1Module::Install::BundleU(s3e)r Contributed Perl DocumentaMtoidounle::Install::Bundle(3)
2
3
4

NAME

6       Module::Install::Bundle - Bundle distributions along with your
7       distribution
8

SYNOPSIS

10       Have your Makefile.PL read as follows:
11
12         use inc::Module::Install;
13
14         name      'Foo-Bar';
15         all_from  'lib/Foo/Bar.pm';
16         requires  'Baz' => '1.60';
17
18         # one of either:
19         bundle    'Baz' => '1.60';
20         # OR:
21         auto_bundle;
22
23         WriteAll;
24

DESCRIPTION

26       Module::Install::Bundle allows you to bundle a CPAN distribution within
27       your distribution. When your end-users install your distribution, the
28       bundled distribution will be installed along with yours, unless a newer
29       version of the bundled distribution already exists on their local
30       filesystem.
31
32       While bundling will increase the size of your distribution, it has
33       several benefits:
34
35         Allows installation of bundled distributions when CPAN is unavailable
36         Allows installation of bundled distributions when networking is unavailable
37         Allows everything your distribution needs to be packaged in one place
38
39       Bundling differs from auto-installation in that when it comes time to
40       install, a bundled distribution will be installed based on the
41       distribution bundled with your distribution, whereas with auto-
42       installation the distibution to be installed will be acquired from CPAN
43       and then installed.
44

METHODS

46       ·   auto_bundle()
47
48           Takes no arguments, will bundle every distribution specified by a
49           "requires()".  When you, as a module author, do a "perl
50           Makefile.PL" the latest versions of the distributions to be bundled
51           will be acquired from CPAN and placed in inc/BUNDLES/.
52
53       ·   bundle($name, $version)
54
55           Takes a list of key/value pairs specifying a distribution name and
56           version number. When you, as a module author, do a perl Makefile.PL
57           the distributions that you specified with "bundle()" will be
58           acquired from CPAN and placed in inc/BUNDLES/.
59
60       ·   bundle_deps($name, $version)
61
62           Same as "bundle", except that all dependencies of the bundled
63           modules are also detected and bundled.  To use this function, you
64           need to declare the minimum supported perl version first, like
65           this:
66
67               requires( perl => 5.005 );
68
69       ·   auto_bundle_deps
70
71           Same as "auto_bundle", except that all dependencies of the bundled
72           modules are also detected and bundled. This function has the same
73           constraints as bundle_deps.
74

BUGS

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

AUTHORS

81       Audrey Tang <autrijus@autrijus.org>
82
83       Documentation by Adam Foxson <afoxson@pobox.com>
84

86       Copyright 2003, 2004, 2005 by Audrey Tang <autrijus@autrijus.org>.
87
88       This program is free software; you can redistribute it and/or modify it
89       under the same terms as Perl itself.
90
91
92
93perl v5.12.0                      2010-03-10        Module::Install::Bundle(3)
Impressum