flag fields are u_int's
[unix-history] / usr / src / lib / libc / sys / getsockname.2
index 8fc5f9a..5710eec 100644 (file)
@@ -1,57 +1,61 @@
-.\" Copyright (c) 1983 The Regents of the University of California.
+.\" Copyright (c) 1983, 1991 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" %sccs.include.redist.man%
 .\"
 .\" All rights reserved.
 .\"
 .\" %sccs.include.redist.man%
 .\"
-.\"    @(#)getsockname.2       6.3 (Berkeley) %G%
+.\"     @(#)getsockname.2      6.4 (Berkeley) %G%
 .\"
 .\"
-.TH GETSOCKNAME 2 ""
-.UC 5
-.SH NAME
-getsockname \- get socket name
-.SH SYNOPSIS
-.nf
-.PP
-.ft B
-getsockname(s, name, namelen)
-int s;
-struct sockaddr *name;
-int *namelen;
-.fi
-.SH DESCRIPTION
-.I Getsockname
+.Dd 
+.Dt GETSOCKNAME 2
+.Os BSD 4.2
+.Sh NAME
+.Nm getsockname
+.Nd get socket name
+.Sh SYNOPSIS
+.Ft int
+.Fn getsockname "int s" "struct sockaddr *name" "int *namelen"
+.Sh DESCRIPTION
+.Fn Getsockname
 returns the current 
 returns the current 
-.I name
+.Fa name
 for the specified socket.  The
 for the specified socket.  The
-.I namelen
+.Fa namelen
 parameter should be initialized to indicate
 the amount of space pointed to by
 parameter should be initialized to indicate
 the amount of space pointed to by
-.IR name .
+.Fa name .
 On return it contains the actual size of the name
 returned (in bytes).
 On return it contains the actual size of the name
 returned (in bytes).
-.SH DIAGNOSTICS
-A 0 is returned if the call succeeds, \-1 if it fails.
-.SH ERRORS
+.Sh DIAGNOSTICS
+A 0 is returned if the call succeeds, -1 if it fails.
+.Sh ERRORS
 The call succeeds unless:
 The call succeeds unless:
-.TP 15
-[EBADF]
-The argument \fIs\fP is not a valid descriptor.
-.TP 15
-[ENOTSOCK]
-The argument \fIs\fP is a file, not a socket.
-.TP 15
-[ENOBUFS]
+.Bl -tag -width ENOTSOCKAA
+.It Bq Er EBADF
+The argument
+.Fa s
+is not a valid descriptor.
+.It Bq Er ENOTSOCK
+The argument
+.Fa s
+is a file, not a socket.
+.It Bq Er ENOBUFS
 Insufficient resources were available in the system
 to perform the operation.
 Insufficient resources were available in the system
 to perform the operation.
-.TP 15
-[EFAULT]
+.It Bq Er EFAULT
 The 
 The 
-.I name
+.Fa name
 parameter points to memory not in a valid part of the
 process address space.
 parameter points to memory not in a valid part of the
 process address space.
-.SH "SEE ALSO"
-bind(2), socket(2)
-.SH BUGS
+.El
+.Sh SEE ALSO
+.Xr bind 2 ,
+.Xr socket 2
+.Sh BUGS
 Names bound to sockets in the UNIX domain are inaccessible;
 Names bound to sockets in the UNIX domain are inaccessible;
-.I getsockname
+.Xr getsockname
 returns a zero length name.
 returns a zero length name.
+.Sh HISTORY
+The
+.Nm
+function call appeared in
+.Bx 4.2 .