macro and text revision (-mdoc version 3)

[unix-history] / usr / src / usr.bin / renice / renice.8

diff --git a/usr/src/usr.bin/renice/renice.8 b/usr/src/usr.bin/renice/renice.8
index 67b0131..1f1a419 100644 (file)
--- a/usr/src/usr.bin/renice/renice.8
+++ b/usr/src/usr.bin/renice/renice.8
@@ -1,77 +1,105 @@
-.\" Copyright (c) 1983 The Regents of the University of California.
+.\" Copyright (c) 1983, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" %sccs.include.redist.man%
 .\"
 .\" All rights reserved.
 .\"
 .\" %sccs.include.redist.man%
 .\"

-.\"    @(#)renice.8    6.4 (Berkeley) %G%
+.\"     @(#)renice.8   6.5 (Berkeley) %G%

 .\"
 .\"

-.UC 7
-.TH RENICE 8 ""
-.UC 4
-.SH NAME
-renice \- alter priority of running processes
-.SH SYNOPSIS
-.B renice
-priority [ [
-.B \-p
-] pid ... ] [ [
-.B \-g
-] pgrp ... ] [ [
-.B \-u
-] user ... ]
-.SH DESCRIPTION
-.I Renice
+.Dd 
+.Dt RENICE 8
+.Os BSD 4
+.Sh NAME
+.Nm renice
+.Nd alter priority of running processes
+.Sh SYNOPSIS
+.Nm renice
+.Ar priority
+.Oo
+.Op Fl p
+.Ar pid ...
+.Oc
+.Oo
+.Op Fl g
+.Ar pgrp ...
+.Oc
+.Oo
+.Op Fl u
+.Ar user ...
+.Oc
+.Sh DESCRIPTION
+.Nm Renice

 alters the 
 scheduling priority of one or more running processes.
 alters the 
 scheduling priority of one or more running processes.

-The
-.I who
+The following
+.Ar who

 parameters are interpreted as process ID's, process group
 ID's, or user names.
 parameters are interpreted as process ID's, process group
 ID's, or user names.

-.IR Renice 'ing
+.Nm Renice Ns 'ing

 a process group causes all processes in the process group
 to have their scheduling priority altered.  
 a process group causes all processes in the process group
 to have their scheduling priority altered.  

-.IR Renice 'ing
+.Nm Renice Ns 'ing

 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
 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.  To force 
-.I who
-parameters to be interpreted as process group ID's, a
-.B \-g 
-may be specified.  To force the
-.I who
-parameters to be interpreted as user names, a
-.B \-u
-may be given.  Supplying
-.B \-p
-will reset 
-.I who
+their process ID's.
+.Pp
+Options supported by
+.Nm renice :
+.Bl -tag -width Ds
+.It Fl g
+Force 
+.Ar who
+parameters to be interpreted as process group ID's.
+.It Fl u
+Force the
+.Ar who
+parameters to be interpreted as user names.
+.It Fl p
+Resets the
+.Ar who

 interpretation to be (the default) process ID's.
 interpretation to be (the default) process ID's.

+.El
+.Pp

 For example,
 For example,

-.sp
-       renice +1 987 -u daemon root -p 32 
-.sp
+.Bd -literal -offset
+renice +1 987 -u daemon root -p 32
+.Ed
+.Pp

 would change the priority of process ID's 987 and 32, and
 all processes owned by users daemon and root.
 would change the priority of process ID's 987 and 32, and
 all processes owned by users daemon and root.

-.PP
+.Pp

 Users other than the super-user may only alter the priority of
 processes they own,
 and can only monotonically increase their ``nice value''
 Users other than the super-user may only alter the priority of
 processes they own,
 and can only monotonically increase their ``nice value''

-within the range 0 to PRIO_MAX (20).
+within the range 0 to
+.Dv PRIO_MAX
+(20).

 (This prevents overriding administrative fiats.)
 The super-user
 may alter the priority of any process
 (This prevents overriding administrative fiats.)
 The super-user
 may alter the priority of any process

-and set the priority to any value in the range PRIO_MIN (\-20)
-to PRIO_MAX.
+and set the priority to any value in the range
+.Dv PRIO_MIN
+(\-20)
+to
+.Dv PRIO_MAX .

 Useful priorities are:
 20 (the affected processes will run only when nothing else
 in the system wants to),
 0 (the ``base'' scheduling priority),
 anything negative (to make things go very fast).
 Useful priorities are:
 20 (the affected processes will run only when nothing else
 in the system wants to),
 0 (the ``base'' scheduling priority),
 anything negative (to make things go very fast).

-.SH FILES
-/etc/passwd    to map user names to user ID's
-.SH SEE ALSO
-getpriority(2), setpriority(2)
-.SH BUGS
+.Sh FILES
+.Bl -tag -width /etc/passwd -compact
+.It Pa /etc/passwd
+to map user names to user ID's
+.El
+.Sh SEE ALSO
+.Xr getpriority 2 ,
+.Xr setpriority 2
+.Sh BUGS

 Non super-users can not increase scheduling priorities of their own processes,
 even if they were the ones that decreased the priorities in the first place.
 Non super-users can not increase scheduling priorities of their own processes,
 even if they were the ones that decreased the priorities in the first place.

+.Sh HISTORY
+The
+.Nm
+command appeared in
+.Bx 4.0 .