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