summaryrefslogtreecommitdiffstats
path: root/usr.sbin/mrouted/map-mbone.8
diff options
context:
space:
mode:
authorwollman <wollman@FreeBSD.org>1995-06-13 18:05:16 +0000
committerwollman <wollman@FreeBSD.org>1995-06-13 18:05:16 +0000
commitd7ec2bee9b62915b2bfc4cbeffefb602d913f92d (patch)
tree251f664e3bb6640c0dc6968bd9a6ec402be8d14b /usr.sbin/mrouted/map-mbone.8
parent20ad4f8359820cf12331c0335034438fc23ad604 (diff)
downloadFreeBSD-src-d7ec2bee9b62915b2bfc4cbeffefb602d913f92d.zip
FreeBSD-src-d7ec2bee9b62915b2bfc4cbeffefb602d913f92d.tar.gz
This is mrouted version 3.5, with the route-change notification hook from
mrouted-3.5n. This is being splatted onto the head rather than properly imported thanks to the ``delete trailing whitespace'' screw. This code is now actively working in an operational environment (the DARTNET) so I have some confidence that the basic functionality actually works. Obtained from: Bill Fenner, PARC, and ISI
Diffstat (limited to 'usr.sbin/mrouted/map-mbone.8')
-rw-r--r--usr.sbin/mrouted/map-mbone.8156
1 files changed, 74 insertions, 82 deletions
diff --git a/usr.sbin/mrouted/map-mbone.8 b/usr.sbin/mrouted/map-mbone.8
index 41eb808..ba850d2 100644
--- a/usr.sbin/mrouted/map-mbone.8
+++ b/usr.sbin/mrouted/map-mbone.8
@@ -1,97 +1,89 @@
-.Dd March 31, 1995
-.Dt MAP-MBONE 8
-.Os FreeBSD 2.0
-.Sh NAME
-.Nm map-mbone
-.Nd multicast connection mapper
-.Sh SYNOPSIS
-.Nm map-mbone
-.Op Fl d Ar debuglevel
-.Op Fl f
-.Op Fl g
-.Op Fl n
-.Op Fl r Ar retries
-.Op Fl t Ar timeout
-.Op Ar router
-.Sh DESCRIPTION
-.Nm map-mbone
+.TH MAP-MBONE 8
+.UC 5
+.SH NAME
+map-mbone \- Multicast connection mapper
+.SH SYNOPSIS
+.B /usr/sbin/map-mbone
+[
+.B \-d
+.I debug_level
+] [
+.B \-f
+] [
+.B \-g
+] [
+.B \-n
+] [
+.B \-r
+.I retry_count
+] [
+.B \-t
+.I timeout_count
+] [
+.B starting_router
+]
+.SH DESCRIPTION
+.I map-mbone
attempts to display all multicast routers that are reachable from the multicast
-router
-.Ar router .
-If not specified on the command line, the default
-.Ar router
-is the local host.
-.Nm
-traverses neighboring multicast routers by sending the
-.Dv ASK_NEIGHBORS
-.Tn IGMP
-message to each 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 number, then
-.Nm
+.I starting_router.
+If not specified on the command line, the default multicast
+.I starting_router
+is the localhost.
+.PP
+.I map-mbone
+traverses neighboring multicast routers by sending the ASK_NEIGHBORS IGMP
+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
+number, then
+.I map-mbone
requests additional information such as metrics, thresholds, and flags from the
multicast router. For each new occurrence of neighboring multicast router in
the reply and provided the flooding option has been selected, then
-.Nm
+.I map-mbone
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 options supported by
-.Nm
-are as follows:
-.Bl -tag -width XXXdebuglevel
-.It Fl d Ar debuglevel
-This sets the debug level to
-.Ar debuglevel .
-When the debug level is greater than the default value of 0,
-additional debugging messages are printed. Regardless of the debug
-level, an error condition, will always write an error message and will
-cause
+.br
+.ne 5
+.SH INVOCATION
+.PP
+"\-d" option sets 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
.I map-mbone
to terminate.
Non-zero debug levels have the following effects:
-.Bl -tag -width "level 3"
-.It level 1
+.IP "level 1"
packet warnings are printed to stderr.
-.It level 2
+.IP "level 2"
all level 1 messages plus notifications down networks are printed to stderr.
-.It level 3
+.IP "level 3"
all level 2 messages plus notifications of all packet
timeouts are printed to stderr.
-.El
-.It Fl f
-This option enables flooding. Flooding allows
-.Nm
-to perform recursive search
-of neighboring multicast routers and is enabled by default when an
-initial
-.Ar router
-is not specified.
-.It Fl g
-This option enables graphing in GraphEd format.
-.It Fl n
-This option disables the DNS lookup for the multicast routers' names.
-.It Fl r Ar retries
-This options sets the neighbor query retry limit to
-.Ar retries .
-The default is one retry.
-.It Fl t Ar timeout
-This option sets the number of seconds to wait for a neighbor query
-reply before retrying. The default timeout is two seconds.
-.Sh RESTRICTIONS
-.Nm
-must be run as `root'.
-.Sh SEE ALSO
-.Xr mrinfo 8 ,
-.Xr mrouted 8 ,
-.Xr mtrace 8
-.Sh AUTHOR
+.PP
+"\-f" option sets flooding option. Flooding allows the recursive search
+of neighboring multicast routers and is enable by default when starting_router
+is not used.
+.PP
+"\-g" option sets graphing in GraphEd format.
+.PP
+"\-n" option disables the DNS lookup for the multicast routers names.
+.PP
+"\-r retry_count" sets the neighbor query retry limit. Default is 1 retry.
+.PP
+"\-t timeout_count" sets the number of seconds to wait for a neighbor query
+reply before retrying. Default timeout is 2 seconds.
+.PP
+.SH IMPORTANT NOTE
+.I map-mbone
+must be run as root.
+.PP
+.SH SEE ALSO
+.BR mrouted (8) ,
+.BR mrinfo (8) ,
+.BR mtrace (8)
+.PP
+.SH AUTHOR
Pavel Curtis
-.Sh HISTORY
-A
-.Nm
-command first appeared in
-.Tn FreeBSD
-2.0.
OpenPOWER on IntegriCloud