Perl::Dist::WiX::Asset::Launcher - Start menu launcher asset for a Win32 Perl
This document describes Perl::Dist::WiX::Asset::Launcher version 1.500.
my $batlauncher = Perl::Dist::WiX::Asset::Launcher->new( parent => $dist, name => 'CPAN Client', bin => 'cpan', ); $batlauncher->install(); my $exelauncher = Perl::Dist::WiX::Asset::Launcher->new( parent => $dist, name => 'Padre Development Environment', bin => 'padre', exe => 1, ); $exelauncher->install();
This asset creates a Start Menu entry for a script or executable file in the perl binary directory.
This class is a Perl::Dist::WiX::Role::Asset and shares its API.
The new constructor takes a series of parameters, validates then and returns a new Perl::Dist::WiX::Asset::Launcher object.
new
Perl::Dist::WiX::Asset::Launcher
It inherits all the parameters described in the Perl::Dist::WiX::Role::Asset->new() method documentation, and adds the additional parameters described below.
The required name parameter is the name of the link in the start menu.
name
The bin parameter is the name of the script or executable file to link to.
bin
The exe parameter specifies if the file is an executable file, as opposed to a script that has been converted to a batch file.
exe
The directory_id parameter specifies the directory that the Start menu link is to be created in.
directory_id
The install method installs the Start Menu link described by the Perl::Dist::WiX::Asset::Launcher object and returns true (or throws an exception.)
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.
Curtis Jewell <csjewell@cpan.org>
Adam Kennedy <adamk@cpan.org>
Perl::Dist::WiX, Perl::Dist::WiX::Role::Asset
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.
To install Perl::Dist::WiX, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Perl::Dist::WiX
CPAN shell
perl -MCPAN -e shell install Perl::Dist::WiX
For more information on module installation, please visit the detailed CPAN module installation guide.