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