man-pages/man2/nice.2

85 lines
2.9 KiB
Groff
Raw Normal View History

2004-11-03 13:51:07 +00:00
.\" Hey Emacs! This file is -*- nroff -*- source.
.\"
.\" Copyright (c) 1992 Drew Eckhardt <drew@cs.colorado.edu>, March 28, 1992
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.\" Modified by Michael Haardt <michael@moria.de>
.\" Modified 1993-07-24 by Rik Faith <faith@cs.unc.edu>
.\" Modified 1996-11-04 by Eric S. Raymond <esr@thyrsus.com>
.\" Modified 2001-06-04 by aeb
.\" Modified 2004-05-27 by Michael Kerrisk <mtk-manpages@gmx.net>
2004-11-03 13:51:07 +00:00
.\"
.TH NICE 2 2004-05-27 "Linux 2.6.6" "Linux Programmer's Manual"
.SH NAME
nice \- change process priority
.SH SYNOPSIS
.B #include <unistd.h>
.sp
.BI "int nice(int " inc );
.SH DESCRIPTION
.B nice
adds
.I inc
to the nice value for the calling pid.
(A large nice value means a low priority.)
Only the super\%user may specify a negative increment, or priority increase.
.SH "RETURN VALUE"
On success, zero is returned. On error, \-1 is returned, and
.I errno
is set appropriately.
.SH ERRORS
.TP
.B EPERM
The calling process attempted to increase its priority by
supplying a negative
.IR inc
but has insufficient privileges.
Under Linux the
.B CAP_SYS_NICE
capability is required.
.SH "CONFORMING TO"
SVr4, SVID EXT, AT&T, X/OPEN, BSD 4.3. However, the Linux and glibc
(earlier than glibc 2.2.4) return value is nonstandard, see below.
SVr4 documents an additional
EINVAL error code.
.SH NOTES
Note that the routine is documented in SUSv2 and POSIX 1003.1-2003
to return the new nice value, while the Linux syscall and (g)libc
(earlier than glibc 2.2.4) routines return 0 on success.
The new nice value can be found using
.BR getpriority (2).
Note that an implementation in which
.B nice
returns the new nice value can legitimately return \-1.
To reliably detect an error, set
.I errno
to 0 before the call, and check its value when
.B nice
returns \-1.
.SH "SEE ALSO"
.BR nice (1),
.BR fork (2),
.BR getpriority (2),
.BR setpriority (2),
.BR capabilities (7),
.BR renice (8)