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