Initial commit of OpenSPARC T2 architecture model.

[OpenSPARC-T2-SAM] / sam-t2 / devtools / v8plus / man / man1 / pod2latex.1

.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" 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 "POD2LATEX 1"
.TH POD2LATEX 1 "2007-06-19" "perl v5.8.8" "Perl Programmers Reference Guide"
.SH "NAME"
pod2latex \- convert pod documentation to latex format
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  pod2latex *.pm
.Ve
.PP
.Vb 1
\&  pod2latex -out mytex.tex *.pod
.Ve
.PP
.Vb 1
\&  pod2latex -full -sections 'DESCRIPTION|NAME' SomeDir
.Ve
.PP
.Vb 1
\&  pod2latex -prefile h.tex -postfile t.tex my.pod
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`pod2latex\*(C'\fR is a program to convert \s-1POD\s0 format documentation
(perlpod) into latex. It can process multiple input documents at a
time and either generate a latex file per input document or a single
combined output file.
.SH "OPTIONS AND ARGUMENTS"
.IX Header "OPTIONS AND ARGUMENTS"
This section describes the supported command line options. Minimum
matching is supported.
.IP "\fB\-out\fR" 4
.IX Item "-out"
Name of the output file to be used. If there are multiple input pods
it is assumed that the intention is to write all translated output
into a single file. \f(CW\*(C`.tex\*(C'\fR is appended if not present.  If the
argument is not supplied, a single document will be created for each
input file.
.IP "\fB\-full\fR" 4
.IX Item "-full"
Creates a complete \f(CW\*(C`latex\*(C'\fR file that can be processed immediately
(unless \f(CW\*(C`=for/=begin\*(C'\fR directives are used that rely on extra packages).
Table of contents and index generation commands are included in the
wrapper \f(CW\*(C`latex\*(C'\fR code.
.IP "\fB\-sections\fR" 4
.IX Item "-sections"
Specify pod sections to include (or remove if negated) in the
translation.  See \*(L"\s-1SECTION\s0 \s-1SPECIFICATIONS\s0\*(R" in Pod::Select for the
format to use for \fIsection-spec\fR. This option may be given multiple
times on the command line.This is identical to the similar option in
the \f(CW\*(C`podselect()\*(C'\fR command.
.IP "\fB\-modify\fR" 4
.IX Item "-modify"
This option causes the output \f(CW\*(C`latex\*(C'\fR to be slightly
modified from the input pod such that when a \f(CW\*(C`=head1 NAME\*(C'\fR
is encountered a section is created containing the actual
pod name (rather than \fB\s-1NAME\s0\fR) and all subsequent \f(CW\*(C`=head1\*(C'\fR
directives are treated as subsections. This has the advantage
that the description of a module will be in its own section
which is helpful for including module descriptions in documentation.
Also forces \f(CW\*(C`latex\*(C'\fR label and index entries to be prefixed by the
name of the module.
.IP "\fB\-h1level\fR" 4
.IX Item "-h1level"
Specifies the \f(CW\*(C`latex\*(C'\fR section that is equivalent to a \f(CW\*(C`H1\*(C'\fR pod
directive. This is an integer between 0 and 5 with 0 equivalent to a
\&\f(CW\*(C`latex\*(C'\fR chapter, 1 equivalent to a \f(CW\*(C`latex\*(C'\fR section etc. The default
is 1 (\f(CW\*(C`H1\*(C'\fR equivalent to a latex section).
.IP "\fB\-help\fR" 4
.IX Item "-help"
Print a brief help message and exit.
.IP "\fB\-man\fR" 4
.IX Item "-man"
Print the manual page and exit.
.IP "\fB\-verbose\fR" 4
.IX Item "-verbose"
Print information messages as each document is processed.
.IP "\fB\-preamble\fR" 4
.IX Item "-preamble"
A user-supplied preamble for the LaTeX code. Multiple values
are supported and appended in order separated by \*(L"\en\*(R".
See \fB\-prefile\fR for reading the preamble from a file.
.IP "\fB\-postamble\fR" 4
.IX Item "-postamble"
A user supplied postamble for the LaTeX code. Multiple values
are supported and appended in order separated by \*(L"\en\*(R".
See \fB\-postfile\fR for reading the postamble from a file.
.IP "\fB\-prefile\fR" 4
.IX Item "-prefile"
A user-supplied preamble for the LaTeX code to be read from the
named file. Multiple values are supported and appended in
order. See \fB\-preamble\fR.
.IP "\fB\-postfile\fR" 4
.IX Item "-postfile"
A user-supplied postamble for the LaTeX code to be read from the
named file. Multiple values are supported and appended in
order. See \fB\-postamble\fR.
.SH "BUGS"
.IX Header "BUGS"
Known bugs are:
.IP "\(bu" 4
Cross references between documents are not resolved when multiple
pod documents are converted into a single output \f(CW\*(C`latex\*(C'\fR file.
.IP "\(bu" 4
Functions and variables are not automatically recognized
and they will therefore not be marked up in any special way
unless instructed by an explicit pod command.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Pod::LaTeX
.SH "AUTHOR"
.IX Header "AUTHOR"
Tim Jenness <tjenness@cpan.org>
.PP
This program is free software; you can redistribute it
and/or modify it under the same terms as Perl itself.
.PP
Copyright (C) 2000, 2003, 2004 Tim Jenness. All Rights Reserved.