Linux Commands Examples

A great documentation place for Linux commands

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>

add an example, a script, a trick and tips

: email address (won't be displayed)
: name

Step 2

Thanks for this example ! - It will be moderated and published shortly.

Feel free to post other examples
Oops ! There is a tiny cockup. A damn 404 cockup. Please contact the loosy team who maintains and develops this wonderful site by clicking in the mighty feedback button on the side of the page. Say what happened. Thanks!

examples

0
source
            
pod2html Seamstress.pod
0
source
            
pod2text Changes.pod > Changes.pod.txt
pod2html Changes.pod > Changes.pod.html

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

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

copyright

This program is distributed under the Artistic License.


bugs

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


see also

perlpod, Pod::Html


author

Tom Christiansen, <tchrist[:at:]perl[:dot:]com>.

How can this site be more helpful to YOU ?


give  feedback