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