README.md
1WHAT IS MTR?
2===
3
4mtr combines the functionality of the 'traceroute' and 'ping' programs
5in a single network diagnostic tool.
6
7As mtr starts, it investigates the network connection between the host
8mtr runs on and a user-specified destination host. After it
9determines the address of each network hop between the machines,
10it sends a sequence of ICMP ECHO requests to each one to determine the
11quality of the link to each machine. As it does this, it prints
12running statistics about each machine.
13
14mtr is distributed under the GNU General Public License version 2.
15See the COPYING file for details.
16
17INSTALLING
18===
19
20If you're building this from a tarball, compiling mtr is as
21simple as:
22
23 ./configure && make
24
25(in the past, there was a Makefile in the distribution that did
26the `./configure` for you and then ran make again with the generated
27Makefile, but this has suffered some bitrot. It didn't work well
28with git.)
29
30If you're building from the git repository, you'll need to run:
31
32 ./bootstrap.sh && ./configure && make
33
34When it looks as if the compilation was successful, you can
35test mtr with
36
37 sudo ./mtr <host>
38
39(fill in a hostname or IP address where it says <host>) or
40immediately continue on to installing:
41
42 make install
43
44Note that mtr-packet must be suid-root because it requires access to
45raw IP sockets. See SECURITY for security information.
46
47Older versions used to require a non-existent path to GTK for a
48correct build of a non-gtk version while GTK was installed. This is
49no longer necessary. `./configure --without-gtk` should now work.
50If it doesn't, try `make WITHOUT_X11=YES` as the make step.
51
52On Solaris, you'll need to use GNU make to build.
53(Use `gmake` rather than `make`.)
54
55On Solaris (and possibly other systems) the "gtk" library may be
56installed in a directory where the dynamic linker refuses to look when
57a binary is setuid. Roman Shterenzon reports that adding
58 -Wl,-rpath=/usr/lib
59to the commandline will work if you are using gnu LD. He tells me that
60you're out of luck when you use the sun LD. That's not quite true, as
61you can move the gtk libraries to `/usr/lib` instead of leaving them in
62`/usr/local/lib`. (when the ld tells you that `/usr/local/lib` is untrusted
63and `/usr/lib` is trusted, and you trust the gtk libs enough to want them
64in a setuid program, then there is something to say for moving them
65to the "trusted" directory.)
66
67Building on MacOS should not require any special steps.
68
69BUILDING FOR WINDOWS
70===
71
72Building for Windows requires Cygwin. To obtain Cygwin, see
73https://cygwin.com/install.html.
74Next, re-run cygwin's `setup-x86.exe` (or `setup-x86_64.exe` if you're using 64bit cygwin) with the following arguments,
75which will install the packages required for building:
76
77 setup-x86.exe --package-manager --wait --packages automake,pkg-config,make,gcc-core,libncurses-devel
78
79Build as under Unix:
80
81 ./bootstrap.sh && ./configure && make
82
83Finally, install the built binaries:
84
85 make install
86
87
88WHERE CAN I GET THE LATEST VERSION OR MORE INFORMATION?
89===
90
91mtr is now hosted on github.
92https://github.com/traviscross/mtr
93
94See the mtr web page at http://www.BitWizard.nl/mtr/
95
96Bug reports and feature requests should be submitted to the Github bug tracking system.
97
98Patches can be submitted by cloning the Github repository and issuing
99a pull request, or by email to me. Please use unified diffs. Usually
100the diff is sort of messy, so please check that the diff is clean and
101doesn't contain too much of your local stuff (for example, I don't
102want/need the "configure" script that /your/ automake made for you).
103
104(There used to be a mailinglist, but all it got was spam. So
105when the server was upgraded, the mailing list died.)
106
107
108REW
109
110