Initial commit of OpenSPARC T2 design and verification files.

[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man1 / perldoc.1

.\" 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 "PERLDOC 1"
.TH PERLDOC 1 "2002-08-28" "perl v5.8.0" "Perl Programmers Reference Guide"
.SH "NAME"
perldoc \- Look up Perl documentation in pod format.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBperldoc\fR [\fB\-h\fR] [\fB\-v\fR] [\fB\-t\fR] [\fB\-u\fR] [\fB\-m\fR] [\fB\-l\fR] [\fB\-F\fR]  [\fB\-X\fR] PageName|ModuleName|ProgramName
.PP
\&\fBperldoc\fR \fB\-f\fR BuiltinFunction
.PP
\&\fBperldoc\fR \fB\-q\fR \s-1FAQ\s0 Keyword
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fIperldoc\fR looks up a piece of documentation in .pod format that is embedded
in the perl installation tree or in a perl script, and displays it via
\&\f(CW\*(C`pod2man | nroff \-man | $PAGER\*(C'\fR. (In addition, if running under \s-1HP\-UX\s0,
\&\f(CW\*(C`col \-x\*(C'\fR will be used.) This is primarily used for the documentation for
the perl library modules.
.PP
Your system may also have man pages installed for those modules, in
which case you can probably just use the \fIman\fR\|(1) command.
.PP
If you are looking for a table of contents to the Perl library modules
documentation, see the perltoc page.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-h\fR help" 5
.IX Item "-h help"
Prints out a brief help message.
.IP "\fB\-v\fR verbose" 5
.IX Item "-v verbose"
Describes search for the item in detail.
.IP "\fB\-t\fR text output" 5
.IX Item "-t text output"
Display docs using plain text converter, instead of nroff. This may be faster,
but it won't look as nice.
.IP "\fB\-u\fR unformatted" 5
.IX Item "-u unformatted"
Find docs only; skip reformatting by pod2*
.IP "\fB\-m\fR module" 5
.IX Item "-m module"
Display the entire module: both code and unformatted pod documentation.
This may be useful if the docs don't explain a function in the detail
you need, and you'd like to inspect the code directly; perldoc will find
the file for you and simply hand it off for display.
.IP "\fB\-l\fR file name only" 5
.IX Item "-l file name only"
Display the file name of the module found.
.IP "\fB\-F\fR file names" 5
.IX Item "-F file names"
Consider arguments as file names, no search in directories will be performed.
.IP "\fB\-f\fR perlfunc" 5
.IX Item "-f perlfunc"
The \fB\-f\fR option followed by the name of a perl built in function will
extract the documentation of this function from perlfunc.
.IP "\fB\-q\fR perlfaq" 5
.IX Item "-q perlfaq"
The \fB\-q\fR option takes a regular expression as an argument.  It will search
the question headings in perlfaq[1\-9] and print the entries matching
the regular expression.
.IP "\fB\-X\fR use an index if present" 5
.IX Item "-X use an index if present"
The \fB\-X\fR option looks for an entry whose basename matches the name given on the
command line in the file \f(CW\*(C`$Config{archlib}/pod.idx\*(C'\fR.  The pod.idx file should
contain fully qualified filenames, one per line.
.IP "\fB\-U\fR run insecurely" 5
.IX Item "-U run insecurely"
Because \fBperldoc\fR does not run properly tainted, and is known to
have security issues, it will not normally execute as the superuser.
If you use the \fB\-U\fR flag, it will do so, but only after setting
the effective and real IDs to nobody's or nouser's account, or \-2
if unavailable.  If it cannot relinquish its privileges, it will not
run.  
.IP "\fBPageName|ModuleName|ProgramName\fR" 5
.IX Item "PageName|ModuleName|ProgramName"
The item you want to look up.  Nested modules (such as \f(CW\*(C`File::Basename\*(C'\fR)
are specified either as \f(CW\*(C`File::Basename\*(C'\fR or \f(CW\*(C`File/Basename\*(C'\fR.  You may also
give a descriptive name of a page, such as \f(CW\*(C`perlfunc\*(C'\fR.
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
Any switches in the \f(CW\*(C`PERLDOC\*(C'\fR environment variable will be used before the
command line arguments.  \f(CW\*(C`perldoc\*(C'\fR also searches directories
specified by the \f(CW\*(C`PERL5LIB\*(C'\fR (or \f(CW\*(C`PERLLIB\*(C'\fR if \f(CW\*(C`PERL5LIB\*(C'\fR is not
defined) and \f(CW\*(C`PATH\*(C'\fR environment variables.
(The latter is so that embedded pods for executables, such as
\&\f(CW\*(C`perldoc\*(C'\fR itself, are available.)  \f(CW\*(C`perldoc\*(C'\fR will use, in order of
preference, the pager defined in \f(CW\*(C`PERLDOC_PAGER\*(C'\fR, \f(CW\*(C`MANPAGER\*(C'\fR, or
\&\f(CW\*(C`PAGER\*(C'\fR before trying to find a pager on its own.  (\f(CW\*(C`MANPAGER\*(C'\fR is not
used if \f(CW\*(C`perldoc\*(C'\fR was told to display plain text or unformatted pod.)
.PP
One useful value for \f(CW\*(C`PERLDOC_PAGER\*(C'\fR is \f(CW\*(C`less \-+C \-E\*(C'\fR.
.SH "VERSION"
.IX Header "VERSION"
This is perldoc v2.03.
.SH "AUTHOR"
.IX Header "AUTHOR"
Kenneth Albanowski <kjahds@kjahds.com>
.PP
Minor updates by Andy Dougherty <doughera@lafcol.lafayette.edu>,
and others.