freebsd-skq/usr.bin/nice/nice.1

.\" Copyright (c) 1980, 1990, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" 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. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    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
.\" $FreeBSD$
.\"
.Dd June 6, 1993
.Dt NICE 1
.Os BSD 4
.Sh NAME
.Nm nice
.Nd execute a command at a low scheduling priority
.Sh SYNOPSIS
.Nm
.Op Fl Ns Ar number
.Ar command
.Op Ar arguments
.Sh DESCRIPTION
.Nm Nice
runs
.Ar command
at a low priority.
(Think of low and slow).
If
.Fl Ns Ar number
is not given,
.Nm 
assumes the value 10.
The priority is a value in the range -20 to 20.
The default priority is 0, priority 20 is the lowest possible. 
.Nm Nice
will execute
.Ar command
at priority
.Ar number
relative to the priority
of 
.Nm .
Higher priorities than the
current process priority can only requested by the
super-user. 
Negative numbers are expressed as
.Fl - Ns Ar number .
.Pp
The returned exit status is the exit value from the
command executed by
.Nm .
.Pp
Some shells may provide a builtin
.Nm
command which is similar or identical to this utility.
Consult the
.Xr builtin 1
manual page.
.Sh EXAMPLES
$ nice -5 date
.Pp
Execute command 
.Sq date 
at priority 5 assuming the priority of the
shell is 0.
.Pp
# nice -16 nice --35 date
.Pp
Execute command 
.Sq date 
at priority -19 assuming the priority of the
shell is 0 and you are the super-user.
.Sh SEE ALSO
.Xr builtin 1 ,
.Xr csh 1 ,
.Xr idprio 1 ,
.Xr rtprio 1 ,
.Xr getpriority 2 ,
.Xr setpriority 2 ,
.Xr renice 8
.Sh HISTORY
A
.Nm
command appeared in
.At v6 .
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" Copyright (c) 1980, 1990, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" 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. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed by the University of`
			`.\" California, Berkeley and its contributors.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" 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`
$Id$ -> $FreeBSD$ 1999-08-28 01:08:13 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\"`
			`.Dd June 6, 1993`
			`.Dt NICE 1`
			`.Os BSD 4`
			`.Sh NAME`
			`.Nm nice`
			`.Nd execute a command at a low scheduling priority`
			`.Sh SYNOPSIS`
.Nm nice -> .Nm. 1998-03-23 07:45:40 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Op Fl Ns Ar number`
			`.Ar command`
			`.Op Ar arguments`
			`.Sh DESCRIPTION`
			`.Nm Nice`
			`runs`
			`.Ar command`
			`at a low priority.`
			`(Think of low and slow).`
			`If`
			`.Fl Ns Ar number`
Fix a typo and a punctuation mistake, the two of which conspired against the reader. 2000-11-29 06:55:13 +00:00			`is not given,`
Match the reality. The man page was completely wrong. 1996-11-02 22:02:32 +00:00			`.Nm`
Fix a typo and a punctuation mistake, the two of which conspired against the reader. 2000-11-29 06:55:13 +00:00			`assumes the value 10.`
Correct some hard sentence breaks. Only those surrounding the previous commit and those which cause ugly nroff output have been fixed, since the purpose of the style guideline which they contravene is to reduce the sizes of deltas. Reported by: bde 1999-09-14 11:46:04 +00:00			`The priority is a value in the range -20 to 20.`
			`The default priority is 0, priority 20 is the lowest possible.`
Match the reality. The man page was completely wrong. 1996-11-02 22:02:32 +00:00			`.Nm Nice`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`will execute`
			`.Ar command`
Match the reality. The man page was completely wrong. 1996-11-02 22:02:32 +00:00			`at priority`
			`.Ar number`
			`relative to the priority`
			`of`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm .`
Match the reality. The man page was completely wrong. 1996-11-02 22:02:32 +00:00			`Higher priorities than the`
			`current process priority can only requested by the`
			`super-user.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`Negative numbers are expressed as`
			`.Fl - Ns Ar number .`
			`.Pp`
			`The returned exit status is the exit value from the`
			`command executed by`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm .`
Improve shell documentation: * Consistently misspell built-in as builtin. * Add a builtin(1) manpage and create builtin(1) MLINKS for all shell builtin commands for which no standalone utility exists. These MLINKS replace those that were created for csh(1). * Add appropriate xrefs for builtin(1) to the csh(1) and sh(1) manpages, as well as to the manpages of standalone utilities which are supported as shell builtin commands in at least one of the shells. In such manpages, explain that similar functionality may be provided as a shell builtin command. * Improve sh(1)'s description of the cd builtin command. Csh(1) already describes it adequately. Replace the cd(1) manpage with a builtin(1) MLINKS link. * Clean up some mdoc problems: use Xr instead of literal "foo(n)"; use Ic instead of Xr for shell builtin commands. * Undo English contractions. Reviewed by: mpp, rgrimes 1999-09-08 15:40:46 +00:00			`.Pp`
			`Some shells may provide a builtin`
			`.Nm`
Correct some hard sentence breaks. Only those surrounding the previous commit and those which cause ugly nroff output have been fixed, since the purpose of the style guideline which they contravene is to reduce the sizes of deltas. Reported by: bde 1999-09-14 11:46:04 +00:00			`command which is similar or identical to this utility.`
			`Consult the`
Improve shell documentation: * Consistently misspell built-in as builtin. * Add a builtin(1) manpage and create builtin(1) MLINKS for all shell builtin commands for which no standalone utility exists. These MLINKS replace those that were created for csh(1). * Add appropriate xrefs for builtin(1) to the csh(1) and sh(1) manpages, as well as to the manpages of standalone utilities which are supported as shell builtin commands in at least one of the shells. In such manpages, explain that similar functionality may be provided as a shell builtin command. * Improve sh(1)'s description of the cd builtin command. Csh(1) already describes it adequately. Replace the cd(1) manpage with a builtin(1) MLINKS link. * Clean up some mdoc problems: use Xr instead of literal "foo(n)"; use Ic instead of Xr for shell builtin commands. * Undo English contractions. Reviewed by: mpp, rgrimes 1999-09-08 15:40:46 +00:00			`.Xr builtin 1`
			`manual page.`
Match the reality. The man page was completely wrong. 1996-11-02 22:02:32 +00:00			`.Sh EXAMPLES`
			`$ nice -5 date`
			`.Pp`
			`Execute command`
			`.Sq date`
			`at priority 5 assuming the priority of the`
			`shell is 0.`
			`.Pp`
			`# nice -16 nice --35 date`
			`.Pp`
			`Execute command`
			`.Sq date`
			`at priority -19 assuming the priority of the`
			`shell is 0 and you are the super-user.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh SEE ALSO`
Improve shell documentation: * Consistently misspell built-in as builtin. * Add a builtin(1) manpage and create builtin(1) MLINKS for all shell builtin commands for which no standalone utility exists. These MLINKS replace those that were created for csh(1). * Add appropriate xrefs for builtin(1) to the csh(1) and sh(1) manpages, as well as to the manpages of standalone utilities which are supported as shell builtin commands in at least one of the shells. In such manpages, explain that similar functionality may be provided as a shell builtin command. * Improve sh(1)'s description of the cd builtin command. Csh(1) already describes it adequately. Replace the cd(1) manpage with a builtin(1) MLINKS link. * Clean up some mdoc problems: use Xr instead of literal "foo(n)"; use Ic instead of Xr for shell builtin commands. * Undo English contractions. Reviewed by: mpp, rgrimes 1999-09-08 15:40:46 +00:00			`.Xr builtin 1 ,`
Sort cross references. 1997-01-15 23:25:55 +00:00			`.Xr csh 1 ,`
Add ref to idprio(1). 1997-07-21 23:05:06 +00:00			`.Xr idprio 1 ,`
Various man page cleanup: - Sort xrefs - Be consistent with section names as outlines in mdoc(7). - Other misc mdoc cleanup. PR: doc/13144 Submitted by: Alexey M. Zelkin <phantom@cris.net> 1999-08-15 08:25:34 +00:00			`.Xr rtprio 1 ,`
Match the reality. The man page was completely wrong. 1996-11-02 22:02:32 +00:00			`.Xr getpriority 2 ,`
			`.Xr setpriority 2 ,`
Various man page cleanup: - Sort xrefs - Be consistent with section names as outlines in mdoc(7). - Other misc mdoc cleanup. PR: doc/13144 Submitted by: Alexey M. Zelkin <phantom@cris.net> 1999-08-15 08:25:34 +00:00			`.Xr renice 8`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh HISTORY`
			`A`
.Nm nice -> .Nm. 1998-03-23 07:45:40 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`command appeared in`
			`.At v6 .`