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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)intro.3     8.1 (Berkeley) 6/5/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd October 6, 2020
  32 .Dt INTRO 3
  33 .Os
  34 .Sh NAME
  35 .Nm intro
  36 .Nd introduction to the C libraries
  37 .Sh SYNOPSIS
  38 .Nm cc
  39 .Op Ar flags
  40 .Ar
  41 .Op Fl llibrary
  42 .Sh DESCRIPTION
  43 This section provides an overview of the C
  44 library functions, their error returns and other
  45 common definitions and concepts.
  46 Most of these functions are available from the C library,
  47 .Em libc .
  48 Other libraries, such as the math library,
  49 .Em libm ,
  50 must be indicated at compile time with the
  51 .Fl l
  52 option of the compiler.
  53 .Pp
  54 The various libraries (followed by the loader flag):
  55 .Bl -tag -width "libbluetooth (-lbluetooth)"
  56 .It Em libbluetooth Pq Fl l Ns Ar bluetooth
  57 The bluetooth library.
  58 See
  59 .Xr bluetooth 3 .
  60 .It Em libc Pq Fl l Ns Ar c
  61 Standard C library functions.
  62 When using the C compiler
  63 .Xr cc 1 ,
  64 it is not necessary
  65 to supply the loader flag
  66 .Fl l Ns Ar c
  67 for these functions.
  68 There are several `libraries' or groups of functions included inside of
  69 .Em libc :
  70 .Bl -tag -width "XXXXXX"
  71 .It standard I/O routines
  72 see
  73 .Xr stdio 3
  74 .It database routines
  75 see
  76 .Xr db 3
  77 .It bit operators
  78 see
  79 .Xr bitstring 3
  80 .It string operators
  81 see
  82 .Xr string 3
  83 .It character tests and character operators
  84 .It storage allocation
  85 see
  86 .Xr mpool 3
  87 .It regular-expressions
  88 see
  89 .Xr regex 3
  90 .It remote procedure calls (RPC)
  91 see
  92 .Xr rpc 3
  93 .It time functions
  94 see
  95 .Xr time 3
  96 .It signal handling
  97 see
  98 .Xr signal 3
  99 .El
 100 .It Em libcalendar Pq Fl l Ns Ar calendar
 101 The calendar arithmetic library.
 102 See
 103 .Xr calendar 3 .
 104 .It Em libcam Pq Fl l Ns Ar cam
 105 The common access method user library.
 106 See
 107 .Xr cam 3 .
 108 .It Em libcrypt Pq Fl l Ns Ar crypt
 109 The crypt library.
 110 See
 111 .Xr crypt 3 .
 112 .It Em libcurses Pq Fl l Ns Ar curses Fl l Ns Ar termcap
 113 Terminal independent screen management routines
 114 for two dimensional non-bitmap display terminals.
 115 See
 116 .Xr ncurses 3 .
 117 .It Em libcuse Pq Fl l Ns Ar cuse
 118 The userland character device library.
 119 See
 120 .Xr cuse 3 .
 121 .It Em libcompat Pq Fl l Ns Ar compat
 122 Functions which are obsolete but are available for compatibility with
 123 .Bx 4.3 .
 124 In particular,
 125 a number of system call interfaces provided in previous releases of
 126 .Bx
 127 have been included for source code compatibility.
 128 Use of these routines should, for the most part, be avoided.
 129 The manual page entry for each compatibility routine
 130 indicates the proper interface to use.
 131 .It Em libdevinfo Pq Fl l Ns Ar devinfo
 132 The Device and Resource Information Utility library.
 133 See
 134 .Xr devinfo 3 .
 135 .It Em libdevstat Pq Fl l Ns Ar devstat
 136 The Device Statistics library.
 137 See
 138 .Xr devstat 3 .
 139 .It Em libdwarf Pq Fl l Ns Ar dwarf
 140 The DWARF access library.
 141 See
 142 .Xr dwarf 3 .
 143 .It Em libelf Pq Fl l Ns Ar elf
 144 The ELF access library.
 145 See
 146 .Xr elf 3 .
 147 .It Em libfetch Pq Fl l Ns Ar fetch
 148 The file transfer library.
 149 See
 150 .Xr fetch 3 .
 151 .It Em libfigpar Pq Fl l Ns Ar figpar
 152 The configuration file parsing library.
 153 See
 154 .Xr figpar 3 .
 155 .It Em libgpio Pq Fl l Ns Ar gpio
 156 The general-purpose input output library (GPIO).
 157 See
 158 .Xr gpio 3 .
 159 .It Em libgssapi Pq Fl l Ns Ar gssapi
 160 The generic security service application programming
 161 interface.
 162 See
 163 .Xr gssapi 3 .
 164 .It Em libjail Pq Fl l Ns Ar jail
 165 The jail library.
 166 See
 167 .Xr jail 3 .
 168 .It Em libkvm Pq Fl l Ns Ar kvm
 169 Functions used to access kernel memory are in this library.
 170 They can be used
 171 against both a running system and a crash dump.
 172 See
 173 .Xr kvm 3 .
 174 .It Em libl Pq Fl l Ns Ar l
 175 The library for
 176 .Xr lex 1 .
 177 .It Em libm Pq Fl l Ns Ar m
 178 The math library.
 179 See
 180 .Xr math 3 .
 181 .It Em libmd Pq Fl l Ns Ar md
 182 The message digest library.
 183 See
 184 .Xr md4 3 ,
 185 .Xr md5 3 ,
 186 .Xr sha 3 ,
 187 .Xr sha256 3 ,
 188 .Xr sha512 3 ,
 189 .Xr ripemd 3 ,
 190 .Xr skein 3 .
 191 .It Em libmp Pq Fl l Ns Ar mp
 192 .It Em libpam Pq Fl l Ns Ar pam
 193 The pluggable authentication module library.
 194 See
 195 .Xr pam 3 .
 196 .It Em libpcap Pq Fl l Ns Ar pcap
 197 The packet capture library.
 198 See
 199 .Xr pcap 3 .
 200 .It Em libpmc Pq Fl l Ns Ar pmc
 201 The performance counters library.
 202 See
 203 .Xr pmc 3 .
 204 .It Em libpthread Pq Fl l Ns Ar pthread
 205 The POSIX threads library.
 206 See
 207 .Xr pthread 3 .
 208 .It Em libsysdecode Pq Fl l Ns Ar sysdecode
 209 The system argument decoding library.
 210 See
 211 .Xr sysdecode 3 .
 212 .It Em libtermcap Pq Fl l Ns Ar termcap
 213 The terminal independent operation library package.
 214 See
 215 .Xr termcap 3 .
 216 .It Em libusb Pq Fl l Ns Ar usb
 217 The USB access library.
 218 See
 219 .Xr usb 3 .
 220 .It Em libvgl Pq Fl l Ns Ar vgl
 221 The video graphics library.
 222 See
 223 .Xr vgl 3 .
 224 .It Em liby Pq Fl l Ns Ar y
 225 The library for
 226 .Xr yacc 1 .
 227 .It Em libz Pq Fl l Ns Ar z
 228 The general-purpose data compression library.
 229 See
 230 .Xr zlib 3 .
 231 .El
 232 .Sh FILES
 233 .Bl -tag -width /usr/lib/libm_p.a -compact
 234 .It Pa /usr/lib/libc.a
 235 the C library
 236 .It Pa /usr/lib/libc_p.a
 237 the C library compiled for profiling
 238 .It Pa /usr/lib/libm.a
 239 the math library
 240 .It Pa /usr/lib/libm_p.a
 241 the math library compiled for profiling
 242 .El
 243 .Sh SEE ALSO
 244 .Xr cc 1 ,
 245 .Xr ld 1 ,
 246 .Xr nm 1 ,
 247 .Xr intro 2 ,
 248 .Xr math 3 ,
 249 .Xr stdio 3
 250 .Sh HISTORY
 251 An
 252 .Nm
 253 manual appeared in
 254 .At v7 .