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