.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.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.  \*(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-
.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" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "vmsish 3perl"
.TH vmsish 3perl "2021-09-24" "perl v5.32.1" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
vmsish \- Perl pragma to control VMS\-specific language features
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use vmsish;
\&
\&    use vmsish \*(Aqstatus\*(Aq;        # or \*(Aq$?\*(Aq
\&    use vmsish \*(Aqexit\*(Aq;
\&    use vmsish \*(Aqtime\*(Aq;
\&
\&    use vmsish \*(Aqhushed\*(Aq;
\&    no vmsish \*(Aqhushed\*(Aq;
\&    vmsish::hushed($hush);
\&
\&    use vmsish;
\&    no vmsish \*(Aqtime\*(Aq;
.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 \fBexit()\fR, which considers \f(CW\*(C`exit 1\*(C'\fR to indicate
an error.  As with the \s-1CRTL\s0's \fBexit()\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 \fBexit()\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 \fBexit()\fR or
\&\fBdie()\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 \fBvmsish::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) {
        \fBvmsish::hushed\fR\|(1);
    } 
    print \*(L"Sssshhhh...I'm hushed...\en\*(R" if \fBvmsish::hushed()\fR;
    exit 44;
.Sp
Note that an \fBexit()\fR or \fBdie()\fR that is compiled 'hushed' because of \*(L"use
vmsish\*(R" is not un-hushed by calling \fBvmsish::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"Perl Modules\*(R" in perlmod.