- double spaces killed

- new sentence, new line
- grammar

ok deraadt@

1 files changed, 145 insertions, 102 deletions

diff --git a/usr.sbin/mrouted/mrouted.8 b/usr.sbin/mrouted/mrouted.8
index 4a2f3c07c23..ee3bab0046a 100644
--- a/usr.sbin/mrouted/mrouted.8
+++ b/usr.sbin/mrouted/mrouted.8
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: mrouted.8,v 1.11 2003/03/03 15:14:28 deraadt Exp $
+.\"	$OpenBSD: mrouted.8,v 1.12 2003/03/05 21:18:10 jmc Exp $
 .\" The mrouted program is covered by the license in the accompanying file
 .\" named "LICENSE".  Use of the mrouted program represents acceptance of
 .\" the terms and conditions listed in that file.
@@ -26,12 +26,13 @@ datagram forwarding algorithm called Reverse Path Multicasting.
 .Pp
 .Nm
 forwards a multicast datagram along a shortest (reverse) path tree
-rooted at the subnet on which the datagram originates. The multicast
-delivery tree may be thought of as a broadcast delivery tree that has
-been pruned back so that it does not extend beyond those subnetworks
-that have members of the destination group. Hence, datagrams
-are not forwarded along those branches which have no listeners of the
-multicast group. The IP time-to-live of a multicast datagram can be
+rooted at the subnet on which the datagram originates.
+The multicast delivery tree may be thought of as a broadcast delivery
+tree that has been pruned back so that it does not extend beyond those
+subnetworks that have members of the destination group.
+Hence, datagrams are not forwarded along those branches which have no
+listeners of the multicast group.
+The IP time-to-live of a multicast datagram can be
 used to limit the range of multicast datagrams.
 .Pp
 In order to support multicasting among subnets that are separated by (unicast)
@@ -40,25 +41,28 @@ routers that do not support IP multicasting,
 includes support for
 "tunnels", which are virtual point-to-point links between pairs of
 .Nm
-daemons located anywhere in an internet.  IP multicast packets are encapsulated
-for transmission through tunnels, so that they look like normal unicast
-datagrams to intervening routers and subnets.  The encapsulation is added on
-entry to a tunnel, and stripped off on exit from a tunnel.
+daemons located anywhere in an internet.
+IP multicast packets are encapsulated for transmission through tunnels,
+so that they look like normal unicast datagrams to intervening routers
+and subnets.
+The encapsulation is added on entry to a tunnel, and stripped off on exit
+from a tunnel.
 By default, the packets are encapsulated using the IP-in-IP protocol
 (IP protocol number 4).
 Older versions of
 .Nm
-tunnel using IP source routing, which puts a heavy load on some
+tunnel use IP source routing, which puts a heavy load on some
 types of routers.
 This version does not support IP source route tunneling.
 .Pp
 The tunneling mechanism allows
 .Nm
-to establish a virtual internet, for
-the purpose of multicasting only, which is independent of the physical
-internet, and which may span multiple Autonomous Systems.  This capability
-is intended for experimental support of internet multicasting only, pending
-widespread support for multicast routing by the regular (unicast) routers.
+to establish a virtual internet, for the purpose of multicasting only,
+which is independent of the physical internet, and which may span
+multiple Autonomous Systems.
+This capability is intended for experimental support of internet
+multicasting only, pending widespread support for multicast routing
+by the regular (unicast) routers.
 .Nm
 suffers from the well-known scaling problems of any distance-vector
 routing protocol, and does not (yet) support hierarchical multicast routing.
@@ -76,27 +80,32 @@ If no
 .Fl d
 option is given, or if the debug level is specified as 0,
 .Nm
-detaches from the invoking terminal. Otherwise, it remains attached to the
-invoking terminal and responsive to signals from that terminal. If
+detaches from the invoking terminal.
+Otherwise, it remains attached to the invoking terminal and responsive
+to signals from that terminal.
+If
 .Fl d
-is given with no argument, the debug level defaults to 2. Regardless of the
-debug level,
+is given with no argument, the debug level defaults to 2.
+Regardless of the debug level,
 .Nm
-always writes warning and error messages to the system
-log daemon. Non-zero debug levels have the following effects:
+always writes warning and error messages to the system log daemon.
+Non-zero debug levels have the following effects:
+.Pp
 .Bl -hang -compact -offset indent
 .It 1
-all syslog'ed
+All syslog'ed
 messages are also printed to stderr.
 .It 2
-all level 1 messages plus notifications of "significant"
+All level 1 messages plus notifications of "significant"
 events are printed to stderr.
 .It 3
-all level 2 messages plus notifications of all packet
+All level 2 messages plus notifications of all packet
 arrivals and departures are printed to stderr.
 .El
 .Pp
-Upon startup, mrouted writes its pid to the file
+Upon startup,
+.Nm
+writes its pid to the file
 .Pa /var/run/mrouted.pid .
 .Sh CONFIGURATION
 .Nm
@@ -104,16 +113,15 @@ automatically configures itself to forward on all multicast-capable
 interfaces, i.e., interfaces that have the IFF_MULTICAST flag set (excluding
 the loopback "interface"), and it finds other
 .Nm
-directly reachable
-via those interfaces.  To override the default configuration, or to add
-tunnel links to other
-.Nm
+directly reachable via those interfaces.
+To override the default configuration, or to add tunnel links to other
+.Nm mrouted ,
 configuration commands may be placed in
 .Pa /etc/mrouted.conf
 (or an alternative file, specified by the
 .Fl c
 option).
-There are four types of configuration commands:
+There are five types of configuration commands:
 .Bl -item -offset indent
 .It
 .Tn phyint <local-addr> [disable] [metric <m>]
@@ -144,26 +152,33 @@ and
 .Ar altnet
 options may be specified as many times as necessary.
 .Pp
-The phyint command can be used to disable multicast routing on the physical
+The
+.Nm phyint
+command can be used to disable multicast routing on the physical
 interface identified by local IP address
 .Ar <local-addr> ,
 or to associate a non-default metric or threshold with the specified
-physical interface. The local IP address
+physical interface.
+The local IP address
 .Ar <local-addr>
 may be replaced by the interface name (e.g., le0).
-If a phyint is attached to multiple IP subnets, describe each additional subnet
-with the altnet keyword.
+If a phyint is attached to multiple IP subnets, describe each additional
+subnet with the
+.Ar altnet
+keyword.
 Phyint commands must precede tunnel commands.
 .Pp
-The tunnel command can be used to establish a tunnel link between local
-IP address
+The
+.Nm tunnel
+command can be used to establish a tunnel link between local IP address
 .Ar <local-addr>
 and remote IP address
 .Ar <remote-addr> ,
 and to associate a non-default metric or threshold with that tunnel.
 The local IP address
 .Ar <local-addr>
-may be replaced by the interface name (e.g., le0).  The remote IP address
+may be replaced by the interface name (e.g., le0).
+The remote IP address
 .Ar <remote-addr>
 may be replaced by a host name, if and only if the host name has a single
 IP address associated with it.
@@ -174,60 +189,82 @@ it can be used.
 '\"the srcrt keyword specifies
 '\"encapsulation using IP source routing.
 .Pp
-The cache_lifetime is a value that determines the amount of time that a
-cached multicast route stays in kernel before timing out. The value of this
-entry should lie between 300 (5 min) and 86400 (1 day). It defaults to 300.
+The
+.Nm cache_lifetime
+is a value that determines the amount of time that a
+cached multicast route stays in kernel before timing out.
+The value of this entry should lie between 300 (5 min) and 86400 (1 day).
+It defaults to 300.
 .Pp
 The
-.Ar pruning
+.Nm pruning
 option is provided for
 .Nm
-to act as a non-pruning router. It is also possible to start
+to act as a non-pruning router.
+It is also possible to start
 .Nm
 in a non-pruning mode using the
 .Fl p
-option on the command line. It is expected that a router would be configured
-in this manner for test purposes only. The default mode is pruning enabled.
+option on the command line.
+It is expected that a router would be configured in this manner for test
+purposes only.
+The default mode is pruning enabled.
 .Pp
-You may assign names to boundaries to make configuration easier with
-the name keyword.  The boundary option on phyint or tunnel commands
-can accept either a name or a boundary.
+You may assign names to boundaries to make configuration easier with the
+.Nm name
+keyword.
+The
+.Ar boundary
+option on
+.Nm phyint
+or
+.Nm tunnel
+commands can accept either a name or a boundary.
 .Pp
-The metric is the "cost" associated with sending a datagram on the given
+The
+.Ar metric
+is the "cost" associated with sending a datagram on the given
 interface or tunnel; it may be used to influence the choice of routes.
-The metric defaults to 1.  Metrics should be kept as small as possible,
-because
+The metric defaults to 1.
+Metrics should be kept as small as possible, because
 .Nm
-cannot route along paths with a sum of metrics greater
-than 31.
+cannot route along paths with a sum of metrics greater than 31.
+.br
 .Pp
-The threshold is the minimum IP time-to-live required for a multicast datagram
-to be forwarded to the given interface or tunnel.  It is used to control the
-scope of multicast datagrams.  (The TTL of forwarded packets is only compared
-to the threshold, it is not decremented by the threshold.  Every multicast
-router decrements the TTL by 1.)  The default threshold is 1.
+The
+.Ar threshold
+is the minimum IP time-to-live required for a multicast datagram
+to be forwarded to the given interface or tunnel.
+It is used to control the scope of multicast datagrams.
+(The TTL of forwarded packets is only compared to the threshold,
+it is not decremented by the threshold.
+Every multicast router decrements the TTL by 1.)
+The default threshold is 1.
 .Pp
 In general, all
 .Nm
 connected to a particular subnet or tunnel should
 use the same metric and threshold for that subnet or tunnel.
 .Pp
-The rate_limit option allows the network administrator to specify a
+The
+.Ar rate_limit
+option allows the network administrator to specify a
 certain bandwidth in Kbits/second which would be allocated to multicast
-traffic.  It defaults to 500Kbps on tunnels, and 0 (unlimited) on physical
-interfaces.
+traffic.
+It defaults to 500Kbps on tunnels, and 0 (unlimited) on physical interfaces.
 .Pp
-The boundary option allows an interface
-to be configured as an administrative boundary for the specified
-scoped address. Packets belonging to this address will not
-be forwarded on a scoped interface.  The boundary option accepts either
-a name or a boundary spec.
+The
+.Ar boundary
+option allows an interface to be configured as an administrative boundary
+for the specified scoped address.
+Packets belonging to this address will not be forwarded on a scoped interface.
+The boundary option accepts either a name or a boundary spec.
 .Pp
 .Nm
 will not initiate execution if it has fewer than two enabled vifs,
 where a vif (virtual interface) is either a physical multicast-capable
-interface or a tunnel.  It will log a warning if all of its vifs are
-tunnels; such an
+interface or a tunnel.
+It will log a warning if all of its vifs are tunnels; such an
 .Nm
 configuration would be better replaced by more
 direct tunnels (i.e., eliminate the middle man).
@@ -271,6 +308,7 @@ tunnel 192.168.5.4 10.11.12.13 metric 1 threshold 32
 .Sh SIGNALS
 .Nm
 responds to the following signals:
+.Pp
 .Bl -tag -width TERM -compact
 .It HUP
 restarts
@@ -337,28 +375,31 @@ Multicast Routing Table (1136 entries)
 .Ed
 .Pp
 In this example, there are four vifs connecting to two subnets and two
-tunnels.  The vif 3 tunnel is not in use (no peer address). The vif 0 and
-vif 1 subnets have some groups present; tunnels never have any groups.  This
-instance of
+tunnels.
+The vif 3 tunnel is not in use (no peer address).
+The vif 0 and vif 1 subnets have some groups present;
+tunnels never have any groups.
+This instance of
 .Nm
-is the one responsible for sending periodic group
-membership queries on the vif 0 and vif 1 subnets, as indicated by the
-"querier" flags. The list of boundaries indicate the scoped addresses on that
-interface. A count of the no. of incoming and outgoing packets is also
+is the one responsible for sending periodic group membership queries on the
+vif 0 and vif 1 subnets, as indicated by the "querier" flags.
+The list of boundaries indicate the scoped addresses on that interface.
+A count of the no. of incoming and outgoing packets is also
 shown at each interface.
 .Pp
 Associated with each subnet from which a multicast datagram can originate
 is the address of the previous hop router (unless the subnet is directly-
 connected), the metric of the path back to the origin, the amount of time
 since we last received an update for this subnet, the incoming vif for
-multicasts from that origin, and a list of outgoing vifs.  "*" means that
-the outgoing vif is connected to a leaf of the broadcast tree rooted at the
-origin, and a multicast datagram from that origin will be forwarded on that
-outgoing vif only if there are members of the destination group on that leaf.
+multicasts from that origin, and a list of outgoing vifs.
+"*" means that the outgoing vif is connected to a leaf of the broadcast
+tree rooted at the origin, and a multicast datagram from that origin will
+be forwarded on that outgoing vif only if there are members of the
+destination group on that leaf.
 .Pp
 .Nm
-also maintains a copy of the kernel forwarding cache table. Entries
-are created and deleted by
+also maintains a copy of the kernel forwarding cache table.
+Entries are created and deleted by
 .Nm mrouted .
 .Pp
 The cache tables look like this:
@@ -378,29 +419,31 @@ Multicast Routing Cache Table (147 entries)
 .Ed
 .Pp
 Each entry is characterized by the origin subnet number and mask and the
-destination multicast group. The 'CTmr' field indicates the lifetime
-of the entry.  The entry is deleted from the cache table
-when the timer decrements to zero.  The 'Age' field is the time since
-this cache entry was originally created.  Since cache entries get refreshed
-if traffic is flowing, routing entries can grow very old.
+destination multicast group.
+The 'CTmr' field indicates the lifetime of the entry.
+The entry is deleted from the cache table when the timer decrements to zero.
+The 'Age' field is the time since this cache entry was originally created.
+Since cache entries get refreshed if traffic is flowing,
+routing entries can grow very old.
 The 'Ptmr' field is simply a dash if no prune was sent upstream, or the
 amount of time until the upstream prune will time out.
-The 'Ivif' field indicates the
-incoming vif for multicast packets from that origin.  Each router also
-maintains a record of the number of prunes received from neighboring
-routers for a particular source and group. If there are no members of
-a multicast group on any downward link of the multicast tree for a
-subnet, a prune message is sent to the upstream router. They are
-indicated by a "P" after the vif number.  The Forwvifs field shows the
-interfaces along which datagrams belonging to the source-group are
-forwarded. A "p" indicates that no datagrams are being forwarded along
-that interface. An unlisted interface is a leaf subnet with are no
-members of the particular group on that subnet. A "b" on an interface
-indicates that it is a boundary interface, i.e., traffic will not be
-forwarded on the scoped address on that interface.
+The 'Ivif' field indicates the incoming vif for multicast packets from
+that origin.
+Each router also maintains a record of the number of prunes received from
+neighboring routers for a particular source and group.
+If there are no members of a multicast group on any downward link of the
+multicast tree for a subnet, a prune message is sent to the upstream router.
+They are indicated by a "P" after the vif number.
+The Forwvifs field shows the interfaces along which datagrams belonging to
+the source-group are forwarded.
+A "p" indicates that no datagrams are being forwarded along that interface.
+An unlisted interface is a leaf subnet with no members of the particular
+group on that subnet.
+A "b" on an interface indicates that it is a boundary interface, i.e.,
+traffic will not be forwarded on the scoped address on that interface.
 An additional line with a ">" as the first character is printed for
-each source on the subnet.  Note that there can be many sources in
-one subnet.
+each source on the subnet.
+Note that there can be many sources in one subnet.
 .Sh FILES
 .Bl -tag -width /var/tmp/mrouted.cache -compact
 .It Pa /etc/mrouted.conf