Annotation of embedaddon/mtr/mtr.8, revision 1.1.1.2
1.1.1.2 ! misho 1: .TH MTR 8 "July 12, 2014" "mtr" "mtr"
1.1 misho 2: .SH NAME
3: mtr \- a network diagnostic tool
4: .SH SYNOPSIS
1.1.1.2 ! misho 5: .B mtr
1.1 misho 6: [\c
1.1.1.2 ! misho 7: .BR \-4 |\c
! 8: .B \-6\c
1.1 misho 9: ]
10: [\c
1.1.1.2 ! misho 11: .BI \-F \ FILENAME\c
1.1 misho 12: ]
13: [\c
14: .B \-\-report\c
15: ]
16: [\c
17: .B \-\-report-wide\c
18: ]
19: [\c
1.1.1.2 ! misho 20: .B \-\-xml\c
1.1 misho 21: ]
22: [\c
1.1.1.2 ! misho 23: .B \-\-gtk\c
1.1 misho 24: ]
25: [\c
1.1.1.2 ! misho 26: .B \-\-curses\c
1.1 misho 27: ]
28: [\c
29: .B \-\-raw\c
30: ]
31: [\c
1.1.1.2 ! misho 32: .B \-\-csv\c
! 33: ]
! 34: [\c
! 35: .B \-\-split\c
1.1 misho 36: ]
37: [\c
38: .B \-\-no-dns\c
39: ]
40: [\c
41: .B \-\-show-ips\c
42: ]
43: [\c
1.1.1.2 ! misho 44: .BI \-o \ FIELDS\c
! 45: ]
! 46: [\c
! 47: .BI \-y \ IPINFO\c
! 48: ]
! 49: [\c
! 50: .B \-\-aslookup\c
1.1 misho 51: ]
52: [\c
1.1.1.2 ! misho 53: .BI \-i \ INTERVAL\c
1.1 misho 54: ]
55: [\c
1.1.1.2 ! misho 56: .BI \-c \ COUNT\c
1.1 misho 57: ]
58: [\c
1.1.1.2 ! misho 59: .BI \-s \ PACKETSIZE\c
! 60: ]
! 61: [\c
! 62: .BI \-B \ BITPATTERN\c
! 63: ]
! 64: [\c
! 65: .BI \-Q \ TOS\c
! 66: ]
! 67: [\c
! 68: .B \-\-mpls\c
! 69: ]
! 70: [\c
! 71: .BI \-a \ ADDRESS\c
! 72: ]
! 73: [\c
! 74: .BI \-f \ FIRST\-TTL\c
! 75: ]
! 76: [\c
! 77: .BI \-m \ MAX\-TTL\c
! 78: ]
! 79: [\c
! 80: .B \-\-udp\c
1.1 misho 81: ]
82: [\c
83: .B \-\-tcp\c
84: ]
85: [\c
1.1.1.2 ! misho 86: .BI \-P \ PORT\c
1.1 misho 87: ]
88: [\c
1.1.1.2 ! misho 89: .BI \-Z \ TIMEOUT\c
1.1 misho 90: ]
1.1.1.2 ! misho 91: [\c
! 92: .BI \-M \ MARK\c
! 93: ]
! 94: .I HOSTNAME
1.1 misho 95: .SH DESCRIPTION
96: .B mtr
97: combines the functionality of the
98: .B traceroute
99: and
100: .B ping
101: programs in a single network diagnostic tool.
102: .PP
103: As
104: .B mtr
105: starts, it investigates the network connection between the host
106: .B mtr
107: runs on and
1.1.1.2 ! misho 108: .BR HOSTNAME
! 109: by sending packets with purposely low TTLs. It continues to send
1.1 misho 110: packets with low TTL, noting the response time of the intervening
111: routers. This allows
112: .B mtr
113: to print the response percentage and response times of the internet
114: route to
115: .BR HOSTNAME .
116: A sudden increase in packet loss or response time is often an indication
117: of a bad (or simply overloaded) link.
118: .PP
119: The results are usually reported as round-trip-response times in miliseconds
120: and the percentage of packetloss.
121: .SH OPTIONS
122: .TP
1.1.1.2 ! misho 123: .B \-h\fR, \fB\-\-help
1.1 misho 124: Print the summary of command line argument options.
125: .TP
1.1.1.2 ! misho 126: .B \-v\fR, \fB\-\-version
1.1 misho 127: Print the installed version of mtr.
128: .TP
1.1.1.2 ! misho 129: .B \-4
! 130: Use IPv4 only.
1.1 misho 131: .TP
1.1.1.2 ! misho 132: .B \-6
! 133: Use IPv6 only. (IPV4 may be used for DNS lookups).
! 134: .TP
! 135: .B \-F \fIFILENAME\fR, \fB\-\-filename \fIFILENAME
! 136: MISSING
! 137: .TP
! 138: .B \-r\fR, \fB\-\-report
1.1 misho 139: This option puts
140: .B mtr
141: into
142: .B report
143: mode. When in this mode,
144: .B mtr
145: will run for the number of cycles specified by the
146: .B \-c
147: option, and then print statistics and exit.
148: .TP
149: \c
150: This mode is useful for generating statistics about network quality.
151: Note that each running instance of
152: .B mtr
153: generates a significant amount of network traffic. Using
154: .B mtr
155: to measure the quality of your network may result in decreased
156: network performance.
157: .TP
1.1.1.2 ! misho 158: .B \-w\fR, \fB\-\-report\-wide
1.1 misho 159: This option puts
160: .B mtr
161: into
162: .B wide report
163: mode. When in this mode,
164: .B mtr
165: will not cut hostnames in the report.
166: .TP
1.1.1.2 ! misho 167: .B \-x\fR, \fB\-\-xml
! 168: Use this option to tell
! 169: .B mtr
! 170: to use the xml output format. This format is better suited for
! 171: automated processing of the measurement results.
1.1 misho 172: .TP
1.1.1.2 ! misho 173: .B \-t\fR, \fB\-\-curses
1.1 misho 174: Use this option to force
175: .B mtr
176: to use the curses based terminal
177: interface (if available).
178: .TP
1.1.1.2 ! misho 179: .B \-g\fR, \fB\-\-gtk
! 180: Use this option to force
1.1 misho 181: .B mtr
1.1.1.2 ! misho 182: to use the GTK+ based X11 window interface (if available).
! 183: GTK+ must have been available on the system when
! 184: .B mtr
! 185: was built for this to work. See the GTK+ web page at
! 186: .B http://www.gtk.org/
! 187: for more information about GTK+.
1.1 misho 188: .TP
1.1.1.2 ! misho 189: .B \-l\fR, \fB\-\-raw
! 190: Use this option to tell
! 191: .B mtr
! 192: to use the raw output format. This format is better suited for
! 193: archival of the measurement results. It could be parsed to
! 194: be presented into any of the other display methods.
1.1 misho 195: .TP
1.1.1.2 ! misho 196: .B \-C\fR, \fB\-\-csv
! 197: MISSING
! 198: .TP
! 199: .B \-p\fR, \fB\-\-split
! 200: Use this option to set
! 201: .B mtr
! 202: to spit out a format that is suitable for a split-user interface.
! 203: .TP
! 204: .B \-n\fR, \fB\-\-no\-dns
1.1 misho 205: Use this option to force
206: .B mtr
207: to display numeric IP numbers and not try to resolve the
208: host names.
209: .TP
1.1.1.2 ! misho 210: .B \-b\fR, \fB\-\-show\-ips
1.1 misho 211: Use this option to tell
212: .B mtr
213: to display both the host names and numeric IP numbers. In split mode
1.1.1.2 ! misho 214: this adds an extra field to the output. In report mode, there is usually
! 215: too little space to add the IPs, and they will be truncated. Use the
1.1 misho 216: wide report (-w) mode to see the IPs in report mode.
217: .TP
1.1.1.2 ! misho 218: .B \-o \fIFIELDS\fR, \fB\-\-order \fIFIELDS
! 219: Use this option to specify which fields to display and in which order.
! 220: You may use one or more space characters to separate fields.
1.1 misho 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:
1.1.1.2 ! misho 244: -o "LSD NBAW X"
1.1 misho 245: .TP
1.1.1.2 ! misho 246: .B \-y \fIn\fR, \fB\-\-ipinfo \fIn
! 247: MISSING
1.1 misho 248: .TP
1.1.1.2 ! misho 249: .B \-z\fR, \fB\-\-aslookup
! 250: MISSING
1.1 misho 251: .TP
1.1.1.2 ! misho 252: .B \-i \fISECONDS\fR, \fB\-\-interval \fISECONDS
! 253: Use this option to specify the positive number of seconds between ICMP
! 254: ECHO requests. The default value for this parameter is one second. The
! 255: root user may choose values between zero and one.
1.1 misho 256: .TP
1.1.1.2 ! misho 257: .B \-c \fICOUNT\fR, \fB\-\-report\-cycles \fICOUNT
! 258: Use this option to set the number of pings sent to determine
! 259: both the machines on the network and the reliability of
! 260: those machines. Each cycle lasts one second.
! 261: .TP
! 262: .B \-s \fIPACKETSIZE\fR, \fB\-\-psize \fIPACKETSIZE
! 263: This option sets the packet size used for probing. It is in bytes,
! 264: inclusive IP and ICMP headers.
1.1 misho 265:
1.1.1.2 ! misho 266: If set to a negative number, every iteration will use a different, random
! 267: packet size up to that number.
1.1 misho 268: .TP
1.1.1.2 ! misho 269: .B \-B \fINUM\fR, \fB\-\-bitpattern \fINUM
! 270: Specifies bit pattern to use in payload. Should be within range 0 - 255. If
! 271: .I NUM
! 272: is greater than 255, a random pattern is used.
! 273: .TP
! 274: .B \-Q \fINUM\fR, \fB\-\-tos \fINUM
! 275: Specifies value for type of service field in IP header. Should be within range 0
! 276: - 255.
1.1 misho 277: .TP
1.1.1.2 ! misho 278: .B \-e\fR, \fB\-\-mpls
1.1 misho 279: Use this option to tell
280: .B mtr
1.1.1.2 ! misho 281: to display information from ICMP extensions for MPLS (RFC 4950)
! 282: that are encoded in the response packets.
1.1 misho 283: .TP
1.1.1.2 ! misho 284: .B \-a \fIADDRESS\fR, \fB\-\-address \fIADDRESS
! 285: Use this option to bind the outgoing socket to
! 286: .IR ADDRESS ,
! 287: so that all packets will be sent with
! 288: .I ADDRESS
! 289: as source address. NOTE that this option doesn't apply to DNS requests
! 290: (which could be and could not be what you want).
! 291: .TP
! 292: .B \-f \fINUM\fR, \fB\-\-first-ttl \fINUM
! 293: Specifies with what TTL to start. Defaults to 1.
! 294: .TP
! 295: .B \-m \fINUM\fR, \fB\-\-max-ttl \fINUM
! 296: Specifies the maximum number of hops (max time-to-live value) traceroute will
! 297: probe. Default is 30.
1.1 misho 298: .TP
1.1.1.2 ! misho 299: .B \-u\fR, \fB\-\-udp
1.1 misho 300: Use UDP datagrams instead of ICMP ECHO.
301: .TP
1.1.1.2 ! misho 302: .B \-T\fR, \fB\-\-tcp
! 303: Use TCP SYN packets instead of ICMP ECHO.
! 304: .I PACKETSIZE
! 305: is ignored, since SYN packets can not contain data.
1.1 misho 306: .TP
1.1.1.2 ! misho 307: .B \-P \fIPORT\fR, \fB\-\-port \fIPORT
1.1 misho 308: The target port number for TCP traces.
309: .TP
1.1.1.2 ! misho 310: .B \-Z \fISECONDS\fR, \fB\-\-timeout \fISECONDS
1.1 misho 311: The number of seconds to keep the TCP socket open before giving up on
1.1.1.2 ! misho 312: the connection. This will only affect the final hop. Using large values
1.1 misho 313: for this, especially combined with a short interval, will use up a lot
314: of file descriptors.
315: .TP
1.1.1.2 ! misho 316: .B \-M \fIMARK\fR, \fB\-\-mark \fIMARK
! 317: MISSING
! 318: .SH ENVIRONMENT
! 319: .B mtr
! 320: recognizes a few environment variables.
1.1 misho 321: .TP
1.1.1.2 ! misho 322: .B MTR_OPTIONS
! 323: This environment variable allows to specify options, as if they were
! 324: passed on the command line. It is parsed before reading the actual
! 325: command line options, so that options specified in
! 326: .B MTR_OPTIONS
! 327: are overriden by command-line options.
1.1 misho 328:
1.1.1.2 ! misho 329: Example:
1.1 misho 330:
1.1.1.2 ! misho 331: .BI MTR_OPTIONS ="-4\ -c\ 1"
! 332: .B mtr
! 333: .I \-6\ localhost
! 334:
! 335: would send one probe (because of
! 336: .I -c\ 1\c
! 337: ) towards
! 338: .B ::1
! 339: (because of
! 340: .IR -6 ,
! 341: which overrides the
! 342: .I -4
! 343: passed in
! 344: .B MTR_OPTIONS\c
! 345: ).
! 346: .TP
! 347: .B DISPLAY
! 348: Used for the GTK+ frontend.
! 349: .SH BUGS
1.1 misho 350: Some modern routers give a lower priority to ICMP ECHO packets than
351: to other network traffic. Consequently, the reliability of these
352: routers reported by
353: .B mtr
354: will be significantly lower than the actual reliability of
355: these routers.
356: .SH CONTACT INFORMATION
357: .PP
358: For the latest version, see the mtr web page at
359: .BR http://www.bitwizard.nl/mtr/ .
360: .PP
361: The mtr mailinglist was little used and is no longer active.
362: .PP
1.1.1.2 ! misho 363: For patches, bug reports, or feature requests, please open an issue on
! 364: GitHub at:
! 365: .BR https://github.com/traviscross/mtr .
1.1 misho 366: .SH "SEE ALSO"
367: traceroute(8),
368: ping(8)
369: TCP/IP Illustrated (Stevens, ISBN 0201633469).
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to mtr.8 CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / mtr