man pages section 1: User Commands

Exit Print View

Updated: July 2014
 
 

pod2html (1)

Name

pod2html - convert .pod files to .html files

Synopsis

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

Description




Perl Programmers Reference Guide                      POD2HTML(1)



NAME
     pod2html - convert .pod files to .html files

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

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

ARGUMENTS
     pod2html takes the following arguments:

     help
           --help

         Displays the usage message.

     htmlroot
           --htmlroot=name

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

     infile
           --infile=name

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

     outfile
           --outfile=name

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

     podroot
           --podroot=name

         Specify the base directory for finding library pods.

     podpath
           --podpath=name:...:name

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

     libpods



perl v5.12.5         Last change: 2014-06-17                    1






Perl Programmers Reference Guide                      POD2HTML(1)



           --libpods=name:...:name

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

     netscape
           --netscape

         Use Netscape HTML directives when applicable.

     nonetscape
           --nonetscape

         Do not use Netscape HTML directives (default).

     index
           --index

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

     noindex
           --noindex

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

     recurse
           --recurse

         Recurse into subdirectories specified in podpath
         (default behaviour).

     norecurse
           --norecurse

         Do not recurse into subdirectories specified in podpath.

     title
           --title=title

         Specify the title of the resulting HTML file.

     verbose
           --verbose

         Display progress messages.

AUTHOR
     Tom Christiansen, <tchrist@perl.com>.

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



perl v5.12.5         Last change: 2014-06-17                    2






Perl Programmers Reference Guide                      POD2HTML(1)



ATTRIBUTES
     See attributes(5) for descriptions of the following
     attributes:

     +---------------+------------------+
     |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
     +---------------+------------------+
     |Availability   | runtime/perl-512 |
     +---------------+------------------+
     |Stability      | Uncommitted      |
     +---------------+------------------+
SEE ALSO
     perlpod, Pod::Html

COPYRIGHT
     This program is distributed under the Artistic License.



NOTES
     This software was built from source available at
     https://java.net/projects/solaris-userland.  The original
     community source was downloaded from
     http://www.cpan.org/src/5.0/perl-5.12.5.tar.bz2

     Further information about this software can be found on the
     open source community website at http://www.perl.org/.




























perl v5.12.5         Last change: 2014-06-17                    3