/[public]/psiconv/trunk/INSTALL
ViewVC logotype

Diff of /psiconv/trunk/INSTALL

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 254 Revision 346
1Installation Instructions 1Installation Instructions
2************************* 2*************************
3 3
4Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004 Free 4Copyright (C) 1994-1996, 1999-2002, 2004-2011 Free Software Foundation,
5Software Foundation, Inc. 5Inc.
6 6
7This file is free documentation; the Free Software Foundation gives 7 Copying and distribution of this file, with or without modification,
8unlimited permission to copy, distribute and modify it. 8are permitted in any medium without royalty provided the copyright
9notice and this notice are preserved. This file is offered as-is,
10without warranty of any kind.
9 11
10Basic Installation 12Basic Installation
11================== 13==================
12 14
13These are generic installation instructions. 15 Briefly, the shell commands `./configure; make; make install' should
16configure, build, and install this package. The following
17more-detailed instructions are generic; see the `README' file for
18instructions specific to this package. Some packages provide this
19`INSTALL' file but do not implement all of the features documented
20below. The lack of an optional feature in a given package is not
21necessarily a bug. More recommendations for GNU packages can be found
22in *note Makefile Conventions: (standards)Makefile Conventions.
14 23
15 The `configure' shell script attempts to guess correct values for 24 The `configure' shell script attempts to guess correct values for
16various system-dependent variables used during compilation. It uses 25various system-dependent variables used during compilation. It uses
17those values to create a `Makefile' in each directory of the package. 26those values to create a `Makefile' in each directory of the package.
18It may also create one or more `.h' files containing system-dependent 27It may also create one or more `.h' files containing system-dependent
21file `config.log' containing compiler output (useful mainly for 30file `config.log' containing compiler output (useful mainly for
22debugging `configure'). 31debugging `configure').
23 32
24 It can also use an optional file (typically called `config.cache' 33 It can also use an optional file (typically called `config.cache'
25and enabled with `--cache-file=config.cache' or simply `-C') that saves 34and enabled with `--cache-file=config.cache' or simply `-C') that saves
26the results of its tests to speed up reconfiguring. (Caching is 35the results of its tests to speed up reconfiguring. Caching is
27disabled by default to prevent problems with accidental use of stale 36disabled by default to prevent problems with accidental use of stale
28cache files.) 37cache files.
29 38
30 If you need to do unusual things to compile the package, please try 39 If you need to do unusual things to compile the package, please try
31to figure out how `configure' could check whether to do them, and mail 40to figure out how `configure' could check whether to do them, and mail
32diffs or instructions to the address given in the `README' so they can 41diffs or instructions to the address given in the `README' so they can
33be considered for the next release. If you are using the cache, and at 42be considered for the next release. If you are using the cache, and at
34some point `config.cache' contains results you don't want to keep, you 43some point `config.cache' contains results you don't want to keep, you
35may remove or edit it. 44may remove or edit it.
36 45
37 The file `configure.ac' (or `configure.in') is used to create 46 The file `configure.ac' (or `configure.in') is used to create
38`configure' by a program called `autoconf'. You only need 47`configure' by a program called `autoconf'. You need `configure.ac' if
39`configure.ac' if you want to change it or regenerate `configure' using 48you want to change it or regenerate `configure' using a newer version
40a newer version of `autoconf'. 49of `autoconf'.
41 50
42The simplest way to compile this package is: 51 The simplest way to compile this package is:
43 52
44 1. `cd' to the directory containing the package's source code and type 53 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 54 `./configure' to configure the package for your system.
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 55
50 Running `configure' takes awhile. While running, it prints some 56 Running `configure' might take a while. While running, it prints
51 messages telling which features it is checking for. 57 some messages telling which features it is checking for.
52 58
53 2. Type `make' to compile the package. 59 2. Type `make' to compile the package.
54 60
55 3. Optionally, type `make check' to run any self-tests that come with 61 3. Optionally, type `make check' to run any self-tests that come with
56 the package. 62 the package, generally using the just-built uninstalled binaries.
57 63
58 4. Type `make install' to install the programs and any data files and 64 4. Type `make install' to install the programs and any data files and
59 documentation. 65 documentation. When installing into a prefix owned by root, it is
66 recommended that the package be configured and built as a regular
67 user, and only the `make install' phase executed with root
68 privileges.
60 69
70 5. Optionally, type `make installcheck' to repeat any self-tests, but
71 this time using the binaries in their final installed location.
72 This target does not install anything. Running this target as a
73 regular user, particularly if the prior `make install' required
74 root privileges, verifies that the installation completed
75 correctly.
76
61 5. You can remove the program binaries and object files from the 77 6. You can remove the program binaries and object files from the
62 source code directory by typing `make clean'. To also remove the 78 source code directory by typing `make clean'. To also remove the
63 files that `configure' created (so you can compile the package for 79 files that `configure' created (so you can compile the package for
64 a different kind of computer), type `make distclean'. There is 80 a different kind of computer), type `make distclean'. There is
65 also a `make maintainer-clean' target, but that is intended mainly 81 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 82 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 83 all sorts of other programs in order to regenerate files that came
68 with the distribution. 84 with the distribution.
69 85
86 7. Often, you can also type `make uninstall' to remove the installed
87 files again. In practice, not all packages have tested that
88 uninstallation works correctly, even though it is required by the
89 GNU Coding Standards.
90
91 8. Some packages, particularly those that use Automake, provide `make
92 distcheck', which can by used by developers to test that all other
93 targets like `make install' and `make uninstall' work correctly.
94 This target is generally not run by end users.
95
70Compilers and Options 96Compilers and Options
71===================== 97=====================
72 98
73Some systems require unusual options for compilation or linking that the 99 Some systems require unusual options for compilation or linking that
74`configure' script does not know about. Run `./configure --help' for 100the `configure' script does not know about. Run `./configure --help'
75details on some of the pertinent environment variables. 101for details on some of the pertinent environment variables.
76 102
77 You can give `configure' initial values for configuration parameters 103 You can give `configure' initial values for configuration parameters
78by setting variables in the command line or in the environment. Here 104by setting variables in the command line or in the environment. Here
79is an example: 105is an example:
80 106
81 ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix 107 ./configure CC=c99 CFLAGS=-g LIBS=-lposix
82 108
83 *Note Defining Variables::, for more details. 109 *Note Defining Variables::, for more details.
84 110
85Compiling For Multiple Architectures 111Compiling For Multiple Architectures
86==================================== 112====================================
87 113
88You can compile the package for more than one kind of computer at the 114 You can compile the package for more than one kind of computer at the
89same time, by placing the object files for each architecture in their 115same time, by placing the object files for each architecture in their
90own directory. To do this, you must use a version of `make' that 116own directory. To do this, you can use GNU `make'. `cd' to the
91supports the `VPATH' variable, such as GNU `make'. `cd' to the
92directory where you want the object files and executables to go and run 117directory where you want the object files and executables to go and run
93the `configure' script. `configure' automatically checks for the 118the `configure' script. `configure' automatically checks for the
94source code in the directory that `configure' is in and in `..'. 119source code in the directory that `configure' is in and in `..'. This
120is known as a "VPATH" build.
95 121
96 If you have to use a `make' that does not support the `VPATH' 122 With a non-GNU `make', it is safer to compile the package for one
97variable, you have to compile the package for one architecture at a
98time in the source code directory. After you have installed the 123architecture at a time in the source code directory. After you have
99package for one architecture, use `make distclean' before reconfiguring 124installed the package for one architecture, use `make distclean' before
100for another architecture. 125reconfiguring for another architecture.
126
127 On MacOS X 10.5 and later systems, you can create libraries and
128executables that work on multiple system types--known as "fat" or
129"universal" binaries--by specifying multiple `-arch' options to the
130compiler but only a single `-arch' option to the preprocessor. Like
131this:
132
133 ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
134 CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
135 CPP="gcc -E" CXXCPP="g++ -E"
136
137 This is not guaranteed to produce working output in all cases, you
138may have to build one architecture at a time and combine the results
139using the `lipo' tool if you have problems.
101 140
102Installation Names 141Installation Names
103================== 142==================
104 143
105By default, `make install' will install the package's files in 144 By default, `make install' installs the package's commands under
106`/usr/local/bin', `/usr/local/man', etc. You can specify an 145`/usr/local/bin', include files under `/usr/local/include', etc. You
107installation prefix other than `/usr/local' by giving `configure' the 146can specify an installation prefix other than `/usr/local' by giving
108option `--prefix=PREFIX'. 147`configure' the option `--prefix=PREFIX', where PREFIX must be an
148absolute file name.
109 149
110 You can specify separate installation prefixes for 150 You can specify separate installation prefixes for
111architecture-specific files and architecture-independent files. If you 151architecture-specific files and architecture-independent files. If you
112give `configure' the option `--exec-prefix=PREFIX', the package will 152pass the option `--exec-prefix=PREFIX' to `configure', the package uses
113use PREFIX as the prefix for installing programs and libraries. 153PREFIX as the prefix for installing programs and libraries.
114Documentation and other data files will still use the regular prefix. 154Documentation and other data files still use the regular prefix.
115 155
116 In addition, if you use an unusual directory layout you can give 156 In addition, if you use an unusual directory layout you can give
117options like `--bindir=DIR' to specify different values for particular 157options like `--bindir=DIR' to specify different values for particular
118kinds of files. Run `configure --help' for a list of the directories 158kinds of files. Run `configure --help' for a list of the directories
119you can set and what kinds of files go in them. 159you can set and what kinds of files go in them. In general, the
160default for these options is expressed in terms of `${prefix}', so that
161specifying just `--prefix' will affect all of the other directory
162specifications that were not explicitly provided.
163
164 The most portable way to affect installation locations is to pass the
165correct locations to `configure'; however, many packages provide one or
166both of the following shortcuts of passing variable assignments to the
167`make install' command line to change installation locations without
168having to reconfigure or recompile.
169
170 The first method involves providing an override variable for each
171affected directory. For example, `make install
172prefix=/alternate/directory' will choose an alternate location for all
173directory configuration variables that were expressed in terms of
174`${prefix}'. Any directories that were specified during `configure',
175but not in terms of `${prefix}', must each be overridden at install
176time for the entire installation to be relocated. The approach of
177makefile variable overrides for each directory variable is required by
178the GNU Coding Standards, and ideally causes no recompilation.
179However, some platforms have known limitations with the semantics of
180shared libraries that end up requiring recompilation when using this
181method, particularly noticeable in packages that use GNU Libtool.
182
183 The second method involves providing the `DESTDIR' variable. For
184example, `make install DESTDIR=/alternate/directory' will prepend
185`/alternate/directory' before all installation names. The approach of
186`DESTDIR' overrides is not required by the GNU Coding Standards, and
187does not work on platforms that have drive letters. On the other hand,
188it does better at avoiding recompilation issues, and works well even
189when some directory options were not specified in terms of `${prefix}'
190at `configure' time.
191
192Optional Features
193=================
120 194
121 If the package supports it, you can cause programs to be installed 195 If the package supports it, you can cause programs to be installed
122with an extra prefix or suffix on their names by giving `configure' the 196with an extra prefix or suffix on their names by giving `configure' the
123option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. 197option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
124 198
125Optional Features
126=================
127
128Some packages pay attention to `--enable-FEATURE' options to 199 Some packages pay attention to `--enable-FEATURE' options to
129`configure', where FEATURE indicates an optional part of the package. 200`configure', where FEATURE indicates an optional part of the package.
130They may also pay attention to `--with-PACKAGE' options, where PACKAGE 201They may also pay attention to `--with-PACKAGE' options, where PACKAGE
131is something like `gnu-as' or `x' (for the X Window System). The 202is something like `gnu-as' or `x' (for the X Window System). The
132`README' should mention any `--enable-' and `--with-' options that the 203`README' should mention any `--enable-' and `--with-' options that the
133package recognizes. 204package recognizes.
135 For packages that use the X Window System, `configure' can usually 206 For packages that use the X Window System, `configure' can usually
136find the X include and library files automatically, but if it doesn't, 207find the X include and library files automatically, but if it doesn't,
137you can use the `configure' options `--x-includes=DIR' and 208you can use the `configure' options `--x-includes=DIR' and
138`--x-libraries=DIR' to specify their locations. 209`--x-libraries=DIR' to specify their locations.
139 210
211 Some packages offer the ability to configure how verbose the
212execution of `make' will be. For these packages, running `./configure
213--enable-silent-rules' sets the default to minimal output, which can be
214overridden with `make V=1'; while running `./configure
215--disable-silent-rules' sets the default to verbose, which can be
216overridden with `make V=0'.
217
218Particular systems
219==================
220
221 On HP-UX, the default C compiler is not ANSI C compatible. If GNU
222CC is not installed, it is recommended to use the following options in
223order to use an ANSI C compiler:
224
225 ./configure CC="cc -Ae -D_XOPEN_SOURCE=500"
226
227and if that doesn't work, install pre-built binaries of GCC for HP-UX.
228
229 HP-UX `make' updates targets which have the same time stamps as
230their prerequisites, which makes it generally unusable when shipped
231generated files such as `configure' are involved. Use GNU `make'
232instead.
233
234 On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
235parse its `<wchar.h>' header file. The option `-nodtk' can be used as
236a workaround. If GNU CC is not installed, it is therefore recommended
237to try
238
239 ./configure CC="cc"
240
241and if that doesn't work, try
242
243 ./configure CC="cc -nodtk"
244
245 On Solaris, don't put `/usr/ucb' early in your `PATH'. This
246directory contains several dysfunctional programs; working variants of
247these programs are available in `/usr/bin'. So, if you need `/usr/ucb'
248in your `PATH', put it _after_ `/usr/bin'.
249
250 On Haiku, software installed for all users goes in `/boot/common',
251not `/usr/local'. It is recommended to use the following options:
252
253 ./configure --prefix=/boot/common
254
140Specifying the System Type 255Specifying the System Type
141========================== 256==========================
142 257
143There may be some features `configure' cannot figure out automatically, 258 There may be some features `configure' cannot figure out
144but needs to determine by the type of machine the package will run on. 259automatically, but needs to determine by the type of machine the package
145Usually, assuming the package is built to be run on the _same_ 260will run on. Usually, assuming the package is built to be run on the
146architectures, `configure' can figure that out, but if it prints a 261_same_ architectures, `configure' can figure that out, but if it prints
147message saying it cannot guess the machine type, give it the 262a message saying it cannot guess the machine type, give it the
148`--build=TYPE' option. TYPE can either be a short name for the system 263`--build=TYPE' option. TYPE can either be a short name for the system
149type, such as `sun4', or a canonical name which has the form: 264type, such as `sun4', or a canonical name which has the form:
150 265
151 CPU-COMPANY-SYSTEM 266 CPU-COMPANY-SYSTEM
152 267
153where SYSTEM can have one of these forms: 268where SYSTEM can have one of these forms:
154 269
270 OS
155 OS KERNEL-OS 271 KERNEL-OS
156 272
157 See the file `config.sub' for the possible values of each field. If 273 See the file `config.sub' for the possible values of each field. If
158`config.sub' isn't included in this package, then this package doesn't 274`config.sub' isn't included in this package, then this package doesn't
159need to know the machine type. 275need to know the machine type.
160 276
161 If you are _building_ compiler tools for cross-compiling, you should 277 If you are _building_ compiler tools for cross-compiling, you should
162use the `--target=TYPE' option to select the type of system they will 278use the option `--target=TYPE' to select the type of system they will
163produce code for. 279produce code for.
164 280
165 If you want to _use_ a cross compiler, that generates code for a 281 If you want to _use_ a cross compiler, that generates code for a
166platform different from the build platform, you should specify the 282platform different from the build platform, you should specify the
167"host" platform (i.e., that on which the generated programs will 283"host" platform (i.e., that on which the generated programs will
168eventually be run) with `--host=TYPE'. 284eventually be run) with `--host=TYPE'.
169 285
170Sharing Defaults 286Sharing Defaults
171================ 287================
172 288
173If you want to set default values for `configure' scripts to share, you 289 If you want to set default values for `configure' scripts to share,
174can create a site shell script called `config.site' that gives default 290you can create a site shell script called `config.site' that gives
175values for variables like `CC', `cache_file', and `prefix'. 291default values for variables like `CC', `cache_file', and `prefix'.
176`configure' looks for `PREFIX/share/config.site' if it exists, then 292`configure' looks for `PREFIX/share/config.site' if it exists, then
177`PREFIX/etc/config.site' if it exists. Or, you can set the 293`PREFIX/etc/config.site' if it exists. Or, you can set the
178`CONFIG_SITE' environment variable to the location of the site script. 294`CONFIG_SITE' environment variable to the location of the site script.
179A warning: not all `configure' scripts look for a site script. 295A warning: not all `configure' scripts look for a site script.
180 296
181Defining Variables 297Defining Variables
182================== 298==================
183 299
184Variables not defined in a site shell script can be set in the 300 Variables not defined in a site shell script can be set in the
185environment passed to `configure'. However, some packages may run 301environment passed to `configure'. However, some packages may run
186configure again during the build, and the customized values of these 302configure again during the build, and the customized values of these
187variables may be lost. In order to avoid this problem, you should set 303variables may be lost. In order to avoid this problem, you should set
188them in the `configure' command line, using `VAR=value'. For example: 304them in the `configure' command line, using `VAR=value'. For example:
189 305
190 ./configure CC=/usr/local2/bin/gcc 306 ./configure CC=/usr/local2/bin/gcc
191 307
192will cause the specified gcc to be used as the C compiler (unless it is 308causes the specified `gcc' to be used as the C compiler (unless it is
193overridden in the site shell script). 309overridden in the site shell script).
310
311Unfortunately, this technique does not work for `CONFIG_SHELL' due to
312an Autoconf bug. Until the bug is fixed you can use this workaround:
313
314 CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
194 315
195`configure' Invocation 316`configure' Invocation
196====================== 317======================
197 318
198`configure' recognizes the following options to control how it operates. 319 `configure' recognizes the following options to control how it
320operates.
199 321
200`--help' 322`--help'
201`-h' 323`-h'
202 Print a summary of the options to `configure', and exit. 324 Print a summary of all of the options to `configure', and exit.
325
326`--help=short'
327`--help=recursive'
328 Print a summary of the options unique to this package's
329 `configure', and exit. The `short' variant lists options used
330 only in the top level, while the `recursive' variant lists options
331 also present in any nested packages.
203 332
204`--version' 333`--version'
205`-V' 334`-V'
206 Print the version of Autoconf used to generate the `configure' 335 Print the version of Autoconf used to generate the `configure'
207 script, and exit. 336 script, and exit.
224 353
225`--srcdir=DIR' 354`--srcdir=DIR'
226 Look for the package's source code in directory DIR. Usually 355 Look for the package's source code in directory DIR. Usually
227 `configure' can determine that directory automatically. 356 `configure' can determine that directory automatically.
228 357
358`--prefix=DIR'
359 Use DIR as the installation prefix. *note Installation Names::
360 for more details, including other options available for fine-tuning
361 the installation locations.
362
363`--no-create'
364`-n'
365 Run the configure checks, but stop before creating any output
366 files.
367
229`configure' also accepts some other, not widely useful, options. Run 368`configure' also accepts some other, not widely useful, options. Run
230`configure --help' for more details. 369`configure --help' for more details.
231 370

Legend:
Removed from v.254  
changed lines
  Added in v.346

frodo@frodo.looijaard.name
ViewVC Help
Powered by ViewVC 1.1.26