summaryrefslogtreecommitdiff
path: root/lib/libc
diff options
context:
space:
mode:
authorPhilip Guenther <guenther@cvs.openbsd.org>2013-03-31 22:11:27 +0000
committerPhilip Guenther <guenther@cvs.openbsd.org>2013-03-31 22:11:27 +0000
commit057ba21af51c17a2a371f134dbb215e00362bb53 (patch)
treee775f4dbd9c2e006249c86d6e91fc4faf6f1b5fc /lib/libc
parentd54fbe4007bc35441a81861d2f6707cbfb993fde (diff)
More SYNOPSIS, ERRORS, and STANDARDS updates
Diffstat (limited to 'lib/libc')
-rw-r--r--lib/libc/sys/fork.23
-rw-r--r--lib/libc/sys/fsync.211
-rw-r--r--lib/libc/sys/getitimer.226
-rw-r--r--lib/libc/sys/getpeername.210
-rw-r--r--lib/libc/sys/getpriority.216
-rw-r--r--lib/libc/sys/getrusage.212
-rw-r--r--lib/libc/sys/getsockname.210
7 files changed, 62 insertions, 26 deletions
diff --git a/lib/libc/sys/fork.2 b/lib/libc/sys/fork.2
index fab4fb8a539..b9d934b8325 100644
--- a/lib/libc/sys/fork.2
+++ b/lib/libc/sys/fork.2
@@ -1,4 +1,4 @@
-.\" $OpenBSD: fork.2,v 1.16 2013/03/31 08:37:00 guenther Exp $
+.\" $OpenBSD: fork.2,v 1.17 2013/03/31 22:11:26 guenther Exp $
.\" $NetBSD: fork.2,v 1.6 1995/02/27 12:32:36 cgd Exp $
.\"
.\" Copyright (c) 1980, 1991, 1993
@@ -37,7 +37,6 @@
.Nm fork
.Nd create a new process
.Sh SYNOPSIS
-.Fd #include <sys/types.h>
.Fd #include <unistd.h>
.Ft pid_t
.Fn fork void
diff --git a/lib/libc/sys/fsync.2 b/lib/libc/sys/fsync.2
index eb587b8472b..166f852f7d6 100644
--- a/lib/libc/sys/fsync.2
+++ b/lib/libc/sys/fsync.2
@@ -1,4 +1,4 @@
-.\" $OpenBSD: fsync.2,v 1.9 2011/04/29 07:12:44 jmc Exp $
+.\" $OpenBSD: fsync.2,v 1.10 2013/03/31 22:11:26 guenther Exp $
.\" $NetBSD: fsync.2,v 1.4 1995/02/27 12:32:38 cgd Exp $
.\"
.\" Copyright (c) 1983, 1993
@@ -30,7 +30,7 @@
.\"
.\" @(#)fsync.2 8.1 (Berkeley) 6/4/93
.\"
-.Dd $Mdocdate: April 29 2011 $
+.Dd $Mdocdate: March 31 2013 $
.Dt FSYNC 2
.Os
.Sh NAME
@@ -64,13 +64,18 @@ fails if:
is not a valid descriptor.
.It Bq Er EINVAL
.Fa fd
-refers to a socket, not to a file.
+does not refer to a file which can be synchronized.
.It Bq Er EIO
An I/O error occurred while reading from or writing to the file system.
.El
.Sh SEE ALSO
.Xr sync 2 ,
.Xr sync 8
+.Sh STANDARDS
+The
+.Fn fsync
+function conforms to
+.St -p1003.1-2008 .
.Sh HISTORY
The
.Fn fsync
diff --git a/lib/libc/sys/getitimer.2 b/lib/libc/sys/getitimer.2
index d947c5e34f7..3ca18fa7dfd 100644
--- a/lib/libc/sys/getitimer.2
+++ b/lib/libc/sys/getitimer.2
@@ -1,4 +1,4 @@
-.\" $OpenBSD: getitimer.2,v 1.21 2007/05/31 19:19:32 jmc Exp $
+.\" $OpenBSD: getitimer.2,v 1.22 2013/03/31 22:11:26 guenther Exp $
.\" $NetBSD: getitimer.2,v 1.6 1995/10/12 15:40:54 jtc Exp $
.\"
.\" Copyright (c) 1983, 1991, 1993
@@ -30,7 +30,7 @@
.\"
.\" @(#)getitimer.2 8.2 (Berkeley) 12/11/93
.\"
-.Dd $Mdocdate: May 31 2007 $
+.Dd $Mdocdate: March 31 2013 $
.Dt GETITIMER 2
.Os
.Sh NAME
@@ -187,19 +187,33 @@ The
.Fa value
parameter specified a bad address.
.It Bq Er EINVAL
-A
-.Fa value
-parameter specified a time that was too large to be handled.
-.It Bq Er EINVAL
An unrecognized value for
.Fa which
was specified.
.El
+.Pp
+In addition,
+.Fn setitimer
+may return the following error:
+.Bl -tag -width Er
+.It Bq Er EINVAL
+.Fa value
+or
+.Fa ovalue
+specified a time that was too large to be handled.
+.El
.Sh SEE ALSO
.Xr gettimeofday 2 ,
.Xr poll 2 ,
.Xr select 2 ,
.Xr sigaction 2
+.Sh STANDARDS
+The
+.Fn getitimer
+and
+.Fn setitimer
+functions conform to
+.St -p1003.1-2008 .
.Sh HISTORY
The
.Fn getitimer
diff --git a/lib/libc/sys/getpeername.2 b/lib/libc/sys/getpeername.2
index a2d9f1e54bc..4e0e62aeb6a 100644
--- a/lib/libc/sys/getpeername.2
+++ b/lib/libc/sys/getpeername.2
@@ -1,4 +1,4 @@
-.\" $OpenBSD: getpeername.2,v 1.24 2010/07/01 20:48:37 jmc Exp $
+.\" $OpenBSD: getpeername.2,v 1.25 2013/03/31 22:11:26 guenther Exp $
.\" $NetBSD: getpeername.2,v 1.6 1995/10/12 15:40:56 jtc Exp $
.\"
.\" Copyright (c) 1983, 1991, 1993
@@ -30,14 +30,13 @@
.\"
.\" @(#)getpeername.2 8.1 (Berkeley) 6/4/93
.\"
-.Dd $Mdocdate: July 1 2010 $
+.Dd $Mdocdate: March 31 2013 $
.Dt GETPEERNAME 2
.Os
.Sh NAME
.Nm getpeername
.Nd get name of connected peer
.Sh SYNOPSIS
-.Fd #include <sys/types.h>
.Fd #include <sys/socket.h>
.Ft int
.Fn getpeername "int s" "struct sockaddr *name" "socklen_t *namelen"
@@ -132,6 +131,11 @@ process address space.
.Xr getsockname 2 ,
.Xr socket 2 ,
.Xr getpeereid 3
+.Sh STANDARDS
+The
+.Fn getpeername
+function conforms to
+.St -p1003.1-2008 .
.Sh HISTORY
The
.Fn getpeername
diff --git a/lib/libc/sys/getpriority.2 b/lib/libc/sys/getpriority.2
index a0481e6c5a3..e3d18fb3736 100644
--- a/lib/libc/sys/getpriority.2
+++ b/lib/libc/sys/getpriority.2
@@ -1,4 +1,4 @@
-.\" $OpenBSD: getpriority.2,v 1.12 2007/05/31 19:19:32 jmc Exp $
+.\" $OpenBSD: getpriority.2,v 1.13 2013/03/31 22:11:26 guenther Exp $
.\" $NetBSD: getpriority.2,v 1.4 1995/02/27 12:33:15 cgd Exp $
.\"
.\" Copyright (c) 1980, 1991, 1993
@@ -30,15 +30,14 @@
.\"
.\" @(#)getpriority.2 8.1 (Berkeley) 6/4/93
.\"
-.Dd $Mdocdate: May 31 2007 $
+.Dd $Mdocdate: March 31 2013 $
.Dt GETPRIORITY 2
.Os
.Sh NAME
.Nm getpriority ,
.Nm setpriority
-.Nd get/set program scheduling priority
+.Nd get/set process scheduling priority
.Sh SYNOPSIS
-.Fd #include <sys/time.h>
.Fd #include <sys/resource.h>
.Ft int
.Fn getpriority "int which" "id_t who"
@@ -123,7 +122,7 @@ or
.Dv PRIO_USER .
.El
.Pp
-In addition to the errors indicated above,
+In addition,
.Fn setpriority
will fail if:
.Bl -tag -width Er
@@ -137,6 +136,13 @@ A non-superuser attempted to lower a process priority.
.Xr nice 1 ,
.Xr fork 2 ,
.Xr renice 8
+.Sh STANDARDS
+The
+.Fn getpriority
+and
+.Fn setpriority
+functions conform to
+.St -p1003.1-2008 .
.Sh HISTORY
The
.Fn getpriority
diff --git a/lib/libc/sys/getrusage.2 b/lib/libc/sys/getrusage.2
index b018ae6dc3a..787ef967bfc 100644
--- a/lib/libc/sys/getrusage.2
+++ b/lib/libc/sys/getrusage.2
@@ -1,4 +1,4 @@
-.\" $OpenBSD: getrusage.2,v 1.13 2007/05/31 19:19:32 jmc Exp $
+.\" $OpenBSD: getrusage.2,v 1.14 2013/03/31 22:11:26 guenther Exp $
.\"
.\" Copyright (c) 1985, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
@@ -29,18 +29,17 @@
.\"
.\" @(#)getrusage.2 8.1 (Berkeley) 6/4/93
.\"
-.Dd $Mdocdate: May 31 2007 $
+.Dd $Mdocdate: March 31 2013 $
.Dt GETRUSAGE 2
.Os
.Sh NAME
.Nm getrusage
.Nd get information about resource utilization
.Sh SYNOPSIS
-.Fd #include <sys/time.h>
.Fd #include <sys/resource.h>
.Pp
.Fd #define RUSAGE_SELF 0
-.Fd #define RUSAGE_CHILDREN -1
+.Fd #define RUSAGE_CHILDREN (-1)
.Ft int
.Fn getrusage "int who" "struct rusage *rusage"
.Sh DESCRIPTION
@@ -158,6 +157,11 @@ parameter is not in a valid part of the process address space.
.Xr clock_gettime 2 ,
.Xr gettimeofday 2 ,
.Xr wait 2
+.Sh STANDARDS
+The
+.Fn getrusage
+function conforms to
+.St -p1003.1-2008 .
.Sh HISTORY
The
.Fn getrusage
diff --git a/lib/libc/sys/getsockname.2 b/lib/libc/sys/getsockname.2
index c64b09ccb07..6523ba1e7ed 100644
--- a/lib/libc/sys/getsockname.2
+++ b/lib/libc/sys/getsockname.2
@@ -1,4 +1,4 @@
-.\" $OpenBSD: getsockname.2,v 1.28 2012/10/12 20:45:49 guenther Exp $
+.\" $OpenBSD: getsockname.2,v 1.29 2013/03/31 22:11:26 guenther Exp $
.\" $NetBSD: getsockname.2,v 1.6 1995/10/12 15:41:00 jtc Exp $
.\"
.\" Copyright (c) 1983, 1991, 1993
@@ -30,14 +30,13 @@
.\"
.\" @(#)getsockname.2 8.1 (Berkeley) 6/4/93
.\"
-.Dd $Mdocdate: October 12 2012 $
+.Dd $Mdocdate: March 31 2013 $
.Dt GETSOCKNAME 2
.Os
.Sh NAME
.Nm getsockname
.Nd get socket name
.Sh SYNOPSIS
-.Fd #include <sys/types.h>
.Fd #include <sys/socket.h>
.Ft int
.Fn getsockname "int s" "struct sockaddr *name" "socklen_t *namelen"
@@ -151,6 +150,11 @@ process address space.
.Xr getpeername 2 ,
.Xr socket 2 ,
.Xr getpeereid 3
+.Sh STANDARDS
+The
+.Fn getsockname
+function conforms to
+.St -p1003.1-2008 .
.Sh HISTORY
The
.Fn getsockname