195 lines
4.3 KiB
HTML
195 lines
4.3 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of CATMAN</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>CATMAN</H1>
|
|
Section: Manual pager utils (8)<BR>Updated: 2020-02-25<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
catman - create or update the pre-formatted manual pages
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<B>catman</B>
|
|
|
|
[<B>-d?V</B>]
|
|
|
|
[<B>-M</B>
|
|
|
|
<I>path</I>]
|
|
|
|
[<B>-C</B>
|
|
|
|
<I>file</I>]
|
|
|
|
[<I>section</I>]
|
|
|
|
...
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<B>catman</B>
|
|
|
|
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.
|
|
<P>
|
|
The options available to
|
|
<B>catman</B>
|
|
|
|
are the manual page hierarchies and sections to pre-format.
|
|
The default hierarchies are those specified as system hierarchies in the
|
|
man-db configuration file, and the default sections are either the
|
|
colon-delimited contents of the environment variable
|
|
$<B>MANSECT</B>
|
|
|
|
or the standard set compiled into
|
|
<B>man</B>
|
|
|
|
if
|
|
$<B>MANSECT</B>
|
|
|
|
is undefined.
|
|
Supplying
|
|
<B>catman</B>
|
|
|
|
with a set of whitespace-delimited section names will override both of
|
|
the above.
|
|
<P>
|
|
<B>catman</B>
|
|
|
|
makes use of the
|
|
<B>index</B>
|
|
|
|
database cache associated with each hierarchy to determine which files
|
|
need to be formatted.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B>-d</B>, <B>--debug</B>
|
|
|
|
<DD>
|
|
Print debugging information.
|
|
<DT id="2"><B>-M </B><I>path</I><B></B>, <B>--manpath=</B><I>path</I>
|
|
|
|
<DD>
|
|
Specify an alternate colon-delimited manual page hierarchy search path.
|
|
By default, this is all paths indicated as system hierarchies
|
|
in the man-db configuration file.
|
|
<DT id="3"><B>-C </B><I>file</I><B></B>, <B>--config-file=</B><I>file</I>
|
|
|
|
<DD>
|
|
Use this user configuration file rather than the default of
|
|
<I>~/.manpath</I>.
|
|
|
|
<DT id="4"><B>-?</B>, <B>--help</B>
|
|
|
|
<DD>
|
|
Print a help message and exit.
|
|
<DT id="5"><B>--usage</B>
|
|
|
|
<DD>
|
|
Print a short usage message and exit.
|
|
<DT id="6"><B>-V</B>, <B>--version</B>
|
|
|
|
<DD>
|
|
Display version information.
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>ENVIRONMENT</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="7"><B>MANSECT</B>
|
|
|
|
<DD>
|
|
If
|
|
$<B>MANSECT</B>
|
|
|
|
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.
|
|
The default is "1 n l 8 3 2 3posix 3pm 3perl 3am 5 4 9 6 7", unless overridden by the
|
|
<B>SECTION</B>
|
|
|
|
directive in
|
|
<I>/etc/manpath.config</I>.
|
|
|
|
<DT id="8"><B>MANPATH</B>
|
|
|
|
<DD>
|
|
If
|
|
$<B>MANPATH</B>
|
|
|
|
is set, its value is interpreted as the colon-delimited manual page
|
|
hierarchy search path to use.
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>FILES</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="9"><I>/etc/manpath.config</I>
|
|
|
|
<DD>
|
|
man-db configuration file.
|
|
<DT id="10"><I>/usr/man/index.(bt|db|dir|pag)</I>
|
|
|
|
<DD>
|
|
A traditional global
|
|
<I>index</I>
|
|
|
|
database cache.
|
|
<DT id="11"><I>/var/catman/index.(bt|db|dir|pag)</I>
|
|
|
|
<DD>
|
|
An alternate or FSSTND
|
|
compliant global
|
|
<I>index</I>
|
|
|
|
database cache.
|
|
</DL>
|
|
<A NAME="lbAH"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+man">man</A></B>(1),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?5+manpath">manpath</A></B>(5),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?8+mandb">mandb</A></B>(8)
|
|
|
|
<A NAME="lbAI"> </A>
|
|
<H2>AUTHOR</H2>
|
|
|
|
<PRE>
|
|
Wilf. (<A HREF="mailto:G.Wilford@ee.surrey.ac.uk">G.Wilford@ee.surrey.ac.uk</A>).
|
|
Fabrizio Polacco (<A HREF="mailto:fpolacco@debian.org">fpolacco@debian.org</A>).
|
|
Colin Watson (<A HREF="mailto:cjwatson@debian.org">cjwatson@debian.org</A>).
|
|
</PRE>
|
|
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="12"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="13"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="14"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="15"><A HREF="#lbAE">OPTIONS</A><DD>
|
|
<DT id="16"><A HREF="#lbAF">ENVIRONMENT</A><DD>
|
|
<DT id="17"><A HREF="#lbAG">FILES</A><DD>
|
|
<DT id="18"><A HREF="#lbAH">SEE ALSO</A><DD>
|
|
<DT id="19"><A HREF="#lbAI">AUTHOR</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:06:11 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|