.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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 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.
.\"
.\" 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 "Agent::Channel::Syslog 3pm"
.TH Agent::Channel::Syslog 3pm "2016-09-17" "perl v5.22.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::Syslog \- syslog logging channel for Log::Agent::Logger
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& require Log::Agent::Channel::Syslog;
\&
\& my $channel = Log::Agent::Channel::Syslog\->make(
\&     # Specific attributes
\&     \-prefix     => prefix,
\&     \-facility   => "user",
\&     \-showpid    => 1,
\&     \-socktype   => "unix",
\&     \-logopt     => "ndelay",
\& );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The syslog logging channels directs operations to \fIsyslog()\fR via the
\&\fISys::Syslog\fR\|(3) interface.
.PP
The creation routine \fImake()\fR takes the following switches:
.ie n .IP """\-facility"" => \fIfacility\fR" 4
.el .IP "\f(CW\-facility\fR => \fIfacility\fR" 4
.IX Item "-facility => facility"
Tell \fIsyslog()\fR which facility to use (e.g. \*(L"user\*(R", \*(L"auth\*(R", \*(L"daemon\*(R").
Unlike the \fISys::Syslog\fR\|(3) interface, the facility is set once and for all:
every message logged through this channel will use the same facility.
.ie n .IP """\-logopt"" => \fIsyslog options\fR" 4
.el .IP "\f(CW\-logopt\fR => \fIsyslog options\fR" 4
.IX Item "-logopt => syslog options"
Specifies logging options, under the form of a string containing zero or
more of the words \fIndelay\fR, \fIcons\fR or \fInowait\fR.
.ie n .IP """\-prefix"" => \fIprefix\fR" 4
.el .IP "\f(CW\-prefix\fR => \fIprefix\fR" 4
.IX Item "-prefix => prefix"
The \fIprefix\fR here is syslog's identification string.
.ie n .IP """\-showpid"" => \fIflag\fR" 4
.el .IP "\f(CW\-showpid\fR => \fIflag\fR" 4
.IX Item "-showpid => flag"
Set to true to have the \s-1PID\s0 of the process logged. It is false by default.
.ie n .IP """\-socktype"" => (\fIunix\fR | \fIinet\fR)" 4
.el .IP "\f(CW\-socktype\fR => (\fIunix\fR | \fIinet\fR)" 4
.IX Item "-socktype => (unix | inet)"
Specifies the logging socket type to use. The default behaviour is to
use Sys:Syslog's default.
.SH "AUTHOR"
.IX Header "AUTHOR"
Raphael Manfredi \fI<Raphael_Manfredi@pobox.com>\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fILog::Agent::Logger\fR\|(3).