.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 "Datum::Strip 3pm"
.TH Datum::Strip 3pm "2022-06-30" "perl v5.34.0" "User Contributed Perl Documentation"
.\" 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::Datum::Strip \- strips most Carp::Datum calls lexically
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Carp::Datum::Strip qw(datum_strip);
\&
\& datum_strip("\-", "\-");
\& datum_strip($file, "$file.new", ".bak");
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module exports a single routine, \fBdatum_strip()\fR, whose purpose is
to remove calls to \f(CW\*(C`Carp::Datum\*(C'\fR routines lexically.
.PP
Because stripping is done lexically, there are some restrictions about
what is actually supported.  Unless the conventions documented in
Carp::Datum are followed, stripping will be incorrect.
.PP
The general guidelines are:
.IP "\(bu" 4
Do not use here documents or generalized quotes (qq) within 
assertion expression or tags.  Write assertions using '' or "",
as appropriate.
.IP "\(bu" 4
Assertions can be safely put on several lines, but must end with a semi-colon,
outside any string.
.PP
There are two calls that will never be stripped: \s-1\fBVERIFY\s0()\fR and \s-1\fBDTRACE\s0()\fR.
The \s-1\fBVERIFY\s0()\fR is meant to be preserved (or \f(CW\*(C`DREQUIRE\*(C'\fR would have been used).
\&\f(CW\*(C`DTRACE\*(C'\fR, when called, will be remapped dynamically to some
\&\f(CW\*(C`Log::Agent\*(C'\fR routine, depending on the trace level.  See Carp::Datum
for details.
.SH "INTERFACE"
.IX Header "INTERFACE"
The interface of the \fBdatum_strip()\fR routine is:
.ie n .IP """datum_strip"" \fIold_file\fR, \fInew_file\fR, [\fIext\fR]" 4
.el .IP "\f(CWdatum_strip\fR \fIold_file\fR, \fInew_file\fR, [\fIext\fR]" 4
.IX Item "datum_strip old_file, new_file, [ext]"
The \fIold_file\fR specifies the old file path, the one to be stripped.
The stripped version will be written to \fInew_file\fR.
.Sp
If the optional third argument \fIext\fR is given (e.g. \*(L".bak\*(R"),
then \fIold_file\fR will be renamed with the supplied extension, and \fInew_file\fR
will be renamed \fIold_file\fR.  Renaming only occurs if stripping was successful
(i.e. the new file was correctly written to disk).
.Sp
The lowest nine \*(L"rwx\*(R" mode bits from \fIold_file\fR are preserved when
creating \fInew_file\fR.
.Sp
Both \fIold_file\fR and \fInew_file\fR can be set to \*(L"\-\*(R", in which case \s-1STDIN\s0
and \s-1STDOUT\s0 are used, respectively, and no renaming can occur, nor any
mode bit propagation.
.Sp
Returns true on success, \f(CW\*(C`undef\*(C'\fR on error.
.SH "AUTHORS"
.IX Header "AUTHORS"
Christophe Dehaudt and Raphael Manfredi are the original authors.
.PP
Send bug reports, hints, tips, suggestions to Dave Hoover at <squirrel@cpan.org>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBCarp::Datum\fR\|(3).