sys-utils/renice.1

   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. 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 .\"     @(#)renice.8   8.1 (Berkeley) 6/9/93
  33 .\"
  34 .Dd June 9, 1993
  35 .Dt RENICE 1
  36 .Os BSD 4
  37 .Sh NAME
  38 .Nm renice
  39 .Nd alter priority of running processes
  40 .Sh SYNOPSIS
  41 .Nm renice
  42 .Op Fl n
  43 .Ar priority
  44 .Oo
  45 .Op Fl p
  46 .Ar pid ...
  47 .Oc
  48 .Oo
  49 .Op Fl g
  50 .Ar pgrp ...
  51 .Oc
  52 .Oo
  53 .Op Fl u
  54 .Ar user ...
  55 .Oc
  56 .Nm renice
  57 .Fl h | Fl v
  58 .Sh DESCRIPTION
  59 .Nm Renice
  60 alters the
  61 scheduling priority of one or more running processes.
  62 The following
  63 .Ar who
  64 parameters are interpreted as process ID's, process group
  65 ID's, or user names.
  66 .Nm Renice Ns 'ing
  67 a process group causes all processes in the process group
  68 to have their scheduling priority altered.
  69 .Nm Renice Ns 'ing
  70 a user causes all processes owned by the user to have
  71 their scheduling priority altered.
  72 By default, the processes to be affected are specified by
  73 their process ID's.
  74 .Pp
  75 Options supported by
  76 .Nm renice :
  77 .Bl -tag -width Ds
  78 .It Fl n, Fl Fl priority
  79 The scheduling
  80 .Ar priority
  81 of the process, process group, or user.
  82 .It Fl g, Fl Fl pgrp
  83 Force
  84 .Ar who
  85 parameters to be interpreted as process group ID's.
  86 .It Fl u, Fl Fl user
  87 Force the
  88 .Ar who
  89 parameters to be interpreted as user names.
  90 .It Fl p, Fl Fl pid
  91 Resets the
  92 .Ar who
  93 interpretation to be (the default) process ID's.
  94 .It Fl v, Fl Fl version
  95 Print version.
  96 .It Fl h, Fl Fl help
  97 Print help.
  98 .El
  99 .Pp
 100 For example,
 101 .Bd -literal -offset
 102 renice +1 987 -u daemon root -p 32
 103 .Ed
 104 .Pp
 105 would change the priority of process ID's 987 and 32, and
 106 all processes owned by users daemon and root.
 107 .Pp
 108 Users other than the super-user may only alter the priority of
 109 processes they own,
 110 and can only monotonically increase their ``nice value''
 111 within the range 0 to
 112 .Dv PRIO_MAX
 113 (20).
 114 (This prevents overriding administrative fiats.)
 115 The super-user
 116 may alter the priority of any process
 117 and set the priority to any value in the range
 118 .Dv PRIO_MIN
 119 (\-20)
 120 to
 121 .Dv PRIO_MAX .
 122 Useful priorities are:
 123 20 (the affected processes will run only when nothing else
 124 in the system wants to),
 125 0 (the ``base'' scheduling priority),
 126 anything negative (to make things go very fast).
 127 .Sh FILES
 128 .Bl -tag -width /etc/passwd -compact
 129 .It Pa /etc/passwd
 130 to map user names to user ID's
 131 .El
 132 .Sh SEE ALSO
 133 .Xr getpriority 2 ,
 134 .Xr setpriority 2
 135 .Sh BUGS
 136 Non super-users can not increase scheduling priorities of their own processes,
 137 even if they were the ones that decreased the priorities in the first place.
 138 .br
 139 The Linux kernel (at least version 2.0.0) and linux libc (at least
 140 version 5.2.18) does not agree entirely on what the specifics of the
 141 systemcall interface to set nice values is.  Thus causes renice to
 142 report bogus previous nice values.
 143 .Sh HISTORY
 144 The
 145 .Nm
 146 command appeared in
 147 .Bx 4.0 .
 148 .Sh AVAILABILITY
 149 The renice command is part of the util-linux-ng package and is available from
 150 ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/.