DOCMAKE(1p)

📦 version 0.1101, in arch rolling

🦋 docmake — the Perl man page, but make it a group chat

okay so bestie, welcome to the DOCMAKE(1p) page 💅 it lives in the User Contributed Perl Documentation section, and the version is version 0.1101 ✨

💖 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, again. it's important, ok? 👑

🌸 SYNOPSIS 🌸

here's the tea, literally every example, exactly as written:

# 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

(no, bestie, I'm not "fixing" the typos in there — those are exactly what the page says and I do not make the rules 💀)

🫶 DESCRIPTION 🫶

okay so docmake is a tool that renders DocBook/XML into all its resultant formats using XSLT — we're talking XHTML, XSL-FO, PDF, RTF, etc. 🔥 if you want a brief help, just type docmake help (yes. that's the whole command. icon behaviour).

it aims to be a replacement for xmlto — <http://cyberelk.net/tim/software/xmlto/> . and the way that it's better is: unlike xmlto, it's written in Perl, which is easier to get right than xmlto's Bash 🐚 and on top of that, xmlto hadn't been updated for a long time when the author started working on docmake. so, like, she saw a need and she delivered 💅

👑 USAGE 👑

the basic invocation of docmake is literally:

docmake [flags] MODE input.xml

✨ MODES ✨

here are the available modes, no gatekeeping:

  • help — to get help 🥺
  • fo — convert to XSL-FO.
  • manpages — convert to Unix man pages. (hi, that's how you're reading this 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 🎀

and these are the available flags, bestie:

  • -h ; --help — display some rudimentary help.
  • --man — display the man page. (meta!! you're literally here)
  • -v ; --verbose — verbose — output the commands' invocation as they are executed.
  • --ns — use the DocBook xsl-ns ( namespaces ) URLs.
also, straight-up copying the page here: it then says "Verbose - output the commands' invocation as they are executed." a second time under --ns. yeah. the original page just has that line twice, no cap 😭 I'm keeping it because we keep every detail.
  • -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. ⚠️ important caveat, bestie: as opposed to xsltproc, KEY and VALUE cannot be specified as different command line arguments — they have to be on the same one, delimited by an equal sign ("="). don't do it any other way, fr fr.
  • --trailing-slash=0 — disable adding a trailing slash when building into an HTML file, to emit an unneeded file there. note the "=0" argument 👀 like, the =0 is not optional, it's the whole point.
  • --make — behave like make in building files only if their dependencies are newer. slay, incremental builds 🧚

💜 EXAMPLES 💜

there are some examples for sample invocation in the Synopsis — yes, scroll up, they're right there 🫶

🌈 SEE ALSO 🌈

go read these, they're iconic:

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. (yes, the man page is telling you to google it, and honestly? valid.)

  • 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 🔔 (nice, no ghosting)

💅 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 me a diff or prod me to pull from your repository :)

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

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

🎀 AUTHOR 🎀

Shlomi Fish <shlomif@cpan.org>

⭐ 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 🫶 (receipts, bestie. always bring receipts.)

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

this is free software, licensed under:

The MIT (X11) License
cute sign-off 🧚✨ that's the whole page! it was generated by perl v5.42.0 and dated 2026-03-07, so go forth and render your DocBook, bestie — you're literally the main character of XSLT now 👑💜
📦 where this page comes from