BSD 4_3_Net_2 release

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

diff --git a/usr/src/lib/libc/sys/bind.2 b/usr/src/lib/libc/sys/bind.2
index ec75086..031f45e 100644 (file)
--- a/usr/src/lib/libc/sys/bind.2
+++ b/usr/src/lib/libc/sys/bind.2
@@ -1,111 +1,126 @@
 .\" Copyright (c) 1983 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" Copyright (c) 1983 The Regents of the University of California.
 .\" 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.
+.\" 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.

 .\"
 .\"

-.\"    @(#)bind.2      6.7 (Berkeley) %G%
+.\" 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 BIND 2 ""
-.UC 5
-.SH NAME
-bind \- bind a name to a socket
-.SH SYNOPSIS
-.nf
-.ft B
-#include <sys/types.h>
-#include <sys/socket.h>
-.PP
-.ft B
-bind(s, name, namelen)
-int s;
-struct sockaddr *name;
-int namelen;
-.fi
-.SH DESCRIPTION
-.I Bind
+.\"     @(#)bind.2     6.9 (Berkeley) 3/10/91
+.\"
+.Dd March 10, 1991
+.Dt BIND 2
+.Os BSD 4.2
+.Sh NAME
+.Nm bind
+.Nd bind a name to a socket
+.Sh SYNOPSIS
+.Fd #include <sys/types.h>
+.Fd #include <sys/socket.h>
+.Ft int
+.Fn bind "int s" "struct sockaddr *name" "int namelen"
+.Sh DESCRIPTION
+.Fn Bind

 assigns a name to an unnamed socket.
 When a socket is created 
 with
 assigns a name to an unnamed socket.
 When a socket is created 
 with

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

 it exists in a name space (address family)
 but has no name assigned.
 it exists in a name space (address family)
 but has no name assigned.

-.I Bind
+.Fn Bind

 requests that
 requests that

-.IR name 
+.Fa name

 be assigned to the socket.
 be assigned to the socket.

-.SH NOTES
+.Sh NOTES

 Binding a name in the UNIX domain creates a socket in the file
 system that must be deleted by the caller when it is no longer
 needed (using
 Binding a name in the UNIX domain creates a socket in the file
 system that must be deleted by the caller when it is no longer
 needed (using

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

 The rules used in name binding vary between communication domains.
 Consult the manual entries in section 4 for detailed information.
 The rules used in name binding vary between communication domains.
 Consult the manual entries in section 4 for detailed information.

-.SH "RETURN VALUE
+.Sh RETURN VALUES

 If the bind is successful, a 0 value is returned.
 If the bind is successful, a 0 value is returned.

-A return value of \-1 indicates an error, which is
-further specified in the global \fIerrno\fP.
-.SH ERRORS
-The \fIbind\fP call will fail if:
-.TP 20
-[EBADF]
-\fIS\fP is not a valid descriptor.
-.TP 20
-[ENOTSOCK]
-\fIS\fP is not a socket.
-.TP 20
-[EADDRNOTAVAIL]
+A return value of -1 indicates an error, which is
+further specified in the global
+.Va errno .
+.Sh ERRORS
+The
+.Fn bind
+call will fail if:
+.Bl -tag -width EADDRNOTAVA
+.It Bq Er EBADF
+.Fa S
+is not a valid descriptor.
+.It Bq Er ENOTSOCK
+.Fa S
+is not a socket.
+.It Bq Er EADDRNOTAVAIL

 The specified address is not available from the local machine.
 The specified address is not available from the local machine.

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

 The specified address is already in use.
 The specified address is already in use.

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

 The socket is already bound to an address.
 The socket is already bound to an address.

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

 The requested address is protected, and the current user
 has inadequate permission to access it.
 The requested address is protected, and the current user
 has inadequate permission to access it.

-.TP 20
-[EFAULT]
-The \fIname\fP parameter is not in a valid part of the user
+.It Bq Er EFAULT
+The
+.Fa name
+parameter is not in a valid part of the user

 address space.
 address space.

-.PP
+.El
+.Pp

 The following errors are specific to binding names in the UNIX domain.
 The following errors are specific to binding names in the UNIX domain.

-.TP 15
-[ENOTDIR]
+.Bl -tag -width EADDRNOTAVA
+.It Bq Er ENOTDIR

 A component of the path prefix is not a directory.
 A component of the path prefix is not a directory.

-.TP 15
-[EINVAL]
+.It Bq Er EINVAL

 The pathname contains a character with the high-order bit set.
 The pathname contains a character with the high-order bit set.

-.TP 15
-[ENAMETOOLONG]
+.It Bq Er ENAMETOOLONG

 A component of a pathname exceeded 255 characters,
 or an entire path name exceeded 1023 characters.
 A component of a pathname exceeded 255 characters,
 or an entire path name exceeded 1023 characters.

-.TP 15
-[ENOENT]
+.It Bq Er ENOENT

 A prefix component of the path name does not exist.
 A prefix component of the path name does not exist.

-.TP 15
-[ELOOP]
+.It Bq Er ELOOP

 Too many symbolic links were encountered in translating the pathname.
 Too many symbolic links were encountered in translating the pathname.

-.TP 15
-[EIO]
+.It Bq Er EIO

 An I/O error occurred while making the directory entry or allocating the inode.
 An I/O error occurred while making the directory entry or allocating the inode.

-.TP 15
-[EROFS]
+.It Bq Er EROFS

 The name would reside on a read-only file system.
 The name would reside on a read-only file system.

-.TP 15
-[EISDIR]
-A null pathname was specified.
-.SH SEE ALSO
-connect(2), listen(2), socket(2), getsockname(2)
+.It Bq Er EISDIR
+An empty pathname was specified.
+.El
+.Sh SEE ALSO
+.Xr connect 2 ,
+.Xr listen 2 ,
+.Xr socket 2 ,
+.Xr getsockname 2
+.Sh HISTORY
+The
+.Nm
+function call appeared in
+.Bx 4.2 .