This commit was manufactured by cvs2svn to create tag 'FreeBSD-release/1.1'.

[unix-history] / usr.bin / nice / nice.1

diff --git a/usr.bin/nice/nice.1 b/usr.bin/nice/nice.1
index 2d95baf..e3fa9e5 100644 (file)
--- a/usr.bin/nice/nice.1
+++ b/usr.bin/nice/nice.1
@@ -1,7 +1,6 @@
 .\" Copyright (c) 1980, 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" Copyright (c) 1980, 1990 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:
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
 .\" are met:


@@ -30,63 +29,84 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"

-.\"    @(#)nice.1      6.7 (Berkeley) 7/24/91
+.\"    from: @(#)nice.1        6.7 (Berkeley) 7/24/91
+.\"    $Id: nice.1,v 1.3 1994/04/24 01:23:11 jkh Exp $

 .\"
 .Dd July 24, 1991
 .Dt NICE 1
 .\"
 .Dd July 24, 1991
 .Dt NICE 1

-.Os BSD 4
+.Os 

 .Sh NAME
 .Nm nice
 .Sh NAME
 .Nm nice

-.Nd execute a Bourne shell command at a low scheduling priority
+.Nd execute a utility with an altered scheduling priority

 .Sh SYNOPSIS
 .Nm nice
 .Sh SYNOPSIS
 .Nm nice

-.Op Fl Ns Ar number
-.Ar command
-.Op Ar arguments
+.Op Fl n Ar increment
+.Ar utility
+.Op Ar argument ...

 .Sh DESCRIPTION
 .Nm Nice
 runs
 .Sh DESCRIPTION
 .Nm Nice
 runs

-.Ar command
-at a low priority.
-(Think of low and slow).
-If
-.Fl Ns Ar number
-is specified, and if it is greater than or equal
-to 10 (the default),
+.Ar utility
+at an altered scheduling priority.
+If an 
+.Ar increment 
+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
+a negative 
+.Ar increment .
+The priority can be adjusted over a
+range of -20 (the higest) to 20 (the lowest).
+.Pp
+Available options:
+.Bl -tag -width indent
+.It Fl n Ar increment
+A positive or negative decimal integer used to modify the system scheduling
+priority of 
+.Ar utility.
+.El
+.Sh DIAGNOSTICS
+The

 .Nm nice
 .Nm nice

-will execute
-.Ar command
-at that priority.
-The upper bound, or lowest priority that
+utility shall exit with one of the following values:
+.Bl -tag -width indent
+.It 1-125
+An error occurred in the 

 .Nm nice
 .Nm nice

-will run a command is 20.
-The lower bounds or
-higher priorities (integers less than 10)
-can only be requested by the super-user.
-Negative numbers are expressed as
-.Fl - Ns Ar number .
+utility.
+.It 126
+The 
+.Ar utility
+was found but could not be invoked.
+.It 127
+The 
+.Ar utility
+could not be found.
+.El

 .Pp
 .Pp

-The returned exit status is the exit value from the
-command executed by
-.Nm nice .
+Otherwise, the exit status of 
+.Nm nice
+shall be that of 
+.Ar utility .
+.Sh COMPATIBILITY
+The historic 
+.Fl Ns Ar increment 
+option has been deprecated but is still supported in this implementation.

 .Sh SEE ALSO
 .Xr csh 1 ,
 .Xr renice 8
 .Sh SEE ALSO
 .Xr csh 1 ,
 .Xr renice 8

+.Sh STANDARDS
+The
+.Nm nice
+utility conforms to 
+.St -p1003.2-92 .

 .Sh HISTORY
 A
 .Nm nice
 .Sh HISTORY
 A
 .Nm nice

-command appeared in
+utility appeared in

 .At v6 .
 .Sh BUGS
 .Nm Nice
 .At v6 .
 .Sh BUGS
 .Nm Nice

-is particular to
-.Xr sh  1  .
-If you use
-.Xr csh  1  ,
-then commands executed with ``&'' are automatically immune to hangup
-signals while in the background.
-.Pp
-.Nm Nice

 is built into
 .Xr csh  1
 with a slightly different syntax than described here.  The form
 is built into
 .Xr csh  1
 with a slightly different syntax than described here.  The form