/ 
Perl-Dist-WiX-1.102_102
River stage one • 1 direct dependent • 1 total dependent
/ Perl::Dist::WiX::Asset::PAR

NAME

Perl::Dist::WiX::Asset::PAR - "Binary .par package" asset for a Win32 Perl

SYNOPSIS

my $binary = Perl::Dist::Asset::PAR->new(
    name       => 'dmake',
);

# Or usually more like this:
$perl_dist_wix_obj->install_par(
  name => 'Perl-Dist-PrepackagedPAR-libexpat',
  url  => 'http://parrepository.de/Perl-Dist-PrepackagedPAR-libexpat-2.0.1-MSWin32-x86-multi-thread-anyversion.par',
);

DESCRIPTION

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

It is normally created by the install_par method of Perl::Dist::WiX (and other things that call it).

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

The install_to argument of the Perl::Dist::WiX::Asset::Library asset is not supported by the PAR asset.

See "PAR FILE FORMAT EXTENSIONS" below for details on how non-Perl binaries are installed.

METHODS

This class is a Perl::Dist::WiX::Role::Asset and shares its API.

new

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

It inherits all the parameters described in the Perl::Dist::WiX::Asset new method documentation, and adds an additional parameter.

name

The required name param is the logical name of the package for the purposes of identification. A sensible default would be the name of the primary Perl module in the package.

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

install

The install method installs the retrieved .par file.

PAR FILE FORMAT EXTENSIONS

This concerns packagers of .par binaries only.

A .par usually mostly contains the blib/ directory after making a Perl module. For use with Perl::Dist::Asset::PAR, there are currently three more subdirectories which will be installed:

blib/c/lib     => goes into the c/lib library directory for non-Perl extensions
blib/c/bin     => goes into the c/bin executable/dll directory for non-Perl extensions
blib/c/include => goes into the c/include header directory for non-Perl extensions
blib/c/share   => goes into the c/share share directory for non-Perl extensions

SUPPORT

Bugs should be reported via the CPAN bug tracker at

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

For other issues, contact the author.

AUTHOR

Curtis Jewell <csjewell@cpan.org>

SEE ALSO

Perl::Dist::WiX, Perl::Dist::WiX::Asset

COPYRIGHT AND LICENSE

Copyright 2009 - 2010 Curtis Jewell.

Copyright 2008 Steffen Mueller, borrowing heavily from Adam Kennedy's code.

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.