Debian Codegraph @

upstream/debian-unstable/man3/Sys::Syslog.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "Sys::Syslog 3perl"
58 .TH Sys::Syslog 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Sys::Syslog \- Perl interface to the UNIX syslog(3) calls
65 .SH VERSION
66 .IX Header "VERSION"
67 This is the documentation of version 0.36
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 2
71 \& use Sys::Syslog; # all except setlogsock()
72 \& use Sys::Syslog qw(:standard :macros); # standard functions & macros
73 \&
74 \& openlog($ident, $logopt, $facility); # don\*(Aqt forget this
75 \& syslog($priority, $format, @args);
76 \& $oldmask = setlogmask($mask_priority);
77 \& closelog();
78 .Ve
79 .SH DESCRIPTION
80 .IX Header "DESCRIPTION"
81 \&\f(CW\*(C`Sys::Syslog\*(C'\fR is an interface to the UNIX \f(CWsyslog(3)\fR program.
82 Call \f(CWsyslog()\fR with a string priority and a list of \f(CWprintf()\fR args
83 just like \f(CWsyslog(3)\fR.
84 .SH EXPORTS
85 .IX Header "EXPORTS"
86 \&\f(CW\*(C`Sys::Syslog\*(C'\fR exports the following \f(CW\*(C`Exporter\*(C'\fR tags:
87 .IP \(bu 4
88 \&\f(CW\*(C`:standard\*(C'\fR exports the standard \f(CWsyslog(3)\fR functions:
89 .Sp
90 .Vb 1
91 \& openlog closelog setlogmask syslog
92 .Ve
93 .IP \(bu 4
94 \&\f(CW\*(C`:extended\*(C'\fR exports the Perl specific functions for \f(CWsyslog(3)\fR:
95 .Sp
96 .Vb 1
97 \& setlogsock
98 .Ve
99 .IP \(bu 4
100 \&\f(CW\*(C`:macros\*(C'\fR exports the symbols corresponding to most of your \f(CWsyslog(3)\fR
101 macros and the \f(CWLOG_UPTO()\fR and \f(CWLOG_MASK()\fR functions.
102 See "CONSTANTS" for the supported constants and their meaning.
103 .PP
104 By default, \f(CW\*(C`Sys::Syslog\*(C'\fR exports the symbols from the \f(CW\*(C`:standard\*(C'\fR tag.
105 .SH FUNCTIONS
106 .IX Header "FUNCTIONS"
107 .ie n .IP "\fBopenlog($ident, \fR\fB$logopt\fR\fB, \fR\fB$facility\fR\fB)\fR" 4
108 .el .IP "\fBopenlog($ident, \fR\f(CB$logopt\fR\fB, \fR\f(CB$facility\fR\fB)\fR" 4
109 .IX Item "openlog($ident, $logopt, $facility)"
110 Opens the syslog.
111 \&\f(CW$ident\fR is prepended to every message. \f(CW$logopt\fR contains zero or
112 more of the options detailed below. \f(CW$facility\fR specifies the part
113 of the system to report about, for example \f(CW\*(C`LOG_USER\*(C'\fR or \f(CW\*(C`LOG_LOCAL0\*(C'\fR:
114 see "Facilities" for a list of well-known facilities, and your
115 \&\f(CWsyslog(3)\fR documentation for the facilities available in your system.
116 Check "SEE ALSO" for useful links. Facility can be given as a string
117 or a numeric macro.
118 .Sp
119 This function will croak if it can't connect to the syslog daemon.
120 .Sp
121 Note that \f(CWopenlog()\fR now takes three arguments, just like \f(CWopenlog(3)\fR.
122 .Sp
123 \&\fBYou should use \fR\f(CBopenlog()\fR\fB before calling \fR\f(CBsyslog()\fR\fB.\fR
124 .Sp
125 \&\fBOptions\fR
126 .RS 4
127 .IP \(bu 4
128 \&\f(CW\*(C`cons\*(C'\fR \- This option is ignored, since the failover mechanism will drop
129 down to the console automatically if all other media fail.
130 .IP \(bu 4
131 \&\f(CW\*(C`ndelay\*(C'\fR \- Open the connection immediately (normally, the connection is
132 opened when the first message is logged).
133 .IP \(bu 4
134 \&\f(CW\*(C`noeol\*(C'\fR \- When set to true, no end of line character (\f(CW\*(C`\en\*(C'\fR) will be
135 appended to the message. This can be useful for some syslog daemons.
136 Added in \f(CW\*(C`Sys::Syslog\*(C'\fR 0.29.
137 .IP \(bu 4
138 \&\f(CW\*(C`nofatal\*(C'\fR \- When set to true, \f(CWopenlog()\fR and \f(CWsyslog()\fR will only
139 emit warnings instead of dying if the connection to the syslog can't
140 be established. Added in \f(CW\*(C`Sys::Syslog\*(C'\fR 0.15.
141 .IP \(bu 4
142 \&\f(CW\*(C`nonul\*(C'\fR \- When set to true, no \f(CW\*(C`NUL\*(C'\fR character (\f(CW\*(C`\e0\*(C'\fR) will be
143 appended to the message. This can be useful for some syslog daemons.
144 Added in \f(CW\*(C`Sys::Syslog\*(C'\fR 0.29.
145 .IP \(bu 4
146 \&\f(CW\*(C`nowait\*(C'\fR \- Don't wait for child processes that may have been created
147 while logging the message. (The GNU C library does not create a child
148 process, so this option has no effect on Linux.)
149 .IP \(bu 4
150 \&\f(CW\*(C`perror\*(C'\fR \- Write the message to standard error output as well to the
151 system log. Added in \f(CW\*(C`Sys::Syslog\*(C'\fR 0.22.
152 .IP \(bu 4
153 \&\f(CW\*(C`pid\*(C'\fR \- Include PID with each message.
154 .RE
155 .RS 4
156 .Sp
157 \&\fBExamples\fR
158 .Sp
159 Open the syslog with options \f(CW\*(C`ndelay\*(C'\fR and \f(CW\*(C`pid\*(C'\fR, and with facility \f(CW\*(C`LOCAL0\*(C'\fR:
160 .Sp
161 .Vb 1
162 \& openlog($name, "ndelay,pid", "local0");
163 .Ve
164 .Sp
165 Same thing, but this time using the macro corresponding to \f(CW\*(C`LOCAL0\*(C'\fR:
166 .Sp
167 .Vb 1
168 \& openlog($name, "ndelay,pid", LOG_LOCAL0);
169 .Ve
170 .RE
171 .ie n .IP "\fBsyslog($priority, \fR\fB$message\fR\fB)\fR" 4
172 .el .IP "\fBsyslog($priority, \fR\f(CB$message\fR\fB)\fR" 4
173 .IX Item "syslog($priority, $message)"
174 .PD 0
175 .ie n .IP "\fBsyslog($priority, \fR\fB$format\fR\fB, \fR\fB@args\fR\fB)\fR" 4
176 .el .IP "\fBsyslog($priority, \fR\f(CB$format\fR\fB, \fR\f(CB@args\fR\fB)\fR" 4
177 .IX Item "syslog($priority, $format, @args)"
178 .PD
179 If \f(CW$priority\fR permits, logs \f(CW$message\fR or \f(CW\*(C`sprintf($format, @args)\*(C'\fR
180 with the addition that \f(CW%m\fR in \f(CW$message\fR or \f(CW$format\fR is replaced with
181 \&\f(CW"$!"\fR (the latest error message).
182 .Sp
183 \&\f(CW$priority\fR can specify a level, or a level and a facility. Levels and
184 facilities can be given as strings or as macros. When using the \f(CW\*(C`eventlog\*(C'\fR
185 mechanism, priorities \f(CW\*(C`DEBUG\*(C'\fR and \f(CW\*(C`INFO\*(C'\fR are mapped to event type
186 \&\f(CW\*(C`informational\*(C'\fR, \f(CW\*(C`NOTICE\*(C'\fR and \f(CW\*(C`WARNING\*(C'\fR to \f(CW\*(C`warning\*(C'\fR and \f(CW\*(C`ERR\*(C'\fR to
187 \&\f(CW\*(C`EMERG\*(C'\fR to \f(CW\*(C`error\*(C'\fR.
188 .Sp
189 If you didn't use \f(CWopenlog()\fR before using \f(CWsyslog()\fR, \f(CWsyslog()\fR will
190 try to guess the \f(CW$ident\fR by extracting the shortest prefix of
191 \&\f(CW$format\fR that ends in a \f(CW":"\fR.
192 .Sp
193 \&\fBExamples\fR
194 .Sp
195 .Vb 3
196 \& # informational level
197 \& syslog("info", $message);
198 \& syslog(LOG_INFO, $message);
199 \&
200 \& # information level, Local0 facility
201 \& syslog("info|local0", $message);
202 \& syslog(LOG_INFO|LOG_LOCAL0, $message);
203 .Ve
204 .RS 4
205 .IP \fBNote\fR 4
206 .IX Item "Note"
207 \&\f(CW\*(C`Sys::Syslog\*(C'\fR version v0.07 and older passed the \f(CW$message\fR as the
208 formatting string to \f(CWsprintf()\fR even when no formatting arguments
209 were provided. If the code calling \f(CWsyslog()\fR might execute with
210 older versions of this module, make sure to call the function as
211 \&\f(CW\*(C`syslog($priority, "%s", $message)\*(C'\fR instead of \f(CW\*(C`syslog($priority,
212 $message)\*(C'\fR. This protects against hostile formatting sequences that
213 might show up if \f(CW$message\fR contains tainted data.
214 .RE
215 .RS 4
216 .RE
217 .IP \fBsetlogmask($mask_priority)\fR 4
218 .IX Item "setlogmask($mask_priority)"
219 Sets the log mask for the current process to \f(CW$mask_priority\fR and
220 returns the old mask. If the mask argument is 0, the current log mask
221 is not modified. See "Levels" for the list of available levels.
222 You can use the \f(CWLOG_UPTO()\fR function to allow all levels up to a
223 given priority (but it only accept the numeric macros as arguments).
224 .Sp
225 \&\fBExamples\fR
226 .Sp
227 Only log errors:
228 .Sp
229 .Vb 1
230 \& setlogmask( LOG_MASK(LOG_ERR) );
231 .Ve
232 .Sp
233 Log everything except informational messages:
234 .Sp
235 .Vb 1
236 \& setlogmask( ~(LOG_MASK(LOG_INFO)) );
237 .Ve
238 .Sp
239 Log critical messages, errors and warnings:
240 .Sp
241 .Vb 3
242 \& setlogmask( LOG_MASK(LOG_CRIT)
243 \& | LOG_MASK(LOG_ERR)
244 \& | LOG_MASK(LOG_WARNING) );
245 .Ve
246 .Sp
247 Log all messages up to debug:
248 .Sp
249 .Vb 1
250 \& setlogmask( LOG_UPTO(LOG_DEBUG) );
251 .Ve
252 .IP \fBsetlogsock()\fR 4
253 .IX Item "setlogsock()"
254 Sets the socket type and options to be used for the next call to \f(CWopenlog()\fR
255 or \f(CWsyslog()\fR. Returns true on success, \f(CW\*(C`undef\*(C'\fR on failure.
256 .Sp
257 Being Perl-specific, this function has evolved along time. It can currently
258 be called as follow:
259 .RS 4
260 .IP \(bu 4
261 \&\f(CWsetlogsock($sock_type)\fR
262 .IP \(bu 4
263 \&\f(CW\*(C`setlogsock($sock_type, $stream_location)\*(C'\fR (added in Perl 5.004_02)
264 .IP \(bu 4
265 \&\f(CW\*(C`setlogsock($sock_type, $stream_location, $sock_timeout)\*(C'\fR (added in
266 \&\f(CW\*(C`Sys::Syslog\*(C'\fR 0.25)
267 .IP \(bu 4
268 \&\f(CWsetlogsock(\e%options)\fR (added in \f(CW\*(C`Sys::Syslog\*(C'\fR 0.28)
269 .RE
270 .RS 4
271 .Sp
272 The available options are:
273 .IP \(bu 4
274 \&\f(CW\*(C`type\*(C'\fR \- equivalent to \f(CW$sock_type\fR, selects the socket type (or
275 "mechanism"). An array reference can be passed to specify several
276 mechanisms to try, in the given order.
277 .IP \(bu 4
278 \&\f(CW\*(C`path\*(C'\fR \- equivalent to \f(CW$stream_location\fR, sets the stream location.
279 Defaults to standard Unix location, or \f(CW\*(C`_PATH_LOG\*(C'\fR.
280 .IP \(bu 4
281 \&\f(CW\*(C`timeout\*(C'\fR \- equivalent to \f(CW$sock_timeout\fR, sets the socket timeout
282 in seconds. Defaults to 0 on all systems except Mac\ OS\ X where it
283 is set to 0.25 sec.
284 .IP \(bu 4
285 \&\f(CW\*(C`host\*(C'\fR \- sets the hostname to send the messages to. Defaults to
286 the local host.
287 .IP \(bu 4
288 \&\f(CW\*(C`port\*(C'\fR \- sets the TCP or UDP port to connect to. Defaults to the
289 first standard syslog port available on the system.
290 .RE
291 .RS 4
292 .Sp
293 The available mechanisms are:
294 .IP \(bu 4
295 \&\f(CW"native"\fR \- use the native C functions from your \f(CWsyslog(3)\fR library
296 (added in \f(CW\*(C`Sys::Syslog\*(C'\fR 0.15).
297 .IP \(bu 4
298 \&\f(CW"eventlog"\fR \- send messages to the Win32 events logger (Win32 only;
299 added in \f(CW\*(C`Sys::Syslog\*(C'\fR 0.19).
300 .IP \(bu 4
301 \&\f(CW"tcp"\fR \- connect to a TCP socket, on the \f(CW\*(C`syslog/tcp\*(C'\fR or \f(CW\*(C`syslogng/tcp\*(C'\fR
302 service. See also the \f(CW\*(C`host\*(C'\fR, \f(CW\*(C`port\*(C'\fR and \f(CW\*(C`timeout\*(C'\fR options.
303 .IP \(bu 4
304 \&\f(CW"udp"\fR \- connect to a UDP socket, on the \f(CW\*(C`syslog/udp\*(C'\fR service.
305 See also the \f(CW\*(C`host\*(C'\fR, \f(CW\*(C`port\*(C'\fR and \f(CW\*(C`timeout\*(C'\fR options.
306 .IP \(bu 4
307 \&\f(CW"inet"\fR \- connect to an INET socket, either TCP or UDP, tried in that
308 order. See also the \f(CW\*(C`host\*(C'\fR, \f(CW\*(C`port\*(C'\fR and \f(CW\*(C`timeout\*(C'\fR options.
309 .IP \(bu 4
310 \&\f(CW"unix"\fR \- connect to a UNIX domain socket (in some systems a character
311 special device). The name of that socket is given by the \f(CW\*(C`path\*(C'\fR option
312 or, if omitted, the value returned by the \f(CW\*(C`_PATH_LOG\*(C'\fR macro (if your
313 system defines it), \fI/dev/log\fR or \fI/dev/conslog\fR, whichever is writable.
314 .IP \(bu 4
315 \&\f(CW"stream"\fR \- connect to the stream indicated by the \f(CW\*(C`path\*(C'\fR option, or,
316 if omitted, the value returned by the \f(CW\*(C`_PATH_LOG\*(C'\fR macro (if your system
317 defines it), \fI/dev/log\fR or \fI/dev/conslog\fR, whichever is writable. For
318 example Solaris and IRIX system may prefer \f(CW"stream"\fR instead of \f(CW"unix"\fR.
319 .IP \(bu 4
320 \&\f(CW"pipe"\fR \- connect to the named pipe indicated by the \f(CW\*(C`path\*(C'\fR option,
321 or, if omitted, to the value returned by the \f(CW\*(C`_PATH_LOG\*(C'\fR macro (if your
322 system defines it), or \fI/dev/log\fR (added in \f(CW\*(C`Sys::Syslog\*(C'\fR 0.21).
323 HP-UX is a system which uses such a named pipe.
324 .IP \(bu 4
325 \&\f(CW"console"\fR \- send messages directly to the console, as for the \f(CW"cons"\fR
326 option of \f(CWopenlog()\fR.
327 .RE
328 .RS 4
329 .Sp
330 The default is to try \f(CW\*(C`native\*(C'\fR, \f(CW\*(C`tcp\*(C'\fR, \f(CW\*(C`udp\*(C'\fR, \f(CW\*(C`unix\*(C'\fR, \f(CW\*(C`pipe\*(C'\fR, \f(CW\*(C`stream\*(C'\fR,
331 \&\f(CW\*(C`console\*(C'\fR.
332 Under systems with the Win32 API, \f(CW\*(C`eventlog\*(C'\fR will be added as the first
333 mechanism to try if \f(CW\*(C`Win32::EventLog\*(C'\fR is available.
334 .Sp
335 Giving an invalid value for \f(CW$sock_type\fR will \f(CW\*(C`croak\*(C'\fR.
336 .Sp
337 \&\fBExamples\fR
338 .Sp
339 Select the UDP socket mechanism:
340 .Sp
341 .Vb 1
342 \& setlogsock("udp");
343 .Ve
344 .Sp
345 Send messages using the TCP socket mechanism on a custom port:
346 .Sp
347 .Vb 1
348 \& setlogsock({ type => "tcp", port => 2486 });
349 .Ve
350 .Sp
351 Send messages to a remote host using the TCP socket mechanism:
352 .Sp
353 .Vb 1
354 \& setlogsock({ type => "tcp", host => $loghost });
355 .Ve
356 .Sp
357 Try the native, UDP socket then UNIX domain socket mechanisms:
358 .Sp
359 .Vb 1
360 \& setlogsock(["native", "udp", "unix"]);
361 .Ve
362 .IP \fBNote\fR 4
363 .IX Item "Note"
364 Now that the "native" mechanism is supported by \f(CW\*(C`Sys::Syslog\*(C'\fR and selected
365 by default, the use of the \f(CWsetlogsock()\fR function is discouraged because
366 other mechanisms are less portable across operating systems. Authors of
367 modules and programs that use this function, especially its cargo-cult form
368 \&\f(CWsetlogsock("unix")\fR, are advised to remove any occurrence of it unless they
369 specifically want to use a given mechanism (like TCP or UDP to connect to
370 a remote host).
371 .RE
372 .RS 4
373 .RE
374 .IP \fBcloselog()\fR 4
375 .IX Item "closelog()"
376 Closes the log file and returns true on success.
377 .SH "THE RULES OF SYS::SYSLOG"
378 .IX Header "THE RULES OF SYS::SYSLOG"
379 \&\fIThe First Rule of Sys::Syslog is:\fR
380 You do not call \f(CW\*(C`setlogsock\*(C'\fR.
381 .PP
382 \&\fIThe Second Rule of Sys::Syslog is:\fR
383 You \fBdo not\fR call \f(CW\*(C`setlogsock\*(C'\fR.
384 .PP
385 \&\fIThe Third Rule of Sys::Syslog is:\fR
386 The program crashes, \f(CW\*(C`die\*(C'\fRs, calls \f(CW\*(C`closelog\*(C'\fR, the log is over.
387 .PP
388 \&\fIThe Fourth Rule of Sys::Syslog is:\fR
389 One facility, one priority.
390 .PP
391 \&\fIThe Fifth Rule of Sys::Syslog is:\fR
392 One log at a time.
393 .PP
394 \&\fIThe Sixth Rule of Sys::Syslog is:\fR
395 No \f(CW\*(C`syslog\*(C'\fR before \f(CW\*(C`openlog\*(C'\fR.
396 .PP
397 \&\fIThe Seventh Rule of Sys::Syslog is:\fR
398 Logs will go on as long as they have to.
399 .PP
400 \&\fIThe Eighth, and Final Rule of Sys::Syslog is:\fR
401 If this is your first use of Sys::Syslog, you must read the doc.
402 .SH EXAMPLES
403 .IX Header "EXAMPLES"
404 An example:
405 .PP
406 .Vb 4
407 \& openlog($program, \*(Aqcons,pid\*(Aq, \*(Aquser\*(Aq);
408 \& syslog(\*(Aqinfo\*(Aq, \*(Aq%s\*(Aq, \*(Aqthis is another test\*(Aq);
409 \& syslog(\*(Aqmail|warning\*(Aq, \*(Aqthis is a better test: %d\*(Aq, time);
410 \& closelog();
411 \&
412 \& syslog(\*(Aqdebug\*(Aq, \*(Aqthis is the last test\*(Aq);
413 .Ve
414 .PP
415 Another example:
416 .PP
417 .Vb 2
418 \& openlog("$program $$", \*(Aqndelay\*(Aq, \*(Aquser\*(Aq);
419 \& syslog(\*(Aqnotice\*(Aq, \*(Aqfooprogram: this is really done\*(Aq);
420 .Ve
421 .PP
422 Example of use of \f(CW%m\fR:
423 .PP
424 .Vb 2
425 \& $! = 55;
426 \& syslog(\*(Aqinfo\*(Aq, \*(Aqproblem was %m\*(Aq); # %m == $! in syslog(3)
427 .Ve
428 .PP
429 Log to UDP port on \f(CW$remotehost\fR instead of logging locally:
430 .PP
431 .Vb 3
432 \& setlogsock("udp", $remotehost);
433 \& openlog($program, \*(Aqndelay\*(Aq, \*(Aquser\*(Aq);
434 \& syslog(\*(Aqinfo\*(Aq, \*(Aqsomething happened over here\*(Aq);
435 .Ve
436 .SH CONSTANTS
437 .IX Header "CONSTANTS"
438 .SS Facilities
439 .IX Subsection "Facilities"
440 .IP \(bu 4
441 \&\f(CW\*(C`LOG_AUDIT\*(C'\fR \- audit daemon (IRIX); falls back to \f(CW\*(C`LOG_AUTH\*(C'\fR
442 .IP \(bu 4
443 \&\f(CW\*(C`LOG_AUTH\*(C'\fR \- security/authorization messages
444 .IP \(bu 4
445 \&\f(CW\*(C`LOG_AUTHPRIV\*(C'\fR \- security/authorization messages (private)
446 .IP \(bu 4
447 \&\f(CW\*(C`LOG_CONSOLE\*(C'\fR \- \f(CW\*(C`/dev/console\*(C'\fR output (FreeBSD); falls back to \f(CW\*(C`LOG_USER\*(C'\fR
448 .IP \(bu 4
449 \&\f(CW\*(C`LOG_CRON\*(C'\fR \- clock daemons (\fBcron\fR and \fBat\fR)
450 .IP \(bu 4
451 \&\f(CW\*(C`LOG_DAEMON\*(C'\fR \- system daemons without separate facility value
452 .IP \(bu 4
453 \&\f(CW\*(C`LOG_FTP\*(C'\fR \- FTP daemon
454 .IP \(bu 4
455 \&\f(CW\*(C`LOG_KERN\*(C'\fR \- kernel messages
456 .IP \(bu 4
457 \&\f(CW\*(C`LOG_INSTALL\*(C'\fR \- installer subsystem (Mac OS X); falls back to \f(CW\*(C`LOG_USER\*(C'\fR
458 .IP \(bu 4
459 \&\f(CW\*(C`LOG_LAUNCHD\*(C'\fR \- launchd \- general bootstrap daemon (Mac OS X);
460 falls back to \f(CW\*(C`LOG_DAEMON\*(C'\fR
461 .IP \(bu 4
462 \&\f(CW\*(C`LOG_LFMT\*(C'\fR \- logalert facility; falls back to \f(CW\*(C`LOG_USER\*(C'\fR
463 .IP \(bu 4
464 \&\f(CW\*(C`LOG_LOCAL0\*(C'\fR through \f(CW\*(C`LOG_LOCAL7\*(C'\fR \- reserved for local use
465 .IP \(bu 4
466 \&\f(CW\*(C`LOG_LPR\*(C'\fR \- line printer subsystem
467 .IP \(bu 4
468 \&\f(CW\*(C`LOG_MAIL\*(C'\fR \- mail subsystem
469 .IP \(bu 4
470 \&\f(CW\*(C`LOG_NETINFO\*(C'\fR \- NetInfo subsystem (Mac OS X); falls back to \f(CW\*(C`LOG_DAEMON\*(C'\fR
471 .IP \(bu 4
472 \&\f(CW\*(C`LOG_NEWS\*(C'\fR \- USENET news subsystem
473 .IP \(bu 4
474 \&\f(CW\*(C`LOG_NTP\*(C'\fR \- NTP subsystem (FreeBSD, NetBSD); falls back to \f(CW\*(C`LOG_DAEMON\*(C'\fR
475 .IP \(bu 4
476 \&\f(CW\*(C`LOG_RAS\*(C'\fR \- Remote Access Service (VPN / PPP) (Mac OS X);
477 falls back to \f(CW\*(C`LOG_AUTH\*(C'\fR
478 .IP \(bu 4
479 \&\f(CW\*(C`LOG_REMOTEAUTH\*(C'\fR \- remote authentication/authorization (Mac OS X);
480 falls back to \f(CW\*(C`LOG_AUTH\*(C'\fR
481 .IP \(bu 4
482 \&\f(CW\*(C`LOG_SECURITY\*(C'\fR \- security subsystems (firewalling, etc.) (FreeBSD);
483 falls back to \f(CW\*(C`LOG_AUTH\*(C'\fR
484 .IP \(bu 4
485 \&\f(CW\*(C`LOG_SYSLOG\*(C'\fR \- messages generated internally by \fBsyslogd\fR
486 .IP \(bu 4
487 \&\f(CW\*(C`LOG_USER\*(C'\fR (default) \- generic user-level messages
488 .IP \(bu 4
489 \&\f(CW\*(C`LOG_UUCP\*(C'\fR \- UUCP subsystem
490 .SS Levels
491 .IX Subsection "Levels"
492 .IP \(bu 4
493 \&\f(CW\*(C`LOG_EMERG\*(C'\fR \- system is unusable
494 .IP \(bu 4
495 \&\f(CW\*(C`LOG_ALERT\*(C'\fR \- action must be taken immediately
496 .IP \(bu 4
497 \&\f(CW\*(C`LOG_CRIT\*(C'\fR \- critical conditions
498 .IP \(bu 4
499 \&\f(CW\*(C`LOG_ERR\*(C'\fR \- error conditions
500 .IP \(bu 4
501 \&\f(CW\*(C`LOG_WARNING\*(C'\fR \- warning conditions
502 .IP \(bu 4
503 \&\f(CW\*(C`LOG_NOTICE\*(C'\fR \- normal, but significant, condition
504 .IP \(bu 4
505 \&\f(CW\*(C`LOG_INFO\*(C'\fR \- informational message
506 .IP \(bu 4
507 \&\f(CW\*(C`LOG_DEBUG\*(C'\fR \- debug-level message
508 .SH DIAGNOSTICS
509 .IX Header "DIAGNOSTICS"
510 .ie n .IP """Invalid argument passed to setlogsock""" 4
511 .el .IP "\f(CWInvalid argument passed to setlogsock\fR" 4
512 .IX Item "Invalid argument passed to setlogsock"
513 \&\fB(F)\fR You gave \f(CWsetlogsock()\fR an invalid value for \f(CW$sock_type\fR.
514 .ie n .IP """eventlog passed to setlogsock, but no Win32 API available""" 4
515 .el .IP "\f(CWeventlog passed to setlogsock, but no Win32 API available\fR" 4
516 .IX Item "eventlog passed to setlogsock, but no Win32 API available"
517 \&\fB(W)\fR You asked \f(CWsetlogsock()\fR to use the Win32 event logger but the
518 operating system running the program isn't Win32 or does not provides Win32
519 compatible facilities.
520 .ie n .IP """no connection to syslog available""" 4
521 .el .IP "\f(CWno connection to syslog available\fR" 4
522 .IX Item "no connection to syslog available"
523 \&\fB(F)\fR \f(CWsyslog()\fR failed to connect to the specified socket.
524 .ie n .IP """stream passed to setlogsock, but %s is not writable""" 4
525 .el .IP "\f(CWstream passed to setlogsock, but %s is not writable\fR" 4
526 .IX Item "stream passed to setlogsock, but %s is not writable"
527 \&\fB(W)\fR You asked \f(CWsetlogsock()\fR to use a stream socket, but the given
528 path is not writable.
529 .ie n .IP """stream passed to setlogsock, but could not find any device""" 4
530 .el .IP "\f(CWstream passed to setlogsock, but could not find any device\fR" 4
531 .IX Item "stream passed to setlogsock, but could not find any device"
532 \&\fB(W)\fR You asked \f(CWsetlogsock()\fR to use a stream socket, but didn't
533 provide a path, and \f(CW\*(C`Sys::Syslog\*(C'\fR was unable to find an appropriate one.
534 .ie n .IP """tcp passed to setlogsock, but tcp service unavailable""" 4
535 .el .IP "\f(CWtcp passed to setlogsock, but tcp service unavailable\fR" 4
536 .IX Item "tcp passed to setlogsock, but tcp service unavailable"
537 \&\fB(W)\fR You asked \f(CWsetlogsock()\fR to use a TCP socket, but the service
538 is not available on the system.
539 .ie n .IP """syslog: expecting argument %s""" 4
540 .el .IP "\f(CWsyslog: expecting argument %s\fR" 4
541 .IX Item "syslog: expecting argument %s"
542 \&\fB(F)\fR You forgot to give \f(CWsyslog()\fR the indicated argument.
543 .ie n .IP """syslog: invalid level/facility: %s""" 4
544 .el .IP "\f(CWsyslog: invalid level/facility: %s\fR" 4
545 .IX Item "syslog: invalid level/facility: %s"
546 \&\fB(F)\fR You specified an invalid level or facility.
547 .ie n .IP """syslog: too many levels given: %s""" 4
548 .el .IP "\f(CWsyslog: too many levels given: %s\fR" 4
549 .IX Item "syslog: too many levels given: %s"
550 \&\fB(F)\fR You specified too many levels.
551 .ie n .IP """syslog: too many facilities given: %s""" 4
552 .el .IP "\f(CWsyslog: too many facilities given: %s\fR" 4
553 .IX Item "syslog: too many facilities given: %s"
554 \&\fB(F)\fR You specified too many facilities.
555 .ie n .IP """syslog: level must be given""" 4
556 .el .IP "\f(CWsyslog: level must be given\fR" 4
557 .IX Item "syslog: level must be given"
558 \&\fB(F)\fR You forgot to specify a level.
559 .ie n .IP """udp passed to setlogsock, but udp service unavailable""" 4
560 .el .IP "\f(CWudp passed to setlogsock, but udp service unavailable\fR" 4
561 .IX Item "udp passed to setlogsock, but udp service unavailable"
562 \&\fB(W)\fR You asked \f(CWsetlogsock()\fR to use a UDP socket, but the service
563 is not available on the system.
564 .ie n .IP """unix passed to setlogsock, but path not available""" 4
565 .el .IP "\f(CWunix passed to setlogsock, but path not available\fR" 4
566 .IX Item "unix passed to setlogsock, but path not available"
567 \&\fB(W)\fR You asked \f(CWsetlogsock()\fR to use a UNIX socket, but \f(CW\*(C`Sys::Syslog\*(C'\fR
568 was unable to find an appropriate an appropriate device.
569 .SH HISTORY
570 .IX Header "HISTORY"
571 \&\f(CW\*(C`Sys::Syslog\*(C'\fR is a core module, part of the standard Perl distribution
572 since 1990. At this time, modules as we know them didn't exist, the
573 Perl library was a collection of \fI.pl\fR files, and the one for sending
574 syslog messages with was simply \fIlib/syslog.pl\fR, included with Perl 3.0.
575 It was converted as a module with Perl 5.0, but had a version number
576 only starting with Perl 5.6. Here is a small table with the matching
577 Perl and \f(CW\*(C`Sys::Syslog\*(C'\fR versions.
578 .PP
579 .Vb 10
580 \& Sys::Syslog Perl
581 \& \-\-\-\-\-\-\-\-\-\-\- \-\-\-\-
582 \& undef 5.0.0 ~ 5.5.4
583 \& 0.01 5.6.*
584 \& 0.03 5.8.0
585 \& 0.04 5.8.1, 5.8.2, 5.8.3
586 \& 0.05 5.8.4, 5.8.5, 5.8.6
587 \& 0.06 5.8.7
588 \& 0.13 5.8.8
589 \& 0.22 5.10.0
590 \& 0.27 5.8.9, 5.10.1 ~ 5.14.*
591 \& 0.29 5.16.*
592 \& 0.32 5.18.*
593 \& 0.33 5.20.*
594 \& 0.33 5.22.*
595 .Ve
596 .SH "SEE ALSO"
597 .IX Header "SEE ALSO"
598 .SS "Other modules"
599 .IX Subsection "Other modules"
600 Log::Log4perl \- Perl implementation of the Log4j API
601 .PP
602 Log::Dispatch \- Dispatches messages to one or more outputs
603 .PP
604 Log::Report \- Report a problem, with exceptions and language support
605 .SS "Manual Pages"
606 .IX Subsection "Manual Pages"
607 \&\fBsyslog\fR\|(3)
608 .PP
609 SUSv3 issue 6, IEEE Std 1003.1, 2004 edition,
610 <http://www.opengroup.org/onlinepubs/000095399/basedefs/syslog.h.html>
611 .PP
612 GNU C Library documentation on syslog,
613 <http://www.gnu.org/software/libc/manual/html_node/Syslog.html>
614 .PP
615 FreeBSD documentation on syslog,
616 <https://www.freebsd.org/cgi/man.cgi?query=syslog>
617 .PP
618 Solaris 11 documentation on syslog,
619 <https://docs.oracle.com/cd/E53394_01/html/E54766/syslog\-3c.html>
620 .PP
621 Mac OS X documentation on syslog,
622 <http://developer.apple.com/documentation/Darwin/Reference/ManPages/man3/syslog.3.html>
623 .PP
624 IRIX documentation on syslog,
625 <http://nixdoc.net/man\-pages/IRIX/man3/syslog.3c.html>
626 .PP
627 AIX 5L 5.3 documentation on syslog,
628 <http://publib.boulder.ibm.com/infocenter/pseries/v5r3/index.jsp?topic=/com.ibm.aix.basetechref/doc/basetrf2/syslog.htm>
629 .PP
630 HP-UX 11i documentation on syslog,
631 <http://docs.hp.com/en/B2355\-60130/syslog.3C.html>
632 .PP
633 Tru64 documentation on syslog,
634 <http://nixdoc.net/man\-pages/Tru64/man3/syslog.3.html>
635 .PP
636 Stratus VOS 15.1,
637 <http://stratadoc.stratus.com/vos/15.1.1/r502\-01/wwhelp/wwhimpl/js/html/wwhelp.htm?context=r502\-01&file=ch5r502\-01bi.html>
638 .SS RFCs
639 .IX Subsection "RFCs"
640 \&\fIRFC 3164 \- The BSD syslog Protocol\fR, <http://www.faqs.org/rfcs/rfc3164.html>
641 \&\-\- Please note that this is an informational RFC, and therefore does not
642 specify a standard of any kind.
643 .PP
644 \&\fIRFC 3195 \- Reliable Delivery for syslog\fR, <http://www.faqs.org/rfcs/rfc3195.html>
645 .SS Articles
646 .IX Subsection "Articles"
647 \&\fISyslogging with Perl\fR, <http://lexington.pm.org/meetings/022001.html>
648 .SS "Event Log"
649 .IX Subsection "Event Log"
650 Windows Event Log,
651 <http://msdn.microsoft.com/library/default.asp?url=/library/en\-us/wes/wes/windows_event_log.asp>
652 .SH "AUTHORS & ACKNOWLEDGEMENTS"
653 .IX Header "AUTHORS & ACKNOWLEDGEMENTS"
654 Tom Christiansen <\fItchrist (at) perl.com\fR> and Larry Wall
655 <\fIlarry (at) wall.org\fR>.
656 .PP
657 UNIX domain sockets added by Sean Robinson
658 <\fIrobinson_s (at) sc.maricopa.edu\fR> with support from Tim Bunce
659 <\fITim.Bunce (at) ig.co.uk\fR> and the \f(CW\*(C`perl5\-porters\*(C'\fR mailing list.
660 .PP
661 Dependency on \fIsyslog.ph\fR replaced with XS code by Tom Hughes
662 <\fItom (at) compton.nu\fR>.
663 .PP
664 Code for \f(CWconstant()\fRs regenerated by Nicholas Clark <\fInick (at) ccl4.org\fR>.
665 .PP
666 Failover to different communication modes by Nick Williams
667 <\fINick.Williams (at) morganstanley.com\fR>.
668 .PP
669 Extracted from core distribution for publishing on the CPAN by
670 Sébastien Aperghis-Tramoni <sebastien (at) aperghis.net>.
671 .PP
672 XS code for using native C functions borrowed from \f(CW\*(C`Unix::Syslog\*(C'\fR,
673 written by Marcus Harnisch <\fImarcus.harnisch (at) gmx.net\fR>.
674 .PP
675 Yves Orton suggested and helped for making \f(CW\*(C`Sys::Syslog\*(C'\fR use the native
676 event logger under Win32 systems.
677 .PP
678 Jerry D. Hedden and Reini Urban provided greatly appreciated help to
679 debug and polish \f(CW\*(C`Sys::Syslog\*(C'\fR under Cygwin.
680 .SH BUGS
681 .IX Header "BUGS"
682 Please report any bugs or feature requests to
683 \&\f(CW\*(C`bug\-sys\-syslog (at) rt.cpan.org\*(C'\fR, or through the web interface at
684 <http://rt.cpan.org/Public/Dist/Display.html?Name=Sys\-Syslog>.
685 I will be notified, and then you'll automatically be notified of progress on
686 your bug as I make changes.
687 .SH SUPPORT
688 .IX Header "SUPPORT"
689 You can find documentation for this module with the perldoc command.
690 .PP
691 .Vb 1
692 \& perldoc Sys::Syslog
693 .Ve
694 .PP
695 You can also look for information at:
696 .IP \(bu 4
697 Perl Documentation
698 .Sp
699 <http://perldoc.perl.org/Sys/Syslog.html>
700 .IP \(bu 4
701 MetaCPAN
702 .Sp
703 <https://metacpan.org/module/Sys::Syslog>
704 .IP \(bu 4
705 Search CPAN
706 .Sp
707 <http://search.cpan.org/dist/Sys\-Syslog/>
708 .IP \(bu 4
709 AnnoCPAN: Annotated CPAN documentation
710 .Sp
711 <http://annocpan.org/dist/Sys\-Syslog>
712 .IP \(bu 4
713 CPAN Ratings
714 .Sp
715 <http://cpanratings.perl.org/d/Sys\-Syslog>
716 .IP \(bu 4
717 RT: CPAN's request tracker
718 .Sp
719 <http://rt.cpan.org/Dist/Display.html?Queue=Sys\-Syslog>
720 .PP
721 The source code is available on Git Hub:
722 <https://github.com/maddingue/Sys\-Syslog/>
723 .SH COPYRIGHT
724 .IX Header "COPYRIGHT"
725 Copyright (C) 1990\-2012 by Larry Wall and others.
726 .SH LICENSE
727 .IX Header "LICENSE"
728 This program is free software; you can redistribute it and/or modify it
729 under the same terms as Perl itself.