1POD2HTML(1)            Perl Programmers Reference Guide            POD2HTML(1)
2
3
4

NAME

6       pod2html - convert .pod files to .html files
7

SYNOPSIS

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

DESCRIPTION

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

ARGUMENTS

18       pod2html takes the following arguments:
19
20       help
21             --help
22
23           Displays the usage message.
24
25       htmlroot
26             --htmlroot=name
27
28           Sets the base URL for the HTML files.  When cross-references are
29           made, the HTML root is prepended to the URL.
30
31       infile
32             --infile=name
33
34           Specify the pod file to convert.  Input is taken from STDIN if no
35           infile is specified.
36
37       outfile
38             --outfile=name
39
40           Specify the HTML file to create.  Output goes to STDOUT if no out‐
41           file is specified.
42
43       podroot
44             --podroot=name
45
46           Specify the base directory for finding library pods.
47
48       podpath
49             --podpath=name:...:name
50
51           Specify which subdirectories of the podroot contain pod files whose
52           HTML converted forms can be linked-to in cross-references.
53
54       libpods
55             --libpods=name:...:name
56
57           List of page names (eg, "perlfunc") which contain linkable
58           "=item"s.
59
60       netscape
61             --netscape
62
63           Use Netscape HTML directives when applicable.
64
65       nonetscape
66             --nonetscape
67
68           Do not use Netscape HTML directives (default).
69
70       index
71             --index
72
73           Generate an index at the top of the HTML file (default behaviour).
74
75       noindex
76             --noindex
77
78           Do not generate an index at the top of the HTML file.
79
80       recurse
81             --recurse
82
83           Recurse into subdirectories specified in podpath (default behav‐
84           iour).
85
86       norecurse
87             --norecurse
88
89           Do not recurse into subdirectories specified in podpath.
90
91       title
92             --title=title
93
94           Specify the title of the resulting HTML file.
95
96       verbose
97             --verbose
98
99           Display progress messages.
100

AUTHOR

102       Tom Christiansen, <tchrist@perl.com>.
103

BUGS

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

SEE ALSO

108       perlpod, Pod::Html
109

111       This program is distributed under the Artistic License.
112
113
114
115perl v5.8.8                       2008-05-05                       POD2HTML(1)
Impressum