John McNamara > App-Pod2Epub > pod2epub

Download:
App-Pod2Epub-0.05.tar.gz

Annotate this POD

Website

View/Report Bugs
Source  

NAME ^

pod2epub - A utility to convert Pod to an ePub eBook.

SYNOPSIS ^

pod2epub [options] podfile --outfile file.epub

    Main options (see manpage for all options):
        -o --outfile    Name of output ePub file.
        -t --title      Add ePub book title.
        -a --author     Add ePub book author.
        -s --stylesheet Change the default stylesheet.
        -c --cover      Add cover image.
        -h --help       Print a brief help message.
        -m --man        Print the full manpage.

    Example:
        pod2epub some_module.pm -o some_module.epub

DESCRIPTION ^

This program is used for converting Pod documents to ePub eBooks. The output eBook can be read on a variety of hardware and software eBook readers.

Pod is Perl's Plain Old Documentation format, see http://perldoc.perl.org/perlpod.html. EPub is an eBook format, see http://en.wikipedia.org/wiki/Epub.

OPTIONS ^

podfile

The input file containing Pod documentation.

-o or --outfile

The output ePub file. This is a required argument.

-s or --stylesheet

Specify the CSS stylesheet that the ePub eBook will use. If none is supplied the following minimal stylesheet is used:

    h1         { font-size: 110%; }
    h2, h3, h4 { font-size: 100%; }
-c or --cover

Add an image for use as a book cover.

-t or --title

Add the ePub book title. Defaults to "Pod Document". A future release will parse this from the Pod document where possible.

-a or --author

Add the ePub book author. Defaults to "Perl Author". A future release will parse this from the Pod document where possible.

-h or --help

Print a brief help message and exit.

SECONDARY OPTIONS ^

-x or --xhtml-only

Output the Pod documentation in XHTML format without converting it ePub. This can be useful for debugging XHTML errors.

-l or --language

Add the ePub book language. Defaults to "en".

-m or --man

Prints the manpage and exit.

-v or --version

Prints the version of the pod2epub application.

-e or --errata

Generate a "Pod Errors" section at the end of the document if there are Pod errors. This is the default. To turn this feature off use --no-errata or -no-e. Equivalent to the Pod::Simple no_errata_section() method.

TODO ^

AUTHOR ^

John McNamara jmcnamara@cpan.org

COPYRIGHT ^

© MMXII, John McNamara.

All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.

syntax highlighting: