.\" -*- 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::Report::Dispatcher::File 3"
.TH Log::Report::Dispatcher::File 3 2025-12-12 "perl v5.42.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::Report::Dispatcher::File \- send messages to a file or file\-handle
.SH INHERITANCE
.IX Header "INHERITANCE"
.Vb 2
\& Log::Report::Dispatcher::File
\&   is a Log::Report::Dispatcher
.Ve
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&  dispatcher Log::Report::Dispatcher::File => \*(Aqstderr\*(Aq,
\&    to => \e*STDERR, accept => \*(AqNOTICE\-\*(Aq;
\&
\&  # close a dispatcher
\&  dispatcher close => \*(Aqstderr\*(Aq;
\&
\&  # let dispatcher open and close the file
\&  dispatcher FILE => \*(Aqmylog\*(Aq, to => \*(Aq/var/log/mylog\*(Aq, charset => \*(Aqutf\-8\*(Aq;
\&  ...
\&  dispatcher close => \*(Aqmylog\*(Aq;  # will close file
\&
\&  # open yourself, then also close yourself
\&  open OUT, ">:encoding(\*(Aqiso\-8859\-1\*(Aq)", \*(Aq/var/log/mylog\*(Aq
\&      or fault "...";
\&  dispatcher FILE => \*(Aqmylog\*(Aq, to => \e*OUT;
\&  ...
\&  dispatcher close => \*(Aqmylog\*(Aq;
\&  close OUT;
\&
\&  # dispatch into a scalar
\&  my $output = \*(Aq\*(Aq;
\&  open $outfile, \*(Aq>\*(Aq, \e$output;
\&  dispatcher FILE => \*(Aqinto\-scalar\*(Aq, to => \e$outfile;
\&  ...
\&  dispatcher close => \*(Aqinto\-scalar\*(Aq;
\&  print $output;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This basic file logger accepts an file\-handle or filename as destination.
.PP
[1.00] writing to the file protected by a lock, so multiple processes
can write to the same file.
.PP
Extends "DESCRIPTION" in Log::Report::Dispatcher.
.SH METHODS
.IX Header "METHODS"
Extends "METHODS" in Log::Report::Dispatcher.
.SS Constructors
.IX Subsection "Constructors"
Extends "Constructors" in Log::Report::Dispatcher.
.ie n .IP "$class\->\fBnew\fR($type, $name, %options)" 4
.el .IP "\f(CW$class\fR\->\fBnew\fR($type, \f(CW$name\fR, \f(CW%options\fR)" 4
.IX Item "$class->new($type, $name, %options)"
Inherited, see "Constructors" in Log::Report::Dispatcher
.Sp
.Vb 9
\& \-Option       \-\-Defined in             \-\-Default
\&  accept         Log::Report::Dispatcher  depend on mode
\&  charset        Log::Report::Dispatcher  LC_CTYPE
\&  format                                  <adds timestamp>
\&  format_reason  Log::Report::Dispatcher  \*(AqLOWERCASE\*(Aq
\&  locale         Log::Report::Dispatcher  <system locale>
\&  mode           Log::Report::Dispatcher  \*(AqNORMAL\*(Aq
\&  replace                                 false
\&  to                                      <required>
.Ve
.RS 4
.ie n .IP "accept => $reasons|\e@reasons" 2
.el .IP "accept => \f(CW$reasons\fR|\e@reasons" 2
.IX Item "accept => $reasons|@reasons"
.PD 0
.IP "charset => CHARSET" 2
.IX Item "charset => CHARSET"
.IP "format => CODE|\*(AqLONG\*(Aq" 2
.IX Item "format => CODE|'LONG'"
.PD
[1.00] process each printed line.  By default, this adds a timestamp,
but you may want to add hostname, process number, or more.
.Sp
.Vb 3
\&  format => sub { \*(Aq[\*(Aq.localtime().\*(Aq] \*(Aq.$_[0] }
\&  format => sub { shift }   # no timestamp
\&  format => \*(AqLONG\*(Aq
.Ve
.Sp
The first parameter to format is the string to print; it is already
translated and trailed by a newline.  The second parameter is the
text\-domain (if known).
.Sp
[1.10] As third parameter, you get the message raw object as well (maybe
you want to use the message context?)
.Sp
[1.19] After the three positional parameters, there may be a list
of pairs providing additional facts about the exception.  It may
contain \f(CW\*(C`location\*(C'\fR information.
.Sp
The "LONG" format is equivalent to:
.Sp
.Vb 2
\&  my $t = strftime "%FT%T", gmtime;
\&  "[$t $$] $_[1] $_[0]"
.Ve
.Sp
Use of context:
.Sp
.Vb 4
\&  format => sub { my ($msgstr, $domain, $msg, %more) = @_;
\&     my $host = $msg\->context\->{host};
\&     "$host $msgstr";
\&  }
.Ve
.IP "format_reason => \*(AqUPPERCASE\*(Aq|\*(AqLOWERCASE\*(Aq|\*(AqUCFIRST\*(Aq|\*(AqIGNORE\*(Aq|CODE" 2
.IX Item "format_reason => 'UPPERCASE'|'LOWERCASE'|'UCFIRST'|'IGNORE'|CODE"
.PD 0
.IP "locale => LOCALE" 2
.IX Item "locale => LOCALE"
.IP "mode => \*(AqNORMAL\*(Aq|\*(AqVERBOSE\*(Aq|\*(AqASSERT\*(Aq|\*(AqDEBUG\*(Aq|0..3" 2
.IX Item "mode => 'NORMAL'|'VERBOSE'|'ASSERT'|'DEBUG'|0..3"
.IP "replace => BOOLEAN" 2
.IX Item "replace => BOOLEAN"
.PD
Only used in combination with a \f(CW\*(C`to\*(C'\fR filename: throw away the old file
if it exists.  Probably you wish to append to existing information.
.Sp
Use the locale setting by default, which is LC_CTYPE or LC_ALL or LANG
(in that order).  If these contain a character\-set which Perl understands,
then that is used, otherwise silently ignored.
.ie n .IP "to => $file|$fh|OBJECT|CODE" 2
.el .IP "to => \f(CW$file\fR|$fh|OBJECT|CODE" 2
.IX Item "to => $file|$fh|OBJECT|CODE"
You can either specify a \f(CW$file\fR by name, which is opened in append mode with
autoflush on. Or pass any kind of file handle \f(CW$fh\fR, or some OBJECT which
implements a \f(CWprint()\fR method. You probably want to have autoflush
enabled on your file\-handles.
.Sp
When cleaning\-up the dispatcher, the file will only be closed in case
of a named \f(CW$file\fR.
.Sp
[1.10] When you pass a CODE, then for each log message the function is
called with two arguments: this dispatcher object and the message object.
In some way (maybe via the message context) you have to determine the
log filename.  This means that probably many log\-files are open at the
same time.
.Sp
.Vb 3
\&  # configuration time
\&  dispatcher FILE => \*(Aqlogfile\*(Aq, to =>
\&     sub { my ($disp, $msg) = @_; $msg\->context\->{logfile} };
\&
\&  # whenever you want to change the logfile
\&  textdomain\->updateContext(logfile => \*(Aq/var/log/app\*(Aq);
\&  (textdomain \*(Aqmydomain\*(Aq)\->setContext(logfile => \*(Aq/var/log/app\*(Aq);
\&
\&  # or
\&  error _\|_x"help", _context => {logfile => \*(Aq/dev/tty\*(Aq};
\&  error _\|_x"help", _context => "logfile=/dev/tty";
.Ve
.RE
.RS 4
.RE
.SS Accessors
.IX Subsection "Accessors"
Extends "Accessors" in Log::Report::Dispatcher.
.ie n .IP $obj\->\fBfilename\fR() 4
.el .IP \f(CW$obj\fR\->\fBfilename\fR() 4
.IX Item "$obj->filename()"
Returns the name of the opened file, or \f(CW\*(C`undef\*(C'\fR in case this dispatcher
was started from a file\-handle or file\-object.
.ie n .IP $obj\->\fBformat\fR() 4
.el .IP \f(CW$obj\fR\->\fBformat\fR() 4
.IX Item "$obj->format()"

.ie n .IP $obj\->\fBisDisabled\fR() 4
.el .IP \f(CW$obj\fR\->\fBisDisabled\fR() 4
.IX Item "$obj->isDisabled()"
Inherited, see "Accessors" in Log::Report::Dispatcher
.ie n .IP $obj\->\fBmode\fR() 4
.el .IP \f(CW$obj\fR\->\fBmode\fR() 4
.IX Item "$obj->mode()"
Inherited, see "Accessors" in Log::Report::Dispatcher
.ie n .IP $obj\->\fBname\fR() 4
.el .IP \f(CW$obj\fR\->\fBname\fR() 4
.IX Item "$obj->name()"
Inherited, see "Accessors" in Log::Report::Dispatcher
.ie n .IP "$obj\->\fBneeds\fR( [$reason] )" 4
.el .IP "\f(CW$obj\fR\->\fBneeds\fR( [$reason] )" 4
.IX Item "$obj->needs( [$reason] )"
Inherited, see "Accessors" in Log::Report::Dispatcher
.ie n .IP $obj\->\fBoutput\fR($msg) 4
.el .IP \f(CW$obj\fR\->\fBoutput\fR($msg) 4
.IX Item "$obj->output($msg)"
Returns the file\-handle to write the log lines to. [1.10] This may
depend on the \f(CW$msg\fR (especially message context)
.ie n .IP $obj\->\fBtype\fR() 4
.el .IP \f(CW$obj\fR\->\fBtype\fR() 4
.IX Item "$obj->type()"
Inherited, see "Accessors" in Log::Report::Dispatcher
.SS "File maintenance"
.IX Subsection "File maintenance"
.ie n .IP $obj\->\fBrotate\fR($filename|CODE) 4
.el .IP \f(CW$obj\fR\->\fBrotate\fR($filename|CODE) 4
.IX Item "$obj->rotate($filename|CODE)"
[1.00] Move the current file to \f(CW$filename\fR, and start a new file.
.SS Logging
.IX Subsection "Logging"
Extends "Logging" in Log::Report::Dispatcher.
.ie n .IP $any\->\fBaddSkipStack\fR(@CODE) 4
.el .IP \f(CW$any\fR\->\fBaddSkipStack\fR(@CODE) 4
.IX Item "$any->addSkipStack(@CODE)"
Inherited, see "Logging" in Log::Report::Dispatcher
.ie n .IP $obj\->\fBclose\fR() 4
.el .IP \f(CW$obj\fR\->\fBclose\fR() 4
.IX Item "$obj->close()"
Only when initiated with a FILENAME, the file will be closed.  In any
other case, nothing will be done.
Improves base, see "Logging" in Log::Report::Dispatcher
.ie n .IP $any\->\fBcollectLocation\fR() 4
.el .IP \f(CW$any\fR\->\fBcollectLocation\fR() 4
.IX Item "$any->collectLocation()"
Inherited, see "Logging" in Log::Report::Dispatcher
.ie n .IP "$any\->\fBcollectStack\fR( [$maxdepth] )" 4
.el .IP "\f(CW$any\fR\->\fBcollectStack\fR( [$maxdepth] )" 4
.IX Item "$any->collectStack( [$maxdepth] )"
Inherited, see "Logging" in Log::Report::Dispatcher
.ie n .IP "$obj\->\fBlog\fR(\e%options, $reason, $message, $domain)" 4
.el .IP "\f(CW$obj\fR\->\fBlog\fR(\e%options, \f(CW$reason\fR, \f(CW$message\fR, \f(CW$domain\fR)" 4
.IX Item "$obj->log(%options, $reason, $message, $domain)"
Inherited, see "Logging" in Log::Report::Dispatcher
.ie n .IP $obj\->\fBskipStack\fR() 4
.el .IP \f(CW$obj\fR\->\fBskipStack\fR() 4
.IX Item "$obj->skipStack()"
Inherited, see "Logging" in Log::Report::Dispatcher
.ie n .IP $any\->\fBstackTraceLine\fR(%options) 4
.el .IP \f(CW$any\fR\->\fBstackTraceLine\fR(%options) 4
.IX Item "$any->stackTraceLine(%options)"
Inherited, see "Logging" in Log::Report::Dispatcher
.ie n .IP "$obj\->\fBtranslate\fR(\e%options, $reason, $message)" 4
.el .IP "\f(CW$obj\fR\->\fBtranslate\fR(\e%options, \f(CW$reason\fR, \f(CW$message\fR)" 4
.IX Item "$obj->translate(%options, $reason, $message)"
Inherited, see "Logging" in Log::Report::Dispatcher
.SH DETAILS
.IX Header "DETAILS"
Extends "DETAILS" in Log::Report::Dispatcher.
.SH DIAGNOSTICS
.IX Header "DIAGNOSTICS"
.IP "Error: cannot rotate log file which was opened as file\-handle" 4
.IX Item "Error: cannot rotate log file which was opened as file-handle"
Cast by \f(CWrotate()\fR
.ie n .IP "Fault: cannot write log into $file: $!" 4
.el .IP "Fault: cannot write log into \f(CW$file:\fR $!" 4
.IX Item "Fault: cannot write log into $file: $!"
Cast by \f(CWrotate()\fR
.ie n .IP "Error: dispatcher $name needs parameter \*(Aqto\*(Aq" 4
.el .IP "Error: dispatcher \f(CW$name\fR needs parameter \*(Aqto\*(Aq" 4
.IX Item "Error: dispatcher $name needs parameter 'to'"
Cast by \f(CWnew()\fR
.ie n .IP "Fault: unable to rotate logfile $fn to $oldfn: $!" 4
.el .IP "Fault: unable to rotate logfile \f(CW$fn\fR to \f(CW$oldfn:\fR $!" 4
.IX Item "Fault: unable to rotate logfile $fn to $oldfn: $!"
Cast by \f(CWrotate()\fR
.IP "Error: unknown format parameter \`$what\*(Aq" 4
.IX Item "Error: unknown format parameter `$what'"
Cast by \f(CWnew()\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of Log\-Report version 1.43,
built on December 05, 2025. Website: \fIhttp://perl.overmeer.net/CPAN/\fR
.SH LICENSE
.IX Header "LICENSE"
For contributors see file ChangeLog.
.PP
This software is copyright (c) 2007\-2025 by Mark Overmeer.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.