Copyright © 2005,2006,2007 Christopher Kleckner All rights reserved

This file is part of the Rio library for ruby.

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.

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.

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

Rio - Ruby I/O Facilitator

fa-cil-i-tate: To make easy or easier [www.thefreedictionary.com/facilitate]

Rio is a facade for most of the standard ruby classes that deal with I/O; providing a simple, intuitive, succinct interface to the functionality provided by IO, File, Dir, Pathname, FileUtils, Tempfile, StringIO, OpenURI and others. Rio also provides an application level interface which allows many common I/O idioms to be expressed succinctly.

Building the documentation

To create the documentation for Rio run the command

ruby build_doc.rb

from the distribution directory.

Then point your browser at the ‘doc/rdoc’ directory.

The RDoc template file included with this distribution contains some RDoc hacks that overcomes some of RDoc’s weaknesses and makes the documentation much more usable. It is inadvisable to build the RDoc documentation without these.

Suggested Reading

  • RIO::Doc::SYNOPSIS

  • RIO::Doc::INTRO

  • RIO::Doc::HOWTO

  • RIO::Doc::EXAMPLES

  • RIO::Rio

Installation

To install Rio from the distribution directory type

ruby setup.rb

Rio is also available as a gem. If you have rubygems installed use:

gem install rio

To use Rio as a rubygem:

require 'rubygems'
require 'rio'

To read the documentation without running rdoc, read the files:

  • lib/rio/doc/SYNOPSIS.rb

  • lib/rio/doc/INTRO.rb

  • lib/rio/doc/HOWTO.rb

  • lib/rio/if/*.rb

Project

rubyforge.org/projects/rio/

Documentation

rio.rubyforge.org/

Bugs

rubyforge.org/tracker/?group_id=821

Email

[email protected]