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