local-lib5/man/man3/Module::Install::Makefile.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::Makefile 3"
 132 .TH Module::Install::Makefile 3 "2009-05-27" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Module::Install::MakeMaker \- Extension Rules for ExtUtils::MakeMaker
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 In your \fIMakefile.PL\fR:
 138 .PP
 139 .Vb 2
 140 \&    use inc::Module::Install;
 141 \&    WriteMakefile();
 142 .Ve
 143 .SH "DESCRIPTION"
 144 .IX Header "DESCRIPTION"
 145 This module is a wrapper around \fBExtUtils::MakeMaker\fR.  It exports
 146 two functions: \f(CW\*(C`prompt\*(C'\fR (an alias for \f(CW\*(C`ExtUtils::MakeMaker::prompt\*(C'\fR)
 147 and \f(CW\*(C`WriteMakefile\*(C'\fR.
 148 .PP
 149 The \f(CW\*(C`WriteMakefile\*(C'\fR function will pass on keyword/value pair functions
 150 to \f(CW\*(C`ExtUtils::MakeMaker::WriteMakefile\*(C'\fR. The required parameters
 151 \&\f(CW\*(C`NAME\*(C'\fR and \f(CW\*(C`VERSION\*(C'\fR (or \f(CW\*(C`VERSION_FROM\*(C'\fR) are not necessary if
 152 it can find them unambiguously in your code.
 153 .SH "CONFIGURATION OPTIONS"
 154 .IX Header "CONFIGURATION OPTIONS"
 155 This module also adds some Configuration parameters of its own:
 156 .Sh "\s-1NAME\s0"
 157 .IX Subsection "NAME"
 158 The \s-1NAME\s0 parameter is required by \fBExtUtils::MakeMaker\fR. If you have a
 159 single module in your distribution, or if the module name indicated by
 160 the current directory exists under \fIlib/\fR, this module will use the
 161 guessed package name as the default.
 162 .PP
 163 If this module can't find a default for \f(CW\*(C`NAME\*(C'\fR it will ask you to specify
 164 it manually.
 165 .Sh "\s-1VERSION\s0"
 166 .IX Subsection "VERSION"
 167 \&\fBExtUtils::MakeMaker\fR requires either the \f(CW\*(C`VERSION\*(C'\fR or \f(CW\*(C`VERSION_FROM\*(C'\fR
 168 parameter.  If this module can guess the package's \f(CW\*(C`NAME\*(C'\fR, it will attempt
 169 to parse the \f(CW\*(C`VERSION\*(C'\fR from it.
 170 .PP
 171 If this module can't find a default for \f(CW\*(C`VERSION\*(C'\fR it will ask you to
 172 specify it manually.
 173 .SH "MAKE TARGETS"
 174 .IX Header "MAKE TARGETS"
 175 \&\fBExtUtils::MakeMaker\fR provides you with many useful \f(CW\*(C`make\*(C'\fR targets. A
 176 \&\f(CW\*(C`make\*(C'\fR \fBtarget\fR is the word you specify after \f(CW\*(C`make\*(C'\fR, like \f(CW\*(C`test\*(C'\fR
 177 for \f(CW\*(C`make test\*(C'\fR. Some of the more useful targets are:
 178 .IP "* all" 4
 179 .IX Item "all"
 180 This is the default target. When you type \f(CW\*(C`make\*(C'\fR it is the same as
 181 entering \f(CW\*(C`make all\*(C'\fR. This target builds all of your code and stages it
 182 in the \f(CW\*(C`blib\*(C'\fR directory.
 183 .IP "* test" 4
 184 .IX Item "test"
 185 Run your distribution's test suite.
 186 .IP "* install" 4
 187 .IX Item "install"
 188 Copy the contents of the \f(CW\*(C`blib\*(C'\fR directory into the appropriate
 189 directories in your Perl installation.
 190 .IP "* dist" 4
 191 .IX Item "dist"
 192 Create a distribution tarball, ready for uploading to \s-1CPAN\s0 or sharing
 193 with a friend.
 194 .IP "* clean distclean purge" 4
 195 .IX Item "clean distclean purge"
 196 Remove the files created by \f(CW\*(C`perl Makefile.PL\*(C'\fR and \f(CW\*(C`make\*(C'\fR.
 197 .IP "* help" 4
 198 .IX Item "help"
 199 Same as typing \f(CW\*(C`perldoc ExtUtils::MakeMaker\*(C'\fR.
 200 .PP
 201 This module modifies the behaviour of some of these targets, depending
 202 on your requirements, and also adds the following targets to your Makefile:
 203 .IP "* cpurge" 4
 204 .IX Item "cpurge"
 205 Just like purge, except that it also deletes the files originally added
 206 by this module itself.
 207 .IP "* chelp" 4
 208 .IX Item "chelp"
 209 Short cut for typing \f(CW\*(C`perldoc Module::Install\*(C'\fR.
 210 .IP "* distsign" 4
 211 .IX Item "distsign"
 212 Short cut for typing \f(CW\*(C`cpansign \-s\*(C'\fR, for \fBModule::Signature\fR users to
 213 sign the distribution before release.
 214 .SH "SEE ALSO"
 215 .IX Header "SEE ALSO"
 216 Module::Install, CPAN::MakeMaker, CPAN::MakeMaker::Philosophy
 217 .SH "AUTHORS"
 218 .IX Header "AUTHORS"
 219 Adam Kennedy <adamk@cpan.org>
 220 .PP
 221 Audrey Tang <autrijus@autrijus.org>
 222 .PP
 223 Brian Ingerson <INGY@cpan.org>
 224 .SH "COPYRIGHT"
 225 .IX Header "COPYRIGHT"
 226 Some parts copyright 2008 \- 2009 Adam Kennedy.
 227 .PP
 228 Copyright 2002, 2003, 2004 Audrey Tang and Brian Ingerson.
 229 .PP
 230 This program is free software; you can redistribute it and/or modify it
 231 under the same terms as Perl itself.