.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.48)
.\"
.\" 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::Syslog 3"
.TH Log::Dispatch::Syslog 3 2026-10-26 "perl v5.44.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 SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Log::Dispatch;
\&
\&  my $log = Log::Dispatch\->new(
\&      outputs => [
\&          [
\&              \*(AqSyslog\*(Aq,
\&              min_level => \*(Aqinfo\*(Aq,
\&              ident     => \*(AqYadda yadda\*(Aq
\&          ]
\&      ]
\&  );
\&
\&  $log\->emerg("Time to die.");
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module provides a simple object for sending messages to the system log
(via UNIX syslog calls).
.PP
Note that logging may fail if you try to pass UTF\-8 characters in the log
message. If logging fails and warnings are enabled, the error message will be
output using Perl\*(Aqs \f(CW\*(C`warn\*(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
ident ($)
.Sp
This string will be prepended to all messages in the system log. Defaults to
\&\f(CW$0\fR.
.IP \(bu 4
logopt ($)
.Sp
A string containing the log options (separated by any separator you like). See
the \fBopenlog\fR\|(3) and Sys::Syslog docs for more details. Defaults to \*(Aq\*(Aq.
.IP \(bu 4
facility ($)
.Sp
Specifies what type of program is doing the logging to the system log. Valid
options are \*(Aqauth\*(Aq, \*(Aqauthpriv\*(Aq, \*(Aqcron\*(Aq, \*(Aqdaemon\*(Aq, \*(Aqkern\*(Aq, \*(Aqlocal0\*(Aq through
\&\*(Aqlocal7\*(Aq, \*(Aqmail, \*(Aqnews\*(Aq, \*(Aqsyslog\*(Aq, \*(Aquser\*(Aq, \*(Aquucp\*(Aq. Defaults to \*(Aquser\*(Aq
.IP \(bu 4
socket ($, \e@, or \e%)
.Sp
Tells what type of socket to use for sending syslog messages. Valid options are
listed in \f(CW\*(C`Sys::Syslog\*(C'\fR.
.Sp
If you don\*(Aqt provide this, then we let \f(CW\*(C`Sys::Syslog\*(C'\fR simply pick one that
works, which is the preferred option, as it makes your code more portable.
.Sp
If you pass an array reference, it is dereferenced and passed to
\&\f(CWSys::Syslog::setlogsock()\fR.
.Sp
If you pass a hash reference, it is passed to \f(CWSys::Syslog::setlogsock()\fR as
is.
.IP \(bu 4
lock ($)
.Sp
If this is set to a true value, then the calls to \f(CWsetlogsock()\fR,
\&\f(CWopenlog()\fR, \f(CWsyslog()\fR, and \f(CWcloselog()\fR will all be guarded by a
thread\-locked variable.
.Sp
This is only relevant when running you are using Perl threads in your
application. Setting this to a true value will cause the threads and
threads::shared modules to be loaded.
.Sp
This defaults to false.