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