.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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 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.
.\"
.\" 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 "Level 3"
.TH Level 3 "2015-09-15" "perl v5.16.3" "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::Log4perl::Level \- Predefined log levels
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use Log::Log4perl::Level;
\&  print $ERROR, "\en";
\&
\&  # \-\- or \-\-
\&
\&  use Log::Log4perl qw(:levels);
\&  print $ERROR, "\en";
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Log::Log4perl::Level\*(C'\fR simply exports a predefined set of \fILog4perl\fR log
levels into the caller's name space. It is used internally by 
\&\f(CW\*(C`Log::Log4perl\*(C'\fR. The following scalars are defined:
.PP
.Vb 8
\&    $OFF
\&    $FATAL
\&    $ERROR
\&    $WARN
\&    $INFO
\&    $DEBUG
\&    $TRACE
\&    $ALL
.Ve
.PP
\&\f(CW\*(C`Log::Log4perl\*(C'\fR also exports these constants into the caller's namespace
if you pull it in providing the \f(CW\*(C`:levels\*(C'\fR tag:
.PP
.Vb 1
\&    use Log::Log4perl qw(:levels);
.Ve
.PP
This is the preferred way, there's usually no need to call 
\&\f(CW\*(C`Log::Log4perl::Level\*(C'\fR explicitly.
.PP
The numerical values assigned to these constants are purely virtual,
only used by Log::Log4perl internally and can change at any time,
so please don't make any assumptions. You can test for numerical equality
by directly comparing two level values, that's ok:
.PP
.Vb 3
\&    if( get_logger()\->level() == $DEBUG ) {
\&        print "The logger\*(Aqs level is DEBUG\en";
\&    }
.Ve
.PP
But if you want to figure out which of two levels is more verbose, use
Log4perl's own comparator:
.PP
.Vb 5
\&    if( Log::Log4perl::Level::isGreaterOrEqual( $level1, $level2 ) ) {
\&        print Log::Log4perl::Level::to_level( $level1 ), 
\&            " is equal or more verbose than ", 
\&            Log::Log4perl::Level::to_level( $level2 ), "\en";
\&    }
.Ve
.PP
If the caller wants to import level constants into a different namespace,
it can be provided with the \f(CW\*(C`use\*(C'\fR command:
.PP
.Vb 1
\&    use Log::Log4perl::Level qw(MyNameSpace);
.Ve
.PP
After this \f(CW$MyNameSpace::ERROR\fR, \f(CW$MyNameSpace::INFO\fR etc. 
will be defined accordingly.
.SS "Numeric levels and Strings"
.IX Subsection "Numeric levels and Strings"
Level variables like \f(CW$DEBUG\fR or \f(CW$WARN\fR have numeric values that are 
internal to Log4perl. Transform them to strings that can be used
in a Log4perl configuration file, use the c<\fIto_level()\fR> function
provided by Log::Log4perl::Level:
.PP
.Vb 2
\&    use Log::Log4perl qw(:easy);
\&    use Log::Log4perl::Level;
\&
\&        # prints "DEBUG"
\&    print Log::Log4perl::Level::to_level( $DEBUG ), "\en";
.Ve
.PP
To perform the reverse transformation, which takes a string like
\&\*(L"\s-1DEBUG\*(R"\s0 and converts it into a constant like \f(CW$DEBUG\fR, use the
\&\fIto_priority()\fR function:
.PP
.Vb 2
\&    use Log::Log4perl qw(:easy);
\&    use Log::Log4perl::Level;
\&
\&    my $numval = Log::Log4perl::Level::to_priority( "DEBUG" );
.Ve
.PP
after which \f(CW$numval\fR could be used where a numerical value is required:
.PP
.Vb 1
\&    Log::Log4perl\->easy_init( $numval );
.Ve
.SH "LICENSE"
.IX Header "LICENSE"
Copyright 2002\-2013 by Mike Schilli <m@perlmeister.com> 
and Kevin Goess <cpan@goess.org>.
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.SH "AUTHOR"
.IX Header "AUTHOR"
Please contribute patches to the project on Github:
.PP
.Vb 1
\&    http://github.com/mschilli/log4perl
.Ve
.PP
Send bug reports or requests for enhancements to the authors via our
.PP
\&\s-1MAILING LIST \s0(questions, bug reports, suggestions/patches): 
log4perl\-devel@lists.sourceforge.net
.PP
Authors (please contact them via the list above, not directly):
Mike Schilli <m@perlmeister.com>,
Kevin Goess <cpan@goess.org>
.PP
Contributors (in alphabetical order):
Ateeq Altaf, Cory Bennett, Jens Berthold, Jeremy Bopp, Hutton
Davidson, Chris R. Donnelly, Matisse Enzer, Hugh Esco, Anthony
Foiani, James FitzGibbon, Carl Franks, Dennis Gregorovic, Andy
Grundman, Paul Harrington, Alexander Hartmaier  David Hull, 
Robert Jacobson, Jason Kohles, Jeff Macdonald, Markus Peter, 
Brett Rann, Peter Rabbitson, Erik Selberg, Aaron Straup Cope, 
Lars Thegler, David Viner, Mac Yang.