Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Pod::Html.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Pod::Html 3pm"
61 .TH Pod::Html 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Pod::Html \- module to convert pod files to HTML
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 2
71 \& use Pod::Html;
72 \& pod2html([options]);
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 Converts files from pod format (see perlpod) to HTML format. It
77 can automatically generate indexes and cross\-references, and it keeps
78 a cache of things it knows how to cross\-reference.
79 .SH FUNCTIONS
80 .IX Header "FUNCTIONS"
81 .SS pod2html
82 .IX Subsection "pod2html"
83 .Vb 7
84 \& pod2html("pod2html",
85 \& "\-\-podpath=lib:ext:pod:vms",
86 \& "\-\-podroot=/usr/src/perl",
87 \& "\-\-htmlroot=/perl/nmanual",
88 \& "\-\-recurse",
89 \& "\-\-infile=foo.pod",
90 \& "\-\-outfile=/perl/nmanual/foo.html");
91 .Ve
92 .PP
93 pod2html takes the following arguments:
94 .IP backlink 4
95 .IX Item "backlink"
96 .Vb 1
97 \& \-\-backlink
98 .Ve
99 .Sp
100 Turns every \f(CW\*(C`head1\*(C'\fR heading into a link back to the top of the page.
101 By default, no backlinks are generated.
102 .IP cachedir 4
103 .IX Item "cachedir"
104 .Vb 1
105 \& \-\-cachedir=name
106 .Ve
107 .Sp
108 Creates the directory cache in the given directory.
109 .IP css 4
110 .IX Item "css"
111 .Vb 1
112 \& \-\-css=stylesheet
113 .Ve
114 .Sp
115 Specify the URL of a cascading style sheet. Also disables all HTML/CSS
116 \&\f(CW\*(C`style\*(C'\fR attributes that are output by default (to avoid conflicts).
117 .IP flush 4
118 .IX Item "flush"
119 .Vb 1
120 \& \-\-flush
121 .Ve
122 .Sp
123 Flushes the directory cache.
124 .IP header 4
125 .IX Item "header"
126 .Vb 2
127 \& \-\-header
128 \& \-\-noheader
129 .Ve
130 .Sp
131 Creates header and footer blocks containing the text of the \f(CW\*(C`NAME\*(C'\fR
132 section. By default, no headers are generated.
133 .IP help 4
134 .IX Item "help"
135 .Vb 1
136 \& \-\-help
137 .Ve
138 .Sp
139 Displays the usage message.
140 .IP htmldir 4
141 .IX Item "htmldir"
142 .Vb 1
143 \& \-\-htmldir=name
144 .Ve
145 .Sp
146 Sets the directory to which all cross references in the resulting
147 html file will be relative. Not passing this causes all links to be
148 absolute since this is the value that tells Pod::Html the root of the
149 documentation tree.
150 .Sp
151 Do not use this and \-\-htmlroot in the same call to pod2html; they are
152 mutually exclusive.
153 .IP htmlroot 4
154 .IX Item "htmlroot"
155 .Vb 1
156 \& \-\-htmlroot=name
157 .Ve
158 .Sp
159 Sets the base URL for the HTML files. When cross\-references are made,
160 the HTML root is prepended to the URL.
161 .Sp
162 Do not use this if relative links are desired: use \-\-htmldir instead.
163 .Sp
164 Do not pass both this and \-\-htmldir to pod2html; they are mutually
165 exclusive.
166 .IP index 4
167 .IX Item "index"
168 .Vb 2
169 \& \-\-index
170 \& \-\-noindex
171 .Ve
172 .Sp
173 Generate an index at the top of the HTML file. This is the default
174 behaviour.
175 .IP infile 4
176 .IX Item "infile"
177 .Vb 1
178 \& \-\-infile=name
179 .Ve
180 .Sp
181 Specify the pod file to convert. Input is taken from STDIN if no
182 infile is specified.
183 .IP outfile 4
184 .IX Item "outfile"
185 .Vb 1
186 \& \-\-outfile=name
187 .Ve
188 .Sp
189 Specify the HTML file to create. Output goes to STDOUT if no outfile
190 is specified.
191 .IP poderrors 4
192 .IX Item "poderrors"
193 .Vb 2
194 \& \-\-poderrors
195 \& \-\-nopoderrors
196 .Ve
197 .Sp
198 Include a "POD ERRORS" section in the outfile if there were any POD
199 errors in the infile. This section is included by default.
200 .IP podpath 4
201 .IX Item "podpath"
202 .Vb 1
203 \& \-\-podpath=name:...:name
204 .Ve
205 .Sp
206 Specify which subdirectories of the podroot contain pod files whose
207 HTML converted forms can be linked to in cross references.
208 .IP podroot 4
209 .IX Item "podroot"
210 .Vb 1
211 \& \-\-podroot=name
212 .Ve
213 .Sp
214 Specify the base directory for finding library pods. Default is the
215 current working directory.
216 .IP quiet 4
217 .IX Item "quiet"
218 .Vb 2
219 \& \-\-quiet
220 \& \-\-noquiet
221 .Ve
222 .Sp
223 Don\*(Aqt display \fImostly harmless\fR warning messages. These messages
224 will be displayed by default. But this is not the same as \f(CW\*(C`verbose\*(C'\fR
225 mode.
226 .IP recurse 4
227 .IX Item "recurse"
228 .Vb 2
229 \& \-\-recurse
230 \& \-\-norecurse
231 .Ve
232 .Sp
233 Recurse into subdirectories specified in podpath (default behaviour).
234 .IP title 4
235 .IX Item "title"
236 .Vb 1
237 \& \-\-title=title
238 .Ve
239 .Sp
240 Specify the title of the resulting HTML file.
241 .IP verbose 4
242 .IX Item "verbose"
243 .Vb 2
244 \& \-\-verbose
245 \& \-\-noverbose
246 .Ve
247 .Sp
248 Display progress messages. By default, they won\*(Aqt be displayed.
249 .SS "Formerly Exported Auxiliary Functions"
250 .IX Subsection "Formerly Exported Auxiliary Functions"
251 Prior to perl\-5.36, the following three functions were exported by
252 \&\fIPod::Html\fR, either by default or on request:
253 .IP \(bu 4
254 \&\f(CWhtmlify()\fR (by default)
255 .IP \(bu 4
256 \&\f(CWanchorify()\fR (upon request)
257 .IP \(bu 4
258 \&\f(CWrelativize_url()\fR (upon request)
259 .PP
260 The definition and documentation of these functions have been moved to
261 \&\fIPod::Html::Util\fR, viewable via \f(CW\*(C`perldoc Pod::Html::Util\*(C'\fR.
262 .PP
263 Beginning with perl\-5.38 these functions must be explicitly imported from
264 \&\fIPod::Html::Util\fR. Please modify your code as needed.
265 .SH ENVIRONMENT
266 .IX Header "ENVIRONMENT"
267 Uses \f(CW$Config{pod2html}\fR to setup default options.
268 .SH AUTHOR
269 .IX Header "AUTHOR"
270 Marc Green, <[email protected]>.
271 .PP
272 Original version by Tom Christiansen, <[email protected]>.
273 .SH "SEE ALSO"
274 .IX Header "SEE ALSO"
275 perlpod
276 .SH COPYRIGHT
277 .IX Header "COPYRIGHT"
278 This program is distributed under the Artistic License.