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