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