rio 0.4.2 → 0.5.1

data/lib/rio/if/csv.rb

@@ -1,6 +1,6 @@
 #--
-# =============================================================================== 
-# Copyright (c) 2005,2006,2007,2008 Christopher Kleckner
+# ===========================================================================
+# Copyright (c) 2005-2012 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -18,22 +18,9 @@
 # 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
-# =============================================================================== 
+# =========================================================================== 
 #++
 #
-# To create the documentation for Rio run the command
-#  ruby build_doc.rb
-# from the distribution directory.
-#
-# Suggested Reading
-# * RIO::Doc::SYNOPSIS
-# * RIO::Doc::INTRO
-# * RIO::Doc::HOWTO
-# * RIO::Doc::EXAMPLES
-# * RIO::Rio
-#
-
-
 module RIO
   module IF
     module CSV
@@ -41,9 +28,9 @@ module RIO
       #def dir() target.dir end
       
       # Puts a Rio in CSV mode and sets the field and record separators.
-      # In csv mode selecting with IF::GrandeStream#records will cause each line
+      # In csv mode selecting with {#records}[rdoc-ref:IF::GrandeStream#records] will cause each line
       # read to be parsed into a line with the CSV standard library.
-      # Specifying using IF::GrandeStream#lines to select will return unparsed strings
+      # Specifying using {#lines}[rdoc-ref:IF::GrandeStream#lines] to select will return unparsed strings
       # as normal.
       #
       #  # copy a csv file, changing the field separator
@@ -63,8 +50,8 @@ module RIO
       #  rio("afile.csv").csv.columns(5..7).skiplines[0]
       #
       # See RIO::Doc::INTRO for complete documentation on csv mode.
-      def csv(field_separator=',',record_separator=nil,&block) 
-        target.csv(field_separator,record_separator,&block); 
+      def csv(*csv_args,&block) 
+        target.csv(*csv_args,&block); 
         self 
       end
       # Select columns from a CSV file. See #csv and RIO::Doc::INTRO.

data/lib/rio/if/dir.rb

@@ -1,6 +1,7 @@
+# -*- coding: utf-8 -*-
 #--
-# =============================================================================== 
-# Copyright (c) 2005,2006,2007,2008 Christopher Kleckner
+# ===========================================================================
+# Copyright (c) 2005-2012 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -18,22 +19,9 @@
 # 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
-# =============================================================================== 
+# =========================================================================== 
 #++
 #
-# To create the documentation for Rio run the command
-#  ruby build_doc.rb
-# from the distribution directory.
-#
-# Suggested Reading
-# * RIO::Doc::SYNOPSIS
-# * RIO::Doc::INTRO
-# * RIO::Doc::HOWTO
-# * RIO::Doc::EXAMPLES
-# * RIO::Rio
-#
-
-
 module RIO
   module IF
     module Dir
@@ -63,7 +51,7 @@ module RIO
       #
       # Uses ::Find#find to find all entries recursively for a Rio that 
       # specifies a directory. Note that there are other ways to recurse through
-      # a directory structure using a Rio. See IF::Grande#each and IF::GrandeEntry#all.
+      # a directory structure using a Rio. See {#each}[rdoc-ref:IF::Grande#each] and {#all}[rdoc-ref:IF::GrandeEntry#all].
       #
       # Calls the block passing a Rio for each entry found. The Rio inherits
       # file attrubutes from the directory Rio.
@@ -85,7 +73,7 @@ module RIO
       # Returns the filenames found by expanding the pattern given in string, 
       # either as an array or as parameters to the block. In both cases the filenames
       # are expressed as a Rio.
-      # Note that this pattern is not a regexp (it�s closer to a shell glob). 
+      # Note that this pattern is not a regexp (it�s closer to a shell glob). 
       # See File::fnmatch for details of file name matching and the meaning of the flags parameter.
       #
       #
@@ -95,10 +83,10 @@ module RIO
       # Calls ::Dir#rmdir
       #
       # Deletes the directory referenced by the Rio. 
-      # Raises a subclass of SystemCallError if the directory isn�t empty.
+      # Raises a subclass of SystemCallError if the directory isn�t empty.
       # Returns the Rio. If the directory does not exist, just returns the Rio.
       #
-      # See also #rmtree, IF::Grande#delete, IF::Grande#delete!
+      # See also #rmtree, {#delete}[rdoc-ref:IF::Grande#delete], {#delete!}[rdoc-ref:IF::Grande#delete!]
       #
       #    rio('adir').rmdir # remove the empty directory 'adir'
       #
@@ -112,7 +100,7 @@ module RIO
       #
       # If called with a block, behaves as if <tt>rmtree.each(&block)</tt> had been called
       # 
-      # See also IF::Grande#delete!
+      # See also {#delete!}[rdoc-ref:IF::Grande#delete!]
       #
       #  rio('adir').rmtree # removes the directory 'adir' recursively
       #

data/lib/rio/if/file.rb

@@ -1,6 +1,6 @@
 #--
-# =============================================================================== 
-# Copyright (c) 2005,2006,2007,2008 Christopher Kleckner
+# ===========================================================================
+# Copyright (c) 2005-2012 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -18,22 +18,9 @@
 # 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
-# =============================================================================== 
+# =========================================================================== 
 #++
 #
-# To create the documentation for Rio run the command
-#  ruby build_doc.rb
-# from the distribution directory.
-#
-# Suggested Reading
-# * RIO::Doc::SYNOPSIS
-# * RIO::Doc::INTRO
-# * RIO::Doc::HOWTO
-# * RIO::Doc::EXAMPLES
-# * RIO::Rio
-#
-
-
 module RIO
   module IF
     module File
@@ -42,7 +29,7 @@ module RIO
       #
       # Deletes the referenced file, returning the Rio. Raises an exception on any error. 
       #
-      # See also IF::Grande#delete, IF::Grande#delete!, IF::Dir#rmdir.
+      # See also {#delete}[rdoc-ref:IF::Grande#delete], {#delete!}[rdoc-ref:IF::Grande#delete!], {#rmdir}[rdoc-ref:IF::Dir#rmdir].
       def rm() target.rm(); self end
       
       
@@ -65,7 +52,7 @@ module RIO
       #  f.size()                   #=> 5
       #
       # If called with no arguments, truncates the Rio at the
-      # value returned by IF::FileOrDir#pos().
+      # value returned by {#pos}[rdoc-ref:IF::FileOrDir#pos]().
       #  f.read(2)
       #  f.truncate.size            #=> 2
       #  f.contents                 #=> "12"
@@ -74,7 +61,7 @@ module RIO
       #
       def truncate(sz=pos()) target.truncate(sz); self end
       
-      # Calls IF::File#truncate(0)
+      # Calls {#truncate}[rdoc-ref:IF::File#truncate](0)
       #
       def clear() target.clear(); self end
 

data/lib/rio/if/fileordir.rb

@@ -1,6 +1,6 @@
 #--
-# =============================================================================== 
-# Copyright (c) 2005,2006,2007,2008 Christopher Kleckner
+# ===========================================================================
+# Copyright (c) 2005-2012 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -18,22 +18,9 @@
 # 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
-# =============================================================================== 
+# =========================================================================== 
 #++
 #
-# To create the documentation for Rio run the command
-#  ruby build_doc.rb
-# from the distribution directory.
-#
-# Suggested Reading
-# * RIO::Doc::SYNOPSIS
-# * RIO::Doc::INTRO
-# * RIO::Doc::HOWTO
-# * RIO::Doc::EXAMPLES
-# * RIO::Rio
-#
-
-
 module RIO
   module IF
     module FileOrDir
@@ -41,18 +28,18 @@ module RIO
       # undocumented
       def open(m,*args,&block) target.open(m,*args,&block); self end
 
-      # Creates a symbolic link _dest_ which points to the Rio's IF::Path#fspath.  
+      # Creates a symbolic link _dest_ which points to the Rio's {#fspath}[rdoc-ref:IF::Path#fspath].  
       # Raises a NotImplementedError exception on platforms that do not support symbolic links.
       # _dest_ may be a Rio, a String, or anything that will create an appropriate Rio 
       # when passed to Rio#new .
       # If _dest_ already exists and is a directory, creates a symbolic link in the _dest_ directory,
-      # named with the name returned by IF::Path#filename.
+      # named with the name returned by {#filename}[rdoc-ref:IF::Path#filename].
       # If _dest_ already exists and it is not a directory, raises Errno::EEXIST.
       # 
       # Returns the Rio (not the symlink).
       #
-      # IF::FileOrDir#symlink differs from File#symlink when the Rio or the _dest_ path has directory information.
-      # In this case IF::FileOrDir#symlink creates a symlink that actually refers to the Rio's location 
+      # {#symlink}[rdoc-ref:IF::FileOrDir#symlink] differs from File#symlink when the Rio or the _dest_ path has directory information.
+      # In this case {#symlink}[rdoc-ref:IF::FileOrDir#symlink] creates a symlink that actually refers to the Rio's location 
       # from the perspective of the link's location.
       #
       # For example: Given an existing file 'adir/afile' and a _dest_ of 'adir/alink'
@@ -90,8 +77,8 @@ module RIO
       #                           # the old path
       # ===== Rename Mode
       #
-      # In rename mode, changes to a Rio's path using IF::Path#dirname=, IF::Path#filename=, 
-      # IF::Path#basename=, and IF::Path#extname= also cause the object on the filesystem
+      # In rename mode, changes to a Rio's path using {#dirname=}[rdoc-ref:IF::Path#dirname=], {#filename=}[rdoc-ref:IF::Path#filename=], 
+      # {#basename=}[rdoc-ref:IF::Path#basename=], and {#extname=}[rdoc-ref:IF::Path#extname=] also cause the object on the filesystem
       # to be renamed.
       #
       # Change the extension of all'.cpp' files in 'adir' to '.cxx'
@@ -104,12 +91,12 @@ module RIO
       #    gzfile.ext('.tar.gz').ext = '.tgz'
       #  end
       #
-      # See IF::Path#dirname=, IF::Path#filename=, IF::Path#basename=, and IF::Path#extname=
+      # See {#dirname=}[rdoc-ref:IF::Path#dirname=], {#filename=}[rdoc-ref:IF::Path#filename=], {#basename=}[rdoc-ref:IF::Path#basename=], and {#extname=}[rdoc-ref:IF::Path#extname=]
       #
       def rename(*args,&block) target.rename(*args,&block); self end
       
 
-      # Behaves like IF::FileOrDir#rename, but also changes the calling Rio to 
+      # Behaves like {#rename}[rdoc-ref:IF::FileOrDir#rename], but also changes the calling Rio to 
       # refer to the renamed path
       def rename!(*args,&block) target.rename!(*args,&block); self end
       
@@ -188,7 +175,7 @@ module RIO
       # For directories calls Dir#seek
       #     ario.seek( integer ) => ario
       # Seeks to a particular location in _ario_. _integer_ must be a value
-      # returned by IF::FileOrDir#tell.
+      # returned by {#tell}[rdoc-ref:IF::FileOrDir#tell].
       #
       #  d = rio("testdir")       #=> #<RIO::Rio:0x401b3c40>
       #  d.read                   #=> rio(".")
@@ -217,7 +204,7 @@ module RIO
       # For directories calls Dir#pos
       #     ario.pos => integer
       #     ario.tell => integer
-      # Returns the current position in _dir_. See also IF::FileOrDir#seek.
+      # Returns the current position in _dir_. See also {#seek}[rdoc-ref:IF::FileOrDir#seek].
       #
       #     d = rio("testdir")
       #     d.pos   #=> 0
@@ -226,7 +213,7 @@ module RIO
       #
       def pos() target.pos end
 
-      # See IF::FileOrDir#pos
+      # See {#pos}[rdoc-ref:IF::FileOrDir#pos]
       def tell() target.tell end
 
       # For directories calls Dir#pos=, otherwise calls IO#pos=
@@ -241,8 +228,10 @@ module RIO
       #
       # For directories calls Dir#pos=
       #     ario.pos = integer     => integer
-      #------------------------------------------------------------------------
-      # Synonym for +IF::FileOrDir#seek+, but returns the position parameter.
+      #
+      # ---
+      #
+      # Synonym for {#seek}[rdoc-ref:IF::FileOrDir#seek], but returns the position parameter.
       #
       #        d = rio("testdir")       #=> d
       #        d.read                   #=> rio(".")

data/lib/rio/if/grande.rb

@@ -1,6 +1,6 @@
 #--
-# =============================================================================== 
-# Copyright (c) 2005,2006,2007,2008 Christopher Kleckner
+# ===========================================================================
+# Copyright (c) 2005-2012 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -18,20 +18,9 @@
 # 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
-# =============================================================================== 
+# =========================================================================== 
 #++
 #
-# To create the documentation for Rio run the command
-#  ruby build_doc.rb
-# from the distribution directory.
-#
-# Suggested Reading
-# * RIO::Doc::SYNOPSIS
-# * RIO::Doc::INTRO
-# * RIO::Doc::HOWTO
-# * RIO::Doc::EXAMPLES
-# * RIO::Rio
-#
 
 require 'rio/no_warn'
 module RIO
@@ -40,7 +29,7 @@ module RIO
 
       # Returns the contents of the rio as an array. (See ::Enumerable#to_a)
       #
-      # IF::Grande#to_a is implemented in terms of #each so the the following are roughly equivelent
+      # {#to_a}[rdoc-ref:IF::Grande#to_a] is implemented in terms of #each so the the following are roughly equivelent
       #
       #  ary = ario.to_a
       #
@@ -49,9 +38,9 @@ module RIO
       #    ary << ary
       #  end
       #
-      # What constitutes an array element is determined by IF::GrandeStream#lines, 
-      # IF::GrandeStream#bytes, IF::GrandeStream#records, IF::GrandeStream#rows or 
-      # by an extension such as IF::CSV#csv. IF::GrandeStream#lines is the default.
+      # What constitutes an array element is determined by {#lines}[rdoc-ref:IF::GrandeStream#lines], 
+      # {#bytes}[rdoc-ref:IF::GrandeStream#bytes], {#records}[rdoc-ref:IF::GrandeStream#records], {#rows}[rdoc-ref:IF::GrandeStream#rows] or 
+      # by an extension such as {#csv}[rdoc-ref:IF::CSV#csv]. {#lines}[rdoc-ref:IF::GrandeStream#lines] is the default.
       #
       #  rio('afile.txt').to_a # returns an array of the lines in afile.txt
       #
@@ -60,11 +49,11 @@ module RIO
       #  rio('afile.dat').bytes(50).to_a # an array containing the contents of afile.dat broken 
       #                                  # up into 50 byte chunks
       #
-      # See also IF::Grande#[] (subscript operator)
+      # See also {#[]}[link:RIO/IF/Grande.html#method-i-5B-5D] (subscript operator)
       #
       def to_a() target.to_a() end
 
-      # Grande subscript operator. 
+      # \Grande subscript operator. 
       # 
       # For files this returns all or part of a file as an array.
       #
@@ -72,13 +61,13 @@ module RIO
       #
       # === Files
       #
-      # This combines the record selection offered by IF::GrandeStream#records with
-      # the conversion to an array provided by IF::Grande#to_a. The following two are equivelant:
+      # This combines the record selection offered by {#records}[rdoc-ref:IF::GrandeStream#records] with
+      # the conversion to an array provided by {#to_a}[rdoc-ref:IF::Grande#to_a]. The following two are equivelant:
       #  ario[*args]
       #  ario.records(*args).to_a
       #
-      # What constitutes an array element is determined by IF::GrandeStream#lines, IF::GrandeStream#bytes, 
-      # or by an extension such as IF::CSV#csv. IF::GrandeStream#lines is the default.
+      # What constitutes an array element is determined by {#lines}[rdoc-ref:IF::GrandeStream#lines], {#bytes}[rdoc-ref:IF::GrandeStream#bytes], 
+      # or by an extension such as {#csv}[rdoc-ref:IF::CSV#csv]. {#lines}[rdoc-ref:IF::GrandeStream#lines] is the default.
       # 
       # Arguments may consist of zero or more integers, ranges, regular expressions, symbols,
       # procs, and arrays
@@ -97,7 +86,7 @@ module RIO
       # 
       # A record matching *any* of the selectors will be included in the array. (acts like an _or_)
       #
-      # Because this is implemented in terms of the IF::Grande#each, 
+      # Because this is implemented in terms of the {#each}[rdoc-ref:IF::Grande#each], 
       # When only record ranges are used to select records,
       # iteration will stop when the recno exceeds the maximum of any range. That is to say
       #
@@ -108,8 +97,8 @@ module RIO
       # 
       # === Directories
       # 
-      # This combines the entry selection offered by IF::GrandeEntry#entries with
-      # the conversion to an array provided by IF::Grande#to_a. The following two are equivelant:
+      # This combines the entry selection offered by {#entries}[rdoc-ref:IF::GrandeEntry#entries] with
+      # the conversion to an array provided by {#to_a}[rdoc-ref:IF::Grande#to_a]. The following two are equivelant:
       #  ario[*args]
       #  ario.entries(*args).to_a
       #
@@ -117,34 +106,34 @@ module RIO
       # An empty argument list selects all entries
       # See ::Dir#glob and ::File::fnmatch? for more in information on _globs_. 
       # Be warned that using the '**' glob
-      # recurses into directories independently of IF::GrandeEntry#all and using both is unsupported.
+      # recurses into directories independently of {#all}[rdoc-ref:IF::GrandeEntry#all] and using both is unsupported.
       # 
       #  ario = rio('adir')
       #  ario[] # returns an array containg all entries in _adir_
       #  ario[/^zippy/] # all entries starting with 'zippy'
       #  ario['zippy*'] # same thing
       #
-      # As with IF::Grande#each:
-      # * Files and directories are returned as Rios
-      # * The types of entries is also affected by IF::GrandeEntry#files and IF::GrandeEntry#dirs.
+      # As with {#each}[rdoc-ref:IF::Grande#each]:
+      # * Files and directories are returned as \Rios
+      # * The types of entries is also affected by {#files}[rdoc-ref:IF::GrandeEntry#files] and {#dirs}[rdoc-ref:IF::GrandeEntry#dirs].
       #    rio('adir').files['*.txt'] # array of all .txt files
       #    rio('adir').dirs[/^\./] # array of all dot directories
-      # * Recursion is enabled using IF::GrandeEntry#all
+      # * Recursion is enabled using {#all}[rdoc-ref:IF::GrandeEntry#all]
       #    rio('adir').all.files['*.[ch]'] # array of c source files in adir and its subdirecories
       #    rio('adir').all.dirs[/^\.svn/]  # array of subversion directories in adir and subdirectories
-      # * IF::GrandeEntry#files and IF::GrandeEntry#dirs act independently of each other. 
+      # * {#files}[rdoc-ref:IF::GrandeEntry#files] and {#dirs}[rdoc-ref:IF::GrandeEntry#dirs] act independently of each other. 
       #   Specifying both will cause both to be returned. 
-      #   The argument list to IF::Grande#[] will be applied to the closest.
+      #   The argument list to {#[]}[link:RIO/IF/Grande.html#method-i-5B-5D] will be applied to the closest.
       #    rio('adir').files('*.rb').dirs['ruby*'] # array of .rb files and 
       #                                            # directories starting with 'ruby'
       #    rio('adir').dirs('ruby*').files['*.rb'] # same thing
       #
       # === Lines
-      # This section applies similarly to IF::GrandeStream#lines, IF::GrandeStream#bytes, 
-      # IF::GrandeStream#records, and IF::GrandeStream#rows
+      # This section applies similarly to {#lines}[rdoc-ref:IF::GrandeStream#lines], {#bytes}[rdoc-ref:IF::GrandeStream#bytes], 
+      # {#records}[rdoc-ref:IF::GrandeStream#records], and {#rows}[rdoc-ref:IF::GrandeStream#rows]
       #
-      # Using IF::GrandeStream#lines and related methods with a Rio referencing a directory 
-      # imples IF::GrandeEntry#files and will cause an array of the lines or bytes in the 
+      # Using {#lines}[rdoc-ref:IF::GrandeStream#lines] and related methods with a \Rio referencing a directory 
+      # imples {#files}[rdoc-ref:IF::GrandeEntry#files] and will cause an array of the lines or bytes in the 
       # files to be returned. As above,
       # the arguments to the subscript operator will be applied to the closest.
       #  rio('adir').lines[] # array of all lines in the files in 'adir'
@@ -155,7 +144,7 @@ module RIO
       #                                                     # 'adir and its subdirectories
       #
       # Note the difference between the following similar usages
-      #  it1 = rio('adir').files('*.rb') # returns a Rio, prepared for selecting ruby files
+      #  it1 = rio('adir').files('*.rb') # returns a \Rio, prepared for selecting ruby files
       #  it2 = rio('adir').files['*.rb'] # returns an array of the ruby files
       #
       # The second example above could have been written
@@ -203,25 +192,25 @@ module RIO
 
 
 
-      # Iterate through a rio. Executes the block for each item selected for the Rio. 
-      # See IF::GrandeStream#lines, IF::GrandeStream#records, IF::GrandeStream#bytes, 
-      # IF::GrandeEntry#files, IF::GrandeEntry#dirs, IF::Grande#[] 
-      # and IF::Grande#to_a for more information
+      # Iterate through a rio. Executes the block for each item selected for the \Rio. 
+      # See {#lines}[rdoc-ref:IF::GrandeStream#lines], {#records}[rdoc-ref:IF::GrandeStream#records], {#bytes}[rdoc-ref:IF::GrandeStream#bytes], 
+      # {#files}[rdoc-ref:IF::GrandeEntry#files], {#dirs}[rdoc-ref:IF::GrandeEntry#dirs], {#[]}[link:RIO/IF/Grande.html#method-i-5B-5D] 
+      # and {#to_a}[rdoc-ref:IF::Grande#to_a] for more information
       # on how records are selected and what kind of record is passed to the block.
       # 
-      # IF::Grande#each is the fundemental method for all the Rio grande operators.
-      # IF::Grande#to_a and the Rio copy operators 
-      # IF::Grande#<, IF::Grande#<<, IF::Grande#>>, and IF::Grande#> 
-      # are all implemented in terms of IF::Grande#each.
+      # {#each}[rdoc-ref:IF::Grande#each] is the fundemental method for all the \Rio grande operators.
+      # {#to_a}[rdoc-ref:IF::Grande#to_a] and the \Rio copy operators 
+      # {#<}[link:RIO/IF/Grande.html#method-i-3C], {#<<}[link:RIO/IF/Grande.html#method-i-3C-3C], {#>>}[link:RIO/IF/Grande.html#method-i-3E-3E], and {#>}[link:RIO/IF/Grande.html#method-i-3E] 
+      # are all implemented in terms of {#each}[rdoc-ref:IF::Grande#each].
       #
-      # While IF::Grande#each is fundamental to a Rio, it rarely needs 
+      # While {#each}[rdoc-ref:IF::Grande#each] is fundamental to a \Rio, it rarely needs 
       # actually be called because all the grande configuration methods will also take a block 
-      # and call IF::Grande#each if one is given. 
+      # and call {#each}[rdoc-ref:IF::Grande#each] if one is given. 
       # So the existance of a block after many methods is taken as an implied
-      # IF::Grande#each
+      # {#each}[rdoc-ref:IF::Grande#each]
       #
-      # For Rios that refer to files, the item passed to the block is a String containing
-      # the line or block as selected by IF::GrandeStream#lines, or IF::GrandeStream#bytes. 
+      # For \Rios that refer to files, the item passed to the block is a String containing
+      # the line or block as selected by {#lines}[rdoc-ref:IF::GrandeStream#lines], or {#bytes}[rdoc-ref:IF::GrandeStream#bytes]. 
       # +lines+ is the default.
       #  rio('afile').lines.each { |line| ...}
       # 
@@ -246,14 +235,14 @@ module RIO
       #  1 is spelled 'one'
       #
       # 
-      # For Rios that refer to directories, the item passed to the block is a Rio refering to
+      # For \Rios that refer to directories, the item passed to the block is a \Rio refering to
       # the directory entry. 
       #
       #  rio('adir').files.each do |file|
       #    file.kind_of?(RIO::Rio)  # true
       #  end
       # 
-      # In addition, the Rio passed to the block inherits certain attributes from the directory Rio.
+      # In addition, the \Rio passed to the block inherits certain attributes from the directory \Rio.
       #
       #  rio('adir').files.chomp.each do |file| # chomp is ignored for directories,
       #    file.each do |line|                  # chomp attribute is inherited by the file rio
@@ -261,7 +250,7 @@ module RIO
       #    end
       #  end
       #
-      # IF::Grande#each returns the Rio which called it.
+      # {#each}[rdoc-ref:IF::Grande#each] returns the \Rio which called it.
       #
       # Here are a few illustrative examples
       # 
@@ -319,9 +308,9 @@ module RIO
       def each(*args,&block) target.each(*args,&block); self end
 
 
-      # For a file Rio +delete+ calls FileUtils#rm. 
-      # For a directory Rio +delete+ calls FileUtils#rmdir
-      # Returns the Rio. If the Rio does not exist, simply return the Rio.
+      # For a file \Rio +delete+ calls FileUtils#rm. 
+      # For a directory \Rio +delete+ calls FileUtils#rmdir
+      # Returns the \Rio. If the \Rio does not exist, simply return the \Rio.
       #
       #  rio('afile,txt').delete # delete 'afile.txt'
       #  rio('adir').delete # delete adir
@@ -329,12 +318,12 @@ module RIO
       #
       def delete() target.delete(); self end
 
-      # See IF::Grande#delete
+      # See {#delete}[rdoc-ref:IF::Grande#delete]
       def unlink() target.unlink(); self end
 
-      # For a file IF::Grande#delete! calls FileUtils#rm. 
-      # For a directory IF::Grande#delete! calls FileUtils#rmtree.
-      # Returns the Rio. If the rio does not exist, simply returns itself.
+      # For a file {#delete!}[rdoc-ref:IF::Grande#delete!] calls FileUtils#rm. 
+      # For a directory {#delete!}[rdoc-ref:IF::Grande#delete!] calls FileUtils#rmtree.
+      # Returns the \Rio. If the rio does not exist, simply returns itself.
       #
       #  rio('afile,txt').delete! # delete f.txt
       #  rio('adir').delete! # delete adir
@@ -343,23 +332,23 @@ module RIO
       #  rio('adir/asubdir').delete!.mkpath 
       #
       # ==== Deleting Summary
-      # * To delete something only if it is not a directory use IF::File#rm
-      # * To delete an empty directory use IF::Dir#rmdir
-      # * To delete an entire directory tree use IF::Dir#rmtree
-      # * To delete anything except a populated directory use IF::Grande#delete
-      # * To delete anything use IF::Grande#delete!
+      # * To delete something only if it is not a directory use {#rm}[rdoc-ref:IF::File#rm]
+      # * To delete an empty directory use {#rmdir}[rdoc-ref:IF::Dir#rmdir]
+      # * To delete an entire directory tree use {#rmtree}[rdoc-ref:IF::Dir#rmtree]
+      # * To delete anything except a populated directory use {#delete}[rdoc-ref:IF::Grande#delete]
+      # * To delete anything use {#delete!}[rdoc-ref:IF::Grande#delete!]
       #
       # In all cases, deleting something that does not exist is considered successful.
       #
       def delete!() target.delete!(); self end
 
-      # Grande Copy-To Operator
+      # \Grande Copy-To Operator
       # 
-      # The copy grande-operator copies a Rio to a another Rio or another ruby object. The behaviour 
+      # The copy grande-operator copies a \Rio to a another \Rio or another ruby object. The behaviour 
       # and the library used depend on the types of the of the source and destination. For
       # simple file or directory copying ::FileUtils#cp or ::FileUtils#cp_r will be used. If
-      # any of the Rio grande methods are specified for the source or destination, the
-      # source Rio will be iterated through copying records to the destintion as specified. Roughly
+      # any of the \Rio grande methods are specified for the source or destination, the
+      # source \Rio will be iterated through copying records to the destintion as specified. Roughly
       # equivelant to
       #  dst = rio('dst_file')
       #  rio('src_file').each do |line|
@@ -368,9 +357,9 @@ module RIO
       #  dst.close
       #
       # The destination of the copy operators may be a:
-      # IO::      Each record of the Rio is written to the IO using IO#print. The IO must be opened for writing.
-      # Array::   Each record or entry of the Rio becomes an element of the array
-      # String::  Puts the entire contents of the Rio into the string
+      # IO::      Each record of the \Rio is written to the IO using IO#print. The IO must be opened for writing.
+      # Array::   Each record or entry of the \Rio becomes an element of the array
+      # String::  Puts the entire contents of the \Rio into the string
       # Rio::     Depends on the destination. See below.
       #
       # Copy a file to a file
@@ -396,7 +385,7 @@ module RIO
       #
       #  rio('afile').skiplines(0..9) > ary # ary will contain all but the first ten lines of the file
       #
-      #  rio('adir') > ary # ary will contain a Rio for each entry in the directory
+      #  rio('adir') > ary # ary will contain a \Rio for each entry in the directory
       #  rio('adir').files > ary # same, but only files
       #  rio('adir').files('*.rb') >ary # same, but only .rb files
       # 
@@ -404,7 +393,7 @@ module RIO
       #  rio('afile') > astring # slurp the entire contents of the file into astring
       #  astring = rio('afile').contents # same effect
       #
-      # Copy the first line *and* every line containing the word Rio into a gzipped file
+      # Copy the first line *and* every line containing the word \Rio into a gzipped file
       #  rio('src').lines(1,/Rio/) > rio('dst.gz').gzip
       #
       # Copy lines of a web page into an array with each line chomped
@@ -414,7 +403,7 @@ module RIO
       # file on a web site into a local gzipped csv file that uses semi-colons as separators
       #  rio('http://host/file.csv.gz').columns(0,7..9).gzip.csv[0..9] > rio('localfile.csv.gz').csv(';').gzip
       #
-      # See also IF::Grande#>>, IF::Grande#|
+      # See also {#>>}[link:RIO/IF/Grande.html#method-i-3E-3E], {#|}[link:RIO/IF/Grande.html#method-i-7C]
       #
       def >(destination) 
         RIO::no_warn {
@@ -423,23 +412,23 @@ module RIO
         self 
       end
 
-      # Alias for IF::Grande#> (copy-to grande operator)
+      # Alias for {#>}[link:RIO/IF/Grande.html#method-i-3E] (copy-to grande operator)
       def copy_to(destination) target.copy_to(destination); self end
 
 
-      # Grande Pipe Operator
+      # \Grande Pipe Operator
       # 
-      # The Rio pipe operator is actually an alternative syntax for calling the IF::Grande#> (copy-to) 
+      # The \Rio pipe operator is actually an alternative syntax for calling the {#>}[link:RIO/IF/Grande.html#method-i-3E] (copy-to) 
       # operator, designed to 
       # allow several copy operation to be performed in one line of code, with behavior that mimics
       # the pipe operator commonly available in shells.
       #
-      # If +destination+ is a +cmdio+, a <tt>cmdpipe</tt> Rio is returned, and none of the commands are run.
+      # If +destination+ is a +cmdio+, a <tt>cmdpipe</tt> \Rio is returned, and none of the commands are run.
       #
-      # Otherwise the +cmdpipe+ Rio is run with the output of the pipe being copied to the destination.
-      # In this case a Rio representing the +destination+ is returned.
+      # Otherwise the +cmdpipe+ \Rio is run with the output of the pipe being copied to the destination.
+      # In this case a \Rio representing the +destination+ is returned.
       # 
-      # If destination is not a Rio it is passed to the Rio constructor as is done with the copy-to operator
+      # If destination is not a \Rio it is passed to the \Rio constructor as is done with the copy-to operator
       # except that if +destination+ is a String it is assumed to be a command instead of a path.
       #
       #  rio('afile') | rio(?-,'grep i') | rio(?-) # returns rio(?-)
@@ -465,26 +454,26 @@ module RIO
       #  acmdpipe2 = rio('afile') | 'acmd' | 'acmd2'
       #  acmdpipe2 | rio('outfile') # same thing
       #
-      # The grande pipe operator can not be used to create a +cmdpipe+ Rio that includes a destination.
-      # This must be done using a Rio constructor
+      # The grande pipe operator can not be used to create a +cmdpipe+ \Rio that includes a destination.
+      # This must be done using a \Rio constructor
       #  cmd_with_output = rio(?|,'acmd',rio('outfile'))
       #  rio('afile') | cmd_with_output # same as above
       #
       def |(destination) target | destination end
 
-      # Grande Append-To Operator
+      # \Grande Append-To Operator
       # 
-      # The append-to grande-operator is the same as IF::Grande#> (copy-to) except that it opens the destination
+      # The append-to grande-operator is the same as {#>}[link:RIO/IF/Grande.html#method-i-3E] (copy-to) except that it opens the destination
       # for append.
       # The destination can be a kind of:
-      # IO::     Each record of the Rio is written to the IO using IO#print. The IO must be opened for writing.
-      # Array::  Each record or entry of the Rio is appended to the destination array
-      # String:: Appends the entire contents of the Rio to destination
-      # Rio::    Just like IF::Grande#> (copy-to) except the unopened object are 
+      # IO::     Each record of the \Rio is written to the IO using IO#print. The IO must be opened for writing.
+      # Array::  Each record or entry of the \Rio is appended to the destination array
+      # String:: Appends the entire contents of the \Rio to destination
+      # Rio::    Just like {#>}[link:RIO/IF/Grande.html#method-i-3E] (copy-to) except the unopened object are 
       #          opened for append. If the destination is already opened for writing or is a 
-      #          directory, this is identical to IF::Grande#> (copy-to) 
+      #          directory, this is identical to {#>}[link:RIO/IF/Grande.html#method-i-3E] (copy-to) 
       #
-      # See IF::Grande#> (copy-to)
+      # See {#>}[link:RIO/IF/Grande.html#method-i-3E] (copy-to)
       # 
       #  rio('afile') >> rio('anotherfile') # append the contents of 'afile' to 'anotherfile'
       #  rio('afile') >> rio('adir') # copies 'afile' to the directory 'adir'
@@ -493,32 +482,32 @@ module RIO
       def >>(destination) target >> destination; self end
 
       
-      # Alias for IF::Grande#>> (append-to grande operator)
+      # Alias for {#>>}[link:RIO/IF/Grande.html#method-i-3E-3E] (append-to grande operator)
       def append_to(destination) target.append_to(destination); self end
 
 
-      # Grande Append-From Operator
+      # \Grande Append-From Operator
       # 
-      # The append-from grande-operator copies a Rio from another Rio or another ruby object. This
-      # behaves like IF::Grande#< (copy-from) except unopened Rios are opened for append.
+      # The append-from grande-operator copies a \Rio from another \Rio or another ruby object. This
+      # behaves like {#<}[link:RIO/IF/Grande.html#method-i-3C] (copy-from) except unopened \Rios are opened for append.
       #
       # The following summarizes how objects are copied:
-      # IO::       IO#each is used to iterate through the source with each record appended to the Rio
-      # Array::    Each element of the Array is appended individually to the Rio.
-      # String::   The string is appended to the Rio using IF::RubyIO#print
-      # Rio::      The source Rio is appended using its IF::Grande#>> (append-to) operator
+      # IO::       IO#each is used to iterate through the source with each record appended to the \Rio
+      # Array::    Each element of the Array is appended individually to the \Rio.
+      # String::   The string is appended to the \Rio using {#print}[rdoc-ref:IF::RubyIO#print]
+      # Rio::      The source \Rio is appended using its {#>>}[link:RIO/IF/Grande.html#method-i-3E-3E] (append-to) operator
       # 
-      # See IF::Grande#< (copy-from)
+      # See {#<}[link:RIO/IF/Grande.html#method-i-3C] (copy-from)
       def <<(source) target << source; self end
 
 
-      # Alias for IF::Grande#<< (append-from grande operator)
+      # Alias for {#<<}[link:RIO/IF/Grande.html#method-i-3C-3C] (append-from grande operator)
       def append_from(source) target.append_from(source); self end
 
 
-      # Grande Copy-From Operator
+      # \Grande Copy-From Operator
       # 
-      # The copy-from grande-operator copies a Rio from another Rio or another ruby object. 
+      # The copy-from grande-operator copies a \Rio from another \Rio or another ruby object. 
       # Its operation is dependent on the the file system objects referenced, the rio
       # options set, and the state of its source and destination. In the broadest of terms
       # it could be described as doing the following:
@@ -577,7 +566,7 @@ module RIO
       #      else dest << rio(el)
       #    end
       #
-      # To improve run-time efficiency, Rio will choose from among several strategies when
+      # To improve run-time efficiency, \Rio will choose from among several strategies when
       # copying. For instance when no file or directory filtering is specified, FileUtils#cp_r is
       # used to copy directories; and when no line filtering is specified, FileUtils#cp is used to copy
       # files.
@@ -598,7 +587,7 @@ module RIO
       #  rio('skeldir') < rio('adir').dirs # copy only the directory structure
       #  rio('destdir') < rio('adir').dirs.files(/^\./) # copy the directory structure and all dot files
       #  
-      # See also IF::Grande#> (copy-to), IF::Grande#each, IF::Grande#[]
+      # See also {#>}[link:RIO/IF/Grande.html#method-i-3E] (copy-to), {#each}[rdoc-ref:IF::Grande#each], {#[]}[link:RIO/IF/Grande.html#method-i-5B-5D]
       #
       def <(source) 
         RIO::no_warn {
@@ -607,16 +596,16 @@ module RIO
         self 
       end
 
-      # Alias for IF::Grande#< (copy-from grande operator)
+      # Alias for {#<}[link:RIO/IF/Grande.html#method-i-3C] (copy-from grande operator)
       def copy_from(source) target.copy_from(source); self end
 
 
-      # Reads and returns the next record or entry from a Rio, 
+      # Reads and returns the next record or entry from a \Rio, 
       # honoring the grande selection methods. 
       #
       # Returns nil on end of file.
       #
-      # See also IF::GrandeStream#records, IF::GrandeStream#lines, IF::Grande#each, IF::Grande#[]
+      # See also {#records}[rdoc-ref:IF::GrandeStream#records], {#lines}[rdoc-ref:IF::GrandeStream#lines], {#each}[rdoc-ref:IF::Grande#each], {#[]}[link:RIO/IF/Grande.html#method-i-5B-5D]
       #
       #  ario = rio('afile').lines(10..12)
       #  line10 = ario.get 
@@ -630,7 +619,7 @@ module RIO
       #
       def get() target.get() end
 
-      # Grande Exclude method
+      # \Grande Exclude method
       # 
       # +skip+ can be used in two ways.
       #
@@ -652,8 +641,8 @@ module RIO
       #
       # ==== skip with arguments
       #
-      # When called with arguments it acts like IF::GrandeEntry#skipentries for directory 
-      # Rios and like IF::GrandeStream#skiprecords for stream Rios.
+      # When called with arguments it acts like {#skipentries}[rdoc-ref:IF::GrandeEntry#skipentries] for directory 
+      # \Rios and like {#skiprecords}[rdoc-ref:IF::GrandeStream#skiprecords] for stream \Rios.
       #
       #  rio('afile').lines(/Rio/).skip[0..4] # lines containg 'Rio' excluding the
       #                                       # first five lines
@@ -663,10 +652,10 @@ module RIO
       #
       # If a block is given, behaves as if <tt>skip(*args).each(&block)</tt> had been called.
       #
-      # Returns the Rio.
+      # Returns the \Rio.
       #
-      # See IF::GrandeStream#skiplines, IF::GrandeStream#skiprecords, IF::GrandeStream#skiprows, 
-      # IF::GrandeEntry#skipfiles, IF::GrandeEntry#skipdirs, and IF::GrandeEntry#skipentries.
+      # See {#skiplines}[rdoc-ref:IF::GrandeStream#skiplines], {#skiprecords}[rdoc-ref:IF::GrandeStream#skiprecords], {#skiprows}[rdoc-ref:IF::GrandeStream#skiprows], 
+      # {#skipfiles}[rdoc-ref:IF::GrandeEntry#skipfiles], {#skipdirs}[rdoc-ref:IF::GrandeEntry#skipdirs], and {#skipentries}[rdoc-ref:IF::GrandeEntry#skipentries].
       #
       def skip(*args,&block) target.skip(*args,&block); self end 
 
@@ -680,12 +669,12 @@ module RIO
       #
       def empty?() target.empty? end
 
-      # IF::Grande#split has two distinct behaviors depending on 
+      # {#split}[rdoc-ref:IF::Grande#split] has two distinct behaviors depending on 
       # whether or not it is called with an argument.
       #
       # ==== split with no aruments:
       #
-      # Returns an array of Rios, one for each path element. 
+      # Returns an array of \Rios, one for each path element. 
       # (Note that this behavior differs from File#split.)
       #
       #  rio('a/b/c').split   #=> [rio('a'),rio('b'),rio('c')]
@@ -700,7 +689,7 @@ module RIO
       #  ary[1] = rio('d')
       #  ary.to_rio                 #=> rio('a/d/c')
       #
-      # See also IF::Path#join, IF::Path#/, IF::Path#splitpath
+      # See also {#join}[rdoc-ref:IF::Path#join], IF::Path#/, {#splitpath}[rdoc-ref:IF::Path#splitpath]
       #
       # ==== split with an argument:
       #