BSD 4_4 release

[unix-history] / usr / src / sbin / XNSrouted / XNSrouted.8

diff --git a/usr/src/sbin/XNSrouted/XNSrouted.8 b/usr/src/sbin/XNSrouted/XNSrouted.8
index 4a7a6d6..7b278bd 100644 (file)
--- a/usr/src/sbin/XNSrouted/XNSrouted.8
+++ b/usr/src/sbin/XNSrouted/XNSrouted.8
@@ -1,162 +1,186 @@
-.\" Copyright (c) 1986 The Regents of the University of California.
-.\" All rights reserved.
+.\" Copyright (c) 1986, 1991, 1993
+.\"    The Regents of the University of California.  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.

 .\"
 .\"

-.\"    @(#)XNSrouted.8 6.3 (Berkeley) 6/24/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 XNSROUTED 8 "June 24, 1990"
-.UC 6
-.SH NAME
-XNSrouted \- NS Routing Information Protocol daemon
-.SH SYNOPSIS
-.B XNSrouted
-[
-.B \-s
-] [
-.B \-q
-] [
-.B \-t
-] [
-.I logfile
-]
-.SH DESCRIPTION
-.I XNSrouted
+.\"     @(#)XNSrouted.8        8.1 (Berkeley) 6/5/93
+.\"
+.Dd June 5, 1993
+.Dt XNSROUTED 8
+.Os BSD 4.3
+.Sh NAME
+.Nm XNSrouted
+.Nd NS Routing Information Protocol daemon
+.Sh SYNOPSIS
+.Nm XNSrouted
+.Op Fl q
+.Op Fl s
+.Op Fl t
+.Op Ar logfile
+.Sh DESCRIPTION
+.Nm XNSrouted

 is invoked at boot time to manage the Xerox NS routing tables.
 The NS routing daemon uses the Xerox NS Routing
 Information Protocol in maintaining up to date kernel routing
 table entries.
 is invoked at boot time to manage the Xerox NS routing tables.
 The NS routing daemon uses the Xerox NS Routing
 Information Protocol in maintaining up to date kernel routing
 table entries.

-.PP
+.Pp
+Available options:
+.Bl -tag -width logfile
+.It Fl q
+Do not supply routing information (opposite of
+.Fl s
+option below).
+.It Fl s
+Forces 
+.Nm XNSrouted
+to supply routing information whether it is acting as an internetwork
+router or not.
+.It Fl t
+All packets sent or received are
+printed on the standard output.  In addition,
+.Nm XNSrouted
+will not divorce itself from the controlling terminal
+so that interrupts from the keyboard will kill the process.
+.It Ar logfile
+Name of file in which 
+.Nm XNSrouted Ns 's
+actions should be logged.  This log contains information
+about any changes to the routing tables and a history of
+recent messages sent and received which are related to
+the changed route.
+.El
+.Pp

 In normal operation
 In normal operation

-.I XNSrouted
+.Nm XNSrouted

 listens
 for routing information packets.  If the host is connected to
 multiple NS networks, it periodically supplies copies
 of its routing tables to any directly connected hosts
 and networks.
 listens
 for routing information packets.  If the host is connected to
 multiple NS networks, it periodically supplies copies
 of its routing tables to any directly connected hosts
 and networks.

-.PP
+.Pp

 When
 When

-.I XNSrouted
-is started, it uses the SIOCGIFCONF
-.I ioctl
+.Nm XNSrouted
+is started, it uses the
+.Dv SIOCGIFCONF
+.Xr ioctl 2

 to find those
 directly connected interfaces configured into the
 to find those
 directly connected interfaces configured into the

-system and marked ``up'' (the software loopback interface
+system and marked
+.Dq up
+(the software loopback interface

 is ignored).  If multiple interfaces
 are present, it is assumed the host will forward packets
 between networks.
 is ignored).  If multiple interfaces
 are present, it is assumed the host will forward packets
 between networks.

-.I XNSrouted
+.Nm XNSrouted

 then transmits a 
 then transmits a 

-.I request
+.Em request

 packet on each interface (using a broadcast packet if
 the interface supports it) and enters a loop, listening
 for
 packet on each interface (using a broadcast packet if
 the interface supports it) and enters a loop, listening
 for

-.I request
+.Em request

 and
 and

-.I response
+.Em response

 packets from other hosts.
 packets from other hosts.

-.PP
+.Pp

 When a
 When a

-.I request
+.Em request

 packet is received, 
 packet is received, 

-.I XNSrouted
+.Nm XNSrouted

 formulates a reply based on the information maintained in its
 internal tables.  The
 formulates a reply based on the information maintained in its
 internal tables.  The

-.I response
+.Em response

 packet generated contains a list of known routes, each marked
 packet generated contains a list of known routes, each marked

-with a ``hop count'' metric (a count of 16, or greater, is
-considered ``infinite'').  The metric associated with each
+with a
+.Dq hop count
+metric (a count of 16, or greater, is
+considered
+.Dq infinite ) .
+The metric associated with each

 route returned provides a metric
 route returned provides a metric

-.IR "relative to the sender" .
-.PP
-.I Response
+.Em relative to the sender .
+.Pp
+.Em Response

 packets received by
 packets received by

-.I XNSrouted
+.Nm XNSrouted

 are used to update the routing tables if one of the following
 conditions is satisfied:
 are used to update the routing tables if one of the following
 conditions is satisfied:

-.TP
-(1)
+.Bl -bullet
+.It

 No routing table entry exists for the destination network
 or host, and the metric indicates the destination is ``reachable''
 (i.e. the hop count is not infinite).
 No routing table entry exists for the destination network
 or host, and the metric indicates the destination is ``reachable''
 (i.e. the hop count is not infinite).

-.TP
-(2)
+.It

 The source host of the packet is the same as the router in the
 existing routing table entry.  That is, updated information is
 being received from the very internetwork router through which
 packets for the destination are being routed.
 The source host of the packet is the same as the router in the
 existing routing table entry.  That is, updated information is
 being received from the very internetwork router through which
 packets for the destination are being routed.

-.TP
-(3)
+.It

 The existing entry in the routing table has not been updated for
 some time (defined to be 90 seconds) and the route is at least
 as cost effective as the current route.
 The existing entry in the routing table has not been updated for
 some time (defined to be 90 seconds) and the route is at least
 as cost effective as the current route.

-.TP
-(4)
+.It

 The new route describes a shorter route to the destination than
 the one currently stored in the routing tables; the metric of
 the new route is compared against the one stored in the table
 to decide this.
 The new route describes a shorter route to the destination than
 the one currently stored in the routing tables; the metric of
 the new route is compared against the one stored in the table
 to decide this.

-.PP
+.El
+.Pp

 When an update is applied,
 When an update is applied,

-.I XNSrouted
+.Nm XNSrouted

 records the change in its internal tables and generates a
 records the change in its internal tables and generates a

-.I response
+.Em response

 packet to all directly connected hosts and networks.
 packet to all directly connected hosts and networks.

-.I Routed
+.Xr Routed 8

 waits a short period
 of time (no more than 30 seconds) before modifying the kernel's
 routing tables to allow possible unstable situations to settle.
 waits a short period
 of time (no more than 30 seconds) before modifying the kernel's
 routing tables to allow possible unstable situations to settle.

-.PP
+.Pp

 In addition to processing incoming packets,
 In addition to processing incoming packets,

-.I XNSrouted
+.Nm XNSrouted

 also periodically checks the routing table entries.
 If an entry has not been updated for 3 minutes, the entry's metric
 is set to infinity and marked for deletion.  Deletions are delayed
 an additional 60 seconds to insure the invalidation is propagated
 to other routers.
 also periodically checks the routing table entries.
 If an entry has not been updated for 3 minutes, the entry's metric
 is set to infinity and marked for deletion.  Deletions are delayed
 an additional 60 seconds to insure the invalidation is propagated
 to other routers.

-.PP
+.Pp

 Hosts acting as internetwork routers gratuitously supply their
 routing tables every 30 seconds to all directly connected hosts
 and networks.
 Hosts acting as internetwork routers gratuitously supply their
 routing tables every 30 seconds to all directly connected hosts
 and networks.

-.PP
-Supplying the
-.B \-s
-option forces 
-.I XNSrouted
-to supply routing information whether it is acting as an internetwork
-router or not.
+.Sh SEE ALSO
+.Xr idp 4
+.Rs
+.%T "Internet Transport Protocols"
+.%R "XSIS 028112"
+.%Q "Xerox System Integration Standard"
+.Re
+.Sh HISTORY

 The
 The

-.B \-q
-option is the opposite of the
-.B \-s
-option.  If the
-.B \-t
-option is specified, all packets sent or received are
-printed on the standard output.  In addition,
-.I XNSrouted
-will not divorce itself from the controlling terminal
-so that interrupts from the keyboard will kill the process.
-Any other argument supplied is interpreted as the name
-of file in which 
-.IR XNSrouted 's
-actions should be logged.  This log contains information
-about any changes to the routing tables and a history of
-recent messages sent and received which are related to
-the changed route.
-.SH "SEE ALSO"
-``Internet Transport Protocols'', XSIS 028112, Xerox System Integration
-Standard.
-.br
-idp(4)
+.Nm
+command appeared in
+.Bx 4.3 .