ASPN ActiveState Programmer Network
  ActiveState
/ Home / Perl / PHP / Python / Tcl / XSLT /
/ Safari / My ASPN /
Cookbooks | Documentation | Mailing Lists | Modules | News Feeds | Products | User Groups | Web Services
SEARCH
advanced | search help

Reference
ActivePerl 5.8
Programs
a2p
ap-update-html
c2ph
cpan
dbilogstrip
dbiprof
dbiproxy
dprofpp
enc2xs
exetype
find2perl
h2ph
h2xs
instmodsh
libnetcfg
lwp-download
lwp-mirror
lwp-request
lwp-rget
perlbug
perlcc
perlglob
perlivp
piconv
pl2bat
pl2pm
pod2html
pod2latex
pod2man
pod2text
pod2usage
podchecker
podselect
ppm
prove
psed
pstruct
ptar
ptardiff
ptked
ptksh
reloc perl
runperl
s2p
SOAPsh
splain
tkjpeg
tkx-ed
widget
XMLRPCsh
xsubpp

MyASPN >> Reference >> ActivePerl 5.8 >> Programs
ActivePerl 5.8 documentation

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 the perlpod manpage) 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 =items.

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 the Pod::Html manpage for a list of known bugs in the translator.


SEE ALSO

the perlpod manpage, the Pod::Html manpage


COPYRIGHT

This program is distributed under the Artistic License.


Privacy Policy | Email Opt-out | Feedback | Syndication
© ActiveState 2004 All rights reserved