ec3e22fd989b5a35975d25d56143d64e9918271e
[dragonfly.git] / 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: src/share/man/man3/intro.3,v 1.9.2.4 2001/08/17 13:08:36 ru Exp $
34 .\" $DragonFly: src/share/man/man3/intro.3,v 1.2 2003/06/17 04:36:58 dillon Exp $
35 .\"
36 .Dd June 5, 1993
37 .Dt INTRO 3
38 .Os
39 .Sh NAME
40 .Nm intro
41 .Nd introduction to the C libraries
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 .\" (see
49 .\" .Xr libc 3 ) .
50 Other libraries, such as the math library,
51 .Em libm ,
52 must be indicated at compile time with the
53 .Fl l
54 option of the compiler.
55 .\" .Pp
56 .\" A subset of the
57 .\" .Xr libc functions
58 .\" are available from Fortran;
59 .\" they are described separately in
60 .\" .Xr intro 3f .
61 .Pp
62 The various libraries (followed by the loader flag):
63 .Bl -tag -width "libc (-lc)"
64 .It Xr libc Pq Fl l Ns Ar c
65 Standard C library functions.
66 .\" (See
67 .\" .Xr libc 3 . )
68 When using the C compiler
69 .Xr cc 1 ,
70 it is not necessary
71 to supply the loader flag
72 .Fl l Ns Ar c
73 for these functions.
74 There are several `libraries' or groups of functions included inside of
75 .Xr libc :
76 the standard
77 .Tn I/O
78 routines,
79 database routines,
80 bit operators,
81 string operators,
82 character tests and character operators,
83 des encryption routines,
84 storage allocation, time functions, signal handling and more.
85 .It Xr libcurses Pq Fl l Ns Ar curses Fl l Ns Ar termcap
86 Terminal independent screen management routines
87 for two dimensional non-bitmap display terminals.
88 (See
89 .Xr ncurses 3 . )
90 .It Xr libcompat Pq Fl l Ns Ar compat
91 Functions which are obsolete but are available for compatibility with
92 .Bx 4.3 .
93 In particular,
94 a number of system call interfaces provided in previous releases of
95 .Bx
96 have been included for source code compatibility.
97 Use of these routines should, for the most part, be avoided.
98 The manual page entry for each compatibility routine
99 indicates the proper interface to use.
100 .It Xr libkvm Pq Fl l Ns Ar kvm
101 Functions used to access kernel memory are in this library.  They can be used
102 against both a running system and a crash dump.
103 (See
104 .Xr kvm 3 . )
105 .It Xr libl Pq Fl l Ns Ar l
106 The library for
107 .Xr lex 1 .
108 .\" .It Xr libln
109 .It Xr libm Pq Fl l Ns Ar m
110 The math library,
111 .Em libm .
112 The math library is loaded as needed by the Pascal compiler,
113 .\" .Xr pc 1 ,
114 but not by the C compiler which requires the
115 .Fl l Ns Ar m
116 flag.
117 (See
118 .Xr math 3 . )
119 .It Xr libmp Pq Fl l Ns Ar mp
120 .\" .It Xr libom
121 .\" Old math library.
122 .\" .It Xr libplot Pq Fl l Ns Ar plot
123 .\" Device independent plotting functions.
124 .\" (See
125 .\" .Xr plot 3 . )
126 .\" .It Xr libplotf77 Pq Fl l Ns Ar plotf77
127 .\" The device independent plotting functions for fortran.
128 .\" (See
129 .\" .Xr plot 3 . )
130 .\" .It Xr libresolv Pq Fl l Ns Ar resolv
131 .\" Routines for network address resolution.
132 .It Xr libtermcap Pq Fl l Ns Ar termcap
133 The terminal independent operation library package.
134 (See
135 .Xr termcap 3 . )
136 .\" .It libvt0.a
137 .It Xr liby Pq Fl l Ns Ar y
138 The library for
139 .Xr yacc 1 .
140 .El
141 .Sh FILES
142 .Bl -tag -width /usr/lib/libm_p.a -compact
143 .It Pa /usr/lib/libc.a
144 the C library
145 .It Pa /usr/lib/libc_p.a
146 the C library compiled for profiling
147 .It Pa /usr/lib/libm.a
148 the math library
149 .It Pa /usr/lib/libm_p.a
150 the math library compiled for profiling
151 .El
152 .Sh SEE ALSO
153 .\" .Xr libc 3 ,
154 .Xr cc 1 ,
155 .Xr ld 1 ,
156 .Xr nm 1 ,
157 .Xr intro 2 ,
158 .Xr math 3 ,
159 .Xr stdio 3
160 .\" .Sh LIST OF FUNCTIONS
161 .\" .Bl -column "strncasecmpxxx" "system"
162 .\" .Sy Name    Description
163 .\" .El
164 .Sh HISTORY
165 An
166 .Nm
167 manual appeared in
168 .At v7 .