Contents

== Description
   The ptools (power tools) package is an additional set of commands for the
   File class based on Unix command line tools.
   
== Prerequisites
   Ruby 1.8.0 or later is recommended but not required.

== Installation
   ruby test/ts_all.rb (optional)
   ruby install.rb

== Synopsis
   require "ptools"

   File.which("ruby")         # '/usr/local/bin/ruby'
   File.whereis("ruby")       # ['/usr/local/bin/ruby','/opt/bin/ruby']

   File.head("myfile")        # Returns first 10 lines of 'myfile'
   File.middle("myfile",8,12) # Returns lines 8-12 of 'myfile'
   File.tail("myfile",3)      # Returns last 3 lines of 'myfile'
   File.wc("myfile",'words')  # Returns the number of words in 'myfile'

   File.touch("newfile")      # "newfile" now exists

   # Creates a copy of 'myfile' called 'newfile', in DOS format
   File.nl_convert("myfile", "newfile", "dos")
   
== Known Bugs
   There is a bug in 1.6.x that can cause $\ characters to accumulate when
   converting to DOS or MAC format if nl_convert is run multiple times on
   the same file.  This appears to be fixed in 1.8.x.

== Acknowledgements
   The which() method was adopted from the FileWhich code posted by Michael
   Granger on http://www.rubygarden.org.  The 'whereis' command is a minor
   modification of that code as well.

   The nl_convert() method was adopted (somewhat) from the nlcvt program
   found at http://www.perl.com/language/ppt/src/nlcvt/nlcvt, written by
   Tom Christiansen.
    
   The middle() method was provided by Shashank Date.

== Future Plans
   Add whatever other tools people think might be useful.
   
== License
   Ruby's
    
== Copyright
   (C) 2003-2005 Daniel J. Berger
   All Rights Reserved.
    
== Warranty
   This package is provided "as is" and without any express or
   implied warranties, including, without limitation, the implied
   warranties of merchantability and fitness for a particular purpose.

== Author
   Daniel J. Berger
   djberg96 at gmail dot com
   imperator on IRC (irc.freenode.net)

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
ptools-1.0.0	README