<?xml version="1.0" encoding="EUC-JP" ?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>ruby-src:ext/syslog/syslog.txt</title>
<meta http-equiv="Content-type" content="text/html; charset=EUC-JP" />
<link href="default.css" type="text/css" rel="stylesheet" />
<link href="refm463.html" rel="next" />
<link href="refm461.html" rel="prev" />
<link href="index.html" rel="start" />
</head>
<body>
<div class="navigator"><span class="navigator">[<a href="index.html">MAIN</a>][<a href="refm482.html">INDEX</a>][<a href="refm483.html">KEYWORD</a>][<a href="refm594.html">METHOD</a>(<a href="refm633.html">NC</a>)] [<a href="index.html">TOP</a>][<a href="index.html">UP</a>][<a href="refm461.html"><-PREV</a>][<a href="refm463.html">NEXT-></a>]</span></div>
<hr />
<h1>ruby-src:ext/syslog/syslog.txt</h1>
.\" syslog.txt - -*- Indented-Text -*-<br />
$RoughId: syslog.txt,v 1.18 2002/02/25 08:20:14 knu Exp $<br />
$Id: syslog.txt,v 1.2 2002/02/25 12:13:30 knu Exp $<br />
<br />
UNIX Syslog extension for Ruby<br />
Amos Gouaux, University of Texas at Dallas<br />
<amos+ruby@utdallas.edu><br />
&<br />
Akinori MUSHA<br />
<knu@ruby-lang.org><br />
<br />
** Syslog(Module)<br />
<br />
Included Modules: Syslog::Constants<br />
<br />
require 'syslog'<br />
<br />
A Simple wrapper for the UNIX syslog system calls that might be handy<br />
if you're writing a server in Ruby. For the details of the syslog(8)<br />
architecture and constants, see the syslog(3) manual page of your<br />
platform.<br />
<br />
Module Methods:<br />
<br />
open(ident = $0, logopt = Syslog::LOG_PID | Syslog::LOG_CONS,<br />
facility = Syslog::LOG_USER) [{ |syslog| ... }]<br />
<br />
Opens syslog with the given options and returns the module<br />
itself. If a block is given, calls it with an argument of<br />
itself. If syslog is already opened, raises RuntimeError.<br />
<br />
Example:<br />
Syslog.open('ftpd', Syslog::LOG_PID | Syslog::LOG_NDELAY,<br />
Syslog::LOG_FTP)<br />
<br />
open!(ident = $0, logopt = Syslog::LOG_PID | Syslog::LOG_CONS,<br />
facility = Syslog::LOG_USER)<br />
reopen(ident = $0, logopt = Syslog::LOG_PID | Syslog::LOG_CONS,<br />
facility = Syslog::LOG_USER)<br />
<br />
Same as open, but does a close first.<br />
<br />
opened?<br />
<br />
Returns true if syslog opened, otherwise false.<br />
<br />
ident<br />
options<br />
facility<br />
<br />
Returns the parameters given in the last open, respectively.<br />
Every call of Syslog::open resets these values.<br />
<br />
log(pri, message, ...)<br />
<br />
Writes message to syslog.<br />
<br />
Example:<br />
Syslog.log(Syslog::LOG_CRIT, "the sky is falling in %d seconds!", 10)<br />
<br />
crit(message, ...)<br />
emerg(message, ...)<br />
alert(message, ...)<br />
err(message, ...)<br />
warning(message, ...)<br />
notice(message, ...)<br />
info(message, ...)<br />
debug(message, ...)<br />
<br />
These are shortcut methods of Syslog::log(). The lineup may<br />
vary depending on what priorities are defined on your system.<br />
<br />
Example:<br />
Syslog.crit("the sky is falling in %d seconds!", 5)<br />
<br />
mask<br />
mask=(mask)<br />
<br />
Returns or sets the log priority mask. The value of the mask<br />
is persistent and will not be reset by Syslog::open or<br />
Syslog::close.<br />
<br />
Example:<br />
Syslog.mask = Syslog::LOG_UPTO(Syslog::LOG_ERR)<br />
<br />
close <br />
<br />
Closes syslog.<br />
<br />
inspect<br />
<br />
Returns the "inspect" string of the Syslog module.<br />
<br />
instance<br />
<br />
Returns the module itself. (Just for backward compatibility)<br />
<br />
LOG_MASK(pri)<br />
<br />
Creates a mask for one priority.<br />
<br />
LOG_UPTO(pri)<br />
<br />
Creates a mask for all priorities up to pri.<br />
<br />
** Syslog::Constants(Module)<br />
<br />
require 'syslog'<br />
include Syslog::Constants<br />
<br />
This module includes the LOG_* constants available on the system.<br />
<br />
Module Methods:<br />
<br />
LOG_MASK(pri)<br />
<br />
Creates a mask for one priority.<br />
<br />
LOG_UPTO(pri)<br />
<br />
Creates a mask for all priorities up to pri.<br />
<hr />
<div class="navigator"><span class="navigator">[<a href="index.html">MAIN</a>][<a href="refm482.html">INDEX</a>][<a href="refm483.html">KEYWORD</a>][<a href="refm594.html">METHOD</a>(<a href="refm633.html">NC</a>)] [<a href="index.html">TOP</a>][<a href="index.html">UP</a>][<a href="refm461.html"><-PREV</a>][<a href="refm463.html">NEXT-></a>]</span></div>
</body>
</html>
