Add FSF statement to ayc_PE locale.
[glibc.git] / INSTALL
blob2c61704b8f99ee73c8c151641f3eeeda68f38ce6
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.
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.
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 `--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.
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.
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.
131 `--enable-hardcoded-path-in-tests'
132      By default, dynamic tests are linked to run with the installed C
133      library.  This option hardcodes the newly built C library path in
134      dynamic tests so that they can be invoked directly.
136 `--enable-lock-elision=yes'
137      Enable lock elision for pthread mutexes by default.
139 `--enable-pt_chown'
140      The file `pt_chown' is a helper binary for `grantpt' (*note
141      Pseudo-Terminals: Allocation.) that is installed setuid root to
142      fix up pseudo-terminal ownership.  It is not built by default
143      because systems using the Linux kernel are commonly built with the
144      `devpts' filesystem enabled and mounted at `/dev/pts', which
145      manages pseudo-terminal ownership automatically.  By using
146      `--enable-pt_chown', you may build `pt_chown' and install it
147      setuid and owned by `root'.  The use of `pt_chown' introduces
148      additional security risks to the system and you should enable it
149      only if you understand and accept those risks.
151 `--build=BUILD-SYSTEM'
152 `--host=HOST-SYSTEM'
153      These options are for cross-compiling.  If you specify both
154      options and BUILD-SYSTEM is different from HOST-SYSTEM, `configure'
155      will prepare to cross-compile the GNU C Library from BUILD-SYSTEM
156      to be used on HOST-SYSTEM.  You'll probably need the
157      `--with-headers' option too, and you may have to override
158      CONFIGURE's selection of the compiler and/or binutils.
160      If you only specify `--host', `configure' will prepare for a
161      native compile but use what you specify instead of guessing what
162      your system is. This is most useful to change the CPU submodel.
163      For example, if `configure' guesses your machine as
164      `i686-pc-linux-gnu' but you want to compile a library for 586es,
165      give `--host=i586-pc-linux-gnu' or just `--host=i586-linux' and add
166      the appropriate compiler flags (`-mcpu=i586' will do the trick) to
167      CFLAGS.
169      If you specify just `--build', `configure' will get confused.
171 `--with-pkgversion=VERSION'
172      Specify a description, possibly including a build number or build
173      date, of the binaries being built, to be included in `--version'
174      output from programs installed with the GNU C Library.  For
175      example, `--with-pkgversion='FooBar GNU/Linux glibc build 123''.
176      The default value is `GNU libc'.
178 `--with-bugurl=URL'
179      Specify the URL that users should visit if they wish to report a
180      bug, to be included in `--help' output from programs installed with
181      the GNU C Library.  The default value refers to the main
182      bug-reporting information for the GNU C Library.
184    To build the library and related programs, type `make'.  This will
185 produce a lot of output, some of which may look like errors from `make'
186 but isn't.  Look for error messages from `make' containing `***'.
187 Those indicate that something is seriously wrong.
189    The compilation process can take a long time, depending on the
190 configuration and the speed of your machine.  Some complex modules may
191 take a very long time to compile, as much as several minutes on slower
192 machines.  Do not panic if the compiler appears to hang.
194    If you want to run a parallel make, simply pass the `-j' option with
195 an appropriate numeric parameter to `make'.  You need a recent GNU
196 `make' version, though.
198    To build and run test programs which exercise some of the library
199 facilities, type `make check'.  If it does not complete successfully,
200 do not use the built library, and report a bug after verifying that the
201 problem is not already known.  *Note Reporting Bugs::, for instructions
202 on reporting bugs.  Note that some of the tests assume they are not
203 being run by `root'.  We recommend you compile and test the GNU C
204 Library as an unprivileged user.
206    Before reporting bugs make sure there is no problem with your system.
207 The tests (and later installation) use some pre-existing files of the
208 system such as `/etc/passwd', `/etc/nsswitch.conf' and others.  These
209 files must all contain correct and sensible content.
211    To format the `GNU C Library Reference Manual' for printing, type
212 `make dvi'.  You need a working TeX installation to do this.  The
213 distribution builds the on-line formatted version of the manual, as
214 Info files, as part of the build process.  You can build them manually
215 with `make info'.
217    The library has a number of special-purpose configuration parameters
218 which you can find in `Makeconfig'.  These can be overwritten with the
219 file `configparms'.  To change them, create a `configparms' in your
220 build directory and add values as appropriate for your system.  The
221 file is included and parsed by `make' and has to follow the conventions
222 for makefiles.
224    It is easy to configure the GNU C Library for cross-compilation by
225 setting a few variables in `configparms'.  Set `CC' to the
226 cross-compiler for the target you configured the library for; it is
227 important to use this same `CC' value when running `configure', like
228 this: `CC=TARGET-gcc configure TARGET'.  Set `BUILD_CC' to the compiler
229 to use for programs run on the build system as part of compiling the
230 library.  You may need to set `AR' to cross-compiling versions of `ar'
231 if the native tools are not configured to work with object files for
232 the target you configured for.  When cross-compiling the GNU C Library,
233 it may be tested using `make check
234 test-wrapper="SRCDIR/scripts/cross-test-ssh.sh HOSTNAME"', where SRCDIR
235 is the absolute directory name for the main source directory and
236 HOSTNAME is the host name of a system that can run the newly built
237 binaries of the GNU C Library.  The source and build directories must
238 be visible at the same locations on both the build system and HOSTNAME.
240    In general, when testing the GNU C Library, `test-wrapper' may be set
241 to the name and arguments of any program to run newly built binaries.
242 This program must preserve the arguments to the binary being run, its
243 working directory, all environment variables set as part of testing and
244 the standard input, output and error file descriptors.  If
245 `TEST-WRAPPER env' will not work to run a program with environment
246 variables set, then `test-wrapper-env' must be set to a program that
247 runs a newly built program with environment variable assignments in
248 effect, those assignments being specified as `VAR=VALUE' before the
249 name of the program to be run.
251 Installing the C Library
252 ========================
254 To install the library and its header files, and the Info files of the
255 manual, type `env LANGUAGE=C LC_ALL=C make install'.  This will build
256 things, if necessary, before installing them; however, you should still
257 compile everything first.  If you are installing the GNU C Library as
258 your primary C library, we recommend that you shut the system down to
259 single-user mode first, and reboot afterward.  This minimizes the risk
260 of breaking things when the library changes out from underneath.
262    `make install' will do the entire job of upgrading from a previous
263 installation of the GNU C Library version 2.x.  There may sometimes be
264 headers left behind from the previous installation, but those are
265 generally harmless.  If you want to avoid leaving headers behind you
266 can do things in the following order.
268    You must first build the library (`make'), optionally check it
269 (`make check'), switch the include directories and then install (`make
270 install').  The steps must be done in this order.  Not moving the
271 directory before install will result in an unusable mixture of header
272 files from both libraries, but configuring, building, and checking the
273 library requires the ability to compile and run programs against the old
274 library.  The new `/usr/include', after switching the include
275 directories and before installing the library should contain the Linux
276 headers, but nothing else.  If you do this, you will need to restore
277 any headers from libraries other than the GNU C Library yourself after
278 installing the library.
280    You can install the GNU C Library somewhere other than where you
281 configured it to go by setting the `install_root' variable on the
282 command line for `make install'.  The value of this variable is
283 prepended to all the paths for installation.  This is useful when
284 setting up a chroot environment or preparing a binary distribution.
285 The directory should be specified with an absolute file name.
287    The GNU C Library includes a daemon called `nscd', which you may or
288 may not want to run.  `nscd' caches name service lookups; it can
289 dramatically improve performance with NIS+, and may help with DNS as
290 well.
292    One auxiliary program, `/usr/libexec/pt_chown', is installed setuid
293 `root'.  This program is invoked by the `grantpt' function; it sets the
294 permissions on a pseudoterminal so it can be used by the calling
295 process.  This means programs like `xterm' and `screen' do not have to
296 be setuid to get a pty.  (There may be other reasons why they need
297 privileges.)  If you are using a Linux kernel with the `devptsfs' or
298 `devfs' filesystems providing pty slaves, you don't need this program;
299 otherwise you do.  The source for `pt_chown' is in
300 `login/programs/pt_chown.c'.
302    After installation you might want to configure the timezone and
303 locale installation of your system.  The GNU C Library comes with a
304 locale database which gets configured with `localedef'.  For example, to
305 set up a German locale with name `de_DE', simply issue the command
306 `localedef -i de_DE -f ISO-8859-1 de_DE'.  To configure all locales
307 that are supported by the GNU C Library, you can issue from your build
308 directory the command `make localedata/install-locales'.
310    To configure the locally used timezone, set the `TZ' environment
311 variable.  The script `tzselect' helps you to select the right value.
312 As an example, for Germany, `tzselect' would tell you to use
313 `TZ='Europe/Berlin''.  For a system wide installation (the given paths
314 are for an installation with `--prefix=/usr'), link the timezone file
315 which is in `/usr/share/zoneinfo' to the file `/etc/localtime'.  For
316 Germany, you might execute `ln -s /usr/share/zoneinfo/Europe/Berlin
317 /etc/localtime'.
319 Recommended Tools for Compilation
320 =================================
322 We recommend installing the following GNU tools before attempting to
323 build the GNU C Library:
325    * GNU `make' 3.79 or newer
327      You need the latest version of GNU `make'.  Modifying the GNU C
328      Library to work with other `make' programs would be so difficult
329      that we recommend you port GNU `make' instead.  *Really.*  We
330      recommend GNU `make' version 3.79.  All earlier versions have
331      severe bugs or lack features.
333    * GCC 4.4 or newer, GCC 4.6 recommended
335      GCC 4.4 or higher is required; as of this writing, GCC 4.6 is the
336      compiler we advise to use to build the GNU C Library.
338      You can use whatever compiler you like to compile programs that use
339      the GNU C Library.
341      Check the FAQ for any special compiler issues on particular
342      platforms.
344    * GNU `binutils' 2.20 or later
346      You must use GNU `binutils' (as and ld) to build the GNU C Library.
347      No other assembler or linker has the necessary functionality at the
348      moment.
350    * GNU `texinfo' 4.5 or later
352      To correctly translate and install the Texinfo documentation you
353      need this version of the `texinfo' package.  Earlier versions do
354      not understand all the tags used in the document, and the
355      installation mechanism for the info files is not present or works
356      differently.
358    * GNU `awk' 3.1.2, or higher
360      `awk' is used in several places to generate files.  Some `gawk'
361      extensions are used, including the `asorti' function, which was
362      introduced in version 3.1.2 of `gawk'.
364    * Perl 5
366      Perl is not required, but it is used if present to test the
367      installation.  We may decide to use it elsewhere in the future.
369    * GNU `sed' 3.02 or newer
371      `Sed' is used in several places to generate files.  Most scripts
372      work with any version of `sed'.  The known exception is the script
373      `po2test.sed' in the `intl' subdirectory which is used to generate
374      `msgs.h' for the test suite.  This script works correctly only
375      with GNU `sed' 3.02.  If you like to run the test suite, you
376      should definitely upgrade `sed'.
379 If you change any of the `configure.in' files you will also need
381    * GNU `autoconf' 2.53 or higher
383 and if you change any of the message translation files you will need
385    * GNU `gettext' 0.10.36 or later
387 You may also need these packages if you upgrade your source tree using
388 patches, although we try to avoid this.
390 Specific advice for GNU/Linux systems
391 =====================================
393 If you are installing the GNU C Library on GNU/Linux systems, you need
394 to have the header files from a 2.6.19.1 or newer kernel around for
395 reference.  These headers must be installed using `make
396 headers_install'; the headers present in the kernel source directory
397 are not suitable for direct use by the GNU C Library.  You do not need
398 to use that kernel, just have its headers installed where the GNU C
399 Library can access them, referred to here as INSTALL-DIRECTORY.  The
400 easiest way to do this is to unpack it in a directory such as
401 `/usr/src/linux-VERSION'.  In that directory, run `make headers_install
402 INSTALL_HDR_PATH=INSTALL-DIRECTORY'.  Finally, configure the GNU C
403 Library with the option `--with-headers=INSTALL-DIRECTORY/include'.
404 Use the most recent kernel you can get your hands on.  (If you are
405 cross-compiling the GNU C Library, you need to specify
406 `ARCH=ARCHITECTURE' in the `make headers_install' command, where
407 ARCHITECTURE is the architecture name used by the Linux kernel, such as
408 `x86' or `powerpc'.)
410    After installing the GNU C Library, you may need to remove or rename
411 directories such as `/usr/include/linux' and `/usr/include/asm', and
412 replace them with copies of directories such as `linux' and `asm' from
413 `INSTALL-DIRECTORY/include'.  All directories present in
414 `INSTALL-DIRECTORY/include' should be copied, except that the GNU C
415 Library provides its own version of `/usr/include/scsi'; the files
416 provided by the kernel should be copied without replacing those
417 provided by the GNU C Library.  The `linux', `asm' and `asm-generic'
418 directories are required to compile programs using the GNU C Library;
419 the other directories describe interfaces to the kernel but are not
420 required if not compiling programs using those interfaces.  You do not
421 need to copy kernel headers if you did not specify an alternate kernel
422 header source using `--with-headers'.
424    The Filesystem Hierarchy Standard for GNU/Linux systems expects some
425 components of the GNU C Library installation to be in `/lib' and some
426 in `/usr/lib'.  This is handled automatically if you configure the GNU
427 C Library with `--prefix=/usr'.  If you set some other prefix or allow
428 it to default to `/usr/local', then all the components are installed
429 there.
431 Reporting Bugs
432 ==============
434 There are probably bugs in the GNU C Library.  There are certainly
435 errors and omissions in this manual.  If you report them, they will get
436 fixed.  If you don't, no one will ever know about them and they will
437 remain unfixed for all eternity, if not longer.
439    It is a good idea to verify that the problem has not already been
440 reported.  Bugs are documented in two places: The file `BUGS' describes
441 a number of well known bugs and the central GNU C Library bug tracking
442 system has a WWW interface at `http://sourceware.org/bugzilla/'.  The
443 WWW interface gives you access to open and closed reports.  A closed
444 report normally includes a patch or a hint on solving the problem.
446    To report a bug, first you must find it.  With any luck, this will
447 be the hard part.  Once you've found a bug, make sure it's really a
448 bug.  A good way to do this is to see if the GNU C Library behaves the
449 same way some other C library does.  If so, probably you are wrong and
450 the libraries are right (but not necessarily).  If not, one of the
451 libraries is probably wrong.  It might not be the GNU C Library.  Many
452 historical Unix C libraries permit things that we don't, such as
453 closing a file twice.
455    If you think you have found some way in which the GNU C Library does
456 not conform to the ISO and POSIX standards (*note Standards and
457 Portability::), that is definitely a bug.  Report it!
459    Once you're sure you've found a bug, try to narrow it down to the
460 smallest test case that reproduces the problem.  In the case of a C
461 library, you really only need to narrow it down to one library function
462 call, if possible.  This should not be too difficult.
464    The final step when you have a simple test case is to report the bug.
465 Do this at `http://www.gnu.org/software/libc/bugs.html'.
467    If you are not sure how a function should behave, and this manual
468 doesn't tell you, that's a bug in the manual.  Report that too!  If the
469 function's behavior disagrees with the manual, then either the library
470 or the manual has a bug, so report the disagreement.  If you find any
471 errors or omissions in this manual, please report them to the bug
472 database.  If you refer to specific sections of the manual, please
473 include the section names for easier identification.