INSTALL

   1 Installing the GNU C Library
   2 ****************************
   3
   4 Before you do anything else, you should read the file `FAQ' located at
   5 the top level of the source tree.  This file answers common questions
   6 and describes problems you may experience with compilation and
   7 installation.  It is updated more frequently than this manual.
   8
   9    Features can be added to GNU Libc via "add-on" bundles.  These are
  10 separate tar files, which you unpack into the top level of the source
  11 tree.  Then you give `configure' the `--enable-add-ons' option to
  12 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 GNU Libc
  19 ==================================
  20
  21 GNU libc can be compiled in the source directory, but we strongly advise
  22 building it in a separate build directory.  For example, if you have
  23 unpacked the glibc sources in `/src/gnu/glibc-2.3', create a directory
  24 `/src/gnu/glibc-build' to put the object files in.  This allows
  25 removing the whole build directory in case an error occurs, which is the
  26 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-2.3/configure ARGS...
  32
  33    Please note that even if you're building in a separate build
  34 directory, the compilation needs to modify a few files in the source
  35 directory, especially some files in the manual subdirectory.
  36
  37 `configure' takes many options, but you can get away with knowing only
  38 two: `--prefix' and `--enable-add-ons'.  The `--prefix' option tells
  39 `configure' where you want glibc installed. This defaults to
  40 `/usr/local'.  The `--enable-add-ons' option tells `configure' to use
  41 all the add-on bundles it finds in the source directory.  Since
  42 important functionality is provided in add-ons, you should always
  43 specify this option.
  44
  45    It may also be useful to set the CC and CFLAGS variables in the
  46 environment when running `configure'.  CC selects the C compiler that
  47 will be used, and CFLAGS sets optimization options for the compiler.
  48
  49    The following list describes all of the available options for
  50 `configure':
  51
  52 `--prefix=DIRECTORY'
  53      Install machine-independent data files in subdirectories of
  54      `DIRECTORY'.  The default is to install in `/usr/local'.
  55
  56 `--exec-prefix=DIRECTORY'
  57      Install the library and other machine-dependent files in
  58      subdirectories of `DIRECTORY'.  The default is to the `--prefix'
  59      directory if that option is specified, or `/usr/local' otherwise.
  60
  61 `--with-headers=DIRECTORY'
  62      Look for kernel header files in DIRECTORY, not `/usr/include'.
  63      Glibc needs information from the kernel's private header files.
  64      Glibc will normally look in `/usr/include' for them, but if you
  65      specify this 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 glibc.  Conflicts can
  69      occasionally happen in this case.  Note that Linux libc5 qualifies
  70      as an older version of glibc.  You can also use this option if you
  71      want to compile glibc with a newer set of kernel headers than the
  72      ones found in `/usr/include'.
  73
  74 `--enable-add-ons[=LIST]'
  75      Enable add-on packages in your source tree.  If this option is
  76      specified with no list, it enables all the add-on packages it
  77      finds.  If you do not wish to use some add-on packages that you
  78      have present in your source tree, give this option a list of the
  79      add-ons that you _do_ want used, like this: `--enable-add-ons=nptl'
  80
  81 `--enable-kernel=VERSION'
  82      This option is currently only useful on GNU/Linux systems.  The
  83      VERSION parameter should have the form X.Y.Z and describes the
  84      smallest version of the Linux kernel the generated library is
  85      expected to support.  The higher the VERSION number is, the less
  86      compatibility code is added, and the faster the code gets.
  87
  88 `--with-binutils=DIRECTORY'
  89      Use the binutils (assembler and linker) in `DIRECTORY', not the
  90      ones the C compiler would default to.  You can use this option if
  91      the default binutils on your system cannot deal with all the
  92      constructs in the GNU C library.  In that case, `configure' will
  93      detect the problem and suppress these constructs, so that the
  94      library will still be usable, but functionality may be lost--for
  95      example, you can't build a shared libc with old binutils.
  96
  97 `--without-fp'
  98      Use this option if your computer lacks hardware floating-point
  99      support and your operating system does not emulate an FPU.
 100
 101      these
 102
 103 `--disable-shared'
 104      Don't build shared libraries even if it is possible.  Not all
 105      systems support shared libraries; you need ELF support and
 106      (currently) the GNU linker.
 107
 108 `--disable-profile'
 109      Don't build libraries with profiling information.  You may want to
 110      use this option if you don't plan to do profiling.
 111
 112 `--enable-omitfp'
 113      Use maximum optimization for the normal (static and shared)
 114      libraries, and compile separate static libraries with debugging
 115      information and no optimization.  We recommend not doing this.
 116      The extra optimization doesn't gain you much, it may provoke
 117      compiler bugs, and you won't be able to trace bugs through the C
 118      library.
 119
 120 `--disable-versioning'
 121      Don't compile the shared libraries with symbol version information.
 122      Doing this will make the resulting library incompatible with old
 123      binaries, so it's not recommended.
 124
 125 `--enable-static-nss'
 126      Compile static versions of the NSS (Name Service Switch) libraries.
 127      This is not recommended because it defeats the purpose of NSS; a
 128      program linked statically with the NSS libraries cannot be
 129      dynamically reconfigured to use a different name database.
 130
 131 `--without-tls'
 132      By default the C library is built with support for thread-local
 133      storage if the used tools support it.  By using `--without-tls'
 134      this can be prevented though there generally is no reason since it
 135      creates compatibility problems.
 136
 137 `--build=BUILD-SYSTEM'
 138 `--host=HOST-SYSTEM'
 139      These options are for cross-compiling.  If you specify both
 140      options and BUILD-SYSTEM is different from HOST-SYSTEM, `configure'
 141      will prepare to cross-compile glibc from BUILD-SYSTEM to be used
 142      on HOST-SYSTEM.  You'll probably need the `--with-headers' option
 143      too, and you may have to override CONFIGURE's selection of the
 144      compiler and/or binutils.
 145
 146      If you only specify `--host', `configure' will prepare for a
 147      native compile but use what you specify instead of guessing what
 148      your system is. This is most useful to change the CPU submodel.
 149      For example, if `configure' guesses your machine as
 150      `i586-pc-linux-gnu' but you want to compile a library for 386es,
 151      give `--host=i386-pc-linux-gnu' or just `--host=i386-linux' and add
 152      the appropriate compiler flags (`-mcpu=i386' will do the trick) to
 153      CFLAGS.
 154
 155      If you specify just `--build', `configure' will get confused.
 156
 157    To build the library and related programs, type `make'.  This will
 158 produce a lot of output, some of which may look like errors from `make'
 159 but isn't.  Look for error messages from `make' containing `***'.
 160 Those indicate that something is seriously wrong.
 161
 162    The compilation process can take several hours.  Expect at least two
 163 hours for the default configuration on i586 for GNU/Linux.  For Hurd,
 164 times are much longer.  Some complex modules may take a very long time
 165 to compile, as much as several minutes on slower machines.  Do not
 166 panic if the compiler appears to hang.
 167
 168    If you want to run a parallel make, simply pass the `-j' option with
 169 an appropriate numeric parameter to `make'.  You need a recent GNU
 170 `make' version, though.
 171
 172    To build and run test programs which exercise some of the library
 173 facilities, type `make check'.  If it does not complete successfully,
 174 do not use the built library, and report a bug after verifying that the
 175 problem is not already known.  *Note Reporting Bugs::, for instructions
 176 on reporting bugs.  Note that some of the tests assume they are not
 177 being run by `root'.  We recommend you compile and test glibc as an
 178 unprivileged user.
 179
 180    Before reporting bugs make sure there is no problem with your system.
 181 The tests (and later installation) use some pre-existing files of the
 182 system such as `/etc/passwd', `/etc/nsswitch.conf' and others.  These
 183 files must all contain correct and sensible content.
 184
 185    To format the `GNU C Library Reference Manual' for printing, type
 186 `make dvi'.  You need a working TeX installation to do this.  The
 187 distribution already includes the on-line formatted version of the
 188 manual, as Info files.  You can regenerate those with `make info', but
 189 it shouldn't be necessary.
 190
 191    The library has a number of special-purpose configuration parameters
 192 which you can find in `Makeconfig'.  These can be overwritten with the
 193 file `configparms'.  To change them, create a `configparms' in your
 194 build directory and add values as appropriate for your system.  The
 195 file is included and parsed by `make' and has to follow the conventions
 196 for makefiles.
 197
 198    It is easy to configure the GNU C library for cross-compilation by
 199 setting a few variables in `configparms'.  Set `CC' to the
 200 cross-compiler for the target you configured the library for; it is
 201 important to use this same `CC' value when running `configure', like
 202 this: `CC=TARGET-gcc configure TARGET'.  Set `BUILD_CC' to the compiler
 203 to use for programs run on the build system as part of compiling the
 204 library.  You may need to set `AR' and `RANLIB' to cross-compiling
 205 versions of `ar' and `ranlib' if the native tools are not configured to
 206 work with object files for the target you configured for.
 207
 208 Installing the C Library
 209 ========================
 210
 211 To install the library and its header files, and the Info files of the
 212 manual, type `env LANGUAGE=C LC_ALL=C make install'.  This will build
 213 things, if necessary, before installing them; however, you should still
 214 compile everything first.  If you are installing glibc as your primary
 215 C library, we recommend that you shut the system down to single-user
 216 mode first, and reboot afterward.  This minimizes the risk of breaking
 217 things when the library changes out from underneath.
 218
 219    If you're upgrading from Linux libc5 or some other C library, you
 220 need to replace the `/usr/include' with a fresh directory before
 221 installing it.  The new `/usr/include' should contain the Linux
 222 headers, but nothing else.
 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.
 231
 232    If you are upgrading from a previous installation of glibc 2.0 or
 233 2.1, `make install' will do the entire job.  You do not need to remove
 234 the old includes - if you want to do so anyway you must then follow the
 235 order given above.
 236
 237    You may also need to reconfigure GCC to work with the new library.
 238 The easiest way to do that is to figure out the compiler switches to
 239 make it work again (`-Wl,--dynamic-linker=/lib/ld-linux.so.2' should
 240 work on GNU/Linux systems) and use them to recompile gcc.  You can also
 241 edit the specs file (`/usr/lib/gcc-lib/TARGET/VERSION/specs'), but that
 242 is a bit of a black art.
 243
 244    You can install glibc somewhere other than where you configured it
 245 to go by setting the `install_root' variable on the command line for
 246 `make install'.  The value of this variable is prepended to all the
 247 paths for installation.  This is useful when setting up a chroot
 248 environment or preparing a binary distribution.  The directory should be
 249 specified with an absolute file name.
 250
 251    Glibc 2.2 includes a daemon called `nscd', which you may or may not
 252 want to run.  `nscd' caches name service lookups; it can dramatically
 253 improve performance with NIS+, and may help with DNS as well.
 254
 255    One auxiliary program, `/usr/libexec/pt_chown', is installed setuid
 256 `root'.  This program is invoked by the `grantpt' function; it sets the
 257 permissions on a pseudoterminal so it can be used by the calling
 258 process.  This means programs like `xterm' and `screen' do not have to
 259 be setuid to get a pty.  (There may be other reasons why they need
 260 privileges.)  If you are using a 2.1 or newer Linux kernel with the
 261 `devptsfs' or `devfs' filesystems providing pty slaves, you don't need
 262 this program; otherwise you do.  The source for `pt_chown' is in
 263 `login/programs/pt_chown.c'.
 264
 265    After installation you might want to configure the timezone and
 266 locale installation of your system.  The GNU C library comes with a
 267 locale database which gets configured with `localedef'.  For example, to
 268 set up a German locale with name `de_DE', simply issue the command
 269 `localedef -i de_DE -f ISO-8859-1 de_DE'.  To configure all locales
 270 that are supported by glibc, you can issue from your build directory the
 271 command `make localedata/install-locales'.
 272
 273    To configure the locally used timezone, set the `TZ' environment
 274 variable.  The script `tzselect' helps you to select the right value.
 275 As an example, for Germany, `tzselect' would tell you to use
 276 `TZ='Europe/Berlin''.  For a system wide installation (the given paths
 277 are for an installation with `--prefix=/usr'), link the timezone file
 278 which is in `/usr/share/zoneinfo' to the file `/etc/localtime'.  For
 279 Germany, you might execute `ln -s /usr/share/zoneinfo/Europe/Berlin
 280 /etc/localtime'.
 281
 282 Recommended Tools for Compilation
 283 =================================
 284
 285 We recommend installing the following GNU tools before attempting to
 286 build the GNU C library:
 287
 288    * GNU `make' 3.79 or newer
 289
 290      You need the latest version of GNU `make'.  Modifying the GNU C
 291      Library to work with other `make' programs would be so difficult
 292      that we recommend you port GNU `make' instead.  *Really.*  We
 293      recommend GNU `make' version 3.79.  All earlier versions have
 294      severe bugs or lack features.
 295
 296    * GCC 3.4 or newer, GCC 4.1 recommended
 297
 298      The GNU C library can only be compiled with the GNU C compiler
 299      family.  For the 2.3 releases, GCC 3.2 or higher is required; GCC
 300      3.4 is the compiler we advise to use for 2.3 versions.  For the
 301      2.4 release, GCC 3.4 or higher is required; as of this writing,
 302      GCC 4.1 is the compiler we advise to use for current versions.  On
 303      certain machines including `powerpc64', compilers prior to GCC 4.0
 304      have bugs that prevent them compiling the C library code in the
 305      2.4 release.  On other machines, GCC 4.1 is required to build the C
 306      library with support for the correct `long double' type format;
 307      these include `powerpc' (32 bit), `s390' and `s390x'.
 308
 309      You can use whatever compiler you like to compile programs that
 310      use GNU libc, but be aware that both GCC 2.7 and 2.8 have bugs in
 311      their floating-point support that may be triggered by the math
 312      library.
 313
 314      Check the FAQ for any special compiler issues on particular
 315      platforms.
 316
 317    * GNU `binutils' 2.15 or later
 318
 319      You must use GNU `binutils' (as and ld) to build the GNU C library.
 320      No other assembler or linker has the necessary functionality at the
 321      moment.
 322
 323    * GNU `texinfo' 3.12f
 324
 325      To correctly translate and install the Texinfo documentation you
 326      need this version of the `texinfo' package.  Earlier versions do
 327      not understand all the tags used in the document, and the
 328      installation mechanism for the info files is not present or works
 329      differently.
 330
 331    * GNU `awk' 3.0, or higher
 332
 333      `Awk' is used in several places to generate files.  `gawk' 3.0 is
 334      known to work.
 335
 336    * Perl 5
 337
 338      Perl is not required, but it is used if present to test the
 339      installation.  We may decide to use it elsewhere in the future.
 340
 341    * GNU `sed' 3.02 or newer
 342
 343      `Sed' is used in several places to generate files.  Most scripts
 344      work with any version of `sed'.  The known exception is the script
 345      `po2test.sed' in the `intl' subdirectory which is used to generate
 346      `msgs.h' for the test suite.  This script works correctly only
 347      with GNU `sed' 3.02.  If you like to run the test suite, you
 348      should definitely upgrade `sed'.
 349
 350
 351 If you change any of the `configure.in' files you will also need
 352
 353    * GNU `autoconf' 2.53 or higher
 354
 355 and if you change any of the message translation files you will need
 356
 357    * GNU `gettext' 0.10.36 or later
 358
 359 You may also need these packages if you upgrade your source tree using
 360 patches, although we try to avoid this.
 361
 362 Supported Configurations
 363 ========================
 364
 365 The GNU C Library currently supports configurations that match the
 366 following patterns:
 367
 368      alpha*-*-linux
 369      arm-*-linux
 370      cris-*-linux
 371      hppa-*-linux
 372      iX86-*-gnu
 373      iX86-*-linux
 374      ia64-*-linux
 375      m68k-*-linux
 376      mips*-*-linux
 377      powerpc-*-linux
 378      s390-*-linux
 379      s390x-*-linux
 380      sparc-*-linux
 381      sparc64-*-linux
 382      x86_64-*-linux
 383
 384    Former releases of this library (version 2.1 and/or 2.0) used to run
 385 on the following configurations:
 386
 387      arm-*-linuxaout
 388      arm-*-none
 389
 390    Very early releases (version 1.09.1 and perhaps earlier versions)
 391 used to run on the following configurations:
 392
 393      alpha-dec-osf1
 394      alpha-*-linuxecoff
 395      iX86-*-bsd4.3
 396      iX86-*-isc2.2
 397      iX86-*-isc3.N
 398      iX86-*-sco3.2
 399      iX86-*-sco3.2v4
 400      iX86-*-sysv
 401      iX86-*-sysv4
 402      iX86-force_cpu386-none
 403      iX86-sequent-bsd
 404      i960-nindy960-none
 405      m68k-hp-bsd4.3
 406      m68k-mvme135-none
 407      m68k-mvme136-none
 408      m68k-sony-newsos3
 409      m68k-sony-newsos4
 410      m68k-sun-sunos4.N
 411      mips-dec-ultrix4.N
 412      mips-sgi-irix4.N
 413      sparc-sun-solaris2.N
 414      sparc-sun-sunos4.N
 415
 416    Since no one has volunteered to test and fix these configurations,
 417 they are not supported at the moment.  They probably don't compile;
 418 they definitely don't work anymore.  Porting the library is not hard.
 419 If you are interested in doing a port, please contact the glibc
 420 maintainers.  Start at `http://www.gnu.org/software/libc/' and read the
 421 references there on how to go about getting involved and contacting the
 422 developers.
 423
 424    Valid cases of `iX86' include `i386', `i486', `i586', and `i686'.
 425 All of those configurations produce a library that can run on this
 426 processor and newer processors.  The GCC compiler by default generates
 427 code that's optimized for the machine it's configured for and will use
 428 the instructions available on that machine.  For example if your GCC is
 429 configured for `i686', gcc will optimize for `i686' and might issue
 430 some `i686' specific instructions.  To generate code for other models,
 431 you have to configure for that model and give GCC the appropriate
 432 `-march=' and `-mcpu=' compiler switches via CFLAGS.
 433
 434 Specific advice for GNU/Linux systems
 435 =====================================
 436
 437 If you are installing GNU libc on a GNU/Linux system, you need to have
 438 the header files from a 2.2 or newer kernel around for reference.  For
 439 some architectures, like ia64, sh and hppa, you need at least headers
 440 from kernel 2.3.99 (sh and hppa) or 2.4.0 (ia64).  You do not need to
 441 use that kernel, just have its headers where glibc can access at them.
 442 The easiest way to do this is to unpack it in a directory such as
 443 `/usr/src/linux-2.2.1'.  In that directory, run `make config' and
 444 accept all the defaults.  Then run `make include/linux/version.h'.
 445 Finally, configure glibc with the option
 446 `--with-headers=/usr/src/linux-2.2.1/include'.  Use the most recent
 447 kernel you can get your hands on.
 448
 449    An alternate tactic is to unpack the 2.2 kernel and run `make
 450 config' as above; then, rename or delete `/usr/include', create a new
 451 `/usr/include', and make symbolic links of `/usr/include/linux' and
 452 `/usr/include/asm' into the kernel sources.  You can then configure
 453 glibc with no special options.  This tactic is recommended if you are
 454 upgrading from libc5, since you need to get rid of the old header files
 455 anyway.
 456
 457    After installing GNU libc, you may need to remove or rename
 458 `/usr/include/linux' and `/usr/include/asm', and replace them with
 459 copies of `include/linux' and `include/asm-$ARCHITECTURE' taken from
 460 the Linux source package which supplied kernel headers for building the
 461 library.  ARCHITECTURE will be the machine architecture for which the
 462 library was built, such as `i386' or `alpha'.  You do not need to do
 463 this if you did not specify an alternate kernel header source using
 464 `--with-headers'.  The intent here is that these directories should be
 465 copies of, *not* symlinks to, the kernel headers used to build the
 466 library.
 467
 468    Note that `/usr/include/net' and `/usr/include/scsi' should *not* be
 469 symlinks into the kernel sources.  GNU libc provides its own versions
 470 of these files.
 471
 472    GNU/Linux expects some components of the libc installation to be in
 473 `/lib' and some in `/usr/lib'.  This is handled automatically if you
 474 configure glibc with `--prefix=/usr'.  If you set some other prefix or
 475 allow it to default to `/usr/local', then all the components are
 476 installed there.
 477
 478    If you are upgrading from libc5, you need to recompile every shared
 479 library on your system against the new library for the sake of new code,
 480 but keep the old libraries around for old binaries to use.  This is
 481 complicated and difficult.  Consult the Glibc2 HOWTO at
 482 `http://www.imaxx.net/~thrytis/glibc' for details.
 483
 484    You cannot use `nscd' with 2.0 kernels, due to bugs in the
 485 kernel-side thread support.  `nscd' happens to hit these bugs
 486 particularly hard, but you might have problems with any threaded
 487 program.
 488
 489 Reporting Bugs
 490 ==============
 491
 492 There are probably bugs in the GNU C library.  There are certainly
 493 errors and omissions in this manual.  If you report them, they will get
 494 fixed.  If you don't, no one will ever know about them and they will
 495 remain unfixed for all eternity, if not longer.
 496
 497    It is a good idea to verify that the problem has not already been
 498 reported.  Bugs are documented in two places: The file `BUGS' describes
 499 a number of well known bugs and the bug tracking system has a WWW
 500 interface at `http://sources.redhat.com/bugzilla/'.  The WWW interface
 501 gives you access to open and closed reports.  A closed report normally
 502 includes a patch or a hint on solving the problem.
 503
 504    To report a bug, first you must find it.  With any luck, this will
 505 be the hard part.  Once you've found a bug, make sure it's really a
 506 bug.  A good way to do this is to see if the GNU C library behaves the
 507 same way some other C library does.  If so, probably you are wrong and
 508 the libraries are right (but not necessarily).  If not, one of the
 509 libraries is probably wrong.  It might not be the GNU library.  Many
 510 historical Unix C libraries permit things that we don't, such as
 511 closing a file twice.
 512
 513    If you think you have found some way in which the GNU C library does
 514 not conform to the ISO and POSIX standards (*note Standards and
 515 Portability::), that is definitely a bug.  Report it!
 516
 517    Once you're sure you've found a bug, try to narrow it down to the
 518 smallest test case that reproduces the problem.  In the case of a C
 519 library, you really only need to narrow it down to one library function
 520 call, if possible.  This should not be too difficult.
 521
 522    The final step when you have a simple test case is to report the bug.
 523 Do this using the WWW interface to the bug database.
 524
 525    If you are not sure how a function should behave, and this manual
 526 doesn't tell you, that's a bug in the manual.  Report that too!  If the
 527 function's behavior disagrees with the manual, then either the library
 528 or the manual has a bug, so report the disagreement.  If you find any
 529 errors or omissions in this manual, please report them to the bug
 530 database.  If you refer to specific sections of the manual, please
 531 include the section names for easier identification.
 532