Pod::Html(3pm)

1Pod::Html(3pm)         Perl Programmers Reference Guide         Pod::Html(3pm)
2
3
4

NAME

6       Pod::Html - module to convert pod files to HTML
7

SYNOPSIS

9           use Pod::Html;
10           pod2html([options]);
11

DESCRIPTION

13       Converts files from pod format (see perlpod) to HTML format.  It can
14       automatically generate indexes and cross-references, and it keeps a
15       cache of things it knows how to cross-reference.
16

FUNCTIONS

18   pod2html
19           pod2html("pod2html",
20                    "--podpath=lib:ext:pod:vms",
21                    "--podroot=/usr/src/perl",
22                    "--htmlroot=/perl/nmanual",
23                    "--recurse",
24                    "--infile=foo.pod",
25                    "--outfile=/perl/nmanual/foo.html");
26
27       pod2html takes the following arguments:
28
29       backlink
30               --backlink
31
32           Turns every "head1" heading into a link back to the top of the
33           page.  By default, no backlinks are generated.
34
35       cachedir
36               --cachedir=name
37
38           Creates the directory cache in the given directory.
39
40       css
41               --css=stylesheet
42
43           Specify the URL of a cascading style sheet.  Also disables all
44           HTML/CSS "style" attributes that are output by default (to avoid
45           conflicts).
46
47       flush
48               --flush
49
50           Flushes the directory cache.
51
52       header
53               --header
54               --noheader
55
56           Creates header and footer blocks containing the text of the "NAME"
57           section.  By default, no headers are generated.
58
59       help
60               --help
61
62           Displays the usage message.
63
64       htmldir
65               --htmldir=name
66
67           Sets the directory to which all cross references in the resulting
68           html file will be relative. Not passing this causes all links to be
69           absolute since this is the value that tells Pod::Html the root of
70           the documentation tree.
71
72           Do not use this and --htmlroot in the same call to pod2html; they
73           are mutually exclusive.
74
75       htmlroot
76               --htmlroot=name
77
78           Sets the base URL for the HTML files.  When cross-references are
79           made, the HTML root is prepended to the URL.
80
81           Do not use this if relative links are desired: use --htmldir
82           instead.
83
84           Do not pass both this and --htmldir to pod2html; they are mutually
85           exclusive.
86
87       index
88               --index
89               --noindex
90
91           Generate an index at the top of the HTML file.  This is the default
92           behaviour.
93
94       infile
95               --infile=name
96
97           Specify the pod file to convert.  Input is taken from STDIN if no
98           infile is specified.
99
100       outfile
101               --outfile=name
102
103           Specify the HTML file to create.  Output goes to STDOUT if no
104           outfile is specified.
105
106       poderrors
107               --poderrors
108               --nopoderrors
109
110           Include a "POD ERRORS" section in the outfile if there were any POD
111           errors in the infile. This section is included by default.
112
113       podpath
114               --podpath=name:...:name
115
116           Specify which subdirectories of the podroot contain pod files whose
117           HTML converted forms can be linked to in cross references.
118
119       podroot
120               --podroot=name
121
122           Specify the base directory for finding library pods. Default is the
123           current working directory.
124
125       quiet
126               --quiet
127               --noquiet
128
129           Don't display mostly harmless warning messages.  These messages
130           will be displayed by default.  But this is not the same as
131           "verbose" mode.
132
133       recurse
134               --recurse
135               --norecurse
136
137           Recurse into subdirectories specified in podpath (default
138           behaviour).
139
140       title
141               --title=title
142
143           Specify the title of the resulting HTML file.
144
145       verbose
146               --verbose
147               --noverbose
148
149           Display progress messages.  By default, they won't be displayed.
150
151   Formerly Exported Auxiliary Functions
152       Prior to perl-5.36, the following three functions were exported by
153       Pod::Html, either by default or on request:
154
155       •   htmlify() (by default)
156
157       •   anchorify() (upon request)
158
159       •   relativize_url() (upon request)
160
161       The definition and documentation of these functions have been moved to
162       Pod::Html::Util, viewable via "perldoc Pod::Html::Util".
163
164       Beginning with perl-5.38 these functions must be explicitly imported
165       from Pod::Html::Util.  Please modify your code as needed.
166

ENVIRONMENT

168       Uses $Config{pod2html} to setup default options.
169

AUTHOR

171       Marc Green, <marcgreen@cpan.org>.
172
173       Original version by Tom Christiansen, <tchrist@perl.com>.
174

COPYRIGHT

179       This program is distributed under the Artistic License.
180
181
182
183perl v5.38.2                      2023-11-30                    Pod::Html(3pm)