243 system manual pages should live with the software

Reviewed by: garrett@nexenta.com
Reviewed by: gwr@nexenta.com
Reviewed by: trisk@opensolaris.org
Approved by: gwr@nexenta.com

--HG--
extra : rebase_source : 0c599d0bec0dc8865fbba67721a7a6cd6b1feefb

1 files changed, 138 insertions, 0 deletions

diff --git a/usr/src/man/man3socket/socketpair.3socket b/usr/src/man/man3socket/socketpair.3socket
new file mode 100644
index 0000000000..a455bef899
--- /dev/null
+++ b/usr/src/man/man3socket/socketpair.3socket
@@ -0,0 +1,138 @@
+'\" te
+.\" Copyright 1989 AT&T
+.\" Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved
+.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
+.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
+.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
+.TH socketpair 3SOCKET "10 Jan 2001" "SunOS 5.11" "Sockets Library Functions"
+.SH NAME
+socketpair \- create a pair of connected sockets
+.SH SYNOPSIS
+.LP
+.nf
+\fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsocket\fR \fB -lnsl \fR [ \fIlibrary\fR ... ]
+#include <sys/types.h>
+#include <sys/socket.h>
+
+\fBint\fR \fBsocketpair\fR(\fBint\fR \fIdomain\fR, \fBint\fR \fItype\fR, \fBint\fR \fIprotocol\fR, \fBint\fR \fIsv\fR[2]);
+.fi
+
+.SH DESCRIPTION
+.sp
+.LP
+The \fBsocketpair()\fR library call creates an unnamed pair of connected
+sockets in the specified address family \fIdomain\fR, of the specified
+\fItype\fR, that uses the optionally specified \fIprotocol\fR. The descriptors
+that are used in referencing the new sockets are returned in \fIsv\fR[0] and
+\fIsv\fR[1]. The two sockets are indistinguishable.
+.SH RETURN VALUES
+.sp
+.LP
+\fBsocketpair()\fR returns \fB\(mi1\fR on failure and \fB0\fR on success.
+.SH ERRORS
+.sp
+.LP
+The call succeeds unless:
+.sp
+.ne 2
+.mk
+.na
+\fB\fBEAFNOSUPPORT\fR\fR
+.ad
+.RS 19n
+.rt  
+The specified address family is not supported on this machine.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBEMFILE\fR\fR
+.ad
+.RS 19n
+.rt  
+Too many descriptors are in use by this process.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBENOMEM\fR\fR
+.ad
+.RS 19n
+.rt  
+There was insufficient user memory for the operation to complete.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBENOSR\fR\fR
+.ad
+.RS 19n
+.rt  
+There were insufficient \fBSTREAMS\fR resources for the operation to complete.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBEOPNOTSUPP\fR\fR
+.ad
+.RS 19n
+.rt  
+The specified protocol does not support creation of socket pairs.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBEPROTONOSUPPORT\fR\fR
+.ad
+.RS 19n
+.rt  
+The specified protocol is not supported on this machine.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBEACCES\fR\fR
+.ad
+.RS 19n
+.rt  
+The process does not have appropriate privileges.
+.RE
+
+.SH ATTRIBUTES
+.sp
+.LP
+See \fBattributes\fR(5) for descriptions of the following attributes:
+.sp
+
+.sp
+.TS
+tab() box;
+cw(2.75i) |cw(2.75i) 
+lw(2.75i) |lw(2.75i) 
+.
+ATTRIBUTE TYPEATTRIBUTE VALUE
+_
+MT-LevelSafe
+.TE
+
+.SH SEE ALSO
+.sp
+.LP
+\fBpipe\fR(2), \fBread\fR(2), \fBwrite\fR(2), \fBsocket.h\fR(3HEAD),
+\fBattributes\fR(5)
+.SH NOTES
+.sp
+.LP
+This call is currently implemented only for the \fBAF_UNIX\fR address family.