usr.bin/nice/nice.1

   1 .\"     $NetBSD: nice.1,v 1.13 2002/09/30 11:09:07 grant Exp $
   2 .\"
   3 .\" Copyright (c) 1980, 1990, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)nice.1      8.1 (Berkeley) 6/6/93
  31 .\"
  32 .Dd June 6, 1993
  33 .Dt NICE 1
  34 .Os
  35 .Sh NAME
  36 .Nm nice
  37 .Nd execute a utility with an altered scheduling priority
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Op Fl n Ar increment
  41 .Ar utility
  42 .Op Ar argument ...
  43 .Sh DESCRIPTION
  44 .Nm
  45 runs
  46 .Ar utility
  47 at an altered scheduling priority.
  48 If an
  49 .Ar increment
  50 is given, it is used; otherwise
  51 an increment of 10 is assumed.
  52 The super-user can run utilities with priorities higher than normal by using
  53 a negative
  54 .Ar increment .
  55 The priority can be adjusted over a
  56 range of -20 (the highest) to 20 (the lowest).
  57 A priority of 19 or 20
  58 will prevent a process from taking any cycles from others at nice 0 or
  59 better.
  60 .Pp
  61 Available options:
  62 .Bl -tag -width indent
  63 .It Fl n Ar increment
  64 A positive or negative decimal integer used to modify the system scheduling
  65 priority of
  66 .Ar utility .
  67 .El
  68 .Sh EXIT STATUS
  69 The
  70 .Nm
  71 utility exits with one of the following values:
  72 .Bl -tag -width indent
  73 .It 1-125
  74 An error occurred in the
  75 .Nm
  76 utility.
  77 .It 126
  78 The
  79 .Ar utility
  80 was found but could not be invoked.
  81 .It 127
  82 The
  83 .Ar utility
  84 could not be found.
  85 .El
  86 .Pp
  87 Otherwise, the exit status of
  88 .Nm
  89 will be that of
  90 .Ar utility .
  91 .Sh COMPATIBILITY
  92 The historic
  93 .Fl Ns Ar increment
  94 option has been deprecated but is still supported in this implementation.
  95 .Sh SEE ALSO
  96 .Xr csh 1 ,
  97 .Xr getpriority 2 ,
  98 .Xr setpriority 2 ,
  99 .Xr renice 8
 100 .Sh STANDARDS
 101 The
 102 .Nm
 103 utility conforms to
 104 .St -p1003.2-92 .
 105 .Sh HISTORY
 106 A
 107 .Nm
 108 utility appeared in
 109 .At v6 .
 110 .Sh BUGS
 111 .Nm
 112 is built into
 113 .Xr csh  1
 114 with a slightly different syntax than described here.
 115 The form
 116 .Ql nice +10
 117 nices to positive nice, and
 118 .Ql nice \-10
 119 can be used
 120 by the super-user to give a process more of the processor.