Commit | Line | Data |
---|---|---|
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 "vmsish 3" | |
132 | .TH vmsish 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide" | |
133 | .SH "NAME" | |
134 | vmsish \- Perl pragma to control VMS\-specific language features | |
135 | .SH "SYNOPSIS" | |
136 | .IX Header "SYNOPSIS" | |
137 | .Vb 1 | |
138 | \& use vmsish; | |
139 | .Ve | |
140 | .PP | |
141 | .Vb 3 | |
142 | \& use vmsish 'status'; # or '$?' | |
143 | \& use vmsish 'exit'; | |
144 | \& use vmsish 'time'; | |
145 | .Ve | |
146 | .PP | |
147 | .Vb 3 | |
148 | \& use vmsish 'hushed'; | |
149 | \& no vmsish 'hushed'; | |
150 | \& vmsish::hushed($hush); | |
151 | .Ve | |
152 | .PP | |
153 | .Vb 2 | |
154 | \& use vmsish; | |
155 | \& no vmsish 'time'; | |
156 | .Ve | |
157 | .SH "DESCRIPTION" | |
158 | .IX Header "DESCRIPTION" | |
159 | If no import list is supplied, all possible VMS-specific features are | |
160 | assumed. Currently, there are four VMS-specific features available: | |
161 | \&'status' (a.k.a '$?'), 'exit', 'time' and 'hushed'. | |
162 | .PP | |
163 | If you're not running \s-1VMS\s0, this module does nothing. | |
164 | .ie n .IP """vmsish status""" 6 | |
165 | .el .IP "\f(CWvmsish status\fR" 6 | |
166 | .IX Item "vmsish status" | |
167 | This makes \f(CW$?\fR and \f(CW\*(C`system\*(C'\fR return the native \s-1VMS\s0 exit status | |
168 | instead of emulating the \s-1POSIX\s0 exit status. | |
169 | .ie n .IP """vmsish exit""" 6 | |
170 | .el .IP "\f(CWvmsish exit\fR" 6 | |
171 | .IX Item "vmsish exit" | |
172 | This makes \f(CW\*(C`exit 1\*(C'\fR produce a successful exit (with status \s-1SS$_NORMAL\s0), | |
173 | instead of emulating \s-1UNIX\s0 \fIexit()\fR, which considers \f(CW\*(C`exit 1\*(C'\fR to indicate | |
174 | an error. As with the \s-1CRTL\s0's \fIexit()\fR function, \f(CW\*(C`exit 0\*(C'\fR is also mapped | |
175 | to an exit status of \s-1SS$_NORMAL\s0, and any other argument to \fIexit()\fR is | |
176 | used directly as Perl's exit status. | |
177 | .ie n .IP """vmsish time""" 6 | |
178 | .el .IP "\f(CWvmsish time\fR" 6 | |
179 | .IX Item "vmsish time" | |
180 | This makes all times relative to the local time zone, instead of the | |
181 | default of Universal Time (a.k.a Greenwich Mean Time, or \s-1GMT\s0). | |
182 | .ie n .IP """vmsish hushed""" 6 | |
183 | .el .IP "\f(CWvmsish hushed\fR" 6 | |
184 | .IX Item "vmsish hushed" | |
185 | This suppresses printing of \s-1VMS\s0 status messages to \s-1SYS$OUTPUT\s0 and | |
186 | \&\s-1SYS$ERROR\s0 if Perl terminates with an error status. and allows | |
187 | programs that are expecting \*(L"unix\-style\*(R" Perl to avoid having to parse | |
188 | \&\s-1VMS\s0 error messages. It does not suppress any messages from Perl | |
189 | itself, just the messages generated by \s-1DCL\s0 after Perl exits. The \s-1DCL\s0 | |
190 | symbol \f(CW$STATUS\fR will still have the termination status, but with a | |
191 | high-order bit set: | |
192 | .Sp | |
193 | \&\s-1EXAMPLE:\s0 | |
194 | $ perl \-e\*(L"exit 44;\*(R" Non-hushed error exit | |
195 | \f(CW%SYSTEM\fR\-F\-ABORT, abort \s-1DCL\s0 message | |
196 | $ show sym \f(CW$STATUS\fR | |
197 | \f(CW$STATUS\fR == \*(L"%X0000002C\*(R" | |
198 | .Sp | |
199 | .Vb 3 | |
200 | \& $ perl -e"use vmsish qw(hushed); exit 44;" Hushed error exit | |
201 | \& $ show sym $STATUS | |
202 | \& $STATUS == "%X1000002C" | |
203 | .Ve | |
204 | .Sp | |
205 | The 'hushed' flag has a global scope during compilation: the \fIexit()\fR or | |
206 | \&\fIdie()\fR commands that are compiled after 'vmsish hushed' will be hushed | |
207 | when they are executed. Doing a \*(L"no vmsish 'hushed'\*(R" turns off the | |
208 | hushed flag. | |
209 | .Sp | |
210 | The status of the hushed flag also affects output of \s-1VMS\s0 error | |
211 | messages from compilation errors. Again, you still get the Perl | |
212 | error message (and the code in \f(CW$STATUS\fR) | |
213 | .Sp | |
214 | \&\s-1EXAMPLE:\s0 | |
215 | use vmsish 'hushed'; # turn on hushed flag | |
216 | use Carp; # Carp compiled hushed | |
217 | exit 44; # will be hushed | |
218 | croak('I die'); # will be hushed | |
219 | no vmsish 'hushed'; # turn off hushed flag | |
220 | exit 44; # will not be hushed | |
221 | croak('I die2'): # \s-1WILL\s0 be hushed, croak was compiled hushed | |
222 | .Sp | |
223 | You can also control the 'hushed' flag at run\-time, using the built-in | |
224 | routine \fIvmsish::hushed()\fR. Without argument, it returns the hushed status. | |
225 | Since vmsish::hushed is built\-in, you do not need to \*(L"use vmsish\*(R" to call | |
226 | it. | |
227 | .Sp | |
228 | \&\s-1EXAMPLE:\s0 | |
229 | if ($quiet_exit) { | |
230 | \fIvmsish::hushed\fR\|(1); | |
231 | } | |
232 | print \*(L"Sssshhhh...I'm hushed...\en\*(R" if \fIvmsish::hushed()\fR; | |
233 | exit 44; | |
234 | .Sp | |
235 | Note that an \fIexit()\fR or \fIdie()\fR that is compiled 'hushed' because of \*(L"use | |
236 | vmsish\*(R" is not un-hushed by calling \fIvmsish::hushed\fR\|(0) at runtime. | |
237 | .Sp | |
238 | The messages from error exits from inside the Perl core are generally | |
239 | more serious, and are not suppressed. | |
240 | .PP | |
241 | See \*(L"Pragmatic Modules\*(R" in perlmod. |