.\" -*- 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 "Log::Dispatch::Screen 3"
.TH Log::Dispatch::Screen 3 2026-04-13 "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 SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Log::Dispatch;
\&
\&  my $log = Log::Dispatch\->new(
\&      outputs => [
\&          [
\&              \*(AqScreen\*(Aq,
\&              min_level => \*(Aqdebug\*(Aq,
\&              stderr    => 1,
\&              newline   => 1
\&          ]
\&      ],
\&  );
\&
\&  $log\->alert("I\*(Aqm searching the city for sci\-fi wasabi");
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module provides an object for logging to the screen (really \f(CW\*(C`STDOUT\*(C'\fR or
\&\f(CW\*(C`STDERR\*(C'\fR).
.PP
Note that a newline will \fInot\fR be added automatically at the end of a message
by default. To do that, pass \f(CW\*(C`newline => 1\*(C'\fR.
.SH CONSTRUCTOR
.IX Header "CONSTRUCTOR"
The constructor takes the following parameters in addition to the standard
parameters documented in Log::Dispatch::Output:
.IP \(bu 4
stderr (0 or 1)
.Sp
Indicates whether or not logging information should go to \f(CW\*(C`STDERR\*(C'\fR. If false,
logging information is printed to \f(CW\*(C`STDOUT\*(C'\fR instead.
.Sp
This defaults to true.
.IP \(bu 4
utf8 (0 or 1)
.Sp
If this is true, then the output will be encoded using the UTF\-8 encoding. If
you have \fIalready\fR applied an encoding layer to the relevant filehandle,
\&\f(CW\*(C`STDOUT\*(C'\fR or \f(CW\*(C`STDERR\*(C'\fR, then your output will end up double\-encoded if this is
true.
.Sp
This defaults to false.