OLD | NEW |
1 Installation Instructions | 1 Installation Instructions |
2 ************************* | 2 ************************* |
3 | 3 |
4 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, | 4 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, |
5 2006, 2007, 2008, 2009 Free Software Foundation, Inc. | 5 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. |
6 | 6 |
7 This file is free documentation; the Free Software Foundation gives | 7 Copying and distribution of this file, with or without modification, |
8 unlimited permission to copy, distribute and modify it. | 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. |
9 | 11 |
10 Basic Installation | 12 Basic Installation |
11 ================== | 13 ================== |
12 | 14 |
13 Briefly, the shell commands `./configure; make; make install' should | 15 Briefly, the shell commands `./configure; make; make install' should |
14 configure, build, and install this package. The following | 16 configure, build, and install this package. The following |
15 more-detailed instructions are generic; see the `README' file for | 17 more-detailed instructions are generic; see the `README' file for |
16 instructions specific to this package. | 18 instructions specific to this package. Some packages provide this |
| 19 `INSTALL' file but do not implement all of the features documented |
| 20 below. The lack of an optional feature in a given package is not |
| 21 necessarily a bug. More recommendations for GNU packages can be found |
| 22 in *note Makefile Conventions: (standards)Makefile Conventions. |
17 | 23 |
18 The `configure' shell script attempts to guess correct values for | 24 The `configure' shell script attempts to guess correct values for |
19 various system-dependent variables used during compilation. It uses | 25 various system-dependent variables used during compilation. It uses |
20 those values to create a `Makefile' in each directory of the package. | 26 those values to create a `Makefile' in each directory of the package. |
21 It may also create one or more `.h' files containing system-dependent | 27 It may also create one or more `.h' files containing system-dependent |
22 definitions. Finally, it creates a shell script `config.status' that | 28 definitions. Finally, it creates a shell script `config.status' that |
23 you can run in the future to recreate the current configuration, and a | 29 you can run in the future to recreate the current configuration, and a |
24 file `config.log' containing compiler output (useful mainly for | 30 file `config.log' containing compiler output (useful mainly for |
25 debugging `configure'). | 31 debugging `configure'). |
26 | 32 |
27 It can also use an optional file (typically called `config.cache' | 33 It can also use an optional file (typically called `config.cache' |
28 and enabled with `--cache-file=config.cache' or simply `-C') that saves | 34 and enabled with `--cache-file=config.cache' or simply `-C') that saves |
29 the results of its tests to speed up reconfiguring. Caching is | 35 the results of its tests to speed up reconfiguring. Caching is |
30 disabled by default to prevent problems with accidental use of stale | 36 disabled by default to prevent problems with accidental use of stale |
31 cache files. | 37 cache files. |
32 | 38 |
33 If you need to do unusual things to compile the package, please try | 39 If you need to do unusual things to compile the package, please try |
34 to figure out how `configure' could check whether to do them, and mail | 40 to figure out how `configure' could check whether to do them, and mail |
35 diffs or instructions to the address given in the `README' so they can | 41 diffs or instructions to the address given in the `README' so they can |
36 be considered for the next release. If you are using the cache, and at | 42 be considered for the next release. If you are using the cache, and at |
37 some point `config.cache' contains results you don't want to keep, you | 43 some point `config.cache' contains results you don't want to keep, you |
38 may remove or edit it. | 44 may remove or edit it. |
39 | 45 |
40 The file `configure.ac' (or `configure.in') is used to create | 46 The file `configure.ac' (or `configure.in') is used to create |
41 `configure' by a program called `autoconf'. You need `configure.ac' if | 47 `configure' by a program called `autoconf'. You need `configure.ac' if |
42 you want to change it or regenerate `configure' using a newer version | 48 you want to change it or regenerate `configure' using a newer version |
43 of `autoconf'. | 49 of `autoconf'. |
44 | 50 |
45 The simplest way to compile this package is: | 51 The simplest way to compile this package is: |
46 | 52 |
47 1. `cd' to the directory containing the package's source code and type | 53 1. `cd' to the directory containing the package's source code and type |
48 `./configure' to configure the package for your system. | 54 `./configure' to configure the package for your system. |
49 | 55 |
50 Running `configure' might take a while. While running, it prints | 56 Running `configure' might take a while. While running, it prints |
51 some messages telling which features it is checking for. | 57 some messages telling which features it is checking for. |
52 | 58 |
53 2. Type `make' to compile the package. | 59 2. Type `make' to compile the package. |
54 | 60 |
55 3. Optionally, type `make check' to run any self-tests that come with | 61 3. Optionally, type `make check' to run any self-tests that come with |
56 the package. | 62 the package, generally using the just-built uninstalled binaries. |
57 | 63 |
58 4. Type `make install' to install the programs and any data files and | 64 4. Type `make install' to install the programs and any data files and |
59 documentation. | 65 documentation. When installing into a prefix owned by root, it is |
| 66 recommended that the package be configured and built as a regular |
| 67 user, and only the `make install' phase executed with root |
| 68 privileges. |
60 | 69 |
61 5. You can remove the program binaries and object files from the | 70 5. Optionally, type `make installcheck' to repeat any self-tests, but |
| 71 this time using the binaries in their final installed location. |
| 72 This target does not install anything. Running this target as a |
| 73 regular user, particularly if the prior `make install' required |
| 74 root privileges, verifies that the installation completed |
| 75 correctly. |
| 76 |
| 77 6. You can remove the program binaries and object files from the |
62 source code directory by typing `make clean'. To also remove the | 78 source code directory by typing `make clean'. To also remove the |
63 files that `configure' created (so you can compile the package for | 79 files that `configure' created (so you can compile the package for |
64 a different kind of computer), type `make distclean'. There is | 80 a different kind of computer), type `make distclean'. There is |
65 also a `make maintainer-clean' target, but that is intended mainly | 81 also a `make maintainer-clean' target, but that is intended mainly |
66 for the package's developers. If you use it, you may have to get | 82 for the package's developers. If you use it, you may have to get |
67 all sorts of other programs in order to regenerate files that came | 83 all sorts of other programs in order to regenerate files that came |
68 with the distribution. | 84 with the distribution. |
69 | 85 |
70 6. Often, you can also type `make uninstall' to remove the installed | 86 7. Often, you can also type `make uninstall' to remove the installed |
71 files again. | 87 files again. In practice, not all packages have tested that |
| 88 uninstallation works correctly, even though it is required by the |
| 89 GNU Coding Standards. |
| 90 |
| 91 8. Some packages, particularly those that use Automake, provide `make |
| 92 distcheck', which can by used by developers to test that all other |
| 93 targets like `make install' and `make uninstall' work correctly. |
| 94 This target is generally not run by end users. |
72 | 95 |
73 Compilers and Options | 96 Compilers and Options |
74 ===================== | 97 ===================== |
75 | 98 |
76 Some systems require unusual options for compilation or linking that | 99 Some systems require unusual options for compilation or linking that |
77 the `configure' script does not know about. Run `./configure --help' | 100 the `configure' script does not know about. Run `./configure --help' |
78 for details on some of the pertinent environment variables. | 101 for details on some of the pertinent environment variables. |
79 | 102 |
80 You can give `configure' initial values for configuration parameters | 103 You can give `configure' initial values for configuration parameters |
81 by setting variables in the command line or in the environment. Here | 104 by setting variables in the command line or in the environment. Here |
82 is an example: | 105 is an example: |
83 | 106 |
84 ./configure CC=c99 CFLAGS=-g LIBS=-lposix | 107 ./configure CC=c99 CFLAGS=-g LIBS=-lposix |
85 | 108 |
86 *Note Defining Variables::, for more details. | 109 *Note Defining Variables::, for more details. |
87 | 110 |
88 Compiling For Multiple Architectures | 111 Compiling For Multiple Architectures |
89 ==================================== | 112 ==================================== |
90 | 113 |
91 You can compile the package for more than one kind of computer at the | 114 You can compile the package for more than one kind of computer at the |
92 same time, by placing the object files for each architecture in their | 115 same time, by placing the object files for each architecture in their |
93 own directory. To do this, you can use GNU `make'. `cd' to the | 116 own directory. To do this, you can use GNU `make'. `cd' to the |
94 directory where you want the object files and executables to go and run | 117 directory where you want the object files and executables to go and run |
95 the `configure' script. `configure' automatically checks for the | 118 the `configure' script. `configure' automatically checks for the |
96 source code in the directory that `configure' is in and in `..'. | 119 source code in the directory that `configure' is in and in `..'. This |
| 120 is known as a "VPATH" build. |
97 | 121 |
98 With a non-GNU `make', it is safer to compile the package for one | 122 With a non-GNU `make', it is safer to compile the package for one |
99 architecture at a time in the source code directory. After you have | 123 architecture at a time in the source code directory. After you have |
100 installed the package for one architecture, use `make distclean' before | 124 installed the package for one architecture, use `make distclean' before |
101 reconfiguring for another architecture. | 125 reconfiguring for another architecture. |
102 | 126 |
103 On MacOS X 10.5 and later systems, you can create libraries and | 127 On MacOS X 10.5 and later systems, you can create libraries and |
104 executables that work on multiple system types--known as "fat" or | 128 executables that work on multiple system types--known as "fat" or |
105 "universal" binaries--by specifying multiple `-arch' options to the | 129 "universal" binaries--by specifying multiple `-arch' options to the |
106 compiler but only a single `-arch' option to the preprocessor. Like | 130 compiler but only a single `-arch' option to the preprocessor. Like |
107 this: | 131 this: |
108 | 132 |
109 ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \ | 133 ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \ |
110 CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \ | 134 CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \ |
111 CPP="gcc -E" CXXCPP="g++ -E" | 135 CPP="gcc -E" CXXCPP="g++ -E" |
112 | 136 |
113 This is not guaranteed to produce working output in all cases, you | 137 This is not guaranteed to produce working output in all cases, you |
114 may have to build one architecture at a time and combine the results | 138 may have to build one architecture at a time and combine the results |
115 using the `lipo' tool if you have problems. | 139 using the `lipo' tool if you have problems. |
116 | 140 |
117 Installation Names | 141 Installation Names |
118 ================== | 142 ================== |
119 | 143 |
120 By default, `make install' installs the package's commands under | 144 By default, `make install' installs the package's commands under |
121 `/usr/local/bin', include files under `/usr/local/include', etc. You | 145 `/usr/local/bin', include files under `/usr/local/include', etc. You |
122 can specify an installation prefix other than `/usr/local' by giving | 146 can specify an installation prefix other than `/usr/local' by giving |
123 `configure' the option `--prefix=PREFIX'. | 147 `configure' the option `--prefix=PREFIX', where PREFIX must be an |
| 148 absolute file name. |
124 | 149 |
125 You can specify separate installation prefixes for | 150 You can specify separate installation prefixes for |
126 architecture-specific files and architecture-independent files. If you | 151 architecture-specific files and architecture-independent files. If you |
127 pass the option `--exec-prefix=PREFIX' to `configure', the package uses | 152 pass the option `--exec-prefix=PREFIX' to `configure', the package uses |
128 PREFIX as the prefix for installing programs and libraries. | 153 PREFIX as the prefix for installing programs and libraries. |
129 Documentation and other data files still use the regular prefix. | 154 Documentation and other data files still use the regular prefix. |
130 | 155 |
131 In addition, if you use an unusual directory layout you can give | 156 In addition, if you use an unusual directory layout you can give |
132 options like `--bindir=DIR' to specify different values for particular | 157 options like `--bindir=DIR' to specify different values for particular |
133 kinds of files. Run `configure --help' for a list of the directories | 158 kinds of files. Run `configure --help' for a list of the directories |
134 you can set and what kinds of files go in them. | 159 you can set and what kinds of files go in them. In general, the |
| 160 default for these options is expressed in terms of `${prefix}', so that |
| 161 specifying just `--prefix' will affect all of the other directory |
| 162 specifications that were not explicitly provided. |
| 163 |
| 164 The most portable way to affect installation locations is to pass the |
| 165 correct locations to `configure'; however, many packages provide one or |
| 166 both of the following shortcuts of passing variable assignments to the |
| 167 `make install' command line to change installation locations without |
| 168 having to reconfigure or recompile. |
| 169 |
| 170 The first method involves providing an override variable for each |
| 171 affected directory. For example, `make install |
| 172 prefix=/alternate/directory' will choose an alternate location for all |
| 173 directory configuration variables that were expressed in terms of |
| 174 `${prefix}'. Any directories that were specified during `configure', |
| 175 but not in terms of `${prefix}', must each be overridden at install |
| 176 time for the entire installation to be relocated. The approach of |
| 177 makefile variable overrides for each directory variable is required by |
| 178 the GNU Coding Standards, and ideally causes no recompilation. |
| 179 However, some platforms have known limitations with the semantics of |
| 180 shared libraries that end up requiring recompilation when using this |
| 181 method, particularly noticeable in packages that use GNU Libtool. |
| 182 |
| 183 The second method involves providing the `DESTDIR' variable. For |
| 184 example, `make install DESTDIR=/alternate/directory' will prepend |
| 185 `/alternate/directory' before all installation names. The approach of |
| 186 `DESTDIR' overrides is not required by the GNU Coding Standards, and |
| 187 does not work on platforms that have drive letters. On the other hand, |
| 188 it does better at avoiding recompilation issues, and works well even |
| 189 when some directory options were not specified in terms of `${prefix}' |
| 190 at `configure' time. |
| 191 |
| 192 Optional Features |
| 193 ================= |
135 | 194 |
136 If the package supports it, you can cause programs to be installed | 195 If the package supports it, you can cause programs to be installed |
137 with an extra prefix or suffix on their names by giving `configure' the | 196 with an extra prefix or suffix on their names by giving `configure' the |
138 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. | 197 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. |
139 | 198 |
140 Optional Features | |
141 ================= | |
142 | |
143 Some packages pay attention to `--enable-FEATURE' options to | 199 Some packages pay attention to `--enable-FEATURE' options to |
144 `configure', where FEATURE indicates an optional part of the package. | 200 `configure', where FEATURE indicates an optional part of the package. |
145 They may also pay attention to `--with-PACKAGE' options, where PACKAGE | 201 They may also pay attention to `--with-PACKAGE' options, where PACKAGE |
146 is something like `gnu-as' or `x' (for the X Window System). The | 202 is something like `gnu-as' or `x' (for the X Window System). The |
147 `README' should mention any `--enable-' and `--with-' options that the | 203 `README' should mention any `--enable-' and `--with-' options that the |
148 package recognizes. | 204 package recognizes. |
149 | 205 |
150 For packages that use the X Window System, `configure' can usually | 206 For packages that use the X Window System, `configure' can usually |
151 find the X include and library files automatically, but if it doesn't, | 207 find the X include and library files automatically, but if it doesn't, |
152 you can use the `configure' options `--x-includes=DIR' and | 208 you can use the `configure' options `--x-includes=DIR' and |
153 `--x-libraries=DIR' to specify their locations. | 209 `--x-libraries=DIR' to specify their locations. |
154 | 210 |
| 211 Some packages offer the ability to configure how verbose the |
| 212 execution of `make' will be. For these packages, running `./configure |
| 213 --enable-silent-rules' sets the default to minimal output, which can be |
| 214 overridden with `make V=1'; while running `./configure |
| 215 --disable-silent-rules' sets the default to verbose, which can be |
| 216 overridden with `make V=0'. |
| 217 |
155 Particular systems | 218 Particular systems |
156 ================== | 219 ================== |
157 | 220 |
158 On HP-UX, the default C compiler is not ANSI C compatible. If GNU | 221 On HP-UX, the default C compiler is not ANSI C compatible. If GNU |
159 CC is not installed, it is recommended to use the following options in | 222 CC is not installed, it is recommended to use the following options in |
160 order to use an ANSI C compiler: | 223 order to use an ANSI C compiler: |
161 | 224 |
162 ./configure CC="cc -Ae -D_XOPEN_SOURCE=500" | 225 ./configure CC="cc -Ae -D_XOPEN_SOURCE=500" |
163 | 226 |
164 and if that doesn't work, install pre-built binaries of GCC for HP-UX. | 227 and if that doesn't work, install pre-built binaries of GCC for HP-UX. |
(...skipping 116 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
281 `-q' | 344 `-q' |
282 Do not print messages saying which checks are being made. To | 345 Do not print messages saying which checks are being made. To |
283 suppress all normal output, redirect it to `/dev/null' (any error | 346 suppress all normal output, redirect it to `/dev/null' (any error |
284 messages will still be shown). | 347 messages will still be shown). |
285 | 348 |
286 `--srcdir=DIR' | 349 `--srcdir=DIR' |
287 Look for the package's source code in directory DIR. Usually | 350 Look for the package's source code in directory DIR. Usually |
288 `configure' can determine that directory automatically. | 351 `configure' can determine that directory automatically. |
289 | 352 |
290 `--prefix=DIR' | 353 `--prefix=DIR' |
291 Use DIR as the installation prefix. *Note Installation Names:: | 354 Use DIR as the installation prefix. *note Installation Names:: |
292 for more details, including other options available for fine-tuning | 355 for more details, including other options available for fine-tuning |
293 the installation locations. | 356 the installation locations. |
294 | 357 |
295 `--no-create' | 358 `--no-create' |
296 `-n' | 359 `-n' |
297 Run the configure checks, but stop before creating any output | 360 Run the configure checks, but stop before creating any output |
298 files. | 361 files. |
299 | 362 |
300 `configure' also accepts some other, not widely useful, options. Run | 363 `configure' also accepts some other, not widely useful, options. Run |
301 `configure --help' for more details. | 364 `configure --help' for more details. |
302 | 365 |
OLD | NEW |