xref: /openbsd-src/usr.bin/nice/nice.1 (revision 01c04610def415d91ba53ed8301fa7d251b19af6)
1*01c04610Sjsg.\"	$OpenBSD: nice.1,v 1.20 2020/02/08 01:09:58 jsg Exp $
2df930be7Sderaadt.\"	$NetBSD: nice.1,v 1.6 1995/08/31 23:30:57 jtc Exp $
3df930be7Sderaadt.\"
4df930be7Sderaadt.\" Copyright (c) 1980, 1990, 1993
5df930be7Sderaadt.\"	The Regents of the University of California.  All rights reserved.
6df930be7Sderaadt.\"
7df930be7Sderaadt.\" Redistribution and use in source and binary forms, with or without
8df930be7Sderaadt.\" modification, are permitted provided that the following conditions
9df930be7Sderaadt.\" are met:
10df930be7Sderaadt.\" 1. Redistributions of source code must retain the above copyright
11df930be7Sderaadt.\"    notice, this list of conditions and the following disclaimer.
12df930be7Sderaadt.\" 2. Redistributions in binary form must reproduce the above copyright
13df930be7Sderaadt.\"    notice, this list of conditions and the following disclaimer in the
14df930be7Sderaadt.\"    documentation and/or other materials provided with the distribution.
15f75387cbSmillert.\" 3. Neither the name of the University nor the names of its contributors
16df930be7Sderaadt.\"    may be used to endorse or promote products derived from this software
17df930be7Sderaadt.\"    without specific prior written permission.
18df930be7Sderaadt.\"
19df930be7Sderaadt.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20df930be7Sderaadt.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21df930be7Sderaadt.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22df930be7Sderaadt.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23df930be7Sderaadt.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24df930be7Sderaadt.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25df930be7Sderaadt.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26df930be7Sderaadt.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27df930be7Sderaadt.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28df930be7Sderaadt.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29df930be7Sderaadt.\" SUCH DAMAGE.
30df930be7Sderaadt.\"
31df930be7Sderaadt.\"	@(#)nice.1	8.1 (Berkeley) 6/6/93
32df930be7Sderaadt.\"
33*01c04610Sjsg.Dd $Mdocdate: February 8 2020 $
34df930be7Sderaadt.Dt NICE 1
35df930be7Sderaadt.Os
36df930be7Sderaadt.Sh NAME
37df930be7Sderaadt.Nm nice
38df930be7Sderaadt.Nd execute a utility with an altered scheduling priority
39df930be7Sderaadt.Sh SYNOPSIS
40df930be7Sderaadt.Nm nice
41df930be7Sderaadt.Op Fl n Ar increment
42df930be7Sderaadt.Ar utility
43df930be7Sderaadt.Op Ar argument ...
44df930be7Sderaadt.Sh DESCRIPTION
452e0eb34fSaaron.Nm
46df930be7Sderaadtruns
47df930be7Sderaadt.Ar utility
48df930be7Sderaadtat an altered scheduling priority.
49df930be7SderaadtIf an
50df930be7Sderaadt.Ar increment
51df930be7Sderaadtis given, it is used; otherwise
52df930be7Sderaadtan increment of 10 is assumed.
53a3542fadSaaronThe superuser can run utilities with priorities higher than normal by using
54df930be7Sderaadta negative
55df930be7Sderaadt.Ar increment .
56df930be7SderaadtThe priority can be adjusted over a
572e0eb34fSaaronrange of \-20 (the highest) to 20 (the lowest).
58df930be7Sderaadt.Pp
594c2c4eb0SaaronThe options are as follows:
60f1ba3473Saaron.Bl -tag -width Ds
61df930be7Sderaadt.It Fl n Ar increment
62df930be7SderaadtA positive or negative decimal integer used to modify the system scheduling
63df930be7Sderaadtpriority of
64df930be7Sderaadt.Ar utility .
65df930be7Sderaadt.El
6611c0d3b3Sjmc.Sh EXIT STATUS
67df930be7SderaadtThe
682e0eb34fSaaron.Nm
6911c0d3b3Sjmcutility exits with one of the following values:
7021059b0fSaaron.Pp
7121059b0fSaaron.Bl -tag -width indent -offset indent -compact
722e0eb34fSaaron.It 1\-125
7321059b0fSaaronAn error occurred.
74df930be7Sderaadt.It 126
75df930be7SderaadtThe
76df930be7Sderaadt.Ar utility
77df930be7Sderaadtwas found but could not be invoked.
78df930be7Sderaadt.It 127
79df930be7SderaadtThe
80df930be7Sderaadt.Ar utility
81df930be7Sderaadtcould not be found.
82df930be7Sderaadt.El
83df930be7Sderaadt.Pp
84df930be7SderaadtOtherwise, the exit status of
852e0eb34fSaaron.Nm
86df930be7Sderaadtshall be that of
87df930be7Sderaadt.Ar utility .
88df930be7Sderaadt.Sh SEE ALSO
89df930be7Sderaadt.Xr csh 1 ,
9043183020Sderaadt.Xr getpriority 2 ,
91df930be7Sderaadt.Xr renice 8
922aeff9fbSjmc.Sh STANDARDS
937c5a075bSjmcThe
947c5a075bSjmc.Nm
957c5a075bSjmcutility is compliant with the
9699332e38Sjmc.St -p1003.1-2008
977c5a075bSjmcspecification.
987c5a075bSjmc.Pp
993746a816SaaronThe historic
1003746a816Saaron.Fl Ns Ar increment
1013746a816Saaronoption has been deprecated but is still supported in this implementation.
102d406b0bbSjmc.Pp
103d406b0bbSjmc.Nm
104d406b0bbSjmcalso exists as a built-in to
105d406b0bbSjmc.Xr csh 1 ,
106d406b0bbSjmcthough with a different syntax.
107df930be7Sderaadt.Sh HISTORY
108df930be7SderaadtA
1092e0eb34fSaaron.Nm
110df930be7Sderaadtutility appeared in
111*01c04610Sjsg.At v4 .
112