.\" 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 "Config 3"
.TH Config 3 "2016-01-27" "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::Config \- Log4perl configuration file syntax
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
In \f(CW\*(C`Log::Log4perl\*(C'\fR, configuration files are used to describe how the
system's loggers ought to behave.
.PP
The format is the same as the one as used for \f(CW\*(C`log4j\*(C'\fR, just with
a few perl-specific extensions, like enabling the \f(CW\*(C`Bar::Twix\*(C'\fR
syntax instead of insisting on the Java-specific \f(CW\*(C`Bar.Twix\*(C'\fR.
.PP
Comment lines and blank lines (all whitespace or empty) are ignored.
.PP
Comment lines may start with arbitrary whitespace followed by one of:
.IP "# \- Common comment delimiter" 4
.IX Item "# - Common comment delimiter"
.PD 0
.IP "! \- Java .properties file comment delimiter accepted by log4j" 4
.IX Item "! - Java .properties file comment delimiter accepted by log4j"
.IP "; \- Common .ini file comment delimiter" 4
.IX Item "; - Common .ini file comment delimiter"
.PD
.PP
Comments at the end of a line are not supported. So if you write
.PP
.Vb 1
\&    log4perl.appender.A1.filename=error.log #in current dir
.Ve
.PP
you will find your messages in a file called \f(CW\*(C`error.log #in current dir\*(C'\fR.
.PP
Also, blanks between syntactical entities are ignored, it doesn't 
matter if you write
.PP
.Vb 1
\&    log4perl.logger.Bar.Twix=WARN,Screen
.Ve
.PP
or
.PP
.Vb 1
\&    log4perl.logger.Bar.Twix = WARN, Screen
.Ve
.PP
\&\f(CW\*(C`Log::Log4perl\*(C'\fR will strip the blanks while parsing your input.
.PP
Assignments need to be on a single line. However, you can break the
line if you want to by using a continuation character at the end of the
line. Instead of writing
.PP
.Vb 1
\&    log4perl.appender.A1.layout=Log::Log4perl::Layout::SimpleLayout
.Ve
.PP
you can break the line at any point by putting a backslash at the very (!)
end of the line to be continued:
.PP
.Vb 2
\&    log4perl.appender.A1.layout=\e
\&        Log::Log4perl::Layout::SimpleLayout
.Ve
.PP
Watch out for trailing blanks after the backslash, which would prevent
the line from being properly concatenated.
.SS "Loggers"
.IX Subsection "Loggers"
Loggers are addressed by category:
.PP
.Vb 1
\&    log4perl.logger.Bar.Twix      = WARN, Screen
.Ve
.PP
This sets all loggers under the \f(CW\*(C`Bar::Twix\*(C'\fR hierarchy on priority
\&\f(CW\*(C`WARN\*(C'\fR and attaches a later-to-be-defined \f(CW\*(C`Screen\*(C'\fR appender to them.
Settings for the root appender (which doesn't have a name) can be
accomplished by simply omitting the name:
.PP
.Vb 1
\&    log4perl.logger = FATAL, Database, Mailer
.Ve
.PP
This sets the root appender's level to \f(CW\*(C`FATAL\*(C'\fR and also attaches the 
later-to-be-defined appenders \f(CW\*(C`Database\*(C'\fR and \f(CW\*(C`Mailer\*(C'\fR to it. Alternatively,
the root logger can be addressed as \f(CW\*(C`rootLogger\*(C'\fR:
.PP
.Vb 1
\&    log4perl.rootLogger = FATAL, Database, Mailer
.Ve
.PP
The additivity flag of a logger is set or cleared via the 
\&\f(CW\*(C`additivity\*(C'\fR keyword:
.PP
.Vb 1
\&    log4perl.additivity.Bar.Twix = 0|1
.Ve
.PP
(Note the reversed order of keyword and logger name, resulting
from the dilemma that a logger name could end in \f(CW\*(C`.additivity\*(C'\fR
according to the log4j documentation).
.SS "Appenders and Layouts"
.IX Subsection "Appenders and Layouts"
Appender names used in Log4perl configuration file
lines need to be resolved later on, in order to
define the appender's properties and its layout. To specify properties
of an appender, just use the \f(CW\*(C`appender\*(C'\fR keyword after the
\&\f(CW\*(C`log4perl\*(C'\fR intro and the appender's name:
.PP
.Vb 6
\&        # The Bar::Twix logger and its appender
\&    log4perl.logger.Bar.Twix = DEBUG, A1
\&    log4perl.appender.A1=Log::Log4perl::Appender::File
\&    log4perl.appender.A1.filename=test.log
\&    log4perl.appender.A1.mode=append
\&    log4perl.appender.A1.layout=Log::Log4perl::Layout::SimpleLayout
.Ve
.PP
This sets a priority of \f(CW\*(C`DEBUG\*(C'\fR for loggers in the \f(CW\*(C`Bar::Twix\*(C'\fR
hierarchy and assigns the \f(CW\*(C`A1\*(C'\fR appender to it, which is later on
resolved to be an appender of type \f(CW\*(C`Log::Log4perl::Appender::File\*(C'\fR, simply
appending to a log file. According to the \f(CW\*(C`Log::Log4perl::Appender::File\*(C'\fR
manpage, the \f(CW\*(C`filename\*(C'\fR parameter specifies the name of the log file
and the \f(CW\*(C`mode\*(C'\fR parameter can be set to \f(CW\*(C`append\*(C'\fR or \f(CW\*(C`write\*(C'\fR (the
former will append to the logfile if one with the specified name
already exists while the latter would clobber and overwrite it).
.PP
The order of the entries in the configuration file is not important,
\&\f(CW\*(C`Log::Log4perl\*(C'\fR will read in the entire file first and try to make
sense of the lines after it knows the entire context.
.PP
You can very well define all loggers first and then their appenders
(you could even define your appenders first and then your loggers,
but let's not go there):
.PP
.Vb 2
\&    log4perl.logger.Bar.Twix = DEBUG, A1
\&    log4perl.logger.Bar.Snickers = FATAL, A2
\&
\&    log4perl.appender.A1=Log::Log4perl::Appender::File
\&    log4perl.appender.A1.filename=test.log
\&    log4perl.appender.A1.mode=append
\&    log4perl.appender.A1.layout=Log::Log4perl::Layout::SimpleLayout
\&
\&    log4perl.appender.A2=Log::Log4perl::Appender::Screen
\&    log4perl.appender.A2.stderr=0
\&    log4perl.appender.A2.layout=Log::Log4perl::Layout::PatternLayout
\&    log4perl.appender.A2.layout.ConversionPattern = %d %m %n
.Ve
.PP
Note that you have to specify the full path to the layout class
and that \f(CW\*(C`ConversionPattern\*(C'\fR is the keyword to specify the printf-style
formatting instructions.
.SH "Configuration File Cookbook"
.IX Header "Configuration File Cookbook"
Here's some examples of often-used Log4perl configuration files:
.SS "Append to \s-1STDERR\s0"
.IX Subsection "Append to STDERR"
.Vb 5
\&    log4perl.category.Bar.Twix      = WARN, Screen
\&    log4perl.appender.Screen        = Log::Log4perl::Appender::Screen
\&    log4perl.appender.Screen.layout = \e
\&        Log::Log4perl::Layout::PatternLayout
\&    log4perl.appender.Screen.layout.ConversionPattern = %d %m %n
.Ve
.SS "Append to \s-1STDOUT\s0"
.IX Subsection "Append to STDOUT"
.Vb 6
\&    log4perl.category.Bar.Twix      = WARN, Screen
\&    log4perl.appender.Screen        = Log::Log4perl::Appender::Screen
\&    log4perl.appender.Screen.stderr = 0
\&    log4perl.appender.Screen.layout = \e
\&        Log::Log4perl::Layout::PatternLayout
\&    log4perl.appender.Screen.layout.ConversionPattern = %d %m %n
.Ve
.SS "Append to a log file"
.IX Subsection "Append to a log file"
.Vb 7
\&    log4perl.logger.Bar.Twix = DEBUG, A1
\&    log4perl.appender.A1=Log::Log4perl::Appender::File
\&    log4perl.appender.A1.filename=test.log
\&    log4perl.appender.A1.mode=append
\&    log4perl.appender.A1.layout = \e
\&        Log::Log4perl::Layout::PatternLayout
\&    log4perl.appender.A1.layout.ConversionPattern = %d %m %n
.Ve
.PP
Note that you could even leave out
.PP
.Vb 1
\&    log4perl.appender.A1.mode=append
.Ve
.PP
and still have the logger append to the logfile by default, although
the \f(CW\*(C`Log::Log4perl::Appender::File\*(C'\fR module does exactly the opposite.
This is due to some nasty trickery \f(CW\*(C`Log::Log4perl\*(C'\fR performs behind 
the scenes to make sure that beginner's \s-1CGI\s0 applications don't clobber 
the log file every time they're called.
.SS "Write a log file from scratch"
.IX Subsection "Write a log file from scratch"
If you loathe the Log::Log4perl's append-by-default strategy, you can
certainly override it:
.PP
.Vb 5
\&    log4perl.logger.Bar.Twix = DEBUG, A1
\&    log4perl.appender.A1=Log::Log4perl::Appender::File
\&    log4perl.appender.A1.filename=test.log
\&    log4perl.appender.A1.mode=write
\&    log4perl.appender.A1.layout=Log::Log4perl::Layout::SimpleLayout
.Ve
.PP
\&\f(CW\*(C`write\*(C'\fR is the \f(CW\*(C`mode\*(C'\fR that has \f(CW\*(C`Log::Log4perl::Appender::File\*(C'\fR
explicitly clobber the log file if it exists.
.SS "Configuration files encoded in utf\-8"
.IX Subsection "Configuration files encoded in utf-8"
If your configuration file is encoded in utf\-8 (which matters if you 
e.g. specify utf8\-encoded appender filenames in it), then you need to 
tell Log4perl before running \fIinit()\fR:
.PP
.Vb 2
\&    use Log::Log4perl::Config;
\&    Log::Log4perl::Config\->utf( 1 );
\&
\&    Log::Log4perl\->init( ... );
.Ve
.PP
This makes sure Log4perl interprets utf8\-encoded config files correctly.
This setting might become the default at some point.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Log::Log4perl::Config::PropertyConfigurator
.PP
Log::Log4perl::Config::DOMConfigurator
.PP
Log::Log4perl::Config::LDAPConfigurator (coming soon!)
.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.