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