Perl version

Modules

  • ABCDE
  • FGHIL
  • MNOPS
  • TUX

pod2html

Perl 5 version 8.8 documentation
Recently read

pod2html

NAME

pod2html - convert .pod files to .html files

SYNOPSIS

  1. pod2html --help --htmlroot=<name> --infile=<name> --outfile=<name>
  2. --podpath=<name>:...:<name> --podroot=<name>
  3. --libpods=<name>:...:<name> --recurse --norecurse --verbose
  4. --index --noindex --title=<name>

DESCRIPTION

Converts files from pod format (see perlpod) to HTML format.

ARGUMENTS

pod2html takes the following arguments:

  • help
    1. --help

    Displays the usage message.

  • htmlroot
    1. --htmlroot=name

    Sets the base URL for the HTML files. When cross-references are made, the HTML root is prepended to the URL.

  • infile
    1. --infile=name

    Specify the pod file to convert. Input is taken from STDIN if no infile is specified.

  • outfile
    1. --outfile=name

    Specify the HTML file to create. Output goes to STDOUT if no outfile is specified.

  • podroot
    1. --podroot=name

    Specify the base directory for finding library pods.

  • podpath
    1. --podpath=name:...:name

    Specify which subdirectories of the podroot contain pod files whose HTML converted forms can be linked-to in cross-references.

  • libpods
    1. --libpods=name:...:name

    List of page names (eg, "perlfunc") which contain linkable =item s.

  • netscape
    1. --netscape

    Use Netscape HTML directives when applicable.

  • nonetscape
    1. --nonetscape

    Do not use Netscape HTML directives (default).

  • index
    1. --index

    Generate an index at the top of the HTML file (default behaviour).

  • noindex
    1. --noindex

    Do not generate an index at the top of the HTML file.

  • recurse
    1. --recurse

    Recurse into subdirectories specified in podpath (default behaviour).

  • norecurse
    1. --norecurse

    Do not recurse into subdirectories specified in podpath.

  • title
    1. --title=title

    Specify the title of the resulting HTML file.

  • verbose
    1. --verbose

    Display progress messages.

AUTHOR

Tom Christiansen, <tchrist@perl.com>.

BUGS

See Pod::Html for a list of known bugs in the translator.

SEE ALSO

perlpod, Pod::Html

COPYRIGHT

This program is distributed under the Artistic License.