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