xref: /netbsd/usr.bin/renice/renice.8 (revision bf9ec67e)
1.\"	$NetBSD: renice.8,v 1.10 2001/12/08 19:11:33 wiz Exp $
2.\"
3.\" Copyright (c) 1983, 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
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.\"
34.\"     from: @(#)renice.8	8.1 (Berkeley) 6/9/93
35.\"	$NetBSD: renice.8,v 1.10 2001/12/08 19:11:33 wiz Exp $
36.\"
37.Dd June 9, 1993
38.Dt RENICE 8
39.Os
40.Sh NAME
41.Nm renice
42.Nd alter priority of running processes
43.Sh SYNOPSIS
44.Nm
45.Ar priority
46.Oo
47.Op Fl p
48.Ar pid ...
49.Oc
50.Oo
51.Fl g
52.Ar pgrp ...
53.Oc
54.Oo
55.Fl u
56.Ar user ...
57.Oc
58.Nm ""
59.Fl n
60.Ar increment
61.Oo
62.Op Fl p
63.Ar pid ...
64.Oc
65.Oo
66.Fl g
67.Ar pgrp ...
68.Oc
69.Oo
70.Fl u
71.Ar user ...
72.Oc
73.Sh DESCRIPTION
74.Nm
75alters the
76scheduling priority of one or more running processes.
77The following
78.Ar who
79parameters are interpreted as process ID's, process group
80ID's, or user names.
81.Nm "" Ns 'ing
82a process group causes all processes in the process group
83to have their scheduling priority altered.
84.Nm "" Ns 'ing
85a user causes all processes owned by the user to have
86their scheduling priority altered.
87By default, the processes to be affected are specified by
88their process ID's.
89.Pp
90Options supported by
91.Nm "" :
92.Bl -tag -width Ds
93.It Fl g
94Force
95.Ar who
96parameters to be interpreted as process group ID's.
97.It Fl n
98Instead of changing the specified processes to the given priority,
99interpret the following argument as an increment to be applied to
100the current priority of each process.
101.It Fl u
102Force the
103.Ar who
104parameters to be interpreted as user names.
105.It Fl p
106Resets the
107.Ar who
108interpretation to be (the default) process ID's.
109.El
110.Pp
111For example,
112.Bd -literal -offset
113renice +1 987 -u daemon root -p 32
114.Ed
115.Pp
116would change the priority of process ID's 987 and 32, and
117all processes owned by users daemon and root.
118.Pp
119Users other than the super-user may only alter the priority of
120processes they own,
121and can only monotonically increase their ``nice value''
122within the range 0 to
123.Dv PRIO_MAX
124(20).
125(This prevents overriding administrative fiats.)
126The super-user
127may alter the priority of any process
128and set the priority to any value in the range
129.Dv PRIO_MIN
130(\-20)
131to
132.Dv PRIO_MAX .
133.Pp
134Useful priorities are:
1350, the ``base'' scheduling priority;
13620, the affected processes will run only when nothing at the base priority
137wants to;
138anything negative, the processes will receive a scheduling preference.
139.Sh FILES
140.Bl -tag -width /etc/passwd -compact
141.It Pa /etc/passwd
142to map user names to user ID's
143.El
144.Sh SEE ALSO
145.Xr nice 1 ,
146.Xr getpriority 2 ,
147.Xr setpriority 2
148.Sh HISTORY
149The
150.Nm
151command appeared in
152.Bx 4.0 .
153.Sh BUGS
154Non super-users can not increase scheduling priorities of their own processes,
155even if they were the ones that decreased the priorities in the first place.
156