Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Module::Install::BundlUser Contributed Perl DocumentModule::Install::Bundle(3)

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';
	 all_from  'lib/Foo/Bar.pm';
	 requires  'Baz' => '1.60';

	 # one of either:
	 bundle	   'Baz' => '1.60';
	 # OR:
	 auto_bundle;

	 WriteAll;

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	distribution to	be installed will be acquired from
       CPAN and	then installed.

METHODS
       o   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/.

       o   bundle($name, $version)

	   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/.

       o   bundle_deps($name, $version)

	   Same	as "bundle", except that all dependencies of the bundled
	   modules are also detected and bundled.  To use this function, you
	   need	to declare the minimum supported perl version first, like
	   this:

	       perl_version( '5.005' );

       o   auto_bundle_deps

	   Same	as "auto_bundle", except that all dependencies of the bundled
	   modules are also detected and bundled. This function	has the	same
	   constraints as bundle_deps.

BUGS
       Please report any bugs to (patches welcome):

	   http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Module-Install

AUTHORS
       Audrey Tang <autrijus@autrijus.org>

       Documentation by	Adam Foxson <afoxson@pobox.com>

COPYRIGHT
       Copyright 2003, 2004, 2005 by Audrey Tang <autrijus@autrijus.org>.

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

perl v5.32.1			  2017-04-04	    Module::Install::Bundle(3)

NAME | SYNOPSIS | DESCRIPTION | METHODS | BUGS | AUTHORS | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Module::Install::Bundle&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help