Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.sbin / mrouted / mrinfo.8
1 .\" $FreeBSD: src/usr.sbin/mrouted/mrinfo.8,v 1.9.2.4 2003/03/11 21:13:51 trhodes Exp $
2 .\"
3 .Dd May 8, 1995
4 .Dt MRINFO 8
5 .Os
6 .Sh NAME
7 .Nm mrinfo
8 .Nd display configuration info from a multicast router
9 .Sh SYNOPSIS
10 .Nm
11 .Op Fl d Ar debug_level
12 .Op Fl r Ar retry_count
13 .Op Fl t Ar timeout_count
14 .Ar multicast_router
15 .Sh DESCRIPTION
16 The
17 .Nm
18 utility
19 attempts to display the configuration information from the multicast router
20 .Ar multicast_router .
21 .Pp
22 The
23 .Nm
24 utility uses the ASK_NEIGHBORS IGMP message to the specified multicast router.
25 If this
26 multicast router responds, the version number and a list of their neighboring
27 multicast router addresses is part of that response.
28 If the responding router
29 has a recent multicast version number, then
30 .Nm
31 requests additional information such as metrics, thresholds, and flags from the
32 multicast router.
33 Once the specified multicast router responds, the
34 configuration is displayed to the standard output.
35 .Pp
36 The following options are available:
37 .Bl -tag -width indent
38 .It Fl d Ar debug_level
39 Set the debug level.
40 When the debug level is greater than the
41 default value of 0, addition debugging messages are printed.
42 Regardless of
43 the debug level, an error condition, will always write an error message and will
44 cause
45 .Nm
46 to terminate.
47 Non-zero debug levels have the following effects:
48 .Bl -tag -width indent
49 .It "level 1"
50 packet warnings are printed to stderr.
51 .It "level 2"
52 all level 1 messages plus notifications down networks are printed to stderr.
53 .It "level 3"
54 all level 2 messages plus notifications of all packet
55 timeouts are printed to stderr.
56 .El
57 .It Fl r Ar retry_count
58 Set the neighbor query retry limit.
59 Default is 3 retries.
60 .It Fl t Ar timeout_count
61 Set the number of seconds to wait for a neighbor query
62 reply.
63 Default timeout is 4 seconds.
64 .El
65 .Sh SAMPLE OUTPUT
66 .Bd -literal
67 .Nm mrinfo Ar mbone.phony.dom.net
68 127.148.176.10 (mbone.phony.dom.net) [version 3.3]:
69  127.148.176.10 -> 0.0.0.0 (?) [1/1/querier]
70  127.148.176.10 -> 127.0.8.4 (mbone2.phony.dom.net) [1/45/tunnel]
71  127.148.176.10 -> 105.1.41.9 (momoney.com) [1/32/tunnel/down]
72  127.148.176.10 -> 143.192.152.119 (mbone.dipu.edu) [1/32/tunnel]
73 .Ed
74 .Pp
75 For each neighbor of the queried multicast router, the IP of the queried router
76 is displayed, followed by the IP and name of the neighbor.
77 In square brackets
78 the metric (cost of connection), the threshold (multicast ttl) is displayed.
79 If
80 the queried multicast router has a newer version number, the type (tunnel,
81 srcrt) and status (disabled, down) of the connection is displayed.
82 .Sh IMPORTANT NOTE
83 The
84 .Nm
85 utility must be run as root.
86 .Sh SEE ALSO
87 .Xr map-mbone 8 ,
88 .Xr mrouted 8 ,
89 .Xr mtrace 8
90 .Sh AUTHORS
91 .An Van Jacobson