BSD 4_3_Net_2 release

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

diff --git a/usr/src/lib/libc/sys/getpeername.2 b/usr/src/lib/libc/sys/getpeername.2
index e01a807..c7b036a 100644 (file)
--- a/usr/src/lib/libc/sys/getpeername.2
+++ b/usr/src/lib/libc/sys/getpeername.2
@@ -1,70 +1,89 @@
-.\" Copyright (c) 1983 The Regents of the University of California.
+.\" Copyright (c) 1983, 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: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" 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.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"    @(#)getpeername.2       6.4 (Berkeley) 6/23/90
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.TH GETPEERNAME 2 "June 23, 1990"
-.UC 5
-.SH NAME
-getpeername \- get name of connected peer
-.SH SYNOPSIS
-.nf
-.PP
-.ft B
-getpeername(s, name, namelen)
-int s;
-struct sockaddr *name;
-int *namelen;
-.fi
-.SH DESCRIPTION
-.I Getpeername
+.\"     @(#)getpeername.2      6.5 (Berkeley) 3/10/91
+.\"
+.Dd March 10, 1991
+.Dt GETPEERNAME 2
+.Os BSD 4.2
+.Sh NAME
+.Nm getpeername
+.Nd get name of connected peer
+.Sh SYNOPSIS
+.Ft int
+.Fn getpeername "int s" "struct sockaddr *name" "int *namelen"
+.Sh DESCRIPTION
+.Fn Getpeername

 returns the name of the peer connected to
 socket
 returns the name of the peer connected to
 socket

-.IR s .
+.Fa s .

 The
 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).
 The name is truncated if the buffer provided is too small.
 On return it contains the actual size of the name
 returned (in bytes).
 The name is truncated if the buffer provided is too small.

-.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
-[ENOTCONN]
+.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 ENOTCONN

 The socket is not connected.
 The socket is not connected.

-.TP 15
-[ENOBUFS]
+.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"
-accept(2), bind(2), socket(2), getsockname(2)
+.El
+.Sh SEE ALSO
+.Xr accept 2 ,
+.Xr bind 2 ,
+.Xr socket 2 ,
+.Xr getsockname 2
+.Sh HISTORY
+The
+.Nm
+function call appeared in
+.Bx 4.2 .