sam-t2/devtools/v8plus/man/man3/vmsish.3

.\" 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 "vmsish 3"
.TH vmsish 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide"
.SH "NAME"
vmsish \- Perl pragma to control VMS\-specific language features
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use vmsish;
.Ve
.PP
.Vb 3
\&    use vmsish 'status';        # or '$?'
\&    use vmsish 'exit';
\&    use vmsish 'time';
.Ve
.PP
.Vb 3
\&    use vmsish 'hushed';
\&    no vmsish 'hushed';
\&    vmsish::hushed($hush);
.Ve
.PP
.Vb 2
\&    use vmsish;
\&    no vmsish 'time';
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
If no import list is supplied, all possible VMS-specific features are
assumed.  Currently, there are four VMS-specific features available:
\&'status' (a.k.a '$?'), 'exit', 'time' and 'hushed'.
.PP
If you're not running \s-1VMS\s0, this module does nothing.
.ie n .IP """vmsish status""" 6
.el .IP "\f(CWvmsish status\fR" 6
.IX Item "vmsish status"
This makes \f(CW$?\fR and \f(CW\*(C`system\*(C'\fR return the native \s-1VMS\s0 exit status
instead of emulating the \s-1POSIX\s0 exit status.
.ie n .IP """vmsish exit""" 6
.el .IP "\f(CWvmsish exit\fR" 6
.IX Item "vmsish exit"
This makes \f(CW\*(C`exit 1\*(C'\fR produce a successful exit (with status \s-1SS$_NORMAL\s0),
instead of emulating \s-1UNIX\s0 \fIexit()\fR, which considers \f(CW\*(C`exit 1\*(C'\fR to indicate
an error.  As with the \s-1CRTL\s0's \fIexit()\fR function, \f(CW\*(C`exit 0\*(C'\fR is also mapped
to an exit status of \s-1SS$_NORMAL\s0, and any other argument to \fIexit()\fR is
used directly as Perl's exit status.
.ie n .IP """vmsish time""" 6
.el .IP "\f(CWvmsish time\fR" 6
.IX Item "vmsish time"
This makes all times relative to the local time zone, instead of the
default of Universal Time (a.k.a Greenwich Mean Time, or \s-1GMT\s0).
.ie n .IP """vmsish hushed""" 6
.el .IP "\f(CWvmsish hushed\fR" 6
.IX Item "vmsish hushed"
This suppresses printing of \s-1VMS\s0 status messages to \s-1SYS$OUTPUT\s0 and
\&\s-1SYS$ERROR\s0 if Perl terminates with an error status.  and allows
programs that are expecting \*(L"unix\-style\*(R" Perl to avoid having to parse
\&\s-1VMS\s0 error messages.  It does not suppress any messages from Perl
itself, just the messages generated by \s-1DCL\s0 after Perl exits.  The \s-1DCL\s0
symbol \f(CW$STATUS\fR will still have the termination status, but with a
high-order bit set:
.Sp
\&\s-1EXAMPLE:\s0
    $ perl \-e\*(L"exit 44;\*(R"                             Non-hushed error exit
    \f(CW%SYSTEM\fR\-F\-ABORT, abort                          \s-1DCL\s0 message
    $ show sym \f(CW$STATUS\fR
      \f(CW$STATUS\fR == \*(L"%X0000002C\*(R"
.Sp
.Vb 3
\&    $ perl -e"use vmsish qw(hushed); exit 44;"      Hushed error exit
\&    $ show sym $STATUS
\&      $STATUS == "%X1000002C"
.Ve
.Sp
The 'hushed' flag has a global scope during compilation: the \fIexit()\fR or
\&\fIdie()\fR commands that are compiled after 'vmsish hushed' will be hushed
when they are executed.  Doing a \*(L"no vmsish 'hushed'\*(R" turns off the
hushed flag.
.Sp
The status of the hushed flag also affects output of \s-1VMS\s0 error
messages from compilation errors.   Again, you still get the Perl
error message (and the code in \f(CW$STATUS\fR)
.Sp
\&\s-1EXAMPLE:\s0
    use vmsish 'hushed';    # turn on hushed flag
    use Carp;          # Carp compiled hushed
    exit 44;           # will be hushed
    croak('I die');    # will be hushed
    no vmsish 'hushed';     # turn off hushed flag
    exit 44;           # will not be hushed
    croak('I die2'):   # \s-1WILL\s0 be hushed, croak was compiled hushed
.Sp
You can also control the 'hushed' flag at run\-time, using the built-in
routine \fIvmsish::hushed()\fR.  Without argument, it returns the hushed status.
Since vmsish::hushed is built\-in, you do not need to \*(L"use vmsish\*(R" to call
it.
.Sp
\&\s-1EXAMPLE:\s0
    if ($quiet_exit) {
        \fIvmsish::hushed\fR\|(1);
    }
    print \*(L"Sssshhhh...I'm hushed...\en\*(R" if \fIvmsish::hushed()\fR;
    exit 44;
.Sp
Note that an \fIexit()\fR or \fIdie()\fR that is compiled 'hushed' because of \*(L"use
vmsish\*(R" is not un-hushed by calling \fIvmsish::hushed\fR\|(0) at runtime.
.Sp
The messages from error exits from inside the Perl core are generally
more serious, and are not suppressed.
.PP
See \*(L"Pragmatic Modules\*(R" in perlmod.