INSTALL
author Peter Kovacs <kpeter@inf.elte.hu>
Wed, 08 Oct 2008 13:40:20 +0200
changeset 301 9db8964f0cf6
parent 5 233b4094ceae
child 318 1e2d6ca80793
permissions -rw-r--r--
Fix several doxygen warings
     1 Installation Instructions
     2 =========================
     3 
     4    Since you are reading this I assume you already obtained one of the release
     5 tarballs and successfully extracted it. The latest version of LEMON is
     6 available at our web page (http://lemon.cs.elte.hu/).
     7 
     8    In order to install LEMON from the extracted source tarball you have to
     9 issue the following commands:
    10 
    11    1. `cd lemon-x.y.z'
    12 
    13       This command changes to the directory which was created when you
    14       extracted the sources. The x.y.z part is a version number.
    15 
    16    2. `./configure'
    17 
    18       This command runs the configure shell script, which does some checks and
    19       creates the makefiles.
    20 
    21    3. `make'
    22 
    23       This command compiles the non-template part of LEMON into libemon.a
    24       file. It also compiles the programs in the tools, benchmark and demo
    25       subdirectories when enabled.
    26 
    27    4. `make check'
    28 
    29       This step is optional, but recommended. It runs the test programs that
    30       we developed for LEMON to check whether the library works properly on
    31       your platform.
    32 
    33    5. `make install'
    34 
    35       This command installs LEMON under /usr/local (you will need root
    36       privileges to be able to do that). If you want to install it to some
    37       other location, then pass the --prefix=DIRECTORY flag to configure in
    38       step 2. For example: `./configure --prefix=/home/username/lemon'.
    39 
    40    6. `make install-html'
    41 
    42       This command installs the documentation under share/doc/lemon/docs. The
    43       generated documentation is included in the tarball. If you want to
    44       generate it yourself, then run `make html'. Note that for this you need
    45       to have the following programs installed: Doxygen, Graphviz, Ghostscript,
    46       Latex.
    47 
    48 
    49 Configure Options and Variables
    50 ===============================
    51 
    52    In step 2 you can customize the actions of configure by setting variables
    53 and passing options to it. This can be done like this:
    54 `./configure [OPTION]... [VARIABLE=VALUE]...'
    55 
    56    Below you will find some useful variables and options (see
    57 `./configure --help' for more):
    58 
    59 CXX='comp'
    60 
    61   Change the C++ compiler to 'comp'.
    62 
    63 CXXFLAGS='flags'
    64 
    65   Pass the 'flags' to the compiler. For example CXXFLAGS='-O3 -march=pentium-m'
    66   turns on generation of aggressively optimized Pentium-M specific code.
    67 
    68 --prefix=PREFIX
    69 
    70   Set the installation prefix to PREFIX. By default it is /usr/local.
    71 
    72 --enable-demo
    73 
    74    Build the examples in the demo subdirectory.
    75 
    76 --disable-demo
    77 
    78    Do not build the examples in the demo subdirectory (default).
    79 
    80 --enable-benchmark
    81 
    82    Build the programs in the benchmark subdirectory.
    83 
    84 --disable-benchmark
    85 
    86    Do not build the programs in the benchmark subdirectory (default).
    87 
    88 --enable-tools
    89 
    90    Build the programs in the tools subdirectory (default).
    91 
    92 --disable-tools
    93 
    94    Do not build the programs in the tools subdirectory.
    95 
    96 --with-glpk[=PREFIX]
    97 
    98    Enable GLPK support (default). You should specify the prefix too if
    99    you installed GLPK to some non-standard location (e.g. your home
   100    directory). If it is not found, GLPK support will be disabled.
   101 
   102 --with-glpk-includedir=DIR
   103 
   104    The directory where the GLPK header files are located. This is only
   105    useful when the GLPK headers and libraries are not under the same
   106    prefix (which is unlikely).
   107 
   108 --with-glpk-libdir=DIR
   109 
   110    The directory where the GLPK libraries are located. This is only
   111    useful when the GLPK headers and libraries are not under the same
   112    prefix (which is unlikely).
   113 
   114 --without-glpk
   115 
   116    Disable GLPK support.
   117 
   118 --with-cplex[=PREFIX]
   119 
   120    Enable CPLEX support (default). You should specify the prefix too
   121    if you installed CPLEX to some non-standard location
   122    (e.g. /opt/ilog/cplex75). If it is not found, CPLEX support will be
   123    disabled.
   124 
   125 --with-cplex-includedir=DIR
   126 
   127    The directory where the CPLEX header files are located. This is
   128    only useful when the CPLEX headers and libraries are not under the
   129    same prefix (e.g.  /usr/local/cplex/cplex75/include).
   130 
   131 --with-cplex-libdir=DIR
   132 
   133    The directory where the CPLEX libraries are located. This is only
   134    useful when the CPLEX headers and libraries are not under the same
   135    prefix (e.g.
   136    /usr/local/cplex/cplex75/lib/i86_linux2_glibc2.2_gcc3.0/static_pic_mt).
   137 
   138 --without-cplex
   139 
   140    Disable CPLEX support.
   141 
   142 --with-soplex[=PREFIX]
   143 
   144    Enable SoPlex support (default). You should specify the prefix too if
   145    you installed SoPlex to some non-standard location (e.g. your home
   146    directory). If it is not found, SoPlex support will be disabled.
   147 
   148 --with-soplex-includedir=DIR
   149 
   150    The directory where the SoPlex header files are located. This is only
   151    useful when the SoPlex headers and libraries are not under the same
   152    prefix (which is unlikely).
   153 
   154 --with-soplex-libdir=DIR
   155 
   156    The directory where the SoPlex libraries are located. This is only
   157    useful when the SoPlex headers and libraries are not under the same
   158    prefix (which is unlikely).
   159 
   160 --without-soplex
   161 
   162    Disable SoPlex support.