1 BEGIN {require 5.002;} # MakeMaker 5.17 was the last MakeMaker that was compatible with perl5.001m
3 package ExtUtils::MakeMaker;
6 $Version_OK = "5.17"; # Makefiles older than $Version_OK will die
7 # (Will be checked from MakeMaker version 4.13 onwards)
8 ($Revision = substr(q$Revision: 1.222 $, 10)) =~ s/\s+$//;
19 @ISA @EXPORT @EXPORT_OK $AUTOLOAD
20 $ISA_TTY $Is_Mac $Is_OS2 $Is_VMS $Revision
21 $VERSION $Verbose $Version_OK %Config %Keep_after_flush
22 %MM_Sections %Prepend_dot_dot %Recognized_Att_Keys
23 @Get_from_Config @MM_Sections @Overridable @Parent
28 # &DynaLoader::mod2fname should be available to miniperl, thus
29 # should be a pseudo-builtin (cmp. os2.c).
30 #eval {require DynaLoader;};
33 # Set up the inheritance before we pull in the MM_* packages, because they
34 # import variables and functions from here
37 @EXPORT = qw(&WriteMakefile &writeMakefile $Verbose &prompt);
38 @EXPORT_OK = qw($VERSION &Version_check &neatvalue &mkbootstrap &mksymlists);
41 # Dummy package MM inherits actual methods from OS-specific
42 # default packages. We use this intermediate package so
43 # MY::XYZ->func() can call MM->func() and get the proper
44 # default routine without having to know under what OS
47 @MM::ISA = qw[ExtUtils::MM_Unix ExtUtils::Liblist::Kid ExtUtils::MakeMaker];
50 # Setup dummy package:
51 # MY exists for overriding methods to be defined within
56 ### sub AUTOLOAD { use Devel::Symdump; print Devel::Symdump->rnew->as_string; Carp::confess "hey why? $AUTOLOAD" }
61 # "predeclare the package: we only load it via AUTOLOAD
62 # but we have already mentioned it in @ISA
63 package ExtUtils::Liblist::Kid;
65 package ExtUtils::MakeMaker;
67 # Now we can pull in the friends
69 $Is_VMS = $^O eq 'VMS';
70 $Is_OS2 = $^O eq 'os2';
71 $Is_Mac = $^O eq 'MacOS';
72 $Is_Win32 = $^O eq 'MSWin32';
73 $Is_Cygwin= $^O eq 'cygwin';
74 $Is_NetWare = $Config{'osname'} eq 'NetWare';
76 require ExtUtils::MM_Unix;
79 require ExtUtils::MM_VMS;
80 require VMS::Filespec; # is a noop as long as we require it within MM_VMS
83 require ExtUtils::MM_OS2;
86 require ExtUtils::MM_MacOS;
90 require ExtUtils::MM_NW5;
94 require ExtUtils::MM_Win32;
97 require ExtUtils::MM_Cygwin;
102 # The use of the Version_check target has been dropped between perl
103 # 5.5.63 and 5.5.64. We must keep the subroutine for a while so that
104 # old Makefiles can satisfy the Version_check target.
107 my($checkversion) = @_;
108 die "Your Makefile was built with ExtUtils::MakeMaker v $checkversion.
109 Current Version is $ExtUtils::MakeMaker::VERSION. There have been considerable
110 changes in the meantime.
111 Please rerun 'perl Makefile.PL' to regenerate the Makefile.\n"
112 if $checkversion < $Version_OK;
113 printf STDOUT "%s %s %s %s.\n", "Makefile built with ExtUtils::MakeMaker v",
114 $checkversion, "Current Version is", $VERSION
115 unless $checkversion == $VERSION;
119 $_[0] =~ /^Use of uninitialized value/ && return;
120 $_[0] =~ /used only once/ && return;
121 $_[0] =~ /^Subroutine\s+[\w:]+\s+redefined/ && return;
126 Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
127 local $SIG{__WARN__} = \&warnhandler;
130 MM->new(\%att)->flush;
135 $ISA_TTY = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ; # Pipe?
136 Carp::confess("prompt function called without an argument") unless defined $mess;
137 my $dispdef = defined $def ? "[$def] " : " ";
138 $def = defined $def ? $def : "";
141 print "$mess $dispdef";
143 chomp($ans = <STDIN>);
147 return ($ans ne '') ? $ans : $def;
150 sub eval_in_subdirs {
156 foreach $dir (@{$self->{DIR}}){
157 my($abs) = $self->catdir($pwd,$dir);
158 $self->eval_in_x($abs);
166 chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
168 # my $fh = new FileHandle;
169 # $fh->open("Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
171 open(FH,"Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
172 # my $eval = join "", <$fh>;
173 my $eval = join "", <FH>;
178 # if ($@ =~ /prerequisites/) {
179 # die "MakeMaker WARNING: $@";
181 # warn "WARNING from evaluation of $dir/Makefile.PL: $@";
183 warn "WARNING from evaluation of $dir/Makefile.PL: $@";
190 # package name for the classes into which the first object will be blessed
191 $PACKNAME = "PACK000";
195 AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION
196 C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
197 EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE FULLPERL FUNCLIST H
198 HTMLLIBPODS HTMLSCRIPTPODS IMPORTS
199 INC INCLUDE_EXT INSTALLARCHLIB INSTALLBIN INSTALLDIRS INSTALLHTMLPRIVLIBDIR
200 INSTALLHTMLSCRIPTDIR INSTALLHTMLSITELIBDIR INSTALLMAN1DIR
201 INSTALLMAN3DIR INSTALLPRIVLIB INSTALLSCRIPT INSTALLSITEARCH
202 INSTALLSITELIB INST_ARCHLIB INST_BIN INST_EXE INST_LIB
203 INST_HTMLLIBDIR INST_HTMLSCRIPTDIR
204 INST_MAN1DIR INST_MAN3DIR INST_SCRIPT LDFROM LIB LIBPERL_A LIBS
205 LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB
207 NAME NEEDS_LINKING NOECHO NORECURS NO_VC OBJECT OPTIMIZE PERL PERLMAINCC
208 PERLRUN PERLRUNINST PERL_ARCHLIB PERL_CORE
209 PERL_LIB PERL_SRC PERM_RW PERM_RWX
210 PL_FILES PM PM_FILTER PMLIBDIRS POLLUTE PPM_INSTALL_EXEC
211 PPM_INSTALL_SCRIPT PREFIX
212 PREREQ_PM SKIP TEST_LIBS TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
213 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
215 MACPERL_SRC MACPERL_LIB MACLIBS_68K MACLIBS_PPC MACLIBS_SC MACLIBS_MRC
216 MACLIBS_ALL_68K MACLIBS_ALL_PPC MACLIBS_SHARED
219 # IMPORTS is used under OS/2 and Win32
221 # @Overridable is close to @MM_Sections but not identical. The
222 # order is important. Many subroutines declare macros. These
223 # depend on each other. Let's try to collect the macros up front,
224 # then pasthru, then the rules.
226 # MM_Sections are the sections we have to call explicitly
227 # in Overridable we have subroutines that are used indirectly
233 post_initialize const_config constants tool_autosplit tool_xsubpp
234 tools_other dist macro depend cflags const_loadlibs const_cccmd
239 c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs
240 dynamic_lib static static_lib htmlifypods manifypods processPL
242 clean realclean dist_basics dist_core dist_dir dist_test dist_ci
243 install force perldepend makefile staticmake test ppd
245 ); # loses section ordering
247 @Overridable = @MM_Sections;
248 push @Overridable, qw[
250 dir_target libscan makeaperl needs_linking perm_rw perm_rwx
251 subdir_x test_via_harness test_via_script
254 push @MM_Sections, qw[
256 pm_to_blib selfdocument
260 # Postamble needs to be the last that was always the case
261 push @MM_Sections, "postamble";
262 push @Overridable, "postamble";
264 # All sections are valid keys.
265 @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
267 # we will use all these variables in the Makefile
270 ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc
271 lib_ext obj_ext osname osvers ranlib sitelibexp sitearchexp so
276 foreach $item (@Attrib_help){
277 $Recognized_Att_Keys{$item} = 1;
279 foreach $item (@Get_from_Config) {
280 $Recognized_Att_Keys{uc $item} = $Config{$item};
281 print "Attribute '\U$item\E' => '$Config{$item}'\n"
286 # When we eval a Makefile.PL in a subdirectory, that one will ask
287 # us (the parent) for the values and will prepend "..", so that
288 # all files to be installed end up below OUR ./blib
293 INST_BIN 1 INST_EXE 1 INST_LIB 1 INST_ARCHLIB 1 INST_SCRIPT 1
294 MAP_TARGET 1 INST_HTMLLIBDIR 1 INST_HTMLSCRIPTDIR 1
295 INST_MAN1DIR 1 INST_MAN3DIR 1 PERL_SRC 1 PERL 1 FULLPERL 1
300 NEEDS_LINKING HAS_LINK_CODE
302 @Keep_after_flush{@keep} = (1) x @keep;
308 The extension you are trying to build apparently is rather old and
309 most probably outdated. We detect that from the fact, that a
310 subroutine "writeMakefile" is called, and this subroutine is not
311 supported anymore since about October 1994.
313 Please contact the author or look into CPAN (details about CPAN can be
314 found in the FAQ and at http:/www.perl.com) for a more recent version
315 of the extension. If you're really desperate, you can try to change
316 the subroutine name from writeMakefile to WriteMakefile and rerun
317 'perl Makefile.PL', but you're most probably left alone, when you do
325 sub ExtUtils::MakeMaker::new {
326 my($class,$self) = @_;
329 print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
330 if (-f "MANIFEST" && ! -f "Makefile"){
334 $self = {} unless (defined $self);
338 my %configure_att; # record &{$self->{CONFIGURE}} attributes
339 my(%initial_att) = %$self; # record initial attributes
342 foreach $prereq (sort keys %{$self->{PREREQ_PM}}) {
343 my $eval = "require $prereq";
347 warn "Warning: prerequisite $prereq failed to load: $@";
349 elsif ($prereq->VERSION < $self->{PREREQ_PM}->{$prereq} ){
350 warn "Warning: prerequisite $prereq $self->{PREREQ_PM}->{$prereq} not found";
351 # Why is/was this 'delete' here? We need PREREQ_PM later to make PPDs.
353 # delete $self->{PREREQ_PM}{$prereq};
357 # unless (defined $ExtUtils::MakeMaker::useCPAN) {
358 # print qq{MakeMaker WARNING: prerequisites not found (@unsatisfied)
359 # Please install these modules first and rerun 'perl Makefile.PL'.\n};
360 # if ($ExtUtils::MakeMaker::hasCPAN) {
361 # $ExtUtils::MakeMaker::useCPAN = prompt(qq{Should I try to use the CPAN module to fetch them for you?},"yes");
363 # print qq{Hint: You may want to install the CPAN module to autofetch the needed modules\n};
364 # $ExtUtils::MakeMaker::useCPAN=0;
367 # if ($ExtUtils::MakeMaker::useCPAN) {
369 # CPAN->import(@unsatisfied);
371 # die qq{prerequisites not found (@unsatisfied)};
373 # warn qq{WARNING: prerequisites not found (@unsatisfied)};
376 if (defined $self->{CONFIGURE}) {
377 if (ref $self->{CONFIGURE} eq 'CODE') {
378 %configure_att = %{&{$self->{CONFIGURE}}};
379 $self = { %$self, %configure_att };
381 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
385 # This is for old Makefiles written pre 5.00, will go away
386 if ( Carp::longmess("") =~ /runsubdirpl/s ){
387 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
390 my $newclass = ++$PACKNAME;
391 local @Parent = @Parent; # Protect against non-local exits
394 print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
395 mv_all_methods("MY",$newclass);
396 bless $self, $newclass;
398 @{"$newclass\:\:ISA"} = 'MM';
401 if (defined $Parent[-2]){
402 $self->{PARENT} = $Parent[-2];
404 for $key (keys %Prepend_dot_dot) {
405 next unless defined $self->{PARENT}{$key};
406 $self->{$key} = $self->{PARENT}{$key};
407 # PERL and FULLPERL may be command verbs instead of full
408 # file specifications under VMS. If so, don't turn them
410 $self->{$key} = $self->catdir("..",$self->{$key})
411 unless $self->file_name_is_absolute($self->{$key})
412 || ($^O eq 'VMS' and ($key =~ /PERL$/ && $self->{$key} =~ /^[\w\-\$]+$/));
414 if ($self->{PARENT}) {
415 $self->{PARENT}->{CHILDREN}->{$newclass} = $self;
416 foreach my $opt (qw(CAPI POLLUTE PERL_CORE)) {
417 if (exists $self->{PARENT}->{$opt}
418 and not exists $self->{$opt})
420 # inherit, but only if already unspecified
421 $self->{$opt} = $self->{PARENT}->{$opt};
426 parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV);
429 $self->{NAME} ||= $self->guess_name;
431 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
435 if (! $self->{PERL_SRC} ) {
436 my($pthinks) = $self->canonpath($INC{'Config.pm'});
437 my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
438 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
439 if ($pthinks ne $cthinks &&
440 !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
441 print "Have $pthinks expected $cthinks\n";
443 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
446 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
448 print STDOUT <<END unless $self->{UNINSTALLED_PERL};
449 Your perl and your Config.pm seem to have different ideas about the architecture
451 Perl thinks: [$pthinks]
452 Config says: [$Config{archname}]
453 This may or may not cause problems. Please check your installation of perl if you
454 have problems building this extension.
459 $self->init_dirscan();
460 $self->init_others();
461 my($argv) = neatvalue(\@ARGV);
465 push @{$self->{RESULT}}, <<END;
466 # This Makefile is for the $self->{NAME} extension to perl.
468 # It was generated automatically by MakeMaker version
469 # $VERSION (Revision: $Revision) from the contents of
470 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
472 # ANY CHANGES MADE HERE WILL BE LOST!
474 # MakeMaker ARGV: $argv
476 # MakeMaker Parameters:
479 foreach $key (sort keys %initial_att){
480 my($v) = neatvalue($initial_att{$key});
481 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
483 push @{$self->{RESULT}}, "# $key => $v";
485 undef %initial_att; # free memory
487 if (defined $self->{CONFIGURE}) {
488 push @{$self->{RESULT}}, <<END;
490 # MakeMaker 'CONFIGURE' Parameters:
492 if (scalar(keys %configure_att) > 0) {
493 foreach $key (sort keys %configure_att){
494 my($v) = neatvalue($configure_att{$key});
495 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
497 push @{$self->{RESULT}}, "# $key => $v";
502 push @{$self->{RESULT}}, "# no values returned";
504 undef %configure_att; # free memory
507 # turn the SKIP array into a SKIPHASH hash
509 for $skip (@{$self->{SKIP} || []}) {
510 $self->{SKIPHASH}{$skip} = 1;
512 delete $self->{SKIP}; # free memory
514 if ($self->{PARENT}) {
515 for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
516 $self->{SKIPHASH}{$_} = 1;
520 # We run all the subdirectories now. They don't have much to query
521 # from the parent, but the parent has to query them: if they need linking!
522 unless ($self->{NORECURS}) {
523 $self->eval_in_subdirs if @{$self->{DIR}};
527 foreach $section ( @MM_Sections ){
528 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
529 my($skipit) = $self->skipcheck($section);
531 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
533 my(%a) = %{$self->{$section} || {}};
534 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
535 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
536 push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
540 push @{$self->{RESULT}}, "\n# End.";
545 sub WriteEmptyMakefile {
546 if (-f 'Makefile.old') {
547 chmod 0666, 'Makefile.old';
548 unlink 'Makefile.old' or warn "unlink Makefile.old: $!";
550 rename 'Makefile', 'Makefile.old' or warn "rename Makefile Makefile.old: $!"
552 open MF, '> Makefile' or die "open Makefile for write: $!";
565 close MF or die "close Makefile for write: $!";
569 print STDOUT "Checking if your kit is complete...\n";
570 require ExtUtils::Manifest;
571 $ExtUtils::Manifest::Quiet=$ExtUtils::Manifest::Quiet=1; #avoid warning
572 my(@missed)=ExtUtils::Manifest::manicheck();
574 print STDOUT "Warning: the following files are missing in your kit:\n";
575 print "\t", join "\n\t", @missed;
577 print STDOUT "Please inform the author.\n";
579 print STDOUT "Looks good\n";
584 my($self, @args) = @_;
586 unless (m/(.*?)=(.*)/){
587 help(),exit 1 if m/^help$/;
588 ++$Verbose if m/^verb/;
591 my($name, $value) = ($1, $2);
592 if ($value =~ m/^~(\w+)?/){ # tilde with optional username
593 $value =~ s [^~(\w*)]
595 ((getpwnam($1))[7] || "~$1") :
599 $self->{uc($name)} = $value;
602 # catch old-style 'potential_libs' and inform user how to 'upgrade'
603 if (defined $self->{potential_libs}){
604 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
605 if ($self->{potential_libs}){
606 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
608 print STDOUT "$msg deleted.\n";
610 $self->{LIBS} = [$self->{potential_libs}];
611 delete $self->{potential_libs};
613 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
614 if (defined $self->{ARMAYBE}){
615 my($armaybe) = $self->{ARMAYBE};
616 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
617 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
618 my(%dl) = %{$self->{dynamic_lib} || {}};
619 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
620 delete $self->{ARMAYBE};
622 if (defined $self->{LDTARGET}){
623 print STDOUT "LDTARGET should be changed to LDFROM\n";
624 $self->{LDFROM} = $self->{LDTARGET};
625 delete $self->{LDTARGET};
627 # Turn a DIR argument on the command line into an array
628 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
629 # So they can choose from the command line, which extensions they want
630 # the grep enables them to have some colons too much in case they
631 # have to build a list with the shell
632 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
634 # Turn a INCLUDE_EXT argument on the command line into an array
635 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
636 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
638 # Turn a EXCLUDE_EXT argument on the command line into an array
639 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
640 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
643 foreach $mmkey (sort keys %$self){
644 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
645 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
646 unless exists $Recognized_Att_Keys{$mmkey};
653 # We allow extension-specific hints files.
655 return unless -d "hints";
657 # First we look for the best hintsfile we have
659 my($hint)="${^O}_$Config{osvers}";
664 # Also try without trailing minor version numbers.
666 last if -f "hints/$hint.pl"; # found
668 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
670 return unless -f "hints/$hint.pl"; # really there
672 # execute the hintsfile:
674 # my $fh = new FileHandle;
675 # $fh->open("hints/$hint.pl");
677 open(FH,"hints/$hint.pl");
678 # @goodhints = <$fh>;
682 print STDOUT "Processing hints file hints/$hint.pl\n";
683 eval join('',@goodhints);
684 print STDOUT $@ if $@;
690 my($symtab) = \%{"${from}::"};
693 # Here you see the *current* list of methods that are overridable
694 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
695 # still trying to reduce the list to some reasonable minimum --
696 # because I want to make it easier for the user. A.K.
698 foreach $method (@Overridable) {
700 # We cannot say "next" here. Nick might call MY->makeaperl
701 # which isn't defined right now
703 # Above statement was written at 4.23 time when Tk-b8 was
704 # around. As Tk-b9 only builds with 5.002something and MM 5 is
705 # standard, we try to enable the next line again. It was
706 # commented out until MM 5.23
708 next unless defined &{"${from}::$method"};
710 *{"${to}::$method"} = \&{"${from}::$method"};
712 # delete would do, if we were sure, nobody ever called
713 # MY->makeaperl directly
715 # delete $symtab->{$method};
717 # If we delete a method, then it will be undefined and cannot
718 # be called. But as long as we have Makefile.PLs that rely on
719 # %MY:: being intact, we have to fill the hole with an
722 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
725 # We have to clean out %INC also, because the current directory is
726 # changed frequently and Graham Barr prefers to get his version
727 # out of a History.pl file which is "required" so woudn't get
728 # loaded again in another extension requiring a History.pl
730 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
731 # to core dump in the middle of a require statement. The required
732 # file was Tk/MMutil.pm. The consequence is, we have to be
733 # extremely careful when we try to give perl a reason to reload a
734 # library with same name. The workaround prefers to drop nothing
735 # from %INC and teach the writers not to use such libraries.
738 # foreach $inc (keys %INC) {
739 # #warn "***$inc*** deleted";
747 if ($section eq 'dynamic') {
748 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
749 "in skipped section 'dynamic_bs'\n"
750 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
751 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
752 "in skipped section 'dynamic_lib'\n"
753 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
755 if ($section eq 'dynamic_lib') {
756 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
757 "targets in skipped section 'dynamic_bs'\n"
758 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
760 if ($section eq 'static') {
761 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
762 "in skipped section 'static_lib'\n"
763 if $self->{SKIPHASH}{static_lib} && $Verbose;
765 return 'skipped' if $self->{SKIPHASH}{$section};
773 # my $fh = new FileHandle;
775 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
777 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
778 # $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
779 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
781 for $chunk (@{$self->{RESULT}}) {
782 # print $fh "$chunk\n";
788 my($finalname) = $self->{MAKEFILE};
789 rename("MakeMaker.tmp", $finalname);
790 chmod 0644, $finalname unless $Is_VMS;
792 if ($self->{PARENT}) {
793 foreach (keys %$self) { # safe memory
794 delete $self->{$_} unless $Keep_after_flush{$_};
798 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
801 # The following mkbootstrap() is only for installations that are calling
802 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
803 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
806 !!! Your Makefile has been built such a long time ago, !!!
807 !!! that is unlikely to work with current MakeMaker. !!!
808 !!! Please rebuild your Makefile !!!
812 # Ditto for mksymlists() as of MakeMaker 5.17
815 !!! Your Makefile has been built such a long time ago, !!!
816 !!! that is unlikely to work with current MakeMaker. !!!
817 !!! Please rebuild your Makefile !!!
823 return "undef" unless defined $v;
825 return "q[$v]" unless $t;
827 my(@m, $elem, @neat);
829 foreach $elem (@$v) {
830 push @neat, "q[$elem]";
832 push @m, join ", ", @neat;
836 return "$v" unless $t eq 'HASH';
838 while (($key,$val) = each %$v){
839 last unless defined $key; # cautious programming in case (undef,undef) is true
840 push(@m,"$key=>".neatvalue($val)) ;
842 return "{ ".join(', ',@m)." }";
849 push @m, "\n# Full list of MakeMaker attribute values:";
850 foreach $key (sort keys %$self){
851 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
852 my($v) = neatvalue($self->{$key});
853 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
855 push @m, "# $key => $v";
861 package ExtUtils::MakeMaker;
868 ExtUtils::MakeMaker - create an extension Makefile
872 C<use ExtUtils::MakeMaker;>
874 C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
878 C<MM-E<gt>new(\%att)-E<gt>flush;>
882 This utility is designed to write a Makefile for an extension module
883 from a Makefile.PL. It is based on the Makefile.SH model provided by
884 Andy Dougherty and the perl5-porters.
886 It splits the task of generating the Makefile into several subroutines
887 that can be individually overridden. Each subroutine returns the text
888 it wishes to have written to the Makefile.
890 MakeMaker is object oriented. Each directory below the current
891 directory that contains a Makefile.PL. Is treated as a separate
892 object. This makes it possible to write an unlimited number of
893 Makefiles with a single invocation of WriteMakefile().
895 =head2 How To Write A Makefile.PL
897 The short answer is: Don't.
899 Always begin with h2xs.
900 Always begin with h2xs!
901 ALWAYS BEGIN WITH H2XS!
903 even if you're not building around a header file, and even if you
904 don't have an XS component.
906 Run h2xs(1) before you start thinking about writing a module. For so
907 called pm-only modules that consist of C<*.pm> files only, h2xs has
908 the C<-X> switch. This will generate dummy files of all kinds that are
909 useful for the module developer.
911 The medium answer is:
913 use ExtUtils::MakeMaker;
914 WriteMakefile( NAME => "Foo::Bar" );
916 The long answer is the rest of the manpage :-)
918 =head2 Default Makefile Behaviour
920 The generated Makefile enables the user of the extension to invoke
922 perl Makefile.PL # optionally "perl Makefile.PL verbose"
924 make test # optionally set TEST_VERBOSE=1
925 make install # See below
927 The Makefile to be produced may be altered by adding arguments of the
928 form C<KEY=VALUE>. E.g.
930 perl Makefile.PL PREFIX=/tmp/myperl5
932 Other interesting targets in the generated Makefile are
934 make config # to check if the Makefile is up-to-date
935 make clean # delete local temp files (Makefile gets renamed)
936 make realclean # delete derived files (including ./blib)
937 make ci # check in all the files in the MANIFEST file
938 make dist # see below the Distribution Support section
942 MakeMaker checks for the existence of a file named F<test.pl> in the
943 current directory and if it exists it adds commands to the test target
944 of the generated Makefile that will execute the script with the proper
945 set of perl C<-I> options.
947 MakeMaker also checks for any files matching glob("t/*.t"). It will
948 add commands to the test target of the generated Makefile that execute
949 all matching files via the L<Test::Harness> module with the C<-I>
950 switches set correctly.
954 A useful variation of the above is the target C<testdb>. It runs the
955 test under the Perl debugger (see L<perldebug>). If the file
956 F<test.pl> exists in the current directory, it is used for the test.
958 If you want to debug some other testfile, set C<TEST_FILE> variable
961 make testdb TEST_FILE=t/mytest.t
963 By default the debugger is called using C<-d> option to perl. If you
964 want to specify some other option, set C<TESTDB_SW> variable:
966 make testdb TESTDB_SW=-Dx
970 make alone puts all relevant files into directories that are named by
971 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_HTMLLIBDIR,
972 INST_HTMLSCRIPTDIR, INST_MAN1DIR, and INST_MAN3DIR. All these default
973 to something below ./blib if you are I<not> building below the perl
974 source directory. If you I<are> building below the perl source,
975 INST_LIB and INST_ARCHLIB default to ../../lib, and INST_SCRIPT is not
978 The I<install> target of the generated Makefile copies the files found
979 below each of the INST_* directories to their INSTALL*
980 counterparts. Which counterparts are chosen depends on the setting of
981 INSTALLDIRS according to the following table:
986 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH
987 INST_LIB INSTALLPRIVLIB INSTALLSITELIB
988 INST_HTMLLIBDIR INSTALLHTMLPRIVLIBDIR INSTALLHTMLSITELIBDIR
989 INST_HTMLSCRIPTDIR INSTALLHTMLSCRIPTDIR
991 INST_SCRIPT INSTALLSCRIPT
992 INST_MAN1DIR INSTALLMAN1DIR
993 INST_MAN3DIR INSTALLMAN3DIR
995 The INSTALL... macros in turn default to their %Config
996 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
998 You can check the values of these variables on your system with
1002 And to check the sequence in which the library directories are
1003 searched by perl, run
1005 perl -le 'print join $/, @INC'
1008 =head2 PREFIX and LIB attribute
1010 PREFIX and LIB can be used to set several INSTALL* attributes in one
1011 go. The quickest way to install a module in a non-standard place might
1014 perl Makefile.PL LIB=~/lib
1016 This will install the module's architecture-independent files into
1017 ~/lib, the architecture-dependent files into ~/lib/$archname.
1019 Another way to specify many INSTALL directories with a single
1020 parameter is PREFIX.
1022 perl Makefile.PL PREFIX=~
1024 This will replace the string specified by C<$Config{prefix}> in all
1025 C<$Config{install*}> values.
1027 Note, that in both cases the tilde expansion is done by MakeMaker, not
1028 by perl by default, nor by make.
1030 Conflicts between parameters LIB,
1031 PREFIX and the various INSTALL* arguments are resolved so that:
1037 setting LIB overrides any setting of INSTALLPRIVLIB, INSTALLARCHLIB,
1038 INSTALLSITELIB, INSTALLSITEARCH (and they are not affected by PREFIX);
1042 without LIB, setting PREFIX replaces the initial C<$Config{prefix}>
1043 part of those INSTALL* arguments, even if the latter are explicitly
1044 set (but are set to still start with C<$Config{prefix}>).
1048 If the user has superuser privileges, and is not working on AFS
1049 or relatives, then the defaults for
1050 INSTALLPRIVLIB, INSTALLARCHLIB, INSTALLSCRIPT, etc. will be appropriate,
1051 and this incantation will be the best:
1053 perl Makefile.PL; make; make test
1056 make install per default writes some documentation of what has been
1057 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1058 can be bypassed by calling make pure_install.
1062 will have to specify the installation directories as these most
1063 probably have changed since perl itself has been installed. They will
1064 have to do this by calling
1066 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1067 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1070 Be careful to repeat this procedure every time you recompile an
1071 extension, unless you are sure the AFS installation directories are
1074 =head2 Static Linking of a new Perl Binary
1076 An extension that is built with the above steps is ready to use on
1077 systems supporting dynamic loading. On systems that do not support
1078 dynamic loading, any newly created extension has to be linked together
1079 with the available resources. MakeMaker supports the linking process
1080 by creating appropriate targets in the Makefile whenever an extension
1081 is built. You can invoke the corresponding section of the makefile with
1085 That produces a new perl binary in the current directory with all
1086 extensions linked in that can be found in INST_ARCHLIB, SITELIBEXP,
1087 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1088 UNIX, this is called Makefile.aperl (may be system dependent). If you
1089 want to force the creation of a new perl, it is recommended, that you
1090 delete this Makefile.aperl, so the directories are searched-through
1091 for linkable libraries again.
1093 The binary can be installed into the directory where perl normally
1094 resides on your machine with
1098 To produce a perl binary with a different name than C<perl>, either say
1100 perl Makefile.PL MAP_TARGET=myperl
1107 make myperl MAP_TARGET=myperl
1108 make inst_perl MAP_TARGET=myperl
1110 In any case you will be prompted with the correct invocation of the
1111 C<inst_perl> target that installs the new binary into INSTALLBIN.
1113 make inst_perl per default writes some documentation of what has been
1114 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1115 can be bypassed by calling make pure_inst_perl.
1117 Warning: the inst_perl: target will most probably overwrite your
1118 existing perl binary. Use with care!
1120 Sometimes you might want to build a statically linked perl although
1121 your system supports dynamic loading. In this case you may explicitly
1122 set the linktype with the invocation of the Makefile.PL or make:
1124 perl Makefile.PL LINKTYPE=static # recommended
1128 make LINKTYPE=static # works on most systems
1130 =head2 Determination of Perl Library and Installation Locations
1132 MakeMaker needs to know, or to guess, where certain things are
1133 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1134 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1135 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1137 Extensions may be built either using the contents of the perl source
1138 directory tree or from the installed perl library. The recommended way
1139 is to build extensions after you have run 'make install' on perl
1140 itself. You can do that in any directory on your hard disk that is not
1141 below the perl source tree. The support for extensions below the ext
1142 directory of the perl distribution is only good for the standard
1143 extensions that come with perl.
1145 If an extension is being built below the C<ext/> directory of the perl
1146 source then MakeMaker will set PERL_SRC automatically (e.g.,
1147 C<../..>). If PERL_SRC is defined and the extension is recognized as
1148 a standard extension, then other variables default to the following:
1151 PERL_LIB = PERL_SRC/lib
1152 PERL_ARCHLIB = PERL_SRC/lib
1154 INST_ARCHLIB = PERL_ARCHLIB
1156 If an extension is being built away from the perl source then MakeMaker
1157 will leave PERL_SRC undefined and default to using the installed copy
1158 of the perl library. The other variables default to the following:
1160 PERL_INC = $archlibexp/CORE
1161 PERL_LIB = $privlibexp
1162 PERL_ARCHLIB = $archlibexp
1163 INST_LIB = ./blib/lib
1164 INST_ARCHLIB = ./blib/arch
1166 If perl has not yet been installed then PERL_SRC can be defined on the
1167 command line as shown in the previous section.
1170 =head2 Which architecture dependent directory?
1172 If you don't want to keep the defaults for the INSTALL* macros,
1173 MakeMaker helps you to minimize the typing needed: the usual
1174 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1175 by Configure at perl compilation time. MakeMaker supports the user who
1176 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1177 then MakeMaker defaults the latter to be the same subdirectory of
1178 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1179 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1180 for INSTALLSITELIB and INSTALLSITEARCH.
1182 MakeMaker gives you much more freedom than needed to configure
1183 internal variables and get different results. It is worth to mention,
1184 that make(1) also lets you configure most of the variables that are
1185 used in the Makefile. But in the majority of situations this will not
1186 be necessary, and should only be done if the author of a package
1187 recommends it (or you know what you're doing).
1189 =head2 Using Attributes and Parameters
1191 The following attributes can be specified as arguments to WriteMakefile()
1192 or as NAME=VALUE pairs on the command line:
1198 One line description of the module. Will be included in PPD file.
1202 Name of the file that contains the package description. MakeMaker looks
1203 for a line in the POD matching /^($package\s-\s)(.*)/. This is typically
1204 the first line in the "=head1 NAME" section. $2 becomes the abstract.
1208 String containing name (and email address) of package author(s). Is used
1209 in PPD (Perl Package Description) files for PPM (Perl Package Manager).
1211 =item BINARY_LOCATION
1213 Used when creating PPD files for binary packages. It can be set to a
1214 full or relative path or URL to the binary archive for a particular
1215 architecture. For example:
1217 perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
1219 builds a PPD package that references a binary of the C<Agent> package,
1220 located in the C<x86> directory relative to the PPD itself.
1224 Ref to array of *.c file names. Initialised from a directory scan
1225 and the values portion of the XS attribute hash. This is not
1226 currently used by MakeMaker but may be handy in Makefile.PLs.
1230 [This attribute is obsolete in Perl 5.6. PERL_OBJECT builds are C-compatible
1233 Switch to force usage of the Perl C API even when compiling for PERL_OBJECT.
1235 Note that this attribute is passed through to any recursive build,
1236 but if and only if the submodule's Makefile.PL itself makes no mention
1237 of the 'CAPI' attribute.
1241 String that will be included in the compiler call command line between
1242 the arguments INC and OPTIMIZE.
1246 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1247 config.sh. MakeMaker will add to CONFIG the following values anyway:
1267 CODE reference. The subroutine should return a hash reference. The
1268 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1269 be determined by some evaluation method.
1273 Something like C<"-DHAVE_UNISTD_H">
1277 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1282 Your name for distributing the package (by tar file). This defaults to
1287 Hashref of symbol names for routines to be made available as universal
1288 symbols. Each key/value pair consists of the package name and an
1289 array of routine names in that package. Used only under AIX, OS/2,
1290 VMS and Win32 at present. The routine names supplied will be expanded
1291 in the same way as XSUB names are expanded by the XS() macro.
1294 {"$(NAME)" => ["boot_$(NAME)" ] }
1298 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1299 "NetconfigPtr" => [ 'DESTROY'] }
1301 Please see the L<ExtUtils::Mksymlists> documentation for more information
1302 about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
1306 Array of symbol names for variables to be made available as universal symbols.
1307 Used only under AIX, OS/2, VMS and Win32 at present. Defaults to [].
1308 (e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
1312 Array of extension names to exclude when doing a static build. This
1313 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1314 details. (e.g. [ qw( Socket POSIX ) ] )
1316 This attribute may be most useful when specified as a string on the
1317 command line: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1321 Ref to array of executable files. The files will be copied to the
1322 INST_SCRIPT directory. Make realclean will delete them from there
1325 =item FIRST_MAKEFILE
1327 The name of the Makefile to be produced. Defaults to the contents of
1328 MAKEFILE, but can be overridden. This is used for the second Makefile
1329 that will be produced for the MAP_TARGET.
1333 Perl binary able to run this extension.
1337 This provides an alternate means to specify function names to be
1338 exported from the extension. Its value is a reference to an
1339 array of function names to be exported by the extension. These
1340 names are passed through unaltered to the linker options file.
1344 Ref to array of *.h file names. Similar to C.
1348 Hashref of .pm and .pod files. MakeMaker will default this to all
1349 .pod and any .pm files that include POD directives. The files listed
1350 here will be converted to HTML format and installed as was requested
1353 =item HTMLSCRIPTPODS
1355 Hashref of pod-containing files. MakeMaker will default this to all
1356 EXE_FILES files that include POD directives. The files listed
1357 here will be converted to HTML format and installed as was requested
1362 This attribute is used to specify names to be imported into the
1363 extension. It is only used on OS/2 and Win32.
1367 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1371 Array of extension names to be included when doing a static build.
1372 MakeMaker will normally build with all of the installed extensions when
1373 doing a static build, and that is usually the desired behavior. If
1374 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1375 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1377 It is not necessary to mention DynaLoader or the current extension when
1378 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1379 only DynaLoader and the current extension will be included in the build.
1381 This attribute may be most useful when specified as a string on the
1382 command line: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1384 =item INSTALLARCHLIB
1386 Used by 'make install', which copies files from INST_ARCHLIB to this
1387 directory if INSTALLDIRS is set to perl.
1391 Directory to install binary files (e.g. tkperl) into.
1395 Determines which of the two sets of installation directories to
1396 choose: installprivlib and installarchlib versus installsitelib and
1397 installsitearch. The first pair is chosen with INSTALLDIRS=perl, the
1398 second with INSTALLDIRS=site. Default is site.
1400 =item INSTALLHTMLPRIVLIBDIR
1402 This directory gets the HTML pages at 'make install' time. Defaults to
1403 $Config{installhtmlprivlibdir}.
1405 =item INSTALLHTMLSCRIPTDIR
1407 This directory gets the HTML pages at 'make install' time. Defaults to
1408 $Config{installhtmlscriptdir}.
1410 =item INSTALLHTMLSITELIBDIR
1412 This directory gets the HTML pages at 'make install' time. Defaults to
1413 $Config{installhtmlsitelibdir}.
1416 =item INSTALLMAN1DIR
1418 This directory gets the man pages at 'make install' time. Defaults to
1419 $Config{installman1dir}.
1421 =item INSTALLMAN3DIR
1423 This directory gets the man pages at 'make install' time. Defaults to
1424 $Config{installman3dir}.
1426 =item INSTALLPRIVLIB
1428 Used by 'make install', which copies files from INST_LIB to this
1429 directory if INSTALLDIRS is set to perl.
1433 Used by 'make install' which copies files from INST_SCRIPT to this
1436 =item INSTALLSITEARCH
1438 Used by 'make install', which copies files from INST_ARCHLIB to this
1439 directory if INSTALLDIRS is set to site (default).
1441 =item INSTALLSITELIB
1443 Used by 'make install', which copies files from INST_LIB to this
1444 directory if INSTALLDIRS is set to site (default).
1448 Same as INST_LIB for architecture dependent files.
1452 Directory to put real binary files during 'make'. These will be copied
1453 to INSTALLBIN during 'make install'
1457 Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you
1460 =item INST_HTMLLIBDIR
1462 Directory to hold the man pages in HTML format at 'make' time
1464 =item INST_HTMLSCRIPTDIR
1466 Directory to hold the man pages in HTML format at 'make' time
1470 Directory where we put library files of this extension while building
1475 Directory to hold the man pages at 'make' time
1479 Directory to hold the man pages at 'make' time
1483 Directory, where executable files should be installed during
1484 'make'. Defaults to "./blib/script", just to have a dummy location during
1485 testing. make install will copy the files in INST_SCRIPT to
1490 defaults to "$(OBJECT)" and is used in the ld command to specify
1491 what files to link/load from (also see dynamic_lib below for how to
1496 LIB should only be set at C<perl Makefile.PL> time but is allowed as a
1497 MakeMaker argument. It has the effect of
1498 setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any
1499 explicit setting of those arguments (or of PREFIX).
1500 INSTALLARCHLIB and INSTALLSITEARCH are set to the corresponding
1501 architecture subdirectory.
1505 The filename of the perllibrary that will be used together with this
1506 extension. Defaults to libperl.a.
1510 An anonymous array of alternative library
1511 specifications to be searched for (in order) until
1512 at least one library is found. E.g.
1514 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1516 Mind, that any element of the array
1517 contains a complete set of arguments for the ld
1518 command. So do not specify
1520 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1522 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1523 you specify a scalar as in
1525 'LIBS' => "-ltcl -ltk -lX11"
1527 MakeMaker will turn it into an array with one element.
1531 'static' or 'dynamic' (default unless usedl=undef in
1532 config.sh). Should only be used to force static linking (also see
1537 Boolean which tells MakeMaker, that it should include the rules to
1538 make a perl. This is handled automatically as a switch by
1539 MakeMaker. The user normally does not need it.
1543 The name of the Makefile to be produced.
1547 Hashref of pod-containing files. MakeMaker will default this to all
1548 EXE_FILES files that include POD directives. The files listed
1549 here will be converted to man pages and installed as was requested
1554 Hashref that assigns to *.pm and *.pod files the files into which the
1555 manpages are to be written. MakeMaker parses all *.pod and *.pm files
1556 for POD directives. Files that contain POD will be the default keys of
1557 the MAN3PODS hashref. These will then be converted to man pages during
1558 C<make> and will be installed during C<make install>.
1562 If it is intended, that a new perl binary be produced, this variable
1563 may hold a name for that binary. Defaults to perl
1567 If the extension links to a library that it builds set this to the
1568 name of the library (see SDBM_File)
1572 Perl module name for this extension (DBD::Oracle). This will default
1573 to the directory name but should be explicitly defined in the
1578 MakeMaker will figure out if an extension contains linkable code
1579 anywhere down the directory tree, and will set this variable
1580 accordingly, but you can speed it up a very little bit if you define
1581 this boolean variable yourself.
1585 Defaults to C<@>. By setting it to an empty string you can generate a
1586 Makefile that echos all commands. Mainly used in debugging MakeMaker
1591 Boolean. Attribute to inhibit descending into subdirectories.
1595 In general, any generated Makefile checks for the current version of
1596 MakeMaker and the version the Makefile was built under. If NO_VC is
1597 set, the version check is neglected. Do not write this into your
1598 Makefile.PL, use it interactively instead.
1602 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1603 string containing all object files, e.g. "tkpBind.o
1604 tkpButton.o tkpCanvas.o"
1606 (Where BASEEXT is the last component of NAME, and OBJ_EXT is $Config{obj_ext}.)
1610 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1611 passed to subdirectory makes.
1615 Perl binary for tasks that can be done by miniperl
1619 Set only when MakeMaker is building the extensions of the Perl core
1624 The call to the program that is able to compile perlmain.c. Defaults
1629 Same as for PERL_LIB, but for architecture dependent files.
1631 Used only when MakeMaker is building the extensions of the Perl core
1632 distribution (because normally $(PERL_ARCHLIB) is automatically in @INC,
1633 and adding it would get in the way of PERL5LIB).
1637 Directory containing the Perl library to use.
1639 Used only when MakeMaker is building the extensions of the Perl core
1640 distribution (because normally $(PERL_LIB) is automatically in @INC,
1641 and adding it would get in the way of PERL5LIB).
1643 =item PERL_MALLOC_OK
1645 defaults to 0. Should be set to TRUE if the extension can work with
1646 the memory allocation routines substituted by the Perl malloc() subsystem.
1647 This should be applicable to most extensions with exceptions of those
1653 with bugs in memory allocations which are caught by Perl's malloc();
1657 which interact with the memory allocator in other ways than via
1658 malloc(), realloc(), free(), calloc(), sbrk() and brk();
1662 which rely on special alignment which is not provided by Perl's malloc().
1666 B<NOTE.> Negligence to set this flag in I<any one> of loaded extension
1667 nullifies many advantages of Perl's malloc(), such as better usage of
1668 system resources, error detection, memory usage reporting, catchable failure
1669 of memory allocations, etc.
1673 Use this instead of $(PERL) or $(FULLPERL) when you wish to run perl.
1674 It will set up extra necessary flags for you.
1678 Use this instead of $(PERL) or $(FULLPERL) when you wish to run
1679 perl to work with modules. It will add things like -I$(INST_ARCH)
1680 and other necessary flags.
1684 Directory containing the Perl source code (use of this should be
1685 avoided, it may be undefined)
1689 Desired permission for read/writable files. Defaults to C<644>.
1690 See also L<MM_Unix/perm_rw>.
1694 Desired permission for executable files. Defaults to C<755>.
1695 See also L<MM_Unix/perm_rwx>.
1699 Ref to hash of files to be processed as perl programs. MakeMaker
1700 will default to any found *.PL file (except Makefile.PL) being keys
1701 and the basename of the file being the value. E.g.
1703 {'foobar.PL' => 'foobar'}
1705 The *.PL files are expected to produce output to the target files
1706 themselves. If multiple files can be generated from the same *.PL
1707 file then the value in the hash can be a reference to an array of
1708 target file names. E.g.
1710 {'foobar.PL' => ['foobar1','foobar2']}
1714 Hashref of .pm files and *.pl files to be installed. e.g.
1716 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1718 By default this will include *.pm and *.pl and the files found in
1719 the PMLIBDIRS directories. Defining PM in the
1720 Makefile.PL will override PMLIBDIRS.
1724 Ref to array of subdirectories containing library files. Defaults to
1725 [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
1726 they contain will be installed in the corresponding location in the
1727 library. A libscan() method can be used to alter the behaviour.
1728 Defining PM in the Makefile.PL will override PMLIBDIRS.
1730 (Where BASEEXT is the last component of NAME.)
1734 A filter program, in the traditional Unix sense (input from stdin, output
1735 to stdout) that is passed on each .pm file during the build (in the
1736 pm_to_blib() phase). It is empty by default, meaning no filtering is done.
1738 Great care is necessary when defining the command if quoting needs to be
1739 done. For instance, you would need to say:
1741 {'PM_FILTER' => 'grep -v \\"^\\#\\"'}
1743 to remove all the leading coments on the fly during the build. The
1744 extra \\ are necessary, unfortunately, because this variable is interpolated
1745 within the context of a Perl program built on the command line, and double
1746 quotes are what is used with the -e switch to build that command line. The
1747 # is escaped for the Makefile, since what is going to be generated will then
1750 PM_FILTER = grep -v \"^\#\"
1752 Without the \\ before the #, we'd have the start of a Makefile comment,
1753 and the macro would be incorrectly defined.
1757 Release 5.005 grandfathered old global symbol names by providing preprocessor
1758 macros for extension source compatibility. As of release 5.6, these
1759 preprocessor definitions are not available by default. The POLLUTE flag
1760 specifies that the old names should still be defined:
1762 perl Makefile.PL POLLUTE=1
1764 Please inform the module author if this is necessary to successfully install
1765 a module under 5.6 or later.
1767 =item PPM_INSTALL_EXEC
1769 Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl)
1771 =item PPM_INSTALL_SCRIPT
1773 Name of the script that gets executed by the Perl Package Manager after
1774 the installation of a package.
1778 Can be used to set the three INSTALL* attributes in one go (except for
1779 probably INSTALLMAN1DIR, if it is not below PREFIX according to
1780 %Config). They will have PREFIX as a common directory node and will
1781 branch from that node into lib/, lib/ARCHNAME or whatever Configure
1782 decided at the build time of your perl (unless you override one of
1787 Hashref: Names of modules that need to be available to run this
1788 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1789 desired version is the value. If the required version number is 0, we
1790 only check if any version is installed already.
1794 Arrayref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1795 Makefile. Caution! Do not use the SKIP attribute for the negligible
1796 speedup. It may seriously damage the resulting Makefile. Only use it
1797 if you really need it.
1801 The set of -I's necessary to run a "make test". Use as:
1802 $(PERL) $(TEST_LIBS) -e '...' for example.
1806 Ref to array of typemap file names. Use this when the typemaps are
1807 in some directory other than the current directory or when they are
1808 not named B<typemap>. The last typemap in the list takes
1809 precedence. A typemap in the current directory has highest
1810 precedence, even if it isn't listed in TYPEMAPS. The default system
1811 typemap has lowest precedence.
1815 Your version number for distributing the package. This defaults to
1820 Instead of specifying the VERSION in the Makefile.PL you can let
1821 MakeMaker parse a file to determine the version number. The parsing
1822 routine requires that the file named by VERSION_FROM contains one
1823 single line to compute the version number. The first line in the file
1824 that contains the regular expression
1826 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
1828 will be evaluated with eval() and the value of the named variable
1829 B<after> the eval() will be assigned to the VERSION attribute of the
1830 MakeMaker object. The following lines will be parsed o.k.:
1834 ( $VERSION ) = '$Revision: 1.222 $ ' =~ /\$Revision:\s+([^\s]+)/;
1835 $FOO::VERSION = '1.10';
1836 *FOO::VERSION = \'1.11';
1837 our $VERSION = 1.2.3; # new for perl5.6.0
1839 but these will fail:
1841 my $VERSION = '1.01';
1842 local $VERSION = '1.02';
1843 local $FOO::VERSION = '1.30';
1845 (Putting C<my> or C<local> on the preceding line will work o.k.)
1847 The file named in VERSION_FROM is not added as a dependency to
1848 Makefile. This is not really correct, but it would be a major pain
1849 during development to have to rewrite the Makefile for any smallish
1850 change in that file. If you want to make sure that the Makefile
1851 contains the correct VERSION macro after any change of the file, you
1852 would have to do something like
1854 depend => { Makefile => '$(VERSION_FROM)' }
1856 See attribute C<depend> below.
1860 Hashref of .xs files. MakeMaker will default this. e.g.
1862 {'name_of_file.xs' => 'name_of_file.c'}
1864 The .c files will automatically be included in the list of files
1865 deleted by a make clean.
1869 String of options to pass to xsubpp. This might include C<-C++> or
1870 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
1875 May be set to an empty string, which is identical to C<-prototypes>, or
1876 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
1877 defaults to the empty string.
1881 Your version number for the .xs file of this package. This defaults
1882 to the value of the VERSION attribute.
1886 =head2 Additional lowercase attributes
1888 can be used to pass parameters to the methods which implement that
1889 part of the Makefile.
1895 {FILES => "*.xyz foo"}
1899 {ANY_TARGET => ANY_DEPENDECY, ...}
1901 (ANY_TARGET must not be given a double-colon rule by MakeMaker.)
1905 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
1906 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
1907 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
1909 If you specify COMPRESS, then SUFFIX should also be altered, as it is
1910 needed to tell make the target file of the compression. Setting
1911 DIST_CP to ln can be useful, if you need to preserve the timestamps on
1912 your files. DIST_CP can take the values 'cp', which copies the file,
1913 'ln', which links the file, and 'best' which copies symbolic links and
1914 links the rest. Default is 'best'.
1918 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
1922 {LINKTYPE => 'static', 'dynamic' or ''}
1924 NB: Extensions that have nothing but *.pm files had to say
1928 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1929 can be deleted safely. MakeMaker recognizes when there's nothing to
1934 {ANY_MACRO => ANY_VALUE, ...}
1938 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
1944 =item tool_autosplit
1950 =head2 Overriding MakeMaker Methods
1952 If you cannot achieve the desired Makefile behaviour by specifying
1953 attributes you may define private subroutines in the Makefile.PL.
1954 Each subroutines returns the text it wishes to have written to
1955 the Makefile. To override a section of the Makefile you can
1958 sub MY::c_o { "new literal text" }
1960 or you can edit the default by saying something like:
1963 package MY; # so that "SUPER" works right
1964 my $inherited = shift->SUPER::c_o(@_);
1965 $inherited =~ s/old text/new text/;
1969 If you are running experiments with embedding perl as a library into
1970 other applications, you might find MakeMaker is not sufficient. You'd
1971 better have a look at ExtUtils::Embed which is a collection of utilities
1974 If you still need a different solution, try to develop another
1975 subroutine that fits your needs and submit the diffs to
1976 F<perl5-porters@perl.org> or F<comp.lang.perl.moderated> as appropriate.
1978 For a complete description of all MakeMaker methods see L<ExtUtils::MM_Unix>.
1980 Here is a simple example of how to add a new target to the generated
1985 $(MYEXTLIB): sdbm/Makefile
1986 cd sdbm && $(MAKE) all
1991 =head2 Hintsfile support
1993 MakeMaker.pm uses the architecture specific information from
1994 Config.pm. In addition it evaluates architecture specific hints files
1995 in a C<hints/> directory. The hints files are expected to be named
1996 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
1997 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
1998 MakeMaker within the WriteMakefile() subroutine, and can be used to
1999 execute commands as well as to include special variables. The rules
2000 which hintsfile is chosen are the same as in Configure.
2002 The hintsfile is eval()ed immediately after the arguments given to
2003 WriteMakefile are stuffed into a hash reference $self but before this
2004 reference becomes blessed. So if you want to do the equivalent to
2005 override or create an attribute you would say something like
2007 $self->{LIBS} = ['-ldbm -lucb -lc'];
2009 =head2 Distribution Support
2011 For authors of extensions MakeMaker provides several Makefile
2012 targets. Most of the support comes from the ExtUtils::Manifest module,
2013 where additional documentation can be found.
2017 =item make distcheck
2019 reports which files are below the build directory but not in the
2020 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
2023 =item make skipcheck
2025 reports which files are skipped due to the entries in the
2026 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
2029 =item make distclean
2031 does a realclean first and then the distcheck. Note that this is not
2032 needed to build a new distribution as long as you are sure that the
2033 MANIFEST file is ok.
2037 rewrites the MANIFEST file, adding all remaining files found (See
2038 ExtUtils::Manifest::mkmanifest() for details)
2042 Copies all the files that are in the MANIFEST file to a newly created
2043 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
2044 exists, it will be removed first.
2048 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
2049 a make test in that directory.
2053 First does a distdir. Then a command $(PREOP) which defaults to a null
2054 command, followed by $(TOUNIX), which defaults to a null command under
2055 UNIX, and will convert files in distribution directory to UNIX format
2056 otherwise. Next it runs C<tar> on that directory into a tarfile and
2057 deletes the directory. Finishes with a command $(POSTOP) which
2058 defaults to a null command.
2062 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
2064 =item make uutardist
2066 Runs a tardist first and uuencodes the tarfile.
2070 First does a distdir. Then a command $(PREOP) which defaults to a null
2071 command. Next it runs C<shar> on that directory into a sharfile and
2072 deletes the intermediate directory again. Finishes with a command
2073 $(POSTOP) which defaults to a null command. Note: For shdist to work
2074 properly a C<shar> program that can handle directories is mandatory.
2078 First does a distdir. Then a command $(PREOP) which defaults to a null
2079 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
2080 zipfile. Then deletes that directory. Finishes with a command
2081 $(POSTOP) which defaults to a null command.
2085 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
2089 Customization of the dist targets can be done by specifying a hash
2090 reference to the dist attribute of the WriteMakefile call. The
2091 following parameters are recognized:
2094 COMPRESS ('gzip --best')
2097 TO_UNIX (depends on the system)
2098 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
2108 WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" })
2110 =head2 Disabling an extension
2112 If some events detected in F<Makefile.PL> imply that there is no way
2113 to create the Module, but this is a normal state of things, then you
2114 can create a F<Makefile> which does nothing, but succeeds on all the
2115 "usual" build targets. To do so, use
2117 ExtUtils::MakeMaker::WriteEmptyMakefile();
2119 instead of WriteMakefile().
2121 This may be useful if other modules expect this module to be I<built>
2122 OK, as opposed to I<work> OK (say, this system-dependent module builds
2123 in a subdirectory of some other distribution, or is listed as a
2124 dependency in a CPAN::Bundle, but the functionality is supported by
2125 different means on the current architecture).
2133 Command line options used by C<MakeMaker-E<gt>new()>, and thus by
2134 C<WriteMakefile()>. The string is split on whitespace, and the result
2135 is processed before any actual command line arguments are processed.
2141 ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib,
2142 ExtUtils::Install, ExtUtils::Embed
2146 Andy Dougherty <F<doughera@lafcol.lafayette.edu>>, Andreas KE<ouml>nig
2147 <F<andreas.koenig@mind.de>>, Tim Bunce <F<Tim.Bunce@ig.co.uk>>. VMS
2148 support by Charles Bailey <F<bailey@newman.upenn.edu>>. OS/2 support
2149 by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>.
2151 Send patches and bug reports to <F<perlbug@perl.org>>.