Fix typos.
[kopensolaris-gnu/glibc.git] / manual / install.texi
1 @c This is for making the `INSTALL' file for the distribution.
2 @c Makeinfo ignores it when processing the file from the include.
3 @setfilename INSTALL
4
5 @node Installation, Maintenance, Library Summary, Top
6 @c %MENU% How to install the GNU C library
7 @appendix Installing the GNU C Library
8
9 Before you do anything else, you should read the file @file{FAQ} found
10 at the top level of the source tree.  This file answers common questions
11 and describes problems you may experience with compilation and
12 installation.  It is updated more frequently than this manual.
13
14 Features can be added to GNU Libc via @dfn{add-on} bundles.  These are
15 separate tarfiles which you unpack into the top level of the source
16 tree.  Then you give @code{configure} the @samp{--enable-add-ons} option
17 to activate them, and they will be compiled into the library.  As of the
18 2.2 release, one important component of glibc is distributed as
19 ``official'' add-ons: the linuxthreads add-on.  Unless you are doing an
20 unusual installation, you should get this.
21
22 Support for POSIX threads is maintained by someone else, so it's in a
23 separate package.  It is only available for Linux systems, but this will
24 change in the future.  Get it from the same place you got the main
25 bundle; the file is @file{glibc-linuxthreads-@var{VERSION}.tar.gz}.
26
27 You will need recent versions of several GNU tools: definitely GCC and
28 GNU Make, and possibly others.  @xref{Tools for Compilation}, below.
29
30 @menu
31 * Configuring and compiling::   How to compile and test GNU libc.
32 * Running make install::        How to install it once you've got it compiled.
33 * Tools for Compilation::       You'll need these first.
34 * Supported Configurations::    What it runs on, what it doesn't.
35 * Linux::                       Specific advice for Linux systems.
36 * Reporting Bugs::              So they'll get fixed.
37 @end menu
38
39 @node Configuring and compiling
40 @appendixsec Configuring and compiling GNU Libc
41 @cindex configuring
42 @cindex compiling
43
44 GNU libc can be compiled in the source directory, but we strongly advise to
45 build it in a separate build directory.  For example, if you have unpacked
46 the glibc sources in @file{/src/gnu/glibc-2.2.0}, create a directory
47 @file{/src/gnu/glibc-build} to put the object files in.  This allows
48 removing the whole build directory in case an error occurs, which is the
49 safest way to get a fresh start and should always be done.
50
51 From your object directory, run the shell script @file{configure} found
52 at the top level of the source tree.  In the scenario above, you'd type
53
54 @smallexample
55 $ ../glibc-2.2.0/configure @var{args...}
56 @end smallexample
57
58 Please note that even if you're building in a separate build directory,
59 the compilation needs to modify a few files in the source
60 directory, especially some files in the manual subdirectory.
61
62 @noindent
63 @code{configure} takes many options, but you can get away with knowing
64 only two: @samp{--prefix} and @samp{--enable-add-ons}.  The
65 @code{--prefix} option tells configure where you want glibc installed.
66 This defaults to @file{/usr/local}.  The @samp{--enable-add-ons} option
67 tells configure to use all the add-on bundles it finds in the source
68 directory.  Since important functionality is provided in add-ons, you
69 should always specify this option.
70
71 It may also be useful to set the @var{CC} and @var{CFLAGS} variables in
72 the environment when running @code{configure}.  @var{CC} selects the C
73 compiler that will be used, and @var{CFLAGS} sets optimization options
74 for the compiler.
75
76 The following list describes all of the available options for @code{configure}:
77
78 @table @samp
79 @item --prefix=@var{directory}
80 Install machine-independent data files in subdirectories of
81 @file{@var{directory}}.  The default is to install in @file{/usr/local}.
82
83 @item --exec-prefix=@var{directory}
84 Install the library and other machine-dependent files in subdirectories
85 of @file{@var{directory}}.  The default is to the @samp{--prefix}
86 directory if that option is specified, or @file{/usr/local} otherwise.
87
88 @item --with-headers=@var{directory}
89 Look for kernel header files in @var{directory}, not
90 @file{/usr/include}.  Glibc needs information from the kernel's private
91 header files.  It will normally look in @file{/usr/include} for them,
92 but if you specify this option, it will look in @var{DIRECTORY} instead.
93
94 This option is primarily of use on a system where the headers in
95 @file{/usr/include} come from an older version of glibc.  Conflicts can
96 occasionally happen in this case.  Note that Linux libc5 qualifies as an
97 older version of glibc.  You can also use this option if you want to
98 compile glibc with a newer set of kernel headers than the ones found in
99 @file{/usr/include}.
100
101 @item --enable-add-ons[=@var{list}]
102 Enable add-on packages in your source tree.  If this option is specified
103 with no list, it enables all the add-on packages it finds.  If you do
104 not wish to use some add-on package that you have present in your source
105 tree, give this option a list of the add-ons that you @emph{do} want
106 used, like this: @samp{--enable-add-ons=linuxthreads}
107
108 @item --enable-kernel=@var{version}
109 This option is currently only useful on Linux systems.  The
110 @var{version} parameter should have the form X.Y.Z and describes the
111 smallest version of the Linux kernel the generated library is expected
112 to support.  The higher the @var{version} number is, the less
113 compatibility code is added, and the faster the code gets.
114
115 @item --with-binutils=@var{directory}
116 Use the binutils (assembler and linker) in @file{@var{directory}}, not
117 the ones the C compiler would default to.  You could use this option if
118 the default binutils on your system cannot deal with all the constructs
119 in the GNU C library.  In that case, @code{configure} will detect the problem and
120 suppress these constructs, so that the library will still be usable, but
121 functionality may be lost---for example, you can't build a shared libc
122 with old binutils.
123
124 @item --without-fp
125 Use this option if your computer lacks hardware floating-point support
126 and your operating system does not emulate an FPU.
127
128 @c disable static doesn't work currently
129 @c @item --disable-static
130 @c Don't build static libraries.  Static libraries aren't that useful these
131 @c days, but we recommend you build them in case you need them.
132
133 @item --disable-shared
134 Don't build shared libraries even if it is possible.  Not all systems support
135 shared libraries; you need ELF support and (currently) the GNU linker.
136
137 @item --disable-profile
138 Don't build libraries with profiling information.  You may want to use
139 this option if you don't plan to do profiling.
140
141 @item --enable-omitfp
142 Use maximum optimization for the normal (static and shared)
143 libraries, and compile separate static libraries with debugging
144 information and no optimization.  We recommend against this.  The extra
145 optimization doesn't gain you much, it may provoke compiler bugs, and
146 you won't be able to trace bugs through the C library.
147
148 @item --disable-versioning
149 Don't compile the shared libraries with symbol version information.
150 Doing this will make the resulting library incompatible with old
151 binaries, so it's not recommended.
152
153 @item --enable-static-nss
154 Compile static versions of the NSS (Name Service Switch) libraries.
155 This is not recommended because it defeats the purpose of NSS; a program
156 linked statically with the NSS libraries cannot be dynamically
157 reconfigured to use a different name database.
158
159 @item --build=@var{build-system}
160 @itemx --host=@var{host-system}
161 These options are for cross-compiling.  If you specify both options and
162 @var{build-system} is different from @var{host-system}, @code{configure}
163 will prepare to cross-compile glibc from @var{build-system} to be used
164 on @var{host-system}.  You'll probably need the @samp{--with-headers}
165 option too, and you may have to override @var{configure}'s selection of
166 the compiler and/or binutils.
167
168 If you only specify @samp{--host}, configure will prepare for a native
169 compile but use what you specify instead of guessing what your system is.
170 This is most useful to change the CPU submodel.  For example, if
171 configure guesses your machine as @code{i586-pc-linux-gnu} but you want
172 to compile a library for 386es, give @samp{--host=i386-pc-linux-gnu} or
173 just @samp{--host=i386-linux} and add the appropriate compiler flags
174 (@samp{-mcpu=i386} will do the trick) to @var{CFLAGS}.
175
176 If you specify just @samp{--build}, configure will get confused.
177 @end table
178
179 To build the library and related programs, type @code{make}.  This will
180 produce a lot of output, some of which may look like errors from
181 @code{make} but isn't.  Look for error messages from @code{make}
182 containing @samp{***}.  Those indicate that something is really wrong.
183
184 The compilation process takes several hours even on fast hardware.
185 Expect at least two hours for the default configuration on i586 for
186 Linux.  For Hurd times are much longer.  Except for EGCS 1.1 and GCC
187 2.95 (and later versions of GCC), all supported versions of GCC have a
188 problem which causes them to take several minutes to compile certain
189 files in the iconvdata directory.  Do not panic if the compiler appears
190 to hang.
191
192 If you want to run a parallel make, you can't just give @code{make} the
193 @samp{-j} option, because it won't be passed down to the sub-makes.
194 Instead, edit the generated @file{Makefile} and uncomment the line
195
196 @smallexample
197 # PARALLELMFLAGS = -j 4
198 @end smallexample
199
200 @noindent
201 You can change the @samp{4} to some other number as appropriate for
202 your system.  Instead of changing the @file{Makefile}, you could give
203 this option directly to @code{make} and call it as, for example,
204 @code{make PARALLELMFLAGS=-j4}.  If you're building in the source
205 directory, you must use the latter approach since in this case no
206 new @file{Makefile} is generated for you to change.
207
208 To build and run test programs which exercise some of the library
209 facilities, type @code{make check}.  If it does not complete
210 successfully, do not use the built library, and report a bug after
211 verifying that the problem is not already known.  @xref{Reporting Bugs},
212 for instructions on reporting bugs.  Note that some of the tests assume
213 they are not being run by @code{root}.  We recommend you compile and
214 test glibc as an unprivileged user.
215
216 To format the @cite{GNU C Library Reference Manual} for printing, type
217 @w{@code{make dvi}}.  You need a working @TeX{} installation to do this.
218 The distribution already includes the on-line formatted version of the
219 manual, as Info files.  You can regenerate those with @w{@code{make
220 info}}, but it shouldn't be necessary.
221
222 The library has a number of special-purpose configuration parameters
223 which you can find in @file{Makeconfig}.  These can be overwritten with
224 the file @file{configparms}.  To change them, create a
225 @file{configparms} in your build directory and add values as appropriate
226 for your system.  The file is included and parsed by @code{make} and has
227 to follow the conventions for makefiles.
228
229 It is easy to configure the GNU C library for cross-compilation by
230 setting a few variables in @file{configparms}.  Set @code{CC} to the
231 cross-compiler for the target you configured the library for; it is
232 important to use this same @code{CC} value when running
233 @code{configure}, like this: @samp{CC=@var{target}-gcc configure
234 @var{target}}.  Set @code{BUILD_CC} to the compiler to use for for
235 programs run on the build system as part of compiling the library.  You
236 may need to set @code{AR} and @code{RANLIB} to cross-compiling versions
237 of @code{ar} and @code{ranlib} if the native tools are not configured to
238 work with object files for the target you configured for.
239
240
241 @node Running make install
242 @appendixsec Installing the C Library
243 @cindex installing
244
245 To install the library and its header files, and the Info files of the
246 manual, type @code{env LANGUAGE=C LC_ALL=C make install}.  This will
247 build things if necessary, before installing them.  However, you should
248 still compile everything first.  If you are installing glibc as your
249 primary C library, we recommend that you shut the system down to
250 single-user mode first, and reboot afterward.  This minimizes the risk
251 of breaking things when the library changes out from underneath.
252
253 If you're upgrading from Linux libc5 or some other C library, you need to
254 replace the @file{/usr/include} with a fresh directory before installing it.
255 The new @file{/usr/include} should contain the Linux headers, but nothing else.
256
257 You must first build the library (@samp{make}), optionally check it
258 (@samp{make check}), switch the include directories and then install
259 (@samp{make install}).  The steps must be done in this order.  Not moving
260 the directory before install will result in an unusable mixture of header
261 files from both libraries, but configuring, building, and checking the
262 library requires the ability to compile and run programs against the old
263 library.
264
265 If you are upgrading from a previous installation of glibc 2.0 or 2.1,
266 @samp{make install} will do the entire job.  You do not need to remove
267 the old includes -- if you want to do so anyway you must then follow the
268 order given above.
269
270 You may also need to reconfigure GCC to work with the new library.  The
271 easiest way to do that is to figure out the compiler switches to make it
272 work again (@samp{-Wl,--dynamic-linker=/lib/ld-linux.so.2} should work on
273 Linux systems) and use them to recompile gcc.  You can also edit the specs
274 file (@file{/usr/lib/gcc-lib/@var{TARGET}/@var{VERSION}/specs}), but that
275 is a bit of a black art.
276
277 You can install glibc somewhere other than where you configured it to go
278 by setting the @code{install_root} variable on the command line for
279 @samp{make install}.  The value of this variable is prepended to all the
280 paths for installation.  This is useful when setting up a chroot
281 environment or preparing a binary distribution.  The directory should be
282 specified with an absolute file name.
283
284 Glibc 2.2 includes a daemon called @code{nscd}, which you
285 may or may not want to run.  @code{nscd} caches name service lookups; it
286 can dramatically improve performance with NIS+, and may help with DNS as
287 well.
288
289 One auxiliary program, @file{/usr/libexec/pt_chown}, is installed setuid
290 @code{root}.  This program is invoked by the @code{grantpt} function; it
291 sets the permissions on a pseudoterminal so it can be used by the
292 calling process.  This means programs like @code{xterm} and
293 @code{screen} do not have to be setuid to get a pty.  (There may be
294 other reasons why they need privileges.)  If you are using a 2.1 or
295 newer Linux kernel with the @code{devptsfs} or @code{devfs} filesystems
296 providing pty slaves, you don't need this program; otherwise you do.
297 The source for @file{pt_chown} is in @file{login/programs/pt_chown.c}.
298
299 After installation you might want to configure the timezone and locale
300 installation of your system.  The GNU C library comes with a locale
301 database which gets configured with @code{localedef}.  For example, to
302 set up a German locale with name @code{de_DE}, simply issue the command
303 @samp{localedef -i de_DE -f ISO-8859-1 de_DE}.  To configure all locales
304 that are supported by glibc, you can issue from your build directory the
305 command @samp{make localedata/install-locales}.
306
307 To configure the locally used timezone, you can either set the @code{TZ}
308 environment variable.  The script @code{tzselect} helps you to select
309 the right value.  As an example for Germany, tzselect would tell you to
310 use @samp{TZ='Europe/Berlin'}.  For a system wide installation (the
311 given paths are for an installation with @samp{--prefix=/usr}), link the
312 timezone file which is in @file{/usr/share/zoneinfo} to the file
313 @file{/etc/localtime}.  For Germany, you might execute @samp{ln -s
314 /usr/share/zoneinfo/Europe/Berlin /etc/localtime}.
315
316 @node Tools for Compilation
317 @appendixsec Recommended Tools for Compilation
318 @cindex installation tools
319 @cindex tools, for installing library
320
321 We recommend installing the following GNU tools before attempting to
322 build the GNU C library:
323
324 @itemize @bullet
325 @item
326 GNU @code{make} 3.79 or newer
327
328 You need the latest version of GNU @code{make}.  Modifying the GNU C
329 Library to work with other @code{make} programs would be so difficult that we
330 recommend you port GNU @code{make} instead.  @strong{Really.}  We
331 recommend version GNU @code{make} version 3.79.  All earlier
332 versions have severe bugs or lack features.
333
334 @item
335 GCC 2.95 or newer
336
337 The GNU C library can only be compiled with the GNU C compiler family.
338 As of the 2.2 release, GCC 2.95.2 or higher is required.  As of this
339 writing, GCC 2.95.3 is the compiler we advise to use.
340
341 You can use whatever compiler you like to compile programs that use GNU
342 libc, but be aware that both GCC 2.7 and 2.8 have bugs in their
343 floating-point support that may be triggered by the math library.
344
345 For PPC you might need some patches even on top of the last GCC version.
346 See the FAQ.
347
348 @item
349 GNU @code{binutils} 2.10.1 or later
350
351 You must use GNU binutils (as and ld) if you want to build a shared
352 library.  Even if you don't, we recommend you use them anyway.  No one
353 has tested compilation with non-GNU binutils in a long time.
354
355 The quality of binutils releases has varied a bit recently.  The bugs
356 are in obscure features, but glibc uses quite a few of those.  2.10.1
357 and later releases are known to work.  Versions after 2.8.1.0.23 may or
358 may not work.  Older versions definitely don't.
359
360 For PPC you might need some patches even on top of the last binutils
361 version.  See the FAQ.
362
363 @item
364 GNU @code{texinfo} 3.12f
365
366 To correctly translate and install the Texinfo documentation you need
367 this version of the @code{texinfo} package.  Earlier versions do not
368 understand all the tags used in the document, and the installation
369 mechanism for the info files is not present or works differently.
370
371 @item
372 GNU @code{awk} 3.0, or some other POSIX awk
373
374 Awk is used in several places to generate files.  The scripts should
375 work with any POSIX-compliant awk implementation; @code{gawk} 3.0 and
376 @code{mawk} 1.3 are known to work.
377
378 @item
379 Perl 5
380
381 Perl is not required, but it is used if present to test the
382 installation.  We may decide to use it elsewhere in the future.
383
384 @item
385 GNU @code{sed} 3.02 or newer
386
387 Sed is used in several places to generate files.  Most scripts work with
388 any version of @code{sed}.  The known exception is the script
389 @code{po2test.sed} in the @code{intl} subdirectory which is used to
390 generate @code{msgs.h} for the testsuite.  This script works correctly
391 only with GNU @code{sed} 3.02.  If you like to run the testsuite, you
392 should definitely upgrade @code{sed}.
393
394 @end itemize
395
396 @noindent
397 If you change any of the @file{configure.in} files you will also need
398
399 @itemize @bullet
400 @item
401 GNU @code{autoconf} 2.12 or higher
402 @end itemize
403
404 @noindent
405 and if you change any of the message translation files you will need
406
407 @itemize @bullet
408 @item
409 GNU @code{gettext} 0.10.36 or later
410 @end itemize
411
412 @noindent
413 You may also need these packages if you upgrade your source tree using
414 patches, although we try to avoid this.
415
416 @node Supported Configurations
417 @appendixsec Supported Configurations
418 @cindex configurations, all supported
419
420 The GNU C Library currently supports configurations that match the
421 following patterns:
422
423 @smallexample
424 alpha@var{*}-@var{*}-linux
425 arm-@var{*}-linux
426 cris-@var{*}-linux
427 hppa-@var{*}-linux
428 i@var{x}86-@var{*}-gnu
429 i@var{x}86-@var{*}-linux
430 ia64-@var{*}-linux
431 m68k-@var{*}-linux
432 mips@var{*}-@var{*}-linux
433 powerpc-@var{*}-linux
434 s390-@var{*}-linux
435 s390x-@var{*}-linux
436 sparc-@var{*}-linux
437 sparc64-@var{*}-linux
438 @end smallexample
439
440 Former releases of this library (version 2.1 and/or 2.0) used to run on
441 the following configurations:
442
443 @smallexample
444 arm-@var{*}-linuxaout
445 arm-@var{*}-none
446 @end smallexample
447
448 Very early releases (version 1.09.1 and perhaps earlier versions) used
449 to run on the following configurations:
450
451 @smallexample
452 alpha-dec-osf1
453 alpha-@var{*}-linuxecoff
454 i@var{x}86-@var{*}-bsd4.3
455 i@var{x}86-@var{*}-isc2.2
456 i@var{x}86-@var{*}-isc3.@var{n}
457 i@var{x}86-@var{*}-sco3.2
458 i@var{x}86-@var{*}-sco3.2v4
459 i@var{x}86-@var{*}-sysv
460 i@var{x}86-@var{*}-sysv4
461 i@var{x}86-force_cpu386-none
462 i@var{x}86-sequent-bsd
463 i960-nindy960-none
464 m68k-hp-bsd4.3
465 m68k-mvme135-none
466 m68k-mvme136-none
467 m68k-sony-newsos3
468 m68k-sony-newsos4
469 m68k-sun-sunos4.@var{n}
470 mips-dec-ultrix4.@var{n}
471 mips-sgi-irix4.@var{n}
472 sparc-sun-solaris2.@var{n}
473 sparc-sun-sunos4.@var{n}
474 @end smallexample
475
476 Since no one has volunteered to test and fix these configurations,
477 they are not supported at the moment.  They probably don't compile;
478 they definitely don't work anymore.  Porting the library is not hard.
479 If you are interested in doing a port, please contact the glibc
480 maintainers by sending electronic mail to @email{bug-glibc@@gnu.org}.
481
482 Valid cases of @samp{i@var{x}86} include @samp{i386}, @samp{i486},
483 @samp{i586}, and @samp{i686}.  All of those configurations produce a
484 library that can run on this processor and newer processors.  The GCC
485 compiler by default generates code that's optimized for the machine it's
486 configured for and will use the instructions available on that machine.
487 For example if your GCC is configured for @samp{i686}, gcc will optimize
488 for @samp{i686} and might issue some @samp{i686} specific instructions.
489 To generate code for other models, you have to configure for that model
490 and give GCC the appropriate @samp{-march=} and @samp{-mcpu=} compiler
491 switches via @var{CFLAGS}.
492
493 @node Linux
494 @appendixsec Specific advice for Linux systems
495 @cindex upgrading from libc5
496 @cindex kernel header files
497
498 If you are installing GNU libc on a Linux system, you need to have the
499 header files from a 2.2 or newer kernel around for reference.  For some
500 architectures, like ia64, sh and hppa, you need at least headers from
501 kernel 2.3.99 (sh and hppa) or 2.4.0 (ia64).  You do not need to use
502 that kernel, just have its headers where glibc can access at them.  The
503 easiest way to do this is to unpack it in a directory such as
504 @file{/usr/src/linux-2.2.1}.  In that directory, run @samp{make config}
505 and accept all the defaults.  Then run @samp{make
506 include/linux/version.h}.  Finally, configure glibc with the option
507 @samp{--with-headers=/usr/src/linux-2.2.1/include}.  Use the most recent
508 kernel you can get your hands on.
509
510 An alternate tactic is to unpack the 2.2 kernel and run @samp{make
511 config} as above.  Then rename or delete @file{/usr/include}, create
512 a new @file{/usr/include}, and make the usual symbolic links of
513 @file{/usr/include/linux} and @file{/usr/include/asm} into the 2.2
514 kernel sources.  You can then configure glibc with no special options.
515 This tactic is recommended if you are upgrading from libc5, since you
516 need to get rid of the old header files anyway.
517
518 Note that @file{/usr/include/net} and @file{/usr/include/scsi} should
519 @strong{not} be symlinks into the kernel sources.  GNU libc provides its
520 own versions of these files.
521
522 Linux expects some components of the libc installation to be in
523 @file{/lib} and some in @file{/usr/lib}.  This is handled automatically
524 if you configure glibc with @samp{--prefix=/usr}.  If you set some other
525 prefix or allow it to default to @file{/usr/local}, then all the
526 components are installed there.
527
528 If you are upgrading from libc5, you need to recompile every shared
529 library on your system against the new library for the sake of new code,
530 but keep the old libraries around for old binaries to use.  This is
531 complicated and difficult.  Consult the Glibc2 HOWTO at
532 @url{http://www.imaxx.net/~thrytis/glibc} for details.
533
534 You cannot use @code{nscd} with 2.0 kernels, due to bugs in the
535 kernel-side thread support.  @code{nscd} happens to hit these bugs
536 particularly hard, but you might have problems with any threaded
537 program.
538
539 @node Reporting Bugs
540 @appendixsec Reporting Bugs
541 @cindex reporting bugs
542 @cindex bugs, reporting
543
544 There are probably bugs in the GNU C library.  There are certainly
545 errors and omissions in this manual.  If you report them, they will get
546 fixed.  If you don't, no one will ever know about them and they will
547 remain unfixed for all eternity, if not longer.
548
549 It is a good idea to verify that the problem has not already been
550 reported.  Bugs are documented in two places: The file @file{BUGS}
551 describes a number of well known bugs and the bug tracking system has a
552 WWW interface at
553 @url{http://www-gnats.gnu.org:8080/cgi-bin/wwwgnats.pl}.  The WWW
554 interface gives you access to open and closed reports.  The closed
555 reports normally include a patch or a hint on solving the problem.
556
557 To report a bug, first you must find it.  Hopefully, this will be the
558 hard part.  Once you've found a bug, make sure it's really a bug.  A
559 good way to do this is to see if the GNU C library behaves the same way
560 some other C library does.  If so, probably you are wrong and the
561 libraries are right (but not necessarily).  If not, one of the libraries
562 is probably wrong.  It might not be the GNU library.  Many historical
563 Unix C libraries permit things that we don't, such as closing a file
564 twice.
565
566 If you think you have found some way in which the GNU C library does not
567 conform to the ISO and POSIX standards (@pxref{Standards and
568 Portability}), that is definitely a bug.  Report it!
569
570 Once you're sure you've found a bug, try to narrow it down to the
571 smallest test case that reproduces the problem.  In the case of a C
572 library, you really only need to narrow it down to one library
573 function call, if possible.  This should not be too difficult.
574
575 The final step when you have a simple test case is to report the bug.
576 Do this using the @code{glibcbug} script.  It is installed with libc, or
577 if you haven't installed it, will be in your build directory.  Send your
578 test case, the results you got, the results you expected, and what you
579 think the problem might be (if you've thought of anything).
580 @code{glibcbug} will insert the configuration information we need to
581 see, and ship the report off to @email{bugs@@gnu.org}.  Don't send
582 a message there directly; it is fed to a program that expects mail to be
583 formatted in a particular way.  Use the script.
584
585 If you are not sure how a function should behave, and this manual
586 doesn't tell you, that's a bug in the manual.  Report that too!  If the
587 function's behavior disagrees with the manual, then either the library
588 or the manual has a bug, so report the disagreement.  If you find any
589 errors or omissions in this manual, please report them to the Internet
590 address @email{bug-glibc-manual@@gnu.org}.  If you refer to specific
591 sections of the manual, please include the section names for easier
592 identification.