usr.sbin/map-mbone/map-mbone.8

   1 .\"     $NetBSD: map-mbone.8,v 1.5 2003/03/05 21:55:52 wiz Exp $
   2 .\"
   3 .\" Mapper for connections between MRouteD multicast routers.
   4 .\" Written by Pavel Curtis <Pavel@PARC.Xerox.Com>
   5 .\"
   6 .\" Copyright (c) 1992, 2001 Xerox Corporation.  All rights reserved.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions are met:
  10 .\"
  11 .\" Redistributions of source code must retain the above copyright notice,
  12 .\" this list of conditions and the following disclaimer.
  13 .\"
  14 .\" Redistributions in binary form must reproduce the above copyright notice,
  15 .\" this list of conditions and the following disclaimer in the documentation
  16 .\" and/or other materials provided with the distribution.
  17 .\"
  18 .\" Neither name of the Xerox, PARC, nor the names of its contributors may be
  19 .\" used to endorse or promote products derived from this software
  20 .\" without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  24 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  25 .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE XEROX CORPORATION OR
  26 .\" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  27 .\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  28 .\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  29 .\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  30 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  31 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  32 .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33 .\"
  34 .TH MAP-MBONE 8
  35 .UC 5
  36 .SH NAME
  37 map-mbone \- Multicast connection mapper
  38 .SH SYNOPSIS
  39 .B /usr/sbin/map-mbone
  40 [
  41 .B \-d
  42 .I debug_level
  43 ] [
  44 .B \-f
  45 ] [
  46 .B \-g
  47 ] [
  48 .B \-n
  49 ] [
  50 .B \-r
  51 .I retry_count
  52 ] [
  53 .B \-t
  54 .I timeout_count
  55 ] [
  56 .B starting_router
  57 ]
  58 .SH DESCRIPTION
  59 .I map-mbone
  60 attempts to display all multicast routers that are reachable from the multicast
  61 .I starting_router.
  62 If not specified on the command line, the default multicast
  63 .I starting_router
  64 is the localhost.
  65 .PP
  66 .I map-mbone
  67 traverses neighboring multicast routers by sending the ASK_NEIGHBORS IGMP
  68 message to the multicast starting_router. If this multicast router responds,
  69 the version number and a list of their neighboring multicast router addresses is
  70 part of that response. If the responding router has recent multicast version
  71 number, then
  72 .I map-mbone
  73 requests additional information such as metrics, thresholds, and flags from the
  74 multicast router. For each new occurrence of neighboring multicast router in
  75 the reply and provided the flooding option has been selected, then
  76 .I map-mbone
  77 asks each of this multicast router for a list of neighbors. This search
  78 for unique routers will continue until no new neighboring multicast routers
  79 are reported.
  80 .br
  81 .ne 5
  82 .SH INVOCATION
  83 .PP
  84 "\-d" option sets the debug level. When the debug level is greater than the
  85 default value of 0, addition debugging messages are printed. Regardless of
  86 the debug level, an error condition, will always write an error message and will
  87 cause
  88 .I map-mbone
  89 to terminate.
  90 Non-zero debug levels have the following effects:
  91 .IP "level 1"
  92 packet warnings are printed to stderr.
  93 .IP "level 2"
  94 all level 1 messages plus notifications down networks are printed to stderr.
  95 .IP "level 3"
  96 all level 2 messages plus notifications of all packet
  97 timeouts are printed to stderr.
  98 .PP
  99 "\-f" option sets flooding option. Flooding allows the recursive search
 100 of neighboring multicast routers and is enable by default when starting_router
 101 is not used.
 102 .PP
 103 "\-g" option sets graphing in GraphEd format.
 104 .PP
 105 "\-n" option disables the DNS lookup for the multicast  routers names.
 106 .PP
 107 "\-r retry_count" sets the neighbor query retry limit. Default is 1 retry.
 108 .PP
 109 "\-t timeout_count" sets the number of seconds to wait for a neighbor query
 110 reply before retrying. Default timeout is 2 seconds.
 111 .PP
 112 .SH IMPORTANT NOTE
 113 .I map-mbone
 114 must be run as root.
 115 .PP
 116 .SH SEE ALSO
 117 .BR mrouted (8) ,
 118 .BR mrinfo (8) ,
 119 .BR mtrace (8)
 120 .PP
 121 .SH AUTHOR
 122 Pavel Curtis