D7net
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
usr
/
local
/
lp
/
sonarperl
/
man
/
man1
/
Filename :
pod2html.1
back
Copy
.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "POD2HTML 1" .TH POD2HTML 1 2025-02-14 "perl v5.38.0" "Perl Programmers Reference Guide" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME pod2html \- convert .pod files to .html files .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 8 \& pod2html \-\-help \-\-htmldir=<name> \-\-htmlroot=<URL> \& \-\-infile=<name> \-\-outfile=<name> \& \-\-podpath=<name>:...:<name> \-\-podroot=<name> \& \-\-cachedir=<name> \-\-flush \-\-recurse \-\-norecurse \& \-\-quiet \-\-noquiet \-\-verbose \-\-noverbose \& \-\-index \-\-noindex \-\-backlink \-\-nobacklink \& \-\-header \-\-noheader \-\-poderrors \-\-nopoderrors \& \-\-css=<URL> \-\-title=<name> .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" Converts files from pod format (see perlpod) to HTML format. .SH ARGUMENTS .IX Header "ARGUMENTS" pod2html takes the following arguments: .IP backlink 4 .IX Item "backlink" .Vb 2 \& \-\-backlink \& \-\-nobacklink .Ve .Sp Turn =head1 directives into links pointing to the top of the HTML file. \&\-\-nobacklink (which is the default behavior) does not create these backlinks. .IP cachedir 4 .IX Item "cachedir" .Vb 1 \& \-\-cachedir=name .Ve .Sp Specify which directory is used for storing cache. Default directory is the current working directory. .IP css 4 .IX Item "css" .Vb 1 \& \-\-css=URL .Ve .Sp Specify the URL of cascading style sheet to link from resulting HTML file. Default is none style sheet. .IP flush 4 .IX Item "flush" .Vb 1 \& \-\-flush .Ve .Sp Flush the cache. .IP header 4 .IX Item "header" .Vb 2 \& \-\-header \& \-\-noheader .Ve .Sp Create header and footer blocks containing the text of the "NAME" section. \&\-\-noheader \-\- which is the default behavior \-\- does not create header or footer blocks. .IP help 4 .IX Item "help" .Vb 1 \& \-\-help .Ve .Sp Displays the usage message. .IP htmldir 4 .IX Item "htmldir" .Vb 1 \& \-\-htmldir=name .Ve .Sp Sets the directory to which all cross references in the resulting HTML file will be relative. Not passing this causes all links to be absolute since this is the value that tells Pod::Html the root of the documentation tree. .Sp Do not use this and \-\-htmlroot in the same call to pod2html; they are mutually exclusive. .IP htmlroot 4 .IX Item "htmlroot" .Vb 1 \& \-\-htmlroot=URL .Ve .Sp Sets the base URL for the HTML files. When cross-references are made, the HTML root is prepended to the URL. .Sp Do not use this if relative links are desired: use \-\-htmldir instead. .Sp Do not pass both this and \-\-htmldir to pod2html; they are mutually exclusive. .IP index 4 .IX Item "index" .Vb 1 \& \-\-index .Ve .Sp Generate an index at the top of the HTML file (default behaviour). .RS 4 .IP noindex 4 .IX Item "noindex" .Vb 1 \& \-\-noindex .Ve .Sp Do not generate an index at the top of the HTML file. .RE .RS 4 .RE .IP infile 4 .IX Item "infile" .Vb 1 \& \-\-infile=name .Ve .Sp Specify the pod file to convert. Input is taken from STDIN if no infile is specified. .IP outfile 4 .IX Item "outfile" .Vb 1 \& \-\-outfile=name .Ve .Sp Specify the HTML file to create. Output goes to STDOUT if no outfile is specified. .IP poderrors 4 .IX Item "poderrors" .Vb 2 \& \-\-poderrors \& \-\-nopoderrors .Ve .Sp Include a "POD ERRORS" section in the outfile if there were any POD errors in the infile (default behaviour). \-\-nopoderrors does not create this "POD ERRORS" section. .IP podpath 4 .IX Item "podpath" .Vb 1 \& \-\-podpath=name:...:name .Ve .Sp Specify which subdirectories of the podroot contain pod files whose HTML converted forms can be linked-to in cross-references. .IP podroot 4 .IX Item "podroot" .Vb 1 \& \-\-podroot=name .Ve .Sp Specify the base directory for finding library pods. .IP quiet 4 .IX Item "quiet" .Vb 2 \& \-\-quiet \& \-\-noquiet .Ve .Sp Don't display mostly harmless warning messages. \-\-noquiet \-\- which is the default behavior \-\- \fIdoes\fR display these mostly harmless warning messages (but this is not the same as "verbose" mode). .IP recurse 4 .IX Item "recurse" .Vb 2 \& \-\-recurse \& \-\-norecurse .Ve .Sp Recurse into subdirectories specified in podpath (default behaviour). \&\-\-norecurse does not recurse into these subdirectories. .IP title 4 .IX Item "title" .Vb 1 \& \-\-title=title .Ve .Sp Specify the title of the resulting HTML file. .IP verbose 4 .IX Item "verbose" .Vb 2 \& \-\-verbose \& \-\-noverbose .Ve .Sp Display progress messages. \-\-noverbose \-\- which is the default behavior \-\- does not display these progress messages. .SH AUTHOR .IX Header "AUTHOR" Tom Christiansen, <tchrist@perl.com>. .SH BUGS .IX Header "BUGS" See Pod::Html for a list of known bugs in the translator. .SH "SEE ALSO" .IX Header "SEE ALSO" perlpod, Pod::Html .SH COPYRIGHT .IX Header "COPYRIGHT" This program is distributed under the Artistic License.