.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" 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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Appender::Screen 3"
.TH Appender::Screen 3 2026-08-14 "perl v5.42.2" "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::Screen \- Log to STDOUT/STDERR
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use Log::Log4perl::Appender::Screen;
\&
\&    my $app = Log::Log4perl::Appender::Screen\->new(
\&      autoflush => 1,
\&      stderr    => 0,
\&      utf8      => 1,
\&    );
\&
\&    $file\->log(message => "Log me\en");
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is a simple appender for writing to STDOUT or STDERR.
.PP
The constructor \f(CWnew()\fR takes an optional parameter \f(CW\*(C`stderr\*(C'\fR:
.IP \(bu 4
If set to a false value, it will log all levels to STDOUT (or, more
accurately, whichever file handle is selected via \f(CWselect()\fR, STDOUT
by default).
.IP \(bu 4
If set to a hash, then any \f(CW\*(C`log4p_level\*(C'\fR with a truthy value will
dynamically use STDERR, or STDOUT otherwise.
.IP \(bu 4
Otherwise, if a true value (the default setting is 1), messages will be
logged to STDERR.
.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
Design and implementation of this module has been greatly inspired by
Dave Rolsky\*(Aqs \f(CW\*(C`Log::Dispatch\*(C'\fR appender framework.
.PP
To enable printing wide utf8 characters, set the utf8 option to a true
value:
.PP
.Vb 4
\&    my $app = Log::Log4perl::Appender::Screen\->new(
\&      stderr    => 1,
\&      utf8      => 1,
\&    );
.Ve
.PP
This will issue the necessary binmode command to the selected output
channel (stderr/stdout).
.PP
To enable autoflush, set the
\&\f(CW\*(C`autoflush\*(C'\fR option to a true value:
.PP
.Vb 3
\&    my $app = Log::Log4perl::Appender::Screen\->new(
\&      autoflush => 1,
\&    );
.Ve
.PP
This will issue the necessary autoflush command to the selected output
channel (stderr/stdout).
.PP
This is required in containers, especially when the log volume is low, to
not buffer the log messages and cause a significant delay.
.SH LICENSE
.IX Header "LICENSE"
Copyright 2002\-2026 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.