original/man3/intro.3

   1 .\" Copyright (C) 2007 Michael Kerrisk <mtk.manpages@gmail.com>
   2 .\"
   3 .\" Permission is granted to make and distribute verbatim copies of this
   4 .\" manual provided the copyright notice and this permission notice are
   5 .\" preserved on all copies.
   6 .\"
   7 .\" Permission is granted to copy and distribute modified versions of this
   8 .\" manual under the conditions for verbatim copying, provided that the
   9 .\" entire resulting derived work is distributed under the terms of a
  10 .\" permission notice identical to this one.
  11 .\"
  12 .\" Since the Linux kernel and libraries are constantly changing, this
  13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  14 .\" responsibility for errors or omissions, or for damages resulting from
  15 .\" the use of the information contained herein.  The author(s) may not
  16 .\" have taken the same level of care in the production of this manual,
  17 .\" which is licensed free of charge, as they might when working
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\"
  23 .\" 2007-10-23 mtk, Nearly a complete rewrite of the earlier page.
  24 .TH INTRO 3 2010-11-11 "Linux" "Linux Programmer's Manual"
  25 .SH NAME
  26 intro \- Introduction to library functions
  27 .SH DESCRIPTION
  28 Section 3 of the manual describes all library functions excluding the library
  29 functions (system call wrappers) described in section 2,
  30 which implement system calls.
  31
  32 Many of the functions described in the section are part of the
  33 Standard C Library
  34 .RI ( libc ).
  35 Some functions are part of other libraries (e.g.,
  36 the math library,
  37 .IR libm ,
  38 or the real-time library,
  39 .IR librt )
  40 in which case the manual page will indicate the linker
  41 option needed to link against the required library
  42 (e.g.,
  43 .I \-lm
  44 and
  45 .IR \-lrt ,
  46 respectively,
  47 for the aforementioned libraries).
  48
  49 In some cases,
  50 the programmer must define a feature test macro in order to obtain
  51 the declaration of a function from the header file specified
  52 in the man page SYNOPSIS section.
  53 (Where required, these feature test macros must be defined before including
  54 .I any
  55 header files.)
  56 In such cases, the required macro is described in the man page.
  57 For further information on feature test macros, see
  58 .BR feature_test_macros (7).
  59 .\"
  60 .\" There
  61 .\" are various function groups which can be identified by a letter which
  62 .\" is appended to the chapter number:
  63 .\" .IP (3C)
  64 .\" These functions, the functions from chapter 2 and from chapter 3S are
  65 .\" contained in the C standard library libc, which will be used by
  66 .\" .BR cc (1)
  67 .\" by default.
  68 .\" .IP (3S)
  69 .\" These functions are parts of the
  70 .\" .BR stdio (3)
  71 .\" library.  They are contained in the standard C library libc.
  72 .\" .IP (3M)
  73 .\" These functions are contained in the arithmetic library libm.  They are
  74 .\" used by the
  75 .\" .BR f77 (1)
  76 .\" FORTRAN compiler by default, but not by the
  77 .\" .BR cc (1)
  78 .\" C compiler, which needs the option \fI\-lm\fP.
  79 .\" .IP (3F)
  80 .\" These functions are part of the FORTRAN library libF77.  There are no
  81 .\" special compiler flags needed to use these functions.
  82 .\" .IP (3X)
  83 .\" Various special libraries.  The manual pages documenting their functions
  84 .\" specify the library names.
  85 .SH "CONFORMING TO"
  86 Certain terms and abbreviations are used to indicate UNIX variants
  87 and standards to which calls in this section conform.
  88 See
  89 .BR standards (7).
  90 .SH NOTES
  91 .SS Authors and Copyright Conditions
  92 Look at the header of the manual page source for the author(s) and copyright
  93 conditions.
  94 Note that these can be different from page to page!
  95 .SH "SEE ALSO"
  96 .BR intro (2),
  97 .BR errno (3),
  98 .BR capabilities (7),
  99 .BR credentials (7),
 100 .BR environ (7),
 101 .BR feature_test_macros (7),
 102 .BR libc (7),
 103 .BR math_error (7),
 104 .BR path_resolution (7),
 105 .BR pthreads (7),
 106 .BR signal (7),
 107 .BR standards (7)