BSD 4_4_Lite1 release

[unix-history] / usr / src / share / man / man4 / ns.4

diff --git a/usr/src/share/man/man4/ns.4 b/usr/src/share/man/man4/ns.4
index 0deac22..18efeac 100644 (file)
--- a/usr/src/share/man/man4/ns.4
+++ b/usr/src/share/man/man4/ns.4
@@ -1,53 +1,98 @@
-.\" Copyright (c) 1985 The Regents of the University of California.
-.\" All rights reserved.
+.\" Copyright (c) 1985, 1991, 1993
+.\"    The Regents of the University of California.  All rights reserved.

 .\"
 .\"

-.\" %sccs.include.redist.man%
+.\" 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.

 .\"
 .\"

-.\"    @(#)ns.4        1.5 (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 NS 4 ""
-.UC 6
-.SH NAME
-ns \- Xerox Network Systems(tm) protocol family
-.SH SYNOPSIS
-\fBoptions NS\fP
-.br
-\fBoptions NSIP\fP
-.br
-\fBpseudo-device ns\fP
-.SH DESCRIPTION
-.IX  "ns device"  ""  "\fLns\fP \(em Xerox NS protocol family"
-The NS protocol family is a collection of protocols
+.\"     @(#)ns.4       8.2 (Berkeley) 11/30/93
+.\"
+.Dd November 30, 1993
+.Dt NS 4
+.Os BSD 4.3
+.Sh NAME
+.Nm ns
+.Nd Xerox Network Systems(tm) protocol family
+.Sh SYNOPSIS
+.Nm options NS
+.Nm options NSIP
+.Nm pseudo-device ns
+.Sh DESCRIPTION
+The
+.Tn NS
+protocol family is a collection of protocols

 layered atop the
 layered atop the

-.I Internet Datagram Protocol
-(IDP) transport layer, and using the Xerox NS address formats.
-The NS family provides protocol support for the
-SOCK_STREAM, SOCK_DGRAM, SOCK_SEQPACKET, and SOCK_RAW socket types; the
-SOCK_RAW interface is a debugging tool, allowing you to trace all packets
+.Em Internet  Datagram  Protocol
+.Pq Tn IDP
+transport layer, and using the Xerox 
+.Tn NS
+address formats.
+The
+.Tn NS
+family provides protocol support for the
+.Dv SOCK_STREAM , SOCK_DGRAM , SOCK_SEQPACKET ,
+and
+.Dv SOCK_RAW
+socket types; the
+.Dv SOCK_RAW
+interface is a debugging tool, allowing you to trace all packets

 entering, (or with toggling kernel variable, additionally leaving) the local
 host.
 entering, (or with toggling kernel variable, additionally leaving) the local
 host.

-.SH ADDRESSING
-NS addresses are 12 byte quantities, consisting of a 
+.Sh ADDRESSING
+.Tn NS
+addresses are 12 byte quantities, consisting of a 

 4 byte Network number, a 6 byte Host number and a 2 byte port number,
 all stored in network standard format.
 4 byte Network number, a 6 byte Host number and a 2 byte port number,
 all stored in network standard format.

-(on the VAX these are word and byte reversed; on the Sun they are not
+(on the
+.Tn VAX
+these are word and byte reversed; on the
+.Tn SUN 
+they are not

 reversed).  The include file
 reversed).  The include file

-.RI < netns/ns.h >
-defines the NS address as a structure containing unions (for quicker
+.Aq Pa netns/ns.h
+defines the
+.Tn NS
+address as a structure containing unions (for quicker

 comparisons).
 comparisons).

-.PP
+.Pp

 Sockets in the Internet protocol family use the following
 addressing structure:
 Sockets in the Internet protocol family use the following
 addressing structure:

-.nf
-
+.Bd -literal -offset indent

 struct sockaddr_ns {
        short           sns_family;
        struct ns_addr  sns_addr;
        char            sns_zero[2];
 };
 struct sockaddr_ns {
        short           sns_family;
        struct ns_addr  sns_addr;
        char            sns_zero[2];
 };

-
-where an ns_addr is composed as follows:
-
+.Ed
+.Pp
+where an
+.Ar ns_addr
+is composed as follows:
+.Bd -literal -offset indent

 union ns_host {
        u_char          c_host[6];
        u_short         s_host[3];
 union ns_host {
        u_char          c_host[6];
        u_short         s_host[3];


@@ -63,36 +108,72 @@ struct ns_addr {
        union ns_host   x_host;
        u_short x_port;
 };
        union ns_host   x_host;
        u_short x_port;
 };

-
-.fi
+.Ed
+.Pp

 Sockets may be created with an address of all zeroes to effect
 Sockets may be created with an address of all zeroes to effect

-``wildcard'' matching on incoming messages.
+.Dq wildcard
+matching on incoming messages.

 The local port address specified in a
 The local port address specified in a

-.IR bind (2)
-call is restricted to be greater than NSPORT_RESERVED
-(=3000, in <netns/ns.h>) unless the creating process is running
+.Xr bind 2
+call is restricted to be greater than
+.Dv NSPORT_RESERVED
+(=3000, in
+.Aq Pa netns/ns.h )
+unless the creating process is running

 as the super-user, providing a space of protected port numbers.
 as the super-user, providing a space of protected port numbers.

-.SH PROTOCOLS
-The NS protocol family supported by the operating system
+.Sh PROTOCOLS
+The
+.Tn NS
+protocol family supported by the operating system

 is comprised of
 is comprised of

-the Internet Datagram Protocol (IDP)
-.IR idp (4),
-Error Protocol (available through IDP),
+the Internet Datagram Protocol
+.Pq Tn IDP
+.Xr idp 4 ,
+Error Protocol (available through
+.Tn IDP ) ,
+and
+Sequenced Packet Protocol
+.Pq Tn SPP
+.Xr spp 4 .
+.Pp
+.Tn SPP
+is used to support the
+.Dv SOCK_STREAM

 and
 and

-Sequenced Packet Protocol (SPP)
-.IR spp (4).
-.LP
-SPP is used to support the SOCK_STREAM and SOCK_SEQPACKET abstraction,
-while IDP is used to support the SOCK_DGRAM abstraction.
+.Dv SOCK_SEQPACKET
+abstraction,
+while
+.Tn IDP
+is used to support the
+.Dv SOCK_DGRAM
+abstraction.

 The Error protocol is responded to by the kernel
 to handle and report errors in protocol processing;
 it is, however,
 only accessible to user programs through heroic actions.
 The Error protocol is responded to by the kernel
 to handle and report errors in protocol processing;
 it is, however,
 only accessible to user programs through heroic actions.

-.SH SEE ALSO
-intro(3), byteorder(3), gethostbyname(3), getnetent(3),
-getprotoent(3), getservent(3), ns(3),
-intro(4), spp(4), idp(4), nsip(4)
-.br
-Internet Transport Protocols, Xerox Corporation document XSIS-028112
-.br
-An Advanced 4.3BSD Interprocess Communication Tutorial
+.Sh SEE ALSO
+.Xr intro 3 ,
+.Xr byteorder 3 ,
+.Xr gethostbyname 3 ,
+.Xr getnetent 3 ,
+.Xr getprotoent 3 ,
+.Xr getservent 3 ,
+.Xr ns 3 ,
+.Xr intro 4 ,
+.Xr spp 4 ,
+.Xr idp 4 ,
+.Xr nsip 4
+.Rs
+.%T "Internet Transport Protocols"
+.%R Xerox Corporation document XSIS
+.%N 028112
+.Re
+.Rs
+.%T "An Advanced 4.3 BSD Interprocess Communication Tutorial"
+.Re
+.Sh HISTORY
+The
+.Nm
+protocol family
+appeared in
+.Bx 4.3 .