[apple/shell_cmds.git] / renice / renice.8

.\" Copyright (c) 1983, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)renice.8	8.1 (Berkeley) 6/9/93
.\" $FreeBSD: src/usr.bin/renice/renice.8,v 1.16 2003/02/26 20:27:24 charnier Exp $
.\"
.Dd June 9, 1993
.Dt RENICE 8
.Os
.Sh NAME
.Nm renice
.Nd alter priority of running processes
.Sh SYNOPSIS
.Nm
.Ar priority
.Op Oo Fl p Oc Ar pid ...
.Op Oo Fl g Oc Ar pgrp ...
.Op Oo Fl u Oc Ar user ...
.Nm
.Fl n Ar increment
.Op Oo Fl p Oc Ar pid ...
.Op Oo Fl g Oc Ar pgrp ...
.Op Oo Fl u Oc Ar user ...
.Sh DESCRIPTION
The
.Nm
utility alters the
scheduling priority of one or more running processes.
The following
.Ar who
parameters are interpreted as process ID's, process group
ID's, user ID's or user names.
The
.Nm Ns 'ing
of a process group causes all processes in the process group
to have their scheduling priority altered.
The
.Nm Ns 'ing
of a user causes all processes owned by the user to have
their scheduling priority altered.
By default, the processes to be affected are specified by
their process ID's.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl g
Force
.Ar who
parameters to be interpreted as process group ID's.
.It Fl n
Instead of changing the specified processes to the given priority,
interpret the following argument as an increment to be applied to
the current priority of each process.
.It Fl u
Force the
.Ar who
parameters to be interpreted as user names or user ID's.
.It Fl p
Reset the
.Ar who
interpretation to be (the default) process ID's.
.El
.Pp
For example,
.Pp
.Dl "renice +1 987 -u daemon root -p 32"
.Pp
would change the priority of process ID's 987 and 32, and
all processes owned by users daemon and root.
.Pp
Users other than the super-user may only alter the priority of
processes they own,
and can only monotonically increase their ``nice value''
within the range 0 to
.Dv PRIO_MAX
(20).
(This prevents overriding administrative fiats.)
The super-user
may alter the priority of any process
and set the priority to any value in the range
.Dv PRIO_MIN
(\-20)
to
.Dv PRIO_MAX .
Useful priorities are:
20 (the affected processes will run only when nothing else
in the system wants to),
0 (the ``base'' scheduling priority),
anything negative (to make things go very fast).
.Sh FILES
.Bl -tag -width /etc/passwd -compact
.It Pa /etc/passwd
to map user names to user ID's
.El
.Sh SEE ALSO
.Xr nice 1 ,
.Xr rtprio 1 ,
.Xr getpriority 2 ,
.Xr setpriority 2
.Sh STANDARDS
The
.Nm
utility conforms to
.St -p1003.1-2001 .
.Sh HISTORY
The
.Nm
utility appeared in
.Bx 4.0 .
.Sh BUGS
Non super-users cannot increase scheduling priorities of their own processes,
even if they were the ones that decreased the priorities in the first place.
Commit	Line	Data
44bd5ea7 A	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	.\"
1c4c78a5 A	32	.\" @(#)renice.8 8.1 (Berkeley) 6/9/93
1c4c78a5 A	33	.\" $FreeBSD: src/usr.bin/renice/renice.8,v 1.16 2003/02/26 20:27:24 charnier Exp $
44bd5ea7 A	34	.\"
	35	.Dd June 9, 1993
	36	.Dt RENICE 8
1c4c78a5	37	.Os
44bd5ea7 A	38	.Sh NAME
	39	.Nm renice
	40	.Nd alter priority of running processes
	41	.Sh SYNOPSIS
	42	.Nm
	43	.Ar priority
1c4c78a5 A	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 ...
44bd5ea7	52	.Sh DESCRIPTION
1c4c78a5	53	The
44bd5ea7	54	.Nm
1c4c78a5	55	utility alters the
44bd5ea7 A	56	scheduling priority of one or more running processes.
	57	The following
	58	.Ar who
	59	parameters are interpreted as process ID's, process group
1c4c78a5 A	60	ID's, user ID's or user names.
1c4c78a5 A	61	The
daf87b50	62	.Nm Ns 'ing
1c4c78a5 A	63	of a process group causes all processes in the process group
	64	to have their scheduling priority altered.
	65	The
daf87b50	66	.Nm Ns 'ing
1c4c78a5	67	of a user causes all processes owned by the user to have
44bd5ea7 A	68	their scheduling priority altered.
	69	By default, the processes to be affected are specified by
	70	their process ID's.
	71	.Pp
1c4c78a5 A	72	The following options are available:
1c4c78a5 A	73	.Bl -tag -width indent
44bd5ea7	74	.It Fl g
1c4c78a5	75	Force
44bd5ea7 A	76	.Ar who
44bd5ea7 A	77	parameters to be interpreted as process group ID's.
1c4c78a5 A	78	.It Fl n
	79	Instead of changing the specified processes to the given priority,
	80	interpret the following argument as an increment to be applied to
	81	the current priority of each process.
44bd5ea7 A	82	.It Fl u
	83	Force the
	84	.Ar who
1c4c78a5	85	parameters to be interpreted as user names or user ID's.
44bd5ea7	86	.It Fl p
1c4c78a5	87	Reset the
44bd5ea7 A	88	.Ar who
	89	interpretation to be (the default) process ID's.
	90	.El
	91	.Pp
	92	For example,
1c4c78a5 A	93	.Pp
1c4c78a5 A	94	.Dl "renice +1 987 -u daemon root -p 32"
44bd5ea7 A	95	.Pp
	96	would change the priority of process ID's 987 and 32, and
	97	all processes owned by users daemon and root.
	98	.Pp
	99	Users other than the super-user may only alter the priority of
	100	processes they own,
	101	and can only monotonically increase their ``nice value''
	102	within the range 0 to
	103	.Dv PRIO_MAX
	104	(20).
	105	(This prevents overriding administrative fiats.)
	106	The super-user
	107	may alter the priority of any process
	108	and set the priority to any value in the range
	109	.Dv PRIO_MIN
	110	(\-20)
	111	to
	112	.Dv PRIO_MAX .
	113	Useful priorities are:
	114	20 (the affected processes will run only when nothing else
	115	in the system wants to),
	116	0 (the ``base'' scheduling priority),
	117	anything negative (to make things go very fast).
	118	.Sh FILES
	119	.Bl -tag -width /etc/passwd -compact
	120	.It Pa /etc/passwd
	121	to map user names to user ID's
	122	.El
	123	.Sh SEE ALSO
	124	.Xr nice 1 ,
1c4c78a5	125	.Xr rtprio 1 ,
44bd5ea7 A	126	.Xr getpriority 2 ,
44bd5ea7 A	127	.Xr setpriority 2
1c4c78a5 A	128	.Sh STANDARDS
	129	The
	130	.Nm
	131	utility conforms to
	132	.St -p1003.1-2001 .
44bd5ea7 A	133	.Sh HISTORY
	134	The
	135	.Nm
1c4c78a5	136	utility appeared in
44bd5ea7	137	.Bx 4.0 .
1c4c78a5 A	138	.Sh BUGS
	139	Non super-users cannot increase scheduling priorities of their own processes,
	140	even if they were the ones that decreased the priorities in the first place.