Unix::Syslog 1.1

Unix::Syslog is a Perl module that provides an interface to the system logger syslogd(8) via Perl's XSUBs. The implementation attempts to resemble the native libc-functions of your system, so that anyone being familiar with syslog.h should be able to use this module right away.<br /><br />In contrary to Sys::Syslog(3), this modules does not open a network connection to send the messages. This can help you to avoid opening security holes in your computer (see "FAQ").<br /><br />The subs imported by the tag macros are simply wrappers around the most important #defines in your system's C header file syslog.h. The macros return integer values that are used to specify options, facilities and priorities in a more or less portable way. They also provide general information about your local syslog mechanism. Check syslog(3) and your local syslog.h for information about the macros, options and facilities available on your system.<br /><br />The following functions are provided:<br /><br />openlog $ident, $option, $facility<br /><br /> opens a connection to the system logger. $ident is an identifier string that syslogd(8) prints into every message. It usually equals the process name. $option is an integer value that is the result of ORed options. $facility is an integer value that specifies the part of the system the message should be associated with (e.g. kernel message, mail subsystem).<br /><br />syslog $priority, $format, @formatargs<br /><br /> Generates a log message and passes it to the system logger. If syslog() is called without calling openlog() first, probably system dependent default values will be used as arguments for an implicit call to openlog().<br /><br /> $priority is an integer value that specifies the priority of the message. Alternatively $priority can be the ORed value of a priority and a facility. In that case a previously selected facility will be overridden.<br /><br /> In the case that syslog() is called without calling openlog() first and priority does not specify both a priority and a facility, a default facility will be used. This behaviour is most likely system dependent and the user should not rely on any particular value in that case.<br /><br /> $format is a format string in the style of printf(3). Additionally to the usual printf directives %m can be specified in the string. It will be replaced implicitly by the contents of the Perl variable $! ($ERRNO). @formatargs is a list of values that the format directives will be replaced with subsequently.<br /><br />closelog<br /><br /> closes the connection to the system logger.<br /><br />setlogmask $mask_priority<br /><br /> sets the priority mask and returns the old mask. Logging is enabled for the priorities indicated by the bits in the mask that are set and is disabled where the bits are not set. Macros are provided to specify valid and portable arguments to setlogmask(). Usually the default log mask allows all messages to be logged.<br /><br />priorityname $priority<br /><br /> returns a string containing the name of $priority as string. If this functionality has not been enabled at installation, the function returns undef.<br /><br />facilityname $facility<br /><br /> returns a string containing the name of $facility as string. If this functionality has not been enabled at installation, the function returns undef.<br /><br />SYNOPSIS<br /><br /> use Unix::Syslog qw(:macros); # Syslog macros<br /> use Unix::Syslog qw(:subs); # Syslog functions<br /><br /> openlog $ident, $option, $facility;<br /> syslog $priority, $format, @formatargs;<br /> closelog;<br /> $oldmask = setlogmask $mask_priority;

Requirements:	No special requirements
Platforms:	*nix, Linux
Keyword:	Connection,  Default,  Enabled,  Facility,  Format,  Formatargs,  Integer,  Macros,  Message,  Openlog,  Option,  Options,  Priority,  Returns,  String,  Syslog,  System,  Unix,  Unix Syslog,  Unixsyslog
Users rating:	0/10