TIVI-153: no iputils in Tizen; initial commit
[profile/ivi/iputils.git] / doc / tracepath.sgml
1 <refentry id="tracepath">
2
3 <refmeta>
4 <refentrytitle>tracepath</refentrytitle>
5 <manvolnum>8</manvolnum>
6 <refmiscinfo>iputils-&snapshot;</refmiscinfo>
7 </refmeta>
8
9 <refnamediv>
10 <refname>tracepath, tracepath6</refname>
11 <refpurpose>
12 traces path to a network host discovering MTU along this path</refpurpose>
13 </refnamediv>
14
15 <refsynopsisdiv>
16 <cmdsynopsis>
17 <command>tracepath</command>
18 <arg choice="opt">-n</arg>
19 <arg choice="opt">-b</arg>
20 <arg choice="opt">-l <replaceable/pktlen/</arg>
21 <arg choice="req"><replaceable/destination/</arg>
22 <arg choice="opt"><replaceable/port/</arg>
23 </cmdsynopsis>
24 </refsynopsisdiv>
25
26 <refsect1><title>DESCRIPTION</title>
27 <para>
28 It traces path to <replaceable/destination/ discovering MTU along this path.
29 It uses UDP port <replaceable/port/ or some random port.
30 It is similar to <command/traceroute/, only does not require superuser
31 privileges and has no fancy options.
32 </para>
33
34 <para>
35 <command/tracepath6/ is good replacement for <command/traceroute6/
36 and classic example of application of Linux error queues.
37 The situation with IPv4 is worse, because commercial
38 IP routers do not return enough information in icmp error messages.
39 Probably, it will change, when they will be updated.
40 For now it uses Van Jacobson's trick, sweeping a range
41 of UDP ports to maintain trace history.
42 </para>
43 </refsect1>
44
45 <refsect1><title>OPTIONS</title>
46 <variablelist>
47
48  <varlistentry>
49   <term><option/-n/</term>
50   <listitem><para>
51 Print primarily IP addresses numerically.
52   </para></listitem>
53  </varlistentry>
54
55  <varlistentry>
56   <term><option/-b/</term>
57   <listitem><para>
58 Print both of host names and IP addresses.
59   </para></listitem>
60  </varlistentry>
61
62  <varlistentry>
63   <term><option/-l/</term>
64   <listitem><para>
65 Sets the initial packet length to <replaceable/pktlen/ instead of
66 65536 for <command/tracepath/ or 128000 for <command/tracepath6/.
67   </para></listitem>
68  </varlistentry>
69 </variablelist>
70 </refsect1>
71
72 <refsect1><title>OUTPUT</title>
73 <para>
74 <literallayout>
75 root@mops:~ # tracepath6 3ffe:2400:0:109::2
76  1?: [LOCALHOST]                              pmtu 1500
77  1:  dust.inr.ac.ru                   0.411ms
78  2:  dust.inr.ac.ru        asymm  1   0.390ms pmtu 1480
79  2:  3ffe:2400:0:109::2               463.514ms reached
80      Resume: pmtu 1480 hops 2 back 2
81 </literallayout>
82 </para>
83
84 <para>
85 The first column shows <literal/TTL/ of the probe, followed by colon.
86 Usually value of <literal/TTL/ is obtained from reply from network,
87 but sometimes reply does not contain necessary information and
88 we have to guess it. In this case the number is followed by ?.
89 </para>
90
91 <para>
92 The second column shows the network hop, which replied to the probe.
93 It is either address of router or word <literal/[LOCALHOST]/, if
94 the probe was not sent to the network.
95 </para>
96
97 <para>
98 The rest of line shows miscellaneous information about path to
99 the correspinding hetwork hop. As rule it contains value of RTT.
100 Additionally, it can show Path MTU, when it changes.
101 If the path is asymmetric
102 or the probe finishes before it reach prescribed hop, difference
103 between number of hops in forward and backward direction is shown
104 following keyword <literal/async/. This information is not reliable.
105 F.e. the third line shows asymmetry of 1, it is because the first probe
106 with TTL of 2 was rejected at the first hop due to Path MTU Discovery.
107 </para>
108
109 <para>
110 The last line summarizes information about all the path to the destination,
111 it shows detected Path MTU, amount of hops to the destination and our
112 guess about amount of hops from the destination to us, which can be
113 different when the path is asymmetric.
114 </para>
115
116 </refsect1>
117
118
119
120
121 <refsect1><title>SEE ALSO</title>
122 <para>
123 <citerefentry><refentrytitle/traceroute/<manvolnum/8/</citerefentry>,
124 <link linkend="traceroute6">
125 <citerefentry><refentrytitle/traceroute6/<manvolnum/8/</citerefentry></link>,
126 <link linkend="ping">
127 <citerefentry><refentrytitle/ping/<manvolnum/8/</citerefentry></link>.
128 </para>
129 </refsect1>
130
131 <refsect1><title>AUTHOR</title>
132 <para>
133 <command/tracepath/ was written by
134 <ulink url="mailto:kuznet@ms2.inr.ac.ru">Alexey Kuznetsov
135 &lt;kuznet@ms2.inr.ac.ru&gt;</ulink>.
136 </para>
137 </refsect1>
138
139 <refsect1><title>SECURITY</title>
140 <para>
141 No security issues.
142 </para>
143 <para>
144 This lapidary deserves to be elaborated.
145 <command/tracepath/ is not a privileged program, unlike
146 <command/traceroute/, <command/ping/ and other beasts of this kind.
147 <command/tracepath/ may be executed by everyone who has some access
148 to network, enough to send UDP datagrams to investigated destination
149 using given port.
150 </para>
151 </refsect1>
152
153 <refsect1><title>AVAILABILITY</title>
154 <para>
155 <command/tracepath/ is part of <filename/iputils/ package
156 and the latest versions are  available in source form at
157 <ulink url="http://www.skbuff.net/iputils/iputils-current.tar.bz2">
158 http://www.skbuff.net/iputils/iputils-current.tar.bz2</ulink>.
159 </para>
160 </refsect1>
161
162 <![IGNORE[
163 <refsect1><title>COPYING</title>
164 <para>
165 <literallayout>
166 This documentation is free software; you can redistribute
167 it and/or modify it under the terms of the GNU General Public
168 License Version 2.
169
170 This program is distributed in the hope that it will be
171 useful, but WITHOUT ANY WARRANTY; without even the implied
172 warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
173 See the GNU General Public License for more details.
174  
175 For more details see the file COPYING in the source
176 distribution of Linux kernel of version 2.4.
177 </literallayout>
178 </para>
179 </refsect1>
180 ]]>
181
182
183
184
185 </refentry>