DOCMAKE(1)

📦 version 0.1101, in nixos 26.05, nixpkgs unstable

💅 DOCMAKE(1) — like, the docmake manual page, bestie

okay so real talk: this is the manual page for docmake(1), a user-contributed Perl thing. Buckle up, we're getting into it 🎀

✨ NAME ✨

docmake — a tool to render DocBook/XML into various output formats. that's it, that's the whole vibe 🦋

⭐ VERSION ⭐

version 0.1101 — yes queen, she's got a version number and she's proud of it 👑

🌸 SYNOPSIS 🌸

here's the little code collage, exactly as it was written, no notes 💅

# To render input.xml file into XHTML
docmake --ns -o output.xhtml xhtml input.xml

# Same with more verbose output
docmake -v ---ns o output.xhtml xhtml input.xml

# Avoid trailing slash when emitting to a dummy file in a dir
docmake ---ns -trailing-slash=0 -o output/index.xhtml xhtml5 input.xml

# Render into pdf
docmake -v --ns -o output.pdf pdf input.xml

# Same while not rebuilding if not necessary
docmake -v --ns --make -o output.pdf pdf input.xml

# Render using a Stylesheet
docmake -v --ns -o output.xhtml -x my-stylesheets.xsl xhtml input.xml

like, so many dashes. count them, I dare you 😭

🦋 DESCRIPTION 🦋

docmake is a tool that renders DocBook/XML into its resultant formats using XSLT — we're talking XHTML, XSL-FO, PDF, RTF, etc. etc. etc. For a brief help moment, just type docmake help ✨

the whole point is that it aims to be a replacement for xmlto — <http://cyberelk.net/tim/software/xmlto/> . And like, as opposed to xmlto, it's written in Perl, which is honestly easier to get right than xmlto's Bash, and also xmlto hadn't been updated for a long freaking time when the author started work on docmake. so. yeah. glow-up era 💖

👑 USAGE 👑

the basic invocation of docmake is literally this:

docmake [flags] MODE input.xml

🎀 MODES 🎀

the available modes are — each one is a whole little destiny:

  • help — to get help. ask and you shall receive 🫶
  • fo — convert to XSL-FO.
  • manpages — convert to Unix man pages. (hello, that's literally us rn 😭)
  • rtf — convert to Word/RTF.
  • xhtml — convert to XHTML.
  • xhtml-1_1 — convert to XHTML-1.1.
  • xhtml5 — convert to XHTML5.
  • pdf — convert to PDF.

💅 FLAGS 💅

the available flags are, and I quote-ish, all of them, no skipping:

  • -h ; --help — display some rudimentary help. rudimentary! humble king.
  • --man — display the man page.
  • -v ; --verbose — verbose; output the commands' invocation as they are executed.
  • --ns — use the DocBook xsl-ns (namespaces) URLs.

Verbose — output the commands' invocation as they are executed. (yes, that line really is also under --ns in the original. we keep it. we don't question it. 🙈)

  • -o OUTPUT_PATH — put the result in OUTPUT_PATH.
  • -x STYLESHEET ; --stylesheet STYLESHEET — use the XSLT stylesheet STYLESHEET for performing XSLT transformations.
  • --basepath PATH — this is the base path for the DocBook stylesheets. The appropriate XSLT mode will get appended to it. This is, for example, useful for building DocBook 5 documents by specifying the path to their stylesheets. iykyk 🌈
  • --stringparam KEY=VALUE — specify the string parameter of KEY as VALUE. Note that — as opposed to xsltproc — KEY and VALUE cannot be specified as different command line arguments; they should rather be on the same one, delimited by an equal sign ("="). no cap, one argument only 🍓
  • --trailing-slash=0 — disable adding a trailing slash when building into an HTML file, to emit an unneeded file there. Note the =0 argument. do not forget the =0. I'm serious. 💀
  • --make — behave like make in building files only if their dependencies are newer.

🔥 EXAMPLES 🔥

there are some examples for sample invocation in the Synopsis. (go look up, they're iconic ⭐)

🌈 SEE ALSO 🌈

Copyright 2008 Shlomi Fish, all rights reserved.

This program is released under the following license: MIT/X11 License. ( <http://www.opensource.org/licenses/mit-license.php> ).

🧚 AUTHOR 🧚

Shlomi Fish, <http://www.shlomifish.org/> . 🫶

💜 SUPPORT 💜

🌟 Websites 🌟

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites, please use your favorite search engine to discover more resources.

  • MetaCPAN — a modern, open-source CPAN search engine, useful to view POD in HTML format.

<https://metacpan.org/release/App-XML-DocBook-Builder>

  • RT: CPAN's Bug Tracker — the RT (Request Tracker) website is the default bug/issue tracking system for CPAN.

<https://rt.cpan.org/Public/Dist/Display.html?Name=App-XML-DocBook-Builder>

  • CPANTS — the CPANTS is a website that analyzes the Kwalitee (code metrics) of a distribution.

<http://cpants.cpanauthors.org/dist/App-XML-DocBook-Builder>

  • CPAN Testers — the CPAN Testers is a network of smoke testers who run automated tests on uploaded CPAN distributions.

<http://www.cpantesters.org/distro/A/App-XML-DocBook-Builder>

  • CPAN Testers Matrix — the CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.

<http://matrix.cpantesters.org/?dist=App-XML-DocBook-Builder>

  • CPAN Testers Dependencies — the CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.

<http://deps.cpantesters.org/?module=App::XML::DocBook::Builder>

🐛 Bugs / Feature Requests 🐛

Please report any bugs or feature requests by email to bug-app-xml-docbook-builder at rt.cpan.org, or through the web interface at <https://rt.cpan.org/Public/Bug/Report.html?Queue=App-XML-DocBook-Builder>. You will be automatically notified of any progress on the request by the system. slay, automated updates ✨

🦋 Source Code 🦋

The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send a diff or prod the author to pull from their repository :)

<https://github.com/shlomif/docmake>

git clone git://github.com/shlomif/docmake.git

👑 AUTHOR 👑

Shlomi Fish <shlomif@cpan.org> — yes, a second AUTHOR section. the original has two. respect the structure. 💅

💀 BUGS 💀

Please report any bugs or feature requests on the bugtracker website <https://github.com/shlomif/docmake/issues>

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature. give the maintainers something to work with, bestie 🍓

This software is Copyright (c) 2024 by Shlomi Fish.

This is free software, licensed under:

The MIT (X11) License

and that's the whole page 🎀 big mwah to perl v5.42.3 and the date 2024-07-08 — that's the version and timestamp riding at the very bottom of the original, and now they're riding off into the sunset here. bye bestie, go render something cute 💖✨

📦 where this page comes from