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. 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 .\" $FreeBSD: src/usr.bin/renice/renice.8,v 1.16 2003/02/26 20:27:24 charnier Exp $
  34 .\"
  35 .Dd June 9, 1993
  36 .Dt RENICE 8
  37 .Os
  38 .Sh NAME
  39 .Nm renice
  40 .Nd alter priority of running processes
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Ar priority
  44 .Op Oo Fl p Oc Ar pid ...
  45 .Op Oo Fl g Oc Ar pgrp ...
  46 .Op Oo Fl u Oc Ar user ...
  47 .Nm
  48 .Fl n Ar increment
  49 .Op Oo Fl p Oc Ar pid ...
  50 .Op Oo Fl g Oc Ar pgrp ...
  51 .Op Oo Fl u Oc Ar user ...
  52 .Sh DESCRIPTION
  53 The
  54 .Nm
  55 utility alters the
  56 scheduling priority of one or more running processes.
  57 The following
  58 .Ar who
  59 parameters are interpreted as process ID's, process group
  60 ID's, user ID's or user names.
  61 The
  62 .Nm Ns 'ing
  63 of a process group causes all processes in the process group
  64 to have their scheduling priority altered.
  65 The
  66 .Nm Ns 'ing
  67 of a user causes all processes owned by the user to have
  68 their scheduling priority altered.
  69 By default, the processes to be affected are specified by
  70 their process ID's.
  71 .Pp
  72 The following options are available:
  73 .Bl -tag -width indent
  74 .It Fl g
  75 Force
  76 .Ar who
  77 parameters to be interpreted as process group ID's.
  78 .It Fl n
  79 Instead of changing the specified processes to the given priority,
  80 interpret the following argument as an increment to be applied to
  81 the current priority of each process.
  82 .It Fl u
  83 Force the
  84 .Ar who
  85 parameters to be interpreted as user names or user ID's.
  86 .It Fl p
  87 Reset the
  88 .Ar who
  89 interpretation to be (the default) process ID's.
  90 .El
  91 .Pp
  92 For example,
  93 .Pp
  94 .Dl "renice +1 987 -u daemon root -p 32"
  95 .Pp
  96 would change the priority of process ID's 987 and 32, and
  97 all processes owned by users daemon and root.
  98 .Pp
  99 Users other than the super-user may only alter the priority of
 100 processes they own,
 101 and can only monotonically increase their ``nice value''
 102 within the range 0 to
 103 .Dv PRIO_MAX
 104 (20).
 105 (This prevents overriding administrative fiats.)
 106 The super-user
 107 may alter the priority of any process
 108 and set the priority to any value in the range
 109 .Dv PRIO_MIN
 110 (\-20)
 111 to
 112 .Dv PRIO_MAX .
 113 Useful priorities are:
 114 20 (the affected processes will run at the lowest priority),
 115 0 (the ``base'' scheduling priority),
 116 anything negative (lower values cause more favorable scheduling).
 117 .Sh FILES
 118 .Bl -tag -width /etc/passwd -compact
 119 .It Pa /etc/passwd
 120 to map user names to user ID's
 121 .El
 122 .Sh SEE ALSO
 123 .Xr nice 1 ,
 124 .Xr rtprio 1 ,
 125 .Xr getpriority 2 ,
 126 .Xr setpriority 2
 127 .Sh STANDARDS
 128 The
 129 .Nm
 130 utility conforms to
 131 .St -p1003.1-2001 .
 132 .Sh HISTORY
 133 The
 134 .Nm
 135 utility appeared in
 136 .Bx 4.0 .
 137 .Sh BUGS
 138 Non super-users cannot increase scheduling priorities of their own processes,
 139 even if they were the ones that decreased the priorities in the first place.