Annotation of src/usr.bin/renice/renice.8, Revision 1.8
1.8 ! aaron 1: .\" $OpenBSD: renice.8,v 1.7 1999/05/23 14:11:30 aaron Exp $
1.6 millert 2: .\" Copyright (c) 1983, 1991, 1993
3: .\" The Regents of the University of California. All rights reserved.
1.1 deraadt 4: .\"
5: .\" Redistribution and use in source and binary forms, with or without
6: .\" modification, are permitted provided that the following conditions
7: .\" are met:
8: .\" 1. Redistributions of source code must retain the above copyright
9: .\" notice, this list of conditions and the following disclaimer.
10: .\" 2. Redistributions in binary form must reproduce the above copyright
11: .\" notice, this list of conditions and the following disclaimer in the
12: .\" documentation and/or other materials provided with the distribution.
13: .\" 3. All advertising materials mentioning features or use of this software
14: .\" must display the following acknowledgement:
15: .\" This product includes software developed by the University of
16: .\" California, Berkeley and its contributors.
17: .\" 4. Neither the name of the University nor the names of its contributors
18: .\" may be used to endorse or promote products derived from this software
19: .\" without specific prior written permission.
20: .\"
21: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31: .\" SUCH DAMAGE.
32: .\"
1.6 millert 33: .\" from: @(#)renice.8 8.1 (Berkeley) 6/9/93
1.1 deraadt 34: .\"
1.6 millert 35: .Dd June 9, 1993
1.1 deraadt 36: .Dt RENICE 8
1.7 aaron 37: .Os
1.1 deraadt 38: .Sh NAME
39: .Nm renice
40: .Nd alter priority of running processes
41: .Sh SYNOPSIS
42: .Nm renice
43: .Ar priority
44: .Oo
45: .Op Fl p
46: .Ar pid ...
47: .Oc
48: .Oo
49: .Op Fl g
50: .Ar pgrp ...
51: .Oc
52: .Oo
53: .Op Fl u
54: .Ar user ...
55: .Oc
56: .Sh DESCRIPTION
1.8 ! aaron 57: .Nm
! 58: alters the
1.3 kstailey 59: scheduling
60: .Ar priority
61: (an integer) of one or more running processes.
1.1 deraadt 62: The following
63: .Ar who
1.5 aaron 64: parameters (pid, pgrp and user) are interpreted as process IDs, process group
65: IDs, or user names.
66: .Nm renice Ns ing
1.1 deraadt 67: a process group causes all processes in the process group
1.8 ! aaron 68: to have their scheduling priority altered.
1.5 aaron 69: .Nm renice Ns ing
1.1 deraadt 70: a user causes all processes owned by the user to have
71: their scheduling priority altered.
72: By default, the processes to be affected are specified by
1.5 aaron 73: their process IDs.
1.1 deraadt 74: .Pp
75: Options supported by
76: .Nm renice :
77: .Bl -tag -width Ds
78: .It Fl g
1.8 ! aaron 79: Force
1.1 deraadt 80: .Ar who
1.5 aaron 81: parameters to be interpreted as process group IDs.
1.1 deraadt 82: .It Fl u
83: Force the
84: .Ar who
85: parameters to be interpreted as user names.
86: .It Fl p
87: Resets the
88: .Ar who
1.5 aaron 89: interpretation to be (the default) process IDs.
1.1 deraadt 90: .El
91: .Pp
92: For example,
93: .Bd -literal -offset
94: renice +1 987 -u daemon root -p 32
95: .Ed
96: .Pp
1.5 aaron 97: would change the priority of process IDs 987 and 32, and
1.1 deraadt 98: all processes owned by users daemon and root.
99: .Pp
100: Users other than the super-user may only alter the priority of
101: processes they own,
102: and can only monotonically increase their ``nice value''
103: within the range 0 to
104: .Dv PRIO_MAX
105: (20).
106: (This prevents overriding administrative fiats.)
107: The super-user
108: may alter the priority of any process
109: and set the priority to any value in the range
110: .Dv PRIO_MIN
111: (\-20)
112: to
113: .Dv PRIO_MAX .
114: Useful priorities are:
115: 20 (the affected processes will run only when nothing else
116: in the system wants to),
117: 0 (the ``base'' scheduling priority),
118: anything negative (to make things go very fast).
119: .Sh FILES
120: .Bl -tag -width /etc/passwd -compact
121: .It Pa /etc/passwd
1.5 aaron 122: to map user names to user IDs
1.1 deraadt 123: .El
124: .Sh SEE ALSO
1.4 deraadt 125: .Xr nice 1 ,
1.1 deraadt 126: .Xr getpriority 2 ,
127: .Xr setpriority 2
128: .Sh BUGS
1.5 aaron 129: Non-super-users cannot increase scheduling priorities of their own processes,
1.1 deraadt 130: even if they were the ones that decreased the priorities in the first place.
131: .Sh HISTORY
132: The
133: .Nm
134: command appeared in
135: .Bx 4.0 .