INSTALL
changeset 245 da1d220b176b
parent 5 233b4094ceae
child 325 1e2d6ca80793
     1.1 --- a/INSTALL	Tue Jul 29 15:06:37 2008 +0200
     1.2 +++ b/INSTALL	Wed Jul 30 12:07:29 2008 +0100
     1.3 @@ -3,72 +3,95 @@
     1.4  
     1.5     Since you are reading this I assume you already obtained one of the release
     1.6  tarballs and successfully extracted it. The latest version of LEMON is
     1.7 -available at our webpage (http://lemon.cs.elte.hu/).
     1.8 +available at our web page (http://lemon.cs.elte.hu/).
     1.9  
    1.10     In order to install LEMON from the extracted source tarball you have to
    1.11  issue the following commands:
    1.12  
    1.13 -  1. `cd lemon-x.y.z'
    1.14 +   1. `cd lemon-x.y.z'
    1.15  
    1.16 -     This changes to the directory which was created when you extracted the
    1.17 -     sources. The x.y.z part is a version number.
    1.18 +      This command changes to the directory which was created when you
    1.19 +      extracted the sources. The x.y.z part is a version number.
    1.20  
    1.21 -  2. `./configure'
    1.22 +   2. `./configure'
    1.23  
    1.24 -     This runs the configure shell script, which does some checks and
    1.25 -     configuration (creates makefiles etc).
    1.26 +      This command runs the configure shell script, which does some checks and
    1.27 +      creates the makefiles.
    1.28  
    1.29 -  3. `make'
    1.30 +   3. `make'
    1.31  
    1.32 -     This command compiles the non-template part of LEMON into libemon.a file.
    1.33 -     It also compiles the benchmark and demo programs when enabled.
    1.34 +      This command compiles the non-template part of LEMON into libemon.a
    1.35 +      file. It also compiles the programs in the tools, benchmark and demo
    1.36 +      subdirectories when enabled.
    1.37  
    1.38 -  4. `make check'
    1.39 +   4. `make check'
    1.40  
    1.41 -     This step is optional, but recommended. It runs the test programs that we
    1.42 -     developed for LEMON to check whether the library works properly on your
    1.43 -     platform.
    1.44 +      This step is optional, but recommended. It runs the test programs that
    1.45 +      we developed for LEMON to check whether the library works properly on
    1.46 +      your platform.
    1.47  
    1.48 -  5. `make install'
    1.49 +   5. `make install'
    1.50  
    1.51 -     This command installs LEMON under /usr/local (you will need root
    1.52 -     privileges to be able to do that). If you want to install it to some
    1.53 -     other location, then pass the --prefix=DIRECTORY flag to configure in
    1.54 -     step 1. For example: `./configure --prefix=/home/username/lemon'
    1.55 +      This command installs LEMON under /usr/local (you will need root
    1.56 +      privileges to be able to do that). If you want to install it to some
    1.57 +      other location, then pass the --prefix=DIRECTORY flag to configure in
    1.58 +      step 2. For example: `./configure --prefix=/home/username/lemon'.
    1.59  
    1.60 +   6. `make install-html'
    1.61  
    1.62 -Configure Flags
    1.63 -===============
    1.64 +      This command installs the documentation under share/doc/lemon/docs. The
    1.65 +      generated documentation is included in the tarball. If you want to
    1.66 +      generate it yourself, then run `make html'. Note that for this you need
    1.67 +      to have the following programs installed: Doxygen, Graphviz, Ghostscript,
    1.68 +      Latex.
    1.69  
    1.70 -   You can pass the following flags to configure in step 1
    1.71 -(see ./configure --help for more):
    1.72  
    1.73 -CXX=comp
    1.74 +Configure Options and Variables
    1.75 +===============================
    1.76 +
    1.77 +   In step 2 you can customize the actions of configure by setting variables
    1.78 +and passing options to it. This can be done like this:
    1.79 +`./configure [OPTION]... [VARIABLE=VALUE]...'
    1.80 +
    1.81 +   Below you will find some useful variables and options (see
    1.82 +`./configure --help' for more):
    1.83 +
    1.84 +CXX='comp'
    1.85  
    1.86    Change the C++ compiler to 'comp'.
    1.87  
    1.88  CXXFLAGS='flags'
    1.89  
    1.90 -  Pass the 'flags' to the compiler. For example
    1.91 -  CXXFLAGS='-O3 -march=pentium-m'
    1.92 -  turns  on generation of aggressively optimized
    1.93 -  Pentium-M specific code.
    1.94 +  Pass the 'flags' to the compiler. For example CXXFLAGS='-O3 -march=pentium-m'
    1.95 +  turns on generation of aggressively optimized Pentium-M specific code.
    1.96 +
    1.97 +--prefix=PREFIX
    1.98 +
    1.99 +  Set the installation prefix to PREFIX. By default it is /usr/local.
   1.100  
   1.101  --enable-demo
   1.102  
   1.103 -   Build the demo programs too.
   1.104 +   Build the examples in the demo subdirectory.
   1.105  
   1.106  --disable-demo
   1.107  
   1.108 -   Do not build the demo programs (default).
   1.109 +   Do not build the examples in the demo subdirectory (default).
   1.110  
   1.111  --enable-benchmark
   1.112  
   1.113 -   Build the benchmark programs too.
   1.114 +   Build the programs in the benchmark subdirectory.
   1.115  
   1.116  --disable-benchmark
   1.117  
   1.118 -   Do not build the benchmark programs (default).
   1.119 +   Do not build the programs in the benchmark subdirectory (default).
   1.120 +
   1.121 +--enable-tools
   1.122 +
   1.123 +   Build the programs in the tools subdirectory (default).
   1.124 +
   1.125 +--disable-tools
   1.126 +
   1.127 +   Do not build the programs in the tools subdirectory.
   1.128  
   1.129  --with-glpk[=PREFIX]
   1.130  
   1.131 @@ -115,3 +138,25 @@
   1.132  --without-cplex
   1.133  
   1.134     Disable CPLEX support.
   1.135 +
   1.136 +--with-soplex[=PREFIX]
   1.137 +
   1.138 +   Enable SoPlex support (default). You should specify the prefix too if
   1.139 +   you installed SoPlex to some non-standard location (e.g. your home
   1.140 +   directory). If it is not found, SoPlex support will be disabled.
   1.141 +
   1.142 +--with-soplex-includedir=DIR
   1.143 +
   1.144 +   The directory where the SoPlex header files are located. This is only
   1.145 +   useful when the SoPlex headers and libraries are not under the same
   1.146 +   prefix (which is unlikely).
   1.147 +
   1.148 +--with-soplex-libdir=DIR
   1.149 +
   1.150 +   The directory where the SoPlex libraries are located. This is only
   1.151 +   useful when the SoPlex headers and libraries are not under the same
   1.152 +   prefix (which is unlikely).
   1.153 +
   1.154 +--without-soplex
   1.155 +
   1.156 +   Disable SoPlex support.