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