Adam Kennedy > Perl-Dist-1.16 > Perl::Dist::Asset::Binary

Download:
Perl-Dist-1.16.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  4
View/Report Bugs
Module Version: 1.16   Source  

NAME ^

Perl::Dist::Asset::Binary - "Binary Package" asset for a Win32 Perl

SYNOPSIS ^

  my $binary = Perl::Dist::Asset::Binary->new(
      name       => 'dmake',
      license    => {
          'dmake/COPYING'            => 'dmake/COPYING',
          'dmake/readme/license.txt' => 'dmake/license.txt',
      },
      install_to => {
          'dmake/dmake.exe' => 'c/bin/dmake.exe',       
          'dmake/startup'   => 'c/bin/startup',
      },
  );

DESCRIPTION ^

Perl::Dist::Asset::Binary is a data class that provides encapsulation and error checking for a "binary package" to be installed in a Perl::Dist-based Perl distribution.

It is normally created on the fly by the <Perl::Dist::Inno> install_binary method (and other things that call it).

These packages will be simple zip or tar.gz files that are local files, installed in a CPAN distribution's 'share' directory, or retrieved from the internet via a URI.

The specification of the location to retrieve the package is done via the standard mechanism implemented in Perl::Dist::Asset.

METHODS ^

This class inherits from Perl::Dist::Asset and shares its API.

new

The new constructor takes a series of parameters, validates then and returns a new Perl::Dist::Asset::Binary object.

It inherits all the params described in the Perl::Dist::Asset new method documentation, and adds some additional params.

name

The required name param is the logical (arbitrary) name of the package for the purposes of identification.

license

During the installation build process, licenses files are pulled from the various source packages and written to a single dedicated directory.

The optional license param should be a reference to a HASH, where the keys are the location of license files within the package, and the values are locations within the "licenses" subdirectory of the final installation.

install_to

The required install_to param describes the location that the package will be installed to.

If the install_to param is a single string, such as "c" or "perl\foo" the entire binary package will be installed, with the root of the package archive being placed in the directory specified.

If the install_to param is a reference to a HASH, it is taken to mean that only some parts of the original binary package are required in the final install. In this case, the keys should be the file or directories desired, and the values are the names of the file or directory in the final Perl installation.

Although this param does not default when called directly, in practice the Perl::Dist::Inno install_binary method will default this value to "c", as most binary installations are for C toolchain tools or pre-compiled C libraries.

The new constructor returns a Perl::Dist::Asset::Binary object, or throws an exception (dies) if an invalid param is provided.

SUPPORT ^

Bugs should be reported via the CPAN bug tracker at

http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Perl-Dist

For other issues, contact the author.

AUTHOR ^

Adam Kennedy <adamk@cpan.org>

SEE ALSO ^

Perl::Dist, Perl::Dist::Inno, Perl::Dist::Asset

COPYRIGHT ^

Copyright 2007 - 2009 Adam Kennedy.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.

syntax highlighting: