1 BEGIN {require 5.002;} # MakeMaker 5.17 was the last MakeMaker that was compatible with perl5.001m
3 package ExtUtils::MakeMaker;
5 $Version = $VERSION = "5.42";
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.216 $, 10)) =~ s/\s+$//;
19 @ISA @EXPORT @EXPORT_OK $AUTOLOAD
20 $ISA_TTY $Is_Mac $Is_OS2 $Is_VMS $Revision $Setup_done
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
40 # $Version in mixed case will go away!
43 # Dummy package MM inherits actual methods from OS-specific
44 # default packages. We use this intermediate package so
45 # MY::XYZ->func() can call MM->func() and get the proper
46 # default routine without having to know under what OS
49 @MM::ISA = qw[ExtUtils::MM_Unix ExtUtils::Liblist ExtUtils::MakeMaker];
52 # Setup dummy package:
53 # MY exists for overriding methods to be defined within
58 ### sub AUTOLOAD { use Devel::Symdump; print Devel::Symdump->rnew->as_string; Carp::confess "hey why? $AUTOLOAD" }
63 # "predeclare the package: we only load it via AUTOLOAD
64 # but we have already mentioned it in @ISA
65 package ExtUtils::Liblist;
67 package ExtUtils::MakeMaker;
69 # Now we can pull in the friends
71 $Is_VMS = $^O eq 'VMS';
72 $Is_OS2 = $^O eq 'os2';
73 $Is_Mac = $^O eq 'MacOS';
74 $Is_Win32 = $^O eq 'MSWin32';
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_Mac;
89 require ExtUtils::MM_Win32;
92 # The SelfLoader would bring a lot of overhead for MakeMaker, because
93 # we know for sure we will use most of the autoloaded functions once
94 # we have to use one of them. So we write our own loader
98 if (defined fileno(DATA)) {
100 my $o = $/; # For future reads from the file.
112 warn "AUTOLOAD called unexpectedly for $AUTOLOAD";
114 defined(&$AUTOLOAD) or die "Myloader inconsistency error";
118 # The only subroutine we do not SelfLoad is Version_Check because it's
119 # called so often. Loading this minimum still requires 1.2 secs on my
123 my($checkversion) = @_;
124 die "Your Makefile was built with ExtUtils::MakeMaker v $checkversion.
125 Current Version is $ExtUtils::MakeMaker::VERSION. There have been considerable
126 changes in the meantime.
127 Please rerun 'perl Makefile.PL' to regenerate the Makefile.\n"
128 if $checkversion < $Version_OK;
129 printf STDOUT "%s %s %s %s.\n", "Makefile built with ExtUtils::MakeMaker v",
130 $checkversion, "Current Version is", $VERSION
131 unless $checkversion == $VERSION;
135 $_[0] =~ /^Use of uninitialized value/ && return;
136 $_[0] =~ /used only once/ && return;
137 $_[0] =~ /^Subroutine\s+[\w:]+\s+redefined/ && return;
141 sub ExtUtils::MakeMaker::eval_in_subdirs ;
142 sub ExtUtils::MakeMaker::eval_in_x ;
143 sub ExtUtils::MakeMaker::full_setup ;
144 sub ExtUtils::MakeMaker::writeMakefile ;
145 sub ExtUtils::MakeMaker::new ;
146 sub ExtUtils::MakeMaker::check_manifest ;
147 sub ExtUtils::MakeMaker::parse_args ;
148 sub ExtUtils::MakeMaker::check_hints ;
149 sub ExtUtils::MakeMaker::mv_all_methods ;
150 sub ExtUtils::MakeMaker::skipcheck ;
151 sub ExtUtils::MakeMaker::flush ;
152 sub ExtUtils::MakeMaker::mkbootstrap ;
153 sub ExtUtils::MakeMaker::mksymlists ;
154 sub ExtUtils::MakeMaker::neatvalue ;
155 sub ExtUtils::MakeMaker::selfdocument ;
156 sub ExtUtils::MakeMaker::WriteMakefile ;
157 sub ExtUtils::MakeMaker::prompt ($;$) ;
163 package ExtUtils::MakeMaker;
166 Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
167 local $SIG{__WARN__} = \&warnhandler;
169 unless ($Setup_done++){
171 undef &ExtUtils::MakeMaker::full_setup; #safe memory
174 MM->new(\%att)->flush;
179 $ISA_TTY = -t STDIN && -t STDOUT ;
180 Carp::confess("prompt function called without an argument") unless defined $mess;
181 my $dispdef = defined $def ? "[$def] " : " ";
182 $def = defined $def ? $def : "";
186 print "$mess $dispdef";
187 chomp($ans = <STDIN>);
192 sub eval_in_subdirs {
198 foreach $dir (@{$self->{DIR}}){
199 my($abs) = $self->catdir($pwd,$dir);
200 $self->eval_in_x($abs);
208 chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
210 # my $fh = new FileHandle;
211 # $fh->open("Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
213 open(FH,"Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
214 # my $eval = join "", <$fh>;
215 my $eval = join "", <FH>;
220 # if ($@ =~ /prerequisites/) {
221 # die "MakeMaker WARNING: $@";
223 # warn "WARNING from evaluation of $dir/Makefile.PL: $@";
225 warn "WARNING from evaluation of $dir/Makefile.PL: $@";
233 # package name for the classes into which the first object will be blessed
234 $PACKNAME = "PACK000";
239 C CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
240 EXE_FILES EXCLUDE_EXT INCLUDE_EXT NO_VC FIRST_MAKEFILE FULLPERL H
241 INC INSTALLARCHLIB INSTALLBIN INSTALLDIRS INSTALLMAN1DIR
242 INSTALLMAN3DIR INSTALLPRIVLIB INSTALLSCRIPT INSTALLSITEARCH
243 INSTALLSITELIB INST_ARCHLIB INST_BIN INST_EXE INST_LIB
244 INST_MAN1DIR INST_MAN3DIR INST_SCRIPT LDFROM LIBPERL_A LIB LIBS
245 LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB
246 NAME NEEDS_LINKING NOECHO NORECURS OBJECT OPTIMIZE PERL PERLMAINCC
247 PERL_ARCHLIB PERL_LIB PERL_SRC PL_FILES PM PMLIBDIRS PREFIX
248 PREREQ_PM SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
249 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
257 # IMPORTS is used under OS/2
259 # ^^^ installpm is deprecated, will go about Summer 96
261 # @Overridable is close to @MM_Sections but not identical. The
262 # order is important. Many subroutines declare macros. These
263 # depend on each other. Let's try to collect the macros up front,
264 # then pasthru, then the rules.
266 # MM_Sections are the sections we have to call explicitly
267 # in Overridable we have subroutines that are used indirectly
273 post_initialize const_config constants tool_autosplit tool_xsubpp
274 tools_other dist macro depend cflags const_loadlibs const_cccmd
279 c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs
280 dynamic_lib static static_lib manifypods processPL installbin subdirs
281 clean realclean dist_basics dist_core dist_dir dist_test dist_ci
282 install force perldepend makefile staticmake test
284 ); # loses section ordering
286 @Overridable = @MM_Sections;
287 push @Overridable, qw[
289 dir_target libscan makeaperl needs_linking subdir_x test_via_harness
294 push @MM_Sections, qw[
296 pm_to_blib selfdocument
300 # Postamble needs to be the last that was always the case
301 push @MM_Sections, "postamble";
302 push @Overridable, "postamble";
304 # All sections are valid keys.
305 @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
307 # we will use all these variables in the Makefile
310 ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc
311 lib_ext obj_ext ranlib sitelibexp sitearchexp so exe_ext
315 foreach $item (@Attrib_help){
316 $Recognized_Att_Keys{$item} = 1;
318 foreach $item (@Get_from_Config) {
319 $Recognized_Att_Keys{uc $item} = $Config{$item};
320 print "Attribute '\U$item\E' => '$Config{$item}'\n"
325 # When we eval a Makefile.PL in a subdirectory, that one will ask
326 # us (the parent) for the values and will prepend "..", so that
327 # all files to be installed end up below OUR ./blib
332 INST_BIN 1 INST_EXE 1 INST_LIB 1 INST_ARCHLIB 1 INST_SCRIPT
333 1 MAP_TARGET 1 INST_MAN1DIR 1 INST_MAN3DIR 1 PERL_SRC 1
339 NEEDS_LINKING HAS_LINK_CODE
341 @Keep_after_flush{@keep} = (1) x @keep;
347 The extension you are trying to build apparently is rather old and
348 most probably outdated. We detect that from the fact, that a
349 subroutine "writeMakefile" is called, and this subroutine is not
350 supported anymore since about October 1994.
352 Please contact the author or look into CPAN (details about CPAN can be
353 found in the FAQ and at http:/www.perl.com) for a more recent version
354 of the extension. If you're really desperate, you can try to change
355 the subroutine name from writeMakefile to WriteMakefile and rerun
356 'perl Makefile.PL', but you're most probably left alone, when you do
364 sub ExtUtils::MakeMaker::new {
365 my($class,$self) = @_;
368 print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
369 if (-f "MANIFEST" && ! -f "Makefile"){
373 $self = {} unless (defined $self);
377 my(%initial_att) = %$self; # record initial attributes
380 foreach $prereq (sort keys %{$self->{PREREQ_PM}}) {
381 my $eval = "use $prereq $self->{PREREQ_PM}->{$prereq}";
384 warn "Warning: prerequisite $prereq $self->{PREREQ_PM}->{$prereq} not found";
386 delete $self->{PREREQ_PM}{$prereq};
390 # unless (defined $ExtUtils::MakeMaker::useCPAN) {
391 # print qq{MakeMaker WARNING: prerequisites not found (@unsatisfied)
392 # Please install these modules first and rerun 'perl Makefile.PL'.\n};
393 # if ($ExtUtils::MakeMaker::hasCPAN) {
394 # $ExtUtils::MakeMaker::useCPAN = prompt(qq{Should I try to use the CPAN module to fetch them for you?},"yes");
396 # print qq{Hint: You may want to install the CPAN module to autofetch the needed modules\n};
397 # $ExtUtils::MakeMaker::useCPAN=0;
400 # if ($ExtUtils::MakeMaker::useCPAN) {
402 # CPAN->import(@unsatisfied);
404 # die qq{prerequisites not found (@unsatisfied)};
406 # warn qq{WARNING: prerequisites not found (@unsatisfied)};
409 if (defined $self->{CONFIGURE}) {
410 if (ref $self->{CONFIGURE} eq 'CODE') {
411 $self = { %$self, %{&{$self->{CONFIGURE}}}};
413 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
417 # This is for old Makefiles written pre 5.00, will go away
418 if ( Carp::longmess("") =~ /runsubdirpl/s ){
419 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
422 my $newclass = ++$PACKNAME;
425 print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
426 mv_all_methods("MY",$newclass);
427 bless $self, $newclass;
429 @{"$newclass\:\:ISA"} = 'MM';
432 if (defined $Parent[-2]){
433 $self->{PARENT} = $Parent[-2];
435 for $key (keys %Prepend_dot_dot) {
436 next unless defined $self->{PARENT}{$key};
437 $self->{$key} = $self->{PARENT}{$key};
438 # PERL and FULLPERL may be command verbs instead of full
439 # file specifications under VMS. If so, don't turn them
441 $self->{$key} = $self->catdir("..",$self->{$key})
442 unless $self->file_name_is_absolute($self->{$key})
443 || ($^O eq 'VMS' and ($key =~ /PERL$/ && $self->{$key} =~ /^[\w\-\$]+$/));
445 $self->{PARENT}->{CHILDREN}->{$newclass} = $self if $self->{PARENT};
447 parse_args($self,@ARGV);
450 $self->{NAME} ||= $self->guess_name;
452 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
456 if (! $self->{PERL_SRC} ) {
457 my($pthinks) = $self->canonpath($INC{'Config.pm'});
458 my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
459 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
460 if ($pthinks ne $cthinks &&
461 !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
462 print "Have $pthinks expected $cthinks\n";
464 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
467 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
470 Your perl and your Config.pm seem to have different ideas about the architecture
472 Perl thinks: [$pthinks]
473 Config says: [$Config{archname}]
474 This may or may not cause problems. Please check your installation of perl if you
475 have problems building this extension.
480 $self->init_dirscan();
481 $self->init_others();
483 push @{$self->{RESULT}}, <<END;
484 # This Makefile is for the $self->{NAME} extension to perl.
486 # It was generated automatically by MakeMaker version
487 # $VERSION (Revision: $Revision) from the contents of
488 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
490 # ANY CHANGES MADE HERE WILL BE LOST!
492 # MakeMaker Parameters:
495 foreach $key (sort keys %initial_att){
496 my($v) = neatvalue($initial_att{$key});
497 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
499 push @{$self->{RESULT}}, "# $key => $v";
502 # turn the SKIP array into a SKIPHASH hash
504 for $skip (@{$self->{SKIP} || []}) {
505 $self->{SKIPHASH}{$skip} = 1;
507 delete $self->{SKIP}; # free memory
509 if ($self->{PARENT}) {
510 for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
511 $self->{SKIPHASH}{$_} = 1;
515 # We run all the subdirectories now. They don't have much to query
516 # from the parent, but the parent has to query them: if they need linking!
517 unless ($self->{NORECURS}) {
518 $self->eval_in_subdirs if @{$self->{DIR}};
522 foreach $section ( @MM_Sections ){
523 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
524 my($skipit) = $self->skipcheck($section);
526 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
528 my(%a) = %{$self->{$section} || {}};
529 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
530 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
531 push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
535 push @{$self->{RESULT}}, "\n# End.";
541 sub WriteEmptyMakefile {
542 if (-f 'Makefile.old') {
543 chmod 0666, 'Makefile.old';
544 unlink 'Makefile.old' or warn "unlink Makefile.old: $!";
546 rename 'Makefile', 'Makefile.old' or warn "rename Makefile Makefile.old: $!"
548 open MF, '> Makefile' or die "open Makefile for write: $!";
561 close MF or die "close Makefile for write: $!";
565 print STDOUT "Checking if your kit is complete...\n";
566 require ExtUtils::Manifest;
567 $ExtUtils::Manifest::Quiet=$ExtUtils::Manifest::Quiet=1; #avoid warning
568 my(@missed)=ExtUtils::Manifest::manicheck();
570 print STDOUT "Warning: the following files are missing in your kit:\n";
571 print "\t", join "\n\t", @missed;
573 print STDOUT "Please inform the author.\n";
575 print STDOUT "Looks good\n";
580 my($self, @args) = @_;
582 unless (m/(.*?)=(.*)/){
583 help(),exit 1 if m/^help$/;
584 ++$Verbose if m/^verb/;
587 my($name, $value) = ($1, $2);
588 if ($value =~ m/^~(\w+)?/){ # tilde with optional username
589 $value =~ s [^~(\w*)]
591 ((getpwnam($1))[7] || "~$1") :
595 $self->{uc($name)} = $value;
598 # catch old-style 'potential_libs' and inform user how to 'upgrade'
599 if (defined $self->{potential_libs}){
600 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
601 if ($self->{potential_libs}){
602 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
604 print STDOUT "$msg deleted.\n";
606 $self->{LIBS} = [$self->{potential_libs}];
607 delete $self->{potential_libs};
609 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
610 if (defined $self->{ARMAYBE}){
611 my($armaybe) = $self->{ARMAYBE};
612 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
613 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
614 my(%dl) = %{$self->{dynamic_lib} || {}};
615 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
616 delete $self->{ARMAYBE};
618 if (defined $self->{LDTARGET}){
619 print STDOUT "LDTARGET should be changed to LDFROM\n";
620 $self->{LDFROM} = $self->{LDTARGET};
621 delete $self->{LDTARGET};
623 # Turn a DIR argument on the command line into an array
624 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
625 # So they can choose from the command line, which extensions they want
626 # the grep enables them to have some colons too much in case they
627 # have to build a list with the shell
628 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
630 # Turn a INCLUDE_EXT argument on the command line into an array
631 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
632 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
634 # Turn a EXCLUDE_EXT argument on the command line into an array
635 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
636 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
639 foreach $mmkey (sort keys %$self){
640 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
641 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
642 unless exists $Recognized_Att_Keys{$mmkey};
649 # We allow extension-specific hints files.
651 return unless -d "hints";
653 # First we look for the best hintsfile we have
655 my($hint)="${^O}_$Config{osvers}";
660 # Also try without trailing minor version numbers.
662 last if -f "hints/$hint.pl"; # found
664 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
666 return unless -f "hints/$hint.pl"; # really there
668 # execute the hintsfile:
670 # my $fh = new FileHandle;
671 # $fh->open("hints/$hint.pl");
673 open(FH,"hints/$hint.pl");
674 # @goodhints = <$fh>;
678 print STDOUT "Processing hints file hints/$hint.pl\n";
679 eval join('',@goodhints);
680 print STDOUT $@ if $@;
686 my($symtab) = \%{"${from}::"};
689 # Here you see the *current* list of methods that are overridable
690 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
691 # still trying to reduce the list to some reasonable minimum --
692 # because I want to make it easier for the user. A.K.
694 foreach $method (@Overridable) {
696 # We cannot say "next" here. Nick might call MY->makeaperl
697 # which isn't defined right now
699 # Above statement was written at 4.23 time when Tk-b8 was
700 # around. As Tk-b9 only builds with 5.002something and MM 5 is
701 # standard, we try to enable the next line again. It was
702 # commented out until MM 5.23
704 next unless defined &{"${from}::$method"};
706 *{"${to}::$method"} = \&{"${from}::$method"};
708 # delete would do, if we were sure, nobody ever called
709 # MY->makeaperl directly
711 # delete $symtab->{$method};
713 # If we delete a method, then it will be undefined and cannot
714 # be called. But as long as we have Makefile.PLs that rely on
715 # %MY:: being intact, we have to fill the hole with an
718 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
721 # We have to clean out %INC also, because the current directory is
722 # changed frequently and Graham Barr prefers to get his version
723 # out of a History.pl file which is "required" so woudn't get
724 # loaded again in another extension requiring a History.pl
726 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
727 # to core dump in the middle of a require statement. The required
728 # file was Tk/MMutil.pm. The consequence is, we have to be
729 # extremely careful when we try to give perl a reason to reload a
730 # library with same name. The workaround prefers to drop nothing
731 # from %INC and teach the writers not to use such libraries.
734 # foreach $inc (keys %INC) {
735 # #warn "***$inc*** deleted";
743 if ($section eq 'dynamic') {
744 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
745 "in skipped section 'dynamic_bs'\n"
746 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
747 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
748 "in skipped section 'dynamic_lib'\n"
749 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
751 if ($section eq 'dynamic_lib') {
752 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
753 "targets in skipped section 'dynamic_bs'\n"
754 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
756 if ($section eq 'static') {
757 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
758 "in skipped section 'static_lib'\n"
759 if $self->{SKIPHASH}{static_lib} && $Verbose;
761 return 'skipped' if $self->{SKIPHASH}{$section};
769 # my $fh = new FileHandle;
771 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
773 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
774 # $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
775 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
777 for $chunk (@{$self->{RESULT}}) {
778 # print $fh "$chunk\n";
784 my($finalname) = $self->{MAKEFILE};
785 rename("MakeMaker.tmp", $finalname);
786 chmod 0644, $finalname unless $Is_VMS;
788 if ($self->{PARENT}) {
789 foreach (keys %$self) { # safe memory
790 delete $self->{$_} unless $Keep_after_flush{$_};
794 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
797 # The following mkbootstrap() is only for installations that are calling
798 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
799 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
802 !!! Your Makefile has been built such a long time ago, !!!
803 !!! that is unlikely to work with current MakeMaker. !!!
804 !!! Please rebuild your Makefile !!!
808 # Ditto for mksymlists() as of MakeMaker 5.17
811 !!! Your Makefile has been built such a long time ago, !!!
812 !!! that is unlikely to work with current MakeMaker. !!!
813 !!! Please rebuild your Makefile !!!
819 return "undef" unless defined $v;
821 return "q[$v]" unless $t;
823 my(@m, $elem, @neat);
825 foreach $elem (@$v) {
826 push @neat, "q[$elem]";
828 push @m, join ", ", @neat;
832 return "$v" unless $t eq 'HASH';
834 while (($key,$val) = each %$v){
835 last unless defined $key; # cautious programming in case (undef,undef) is true
836 push(@m,"$key=>".neatvalue($val)) ;
838 return "{ ".join(', ',@m)." }";
845 push @m, "\n# Full list of MakeMaker attribute values:";
846 foreach $key (sort keys %$self){
847 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
848 my($v) = neatvalue($self->{$key});
849 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
851 push @m, "# $key => $v";
857 package ExtUtils::MakeMaker;
864 ExtUtils::MakeMaker - create an extension Makefile
868 C<use ExtUtils::MakeMaker;>
870 C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
874 C<MM-E<gt>new(\%att)-E<gt>flush;>
878 This utility is designed to write a Makefile for an extension module
879 from a Makefile.PL. It is based on the Makefile.SH model provided by
880 Andy Dougherty and the perl5-porters.
882 It splits the task of generating the Makefile into several subroutines
883 that can be individually overridden. Each subroutine returns the text
884 it wishes to have written to the Makefile.
886 MakeMaker is object oriented. Each directory below the current
887 directory that contains a Makefile.PL. Is treated as a separate
888 object. This makes it possible to write an unlimited number of
889 Makefiles with a single invocation of WriteMakefile().
891 =head2 How To Write A Makefile.PL
893 The short answer is: Don't.
895 Always begin with h2xs.
896 Always begin with h2xs!
897 ALWAYS BEGIN WITH H2XS!
899 even if you're not building around a header file, and even if you
900 don't have an XS component.
902 Run h2xs(1) before you start thinking about writing a module. For so
903 called pm-only modules that consist of C<*.pm> files only, h2xs has
904 the C<-X> switch. This will generate dummy files of all kinds that are
905 useful for the module developer.
907 The medium answer is:
909 use ExtUtils::MakeMaker;
910 WriteMakefile( NAME => "Foo::Bar" );
912 The long answer is the rest of the manpage :-)
914 =head2 Default Makefile Behaviour
916 The generated Makefile enables the user of the extension to invoke
918 perl Makefile.PL # optionally "perl Makefile.PL verbose"
920 make test # optionally set TEST_VERBOSE=1
921 make install # See below
923 The Makefile to be produced may be altered by adding arguments of the
924 form C<KEY=VALUE>. E.g.
926 perl Makefile.PL PREFIX=/tmp/myperl5
928 Other interesting targets in the generated Makefile are
930 make config # to check if the Makefile is up-to-date
931 make clean # delete local temp files (Makefile gets renamed)
932 make realclean # delete derived files (including ./blib)
933 make ci # check in all the files in the MANIFEST file
934 make dist # see below the Distribution Support section
938 MakeMaker checks for the existence of a file named F<test.pl> in the
939 current directory and if it exists it adds commands to the test target
940 of the generated Makefile that will execute the script with the proper
941 set of perl C<-I> options.
943 MakeMaker also checks for any files matching glob("t/*.t"). It will
944 add commands to the test target of the generated Makefile that execute
945 all matching files via the L<Test::Harness> module with the C<-I>
946 switches set correctly.
950 A useful variation of the above is the target C<testdb>. It runs the
951 test under the Perl debugger (see L<perldebug>). If the file
952 F<test.pl> exists in the current directory, it is used for the test.
954 If you want to debug some other testfile, set C<TEST_FILE> variable
957 make testdb TEST_FILE=t/mytest.t
959 By default the debugger is called using C<-d> option to perl. If you
960 want to specify some other option, set C<TESTDB_SW> variable:
962 make testdb TESTDB_SW=-Dx
966 make alone puts all relevant files into directories that are named by
967 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_MAN1DIR, and
968 INST_MAN3DIR. All these default to something below ./blib if you are
969 I<not> building below the perl source directory. If you I<are>
970 building below the perl source, INST_LIB and INST_ARCHLIB default to
971 ../../lib, and INST_SCRIPT is not defined.
973 The I<install> target of the generated Makefile copies the files found
974 below each of the INST_* directories to their INSTALL*
975 counterparts. Which counterparts are chosen depends on the setting of
976 INSTALLDIRS according to the following table:
981 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH
982 INST_LIB INSTALLPRIVLIB INSTALLSITELIB
984 INST_SCRIPT INSTALLSCRIPT
985 INST_MAN1DIR INSTALLMAN1DIR
986 INST_MAN3DIR INSTALLMAN3DIR
988 The INSTALL... macros in turn default to their %Config
989 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
991 You can check the values of these variables on your system with
995 And to check the sequence in which the library directories are
996 searched by perl, run
998 perl -le 'print join $/, @INC'
1001 =head2 PREFIX and LIB attribute
1003 PREFIX and LIB can be used to set several INSTALL* attributes in one
1004 go. The quickest way to install a module in a non-standard place might
1007 perl Makefile.PL LIB=~/lib
1009 This will install the module's architecture-independent files into
1010 ~/lib, the architecture-dependent files into ~/lib/$archname/auto.
1012 Another way to specify many INSTALL directories with a single
1013 parameter is PREFIX.
1015 perl Makefile.PL PREFIX=~
1017 This will replace the string specified by $Config{prefix} in all
1018 $Config{install*} values.
1020 Note, that in both cases the tilde expansion is done by MakeMaker, not
1021 by perl by default, nor by make. Conflicts between parmeters LIB,
1022 PREFIX and the various INSTALL* arguments are resolved so that
1025 If the user has superuser privileges, and is not working on AFS
1026 (Andrew File System) 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:
1173 # The following "=item C" is used by the attrib_help routine
1174 # likewise the "=back" below. So be careful when changing it!
1180 Ref to array of *.c file names. Initialised from a directory scan
1181 and the values portion of the XS attribute hash. This is not
1182 currently used by MakeMaker but may be handy in Makefile.PLs.
1186 String that will be included in the compiler call command line between
1187 the arguments INC and OPTIMIZE.
1191 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1192 config.sh. MakeMaker will add to CONFIG the following values anyway:
1212 CODE reference. The subroutine should return a hash reference. The
1213 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1214 be determined by some evaluation method.
1218 Something like C<"-DHAVE_UNISTD_H">
1222 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1227 Your name for distributing the package (by tar file). This defaults to
1232 Hashref of symbol names for routines to be made available as
1233 universal symbols. Each key/value pair consists of the package name
1234 and an array of routine names in that package. Used only under AIX
1235 (export lists) and VMS (linker options) at present. The routine
1236 names supplied will be expanded in the same way as XSUB names are
1237 expanded by the XS() macro. Defaults to
1239 {"$(NAME)" => ["boot_$(NAME)" ] }
1243 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1244 "NetconfigPtr" => [ 'DESTROY'] }
1248 Array of symbol names for variables to be made available as
1249 universal symbols. Used only under AIX (export lists) and VMS
1250 (linker options) at present. Defaults to []. (e.g. [ qw(
1251 Foo_version Foo_numstreams Foo_tree ) ])
1255 Array of extension names to exclude when doing a static build. This
1256 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1257 details. (e.g. [ qw( Socket POSIX ) ] )
1259 This attribute may be most useful when specified as a string on the
1260 commandline: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1264 Ref to array of executable files. The files will be copied to the
1265 INST_SCRIPT directory. Make realclean will delete them from there
1270 In general any generated Makefile checks for the current version of
1271 MakeMaker and the version the Makefile was built under. If NO_VC is
1272 set, the version check is neglected. Do not write this into your
1273 Makefile.PL, use it interactively instead.
1275 =item FIRST_MAKEFILE
1277 The name of the Makefile to be produced. Defaults to the contents of
1278 MAKEFILE, but can be overridden. This is used for the second Makefile
1279 that will be produced for the MAP_TARGET.
1283 Perl binary able to run this extension.
1287 Ref to array of *.h file names. Similar to C.
1291 IMPORTS is only used on OS/2.
1295 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1299 Array of extension names to be included when doing a static build.
1300 MakeMaker will normally build with all of the installed extensions when
1301 doing a static build, and that is usually the desired behavior. If
1302 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1303 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1305 It is not necessary to mention DynaLoader or the current extension when
1306 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1307 only DynaLoader and the current extension will be included in the build.
1309 This attribute may be most useful when specified as a string on the
1310 commandline: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1312 =item INSTALLARCHLIB
1314 Used by 'make install', which copies files from INST_ARCHLIB to this
1315 directory if INSTALLDIRS is set to perl.
1319 Directory to install binary files (e.g. tkperl) into.
1323 Determines which of the two sets of installation directories to
1324 choose: installprivlib and installarchlib versus installsitelib and
1325 installsitearch. The first pair is chosen with INSTALLDIRS=perl, the
1326 second with INSTALLDIRS=site. Default is site.
1328 =item INSTALLMAN1DIR
1330 This directory gets the man pages at 'make install' time. Defaults to
1331 $Config{installman1dir}.
1333 =item INSTALLMAN3DIR
1335 This directory gets the man pages at 'make install' time. Defaults to
1336 $Config{installman3dir}.
1338 =item INSTALLPRIVLIB
1340 Used by 'make install', which copies files from INST_LIB to this
1341 directory if INSTALLDIRS is set to perl.
1345 Used by 'make install' which copies files from INST_SCRIPT to this
1348 =item INSTALLSITELIB
1350 Used by 'make install', which copies files from INST_LIB to this
1351 directory if INSTALLDIRS is set to site (default).
1353 =item INSTALLSITEARCH
1355 Used by 'make install', which copies files from INST_ARCHLIB to this
1356 directory if INSTALLDIRS is set to site (default).
1360 Same as INST_LIB for architecture dependent files.
1364 Directory to put real binary files during 'make'. These will be copied
1365 to INSTALLBIN during 'make install'
1369 Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you
1374 Directory where we put library files of this extension while building
1379 Directory to hold the man pages at 'make' time
1383 Directory to hold the man pages at 'make' time
1387 Directory, where executable files should be installed during
1388 'make'. Defaults to "./blib/bin", just to have a dummy location during
1389 testing. make install will copy the files in INST_SCRIPT to
1394 defaults to "$(OBJECT)" and is used in the ld command to specify
1395 what files to link/load from (also see dynamic_lib below for how to
1400 The filename of the perllibrary that will be used together with this
1401 extension. Defaults to libperl.a.
1405 LIB can only be set at C<perl Makefile.PL> time. It has the effect of
1406 setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any
1410 An anonymous array of alternative library
1411 specifications to be searched for (in order) until
1412 at least one library is found. E.g.
1414 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1416 Mind, that any element of the array
1417 contains a complete set of arguments for the ld
1418 command. So do not specify
1420 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1422 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1423 you specify a scalar as in
1425 'LIBS' => "-ltcl -ltk -lX11"
1427 MakeMaker will turn it into an array with one element.
1431 'static' or 'dynamic' (default unless usedl=undef in
1432 config.sh). Should only be used to force static linking (also see
1437 Boolean which tells MakeMaker, that it should include the rules to
1438 make a perl. This is handled automatically as a switch by
1439 MakeMaker. The user normally does not need it.
1443 The name of the Makefile to be produced.
1447 Hashref of pod-containing files. MakeMaker will default this to all
1448 EXE_FILES files that include POD directives. The files listed
1449 here will be converted to man pages and installed as was requested
1454 Hashref of .pm and .pod files. MakeMaker will default this to all
1455 .pod and any .pm files that include POD directives. The files listed
1456 here will be converted to man pages and installed as was requested
1461 If it is intended, that a new perl binary be produced, this variable
1462 may hold a name for that binary. Defaults to perl
1466 If the extension links to a library that it builds set this to the
1467 name of the library (see SDBM_File)
1471 Perl module name for this extension (DBD::Oracle). This will default
1472 to the directory name but should be explicitly defined in the
1477 MakeMaker will figure out, if an extension contains linkable code
1478 anywhere down the directory tree, and will set this variable
1479 accordingly, but you can speed it up a very little bit, if you define
1480 this boolean variable yourself.
1484 Defaults to C<@>. By setting it to an empty string you can generate a
1485 Makefile that echos all commands. Mainly used in debugging MakeMaker
1490 Boolean. Attribute to inhibit descending into subdirectories.
1494 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1495 string containing all object files, e.g. "tkpBind.o
1496 tkpButton.o tkpCanvas.o"
1500 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1501 passed to subdirectory makes.
1505 Perl binary for tasks that can be done by miniperl
1509 The call to the program that is able to compile perlmain.c. Defaults
1514 Same as above for architecture dependent files
1518 Directory containing the Perl library to use.
1522 Directory containing the Perl source code (use of this should be
1523 avoided, it may be undefined)
1527 Ref to hash of files to be processed as perl programs. MakeMaker
1528 will default to any found *.PL file (except Makefile.PL) being keys
1529 and the basename of the file being the value. E.g.
1531 {'foobar.PL' => 'foobar'}
1533 The *.PL files are expected to produce output to the target files
1538 Hashref of .pm files and *.pl files to be installed. e.g.
1540 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1542 By default this will include *.pm and *.pl and the files found in
1543 the PMLIBDIRS directories. Defining PM in the
1544 Makefile.PL will override PMLIBDIRS.
1548 Ref to array of subdirectories containing library files. Defaults to
1549 [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
1550 they contain will be installed in the corresponding location in the
1551 library. A libscan() method can be used to alter the behaviour.
1552 Defining PM in the Makefile.PL will override PMLIBDIRS.
1556 Can be used to set the three INSTALL* attributes in one go (except for
1557 probably INSTALLMAN1DIR, if it is not below PREFIX according to
1558 %Config). They will have PREFIX as a common directory node and will
1559 branch from that node into lib/, lib/ARCHNAME or whatever Configure
1560 decided at the build time of your perl (unless you override one of
1565 Hashref: Names of modules that need to be available to run this
1566 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1567 desired version is the value. If the required version number is 0, we
1568 only check if any version is installed already.
1572 Arryref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1573 Makefile. Caution! Do not use the SKIP attribute for the neglectible
1574 speedup. It may seriously damage the resulting Makefile. Only use it,
1575 if you really need it.
1579 Ref to array of typemap file names. Use this when the typemaps are
1580 in some directory other than the current directory or when they are
1581 not named B<typemap>. The last typemap in the list takes
1582 precedence. A typemap in the current directory has highest
1583 precedence, even if it isn't listed in TYPEMAPS. The default system
1584 typemap has lowest precedence.
1588 Your version number for distributing the package. This defaults to
1593 Instead of specifying the VERSION in the Makefile.PL you can let
1594 MakeMaker parse a file to determine the version number. The parsing
1595 routine requires that the file named by VERSION_FROM contains one
1596 single line to compute the version number. The first line in the file
1597 that contains the regular expression
1599 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
1601 will be evaluated with eval() and the value of the named variable
1602 B<after> the eval() will be assigned to the VERSION attribute of the
1603 MakeMaker object. The following lines will be parsed o.k.:
1607 ( $VERSION ) = '$Revision: 1.216 $ ' =~ /\$Revision:\s+([^\s]+)/;
1608 $FOO::VERSION = '1.10';
1609 *FOO::VERSION = \'1.11';
1611 but these will fail:
1613 my $VERSION = '1.01';
1614 local $VERSION = '1.02';
1615 local $FOO::VERSION = '1.30';
1617 The file named in VERSION_FROM is not added as a dependency to
1618 Makefile. This is not really correct, but it would be a major pain
1619 during development to have to rewrite the Makefile for any smallish
1620 change in that file. If you want to make sure that the Makefile
1621 contains the correct VERSION macro after any change of the file, you
1622 would have to do something like
1624 depend => { Makefile => '$(VERSION_FROM)' }
1626 See attribute C<depend> below.
1630 Hashref of .xs files. MakeMaker will default this. e.g.
1632 {'name_of_file.xs' => 'name_of_file.c'}
1634 The .c files will automatically be included in the list of files
1635 deleted by a make clean.
1639 String of options to pass to xsubpp. This might include C<-C++> or
1640 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
1645 May be set to an empty string, which is identical to C<-prototypes>, or
1646 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
1647 defaults to the empty string.
1651 Your version number for the .xs file of this package. This defaults
1652 to the value of the VERSION attribute.
1656 =head2 Additional lowercase attributes
1658 can be used to pass parameters to the methods which implement that
1659 part of the Makefile.
1665 {FILES => "*.xyz foo"}
1669 {ANY_TARGET => ANY_DEPENDECY, ...}
1673 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => 'gz',
1674 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
1675 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
1677 If you specify COMPRESS, then SUFFIX should also be altered, as it is
1678 needed to tell make the target file of the compression. Setting
1679 DIST_CP to ln can be useful, if you need to preserve the timestamps on
1680 your files. DIST_CP can take the values 'cp', which copies the file,
1681 'ln', which links the file, and 'best' which copies symbolic links and
1682 links the rest. Default is 'best'.
1686 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
1690 Deprecated as of MakeMaker 5.23. See L<ExtUtils::MM_Unix/pm_to_blib>.
1694 {LINKTYPE => 'static', 'dynamic' or ''}
1696 NB: Extensions that have nothing but *.pm files had to say
1700 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1701 can be deleted safely. MakeMaker recognizes, when there's nothing to
1706 {ANY_MACRO => ANY_VALUE, ...}
1710 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
1712 =item tool_autosplit
1720 # bug in pod2html, so leave the =back
1722 # Don't delete this cut, MM depends on it!
1724 =head2 Overriding MakeMaker Methods
1726 If you cannot achieve the desired Makefile behaviour by specifying
1727 attributes you may define private subroutines in the Makefile.PL.
1728 Each subroutines returns the text it wishes to have written to
1729 the Makefile. To override a section of the Makefile you can
1732 sub MY::c_o { "new literal text" }
1734 or you can edit the default by saying something like:
1737 package MY; # so that "SUPER" works right
1738 my $inherited = shift->SUPER::c_o(@_);
1739 $inherited =~ s/old text/new text/;
1743 If you running experiments with embedding perl as a library into other
1744 applications, you might find MakeMaker not sufficient. You'd better
1745 have a look at ExtUtils::embed which is a collection of utilities for
1748 If you still need a different solution, try to develop another
1749 subroutine, that fits your needs and submit the diffs to
1750 F<perl5-porters@nicoh.com> or F<comp.lang.perl.misc> as appropriate.
1752 For a complete description of all MakeMaker methods see L<ExtUtils::MM_Unix>.
1754 Here is a simple example of how to add a new target to the generated
1759 $(MYEXTLIB): sdbm/Makefile
1760 cd sdbm && $(MAKE) all
1765 =head2 Hintsfile support
1767 MakeMaker.pm uses the architecture specific information from
1768 Config.pm. In addition it evaluates architecture specific hints files
1769 in a C<hints/> directory. The hints files are expected to be named
1770 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
1771 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
1772 MakeMaker within the WriteMakefile() subroutine, and can be used to
1773 execute commands as well as to include special variables. The rules
1774 which hintsfile is chosen are the same as in Configure.
1776 The hintsfile is eval()ed immediately after the arguments given to
1777 WriteMakefile are stuffed into a hash reference $self but before this
1778 reference becomes blessed. So if you want to do the equivalent to
1779 override or create an attribute you would say something like
1781 $self->{LIBS} = ['-ldbm -lucb -lc'];
1783 =head2 Distribution Support
1785 For authors of extensions MakeMaker provides several Makefile
1786 targets. Most of the support comes from the ExtUtils::Manifest module,
1787 where additional documentation can be found.
1791 =item make distcheck
1793 reports which files are below the build directory but not in the
1794 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
1797 =item make skipcheck
1799 reports which files are skipped due to the entries in the
1800 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
1803 =item make distclean
1805 does a realclean first and then the distcheck. Note that this is not
1806 needed to build a new distribution as long as you are sure, that the
1807 MANIFEST file is ok.
1811 rewrites the MANIFEST file, adding all remaining files found (See
1812 ExtUtils::Manifest::mkmanifest() for details)
1816 Copies all the files that are in the MANIFEST file to a newly created
1817 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
1818 exists, it will be removed first.
1822 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
1823 a make test in that directory.
1827 First does a distdir. Then a command $(PREOP) which defaults to a null
1828 command, followed by $(TOUNIX), which defaults to a null command under
1829 UNIX, and will convert files in distribution directory to UNIX format
1830 otherwise. Next it runs C<tar> on that directory into a tarfile and
1831 deletes the directory. Finishes with a command $(POSTOP) which
1832 defaults to a null command.
1836 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
1838 =item make uutardist
1840 Runs a tardist first and uuencodes the tarfile.
1844 First does a distdir. Then a command $(PREOP) which defaults to a null
1845 command. Next it runs C<shar> on that directory into a sharfile and
1846 deletes the intermediate directory again. Finishes with a command
1847 $(POSTOP) which defaults to a null command. Note: For shdist to work
1848 properly a C<shar> program that can handle directories is mandatory.
1852 First does a distdir. Then a command $(PREOP) which defaults to a null
1853 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
1854 zipfile. Then deletes that directory. Finishes with a command
1855 $(POSTOP) which defaults to a null command.
1859 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
1863 Customization of the dist targets can be done by specifying a hash
1864 reference to the dist attribute of the WriteMakefile call. The
1865 following parameters are recognized:
1868 COMPRESS ('compress')
1871 TO_UNIX (depends on the system)
1872 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
1882 WriteMakefile( 'dist' => { COMPRESS=>"gzip", SUFFIX=>"gz" })
1884 =head2 Disabling an extension
1886 If some events detected in F<Makefile.PL> imply that there is no way
1887 to create the Module, but this is a normal state of things, then you
1888 can create a F<Makefile> which does nothing, but succeeds on all the
1889 "usual" build targets. To do so, use
1891 ExtUtils::MakeMaker::WriteEmptyMakefile();
1893 instead of WriteMakefile().
1895 This may be useful if other modules expect this module to be I<built>
1896 OK, as opposed to I<work> OK (say, this system-dependent module builds
1897 in a subdirectory of some other distribution, or is listed as a
1898 dependency in a CPAN::Bundle, but the functionality is supported by
1899 different means on the current architecture).
1903 ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib,
1904 ExtUtils::Install, ExtUtils::embed
1908 Andy Dougherty <F<doughera@lafcol.lafayette.edu>>, Andreas KE<ouml>nig
1909 <F<A.Koenig@franz.ww.TU-Berlin.DE>>, Tim Bunce <F<Tim.Bunce@ig.co.uk>>.
1910 VMS support by Charles Bailey <F<bailey@genetics.upenn.edu>>. OS/2
1911 support by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>. Contact the
1912 makemaker mailing list C<mailto:makemaker@franz.ww.tu-berlin.de>, if
1913 you have any questions.