xref: /netbsd-src/share/man/man3/intro.3 (revision 06be8101a16cc95f40783b3cb7afd12112103a9a)
1.\"	$NetBSD: intro.3,v 1.12 2001/11/10 06:32:37 gmcgarry Exp $
2.\"
3.\" Copyright (c) 1980, 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"     @(#)intro.3	8.1 (Berkeley) 6/5/93
35.\"
36.Dd October 4, 2001
37.Dt INTRO 3
38.Os
39.Sh NAME
40.Nm intro
41.Nd introduction to the system libraries
42.Sh DESCRIPTION
43This section provides an overview of the system libraries, their
44functions, error returns and other common definitions and concepts.
45Most of these functions are available from the standard C library,
46.Em libc .
47Other libraries, such as the math library,
48.Em libm ,
49must be indicated at compile time with the
50.Fl l
51option of the compiler.
52.\" .Pp
53.\" A subset of the
54.\" .Xr libc functions
55.\" are available from Fortran;
56.\" they are described separately in
57.\" .Xr intro 3f .
58.Pp
59The various system libraries supplied in
60.Nx
61(followed by the linker flags) are:
62.Bl -tag -width "libc (-lc)"
63.It Em libasn1 Pq Fl l Ns Ar asn1
64The abstract syntax notation (ASN) library provides routines for the
65specification of abstract data types.
66.It Em libbz2 Pq Fl l Ns Ar bz2
67Block-sorting compressor library providing routines for fast and
68efficient compression.
69.It Em libc Pq Fl l Ns Ar c
70Standard C library functions.  When using the C compiler
71.Xr cc 1 ,
72it is not necessary to supply the linker flag
73.Fl l Ns Ar c
74for these functions.  There are several subsystems included inside
75.Em libc :
76.Pp
77.Bl -tag -width "XXXXXX"
78.It standard I/O routines
79see
80.Xr stdio 3
81.It database routines
82see
83.Xr db 3
84.It bit operators
85see
86.Xr bit_string 3
87.It string operators
88see
89.Xr string 3
90.It character tests and character operators
91.It Tn encryption and hash routines
92see
93.Xr md4 3
94and
95.Xr md5 3 .
96.It storage allocation
97see
98.Xr mpool 3
99and
100.Xr malloc 3
101.It time functions
102see
103.Xr time 3
104.It signal handling
105see
106.Xr signal 3
107.El
108.It Em libcdk Pq Fl l Ns Ar cdk
109Curses development kit (CDK) library.
110.It Em libcom_err Pq Fl l Ns Ar com_err
111The common error description library.
112.It Em libcompat Pq Fl l Ns Ar compat
113Functions which are obsolete but are available for compatibility with
114.Bx 4.3 .
115In particular, a number of system call interfaces provided in previous
116releases of
117.Bx
118have been included for source code compatibility.  Use of these
119routines should, for the most part, be avoided.  The manual page entry
120for each compatibility routine indicates the proper interface to use.
121.It Em libcrypt Pq Fl l Ns Ar crypt
122Crypt library functions.  See
123.Xr crypt 3 .
124.It Em libcrypto Pq Fl l Ns Ar crypto
125The OpenSSL cryptographic library routines.  See
126.Xr crypto 3 .
127.It Em libcrypto_idea Pq Fl l Ns Ar crypto_idea
128The OpenSSL cryptographic library routines for the IDEA algorithm.
129This algorithm is separated from libcrypto since the IDEA algorithm is
130protected by patents and its use is restricted.
131.It Em libcrypto_rc5 Pq Fl l Ns Ar crypto_rc5
132The OpenSSL cryptographic library routines for the RC5 algorithm.
133This algorithm is separated from libcrypto since the RC5 algorithm is
134protected by patents and its use is restricted.
135.It Xo
136.Em libcurses
137.Pf ( Ns Fl l Ns Ar curses
138.Fl l Ns Ar termcap )
139.Xc
140Terminal independent screen management routines
141for two dimensional non-bitmap display terminals.  See
142.Xr curses 3 .
143.It Em libdes Pq Fl l Ns Ar des
144The OpenSSL cryptographic library for the DES algorithms.  See
145.Xr des 3 .
146.It Em libedit Pq Fl l Ns Ar edit
147The command-line editor or editline library.  The editline library
148provides generic editing and history functions.  See
149.Xr editline 3 .
150.It Em libform Pq Fl l Ns Ar form
151The curses form library functions provides a terminal-independent form
152system using the curses library.  The form library provides facilities
153for defining forms on terminals.  See
154.Xr forms 3 .
155.It Em libgssapi Pq Fl l Ns Ar gssapi
156The Generic Security Services (GSS) API library.  This library provides
157verification services to applications and usually sits above the
158cryptographic libraries.
159.It Em libhesiod Pq Fl l Ns Ar hesiod
160The Hesiod library functions.  This library provides routines for
161performing lookups of Hesiod information, which is stored as text
162records in the Domain Name Service.  See
163.Xr hesiod 3 .
164.It Em libhdb Pq Fl l Ns Ar hdb
165The Heimdal Kerberos 5 authentication/authorisation database library.
166.It Em libintl Pq Fl l Ns Ar intl
167The internationalized message handling library.  See
168.Xr gettext 3 .
169.It Em libipsec Pq Fl l Ns Ar ipsec
170The IPsec policy control library.  See
171.Xr ipsec_set_policy 3
172and
173.Xr ipsec_strerror 3 .
174.It Em libkadm Pq Fl l Ns Ar kadm
175The Kerberos 4 administration server and client library.
176.It Em libkadm5clnt Pq Fl l Ns Ar kadm5clnt
177The Kerberos 5 administration client library.
178.It Em libkadm5srv Pq Fl l Ns Ar kadm5srv
179The Kerberos 5 administration server library.
180.It Em libkafs Pq Fl l Ns Ar kafs
181The Kerberos AFS library functions.
182.It Em libkdb Pq Fl l Ns Ar kdb
183The Kerberos 4 authentication/authorisation database library.
184.It Em libkrb Pq Fl l Ns Ar krb
185The Kerberos 4 library.
186.It Em libkrb5 Pq Fl l Ns Ar krb5
187The Kerberos 5 library.  See
188.Xr krb5 3 .
189.It Em libkstream Pq Fl l Ns Ar kstream
190Kerberos 4 encrypted stream library.
191.It Em libkvm Pq Fl l Ns Ar kvm
192Kernel data access library.  See
193.Xr kvm 3 .
194.It Em libl Pq Fl l Ns Ar l
195The library for
196.Xr lex 1 .
197.It Em libm Pq Fl l Ns Ar m
198The math library.  See
199.Xr math 3 .
200.\" The math library is loaded as needed by the Pascal compiler
201.\" .Xr pc 1 ,
202.\" but not by the C compiler which requires the
203.\" .Fl l Ns Ar m
204.\" flag (see
205.\" .Xr math 3 ) .
206.\" .It Em libmp Pq Fl l Ns Ar mp
207.\" .It Em libom
208.\" Old math library.
209.\" .It Em libplot Pq Fl l Ns Ar plot
210.\" Device independent plotting functions (see
211.\" .Xr plot 3 ) .
212.\" .It Em libplotf77 Pq Fl l Ns Ar plotf77
213.\" The device independent plotting functions for fortran. (see
214.\" .Xr plot 3 ) .
215.\" .It Em libresolv Pq Fl l Ns Ar resolv
216.\" Routines for network address resolution.
217.It Em libmenu Pq Fl l Ns Ar menu
218The curses menu library.  See
219.Xr menus 3 .
220.It Em libpcap Pq Fl l Ns Ar pcap
221The packet capture library.  See
222.Xr pcap 3 .
223.It Em libpci Pq Fl l Ns Ar pci
224The PCI bus access library.  See
225.Xr pci 3 .
226.It Em libposix Pq Fl l Ns Ar posix
227POSIX compatibility library.
228.It Em libresolv Pq Fl l Ns Ar resolv
229The DNS resolver library.
230.It Em librmt Pq Fl l Ns Ar rmt
231Remote magnetic tap library.  See
232.Xr rmtops 3 .
233.It Em libroken Pq Fl l Ns Ar roken
234A library containing compatibility functions used by Kerberos.  It
235implements functionality required by the Kerberos implementation not
236implemented in the standard
237.Nx
238libraries.
239.It Em librpcsvc Pq Fl l Ns Ar rpcsvc
240The Remote Procedure Call (RPC) services library.  See
241.Xr rpc 3 .
242.It Em libskey Pq Fl l Ns Ar skey
243The S/Key one-time password library.  See
244.Xr skey 3 .
245.It Em libsl Pq Fl l Ns Ar sl
246.It Em libss Pq Fl l Ns Ar ss
247.It Em libssl Pq Fl l Ns Ar ssl
248The secure sockets layer (SSL) library.  See
249.Xr ssl 3 .
250.It Em libtelnet Pq Fl l Ns Ar telnet
251The telnet library.
252.It Em libtermcap Pq Fl l Ns Ar termcap
253The terminal-independent operation library.  See
254.Xr termcap 3 .
255.It Em libusb Pq Fl l Ns Ar usb
256The Universal Serial Bus (USB) access library.  See
257.Xr usb 3 .
258.It Em libutil Pq Fl l Ns Ar util
259The system utilities library.  See
260.Xr opendisk 3 ,
261etc.
262.It Em libwrap Pq Fl l Ns Ar wrap
263The TCP wrappers library.  See
264.Xr host_access 3 .
265.It Em liby Pq Fl l Ns Ar y
266The library for
267.Xr yacc 1 .
268.It Em libz Pq Fl l Ns Ar z
269General-purpose compression library.
270.El
271.Sh SEE ALSO
272.Xr cc 1 ,
273.Xr ld 1 ,
274.Xr nm 1 ,
275.Xr rtld 1 ,
276.Xr intro 2
277.Sh HISTORY
278An
279.Nm intro
280manual appeared in
281.At v7 .
282