.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "Appender::ScreenColoredLevels 3"
.TH Appender::ScreenColoredLevels 3 2023-07-25 "perl v5.38.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
Log::Log4perl::Appender::ScreenColoredLevels \- Colorize messages according to level
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use Log::Log4perl qw(:easy);
\&
\&    Log::Log4perl\->init(\e <<\*(AqEOT\*(Aq);
\&      log4perl.category = DEBUG, Screen
\&      log4perl.appender.Screen = \e
\&          Log::Log4perl::Appender::ScreenColoredLevels
\&      log4perl.appender.Screen.layout = \e
\&          Log::Log4perl::Layout::PatternLayout
\&      log4perl.appender.Screen.layout.ConversionPattern = \e
\&          %d %F{1} %L> %m %n
\&    EOT
\&
\&      # Appears black
\&    DEBUG "Debug Message";
\&
\&      # Appears green
\&    INFO  "Info Message";
\&
\&      # Appears blue
\&    WARN  "Warn Message";
\&
\&      # Appears magenta
\&    ERROR "Error Message";
\&
\&      # Appears red
\&    FATAL "Fatal Message";
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This appender acts like Log::Log4perl::Appender::Screen, except that
it colorizes its output, based on the priority of the message sent.
.PP
You can configure the colors and attributes used for the different
levels, by specifying them in your configuration:
.PP
.Vb 2
\&    log4perl.appender.Screen.color.TRACE=cyan
\&    log4perl.appender.Screen.color.DEBUG=bold blue
.Ve
.PP
You can also specify nothing, to indicate that level should not have
coloring applied, which means the text will be whatever the default
color for your terminal is.  This is the default for debug messages.
.PP
.Vb 1
\&    log4perl.appender.Screen.color.DEBUG=
.Ve
.PP
You can use any attribute supported by Term::ANSIColor as a configuration
option.
.PP
.Vb 2
\&    log4perl.appender.Screen.color.FATAL=\e
\&        bold underline blink red on_white
.Ve
.PP
The commonly used colors and attributes are:
.IP attributes 4
.IX Item "attributes"
BOLD, DARK, UNDERLINE, UNDERSCORE, BLINK
.IP colors 4
.IX Item "colors"
BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE
.IP "background colors" 4
.IX Item "background colors"
ON_BLACK, ON_RED, ON_GREEN, ON_YELLOW, ON_BLUE, ON_MAGENTA, ON_CYAN, ON_WHITE
.PP
See Term::ANSIColor for a complete list, and information on which are
supported by various common terminal emulators.
.PP
The default values for these options are:
.IP Trace 4
.IX Item "Trace"
Yellow
.IP Debug 4
.IX Item "Debug"
None (whatever the terminal default is)
.IP Info 4
.IX Item "Info"
Green
.IP Warn 4
.IX Item "Warn"
Blue
.IP Error 4
.IX Item "Error"
Magenta
.IP Fatal 4
.IX Item "Fatal"
Red
.PP
The constructor \f(CWnew()\fR takes an optional parameter \f(CW\*(C`stderr\*(C'\fR,
if set to a true value, the appender will log all levels to STDERR.
If \f(CW\*(C`stderr\*(C'\fR is set to a false value, it will log all levels to
STDOUT. Otherwise, \f(CW\*(C`stderr\*(C'\fR may be set to a hash, with a key for
each \f(CW\*(C`log4p_level\*(C'\fR and a truthy value to dynamically use stderr.
The default setting for \f(CW\*(C`stderr\*(C'\fR is 1, so all messages will be logged
to STDERR by default.
.PP
.Vb 4
\&    # All messages/levels to STDERR
\&    my $app = Log::Log4perl::Appender::Screen\->new(
\&        stderr  => 1,
\&    );
\&
\&    # Only ERROR and FATAL to STDERR (case\-sensitive)
\&    my $app = Log::Log4perl::Appender::Screen\->new(
\&        stderr  => { ERROR => 1, FATAL => 1},
\&    );
.Ve
.PP
The constructor can also take an optional
parameter \f(CW\*(C`color\*(C'\fR, whose value is a  hashref of color configuration
options, any levels that are not included in the hashref will be set
to their default values.
.SS "Using ScreenColoredLevels on Windows"
.IX Subsection "Using ScreenColoredLevels on Windows"
Note that if you're using this appender on Windows, you need to fetch
Win32::Console::ANSI from CPAN and add
.PP
.Vb 1
\&    use Win32::Console::ANSI;
.Ve
.PP
to your script.
.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
MAILING LIST (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.