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