d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
57976b7af3
freebsd-dev/share/man/man3/intro.3

255 lines
6.4 KiB
Groff
Raw Normal View History

BSD 4.4 Lite Share Sources
1994-05-30 19:09:18 +00:00
.\" 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.
multiple: Remove 3rd clause from BSD license where approved by the regents and renumber. This patch skips files in contrib/ and crypto/ Acked by: imp Discussed with: emaste
2014-03-14 03:07:51 +00:00
.\" 3. Neither the name of the University nor the names of its contributors
BSD 4.4 Lite Share Sources
1994-05-30 19:09:18 +00:00
.\" 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
$Id$ -> $FreeBSD$
1999-08-28 00:22:10 +00:00
.\" $FreeBSD$
BSD 4.4 Lite Share Sources
1994-05-30 19:09:18 +00:00
.\"
intro(3): Update the list of included libraries - Extend the list of main libraries of section 3 - Extend the library functions that are included in the libc MFC after: 2 weeks Submitted by: Naga Chaitanya Vellanki <pnagato at protonmail dot com> Approved by: gbe Differential Revision: https://reviews.freebsd.org/D26476
2020-10-06 10:51:47 +00:00
.Dd October 6, 2020
BSD 4.4 Lite Share Sources
1994-05-30 19:09:18 +00:00
.Dt INTRO 3
mdoc(7) police: removed HISTORY info from the .Os call.
2001-07-10 15:31:11 +00:00
.Os
BSD 4.4 Lite Share Sources
1994-05-30 19:09:18 +00:00
.Sh NAME
.Nm intro
.Nd introduction to the C libraries
intro(3): Update the list of included libraries - Extend the list of main libraries of section 3 - Extend the library functions that are included in the libc MFC after: 2 weeks Submitted by: Naga Chaitanya Vellanki <pnagato at protonmail dot com> Approved by: gbe Differential Revision: https://reviews.freebsd.org/D26476
2020-10-06 10:51:47 +00:00
.Sh SYNOPSIS
.Nm cc
.Op Ar flags
.Ar
.Op Fl llibrary
BSD 4.4 Lite Share Sources
1994-05-30 19:09:18 +00:00
.Sh DESCRIPTION
This section provides 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,
Bring intro(3) a bit closer to reality: 1) comment out xref to non-existant libc(3) 2) comment out reference to Fortran specific section (3f) 3) add libkvm with reference to kvm(3) 4) comment out xref to non-existant pc(1) 5) comment out libplot and libplotf77 6) fix problem with -ltermcap not being parenthesized 7) sort files listing still missing most of the libraries that exist in /usr/lib. Closes PR#1151
1997-02-17 08:30:16 +00:00
.Em libc .
BSD 4.4 Lite Share Sources
1994-05-30 19:09:18 +00:00
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):
intro(3): Update the list of included libraries - Extend the list of main libraries of section 3 - Extend the library functions that are included in the libc MFC after: 2 weeks Submitted by: Naga Chaitanya Vellanki <pnagato at protonmail dot com> Approved by: gbe Differential Revision: https://reviews.freebsd.org/D26476
2020-10-06 10:51:47 +00:00
.Bl -tag -width "libbluetooth (-lbluetooth)"
.It Em libbluetooth Pq Fl l Ns Ar bluetooth
The bluetooth library.
See
.Xr bluetooth 3 .
intro(3): fix markup - Use `Em` with `.It` macro when referring to other libraries, instead of `Xr`. - Use `.Em` instead of `.Xr` when referring to libraries. - Remove commented out lines. MFC after: 1 month Reported by: make manlint Sponsored by: Dell EMC Isilon
2017-03-23 05:26:44 +00:00
.It Em libc Pq Fl l Ns Ar c
Bring intro(3) a bit closer to reality: 1) comment out xref to non-existant libc(3) 2) comment out reference to Fortran specific section (3f) 3) add libkvm with reference to kvm(3) 4) comment out xref to non-existant pc(1) 5) comment out libplot and libplotf77 6) fix problem with -ltermcap not being parenthesized 7) sort files listing still missing most of the libraries that exist in /usr/lib. Closes PR#1151
1997-02-17 08:30:16 +00:00
Standard C library functions.
When using the C compiler
BSD 4.4 Lite Share Sources
1994-05-30 19:09:18 +00:00
.Xr cc 1 ,
it is not necessary
to supply the loader flag
.Fl l Ns Ar c
for these functions.
There are several `libraries' or groups of functions included inside of
intro(3): Update the list of included libraries - Extend the list of main libraries of section 3 - Extend the library functions that are included in the libc MFC after: 2 weeks Submitted by: Naga Chaitanya Vellanki <pnagato at protonmail dot com> Approved by: gbe Differential Revision: https://reviews.freebsd.org/D26476
2020-10-06 10:51:47 +00:00
.Em libc :
.Bl -tag -width "XXXXXX"
.It standard I/O routines
see
.Xr stdio 3
.It database routines
see
.Xr db 3
.It bit operators
see
.Xr bitstring 3
.It string operators
see
.Xr string 3
.It character tests and character operators
.It storage allocation
see
.Xr mpool 3
.It regular-expressions
see
.Xr regex 3
.It remote procedure calls (RPC)
see
.Xr rpc 3
.It time functions
see
.Xr time 3
.It signal handling
see
.Xr signal 3
.El
.It Em libcalendar Pq Fl l Ns Ar calendar
The calendar arithmetic library.
See
.Xr calendar 3 .
.It Em libcam Pq Fl l Ns Ar cam
The common access method user library.
See
.Xr cam 3 .
.It Em libcrypt Pq Fl l Ns Ar crypt
The crypt library.
See
.Xr crypt 3 .
intro(3): fix markup - Use `Em` with `.It` macro when referring to other libraries, instead of `Xr`. - Use `.Em` instead of `.Xr` when referring to libraries. - Remove commented out lines. MFC after: 1 month Reported by: make manlint Sponsored by: Dell EMC Isilon
2017-03-23 05:26:44 +00:00
.It Em libcurses Pq Fl l Ns Ar curses Fl l Ns Ar termcap
BSD 4.4 Lite Share Sources
1994-05-30 19:09:18 +00:00
Terminal independent screen management routines
for two dimensional non-bitmap display terminals.
intro(3): Update the list of included libraries - Extend the list of main libraries of section 3 - Extend the library functions that are included in the libc MFC after: 2 weeks Submitted by: Naga Chaitanya Vellanki <pnagato at protonmail dot com> Approved by: gbe Differential Revision: https://reviews.freebsd.org/D26476
2020-10-06 10:51:47 +00:00
See
.Xr ncurses 3 .
.It Em libcuse Pq Fl l Ns Ar cuse
The userland character device library.
See
.Xr cuse 3 .
intro(3): fix markup - Use `Em` with `.It` macro when referring to other libraries, instead of `Xr`. - Use `.Em` instead of `.Xr` when referring to libraries. - Remove commented out lines. MFC after: 1 month Reported by: make manlint Sponsored by: Dell EMC Isilon
2017-03-23 05:26:44 +00:00
.It Em libcompat Pq Fl l Ns Ar compat
BSD 4.4 Lite Share Sources
1994-05-30 19:09:18 +00:00
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
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days
2001-07-14 19:41:16 +00:00
indicates the proper interface to use.
intro(3): Update the list of included libraries - Extend the list of main libraries of section 3 - Extend the library functions that are included in the libc MFC after: 2 weeks Submitted by: Naga Chaitanya Vellanki <pnagato at protonmail dot com> Approved by: gbe Differential Revision: https://reviews.freebsd.org/D26476
2020-10-06 10:51:47 +00:00
.It Em libdevinfo Pq Fl l Ns Ar devinfo
The Device and Resource Information Utility library.
See
.Xr devinfo 3 .
.It Em libdevstat Pq Fl l Ns Ar devstat
The Device Statistics library.
See
.Xr devstat 3 .
.It Em libdwarf Pq Fl l Ns Ar dwarf
The DWARF access library.
See
.Xr dwarf 3 .
.It Em libelf Pq Fl l Ns Ar elf
The ELF access library.
See
.Xr elf 3 .
.It Em libfetch Pq Fl l Ns Ar fetch
The file transfer library.
See
.Xr fetch 3 .
.It Em libfigpar Pq Fl l Ns Ar figpar
The configuration file parsing library.
See
.Xr figpar 3 .
.It Em libgpio Pq Fl l Ns Ar gpio
The general-purpose input output library (GPIO).
See
.Xr gpio 3 .
.It Em libgssapi Pq Fl l Ns Ar gssapi
The generic security service application programming
interface.
See
.Xr gssapi 3 .
.It Em libjail Pq Fl l Ns Ar jail
The jail library.
See
.Xr jail 3 .
intro(3): fix markup - Use `Em` with `.It` macro when referring to other libraries, instead of `Xr`. - Use `.Em` instead of `.Xr` when referring to libraries. - Remove commented out lines. MFC after: 1 month Reported by: make manlint Sponsored by: Dell EMC Isilon
2017-03-23 05:26:44 +00:00
.It Em libkvm Pq Fl l Ns Ar kvm
Mechanically kill hard sentence breaks and double whitespaces.
2004-07-03 18:29:24 +00:00
Functions used to access kernel memory are in this library.
They can be used
Bring intro(3) a bit closer to reality: 1) comment out xref to non-existant libc(3) 2) comment out reference to Fortran specific section (3f) 3) add libkvm with reference to kvm(3) 4) comment out xref to non-existant pc(1) 5) comment out libplot and libplotf77 6) fix problem with -ltermcap not being parenthesized 7) sort files listing still missing most of the libraries that exist in /usr/lib. Closes PR#1151
1997-02-17 08:30:16 +00:00
against both a running system and a crash dump.
intro(3): Update the list of included libraries - Extend the list of main libraries of section 3 - Extend the library functions that are included in the libc MFC after: 2 weeks Submitted by: Naga Chaitanya Vellanki <pnagato at protonmail dot com> Approved by: gbe Differential Revision: https://reviews.freebsd.org/D26476
2020-10-06 10:51:47 +00:00
See
.Xr kvm 3 .
intro(3): fix markup - Use `Em` with `.It` macro when referring to other libraries, instead of `Xr`. - Use `.Em` instead of `.Xr` when referring to libraries. - Remove commented out lines. MFC after: 1 month Reported by: make manlint Sponsored by: Dell EMC Isilon
2017-03-23 05:26:44 +00:00
.It Em libl Pq Fl l Ns Ar l
BSD 4.4 Lite Share Sources
1994-05-30 19:09:18 +00:00
The library for
.Xr lex 1 .
intro(3): fix markup - Use `Em` with `.It` macro when referring to other libraries, instead of `Xr`. - Use `.Em` instead of `.Xr` when referring to libraries. - Remove commented out lines. MFC after: 1 month Reported by: make manlint Sponsored by: Dell EMC Isilon
2017-03-23 05:26:44 +00:00
.It Em libm Pq Fl l Ns Ar m
intro(3): Update the list of included libraries - Extend the list of main libraries of section 3 - Extend the library functions that are included in the libc MFC after: 2 weeks Submitted by: Naga Chaitanya Vellanki <pnagato at protonmail dot com> Approved by: gbe Differential Revision: https://reviews.freebsd.org/D26476
2020-10-06 10:51:47 +00:00
The math library.
See
.Xr math 3 .
.It Em libmd Pq Fl l Ns Ar md
The message digest library.
See
.Xr md4 3 ,
.Xr md5 3 ,
.Xr sha 3 ,
.Xr sha256 3 ,
.Xr sha512 3 ,
.Xr ripemd 3 ,
.Xr skein 3 .
intro(3): fix markup - Use `Em` with `.It` macro when referring to other libraries, instead of `Xr`. - Use `.Em` instead of `.Xr` when referring to libraries. - Remove commented out lines. MFC after: 1 month Reported by: make manlint Sponsored by: Dell EMC Isilon
2017-03-23 05:26:44 +00:00
.It Em libmp Pq Fl l Ns Ar mp
intro(3): Update the list of included libraries - Extend the list of main libraries of section 3 - Extend the library functions that are included in the libc MFC after: 2 weeks Submitted by: Naga Chaitanya Vellanki <pnagato at protonmail dot com> Approved by: gbe Differential Revision: https://reviews.freebsd.org/D26476
2020-10-06 10:51:47 +00:00
.It Em libpam Pq Fl l Ns Ar pam
The pluggable authentication module library.
See
.Xr pam 3 .
.It Em libpcap Pq Fl l Ns Ar pcap
The packet capture library.
See
.Xr pcap 3 .
.It Em libpmc Pq Fl l Ns Ar pmc
The performance counters library.
See
.Xr pmc 3 .
.It Em libpthread Pq Fl l Ns Ar pthread
The POSIX threads library.
See
.Xr pthread 3 .
.It Em libsysdecode Pq Fl l Ns Ar sysdecode
The system argument decoding library.
See
.Xr sysdecode 3 .
intro(3): fix markup - Use `Em` with `.It` macro when referring to other libraries, instead of `Xr`. - Use `.Em` instead of `.Xr` when referring to libraries. - Remove commented out lines. MFC after: 1 month Reported by: make manlint Sponsored by: Dell EMC Isilon
2017-03-23 05:26:44 +00:00
.It Em libtermcap Pq Fl l Ns Ar termcap
Remove more single-space hard sentence breaks.
2000-03-02 14:54:02 +00:00
The terminal independent operation library package.
intro(3): Update the list of included libraries - Extend the list of main libraries of section 3 - Extend the library functions that are included in the libc MFC after: 2 weeks Submitted by: Naga Chaitanya Vellanki <pnagato at protonmail dot com> Approved by: gbe Differential Revision: https://reviews.freebsd.org/D26476
2020-10-06 10:51:47 +00:00
See
.Xr termcap 3 .
.It Em libusb Pq Fl l Ns Ar usb
The USB access library.
See
.Xr usb 3 .
.It Em libvgl Pq Fl l Ns Ar vgl
The video graphics library.
See
.Xr vgl 3 .
intro(3): fix markup - Use `Em` with `.It` macro when referring to other libraries, instead of `Xr`. - Use `.Em` instead of `.Xr` when referring to libraries. - Remove commented out lines. MFC after: 1 month Reported by: make manlint Sponsored by: Dell EMC Isilon
2017-03-23 05:26:44 +00:00
.It Em liby Pq Fl l Ns Ar y
BSD 4.4 Lite Share Sources
1994-05-30 19:09:18 +00:00
The library for
.Xr yacc 1 .
intro(3): Update the list of included libraries - Extend the list of main libraries of section 3 - Extend the library functions that are included in the libc MFC after: 2 weeks Submitted by: Naga Chaitanya Vellanki <pnagato at protonmail dot com> Approved by: gbe Differential Revision: https://reviews.freebsd.org/D26476
2020-10-06 10:51:47 +00:00
.It Em libz Pq Fl l Ns Ar z
The general-purpose data compression library.
See
.Xr zlib 3 .
BSD 4.4 Lite Share Sources
1994-05-30 19:09:18 +00:00
.El
.Sh FILES
.Bl -tag -width /usr/lib/libm_p.a -compact
.It Pa /usr/lib/libc.a
the C library
.It Pa /usr/lib/libc_p.a
the C library compiled for profiling
Bring intro(3) a bit closer to reality: 1) comment out xref to non-existant libc(3) 2) comment out reference to Fortran specific section (3f) 3) add libkvm with reference to kvm(3) 4) comment out xref to non-existant pc(1) 5) comment out libplot and libplotf77 6) fix problem with -ltermcap not being parenthesized 7) sort files listing still missing most of the libraries that exist in /usr/lib. Closes PR#1151
1997-02-17 08:30:16 +00:00
.It Pa /usr/lib/libm.a
the math library
BSD 4.4 Lite Share Sources
1994-05-30 19:09:18 +00:00
.It Pa /usr/lib/libm_p.a
the math library compiled for profiling
.El
.Sh SEE ALSO
.Xr cc 1 ,
.Xr ld 1 ,
Sort cross references.
1997-01-13 00:25:51 +00:00
.Xr nm 1 ,
.Xr intro 2 ,
.Xr math 3 ,
.Xr stdio 3
BSD 4.4 Lite Share Sources
1994-05-30 19:09:18 +00:00
.Sh HISTORY
An
mdoc(7) police: use the new features of the Nm macro.
2000-11-20 18:41:33 +00:00
.Nm
BSD 4.4 Lite Share Sources
1994-05-30 19:09:18 +00:00
manual appeared in
.At v7 .
Reference in New Issue Copy Permalink