xref: /openbsd/usr.sbin/mrinfo/mrinfo.8 (revision d89ec533)
1.\"	$OpenBSD: mrinfo.8,v 1.12 2007/05/31 19:20:25 jmc Exp $
2.\"	$NetBSD: mrinfo.8,v 1.2 1995/10/03 23:20:39 thorpej Exp $
3.\"
4.\" Written Wed Mar 24 1993 by Van Jacobson (adapted from the
5.\" multicast mapper written by Pavel Curtis).
6.\"
7.\" The lawyers insist we include the following UC copyright notice.
8.\" The mapper from which this is derived contained a Xerox copyright
9.\" notice which follows the UC one.  Try not to get depressed noting
10.\" that the legal gibberish is larger than the program.
11.\"
12.\" Copyright (c) 1993 Regents of the University of California.
13.\" All rights reserved.
14.\"
15.\" Redistribution and use in source and binary forms, with or without
16.\" modification, are permitted provided that the following conditions
17.\" are met:
18.\" 1. Redistributions of source code must retain the above copyright
19.\"    notice, this list of conditions and the following disclaimer.
20.\" 2. Redistributions in binary form must reproduce the above copyright
21.\"    notice, this list of conditions and the following disclaimer in the
22.\"    documentation and/or other materials provided with the distribution.
23.\" 3. All advertising materials mentioning features or use of this software
24.\"    must display the following acknowledgement:
25.\"	This product includes software developed by the Computer Systems
26.\"	Engineering Group at Lawrence Berkeley Laboratory.
27.\" 4. Neither the name of the University nor of the Laboratory may be used
28.\"    to endorse or promote products derived from this software without
29.\"    specific prior written permission.
30.\"
31.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
32.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
33.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
35.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
39.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
40.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
41.\" SUCH DAMAGE.
42.\" ---------------------------------
43.\" Copyright (c) 1992, 2001 Xerox Corporation.  All rights reserved.
44.\"
45.\" Redistribution and use in source and binary forms, with or without
46.\" modification, are permitted provided that the following conditions are met:
47.\"
48.\" Redistributions of source code must retain the above copyright notice,
49.\" this list of conditions and the following disclaimer.
50.\"
51.\" Redistributions in binary form must reproduce the above copyright notice,
52.\" this list of conditions and the following disclaimer in the documentation
53.\" and/or other materials provided with the distribution.
54.\"
55.\" Neither name of the Xerox, PARC, nor the names of its contributors may be
56.\" used to endorse or promote products derived from this software
57.\" without specific prior written permission.
58.\"
59.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
60.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
61.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
62.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE XEROX CORPORATION OR
63.\" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
64.\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
65.\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
66.\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
67.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
68.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
69.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
70.\"
71.Dd $Mdocdate: May 31 2007 $
72.Dt MRINFO 8
73.Os
74.Sh NAME
75.Nm mrinfo
76.Nd displays configuration info from a multicast router
77.Sh SYNOPSIS
78.Nm mrinfo
79.Op Fl d Ar debug_level
80.Op Fl r Ar retry_count
81.Op Fl t Ar timeout_count
82.Ar multicast_router
83.Sh DESCRIPTION
84.Nm
85attempts to display the configuration information from the specified
86.Ar multicast_router .
87.Pp
88.Nm
89uses the ASK_NEIGHBORS IGMP message to query the specified multicast
90router.
91If the router responds, the version number and a list of their
92neighboring multicast router addresses is part of the response.
93If the responding router has a recent multicast version number, then
94.Nm
95requests additional information such as metrics, thresholds,
96and flags from the multicast router.
97Once the specified multicast router responds,
98the configuration is displayed to the standard output.
99.Pp
100The options are as follows:
101.Bl -tag -width timeout_levelxyz
102.It Fl d Ar debug_level
103sets the debug level.
104When the debug level is greater than the default value of 0,
105additional debugging messages are printed.
106Regardless of the debug level,
107an error condition will always write an error message and cause
108.Nm
109to terminate.
110Non-zero debug levels have the following effects (printed to stderr):
111.Pp
112.Bl -tag -width 1n -compact -offset indent
113.It 1
114packet warnings.
115.It 2
116all level 1 messages plus notifications of down networks.
117.It 3
118all level 2 messages plus notifications of all packet timeouts.
119.El
120.It Fl r Ar retry_count
121sets the neighbor query retry limit.
122The default is to do 3 retries.
123.It Fl t Ar timeout_count
124sets the number of seconds to wait for a neighbor query reply.
125The default timeout is 4 seconds.
126.El
127.Sh EXAMPLES
128.Bd -literal
129# mrinfo mbone.phony.dom.net
130127.148.176.10 (mbone.phony.dom.net) [version 3.3]:
131 127.148.176.10 -> 0.0.0.0 (?) [1/1/querier]
132 127.148.176.10 -> 127.0.8.4 (mbone2.phony.dom.net) [1/45/tunnel]
133 127.148.176.10 -> 105.1.41.9 (momoney.com) [1/32/tunnel/down]
134 127.148.176.10 -> 143.192.152.119 (mbone.dipu.edu) [1/32/tunnel]
135.Ed
136.Pp
137For each neighbor of the queried multicast router, the IP of the queried router
138is displayed, followed by the IP and name of the neighbor.
139In square brackets the metric (cost of connection)
140and threshold (multicast ttl) is displayed.
141If the queried multicast router has a newer version number, the type (tunnel,
142srcrt) and status (disabled, down) of the connection is displayed.
143.Sh SEE ALSO
144.Xr map-mbone 8 ,
145.Xr mrouted 8 ,
146.Xr mtrace 8
147.Sh AUTHORS
148.An Van Jacobson
149