1: Basic Installation
2: ==================
3:
4: These are generic *nix installation instructions.
5:
6: For Windows/NT, please see ports/winnt and html/build/hints/winnt.html.
7:
8: The `configure' shell script attempts to guess correct values for
9: various system-dependent variables used during compilation. It uses
10: those values to create a `Makefile' in each directory of the package.
11: It may also create one or more `.h' files containing system-dependent
12: definitions. Finally, it creates a shell script `config.status' that
13: you can run in the future to recreate the current configuration, a file
14: `config.cache' that saves the results of its tests to speed up
15: reconfiguring, and a file `config.log' containing compiler output
16: (useful mainly for debugging `configure').
17:
18: If you need to do unusual things to compile the package, please try
19: to figure out how `configure' could check whether to do them, and mail
20: diffs or instructions to the address given in the `README' so they can
21: be considered for the next release. If at some point `config.cache'
22: contains results you don't want to keep, you may remove or edit it.
23:
24: The file `configure.in' is used to create `configure' by a program
25: called `autoconf'. You only need `configure.in' if you want to change
26: it or regenerate `configure' using a newer version of `autoconf'.
27:
28: The simplest way to compile this package is:
29:
30: 1. `cd' to the directory containing the package's source code and type
31: `./configure' to configure the package for your system. If you're
32: using `csh' on an old version of System V, you might need to type
33: `sh ./configure' instead to prevent `csh' from trying to execute
34: `configure' itself.
35:
36: Running `configure' takes a while. While running, it prints some
37: messages telling which features it is checking for.
38:
39: 2. Type `make' to compile the package.
40:
41: 3. Optionally, type `make check' to run any self-tests that come with
42: the package.
43:
44: 4. Type `make install' to install the programs and any data files and
45: documentation.
46:
47: 5. You can remove the program binaries and object files from the
48: source code directory by typing `make clean'. To also remove the
49: files that `configure' created (so you can compile the package for
50: a different kind of computer), type `make distclean'. There is
51: also a `make maintainer-clean' target, but that is intended mainly
52: for the package's developers. If you use it, you may have to get
53: all sorts of other programs in order to regenerate files that came
54: with the distribution.
55:
56: Compilers and Options
57: =====================
58:
59: Some systems require unusual options for compilation or linking that
60: the `configure' script does not know about. You can give `configure'
61: initial values for variables by setting them in the environment. Using
62: a Bourne-compatible shell, you can do that on the command line like
63: this:
64: CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
65:
66: Or on systems that have the `env' program, you can do it like this:
67: env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
68:
69: Compiling For Multiple Architectures
70: ====================================
71:
72: You can compile the package for more than one kind of computer at the
73: same time, by placing the object files for each architecture in their
74: own directory. To do this, you must use a version of `make' that
75: supports the `VPATH' variable, such as GNU `make'. `cd' to the
76: directory where you want the object files and executables to go and run
77: the `configure' script. `configure' automatically checks for the
78: source code in the directory that `configure' is in and in `..'.
79:
80: If you have to use a `make' that does not supports the `VPATH'
81: variable, you have to compile the package for one architecture at a time
82: in the source code directory. After you have installed the package for
83: one architecture, use `make distclean' before reconfiguring for another
84: architecture.
85:
86: Installation Names
87: ==================
88:
89: By default, `make install' will install the package's files in
90: `/usr/local/bin', `/usr/local/man', etc. You can specify an
91: installation prefix other than `/usr/local' by giving `configure' the
92: option `--prefix=PATH'.
93:
94: You can specify separate installation prefixes for
95: architecture-specific files and architecture-independent files. If you
96: give `configure' the option `--exec-prefix=PATH', the package will use
97: PATH as the prefix for installing programs and libraries.
98: Documentation and other data files will still use the regular prefix.
99:
100: If the package supports it, you can cause programs to be installed
101: with an extra prefix or suffix on their names by giving `configure' the
102: option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
103:
104: Optional Features
105: =================
106:
107: Some packages pay attention to `--enable-FEATURE' options to
108: `configure', where FEATURE indicates an optional part of the package.
109: They may also pay attention to `--with-PACKAGE' options, where PACKAGE
110: is something like `gnu-as' or `x' (for the X Window System). The
111: `README' should mention any `--enable-' and `--with-' options that the
112: package recognizes.
113:
114: For packages that use the X Window System, `configure' can usually
115: find the X include and library files automatically, but if it doesn't,
116: you can use the `configure' options `--x-includes=DIR' and
117: `--x-libraries=DIR' to specify their locations.
118:
119: Specifying the System Type
120: ==========================
121:
122: There may be some features `configure' can not figure out
123: automatically, but needs to determine by the type of host the package
124: will run on. Usually `configure' can figure that out, but if it prints
125: a message saying it can not guess the host type, give it the
126: `--host=TYPE' option. TYPE can either be a short name for the system
127: type, such as `sun4', or a canonical name with three fields:
128: CPU-COMPANY-SYSTEM
129:
130: See the file `config.sub' for the possible values of each field. If
131: `config.sub' isn't included in this package, then this package doesn't
132: need to know the host type.
133:
134: If you are building compiler tools for cross-compiling, you can also
135: use the `--target=TYPE' option to select the type of system they will
136: produce code for and the `--build=TYPE' option to select the type of
137: system on which you are compiling the package.
138:
139: Sharing Defaults
140: ================
141:
142: If you want to set default values for `configure' scripts to share,
143: you can create a site shell script called `config.site' that gives
144: default values for variables like `CC', `cache_file', and `prefix'.
145: `configure' looks for `PREFIX/share/config.site' if it exists, then
146: `PREFIX/etc/config.site' if it exists. Or, you can set the
147: `CONFIG_SITE' environment variable to the location of the site script.
148: A warning: not all `configure' scripts look for a site script.
149:
150: Operation Controls
151: ==================
152:
153: `configure' recognizes the following options to control how it
154: operates.
155:
156: `--cache-file=FILE'
157: Use and save the results of the tests in FILE instead of
158: `./config.cache'. Set FILE to `/dev/null' to disable caching, for
159: debugging `configure'.
160:
161: `--help'
162: Print a summary of the options to `configure', and exit.
163:
164: `--quiet'
165: `--silent'
166: `-q'
167: Do not print messages saying which checks are being made.
168:
169: `--srcdir=DIR'
170: Look for the package's source code in directory DIR. Usually
171: `configure' can determine that directory automatically.
172:
173: `--version'
174: Print the version of Autoconf used to generate the `configure'
175: script, and exit.
176:
177: `configure' also accepts some other, not widely useful, options.
178:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>