Changeset 1760

Show
Ignore:
Timestamp:
01/15/06 21:32:34
Author:
miyagawa
Message:

update the document

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • Archive-Any-Create/trunk/Changes

    r1757 r1760  
    11Revision history for Perl extension Archive::Any::Create 
     2 
     30.02  2006-01-15T12:28:58Z 
     4        - Oops, document. 
    25 
    360.01  Sun Jan 15 08:28:26 2006 
  • Archive-Any-Create/trunk/lib/Archive/Any/Create.pm

    r1757 r1760  
    22 
    33use strict; 
    4 our $VERSION = '0.01'; 
     4our $VERSION = '0.02'; 
    55 
    66use Exception::Class 'Archive::Any::Create::Error'; 
     
    8484=head1 DESCRIPTION 
    8585 
    86 Archive::Any::Create is 
     86Archive::Any::Create is a wrapper module to create tar/tar.gz/zip 
     87files with a single easy-to-use API. 
     88 
     89=head1 METHODS 
     90 
     91=over 4 
     92 
     93=item new 
     94 
     95Create new Archive::Any::Create object. No parameters. 
     96 
     97=item container($dir) 
     98 
     99Specify a top-level directory (or folder) to contain multiple 
     100files. Not necessary but recommended to create a good-manner archive 
     101file. 
     102 
     103=item add_file($file, $data) 
     104 
     105Add a file that contains C<$data> as its content. C<$file> can be a 
     106file in the nested subdirectory. 
     107 
     108=item write_file($filename) 
     109 
     110Write an archive file named C<$filename>. This method is DWIMmy, in 
     111the sense that it automatically dispatches archiving module based on 
     112its filename. So, C<< $archive->write_file("foo.tar.gz") >> will 
     113create a tarball and C<< $archive->write_file("foo.zip") >> will 
     114create a zip file with the same contents. 
     115 
     116=item write_filehandle($fh, $format) 
     117 
     118Write an archive data stream into filehandle. C<$format> is either, 
     119L<tar>, L<tar.gz> or L<zip>. 
     120 
     121=back 
    87122 
    88123=head1 AUTHOR