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