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