source: trunk/third/pcre/INSTALL @ 19309

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