Return to README CVS log

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

Annotation of embedaddon/mtr/README, revision 1.1.1.3

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