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 AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION LICENSE_HREF CAPI
239 C CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
240 EXE_FILES EXCLUDE_EXT INCLUDE_EXT NO_VC FIRST_MAKEFILE FULLPERL H
241 INC INSTALLARCHLIB INSTALLBIN INSTALLDIRS INSTALLMAN1DIR
242 INSTALLMAN3DIR INSTALLPRIVLIB INSTALLSCRIPT INSTALLSITEARCH
243 INSTALLSITELIB INST_ARCHLIB INST_BIN INST_EXE INST_LIB
244 INST_MAN1DIR INST_MAN3DIR INST_SCRIPT LDFROM LIBPERL_A LIB LIBS
245 LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB
246 NAME NEEDS_LINKING NOECHO NORECURS OBJECT OPTIMIZE PERL PERLMAINCC
247 PERL_ARCHLIB PERL_LIB PERL_SRC PL_FILES PM PMLIBDIRS PREFIX
248 PREREQ_PM SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
249 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
257 # IMPORTS is used under OS/2
259 # ^^^ installpm is deprecated, will go about Summer 96
261 # @Overridable is close to @MM_Sections but not identical. The
262 # order is important. Many subroutines declare macros. These
263 # depend on each other. Let's try to collect the macros up front,
264 # then pasthru, then the rules.
266 # MM_Sections are the sections we have to call explicitly
267 # in Overridable we have subroutines that are used indirectly
273 post_initialize const_config constants tool_autosplit tool_xsubpp
274 tools_other dist macro depend cflags const_loadlibs const_cccmd
279 c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs
280 dynamic_lib static static_lib manifypods processPL installbin subdirs
281 clean realclean dist_basics dist_core dist_dir dist_test dist_ci
282 install force perldepend makefile staticmake test ppd
284 ); # loses section ordering
286 @Overridable = @MM_Sections;
287 push @Overridable, qw[
289 dir_target libscan makeaperl needs_linking subdir_x test_via_harness
294 push @MM_Sections, qw[
296 pm_to_blib selfdocument
300 # Postamble needs to be the last that was always the case
301 push @MM_Sections, "postamble";
302 push @Overridable, "postamble";
304 # All sections are valid keys.
305 @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
307 # we will use all these variables in the Makefile
310 ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc
311 lib_ext obj_ext osname osvers ranlib sitelibexp sitearchexp so exe_ext
315 foreach $item (@Attrib_help){
316 $Recognized_Att_Keys{$item} = 1;
318 foreach $item (@Get_from_Config) {
319 $Recognized_Att_Keys{uc $item} = $Config{$item};
320 print "Attribute '\U$item\E' => '$Config{$item}'\n"
325 # When we eval a Makefile.PL in a subdirectory, that one will ask
326 # us (the parent) for the values and will prepend "..", so that
327 # all files to be installed end up below OUR ./blib
332 INST_BIN 1 INST_EXE 1 INST_LIB 1 INST_ARCHLIB 1 INST_SCRIPT
333 1 MAP_TARGET 1 INST_MAN1DIR 1 INST_MAN3DIR 1 PERL_SRC 1
339 NEEDS_LINKING HAS_LINK_CODE
341 @Keep_after_flush{@keep} = (1) x @keep;
347 The extension you are trying to build apparently is rather old and
348 most probably outdated. We detect that from the fact, that a
349 subroutine "writeMakefile" is called, and this subroutine is not
350 supported anymore since about October 1994.
352 Please contact the author or look into CPAN (details about CPAN can be
353 found in the FAQ and at http:/www.perl.com) for a more recent version
354 of the extension. If you're really desperate, you can try to change
355 the subroutine name from writeMakefile to WriteMakefile and rerun
356 'perl Makefile.PL', but you're most probably left alone, when you do
364 sub ExtUtils::MakeMaker::new {
365 my($class,$self) = @_;
368 print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
369 if (-f "MANIFEST" && ! -f "Makefile"){
373 $self = {} unless (defined $self);
377 my(%initial_att) = %$self; # record initial attributes
380 foreach $prereq (sort keys %{$self->{PREREQ_PM}}) {
381 my $eval = "use $prereq $self->{PREREQ_PM}->{$prereq}";
384 warn "Warning: prerequisite $prereq $self->{PREREQ_PM}->{$prereq} not found";
387 # delete $self->{PREREQ_PM}{$prereq};
391 # unless (defined $ExtUtils::MakeMaker::useCPAN) {
392 # print qq{MakeMaker WARNING: prerequisites not found (@unsatisfied)
393 # Please install these modules first and rerun 'perl Makefile.PL'.\n};
394 # if ($ExtUtils::MakeMaker::hasCPAN) {
395 # $ExtUtils::MakeMaker::useCPAN = prompt(qq{Should I try to use the CPAN module to fetch them for you?},"yes");
397 # print qq{Hint: You may want to install the CPAN module to autofetch the needed modules\n};
398 # $ExtUtils::MakeMaker::useCPAN=0;
401 # if ($ExtUtils::MakeMaker::useCPAN) {
403 # CPAN->import(@unsatisfied);
405 # die qq{prerequisites not found (@unsatisfied)};
407 # warn qq{WARNING: prerequisites not found (@unsatisfied)};
410 if (defined $self->{CONFIGURE}) {
411 if (ref $self->{CONFIGURE} eq 'CODE') {
412 $self = { %$self, %{&{$self->{CONFIGURE}}}};
414 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
418 # This is for old Makefiles written pre 5.00, will go away
419 if ( Carp::longmess("") =~ /runsubdirpl/s ){
420 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
423 my $newclass = ++$PACKNAME;
426 print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
427 mv_all_methods("MY",$newclass);
428 bless $self, $newclass;
430 @{"$newclass\:\:ISA"} = 'MM';
433 if (defined $Parent[-2]){
434 $self->{PARENT} = $Parent[-2];
436 for $key (keys %Prepend_dot_dot) {
437 next unless defined $self->{PARENT}{$key};
438 $self->{$key} = $self->{PARENT}{$key};
439 # PERL and FULLPERL may be command verbs instead of full
440 # file specifications under VMS. If so, don't turn them
442 $self->{$key} = $self->catdir("..",$self->{$key})
443 unless $self->file_name_is_absolute($self->{$key})
444 || ($^O eq 'VMS' and ($key =~ /PERL$/ && $self->{$key} =~ /^[\w\-\$]+$/));
446 $self->{PARENT}->{CHILDREN}->{$newclass} = $self if $self->{PARENT};
448 parse_args($self,@ARGV);
451 $self->{NAME} ||= $self->guess_name;
453 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
457 if (! $self->{PERL_SRC} ) {
458 my($pthinks) = $self->canonpath($INC{'Config.pm'});
459 my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
460 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
461 if ($pthinks ne $cthinks &&
462 !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
463 print "Have $pthinks expected $cthinks\n";
465 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
468 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
471 Your perl and your Config.pm seem to have different ideas about the architecture
473 Perl thinks: [$pthinks]
474 Config says: [$Config{archname}]
475 This may or may not cause problems. Please check your installation of perl if you
476 have problems building this extension.
481 $self->init_dirscan();
482 $self->init_others();
484 push @{$self->{RESULT}}, <<END;
485 # This Makefile is for the $self->{NAME} extension to perl.
487 # It was generated automatically by MakeMaker version
488 # $VERSION (Revision: $Revision) from the contents of
489 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
491 # ANY CHANGES MADE HERE WILL BE LOST!
493 # MakeMaker Parameters:
496 foreach $key (sort keys %initial_att){
497 my($v) = neatvalue($initial_att{$key});
498 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
500 push @{$self->{RESULT}}, "# $key => $v";
503 # turn the SKIP array into a SKIPHASH hash
505 for $skip (@{$self->{SKIP} || []}) {
506 $self->{SKIPHASH}{$skip} = 1;
508 delete $self->{SKIP}; # free memory
510 if ($self->{PARENT}) {
511 for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
512 $self->{SKIPHASH}{$_} = 1;
516 # We run all the subdirectories now. They don't have much to query
517 # from the parent, but the parent has to query them: if they need linking!
518 unless ($self->{NORECURS}) {
519 $self->eval_in_subdirs if @{$self->{DIR}};
523 foreach $section ( @MM_Sections ){
524 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
525 my($skipit) = $self->skipcheck($section);
527 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
529 my(%a) = %{$self->{$section} || {}};
530 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
531 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
532 push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
536 push @{$self->{RESULT}}, "\n# End.";
542 sub WriteEmptyMakefile {
543 if (-f 'Makefile.old') {
544 chmod 0666, 'Makefile.old';
545 unlink 'Makefile.old' or warn "unlink Makefile.old: $!";
547 rename 'Makefile', 'Makefile.old' or warn "rename Makefile Makefile.old: $!"
549 open MF, '> Makefile' or die "open Makefile for write: $!";
562 close MF or die "close Makefile for write: $!";
566 print STDOUT "Checking if your kit is complete...\n";
567 require ExtUtils::Manifest;
568 $ExtUtils::Manifest::Quiet=$ExtUtils::Manifest::Quiet=1; #avoid warning
569 my(@missed)=ExtUtils::Manifest::manicheck();
571 print STDOUT "Warning: the following files are missing in your kit:\n";
572 print "\t", join "\n\t", @missed;
574 print STDOUT "Please inform the author.\n";
576 print STDOUT "Looks good\n";
581 my($self, @args) = @_;
583 unless (m/(.*?)=(.*)/){
584 help(),exit 1 if m/^help$/;
585 ++$Verbose if m/^verb/;
588 my($name, $value) = ($1, $2);
589 if ($value =~ m/^~(\w+)?/){ # tilde with optional username
590 $value =~ s [^~(\w*)]
592 ((getpwnam($1))[7] || "~$1") :
596 $self->{uc($name)} = $value;
599 # catch old-style 'potential_libs' and inform user how to 'upgrade'
600 if (defined $self->{potential_libs}){
601 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
602 if ($self->{potential_libs}){
603 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
605 print STDOUT "$msg deleted.\n";
607 $self->{LIBS} = [$self->{potential_libs}];
608 delete $self->{potential_libs};
610 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
611 if (defined $self->{ARMAYBE}){
612 my($armaybe) = $self->{ARMAYBE};
613 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
614 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
615 my(%dl) = %{$self->{dynamic_lib} || {}};
616 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
617 delete $self->{ARMAYBE};
619 if (defined $self->{LDTARGET}){
620 print STDOUT "LDTARGET should be changed to LDFROM\n";
621 $self->{LDFROM} = $self->{LDTARGET};
622 delete $self->{LDTARGET};
624 # Turn a DIR argument on the command line into an array
625 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
626 # So they can choose from the command line, which extensions they want
627 # the grep enables them to have some colons too much in case they
628 # have to build a list with the shell
629 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
631 # Turn a INCLUDE_EXT argument on the command line into an array
632 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
633 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
635 # Turn a EXCLUDE_EXT argument on the command line into an array
636 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
637 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
640 foreach $mmkey (sort keys %$self){
641 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
642 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
643 unless exists $Recognized_Att_Keys{$mmkey};
650 # We allow extension-specific hints files.
652 return unless -d "hints";
654 # First we look for the best hintsfile we have
656 my($hint)="${^O}_$Config{osvers}";
661 # Also try without trailing minor version numbers.
663 last if -f "hints/$hint.pl"; # found
665 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
667 return unless -f "hints/$hint.pl"; # really there
669 # execute the hintsfile:
671 # my $fh = new FileHandle;
672 # $fh->open("hints/$hint.pl");
674 open(FH,"hints/$hint.pl");
675 # @goodhints = <$fh>;
679 print STDOUT "Processing hints file hints/$hint.pl\n";
680 eval join('',@goodhints);
681 print STDOUT $@ if $@;
687 my($symtab) = \%{"${from}::"};
690 # Here you see the *current* list of methods that are overridable
691 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
692 # still trying to reduce the list to some reasonable minimum --
693 # because I want to make it easier for the user. A.K.
695 foreach $method (@Overridable) {
697 # We cannot say "next" here. Nick might call MY->makeaperl
698 # which isn't defined right now
700 # Above statement was written at 4.23 time when Tk-b8 was
701 # around. As Tk-b9 only builds with 5.002something and MM 5 is
702 # standard, we try to enable the next line again. It was
703 # commented out until MM 5.23
705 next unless defined &{"${from}::$method"};
707 *{"${to}::$method"} = \&{"${from}::$method"};
709 # delete would do, if we were sure, nobody ever called
710 # MY->makeaperl directly
712 # delete $symtab->{$method};
714 # If we delete a method, then it will be undefined and cannot
715 # be called. But as long as we have Makefile.PLs that rely on
716 # %MY:: being intact, we have to fill the hole with an
719 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
722 # We have to clean out %INC also, because the current directory is
723 # changed frequently and Graham Barr prefers to get his version
724 # out of a History.pl file which is "required" so woudn't get
725 # loaded again in another extension requiring a History.pl
727 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
728 # to core dump in the middle of a require statement. The required
729 # file was Tk/MMutil.pm. The consequence is, we have to be
730 # extremely careful when we try to give perl a reason to reload a
731 # library with same name. The workaround prefers to drop nothing
732 # from %INC and teach the writers not to use such libraries.
735 # foreach $inc (keys %INC) {
736 # #warn "***$inc*** deleted";
744 if ($section eq 'dynamic') {
745 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
746 "in skipped section 'dynamic_bs'\n"
747 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
748 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
749 "in skipped section 'dynamic_lib'\n"
750 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
752 if ($section eq 'dynamic_lib') {
753 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
754 "targets in skipped section 'dynamic_bs'\n"
755 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
757 if ($section eq 'static') {
758 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
759 "in skipped section 'static_lib'\n"
760 if $self->{SKIPHASH}{static_lib} && $Verbose;
762 return 'skipped' if $self->{SKIPHASH}{$section};
770 # my $fh = new FileHandle;
772 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
774 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
775 # $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
776 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
778 for $chunk (@{$self->{RESULT}}) {
779 # print $fh "$chunk\n";
785 my($finalname) = $self->{MAKEFILE};
786 rename("MakeMaker.tmp", $finalname);
787 chmod 0644, $finalname unless $Is_VMS;
789 if ($self->{PARENT}) {
790 foreach (keys %$self) { # safe memory
791 delete $self->{$_} unless $Keep_after_flush{$_};
795 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
798 # The following mkbootstrap() is only for installations that are calling
799 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
800 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
803 !!! Your Makefile has been built such a long time ago, !!!
804 !!! that is unlikely to work with current MakeMaker. !!!
805 !!! Please rebuild your Makefile !!!
809 # Ditto for mksymlists() as of MakeMaker 5.17
812 !!! Your Makefile has been built such a long time ago, !!!
813 !!! that is unlikely to work with current MakeMaker. !!!
814 !!! Please rebuild your Makefile !!!
820 return "undef" unless defined $v;
822 return "q[$v]" unless $t;
824 my(@m, $elem, @neat);
826 foreach $elem (@$v) {
827 push @neat, "q[$elem]";
829 push @m, join ", ", @neat;
833 return "$v" unless $t eq 'HASH';
835 while (($key,$val) = each %$v){
836 last unless defined $key; # cautious programming in case (undef,undef) is true
837 push(@m,"$key=>".neatvalue($val)) ;
839 return "{ ".join(', ',@m)." }";
846 push @m, "\n# Full list of MakeMaker attribute values:";
847 foreach $key (sort keys %$self){
848 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
849 my($v) = neatvalue($self->{$key});
850 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
852 push @m, "# $key => $v";
858 package ExtUtils::MakeMaker;
865 ExtUtils::MakeMaker - create an extension Makefile
869 C<use ExtUtils::MakeMaker;>
871 C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
875 C<MM-E<gt>new(\%att)-E<gt>flush;>
879 This utility is designed to write a Makefile for an extension module
880 from a Makefile.PL. It is based on the Makefile.SH model provided by
881 Andy Dougherty and the perl5-porters.
883 It splits the task of generating the Makefile into several subroutines
884 that can be individually overridden. Each subroutine returns the text
885 it wishes to have written to the Makefile.
887 MakeMaker is object oriented. Each directory below the current
888 directory that contains a Makefile.PL. Is treated as a separate
889 object. This makes it possible to write an unlimited number of
890 Makefiles with a single invocation of WriteMakefile().
892 =head2 How To Write A Makefile.PL
894 The short answer is: Don't.
896 Always begin with h2xs.
897 Always begin with h2xs!
898 ALWAYS BEGIN WITH H2XS!
900 even if you're not building around a header file, and even if you
901 don't have an XS component.
903 Run h2xs(1) before you start thinking about writing a module. For so
904 called pm-only modules that consist of C<*.pm> files only, h2xs has
905 the C<-X> switch. This will generate dummy files of all kinds that are
906 useful for the module developer.
908 The medium answer is:
910 use ExtUtils::MakeMaker;
911 WriteMakefile( NAME => "Foo::Bar" );
913 The long answer is the rest of the manpage :-)
915 =head2 Default Makefile Behaviour
917 The generated Makefile enables the user of the extension to invoke
919 perl Makefile.PL # optionally "perl Makefile.PL verbose"
921 make test # optionally set TEST_VERBOSE=1
922 make install # See below
924 The Makefile to be produced may be altered by adding arguments of the
925 form C<KEY=VALUE>. E.g.
927 perl Makefile.PL PREFIX=/tmp/myperl5
929 Other interesting targets in the generated Makefile are
931 make config # to check if the Makefile is up-to-date
932 make clean # delete local temp files (Makefile gets renamed)
933 make realclean # delete derived files (including ./blib)
934 make ci # check in all the files in the MANIFEST file
935 make dist # see below the Distribution Support section
939 MakeMaker checks for the existence of a file named F<test.pl> in the
940 current directory and if it exists it adds commands to the test target
941 of the generated Makefile that will execute the script with the proper
942 set of perl C<-I> options.
944 MakeMaker also checks for any files matching glob("t/*.t"). It will
945 add commands to the test target of the generated Makefile that execute
946 all matching files via the L<Test::Harness> module with the C<-I>
947 switches set correctly.
951 A useful variation of the above is the target C<testdb>. It runs the
952 test under the Perl debugger (see L<perldebug>). If the file
953 F<test.pl> exists in the current directory, it is used for the test.
955 If you want to debug some other testfile, set C<TEST_FILE> variable
958 make testdb TEST_FILE=t/mytest.t
960 By default the debugger is called using C<-d> option to perl. If you
961 want to specify some other option, set C<TESTDB_SW> variable:
963 make testdb TESTDB_SW=-Dx
967 make alone puts all relevant files into directories that are named by
968 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_MAN1DIR, and
969 INST_MAN3DIR. All these default to something below ./blib if you are
970 I<not> building below the perl source directory. If you I<are>
971 building below the perl source, INST_LIB and INST_ARCHLIB default to
972 ../../lib, and INST_SCRIPT is not defined.
974 The I<install> target of the generated Makefile copies the files found
975 below each of the INST_* directories to their INSTALL*
976 counterparts. Which counterparts are chosen depends on the setting of
977 INSTALLDIRS according to the following table:
982 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH
983 INST_LIB INSTALLPRIVLIB INSTALLSITELIB
985 INST_SCRIPT INSTALLSCRIPT
986 INST_MAN1DIR INSTALLMAN1DIR
987 INST_MAN3DIR INSTALLMAN3DIR
989 The INSTALL... macros in turn default to their %Config
990 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
992 You can check the values of these variables on your system with
996 And to check the sequence in which the library directories are
997 searched by perl, run
999 perl -le 'print join $/, @INC'
1002 =head2 PREFIX and LIB attribute
1004 PREFIX and LIB can be used to set several INSTALL* attributes in one
1005 go. The quickest way to install a module in a non-standard place might
1008 perl Makefile.PL LIB=~/lib
1010 This will install the module's architecture-independent files into
1011 ~/lib, the architecture-dependent files into ~/lib/$archname/auto.
1013 Another way to specify many INSTALL directories with a single
1014 parameter is PREFIX.
1016 perl Makefile.PL PREFIX=~
1018 This will replace the string specified by $Config{prefix} in all
1019 $Config{install*} values.
1021 Note, that in both cases the tilde expansion is done by MakeMaker, not
1022 by perl by default, nor by make. Conflicts between parmeters LIB,
1023 PREFIX and the various INSTALL* arguments are resolved so that
1026 If the user has superuser privileges, and is not working on AFS
1027 (Andrew File System) or relatives, then the defaults for
1028 INSTALLPRIVLIB, INSTALLARCHLIB, INSTALLSCRIPT, etc. will be appropriate,
1029 and this incantation will be the best:
1031 perl Makefile.PL; make; make test
1034 make install per default writes some documentation of what has been
1035 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1036 can be bypassed by calling make pure_install.
1040 will have to specify the installation directories as these most
1041 probably have changed since perl itself has been installed. They will
1042 have to do this by calling
1044 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1045 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1048 Be careful to repeat this procedure every time you recompile an
1049 extension, unless you are sure the AFS installation directories are
1052 =head2 Static Linking of a new Perl Binary
1054 An extension that is built with the above steps is ready to use on
1055 systems supporting dynamic loading. On systems that do not support
1056 dynamic loading, any newly created extension has to be linked together
1057 with the available resources. MakeMaker supports the linking process
1058 by creating appropriate targets in the Makefile whenever an extension
1059 is built. You can invoke the corresponding section of the makefile with
1063 That produces a new perl binary in the current directory with all
1064 extensions linked in that can be found in INST_ARCHLIB , SITELIBEXP,
1065 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1066 UNIX, this is called Makefile.aperl (may be system dependent). If you
1067 want to force the creation of a new perl, it is recommended, that you
1068 delete this Makefile.aperl, so the directories are searched-through
1069 for linkable libraries again.
1071 The binary can be installed into the directory where perl normally
1072 resides on your machine with
1076 To produce a perl binary with a different name than C<perl>, either say
1078 perl Makefile.PL MAP_TARGET=myperl
1085 make myperl MAP_TARGET=myperl
1086 make inst_perl MAP_TARGET=myperl
1088 In any case you will be prompted with the correct invocation of the
1089 C<inst_perl> target that installs the new binary into INSTALLBIN.
1091 make inst_perl per default writes some documentation of what has been
1092 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1093 can be bypassed by calling make pure_inst_perl.
1095 Warning: the inst_perl: target will most probably overwrite your
1096 existing perl binary. Use with care!
1098 Sometimes you might want to build a statically linked perl although
1099 your system supports dynamic loading. In this case you may explicitly
1100 set the linktype with the invocation of the Makefile.PL or make:
1102 perl Makefile.PL LINKTYPE=static # recommended
1106 make LINKTYPE=static # works on most systems
1108 =head2 Determination of Perl Library and Installation Locations
1110 MakeMaker needs to know, or to guess, where certain things are
1111 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1112 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1113 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1115 Extensions may be built either using the contents of the perl source
1116 directory tree or from the installed perl library. The recommended way
1117 is to build extensions after you have run 'make install' on perl
1118 itself. You can do that in any directory on your hard disk that is not
1119 below the perl source tree. The support for extensions below the ext
1120 directory of the perl distribution is only good for the standard
1121 extensions that come with perl.
1123 If an extension is being built below the C<ext/> directory of the perl
1124 source then MakeMaker will set PERL_SRC automatically (e.g.,
1125 C<../..>). If PERL_SRC is defined and the extension is recognized as
1126 a standard extension, then other variables default to the following:
1129 PERL_LIB = PERL_SRC/lib
1130 PERL_ARCHLIB = PERL_SRC/lib
1132 INST_ARCHLIB = PERL_ARCHLIB
1134 If an extension is being built away from the perl source then MakeMaker
1135 will leave PERL_SRC undefined and default to using the installed copy
1136 of the perl library. The other variables default to the following:
1138 PERL_INC = $archlibexp/CORE
1139 PERL_LIB = $privlibexp
1140 PERL_ARCHLIB = $archlibexp
1141 INST_LIB = ./blib/lib
1142 INST_ARCHLIB = ./blib/arch
1144 If perl has not yet been installed then PERL_SRC can be defined on the
1145 command line as shown in the previous section.
1148 =head2 Which architecture dependent directory?
1150 If you don't want to keep the defaults for the INSTALL* macros,
1151 MakeMaker helps you to minimize the typing needed: the usual
1152 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1153 by Configure at perl compilation time. MakeMaker supports the user who
1154 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1155 then MakeMaker defaults the latter to be the same subdirectory of
1156 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1157 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1158 for INSTALLSITELIB and INSTALLSITEARCH.
1160 MakeMaker gives you much more freedom than needed to configure
1161 internal variables and get different results. It is worth to mention,
1162 that make(1) also lets you configure most of the variables that are
1163 used in the Makefile. But in the majority of situations this will not
1164 be necessary, and should only be done, if the author of a package
1165 recommends it (or you know what you're doing).
1167 =head2 Using Attributes and Parameters
1169 The following attributes can be specified as arguments to WriteMakefile()
1170 or as NAME=VALUE pairs on the command line:
1174 # The following "=item C" is used by the attrib_help routine
1175 # likewise the "=back" below. So be careful when changing it!
1181 Ref to array of *.c file names. Initialised from a directory scan
1182 and the values portion of the XS attribute hash. This is not
1183 currently used by MakeMaker but may be handy in Makefile.PLs.
1187 String that will be included in the compiler call command line between
1188 the arguments INC and OPTIMIZE.
1192 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1193 config.sh. MakeMaker will add to CONFIG the following values anyway:
1213 CODE reference. The subroutine should return a hash reference. The
1214 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1215 be determined by some evaluation method.
1219 Something like C<"-DHAVE_UNISTD_H">
1223 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1228 Your name for distributing the package (by tar file). This defaults to
1233 Hashref of symbol names for routines to be made available as
1234 universal symbols. Each key/value pair consists of the package name
1235 and an array of routine names in that package. Used only under AIX
1236 (export lists) and VMS (linker options) at present. The routine
1237 names supplied will be expanded in the same way as XSUB names are
1238 expanded by the XS() macro. Defaults to
1240 {"$(NAME)" => ["boot_$(NAME)" ] }
1244 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1245 "NetconfigPtr" => [ 'DESTROY'] }
1249 Array of symbol names for variables to be made available as
1250 universal symbols. Used only under AIX (export lists) and VMS
1251 (linker options) at present. Defaults to []. (e.g. [ qw(
1252 Foo_version Foo_numstreams Foo_tree ) ])
1256 Array of extension names to exclude when doing a static build. This
1257 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1258 details. (e.g. [ qw( Socket POSIX ) ] )
1260 This attribute may be most useful when specified as a string on the
1261 commandline: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1265 Ref to array of executable files. The files will be copied to the
1266 INST_SCRIPT directory. Make realclean will delete them from there
1271 In general any generated Makefile checks for the current version of
1272 MakeMaker and the version the Makefile was built under. If NO_VC is
1273 set, the version check is neglected. Do not write this into your
1274 Makefile.PL, use it interactively instead.
1276 =item FIRST_MAKEFILE
1278 The name of the Makefile to be produced. Defaults to the contents of
1279 MAKEFILE, but can be overridden. This is used for the second Makefile
1280 that will be produced for the MAP_TARGET.
1284 Perl binary able to run this extension.
1288 Ref to array of *.h file names. Similar to C.
1292 IMPORTS is only used on OS/2.
1296 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1300 Array of extension names to be included when doing a static build.
1301 MakeMaker will normally build with all of the installed extensions when
1302 doing a static build, and that is usually the desired behavior. If
1303 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1304 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1306 It is not necessary to mention DynaLoader or the current extension when
1307 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1308 only DynaLoader and the current extension will be included in the build.
1310 This attribute may be most useful when specified as a string on the
1311 commandline: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1313 =item INSTALLARCHLIB
1315 Used by 'make install', which copies files from INST_ARCHLIB to this
1316 directory if INSTALLDIRS is set to perl.
1320 Directory to install binary files (e.g. tkperl) into.
1324 Determines which of the two sets of installation directories to
1325 choose: installprivlib and installarchlib versus installsitelib and
1326 installsitearch. The first pair is chosen with INSTALLDIRS=perl, the
1327 second with INSTALLDIRS=site. Default is site.
1329 =item INSTALLMAN1DIR
1331 This directory gets the man pages at 'make install' time. Defaults to
1332 $Config{installman1dir}.
1334 =item INSTALLMAN3DIR
1336 This directory gets the man pages at 'make install' time. Defaults to
1337 $Config{installman3dir}.
1339 =item INSTALLPRIVLIB
1341 Used by 'make install', which copies files from INST_LIB to this
1342 directory if INSTALLDIRS is set to perl.
1346 Used by 'make install' which copies files from INST_SCRIPT to this
1349 =item INSTALLSITELIB
1351 Used by 'make install', which copies files from INST_LIB to this
1352 directory if INSTALLDIRS is set to site (default).
1354 =item INSTALLSITEARCH
1356 Used by 'make install', which copies files from INST_ARCHLIB to this
1357 directory if INSTALLDIRS is set to site (default).
1361 Same as INST_LIB for architecture dependent files.
1365 Directory to put real binary files during 'make'. These will be copied
1366 to INSTALLBIN during 'make install'
1370 Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you
1375 Directory where we put library files of this extension while building
1380 Directory to hold the man pages at 'make' time
1384 Directory to hold the man pages at 'make' time
1388 Directory, where executable files should be installed during
1389 'make'. Defaults to "./blib/bin", just to have a dummy location during
1390 testing. make install will copy the files in INST_SCRIPT to
1395 defaults to "$(OBJECT)" and is used in the ld command to specify
1396 what files to link/load from (also see dynamic_lib below for how to
1401 The filename of the perllibrary that will be used together with this
1402 extension. Defaults to libperl.a.
1406 LIB can only be set at C<perl Makefile.PL> time. It has the effect of
1407 setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any
1411 An anonymous array of alternative library
1412 specifications to be searched for (in order) until
1413 at least one library is found. E.g.
1415 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1417 Mind, that any element of the array
1418 contains a complete set of arguments for the ld
1419 command. So do not specify
1421 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1423 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1424 you specify a scalar as in
1426 'LIBS' => "-ltcl -ltk -lX11"
1428 MakeMaker will turn it into an array with one element.
1432 'static' or 'dynamic' (default unless usedl=undef in
1433 config.sh). Should only be used to force static linking (also see
1438 Boolean which tells MakeMaker, that it should include the rules to
1439 make a perl. This is handled automatically as a switch by
1440 MakeMaker. The user normally does not need it.
1444 The name of the Makefile to be produced.
1448 Hashref of pod-containing files. MakeMaker will default this to all
1449 EXE_FILES files that include POD directives. The files listed
1450 here will be converted to man pages and installed as was requested
1455 Hashref of .pm and .pod files. MakeMaker will default this to all
1456 .pod and any .pm files that include POD directives. The files listed
1457 here will be converted to man pages and installed as was requested
1462 If it is intended, that a new perl binary be produced, this variable
1463 may hold a name for that binary. Defaults to perl
1467 If the extension links to a library that it builds set this to the
1468 name of the library (see SDBM_File)
1472 Perl module name for this extension (DBD::Oracle). This will default
1473 to the directory name but should be explicitly defined in the
1478 MakeMaker will figure out, if an extension contains linkable code
1479 anywhere down the directory tree, and will set this variable
1480 accordingly, but you can speed it up a very little bit, if you define
1481 this boolean variable yourself.
1485 Defaults to C<@>. By setting it to an empty string you can generate a
1486 Makefile that echos all commands. Mainly used in debugging MakeMaker
1491 Boolean. Attribute to inhibit descending into subdirectories.
1495 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1496 string containing all object files, e.g. "tkpBind.o
1497 tkpButton.o tkpCanvas.o"
1501 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1502 passed to subdirectory makes.
1506 Perl binary for tasks that can be done by miniperl
1510 The call to the program that is able to compile perlmain.c. Defaults
1515 Same as above for architecture dependent files
1519 Directory containing the Perl library to use.
1523 Directory containing the Perl source code (use of this should be
1524 avoided, it may be undefined)
1528 Ref to hash of files to be processed as perl programs. MakeMaker
1529 will default to any found *.PL file (except Makefile.PL) being keys
1530 and the basename of the file being the value. E.g.
1532 {'foobar.PL' => 'foobar'}
1534 The *.PL files are expected to produce output to the target files
1539 Hashref of .pm files and *.pl files to be installed. e.g.
1541 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1543 By default this will include *.pm and *.pl. If a lib directory
1544 exists and is not listed in DIR (above) then any *.pm and *.pl files
1545 it contains will also be included by default. Defining PM in the
1546 Makefile.PL will override PMLIBDIRS.
1550 Ref to array of subdirectories containing library files. Defaults to
1551 [ 'lib', $(BASEEXT) ]. The directories will be scanned and any files
1552 they contain will be installed in the corresponding location in the
1553 library. A libscan() method can be used to alter the behaviour.
1554 Defining PM in the Makefile.PL will override PMLIBDIRS.
1558 Can be used to set the three INSTALL* attributes in one go (except for
1559 probably INSTALLMAN1DIR, if it is not below PREFIX according to
1560 %Config). They will have PREFIX as a common directory node and will
1561 branch from that node into lib/, lib/ARCHNAME or whatever Configure
1562 decided at the build time of your perl (unless you override one of
1567 Hashref: Names of modules that need to be available to run this
1568 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1569 desired version is the value. If the required version number is 0, we
1570 only check if any version is installed already.
1574 Arryref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1575 Makefile. Caution! Do not use the SKIP attribute for the neglectible
1576 speedup. It may seriously damage the resulting Makefile. Only use it,
1577 if you really need it.
1581 Ref to array of typemap file names. Use this when the typemaps are
1582 in some directory other than the current directory or when they are
1583 not named B<typemap>. The last typemap in the list takes
1584 precedence. A typemap in the current directory has highest
1585 precedence, even if it isn't listed in TYPEMAPS. The default system
1586 typemap has lowest precedence.
1590 Your version number for distributing the package. This defaults to
1595 Instead of specifying the VERSION in the Makefile.PL you can let
1596 MakeMaker parse a file to determine the version number. The parsing
1597 routine requires that the file named by VERSION_FROM contains one
1598 single line to compute the version number. The first line in the file
1599 that contains the regular expression
1601 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
1603 will be evaluated with eval() and the value of the named variable
1604 B<after> the eval() will be assigned to the VERSION attribute of the
1605 MakeMaker object. The following lines will be parsed o.k.:
1609 ( $VERSION ) = '$Revision: 1.216 $ ' =~ /\$Revision:\s+([^\s]+)/;
1610 $FOO::VERSION = '1.10';
1611 *FOO::VERSION = \'1.11';
1613 but these will fail:
1615 my $VERSION = '1.01';
1616 local $VERSION = '1.02';
1617 local $FOO::VERSION = '1.30';
1619 The file named in VERSION_FROM is not added as a dependency to
1620 Makefile. This is not really correct, but it would be a major pain
1621 during development to have to rewrite the Makefile for any smallish
1622 change in that file. If you want to make sure that the Makefile
1623 contains the correct VERSION macro after any change of the file, you
1624 would have to do something like
1626 depend => { Makefile => '$(VERSION_FROM)' }
1628 See attribute C<depend> below.
1632 Hashref of .xs files. MakeMaker will default this. e.g.
1634 {'name_of_file.xs' => 'name_of_file.c'}
1636 The .c files will automatically be included in the list of files
1637 deleted by a make clean.
1641 String of options to pass to xsubpp. This might include C<-C++> or
1642 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
1647 May be set to an empty string, which is identical to C<-prototypes>, or
1648 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
1649 defaults to the empty string.
1653 Your version number for the .xs file of this package. This defaults
1654 to the value of the VERSION attribute.
1658 =head2 Additional lowercase attributes
1660 can be used to pass parameters to the methods which implement that
1661 part of the Makefile.
1667 {FILES => "*.xyz foo"}
1671 {ANY_TARGET => ANY_DEPENDECY, ...}
1675 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => 'gz',
1676 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
1677 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
1679 If you specify COMPRESS, then SUFFIX should also be altered, as it is
1680 needed to tell make the target file of the compression. Setting
1681 DIST_CP to ln can be useful, if you need to preserve the timestamps on
1682 your files. DIST_CP can take the values 'cp', which copies the file,
1683 'ln', which links the file, and 'best' which copies symbolic links and
1684 links the rest. Default is 'best'.
1688 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
1692 Deprecated as of MakeMaker 5.23. See L<ExtUtils::MM_Unix/pm_to_blib>.
1696 {LINKTYPE => 'static', 'dynamic' or ''}
1698 NB: Extensions that have nothing but *.pm files had to say
1702 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1703 can be deleted safely. MakeMaker recognizes, when there's nothing to
1708 {ANY_MACRO => ANY_VALUE, ...}
1712 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
1714 =item tool_autosplit
1722 # bug in pod2html, so leave the =back
1724 # Don't delete this cut, MM depends on it!
1726 =head2 Overriding MakeMaker Methods
1728 If you cannot achieve the desired Makefile behaviour by specifying
1729 attributes you may define private subroutines in the Makefile.PL.
1730 Each subroutines returns the text it wishes to have written to
1731 the Makefile. To override a section of the Makefile you can
1734 sub MY::c_o { "new literal text" }
1736 or you can edit the default by saying something like:
1739 package MY; # so that "SUPER" works right
1740 my $inherited = shift->SUPER::c_o(@_);
1741 $inherited =~ s/old text/new text/;
1745 If you running experiments with embedding perl as a library into other
1746 applications, you might find MakeMaker not sufficient. You'd better
1747 have a look at ExtUtils::embed which is a collection of utilities for
1750 If you still need a different solution, try to develop another
1751 subroutine, that fits your needs and submit the diffs to
1752 F<perl5-porters@nicoh.com> or F<comp.lang.perl.misc> as appropriate.
1754 For a complete description of all MakeMaker methods see L<ExtUtils::MM_Unix>.
1756 Here is a simple example of how to add a new target to the generated
1761 $(MYEXTLIB): sdbm/Makefile
1762 cd sdbm && $(MAKE) all
1767 =head2 Hintsfile support
1769 MakeMaker.pm uses the architecture specific information from
1770 Config.pm. In addition it evaluates architecture specific hints files
1771 in a C<hints/> directory. The hints files are expected to be named
1772 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
1773 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
1774 MakeMaker within the WriteMakefile() subroutine, and can be used to
1775 execute commands as well as to include special variables. The rules
1776 which hintsfile is chosen are the same as in Configure.
1778 The hintsfile is eval()ed immediately after the arguments given to
1779 WriteMakefile are stuffed into a hash reference $self but before this
1780 reference becomes blessed. So if you want to do the equivalent to
1781 override or create an attribute you would say something like
1783 $self->{LIBS} = ['-ldbm -lucb -lc'];
1785 =head2 Distribution Support
1787 For authors of extensions MakeMaker provides several Makefile
1788 targets. Most of the support comes from the ExtUtils::Manifest module,
1789 where additional documentation can be found.
1793 =item make distcheck
1795 reports which files are below the build directory but not in the
1796 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
1799 =item make skipcheck
1801 reports which files are skipped due to the entries in the
1802 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
1805 =item make distclean
1807 does a realclean first and then the distcheck. Note that this is not
1808 needed to build a new distribution as long as you are sure, that the
1809 MANIFEST file is ok.
1813 rewrites the MANIFEST file, adding all remaining files found (See
1814 ExtUtils::Manifest::mkmanifest() for details)
1818 Copies all the files that are in the MANIFEST file to a newly created
1819 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
1820 exists, it will be removed first.
1824 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
1825 a make test in that directory.
1829 First does a distdir. Then a command $(PREOP) which defaults to a null
1830 command, followed by $(TOUNIX), which defaults to a null command under
1831 UNIX, and will convert files in distribution directory to UNIX format
1832 otherwise. Next it runs C<tar> on that directory into a tarfile and
1833 deletes the directory. Finishes with a command $(POSTOP) which
1834 defaults to a null command.
1838 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
1840 =item make uutardist
1842 Runs a tardist first and uuencodes the tarfile.
1846 First does a distdir. Then a command $(PREOP) which defaults to a null
1847 command. Next it runs C<shar> on that directory into a sharfile and
1848 deletes the intermediate directory again. Finishes with a command
1849 $(POSTOP) which defaults to a null command. Note: For shdist to work
1850 properly a C<shar> program that can handle directories is mandatory.
1854 First does a distdir. Then a command $(PREOP) which defaults to a null
1855 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
1856 zipfile. Then deletes that directory. Finishes with a command
1857 $(POSTOP) which defaults to a null command.
1861 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
1865 Customization of the dist targets can be done by specifying a hash
1866 reference to the dist attribute of the WriteMakefile call. The
1867 following parameters are recognized:
1870 COMPRESS ('compress')
1873 TO_UNIX (depends on the system)
1874 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
1884 WriteMakefile( 'dist' => { COMPRESS=>"gzip", SUFFIX=>"gz" })
1886 =head2 Disabling an extension
1888 If some events detected in F<Makefile.PL> imply that there is no way
1889 to create the Module, but this is a normal state of things, then you
1890 can create a F<Makefile> which does nothing, but succeeds on all the
1891 "usual" build targets. To do so, use
1893 ExtUtils::MakeMaker::WriteEmptyMakefile();
1895 instead of WriteMakefile().
1897 This may be useful if other modules expect this module to be I<built>
1898 OK, as opposed to I<work> OK (say, this system-dependent module builds
1899 in a subdirectory of some other distribution, or is listed as a
1900 dependency in a CPAN::Bundle, but the functionality is supported by
1901 different means on the current architecture).
1905 ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib,
1906 ExtUtils::Install, ExtUtils::embed
1910 Andy Dougherty <F<doughera@lafcol.lafayette.edu>>, Andreas KE<ouml>nig
1911 <F<A.Koenig@franz.ww.TU-Berlin.DE>>, Tim Bunce <F<Tim.Bunce@ig.co.uk>>.
1912 VMS support by Charles Bailey <F<bailey@genetics.upenn.edu>>. OS/2
1913 support by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>. Contact the
1914 makemaker mailing list C<mailto:makemaker@franz.ww.tu-berlin.de>, if
1915 you have any questions.