Merge-o-matic and add a bunch of $Id's

1 files changed, 92 insertions, 54 deletions

diff --git a/sbin/routed/routed.8 b/sbin/routed/routed.8
index 36a1705..d357ba5 100644
--- a/sbin/routed/routed.8
+++ b/sbin/routed/routed.8
@@ -1,3 +1,5 @@
+.\"   $Revision: 2.17 $
+.\"
 .\" Copyright (c) 1983, 1991, 1993
 .\"	The Regents of the University of California.  All rights reserved.
 .\"
@@ -30,17 +32,19 @@
 .\" SUCH DAMAGE.
 .\"
 .\"     @(#)routed.8	8.2 (Berkeley) 12/11/93
-.\"	$Id: routed.8,v 1.10 1998/06/17 13:13:41 jkoshy Exp $
+.\"
+.\"     $Id$
 .\"
 .Dd June 1, 1996
 .Dt ROUTED 8
 .Os BSD 4.4
 .Sh NAME
-.Nm routed
+.Nm routed ,
+.Nm rdisc
 .Nd network RIP and router discovery routing daemon
 .Sh SYNOPSIS
 .Nm routed
-.Op Fl sqdghmAt
+.Op Fl sqdghmpAtv
 .Op Fl T Ar tracefile
 .Oo
 .Fl F
@@ -55,7 +59,9 @@ It uses Routing Information Protocol, RIPv1 (RFC\ 1058),
 RIPv2 (RFC\ 1723),
 and Internet Router Discovery Protocol (RFC 1256)
 to maintain the kernel routing table.
-The RIPv1 protocol is based on the reference 4.3BSD daemon.
+The RIPv1 protocol is based on the reference
+.Bx 4.3
+daemon.
 .Pp
 It listens on the
 .Xr udp 4
@@ -116,7 +122,7 @@ Advertised metrics reflect the metric associated with interface
 so setting the metric on an interface
 is an effective way to steer traffic.
 .Pp
-Responses do not contain routes with a first hop on the requesting
+Responses do not include routes with a first hop on the requesting
 network to implement in part
 .Em split-horizon .
 Requests from query programs
@@ -152,7 +158,7 @@ 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 until the route has been advertised with
 an infinite metric to insure the invalidation
-is propagated throughout the local Internet.
+is propagated throughout the local internet.
 This is a form of
 .Em poison reverse .
 .Pp
@@ -180,7 +186,7 @@ support multicasting.
 If no response is received on a remote interface, if there are errors
 while sending responses,
 or if there are more errors than input or output (see
-.Xr netstat 8 ),
+.Xr netstat 1 ),
 then the cable or some other part of the interface is assumed to be
 disconnected or broken, and routes are adjusted appropriately.
 .Pp
@@ -189,15 +195,17 @@ The
 is handled similarly.
 When the daemon is supplying RIP routes, it also listens for
 Router Discovery Solicitations and sends Advertisements.
-When it is quiet and only listening to other RIP routers, it
+When it is quiet and listening to other RIP routers, it
 sends Solicitations and listens for Advertisements.
 If it receives
-a good Advertisement, it stops listening for broadcast or multicast
-RIP responses.
+a good Advertisement and it is not multi-homed,
+it stops listening for broadcast or multicast RIP responses.
 It tracks several advertising routers to speed recovery when the
 currently chosen router dies.
 If all discovered routers disappear,
 the daemon resumes listening to RIP responses.
+It continues listening to RIP while using Router Discovery
+if multi-homed to ensure all interfaces are used.
 .Pp
 The Router Discovery standard requires that advertisements
 have a default "lifetime" of 30 minutes.  That means should
@@ -217,9 +225,7 @@ is received), there is a single default route and a variable number of
 redirected host routes in the kernel table.
 On a host with more than one network interface,
 this default route will be via only one of the interfaces.
-Thus, multi-homed hosts running with
-.Fl q
-might need
+Thus, multi-homed hosts running with \f3\-q\f1 might need
 .Cm no_rdisc
 described below.
 .Pp
@@ -238,22 +244,24 @@ to infer the netmask used by the remote system when RIPv1 is used.
 The following options are available:
 .Bl -tag -width indent
 .It Fl s
-Force
+force
 .Nm
 to supply routing information.
 This is the default if multiple network interfaces are present on which
 RIP or Router Discovery have not been disabled, and if the kernel switch
 ipforwarding=1.
 .It Fl q
-Is the opposite of the
+is the opposite of the
 .Fl s
 option.
 This is the default when only one interface is present.
+With this explicit option, the daemon is always in "quite-mode" for RIP
+and does not supply routing information to other computers.
 .It Fl d
-Do not run in the background.
+do not run in the background.
 This option is meant for interactive use.
 .It Fl g
-Used on internetwork routers to offer a route
+used on internetwork routers to offer a route
 to the "default" destination.
 It is equivalent to
 .Fl F
@@ -266,23 +274,23 @@ on the command line or
 in the
 .Pa /etc/gateways
 file.
-Since a larger metric
+since a larger metric
 will be used, reducing the spread of the potentially dangerous
 default route.
 This is typically used on a gateway to the Internet,
 or on a gateway that uses another routing protocol whose routes
 are not reported to other local routers.
 Notice that because a metric of 1 is used, this feature is
-dangerous.  It is more commonly accidentally used to create chaos with routing
-loop than to solve problems.
+dangerous.  It is more commonly accidentally used to create chaos with a
+routing loop than to solve problems.
 .It Fl h
-Cause host or point-to-point routes to not be advertised,
+cause host or point-to-point routes to not be advertised,
 provided there is a network route going the same direction.
 That is a limited kind of aggregation.
 This option is useful on gateways to Ethernets that have other gateway
 machines connected with point-to-point links such as SLIP.
 .It Fl m
-Cause the machine to advertise a host or point-to-point route to
+cause the machine to advertise a host or point-to-point route to
 its primary interface.
 It is useful on multi-homed machines such as NFS servers.
 This option should not be used except when the cost of
@@ -296,20 +304,14 @@ option overrides the
 .Fl q
 option to the limited extent of advertising the host route.
 .It Fl A
-Do not ignore RIPv2 authentication if we do not care about RIPv2
+do not ignore RIPv2 authentication if we do not care about RIPv2
 authentication.
 This option is required for conformance with RFC 1723.
 However, it makes no sense and breaks using RIP as a discovery protocol
 to ignore all RIPv2 packets that carry authentication when this machine
 does not care about authentication.
-.It Fl T Ar tracefile
-Increase the debugging level to at least 1 and
-causes debugging information to be appended to the trace file.
-Note that because of security concerns, it is wisest to not run
-.Nm
-routinely with tracing directed to a file.
 .It Fl t
-Increase the debugging level, which causes more information to be logged
+increase the debugging level, which causes more information to be logged
 on the tracefile specified with
 .Fl T
 or standard out.
@@ -321,8 +323,16 @@ or
 signals or with the
 .Xr rtquery 8
 command.
+.It Fl T Ar tracefile
+increases the debugging level to at least 1 and
+causes debugging information to be appended to the trace file.
+Note that because of security concerns, it is wisest to not run
+.Nm
+routinely with tracing directed to a file.
+.It Fl v
+display and logs the version of daemon.
 .It Fl F Ar net[/mask][,metric]
-Minimize routes in transmissions via interfaces with addresses that match
+minimize routes in transmissions via interfaces with addresses that match
 .Em net/mask ,
 and synthesizes a default route to this machine with the
 .Em metric .
@@ -333,7 +343,6 @@ If
 .Em metric
 is absent, a value of 14 is assumed to limit
 the spread of the "fake" default route.
-
 This is a dangerous feature that when used carelessly can cause routing
 loops.
 Notice also that more than one interface can match the specified network
@@ -341,7 +350,7 @@ number and mask.
 See also
 .Fl g .
 .It Fl P Ar parms
-Is equivalent to adding the parameter
+is equivalent to adding the parameter
 line
 .Em parms
 to the
@@ -397,10 +406,12 @@ route is restored.
 Such gateways can be useful on media that do not support broadcasts
 or multicasts but otherwise act like classic shared media like
 Ethernets such as some ATM networks.
-One can list all RIP routers reachable on the ATM network in
+One can list all RIP routers reachable on the HIPPI or ATM network in
 .Pa /etc/gateways
 with a series of
 "host" lines.
+Note that it is usually desirable to use RIPv2 in such situations
+to avoid generating lists of inferred host routes.
 .Pp
 Gateways marked
 .Em external
@@ -409,7 +420,7 @@ routing table nor are they included in routing updates.
 The function of external entries is to indicate
 that another routing process
 will install such a route if necessary,
-and that alternate routes to that destination should not be installed
+and that other routes to that destination should not be installed
 by
 .Nm Ns .
 Such entries are only required when both routers may learn of routes
@@ -418,7 +429,8 @@ to the same destination.
 The
 .Pa /etc/gateways
 file is comprised of a series of lines, each in
-one of the following formats or consist of parameters described below:
+one of the following two formats or consist of parameters described later.
+Blank lines and lines starting with '#' are comments.
 .Pp
 .Bd -ragged
 .Cm net
@@ -488,6 +500,15 @@ or whether the gateway is
 .Cm external
 to the scope of the RIP protocol.
 .Pp
+As can be seen when debugging is turned on with
+.Fl t ,
+such lines create pseudo-interfaces.
+To set parameters for remote or external interfaces,
+a line starting with
+.Cm if=alias(Hname) ,
+.Cm if=remote(Hname) ,
+etc. should be used.
+.Pp
 Lines that start with neither "net" nor "host" must consist of one
 or more of the following parameter settings, separated by commas or
 blanks:
@@ -504,14 +525,21 @@ with mask
 and the supplied metric (default 1).
 This is useful for filling "holes" in CIDR allocations.
 This parameter must appear by itself on a line.
+The network number must specify a full, 32-bit value, as in 192.0.2.0
+instead of 192.0.2.
 .Pp
 Do not use this feature unless necessary.  It is dangerous.
-.It Cm passwd Ns \&= Ns Ar XXX
-specifies a RIPv2 password that will be included on all RIPv2
-responses sent and checked on all RIPv2 responses received.
-The password must not contain any blanks, tab characters, commas
-or '#' characters.
-.It Cm passwd Ns \&= Ns Ar XXX1[|KeyID[start|stop]]
+.It Cm ripv1_mask Ns \&= Ns Ar nname/mask1,mask2
+specifies that netmask of the network of which
+.Cm nname/mask1\f1
+is
+a subnet should be
+.Cm mask2 .
+For example \f2ripv1_mask=192.0.2.16/28,27\f1 marks 192.0.2.16/28
+as a subnet of 192.0.2.0/27 instead of 192.0.2.0/24.
+It is better to turn on RIPv2 instead of using this facility, for example
+with \f2ripv2_out\f1.
+.It Cm passwd Ns \&= Ns Ar XXX[|KeyID[start|stop]]
 specifies a RIPv2 cleartext password that will be included on
 all RIPv2 responses sent, and checked on all RIPv2 responses received.
 Any blanks, tab characters, commas, or '#', '|', or NULL characters in the
@@ -533,15 +561,15 @@ recently is used, or unless no passwords are valid yet, in which case
 no password is output.
 Incoming packets can carry any password that is valid, will
 be valid within 24 hours, or that was valid within 24 hours.
-.It Cm md5_passwd Ns \&= Ns Ar XXX1|KeyID[start|stop]
+To protect the secrets, the passwd settings are valid only in the
+.Em /etc/gateways
+file and only when that file is readable only by UID 0.
+.It Cm md5_passwd Ns \&= Ns Ar XXX|KeyID[start|stop]
 specifies a RIPv2 MD5 password.
 Except that a
 .Cm KeyID
 is required, this keyword is similar to
 .Cm passwd .
-To protect the secrets, this parameter setting is valid only in the
-.Pa /etc/gateways
-file and only when that file is readable only by UID 0.
 .It Cm no_ag
 turns off aggregation of subnets in RIPv1 and RIPv2 responses.
 .It Cm no_super_ag
@@ -563,18 +591,21 @@ or
 causes
 .Nm
 to act as a client router discovery daemon, not advertising.
+.It Cm no_rip_mcast
+causes RIPv2 packets to be broadcast instead of multicast.
 .It Cm no_ripv1_in
 causes RIPv1 received responses to be ignored.
 .It Cm no_ripv2_in
 causes RIPv2 received responses to be ignored.
 .It Cm ripv2_out
-turns off RIPv1 output and causes RIPv2 advertisements to be
+turns on RIPv2 output and causes RIPv2 advertisements to be
 multicast when possible.
 .It Cm ripv2
 is equivalent to
 .Cm no_ripv1_in
 and
 .Cm no_ripv1_out .
+This enables RIPv2.
 .It Cm no_rdisc
 disables the Internet Router Discovery Protocol.
 .It Cm no_solicit
@@ -593,8 +624,12 @@ which by default only listen to Router Discovery messages.
 specifies that Router Discovery packets should be broadcast instead of
 multicast.
 .It Cm rdisc_pref Ns \&= Ns Ar N
-sets the preference in Router Discovery Advertisements to the integer
+sets the preference in Router Discovery Advertisements to the optionally
+signed integer
 .Ar N .
+The default preference is 0.
+Default routes with smaller or more negative preferences are preferred by
+clients.
 .It Cm rdisc_interval Ns \&= Ns Ar N
 sets the nominal interval with which Router Discovery Advertisements
 are transmitted to N seconds and their lifetime to 3*N.
@@ -612,15 +647,17 @@ Unless modified with
 .Cm fake_default ,
 the default route is broadcast with a metric of 14.
 That serves as a "poor man's router discovery" protocol.
-.It Cm trust_gateway Ns \&= Ns Ar rname
+.It Cm trust_gateway Ns \&= Ns Ar rname[|net1/mask1|net2/mask2|...]
 causes RIP packets from that router and other routers named in
 other
 .Cm trust_gateway
-keywords to be accept, and packets from other routers to be ignored.
+keywords to be accepted, and packets from other routers to be ignored.
+If networks are specified, then routes to other networks will be ignored
+from that router.
 .It Cm redirect_ok
 causes RIP to allow ICMP Redirect messages when the system is acting
 as a router and forwarding packets.
-Otherwise, ICMP Redirect messages are are overridden.
+Otherwise, ICMP Redirect messages are overridden.
 .El
 .Pp
 .Sh FILES
@@ -632,15 +669,16 @@ for distant gateways
 .Xr icmp 4 ,
 .Xr udp 4 ,
 .Xr gated 8 ,
-.Xr rtquery 8
+.Xr htable 8 ,
+.Xr rtquery 8 .
 .Rs
 .%T Internet Transport Protocols
 .%R XSIS 028112
 .%Q Xerox System Integration Standard
 .Re
 .Sh BUGS
-It does not always detect unidirectional failures in network interfaces
-(e.g., when the output side fails).
+It does not always detect unidirectional failures in network interfaces,
+for example, when the output side fails.
 .Sh HISTORY
 The
 .Nm