NAME

Perl::Dist::WiX::Asset::Launcher - Start menu launcher asset for a Win32 Perl

SYNOPSIS

  my $distribution = Perl::Dist::WiX::Asset::Launcher->new(
    ...
  );

DESCRIPTION

TODO: Document

METHODS

TODO: Document

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

new

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

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

name

The required name param is the name of the package for the purposes of identification.

This should match the name of the Perl distribution without any version numbers. For example, "File-Spec" or "libwww-perl".

Alternatively, the name param can be a CPAN path to the distribution such as shown in the synopsis.

In this case, the url to fetch from will be derived from the name.

force

Unlike in the CPAN client installation, in which all modules MUST pass their tests to be added, the secondary method allows for cases where it is known that the tests can be safely "forced".

The optional boolean force param allows you to specify that the tests should be skipped and the module installed without validating it.

automated_testing

Many modules contain additional long-running tests, tests that require additional dependencies, or have differing behaviour when installing in a non-user automated environment.

The optional automated_testing param lets you specify that the module should be installed with the AUTOMATED_TESTING environment variable set to true, to make the distribution behave properly in an automated environment (in cases where it doesn't otherwise).

release_testing

Some modules contain release-time only tests, that require even heavier additional dependencies compared to even the automated_testing tests.

The optional release_testing param lets you specify that the module tests should be run with the additional RELEASE_TESTING environment flag set.

By default, release_testing is set to false to squelch any accidental execution of release tests when Perl::Dist::WiX itself is being tested under RELEASE_TESTING.

makefilepl_param

Some distributions illegally require you to pass additional non-standard parameters when you invoke "perl Makefile.PL".

The optional makefilepl_param param should be a reference to an ARRAY where each element contains the argument to pass to the Makefile.PL.

buildpl_param

Some distributions require you to pass additional non-standard parameters when you invoke "perl Build.PL".

The optional buildpl_param param should be a reference to an ARRAY where each element contains the argument to pass to the Build.PL.

The new method returns a Perl::Dist::WiX::Asset::Distribution object, or throws an exception on error.

install

The install method installs the website link described by the Perl::Dist::WiX::Asset::Website object and returns a file that was installed as a File::List::Object object.

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>

Adam Kennedy <adamk@cpan.org>

SEE ALSO

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

COPYRIGHT

Copyright 2009 - 2010 Curtis Jewell.

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.