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";
238 C CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
239 EXE_FILES EXCLUDE_EXT INCLUDE_EXT NO_VC FIRST_MAKEFILE FULLPERL H
240 INC INSTALLARCHLIB INSTALLBIN INSTALLDIRS INSTALLMAN1DIR
241 INSTALLMAN3DIR INSTALLPRIVLIB INSTALLSCRIPT INSTALLSITEARCH
242 INSTALLSITELIB INST_ARCHLIB INST_BIN INST_EXE INST_LIB
243 INST_MAN1DIR INST_MAN3DIR INST_SCRIPT LDFROM LIBPERL_A LIB LIBS
244 LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB
245 NAME NEEDS_LINKING NOECHO NORECURS OBJECT OPTIMIZE PERL PERLMAINCC
246 PERL_ARCHLIB PERL_LIB PERL_SRC PL_FILES PM PMLIBDIRS PREFIX
247 PREREQ_PM SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
248 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
256 # IMPORTS is used under OS/2
258 # ^^^ installpm is deprecated, will go about Summer 96
260 # @Overridable is close to @MM_Sections but not identical. The
261 # order is important. Many subroutines declare macros. These
262 # depend on each other. Let's try to collect the macros up front,
263 # then pasthru, then the rules.
265 # MM_Sections are the sections we have to call explicitly
266 # in Overridable we have subroutines that are used indirectly
272 post_initialize const_config constants tool_autosplit tool_xsubpp
273 tools_other dist macro depend cflags const_loadlibs const_cccmd
278 c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs
279 dynamic_lib static static_lib manifypods processPL installbin subdirs
280 clean realclean dist_basics dist_core dist_dir dist_test dist_ci
281 install force perldepend makefile staticmake test
283 ); # loses section ordering
285 @Overridable = @MM_Sections;
286 push @Overridable, qw[
288 dir_target libscan makeaperl needs_linking subdir_x test_via_harness
293 push @MM_Sections, qw[
295 pm_to_blib selfdocument
299 # Postamble needs to be the last that was always the case
300 push @MM_Sections, "postamble";
301 push @Overridable, "postamble";
303 # All sections are valid keys.
304 @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
306 # we will use all these variables in the Makefile
309 ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc
310 lib_ext obj_ext ranlib sitelibexp sitearchexp so exe_ext
314 foreach $item (@Attrib_help){
315 $Recognized_Att_Keys{$item} = 1;
317 foreach $item (@Get_from_Config) {
318 $Recognized_Att_Keys{uc $item} = $Config{$item};
319 print "Attribute '\U$item\E' => '$Config{$item}'\n"
324 # When we eval a Makefile.PL in a subdirectory, that one will ask
325 # us (the parent) for the values and will prepend "..", so that
326 # all files to be installed end up below OUR ./blib
331 INST_BIN 1 INST_EXE 1 INST_LIB 1 INST_ARCHLIB 1 INST_SCRIPT
332 1 MAP_TARGET 1 INST_MAN1DIR 1 INST_MAN3DIR 1 PERL_SRC 1
338 NEEDS_LINKING HAS_LINK_CODE
340 @Keep_after_flush{@keep} = (1) x @keep;
346 The extension you are trying to build apparently is rather old and
347 most probably outdated. We detect that from the fact, that a
348 subroutine "writeMakefile" is called, and this subroutine is not
349 supported anymore since about October 1994.
351 Please contact the author or look into CPAN (details about CPAN can be
352 found in the FAQ and at http:/www.perl.com) for a more recent version
353 of the extension. If you're really desperate, you can try to change
354 the subroutine name from writeMakefile to WriteMakefile and rerun
355 'perl Makefile.PL', but you're most probably left alone, when you do
363 sub ExtUtils::MakeMaker::new {
364 my($class,$self) = @_;
367 print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
368 if (-f "MANIFEST" && ! -f "Makefile"){
372 $self = {} unless (defined $self);
376 my(%initial_att) = %$self; # record initial attributes
379 foreach $prereq (sort keys %{$self->{PREREQ_PM}}) {
380 my $eval = "use $prereq $self->{PREREQ_PM}->{$prereq}";
383 warn "Warning: prerequisite $prereq $self->{PREREQ_PM}->{$prereq} not found";
385 delete $self->{PREREQ_PM}{$prereq};
389 # unless (defined $ExtUtils::MakeMaker::useCPAN) {
390 # print qq{MakeMaker WARNING: prerequisites not found (@unsatisfied)
391 # Please install these modules first and rerun 'perl Makefile.PL'.\n};
392 # if ($ExtUtils::MakeMaker::hasCPAN) {
393 # $ExtUtils::MakeMaker::useCPAN = prompt(qq{Should I try to use the CPAN module to fetch them for you?},"yes");
395 # print qq{Hint: You may want to install the CPAN module to autofetch the needed modules\n};
396 # $ExtUtils::MakeMaker::useCPAN=0;
399 # if ($ExtUtils::MakeMaker::useCPAN) {
401 # CPAN->import(@unsatisfied);
403 # die qq{prerequisites not found (@unsatisfied)};
405 # warn qq{WARNING: prerequisites not found (@unsatisfied)};
408 if (defined $self->{CONFIGURE}) {
409 if (ref $self->{CONFIGURE} eq 'CODE') {
410 $self = { %$self, %{&{$self->{CONFIGURE}}}};
412 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
416 # This is for old Makefiles written pre 5.00, will go away
417 if ( Carp::longmess("") =~ /runsubdirpl/s ){
418 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
421 my $newclass = ++$PACKNAME;
424 print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
425 mv_all_methods("MY",$newclass);
426 bless $self, $newclass;
428 @{"$newclass\:\:ISA"} = 'MM';
431 if (defined $Parent[-2]){
432 $self->{PARENT} = $Parent[-2];
434 for $key (keys %Prepend_dot_dot) {
435 next unless defined $self->{PARENT}{$key};
436 $self->{$key} = $self->{PARENT}{$key};
437 # PERL and FULLPERL may be command verbs instead of full
438 # file specifications under VMS. If so, don't turn them
440 $self->{$key} = $self->catdir("..",$self->{$key})
441 unless $self->file_name_is_absolute($self->{$key})
442 || ($^O eq 'VMS' and ($key =~ /PERL$/ && $self->{$key} =~ /^[\w\-\$]+$/));
444 $self->{PARENT}->{CHILDREN}->{$newclass} = $self if $self->{PARENT};
446 parse_args($self,@ARGV);
449 $self->{NAME} ||= $self->guess_name;
451 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
455 if (! $self->{PERL_SRC} ) {
456 my($pthinks) = $self->canonpath($INC{'Config.pm'});
457 my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
458 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
459 if ($pthinks ne $cthinks &&
460 !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
461 print "Have $pthinks expected $cthinks\n";
463 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
466 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
469 Your perl and your Config.pm seem to have different ideas about the architecture
471 Perl thinks: [$pthinks]
472 Config says: [$Config{archname}]
473 This may or may not cause problems. Please check your installation of perl if you
474 have problems building this extension.
479 $self->init_dirscan();
480 $self->init_others();
482 push @{$self->{RESULT}}, <<END;
483 # This Makefile is for the $self->{NAME} extension to perl.
485 # It was generated automatically by MakeMaker version
486 # $VERSION (Revision: $Revision) from the contents of
487 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
489 # ANY CHANGES MADE HERE WILL BE LOST!
491 # MakeMaker Parameters:
494 foreach $key (sort keys %initial_att){
495 my($v) = neatvalue($initial_att{$key});
496 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
498 push @{$self->{RESULT}}, "# $key => $v";
501 # turn the SKIP array into a SKIPHASH hash
503 for $skip (@{$self->{SKIP} || []}) {
504 $self->{SKIPHASH}{$skip} = 1;
506 delete $self->{SKIP}; # free memory
508 if ($self->{PARENT}) {
509 for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
510 $self->{SKIPHASH}{$_} = 1;
514 # We run all the subdirectories now. They don't have much to query
515 # from the parent, but the parent has to query them: if they need linking!
516 unless ($self->{NORECURS}) {
517 $self->eval_in_subdirs if @{$self->{DIR}};
521 foreach $section ( @MM_Sections ){
522 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
523 my($skipit) = $self->skipcheck($section);
525 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
527 my(%a) = %{$self->{$section} || {}};
528 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
529 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
530 push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
534 push @{$self->{RESULT}}, "\n# End.";
540 sub WriteEmptyMakefile {
541 if (-f 'Makefile.old') {
542 chmod 0666, 'Makefile.old';
543 unlink 'Makefile.old' or warn "unlink Makefile.old: $!";
545 rename 'Makefile', 'Makefile.old' or warn "rename Makefile Makefile.old: $!"
547 open MF, '> Makefile' or die "open Makefile for write: $!";
560 close MF or die "close Makefile for write: $!";
564 print STDOUT "Checking if your kit is complete...\n";
565 require ExtUtils::Manifest;
566 $ExtUtils::Manifest::Quiet=$ExtUtils::Manifest::Quiet=1; #avoid warning
567 my(@missed)=ExtUtils::Manifest::manicheck();
569 print STDOUT "Warning: the following files are missing in your kit:\n";
570 print "\t", join "\n\t", @missed;
572 print STDOUT "Please inform the author.\n";
574 print STDOUT "Looks good\n";
579 my($self, @args) = @_;
581 unless (m/(.*?)=(.*)/){
582 help(),exit 1 if m/^help$/;
583 ++$Verbose if m/^verb/;
586 my($name, $value) = ($1, $2);
587 if ($value =~ m/^~(\w+)?/){ # tilde with optional username
588 $value =~ s [^~(\w*)]
590 ((getpwnam($1))[7] || "~$1") :
594 $self->{uc($name)} = $value;
597 # catch old-style 'potential_libs' and inform user how to 'upgrade'
598 if (defined $self->{potential_libs}){
599 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
600 if ($self->{potential_libs}){
601 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
603 print STDOUT "$msg deleted.\n";
605 $self->{LIBS} = [$self->{potential_libs}];
606 delete $self->{potential_libs};
608 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
609 if (defined $self->{ARMAYBE}){
610 my($armaybe) = $self->{ARMAYBE};
611 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
612 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
613 my(%dl) = %{$self->{dynamic_lib} || {}};
614 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
615 delete $self->{ARMAYBE};
617 if (defined $self->{LDTARGET}){
618 print STDOUT "LDTARGET should be changed to LDFROM\n";
619 $self->{LDFROM} = $self->{LDTARGET};
620 delete $self->{LDTARGET};
622 # Turn a DIR argument on the command line into an array
623 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
624 # So they can choose from the command line, which extensions they want
625 # the grep enables them to have some colons too much in case they
626 # have to build a list with the shell
627 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
629 # Turn a INCLUDE_EXT argument on the command line into an array
630 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
631 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
633 # Turn a EXCLUDE_EXT argument on the command line into an array
634 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
635 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
638 foreach $mmkey (sort keys %$self){
639 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
640 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
641 unless exists $Recognized_Att_Keys{$mmkey};
648 # We allow extension-specific hints files.
650 return unless -d "hints";
652 # First we look for the best hintsfile we have
654 my($hint)="${^O}_$Config{osvers}";
659 # Also try without trailing minor version numbers.
661 last if -f "hints/$hint.pl"; # found
663 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
665 return unless -f "hints/$hint.pl"; # really there
667 # execute the hintsfile:
669 # my $fh = new FileHandle;
670 # $fh->open("hints/$hint.pl");
672 open(FH,"hints/$hint.pl");
673 # @goodhints = <$fh>;
677 print STDOUT "Processing hints file hints/$hint.pl\n";
678 eval join('',@goodhints);
679 print STDOUT $@ if $@;
685 my($symtab) = \%{"${from}::"};
688 # Here you see the *current* list of methods that are overridable
689 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
690 # still trying to reduce the list to some reasonable minimum --
691 # because I want to make it easier for the user. A.K.
693 foreach $method (@Overridable) {
695 # We cannot say "next" here. Nick might call MY->makeaperl
696 # which isn't defined right now
698 # Above statement was written at 4.23 time when Tk-b8 was
699 # around. As Tk-b9 only builds with 5.002something and MM 5 is
700 # standard, we try to enable the next line again. It was
701 # commented out until MM 5.23
703 next unless defined &{"${from}::$method"};
705 *{"${to}::$method"} = \&{"${from}::$method"};
707 # delete would do, if we were sure, nobody ever called
708 # MY->makeaperl directly
710 # delete $symtab->{$method};
712 # If we delete a method, then it will be undefined and cannot
713 # be called. But as long as we have Makefile.PLs that rely on
714 # %MY:: being intact, we have to fill the hole with an
717 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
720 # We have to clean out %INC also, because the current directory is
721 # changed frequently and Graham Barr prefers to get his version
722 # out of a History.pl file which is "required" so woudn't get
723 # loaded again in another extension requiring a History.pl
725 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
726 # to core dump in the middle of a require statement. The required
727 # file was Tk/MMutil.pm. The consequence is, we have to be
728 # extremely careful when we try to give perl a reason to reload a
729 # library with same name. The workaround prefers to drop nothing
730 # from %INC and teach the writers not to use such libraries.
733 # foreach $inc (keys %INC) {
734 # #warn "***$inc*** deleted";
742 if ($section eq 'dynamic') {
743 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
744 "in skipped section 'dynamic_bs'\n"
745 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
746 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
747 "in skipped section 'dynamic_lib'\n"
748 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
750 if ($section eq 'dynamic_lib') {
751 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
752 "targets in skipped section 'dynamic_bs'\n"
753 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
755 if ($section eq 'static') {
756 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
757 "in skipped section 'static_lib'\n"
758 if $self->{SKIPHASH}{static_lib} && $Verbose;
760 return 'skipped' if $self->{SKIPHASH}{$section};
768 # my $fh = new FileHandle;
770 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
772 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
773 # $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
774 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
776 for $chunk (@{$self->{RESULT}}) {
777 # print $fh "$chunk\n";
783 my($finalname) = $self->{MAKEFILE};
784 rename("MakeMaker.tmp", $finalname);
785 chmod 0644, $finalname unless $Is_VMS;
787 if ($self->{PARENT}) {
788 foreach (keys %$self) { # safe memory
789 delete $self->{$_} unless $Keep_after_flush{$_};
793 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
796 # The following mkbootstrap() is only for installations that are calling
797 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
798 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
801 !!! Your Makefile has been built such a long time ago, !!!
802 !!! that is unlikely to work with current MakeMaker. !!!
803 !!! Please rebuild your Makefile !!!
807 # Ditto for mksymlists() as of MakeMaker 5.17
810 !!! Your Makefile has been built such a long time ago, !!!
811 !!! that is unlikely to work with current MakeMaker. !!!
812 !!! Please rebuild your Makefile !!!
818 return "undef" unless defined $v;
820 return "q[$v]" unless $t;
822 my(@m, $elem, @neat);
824 foreach $elem (@$v) {
825 push @neat, "q[$elem]";
827 push @m, join ", ", @neat;
831 return "$v" unless $t eq 'HASH';
833 while (($key,$val) = each %$v){
834 last unless defined $key; # cautious programming in case (undef,undef) is true
835 push(@m,"$key=>".neatvalue($val)) ;
837 return "{ ".join(', ',@m)." }";
844 push @m, "\n# Full list of MakeMaker attribute values:";
845 foreach $key (sort keys %$self){
846 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
847 my($v) = neatvalue($self->{$key});
848 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
850 push @m, "# $key => $v";
856 package ExtUtils::MakeMaker;
863 ExtUtils::MakeMaker - create an extension Makefile
867 C<use ExtUtils::MakeMaker;>
869 C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
873 C<MM-E<gt>new(\%att)-E<gt>flush;>
877 This utility is designed to write a Makefile for an extension module
878 from a Makefile.PL. It is based on the Makefile.SH model provided by
879 Andy Dougherty and the perl5-porters.
881 It splits the task of generating the Makefile into several subroutines
882 that can be individually overridden. Each subroutine returns the text
883 it wishes to have written to the Makefile.
885 MakeMaker is object oriented. Each directory below the current
886 directory that contains a Makefile.PL. Is treated as a separate
887 object. This makes it possible to write an unlimited number of
888 Makefiles with a single invocation of WriteMakefile().
890 =head2 How To Write A Makefile.PL
892 The short answer is: Don't.
894 Always begin with h2xs.
895 Always begin with h2xs!
896 ALWAYS BEGIN WITH H2XS!
898 even if you're not building around a header file, and even if you
899 don't have an XS component.
901 Run h2xs(1) before you start thinking about writing a module. For so
902 called pm-only modules that consist of C<*.pm> files only, h2xs has
903 the C<-X> switch. This will generate dummy files of all kinds that are
904 useful for the module developer.
906 The medium answer is:
908 use ExtUtils::MakeMaker;
909 WriteMakefile( NAME => "Foo::Bar" );
911 The long answer is the rest of the manpage :-)
913 =head2 Default Makefile Behaviour
915 The generated Makefile enables the user of the extension to invoke
917 perl Makefile.PL # optionally "perl Makefile.PL verbose"
919 make test # optionally set TEST_VERBOSE=1
920 make install # See below
922 The Makefile to be produced may be altered by adding arguments of the
923 form C<KEY=VALUE>. E.g.
925 perl Makefile.PL PREFIX=/tmp/myperl5
927 Other interesting targets in the generated Makefile are
929 make config # to check if the Makefile is up-to-date
930 make clean # delete local temp files (Makefile gets renamed)
931 make realclean # delete derived files (including ./blib)
932 make ci # check in all the files in the MANIFEST file
933 make dist # see below the Distribution Support section
937 MakeMaker checks for the existence of a file named F<test.pl> in the
938 current directory and if it exists it adds commands to the test target
939 of the generated Makefile that will execute the script with the proper
940 set of perl C<-I> options.
942 MakeMaker also checks for any files matching glob("t/*.t"). It will
943 add commands to the test target of the generated Makefile that execute
944 all matching files via the L<Test::Harness> module with the C<-I>
945 switches set correctly.
949 A useful variation of the above is the target C<testdb>. It runs the
950 test under the Perl debugger (see L<perldebug>). If the file
951 F<test.pl> exists in the current directory, it is used for the test.
953 If you want to debug some other testfile, set C<TEST_FILE> variable
956 make testdb TEST_FILE=t/mytest.t
958 By default the debugger is called using C<-d> option to perl. If you
959 want to specify some other option, set C<TESTDB_SW> variable:
961 make testdb TESTDB_SW=-Dx
965 make alone puts all relevant files into directories that are named by
966 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_MAN1DIR, and
967 INST_MAN3DIR. All these default to something below ./blib if you are
968 I<not> building below the perl source directory. If you I<are>
969 building below the perl source, INST_LIB and INST_ARCHLIB default to
970 ../../lib, and INST_SCRIPT is not defined.
972 The I<install> target of the generated Makefile copies the files found
973 below each of the INST_* directories to their INSTALL*
974 counterparts. Which counterparts are chosen depends on the setting of
975 INSTALLDIRS according to the following table:
980 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH
981 INST_LIB INSTALLPRIVLIB INSTALLSITELIB
983 INST_SCRIPT INSTALLSCRIPT
984 INST_MAN1DIR INSTALLMAN1DIR
985 INST_MAN3DIR INSTALLMAN3DIR
987 The INSTALL... macros in turn default to their %Config
988 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
990 You can check the values of these variables on your system with
994 And to check the sequence in which the library directories are
995 searched by perl, run
997 perl -le 'print join $/, @INC'
1000 =head2 PREFIX and LIB attribute
1002 PREFIX and LIB can be used to set several INSTALL* attributes in one
1003 go. The quickest way to install a module in a non-standard place might
1006 perl Makefile.PL LIB=~/lib
1008 This will install the module's architecture-independent files into
1009 ~/lib, the architecture-dependent files into ~/lib/$archname/auto.
1011 Another way to specify many INSTALL directories with a single
1012 parameter is PREFIX.
1014 perl Makefile.PL PREFIX=~
1016 This will replace the string specified by $Config{prefix} in all
1017 $Config{install*} values.
1019 Note, that in both cases the tilde expansion is done by MakeMaker, not
1020 by perl by default, nor by make. Conflicts between parmeters LIB,
1021 PREFIX and the various INSTALL* arguments are resolved so that
1024 If the user has superuser privileges, and is not working on AFS
1025 (Andrew File System) or relatives, then the defaults for
1026 INSTALLPRIVLIB, INSTALLARCHLIB, INSTALLSCRIPT, etc. will be appropriate,
1027 and this incantation will be the best:
1029 perl Makefile.PL; make; make test
1032 make install per default writes some documentation of what has been
1033 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1034 can be bypassed by calling make pure_install.
1038 will have to specify the installation directories as these most
1039 probably have changed since perl itself has been installed. They will
1040 have to do this by calling
1042 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1043 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1046 Be careful to repeat this procedure every time you recompile an
1047 extension, unless you are sure the AFS installation directories are
1050 =head2 Static Linking of a new Perl Binary
1052 An extension that is built with the above steps is ready to use on
1053 systems supporting dynamic loading. On systems that do not support
1054 dynamic loading, any newly created extension has to be linked together
1055 with the available resources. MakeMaker supports the linking process
1056 by creating appropriate targets in the Makefile whenever an extension
1057 is built. You can invoke the corresponding section of the makefile with
1061 That produces a new perl binary in the current directory with all
1062 extensions linked in that can be found in INST_ARCHLIB , SITELIBEXP,
1063 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1064 UNIX, this is called Makefile.aperl (may be system dependent). If you
1065 want to force the creation of a new perl, it is recommended, that you
1066 delete this Makefile.aperl, so the directories are searched-through
1067 for linkable libraries again.
1069 The binary can be installed into the directory where perl normally
1070 resides on your machine with
1074 To produce a perl binary with a different name than C<perl>, either say
1076 perl Makefile.PL MAP_TARGET=myperl
1083 make myperl MAP_TARGET=myperl
1084 make inst_perl MAP_TARGET=myperl
1086 In any case you will be prompted with the correct invocation of the
1087 C<inst_perl> target that installs the new binary into INSTALLBIN.
1089 make inst_perl per default writes some documentation of what has been
1090 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1091 can be bypassed by calling make pure_inst_perl.
1093 Warning: the inst_perl: target will most probably overwrite your
1094 existing perl binary. Use with care!
1096 Sometimes you might want to build a statically linked perl although
1097 your system supports dynamic loading. In this case you may explicitly
1098 set the linktype with the invocation of the Makefile.PL or make:
1100 perl Makefile.PL LINKTYPE=static # recommended
1104 make LINKTYPE=static # works on most systems
1106 =head2 Determination of Perl Library and Installation Locations
1108 MakeMaker needs to know, or to guess, where certain things are
1109 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1110 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1111 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1113 Extensions may be built either using the contents of the perl source
1114 directory tree or from the installed perl library. The recommended way
1115 is to build extensions after you have run 'make install' on perl
1116 itself. You can do that in any directory on your hard disk that is not
1117 below the perl source tree. The support for extensions below the ext
1118 directory of the perl distribution is only good for the standard
1119 extensions that come with perl.
1121 If an extension is being built below the C<ext/> directory of the perl
1122 source then MakeMaker will set PERL_SRC automatically (e.g.,
1123 C<../..>). If PERL_SRC is defined and the extension is recognized as
1124 a standard extension, then other variables default to the following:
1127 PERL_LIB = PERL_SRC/lib
1128 PERL_ARCHLIB = PERL_SRC/lib
1130 INST_ARCHLIB = PERL_ARCHLIB
1132 If an extension is being built away from the perl source then MakeMaker
1133 will leave PERL_SRC undefined and default to using the installed copy
1134 of the perl library. The other variables default to the following:
1136 PERL_INC = $archlibexp/CORE
1137 PERL_LIB = $privlibexp
1138 PERL_ARCHLIB = $archlibexp
1139 INST_LIB = ./blib/lib
1140 INST_ARCHLIB = ./blib/arch
1142 If perl has not yet been installed then PERL_SRC can be defined on the
1143 command line as shown in the previous section.
1146 =head2 Which architecture dependent directory?
1148 If you don't want to keep the defaults for the INSTALL* macros,
1149 MakeMaker helps you to minimize the typing needed: the usual
1150 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1151 by Configure at perl compilation time. MakeMaker supports the user who
1152 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1153 then MakeMaker defaults the latter to be the same subdirectory of
1154 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1155 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1156 for INSTALLSITELIB and INSTALLSITEARCH.
1158 MakeMaker gives you much more freedom than needed to configure
1159 internal variables and get different results. It is worth to mention,
1160 that make(1) also lets you configure most of the variables that are
1161 used in the Makefile. But in the majority of situations this will not
1162 be necessary, and should only be done, if the author of a package
1163 recommends it (or you know what you're doing).
1165 =head2 Using Attributes and Parameters
1167 The following attributes can be specified as arguments to WriteMakefile()
1168 or as NAME=VALUE pairs on the command line:
1172 # The following "=item C" is used by the attrib_help routine
1173 # likewise the "=back" below. So be careful when changing it!
1179 Ref to array of *.c file names. Initialised from a directory scan
1180 and the values portion of the XS attribute hash. This is not
1181 currently used by MakeMaker but may be handy in Makefile.PLs.
1185 String that will be included in the compiler call command line between
1186 the arguments INC and OPTIMIZE.
1190 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1191 config.sh. MakeMaker will add to CONFIG the following values anyway:
1211 CODE reference. The subroutine should return a hash reference. The
1212 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1213 be determined by some evaluation method.
1217 Something like C<"-DHAVE_UNISTD_H">
1221 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1226 Your name for distributing the package (by tar file). This defaults to
1231 Hashref of symbol names for routines to be made available as
1232 universal symbols. Each key/value pair consists of the package name
1233 and an array of routine names in that package. Used only under AIX
1234 (export lists) and VMS (linker options) at present. The routine
1235 names supplied will be expanded in the same way as XSUB names are
1236 expanded by the XS() macro. Defaults to
1238 {"$(NAME)" => ["boot_$(NAME)" ] }
1242 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1243 "NetconfigPtr" => [ 'DESTROY'] }
1247 Array of symbol names for variables to be made available as
1248 universal symbols. Used only under AIX (export lists) and VMS
1249 (linker options) at present. Defaults to []. (e.g. [ qw(
1250 Foo_version Foo_numstreams Foo_tree ) ])
1254 Array of extension names to exclude when doing a static build. This
1255 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1256 details. (e.g. [ qw( Socket POSIX ) ] )
1258 This attribute may be most useful when specified as a string on the
1259 commandline: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1263 Ref to array of executable files. The files will be copied to the
1264 INST_SCRIPT directory. Make realclean will delete them from there
1269 In general any generated Makefile checks for the current version of
1270 MakeMaker and the version the Makefile was built under. If NO_VC is
1271 set, the version check is neglected. Do not write this into your
1272 Makefile.PL, use it interactively instead.
1274 =item FIRST_MAKEFILE
1276 The name of the Makefile to be produced. Defaults to the contents of
1277 MAKEFILE, but can be overridden. This is used for the second Makefile
1278 that will be produced for the MAP_TARGET.
1282 Perl binary able to run this extension.
1286 Ref to array of *.h file names. Similar to C.
1290 IMPORTS is only used on OS/2.
1294 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1298 Array of extension names to be included when doing a static build.
1299 MakeMaker will normally build with all of the installed extensions when
1300 doing a static build, and that is usually the desired behavior. If
1301 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1302 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1304 It is not necessary to mention DynaLoader or the current extension when
1305 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1306 only DynaLoader and the current extension will be included in the build.
1308 This attribute may be most useful when specified as a string on the
1309 commandline: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1311 =item INSTALLARCHLIB
1313 Used by 'make install', which copies files from INST_ARCHLIB to this
1314 directory if INSTALLDIRS is set to perl.
1318 Directory to install binary files (e.g. tkperl) into.
1322 Determines which of the two sets of installation directories to
1323 choose: installprivlib and installarchlib versus installsitelib and
1324 installsitearch. The first pair is chosen with INSTALLDIRS=perl, the
1325 second with INSTALLDIRS=site. Default is site.
1327 =item INSTALLMAN1DIR
1329 This directory gets the man pages at 'make install' time. Defaults to
1330 $Config{installman1dir}.
1332 =item INSTALLMAN3DIR
1334 This directory gets the man pages at 'make install' time. Defaults to
1335 $Config{installman3dir}.
1337 =item INSTALLPRIVLIB
1339 Used by 'make install', which copies files from INST_LIB to this
1340 directory if INSTALLDIRS is set to perl.
1344 Used by 'make install' which copies files from INST_SCRIPT to this
1347 =item INSTALLSITELIB
1349 Used by 'make install', which copies files from INST_LIB to this
1350 directory if INSTALLDIRS is set to site (default).
1352 =item INSTALLSITEARCH
1354 Used by 'make install', which copies files from INST_ARCHLIB to this
1355 directory if INSTALLDIRS is set to site (default).
1359 Same as INST_LIB for architecture dependent files.
1363 Directory to put real binary files during 'make'. These will be copied
1364 to INSTALLBIN during 'make install'
1368 Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you
1373 Directory where we put library files of this extension while building
1378 Directory to hold the man pages at 'make' time
1382 Directory to hold the man pages at 'make' time
1386 Directory, where executable files should be installed during
1387 'make'. Defaults to "./blib/bin", just to have a dummy location during
1388 testing. make install will copy the files in INST_SCRIPT to
1393 defaults to "$(OBJECT)" and is used in the ld command to specify
1394 what files to link/load from (also see dynamic_lib below for how to
1399 The filename of the perllibrary that will be used together with this
1400 extension. Defaults to libperl.a.
1404 LIB can only be set at C<perl Makefile.PL> time. It has the effect of
1405 setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any
1409 An anonymous array of alternative library
1410 specifications to be searched for (in order) until
1411 at least one library is found. E.g.
1413 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1415 Mind, that any element of the array
1416 contains a complete set of arguments for the ld
1417 command. So do not specify
1419 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1421 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1422 you specify a scalar as in
1424 'LIBS' => "-ltcl -ltk -lX11"
1426 MakeMaker will turn it into an array with one element.
1430 'static' or 'dynamic' (default unless usedl=undef in
1431 config.sh). Should only be used to force static linking (also see
1436 Boolean which tells MakeMaker, that it should include the rules to
1437 make a perl. This is handled automatically as a switch by
1438 MakeMaker. The user normally does not need it.
1442 The name of the Makefile to be produced.
1446 Hashref of pod-containing files. MakeMaker will default this to all
1447 EXE_FILES files that include POD directives. The files listed
1448 here will be converted to man pages and installed as was requested
1453 Hashref of .pm and .pod files. MakeMaker will default this to all
1454 .pod and any .pm files that include POD directives. The files listed
1455 here will be converted to man pages and installed as was requested
1460 If it is intended, that a new perl binary be produced, this variable
1461 may hold a name for that binary. Defaults to perl
1465 If the extension links to a library that it builds set this to the
1466 name of the library (see SDBM_File)
1470 Perl module name for this extension (DBD::Oracle). This will default
1471 to the directory name but should be explicitly defined in the
1476 MakeMaker will figure out, if an extension contains linkable code
1477 anywhere down the directory tree, and will set this variable
1478 accordingly, but you can speed it up a very little bit, if you define
1479 this boolean variable yourself.
1483 Defaults to C<@>. By setting it to an empty string you can generate a
1484 Makefile that echos all commands. Mainly used in debugging MakeMaker
1489 Boolean. Attribute to inhibit descending into subdirectories.
1493 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1494 string containing all object files, e.g. "tkpBind.o
1495 tkpButton.o tkpCanvas.o"
1499 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1500 passed to subdirectory makes.
1504 Perl binary for tasks that can be done by miniperl
1508 The call to the program that is able to compile perlmain.c. Defaults
1513 Same as above for architecture dependent files
1517 Directory containing the Perl library to use.
1521 Directory containing the Perl source code (use of this should be
1522 avoided, it may be undefined)
1526 Ref to hash of files to be processed as perl programs. MakeMaker
1527 will default to any found *.PL file (except Makefile.PL) being keys
1528 and the basename of the file being the value. E.g.
1530 {'foobar.PL' => 'foobar'}
1532 The *.PL files are expected to produce output to the target files
1537 Hashref of .pm files and *.pl files to be installed. e.g.
1539 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1541 By default this will include *.pm and *.pl and the files found in
1542 the PMLIBDIRS directories. Defining PM in the
1543 Makefile.PL will override PMLIBDIRS.
1547 Ref to array of subdirectories containing library files. Defaults to
1548 [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
1549 they contain will be installed in the corresponding location in the
1550 library. A libscan() method can be used to alter the behaviour.
1551 Defining PM in the Makefile.PL will override PMLIBDIRS.
1555 Can be used to set the three INSTALL* attributes in one go (except for
1556 probably INSTALLMAN1DIR, if it is not below PREFIX according to
1557 %Config). They will have PREFIX as a common directory node and will
1558 branch from that node into lib/, lib/ARCHNAME or whatever Configure
1559 decided at the build time of your perl (unless you override one of
1564 Hashref: Names of modules that need to be available to run this
1565 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1566 desired version is the value. If the required version number is 0, we
1567 only check if any version is installed already.
1571 Arryref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1572 Makefile. Caution! Do not use the SKIP attribute for the neglectible
1573 speedup. It may seriously damage the resulting Makefile. Only use it,
1574 if you really need it.
1578 Ref to array of typemap file names. Use this when the typemaps are
1579 in some directory other than the current directory or when they are
1580 not named B<typemap>. The last typemap in the list takes
1581 precedence. A typemap in the current directory has highest
1582 precedence, even if it isn't listed in TYPEMAPS. The default system
1583 typemap has lowest precedence.
1587 Your version number for distributing the package. This defaults to
1592 Instead of specifying the VERSION in the Makefile.PL you can let
1593 MakeMaker parse a file to determine the version number. The parsing
1594 routine requires that the file named by VERSION_FROM contains one
1595 single line to compute the version number. The first line in the file
1596 that contains the regular expression
1598 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
1600 will be evaluated with eval() and the value of the named variable
1601 B<after> the eval() will be assigned to the VERSION attribute of the
1602 MakeMaker object. The following lines will be parsed o.k.:
1606 ( $VERSION ) = '$Revision: 1.216 $ ' =~ /\$Revision:\s+([^\s]+)/;
1607 $FOO::VERSION = '1.10';
1608 *FOO::VERSION = \'1.11';
1610 but these will fail:
1612 my $VERSION = '1.01';
1613 local $VERSION = '1.02';
1614 local $FOO::VERSION = '1.30';
1616 The file named in VERSION_FROM is not added as a dependency to
1617 Makefile. This is not really correct, but it would be a major pain
1618 during development to have to rewrite the Makefile for any smallish
1619 change in that file. If you want to make sure that the Makefile
1620 contains the correct VERSION macro after any change of the file, you
1621 would have to do something like
1623 depend => { Makefile => '$(VERSION_FROM)' }
1625 See attribute C<depend> below.
1629 Hashref of .xs files. MakeMaker will default this. e.g.
1631 {'name_of_file.xs' => 'name_of_file.c'}
1633 The .c files will automatically be included in the list of files
1634 deleted by a make clean.
1638 String of options to pass to xsubpp. This might include C<-C++> or
1639 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
1644 May be set to an empty string, which is identical to C<-prototypes>, or
1645 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
1646 defaults to the empty string.
1650 Your version number for the .xs file of this package. This defaults
1651 to the value of the VERSION attribute.
1655 =head2 Additional lowercase attributes
1657 can be used to pass parameters to the methods which implement that
1658 part of the Makefile.
1664 {FILES => "*.xyz foo"}
1668 {ANY_TARGET => ANY_DEPENDECY, ...}
1672 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => 'gz',
1673 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
1674 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
1676 If you specify COMPRESS, then SUFFIX should also be altered, as it is
1677 needed to tell make the target file of the compression. Setting
1678 DIST_CP to ln can be useful, if you need to preserve the timestamps on
1679 your files. DIST_CP can take the values 'cp', which copies the file,
1680 'ln', which links the file, and 'best' which copies symbolic links and
1681 links the rest. Default is 'best'.
1685 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
1689 Deprecated as of MakeMaker 5.23. See L<ExtUtils::MM_Unix/pm_to_blib>.
1693 {LINKTYPE => 'static', 'dynamic' or ''}
1695 NB: Extensions that have nothing but *.pm files had to say
1699 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1700 can be deleted safely. MakeMaker recognizes, when there's nothing to
1705 {ANY_MACRO => ANY_VALUE, ...}
1709 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
1711 =item tool_autosplit
1719 # bug in pod2html, so leave the =back
1721 # Don't delete this cut, MM depends on it!
1723 =head2 Overriding MakeMaker Methods
1725 If you cannot achieve the desired Makefile behaviour by specifying
1726 attributes you may define private subroutines in the Makefile.PL.
1727 Each subroutines returns the text it wishes to have written to
1728 the Makefile. To override a section of the Makefile you can
1731 sub MY::c_o { "new literal text" }
1733 or you can edit the default by saying something like:
1736 package MY; # so that "SUPER" works right
1737 my $inherited = shift->SUPER::c_o(@_);
1738 $inherited =~ s/old text/new text/;
1742 If you running experiments with embedding perl as a library into other
1743 applications, you might find MakeMaker not sufficient. You'd better
1744 have a look at ExtUtils::embed which is a collection of utilities for
1747 If you still need a different solution, try to develop another
1748 subroutine, that fits your needs and submit the diffs to
1749 F<perl5-porters@nicoh.com> or F<comp.lang.perl.misc> as appropriate.
1751 For a complete description of all MakeMaker methods see L<ExtUtils::MM_Unix>.
1753 Here is a simple example of how to add a new target to the generated
1758 $(MYEXTLIB): sdbm/Makefile
1759 cd sdbm && $(MAKE) all
1764 =head2 Hintsfile support
1766 MakeMaker.pm uses the architecture specific information from
1767 Config.pm. In addition it evaluates architecture specific hints files
1768 in a C<hints/> directory. The hints files are expected to be named
1769 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
1770 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
1771 MakeMaker within the WriteMakefile() subroutine, and can be used to
1772 execute commands as well as to include special variables. The rules
1773 which hintsfile is chosen are the same as in Configure.
1775 The hintsfile is eval()ed immediately after the arguments given to
1776 WriteMakefile are stuffed into a hash reference $self but before this
1777 reference becomes blessed. So if you want to do the equivalent to
1778 override or create an attribute you would say something like
1780 $self->{LIBS} = ['-ldbm -lucb -lc'];
1782 =head2 Distribution Support
1784 For authors of extensions MakeMaker provides several Makefile
1785 targets. Most of the support comes from the ExtUtils::Manifest module,
1786 where additional documentation can be found.
1790 =item make distcheck
1792 reports which files are below the build directory but not in the
1793 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
1796 =item make skipcheck
1798 reports which files are skipped due to the entries in the
1799 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
1802 =item make distclean
1804 does a realclean first and then the distcheck. Note that this is not
1805 needed to build a new distribution as long as you are sure, that the
1806 MANIFEST file is ok.
1810 rewrites the MANIFEST file, adding all remaining files found (See
1811 ExtUtils::Manifest::mkmanifest() for details)
1815 Copies all the files that are in the MANIFEST file to a newly created
1816 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
1817 exists, it will be removed first.
1821 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
1822 a make test in that directory.
1826 First does a distdir. Then a command $(PREOP) which defaults to a null
1827 command, followed by $(TOUNIX), which defaults to a null command under
1828 UNIX, and will convert files in distribution directory to UNIX format
1829 otherwise. Next it runs C<tar> on that directory into a tarfile and
1830 deletes the directory. Finishes with a command $(POSTOP) which
1831 defaults to a null command.
1835 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
1837 =item make uutardist
1839 Runs a tardist first and uuencodes the tarfile.
1843 First does a distdir. Then a command $(PREOP) which defaults to a null
1844 command. Next it runs C<shar> on that directory into a sharfile and
1845 deletes the intermediate directory again. Finishes with a command
1846 $(POSTOP) which defaults to a null command. Note: For shdist to work
1847 properly a C<shar> program that can handle directories is mandatory.
1851 First does a distdir. Then a command $(PREOP) which defaults to a null
1852 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
1853 zipfile. Then deletes that directory. Finishes with a command
1854 $(POSTOP) which defaults to a null command.
1858 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
1862 Customization of the dist targets can be done by specifying a hash
1863 reference to the dist attribute of the WriteMakefile call. The
1864 following parameters are recognized:
1867 COMPRESS ('compress')
1870 TO_UNIX (depends on the system)
1871 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
1881 WriteMakefile( 'dist' => { COMPRESS=>"gzip", SUFFIX=>"gz" })
1883 =head2 Disabling an extension
1885 If some events detected in F<Makefile.PL> imply that there is no way
1886 to create the Module, but this is a normal state of things, then you
1887 can create a F<Makefile> which does nothing, but succeeds on all the
1888 "usual" build targets. To do so, use
1890 ExtUtils::MakeMaker::WriteEmptyMakefile();
1892 instead of WriteMakefile().
1894 This may be useful if other modules expect this module to be I<built>
1895 OK, as opposed to I<work> OK (say, this system-dependent module builds
1896 in a subdirectory of some other distribution, or is listed as a
1897 dependency in a CPAN::Bundle, but the functionality is supported by
1898 different means on the current architecture).
1902 ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib,
1903 ExtUtils::Install, ExtUtils::embed
1907 Andy Dougherty <F<doughera@lafcol.lafayette.edu>>, Andreas KE<ouml>nig
1908 <F<A.Koenig@franz.ww.TU-Berlin.DE>>, Tim Bunce <F<Tim.Bunce@ig.co.uk>>.
1909 VMS support by Charles Bailey <F<bailey@genetics.upenn.edu>>. OS/2
1910 support by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>. Contact the
1911 makemaker mailing list C<mailto:makemaker@franz.ww.tu-berlin.de>, if
1912 you have any questions.