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