xref: /netbsd/usr.bin/nice/nice.1 (revision bf9ec67e)
1.\"	$NetBSD: nice.1,v 1.12 2001/12/08 19:09:35 wiz 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
49runs
50.Ar utility
51at an altered scheduling priority.
52If an
53.Ar increment
54is given, it is used; otherwise
55an increment of 10 is assumed.
56The super-user can run utilities with priorities higher than normal by using
57a negative
58.Ar increment .
59The priority can be adjusted over a
60range of -20 (the highest) to 20 (the lowest). A priority of 19 or 20
61will prevent a process from taking any cycles from others at nice 0 or
62better.
63.Pp
64Available options:
65.Bl -tag -width indent
66.It Fl n Ar increment
67A positive or negative decimal integer used to modify the system scheduling
68priority of
69.Ar utility .
70.El
71.Sh EXIT STATUS
72The
73.Nm
74utility exits with one of the following values:
75.Bl -tag -width indent
76.It 1-125
77An error occurred in the
78.Nm
79utility.
80.It 126
81The
82.Ar utility
83was found but could not be invoked.
84.It 127
85The
86.Ar utility
87could not be found.
88.El
89.Pp
90Otherwise, the exit status of
91.Nm
92will be that of
93.Ar utility .
94.Sh COMPATIBILITY
95The historic
96.Fl Ns Ar increment
97option has been deprecated but is still supported in this implementation.
98.Sh SEE ALSO
99.Xr csh 1 ,
100.Xr getpriority 2 ,
101.Xr setpriority 2 ,
102.Xr renice 8
103.Sh STANDARDS
104The
105.Nm
106utility conforms to
107.St -p1003.2-92 .
108.Sh HISTORY
109A
110.Nm
111utility appeared in
112.At v6 .
113.Sh BUGS
114.Nm
115is built into
116.Xr csh  1
117with a slightly different syntax than described here.  The form
118.Ql nice +10
119nices to positive nice, and
120.Ql nice \-10
121can be used
122by the super-user to give a process more of the processor.
123