4 These are generic installation instructions, with a few additional
5 notes for installing on non-Linux systems.
7 The `configure' shell script attempts to guess correct values for
8 various system-dependent variables used during compilation. It uses
9 those values to create a `Makefile' in each directory of the package.
10 It may also create one or more `.h' files containing system-dependent
11 definitions. Finally, it creates a shell script `config.status' that
12 you can run in the future to recreate the current configuration, a file
13 `config.cache' that saves the results of its tests to speed up
14 reconfiguring, and a file `config.log' containing compiler output
15 (useful mainly for debugging `configure').
17 If you need to do unusual things to compile the package, please try
18 to figure out how `configure' could check whether to do them, and mail
19 diffs or instructions to the address given in the `README' so they can
20 be considered for the next release. If at some point `config.cache'
21 contains results you don't want to keep, you may remove or edit it.
23 The file `configure.in' is used to create `configure' by a program
24 called `autoconf'. You only need `configure.in' if you want to change
25 it or regenerate `configure' using a newer version of `autoconf'.
27 The simplest way to compile this package is:
29 1. `cd' to the directory containing the package's source code and type
30 `./configure' to configure the package for your system. If you're
31 using `csh' on an old version of System V, you might need to type
32 `sh ./configure' instead to prevent `csh' from trying to execute
35 Running `configure' takes awhile. While running, it prints some
36 messages telling which features it is checking for.
38 2. Type `make' to compile the package.
40 3. Optionally, type `make check' to run any self-tests that come with
43 4. Type `make install' to install the programs and any data files and
46 5. You can remove the program binaries and object files from the
47 source code directory by typing `make clean'. To also remove the
48 files that `configure' created (so you can compile the package for
49 a different kind of computer), type `make distclean'. There is
50 also a `make maintainer-clean' target, but that is intended mainly
51 for the package's developers. If you use it, you may have to get
52 all sorts of other programs in order to regenerate files that came
53 with the distribution.
58 Some systems require unusual options for compilation or linking that
59 the `configure' script does not know about. You can give `configure'
60 initial values for variables by setting them in the environment. Using
61 a Bourne-compatible shell, you can do that on the command line like
63 CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
65 Or on systems that have the `env' program, you can do it like this:
66 env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
68 Compiling For Multiple Architectures
69 ====================================
71 You can compile the package for more than one kind of computer at the
72 same time, by placing the object files for each architecture in their
73 own directory. To do this, you must use a version of `make' that
74 supports the `VPATH' variable, such as GNU `make'. `cd' to the
75 directory where you want the object files and executables to go and run
76 the `configure' script. `configure' automatically checks for the
77 source code in the directory that `configure' is in and in `..'.
79 If you have to use a `make' that does not supports the `VPATH'
80 variable, you have to compile the package for one architecture at a time
81 in the source code directory. After you have installed the package for
82 one architecture, use `make distclean' before reconfiguring for another
88 By default, `make install' will install the package's files in
89 `/usr/local/bin', `/usr/local/man', etc. You can specify an
90 installation prefix other than `/usr/local' by giving `configure' the
91 option `--prefix=PATH'.
93 You can specify separate installation prefixes for
94 architecture-specific files and architecture-independent files. If you
95 give `configure' the option `--exec-prefix=PATH', the package will use
96 PATH as the prefix for installing programs and libraries.
97 Documentation and other data files will still use the regular prefix.
99 In addition, if you use an unusual directory layout you can give
100 options like `--bindir=PATH' to specify different values for particular
101 kinds of files. Run `configure --help' for a list of the directories
102 you can set and what kinds of files go in them.
104 If the package supports it, you can cause programs to be installed
105 with an extra prefix or suffix on their names by giving `configure' the
106 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
111 Some packages pay attention to `--enable-FEATURE' options to
112 `configure', where FEATURE indicates an optional part of the package.
113 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
114 is something like `gnu-as' or `x' (for the X Window System). The
115 `README' should mention any `--enable-' and `--with-' options that the
118 For packages that use the X Window System, `configure' can usually
119 find the X include and library files automatically, but if it doesn't,
120 you can use the `configure' options `--x-includes=DIR' and
121 `--x-libraries=DIR' to specify their locations.
123 Specifying the System Type
124 ==========================
126 There may be some features `configure' can not figure out
127 automatically, but needs to determine by the type of host the package
128 will run on. Usually `configure' can figure that out, but if it prints
129 a message saying it can not guess the host type, give it the
130 `--host=TYPE' option. TYPE can either be a short name for the system
131 type, such as `sun4', or a canonical name with three fields:
134 See the file `config.sub' for the possible values of each field. If
135 `config.sub' isn't included in this package, then this package doesn't
136 need to know the host type.
138 If you are building compiler tools for cross-compiling, you can also
139 use the `--target=TYPE' option to select the type of system they will
140 produce code for and the `--build=TYPE' option to select the type of
141 system on which you are compiling the package.
146 If you want to set default values for `configure' scripts to share,
147 you can create a site shell script called `config.site' that gives
148 default values for variables like `CC', `cache_file', and `prefix'.
149 `configure' looks for `PREFIX/share/config.site' if it exists, then
150 `PREFIX/etc/config.site' if it exists. Or, you can set the
151 `CONFIG_SITE' environment variable to the location of the site script.
152 A warning: not all `configure' scripts look for a site script.
157 `configure' recognizes the following options to control how it
161 Use and save the results of the tests in FILE instead of
162 `./config.cache'. Set FILE to `/dev/null' to disable caching, for
163 debugging `configure'.
166 Print a summary of the options to `configure', and exit.
171 Do not print messages saying which checks are being made. To
172 suppress all normal output, redirect it to `/dev/null' (any error
173 messages will still be shown).
176 Look for the package's source code in directory DIR. Usually
177 `configure' can determine that directory automatically.
180 Print the version of Autoconf used to generate the `configure'
183 `configure' also accepts some other, not widely useful, options.
188 To run xmlto on a non-Linux system you will need some supporting
189 software. For Solaris at least, you will need GNU bash, GNU find,
190 mktemp, and getopt. The first two are GNU packages and can be obtained
191 from <http://www.gnu.org/>.
193 For getopt, visit <http://huizen.dds.nl/~frodol/getopt.html>. For
194 Solaris, the following will need changing:
199 For mktemp, visit <http://www.mktemp.org/>. For Solaris, stripping
200 the binary will cause it to core dump on startup. If you experience this
201 problem remove the -s from the installation command line.
206 If you get `Attempt to load network entity' errors when building
207 xmlto, your system does not have the required support for XML Catalogs
208 (http://www.oasis-open.org/committees/entity/spec-2001-08-06.html).
209 In particular, Debian has no support for these.