<?xml version="1.0" encoding="iso-8859-1"?>
<!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" xml:lang="en" lang="en">
<head>
<title>File: README</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="fileHeader">
<h1>README</h1>
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Path:</strong></td>
<td>README
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
<td>Fri Oct 28 14:57:44 GMT-8:00 2005</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>
Copyright © 2005, Christopher Kleckner All rights reserved
</p>
<p>
This file is part of the Rio library for ruby.
</p>
<p>
Rio is free software; you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.
</p>
<p>
Rio is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details.
</p>
<p>
You should have received a copy of the GNU General Public License along
with Rio; if not, write to the Free Software Foundation, Inc., 51 Franklin
St, Fifth Floor, Boston, MA 02110-1301 USA
</p>
<p>
<b>Rio is pre-alpha software. The documented interface and behavior is
subject to change without notice.</b>
</p>
<h3>Rio - Ruby I/O Comfort Class</h3>
<p>
Rio is a convenience class wrapping much of the functionality of IO, File,
Dir, Pathname, FileUtils, Tempfile, StringIO, OpenURI, Zlib, and CSV.
</p>
<p>
To create the documentation for Rio run the command
</p>
<pre>
rake rdoc
</pre>
<p>
from the distribution directory.
</p>
<p>
If your don’t have rake installed try:
</p>
<pre>
ruby RUNME.1st.rb
</pre>
<p>
from the distribution directory.
</p>
<p>
Then point your browser at the ‘doc/rdoc’ directory.
</p>
<p>
Suggested Reading
</p>
<ul>
<li><a href="../classes/RIO/Doc/SYNOPSIS.html">RIO::Doc::SYNOPSIS</a>
</li>
<li><a href="../classes/RIO/Doc/INTRO.html">RIO::Doc::INTRO</a>
</li>
<li><a href="../classes/RIO/Doc/HOWTO.html">RIO::Doc::HOWTO</a>
</li>
<li><a href="../classes/RIO/Rio.html">RIO::Rio</a>
</li>
</ul>
<p>
To install Rio untar the distribution and type
</p>
<pre>
rake install
</pre>
<p>
If you don’t have rake installed, get it.
</p>
<p>
Until you do, you may want to try
</p>
<pre>
ruby setup.rb
</pre>
<p>
Rio is also available as a gem. If you have rubygems installed use:
</p>
<pre>
gem install rio
</pre>
<p>
To use Rio as a rubygem:
</p>
<pre>
require 'rubygems'
require 'rio'
</pre>
<p>
To build the documentation without rake, try
</p>
<pre>
rdoc --op doc/rdoc -m RIO::Doc::SYNOPSIS README lib/rio/doc/*.rb lib/rio.rb lib/rio/if/*.rb lib/rio/kernel.rb
</pre>
<p>
Then point your browser at doc/rdoc.
</p>
<p>
To read the documentation without running rdoc, read the files:
</p>
<ul>
<li>lib/rio/doc/SYNOPSIS.rb
</li>
<li>lib/rio/doc/INTRO.rb
</li>
<li>lib/rio/doc/HOWTO.rb
</li>
<li>lib/rio/if/*.rb
</li>
</ul>
<table>
<tr><td valign="top">Project:</td><td><a href="http://rubyforge.org/projects/rio">rubyforge.org/projects/rio</a>/
</td></tr>
<tr><td valign="top">Documentation:</td><td><a href="http://rio.rubyforge.org">rio.rubyforge.org</a>/
</td></tr>
<tr><td valign="top">Bugs:</td><td><a
href="http://rubyforge.org/tracker/?group_id=821">rubyforge.org/tracker/?group_id=821</a>
</td></tr>
<tr><td valign="top">Email:</td><td>rio4ruby@rubyforge.org
</td></tr>
</table>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<!-- if method_list -->
</div>
<div id="validator-badges">
<p><small>Copyright © 2005 Christopher Kleckner. <a href="http://www.gnu.org/licenses/gpl.html">All rights reserved</a>.</small></p>
</div>
</body>
</html>