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