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