xref: /freebsd/usr.bin/renice/renice.8 (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
1.\" Copyright (c) 1983, 1991, 1993
2.\"	The Regents of the University of California.  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.\"     @(#)renice.8	8.1 (Berkeley) 6/9/93
33.\" $FreeBSD$
34.\"
35.Dd June 9, 1993
36.Dt RENICE 8
37.Os
38.Sh NAME
39.Nm renice
40.Nd alter priority of running processes
41.Sh SYNOPSIS
42.Nm
43.Ar priority
44.Op Oo Fl p Oc Ar pid ...
45.Op Oo Fl g Oc Ar pgrp ...
46.Op Oo Fl u Oc Ar user ...
47.Nm
48.Fl n Ar increment
49.Op Oo Fl p Oc Ar pid ...
50.Op Oo Fl g Oc Ar pgrp ...
51.Op Oo Fl u Oc Ar user ...
52.Sh DESCRIPTION
53The
54.Nm
55utility alters the
56scheduling priority of one or more running processes.
57The following
58.Ar who
59parameters are interpreted as process ID's, process group
60ID's, user ID's or user names.
61The
62.Nm Ns 'ing
63of a process group causes all processes in the process group
64to have their scheduling priority altered.
65The
66.Nm Ns 'ing
67of a user causes all processes owned by the user to have
68their scheduling priority altered.
69By default, the processes to be affected are specified by
70their process ID's.
71.Pp
72The following options are available:
73.Bl -tag -width indent
74.It Fl g
75Force
76.Ar who
77parameters to be interpreted as process group ID's.
78.It Fl n
79Instead of changing the specified processes to the given priority,
80interpret the following argument as an increment to be applied to
81the current priority of each process.
82.It Fl u
83Force the
84.Ar who
85parameters to be interpreted as user names or user ID's.
86.It Fl p
87Reset the
88.Ar who
89interpretation to be (the default) process ID's.
90.El
91.Pp
92For example,
93.Pp
94.Dl "renice +1 987 -u daemon root -p 32"
95.Pp
96would change the priority of process ID's 987 and 32, and
97all processes owned by users daemon and root.
98.Pp
99Users other than the super-user may only alter the priority of
100processes they own,
101and can only monotonically increase their ``nice value''
102within the range 0 to
103.Dv PRIO_MAX
104(20).
105(This prevents overriding administrative fiats.)
106The super-user
107may alter the priority of any process
108and set the priority to any value in the range
109.Dv PRIO_MIN
110(\-20)
111to
112.Dv PRIO_MAX .
113Useful priorities are:
11420 (the affected processes will run only when nothing else
115in the system wants to),
1160 (the ``base'' scheduling priority),
117anything negative (to make things go very fast).
118.Sh FILES
119.Bl -tag -width /etc/passwd -compact
120.It Pa /etc/passwd
121to map user names to user ID's
122.El
123.Sh SEE ALSO
124.Xr nice 1 ,
125.Xr rtprio 1 ,
126.Xr getpriority 2 ,
127.Xr setpriority 2
128.Sh STANDARDS
129The
130.Nm
131utility conforms to
132.St -p1003.1-2001 .
133.Sh HISTORY
134The
135.Nm
136utility appeared in
137.Bx 4.0 .
138.Sh BUGS
139Non super-users cannot increase scheduling priorities of their own processes,
140even if they were the ones that decreased the priorities in the first place.
141