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