usr.bin/renice/renice.8

   1 .\" Copyright (c) 1983, 1991, 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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .Dd October 27, 2020
  29 .Dt RENICE 8
  30 .Os
  31 .Sh NAME
  32 .Nm renice
  33 .Nd alter priority of running processes
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Ar priority
  37 .Op Oo Fl gpu Oc Ar target
  38 .Nm
  39 .Fl n Ar increment
  40 .Op Oo Fl gpu Oc Ar target
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 utility alters the
  45 scheduling priority of one or more running processes.
  46 The following
  47 .Ar target
  48 parameters are interpreted as process ID's (the default), process group
  49 ID's, user ID's or user names.
  50 The
  51 .Nm Ns 'ing
  52 of a process group causes all processes in the process group
  53 to have their scheduling priority altered.
  54 The
  55 .Nm Ns 'ing
  56 of a user causes all processes owned by the user to have
  57 their scheduling priority altered.
  58 .Pp
  59 The following options are available:
  60 .Bl -tag -width indent
  61 .It Fl n
  62 Instead of changing the specified processes to the given priority,
  63 interpret the following argument as an increment to be applied to
  64 the current priority of each process.
  65 .It Fl g
  66 Interpret
  67 .Ar target
  68 parameters as process group ID's.
  69 .It Fl p
  70 Interpret
  71 .Ar target
  72 parameters as process ID's (the default).
  73 .It Fl u
  74 Interpret
  75 .Ar target
  76 parameters as user names or user ID's.
  77 .El
  78 .Pp
  79 Users other than the super-user may only alter the priority of
  80 processes they own,
  81 and can only monotonically increase their ``nice value''
  82 within the range 0 to
  83 .Dv PRIO_MAX
  84 (20).
  85 (This prevents overriding administrative fiats.)
  86 The super-user
  87 may alter the priority of any process
  88 and set the priority to any value in the range
  89 .Dv PRIO_MIN
  90 (\-20)
  91 to
  92 .Dv PRIO_MAX .
  93 Useful priorities are:
  94 20 (the affected processes will run only when nothing else
  95 in the system wants to),
  96 0 (the ``base'' scheduling priority),
  97 anything negative (to make things go very fast).
  98 .Sh FILES
  99 .Bl -tag -width /etc/passwd -compact
 100 .It Pa /etc/passwd
 101 to map user names to user ID's
 102 .El
 103 .Sh EXAMPLES
 104 Change the priority of process ID's 987 and 32, and
 105 all processes owned by users daemon and root.
 106 .Pp
 107 .Dl "renice +1 987 -u daemon root -p 32"
 108 .Sh SEE ALSO
 109 .Xr nice 1 ,
 110 .Xr rtprio 1 ,
 111 .Xr getpriority 2 ,
 112 .Xr setpriority 2
 113 .Sh STANDARDS
 114 The
 115 .Nm
 116 utility conforms to
 117 .St -p1003.1-2001 .
 118 .Sh HISTORY
 119 The
 120 .Nm
 121 utility appeared in
 122 .Bx 4.0 .
 123 .Sh BUGS
 124 Non super-users cannot increase scheduling priorities of their own processes,
 125 even if they were the ones that decreased the priorities in the first place.