NetBSD/usr.bin/nice/nice.1

121 lines
3.3 KiB
Groff
Raw Normal View History

.\" $NetBSD: nice.1,v 1.14 2003/08/07 11:15:23 agc Exp $
.\"
.\" Copyright (c) 1980, 1990, 1993
.\" The Regents of the University of California. All rights reserved.
1993-03-21 12:45:37 +03:00
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
1993-03-21 12:45:37 +03:00
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" @(#)nice.1 8.1 (Berkeley) 6/6/93
1993-03-21 12:45:37 +03:00
.\"
.Dd June 6, 1993
1993-03-21 12:45:37 +03:00
.Dt NICE 1
2001-12-01 19:43:07 +03:00
.Os
1993-03-21 12:45:37 +03:00
.Sh NAME
.Nm nice
1993-08-28 00:22:04 +04:00
.Nd execute a utility with an altered scheduling priority
1993-03-21 12:45:37 +03:00
.Sh SYNOPSIS
1997-10-19 10:28:02 +04:00
.Nm
1993-08-28 00:22:04 +04:00
.Op Fl n Ar increment
.Ar utility
.Op Ar argument ...
1993-03-21 12:45:37 +03:00
.Sh DESCRIPTION
1997-10-19 10:28:02 +04:00
.Nm
1993-03-21 12:45:37 +03:00
runs
1993-08-28 00:22:04 +04:00
.Ar utility
at an altered scheduling priority.
2001-12-01 19:43:07 +03:00
If an
.Ar increment
1993-08-28 00:22:04 +04:00
is given, it is used; otherwise
an increment of 10 is assumed.
The super-user can run utilities with priorities higher than normal by using
2001-12-01 19:43:07 +03:00
a negative
1993-08-28 00:22:04 +04:00
.Ar increment .
The priority can be adjusted over a
2002-09-30 15:08:56 +04:00
range of -20 (the highest) to 20 (the lowest).
A priority of 19 or 20
will prevent a process from taking any cycles from others at nice 0 or
better.
1993-08-28 00:22:04 +04:00
.Pp
Available options:
.Bl -tag -width indent
.It Fl n Ar increment
A positive or negative decimal integer used to modify the system scheduling
2001-12-01 19:43:07 +03:00
priority of
2001-12-08 22:09:35 +03:00
.Ar utility .
1993-08-28 00:22:04 +04:00
.El
.Sh EXIT STATUS
1993-08-28 00:22:04 +04:00
The
1997-10-19 10:28:02 +04:00
.Nm
utility exits with one of the following values:
1993-08-28 00:22:04 +04:00
.Bl -tag -width indent
.It 1-125
2001-12-01 19:43:07 +03:00
An error occurred in the
1997-10-19 10:28:02 +04:00
.Nm
1993-08-28 00:22:04 +04:00
utility.
.It 126
2001-12-01 19:43:07 +03:00
The
1993-08-28 00:22:04 +04:00
.Ar utility
was found but could not be invoked.
.It 127
2001-12-01 19:43:07 +03:00
The
1993-08-28 00:22:04 +04:00
.Ar utility
could not be found.
.El
1993-03-21 12:45:37 +03:00
.Pp
2001-12-01 19:43:07 +03:00
Otherwise, the exit status of
1997-10-19 10:28:02 +04:00
.Nm
2001-12-01 19:43:07 +03:00
will be that of
1993-08-28 00:22:04 +04:00
.Ar utility .
.Sh COMPATIBILITY
2001-12-01 19:43:07 +03:00
The historic
.Fl Ns Ar increment
1993-08-28 00:22:04 +04:00
option has been deprecated but is still supported in this implementation.
1993-03-21 12:45:37 +03:00
.Sh SEE ALSO
.Xr csh 1 ,
1997-08-25 20:42:36 +04:00
.Xr getpriority 2 ,
.Xr setpriority 2 ,
1993-03-21 12:45:37 +03:00
.Xr renice 8
1993-08-28 00:22:04 +04:00
.Sh STANDARDS
The
1997-10-19 10:28:02 +04:00
.Nm
2001-12-01 19:43:07 +03:00
utility conforms to
1993-08-28 00:22:04 +04:00
.St -p1003.2-92 .
1993-03-21 12:45:37 +03:00
.Sh HISTORY
A
1997-10-19 10:28:02 +04:00
.Nm
1993-08-28 00:22:04 +04:00
utility appeared in
1993-03-21 12:45:37 +03:00
.At v6 .
.Sh BUGS
1997-10-19 10:28:02 +04:00
.Nm
1993-03-21 12:45:37 +03:00
is built into
.Xr csh 1
2002-09-30 15:08:56 +04:00
with a slightly different syntax than described here.
The form
1993-03-21 12:45:37 +03:00
.Ql nice +10
nices to positive nice, and
.Ql nice \-10
can be used
by the super-user to give a process more of the processor.