.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "DOCMAKE 1p"
.TH DOCMAKE 1p 2026-03-07 "perl v5.42.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
docmake \- a tool to render DocBook/XML into various output formats.
.SH VERSION
.IX Header "VERSION"
version 0.1101
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&    # 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
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBdocmake\fR is a tool to render DocBook/XML into its resultant formats
using XSLT: XHTML, XSL\-FO, PDF, RTF, etc. For a brief help type
\&\f(CW\*(C`docmake help\*(C'\fR .
.PP
It aims to be a replacement for xmlto \-
<http://cyberelk.net/tim/software/xmlto/> . As opposed to xmlto,
it is written in Perl, which is easier to get right than xmlto\*(Aqs Bash, and
xmlto hasn\*(Aqt been updated for a long time when I started work on docmake.
.SH USAGE
.IX Header "USAGE"
The basic invocation of docmake is:
.PP
.Vb 1
\&    docmake [flags] MODE input.xml
.Ve
.SS MODES
.IX Subsection "MODES"
The available modes are:
.IP \(bu 4
help
.Sp
To get help.
.IP \(bu 4
fo
.Sp
Convert to XSL\-FO.
.IP \(bu 4
manpages
.Sp
Convert to Unix man pages.
.IP \(bu 4
rtf
.Sp
Convert to Word/RTF.
.IP \(bu 4
xhtml
.Sp
Convert to XHTML.
.IP \(bu 4
xhtml\-1_1
.Sp
Convert to XHTML\-1.1.
.IP \(bu 4
xhtml5
.Sp
Convert to XHTML5.
.IP \(bu 4
pdf
.Sp
Convert to PDF.
.SS FLAGS
.IX Subsection "FLAGS"
The available flags are:
.IP \(bu 4
\&\-h ; \-\-help
.Sp
Display some rudimentary help.
.IP \(bu 4
\&\-\-man
.Sp
Display the man page.
.IP \(bu 4
\&\-v ; \-\-verbose
.Sp
Verbose \- output the commands\*(Aq invocation as they are executed.
.IP \(bu 4
\&\-\-ns
.Sp
Use the DocBook xsl\-ns ( namespaces ) URLs.
.Sp
Verbose \- output the commands\*(Aq invocation as they are executed.
.IP \(bu 4
\&\-o OUTPUT_PATH
.Sp
Put the result in \fBOUTPUT_PATH\fR .
.IP \(bu 4
\&\-x STYLESHEET ; \-\-stylesheet STYLESHEET
.Sp
Use the XSLT stylesheet \fBSTYLESHEET\fR for performing XSLT transformations.
.IP \(bu 4
\&\-\-basepath PATH
.Sp
This is the base path for the DocBook stylesheets. The appropriate XSLT mode
will be appended to it. This is for example, useful for building DocBook 5
documents by specifying the path to their stylesheets.
.IP \(bu 4
\&\-\-stringparam KEY=VALUE
.Sp
Specify the string parameter of \fBKEY\fR as \fBVALUE\fR. Note that as opposed to
xsltproc, \fBKEY\fR and \fBVALUE\fR cannot be specified as different command line
arguments, but rather should be on the same one, delimited by an equal sign ("\f(CW\*(C`=\*(C'\fR").
.IP \(bu 4
\&\-\-trailing\-slash=0
.Sp
Disable adding a trailing slash when building into an HTML file, to emit
an unneeded file there. \fBNote\fR the \f(CW\*(C`=0\*(C'\fR argument.
.IP \(bu 4
\&\-\-make
.Sp
Behave like make in building files only if their dependencies are newer.
.SS EXAMPLES
.IX Subsection "EXAMPLES"
There are some examples for sample invocation in the Synopsis.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP \(bu 4
DocBook on the Wikipedia \- <http://en.wikipedia.org/wiki/DocBook>
.IP \(bu 4
DocBook/XSL \- The Complete Guide \- <http://www.sagehill.net/docbookxsl/>
.IP \(bu 4
The DocBook Homepage \- <http://www.docbook.org/>
.IP \(bu 4
xmlto \- <http://cyberelk.net/tim/software/xmlto/>
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2008 Shlomi Fish, all rights reserved.
.PP
This program is released under the following license: MIT/X11 License.
( <http://www.opensource.org/licenses/mit\-license.php> ).
.SH AUTHOR
.IX Header "AUTHOR"
Shlomi Fish , <http://www.shlomifish.org/> .
.SH SUPPORT
.IX Header "SUPPORT"
.SS Websites
.IX Subsection "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.
.IP \(bu 4
MetaCPAN
.Sp
A modern, open\-source CPAN search engine, useful to view POD in HTML format.
.Sp
<https://metacpan.org/release/App\-XML\-DocBook\-Builder>
.IP \(bu 4
RT: CPAN\*(Aqs Bug Tracker
.Sp
The RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN.
.Sp
<https://rt.cpan.org/Public/Dist/Display.html?Name=App\-XML\-DocBook\-Builder>
.IP \(bu 4
CPANTS
.Sp
The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.
.Sp
<http://cpants.cpanauthors.org/dist/App\-XML\-DocBook\-Builder>
.IP \(bu 4
CPAN Testers
.Sp
The CPAN Testers is a network of smoke testers who run automated tests on uploaded CPAN distributions.
.Sp
<http://www.cpantesters.org/distro/A/App\-XML\-DocBook\-Builder>
.IP \(bu 4
CPAN Testers Matrix
.Sp
The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.
.Sp
<http://matrix.cpantesters.org/?dist=App\-XML\-DocBook\-Builder>
.IP \(bu 4
CPAN Testers Dependencies
.Sp
The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.
.Sp
<http://deps.cpantesters.org/?module=App::XML::DocBook::Builder>
.SS "Bugs / Feature Requests"
.IX Subsection "Bugs / Feature Requests"
Please report any bugs or feature requests by email to \f(CW\*(C`bug\-app\-xml\-docbook\-builder at rt.cpan.org\*(C'\fR, 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.
.SS "Source Code"
.IX Subsection "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 :)
.PP
<https://github.com/shlomif/docmake>
.PP
.Vb 1
\&  git clone git://github.com/shlomif/docmake.git
.Ve
.SH AUTHOR
.IX Header "AUTHOR"
Shlomi Fish <shlomif@cpan.org>
.SH BUGS
.IX Header "BUGS"
Please report any bugs or feature requests on the bugtracker website
<https://github.com/shlomif/docmake/issues>
.PP
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.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2024 by Shlomi Fish.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The MIT (X11) License
.Ve