Arch::Tarball(3pm) User Contributed Perl Documentation Arch::Tarball(3pm)NAME
Arch::Tarball - an interface to create and work with tarballs
SYNOPSIS
use Arch::Tarball
my $tarball = Arch::Tarball->new;
my $pipe = $tarball->create(
dir => '/path/to/subdir-to-pack',
base_name => 'new-subdir-to-pack',
pipe => 1,
);
DESCRIPTION
Arch::Tarball provides an object oriented interface to work with (create, examine or extract) standard gzipped tarballs.
Note: As functionality is added only when needed, a lot of features are currently not implemented.
METHODS
The following functions are available:
new, create, extract, list.
new %opts
Creates a new Arch::Tarball object.
The following parameters can be set via %opts:
tar The name of the tar executable. Defaults to "tar".
file
The filename of the Tarball.
create %opts
Creates a new tarball (tar.gz) from a given directory structure.
create understands the following options:
dir (mandatory)
Specifies the base directory for the tarball. The given directory and recursively its content will be added to the tarball. The
directory's basename will be used as the first and the only subdirectory in the tarball.
base_name
Allow the programmer to specify a different base directory name for the tarball content than the basename of dir. In this case,
'cp' process is launched to temporarily rename the last element of dir.
pipe
When set, create does not create a physical tarball but writes the tarballs content to a newly created pipe. The pipe is returned
by the create method.
Note: Currently the pipe option is mandatory.
extract %opts
Extracts the tarball to a given target directory, specified by dir option. If dir option is not given, a temporary directory is
created that will hold the extracted dirs/files. This directory is returned.
The file option specifies the tarball file name. It may be given in the constructor instead.
list %opts (not implemented yet)
Returns a list of files and directories in the tarball.
BUGS
Most functionality is currently not implemented. If you need part of the missing functionality, please contact the authors.
Patches are greatly appreciated.
AUTHORS
Mikhael Goikhman (migo@homemail.com--Perl-GPL/arch-perl--devel).
Enno Cramer (uebergeek@web.de--2003/arch-perl--devel).
perl v5.10.1 2005-04-22 Arch::Tarball(3pm)
Check Out this Related Man Page
Arch::Session(3pm) User Contributed Perl Documentation Arch::Session(3pm)NAME
Arch::Session - access arch archives
SYNOPSIS
use Arch::Session;
my $session = Arch::Session->new;
my $rev = 'migo@homemail.com--Perl-GPL/arch-perl--devel--0--patch-1';
my $log = $session->get_revision_log($rev);
my $cset = $session->get_revision_changeset($rev);
my $tree = $session->get_tree($rev);
DESCRIPTION
Arch::Session provides an interface to access changesets and logs stored in arch archives.
METHODS
The following common methods (inherited and pure virtual that this class implements) are documented in Arch::Storage:
new, init, working_name, working_names, fixup_name_alias, is_archive_managed, expanded_revisions.
archives, categories, branches, versions, revisions, get_revision_descs, expanded_archive_info, get_revision_changeset, get_changeset,
get_revision_log, get_log.
Additionally, the following methods are available:
get_specified_changeset, clear_cache, get_tree, init_tree, my_id.
get_specified_changeset arg
Get changeset object (Arch::Changeset) by a user specified input. arg may be revision name, or changeset directory, or tree directory
(then changeset for tree changes is constructed), and in the future local tarball filepath or remote tarball url.
clear_cache [key ..]
For performance reasons, most method results are cached (memoized in fact). Use this method to explicitly request this cache to be
cleared.
By default all cached keys are cleared; key may be one of the strings 'archives', 'categories', 'branches', 'versions', 'revisions' or
'revision_descs'.
get_tree [{ options }] [revision [dir]]
Construct a working tree for revision or working_name in dir. If dir is not specified, a new temporary directory is automatically
created.
Keys of options may be pristine, link, library, sparse, non_sparse, no_greedy_add; all are false by default. See "tla get".
init_tree dir
Run "tla init-tree" in dir.
my_id [newid]
Get or set "tla my-id".
BUGS
No known bugs.
AUTHORS
Mikhael Goikhman (migo@homemail.com--Perl-GPL/arch-perl--devel).
Enno Cramer (uebergeek@web.de--2003/arch-perl--devel).
SEE ALSO
For more information, see tla, Arch::Storage, Arch::Library, Arch::Name, Arch::Log, Arch::Changeset.
perl v5.10.1 2005-11-14 Arch::Session(3pm)