.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" 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 "Log::Contextual::WarnLogger 3pm"
.TH Log::Contextual::WarnLogger 3pm "2010-07-31" "perl v5.10.1" "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"
Log::Contextual::WarnLogger \- Simple logger for libraries using Log::Contextual
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\& package My::Package;
\& use Log::Contextual::WarnLogger;
\& use Log::Contextual qw( :log ),
\&   \-default_logger => Log::Contextual::WarnLogger\->new({
\&      env_prefix => \*(AqMY_PACKAGE\*(Aq
\&   });
\&
\& # warns \*(Aq[info] program started\*(Aq if $ENV{MY_PACKAGE_TRACE} is set
\& log_info { \*(Aqprogram started\*(Aq }; # no\-op because info is not in levels
\& sub foo {
\&   # warns \*(Aq[debug] entered foo\*(Aq if $ENV{MY_PACKAGE_DEBUG} is set
\&   log_debug { \*(Aqentered foo\*(Aq };
\&   ...
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module is a simple logger made for libraries using Log::Contextual.  We
recommend the use of this logger as your default logger as it is simple and
useful for most users, yet users can use \*(L"set_logger\*(R" in Log::Contextual to override
your choice of logger in their own code thanks to the way Log::Contextual
works.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
Arguments: \f(CW\*(C`Dict[ env_prefix => Str ] $conf\*(C'\fR
.PP
.Vb 3
\& my $l = Log::Contextual::WarnLogger\->new({
\&   env_prefix
\& });
.Ve
.PP
Creates a new logger object where \f(CW\*(C`env_prefix\*(C'\fR defines what the prefix is for
the environment variables that will be checked for the six log levels.  For
example, if \f(CW\*(C`env_prefix\*(C'\fR is set to \f(CW\*(C`FREWS_PACKAGE\*(C'\fR the following environment
variables will be used:
.PP
.Vb 1
\& FREWS_PACKAGE_UPTO
\&
\& FREWS_PACKAGE_TRACE
\& FREWS_PACKAGE_DEBUG
\& FREWS_PACKAGE_INFO
\& FREWS_PACKAGE_WARN
\& FREWS_PACKAGE_ERROR
\& FREWS_PACKAGE_FATAL
.Ve
.PP
Note that \f(CW\*(C`UPTO\*(C'\fR is a convenience variable.  If you set
\&\f(CW\*(C`FOO_UPTO=TRACE\*(C'\fR it will enable all log levels.  Similarly, if you
set it to \f(CW\*(C`FATAL\*(C'\fR only fatal will be enabled.
.ie n .SS "$level"
.el .SS "\f(CW$level\fP"
.IX Subsection "$level"
Arguments: \f(CW@anything\fR
.PP
All of the following six methods work the same.  The basic pattern is:
.PP
.Vb 2
\& sub $level {
\&   my $self = shift;
\&
\&   warn "[$level] " . join qq{\en}, @_;
\&      if $self\->is_$level;
\& }
.Ve
.PP
\fItrace\fR
.IX Subsection "trace"
.PP
.Vb 1
\& $l\->trace( \*(Aqentered method foo with args \*(Aq join q{,}, @args );
.Ve
.PP
\fIdebug\fR
.IX Subsection "debug"
.PP
.Vb 1
\& $l\->debug( \*(Aqentered method foo\*(Aq );
.Ve
.PP
\fIinfo\fR
.IX Subsection "info"
.PP
.Vb 1
\& $l\->info( \*(Aqstarted process foo\*(Aq );
.Ve
.PP
\fIwarn\fR
.IX Subsection "warn"
.PP
.Vb 1
\& $l\->warn( \*(Aqpossible misconfiguration at line 10\*(Aq );
.Ve
.PP
\fIerror\fR
.IX Subsection "error"
.PP
.Vb 1
\& $l\->error( \*(Aqnon\-numeric user input!\*(Aq );
.Ve
.PP
\fIfatal\fR
.IX Subsection "fatal"
.PP
.Vb 1
\& $l\->fatal( \*(Aq1 is never equal to 0!\*(Aq );
.Ve
.SS "is_$level"
.IX Subsection "is_$level"
All of the following six functions just return true if their respective
environment variable is enabled.
.PP
\fIis_trace\fR
.IX Subsection "is_trace"
.PP
.Vb 1
\& say \*(Aqtracing\*(Aq if $l\->is_trace;
.Ve
.PP
\fIis_debug\fR
.IX Subsection "is_debug"
.PP
.Vb 1
\& say \*(Aqdebuging\*(Aq if $l\->is_debug;
.Ve
.PP
\fIis_info\fR
.IX Subsection "is_info"
.PP
.Vb 1
\& say q{info\*(Aqing} if $l\->is_info;
.Ve
.PP
\fIis_warn\fR
.IX Subsection "is_warn"
.PP
.Vb 1
\& say \*(Aqwarning\*(Aq if $l\->is_warn;
.Ve
.PP
\fIis_error\fR
.IX Subsection "is_error"
.PP
.Vb 1
\& say \*(Aqerroring\*(Aq if $l\->is_error;
.Ve
.PP
\fIis_fatal\fR
.IX Subsection "is_fatal"
.PP
.Vb 1
\& say q{fatal\*(Aqing} if $l\->is_fatal;
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
See \*(L"\s-1AUTHOR\s0\*(R" in Log::Contextual
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
See \*(L"\s-1COPYRIGHT\s0\*(R" in Log::Contextual
.SH "LICENSE"
.IX Header "LICENSE"
See \*(L"\s-1LICENSE\s0\*(R" in Log::Contextual