xref: /dragonfly/usr.bin/renice/renice.8 (revision 0dace59e)
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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     @(#)renice.8	8.1 (Berkeley) 6/9/93
29.\" $FreeBSD: src/usr.bin/renice/renice.8,v 1.5.2.5 2002/06/17 23:58:46 tjr Exp $
30.\" $DragonFly: src/usr.bin/renice/renice.8,v 1.2 2003/06/17 04:29:30 dillon Exp $
31.\"
32.Dd June 9, 1993
33.Dt RENICE 8
34.Os
35.Sh NAME
36.Nm renice
37.Nd alter priority of running processes
38.Sh SYNOPSIS
39.Nm
40.Op Ar priority | Op Fl n Ar increment
41.Op Oo Fl p Oc Ar pid ...
42.Op Oo Fl g Oc Ar pgrp ...
43.Op Oo Fl u Oc Ar user ...
44.Sh DESCRIPTION
45.Nm Renice
46alters the
47scheduling priority of one or more running processes.
48The following
49.Ar who
50parameters are interpreted as process ID's, process group
51ID's, user ID's or user names.
52.Nm Renice Ns 'ing
53a process group causes all processes in the process group
54to have their scheduling priority altered.
55.Nm Renice Ns 'ing
56a user causes all processes owned by the user to have
57their scheduling priority altered.
58By default, the processes to be affected are specified by
59their process ID's.
60.Pp
61Options supported by
62.Nm :
63.Bl -tag -width Ds
64.It Fl g
65Force
66.Ar who
67parameters to be interpreted as process group ID's.
68.It Fl n
69Instead of changing the specified processes to the given priority,
70interpret the following argument as an increment to be applied to
71the current priority of each process.
72.It Fl u
73Force the
74.Ar who
75parameters to be interpreted as user names or user ID's.
76.It Fl p
77Resets the
78.Ar who
79interpretation to be (the default) process ID's.
80.El
81.Pp
82For example,
83.Pp
84.Dl "renice +1 987 -u daemon root -p 32"
85.Pp
86would change the priority of process ID's 987 and 32, and
87all processes owned by users daemon and root.
88.Pp
89Users other than the super-user may only alter the priority of
90processes they own,
91and can only monotonically increase their ``nice value''
92within the range 0 to
93.Dv PRIO_MAX
94(20).
95(This prevents overriding administrative fiats.)
96The super-user
97may alter the priority of any process
98and set the priority to any value in the range
99.Dv PRIO_MIN
100(\-20)
101to
102.Dv PRIO_MAX .
103Useful priorities are:
10420 (the affected processes will run only when nothing else
105in the system wants to),
1060 (the ``base'' scheduling priority),
107anything negative (to make things go very fast).
108.Sh FILES
109.Bl -tag -width /etc/passwd -compact
110.It Pa /etc/passwd
111to map user names to user ID's
112.El
113.Sh SEE ALSO
114.Xr nice 1 ,
115.Xr rtprio 1 ,
116.Xr getpriority 2 ,
117.Xr setpriority 2
118.Sh STANDARDS
119The
120.Nm
121utility conforms to
122.St -p1003.1-2001 .
123.Sh HISTORY
124The
125.Nm
126command appeared in
127.Bx 4.0 .
128.Sh BUGS
129Non super-users cannot increase scheduling priorities of their own processes,
130even if they were the ones that decreased the priorities in the first place.
131