Initial commit of OpenSPARC T2 design and verification files.

[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / Pod::Html.3

.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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.  | will give a
.\" real vertical bar.  \*(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-|\(bv\*(Tr
.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" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" 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 "Pod::Html 3"
.TH Pod::Html 3 "2002-06-01" "perl v5.8.0" "Perl Programmers Reference Guide"
.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 \s-1HTML\s0 format.  It
can automatically generate indexes and cross\-references, and it keeps
a cache of things it knows how to cross\-reference.
.SH "ARGUMENTS"
.IX Header "ARGUMENTS"
Pod::Html takes the following arguments:
.IP "backlink" 4
.IX Item "backlink"
.Vb 1
\&    --backlink="Back to Top"
.Ve
.Sp
Adds \*(L"Back to Top\*(R" links in front of every \f(CW\*(C`head1\*(C'\fR heading (except for
the first).  By default, no backlinks are generated.
.IP "cachedir" 4
.IX Item "cachedir"
.Vb 1
\&    --cachedir=name
.Ve
.Sp
Creates the item and directory caches in the given directory.
.IP "css" 4
.IX Item "css"
.Vb 1
\&    --css=stylesheet
.Ve
.Sp
Specify the \s-1URL\s0 of a cascading style sheet.  Also disables all \s-1HTML/CSS\s0
\&\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 item and directory caches.
.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 in which the resulting \s-1HTML\s0 file is placed.  This
is used to generate relative links to other files. Not passing this
causes all links to be absolute, since this is the value that tells
Pod::Html the root of the documentation tree.
.IP "htmlroot" 4
.IX Item "htmlroot"
.Vb 1
\&    --htmlroot=name
.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.
.IP "index" 4
.IX Item "index"
.Vb 2
\&    --index
\&    --noindex
.Ve
.Sp
Generate an index at the top of the \s-1HTML\s0 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 \s-1STDIN\s0 if no
infile is specified.
.IP "libpods" 4
.IX Item "libpods"
.Vb 1
\&    --libpods=name:...:name
.Ve
.Sp
List of page names (eg, \*(L"perlfunc\*(R") which contain linkable \f(CW\*(C`=item\*(C'\fRs.
.IP "netscape" 4
.IX Item "netscape"
.Vb 2
\&    --netscape
\&    --nonetscape
.Ve
.Sp
\&\fBDeprecated\fR, has no effect. For backwards compatibility only.
.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 "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 "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 \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 \s-1HTML\s0 file.
.IP "verbose" 4
.IX Item "verbose"
.Vb 2
\&    --verbose
\&    --noverbose
.Ve
.Sp
Display progress messages.  By default, they won't be displayed.
.SH "EXAMPLE"
.IX Header "EXAMPLE"
.Vb 8
\&    pod2html("pod2html",
\&             "--podpath=lib:ext:pod:vms",
\&             "--podroot=/usr/src/perl",
\&             "--htmlroot=/perl/nmanual",
\&             "--libpods=perlfunc:perlguts:perlvar:perlrun:perlop",
\&             "--recurse",
\&             "--infile=foo.pod",
\&             "--outfile=/perl/nmanual/foo.html");
.Ve
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
Uses \f(CW$Config{pod2html}\fR to setup default options.
.SH "AUTHOR"
.IX Header "AUTHOR"
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.