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