[apple/shell_cmds.git] / nice / nice.1

.\"	$NetBSD: nice.1,v 1.8 1997/10/19 06:28:02 lukem Exp $
.\"
.\" Copyright (c) 1980, 1990, 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.
.\"
.\"	@(#)nice.1	8.1 (Berkeley) 6/6/93
.\"
.Dd June 6, 1993
.Dt NICE 1
.Os 
.Sh NAME
.Nm nice
.Nd execute a utility with an altered scheduling priority
.Sh SYNOPSIS
.Nm
.Op Fl n Ar increment
.Ar utility
.Op Ar argument ...
.Sh DESCRIPTION
.Nm
runs
.Ar utility
at an altered scheduling priority.
If an 
.Ar increment 
is given, it is used; otherwise
an increment of 10 is assumed.
The super-user can run utilities with priorities higher than normal by using
a negative 
.Ar increment .
The priority can be adjusted over a
range of -20 (the highest) to 20 (the lowest).
.Pp
Available options:
.Bl -tag -width indent
.It Fl n Ar increment
A positive or negative decimal integer used to modify the system scheduling
priority of 
.Ar utility.
.El
.Sh DIAGNOSTICS
The
.Nm
utility shall exit with one of the following values:
.Bl -tag -width indent
.It 1-125
An error occurred in the 
.Nm
utility.
.It 126
The 
.Ar utility
was found but could not be invoked.
.It 127
The 
.Ar utility
could not be found.
.El
.Pp
Otherwise, the exit status of 
.Nm
shall be that of 
.Ar utility .
.Sh COMPATIBILITY
The historic 
.Fl Ns Ar increment 
option has been deprecated but is still supported in this implementation.
.Sh SEE ALSO
.Xr csh 1 ,
.Xr getpriority 2 ,
.Xr setpriority 2 ,
.Xr renice 8
.Sh STANDARDS
The
.Nm
utility conforms to 
.St -p1003.2-92 .
.Sh HISTORY
A
.Nm
utility appeared in
.At v6 .
.Sh BUGS
.Nm
is built into
.Xr csh  1
with a slightly different syntax than described here.  The form
.Ql nice +10
nices to positive nice, and
.Ql nice \-10
can be used
by the super-user to give a process more of the processor.
Commit	Line	Data
44bd5ea7 A	1	.\" $NetBSD: nice.1,v 1.8 1997/10/19 06:28:02 lukem Exp $
	2	.\"
	3	.\" Copyright (c) 1980, 1990, 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	.\" @(#)nice.1 8.1 (Berkeley) 6/6/93
	35	.\"
	36	.Dd June 6, 1993
	37	.Dt NICE 1
	38	.Os
	39	.Sh NAME
	40	.Nm nice
	41	.Nd execute a utility with an altered scheduling priority
	42	.Sh SYNOPSIS
	43	.Nm
	44	.Op Fl n Ar increment
	45	.Ar utility
	46	.Op Ar argument ...
	47	.Sh DESCRIPTION
	48	.Nm
	49	runs
	50	.Ar utility
	51	at an altered scheduling priority.
	52	If an
	53	.Ar increment
	54	is given, it is used; otherwise
	55	an increment of 10 is assumed.
	56	The super-user can run utilities with priorities higher than normal by using
	57	a negative
	58	.Ar increment .
	59	The priority can be adjusted over a
	60	range of -20 (the highest) to 20 (the lowest).
	61	.Pp
	62	Available options:
	63	.Bl -tag -width indent
	64	.It Fl n Ar increment
65	A positive or negative decimal integer used to modify the system scheduling
66	priority of
67	.Ar utility.
68	.El
69	.Sh DIAGNOSTICS
70	The
71	.Nm
72	utility shall exit with one of the following values:
73	.Bl -tag -width indent
74	.It 1-125
75	An error occurred in the
76	.Nm
77	utility.
78	.It 126
79	The
80	.Ar utility
81	was found but could not be invoked.
82	.It 127
83	The
84	.Ar utility
85	could not be found.
86	.El
87	.Pp
88	Otherwise, the exit status of
89	.Nm
90	shall be that of
91	.Ar utility .
92	.Sh COMPATIBILITY
93	The historic
94	.Fl Ns Ar increment
95	option has been deprecated but is still supported in this implementation.
96	.Sh SEE ALSO
97	.Xr csh 1 ,
98	.Xr getpriority 2 ,
99	.Xr setpriority 2 ,
100	.Xr renice 8
101	.Sh STANDARDS
102	The
103	.Nm
104	utility conforms to
105	.St -p1003.2-92 .
106	.Sh HISTORY
107	A
108	.Nm
109	utility appeared in
110	.At v6 .
111	.Sh BUGS
112	.Nm
113	is built into
114	.Xr csh 1
115	with a slightly different syntax than described here. The form
116	.Ql nice +10
117	nices to positive nice, and
118	.Ql nice \-10
119	can be used
120	by the super-user to give a process more of the processor.