| Current File : //usr/local/apps/perl/man/man1/pod2html.1 |
.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "POD2HTML 1"
.TH POD2HTML 1 "2019-05-31" "perl v5.30.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 \s-1HTML\s0 format.
.SH "ARGUMENTS"
.IX Header "ARGUMENTS"
pod2html takes the following arguments:
.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 \s-1HTML\s0 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 \s-1URL\s0 for the \s-1HTML\s0 files. When cross-references are made, the
\&\s-1HTML\s0 root is prepended to the \s-1URL.\s0
.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 "infile" 4
.IX Item "infile"
.Vb 1
\& \-\-infile=name
.Ve
.Sp
Specify the pod file to convert. Input is taken from \s-1STDIN\s0 if no
infile is specified.
.IP "outfile" 4
.IX Item "outfile"
.Vb 1
\& \-\-outfile=name
.Ve
.Sp
Specify the \s-1HTML\s0 file to create. Output goes to \s-1STDOUT\s0 if no outfile
is specified.
.IP "podroot" 4
.IX Item "podroot"
.Vb 1
\& \-\-podroot=name
.Ve
.Sp
Specify the base directory for finding library pods.
.IP "podpath" 4
.IX Item "podpath"
.Vb 1
\& \-\-podpath=name:...:name
.Ve
.Sp
Specify which subdirectories of the podroot contain pod files whose
\&\s-1HTML\s0 converted forms can be linked-to in cross-references.
.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 "flush" 4
.IX Item "flush"
.Vb 1
\& \-\-flush
.Ve
.Sp
Flush the cache.
.IP "backlink" 4
.IX Item "backlink"
.Vb 1
\& \-\-backlink
.Ve
.Sp
Turn =head1 directives into links pointing to the top of the \s-1HTML\s0 file.
.IP "nobacklink" 4
.IX Item "nobacklink"
.Vb 1
\& \-\-nobacklink
.Ve
.Sp
Do not turn =head1 directives into links pointing to the top of the \s-1HTML\s0 file
(default behaviour).
.IP "header" 4
.IX Item "header"
.Vb 1
\& \-\-header
.Ve
.Sp
Create header and footer blocks containing the text of the \*(L"\s-1NAME\*(R"\s0 section.
.IP "noheader" 4
.IX Item "noheader"
.Vb 1
\& \-\-noheader
.Ve
.Sp
Do not create header and footer blocks containing the text of the \*(L"\s-1NAME\*(R"\s0
section (default behaviour).
.IP "poderrors" 4
.IX Item "poderrors"
.Vb 1
\& \-\-poderrors
.Ve
.Sp
Include a \*(L"\s-1POD ERRORS\*(R"\s0 section in the outfile if there were any \s-1POD\s0 errors in
the infile (default behaviour).
.IP "nopoderrors" 4
.IX Item "nopoderrors"
.Vb 1
\& \-\-nopoderrors
.Ve
.Sp
Do not include a \*(L"\s-1POD ERRORS\*(R"\s0 section in the outfile if there were any \s-1POD\s0
errors in the infile.
.IP "index" 4
.IX Item "index"
.Vb 1
\& \-\-index
.Ve
.Sp
Generate an index at the top of the \s-1HTML\s0 file (default behaviour).
.IP "noindex" 4
.IX Item "noindex"
.Vb 1
\& \-\-noindex
.Ve
.Sp
Do not generate an index at the top of the \s-1HTML\s0 file.
.IP "recurse" 4
.IX Item "recurse"
.Vb 1
\& \-\-recurse
.Ve
.Sp
Recurse into subdirectories specified in podpath (default behaviour).
.IP "norecurse" 4
.IX Item "norecurse"
.Vb 1
\& \-\-norecurse
.Ve
.Sp
Do not recurse into subdirectories specified in podpath.
.IP "css" 4
.IX Item "css"
.Vb 1
\& \-\-css=URL
.Ve
.Sp
Specify the \s-1URL\s0 of cascading style sheet to link from resulting \s-1HTML\s0 file.
Default is none style sheet.
.IP "title" 4
.IX Item "title"
.Vb 1
\& \-\-title=title
.Ve
.Sp
Specify the title of the resulting \s-1HTML\s0 file.
.IP "quiet" 4
.IX Item "quiet"
.Vb 1
\& \-\-quiet
.Ve
.Sp
Don't display mostly harmless warning messages.
.IP "noquiet" 4
.IX Item "noquiet"
.Vb 1
\& \-\-noquiet
.Ve
.Sp
Display mostly harmless warning messages (default behaviour). But this is not
the same as \*(L"verbose\*(R" mode.
.IP "verbose" 4
.IX Item "verbose"
.Vb 1
\& \-\-verbose
.Ve
.Sp
Display progress messages.
.IP "noverbose" 4
.IX Item "noverbose"
.Vb 1
\& \-\-noverbose
.Ve
.Sp
Do not display progress messages (default behaviour).
.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.