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