D7net
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
usr
/
local
/
lp
/
sonarperl
/
man
/
man3
/
Filename :
Pod::Html.3
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 "Pod::Html 3" .TH Pod::Html 3 2023-05-26 "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 Pod::Html \- module to convert pod files to HTML .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 2 \& use Pod::Html; \& pod2html([options]); .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" Converts files from pod format (see perlpod) to HTML format. It can automatically generate indexes and cross-references, and it keeps a cache of things it knows how to cross-reference. .SH FUNCTIONS .IX Header "FUNCTIONS" .SS pod2html .IX Subsection "pod2html" .Vb 7 \& pod2html("pod2html", \& "\-\-podpath=lib:ext:pod:vms", \& "\-\-podroot=/usr/src/perl", \& "\-\-htmlroot=/perl/nmanual", \& "\-\-recurse", \& "\-\-infile=foo.pod", \& "\-\-outfile=/perl/nmanual/foo.html"); .Ve .PP pod2html takes the following arguments: .IP backlink 4 .IX Item "backlink" .Vb 1 \& \-\-backlink .Ve .Sp Turns every \f(CW\*(C`head1\*(C'\fR heading into a link back to the top of the page. By default, no backlinks are generated. .IP cachedir 4 .IX Item "cachedir" .Vb 1 \& \-\-cachedir=name .Ve .Sp Creates the directory cache in the given directory. .IP css 4 .IX Item "css" .Vb 1 \& \-\-css=stylesheet .Ve .Sp Specify the URL of a cascading style sheet. Also disables all HTML/CSS \&\f(CW\*(C`style\*(C'\fR attributes that are output by default (to avoid conflicts). .IP flush 4 .IX Item "flush" .Vb 1 \& \-\-flush .Ve .Sp Flushes the directory cache. .IP header 4 .IX Item "header" .Vb 2 \& \-\-header \& \-\-noheader .Ve .Sp Creates header and footer blocks containing the text of the \f(CW\*(C`NAME\*(C'\fR section. By default, no headers are generated. .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=name .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 2 \& \-\-index \& \-\-noindex .Ve .Sp Generate an index at the top of the HTML file. This is the default behaviour. .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. This section is included by default. .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. Default is the current working directory. .IP quiet 4 .IX Item "quiet" .Vb 2 \& \-\-quiet \& \-\-noquiet .Ve .Sp Don't display \fImostly harmless\fR warning messages. These messages will be displayed by default. But this is not the same as \f(CW\*(C`verbose\*(C'\fR mode. .IP recurse 4 .IX Item "recurse" .Vb 2 \& \-\-recurse \& \-\-norecurse .Ve .Sp Recurse into subdirectories specified in podpath (default behaviour). .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. By default, they won't be displayed. .SS "Formerly Exported Auxiliary Functions" .IX Subsection "Formerly Exported Auxiliary Functions" Prior to perl\-5.36, the following three functions were exported by \&\fIPod::Html\fR, either by default or on request: .IP \(bu 4 \&\f(CWhtmlify()\fR (by default) .IP \(bu 4 \&\f(CWanchorify()\fR (upon request) .IP \(bu 4 \&\f(CWrelativize_url()\fR (upon request) .PP The definition and documentation of these functions have been moved to \&\fIPod::Html::Util\fR, viewable via \f(CW\*(C`perldoc Pod::Html::Util\*(C'\fR. .PP Beginning with perl\-5.38 these functions must be explicitly imported from \&\fIPod::Html::Util\fR. Please modify your code as needed. .SH ENVIRONMENT .IX Header "ENVIRONMENT" Uses \f(CW$Config{pod2html}\fR to setup default options. .SH AUTHOR .IX Header "AUTHOR" Marc Green, <marcgreen@cpan.org>. .PP Original version by Tom Christiansen, <tchrist@perl.com>. .SH "SEE ALSO" .IX Header "SEE ALSO" perlpod .SH COPYRIGHT .IX Header "COPYRIGHT" This program is distributed under the Artistic License.