1# NAME 2 3File::ShareDir::Tarball - Deal transparently with shared files distributed as tarballs 4 5# VERSION 6 7version 0.2.2 8 9# SYNOPSIS 10 11 use File::ShareDir::Tarball ':all'; 12 13 # use exactly like File::ShareDir 14 $dir = dist_dir('File-ShareDir'); 15 16# DESCRIPTION 17 18If the shared files of a distribution are contained in a 19tarball (see [Dist::Zilla::Plugin::ShareDir::Tarball](http://search.cpan.org/perldoc?Dist::Zilla::Plugin::ShareDir::Tarball) for 20why you would want to do that), automatically 21extract the archive in a temporary 22directory and return the path to that directory. If called for a regular distribution without a bundle file 23(`shared-files.tar.gz`), it'll return the original shared dir. 24In other words, 25from the consumer point of view, it'll behave just like [File::ShareDir](http://search.cpan.org/perldoc?File::ShareDir). 26 27# EXPORT TAGS 28 29## :all 30 31Exports `dist_dir()` and `dist_file()`. 32 33# EXPORTABLE FUNCTIONS 34 35## dist\_dir( $distribution ) 36 37Behaves just like `dist_dir()` from [File::ShareDir](http://search.cpan.org/perldoc?File::ShareDir). 38 39## dist\_file( $distribution, $file ) 40 41Behaves just like `dist_file()` from [File::ShareDir](http://search.cpan.org/perldoc?File::ShareDir). 42 43# SEE ALSO 44 45- [Test::File::ShareDir](http://search.cpan.org/perldoc?Test::File::ShareDir) 46 47To test or use a shared dir that is not deployed yet. 48 49- [Dist::Zilla::Plugin::ShareDir::Tarball](http://search.cpan.org/perldoc?Dist::Zilla::Plugin::ShareDir::Tarball) 50 51[Dist::Zilla](http://search.cpan.org/perldoc?Dist::Zilla) plugin to create the tarball effortlessly. 52 53- [Module::Build::CleanInstall](http://search.cpan.org/perldoc?Module::Build::CleanInstall) 54 55Provides an alternative to this module by subclassing [Module::Build](http://search.cpan.org/perldoc?Module::Build) and, 56upon installation, remove the files from previous installations as given in 57the _packlist_. 58 59# AUTHOR 60 61Yanick Champoux <yanick@babyl.dyndns.org> [![endorse](http://api.coderwall.com/yanick/endorsecount.png)](http://coderwall.com/yanick) 62 63# COPYRIGHT AND LICENSE 64 65This software is copyright (c) 2012 by Yanick Champoux. 66 67This is free software; you can redistribute it and/or modify it under 68the same terms as the Perl 5 programming language system itself. 69