Debian Codegraph @

upstream/debian-unstable/man3/Pod::Html.3perl

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