--- embedaddon/mtr/mtr.8 2016/11/01 09:33:48 1.1.1.2 +++ embedaddon/mtr/mtr.8 2019/10/21 14:25:31 1.1.1.3 @@ -1,4 +1,4 @@ -.TH MTR 8 "July 12, 2014" "mtr" "mtr" +.TH MTR 8 "0.87.203-0e5e" "mtr" "System Administration" .SH NAME mtr \- a network diagnostic tool .SH SYNOPSIS @@ -26,12 +26,18 @@ mtr \- a network diagnostic tool .B \-\-curses\c ] [\c +.BI \--displaymode \ MODE\c +] +[\c .B \-\-raw\c ] [\c .B \-\-csv\c ] [\c +.B \-\-json\c +] +[\c .B \-\-split\c ] [\c @@ -62,6 +68,9 @@ mtr \- a network diagnostic tool .BI \-B \ BITPATTERN\c ] [\c +.BI \-G \ GRACEPERIOD\c +] +[\c .BI \-Q \ TOS\c ] [\c @@ -77,15 +86,24 @@ mtr \- a network diagnostic tool .BI \-m \ MAX\-TTL\c ] [\c +.BI \-U \ MAX\-UNKNOWN\c +] +[\c .B \-\-udp\c ] [\c .B \-\-tcp\c ] [\c +.BI \-\-sctp\c +] +[\c .BI \-P \ PORT\c ] [\c +.BI \-L \ LOCALPORT\c +] +[\c .BI \-Z \ TIMEOUT\c ] [\c @@ -116,7 +134,7 @@ route to A sudden increase in packet loss or response time is often an indication of a bad (or simply overloaded) link. .PP -The results are usually reported as round-trip-response times in miliseconds +The results are usually reported as round-trip-response times in milliseconds and the percentage of packetloss. .SH OPTIONS .TP @@ -130,10 +148,10 @@ Print the installed version of mtr. Use IPv4 only. .TP .B \-6 -Use IPv6 only. (IPV4 may be used for DNS lookups). +Use IPv6 only. (IPV4 may be used for DNS lookups.) .TP .B \-F \fIFILENAME\fR, \fB\-\-filename \fIFILENAME -MISSING +Reads the list of hostnames from the specified file. .TP .B \-r\fR, \fB\-\-report This option puts @@ -175,7 +193,23 @@ Use this option to force .B mtr to use the curses based terminal interface (if available). +In case the list of hops exceeds the +height of your terminal, you can use the +.B + +and +.B - +keys to scroll up and down half a page. + +.B Ctrl\fR-\fPL +clears spurious error messages that may overwrite other parts of the display. + .TP +.B -\-displaymode \fIMODE +Use this option to select the initial display mode: 0 (default) +selects statistics, 1 selects the stripchart without latency +information, and 2 selects the stripchart with latency +information. +.TP .B \-g\fR, \fB\-\-gtk Use this option to force .B mtr @@ -183,19 +217,54 @@ to use the GTK+ based X11 window interface (if availab GTK+ must have been available on the system when .B mtr was built for this to work. See the GTK+ web page at -.B http://www.gtk.org/ +.UR http://\:www.\:gtk.\:org/ +.UE for more information about GTK+. .TP .B \-l\fR, \fB\-\-raw -Use this option to tell -.B mtr -to use the raw output format. This format is better suited for +Use the raw output format. This format is better suited for archival of the measurement results. It could be parsed to be presented into any of the other display methods. +.IP +Example of the raw output format: +.nf +h 0 10.1.1.1 +p 0 339 +h 1 46.149.16.4 +p 1 530 +h 2 172.31.1.16 +p 2 531 +h 3 82.221.168.236 +p 3 1523 +h 5 195.130.211.8 +p 5 1603 +h 6 193.4.58.17 +p 6 1127 +h 7 193.4.58.17 +d 7 www.isnic.is +.fi .TP .B \-C\fR, \fB\-\-csv -MISSING +Use the Comma-Separated-Value (CSV) output format. +(Note: The separator is actually a semi-colon ';'.) +.IP +Example of the CSV output format: +.nf +MTR.0.86+git:16e39fc0;1435562787;OK;nic.is;1;r-76520-PROD.greenqloud.internal;288 +MTR.0.86+git:16e39fc0;1435562787;OK;nic.is;2;46.149.16.4;2086 +MTR.0.86+git:16e39fc0;1435562787;OK;nic.is;3;172.31.1.16;600 +MTR.0.86+git:16e39fc0;1435562787;OK;nic.is;4;82.221.168.236;1163 +MTR.0.86+git:16e39fc0;1435562787;OK;nic.is;5;???;0 +MTR.0.86+git:16e39fc0;1435562787;OK;nic.is;6;rix-k2-gw.isnic.is;1654 +MTR.0.86+git:16e39fc0;1435562787;OK;nic.is;7;www.isnic.is;1036 +.fi .TP +.B \-j\fR, \fB\-\-json +Use this option to tell +.B mtr +to use the JSON output format. This format is better suited for +automated processing of the measurement results. +.TP .B \-p\fR, \fB\-\-split Use this option to set .B mtr @@ -244,10 +313,33 @@ Example: -o "LSD NBAW X" .TP .B \-y \fIn\fR, \fB\-\-ipinfo \fIn -MISSING +Displays information about each IP hop. Valid values for \fIn\fR are: +.TS +tab(%); +ll. +0%Display AS number (equivalent to \fB-z\fR) +1%Display IP prefix +2%Display country code of the origin AS +3%Display RIR (ripencc, arin, ...) +4%Display the allocation date of the IP prefix +.TE +.br + +It is possible to cycle between these fields at runtime (using the \fBy\fR key). .TP .B \-z\fR, \fB\-\-aslookup -MISSING +Displays the Autonomous System (AS) number alongside each hop. Equivalent to \fB\-\-ipinfo 0\fR. +.IP +Example (columns to the right not shown for clarity): +.nf +1. AS??? r-76520-PROD.greenqloud.internal +2. AS51969 46.149.16.4 +3. AS??? 172.31.1.16 +4. AS30818 82.221.168.236 +5. ??? +6. AS??? rix-k2-gw.isnic.is +7. AS1850 www.isnic.is +.fi .TP .B \-i \fISECONDS\fR, \fB\-\-interval \fISECONDS Use this option to specify the positive number of seconds between ICMP @@ -271,6 +363,10 @@ Specifies bit pattern to use in payload. Should be wi .I NUM is greater than 255, a random pattern is used. .TP +.B \-G \fISECONDS\fR, \fB\-\-gracetime \fISECONDS +Use this option to specify the positive number of seconds to wait for responses +after the final request. The default value is five seconds. +.TP .B \-Q \fINUM\fR, \fB\-\-tos \fINUM Specifies value for type of service field in IP header. Should be within range 0 - 255. @@ -296,6 +392,9 @@ Specifies with what TTL to start. Defaults to 1. Specifies the maximum number of hops (max time-to-live value) traceroute will probe. Default is 30. .TP +.B \-U \fINUM\fR, \fB\-\-max-unknown \fINUM +Specifies the maximum unknown host. Default is 5. +.TP .B \-u\fR, \fB\-\-udp Use UDP datagrams instead of ICMP ECHO. .TP @@ -304,17 +403,27 @@ Use TCP SYN packets instead of ICMP ECHO. .I PACKETSIZE is ignored, since SYN packets can not contain data. .TP +.B \-S\fR, \fB\-\-sctp +Use Stream Control Transmission Protocol packets instead of ICMP ECHO. +.TP .B \-P \fIPORT\fR, \fB\-\-port \fIPORT -The target port number for TCP traces. +The target port number for TCP/SCTP/UDP traces. .TP +.B \-L \fILOCALPORT\fR, \fB\-\-localport \fILOCALPORT +The source port number for UDP traces. +.TP .B \-Z \fISECONDS\fR, \fB\-\-timeout \fISECONDS -The number of seconds to keep the TCP socket open before giving up on -the connection. This will only affect the final hop. Using large values -for this, especially combined with a short interval, will use up a lot -of file descriptors. +The number of seconds to keep probe sockets open before giving up on +the connection. Using large values for this, especially combined with +a short interval, will use up a lot of file descriptors. .TP .B \-M \fIMARK\fR, \fB\-\-mark \fIMARK -MISSING +Set the mark for each packet sent through this socket similar to the +netfilter MARK target but socket-based. +.I MARK +is 32 unsigned integer. See +.BR socket (7) +for full description of this socket option. .SH ENVIRONMENT .B mtr recognizes a few environment variables. @@ -324,7 +433,7 @@ This environment variable allows to specify options, a passed on the command line. It is parsed before reading the actual command line options, so that options specified in .B MTR_OPTIONS -are overriden by command-line options. +are overridden by command-line options. Example: @@ -344,8 +453,19 @@ passed in .B MTR_OPTIONS\c ). .TP +.B MTR_PACKET +A path to the +.I mtr-packet +executable, to be used for sending and receiving network probes. If +.B MTR_PACKET +is unset, the +.B PATH +will be used to search for an +.I mtr-packet +executable. +.TP .B DISPLAY -Used for the GTK+ frontend. +Specifies an X11 server for the GTK+ frontend. .SH BUGS Some modern routers give a lower priority to ICMP ECHO packets than to other network traffic. Consequently, the reliability of these @@ -356,14 +476,16 @@ these routers. .SH CONTACT INFORMATION .PP For the latest version, see the mtr web page at -.BR http://www.bitwizard.nl/mtr/ . +.UR http://\:www.\:bitwizard.\:nl/\:mtr/ +.UE .PP -The mtr mailinglist was little used and is no longer active. -.PP For patches, bug reports, or feature requests, please open an issue on GitHub at: -.BR https://github.com/traviscross/mtr . +.UR https://\:github\:.com/\:traviscross/\:mtr +.UE . .SH "SEE ALSO" -traceroute(8), -ping(8) +.BR mtr-packet (8), +.BR traceroute (8), +.BR ping (8), +.BR socket (7), TCP/IP Illustrated (Stevens, ISBN 0201633469).