projects / OpenSPARC-T2-SAM / blame
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / devtools / v9 / man / man3 / Getopt::Std.3
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 "Getopt::Std 3"
132.TH Getopt::Std 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide"
133.SH "NAME"
134getopt, getopts \- Process single\-character switches with switch clustering
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137.Vb 1
138\& use Getopt::Std;
139.Ve
140.PP
141.Vb 5
142\& getopt('oDI'); # -o, -D & -I take arg. Sets $opt_* as a side effect.
143\& getopt('oDI', \e%opts); # -o, -D & -I take arg. Values in %opts
144\& getopts('oif:'); # -o & -i are boolean flags, -f takes an argument
145\& # Sets $opt_* as a side effect.
146\& getopts('oif:', \e%opts); # options as above. Values in %opts
147.Ve
148.SH "DESCRIPTION"
149.IX Header "DESCRIPTION"
150The \fIgetopt()\fR function processes single-character switches with switch
151clustering. Pass one argument which is a string containing all switches
152that take an argument. For each switch found, sets \f(CW$opt_x\fR (where x is the
153switch name) to the value of the argument if an argument is expected,
154or 1 otherwise. Switches which take an argument don't care whether
155there is a space between the switch and the argument.
156.PP
157The \fIgetopts()\fR function is similar, but you should pass to it the list of all
158switches to be recognized. If unspecified switches are found on the
159command\-line, the user will be warned that an unknown option was given.
160.PP
161Note that, if your code is running under the recommended \f(CW\*(C`use strict
162\&'vars'\*(C'\fR pragma, you will need to declare these package variables
163with \*(L"our\*(R":
164.PP
165.Vb 1
166\& our($opt_x, $opt_y);
167.Ve
168.PP
169For those of you who don't like additional global variables being created, \fIgetopt()\fR
170and \fIgetopts()\fR will also accept a hash reference as an optional second argument.
171Hash keys will be x (where x is the switch name) with key values the value of
172the argument or 1 if no argument is specified.
173.PP
174To allow programs to process arguments that look like switches, but aren't,
175both functions will stop processing switches when they see the argument
176\&\f(CW\*(C`\-\-\*(C'\fR. The \f(CW\*(C`\-\-\*(C'\fR will be removed from \f(CW@ARGV\fR.
177.ie n .SH """\-\-help""\fP and \f(CW""\-\-version"""
178.el .SH "\f(CW\-\-help\fP and \f(CW\-\-version\fP"
179.IX Header "--help and --version"
180If \f(CW\*(C`\-\*(C'\fR is not a recognized switch letter, \fIgetopts()\fR supports arguments
181\&\f(CW\*(C`\-\-help\*(C'\fR and \f(CW\*(C`\-\-version\*(C'\fR. If \f(CW\*(C`main::HELP_MESSAGE()\*(C'\fR and/or
182\&\f(CW\*(C`main::VERSION_MESSAGE()\*(C'\fR are defined, they are called; the arguments are
183the output file handle, the name of option-processing package, its version,
184and the switches string. If the subroutines are not defined, an attempt is
185made to generate intelligent messages; for best results, define \f(CW$main::VERSION\fR.
186.PP
187If embedded documentation (in pod format, see perlpod) is detected
188in the script, \f(CW\*(C`\-\-help\*(C'\fR will also show how to access the documentation.
189.PP
190Note that due to excessive paranoia, if \f(CW$Getopt::Std::STANDARD_HELP_VERSION\fR
191isn't true (the default is false), then the messages are printed on \s-1STDERR\s0,
192and the processing continues after the messages are printed. This being
193the opposite of the standard-conforming behaviour, it is strongly recommended
194to set \f(CW$Getopt::Std::STANDARD_HELP_VERSION\fR to true.
195.PP
196One can change the output file handle of the messages by setting
197\&\f(CW$Getopt::Std::OUTPUT_HELP_VERSION\fR. One can print the messages of \f(CW\*(C`\-\-help\*(C'\fR
198(without the \f(CW\*(C`Usage:\*(C'\fR line) and \f(CW\*(C`\-\-version\*(C'\fR by calling functions \fIhelp_mess()\fR
199and \fIversion_mess()\fR with the switches string as an argument.
Full OpenSPARC architecture tarball including simulator, hypervisor, and OBP.