xref: /freebsd/usr.sbin/traceroute6/traceroute6.8 (revision 1669d8afc64812c8d2d1d147ae1fd42ff441e1b1)
1.\"	$KAME: traceroute6.8,v 1.10 2004/06/06 12:35:15 suz Exp $
2.\"
3.\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. Neither the name of the project nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\" $FreeBSD$
31.\"
32.Dd May 17, 1998
33.Dt TRACEROUTE6 8
34.Os
35.\"
36.Sh NAME
37.Nm traceroute6
38.Nd "print the route IPv6 packets will take to a network node"
39.\"
40.Sh SYNOPSIS
41.Nm
42.Bk -words
43.Op Fl dIlnNrvU
44.Ek
45.Bk -words
46.Op Fl f Ar firsthop
47.Ek
48.Bk -words
49.Op Fl g Ar gateway
50.Ek
51.Bk -words
52.Op Fl m Ar hoplimit
53.Ek
54.Bk -words
55.Op Fl p Ar port
56.Ek
57.Bk -words
58.Op Fl q Ar probes
59.Ek
60.Bk -words
61.Op Fl s Ar src
62.Ek
63.Bk -words
64.Op Fl w Ar waittime
65.Ek
66.Bk -words
67.Ar target
68.Op Ar datalen
69.Ek
70.\"
71.Sh DESCRIPTION
72The
73.Nm
74utility
75uses the IPv6 protocol hop limit field to elicit an ICMPv6 TIME_EXCEEDED
76response from each gateway along the path to some host.
77.Pp
78The only mandatory parameter is the destination host name or IPv6 address.
79The default probe datagram carries 12 bytes of payload,
80in addition to the IPv6 header.
81The size of the payload can be specified by giving a length
82(in bytes)
83after the destination host name.
84.Pp
85Other options are:
86.Bl -tag -width Ds
87.It Fl d
88Debug mode.
89.It Fl f Ar firsthop
90Specify how many hops to skip in trace.
91.It Fl g Ar gateway
92Specify intermediate gateway
93.Nm (
94uses routing header).
95.It Fl I
96Use ICMP6 ECHO instead of UDP datagrams.
97.It Fl l
98Print both host hostnames and numeric addresses.
99Normally
100.Nm
101prints only hostnames if
102.Fl n
103is not specified, and only numeric addresses if
104.Fl n
105is specified.
106.It Fl m Ar hoplimit
107Specify maximum hoplimit, up to 255.
108The default is 30 hops.
109.It Fl n
110Do not resolve numeric address to hostname.
111.It Fl N
112Use a packet with no upper layer header for the probes,
113instead of UDP datagrams.
114.It Fl p Ar port
115Set UDP port number to
116.Ar port .
117.It Fl q Ar probes
118Set the number of probe per hop count to
119.Ar probes .
120.It Fl r
121Bypass the normal routing tables and send directly to a host
122on an attached network.
123If the host is not on a directly-connected network,
124an error is returned.
125This option corresponds to the
126.Dv SO_DONTROUTE
127socket option;
128it can be used to ping a local host through an interface
129that has no route through it
130(e.g., after the interface was dropped by a routing daemon).
131.It Fl s Ar src
132.Ar Src
133specifies the source IPv6 address to be used.
134.It Fl U
135Use UDP datagrams for the probes.
136This is the default.
137.It Fl v
138Be verbose.
139.It Fl w Ar waittime
140Specify the delay time between probes.
141.El
142.Pp
143This program prints the route to the given destination and the round-trip
144time to each gateway, in the same manner as traceroute.
145.Pp
146Here is a list of possible annotations after the round-trip time for each gateway:
147.Bl -hang -offset indent
148.It !N
149Destination Unreachable - No Route to Host.
150.It !P
151Destination Unreachable - Administratively Prohibited.
152.It !S
153Destination Unreachable - Not a Neighbour.
154.It !A
155Destination Unreachable - Address Unreachable.
156.It !\&
157This is printed if the hop limit is <= 1 on a port unreachable message.
158This means that the packet got to the destination,
159but that the reply had a hop limit that was just large enough to
160allow it to get back to the source of the traceroute6.
161This was more interesting in the IPv4 case,
162where some IP stack bugs could be identified by this behaviour.
163.El
164.\"
165.Sh RETURN VALUES
166The
167.Nm
168utility will exit with 0 on success, and non-zero on errors.
169.\"
170.Sh SEE ALSO
171.Xr ping 8 ,
172.Xr ping6 8 ,
173.Xr traceroute 8
174.\"
175.Sh HISTORY
176The
177.Nm
178utility first appeared in WIDE hydrangea IPv6 protocol stack kit.
179