Debian Codegraph @

INSTALL

raw
1 Installation Instructions
2 *************************
3
4 Copyright (C) 1994-1996, 1999-2002, 2004-2013 Free Software Foundation,
5 Inc.
6
7 Copying and distribution of this file, with or without modification,
8 are permitted in any medium without royalty provided the copyright
9 notice and this notice are preserved. This file is offered as-is,
10 without warranty of any kind.
11
12 Prerequisites
13 =============
14
15 This project has the following prerequisites:
16
17 (Ubuntu package names)
18 libkeyutils-dev
19 libtasn1-dev
20 libgmp-dev
21 libnspr4-dev
22 libnss3-dev
23
24 These software TPMs are supported:
25 https://sourceforge.net/projects/ibmswtpm2/
26 https://github.com/stefanberger/swtpm
27
28 swtpm depends upon
29 https://github.com/stefanberger/libtpms
30
31 Supported TSSes include these. Both are included in some distros.
32 IBM TSS https://sourceforge.net/projects/ibmtpm20tss/
33 Intel TSS
34
35 Basic Installation
36 ==================
37
38 Briefly, the shell commands `autoreconf -i; ./configure; make; make install' should
39 configure, build, and install this package. The following
40 more-detailed instructions are generic; see the `README' file for
41 instructions specific to this package. Some packages provide this
42 `INSTALL' file but do not implement all of the features documented
43 below. The lack of an optional feature in a given package is not
44 necessarily a bug. More recommendations for GNU packages can be found
45 in *note Makefile Conventions: (standards)Makefile Conventions.
46
47 The `configure' shell script attempts to guess correct values for
48 various system-dependent variables used during compilation. It uses
49 those values to create a `Makefile' in each directory of the package.
50 It may also create one or more `.h' files containing system-dependent
51 definitions. Finally, it creates a shell script `config.status' that
52 you can run in the future to recreate the current configuration, and a
53 file `config.log' containing compiler output (useful mainly for
54 debugging `configure').
55
56 It can also use an optional file (typically called `config.cache'
57 and enabled with `--cache-file=config.cache' or simply `-C') that saves
58 the results of its tests to speed up reconfiguring. Caching is
59 disabled by default to prevent problems with accidental use of stale
60 cache files.
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 you are using the cache, and at
66 some point `config.cache' contains results you don't want to keep, you
67 may remove or edit it.
68
69 The file `configure.ac' (or `configure.in') is used to create
70 `configure' by a program called `autoconf'. You need `configure.ac' if
71 you want to change it or regenerate `configure' using a newer version
72 of `autoconf'.
73
74 The simplest way to compile this package is:
75
76 1. `cd' to the directory containing the package's source code and type
77 `autoreconf -i' and then `./configure' to configure the package for your system.
78
79 Running `configure' might take a while. While running, it prints
80 some messages telling which features it is checking for.
81
82 2. Type `make' to compile the package.
83
84 3. Optionally, type `make check' to run any self-tests that come with
85 the package, generally using the just-built uninstalled binaries.
86
87 4. Type `make install' to install the programs and any data files and
88 documentation. When installing into a prefix owned by root, it is
89 recommended that the package be configured and built as a regular
90 user, and only the `make install' phase executed with root
91 privileges.
92
93 5. Optionally, type `make installcheck' to repeat any self-tests, but
94 this time using the binaries in their final installed location.
95 This target does not install anything. Running this target as a
96 regular user, particularly if the prior `make install' required
97 root privileges, verifies that the installation completed
98 correctly.
99
100 6. You can remove the program binaries and object files from the
101 source code directory by typing `make clean'. To also remove the
102 files that `configure' created (so you can compile the package for
103 a different kind of computer), type `make distclean'. There is
104 also a `make maintainer-clean' target, but that is intended mainly
105 for the package's developers. If you use it, you may have to get
106 all sorts of other programs in order to regenerate files that came
107 with the distribution.
108
109 7. Often, you can also type `make uninstall' to remove the installed
110 files again. In practice, not all packages have tested that
111 uninstallation works correctly, even though it is required by the
112 GNU Coding Standards.
113
114 8. Some packages, particularly those that use Automake, provide `make
115 distcheck', which can by used by developers to test that all other
116 targets like `make install' and `make uninstall' work correctly.
117 This target is generally not run by end users.
118
119 Compilers and Options
120 =====================
121
122 Some systems require unusual options for compilation or linking that
123 the `configure' script does not know about. Run `./configure --help'
124 for details on some of the pertinent environment variables.
125
126 You can give `configure' initial values for configuration parameters
127 by setting variables in the command line or in the environment. Here
128 is an example:
129
130 ./configure CC=c99 CFLAGS=-g LIBS=-lposix
131
132 *Note Defining Variables::, for more details.
133
134 Compiling For Multiple Architectures
135 ====================================
136
137 You can compile the package for more than one kind of computer at the
138 same time, by placing the object files for each architecture in their
139 own directory. To do this, you can use GNU `make'. `cd' to the
140 directory where you want the object files and executables to go and run
141 the `configure' script. `configure' automatically checks for the
142 source code in the directory that `configure' is in and in `..'. This
143 is known as a "VPATH" build.
144
145 With a non-GNU `make', it is safer to compile the package for one
146 architecture at a time in the source code directory. After you have
147 installed the package for one architecture, use `make distclean' before
148 reconfiguring for another architecture.
149
150 On MacOS X 10.5 and later systems, you can create libraries and
151 executables that work on multiple system types--known as "fat" or
152 "universal" binaries--by specifying multiple `-arch' options to the
153 compiler but only a single `-arch' option to the preprocessor. Like
154 this:
155
156 ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
157 CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
158 CPP="gcc -E" CXXCPP="g++ -E"
159
160 This is not guaranteed to produce working output in all cases, you
161 may have to build one architecture at a time and combine the results
162 using the `lipo' tool if you have problems.
163
164 Installation Names
165 ==================
166
167 By default, `make install' installs the package's commands under
168 `/usr/local/bin', include files under `/usr/local/include', etc. You
169 can specify an installation prefix other than `/usr/local' by giving
170 `configure' the option `--prefix=PREFIX', where PREFIX must be an
171 absolute file name.
172
173 You can specify separate installation prefixes for
174 architecture-specific files and architecture-independent files. If you
175 pass the option `--exec-prefix=PREFIX' to `configure', the package uses
176 PREFIX as the prefix for installing programs and libraries.
177 Documentation and other data files still use the regular prefix.
178
179 In addition, if you use an unusual directory layout you can give
180 options like `--bindir=DIR' to specify different values for particular
181 kinds of files. Run `configure --help' for a list of the directories
182 you can set and what kinds of files go in them. In general, the
183 default for these options is expressed in terms of `${prefix}', so that
184 specifying just `--prefix' will affect all of the other directory
185 specifications that were not explicitly provided.
186
187 The most portable way to affect installation locations is to pass the
188 correct locations to `configure'; however, many packages provide one or
189 both of the following shortcuts of passing variable assignments to the
190 `make install' command line to change installation locations without
191 having to reconfigure or recompile.
192
193 The first method involves providing an override variable for each
194 affected directory. For example, `make install
195 prefix=/alternate/directory' will choose an alternate location for all
196 directory configuration variables that were expressed in terms of
197 `${prefix}'. Any directories that were specified during `configure',
198 but not in terms of `${prefix}', must each be overridden at install
199 time for the entire installation to be relocated. The approach of
200 makefile variable overrides for each directory variable is required by
201 the GNU Coding Standards, and ideally causes no recompilation.
202 However, some platforms have known limitations with the semantics of
203 shared libraries that end up requiring recompilation when using this
204 method, particularly noticeable in packages that use GNU Libtool.
205
206 The second method involves providing the `DESTDIR' variable. For
207 example, `make install DESTDIR=/alternate/directory' will prepend
208 `/alternate/directory' before all installation names. The approach of
209 `DESTDIR' overrides is not required by the GNU Coding Standards, and
210 does not work on platforms that have drive letters. On the other hand,
211 it does better at avoiding recompilation issues, and works well even
212 when some directory options were not specified in terms of `${prefix}'
213 at `configure' time.
214
215 Optional Features
216 =================
217
218 If the package supports it, you can cause programs to be installed
219 with an extra prefix or suffix on their names by giving `configure' the
220 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
221
222 Some packages pay attention to `--enable-FEATURE' options to
223 `configure', where FEATURE indicates an optional part of the package.
224 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
225 is something like `gnu-as' or `x' (for the X Window System). The
226 `README' should mention any `--enable-' and `--with-' options that the
227 package recognizes.
228
229 For packages that use the X Window System, `configure' can usually
230 find the X include and library files automatically, but if it doesn't,
231 you can use the `configure' options `--x-includes=DIR' and
232 `--x-libraries=DIR' to specify their locations.
233
234 Some packages offer the ability to configure how verbose the
235 execution of `make' will be. For these packages, running `./configure
236 --enable-silent-rules' sets the default to minimal output, which can be
237 overridden with `make V=1'; while running `./configure
238 --disable-silent-rules' sets the default to verbose, which can be
239 overridden with `make V=0'.
240
241 Particular systems
242 ==================
243
244 On HP-UX, the default C compiler is not ANSI C compatible. If GNU
245 CC is not installed, it is recommended to use the following options in
246 order to use an ANSI C compiler:
247
248 ./configure CC="cc -Ae -D_XOPEN_SOURCE=500"
249
250 and if that doesn't work, install pre-built binaries of GCC for HP-UX.
251
252 HP-UX `make' updates targets which have the same time stamps as
253 their prerequisites, which makes it generally unusable when shipped
254 generated files such as `configure' are involved. Use GNU `make'
255 instead.
256
257 On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
258 parse its `<wchar.h>' header file. The option `-nodtk' can be used as
259 a workaround. If GNU CC is not installed, it is therefore recommended
260 to try
261
262 ./configure CC="cc"
263
264 and if that doesn't work, try
265
266 ./configure CC="cc -nodtk"
267
268 On Solaris, don't put `/usr/ucb' early in your `PATH'. This
269 directory contains several dysfunctional programs; working variants of
270 these programs are available in `/usr/bin'. So, if you need `/usr/ucb'
271 in your `PATH', put it _after_ `/usr/bin'.
272
273 On Haiku, software installed for all users goes in `/boot/common',
274 not `/usr/local'. It is recommended to use the following options:
275
276 ./configure --prefix=/boot/common
277
278 Specifying the System Type
279 ==========================
280
281 There may be some features `configure' cannot figure out
282 automatically, but needs to determine by the type of machine the package
283 will run on. Usually, assuming the package is built to be run on the
284 _same_ architectures, `configure' can figure that out, but if it prints
285 a message saying it cannot guess the machine type, give it the
286 `--build=TYPE' option. TYPE can either be a short name for the system
287 type, such as `sun4', or a canonical name which has the form:
288
289 CPU-COMPANY-SYSTEM
290
291 where SYSTEM can have one of these forms:
292
293 OS
294 KERNEL-OS
295
296 See the file `config.sub' for the possible values of each field. If
297 `config.sub' isn't included in this package, then this package doesn't
298 need to know the machine type.
299
300 If you are _building_ compiler tools for cross-compiling, you should
301 use the option `--target=TYPE' to select the type of system they will
302 produce code for.
303
304 If you want to _use_ a cross compiler, that generates code for a
305 platform different from the build platform, you should specify the
306 "host" platform (i.e., that on which the generated programs will
307 eventually be run) with `--host=TYPE'.
308
309 Sharing Defaults
310 ================
311
312 If you want to set default values for `configure' scripts to share,
313 you can create a site shell script called `config.site' that gives
314 default values for variables like `CC', `cache_file', and `prefix'.
315 `configure' looks for `PREFIX/share/config.site' if it exists, then
316 `PREFIX/etc/config.site' if it exists. Or, you can set the
317 `CONFIG_SITE' environment variable to the location of the site script.
318 A warning: not all `configure' scripts look for a site script.
319
320 Defining Variables
321 ==================
322
323 Variables not defined in a site shell script can be set in the
324 environment passed to `configure'. However, some packages may run
325 configure again during the build, and the customized values of these
326 variables may be lost. In order to avoid this problem, you should set
327 them in the `configure' command line, using `VAR=value'. For example:
328
329 ./configure CC=/usr/local2/bin/gcc
330
331 causes the specified `gcc' to be used as the C compiler (unless it is
332 overridden in the site shell script).
333
334 Unfortunately, this technique does not work for `CONFIG_SHELL' due to
335 an Autoconf limitation. Until the limitation is lifted, you can use
336 this workaround:
337
338 CONFIG_SHELL=/bin/bash ./configure CONFIG_SHELL=/bin/bash
339
340 `configure' Invocation
341 ======================
342
343 `configure' recognizes the following options to control how it
344 operates.
345
346 `--help'
347 `-h'
348 Print a summary of all of the options to `configure', and exit.
349
350 `--help=short'
351 `--help=recursive'
352 Print a summary of the options unique to this package's
353 `configure', and exit. The `short' variant lists options used
354 only in the top level, while the `recursive' variant lists options
355 also present in any nested packages.
356
357 `--version'
358 `-V'
359 Print the version of Autoconf used to generate the `configure'
360 script, and exit.
361
362 `--cache-file=FILE'
363 Enable the cache: use and save the results of the tests in FILE,
364 traditionally `config.cache'. FILE defaults to `/dev/null' to
365 disable caching.
366
367 `--config-cache'
368 `-C'
369 Alias for `--cache-file=config.cache'.
370
371 `--quiet'
372 `--silent'
373 `-q'
374 Do not print messages saying which checks are being made. To
375 suppress all normal output, redirect it to `/dev/null' (any error
376 messages will still be shown).
377
378 `--srcdir=DIR'
379 Look for the package's source code in directory DIR. Usually
380 `configure' can determine that directory automatically.
381
382 `--prefix=DIR'
383 Use DIR as the installation prefix. *note Installation Names::
384 for more details, including other options available for fine-tuning
385 the installation locations.
386
387 `--no-create'
388 `-n'
389 Run the configure checks, but stop before creating any output
390 files.
391
392 `configure' also accepts some other, not widely useful, options. Run
393 `configure --help' for more details.