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