Annotation of src/usr.bin/nice/nice.1, Revision 1.10
1.10 ! aaron 1: .\" $OpenBSD: nice.1,v 1.9 2000/11/09 17:52:27 aaron Exp $
1.1 deraadt 2: .\" $NetBSD: nice.1,v 1.6 1995/08/31 23:30:57 jtc Exp $
3: .\"
4: .\" Copyright (c) 1980, 1990, 1993
5: .\" The Regents of the University of California. All rights reserved.
6: .\"
7: .\" Redistribution and use in source and binary forms, with or without
8: .\" modification, are permitted provided that the following conditions
9: .\" are met:
10: .\" 1. Redistributions of source code must retain the above copyright
11: .\" notice, this list of conditions and the following disclaimer.
12: .\" 2. Redistributions in binary form must reproduce the above copyright
13: .\" notice, this list of conditions and the following disclaimer in the
14: .\" documentation and/or other materials provided with the distribution.
15: .\" 3. All advertising materials mentioning features or use of this software
16: .\" must display the following acknowledgement:
17: .\" This product includes software developed by the University of
18: .\" California, Berkeley and its contributors.
19: .\" 4. Neither the name of the University nor the names of its contributors
20: .\" may be used to endorse or promote products derived from this software
21: .\" without specific prior written permission.
22: .\"
23: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33: .\" SUCH DAMAGE.
34: .\"
35: .\" @(#)nice.1 8.1 (Berkeley) 6/6/93
36: .\"
37: .Dd June 6, 1993
38: .Dt NICE 1
1.5 aaron 39: .Os
1.1 deraadt 40: .Sh NAME
41: .Nm nice
42: .Nd execute a utility with an altered scheduling priority
43: .Sh SYNOPSIS
44: .Nm nice
45: .Op Fl n Ar increment
46: .Ar utility
47: .Op Ar argument ...
48: .Sh DESCRIPTION
1.5 aaron 49: .Nm
1.1 deraadt 50: runs
51: .Ar utility
52: at an altered scheduling priority.
1.5 aaron 53: If an
54: .Ar increment
1.1 deraadt 55: is given, it is used; otherwise
56: an increment of 10 is assumed.
1.8 aaron 57: The superuser can run utilities with priorities higher than normal by using
1.5 aaron 58: a negative
1.1 deraadt 59: .Ar increment .
60: The priority can be adjusted over a
1.5 aaron 61: range of \-20 (the highest) to 20 (the lowest).
1.1 deraadt 62: .Pp
1.6 aaron 63: The options are as follows:
1.9 aaron 64: .Bl -tag -width Ds
1.1 deraadt 65: .It Fl n Ar increment
66: A positive or negative decimal integer used to modify the system scheduling
1.5 aaron 67: priority of
1.4 aaron 68: .Ar utility .
1.1 deraadt 69: .El
1.7 aaron 70: .Pp
1.1 deraadt 71: The
1.5 aaron 72: .Nm
1.1 deraadt 73: utility shall exit with one of the following values:
1.7 aaron 74: .Pp
75: .Bl -tag -width indent -offset indent -compact
1.5 aaron 76: .It 1\-125
1.7 aaron 77: An error occurred.
1.1 deraadt 78: .It 126
1.5 aaron 79: The
1.1 deraadt 80: .Ar utility
81: was found but could not be invoked.
82: .It 127
1.5 aaron 83: The
1.1 deraadt 84: .Ar utility
85: could not be found.
86: .El
87: .Pp
1.5 aaron 88: Otherwise, the exit status of
89: .Nm
90: shall be that of
1.1 deraadt 91: .Ar utility .
92: .Sh SEE ALSO
93: .Xr csh 1 ,
1.3 deraadt 94: .Xr getpriority 2 ,
95: .Xr setpriority 2 ,
1.1 deraadt 96: .Xr renice 8
1.10 ! aaron 97: .Sh COMPATIBILITY
! 98: The historic
! 99: .Fl Ns Ar increment
! 100: option has been deprecated but is still supported in this implementation.
1.1 deraadt 101: .Sh STANDARDS
102: The
1.5 aaron 103: .Nm
104: utility conforms to
1.1 deraadt 105: .St -p1003.2-92 .
106: .Sh HISTORY
107: A
1.5 aaron 108: .Nm
1.1 deraadt 109: utility appeared in
110: .At v6 .
111: .Sh BUGS
1.5 aaron 112: .Nm
1.1 deraadt 113: is built into
1.7 aaron 114: .Xr csh 1
115: with a slightly different syntax than described here.
116: The form
1.1 deraadt 117: .Ql nice +10
118: nices to positive nice, and
119: .Ql nice \-10
120: can be used
1.8 aaron 121: by the superuser to give a process more of the processor.