DOCMAKE(1p)           User Contributed Perl Documentation          DOCMAKE(1p)


NAME
       docmake - a tool to render DocBook/XML into various output formats.

VERSION
       version 0.1101

SYNOPSIS
           # 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

DESCRIPTION
       docmake is a tool to render DocBook/XML into its resultant formats
       using XSLT: XHTML, XSL-FO, PDF, RTF, etc. For a brief help type
       "docmake help" .

       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's Bash, and
       xmlto hasn't been updated for a long time when I started work on
       docmake.

USAGE
       The basic invocation of docmake is:

           docmake [flags] MODE input.xml

   MODES
       The available modes are:

       o   help

           To get help.

       o   fo

           Convert to XSL-FO.

       o   manpages

           Convert to Unix man pages.

       o   rtf

           Convert to Word/RTF.

       o   xhtml

           Convert to XHTML.

       o   xhtml-1_1

           Convert to XHTML-1.1.

       o   xhtml5

           Convert to XHTML5.

       o   pdf

           Convert to PDF.

   FLAGS
       The available flags are:

       o   -h ; --help

           Display some rudimentary help.

       o   --man

           Display the man page.

       o   -v ; --verbose

           Verbose - output the commands' invocation as they are executed.

       o   --ns

           Use the DocBook xsl-ns ( namespaces ) URLs.

           Verbose - output the commands' invocation as they are executed.

       o   -o OUTPUT_PATH

           Put the result in OUTPUT_PATH .

       o   -x STYLESHEET ; --stylesheet STYLESHEET

           Use the XSLT stylesheet STYLESHEET for performing XSLT
           transformations.

       o   --basepath PATH

           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.

       o   --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, but rather should be on the same one, delimited by
           an equal sign (""="").

       o   --trailing-slash=0

           Disable adding a trailing slash when building into an HTML file, to
           emit an unneeded file there. Note the "=0" argument.

       o   --make

           Behave like make in building files only if their dependencies are
           newer.

   EXAMPLES
       There are some examples for sample invocation in the Synopsis.

SEE ALSO
       o   DocBook on the Wikipedia - <http://en.wikipedia.org/wiki/DocBook>

       o   DocBook/XSL - The Complete Guide -
           <http://www.sagehill.net/docbookxsl/>

       o   The DocBook Homepage - <http://www.docbook.org/>

       o   xmlto - <http://cyberelk.net/tim/software/xmlto/>

COPYRIGHT & LICENSE
       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.

       o   MetaCPAN

           A modern, open-source CPAN search engine, useful to view POD in
           HTML format.

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

       o   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>

       o   CPANTS

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

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

       o   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>

       o   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>

       o   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.

   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.

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

       This is free software, licensed under:

         The MIT (X11) License

perl v5.42.0                      2026-03-07                       DOCMAKE(1p)