This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
e945d6d92ace397fcc3a5791f20434f7857db339
[perl5.git] / lib / Module / Build.pm
1 package Module::Build;
2
3 # This module doesn't do much of anything itself, it inherits from the
4 # modules that do the real work.  The only real thing it has to do is
5 # figure out which OS-specific module to pull in.  Many of the
6 # OS-specific modules don't do anything either - most of the work is
7 # done in Module::Build::Base.
8
9 use strict;
10 use File::Spec ();
11 use File::Path ();
12 use File::Basename ();
13
14 use Module::Build::Base;
15
16 use vars qw($VERSION @ISA);
17 @ISA = qw(Module::Build::Base);
18 $VERSION = '0.2806';
19 $VERSION = eval $VERSION;
20
21 # Okay, this is the brute-force method of finding out what kind of
22 # platform we're on.  I don't know of a systematic way.  These values
23 # came from the latest (bleadperl) perlport.pod.
24
25 my %OSTYPES = qw(
26                  aix       Unix
27                  bsdos     Unix
28                  dgux      Unix
29                  dynixptx  Unix
30                  freebsd   Unix
31                  linux     Unix
32                  hpux      Unix
33                  irix      Unix
34                  darwin    Unix
35                  machten   Unix
36                  next      Unix
37                  openbsd   Unix
38                  netbsd    Unix
39                  dec_osf   Unix
40                  svr4      Unix
41                  svr5      Unix
42                  sco_sv    Unix
43                  unicos    Unix
44                  unicosmk  Unix
45                  solaris   Unix
46                  sunos     Unix
47                  cygwin    Unix
48                  os2       Unix
49                  interix   Unix
50                  
51                  dos       Windows
52                  MSWin32   Windows
53
54                  os390     EBCDIC
55                  os400     EBCDIC
56                  posix-bc  EBCDIC
57                  vmesa     EBCDIC
58
59                  MacOS     MacOS
60                  VMS       VMS
61                  VOS       VOS
62                  riscos    RiscOS
63                  amigaos   Amiga
64                  mpeix     MPEiX
65                 );
66
67 # Inserts the given module into the @ISA hierarchy between
68 # Module::Build and its immediate parent
69 sub _interpose_module {
70   my ($self, $mod) = @_;
71   eval "use $mod";
72   die $@ if $@;
73
74   no strict 'refs';
75   my $top_class = $mod;
76   while (@{"${top_class}::ISA"}) {
77     last if ${"${top_class}::ISA"}[0] eq $ISA[0];
78     $top_class = ${"${top_class}::ISA"}[0];
79   }
80
81   @{"${top_class}::ISA"} = @ISA;
82   @ISA = ($mod);
83 }
84
85 if (grep {-e File::Spec->catfile($_, qw(Module Build Platform), $^O) . '.pm'} @INC) {
86   __PACKAGE__->_interpose_module("Module::Build::Platform::$^O");
87
88 } elsif (exists $OSTYPES{$^O}) {
89   __PACKAGE__->_interpose_module("Module::Build::Platform::$OSTYPES{$^O}");
90
91 } else {
92   warn "Unknown OS type '$^O' - using default settings\n";
93 }
94
95 sub os_type { $OSTYPES{$^O} }
96
97 1;
98
99 __END__
100
101
102 =head1 NAME
103
104 Module::Build - Build and install Perl modules
105
106
107 =head1 SYNOPSIS
108
109 Standard process for building & installing modules:
110
111   perl Build.PL
112   ./Build
113   ./Build test
114   ./Build install
115
116 Or, if you're on a platform (like DOS or Windows) that doesn't require
117 the "./" notation, you can do this:
118
119   perl Build.PL
120   Build
121   Build test
122   Build install
123
124
125 =head1 DESCRIPTION
126
127 C<Module::Build> is a system for building, testing, and installing
128 Perl modules.  It is meant to be an alternative to
129 C<ExtUtils::MakeMaker>.  Developers may alter the behavior of the
130 module through subclassing in a much more straightforward way than
131 with C<MakeMaker>.  It also does not require a C<make> on your system
132 - most of the C<Module::Build> code is pure-perl and written in a very
133 cross-platform way.  In fact, you don't even need a shell, so even
134 platforms like MacOS (traditional) can use it fairly easily.  Its only
135 prerequisites are modules that are included with perl 5.6.0, and it
136 works fine on perl 5.005 if you can install a few additional modules.
137
138 See L<"MOTIVATIONS"> for more comparisons between C<ExtUtils::MakeMaker>
139 and C<Module::Build>.
140
141 To install C<Module::Build>, and any other module that uses
142 C<Module::Build> for its installation process, do the following:
143
144   perl Build.PL       # 'Build.PL' script creates the 'Build' script
145   ./Build             # Need ./ to ensure we're using this "Build" script
146   ./Build test        # and not another one that happens to be in the PATH
147   ./Build install
148
149 This illustrates initial configuration and the running of three
150 'actions'.  In this case the actions run are 'build' (the default
151 action), 'test', and 'install'.  Other actions defined so far include:
152
153   build                          manifest    
154   clean                          manpages    
155   code                           pardist     
156   config_data                    ppd         
157   diff                           ppmdist     
158   dist                           prereq_report
159   distcheck                      pure_install
160   distclean                      realclean   
161   distdir                        retest      
162   distmeta                       skipcheck   
163   distsign                       test        
164   disttest                       testcover   
165   docs                           testdb      
166   fakeinstall                    testpod     
167   help                           testpodcoverage
168   html                           versioninstall
169   install                                    
170
171
172 You can run the 'help' action for a complete list of actions.
173
174
175 =head1 GUIDE TO DOCUMENTATION
176
177 The documentation for C<Module::Build> is broken up into three sections:
178
179 =over
180
181 =item General Usage (L<Module::Build>)
182
183 This is the document you are currently reading. It describes basic
184 usage and background information.  Its main purpose is to assist the
185 user who wants to learn how to invoke and control C<Module::Build>
186 scripts at the command line.
187
188 =item Authoring Reference (L<Module::Build::Authoring>)
189
190 This document describes the structure and organization of
191 C<Module::Build>, and the relevant concepts needed by authors who are
192 writing F<Build.PL> scripts for a distribution or controlling
193 C<Module::Build> processes programmatically.
194
195 =item API Reference (L<Module::Build::API>)
196
197 This is a reference to the C<Module::Build> API.
198
199 =item Cookbook (L<Module::Build::Cookbook>)
200
201 This document demonstrates how to accomplish many common tasks.  It
202 covers general command line usage and authoring of F<Build.PL>
203 scripts.  Includes working examples.
204
205 =back
206
207
208 =head1 ACTIONS
209
210 There are some general principles at work here.  First, each task when
211 building a module is called an "action".  These actions are listed
212 above; they correspond to the building, testing, installing,
213 packaging, etc., tasks.
214
215 Second, arguments are processed in a very systematic way.  Arguments
216 are always key=value pairs.  They may be specified at C<perl Build.PL>
217 time (i.e. C<perl Build.PL destdir=/my/secret/place>), in which case
218 their values last for the lifetime of the C<Build> script.  They may
219 also be specified when executing a particular action (i.e.
220 C<Build test verbose=1>), in which case their values last only for the
221 lifetime of that command.  Per-action command line parameters take
222 precedence over parameters specified at C<perl Build.PL> time.
223
224 The build process also relies heavily on the C<Config.pm> module, and
225 all the key=value pairs in C<Config.pm> are available in
226
227 C<< $self->{config} >>.  If the user wishes to override any of the
228 values in C<Config.pm>, she may specify them like so:
229
230   perl Build.PL --config cc=gcc --config ld=gcc
231
232 The following build actions are provided by default.
233
234 =over 4
235
236 =item build
237
238 [version 0.01]
239
240 If you run the C<Build> script without any arguments, it runs the
241 C<build> action, which in turn runs the C<code> and C<docs> actions.
242
243 This is analogous to the MakeMaker 'make all' target.
244
245 =item clean
246
247 [version 0.01]
248
249 This action will clean up any files that the build process may have
250 created, including the C<blib/> directory (but not including the
251 C<_build/> directory and the C<Build> script itself).
252
253 =item code
254
255 [version 0.20]
256
257 This action builds your codebase.
258
259 By default it just creates a C<blib/> directory and copies any C<.pm>
260 and C<.pod> files from your C<lib/> directory into the C<blib/>
261 directory.  It also compiles any C<.xs> files from C<lib/> and places
262 them in C<blib/>.  Of course, you need a working C compiler (probably
263 the same one that built perl itself) for the compilation to work
264 properly.
265
266 The C<code> action also runs any C<.PL> files in your F<lib/>
267 directory.  Typically these create other files, named the same but
268 without the C<.PL> ending.  For example, a file F<lib/Foo/Bar.pm.PL>
269 could create the file F<lib/Foo/Bar.pm>.  The C<.PL> files are
270 processed first, so any C<.pm> files (or other kinds that we deal
271 with) will get copied correctly.
272
273 =item config_data
274
275 [version 0.26]
276
277 ...
278
279 =item diff
280
281 [version 0.14]
282
283 This action will compare the files about to be installed with their
284 installed counterparts.  For .pm and .pod files, a diff will be shown
285 (this currently requires a 'diff' program to be in your PATH).  For
286 other files like compiled binary files, we simply report whether they
287 differ.
288
289 A C<flags> parameter may be passed to the action, which will be passed
290 to the 'diff' program.  Consult your 'diff' documentation for the
291 parameters it will accept - a good one is C<-u>:
292
293   ./Build diff flags=-u
294
295 =item dist
296
297 [version 0.02]
298
299 This action is helpful for module authors who want to package up their
300 module for source distribution through a medium like CPAN.  It will create a
301 tarball of the files listed in F<MANIFEST> and compress the tarball using
302 GZIP compression.
303
304 By default, this action will use the external C<tar> and C<gzip>
305 executables on Unix-like platforms, and the C<Archive::Tar> module
306 elsewhere.  However, you can force it to use whatever executable you
307 want by supplying an explicit C<tar> (and optional C<gzip>) parameter:
308
309   ./Build dist --tar C:\path\to\tar.exe --gzip C:\path\to\zip.exe
310
311 =item distcheck
312
313 [version 0.05]
314
315 Reports which files are in the build directory but not in the
316 F<MANIFEST> file, and vice versa.  (See L<manifest> for details.)
317
318 =item distclean
319
320 [version 0.05]
321
322 Performs the 'realclean' action and then the 'distcheck' action.
323
324 =item distdir
325
326 [version 0.05]
327
328 Creates a "distribution directory" named C<$dist_name-$dist_version>
329 (if that directory already exists, it will be removed first), then
330 copies all the files listed in the F<MANIFEST> file to that directory.
331 This directory is what the distribution tarball is created from.
332
333 =item distmeta
334
335 [version 0.21]
336
337 Creates the F<META.yml> file that describes the distribution.
338
339 F<META.yml> is a file containing various bits of "metadata" about the
340 distribution.  The metadata includes the distribution name, version,
341 abstract, prerequisites, license, and various other data about the
342 distribution.  This file is created as F<META.yml> in YAML format.
343 It is recommended that the C<YAML> module be installed to create it.
344 If the C<YAML> module is not installed, an internal module supplied
345 with Module::Build will be used to write the META.yml file, and this
346 will most likely be fine.
347
348 F<META.yml> file must also be listed in F<MANIFEST> - if it's not, a
349 warning will be issued.
350
351 The current version of the F<META.yml> specification can be found at
352 L<http://module-build.sourceforge.net/META-spec-current.html>
353
354 =item distsign
355
356 [version 0.16]
357
358 Uses C<Module::Signature> to create a SIGNATURE file for your
359 distribution, and adds the SIGNATURE file to the distribution's
360 MANIFEST.
361
362 =item disttest
363
364 [version 0.05]
365
366 Performs the 'distdir' action, then switches into that directory and
367 runs a C<perl Build.PL>, followed by the 'build' and 'test' actions in
368 that directory.
369
370 =item docs
371
372 [version 0.20]
373
374 This will generate documentation (e.g. Unix man pages and html
375 documents) for any installable items under B<blib/> that
376 contain POD.  If there are no C<bindoc> or C<libdoc> installation
377 targets defined (as will be the case on systems that don't support
378 Unix manpages) no action is taken for manpages.  If there are no
379 C<binhtml> or C<libhtml> installation targets defined no action is
380 taken for html documents.
381
382 =item fakeinstall
383
384 [version 0.02]
385
386 This is just like the C<install> action, but it won't actually do
387 anything, it will just report what it I<would> have done if you had
388 actually run the C<install> action.
389
390 =item help
391
392 [version 0.03]
393
394 This action will simply print out a message that is meant to help you
395 use the build process.  It will show you a list of available build
396 actions too.
397
398 With an optional argument specifying an action name (e.g. C<Build help
399 test>), the 'help' action will show you any POD documentation it can
400 find for that action.
401
402 =item html
403
404 [version 0.26]
405
406 This will generate HTML documentation for any binary or library files
407 under B<blib/> that contain POD.  The HTML documentation will only be
408 installed if the install paths can be determined from values in
409 C<Config.pm>.  You can also supply or override install paths on the
410 command line by specifying C<install_path> values for the C<binhtml>
411 and/or C<libhtml> installation targets.
412
413 =item install
414
415 [version 0.01]
416
417 This action will use C<ExtUtils::Install> to install the files from
418 C<blib/> into the system.  See L<"INSTALL PATHS">
419 for details about how Module::Build determines where to install
420 things, and how to influence this process.
421
422 If you want the installation process to look around in C<@INC> for
423 other versions of the stuff you're installing and try to delete it,
424 you can use the C<uninst> parameter, which tells C<ExtUtils::Install> to
425 do so:
426
427   ./Build install uninst=1
428
429 This can be a good idea, as it helps prevent multiple versions of a
430 module from being present on your system, which can be a confusing
431 situation indeed.
432
433 =item manifest
434
435 [version 0.05]
436
437 This is an action intended for use by module authors, not people
438 installing modules.  It will bring the F<MANIFEST> up to date with the
439 files currently present in the distribution.  You may use a
440 F<MANIFEST.SKIP> file to exclude certain files or directories from
441 inclusion in the F<MANIFEST>.  F<MANIFEST.SKIP> should contain a bunch
442 of regular expressions, one per line.  If a file in the distribution
443 directory matches any of the regular expressions, it won't be included
444 in the F<MANIFEST>.
445
446 The following is a reasonable F<MANIFEST.SKIP> starting point, you can
447 add your own stuff to it:
448
449   ^_build
450   ^Build$
451   ^blib
452   ~$
453   \.bak$
454   ^MANIFEST\.SKIP$
455   CVS
456
457 See the L<distcheck> and L<skipcheck> actions if you want to find out
458 what the C<manifest> action would do, without actually doing anything.
459
460 =item manpages
461
462 [version 0.28]
463
464 This will generate man pages for any binary or library files under
465 B<blib/> that contain POD.  The man pages will only be installed if the
466 install paths can be determined from values in C<Config.pm>.  You can
467 also supply or override install paths by specifying there values on
468 the command line with the C<bindoc> and C<libdoc> installation
469 targets.
470
471 =item pardist
472
473 [version 0.2806]
474
475 Generates a PAR binary distribution for use with L<PAR> or L<PAR::Dist>.
476
477 It requires that the PAR::Dist module (version 0.17 and up) is
478 installed on your system.
479
480 =item ppd
481
482 [version 0.20]
483
484 Build a PPD file for your distribution.
485
486 This action takes an optional argument C<codebase> which is used in
487 the generated ppd file to specify the (usually relative) URL of the
488 distribution.  By default, this value is the distribution name without
489 any path information.
490
491 Example:
492
493   ./Build ppd --codebase "MSWin32-x86-multi-thread/Module-Build-0.21.tar.gz"
494
495 =item ppmdist
496
497 [version 0.23]
498
499 Generates a PPM binary distribution and a PPD description file.  This
500 action also invokes the 'ppd' action, so it can accept the same
501 C<codebase> argument described under that action.
502
503 This uses the same mechanism as the C<dist> action to tar & zip its
504 output, so you can supply C<tar> and/or C<gzip> parameters to affect
505 the result.
506
507 =item prereq_report
508
509 [version 0.28]
510
511 This action prints out a list of all prerequisites, the versions required, and
512 the versions actually installed.  This can be useful for reviewing the
513 configuration of your system prior to a build, or when compiling data to send
514 for a bug report.
515
516 =item pure_install
517
518 [version 0.28]
519
520 This action is identical to the C<install> action.  In the future,
521 though, if C<install> starts writing to the file file
522 F<$(INSTALLARCHLIB)/perllocal.pod>, C<pure_install> won't, and that
523 will be the only difference between them.
524
525 =item realclean
526
527 [version 0.01]
528
529 This action is just like the C<clean> action, but also removes the
530 C<_build> directory and the C<Build> script.  If you run the
531 C<realclean> action, you are essentially starting over, so you will
532 have to re-create the C<Build> script again.
533
534 =item retest
535
536 [version 0.2806]
537
538 This is just like the C<test> action, but doesn't actually build the
539 distribution first, and doesn't add F<blib/> to the load path, and
540 therefore will test against a I<previously> installed version of the
541 distribution.  This can be used to verify that a certain installed
542 distribution still works, or to see whether newer versions of a
543 distribution still pass the old regression tests, and so on.
544
545 =item skipcheck
546
547 [version 0.05]
548
549 Reports which files are skipped due to the entries in the
550 F<MANIFEST.SKIP> file (See L<manifest> for details)
551
552 =item test
553
554 [version 0.01]
555
556 This will use C<Test::Harness> to run any regression tests and report
557 their results.  Tests can be defined in the standard places: a file
558 called C<test.pl> in the top-level directory, or several files ending
559 with C<.t> in a C<t/> directory.
560
561 If you want tests to be 'verbose', i.e. show details of test execution
562 rather than just summary information, pass the argument C<verbose=1>.
563
564 If you want to run tests under the perl debugger, pass the argument
565 C<debugger=1>.
566
567 In addition, if a file called C<visual.pl> exists in the top-level
568 directory, this file will be executed as a Perl script and its output
569 will be shown to the user.  This is a good place to put speed tests or
570 other tests that don't use the C<Test::Harness> format for output.
571
572 To override the choice of tests to run, you may pass a C<test_files>
573 argument whose value is a whitespace-separated list of test scripts to
574 run.  This is especially useful in development, when you only want to
575 run a single test to see whether you've squashed a certain bug yet:
576
577   ./Build test --test_files t/something_failing.t
578
579 You may also pass several C<test_files> arguments separately:
580
581   ./Build test --test_files t/one.t --test_files t/two.t
582
583 or use a C<glob()>-style pattern:
584
585   ./Build test --test_files 't/01-*.t'
586
587 =item testcover
588
589 [version 0.26]
590
591 Runs the C<test> action using C<Devel::Cover>, generating a
592 code-coverage report showing which parts of the code were actually
593 exercised during the tests.
594
595 To pass options to C<Devel::Cover>, set the C<$DEVEL_COVER_OPTIONS>
596 environment variable:
597
598   DEVEL_COVER_OPTIONS=-ignore,Build ./Build testcover
599
600 =item testdb
601
602 [version 0.05]
603
604 This is a synonym for the 'test' action with the C<debugger=1>
605 argument.
606
607 =item testpod
608
609 [version 0.25]
610
611 This checks all the files described in the C<docs> action and 
612 produces C<Test::Harness>-style output.  If you are a module author,
613 this is useful to run before creating a new release.
614
615 =item testpodcoverage
616
617 [version 0.28]
618
619 This checks the pod coverage of the distribution and 
620 produces C<Test::Harness>-style output. If you are a module author,
621 this is useful to run before creating a new release.
622
623 =item versioninstall
624
625 [version 0.16]
626
627 ** Note: since C<only.pm> is so new, and since we just recently added
628 support for it here too, this feature is to be considered
629 experimental. **
630
631 If you have the C<only.pm> module installed on your system, you can
632 use this action to install a module into the version-specific library
633 trees.  This means that you can have several versions of the same
634 module installed and C<use> a specific one like this:
635
636   use only MyModule => 0.55;
637
638 To override the default installation libraries in C<only::config>,
639 specify the C<versionlib> parameter when you run the C<Build.PL> script:
640
641   perl Build.PL --versionlib /my/version/place/
642
643 To override which version the module is installed as, specify the
644 C<versionlib> parameter when you run the C<Build.PL> script:
645
646   perl Build.PL --version 0.50
647
648 See the C<only.pm> documentation for more information on
649 version-specific installs.
650
651 =back
652
653
654 =head1 OPTIONS
655
656 =head2 Command Line Options
657
658 The following options can be used during any invocation of C<Build.PL>
659 or the Build script, during any action.  For information on other
660 options specific to an action, see the documentation for the
661 respective action.
662
663 NOTE: There is some preliminary support for options to use the more
664 familiar long option style.  Most options can be preceded with the
665 C<--> long option prefix, and the underscores changed to dashes
666 (e.g. --use-rcfile).  Additionally, the argument to boolean options is
667 optional, and boolean options can be negated by prefixing them with
668 'no' or 'no-' (e.g. --noverbose or --no-verbose).
669
670 =over 4
671
672 =item quiet
673
674 Suppress informative messages on output.
675
676 =item use_rcfile
677
678 Load the F<~/.modulebuildrc> option file.  This option can be set to
679 false to prevent the custom resource file from being loaded.
680
681 =item verbose
682
683 Display extra information about the Build on output.
684
685 =item allow_mb_mismatch
686
687 Suppresses the check upon startup that the version of Module::Build
688 we're now running under is the same version that was initially invoked
689 when building the distribution (i.e. when the C<Build.PL> script was
690 first run).  Use with caution.
691
692 =back
693
694
695 =head2 Default Options File (F<.modulebuildrc>)
696
697 [version 0.28]
698
699 When Module::Build starts up, it will look first for a file,
700 F<$ENV{HOME}/.modulebuildrc>.  If it's not found there, it will look
701 in the the F<.modulebuildrc> file in the directories referred to by
702 the environment variables C<HOMEDRIVE> + C<HOMEDIR>, C<USERPROFILE>,
703 C<APPDATA>, C<WINDIR>, C<SYS$LOGIN>.  If the file exists, the options
704 specified there will be used as defaults, as if they were typed on the
705 command line.  The defaults can be overridden by specifying new values
706 on the command line.
707
708 The action name must come at the beginning of the line, followed by any
709 amount of whitespace and then the options.  Options are given the same
710 as they would be on the command line.  They can be separated by any
711 amount of whitespace, including newlines, as long there is whitespace at
712 the beginning of each continued line.  Anything following a hash mark (C<#>)
713 is considered a comment, and is stripped before parsing.  If more than
714 one line begins with the same action name, those lines are merged into
715 one set of options.
716
717 Besides the regular actions, there are two special pseudo-actions: the
718 key C<*> (asterisk) denotes any global options that should be applied
719 to all actions, and the key 'Build_PL' specifies options to be applied
720 when you invoke C<perl Build.PL>.
721
722   *        verbose=1   # global options
723   diff     flags=-u
724   install  --install_base /home/ken
725            --install_path html=/home/ken/docs/html
726
727 If you wish to locate your resource file in a different location, you
728 can set the environment variable 'MODULEBUILDRC' to the complete
729 absolute path of the file containing your options.
730
731
732 =head1 INSTALL PATHS
733
734 [version 0.19]
735
736 When you invoke Module::Build's C<build> action, it needs to figure
737 out where to install things.  The nutshell version of how this works
738 is that default installation locations are determined from
739 F<Config.pm>, and they may be overridden by using the C<install_path>
740 parameter.  An C<install_base> parameter lets you specify an
741 alternative installation root like F</home/foo>, and a C<destdir> lets
742 you specify a temporary installation directory like F</tmp/install> in
743 case you want to create bundled-up installable packages.
744
745 Natively, Module::Build provides default installation locations for
746 the following types of installable items:
747
748 =over 4
749
750 =item lib
751
752 Usually pure-Perl module files ending in F<.pm>.
753
754 =item arch
755
756 "Architecture-dependent" module files, usually produced by compiling
757 XS, Inline, or similar code.
758
759 =item script
760
761 Programs written in pure Perl.  In order to improve reuse, try to make
762 these as small as possible - put the code into modules whenever
763 possible.
764
765 =item bin
766
767 "Architecture-dependent" executable programs, i.e. compiled C code or
768 something.  Pretty rare to see this in a perl distribution, but it
769 happens.
770
771 =item bindoc
772
773 Documentation for the stuff in C<script> and C<bin>.  Usually
774 generated from the POD in those files.  Under Unix, these are manual
775 pages belonging to the 'man1' category.
776
777 =item libdoc
778
779 Documentation for the stuff in C<lib> and C<arch>.  This is usually
780 generated from the POD in F<.pm> files.  Under Unix, these are manual
781 pages belonging to the 'man3' category.
782
783 =item binhtml
784
785 This is the same as C<bindoc> above, but applies to html documents.
786
787 =item libhtml
788
789 This is the same as C<bindoc> above, but applies to html documents.
790
791 =back
792
793 Four other parameters let you control various aspects of how
794 installation paths are determined:
795
796 =over 4
797
798 =item installdirs
799
800 The default destinations for these installable things come from
801 entries in your system's C<Config.pm>.  You can select from three
802 different sets of default locations by setting the C<installdirs>
803 parameter as follows:
804
805                           'installdirs' set to:
806                    core          site                vendor
807
808               uses the following defaults from Config.pm:
809
810   lib     => installprivlib  installsitelib      installvendorlib
811   arch    => installarchlib  installsitearch     installvendorarch
812   script  => installscript   installsitebin      installvendorbin
813   bin     => installbin      installsitebin      installvendorbin
814   bindoc  => installman1dir  installsiteman1dir  installvendorman1dir
815   libdoc  => installman3dir  installsiteman3dir  installvendorman3dir
816   binhtml => installhtml1dir installsitehtml1dir installvendorhtml1dir [*]
817   libhtml => installhtml3dir installsitehtml3dir installvendorhtml3dir [*]
818
819   * Under some OS (eg. MSWin32) the destination for html documents is
820     determined by the C<Config.pm> entry C<installhtmldir>.
821
822 The default value of C<installdirs> is "site".  If you're creating
823 vendor distributions of module packages, you may want to do something
824 like this:
825
826   perl Build.PL --installdirs vendor
827
828 or
829
830   ./Build install --installdirs vendor
831
832 If you're installing an updated version of a module that was included
833 with perl itself (i.e. a "core module"), then you may set
834 C<installdirs> to "core" to overwrite the module in its present
835 location.
836
837 (Note that the 'script' line is different from MakeMaker -
838 unfortunately there's no such thing as "installsitescript" or
839 "installvendorscript" entry in C<Config.pm>, so we use the
840 "installsitebin" and "installvendorbin" entries to at least get the
841 general location right.  In the future, if C<Config.pm> adds some more
842 appropriate entries, we'll start using those.)
843
844 =item install_path
845
846 Once the defaults have been set, you can override them.
847
848 On the command line, that would look like this:
849
850   perl Build.PL --install_path lib=/foo/lib --install_path arch=/foo/lib/arch
851
852 or this:
853
854   ./Build install --install_path lib=/foo/lib --install_path arch=/foo/lib/arch
855
856 =item install_base
857
858 You can also set the whole bunch of installation paths by supplying the
859 C<install_base> parameter to point to a directory on your system.  For
860 instance, if you set C<install_base> to "/home/ken" on a Linux
861 system, you'll install as follows:
862
863   lib     => /home/ken/lib/perl5
864   arch    => /home/ken/lib/perl5/i386-linux
865   script  => /home/ken/bin
866   bin     => /home/ken/bin
867   bindoc  => /home/ken/man/man1
868   libdoc  => /home/ken/man/man3
869   binhtml => /home/ken/html
870   libhtml => /home/ken/html
871
872 Note that this is I<different> from how MakeMaker's C<PREFIX>
873 parameter works.  C<install_base> just gives you a default layout under the
874 directory you specify, which may have little to do with the
875 C<installdirs=site> layout.
876
877 The exact layout under the directory you specify may vary by system -
878 we try to do the "sensible" thing on each platform.
879
880 =item destdir
881
882 If you want to install everything into a temporary directory first
883 (for instance, if you want to create a directory tree that a package
884 manager like C<rpm> or C<dpkg> could create a package from), you can
885 use the C<destdir> parameter:
886
887   perl Build.PL --destdir /tmp/foo
888
889 or
890
891   ./Build install --destdir /tmp/foo
892
893 This will effectively install to "/tmp/foo/$sitelib",
894 "/tmp/foo/$sitearch", and the like, except that it will use
895 C<File::Spec> to make the pathnames work correctly on whatever
896 platform you're installing on.
897
898 =item prefix
899
900 Provided for compatibility with ExtUtils::MakeMaker's PREFIX argument.
901 C<prefix> should be used when you wish Module::Build to install your
902 modules, documentation and scripts in the same place
903 ExtUtils::MakeMaker does.
904
905 The following are equivalent.
906
907     perl Build.PL --prefix /tmp/foo
908     perl Makefile.PL PREFIX=/tmp/foo
909
910 Because of the very complex nature of the prefixification logic, the
911 behavior of PREFIX in MakeMaker has changed subtly over time.
912 Module::Build's --prefix logic is equivalent to the PREFIX logic found
913 in ExtUtils::MakeMaker 6.30.
914
915 If you do not need to retain compatibility with ExtUtils::MakeMaker or
916 are starting a fresh Perl installation we recommand you use
917 C<install_base> instead (and C<INSTALL_BASE> in ExtUtils::MakeMaker).
918 See L<Module::Build::Cookbook/Instaling in the same location as
919 ExtUtils::MakeMaker> for further information.
920
921
922 =back
923
924
925 =head1 MOTIVATIONS
926
927 There are several reasons I wanted to start over, and not just fix
928 what I didn't like about MakeMaker:
929
930 =over 4
931
932 =item *
933
934 I don't like the core idea of MakeMaker, namely that C<make> should be
935 involved in the build process.  Here are my reasons:
936
937 =over 4
938
939 =item +
940
941 When a person is installing a Perl module, what can you assume about
942 their environment?  Can you assume they have C<make>?  No, but you can
943 assume they have some version of Perl.
944
945 =item +
946
947 When a person is writing a Perl module for intended distribution, can
948 you assume that they know how to build a Makefile, so they can
949 customize their build process?  No, but you can assume they know Perl,
950 and could customize that way.
951
952 =back
953
954 For years, these things have been a barrier to people getting the
955 build/install process to do what they want.
956
957 =item *
958
959 There are several architectural decisions in MakeMaker that make it
960 very difficult to customize its behavior.  For instance, when using
961 MakeMaker you do C<use ExtUtils::MakeMaker>, but the object created in
962 C<WriteMakefile()> is actually blessed into a package name that's
963 created on the fly, so you can't simply subclass
964 C<ExtUtils::MakeMaker>.  There is a workaround C<MY> package that lets
965 you override certain MakeMaker methods, but only certain explicitly
966 preselected (by MakeMaker) methods can be overridden.  Also, the method
967 of customization is very crude: you have to modify a string containing
968 the Makefile text for the particular target.  Since these strings
969 aren't documented, and I<can't> be documented (they take on different
970 values depending on the platform, version of perl, version of
971 MakeMaker, etc.), you have no guarantee that your modifications will
972 work on someone else's machine or after an upgrade of MakeMaker or
973 perl.
974
975 =item *
976
977 It is risky to make major changes to MakeMaker, since it does so many
978 things, is so important, and generally works.  C<Module::Build> is an
979 entirely separate package so that I can work on it all I want, without
980 worrying about backward compatibility.
981
982 =item *
983
984 Finally, Perl is said to be a language for system administration.
985 Could it really be the case that Perl isn't up to the task of building
986 and installing software?  Even if that software is a bunch of stupid
987 little C<.pm> files that just need to be copied from one place to
988 another?  My sense was that we could design a system to accomplish
989 this in a flexible, extensible, and friendly manner.  Or die trying.
990
991 =back
992
993
994 =head1 TO DO
995
996 The current method of relying on time stamps to determine whether a
997 derived file is out of date isn't likely to scale well, since it
998 requires tracing all dependencies backward, it runs into problems on
999 NFS, and it's just generally flimsy.  It would be better to use an MD5
1000 signature or the like, if available.  See C<cons> for an example.
1001
1002  - append to perllocal.pod
1003  - add a 'plugin' functionality
1004
1005
1006 =head1 AUTHOR
1007
1008 Ken Williams <kwilliams@cpan.org>
1009
1010 Development questions, bug reports, and patches should be sent to the
1011 Module-Build mailing list at <module-build@perl.org>.
1012
1013 Bug reports are also welcome at
1014 <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Module-Build>.
1015
1016 The latest development version is available from the Subversion
1017 repository at <https://svn.perl.org/modules/Module-Build/trunk/>
1018
1019
1020 =head1 COPYRIGHT
1021
1022 Copyright (c) 2001-2006 Ken Williams.  All rights reserved.
1023
1024 This library is free software; you can redistribute it and/or
1025 modify it under the same terms as Perl itself.
1026
1027
1028 =head1 SEE ALSO
1029
1030 perl(1), L<Module::Build::Cookbook>, L<Module::Build::Authoring>,
1031 L<Module::Build::API>, L<ExtUtils::MakeMaker>, L<YAML>
1032
1033 F<META.yml> Specification:
1034 L<http://module-build.sourceforge.net/META-spec-current.html>
1035
1036 L<http://www.dsmit.com/cons/>
1037
1038 L<http://search.cpan.org/dist/PerlBuildSystem/>
1039
1040 =cut