Annotation of embedaddon/mrouted/map-mbone.8, revision 1.1.1.1
1.1 misho 1: .\" $OpenBSD: map-mbone.8,v 1.13 2007/05/31 19:20:25 jmc Exp $
2: .\" $NetBSD: map-mbone.8,v 1.2 1995/10/03 23:16:53 thorpej Exp $
3: .\"
4: .\" Mapper for connections between MRouteD multicast routers.
5: .\" Written by Pavel Curtis <Pavel@PARC.Xerox.Com>
6: .\"
7: .\" Copyright (c) 1992, 2001 Xerox Corporation. All rights reserved.
8: .\"
9: .\" Redistribution and use in source and binary forms, with or without
10: .\" modification, are permitted provided that the following conditions are met:
11: .\"
12: .\" Redistributions of source code must retain the above copyright notice,
13: .\" this list of conditions and the following disclaimer.
14: .\"
15: .\" Redistributions in binary form must reproduce the above copyright notice,
16: .\" this list of conditions and the following disclaimer in the documentation
17: .\" and/or other materials provided with the distribution.
18: .\"
19: .\" Neither name of the Xerox, PARC, nor the names of its contributors may be
20: .\" used to endorse or promote products derived from this software
21: .\" without specific prior written permission.
22: .\"
23: .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24: .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
25: .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26: .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE XEROX CORPORATION OR
27: .\" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
28: .\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
29: .\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
30: .\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
31: .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
32: .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
33: .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34: .\"
35: .Dd $Mdocdate: May 31 2007 $
36: .Dt MAP-MBONE 8 SMM
37: .Os
38: .Sh NAME
39: .Nm map-mbone
40: .Nd Multicast connection mapper
41: .Sh SYNOPSIS
42: .Nm map-mbone
43: .Op Fl fgn
44: .Op Fl d Ar level
45: .Op Fl r Ar count
46: .Op Fl t Ar seconds
47: .Op Ar starting_router
48: .Sh DESCRIPTION
49: .Nm
50: attempts to display all multicast routers that are reachable from the multicast
51: router
52: .Ar starting_router .
53: If not specified on the command line,
54: .Ar starting_router
55: is
56: .Dq localhost .
57: .Nm
58: must be run as root.
59: .Pp
60: .Nm
61: sends an
62: .Dv ASK_NEIGHBORS
63: .Tn IGMP
64: message to
65: .Ar starting_router .
66: A response contains the
67: multicast version number
68: of
69: .Ar starting_router
70: and the addresses of
71: all its neighboring multicast routers.
72: If the multicast version number is recent, then
73: .Nm
74: requests additional information such as metrics, thresholds, and flags.
75: .Pp
76: If a recursive search has been requested (see
77: .Fl f ) ,
78: .Nm
79: repeats the above operation for each new
80: multicast router in the list of neighbors and
81: continues the process until no new multicast routers are reported.
82: .Pp
83: The options are as follows:
84: .Pp
85: .Bl -tag -width "-t seconds"
86: .It Fl d Ar level
87: Sets the debug level to
88: .Ar level .
89: When the debug level is greater than
90: 0, additional debugging messages are printed to stderr.
91: Regardless of
92: the debug level, an error condition will always write an error message and will
93: cause
94: .Nm
95: to terminate.
96: Non-zero debug levels are:
97: .Bl -enum -offset indent
98: .It
99: Print packet warnings, plus level 0 messages.
100: .It
101: Print notifications of down networks, plus level 1 messages.
102: .It
103: Print notifications of all packet timeouts, plus level 2 messages.
104: .El
105: .Pp
106: Default is 0.
107: .It Fl f
108: Causes a recursive (flooding) search.
109: If no
110: .Ar starting_router
111: is specified, a recursive search is always performed.
112: .It Fl g
113: Sets graphing format to GraphEd format.
114: .It Fl n
115: Disables DNS lookup for the names of the multicast routers.
116: .It Fl r Ar count
117: Sets the neighbor query retry limit to
118: .Ar count .
119: Default is 1.
120: .It Fl t Ar seconds
121: Sets the number of seconds to wait for a neighbor query
122: reply before retrying to
123: .Ar seconds .
124: Default is 2.
125: .El
126: .Sh SEE ALSO
127: .Xr mrinfo 8 ,
128: .Xr mrouted 8 ,
129: .Xr mtrace 8
130: .Sh AUTHORS
131: Pavel Curtis
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>