Initial revision

3 files changed, 289 insertions, 0 deletions

diff --git a/man/man8/accessdb.man8 b/man/man8/accessdb.man8
new file mode 100644
index 00000000..431a7fa7
--- /dev/null
+++ b/man/man8/accessdb.man8
@@ -0,0 +1,44 @@
+.\" Man page for accessdb
+.\"
+.\" Copyright (c) 1998 Fabrizio Polacco <fpolacco@debian.org
+.\"
+.\" You may distribute under the terms of the GNU General Public
+.\" License as specified in the file COPYING that comes with the
+.\" man_db distribution.
+.\"
+.\" Tue, 24 Feb 1998 18:18:36 +0200
+.\" 
+.TH accessdb 8 "%date%" "%version%" "Manual pager utils"
+.SH NAME
+accessdb \- dumps the content of a man-db database in a human readable
+format.
+.SH SYNOPSIS
+.B /usr/sbin/accessdb 
+.RI [ <index-file> ]
+.SH DESCRIPTION
+.B accessdb 
+will output the data contained within a man_db database in a
+human  readable form. By default, it will dump the data from
+.B /var/catman/index.<db-type>,
+where <db-type> is dependent on the database library in use.
+
+Supplying   an  argument  to  accessdb  will  override  this
+default.
+
+.nf
+$mtime$ -> "795987034"
+$version$ -> "2.3.1"
+apropos -> "1 1 795981542 A - - search the manual page names and descriptions"
+catman -> "8 8 795981544 A - - create or update the pre-formatted manual pages"
+man -> "1 1 795981542 A - - an interface to the on-line reference manuals"
+mandb -> "8 8 795981544 A - - create or update the manual page index caches"
+manpath -> " 1 5"
+manpath~1 -> "1 1 795981542 A - - determine search path for manual pages"
+manpath~5 -> "5 5 795981543 A - - format of the /etc/man_db.config file"
+whatis -> "1 1 795981543 A - - search the manual page names"
+zsoelim -> "1 1 795981543 A - - satisfy .so requests in roff input"
+.fi
+
+.SH AUTHOR
+Wilf. (G.Wilford@ee.surrey.ac.uk).
+Fabrizio Polacco (fpolacco@debian.org).
diff --git a/man/man8/catman.man8 b/man/man8/catman.man8
new file mode 100644
index 00000000..b5410b55
--- /dev/null
+++ b/man/man8/catman.man8
@@ -0,0 +1,100 @@
+.\" Man page for catman
+.\"
+.\" Copyright (C), 1994, 1995, Graeme W. Wilford. (Wilf.)
+.\"
+.\" You may distribute under the terms of the GNU General Public
+.\" License as specified in the file COPYING that comes with the
+.\" man_db distribution.
+.\"
+.\" Sat Dec 10 14:17:29 GMT 1994  Wilf. (G.Wilford@ee.surrey.ac.uk) 
+.\" 
+.TH %catman% 8 "%date%" "%version%" "Manual pager utils"
+.SH NAME
+%catman% \- create or update the pre-formatted manual pages
+.SH SYNOPSIS
+.B %catman% 
+.RB [\| \-dhV \|] 
+.RB [\| \-M 
+.IR path \|] 
+.RI [\| section \|]
+\&.\|.\|.
+.SH DESCRIPTION
+.B %catman%
+is used to create an up to date set of pre-formatted manual pages known as
+cat pages. 
+Cat pages are generally much faster to display than the original
+manual pages, but require extra storage space. The decision to
+support cat pages is that of the local administrator, who must provide
+suitable directories to contain them.
+
+The options available to
+.B %catman%
+are the manual page hierarchies and sections to pre-format. The
+default hierarchies are those specified as `global' in the man_db 
+configuration file and the default sections are either 
+the colon delimited contents of the environment variable
+.RB $ MANSECT
+or the standard set compiled into 
+.B %man%
+if 
+.RB $ MANSECT
+is undefined. Supplying
+.B %catman%
+with a set of whitespace delimited section names will override both of
+the above.
+
+.B %catman%
+makes use of the
+.B index
+database cache associated with each hierarchy to determine which files 
+need to be formatted.
+.SH OPTIONS
+.TP
+.B \-d, \-\-debug
+Print debugging information.
+.TP
+.BI \-M\  path ,\ \-\-manpath= path
+Specify an alternate colon delimited manual page hierarchy search path. 
+By default, this is all paths indicated as `global'
+in the man_db configuration file.
+.TP
+.B \-h, \-\-help
+Print a help message and exit.
+.TP
+.B \-V, \-\-version
+Display version and author information.
+.SH ENVIRONMENT
+.TP
+.B MANSECT
+If
+.RB $ MANSECT
+is set, its value is a colon delimited list of sections and it is used to
+determine which manual sections to search and in what order.
+.TP
+.B MANPATH
+If
+.RB $ MANPATH
+is set, its value is interpreted as the colon delimited, manual page
+hierarchy search path to use.
+.SH FILES
+.TP
+.I %manpath_config_file%
+man_db configuration file.
+.TP
+.I /usr/man/index.(bt|db|dir|pag)
+A traditional global
+.I index
+database cache.
+.TP
+.I /var/catman/index.(bt|db|dir|pag)
+An alternate or FSSTND
+compliant global
+.I index
+database cache.
+.SH "SEE ALSO"
+.BR %man% (1),
+.BR manpath (5), 
+.BR %mandb% (8).
+.SH AUTHOR
+Wilf. (G.Wilford@ee.surrey.ac.uk).
+Fabrizio Polacco (fpolacco@debian.org).
diff --git a/man/man8/mandb.man8 b/man/man8/mandb.man8
new file mode 100644
index 00000000..6a2cfa3e
--- /dev/null
+++ b/man/man8/mandb.man8
@@ -0,0 +1,145 @@
+'\" t
+.\" Man page for mandb
+.\"
+.\" Copyright (C), 1994, 1995, Graeme W. Wilford. (Wilf.)
+.\"
+.\" You may distribute under the terms of the GNU General Public
+.\" License as specified in the file COPYING that comes with the
+.\" man_db distribution.
+.\" 
+.\" Tue Apr 26 12:56:44 BST 1994  Wilf. (G.Wilford@ee.surrey.ac.uk) 
+.\"
+.TH %mandb% 8 "%date%" "%version%" "Manual pager utils"
+.SH NAME
+%mandb% \- create or update the manual page index caches
+.SH SYNOPSIS
+.B %mandb%  
+.RB [\| \-dqsuc \||\| \-h \||\| \-V\c
+.RI "\|] [\|" manpath \|] 
+.SH DESCRIPTION
+.B %mandb%
+is used to initialise or manually update
+.B index 
+database caches that are usually maintained by 
+.BR %man% .
+The caches contain information relevant to the current state of the manual
+page system and the information stored within them is used by the man_db 
+utilities to enhance their speed and functionality.
+
+When creating or updating an
+.BR index ,
+.B %mandb%
+will warn of bad ROFF .so requests, bogus manual page filenames and 
+manual pages from which the 
+.B whatis 
+cannot be parsed.
+
+Supplying 
+.B %mandb% 
+with an optional colon delimited path will override the internal `global'
+manual page hierarchy search path, determined from information found within 
+the man_db configuration file.
+.SH "DATABASE CACHES"
+.B %mandb%
+can be compiled with support for any one of the following database types.
+
+.TS
+tab (@);
+l l l l.
+Name@Type@Async@Filename
+_
+Berkeley db@Binary tree@Yes@\fIindex.bt\fR
+GNU gdbm v >= 1.6@Hashed@Yes@\fIindex.db\fR
+GNU gdbm v <  1.6@Hashed@No@\fIindex.db\fR
+UNIX ndbm@Hashed@No@\fIindex.(dir|pag)\fR
+.TE
+
+Those database types that support asynchronous updates provide enhanced
+speed at the cost of possible corruption in the event of unusual
+termination.
+In an unusual case where this has occured, it may be necessary to rerun 
+.B %mandb% 
+with the 
+.B \-c
+option to re-create the databases from scratch. 
+.SH OPTIONS
+.TP
+.B \-d, \-\-debug
+Produce debugging information.
+.TP
+.B \-q, \-\-quiet
+Produce no warnings.
+.TP
+.B \-s, \-\-no-straycats
+Do not spend time looking for or adding information to the databases
+regarding stray cats.
+.TP
+.B \-c, \-\-create
+By default, 
+.B %mandb%
+will try to update any previously created databases. If a database
+does not exist, it will create it. This option forces 
+.B %mandb%
+to delete previous databases and re-create them from scratch. This may be
+necessary if a database becomes corrupt or if a new database storage scheme
+is introduced in the future.
+.TP
+.B \-u, \-\-user-db
+Create user databases only, even with write permissions necessary to create
+`global' databases.
+.TP
+.B \-h, \-\-help
+Show the usage message, then exit.
+.TP
+.B \-V, \-\-version
+Show the version, then exit.
+.SH DIAGNOSTICS
+The following warning messages can be emitted during database building.
+.TP 
+.B <filename>: whatis parse for page(sec) failed
+An attempt to extract whatis line(s) from the given
+<filename> failed.  This is usually due to a poorly written manual
+page, but if many such messages are emitted it is likely that the
+system contains non-standard manual pages which are incompatible with
+the man_db whatis parser.
+.TP
+.B <filename>: is a dangling symlink
+<filename> does not exist but is referenced by a symbolic link. 
+Further diagnostics are usually emitted to identify the <filename> of the
+offending link. 
+.TP
+.B <filename>: bad symlink or ROFF `.so' request
+<filename> is either a symbolic link to, or contains a ROFF include
+request to, a non existent file.
+.TP
+.B <filename>: ignoring bogus filename
+The <filename> may or may not be a valid manual page but its name is
+invalid.  This is usually due to a manual page with sectional extension <x>
+being put in manual page section <y>. 
+.TP
+.B <filename_mask>: competing extensions
+The wildcard <filename_mask> is not unique.  This is usually caused by
+the existance of both a compressed and uncompressed version of the same
+manual page.  All but the most recent are ignored.
+.SH FILES
+.TP
+.I %manpath_config_file%
+man_db configuration file.
+.TP
+.I /usr/man/index.(bt|db|dir|pag)
+A traditional global
+.I index
+database cache.
+.TP
+.I /var/catman/index.(bt|db|dir|pag)
+An alternate or FSSTND
+compliant global
+.I index
+database cache.
+.SH "SEE ALSO"
+.BR %man% (1), 
+.BR manpath (5),
+.BR %catman% (8).
+.SH AUTHOR
+Wilf. (G.Wilford@ee.surrey.ac.uk).
+Fabrizio Polacco (fpolacco@debian.org).