Debian Codegraph @

INSTALL

raw
1 Installation Instructions
2 *************************
3
4 Copyright (C) 1994-1996, 1999-2002, 2004-2013 Free Software Foundation,
5 Inc.
6
7 Copying and distribution of this file, with or without modification,
8 are permitted in any medium without royalty provided the copyright
9 notice and this notice are preserved. This file is offered as-is,
10 without warranty of any kind.
11
12 Pre-requisites
13 ==============
14 Install autoconf, on Ubuntu:
15
16 sudo apt-get install autoconf
17
18 then install automake, on Ubuntu:
19
20 sudo apt-get install autotools-dev
21 sudo apt-get install automake
22
23 then install libtool, on Ubuntu:
24
25 sudo apt-get install libtool
26
27 Now you can proceed with basic intallation:
28 ./autogen.sh
29 ./configure --prefix=/usr
30 make
31 sudo make install
32
33 Basic Installation
34 ==================
35
36 Briefly, the shell command `./configure && make && make install'
37 should configure, build, and install this package. The following
38 more-detailed instructions are generic; see the `README' file for
39 instructions specific to this package. Some packages provide this
40 `INSTALL' file but do not implement all of the features documented
41 below. The lack of an optional feature in a given package is not
42 necessarily a bug. More recommendations for GNU packages can be found
43 in *note Makefile Conventions: (standards)Makefile Conventions.
44
45 The `configure' shell script attempts to guess correct values for
46 various system-dependent variables used during compilation. It uses
47 those values to create a `Makefile' in each directory of the package.
48 It may also create one or more `.h' files containing system-dependent
49 definitions. Finally, it creates a shell script `config.status' that
50 you can run in the future to recreate the current configuration, and a
51 file `config.log' containing compiler output (useful mainly for
52 debugging `configure').
53
54 It can also use an optional file (typically called `config.cache'
55 and enabled with `--cache-file=config.cache' or simply `-C') that saves
56 the results of its tests to speed up reconfiguring. Caching is
57 disabled by default to prevent problems with accidental use of stale
58 cache files.
59
60 If you need to do unusual things to compile the package, please try
61 to figure out how `configure' could check whether to do them, and mail
62 diffs or instructions to the address given in the `README' so they can
63 be considered for the next release. If you are using the cache, and at
64 some point `config.cache' contains results you don't want to keep, you
65 may remove or edit it.
66
67 The file `configure.ac' (or `configure.in') is used to create
68 `configure' by a program called `autoconf'. You need `configure.ac' if
69 you want to change it or regenerate `configure' using a newer version
70 of `autoconf'.
71
72 The simplest way to compile this package is:
73
74 1. `cd' to the directory containing the package's source code and type
75 `./configure' to configure the package for your system.
76
77 Running `configure' might take a while. While running, it prints
78 some messages telling which features it is checking for.
79
80 2. Type `make' to compile the package.
81
82 3. Optionally, type `make check' to run any self-tests that come with
83 the package, generally using the just-built uninstalled binaries.
84
85 4. Type `make install' to install the programs and any data files and
86 documentation. When installing into a prefix owned by root, it is
87 recommended that the package be configured and built as a regular
88 user, and only the `make install' phase executed with root
89 privileges.
90
91 5. Optionally, type `make installcheck' to repeat any self-tests, but
92 this time using the binaries in their final installed location.
93 This target does not install anything. Running this target as a
94 regular user, particularly if the prior `make install' required
95 root privileges, verifies that the installation completed
96 correctly.
97
98 6. You can remove the program binaries and object files from the
99 source code directory by typing `make clean'. To also remove the
100 files that `configure' created (so you can compile the package for
101 a different kind of computer), type `make distclean'. There is
102 also a `make maintainer-clean' target, but that is intended mainly
103 for the package's developers. If you use it, you may have to get
104 all sorts of other programs in order to regenerate files that came
105 with the distribution.
106
107 7. Often, you can also type `make uninstall' to remove the installed
108 files again. In practice, not all packages have tested that
109 uninstallation works correctly, even though it is required by the
110 GNU Coding Standards.
111
112 8. Some packages, particularly those that use Automake, provide `make
113 distcheck', which can by used by developers to test that all other
114 targets like `make install' and `make uninstall' work correctly.
115 This target is generally not run by end users.
116
117 Compilers and Options
118 =====================
119
120 Some systems require unusual options for compilation or linking that
121 the `configure' script does not know about. Run `./configure --help'
122 for details on some of the pertinent environment variables.
123
124 You can give `configure' initial values for configuration parameters
125 by setting variables in the command line or in the environment. Here
126 is an example:
127
128 ./configure CC=c99 CFLAGS=-g LIBS=-lposix
129
130 *Note Defining Variables::, for more details.
131
132 Compiling For Multiple Architectures
133 ====================================
134
135 You can compile the package for more than one kind of computer at the
136 same time, by placing the object files for each architecture in their
137 own directory. To do this, you can use GNU `make'. `cd' to the
138 directory where you want the object files and executables to go and run
139 the `configure' script. `configure' automatically checks for the
140 source code in the directory that `configure' is in and in `..'. This
141 is known as a "VPATH" build.
142
143 With a non-GNU `make', it is safer to compile the package for one
144 architecture at a time in the source code directory. After you have
145 installed the package for one architecture, use `make distclean' before
146 reconfiguring for another architecture.
147
148 On MacOS X 10.5 and later systems, you can create libraries and
149 executables that work on multiple system types--known as "fat" or
150 "universal" binaries--by specifying multiple `-arch' options to the
151 compiler but only a single `-arch' option to the preprocessor. Like
152 this:
153
154 ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
155 CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
156 CPP="gcc -E" CXXCPP="g++ -E"
157
158 This is not guaranteed to produce working output in all cases, you
159 may have to build one architecture at a time and combine the results
160 using the `lipo' tool if you have problems.
161
162 Installation Names
163 ==================
164
165 By default, `make install' installs the package's commands under
166 `/usr/local/bin', include files under `/usr/local/include', etc. You
167 can specify an installation prefix other than `/usr/local' by giving
168 `configure' the option `--prefix=PREFIX', where PREFIX must be an
169 absolute file name.
170
171 You can specify separate installation prefixes for
172 architecture-specific files and architecture-independent files. If you
173 pass the option `--exec-prefix=PREFIX' to `configure', the package uses
174 PREFIX as the prefix for installing programs and libraries.
175 Documentation and other data files still use the regular prefix.
176
177 In addition, if you use an unusual directory layout you can give
178 options like `--bindir=DIR' to specify different values for particular
179 kinds of files. Run `configure --help' for a list of the directories
180 you can set and what kinds of files go in them. In general, the
181 default for these options is expressed in terms of `${prefix}', so that
182 specifying just `--prefix' will affect all of the other directory
183 specifications that were not explicitly provided.
184
185 The most portable way to affect installation locations is to pass the
186 correct locations to `configure'; however, many packages provide one or
187 both of the following shortcuts of passing variable assignments to the
188 `make install' command line to change installation locations without
189 having to reconfigure or recompile.
190
191 The first method involves providing an override variable for each
192 affected directory. For example, `make install
193 prefix=/alternate/directory' will choose an alternate location for all
194 directory configuration variables that were expressed in terms of
195 `${prefix}'. Any directories that were specified during `configure',
196 but not in terms of `${prefix}', must each be overridden at install
197 time for the entire installation to be relocated. The approach of
198 makefile variable overrides for each directory variable is required by
199 the GNU Coding Standards, and ideally causes no recompilation.
200 However, some platforms have known limitations with the semantics of
201 shared libraries that end up requiring recompilation when using this
202 method, particularly noticeable in packages that use GNU Libtool.
203
204 The second method involves providing the `DESTDIR' variable. For
205 example, `make install DESTDIR=/alternate/directory' will prepend
206 `/alternate/directory' before all installation names. The approach of
207 `DESTDIR' overrides is not required by the GNU Coding Standards, and
208 does not work on platforms that have drive letters. On the other hand,
209 it does better at avoiding recompilation issues, and works well even
210 when some directory options were not specified in terms of `${prefix}'
211 at `configure' time.
212
213 Optional Features
214 =================
215
216 If the package supports it, you can cause programs to be installed
217 with an extra prefix or suffix on their names by giving `configure' the
218 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
219
220 Some packages pay attention to `--enable-FEATURE' options to
221 `configure', where FEATURE indicates an optional part of the package.
222 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
223 is something like `gnu-as' or `x' (for the X Window System). The
224 `README' should mention any `--enable-' and `--with-' options that the
225 package recognizes.
226
227 For packages that use the X Window System, `configure' can usually
228 find the X include and library files automatically, but if it doesn't,
229 you can use the `configure' options `--x-includes=DIR' and
230 `--x-libraries=DIR' to specify their locations.
231
232 Some packages offer the ability to configure how verbose the
233 execution of `make' will be. For these packages, running `./configure
234 --enable-silent-rules' sets the default to minimal output, which can be
235 overridden with `make V=1'; while running `./configure
236 --disable-silent-rules' sets the default to verbose, which can be
237 overridden with `make V=0'.
238
239 Particular systems
240 ==================
241
242 On HP-UX, the default C compiler is not ANSI C compatible. If GNU
243 CC is not installed, it is recommended to use the following options in
244 order to use an ANSI C compiler:
245
246 ./configure CC="cc -Ae -D_XOPEN_SOURCE=500"
247
248 and if that doesn't work, install pre-built binaries of GCC for HP-UX.
249
250 HP-UX `make' updates targets which have the same time stamps as
251 their prerequisites, which makes it generally unusable when shipped
252 generated files such as `configure' are involved. Use GNU `make'
253 instead.
254
255 On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
256 parse its `<wchar.h>' header file. The option `-nodtk' can be used as
257 a workaround. If GNU CC is not installed, it is therefore recommended
258 to try
259
260 ./configure CC="cc"
261
262 and if that doesn't work, try
263
264 ./configure CC="cc -nodtk"
265
266 On Solaris, don't put `/usr/ucb' early in your `PATH'. This
267 directory contains several dysfunctional programs; working variants of
268 these programs are available in `/usr/bin'. So, if you need `/usr/ucb'
269 in your `PATH', put it _after_ `/usr/bin'.
270
271 On Haiku, software installed for all users goes in `/boot/common',
272 not `/usr/local'. It is recommended to use the following options:
273
274 ./configure --prefix=/boot/common
275
276 Specifying the System Type
277 ==========================
278
279 There may be some features `configure' cannot figure out
280 automatically, but needs to determine by the type of machine the package
281 will run on. Usually, assuming the package is built to be run on the
282 _same_ architectures, `configure' can figure that out, but if it prints
283 a message saying it cannot guess the machine type, give it the
284 `--build=TYPE' option. TYPE can either be a short name for the system
285 type, such as `sun4', or a canonical name which has the form:
286
287 CPU-COMPANY-SYSTEM
288
289 where SYSTEM can have one of these forms:
290
291 OS
292 KERNEL-OS
293
294 See the file `config.sub' for the possible values of each field. If
295 `config.sub' isn't included in this package, then this package doesn't
296 need to know the machine type.
297
298 If you are _building_ compiler tools for cross-compiling, you should
299 use the option `--target=TYPE' to select the type of system they will
300 produce code for.
301
302 If you want to _use_ a cross compiler, that generates code for a
303 platform different from the build platform, you should specify the
304 "host" platform (i.e., that on which the generated programs will
305 eventually be run) with `--host=TYPE'.
306
307 Sharing Defaults
308 ================
309
310 If you want to set default values for `configure' scripts to share,
311 you can create a site shell script called `config.site' that gives
312 default values for variables like `CC', `cache_file', and `prefix'.
313 `configure' looks for `PREFIX/share/config.site' if it exists, then
314 `PREFIX/etc/config.site' if it exists. Or, you can set the
315 `CONFIG_SITE' environment variable to the location of the site script.
316 A warning: not all `configure' scripts look for a site script.
317
318 Defining Variables
319 ==================
320
321 Variables not defined in a site shell script can be set in the
322 environment passed to `configure'. However, some packages may run
323 configure again during the build, and the customized values of these
324 variables may be lost. In order to avoid this problem, you should set
325 them in the `configure' command line, using `VAR=value'. For example:
326
327 ./configure CC=/usr/local2/bin/gcc
328
329 causes the specified `gcc' to be used as the C compiler (unless it is
330 overridden in the site shell script).
331
332 Unfortunately, this technique does not work for `CONFIG_SHELL' due to
333 an Autoconf limitation. Until the limitation is lifted, you can use
334 this workaround:
335
336 CONFIG_SHELL=/bin/bash ./configure CONFIG_SHELL=/bin/bash
337
338 `configure' Invocation
339 ======================
340
341 `configure' recognizes the following options to control how it
342 operates.
343
344 `--help'
345 `-h'
346 Print a summary of all of the options to `configure', and exit.
347
348 `--help=short'
349 `--help=recursive'
350 Print a summary of the options unique to this package's
351 `configure', and exit. The `short' variant lists options used
352 only in the top level, while the `recursive' variant lists options
353 also present in any nested packages.
354
355 `--version'
356 `-V'
357 Print the version of Autoconf used to generate the `configure'
358 script, and exit.
359
360 `--cache-file=FILE'
361 Enable the cache: use and save the results of the tests in FILE,
362 traditionally `config.cache'. FILE defaults to `/dev/null' to
363 disable caching.
364
365 `--config-cache'
366 `-C'
367 Alias for `--cache-file=config.cache'.
368
369 `--quiet'
370 `--silent'
371 `-q'
372 Do not print messages saying which checks are being made. To
373 suppress all normal output, redirect it to `/dev/null' (any error
374 messages will still be shown).
375
376 `--srcdir=DIR'
377 Look for the package's source code in directory DIR. Usually
378 `configure' can determine that directory automatically.
379
380 `--prefix=DIR'
381 Use DIR as the installation prefix. *note Installation Names::
382 for more details, including other options available for fine-tuning
383 the installation locations.
384
385 `--no-create'
386 `-n'
387 Run the configure checks, but stop before creating any output
388 files.
389
390 `configure' also accepts some other, not widely useful, options. Run
391 `configure --help' for more details.