usr.sbin/mrouted/map-mbone.8

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