Annotation of embedaddon/mtr/mtr.8, revision 1.1.1.1
1.1 misho 1: .TH MTR 8 "March 4, 1999" "mtr" "mtr"
2:
3:
4: .SH NAME
5: mtr \- a network diagnostic tool
6:
7:
8: .SH SYNOPSIS
9: .B mtr
10: [\c
11: .B \-hvrctglspeniuTP46\c
12: ]
13: [\c
14: .B \-\-help\c
15: ]
16: [\c
17: .B \-\-version\c
18: ]
19: [\c
20: .B \-\-report\c
21: ]
22: [\c
23: .B \-\-report-wide\c
24: ]
25: [\c
26: .B \-\-report\-cycles\ COUNT\c
27: ]
28: [\c
29: .B \-\-curses\c
30: ]
31: [\c
32: .B \-\-split\c
33: ]
34: [\c
35: .B \-\-raw\c
36: ]
37: [\c
38: .B \-\-mpls\c
39: ]
40: [\c
41: .B \-\-no-dns\c
42: ]
43: [\c
44: .B \-\-show-ips\c
45: ]
46: [\c
47: .B \-\-gtk\c
48: ]
49: [\c
50: .B \-\-address\ IP.ADD.RE.SS\c
51: ]
52: [\c
53: .B \-\-interval\ SECONDS\c
54: ]
55: [\c
56: .B \-\-psize\ BYTES | -s BYTES\c
57: ]
58: [\c
59: .B \-\-tcp\c
60: ]
61: [\c
62: .B \-\-port\ PORT\c
63: ]
64: [\c
65: .B \-\-timeout\ SECONDS\c
66: ]
67: .B HOSTNAME [PACKETSIZE]
68:
69:
70: .SH DESCRIPTION
71:
72: .B mtr
73: combines the functionality of the
74: .B traceroute
75: and
76: .B ping
77: programs in a single network diagnostic tool.
78:
79: .PP
80: As
81: .B mtr
82: starts, it investigates the network connection between the host
83: .B mtr
84: runs on and
85: .BR HOSTNAME .
86: by sending packets with purposely low TTLs. It continues to send
87: packets with low TTL, noting the response time of the intervening
88: routers. This allows
89: .B mtr
90: to print the response percentage and response times of the internet
91: route to
92: .BR HOSTNAME .
93: A sudden increase in packet loss or response time is often an indication
94: of a bad (or simply overloaded) link.
95:
96: .PP
97: The results are usually reported as round-trip-response times in miliseconds
98: and the percentage of packetloss.
99:
100: .SH OPTIONS
101:
102: .TP
103: .B \-h
104: .TP
105: .B \-\-help
106: .br
107: Print the summary of command line argument options.
108:
109: .TP
110: .B \-v
111: .TP
112: .B \-\-version
113: .br
114: Print the installed version of mtr.
115:
116: .TP
117: .B \-r
118: .TP
119: .B \-\-report
120: .br
121: This option puts
122: .B mtr
123: into
124: .B report
125: mode. When in this mode,
126: .B mtr
127: will run for the number of cycles specified by the
128: .B \-c
129: option, and then print statistics and exit.
130: .TP
131: \c
132: This mode is useful for generating statistics about network quality.
133: Note that each running instance of
134: .B mtr
135: generates a significant amount of network traffic. Using
136: .B mtr
137: to measure the quality of your network may result in decreased
138: network performance.
139:
140: .TP
141: .B \-w
142: .TP
143: .B \-\-report-wide
144: .br
145: This option puts
146: .B mtr
147: into
148: .B wide report
149: mode. When in this mode,
150: .B mtr
151: will not cut hostnames in the report.
152:
153: .TP
154: .B \-c\ COUNT
155: .TP
156: .B \-\-report\-cycles\ COUNT
157: Use this option to set the number of pings sent to determine
158: both the machines on the network and the reliability of
159: those machines. Each cycle lasts one second.
160:
161: .TP
162: .B \-s\ BYTES
163: .TP
164: .B \-\-psize\ BYTES
165: .TP
166: .B PACKETSIZE
167: These options or a trailing PACKETSIZE on the command line sets
168: the packet size used for probing.
169: It is in bytes inclusive IP and ICMP headers
170:
171: If set to a negative number, every iteration will use a different, random
172: packet size upto that number.
173: .TP
174: .B \-t
175: .TP
176: .B \-\-curses
177: .br
178: Use this option to force
179: .B mtr
180: to use the curses based terminal
181: interface (if available).
182:
183: .TP
184: .B \-e
185: .TP
186: .B \-\-mpls
187: .br
188: Use this option to tell
189: .B mtr
190: to display information from ICMP extensions for MPLS (RFC 4950)
191: that are encoded in the response packets.
192:
193: .TP
194: .B \-n
195: .TP
196: .B \-\-no-dns
197: .br
198: Use this option to force
199: .B mtr
200: to display numeric IP numbers and not try to resolve the
201: host names.
202:
203: .TP
204: .B \-b
205: .TP
206: .B \-\-show-ips
207: .br
208: Use this option to tell
209: .B mtr
210: to display both the host names and numeric IP numbers. In split mode
211: this adds an extra field to the output. In report mode, there is usually
212: too little space to add the IPs, and they will be truncated. Use the
213: wide report (-w) mode to see the IPs in report mode.
214:
215: .TP
216: .B \-o\ fields\ order
217: .TP
218: .B \-\-order\ fields\ order
219: .br
220: Use this option to specify the fields and their order when loading mtr.
221: .br
222: Available fields:
223: .TS
224: center allbox tab(%);
225: ll.
226: L%Loss ratio
227: D%Dropped packets
228: R%Received packets
229: S%Sent Packets
230: N%Newest RTT(ms)
231: B%Min/Best RTT(ms)
232: A%Average RTT(ms)
233: W%Max/Worst RTT(ms)
234: V%Standard Deviation
235: G%Geometric Mean
236: J%Current Jitter
237: M%Jitter Mean/Avg.
238: X%Worst Jitter
239: I%Interarrival Jitter
240: .TE
241: .br
242:
243: Example:
244: -o "LSD NBAW"
245: .TP
246: .B \-g
247: .TP
248: .B \-\-gtk
249: .br
250: Use this option to force
251: .B mtr
252: to use the GTK+ based X11 window interface (if available).
253: GTK+ must have been available on the system when
254: .B mtr
255: was built for this to work. See the GTK+ web page at
256: .B http://www.gtk.org/
257: for more information about GTK+.
258:
259: .TP
260: .B \-p
261: .TP
262: .B \-\-split
263: .br
264: Use this option to set
265: .B mtr
266: to spit out a format that is suitable for a split-user interface.
267:
268: .TP
269: .B \-l
270: .TP
271: .B \-\-raw
272: .br
273: Use this option to tell
274: .B mtr
275: to use the raw output format. This format is better suited for
276: archival of the measurement results. It could be parsed to
277: be presented into any of the other display methods.
278:
279: .TP
280: .B \-a\ IP.ADD.RE.SS
281: .TP
282: .B \-\-address\ IP.ADD.RE.SS
283: .br
284: Use this option to bind outgoing packets' socket to specific interface,
285: so that any packet will be sent through this interface. NOTE that this
286: option doesn't apply to DNS requests (which could be and could not be
287: what you want).
288:
289: .TP
290: .B \-i\ SECONDS
291: .TP
292: .B \-\-interval\ SECONDS
293: .br
294: Use this option to specify the positive number of seconds between ICMP
295: ECHO requests. The default value for this parameter is one second.
296:
297: .TP
298: .B \-u
299: .br
300: Use UDP datagrams instead of ICMP ECHO.
301:
302: .TP
303: .B \-T
304: .TP
305: .B \-\-tcp
306: .br
307: Use TCP SYN packets instead of ICMP ECHO. PACKETSIZE is ignored, since
308: SYN packets can not contain data.
309:
310: .TP
311: .B \-P\ PORT
312: .TP
313: .B \-\-port\ PORT
314: .br
315: The target port number for TCP traces.
316:
317: .TP
318: .B \-\-timeout\ SECONDS
319: .br
320: The number of seconds to keep the TCP socket open before giving up on
321: the connection. This will only affect the final hop. Using large values
322: for this, especially combined with a short interval, will use up a lot
323: of file descriptors.
324:
325: .TP
326: .B \-4
327: .br
328: Use IPv4 only.
329:
330: .TP
331: .B \-6
332: .br
333: Use IPv6 only.
334:
335: .SH BUGS
336:
337: Some modern routers give a lower priority to ICMP ECHO packets than
338: to other network traffic. Consequently, the reliability of these
339: routers reported by
340: .B mtr
341: will be significantly lower than the actual reliability of
342: these routers.
343:
344:
345: .SH CONTACT INFORMATION
346:
347: .PP
348: For the latest version, see the mtr web page at
349: .BR http://www.bitwizard.nl/mtr/ .
350:
351: .PP
352: The mtr mailinglist was little used and is no longer active.
353:
354: .PP
355: Bug reports and feature requests should be submitted to the
356: launchpad mtr bugtracker.
357:
358: .SH "SEE ALSO"
359:
360: traceroute(8),
361: ping(8)
362: TCP/IP Illustrated (Stevens, ISBN 0201633469).
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>