freebsd-skq/usr.sbin/mrouted/mrinfo.8

.\" $FreeBSD$
.\"
.Dd May 8, 1995
.Dt MRINFO 8
.Os
.Sh NAME
.Nm mrinfo
.Nd display configuration info from a multicast router
.Sh SYNOPSIS
.Nm
.Op Fl d Ar debug_level
.Op Fl r Ar retry_count
.Op Fl t Ar timeout_count
.Ar multicast_router
.Sh DESCRIPTION
.Nm Mrinfo
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
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 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
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
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 r Ar retry_count
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.
.El
.Sh SAMPLE OUTPUT
.Bd -literal
.Nm mrinfo Ar mbone.phony.dom.net
127.148.176.10 (mbone.phony.dom.net) [version 3.3]:
 127.148.176.10 -> 0.0.0.0 (?) [1/1/querier]
 127.148.176.10 -> 127.0.8.4 (mbone2.phony.dom.net) [1/45/tunnel]
 127.148.176.10 -> 105.1.41.9 (momoney.com) [1/32/tunnel/down]
 127.148.176.10 -> 143.192.152.119 (mbone.dipu.edu) [1/32/tunnel]
.Ed
.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
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
.Nm Mrinfo
must be run as root.
.Sh SEE ALSO
.Xr map-mbone 8 ,
.Xr mrouted 8 ,
.Xr mtrace 8
.Sh AUTHORS
.An Van Jacobson
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-28 23:23:38 +00:00			`.\" $FreeBSD$`
			`.\"`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 06:15:23 +00:00			`.Dd May 8, 1995`
			`.Dt MRINFO 8`
Avoid use of direct troff requests in mdoc(7) manual pages. 2000-11-10 17:46:15 +00:00			`.Os`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 06:15:23 +00:00			`.Sh NAME`
			`.Nm mrinfo`
			`.Nd display configuration info from a multicast router`
			`.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 06:15:23 +00:00			`.Op Fl d Ar debug_level`
			`.Op Fl r Ar retry_count`
			`.Op Fl t Ar timeout_count`
			`.Ar multicast_router`
			`.Sh DESCRIPTION`
			`.Nm Mrinfo`
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 18:05:16 +00:00			`attempts to display the configuration information from the multicast router`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 06:15:23 +00:00			`.Ar multicast_router .`
			`.Pp`
			`.Nm Mrinfo`
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			`uses the ASK_NEIGHBORS IGMP message to the specified multicast router.`
			`If this`
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 18:05:16 +00:00			`multicast router responds, the version number and a list of their neighboring`
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 addresses is part of that response.`
			`If the responding router`
Remove whitespace at EOL. 2001-07-15 08:06:20 +00:00			`has a recent multicast version number, then`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 06:15:23 +00:00			`.Nm`
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 18:05:16 +00: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.`
			`Once the specified multicast router responds, the`
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 18:05:16 +00:00			`configuration is displayed to the standard output.`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 06:15:23 +00:00			`.Pp`
			`The following options are available:`
			`.Bl -tag -width indent`
			`.It Fl d Ar debug_level`
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 18:05:16 +00:00			`the debug level, an error condition, will always write an error message and will`
Remove whitespace at EOL. 2001-07-15 08:06:20 +00:00			`cause`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 06:15:23 +00:00			`.Nm`
Forgot to add these two. Submitted by: Mark Tinguely <tinguely@plains.NoDak.edu> 1995-03-31 21:18:13 +00: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 06:15:23 +00:00			`.Bl -tag -width indent`
			`.It "level 1"`
Forgot to add these two. Submitted by: Mark Tinguely <tinguely@plains.NoDak.edu> 1995-03-31 21:18:13 +00:00			`packet warnings are printed to stderr.`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 06:15:23 +00:00			`.It "level 2"`
Forgot to add these two. Submitted by: Mark Tinguely <tinguely@plains.NoDak.edu> 1995-03-31 21:18:13 +00: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 06:15:23 +00:00			`.It "level 3"`
Forgot to add these two. Submitted by: Mark Tinguely <tinguely@plains.NoDak.edu> 1995-03-31 21:18:13 +00: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 06:15:23 +00:00			`.El`
			`.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 3 retries.`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 06:15:23 +00: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.`
			`Default timeout is 4 seconds.`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 06:15:23 +00:00			`.El`
			`.Sh SAMPLE OUTPUT`
Avoid use of direct troff requests in mdoc(7) manual pages. 2000-11-10 17:46:15 +00:00			`.Bd -literal`
			`.Nm mrinfo Ar mbone.phony.dom.net`
Forgot to add these two. Submitted by: Mark Tinguely <tinguely@plains.NoDak.edu> 1995-03-31 21:18:13 +00:00			`127.148.176.10 (mbone.phony.dom.net) [version 3.3]:`
			`127.148.176.10 -> 0.0.0.0 (?) [1/1/querier]`
			`127.148.176.10 -> 127.0.8.4 (mbone2.phony.dom.net) [1/45/tunnel]`
			`127.148.176.10 -> 105.1.41.9 (momoney.com) [1/32/tunnel/down]`
			`127.148.176.10 -> 143.192.152.119 (mbone.dipu.edu) [1/32/tunnel]`
Avoid use of direct troff requests in mdoc(7) manual pages. 2000-11-10 17:46:15 +00:00			`.Ed`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 06:15:23 +00:00			`.Pp`
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 18:05:16 +00:00			`For each neighbor of the queried multicast router, the IP of the queried router`
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			`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`
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 18:05:16 +00:00			`the queried multicast router has a newer version number, the type (tunnel,`
			`srcrt) and status (disabled, down) of the connection is displayed.`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 06:15:23 +00:00			`.Sh IMPORTANT NOTE`
			`.Nm Mrinfo`
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 18:05:16 +00:00			`must be run as root.`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 06:15:23 +00:00			`.Sh SEE ALSO`
			`.Xr map-mbone 8 ,`
Sort cross references. 1998-08-31 16:41:09 +00:00			`.Xr mrouted 8 ,`
Use err(3). Add usage(). Rewrote man pages in mdoc format. 1997-09-30 06:15:23 +00: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 06:15:23 +00:00			`.An Van Jacobson`