man page macro and text revisions (-mdoc version 3)

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

diff --git a/usr/src/lib/libc/sys/socket.2 b/usr/src/lib/libc/sys/socket.2
index 816d27e..b9afe46 100644 (file)
--- a/usr/src/lib/libc/sys/socket.2
+++ b/usr/src/lib/libc/sys/socket.2
@@ -1,94 +1,85 @@
-.\" 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 the above copyright notice and this paragraph are
-.\" duplicated in all such forms and that any documentation,
-.\" advertising materials, and other materials related to such
-.\" distribution and use acknowledge that the software was developed
-.\" by the University of California, Berkeley.  The name of the
-.\" University may not 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.
+.\" %sccs.include.redist.man%

 .\"
 .\"

-.\"    @(#)socket.2    6.6 (Berkeley) %G%
+.\"     @(#)socket.2   6.8 (Berkeley) %G%

 .\"
 .\"

-.TH SOCKET 2 ""
-.UC 5
-.SH NAME
-socket \- create an endpoint for communication
-.SH SYNOPSIS
-.nf
-.ft B
-#include <sys/types.h>
-#include <sys/socket.h>
-.PP
-.ft B
-s = socket(domain, type, protocol)
-int s, domain, type, protocol;
-.fi
-.SH DESCRIPTION
-.I Socket
+.Dd 
+.Dt SOCKET 2
+.Os BSD 4.2
+.Sh NAME
+.Nm socket
+.Nd create an endpoint for communication
+.Sh SYNOPSIS
+.Fd #include <sys/types.h>
+.Fd #include <sys/socket.h>
+.Ft int
+.Fn socket "int domain" "int type" "int protocol"
+.Sh DESCRIPTION
+.Fn Socket

 creates an endpoint for communication and returns a descriptor.
 creates an endpoint for communication and returns a descriptor.

-.PP
+.Pp

 The
 The

-.I domain
+.Fa domain

 parameter specifies a communications domain within which
 communication will take place; this selects the protocol family
 which should be used.
 parameter specifies a communications domain within which
 communication will take place; this selects the protocol family
 which should be used.

-The protocol family generally is the same as the address family
-for the addresses supplied in later operations on the socket.

 These families are defined in the include file
 These families are defined in the include file

-.IR <sys/socket.h> .
+.Ao Pa sys/socket.h Ac .

 The currently understood formats are
 The currently understood formats are

-.PP
-.RS
-.nf
-.ta 1.25i 1.75i
-PF_UNIX        (UNIX internal protocols),
-PF_INET        (ARPA Internet protocols),
-PF_NS  (Xerox Network Systems protocols), and
-PF_IMPLINK     (IMP \*(lqhost at IMP\*(rq link layer).
-.fi
-.RE
-.PP
+.Pp
+.Bd -literal -offset indent -compact
+AF_UNIX                (UNIX internal protocols),
+AF_INET                (ARPA Internet protocols),
+AF_ISO         (ISO protocols),
+AF_NS          (Xerox Network Systems protocols), and
+AF_IMPLINK     (IMP \*(lqhost at IMP\*(rq link layer).
+.Ed
+.Pp

 The socket has the indicated
 The socket has the indicated

-.I type,
+.Fa type ,

 which specifies the semantics of communication.  Currently
 defined types are:
 which specifies the semantics of communication.  Currently
 defined types are:

-.PP
-.RS
-.nf
+.Pp
+.Bd -literal -offset indent -compact

 SOCK_STREAM
 SOCK_DGRAM
 SOCK_RAW
 SOCK_SEQPACKET
 SOCK_RDM
 SOCK_STREAM
 SOCK_DGRAM
 SOCK_RAW
 SOCK_SEQPACKET
 SOCK_RDM

-.fi
-.RE
-.PP
-A SOCK_STREAM type provides sequenced, reliable,
+.Ed
+.Pp
+A
+.Dv SOCK_STREAM
+type provides sequenced, reliable,

 two-way connection based byte streams.
 An out-of-band data transmission mechanism may be supported.
 two-way connection based byte streams.
 An out-of-band data transmission mechanism may be supported.

-A SOCK_DGRAM socket supports
+A
+.Dv SOCK_DGRAM
+socket supports

 datagrams (connectionless, unreliable messages of
 a fixed (typically small) maximum length).
 datagrams (connectionless, unreliable messages of
 a fixed (typically small) maximum length).

-A SOCK_SEQPACKET socket may provide a sequenced, reliable,
+A
+.Dv SOCK_SEQPACKET
+socket may provide a sequenced, reliable,

 two-way connection-based data transmission path for datagrams
 of fixed maximum length; a consumer may be required to read
 an entire packet with each read system call.
 This facility is protocol specific, and presently implemented
 two-way connection-based data transmission path for datagrams
 of fixed maximum length; a consumer may be required to read
 an entire packet with each read system call.
 This facility is protocol specific, and presently implemented

-only for PF_NS.
-SOCK_RAW sockets provide access to internal network protocols and interfaces.
-The types SOCK_RAW,
+only for
+.Dv PF_NS .
+.Dv SOCK_RAW
+sockets provide access to internal network protocols and interfaces.
+The types
+.Dv SOCK_RAW ,

 which is available only to the super-user, and
 which is available only to the super-user, and

-SOCK_RDM, which is planned,
+.Dv SOCK_RDM ,
+which is planned,

 but not yet implemented, are not described here.
 but not yet implemented, are not described here.

-.PP
+.Pp

 The
 The

-.I protocol
+.Fa protocol

 specifies a particular protocol to be used with the socket.
 Normally only a single protocol exists to support a particular
 socket type within a given protocol family.  However, it is possible
 specifies a particular protocol to be used with the socket.
 Normally only a single protocol exists to support a particular
 socket type within a given protocol family.  However, it is possible


@@ -96,110 +87,145 @@ that many protocols may exist, in which case a particular protocol
 must be specified in this manner.  The protocol number to use is
 particular to the \*(lqcommunication domain\*(rq in which communication
 is to take place; see
 must be specified in this manner.  The protocol number to use is
 particular to the \*(lqcommunication domain\*(rq in which communication
 is to take place; see

-.IR protocols (3N).
-.PP
-Sockets of type SOCK_STREAM
+.Xr protocols 5 .
+.Pp
+Sockets of type
+.Dv SOCK_STREAM

 are full-duplex byte streams, similar
 to pipes.  A stream socket must be in a
 are full-duplex byte streams, similar
 to pipes.  A stream socket must be in a

-.I connected
+.Em connected

 state before any data may be sent or received
 on it.  A connection to another socket is created with a
 state before any data may be sent or received
 on it.  A connection to another socket is created with a

-.IR connect (2)
+.Xr connect 2

 call.  Once connected, data may be transferred using
 call.  Once connected, data may be transferred using

-.IR read (2)
+.Xr read 2

 and
 and

-.IR write (2)
+.Xr write 2

 calls or some variant of the 
 calls or some variant of the 

-.IR send (2)
+.Xr send 2

 and
 and

-.IR recv (2)
+.Xr recv 2

 calls.  When a session has been completed a
 calls.  When a session has been completed a

-.IR close (2)
+.Xr close 2

 may be performed.
 Out-of-band data may also be transmitted as described in
 may be performed.
 Out-of-band data may also be transmitted as described in

-.IR send (2)
+.Xr send 2

 and received as described in
 and received as described in

-.IR recv (2).
-.PP
+.Xr recv 2 .
+.Pp

 The communications protocols used to implement a
 The communications protocols used to implement a

-SOCK_STREAM insure that data
+.Dv SOCK_STREAM
+insure that data

 is not lost or duplicated.  If a piece of data for which the
 peer protocol has buffer space cannot be successfully transmitted
 within a reasonable length of time, then
 the connection is considered broken and calls
 will indicate an error with
 is not lost or duplicated.  If a piece of data for which the
 peer protocol has buffer space cannot be successfully transmitted
 within a reasonable length of time, then
 the connection is considered broken and calls
 will indicate an error with

-\-1 returns and with ETIMEDOUT as the specific code
-in the global variable errno.
-The protocols optionally keep sockets \*(lqwarm\*(rq by
-forcing transmissions
+-1 returns and with
+.Dv ETIMEDOUT
+as the specific code
+in the global variable
+.Va errno .
+The protocols optionally keep sockets
+.Dq warm
+by forcing transmissions

 roughly every minute in the absence of other activity.
 An error is then indicated if no response can be
 elicited on an otherwise
 idle connection for a extended period (e.g. 5 minutes).
 roughly every minute in the absence of other activity.
 An error is then indicated if no response can be
 elicited on an otherwise
 idle connection for a extended period (e.g. 5 minutes).

-A SIGPIPE signal is raised if a process sends
+A
+.Dv SIGPIPE
+signal is raised if a process sends

 on a broken stream; this causes naive processes,
 which do not handle the signal, to exit.
 on a broken stream; this causes naive processes,
 which do not handle the signal, to exit.

-.PP
-SOCK_SEQPACKET sockets employ the same system calls
-as SOCK_STREAM sockets.  The only difference
+.Pp
+.Dv SOCK_SEQPACKET
+sockets employ the same system calls
+as
+.Dv SOCK_STREAM
+sockets.  The only difference

 is that 
 is that 

-.IR read (2)
+.Xr read 2

 calls will return only the amount of data requested,
 and any remaining in the arriving packet will be discarded.
 calls will return only the amount of data requested,
 and any remaining in the arriving packet will be discarded.

-.PP
-SOCK_DGRAM and SOCK_RAW
+.Pp
+.Dv SOCK_DGRAM
+and
+.Dv SOCK_RAW

 sockets allow sending of datagrams to correspondents
 named in
 sockets allow sending of datagrams to correspondents
 named in

-.IR send (2)
+.Xr send 2

 calls.  Datagrams are generally received with
 calls.  Datagrams are generally received with

-.IR recvfrom (2),
+.Xr recvfrom 2 ,

 which returns the next datagram with its return address.
 which returns the next datagram with its return address.

-.PP
+.Pp

 An 
 An 

-.IR fcntl (2)
+.Xr fcntl 2

 call can be used to specify a process group to receive
 call can be used to specify a process group to receive

-a SIGURG signal when the out-of-band data arrives.
+a
+.Dv SIGURG
+signal when the out-of-band data arrives.

 It may also enable non-blocking I/O
 and asynchronous notification of I/O events
 It may also enable non-blocking I/O
 and asynchronous notification of I/O events

-via SIGIO.
-.PP
+via
+.Dv SIGIO .
+.Pp

 The operation of sockets is controlled by socket level
 The operation of sockets is controlled by socket level

-.IR options .
+.Em options .

 These options are defined in the file
 These options are defined in the file

-.RI < sys/socket.h >.
-.IR Setsockopt (2)
+.Ao Pa sys/socket.h Ac .
+.Xr Setsockopt 2

 and
 and

-.IR getsockopt (2)
+.Xr getsockopt 2

 are used to set and get options, respectively.
 are used to set and get options, respectively.

-.SH "RETURN VALUE
-A \-1 is returned if an error occurs, otherwise the return
+.Sh RETURN VALUES
+A -1 is returned if an error occurs, otherwise the return

 value is a descriptor referencing the socket.
 value is a descriptor referencing the socket.

-.SH "ERRORS
-The \fIsocket\fP call fails if:
-.TP 20
-[EPROTONOSUPPORT]
+.Sh ERRORS
+The
+.Fn socket
+call fails if:
+.Bl -tag -width EPROTONOPSUPPORTA
+.It Bq Er EPROTONOSUPPORT

 The protocol type or the specified protocol is not supported
 within this domain.
 The protocol type or the specified protocol is not supported
 within this domain.

-.TP 20
-[EMFILE]
+.It Bq Er EMFILE

 The per-process descriptor table is full.
 The per-process descriptor table is full.

-.TP 20
-[ENFILE]
+.It Bq Er ENFILE

 The system file table is full.
 The system file table is full.

-.TP 20
-[EACCESS]
+.It Bq Er EACCESS

 Permission to create a socket of the specified type and/or protocol
 is denied.
 Permission to create a socket of the specified type and/or protocol
 is denied.

-.TP 20
-[ENOBUFS]
+.It Bq Er ENOBUFS

 Insufficient buffer space is available.
 The socket cannot be created until sufficient resources are freed.
 Insufficient buffer space is available.
 The socket cannot be created until sufficient resources are freed.

-.SH SEE ALSO
-accept(2), bind(2), connect(2), getsockname(2), getsockopt(2),
-ioctl(2), listen(2), read(2), recv(2),
-select(2), send(2), shutdown(2), socketpair(2), write(2)
-.br
-``An Introductory 4.3BSD Interprocess Communication Tutorial.''
-(reprinted in UNIX Programmer's Supplementary Documents Volume 1, PS1:7)
-``An Advanced 4.3BSD Interprocess Communication Tutorial.''
-(reprinted in UNIX Programmer's Supplementary Documents Volume 1, PS1:8)
+.El
+.Sh SEE ALSO
+.Xr accept 2 ,
+.Xr bind 2 ,
+.Xr connect 2 ,
+.Xr getprotoent 3 ,
+.Xr getsockname 2 ,
+.Xr getsockopt 2 ,
+.Xr ioctl 2 ,
+.Xr listen 2 ,
+.Xr read 2 ,
+.Xr recv 2 ,
+.Xr select 2 ,
+.Xr send 2 ,
+.Xr shutdown 2 ,
+.Xr socketpair 2 ,
+.Xr write 2
+.Rs
+.%T "An Introductory 4.3 BSD Interprocess Communication Tutorial"
+.%O "reprinted in UNIX Programmer's Supplementary Documents Volume 1"
+.Re
+.Rs
+.%T "BSD Interprocess Communication Tutorial"
+.%O "reprinted in UNIX Programmer's Supplementary Documents Volume 1"
+.Re
+.Sh HISTORY
+The
+.Nm
+function call appeared in
+.Bx 4.2 .