DAPS-XMLFORMAT(1)

✨ NAME ✨

okay bestie, so this is daps-xmlformat — a program that lives inside the DAPS software package, which is a whole complete environment for building HTML, PDF, ePUB and other formats from DocBook XML. 💖

---

🎀 DESCRIPTION 🎀

This manual page documents, briefly, the daps-xmlformat program. Short and sweet, no cap.

So here's the vibe: daps-xmlformat is a wrapper around the xmlformat command, and xmlformat is what you use to format XML-formatted files. You literally just pass the file name to the program on the command line. That's it. That's the whole thing. 🦋

Wanna see the usage help? Use the --help switch and you get something exactly like this:

Usage: xmlformat [options] xml-file

Options:
--help, -h
Print this message and exit.
--backup suffix -b suffix
Back up the input document, adding suffix to the input
filename to create the backup filename.
--canonized-output
Proceed only as far as the document canonization stage,
printing the result.
--check-parser
Parse the document into tokens and verify that their
concatenation is identical to the original input document.
This option suppresses further document processing.
--config-file file_name, -f file_name
Specify the configuration filename. If no file is named,
xmlformat uses the file named by the environment variable
XMLFORMAT_CONF, if it exists, or ./xmlformat.conf, if it
exists. Otherwise, xmlformat uses built-in formatting
options.
--in-place, -i
Format the document in place, replacing the contents of
the input file with the reformatted document. (It's a
good idea to use --backup along with this option.)
--show-config
Show configuration options after reading configuration
file. This option suppresses document processing.
--show-unconfigured-elements
Show elements that are used in the document but for
which no options were specified in the configuration
file. This option suppresses document output.
--verbose, -v
Be verbose about processing stages.
--version, -V
Show version information and exit.

Now let's break those options down one by one, because you deserve to know your flags, periodt. 💅

🌸 OPTIONS 🌸

• --help, -h — prints that message right there and then dips out. no further drama.
• --backup suffix, -b suffix — backs up the input document by tacking suffix onto the input filename to make the backup filename. protect your files bestie 🫶
• --canonized-output — only goes as far as the document canonization stage, then prints the result. stops early on purpose, iconic behaviour honestly.
• --check-parser — parses the document into tokens and verifies that concatenating them gives you something identical to the original input document. note: this option suppresses further document processing. it does its one job and then it's done. 😌
• --config-file file_name, -f file_name — specifies the configuration filename. and if no file is named? then xmlformat goes looking for the file named by the environment variable XMLFORMAT_CONF, if it exists, or ./xmlformat.conf, if it exists. and if none of that exists? then xmlformat just uses built-in formatting options. fallback queen. 👑
• --in-place, -i — formats the document in place, replacing the contents of the input file with the reformatted document.

⚠️ okay so this is important: it's a good idea to use --backup along with this option. like, actually. because "in place" means in place. 😭

• --show-config — shows the configuration options after reading the configuration file. this option suppresses document processing. it's here to spill config tea, not to format.
• --show-unconfigured-elements — shows the elements that are used in the document but for which no options were specified in the configuration file. this option suppresses document output. nosy in the best way 🔥
• --verbose, -v — be verbose about processing stages. tell me everything, I'm listening.
• --version, -V — shows version information and exits. slay.

---

💜 THIS MAN PAGE AUTHOR 💜

• Filippo Rusconi <lopippo@debian.org>

---

🌈 AUTHORS 🌈

• Frank Sundermeyer <fsundermeyer@opensuse.org> — Developer
• Thomas Schraitle <toms@opensuse.org> — Developer
• Stefan Knorr — Developer
• Berthold Gunreben — Previous Developer of susedoc
• Jana Jaeger — Previous Developer of susedoc

---

and that's the whole page bestie, you made it to the end 🥳 this was daps-xmlformat version @DAPS_VERSION@, dated 01/10/2020, and the man page is DAPS-XMLFORMAT(1). go format something cute 💅✨🌸