The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Module::Install::Bundle - Bundle distributions along with your distribution

SYNOPSIS

Have your Makefile.PL read as follows:

  use inc::Module::Install;

  name("Foo-Bar");
  version_from("lib/Foo/Bar.pm");
  abstract("Description of your distribution");
  author("Your Name <your@email.com>");
  license("gpl"); # or "perl", etc
  requires("Baz" => "1.60");
  check_nmake();

  # one of either:
  auto_bundle(); # OR
  bundle("Baz" => "1.60");

  &Meta->write;
  &Build->write if lc($0) eq "build.pl";
  &Makefile->write if lc($0) eq "makefile.pl";

DESCRIPTION

Module::Install::Bundle allows you to bundle a CPAN distribution within your distribution. When your end-users install your distribution, the bundled distribution will be installed along with yours, unless a newer version of the bundled distribution already exists on their local filesystem.

While bundling will increase the size of your distribution, it has several benefits:

  Allows installation of bundled distributions when CPAN is unavailable
  Allows installation of bundled distributions when networking is unavailable
  Allows everything your distribution needs to be packaged in one place

Bundling differs from auto-installation in that when it comes time to install, a bundled distribution will be installed based on the distribution bundled with your distribution, whereas with auto-installation the distibution to be installed will be acquired from CPAN and then installed.

METHODS

  • auto_bundle

    Takes no arguments, will bundle every distribution specified by a requires(). When you, as a module author, do a perl Makefile.PL the latest versions of the distributions to be bundled will be acquired from CPAN and placed in inc/BUNDLES/.

  • bundle

    Takes a list of key/value pairs specifying a distribution name and version number. When you, as a module author, do a perl Makefile.PL the distributions that you specified with bundle() will be acquired from CPAN and placed in inc/BUNDLES/.

BUGS

  Please report any bugs to (patches welcome):
  http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Module-Install

COPYRIGHT

  Copyright 2003 by Autrijus Tang <autrijus@autrijus.org>.

LICENSE

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

SEE ALSO

AUTHORS

  Autrijus Tang <autrijus@autrijus.org>
  Documentation by Adam Foxson <afoxson@pobox.com>