RubyGems - riess - Versions diffs - 0.0.8 - Mend

riess 0.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (420) hide show

data/vendor/log4r-1.0.5/doc/rdoc/files/log4r/formatter/formatter_rb.html ADDED

@@ -0,0 +1,152 @@
+<html><head>
+  <title>File: formatter.rb</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+  <link rel=StyleSheet href="../../.././rdoc-style.css" type="text/css" media=screen>
+  <script type="text/javascript" language="JavaScript">
+  <!--
+  function popCode(url) {
+    parent.frames.source.location = url
+  }
+  //-->
+  </script>
+</head>
+<body bgcolor="white">
+<table width="100%">
+ <tr class="title-row">
+ <td><table width="100%"><tr>
+   <td class="big-title-font" colspan=2><font size=-3><B>File</B><BR></font>formatter.rb</td>
+   <td align="right"><table cellspacing=0 cellpadding=2>
+         <tr>
+           <td  class="small-title-font">Path:</td>
+           <td class="small-title-font">log4r/formatter/formatter.rb</td>
+         </tr>
+         <tr>
+           <td class="small-title-font">Modified:</td>
+           <td class="small-title-font">Mon Sep 01 15:33:20 PDT 2003</td>
+         </tr>
+        </table>
+    </td></tr></table></td>
+  </tr>
+</table><br>
+  <!-- banner header -->
+<div class="description"><h1>Formatters</h1>
+<p>
+Formatters are responsible for formatting LogEvent data. An Outputter
+owning a Formatter will invoke the Log4r::Formatter#format method prior to
+writing.
+</p>
+<h2>Available Formatters</h2>
+<ul>
+<li><a
+href="../../../classes/Log4r/BasicFormatter.html">Log4r::BasicFormatter</a>
+- default
+</li>
+<li><a
+href="../../../classes/Log4r/PatternFormatter.html">Log4r::PatternFormatter</a>
+- most flexible. See <a
+href="patternformatter_rb.html">log4r/formatter/patternformatter.rb</a>
+</li>
+<li><a
+href="../../../classes/Log4r/SimpleFormatter.html">Log4r::SimpleFormatter</a>
+- like BasicFormatter for Strings only (low noise)
+</li>
+<li><a
+href="../../../classes/Log4r/ObjectFormatter.html">Log4r::ObjectFormatter</a>
+- for inspecting objects
+</li>
+<li>Log4r::NullFormatter - twirls on its feet and does nothing
+</li>
+</ul>
+<h1>XML Configuration</h1>
+<p>
+Specify the Formatter and its class (as <tt>type</tt>) under an
+<tt>&lt;outputter&gt;</tt> directive:
+</p>
+<pre>
+  &lt;outputter name=&quot;someout&quot; type=&quot;sometype&quot;&gt;
+    &lt;formatter type=&quot;Log4r::BasicFormatter&quot;/&gt;
+  &lt;/outputter&gt;
+</pre>
+<p>
+As explained in <a
+href="../configurator_rb.html">log4r/configurator.rb</a>, the hash
+arguments you would normally pass to <tt>new</tt> are specified as <em>XML
+parameters</em>. Only PatternFormatter has any of these.
+</p>
+<h1>Custom Formatting</h1>
+<p>
+Building a custom Formatter is extremely easy. Just define a class that
+extends Formatter and override the Formatter#format method. Then give it to
+any interested Outputters.
+</p>
+<p>
+If you&#8217;re interested in setting up your custom formatters in XML,
+please take a look at <a
+href="../configurator_rb.html">log4r/configurator.rb</a>.
+</p>
+<h2>Data Available</h2>
+<p>
+See <a href="../../../classes/Log4r/LogEvent.html">Log4r::LogEvent</a>
+</p>
+<table>
+<tr><td valign="top">Version:</td><td>$Id: formatter.rb,v 1.7 2003/09/01 22:33:20 cepheus Exp $
+</td></tr>
+</table>
+</div>
+<table cellpadding=5 width="100%">
+<tr><td class="tablesubtitle">Required files</td></tr>
+</table><br>
+<div class="name-list">
+singleton
+log4r/base
+</div>
+<table cellpadding=5 width="100%">
+<tr><td class="tablesubtitle">Classes and Modules</td></tr>
+</table><br>
+Module <a href="../../../classes/Log4r.html" class="link">Log4r</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/BasicFormatter.html" class="link">Log4r::BasicFormatter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/ConfigError.html" class="link">Log4r::ConfigError</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/Configurator.html" class="link">Log4r::Configurator</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/DateFileOutputter.html" class="link">Log4r::DateFileOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/DefaultFormatter.html" class="link">Log4r::DefaultFormatter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/EmailOutputter.html" class="link">Log4r::EmailOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/FileOutputter.html" class="link">Log4r::FileOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/Formatter.html" class="link">Log4r::Formatter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/IOOutputter.html" class="link">Log4r::IOOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/Log4rTools.html" class="link">Log4r::Log4rTools</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/LogEvent.html" class="link">Log4r::LogEvent</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/LogServer.html" class="link">Log4r::LogServer</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/Logger.html" class="link">Log4r::Logger</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/ObjectFormatter.html" class="link">Log4r::ObjectFormatter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/Outputter.html" class="link">Log4r::Outputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/PatternFormatter.html" class="link">Log4r::PatternFormatter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/RemoteOutputter.html" class="link">Log4r::RemoteOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/RollingFileOutputter.html" class="link">Log4r::RollingFileOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/RootLogger.html" class="link">Log4r::RootLogger</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/SimpleFormatter.html" class="link">Log4r::SimpleFormatter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/StderrOutputter.html" class="link">Log4r::StderrOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/StdoutOutputter.html" class="link">Log4r::StdoutOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/SyslogOutputter.html" class="link">Log4r::SyslogOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/YamlConfigurator.html" class="link">Log4r::YamlConfigurator</a><br />
+<br>
+  <!-- method descriptions -->
+</body>
+</html>

data/vendor/log4r-1.0.5/doc/rdoc/files/log4r/formatter/patternformatter_rb.html ADDED

@@ -0,0 +1,266 @@
+<html><head>
+  <title>File: patternformatter.rb</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+  <link rel=StyleSheet href="../../.././rdoc-style.css" type="text/css" media=screen>
+  <script type="text/javascript" language="JavaScript">
+  <!--
+  function popCode(url) {
+    parent.frames.source.location = url
+  }
+  //-->
+  </script>
+</head>
+<body bgcolor="white">
+<table width="100%">
+ <tr class="title-row">
+ <td><table width="100%"><tr>
+   <td class="big-title-font" colspan=2><font size=-3><B>File</B><BR></font>patternformatter.rb</td>
+   <td align="right"><table cellspacing=0 cellpadding=2>
+         <tr>
+           <td  class="small-title-font">Path:</td>
+           <td class="small-title-font">log4r/formatter/patternformatter.rb</td>
+         </tr>
+         <tr>
+           <td class="small-title-font">Modified:</td>
+           <td class="small-title-font">Mon Jan 28 08:05:05 PST 2002</td>
+         </tr>
+        </table>
+    </td></tr></table></td>
+  </tr>
+</table><br>
+  <!-- banner header -->
+<div class="description"><h1>PatternFormatter</h1>
+<p>
+PatternFormatter offers complete control over the appearance of <a
+href="../../../classes/Log4r.html">Log4r</a> log events without having to
+write custom Formatter classes. In order to take advantage of
+PatternFormatter, some familarity with Kernel#sprintf or the C printf
+function is recommended. For time formatting, please look at Time.strftime.
+</p>
+<p>
+PatternFormatter accepts three hash arguments:
+</p>
+<table>
+<tr><td valign="top"><tt>pattern</tt>:</td><td>Log event format string.
+</td></tr>
+<tr><td valign="top"><tt>date_pattern</tt>:</td><td>Date format string.
+</td></tr>
+<tr><td valign="top"><tt>date_method</tt>:</td><td><tt>Time</tt> method to call (instead of using date_pattern).
+</td></tr>
+</table>
+<p>
+The <tt>pattern</tt> format string is something like &quot;%l [%d]
+%80M&quot;, which resembles a pattern one would normally pass to
+Kernel#sprintf. However, the directives are specific to <a
+href="../../../classes/Log4r.html">Log4r</a>. Before we go on, let&#8217;s
+cover some terminology.
+</p>
+<h2>Terminology</h2>
+<dl>
+<dt><b>%</b></dt><dd>The directive identifier. Everything after this up to and including one of
+the <em>directive letters</em> defines a <em>directive</em>.
+</dd>
+<dt><b>directive letter</b></dt><dd>Letters in the set <tt>[cCdtmMl%]</tt>. These identify what kind of data
+we&#8217;re interested in. They are detailed below.
+</dd>
+<dt><b>format directive</b></dt><dd>The numbers and assorted symbols that appears between <b>%</b> and a
+<em>directive letter</em> is a format directive. It is comprised of an
+integer specifying the field width followed optionally by a period and an
+integer specifying the precision. The field width is the minimum number of
+characters to copy from the data string while the precision is the maximum
+number to copy. If the field width is preceded by a - sign, the data will
+be left-justified. Otherwise, it is right-justified.
+</dd>
+<dt><b>directive</b></dt><dd>A statement that says, &quot;I want this data to appear with this
+(optional) particular format.&quot; A directive starts with a <b>%</b> and
+is followed by a format directive and terminates in a directive letter.
+</dd>
+</dl>
+<h2>What the Directive Letters mean</h2>
+<dl>
+<dt><b>c</b></dt><dd>Produces a logger&#8217;s name. Fast.
+</dd>
+<dt><b>C</b></dt><dd>Produces a logger&#8217;s full name. Fast.
+</dd>
+<dt><b>d</b></dt><dd>Produces the time in a format specified by <b>date_pattern</b> or by
+<b>date_method</b>. If neither is specified, the default will be used
+(ISO8601). Slow.
+</dd>
+<dt><b>t</b></dt><dd>Produces the file and line number of the log event. The appearance varies
+by Ruby version, but it is the same output returned by Kernel#caller[0].
+Slow.
+</dd>
+<dt><b>m</b></dt><dd>The non-inspected log message. That is, to_s called on the object passed
+into a log method. Fast.
+</dd>
+<dt><b>M</b></dt><dd>The message formatted by the <tt><a
+href="../../../classes/Log4r/BasicFormatter.html#M000075">format_object</a></tt>
+method in BasicFormatter. It will pretty-print Exceptions, print Strings
+and inspect everything else. Slow.
+</dd>
+<dt><b>l</b></dt><dd>The name of the level. That&#8217;s l as in Lambda. Fast.
+</dd>
+<dt><b>%</b></dt><dd>%% just prints a %. Any formatting is <em>probably</em> ignored. Fast.
+</dd>
+</dl>
+<h2>Examples of directives:</h2>
+<dl>
+<dt><b>%d</b></dt><dd>Prints out the date according to our date_pattern or date_method. By
+default, it looks like this: 2001-01-12 13:15:50
+</dd>
+<dt><b>%.120m</b></dt><dd>Prints out at most 120 characters of the log message.
+</dd>
+<dt><b>%15t</b></dt><dd>Prints the execution trace and pads it on the left with enough whitespace
+to make the whole thing 15 chars.
+</dd>
+</dl>
+<h2>Pattern String</h2>
+<p>
+A pattern string is simply a bunch of directives combined with the desired
+format. For instance, to show the level in brackets followed by the date
+and then the log message trimmed to 15 characters, we use the following
+pattern:
+</p>
+<pre>
+  &quot;[%l] %d :: %.15m&quot;     #=&gt;     [DEBUG] 2001-01-12 13:15:50 :: This is a messa
+</pre>
+<p>
+To create a PatternFormatter with this format:
+</p>
+<pre>
+  p = PatternFormatter.new(:pattern =&gt; &quot;[%l] %d :: %.15m&quot;)
+</pre>
+<h2>Formatting time</h2>
+<p>
+To format time, do one of the following:
+</p>
+<ul>
+<li>Specify a date_pattern
+</li>
+<li>Specify what class method of Ruby&#8217;s <tt>Time</tt> class to call.
+</li>
+<li>Use the default format
+</li>
+</ul>
+<p>
+If neither date_pattern nor date_method is specified, the default date
+format will be used. Currently, that would be ISO8601,
+</p>
+<p>
+The date_pattern is exactly what one would pass to <tt>Time.strftime</tt>.
+To specify a date_pattern, pass
+<tt>:date_pattern=&gt;&quot;pattern&quot;</tt> to PatternFormat.new.
+</p>
+<p>
+Alternatively, date_method can be specified to produce the output of a
+specific <tt>Time</tt> method, such as <tt>usec</tt> or <tt>to_s</tt> or
+any other zero argument <tt>Time</tt> method that produces a time. More
+precisely, the method to call will be invoked on <tt>Time.now</tt>. To
+specify a date_method, pass
+<tt>:date_method=&gt;&#8217;methodname&#8217;</tt> (or a Symbol equivalent)
+to <tt>PatternFormatter.new</tt>.
+</p>
+<h1>XML Configuration</h1>
+<p>
+As explained in <a
+href="../configurator_rb.html">log4r/configurator.rb</a>, the hash
+arguments to PatternFormatter are <em>XML parameters</em>. Here&#8217;s an
+example:
+</p>
+<pre>
+  &lt;formatter type=&quot;PatternFormatter&quot; pattern=&quot;[%l] %d :: %.15m&quot;&gt;
+    &lt;date_method&gt;usec&lt;/date_method&gt;
+  &lt;/formatter&gt;
+</pre>
+<h1>Performace considerations</h1>
+<p>
+The performance impact of using a particular directive letter is noted in
+the <b>What the Directives Letters mean</b> section.
+</p>
+<p>
+The performance impact of time formatting merits special attention. If you
+aren&#8217;t aware yet, the Time class is kind of a kludge. Time.now.usec
+happens to be faster than Time.now. If you&#8217;re concerned about
+performance, please profile the various time methods and patterns.
+</p>
+<h2>Other Info</h2>
+<table>
+<tr><td valign="top">Version:</td><td>$Id: patternformatter.rb,v 1.2 2002/01/28 16:05:05 cepheus Exp $
+</td></tr>
+<tr><td valign="top">Author:</td><td>Leon Torres &lt;leon@ugcs.caltech.edu&gt;
+</td></tr>
+</table>
+</div>
+<table cellpadding=5 width="100%">
+<tr><td class="tablesubtitle">Required files</td></tr>
+</table><br>
+<div class="name-list">
+<a href="formatter_rb.html">log4r/formatter/formatter</a>
+</div>
+<table cellpadding=5 width="100%">
+<tr><td class="tablesubtitle">Classes and Modules</td></tr>
+</table><br>
+Module <a href="../../../classes/Log4r.html" class="link">Log4r</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/BasicFormatter.html" class="link">Log4r::BasicFormatter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/ConfigError.html" class="link">Log4r::ConfigError</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/Configurator.html" class="link">Log4r::Configurator</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/DateFileOutputter.html" class="link">Log4r::DateFileOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/DefaultFormatter.html" class="link">Log4r::DefaultFormatter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/EmailOutputter.html" class="link">Log4r::EmailOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/FileOutputter.html" class="link">Log4r::FileOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/Formatter.html" class="link">Log4r::Formatter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/IOOutputter.html" class="link">Log4r::IOOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/Log4rTools.html" class="link">Log4r::Log4rTools</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/LogEvent.html" class="link">Log4r::LogEvent</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/LogServer.html" class="link">Log4r::LogServer</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/Logger.html" class="link">Log4r::Logger</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/ObjectFormatter.html" class="link">Log4r::ObjectFormatter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/Outputter.html" class="link">Log4r::Outputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/PatternFormatter.html" class="link">Log4r::PatternFormatter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/RemoteOutputter.html" class="link">Log4r::RemoteOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/RollingFileOutputter.html" class="link">Log4r::RollingFileOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/RootLogger.html" class="link">Log4r::RootLogger</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/SimpleFormatter.html" class="link">Log4r::SimpleFormatter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/StderrOutputter.html" class="link">Log4r::StderrOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/StdoutOutputter.html" class="link">Log4r::StdoutOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/SyslogOutputter.html" class="link">Log4r::SyslogOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../../classes/Log4r/YamlConfigurator.html" class="link">Log4r::YamlConfigurator</a><br />
+<br>
+  <!-- method descriptions -->
+</body>
+</html>

data/vendor/log4r-1.0.5/doc/rdoc/files/log4r/logger_rb.html ADDED

@@ -0,0 +1,320 @@
+<html><head>
+  <title>File: logger.rb</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+  <link rel=StyleSheet href="../.././rdoc-style.css" type="text/css" media=screen>
+  <script type="text/javascript" language="JavaScript">
+  <!--
+  function popCode(url) {
+    parent.frames.source.location = url
+  }
+  //-->
+  </script>
+</head>
+<body bgcolor="white">
+<table width="100%">
+ <tr class="title-row">
+ <td><table width="100%"><tr>
+   <td class="big-title-font" colspan=2><font size=-3><B>File</B><BR></font>logger.rb</td>
+   <td align="right"><table cellspacing=0 cellpadding=2>
+         <tr>
+           <td  class="small-title-font">Path:</td>
+           <td class="small-title-font">log4r/logger.rb</td>
+         </tr>
+         <tr>
+           <td class="small-title-font">Modified:</td>
+           <td class="small-title-font">Wed Mar 17 11:13:07 PST 2004</td>
+         </tr>
+        </table>
+    </td></tr></table></td>
+  </tr>
+</table><br>
+  <!-- banner header -->
+<div class="description"><h1>Loggers</h1>
+<p>
+Loggers provide the interface for logging in <a
+href="../../classes/Log4r.html">Log4r</a>. To create a logger, first come
+up with a name for it. Good choices include the name of the class using it,
+a service name, or the name of the file.
+</p>
+<p>
+To create a logger named &#8216;mylog&#8217;:
+</p>
+<pre>
+  Logger.new('mylog')
+</pre>
+<p>
+After creating a logger, it is stashed in a repository. The logger may be
+retrieved at any time:
+</p>
+<pre>
+  Logger['mylog']              # get mylog back
+</pre>
+<p>
+It will return nil if the logger is not found. Alternatively, if an
+Exception is desired when a nonexistant logger is referenced, the
+Logger#get command can be used:
+</p>
+<pre>
+  Logger.get('boguslog')       # raises NameError if it doesn't exist
+</pre>
+<h2>Manipulating a Logger&#8217;s Outputters</h2>
+<p>
+Loggers start out with no outputters. They can be added using the
+Logger#add method or set directly by modifying the Loggers#outputters
+array:
+</p>
+<pre>
+  mylog = Logger['mylog']
+  # assume we've created Outputters out1 through out4
+  mylog.outputters = out1, out2
+  mylog.add(out3, out4)
+  mylog.each_outputter {|o| o.flush}
+</pre>
+<pre>
+  # assume out5 through out7 have names 'out5' through 'out7' resp.
+  mylog.outputters = 'out5', 'out6'
+  mylog.add('out7')
+  mylog.remove('out5','out7')
+</pre>
+<p>
+Please see <a
+href="outputter/outputter_rb.html">log4r/outputter/outputter.rb</a> and <a
+href="../../classes/Log4r/Outputter.html">Log4r::Outputter</a> for more
+about outputters.
+</p>
+<h2>Logging Methods</h2>
+<p>
+To log something at a certain priority, use the logging method named after
+the lowercased priority level name:
+</p>
+<pre>
+  mylog.warn &quot;This is a message with priority WARN&quot;
+  mylog.fatal &quot;A FATAL message&quot;
+</pre>
+<p>
+Blocks can also be logged:
+</p>
+<pre>
+  mylog.warn {&quot;This is also a message with priority WARN&quot;}
+  mylog.debug do
+    # some complicated string magic
+    return result
+  end
+</pre>
+<p>
+The primary difference is that the block doesn&#8217;t get called unless
+the Logger can log at that level. It is useful for doing computationaly
+expensive things at a log event.
+</p>
+<h2>Query Methods</h2>
+<p>
+To ask <a href="../../classes/Log4r.html">Log4r</a> whether it is capable
+of logging a certain level:
+</p>
+<pre>
+  mylog.warn?   # are we logging WARN?
+  mylog.fatal?  # how about FATAL?
+</pre>
+<p>
+Query methods and blocks accomplish the same thing:
+</p>
+<pre>
+  mylog.warn &quot;don't evaluate unless WARN is on&quot; if mylog.warn?
+  mylog.warn {&quot;don't evaluate unless WARN is on&quot;}
+</pre>
+<h2>What About the Special Levels?</h2>
+<p>
+<tt>ALL</tt> and <tt>OFF</tt> can be querried, but not logged:
+</p>
+<pre>
+  log.off?                    # true iff level is OFF
+  log.all?                    # true iff level is ALL
+  log.all &quot;Try to log&quot;        =&gt; Method not defined. (NameError)
+</pre>
+<h2>Custom Levels and Method Names</h2>
+<p>
+Suppose we&#8217;ve set up <a href="../../classes/Log4r.html">Log4r</a>
+with the custom levels:
+</p>
+<pre>
+  Foo &lt; Bar &lt; Baz
+</pre>
+<p>
+As one might expect, the logging methods are named after them:
+</p>
+<pre>
+  log.bar &quot;something&quot;        # log at custom level Bar
+  log.bar?                   # are we logging at level Bar?
+</pre>
+<h1>Logger Inheritance</h1>
+<p>
+Normally, when a logger is created, its parent is set to RootLogger. If a
+Logger&#8217;s level isn&#8217;t specified at creation, it will inherit the
+level of its parent.
+</p>
+<p>
+To specify an ancestors of a logger besides RootLogger, include the names
+of the ancestors in order of ancestry and delimited by
+Log4r::Log4rConfig::LoggerPathDelimiter. For example, if the delimiter is
+the default <tt>::</tt>, our logger is &#8216;me&#8217; and its ancestors
+are &#8216;cain&#8217;, &#8216;grandpa&#8217;, and &#8216;pa&#8217;, we
+create the logger like so:
+</p>
+<pre>
+  Logger.new('cain::grandpa::pa::me')
+</pre>
+<p>
+This string is split into three compontents which can be used by a
+Formatter to avoid parsing the name:
+</p>
+<table>
+<tr><td valign="top">Logger#fullname:</td><td>The whole enchilada: &#8216;cain::grandpa::pa::me&#8217;
+</td></tr>
+<tr><td valign="top">Logger#name:</td><td>Just &#8216;me&#8217;
+</td></tr>
+</table>
+<p>
+To get this logger back from the repository,
+</p>
+<pre>
+  Logger['cain::grandpa::pa::me']
+</pre>
+<h1>Outputter Additivity</h1>
+<p>
+By default, Logger Outputters are <b>additive</b>. This means that a log
+event will also be sent to all of a logger&#8217;s ancestors. To stop this
+behavior, set a logger&#8217;s <tt>additive</tt> to false.
+</p>
+<pre>
+  Logger['foo'].additive = false
+</pre>
+<p>
+A Logger&#8217;s level, additivity and trace can be changed dynamically,
+but this is an expensive operation as the logging methods have to be
+redefined.
+</p>
+<h1>RootLogger</h1>
+<p>
+<a href="../../classes/Log4r/RootLogger.html">Log4r::RootLogger</a> is the
+ancestor of all loggers. Its level defines the global logging threshold.
+Any loggers created <b>after</b> RootLogger&#8217;s level is set will not
+log below that level. By default, RootLogger&#8217;s level is set to
+<tt>ALL</tt>
+</p>
+<p>
+RootLogger is a singleton which gets created automaticallay. It can be
+retrieved at any time with Logger.root, Logger.global,
+Logger[&#8216;root&#8217;] or Logger[&#8216;global&#8217;].
+</p>
+<h2>Global Level</h2>
+<p>
+Suppose we want <em>everything</em> to ignore events less than FATAL. We
+can accomplish this easily:
+</p>
+<pre>
+  Logger.global.level = FATAL
+</pre>
+<p>
+Just be sure to set this before any other Loggers or Outputters are
+defined.
+</p>
+<h2>RootLogger Does Nothing</h2>
+<p>
+RootLogger itself behaves as if its level were permanently set to
+<tt>OFF</tt>, thus making it a sort of null object.
+</p>
+<h1>XML Configuration</h1>
+<p>
+Please see <a href="configurator_rb.html">log4r/configurator.rb</a> for an
+overview of XML configuratoin.
+</p>
+<p>
+It&#8217;s easy to configure a Logger in XML. The following example should
+be sufficient:
+</p>
+<pre>
+    ...
+    &lt;logger name=&quot;papa::mylog&quot; level=&quot;DEBUG&quot; trace=&quot;true&quot;&gt;
+      &lt;additive&gt;false&lt;/additive&gt;
+      &lt;outputter&gt;stdout&lt;/outputter&gt;
+      &lt;outputters&gt;stderr, dancer, doner, blitzen&lt;/outputters&gt;
+    &lt;/logger&gt;
+    &lt;logger name=&quot;papa&quot; outputters=&quot;stderr, stdout&quot;/&gt;
+    ...
+</pre>
+<p>
+The element <tt>outputter</tt> can occur multiple times, but cannot be an
+attribute of <tt>logger</tt>. That is, it is not an <em>XML directive</em>.
+However, the element <tt>outputters</tt> is an <em>XML directive</em>, as
+are all the others.
+</p>
+<p>
+For more examples, check the <tt>examples</tt> directory in the <a
+href="../../classes/Log4r.html">Log4r</a> package.
+</p>
+<h2>Other Info</h2>
+<table>
+<tr><td valign="top">Version:</td><td>$Id: logger.rb,v 1.24 2004/03/17 19:13:07 fando Exp $
+</td></tr>
+<tr><td valign="top">Author:</td><td>Leon Torres &lt;leon(at)ugcs.caltech.edu&gt;
+</td></tr>
+</table>
+</div>
+<table cellpadding=5 width="100%">
+<tr><td class="tablesubtitle">Required files</td></tr>
+</table><br>
+<div class="name-list">
+<a href="outputter/outputter_rb.html">log4r/outputter/outputter</a>
+log4r/repository
+log4r/loggerfactory
+log4r/staticlogger
+</div>
+<table cellpadding=5 width="100%">
+<tr><td class="tablesubtitle">Classes and Modules</td></tr>
+</table><br>
+Module <a href="../../classes/Log4r.html" class="link">Log4r</a><br />
+&nbsp;&nbsp;::Class <a href="../../classes/Log4r/BasicFormatter.html" class="link">Log4r::BasicFormatter</a><br />
+&nbsp;&nbsp;::Class <a href="../../classes/Log4r/ConfigError.html" class="link">Log4r::ConfigError</a><br />
+&nbsp;&nbsp;::Class <a href="../../classes/Log4r/Configurator.html" class="link">Log4r::Configurator</a><br />
+&nbsp;&nbsp;::Class <a href="../../classes/Log4r/DateFileOutputter.html" class="link">Log4r::DateFileOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../classes/Log4r/DefaultFormatter.html" class="link">Log4r::DefaultFormatter</a><br />
+&nbsp;&nbsp;::Class <a href="../../classes/Log4r/EmailOutputter.html" class="link">Log4r::EmailOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../classes/Log4r/FileOutputter.html" class="link">Log4r::FileOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../classes/Log4r/Formatter.html" class="link">Log4r::Formatter</a><br />
+&nbsp;&nbsp;::Class <a href="../../classes/Log4r/IOOutputter.html" class="link">Log4r::IOOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../classes/Log4r/Log4rTools.html" class="link">Log4r::Log4rTools</a><br />
+&nbsp;&nbsp;::Class <a href="../../classes/Log4r/LogEvent.html" class="link">Log4r::LogEvent</a><br />
+&nbsp;&nbsp;::Class <a href="../../classes/Log4r/LogServer.html" class="link">Log4r::LogServer</a><br />
+&nbsp;&nbsp;::Class <a href="../../classes/Log4r/Logger.html" class="link">Log4r::Logger</a><br />
+&nbsp;&nbsp;::Class <a href="../../classes/Log4r/ObjectFormatter.html" class="link">Log4r::ObjectFormatter</a><br />
+&nbsp;&nbsp;::Class <a href="../../classes/Log4r/Outputter.html" class="link">Log4r::Outputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../classes/Log4r/PatternFormatter.html" class="link">Log4r::PatternFormatter</a><br />
+&nbsp;&nbsp;::Class <a href="../../classes/Log4r/RemoteOutputter.html" class="link">Log4r::RemoteOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../classes/Log4r/RollingFileOutputter.html" class="link">Log4r::RollingFileOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../classes/Log4r/RootLogger.html" class="link">Log4r::RootLogger</a><br />
+&nbsp;&nbsp;::Class <a href="../../classes/Log4r/SimpleFormatter.html" class="link">Log4r::SimpleFormatter</a><br />
+&nbsp;&nbsp;::Class <a href="../../classes/Log4r/StderrOutputter.html" class="link">Log4r::StderrOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../classes/Log4r/StdoutOutputter.html" class="link">Log4r::StdoutOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../classes/Log4r/SyslogOutputter.html" class="link">Log4r::SyslogOutputter</a><br />
+&nbsp;&nbsp;::Class <a href="../../classes/Log4r/YamlConfigurator.html" class="link">Log4r::YamlConfigurator</a><br />
+<br>
+  <!-- method descriptions -->
+</body>
+</html>