renice(8): Clarify "who" parameters.

There was a question raised in freebsd-questions@ mail list[1] about the
"who" parameters in this man page. It seems OpenBSD[2] amd NetBSD[3]
both have more legible descriptions so I borrowed some of their ideas to try
and make this page clearer.

[1] https://lists.freebsd.org/pipermail/freebsd-questions/2020-October/291914.html
[2] https://man.bsd.lv/renice
[3] https://man.netbsd.org/renice.8

Approved by:	manpages (bcr@)
Differential Revision:		https://reviews.freebsd.org/D26950
This commit is contained in:
Fernando Apesteguía 2020-10-27 12:32:17 +00:00
parent b0d30b27f0
commit f8ae041a04

View File

@ -28,7 +28,7 @@
.\" @(#)renice.8 8.1 (Berkeley) 6/9/93 .\" @(#)renice.8 8.1 (Berkeley) 6/9/93
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd June 9, 1993 .Dd October 27, 2020
.Dt RENICE 8 .Dt RENICE 8
.Os .Os
.Sh NAME .Sh NAME
@ -37,22 +37,18 @@
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm
.Ar priority .Ar priority
.Op Oo Fl p Oc Ar pid ... .Op Oo Fl gpu Oc Ar target
.Op Oo Fl g Oc Ar pgrp ...
.Op Oo Fl u Oc Ar user ...
.Nm .Nm
.Fl n Ar increment .Fl n Ar increment
.Op Oo Fl p Oc Ar pid ... .Op Oo Fl gpu Oc Ar target
.Op Oo Fl g Oc Ar pgrp ...
.Op Oo Fl u Oc Ar user ...
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Nm .Nm
utility alters the utility alters the
scheduling priority of one or more running processes. scheduling priority of one or more running processes.
The following The following
.Ar who .Ar target
parameters are interpreted as process ID's, process group parameters are interpreted as process ID's (the default), process group
ID's, user ID's or user names. ID's, user ID's or user names.
The The
.Nm Ns 'ing .Nm Ns 'ing
@ -62,27 +58,25 @@ The
.Nm Ns 'ing .Nm Ns 'ing
of a user causes all processes owned by the user to have of a user causes all processes owned by the user to have
their scheduling priority altered. their scheduling priority altered.
By default, the processes to be affected are specified by
their process ID's.
.Pp .Pp
The following options are available: The following options are available:
.Bl -tag -width indent .Bl -tag -width indent
.It Fl g
Force
.Ar who
parameters to be interpreted as process group ID's.
.It Fl n .It Fl n
Instead of changing the specified processes to the given priority, Instead of changing the specified processes to the given priority,
interpret the following argument as an increment to be applied to interpret the following argument as an increment to be applied to
the current priority of each process. the current priority of each process.
.It Fl u .It Fl g
Force the Interpret
.Ar who .Ar target
parameters to be interpreted as user names or user ID's. parameters as process group ID's.
.It Fl p .It Fl p
Reset the Interpret
.Ar who .Ar target
interpretation to be (the default) process ID's. parameters as process ID's (the default).
.It Fl u
Interpret
.Ar target
parameters as user names or user ID's.
.El .El
.Pp .Pp
Users other than the super-user may only alter the priority of Users other than the super-user may only alter the priority of