DH_INSTALLXMLCATALOGS(1)

✨ DH_INSTALLXMLCATALOGS(1) — Debhelper 💖

Okay so bestie, this is the manual page for dh_installxmlcatalogs, a Debhelper program that installs and registers XML catalog files 🎀 It's giving very responsible packaging energy and it follows the Debian XML/SGML policy, so we love to see it 💅

🌸 NAME

dh_installxmlcatalogs - install and register XML catalog files

🦋 SYNOPSIS

dh_installxmlcatalogs [debhelper options] [-n]

💜 DESCRIPTION

dh_installxmlcatalogs is a debhelper program that installs and registers XML catalog files. It complies with the Debian XML/SGML policy, obviously ✨

So the file debian/package.xmlcatalogs is where you list the local XML catalog files to be installed per package, plus the XML entities inside those local catalogs that should get registered in the XML catalog system 🧚

The local XML catalog file entries in that file should look like local;source;dest. The verbatim local tells the tool this is an entry for a local XML catalog file, source is where that catalog lives in the source tree, and dest is where it should end up under the package build area. Quick reminder: dest should start with /usr/share/xml/ 🫶

Next up, the entries for XML entities to be registered in the package XML catalog file look like package;type;id;catalog. The verbatim package marks it as an entity for the package catalog, type is the XML entity type (public, system, uri), id is the XML entity id, and catalog is the local XML catalog file 😭

For entities going into the root XML catalog file, use root;type;id. Again the verbatim root says it's for the root catalog, and type (public, system, uri) and id do the same jobs as before 💅

If an entry needs to be registered identically in both the root catalog and the package catalog file, you can use root-and-package;type;id;catalog. The verbatim root-and-package means it goes in both root and package XML catalog files, with type, id and catalog working just like above 🔥

XML entity types are described in update-xmlcatalog(8). Using the "root" or "package" commands, a type of "public" will generally produce "delegatePublic" statements in the applicable catalog file. Generally you'll want public for any formal public identifiers, and system for any files on the local filesystem or URLs. uri 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. Main character energy for the public/system split 🌈

dh_installxmlcatalogs automatically adds maintainer script snippets for the registration and unregistration of the listed XML entities in the XML catalog system (unless -n is used). A dependency on the xml-core package gets added to ${misc:Depends}, so be sure to use that variable in the file debian/control. See dh_installdeb(1) for an explanation of Debhelper maintainer script snippets 🍓

🎀 OPTIONS

• -n, --noscripts — Don't touch the postinst/postrm/prerm scripts. Hands off, bestie 🙈

🧚 NOTES

Heads up, this command is NOT idempotent 💀 Call dh_clean -k between invocations of this command, otherwise it may add multiple instances of the same text to your maintainer scripts. Nobody wants duplicate snippets, periodt 😭

💖 SEE ALSO

debhelper(7)

/usr/share/doc/xml-core/

👑 AUTHOR

Ardo van Rangelrooij <ardo@debian.org>

Adam Di Carlo <aph@debian.org>

---

Okay that's the whole tea, bestie 🫶 This page is from perl v5.36.0 (Debhelper), dated 2023-12-12, so go slay your packaging with it ✨💅