.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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 "Data::Phrasebook::Debug 3pm"
.TH Data::Phrasebook::Debug 3pm "2022-11-19" "perl v5.36.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"
Data::Phrasebook::Debug \- Phrasebook debugging.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Data::Phrasebook;
\&
\&    my $q = Data::Phrasebook\->new(
\&        class  => \*(AqPlain\*(Aq,
\&        loader => \*(AqText\*(Aq,
\&        file   => \*(Aqphrases.txt\*(Aq,
\&        debug  => 2,
\&    );
\&
\&    my $r = Phrasebook\->new( file  => \*(Aqphrases.txt\*(Aq, debug => 3 );
\&
\&    $r\->debug(4);
\&    $r\->store(3,"Start");
\&    my @log = $r\->retrieve(2);
\&    $r\->clear();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module enables debug logging for phrasebook classes. It simply stores
all interaction with the phrasebook, which can then be interrogated. Do not
call directly, but via the class object.
.PP
There is a single storage for all levels of the Data::Phrasebook heirarchy.
This then enables storage and retrieval to be performed by the user. There
are several different levels of debugging, detailed as follows:
.PP
.Vb 4
\&  1 \- Errors
\&  2 \- Warnings
\&  3 \- Information
\&  4 \- Variable Debugging
.Ve
.PP
The first three are simple strings that are recorded during the processing.
However, the latter is specifically for dumping the contents of significant
variables.
.PP
Through the use of the \fBdebug()\fR method, the debugging can be switched on and
off at significant points. The \fBclear()\fR method will clear the current trail of
debugging information.
.SH "METHODS"
.IX Header "METHODS"
.SS "debug"
.IX Subsection "debug"
Accessor to debugging flag.
.SS "clear"
.IX Subsection "clear"
Clear the currently stored debugging information.
.SS "store"
.IX Subsection "store"
Store debugging information.
.SS "retrieve"
.IX Subsection "retrieve"
Retrieve debugging information.
.SS "dumper"
.IX Subsection "dumper"
Uses 'on demand' call to \fBData::Dumper::Dumper()\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Data::Phrasebook.
.SH "SUPPORT"
.IX Header "SUPPORT"
Please see the \s-1README\s0 file.
.SH "AUTHOR"
.IX Header "AUTHOR"
.Vb 2
\&  Barbie, <barbie@cpan.org>
\&  for Miss Barbell Productions <http://www.missbarbell.co.uk>.
.Ve
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
.Vb 1
\&  Copyright (C) 2004\-2013 Barbie for Miss Barbell Productions.
\&
\&  This distribution is free software; you can redistribute it and/or
\&  modify it under the Artistic License v2.
.Ve