man-pages/man8/update-catalog.8.html
2021-03-31 01:06:50 +01:00

197 lines
3.7 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of UPDATE-CATALOG</TITLE>
</HEAD><BODY>
<H1>UPDATE-CATALOG</H1>
Section: Debian (8)<BR>Updated: June 2004<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
update-catalog - create or update entry in SGML catalog file
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<B>update-catalog</B>
[<I>options</I>]
<B>--add</B>
<I>centralized_catalog ordinary_catalog</I>
<P>
<B>update-catalog</B>
[<I>options</I>]
<B>--remove</B>
<I>centralized_catalog ordinary_catalog</I>
<P>
<B>update-catalog</B>
[<I>options</I>]
<B>--update-super</B>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
<B>update-catalog</B>
inserts, updates or removes entries in the
SGML centralized catalogs located in
<I>/etc/sgml</I>.
To change the SGML super catalog located in
<I>/etc/sgml/catalog</I>
modify the directory contents of
<I>/etc/sgml</I>
to contain new files or symbolic links having a
<B>.cat</B>
extension or remove (or move) existing centralized catalogs and regenerate the super catalog using the
<B>--update-super</B>
option.
See section
<B>SUPER CATALOG</B>
for details on the generation process.
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<DL COMPACT>
<DT id="1"><B>--add</B>
<DD>
Adds an entry for the
<I>ordinary_catalog</I>
in the
<I>centralized_catalog</I>.
<DT id="2"><B>--remove</B>
<DD>
Removes the entry for the
<I>ordinary_catalog</I>
from the
<I>centralized_catalog</I>.
<DT id="3"><B>--update-super</B>
<DD>
Regenerates the SGML super catalog from the contents of the
<I>/etc/sgml</I>
directory.
See section
<B>SUPER CATALOG</B>
for details on the super catalog generation.
<DT id="4"><B>--quiet</B>
<DD>
Prevents the usual diagnostic output.
<DT id="5"><B>--test</B>
<DD>
Prevents the update of the catalog and writes the resulting SGML
catalog to standard output.
<DT id="6"><B>--version</B>
<DD>
Displays the version information and exits.
<DT id="7"><B>--help</B>
<DD>
Display the usage information and exits.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>SUPER CATALOG</H2>
The super-catalog located in
<I>/etc/sgml/catalog</I>
cannot be directly modified.
It is generated by the
<I>update-catalog</I>
<I>--update-super</I>
command.
The generation considers files in the
<I>/etc/sgml</I>
directory that have a
<B>.cat</B>
extension.
For instance files ending in .old or .disabled are not considered.
Before adding a catalog to the super catalog it is parsed and verified in order to not corrupt the super catalog.
All referenced catalogs are verified to actually exist.
If the check fails, a message is printed and the complete catalog is ignored.
This check ensures that a catalog from a package, which is removed but not purged, is removed from the super catalog.
<A NAME="lbAG">&nbsp;</A>
<H2>AUTHOR</H2>
Ardo van Rangelrooij &lt;<A HREF="mailto:ardo@debian.org">ardo@debian.org</A>&gt;
<A NAME="lbAH">&nbsp;</A>
<H2>COPYRIGHT</H2>
Copyright &#169; 2001-2004 Ardo van Rangelrooij
Copyright &#169; 2012 Helmut Grohne
<P>
This is free software; see the GNU General Public Licence version 2 or
later for copying conditions. There is
<I>no</I>
warranty.
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="8"><A HREF="#lbAB">NAME</A><DD>
<DT id="9"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="10"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="11"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="12"><A HREF="#lbAF">SUPER CATALOG</A><DD>
<DT id="13"><A HREF="#lbAG">AUTHOR</A><DD>
<DT id="14"><A HREF="#lbAH">COPYRIGHT</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:18 GMT, March 31, 2021
</BODY>
</HTML>