usr.sbin/mrouted/map-mbone.8

   1 .\" $FreeBSD$
   2 .\"
   3 .Dd May 8, 1995
   4 .Dt MAP-MBONE 8
   5 .Os
   6 .Sh NAME
   7 .Nm map-mbone
   8 .Nd multicast connection mapper
   9 .Sh SYNOPSIS
  10 .Nm
  11 .Op Fl d Ar debug_level
  12 .Op Fl f
  13 .Op Fl g
  14 .Op Fl n
  15 .Op Fl r Ar retry_count
  16 .Op Fl t Ar timeout_count
  17 .Op Ar starting_router
  18 .Sh DESCRIPTION
  19 .Nm Map-mbone
  20 attempts to display all multicast routers that are reachable from the multicast
  21 .Ar starting_router .
  22 If not specified on the command line, the default multicast
  23 .Ar starting_router
  24 is the localhost.
  25 .Pp
  26 .Nm Map-mbone
  27 traverses neighboring multicast routers by sending the ASK_NEIGHBORS IGMP
  28 message to the multicast starting_router.
  29 If this multicast router responds,
  30 the version number and a list of their neighboring multicast router addresses is
  31 part of that response.
  32 If the responding router has recent multicast version
  33 number, then
  34 .Nm
  35 requests additional information such as metrics, thresholds, and flags from the
  36 multicast router.
  37 For each new occurrence of neighboring multicast router in
  38 the reply and provided the flooding option has been selected, then
  39 .Nm
  40 asks each of this multicast router for a list of neighbors.
  41 This search
  42 for unique routers will continue until no new neighboring multicast routers
  43 are reported.
  44 .Pp
  45 The following options are available:
  46 .Bl -tag -width indent
  47 .It Fl d
  48 Set the debug level.
  49 When the debug level is greater than the
  50 default value of 0, addition debugging messages are printed.
  51 Regardless of
  52 the debug level, an error condition, will always write an error message and will
  53 cause
  54 .Nm
  55 to terminate.
  56 Non-zero debug levels have the following effects:
  57 .Bl -tag -width indent
  58 .It "level 1"
  59 packet warnings are printed to stderr.
  60 .It "level 2"
  61 all level 1 messages plus notifications down networks are printed to stderr.
  62 .It "level 3"
  63 all level 2 messages plus notifications of all packet
  64 timeouts are printed to stderr.
  65 .El
  66 .It Fl f
  67 Set flooding option.
  68 Flooding allows the recursive search
  69 of neighboring multicast routers and is enable by default when starting_router
  70 is not used.
  71 .It Fl g
  72 Set graphing in GraphEd format.
  73 .It Fl n
  74 Disable the DNS lookup for the multicast routers names.
  75 .It Fl r Ar retry_count
  76 Set the neighbor query retry limit.
  77 Default is 1 retry.
  78 .It Fl t Ar timeout_count
  79 Set the number of seconds to wait for a neighbor query
  80 reply before retrying.
  81 Default timeout is 2 seconds.
  82 .El
  83 .Sh IMPORTANT NOTE
  84 .Nm Map-mbone
  85 must be run as root.
  86 .Sh SEE ALSO
  87 .Xr mrinfo 8 ,
  88 .Xr mrouted 8 ,
  89 .Xr mtrace 8
  90 .Sh AUTHORS
  91 .An Pavel Curtis