[findutils.git] / INSTALL
Commit [+]AuthorDateLineData
5e8d3241 jay2005-07-29 21:19:02 +00001Installation Instructions
629f87a5 jay2004-10-24 21:10:00 +00003
5e8d3241 jay2005-07-29 21:19:02 +00004Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005 Free
5Software Foundation, Inc.
7This file is free documentation; the Free Software Foundation gives
629f87a5 jay2004-10-24 21:10:00 +00008unlimited permission to copy, distribute and modify it.
16808258 kevin1996-02-04 20:35:04 +000010Basic Installation
5e8d3241 jay2005-07-29 21:19:02 +000013These are generic installation instructions.
16808258 kevin1996-02-04 20:35:04 +000014
15 The `configure' shell script attempts to guess correct values for
16various system-dependent variables used during compilation. It uses
17those values to create a `Makefile' in each directory of the package.
18It may also create one or more `.h' files containing system-dependent
19definitions. Finally, it creates a shell script `config.status' that
629f87a5 jay2004-10-24 21:10:00 +000020you can run in the future to recreate the current configuration, and a
21file `config.log' containing compiler output (useful mainly for
22debugging `configure').
24 It can also use an optional file (typically called `config.cache'
25and enabled with `--cache-file=config.cache' or simply `-C') that saves
26the results of its tests to speed up reconfiguring. (Caching is
27disabled by default to prevent problems with accidental use of stale
28cache files.)
16808258 kevin1996-02-04 20:35:04 +000029
30 If you need to do unusual things to compile the package, please try
31to figure out how `configure' could check whether to do them, and mail
32diffs or instructions to the address given in the `README' so they can
629f87a5 jay2004-10-24 21:10:00 +000033be considered for the next release. If you are using the cache, and at
34some point `config.cache' contains results you don't want to keep, you
35may remove or edit it.
16808258 kevin1996-02-04 20:35:04 +000036
629f87a5 jay2004-10-24 21:10:00 +000037 The file `' (or `') is used to create
38`configure' by a program called `autoconf'. You only need
39`' if you want to change it or regenerate `configure' using
40a newer version of `autoconf'.
16808258 kevin1996-02-04 20:35:04 +000041
42The simplest way to compile this package is:
44 1. `cd' to the directory containing the package's source code and type
45 `./configure' to configure the package for your system. If you're
46 using `csh' on an old version of System V, you might need to type
47 `sh ./configure' instead to prevent `csh' from trying to execute
48 `configure' itself.
50 Running `configure' takes awhile. While running, it prints some
51 messages telling which features it is checking for.
53 2. Type `make' to compile the package.
55 3. Optionally, type `make check' to run any self-tests that come with
56 the package.
58 4. Type `make install' to install the programs and any data files and
59 documentation.
61 5. You can remove the program binaries and object files from the
eabc26a3 kevind2000-04-05 07:20:11 +000062 source code directory by typing `make clean'. To also remove the
63 files that `configure' created (so you can compile the package for
64 a different kind of computer), type `make distclean'. There is
65 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
67 all sorts of other programs in order to regenerate files that came
68 with the distribution.
16808258 kevin1996-02-04 20:35:04 +000069
70Compilers and Options
5e8d3241 jay2005-07-29 21:19:02 +000073Some systems require unusual options for compilation or linking that the
74`configure' script does not know about. Run `./configure --help' for
75details on some of the pertinent environment variables.
629f87a5 jay2004-10-24 21:10:00 +000076
77 You can give `configure' initial values for configuration parameters
78by setting variables in the command line or in the environment. Here
79is an example:
16808258 kevin1996-02-04 20:35:04 +000080
629f87a5 jay2004-10-24 21:10:00 +000081 ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
83 *Note Defining Variables::, for more details.
16808258 kevin1996-02-04 20:35:04 +000084
eabc26a3 kevind2000-04-05 07:20:11 +000085Compiling For Multiple Architectures
16808258 kevin1996-02-04 20:35:04 +000087
5e8d3241 jay2005-07-29 21:19:02 +000088You can compile the package for more than one kind of computer at the
eabc26a3 kevind2000-04-05 07:20:11 +000089same time, by placing the object files for each architecture in their
90own directory. To do this, you must use a version of `make' that
91supports the `VPATH' variable, such as GNU `make'. `cd' to the
92directory where you want the object files and executables to go and run
93the `configure' script. `configure' automatically checks for the
94source code in the directory that `configure' is in and in `..'.
629f87a5 jay2004-10-24 21:10:00 +000096 If you have to use a `make' that does not support the `VPATH'
97variable, you have to compile the package for one architecture at a
98time in the source code directory. After you have installed the
99package for one architecture, use `make distclean' before reconfiguring
100for another architecture.
16808258 kevin1996-02-04 20:35:04 +0000101
102Installation Names
1799b29d jay2005-08-01 07:56:09 +0000105By default, `make install' installs the package's commands under
106`/usr/local/bin', include files under `/usr/local/include', etc. You
107can specify an installation prefix other than `/usr/local' by giving
108`configure' the option `--prefix=PREFIX'.
16808258 kevin1996-02-04 20:35:04 +0000109
110 You can specify separate installation prefixes for
111architecture-specific files and architecture-independent files. If you
1799b29d jay2005-08-01 07:56:09 +0000112pass the option `--exec-prefix=PREFIX' to `configure', the package uses
113PREFIX as the prefix for installing programs and libraries.
114Documentation and other data files still use the regular prefix.
16808258 kevin1996-02-04 20:35:04 +0000115
eabc26a3 kevind2000-04-05 07:20:11 +0000116 In addition, if you use an unusual directory layout you can give
5e8d3241 jay2005-07-29 21:19:02 +0000117options like `--bindir=DIR' to specify different values for particular
eabc26a3 kevind2000-04-05 07:20:11 +0000118kinds of files. Run `configure --help' for a list of the directories
119you can set and what kinds of files go in them.
16808258 kevin1996-02-04 20:35:04 +0000121 If the package supports it, you can cause programs to be installed
122with an extra prefix or suffix on their names by giving `configure' the
123option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
125Optional Features
5e8d3241 jay2005-07-29 21:19:02 +0000128Some packages pay attention to `--enable-FEATURE' options to
16808258 kevin1996-02-04 20:35:04 +0000129`configure', where FEATURE indicates an optional part of the package.
130They may also pay attention to `--with-PACKAGE' options, where PACKAGE
131is something like `gnu-as' or `x' (for the X Window System). The
132`README' should mention any `--enable-' and `--with-' options that the
133package recognizes.
135 For packages that use the X Window System, `configure' can usually
136find the X include and library files automatically, but if it doesn't,
137you can use the `configure' options `--x-includes=DIR' and
138`--x-libraries=DIR' to specify their locations.
140Specifying the System Type
5e8d3241 jay2005-07-29 21:19:02 +0000143There may be some features `configure' cannot figure out automatically,
144but needs to determine by the type of machine the package will run on.
145Usually, assuming the package is built to be run on the _same_
146architectures, `configure' can figure that out, but if it prints a
147message saying it cannot guess the machine type, give it the
629f87a5 jay2004-10-24 21:10:00 +0000148`--build=TYPE' option. TYPE can either be a short name for the system
149type, such as `sun4', or a canonical name which has the form:
16808258 kevin1996-02-04 20:35:04 +0000151 CPU-COMPANY-SYSTEM
629f87a5 jay2004-10-24 21:10:00 +0000153where SYSTEM can have one of these forms:
157 See the file `config.sub' for the possible values of each field. If
16808258 kevin1996-02-04 20:35:04 +0000158`config.sub' isn't included in this package, then this package doesn't
629f87a5 jay2004-10-24 21:10:00 +0000159need to know the machine type.
16808258 kevin1996-02-04 20:35:04 +0000160
629f87a5 jay2004-10-24 21:10:00 +0000161 If you are _building_ compiler tools for cross-compiling, you should
1799b29d jay2005-08-01 07:56:09 +0000162use the option `--target=TYPE' to select the type of system they will
629f87a5 jay2004-10-24 21:10:00 +0000163produce code for.
165 If you want to _use_ a cross compiler, that generates code for a
166platform different from the build platform, you should specify the
167"host" platform (i.e., that on which the generated programs will
168eventually be run) with `--host=TYPE'.
16808258 kevin1996-02-04 20:35:04 +0000169
170Sharing Defaults
5e8d3241 jay2005-07-29 21:19:02 +0000173If you want to set default values for `configure' scripts to share, you
174can create a site shell script called `' that gives default
175values for variables like `CC', `cache_file', and `prefix'.
16808258 kevin1996-02-04 20:35:04 +0000176`configure' looks for `PREFIX/share/' if it exists, then
177`PREFIX/etc/' if it exists. Or, you can set the
178`CONFIG_SITE' environment variable to the location of the site script.
179A warning: not all `configure' scripts look for a site script.
629f87a5 jay2004-10-24 21:10:00 +0000181Defining Variables
16808258 kevin1996-02-04 20:35:04 +0000182==================
5e8d3241 jay2005-07-29 21:19:02 +0000184Variables not defined in a site shell script can be set in the
629f87a5 jay2004-10-24 21:10:00 +0000185environment passed to `configure'. However, some packages may run
186configure again during the build, and the customized values of these
187variables may be lost. In order to avoid this problem, you should set
188them in the `configure' command line, using `VAR=value'. For example:
190 ./configure CC=/usr/local2/bin/gcc
5e8d3241 jay2005-07-29 21:19:02 +0000192causes the specified `gcc' to be used as the C compiler (unless it is
193overridden in the site shell script). Here is a another example:
195 /bin/bash ./configure CONFIG_SHELL=/bin/bash
197Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
198configuration-related scripts to be executed by `/bin/bash'.
629f87a5 jay2004-10-24 21:10:00 +0000199
200`configure' Invocation
5e8d3241 jay2005-07-29 21:19:02 +0000203`configure' recognizes the following options to control how it operates.
16808258 kevin1996-02-04 20:35:04 +0000204
16808258 kevin1996-02-04 20:35:04 +0000205`--help'
629f87a5 jay2004-10-24 21:10:00 +0000206`-h'
16808258 kevin1996-02-04 20:35:04 +0000207 Print a summary of the options to `configure', and exit.
629f87a5 jay2004-10-24 21:10:00 +0000209`--version'
211 Print the version of Autoconf used to generate the `configure'
212 script, and exit.
215 Enable the cache: use and save the results of the tests in FILE,
216 traditionally `config.cache'. FILE defaults to `/dev/null' to
217 disable caching.
221 Alias for `--cache-file=config.cache'.
16808258 kevin1996-02-04 20:35:04 +0000223`--quiet'
eabc26a3 kevind2000-04-05 07:20:11 +0000226 Do not print messages saying which checks are being made. To
227 suppress all normal output, redirect it to `/dev/null' (any error
228 messages will still be shown).
16808258 kevin1996-02-04 20:35:04 +0000229
231 Look for the package's source code in directory DIR. Usually
232 `configure' can determine that directory automatically.
629f87a5 jay2004-10-24 21:10:00 +0000234`configure' also accepts some other, not widely useful, options. Run
235`configure --help' for more details.
16808258 kevin1996-02-04 20:35:04 +0000236