home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _dedab3f14c88420397f17cc71bb6cbd6 < prev    next >
Text File  |  2000-03-23  |  5KB  |  130 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>syslog - Perl interface to the UNIX syslog calls</TITLE>
  5. <LINK REL="stylesheet" HREF="../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> syslog - Perl interface to the UNIX syslog calls</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#examples">EXAMPLES</A></LI>
  26.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  27.     <LI><A HREF="#author">AUTHOR</A></LI>
  28. </UL>
  29. <!-- INDEX END -->
  30.  
  31. <HR>
  32. <P>
  33. <H1><A NAME="name">NAME</A></H1>
  34. <P>Sys::Syslog, openlog, closelog, setlogmask, syslog - Perl interface to the UNIX <CODE>syslog(3)</CODE> calls</P>
  35. <P>
  36. <HR>
  37. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  38. <UL>
  39. <LI>Linux</LI>
  40. <LI>Solaris</LI>
  41. </UL>
  42. <HR>
  43. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  44. <PRE>
  45.     use Sys::Syslog;                          # all except setlogsock, or:
  46.     use Sys::Syslog qw(:DEFAULT setlogsock);  # default set, plus setlogsock</PRE>
  47. <PRE>
  48.     setlogsock $sock_type;
  49.     openlog $ident, $logopt, $facility;
  50.     syslog $priority, $format, @args;
  51.     $oldmask = setlogmask $mask_priority;
  52.     closelog;</PRE>
  53. <P>
  54. <HR>
  55. <H1><A NAME="description">DESCRIPTION</A></H1>
  56. <P>Sys::Syslog is an interface to the UNIX <CODE>syslog(3)</CODE> program.
  57. Call <CODE>syslog()</CODE> with a string priority and a list of <A HREF="../../lib/Pod/perlfunc.html#item_printf"><CODE>printf()</CODE></A> args
  58. just like <CODE>syslog(3)</CODE>.</P>
  59. <P>Syslog provides the functions:</P>
  60. <DL>
  61. <DT><STRONG><A NAME="item_openlog_%24ident%2C_%24logopt%2C_%24facility">openlog $ident, $logopt, $facility</A></STRONG><BR>
  62. <DD>
  63. <EM>$ident</EM> is prepended to every message.
  64. <EM>$logopt</EM> contains zero or more of the words <EM>pid</EM>, <EM>ndelay</EM>, <EM>cons</EM>, <EM>nowait</EM>.
  65. <EM>$facility</EM> specifies the part of the system
  66. <P></P>
  67. <DT><STRONG><A NAME="item_syslog_%24priority%2C_%24format%2C_%40args">syslog $priority, $format, @args</A></STRONG><BR>
  68. <DD>
  69. If <EM>$priority</EM> permits, logs <EM>($format, @args)</EM>
  70. printed as by <A HREF="../../lib/Pod/perlfunc.html#item_printf"><CODE>printf(3V)</CODE></A>, with the addition that <EM>%m</EM>
  71. is replaced with <CODE>"$!"</CODE> (the latest error message).
  72. <P></P>
  73. <DT><STRONG><A NAME="item_setlogmask_%24mask_priority">setlogmask $mask_priority</A></STRONG><BR>
  74. <DD>
  75. Sets log mask <EM>$mask_priority</EM> and returns the old mask.
  76. <P></P>
  77. <DT><STRONG><A NAME="item_sock_type">setlogsock $sock_type (added in 5.004_02)</A></STRONG><BR>
  78. <DD>
  79. Sets the socket type to be used for the next call to
  80. <CODE>openlog()</CODE> or <CODE>syslog()</CODE> and returns TRUE on success,
  81. undef on failure.
  82. <P>A value of 'unix' will connect to the UNIX domain socket returned by
  83. <CODE>_PATH_LOG</CODE> in <EM>syslog.ph</EM>.  A value of 'inet' will connect to an
  84. INET socket returned by getservbyname().  Any other value croaks.</P>
  85. <P>The default is for the INET socket to be used.</P>
  86. <P></P>
  87. <DT><STRONG><A NAME="item_closelog">closelog</A></STRONG><BR>
  88. <DD>
  89. Closes the log file.
  90. <P></P></DL>
  91. <P>Note that <CODE>openlog</CODE> now takes three arguments, just like <CODE>openlog(3)</CODE>.</P>
  92. <P>
  93. <HR>
  94. <H1><A NAME="examples">EXAMPLES</A></H1>
  95. <PRE>
  96.     openlog($program, 'cons,pid', 'user');
  97.     syslog('info', 'this is another test');
  98.     syslog('mail|warning', 'this is a better test: %d', time);
  99.     closelog();</PRE>
  100. <PRE>
  101.     syslog('debug', 'this is the last test');</PRE>
  102. <PRE>
  103.     setlogsock('unix');
  104.     openlog("$program $$", 'ndelay', 'user');
  105.     syslog('notice', 'fooprogram: this is really done');</PRE>
  106. <PRE>
  107.     setlogsock('inet');
  108.     $! = 55;
  109.     syslog('info', 'problem was %m'); # %m == $! in syslog(3)</PRE>
  110. <P>
  111. <HR>
  112. <H1><A NAME="see also">SEE ALSO</A></H1>
  113. <P><EM>syslog(3)</EM></P>
  114. <P>
  115. <HR>
  116. <H1><A NAME="author">AUTHOR</A></H1>
  117. <P>Tom Christiansen <<EM><A HREF="mailto:tchrist@perl.com">tchrist@perl.com</A></EM>> and Larry Wall <<EM><A HREF="mailto:larry@wall.org">larry@wall.org</A></EM>>.
  118. UNIX domain sockets added by Sean Robinson <<EM><A HREF="mailto:robinson_s@sc.maricopa.edu">robinson_s@sc.maricopa.edu</A></EM>>
  119. with support from Tim Bunce <<A HREF="mailto:Tim.Bunce@ig.co.uk">Tim.Bunce@ig.co.uk</A>> and the perl5-porters mailing list.
  120. Dependency on <EM>syslog.ph</EM> replaced with XS code bu Tom Hughes <<EM><A HREF="mailto:tom@compton.nu">tom@compton.nu</A></EM>>.</P>
  121. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  122. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  123. <STRONG><P CLASS=block> syslog - Perl interface to the UNIX syslog calls</P></STRONG>
  124. </TD></TR>
  125. </TABLE>
  126.  
  127. </BODY>
  128.  
  129. </HTML>
  130.