.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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 >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 "Log::Dispatch::FileWriteRotate 3pm"
.TH Log::Dispatch::FileWriteRotate 3pm "2019-01-12" "perl v5.28.1" "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::Dispatch::FileWriteRotate \- Log to files that archive/rotate themselves, w/ File::Write::Rotate
.SH "VERSION"
.IX Header "VERSION"
This document describes version 0.060 of Log::Dispatch::FileWriteRotate (from Perl distribution Log-Dispatch-FileWriteRotate), released on 2019\-01\-09.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Log::Dispatch::FileWriteRotate;
\&
\& my $file = Log::Dispatch::FileWriteRotate(
\&     min_level => \*(Aqinfo\*(Aq,
\&
\&     # will be passed to File::Write::Rotate
\&     dir       => \*(Aq/var/log\*(Aq,
\&     prefix    => \*(Aqmyapp\*(Aq,
\&     suffix    => \*(Aq.log\*(Aq,
\&     period    => \*(Aqmonthly\*(Aq,
\&     size      => 25*1024*1024,
\&     histories => 12,
\& );
\&
\& $file\->log(level => \*(Aqinfo\*(Aq, message => "Your comment\en");
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module functions similarly to Log::Dispatch::FileRotate, but uses
File::Write::Rotate as backend, thus interoperates more easily with other
modules which use File::Write::Rotate as backend, e.g.
Tie::Handle::FileWriteRotate or Process::Govern.
.SH "METHODS"
.IX Header "METHODS"
.SS "new(%args)"
.IX Subsection "new(%args)"
Constructor. This method takes a hash of parameters. The following options are
valid: \f(CW\*(C`min_level\*(C'\fR and \f(CW\*(C`max_level\*(C'\fR (see Log::Dispatch documentation);
\&\f(CW\*(C`dir\*(C'\fR, \f(CW\*(C`prefix\*(C'\fR, \f(CW\*(C`suffix\*(C'\fR, \f(CW\*(C`period\*(C'\fR, \f(CW\*(C`size\*(C'\fR, and \f(CW\*(C`histories\*(C'\fR (see
File::Write::Rotate).
.SS "log_message(message => \s-1STR\s0)"
.IX Subsection "log_message(message => STR)"
Send a message to the appropriate output. Generally this shouldn't be called
directly but should be called through the \f(CW\*(C`log()\*(C'\fR method (in
LLog::Dispatch::Output>).
.SH "HOMEPAGE"
.IX Header "HOMEPAGE"
Please visit the project's homepage at <https://metacpan.org/release/Log\-Dispatch\-FileWriteRotate>.
.SH "SOURCE"
.IX Header "SOURCE"
Source repository is at <https://github.com/perlancar/perl\-Log\-Dispatch\-FileWriteRotate>.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests on the bugtracker website <https://rt.cpan.org/Public/Dist/Display.html?Name=Log\-Dispatch\-FileWriteRotate>
.PP
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Log::Dispatch
.PP
File::Write::Rotate
.PP
Log::Dispatch::FileRotate
.SH "AUTHOR"
.IX Header "AUTHOR"
perlancar <perlancar@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2019, 2015, 2013, 2012 by perlancar@cpan.org.
.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.