Not needed anymore.
[kopensolaris-gnu/glibc.git] / INSTALL
1 Library Maintenance
2 *******************
3
4 How to Install the GNU C Library
5 ================================
6
7    Installation of the GNU C library is relatively simple, but usually
8 requires several GNU tools to be installed already.
9
10    To configure the GNU C library for your system, run the shell script
11 `configure' with `sh'.  Use an argument which is the conventional GNU
12 name for your system configuration--for example, `sparc-sun-sunos4.1',
13 for a Sun 4 running SunOS 4.1.  *Note Installation:
14 (gcc.info)Installation, for a full description of standard GNU
15 configuration names.  If you omit the configuration name, `configure'
16 will try to guess one for you by inspecting the system it is running
17 on.  It may or may not be able to come up with a guess, and the its
18 guess might be wrong.  `configure' will tell you the canonical name of
19 the chosen configuration before proceeding.
20
21    Here are some options that you should specify (if appropriate) when
22 you run `configure':
23
24 `--with-gnu-ld'
25      Use this option if you plan to use GNU `ld' to link programs with
26      the GNU C Library.  (We strongly recommend that you do.)  This
27      option enables use of features that exist only in GNU `ld'; so if
28      you configure for GNU `ld' you must use GNU `ld' *every time* you
29      link with the GNU C Library, and when building it.
30
31 `--with-gnu-as'
32      Use this option if you plan to use the GNU assembler, `gas', when
33      building the GNU C Library.  On some systems, the library may not
34      build properly if you do *not* use `gas'.
35
36 `--with-gnu-binutils'
37      This option implies both `--with-gnu-ld' and `--with-gnu-as'.  On
38      systems where GNU tools are the system tools, there is no need to
39      specify this option.  These include GNU, GNU/Linux, and free BSD
40      systems.
41
42 `--without-fp'
43 `--nfp'
44      Use this option if your computer lacks hardware floating-point
45      support.
46
47 `--prefix=DIRECTORY'
48      Install machine-independent data files in subdirectories of
49      `DIRECTORY'.  (You can also set this in `configparms'; see below.)
50
51 `--exec-prefix=DIRECTORY'
52      Install the library and other machine-dependent files in
53      subdirectories of `DIRECTORY'.  (You can also set this in
54      `configparms'; see below.)
55
56 `--enable-shared'
57 `--disable-shared'
58      Enable or disable building of an ELF shared library on systems that
59      support it.  The default is to build the shared library on systems
60      using ELF when the GNU `binutils' are available.
61
62 `--enable-profile'
63 `--disable-profile'
64      Enable or disable building of the profiled C library, `-lc_p'.  The
65      default is to build the profiled library.  You may wish to disable
66      it if you don't plan to do profiling, because it doubles the build
67      time of compiling just the unprofiled static library.
68
69 `--enable-omitfp'
70      Enable building a highly-optimized but possibly undebuggable
71      static C library.  This causes the normal static and shared (if
72      enabled) C libraries to be compiled with maximal optimization,
73      including the `-fomit-frame-pointer' switch that makes debugging
74      impossible on many machines, and without debugging information
75      (which makes the binaries substantially smaller).  An additional
76      static library is compiled with no optimization and full debugging
77      information, and installed as `-lc_g'.
78
79 `--enable-bounded'
80 `--disable-bounded'
81      Enable or disable building of the C library with support for bounded
82      pointers.  To do this one need the enhanced version of the GNU CC
83      with can generate code for bounded pointers.  This version of the
84      C library is necessary to run code which is also compiled using the
85      enhanced gcc for debugging purposes.
86
87 There are two more options:
88
89 `--with-gmp'
90 `--with-gettext'
91      These options are not of much use for the normal installer of the
92      GNU libc.  Only maintainers need this to get automatic updates of
93      the files from these packages in the GNU C library source tree.
94
95
96    The simplest way to run `configure' is to do it in the directory
97 that contains the library sources.  This prepares to build the library
98 in that very directory.
99
100    You can prepare to build the library in some other directory by going
101 to that other directory to run `configure'.  In order to run configure,
102 you will have to specify a directory for it, like this:
103
104      mkdir sun4
105      cd sun4
106      ../configure sparc-sun-sunos4.1
107
108 `configure' looks for the sources in whatever directory you specified
109 for finding `configure' itself.  It does not matter where in the file
110 system the source and build directories are--as long as you specify the
111 source directory when you run `configure', you will get the proper
112 results.
113
114    This feature lets you keep sources and binaries in different
115 directories, and that makes it easy to build the library for several
116 different machines from the same set of sources.  Simply create a build
117 directory for each target machine, and run `configure' in that
118 directory specifying the target machine's configuration name.
119
120    The library has a number of special-purpose configuration parameters.
121 These are defined in the file `Makeconfig'; see the comments in that
122 file for the details.
123
124    But don't edit the file `Makeconfig' yourself--instead, create a
125 file `configparms' in the directory where you are building the library,
126 and define in that file the parameters you want to specify.
127 `configparms' should *not* be an edited copy of `Makeconfig'; specify
128 only the parameters that you want to override.  To see how to set these
129 parameters, find the section of `Makeconfig' that says "These are the
130 configuration variables." Then for each parameter that you want to
131 change, copy the definition from `Makeconfig' to your new `configparms'
132 file, and change the value as appropriate for your system.
133
134    It is easy to configure the GNU C library for cross-compilation by
135 setting a few variables in `configparms'.  Set `CC' to the
136 cross-compiler for the target you configured the library for; it is
137 important to use this same `CC' value when running `configure', like
138 this: `CC=TARGET-gcc configure TARGET'.  Set `BUILD_CC' to the compiler
139 to use for for programs run on the build system as part of compiling
140 the library.  You may need to set `AR' and `RANLIB' to cross-compiling
141 versions of `ar' and `ranlib' if the native tools are not configured to
142 work with object files for the target you configured for.
143
144    Some of the machine-dependent code for some machines uses extensions
145 in the GNU C compiler, so you may need to compile the library with GCC.
146 (In fact, all of the existing complete ports require GCC.)
147
148    To build the library and related programs, type `make'.  This will
149 produce a lot of output, some of which may look like errors from `make'
150 (but isn't).  Look for error messages from `make' containing `***'.
151 Those indicate that something is really wrong.
152
153    To build and run some test programs which exercise some of the
154 library facilities, type `make check'.  This will produce several files
155 with names like `PROGRAM.out'.
156
157    To format the `GNU C Library Reference Manual' for printing, type
158 `make dvi'.
159
160    To install the library and its header files, and the Info files of
161 the manual, type `make install'.  This will build things if necessary,
162 before installing them.
163
164 Recommended Tools to Install the GNU C Library
165 ----------------------------------------------
166
167    We recommend installing the following GNU tools before attempting to
168 build the GNU C library:
169
170    * `make' 3.75
171
172      You need the latest version of GNU `make'.  Modifying the GNU C
173      Library to work with other `make' programs would be so hard that we
174      recommend you port GNU `make' instead.  *Really.* We recommend
175      version GNU `make' version 3.75 or later.
176
177    * GCC 2.7.2.1
178
179      On most platforms, the GNU C library can only be compiled with the
180      GNU C compiler.  We recommend GCC version 2.7.2 or later; earlier
181      versions may have problems.
182
183    * `binutils' 2.7
184
185      Using the GNU `binutils' (assembler, linker, and related tools) is
186      preferable when possible, and they are required to build an ELF
187      shared C library.  We recommend `binutils' version 2.7 or later;
188      earlier versions are known to have problems or to not support all
189      architectures.
190
191 Supported Configurations
192 ------------------------
193
194    The GNU C Library currently supports configurations that match the
195 following patterns:
196
197      alpha-ANYTHING-linux
198      alpha-ANYTHING-linuxecoff
199      iX86-ANYTHING-gnu
200      iX86-ANYTHING-linux
201      m68k-ANYTHING-linux
202      mips-ANYTHING-linux
203      sparc-ANYTHING-linux
204      powerpc-ANYTHING-linux
205
206    Former versions of this library used to support the following
207 configurations but the current status is unknown:
208
209      alpha-dec-osf1
210      iX86-ANYTHING-bsd4.3
211      iX86-ANYTHING-isc2.2
212      iX86-ANYTHING-isc3.N
213      iX86-ANYTHING-sco3.2
214      iX86-ANYTHING-sco3.2v4
215      iX86-ANYTHING-sysv
216      iX86-ANYTHING-sysv4
217      iX86-force_cpu386-none
218      iX86-sequent-bsd
219      i960-nindy960-none
220      m68k-hp-bsd4.3
221      m68k-mvme135-none
222      m68k-mvme136-none
223      m68k-sony-newsos3
224      m68k-sony-newsos4
225      m68k-sun-sunos4.N
226      mips-dec-ultrix4.N
227      mips-sgi-irix4.N
228      sparc-sun-solaris2.N
229      sparc-sun-sunos4.N
230
231    Each case of `iX86' can be `i386', `i486', `i586', or `i686'.  All
232 of those configurations produce a library that can run on any of these
233 processors.  The library will be optimized for the specified processor,
234 but will not use instructions not available on all of them.
235
236    While no other configurations are supported, there are handy aliases
237 for these few.  (These aliases work in other GNU software as well.)
238
239      decstation
240      hp320-bsd4.3 hp300bsd
241      i486-gnu
242      i586-linux
243      i386-sco
244      i386-sco3.2v4
245      i386-sequent-dynix
246      i386-svr4
247      news
248      sun3-sunos4.N sun3
249      sun4-solaris2.N sun4-sunos5.N
250      sun4-sunos4.N sun4
251
252 Reporting Bugs
253 ==============
254
255    There are probably bugs in the GNU C library.  There are certainly
256 errors and omissions in this manual.  If you report them, they will get
257 fixed.  If you don't, no one will ever know about them and they will
258 remain unfixed for all eternity, if not longer.
259
260    To report a bug, first you must find it.  Hopefully, this will be the
261 hard part.  Once you've found a bug, make sure it's really a bug.  A
262 good way to do this is to see if the GNU C library behaves the same way
263 some other C library does.  If so, probably you are wrong and the
264 libraries are right (but not necessarily).  If not, one of the libraries
265 is probably wrong.
266
267    Once you're sure you've found a bug, try to narrow it down to the
268 smallest test case that reproduces the problem.  In the case of a C
269 library, you really only need to narrow it down to one library function
270 call, if possible.  This should not be too difficult.
271
272    The final step when you have a simple test case is to report the bug.
273 When reporting a bug, send your test case, the results you got, the
274 results you expected, what you think the problem might be (if you've
275 thought of anything), your system type, and the version of the GNU C
276 library which you are using.  Also include the files `config.status'
277 and `config.make' which are created by running `configure'; they will
278 be in whatever directory was current when you ran `configure'.
279
280    If you think you have found some way in which the GNU C library does
281 not conform to the ANSI and POSIX standards (*note Standards and
282 Portability::.), that is definitely a bug.  Report it!
283
284    Send bug reports to the Internet address `bug-glibc@prep.ai.mit.edu'
285 or the UUCP path `mit-eddie!prep.ai.mit.edu!bug-glibc'.  If you have
286 other problems with installation or use, please report those as well.
287
288    If you are not sure how a function should behave, and this manual
289 doesn't tell you, that's a bug in the manual.  Report that too!  If the
290 function's behavior disagrees with the manual, then either the library
291 or the manual has a bug, so report the disagreement.  If you find any
292 errors or omissions in this manual, please report them to the Internet
293 address `bug-glibc-manual@prep.ai.mit.edu' or the UUCP path
294 `mit-eddie!prep.ai.mit.edu!bug-glibc-manual'.
295
296 Adding New Functions
297 ====================
298
299    The process of building the library is driven by the makefiles, which
300 make heavy use of special features of GNU `make'.  The makefiles are
301 very complex, and you probably don't want to try to understand them.
302 But what they do is fairly straightforward, and only requires that you
303 define a few variables in the right places.
304
305    The library sources are divided into subdirectories, grouped by
306 topic.
307
308    The `string' subdirectory has all the string-manipulation functions,
309 `math' has all the mathematical functions, etc.
310
311    Each subdirectory contains a simple makefile, called `Makefile',
312 which defines a few `make' variables and then includes the global
313 makefile `Rules' with a line like:
314
315      include ../Rules
316
317 The basic variables that a subdirectory makefile defines are:
318
319 `subdir'
320      The name of the subdirectory, for example `stdio'.  This variable
321      *must* be defined.
322
323 `headers'
324      The names of the header files in this section of the library, such
325      as `stdio.h'.
326
327 `routines'
328 `aux'
329      The names of the modules (source files) in this section of the
330      library.  These should be simple names, such as `strlen' (rather
331      than complete file names, such as `strlen.c').  Use `routines' for
332      modules that define functions in the library, and `aux' for
333      auxiliary modules containing things like data definitions.  But the
334      values of `routines' and `aux' are just concatenated, so there
335      really is no practical difference.
336
337 `tests'
338      The names of test programs for this section of the library.  These
339      should be simple names, such as `tester' (rather than complete file
340      names, such as `tester.c').  `make tests' will build and run all
341      the test programs.  If a test program needs input, put the test
342      data in a file called `TEST-PROGRAM.input'; it will be given to
343      the test program on its standard input.  If a test program wants
344      to be run with arguments, put the arguments (all on a single line)
345      in a file called `TEST-PROGRAM.args'.  Test programs should exit
346      with zero status when the test passes, and nonzero status when the
347      test indicates a bug in the library or error in building.
348
349 `others'
350      The names of "other" programs associated with this section of the
351      library.  These are programs which are not tests per se, but are
352      other small programs included with the library.  They are built by
353      `make others'.
354
355 `install-lib'
356 `install-data'
357 `install'
358      Files to be installed by `make install'.  Files listed in
359      `install-lib' are installed in the directory specified by `libdir'
360      in `configparms' or `Makeconfig' (*note Installation::.).  Files
361      listed in `install-data' are installed in the directory specified
362      by `datadir' in `configparms' or `Makeconfig'.  Files listed in
363      `install' are installed in the directory specified by `bindir' in
364      `configparms' or `Makeconfig'.
365
366 `distribute'
367      Other files from this subdirectory which should be put into a
368      distribution tar file.  You need not list here the makefile itself
369      or the source and header files listed in the other standard
370      variables.  Only define `distribute' if there are files used in an
371      unusual way that should go into the distribution.
372
373 `generated'
374      Files which are generated by `Makefile' in this subdirectory.
375      These files will be removed by `make clean', and they will never
376      go into a distribution.
377
378 `extra-objs'
379      Extra object files which are built by `Makefile' in this
380      subdirectory.  This should be a list of file names like `foo.o';
381      the files will actually be found in whatever directory object
382      files are being built in.  These files will be removed by
383      `make clean'.  This variable is used for secondary object files
384      needed to build `others' or `tests'.
385
386 Porting the GNU C Library
387 =========================
388
389    The GNU C library is written to be easily portable to a variety of
390 machines and operating systems.  Machine- and operating system-dependent
391 functions are well separated to make it easy to add implementations for
392 new machines or operating systems.  This section describes the layout of
393 the library source tree and explains the mechanisms used to select
394 machine-dependent code to use.
395
396    All the machine-dependent and operating system-dependent files in the
397 library are in the subdirectory `sysdeps' under the top-level library
398 source directory.  This directory contains a hierarchy of
399 subdirectories (*note Hierarchy Conventions::.).
400
401    Each subdirectory of `sysdeps' contains source files for a
402 particular machine or operating system, or for a class of machine or
403 operating system (for example, systems by a particular vendor, or all
404 machines that use IEEE 754 floating-point format).  A configuration
405 specifies an ordered list of these subdirectories.  Each subdirectory
406 implicitly appends its parent directory to the list.  For example,
407 specifying the list `unix/bsd/vax' is equivalent to specifying the list
408 `unix/bsd/vax unix/bsd unix'.  A subdirectory can also specify that it
409 implies other subdirectories which are not directly above it in the
410 directory hierarchy.  If the file `Implies' exists in a subdirectory,
411 it lists other subdirectories of `sysdeps' which are appended to the
412 list, appearing after the subdirectory containing the `Implies' file.
413 Lines in an `Implies' file that begin with a `#' character are ignored
414 as comments.  For example, `unix/bsd/Implies' contains:
415      # BSD has Internet-related things.
416      unix/inet
417
418 and `unix/Implies' contains:
419      posix
420
421 So the final list is `unix/bsd/vax unix/bsd unix/inet unix posix'.
422
423    `sysdeps' has two "special" subdirectories, called `generic' and
424 `stub'.  These two are always implicitly appended to the list of
425 subdirectories (in that order), so you needn't put them in an `Implies'
426 file, and you should not create any subdirectories under them intended
427 to be new specific categories.  `generic' is for things that can be
428 implemented in machine-independent C, using only other
429 machine-independent functions in the C library.  `stub' is for "stub"
430 versions of functions which cannot be implemented on a particular
431 machine or operating system.  The stub functions always return an
432 error, and set `errno' to `ENOSYS' (Function not implemented).  *Note
433 Error Reporting::.
434
435    A source file is known to be system-dependent by its having a
436 version in `generic' or `stub'; every generally-available function whose
437 implementation is system-dependent in should have either a generic or
438 stub implementation (there is no point in having both).  Some rare
439 functions are only useful on specific systems and aren't defined at all
440 on others; these do not appear anywhere in the system-independent
441 source code or makefiles (including the `generic' and `stub'
442 directories), only in the system-dependent `Makefile' in the specific
443 system's subdirectory.
444
445    If you come across a file that is in one of the main source
446 directories (`string', `stdio', etc.), and you want to write a machine-
447 or operating system-dependent version of it, move the file into
448 `sysdeps/generic' and write your new implementation in the appropriate
449 system-specific subdirectory.  Note that if a file is to be
450 system-dependent, it *must not* appear in one of the main source
451 directories.
452
453    There are a few special files that may exist in each subdirectory of
454 `sysdeps':
455
456 `Makefile'
457      A makefile for this machine or operating system, or class of
458      machine or operating system.  This file is included by the library
459      makefile `Makerules', which is used by the top-level makefile and
460      the subdirectory makefiles.  It can change the variables set in the
461      including makefile or add new rules.  It can use GNU `make'
462      conditional directives based on the variable `subdir' (see above)
463      to select different sets of variables and rules for different
464      sections of the library.  It can also set the `make' variable
465      `sysdep-routines', to specify extra modules to be included in the
466      library.  You should use `sysdep-routines' rather than adding
467      modules to `routines' because the latter is used in determining
468      what to distribute for each subdirectory of the main source tree.
469
470      Each makefile in a subdirectory in the ordered list of
471      subdirectories to be searched is included in order.  Since several
472      system-dependent makefiles may be included, each should append to
473      `sysdep-routines' rather than simply setting it:
474
475           sysdep-routines := $(sysdep-routines) foo bar
476
477 `Subdirs'
478      This file contains the names of new whole subdirectories under the
479      top-level library source tree that should be included for this
480      system.  These subdirectories are treated just like the
481      system-independent subdirectories in the library source tree, such
482      as `stdio' and `math'.
483
484      Use this when there are completely new sets of functions and header
485      files that should go into the library for the system this
486      subdirectory of `sysdeps' implements.  For example,
487      `sysdeps/unix/inet/Subdirs' contains `inet'; the `inet' directory
488      contains various network-oriented operations which only make sense
489      to put in the library on systems that support the Internet.
490
491 `Dist'
492      This file contains the names of files (relative to the
493      subdirectory of `sysdeps' in which it appears) which should be
494      included in the distribution.  List any new files used by rules in
495      the `Makefile' in the same directory, or header files used by the
496      source files in that directory.  You don't need to list files that
497      are implementations (either C or assembly source) of routines
498      whose names are given in the machine-independent makefiles in the
499      main source tree.
500
501 `configure'
502      This file is a shell script fragment to be run at configuration
503      time.  The top-level `configure' script uses the shell `.' command
504      to read the `configure' file in each system-dependent directory
505      chosen, in order.  The `configure' files are often generated from
506      `configure.in' files using Autoconf.
507
508      A system-dependent `configure' script will usually add things to
509      the shell variables `DEFS' and `config_vars'; see the top-level
510      `configure' script for details.  The script can check for
511      `--with-PACKAGE' options that were passed to the top-level
512      `configure'.  For an option `--with-PACKAGE=VALUE' `configure'
513      sets the shell variable `with_PACKAGE' (with any dashes in PACKAGE
514      converted to underscores) to VALUE; if the option is just
515      `--with-PACKAGE' (no argument), then it sets `with_PACKAGE' to
516      `yes'.
517
518 `configure.in'
519      This file is an Autoconf input fragment to be processed into the
520      file `configure' in this subdirectory.  *Note Introduction:
521      (autoconf.info)Introduction, for a description of Autoconf.  You
522      should write either `configure' or `configure.in', but not both.
523      The first line of `configure.in' should invoke the `m4' macro
524      `GLIBC_PROVIDES'.  This macro does several `AC_PROVIDE' calls for
525      Autoconf macros which are used by the top-level `configure'
526      script; without this, those macros might be invoked again
527      unnecessarily by Autoconf.
528
529    That is the general system for how system-dependencies are isolated.
530
531 Layout of the `sysdeps' Directory Hierarchy
532 -------------------------------------------
533
534    A GNU configuration name has three parts: the CPU type, the
535 manufacturer's name, and the operating system.  `configure' uses these
536 to pick the list of system-dependent directories to look for.  If the
537 `--nfp' option is *not* passed to `configure', the directory
538 `MACHINE/fpu' is also used.  The operating system often has a "base
539 operating system"; for example, if the operating system is `sunos4.1',
540 the base operating system is `unix/bsd'.  The algorithm used to pick
541 the list of directories is simple: `configure' makes a list of the base
542 operating system, manufacturer, CPU type, and operating system, in that
543 order.  It then concatenates all these together with slashes in
544 between, to produce a directory name; for example, the configuration
545 `sparc-sun-sunos4.1' results in `unix/bsd/sun/sparc/sunos4.1'.
546 `configure' then tries removing each element of the list in turn, so
547 `unix/bsd/sparc' and `sun/sparc' are also tried, among others.  Since
548 the precise version number of the operating system is often not
549 important, and it would be very inconvenient, for example, to have
550 identical `sunos4.1.1' and `sunos4.1.2' directories, `configure' tries
551 successively less specific operating system names by removing trailing
552 suffixes starting with a period.
553
554    As an example, here is the complete list of directories that would be
555 tried for the configuration `sparc-sun-sunos4.1' (without the `--nfp'
556 option):
557
558      sparc/fpu
559      unix/bsd/sun/sunos4.1/sparc
560      unix/bsd/sun/sunos4.1
561      unix/bsd/sun/sunos4/sparc
562      unix/bsd/sun/sunos4
563      unix/bsd/sun/sunos/sparc
564      unix/bsd/sun/sunos
565      unix/bsd/sun/sparc
566      unix/bsd/sun
567      unix/bsd/sunos4.1/sparc
568      unix/bsd/sunos4.1
569      unix/bsd/sunos4/sparc
570      unix/bsd/sunos4
571      unix/bsd/sunos/sparc
572      unix/bsd/sunos
573      unix/bsd/sparc
574      unix/bsd
575      unix/sun/sunos4.1/sparc
576      unix/sun/sunos4.1
577      unix/sun/sunos4/sparc
578      unix/sun/sunos4
579      unix/sun/sunos/sparc
580      unix/sun/sunos
581      unix/sun/sparc
582      unix/sun
583      unix/sunos4.1/sparc
584      unix/sunos4.1
585      unix/sunos4/sparc
586      unix/sunos4
587      unix/sunos/sparc
588      unix/sunos
589      unix/sparc
590      unix
591      sun/sunos4.1/sparc
592      sun/sunos4.1
593      sun/sunos4/sparc
594      sun/sunos4
595      sun/sunos/sparc
596      sun/sunos
597      sun/sparc
598      sun
599      sunos4.1/sparc
600      sunos4.1
601      sunos4/sparc
602      sunos4
603      sunos/sparc
604      sunos
605      sparc
606
607    Different machine architectures are conventionally subdirectories at
608 the top level of the `sysdeps' directory tree.  For example,
609 `sysdeps/sparc' and `sysdeps/m68k'.  These contain files specific to
610 those machine architectures, but not specific to any particular
611 operating system.  There might be subdirectories for specializations of
612 those architectures, such as `sysdeps/m68k/68020'. Code which is
613 specific to the floating-point coprocessor used with a particular
614 machine should go in `sysdeps/MACHINE/fpu'.
615
616    There are a few directories at the top level of the `sysdeps'
617 hierarchy that are not for particular machine architectures.
618
619 `generic'
620 `stub'
621      As described above (*note Porting::.), these are the two
622      subdirectories that every configuration implicitly uses after all
623      others.
624
625 `ieee754'
626      This directory is for code using the IEEE 754 floating-point
627      format, where the C type `float' is IEEE 754 single-precision
628      format, and `double' is IEEE 754 double-precision format.  Usually
629      this directory is referred to in the `Implies' file in a machine
630      architecture-specific directory, such as `m68k/Implies'.
631
632 `posix'
633      This directory contains implementations of things in the library in
634      terms of POSIX.1 functions.  This includes some of the POSIX.1
635      functions themselves.  Of course, POSIX.1 cannot be completely
636      implemented in terms of itself, so a configuration using just
637      `posix' cannot be complete.
638
639 `unix'
640      This is the directory for Unix-like things.  *Note Porting to
641      Unix::.  `unix' implies `posix'.  There are some special-purpose
642      subdirectories of `unix':
643
644     `unix/common'
645           This directory is for things common to both BSD and System V
646           release 4.  Both `unix/bsd' and `unix/sysv/sysv4' imply
647           `unix/common'.
648
649     `unix/inet'
650           This directory is for `socket' and related functions on Unix
651           systems.  The `inet' top-level subdirectory is enabled by
652           `unix/inet/Subdirs'.  `unix/common' implies `unix/inet'.
653
654 `mach'
655      This is the directory for things based on the Mach microkernel
656      from CMU (including the GNU operating system).  Other basic
657      operating systems (VMS, for example) would have their own
658      directories at the top level of the `sysdeps' hierarchy, parallel
659      to `unix' and `mach'.
660
661 Porting the GNU C Library to Unix Systems
662 -----------------------------------------
663
664    Most Unix systems are fundamentally very similar.  There are
665 variations between different machines, and variations in what
666 facilities are provided by the kernel.  But the interface to the
667 operating system facilities is, for the most part, pretty uniform and
668 simple.
669
670    The code for Unix systems is in the directory `unix', at the top
671 level of the `sysdeps' hierarchy.  This directory contains
672 subdirectories (and subdirectory trees) for various Unix variants.
673
674    The functions which are system calls in most Unix systems are
675 automatically generated from the `syscalls.list' files for the appropriate
676 archirecture.  The format of the syscalls.list files is quite easy: only
677 a few informations are necessary line the system call name, the number of
678 arguments and such.  The files are run through the C preprocessor.
679
680    These files all use a set of macros that should be defined in
681 `sysdep.h'.  The `sysdep.h' file in `sysdeps/unix' partially defines
682 them; a `sysdep.h' file in another directory must finish defining them
683 for the particular machine and operating system variant.  See
684 `sysdeps/unix/sysdep.h' and the machine-specific `sysdep.h'
685 implementations to see what these macros are and what they should do.
686
687    The system-specific makefile for the `unix' directory (that is, the
688 file `sysdeps/unix/Makefile') gives rules to generate several files
689 from the Unix system you are building the library on (which is assumed
690 to be the target system you are building the library *for*).  All the
691 generated files are put in the directory where the object files are
692 kept; they should not affect the source tree itself.  The files
693 generated are `ioctls.h', `errnos.h', `sys/param.h', and `errlist.c'
694 (for the `stdio' section of the library).
695
696 Contributors to the GNU C Library
697 =================================
698
699    The GNU C library was written originally by Roland McGrath.  Some
700 parts of the library were contributed or worked on by other people.
701
702    * The `getopt' function and related code were written by Richard
703      Stallman, David J. MacKenzie, and Roland McGrath.
704
705    * The merge sort function `qsort' was written by Michael J. Haertel.
706
707    * The quick sort function used as a fallback by `qsort' was written
708      by Douglas C. Schmidt.
709
710    * The memory allocation functions `malloc', `realloc' and `free' and
711      related code were written by Michael J. Haertel.
712
713    * Fast implementations of many of the string functions (`memcpy',
714      `strlen', etc.) were written by Torbjorn Granlund.
715
716    * The `tar.h' header file was written by David J. MacKenzie.
717
718    * The port to the MIPS DECStation running Ultrix 4
719      (`mips-dec-ultrix4') was contributed by Brendan Kehoe and Ian
720      Lance Taylor.
721
722    * The DES encryption function `crypt' and related functions were
723      contributed by Michael Glad.
724
725    * The `ftw' function was contributed by Ian Lance Taylor.
726
727    * The startup code to support SunOS shared libraries was contributed
728      by Tom Quinn.
729
730    * The `mktime' function was contributed by Paul Eggert.
731
732    * The port to the Sequent Symmetry running Dynix version 3
733      (`i386-sequent-bsd') was contributed by Jason Merrill.
734
735    * The timezone support code is derived from the public-domain
736      timezone package by Arthur David Olson and his many contributors.
737
738    * The port to the DEC Alpha running OSF/1 (`alpha-dec-osf1') was
739      contributed by Brendan Kehoe, using some code written by Roland
740      McGrath.
741
742    * The port to SGI machines running Irix 4 (`mips-sgi-irix4') was
743      contributed by Tom Quinn.
744
745    * The port of the Mach and Hurd code to the MIPS architecture
746      (`mips-ANYTHING-gnu') was contributed by Kazumoto Kojima.
747
748    * The floating-point printing function used by `printf' and friends
749      and the floating-point reading function used by `scanf', `strtod'
750      and friends were written by Ulrich Drepper.  The multi-precision
751      integer functions used in those functions are taken from GNU MP,
752      which was contributed by Torbjorn Granlund.
753
754    * The internationalization support in the library, and the support
755      programs `locale' and `localedef', were written by Ulrich Drepper.
756      Ulrich Drepper adapted the support code for message catalogs
757      (`libintl.h', etc.) from the GNU `gettext' package, which he also
758      wrote.  He also contributed the `catgets' support and the entire
759      suite of multi-byte and wide-character support functions
760      (`wctype.h', `wchar.h', etc.).
761
762    * The implementations of the `nsswitch.conf' mechanism and the files
763      and DNS backends for it were designed and written by Ulrich
764      Drepper and Roland McGrath, based on a backend interface defined
765      by Peter Eriksson.
766
767    * The port to Linux i386/ELF (`i386-ANYTHING-linux') was contributed
768      by Ulrich Drepper, based in large part on work done in Hongjiu
769      Lu's Linux version of the GNU C Library.
770
771    * The port to Linux/m68k (`m68k-ANYTHING-linux') was contributed by
772      Andreas Schwab.
773
774    * Richard Henderson contributed the ELF dynamic linking code and
775      other support for the Alpha processor.
776
777    * David Mosberger-Tang contributed the port to Linux/Alpha
778      (`alpha-ANYTHING-linux').
779
780    * Stephen R. van den Berg contributed a highly-optimized `strstr'
781      function.
782
783    * Ulrich Drepper contributed the `hsearch' and `drand48' families of
784      functions; reentrant `...`_r'' versions of the `random' family;
785      System V shared memory and IPC support code; and several
786      highly-optimized string functions for iX86 processors.
787
788    * The math functions are taken from `fdlibm-5.1' by Sun
789      Microsystems, as modified by J.T. Conklin, Ian Lance Taylor,
790      Ulrich Drepper, Andreas Schwab, and Roland McGrath.
791
792    * The `libio' library used to implement `stdio' functions on some
793      platforms was written by Per Bothner and modified by Ulrich
794      Drepper.
795
796    * Some of the Internet-related code (most of the `inet'
797      subdirectory) and several other miscellaneous functions and
798      header files have been included from 4.4 BSD with little or no
799      modification.
800
801      All code incorporated from 4.4 BSD is under the following
802      copyright:
803
804                Copyright (C) 1991 Regents of the University of California.
805                All rights reserved.
806
807           Redistribution and use in source and binary forms, with or
808           without modification, are permitted provided that the
809           following conditions are met:
810
811             1. Redistributions of source code must retain the above
812                copyright notice, this list of conditions and the
813                following disclaimer.
814
815             2. Redistributions in binary form must reproduce the above
816                copyright notice, this list of conditions and the
817                following disclaimer in the documentation and/or other
818                materials provided with the distribution.
819
820             3. All advertising materials mentioning features or use of
821                this software must display the following acknowledgement:
822                     This product includes software developed by the
823                     University of California, Berkeley and its
824                     contributors.
825
826             4. Neither the name of the University nor the names of its
827                contributors may be used to endorse or promote products
828                derived from this software without specific prior
829                written permission.
830
831           THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS
832           IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
833           LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
834           FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT
835           SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
836           INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
837           DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
838           SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
839           OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
840           LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
841           (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
842           THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
843           OF SUCH DAMAGE.
844
845    * The random number generation functions `random', `srandom',
846      `setstate' and `initstate', which are also the basis for the
847      `rand' and `srand' functions, were written by Earl T. Cohen for
848      the University of California at Berkeley and are copyrighted by the
849      Regents of the University of California.  They have undergone minor
850      changes to fit into the GNU C library and to fit the ANSI C
851      standard, but the functional code is Berkeley's.
852
853    * The Internet resolver code is taken directly from BIND 4.9.5,
854      which is under both the Berkeley copyright above and also:
855
856           Portions Copyright (C) 1993 by Digital Equipment Corporation.
857
858           Permission to use, copy, modify, and distribute this software
859           for any purpose with or without fee is hereby granted,
860           provided that the above copyright notice and this permission
861           notice appear in all copies, and that the name of Digital
862           Equipment Corporation not be used in advertising or publicity
863           pertaining to distribution of the document or software
864           without specific, written prior permission.
865
866           THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP.
867           DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
868           INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
869           FITNESS.  IN NO EVENT SHALL DIGITAL EQUIPMENT CORPORATION BE
870           LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
871           DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
872           DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
873           OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
874           WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
875
876    * The code to support Sun RPC is taken verbatim from Sun's
877      RPCSRC-4.0 distribution, and is covered by this copyright:
878
879                Copyright (C) 1984, Sun Microsystems, Inc.
880
881           Sun RPC is a product of Sun Microsystems, Inc. and is
882           provided for unrestricted use provided that this legend is
883           included on all tape media and as a part of the software
884           program in whole or part.  Users may copy or modify Sun RPC
885           without charge, but are not authorized to license or
886           distribute it to anyone else except as part of a product or
887           program developed by the user.
888
889           SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND
890           INCLUDING THE WARRANTIES OF DESIGN, MERCHANTIBILITY AND
891           FITNESS FOR A PARTICULAR PURPOSE, OR ARISING FROM A COURSE OF
892           DEALING, USAGE OR TRADE PRACTICE.
893
894           Sun RPC is provided with no support and without any
895           obligation on the part of Sun Microsystems, Inc. to assist in
896           its use, correction, modification or enhancement.
897
898           SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT
899           TO THE INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY
900           PATENTS BY SUN RPC OR ANY PART THEREOF.
901
902           In no event will Sun Microsystems, Inc. be liable for any
903           lost revenue or profits or other special, indirect and
904           consequential damages, even if Sun has been advised of the
905           possibility of such damages.
906
907                Sun Microsystems, Inc.
908                2550 Garcia Avenue
909                Mountain View, California  94043
910
911    * Some of the support code for Mach is taken from Mach 3.0 by CMU,
912      and is under the following copyright terms:
913
914                Mach Operating System
915                Copyright (C) 1991,1990,1989 Carnegie Mellon University
916                All Rights Reserved.
917
918           Permission to use, copy, modify and distribute this software
919           and its documentation is hereby granted, provided that both
920           the copyright notice and this permission notice appear in all
921           copies of the software, derivative works or modified
922           versions, and any portions thereof, and that both notices
923           appear in supporting documentation.
924
925           CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS
926           IS" CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF
927           ANY KIND FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF
928           THIS SOFTWARE.
929
930           Carnegie Mellon requests users of this software to return to
931
932                 Software Distribution Coordinator
933                 School of Computer Science
934                 Carnegie Mellon University
935                 Pittsburgh PA 15213-3890
936
937           or `Software.Distribution@CS.CMU.EDU' any improvements or
938           extensions that they make and grant Carnegie Mellon the
939           rights to redistribute these changes.
940
941    * The `getaddrinfo' function is written by Craig Metz and it has the
942      following copyright:
943
944         The Inner Net License, Version 2.00
945         ===================================
946
947         The author(s) grant permission for redistribution and use in source and
948         binary forms, with or without modification, of the software
949         and documentation provided that the following conditions are met:
950
951         0. If you receive a version of the software that is
952            specifically labelled as not being for redistribution
953            (check the version message and/or README), you are not
954            permitted to redistribute that version of the software in
955            any way or form.
956         1. All terms of the all other applicable copyrights and
957            licenses must be followed.
958         2. Redistributions of source code must retain the authors'
959            copyright notice(s), this list of conditions, and the
960            following disclaimer.
961         3. Redistributions in binary form must reproduce the authors'
962            copyright notice(s), this list of conditions, and the
963            following disclaimer in the documentation and/or other
964            materials provided with the distribution.
965         4. All advertising materials mentioning features or use of
966            this software must display the following acknowledgement
967            with the name(s) of the authors as specified in the
968            copyright notice(s) substituted where indicated:
969
970         This product includes software developed by <name(s)>, The Inner
971         Net, and other contributors.
972
973         5. Neither the name(s) of the author(s) nor the names of its
974            contributors may be used to endorse or promote products
975            derived from this software without specific prior written
976            permission.
977
978         THIS SOFTWARE IS PROVIDED BY ITS AUTHORS AND CONTRIBUTORS ``AS
979         IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
980         LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
981         FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
982         SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
983         INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
984         DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
985         SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
986         OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
987         LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
988         (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
989         THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
990         OF SUCH DAMAGE.
991
992         If these license terms cause you a real problem, contact the author.