86c066ed6e161841e7a82031dad2b16ebc54e28b
[kopensolaris-gnu/glibc.git] / manual / libc.texinfo
1 \input texinfo                  @c -*- Texinfo -*-
2 @comment %**start of header (This is for running Texinfo on a region.)
3 @setfilename libc.info
4 @settitle The GNU C Library
5 @setchapternewpage odd
6 @comment %**end of header (This is for running Texinfo on a region.)
7
8 @c This tells texinfo.tex to use the real section titles in xrefs in
9 @c place of the node name, when no section title is explicitly given.
10 @set xref-automatic-section-title
11 @smallbook
12
13 @c  I've already told people the printed edition will be 0.06
14 @set EDITION 0.06 DRAFT
15 @set VERSION 1.09 Beta
16 @set UPDATED 18 October 1994
17 @set ISBN 1-882114-53-1
18
19 @ifinfo
20 This file documents the GNU C library.
21
22 This is Edition @value{EDITION}, last updated @value{UPDATED},
23 of @cite{The GNU C Library Reference Manual}, for Version @value{VERSION}.
24
25 Copyright (C) 1993, 1994 Free Software Foundation, Inc.
26
27 Permission is granted to make and distribute verbatim copies of
28 this manual provided the copyright notice and this permission notice
29 are preserved on all copies.
30
31 @ignore
32 Permission is granted to process this file through TeX and print the
33 results, provided the printed document carries copying permission
34 notice identical to this one except for the removal of this paragraph
35 (this paragraph not being relevant to the printed manual).
36
37 @end ignore
38 Permission is granted to copy and distribute modified versions of this
39 manual under the conditions for verbatim copying, provided also that the
40 section entitled ``GNU Library General Public License'' is included
41 exactly as in the original, and provided that the entire resulting
42 derived work is distributed under the terms of a permission notice
43 identical to this one.
44
45 Permission is granted to copy and distribute translations of this manual
46 into another language, under the above conditions for modified versions,
47 except that the text of the translations of the section entitled ``GNU
48 Library General Public License'' must be approved for accuracy by the
49 Foundation.
50 @end ifinfo
51
52 @iftex
53 @shorttitlepage The GNU C Library Reference Manual
54 @end iftex
55 @titlepage
56 @center @titlefont{The GNU C Library}
57 @sp 1
58 @center @titlefont{Reference Manual}
59 @sp 2
60 @center Sandra Loosemore
61 @center with
62 @center Richard M. Stallman, Roland McGrath, and Andrew Oram
63 @sp 3
64 @center Edition @value{EDITION}
65 @sp 1
66 @center last updated @value{UPDATED}
67 @sp 1
68 @center for version @value{VERSION}
69 @page
70 @vskip 0pt plus 1filll
71 Copyright @copyright{} 1993, 1994 Free Software Foundation, Inc.
72 @sp 2
73 Published by the Free Software Foundation @*
74 675 Massachusetts Avenue, @*
75 Cambridge, MA 02139 USA @*
76 Printed copies are available for $50 each. @*
77 ISBN @value{ISBN} @*
78
79 Permission is granted to make and distribute verbatim copies of
80 this manual provided the copyright notice and this permission notice
81 are preserved on all copies.
82
83 Permission is granted to copy and distribute modified versions of this
84 manual under the conditions for verbatim copying, provided also that the
85 section entitled ``GNU Library General Public License'' is included
86 exactly as in the original, and provided that the entire resulting
87 derived work is distributed under the terms of a permission notice
88 identical to this one.
89
90 Permission is granted to copy and distribute translations of this manual
91 into another language, under the above conditions for modified versions,
92 except that the text of the translation of the section entitled ``GNU
93 Library General Public License'' must be approved for accuracy by the
94 Foundation.
95 @end titlepage
96 @page
97
98 @ifinfo
99 @node Top, Introduction, (dir), (dir)
100 @top Main Menu
101 This is Edition @value{EDITION}, last updated @value{UPDATED}, of
102 @cite{The GNU C Library Reference Manual}, for Version @value{VERSION}
103 of the GNU C Library.
104 @end ifinfo
105
106
107 @menu
108 * Introduction::                Purpose of the GNU C Library.
109 * Error Reporting::             How the GNU Library functions report
110                                  error conditions.
111 * Memory Allocation::           Your program can allocate memory dynamically
112                                  and manipulate it via pointers.
113 * Character Handling::          Character testing and conversion functions.
114 * String and Array Utilities::  Utilities for copying and comparing
115                                  strings and arrays.
116 * Extended Characters::         Support for extended character sets.
117 * Locales::                     The country and language can affect
118                                  the behavior of library functions.
119 * Searching and Sorting::       General searching and sorting functions.
120 * Pattern Matching::            Matching wildcards and regular expressions,
121                                  and shell-style ``word expansion''.
122 * I/O Overview::                Introduction to the I/O facilities.
123 * Streams: I/O on Streams.      High-level, portable I/O facilities.
124 * Low-Level I/O::               Low-level, less portable I/O.
125 * File System Interface::       Functions for manipulating files.
126 * Pipes and FIFOs::             A simple interprocess communication mechanism.
127 * Sockets::                     A more complicated interprocess communication
128                                  mechanism, with support for networking.
129 * Low-Level Terminal Interface::How to change the characteristics
130                                  of a terminal device.
131 * Mathematics::                 Math functions (transcendental functions,
132                                  random numbers, absolute value, etc.).
133 * Arithmetic::                  Low-level arithmetic functions.
134 * Date and Time::               Functions for getting the date and time,
135                                  and for conversion between formats.
136 * Non-Local Exits::             The @code{setjmp} and @code{longjmp} facilities.
137 * Signal Handling::             All about signals; how to send them,
138                                  block them, and handle them.
139 * Process Startup::             Writing the beginning and end of your program.
140 * Processes::                   How to create processes and run other programs.
141 * Job Control::                 All about process groups and sessions.
142 * Users and Groups::            How users are identified and classified.
143 * System Information::          Getting information about the
144                                  hardware and software configuration
145                                  of the machine a program runs on.
146 * System Configuration::        Parameters describing operating system limits.
147
148 Appendices
149
150 * Language Features::           C language features provided by the library. 
151
152 * Library Summary::             A summary showing the syntax, header file,
153                                  and derivation of each library feature.
154 * Maintenance::                 How to install and maintain the GNU C Library.
155 * Copying::                     The GNU Library General Public License says
156                                  how you can copy and share the GNU C Library.
157
158 Indices
159
160 * Concept Index::               Index of concepts and names.
161 * Type Index::                  Index of types and type qualifiers.
162 * Function Index::              Index of functions and function-like macros.
163 * Variable Index::              Index of variables and variable-like macros.
164 * File Index::                  Index of programs and files.
165
166  --- The Detailed Node Listing ---
167
168 Introduction
169
170 * Getting Started::             Getting Started
171 * Standards and Portability::   Standards and Portability
172 * Using the Library::           Using the Library
173 * Roadmap to the Manual::       Roadmap to the Manual
174
175 Standards and Portability
176
177 * ANSI C::                      The American National Standard for the
178                                  C programming language.  
179 * POSIX::                       The IEEE 1003 standards for operating systems.
180 * Berkeley Unix::               BSD and SunOS.
181 * SVID::                        The System V Interface Description.  
182
183 Using the Library
184
185 * Header Files::                How to use the header files in your programs.
186 * Macro Definitions::           Some functions in the library may really
187                                  be implemented as macros.
188 * Reserved Names::              The C standard reserves some names for
189                                  the library, and some for users.
190 * Feature Test Macros::         How to control what names are defined.
191
192 Error Reporting
193
194 * Checking for Errors::         How errors are reported by library functions.
195 * Error Codes::                 What all the error codes are.
196 * Error Messages::              Mapping error codes onto error messages.
197
198 Memory Allocation
199
200 * Memory Concepts::             An introduction to concepts and terminology.
201 * Dynamic Allocation and C::    How to get different kinds of allocation in C.
202 * Unconstrained Allocation::    The @code{malloc} facility allows fully general
203                                  dynamic allocation.
204 * Obstacks::                    Obstacks are less general than malloc
205                                  but more efficient and convenient.
206 * Variable Size Automatic::     Allocation of variable-sized blocks
207                                  of automatic storage that are freed when the
208                                  calling function returns.
209 * Relocating Allocator::        Waste less memory, if you can tolerate
210                                  automatic relocation of the blocks you get.
211 * Memory Warnings::             Getting warnings when memory is nearly full.
212
213 Unconstrained Allocation
214
215 * Basic Allocation::            Simple use of @code{malloc}.
216 * Malloc Examples::             Examples of @code{malloc}.  @code{xmalloc}.
217 * Freeing after Malloc::        Use @code{free} to free a block you
218                                  got with @code{malloc}.
219 * Changing Block Size::         Use @code{realloc} to make a block
220                                  bigger or smaller.
221 * Allocating Cleared Space::    Use @code{calloc} to allocate a
222                                  block and clear it.
223 * Efficiency and Malloc::       Efficiency considerations in use of
224                                  these functions.
225 * Aligned Memory Blocks::       Allocating specially aligned memory:
226                                  @code{memalign} and @code{valloc}.
227 * Heap Consistency Checking::   Automatic checking for errors.
228 * Hooks for Malloc::            You can use these hooks for debugging
229                                  programs that use @code{malloc}.
230 * Statistics of Malloc::        Getting information about how much
231                                  memory your program is using.
232 * Summary of Malloc::           Summary of @code{malloc} and related functions.
233
234 Obstacks
235
236 * Creating Obstacks::           How to declare an obstack in your program.
237 * Preparing for Obstacks::      Preparations needed before you can
238                                  use obstacks.
239 * Allocation in an Obstack::    Allocating objects in an obstack.
240 * Freeing Obstack Objects::     Freeing objects in an obstack.
241 * Obstack Functions::           The obstack functions are both
242                                  functions and macros.
243 * Growing Objects::             Making an object bigger by stages.
244 * Extra Fast Growing::          Extra-high-efficiency (though more
245                                  complicated) growing objects.
246 * Status of an Obstack::        Inquiries about the status of an obstack.
247 * Obstacks Data Alignment::     Controlling alignment of objects in obstacks.
248 * Obstack Chunks::              How obstacks obtain and release chunks. 
249                                 Efficiency considerations.
250 * Summary of Obstacks::         
251
252 Automatic Storage with Variable Size
253
254 * Alloca Example::              Example of using @code{alloca}.
255 * Advantages of Alloca::        Reasons to use @code{alloca}.
256 * Disadvantages of Alloca::     Reasons to avoid @code{alloca}.
257 * GNU C Variable-Size Arrays::  Only in GNU C, here is an alternative
258                                  method of allocating dynamically and
259                                  freeing automatically.
260 Relocating Allocator
261
262 * Relocator Concepts::          How to understand relocating allocation.
263 * Using Relocator::             Functions for relocating allocation.
264
265 Character Handling
266
267 * Classification of Characters::Testing whether characters are
268                                  letters, digits, punctuation, etc.
269 * Case Conversion::             Case mapping, and the like.
270
271 String and Array Utilities
272
273 * Representation of Strings::   Introduction to basic concepts.
274 * String/Array Conventions::    Whether to use a string function or an
275                                  arbitrary array function.
276 * String Length::               Determining the length of a string.
277 * Copying and Concatenation::   Functions to copy the contents of strings
278                                  and arrays.
279 * String/Array Comparison::     Functions for byte-wise and character-wise
280                                  comparison.
281 * Collation Functions::         Functions for collating strings.
282 * Search Functions::            Searching for a specific element or substring.
283 * Finding Tokens in a String::  Splitting a string into tokens by looking
284                                  for delimiters.
285
286 Extended Characters
287
288 * Extended Char Intro::         Multibyte codes versus wide characters.
289 * Locales and Extended Chars::  The locale selects the character codes.
290 * Multibyte Char Intro::        How multibyte codes are represented.
291 * Wide Char Intro::             How wide characters are represented.
292 * Wide String Conversion::      Converting wide strings to multibyte code
293                                    and vice versa.
294 * Length of Char::              how many bytes make up one multibyte char.
295 * Converting One Char::         Converting a string character by character.
296 * Example of Conversion::       Example showing why converting 
297                                    one character at a time may be useful.
298 * Shift State::                 Multibyte codes with "shift characters".
299
300 Locales and Internationalization
301
302 * Effects of Locale::           Actions affected by the choice of locale.
303 * Choosing Locale::             How the user specifies a locale.
304 * Locale Categories::           Different purposes for which
305                                  you can select a locale.
306 * Setting the Locale::          How a program specifies the locale.
307 * Standard Locales::            Locale names available on all systems.
308 * Numeric Formatting::          How to format numbers for the chosen locale.
309
310 Searching and Sorting 
311
312 * Comparison Functions::        Defining how to compare two objects.
313                                 Since the sort and search facilities are
314                                 general, you have to specify the ordering.
315 * Array Search Function::       The @code{bsearch} function.
316 * Array Sort Function::         The @code{qsort} function.
317 * Search/Sort Example::         An example program.
318
319 Pattern Matching
320
321 * Wildcard Matching::    Matching a wildcard pattern against a single string.
322 * Globbing::             Finding the files that match a wildcard pattern.
323 * Regular Expressions::  Matching regular expressions against strings.
324 * Word Expansion::       Expanding shell variables, nested commands,
325                           arithmetic, and wildcards.
326                           This is what the shell does with shell commands.
327
328 I/O Overview
329
330 * I/O Concepts::                Some basic information and terminology.
331 * File Names::                  How to refer to a file.
332
333 I/O Concepts
334
335 * Streams and File Descriptors:: The GNU Library provides two ways
336                                   to access the contents of files.
337 * File Position::               The number of bytes from the
338                                  beginning of the file.
339
340 File Names
341
342 * Directories::                 Directories contain entries for files.
343 * File Name Resolution::        A file name specifies how to look up a file.
344 * File Name Errors::            Error conditions relating to file names.
345 * File Name Portability::       File name portability and syntax issues.
346
347 I/O on Streams
348
349 * Streams::                     About the data type representing a stream.
350 * Standard Streams::            Streams to the standard input and output 
351                                  devices are created for you.
352 * Opening Streams::             How to create a stream to talk to a file.
353 * Closing Streams::             Close a stream when you are finished with it.
354 * Simple Output::               Unformatted output by characters and lines.
355 * Character Input::             Unformatted input by characters and words.
356 * Line Input::                  Reading a line or a record from a stream.
357 * Unreading::                   Peeking ahead/pushing back input just read.
358 * Formatted Output::            @code{printf} and related functions.
359 * Customizing Printf::          You can define new conversion specifiers for
360                                  @code{printf} and friends.
361 * Formatted Input::             @code{scanf} and related functions.
362 * Block Input/Output::          Input and output operations on blocks of data.
363 * EOF and Errors::              How you can tell if an I/O error happens.
364 * Binary Streams::              Some systems distinguish between text files
365                                  and binary files.
366 * File Positioning::            About random-access streams.
367 * Portable Positioning::        Random access on peculiar ANSI C systems.
368 * Stream Buffering::            How to control buffering of streams.
369 * Temporary Files::             How to open a temporary file.
370 * Other Kinds of Streams::      Other Kinds of Streams
371
372 Unreading
373
374 * Unreading Idea::              An explanation of unreading with pictures.
375 * How Unread::                  How to call @code{ungetc} to do unreading.
376
377 Formatted Output
378
379 * Formatted Output Basics::     Some examples to get you started.
380 * Output Conversion Syntax::    General syntax of conversion specifications.
381 * Table of Output Conversions:: Summary of output conversions, what they do.
382 * Integer Conversions::         Details of formatting integers.
383 * Floating-Point Conversions::  Details of formatting floating-point numbers.
384 * Other Output Conversions::    Details about formatting of strings,
385                                  characters, pointers, and the like.
386 * Formatted Output Functions::  Descriptions of the actual functions.
387 * Variable Arguments Output::   @code{vprintf} and friends.
388 * Parsing a Template String::   What kinds of arguments does
389                                  a given template call for?
390
391 Customizing Printf
392
393 * Registering New Conversions::  
394 * Conversion Specifier Options::  
395 * Defining the Output Handler::  
396 * Printf Extension Example::    
397
398 Formatted Input
399
400 * Formatted Input Basics::      Some basics to get you started.
401 * Input Conversion Syntax::     Syntax of conversion specifications.
402 * Table of Input Conversions::  Summary of input conversions and what they do.
403 * Numeric Input Conversions::   Details of conversions for reading numbers.
404 * String Input Conversions::    Details of conversions for reading strings.
405 * Other Input Conversions::     Details of miscellaneous other conversions.
406 * Formatted Input Functions::   Descriptions of the actual functions.
407 * Variable Arguments Input::    @code{vscanf} and friends.
408
409 Stream Buffering
410
411 * Buffering Concepts::          Terminology is defined here.
412 * Flushing Buffers::            How to ensure that output buffers are flushed.
413 * Controlling Buffering::       How to specify what kind of buffering to use.
414
415 Other Kinds of Streams
416
417 * String Streams::              
418 * Custom Streams::              
419
420 Programming Your Own Custom Streams
421
422 * Streams and Cookies::         
423 * Hook Functions::              
424
425 Low-Level I/O
426
427 * Opening and Closing Files::   How to open and close file descriptors.
428 * I/O Primitives::              Reading and writing data.
429 * File Position Primitive::     Setting a descriptor's file position.
430 * Descriptors and Streams::     Converting descriptor to stream or vice-versa.
431 * Stream/Descriptor Precautions::  Precautions needed if you use both
432                                     descriptors and streams.
433 * Waiting for I/O::             How to check for input or output
434                                  on multiple file descriptors.
435 * Control Operations::          Various other operations on file descriptors.
436 * Duplicating Descriptors::     Fcntl commands for duplicating descriptors.
437 * Descriptor Flags::            Fcntl commands for manipulating flags
438                                  associated with file descriptors.
439 * File Status Flags::           Fcntl commands for manipulating flags
440                                  associated with open files.
441 * File Locks::                  Fcntl commands for implementing file locking.
442 * Interrupt Input::             Getting a signal when input arrives.
443
444 File System Interface
445
446 * Working Directory::           This is used to resolve relative file names.
447 * Accessing Directories::       Finding out what files a directory contains.
448 * Hard Links::                  Adding alternate names to a file.
449 * Symbolic Links::              A file that ``points to'' a file name.
450 * Deleting Files::              How to delete a file, and what that means.
451 * Renaming Files::              Changing a file's name.
452 * Creating Directories::        A system call just for creating a directory.
453 * File Attributes::             Attributes of individual files.
454 * Making Special Files::        How to create special files.
455
456 Accessing Directories
457
458 * Directory Entries::           Format of one directory entry.
459 * Opening a Directory::         How to open a directory stream.
460 * Reading/Closing Directory::   How to read directory entries from the stream.
461 * Simple Directory Lister::     A very simple directory listing program.
462 * Random Access Directory::     Rereading part of the directory
463                                   already read with the same stream.
464
465 File Attributes
466
467 * Attribute Meanings::          The names of the file attributes,
468                                  and what their values mean.
469 * Reading Attributes::          How to read the attributes of a file.
470 * Testing File Type::           Distinguishing ordinary files,
471                                  directories, links...
472 * File Owner::                  How ownership for new files is determined,
473                                  and how to change it.
474 * Permission Bits::             How information about a file's access mode
475                                  is stored.
476 * Access Permission::           How the system decides who can access a file.
477 * Setting Permissions::         How permissions for new files are assigned,
478                                  and how to change them.
479 * Testing File Access::         How to find out if your process can
480                                  access a file.
481 * File Times::                  About the time attributes of a file.
482
483 Pipes and FIFOs
484
485 * Creating a Pipe::             Making a pipe with the @code{pipe} function.
486 * Pipe to a Subprocess::        Using a pipe to communicate with a child.
487 * FIFO Special Files::          Making a FIFO special file.
488
489 Sockets
490
491 * Socket Concepts::             Basic concepts you need to know about.
492 * Communication Styles::        Stream communication, datagrams, and others.
493 * Socket Addresses::            How socket names (``addresses'') work.
494 * File Namespace::              Details about the file namespace.
495 * Internet Namespace::          Details about the Internet namespace.
496 * Open/Close Sockets::          Creating sockets and destroying them.
497 * Connections::                 Operations on sockets with connection state.
498 * Datagrams::                   Operations on datagram sockets.
499 * Socket Options::              Miscellaneous low-level socket options.
500 * Networks Database::           Accessing the database of network names.
501
502 Socket Addresses
503
504 * Address Formats::             About @code{struct sockaddr}.
505 * Setting Address::             Binding an address to a socket.
506 * Reading Address::             Reading the address of a socket.
507
508 Internet Domain
509
510 * Internet Address Format::     How socket addresses are specified in the
511                                  Internet namespace.
512 * Host Addresses::              All about host addresses of Internet hosts.
513 * Protocols Database::          Referring to protocols by name.
514 * Services Database::           Ports may have symbolic names.
515 * Byte Order::                  Different hosts may use different byte
516                                  ordering conventions; you need to
517                                  canonicalize host address and port number. 
518 * Inet Example::                Putting it all together.
519
520 Host Addresses
521
522 * Abstract Host Addresses::             What a host number consists of.
523 * Data type: Host Address Data Type.    Data type for a host number.
524 * Functions: Host Address Functions.    Functions to operate on them.
525 * Names: Host Names.                    Translating host names to host numbers.
526
527 Open/Close Sockets
528
529 * Creating a Socket::           How to open a socket.
530 * Closing a Socket::            How to close a socket.
531 * Socket Pairs::                These are created like pipes.
532
533 Connections
534
535 * Connecting::                  What the client program must do.
536 * Listening::                   How a server program waits for requests.
537 * Accepting Connections::       What the server does when it gets a request.
538 * Who is Connected::            Getting the address of the
539                                  other side of a connection.
540 * Transferring Data::           How to send and receive data.
541 * Byte Stream Example::         An example client for communicating over a
542                                  byte stream socket in the Internet namespace.
543 * Server Example::              A corresponding server program.
544 * Out-of-Band Data::            This is an advanced feature.
545
546 Transferring Data
547
548 * Sending Data::                Sending data with @code{write}.
549 * Receiving Data::              Reading data with @code{read}.
550 * Socket Data Options::         Using @code{send} and @code{recv}.
551
552 Datagrams
553
554 * Sending Datagrams::           Sending packets on a datagram socket.
555 * Receiving Datagrams::         Receiving packets on a datagram socket.
556 * Datagram Example::            An example program: packets sent over a
557                                  datagram stream in the file namespace.
558 * Example Receiver::            Another program, that receives those packets.
559
560 Socket Options
561
562 * Socket Option Functions::     The basic functions for setting and getting
563                                  socket options.
564 * Socket-Level Options::        Details of the options at the socket level.
565
566 Low-Level Terminal Interface
567
568 * Is It a Terminal::            How to determine if a file is a terminal
569                                  device, and what its name is.
570 * I/O Queues::                  About flow control and typeahead.
571 * Canonical or Not::            Two basic styles of input processing.
572 * Terminal Modes::              How to examine and modify flags controlling
573                                  terminal I/O: echoing, signals, editing.
574 * Line Control::                Sending break sequences, clearing  buffers...
575 * Noncanon Example::            How to read single characters without echo.
576
577 Terminal Modes
578
579 * Mode Data Types::             The data type @code{struct termios} and related types.
580 * Mode Functions::              Functions to read and set terminal attributes.
581 * Setting Modes::               The right way to set attributes reliably.
582 * Input Modes::                 Flags controlling low-level input handling.
583 * Output Modes::                Flags controlling low-level output handling.
584 * Control Modes::               Flags controlling serial port behavior.
585 * Local Modes::                 Flags controlling high-level input handling.
586 * Line Speed::                  How to read and set the terminal line speed.
587 * Special Characters::          Characters that have special effects,
588                                  and how to change them.
589 * Noncanonical Input::          Controlling how long to wait for input.
590
591 Special Characters
592
593 * Editing Characters::          
594 * Signal Characters::           
595 * Start/Stop Characters::       
596
597 Mathematics
598
599 * Domain and Range Errors::     How overflow conditions and the
600                                  like are reported.
601 * Not a Number::                Making NANs and testing for NANs.
602 * Trig Functions::              Sine, cosine, and tangent.
603 * Inverse Trig Functions::      Arc sine, arc cosine, and arc tangent.
604 * Exponents and Logarithms::    Also includes square root.
605 * Hyperbolic Functions::        Hyperbolic sine and friends.
606 * Pseudo-Random Numbers::       Functions for generating pseudo-random numbers.
607 * Absolute Value::              Absolute value functions.
608
609 Pseudo-Random Numbers
610
611 * ANSI Random::                 @code{rand} and friends.
612 * BSD Random::                  @code{random} and friends.
613
614 Low-Level Arithmetic Functions
615
616 * Normalization Functions::     Hacks for radix-2 representations.
617 * Rounding and Remainders::     Determinining the integer and
618                                  fractional parts of a float.
619 * Integer Division::            Functions for performing integer division.
620 * Parsing of Numbers::          Functions for ``reading'' numbers from strings.
621 * Predicates on Floats::        Some miscellaneous test functions.
622
623 Parsing of Numbers
624
625 * Parsing of Integers::         Functions for conversion of integer values.
626 * Parsing of Floats::           Functions for conversion of floating-point.
627
628 Date and Time
629
630 * Processor Time::              Measures processor time used by a program.
631 * Calendar Time::               Manipulation of ``real'' dates and times.
632 * Setting an Alarm::            Sending a signal after a specified time.
633 * Sleeping::                    Waiting for a period of time.
634
635 Processor Time
636
637 * Basic CPU Time::              The @code{clock} function.
638 * Detailed CPU Time::           The @code{times} function.
639
640 Calendar Time
641
642 * Simple Calendar Time::        Facilities for manipulating calendar time.
643 * High-Resolution Calendar::    A time representation with greater precision.
644 * Broken-down Time::            Facilities for manipulating local time.
645 * Formatting Date and Time::    Converting times to strings.
646 * TZ Variable::                 How users specify the time zone.
647 * Time Zone Functions::         Functions to examine or specify the time zone.
648 * Time Functions Example::      An example program showing use of some of
649                                  the time functions.
650
651 Signal Handling
652
653 * Concepts of Signals::         Introduction to the signal facilities.
654 * Standard Signals::            Particular kinds of signals with standard
655                                  names and meanings.
656 * Signal Actions::              Specifying what happens when a particular
657                                  signal is delivered.
658 * Defining Handlers::           How to write a signal handler function.
659 * Generating Signals::          How to send a signal to a process.
660 * Blocking Signals::            Making the system hold signals temporarily.
661 * Waiting for a Signal::        Suspending your program until a signal arrives.
662 * BSD Signal Handling::         Additional functions for backward
663                                  compatibility with BSD.
664 * BSD Handler::                 BSD Function to Establish a Handler
665
666 Basic Concepts of Signals
667
668 * Kinds of Signals::            Some examples of what can cause a signal.
669 * Signal Generation::           Concepts of why and how signals occur.
670 * Delivery of Signal::          Concepts of what a signal does to the process.
671
672 Standard Signals
673
674 * Program Error Signals::       Used to report serious program errors.
675 * Termination Signals::         Used to interrupt and/or terminate the program.
676 * Alarm Signals::               Used to indicate expiration of timers.
677 * Asynchronous I/O Signals::    Used to indicate input is available.
678 * Job Control Signals::         Signals used to support job control.
679 * Miscellaneous Signals::       Miscellaneous Signals
680 * Nonstandard Signals::         Implementations can support other signals.
681 * Signal Messages::             Printing a message describing a signal.
682
683 Specifying Signal Actions
684
685 * Basic Signal Handling::       The simple @code{signal} function.
686 * Advanced Signal Handling::    The more powerful @code{sigaction} function.
687 * Signal and Sigaction::        How those two functions interact.
688 * Sigaction Function Example::  An example of using the sigaction function.
689 * Flags for Sigaction::         Specifying options for signal handling.
690 * Initial Signal Actions::      How programs inherit signal actions.
691
692 Defining Signal Handlers
693
694 * Handler Returns::             
695 * Termination in Handler::      
696 * Longjmp in Handler::          
697 * Signals in Handler::       
698 * Nonreentrancy::               
699 * Atomic Data Access::          
700
701 Generating Signals
702
703 * Signaling Yourself::          Signaling Yourself
704 * Signaling Another Process::   Send a signal to another process.
705 * Permission for kill::         Permission for using @code{kill}
706 * Kill Example::                Using @code{kill} for Communication
707
708 Blocking Signals
709
710 * Why Block::                   The purpose of blocking signals.
711 * Signal Sets::                 How to specify which signals to block.
712 * Process Signal Mask::         Blocking delivery of signals to your
713                                  process during normal execution.
714 * Testing for Delivery::        Blocking to Test for Delivery of a Signal
715 * Blocking for Handler::        Blocking additional signals while a
716                                  handler is being run.
717 * Checking for Pending Signals::Checking for Pending Signals
718 * Remembering a Signal::        How you can get almost the same effect
719                                  as blocking a signal, by handling it
720                                  and setting a flag to be tested later.
721
722 Waiting for a Signal
723
724 * Using Pause::                 The simple way, using @code{pause}.
725 * Pause Problems::              Why the simple way is often not very good.
726 * Sigsuspend::                  Reliably waiting for a specific signal.
727
728 BSD Signal Handling
729
730 * POSIX vs BSD::                Comparison of BSD and POSIX signal functions.
731
732 BSD Function to Establish a Handler
733
734 * Blocking in BSD::             BSD Functions for Blocking Signals 
735 * Signal Stack::                Using a Separate Signal Stack
736
737 Process Startup and Termination
738
739 * Program Arguments::           Parsing your program's command-line arguments.
740 * Environment Variables::       How to access parameters inherited from
741                                  a parent process.
742 * Program Termination::         How to cause a process to terminate and
743                                  return status information to its parent.
744
745 Program Arguments
746
747 * Argument Syntax::             By convention, options start with a hyphen.
748 * Parsing Options::             The @code{getopt} function.
749 * Example of Getopt::           An example of parsing options with @code{getopt}.
750 * Long Options::                GNU utilities should accept long-named options.
751                                  Here is how to do that.
752 * Long Option Example::         An example of using @code{getopt_long}.
753
754 Environment Variables
755
756 * Environment Access::          How to get and set the values of
757                                  environment variables.
758 * Standard Environment::        These environment variables have
759                                  standard interpretations.
760
761 Program Termination
762
763 * Normal Termination::          If a program calls @code{exit}, a
764                                  process terminates normally.
765 * Exit Status::                 The @code{exit status} provides information 
766                                  about why the process terminated. 
767 * Cleanups on Exit::            A process can run its own cleanup
768                                  functions upon normal termination. 
769 * Aborting a Program::          The @code{abort} function causes
770                                  abnormal program termination. 
771 * Termination Internals::       What happens when a process terminates.
772
773
774 Child Processes
775
776 * Running a Command::           The easy way to run another program.
777 * Process Creation Concepts::   An overview of the hard way to do it.
778 * Process Identification::      How to get the process ID of a process.
779 * Creating a Process::          How to fork a child process.
780 * Executing a File::            How to make a child execute another program.
781 * Process Completion::          How to tell when a child process has completed.
782 * Process Completion Status::   How to interpret the status value 
783                                  returned from a child process.
784 * BSD Wait Functions::          More functions, for backward compatibility.
785 * Process Creation Example::    A complete example program.
786
787 Job Control
788
789 * Concepts of Job Control ::    Concepts of Job Control
790 * Job Control is Optional::     Not all POSIX systems support job control.
791 * Controlling Terminal::        How a process gets its controlling terminal.
792 * Access to the Terminal::      How processes share the controlling terminal.
793 * Orphaned Process Groups::     Jobs left after the user logs out.
794 * Implementing a Shell::        What a shell must do to implement job control.
795 * Functions for Job Control::   Functions to control process groups.
796
797 Implementing a Job Control Shell
798
799 * Data Structures::             Introduction to the sample shell.
800 * Initializing the Shell::      What the shell must do to take
801                                  responsibility for job control.
802 * Launching Jobs::              Creating jobs to execute commands.
803 * Foreground and Background::   Putting a job in foreground of background.
804 * Stopped and Terminated Jobs:: Reporting job status.
805 * Continuing Stopped Jobs::     How to continue a stopped job in
806                                  the foreground or background.
807 * Missing Pieces::              Other parts of the shell.
808
809 Functions for Job Control
810
811 * Identifying the Terminal::    Determining the controlling terminal's name.
812 * Process Group Functions::     Functions for manipulating process groups.
813 * Terminal Access Functions::   Functions for controlling terminal access.
814
815 Users and Groups
816
817 * User and Group IDs::          Each user and group has a unique numeric ID.
818 * Process Persona::             The user IDs and group IDs of a process.
819 * Why Change Persona::          Why a program might need to change
820                                  its user and/or group IDs.
821 * How Change Persona::          Restrictions on changing user and group IDs.
822 * Reading Persona::             Examining the process's user and group IDs.
823 * Setting User ID::             
824 * Setting Groups::              
825 * Enable/Disable Setuid::       
826 * Setuid Program Example::      Setuid Program Example
827 * Tips for Setuid::             
828 * Who Logged In::               Getting the name of the user who logged in,
829                                  or of the real user ID of the current process.
830
831 * User Database::               Functions and data structures for
832                                  accessing the user database.
833 * Group Database::              Functions and data structures for
834                                  accessing the group database.
835 * Database Example::            Example program showing use of database
836                                  inquiry functions.
837
838 User Database
839
840 * User Data Structure::         
841 * Lookup User::                 
842 * Scanning All Users::          Scanning the List of All Users
843 * Writing a User Entry::        
844
845 Group Database
846
847 * Group Data Structure::        
848 * Lookup Group::                
849 * Scanning All Groups::         Scanning the List of All Groups
850
851 System Information
852
853 * Host Identification::         Determining the name of the machine.
854 * Hardware/Software Type ID::   Determining the hardware type and
855                                  operating system type.
856
857 System Configuration Limits
858
859 * General Limits::              Constants and functions that describe
860                                  various process-related limits that have
861                                  one uniform value for any given machine.
862 * System Options::              Optional POSIX features.
863 * Version Supported::           Version numbers of POSIX.1 and POSIX.2.
864 * Sysconf::                     Getting specific configuration values
865                                  of general limits and system options.
866 * Minimums::                    Minimum values for general limits.
867    
868 * Limits for Files::            Size limitations on individual files.
869                                  These can vary between file systems
870                                   or even from file to file.
871 * Options for Files::           Optional features that some files may support.
872 * File Minimums::               Minimum values for file limits.
873 * Pathconf::                    Getting the limit values for a particular file.
874    
875 * Utility Limits::              Capacity limits of POSIX.2 utility programs.
876 * Utility Minimums::            Minimum allowable values of those limits.
877    
878 * String Parameters::           Getting the default search path.
879
880 Library Facilities that are Part of the C Language
881
882 * Consistency Checking::        Using @code{assert} to abort
883                                  if something ``impossible'' happens.
884 * Variadic Functions::          Defining functions with varying
885                                  numbers of arguments.
886 * Null Pointer Constant::       The macro @code{NULL}.
887 * Important Data Types::        Data types for object sizes.
888 * Data Type Measurements::      Parameters of data type representations.
889
890 Variadic Functions
891
892 * Why Variadic::                Reasons for making functions take
893                                  variable arguments.
894 * How Variadic::                How to define and call variadic functions.
895 * Argument Macros::             Detailed specification of the macros
896                                  for accessing variable arguments.
897 * Variadic Example::            A complete example.
898
899 How Variadic Functions are Defined and Used
900
901 * Variadic Prototypes::         How to make a prototype for a function
902                                  with variable arguments.
903 * Receiving Arguments::         Steps you must follow to access the
904                                  optional argument values.
905 * How Many Arguments::          How to decide whether there are more arguments.
906 * Calling Variadics::           Things you need to know about calling
907                                  variable arguments functions.
908
909 Data Type Measurements
910
911 * Width of Type::               How many bits does an integer type hold?
912 * Range of Type::               What are the largest and smallest values
913                                  that an integer type can hold?
914 * Floating Type Macros::        Parameters that measure floating-point types.
915 * Structure Measurement::       Getting measurements on structure types.
916
917 Floating Type Macros
918
919 * Floating Point Concepts::     Definitions of terminology.
920 * Floating Point Parameters::   Dimensions, limits of floating point types.
921 * IEEE Floating Point::         How one common representation is described.
922
923 Library Maintenance
924
925 * Installation::                How to configure, compile and install
926                                  the GNU C library.
927 * Reporting Bugs::              How to report bugs (if you want to
928                                  get them fixed) and other troubles
929                                  you may have with the GNU C library.
930 * Porting::                     How to port the GNU C library to
931                                  a new machine or operating system.
932 @c * Traditional C Compatibility::  Using the GNU C library with non-ANSI
933 @c                                          C compilers.
934 * Contributors::                Who wrote what parts of the GNU C Library.
935
936 Porting the GNU C Library
937
938 * Hierarchy Conventions::       How the @file{sysdeps} hierarchy is
939                                  layed out.
940 * Porting to Unix::             Porting the library to an average
941                                  Unix-like system.
942 @end menu
943
944
945 @comment Includes of all the individual chapters.
946 @include intro.texi
947 @include errno.texi
948 @include memory.texi
949 @include ctype.texi
950 @include string.texi
951 @include io.texi
952 @include stdio.texi
953 @include llio.texi
954 @include filesys.texi
955 @include pipe.texi
956 @include socket.texi
957 @include terminal.texi
958 @include math.texi
959 @include arith.texi
960 @include search.texi
961 @include pattern.texi
962 @include time.texi
963 @include mbyte.texi
964 @include locale.texi
965 @include setjmp.texi
966 @include signal.texi
967 @include startup.texi
968 @include process.texi
969 @include job.texi
970 @include users.texi
971 @include sysinfo.texi
972 @include conf.texi
973
974 @comment Includes of the appendices.
975 @include lang.texi
976 @include header.texi
977 @include maint.texi
978
979
980 @set lgpl-appendix
981 @node Copying, Concept Index, Maintenance, Top
982 @include lgpl.texinfo
983
984
985 @node Concept Index, Type Index, Copying, Top
986 @unnumbered Concept Index
987
988 @printindex cp
989
990 @node Type Index, Function Index, Concept Index, Top
991 @unnumbered Type Index
992
993 @printindex tp
994
995 @node Function Index, Variable Index, Type Index, Top
996 @unnumbered Function and Macro Index
997
998 @printindex fn
999
1000 @node Variable Index, File Index, Function Index, Top
1001 @unnumbered Variable and Constant Macro Index
1002
1003 @printindex vr
1004
1005 @node File Index, , Variable Index, Top
1006 @unnumbered Program and File Index
1007
1008 @printindex pg
1009
1010
1011 @shortcontents
1012 @contents
1013 @bye