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' found 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 tarfiles 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 to build 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' found
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 all
49 the add-on bundles it finds in the source directory.  Since important
50 functionality is provided in add-ons, you should always specify this
51 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      It 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 package 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 `--with-binutils=DIRECTORY'
91      Use the binutils (assembler and linker) in `DIRECTORY', not the
92      ones the C compiler would default to.  You could use this option if
93      the default binutils on your system cannot deal with all the
94      constructs in the GNU C library.  In that case, `configure' will
95      detect the problem and suppress these constructs, so that the
96      library will still be usable, but functionality may be lost--for
97      example, you can't build a shared libc with old binutils.
98
99 `--without-fp'
100      Use this option if your computer lacks hardware floating-point
101      support and your operating system does not emulate an FPU.
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 optimisation.  We recommend against this.  The
116      extra optimization doesn't gain you much, it may provoke compiler
117      bugs, and you won't be able to trace bugs through the C library.
118
119 `--disable-versioning'
120      Don't compile the shared libraries with symbol version information.
121      Doing this will make the resulting library incompatible with old
122      binaries, so it's not recommended.
123
124 `--enable-static-nss'
125      Compile static versions of the NSS (Name Service Switch) libraries.
126      This is not recommended because it defeats the purpose of NSS; a
127      program linked statically with the NSS libraries cannot be
128      dynamically reconfigured to use a different name database.
129
130 `--build=BUILD-SYSTEM'
131 `--host=HOST-SYSTEM'
132      These options are for cross-compiling.  If you specify both
133      options and BUILD-SYSTEM is different from HOST-SYSTEM, `configure'
134      will prepare to cross-compile glibc from BUILD-SYSTEM to be used
135      on HOST-SYSTEM.  You'll probably need the `--with-headers' option
136      too, and you may have to override CONFIGURE's selection of the
137      compiler and/or binutils.
138
139      If you only specify `--host', configure will prepare for a native
140      compile but use what you specify instead of guessing what your
141      system is.  This is most useful to change the CPU submodel.  For
142      example, if configure guesses your machine as `i586-pc-linux-gnu'
143      but you want to compile a library for 386es, give
144      `--host=i386-pc-linux-gnu' or just `--host=i386-linux' and add the
145      appropriate compiler flags (`-mcpu=i386' will do the trick) to
146      CFLAGS.
147
148      If you specify just `--build', configure will get confused.
149
150    To build the library and related programs, type `make'.  This will
151 produce a lot of output, some of which may look like errors from `make'
152 but isn't.  Look for error messages from `make' containing `***'.
153 Those indicate that something is really wrong.
154
155    The compilation process takes several hours even on fast hardware.
156 Expect at least two hours for the default configuration on i586 for
157 Linux.  For Hurd times are much longer.  Except for EGCS 1.1 and GCC
158 2.95 (and later versions of GCC), all supported versions of GCC have a
159 problem which causes them to take several minutes to compile certain
160 files in the iconvdata directory.  Do not panic if the compiler appears
161 to hang.
162
163    If you want to run a parallel make, you can't just give `make' the
164 `-j' option, because it won't be passed down to the sub-makes.
165 Instead, edit the generated `Makefile' and uncomment the line
166
167      # PARALLELMFLAGS = -j 4
168
169 You can change the `4' to some other number as appropriate for your
170 system.  Instead of changing the `Makefile', you could give this option
171 directly to `make' and call it as, for example, `make
172 PARALLELMFLAGS=-j4'.  If you're building in the source directory, you
173 must use the latter approach since in this case no new `Makefile' is
174 generated for you to change.
175
176    To build and run test programs which exercise some of the library
177 facilities, type `make check'.  If it does not complete successfully,
178 do not use the built library, and report a bug after verifying that the
179 problem is not already known.  *Note Reporting Bugs::, for instructions
180 on reporting bugs.  Note that some of the tests assume they are not
181 being run by `root'.  We recommend you compile and test glibc as an
182 unprivileged user.
183
184    To format the `GNU C Library Reference Manual' for printing, type
185 `make dvi'.  You need a working TeX installation to do this.  The
186 distribution already includes the on-line formatted version of the
187 manual, as Info files.  You can regenerate those with `make info', but
188 it shouldn't be necessary.
189
190    The library has a number of special-purpose configuration parameters
191 which you can find in `Makeconfig'.  These can be overwritten with the
192 file `configparms'.  To change them, create a `configparms' in your
193 build directory and add values as appropriate for your system.  The
194 file is included and parsed by `make' and has to follow the conventions
195 for makefiles.
196
197    It is easy to configure the GNU C library for cross-compilation by
198 setting a few variables in `configparms'.  Set `CC' to the
199 cross-compiler for the target you configured the library for; it is
200 important to use this same `CC' value when running `configure', like
201 this: `CC=TARGET-gcc configure TARGET'.  Set `BUILD_CC' to the compiler
202 to use for for programs run on the build system as part of compiling
203 the library.  You may need to set `AR' and `RANLIB' to cross-compiling
204 versions of `ar' and `ranlib' if the native tools are not configured to
205 work with object files for the target you configured for.
206
207 Installing the C Library
208 ========================
209
210    To install the library and its header files, and the Info files of
211 the manual, type `make install'.  This will build things if necessary,
212 before installing them.  However, you should still compile everything
213 first.  If you are installing glibc as your primary C library, we
214 recommend that you shut the system down to single-user mode first, and
215 reboot afterward.  This minimizes the risk of breaking things when the
216 library changes out from underneath.
217
218    If you're upgrading from Linux libc5 or some other C library, you
219 need to replace the `/usr/include' with a fresh directory before
220 installing it.  The new `/usr/include' should contain the Linux
221 headers, but nothing else.
222
223    You must first build the library (`make'), optionally check it
224 (`make check'), switch the include directories and then install (`make
225 install').  The steps must be done in this order.  Not moving the
226 directory before install will result in an unusable mixture of header
227 files from both libraries, but configuring, building, and checking the
228 library requires the ability to compile and run programs against the old
229 library.
230
231    If you are upgrading from a previous installation of glibc 2.0 or
232 2.1, `make install' will do the entire job.  You do not need to remove
233 the old includes - if you want to do so anyway you must then follow the
234 order given above.
235
236    You may also need to reconfigure GCC to work with the new library.
237 The easiest way to do that is to figure out the compiler switches to
238 make it work again (`-Wl,--dynamic-linker=/lib/ld-linux.so.2' should
239 work on Linux systems) and use them to recompile gcc.  You can also
240 edit the specs file (`/usr/lib/gcc-lib/TARGET/VERSION/specs'), but that
241 is a bit of a black art.
242
243    You can install glibc somewhere other than where you configured it
244 to go by setting the `install_root' variable on the command line for
245 `make install'.  The value of this variable is prepended to all the
246 paths for installation.  This is useful when setting up a chroot
247 environment or preparing a binary distribution.  The directory should be
248 specified with an absolute file name.
249
250    Glibc 2.2 includes a daemon called `nscd', which you may or may not
251 want to run.  `nscd' caches name service lookups; it can dramatically
252 improve performance with NIS+, and may help with DNS as well.
253
254    One auxiliary program, `/usr/libexec/pt_chown', is installed setuid
255 `root'.  This program is invoked by the `grantpt' function; it sets the
256 permissions on a pseudoterminal so it can be used by the calling
257 process.  This means programs like `xterm' and `screen' do not have to
258 be setuid to get a pty.  (There may be other reasons why they need
259 privileges.)  If you are using a 2.1 or newer Linux kernel with the
260 `devptsfs' or `devfs' filesystems providing pty slaves, you don't need
261 this program; otherwise you do.  The source for `pt_chown' is in
262 `login/programs/pt_chown.c'.
263
264    After installation you might want to configure the timezone and
265 locale installation of your system.  The GNU C library comes with a
266 locale database which gets configured with `localedef'.  For example, to
267 set up a German locale with name `de_DE', simply issue the command
268 `localedef -i de_DE -f ISO-8859-1 de_DE'.  To configure all locales
269 that are supported by glibc, you can issue from your build directory the
270 command `make localedata/install-locales'.
271
272    To configure the locally used timezone, you can either set the `TZ'
273 environment variable.  The script `tzselect' helps you to select the
274 right value.  As an example for Germany, tzselect would tell you to use
275 `TZ='Europe/Berlin''.  For a system wide installation (the given paths
276 are for an installation with `--prefix=/usr'), link the timezone file
277 which is in `/usr/share/zoneinfo' to the file `/etc/localtime'.  For
278 Germany, you might execute `ln -s /usr/share/zoneinfo/Europe/Berlin
279 /etc/localtime'.
280
281 Recommended Tools for Compilation
282 =================================
283
284    We recommend installing the following GNU tools before attempting to
285 build the GNU C library:
286
287    * GNU `make' 3.79 or newer
288
289      You need the latest version of GNU `make'.  Modifying the GNU C
290      Library to work with other `make' programs would be so difficult
291      that we recommend you port GNU `make' instead.  *Really.*  We
292      recommend version GNU `make' version 3.79.  All earlier versions
293      have severe bugs or lack features.
294
295    * EGCS 1.1.1, 1.1 or 1.0.3, or GCC 2.8.1, 2.95 or newer
296
297      The GNU C library can only be compiled with the GNU C compiler
298      family.  As of the 2.1 release, EGCS 1.0.3 or higher is required.
299      GCC 2.8.1 can also be used (but see the FAQ for reasons why you
300      might not want to).  Earlier versions simply are too buggy.  As of
301      this writing, GCC 2.95.2 is the compiler we advise to use.
302
303      You can use whatever compiler you like to compile programs that
304      use GNU libc, but be aware that both GCC 2.7 and 2.8 have bugs in
305      their floating-point support that may be triggered by the math
306      library.
307
308      On Alpha machines you need at least EGCS 1.1.1.  Earlier versions
309      don't work reliably.
310
311      For PPC you might need some patches even on top of the last EGCS
312      version.  See the FAQ.
313
314    * GNU `binutils' 2.9.1, 2.9.1.0.16, or later 2.9.1.0.x release
315
316      You must use GNU binutils (as and ld) if you want to build a shared
317      library.  Even if you don't, we recommend you use them anyway.  No
318      one has tested compilation with non-GNU binutils in a long time.
319
320      The quality of binutils releases has varied a bit recently.  The
321      bugs are in obscure features, but glibc uses quite a few of those.
322      2.9.1, 2.9.1.0.16, and later 2.9.1.0.x releases are known to
323      work.  Versions after 2.8.1.0.23 may or may not work.  Older
324      versions definitely don't.  2.9.1.0.16 or higher is required on
325      some platforms, like PPC and Arm.
326
327      For PPC you might need some patches even on top of the last
328      binutils version.  See the FAQ.
329
330    * GNU `texinfo' 3.12f
331
332      To correctly translate and install the Texinfo documentation you
333      need this version of the `texinfo' package.  Earlier versions do
334      not understand all the tags used in the document, and the
335      installation mechanism for the info files is not present or works
336      differently.
337
338    * GNU `awk' 3.0, or some other POSIX awk
339
340      Awk is used in several places to generate files.  The scripts
341      should work with any POSIX-compliant awk implementation; `gawk'
342      3.0 and `mawk' 1.3 are known to work.
343
344    * Perl 5
345
346      Perl is not required, but it is used if present to test the
347      installation.  We may decide to use it elsewhere in the future.
348
349    * GNU `sed' 3.02 or newer
350
351      Sed is used in several places to generate files.  Most scripts
352      work with any version of `sed'.  The known exception is the script
353      `po2test.sed' in the `intl' subdirectory which is used to generate
354      `msgs.h' for the testsuite.  This script works correctly only with
355      GNU `sed' 3.02.  If you like to run the testsuite, you should
356      definitly upgrade `sed'.
357
358
359 If you change any of the `configure.in' files you will also need
360
361    * GNU `autoconf' 2.12 or higher
362
363 and if you change any of the message translation files you will need
364
365    * GNU `gettext' 0.10.35 or later (version 0.10.35 is a alpha release
366      and available via ftp from alpha.gnu.org/gnu)
367
368 You may also need these packages if you upgrade your source tree using
369 patches, although we try to avoid this.
370
371 Supported Configurations
372 ========================
373
374    The GNU C Library currently supports configurations that match the
375 following patterns:
376
377      alpha*-*-linux
378      arm-*-linux
379      arm-*-linuxaout
380      arm-*-none
381      iX86-*-gnu
382      iX86-*-linux
383      ia64-*-linux
384      m68k-*-linux
385      mips*-*-linux
386      powerpc-*-linux
387      sparc-*-linux
388      sparc64-*-linux
389
390    Former releases of this library (version 1.09.1 and perhaps earlier
391 versions) 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 by sending electronic mail to <bug-glibc@gnu.org>.
421
422    Valid cases of `iX86' include `i386', `i486', `i586', and `i686'.
423 All of those configurations produce a library that can run on this
424 processor and newer processors.  The GCC compiler by default generates
425 code that's optimized for the machine it's configured for and will use
426 the instructions available on that machine.  For example if your GCC is
427 configured for `i686', gcc will optimize for `i686' and might issue
428 some `i686' specific instructions.  To generate code for other models,
429 you have to configure for that model and give GCC the appropriate
430 `-march=' and `-mcpu=' compiler switches via CFLAGS.
431
432 Specific advice for Linux systems
433 =================================
434
435    If you are installing GNU libc on a Linux system, you need to have
436 the header files from a 2.2 kernel around for reference.  You do not
437 need to use the 2.2 kernel, just have its headers where glibc can access
438 at them.  The easiest way to do this is to unpack it in a directory
439 such as `/usr/src/linux-2.2.1'.  In that directory, run `make config'
440 and accept all the defaults.  Then run `make include/linux/version.h'.
441 Finally, configure glibc with the option
442 `--with-headers=/usr/src/linux-2.2.1/include'.  Use the most recent
443 kernel you can get your hands on.
444
445    An alternate tactic is to unpack the 2.2 kernel and run `make
446 config' as above.  Then rename or delete `/usr/include', create a new
447 `/usr/include', and make the usual symbolic links of
448 `/usr/include/linux' and `/usr/include/asm' into the 2.2 kernel
449 sources.  You can then configure glibc with no special options.  This
450 tactic is recommended if you are upgrading from libc5, since you need
451 to get rid of the old header files anyway.
452
453    Note that `/usr/include/net' and `/usr/include/scsi' should *not* be
454 symlinks into the kernel sources.  GNU libc provides its own versions
455 of these files.
456
457    Linux expects some components of the libc installation to be in
458 `/lib' and some in `/usr/lib'.  This is handled automatically if you
459 configure glibc with `--prefix=/usr'.  If you set some other prefix or
460 allow it to default to `/usr/local', then all the components are
461 installed there.
462
463    If you are upgrading from libc5, you need to recompile every shared
464 library on your system against the new library for the sake of new code,
465 but keep the old libraries around for old binaries to use.  This is
466 complicated and difficult.  Consult the Glibc2 HOWTO at
467 <http://www.imaxx.net/~thrytis/glibc> for details.
468
469    You cannot use `nscd' with 2.0 kernels, due to bugs in the
470 kernel-side thread support.  `nscd' happens to hit these bugs
471 particularly hard, but you might have problems with any threaded
472 program.
473
474 Reporting Bugs
475 ==============
476
477    There are probably bugs in the GNU C library.  There are certainly
478 errors and omissions in this manual.  If you report them, they will get
479 fixed.  If you don't, no one will ever know about them and they will
480 remain unfixed for all eternity, if not longer.
481
482    It is a good idea to verify that the problem has not already been
483 reported.  Bugs are documented in two places: The file `BUGS' describes
484 a number of well known bugs and the bug tracking system has a WWW
485 interface at <http://www-gnats.gnu.org:8080/cgi-bin/wwwgnats.pl>.  The
486 WWW interface gives you access to open and closed reports.  The closed
487 reports normally include a patch or a hint on solving the problem.
488
489    To report a bug, first you must find it.  Hopefully, this will be the
490 hard part.  Once you've found a bug, make sure it's really a bug.  A
491 good way to do this is to see if the GNU C library behaves the same way
492 some other C library does.  If so, probably you are wrong and the
493 libraries are right (but not necessarily).  If not, one of the libraries
494 is probably wrong.  It might not be the GNU library.  Many historical
495 Unix C libraries permit things that we don't, such as closing a file
496 twice.
497
498    If you think you have found some way in which the GNU C library does
499 not conform to the ISO and POSIX standards (*note Standards and
500 Portability::), that is definitely a bug.  Report it!
501
502    Once you're sure you've found a bug, try to narrow it down to the
503 smallest test case that reproduces the problem.  In the case of a C
504 library, you really only need to narrow it down to one library function
505 call, if possible.  This should not be too difficult.
506
507    The final step when you have a simple test case is to report the bug.
508 Do this using the `glibcbug' script.  It is installed with libc, or if
509 you haven't installed it, will be in your build directory.  Send your
510 test case, the results you got, the results you expected, and what you
511 think the problem might be (if you've thought of anything).  `glibcbug'
512 will insert the configuration information we need to see, and ship the
513 report off to <bugs@gnu.org>.  Don't send a message there directly; it
514 is fed to a program that expects mail to be formatted in a particular
515 way.  Use the script.
516
517    If you are not sure how a function should behave, and this manual
518 doesn't tell you, that's a bug in the manual.  Report that too!  If the
519 function's behavior disagrees with the manual, then either the library
520 or the manual has a bug, so report the disagreement.  If you find any
521 errors or omissions in this manual, please report them to the Internet
522 address <bug-glibc-manual@gnu.org>.  If you refer to specific sections
523 of the manual, please include the section names for easier
524 identification.
525