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