Debian Codegraph @

upstream/opensuse-tumbleweed/man1/pod2html.1

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 "POD2HTML 1"
61 .TH POD2HTML 1 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 pod2html \- convert .pod files to .html files
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 8
71 \& pod2html \-\-help \-\-htmldir=<name> \-\-htmlroot=<URL>
72 \& \-\-infile=<name> \-\-outfile=<name>
73 \& \-\-podpath=<name>:...:<name> \-\-podroot=<name>
74 \& \-\-cachedir=<name> \-\-flush \-\-recurse \-\-norecurse
75 \& \-\-quiet \-\-noquiet \-\-verbose \-\-noverbose
76 \& \-\-index \-\-noindex \-\-backlink \-\-nobacklink
77 \& \-\-header \-\-noheader \-\-poderrors \-\-nopoderrors
78 \& \-\-css=<URL> \-\-title=<name>
79 .Ve
80 .SH DESCRIPTION
81 .IX Header "DESCRIPTION"
82 Converts files from pod format (see perlpod) to HTML format.
83 .SH ARGUMENTS
84 .IX Header "ARGUMENTS"
85 pod2html takes the following arguments:
86 .IP backlink 4
87 .IX Item "backlink"
88 .Vb 2
89 \& \-\-backlink
90 \& \-\-nobacklink
91 .Ve
92 .Sp
93 Turn =head1 directives into links pointing to the top of the HTML file.
94 \&\-\-nobacklink (which is the default behavior) does not create these backlinks.
95 .IP cachedir 4
96 .IX Item "cachedir"
97 .Vb 1
98 \& \-\-cachedir=name
99 .Ve
100 .Sp
101 Specify which directory is used for storing cache. Default directory is the
102 current working directory.
103 .IP css 4
104 .IX Item "css"
105 .Vb 1
106 \& \-\-css=URL
107 .Ve
108 .Sp
109 Specify the URL of cascading style sheet to link from resulting HTML file.
110 Default is none style sheet.
111 .IP flush 4
112 .IX Item "flush"
113 .Vb 1
114 \& \-\-flush
115 .Ve
116 .Sp
117 Flush the cache.
118 .IP header 4
119 .IX Item "header"
120 .Vb 2
121 \& \-\-header
122 \& \-\-noheader
123 .Ve
124 .Sp
125 Create header and footer blocks containing the text of the "NAME" section.
126 \&\-\-noheader \-\- which is the default behavior \-\- does not create header or footer
127 blocks.
128 .IP help 4
129 .IX Item "help"
130 .Vb 1
131 \& \-\-help
132 .Ve
133 .Sp
134 Displays the usage message.
135 .IP htmldir 4
136 .IX Item "htmldir"
137 .Vb 1
138 \& \-\-htmldir=name
139 .Ve
140 .Sp
141 Sets the directory to which all cross references in the resulting HTML file
142 will be relative. Not passing this causes all links to be absolute since this
143 is the value that tells Pod::Html the root of the documentation tree.
144 .Sp
145 Do not use this and \-\-htmlroot in the same call to pod2html; they are mutually
146 exclusive.
147 .IP htmlroot 4
148 .IX Item "htmlroot"
149 .Vb 1
150 \& \-\-htmlroot=URL
151 .Ve
152 .Sp
153 Sets the base URL for the HTML files. When cross\-references are made, the
154 HTML root is prepended to the URL.
155 .Sp
156 Do not use this if relative links are desired: use \-\-htmldir instead.
157 .Sp
158 Do not pass both this and \-\-htmldir to pod2html; they are mutually exclusive.
159 .IP index 4
160 .IX Item "index"
161 .Vb 1
162 \& \-\-index
163 .Ve
164 .Sp
165 Generate an index at the top of the HTML file (default behaviour).
166 .RS 4
167 .IP noindex 4
168 .IX Item "noindex"
169 .Vb 1
170 \& \-\-noindex
171 .Ve
172 .Sp
173 Do not generate an index at the top of the HTML file.
174 .RE
175 .RS 4
176 .RE
177 .IP infile 4
178 .IX Item "infile"
179 .Vb 1
180 \& \-\-infile=name
181 .Ve
182 .Sp
183 Specify the pod file to convert. Input is taken from STDIN if no
184 infile is specified.
185 .IP outfile 4
186 .IX Item "outfile"
187 .Vb 1
188 \& \-\-outfile=name
189 .Ve
190 .Sp
191 Specify the HTML file to create. Output goes to STDOUT if no outfile
192 is specified.
193 .IP poderrors 4
194 .IX Item "poderrors"
195 .Vb 2
196 \& \-\-poderrors
197 \& \-\-nopoderrors
198 .Ve
199 .Sp
200 Include a "POD ERRORS" section in the outfile if there were any POD errors in
201 the infile (default behaviour). \-\-nopoderrors does not create this "POD
202 ERRORS" section.
203 .IP podpath 4
204 .IX Item "podpath"
205 .Vb 1
206 \& \-\-podpath=name:...:name
207 .Ve
208 .Sp
209 Specify which subdirectories of the podroot contain pod files whose
210 HTML converted forms can be linked\-to in cross\-references.
211 .IP podroot 4
212 .IX Item "podroot"
213 .Vb 1
214 \& \-\-podroot=name
215 .Ve
216 .Sp
217 Specify the base directory for finding library pods.
218 .IP quiet 4
219 .IX Item "quiet"
220 .Vb 2
221 \& \-\-quiet
222 \& \-\-noquiet
223 .Ve
224 .Sp
225 Don\*(Aqt display mostly harmless warning messages. \-\-noquiet \-\- which is the
226 default behavior \-\- \fIdoes\fR display these mostly harmless warning messages (but
227 this is not the same as "verbose" mode).
228 .IP recurse 4
229 .IX Item "recurse"
230 .Vb 2
231 \& \-\-recurse
232 \& \-\-norecurse
233 .Ve
234 .Sp
235 Recurse into subdirectories specified in podpath (default behaviour).
236 \&\-\-norecurse does not recurse into these subdirectories.
237 .IP title 4
238 .IX Item "title"
239 .Vb 1
240 \& \-\-title=title
241 .Ve
242 .Sp
243 Specify the title of the resulting HTML file.
244 .IP verbose 4
245 .IX Item "verbose"
246 .Vb 2
247 \& \-\-verbose
248 \& \-\-noverbose
249 .Ve
250 .Sp
251 Display progress messages. \-\-noverbose \-\- which is the default behavior \-\-
252 does not display these progress messages.
253 .SH AUTHOR
254 .IX Header "AUTHOR"
255 Tom Christiansen, <[email protected]>.
256 .SH BUGS
257 .IX Header "BUGS"
258 See Pod::Html for a list of known bugs in the translator.
259 .SH "SEE ALSO"
260 .IX Header "SEE ALSO"
261 perlpod, Pod::Html
262 .SH COPYRIGHT
263 .IX Header "COPYRIGHT"
264 This program is distributed under the Artistic License.