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