File:  [ELWIX - Embedded LightWeight unIX -] / embedaddon / mtr / README.md
Revision 1.1.1.2 (vendor branch): download - view: text, annotated - select for diffs - revision graph
Wed Sep 27 11:18:58 2023 UTC (9 months ago) by misho
Branches: mtr, MAIN
CVS tags: v0_95, HEAD
Version 0.95

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

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