NAME

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

VERSION

This document describes Perl::Dist::WiX::Asset::PAR version 1.500.

SYNOPSIS

  my $binary = Perl::Dist::Asset::PAR->new(
    parent => $dist, # A Perl::Dist::WiX object.
    name   => 'dmake',
    url    => 'http://parrepository.de/Perl-Dist-PrepackagedPAR-libexpat-2.0.1-MSWin32-x86-multi-thread-anyversion.par',
  );
  
  # 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::WiX::Asset::PAR object.

The new constructor will throw an exception (dies) if an invalid parameter is provided.

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

name

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

name

The required dist_info parameter is the location of the source package for the .par file, either as a URL (which should be accessible for 3 years) or as a location on CPAN in the 'AUTHORID/dist-version.tar.gz' format.

install

The install method retrieves the specified .par file and installs it.

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 four 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::Role::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.

cpanm Perl::Dist::WiX

perl -MCPAN -e shell
install Perl::Dist::WiX