.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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 "Carp 3perl"
.TH Carp 3perl "2011-09-26" "perl v5.14.2" "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"
Carp \- alternative warn and die for modules
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Carp;
\&
\&    # warn user (from perspective of caller)
\&    carp "string trimmed to 80 chars";
\&
\&    # die of errors (from perspective of caller)
\&    croak "We\*(Aqre outta here!";
\&
\&    # die of errors with stack backtrace
\&    confess "not implemented";
\&
\&    # cluck not exported by default
\&    use Carp qw(cluck);
\&    cluck "This is how we got here!";
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The Carp routines are useful in your own modules because
they act like \fIdie()\fR or \fIwarn()\fR, but with a message which is more
likely to be useful to a user of your module.  In the case of
cluck, confess, and longmess that context is a summary of every
call in the call-stack.  For a shorter message you can use \f(CW\*(C`carp\*(C'\fR
or \f(CW\*(C`croak\*(C'\fR which report the error as being from where your module
was called.  There is no guarantee that that is where the error
was, but it is a good educated guess.
.PP
You can also alter the way the output and logic of \f(CW\*(C`Carp\*(C'\fR works, by
changing some global variables in the \f(CW\*(C`Carp\*(C'\fR namespace. See the
section on \f(CW\*(C`GLOBAL VARIABLES\*(C'\fR below.
.PP
Here is a more complete description of how \f(CW\*(C`carp\*(C'\fR and \f(CW\*(C`croak\*(C'\fR work.
What they do is search the call-stack for a function call stack where
they have not been told that there shouldn't be an error.  If every
call is marked safe, they give up and give a full stack backtrace
instead.  In other words they presume that the first likely looking
potential suspect is guilty.  Their rules for telling whether
a call shouldn't generate errors work as follows:
.IP "1." 4
Any call from a package to itself is safe.
.IP "2." 4
Packages claim that there won't be errors on calls to or from
packages explicitly marked as safe by inclusion in \f(CW@CARP_NOT\fR, or
(if that array is empty) \f(CW@ISA\fR.  The ability to override what
\&\f(CW@ISA\fR says is new in 5.8.
.IP "3." 4
The trust in item 2 is transitive.  If A trusts B, and B
trusts C, then A trusts C.  So if you do not override \f(CW@ISA\fR
with \f(CW@CARP_NOT\fR, then this trust relationship is identical to,
\&\*(L"inherits from\*(R".
.IP "4." 4
Any call from an internal Perl module is safe.  (Nothing keeps
user modules from marking themselves as internal to Perl, but
this practice is discouraged.)
.IP "5." 4
Any call to Perl's warning system (eg Carp itself) is safe.
(This rule is what keeps it from reporting the error at the
point where you call \f(CW\*(C`carp\*(C'\fR or \f(CW\*(C`croak\*(C'\fR.)
.IP "6." 4
\&\f(CW$Carp::CarpLevel\fR can be set to skip a fixed number of additional
call levels.  Using this is not recommended because it is very
difficult to get it to behave correctly.
.SS "Forcing a Stack Trace"
.IX Subsection "Forcing a Stack Trace"
As a debugging aid, you can force Carp to treat a croak as a confess
and a carp as a cluck across \fIall\fR modules. In other words, force a
detailed stack trace to be given.  This can be very helpful when trying
to understand why, or from where, a warning or error is being generated.
.PP
This feature is enabled by 'importing' the non-existent symbol
\&'verbose'. You would typically enable it by saying
.PP
.Vb 1
\&    perl \-MCarp=verbose script.pl
.Ve
.PP
or by including the string \f(CW\*(C`\-MCarp=verbose\*(C'\fR in the \s-1PERL5OPT\s0
environment variable.
.PP
Alternately, you can set the global variable \f(CW$Carp::Verbose\fR to true.
See the \f(CW\*(C`GLOBAL VARIABLES\*(C'\fR section below.
.SH "GLOBAL VARIABLES"
.IX Header "GLOBAL VARIABLES"
.ie n .SS "$Carp::MaxEvalLen"
.el .SS "\f(CW$Carp::MaxEvalLen\fP"
.IX Subsection "$Carp::MaxEvalLen"
This variable determines how many characters of a string-eval are to
be shown in the output. Use a value of \f(CW0\fR to show all text.
.PP
Defaults to \f(CW0\fR.
.ie n .SS "$Carp::MaxArgLen"
.el .SS "\f(CW$Carp::MaxArgLen\fP"
.IX Subsection "$Carp::MaxArgLen"
This variable determines how many characters of each argument to a
function to print. Use a value of \f(CW0\fR to show the full length of the
argument.
.PP
Defaults to \f(CW64\fR.
.ie n .SS "$Carp::MaxArgNums"
.el .SS "\f(CW$Carp::MaxArgNums\fP"
.IX Subsection "$Carp::MaxArgNums"
This variable determines how many arguments to each function to show.
Use a value of \f(CW0\fR to show all arguments to a function call.
.PP
Defaults to \f(CW8\fR.
.ie n .SS "$Carp::Verbose"
.el .SS "\f(CW$Carp::Verbose\fP"
.IX Subsection "$Carp::Verbose"
This variable makes \f(CW\*(C`carp\*(C'\fR and \f(CW\*(C`croak\*(C'\fR generate stack backtraces
just like \f(CW\*(C`cluck\*(C'\fR and \f(CW\*(C`confess\*(C'\fR.  This is how \f(CW\*(C`use Carp \*(Aqverbose\*(Aq\*(C'\fR
is implemented internally.
.PP
Defaults to \f(CW0\fR.
.ie n .SS "@CARP_NOT"
.el .SS "\f(CW@CARP_NOT\fP"
.IX Subsection "@CARP_NOT"
This variable, \fIin your package\fR, says which packages are \fInot\fR to be
considered as the location of an error. The \f(CW\*(C`carp()\*(C'\fR and \f(CW\*(C`cluck()\*(C'\fR
functions will skip over callers when reporting where an error occurred.
.PP
\&\s-1NB:\s0 This variable must be in the package's symbol table, thus:
.PP
.Vb 4
\&    # These work
\&    our @CARP_NOT; # file scope
\&    use vars qw(@CARP_NOT); # package scope
\&    @My::Package::CARP_NOT = ... ; # explicit package variable
\&
\&    # These don\*(Aqt work
\&    sub xyz { ... @CARP_NOT = ... } # w/o declarations above
\&    my @CARP_NOT; # even at top\-level
.Ve
.PP
Example of use:
.PP
.Vb 9
\&    package My::Carping::Package;
\&    use Carp;
\&    our @CARP_NOT;
\&    sub bar     { .... or _error(\*(AqWrong input\*(Aq) }
\&    sub _error  {
\&        # temporary control of where\*(Aqness, _\|_PACKAGE_\|_ is implicit
\&        local @CARP_NOT = qw(My::Friendly::Caller);
\&        carp(@_)
\&    }
.Ve
.PP
This would make \f(CW\*(C`Carp\*(C'\fR report the error as coming from a caller not
in \f(CW\*(C`My::Carping::Package\*(C'\fR, nor from \f(CW\*(C`My::Friendly::Caller\*(C'\fR.
.PP
Also read the \*(L"\s-1DESCRIPTION\s0\*(R" section above, about how \f(CW\*(C`Carp\*(C'\fR decides
where the error is reported from.
.PP
Use \f(CW@CARP_NOT\fR, instead of \f(CW$Carp::CarpLevel\fR.
.PP
Overrides \f(CW\*(C`Carp\*(C'\fR's use of \f(CW@ISA\fR.
.ie n .SS "%Carp::Internal"
.el .SS "\f(CW%Carp::Internal\fP"
.IX Subsection "%Carp::Internal"
This says what packages are internal to Perl.  \f(CW\*(C`Carp\*(C'\fR will never
report an error as being from a line in a package that is internal to
Perl.  For example:
.PP
.Vb 3
\&    $Carp::Internal{ (_\|_PACKAGE_\|_) }++;
\&    # time passes...
\&    sub foo { ... or confess("whatever") };
.Ve
.PP
would give a full stack backtrace starting from the first caller
outside of _\|_PACKAGE_\|_.  (Unless that package was also internal to
Perl.)
.ie n .SS "%Carp::CarpInternal"
.el .SS "\f(CW%Carp::CarpInternal\fP"
.IX Subsection "%Carp::CarpInternal"
This says which packages are internal to Perl's warning system.  For
generating a full stack backtrace this is the same as being internal
to Perl, the stack backtrace will not start inside packages that are
listed in \f(CW%Carp::CarpInternal\fR.  But it is slightly different for
the summary message generated by \f(CW\*(C`carp\*(C'\fR or \f(CW\*(C`croak\*(C'\fR.  There errors
will not be reported on any lines that are calling packages in
\&\f(CW%Carp::CarpInternal\fR.
.PP
For example \f(CW\*(C`Carp\*(C'\fR itself is listed in \f(CW%Carp::CarpInternal\fR.
Therefore the full stack backtrace from \f(CW\*(C`confess\*(C'\fR will not start
inside of \f(CW\*(C`Carp\*(C'\fR, and the short message from calling \f(CW\*(C`croak\*(C'\fR is
not placed on the line where \f(CW\*(C`croak\*(C'\fR was called.
.ie n .SS "$Carp::CarpLevel"
.el .SS "\f(CW$Carp::CarpLevel\fP"
.IX Subsection "$Carp::CarpLevel"
This variable determines how many additional call frames are to be
skipped that would not otherwise be when reporting where an error
occurred on a call to one of \f(CW\*(C`Carp\*(C'\fR's functions.  It is fairly easy
to count these call frames on calls that generate a full stack
backtrace.  However it is much harder to do this accounting for calls
that generate a short message.  Usually people skip too many call
frames.  If they are lucky they skip enough that \f(CW\*(C`Carp\*(C'\fR goes all of
the way through the call stack, realizes that something is wrong, and
then generates a full stack backtrace.  If they are unlucky then the
error is reported from somewhere misleading very high in the call
stack.
.PP
Therefore it is best to avoid \f(CW$Carp::CarpLevel\fR.  Instead use
\&\f(CW@CARP_NOT\fR, \f(CW%Carp::Internal\fR and \f(CW%Carp::CarpInternal\fR.
.PP
Defaults to \f(CW0\fR.
.SH "BUGS"
.IX Header "BUGS"
The Carp routines don't handle exception objects currently.
If called with a first argument that is a reference, they simply
call \fIdie()\fR or \fIwarn()\fR, as appropriate.