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