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