1 # $Id: /local/ExtUtils-MakeMaker/lib/ExtUtils/MakeMaker.pm 66493 2008-09-27T21:35:25.560547Z schwern $
2 package ExtUtils::MakeMaker;
9 use ExtUtils::MakeMaker::Config;
13 our $Verbose = 0; # exported
14 our @Parent; # needs to be localized
15 our @Get_from_Config; # referenced by MM_Unix
19 my %Recognized_Att_Keys;
21 our $VERSION = '6.46';
22 our ($Revision) = q$Revision: 66493 $ =~ /Revision:\s+(\S+)/;
23 our $Filename = __FILE__; # referenced outside MakeMaker
25 our @ISA = qw(Exporter);
26 our @EXPORT = qw(&WriteMakefile &writeMakefile $Verbose &prompt);
27 our @EXPORT_OK = qw($VERSION &neatvalue &mkbootstrap &mksymlists
30 # These will go away once the last of the Win32 & VMS specific code is
32 my $Is_VMS = $^O eq 'VMS';
33 my $Is_Win32 = $^O eq 'MSWin32';
37 require ExtUtils::MM; # Things like CPAN assume loading ExtUtils::MakeMaker
40 require ExtUtils::MY; # XXX pre-5.8 versions of ExtUtils::Embed expect
41 # loading ExtUtils::MakeMaker will give them MY.
42 # This will go when Embed is its own CPAN module.
46 Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
53 my $mm = MM->new(\%att);
60 # Basic signatures of the attributes WriteMakefile takes. Each is the
61 # reference type. Empty value indicate it takes a non-reference
71 EXCLUDE_EXT => 'ARRAY',
76 INCLUDE_EXT => 'ARRAY',
85 PMLIBPARENTDIRS => 'ARRAY',
90 VERSION => ['version',''],
91 _KEEP_AFTER_FLUSH => '',
102 tool_autosplit => 'HASH',
105 @Att_Sigs{keys %Recognized_Att_Keys} = ('') x keys %Recognized_Att_Keys;
106 @Att_Sigs{keys %Special_Sigs} = values %Special_Sigs;
112 while( my($key, $val) = each %$att ) {
113 my $sig = $Att_Sigs{$key};
114 unless( defined $sig ) {
115 warn "WARNING: $key is not a known parameter.\n";
119 my @sigs = ref $sig ? @$sig : $sig;
120 my $given = ref $val;
121 unless( grep { $given eq $_ || ($_ && eval{$val->isa($_)}) } @sigs ) {
122 my $takes = join " or ", map { _format_att($_) } @sigs;
124 my $has = _format_att($given);
125 warn "WARNING: $key takes a $takes not a $has.\n".
126 " Please inform the author.\n";
135 return $given eq '' ? "string/number"
136 : uc $given eq $given ? "$given reference"
142 sub prompt ($;$) { ## no critic
143 my($mess, $def) = @_;
144 Carp::confess("prompt function called without an argument")
145 unless defined $mess;
147 my $isa_tty = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ;
149 my $dispdef = defined $def ? "[$def] " : " ";
150 $def = defined $def ? $def : "";
154 print "$mess $dispdef";
157 if ($ENV{PERL_MM_USE_DEFAULT} || (!$isa_tty && eof STDIN)) {
165 else { # user hit ctrl-D
170 return (!defined $ans || $ans eq '') ? $def : $ans;
173 sub eval_in_subdirs {
175 use Cwd qw(cwd abs_path);
176 my $pwd = cwd() || die "Can't figure out your cwd!";
178 local @INC = map eval {abs_path($_) if -e} || $_, @INC;
179 push @INC, '.'; # '.' has to always be at the end of @INC
181 foreach my $dir (@{$self->{DIR}}){
182 my($abs) = $self->catdir($pwd,$dir);
183 eval { $self->eval_in_x($abs); };
192 chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
199 # if ($@ =~ /prerequisites/) {
200 # die "MakeMaker WARNING: $@";
202 # warn "WARNING from evaluation of $dir/Makefile.PL: $@";
204 die "ERROR from evaluation of $dir/Makefile.PL: $@";
209 # package name for the classes into which the first object will be blessed
210 my $PACKNAME = 'PACK000';
215 my @attrib_help = qw/
217 AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION
218 C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
219 EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE
220 FULLPERL FULLPERLRUN FULLPERLRUNINST
223 INST_ARCHLIB INST_SCRIPT INST_BIN INST_LIB INST_MAN1DIR INST_MAN3DIR
225 DESTDIR PREFIX INSTALL_BASE
226 PERLPREFIX SITEPREFIX VENDORPREFIX
227 INSTALLPRIVLIB INSTALLSITELIB INSTALLVENDORLIB
228 INSTALLARCHLIB INSTALLSITEARCH INSTALLVENDORARCH
229 INSTALLBIN INSTALLSITEBIN INSTALLVENDORBIN
230 INSTALLMAN1DIR INSTALLMAN3DIR
231 INSTALLSITEMAN1DIR INSTALLSITEMAN3DIR
232 INSTALLVENDORMAN1DIR INSTALLVENDORMAN3DIR
233 INSTALLSCRIPT INSTALLSITESCRIPT INSTALLVENDORSCRIPT
234 PERL_LIB PERL_ARCHLIB
235 SITELIBEXP SITEARCHEXP
237 INC INCLUDE_EXT LDFROM LIB LIBPERL_A LIBS LICENSE
238 LINKTYPE MAKE MAKEAPERL MAKEFILE MAKEFILE_OLD MAN1PODS MAN3PODS MAP_TARGET
240 MYEXTLIB NAME NEEDS_LINKING NOECHO NO_META NORECURS NO_VC OBJECT OPTIMIZE
241 PERL_MALLOC_OK PERL PERLMAINCC PERLRUN PERLRUNINST PERL_CORE
242 PERL_SRC PERM_RW PERM_RWX
243 PL_FILES PM PM_FILTER PMLIBDIRS PMLIBPARENTDIRS POLLUTE PPM_INSTALL_EXEC
244 PPM_INSTALL_SCRIPT PREREQ_FATAL PREREQ_PM PREREQ_PRINT PRINT_PREREQ
245 SIGN SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
246 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
249 MACPERL_SRC MACPERL_LIB MACLIBS_68K MACLIBS_PPC MACLIBS_SC MACLIBS_MRC
250 MACLIBS_ALL_68K MACLIBS_ALL_PPC MACLIBS_SHARED
253 # IMPORTS is used under OS/2 and Win32
255 # @Overridable is close to @MM_Sections but not identical. The
256 # order is important. Many subroutines declare macros. These
257 # depend on each other. Let's try to collect the macros up front,
258 # then pasthru, then the rules.
260 # MM_Sections are the sections we have to call explicitly
261 # in Overridable we have subroutines that are used indirectly
267 post_initialize const_config constants platform_constants
268 tool_autosplit tool_xsubpp tools_other
272 dist macro depend cflags const_loadlibs const_cccmd
279 top_targets blibdirs linkext dlsyms dynamic dynamic_bs
280 dynamic_lib static static_lib manifypods processPL
282 clean_subdirs clean realclean_subdirs realclean
284 dist_basics dist_core distdir dist_test dist_ci distmeta distsignature
285 install force perldepend makefile staticmake test ppd
287 ); # loses section ordering
289 @Overridable = @MM_Sections;
290 push @Overridable, qw[
292 libscan makeaperl needs_linking perm_rw perm_rwx
293 subdir_x test_via_harness test_via_script
295 init_VERSION init_dist init_INST init_INSTALL init_DEST init_dirscan
296 init_PM init_MANPODS init_xs init_PERL init_DIRFILESEP init_linker
299 push @MM_Sections, qw[
301 pm_to_blib selfdocument
305 # Postamble needs to be the last that was always the case
306 push @MM_Sections, "postamble";
307 push @Overridable, "postamble";
309 # All sections are valid keys.
310 @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
312 # we will use all these variables in the Makefile
315 ar cc cccdlflags ccdlflags dlext dlsrc exe_ext full_ar ld
316 lddlflags ldflags libc lib_ext obj_ext osname osvers ranlib
317 sitelibexp sitearchexp so
320 # 5.5.3 doesn't have any concept of vendor libs
321 push @Get_from_Config, qw( vendorarchexp vendorlibexp ) if $] >= 5.006;
323 foreach my $item (@attrib_help){
324 $Recognized_Att_Keys{$item} = 1;
326 foreach my $item (@Get_from_Config) {
327 $Recognized_Att_Keys{uc $item} = $Config{$item};
328 print "Attribute '\U$item\E' => '$Config{$item}'\n"
333 # When we eval a Makefile.PL in a subdirectory, that one will ask
334 # us (the parent) for the values and will prepend "..", so that
335 # all files to be installed end up below OUR ./blib
337 @Prepend_parent = qw(
338 INST_BIN INST_LIB INST_ARCHLIB INST_SCRIPT
339 MAP_TARGET INST_MAN1DIR INST_MAN3DIR PERL_SRC
347 The extension you are trying to build apparently is rather old and
348 most probably outdated. We detect that from the fact, that a
349 subroutine "writeMakefile" is called, and this subroutine is not
350 supported anymore since about October 1994.
352 Please contact the author or look into CPAN (details about CPAN can be
353 found in the FAQ and at http:/www.perl.com) for a more recent version
354 of the extension. If you're really desperate, you can try to change
355 the subroutine name from writeMakefile to WriteMakefile and rerun
356 'perl Makefile.PL', but you're most probably left alone, when you do
365 my($class,$self) = @_;
368 # Store the original args passed to WriteMakefile()
369 foreach my $k (keys %$self) {
370 $self->{ARGS}{$k} = $self->{$k};
373 if ("@ARGV" =~ /\bPREREQ_PRINT\b/) {
374 require Data::Dumper;
375 print Data::Dumper->Dump([$self->{PREREQ_PM}], [qw(PREREQ_PM)]);
379 # PRINT_PREREQ is RedHatism.
380 if ("@ARGV" =~ /\bPRINT_PREREQ\b/) {
381 print join(" ", map { "perl($_)>=$self->{PREREQ_PM}->{$_} " }
382 sort keys %{$self->{PREREQ_PM}}), "\n";
386 print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
387 if (-f "MANIFEST" && ! -f "Makefile"){
391 $self = {} unless (defined $self);
395 my %configure_att; # record &{$self->{CONFIGURE}} attributes
396 my(%initial_att) = %$self; # record initial attributes
398 my(%unsatisfied) = ();
399 foreach my $prereq (sort keys %{$self->{PREREQ_PM}}) {
400 # 5.8.0 has a bug with require Foo::Bar alone in an eval, so an
401 # extra statement is a workaround.
402 my $file = "$prereq.pm";
404 eval { require $file };
406 my $pr_version = $prereq->VERSION || 0;
408 # convert X.Y_Z alpha version #s to X.YZ for easier comparisons
409 $pr_version =~ s/(\d+)\.(\d+)_(\d+)/$1.$2$3/;
412 warn sprintf "Warning: prerequisite %s %s not found.\n",
413 $prereq, $self->{PREREQ_PM}{$prereq}
414 unless $self->{PREREQ_FATAL};
415 $unsatisfied{$prereq} = 'not installed';
416 } elsif ($pr_version < $self->{PREREQ_PM}->{$prereq} ){
417 warn sprintf "Warning: prerequisite %s %s not found. We have %s.\n",
418 $prereq, $self->{PREREQ_PM}{$prereq},
419 ($pr_version || 'unknown version')
420 unless $self->{PREREQ_FATAL};
421 $unsatisfied{$prereq} = $self->{PREREQ_PM}->{$prereq} ?
422 $self->{PREREQ_PM}->{$prereq} : 'unknown version' ;
426 if (%unsatisfied && $self->{PREREQ_FATAL}){
427 my $failedprereqs = join "\n", map {" $_ $unsatisfied{$_}"}
428 sort { $a cmp $b } keys %unsatisfied;
430 MakeMaker FATAL: prerequisites not found.
433 Please install these modules first and rerun 'perl Makefile.PL'.
437 if (defined $self->{CONFIGURE}) {
438 if (ref $self->{CONFIGURE} eq 'CODE') {
439 %configure_att = %{&{$self->{CONFIGURE}}};
440 $self = { %$self, %configure_att };
442 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
446 # This is for old Makefiles written pre 5.00, will go away
447 if ( Carp::longmess("") =~ /runsubdirpl/s ){
448 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
451 my $newclass = ++$PACKNAME;
452 local @Parent = @Parent; # Protect against non-local exits
454 print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
455 mv_all_methods("MY",$newclass);
456 bless $self, $newclass;
458 require ExtUtils::MY;
460 no strict 'refs'; ## no critic;
461 @{"$newclass\:\:ISA"} = 'MM';
464 if (defined $Parent[-2]){
465 $self->{PARENT} = $Parent[-2];
466 for my $key (@Prepend_parent) {
467 next unless defined $self->{PARENT}{$key};
469 # Don't stomp on WriteMakefile() args.
470 next if defined $self->{ARGS}{$key} and
471 $self->{ARGS}{$key} eq $self->{$key};
473 $self->{$key} = $self->{PARENT}{$key};
475 unless ($Is_VMS && $key =~ /PERL$/) {
476 $self->{$key} = $self->catdir("..",$self->{$key})
477 unless $self->file_name_is_absolute($self->{$key});
479 # PERL or FULLPERL will be a command verb or even a
480 # command with an argument instead of a full file
481 # specification under VMS. So, don't turn the command
482 # into a filespec, but do add a level to the path of
483 # the argument if not already absolute.
484 my @cmd = split /\s+/, $self->{$key};
485 $cmd[1] = $self->catfile('[-]',$cmd[1])
486 unless (@cmd < 2) || $self->file_name_is_absolute($cmd[1]);
487 $self->{$key} = join(' ', @cmd);
490 if ($self->{PARENT}) {
491 $self->{PARENT}->{CHILDREN}->{$newclass} = $self;
492 foreach my $opt (qw(POLLUTE PERL_CORE LINKTYPE)) {
493 if (exists $self->{PARENT}->{$opt}
494 and not exists $self->{$opt})
496 # inherit, but only if already unspecified
497 $self->{$opt} = $self->{PARENT}->{$opt};
501 my @fm = grep /^FIRST_MAKEFILE=/, @ARGV;
502 parse_args($self,@fm) if @fm;
504 parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV);
508 $self->{NAME} ||= $self->guess_name;
510 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
524 $self->init_DIRFILESEP;
526 $self->init_ABSTRACT;
528 if (! $self->{PERL_SRC} ) {
529 require VMS::Filespec if $Is_VMS;
530 my($pthinks) = $self->canonpath($INC{'Config.pm'});
531 my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
532 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
533 if ($pthinks ne $cthinks &&
534 !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
535 print "Have $pthinks expected $cthinks\n";
537 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
540 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
542 print STDOUT <<END unless $self->{UNINSTALLED_PERL};
543 Your perl and your Config.pm seem to have different ideas about the
544 architecture they are running on.
545 Perl thinks: [$pthinks]
546 Config says: [$Config{archname}]
547 This may or may not cause problems. Please check your installation of perl
548 if you have problems building this extension.
553 $self->init_others();
554 $self->init_platform();
556 my($argv) = neatvalue(\@ARGV);
560 push @{$self->{RESULT}}, <<END;
561 # This Makefile is for the $self->{NAME} extension to perl.
563 # It was generated automatically by MakeMaker version
564 # $VERSION (Revision: $Revision) from the contents of
565 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
567 # ANY CHANGES MADE HERE WILL BE LOST!
569 # MakeMaker ARGV: $argv
571 # MakeMaker Parameters:
574 foreach my $key (sort keys %initial_att){
575 next if $key eq 'ARGS';
577 my($v) = neatvalue($initial_att{$key});
578 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
580 push @{$self->{RESULT}}, "# $key => $v";
582 undef %initial_att; # free memory
584 if (defined $self->{CONFIGURE}) {
585 push @{$self->{RESULT}}, <<END;
587 # MakeMaker 'CONFIGURE' Parameters:
589 if (scalar(keys %configure_att) > 0) {
590 foreach my $key (sort keys %configure_att){
591 next if $key eq 'ARGS';
592 my($v) = neatvalue($configure_att{$key});
593 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
595 push @{$self->{RESULT}}, "# $key => $v";
600 push @{$self->{RESULT}}, "# no values returned";
602 undef %configure_att; # free memory
605 # turn the SKIP array into a SKIPHASH hash
606 for my $skip (@{$self->{SKIP} || []}) {
607 $self->{SKIPHASH}{$skip} = 1;
609 delete $self->{SKIP}; # free memory
611 if ($self->{PARENT}) {
612 for (qw/install dist dist_basics dist_core distdir dist_test dist_ci/) {
613 $self->{SKIPHASH}{$_} = 1;
617 # We run all the subdirectories now. They don't have much to query
618 # from the parent, but the parent has to query them: if they need linking!
619 unless ($self->{NORECURS}) {
620 $self->eval_in_subdirs if @{$self->{DIR}};
623 foreach my $section ( @MM_Sections ){
624 # Support for new foo_target() methods.
625 my $method = $section;
626 $method .= '_target' unless $self->can($method);
628 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
629 my($skipit) = $self->skipcheck($section);
631 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
633 my(%a) = %{$self->{$section} || {}};
634 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
635 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
636 push @{$self->{RESULT}}, $self->maketext_filter(
642 push @{$self->{RESULT}}, "\n# End.";
647 sub WriteEmptyMakefile {
648 Carp::croak "WriteEmptyMakefile: Need an even number of args" if @_ % 2;
651 my $self = MM->new(\%att);
653 my $new = $self->{MAKEFILE};
654 my $old = $self->{MAKEFILE_OLD};
656 _unlink($old) or warn "unlink $old: $!";
659 _rename($new, $old) or warn "rename $new => $old: $!"
661 open my $mfh, '>', $new or die "open $new for write: $!";
674 close $mfh or die "close $new for write: $!";
678 print STDOUT "Checking if your kit is complete...\n";
679 require ExtUtils::Manifest;
681 $ExtUtils::Manifest::Quiet = $ExtUtils::Manifest::Quiet = 1;
682 my(@missed) = ExtUtils::Manifest::manicheck();
684 print STDOUT "Warning: the following files are missing in your kit:\n";
685 print "\t", join "\n\t", @missed;
687 print STDOUT "Please inform the author.\n";
689 print STDOUT "Looks good\n";
694 my($self, @args) = @_;
696 unless (m/(.*?)=(.*)/) {
697 ++$Verbose if m/^verb/;
700 my($name, $value) = ($1, $2);
701 if ($value =~ m/^~(\w+)?/) { # tilde with optional username
702 $value =~ s [^~(\w*)]
704 ((getpwnam($1))[7] || "~$1") :
709 # Remember the original args passed it. It will be useful later.
710 $self->{ARGS}{uc $name} = $self->{uc $name} = $value;
713 # catch old-style 'potential_libs' and inform user how to 'upgrade'
714 if (defined $self->{potential_libs}){
715 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
716 if ($self->{potential_libs}){
717 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
719 print STDOUT "$msg deleted.\n";
721 $self->{LIBS} = [$self->{potential_libs}];
722 delete $self->{potential_libs};
724 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
725 if (defined $self->{ARMAYBE}){
726 my($armaybe) = $self->{ARMAYBE};
727 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
728 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
729 my(%dl) = %{$self->{dynamic_lib} || {}};
730 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
731 delete $self->{ARMAYBE};
733 if (defined $self->{LDTARGET}){
734 print STDOUT "LDTARGET should be changed to LDFROM\n";
735 $self->{LDFROM} = $self->{LDTARGET};
736 delete $self->{LDTARGET};
738 # Turn a DIR argument on the command line into an array
739 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
740 # So they can choose from the command line, which extensions they want
741 # the grep enables them to have some colons too much in case they
742 # have to build a list with the shell
743 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
745 # Turn a INCLUDE_EXT argument on the command line into an array
746 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
747 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
749 # Turn a EXCLUDE_EXT argument on the command line into an array
750 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
751 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
754 foreach my $mmkey (sort keys %$self){
755 next if $mmkey eq 'ARGS';
756 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
757 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
758 unless exists $Recognized_Att_Keys{$mmkey};
765 # We allow extension-specific hints files.
768 my $curdir = File::Spec->curdir;
770 my $hint_dir = File::Spec->catdir($curdir, "hints");
771 return unless -d $hint_dir;
773 # First we look for the best hintsfile we have
774 my($hint)="${^O}_$Config{osvers}";
779 # Also try without trailing minor version numbers.
781 last if -f File::Spec->catfile($hint_dir, "$hint.pl"); # found
783 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
785 my $hint_file = File::Spec->catfile($hint_dir, "$hint.pl");
787 return unless -f $hint_file; # really there
789 _run_hintfile($self, $hint_file);
794 local($self) = shift; # make $self available to the hint file.
795 my($hint_file) = shift;
798 print STDERR "Processing hints file $hint_file\n";
800 # Just in case the ./ isn't on the hint file, which File::Spec can
801 # often strip off, we bung the curdir into @INC
802 local @INC = (File::Spec->curdir, @INC);
803 my $ret = do $hint_file;
804 if( !defined $ret ) {
805 my $error = $@ || $!;
813 # Here you see the *current* list of methods that are overridable
814 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
815 # still trying to reduce the list to some reasonable minimum --
816 # because I want to make it easier for the user. A.K.
818 local $SIG{__WARN__} = sub {
819 # can't use 'no warnings redefined', 5.6 only
820 warn @_ unless $_[0] =~ /^Subroutine .* redefined/
822 foreach my $method (@Overridable) {
824 # We cannot say "next" here. Nick might call MY->makeaperl
825 # which isn't defined right now
827 # Above statement was written at 4.23 time when Tk-b8 was
828 # around. As Tk-b9 only builds with 5.002something and MM 5 is
829 # standard, we try to enable the next line again. It was
830 # commented out until MM 5.23
832 next unless defined &{"${from}::$method"};
835 no strict 'refs'; ## no critic
836 *{"${to}::$method"} = \&{"${from}::$method"};
838 # If we delete a method, then it will be undefined and cannot
839 # be called. But as long as we have Makefile.PLs that rely on
840 # %MY:: being intact, we have to fill the hole with an
845 my $super = "SUPER::".$method;
853 # We have to clean out %INC also, because the current directory is
854 # changed frequently and Graham Barr prefers to get his version
855 # out of a History.pl file which is "required" so woudn't get
856 # loaded again in another extension requiring a History.pl
858 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
859 # to core dump in the middle of a require statement. The required
860 # file was Tk/MMutil.pm. The consequence is, we have to be
861 # extremely careful when we try to give perl a reason to reload a
862 # library with same name. The workaround prefers to drop nothing
863 # from %INC and teach the writers not to use such libraries.
866 # foreach $inc (keys %INC) {
867 # #warn "***$inc*** deleted";
875 if ($section eq 'dynamic') {
876 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
877 "in skipped section 'dynamic_bs'\n"
878 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
879 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
880 "in skipped section 'dynamic_lib'\n"
881 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
883 if ($section eq 'dynamic_lib') {
884 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
885 "targets in skipped section 'dynamic_bs'\n"
886 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
888 if ($section eq 'static') {
889 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
890 "in skipped section 'static_lib'\n"
891 if $self->{SKIPHASH}{static_lib} && $Verbose;
893 return 'skipped' if $self->{SKIPHASH}{$section};
900 my $finalname = $self->{MAKEFILE};
901 print STDOUT "Writing $finalname for $self->{NAME}\n";
903 unlink($finalname, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : ());
904 open(my $fh,">", "MakeMaker.tmp")
905 or die "Unable to open MakeMaker.tmp: $!";
907 for my $chunk (@{$self->{RESULT}}) {
908 print $fh "$chunk\n";
912 _rename("MakeMaker.tmp", $finalname) or
913 warn "rename MakeMaker.tmp => $finalname: $!";
914 chmod 0644, $finalname unless $Is_VMS;
916 my %keep = map { ($_ => 1) } qw(NEEDS_LINKING HAS_LINK_CODE);
918 if ($self->{PARENT} && !$self->{_KEEP_AFTER_FLUSH}) {
919 foreach (keys %$self) { # safe memory
920 delete $self->{$_} unless $keep{$_};
924 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
928 # This is a rename for OS's where the target must be unlinked first.
930 my($src, $dest) = @_;
933 return rename $src, $dest;
936 # This is an unlink for OS's where the target must be writable first.
940 return unlink @files;
944 # The following mkbootstrap() is only for installations that are calling
945 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
946 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
949 !!! Your Makefile has been built such a long time ago, !!!
950 !!! that is unlikely to work with current MakeMaker. !!!
951 !!! Please rebuild your Makefile !!!
955 # Ditto for mksymlists() as of MakeMaker 5.17
958 !!! Your Makefile has been built such a long time ago, !!!
959 !!! that is unlikely to work with current MakeMaker. !!!
960 !!! Please rebuild your Makefile !!!
966 return "undef" unless defined $v;
968 return "q[$v]" unless $t;
972 foreach my $elem (@$v) {
973 push @neat, "q[$elem]";
975 push @m, join ", ", @neat;
979 return "$v" unless $t eq 'HASH';
981 while (($key,$val) = each %$v){
982 last unless defined $key; # cautious programming in case (undef,undef) is true
983 push(@m,"$key=>".neatvalue($val)) ;
985 return "{ ".join(', ',@m)." }";
992 push @m, "\n# Full list of MakeMaker attribute values:";
993 foreach my $key (sort keys %$self){
994 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
995 my($v) = neatvalue($self->{$key});
996 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
998 push @m, "# $key => $v";
1010 ExtUtils::MakeMaker - Create a module Makefile
1014 use ExtUtils::MakeMaker;
1016 WriteMakefile( ATTRIBUTE => VALUE [, ...] );
1020 This utility is designed to write a Makefile for an extension module
1021 from a Makefile.PL. It is based on the Makefile.SH model provided by
1022 Andy Dougherty and the perl5-porters.
1024 It splits the task of generating the Makefile into several subroutines
1025 that can be individually overridden. Each subroutine returns the text
1026 it wishes to have written to the Makefile.
1028 MakeMaker is object oriented. Each directory below the current
1029 directory that contains a Makefile.PL is treated as a separate
1030 object. This makes it possible to write an unlimited number of
1031 Makefiles with a single invocation of WriteMakefile().
1033 =head2 How To Write A Makefile.PL
1035 See ExtUtils::MakeMaker::Tutorial.
1037 The long answer is the rest of the manpage :-)
1039 =head2 Default Makefile Behaviour
1041 The generated Makefile enables the user of the extension to invoke
1043 perl Makefile.PL # optionally "perl Makefile.PL verbose"
1045 make test # optionally set TEST_VERBOSE=1
1046 make install # See below
1048 The Makefile to be produced may be altered by adding arguments of the
1049 form C<KEY=VALUE>. E.g.
1051 perl Makefile.PL INSTALL_BASE=~
1053 Other interesting targets in the generated Makefile are
1055 make config # to check if the Makefile is up-to-date
1056 make clean # delete local temp files (Makefile gets renamed)
1057 make realclean # delete derived files (including ./blib)
1058 make ci # check in all the files in the MANIFEST file
1059 make dist # see below the Distribution Support section
1063 MakeMaker checks for the existence of a file named F<test.pl> in the
1064 current directory and if it exists it execute the script with the
1065 proper set of perl C<-I> options.
1067 MakeMaker also checks for any files matching glob("t/*.t"). It will
1068 execute all matching files in alphabetical order via the
1069 L<Test::Harness> module with the C<-I> switches set correctly.
1071 If you'd like to see the raw output of your tests, set the
1072 C<TEST_VERBOSE> variable to true.
1074 make test TEST_VERBOSE=1
1078 A useful variation of the above is the target C<testdb>. It runs the
1079 test under the Perl debugger (see L<perldebug>). If the file
1080 F<test.pl> exists in the current directory, it is used for the test.
1082 If you want to debug some other testfile, set the C<TEST_FILE> variable
1085 make testdb TEST_FILE=t/mytest.t
1087 By default the debugger is called using C<-d> option to perl. If you
1088 want to specify some other option, set the C<TESTDB_SW> variable:
1090 make testdb TESTDB_SW=-Dx
1094 make alone puts all relevant files into directories that are named by
1095 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_MAN1DIR and
1096 INST_MAN3DIR. All these default to something below ./blib if you are
1097 I<not> building below the perl source directory. If you I<are>
1098 building below the perl source, INST_LIB and INST_ARCHLIB default to
1099 ../../lib, and INST_SCRIPT is not defined.
1101 The I<install> target of the generated Makefile copies the files found
1102 below each of the INST_* directories to their INSTALL*
1103 counterparts. Which counterparts are chosen depends on the setting of
1104 INSTALLDIRS according to the following table:
1109 PERLPREFIX SITEPREFIX VENDORPREFIX
1110 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH INSTALLVENDORARCH
1111 INST_LIB INSTALLPRIVLIB INSTALLSITELIB INSTALLVENDORLIB
1112 INST_BIN INSTALLBIN INSTALLSITEBIN INSTALLVENDORBIN
1113 INST_SCRIPT INSTALLSCRIPT INSTALLSITESCRIPT INSTALLVENDORSCRIPT
1114 INST_MAN1DIR INSTALLMAN1DIR INSTALLSITEMAN1DIR INSTALLVENDORMAN1DIR
1115 INST_MAN3DIR INSTALLMAN3DIR INSTALLSITEMAN3DIR INSTALLVENDORMAN3DIR
1117 The INSTALL... macros in turn default to their %Config
1118 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
1120 You can check the values of these variables on your system with
1124 And to check the sequence in which the library directories are
1125 searched by perl, run
1127 perl -le 'print join $/, @INC'
1129 Sometimes older versions of the module you're installing live in other
1130 directories in @INC. Because Perl loads the first version of a module it
1131 finds, not the newest, you might accidentally get one of these older
1132 versions even after installing a brand new version. To delete I<all other
1133 versions of the module you're installing> (not simply older ones) set the
1136 make install UNINST=1
1141 INSTALL_BASE can be passed into Makefile.PL to change where your
1142 module will be installed. INSTALL_BASE is more like what everyone
1143 else calls "prefix" than PREFIX is.
1145 To have everything installed in your home directory, do the following.
1147 # Unix users, INSTALL_BASE=~ works fine
1148 perl Makefile.PL INSTALL_BASE=/path/to/your/home/dir
1150 Like PREFIX, it sets several INSTALL* attributes at once. Unlike
1151 PREFIX it is easy to predict where the module will end up. The
1152 installation pattern looks like this:
1154 INSTALLARCHLIB INSTALL_BASE/lib/perl5/$Config{archname}
1155 INSTALLPRIVLIB INSTALL_BASE/lib/perl5
1156 INSTALLBIN INSTALL_BASE/bin
1157 INSTALLSCRIPT INSTALL_BASE/bin
1158 INSTALLMAN1DIR INSTALL_BASE/man/man1
1159 INSTALLMAN3DIR INSTALL_BASE/man/man3
1161 INSTALL_BASE in MakeMaker and C<--install_base> in Module::Build (as
1162 of 0.28) install to the same location. If you want MakeMaker and
1163 Module::Build to install to the same location simply set INSTALL_BASE
1164 and C<--install_base> to the same location.
1166 INSTALL_BASE was added in 6.31.
1169 =head2 PREFIX and LIB attribute
1171 PREFIX and LIB can be used to set several INSTALL* attributes in one
1172 go. Here's an example for installing into your home directory.
1174 # Unix users, PREFIX=~ works fine
1175 perl Makefile.PL PREFIX=/path/to/your/home/dir
1177 This will install all files in the module under your home directory,
1178 with man pages and libraries going into an appropriate place (usually
1179 ~/man and ~/lib). How the exact location is determined is complicated
1180 and depends on how your Perl was configured. INSTALL_BASE works more
1181 like what other build systems call "prefix" than PREFIX and we
1182 recommend you use that instead.
1184 Another way to specify many INSTALL directories with a single
1187 perl Makefile.PL LIB=~/lib
1189 This will install the module's architecture-independent files into
1190 ~/lib, the architecture-dependent files into ~/lib/$archname.
1192 Note, that in both cases the tilde expansion is done by MakeMaker, not
1193 by perl by default, nor by make.
1195 Conflicts between parameters LIB, PREFIX and the various INSTALL*
1196 arguments are resolved so that:
1202 setting LIB overrides any setting of INSTALLPRIVLIB, INSTALLARCHLIB,
1203 INSTALLSITELIB, INSTALLSITEARCH (and they are not affected by PREFIX);
1207 without LIB, setting PREFIX replaces the initial C<$Config{prefix}>
1208 part of those INSTALL* arguments, even if the latter are explicitly
1209 set (but are set to still start with C<$Config{prefix}>).
1213 If the user has superuser privileges, and is not working on AFS or
1214 relatives, then the defaults for INSTALLPRIVLIB, INSTALLARCHLIB,
1215 INSTALLSCRIPT, etc. will be appropriate, and this incantation will be
1223 make install per default writes some documentation of what has been
1224 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1225 can be bypassed by calling make pure_install.
1229 will have to specify the installation directories as these most
1230 probably have changed since perl itself has been installed. They will
1231 have to do this by calling
1233 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1234 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1237 Be careful to repeat this procedure every time you recompile an
1238 extension, unless you are sure the AFS installation directories are
1241 =head2 Static Linking of a new Perl Binary
1243 An extension that is built with the above steps is ready to use on
1244 systems supporting dynamic loading. On systems that do not support
1245 dynamic loading, any newly created extension has to be linked together
1246 with the available resources. MakeMaker supports the linking process
1247 by creating appropriate targets in the Makefile whenever an extension
1248 is built. You can invoke the corresponding section of the makefile with
1252 That produces a new perl binary in the current directory with all
1253 extensions linked in that can be found in INST_ARCHLIB, SITELIBEXP,
1254 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1255 UNIX, this is called Makefile.aperl (may be system dependent). If you
1256 want to force the creation of a new perl, it is recommended, that you
1257 delete this Makefile.aperl, so the directories are searched-through
1258 for linkable libraries again.
1260 The binary can be installed into the directory where perl normally
1261 resides on your machine with
1265 To produce a perl binary with a different name than C<perl>, either say
1267 perl Makefile.PL MAP_TARGET=myperl
1274 make myperl MAP_TARGET=myperl
1275 make inst_perl MAP_TARGET=myperl
1277 In any case you will be prompted with the correct invocation of the
1278 C<inst_perl> target that installs the new binary into INSTALLBIN.
1280 make inst_perl per default writes some documentation of what has been
1281 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1282 can be bypassed by calling make pure_inst_perl.
1284 Warning: the inst_perl: target will most probably overwrite your
1285 existing perl binary. Use with care!
1287 Sometimes you might want to build a statically linked perl although
1288 your system supports dynamic loading. In this case you may explicitly
1289 set the linktype with the invocation of the Makefile.PL or make:
1291 perl Makefile.PL LINKTYPE=static # recommended
1295 make LINKTYPE=static # works on most systems
1297 =head2 Determination of Perl Library and Installation Locations
1299 MakeMaker needs to know, or to guess, where certain things are
1300 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1301 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1302 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1304 Extensions may be built either using the contents of the perl source
1305 directory tree or from the installed perl library. The recommended way
1306 is to build extensions after you have run 'make install' on perl
1307 itself. You can do that in any directory on your hard disk that is not
1308 below the perl source tree. The support for extensions below the ext
1309 directory of the perl distribution is only good for the standard
1310 extensions that come with perl.
1312 If an extension is being built below the C<ext/> directory of the perl
1313 source then MakeMaker will set PERL_SRC automatically (e.g.,
1314 C<../..>). If PERL_SRC is defined and the extension is recognized as
1315 a standard extension, then other variables default to the following:
1318 PERL_LIB = PERL_SRC/lib
1319 PERL_ARCHLIB = PERL_SRC/lib
1321 INST_ARCHLIB = PERL_ARCHLIB
1323 If an extension is being built away from the perl source then MakeMaker
1324 will leave PERL_SRC undefined and default to using the installed copy
1325 of the perl library. The other variables default to the following:
1327 PERL_INC = $archlibexp/CORE
1328 PERL_LIB = $privlibexp
1329 PERL_ARCHLIB = $archlibexp
1330 INST_LIB = ./blib/lib
1331 INST_ARCHLIB = ./blib/arch
1333 If perl has not yet been installed then PERL_SRC can be defined on the
1334 command line as shown in the previous section.
1337 =head2 Which architecture dependent directory?
1339 If you don't want to keep the defaults for the INSTALL* macros,
1340 MakeMaker helps you to minimize the typing needed: the usual
1341 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1342 by Configure at perl compilation time. MakeMaker supports the user who
1343 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1344 then MakeMaker defaults the latter to be the same subdirectory of
1345 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1346 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1347 for INSTALLSITELIB and INSTALLSITEARCH.
1349 MakeMaker gives you much more freedom than needed to configure
1350 internal variables and get different results. It is worth to mention,
1351 that make(1) also lets you configure most of the variables that are
1352 used in the Makefile. But in the majority of situations this will not
1353 be necessary, and should only be done if the author of a package
1354 recommends it (or you know what you're doing).
1356 =head2 Using Attributes and Parameters
1358 The following attributes may be specified as arguments to WriteMakefile()
1359 or as NAME=VALUE pairs on the command line.
1365 One line description of the module. Will be included in PPD file.
1369 Name of the file that contains the package description. MakeMaker looks
1370 for a line in the POD matching /^($package\s-\s)(.*)/. This is typically
1371 the first line in the "=head1 NAME" section. $2 becomes the abstract.
1375 String containing name (and email address) of package author(s). Is used
1376 in PPD (Perl Package Description) files for PPM (Perl Package Manager).
1378 =item BINARY_LOCATION
1380 Used when creating PPD files for binary packages. It can be set to a
1381 full or relative path or URL to the binary archive for a particular
1382 architecture. For example:
1384 perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
1386 builds a PPD package that references a binary of the C<Agent> package,
1387 located in the C<x86> directory relative to the PPD itself.
1391 Ref to array of *.c file names. Initialised from a directory scan
1392 and the values portion of the XS attribute hash. This is not
1393 currently used by MakeMaker but may be handy in Makefile.PLs.
1397 String that will be included in the compiler call command line between
1398 the arguments INC and OPTIMIZE.
1402 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1403 config.sh. MakeMaker will add to CONFIG the following values anyway:
1423 CODE reference. The subroutine should return a hash reference. The
1424 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1425 be determined by some evaluation method.
1429 Something like C<"-DHAVE_UNISTD_H">
1433 This is the root directory into which the code will be installed. It
1434 I<prepends itself to the normal prefix>. For example, if your code
1435 would normally go into F</usr/local/lib/perl> you could set DESTDIR=~/tmp/
1436 and installation would go into F<~/tmp/usr/local/lib/perl>.
1438 This is primarily of use for people who repackage Perl modules.
1440 NOTE: Due to the nature of make, it is important that you put the trailing
1441 slash on your DESTDIR. F<~/tmp/> not F<~/tmp>.
1445 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1450 A safe filename for the package.
1452 Defaults to NAME above but with :: replaced with -.
1454 For example, Foo::Bar becomes Foo-Bar.
1458 Your name for distributing the package with the version number
1459 included. This is used by 'make dist' to name the resulting archive
1462 Defaults to DISTNAME-VERSION.
1464 For example, version 1.04 of Foo::Bar becomes Foo-Bar-1.04.
1466 On some OS's where . has special meaning VERSION_SYM may be used in
1471 Hashref of symbol names for routines to be made available as universal
1472 symbols. Each key/value pair consists of the package name and an
1473 array of routine names in that package. Used only under AIX, OS/2,
1474 VMS and Win32 at present. The routine names supplied will be expanded
1475 in the same way as XSUB names are expanded by the XS() macro.
1478 {"$(NAME)" => ["boot_$(NAME)" ] }
1482 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1483 "NetconfigPtr" => [ 'DESTROY'] }
1485 Please see the L<ExtUtils::Mksymlists> documentation for more information
1486 about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
1490 Array of symbol names for variables to be made available as universal symbols.
1491 Used only under AIX, OS/2, VMS and Win32 at present. Defaults to [].
1492 (e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
1496 Array of extension names to exclude when doing a static build. This
1497 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1498 details. (e.g. [ qw( Socket POSIX ) ] )
1500 This attribute may be most useful when specified as a string on the
1501 command line: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1505 Ref to array of executable files. The files will be copied to the
1506 INST_SCRIPT directory. Make realclean will delete them from there
1509 If your executables start with something like #!perl or
1510 #!/usr/bin/perl MakeMaker will change this to the path of the perl
1511 'Makefile.PL' was invoked with so the programs will be sure to run
1512 properly even if perl is not in /usr/bin/perl.
1514 =item FIRST_MAKEFILE
1516 The name of the Makefile to be produced. This is used for the second
1517 Makefile that will be produced for the MAP_TARGET.
1519 Defaults to 'Makefile' or 'Descrip.MMS' on VMS.
1521 (Note: we couldn't use MAKEFILE because dmake uses this for something
1526 Perl binary able to run this extension, load XS modules, etc...
1530 Like PERLRUN, except it uses FULLPERL.
1532 =item FULLPERLRUNINST
1534 Like PERLRUNINST, except it uses FULLPERL.
1538 This provides an alternate means to specify function names to be
1539 exported from the extension. Its value is a reference to an
1540 array of function names to be exported by the extension. These
1541 names are passed through unaltered to the linker options file.
1545 Ref to array of *.h file names. Similar to C.
1549 This attribute is used to specify names to be imported into the
1550 extension. Takes a hash ref.
1552 It is only used on OS/2 and Win32.
1556 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1560 Array of extension names to be included when doing a static build.
1561 MakeMaker will normally build with all of the installed extensions when
1562 doing a static build, and that is usually the desired behavior. If
1563 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1564 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1566 It is not necessary to mention DynaLoader or the current extension when
1567 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1568 only DynaLoader and the current extension will be included in the build.
1570 This attribute may be most useful when specified as a string on the
1571 command line: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1573 =item INSTALLARCHLIB
1575 Used by 'make install', which copies files from INST_ARCHLIB to this
1576 directory if INSTALLDIRS is set to perl.
1580 Directory to install binary files (e.g. tkperl) into if
1585 Determines which of the sets of installation directories to choose:
1586 perl, site or vendor. Defaults to site.
1588 =item INSTALLMAN1DIR
1590 =item INSTALLMAN3DIR
1592 These directories get the man pages at 'make install' time if
1593 INSTALLDIRS=perl. Defaults to $Config{installman*dir}.
1595 If set to 'none', no man pages will be installed.
1597 =item INSTALLPRIVLIB
1599 Used by 'make install', which copies files from INST_LIB to this
1600 directory if INSTALLDIRS is set to perl.
1602 Defaults to $Config{installprivlib}.
1606 Used by 'make install' which copies files from INST_SCRIPT to this
1607 directory if INSTALLDIRS=perl.
1609 =item INSTALLSITEARCH
1611 Used by 'make install', which copies files from INST_ARCHLIB to this
1612 directory if INSTALLDIRS is set to site (default).
1614 =item INSTALLSITEBIN
1616 Used by 'make install', which copies files from INST_BIN to this
1617 directory if INSTALLDIRS is set to site (default).
1619 =item INSTALLSITELIB
1621 Used by 'make install', which copies files from INST_LIB to this
1622 directory if INSTALLDIRS is set to site (default).
1624 =item INSTALLSITEMAN1DIR
1626 =item INSTALLSITEMAN3DIR
1628 These directories get the man pages at 'make install' time if
1629 INSTALLDIRS=site (default). Defaults to
1630 $(SITEPREFIX)/man/man$(MAN*EXT).
1632 If set to 'none', no man pages will be installed.
1634 =item INSTALLSITESCRIPT
1636 Used by 'make install' which copies files from INST_SCRIPT to this
1637 directory if INSTALLDIRS is set to site (default).
1639 =item INSTALLVENDORARCH
1641 Used by 'make install', which copies files from INST_ARCHLIB to this
1642 directory if INSTALLDIRS is set to vendor.
1644 =item INSTALLVENDORBIN
1646 Used by 'make install', which copies files from INST_BIN to this
1647 directory if INSTALLDIRS is set to vendor.
1649 =item INSTALLVENDORLIB
1651 Used by 'make install', which copies files from INST_LIB to this
1652 directory if INSTALLDIRS is set to vendor.
1654 =item INSTALLVENDORMAN1DIR
1656 =item INSTALLVENDORMAN3DIR
1658 These directories get the man pages at 'make install' time if
1659 INSTALLDIRS=vendor. Defaults to $(VENDORPREFIX)/man/man$(MAN*EXT).
1661 If set to 'none', no man pages will be installed.
1663 =item INSTALLVENDORSCRIPT
1665 Used by 'make install' which copies files from INST_SCRIPT to this
1666 directory if INSTALLDIRS is set to is set to vendor.
1670 Same as INST_LIB for architecture dependent files.
1674 Directory to put real binary files during 'make'. These will be copied
1675 to INSTALLBIN during 'make install'
1679 Directory where we put library files of this extension while building
1684 Directory to hold the man pages at 'make' time
1688 Directory to hold the man pages at 'make' time
1692 Directory, where executable files should be installed during
1693 'make'. Defaults to "./blib/script", just to have a dummy location during
1694 testing. make install will copy the files in INST_SCRIPT to
1699 Program to be used to link libraries for dynamic loading.
1701 Defaults to $Config{ld}.
1705 Any special flags that might need to be passed to ld to create a
1706 shared library suitable for dynamic loading. It is up to the makefile
1707 to use it. (See L<Config/lddlflags>)
1709 Defaults to $Config{lddlflags}.
1713 Defaults to "$(OBJECT)" and is used in the ld command to specify
1714 what files to link/load from (also see dynamic_lib below for how to
1719 LIB should only be set at C<perl Makefile.PL> time but is allowed as a
1720 MakeMaker argument. It has the effect of setting both INSTALLPRIVLIB
1721 and INSTALLSITELIB to that value regardless any explicit setting of
1722 those arguments (or of PREFIX). INSTALLARCHLIB and INSTALLSITEARCH
1723 are set to the corresponding architecture subdirectory.
1727 The filename of the perllibrary that will be used together with this
1728 extension. Defaults to libperl.a.
1732 An anonymous array of alternative library
1733 specifications to be searched for (in order) until
1734 at least one library is found. E.g.
1736 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1738 Mind, that any element of the array
1739 contains a complete set of arguments for the ld
1740 command. So do not specify
1742 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1744 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1745 you specify a scalar as in
1747 'LIBS' => "-ltcl -ltk -lX11"
1749 MakeMaker will turn it into an array with one element.
1753 The licensing terms of your distribution. Generally its "perl" for the
1754 same license as Perl itself.
1756 See L<Module::Build::API> for the list of options.
1758 Defaults to "unknown".
1762 'static' or 'dynamic' (default unless usedl=undef in
1763 config.sh). Should only be used to force static linking (also see
1768 Variant of make you intend to run the generated Makefile with. This
1769 parameter lets Makefile.PL know what make quirks to account for when
1770 generating the Makefile.
1772 MakeMaker also honors the MAKE environment variable. This parameter
1775 Currently the only significant values are 'dmake' and 'nmake' for Windows
1778 Defaults to $Config{make}.
1782 Boolean which tells MakeMaker, that it should include the rules to
1783 make a perl. This is handled automatically as a switch by
1784 MakeMaker. The user normally does not need it.
1788 When 'make clean' or similar is run, the $(FIRST_MAKEFILE) will be
1789 backed up at this location.
1791 Defaults to $(FIRST_MAKEFILE).old or $(FIRST_MAKEFILE)_old on VMS.
1795 Hashref of pod-containing files. MakeMaker will default this to all
1796 EXE_FILES files that include POD directives. The files listed
1797 here will be converted to man pages and installed as was requested
1802 Hashref that assigns to *.pm and *.pod files the files into which the
1803 manpages are to be written. MakeMaker parses all *.pod and *.pm files
1804 for POD directives. Files that contain POD will be the default keys of
1805 the MAN3PODS hashref. These will then be converted to man pages during
1806 C<make> and will be installed during C<make install>.
1810 If it is intended, that a new perl binary be produced, this variable
1811 may hold a name for that binary. Defaults to perl
1817 A hashrefs of items to add to the F<META.yml>.
1819 They differ in how they behave if they have the same key as the
1820 default metadata. META_ADD will override the default value with it's
1821 own. META_MERGE will merge its value with the default.
1823 Unless you want to override the defaults, prefer META_MERGE so as to
1824 get the advantage of any future defaults.
1828 If the extension links to a library that it builds set this to the
1829 name of the library (see SDBM_File)
1833 Perl module name for this extension (DBD::Oracle). This will default
1834 to the directory name but should be explicitly defined in the
1839 MakeMaker will figure out if an extension contains linkable code
1840 anywhere down the directory tree, and will set this variable
1841 accordingly, but you can speed it up a very little bit if you define
1842 this boolean variable yourself.
1846 Command so make does not print the literal commands its running.
1848 By setting it to an empty string you can generate a Makefile that
1849 prints all commands. Mainly used in debugging MakeMaker itself.
1855 Boolean. Attribute to inhibit descending into subdirectories.
1859 When true, suppresses the generation and addition to the MANIFEST of
1860 the META.yml module meta-data file during 'make distdir'.
1866 In general, any generated Makefile checks for the current version of
1867 MakeMaker and the version the Makefile was built under. If NO_VC is
1868 set, the version check is neglected. Do not write this into your
1869 Makefile.PL, use it interactively instead.
1873 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1874 string containing all object files, e.g. "tkpBind.o
1875 tkpButton.o tkpCanvas.o"
1877 (Where BASEEXT is the last component of NAME, and OBJ_EXT is $Config{obj_ext}.)
1881 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1882 passed to subdirectory makes.
1886 Perl binary for tasks that can be done by miniperl
1890 Set only when MakeMaker is building the extensions of the Perl core
1895 The call to the program that is able to compile perlmain.c. Defaults
1900 Same as for PERL_LIB, but for architecture dependent files.
1902 Used only when MakeMaker is building the extensions of the Perl core
1903 distribution (because normally $(PERL_ARCHLIB) is automatically in @INC,
1904 and adding it would get in the way of PERL5LIB).
1908 Directory containing the Perl library to use.
1910 Used only when MakeMaker is building the extensions of the Perl core
1911 distribution (because normally $(PERL_LIB) is automatically in @INC,
1912 and adding it would get in the way of PERL5LIB).
1914 =item PERL_MALLOC_OK
1916 defaults to 0. Should be set to TRUE if the extension can work with
1917 the memory allocation routines substituted by the Perl malloc() subsystem.
1918 This should be applicable to most extensions with exceptions of those
1924 with bugs in memory allocations which are caught by Perl's malloc();
1928 which interact with the memory allocator in other ways than via
1929 malloc(), realloc(), free(), calloc(), sbrk() and brk();
1933 which rely on special alignment which is not provided by Perl's malloc().
1937 B<NOTE.> Negligence to set this flag in I<any one> of loaded extension
1938 nullifies many advantages of Perl's malloc(), such as better usage of
1939 system resources, error detection, memory usage reporting, catchable failure
1940 of memory allocations, etc.
1944 Directory under which core modules are to be installed.
1946 Defaults to $Config{installprefixexp} falling back to
1947 $Config{installprefix}, $Config{prefixexp} or $Config{prefix} should
1948 $Config{installprefixexp} not exist.
1950 Overridden by PREFIX.
1954 Use this instead of $(PERL) when you wish to run perl. It will set up
1955 extra necessary flags for you.
1959 Use this instead of $(PERL) when you wish to run perl to work with
1960 modules. It will add things like -I$(INST_ARCH) and other necessary
1961 flags so perl can see the modules you're about to install.
1965 Directory containing the Perl source code (use of this should be
1966 avoided, it may be undefined)
1970 Desired permission for read/writable files. Defaults to C<644>.
1971 See also L<MM_Unix/perm_rw>.
1975 Desired permission for executable files. Defaults to C<755>.
1976 See also L<MM_Unix/perm_rwx>.
1980 MakeMaker can run programs to generate files for you at build time.
1981 By default any file named *.PL (except Makefile.PL and Build.PL) in
1982 the top level directory will be assumed to be a Perl program and run
1983 passing its own basename in as an argument. For example...
1987 This behavior can be overridden by supplying your own set of files to
1988 search. PL_FILES accepts a hash ref, the key being the file to run
1989 and the value is passed in as the first argument when the PL file is run.
1991 PL_FILES => {'bin/foobar.PL' => 'bin/foobar'}
1993 Would run bin/foobar.PL like this:
1995 perl bin/foobar.PL bin/foobar
1997 If multiple files from one program are desired an array ref can be used.
1999 PL_FILES => {'bin/foobar.PL' => [qw(bin/foobar1 bin/foobar2)]}
2001 In this case the program will be run multiple times using each target file.
2003 perl bin/foobar.PL bin/foobar1
2004 perl bin/foobar.PL bin/foobar2
2006 PL files are normally run B<after> pm_to_blib and include INST_LIB and
2007 INST_ARCH in its C<@INC> so the just built modules can be
2008 accessed... unless the PL file is making a module (or anything else in
2009 PM) in which case it is run B<before> pm_to_blib and does not include
2010 INST_LIB and INST_ARCH in its C<@INC>. This apparently odd behavior
2011 is there for backwards compatibility (and its somewhat DWIM).
2016 Hashref of .pm files and *.pl files to be installed. e.g.
2018 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
2020 By default this will include *.pm and *.pl and the files found in
2021 the PMLIBDIRS directories. Defining PM in the
2022 Makefile.PL will override PMLIBDIRS.
2026 Ref to array of subdirectories containing library files. Defaults to
2027 [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
2028 they contain will be installed in the corresponding location in the
2029 library. A libscan() method can be used to alter the behaviour.
2030 Defining PM in the Makefile.PL will override PMLIBDIRS.
2032 (Where BASEEXT is the last component of NAME.)
2036 A filter program, in the traditional Unix sense (input from stdin, output
2037 to stdout) that is passed on each .pm file during the build (in the
2038 pm_to_blib() phase). It is empty by default, meaning no filtering is done.
2040 Great care is necessary when defining the command if quoting needs to be
2041 done. For instance, you would need to say:
2043 {'PM_FILTER' => 'grep -v \\"^\\#\\"'}
2045 to remove all the leading comments on the fly during the build. The
2046 extra \\ are necessary, unfortunately, because this variable is interpolated
2047 within the context of a Perl program built on the command line, and double
2048 quotes are what is used with the -e switch to build that command line. The
2049 # is escaped for the Makefile, since what is going to be generated will then
2052 PM_FILTER = grep -v \"^\#\"
2054 Without the \\ before the #, we'd have the start of a Makefile comment,
2055 and the macro would be incorrectly defined.
2059 Release 5.005 grandfathered old global symbol names by providing preprocessor
2060 macros for extension source compatibility. As of release 5.6, these
2061 preprocessor definitions are not available by default. The POLLUTE flag
2062 specifies that the old names should still be defined:
2064 perl Makefile.PL POLLUTE=1
2066 Please inform the module author if this is necessary to successfully install
2067 a module under 5.6 or later.
2069 =item PPM_INSTALL_EXEC
2071 Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl)
2073 =item PPM_INSTALL_SCRIPT
2075 Name of the script that gets executed by the Perl Package Manager after
2076 the installation of a package.
2080 This overrides all the default install locations. Man pages,
2081 libraries, scripts, etc... MakeMaker will try to make an educated
2082 guess about where to place things under the new PREFIX based on your
2083 Config defaults. Failing that, it will fall back to a structure
2084 which should be sensible for your platform.
2086 If you specify LIB or any INSTALL* variables they will not be effected
2091 Bool. If this parameter is true, failing to have the required modules
2092 (or the right versions thereof) will be fatal. C<perl Makefile.PL>
2093 will C<die> instead of simply informing the user of the missing dependencies.
2095 It is I<extremely> rare to have to use C<PREREQ_FATAL>. Its use by module
2096 authors is I<strongly discouraged> and should never be used lightly.
2097 Module installation tools have ways of resolving umet dependencies but
2098 to do that they need a F<Makefile>. Using C<PREREQ_FATAL> breaks this.
2101 The only situation where it is appropriate is when you have
2102 dependencies that are indispensible to actually I<write> a
2103 F<Makefile>. For example, MakeMaker's F<Makefile.PL> needs L<File::Spec>.
2104 If its not available it cannot write the F<Makefile>.
2106 Note: see L<Test::Harness> for a shortcut for stopping tests early
2107 if you are missing dependencies and are afraid that users might
2108 use your module with an incomplete environment.
2112 Hashref: Names of modules that need to be available to run this
2113 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
2114 desired version is the value. If the required version number is 0, we
2115 only check if any version is installed already.
2119 Bool. If this parameter is true, the prerequisites will be printed to
2120 stdout and MakeMaker will exit. The output format is an evalable hash
2131 RedHatism for C<PREREQ_PRINT>. The output format is different, though:
2133 perl(A::B)>=Vers1 perl(C::D)>=Vers2 ...
2137 Like PERLPREFIX, but only for the site install locations.
2139 Defaults to $Config{siteprefixexp}. Perls prior to 5.6.0 didn't have
2140 an explicit siteprefix in the Config. In those cases
2141 $Config{installprefix} will be used.
2143 Overridable by PREFIX
2147 When true, perform the generation and addition to the MANIFEST of the
2148 SIGNATURE file in the distdir during 'make distdir', via 'cpansign
2151 Note that you need to install the Module::Signature module to
2152 perform this operation.
2158 Arrayref. E.g. [qw(name1 name2)] skip (do not write) sections of the
2159 Makefile. Caution! Do not use the SKIP attribute for the negligible
2160 speedup. It may seriously damage the resulting Makefile. Only use it
2161 if you really need it.
2165 Ref to array of typemap file names. Use this when the typemaps are
2166 in some directory other than the current directory or when they are
2167 not named B<typemap>. The last typemap in the list takes
2168 precedence. A typemap in the current directory has highest
2169 precedence, even if it isn't listed in TYPEMAPS. The default system
2170 typemap has lowest precedence.
2174 Like PERLPREFIX, but only for the vendor install locations.
2176 Defaults to $Config{vendorprefixexp}.
2178 Overridable by PREFIX
2182 If true, make install will be verbose
2186 Your version number for distributing the package. This defaults to
2191 Instead of specifying the VERSION in the Makefile.PL you can let
2192 MakeMaker parse a file to determine the version number. The parsing
2193 routine requires that the file named by VERSION_FROM contains one
2194 single line to compute the version number. The first line in the file
2195 that contains the regular expression
2197 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
2199 will be evaluated with eval() and the value of the named variable
2200 B<after> the eval() will be assigned to the VERSION attribute of the
2201 MakeMaker object. The following lines will be parsed o.k.:
2205 ($VERSION) = q$Revision: 66493 $ =~ /(\d+)/g;
2206 $FOO::VERSION = '1.10';
2207 *FOO::VERSION = \'1.11';
2209 but these will fail:
2212 my $VERSION = '1.01';
2213 local $VERSION = '1.02';
2214 local $FOO::VERSION = '1.30';
2216 "Version strings" are incompatible should not be used.
2222 L<version> objects are fine. As of MakeMaker 6.35 version.pm will be
2223 automatically loaded, but you must declare the dependency on version.pm.
2224 For compatibility with older MakeMaker you should load on the same line
2225 as $VERSION is declared.
2228 use version; our $VERSION = qv(1.2.3);
2230 (Putting C<my> or C<local> on the preceding line will work o.k.)
2232 The file named in VERSION_FROM is not added as a dependency to
2233 Makefile. This is not really correct, but it would be a major pain
2234 during development to have to rewrite the Makefile for any smallish
2235 change in that file. If you want to make sure that the Makefile
2236 contains the correct VERSION macro after any change of the file, you
2237 would have to do something like
2239 depend => { Makefile => '$(VERSION_FROM)' }
2241 See attribute C<depend> below.
2245 A sanitized VERSION with . replaced by _. For places where . has
2246 special meaning (some filesystems, RCS labels, etc...)
2250 Hashref of .xs files. MakeMaker will default this. e.g.
2252 {'name_of_file.xs' => 'name_of_file.c'}
2254 The .c files will automatically be included in the list of files
2255 deleted by a make clean.
2259 String of options to pass to xsubpp. This might include C<-C++> or
2260 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
2265 May be set to an empty string, which is identical to C<-prototypes>, or
2266 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
2267 defaults to the empty string.
2271 Your version number for the .xs file of this package. This defaults
2272 to the value of the VERSION attribute.
2276 =head2 Additional lowercase attributes
2278 can be used to pass parameters to the methods which implement that
2279 part of the Makefile. Parameters are specified as a hash ref but are
2280 passed to the method as a hash.
2286 {FILES => "*.xyz foo"}
2290 {ANY_TARGET => ANY_DEPENDENCY, ...}
2292 (ANY_TARGET must not be given a double-colon rule by MakeMaker.)
2296 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
2297 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
2298 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
2300 If you specify COMPRESS, then SUFFIX should also be altered, as it is
2301 needed to tell make the target file of the compression. Setting
2302 DIST_CP to ln can be useful, if you need to preserve the timestamps on
2303 your files. DIST_CP can take the values 'cp', which copies the file,
2304 'ln', which links the file, and 'best' which copies symbolic links and
2305 links the rest. Default is 'best'.
2309 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
2313 {LINKTYPE => 'static', 'dynamic' or ''}
2315 NB: Extensions that have nothing but *.pm files had to say
2319 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
2320 can be deleted safely. MakeMaker recognizes when there's nothing to
2325 {ANY_MACRO => ANY_VALUE, ...}
2329 Anything put here will be passed to MY::postamble() if you have one.
2333 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
2339 =item tool_autosplit
2345 =head2 Overriding MakeMaker Methods
2347 If you cannot achieve the desired Makefile behaviour by specifying
2348 attributes you may define private subroutines in the Makefile.PL.
2349 Each subroutine returns the text it wishes to have written to
2350 the Makefile. To override a section of the Makefile you can
2353 sub MY::c_o { "new literal text" }
2355 or you can edit the default by saying something like:
2357 package MY; # so that "SUPER" works right
2359 my $inherited = shift->SUPER::c_o(@_);
2360 $inherited =~ s/old text/new text/;
2364 If you are running experiments with embedding perl as a library into
2365 other applications, you might find MakeMaker is not sufficient. You'd
2366 better have a look at ExtUtils::Embed which is a collection of utilities
2369 If you still need a different solution, try to develop another
2370 subroutine that fits your needs and submit the diffs to
2371 C<makemaker@perl.org>
2373 For a complete description of all MakeMaker methods see
2374 L<ExtUtils::MM_Unix>.
2376 Here is a simple example of how to add a new target to the generated
2380 return <<'MAKE_FRAG';
2381 $(MYEXTLIB): sdbm/Makefile
2382 cd sdbm && $(MAKE) all
2387 =head2 The End Of Cargo Cult Programming
2389 WriteMakefile() now does some basic sanity checks on its parameters to
2390 protect against typos and malformatted values. This means some things
2391 which happened to work in the past will now throw warnings and
2392 possibly produce internal errors.
2394 Some of the most common mistakes:
2398 =item C<< MAN3PODS => ' ' >>
2400 This is commonly used to suppress the creation of man pages. MAN3PODS
2401 takes a hash ref not a string, but the above worked by accident in old
2402 versions of MakeMaker.
2404 The correct code is C<< MAN3PODS => { } >>.
2409 =head2 Hintsfile support
2411 MakeMaker.pm uses the architecture specific information from
2412 Config.pm. In addition it evaluates architecture specific hints files
2413 in a C<hints/> directory. The hints files are expected to be named
2414 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
2415 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
2416 MakeMaker within the WriteMakefile() subroutine, and can be used to
2417 execute commands as well as to include special variables. The rules
2418 which hintsfile is chosen are the same as in Configure.
2420 The hintsfile is eval()ed immediately after the arguments given to
2421 WriteMakefile are stuffed into a hash reference $self but before this
2422 reference becomes blessed. So if you want to do the equivalent to
2423 override or create an attribute you would say something like
2425 $self->{LIBS} = ['-ldbm -lucb -lc'];
2427 =head2 Distribution Support
2429 For authors of extensions MakeMaker provides several Makefile
2430 targets. Most of the support comes from the ExtUtils::Manifest module,
2431 where additional documentation can be found.
2435 =item make distcheck
2437 reports which files are below the build directory but not in the
2438 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
2441 =item make skipcheck
2443 reports which files are skipped due to the entries in the
2444 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
2447 =item make distclean
2449 does a realclean first and then the distcheck. Note that this is not
2450 needed to build a new distribution as long as you are sure that the
2451 MANIFEST file is ok.
2455 rewrites the MANIFEST file, adding all remaining files found (See
2456 ExtUtils::Manifest::mkmanifest() for details)
2460 Copies all the files that are in the MANIFEST file to a newly created
2461 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
2462 exists, it will be removed first.
2464 Additionally, it will create a META.yml module meta-data file in the
2465 distdir and add this to the distdir's MANIFEST. You can shut this
2466 behavior off with the NO_META flag.
2470 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
2471 a make test in that directory.
2475 First does a distdir. Then a command $(PREOP) which defaults to a null
2476 command, followed by $(TO_UNIX), which defaults to a null command under
2477 UNIX, and will convert files in distribution directory to UNIX format
2478 otherwise. Next it runs C<tar> on that directory into a tarfile and
2479 deletes the directory. Finishes with a command $(POSTOP) which
2480 defaults to a null command.
2484 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
2486 =item make uutardist
2488 Runs a tardist first and uuencodes the tarfile.
2492 First does a distdir. Then a command $(PREOP) which defaults to a null
2493 command. Next it runs C<shar> on that directory into a sharfile and
2494 deletes the intermediate directory again. Finishes with a command
2495 $(POSTOP) which defaults to a null command. Note: For shdist to work
2496 properly a C<shar> program that can handle directories is mandatory.
2500 First does a distdir. Then a command $(PREOP) which defaults to a null
2501 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
2502 zipfile. Then deletes that directory. Finishes with a command
2503 $(POSTOP) which defaults to a null command.
2507 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
2511 Customization of the dist targets can be done by specifying a hash
2512 reference to the dist attribute of the WriteMakefile call. The
2513 following parameters are recognized:
2516 COMPRESS ('gzip --best')
2519 TO_UNIX (depends on the system)
2520 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
2530 WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" })
2533 =head2 Module Meta-Data
2535 Long plaguing users of MakeMaker based modules has been the problem of
2536 getting basic information about the module out of the sources
2537 I<without> running the F<Makefile.PL> and doing a bunch of messy
2538 heuristics on the resulting F<Makefile>. To this end a simple module
2539 meta-data file has been introduced, F<META.yml>.
2541 F<META.yml> is a YAML document (see http://www.yaml.org) containing
2542 basic information about the module (name, version, prerequisites...)
2543 in an easy to read format. The format is developed and defined by the
2544 Module::Build developers (see
2545 http://module-build.sourceforge.net/META-spec.html)
2547 MakeMaker will automatically generate a F<META.yml> file for you and
2548 add it to your F<MANIFEST> as part of the 'distdir' target (and thus
2549 the 'dist' target). This is intended to seamlessly and rapidly
2550 populate CPAN with module meta-data. If you wish to shut this feature
2551 off, set the C<NO_META> C<WriteMakefile()> flag to true.
2554 =head2 Disabling an extension
2556 If some events detected in F<Makefile.PL> imply that there is no way
2557 to create the Module, but this is a normal state of things, then you
2558 can create a F<Makefile> which does nothing, but succeeds on all the
2559 "usual" build targets. To do so, use
2561 use ExtUtils::MakeMaker qw(WriteEmptyMakefile);
2562 WriteEmptyMakefile();
2564 instead of WriteMakefile().
2566 This may be useful if other modules expect this module to be I<built>
2567 OK, as opposed to I<work> OK (say, this system-dependent module builds
2568 in a subdirectory of some other distribution, or is listed as a
2569 dependency in a CPAN::Bundle, but the functionality is supported by
2570 different means on the current architecture).
2572 =head2 Other Handy Functions
2578 my $value = prompt($message);
2579 my $value = prompt($message, $default);
2581 The C<prompt()> function provides an easy way to request user input
2582 used to write a makefile. It displays the $message as a prompt for
2583 input. If a $default is provided it will be used as a default. The
2584 function returns the $value selected by the user.
2586 If C<prompt()> detects that it is not running interactively and there
2587 is nothing on STDIN or if the PERL_MM_USE_DEFAULT environment variable
2588 is set to true, the $default will be used without prompting. This
2589 prevents automated processes from blocking on user input.
2591 If no $default is provided an empty string will be used instead.
2602 Command line options used by C<MakeMaker-E<gt>new()>, and thus by
2603 C<WriteMakefile()>. The string is split on whitespace, and the result
2604 is processed before any actual command line arguments are processed.
2606 =item PERL_MM_USE_DEFAULT
2608 If set to a true value then MakeMaker's prompt function will
2609 always return the default without waiting for user input.
2613 Same as the PERL_CORE parameter. The parameter overrides this.
2619 L<Module::Build> is a pure-Perl alternative to MakeMaker which does
2620 not rely on make or any other external utility. It is easier to
2621 extend to suit your needs.
2623 L<Module::Install> is a wrapper around MakeMaker which adds features
2624 not normally available.
2626 L<ExtUtils::ModuleMaker> and L<Module::Starter> are both modules to
2627 help you setup your distribution.
2631 Andy Dougherty C<doughera@lafayette.edu>, Andreas KE<ouml>nig
2632 C<andreas.koenig@mind.de>, Tim Bunce C<timb@cpan.org>. VMS
2633 support by Charles Bailey C<bailey@newman.upenn.edu>. OS/2 support
2634 by Ilya Zakharevich C<ilya@math.ohio-state.edu>.
2636 Currently maintained by Michael G Schwern C<schwern@pobox.com>
2638 Send patches and ideas to C<makemaker@perl.org>.
2640 Send bug reports via http://rt.cpan.org/. Please send your
2641 generated Makefile along with your report.
2643 For more up-to-date information, see L<http://www.makemaker.org>.
2647 This program is free software; you can redistribute it and/or
2648 modify it under the same terms as Perl itself.
2650 See L<http://www.perl.com/perl/misc/Artistic.html>