201 lines
4.4 KiB
HTML
201 lines
4.4 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: Manual pager utils (1)<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 - determine search path for manual pages
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<B>manpath</B>
|
|
|
|
[<B>-qgdc?V</B>]
|
|
|
|
[<B>-m</B>
|
|
|
|
<I>system</I>[,...]]
|
|
|
|
[<B>-C</B>
|
|
|
|
<I>file</I>]
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
If
|
|
$<B>MANPATH</B>
|
|
|
|
is set,
|
|
<B>manpath</B>
|
|
|
|
will simply display its contents and issue a warning.
|
|
If not,
|
|
<B>manpath</B>
|
|
|
|
will determine a suitable manual page hierarchy search path and display the
|
|
results.
|
|
<P>
|
|
The colon-delimited path is determined using information gained from the
|
|
man-db configuration file -
|
|
(<I>/etc/manpath.config</I>)
|
|
|
|
and the user's environment.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B>-q</B>, <B>--quiet</B>
|
|
|
|
<DD>
|
|
Do not issue warnings.
|
|
<DT id="2"><B>-d</B>, <B>--debug</B>
|
|
|
|
<DD>
|
|
Print debugging information.
|
|
<DT id="3"><B>-c</B>, <B>--catpath</B>
|
|
|
|
<DD>
|
|
Produce a catpath as opposed to a manpath.
|
|
Once the manpath is determined,
|
|
each path element is converted to its relative catpath.
|
|
<DT id="4"><B>-g</B>, <B>--global</B>
|
|
|
|
<DD>
|
|
Produce a manpath consisting of all paths named as "global" within the
|
|
man-db configuration file.
|
|
<DT id="5"><B>-m</B> <I>system</I>[,...], <B>--systems=</B><I>system</I>[,...]<DD>
|
|
If this system has access to other operating system's manual hierarchies,
|
|
this option can be used to include them in the output of
|
|
<B>manpath</B>.
|
|
|
|
To include NewOS's manual page hierarchies use the option
|
|
<B>-m</B>
|
|
|
|
<B>NewOS</B>.
|
|
|
|
<P>
|
|
The
|
|
<I>system</I>
|
|
|
|
specified can be a combination of comma delimited operating system names.
|
|
To include the native operating system's manual page hierarchies,
|
|
the system name
|
|
<B>man</B>
|
|
|
|
must be included in the argument string.
|
|
This option will override the
|
|
$<B>SYSTEM</B>
|
|
|
|
environment variable.
|
|
<DT id="6"><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="7"><B>-?</B>, <B>--help</B>
|
|
|
|
<DD>
|
|
Print a help message and exit.
|
|
<DT id="8"><B>--usage</B>
|
|
|
|
<DD>
|
|
Print a short usage message and exit.
|
|
<DT id="9"><B>-V</B>, <B>--version</B>
|
|
|
|
<DD>
|
|
Display version information.
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>ENVIRONMENT</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="10"><B>MANPATH</B>
|
|
|
|
<DD>
|
|
If
|
|
$<B>MANPATH</B>
|
|
|
|
is set,
|
|
<B>manpath</B>
|
|
|
|
displays its value rather than determining it on the fly.
|
|
If
|
|
$<B>MANPATH</B>
|
|
|
|
is prefixed by a colon, then the value of the variable is appended
|
|
to the list determined from the content of the configuration files.
|
|
If the colon comes at the end of the value in the variable, then the
|
|
determined list is appended to the content of the variable.
|
|
If the value of the variable contains a double colon
|
|
(<B>::</B>),
|
|
|
|
then the determined list is inserted in the middle of the value, between
|
|
the two colons.
|
|
<DT id="11"><B>SYSTEM</B>
|
|
|
|
<DD>
|
|
If
|
|
$<B>SYSTEM</B>
|
|
|
|
is set, it will have the same effect as if it had been specified as the
|
|
argument to the
|
|
<B>-m</B>
|
|
|
|
option.
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>FILES</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="12"><I>/etc/manpath.config</I>
|
|
|
|
<DD>
|
|
man-db configuration file.
|
|
</DL>
|
|
<A NAME="lbAH"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+apropos">apropos</A></B>(1),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+man">man</A></B>(1),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+whatis">whatis</A></B>(1)
|
|
|
|
<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="13"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="14"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="15"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="16"><A HREF="#lbAE">OPTIONS</A><DD>
|
|
<DT id="17"><A HREF="#lbAF">ENVIRONMENT</A><DD>
|
|
<DT id="18"><A HREF="#lbAG">FILES</A><DD>
|
|
<DT id="19"><A HREF="#lbAH">SEE ALSO</A><DD>
|
|
<DT id="20"><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:05:19 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|