Skip to content
Newer
Older
100644 315 lines (238 sloc) 12.5 KB
7f74fd8 Initial commit of autoconf-based build in 'v4.1d1' branch of user 'sh…
svnusers authored
1 Copyright 1994, 1995, 1996, 1999, 2000, 2001 Free Software Foundation,
2 Inc.
3
4 This file is free documentation; the Free Software Foundation gives
5 unlimited permission to copy, distribute and modify it.
6
7 Mulberry-specific build instructions are can be found at the bottom of
8 this file.
9
10 Basic Installation
11 ==================
12
13 These are generic installation instructions.
14
15 The `configure' shell script attempts to guess correct values for
16 various system-dependent variables used during compilation. It uses
17 those values to create a `Makefile' in each directory of the package.
18 It may also create one or more `.h' files containing system-dependent
19 definitions. Finally, it creates a shell script `config.status' that
20 you can run in the future to recreate the current configuration, and a
21 file `config.log' containing compiler output (useful mainly for
22 debugging `configure').
23
24 It can also use an optional file (typically called `config.cache'
25 and enabled with `--cache-file=config.cache' or simply `-C') that saves
26 the results of its tests to speed up reconfiguring. (Caching is
27 disabled by default to prevent problems with accidental use of stale
28 cache files.)
29
30 If you need to do unusual things to compile the package, please try
31 to figure out how `configure' could check whether to do them, and mail
32 diffs or instructions to the address given in the `README' so they can
33 be considered for the next release. If you are using the cache, and at
34 some point `config.cache' contains results you don't want to keep, you
35 may remove or edit it.
36
37 The file `configure.ac' (or `configure.in') is used to create
38 `configure' by a program called `autoconf'. You only need
39 `configure.ac' if you want to change it or regenerate `configure' using
40 a newer version of `autoconf'.
41
42 The simplest way to compile this package is:
43
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.
49
50 Running `configure' takes awhile. While running, it prints some
51 messages telling which features it is checking for.
52
53 2. Type `make' to compile the package.
54
55 3. Optionally, type `make check' to run any self-tests that come with
56 the package.
57
58 4. Type `make install' to install the programs and any data files and
59 documentation.
60
61 5. You can remove the program binaries and object files from the
62 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.
69
70 Compilers and Options
71 =====================
72
73 Some systems require unusual options for compilation or linking that
74 the `configure' script does not know about. Run `./configure --help'
75 for details on some of the pertinent environment variables.
76
77 You can give `configure' initial values for variables by setting
78 them in the environment. You can do that on the command line like this:
79
80 ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
81
82 *Note Defining Variables::, for more details.
83
84 Compiling For Multiple Architectures
85 ====================================
86
87 You can compile the package for more than one kind of computer at the
88 same time, by placing the object files for each architecture in their
89 own directory. To do this, you must use a version of `make' that
90 supports the `VPATH' variable, such as GNU `make'. `cd' to the
91 directory where you want the object files and executables to go and run
92 the `configure' script. `configure' automatically checks for the
93 source code in the directory that `configure' is in and in `..'.
94
95 If you have to use a `make' that does not support the `VPATH'
96 variable, you have to compile the package for one architecture at a
97 time in the source code directory. After you have installed the
98 package for one architecture, use `make distclean' before reconfiguring
99 for another architecture.
100
101 Installation Names
102 ==================
103
104 By default, `make install' will install the package's files in
105 `/usr/local/bin', `/usr/local/man', etc. You can specify an
106 installation prefix other than `/usr/local' by giving `configure' the
107 option `--prefix=PATH'.
108
109 You can specify separate installation prefixes for
110 architecture-specific files and architecture-independent files. If you
111 give `configure' the option `--exec-prefix=PATH', the package will use
112 PATH as the prefix for installing programs and libraries.
113 Documentation and other data files will still use the regular prefix.
114
115 In addition, if you use an unusual directory layout you can give
116 options like `--bindir=PATH' to specify different values for particular
117 kinds of files. Run `configure --help' for a list of the directories
118 you can set and what kinds of files go in them.
119
120 If the package supports it, you can cause programs to be installed
121 with an extra prefix or suffix on their names by giving `configure' the
122 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
123
124 Optional Features
125 =================
126
127 Some packages pay attention to `--enable-FEATURE' options to
128 `configure', where FEATURE indicates an optional part of the package.
129 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
130 is something like `gnu-as' or `x' (for the X Window System). The
131 `README' should mention any `--enable-' and `--with-' options that the
132 package recognizes.
133
134 For packages that use the X Window System, `configure' can usually
135 find the X include and library files automatically, but if it doesn't,
136 you can use the `configure' options `--x-includes=DIR' and
137 `--x-libraries=DIR' to specify their locations.
138
139 Specifying the System Type
140 ==========================
141
142 There may be some features `configure' cannot figure out
143 automatically, but needs to determine by the type of host the package
144 will run on. Usually `configure' can figure that out, but if it prints
145 a message saying it cannot guess the host type, give it the
146 `--build=TYPE' option. TYPE can either be a short name for the system
147 type, such as `sun4', or a canonical name which has the form:
148
149 CPU-COMPANY-SYSTEM
150
151 where SYSTEM can have one of these forms:
152
153 OS KERNEL-OS
154
155 See the file `config.sub' for the possible values of each field. If
156 `config.sub' isn't included in this package, then this package doesn't
157 need to know the host type.
158
159 If you are _building_ compiler tools for cross-compiling, you should
160 use the `--target=TYPE' option to select the type of system they will
161 produce code for.
162
163 If you want to _use_ a cross compiler, that generates code for a
164 platform different from the build platform, you should specify the host
165 platform (i.e., that on which the generated programs will eventually be
166 run) with `--host=TYPE'. In this case, you should also specify the
167 build platform with `--build=TYPE', because, in this case, it may not
168 be possible to guess the build platform (it sometimes involves
169 compiling and running simple test programs, and this can't be done if
170 the compiler is a cross compiler).
171
172 Sharing Defaults
173 ================
174
175 If you want to set default values for `configure' scripts to share,
176 you can create a site shell script called `config.site' that gives
177 default values for variables like `CC', `cache_file', and `prefix'.
178 `configure' looks for `PREFIX/share/config.site' if it exists, then
179 `PREFIX/etc/config.site' if it exists. Or, you can set the
180 `CONFIG_SITE' environment variable to the location of the site script.
181 A warning: not all `configure' scripts look for a site script.
182
183 Defining Variables
184 ==================
185
186 Variables not defined in a site shell script can be set in the
187 environment passed to `configure'. However, some packages may run
188 configure again during the build, and the customized values of these
189 variables may be lost. In order to avoid this problem, you should set
190 them in the `configure' command line, using `VAR=value'. For example:
191
192 ./configure CC=/usr/local2/bin/gcc
193
194 will cause the specified gcc to be used as the C compiler (unless it is
195 overridden in the site shell script).
196
197 `configure' Invocation
198 ======================
199
200 `configure' recognizes the following options to control how it
201 operates.
202
203 `--help'
204 `-h'
205 Print a summary of the options to `configure', and exit.
206
207 `--version'
208 `-V'
209 Print the version of Autoconf used to generate the `configure'
210 script, and exit.
211
212 `--cache-file=FILE'
213 Enable the cache: use and save the results of the tests in FILE,
214 traditionally `config.cache'. FILE defaults to `/dev/null' to
215 disable caching.
216
217 `--config-cache'
218 `-C'
219 Alias for `--cache-file=config.cache'.
220
221 `--quiet'
222 `--silent'
223 `-q'
224 Do not print messages saying which checks are being made. To
225 suppress all normal output, redirect it to `/dev/null' (any error
226 messages will still be shown).
227
228 `--srcdir=DIR'
229 Look for the package's source code in directory DIR. Usually
230 `configure' can determine that directory automatically.
231
232 `configure' also accepts some other, not widely useful, options. Run
233 `configure --help' for more details.
234
235
236 Mulberry specific build instructions
237 ====================================
238
239 There is a `configure' script provided with the sources. This file is
240 generated from `configure.in', simply by invoking `autoconf'. During
241 the configure process there will be some include paths generated from
242 the directory in which `configure' is run. This means that after the
243 makefiles have been created by the script, they will contain some
244 absolute paths to the build directory. Thus, when moving the build
245 directory to a different place in the file system, `configure' needs
246 to be invoked again before building.
247
248 The configure script generated for building mulberry supports a number
249 of additional flags.
250
251 These flags control the way mulberry is installed:
252
253 --with-mulberry-dir
254
255 Specify location relative to the prefix where mulberry plugins
256 go (default: .mulberry).
257
258 --with-help-dir
259
260 Specify location relative to the prefix where mulberry
261 documentation files go (default: .mulberry)
262
263 --with-program-dir
264
265 Specify location relative to the prefix where the mulberry
266 program goes (default: '')
267
268
269 By default, the mulberry binary will be installed in your $HOME
270 directory. Documentation, plugins and resources will go to
271 $HOME/.mulberry/.
272
273 For a system-wide installation, you may want to run configure like
274 this:
275
276 ./configure --prefix=/usr/local --with-mulberry-dir=lib/mulberry \
277 --with-help-dir=share/doc/mulberry --with-program-dir=bin
278
279 The Makefiles also honor the DESTDIR variable which is prepended to
280 the prefix without a slash if overridden at invocation.
281
282 Mulberry will not build without OpenSSL and LDAP headers and libs.
283 Other features are optional, i.e. if not found the corresponding
284 features (plugins) will be disabled and not built. You can help
285 configure finding those features if they are not located in the
286 default places on your system:
287
288 --with-ldap-include Specify location of LDAP headers
289 --with-ldap-libs Specify link args for LDAP
290 --with-openssl-include Specify location of openssl headers
291 --with-openssl-libs Specify link args for openssl
292 --with-krb4-include Specify location of kerberos4 headers
293 --with-krb4-libs Specify link args for kerberos4
294 --with-krb5-include Specify location of kerberos5 headers
295 --with-krb5-libs Specify link args for kerberos5
296 --with-aspell-include Specify location of aspell headers
297 --with-aspell-libs Specify link args for aspell
298 --with-extra-cppflags Specify additional C preprocessor options
299
300 The switches for include paths accept both compiler switches, e.g.
301 "-I/foo/bar -I/baz" or simply a directory, e.g. "/usr/include/foo".
302 The switches for libs expect link args, like "-L/foo/bar -lbaz" which
303 will be passed directly to the linker.
304
305 For compiling the software, simply type `make'. A few cups of coffee
306 later you may find the mulberry binary in the `Linux/' directory, also
307 the different plugins in their own subdirectories under `Plug-ins'.
308
309 To install the program, you may either want to run `make install'. To
310 speed things up, after a successful build you may also add `SKIPJX="yes"'
311 to your `make' command line, so that the time consuming recursion into
312 the JX library is skipped.
313
314 The tar archive for distribution is generated using `make archive'.
Something went wrong with that request. Please try again.