summaryrefslogtreecommitdiff
path: root/ext/Sys
diff options
context:
space:
mode:
authorRafael Garcia-Suarez <rgarciasuarez@gmail.com>2005-08-31 15:14:28 +0000
committerRafael Garcia-Suarez <rgarciasuarez@gmail.com>2005-08-31 15:14:28 +0000
commitb91ed0194cb2707fc4bb2619e1294e4287626407 (patch)
tree7e1d0ea3f53b265c86b353a09bd475020dcaf392 /ext/Sys
parentea1d064a0a997a28f8265a165120fea0d04e9a22 (diff)
downloadperl-b91ed0194cb2707fc4bb2619e1294e4287626407.tar.gz
Document that Sys::Syslog::openlog might die.
Fixes [perl #36848] Sys::Syslog::syslog kills program if syslogd not running p4raw-id: //depot/perl@25342
Diffstat (limited to 'ext/Sys')
-rw-r--r--ext/Sys/Syslog/Syslog.pm4
1 files changed, 3 insertions, 1 deletions
diff --git a/ext/Sys/Syslog/Syslog.pm b/ext/Sys/Syslog/Syslog.pm
index 7581bcbd8a..c56d37cb70 100644
--- a/ext/Sys/Syslog/Syslog.pm
+++ b/ext/Sys/Syslog/Syslog.pm
@@ -53,13 +53,15 @@ Syslog provides the functions:
=item openlog $ident, $logopt, $facility
+Opens the syslog.
I<$ident> is prepended to every message. I<$logopt> contains zero or
more of the words I<pid>, I<ndelay>, I<nowait>. The cons option is
ignored, since the failover mechanism will drop down to the console
automatically if all other media fail. I<$facility> specifies the
part of the system to report about, for example LOG_USER or LOG_LOCAL0:
see your C<syslog(3)> documentation for the facilities available in
-your system.
+your system. This function will croak if it can't connect to the syslog
+daemon.
B<You should use openlog() before calling syslog().>