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