* gpgmeplug.c (signMessage): Fixed offbyone. Don't include the
[gpgme.git] / INSTALL
1 Installation Instructions for GPGME
2 ===================================
3
4  Copyright 2001 g10 Code GmbH
5
6  This file is free software; as a special exception the author gives
7  unlimited permission to copy and/or distribute it, with or without
8  modifications, as long as this notice is preserved.
9
10  This file is distributed in the hope that it will be useful, but
11  WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
12  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13
14
15 Basic Installation
16 ==================
17
18    These are generic installation instructions.
19
20    The `configure' shell script attempts to guess correct values for
21 various system-dependent variables used during compilation.  It uses
22 those values to create a `Makefile' in each directory of the package.
23 It may also create one or more `.h' files containing system-dependent
24 definitions.  Finally, it creates a shell script `config.status' that
25 you can run in the future to recreate the current configuration, a file
26 `config.cache' that saves the results of its tests to speed up
27 reconfiguring, and a file `config.log' containing compiler output
28 (useful mainly for debugging `configure').
29
30    If you need to do unusual things to compile the package, please try
31 to figure out how `configure' could check whether to do them, and mail
32 diffs or instructions to the address given in the `README' so they can
33 be considered for the next release.  If at some point `config.cache'
34 contains results you don't want to keep, you may remove or edit it.
35
36    The file `configure.in' is used to create `configure' by a program
37 called `autoconf'.  You only need `configure.in' if you want to change
38 it or regenerate `configure' using a newer version of `autoconf'.
39
40 The simplest way to compile this package is:
41
42   1. `cd' to the directory containing the package's source code and type
43      `./configure' to configure the package for your system.  If you're
44      using `csh' on an old version of System V, you might need to type
45      `sh ./configure' instead to prevent `csh' from trying to execute
46      `configure' itself.
47
48      Running `configure' takes awhile.  While running, it prints some
49      messages telling which features it is checking for.
50
51   2. Type `make' to compile the package.
52
53   3. Optionally, type `make check' to run any self-tests that come with
54      the package.
55
56   4. Type `make install' to install the programs and any data files and
57      documentation.
58
59   5. You can remove the program binaries and object files from the
60      source code directory by typing `make clean'.  To also remove the
61      files that `configure' created (so you can compile the package for
62      a different kind of computer), type `make distclean'.  There is
63      also a `make maintainer-clean' target, but that is intended mainly
64      for the package's developers.  If you use it, you may have to get
65      all sorts of other programs in order to regenerate files that came
66      with the distribution.
67
68 Compilers and Options
69 =====================
70
71    Some systems require unusual options for compilation or linking that
72 the `configure' script does not know about.  You can give `configure'
73 initial values for variables by setting them in the environment.  Using
74 a Bourne-compatible shell, you can do that on the command line like
75 this:
76      CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
77
78 Or on systems that have the `env' program, you can do it like this:
79      env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
80
81 Compiling For Multiple Architectures
82 ====================================
83
84    You can compile the package for more than one kind of computer at the
85 same time, by placing the object files for each architecture in their
86 own directory.  To do this, you must use a version of `make' that
87 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
88 directory where you want the object files and executables to go and run
89 the `configure' script.  `configure' automatically checks for the
90 source code in the directory that `configure' is in and in `..'.
91
92    If you have to use a `make' that does not supports the `VPATH'
93 variable, you have to compile the package for one architecture at a time
94 in the source code directory.  After you have installed the package for
95 one architecture, use `make distclean' before reconfiguring for another
96 architecture.
97
98 Installation Names
99 ==================
100
101    By default, `make install' will install the package's files in
102 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
103 installation prefix other than `/usr/local' by giving `configure' the
104 option `--prefix=PATH'.
105
106    You can specify separate installation prefixes for
107 architecture-specific files and architecture-independent files.  If you
108 give `configure' the option `--exec-prefix=PATH', the package will use
109 PATH as the prefix for installing programs and libraries.
110 Documentation and other data files will still use the regular prefix.
111
112    In addition, if you use an unusual directory layout you can give
113 options like `--bindir=PATH' to specify different values for particular
114 kinds of files.  Run `configure --help' for a list of the directories
115 you can set and what kinds of files go in them.
116
117    If the package supports it, you can cause programs to be installed
118 with an extra prefix or suffix on their names by giving `configure' the
119 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
120
121 Optional Features
122 =================
123
124    Some packages pay attention to `--enable-FEATURE' options to
125 `configure', where FEATURE indicates an optional part of the package.
126 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
127 is something like `gnu-as' or `x' (for the X Window System).  The
128 `README' should mention any `--enable-' and `--with-' options that the
129 package recognizes.
130
131    For packages that use the X Window System, `configure' can usually
132 find the X include and library files automatically, but if it doesn't,
133 you can use the `configure' options `--x-includes=DIR' and
134 `--x-libraries=DIR' to specify their locations.
135
136 Specifying the System Type
137 ==========================
138
139    There may be some features `configure' can not figure out
140 automatically, but needs to determine by the type of host the package
141 will run on.  Usually `configure' can figure that out, but if it prints
142 a message saying it can not guess the host type, give it the
143 `--host=TYPE' option.  TYPE can either be a short name for the system
144 type, such as `sun4', or a canonical name with three fields:
145      CPU-COMPANY-SYSTEM
146
147 See the file `config.sub' for the possible values of each field.  If
148 `config.sub' isn't included in this package, then this package doesn't
149 need to know the host type.
150
151    If you are building compiler tools for cross-compiling, you can also
152 use the `--target=TYPE' option to select the type of system they will
153 produce code for and the `--build=TYPE' option to select the type of
154 system on which you are compiling the package.
155
156 Sharing Defaults
157 ================
158
159    If you want to set default values for `configure' scripts to share,
160 you can create a site shell script called `config.site' that gives
161 default values for variables like `CC', `cache_file', and `prefix'.
162 `configure' looks for `PREFIX/share/config.site' if it exists, then
163 `PREFIX/etc/config.site' if it exists.  Or, you can set the
164 `CONFIG_SITE' environment variable to the location of the site script.
165 A warning: not all `configure' scripts look for a site script.
166
167 Operation Controls
168 ==================
169
170    `configure' recognizes the following options to control how it
171 operates.
172
173 `--cache-file=FILE'
174      Use and save the results of the tests in FILE instead of
175      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
176      debugging `configure'.
177
178 `--help'
179      Print a summary of the options to `configure', and exit.
180
181 `--quiet'
182 `--silent'
183 `-q'
184      Do not print messages saying which checks are being made.  To
185      suppress all normal output, redirect it to `/dev/null' (any error
186      messages will still be shown).
187
188 `--srcdir=DIR'
189      Look for the package's source code in directory DIR.  Usually
190      `configure' can determine that directory automatically.
191
192 `--version'
193      Print the version of Autoconf used to generate the `configure'
194      script, and exit.
195
196 `configure' also accepts some other, not widely useful, options.