Annotation of src/usr.bin/nice/nice.1, Revision 1.1.1.1
1.1 deraadt 1: .\" $NetBSD: nice.1,v 1.6 1995/08/31 23:30:57 jtc 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 nice
44: .Op Fl n Ar increment
45: .Ar utility
46: .Op Ar argument ...
47: .Sh DESCRIPTION
48: .Nm Nice
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 nice
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 nice
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 nice
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 renice 8
99: .Sh STANDARDS
100: The
101: .Nm nice
102: utility conforms to
103: .St -p1003.2-92 .
104: .Sh HISTORY
105: A
106: .Nm nice
107: utility appeared in
108: .At v6 .
109: .Sh BUGS
110: .Nm Nice
111: is built into
112: .Xr csh 1
113: with a slightly different syntax than described here. The form
114: .Ql nice +10
115: nices to positive nice, and
116: .Ql nice \-10
117: can be used
118: by the super-user to give a process more of the processor.