Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Moved some information from the txt file to the README file.

  • Loading branch information...
commit b10475ee98541950e608ccdd8d97ff2e73054699 1 parent e7c92ac
@djberg96 authored
Showing with 39 additions and 45 deletions.
  1. +1 −1  CHANGES
  2. +25 −4 README
  3. +13 −40 doc/tar_external.txt
View
2  CHANGES
@@ -1,4 +1,4 @@
-== 1.3.0 - ???
+== 1.3.0 - 16-Jan-2010
* Altered the source code layout, which requires a change in your require
line. It's now require 'archive/tar/external'.
* Updated one test to use a skip as needed.
View
29 README
@@ -15,12 +15,33 @@
# The short way
t = Tar::External.new('test.tar', '*.rb', 'gzip')
-
+
== Prerequisites
The win32-open3 library (MS Windows only).
The 'tar' command line program.
At least one compression program, e.g. gzip, bzip2, zip, etc.
-== Notes
- For further documentation and information, see the tar_external.txt file
- in the 'doc' directory.
+== Known Issues
+ The tar program that comes with Solaris will not raise an error if you
+ try to expand a file from an archive that does not contain that file.
+
+ If you come across any other issues, please report them on the project
+ page at http://www.rubyforge.org/projects/shards.
+
+== Future Plans
+ Anything folks are looking for?
+
+== License
+ Artistic 2.0
+
+== 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.
+
+== Copyright
+ (C) 2003 - 2010 Daniel J. Berger
+ All Rights Reserved
+
+== Author
+ Daniel J. Berger
View
53 doc/tar_external.txt
@@ -1,27 +1,27 @@
== Description
- A simple tar interface using external system calls.
+ A simple tar interface using external system calls.
== Synopsis
- # Assuming we have three .txt files, t1.txt, t2.txt, t3.txt ...
- require 'archive/tar_external'
- include Archive
+ # Assuming we have three .txt files, t1.txt, t2.txt, t3.txt ...
+ require 'archive/tar/external'
+ include Archive
- t = Tar::External.new("myfile.tar")
+ t = Tar::External.new("myfile.tar")
- t.create_archive("*.txt")
- t.compress_archive("bzip2") # 'myfile.tar.bz2' now exists
+ t.create_archive("*.txt")
+ t.compress_archive("bzip2") # 'myfile.tar.bz2' now exists
- t.uncompress_archive("bunzip2")
+ t.uncompress_archive("bunzip2")
- t.archive_name # "myfile.tar"
- t.archive_info # ["t1.txt","t2.txt","t3.txt"]
+ t.archive_name # "myfile.tar"
+ t.archive_info # ["t1.txt","t2.txt","t3.txt"]
- t.add_to_archive("t4.txt","t5.txt")
- t.expand_archive
+ t.add_to_archive("t4.txt","t5.txt")
+ t.expand_archive
== Constants
VERSION
- Current version number of this library. This is a string.
+ Current version number of this library. This is a string.
== Class Methods
Archive::Tar::External.new(archive_name, pattern=nil, program=nil)
@@ -107,30 +107,3 @@ Tar::Error
Tar::CompressError
Raised if something goes wrong during the Tar#compress_archive or
Tar#uncompress_archive methods.
-
-== Known Issues
- The tar program that comes with Solaris will not raise an error if you
- try to expand a file from an archive that does not contain that file.
-
- If you come across any other issues, please report them on the project
- page at http://www.rubyforge.org/projects/shards.
-
-== Future Plans
- Anything folks are looking for?
-
-== License
- Artistic 2.0
-
-== 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.
-
-== Copyright
- (C) 2003 - 2009 Daniel J. Berger
- All Rights Reserved
-
-== Author
- Daniel J. Berger
- djberg96 at gmail dot com
- imperator on IRC (freenode)
Please sign in to comment.
Something went wrong with that request. Please try again.