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 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;
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';
75 require ExtUtils::MM_Unix;
78 require ExtUtils::MM_VMS;
79 require VMS::Filespec; # is a noop as long as we require it within MM_VMS
82 require ExtUtils::MM_OS2;
85 require ExtUtils::MM_Mac;
88 require ExtUtils::MM_Win32;
91 require ExtUtils::MM_Cygwin;
96 # The use of the Version_check target has been dropped between perl
97 # 5.5.63 and 5.5.64. We must keep the subroutine for a while so that
98 # old Makefiles can satisfy the Version_check target.
101 my($checkversion) = @_;
102 die "Your Makefile was built with ExtUtils::MakeMaker v $checkversion.
103 Current Version is $ExtUtils::MakeMaker::VERSION. There have been considerable
104 changes in the meantime.
105 Please rerun 'perl Makefile.PL' to regenerate the Makefile.\n"
106 if $checkversion < $Version_OK;
107 printf STDOUT "%s %s %s %s.\n", "Makefile built with ExtUtils::MakeMaker v",
108 $checkversion, "Current Version is", $VERSION
109 unless $checkversion == $VERSION;
113 $_[0] =~ /^Use of uninitialized value/ && return;
114 $_[0] =~ /used only once/ && return;
115 $_[0] =~ /^Subroutine\s+[\w:]+\s+redefined/ && return;
120 Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
121 local $SIG{__WARN__} = \&warnhandler;
124 MM->new(\%att)->flush;
129 $ISA_TTY = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ; # Pipe?
130 Carp::confess("prompt function called without an argument") unless defined $mess;
131 my $dispdef = defined $def ? "[$def] " : " ";
132 $def = defined $def ? $def : "";
135 print "$mess $dispdef";
137 chomp($ans = <STDIN>);
141 return ($ans ne '') ? $ans : $def;
144 sub eval_in_subdirs {
150 foreach $dir (@{$self->{DIR}}){
151 my($abs) = $self->catdir($pwd,$dir);
152 $self->eval_in_x($abs);
160 chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
162 # my $fh = new FileHandle;
163 # $fh->open("Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
165 open(FH,"Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
166 # my $eval = join "", <$fh>;
167 my $eval = join "", <FH>;
172 # if ($@ =~ /prerequisites/) {
173 # die "MakeMaker WARNING: $@";
175 # warn "WARNING from evaluation of $dir/Makefile.PL: $@";
177 warn "WARNING from evaluation of $dir/Makefile.PL: $@";
184 # package name for the classes into which the first object will be blessed
185 $PACKNAME = "PACK000";
189 AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION
190 C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
191 EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE FULLPERL FUNCLIST H
192 HTMLLIBPODS HTMLSCRIPTPOD IMPORTS
193 INC INCLUDE_EXT INSTALLARCHLIB INSTALLBIN INSTALLDIRS INSTALLHTMLPRIVLIBDIR
194 INSTALLHTMLSCRIPTDIR INSTALLHTMLSITELIBDIR INSTALLMAN1DIR
195 INSTALLMAN3DIR INSTALLPRIVLIB INSTALLSCRIPT INSTALLSITEARCH
196 INSTALLSITELIB INST_ARCHLIB INST_BIN INST_EXE INST_LIB
197 INST_HTMLLIBDIR INST_HTMLSCRIPTDIR
198 INST_MAN1DIR INST_MAN3DIR INST_SCRIPT LDFROM LIB LIBPERL_A LIBS
199 LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB
201 NAME NEEDS_LINKING NOECHO NORECURS NO_VC OBJECT OPTIMIZE PERL PERLMAINCC
202 PERL_ARCHLIB PERL_LIB PERL_SRC PERM_RW PERM_RWX
203 PL_FILES PM PMLIBDIRS POLLUTE PPM_INSTALL_EXEC PPM_INSTALL_SCRIPT PREFIX
204 PREREQ_PM SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
205 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
209 # IMPORTS is used under OS/2 and Win32
211 # @Overridable is close to @MM_Sections but not identical. The
212 # order is important. Many subroutines declare macros. These
213 # depend on each other. Let's try to collect the macros up front,
214 # then pasthru, then the rules.
216 # MM_Sections are the sections we have to call explicitly
217 # in Overridable we have subroutines that are used indirectly
223 post_initialize const_config constants tool_autosplit tool_xsubpp
224 tools_other dist macro depend cflags const_loadlibs const_cccmd
229 c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs
230 dynamic_lib static static_lib htmlifypods manifypods processPL
232 clean realclean dist_basics dist_core dist_dir dist_test dist_ci
233 install force perldepend makefile staticmake test ppd
235 ); # loses section ordering
237 @Overridable = @MM_Sections;
238 push @Overridable, qw[
240 dir_target libscan makeaperl needs_linking perm_rw perm_rwx
241 subdir_x test_via_harness test_via_script
245 push @MM_Sections, qw[
247 pm_to_blib selfdocument
251 # Postamble needs to be the last that was always the case
252 push @MM_Sections, "postamble";
253 push @Overridable, "postamble";
255 # All sections are valid keys.
256 @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
258 # we will use all these variables in the Makefile
261 ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc
262 lib_ext obj_ext osname osvers ranlib sitelibexp sitearchexp so exe_ext
266 foreach $item (@Attrib_help){
267 $Recognized_Att_Keys{$item} = 1;
269 foreach $item (@Get_from_Config) {
270 $Recognized_Att_Keys{uc $item} = $Config{$item};
271 print "Attribute '\U$item\E' => '$Config{$item}'\n"
276 # When we eval a Makefile.PL in a subdirectory, that one will ask
277 # us (the parent) for the values and will prepend "..", so that
278 # all files to be installed end up below OUR ./blib
283 INST_BIN 1 INST_EXE 1 INST_LIB 1 INST_ARCHLIB 1 INST_SCRIPT 1
284 MAP_TARGET 1 INST_HTMLLIBDIR 1 INST_HTMLSCRIPTDIR 1
285 INST_MAN1DIR 1 INST_MAN3DIR 1 PERL_SRC 1 PERL 1 FULLPERL 1
290 NEEDS_LINKING HAS_LINK_CODE
292 @Keep_after_flush{@keep} = (1) x @keep;
298 The extension you are trying to build apparently is rather old and
299 most probably outdated. We detect that from the fact, that a
300 subroutine "writeMakefile" is called, and this subroutine is not
301 supported anymore since about October 1994.
303 Please contact the author or look into CPAN (details about CPAN can be
304 found in the FAQ and at http:/www.perl.com) for a more recent version
305 of the extension. If you're really desperate, you can try to change
306 the subroutine name from writeMakefile to WriteMakefile and rerun
307 'perl Makefile.PL', but you're most probably left alone, when you do
315 sub ExtUtils::MakeMaker::new {
316 my($class,$self) = @_;
319 print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
320 if (-f "MANIFEST" && ! -f "Makefile"){
324 $self = {} unless (defined $self);
328 my(%initial_att) = %$self; # record initial attributes
331 foreach $prereq (sort keys %{$self->{PREREQ_PM}}) {
332 my $eval = "require $prereq";
336 warn "Warning: prerequisite $prereq failed to load: $@";
338 elsif ($prereq->VERSION < $self->{PREREQ_PM}->{$prereq} ){
339 warn "Warning: prerequisite $prereq $self->{PREREQ_PM}->{$prereq} not found";
340 # Why is/was this 'delete' here? We need PREREQ_PM later to make PPDs.
342 # delete $self->{PREREQ_PM}{$prereq};
346 # unless (defined $ExtUtils::MakeMaker::useCPAN) {
347 # print qq{MakeMaker WARNING: prerequisites not found (@unsatisfied)
348 # Please install these modules first and rerun 'perl Makefile.PL'.\n};
349 # if ($ExtUtils::MakeMaker::hasCPAN) {
350 # $ExtUtils::MakeMaker::useCPAN = prompt(qq{Should I try to use the CPAN module to fetch them for you?},"yes");
352 # print qq{Hint: You may want to install the CPAN module to autofetch the needed modules\n};
353 # $ExtUtils::MakeMaker::useCPAN=0;
356 # if ($ExtUtils::MakeMaker::useCPAN) {
358 # CPAN->import(@unsatisfied);
360 # die qq{prerequisites not found (@unsatisfied)};
362 # warn qq{WARNING: prerequisites not found (@unsatisfied)};
365 if (defined $self->{CONFIGURE}) {
366 if (ref $self->{CONFIGURE} eq 'CODE') {
367 $self = { %$self, %{&{$self->{CONFIGURE}}}};
369 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
373 # This is for old Makefiles written pre 5.00, will go away
374 if ( Carp::longmess("") =~ /runsubdirpl/s ){
375 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
378 my $newclass = ++$PACKNAME;
379 local @Parent = @Parent; # Protect against non-local exits
382 print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
383 mv_all_methods("MY",$newclass);
384 bless $self, $newclass;
386 @{"$newclass\:\:ISA"} = 'MM';
389 if (defined $Parent[-2]){
390 $self->{PARENT} = $Parent[-2];
392 for $key (keys %Prepend_dot_dot) {
393 next unless defined $self->{PARENT}{$key};
394 $self->{$key} = $self->{PARENT}{$key};
395 # PERL and FULLPERL may be command verbs instead of full
396 # file specifications under VMS. If so, don't turn them
398 $self->{$key} = $self->catdir("..",$self->{$key})
399 unless $self->file_name_is_absolute($self->{$key})
400 || ($^O eq 'VMS' and ($key =~ /PERL$/ && $self->{$key} =~ /^[\w\-\$]+$/));
402 if ($self->{PARENT}) {
403 $self->{PARENT}->{CHILDREN}->{$newclass} = $self;
404 foreach my $opt (qw(CAPI POLLUTE)) {
405 if (exists $self->{PARENT}->{$opt}
406 and not exists $self->{$opt})
408 # inherit, but only if already unspecified
409 $self->{$opt} = $self->{PARENT}->{$opt};
414 parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV);
417 $self->{NAME} ||= $self->guess_name;
419 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
423 if (! $self->{PERL_SRC} ) {
424 my($pthinks) = $self->canonpath($INC{'Config.pm'});
425 my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
426 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
427 if ($pthinks ne $cthinks &&
428 !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
429 print "Have $pthinks expected $cthinks\n";
431 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
434 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
436 print STDOUT <<END unless $self->{UNINSTALLED_PERL};
437 Your perl and your Config.pm seem to have different ideas about the architecture
439 Perl thinks: [$pthinks]
440 Config says: [$Config{archname}]
441 This may or may not cause problems. Please check your installation of perl if you
442 have problems building this extension.
447 $self->init_dirscan();
448 $self->init_others();
449 my($argv) = neatvalue(\@ARGV);
453 push @{$self->{RESULT}}, <<END;
454 # This Makefile is for the $self->{NAME} extension to perl.
456 # It was generated automatically by MakeMaker version
457 # $VERSION (Revision: $Revision) from the contents of
458 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
460 # ANY CHANGES MADE HERE WILL BE LOST!
462 # MakeMaker ARGV: $argv
464 # MakeMaker Parameters:
467 foreach $key (sort keys %initial_att){
468 my($v) = neatvalue($initial_att{$key});
469 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
471 push @{$self->{RESULT}}, "# $key => $v";
474 # turn the SKIP array into a SKIPHASH hash
476 for $skip (@{$self->{SKIP} || []}) {
477 $self->{SKIPHASH}{$skip} = 1;
479 delete $self->{SKIP}; # free memory
481 if ($self->{PARENT}) {
482 for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
483 $self->{SKIPHASH}{$_} = 1;
487 # We run all the subdirectories now. They don't have much to query
488 # from the parent, but the parent has to query them: if they need linking!
489 unless ($self->{NORECURS}) {
490 $self->eval_in_subdirs if @{$self->{DIR}};
494 foreach $section ( @MM_Sections ){
495 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
496 my($skipit) = $self->skipcheck($section);
498 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
500 my(%a) = %{$self->{$section} || {}};
501 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
502 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
503 push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
507 push @{$self->{RESULT}}, "\n# End.";
512 sub WriteEmptyMakefile {
513 if (-f 'Makefile.old') {
514 chmod 0666, 'Makefile.old';
515 unlink 'Makefile.old' or warn "unlink Makefile.old: $!";
517 rename 'Makefile', 'Makefile.old' or warn "rename Makefile Makefile.old: $!"
519 open MF, '> Makefile' or die "open Makefile for write: $!";
532 close MF or die "close Makefile for write: $!";
536 print STDOUT "Checking if your kit is complete...\n";
537 require ExtUtils::Manifest;
538 $ExtUtils::Manifest::Quiet=$ExtUtils::Manifest::Quiet=1; #avoid warning
539 my(@missed)=ExtUtils::Manifest::manicheck();
541 print STDOUT "Warning: the following files are missing in your kit:\n";
542 print "\t", join "\n\t", @missed;
544 print STDOUT "Please inform the author.\n";
546 print STDOUT "Looks good\n";
551 my($self, @args) = @_;
553 unless (m/(.*?)=(.*)/){
554 help(),exit 1 if m/^help$/;
555 ++$Verbose if m/^verb/;
558 my($name, $value) = ($1, $2);
559 if ($value =~ m/^~(\w+)?/){ # tilde with optional username
560 $value =~ s [^~(\w*)]
562 ((getpwnam($1))[7] || "~$1") :
566 $self->{uc($name)} = $value;
569 # catch old-style 'potential_libs' and inform user how to 'upgrade'
570 if (defined $self->{potential_libs}){
571 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
572 if ($self->{potential_libs}){
573 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
575 print STDOUT "$msg deleted.\n";
577 $self->{LIBS} = [$self->{potential_libs}];
578 delete $self->{potential_libs};
580 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
581 if (defined $self->{ARMAYBE}){
582 my($armaybe) = $self->{ARMAYBE};
583 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
584 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
585 my(%dl) = %{$self->{dynamic_lib} || {}};
586 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
587 delete $self->{ARMAYBE};
589 if (defined $self->{LDTARGET}){
590 print STDOUT "LDTARGET should be changed to LDFROM\n";
591 $self->{LDFROM} = $self->{LDTARGET};
592 delete $self->{LDTARGET};
594 # Turn a DIR argument on the command line into an array
595 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
596 # So they can choose from the command line, which extensions they want
597 # the grep enables them to have some colons too much in case they
598 # have to build a list with the shell
599 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
601 # Turn a INCLUDE_EXT argument on the command line into an array
602 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
603 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
605 # Turn a EXCLUDE_EXT argument on the command line into an array
606 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
607 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
610 foreach $mmkey (sort keys %$self){
611 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
612 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
613 unless exists $Recognized_Att_Keys{$mmkey};
620 # We allow extension-specific hints files.
622 return unless -d "hints";
624 # First we look for the best hintsfile we have
626 my($hint)="${^O}_$Config{osvers}";
631 # Also try without trailing minor version numbers.
633 last if -f "hints/$hint.pl"; # found
635 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
637 return unless -f "hints/$hint.pl"; # really there
639 # execute the hintsfile:
641 # my $fh = new FileHandle;
642 # $fh->open("hints/$hint.pl");
644 open(FH,"hints/$hint.pl");
645 # @goodhints = <$fh>;
649 print STDOUT "Processing hints file hints/$hint.pl\n";
650 eval join('',@goodhints);
651 print STDOUT $@ if $@;
657 my($symtab) = \%{"${from}::"};
660 # Here you see the *current* list of methods that are overridable
661 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
662 # still trying to reduce the list to some reasonable minimum --
663 # because I want to make it easier for the user. A.K.
665 foreach $method (@Overridable) {
667 # We cannot say "next" here. Nick might call MY->makeaperl
668 # which isn't defined right now
670 # Above statement was written at 4.23 time when Tk-b8 was
671 # around. As Tk-b9 only builds with 5.002something and MM 5 is
672 # standard, we try to enable the next line again. It was
673 # commented out until MM 5.23
675 next unless defined &{"${from}::$method"};
677 *{"${to}::$method"} = \&{"${from}::$method"};
679 # delete would do, if we were sure, nobody ever called
680 # MY->makeaperl directly
682 # delete $symtab->{$method};
684 # If we delete a method, then it will be undefined and cannot
685 # be called. But as long as we have Makefile.PLs that rely on
686 # %MY:: being intact, we have to fill the hole with an
689 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
692 # We have to clean out %INC also, because the current directory is
693 # changed frequently and Graham Barr prefers to get his version
694 # out of a History.pl file which is "required" so woudn't get
695 # loaded again in another extension requiring a History.pl
697 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
698 # to core dump in the middle of a require statement. The required
699 # file was Tk/MMutil.pm. The consequence is, we have to be
700 # extremely careful when we try to give perl a reason to reload a
701 # library with same name. The workaround prefers to drop nothing
702 # from %INC and teach the writers not to use such libraries.
705 # foreach $inc (keys %INC) {
706 # #warn "***$inc*** deleted";
714 if ($section eq 'dynamic') {
715 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
716 "in skipped section 'dynamic_bs'\n"
717 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
718 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
719 "in skipped section 'dynamic_lib'\n"
720 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
722 if ($section eq 'dynamic_lib') {
723 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
724 "targets in skipped section 'dynamic_bs'\n"
725 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
727 if ($section eq 'static') {
728 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
729 "in skipped section 'static_lib'\n"
730 if $self->{SKIPHASH}{static_lib} && $Verbose;
732 return 'skipped' if $self->{SKIPHASH}{$section};
740 # my $fh = new FileHandle;
742 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
744 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
745 # $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
746 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
748 for $chunk (@{$self->{RESULT}}) {
749 # print $fh "$chunk\n";
755 my($finalname) = $self->{MAKEFILE};
756 rename("MakeMaker.tmp", $finalname);
757 chmod 0644, $finalname unless $Is_VMS;
759 if ($self->{PARENT}) {
760 foreach (keys %$self) { # safe memory
761 delete $self->{$_} unless $Keep_after_flush{$_};
765 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
768 # The following mkbootstrap() is only for installations that are calling
769 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
770 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
773 !!! Your Makefile has been built such a long time ago, !!!
774 !!! that is unlikely to work with current MakeMaker. !!!
775 !!! Please rebuild your Makefile !!!
779 # Ditto for mksymlists() as of MakeMaker 5.17
782 !!! Your Makefile has been built such a long time ago, !!!
783 !!! that is unlikely to work with current MakeMaker. !!!
784 !!! Please rebuild your Makefile !!!
790 return "undef" unless defined $v;
792 return "q[$v]" unless $t;
794 my(@m, $elem, @neat);
796 foreach $elem (@$v) {
797 push @neat, "q[$elem]";
799 push @m, join ", ", @neat;
803 return "$v" unless $t eq 'HASH';
805 while (($key,$val) = each %$v){
806 last unless defined $key; # cautious programming in case (undef,undef) is true
807 push(@m,"$key=>".neatvalue($val)) ;
809 return "{ ".join(', ',@m)." }";
816 push @m, "\n# Full list of MakeMaker attribute values:";
817 foreach $key (sort keys %$self){
818 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
819 my($v) = neatvalue($self->{$key});
820 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
822 push @m, "# $key => $v";
828 package ExtUtils::MakeMaker;
835 ExtUtils::MakeMaker - create an extension Makefile
839 C<use ExtUtils::MakeMaker;>
841 C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
845 C<MM-E<gt>new(\%att)-E<gt>flush;>
849 This utility is designed to write a Makefile for an extension module
850 from a Makefile.PL. It is based on the Makefile.SH model provided by
851 Andy Dougherty and the perl5-porters.
853 It splits the task of generating the Makefile into several subroutines
854 that can be individually overridden. Each subroutine returns the text
855 it wishes to have written to the Makefile.
857 MakeMaker is object oriented. Each directory below the current
858 directory that contains a Makefile.PL. Is treated as a separate
859 object. This makes it possible to write an unlimited number of
860 Makefiles with a single invocation of WriteMakefile().
862 =head2 How To Write A Makefile.PL
864 The short answer is: Don't.
866 Always begin with h2xs.
867 Always begin with h2xs!
868 ALWAYS BEGIN WITH H2XS!
870 even if you're not building around a header file, and even if you
871 don't have an XS component.
873 Run h2xs(1) before you start thinking about writing a module. For so
874 called pm-only modules that consist of C<*.pm> files only, h2xs has
875 the C<-X> switch. This will generate dummy files of all kinds that are
876 useful for the module developer.
878 The medium answer is:
880 use ExtUtils::MakeMaker;
881 WriteMakefile( NAME => "Foo::Bar" );
883 The long answer is the rest of the manpage :-)
885 =head2 Default Makefile Behaviour
887 The generated Makefile enables the user of the extension to invoke
889 perl Makefile.PL # optionally "perl Makefile.PL verbose"
891 make test # optionally set TEST_VERBOSE=1
892 make install # See below
894 The Makefile to be produced may be altered by adding arguments of the
895 form C<KEY=VALUE>. E.g.
897 perl Makefile.PL PREFIX=/tmp/myperl5
899 Other interesting targets in the generated Makefile are
901 make config # to check if the Makefile is up-to-date
902 make clean # delete local temp files (Makefile gets renamed)
903 make realclean # delete derived files (including ./blib)
904 make ci # check in all the files in the MANIFEST file
905 make dist # see below the Distribution Support section
909 MakeMaker checks for the existence of a file named F<test.pl> in the
910 current directory and if it exists it adds commands to the test target
911 of the generated Makefile that will execute the script with the proper
912 set of perl C<-I> options.
914 MakeMaker also checks for any files matching glob("t/*.t"). It will
915 add commands to the test target of the generated Makefile that execute
916 all matching files via the L<Test::Harness> module with the C<-I>
917 switches set correctly.
921 A useful variation of the above is the target C<testdb>. It runs the
922 test under the Perl debugger (see L<perldebug>). If the file
923 F<test.pl> exists in the current directory, it is used for the test.
925 If you want to debug some other testfile, set C<TEST_FILE> variable
928 make testdb TEST_FILE=t/mytest.t
930 By default the debugger is called using C<-d> option to perl. If you
931 want to specify some other option, set C<TESTDB_SW> variable:
933 make testdb TESTDB_SW=-Dx
937 make alone puts all relevant files into directories that are named by
938 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_HTMLLIBDIR,
939 INST_HTMLSCRIPTDIR, INST_MAN1DIR, and INST_MAN3DIR. All these default
940 to something below ./blib if you are I<not> building below the perl
941 source directory. If you I<are> building below the perl source,
942 INST_LIB and INST_ARCHLIB default to ../../lib, and INST_SCRIPT is not
945 The I<install> target of the generated Makefile copies the files found
946 below each of the INST_* directories to their INSTALL*
947 counterparts. Which counterparts are chosen depends on the setting of
948 INSTALLDIRS according to the following table:
953 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH
954 INST_LIB INSTALLPRIVLIB INSTALLSITELIB
955 INST_HTMLLIBDIR INSTALLHTMLPRIVLIBDIR INSTALLHTMLSITELIBDIR
956 INST_HTMLSCRIPTDIR INSTALLHTMLSCRIPTDIR
958 INST_SCRIPT INSTALLSCRIPT
959 INST_MAN1DIR INSTALLMAN1DIR
960 INST_MAN3DIR INSTALLMAN3DIR
962 The INSTALL... macros in turn default to their %Config
963 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
965 You can check the values of these variables on your system with
969 And to check the sequence in which the library directories are
970 searched by perl, run
972 perl -le 'print join $/, @INC'
975 =head2 PREFIX and LIB attribute
977 PREFIX and LIB can be used to set several INSTALL* attributes in one
978 go. The quickest way to install a module in a non-standard place might
981 perl Makefile.PL LIB=~/lib
983 This will install the module's architecture-independent files into
984 ~/lib, the architecture-dependent files into ~/lib/$archname/auto.
986 Another way to specify many INSTALL directories with a single
989 perl Makefile.PL PREFIX=~
991 This will replace the string specified by $Config{prefix} in all
992 $Config{install*} values.
994 Note, that in both cases the tilde expansion is done by MakeMaker, not
995 by perl by default, nor by make. Conflicts between parameters LIB,
996 PREFIX and the various INSTALL* arguments are resolved so that
999 If the user has superuser privileges, and is not working on AFS
1000 (Andrew File System) or relatives, then the defaults for
1001 INSTALLPRIVLIB, INSTALLARCHLIB, INSTALLSCRIPT, etc. will be appropriate,
1002 and this incantation will be the best:
1004 perl Makefile.PL; make; make test
1007 make install per default writes some documentation of what has been
1008 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1009 can be bypassed by calling make pure_install.
1013 will have to specify the installation directories as these most
1014 probably have changed since perl itself has been installed. They will
1015 have to do this by calling
1017 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1018 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1021 Be careful to repeat this procedure every time you recompile an
1022 extension, unless you are sure the AFS installation directories are
1025 =head2 Static Linking of a new Perl Binary
1027 An extension that is built with the above steps is ready to use on
1028 systems supporting dynamic loading. On systems that do not support
1029 dynamic loading, any newly created extension has to be linked together
1030 with the available resources. MakeMaker supports the linking process
1031 by creating appropriate targets in the Makefile whenever an extension
1032 is built. You can invoke the corresponding section of the makefile with
1036 That produces a new perl binary in the current directory with all
1037 extensions linked in that can be found in INST_ARCHLIB , SITELIBEXP,
1038 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1039 UNIX, this is called Makefile.aperl (may be system dependent). If you
1040 want to force the creation of a new perl, it is recommended, that you
1041 delete this Makefile.aperl, so the directories are searched-through
1042 for linkable libraries again.
1044 The binary can be installed into the directory where perl normally
1045 resides on your machine with
1049 To produce a perl binary with a different name than C<perl>, either say
1051 perl Makefile.PL MAP_TARGET=myperl
1058 make myperl MAP_TARGET=myperl
1059 make inst_perl MAP_TARGET=myperl
1061 In any case you will be prompted with the correct invocation of the
1062 C<inst_perl> target that installs the new binary into INSTALLBIN.
1064 make inst_perl per default writes some documentation of what has been
1065 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1066 can be bypassed by calling make pure_inst_perl.
1068 Warning: the inst_perl: target will most probably overwrite your
1069 existing perl binary. Use with care!
1071 Sometimes you might want to build a statically linked perl although
1072 your system supports dynamic loading. In this case you may explicitly
1073 set the linktype with the invocation of the Makefile.PL or make:
1075 perl Makefile.PL LINKTYPE=static # recommended
1079 make LINKTYPE=static # works on most systems
1081 =head2 Determination of Perl Library and Installation Locations
1083 MakeMaker needs to know, or to guess, where certain things are
1084 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1085 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1086 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1088 Extensions may be built either using the contents of the perl source
1089 directory tree or from the installed perl library. The recommended way
1090 is to build extensions after you have run 'make install' on perl
1091 itself. You can do that in any directory on your hard disk that is not
1092 below the perl source tree. The support for extensions below the ext
1093 directory of the perl distribution is only good for the standard
1094 extensions that come with perl.
1096 If an extension is being built below the C<ext/> directory of the perl
1097 source then MakeMaker will set PERL_SRC automatically (e.g.,
1098 C<../..>). If PERL_SRC is defined and the extension is recognized as
1099 a standard extension, then other variables default to the following:
1102 PERL_LIB = PERL_SRC/lib
1103 PERL_ARCHLIB = PERL_SRC/lib
1105 INST_ARCHLIB = PERL_ARCHLIB
1107 If an extension is being built away from the perl source then MakeMaker
1108 will leave PERL_SRC undefined and default to using the installed copy
1109 of the perl library. The other variables default to the following:
1111 PERL_INC = $archlibexp/CORE
1112 PERL_LIB = $privlibexp
1113 PERL_ARCHLIB = $archlibexp
1114 INST_LIB = ./blib/lib
1115 INST_ARCHLIB = ./blib/arch
1117 If perl has not yet been installed then PERL_SRC can be defined on the
1118 command line as shown in the previous section.
1121 =head2 Which architecture dependent directory?
1123 If you don't want to keep the defaults for the INSTALL* macros,
1124 MakeMaker helps you to minimize the typing needed: the usual
1125 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1126 by Configure at perl compilation time. MakeMaker supports the user who
1127 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1128 then MakeMaker defaults the latter to be the same subdirectory of
1129 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1130 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1131 for INSTALLSITELIB and INSTALLSITEARCH.
1133 MakeMaker gives you much more freedom than needed to configure
1134 internal variables and get different results. It is worth to mention,
1135 that make(1) also lets you configure most of the variables that are
1136 used in the Makefile. But in the majority of situations this will not
1137 be necessary, and should only be done if the author of a package
1138 recommends it (or you know what you're doing).
1140 =head2 Using Attributes and Parameters
1142 The following attributes can be specified as arguments to WriteMakefile()
1143 or as NAME=VALUE pairs on the command line:
1149 String containing name (and email address) of package author(s). Is used
1150 in PPD (Perl Package Description) files for PPM (Perl Package Manager).
1154 One line description of the module. Will be included in PPD file.
1158 Name of the file that contains the package description. MakeMaker looks
1159 for a line in the POD matching /^($package\s-\s)(.*)/. This is typically
1160 the first line in the "=head1 NAME" section. $2 becomes the abstract.
1162 =item BINARY_LOCATION
1164 Used when creating PPD files for binary packages. It can be set to a
1165 full or relative path or URL to the binary archive for a particular
1166 architecture. For example:
1168 perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
1170 builds a PPD package that references a binary of the C<Agent> package,
1171 located in the C<x86> directory relative to the PPD itself.
1175 Ref to array of *.c file names. Initialised from a directory scan
1176 and the values portion of the XS attribute hash. This is not
1177 currently used by MakeMaker but may be handy in Makefile.PLs.
1181 [This attribute is obsolete in Perl 5.6. PERL_OBJECT builds are C-compatible
1184 Switch to force usage of the Perl C API even when compiling for PERL_OBJECT.
1186 Note that this attribute is passed through to any recursive build,
1187 but if and only if the submodule's Makefile.PL itself makes no mention
1188 of the 'CAPI' attribute.
1192 String that will be included in the compiler call command line between
1193 the arguments INC and OPTIMIZE.
1197 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1198 config.sh. MakeMaker will add to CONFIG the following values anyway:
1218 CODE reference. The subroutine should return a hash reference. The
1219 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1220 be determined by some evaluation method.
1224 Something like C<"-DHAVE_UNISTD_H">
1228 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1233 Your name for distributing the package (by tar file). This defaults to
1238 Hashref of symbol names for routines to be made available as universal
1239 symbols. Each key/value pair consists of the package name and an
1240 array of routine names in that package. Used only under AIX, OS/2,
1241 VMS and Win32 at present. The routine names supplied will be expanded
1242 in the same way as XSUB names are expanded by the XS() macro.
1245 {"$(NAME)" => ["boot_$(NAME)" ] }
1249 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1250 "NetconfigPtr" => [ 'DESTROY'] }
1252 Please see the L<ExtUtils::Mksymlists> documentation for more information
1253 about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
1257 Array of symbol names for variables to be made available as universal symbols.
1258 Used only under AIX, OS/2, VMS and Win32 at present. Defaults to [].
1259 (e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
1263 Array of extension names to exclude when doing a static build. This
1264 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1265 details. (e.g. [ qw( Socket POSIX ) ] )
1267 This attribute may be most useful when specified as a string on the
1268 command line: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1272 Ref to array of executable files. The files will be copied to the
1273 INST_SCRIPT directory. Make realclean will delete them from there
1276 =item FIRST_MAKEFILE
1278 The name of the Makefile to be produced. Defaults to the contents of
1279 MAKEFILE, but can be overridden. This is used for the second Makefile
1280 that will be produced for the MAP_TARGET.
1284 Perl binary able to run this extension.
1288 This provides an alternate means to specify function names to be
1289 exported from the extension. Its value is a reference to an
1290 array of function names to be exported by the extension. These
1291 names are passed through unaltered to the linker options file.
1295 Ref to array of *.h file names. Similar to C.
1299 Hashref of .pm and .pod files. MakeMaker will default this to all
1300 .pod and any .pm files that include POD directives. The files listed
1301 here will be converted to HTML format and installed as was requested
1304 =item HTMLSCRIPTPODS
1306 Hashref of pod-containing files. MakeMaker will default this to all
1307 EXE_FILES files that include POD directives. The files listed
1308 here will be converted to HTML format and installed as was requested
1313 This attribute is used to specify names to be imported into the
1314 extension. It is only used on OS/2 and Win32.
1318 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1322 Array of extension names to be included when doing a static build.
1323 MakeMaker will normally build with all of the installed extensions when
1324 doing a static build, and that is usually the desired behavior. If
1325 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1326 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1328 It is not necessary to mention DynaLoader or the current extension when
1329 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1330 only DynaLoader and the current extension will be included in the build.
1332 This attribute may be most useful when specified as a string on the
1333 command line: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1335 =item INSTALLARCHLIB
1337 Used by 'make install', which copies files from INST_ARCHLIB to this
1338 directory if INSTALLDIRS is set to perl.
1342 Directory to install binary files (e.g. tkperl) into.
1346 Determines which of the two sets of installation directories to
1347 choose: installprivlib and installarchlib versus installsitelib and
1348 installsitearch. The first pair is chosen with INSTALLDIRS=perl, the
1349 second with INSTALLDIRS=site. Default is site.
1351 =item INSTALLHTMLPRIVLIBDIR
1353 This directory gets the HTML pages at 'make install' time. Defaults to
1354 $Config{installhtmlprivlibdir}.
1356 =item INSTALLHTMLSCRIPTDIR
1358 This directory gets the HTML pages at 'make install' time. Defaults to
1359 $Config{installhtmlscriptdir}.
1361 =item INSTALLHTMLSITELIBDIR
1363 This directory gets the HTML pages at 'make install' time. Defaults to
1364 $Config{installhtmlsitelibdir}.
1367 =item INSTALLMAN1DIR
1369 This directory gets the man pages at 'make install' time. Defaults to
1370 $Config{installman1dir}.
1372 =item INSTALLMAN3DIR
1374 This directory gets the man pages at 'make install' time. Defaults to
1375 $Config{installman3dir}.
1377 =item INSTALLPRIVLIB
1379 Used by 'make install', which copies files from INST_LIB to this
1380 directory if INSTALLDIRS is set to perl.
1384 Used by 'make install' which copies files from INST_SCRIPT to this
1387 =item INSTALLSITEARCH
1389 Used by 'make install', which copies files from INST_ARCHLIB to this
1390 directory if INSTALLDIRS is set to site (default).
1392 =item INSTALLSITELIB
1394 Used by 'make install', which copies files from INST_LIB to this
1395 directory if INSTALLDIRS is set to site (default).
1399 Same as INST_LIB for architecture dependent files.
1403 Directory to put real binary files during 'make'. These will be copied
1404 to INSTALLBIN during 'make install'
1408 Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you
1413 Directory where we put library files of this extension while building
1416 =item INST_HTMLLIBDIR
1418 Directory to hold the man pages in HTML format at 'make' time
1420 =item INST_HTMLSCRIPTDIR
1422 Directory to hold the man pages in HTML format at 'make' time
1426 Directory to hold the man pages at 'make' time
1430 Directory to hold the man pages at 'make' time
1434 Directory, where executable files should be installed during
1435 'make'. Defaults to "./blib/script", just to have a dummy location during
1436 testing. make install will copy the files in INST_SCRIPT to
1439 =item PERL_MALLOC_OK
1441 defaults to 0. Should be set to TRUE if the extension can work with
1442 the memory allocation routines substituted by the Perl malloc() subsystem.
1443 This should be applicable to most extensions with exceptions of those
1449 with bugs in memory allocations which are caught by Perl's malloc();
1453 which interact with the memory allocator in other ways than via
1454 malloc(), realloc(), free(), calloc(), sbrk() and brk();
1458 which rely on special alignment which is not provided by Perl's malloc().
1462 B<NOTE.> Negligence to set this flag in I<any one> of loaded extension
1463 nullifies many advantages of Perl's malloc(), such as better usage of
1464 system resources, error detection, memory usage reporting, catchable failure
1465 of memory allocations, etc.
1469 defaults to "$(OBJECT)" and is used in the ld command to specify
1470 what files to link/load from (also see dynamic_lib below for how to
1475 LIB can only be set at C<perl Makefile.PL> time. It has the effect of
1476 setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any
1480 The filename of the perllibrary that will be used together with this
1481 extension. Defaults to libperl.a.
1485 An anonymous array of alternative library
1486 specifications to be searched for (in order) until
1487 at least one library is found. E.g.
1489 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1491 Mind, that any element of the array
1492 contains a complete set of arguments for the ld
1493 command. So do not specify
1495 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1497 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1498 you specify a scalar as in
1500 'LIBS' => "-ltcl -ltk -lX11"
1502 MakeMaker will turn it into an array with one element.
1506 'static' or 'dynamic' (default unless usedl=undef in
1507 config.sh). Should only be used to force static linking (also see
1512 Boolean which tells MakeMaker, that it should include the rules to
1513 make a perl. This is handled automatically as a switch by
1514 MakeMaker. The user normally does not need it.
1518 The name of the Makefile to be produced.
1522 Hashref of pod-containing files. MakeMaker will default this to all
1523 EXE_FILES files that include POD directives. The files listed
1524 here will be converted to man pages and installed as was requested
1529 Hashref of .pm and .pod files. MakeMaker will default this to all
1530 .pod and any .pm files that include POD directives. The files listed
1531 here will be converted to man pages and installed as was requested
1536 If it is intended, that a new perl binary be produced, this variable
1537 may hold a name for that binary. Defaults to perl
1541 If the extension links to a library that it builds set this to the
1542 name of the library (see SDBM_File)
1546 Perl module name for this extension (DBD::Oracle). This will default
1547 to the directory name but should be explicitly defined in the
1552 MakeMaker will figure out if an extension contains linkable code
1553 anywhere down the directory tree, and will set this variable
1554 accordingly, but you can speed it up a very little bit if you define
1555 this boolean variable yourself.
1559 Defaults to C<@>. By setting it to an empty string you can generate a
1560 Makefile that echos all commands. Mainly used in debugging MakeMaker
1565 Boolean. Attribute to inhibit descending into subdirectories.
1569 In general, any generated Makefile checks for the current version of
1570 MakeMaker and the version the Makefile was built under. If NO_VC is
1571 set, the version check is neglected. Do not write this into your
1572 Makefile.PL, use it interactively instead.
1576 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1577 string containing all object files, e.g. "tkpBind.o
1578 tkpButton.o tkpCanvas.o"
1582 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1583 passed to subdirectory makes.
1587 Perl binary for tasks that can be done by miniperl
1591 The call to the program that is able to compile perlmain.c. Defaults
1596 Same as above for architecture dependent files.
1600 Directory containing the Perl library to use.
1604 Directory containing the Perl source code (use of this should be
1605 avoided, it may be undefined)
1609 Desired permission for read/writable files. Defaults to C<644>.
1610 See also L<MM_Unix/perm_rw>.
1614 Desired permission for executable files. Defaults to C<755>.
1615 See also L<MM_Unix/perm_rwx>.
1619 Ref to hash of files to be processed as perl programs. MakeMaker
1620 will default to any found *.PL file (except Makefile.PL) being keys
1621 and the basename of the file being the value. E.g.
1623 {'foobar.PL' => 'foobar'}
1625 The *.PL files are expected to produce output to the target files
1626 themselves. If multiple files can be generated from the same *.PL
1627 file then the value in the hash can be a reference to an array of
1628 target file names. E.g.
1630 {'foobar.PL' => ['foobar1','foobar2']}
1634 Hashref of .pm files and *.pl files to be installed. e.g.
1636 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1638 By default this will include *.pm and *.pl and the files found in
1639 the PMLIBDIRS directories. Defining PM in the
1640 Makefile.PL will override PMLIBDIRS.
1644 Ref to array of subdirectories containing library files. Defaults to
1645 [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
1646 they contain will be installed in the corresponding location in the
1647 library. A libscan() method can be used to alter the behaviour.
1648 Defining PM in the Makefile.PL will override PMLIBDIRS.
1652 Release 5.005 grandfathered old global symbol names by providing preprocessor
1653 macros for extension source compatibility. As of release 5.6, these
1654 preprocessor definitions are not available by default. The POLLUTE flag
1655 specifies that the old names should still be defined:
1657 perl Makefile.PL POLLUTE=1
1659 Please inform the module author if this is necessary to successfully install
1660 a module under 5.6 or later.
1662 =item PPM_INSTALL_EXEC
1664 Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl)
1666 =item PPM_INSTALL_SCRIPT
1668 Name of the script that gets executed by the Perl Package Manager after
1669 the installation of a package.
1673 Can be used to set the three INSTALL* attributes in one go (except for
1674 probably INSTALLMAN1DIR, if it is not below PREFIX according to
1675 %Config). They will have PREFIX as a common directory node and will
1676 branch from that node into lib/, lib/ARCHNAME or whatever Configure
1677 decided at the build time of your perl (unless you override one of
1682 Hashref: Names of modules that need to be available to run this
1683 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1684 desired version is the value. If the required version number is 0, we
1685 only check if any version is installed already.
1689 Arryref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1690 Makefile. Caution! Do not use the SKIP attribute for the negligible
1691 speedup. It may seriously damage the resulting Makefile. Only use it
1692 if you really need it.
1696 Ref to array of typemap file names. Use this when the typemaps are
1697 in some directory other than the current directory or when they are
1698 not named B<typemap>. The last typemap in the list takes
1699 precedence. A typemap in the current directory has highest
1700 precedence, even if it isn't listed in TYPEMAPS. The default system
1701 typemap has lowest precedence.
1705 Your version number for distributing the package. This defaults to
1710 Instead of specifying the VERSION in the Makefile.PL you can let
1711 MakeMaker parse a file to determine the version number. The parsing
1712 routine requires that the file named by VERSION_FROM contains one
1713 single line to compute the version number. The first line in the file
1714 that contains the regular expression
1716 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
1718 will be evaluated with eval() and the value of the named variable
1719 B<after> the eval() will be assigned to the VERSION attribute of the
1720 MakeMaker object. The following lines will be parsed o.k.:
1724 ( $VERSION ) = '$Revision: 1.222 $ ' =~ /\$Revision:\s+([^\s]+)/;
1725 $FOO::VERSION = '1.10';
1726 *FOO::VERSION = \'1.11';
1728 but these will fail:
1730 my $VERSION = '1.01';
1731 local $VERSION = '1.02';
1732 local $FOO::VERSION = '1.30';
1734 The file named in VERSION_FROM is not added as a dependency to
1735 Makefile. This is not really correct, but it would be a major pain
1736 during development to have to rewrite the Makefile for any smallish
1737 change in that file. If you want to make sure that the Makefile
1738 contains the correct VERSION macro after any change of the file, you
1739 would have to do something like
1741 depend => { Makefile => '$(VERSION_FROM)' }
1743 See attribute C<depend> below.
1747 Hashref of .xs files. MakeMaker will default this. e.g.
1749 {'name_of_file.xs' => 'name_of_file.c'}
1751 The .c files will automatically be included in the list of files
1752 deleted by a make clean.
1756 String of options to pass to xsubpp. This might include C<-C++> or
1757 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
1762 May be set to an empty string, which is identical to C<-prototypes>, or
1763 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
1764 defaults to the empty string.
1768 Your version number for the .xs file of this package. This defaults
1769 to the value of the VERSION attribute.
1773 =head2 Additional lowercase attributes
1775 can be used to pass parameters to the methods which implement that
1776 part of the Makefile.
1782 {FILES => "*.xyz foo"}
1786 {ANY_TARGET => ANY_DEPENDECY, ...}
1790 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
1791 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
1792 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
1794 If you specify COMPRESS, then SUFFIX should also be altered, as it is
1795 needed to tell make the target file of the compression. Setting
1796 DIST_CP to ln can be useful, if you need to preserve the timestamps on
1797 your files. DIST_CP can take the values 'cp', which copies the file,
1798 'ln', which links the file, and 'best' which copies symbolic links and
1799 links the rest. Default is 'best'.
1803 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
1807 {LINKTYPE => 'static', 'dynamic' or ''}
1809 NB: Extensions that have nothing but *.pm files had to say
1813 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1814 can be deleted safely. MakeMaker recognizes when there's nothing to
1819 {ANY_MACRO => ANY_VALUE, ...}
1823 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
1829 =item tool_autosplit
1835 =head2 Overriding MakeMaker Methods
1837 If you cannot achieve the desired Makefile behaviour by specifying
1838 attributes you may define private subroutines in the Makefile.PL.
1839 Each subroutines returns the text it wishes to have written to
1840 the Makefile. To override a section of the Makefile you can
1843 sub MY::c_o { "new literal text" }
1845 or you can edit the default by saying something like:
1848 package MY; # so that "SUPER" works right
1849 my $inherited = shift->SUPER::c_o(@_);
1850 $inherited =~ s/old text/new text/;
1854 If you are running experiments with embedding perl as a library into
1855 other applications, you might find MakeMaker is not sufficient. You'd
1856 better have a look at ExtUtils::Embed which is a collection of utilities
1859 If you still need a different solution, try to develop another
1860 subroutine that fits your needs and submit the diffs to
1861 F<perl5-porters@perl.org> or F<comp.lang.perl.moderated> as appropriate.
1863 For a complete description of all MakeMaker methods see L<ExtUtils::MM_Unix>.
1865 Here is a simple example of how to add a new target to the generated
1870 $(MYEXTLIB): sdbm/Makefile
1871 cd sdbm && $(MAKE) all
1876 =head2 Hintsfile support
1878 MakeMaker.pm uses the architecture specific information from
1879 Config.pm. In addition it evaluates architecture specific hints files
1880 in a C<hints/> directory. The hints files are expected to be named
1881 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
1882 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
1883 MakeMaker within the WriteMakefile() subroutine, and can be used to
1884 execute commands as well as to include special variables. The rules
1885 which hintsfile is chosen are the same as in Configure.
1887 The hintsfile is eval()ed immediately after the arguments given to
1888 WriteMakefile are stuffed into a hash reference $self but before this
1889 reference becomes blessed. So if you want to do the equivalent to
1890 override or create an attribute you would say something like
1892 $self->{LIBS} = ['-ldbm -lucb -lc'];
1894 =head2 Distribution Support
1896 For authors of extensions MakeMaker provides several Makefile
1897 targets. Most of the support comes from the ExtUtils::Manifest module,
1898 where additional documentation can be found.
1902 =item make distcheck
1904 reports which files are below the build directory but not in the
1905 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
1908 =item make skipcheck
1910 reports which files are skipped due to the entries in the
1911 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
1914 =item make distclean
1916 does a realclean first and then the distcheck. Note that this is not
1917 needed to build a new distribution as long as you are sure that the
1918 MANIFEST file is ok.
1922 rewrites the MANIFEST file, adding all remaining files found (See
1923 ExtUtils::Manifest::mkmanifest() for details)
1927 Copies all the files that are in the MANIFEST file to a newly created
1928 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
1929 exists, it will be removed first.
1933 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
1934 a make test in that directory.
1938 First does a distdir. Then a command $(PREOP) which defaults to a null
1939 command, followed by $(TOUNIX), which defaults to a null command under
1940 UNIX, and will convert files in distribution directory to UNIX format
1941 otherwise. Next it runs C<tar> on that directory into a tarfile and
1942 deletes the directory. Finishes with a command $(POSTOP) which
1943 defaults to a null command.
1947 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
1949 =item make uutardist
1951 Runs a tardist first and uuencodes the tarfile.
1955 First does a distdir. Then a command $(PREOP) which defaults to a null
1956 command. Next it runs C<shar> on that directory into a sharfile and
1957 deletes the intermediate directory again. Finishes with a command
1958 $(POSTOP) which defaults to a null command. Note: For shdist to work
1959 properly a C<shar> program that can handle directories is mandatory.
1963 First does a distdir. Then a command $(PREOP) which defaults to a null
1964 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
1965 zipfile. Then deletes that directory. Finishes with a command
1966 $(POSTOP) which defaults to a null command.
1970 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
1974 Customization of the dist targets can be done by specifying a hash
1975 reference to the dist attribute of the WriteMakefile call. The
1976 following parameters are recognized:
1979 COMPRESS ('gzip --best')
1982 TO_UNIX (depends on the system)
1983 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
1993 WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" })
1995 =head2 Disabling an extension
1997 If some events detected in F<Makefile.PL> imply that there is no way
1998 to create the Module, but this is a normal state of things, then you
1999 can create a F<Makefile> which does nothing, but succeeds on all the
2000 "usual" build targets. To do so, use
2002 ExtUtils::MakeMaker::WriteEmptyMakefile();
2004 instead of WriteMakefile().
2006 This may be useful if other modules expect this module to be I<built>
2007 OK, as opposed to I<work> OK (say, this system-dependent module builds
2008 in a subdirectory of some other distribution, or is listed as a
2009 dependency in a CPAN::Bundle, but the functionality is supported by
2010 different means on the current architecture).
2018 Command line options used by C<MakeMaker-E<gt>new()>, and thus by
2019 C<WriteMakefile()>. The string is split on whitespace, and the result
2020 is processed before any actual command line arguments are processed.
2026 ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib,
2027 ExtUtils::Install, ExtUtils::Embed
2031 Andy Dougherty <F<doughera@lafcol.lafayette.edu>>, Andreas KE<ouml>nig
2032 <F<A.Koenig@franz.ww.TU-Berlin.DE>>, Tim Bunce <F<Tim.Bunce@ig.co.uk>>.
2033 VMS support by Charles Bailey <F<bailey@newman.upenn.edu>>. OS/2
2034 support by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>. Contact the
2035 makemaker mailing list C<mailto:makemaker@franz.ww.tu-berlin.de>, if
2036 you have any questions.