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.4002";
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.211 $, 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.";
541 print STDOUT "Checking if your kit is complete...\n";
542 require ExtUtils::Manifest;
543 $ExtUtils::Manifest::Quiet=$ExtUtils::Manifest::Quiet=1; #avoid warning
544 my(@missed)=ExtUtils::Manifest::manicheck();
546 print STDOUT "Warning: the following files are missing in your kit:\n";
547 print "\t", join "\n\t", @missed;
549 print STDOUT "Please inform the author.\n";
551 print STDOUT "Looks good\n";
556 my($self, @args) = @_;
558 unless (m/(.*?)=(.*)/){
559 help(),exit 1 if m/^help$/;
560 ++$Verbose if m/^verb/;
563 my($name, $value) = ($1, $2);
564 if ($value =~ m/^~(\w+)?/){ # tilde with optional username
565 $value =~ s [^~(\w*)]
567 ((getpwnam($1))[7] || "~$1") :
571 $self->{uc($name)} = $value;
574 # catch old-style 'potential_libs' and inform user how to 'upgrade'
575 if (defined $self->{potential_libs}){
576 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
577 if ($self->{potential_libs}){
578 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
580 print STDOUT "$msg deleted.\n";
582 $self->{LIBS} = [$self->{potential_libs}];
583 delete $self->{potential_libs};
585 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
586 if (defined $self->{ARMAYBE}){
587 my($armaybe) = $self->{ARMAYBE};
588 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
589 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
590 my(%dl) = %{$self->{dynamic_lib} || {}};
591 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
592 delete $self->{ARMAYBE};
594 if (defined $self->{LDTARGET}){
595 print STDOUT "LDTARGET should be changed to LDFROM\n";
596 $self->{LDFROM} = $self->{LDTARGET};
597 delete $self->{LDTARGET};
599 # Turn a DIR argument on the command line into an array
600 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
601 # So they can choose from the command line, which extensions they want
602 # the grep enables them to have some colons too much in case they
603 # have to build a list with the shell
604 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
606 # Turn a INCLUDE_EXT argument on the command line into an array
607 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
608 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
610 # Turn a EXCLUDE_EXT argument on the command line into an array
611 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
612 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
615 foreach $mmkey (sort keys %$self){
616 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
617 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
618 unless exists $Recognized_Att_Keys{$mmkey};
625 # We allow extension-specific hints files.
627 return unless -d "hints";
629 # First we look for the best hintsfile we have
631 my($hint)="${^O}_$Config{osvers}";
636 # Also try without trailing minor version numbers.
638 last if -f "hints/$hint.pl"; # found
640 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
642 return unless -f "hints/$hint.pl"; # really there
644 # execute the hintsfile:
646 # my $fh = new FileHandle;
647 # $fh->open("hints/$hint.pl");
649 open(FH,"hints/$hint.pl");
650 # @goodhints = <$fh>;
654 print STDOUT "Processing hints file hints/$hint.pl\n";
655 eval join('',@goodhints);
656 print STDOUT $@ if $@;
662 my($symtab) = \%{"${from}::"};
665 # Here you see the *current* list of methods that are overridable
666 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
667 # still trying to reduce the list to some reasonable minimum --
668 # because I want to make it easier for the user. A.K.
670 foreach $method (@Overridable) {
672 # We cannot say "next" here. Nick might call MY->makeaperl
673 # which isn't defined right now
675 # Above statement was written at 4.23 time when Tk-b8 was
676 # around. As Tk-b9 only builds with 5.002something and MM 5 is
677 # standard, we try to enable the next line again. It was
678 # commented out until MM 5.23
680 next unless defined &{"${from}::$method"};
682 *{"${to}::$method"} = \&{"${from}::$method"};
684 # delete would do, if we were sure, nobody ever called
685 # MY->makeaperl directly
687 # delete $symtab->{$method};
689 # If we delete a method, then it will be undefined and cannot
690 # be called. But as long as we have Makefile.PLs that rely on
691 # %MY:: being intact, we have to fill the hole with an
694 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
697 # We have to clean out %INC also, because the current directory is
698 # changed frequently and Graham Barr prefers to get his version
699 # out of a History.pl file which is "required" so woudn't get
700 # loaded again in another extension requiring a History.pl
702 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
703 # to core dump in the middle of a require statement. The required
704 # file was Tk/MMutil.pm. The consequence is, we have to be
705 # extremely careful when we try to give perl a reason to reload a
706 # library with same name. The workaround prefers to drop nothing
707 # from %INC and teach the writers not to use such libraries.
710 # foreach $inc (keys %INC) {
711 # #warn "***$inc*** deleted";
719 if ($section eq 'dynamic') {
720 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
721 "in skipped section 'dynamic_bs'\n"
722 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
723 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
724 "in skipped section 'dynamic_lib'\n"
725 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
727 if ($section eq 'dynamic_lib') {
728 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
729 "targets in skipped section 'dynamic_bs'\n"
730 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
732 if ($section eq 'static') {
733 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
734 "in skipped section 'static_lib'\n"
735 if $self->{SKIPHASH}{static_lib} && $Verbose;
737 return 'skipped' if $self->{SKIPHASH}{$section};
745 # my $fh = new FileHandle;
747 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
749 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
750 # $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
751 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
753 for $chunk (@{$self->{RESULT}}) {
754 # print $fh "$chunk\n";
760 my($finalname) = $self->{MAKEFILE};
761 rename("MakeMaker.tmp", $finalname);
762 chmod 0644, $finalname unless $Is_VMS;
764 if ($self->{PARENT}) {
765 foreach (keys %$self) { # safe memory
766 delete $self->{$_} unless $Keep_after_flush{$_};
770 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
773 # The following mkbootstrap() is only for installations that are calling
774 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
775 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
778 !!! Your Makefile has been built such a long time ago, !!!
779 !!! that is unlikely to work with current MakeMaker. !!!
780 !!! Please rebuild your Makefile !!!
784 # Ditto for mksymlists() as of MakeMaker 5.17
787 !!! Your Makefile has been built such a long time ago, !!!
788 !!! that is unlikely to work with current MakeMaker. !!!
789 !!! Please rebuild your Makefile !!!
795 return "undef" unless defined $v;
797 return "q[$v]" unless $t;
799 my(@m, $elem, @neat);
801 foreach $elem (@$v) {
802 push @neat, "q[$elem]";
804 push @m, join ", ", @neat;
808 return "$v" unless $t eq 'HASH';
810 while (($key,$val) = each %$v){
811 last unless defined $key; # cautious programming in case (undef,undef) is true
812 push(@m,"$key=>".neatvalue($val)) ;
814 return "{ ".join(', ',@m)." }";
821 push @m, "\n# Full list of MakeMaker attribute values:";
822 foreach $key (sort keys %$self){
823 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
824 my($v) = neatvalue($self->{$key});
825 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
827 push @m, "# $key => $v";
833 package ExtUtils::MakeMaker;
840 ExtUtils::MakeMaker - create an extension Makefile
844 C<use ExtUtils::MakeMaker;>
846 C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
850 C<MM-E<gt>new(\%att)-E<gt>flush;>
854 This utility is designed to write a Makefile for an extension module
855 from a Makefile.PL. It is based on the Makefile.SH model provided by
856 Andy Dougherty and the perl5-porters.
858 It splits the task of generating the Makefile into several subroutines
859 that can be individually overridden. Each subroutine returns the text
860 it wishes to have written to the Makefile.
862 MakeMaker is object oriented. Each directory below the current
863 directory that contains a Makefile.PL. Is treated as a separate
864 object. This makes it possible to write an unlimited number of
865 Makefiles with a single invocation of WriteMakefile().
867 =head2 How To Write A Makefile.PL
869 The short answer is: Don't.
871 Always begin with h2xs.
872 Always begin with h2xs!
873 ALWAYS BEGIN WITH H2XS!
875 even if you're not building around a header file, and even if you
876 don't have an XS component.
878 Run h2xs(1) before you start thinking about writing a module. For so
879 called pm-only modules that consist of C<*.pm> files only, h2xs has
880 the C<-X> switch. This will generate dummy files of all kinds that are
881 useful for the module developer.
883 The medium answer is:
885 use ExtUtils::MakeMaker;
886 WriteMakefile( NAME => "Foo::Bar" );
888 The long answer is the rest of the manpage :-)
890 =head2 Default Makefile Behaviour
892 The generated Makefile enables the user of the extension to invoke
894 perl Makefile.PL # optionally "perl Makefile.PL verbose"
896 make test # optionally set TEST_VERBOSE=1
897 make install # See below
899 The Makefile to be produced may be altered by adding arguments of the
900 form C<KEY=VALUE>. E.g.
902 perl Makefile.PL PREFIX=/tmp/myperl5
904 Other interesting targets in the generated Makefile are
906 make config # to check if the Makefile is up-to-date
907 make clean # delete local temp files (Makefile gets renamed)
908 make realclean # delete derived files (including ./blib)
909 make ci # check in all the files in the MANIFEST file
910 make dist # see below the Distribution Support section
914 MakeMaker checks for the existence of a file named F<test.pl> in the
915 current directory and if it exists it adds commands to the test target
916 of the generated Makefile that will execute the script with the proper
917 set of perl C<-I> options.
919 MakeMaker also checks for any files matching glob("t/*.t"). It will
920 add commands to the test target of the generated Makefile that execute
921 all matching files via the L<Test::Harness> module with the C<-I>
922 switches set correctly.
926 A useful variation of the above is the target C<testdb>. It runs the
927 test under the Perl debugger (see L<perldebug>). If the file
928 F<test.pl> exists in the current directory, it is used for the test.
930 If you want to debug some other testfile, set C<TEST_FILE> variable
933 make testdb TEST_FILE=t/mytest.t
935 By default the debugger is called using C<-d> option to perl. If you
936 want to specify some other option, set C<TESTDB_SW> variable:
938 make testdb TESTDB_SW=-Dx
942 make alone puts all relevant files into directories that are named by
943 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_MAN1DIR, and
944 INST_MAN3DIR. All these default to something below ./blib if you are
945 I<not> building below the perl source directory. If you I<are>
946 building below the perl source, INST_LIB and INST_ARCHLIB default to
947 ../../lib, and INST_SCRIPT is not defined.
949 The I<install> target of the generated Makefile copies the files found
950 below each of the INST_* directories to their INSTALL*
951 counterparts. Which counterparts are chosen depends on the setting of
952 INSTALLDIRS according to the following table:
957 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH
958 INST_LIB INSTALLPRIVLIB INSTALLSITELIB
960 INST_SCRIPT INSTALLSCRIPT
961 INST_MAN1DIR INSTALLMAN1DIR
962 INST_MAN3DIR INSTALLMAN3DIR
964 The INSTALL... macros in turn default to their %Config
965 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
967 You can check the values of these variables on your system with
971 And to check the sequence in which the library directories are
972 searched by perl, run
974 perl -le 'print join $/, @INC'
977 =head2 PREFIX and LIB attribute
979 PREFIX and LIB can be used to set several INSTALL* attributes in one
980 go. The quickest way to install a module in a non-standard place might
983 perl Makefile.PL LIB=~/lib
985 This will install the module's architecture-independent files into
986 ~/lib, the architecture-dependent files into ~/lib/$archname/auto.
988 Another way to specify many INSTALL directories with a single
991 perl Makefile.PL PREFIX=~
993 This will replace the string specified by $Config{prefix} in all
994 $Config{install*} values.
996 Note, that in both cases the tilde expansion is done by MakeMaker, not
997 by perl by default, nor by make. Conflicts between parmeters LIB,
998 PREFIX and the various INSTALL* arguments are resolved so that
1001 If the user has superuser privileges, and is not working on AFS
1002 (Andrew File System) or relatives, then the defaults for
1003 INSTALLPRIVLIB, INSTALLARCHLIB, INSTALLSCRIPT, etc. will be appropriate,
1004 and this incantation will be the best:
1006 perl Makefile.PL; make; make test
1009 make install per default writes some documentation of what has been
1010 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1011 can be bypassed by calling make pure_install.
1015 will have to specify the installation directories as these most
1016 probably have changed since perl itself has been installed. They will
1017 have to do this by calling
1019 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1020 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1023 Be careful to repeat this procedure every time you recompile an
1024 extension, unless you are sure the AFS installation directories are
1027 =head2 Static Linking of a new Perl Binary
1029 An extension that is built with the above steps is ready to use on
1030 systems supporting dynamic loading. On systems that do not support
1031 dynamic loading, any newly created extension has to be linked together
1032 with the available resources. MakeMaker supports the linking process
1033 by creating appropriate targets in the Makefile whenever an extension
1034 is built. You can invoke the corresponding section of the makefile with
1038 That produces a new perl binary in the current directory with all
1039 extensions linked in that can be found in INST_ARCHLIB , SITELIBEXP,
1040 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1041 UNIX, this is called Makefile.aperl (may be system dependent). If you
1042 want to force the creation of a new perl, it is recommended, that you
1043 delete this Makefile.aperl, so the directories are searched-through
1044 for linkable libraries again.
1046 The binary can be installed into the directory where perl normally
1047 resides on your machine with
1051 To produce a perl binary with a different name than C<perl>, either say
1053 perl Makefile.PL MAP_TARGET=myperl
1060 make myperl MAP_TARGET=myperl
1061 make inst_perl MAP_TARGET=myperl
1063 In any case you will be prompted with the correct invocation of the
1064 C<inst_perl> target that installs the new binary into INSTALLBIN.
1066 make inst_perl per default writes some documentation of what has been
1067 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1068 can be bypassed by calling make pure_inst_perl.
1070 Warning: the inst_perl: target will most probably overwrite your
1071 existing perl binary. Use with care!
1073 Sometimes you might want to build a statically linked perl although
1074 your system supports dynamic loading. In this case you may explicitly
1075 set the linktype with the invocation of the Makefile.PL or make:
1077 perl Makefile.PL LINKTYPE=static # recommended
1081 make LINKTYPE=static # works on most systems
1083 =head2 Determination of Perl Library and Installation Locations
1085 MakeMaker needs to know, or to guess, where certain things are
1086 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1087 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1088 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1090 Extensions may be built either using the contents of the perl source
1091 directory tree or from the installed perl library. The recommended way
1092 is to build extensions after you have run 'make install' on perl
1093 itself. You can do that in any directory on your hard disk that is not
1094 below the perl source tree. The support for extensions below the ext
1095 directory of the perl distribution is only good for the standard
1096 extensions that come with perl.
1098 If an extension is being built below the C<ext/> directory of the perl
1099 source then MakeMaker will set PERL_SRC automatically (e.g.,
1100 C<../..>). If PERL_SRC is defined and the extension is recognized as
1101 a standard extension, then other variables default to the following:
1104 PERL_LIB = PERL_SRC/lib
1105 PERL_ARCHLIB = PERL_SRC/lib
1107 INST_ARCHLIB = PERL_ARCHLIB
1109 If an extension is being built away from the perl source then MakeMaker
1110 will leave PERL_SRC undefined and default to using the installed copy
1111 of the perl library. The other variables default to the following:
1113 PERL_INC = $archlibexp/CORE
1114 PERL_LIB = $privlibexp
1115 PERL_ARCHLIB = $archlibexp
1116 INST_LIB = ./blib/lib
1117 INST_ARCHLIB = ./blib/arch
1119 If perl has not yet been installed then PERL_SRC can be defined on the
1120 command line as shown in the previous section.
1123 =head2 Which architecture dependent directory?
1125 If you don't want to keep the defaults for the INSTALL* macros,
1126 MakeMaker helps you to minimize the typing needed: the usual
1127 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1128 by Configure at perl compilation time. MakeMaker supports the user who
1129 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1130 then MakeMaker defaults the latter to be the same subdirectory of
1131 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1132 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1133 for INSTALLSITELIB and INSTALLSITEARCH.
1135 MakeMaker gives you much more freedom than needed to configure
1136 internal variables and get different results. It is worth to mention,
1137 that make(1) also lets you configure most of the variables that are
1138 used in the Makefile. But in the majority of situations this will not
1139 be necessary, and should only be done, if the author of a package
1140 recommends it (or you know what you're doing).
1142 =head2 Using Attributes and Parameters
1144 The following attributes can be specified as arguments to WriteMakefile()
1145 or as NAME=VALUE pairs on the command line:
1149 # The following "=item C" is used by the attrib_help routine
1150 # likewise the "=back" below. So be careful when changing it!
1156 Ref to array of *.c file names. Initialised from a directory scan
1157 and the values portion of the XS attribute hash. This is not
1158 currently used by MakeMaker but may be handy in Makefile.PLs.
1162 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1163 config.sh. MakeMaker will add to CONFIG the following values anyway:
1183 CODE reference. The subroutine should return a hash reference. The
1184 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1185 be determined by some evaluation method.
1189 Something like C<"-DHAVE_UNISTD_H">
1193 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1198 Your name for distributing the package (by tar file). This defaults to
1203 Hashref of symbol names for routines to be made available as
1204 universal symbols. Each key/value pair consists of the package name
1205 and an array of routine names in that package. Used only under AIX
1206 (export lists) and VMS (linker options) at present. The routine
1207 names supplied will be expanded in the same way as XSUB names are
1208 expanded by the XS() macro. Defaults to
1210 {"$(NAME)" => ["boot_$(NAME)" ] }
1214 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1215 "NetconfigPtr" => [ 'DESTROY'] }
1219 Array of symbol names for variables to be made available as
1220 universal symbols. Used only under AIX (export lists) and VMS
1221 (linker options) at present. Defaults to []. (e.g. [ qw(
1222 Foo_version Foo_numstreams Foo_tree ) ])
1226 Array of extension names to exclude when doing a static build. This
1227 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1228 details. (e.g. [ qw( Socket POSIX ) ] )
1230 This attribute may be most useful when specified as a string on the
1231 commandline: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1235 Ref to array of executable files. The files will be copied to the
1236 INST_SCRIPT directory. Make realclean will delete them from there
1241 In general any generated Makefile checks for the current version of
1242 MakeMaker and the version the Makefile was built under. If NO_VC is
1243 set, the version check is neglected. Do not write this into your
1244 Makefile.PL, use it interactively instead.
1246 =item FIRST_MAKEFILE
1248 The name of the Makefile to be produced. Defaults to the contents of
1249 MAKEFILE, but can be overridden. This is used for the second Makefile
1250 that will be produced for the MAP_TARGET.
1254 Perl binary able to run this extension.
1258 Ref to array of *.h file names. Similar to C.
1262 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1266 Array of extension names to be included when doing a static build.
1267 MakeMaker will normally build with all of the installed extensions when
1268 doing a static build, and that is usually the desired behavior. If
1269 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1270 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1272 It is not necessary to mention DynaLoader or the current extension when
1273 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1274 only DynaLoader and the current extension will be included in the build.
1276 This attribute may be most useful when specified as a string on the
1277 commandline: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1279 =item INSTALLARCHLIB
1281 Used by 'make install', which copies files from INST_ARCHLIB to this
1282 directory if INSTALLDIRS is set to perl.
1286 Directory to install binary files (e.g. tkperl) into.
1290 Determines which of the two sets of installation directories to
1291 choose: installprivlib and installarchlib versus installsitelib and
1292 installsitearch. The first pair is chosen with INSTALLDIRS=perl, the
1293 second with INSTALLDIRS=site. Default is site.
1295 =item INSTALLMAN1DIR
1297 This directory gets the man pages at 'make install' time. Defaults to
1298 $Config{installman1dir}.
1300 =item INSTALLMAN3DIR
1302 This directory gets the man pages at 'make install' time. Defaults to
1303 $Config{installman3dir}.
1305 =item INSTALLPRIVLIB
1307 Used by 'make install', which copies files from INST_LIB to this
1308 directory if INSTALLDIRS is set to perl.
1312 Used by 'make install' which copies files from INST_SCRIPT to this
1315 =item INSTALLSITELIB
1317 Used by 'make install', which copies files from INST_LIB to this
1318 directory if INSTALLDIRS is set to site (default).
1320 =item INSTALLSITEARCH
1322 Used by 'make install', which copies files from INST_ARCHLIB to this
1323 directory if INSTALLDIRS is set to site (default).
1327 Same as INST_LIB for architecture dependent files.
1331 Directory to put real binary files during 'make'. These will be copied
1332 to INSTALLBIN during 'make install'
1336 Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you
1341 Directory where we put library files of this extension while building
1346 Directory to hold the man pages at 'make' time
1350 Directory to hold the man pages at 'make' time
1354 Directory, where executable files should be installed during
1355 'make'. Defaults to "./blib/bin", just to have a dummy location during
1356 testing. make install will copy the files in INST_SCRIPT to
1361 defaults to "$(OBJECT)" and is used in the ld command to specify
1362 what files to link/load from (also see dynamic_lib below for how to
1367 The filename of the perllibrary that will be used together with this
1368 extension. Defaults to libperl.a.
1372 LIB can only be set at C<perl Makefile.PL> time. It has the effect of
1373 setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any
1377 An anonymous array of alternative library
1378 specifications to be searched for (in order) until
1379 at least one library is found. E.g.
1381 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1383 Mind, that any element of the array
1384 contains a complete set of arguments for the ld
1385 command. So do not specify
1387 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1389 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1390 you specify a scalar as in
1392 'LIBS' => "-ltcl -ltk -lX11"
1394 MakeMaker will turn it into an array with one element.
1398 'static' or 'dynamic' (default unless usedl=undef in
1399 config.sh). Should only be used to force static linking (also see
1404 Boolean which tells MakeMaker, that it should include the rules to
1405 make a perl. This is handled automatically as a switch by
1406 MakeMaker. The user normally does not need it.
1410 The name of the Makefile to be produced.
1414 Hashref of pod-containing files. MakeMaker will default this to all
1415 EXE_FILES files that include POD directives. The files listed
1416 here will be converted to man pages and installed as was requested
1421 Hashref of .pm and .pod files. MakeMaker will default this to all
1422 .pod and any .pm files that include POD directives. The files listed
1423 here will be converted to man pages and installed as was requested
1428 If it is intended, that a new perl binary be produced, this variable
1429 may hold a name for that binary. Defaults to perl
1433 If the extension links to a library that it builds set this to the
1434 name of the library (see SDBM_File)
1438 Perl module name for this extension (DBD::Oracle). This will default
1439 to the directory name but should be explicitly defined in the
1444 MakeMaker will figure out, if an extension contains linkable code
1445 anywhere down the directory tree, and will set this variable
1446 accordingly, but you can speed it up a very little bit, if you define
1447 this boolean variable yourself.
1451 Defaults to C<@>. By setting it to an empty string you can generate a
1452 Makefile that echos all commands. Mainly used in debugging MakeMaker
1457 Boolean. Attribute to inhibit descending into subdirectories.
1461 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1462 string containing all object files, e.g. "tkpBind.o
1463 tkpButton.o tkpCanvas.o"
1467 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1468 passed to subdirectory makes.
1472 Perl binary for tasks that can be done by miniperl
1476 The call to the program that is able to compile perlmain.c. Defaults
1481 Same as above for architecture dependent files
1485 Directory containing the Perl library to use.
1489 Directory containing the Perl source code (use of this should be
1490 avoided, it may be undefined)
1494 Ref to hash of files to be processed as perl programs. MakeMaker
1495 will default to any found *.PL file (except Makefile.PL) being keys
1496 and the basename of the file being the value. E.g.
1498 {'foobar.PL' => 'foobar'}
1500 The *.PL files are expected to produce output to the target files
1505 Hashref of .pm files and *.pl files to be installed. e.g.
1507 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1509 By default this will include *.pm and *.pl. If a lib directory
1510 exists and is not listed in DIR (above) then any *.pm and *.pl files
1511 it contains will also be included by default. Defining PM in the
1512 Makefile.PL will override PMLIBDIRS.
1516 Ref to array of subdirectories containing library files. Defaults to
1517 [ 'lib', $(BASEEXT) ]. The directories will be scanned and any files
1518 they contain will be installed in the corresponding location in the
1519 library. A libscan() method can be used to alter the behaviour.
1520 Defining PM in the Makefile.PL will override PMLIBDIRS.
1524 Can be used to set the three INSTALL* attributes in one go (except for
1525 probably INSTALLMAN1DIR, if it is not below PREFIX according to
1526 %Config). They will have PREFIX as a common directory node and will
1527 branch from that node into lib/, lib/ARCHNAME or whatever Configure
1528 decided at the build time of your perl (unless you override one of
1533 Hashref: Names of modules that need to be available to run this
1534 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1535 desired version is the value. If the required version number is 0, we
1536 only check if any version is installed already.
1540 Arryref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1541 Makefile. Caution! Do not use the SKIP attribute for the neglectible
1542 speedup. It may seriously damage the resulting Makefile. Only use it,
1543 if you really need it.
1547 Ref to array of typemap file names. Use this when the typemaps are
1548 in some directory other than the current directory or when they are
1549 not named B<typemap>. The last typemap in the list takes
1550 precedence. A typemap in the current directory has highest
1551 precedence, even if it isn't listed in TYPEMAPS. The default system
1552 typemap has lowest precedence.
1556 Your version number for distributing the package. This defaults to
1561 Instead of specifying the VERSION in the Makefile.PL you can let
1562 MakeMaker parse a file to determine the version number. The parsing
1563 routine requires that the file named by VERSION_FROM contains one
1564 single line to compute the version number. The first line in the file
1565 that contains the regular expression
1567 /\$(([\w\:\']*)\bVERSION)\b.*\=/
1569 will be evaluated with eval() and the value of the named variable
1570 B<after> the eval() will be assigned to the VERSION attribute of the
1571 MakeMaker object. The following lines will be parsed o.k.:
1574 ( $VERSION ) = '$Revision: 1.211 $ ' =~ /\$Revision:\s+([^\s]+)/;
1575 $FOO::VERSION = '1.10';
1577 but these will fail:
1579 my $VERSION = '1.01';
1580 local $VERSION = '1.02';
1581 local $FOO::VERSION = '1.30';
1583 The file named in VERSION_FROM is added as a dependency to Makefile to
1584 guarantee, that the Makefile contains the correct VERSION macro after
1585 a change of the file.
1589 Hashref of .xs files. MakeMaker will default this. e.g.
1591 {'name_of_file.xs' => 'name_of_file.c'}
1593 The .c files will automatically be included in the list of files
1594 deleted by a make clean.
1598 String of options to pass to xsubpp. This might include C<-C++> or
1599 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
1604 May be set to an empty string, which is identical to C<-prototypes>, or
1605 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
1606 defaults to the empty string.
1610 Your version number for the .xs file of this package. This defaults
1611 to the value of the VERSION attribute.
1615 =head2 Additional lowercase attributes
1617 can be used to pass parameters to the methods which implement that
1618 part of the Makefile.
1624 {FILES => "*.xyz foo"}
1628 {ANY_TARGET => ANY_DEPENDECY, ...}
1632 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => 'gz',
1633 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
1634 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
1636 If you specify COMPRESS, then SUFFIX should also be altered, as it is
1637 needed to tell make the target file of the compression. Setting
1638 DIST_CP to ln can be useful, if you need to preserve the timestamps on
1639 your files. DIST_CP can take the values 'cp', which copies the file,
1640 'ln', which links the file, and 'best' which copies symbolic links and
1641 links the rest. Default is 'best'.
1645 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
1649 Deprecated as of MakeMaker 5.23. See L<ExtUtils::MM_Unix/pm_to_blib>.
1653 {LINKTYPE => 'static', 'dynamic' or ''}
1655 NB: Extensions that have nothing but *.pm files had to say
1659 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1660 can be deleted safely. MakeMaker recognizes, when there's nothing to
1665 {ANY_MACRO => ANY_VALUE, ...}
1669 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
1671 =item tool_autosplit
1679 # bug in pod2html, so leave the =back
1681 # Don't delete this cut, MM depends on it!
1683 =head2 Overriding MakeMaker Methods
1685 If you cannot achieve the desired Makefile behaviour by specifying
1686 attributes you may define private subroutines in the Makefile.PL.
1687 Each subroutines returns the text it wishes to have written to
1688 the Makefile. To override a section of the Makefile you can
1691 sub MY::c_o { "new literal text" }
1693 or you can edit the default by saying something like:
1696 package MY; # so that "SUPER" works right
1697 my $inherited = shift->SUPER::c_o(@_);
1698 $inherited =~ s/old text/new text/;
1702 If you running experiments with embedding perl as a library into other
1703 applications, you might find MakeMaker not sufficient. You'd better
1704 have a look at ExtUtils::embed which is a collection of utilities for
1707 If you still need a different solution, try to develop another
1708 subroutine, that fits your needs and submit the diffs to
1709 F<perl5-porters@nicoh.com> or F<comp.lang.perl.misc> as appropriate.
1711 For a complete description of all MakeMaker methods see L<ExtUtils::MM_Unix>.
1713 Here is a simple example of how to add a new target to the generated
1718 $(MYEXTLIB): sdbm/Makefile
1719 cd sdbm && $(MAKE) all
1724 =head2 Hintsfile support
1726 MakeMaker.pm uses the architecture specific information from
1727 Config.pm. In addition it evaluates architecture specific hints files
1728 in a C<hints/> directory. The hints files are expected to be named
1729 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
1730 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
1731 MakeMaker within the WriteMakefile() subroutine, and can be used to
1732 execute commands as well as to include special variables. The rules
1733 which hintsfile is chosen are the same as in Configure.
1735 The hintsfile is eval()ed immediately after the arguments given to
1736 WriteMakefile are stuffed into a hash reference $self but before this
1737 reference becomes blessed. So if you want to do the equivalent to
1738 override or create an attribute you would say something like
1740 $self->{LIBS} = ['-ldbm -lucb -lc'];
1742 =head2 Distribution Support
1744 For authors of extensions MakeMaker provides several Makefile
1745 targets. Most of the support comes from the ExtUtils::Manifest module,
1746 where additional documentation can be found.
1750 =item make distcheck
1752 reports which files are below the build directory but not in the
1753 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
1756 =item make skipcheck
1758 reports which files are skipped due to the entries in the
1759 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
1762 =item make distclean
1764 does a realclean first and then the distcheck. Note that this is not
1765 needed to build a new distribution as long as you are sure, that the
1766 MANIFEST file is ok.
1770 rewrites the MANIFEST file, adding all remaining files found (See
1771 ExtUtils::Manifest::mkmanifest() for details)
1775 Copies all the files that are in the MANIFEST file to a newly created
1776 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
1777 exists, it will be removed first.
1781 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
1782 a make test in that directory.
1786 First does a distdir. Then a command $(PREOP) which defaults to a null
1787 command, followed by $(TOUNIX), which defaults to a null command under
1788 UNIX, and will convert files in distribution directory to UNIX format
1789 otherwise. Next it runs C<tar> on that directory into a tarfile and
1790 deletes the directory. Finishes with a command $(POSTOP) which
1791 defaults to a null command.
1795 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
1797 =item make uutardist
1799 Runs a tardist first and uuencodes the tarfile.
1803 First does a distdir. Then a command $(PREOP) which defaults to a null
1804 command. Next it runs C<shar> on that directory into a sharfile and
1805 deletes the intermediate directory again. Finishes with a command
1806 $(POSTOP) which defaults to a null command. Note: For shdist to work
1807 properly a C<shar> program that can handle directories is mandatory.
1811 First does a distdir. Then a command $(PREOP) which defaults to a null
1812 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
1813 zipfile. Then deletes that directory. Finishes with a command
1814 $(POSTOP) which defaults to a null command.
1818 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
1822 Customization of the dist targets can be done by specifying a hash
1823 reference to the dist attribute of the WriteMakefile call. The
1824 following parameters are recognized:
1827 COMPRESS ('compress')
1830 TO_UNIX (depends on the system)
1831 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
1841 WriteMakefile( 'dist' => { COMPRESS=>"gzip", SUFFIX=>"gz" })
1845 ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib,
1846 ExtUtils::Install, ExtUtils::embed
1850 Andy Dougherty <F<doughera@lafcol.lafayette.edu>>, Andreas KE<ouml>nig
1851 <F<A.Koenig@franz.ww.TU-Berlin.DE>>, Tim Bunce <F<Tim.Bunce@ig.co.uk>>.
1852 VMS support by Charles Bailey <F<bailey@genetics.upenn.edu>>. OS/2
1853 support by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>. Contact the
1854 makemaker mailing list C<mailto:makemaker@franz.ww.tu-berlin.de>, if
1855 you have any questions.