Skip to content

Commit

Permalink
renice(8): Clarify "who" parameters.
Browse files Browse the repository at this point in the history
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
  • Loading branch information
fernape committed Oct 27, 2020
1 parent b0d30b2 commit f8ae041
Showing 1 changed file with 16 additions and 22 deletions.
38 changes: 16 additions & 22 deletions usr.bin/renice/renice.8
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
.\" @(#)renice.8 8.1 (Berkeley) 6/9/93
.\" $FreeBSD$
.\"
.Dd June 9, 1993
.Dd October 27, 2020
.Dt RENICE 8
.Os
.Sh NAME
Expand All @@ -37,22 +37,18 @@
.Sh SYNOPSIS
.Nm
.Ar priority
.Op Oo Fl p Oc Ar pid ...
.Op Oo Fl g Oc Ar pgrp ...
.Op Oo Fl u Oc Ar user ...
.Op Oo Fl gpu Oc Ar target
.Nm
.Fl n Ar increment
.Op Oo Fl p Oc Ar pid ...
.Op Oo Fl g Oc Ar pgrp ...
.Op Oo Fl u Oc Ar user ...
.Op Oo Fl gpu Oc Ar target
.Sh DESCRIPTION
The
.Nm
utility alters the
scheduling priority of one or more running processes.
The following
.Ar who
parameters are interpreted as process ID's, process group
.Ar target
parameters are interpreted as process ID's (the default), process group
ID's, user ID's or user names.
The
.Nm Ns 'ing
Expand All @@ -62,27 +58,25 @@ The
.Nm Ns 'ing
of a user causes all processes owned by the user to have
their scheduling priority altered.
By default, the processes to be affected are specified by
their process ID's.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl g
Force
.Ar who
parameters to be interpreted as process group ID's.
.It Fl n
Instead of changing the specified processes to the given priority,
interpret the following argument as an increment to be applied to
the current priority of each process.
.It Fl u
Force the
.Ar who
parameters to be interpreted as user names or user ID's.
.It Fl g
Interpret
.Ar target
parameters as process group ID's.
.It Fl p
Reset the
.Ar who
interpretation to be (the default) process ID's.
Interpret
.Ar target
parameters as process ID's (the default).
.It Fl u
Interpret
.Ar target
parameters as user names or user ID's.
.El
.Pp
Users other than the super-user may only alter the priority of
Expand Down

0 comments on commit f8ae041

Please sign in to comment.