freebsd-src/usr.sbin/mrouted/map-mbone.8

.\" $FreeBSD$
.\"
.Dd May 8, 1995
.Dt MAP-MBONE 8
.Os
.Sh NAME
.Nm map-mbone
.Nd multicast connection mapper
.Sh SYNOPSIS
.Nm
.Op Fl d Ar debug_level
.Op Fl f
.Op Fl g
.Op Fl n
.Op Fl r Ar retry_count
.Op Fl t Ar timeout_count
.Op Ar starting_router
.Sh DESCRIPTION
.Nm Map-mbone
attempts to display all multicast routers that are reachable from the multicast
.Ar starting_router .
If not specified on the command line, the default multicast
.Ar starting_router
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,
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
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
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
the debug level, an error condition, will always write an error message and will
cause 
.Nm
to terminate.
Non-zero debug levels have the following effects:
.Bl -tag -width indent
.It "level 1"
packet warnings are printed to stderr.
.It "level 2"
all level 1 messages plus notifications down networks are printed to stderr.
.It "level 3"
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
of neighboring multicast routers and is enable by default when starting_router
is not used.
.It Fl g
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.
.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.
.El
.Sh IMPORTANT NOTE
.Nm Map-mbone
must be run as root.
.Sh SEE ALSO
.Xr mrinfo 8 ,
.Xr mrouted 8 ,
.Xr mtrace 8
.Sh AUTHORS
.An Pavel Curtis
Add $FreeBSD$ lines to man pages that are missing them to make it easier for translation teams. PR: docs/13418 Submitted by: Alexey Zelkin <phantom@cris.net> 1999-08-29 00:23:38 +01:00			`.\" $FreeBSD$`
			`.\"`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 07:15:23 +01:00			`.Dd May 8, 1995`
			`.Dt MAP-MBONE 8`
mdoc(7) police: added missing .Os call. 2000-12-14 13:58:15 +00:00			`.Os`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 07:15:23 +01:00			`.Sh NAME`
			`.Nm map-mbone`
			`.Nd multicast connection mapper`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 07:15:23 +01:00			`.Op Fl d Ar debug_level`
			`.Op Fl f`
			`.Op Fl g`
			`.Op Fl n`
			`.Op Fl r Ar retry_count`
			`.Op Fl t Ar timeout_count`
			`.Op Ar starting_router`
			`.Sh DESCRIPTION`
			`.Nm Map-mbone`
Forgot to add these two. Submitted by: Mark Tinguely <tinguely@plains.NoDak.edu> 1995-03-31 22:18:13 +01:00			`attempts to display all multicast routers that are reachable from the multicast`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 07:15:23 +01:00			`.Ar starting_router .`
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 1995-06-13 19:05:16 +01:00			`If not specified on the command line, the default multicast`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 07:15:23 +01:00			`.Ar starting_router`
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 1995-06-13 19:05:16 +01:00			`is the localhost.`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 07:15:23 +01:00			`.Pp`
			`.Nm Map-mbone`
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 1995-06-13 19:05:16 +01:00			`traverses neighboring multicast routers by sending the ASK_NEIGHBORS IGMP`
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. 2000-03-01 14:09:25 +00:00			`message to the multicast starting_router.`
			`If this multicast router responds,`
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 1995-06-13 19:05:16 +01:00			`the version number and a list of their neighboring multicast router addresses is`
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. 2000-03-01 14:09:25 +00:00			`part of that response.`
			`If the responding router has recent multicast version`
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 1995-06-13 19:05:16 +01:00			`number, then`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 07:15:23 +01:00			`.Nm`
Forgot to add these two. Submitted by: Mark Tinguely <tinguely@plains.NoDak.edu> 1995-03-31 22:18:13 +01:00			`requests additional information such as metrics, thresholds, and flags from the`
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. 2000-03-01 14:09:25 +00:00			`multicast router.`
			`For each new occurrence of neighboring multicast router in`
Forgot to add these two. Submitted by: Mark Tinguely <tinguely@plains.NoDak.edu> 1995-03-31 22:18:13 +01:00			`the reply and provided the flooding option has been selected, then`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 07:15:23 +01:00			`.Nm`
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. 2000-03-01 14:09:25 +00:00			`asks each of this multicast router for a list of neighbors.`
			`This search`
Forgot to add these two. Submitted by: Mark Tinguely <tinguely@plains.NoDak.edu> 1995-03-31 22:18:13 +01:00			`for unique routers will continue until no new neighboring multicast routers`
			`are reported.`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 07:15:23 +01:00			`.Pp`
			`The following options are available:`
			`.Bl -tag -width indent`
			`.It Fl d`
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. 2000-03-01 14:09:25 +00:00			`Set the debug level.`
			`When the debug level is greater than the`
			`default value of 0, addition debugging messages are printed.`
			`Regardless of`
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 1995-06-13 19:05:16 +01:00			`the debug level, an error condition, will always write an error message and will`
			`cause`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 07:15:23 +01:00			`.Nm`
Forgot to add these two. Submitted by: Mark Tinguely <tinguely@plains.NoDak.edu> 1995-03-31 22:18:13 +01:00			`to terminate.`
			`Non-zero debug levels have the following effects:`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 07:15:23 +01:00			`.Bl -tag -width indent`
			`.It "level 1"`
Forgot to add these two. Submitted by: Mark Tinguely <tinguely@plains.NoDak.edu> 1995-03-31 22:18:13 +01:00			`packet warnings are printed to stderr.`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 07:15:23 +01:00			`.It "level 2"`
Forgot to add these two. Submitted by: Mark Tinguely <tinguely@plains.NoDak.edu> 1995-03-31 22:18:13 +01:00			`all level 1 messages plus notifications down networks are printed to stderr.`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 07:15:23 +01:00			`.It "level 3"`
Forgot to add these two. Submitted by: Mark Tinguely <tinguely@plains.NoDak.edu> 1995-03-31 22:18:13 +01:00			`all level 2 messages plus notifications of all packet`
			`timeouts are printed to stderr.`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 07:15:23 +01:00			`.El`
			`.It Fl f`
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. 2000-03-01 14:09:25 +00:00			`Set flooding option.`
			`Flooding allows the recursive search`
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 1995-06-13 19:05:16 +01:00			`of neighboring multicast routers and is enable by default when starting_router`
			`is not used.`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 07:15:23 +01:00			`.It Fl g`
			`Set graphing in GraphEd format.`
			`.It Fl n`
			`Disable the DNS lookup for the multicast routers names.`
			`.It Fl r Ar retry_count`
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. 2000-03-01 14:09:25 +00:00			`Set the neighbor query retry limit.`
			`Default is 1 retry.`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 07:15:23 +01:00			`.It Fl t Ar timeout_count`
			`Set the number of seconds to wait for a neighbor query`
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. 2000-03-01 14:09:25 +00:00			`reply before retrying.`
			`Default timeout is 2 seconds.`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 07:15:23 +01:00			`.El`
			`.Sh IMPORTANT NOTE`
			`.Nm Map-mbone`
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 1995-06-13 19:05:16 +01:00			`must be run as root.`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 07:15:23 +01:00			`.Sh SEE ALSO`
			`.Xr mrinfo 8 ,`
Sort cross references. 1998-08-31 17:41:09 +01:00			`.Xr mrouted 8 ,`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 07:15:23 +01:00			`.Xr mtrace 8`
.Sh AUTHOR -> .Sh AUTHORS. Use .An/.Aq. 1998-03-23 08:31:20 +00:00			`.Sh AUTHORS`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 07:15:23 +01:00			`.An Pavel Curtis`