]> git.saurik.com Git - apple/libc.git/blob - gen/intro.3
Libc-594.1.4.tar.gz
[apple/libc.git] / gen / 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.14 2001/08/07 15:48:38 ru Exp $
34 .\"
35 .Dd Aug 17, 2006
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 System library,
46 .Em libSystem .
47 Other libraries
48 must be indicated at compile time with the
49 .Fl l
50 option of the compiler.
51 .Pp
52 The various libraries (followed by the loader flag):
53 .Bl -tag -width "libSystem (-lSystem)"
54 .It Xr libSystem Pq Fl l Ns Ar System
55 Standard C library functions.
56 When using the C compiler
57 .Xr cc 1 ,
58 it is not necessary
59 to supply the loader flag
60 .Fl l Ns Ar System
61 for these functions.
62 There are several `libraries' or groups of functions included inside of
63 .Xr libSystem :
64 the standard
65 .Tn I/O
66 routines,
67 database routines,
68 bit operators,
69 string operators,
70 character tests and character operators,
71 des encryption routines,
72 storage allocation, time functions, signal handling and more.
73 .Pp
74 For compatibility with other systems, which provide these capabilities in
75 separate libraries (such as
76 .Xr libc ) ,
77 symbolic links are provided for
78 .Fl l Ns Ar c ,
79 .Fl l Ns Ar dbm ,
80 .Fl l Ns Ar dl ,
81 .Fl l Ns Ar info ,
82 .Fl l Ns Ar m ,
83 .Fl l Ns Ar poll ,
84 .Fl l Ns Ar pthread
85 and
86 .Fl l Ns Ar rpcsvc ;
87 they all point to
88 .Xr libSystem .
89 .It Xr libcurses Pq Fl l Ns Ar curses Fl l Ns Ar termcap
90 Terminal independent screen management routines
91 for two dimensional non-bitmap display terminals.
92 (See
93 .Xr ncurses 3 . )
94 .It Xr libl Pq Fl l Ns Ar l
95 The library for
96 .Xr lex 1 .
97 .It Xr libtermcap Pq Fl l Ns Ar termcap
98 The terminal independent operation library package.
99 (See
100 .Xr termcap 3 . )
101 .\" .It libvt0.a
102 .It Xr liby Pq Fl l Ns Ar y
103 The library for
104 .Xr yacc 1 .
105 .El
106 .Sh FILES
107 .Bl -tag -width /usr/lib/libSystem_profile.dylib -compact
108 .It Pa /usr/lib/libSystem.dylib
109 the main System library
110 .It Pa /usr/lib/libSystem_debug.dylib
111 the main System library compiled with debug support
112 .It Pa /usr/lib/libSystem_profile.dylib
113 the main System library compiled for profiling
114 .El
115 .Sh SEE ALSO
116 .\" .Xr libc 3 ,
117 .Xr cc 1 ,
118 .Xr ld 1 ,
119 .Xr nm 1 ,
120 .Xr intro 2 ,
121 .Xr stdio 3
122 .\" .Sh LIST OF FUNCTIONS
123 .\" .Bl -column "strncasecmpxxx" "system"
124 .\" .Sy Name Description
125 .\" .El
126 .Sh HISTORY
127 An
128 .Nm
129 manual appeared in
130 .At v7 .