bug fixes
[gnupg.git] / INSTALL
1
2 Please read the Basic Installation section somewhere below.
3
4 Configure options for GNUPG
5 ===========================
6
7 --with-included-zlib Forces usage of the local zlib sources. Default is
8                      to use the (shared) library of the system.
9
10 --disable-nls       Disable NLS support (See ABOUT-NLS)
11
12 --enable-m-debug    Compile with the integrated malloc debugging stuff.
13                     This makes the program slower but is checks every
14                     free operation and can be used to create statistics
15                     of memory usage. If this option is used the program
16                     option "--debug 32" displays every call to a a malloc
17                     function (this makes the program *really* slow), the
18                     option "--debug 128" displays a memory statistic after
19                     the program run.
20
21 --disable-m-guard   Disable the integrated malloc checking code. As a
22                     side-effect, this removes all debugging code and uses
23                     the -O2 flag for all C files.
24
25
26 Problems
27 ========
28
29 If you have compile problems, use the configure options "--with-zlib" and
30 "--disable-nls" (See ABOUT-NLS).
31
32 I cant check all assembler files; so if you have problems assembling them
33 (or the program crashes), simply delete the files in the mpi/<cpu> directory.
34 The configure scripts may consider several subdirectories to get all
35 available assembler files; be sure to delete the correct ones. The
36 assembler replacements are in C and in mpi/generic; never delete udiv-qrnnd.S
37 in any CPU directory, because there maybe no C substitute.
38 Don't forget to delete "config.cache" and run "./config.status --recheck".
39
40
41 The Random Device
42 =================
43 The current version of GNUPG needs the support of a random device.
44 If there is no such device, it uses a very simple RNG, which does
45 not generate strong random numbers.
46 Random devices are available in Linux, FreeBSD and OpenBSD.
47 The device files may not exist on your system, please check this
48 and create them if needed.
49
50 The Linux files should look like this:
51     cr--r--r--   1 root     sys        1,   8 May 28  1997 /dev/random
52     cr--r--r--   1 root     sys        1,   9 Feb 16 08:23 /dev/urandom
53 You can create them with:
54     mknod /dev/random c 1 8
55     mknod /dev/random c 1 8
56
57 The FreeBSD files [from the 970202 snapshot]:
58     crw-r--r--  1 root  wheel    2,   3 Feb 25 16:54 /dev/random
59     crw-r--r--  1 root  wheel    2,   4 Feb 25 16:54 /dev/urandom
60 You can create them with:
61     mknod /dev/random  c 2 3
62     mknod /dev/urandom c 2 4
63
64
65
66 Installation
67 ============
68 gpg is not installed as suid:root; if you want to do it, do it manually.
69
70 The ~/.gnupg directory will be created if it does not exist.  Your first
71 action should be to create a key pair: "gpg --gen-key".
72
73
74
75 Basic Installation
76 ==================
77
78    These are generic installation instructions.
79
80    The `configure' shell script attempts to guess correct values for
81 various system-dependent variables used during compilation.  It uses
82 those values to create a `Makefile' in each directory of the package.
83 It may also create one or more `.h' files containing system-dependent
84 definitions.  Finally, it creates a shell script `config.status' that
85 you can run in the future to recreate the current configuration, a file
86 `config.cache' that saves the results of its tests to speed up
87 reconfiguring, and a file `config.log' containing compiler output
88 (useful mainly for debugging `configure').
89
90    If you need to do unusual things to compile the package, please try
91 to figure out how `configure' could check whether to do them, and mail
92 diffs or instructions to the address given in the `README' so they can
93 be considered for the next release.  If at some point `config.cache'
94 contains results you don't want to keep, you may remove or edit it.
95
96    The file `configure.in' is used to create `configure' by a program
97 called `autoconf'.  You only need `configure.in' if you want to change
98 it or regenerate `configure' using a newer version of `autoconf'.
99
100 The simplest way to compile this package is:
101
102   1. `cd' to the directory containing the package's source code and type
103      `./configure' to configure the package for your system.  If you're
104      using `csh' on an old version of System V, you might need to type
105      `sh ./configure' instead to prevent `csh' from trying to execute
106      `configure' itself.
107
108      Running `configure' takes awhile.  While running, it prints some
109      messages telling which features it is checking for.
110
111   2. Type `make' to compile the package.
112
113   3. Optionally, type `make check' to run any self-tests that come with
114      the package.
115
116   4. Type `make install' to install the programs and any data files and
117      documentation.
118
119   5. You can remove the program binaries and object files from the
120      source code directory by typing `make clean'.  To also remove the
121      files that `configure' created (so you can compile the package for
122      a different kind of computer), type `make distclean'.  There is
123      also a `make maintainer-clean' target, but that is intended mainly
124      for the package's developers.  If you use it, you may have to get
125      all sorts of other programs in order to regenerate files that came
126      with the distribution.
127
128 Compilers and Options
129 =====================
130
131    Some systems require unusual options for compilation or linking that
132 the `configure' script does not know about.  You can give `configure'
133 initial values for variables by setting them in the environment.  Using
134 a Bourne-compatible shell, you can do that on the command line like
135 this:
136      CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
137
138 Or on systems that have the `env' program, you can do it like this:
139      env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
140
141 Compiling For Multiple Architectures
142 ====================================
143
144    You can compile the package for more than one kind of computer at the
145 same time, by placing the object files for each architecture in their
146 own directory.  To do this, you must use a version of `make' that
147 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
148 directory where you want the object files and executables to go and run
149 the `configure' script.  `configure' automatically checks for the
150 source code in the directory that `configure' is in and in `..'.
151
152    If you have to use a `make' that does not supports the `VPATH'
153 variable, you have to compile the package for one architecture at a time
154 in the source code directory.  After you have installed the package for
155 one architecture, use `make distclean' before reconfiguring for another
156 architecture.
157
158 Installation Names
159 ==================
160
161    By default, `make install' will install the package's files in
162 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
163 installation prefix other than `/usr/local' by giving `configure' the
164 option `--prefix=PATH'.
165
166    You can specify separate installation prefixes for
167 architecture-specific files and architecture-independent files.  If you
168 give `configure' the option `--exec-prefix=PATH', the package will use
169 PATH as the prefix for installing programs and libraries.
170 Documentation and other data files will still use the regular prefix.
171
172    In addition, if you use an unusual directory layout you can give
173 options like `--bindir=PATH' to specify different values for particular
174 kinds of files.  Run `configure --help' for a list of the directories
175 you can set and what kinds of files go in them.
176
177    If the package supports it, you can cause programs to be installed
178 with an extra prefix or suffix on their names by giving `configure' the
179 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
180
181 Optional Features
182 =================
183
184    Some packages pay attention to `--enable-FEATURE' options to
185 `configure', where FEATURE indicates an optional part of the package.
186 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
187 is something like `gnu-as' or `x' (for the X Window System).  The
188 `README' should mention any `--enable-' and `--with-' options that the
189 package recognizes.
190
191    For packages that use the X Window System, `configure' can usually
192 find the X include and library files automatically, but if it doesn't,
193 you can use the `configure' options `--x-includes=DIR' and
194 `--x-libraries=DIR' to specify their locations.
195
196 Specifying the System Type
197 ==========================
198
199    There may be some features `configure' can not figure out
200 automatically, but needs to determine by the type of host the package
201 will run on.  Usually `configure' can figure that out, but if it prints
202 a message saying it can not guess the host type, give it the
203 `--host=TYPE' option.  TYPE can either be a short name for the system
204 type, such as `sun4', or a canonical name with three fields:
205      CPU-COMPANY-SYSTEM
206
207 See the file `config.sub' for the possible values of each field.  If
208 `config.sub' isn't included in this package, then this package doesn't
209 need to know the host type.
210
211    If you are building compiler tools for cross-compiling, you can also
212 use the `--target=TYPE' option to select the type of system they will
213 produce code for and the `--build=TYPE' option to select the type of
214 system on which you are compiling the package.
215
216 Sharing Defaults
217 ================
218
219    If you want to set default values for `configure' scripts to share,
220 you can create a site shell script called `config.site' that gives
221 default values for variables like `CC', `cache_file', and `prefix'.
222 `configure' looks for `PREFIX/share/config.site' if it exists, then
223 `PREFIX/etc/config.site' if it exists.  Or, you can set the
224 `CONFIG_SITE' environment variable to the location of the site script.
225 A warning: not all `configure' scripts look for a site script.
226
227 Operation Controls
228 ==================
229
230    `configure' recognizes the following options to control how it
231 operates.
232
233 `--cache-file=FILE'
234      Use and save the results of the tests in FILE instead of
235      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
236      debugging `configure'.
237
238 `--help'
239      Print a summary of the options to `configure', and exit.
240
241 `--quiet'
242 `--silent'
243 `-q'
244      Do not print messages saying which checks are being made.  To
245      suppress all normal output, redirect it to `/dev/null' (any error
246      messages will still be shown).
247
248 `--srcdir=DIR'
249      Look for the package's source code in directory DIR.  Usually
250      `configure' can determine that directory automatically.
251
252 `--version'
253      Print the version of Autoconf used to generate the `configure'
254      script, and exit.
255
256 `configure' also accepts some other, not widely useful, options.
257