path: root/share/man/man3/intro.3

.\"	$OpenBSD: intro.3,v 1.15 2003/05/21 11:49:04 jmc Exp $
.\"	$NetBSD: intro.3,v 1.5 1995/05/10 22:46:24 jtc Exp $
.\"
.\" Copyright (c) 1980, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)intro.3	8.1 (Berkeley) 6/5/93
.\"
.Dd June 5, 1993
.Dt INTRO 3
.Os
.Sh NAME
.Nm intro
.Nd introduction to the C libraries
.Sh DESCRIPTION
The manual pages in section 3 provide an overview of the C library
functions, their error returns, and other common definitions and concepts.
Most of these functions are available from the C library,
.Em libc .
Other libraries, such as the math library,
.Em libm ,
must be indicated at compile time with the
.Fl l
option of the compiler.
.Pp
The various libraries (followed by the loader flag):
.Bl -tag -width Ds
.It libc Pq Fl l Ns Ar c
Standard C library functions.
When using the C compiler
.Xr cc 1 ,
it is not necessary to supply the loader flag
.Fl l Ns Ar c
for these functions.
There are several
.Dq libraries
or groups of functions included inside of libc: the standard
.Tn I/O
routines,
database routines,
bit operators,
string operators,
character tests and character operators,
DES encryption routines,
storage allocation,
time functions,
signal handling,
and more.
.It libcurses Pq Fl l Ns Ar curses
Terminal independent screen management routines for two-dimensional
non-bitmap display terminals.
See
.Xr curses 3 .
.It libcompat Pq Fl l Ns Ar compat
Functions which are obsolete but are available for compatibility with
.Bx 4.3 .
In particular, a number of system call interfaces provided in previous
releases of
.Bx
have been included for source code compatibility.
Use of these routines should, for the most part, be avoided.
The manual page entry for each compatibility routine
indicates the proper interface to use.
.It libkvm Pq Fl l Ns Ar kvm
Kernel virtual interface library.
See
.Xr kvm 3 .
.It libl Pq Fl l Ns Ar l
The library for
.Xr lex 1 .
.It libm Pq Fl l Ns Ar m
The math library,
.Em libm .
See
.Xr math 3 .
.It libpthread Pq Ar -pthread
.St -p1003.1-01
threads (see
.Xr pthreads 3 )
API and thread scheduler.
Threaded applications should use
.Ar -pthread
not
.Fl l Ns Ar pthread .
.It libtermcap Pq Fl l Ns Ar termcap
The terminal independent operation library package.
(See
.Xr termcap 3 . )
.El
.Sh FILES
.Bl -tag -width /usr/lib/libgnumalloc.a -compact
.It Pa /usr/lib/libasn1.a
.It Pa /usr/lib/libbfd.a
.It Pa /usr/lib/libc.a
C library.
.It Pa /usr/lib/libcom_err.a
.It Pa /usr/lib/libcompat.a
4.3 compatibility library.
.It Pa /usr/lib/libcrypto.a
.Xr ssl 8
support library.
.It Pa /usr/lib/libcurses++.a
C++
.Xr curses 3
library.
.It Pa /usr/lib/libcurses.a
.Xr curses 3
library.
.It Pa /usr/lib/libdes.a
.It Pa /usr/lib/libedit.a
.It Pa /usr/lib/libevent.a
.It Pa /usr/lib/libfl.a
.It Pa /usr/lib/libform.a
.It Pa /usr/lib/libfrtbegin.a
.It Pa /usr/lib/libg2c.a
.It Pa /usr/lib/libgssapi.a
.It Pa /usr/lib/libhdb.a
.It Pa /usr/lib/libiberty.a
.It Pa /usr/lib/libkadm5clnt.a
.It Pa /usr/lib/libkadm5srv.a
.It Pa /usr/lib/libkafs.a
afsd support library.
.It Pa /usr/lib/libkeynote.a
.It Pa /usr/lib/libkrb5.a
.It Pa /usr/lib/libkvm.a
.Xr kvm 3
kernel virtual memory access library.
.It Pa /usr/lib/libl.a
.It Pa /usr/lib/libm.a
.Xr math 3
library.
.It Pa /usr/lib/libmenu.a
.It Pa /usr/lib/libmmalloc.a
.It Pa /usr/lib/libncurses.a
.It Pa /usr/lib/libobjc.a
.It Pa /usr/lib/libocurses.a
The
.Xr ocurses 3
library is compatible with the
.Em curses
library provided in 4.3.
.It Pa /usr/lib/libopcodes.a
.It Pa /usr/lib/libossaudio.a
.It Pa /usr/lib/libotermcap.a
4.3-compatible termcap library.
For use with
.Xo
.Xr ocurses 3
.Pf ( i.e., Fl l Ns Ar ocurses
.Fl l Ns Ar otermcap ) .
.Xc
.It Pa /usr/lib/libpanel.a
.Xr panel 3
library for use with
.Xo
.Xr curses 3
.Pf ( i.e., Fl l Ns Ar panel
.Fl l Ns Ar curses ) .
.Xc
.It Pa /usr/lib/libpcap.a
.Xr pcap 3
library.
.It Pa /usr/lib/libperl.a
.It Pa /usr/lib/libpthread.a
.St -p1003.1-01
threads library (see
.Xr pthreads 3 ) .
.It Pa /usr/lib/libreadline.a
.It Pa /usr/lib/libresolv.a
The
.Xr resolver 3
routines are included in
.Em libc .
For legacy applications, this library contains only those functions.
.It Pa /usr/lib/librpcsvc.a
Generated by
.Xr rpcgen 1 ,
containing stub functions for many common
.Xr rpc 3
protocols.
.It Pa /usr/lib/libsectok.a
.It Pa /usr/lib/libskey.a
Support library for the
.Xr skey 1
authentication toolkit.
.It Pa /usr/lib/libssl.a
.Xr ssl 8
support library.
.It Pa /usr/lib/libstdc++.a
.It Pa /usr/lib/libtermcap.a
.It Pa /usr/lib/libtermlib.a
.It Pa /usr/lib/libusbhid.a
.It Pa /usr/lib/libutil.a
.It Pa /usr/lib/libwrap.a
.It Pa /usr/lib/liby.a
.It Pa /usr/lib/libz.a
.Pp
.It Pa /usr/lib/libi386.a
.El
.\" Must talk about shared libraries, _p profiled libraries, and how to tell the
.\" C compiler to use them, and any other issues.
.Sh SEE ALSO
.Xr cc 1 ,
.Xr ld 1 ,
.Xr ld.so 1 ,
.Xr nm 1 ,
.Xr intro 2 ,
.Xr math 3 ,
.Xr pthreads 3 ,
.Xr stdio 3
.\" .Sh LIST OF FUNCTIONS
.\" .Bl -column "strncasecmpxxx" "system"
.\" .Sy Name	Description
.\" .El
.Sh HISTORY
An
.Nm
manual appeared in
.At v7 .