Yanick Champoux > Pod-Manual-0.08 > podmanual

Download:
Pod-Manual-0.08.tar.gz

Annotate this POD

CPAN RT

New  5
Open  0
View/Report Bugs
Source   Latest Release: Pod-Manual-0.08_04

NAME ^

podmanual - converts pods into docbook or pdf manual

SYNOPSIS ^

podmanual [ OPTIONS ] [ module names | pod files ]

DESCRIPTION ^

Take the pods given as arguments and generate a manual out of them.

The pods can be given as module names or file names. If no pods are passed as arguments, podmanual will read them from STDIN, assuming a format of one module name per line.

OPTIONS

-format [ pdf | docbook | latex ]

Output format. 'pdf' is the default.

-output filename

Filename of the generated manual. Defaults to 'manual.pdf' or 'manual.docbook', depending on the choosen format.

If the format is 'pdf', the suffix '.pdf' will be appended to filename, if not already present.

If the format is 'docbook' or 'latex', the suffix '.docbook' or '.tex' will be appended to filename if no suffix is already present. Also, the special filename 'stdout' can be given to have the manual printed to STDOUT.

-title manual title

Set the manual title. If the option is not invoked, the name of the first module will be used as the title of the manual.

-silent

Don't output any status message.

-man

Output podmanual's manpage and exit.

-help

Output podmanual's usage and exit.

VERSION ^

This document describes podmanual version 0.08

SEE ALSO ^

Pod::Manual

BUGS ^

Please send bug reports to <bug-pod-manual@rt.cpan.org>, or via the web interface at http://rt.cpan.org/Public/Dist/Display.html?Name=Pod-Manual.

LICENSE ^

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHOR ^

Yanick Champoux, <yanick@cpan.org>

syntax highlighting: