Debian Codegraph @

INSTALL

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