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 --htmldir=<name> --htmlroot=<URL>
10                    --infile=<name> --outfile=<name>
11                    --podpath=<name>:...:<name> --podroot=<name>
12                    --cachedir=<name> --flush --recurse --norecurse
13                    --quiet --noquiet --verbose --noverbose
14                    --index --noindex --backlink --nobacklink
15                    --header --noheader --poderrors --nopoderrors
16                    --css=<URL> --title=<name>
17

DESCRIPTION

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

ARGUMENTS

22       pod2html takes the following arguments:
23
24       help
25             --help
26
27           Displays the usage message.
28
29       htmldir
30             --htmldir=name
31
32           Sets the directory to which all cross references in the resulting
33           HTML file will be relative. Not passing this causes all links to be
34           absolute since this is the value that tells Pod::Html the root of
35           the documentation tree.
36
37           Do not use this and --htmlroot in the same call to pod2html; they
38           are mutually exclusive.
39
40       htmlroot
41             --htmlroot=URL
42
43           Sets the base URL for the HTML files.  When cross-references are
44           made, the HTML root is prepended to the URL.
45
46           Do not use this if relative links are desired: use --htmldir
47           instead.
48
49           Do not pass both this and --htmldir to pod2html; they are mutually
50           exclusive.
51
52       infile
53             --infile=name
54
55           Specify the pod file to convert.  Input is taken from STDIN if no
56           infile is specified.
57
58       outfile
59             --outfile=name
60
61           Specify the HTML file to create.  Output goes to STDOUT if no
62           outfile is specified.
63
64       podroot
65             --podroot=name
66
67           Specify the base directory for finding library pods.
68
69       podpath
70             --podpath=name:...:name
71
72           Specify which subdirectories of the podroot contain pod files whose
73           HTML converted forms can be linked-to in cross-references.
74
75       cachedir
76             --cachedir=name
77
78           Specify which directory is used for storing cache. Default
79           directory is the current working directory.
80
81       flush
82             --flush
83
84           Flush the cache.
85
86       backlink
87             --backlink
88
89           Turn =head1 directives into links pointing to the top of the HTML
90           file.
91
92       nobacklink
93             --nobacklink
94
95           Do not turn =head1 directives into links pointing to the top of the
96           HTML file (default behaviour).
97
98       header
99             --header
100
101           Create header and footer blocks containing the text of the "NAME"
102           section.
103
104       noheader
105             --noheader
106
107           Do not create header and footer blocks containing the text of the
108           "NAME" section (default behaviour).
109
110       poderrors
111             --poderrors
112
113           Include a "POD ERRORS" section in the outfile if there were any POD
114           errors in the infile (default behaviour).
115
116       nopoderrors
117             --nopoderrors
118
119           Do not include a "POD ERRORS" section in the outfile if there were
120           any POD errors in the infile.
121
122       index
123             --index
124
125           Generate an index at the top of the HTML file (default behaviour).
126
127       noindex
128             --noindex
129
130           Do not generate an index at the top of the HTML file.
131
132       recurse
133             --recurse
134
135           Recurse into subdirectories specified in podpath (default
136           behaviour).
137
138       norecurse
139             --norecurse
140
141           Do not recurse into subdirectories specified in podpath.
142
143       css
144             --css=URL
145
146           Specify the URL of cascading style sheet to link from resulting
147           HTML file.  Default is none style sheet.
148
149       title
150             --title=title
151
152           Specify the title of the resulting HTML file.
153
154       quiet
155             --quiet
156
157           Don't display mostly harmless warning messages.
158
159       noquiet
160             --noquiet
161
162           Display mostly harmless warning messages (default behaviour). But
163           this is not the same as "verbose" mode.
164
165       verbose
166             --verbose
167
168           Display progress messages.
169
170       noverbose
171             --noverbose
172
173           Do not display progress messages (default behaviour).
174

AUTHOR

176       Tom Christiansen, <tchrist@perl.com>.
177

BUGS

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

SEE ALSO

182       perlpod, Pod::Html
183

185       This program is distributed under the Artistic License.
186
187
188
189perl v5.36.0                      2022-08-30                       POD2HTML(1)
Impressum