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 PERL_ARCHLIB PERL_LIB PERL_SRC PERM_RW PERM_RWX
209 PL_FILES PM PM_FILTER PMLIBDIRS POLLUTE PPM_INSTALL_EXEC
210 PPM_INSTALL_SCRIPT PREFIX
211 PREREQ_PM SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
212 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(%initial_att) = %$self; # record initial attributes
341 foreach $prereq (sort keys %{$self->{PREREQ_PM}}) {
342 my $eval = "require $prereq";
346 warn "Warning: prerequisite $prereq failed to load: $@";
348 elsif ($prereq->VERSION < $self->{PREREQ_PM}->{$prereq} ){
349 warn "Warning: prerequisite $prereq $self->{PREREQ_PM}->{$prereq} not found";
350 # Why is/was this 'delete' here? We need PREREQ_PM later to make PPDs.
352 # delete $self->{PREREQ_PM}{$prereq};
356 # unless (defined $ExtUtils::MakeMaker::useCPAN) {
357 # print qq{MakeMaker WARNING: prerequisites not found (@unsatisfied)
358 # Please install these modules first and rerun 'perl Makefile.PL'.\n};
359 # if ($ExtUtils::MakeMaker::hasCPAN) {
360 # $ExtUtils::MakeMaker::useCPAN = prompt(qq{Should I try to use the CPAN module to fetch them for you?},"yes");
362 # print qq{Hint: You may want to install the CPAN module to autofetch the needed modules\n};
363 # $ExtUtils::MakeMaker::useCPAN=0;
366 # if ($ExtUtils::MakeMaker::useCPAN) {
368 # CPAN->import(@unsatisfied);
370 # die qq{prerequisites not found (@unsatisfied)};
372 # warn qq{WARNING: prerequisites not found (@unsatisfied)};
375 if (defined $self->{CONFIGURE}) {
376 if (ref $self->{CONFIGURE} eq 'CODE') {
377 $self = { %$self, %{&{$self->{CONFIGURE}}}};
379 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
383 # This is for old Makefiles written pre 5.00, will go away
384 if ( Carp::longmess("") =~ /runsubdirpl/s ){
385 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
388 my $newclass = ++$PACKNAME;
389 local @Parent = @Parent; # Protect against non-local exits
392 print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
393 mv_all_methods("MY",$newclass);
394 bless $self, $newclass;
396 @{"$newclass\:\:ISA"} = 'MM';
399 if (defined $Parent[-2]){
400 $self->{PARENT} = $Parent[-2];
402 for $key (keys %Prepend_dot_dot) {
403 next unless defined $self->{PARENT}{$key};
404 $self->{$key} = $self->{PARENT}{$key};
405 # PERL and FULLPERL may be command verbs instead of full
406 # file specifications under VMS. If so, don't turn them
408 $self->{$key} = $self->catdir("..",$self->{$key})
409 unless $self->file_name_is_absolute($self->{$key})
410 || ($^O eq 'VMS' and ($key =~ /PERL$/ && $self->{$key} =~ /^[\w\-\$]+$/));
412 if ($self->{PARENT}) {
413 $self->{PARENT}->{CHILDREN}->{$newclass} = $self;
414 foreach my $opt (qw(CAPI POLLUTE)) {
415 if (exists $self->{PARENT}->{$opt}
416 and not exists $self->{$opt})
418 # inherit, but only if already unspecified
419 $self->{$opt} = $self->{PARENT}->{$opt};
424 parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV);
427 $self->{NAME} ||= $self->guess_name;
429 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
433 if (! $self->{PERL_SRC} ) {
434 my($pthinks) = $self->canonpath($INC{'Config.pm'});
435 my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
436 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
437 if ($pthinks ne $cthinks &&
438 !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
439 print "Have $pthinks expected $cthinks\n";
441 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
444 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
446 print STDOUT <<END unless $self->{UNINSTALLED_PERL};
447 Your perl and your Config.pm seem to have different ideas about the architecture
449 Perl thinks: [$pthinks]
450 Config says: [$Config{archname}]
451 This may or may not cause problems. Please check your installation of perl if you
452 have problems building this extension.
457 $self->init_dirscan();
458 $self->init_others();
459 my($argv) = neatvalue(\@ARGV);
463 push @{$self->{RESULT}}, <<END;
464 # This Makefile is for the $self->{NAME} extension to perl.
466 # It was generated automatically by MakeMaker version
467 # $VERSION (Revision: $Revision) from the contents of
468 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
470 # ANY CHANGES MADE HERE WILL BE LOST!
472 # MakeMaker ARGV: $argv
474 # MakeMaker Parameters:
477 foreach $key (sort keys %initial_att){
478 my($v) = neatvalue($initial_att{$key});
479 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
481 push @{$self->{RESULT}}, "# $key => $v";
484 # turn the SKIP array into a SKIPHASH hash
486 for $skip (@{$self->{SKIP} || []}) {
487 $self->{SKIPHASH}{$skip} = 1;
489 delete $self->{SKIP}; # free memory
491 if ($self->{PARENT}) {
492 for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
493 $self->{SKIPHASH}{$_} = 1;
497 # We run all the subdirectories now. They don't have much to query
498 # from the parent, but the parent has to query them: if they need linking!
499 unless ($self->{NORECURS}) {
500 $self->eval_in_subdirs if @{$self->{DIR}};
504 foreach $section ( @MM_Sections ){
505 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
506 my($skipit) = $self->skipcheck($section);
508 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
510 my(%a) = %{$self->{$section} || {}};
511 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
512 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
513 push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
517 push @{$self->{RESULT}}, "\n# End.";
522 sub WriteEmptyMakefile {
523 if (-f 'Makefile.old') {
524 chmod 0666, 'Makefile.old';
525 unlink 'Makefile.old' or warn "unlink Makefile.old: $!";
527 rename 'Makefile', 'Makefile.old' or warn "rename Makefile Makefile.old: $!"
529 open MF, '> Makefile' or die "open Makefile for write: $!";
542 close MF or die "close Makefile for write: $!";
546 print STDOUT "Checking if your kit is complete...\n";
547 require ExtUtils::Manifest;
548 $ExtUtils::Manifest::Quiet=$ExtUtils::Manifest::Quiet=1; #avoid warning
549 my(@missed)=ExtUtils::Manifest::manicheck();
551 print STDOUT "Warning: the following files are missing in your kit:\n";
552 print "\t", join "\n\t", @missed;
554 print STDOUT "Please inform the author.\n";
556 print STDOUT "Looks good\n";
561 my($self, @args) = @_;
563 unless (m/(.*?)=(.*)/){
564 help(),exit 1 if m/^help$/;
565 ++$Verbose if m/^verb/;
568 my($name, $value) = ($1, $2);
569 if ($value =~ m/^~(\w+)?/){ # tilde with optional username
570 $value =~ s [^~(\w*)]
572 ((getpwnam($1))[7] || "~$1") :
576 $self->{uc($name)} = $value;
579 # catch old-style 'potential_libs' and inform user how to 'upgrade'
580 if (defined $self->{potential_libs}){
581 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
582 if ($self->{potential_libs}){
583 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
585 print STDOUT "$msg deleted.\n";
587 $self->{LIBS} = [$self->{potential_libs}];
588 delete $self->{potential_libs};
590 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
591 if (defined $self->{ARMAYBE}){
592 my($armaybe) = $self->{ARMAYBE};
593 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
594 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
595 my(%dl) = %{$self->{dynamic_lib} || {}};
596 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
597 delete $self->{ARMAYBE};
599 if (defined $self->{LDTARGET}){
600 print STDOUT "LDTARGET should be changed to LDFROM\n";
601 $self->{LDFROM} = $self->{LDTARGET};
602 delete $self->{LDTARGET};
604 # Turn a DIR argument on the command line into an array
605 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
606 # So they can choose from the command line, which extensions they want
607 # the grep enables them to have some colons too much in case they
608 # have to build a list with the shell
609 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
611 # Turn a INCLUDE_EXT argument on the command line into an array
612 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
613 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
615 # Turn a EXCLUDE_EXT argument on the command line into an array
616 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
617 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
620 foreach $mmkey (sort keys %$self){
621 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
622 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
623 unless exists $Recognized_Att_Keys{$mmkey};
630 # We allow extension-specific hints files.
632 return unless -d "hints";
634 # First we look for the best hintsfile we have
636 my($hint)="${^O}_$Config{osvers}";
641 # Also try without trailing minor version numbers.
643 last if -f "hints/$hint.pl"; # found
645 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
647 return unless -f "hints/$hint.pl"; # really there
649 # execute the hintsfile:
651 # my $fh = new FileHandle;
652 # $fh->open("hints/$hint.pl");
654 open(FH,"hints/$hint.pl");
655 # @goodhints = <$fh>;
659 print STDOUT "Processing hints file hints/$hint.pl\n";
660 eval join('',@goodhints);
661 print STDOUT $@ if $@;
667 my($symtab) = \%{"${from}::"};
670 # Here you see the *current* list of methods that are overridable
671 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
672 # still trying to reduce the list to some reasonable minimum --
673 # because I want to make it easier for the user. A.K.
675 foreach $method (@Overridable) {
677 # We cannot say "next" here. Nick might call MY->makeaperl
678 # which isn't defined right now
680 # Above statement was written at 4.23 time when Tk-b8 was
681 # around. As Tk-b9 only builds with 5.002something and MM 5 is
682 # standard, we try to enable the next line again. It was
683 # commented out until MM 5.23
685 next unless defined &{"${from}::$method"};
687 *{"${to}::$method"} = \&{"${from}::$method"};
689 # delete would do, if we were sure, nobody ever called
690 # MY->makeaperl directly
692 # delete $symtab->{$method};
694 # If we delete a method, then it will be undefined and cannot
695 # be called. But as long as we have Makefile.PLs that rely on
696 # %MY:: being intact, we have to fill the hole with an
699 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
702 # We have to clean out %INC also, because the current directory is
703 # changed frequently and Graham Barr prefers to get his version
704 # out of a History.pl file which is "required" so woudn't get
705 # loaded again in another extension requiring a History.pl
707 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
708 # to core dump in the middle of a require statement. The required
709 # file was Tk/MMutil.pm. The consequence is, we have to be
710 # extremely careful when we try to give perl a reason to reload a
711 # library with same name. The workaround prefers to drop nothing
712 # from %INC and teach the writers not to use such libraries.
715 # foreach $inc (keys %INC) {
716 # #warn "***$inc*** deleted";
724 if ($section eq 'dynamic') {
725 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
726 "in skipped section 'dynamic_bs'\n"
727 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
728 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
729 "in skipped section 'dynamic_lib'\n"
730 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
732 if ($section eq 'dynamic_lib') {
733 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
734 "targets in skipped section 'dynamic_bs'\n"
735 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
737 if ($section eq 'static') {
738 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
739 "in skipped section 'static_lib'\n"
740 if $self->{SKIPHASH}{static_lib} && $Verbose;
742 return 'skipped' if $self->{SKIPHASH}{$section};
750 # my $fh = new FileHandle;
752 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
754 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
755 # $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
756 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
758 for $chunk (@{$self->{RESULT}}) {
759 # print $fh "$chunk\n";
765 my($finalname) = $self->{MAKEFILE};
766 rename("MakeMaker.tmp", $finalname);
767 chmod 0644, $finalname unless $Is_VMS;
769 if ($self->{PARENT}) {
770 foreach (keys %$self) { # safe memory
771 delete $self->{$_} unless $Keep_after_flush{$_};
775 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
778 # The following mkbootstrap() is only for installations that are calling
779 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
780 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
783 !!! Your Makefile has been built such a long time ago, !!!
784 !!! that is unlikely to work with current MakeMaker. !!!
785 !!! Please rebuild your Makefile !!!
789 # Ditto for mksymlists() as of MakeMaker 5.17
792 !!! Your Makefile has been built such a long time ago, !!!
793 !!! that is unlikely to work with current MakeMaker. !!!
794 !!! Please rebuild your Makefile !!!
800 return "undef" unless defined $v;
802 return "q[$v]" unless $t;
804 my(@m, $elem, @neat);
806 foreach $elem (@$v) {
807 push @neat, "q[$elem]";
809 push @m, join ", ", @neat;
813 return "$v" unless $t eq 'HASH';
815 while (($key,$val) = each %$v){
816 last unless defined $key; # cautious programming in case (undef,undef) is true
817 push(@m,"$key=>".neatvalue($val)) ;
819 return "{ ".join(', ',@m)." }";
826 push @m, "\n# Full list of MakeMaker attribute values:";
827 foreach $key (sort keys %$self){
828 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
829 my($v) = neatvalue($self->{$key});
830 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
832 push @m, "# $key => $v";
838 package ExtUtils::MakeMaker;
845 ExtUtils::MakeMaker - create an extension Makefile
849 C<use ExtUtils::MakeMaker;>
851 C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
855 C<MM-E<gt>new(\%att)-E<gt>flush;>
859 This utility is designed to write a Makefile for an extension module
860 from a Makefile.PL. It is based on the Makefile.SH model provided by
861 Andy Dougherty and the perl5-porters.
863 It splits the task of generating the Makefile into several subroutines
864 that can be individually overridden. Each subroutine returns the text
865 it wishes to have written to the Makefile.
867 MakeMaker is object oriented. Each directory below the current
868 directory that contains a Makefile.PL. Is treated as a separate
869 object. This makes it possible to write an unlimited number of
870 Makefiles with a single invocation of WriteMakefile().
872 =head2 How To Write A Makefile.PL
874 The short answer is: Don't.
876 Always begin with h2xs.
877 Always begin with h2xs!
878 ALWAYS BEGIN WITH H2XS!
880 even if you're not building around a header file, and even if you
881 don't have an XS component.
883 Run h2xs(1) before you start thinking about writing a module. For so
884 called pm-only modules that consist of C<*.pm> files only, h2xs has
885 the C<-X> switch. This will generate dummy files of all kinds that are
886 useful for the module developer.
888 The medium answer is:
890 use ExtUtils::MakeMaker;
891 WriteMakefile( NAME => "Foo::Bar" );
893 The long answer is the rest of the manpage :-)
895 =head2 Default Makefile Behaviour
897 The generated Makefile enables the user of the extension to invoke
899 perl Makefile.PL # optionally "perl Makefile.PL verbose"
901 make test # optionally set TEST_VERBOSE=1
902 make install # See below
904 The Makefile to be produced may be altered by adding arguments of the
905 form C<KEY=VALUE>. E.g.
907 perl Makefile.PL PREFIX=/tmp/myperl5
909 Other interesting targets in the generated Makefile are
911 make config # to check if the Makefile is up-to-date
912 make clean # delete local temp files (Makefile gets renamed)
913 make realclean # delete derived files (including ./blib)
914 make ci # check in all the files in the MANIFEST file
915 make dist # see below the Distribution Support section
919 MakeMaker checks for the existence of a file named F<test.pl> in the
920 current directory and if it exists it adds commands to the test target
921 of the generated Makefile that will execute the script with the proper
922 set of perl C<-I> options.
924 MakeMaker also checks for any files matching glob("t/*.t"). It will
925 add commands to the test target of the generated Makefile that execute
926 all matching files via the L<Test::Harness> module with the C<-I>
927 switches set correctly.
931 A useful variation of the above is the target C<testdb>. It runs the
932 test under the Perl debugger (see L<perldebug>). If the file
933 F<test.pl> exists in the current directory, it is used for the test.
935 If you want to debug some other testfile, set C<TEST_FILE> variable
938 make testdb TEST_FILE=t/mytest.t
940 By default the debugger is called using C<-d> option to perl. If you
941 want to specify some other option, set C<TESTDB_SW> variable:
943 make testdb TESTDB_SW=-Dx
947 make alone puts all relevant files into directories that are named by
948 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_HTMLLIBDIR,
949 INST_HTMLSCRIPTDIR, INST_MAN1DIR, and INST_MAN3DIR. All these default
950 to something below ./blib if you are I<not> building below the perl
951 source directory. If you I<are> building below the perl source,
952 INST_LIB and INST_ARCHLIB default to ../../lib, and INST_SCRIPT is not
955 The I<install> target of the generated Makefile copies the files found
956 below each of the INST_* directories to their INSTALL*
957 counterparts. Which counterparts are chosen depends on the setting of
958 INSTALLDIRS according to the following table:
963 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH
964 INST_LIB INSTALLPRIVLIB INSTALLSITELIB
965 INST_HTMLLIBDIR INSTALLHTMLPRIVLIBDIR INSTALLHTMLSITELIBDIR
966 INST_HTMLSCRIPTDIR INSTALLHTMLSCRIPTDIR
968 INST_SCRIPT INSTALLSCRIPT
969 INST_MAN1DIR INSTALLMAN1DIR
970 INST_MAN3DIR INSTALLMAN3DIR
972 The INSTALL... macros in turn default to their %Config
973 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
975 You can check the values of these variables on your system with
979 And to check the sequence in which the library directories are
980 searched by perl, run
982 perl -le 'print join $/, @INC'
985 =head2 PREFIX and LIB attribute
987 PREFIX and LIB can be used to set several INSTALL* attributes in one
988 go. The quickest way to install a module in a non-standard place might
991 perl Makefile.PL LIB=~/lib
993 This will install the module's architecture-independent files into
994 ~/lib, the architecture-dependent files into ~/lib/$archname.
996 Another way to specify many INSTALL directories with a single
999 perl Makefile.PL PREFIX=~
1001 This will replace the string specified by C<$Config{prefix}> in all
1002 C<$Config{install*}> values.
1004 Note, that in both cases the tilde expansion is done by MakeMaker, not
1005 by perl by default, nor by make.
1007 Conflicts between parameters LIB,
1008 PREFIX and the various INSTALL* arguments are resolved so that:
1014 setting LIB overrides any setting of INSTALLPRIVLIB, INSTALLARCHLIB,
1015 INSTALLSITELIB, INSTALLSITEARCH (and they are not affected by PREFIX);
1019 without LIB, setting PREFIX replaces the initial C<$Config{prefix}>
1020 part of those INSTALL* arguments, even if the latter are explicitly
1021 set (but are set to still start with C<$Config{prefix}>).
1025 If the user has superuser privileges, and is not working on AFS
1026 or relatives, then the defaults for
1027 INSTALLPRIVLIB, INSTALLARCHLIB, INSTALLSCRIPT, etc. will be appropriate,
1028 and this incantation will be the best:
1030 perl Makefile.PL; make; make test
1033 make install per default writes some documentation of what has been
1034 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1035 can be bypassed by calling make pure_install.
1039 will have to specify the installation directories as these most
1040 probably have changed since perl itself has been installed. They will
1041 have to do this by calling
1043 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1044 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1047 Be careful to repeat this procedure every time you recompile an
1048 extension, unless you are sure the AFS installation directories are
1051 =head2 Static Linking of a new Perl Binary
1053 An extension that is built with the above steps is ready to use on
1054 systems supporting dynamic loading. On systems that do not support
1055 dynamic loading, any newly created extension has to be linked together
1056 with the available resources. MakeMaker supports the linking process
1057 by creating appropriate targets in the Makefile whenever an extension
1058 is built. You can invoke the corresponding section of the makefile with
1062 That produces a new perl binary in the current directory with all
1063 extensions linked in that can be found in INST_ARCHLIB , SITELIBEXP,
1064 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1065 UNIX, this is called Makefile.aperl (may be system dependent). If you
1066 want to force the creation of a new perl, it is recommended, that you
1067 delete this Makefile.aperl, so the directories are searched-through
1068 for linkable libraries again.
1070 The binary can be installed into the directory where perl normally
1071 resides on your machine with
1075 To produce a perl binary with a different name than C<perl>, either say
1077 perl Makefile.PL MAP_TARGET=myperl
1084 make myperl MAP_TARGET=myperl
1085 make inst_perl MAP_TARGET=myperl
1087 In any case you will be prompted with the correct invocation of the
1088 C<inst_perl> target that installs the new binary into INSTALLBIN.
1090 make inst_perl per default writes some documentation of what has been
1091 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1092 can be bypassed by calling make pure_inst_perl.
1094 Warning: the inst_perl: target will most probably overwrite your
1095 existing perl binary. Use with care!
1097 Sometimes you might want to build a statically linked perl although
1098 your system supports dynamic loading. In this case you may explicitly
1099 set the linktype with the invocation of the Makefile.PL or make:
1101 perl Makefile.PL LINKTYPE=static # recommended
1105 make LINKTYPE=static # works on most systems
1107 =head2 Determination of Perl Library and Installation Locations
1109 MakeMaker needs to know, or to guess, where certain things are
1110 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1111 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1112 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1114 Extensions may be built either using the contents of the perl source
1115 directory tree or from the installed perl library. The recommended way
1116 is to build extensions after you have run 'make install' on perl
1117 itself. You can do that in any directory on your hard disk that is not
1118 below the perl source tree. The support for extensions below the ext
1119 directory of the perl distribution is only good for the standard
1120 extensions that come with perl.
1122 If an extension is being built below the C<ext/> directory of the perl
1123 source then MakeMaker will set PERL_SRC automatically (e.g.,
1124 C<../..>). If PERL_SRC is defined and the extension is recognized as
1125 a standard extension, then other variables default to the following:
1128 PERL_LIB = PERL_SRC/lib
1129 PERL_ARCHLIB = PERL_SRC/lib
1131 INST_ARCHLIB = PERL_ARCHLIB
1133 If an extension is being built away from the perl source then MakeMaker
1134 will leave PERL_SRC undefined and default to using the installed copy
1135 of the perl library. The other variables default to the following:
1137 PERL_INC = $archlibexp/CORE
1138 PERL_LIB = $privlibexp
1139 PERL_ARCHLIB = $archlibexp
1140 INST_LIB = ./blib/lib
1141 INST_ARCHLIB = ./blib/arch
1143 If perl has not yet been installed then PERL_SRC can be defined on the
1144 command line as shown in the previous section.
1147 =head2 Which architecture dependent directory?
1149 If you don't want to keep the defaults for the INSTALL* macros,
1150 MakeMaker helps you to minimize the typing needed: the usual
1151 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1152 by Configure at perl compilation time. MakeMaker supports the user who
1153 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1154 then MakeMaker defaults the latter to be the same subdirectory of
1155 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1156 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1157 for INSTALLSITELIB and INSTALLSITEARCH.
1159 MakeMaker gives you much more freedom than needed to configure
1160 internal variables and get different results. It is worth to mention,
1161 that make(1) also lets you configure most of the variables that are
1162 used in the Makefile. But in the majority of situations this will not
1163 be necessary, and should only be done if the author of a package
1164 recommends it (or you know what you're doing).
1166 =head2 Using Attributes and Parameters
1168 The following attributes can be specified as arguments to WriteMakefile()
1169 or as NAME=VALUE pairs on the command line:
1175 One line description of the module. Will be included in PPD file.
1179 Name of the file that contains the package description. MakeMaker looks
1180 for a line in the POD matching /^($package\s-\s)(.*)/. This is typically
1181 the first line in the "=head1 NAME" section. $2 becomes the abstract.
1185 String containing name (and email address) of package author(s). Is used
1186 in PPD (Perl Package Description) files for PPM (Perl Package Manager).
1188 =item BINARY_LOCATION
1190 Used when creating PPD files for binary packages. It can be set to a
1191 full or relative path or URL to the binary archive for a particular
1192 architecture. For example:
1194 perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
1196 builds a PPD package that references a binary of the C<Agent> package,
1197 located in the C<x86> directory relative to the PPD itself.
1201 Ref to array of *.c file names. Initialised from a directory scan
1202 and the values portion of the XS attribute hash. This is not
1203 currently used by MakeMaker but may be handy in Makefile.PLs.
1207 [This attribute is obsolete in Perl 5.6. PERL_OBJECT builds are C-compatible
1210 Switch to force usage of the Perl C API even when compiling for PERL_OBJECT.
1212 Note that this attribute is passed through to any recursive build,
1213 but if and only if the submodule's Makefile.PL itself makes no mention
1214 of the 'CAPI' attribute.
1218 String that will be included in the compiler call command line between
1219 the arguments INC and OPTIMIZE.
1223 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1224 config.sh. MakeMaker will add to CONFIG the following values anyway:
1244 CODE reference. The subroutine should return a hash reference. The
1245 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1246 be determined by some evaluation method.
1250 Something like C<"-DHAVE_UNISTD_H">
1254 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1259 Your name for distributing the package (by tar file). This defaults to
1264 Hashref of symbol names for routines to be made available as universal
1265 symbols. Each key/value pair consists of the package name and an
1266 array of routine names in that package. Used only under AIX, OS/2,
1267 VMS and Win32 at present. The routine names supplied will be expanded
1268 in the same way as XSUB names are expanded by the XS() macro.
1271 {"$(NAME)" => ["boot_$(NAME)" ] }
1275 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1276 "NetconfigPtr" => [ 'DESTROY'] }
1278 Please see the L<ExtUtils::Mksymlists> documentation for more information
1279 about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
1283 Array of symbol names for variables to be made available as universal symbols.
1284 Used only under AIX, OS/2, VMS and Win32 at present. Defaults to [].
1285 (e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
1289 Array of extension names to exclude when doing a static build. This
1290 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1291 details. (e.g. [ qw( Socket POSIX ) ] )
1293 This attribute may be most useful when specified as a string on the
1294 command line: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1298 Ref to array of executable files. The files will be copied to the
1299 INST_SCRIPT directory. Make realclean will delete them from there
1302 =item FIRST_MAKEFILE
1304 The name of the Makefile to be produced. Defaults to the contents of
1305 MAKEFILE, but can be overridden. This is used for the second Makefile
1306 that will be produced for the MAP_TARGET.
1310 Perl binary able to run this extension.
1314 This provides an alternate means to specify function names to be
1315 exported from the extension. Its value is a reference to an
1316 array of function names to be exported by the extension. These
1317 names are passed through unaltered to the linker options file.
1321 Ref to array of *.h file names. Similar to C.
1325 Hashref of .pm and .pod files. MakeMaker will default this to all
1326 .pod and any .pm files that include POD directives. The files listed
1327 here will be converted to HTML format and installed as was requested
1330 =item HTMLSCRIPTPODS
1332 Hashref of pod-containing files. MakeMaker will default this to all
1333 EXE_FILES files that include POD directives. The files listed
1334 here will be converted to HTML format and installed as was requested
1339 This attribute is used to specify names to be imported into the
1340 extension. It is only used on OS/2 and Win32.
1344 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1348 Array of extension names to be included when doing a static build.
1349 MakeMaker will normally build with all of the installed extensions when
1350 doing a static build, and that is usually the desired behavior. If
1351 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1352 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1354 It is not necessary to mention DynaLoader or the current extension when
1355 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1356 only DynaLoader and the current extension will be included in the build.
1358 This attribute may be most useful when specified as a string on the
1359 command line: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1361 =item INSTALLARCHLIB
1363 Used by 'make install', which copies files from INST_ARCHLIB to this
1364 directory if INSTALLDIRS is set to perl.
1368 Directory to install binary files (e.g. tkperl) into.
1372 Determines which of the two sets of installation directories to
1373 choose: installprivlib and installarchlib versus installsitelib and
1374 installsitearch. The first pair is chosen with INSTALLDIRS=perl, the
1375 second with INSTALLDIRS=site. Default is site.
1377 =item INSTALLHTMLPRIVLIBDIR
1379 This directory gets the HTML pages at 'make install' time. Defaults to
1380 $Config{installhtmlprivlibdir}.
1382 =item INSTALLHTMLSCRIPTDIR
1384 This directory gets the HTML pages at 'make install' time. Defaults to
1385 $Config{installhtmlscriptdir}.
1387 =item INSTALLHTMLSITELIBDIR
1389 This directory gets the HTML pages at 'make install' time. Defaults to
1390 $Config{installhtmlsitelibdir}.
1393 =item INSTALLMAN1DIR
1395 This directory gets the man pages at 'make install' time. Defaults to
1396 $Config{installman1dir}.
1398 =item INSTALLMAN3DIR
1400 This directory gets the man pages at 'make install' time. Defaults to
1401 $Config{installman3dir}.
1403 =item INSTALLPRIVLIB
1405 Used by 'make install', which copies files from INST_LIB to this
1406 directory if INSTALLDIRS is set to perl.
1410 Used by 'make install' which copies files from INST_SCRIPT to this
1413 =item INSTALLSITEARCH
1415 Used by 'make install', which copies files from INST_ARCHLIB to this
1416 directory if INSTALLDIRS is set to site (default).
1418 =item INSTALLSITELIB
1420 Used by 'make install', which copies files from INST_LIB to this
1421 directory if INSTALLDIRS is set to site (default).
1425 Same as INST_LIB for architecture dependent files.
1429 Directory to put real binary files during 'make'. These will be copied
1430 to INSTALLBIN during 'make install'
1434 Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you
1437 =item INST_HTMLLIBDIR
1439 Directory to hold the man pages in HTML format at 'make' time
1441 =item INST_HTMLSCRIPTDIR
1443 Directory to hold the man pages in HTML format at 'make' time
1447 Directory where we put library files of this extension while building
1452 Directory to hold the man pages at 'make' time
1456 Directory to hold the man pages at 'make' time
1460 Directory, where executable files should be installed during
1461 'make'. Defaults to "./blib/script", just to have a dummy location during
1462 testing. make install will copy the files in INST_SCRIPT to
1467 defaults to "$(OBJECT)" and is used in the ld command to specify
1468 what files to link/load from (also see dynamic_lib below for how to
1473 LIB should only be set at C<perl Makefile.PL> time but is allowed as a
1474 MakeMaker argument. It has the effect of
1475 setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any
1476 explicit setting of those arguments (or of PREFIX).
1477 INSTALLARCHLIB and INSTALLSITEARCH are set to the corresponding
1478 architecture subdirectory.
1482 The filename of the perllibrary that will be used together with this
1483 extension. Defaults to libperl.a.
1487 An anonymous array of alternative library
1488 specifications to be searched for (in order) until
1489 at least one library is found. E.g.
1491 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1493 Mind, that any element of the array
1494 contains a complete set of arguments for the ld
1495 command. So do not specify
1497 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1499 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1500 you specify a scalar as in
1502 'LIBS' => "-ltcl -ltk -lX11"
1504 MakeMaker will turn it into an array with one element.
1508 'static' or 'dynamic' (default unless usedl=undef in
1509 config.sh). Should only be used to force static linking (also see
1514 Boolean which tells MakeMaker, that it should include the rules to
1515 make a perl. This is handled automatically as a switch by
1516 MakeMaker. The user normally does not need it.
1520 The name of the Makefile to be produced.
1524 Hashref of pod-containing files. MakeMaker will default this to all
1525 EXE_FILES files that include POD directives. The files listed
1526 here will be converted to man pages and installed as was requested
1531 Hashref that assigns to *.pm and *.pod files the files into which the
1532 manpages are to be written. MakeMaker parses all *.pod and *.pm files
1533 for POD directives. Files that contain POD will be the default keys of
1534 the MAN3PODS hashref. These will then be converted to man pages during
1535 C<make> and will be installed during C<make install>.
1539 If it is intended, that a new perl binary be produced, this variable
1540 may hold a name for that binary. Defaults to perl
1544 If the extension links to a library that it builds set this to the
1545 name of the library (see SDBM_File)
1549 Perl module name for this extension (DBD::Oracle). This will default
1550 to the directory name but should be explicitly defined in the
1555 MakeMaker will figure out if an extension contains linkable code
1556 anywhere down the directory tree, and will set this variable
1557 accordingly, but you can speed it up a very little bit if you define
1558 this boolean variable yourself.
1562 Defaults to C<@>. By setting it to an empty string you can generate a
1563 Makefile that echos all commands. Mainly used in debugging MakeMaker
1568 Boolean. Attribute to inhibit descending into subdirectories.
1572 In general, any generated Makefile checks for the current version of
1573 MakeMaker and the version the Makefile was built under. If NO_VC is
1574 set, the version check is neglected. Do not write this into your
1575 Makefile.PL, use it interactively instead.
1579 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1580 string containing all object files, e.g. "tkpBind.o
1581 tkpButton.o tkpCanvas.o"
1583 (Where BASEEXT is the last component of NAME, and OBJ_EXT is $Config{obj_ext}.)
1587 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1588 passed to subdirectory makes.
1592 Perl binary for tasks that can be done by miniperl
1596 The call to the program that is able to compile perlmain.c. Defaults
1601 Same as below, but for architecture dependent files.
1605 Directory containing the Perl library to use.
1607 =item PERL_MALLOC_OK
1609 defaults to 0. Should be set to TRUE if the extension can work with
1610 the memory allocation routines substituted by the Perl malloc() subsystem.
1611 This should be applicable to most extensions with exceptions of those
1617 with bugs in memory allocations which are caught by Perl's malloc();
1621 which interact with the memory allocator in other ways than via
1622 malloc(), realloc(), free(), calloc(), sbrk() and brk();
1626 which rely on special alignment which is not provided by Perl's malloc().
1630 B<NOTE.> Negligence to set this flag in I<any one> of loaded extension
1631 nullifies many advantages of Perl's malloc(), such as better usage of
1632 system resources, error detection, memory usage reporting, catchable failure
1633 of memory allocations, etc.
1637 Directory containing the Perl source code (use of this should be
1638 avoided, it may be undefined)
1642 Desired permission for read/writable files. Defaults to C<644>.
1643 See also L<MM_Unix/perm_rw>.
1647 Desired permission for executable files. Defaults to C<755>.
1648 See also L<MM_Unix/perm_rwx>.
1652 Ref to hash of files to be processed as perl programs. MakeMaker
1653 will default to any found *.PL file (except Makefile.PL) being keys
1654 and the basename of the file being the value. E.g.
1656 {'foobar.PL' => 'foobar'}
1658 The *.PL files are expected to produce output to the target files
1659 themselves. If multiple files can be generated from the same *.PL
1660 file then the value in the hash can be a reference to an array of
1661 target file names. E.g.
1663 {'foobar.PL' => ['foobar1','foobar2']}
1667 Hashref of .pm files and *.pl files to be installed. e.g.
1669 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1671 By default this will include *.pm and *.pl and the files found in
1672 the PMLIBDIRS directories. Defining PM in the
1673 Makefile.PL will override PMLIBDIRS.
1677 Ref to array of subdirectories containing library files. Defaults to
1678 [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
1679 they contain will be installed in the corresponding location in the
1680 library. A libscan() method can be used to alter the behaviour.
1681 Defining PM in the Makefile.PL will override PMLIBDIRS.
1683 (Where BASEEXT is the last component of NAME.)
1687 A filter program, in the traditional Unix sense (input from stdin, output
1688 to stdout) that is passed on each .pm file during the build (in the
1689 pm_to_blib() phase). It is empty by default, meaning no filtering is done.
1691 Great care is necessary when defining the command if quoting needs to be
1692 done. For instance, you would need to say:
1694 {'PM_FILTER' => 'grep -v \\"^\\#\\"'}
1696 to remove all the leading coments on the fly during the build. The
1697 extra \\ are necessary, unfortunately, because this variable is interpolated
1698 within the context of a Perl program built on the command line, and double
1699 quotes are what is used with the -e switch to build that command line. The
1700 # is escaped for the Makefile, since what is going to be generated will then
1703 PM_FILTER = grep -v \"^\#\"
1705 Without the \\ before the #, we'd have the start of a Makefile comment,
1706 and the macro would be incorrectly defined.
1710 Release 5.005 grandfathered old global symbol names by providing preprocessor
1711 macros for extension source compatibility. As of release 5.6, these
1712 preprocessor definitions are not available by default. The POLLUTE flag
1713 specifies that the old names should still be defined:
1715 perl Makefile.PL POLLUTE=1
1717 Please inform the module author if this is necessary to successfully install
1718 a module under 5.6 or later.
1720 =item PPM_INSTALL_EXEC
1722 Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl)
1724 =item PPM_INSTALL_SCRIPT
1726 Name of the script that gets executed by the Perl Package Manager after
1727 the installation of a package.
1731 Can be used to set the three INSTALL* attributes in one go (except for
1732 probably INSTALLMAN1DIR, if it is not below PREFIX according to
1733 %Config). They will have PREFIX as a common directory node and will
1734 branch from that node into lib/, lib/ARCHNAME or whatever Configure
1735 decided at the build time of your perl (unless you override one of
1740 Hashref: Names of modules that need to be available to run this
1741 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1742 desired version is the value. If the required version number is 0, we
1743 only check if any version is installed already.
1747 Arryref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1748 Makefile. Caution! Do not use the SKIP attribute for the negligible
1749 speedup. It may seriously damage the resulting Makefile. Only use it
1750 if you really need it.
1754 Ref to array of typemap file names. Use this when the typemaps are
1755 in some directory other than the current directory or when they are
1756 not named B<typemap>. The last typemap in the list takes
1757 precedence. A typemap in the current directory has highest
1758 precedence, even if it isn't listed in TYPEMAPS. The default system
1759 typemap has lowest precedence.
1763 Your version number for distributing the package. This defaults to
1768 Instead of specifying the VERSION in the Makefile.PL you can let
1769 MakeMaker parse a file to determine the version number. The parsing
1770 routine requires that the file named by VERSION_FROM contains one
1771 single line to compute the version number. The first line in the file
1772 that contains the regular expression
1774 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
1776 will be evaluated with eval() and the value of the named variable
1777 B<after> the eval() will be assigned to the VERSION attribute of the
1778 MakeMaker object. The following lines will be parsed o.k.:
1782 ( $VERSION ) = '$Revision: 1.222 $ ' =~ /\$Revision:\s+([^\s]+)/;
1783 $FOO::VERSION = '1.10';
1784 *FOO::VERSION = \'1.11';
1785 our $VERSION = 1.2.3; # new for perl5.6.0
1787 but these will fail:
1789 my $VERSION = '1.01';
1790 local $VERSION = '1.02';
1791 local $FOO::VERSION = '1.30';
1793 (Putting C<my> or C<local> on the preceding line will work o.k.)
1795 The file named in VERSION_FROM is not added as a dependency to
1796 Makefile. This is not really correct, but it would be a major pain
1797 during development to have to rewrite the Makefile for any smallish
1798 change in that file. If you want to make sure that the Makefile
1799 contains the correct VERSION macro after any change of the file, you
1800 would have to do something like
1802 depend => { Makefile => '$(VERSION_FROM)' }
1804 See attribute C<depend> below.
1808 Hashref of .xs files. MakeMaker will default this. e.g.
1810 {'name_of_file.xs' => 'name_of_file.c'}
1812 The .c files will automatically be included in the list of files
1813 deleted by a make clean.
1817 String of options to pass to xsubpp. This might include C<-C++> or
1818 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
1823 May be set to an empty string, which is identical to C<-prototypes>, or
1824 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
1825 defaults to the empty string.
1829 Your version number for the .xs file of this package. This defaults
1830 to the value of the VERSION attribute.
1834 =head2 Additional lowercase attributes
1836 can be used to pass parameters to the methods which implement that
1837 part of the Makefile.
1843 {FILES => "*.xyz foo"}
1847 {ANY_TARGET => ANY_DEPENDECY, ...}
1849 (ANY_TARGET must not be given a double-colon rule by MakeMaker.)
1853 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
1854 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
1855 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
1857 If you specify COMPRESS, then SUFFIX should also be altered, as it is
1858 needed to tell make the target file of the compression. Setting
1859 DIST_CP to ln can be useful, if you need to preserve the timestamps on
1860 your files. DIST_CP can take the values 'cp', which copies the file,
1861 'ln', which links the file, and 'best' which copies symbolic links and
1862 links the rest. Default is 'best'.
1866 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
1870 {LINKTYPE => 'static', 'dynamic' or ''}
1872 NB: Extensions that have nothing but *.pm files had to say
1876 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1877 can be deleted safely. MakeMaker recognizes when there's nothing to
1882 {ANY_MACRO => ANY_VALUE, ...}
1886 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
1892 =item tool_autosplit
1898 =head2 Overriding MakeMaker Methods
1900 If you cannot achieve the desired Makefile behaviour by specifying
1901 attributes you may define private subroutines in the Makefile.PL.
1902 Each subroutines returns the text it wishes to have written to
1903 the Makefile. To override a section of the Makefile you can
1906 sub MY::c_o { "new literal text" }
1908 or you can edit the default by saying something like:
1911 package MY; # so that "SUPER" works right
1912 my $inherited = shift->SUPER::c_o(@_);
1913 $inherited =~ s/old text/new text/;
1917 If you are running experiments with embedding perl as a library into
1918 other applications, you might find MakeMaker is not sufficient. You'd
1919 better have a look at ExtUtils::Embed which is a collection of utilities
1922 If you still need a different solution, try to develop another
1923 subroutine that fits your needs and submit the diffs to
1924 F<perl5-porters@perl.org> or F<comp.lang.perl.moderated> as appropriate.
1926 For a complete description of all MakeMaker methods see L<ExtUtils::MM_Unix>.
1928 Here is a simple example of how to add a new target to the generated
1933 $(MYEXTLIB): sdbm/Makefile
1934 cd sdbm && $(MAKE) all
1939 =head2 Hintsfile support
1941 MakeMaker.pm uses the architecture specific information from
1942 Config.pm. In addition it evaluates architecture specific hints files
1943 in a C<hints/> directory. The hints files are expected to be named
1944 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
1945 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
1946 MakeMaker within the WriteMakefile() subroutine, and can be used to
1947 execute commands as well as to include special variables. The rules
1948 which hintsfile is chosen are the same as in Configure.
1950 The hintsfile is eval()ed immediately after the arguments given to
1951 WriteMakefile are stuffed into a hash reference $self but before this
1952 reference becomes blessed. So if you want to do the equivalent to
1953 override or create an attribute you would say something like
1955 $self->{LIBS} = ['-ldbm -lucb -lc'];
1957 =head2 Distribution Support
1959 For authors of extensions MakeMaker provides several Makefile
1960 targets. Most of the support comes from the ExtUtils::Manifest module,
1961 where additional documentation can be found.
1965 =item make distcheck
1967 reports which files are below the build directory but not in the
1968 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
1971 =item make skipcheck
1973 reports which files are skipped due to the entries in the
1974 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
1977 =item make distclean
1979 does a realclean first and then the distcheck. Note that this is not
1980 needed to build a new distribution as long as you are sure that the
1981 MANIFEST file is ok.
1985 rewrites the MANIFEST file, adding all remaining files found (See
1986 ExtUtils::Manifest::mkmanifest() for details)
1990 Copies all the files that are in the MANIFEST file to a newly created
1991 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
1992 exists, it will be removed first.
1996 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
1997 a make test in that directory.
2001 First does a distdir. Then a command $(PREOP) which defaults to a null
2002 command, followed by $(TOUNIX), which defaults to a null command under
2003 UNIX, and will convert files in distribution directory to UNIX format
2004 otherwise. Next it runs C<tar> on that directory into a tarfile and
2005 deletes the directory. Finishes with a command $(POSTOP) which
2006 defaults to a null command.
2010 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
2012 =item make uutardist
2014 Runs a tardist first and uuencodes the tarfile.
2018 First does a distdir. Then a command $(PREOP) which defaults to a null
2019 command. Next it runs C<shar> on that directory into a sharfile and
2020 deletes the intermediate directory again. Finishes with a command
2021 $(POSTOP) which defaults to a null command. Note: For shdist to work
2022 properly a C<shar> program that can handle directories is mandatory.
2026 First does a distdir. Then a command $(PREOP) which defaults to a null
2027 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
2028 zipfile. Then deletes that directory. Finishes with a command
2029 $(POSTOP) which defaults to a null command.
2033 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
2037 Customization of the dist targets can be done by specifying a hash
2038 reference to the dist attribute of the WriteMakefile call. The
2039 following parameters are recognized:
2042 COMPRESS ('gzip --best')
2045 TO_UNIX (depends on the system)
2046 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
2056 WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" })
2058 =head2 Disabling an extension
2060 If some events detected in F<Makefile.PL> imply that there is no way
2061 to create the Module, but this is a normal state of things, then you
2062 can create a F<Makefile> which does nothing, but succeeds on all the
2063 "usual" build targets. To do so, use
2065 ExtUtils::MakeMaker::WriteEmptyMakefile();
2067 instead of WriteMakefile().
2069 This may be useful if other modules expect this module to be I<built>
2070 OK, as opposed to I<work> OK (say, this system-dependent module builds
2071 in a subdirectory of some other distribution, or is listed as a
2072 dependency in a CPAN::Bundle, but the functionality is supported by
2073 different means on the current architecture).
2081 Command line options used by C<MakeMaker-E<gt>new()>, and thus by
2082 C<WriteMakefile()>. The string is split on whitespace, and the result
2083 is processed before any actual command line arguments are processed.
2089 ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib,
2090 ExtUtils::Install, ExtUtils::Embed
2094 Andy Dougherty <F<doughera@lafcol.lafayette.edu>>, Andreas KE<ouml>nig
2095 <F<andreas.koenig@mind.de>>, Tim Bunce <F<Tim.Bunce@ig.co.uk>>. VMS
2096 support by Charles Bailey <F<bailey@newman.upenn.edu>>. OS/2 support
2097 by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>.
2099 Send patches and bug reports to <F<perlbug@perl.org>>.