annotate INSTALL @ 2104:3e7e5395f0bc

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