alpar@5: Installation Instructions
alpar@5: =========================
alpar@5: 
kpeter@318: Since you are reading this I assume you already obtained one of the release
alpar@5: tarballs and successfully extracted it. The latest version of LEMON is
ladanyi@245: available at our web page (http://lemon.cs.elte.hu/).
alpar@5: 
kpeter@493: LEMON provides two different build environments, one is based on "autotool",
kpeter@493: while the other is based on "cmake". This file contains instructions only for
kpeter@493: the former one, which is the recommended build environment on Linux, Mac OSX
kpeter@493: and other unices or if you use Cygwin on Windows. For cmake installation
kpeter@493: instructions visit http://lemon.cs.elte.hu.
kpeter@493: 
kpeter@318: In order to install LEMON from the extracted source tarball you have to
alpar@5: issue the following commands:
alpar@5: 
ladanyi@245:    1. `cd lemon-x.y.z'
alpar@5: 
ladanyi@245:       This command changes to the directory which was created when you
ladanyi@245:       extracted the sources. The x.y.z part is a version number.
alpar@5: 
ladanyi@245:    2. `./configure'
alpar@5: 
ladanyi@245:       This command runs the configure shell script, which does some checks and
ladanyi@245:       creates the makefiles.
alpar@5: 
ladanyi@245:    3. `make'
alpar@5: 
ladanyi@245:       This command compiles the non-template part of LEMON into libemon.a
ladanyi@564:       file. It also compiles the programs in the tools subdirectory by
ladanyi@564:       default.
alpar@5: 
ladanyi@245:    4. `make check'
alpar@5: 
ladanyi@245:       This step is optional, but recommended. It runs the test programs that
ladanyi@245:       we developed for LEMON to check whether the library works properly on
ladanyi@245:       your platform.
alpar@5: 
ladanyi@245:    5. `make install'
alpar@5: 
ladanyi@245:       This command installs LEMON under /usr/local (you will need root
ladanyi@245:       privileges to be able to do that). If you want to install it to some
ladanyi@245:       other location, then pass the --prefix=DIRECTORY flag to configure in
ladanyi@245:       step 2. For example: `./configure --prefix=/home/username/lemon'.
alpar@5: 
ladanyi@245:    6. `make install-html'
alpar@5: 
ladanyi@245:       This command installs the documentation under share/doc/lemon/docs. The
ladanyi@245:       generated documentation is included in the tarball. If you want to
ladanyi@245:       generate it yourself, then run `make html'. Note that for this you need
ladanyi@245:       to have the following programs installed: Doxygen, Graphviz, Ghostscript,
ladanyi@245:       Latex.
alpar@5: 
alpar@5: 
ladanyi@245: Configure Options and Variables
ladanyi@245: ===============================
ladanyi@245: 
kpeter@318: In step 2 you can customize the actions of configure by setting variables
ladanyi@245: and passing options to it. This can be done like this:
ladanyi@245: `./configure [OPTION]... [VARIABLE=VALUE]...'
ladanyi@245: 
kpeter@318: Below you will find some useful variables and options (see `./configure --help'
kpeter@318: for more):
ladanyi@245: 
ladanyi@245: CXX='comp'
alpar@5: 
alpar@5:   Change the C++ compiler to 'comp'.
alpar@5: 
alpar@5: CXXFLAGS='flags'
alpar@5: 
ladanyi@245:   Pass the 'flags' to the compiler. For example CXXFLAGS='-O3 -march=pentium-m'
ladanyi@245:   turns on generation of aggressively optimized Pentium-M specific code.
ladanyi@245: 
ladanyi@245: --prefix=PREFIX
ladanyi@245: 
ladanyi@245:   Set the installation prefix to PREFIX. By default it is /usr/local.
alpar@5: 
ladanyi@245: --enable-tools
ladanyi@245: 
ladanyi@245:    Build the programs in the tools subdirectory (default).
ladanyi@245: 
ladanyi@245: --disable-tools
ladanyi@245: 
ladanyi@245:    Do not build the programs in the tools subdirectory.
alpar@5: 
alpar@5: --with-glpk[=PREFIX]
alpar@5: 
alpar@5:    Enable GLPK support (default). You should specify the prefix too if
alpar@5:    you installed GLPK to some non-standard location (e.g. your home
alpar@5:    directory). If it is not found, GLPK support will be disabled.
alpar@5: 
alpar@5: --with-glpk-includedir=DIR
alpar@5: 
alpar@5:    The directory where the GLPK header files are located. This is only
alpar@5:    useful when the GLPK headers and libraries are not under the same
alpar@5:    prefix (which is unlikely).
alpar@5: 
alpar@5: --with-glpk-libdir=DIR
alpar@5: 
alpar@5:    The directory where the GLPK libraries are located. This is only
alpar@5:    useful when the GLPK headers and libraries are not under the same
alpar@5:    prefix (which is unlikely).
alpar@5: 
alpar@5: --without-glpk
alpar@5: 
alpar@5:    Disable GLPK support.
alpar@5: 
alpar@5: --with-cplex[=PREFIX]
alpar@5: 
alpar@5:    Enable CPLEX support (default). You should specify the prefix too
alpar@5:    if you installed CPLEX to some non-standard location
alpar@5:    (e.g. /opt/ilog/cplex75). If it is not found, CPLEX support will be
alpar@5:    disabled.
alpar@5: 
alpar@5: --with-cplex-includedir=DIR
alpar@5: 
alpar@5:    The directory where the CPLEX header files are located. This is
alpar@5:    only useful when the CPLEX headers and libraries are not under the
alpar@5:    same prefix (e.g.  /usr/local/cplex/cplex75/include).
alpar@5: 
alpar@5: --with-cplex-libdir=DIR
alpar@5: 
alpar@5:    The directory where the CPLEX libraries are located. This is only
alpar@5:    useful when the CPLEX headers and libraries are not under the same
alpar@5:    prefix (e.g.
alpar@5:    /usr/local/cplex/cplex75/lib/i86_linux2_glibc2.2_gcc3.0/static_pic_mt).
alpar@5: 
alpar@5: --without-cplex
alpar@5: 
alpar@5:    Disable CPLEX support.
ladanyi@245: 
ladanyi@245: --with-soplex[=PREFIX]
ladanyi@245: 
ladanyi@245:    Enable SoPlex support (default). You should specify the prefix too if
ladanyi@245:    you installed SoPlex to some non-standard location (e.g. your home
ladanyi@245:    directory). If it is not found, SoPlex support will be disabled.
ladanyi@245: 
ladanyi@245: --with-soplex-includedir=DIR
ladanyi@245: 
ladanyi@245:    The directory where the SoPlex header files are located. This is only
ladanyi@245:    useful when the SoPlex headers and libraries are not under the same
ladanyi@245:    prefix (which is unlikely).
ladanyi@245: 
ladanyi@245: --with-soplex-libdir=DIR
ladanyi@245: 
ladanyi@245:    The directory where the SoPlex libraries are located. This is only
ladanyi@245:    useful when the SoPlex headers and libraries are not under the same
ladanyi@245:    prefix (which is unlikely).
ladanyi@245: 
ladanyi@245: --without-soplex
ladanyi@245: 
ladanyi@245:    Disable SoPlex support.