.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" 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" '' '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 turned on, 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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Agent::Channel::File 3pm" .TH Agent::Channel::File 3pm "2013-08-13" "perl v5.14.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::Agent::Channel::File \- file logging channel for Log::Agent .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& require Log::Agent::Channel::File; \& \& my $driver = Log::Agent::Channel::File\->make( \& \-prefix => "prefix", \& \-stampfmt => "own", \& \-showpid => 1, \& \-magic_open => 0, \& \-filename => "/tmp/output.err", \& \-fileperm => 0640, \& \-share => 1, \& ); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The file channel performs logging to a file, along with the necessary prefixing and stamping of the messages. .PP Internally, the \f(CW\*(C`Log::Agent::Driver::File\*(C'\fR driver creates such objects for each logging channel defined at driver creation time. .PP The creation routine \fImake()\fR takes the following arguments: .ie n .IP """\-filename"" => \fIfile\fR" 4 .el .IP "\f(CW\-filename\fR => \fIfile\fR" 4 .IX Item "-filename => file" The file name where output should go. The file is opened in append mode and autoflushing is turned on. See also the \f(CW\*(C`\-magic_open\*(C'\fR flag. .ie n .IP """\-fileperm"" => \fIperm\fR" 4 .el .IP "\f(CW\-fileperm\fR => \fIperm\fR" 4 .IX Item "-fileperm => perm" The permissions that the file should be opened with (\s-1XOR\s0'd with the user's umask). Due to the nature of the underlying \fIopen()\fR and \fIsysopen()\fR, the value is limited to less than or equal to 0666. See \*(L"umask\*(R" in \fIperlfunc\fR\|(3) for more details. .ie n .IP """\-magic_open"" => \fIflag\fR" 4 .el .IP "\f(CW\-magic_open\fR => \fIflag\fR" 4 .IX Item "-magic_open => flag" When true, channel filenames beginning with '>' or '|' are opened using Perl's \fIopen()\fR. Otherwise, \fIsysopen()\fR is used, in append mode. .Sp Default is \fIfalse\fR. .ie n .IP """\-no_newline"" => \fIflag\fR" 4 .el .IP "\f(CW\-no_newline\fR => \fIflag\fR" 4 .IX Item "-no_newline => flag" When set to \fItrue\fR, never append any \*(L"\en\*(R" (on Unix) or \*(L"\er\en\*(R" (on Windows) to log messages. .Sp Internally, Log::Agent relies on the channel to delimit logged lines appropriately, so this flag is not used. However, it might be useful for \f(CW\*(C`Log::Agent::Logger\*(C'\fR users. .Sp Default is \fIfalse\fR, meaning newline markers are systematically appended. .ie n .IP """\-no_prefixing"" => \fIflag\fR" 4 .el .IP "\f(CW\-no_prefixing\fR => \fIflag\fR" 4 .IX Item "-no_prefixing => flag" When set to \fItrue\fR, disable the prefixing logic entirely, i.e. the following options are ignored completely: \f(CW\*(C`\-prefix\*(C'\fR, \f(CW\*(C`\-showpid\*(C'\fR, \&\f(CW\*(C`\-no_ucfirst\*(C'\fR, \f(CW\*(C`\-stampfmt\*(C'\fR. .Sp Default is \fIfalse\fR. .ie n .IP """\-no_ucfirst"" => \fIflag\fR" 4 .el .IP "\f(CW\-no_ucfirst\fR => \fIflag\fR" 4 .IX Item "-no_ucfirst => flag" When set to \fItrue\fR, don't upper-case the first letter of the log message entry when there's no prefix inserted before the logged line. When there is a prefix, a \*(L":\*(R" character follows, and therefore the leading letter of the message should not be upper-cased anyway. .Sp Default is \fIfalse\fR, meaning uppercasing is performed. .ie n .IP """\-prefix"" => \fIprefix\fR" 4 .el .IP "\f(CW\-prefix\fR => \fIprefix\fR" 4 .IX Item "-prefix => prefix" The application prefix string to prepend to messages. .ie n .IP """\-rotate"" => \fIobject\fR" 4 .el .IP "\f(CW\-rotate\fR => \fIobject\fR" 4 .IX Item "-rotate => object" This sets a default logfile rotation policy. You need to install the additional \f(CW\*(C`Log::Agent::Rotate\*(C'\fR module to use this switch. .Sp \&\fIobject\fR is the \f(CW\*(C`Log::Agent::Rotate\*(C'\fR instance describing the rotating policy for the channel. Only files which are not opened via a so-called \fImagic open\fR can be rotated. .ie n .IP """\-share"" => \fIflag\fR" 4 .el .IP "\f(CW\-share\fR => \fIflag\fR" 4 .IX Item "-share => flag" When \fItrue\fR, this flag records the channel in a global pool indexed by filenames. An existing file handle for the same filename may be then be shared amongst several file channels. .Sp However, you will get this message in the file .Sp .Vb 1 \& Rotation for \*(Aqfilename\*(Aq may be wrong (shared with distinct policies) .Ve .Sp when a rotation policy different from the one used during the initial opening is given. Which policy will be used is unspecified, on purpose. .ie n .IP """\-showpid"" => \fIflag\fR" 4 .el .IP "\f(CW\-showpid\fR => \fIflag\fR" 4 .IX Item "-showpid => flag" If set to true, the \s-1PID\s0 of the process will be appended within square brackets after the prefix, to all messages. .Sp Default is \fIfalse\fR. .ie n .IP """\-stampfmt"" => (\fIname\fR | \fI\s-1CODE\s0\fR)" 4 .el .IP "\f(CW\-stampfmt\fR => (\fIname\fR | \fI\s-1CODE\s0\fR)" 4 .IX Item "-stampfmt => (name | CODE)" Specifies the time stamp format to use. By default, my \*(L"own\*(R" format is used. See Log::Agent::Stamping for a description of the available format names. .Sp You may also specify a \s-1CODE\s0 ref: that routine will be called every time we need to compute a time stamp. It should not expect any parameter, and should return a string. .SH "CAVEAT" .IX Header "CAVEAT" Beware of \fIchdir()\fR. If your program uses \fIchdir()\fR, you should always specify logfiles by using absolute paths, otherwise you run the risk of having your relative paths become invalid: there is no anchoring done at the time you specify them. This is especially true when configured for rotation, since the logfiles are recreated as needed and you might end up with many logfiles scattered throughout all the directories you \fIchdir()\fRed to. .SH "AUTHORS" .IX Header "AUTHORS" Originally written by Raphael Manfredi , currently maintained by Mark Rogaski . .SH "LICENSE" .IX Header "LICENSE" Copyright (C) 1999 Raphael Manfredi. Copyright (C) 2002 Mark Rogaski, mrogaski@cpan.org; all rights reserved. .PP See \fILog::Agent\fR\|(3) or the \s-1README\s0 file included with the distribution for license information. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fILog::Agent::Logger\fR\|(3), \fILog::Agent::Channel\fR\|(3).