Annotation of src/usr.bin/nice/nice.1, Revision 1.16
1.16 ! jmc 1: .\" $OpenBSD: nice.1,v 1.15 2007/07/27 13:27:46 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.16 ! jmc 33: .Dd $Mdocdate: July 27 2007 $
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.16 ! jmc 67: .Nm
! 68: also exists as a built-in to
! 69: .Xr csh 1 ,
! 70: though with a different syntax.
! 71: .Pp
1.1 deraadt 72: The
1.5 aaron 73: .Nm
1.1 deraadt 74: utility shall exit with one of the following values:
1.7 aaron 75: .Pp
76: .Bl -tag -width indent -offset indent -compact
1.5 aaron 77: .It 1\-125
1.7 aaron 78: An error occurred.
1.1 deraadt 79: .It 126
1.5 aaron 80: The
1.1 deraadt 81: .Ar utility
82: was found but could not be invoked.
83: .It 127
1.5 aaron 84: The
1.1 deraadt 85: .Ar utility
86: could not be found.
87: .El
88: .Pp
1.5 aaron 89: Otherwise, the exit status of
90: .Nm
91: shall be that of
1.1 deraadt 92: .Ar utility .
93: .Sh SEE ALSO
94: .Xr csh 1 ,
1.3 deraadt 95: .Xr getpriority 2 ,
1.1 deraadt 96: .Xr renice 8
1.12 jmc 97: .Sh STANDARDS
1.13 jmc 98: The
99: .Nm
100: utility is compliant with the
101: .St -p1003.1-2004
102: specification.
103: .Pp
1.10 aaron 104: The historic
105: .Fl Ns Ar increment
106: option has been deprecated but is still supported in this implementation.
1.1 deraadt 107: .Sh HISTORY
108: A
1.5 aaron 109: .Nm
1.1 deraadt 110: utility appeared in
111: .At v6 .