1 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software |
1 Installation Instructions |
2 Foundation, Inc. |
2 ========================= |
3 |
3 |
4 This file is free documentation; the Free Software Foundation gives |
4 Since you are reading this I assume you already obtained one of the release |
5 unlimited permission to copy, distribute and modify it. |
5 tarballs and successfully extracted it. The latest version of LEMON is |
|
6 available at our webpage (http://lemon.cs.elte.hu/). |
6 |
7 |
7 Basic Installation |
8 In order to install LEMON from the extracted source tarball you have to |
8 ================== |
9 issue the following commands: |
9 |
10 |
10 These are generic installation instructions. |
11 1. `cd lemon-x.y.z' |
11 |
12 |
12 The `configure' shell script attempts to guess correct values for |
13 This changes to the directory which was created when you extracted the |
13 various system-dependent variables used during compilation. It uses |
14 sources. The x.y.z part is a version number. |
14 those values to create a `Makefile' in each directory of the package. |
|
15 It may also create one or more `.h' files containing system-dependent |
|
16 definitions. Finally, it creates a shell script `config.status' that |
|
17 you can run in the future to recreate the current configuration, and a |
|
18 file `config.log' containing compiler output (useful mainly for |
|
19 debugging `configure'). |
|
20 |
15 |
21 It can also use an optional file (typically called `config.cache' |
16 2. `./configure' |
22 and enabled with `--cache-file=config.cache' or simply `-C') that saves |
|
23 the results of its tests to speed up reconfiguring. (Caching is |
|
24 disabled by default to prevent problems with accidental use of stale |
|
25 cache files.) |
|
26 |
17 |
27 If you need to do unusual things to compile the package, please try |
18 This runs the configure shell script, which does some checks and |
28 to figure out how `configure' could check whether to do them, and mail |
19 configuration (creates makefiles etc). |
29 diffs or instructions to the address given in the `README' so they can |
|
30 be considered for the next release. If you are using the cache, and at |
|
31 some point `config.cache' contains results you don't want to keep, you |
|
32 may remove or edit it. |
|
33 |
20 |
34 The file `configure.ac' (or `configure.in') is used to create |
21 3. `make' |
35 `configure' by a program called `autoconf'. You only need |
|
36 `configure.ac' if you want to change it or regenerate `configure' using |
|
37 a newer version of `autoconf'. |
|
38 |
22 |
39 The simplest way to compile this package is: |
23 This command compiles the non-template part of LEMON into libemon.a file. |
|
24 It also compiles the benchmark and demo programs when enabled. |
40 |
25 |
41 1. `cd' to the directory containing the package's source code and type |
26 4. `make check' |
42 `./configure' to configure the package for your system. If you're |
|
43 using `csh' on an old version of System V, you might need to type |
|
44 `sh ./configure' instead to prevent `csh' from trying to execute |
|
45 `configure' itself. |
|
46 |
27 |
47 Running `configure' takes awhile. While running, it prints some |
28 This step is optional, but recommended. It runs the test programs that we |
48 messages telling which features it is checking for. |
29 developed for LEMON to check whether the library works properly on your |
|
30 platform. |
49 |
31 |
50 2. Type `make' to compile the package. |
32 5. `make install' |
51 |
33 |
52 3. Optionally, type `make check' to run any self-tests that come with |
34 This command installs LEMON under /usr/local (you will need root |
53 the package. |
35 privileges to be able to do that). If you want to install it to some |
|
36 other location, then pass the --prefix=DIRECTORY flag to configure in |
|
37 step 1. For example: `./configure --prefix=/home/username/lemon' |
54 |
38 |
55 4. Type `make install' to install the programs and any data files and |
|
56 documentation. |
|
57 |
39 |
58 5. You can remove the program binaries and object files from the |
40 Configure Flags |
59 source code directory by typing `make clean'. To also remove the |
41 =============== |
60 files that `configure' created (so you can compile the package for |
|
61 a different kind of computer), type `make distclean'. There is |
|
62 also a `make maintainer-clean' target, but that is intended mainly |
|
63 for the package's developers. If you use it, you may have to get |
|
64 all sorts of other programs in order to regenerate files that came |
|
65 with the distribution. |
|
66 |
42 |
67 Compilers and Options |
43 You can pass the following flags to configure in step 1 (see ./configure |
68 ===================== |
44 --help for more): |
69 |
45 |
70 Some systems require unusual options for compilation or linking that |
46 --with-glpk[=PREFIX] |
71 the `configure' script does not know about. Run `./configure --help' |
|
72 for details on some of the pertinent environment variables. |
|
73 |
47 |
74 You can give `configure' initial values for configuration parameters |
48 Enable GLPK support (default). You should specify the prefix too if you |
75 by setting variables in the command line or in the environment. Here |
49 installed GLPK to some non-standard location (e.g. your home directory). If it |
76 is an example: |
50 is not found, GLPK support will be disabled. |
77 |
51 |
78 ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix |
52 --with-glpk-includedir=DIR |
79 |
53 |
80 *Note Defining Variables::, for more details. |
54 The directory where the GLPK header files are located. This is only useful |
|
55 when the GLPK headers and libraries are not under the same prefix (which is |
|
56 unlikely). |
81 |
57 |
82 Compiling For Multiple Architectures |
58 --with-glpk-libdir=DIR |
83 ==================================== |
|
84 |
59 |
85 You can compile the package for more than one kind of computer at the |
60 The directory where the GLPK libraries are located. This is only useful |
86 same time, by placing the object files for each architecture in their |
61 when the GLPK headers and libraries are not under the same prefix (which is |
87 own directory. To do this, you must use a version of `make' that |
62 unlikely). |
88 supports the `VPATH' variable, such as GNU `make'. `cd' to the |
|
89 directory where you want the object files and executables to go and run |
|
90 the `configure' script. `configure' automatically checks for the |
|
91 source code in the directory that `configure' is in and in `..'. |
|
92 |
63 |
93 If you have to use a `make' that does not support the `VPATH' |
64 --without-glpk |
94 variable, you have to compile the package for one architecture at a |
|
95 time in the source code directory. After you have installed the |
|
96 package for one architecture, use `make distclean' before reconfiguring |
|
97 for another architecture. |
|
98 |
65 |
99 Installation Names |
66 Disable GLPK support. |
100 ================== |
|
101 |
67 |
102 By default, `make install' will install the package's files in |
68 --with-cplex[=PREFIX] |
103 `/usr/local/bin', `/usr/local/man', etc. You can specify an |
|
104 installation prefix other than `/usr/local' by giving `configure' the |
|
105 option `--prefix=PATH'. |
|
106 |
69 |
107 You can specify separate installation prefixes for |
70 Enable CPLEX support (default). You should specify the prefix too if you |
108 architecture-specific files and architecture-independent files. If you |
71 installed CPLEX to some non-standard location (e.g. /opt/ilog/cplex75). If it |
109 give `configure' the option `--exec-prefix=PATH', the package will use |
72 is not found, CPLEX support will be disabled. |
110 PATH as the prefix for installing programs and libraries. |
|
111 Documentation and other data files will still use the regular prefix. |
|
112 |
73 |
113 In addition, if you use an unusual directory layout you can give |
74 --with-cplex-includedir=DIR |
114 options like `--bindir=PATH' to specify different values for particular |
|
115 kinds of files. Run `configure --help' for a list of the directories |
|
116 you can set and what kinds of files go in them. |
|
117 |
75 |
118 If the package supports it, you can cause programs to be installed |
76 The directory where the CPLEX header files are located. This is only useful |
119 with an extra prefix or suffix on their names by giving `configure' the |
77 when the CPLEX headers and libraries are not under the same prefix (e.g. |
120 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. |
78 /usr/local/cplex/cplex75/include). |
121 |
79 |
122 Optional Features |
80 --with-cplex-libdir=DIR |
123 ================= |
|
124 |
81 |
125 Some packages pay attention to `--enable-FEATURE' options to |
82 The directory where the CPLEX libraries are located. This is only useful |
126 `configure', where FEATURE indicates an optional part of the package. |
83 when the CPLEX headers and libraries are not under the same prefix (e.g. |
127 They may also pay attention to `--with-PACKAGE' options, where PACKAGE |
84 /usr/local/cplex/cplex75/lib/i86_linux2_glibc2.2_gcc3.0/static_pic_mt). |
128 is something like `gnu-as' or `x' (for the X Window System). The |
|
129 `README' should mention any `--enable-' and `--with-' options that the |
|
130 package recognizes. |
|
131 |
85 |
132 For packages that use the X Window System, `configure' can usually |
86 --without-cplex |
133 find the X include and library files automatically, but if it doesn't, |
|
134 you can use the `configure' options `--x-includes=DIR' and |
|
135 `--x-libraries=DIR' to specify their locations. |
|
136 |
87 |
137 Specifying the System Type |
88 Disable CPLEX support. |
138 ========================== |
|
139 |
89 |
140 There may be some features `configure' cannot figure out |
90 --enable-demo |
141 automatically, but needs to determine by the type of machine the package |
|
142 will run on. Usually, assuming the package is built to be run on the |
|
143 _same_ architectures, `configure' can figure that out, but if it prints |
|
144 a message saying it cannot guess the machine type, give it the |
|
145 `--build=TYPE' option. TYPE can either be a short name for the system |
|
146 type, such as `sun4', or a canonical name which has the form: |
|
147 |
91 |
148 CPU-COMPANY-SYSTEM |
92 Build the demo programs too. |
149 |
93 |
150 where SYSTEM can have one of these forms: |
94 --disable-demo |
151 |
95 |
152 OS KERNEL-OS |
96 Do not build the demo programs (default). |
153 |
97 |
154 See the file `config.sub' for the possible values of each field. If |
98 --enable-benchmark |
155 `config.sub' isn't included in this package, then this package doesn't |
|
156 need to know the machine type. |
|
157 |
99 |
158 If you are _building_ compiler tools for cross-compiling, you should |
100 Build the benchmark programs too. |
159 use the `--target=TYPE' option to select the type of system they will |
|
160 produce code for. |
|
161 |
101 |
162 If you want to _use_ a cross compiler, that generates code for a |
102 --disable-benchmark |
163 platform different from the build platform, you should specify the |
|
164 "host" platform (i.e., that on which the generated programs will |
|
165 eventually be run) with `--host=TYPE'. |
|
166 |
103 |
167 Sharing Defaults |
104 Do not build the benchmark programs (default). |
168 ================ |
|
169 |
|
170 If you want to set default values for `configure' scripts to share, |
|
171 you can create a site shell script called `config.site' that gives |
|
172 default values for variables like `CC', `cache_file', and `prefix'. |
|
173 `configure' looks for `PREFIX/share/config.site' if it exists, then |
|
174 `PREFIX/etc/config.site' if it exists. Or, you can set the |
|
175 `CONFIG_SITE' environment variable to the location of the site script. |
|
176 A warning: not all `configure' scripts look for a site script. |
|
177 |
|
178 Defining Variables |
|
179 ================== |
|
180 |
|
181 Variables not defined in a site shell script can be set in the |
|
182 environment passed to `configure'. However, some packages may run |
|
183 configure again during the build, and the customized values of these |
|
184 variables may be lost. In order to avoid this problem, you should set |
|
185 them in the `configure' command line, using `VAR=value'. For example: |
|
186 |
|
187 ./configure CC=/usr/local2/bin/gcc |
|
188 |
|
189 will cause the specified gcc to be used as the C compiler (unless it is |
|
190 overridden in the site shell script). |
|
191 |
|
192 `configure' Invocation |
|
193 ====================== |
|
194 |
|
195 `configure' recognizes the following options to control how it |
|
196 operates. |
|
197 |
|
198 `--help' |
|
199 `-h' |
|
200 Print a summary of the options to `configure', and exit. |
|
201 |
|
202 `--version' |
|
203 `-V' |
|
204 Print the version of Autoconf used to generate the `configure' |
|
205 script, and exit. |
|
206 |
|
207 `--cache-file=FILE' |
|
208 Enable the cache: use and save the results of the tests in FILE, |
|
209 traditionally `config.cache'. FILE defaults to `/dev/null' to |
|
210 disable caching. |
|
211 |
|
212 `--config-cache' |
|
213 `-C' |
|
214 Alias for `--cache-file=config.cache'. |
|
215 |
|
216 `--quiet' |
|
217 `--silent' |
|
218 `-q' |
|
219 Do not print messages saying which checks are being made. To |
|
220 suppress all normal output, redirect it to `/dev/null' (any error |
|
221 messages will still be shown). |
|
222 |
|
223 `--srcdir=DIR' |
|
224 Look for the package's source code in directory DIR. Usually |
|
225 `configure' can determine that directory automatically. |
|
226 |
|
227 `configure' also accepts some other, not widely useful, options. Run |
|
228 `configure --help' for more details. |
|
229 |
|