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