usr.sbin/pim6sd/mtrace6/mtrace6.8

   1 .\" Copyright (C) 1999 WIDE Project.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the project nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     $Id: mtrace6.8,v 1.3 1999/09/12 17:03:18 jinmei Exp $
  29 .\"     $FreeBSD$
  30 .\"
  31 .Dd Sep 12, 1999
  32 .Dt MTRACE6 8
  33 .Os KAME
  34 .Sh NAME
  35 .Nm mtrace6
  36 .Nd print IPv6 multicast path from a source to
  37 a receiver
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Op Fl d Ar destination
  41 .Op Fl g Ar gateway
  42 .Op Fl h Ar hops
  43 .Op Fl i Ar interface
  44 .Op Fl m Ar maxhops
  45 .Op Fl n
  46 .Op Fl r Ar response_addr
  47 .Op Fl w Ar waittime
  48 .Ar source
  49 .Ar group
  50 .Sh DESCRIPTION
  51 .Nm
  52 utilizes a tracing feature implemented in multicast routers that is
  53 accessed via an extension to the MLD protocol.
  54 A trace query is
  55 passed hop-by-hop along the reverse path from the
  56 .Ar destination
  57 to the
  58 .Ar source ,
  59 collecting hop addresses, packet counts, and routing error conditions
  60 along the path, and then the response is returned to the requestor.
  61 .Sh OPTIONS
  62 .Bl -tag -width Ds
  63 .It Fl d Ar destination
  64 Specifies the multicast receiver that the query wants to trace.
  65 It is the host running
  66 .Nm mtrace6
  67 by default.
  68 .It Fl g Ar gateway
  69 Send the trace query via unicast directly to the multicast router
  70 .Ar gateway .
  71 The unicast router must be the last-hop router on the path from the
  72 intended source to the receiver.
  73 .Ar gateway
  74 can also be a multicast address that the last hop router joins.
  75 .It Fl h Ar hops
  76 Set
  77 .Ar hops
  78 to the IPv6 hop limit field of query packets.
  79 The default is 64.
  80 .It Fl i Ar interface
  81 Specifies the local interface (on a multi-homed host) for sending
  82 the trace query and as the default for the receiver and the response
  83 destination.
  84 .It Fl m Ar maxhops
  85 Set to
  86 .Ar maxhops
  87 to the maximum number of hops that will be traced from the receiver
  88 back toward the source.
  89 The default is 127 hops.
  90 .It Fl n
  91 Print hop addresses numerically rather than symbolically and numerically
  92 (saves a nameserver address-to-name lookup for each router found on
  93 the path).
  94 .It Fl r Ar response_addr
  95 Specify the host that the trace response sends to.
  96 By default, the response will send to the host running
  97 .Nm mtrace6 .
  98 .It Fl w Ar waittime
  99 Set the time to wait for a trace response to
 100 .Ar waittime
 101 seconds.
 102 The default is 3 seconds.
 103 .El
 104 .Sh SEE ALSO
 105 .Xr pim6dd 8 ,
 106 .Xr pim6sd 8 ,
 107 .Xr mtrace 8
 108 .Sh BUGS
 109 Multicast trace for IPv6 is experimental.
 110 MLD types for query and
 111 response, and packet format are not officially defined.
 112 .Pp
 113 .Ar waittime
 114 specified by the
 115 .Fl w
 116 option is currently meaningless.
 117 .Sh HISTORY
 118 The
 119 .Nm mtrace6
 120 command first appeared in WIDE/KAME IPv6 protocol stack kit.