man-pages/man1/dh_installxmlcatalogs.1.html
2021-03-31 01:06:50 +01:00

147 lines
6.0 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of DH_INSTALLXMLCATALOGS</TITLE>
</HEAD><BODY>
<H1>DH_INSTALLXMLCATALOGS</H1>
Section: Debhelper (1)<BR>Updated: 2019-02-27<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>
dh_installxmlcatalogs - install and register XML catalog files
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<B>dh_installxmlcatalogs</B> [<I>debhelper&nbsp;options</I>] [<B>-n</B>]
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<B>dh_installxmlcatalogs</B> is a debhelper program that installs and
registers <FONT SIZE="-1">XML</FONT> catalog files. It complies with the Debian <FONT SIZE="-1">XML/SGML</FONT>
policy.
<P>
The file <I>debian/package.xmlcatalogs</I> lists the local <FONT SIZE="-1">XML</FONT> catalog
files to be installed per package as well as the <FONT SIZE="-1">XML</FONT> entities in those
local <FONT SIZE="-1">XML</FONT> catalog files that are to be registered in the <FONT SIZE="-1">XML</FONT> catalog
system.
<P>
The local <FONT SIZE="-1">XML</FONT> catalog file entries in that file should be of the form
<TT>&quot;local;source;dest&quot;</TT>, where the verbatim <TT>&quot;local&quot;</TT> indicates this is an
entry for a local <FONT SIZE="-1">XML</FONT> catalog file, <TT>&quot;source&quot;</TT> indicates where the
local <FONT SIZE="-1">XML</FONT> catalog resides in the source tree, and <TT>&quot;dest&quot;</TT> indicates
the destination location for the local <FONT SIZE="-1">XML</FONT> catalog under the package
build area. <TT>&quot;dest&quot;</TT> should start with <I>/usr/share/xml/</I>.
<P>
The entries for the <FONT SIZE="-1">XML</FONT> entities to be registered in the package <FONT SIZE="-1">XML</FONT>
catalog file should be of the form <TT>&quot;package;type;id;catalog&quot;</TT>, where
the verbatim <TT>&quot;package&quot;</TT> indicates this is an entry for an <FONT SIZE="-1">XML</FONT> entity
to be registered in the package <FONT SIZE="-1">XML</FONT> catalog file, <TT>&quot;type&quot;</TT> indicates
the <FONT SIZE="-1">XML</FONT> entity type (public, system, uri), <TT>&quot;id&quot;</TT> indicates the <FONT SIZE="-1">XML</FONT>
entity id, and <TT>&quot;catalog&quot;</TT> indicates the local <FONT SIZE="-1">XML</FONT> catalog file.
<P>
The entries for the <FONT SIZE="-1">XML</FONT> entities to be registered in the root <FONT SIZE="-1">XML</FONT>
catalog file should be of the form <TT>&quot;root;type;id&quot;</TT>, where the verbatim
<TT>&quot;root&quot;</TT> indicates this is an entry for an <FONT SIZE="-1">XML</FONT> entity to be registered
in the root <FONT SIZE="-1">XML</FONT> catalog file, <TT>&quot;type&quot;</TT> indicates the <FONT SIZE="-1">XML</FONT> entity type
(public, system, uri), and <TT>&quot;id&quot;</TT> indicates the <FONT SIZE="-1">XML</FONT> entity id.
<P>
If an entry for is to be registered identically in the root catalog
and the package catalog file, you can use the form
<TT>&quot;root-and-package;type;id;catalog&quot;</TT>, where the verbatim
<TT>&quot;root-and-package&quot;</TT> indicates this is an entry for an <FONT SIZE="-1">XML</FONT> entity to be
registered in both the root and package <FONT SIZE="-1">XML</FONT> catalog files, <TT>&quot;type&quot;</TT>
indicates the <FONT SIZE="-1">XML</FONT> entity type (public, system, uri), <TT>&quot;id&quot;</TT> indicates
the <FONT SIZE="-1">XML</FONT> entity id, and <TT>&quot;catalog&quot;</TT> indicates the local <FONT SIZE="-1">XML</FONT> catalog
file.
<P>
<FONT SIZE="-1">XML</FONT> entity types are described in <B><A HREF="/cgi-bin/man/man2html?8+update-xmlcatalog">update-xmlcatalog</A></B>(8). Using the
<TT>&quot;root&quot;</TT> or <TT>&quot;package&quot;</TT> commands, a type of <TT>&quot;public&quot;</TT> will general
<TT>&quot;delegatePublic&quot;</TT> statements in the applicable catalog file. Generally
you will want to use the types <TT>&quot;public&quot;</TT> for any formal public
identifiers, and <TT>&quot;system&quot;</TT> for any files on the local filesystem or
URLs. <TT>&quot;uri&quot;</TT> is only used for non-local files which are not part of
the external document subset, e.g., they are not used for entities or
DTDs.
<P>
<B>dh_installxmlcatalogs</B> automatically adds maintainer script snippets
for the registration and unregistration of the listed <FONT SIZE="-1">XML</FONT> entities in
the <FONT SIZE="-1">XML</FONT> catalog system (unless <B>-n</B> is used).<TT>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TT>A dependency on the<BR>
<B>xml-core</B> package will be added to <TT>&quot;${misc:Depends}&quot;</TT>, so be sure to
use that variable in the file <I>debian/control</I>. See
<B><A HREF="/cgi-bin/man/man2html?1+dh_installdeb">dh_installdeb</A></B>(1) for an explanation of Debhelper maintainer script
snippets.
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<DL COMPACT>
<DT id="1"><B>-n</B>, <B>--noscripts</B><DD>
Do not modify <I>postinst</I>/<I>postrm</I>/<I>prerm</I> scripts.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>NOTES</H2>
Note that this command is not idempotent. ``dh_clean -k'' should be
called between invocations of this command. Otherwise, it may cause
multiple instances of the same text to be added to maintainer scripts.
<A NAME="lbAG">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?7+debhelper">debhelper</A></B>(7)
<P>
<I>/usr/share/doc/xml-core/</I>
<A NAME="lbAH">&nbsp;</A>
<H2>AUTHOR</H2>
<B>Ardo van Rangelrooij</B> &lt;<A HREF="mailto:ardo@debian.org">ardo@debian.org</A>&gt;
<P>
<B>Adam Di Carlo</B> &lt;<A HREF="mailto:aph@debian.org">aph@debian.org</A>&gt;
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="2"><A HREF="#lbAB">NAME</A><DD>
<DT id="3"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="4"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="5"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="6"><A HREF="#lbAF">NOTES</A><DD>
<DT id="7"><A HREF="#lbAG">SEE ALSO</A><DD>
<DT id="8"><A HREF="#lbAH">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:10 GMT, March 31, 2021
</BODY>
</HTML>