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