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