Debian Codegraph @

upstream/debian-unstable/man3/ExtUtils::MakeMaker.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "ExtUtils::MakeMaker 3perl"
58 .TH ExtUtils::MakeMaker 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 ExtUtils::MakeMaker \- Create a module Makefile
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& use ExtUtils::MakeMaker;
69 \&
70 \& WriteMakefile(
71 \& NAME => "Foo::Bar",
72 \& VERSION_FROM => "lib/Foo/Bar.pm",
73 \& );
74 .Ve
75 .SH DESCRIPTION
76 .IX Header "DESCRIPTION"
77 This utility is designed to write a Makefile for an extension module
78 from a Makefile.PL. It is based on the Makefile.SH model provided by
79 Andy Dougherty and the perl5\-porters.
80 .PP
81 It splits the task of generating the Makefile into several subroutines
82 that can be individually overridden. Each subroutine returns the text
83 it wishes to have written to the Makefile.
84 .PP
85 As there are various Make programs with incompatible syntax, which
86 use operating system shells, again with incompatible syntax, it is
87 important for users of this module to know which flavour of Make
88 a Makefile has been written for so they'll use the correct one and
89 won't have to face the possibly bewildering errors resulting from
90 using the wrong one.
91 .PP
92 On POSIX systems, that program will likely be GNU Make; on Microsoft
93 Windows, it will be either Microsoft NMake, DMake or GNU Make.
94 See the section on the "MAKE" parameter for details.
95 .PP
96 ExtUtils::MakeMaker (EUMM) is object oriented. Each directory below the current
97 directory that contains a Makefile.PL is treated as a separate
98 object. This makes it possible to write an unlimited number of
99 Makefiles with a single invocation of \fBWriteMakefile()\fR.
100 .PP
101 All inputs to WriteMakefile are Unicode characters, not just octets. EUMM
102 seeks to handle all of these correctly. It is currently still not possible
103 to portably use Unicode characters in module names, because this requires
104 Perl to handle Unicode filenames, which is not yet the case on Windows.
105 .PP
106 See ExtUtils::MakeMaker::FAQ for details of the design and usage.
107 .SS "How To Write A Makefile.PL"
108 .IX Subsection "How To Write A Makefile.PL"
109 See ExtUtils::MakeMaker::Tutorial.
110 .PP
111 The long answer is the rest of the manpage :\-)
112 .SS "Default Makefile Behaviour"
113 .IX Subsection "Default Makefile Behaviour"
114 The generated Makefile enables the user of the extension to invoke
115 .PP
116 .Vb 4
117 \& perl Makefile.PL # optionally "perl Makefile.PL verbose"
118 \& make
119 \& make test # optionally set TEST_VERBOSE=1
120 \& make install # See below
121 .Ve
122 .PP
123 The Makefile to be produced may be altered by adding arguments of the
124 form \f(CW\*(C`KEY=VALUE\*(C'\fR. E.g.
125 .PP
126 .Vb 1
127 \& perl Makefile.PL INSTALL_BASE=~
128 .Ve
129 .PP
130 Other interesting targets in the generated Makefile are
131 .PP
132 .Vb 5
133 \& make config # to check if the Makefile is up\-to\-date
134 \& make clean # delete local temp files (Makefile gets renamed)
135 \& make realclean # delete derived files (including ./blib)
136 \& make ci # check in all the files in the MANIFEST file
137 \& make dist # see below the Distribution Support section
138 .Ve
139 .SS "make test"
140 .IX Subsection "make test"
141 MakeMaker checks for the existence of a file named \fItest.pl\fR in the
142 current directory, and if it exists it executes the script with the
143 proper set of perl \f(CW\*(C`\-I\*(C'\fR options.
144 .PP
145 MakeMaker also checks for any files matching glob("t/*.t"). It will
146 execute all matching files in alphabetical order via the
147 Test::Harness module with the \f(CW\*(C`\-I\*(C'\fR switches set correctly.
148 .PP
149 You can also organize your tests within subdirectories in the \fIt/\fR directory.
150 To do so, use the \fItest\fR directive in your \fIMakefile.PL\fR. For example, if you
151 had tests in:
152 .PP
153 .Vb 2
154 \& t/foo
155 \& t/foo/bar
156 .Ve
157 .PP
158 You could tell make to run tests in both of those directories with the
159 following directives:
160 .PP
161 .Vb 2
162 \& test => {TESTS => \*(Aqt/*/*.t t/*/*/*.t\*(Aq}
163 \& test => {TESTS => \*(Aqt/foo/*.t t/foo/bar/*.t\*(Aq}
164 .Ve
165 .PP
166 The first will run all test files in all first-level subdirectories and all
167 subdirectories they contain. The second will run tests in only the \fIt/foo\fR
168 and \fIt/foo/bar\fR.
169 .PP
170 If you'd like to see the raw output of your tests, set the
171 \&\f(CW\*(C`TEST_VERBOSE\*(C'\fR variable to true.
172 .PP
173 .Vb 1
174 \& make test TEST_VERBOSE=1
175 .Ve
176 .PP
177 If you want to run particular test files, set the \f(CW\*(C`TEST_FILES\*(C'\fR variable.
178 It is possible to use globbing with this mechanism.
179 .PP
180 .Vb 1
181 \& make test TEST_FILES=\*(Aqt/foobar.t t/dagobah*.t\*(Aq
182 .Ve
183 .PP
184 Windows users who are using \f(CW\*(C`nmake\*(C'\fR should note that due to a bug in \f(CW\*(C`nmake\*(C'\fR,
185 when specifying \f(CW\*(C`TEST_FILES\*(C'\fR you must use back-slashes instead of forward-slashes.
186 .PP
187 .Vb 1
188 \& nmake test TEST_FILES=\*(Aqt\efoobar.t t\edagobah*.t\*(Aq
189 .Ve
190 .SS "make testdb"
191 .IX Subsection "make testdb"
192 A useful variation of the above is the target \f(CW\*(C`testdb\*(C'\fR. It runs the
193 test under the Perl debugger (see perldebug). If the file
194 \&\fItest.pl\fR exists in the current directory, it is used for the test.
195 .PP
196 If you want to debug some other testfile, set the \f(CW\*(C`TEST_FILE\*(C'\fR variable
197 thusly:
198 .PP
199 .Vb 1
200 \& make testdb TEST_FILE=t/mytest.t
201 .Ve
202 .PP
203 By default the debugger is called using \f(CW\*(C`\-d\*(C'\fR option to perl. If you
204 want to specify some other option, set the \f(CW\*(C`TESTDB_SW\*(C'\fR variable:
205 .PP
206 .Vb 1
207 \& make testdb TESTDB_SW=\-Dx
208 .Ve
209 .SS "make install"
210 .IX Subsection "make install"
211 make alone puts all relevant files into directories that are named by
212 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_MAN1DIR and
213 INST_MAN3DIR. All these default to something below ./blib if you are
214 \&\fInot\fR building below the perl source directory. If you \fIare\fR
215 building below the perl source, INST_LIB and INST_ARCHLIB default to
216 \&../../lib, and INST_SCRIPT is not defined.
217 .PP
218 The \fIinstall\fR target of the generated Makefile copies the files found
219 below each of the INST_* directories to their INSTALL*
220 counterparts. Which counterparts are chosen depends on the setting of
221 INSTALLDIRS according to the following table:
222 .PP
223 .Vb 2
224 \& INSTALLDIRS set to
225 \& perl site vendor
226 \&
227 \& PERLPREFIX SITEPREFIX VENDORPREFIX
228 \& INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH INSTALLVENDORARCH
229 \& INST_LIB INSTALLPRIVLIB INSTALLSITELIB INSTALLVENDORLIB
230 \& INST_BIN INSTALLBIN INSTALLSITEBIN INSTALLVENDORBIN
231 \& INST_SCRIPT INSTALLSCRIPT INSTALLSITESCRIPT INSTALLVENDORSCRIPT
232 \& INST_MAN1DIR INSTALLMAN1DIR INSTALLSITEMAN1DIR INSTALLVENDORMAN1DIR
233 \& INST_MAN3DIR INSTALLMAN3DIR INSTALLSITEMAN3DIR INSTALLVENDORMAN3DIR
234 .Ve
235 .PP
236 The INSTALL... macros in turn default to their \f(CW%Config\fR
237 ($Config{installprivlib}, \f(CW$Config\fR{installarchlib}, etc.) counterparts.
238 .PP
239 You can check the values of these variables on your system with
240 .PP
241 .Vb 1
242 \& perl \*(Aq\-V:install.*\*(Aq
243 .Ve
244 .PP
245 And to check the sequence in which the library directories are
246 searched by perl, run
247 .PP
248 .Vb 1
249 \& perl \-le \*(Aqprint join $/, @INC\*(Aq
250 .Ve
251 .PP
252 Sometimes older versions of the module you're installing live in other
253 directories in \f(CW@INC\fR. Because Perl loads the first version of a module it
254 finds, not the newest, you might accidentally get one of these older
255 versions even after installing a brand new version. To delete \fIall other
256 versions of the module you're installing\fR (not simply older ones) set the
257 \&\f(CW\*(C`UNINST\*(C'\fR variable.
258 .PP
259 .Vb 1
260 \& make install UNINST=1
261 .Ve
262 .SS INSTALL_BASE
263 .IX Subsection "INSTALL_BASE"
264 INSTALL_BASE can be passed into Makefile.PL to change where your
265 module will be installed. INSTALL_BASE is more like what everyone
266 else calls "prefix" than PREFIX is.
267 .PP
268 To have everything installed in your home directory, do the following.
269 .PP
270 .Vb 2
271 \& # Unix users, INSTALL_BASE=~ works fine
272 \& perl Makefile.PL INSTALL_BASE=/path/to/your/home/dir
273 .Ve
274 .PP
275 Like PREFIX, it sets several INSTALL* attributes at once. Unlike
276 PREFIX it is easy to predict where the module will end up. The
277 installation pattern looks like this:
278 .PP
279 .Vb 6
280 \& INSTALLARCHLIB INSTALL_BASE/lib/perl5/$Config{archname}
281 \& INSTALLPRIVLIB INSTALL_BASE/lib/perl5
282 \& INSTALLBIN INSTALL_BASE/bin
283 \& INSTALLSCRIPT INSTALL_BASE/bin
284 \& INSTALLMAN1DIR INSTALL_BASE/man/man1
285 \& INSTALLMAN3DIR INSTALL_BASE/man/man3
286 .Ve
287 .PP
288 INSTALL_BASE in MakeMaker and \f(CW\*(C`\-\-install_base\*(C'\fR in Module::Build (as
289 of 0.28) install to the same location. If you want MakeMaker and
290 Module::Build to install to the same location simply set INSTALL_BASE
291 and \f(CW\*(C`\-\-install_base\*(C'\fR to the same location.
292 .PP
293 INSTALL_BASE was added in 6.31.
294 .SS "PREFIX and LIB attribute"
295 .IX Subsection "PREFIX and LIB attribute"
296 PREFIX and LIB can be used to set several INSTALL* attributes in one
297 go. Here's an example for installing into your home directory.
298 .PP
299 .Vb 2
300 \& # Unix users, PREFIX=~ works fine
301 \& perl Makefile.PL PREFIX=/path/to/your/home/dir
302 .Ve
303 .PP
304 This will install all files in the module under your home directory,
305 with man pages and libraries going into an appropriate place (usually
306 ~/man and ~/lib). How the exact location is determined is complicated
307 and depends on how your Perl was configured. INSTALL_BASE works more
308 like what other build systems call "prefix" than PREFIX and we
309 recommend you use that instead.
310 .PP
311 Another way to specify many INSTALL directories with a single
312 parameter is LIB.
313 .PP
314 .Vb 1
315 \& perl Makefile.PL LIB=~/lib
316 .Ve
317 .PP
318 This will install the module's architecture-independent files into
319 ~/lib, the architecture-dependent files into ~/lib/$archname.
320 .PP
321 Note, that in both cases the tilde expansion is done by MakeMaker, not
322 by perl by default, nor by make.
323 .PP
324 Conflicts between parameters LIB, PREFIX and the various INSTALL*
325 arguments are resolved so that:
326 .IP \(bu 4
327 setting LIB overrides any setting of INSTALLPRIVLIB, INSTALLARCHLIB,
328 INSTALLSITELIB, INSTALLSITEARCH (and they are not affected by PREFIX);
329 .IP \(bu 4
330 without LIB, setting PREFIX replaces the initial \f(CW$Config{prefix}\fR
331 part of those INSTALL* arguments, even if the latter are explicitly
332 set (but are set to still start with \f(CW$Config{prefix}\fR).
333 .PP
334 If the user has superuser privileges, and is not working on AFS or
335 relatives, then the defaults for INSTALLPRIVLIB, INSTALLARCHLIB,
336 INSTALLSCRIPT, etc. will be appropriate, and this incantation will be
337 the best:
338 .PP
339 .Vb 4
340 \& perl Makefile.PL;
341 \& make;
342 \& make test
343 \& make install
344 .Ve
345 .PP
346 make install by default writes some documentation of what has been
347 done into the file \f(CW\*(C`$(INSTALLARCHLIB)/perllocal.pod\*(C'\fR. This feature
348 can be bypassed by calling make pure_install.
349 .SS "AFS users"
350 .IX Subsection "AFS users"
351 will have to specify the installation directories as these most
352 probably have changed since perl itself has been installed. They will
353 have to do this by calling
354 .PP
355 .Vb 3
356 \& perl Makefile.PL INSTALLSITELIB=/afs/here/today \e
357 \& INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
358 \& make
359 .Ve
360 .PP
361 Be careful to repeat this procedure every time you recompile an
362 extension, unless you are sure the AFS installation directories are
363 still valid.
364 .SS "Static Linking of a new Perl Binary"
365 .IX Subsection "Static Linking of a new Perl Binary"
366 An extension that is built with the above steps is ready to use on
367 systems supporting dynamic loading. On systems that do not support
368 dynamic loading, any newly created extension has to be linked together
369 with the available resources. MakeMaker supports the linking process
370 by creating appropriate targets in the Makefile whenever an extension
371 is built. You can invoke the corresponding section of the makefile with
372 .PP
373 .Vb 1
374 \& make perl
375 .Ve
376 .PP
377 That produces a new perl binary in the current directory with all
378 extensions linked in that can be found in INST_ARCHLIB, SITELIBEXP,
379 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
380 UNIX, this is called \fIMakefile.aperl\fR (may be system dependent). If you
381 want to force the creation of a new perl, it is recommended that you
382 delete this \fIMakefile.aperl\fR, so the directories are searched through
383 for linkable libraries again.
384 .PP
385 The binary can be installed into the directory where perl normally
386 resides on your machine with
387 .PP
388 .Vb 1
389 \& make inst_perl
390 .Ve
391 .PP
392 To produce a perl binary with a different name than \f(CW\*(C`perl\*(C'\fR, either say
393 .PP
394 .Vb 3
395 \& perl Makefile.PL MAP_TARGET=myperl
396 \& make myperl
397 \& make inst_perl
398 .Ve
399 .PP
400 or say
401 .PP
402 .Vb 3
403 \& perl Makefile.PL
404 \& make myperl MAP_TARGET=myperl
405 \& make inst_perl MAP_TARGET=myperl
406 .Ve
407 .PP
408 In any case you will be prompted with the correct invocation of the
409 \&\f(CW\*(C`inst_perl\*(C'\fR target that installs the new binary into INSTALLBIN.
410 .PP
411 make inst_perl by default writes some documentation of what has been
412 done into the file \f(CW\*(C`$(INSTALLARCHLIB)/perllocal.pod\*(C'\fR. This
413 can be bypassed by calling make pure_inst_perl.
414 .PP
415 Warning: the inst_perl: target will most probably overwrite your
416 existing perl binary. Use with care!
417 .PP
418 Sometimes you might want to build a statically linked perl although
419 your system supports dynamic loading. In this case you may explicitly
420 set the linktype with the invocation of the Makefile.PL or make:
421 .PP
422 .Vb 1
423 \& perl Makefile.PL LINKTYPE=static # recommended
424 .Ve
425 .PP
426 or
427 .PP
428 .Vb 1
429 \& make LINKTYPE=static # works on most systems
430 .Ve
431 .SS "Determination of Perl Library and Installation Locations"
432 .IX Subsection "Determination of Perl Library and Installation Locations"
433 MakeMaker needs to know, or to guess, where certain things are
434 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
435 during the \fBmake\fR\|(1) run), PERL_LIB and PERL_ARCHLIB (where to read
436 existing modules from), and PERL_INC (header files and \f(CW\*(C`libperl*.*\*(C'\fR).
437 .PP
438 Extensions may be built either using the contents of the perl source
439 directory tree or from the installed perl library. The recommended way
440 is to build extensions after you have run 'make install' on perl
441 itself. You can do that in any directory on your hard disk that is not
442 below the perl source tree. The support for extensions below the ext
443 directory of the perl distribution is only good for the standard
444 extensions that come with perl.
445 .PP
446 If an extension is being built below the \f(CW\*(C`ext/\*(C'\fR directory of the perl
447 source then MakeMaker will set PERL_SRC automatically (e.g.,
448 \&\f(CW\*(C`../..\*(C'\fR). If PERL_SRC is defined and the extension is recognized as
449 a standard extension, then other variables default to the following:
450 .PP
451 .Vb 5
452 \& PERL_INC = PERL_SRC
453 \& PERL_LIB = PERL_SRC/lib
454 \& PERL_ARCHLIB = PERL_SRC/lib
455 \& INST_LIB = PERL_LIB
456 \& INST_ARCHLIB = PERL_ARCHLIB
457 .Ve
458 .PP
459 If an extension is being built away from the perl source then MakeMaker
460 will leave PERL_SRC undefined and default to using the installed copy
461 of the perl library. The other variables default to the following:
462 .PP
463 .Vb 5
464 \& PERL_INC = $archlibexp/CORE
465 \& PERL_LIB = $privlibexp
466 \& PERL_ARCHLIB = $archlibexp
467 \& INST_LIB = ./blib/lib
468 \& INST_ARCHLIB = ./blib/arch
469 .Ve
470 .PP
471 If perl has not yet been installed then PERL_SRC can be defined on the
472 command line as shown in the previous section.
473 .SS "Which architecture dependent directory?"
474 .IX Subsection "Which architecture dependent directory?"
475 If you don't want to keep the defaults for the INSTALL* macros,
476 MakeMaker helps you to minimize the typing needed: the usual
477 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
478 by Configure at perl compilation time. MakeMaker supports the user who
479 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
480 then MakeMaker defaults the latter to be the same subdirectory of
481 INSTALLPRIVLIB as Configure decided for the counterparts in \f(CW%Config\fR,
482 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
483 for INSTALLSITELIB and INSTALLSITEARCH.
484 .PP
485 MakeMaker gives you much more freedom than needed to configure
486 internal variables and get different results. It is worth mentioning
487 that \fBmake\fR\|(1) also lets you configure most of the variables that are
488 used in the Makefile. But in the majority of situations this will not
489 be necessary, and should only be done if the author of a package
490 recommends it (or you know what you're doing).
491 .SS "Using Attributes and Parameters"
492 .IX Subsection "Using Attributes and Parameters"
493 The following attributes may be specified as arguments to \fBWriteMakefile()\fR
494 or as NAME=VALUE pairs on the command line. Attributes that became
495 available with later versions of MakeMaker are indicated.
496 .PP
497 In order to maintain portability of attributes with older versions of
498 MakeMaker you may want to use App::EUMM::Upgrade with your \f(CW\*(C`Makefile.PL\*(C'\fR.
499 .IP ABSTRACT 2
500 .IX Item "ABSTRACT"
501 One line description of the module. Will be included in PPD file.
502 .IP ABSTRACT_FROM 2
503 .IX Item "ABSTRACT_FROM"
504 Name of the file that contains the package description. MakeMaker looks
505 for a line in the POD matching /^($package\es\-\es)(.*)/. This is typically
506 the first line in the "=head1 NAME" section. \f(CW$2\fR becomes the abstract.
507 .IP AUTHOR 2
508 .IX Item "AUTHOR"
509 Array of strings containing name (and email address) of package author(s).
510 Is used in CPAN Meta files (META.yml or META.json) and PPD
511 (Perl Package Description) files for PPM (Perl Package Manager).
512 .IP BINARY_LOCATION 2
513 .IX Item "BINARY_LOCATION"
514 Used when creating PPD files for binary packages. It can be set to a
515 full or relative path or URL to the binary archive for a particular
516 architecture. For example:
517 .Sp
518 .Vb 1
519 \& perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
520 .Ve
521 .Sp
522 builds a PPD package that references a binary of the \f(CW\*(C`Agent\*(C'\fR package,
523 located in the \f(CW\*(C`x86\*(C'\fR directory relative to the PPD itself.
524 .IP BUILD_REQUIRES 2
525 .IX Item "BUILD_REQUIRES"
526 Available in version 6.55_03 and above.
527 .Sp
528 A hash of modules that are needed to build your module but not run it.
529 .Sp
530 This will go into the \f(CW\*(C`build_requires\*(C'\fR field of your \fIMETA.yml\fR and the \f(CW\*(C`build\*(C'\fR of the \f(CW\*(C`prereqs\*(C'\fR field of your \fIMETA.json\fR.
531 .Sp
532 Defaults to \f(CW\*(C`{ "ExtUtils::MakeMaker" => 0 }\*(C'\fR if this attribute is not specified.
533 .Sp
534 The format is the same as PREREQ_PM.
535 .IP C 2
536 .IX Item "C"
537 Ref to array of *.c file names. Initialised from a directory scan
538 and the values portion of the XS attribute hash. This is not
539 currently used by MakeMaker but may be handy in Makefile.PLs.
540 .IP CCFLAGS 2
541 .IX Item "CCFLAGS"
542 String that will be included in the compiler call command line between
543 the arguments INC and OPTIMIZE. Note that setting this will overwrite its
544 default value (\f(CW$Config::Config{ccflags}\fR); to preserve that, include
545 the default value directly, e.g.:
546 .Sp
547 .Vb 1
548 \& CCFLAGS => "$Config::Config{ccflags} ..."
549 .Ve
550 .Sp
551 The default value is taken from \f(CW$Config\fR{ccflags}. When overriding
552 CCFLAGS, make sure to include the \f(CW$Config\fR{ccflags} settings to avoid
553 binary incompatibilities.
554 .IP CONFIG 2
555 .IX Item "CONFIG"
556 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
557 config.sh. MakeMaker will add to CONFIG the following values anyway:
558 ar
559 cc
560 cccdlflags
561 ccdlflags
562 cpprun
563 dlext
564 dlsrc
565 ld
566 lddlflags
567 ldflags
568 libc
569 lib_ext
570 obj_ext
571 ranlib
572 sitelibexp
573 sitearchexp
574 so
575 .IP CONFIGURE 2
576 .IX Item "CONFIGURE"
577 CODE reference. The subroutine should return a hash reference. The
578 hash may contain further attributes, e.g. {LIBS => ...}, that have to
579 be determined by some evaluation method.
580 .IP CONFIGURE_REQUIRES 2
581 .IX Item "CONFIGURE_REQUIRES"
582 Available in version 6.52 and above.
583 .Sp
584 A hash of modules that are required to run Makefile.PL itself, but not
585 to run your distribution.
586 .Sp
587 This will go into the \f(CW\*(C`configure_requires\*(C'\fR field of your \fIMETA.yml\fR and the \f(CW\*(C`configure\*(C'\fR of the \f(CW\*(C`prereqs\*(C'\fR field of your \fIMETA.json\fR.
588 .Sp
589 Defaults to \f(CW\*(C`{ "ExtUtils::MakeMaker" => 0 }\*(C'\fR if this attribute is not specified.
590 .Sp
591 The format is the same as PREREQ_PM.
592 .IP DEFINE 2
593 .IX Item "DEFINE"
594 Something like \f(CW"\-DHAVE_UNISTD_H"\fR
595 .IP DESTDIR 2
596 .IX Item "DESTDIR"
597 This is the root directory into which the code will be installed. It
598 \&\fIprepends itself to the normal prefix\fR. For example, if your code
599 would normally go into \fI/usr/local/lib/perl\fR you could set DESTDIR=~/tmp/
600 and installation would go into \fI~/tmp/usr/local/lib/perl\fR.
601 .Sp
602 This is primarily of use for people who repackage Perl modules.
603 .Sp
604 NOTE: Due to the nature of make, it is important that you put the trailing
605 slash on your DESTDIR. \fI~/tmp/\fR not \fI~/tmp\fR.
606 .IP DIR 2
607 .IX Item "DIR"
608 Ref to array of subdirectories containing Makefile.PLs e.g. ['sdbm']
609 in ext/SDBM_File
610 .IP DISTNAME 2
611 .IX Item "DISTNAME"
612 A safe filename for the package.
613 .Sp
614 Defaults to NAME below but with :: replaced with \-.
615 .Sp
616 For example, Foo::Bar becomes Foo-Bar.
617 .IP DISTVNAME 2
618 .IX Item "DISTVNAME"
619 Your name for distributing the package with the version number
620 included. This is used by 'make dist' to name the resulting archive
621 file.
622 .Sp
623 Defaults to DISTNAME-VERSION.
624 .Sp
625 For example, version 1.04 of Foo::Bar becomes Foo\-Bar\-1.04.
626 .Sp
627 On some OS's where . has special meaning VERSION_SYM may be used in
628 place of VERSION.
629 .IP DLEXT 2
630 .IX Item "DLEXT"
631 Specifies the extension of the module's loadable object. For example:
632 .Sp
633 .Vb 1
634 \& DLEXT => \*(Aqunusual_ext\*(Aq, # Default value is $Config{so}
635 .Ve
636 .Sp
637 NOTE: When using this option to alter the extension of a module's
638 loadable object, it is also necessary that the module's pm file
639 specifies the same change:
640 .Sp
641 .Vb 1
642 \& local $DynaLoader::dl_dlext = \*(Aqunusual_ext\*(Aq;
643 .Ve
644 .IP DL_FUNCS 2
645 .IX Item "DL_FUNCS"
646 Hashref of symbol names for routines to be made available as universal
647 symbols. Each key/value pair consists of the package name and an
648 array of routine names in that package. Used only under AIX, OS/2,
649 VMS and Win32 at present. The routine names supplied will be expanded
650 in the same way as XSUB names are expanded by the \fBXS()\fR macro.
651 Defaults to
652 .Sp
653 .Vb 1
654 \& {"$(NAME)" => ["boot_$(NAME)" ] }
655 .Ve
656 .Sp
657 e.g.
658 .Sp
659 .Vb 2
660 \& {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
661 \& "NetconfigPtr" => [ \*(AqDESTROY\*(Aq] }
662 .Ve
663 .Sp
664 Please see the ExtUtils::Mksymlists documentation for more information
665 about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
666 .IP DL_VARS 2
667 .IX Item "DL_VARS"
668 Array of symbol names for variables to be made available as universal symbols.
669 Used only under AIX, OS/2, VMS and Win32 at present. Defaults to [].
670 (e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
671 .IP EXCLUDE_EXT 2
672 .IX Item "EXCLUDE_EXT"
673 Array of extension names to exclude when doing a static build. This
674 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
675 details. (e.g. [ qw( Socket POSIX ) ] )
676 .Sp
677 This attribute may be most useful when specified as a string on the
678 command line: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
679 .IP EXE_FILES 2
680 .IX Item "EXE_FILES"
681 Ref to array of executable files. The files will be copied to the
682 INST_SCRIPT directory. Make realclean will delete them from there
683 again.
684 .Sp
685 If your executables start with something like #!perl or
686 #!/usr/bin/perl MakeMaker will change this to the path of the perl
687 \&'Makefile.PL' was invoked with so the programs will be sure to run
688 properly even if perl is not in /usr/bin/perl.
689 .IP FIRST_MAKEFILE 2
690 .IX Item "FIRST_MAKEFILE"
691 The name of the Makefile to be produced. This is used for the second
692 Makefile that will be produced for the MAP_TARGET.
693 .Sp
694 Defaults to 'Makefile' or 'Descrip.MMS' on VMS.
695 .Sp
696 (Note: we couldn't use MAKEFILE because dmake uses this for something
697 else).
698 .IP FULLPERL 2
699 .IX Item "FULLPERL"
700 Perl binary able to run this extension, load XS modules, etc...
701 .IP FULLPERLRUN 2
702 .IX Item "FULLPERLRUN"
703 Like PERLRUN, except it uses FULLPERL.
704 .IP FULLPERLRUNINST 2
705 .IX Item "FULLPERLRUNINST"
706 Like PERLRUNINST, except it uses FULLPERL.
707 .IP FUNCLIST 2
708 .IX Item "FUNCLIST"
709 This provides an alternate means to specify function names to be
710 exported from the extension. Its value is a reference to an
711 array of function names to be exported by the extension. These
712 names are passed through unaltered to the linker options file.
713 .IP H 2
714 .IX Item "H"
715 Ref to array of *.h file names. Similar to C.
716 .IP IMPORTS 2
717 .IX Item "IMPORTS"
718 This attribute is used to specify names to be imported into the
719 extension. Takes a hash ref.
720 .Sp
721 It is only used on OS/2 and Win32.
722 .IP INC 2
723 .IX Item "INC"
724 Include file dirs eg: \f(CW"\-I/usr/5include \-I/path/to/inc"\fR
725 .IP INCLUDE_EXT 2
726 .IX Item "INCLUDE_EXT"
727 Array of extension names to be included when doing a static build.
728 MakeMaker will normally build with all of the installed extensions when
729 doing a static build, and that is usually the desired behavior. If
730 INCLUDE_EXT is present then MakeMaker will build only with those extensions
731 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
732 .Sp
733 It is not necessary to mention DynaLoader or the current extension when
734 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
735 only DynaLoader and the current extension will be included in the build.
736 .Sp
737 This attribute may be most useful when specified as a string on the
738 command line: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
739 .IP INSTALLARCHLIB 2
740 .IX Item "INSTALLARCHLIB"
741 Used by 'make install', which copies files from INST_ARCHLIB to this
742 directory if INSTALLDIRS is set to perl.
743 .IP INSTALLBIN 2
744 .IX Item "INSTALLBIN"
745 Directory to install binary files (e.g. tkperl) into if
746 INSTALLDIRS=perl.
747 .IP INSTALLDIRS 2
748 .IX Item "INSTALLDIRS"
749 Determines which of the sets of installation directories to choose:
750 perl, site or vendor. Defaults to site.
751 .IP INSTALLMAN1DIR 2
752 .IX Item "INSTALLMAN1DIR"
753 .PD 0
754 .IP INSTALLMAN3DIR 2
755 .IX Item "INSTALLMAN3DIR"
756 .PD
757 These directories get the man pages at 'make install' time if
758 INSTALLDIRS=perl. Defaults to \f(CW$Config\fR{installman*dir}.
759 .Sp
760 If set to 'none', no man pages will be installed.
761 .IP INSTALLPRIVLIB 2
762 .IX Item "INSTALLPRIVLIB"
763 Used by 'make install', which copies files from INST_LIB to this
764 directory if INSTALLDIRS is set to perl.
765 .Sp
766 Defaults to \f(CW$Config\fR{installprivlib}.
767 .IP INSTALLSCRIPT 2
768 .IX Item "INSTALLSCRIPT"
769 Available in version 6.30_02 and above.
770 .Sp
771 Used by 'make install' which copies files from INST_SCRIPT to this
772 directory if INSTALLDIRS=perl.
773 .IP INSTALLSITEARCH 2
774 .IX Item "INSTALLSITEARCH"
775 Used by 'make install', which copies files from INST_ARCHLIB to this
776 directory if INSTALLDIRS is set to site (default).
777 .IP INSTALLSITEBIN 2
778 .IX Item "INSTALLSITEBIN"
779 Used by 'make install', which copies files from INST_BIN to this
780 directory if INSTALLDIRS is set to site (default).
781 .IP INSTALLSITELIB 2
782 .IX Item "INSTALLSITELIB"
783 Used by 'make install', which copies files from INST_LIB to this
784 directory if INSTALLDIRS is set to site (default).
785 .IP INSTALLSITEMAN1DIR 2
786 .IX Item "INSTALLSITEMAN1DIR"
787 .PD 0
788 .IP INSTALLSITEMAN3DIR 2
789 .IX Item "INSTALLSITEMAN3DIR"
790 .PD
791 These directories get the man pages at 'make install' time if
792 INSTALLDIRS=site (default). Defaults to
793 $(SITEPREFIX)/man/man$(MAN*EXT).
794 .Sp
795 If set to 'none', no man pages will be installed.
796 .IP INSTALLSITESCRIPT 2
797 .IX Item "INSTALLSITESCRIPT"
798 Used by 'make install' which copies files from INST_SCRIPT to this
799 directory if INSTALLDIRS is set to site (default).
800 .IP INSTALLVENDORARCH 2
801 .IX Item "INSTALLVENDORARCH"
802 Used by 'make install', which copies files from INST_ARCHLIB to this
803 directory if INSTALLDIRS is set to vendor. Note that if you do not set
804 this, the value of INSTALLVENDORLIB will be used, which is probably not
805 what you want.
806 .IP INSTALLVENDORBIN 2
807 .IX Item "INSTALLVENDORBIN"
808 Used by 'make install', which copies files from INST_BIN to this
809 directory if INSTALLDIRS is set to vendor.
810 .IP INSTALLVENDORLIB 2
811 .IX Item "INSTALLVENDORLIB"
812 Used by 'make install', which copies files from INST_LIB to this
813 directory if INSTALLDIRS is set to vendor.
814 .IP INSTALLVENDORMAN1DIR 2
815 .IX Item "INSTALLVENDORMAN1DIR"
816 .PD 0
817 .IP INSTALLVENDORMAN3DIR 2
818 .IX Item "INSTALLVENDORMAN3DIR"
819 .PD
820 These directories get the man pages at 'make install' time if
821 INSTALLDIRS=vendor. Defaults to $(VENDORPREFIX)/man/man$(MAN*EXT).
822 .Sp
823 If set to 'none', no man pages will be installed.
824 .IP INSTALLVENDORSCRIPT 2
825 .IX Item "INSTALLVENDORSCRIPT"
826 Available in version 6.30_02 and above.
827 .Sp
828 Used by 'make install' which copies files from INST_SCRIPT to this
829 directory if INSTALLDIRS is set to vendor.
830 .IP INST_ARCHLIB 2
831 .IX Item "INST_ARCHLIB"
832 Same as INST_LIB for architecture dependent files.
833 .IP INST_BIN 2
834 .IX Item "INST_BIN"
835 Directory to put real binary files during 'make'. These will be copied
836 to INSTALLBIN during 'make install'
837 .IP INST_LIB 2
838 .IX Item "INST_LIB"
839 Directory where we put library files of this extension while building
840 it.
841 .IP INST_MAN1DIR 2
842 .IX Item "INST_MAN1DIR"
843 Directory to hold the man pages at 'make' time
844 .IP INST_MAN3DIR 2
845 .IX Item "INST_MAN3DIR"
846 Directory to hold the man pages at 'make' time
847 .IP INST_SCRIPT 2
848 .IX Item "INST_SCRIPT"
849 Directory where executable files should be installed during
850 \&'make'. Defaults to "./blib/script", just to have a dummy location during
851 testing. make install will copy the files in INST_SCRIPT to
852 INSTALLSCRIPT.
853 .IP LD 2
854 .IX Item "LD"
855 Program to be used to link libraries for dynamic loading.
856 .Sp
857 Defaults to \f(CW$Config\fR{ld}.
858 .IP LDDLFLAGS 2
859 .IX Item "LDDLFLAGS"
860 Any special flags that might need to be passed to ld to create a
861 shared library suitable for dynamic loading. It is up to the makefile
862 to use it. (See "lddlflags" in Config)
863 .Sp
864 Defaults to \f(CW$Config\fR{lddlflags}.
865 .IP LDFROM 2
866 .IX Item "LDFROM"
867 Defaults to "$(OBJECT)" and is used in the ld command to specify
868 what files to link/load from (also see dynamic_lib below for how to
869 specify ld flags)
870 .IP LIB 2
871 .IX Item "LIB"
872 LIB should only be set at \f(CW\*(C`perl Makefile.PL\*(C'\fR time but is allowed as a
873 MakeMaker argument. It has the effect of setting both INSTALLPRIVLIB
874 and INSTALLSITELIB to that value regardless any explicit setting of
875 those arguments (or of PREFIX). INSTALLARCHLIB and INSTALLSITEARCH
876 are set to the corresponding architecture subdirectory.
877 .IP LIBPERL_A 2
878 .IX Item "LIBPERL_A"
879 The filename of the perllibrary that will be used together with this
880 extension. Defaults to libperl.a.
881 .IP LIBS 2
882 .IX Item "LIBS"
883 An anonymous array of alternative library
884 specifications to be searched for (in order) until
885 at least one library is found. E.g.
886 .Sp
887 .Vb 1
888 \& \*(AqLIBS\*(Aq => ["\-lgdbm", "\-ldbm \-lfoo", "\-L/path \-ldbm.nfs"]
889 .Ve
890 .Sp
891 Mind, that any element of the array
892 contains a complete set of arguments for the ld
893 command. So do not specify
894 .Sp
895 .Vb 1
896 \& \*(AqLIBS\*(Aq => ["\-ltcl", "\-ltk", "\-lX11"]
897 .Ve
898 .Sp
899 See ODBM_File/Makefile.PL for an example, where an array is needed. If
900 you specify a scalar as in
901 .Sp
902 .Vb 1
903 \& \*(AqLIBS\*(Aq => "\-ltcl \-ltk \-lX11"
904 .Ve
905 .Sp
906 MakeMaker will turn it into an array with one element.
907 .IP LICENSE 2
908 .IX Item "LICENSE"
909 Available in version 6.31 and above.
910 .Sp
911 The licensing terms of your distribution. Generally it's "perl_5" for the
912 same license as Perl itself.
913 .Sp
914 See CPAN::Meta::Spec for the list of options.
915 .Sp
916 Defaults to "unknown".
917 .IP LINKTYPE 2
918 .IX Item "LINKTYPE"
919 \&'static' or 'dynamic' (default unless usedl=undef in
920 config.sh). Should only be used to force static linking (also see
921 linkext below).
922 .IP MAGICXS 2
923 .IX Item "MAGICXS"
924 Available in version 6.8305 and above.
925 .Sp
926 When this is set to \f(CW1\fR, \f(CW\*(C`OBJECT\*(C'\fR will be automagically derived from
927 \&\f(CW\*(C`O_FILES\*(C'\fR.
928 .IP MAKE 2
929 .IX Item "MAKE"
930 Available in version 6.30_01 and above.
931 .Sp
932 Variant of make you intend to run the generated Makefile with. This
933 parameter lets Makefile.PL know what make quirks to account for when
934 generating the Makefile.
935 .Sp
936 MakeMaker also honors the MAKE environment variable. This parameter
937 takes precedence.
938 .Sp
939 Currently the only significant values are 'dmake' and 'nmake' for Windows
940 users, instructing MakeMaker to generate a Makefile in the flavour of
941 DMake ("Dennis Vadura's Make") or Microsoft NMake respectively.
942 .Sp
943 Defaults to \f(CW$Config\fR{make}, which may go looking for a Make program
944 in your environment.
945 .Sp
946 How are you supposed to know what flavour of Make a Makefile has
947 been generated for if you didn't specify a value explicitly? Search
948 the generated Makefile for the definition of the MAKE variable,
949 which is used to recursively invoke the Make utility. That will tell
950 you what Make you're supposed to invoke the Makefile with.
951 .IP MAKEAPERL 2
952 .IX Item "MAKEAPERL"
953 Boolean which tells MakeMaker that it should include the rules to
954 make a perl. This is handled automatically as a switch by
955 MakeMaker. The user normally does not need it.
956 .IP MAKEFILE_OLD 2
957 .IX Item "MAKEFILE_OLD"
958 When 'make clean' or similar is run, the $(FIRST_MAKEFILE) will be
959 backed up at this location.
960 .Sp
961 Defaults to $(FIRST_MAKEFILE).old or $(FIRST_MAKEFILE)_old on VMS.
962 .IP MAN1PODS 2
963 .IX Item "MAN1PODS"
964 Hashref of pod-containing files. MakeMaker will default this to all
965 EXE_FILES files that include POD directives. The files listed
966 here will be converted to man pages and installed as was requested
967 at Configure time.
968 .Sp
969 This hash should map POD files (or scripts containing POD) to the
970 man file names under the \f(CW\*(C`blib/man1/\*(C'\fR directory, as in the following
971 example:
972 .Sp
973 .Vb 4
974 \& MAN1PODS => {
975 \& \*(Aqdoc/command.pod\*(Aq => \*(Aqblib/man1/command.1\*(Aq,
976 \& \*(Aqscripts/script.pl\*(Aq => \*(Aqblib/man1/script.1\*(Aq,
977 \& }
978 .Ve
979 .IP MAN3PODS 2
980 .IX Item "MAN3PODS"
981 Hashref that assigns to *.pm and *.pod files the files into which the
982 manpages are to be written. MakeMaker parses all *.pod and *.pm files
983 for POD directives. Files that contain POD will be the default keys of
984 the MAN3PODS hashref. These will then be converted to man pages during
985 \&\f(CW\*(C`make\*(C'\fR and will be installed during \f(CW\*(C`make install\*(C'\fR.
986 .Sp
987 Example similar to MAN1PODS.
988 .IP MAP_TARGET 2
989 .IX Item "MAP_TARGET"
990 If it is intended that a new perl binary be produced, this variable
991 may hold a name for that binary. Defaults to perl
992 .IP META_ADD 2
993 .IX Item "META_ADD"
994 .PD 0
995 .IP META_MERGE 2
996 .IX Item "META_MERGE"
997 .PD
998 Available in version 6.46 and above.
999 .Sp
1000 A hashref of items to add to the CPAN Meta file (\fIMETA.yml\fR or
1001 \&\fIMETA.json\fR).
1002 .Sp
1003 They differ in how they behave if they have the same key as the
1004 default metadata. META_ADD will override the default value with its
1005 own. META_MERGE will merge its value with the default.
1006 .Sp
1007 Unless you want to override the defaults, prefer META_MERGE so as to
1008 get the advantage of any future defaults.
1009 .Sp
1010 Where prereqs are concerned, if META_MERGE is used, prerequisites are merged
1011 with their counterpart \f(CWWriteMakefile()\fR argument
1012 (PREREQ_PM is merged into {prereqs}{runtime}{requires},
1013 BUILD_REQUIRES into \f(CW\*(C`{prereqs}{build}{requires}\*(C'\fR,
1014 CONFIGURE_REQUIRES into \f(CW\*(C`{prereqs}{configure}{requires}\*(C'\fR,
1015 and TEST_REQUIRES into \f(CW\*(C`{prereqs}{test}{requires})\*(C'\fR.
1016 When prereqs are specified with META_ADD, the only prerequisites added to the
1017 file come from the metadata, not \f(CWWriteMakefile()\fR arguments.
1018 .Sp
1019 Note that these configuration options are only used for generating \fIMETA.yml\fR
1020 and \fIMETA.json\fR \-\- they are NOT used for \fIMYMETA.yml\fR and \fIMYMETA.json\fR.
1021 Therefore data in these fields should NOT be used for dynamic (user-side)
1022 configuration.
1023 .Sp
1024 By default CPAN Meta specification \f(CW1.4\fR is used. In order to use
1025 CPAN Meta specification \f(CW2.0\fR, indicate with \f(CW\*(C`meta\-spec\*(C'\fR the version
1026 you want to use.
1027 .Sp
1028 .Vb 1
1029 \& META_MERGE => {
1030 \&
1031 \& "meta\-spec" => { version => 2 },
1032 \&
1033 \& resources => {
1034 \&
1035 \& repository => {
1036 \& type => \*(Aqgit\*(Aq,
1037 \& url => \*(Aqgit://github.com/Perl\-Toolchain\-Gang/ExtUtils\-MakeMaker.git\*(Aq,
1038 \& web => \*(Aqhttps://github.com/Perl\-Toolchain\-Gang/ExtUtils\-MakeMaker\*(Aq,
1039 \& },
1040 \&
1041 \& },
1042 \&
1043 \& },
1044 .Ve
1045 .IP MIN_PERL_VERSION 2
1046 .IX Item "MIN_PERL_VERSION"
1047 Available in version 6.48 and above.
1048 .Sp
1049 The minimum required version of Perl for this distribution.
1050 .Sp
1051 Either the 5.006001 or the 5.6.1 format is acceptable.
1052 .IP MYEXTLIB 2
1053 .IX Item "MYEXTLIB"
1054 If the extension links to a library that it builds, set this to the
1055 name of the library (see SDBM_File)
1056 .IP NAME 2
1057 .IX Item "NAME"
1058 The package representing the distribution. For example, \f(CW\*(C`Test::More\*(C'\fR
1059 or \f(CW\*(C`ExtUtils::MakeMaker\*(C'\fR. It will be used to derive information about
1060 the distribution such as the "DISTNAME", installation locations
1061 within the Perl library and where XS files will be looked for by
1062 default (see "XS").
1063 .Sp
1064 \&\f(CW\*(C`NAME\*(C'\fR \fImust\fR be a valid Perl package name and it \fImust\fR have an
1065 associated \f(CW\*(C`.pm\*(C'\fR file. For example, \f(CW\*(C`Foo::Bar\*(C'\fR is a valid \f(CW\*(C`NAME\*(C'\fR
1066 and there must exist \fIFoo/Bar.pm\fR. Any XS code should be in
1067 \&\fIBar.xs\fR unless stated otherwise.
1068 .Sp
1069 Your distribution \fBmust\fR have a \f(CW\*(C`NAME\*(C'\fR.
1070 .IP NEEDS_LINKING 2
1071 .IX Item "NEEDS_LINKING"
1072 MakeMaker will figure out if an extension contains linkable code
1073 anywhere down the directory tree, and will set this variable
1074 accordingly, but you can speed it up a very little bit if you define
1075 this boolean variable yourself.
1076 .IP NOECHO 2
1077 .IX Item "NOECHO"
1078 Command so make does not print the literal commands it's running.
1079 .Sp
1080 By setting it to an empty string you can generate a Makefile that
1081 prints all commands. Mainly used in debugging MakeMaker itself.
1082 .Sp
1083 Defaults to \f(CW\*(C`@\*(C'\fR.
1084 .IP NORECURS 2
1085 .IX Item "NORECURS"
1086 Boolean. Attribute to inhibit descending into subdirectories.
1087 .IP NO_META 2
1088 .IX Item "NO_META"
1089 When true, suppresses the generation and addition to the MANIFEST of
1090 the META.yml and META.json module meta-data files during 'make distdir'.
1091 .Sp
1092 Defaults to false.
1093 .IP NO_MYMETA 2
1094 .IX Item "NO_MYMETA"
1095 Available in version 6.57_02 and above.
1096 .Sp
1097 When true, suppresses the generation of MYMETA.yml and MYMETA.json module
1098 meta-data files during 'perl Makefile.PL'.
1099 .Sp
1100 Defaults to false.
1101 .IP NO_PACKLIST 2
1102 .IX Item "NO_PACKLIST"
1103 Available in version 6.7501 and above.
1104 .Sp
1105 When true, suppresses the writing of \f(CW\*(C`packlist\*(C'\fR files for installs.
1106 .Sp
1107 Defaults to false.
1108 .IP NO_PERLLOCAL 2
1109 .IX Item "NO_PERLLOCAL"
1110 Available in version 6.7501 and above.
1111 .Sp
1112 When true, suppresses the appending of installations to \f(CW\*(C`perllocal\*(C'\fR.
1113 .Sp
1114 Defaults to false.
1115 .IP NO_VC 2
1116 .IX Item "NO_VC"
1117 In general, any generated Makefile checks for the current version of
1118 MakeMaker and the version the Makefile was built under. If NO_VC is
1119 set, the version check is neglected. Do not write this into your
1120 Makefile.PL, use it interactively instead.
1121 .IP OBJECT 2
1122 .IX Item "OBJECT"
1123 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1124 string or an array containing all object files, e.g. "tkpBind.o
1125 tkpButton.o tkpCanvas.o" or ["tkpBind.o", "tkpButton.o", "tkpCanvas.o"]
1126 .Sp
1127 (Where BASEEXT is the last component of NAME, and OBJ_EXT is \f(CW$Config\fR{obj_ext}.)
1128 .IP OPTIMIZE 2
1129 .IX Item "OPTIMIZE"
1130 Defaults to \f(CW\*(C`\-O\*(C'\fR. Set it to \f(CW\*(C`\-g\*(C'\fR to turn debugging on. The flag is
1131 passed to subdirectory makes.
1132 .IP PERL 2
1133 .IX Item "PERL"
1134 Perl binary for tasks that can be done by miniperl. If it contains
1135 spaces or other shell metacharacters, it needs to be quoted in a way
1136 that protects them, since this value is intended to be inserted in a
1137 shell command line in the Makefile. E.g.:
1138 .Sp
1139 .Vb 3
1140 \& # Perl executable lives in "C:/Program Files/Perl/bin"
1141 \& # Normally you don\*(Aqt need to set this yourself!
1142 \& $ perl Makefile.PL PERL=\*(Aq"C:/Program Files/Perl/bin/perl.exe" \-w\*(Aq
1143 .Ve
1144 .IP PERL_CORE 2
1145 .IX Item "PERL_CORE"
1146 Set only when MakeMaker is building the extensions of the Perl core
1147 distribution.
1148 .IP PERLMAINCC 2
1149 .IX Item "PERLMAINCC"
1150 The call to the program that is able to compile perlmain.c. Defaults
1151 to $(CC).
1152 .IP PERL_ARCHLIB 2
1153 .IX Item "PERL_ARCHLIB"
1154 Same as for PERL_LIB, but for architecture dependent files.
1155 .Sp
1156 Used only when MakeMaker is building the extensions of the Perl core
1157 distribution (because normally $(PERL_ARCHLIB) is automatically in \f(CW@INC\fR,
1158 and adding it would get in the way of PERL5LIB).
1159 .IP PERL_LIB 2
1160 .IX Item "PERL_LIB"
1161 Directory containing the Perl library to use.
1162 .Sp
1163 Used only when MakeMaker is building the extensions of the Perl core
1164 distribution (because normally $(PERL_LIB) is automatically in \f(CW@INC\fR,
1165 and adding it would get in the way of PERL5LIB).
1166 .IP PERL_MALLOC_OK 2
1167 .IX Item "PERL_MALLOC_OK"
1168 defaults to 0. Should be set to TRUE if the extension can work with
1169 the memory allocation routines substituted by the Perl \fBmalloc()\fR subsystem.
1170 This should be applicable to most extensions with exceptions of those
1171 .RS 2
1172 .IP \(bu 4
1173 with bugs in memory allocations which are caught by Perl's \fBmalloc()\fR;
1174 .IP \(bu 4
1175 which interact with the memory allocator in other ways than via
1176 \&\fBmalloc()\fR, \fBrealloc()\fR, \fBfree()\fR, \fBcalloc()\fR, \fBsbrk()\fR and \fBbrk()\fR;
1177 .IP \(bu 4
1178 which rely on special alignment which is not provided by Perl's \fBmalloc()\fR.
1179 .RE
1180 .RS 2
1181 .Sp
1182 \&\fBNOTE.\fR Neglecting to set this flag in \fIany one\fR of the loaded extension
1183 nullifies many advantages of Perl's \fBmalloc()\fR, such as better usage of
1184 system resources, error detection, memory usage reporting, catchable failure
1185 of memory allocations, etc.
1186 .RE
1187 .IP PERLPREFIX 2
1188 .IX Item "PERLPREFIX"
1189 Directory under which core modules are to be installed.
1190 .Sp
1191 Defaults to \f(CW$Config\fR{installprefixexp}, falling back to
1192 \&\f(CW$Config\fR{installprefix}, \f(CW$Config\fR{prefixexp} or \f(CW$Config\fR{prefix} should
1193 \&\f(CW$Config\fR{installprefixexp} not exist.
1194 .Sp
1195 Overridden by PREFIX.
1196 .IP PERLRUN 2
1197 .IX Item "PERLRUN"
1198 Use this instead of $(PERL) when you wish to run perl. It will set up
1199 extra necessary flags for you.
1200 .IP PERLRUNINST 2
1201 .IX Item "PERLRUNINST"
1202 Use this instead of $(PERL) when you wish to run perl to work with
1203 modules. It will add things like \-I$(INST_ARCH) and other necessary
1204 flags so perl can see the modules you're about to install.
1205 .IP PERL_SRC 2
1206 .IX Item "PERL_SRC"
1207 Directory containing the Perl source code (use of this should be
1208 avoided, it may be undefined)
1209 .IP PERM_DIR 2
1210 .IX Item "PERM_DIR"
1211 Available in version 6.51_01 and above.
1212 .Sp
1213 Desired permission for directories. Defaults to \f(CW755\fR.
1214 .IP PERM_RW 2
1215 .IX Item "PERM_RW"
1216 Desired permission for read/writable files. Defaults to \f(CW644\fR.
1217 .IP PERM_RWX 2
1218 .IX Item "PERM_RWX"
1219 Desired permission for executable files. Defaults to \f(CW755\fR.
1220 .IP PL_FILES 2
1221 .IX Item "PL_FILES"
1222 MakeMaker can run programs to generate files for you at build time.
1223 By default any file named *.PL (except Makefile.PL and Build.PL) in
1224 the top level directory will be assumed to be a Perl program and run
1225 passing its own basename in as an argument. This basename is actually a build
1226 target, and there is an intention, but not a requirement, that the *.PL file
1227 make the file passed to to as an argument. For example...
1228 .Sp
1229 .Vb 1
1230 \& perl foo.PL foo
1231 .Ve
1232 .Sp
1233 This behavior can be overridden by supplying your own set of files to
1234 search. PL_FILES accepts a hash ref, the key being the file to run
1235 and the value is passed in as the first argument when the PL file is run.
1236 .Sp
1237 .Vb 1
1238 \& PL_FILES => {\*(Aqbin/foobar.PL\*(Aq => \*(Aqbin/foobar\*(Aq}
1239 \&
1240 \& PL_FILES => {\*(Aqfoo.PL\*(Aq => \*(Aqfoo.c\*(Aq}
1241 .Ve
1242 .Sp
1243 Would run bin/foobar.PL like this:
1244 .Sp
1245 .Vb 1
1246 \& perl bin/foobar.PL bin/foobar
1247 .Ve
1248 .Sp
1249 If multiple files from one program are desired an array ref can be used.
1250 .Sp
1251 .Vb 1
1252 \& PL_FILES => {\*(Aqbin/foobar.PL\*(Aq => [qw(bin/foobar1 bin/foobar2)]}
1253 .Ve
1254 .Sp
1255 In this case the program will be run multiple times using each target file.
1256 .Sp
1257 .Vb 2
1258 \& perl bin/foobar.PL bin/foobar1
1259 \& perl bin/foobar.PL bin/foobar2
1260 .Ve
1261 .Sp
1262 If an output file depends on extra input files beside the script itself,
1263 a hash ref can be used in version 7.36 and above:
1264 .Sp
1265 .Vb 4
1266 \& PL_FILES => { \*(Aqfoo.PL\*(Aq => {
1267 \& \*(Aqfoo.out\*(Aq => \*(Aqfoo.in\*(Aq,
1268 \& \*(Aqbar.out\*(Aq => [qw(bar1.in bar2.in)],
1269 \& }
1270 .Ve
1271 .Sp
1272 In this case the extra input files will be passed to the program after
1273 the target file:
1274 .Sp
1275 .Vb 2
1276 \& perl foo.PL foo.out foo.in
1277 \& perl foo.PL bar.out bar1.in bar2.in
1278 .Ve
1279 .Sp
1280 PL files are normally run \fBafter\fR pm_to_blib and include INST_LIB and
1281 INST_ARCH in their \f(CW@INC\fR, so the just built modules can be
1282 accessed... unless the PL file is making a module (or anything else in
1283 PM) in which case it is run \fBbefore\fR pm_to_blib and does not include
1284 INST_LIB and INST_ARCH in its \f(CW@INC\fR. This apparently odd behavior
1285 is there for backwards compatibility (and it's somewhat DWIM). The argument
1286 passed to the .PL is set up as a target to build in the Makefile. In other
1287 sections such as \f(CW\*(C`postamble\*(C'\fR you can specify a dependency on the
1288 filename/argument that the .PL is supposed (or will have, now that that is
1289 is a dependency) to generate. Note the file to be generated will still be
1290 generated and the .PL will still run even without an explicit dependency created
1291 by you, since the \f(CW\*(C`all\*(C'\fR target still depends on running all eligible to run.PL
1292 files.
1293 .IP PM 2
1294 .IX Item "PM"
1295 Hashref of .pm files and *.pl files to be installed. e.g.
1296 .Sp
1297 .Vb 1
1298 \& {\*(Aqname_of_file.pm\*(Aq => \*(Aq$(INST_LIB)/install_as.pm\*(Aq}
1299 .Ve
1300 .Sp
1301 By default this will include *.pm and *.pl and the files found in
1302 the PMLIBDIRS directories. Defining PM in the
1303 Makefile.PL will override PMLIBDIRS.
1304 .IP PMLIBDIRS 2
1305 .IX Item "PMLIBDIRS"
1306 Ref to array of subdirectories containing library files. Defaults to
1307 [ 'lib', $(BASEEXT) ]. The directories will be scanned and \fIany\fR files
1308 they contain will be installed in the corresponding location in the
1309 library. A \fBlibscan()\fR method can be used to alter the behaviour.
1310 Defining PM in the Makefile.PL will override PMLIBDIRS.
1311 .Sp
1312 (Where BASEEXT is the last component of NAME.)
1313 .IP PM_FILTER 2
1314 .IX Item "PM_FILTER"
1315 A filter program, in the traditional Unix sense (input from stdin, output
1316 to stdout) that is passed on each .pm file during the build (in the
1317 \&\fBpm_to_blib()\fR phase). It is empty by default, meaning no filtering is done.
1318 You could use:
1319 .Sp
1320 .Vb 1
1321 \& PM_FILTER => \*(Aqperl \-ne "print unless /^\e\e#/"\*(Aq,
1322 .Ve
1323 .Sp
1324 to remove all the leading comments on the fly during the build. In order
1325 to be as portable as possible, please consider using a Perl one-liner
1326 rather than Unix (or other) utilities, as above. The # is escaped for
1327 the Makefile, since what is going to be generated will then be:
1328 .Sp
1329 .Vb 1
1330 \& PM_FILTER = perl \-ne "print unless /^\e#/"
1331 .Ve
1332 .Sp
1333 Without the \e before the #, we'd have the start of a Makefile comment,
1334 and the macro would be incorrectly defined.
1335 .Sp
1336 You will almost certainly be better off using the \f(CW\*(C`PL_FILES\*(C'\fR system,
1337 instead. See above, or the ExtUtils::MakeMaker::FAQ entry.
1338 .IP POLLUTE 2
1339 .IX Item "POLLUTE"
1340 Prior to 5.6 various interpreter variables were available without a \f(CW\*(C`PL_\*(C'\fR
1341 prefix, eg. \f(CW\*(C`PL_undef\*(C'\fR was available as \f(CW\*(C`undef\*(C'\fR. As of release 5.6, these
1342 are only defined if the POLLUTE flag is enabled:
1343 .Sp
1344 .Vb 1
1345 \& perl Makefile.PL POLLUTE=1
1346 .Ve
1347 .Sp
1348 Please inform the module author if this is necessary to successfully install
1349 a module under 5.6 or later.
1350 .IP PPM_INSTALL_EXEC 2
1351 .IX Item "PPM_INSTALL_EXEC"
1352 Name of the executable used to run \f(CW\*(C`PPM_INSTALL_SCRIPT\*(C'\fR below. (e.g. perl)
1353 .IP PPM_INSTALL_SCRIPT 2
1354 .IX Item "PPM_INSTALL_SCRIPT"
1355 Name of the script that gets executed by the Perl Package Manager after
1356 the installation of a package.
1357 .IP PPM_UNINSTALL_EXEC 2
1358 .IX Item "PPM_UNINSTALL_EXEC"
1359 Available in version 6.8502 and above.
1360 .Sp
1361 Name of the executable used to run \f(CW\*(C`PPM_UNINSTALL_SCRIPT\*(C'\fR below. (e.g. perl)
1362 .IP PPM_UNINSTALL_SCRIPT 2
1363 .IX Item "PPM_UNINSTALL_SCRIPT"
1364 Available in version 6.8502 and above.
1365 .Sp
1366 Name of the script that gets executed by the Perl Package Manager before
1367 the removal of a package.
1368 .IP PREFIX 2
1369 .IX Item "PREFIX"
1370 This overrides all the default install locations. Man pages,
1371 libraries, scripts, etc... MakeMaker will try to make an educated
1372 guess about where to place things under the new PREFIX based on your
1373 Config defaults. Failing that, it will fall back to a structure
1374 which should be sensible for your platform.
1375 .Sp
1376 If you specify LIB or any INSTALL* variables they will not be affected
1377 by the PREFIX.
1378 .IP PREREQ_FATAL 2
1379 .IX Item "PREREQ_FATAL"
1380 Bool. If this parameter is true, failing to have the required modules
1381 (or the right versions thereof) will be fatal. \f(CW\*(C`perl Makefile.PL\*(C'\fR
1382 will \f(CW\*(C`die\*(C'\fR instead of simply informing the user of the missing dependencies.
1383 .Sp
1384 It is \fIextremely\fR rare to have to use \f(CW\*(C`PREREQ_FATAL\*(C'\fR. Its use by module
1385 authors is \fIstrongly discouraged\fR and should never be used lightly.
1386 .Sp
1387 For dependencies that are required in order to run \f(CW\*(C`Makefile.PL\*(C'\fR,
1388 see \f(CW\*(C`CONFIGURE_REQUIRES\*(C'\fR.
1389 .Sp
1390 Module installation tools have ways of resolving unmet dependencies but
1391 to do that they need a \fIMakefile\fR. Using \f(CW\*(C`PREREQ_FATAL\*(C'\fR breaks this.
1392 That's bad.
1393 .Sp
1394 Assuming you have good test coverage, your tests should fail with
1395 missing dependencies informing the user more strongly that something
1396 is wrong. You can write a \fIt/00compile.t\fR test which will simply
1397 check that your code compiles and stop "make test" prematurely if it
1398 doesn't. See "BAIL_OUT" in Test::More for more details.
1399 .IP PREREQ_PM 2
1400 .IX Item "PREREQ_PM"
1401 A hash of modules that are needed to run your module. The keys are
1402 the module names ie. Test::More, and the minimum version is the
1403 value. If the required version number is 0 any version will do.
1404 The versions given may be a Perl v\-string (see version) or a range
1405 (see CPAN::Meta::Requirements).
1406 .Sp
1407 This will go into the \f(CW\*(C`requires\*(C'\fR field of your \fIMETA.yml\fR and the
1408 \&\f(CW\*(C`runtime\*(C'\fR of the \f(CW\*(C`prereqs\*(C'\fR field of your \fIMETA.json\fR.
1409 .Sp
1410 .Vb 3
1411 \& PREREQ_PM => {
1412 \& # Require Test::More at least 0.47
1413 \& "Test::More" => "0.47",
1414 \&
1415 \& # Require any version of Acme::Buffy
1416 \& "Acme::Buffy" => 0,
1417 \& }
1418 .Ve
1419 .IP PREREQ_PRINT 2
1420 .IX Item "PREREQ_PRINT"
1421 Bool. If this parameter is true, the prerequisites will be printed to
1422 stdout and MakeMaker will exit. The output format is an evalable hash
1423 ref.
1424 .Sp
1425 .Vb 5
1426 \& $PREREQ_PM = {
1427 \& \*(AqA::B\*(Aq => Vers1,
1428 \& \*(AqC::D\*(Aq => Vers2,
1429 \& ...
1430 \& };
1431 .Ve
1432 .Sp
1433 If a distribution defines a minimal required perl version, this is
1434 added to the output as an additional line of the form:
1435 .Sp
1436 .Vb 1
1437 \& $MIN_PERL_VERSION = \*(Aq5.008001\*(Aq;
1438 .Ve
1439 .Sp
1440 If BUILD_REQUIRES is not empty, it will be dumped as \f(CW$BUILD_REQUIRES\fR hashref.
1441 .IP PRINT_PREREQ 2
1442 .IX Item "PRINT_PREREQ"
1443 RedHatism for \f(CW\*(C`PREREQ_PRINT\*(C'\fR. The output format is different, though:
1444 .Sp
1445 .Vb 1
1446 \& perl(A::B)>=Vers1 perl(C::D)>=Vers2 ...
1447 .Ve
1448 .Sp
1449 A minimal required perl version, if present, will look like this:
1450 .Sp
1451 .Vb 1
1452 \& perl(perl)>=5.008001
1453 .Ve
1454 .IP SITEPREFIX 2
1455 .IX Item "SITEPREFIX"
1456 Like PERLPREFIX, but only for the site install locations.
1457 .Sp
1458 Defaults to \f(CW$Config\fR{siteprefixexp}. Perls prior to 5.6.0 didn't have
1459 an explicit siteprefix in the Config. In those cases
1460 \&\f(CW$Config\fR{installprefix} will be used.
1461 .Sp
1462 Overridable by PREFIX
1463 .IP SIGN 2
1464 .IX Item "SIGN"
1465 Available in version 6.18 and above.
1466 .Sp
1467 When true, perform the generation and addition to the MANIFEST of the
1468 SIGNATURE file in the distdir during 'make distdir', via 'cpansign
1469 \&\-s'.
1470 .Sp
1471 Note that you need to install the Module::Signature module to
1472 perform this operation.
1473 .Sp
1474 Defaults to false.
1475 .IP SKIP 2
1476 .IX Item "SKIP"
1477 Arrayref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1478 Makefile. Caution! Do not use the SKIP attribute for the negligible
1479 speedup. It may seriously damage the resulting Makefile. Only use it
1480 if you really need it.
1481 .IP TEST_REQUIRES 2
1482 .IX Item "TEST_REQUIRES"
1483 Available in version 6.64 and above.
1484 .Sp
1485 A hash of modules that are needed to test your module but not run or
1486 build it.
1487 .Sp
1488 This will go into the \f(CW\*(C`build_requires\*(C'\fR field of your \fIMETA.yml\fR and the \f(CW\*(C`test\*(C'\fR of the \f(CW\*(C`prereqs\*(C'\fR field of your \fIMETA.json\fR.
1489 .Sp
1490 The format is the same as PREREQ_PM.
1491 .IP TYPEMAPS 2
1492 .IX Item "TYPEMAPS"
1493 Ref to array of typemap file names. Use this when the typemaps are
1494 in some directory other than the current directory or when they are
1495 not named \fBtypemap\fR. The last typemap in the list takes
1496 precedence. A typemap in the current directory has highest
1497 precedence, even if it isn't listed in TYPEMAPS. The default system
1498 typemap has lowest precedence.
1499 .IP VENDORPREFIX 2
1500 .IX Item "VENDORPREFIX"
1501 Like PERLPREFIX, but only for the vendor install locations.
1502 .Sp
1503 Defaults to \f(CW$Config\fR{vendorprefixexp}.
1504 .Sp
1505 Overridable by PREFIX
1506 .IP VERBINST 2
1507 .IX Item "VERBINST"
1508 If true, make install will be verbose
1509 .IP VERSION 2
1510 .IX Item "VERSION"
1511 Your version number for distributing the package. This defaults to
1512 0.1.
1513 .IP VERSION_FROM 2
1514 .IX Item "VERSION_FROM"
1515 Instead of specifying the VERSION in the Makefile.PL you can let
1516 MakeMaker parse a file to determine the version number. The parsing
1517 routine requires that the file named by VERSION_FROM contains one
1518 single line to compute the version number. The first line in the file
1519 that contains something like a \f(CW$VERSION\fR assignment or \f(CW\*(C`package Name
1520 VERSION\*(C'\fR will be used. The following lines will be parsed o.k.:
1521 .Sp
1522 .Vb 7
1523 \& # Good
1524 \& package Foo::Bar 1.23; # 1.23
1525 \& $VERSION = \*(Aq1.00\*(Aq; # 1.00
1526 \& *VERSION = \e\*(Aq1.01\*(Aq; # 1.01
1527 \& ($VERSION) = q$Revision$ =~ /(\ed+)/g; # The digits in $Revision$
1528 \& $FOO::VERSION = \*(Aq1.10\*(Aq; # 1.10
1529 \& *FOO::VERSION = \e\*(Aq1.11\*(Aq; # 1.11
1530 .Ve
1531 .Sp
1532 but these will fail:
1533 .Sp
1534 .Vb 4
1535 \& # Bad
1536 \& my $VERSION = \*(Aq1.01\*(Aq;
1537 \& local $VERSION = \*(Aq1.02\*(Aq;
1538 \& local $FOO::VERSION = \*(Aq1.30\*(Aq;
1539 .Ve
1540 .Sp
1541 (Putting \f(CW\*(C`my\*(C'\fR or \f(CW\*(C`local\*(C'\fR on the preceding line will work o.k.)
1542 .Sp
1543 "Version strings" are incompatible and should not be used.
1544 .Sp
1545 .Vb 3
1546 \& # Bad
1547 \& $VERSION = 1.2.3;
1548 \& $VERSION = v1.2.3;
1549 .Ve
1550 .Sp
1551 version objects are fine. As of MakeMaker 6.35 version.pm will be
1552 automatically loaded, but you must declare the dependency on version.pm.
1553 For compatibility with older MakeMaker you should load on the same line
1554 as \f(CW$VERSION\fR is declared.
1555 .Sp
1556 .Vb 2
1557 \& # All on one line
1558 \& use version; our $VERSION = qv(1.2.3);
1559 .Ve
1560 .Sp
1561 The file named in VERSION_FROM is not added as a dependency to
1562 Makefile. This is not really correct, but it would be a major pain
1563 during development to have to rewrite the Makefile for any smallish
1564 change in that file. If you want to make sure that the Makefile
1565 contains the correct VERSION macro after any change of the file, you
1566 would have to do something like
1567 .Sp
1568 .Vb 1
1569 \& depend => { Makefile => \*(Aq$(VERSION_FROM)\*(Aq }
1570 .Ve
1571 .Sp
1572 See attribute \f(CW\*(C`depend\*(C'\fR below.
1573 .IP VERSION_SYM 2
1574 .IX Item "VERSION_SYM"
1575 A sanitized VERSION with . replaced by _. For places where . has
1576 special meaning (some filesystems, RCS labels, etc...)
1577 .IP XS 2
1578 .IX Item "XS"
1579 Hashref of .xs files. MakeMaker will default this. e.g.
1580 .Sp
1581 .Vb 1
1582 \& {\*(Aqname_of_file.xs\*(Aq => \*(Aqname_of_file.c\*(Aq}
1583 .Ve
1584 .Sp
1585 The .c files will automatically be included in the list of files
1586 deleted by a make clean.
1587 .IP XSBUILD 2
1588 .IX Item "XSBUILD"
1589 Available in version 7.12 and above.
1590 .Sp
1591 Hashref with options controlling the operation of \f(CW\*(C`XSMULTI\*(C'\fR:
1592 .Sp
1593 .Vb 10
1594 \& {
1595 \& xs => {
1596 \& all => {
1597 \& # options applying to all .xs files for this distribution
1598 \& },
1599 \& \*(Aqlib/Class/Name/File\*(Aq => { # specifically for this file
1600 \& DEFINE => \*(Aq\-Dfunktastic\*(Aq, # defines for only this file
1601 \& INC => "\-I$funkyliblocation", # include flags for only this file
1602 \& # OBJECT => \*(Aqlib/Class/Name/File$(OBJ_EXT)\*(Aq, # default
1603 \& LDFROM => "lib/Class/Name/File\e$(OBJ_EXT) $otherfile\e$(OBJ_EXT)", # what\*(Aqs linked
1604 \& },
1605 \& },
1606 \& }
1607 .Ve
1608 .Sp
1609 Note \f(CW\*(C`xs\*(C'\fR is the file-extension. More possibilities may arise in the
1610 future. Note that object names are specified without their XS extension.
1611 .Sp
1612 \&\f(CW\*(C`LDFROM\*(C'\fR defaults to the same as \f(CW\*(C`OBJECT\*(C'\fR. \f(CW\*(C`OBJECT\*(C'\fR defaults to,
1613 for \f(CW\*(C`XSMULTI\*(C'\fR, just the XS filename with the extension replaced with
1614 the compiler-specific object-file extension.
1615 .Sp
1616 The distinction between \f(CW\*(C`OBJECT\*(C'\fR and \f(CW\*(C`LDFROM\*(C'\fR: \f(CW\*(C`OBJECT\*(C'\fR is the make
1617 target, so make will try to build it. However, \f(CW\*(C`LDFROM\*(C'\fR is what will
1618 actually be linked together to make the shared object or static library
1619 (SO/SL), so if you override it, make sure it includes what you want to
1620 make the final SO/SL, almost certainly including the XS basename with
1621 \&\f(CW\*(C`$(OBJ_EXT)\*(C'\fR appended.
1622 .IP XSMULTI 2
1623 .IX Item "XSMULTI"
1624 Available in version 7.12 and above.
1625 .Sp
1626 When this is set to \f(CW1\fR, multiple XS files may be placed under \fIlib/\fR
1627 next to their corresponding \f(CW\*(C`*.pm\*(C'\fR files (this is essential for compiling
1628 with the correct \f(CW\*(C`VERSION\*(C'\fR values). This feature should be considered
1629 experimental, and details of it may change.
1630 .Sp
1631 This feature was inspired by, and small portions of code copied from,
1632 ExtUtils::MakeMaker::BigHelper. Hopefully this feature will render
1633 that module mainly obsolete.
1634 .IP XSOPT 2
1635 .IX Item "XSOPT"
1636 String of options to pass to xsubpp. This might include \f(CW\*(C`\-C++\*(C'\fR or
1637 \&\f(CW\*(C`\-extern\*(C'\fR. Do not include typemaps here; the TYPEMAP parameter exists for
1638 that purpose.
1639 .IP XSPROTOARG 2
1640 .IX Item "XSPROTOARG"
1641 May be set to \f(CW\*(C`\-prototypes\*(C'\fR, \f(CW\*(C`\-noprototypes\*(C'\fR or the empty string. The
1642 empty string is equivalent to the xsubpp default, or \f(CW\*(C`\-noprototypes\*(C'\fR.
1643 See the xsubpp documentation for details. MakeMaker
1644 defaults to the empty string.
1645 .IP XS_VERSION 2
1646 .IX Item "XS_VERSION"
1647 Your version number for the .xs file of this package. This defaults
1648 to the value of the VERSION attribute.
1649 .SS "Additional lowercase attributes"
1650 .IX Subsection "Additional lowercase attributes"
1651 can be used to pass parameters to the methods which implement that
1652 part of the Makefile. Parameters are specified as a hash ref but are
1653 passed to the method as a hash.
1654 .IP clean 2
1655 .IX Item "clean"
1656 .Vb 1
1657 \& {FILES => "*.xyz foo"}
1658 .Ve
1659 .IP depend 2
1660 .IX Item "depend"
1661 .Vb 1
1662 \& {ANY_TARGET => ANY_DEPENDENCY, ...}
1663 .Ve
1664 .Sp
1665 (ANY_TARGET must not be given a double-colon rule by MakeMaker.)
1666 .IP dist 2
1667 .IX Item "dist"
1668 .Vb 3
1669 \& {TARFLAGS => \*(AqcvfF\*(Aq, COMPRESS => \*(Aqgzip\*(Aq, SUFFIX => \*(Aq.gz\*(Aq,
1670 \& SHAR => \*(Aqshar \-m\*(Aq, DIST_CP => \*(Aqln\*(Aq, ZIP => \*(Aq/bin/zip\*(Aq,
1671 \& ZIPFLAGS => \*(Aq\-rl\*(Aq, DIST_DEFAULT => \*(Aqprivate tardist\*(Aq }
1672 .Ve
1673 .Sp
1674 If you specify COMPRESS, then SUFFIX should also be altered, as it is
1675 needed to tell make the target file of the compression. Setting
1676 DIST_CP to ln can be useful, if you need to preserve the timestamps on
1677 your files. DIST_CP can take the values 'cp', which copies the file,
1678 \&'ln', which links the file, and 'best' which copies symbolic links and
1679 links the rest. Default is 'best'.
1680 .IP dynamic_lib 2
1681 .IX Item "dynamic_lib"
1682 .Vb 1
1683 \& {ARMAYBE => \*(Aqar\*(Aq, OTHERLDFLAGS => \*(Aq...\*(Aq, INST_DYNAMIC_DEP => \*(Aq...\*(Aq}
1684 .Ve
1685 .IP linkext 2
1686 .IX Item "linkext"
1687 .Vb 1
1688 \& {LINKTYPE => \*(Aqstatic\*(Aq, \*(Aqdynamic\*(Aq or \*(Aq\*(Aq}
1689 .Ve
1690 .Sp
1691 NB: Extensions that have nothing but *.pm files had to say
1692 .Sp
1693 .Vb 1
1694 \& {LINKTYPE => \*(Aq\*(Aq}
1695 .Ve
1696 .Sp
1697 with Pre\-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1698 can be deleted safely. MakeMaker recognizes when there's nothing to
1699 be linked.
1700 .IP macro 2
1701 .IX Item "macro"
1702 .Vb 1
1703 \& {ANY_MACRO => ANY_VALUE, ...}
1704 .Ve
1705 .IP postamble 2
1706 .IX Item "postamble"
1707 Anything put here will be passed to
1708 \&\fBMY::postamble()\fR if you have one.
1709 .IP realclean 2
1710 .IX Item "realclean"
1711 .Vb 1
1712 \& {FILES => \*(Aq$(INST_ARCHAUTODIR)/*.xyz\*(Aq}
1713 .Ve
1714 .IP test 2
1715 .IX Item "test"
1716 Specify the targets for testing.
1717 .Sp
1718 .Vb 1
1719 \& {TESTS => \*(Aqt/*.t\*(Aq}
1720 .Ve
1721 .Sp
1722 \&\f(CW\*(C`RECURSIVE_TEST_FILES\*(C'\fR can be used to include all directories
1723 recursively under \f(CW\*(C`t\*(C'\fR that contain \f(CW\*(C`.t\*(C'\fR files. It will be ignored if
1724 you provide your own \f(CW\*(C`TESTS\*(C'\fR attribute, defaults to false.
1725 .Sp
1726 .Vb 1
1727 \& {RECURSIVE_TEST_FILES=>1}
1728 .Ve
1729 .Sp
1730 This is supported since 6.76
1731 .IP tool_autosplit 2
1732 .IX Item "tool_autosplit"
1733 .Vb 1
1734 \& {MAXLEN => 8}
1735 .Ve
1736 .SS "Overriding MakeMaker Methods"
1737 .IX Subsection "Overriding MakeMaker Methods"
1738 If you cannot achieve the desired Makefile behaviour by specifying
1739 attributes you may define private subroutines in the Makefile.PL.
1740 Each subroutine returns the text it wishes to have written to
1741 the Makefile. To override a section of the Makefile you can
1742 either say:
1743 .PP
1744 .Vb 1
1745 \& sub MY::c_o { "new literal text" }
1746 .Ve
1747 .PP
1748 or you can edit the default by saying something like:
1749 .PP
1750 .Vb 6
1751 \& package MY; # so that "SUPER" works right
1752 \& sub c_o {
1753 \& my $inherited = shift\->SUPER::c_o(@_);
1754 \& $inherited =~ s/old text/new text/;
1755 \& $inherited;
1756 \& }
1757 .Ve
1758 .PP
1759 If you are running experiments with embedding perl as a library into
1760 other applications, you might find MakeMaker is not sufficient. You'd
1761 better have a look at ExtUtils::Embed which is a collection of utilities
1762 for embedding.
1763 .PP
1764 If you still need a different solution, try to develop another
1765 subroutine that fits your needs and submit the diffs to
1766 \&\f(CW\*(C`[email protected]\*(C'\fR
1767 .PP
1768 For a complete description of all MakeMaker methods see
1769 ExtUtils::MM_Unix.
1770 .PP
1771 Here is a simple example of how to add a new target to the generated
1772 Makefile:
1773 .PP
1774 .Vb 4
1775 \& sub MY::postamble {
1776 \& return <<\*(AqMAKE_FRAG\*(Aq;
1777 \& $(MYEXTLIB): sdbm/Makefile
1778 \& cd sdbm && $(MAKE) all
1779 \&
1780 \& MAKE_FRAG
1781 \& }
1782 .Ve
1783 .SS "The End Of Cargo Cult Programming"
1784 .IX Subsection "The End Of Cargo Cult Programming"
1785 \&\fBWriteMakefile()\fR now does some basic sanity checks on its parameters to
1786 protect against typos and malformatted values. This means some things
1787 which happened to work in the past will now throw warnings and
1788 possibly produce internal errors.
1789 .PP
1790 Some of the most common mistakes:
1791 .ie n .IP """MAN3PODS => \*(Aq \*(Aq""" 2
1792 .el .IP "\f(CWMAN3PODS => \*(Aq \*(Aq\fR" 2
1793 .IX Item "MAN3PODS => "
1794 This is commonly used to suppress the creation of man pages. MAN3PODS
1795 takes a hash ref not a string, but the above worked by accident in old
1796 versions of MakeMaker.
1797 .Sp
1798 The correct code is \f(CW\*(C`MAN3PODS => { }\*(C'\fR.
1799 .SS "Hintsfile support"
1800 .IX Subsection "Hintsfile support"
1801 MakeMaker.pm uses the architecture-specific information from
1802 Config.pm. In addition it evaluates architecture specific hints files
1803 in a \f(CW\*(C`hints/\*(C'\fR directory. The hints files are expected to be named
1804 like their counterparts in \f(CW\*(C`PERL_SRC/hints\*(C'\fR, but with an \f(CW\*(C`.pl\*(C'\fR file
1805 name extension (eg. \f(CW\*(C`next_3_2.pl\*(C'\fR). They are simply \f(CW\*(C`eval\*(C'\fRed by
1806 MakeMaker within the \fBWriteMakefile()\fR subroutine, and can be used to
1807 execute commands as well as to include special variables. The rules
1808 which hintsfile is chosen are the same as in Configure.
1809 .PP
1810 The hintsfile is \fBeval()\fRed immediately after the arguments given to
1811 WriteMakefile are stuffed into a hash reference \f(CW$self\fR but before this
1812 reference becomes blessed. So if you want to do the equivalent to
1813 override or create an attribute you would say something like
1814 .PP
1815 .Vb 1
1816 \& $self\->{LIBS} = [\*(Aq\-ldbm \-lucb \-lc\*(Aq];
1817 .Ve
1818 .SS "Distribution Support"
1819 .IX Subsection "Distribution Support"
1820 For authors of extensions MakeMaker provides several Makefile
1821 targets. Most of the support comes from the ExtUtils::Manifest module,
1822 where additional documentation can be found.
1823 .IP "make distcheck" 4
1824 .IX Item "make distcheck"
1825 reports which files are below the build directory but not in the
1826 MANIFEST file and vice versa. (See "fullcheck" in ExtUtils::Manifest for
1827 details)
1828 .IP "make skipcheck" 4
1829 .IX Item "make skipcheck"
1830 reports which files are skipped due to the entries in the
1831 \&\f(CW\*(C`MANIFEST.SKIP\*(C'\fR file (See "skipcheck" in ExtUtils::Manifest for
1832 details)
1833 .IP "make distclean" 4
1834 .IX Item "make distclean"
1835 does a realclean first and then the distcheck. Note that this is not
1836 needed to build a new distribution as long as you are sure that the
1837 MANIFEST file is ok.
1838 .IP "make veryclean" 4
1839 .IX Item "make veryclean"
1840 does a realclean first and then removes backup files such as \f(CW\*(C`*~\*(C'\fR,
1841 \&\f(CW\*(C`*.bak\*(C'\fR, \f(CW\*(C`*.old\*(C'\fR and \f(CW\*(C`*.orig\*(C'\fR
1842 .IP "make manifest" 4
1843 .IX Item "make manifest"
1844 rewrites the MANIFEST file, adding all remaining files found (See
1845 "mkmanifest" in ExtUtils::Manifest for details)
1846 .IP "make distdir" 4
1847 .IX Item "make distdir"
1848 Copies all the files that are in the MANIFEST file to a newly created
1849 directory with the name \f(CW\*(C`$(DISTNAME)\-$(VERSION)\*(C'\fR. If that directory
1850 exists, it will be removed first.
1851 .Sp
1852 Additionally, it will create META.yml and META.json module meta-data file
1853 in the distdir and add this to the distdir's MANIFEST. You can shut this
1854 behavior off with the NO_META flag.
1855 .IP "make disttest" 4
1856 .IX Item "make disttest"
1857 Makes a distdir first, and runs a \f(CW\*(C`perl Makefile.PL\*(C'\fR, a make, and
1858 a make test in that directory.
1859 .IP "make tardist" 4
1860 .IX Item "make tardist"
1861 First does a distdir. Then a command $(PREOP) which defaults to a null
1862 command, followed by $(TO_UNIX), which defaults to a null command under
1863 UNIX, and will convert files in distribution directory to UNIX format
1864 otherwise. Next it runs \f(CW\*(C`tar\*(C'\fR on that directory into a tarfile and
1865 deletes the directory. Finishes with a command $(POSTOP) which
1866 defaults to a null command.
1867 .IP "make dist" 4
1868 .IX Item "make dist"
1869 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
1870 .IP "make uutardist" 4
1871 .IX Item "make uutardist"
1872 Runs a tardist first and uuencodes the tarfile.
1873 .IP "make shdist" 4
1874 .IX Item "make shdist"
1875 First does a distdir. Then a command $(PREOP) which defaults to a null
1876 command. Next it runs \f(CW\*(C`shar\*(C'\fR on that directory into a sharfile and
1877 deletes the intermediate directory again. Finishes with a command
1878 $(POSTOP) which defaults to a null command. Note: For shdist to work
1879 properly a \f(CW\*(C`shar\*(C'\fR program that can handle directories is mandatory.
1880 .IP "make zipdist" 4
1881 .IX Item "make zipdist"
1882 First does a distdir. Then a command $(PREOP) which defaults to a null
1883 command. Runs \f(CW\*(C`$(ZIP) $(ZIPFLAGS)\*(C'\fR on that directory into a
1884 zipfile. Then deletes that directory. Finishes with a command
1885 $(POSTOP) which defaults to a null command.
1886 .IP "make ci" 4
1887 .IX Item "make ci"
1888 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
1889 .PP
1890 Customization of the dist targets can be done by specifying a hash
1891 reference to the dist attribute of the WriteMakefile call. The
1892 following parameters are recognized:
1893 .PP
1894 .Vb 12
1895 \& CI (\*(Aqci \-u\*(Aq)
1896 \& COMPRESS (\*(Aqgzip \-\-best\*(Aq)
1897 \& POSTOP (\*(Aq@ :\*(Aq)
1898 \& PREOP (\*(Aq@ :\*(Aq)
1899 \& TO_UNIX (depends on the system)
1900 \& RCS_LABEL (\*(Aqrcs \-q \-Nv$(VERSION_SYM):\*(Aq)
1901 \& SHAR (\*(Aqshar\*(Aq)
1902 \& SUFFIX (\*(Aq.gz\*(Aq)
1903 \& TAR (\*(Aqtar\*(Aq)
1904 \& TARFLAGS (\*(Aqcvf\*(Aq)
1905 \& ZIP (\*(Aqzip\*(Aq)
1906 \& ZIPFLAGS (\*(Aq\-r\*(Aq)
1907 .Ve
1908 .PP
1909 An example:
1910 .PP
1911 .Vb 7
1912 \& WriteMakefile(
1913 \& ...other options...
1914 \& dist => {
1915 \& COMPRESS => "bzip2",
1916 \& SUFFIX => ".bz2"
1917 \& }
1918 \& );
1919 .Ve
1920 .SS "Module Meta-Data (META and MYMETA)"
1921 .IX Subsection "Module Meta-Data (META and MYMETA)"
1922 Long plaguing users of MakeMaker based modules has been the problem of
1923 getting basic information about the module out of the sources
1924 \&\fIwithout\fR running the \fIMakefile.PL\fR and doing a bunch of messy
1925 heuristics on the resulting \fIMakefile\fR. Over the years, it has become
1926 standard to keep this information in one or more CPAN Meta files
1927 distributed with each distribution.
1928 .PP
1929 The original format of CPAN Meta files was YAML and the corresponding
1930 file was called \fIMETA.yml\fR. In 2010, version 2 of the CPAN::Meta::Spec
1931 was released, which mandates JSON format for the metadata in order to
1932 overcome certain compatibility issues between YAML serializers and to
1933 avoid breaking older clients unable to handle a new version of the spec.
1934 The CPAN::Meta library is now standard for accessing old and new-style
1935 Meta files.
1936 .PP
1937 If CPAN::Meta is installed, MakeMaker will automatically generate
1938 \&\fIMETA.json\fR and \fIMETA.yml\fR files for you and add them to your \fIMANIFEST\fR as
1939 part of the 'distdir' target (and thus the 'dist' target). This is intended to
1940 seamlessly and rapidly populate CPAN with module meta-data. If you wish to
1941 shut this feature off, set the \f(CW\*(C`NO_META\*(C'\fR \f(CWWriteMakefile()\fR flag to true.
1942 .PP
1943 At the 2008 QA Hackathon in Oslo, Perl module toolchain maintainers agreed
1944 to use the CPAN Meta format to communicate post-configuration requirements
1945 between toolchain components. These files, \fIMYMETA.json\fR and \fIMYMETA.yml\fR,
1946 are generated when \fIMakefile.PL\fR generates a \fIMakefile\fR (if CPAN::Meta
1947 is installed). Clients like CPAN or CPANPLUS will read these
1948 files to see what prerequisites must be fulfilled before building or testing
1949 the distribution. If you wish to shut this feature off, set the \f(CW\*(C`NO_MYMETA\*(C'\fR
1950 \&\f(CWWriteMakefile()\fR flag to true.
1951 .SS "Disabling an extension"
1952 .IX Subsection "Disabling an extension"
1953 If some events detected in \fIMakefile.PL\fR imply that there is no way
1954 to create the Module, but this is a normal state of things, then you
1955 can create a \fIMakefile\fR which does nothing, but succeeds on all the
1956 "usual" build targets. To do so, use
1957 .PP
1958 .Vb 2
1959 \& use ExtUtils::MakeMaker qw(WriteEmptyMakefile);
1960 \& WriteEmptyMakefile();
1961 .Ve
1962 .PP
1963 instead of \fBWriteMakefile()\fR.
1964 .PP
1965 This may be useful if other modules expect this module to be \fIbuilt\fR
1966 OK, as opposed to \fIwork\fR OK (say, this system-dependent module builds
1967 in a subdirectory of some other distribution, or is listed as a
1968 dependency in a CPAN::Bundle, but the functionality is supported by
1969 different means on the current architecture).
1970 .SS "Other Handy Functions"
1971 .IX Subsection "Other Handy Functions"
1972 .IP prompt 4
1973 .IX Item "prompt"
1974 .Vb 2
1975 \& my $value = prompt($message);
1976 \& my $value = prompt($message, $default);
1977 .Ve
1978 .Sp
1979 The \f(CWprompt()\fR function provides an easy way to request user input
1980 used to write a makefile. It displays the \f(CW$message\fR as a prompt for
1981 input. If a \f(CW$default\fR is provided it will be used as a default. The
1982 function returns the \f(CW$value\fR selected by the user.
1983 .Sp
1984 If \f(CWprompt()\fR detects that it is not running interactively and there
1985 is nothing on STDIN or if the PERL_MM_USE_DEFAULT environment variable
1986 is set to true, the \f(CW$default\fR will be used without prompting. This
1987 prevents automated processes from blocking on user input.
1988 .Sp
1989 If no \f(CW$default\fR is provided an empty string will be used instead.
1990 .IP os_unsupported 4
1991 .IX Item "os_unsupported"
1992 .Vb 2
1993 \& os_unsupported();
1994 \& os_unsupported if $^O eq \*(AqMSWin32\*(Aq;
1995 .Ve
1996 .Sp
1997 The \f(CWos_unsupported()\fR function provides a way to correctly exit your
1998 \&\f(CW\*(C`Makefile.PL\*(C'\fR before calling \f(CW\*(C`WriteMakefile\*(C'\fR. It is essentially a
1999 \&\f(CW\*(C`die\*(C'\fR with the message "OS unsupported".
2000 .Sp
2001 This is supported since 7.26
2002 .SS "Supported versions of Perl"
2003 .IX Subsection "Supported versions of Perl"
2004 Please note that while this module works on Perl 5.6, it is no longer
2005 being routinely tested on 5.6 \- the earliest Perl version being routinely
2006 tested, and expressly supported, is 5.8.1. However, patches to repair
2007 any breakage on 5.6 are still being accepted.
2008 .SH ENVIRONMENT
2009 .IX Header "ENVIRONMENT"
2010 .IP PERL_MM_OPT 4
2011 .IX Item "PERL_MM_OPT"
2012 Command line options used by \f(CW\*(C`MakeMaker\->new()\*(C'\fR, and thus by
2013 \&\f(CWWriteMakefile()\fR. The string is split as the shell would, and the result
2014 is processed before any actual command line arguments are processed.
2015 .Sp
2016 .Vb 1
2017 \& PERL_MM_OPT=\*(AqCCFLAGS="\-Wl,\-rpath \-Wl,/foo/bar/lib" LIBS="\-lwibble \-lwobble"\*(Aq
2018 .Ve
2019 .IP PERL_MM_USE_DEFAULT 4
2020 .IX Item "PERL_MM_USE_DEFAULT"
2021 If set to a true value then MakeMaker's prompt function will
2022 always return the default without waiting for user input.
2023 .IP PERL_CORE 4
2024 .IX Item "PERL_CORE"
2025 Same as the PERL_CORE parameter. The parameter overrides this.
2026 .SH "SEE ALSO"
2027 .IX Header "SEE ALSO"
2028 Module::Build is a pure-Perl alternative to MakeMaker which does
2029 not rely on make or any other external utility. It may be easier to
2030 extend to suit your needs.
2031 .PP
2032 Module::Build::Tiny is a minimal pure-Perl alternative to MakeMaker
2033 that follows the Build.PL protocol of Module::Build but without its
2034 complexity and cruft, implementing only the installation of the module
2035 and leaving authoring to mbtiny or other authoring tools.
2036 .PP
2037 Module::Install is a (now discouraged) wrapper around MakeMaker which
2038 adds features not normally available.
2039 .PP
2040 ExtUtils::ModuleMaker and Module::Starter are both modules to
2041 help you setup your distribution.
2042 .PP
2043 CPAN::Meta and CPAN::Meta::Spec explain CPAN Meta files in detail.
2044 .PP
2045 File::ShareDir::Install makes it easy to install static, sometimes
2046 also referred to as 'shared' files. File::ShareDir helps accessing
2047 the shared files after installation. Test::File::ShareDir helps when
2048 writing tests to use the shared files both before and after installation.
2049 .PP
2050 Dist::Zilla is an authoring tool which allows great customization and
2051 extensibility of the author experience, relying on the existing install
2052 tools like ExtUtils::MakeMaker only for installation.
2053 .PP
2054 Dist::Milla is a Dist::Zilla bundle that greatly simplifies common
2055 usage.
2056 .PP
2057 Minilla is a minimal authoring tool that does the same things as
2058 Dist::Milla without the overhead of Dist::Zilla.
2059 .SH AUTHORS
2060 .IX Header "AUTHORS"
2061 Andy Dougherty \f(CW\*(C`[email protected]\*(C'\fR, Andreas König
2062 \&\f(CW\*(C`[email protected]\*(C'\fR, Tim Bunce \f(CW\*(C`[email protected]\*(C'\fR. VMS
2063 support by Charles Bailey \f(CW\*(C`[email protected]\*(C'\fR. OS/2 support
2064 by Ilya Zakharevich \f(CW\*(C`[email protected]\-state.edu\*(C'\fR.
2065 .PP
2066 Currently maintained by Michael G Schwern \f(CW\*(C`[email protected]\*(C'\fR
2067 .PP
2068 Send patches and ideas to \f(CW\*(C`[email protected]\*(C'\fR.
2069 .PP
2070 Send bug reports via http://rt.cpan.org/. Please send your
2071 generated Makefile along with your report.
2072 .PP
2073 For more up-to-date information, see <https://metacpan.org/release/ExtUtils\-MakeMaker>.
2074 .PP
2075 Repository available at <https://github.com/Perl\-Toolchain\-Gang/ExtUtils\-MakeMaker>.
2076 .SH LICENSE
2077 .IX Header "LICENSE"
2078 This program is free software; you can redistribute it and/or
2079 modify it under the same terms as Perl itself.
2080 .PP
2081 See <http://www.perl.com/perl/misc/Artistic.html>