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 .\"
  30 .Dd November 7, 2022
  31 .Dt INTRO 3
  32 .Os
  33 .Sh NAME
  34 .Nm intro
  35 .Nd introduction to the C libraries
  36 .Sh SYNOPSIS
  37 .Nm cc
  38 .Op Ar flags
  39 .Ar
  40 .Op Fl llibrary
  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 "libbluetooth"
  55 .It Em libbluetooth
  56 .Pq Fl l Ns Ar bluetooth
  57 The bluetooth library.
  58 See
  59 .Xr bluetooth 3 .
  60 .It Em libc
  61 .Pq Fl l Ns Ar c
  62 Standard C library functions.
  63 When using the C compiler
  64 .Xr cc 1 ,
  65 it is not necessary
  66 to supply the loader flag
  67 .Fl l Ns Ar c
  68 for these functions.
  69 There are several `libraries' or groups of functions included inside of
  70 .Em libc :
  71 .Bl -tag -width "XXXXXX"
  72 .It standard I/O routines
  73 see
  74 .Xr stdio 3
  75 .It database routines
  76 see
  77 .Xr db 3
  78 .It bit operators
  79 see
  80 .Xr bitstring 3
  81 .It string operators
  82 see
  83 .Xr string 3
  84 .It character tests and character operators
  85 .It storage allocation
  86 see
  87 .Xr mpool 3
  88 .It regular-expressions
  89 see
  90 .Xr regex 3
  91 .It remote procedure calls (RPC)
  92 see
  93 .Xr rpc 3
  94 .It time functions
  95 see
  96 .Xr time 3
  97 .It signal handling
  98 see
  99 .Xr signal 3
 100 .El
 101 .It Em libcalendar
 102 .Pq Fl l Ns Ar calendar
 103 The calendar arithmetic library.
 104 See
 105 .Xr calendar 3 .
 106 .It Em libcam
 107 .Pq Fl l Ns Ar cam
 108 The common access method user library.
 109 See
 110 .Xr cam 3 .
 111 .It Em libcrypt
 112 .Pq Fl l Ns Ar crypt
 113 The crypt library.
 114 See
 115 .Xr crypt 3 .
 116 .It Em libcurses
 117 .Pq Fl l Ns Ar curses Fl l Ns Ar termcap
 118 Terminal independent screen management routines
 119 for two dimensional non-bitmap display terminals.
 120 See
 121 .Xr ncurses 3 .
 122 .It Em libcuse
 123 .Pq Fl l Ns Ar cuse
 124 The userland character device library.
 125 See
 126 .Xr cuse 3 .
 127 .It Em libcompat
 128 .Pq Fl l Ns Ar compat
 129 Functions which are obsolete but are available for compatibility with
 130 .Bx 4.3 .
 131 In particular,
 132 a number of system call interfaces provided in previous releases of
 133 .Bx
 134 have been included for source code compatibility.
 135 Use of these routines should, for the most part, be avoided.
 136 The manual page entry for each compatibility routine
 137 indicates the proper interface to use.
 138 .It Em libdevinfo
 139 .Pq Fl l Ns Ar devinfo
 140 The Device and Resource Information Utility library.
 141 See
 142 .Xr devinfo 3 .
 143 .It Em libdevstat
 144 .Pq Fl l Ns Ar devstat
 145 The Device Statistics library.
 146 See
 147 .Xr devstat 3 .
 148 .It Em libdwarf
 149 .Pq Fl l Ns Ar dwarf
 150 The DWARF access library.
 151 See
 152 .Xr dwarf 3 .
 153 .It Em libelf
 154 .Pq Fl l Ns Ar elf
 155 The ELF access library.
 156 See
 157 .Xr elf 3 .
 158 .It Em libfetch
 159 .Pq Fl l Ns Ar fetch
 160 The file transfer library.
 161 See
 162 .Xr fetch 3 .
 163 .It Em libfigpar
 164 .Pq Fl l Ns Ar figpar
 165 The configuration file parsing library.
 166 See
 167 .Xr figpar 3 .
 168 .It Em libgpio
 169 .Pq Fl l Ns Ar gpio
 170 The general-purpose input output library (GPIO).
 171 See
 172 .Xr gpio 3 .
 173 .It Em libgssapi
 174 .Pq Fl l Ns Ar gssapi
 175 The generic security service application programming
 176 interface.
 177 See
 178 .Xr gssapi 3 .
 179 .It Em libjail
 180 .Pq Fl l Ns Ar jail
 181 The jail library.
 182 See
 183 .Xr jail 3 .
 184 .It Em libkvm
 185 .Pq Fl l Ns Ar kvm
 186 Functions used to access kernel memory are in this library.
 187 They can be used
 188 against both a running system and a crash dump.
 189 See
 190 .Xr kvm 3 .
 191 .It Em libl
 192 .Pq Fl l Ns Ar l
 193 The library for
 194 .Xr lex 1 .
 195 .It Em libm
 196 .Pq Fl l Ns Ar m
 197 The math library.
 198 See
 199 .Xr math 3 .
 200 .It Em libmd
 201 .Pq Fl l Ns Ar md
 202 The message digest library.
 203 See
 204 .Xr md4 3 ,
 205 .Xr md5 3 ,
 206 .Xr sha 3 ,
 207 .Xr sha256 3 ,
 208 .Xr sha512 3 ,
 209 .Xr ripemd 3 ,
 210 .Xr skein 3 .
 211 .It Em libmp
 212 .Pq Fl l Ns Ar mp
 213 .It Em libpam
 214 .Pq Fl l Ns Ar pam
 215 The pluggable authentication module library.
 216 See
 217 .Xr pam 3 .
 218 .It Em libpcap
 219 .Pq Fl l Ns Ar pcap
 220 The packet capture library.
 221 See
 222 .Xr pcap 3 .
 223 .It Em libpmc
 224 .Pq Fl l Ns Ar pmc
 225 The performance counters library.
 226 See
 227 .Xr pmc 3 .
 228 .It Em libpthread
 229 .Pq Fl l Ns Ar pthread
 230 The POSIX threads library.
 231 See
 232 .Xr pthread 3 .
 233 .It Em libstdthreads
 234 .Pq Fl l Ns Ar stdthreads
 235 The ISO C11 standard
 236 .In threads.h
 237 library.
 238 See
 239 .Xr thrd_create 3 .
 240 .It Em libsysdecode
 241 .Pq Fl l Ns Ar sysdecode
 242 The system argument decoding library.
 243 See
 244 .Xr sysdecode 3 .
 245 .It Em libtermcap
 246 .Pq Fl l Ns Ar termcap
 247 The terminal independent operation library package.
 248 See
 249 .Xr termcap 3 .
 250 .It Em libusb
 251 .Pq Fl l Ns Ar usb
 252 The USB access library.
 253 See
 254 .Xr usb 3 .
 255 .It Em libvgl
 256 .Pq Fl l Ns Ar vgl
 257 The video graphics library.
 258 See
 259 .Xr vgl 3 .
 260 .It Em liby
 261 .Pq Fl l Ns Ar y
 262 The library for
 263 .Xr yacc 1 .
 264 .It Em libz
 265 .Pq Fl l Ns Ar z
 266 The general-purpose data compression library.
 267 See
 268 .Xr zlib 3 .
 269 .El
 270 .Sh FILES
 271 .Bl -tag -width /usr/lib/libm_p.a -compact
 272 .It Pa /usr/lib/libc.a
 273 the C library
 274 .It Pa /usr/lib/libc_p.a
 275 the C library compiled for profiling
 276 .It Pa /usr/lib/libm.a
 277 the math library
 278 .It Pa /usr/lib/libm_p.a
 279 the math library compiled for profiling
 280 .El
 281 .Sh SEE ALSO
 282 .Xr cc 1 ,
 283 .Xr ld 1 ,
 284 .Xr nm 1 ,
 285 .Xr intro 2 ,
 286 .Xr math 3 ,
 287 .Xr stdio 3
 288 .Sh HISTORY
 289 An
 290 .Nm
 291 manual appeared in
 292 .At v7 .