|
Packit |
7cfc04 |
'\" et
|
|
Packit |
7cfc04 |
.TH NICE "3P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
|
|
Packit |
7cfc04 |
.SH PROLOG
|
|
Packit |
7cfc04 |
This manual page is part of the POSIX Programmer's Manual.
|
|
Packit |
7cfc04 |
The Linux implementation of this interface may differ (consult
|
|
Packit |
7cfc04 |
the corresponding Linux manual page for details of Linux behavior),
|
|
Packit |
7cfc04 |
or the interface may not be implemented on Linux.
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
.SH NAME
|
|
Packit |
7cfc04 |
nice
|
|
Packit |
7cfc04 |
\(em change the nice value of a process
|
|
Packit |
7cfc04 |
.SH SYNOPSIS
|
|
Packit |
7cfc04 |
.LP
|
|
Packit |
7cfc04 |
.nf
|
|
Packit |
7cfc04 |
#include <unistd.h>
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
int nice(int \fIincr\fP);
|
|
Packit |
7cfc04 |
.fi
|
|
Packit |
7cfc04 |
.SH DESCRIPTION
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
\fInice\fR()
|
|
Packit |
7cfc04 |
function shall add the value of
|
|
Packit |
7cfc04 |
.IR incr
|
|
Packit |
7cfc04 |
to the nice value of the calling process. A nice value of a process is
|
|
Packit |
7cfc04 |
a non-negative number for which a more positive value shall result in
|
|
Packit |
7cfc04 |
less favorable scheduling.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
A maximum nice value of 2*{NZERO}\(mi1 and a minimum nice value of 0
|
|
Packit |
7cfc04 |
shall be imposed by the system. Requests for values above or below
|
|
Packit |
7cfc04 |
these limits shall result in the nice value being set to the
|
|
Packit |
7cfc04 |
corresponding limit. Only a process with appropriate privileges can
|
|
Packit |
7cfc04 |
lower the nice value.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
Calling the
|
|
Packit |
7cfc04 |
\fInice\fR()
|
|
Packit |
7cfc04 |
function has no effect on the priority of processes or threads with
|
|
Packit |
7cfc04 |
policy SCHED_FIFO or SCHED_RR.
|
|
Packit |
7cfc04 |
The effect on processes or threads with other scheduling policies is
|
|
Packit |
7cfc04 |
implementation-defined.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The nice value set with
|
|
Packit |
7cfc04 |
\fInice\fR()
|
|
Packit |
7cfc04 |
shall be applied to the process. If the process is multi-threaded,
|
|
Packit |
7cfc04 |
the nice value shall affect all system scope threads in the process.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
As \(mi1 is a permissible return value in a successful situation, an
|
|
Packit |
7cfc04 |
application wishing to check for error situations should set
|
|
Packit |
7cfc04 |
.IR errno
|
|
Packit |
7cfc04 |
to 0, then call
|
|
Packit |
7cfc04 |
\fInice\fR(),
|
|
Packit |
7cfc04 |
and if it returns \(mi1, check to see whether
|
|
Packit |
7cfc04 |
.IR errno
|
|
Packit |
7cfc04 |
is non-zero.
|
|
Packit |
7cfc04 |
.SH "RETURN VALUE"
|
|
Packit |
7cfc04 |
Upon successful completion,
|
|
Packit |
7cfc04 |
\fInice\fR()
|
|
Packit |
7cfc04 |
shall return the new nice value \(mi{NZERO}.
|
|
Packit |
7cfc04 |
Otherwise, \(mi1 shall be returned, the nice value of the process
|
|
Packit |
7cfc04 |
shall not be changed, and
|
|
Packit |
7cfc04 |
.IR errno
|
|
Packit |
7cfc04 |
shall be set to indicate the error.
|
|
Packit |
7cfc04 |
.SH ERRORS
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
\fInice\fR()
|
|
Packit |
7cfc04 |
function shall fail if:
|
|
Packit |
7cfc04 |
.TP
|
|
Packit |
7cfc04 |
.BR EPERM
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
.IR incr
|
|
Packit |
7cfc04 |
argument is negative and the calling process does not have appropriate
|
|
Packit |
7cfc04 |
privileges.
|
|
Packit |
7cfc04 |
.LP
|
|
Packit |
7cfc04 |
.IR "The following sections are informative."
|
|
Packit |
7cfc04 |
.SH EXAMPLES
|
|
Packit |
7cfc04 |
.SS "Changing the Nice Value"
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The following example adds the value of the
|
|
Packit |
7cfc04 |
.IR incr
|
|
Packit |
7cfc04 |
argument, \(mi20, to the nice value of the calling process.
|
|
Packit |
7cfc04 |
.sp
|
|
Packit |
7cfc04 |
.RS 4
|
|
Packit |
7cfc04 |
.nf
|
|
Packit |
7cfc04 |
\fB
|
|
Packit |
7cfc04 |
#include <unistd.h>
|
|
Packit |
7cfc04 |
\&...
|
|
Packit |
7cfc04 |
int incr = -20;
|
|
Packit |
7cfc04 |
int ret;
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
ret = nice(incr);
|
|
Packit |
7cfc04 |
.fi \fR
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
.RE
|
|
Packit |
7cfc04 |
.SH "APPLICATION USAGE"
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH RATIONALE
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH "FUTURE DIRECTIONS"
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH "SEE ALSO"
|
|
Packit |
7cfc04 |
.IR "\fIexec\fR\^",
|
|
Packit |
7cfc04 |
.IR "\fIgetpriority\fR\^(\|)"
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The Base Definitions volume of POSIX.1\(hy2008,
|
|
Packit |
7cfc04 |
.IR "\fB<limits.h>\fP",
|
|
Packit |
7cfc04 |
.IR "\fB<unistd.h>\fP"
|
|
Packit |
7cfc04 |
.SH COPYRIGHT
|
|
Packit |
7cfc04 |
Portions of this text are reprinted and reproduced in electronic form
|
|
Packit |
7cfc04 |
from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
|
|
Packit |
7cfc04 |
-- Portable Operating System Interface (POSIX), The Open Group Base
|
|
Packit |
7cfc04 |
Specifications Issue 7, Copyright (C) 2013 by the Institute of
|
|
Packit |
7cfc04 |
Electrical and Electronics Engineers, Inc and The Open Group.
|
|
Packit |
7cfc04 |
(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
|
|
Packit |
7cfc04 |
event of any discrepancy between this version and the original IEEE and
|
|
Packit |
7cfc04 |
The Open Group Standard, the original IEEE and The Open Group Standard
|
|
Packit |
7cfc04 |
is the referee document. The original Standard can be obtained online at
|
|
Packit |
7cfc04 |
http://www.unix.org/online.html .
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
Any typographical or formatting errors that appear
|
|
Packit |
7cfc04 |
in this page are most likely
|
|
Packit |
7cfc04 |
to have been introduced during the conversion of the source files to
|
|
Packit |
7cfc04 |
man page format. To report such errors, see
|
|
Packit |
7cfc04 |
https://www.kernel.org/doc/man-pages/reporting_bugs.html .
|