aboutsummaryrefslogtreecommitdiff
path: root/usr.sbin/mrouted
diff options
context:
space:
mode:
authorSheldon Hearn <sheldonh@FreeBSD.org>2000-03-01 14:09:25 +0000
committerSheldon Hearn <sheldonh@FreeBSD.org>2000-03-01 14:09:25 +0000
commitf2e366a1057c0492a8abdf936898879a630e633e (patch)
treebd399ef474619a212390cbff31b25daa4aa003b5 /usr.sbin/mrouted
parentb825cbde0301c29a6c8930a8f64e291fdcda8606 (diff)
downloadsrc-f2e366a1057c0492a8abdf936898879a630e633e.tar.gz
src-f2e366a1057c0492a8abdf936898879a630e633e.zip
Remove single-space hard sentence breaks. These degrade the quality
of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc.
Notes
Notes: svn path=/head/; revision=57673
Diffstat (limited to 'usr.sbin/mrouted')
-rw-r--r--usr.sbin/mrouted/map-mbone.827
-rw-r--r--usr.sbin/mrouted/mrinfo.827
-rw-r--r--usr.sbin/mrouted/mrouted.839
3 files changed, 62 insertions, 31 deletions
diff --git a/usr.sbin/mrouted/map-mbone.8 b/usr.sbin/mrouted/map-mbone.8
index 63027b8b4dac..d7c693828b17 100644
--- a/usr.sbin/mrouted/map-mbone.8
+++ b/usr.sbin/mrouted/map-mbone.8
@@ -25,24 +25,30 @@ is the localhost.
.Pp
.Nm Map-mbone
traverses neighboring multicast routers by sending the ASK_NEIGHBORS IGMP
-message to the multicast starting_router. If this multicast router responds,
+message to the multicast starting_router.
+If this multicast router responds,
the version number and a list of their neighboring multicast router addresses is
-part of that response. If the responding router has recent multicast version
+part of that response.
+If the responding router has recent multicast version
number, then
.Nm
requests additional information such as metrics, thresholds, and flags from the
-multicast router. For each new occurrence of neighboring multicast router in
+multicast router.
+For each new occurrence of neighboring multicast router in
the reply and provided the flooding option has been selected, then
.Nm
-asks each of this multicast router for a list of neighbors. This search
+asks each of this multicast router for a list of neighbors.
+This search
for unique routers will continue until no new neighboring multicast routers
are reported.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl d
-Set the debug level. When the debug level is greater than the
-default value of 0, addition debugging messages are printed. Regardless of
+Set the debug level.
+When the debug level is greater than the
+default value of 0, addition debugging messages are printed.
+Regardless of
the debug level, an error condition, will always write an error message and will
cause
.Nm
@@ -58,7 +64,8 @@ all level 2 messages plus notifications of all packet
timeouts are printed to stderr.
.El
.It Fl f
-Set flooding option. Flooding allows the recursive search
+Set flooding option.
+Flooding allows the recursive search
of neighboring multicast routers and is enable by default when starting_router
is not used.
.It Fl g
@@ -66,10 +73,12 @@ Set graphing in GraphEd format.
.It Fl n
Disable the DNS lookup for the multicast routers names.
.It Fl r Ar retry_count
-Set the neighbor query retry limit. Default is 1 retry.
+Set the neighbor query retry limit.
+Default is 1 retry.
.It Fl t Ar timeout_count
Set the number of seconds to wait for a neighbor query
-reply before retrying. Default timeout is 2 seconds.
+reply before retrying.
+Default timeout is 2 seconds.
.El
.Sh IMPORTANT NOTE
.Nm Map-mbone
diff --git a/usr.sbin/mrouted/mrinfo.8 b/usr.sbin/mrouted/mrinfo.8
index 3a56910de85b..c8b5c01e8b9f 100644
--- a/usr.sbin/mrouted/mrinfo.8
+++ b/usr.sbin/mrouted/mrinfo.8
@@ -18,20 +18,25 @@ attempts to display the configuration information from the multicast router
.Ar multicast_router .
.Pp
.Nm Mrinfo
-uses the ASK_NEIGHBORS IGMP message to the specified multicast router. If this
+uses the ASK_NEIGHBORS IGMP message to the specified multicast router.
+If this
multicast router responds, the version number and a list of their neighboring
-multicast router addresses is part of that response. If the responding router
+multicast router addresses is part of that response.
+If the responding router
has a recent multicast version number, then
.Nm
requests additional information such as metrics, thresholds, and flags from the
-multicast router. Once the specified multicast router responds, the
+multicast router.
+Once the specified multicast router responds, the
configuration is displayed to the standard output.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl d Ar debug_level
-Set the debug level. When the debug level is greater than the
-default value of 0, addition debugging messages are printed. Regardless of
+Set the debug level.
+When the debug level is greater than the
+default value of 0, addition debugging messages are printed.
+Regardless of
the debug level, an error condition, will always write an error message and will
cause
.Nm
@@ -47,10 +52,12 @@ all level 2 messages plus notifications of all packet
timeouts are printed to stderr.
.El
.It Fl r Ar retry_count
-Set the neighbor query retry limit. Default is 3 retries.
+Set the neighbor query retry limit.
+Default is 3 retries.
.It Fl t Ar timeout_count
Set the number of seconds to wait for a neighbor query
-reply. Default timeout is 4 seconds.
+reply.
+Default timeout is 4 seconds.
.El
.Sh SAMPLE OUTPUT
.nf
@@ -63,8 +70,10 @@ reply. Default timeout is 4 seconds.
.fi
.Pp
For each neighbor of the queried multicast router, the IP of the queried router
-is displayed, followed by the IP and name of the neighbor. In square brackets
-the metric (cost of connection), the treashold (multicast ttl) is displayed. If
+is displayed, followed by the IP and name of the neighbor.
+In square brackets
+the metric (cost of connection), the treashold (multicast ttl) is displayed.
+If
the queried multicast router has a newer version number, the type (tunnel,
srcrt) and status (disabled, down) of the connection is displayed.
.Sh IMPORTANT NOTE
diff --git a/usr.sbin/mrouted/mrouted.8 b/usr.sbin/mrouted/mrouted.8
index 2aad223fd446..1e5645207398 100644
--- a/usr.sbin/mrouted/mrouted.8
+++ b/usr.sbin/mrouted/mrouted.8
@@ -23,12 +23,15 @@ datagram forwarding algorithm called Reverse Path Multicasting.
.Pp
.Nm Mrouted
forwards a multicast datagram along a shortest (reverse) path tree
-rooted at the subnet on which the datagram originates. The multicast
+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
+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
+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)
@@ -74,7 +77,8 @@ in order to perform multicast forwarding.
The following options are available:
.Bl -tag -width indent
.It Fl c Ar config_file
-Specify an alternative file for configuration commands. Default is
+Specify an alternative file for configuration commands.
+Default is
.Pa /etc/mrouted.conf .
.It Fl d Op Ar debug_level
If no
@@ -291,7 +295,8 @@ traffic. It defaults 0 (unlimited).
.It boundary Ar "boundary-name|scoped-addr/mask-len"
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
+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. This command may be specified several times
on an interface in order to describe multiple boundaries.
@@ -493,8 +498,10 @@ 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
+"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
@@ -507,7 +514,8 @@ 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 Mrouted
-also maintains a copy of the kernel forwarding cache table. Entries
+also maintains a copy of the kernel forwarding cache table.
+Entries
are created and deleted by
.Nm mrouted .
.Pp
@@ -545,16 +553,21 @@ 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
+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
+subnet, a prune message is sent to the upstream router.
+They are
indicated by a "P" after the vif number.
.Pp
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
+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.
.Pp