aboutsummaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL97
1 files changed, 17 insertions, 80 deletions
diff --git a/INSTALL b/INSTALL
index 7d1c323..2550dab 100644
--- a/INSTALL
+++ b/INSTALL
@@ -4,10 +4,8 @@ Installation Instructions
4Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, 4Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
52006, 2007, 2008, 2009 Free Software Foundation, Inc. 52006, 2007, 2008, 2009 Free Software Foundation, Inc.
6 6
7 Copying and distribution of this file, with or without modification, 7 This file is free documentation; the Free Software Foundation gives
8are permitted in any medium without royalty provided the copyright 8unlimited permission to copy, distribute and modify it.
9notice and this notice are preserved. This file is offered as-is,
10without warranty of any kind.
11 9
12Basic Installation 10Basic Installation
13================== 11==================
@@ -15,11 +13,7 @@ Basic Installation
15 Briefly, the shell commands `./configure; make; make install' should 13 Briefly, the shell commands `./configure; make; make install' should
16configure, build, and install this package. The following 14configure, build, and install this package. The following
17more-detailed instructions are generic; see the `README' file for 15more-detailed instructions are generic; see the `README' file for
18instructions specific to this package. Some packages provide this 16instructions specific to this package.
19`INSTALL' file but do not implement all of the features documented
20below. The lack of an optional feature in a given package is not
21necessarily a bug. More recommendations for GNU packages can be found
22in *note Makefile Conventions: (standards)Makefile Conventions.
23 17
24 The `configure' shell script attempts to guess correct values for 18 The `configure' shell script attempts to guess correct values for
25various system-dependent variables used during compilation. It uses 19various system-dependent variables used during compilation. It uses
@@ -48,7 +42,7 @@ may remove or edit it.
48you want to change it or regenerate `configure' using a newer version 42you want to change it or regenerate `configure' using a newer version
49of `autoconf'. 43of `autoconf'.
50 44
51 The simplest way to compile this package is: 45The simplest way to compile this package is:
52 46
53 1. `cd' to the directory containing the package's source code and type 47 1. `cd' to the directory containing the package's source code and type
54 `./configure' to configure the package for your system. 48 `./configure' to configure the package for your system.
@@ -59,22 +53,12 @@ of `autoconf'.
59 2. Type `make' to compile the package. 53 2. Type `make' to compile the package.
60 54
61 3. Optionally, type `make check' to run any self-tests that come with 55 3. Optionally, type `make check' to run any self-tests that come with
62 the package, generally using the just-built uninstalled binaries. 56 the package.
63 57
64 4. Type `make install' to install the programs and any data files and 58 4. Type `make install' to install the programs and any data files and
65 documentation. When installing into a prefix owned by root, it is 59 documentation.
66 recommended that the package be configured and built as a regular 60
67 user, and only the `make install' phase executed with root 61 5. You can remove the program binaries and object files from the
68 privileges.
69
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
78 source code directory by typing `make clean'. To also remove the 62 source code directory by typing `make clean'. To also remove the
79 files that `configure' created (so you can compile the package for 63 files that `configure' created (so you can compile the package for
80 a different kind of computer), type `make distclean'. There is 64 a different kind of computer), type `make distclean'. There is
@@ -83,15 +67,8 @@ of `autoconf'.
83 all sorts of other programs in order to regenerate files that came 67 all sorts of other programs in order to regenerate files that came
84 with the distribution. 68 with the distribution.
85 69
86 7. Often, you can also type `make uninstall' to remove the installed 70 6. Often, you can also type `make uninstall' to remove the installed
87 files again. In practice, not all packages have tested that 71 files again.
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.
95 72
96Compilers and Options 73Compilers and Options
97===================== 74=====================
@@ -116,8 +93,7 @@ same time, by placing the object files for each architecture in their
116own directory. To do this, you can use GNU `make'. `cd' to the 93own directory. To do this, you can use GNU `make'. `cd' to the
117directory where you want the object files and executables to go and run 94directory where you want the object files and executables to go and run
118the `configure' script. `configure' automatically checks for the 95the `configure' script. `configure' automatically checks for the
119source code in the directory that `configure' is in and in `..'. This 96source code in the directory that `configure' is in and in `..'.
120is known as a "VPATH" build.
121 97
122 With a non-GNU `make', it is safer to compile the package for one 98 With a non-GNU `make', it is safer to compile the package for one
123architecture at a time in the source code directory. After you have 99architecture at a time in the source code directory. After you have
@@ -144,8 +120,7 @@ Installation Names
144 By default, `make install' installs the package's commands under 120 By default, `make install' installs the package's commands under
145`/usr/local/bin', include files under `/usr/local/include', etc. You 121`/usr/local/bin', include files under `/usr/local/include', etc. You
146can specify an installation prefix other than `/usr/local' by giving 122can specify an installation prefix other than `/usr/local' by giving
147`configure' the option `--prefix=PREFIX', where PREFIX must be an 123`configure' the option `--prefix=PREFIX'.
148absolute file name.
149 124
150 You can specify separate installation prefixes for 125 You can specify separate installation prefixes for
151architecture-specific files and architecture-independent files. If you 126architecture-specific files and architecture-independent files. If you
@@ -156,46 +131,15 @@ Documentation and other data files still use the regular prefix.
156 In addition, if you use an unusual directory layout you can give 131 In addition, if you use an unusual directory layout you can give
157options like `--bindir=DIR' to specify different values for particular 132options like `--bindir=DIR' to specify different values for particular
158kinds of files. Run `configure --help' for a list of the directories 133kinds of files. Run `configure --help' for a list of the directories
159you can set and what kinds of files go in them. In general, the 134you can set and what kinds of files go in them.
160default for these options is expressed in terms of `${prefix}', so that
161specifying just `--prefix' will affect all of the other directory
162specifications that were not explicitly provided.
163
164 The most portable way to affect installation locations is to pass the
165correct locations to `configure'; however, many packages provide one or
166both of the following shortcuts of passing variable assignments to the
167`make install' command line to change installation locations without
168having to reconfigure or recompile.
169
170 The first method involves providing an override variable for each
171affected directory. For example, `make install
172prefix=/alternate/directory' will choose an alternate location for all
173directory configuration variables that were expressed in terms of
174`${prefix}'. Any directories that were specified during `configure',
175but not in terms of `${prefix}', must each be overridden at install
176time for the entire installation to be relocated. The approach of
177makefile variable overrides for each directory variable is required by
178the GNU Coding Standards, and ideally causes no recompilation.
179However, some platforms have known limitations with the semantics of
180shared libraries that end up requiring recompilation when using this
181method, particularly noticeable in packages that use GNU Libtool.
182
183 The second method involves providing the `DESTDIR' variable. For
184example, `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
187does not work on platforms that have drive letters. On the other hand,
188it does better at avoiding recompilation issues, and works well even
189when some directory options were not specified in terms of `${prefix}'
190at `configure' time.
191
192Optional Features
193=================
194 135
195 If the package supports it, you can cause programs to be installed 136 If the package supports it, you can cause programs to be installed
196with an extra prefix or suffix on their names by giving `configure' the 137with an extra prefix or suffix on their names by giving `configure' the
197option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. 138option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
198 139
140Optional Features
141=================
142
199 Some packages pay attention to `--enable-FEATURE' options to 143 Some packages pay attention to `--enable-FEATURE' options to
200`configure', where FEATURE indicates an optional part of the package. 144`configure', where FEATURE indicates an optional part of the package.
201They may also pay attention to `--with-PACKAGE' options, where PACKAGE 145They may also pay attention to `--with-PACKAGE' options, where PACKAGE
@@ -208,13 +152,6 @@ find the X include and library files automatically, but if it doesn't,
208you can use the `configure' options `--x-includes=DIR' and 152you can use the `configure' options `--x-includes=DIR' and
209`--x-libraries=DIR' to specify their locations. 153`--x-libraries=DIR' to specify their locations.
210 154
211 Some packages offer the ability to configure how verbose the
212execution of `make' will be. For these packages, running `./configure
213--enable-silent-rules' sets the default to minimal output, which can be
214overridden with `make V=1'; while running `./configure
215--disable-silent-rules' sets the default to verbose, which can be
216overridden with `make V=0'.
217
218Particular systems 155Particular systems
219================== 156==================
220 157
@@ -351,7 +288,7 @@ operates.
351 `configure' can determine that directory automatically. 288 `configure' can determine that directory automatically.
352 289
353`--prefix=DIR' 290`--prefix=DIR'
354 Use DIR as the installation prefix. *note Installation Names:: 291 Use DIR as the installation prefix. *Note Installation Names::
355 for more details, including other options available for fine-tuning 292 for more details, including other options available for fine-tuning
356 the installation locations. 293 the installation locations.
357 294