Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / devtools / v9 / man / man1 / perldoc.1
CommitLineData
920dae64
AT
1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v
15.if n .sp
16..
17.de Vb \" Begin verbatim text
18.ft CW
19.nf
20.ne \\$1
21..
22.de Ve \" End verbatim text
23.ft R
24.fi
25..
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
43'br\}
44.el\{\
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
49'br\}
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
58..
59. nr % 0
60. rr F
61.\}
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
71.if n \{\
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
77.\}
78.if t \{\
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
84.\}
85. \" simple accents for nroff and troff
86.if n \{\
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
93.\}
94.if t \{\
95. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101.\}
102. \" troff and (daisy-wheel) nroff accents
103.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110.ds ae a\h'-(\w'a'u*4/10)'e
111.ds Ae A\h'-(\w'A'u*4/10)'E
112. \" corrections for vroff
113.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115. \" for low resolution devices (crt and lpr)
116.if \n(.H>23 .if \n(.V>19 \
117\{\
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
127.\}
128.rm #[ #] #H #V #F C
129.\" ========================================================================
130.\"
131.IX Title "PERLDOC 1"
132.TH PERLDOC 1 "2005-08-07" "perl v5.8.8" "Perl Programmers Reference Guide"
133.SH "NAME"
134perldoc \- Look up Perl documentation in Pod format.
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137\&\fBperldoc\fR [\fB\-h\fR] [\fB\-v\fR] [\fB\-t\fR] [\fB\-u\fR] [\fB\-m\fR] [\fB\-l\fR] [\fB\-F\fR]
138[\fB\-i\fR] [\fB\-V\fR] [\fB\-T\fR] [\fB\-r\fR]
139[\fB\-d\f(BIdestination_file\fB\fR]
140[\fB\-o\f(BIformatname\fB\fR]
141[\fB\-M\f(BIFormatterClassName\fB\fR]
142[\fB\-w\f(BIformatteroption:value\fB\fR]
143[\fB\-n\fR\fInroff-replacement\fR]
144[\fB\-X\fR]
145PageName|ModuleName|ProgramName
146.PP
147\&\fBperldoc\fR \fB\-f\fR BuiltinFunction
148.PP
149\&\fBperldoc\fR \fB\-q\fR \s-1FAQ\s0 Keyword
150.PP
151See below for more description of the switches.
152.SH "DESCRIPTION"
153.IX Header "DESCRIPTION"
154\&\fIperldoc\fR looks up a piece of documentation in .pod format that is embedded
155in the perl installation tree or in a perl script, and displays it via
156\&\f(CW\*(C`pod2man | nroff \-man | $PAGER\*(C'\fR. (In addition, if running under \s-1HP\-UX\s0,
157\&\f(CW\*(C`col \-x\*(C'\fR will be used.) This is primarily used for the documentation for
158the perl library modules.
159.PP
160Your system may also have man pages installed for those modules, in
161which case you can probably just use the \fIman\fR\|(1) command.
162.PP
163If you are looking for a table of contents to the Perl library modules
164documentation, see the perltoc page.
165.SH "OPTIONS"
166.IX Header "OPTIONS"
167.IP "\fB\-h\fR" 5
168.IX Item "-h"
169Prints out a brief \fBh\fRelp message.
170.IP "\fB\-v\fR" 5
171.IX Item "-v"
172Describes search for the item in detail (\fBv\fRerbosely).
173.IP "\fB\-t\fR" 5
174.IX Item "-t"
175Display docs using plain \fBt\fRext converter, instead of nroff. This may be faster,
176but it probably won't look as nice.
177.IP "\fB\-u\fR" 5
178.IX Item "-u"
179Skip the real Pod formatting, and just show the raw Pod source (\fBU\fRnformatted)
180.IP "\fB\-m\fR \fImodule\fR" 5
181.IX Item "-m module"
182Display the entire module: both code and unformatted pod documentation.
183This may be useful if the docs don't explain a function in the detail
184you need, and you'd like to inspect the code directly; perldoc will find
185the file for you and simply hand it off for display.
186.IP "\fB\-l\fR" 5
187.IX Item "-l"
188Display on\fBl\fRy the file name of the module found.
189.IP "\fB\-F\fR" 5
190.IX Item "-F"
191Consider arguments as file names; no search in directories will be performed.
192.IP "\fB\-f\fR \fIperlfunc\fR" 5
193.IX Item "-f perlfunc"
194The \fB\-f\fR option followed by the name of a perl built in function will
195extract the documentation of this function from perlfunc.
196.Sp
197Example:
198.Sp
199.Vb 1
200\& perldoc -f sprintf
201.Ve
202.IP "\fB\-q\fR \fIperlfaq-search-regexp\fR" 5
203.IX Item "-q perlfaq-search-regexp"
204The \fB\-q\fR option takes a regular expression as an argument. It will search
205the \fBq\fRuestion headings in perlfaq[1\-9] and print the entries matching
206the regular expression. Example: \f(CW\*(C`perldoc \-q shuffle\*(C'\fR
207.IP "\fB\-T\fR" 5
208.IX Item "-T"
209This specifies that the output is not to be sent to a pager, but is to
210be sent right to \s-1STDOUT\s0.
211.IP "\fB\-d\fR \fIdestination-filename\fR" 5
212.IX Item "-d destination-filename"
213This specifies that the output is to be sent neither to a pager nor
214to \s-1STDOUT\s0, but is to be saved to the specified filename. Example:
215\&\f(CW\*(C`perldoc \-oLaTeX \-dtextwrapdocs.tex Text::Wrap\*(C'\fR
216.IP "\fB\-o\fR \fIoutput-formatname\fR" 5
217.IX Item "-o output-formatname"
218This specifies that you want Perldoc to try using a Pod-formatting
219class for the output format that you specify. For example:
220\&\f(CW\*(C`\-oman\*(C'\fR. This is actually just a wrapper around the \f(CW\*(C`\-M\*(C'\fR switch;
221using \f(CW\*(C`\-o\f(CIformatname\f(CW\*(C'\fR just looks for a loadable class by adding
222that format name (with different capitalizations) to the end of
223different classname prefixes.
224.Sp
225For example, \f(CW\*(C`\-oLaTeX\*(C'\fR currently tries all of the following classes:
226Pod::Perldoc::ToLaTeX Pod::Perldoc::Tolatex Pod::Perldoc::ToLatex
227Pod::Perldoc::ToLATEX Pod::Simple::LaTeX Pod::Simple::latex
228Pod::Simple::Latex Pod::Simple::LATEX Pod::LaTeX Pod::latex Pod::Latex
229Pod::LATEX.
230.IP "\fB\-M\fR \fImodule-name\fR" 5
231.IX Item "-M module-name"
232This specifies the module that you want to try using for formatting the
233pod. The class must at least provide a \f(CW\*(C`parse_from_file\*(C'\fR method.
234For example: \f(CW\*(C`perldoc \-MPod::Perldoc::ToChecker\*(C'\fR.
235.Sp
236You can specify several classes to try by joining them with commas
237or semicolons, as in \f(CW\*(C`\-MTk::SuperPod;Tk::Pod\*(C'\fR.
238.IP "\fB\-w\fR \fIoption:value\fR or \fB\-w\fR \fIoption\fR" 5
239.IX Item "-w option:value or -w option"
240This specifies an option to call the formatter \fBw\fRith. For example,
241\&\f(CW\*(C`\-w textsize:15\*(C'\fR will call
242\&\f(CW\*(C`$formatter\->textsize(15)\*(C'\fR on the formatter object before it is
243used to format the object. For this to be valid, the formatter class
244must provide such a method, and the value you pass should be valid.
245(So if \f(CW\*(C`textsize\*(C'\fR expects an integer, and you do \f(CW\*(C`\-w textsize:big\*(C'\fR,
246expect trouble.)
247.Sp
248You can use \f(CW\*(C`\-w optionname\*(C'\fR (without a value) as shorthand for
249\&\f(CW\*(C`\-w optionname:\f(CI\s-1TRUE\s0\f(CW\*(C'\fR. This is presumably useful in cases of on/off
250features like: \f(CW\*(C`\-w page_numbering\*(C'\fR.
251.Sp
252You can use a \*(L"=\*(R" instead of the \*(L":\*(R", as in: \f(CW\*(C`\-w textsize=15\*(C'\fR. This
253might be more (or less) convenient, depending on what shell you use.
254.IP "\fB\-X\fR" 5
255.IX Item "-X"
256Use an index if it is present \*(-- the \fB\-X\fR option looks for an entry
257whose basename matches the name given on the command line in the file
258\&\f(CW\*(C`$Config{archlib}/pod.idx\*(C'\fR. The \fIpod.idx\fR file should contain fully
259qualified filenames, one per line.
260.IP "\fBPageName|ModuleName|ProgramName\fR" 5
261.IX Item "PageName|ModuleName|ProgramName"
262The item you want to look up. Nested modules (such as \f(CW\*(C`File::Basename\*(C'\fR)
263are specified either as \f(CW\*(C`File::Basename\*(C'\fR or \f(CW\*(C`File/Basename\*(C'\fR. You may also
264give a descriptive name of a page, such as \f(CW\*(C`perlfunc\*(C'\fR.
265.IP "\fB\-n\fR \fIsome-formatter\fR" 5
266.IX Item "-n some-formatter"
267Specify replacement for nroff
268.IP "\fB\-r\fR" 5
269.IX Item "-r"
270Recursive search.
271.IP "\fB\-i\fR" 5
272.IX Item "-i"
273Ignore case.
274.IP "\fB\-V\fR" 5
275.IX Item "-V"
276Displays the version of perldoc you're running.
277.SH "SECURITY"
278.IX Header "SECURITY"
279Because \fBperldoc\fR does not run properly tainted, and is known to
280have security issues, when run as the superuser it will attempt to
281drop privileges by setting the effective and real IDs to nobody's
282or nouser's account, or \-2 if unavailable. If it cannot relinquish
283its privileges, it will not run.
284.SH "ENVIRONMENT"
285.IX Header "ENVIRONMENT"
286Any switches in the \f(CW\*(C`PERLDOC\*(C'\fR environment variable will be used before the
287command line arguments.
288.PP
289Useful values for \f(CW\*(C`PERLDOC\*(C'\fR include \f(CW\*(C`\-oman\*(C'\fR, \f(CW\*(C`\-otext\*(C'\fR, \f(CW\*(C`\-otk\*(C'\fR, \f(CW\*(C`\-ortf\*(C'\fR,
290\&\f(CW\*(C`\-oxml\*(C'\fR, and so on, depending on what modules you have on hand; or
291exactly specify the formatter class with \f(CW\*(C`\-MPod::Perldoc::ToMan\*(C'\fR
292or the like.
293.PP
294\&\f(CW\*(C`perldoc\*(C'\fR also searches directories
295specified by the \f(CW\*(C`PERL5LIB\*(C'\fR (or \f(CW\*(C`PERLLIB\*(C'\fR if \f(CW\*(C`PERL5LIB\*(C'\fR is not
296defined) and \f(CW\*(C`PATH\*(C'\fR environment variables.
297(The latter is so that embedded pods for executables, such as
298\&\f(CW\*(C`perldoc\*(C'\fR itself, are available.)
299.PP
300\&\f(CW\*(C`perldoc\*(C'\fR will use, in order of preference, the pager defined in
301\&\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
302on its own. (\f(CW\*(C`MANPAGER\*(C'\fR is not used if \f(CW\*(C`perldoc\*(C'\fR was told to display
303plain text or unformatted pod.)
304.PP
305One useful value for \f(CW\*(C`PERLDOC_PAGER\*(C'\fR is \f(CW\*(C`less \-+C \-E\*(C'\fR.
306.PP
307Having \s-1PERLDOCDEBUG\s0 set to a positive integer will make perldoc emit
308even more descriptive output than the \f(CW\*(C`\-v\*(C'\fR switch does \*(-- the higher the
309number, the more it emits.
310.SH "AUTHOR"
311.IX Header "AUTHOR"
312Current maintainer: Sean M. Burke, <sburke@cpan.org>
313.PP
314Past contributors are:
315Kenneth Albanowski <kjahds@kjahds.com>,
316Andy Dougherty <doughera@lafcol.lafayette.edu>,
317and many others.