local-lib5/man/man3/Module::Install::Bundle.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "Module::Install::Bundle 3"
 132 .TH Module::Install::Bundle 3 "2009-05-27" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Module::Install::Bundle \- Bundle distributions along with your distribution
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 Have your Makefile.PL read as follows:
 138 .PP
 139 .Vb 1
 140 \&  use inc::Module::Install;
 141 .Ve
 142 .PP
 143 .Vb 3
 144 \&  name      'Foo\-Bar';
 145 \&  all_from  'lib/Foo/Bar.pm';
 146 \&  requires  'Baz' => '1.60';
 147 .Ve
 148 .PP
 149 .Vb 4
 150 \&  # one of either:
 151 \&  bundle    'Baz' => '1.60';
 152 \&  # OR:
 153 \&  auto_bundle;
 154 .Ve
 155 .PP
 156 .Vb 1
 157 \&  WriteAll;
 158 .Ve
 159 .SH "DESCRIPTION"
 160 .IX Header "DESCRIPTION"
 161 Module::Install::Bundle allows you to bundle a \s-1CPAN\s0 distribution within your
 162 distribution. When your end-users install your distribution, the bundled
 163 distribution will be installed along with yours, unless a newer version of
 164 the bundled distribution already exists on their local filesystem.
 165 .PP
 166 While bundling will increase the size of your distribution, it has several
 167 benefits:
 168 .PP
 169 .Vb 3
 170 \&  Allows installation of bundled distributions when CPAN is unavailable
 171 \&  Allows installation of bundled distributions when networking is unavailable
 172 \&  Allows everything your distribution needs to be packaged in one place
 173 .Ve
 174 .PP
 175 Bundling differs from auto-installation in that when it comes time to
 176 install, a bundled distribution will be installed based on the distribution
 177 bundled with your distribution, whereas with auto-installation the distibution
 178 to be installed will be acquired from \s-1CPAN\s0 and then installed.
 179 .SH "METHODS"
 180 .IX Header "METHODS"
 181 .IP "* \fIauto_bundle()\fR" 4
 182 .IX Item "auto_bundle()"
 183 Takes no arguments, will bundle every distribution specified by a \f(CW\*(C`requires()\*(C'\fR.
 184 When you, as a module author, do a \f(CW\*(C`perl Makefile.PL\*(C'\fR the latest versions of
 185 the distributions to be bundled will be acquired from \s-1CPAN\s0 and placed in
 186 \&\fIinc/BUNDLES/\fR.
 187 .ie n .IP "* bundle($name, $version)" 4
 188 .el .IP "* bundle($name, \f(CW$version\fR)" 4
 189 .IX Item "bundle($name, $version)"
 190 Takes a list of key/value pairs specifying a distribution name and version
 191 number. When you, as a module author, do a perl Makefile.PL the distributions
 192 that you specified with \f(CW\*(C`bundle()\*(C'\fR will be acquired from \s-1CPAN\s0 and placed in
 193 \&\fIinc/BUNDLES/\fR.
 194 .ie n .IP "* bundle_deps($name, $version)" 4
 195 .el .IP "* bundle_deps($name, \f(CW$version\fR)" 4
 196 .IX Item "bundle_deps($name, $version)"
 197 Same as \f(CW\*(C`bundle\*(C'\fR, except that all dependencies of the bundled modules are
 198 also detected and bundled.  To use this function, you need to declare the
 199 minimum supported perl version first, like this:
 200 .Sp
 201 .Vb 1
 202 \&    requires( perl => 5.005 );
 203 .Ve
 204 .IP "* auto_bundle_deps" 4
 205 .IX Item "auto_bundle_deps"
 206 Same as \f(CW\*(C`auto_bundle\*(C'\fR, except that all dependencies of the bundled
 207 modules are also detected and bundled. This function has the same constraints as bundle_deps.
 208 .SH "BUGS"
 209 .IX Header "BUGS"
 210 Please report any bugs to (patches welcome):
 211 .PP
 212 .Vb 1
 213 \&    http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Module\-Install
 214 .Ve
 215 .SH "AUTHORS"
 216 .IX Header "AUTHORS"
 217 Audrey Tang <autrijus@autrijus.org>
 218 .PP
 219 Documentation by Adam Foxson <afoxson@pobox.com>
 220 .SH "COPYRIGHT"
 221 .IX Header "COPYRIGHT"
 222 Copyright 2003, 2004, 2005 by Audrey Tang <autrijus@autrijus.org>.
 223 .PP
 224 This program is free software; you can redistribute it and/or modify it under
 225 the same terms as Perl itself.