253 lines
7.9 KiB
HTML
253 lines
7.9 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of INSTALL-DOCS</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>INSTALL-DOCS</H1>
|
|
Section: Debian (8)<BR>Updated: 06 August 2019<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>
|
|
|
|
install-docs - manage online Debian documentation
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
install-docs [options] -i,--install | -r,--remove | -c,--check file [ file ... ]
|
|
|
|
install-docs [options] -I,--install-all | -C,--install-changed | -R,--remove-all
|
|
|
|
install-docs [options] -s,--status docid [ docid ... ]
|
|
|
|
install-docs [options] --dump-db dbname
|
|
|
|
install-docs -h,--help | -V,--version
|
|
|
|
</PRE>
|
|
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
|
|
|
|
<B>install-docs</B> is a tool allow Debian package maintainers to register
|
|
documentation to various documentation systems. It currently supports
|
|
<B>dhelp</B>, <B>dwww</B>, <B>doc-central</B>, and <B>scrollkeeper</B> browsers.
|
|
<P>
|
|
|
|
This manual page provides a quick synopsis of <B>install-docs</B> usage.
|
|
Full documentation can be found in the documentation, including a
|
|
description of the control file syntax and grammar.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B>-v</B>, <B>--verbose</B><DD>
|
|
|
|
|
|
Operate verbosely.
|
|
<DT id="2"><B>-d</B>, <B>--debug</B><DD>
|
|
|
|
|
|
Print some debugging information.
|
|
<DT id="3"><B>--no-update-menus</B><DD>
|
|
|
|
|
|
Inhibit running <B><A HREF="/cgi-bin/man/man2html?8+dwww-build-menu">dwww-build-menu</A></B>(8), <B><A HREF="/cgi-bin/man/man2html?8+dhelp_parse">dhelp_parse</A></B>(8),
|
|
and <B><A HREF="/cgi-bin/man/man2html?8+scrollkeeper-update">scrollkeeper-update</A></B>(8).
|
|
<DT id="4"><B>--rootdir</B> <I>dir</I><DD>
|
|
|
|
|
|
Set the root directory to <I>dir</I> instead of `<I>/</I>'. Useful and valid only with
|
|
the <B>--check</B> action.
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>ACTIONS</H2>
|
|
|
|
|
|
|
|
Below is list of possible actions <B>install-docs</B> could handle. There can be only one action
|
|
option passed to install-docs, moreover the action with its arguments must be the last option
|
|
passed.
|
|
<P>
|
|
|
|
Each <I>file</I> argument should be the full path for the doc-base control file (i.e.
|
|
`/usr/share/doc-base/some_file' or `/etc/doc-base/documents/some_file'), and each
|
|
<I>docid</I> should be the document identifier
|
|
(Document identifiers are set in the `Document' field of the control file, and usually
|
|
correspond to the package name.)
|
|
<P>
|
|
|
|
If <I>file</I> or <I>docid</I> equals `<B>-</B>' (the minus sign), the list of
|
|
arguments is read from the standard input (each file name or document id in separate line).
|
|
<DL COMPACT>
|
|
<DT id="5"><B>-i</B> <I>file</I> [<I>file</I> ...], <B>--install</B> <I>file</I> [<I>file</I> ...]<DD>
|
|
|
|
|
|
Install the documentation described by the control file <I>file</I>.
|
|
<DT id="6"><B>-r</B> <I>file</I> [<I>file</I> ...], <B>--remove</B> <I>file</I> [<I>file</I> ...]<DD>
|
|
|
|
|
|
Remove the documentation identified by the control file
|
|
<I>file</I>.
|
|
<DT id="7"><B>-c</B> <I>file</I> [<I>file</I> ...], <B>--check</B> <I>file</I> [<I>file</I> ...]<DD>
|
|
|
|
|
|
Check the control file <I>file</I> and display number of possible problems found.
|
|
Use with <I>--verbose</I> to get the actual locations of errors and warnings.
|
|
If <I>--rootdir</I> was also given, its argument will be prepended to names of the files
|
|
given if the `Files' and `Index' fields of the <I>file</I>.
|
|
<DT id="8"><B>-R</B>, <B>--remove-all</B><DD>
|
|
|
|
|
|
De-register all registered documents.
|
|
<DT id="9"><B>-I</B>, <B>--install-all</B><DD>
|
|
|
|
|
|
(Re)register all documents from <I>/usr/share/doc-base</I> and <I>/etc/doc-base/documents</I>.
|
|
<DT id="10"><B>-C</B>, <B>--install-changed</B><DD>
|
|
|
|
|
|
Compare contents of <I>/usr/share/doc-base</I> and <I>/etc/doc-base/documents</I> directories
|
|
with registered documents database and de-register any files that are missing and
|
|
(re)register only changed or new files.
|
|
<DT id="11"><B>-s</B> <I>docid</I> [<I>docid</I> ...], <B>--status</B> <I>docid</I> [<I>docid</I> ...]<DD>
|
|
|
|
|
|
Display the status of the document identifier <I>docid</I>.
|
|
<DT id="12"><B>-L</B> <I>docid</I> [<I>docid</I> ...], <B>--listfiles</B> <I>docid</I> [<I>docid</I> ...]<DD>
|
|
|
|
|
|
Deprecated option. Does nothing.
|
|
<DT id="13"><B>--dump-db</B> <I>dbname</I><DD>
|
|
|
|
|
|
Dumps contents of internal databases, for debugging purposes. <I>dbname</I> can be either <B>files.db</B> or
|
|
<B>status.db</B>.
|
|
<DT id="14"><B>-h</B>, <B>--help</B><DD>
|
|
|
|
|
|
Show a short help message.
|
|
<DT id="15"><B>-V</B>, <B>--version</B><DD>
|
|
|
|
|
|
Display version information.
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>COMPATIBILITY ISSUES</H2>
|
|
|
|
|
|
|
|
The following features were added in version 0.8.4,
|
|
please make sure to add proper
|
|
`<I>Conflicts</I>' or `<I>Depends</I>' lines if you would like to use them in your package's scripts:
|
|
<DL COMPACT>
|
|
<DT id="16">•<DD>
|
|
support for passing more than one argument to the <B>-i</B> and <B>-r</B> actions,
|
|
<DT id="17">•<DD>
|
|
reading arguments from the standard input,
|
|
<DT id="18">•<DD>
|
|
<B>-I</B>,<B>--install-all</B>, <B>-R</B>, <B>---remove-all</B>, <B>-c</B>, <B>--check</B> actions,
|
|
<DT id="19">•<DD>
|
|
<B>-d</B>, <B>--debug</B>, <B>-h</B>, <B>--help</B> options.
|
|
</DL>
|
|
<P>
|
|
|
|
The <B>-C</B>, <B>--install-changed</B>, <B>--dump-db</B>, <B>-V</B>, <B>--version</B> options were added in 0.8.12.
|
|
<A NAME="lbAH"> </A>
|
|
<H2>FILES</H2>
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="20"><I>/usr/share/doc-base/</I><DD>
|
|
|
|
|
|
The location of doc-base control files provided by various packages.
|
|
<DT id="21"><I>/etc/doc-base/documents/</I><DD>
|
|
|
|
|
|
The location of doc-base control files provided by local administrator.
|
|
<DT id="22"><I>/var/lib/doc-base/info/documents/</I><DD>
|
|
|
|
|
|
The location of registered control files.
|
|
<DT id="23"><I>/var/lib/doc-base/info/status.db</I><DD>
|
|
|
|
|
|
Statuses of registered documents.
|
|
<DT id="24"><I>/var/lib/doc-base/info/files.db</I><DD>
|
|
|
|
|
|
Timestamps and documents ids of registered doc-base files.
|
|
<DT id="25"><I>/var/lib/doc-base/omf/</I><DD>
|
|
|
|
|
|
The location of generated scrollkeeper <FONT SIZE="-1">OMF</FONT> files.
|
|
Note: <I>/usr/share/omf/doc-base</I> should be a symbolic link pointing to the directory.
|
|
</DL>
|
|
<A NAME="lbAI"> </A>
|
|
<H2>BUGS</H2>
|
|
|
|
|
|
|
|
See <<A HREF="http://bugs.debian.org/doc-base">http://bugs.debian.org/doc-base</A>>.
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+dhelp">dhelp</A></B>(1), <B><A HREF="/cgi-bin/man/man2html?1+doccentral">doccentral</A></B>(1), <B><A HREF="/cgi-bin/man/man2html?7+dwww">dwww</A></B>(7), <B><A HREF="/cgi-bin/man/man2html?7+scrollkeeper">scrollkeeper</A></B>(7),
|
|
Debian doc-base Manual <I>/usr/share/doc/doc-base/doc-base.html/index.html</I>
|
|
<A NAME="lbAK"> </A>
|
|
<H2>AUTHOR</H2>
|
|
|
|
|
|
|
|
This program was originally written by Christian Schwarz
|
|
<<A HREF="mailto:schwarz@debian.org">schwarz@debian.org</A>>, for the Debian GNU/Linux system, and the
|
|
next maintainer was Adam Di Carlo <<A HREF="mailto:aph@debian.org">aph@debian.org</A>>.
|
|
Robert Luberda <<A HREF="mailto:robert@debian.org">robert@debian.org</A>> is currently maintaining and extending it.
|
|
<P>
|
|
|
|
This software was meant to be for the benefit of the entire Debian
|
|
user and developer community. If you are interested in being involved
|
|
with this software, please join the mailing list
|
|
<<A HREF="mailto:debian-doc@lists.debian.org">debian-doc@lists.debian.org</A>>.
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="26"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="27"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="28"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="29"><A HREF="#lbAE">OPTIONS</A><DD>
|
|
<DT id="30"><A HREF="#lbAF">ACTIONS</A><DD>
|
|
<DT id="31"><A HREF="#lbAG">COMPATIBILITY ISSUES</A><DD>
|
|
<DT id="32"><A HREF="#lbAH">FILES</A><DD>
|
|
<DT id="33"><A HREF="#lbAI">BUGS</A><DD>
|
|
<DT id="34"><A HREF="#lbAJ">SEE ALSO</A><DD>
|
|
<DT id="35"><A HREF="#lbAK">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:12 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|