summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorJared Yanovich <jaredy@cvs.openbsd.org>2005-08-10 01:40:50 +0000
committerJared Yanovich <jaredy@cvs.openbsd.org>2005-08-10 01:40:50 +0000
commit0f4f408e7e0173009157a07e7ea952d57d164a21 (patch)
treee1adaeaf859df8f3d55ac21bdecf87612dfcbf64 /lib
parent6902a112ca843dd2dc36679062ab9231ad5aee1b (diff)
macro, capitalization, and layout improvements
Diffstat (limited to 'lib')
-rw-r--r--lib/libc/sys/getpeereid.228
1 files changed, 18 insertions, 10 deletions
diff --git a/lib/libc/sys/getpeereid.2 b/lib/libc/sys/getpeereid.2
index 3fc91e9841a..40402339abe 100644
--- a/lib/libc/sys/getpeereid.2
+++ b/lib/libc/sys/getpeereid.2
@@ -1,4 +1,4 @@
-.\" $OpenBSD: getpeereid.2,v 1.6 2003/11/27 14:31:24 jmc Exp $
+.\" $OpenBSD: getpeereid.2,v 1.7 2005/08/10 01:40:49 jaredy Exp $
.\"
.\" Copyright (c) 1983, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
@@ -40,34 +40,40 @@
.Sh DESCRIPTION
.Fn getpeereid
returns the effective user ID and group ID of the peer connected to
-a UNIX domain socket (see
+a
+.Ux
+domain socket (see
.Xr unix 4 ) .
The argument
.Fa s
must be of type
.Dv SOCK_STREAM .
.Pp
-One common use is for UNIX domain servers to determine the credentials
+One common use is for
+.Ux
+domain servers to determine the credentials
of clients that have connected to it.
.Pp
.Fn getpeereid
takes three parameters:
-.Pp
+.Bl -bullet
+.It
.Fa s
-Contains the file descriptor of the socket whose peer credentials
+contains the file descriptor of the socket whose peer credentials
should be looked up.
-.Pp
+.It
.Fa euid
-Points to a
+points to a
.Li uid_t
variable into which the effective user ID for the connected peer will
be stored.
-.Pp
+.It
.Fa egid
-Points to a
+points to a
.Li gid_t
variable into which the effective group ID for the connected peer will
be stored.
+.El
.Sh RETURN VALUES
If the call succeeds, a 0 is returned and
.Fa euid
@@ -91,7 +97,9 @@ The argument
.Fa s
is a file, not a socket.
.It Bq Er EOPNOTSUPP
-The socket is not in the UNIX domain.
+The socket is not in the
+.Ux
+domain.
.It Bq Er ENOTCONN
The socket is not connected.
.It Bq Er ENOBUFS