embedaddon/mtr/mtr.8 - diff

Return to mtr.8 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / mtr

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

version 1.1.1.1, 2013/07/21 23:43:42	version 1.1.1.2, 2016/11/01 09:33:48
Line 1	Line 1
.TH MTR 8 "March 4, 1999" "mtr" "mtr"	.TH MTR 8 "July 12, 2014" "mtr" "mtr"


.SH NAME	.SH NAME
mtr \- a network diagnostic tool	mtr \- a network diagnostic tool


.SH SYNOPSIS	.SH SYNOPSIS
.B mtr	.B mtr
[\c	[\c
.B \-hvrctglspeniuTP46\c	.BR \-4 \|\c
	.B \-6\c
]	]
[\c	[\c
.B \-\-help\c	.BI \-F \ FILENAME\c
]	]
[\c	[\c
.B \-\-version\c
]
[\c
.B \-\-report\c	.B \-\-report\c
]	]
[\c	[\c
.B \-\-report-wide\c	.B \-\-report-wide\c
]	]
[\c	[\c
.B \-\-report\-cycles\ COUNT\c	.B \-\-xml\c
]	]
[\c	[\c
.B \-\-curses\c	.B \-\-gtk\c
]	]
[\c	[\c
.B \-\-split\c	.B \-\-curses\c
]	]
[\c	[\c
.B \-\-raw\c	.B \-\-raw\c
]	]
[\c	[\c
.B \-\-mpls\c	.B \-\-csv\c
]	]
[\c	[\c
	.B \-\-split\c
	]
	[\c
.B \-\-no-dns\c	.B \-\-no-dns\c
]	]
[\c	[\c
.B \-\-show-ips\c	.B \-\-show-ips\c
]	]
[\c	[\c
.B \-\-gtk\c	.BI \-o \ FIELDS\c
]	]
[\c	[\c
.B \-\-address\ IP.ADD.RE.SS\c	.BI \-y \ IPINFO\c
]	]
[\c	[\c
.B \-\-interval\ SECONDS\c	.B \-\-aslookup\c
]	]
[\c	[\c
.B \-\-psize\ BYTES \| -s BYTES\c	.BI \-i \ INTERVAL\c
]	]
[\c	[\c
	.BI \-c \ COUNT\c
	]
	[\c
	.BI \-s \ PACKETSIZE\c
	]
	[\c
	.BI \-B \ BITPATTERN\c
	]
	[\c
	.BI \-Q \ TOS\c
	]
	[\c
	.B \-\-mpls\c
	]
	[\c
	.BI \-a \ ADDRESS\c
	]
	[\c
	.BI \-f \ FIRST\-TTL\c
	]
	[\c
	.BI \-m \ MAX\-TTL\c
	]
	[\c
	.B \-\-udp\c
	]
	[\c
.B \-\-tcp\c	.B \-\-tcp\c
]	]
[\c	[\c
.B \-\-port\ PORT\c	.BI \-P \ PORT\c
]	]
[\c	[\c
.B \-\-timeout\ SECONDS\c	.BI \-Z \ TIMEOUT\c
]	]
.B HOSTNAME [PACKETSIZE]	[\c
	.BI \-M \ MARK\c
	]
	.I HOSTNAME
.SH DESCRIPTION	.SH DESCRIPTION

.B mtr	.B mtr
combines the functionality of the	combines the functionality of the
.B traceroute	.B traceroute
and	and
.B ping	.B ping
programs in a single network diagnostic tool.	programs in a single network diagnostic tool.

.PP	.PP
As	As
.B mtr	.B mtr
starts, it investigates the network connection between the host	starts, it investigates the network connection between the host
.B mtr	.B mtr
runs on and	runs on and
.BR HOSTNAME .	.BR HOSTNAME
by sending packets with purposely low TTLs. It continues to send	by sending packets with purposely low TTLs. It continues to send
packets with low TTL, noting the response time of the intervening	packets with low TTL, noting the response time of the intervening
routers. This allows	routers. This allows
.B mtr	.B mtr
Line 92 route to	Line 115 route to
.BR HOSTNAME .	.BR HOSTNAME .
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 miliseconds
and the percentage of packetloss.	and the percentage of packetloss.

.SH OPTIONS	.SH OPTIONS

.TP	.TP
.B \-h	.B \-h\fR, \fB\-\-help
.TP
.B \-\-help
.br
Print the summary of command line argument options.	Print the summary of command line argument options.

.TP	.TP
.B \-v	.B \-v\fR, \fB\-\-version
.TP
.B \-\-version
.br
Print the installed version of mtr.	Print the installed version of mtr.

.TP	.TP
.B \-r	.B \-4
	Use IPv4 only.
.TP	.TP
.B \-\-report	.B \-6
.br	Use IPv6 only. (IPV4 may be used for DNS lookups).
	.TP
	.B \-F \fIFILENAME\fR, \fB\-\-filename \fIFILENAME
	MISSING
	.TP
	.B \-r\fR, \fB\-\-report
This option puts	This option puts
.B mtr	.B mtr
into	into
Line 136 generates a significant amount of network traffic. Us	Line 154 generates a significant amount of network traffic. Us
.B mtr	.B mtr
to measure the quality of your network may result in decreased	to measure the quality of your network may result in decreased
network performance.	network performance.

.TP	.TP
.B \-w	.B \-w\fR, \fB\-\-report\-wide
.TP
.B \-\-report-wide
.br
This option puts	This option puts
.B mtr	.B mtr
into	into
Line 149 into	Line 163 into
mode. When in this mode,	mode. When in this mode,
.B mtr	.B mtr
will not cut hostnames in the report.	will not cut hostnames in the report.

.TP	.TP
.B \-c\ COUNT	.B \-x\fR, \fB\-\-xml
	Use this option to tell
	.B mtr
	to use the xml output format. This format is better suited for
	automated processing of the measurement results.
.TP	.TP
.B \-\-report\-cycles\ COUNT	.B \-t\fR, \fB\-\-curses
Use this option to set the number of pings sent to determine
both the machines on the network and the reliability of
those machines. Each cycle lasts one second.

.TP
.B \-s\ BYTES
.TP
.B \-\-psize\ BYTES
.TP
.B PACKETSIZE
These options or a trailing PACKETSIZE on the command line sets
the packet size used for probing.
It is in bytes inclusive IP and ICMP headers

If set to a negative number, every iteration will use a different, random
packet size upto that number.
.TP
.B \-t
.TP
.B \-\-curses
.br
Use this option to force	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).

.TP	.TP
.B \-e	.B \-g\fR, \fB\-\-gtk
.TP	Use this option to force
.B \-\-mpls
.br
Use this option to tell
.B mtr	.B mtr
to display information from ICMP extensions for MPLS (RFC 4950)	to use the GTK+ based X11 window interface (if available).
that are encoded in the response packets.	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/
	for more information about GTK+.
.TP	.TP
.B \-n	.B \-l\fR, \fB\-\-raw
	Use this option to tell
	.B mtr
	to 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.
.TP	.TP
.B \-\-no-dns	.B \-C\fR, \fB\-\-csv
.br	MISSING
	.TP
	.B \-p\fR, \fB\-\-split
	Use this option to set
	.B mtr
	to spit out a format that is suitable for a split-user interface.
	.TP
	.B \-n\fR, \fB\-\-no\-dns
Use this option to force	Use this option to force
.B mtr	.B mtr
to display numeric IP numbers and not try to resolve the	to display numeric IP numbers and not try to resolve the
host names.	host names.

.TP	.TP
.B \-b	.B \-b\fR, \fB\-\-show\-ips
.TP
.B \-\-show-ips
.br
Use this option to tell	Use this option to tell
.B mtr	.B mtr
to display both the host names and numeric IP numbers. In split mode	to display both the host names and numeric IP numbers. In split mode
this adds an extra field to the output. In report mode, there is usually	this adds an extra field to the output. In report mode, there is usually
too little space to add the IPs, and they will be truncated. Use the	too little space to add the IPs, and they will be truncated. Use the
wide report (-w) mode to see the IPs in report mode.	wide report (-w) mode to see the IPs in report mode.

.TP	.TP
.B \-o\ fields\ order	.B \-o \fIFIELDS\fR, \fB\-\-order \fIFIELDS
.TP	Use this option to specify which fields to display and in which order.
.B \-\-order\ fields\ order	You may use one or more space characters to separate fields.
.br	.br
Use this option to specify the fields and their order when loading mtr.
.br
Available fields:	Available fields:
.TS	.TS
center allbox tab(%);	center allbox tab(%);
Line 241 I%Interarrival Jitter	Line 241 I%Interarrival Jitter
.br	.br

Example:	Example:
-o "LSD NBAW"	-o "LSD NBAW X"
.TP	.TP
.B \-g	.B \-y \fIn\fR, \fB\-\-ipinfo \fIn
	MISSING
.TP	.TP
.B \-\-gtk	.B \-z\fR, \fB\-\-aslookup
.br	MISSING
Use this option to force
.B mtr
to use the GTK+ based X11 window interface (if available).
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/
for more information about GTK+.

.TP	.TP
.B \-p	.B \-i \fISECONDS\fR, \fB\-\-interval \fISECONDS
	Use this option to specify the positive number of seconds between ICMP
	ECHO requests. The default value for this parameter is one second. The
	root user may choose values between zero and one.
.TP	.TP
.B \-\-split	.B \-c \fICOUNT\fR, \fB\-\-report\-cycles \fICOUNT
.br	Use this option to set the number of pings sent to determine
Use this option to set	both the machines on the network and the reliability of
.B mtr	those machines. Each cycle lasts one second.
to spit out a format that is suitable for a split-user interface.	.TP
	.B \-s \fIPACKETSIZE\fR, \fB\-\-psize \fIPACKETSIZE
	This option sets the packet size used for probing. It is in bytes,
	inclusive IP and ICMP headers.

	If set to a negative number, every iteration will use a different, random
	packet size up to that number.
.TP	.TP
.B \-l	.B \-B \fINUM\fR, \fB\-\-bitpattern \fINUM
	Specifies bit pattern to use in payload. Should be within range 0 - 255. If
	.I NUM
	is greater than 255, a random pattern is used.
.TP	.TP
.B \-\-raw	.B \-Q \fINUM\fR, \fB\-\-tos \fINUM
.br	Specifies value for type of service field in IP header. Should be within range 0
	- 255.
	.TP
	.B \-e\fR, \fB\-\-mpls
Use this option to tell	Use this option to tell
.B mtr	.B mtr
to use the raw output format. This format is better suited for	to display information from ICMP extensions for MPLS (RFC 4950)
archival of the measurement results. It could be parsed to	that are encoded in the response packets.
be presented into any of the other display methods.

.TP	.TP
.B \-a\ IP.ADD.RE.SS	.B \-a \fIADDRESS\fR, \fB\-\-address \fIADDRESS
	Use this option to bind the outgoing socket to
	.IR ADDRESS ,
	so that all packets will be sent with
	.I ADDRESS
	as source address. NOTE that this option doesn't apply to DNS requests
	(which could be and could not be what you want).
.TP	.TP
.B \-\-address\ IP.ADD.RE.SS	.B \-f \fINUM\fR, \fB\-\-first-ttl \fINUM
.br	Specifies with what TTL to start. Defaults to 1.
Use this option to bind outgoing packets' socket to specific interface,
so that any packet will be sent through this interface. NOTE that this
option doesn't apply to DNS requests (which could be and could not be
what you want).

.TP	.TP
.B \-i\ SECONDS	.B \-m \fINUM\fR, \fB\-\-max-ttl \fINUM
	Specifies the maximum number of hops (max time-to-live value) traceroute will
	probe. Default is 30.
.TP	.TP
.B \-\-interval\ SECONDS	.B \-u\fR, \fB\-\-udp
.br
Use this option to specify the positive number of seconds between ICMP
ECHO requests. The default value for this parameter is one second.

.TP
.B \-u
.br
Use UDP datagrams instead of ICMP ECHO.	Use UDP datagrams instead of ICMP ECHO.

.TP	.TP
.B \-T	.B \-T\fR, \fB\-\-tcp
	Use TCP SYN packets instead of ICMP ECHO.
	.I PACKETSIZE
	is ignored, since SYN packets can not contain data.
.TP	.TP
.B \-\-tcp	.B \-P \fIPORT\fR, \fB\-\-port \fIPORT
.br
Use TCP SYN packets instead of ICMP ECHO. PACKETSIZE is ignored, since
SYN packets can not contain data.

.TP
.B \-P\ PORT
.TP
.B \-\-port\ PORT
.br
The target port number for TCP traces.	The target port number for TCP traces.

.TP	.TP
.B \-\-timeout\ SECONDS	.B \-Z \fISECONDS\fR, \fB\-\-timeout \fISECONDS
.br
The number of seconds to keep the TCP socket open before giving up on	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	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	for this, especially combined with a short interval, will use up a lot
of file descriptors.	of file descriptors.

.TP	.TP
.B \-4	.B \-M \fIMARK\fR, \fB\-\-mark \fIMARK
.br	MISSING
Use IPv4 only.	.SH ENVIRONMENT
	.B mtr
	recognizes a few environment variables.
.TP	.TP
.B \-6	.B MTR_OPTIONS
.br	This environment variable allows to specify options, as if they were
Use IPv6 only.	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.

.SH BUGS	Example:

	.BI MTR_OPTIONS ="-4\ -c\ 1"
	.B mtr
	.I \-6\ localhost

	would send one probe (because of
	.I -c\ 1\c
	) towards
	.B ::1
	(because of
	.IR -6 ,
	which overrides the
	.I -4
	passed in
	.B MTR_OPTIONS\c
	).
	.TP
	.B DISPLAY
	Used for the GTK+ frontend.
	.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
routers reported by	routers reported by
.B mtr	.B mtr
will be significantly lower than the actual reliability of	will be significantly lower than the actual reliability of
these routers.	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/ .	.BR http://www.bitwizard.nl/mtr/ .

.PP	.PP
The mtr mailinglist was little used and is no longer active.	The mtr mailinglist was little used and is no longer active.

.PP	.PP
Bug reports and feature requests should be submitted to the	For patches, bug reports, or feature requests, please open an issue on
launchpad mtr bugtracker.	GitHub at:
	.BR https://github.com/traviscross/mtr .
.SH "SEE ALSO"	.SH "SEE ALSO"

traceroute(8),	traceroute(8),
ping(8)	ping(8)
TCP/IP Illustrated (Stevens, ISBN 0201633469).	TCP/IP Illustrated (Stevens, ISBN 0201633469).

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

Removed from v.1.1.1.1
changed lines
	Added in v.1.1.1.2