245 lines
5.7 KiB
HTML
245 lines
5.7 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of MANPATH</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>MANPATH</H1>
|
|
Section: /etc/manpath.config (5)<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>
|
|
|
|
manpath - format of the /etc/manpath.config file
|
|
<A NAME="lbAC"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
The manpath configuration file is used by the manual page utilities
|
|
to assess users' manpaths at run time, to indicate which manual page
|
|
hierarchies (manpaths) are to be treated as system hierarchies and to
|
|
assign them directories to be used for storing cat files.
|
|
<P>
|
|
If the environment variable
|
|
$<B>MANPATH</B>
|
|
|
|
is already set, the information contained within /etc/manpath.config will
|
|
not override it.
|
|
<A NAME="lbAD"> </A>
|
|
<H2>FORMAT</H2>
|
|
|
|
The following field types are currently recognised:
|
|
<DL COMPACT>
|
|
<DT id="1"><B>#</B><I> comment</I>
|
|
|
|
<DD>
|
|
Blank lines or those beginning with a
|
|
<B>#</B>
|
|
|
|
will be treated as comments and ignored.
|
|
<DT id="2"><B>MANDATORY_MANPATH</B><I> manpath_element</I>
|
|
|
|
<DD>
|
|
Lines of this form indicate manpaths that every automatically generated
|
|
$<B>MANPATH</B>
|
|
|
|
should contain.
|
|
This will typically include
|
|
<I>/usr/man</I>.
|
|
|
|
<DT id="3"><B>MANPATH_MAP</B><I> path_element manpath_element</I>
|
|
|
|
<DD>
|
|
Lines of this form set up
|
|
$<B>PATH</B>
|
|
|
|
to
|
|
$<B>MANPATH</B>
|
|
|
|
mappings.
|
|
For each
|
|
<I>path_element</I>
|
|
|
|
found in the user's
|
|
$<B>PATH</B>,
|
|
|
|
<I>manpath_element</I>
|
|
|
|
will be added to the
|
|
$<B>MANPATH</B>.
|
|
|
|
<DT id="4"><B>MANDB_MAP </B><I>manpath_element </I>[ <I>catpath_element</I> ]<DD>
|
|
Lines of this form indicate which manpaths are to be treated as system
|
|
manpaths, and optionally where their cat files should be stored.
|
|
This field type is particularly important if
|
|
<B>man</B>
|
|
|
|
is a setuid program, as (when in the system configuration file
|
|
/etc/manpath.config rather than the per-user configuration file .manpath)
|
|
it indicates which manual page hierarchies to access as the setuid user and
|
|
which as the invoking user.
|
|
<P>
|
|
The system manual page hierarchies are usually those stored under
|
|
<I>/usr</I>
|
|
|
|
such as
|
|
<I>/usr/man</I>,
|
|
|
|
<I>/usr/local/man</I>
|
|
|
|
and
|
|
<I>/usr/X11R6/man</I>.
|
|
|
|
<P>
|
|
If cat pages from a particular
|
|
<I>manpath_element</I>
|
|
|
|
are not to be stored or are to be stored in the traditional location,
|
|
<I>catpath_element</I>
|
|
|
|
may be omitted.
|
|
<P>
|
|
Traditional cat placement would be impossible for read only mounted manual
|
|
page hierarchies and because of this it is possible to specify any valid
|
|
directory hierarchy for their storage.
|
|
To observe the
|
|
<B>Linux FSSTND</B>
|
|
|
|
the keyword
|
|
<B>FSSTND</B>
|
|
|
|
can be used in place of an actual directory.
|
|
<P>
|
|
Unfortunately, it is necessary to specify
|
|
<B>all</B>
|
|
|
|
system man tree paths, including alternate operating system paths such as
|
|
<I>/usr/man/sun</I>
|
|
|
|
and any
|
|
<B>NLS locale</B>
|
|
|
|
paths such as
|
|
<I>/usr/man/de_DE.88591</I>.
|
|
|
|
<P>
|
|
As the information is parsed line by line in the order written, it is
|
|
necessary for any manpath that is a sub-hierarchy of another hierarchy to be
|
|
listed first, otherwise an incorrect match will be made.
|
|
An example is that
|
|
<I>/usr/man/de_DE.88591</I>
|
|
|
|
must come before
|
|
<I>/usr/man</I>.
|
|
|
|
<DT id="5"><B>DEFINE</B><I> key value</I>
|
|
|
|
<DD>
|
|
Lines of this form define miscellaneous configuration variables; see the
|
|
default configuration file for those variables used by the manual pager
|
|
utilities.
|
|
They include default paths to various programs (such as
|
|
<I>grep</I>
|
|
|
|
and
|
|
<I>tbl</I>),
|
|
|
|
and default sets of arguments to those programs.
|
|
<DT id="6"><B>SECTION</B> <I>section</I> ...<DD>
|
|
<DL COMPACT><DT id="7"><DD>
|
|
Lines of this form define the order in which manual sections should be
|
|
searched.
|
|
If there are no
|
|
<B>SECTION</B>
|
|
|
|
directives in the configuration file, the default is:
|
|
<P>
|
|
|
|
<DL COMPACT><DT id="8"><DD>
|
|
<PRE>
|
|
SECTION 1 n l 8 3 0 2 5 4 9 6 7
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
If multiple
|
|
<B>SECTION</B>
|
|
|
|
directives are given, their section lists will be concatenated.
|
|
<P>
|
|
|
|
If a particular extension is not in this list (say, 1mh) it will be
|
|
displayed with the rest of the section it belongs to.
|
|
The effect of this is that you only need to explicitly list extensions if
|
|
you want to force a particular order.
|
|
Sections with extensions should usually be adjacent to their main section
|
|
(e.g. "1 1mh 8 ...").
|
|
<P>
|
|
|
|
<B>SECTIONS</B>
|
|
|
|
is accepted as an alternative name for this directive.
|
|
</DL>
|
|
|
|
<DT id="9"><B>MINCATWIDTH</B><I> width</I>
|
|
|
|
<DD>
|
|
If the terminal width is less than
|
|
<I>width</I>,
|
|
|
|
cat pages will not be created (if missing) or displayed.
|
|
The default is 80.
|
|
<DT id="10"><B>MAXCATWIDTH</B><I> width</I>
|
|
|
|
<DD>
|
|
If the terminal width is greater than
|
|
<I>width</I>,
|
|
|
|
cat pages will not be created (if missing) or displayed.
|
|
The default is 80.
|
|
<DT id="11"><B>CATWIDTH</B><I> width</I>
|
|
|
|
<DD>
|
|
If
|
|
<I>width</I>
|
|
|
|
is non-zero, cat pages will always be formatted for a terminal of the given
|
|
width, regardless of the width of the terminal actually being used.
|
|
This should generally be within the range set by
|
|
<B>MINCATWIDTH</B>
|
|
|
|
and
|
|
<B>MAXCATWIDTH</B>.
|
|
|
|
<DT id="12"><B>NOCACHE</B>
|
|
|
|
<DD>
|
|
This flag prevents
|
|
<B><A HREF="/cgi-bin/man/man2html?1+man">man</A></B>(1)
|
|
|
|
from creating cat pages automatically.
|
|
</DL>
|
|
<A NAME="lbAE"> </A>
|
|
<H2>BUGS</H2>
|
|
|
|
Unless the rules above are followed and observed precisely, the manual pager
|
|
utilities will not function as desired.
|
|
The rules are overly complicated.
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="13"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="14"><A HREF="#lbAC">DESCRIPTION</A><DD>
|
|
<DT id="15"><A HREF="#lbAD">FORMAT</A><DD>
|
|
<DT id="16"><A HREF="#lbAE">BUGS</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:03 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|