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