usr.sbin/mrinfo/mrinfo.8

   1 .\"     $NetBSD: mrinfo.8,v 1.7 2003/03/05 21:59:59 wiz Exp $
   2 .\"
   3 .\" Written Wed Mar 24 1993 by Van Jacobson (adapted from the
   4 .\" multicast mapper written by Pavel Curtis).
   5 .\"
   6 .\" The lawyers insist we include the following UC copyright notice.
   7 .\" The mapper from which this is derived contained a Xerox copyright
   8 .\" notice which follows the UC one.  Try not to get depressed noting
   9 .\" that the legal gibberish is larger than the program.
  10 .\"
  11 .\" Copyright (c) 1993 Regents of the University of California.
  12 .\" All rights reserved.
  13 .\"
  14 .\" Redistribution and use in source and binary forms, with or without
  15 .\" modification, are permitted provided that the following conditions
  16 .\" are met:
  17 .\" 1. Redistributions of source code must retain the above copyright
  18 .\"    notice, this list of conditions and the following disclaimer.
  19 .\" 2. Redistributions in binary form must reproduce the above copyright
  20 .\"    notice, this list of conditions and the following disclaimer in the
  21 .\"    documentation and/or other materials provided with the distribution.
  22 .\" 3. All advertising materials mentioning features or use of this software
  23 .\"    must display the following acknowledgement:
  24 .\"     This product includes software developed by the Computer Systems
  25 .\"     Engineering Group at Lawrence Berkeley Laboratory.
  26 .\" 4. Neither the name of the University nor of the Laboratory may be used
  27 .\"    to endorse or promote products derived from this software without
  28 .\"    specific prior written permission.
  29 .\"
  30 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  31 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  32 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  33 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  34 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  35 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  36 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  37 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  38 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  39 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  40 .\" SUCH DAMAGE.
  41 .\" ---------------------------------
  42 .\" Copyright (c) 1992, 2001 Xerox Corporation.  All rights reserved.
  43 .\"
  44 .\" Redistribution and use in source and binary forms, with or without
  45 .\" modification, are permitted provided that the following conditions are met:
  46 .\"
  47 .\" Redistributions of source code must retain the above copyright notice,
  48 .\" this list of conditions and the following disclaimer.
  49 .\"
  50 .\" Redistributions in binary form must reproduce the above copyright notice,
  51 .\" this list of conditions and the following disclaimer in the documentation
  52 .\" and/or other materials provided with the distribution.
  53 .\"
  54 .\" Neither name of the Xerox, PARC, nor the names of its contributors may be
  55 .\" used to endorse or promote products derived from this software
  56 .\" without specific prior written permission.
  57 .\"
  58 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  59 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  60 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  61 .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE XEROX CORPORATION OR
  62 .\" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  63 .\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  64 .\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  65 .\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  66 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  67 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  68 .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  69 .\"
  70 .TH MRINFO 8
  71 .UC 5
  72 .SH NAME
  73 mrinfo \- Displays configuration info from a multicast router
  74 .SH SYNOPSIS
  75 .B /usr/sbin/mrinfo
  76 [
  77 .B \-d
  78 .I debug_level
  79 ] [
  80 .B \-r
  81 .I retry_count
  82 ] [
  83 .B \-t
  84 .I timeout_count
  85 ]
  86 .B multicast_router
  87
  88 .SH DESCRIPTION
  89 .I mrinfo
  90 attempts to display the configuration information from the multicast router
  91 .I multicast_router.
  92 .PP
  93 .I mrinfo
  94 uses the ASK_NEIGHBORS IGMP message to the specified multicast router. If this
  95 multicast router responds, the version number and a list of their neighboring
  96 multicast router addresses is part of that response. If the responding router
  97 has a recent multicast version number, then
  98 .I mrinfo
  99 requests additional information such as metrics, thresholds, and flags from the
 100 multicast router. Once the specified multicast router responds, the
 101 configuration is displayed to the standard output.
 102 .br
 103 .ne 5
 104 .SH INVOCATION
 105 .PP
 106 "\-d" option sets the debug level. When the debug level is greater than the
 107 default value of 0, addition debugging messages are printed. Regardless of
 108 the debug level, an error condition, will always write an error message and will
 109 cause
 110 .I mrinfo
 111 to terminate.
 112 Non-zero debug levels have the following effects:
 113 .IP "level 1"
 114 packet warnings are printed to stderr.
 115 .IP "level 2"
 116 all level 1 messages plus notifications down networks are printed to stderr.
 117 .IP "level 3"
 118 all level 2 messages plus notifications of all packet
 119 timeouts are printed to stderr.
 120 .PP
 121 "\-r retry_count" sets the neighbor query retry limit. Default is 3 retry.
 122 .PP
 123 "\-t timeout_count" sets the number of seconds to wait for a neighbor query
 124 reply. Default timeout is 4 seconds.
 125 .PP
 126 .SH SAMPLE OUTPUT
 127 .nf
 128 .I mrinfo mbone.phony.dom.net
 129 127.148.176.10 (mbone.phony.dom.net) [version 3.3]:
 130  127.148.176.10 -\*[Gt] 0.0.0.0 (?) [1/1/querier]
 131  127.148.176.10 -\*[Gt] 127.0.8.4 (mbone2.phony.dom.net) [1/45/tunnel]
 132  127.148.176.10 -\*[Gt] 105.1.41.9 (momoney.com) [1/32/tunnel/down]
 133  127.148.176.10 -\*[Gt] 143.192.152.119 (mbone.dipu.edu) [1/32/tunnel]
 134 .fi
 135 .PP
 136 For each neighbor of the queried multicast router, the IP of the queried router
 137 is displayed, followed by the IP and name of the neighbor. In square brackets
 138 the metric (cost of connection), the threshold (multicast ttl) is displayed. If
 139 the queried multicast router has a newer version number, the type (tunnel,
 140 srcrt) and status (disabled, down) of the connection is displayed.
 141 .PP
 142 .SH IMPORTANT NOTE
 143 .I mrinfo
 144 must be run as root.
 145 .PP
 146 .SH SEE ALSO
 147 .BR mrouted (8) ,
 148 .BR map-mbone (8) ,
 149 .BR mtrace (8)
 150 .PP
 151 .SH AUTHOR
 152 Van Jacobson