flag fields are u_int's

[unix-history] / usr / src / lib / libc / sys / getpriority.2

diff --git a/usr/src/lib/libc/sys/getpriority.2 b/usr/src/lib/libc/sys/getpriority.2
index 8b3446f..b184023 100644 (file)
--- a/usr/src/lib/libc/sys/getpriority.2
+++ b/usr/src/lib/libc/sys/getpriority.2
@@ -1,107 +1,116 @@
-.\" Copyright (c) 1980 The Regents of the University of California.
+.\" Copyright (c) 1980, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted
-.\" provided that the above copyright notice and this paragraph are
-.\" duplicated in all such forms and that any documentation,
-.\" advertising materials, and other materials related to such
-.\" distribution and use acknowledge that the software was developed
-.\" by the University of California, Berkeley.  The name of the
-.\" University may not be used to endorse or promote products derived
-.\" from this software without specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
-.\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" %sccs.include.redist.man%

 .\"
 .\"

-.\"    @(#)getpriority.2       6.7 (Berkeley) %G%
+.\"     @(#)getpriority.2      6.9 (Berkeley) %G%

 .\"
 .\"

-.TH GETPRIORITY 2 ""
-.UC 4
-.SH NAME
-getpriority, setpriority \- get/set program scheduling priority
-.SH SYNOPSIS
-.nf
-.ft B
-#include <sys/time.h>
-#include <sys/resource.h>
-.PP
-.ft B
-prio = getpriority(which, who)
-int prio, which, who;
-.PP
-.ft B
-setpriority(which, who, prio)
-int which, who, prio;
-.fi
-.SH DESCRIPTION
+.Dd 
+.Dt GETPRIORITY 2
+.Os BSD 4
+.Sh NAME
+.Nm getpriority ,
+.Nm setpriority
+.Nd get/set program scheduling priority
+.Sh SYNOPSIS
+.Fd #include <sys/time.h>
+.Fd #include <sys/resource.h>
+.Ft int
+.Fn getpriority "int which" "int who"
+.Ft int
+.Fn setpriority "int which" "int who" "int prio"
+.Sh DESCRIPTION

 The scheduling
 priority of the process, process group, or user, as indicated by
 The scheduling
 priority of the process, process group, or user, as indicated by

-.I which
+.Fa which

 and
 and

-.I who
+.Fa who

 is obtained with the
 is obtained with the

-.I getpriority
+.Fn getpriority

 call and set with the
 call and set with the

-.I setpriority
+.Fn setpriority

 call.
 call.

-.I Which
-is one of PRIO_PROCESS, PRIO_PGRP, or PRIO_USER, and 
-.I who
+.Fa Which
+is one of
+.Dv PRIO_PROCESS ,
+.Dv PRIO_PGRP ,
+or
+.Dv PRIO_USER ,
+and 
+.Fa who

 is interpreted relative to 
 is interpreted relative to 

-.I which
-(a process identifier for PRIO_PROCESS, process group
-identifier for PRIO_PGRP, and a user ID for PRIO_USER).
+.Fa which
+(a process identifier for
+.Dv PRIO_PROCESS ,
+process group
+identifier for
+.Dv PRIO_PGRP ,
+and a user ID for
+.Dv PRIO_USER ) .

 A zero value of
 A zero value of

-.I who
+.Fa who

 denotes the current process, process group, or user.
 denotes the current process, process group, or user.

-.I Prio
-is a value in the range \-20 to 20.  The default priority is 0;
+.Fa Prio
+is a value in the range -20 to 20.  The default priority is 0;

 lower priorities cause more favorable scheduling.
 lower priorities cause more favorable scheduling.

-.PP
+.Pp

 The
 The

-.I getpriority
+.Fn getpriority

 call returns the highest priority (lowest numerical value)
 enjoyed by any of the specified processes.  The
 call returns the highest priority (lowest numerical value)
 enjoyed by any of the specified processes.  The

-.I setpriority
+.Fn setpriority

 call sets the priorities of all of the specified processes
 to the specified value.  Only the super-user may lower priorities.
 call sets the priorities of all of the specified processes
 to the specified value.  Only the super-user may lower priorities.

-.SH "RETURN VALUE
+.Sh RETURN VALUES

 Since
 Since

-.I getpriority
-can legitimately return the value \-1, it is necessary
-to clear the external variable \fIerrno\fP prior to the
+.Fn getpriority
+can legitimately return the value -1, it is necessary
+to clear the external variable
+.Va errno
+prior to the

 call, then check it afterward to determine
 call, then check it afterward to determine

-if a \-1 is an error or a legitimate value.
+if a -1 is an error or a legitimate value.

 The
 The

-.I setpriority
+.Fn setpriority

 call returns 0 if there is no error, or
 call returns 0 if there is no error, or

-\-1 if there is.
-.SH ERRORS
-.I Getpriority
+-1 if there is.
+.Sh ERRORS
+.Fn Getpriority

 and
 and

-.I setpriority
-may return one of the following errors:
-.TP 15
-[ESRCH]
+.Fn setpriority
+will fail if:
+.Bl -tag -width Er
+.It Bq Er ESRCH

 No process was located using the 
 No process was located using the 

-.I which
+.Fa which

 and
 and

-.I who
+.Fa who

 values specified.
 values specified.

-.TP 15
-[EINVAL]
-.I Which
-was not one of PRIO_PROCESS, PRIO_PGRP, or PRIO_USER.
-.PP
+.It Bq Er EINVAL
+.Fa Which
+was not one of
+.Dv PRIO_PROCESS ,
+.Dv PRIO_PGRP ,
+or
+.Dv PRIO_USER .
+.El
+.Pp
+.Bl -tag -width Er

 In addition to the errors indicated above,
 In addition to the errors indicated above,

-.I setpriority
-may fail with one of the following errors returned:
-.TP 15
-[EPERM]
+.Fn setpriority
+will fail if:
+.It Bq Er EPERM

 A process was located, but neither its effective nor real user
 ID matched the effective user ID of the caller.
 A process was located, but neither its effective nor real user
 ID matched the effective user ID of the caller.

-.TP 15
-[EACCES]
+.It Bq Er EACCES

 A non super-user attempted to lower a process priority.
 A non super-user attempted to lower a process priority.

-.SH "SEE ALSO"
-nice(1), fork(2), renice(8)
+.El
+.Sh SEE ALSO
+.Xr nice 1 ,
+.Xr fork 2 ,
+.Xr renice 8
+.Sh HISTORY
+The
+.Nm
+function call appeared in
+.Bx 4.2 .