usr.bin/nice/nice.1

   1 .\" Copyright (c) 1980, 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)nice.1      8.1 (Berkeley) 6/6/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd June 6, 1993
  36 .Dt NICE 1
  37 .Os
  38 .Sh NAME
  39 .Nm nice
  40 .Nd execute a utility at an altered scheduling priority
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl n Ar increment
  44 .Ar utility
  45 .Op Ar argument ...
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 utility runs
  50 .Ar utility
  51 at an altered scheduling priority, by incrementing its
  52 .Dq nice
  53 value by the specified
  54 .Ar increment ,
  55 or a default value of 10.
  56 The lower the nice value of a process, the higher its scheduling priority.
  57 .Pp
  58 The superuser may specify a negative increment in order to run a utility
  59 with a higher scheduling priority.
  60 .Pp
  61 Some shells may provide a builtin
  62 .Nm
  63 command which is similar or identical to this utility.
  64 Consult the
  65 .Xr builtin 1
  66 manual page.
  67 .Sh ENVIRONMENT
  68 The
  69 .Ev PATH
  70 environment variable is used to locate the requested
  71 .Ar utility
  72 if the name contains no
  73 .Ql /
  74 characters.
  75 .Sh EXIT STATUS
  76 If
  77 .Ar utility
  78 is invoked, the exit status of
  79 .Nm
  80 is the exit status of
  81 .Ar utility .
  82 .Pp
  83 An exit status of 126 indicates
  84 .Ar utility
  85 was found, but could not be executed.
  86 An exit status of 127 indicates
  87 .Ar utility
  88 could not be found.
  89 .Sh EXAMPLES
  90 Execute utility
  91 .Sq date
  92 at priority 5 assuming the priority of the
  93 shell is 0:
  94 .Pp
  95 .Dl "nice -n 5 date"
  96 .Pp
  97 Execute utility
  98 .Sq date
  99 at priority -19 assuming the priority of the
 100 shell is 0 and you are the super-user:
 101 .Pp
 102 .Dl "nice -n 16 nice -n -35 date"
 103 .Sh COMPATIBILITY
 104 The traditional
 105 .Fl Ns Ar increment
 106 option has been deprecated but is still supported.
 107 .Sh SEE ALSO
 108 .Xr builtin 1 ,
 109 .Xr csh 1 ,
 110 .Xr idprio 1 ,
 111 .Xr rtprio 1 ,
 112 .Xr getpriority 2 ,
 113 .Xr setpriority 2 ,
 114 .Xr renice 8
 115 .Sh STANDARDS
 116 The
 117 .Nm
 118 utility conforms to
 119 .St -p1003.1-2001 .
 120 .Sh HISTORY
 121 A
 122 .Nm
 123 utility appeared in
 124 .At v4 .