log4r 1.0.6

data/doc/dev/README.developers

@@ -0,0 +1,55 @@
+This document introduces interested developers to log4r development. It also
+reminds us how things work here. :-)
+
+RubyForge Site
+--------------
+
+Log4r is hosted on RubyForge. It was hosted on SourceForge up to 1.0.5.
+
+Project Full Name:  Log4r
+Project Unix Name:  log4r
+CVS Server:         cvs.log4r.rubyforge.org
+Shell/Web Server:   log4r.rubyforge.org
+Path to web pages:  /var/www/gforge-projects/log4r/
+
+
+HTML manual and site
+--------------------
+
+This is pieced together with a homebrewed content-template system. 
+doc/content has the actual contents, which are just three lines of metadata 
+and a bunch of <tr>s that are incorporated into a template. The only template 
+is doc/templates/main.html which is universal. To test the changes, run 
+bin/makedoc.rb directly and check the results in doc/index.html.
+
+
+Testing RDoc
+------------
+Either run bin/makerdoc.rb directly or,
+
+  cd src/
+  rdoc --op /tmp/rdoc --template kilmer --main log4r.rb
+
+
+Automated Builds
+----------------
+
+The build system is automated and relies on CVS and ruby. There are three main
+things that go on during build:
+
+1) bin/makedist.rb checks out a build to prepare for distribution and calls
+   other build scripts, then assembles the distribution into tgz and zip balls
+
+2) HTML manual is constructed by bin/makehtml.rb, called from makedist.rb
+
+3) RDoc is constructed by bin/makerdoc.rb, called from makedist.rb
+
+All system variables and configurable options are in bin/devconfig.rb.
+
+Essentially, the only thing that needs to be done to build packages for
+distribution is,
+
+  ruby makedist.rb <version-number>
+
+The results are one tarball, one zip file of the same, and one documentation
+tarball ready to be placed on the log4r home page.

data/doc/dev/checklist

@@ -0,0 +1,23 @@
+Release checklist:
+
+* DON'T FORGET: change install.rb when new src/ files are added
+* Update the log4r.gemspec
+* Update the changelog
+* Update the README
+* Change any INSTALL instructions
+* Update the manuals and HTML
+* Modify what should not appear in the release (bin/prune.rb)
+* Run makedist.rb and check the integrity of the resulting files
+  - Test installs
+  - Run the unit tests (cd tests; ruby testall.rb)
+  - Run all the examples
+  - Browse the docs
+
+
+Who to Tell:
+
+* RubyGems distribution (to upload gem)
+* ruby-talk mailing list
+* RAA
+* RubyForge news
+* RubyForge email notification of new file releases

data/doc/dev/things-to-do

@@ -0,0 +1,5 @@
+* Add gem generation to the automated build process
+* Rewrite the RDoc in third person (no "you"s) and be more formal
+* Warn of any remaining parameters from XML and YAML in the Configurators
+* Refactor YamlConfigurator and Configurator a bit: XML shouldn't sound
+  like the prefered option

data/doc/log4r.css

@@ -0,0 +1,111 @@
+body {
+	background-color: #FFFFFF;
+	font-family:sans-serif;
+}
+
+a:link { color:#014DA3 }
+a:active { color:#AA0000 }
+a:visited { color:#014DA3 }
+a:hoover { color:#AA0000 }
+
+.example {
+	font-family: monospace;
+	border:1px solid #007;
+	background:#FFFFFF;
+	margin:1em;
+}
+
+pre.box {
+	margin:0px 1em 1em 1em;
+	color:#AA0000;
+}
+
+.menu {
+	font-family:sans-serif;
+	font-size:10px;
+	border-left: 1px solid #AA0000;
+	border-right: 1px solid #AA0000;
+	border-bottom: 1px solid #AA0000;
+	background:#EEEEEE;
+	color:#AA0000;
+}
+
+.menutitle {
+  font-family:sans-serif;
+  font-size:medium;
+  color:#FFFFFF;
+  font-weight:bold;
+  background:#AA0000;
+  border-right: 1px solid #AA0000;
+  border-left: 1px solid #AA0000;
+  border-top: 1px solid #AA0000;
+  border-bottom: 1px solid #AA0000;
+}
+
+.menubuff {
+  font-family:sans-serif;
+  font-size:1px;
+  color:#000000;
+  border-left: 1px solid #AA0000;
+  border-right: 1px solid #AA0000;
+  font-weight:bold;
+  background-color: #99CCFF;
+  height:5;
+  padding-bottom: 0;
+}
+
+.contentbuff {
+	font-family:sans-serif;
+	font-size:10px;
+	border-left: 1px solid #AA0000;
+	border-right: 1px solid #AA0000;
+	font-weight:bold;
+	background-color: #99CCFF;
+  height:5;
+	padding-bottom: 0;
+}
+
+.header {
+	font-family:sans-serif;
+	color:#AA0000;
+}
+
+.content {
+  font-family:sans-serif;
+  font-size:medium;
+  color:#000000;
+  background:#EEEEEE;
+  border-right: 2px solid #AA0000;
+  border-left: 2px solid #AA0000;
+  border-bottom: 2px solid #AA0000;
+  padding-bottom: 5;
+  padding-right: 5;
+  padding-left: 5;
+  padding-top: 0;
+}
+.contenttitle {
+font-family:sans-serif;
+font-size:medium;
+color:#FFFFFF;
+font-weight:bold;
+background-color:#AA0000;
+border-left: 2px solid #AA0000;
+border-top: 1px solid #AA0000;
+border-right: 2px solid #AA0000;
+padding: 2;
+}
+
+.contentbuff {
+  font-family:sans-serif;
+  font-size:10px;
+  color:#014DA3;
+  border-left: 2px solid #AA0000;
+  border-right: 2px solid #AA0000;
+  font-weight:bold;
+  background-color:#99CCFF;
+  height:13;
+  padding-bottom: 0;
+}
+
+br { padding-bottom: 200 }
+

data/doc/templates/main.html

@@ -0,0 +1,147 @@
+<html>
+<head>
+  <!-- TITLE -->
+  <link rel="stylesheet" type="text/css" href="log4r.css">
+</head>
+<body>
+
+<div align="right"><img src="images/log4r-logo.png"/></div>
+<hr noshade>
+
+<table border="0" cellspacing="3" cellpadding="0" width="100%"> 
+<tr>
+
+<!-- Sidebar -->
+<td width="15%" valign="top">
+<table cellspacing="0" cellpadding="0" width=100%" nowrap="true">
+
+<!-- Log4r Box -->
+<tr><td >
+<table width="100%" cellspacing="0" cellpadding="0" align="center" >
+<tr><td width="100%" class="menutitle">Log4r</td></tr>
+<tr><td width="100%" class="menubuff">&nbsp;</td></tr>
+<!-- list -->
+<table class="menu"  cellspacing="3" cellpadding="0" width="100%"
+       align="center">
+<tr><td ><a href="index.html">Home Page</a></tr></td>
+<tr><td><a href="http://sourceforge.net/project/showfiles.php?group_id=43396">
+Download</a></td></tr>
+<tr><td nowrap="true">
+    <a href="http://rubyforge.org/projects/log4r/">@ RubyForge</a>
+</td></tr>
+<tr><td>
+<a href="license.html">License</a>
+</td></tr>
+<tr><td>
+<a href="contact.html">Contact</a>
+</td></tr>
+</table>
+</td></tr>
+
+<tr><td height=15>&nbsp;</td></tr>
+
+<!-- Doc Box -->
+<tr><td >
+<table cellspacing="0" cellpadding="0" align="center" width="100%">
+<tr><td width="100%"  class="menutitle">Documents</td></tr>
+<tr><td  width="100%" class="menubuff">&nbsp;</td></tr>
+<!-- list -->
+<table class="menu"  cellspacing="3" cellpadding="0" width="100%"
+       align="center">
+<tr><td>
+    <a href="manual.html">#{version} Manual</a>
+</tr></tr>
+<tr><td>
+    <a href="rdoc/index.html">#{version} RDoc API</a>
+</td></tr>
+
+</table>
+</td></tr>
+
+<tr><td height=15>&nbsp;</td></tr>
+
+<!-- Development Box -->
+<tr><td >
+<table cellspacing="0" cellpadding="0" align="center" width="100%">
+<tr><td width="100%"  class="menutitle">Development</td></tr>
+<tr><td  width="100%" class="menubuff">&nbsp;</td></tr>
+<!-- list -->
+<table class="menu"  cellspacing="3" cellpadding="0" width="100%"
+       align="center">
+<tr><td>
+<a
+href="http://sourceforge.net/tracker/?atid=436181&group_id=43396&func=browse">
+Bugs</a>
+</tr></tr>
+<tr><td>
+<a
+href="http://sourceforge.net/tracker/?atid=436184&group_id=43396&func=browse">
+Requests</a>
+</td></tr>
+<tr><td>
+<a href="contribute.html">Contribute</a>
+</td></tr>
+
+</table>
+</td></tr>
+
+<tr><td height=15>&nbsp;</td></tr>
+
+
+<!-- Link Box -->
+<tr><td >
+<table cellspacing="0" cellpadding="0" align="center" width="100%">
+<tr><td width="100%"  class="menutitle">Links</td></tr>
+<tr><td  width="100%" class="menubuff">&nbsp;</td></tr>
+<!-- list -->
+<table class="menu"  cellspacing="3" cellpadding="0" width="100%"
+       align="center">
+<tr><td>
+<a href="http://www.ruby-lang.org/en/index.html">Ruby</a>
+</td></tr>
+<tr><td>
+<a href="http://jakarta.apache.org/log4j/docs/index.html">Apache Log4j</a>
+</tr></tr>
+<tr><td>
+<a href="http://www.ruby-lang.org/en/raa-list.rhtml?name=REXML">REXML</a>
+</td></tr>
+<tr><td>
+<a href="http://rm-f.net/~cout/ruby/romp/">ROMP</a>
+</td></tr>
+<tr><td height="5">&nbsp;</td></tr>
+<tr><td align="center">
+    <a href="http://rubyforge.org">
+      <!-- rubyforge image goes here -->
+    </a>
+</a>
+</td></tr>
+
+</table>
+</td></tr>
+
+</table>
+</td>
+
+<!-- Main column -->
+<td width="85%" align="left" valign="top">
+<center>
+<table cellspacing="0" cellpadding="0" align="center" width="95%">
+
+<!-- CONTENT -->
+
+</table>
+</center>
+</td>
+
+
+</tr>
+</table>
+<hr noshade>
+<div align="right">
+<font color="#888888" size="-1">
+<i>
+<!-- CVSID -->
+</i></font>
+</div>
+</body>
+</html>

data/examples/README

@@ -0,0 +1,19 @@
+The examples are:
+
+1. outofthebox.rb                 - How to get started with minimal setup
+2. simpleconfig.rb                - Using Log4r casually
+3. moderateconfig.rb              - A more sophisticated config
+4. xmlconfig.rb and moderate.xml  - XML configuration example based on #3
+5. rrsetup.rb and rrconfig.xml    - A real example (or used to be ;-)
+6. logserver.rb and logclient.rb  - Remote logging example
+7. fileroll.rb                    - Using RollingFileOutputter
+8. yaml.rb and log4r_yaml.yaml    - YAML configuration example
+
+The output will go to screen and to files in the directory logs/.
+
+Note to RubyGems users: The syntax to require log4r as a gem is as follows:
+
+  require 'rubygems'
+  require_gem 'log4r'
+
+Obviously, the examples will need to be modified to follow this.

data/examples/customlevels.rb

@@ -0,0 +1,34 @@
+# Suppose we don't like having 5 levels named DEBUG, INFO, etc.
+# Suppose we'd rather use 3 levels named Foo, Bar, and Baz.
+# Log4r allows you to rename the levels and their corresponding methods
+# in a painless way. This file provides and example
+
+$: << '../src'
+
+require 'log4r'
+require 'log4r/configurator'
+include Log4r
+
+# This is how we specify our levels
+Configurator.custom_levels "Foo", "Bar", "Baz"
+
+l = Logger.new('custom levels')
+l.add StdoutOutputter.new('console')
+
+l.level = Foo
+puts l.foo?
+l.foo "This is foo"
+puts l.bar?
+l.bar "this is bar"
+puts l.baz?
+l.baz "this is baz"
+
+puts "Now change to Baz"
+
+l.level = Baz
+puts l.foo?
+l.foo {"This is foo"}
+puts l.bar?
+l.bar {"this is bar"}
+puts l.baz?
+l.baz {"this is baz"}

data/examples/fileroll.rb

@@ -0,0 +1,40 @@
+# How to use RollingFileOutputter
+
+$: << "../src"
+require 'log4r'
+include Log4r
+
+puts "this will take a while"
+
+# example of log file being split by time constraint 'maxtime'
+config = {
+  "filename" => "logs/TestTime.log",
+  "maxtime" => 10,
+  "trunc" => true
+}
+timeLog = Logger.new 'WbExplorer'
+timeLog.outputters = RollingFileOutputter.new("WbExplorer", config)
+timeLog.level = DEBUG
+
+# log something once a second for 100 seconds
+100.times { |t|
+  timeLog.info "blah #{t}"
+  sleep(1.0)
+}
+
+# example of log file being split by space constraint 'maxsize'
+config = {
+  "filename" => "logs/TestSize.log",
+  "maxsize" => 16000,
+  "trunc" => true
+}
+sizeLog = Logger.new 'WbExplorer'
+sizeLog.outputters = RollingFileOutputter.new("WbExplorer", config)
+sizeLog.level = DEBUG
+
+# log a large number of times
+100000.times { |t|
+  sizeLog.info "blah #{t}"
+}
+
+puts "done! check the two sets of log files in logs/ (TestTime and TestSize)"