d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
e7ed0f64bf
freebsd-nq/usr.bin/nice/nice.1

125 lines
3.5 KiB
Groff
Raw Normal View History

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
mdoc(7) police: removed HISTORY info from the .Os call.
2001-07-10 14:16:33 +00:00
.Os
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
.Sh NAME
.Nm nice
Support the SUSv3 -n option and the "--" end of options marker. Replace "command" with "utility" in the manual page & source to be more consistent with the terminology used in the standard, and to hint that shell builtin commands won't work. Submitted by: Peter Avalos <pavalos@theshell.com> (partially) Approved by: mike
2002-05-12 22:49:48 +00:00
.Nd execute a utility at an altered scheduling priority
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
.Sh SYNOPSIS
.Nm nice -> .Nm.
1998-03-23 07:45:40 +00:00
.Nm
Support the SUSv3 -n option and the "--" end of options marker. Replace "command" with "utility" in the manual page & source to be more consistent with the terminology used in the standard, and to hint that shell builtin commands won't work. Submitted by: Peter Avalos <pavalos@theshell.com> (partially) Approved by: mike
2002-05-12 22:49:48 +00:00
.Op Fl n Ar increment
.Ar utility
.Op Ar argument ...
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
.Sh DESCRIPTION
Use `The .Nm utility'
2002-04-20 12:18:28 +00:00
The
.Nm
utility runs
Support the SUSv3 -n option and the "--" end of options marker. Replace "command" with "utility" in the manual page & source to be more consistent with the terminology used in the standard, and to hint that shell builtin commands won't work. Submitted by: Peter Avalos <pavalos@theshell.com> (partially) Approved by: mike
2002-05-12 22:49:48 +00:00
.Ar utility
at an altered scheduling priority, by incrementing its
.Dq nice
value by the specified
.Ar increment ,
or a default value of 10.
The lower the nice value of a process, the higher its scheduling priority.
.Pp
The superuser may specify a negative increment in order to run a utility
with a higher scheduling prority.
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
.Pp
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
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.
Document the fairly obvious effect of the PATH environment variable.
2002-06-23 11:49:08 +00:00
.Sh ENVIRONMENT
The
.Ev PATH
environment variable is used to locate the requested
.Ar utility
if the name contains no
.Ql /
characters.
Match the reality. The man page was completely wrong.
1996-11-02 22:02:32 +00:00
.Sh EXAMPLES
Support the SUSv3 -n option and the "--" end of options marker. Replace "command" with "utility" in the manual page & source to be more consistent with the terminology used in the standard, and to hint that shell builtin commands won't work. Submitted by: Peter Avalos <pavalos@theshell.com> (partially) Approved by: mike
2002-05-12 22:49:48 +00:00
Execute utility
Remove whitespace at EOL.
2001-07-15 08:06:20 +00:00
.Sq date
Match the reality. The man page was completely wrong.
1996-11-02 22:02:32 +00:00
at priority 5 assuming the priority of the
Make the Examples section consistent with the rest of the system manual pages: description of command first, then command as typed (no shell prompt) using Dl macro.
2002-06-23 11:21:20 +00:00
shell is 0:
Match the reality. The man page was completely wrong.
1996-11-02 22:02:32 +00:00
.Pp
Make the Examples section consistent with the rest of the system manual pages: description of command first, then command as typed (no shell prompt) using Dl macro.
2002-06-23 11:21:20 +00:00
.Dl "nice -n 5 date"
Match the reality. The man page was completely wrong.
1996-11-02 22:02:32 +00:00
.Pp
Support the SUSv3 -n option and the "--" end of options marker. Replace "command" with "utility" in the manual page & source to be more consistent with the terminology used in the standard, and to hint that shell builtin commands won't work. Submitted by: Peter Avalos <pavalos@theshell.com> (partially) Approved by: mike
2002-05-12 22:49:48 +00:00
Execute utility
Remove whitespace at EOL.
2001-07-15 08:06:20 +00:00
.Sq date
Match the reality. The man page was completely wrong.
1996-11-02 22:02:32 +00:00
at priority -19 assuming the priority of the
Make the Examples section consistent with the rest of the system manual pages: description of command first, then command as typed (no shell prompt) using Dl macro.
2002-06-23 11:21:20 +00:00
shell is 0 and you are the super-user:
.Pp
.Dl "nice -n 16 nice -n -35 date"
According to POSIX, exit status must be 127 if the requested utility was not found, 126 if the execvp() failed for any other reason. Similar to rev. 1.6 to src/usr.bin/env/env.c Reviewed by: mike
2002-05-10 06:39:16 +00:00
.Sh DIAGNOSTICS
If
Support the SUSv3 -n option and the "--" end of options marker. Replace "command" with "utility" in the manual page & source to be more consistent with the terminology used in the standard, and to hint that shell builtin commands won't work. Submitted by: Peter Avalos <pavalos@theshell.com> (partially) Approved by: mike
2002-05-12 22:49:48 +00:00
.Ar utility
According to POSIX, exit status must be 127 if the requested utility was not found, 126 if the execvp() failed for any other reason. Similar to rev. 1.6 to src/usr.bin/env/env.c Reviewed by: mike
2002-05-10 06:39:16 +00:00
is invoked, the exit status of
.Nm
is the exit status of
Support the SUSv3 -n option and the "--" end of options marker. Replace "command" with "utility" in the manual page & source to be more consistent with the terminology used in the standard, and to hint that shell builtin commands won't work. Submitted by: Peter Avalos <pavalos@theshell.com> (partially) Approved by: mike
2002-05-12 22:49:48 +00:00
.Ar utility .
According to POSIX, exit status must be 127 if the requested utility was not found, 126 if the execvp() failed for any other reason. Similar to rev. 1.6 to src/usr.bin/env/env.c Reviewed by: mike
2002-05-10 06:39:16 +00:00
.Pp
An exit status of 126 indicates
Support the SUSv3 -n option and the "--" end of options marker. Replace "command" with "utility" in the manual page & source to be more consistent with the terminology used in the standard, and to hint that shell builtin commands won't work. Submitted by: Peter Avalos <pavalos@theshell.com> (partially) Approved by: mike
2002-05-12 22:49:48 +00:00
.Ar utility
According to POSIX, exit status must be 127 if the requested utility was not found, 126 if the execvp() failed for any other reason. Similar to rev. 1.6 to src/usr.bin/env/env.c Reviewed by: mike
2002-05-10 06:39:16 +00:00
was found, but could not be executed.
An exit status of 127 indicates
Support the SUSv3 -n option and the "--" end of options marker. Replace "command" with "utility" in the manual page & source to be more consistent with the terminology used in the standard, and to hint that shell builtin commands won't work. Submitted by: Peter Avalos <pavalos@theshell.com> (partially) Approved by: mike
2002-05-12 22:49:48 +00:00
.Ar utility
According to POSIX, exit status must be 127 if the requested utility was not found, 126 if the execvp() failed for any other reason. Similar to rev. 1.6 to src/usr.bin/env/env.c Reviewed by: mike
2002-05-10 06:39:16 +00:00
could not be found.
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
Support the SUSv3 -n option and the "--" end of options marker. Replace "command" with "utility" in the manual page & source to be more consistent with the terminology used in the standard, and to hint that shell builtin commands won't work. Submitted by: Peter Avalos <pavalos@theshell.com> (partially) Approved by: mike
2002-05-12 22:49:48 +00:00
.Sh COMPATIBILITY
The traditional
.Fl Ns Ar increment
option has been deprecated but is still supported.
.Sh STANDARDS
The
.Nm
utility conforms to
.St -p1003.1-2001 .
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
Support the SUSv3 -n option and the "--" end of options marker. Replace "command" with "utility" in the manual page & source to be more consistent with the terminology used in the standard, and to hint that shell builtin commands won't work. Submitted by: Peter Avalos <pavalos@theshell.com> (partially) Approved by: mike
2002-05-12 22:49:48 +00:00
utility appeared in
Correct History: nice(1) appeared in V4.
2002-06-03 14:56:57 +00:00
.At v4 .
Reference in New Issue Copy Permalink