share/man/man1/nice.1

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 2004, Sun Microsystems, Inc.  All Rights Reserved  Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH NICE 1 "Oct 25, 2017"
  11 .SH NAME
  12 nice \- invoke a command with an altered scheduling priority
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 \fB/usr/bin/nice\fR [\fB-\fIincrement\fR\fR | \fB-n\fR \fIincrement\fR] \fIcommand\fR
  17      [\fIargument\fR]...
  18 .fi
  19
  20 .SS "csh Builtin"
  21 .LP
  22 .nf
  23 \fBnice\fR [\fB-\fIincrement\fR\fR | +\fIincrement\fR] [\fIcommand\fR]
  24 .fi
  25
  26 .SH DESCRIPTION
  27 .sp
  28 .LP
  29 The \fBnice\fR utility invokes \fBcommand\fR, requesting that it be run with a
  30 different system scheduling priority. The \fBpriocntl\fR(1) command is a more
  31 general interface to scheduler functions.
  32 .sp
  33 .LP
  34 The invoking process (generally the user's shell) must be in a scheduling class
  35 that supports \fBnice\fR.
  36 .sp
  37 .LP
  38 If the C shell (see \fBcsh\fR(1)) is used, the full path of the command must be
  39 specified. Otherwise, the \fBcsh\fR built-in version of \fBnice\fR will be
  40 invoked. See \fBcsh Builtin\fR below.
  41 .sp
  42 .LP
  43 If \fBnice\fR executes commands with arguments, it uses the default shell
  44 \fB/usr/bin/sh\fR (see \fBsh\fR(1)).
  45 .SS "csh Builtin"
  46 .sp
  47 .LP
  48 \fBnice\fR is also a \fBcsh\fR built-in command with behavior different from
  49 the utility versions.  See \fBcsh\fR(1) for description.
  50 .SH OPTIONS
  51 .sp
  52 .LP
  53 The following options are supported:
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fB-\fR\fIincrement\fR | \fB-n\fR \fIincrement\fR\fR
  58 .ad
  59 .RS 29n
  60 \fIincrement\fR is a positive or negative decimal integer that has the same
  61 effect on the execution of the utility as if the utility had called the
  62 \fBnice()\fR function with the numeric value of the \fIincrement\fR
  63 option-argument. See \fBnice\fR(2). \fBnice()\fR errors, other than
  64 \fBEINVAL\fR, are ignored. If not specified, an increment of \fB10\fR is
  65 assumed.
  66 .sp
  67 The super-user may run commands with priority higher than normal by using a
  68 negative increment such as \fB-10\fR\&. A negative \fIincrement\fR assigned by
  69 an unprivileged user is ignored.
  70 .RE
  71
  72 .SH OPERANDS
  73 .sp
  74 .LP
  75 The following operands are supported:
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fIcommand\fR\fR
  80 .ad
  81 .RS 12n
  82 The name of a command that is to be invoked. If \fIcommand\fR names any of the
  83 special built-in utilities (see \fBshell_builtins\fR(1)), the results are
  84 undefined.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fIargument\fR\fR
  91 .ad
  92 .RS 12n
  93 Any string to be supplied as an argument when invoking \fIcommand\fR.
  94 .RE
  95
  96 .SH ENVIRONMENT VARIABLES
  97 .sp
  98 .LP
  99 See \fBenviron\fR(5) for descriptions of the following environment variables
 100 that affect the execution of \fBnice\fR: \fBLANG\fR, \fBLC_ALL\fR,
 101 \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, \fBPATH\fR, and \fBNLSPATH\fR.
 102 .SH EXIT STATUS
 103 .sp
 104 .LP
 105 If \fIcommand\fR is invoked, the exit status of \fBnice\fR will be the exit
 106 status of \fIcommand\fR. Otherwise, \fBnice\fR will exit with one of the
 107 following values:
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fB1-125\fR\fR
 112 .ad
 113 .RS 9n
 114 An error occurred.
 115 .RE
 116
 117 .sp
 118 .ne 2
 119 .na
 120 \fB\fB126\fR\fR
 121 .ad
 122 .RS 9n
 123 \fIcommand\fR was found but could not be invoked.
 124 .RE
 125
 126 .sp
 127 .ne 2
 128 .na
 129 \fB\fB127\fR\fR
 130 .ad
 131 .RS 9n
 132 \fIcommand\fR could not be found.
 133 .RE
 134
 135 .SH ATTRIBUTES
 136 .sp
 137 .LP
 138 See \fBattributes\fR(5) for descriptions of the following attributes:
 139 .SS "/usr/bin/nice"
 140 .sp
 141
 142 .sp
 143 .TS
 144 box;
 145 c | c
 146 l | l .
 147 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 148 _
 149 CSI     Enabled
 150 _
 151 Interface Stability     Standard
 152 .TE
 153
 154 .SH SEE ALSO
 155 .sp
 156 .LP
 157 \fBcsh\fR(1), \fBksh\fR(1), \fBnohup\fR(1), \fBpriocntl\fR(1), \fBsh\fR(1),
 158 \fBshell_builtins\fR(1), \fBnice\fR(2), \fBattributes\fR(5), \fBenviron\fR(5),
 159 \fBstandards\fR(5)