[BACK]Return to mtr.8 CVS log [TXT] [DIR] Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / mtr

Diff for /embedaddon/mtr/mtr.8 between versions 1.1.1.2 and 1.1.1.3

version 1.1.1.2, 2016/11/01 09:33:48 version 1.1.1.3, 2019/10/21 14:25:31
Line 1 Line 1
.TH MTR 8 "July 12, 2014" "mtr" "mtr".TH MTR 8 "0.87.203-0e5e" "mtr" "System Administration"
 .SH NAME  .SH NAME
 mtr \- a network diagnostic tool  mtr \- a network diagnostic tool
 .SH SYNOPSIS  .SH SYNOPSIS
Line 26  mtr \- a network diagnostic tool Line 26  mtr \- a network diagnostic tool
 .B \-\-curses\c  .B \-\-curses\c
 ]  ]
 [\c  [\c
   .BI \--displaymode \ MODE\c
   ]
   [\c
 .B \-\-raw\c  .B \-\-raw\c
 ]  ]
 [\c  [\c
 .B \-\-csv\c  .B \-\-csv\c
 ]  ]
 [\c  [\c
   .B \-\-json\c
   ]
   [\c
 .B \-\-split\c  .B \-\-split\c
 ]  ]
 [\c  [\c
Line 62  mtr \- a network diagnostic tool Line 68  mtr \- a network diagnostic tool
 .BI \-B \ BITPATTERN\c  .BI \-B \ BITPATTERN\c
 ]  ]
 [\c  [\c
   .BI \-G \ GRACEPERIOD\c
   ]
   [\c
 .BI \-Q \ TOS\c  .BI \-Q \ TOS\c
 ]  ]
 [\c  [\c
Line 77  mtr \- a network diagnostic tool Line 86  mtr \- a network diagnostic tool
 .BI \-m \ MAX\-TTL\c  .BI \-m \ MAX\-TTL\c
 ]  ]
 [\c  [\c
   .BI \-U \ MAX\-UNKNOWN\c
   ]
   [\c
 .B \-\-udp\c  .B \-\-udp\c
 ]  ]
 [\c  [\c
 .B \-\-tcp\c  .B \-\-tcp\c
 ]  ]
 [\c  [\c
   .BI \-\-sctp\c
   ]
   [\c
 .BI \-P \ PORT\c  .BI \-P \ PORT\c
 ]  ]
 [\c  [\c
   .BI \-L \ LOCALPORT\c
   ]
   [\c
 .BI \-Z \ TIMEOUT\c  .BI \-Z \ TIMEOUT\c
 ]  ]
 [\c  [\c
Line 116  route to  Line 134  route to 
 A sudden increase in packet loss or response time is often an indication  A sudden increase in packet loss or response time is often an indication
 of a bad (or simply overloaded) link.   of a bad (or simply overloaded) link. 
 .PP  .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.   and the percentage of packetloss. 
 .SH OPTIONS  .SH OPTIONS
 .TP  .TP
Line 130  Print the installed version of mtr.   Line 148  Print the installed version of mtr.  
 Use IPv4 only.  Use IPv4 only.
 .TP  .TP
 .B \-6  .B \-6
Use IPv6 only.  (IPV4 may be used for DNS lookups). Use IPv6 only.  (IPV4 may be used for DNS lookups.)
 .TP  .TP
 .B \-F \fIFILENAME\fR, \fB\-\-filename \fIFILENAME  .B \-F \fIFILENAME\fR, \fB\-\-filename \fIFILENAME
MISSINGReads the list of hostnames from the specified file.
 .TP  .TP
 .B \-r\fR, \fB\-\-report  .B \-r\fR, \fB\-\-report
 This option puts   This option puts 
Line 175  Use this option to force  Line 193  Use this option to force 
 .B mtr   .B mtr 
 to use the curses based terminal  to use the curses based terminal
 interface (if available).  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  .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  .B \-g\fR, \fB\-\-gtk
 Use this option to force  Use this option to force
 .B mtr   .B mtr 
Line 183  to use the GTK+ based X11 window interface (if availab Line 217  to use the GTK+ based X11 window interface (if availab
 GTK+ must have been available on the system when   GTK+ must have been available on the system when 
 .B mtr   .B mtr 
 was built for this to work.  See the GTK+ web page at   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+.  for more information about GTK+.
 .TP  .TP
 .B \-l\fR, \fB\-\-raw  .B \-l\fR, \fB\-\-raw
Use this option to tellUse the raw output format.  This format is better suited for
.B mtr 
to use the raw output format.  This format is better suited for 
 archival of the measurement results.  It could be parsed to   archival of the measurement results.  It could be parsed to 
 be presented into any of the other display methods.   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  .TP
 .B \-C\fR, \fB\-\-csv  .B \-C\fR, \fB\-\-csv
MISSINGUse 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  .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  .B \-p\fR, \fB\-\-split
 Use this option to set  Use this option to set
 .B mtr   .B mtr 
Line 244  Example: Line 313  Example:
 -o "LSD NBAW  X"  -o "LSD NBAW  X"
 .TP  .TP
 .B \-y \fIn\fR, \fB\-\-ipinfo \fIn  .B \-y \fIn\fR, \fB\-\-ipinfo \fIn
MISSINGDisplays 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  .TP
 .B \-z\fR, \fB\-\-aslookup  .B \-z\fR, \fB\-\-aslookup
MISSINGDisplays 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  .TP
 .B \-i \fISECONDS\fR, \fB\-\-interval \fISECONDS  .B \-i \fISECONDS\fR, \fB\-\-interval \fISECONDS
 Use this option to specify the positive number of seconds between ICMP  Use this option to specify the positive number of seconds between ICMP
Line 271  Specifies bit pattern to use in payload.  Should be wi Line 363  Specifies bit pattern to use in payload.  Should be wi
 .I NUM  .I NUM
 is greater than 255, a random pattern is used.  is greater than 255, a random pattern is used.
 .TP  .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  .B \-Q \fINUM\fR, \fB\-\-tos \fINUM
 Specifies value for type of service field in IP header.  Should be within range 0  Specifies value for type of service field in IP header.  Should be within range 0
 - 255.  - 255.
Line 296  Specifies with what TTL to start.  Defaults to 1. Line 392  Specifies with what TTL to start.  Defaults to 1.
 Specifies the maximum number of hops (max time-to-live value) traceroute will  Specifies the maximum number of hops (max time-to-live value) traceroute will
 probe.  Default is 30.  probe.  Default is 30.
 .TP  .TP
   .B \-U \fINUM\fR, \fB\-\-max-unknown \fINUM
   Specifies the maximum unknown host. Default is 5.
   .TP
 .B \-u\fR, \fB\-\-udp  .B \-u\fR, \fB\-\-udp
 Use UDP datagrams instead of ICMP ECHO.  Use UDP datagrams instead of ICMP ECHO.
 .TP  .TP
Line 304  Use TCP SYN packets instead of ICMP ECHO. Line 403  Use TCP SYN packets instead of ICMP ECHO.
 .I PACKETSIZE  .I PACKETSIZE
 is ignored, since SYN packets can not contain data.  is ignored, since SYN packets can not contain data.
 .TP  .TP
   .B \-S\fR, \fB\-\-sctp
   Use Stream Control Transmission Protocol packets instead of ICMP ECHO.
   .TP
 .B \-P \fIPORT\fR, \fB\-\-port \fIPORT  .B \-P \fIPORT\fR, \fB\-\-port \fIPORT
The target port number for TCP traces.The target port number for TCP/SCTP/UDP traces.
 .TP  .TP
   .B \-L \fILOCALPORT\fR, \fB\-\-localport \fILOCALPORT
   The source port number for UDP traces.
   .TP
 .B \-Z \fISECONDS\fR, \fB\-\-timeout \fISECONDS  .B \-Z \fISECONDS\fR, \fB\-\-timeout \fISECONDS
The number of seconds to keep the TCP socket open before giving up onThe number of seconds to keep probe sockets open before giving up on
the connection.  This will only affect the final hop.  Using large valuesthe connection.  Using large values for this, especially combined with
for this, especially combined with a short interval, will use up a lota short interval, will use up a lot of file descriptors.
of file descriptors. 
 .TP  .TP
 .B \-M \fIMARK\fR, \fB\-\-mark \fIMARK  .B \-M \fIMARK\fR, \fB\-\-mark \fIMARK
MISSINGSet 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  .SH ENVIRONMENT
 .B mtr  .B mtr
 recognizes a few environment variables.  recognizes a few environment variables.
Line 324  This environment variable allows to specify options, a Line 433  This environment variable allows to specify options, a
 passed on the command line.  It is parsed before reading the actual  passed on the command line.  It is parsed before reading the actual
 command line options, so that options specified in  command line options, so that options specified in
 .B MTR_OPTIONS  .B MTR_OPTIONS
are overriden by command-line options.are overridden by command-line options.
   
 Example:  Example:
   
Line 344  passed in Line 453  passed in
 .B MTR_OPTIONS\c  .B MTR_OPTIONS\c
 ).  ).
 .TP  .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  .B DISPLAY
Used for the GTK+ frontend.Specifies an X11 server for the GTK+ frontend.
 .SH BUGS  .SH BUGS
 Some modern routers give a lower priority to ICMP ECHO packets than   Some modern routers give a lower priority to ICMP ECHO packets than 
 to other network traffic.  Consequently, the reliability of these  to other network traffic.  Consequently, the reliability of these
Line 356  these routers.   Line 476  these routers.  
 .SH CONTACT INFORMATION  .SH CONTACT INFORMATION
 .PP  .PP
 For the latest version, see the mtr web page at   For the latest version, see the mtr web page at 
.BR http://www.bitwizard.nl/mtr/ ..UR http://\:www.\:bitwizard.\:nl/\:mtr/
 .UE
 .PP  .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  For patches, bug reports, or feature requests, please open an issue on
 GitHub at:  GitHub at:
.BR https://github.com/traviscross/mtr ..UR https://\:github\:.com/\:traviscross/\:mtr
 .UE .
 .SH "SEE ALSO"  .SH "SEE ALSO"
traceroute(8),.BR mtr-packet (8),
ping(8).BR traceroute (8),
 .BR ping (8),
 .BR socket (7),
 TCP/IP Illustrated (Stevens, ISBN 0201633469).  TCP/IP Illustrated (Stevens, ISBN 0201633469).
Removed from v.1.1.1.2  
changed lines
  Added in v.1.1.1.3

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>