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