Fix resolver inet_* namespace (bug 17722).
[glibc.git] / INSTALL
blob35f70e0f5e4ff2a0d050180d93f1715dc7d37fba
1 Installing the GNU C Library
2 ****************************
4 Before you do anything else, you should read the FAQ at
5 `http://sourceware.org/glibc/wiki/FAQ'.  It answers common questions
6 and describes problems you may experience with compilation and
7 installation.
9 Features can be added to the GNU C Library via "add-on" bundles.  These
10 are separate tar files, which you unpack into the top level of the
11 source tree.  Then you give `configure' the `--enable-add-ons' option
12 to activate them, and they will be compiled into the library.
14    You will need recent versions of several GNU tools: definitely GCC
15 and GNU Make, and possibly others.  *Note Tools for Compilation::,
16 below.
18 Configuring and compiling the GNU C Library
19 ===========================================
21 The GNU C Library cannot be compiled in the source directory.  You must
22 build it in a separate build directory.  For example, if you have
23 unpacked the GNU C Library sources in `/src/gnu/glibc-VERSION', create
24 a directory `/src/gnu/glibc-build' to put the object files in.  This
25 allows removing the whole build directory in case an error occurs,
26 which is the safest way to get a fresh start and should always be done.
28    From your object directory, run the shell script `configure' located
29 at the top level of the source tree.  In the scenario above, you'd type
31      $ ../glibc-VERSION/configure ARGS...
33    Please note that even though you're building in a separate build
34 directory, the compilation may need to create or modify files and
35 directories in the source directory.
37 `configure' takes many options, but the only one that is usually
38 mandatory is `--prefix'.  This option tells `configure' where you want
39 the GNU C Library installed.  This defaults to `/usr/local', but the
40 normal setting to install as the standard system library is
41 `--prefix=/usr' for GNU/Linux systems and `--prefix=' (an empty prefix)
42 for GNU/Hurd systems.
44    It may also be useful to set the CC and CFLAGS variables in the
45 environment when running `configure'.  CC selects the C compiler that
46 will be used, and CFLAGS sets optimization options for the compiler.
48    The following list describes all of the available options for
49 `configure':
51 `--prefix=DIRECTORY'
52      Install machine-independent data files in subdirectories of
53      `DIRECTORY'.  The default is to install in `/usr/local'.
55 `--exec-prefix=DIRECTORY'
56      Install the library and other machine-dependent files in
57      subdirectories of `DIRECTORY'.  The default is to the `--prefix'
58      directory if that option is specified, or `/usr/local' otherwise.
60 `--with-headers=DIRECTORY'
61      Look for kernel header files in DIRECTORY, not `/usr/include'.
62      The GNU C Library needs information from the kernel's header files
63      describing the interface to the kernel.  The GNU C Library will
64      normally look in `/usr/include' for them, but if you specify this
65      option, it will look in DIRECTORY instead.
67      This option is primarily of use on a system where the headers in
68      `/usr/include' come from an older version of the GNU C Library.
69      Conflicts can occasionally happen in this case.  You can also use
70      this option if you want to compile the GNU C Library with a newer
71      set of kernel headers than the ones found in `/usr/include'.
73 `--enable-add-ons[=LIST]'
74      Specify add-on packages to include in the build.  If this option is
75      specified with no list, it enables all the add-on packages it
76      finds in the main source directory; this is the default behavior.
77      You may specify an explicit list of add-ons to use in LIST,
78      separated by spaces or commas (if you use spaces, remember to
79      quote them from the shell).  Each add-on in LIST can be an
80      absolute directory name or can be a directory name relative to the
81      main source directory, or relative to the build directory (that
82      is, the current working directory).  For example,
83      `--enable-add-ons=nptl,../glibc-libidn-VERSION'.
85 `--enable-kernel=VERSION'
86      This option is currently only useful on GNU/Linux systems.  The
87      VERSION parameter should have the form X.Y.Z and describes the
88      smallest version of the Linux kernel the generated library is
89      expected to support.  The higher the VERSION number is, the less
90      compatibility code is added, and the faster the code gets.
92 `--with-binutils=DIRECTORY'
93      Use the binutils (assembler and linker) in `DIRECTORY', not the
94      ones the C compiler would default to.  You can use this option if
95      the default binutils on your system cannot deal with all the
96      constructs in the GNU C Library.  In that case, `configure' will
97      detect the problem and suppress these constructs, so that the
98      library will still be usable, but functionality may be lost--for
99      example, you can't build a shared libc with old binutils.
101 `--without-fp'
102      Use this option if your computer lacks hardware floating-point
103      support and your operating system does not emulate an FPU.
105 `--disable-shared'
106      Don't build shared libraries even if it is possible.  Not all
107      systems support shared libraries; you need ELF support and
108      (currently) the GNU linker.
110 `--disable-profile'
111      Don't build libraries with profiling information.  You may want to
112      use this option if you don't plan to do profiling.
114 `--enable-static-nss'
115      Compile static versions of the NSS (Name Service Switch) libraries.
116      This is not recommended because it defeats the purpose of NSS; a
117      program linked statically with the NSS libraries cannot be
118      dynamically reconfigured to use a different name database.
120 `--without-tls'
121      By default the C library is built with support for thread-local
122      storage if the used tools support it.  By using `--without-tls'
123      this can be prevented though there generally is no reason since it
124      creates compatibility problems.
126 `--enable-hardcoded-path-in-tests'
127      By default, dynamic tests are linked to run with the installed C
128      library.  This option hardcodes the newly built C library path in
129      dynamic tests so that they can be invoked directly.
131 `--enable-lock-elision=yes'
132      Enable lock elision for pthread mutexes by default.
134 `--enable-pt_chown'
135      The file `pt_chown' is a helper binary for `grantpt' (*note
136      Pseudo-Terminals: Allocation.) that is installed setuid root to
137      fix up pseudo-terminal ownership.  It is not built by default
138      because systems using the Linux kernel are commonly built with the
139      `devpts' filesystem enabled and mounted at `/dev/pts', which
140      manages pseudo-terminal ownership automatically.  By using
141      `--enable-pt_chown', you may build `pt_chown' and install it
142      setuid and owned by `root'.  The use of `pt_chown' introduces
143      additional security risks to the system and you should enable it
144      only if you understand and accept those risks.
146 `--disable-werror'
147      By default, the GNU C Library is built with `-Werror'.  If you wish
148      to build without this option (for example, if building with a newer
149      version of GCC than this version of the GNU C Library was tested
150      with, so new warnings cause the build with `-Werror' to fail), you
151      can configure with `--disable-werror'.
153 `--build=BUILD-SYSTEM'
154 `--host=HOST-SYSTEM'
155      These options are for cross-compiling.  If you specify both
156      options and BUILD-SYSTEM is different from HOST-SYSTEM, `configure'
157      will prepare to cross-compile the GNU C Library from BUILD-SYSTEM
158      to be used on HOST-SYSTEM.  You'll probably need the
159      `--with-headers' option too, and you may have to override
160      CONFIGURE's selection of the compiler and/or binutils.
162      If you only specify `--host', `configure' will prepare for a
163      native compile but use what you specify instead of guessing what
164      your system is.  This is most useful to change the CPU submodel.
165      For example, if `configure' guesses your machine as
166      `i686-pc-linux-gnu' but you want to compile a library for 586es,
167      give `--host=i586-pc-linux-gnu' or just `--host=i586-linux' and add
168      the appropriate compiler flags (`-mcpu=i586' will do the trick) to
169      CFLAGS.
171      If you specify just `--build', `configure' will get confused.
173 `--with-pkgversion=VERSION'
174      Specify a description, possibly including a build number or build
175      date, of the binaries being built, to be included in `--version'
176      output from programs installed with the GNU C Library.  For
177      example, `--with-pkgversion='FooBar GNU/Linux glibc build 123''.
178      The default value is `GNU libc'.
180 `--with-bugurl=URL'
181      Specify the URL that users should visit if they wish to report a
182      bug, to be included in `--help' output from programs installed with
183      the GNU C Library.  The default value refers to the main
184      bug-reporting information for the GNU C Library.
186    To build the library and related programs, type `make'.  This will
187 produce a lot of output, some of which may look like errors from `make'
188 but isn't.  Look for error messages from `make' containing `***'.
189 Those indicate that something is seriously wrong.
191    The compilation process can take a long time, depending on the
192 configuration and the speed of your machine.  Some complex modules may
193 take a very long time to compile, as much as several minutes on slower
194 machines.  Do not panic if the compiler appears to hang.
196    If you want to run a parallel make, simply pass the `-j' option with
197 an appropriate numeric parameter to `make'.  You need a recent GNU
198 `make' version, though.
200    To build and run test programs which exercise some of the library
201 facilities, type `make check'.  If it does not complete successfully,
202 do not use the built library, and report a bug after verifying that the
203 problem is not already known.  *Note Reporting Bugs::, for instructions
204 on reporting bugs.  Note that some of the tests assume they are not
205 being run by `root'.  We recommend you compile and test the GNU C
206 Library as an unprivileged user.
208    Before reporting bugs make sure there is no problem with your system.
209 The tests (and later installation) use some pre-existing files of the
210 system such as `/etc/passwd', `/etc/nsswitch.conf' and others.  These
211 files must all contain correct and sensible content.
213    Normally, `make check' will run all the tests before reporting all
214 problems found and exiting with error status if any problems occurred.
215 You can specify `stop-on-test-failure=y' when running `make check' to
216 make the test run stop and exit with an error status immediately when a
217 failure occurs.
219    To format the `GNU C Library Reference Manual' for printing, type
220 `make dvi'.  You need a working TeX installation to do this.  The
221 distribution builds the on-line formatted version of the manual, as
222 Info files, as part of the build process.  You can build them manually
223 with `make info'.
225    The library has a number of special-purpose configuration parameters
226 which you can find in `Makeconfig'.  These can be overwritten with the
227 file `configparms'.  To change them, create a `configparms' in your
228 build directory and add values as appropriate for your system.  The
229 file is included and parsed by `make' and has to follow the conventions
230 for makefiles.
232    It is easy to configure the GNU C Library for cross-compilation by
233 setting a few variables in `configparms'.  Set `CC' to the
234 cross-compiler for the target you configured the library for; it is
235 important to use this same `CC' value when running `configure', like
236 this: `CC=TARGET-gcc configure TARGET'.  Set `BUILD_CC' to the compiler
237 to use for programs run on the build system as part of compiling the
238 library.  You may need to set `AR' to cross-compiling versions of `ar'
239 if the native tools are not configured to work with object files for
240 the target you configured for.  When cross-compiling the GNU C Library,
241 it may be tested using `make check
242 test-wrapper="SRCDIR/scripts/cross-test-ssh.sh HOSTNAME"', where SRCDIR
243 is the absolute directory name for the main source directory and
244 HOSTNAME is the host name of a system that can run the newly built
245 binaries of the GNU C Library.  The source and build directories must
246 be visible at the same locations on both the build system and HOSTNAME.
248    In general, when testing the GNU C Library, `test-wrapper' may be set
249 to the name and arguments of any program to run newly built binaries.
250 This program must preserve the arguments to the binary being run, its
251 working directory and the standard input, output and error file
252 descriptors.  If `TEST-WRAPPER env' will not work to run a program with
253 environment variables set, then `test-wrapper-env' must be set to a
254 program that runs a newly built program with environment variable
255 assignments in effect, those assignments being specified as `VAR=VALUE'
256 before the name of the program to be run.  If multiple assignments to
257 the same variable are specified, the last assignment specified must
258 take precedence.
260 Installing the C Library
261 ========================
263 To install the library and its header files, and the Info files of the
264 manual, type `make install'.  This will build things, if necessary,
265 before installing them; however, you should still compile everything
266 first.  If you are installing the GNU C Library as your primary C
267 library, we recommend that you shut the system down to single-user mode
268 first, and reboot afterward.  This minimizes the risk of breaking
269 things when the library changes out from underneath.
271    `make install' will do the entire job of upgrading from a previous
272 installation of the GNU C Library version 2.x.  There may sometimes be
273 headers left behind from the previous installation, but those are
274 generally harmless.  If you want to avoid leaving headers behind you
275 can do things in the following order.
277    You must first build the library (`make'), optionally check it
278 (`make check'), switch the include directories and then install (`make
279 install').  The steps must be done in this order.  Not moving the
280 directory before install will result in an unusable mixture of header
281 files from both libraries, but configuring, building, and checking the
282 library requires the ability to compile and run programs against the old
283 library.  The new `/usr/include', after switching the include
284 directories and before installing the library should contain the Linux
285 headers, but nothing else.  If you do this, you will need to restore
286 any headers from libraries other than the GNU C Library yourself after
287 installing the library.
289    You can install the GNU C Library somewhere other than where you
290 configured it to go by setting the `install_root' variable on the
291 command line for `make install'.  The value of this variable is
292 prepended to all the paths for installation.  This is useful when
293 setting up a chroot environment or preparing a binary distribution.
294 The directory should be specified with an absolute file name.
296    The GNU C Library includes a daemon called `nscd', which you may or
297 may not want to run.  `nscd' caches name service lookups; it can
298 dramatically improve performance with NIS+, and may help with DNS as
299 well.
301    One auxiliary program, `/usr/libexec/pt_chown', is installed setuid
302 `root' if the `--enable-pt_chown' configuration option is used.  This
303 program is invoked by the `grantpt' function; it sets the permissions
304 on a pseudoterminal so it can be used by the calling process.  If you
305 are using a Linux kernel with the `devpts' filesystem enabled and
306 mounted at `/dev/pts', you don't need this program.
308    After installation you might want to configure the timezone and
309 locale installation of your system.  The GNU C Library comes with a
310 locale database which gets configured with `localedef'.  For example, to
311 set up a German locale with name `de_DE', simply issue the command
312 `localedef -i de_DE -f ISO-8859-1 de_DE'.  To configure all locales
313 that are supported by the GNU C Library, you can issue from your build
314 directory the command `make localedata/install-locales'.
316    To configure the locally used timezone, set the `TZ' environment
317 variable.  The script `tzselect' helps you to select the right value.
318 As an example, for Germany, `tzselect' would tell you to use
319 `TZ='Europe/Berlin''.  For a system wide installation (the given paths
320 are for an installation with `--prefix=/usr'), link the timezone file
321 which is in `/usr/share/zoneinfo' to the file `/etc/localtime'.  For
322 Germany, you might execute `ln -s /usr/share/zoneinfo/Europe/Berlin
323 /etc/localtime'.
325 Recommended Tools for Compilation
326 =================================
328 We recommend installing the following GNU tools before attempting to
329 build the GNU C Library:
331    * GNU `make' 3.79 or newer
333      You need the latest version of GNU `make'.  Modifying the GNU C
334      Library to work with other `make' programs would be so difficult
335      that we recommend you port GNU `make' instead.  *Really.*  We
336      recommend GNU `make' version 3.79.  All earlier versions have
337      severe bugs or lack features.
339    * GCC 4.6 or newer
341      GCC 4.6 or higher is required.  In general it is recommended to use
342      the newest version of the compiler that is known to work for
343      building the GNU C Library, as newer compilers usually produce
344      better code.  As of release time, GCC 4.9 is the newest compiler
345      verified to work to build the GNU C Library.
347      You can use whatever compiler you like to compile programs that use
348      the GNU C Library.
350      Check the FAQ for any special compiler issues on particular
351      platforms.
353    * GNU `binutils' 2.22 or later
355      You must use GNU `binutils' (as and ld) to build the GNU C Library.
356      No other assembler or linker has the necessary functionality at the
357      moment.
359    * GNU `texinfo' 4.7 or later
361      To correctly translate and install the Texinfo documentation you
362      need this version of the `texinfo' package.  Earlier versions do
363      not understand all the tags used in the document, and the
364      installation mechanism for the info files is not present or works
365      differently.
367    * GNU `awk' 3.1.2, or higher
369      `awk' is used in several places to generate files.  Some `gawk'
370      extensions are used, including the `asorti' function, which was
371      introduced in version 3.1.2 of `gawk'.
373    * Perl 5
375      Perl is not required, but it is used if present to test the
376      installation.  We may decide to use it elsewhere in the future.
378    * GNU `sed' 3.02 or newer
380      `Sed' is used in several places to generate files.  Most scripts
381      work with any version of `sed'.  The known exception is the script
382      `po2test.sed' in the `intl' subdirectory which is used to generate
383      `msgs.h' for the test suite.  This script works correctly only
384      with GNU `sed' 3.02.  If you like to run the test suite, you
385      should definitely upgrade `sed'.
388 If you change any of the `configure.ac' files you will also need
390    * GNU `autoconf' 2.69 (exactly)
392 and if you change any of the message translation files you will need
394    * GNU `gettext' 0.10.36 or later
396 You may also need these packages if you upgrade your source tree using
397 patches, although we try to avoid this.
399 Specific advice for GNU/Linux systems
400 =====================================
402 If you are installing the GNU C Library on GNU/Linux systems, you need
403 to have the header files from a 2.6.32 or newer kernel around for
404 reference.  These headers must be installed using `make
405 headers_install'; the headers present in the kernel source directory
406 are not suitable for direct use by the GNU C Library.  You do not need
407 to use that kernel, just have its headers installed where the GNU C
408 Library can access them, referred to here as INSTALL-DIRECTORY.  The
409 easiest way to do this is to unpack it in a directory such as
410 `/usr/src/linux-VERSION'.  In that directory, run `make headers_install
411 INSTALL_HDR_PATH=INSTALL-DIRECTORY'.  Finally, configure the GNU C
412 Library with the option `--with-headers=INSTALL-DIRECTORY/include'.
413 Use the most recent kernel you can get your hands on.  (If you are
414 cross-compiling the GNU C Library, you need to specify
415 `ARCH=ARCHITECTURE' in the `make headers_install' command, where
416 ARCHITECTURE is the architecture name used by the Linux kernel, such as
417 `x86' or `powerpc'.)
419    After installing the GNU C Library, you may need to remove or rename
420 directories such as `/usr/include/linux' and `/usr/include/asm', and
421 replace them with copies of directories such as `linux' and `asm' from
422 `INSTALL-DIRECTORY/include'.  All directories present in
423 `INSTALL-DIRECTORY/include' should be copied, except that the GNU C
424 Library provides its own version of `/usr/include/scsi'; the files
425 provided by the kernel should be copied without replacing those
426 provided by the GNU C Library.  The `linux', `asm' and `asm-generic'
427 directories are required to compile programs using the GNU C Library;
428 the other directories describe interfaces to the kernel but are not
429 required if not compiling programs using those interfaces.  You do not
430 need to copy kernel headers if you did not specify an alternate kernel
431 header source using `--with-headers'.
433    The Filesystem Hierarchy Standard for GNU/Linux systems expects some
434 components of the GNU C Library installation to be in `/lib' and some
435 in `/usr/lib'.  This is handled automatically if you configure the GNU
436 C Library with `--prefix=/usr'.  If you set some other prefix or allow
437 it to default to `/usr/local', then all the components are installed
438 there.
440 Reporting Bugs
441 ==============
443 There are probably bugs in the GNU C Library.  There are certainly
444 errors and omissions in this manual.  If you report them, they will get
445 fixed.  If you don't, no one will ever know about them and they will
446 remain unfixed for all eternity, if not longer.
448    It is a good idea to verify that the problem has not already been
449 reported.  Bugs are documented in two places: The file `BUGS' describes
450 a number of well known bugs and the central GNU C Library bug tracking
451 system has a WWW interface at `http://sourceware.org/bugzilla/'.  The
452 WWW interface gives you access to open and closed reports.  A closed
453 report normally includes a patch or a hint on solving the problem.
455    To report a bug, first you must find it.  With any luck, this will
456 be the hard part.  Once you've found a bug, make sure it's really a
457 bug.  A good way to do this is to see if the GNU C Library behaves the
458 same way some other C library does.  If so, probably you are wrong and
459 the libraries are right (but not necessarily).  If not, one of the
460 libraries is probably wrong.  It might not be the GNU C Library.  Many
461 historical Unix C libraries permit things that we don't, such as
462 closing a file twice.
464    If you think you have found some way in which the GNU C Library does
465 not conform to the ISO and POSIX standards (*note Standards and
466 Portability::), that is definitely a bug.  Report it!
468    Once you're sure you've found a bug, try to narrow it down to the
469 smallest test case that reproduces the problem.  In the case of a C
470 library, you really only need to narrow it down to one library function
471 call, if possible.  This should not be too difficult.
473    The final step when you have a simple test case is to report the bug.
474 Do this at `http://www.gnu.org/software/libc/bugs.html'.
476    If you are not sure how a function should behave, and this manual
477 doesn't tell you, that's a bug in the manual.  Report that too!  If the
478 function's behavior disagrees with the manual, then either the library
479 or the manual has a bug, so report the disagreement.  If you find any
480 errors or omissions in this manual, please report them to the bug
481 database.  If you refer to specific sections of the manual, please
482 include the section names for easier identification.