INSTALL

   1 Installing the GNU C Library
   2 ****************************
   3
   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.
   8
   9    Features can be added to the GNU C Library via "add-on" bundles.
  10 These are separate tar files, which you unpack into the top level of
  11 the source tree.  Then you give `configure' the `--enable-add-ons'
  12 option to activate them, and they will be compiled into the library.
  13
  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.
  17
  18 Configuring and compiling the GNU C Library
  19 ===========================================
  20
  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.
  27
  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
  30
  31      $ ../glibc-VERSION/configure ARGS...
  32
  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.
  36
  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.
  43
  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.
  47
  48    The following list describes all of the available options for
  49 `configure':
  50
  51 `--prefix=DIRECTORY'
  52      Install machine-independent data files in subdirectories of
  53      `DIRECTORY'.  The default is to install in `/usr/local'.
  54
  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.
  59
  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.
  66
  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'.
  72
  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'.
  84
  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.
  91
  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.
 100
 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.
 104
 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.
 109
 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.
 113
 114 `--disable-versioning'
 115      Don't compile the shared libraries with symbol version information.
 116      Doing this will make the resulting library incompatible with old
 117      binaries, so it's not recommended.
 118
 119 `--enable-static-nss'
 120      Compile static versions of the NSS (Name Service Switch) libraries.
 121      This is not recommended because it defeats the purpose of NSS; a
 122      program linked statically with the NSS libraries cannot be
 123      dynamically reconfigured to use a different name database.
 124
 125 `--without-tls'
 126      By default the C library is built with support for thread-local
 127      storage if the used tools support it.  By using `--without-tls'
 128      this can be prevented though there generally is no reason since it
 129      creates compatibility problems.
 130
 131 `--build=BUILD-SYSTEM'
 132 `--host=HOST-SYSTEM'
 133      These options are for cross-compiling.  If you specify both
 134      options and BUILD-SYSTEM is different from HOST-SYSTEM, `configure'
 135      will prepare to cross-compile the GNU C Library from BUILD-SYSTEM
 136      to be used on HOST-SYSTEM.  You'll probably need the
 137      `--with-headers' option too, and you may have to override
 138      CONFIGURE's selection of the compiler and/or binutils.
 139
 140      If you only specify `--host', `configure' will prepare for a
 141      native compile but use what you specify instead of guessing what
 142      your system is. This is most useful to change the CPU submodel.
 143      For example, if `configure' guesses your machine as
 144      `i586-pc-linux-gnu' but you want to compile a library for 386es,
 145      give `--host=i386-pc-linux-gnu' or just `--host=i386-linux' and add
 146      the appropriate compiler flags (`-mcpu=i386' will do the trick) to
 147      CFLAGS.
 148
 149      If you specify just `--build', `configure' will get confused.
 150
 151    To build the library and related programs, type `make'.  This will
 152 produce a lot of output, some of which may look like errors from `make'
 153 but isn't.  Look for error messages from `make' containing `***'.
 154 Those indicate that something is seriously wrong.
 155
 156    The compilation process can take a long time, depending on the
 157 configuration and the speed of your machine.  Some complex modules may
 158 take a very long time to compile, as much as several minutes on slower
 159 machines.  Do not panic if the compiler appears to hang.
 160
 161    If you want to run a parallel make, simply pass the `-j' option with
 162 an appropriate numeric parameter to `make'.  You need a recent GNU
 163 `make' version, though.
 164
 165    To build and run test programs which exercise some of the library
 166 facilities, type `make check'.  If it does not complete successfully,
 167 do not use the built library, and report a bug after verifying that the
 168 problem is not already known.  *Note Reporting Bugs::, for instructions
 169 on reporting bugs.  Note that some of the tests assume they are not
 170 being run by `root'.  We recommend you compile and test the GNU C
 171 Library as an unprivileged user.
 172
 173    Before reporting bugs make sure there is no problem with your system.
 174 The tests (and later installation) use some pre-existing files of the
 175 system such as `/etc/passwd', `/etc/nsswitch.conf' and others.  These
 176 files must all contain correct and sensible content.
 177
 178    To format the `GNU C Library Reference Manual' for printing, type
 179 `make dvi'.  You need a working TeX installation to do this.  The
 180 distribution builds the on-line formatted version of the manual, as
 181 Info files, as part of the build process.  You can build them manually
 182 with `make info'.
 183
 184    The library has a number of special-purpose configuration parameters
 185 which you can find in `Makeconfig'.  These can be overwritten with the
 186 file `configparms'.  To change them, create a `configparms' in your
 187 build directory and add values as appropriate for your system.  The
 188 file is included and parsed by `make' and has to follow the conventions
 189 for makefiles.
 190
 191    It is easy to configure the GNU C Library for cross-compilation by
 192 setting a few variables in `configparms'.  Set `CC' to the
 193 cross-compiler for the target you configured the library for; it is
 194 important to use this same `CC' value when running `configure', like
 195 this: `CC=TARGET-gcc configure TARGET'.  Set `BUILD_CC' to the compiler
 196 to use for programs run on the build system as part of compiling the
 197 library.  You may need to set `AR' to cross-compiling versions of `ar'
 198 if the native tools are not configured to work with object files for
 199 the target you configured for.  When cross-compiling the GNU C Library,
 200 it may be tested using `make check
 201 test-wrapper="SRCDIR/scripts/cross-test-ssh.sh HOSTNAME"', where SRCDIR
 202 is the absolute directory name for the main source directory and
 203 HOSTNAME is the host name of a system that can run the newly built
 204 binaries of the GNU C Library.  The source and build directories must
 205 be visible at the same locations on both the build system and HOSTNAME.
 206
 207 Installing the C Library
 208 ========================
 209
 210 To install the library and its header files, and the Info files of the
 211 manual, type `env LANGUAGE=C LC_ALL=C make install'.  This will build
 212 things, if necessary, before installing them; however, you should still
 213 compile everything first.  If you are installing the GNU C Library as
 214 your primary C library, we recommend that you shut the system down to
 215 single-user mode first, and reboot afterward.  This minimizes the risk
 216 of breaking things when the library changes out from underneath.
 217
 218    `make install' will do the entire job of upgrading from a previous
 219 installation of the GNU C Library version 2.x.  There may sometimes be
 220 headers left behind from the previous installation, but those are
 221 generally harmless.  If you want to avoid leaving headers behind you
 222 can do things in the following order.
 223
 224    You must first build the library (`make'), optionally check it
 225 (`make check'), switch the include directories and then install (`make
 226 install').  The steps must be done in this order.  Not moving the
 227 directory before install will result in an unusable mixture of header
 228 files from both libraries, but configuring, building, and checking the
 229 library requires the ability to compile and run programs against the old
 230 library.  The new `/usr/include', after switching the include
 231 directories and before installing the library should contain the Linux
 232 headers, but nothing else.  If you do this, you will need to restore
 233 any headers from libraries other than the GNU C Library yourself after
 234 installing the library.
 235
 236    You can install the GNU C Library somewhere other than where you
 237 configured it to go by setting the `install_root' variable on the
 238 command line for `make install'.  The value of this variable is
 239 prepended to all the paths for installation.  This is useful when
 240 setting up a chroot environment or preparing a binary distribution.
 241 The directory should be specified with an absolute file name.
 242
 243    The GNU C Library includes a daemon called `nscd', which you may or
 244 may not want to run.  `nscd' caches name service lookups; it can
 245 dramatically improve performance with NIS+, and may help with DNS as
 246 well.
 247
 248    One auxiliary program, `/usr/libexec/pt_chown', is installed setuid
 249 `root'.  This program is invoked by the `grantpt' function; it sets the
 250 permissions on a pseudoterminal so it can be used by the calling
 251 process.  This means programs like `xterm' and `screen' do not have to
 252 be setuid to get a pty.  (There may be other reasons why they need
 253 privileges.)  If you are using a Linux kernel with the `devptsfs' or
 254 `devfs' filesystems providing pty slaves, you don't need this program;
 255 otherwise you do.  The source for `pt_chown' is in
 256 `login/programs/pt_chown.c'.
 257
 258    After installation you might want to configure the timezone and
 259 locale installation of your system.  The GNU C Library comes with a
 260 locale database which gets configured with `localedef'.  For example, to
 261 set up a German locale with name `de_DE', simply issue the command
 262 `localedef -i de_DE -f ISO-8859-1 de_DE'.  To configure all locales
 263 that are supported by the GNU C Library, you can issue from your build
 264 directory the command `make localedata/install-locales'.
 265
 266    To configure the locally used timezone, set the `TZ' environment
 267 variable.  The script `tzselect' helps you to select the right value.
 268 As an example, for Germany, `tzselect' would tell you to use
 269 `TZ='Europe/Berlin''.  For a system wide installation (the given paths
 270 are for an installation with `--prefix=/usr'), link the timezone file
 271 which is in `/usr/share/zoneinfo' to the file `/etc/localtime'.  For
 272 Germany, you might execute `ln -s /usr/share/zoneinfo/Europe/Berlin
 273 /etc/localtime'.
 274
 275 Recommended Tools for Compilation
 276 =================================
 277
 278 We recommend installing the following GNU tools before attempting to
 279 build the GNU C Library:
 280
 281    * GNU `make' 3.79 or newer
 282
 283      You need the latest version of GNU `make'.  Modifying the GNU C
 284      Library to work with other `make' programs would be so difficult
 285      that we recommend you port GNU `make' instead.  *Really.*  We
 286      recommend GNU `make' version 3.79.  All earlier versions have
 287      severe bugs or lack features.
 288
 289    * GCC 4.3 or newer, GCC 4.6 recommended
 290
 291      GCC 4.3 or higher is required; as of this writing, GCC 4.6 is the
 292      compiler we advise to use to build the GNU C Library.
 293
 294      You can use whatever compiler you like to compile programs that use
 295      the GNU C Library.
 296
 297      Check the FAQ for any special compiler issues on particular
 298      platforms.
 299
 300    * GNU `binutils' 2.20 or later
 301
 302      You must use GNU `binutils' (as and ld) to build the GNU C Library.
 303      No other assembler or linker has the necessary functionality at the
 304      moment.
 305
 306    * GNU `texinfo' 4.5 or later
 307
 308      To correctly translate and install the Texinfo documentation you
 309      need this version of the `texinfo' package.  Earlier versions do
 310      not understand all the tags used in the document, and the
 311      installation mechanism for the info files is not present or works
 312      differently.
 313
 314    * GNU `awk' 3.0, or higher
 315
 316      `Awk' is used in several places to generate files.  `gawk' 3.0 is
 317      known to work.
 318
 319    * Perl 5
 320
 321      Perl is not required, but it is used if present to test the
 322      installation.  We may decide to use it elsewhere in the future.
 323
 324    * GNU `sed' 3.02 or newer
 325
 326      `Sed' is used in several places to generate files.  Most scripts
 327      work with any version of `sed'.  The known exception is the script
 328      `po2test.sed' in the `intl' subdirectory which is used to generate
 329      `msgs.h' for the test suite.  This script works correctly only
 330      with GNU `sed' 3.02.  If you like to run the test suite, you
 331      should definitely upgrade `sed'.
 332
 333
 334 If you change any of the `configure.in' files you will also need
 335
 336    * GNU `autoconf' 2.53 or higher
 337
 338 and if you change any of the message translation files you will need
 339
 340    * GNU `gettext' 0.10.36 or later
 341
 342 You may also need these packages if you upgrade your source tree using
 343 patches, although we try to avoid this.
 344
 345 Specific advice for GNU/Linux systems
 346 =====================================
 347
 348 If you are installing the GNU C Library on GNU/Linux systems, you need
 349 to have the header files from a 2.6.19.1 or newer kernel around for
 350 reference.  These headers must be installed using `make
 351 headers_install'; the headers present in the kernel source directory
 352 are not suitable for direct use by the GNU C Library.  You do not need
 353 to use that kernel, just have its headers installed where the GNU C
 354 Library can access them, referred to here as INSTALL-DIRECTORY.  The
 355 easiest way to do this is to unpack it in a directory such as
 356 `/usr/src/linux-VERSION'.  In that directory, run `make headers_install
 357 INSTALL_HDR_PATH=INSTALL-DIRECTORY'.  Finally, configure the GNU C
 358 Library with the option `--with-headers=INSTALL-DIRECTORY/include'.
 359 Use the most recent kernel you can get your hands on.  (If you are
 360 cross-compiling the GNU C Library, you need to specify
 361 `ARCH=ARCHITECTURE' in the `make headers_install' command, where
 362 ARCHITECTURE is the architecture name used by the Linux kernel, such as
 363 `x86' or `powerpc'.)
 364
 365    After installing the GNU C Library, you may need to remove or rename
 366 directories such as `/usr/include/linux' and `/usr/include/asm', and
 367 replace them with copies of directories such as `linux' and `asm' from
 368 `INSTALL-DIRECTORY/include'.  All directories present in
 369 `INSTALL-DIRECTORY/include' should be copied, except that the GNU C
 370 Library provides its own version of `/usr/include/scsi'; the files
 371 provided by the kernel should be copied without replacing those
 372 provided by the GNU C Library.  The `linux', `asm' and `asm-generic'
 373 directories are required to compile programs using the GNU C Library;
 374 the other directories describe interfaces to the kernel but are not
 375 required if not compiling programs using those interfaces.  You do not
 376 need to copy kernel headers if you did not specify an alternate kernel
 377 header source using `--with-headers'.
 378
 379    The Filesystem Hierarchy Standard for GNU/Linux systems expects some
 380 components of the GNU C Library installation to be in `/lib' and some
 381 in `/usr/lib'.  This is handled automatically if you configure the GNU
 382 C Library with `--prefix=/usr'.  If you set some other prefix or allow
 383 it to default to `/usr/local', then all the components are installed
 384 there.
 385
 386 Reporting Bugs
 387 ==============
 388
 389 There are probably bugs in the GNU C Library.  There are certainly
 390 errors and omissions in this manual.  If you report them, they will get
 391 fixed.  If you don't, no one will ever know about them and they will
 392 remain unfixed for all eternity, if not longer.
 393
 394    It is a good idea to verify that the problem has not already been
 395 reported.  Bugs are documented in two places: The file `BUGS' describes
 396 a number of well known bugs and the bug tracking system has a WWW
 397 interface at `http://sourceware.org/bugzilla/'.  The WWW interface
 398 gives you access to open and closed reports.  A closed report normally
 399 includes a patch or a hint on solving the problem.
 400
 401    To report a bug, first you must find it.  With any luck, this will
 402 be the hard part.  Once you've found a bug, make sure it's really a
 403 bug.  A good way to do this is to see if the GNU C Library behaves the
 404 same way some other C library does.  If so, probably you are wrong and
 405 the libraries are right (but not necessarily).  If not, one of the
 406 libraries is probably wrong.  It might not be the GNU C Library.  Many
 407 historical Unix C libraries permit things that we don't, such as
 408 closing a file twice.
 409
 410    If you think you have found some way in which the GNU C Library does
 411 not conform to the ISO and POSIX standards (*note Standards and
 412 Portability::), that is definitely a bug.  Report it!
 413
 414    Once you're sure you've found a bug, try to narrow it down to the
 415 smallest test case that reproduces the problem.  In the case of a C
 416 library, you really only need to narrow it down to one library function
 417 call, if possible.  This should not be too difficult.
 418
 419    The final step when you have a simple test case is to report the bug.
 420 Do this using the WWW interface to the bug database.
 421
 422    If you are not sure how a function should behave, and this manual
 423 doesn't tell you, that's a bug in the manual.  Report that too!  If the
 424 function's behavior disagrees with the manual, then either the library
 425 or the manual has a bug, so report the disagreement.  If you find any
 426 errors or omissions in this manual, please report them to the bug
 427 database.  If you refer to specific sections of the manual, please
 428 include the section names for easier identification.