share/man/man3/intro.3

   1 .\" Copyright (c) 1980, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)intro.3     8.1 (Berkeley) 6/5/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd March 22, 2017
  36 .Dt INTRO 3
  37 .Os
  38 .Sh NAME
  39 .Nm intro
  40 .Nd introduction to the C libraries
  41 .Sh DESCRIPTION
  42 This section provides an overview of the C
  43 library functions, their error returns and other
  44 common definitions and concepts.
  45 Most of these functions are available from the C library,
  46 .Em libc .
  47 Other libraries, such as the math library,
  48 .Em libm ,
  49 must be indicated at compile time with the
  50 .Fl l
  51 option of the compiler.
  52 .Pp
  53 The various libraries (followed by the loader flag):
  54 .Bl -tag -width "libc (-lc)"
  55 .It Em libc Pq Fl l Ns Ar c
  56 Standard C library functions.
  57 When using the C compiler
  58 .Xr cc 1 ,
  59 it is not necessary
  60 to supply the loader flag
  61 .Fl l Ns Ar c
  62 for these functions.
  63 There are several `libraries' or groups of functions included inside of
  64 .Em libc
  65 : the standard
  66 .Tn I/O
  67 routines,
  68 database routines,
  69 bit operators,
  70 string operators,
  71 character tests and character operators,
  72 des encryption routines,
  73 storage allocation, time functions, signal handling and more.
  74 .It Em libcurses Pq Fl l Ns Ar curses Fl l Ns Ar termcap
  75 Terminal independent screen management routines
  76 for two dimensional non-bitmap display terminals.
  77 (See
  78 .Xr ncurses 3 . )
  79 .It Em libcompat Pq Fl l Ns Ar compat
  80 Functions which are obsolete but are available for compatibility with
  81 .Bx 4.3 .
  82 In particular,
  83 a number of system call interfaces provided in previous releases of
  84 .Bx
  85 have been included for source code compatibility.
  86 Use of these routines should, for the most part, be avoided.
  87 The manual page entry for each compatibility routine
  88 indicates the proper interface to use.
  89 .It Em libkvm Pq Fl l Ns Ar kvm
  90 Functions used to access kernel memory are in this library.
  91 They can be used
  92 against both a running system and a crash dump.
  93 (See
  94 .Xr kvm 3 . )
  95 .It Em libl Pq Fl l Ns Ar l
  96 The library for
  97 .Xr lex 1 .
  98 .It Em libm Pq Fl l Ns Ar m
  99 The math library,
 100 .Em libm .
 101 The math library is loaded as needed by the Pascal compiler,
 102 but not by the C compiler which requires the
 103 .Fl l Ns Ar m
 104 flag.
 105 (See
 106 .Xr math 3 . )
 107 .It Em libmp Pq Fl l Ns Ar mp
 108 .It Em libtermcap Pq Fl l Ns Ar termcap
 109 The terminal independent operation library package.
 110 (See
 111 .Xr termcap 3 . )
 112 .It Em liby Pq Fl l Ns Ar y
 113 The library for
 114 .Xr yacc 1 .
 115 .El
 116 .Sh FILES
 117 .Bl -tag -width /usr/lib/libm_p.a -compact
 118 .It Pa /usr/lib/libc.a
 119 the C library
 120 .It Pa /usr/lib/libc_p.a
 121 the C library compiled for profiling
 122 .It Pa /usr/lib/libm.a
 123 the math library
 124 .It Pa /usr/lib/libm_p.a
 125 the math library compiled for profiling
 126 .El
 127 .Sh SEE ALSO
 128 .Xr cc 1 ,
 129 .Xr ld 1 ,
 130 .Xr nm 1 ,
 131 .Xr intro 2 ,
 132 .Xr math 3 ,
 133 .Xr stdio 3
 134 .Sh HISTORY
 135 An
 136 .Nm
 137 manual appeared in
 138 .At v7 .