diff options
Diffstat (limited to 'INSTALL')
| -rw-r--r-- | INSTALL | 192 |
1 files changed, 97 insertions, 95 deletions
diff --git a/INSTALL b/INSTALL index bb7850d978..748b2d3856 100644 --- a/INSTALL +++ b/INSTALL @@ -6,24 +6,24 @@ the top level of the source tree. This file answers common questions and describes problems you may experience with compilation and installation. It is updated more frequently than this manual. - Features can be added to GNU Libc via "add-on" bundles. These are -separate tar files, which you unpack into the top level of the source -tree. Then you give `configure' the `--enable-add-ons' option to -activate them, and they will be compiled into the library. + Features can be added to the GNU C Library via "add-on" bundles. +These are separate tar files, which you unpack into the top level of +the source tree. Then you give `configure' the `--enable-add-ons' +option to activate them, and they will be compiled into the library. You will need recent versions of several GNU tools: definitely GCC and GNU Make, and possibly others. *Note Tools for Compilation::, below. -Configuring and compiling GNU Libc -================================== +Configuring and compiling the GNU C Library +=========================================== -GNU libc cannot be compiled in the source directory. You must build it -in a separate build directory. For example, if you have unpacked the -glibc sources in `/src/gnu/glibc-VERSION', create a directory -`/src/gnu/glibc-build' to put the object files in. This allows -removing the whole build directory in case an error occurs, which is -the safest way to get a fresh start and should always be done. +The GNU C Library cannot be compiled in the source directory. You must +build it in a separate build directory. For example, if you have +unpacked the GNU C Library sources in `/src/gnu/glibc-VERSION', create +a directory `/src/gnu/glibc-build' to put the object files in. This +allows removing the whole build directory in case an error occurs, +which is the safest way to get a fresh start and should always be done. From your object directory, run the shell script `configure' located at the top level of the source tree. In the scenario above, you'd type @@ -36,10 +36,10 @@ directory, especially some files in the manual subdirectory. `configure' takes many options, but the only one that is usually mandatory is `--prefix'. This option tells `configure' where you want -glibc installed. This defaults to `/usr/local', but the normal setting -to install as the standard system library is `--prefix=/usr' for -GNU/Linux systems and `--prefix=' (an empty prefix) for GNU/Hurd -systems. +the GNU C Library installed. This defaults to `/usr/local', but the +normal setting to install as the standard system library is +`--prefix=/usr' for GNU/Linux systems and `--prefix=' (an empty prefix) +for GNU/Hurd systems. It may also be useful to set the CC and CFLAGS variables in the environment when running `configure'. CC selects the C compiler that @@ -59,16 +59,16 @@ will be used, and CFLAGS sets optimization options for the compiler. `--with-headers=DIRECTORY' Look for kernel header files in DIRECTORY, not `/usr/include'. - Glibc needs information from the kernel's header files describing - the interface to the kernel. Glibc will normally look in - `/usr/include' for them, but if you specify this option, it will - look in DIRECTORY instead. + The GNU C Library needs information from the kernel's header files + describing the interface to the kernel. The GNU C Library will + normally look in `/usr/include' for them, but if you specify this + option, it will look in DIRECTORY instead. This option is primarily of use on a system where the headers in - `/usr/include' come from an older version of glibc. Conflicts can - occasionally happen in this case. You can also use this option if - you want to compile glibc with a newer set of kernel headers than - the ones found in `/usr/include'. + `/usr/include' come from an older version of the GNU C Library. + Conflicts can occasionally happen in this case. You can also use + this option if you want to compile the GNU C Library with a newer + set of kernel headers than the ones found in `/usr/include'. `--enable-add-ons[=LIST]' Specify add-on packages to include in the build. If this option is @@ -93,7 +93,7 @@ will be used, and CFLAGS sets optimization options for the compiler. Use the binutils (assembler and linker) in `DIRECTORY', not the ones the C compiler would default to. You can use this option if the default binutils on your system cannot deal with all the - constructs in the GNU C library. In that case, `configure' will + constructs in the GNU C Library. In that case, `configure' will detect the problem and suppress these constructs, so that the library will still be usable, but functionality may be lost--for example, you can't build a shared libc with old binutils. @@ -132,10 +132,10 @@ will be used, and CFLAGS sets optimization options for the compiler. `--host=HOST-SYSTEM' These options are for cross-compiling. If you specify both options and BUILD-SYSTEM is different from HOST-SYSTEM, `configure' - will prepare to cross-compile glibc from BUILD-SYSTEM to be used - on HOST-SYSTEM. You'll probably need the `--with-headers' option - too, and you may have to override CONFIGURE's selection of the - compiler and/or binutils. + will prepare to cross-compile the GNU C Library from BUILD-SYSTEM + to be used on HOST-SYSTEM. You'll probably need the + `--with-headers' option too, and you may have to override + CONFIGURE's selection of the compiler and/or binutils. If you only specify `--host', `configure' will prepare for a native compile but use what you specify instead of guessing what @@ -167,8 +167,8 @@ facilities, type `make check'. If it does not complete successfully, do not use the built library, and report a bug after verifying that the problem is not already known. *Note Reporting Bugs::, for instructions on reporting bugs. Note that some of the tests assume they are not -being run by `root'. We recommend you compile and test glibc as an -unprivileged user. +being run by `root'. We recommend you compile and test the GNU C +Library as an unprivileged user. Before reporting bugs make sure there is no problem with your system. The tests (and later installation) use some pre-existing files of the @@ -188,7 +188,7 @@ build directory and add values as appropriate for your system. The file is included and parsed by `make' and has to follow the conventions for makefiles. - It is easy to configure the GNU C library for cross-compilation by + It is easy to configure the GNU C Library for cross-compilation by setting a few variables in `configparms'. Set `CC' to the cross-compiler for the target you configured the library for; it is important to use this same `CC' value when running `configure', like @@ -204,16 +204,16 @@ Installing the C Library To install the library and its header files, and the Info files of the manual, type `env LANGUAGE=C LC_ALL=C make install'. This will build things, if necessary, before installing them; however, you should still -compile everything first. If you are installing glibc as your primary -C library, we recommend that you shut the system down to single-user -mode first, and reboot afterward. This minimizes the risk of breaking -things when the library changes out from underneath. +compile everything first. If you are installing the GNU C Library as +your primary C library, we recommend that you shut the system down to +single-user mode first, and reboot afterward. This minimizes the risk +of breaking things when the library changes out from underneath. `make install' will do the entire job of upgrading from a previous -installation of glibc 2.x. There may sometimes be headers left behind -from the previous installation, but those are generally harmless. If -you want to avoid leaving headers behind you can do things in the -following order. +installation of the GNU C Library version 2.x. There may sometimes be +headers left behind from the previous installation, but those are +generally harmless. If you want to avoid leaving headers behind you +can do things in the following order. You must first build the library (`make'), optionally check it (`make check'), switch the include directories and then install (`make @@ -224,19 +224,20 @@ library requires the ability to compile and run programs against the old library. The new `/usr/include', after switching the include directories and before installing the library should contain the Linux headers, but nothing else. If you do this, you will need to restore -any headers from non-glibc libraries youself after installing the -library. +any headers from libraries other than the GNU C Library yourself after +installing the library. - You can install glibc somewhere other than where you configured it -to go by setting the `install_root' variable on the command line for -`make install'. The value of this variable is prepended to all the -paths for installation. This is useful when setting up a chroot -environment or preparing a binary distribution. The directory should be -specified with an absolute file name. + You can install the GNU C Library somewhere other than where you +configured it to go by setting the `install_root' variable on the +command line for `make install'. The value of this variable is +prepended to all the paths for installation. This is useful when +setting up a chroot environment or preparing a binary distribution. +The directory should be specified with an absolute file name. - Glibc includes a daemon called `nscd', which you may or may not want -to run. `nscd' caches name service lookups; it can dramatically -improve performance with NIS+, and may help with DNS as well. + The GNU C Library includes a daemon called `nscd', which you may or +may not want to run. `nscd' caches name service lookups; it can +dramatically improve performance with NIS+, and may help with DNS as +well. One auxiliary program, `/usr/libexec/pt_chown', is installed setuid `root'. This program is invoked by the `grantpt' function; it sets the @@ -249,12 +250,12 @@ this program; otherwise you do. The source for `pt_chown' is in `login/programs/pt_chown.c'. After installation you might want to configure the timezone and -locale installation of your system. The GNU C library comes with a +locale installation of your system. The GNU C Library comes with a locale database which gets configured with `localedef'. For example, to set up a German locale with name `de_DE', simply issue the command `localedef -i de_DE -f ISO-8859-1 de_DE'. To configure all locales -that are supported by glibc, you can issue from your build directory the -command `make localedata/install-locales'. +that are supported by the GNU C Library, you can issue from your build +directory the command `make localedata/install-locales'. To configure the locally used timezone, set the `TZ' environment variable. The script `tzselect' helps you to select the right value. @@ -269,7 +270,7 @@ Recommended Tools for Compilation ================================= We recommend installing the following GNU tools before attempting to -build the GNU C library: +build the GNU C Library: * GNU `make' 3.79 or newer @@ -282,17 +283,17 @@ build the GNU C library: * GCC 4.3 or newer, GCC 4.6 recommended GCC 4.3 or higher is required; as of this writing, GCC 4.6 is the - compiler we advise to use to build the GNU C library. + compiler we advise to use to build the GNU C Library. - You can use whatever compiler you like to compile programs that - use GNU libc. + You can use whatever compiler you like to compile programs that use + the GNU C Library. Check the FAQ for any special compiler issues on particular platforms. * GNU `binutils' 2.15 or later - You must use GNU `binutils' (as and ld) to build the GNU C library. + You must use GNU `binutils' (as and ld) to build the GNU C Library. No other assembler or linker has the necessary functionality at the moment. @@ -338,41 +339,42 @@ patches, although we try to avoid this. Specific advice for GNU/Linux systems ===================================== -If you are installing GNU libc on a GNU/Linux system, you need to have -the header files from a 2.6.19.1 or newer kernel around for reference. -These headers must be installed using `make headers_install'; the -headers present in the kernel source directory are not suitable for -direct use by GNU libc. You do not need to use that kernel, just have -its headers installed where glibc can access them, referred to here as -INSTALL-DIRECTORY. The easiest way to do this is to unpack it in a -directory such as `/usr/src/linux-VERSION'. In that directory, run -`make headers_install INSTALL_HDR_PATH=INSTALL-DIRECTORY'. Finally, -configure glibc with the option -`--with-headers=INSTALL-DIRECTORY/include'. Use the most recent kernel -you can get your hands on. (If you are cross-compiling GNU libc, you -need to specify `ARCH=ARCHITECTURE' in the `make headers_install' -command, where ARCHITECTURE is the architecture name used by the Linux -kernel, such as `x86' or `powerpc'.) - - After installing GNU libc, you may need to remove or rename +If you are installing the GNU C Library on a GNU/Linux system, you need +to have the header files from a 2.6.19.1 or newer kernel around for +reference. These headers must be installed using `make +headers_install'; the headers present in the kernel source directory +are not suitable for direct use by the GNU C Library. You do not need +to use that kernel, just have its headers installed where the GNU C +Library can access them, referred to here as INSTALL-DIRECTORY. The +easiest way to do this is to unpack it in a directory such as +`/usr/src/linux-VERSION'. In that directory, run `make headers_install +INSTALL_HDR_PATH=INSTALL-DIRECTORY'. Finally, configure the GNU C +Library with the option `--with-headers=INSTALL-DIRECTORY/include'. +Use the most recent kernel you can get your hands on. (If you are +cross-compiling the GNU C Library, you need to specify +`ARCH=ARCHITECTURE' in the `make headers_install' command, where +ARCHITECTURE is the architecture name used by the Linux kernel, such as +`x86' or `powerpc'.) + + After installing the GNU C Library, you may need to remove or rename directories such as `/usr/include/linux' and `/usr/include/asm', and replace them with copies of directories such as `linux' and `asm' from `INSTALL-DIRECTORY/include'. All directories present in -`INSTALL-DIRECTORY/include' should be copied, except that GNU libc -provides its own version of `/usr/include/scsi'; the files provided by -the kernel should be copied without replacing those provided by GNU -libc. The `linux', `asm' and `asm-generic' directories are required to -compile programs using GNU libc; the other directories describe -interfaces to the kernel but are not required if not compiling programs -using those interfaces. You do not need to copy kernel headers if you -did not specify an alternate kernel header source using -`--with-headers'. - - GNU/Linux expects some components of the libc installation to be in -`/lib' and some in `/usr/lib'. This is handled automatically if you -configure glibc with `--prefix=/usr'. If you set some other prefix or -allow it to default to `/usr/local', then all the components are -installed there. +`INSTALL-DIRECTORY/include' should be copied, except that the GNU C +Library provides its own version of `/usr/include/scsi'; the files +provided by the kernel should be copied without replacing those +provided by the GNU C Library. The `linux', `asm' and `asm-generic' +directories are required to compile programs using the GNU C Library; +the other directories describe interfaces to the kernel but are not +required if not compiling programs using those interfaces. You do not +need to copy kernel headers if you did not specify an alternate kernel +header source using `--with-headers'. + + GNU/Linux expects some components of the GNU C Library installation +to be in `/lib' and some in `/usr/lib'. This is handled automatically +if you configure the GNU C Library with `--prefix=/usr'. If you set +some other prefix or allow it to default to `/usr/local', then all the +components are installed there. You cannot use `nscd' with 2.0 kernels, due to bugs in the kernel-side thread support. `nscd' happens to hit these bugs @@ -382,7 +384,7 @@ program. Reporting Bugs ============== -There are probably bugs in the GNU C library. There are certainly +There are probably bugs in the GNU C Library. There are certainly errors and omissions in this manual. If you report them, they will get fixed. If you don't, no one will ever know about them and they will remain unfixed for all eternity, if not longer. @@ -396,14 +398,14 @@ includes a patch or a hint on solving the problem. To report a bug, first you must find it. With any luck, this will be the hard part. Once you've found a bug, make sure it's really a -bug. A good way to do this is to see if the GNU C library behaves the +bug. A good way to do this is to see if the GNU C Library behaves the same way some other C library does. If so, probably you are wrong and the libraries are right (but not necessarily). If not, one of the -libraries is probably wrong. It might not be the GNU library. Many +libraries is probably wrong. It might not be the GNU C Library. Many historical Unix C libraries permit things that we don't, such as closing a file twice. - If you think you have found some way in which the GNU C library does + If you think you have found some way in which the GNU C Library does not conform to the ISO and POSIX standards (*note Standards and Portability::), that is definitely a bug. Report it! |