[src/trunk]: src/share/man/man3 Rework to describe the plethora of libraries ...

[gmcgarry <gmcgarry%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/5f49800fe725
branches:  trunk
changeset: 517052:5f49800fe725
user:      gmcgarry <gmcgarry%NetBSD.org@localhost>
date:      Tue Nov 06 00:06:21 2001 +0000

description:
Rework to describe the plethora of libraries that arrived with the
introduction of crypto/Kerberos into the base system.

Doesn't have a hope of being complete since there is little (no?)
documentation available on what the libraries actually do, much
less how to use the functions included within them.  It's questionable
whether some of the libraries should exist in the first place.

Does NOT address lib/11191, lib/11171 + others I haven't found yet.

diffstat:

 share/man/man3/intro.3 |  231 ++++++++++++++++++++++++++++++++++++++----------
 1 files changed, 182 insertions(+), 49 deletions(-)

diffs (291 lines):

diff -r 433962f70c32 -r 5f49800fe725 share/man/man3/intro.3
--- a/share/man/man3/intro.3    Mon Nov 05 23:38:55 2001 +0000
+++ b/share/man/man3/intro.3    Tue Nov 06 00:06:21 2001 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: intro.3,v 1.9 2001/09/11 01:18:14 wiz Exp $
+.\"    $NetBSD: intro.3,v 1.10 2001/11/06 00:06:21 gmcgarry Exp $
 .\"
 .\" Copyright (c) 1980, 1991, 1993
 .\"    The Regents of the University of California.  All rights reserved.
@@ -33,17 +33,16 @@
 .\"
 .\"     @(#)intro.3    8.1 (Berkeley) 6/5/93
 .\"
-.Dd June 5, 1993
+.Dd October 4, 2001
 .Dt INTRO 3
 .Os
 .Sh NAME
 .Nm intro
-.Nd introduction to the C libraries
+.Nd introduction to the system libraries
 .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,
+This section provides an overview of the system libraries, their
+functions, error returns and other common definitions and concepts.
+Most of these functions are available from the standard C library,
 .Em libc .
 Other libraries, such as the math library,
 .Em libm ,
@@ -57,51 +56,145 @@
 .\" they are described separately in
 .\" .Xr intro 3f .
 .Pp
-The various libraries (followed by the loader flag):
+The various system libraries supplied in
+.Nx
+(followed by the linker flags) are:
 .Bl -tag -width "libc (-lc)"
+.It Em libasn1 Pq Fl l Ns Ar asn1
+The abstract syntax notation (ASN) library provides routines for the
+specification of abstract data types.
+.It Em libbz2 Pq Fl l Ns Ar bz2
+Block-sorting compressor library providing routines for fast and
+efficient compression.
 .It Em libc Pq Fl l Ns Ar c
-Standard C library functions.
-When using the C compiler
+Standard C library functions.  When using the C compiler
 .Xr cc 1 ,
-it is not necessary
-to supply the loader flag
+it is not necessary to supply the linker flag
 .Fl l Ns Ar c
-for these functions.
-There are several `libraries' or groups of functions included inside of
+for these functions.  There are several subsystems included inside
 .Em libc :
-the standard
-.Tn I/O
-routines, database routines, bit operators, string operators,
-character tests and character operators,
-.Tn DES
-encryption routines,
-storage allocation, time functions, signal handling and more.
+.Pp
+.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 bit_string 3
+.It string operators
+see
+.Xr string 3
+.It character tests and character operators
+.It Tn encryption and hash routines
+see
+.Xr md4 3
+and
+.Xr md5 3 .
+.It storage allocation
+see
+.Xr mpool 3
+and
+.Xr malloc 3
+.It time functions
+see
+.Xr time 3
+.It signal handling
+see
+.Xr signal 3
+.El
+.It Em libcdk Pq Fl l Ns Ar cdk
+Curses development kit (CDK) library.
+.It Em libcom_err Pq Fl l Ns Ar com_err
+.It Em libcompat Pq Fl l Ns Ar compat
+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 indicates the proper interface to use.
+.It Em libcrypt Pq Fl l Ns Ar crypt
+Crypt library functions.  See
+.Xr crypt 3 .
+.It Em libcrypto Pq Fl l Ns Ar crypto
+The OpenSSL cryptographic library routines.  See
+.Xr crypto 3 .
+.It Em libcrypto_idea Pq Fl l Ns Ar crypto_idea
+The OpenSSL cryptographic library routines for the IDEA algorithm.
+This algorithm is separated from libcrypto since the IDEA algorithm is
+protected by patents and its use is restricted.
+.It Em libcrypto_rc5 Pq Fl l Ns Ar crypto_rc5
+The OpenSSL cryptographic library routines for the RC5 algorithm.
+This algorithm is separated from libcrypto since the RC5 algorithm is
+protected by patents and its use is restricted.
 .It Xo
 .Em libcurses
-.Pf ( Fl l Ns Ar curses
+.Pf ( Ns Fl l Ns Ar curses
 .Fl l Ns Ar termcap )
 .Xc
 Terminal independent screen management routines
-for two dimensional non-bitmap display terminals (see
-.Xr curses 3 ) .
-.It Em libcompat Pq Fl l Ns Ar compat
-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
-indicates the proper interface to use.
-.\" .It Em libkvm
+for two dimensional non-bitmap display terminals.  See
+.Xr curses 3 .
+.It Em libdes Pq Fl l Ns Ar des
+The OpenSSL cryptographic library for the DES algorithms.  See
+.Xr des 3 .
+.It Em libedit Pq Fl l Ns Ar edit
+The command-line editor or editline library.  The editline library
+provides generic editing and history functions.  See
+.Xr editline 3 .
+.It Em libform Pq Fl l Ns Ar form
+The curses form library functions provides a terminal-independent form
+system using the curses library.  The form library provides facilities
+for defining forms on terminals.  See
+.Xr forms 3 .
+.It Em libgssapi Pq Fl l Ns Ar gssapi
+The Generic Security Services (GSS) API library.  This library provides
+verification services to applications and usually sits above the
+cryptographic libraries.
+.It Em libhesiod Pq Fl l Ns Ar hesiod
+The Hesiod library functions.  This library provides routines for
+performing lookups of Hesiod information, which is stored as text
+records in the Domain Name Service.  See
+.Xr hesiod 3 .
+.It Em libhdb Pq Fl l Ns Ar hdb
+The Heimdal Kerberos 5 authentication/authorisation database library.
+.It Em libintl Pq Fl l Ns Ar intl
+The internationalized message handling library.  See
+.Xr gettext 3 .
+.It Em libipsec Pq Fl l Ns Ar ipsec
+The IPsec policy control library.  See
+.Xr ipsec_set_policy 3
+and
+.Xr ipsec_strerror 3 .
+.It Em libkadm Pq Fl l Ns Ar kadm
+The Kerberos 4 administration server and client library.
+.It Em libkadm5clnt Pq Fl l Ns Ar kadm5clnt
+The Kerberos 5 administration client library.
+.It Em libkadm5srv Pq Fl l Ns Ar kadm5srv
+The Kerberos 5 administration server library.
+.It Em libkafs Pq Fl l Ns Ar kafs
+The Kerberos AFS library functions.
+.It Em libkdb Pq Fl l Ns Ar kdb
+The Kerberos 4 authentication/authorisation database library.
+.It Em libkrb Pq Fl l Ns Ar krb
+The Kerberos 4 library.
+.It Em libkrb5 Pq Fl l Ns Ar krb5
+The Kerberos 5 library.
+.It Em libkstream Pq Fl l Ns Ar kstream
+Kerberos 4 encrypted stream library.
+.It Em libkvm Pq Fl l Ns Ar kvm
+Kernel data access library.  See
+.Xr kvm 3 .
 .It Em libl Pq Fl l Ns Ar l
 The library for
 .Xr lex 1 .
-.\" .It Em libln
 .It Em libm Pq Fl l Ns Ar m
-The math library,
-.Em libm .
+The math library.  See
+.Xr math 3 .
 .\" The math library is loaded as needed by the Pascal compiler
 .\" .Xr pc 1 ,
 .\" but not by the C compiler which requires the
@@ -119,13 +212,58 @@
 .\" .Xr plot 3 ) .
 .\" .It Em libresolv Pq Fl l Ns Ar resolv
 .\" Routines for network address resolution.
+.It Em libmenu Pq Fl l Ns Ar menu
+The curses menu library.  See
+.Xr menus 3 .
+.It Em libpcap Pq Fl l Ns Ar pcap
+The packet capture library.  See
+.Xr pcap 3 .
+.It Em libpci Pq Fl l Ns Ar pci
+The PCI bus access library.  See
+.Xr pci 3 .
+.It Em libposix Pq Fl l Ns Ar posix
+POSIX compatibility library.
+.It Em libresolv Pq Fl l Ns Ar resolv
+The DNS resolver library.
+.It Em librmt Pq Fl l Ns Ar rmt
+Remote magnetic tap library.  See
+.Xr rmtops 3 .
+.It Em libroken Pq Fl l Ns Ar roken
+A library containing compatibility functions used by Kerberos.  It
+implements functionality required by the Kerberos implementation not
+implemented in the standard
+.Nx
+libraries.
+.It Em librpcsvc Pq Fl l Ns Ar rpcsvc
+The Remote Procedure Call (RPC) services library.  See
+.Xr rpc 3 .
+.It Em libskey Pq Fl l Ns Ar skey
+The S/Key one-time password library.
+.It Em libsl Pq Fl l Ns Ar sl
+.It Em libss Pq Fl l Ns Ar ss
+.It Em libssl Pq Fl l Ns Ar ssl
+The secure sockets layer (SSL) library.  See
+.Xr ssl 3 .
+.It Em libtelnet Pq Fl l Ns Ar telnet
+The telnet library.
 .It Em libtermcap Pq Fl l Ns Ar termcap
-The terminal independent operation library package (see
-.Xr termcap 3 ) .
-.\" .It libvt0.a
+The terminal-independent operation library.  See
+.Xr termcap 3 .
+.It Em libusb Pq Fl l Ns Ar usb
+The Universal Serial Bus (USB) access library.  See
+.Xr usb 3 .
+.It Em libutil Pq Fl l Ns Ar util
+The system utilities library.  See
+.Xr opendisk 3 ,
+etc.
+.It Em libwrap Pq Fl l Ns Ar wrap
+The TCP wrappers library.  See
+.Xr host_access 3 .
 .It Em liby Pq Fl l Ns Ar y
 The library for
 .Xr yacc 1 .
+.It Em libz Pq Fl l Ns Ar z
+General-purpose compression library.
 .El
 .Sh FILES
 .Bl -tag -width /usr/lib/libm_p.a -compact
@@ -142,15 +280,10 @@
 .Xr cc 1 ,
 .Xr ld 1 ,
 .Xr nm 1 ,
-.Xr intro 2 ,
-.Xr math 3 ,
-.Xr stdio 3
-.\" .Sh LIST OF FUNCTIONS
-.\" .Bl -column "strncasecmpxxx" "system"
-.\" .Sy Name   Description
-.\" .El
+.Xr rtld 1 ,
+.Xr intro 2
 .Sh HISTORY
 An
 .Nm intro
 manual appeared in
-.At v7 .
+.At v7 .
\ No newline at end of file