1 BEGIN {require 5.002;} # MakeMaker 5.17 was the last MakeMaker that was compatible with perl5.001m
3 package ExtUtils::MakeMaker;
6 $Version_OK = "5.17"; # Makefiles older than $Version_OK will die
7 # (Will be checked from MakeMaker version 4.13 onwards)
8 ($Revision = substr(q$Revision: 1.222 $, 10)) =~ s/\s+$//;
19 @ISA @EXPORT @EXPORT_OK $AUTOLOAD
20 $ISA_TTY $Is_Mac $Is_OS2 $Is_VMS $Revision $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);
41 # Dummy package MM inherits actual methods from OS-specific
42 # default packages. We use this intermediate package so
43 # MY::XYZ->func() can call MM->func() and get the proper
44 # default routine without having to know under what OS
47 @MM::ISA = qw[ExtUtils::MM_Unix ExtUtils::Liblist ExtUtils::MakeMaker];
50 # Setup dummy package:
51 # MY exists for overriding methods to be defined within
56 ### sub AUTOLOAD { use Devel::Symdump; print Devel::Symdump->rnew->as_string; Carp::confess "hey why? $AUTOLOAD" }
61 # "predeclare the package: we only load it via AUTOLOAD
62 # but we have already mentioned it in @ISA
63 package ExtUtils::Liblist;
65 package ExtUtils::MakeMaker;
67 # Now we can pull in the friends
69 $Is_VMS = $^O eq 'VMS';
70 $Is_OS2 = $^O eq 'os2';
71 $Is_Mac = $^O eq 'MacOS';
72 $Is_Win32 = $^O eq 'MSWin32';
73 $Is_Cygwin= $^O =~ /cygwin/i;
75 require ExtUtils::MM_Unix;
78 require ExtUtils::MM_VMS;
79 require VMS::Filespec; # is a noop as long as we require it within MM_VMS
82 require ExtUtils::MM_OS2;
85 require ExtUtils::MM_Mac;
88 require ExtUtils::MM_Win32;
91 require ExtUtils::MM_Cygwin;
94 # The SelfLoader would bring a lot of overhead for MakeMaker, because
95 # we know for sure we will use most of the autoloaded functions once
96 # we have to use one of them. So we write our own loader
100 if (defined fileno(DATA)) {
101 my $fh = select DATA;
102 my $o = $/; # For future reads from the file.
114 warn "AUTOLOAD called unexpectedly for $AUTOLOAD";
116 defined(&$AUTOLOAD) or die "Myloader inconsistency error";
120 # The only subroutine we do not SelfLoad is Version_Check because it's
121 # called so often. Loading this minimum still requires 1.2 secs on my
125 my($checkversion) = @_;
126 die "Your Makefile was built with ExtUtils::MakeMaker v $checkversion.
127 Current Version is $ExtUtils::MakeMaker::VERSION. There have been considerable
128 changes in the meantime.
129 Please rerun 'perl Makefile.PL' to regenerate the Makefile.\n"
130 if $checkversion < $Version_OK;
131 printf STDOUT "%s %s %s %s.\n", "Makefile built with ExtUtils::MakeMaker v",
132 $checkversion, "Current Version is", $VERSION
133 unless $checkversion == $VERSION;
137 $_[0] =~ /^Use of uninitialized value/ && return;
138 $_[0] =~ /used only once/ && return;
139 $_[0] =~ /^Subroutine\s+[\w:]+\s+redefined/ && return;
143 sub ExtUtils::MakeMaker::eval_in_subdirs ;
144 sub ExtUtils::MakeMaker::eval_in_x ;
145 sub ExtUtils::MakeMaker::full_setup ;
146 sub ExtUtils::MakeMaker::writeMakefile ;
147 sub ExtUtils::MakeMaker::new ;
148 sub ExtUtils::MakeMaker::check_manifest ;
149 sub ExtUtils::MakeMaker::parse_args ;
150 sub ExtUtils::MakeMaker::check_hints ;
151 sub ExtUtils::MakeMaker::mv_all_methods ;
152 sub ExtUtils::MakeMaker::skipcheck ;
153 sub ExtUtils::MakeMaker::flush ;
154 sub ExtUtils::MakeMaker::mkbootstrap ;
155 sub ExtUtils::MakeMaker::mksymlists ;
156 sub ExtUtils::MakeMaker::neatvalue ;
157 sub ExtUtils::MakeMaker::selfdocument ;
158 sub ExtUtils::MakeMaker::WriteMakefile ;
159 sub ExtUtils::MakeMaker::prompt ($;$) ;
165 package ExtUtils::MakeMaker;
168 Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
169 local $SIG{__WARN__} = \&warnhandler;
171 unless ($Setup_done++){
173 undef &ExtUtils::MakeMaker::full_setup; #safe memory
176 MM->new(\%att)->flush;
181 $ISA_TTY = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ; # Pipe?
182 Carp::confess("prompt function called without an argument") unless defined $mess;
183 my $dispdef = defined $def ? "[$def] " : " ";
184 $def = defined $def ? $def : "";
187 print "$mess $dispdef";
189 chomp($ans = <STDIN>);
193 return ($ans ne '') ? $ans : $def;
196 sub eval_in_subdirs {
202 foreach $dir (@{$self->{DIR}}){
203 my($abs) = $self->catdir($pwd,$dir);
204 $self->eval_in_x($abs);
212 chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
214 # my $fh = new FileHandle;
215 # $fh->open("Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
217 open(FH,"Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
218 # my $eval = join "", <$fh>;
219 my $eval = join "", <FH>;
224 # if ($@ =~ /prerequisites/) {
225 # die "MakeMaker WARNING: $@";
227 # warn "WARNING from evaluation of $dir/Makefile.PL: $@";
229 warn "WARNING from evaluation of $dir/Makefile.PL: $@";
237 # package name for the classes into which the first object will be blessed
238 $PACKNAME = "PACK000";
242 AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION
243 C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
244 EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE FULLPERL FUNCLIST H IMPORTS
245 INC INCLUDE_EXT INSTALLARCHLIB INSTALLBIN INSTALLDIRS INSTALLMAN1DIR
246 INSTALLMAN3DIR INSTALLPRIVLIB INSTALLSCRIPT INSTALLSITEARCH
247 INSTALLSITELIB INST_ARCHLIB INST_BIN INST_EXE INST_LIB
248 INST_MAN1DIR INST_MAN3DIR INST_SCRIPT LDFROM LIB LIBPERL_A LIBS
249 LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB
250 NAME NEEDS_LINKING NOECHO NORECURS NO_VC OBJECT OPTIMIZE PERL PERLMAINCC
251 PERL_ARCHLIB PERL_LIB PERL_SRC PERM_RW PERM_RWX
252 PL_FILES PM PMLIBDIRS PPM_INSTALL_EXEC PPM_INSTALL_SCRIPT PREFIX
253 PREREQ_PM SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
254 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
258 # IMPORTS is used under OS/2 and Win32
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 ppd
283 ); # loses section ordering
285 @Overridable = @MM_Sections;
286 push @Overridable, qw[
288 dir_target libscan makeaperl needs_linking perm_rw perm_rwx
289 subdir_x test_via_harness test_via_script
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 osname osvers 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";
384 # Why is/was this 'delete' here? We need PREREQ_PM later to make PPDs.
386 # delete $self->{PREREQ_PM}{$prereq};
390 # unless (defined $ExtUtils::MakeMaker::useCPAN) {
391 # print qq{MakeMaker WARNING: prerequisites not found (@unsatisfied)
392 # Please install these modules first and rerun 'perl Makefile.PL'.\n};
393 # if ($ExtUtils::MakeMaker::hasCPAN) {
394 # $ExtUtils::MakeMaker::useCPAN = prompt(qq{Should I try to use the CPAN module to fetch them for you?},"yes");
396 # print qq{Hint: You may want to install the CPAN module to autofetch the needed modules\n};
397 # $ExtUtils::MakeMaker::useCPAN=0;
400 # if ($ExtUtils::MakeMaker::useCPAN) {
402 # CPAN->import(@unsatisfied);
404 # die qq{prerequisites not found (@unsatisfied)};
406 # warn qq{WARNING: prerequisites not found (@unsatisfied)};
409 if (defined $self->{CONFIGURE}) {
410 if (ref $self->{CONFIGURE} eq 'CODE') {
411 $self = { %$self, %{&{$self->{CONFIGURE}}}};
413 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
417 # This is for old Makefiles written pre 5.00, will go away
418 if ( Carp::longmess("") =~ /runsubdirpl/s ){
419 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
422 my $newclass = ++$PACKNAME;
423 local @Parent = @Parent; # Protect against non-local exits
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 if ($self->{PARENT}) {
447 $self->{PARENT}->{CHILDREN}->{$newclass} = $self;
448 if (exists $self->{PARENT}->{CAPI}
449 and not exists $self->{CAPI})
451 # inherit, but only if already unspecified
452 $self->{CAPI} = $self->{PARENT}->{CAPI};
456 parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV);
459 $self->{NAME} ||= $self->guess_name;
461 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
465 if (! $self->{PERL_SRC} ) {
466 my($pthinks) = $self->canonpath($INC{'Config.pm'});
467 my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
468 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
469 if ($pthinks ne $cthinks &&
470 !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
471 print "Have $pthinks expected $cthinks\n";
473 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
476 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
479 Your perl and your Config.pm seem to have different ideas about the architecture
481 Perl thinks: [$pthinks]
482 Config says: [$Config{archname}]
483 This may or may not cause problems. Please check your installation of perl if you
484 have problems building this extension.
489 $self->init_dirscan();
490 $self->init_others();
491 my($argv) = neatvalue(\@ARGV);
495 push @{$self->{RESULT}}, <<END;
496 # This Makefile is for the $self->{NAME} extension to perl.
498 # It was generated automatically by MakeMaker version
499 # $VERSION (Revision: $Revision) from the contents of
500 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
502 # ANY CHANGES MADE HERE WILL BE LOST!
504 # MakeMaker ARGV: $argv
506 # MakeMaker Parameters:
509 foreach $key (sort keys %initial_att){
510 my($v) = neatvalue($initial_att{$key});
511 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
513 push @{$self->{RESULT}}, "# $key => $v";
516 # turn the SKIP array into a SKIPHASH hash
518 for $skip (@{$self->{SKIP} || []}) {
519 $self->{SKIPHASH}{$skip} = 1;
521 delete $self->{SKIP}; # free memory
523 if ($self->{PARENT}) {
524 for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
525 $self->{SKIPHASH}{$_} = 1;
529 # We run all the subdirectories now. They don't have much to query
530 # from the parent, but the parent has to query them: if they need linking!
531 unless ($self->{NORECURS}) {
532 $self->eval_in_subdirs if @{$self->{DIR}};
536 foreach $section ( @MM_Sections ){
537 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
538 my($skipit) = $self->skipcheck($section);
540 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
542 my(%a) = %{$self->{$section} || {}};
543 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
544 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
545 push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
549 push @{$self->{RESULT}}, "\n# End.";
554 sub WriteEmptyMakefile {
555 if (-f 'Makefile.old') {
556 chmod 0666, 'Makefile.old';
557 unlink 'Makefile.old' or warn "unlink Makefile.old: $!";
559 rename 'Makefile', 'Makefile.old' or warn "rename Makefile Makefile.old: $!"
561 open MF, '> Makefile' or die "open Makefile for write: $!";
574 close MF or die "close Makefile for write: $!";
578 print STDOUT "Checking if your kit is complete...\n";
579 require ExtUtils::Manifest;
580 $ExtUtils::Manifest::Quiet=$ExtUtils::Manifest::Quiet=1; #avoid warning
581 my(@missed)=ExtUtils::Manifest::manicheck();
583 print STDOUT "Warning: the following files are missing in your kit:\n";
584 print "\t", join "\n\t", @missed;
586 print STDOUT "Please inform the author.\n";
588 print STDOUT "Looks good\n";
593 my($self, @args) = @_;
595 unless (m/(.*?)=(.*)/){
596 help(),exit 1 if m/^help$/;
597 ++$Verbose if m/^verb/;
600 my($name, $value) = ($1, $2);
601 if ($value =~ m/^~(\w+)?/){ # tilde with optional username
602 $value =~ s [^~(\w*)]
604 ((getpwnam($1))[7] || "~$1") :
608 $self->{uc($name)} = $value;
611 # catch old-style 'potential_libs' and inform user how to 'upgrade'
612 if (defined $self->{potential_libs}){
613 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
614 if ($self->{potential_libs}){
615 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
617 print STDOUT "$msg deleted.\n";
619 $self->{LIBS} = [$self->{potential_libs}];
620 delete $self->{potential_libs};
622 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
623 if (defined $self->{ARMAYBE}){
624 my($armaybe) = $self->{ARMAYBE};
625 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
626 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
627 my(%dl) = %{$self->{dynamic_lib} || {}};
628 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
629 delete $self->{ARMAYBE};
631 if (defined $self->{LDTARGET}){
632 print STDOUT "LDTARGET should be changed to LDFROM\n";
633 $self->{LDFROM} = $self->{LDTARGET};
634 delete $self->{LDTARGET};
636 # Turn a DIR argument on the command line into an array
637 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
638 # So they can choose from the command line, which extensions they want
639 # the grep enables them to have some colons too much in case they
640 # have to build a list with the shell
641 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
643 # Turn a INCLUDE_EXT argument on the command line into an array
644 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
645 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
647 # Turn a EXCLUDE_EXT argument on the command line into an array
648 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
649 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
652 foreach $mmkey (sort keys %$self){
653 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
654 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
655 unless exists $Recognized_Att_Keys{$mmkey};
662 # We allow extension-specific hints files.
664 return unless -d "hints";
666 # First we look for the best hintsfile we have
668 my($hint)="${^O}_$Config{osvers}";
673 # Also try without trailing minor version numbers.
675 last if -f "hints/$hint.pl"; # found
677 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
679 return unless -f "hints/$hint.pl"; # really there
681 # execute the hintsfile:
683 # my $fh = new FileHandle;
684 # $fh->open("hints/$hint.pl");
686 open(FH,"hints/$hint.pl");
687 # @goodhints = <$fh>;
691 print STDOUT "Processing hints file hints/$hint.pl\n";
692 eval join('',@goodhints);
693 print STDOUT $@ if $@;
699 my($symtab) = \%{"${from}::"};
702 # Here you see the *current* list of methods that are overridable
703 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
704 # still trying to reduce the list to some reasonable minimum --
705 # because I want to make it easier for the user. A.K.
707 foreach $method (@Overridable) {
709 # We cannot say "next" here. Nick might call MY->makeaperl
710 # which isn't defined right now
712 # Above statement was written at 4.23 time when Tk-b8 was
713 # around. As Tk-b9 only builds with 5.002something and MM 5 is
714 # standard, we try to enable the next line again. It was
715 # commented out until MM 5.23
717 next unless defined &{"${from}::$method"};
719 *{"${to}::$method"} = \&{"${from}::$method"};
721 # delete would do, if we were sure, nobody ever called
722 # MY->makeaperl directly
724 # delete $symtab->{$method};
726 # If we delete a method, then it will be undefined and cannot
727 # be called. But as long as we have Makefile.PLs that rely on
728 # %MY:: being intact, we have to fill the hole with an
731 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
734 # We have to clean out %INC also, because the current directory is
735 # changed frequently and Graham Barr prefers to get his version
736 # out of a History.pl file which is "required" so woudn't get
737 # loaded again in another extension requiring a History.pl
739 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
740 # to core dump in the middle of a require statement. The required
741 # file was Tk/MMutil.pm. The consequence is, we have to be
742 # extremely careful when we try to give perl a reason to reload a
743 # library with same name. The workaround prefers to drop nothing
744 # from %INC and teach the writers not to use such libraries.
747 # foreach $inc (keys %INC) {
748 # #warn "***$inc*** deleted";
756 if ($section eq 'dynamic') {
757 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
758 "in skipped section 'dynamic_bs'\n"
759 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
760 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
761 "in skipped section 'dynamic_lib'\n"
762 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
764 if ($section eq 'dynamic_lib') {
765 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
766 "targets in skipped section 'dynamic_bs'\n"
767 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
769 if ($section eq 'static') {
770 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
771 "in skipped section 'static_lib'\n"
772 if $self->{SKIPHASH}{static_lib} && $Verbose;
774 return 'skipped' if $self->{SKIPHASH}{$section};
782 # my $fh = new FileHandle;
784 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
786 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
787 # $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
788 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
790 for $chunk (@{$self->{RESULT}}) {
791 # print $fh "$chunk\n";
797 my($finalname) = $self->{MAKEFILE};
798 rename("MakeMaker.tmp", $finalname);
799 chmod 0644, $finalname unless $Is_VMS;
801 if ($self->{PARENT}) {
802 foreach (keys %$self) { # safe memory
803 delete $self->{$_} unless $Keep_after_flush{$_};
807 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
810 # The following mkbootstrap() is only for installations that are calling
811 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
812 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
815 !!! Your Makefile has been built such a long time ago, !!!
816 !!! that is unlikely to work with current MakeMaker. !!!
817 !!! Please rebuild your Makefile !!!
821 # Ditto for mksymlists() as of MakeMaker 5.17
824 !!! Your Makefile has been built such a long time ago, !!!
825 !!! that is unlikely to work with current MakeMaker. !!!
826 !!! Please rebuild your Makefile !!!
832 return "undef" unless defined $v;
834 return "q[$v]" unless $t;
836 my(@m, $elem, @neat);
838 foreach $elem (@$v) {
839 push @neat, "q[$elem]";
841 push @m, join ", ", @neat;
845 return "$v" unless $t eq 'HASH';
847 while (($key,$val) = each %$v){
848 last unless defined $key; # cautious programming in case (undef,undef) is true
849 push(@m,"$key=>".neatvalue($val)) ;
851 return "{ ".join(', ',@m)." }";
858 push @m, "\n# Full list of MakeMaker attribute values:";
859 foreach $key (sort keys %$self){
860 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
861 my($v) = neatvalue($self->{$key});
862 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
864 push @m, "# $key => $v";
870 package ExtUtils::MakeMaker;
877 ExtUtils::MakeMaker - create an extension Makefile
881 C<use ExtUtils::MakeMaker;>
883 C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
887 C<MM-E<gt>new(\%att)-E<gt>flush;>
891 This utility is designed to write a Makefile for an extension module
892 from a Makefile.PL. It is based on the Makefile.SH model provided by
893 Andy Dougherty and the perl5-porters.
895 It splits the task of generating the Makefile into several subroutines
896 that can be individually overridden. Each subroutine returns the text
897 it wishes to have written to the Makefile.
899 MakeMaker is object oriented. Each directory below the current
900 directory that contains a Makefile.PL. Is treated as a separate
901 object. This makes it possible to write an unlimited number of
902 Makefiles with a single invocation of WriteMakefile().
904 =head2 How To Write A Makefile.PL
906 The short answer is: Don't.
908 Always begin with h2xs.
909 Always begin with h2xs!
910 ALWAYS BEGIN WITH H2XS!
912 even if you're not building around a header file, and even if you
913 don't have an XS component.
915 Run h2xs(1) before you start thinking about writing a module. For so
916 called pm-only modules that consist of C<*.pm> files only, h2xs has
917 the C<-X> switch. This will generate dummy files of all kinds that are
918 useful for the module developer.
920 The medium answer is:
922 use ExtUtils::MakeMaker;
923 WriteMakefile( NAME => "Foo::Bar" );
925 The long answer is the rest of the manpage :-)
927 =head2 Default Makefile Behaviour
929 The generated Makefile enables the user of the extension to invoke
931 perl Makefile.PL # optionally "perl Makefile.PL verbose"
933 make test # optionally set TEST_VERBOSE=1
934 make install # See below
936 The Makefile to be produced may be altered by adding arguments of the
937 form C<KEY=VALUE>. E.g.
939 perl Makefile.PL PREFIX=/tmp/myperl5
941 Other interesting targets in the generated Makefile are
943 make config # to check if the Makefile is up-to-date
944 make clean # delete local temp files (Makefile gets renamed)
945 make realclean # delete derived files (including ./blib)
946 make ci # check in all the files in the MANIFEST file
947 make dist # see below the Distribution Support section
951 MakeMaker checks for the existence of a file named F<test.pl> in the
952 current directory and if it exists it adds commands to the test target
953 of the generated Makefile that will execute the script with the proper
954 set of perl C<-I> options.
956 MakeMaker also checks for any files matching glob("t/*.t"). It will
957 add commands to the test target of the generated Makefile that execute
958 all matching files via the L<Test::Harness> module with the C<-I>
959 switches set correctly.
963 A useful variation of the above is the target C<testdb>. It runs the
964 test under the Perl debugger (see L<perldebug>). If the file
965 F<test.pl> exists in the current directory, it is used for the test.
967 If you want to debug some other testfile, set C<TEST_FILE> variable
970 make testdb TEST_FILE=t/mytest.t
972 By default the debugger is called using C<-d> option to perl. If you
973 want to specify some other option, set C<TESTDB_SW> variable:
975 make testdb TESTDB_SW=-Dx
979 make alone puts all relevant files into directories that are named by
980 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_MAN1DIR, and
981 INST_MAN3DIR. All these default to something below ./blib if you are
982 I<not> building below the perl source directory. If you I<are>
983 building below the perl source, INST_LIB and INST_ARCHLIB default to
984 ../../lib, and INST_SCRIPT is not defined.
986 The I<install> target of the generated Makefile copies the files found
987 below each of the INST_* directories to their INSTALL*
988 counterparts. Which counterparts are chosen depends on the setting of
989 INSTALLDIRS according to the following table:
994 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH
995 INST_LIB INSTALLPRIVLIB INSTALLSITELIB
997 INST_SCRIPT INSTALLSCRIPT
998 INST_MAN1DIR INSTALLMAN1DIR
999 INST_MAN3DIR INSTALLMAN3DIR
1001 The INSTALL... macros in turn default to their %Config
1002 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
1004 You can check the values of these variables on your system with
1008 And to check the sequence in which the library directories are
1009 searched by perl, run
1011 perl -le 'print join $/, @INC'
1014 =head2 PREFIX and LIB attribute
1016 PREFIX and LIB can be used to set several INSTALL* attributes in one
1017 go. The quickest way to install a module in a non-standard place might
1020 perl Makefile.PL LIB=~/lib
1022 This will install the module's architecture-independent files into
1023 ~/lib, the architecture-dependent files into ~/lib/$archname/auto.
1025 Another way to specify many INSTALL directories with a single
1026 parameter is PREFIX.
1028 perl Makefile.PL PREFIX=~
1030 This will replace the string specified by $Config{prefix} in all
1031 $Config{install*} values.
1033 Note, that in both cases the tilde expansion is done by MakeMaker, not
1034 by perl by default, nor by make. Conflicts between parameters LIB,
1035 PREFIX and the various INSTALL* arguments are resolved so that
1038 If the user has superuser privileges, and is not working on AFS
1039 (Andrew File System) or relatives, then the defaults for
1040 INSTALLPRIVLIB, INSTALLARCHLIB, INSTALLSCRIPT, etc. will be appropriate,
1041 and this incantation will be the best:
1043 perl Makefile.PL; make; make test
1046 make install per default writes some documentation of what has been
1047 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1048 can be bypassed by calling make pure_install.
1052 will have to specify the installation directories as these most
1053 probably have changed since perl itself has been installed. They will
1054 have to do this by calling
1056 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1057 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1060 Be careful to repeat this procedure every time you recompile an
1061 extension, unless you are sure the AFS installation directories are
1064 =head2 Static Linking of a new Perl Binary
1066 An extension that is built with the above steps is ready to use on
1067 systems supporting dynamic loading. On systems that do not support
1068 dynamic loading, any newly created extension has to be linked together
1069 with the available resources. MakeMaker supports the linking process
1070 by creating appropriate targets in the Makefile whenever an extension
1071 is built. You can invoke the corresponding section of the makefile with
1075 That produces a new perl binary in the current directory with all
1076 extensions linked in that can be found in INST_ARCHLIB , SITELIBEXP,
1077 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1078 UNIX, this is called Makefile.aperl (may be system dependent). If you
1079 want to force the creation of a new perl, it is recommended, that you
1080 delete this Makefile.aperl, so the directories are searched-through
1081 for linkable libraries again.
1083 The binary can be installed into the directory where perl normally
1084 resides on your machine with
1088 To produce a perl binary with a different name than C<perl>, either say
1090 perl Makefile.PL MAP_TARGET=myperl
1097 make myperl MAP_TARGET=myperl
1098 make inst_perl MAP_TARGET=myperl
1100 In any case you will be prompted with the correct invocation of the
1101 C<inst_perl> target that installs the new binary into INSTALLBIN.
1103 make inst_perl per default writes some documentation of what has been
1104 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1105 can be bypassed by calling make pure_inst_perl.
1107 Warning: the inst_perl: target will most probably overwrite your
1108 existing perl binary. Use with care!
1110 Sometimes you might want to build a statically linked perl although
1111 your system supports dynamic loading. In this case you may explicitly
1112 set the linktype with the invocation of the Makefile.PL or make:
1114 perl Makefile.PL LINKTYPE=static # recommended
1118 make LINKTYPE=static # works on most systems
1120 =head2 Determination of Perl Library and Installation Locations
1122 MakeMaker needs to know, or to guess, where certain things are
1123 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1124 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1125 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1127 Extensions may be built either using the contents of the perl source
1128 directory tree or from the installed perl library. The recommended way
1129 is to build extensions after you have run 'make install' on perl
1130 itself. You can do that in any directory on your hard disk that is not
1131 below the perl source tree. The support for extensions below the ext
1132 directory of the perl distribution is only good for the standard
1133 extensions that come with perl.
1135 If an extension is being built below the C<ext/> directory of the perl
1136 source then MakeMaker will set PERL_SRC automatically (e.g.,
1137 C<../..>). If PERL_SRC is defined and the extension is recognized as
1138 a standard extension, then other variables default to the following:
1141 PERL_LIB = PERL_SRC/lib
1142 PERL_ARCHLIB = PERL_SRC/lib
1144 INST_ARCHLIB = PERL_ARCHLIB
1146 If an extension is being built away from the perl source then MakeMaker
1147 will leave PERL_SRC undefined and default to using the installed copy
1148 of the perl library. The other variables default to the following:
1150 PERL_INC = $archlibexp/CORE
1151 PERL_LIB = $privlibexp
1152 PERL_ARCHLIB = $archlibexp
1153 INST_LIB = ./blib/lib
1154 INST_ARCHLIB = ./blib/arch
1156 If perl has not yet been installed then PERL_SRC can be defined on the
1157 command line as shown in the previous section.
1160 =head2 Which architecture dependent directory?
1162 If you don't want to keep the defaults for the INSTALL* macros,
1163 MakeMaker helps you to minimize the typing needed: the usual
1164 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1165 by Configure at perl compilation time. MakeMaker supports the user who
1166 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1167 then MakeMaker defaults the latter to be the same subdirectory of
1168 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1169 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1170 for INSTALLSITELIB and INSTALLSITEARCH.
1172 MakeMaker gives you much more freedom than needed to configure
1173 internal variables and get different results. It is worth to mention,
1174 that make(1) also lets you configure most of the variables that are
1175 used in the Makefile. But in the majority of situations this will not
1176 be necessary, and should only be done, if the author of a package
1177 recommends it (or you know what you're doing).
1179 =head2 Using Attributes and Parameters
1181 The following attributes can be specified as arguments to WriteMakefile()
1182 or as NAME=VALUE pairs on the command line:
1188 String containing name (and email address) of package author(s). Is used
1189 in PPD (Perl Package Description) files for PPM (Perl Package Manager).
1193 One line description of the module. Will be included in PPD file.
1197 Name of the file that contains the package description. MakeMaker looks
1198 for a line in the POD matching /^($package\s-\s)(.*)/. This is typically
1199 the first line in the "=head1 NAME" section. $2 becomes the abstract.
1201 =item BINARY_LOCATION
1203 Used when creating PPD files for binary packages. It can be set to a
1204 full or relative path or URL to the binary archive for a particular
1205 architecture. For example:
1207 perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
1209 builds a PPD package that references a binary of the C<Agent> package,
1210 located in the C<x86> directory relative to the PPD itself.
1214 Ref to array of *.c file names. Initialised from a directory scan
1215 and the values portion of the XS attribute hash. This is not
1216 currently used by MakeMaker but may be handy in Makefile.PLs.
1220 Switch to force usage of the Perl C API even when compiling for PERL_OBJECT.
1222 Note that this attribute is passed through to any recursive build,
1223 but if and only if the submodule's Makefile.PL itself makes no mention
1224 of the 'CAPI' attribute.
1228 String that will be included in the compiler call command line between
1229 the arguments INC and OPTIMIZE.
1233 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1234 config.sh. MakeMaker will add to CONFIG the following values anyway:
1254 CODE reference. The subroutine should return a hash reference. The
1255 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1256 be determined by some evaluation method.
1260 Something like C<"-DHAVE_UNISTD_H">
1264 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1269 Your name for distributing the package (by tar file). This defaults to
1274 Hashref of symbol names for routines to be made available as universal
1275 symbols. Each key/value pair consists of the package name and an
1276 array of routine names in that package. Used only under AIX, OS/2,
1277 VMS and Win32 at present. The routine names supplied will be expanded
1278 in the same way as XSUB names are expanded by the XS() macro.
1281 {"$(NAME)" => ["boot_$(NAME)" ] }
1285 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1286 "NetconfigPtr" => [ 'DESTROY'] }
1288 Please see the L<ExtUtils::Mksymlists> documentation for more information
1289 about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
1293 Array of symbol names for variables to be made available as universal symbols.
1294 Used only under AIX, OS/2, VMS and Win32 at present. Defaults to [].
1295 (e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
1299 Array of extension names to exclude when doing a static build. This
1300 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1301 details. (e.g. [ qw( Socket POSIX ) ] )
1303 This attribute may be most useful when specified as a string on the
1304 command line: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1308 Ref to array of executable files. The files will be copied to the
1309 INST_SCRIPT directory. Make realclean will delete them from there
1312 =item FIRST_MAKEFILE
1314 The name of the Makefile to be produced. Defaults to the contents of
1315 MAKEFILE, but can be overridden. This is used for the second Makefile
1316 that will be produced for the MAP_TARGET.
1320 Perl binary able to run this extension.
1324 This provides an alternate means to specify function names to be
1325 exported from the extension. Its value is a reference to an
1326 array of function names to be exported by the extension. These
1327 names are passed through unaltered to the linker options file.
1331 Ref to array of *.h file names. Similar to C.
1335 This attribute is used to specify names to be imported into the
1336 extension. It is only used on OS/2 and Win32.
1340 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1344 Array of extension names to be included when doing a static build.
1345 MakeMaker will normally build with all of the installed extensions when
1346 doing a static build, and that is usually the desired behavior. If
1347 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1348 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1350 It is not necessary to mention DynaLoader or the current extension when
1351 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1352 only DynaLoader and the current extension will be included in the build.
1354 This attribute may be most useful when specified as a string on the
1355 command line: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1357 =item INSTALLARCHLIB
1359 Used by 'make install', which copies files from INST_ARCHLIB to this
1360 directory if INSTALLDIRS is set to perl.
1364 Directory to install binary files (e.g. tkperl) into.
1368 Determines which of the two sets of installation directories to
1369 choose: installprivlib and installarchlib versus installsitelib and
1370 installsitearch. The first pair is chosen with INSTALLDIRS=perl, the
1371 second with INSTALLDIRS=site. Default is site.
1373 =item INSTALLMAN1DIR
1375 This directory gets the man pages at 'make install' time. Defaults to
1376 $Config{installman1dir}.
1378 =item INSTALLMAN3DIR
1380 This directory gets the man pages at 'make install' time. Defaults to
1381 $Config{installman3dir}.
1383 =item INSTALLPRIVLIB
1385 Used by 'make install', which copies files from INST_LIB to this
1386 directory if INSTALLDIRS is set to perl.
1390 Used by 'make install' which copies files from INST_SCRIPT to this
1393 =item INSTALLSITEARCH
1395 Used by 'make install', which copies files from INST_ARCHLIB to this
1396 directory if INSTALLDIRS is set to site (default).
1398 =item INSTALLSITELIB
1400 Used by 'make install', which copies files from INST_LIB to this
1401 directory if INSTALLDIRS is set to site (default).
1405 Same as INST_LIB for architecture dependent files.
1409 Directory to put real binary files during 'make'. These will be copied
1410 to INSTALLBIN during 'make install'
1414 Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you
1419 Directory where we put library files of this extension while building
1424 Directory to hold the man pages at 'make' time
1428 Directory to hold the man pages at 'make' time
1432 Directory, where executable files should be installed during
1433 'make'. Defaults to "./blib/bin", just to have a dummy location during
1434 testing. make install will copy the files in INST_SCRIPT to
1439 defaults to "$(OBJECT)" and is used in the ld command to specify
1440 what files to link/load from (also see dynamic_lib below for how to
1445 LIB can only be set at C<perl Makefile.PL> time. It has the effect of
1446 setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any
1450 The filename of the perllibrary that will be used together with this
1451 extension. Defaults to libperl.a.
1455 An anonymous array of alternative library
1456 specifications to be searched for (in order) until
1457 at least one library is found. E.g.
1459 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1461 Mind, that any element of the array
1462 contains a complete set of arguments for the ld
1463 command. So do not specify
1465 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1467 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1468 you specify a scalar as in
1470 'LIBS' => "-ltcl -ltk -lX11"
1472 MakeMaker will turn it into an array with one element.
1476 'static' or 'dynamic' (default unless usedl=undef in
1477 config.sh). Should only be used to force static linking (also see
1482 Boolean which tells MakeMaker, that it should include the rules to
1483 make a perl. This is handled automatically as a switch by
1484 MakeMaker. The user normally does not need it.
1488 The name of the Makefile to be produced.
1492 Hashref of pod-containing files. MakeMaker will default this to all
1493 EXE_FILES files that include POD directives. The files listed
1494 here will be converted to man pages and installed as was requested
1499 Hashref of .pm and .pod files. MakeMaker will default this to all
1500 .pod and any .pm files that include POD directives. The files listed
1501 here will be converted to man pages and installed as was requested
1506 If it is intended, that a new perl binary be produced, this variable
1507 may hold a name for that binary. Defaults to perl
1511 If the extension links to a library that it builds set this to the
1512 name of the library (see SDBM_File)
1516 Perl module name for this extension (DBD::Oracle). This will default
1517 to the directory name but should be explicitly defined in the
1522 MakeMaker will figure out, if an extension contains linkable code
1523 anywhere down the directory tree, and will set this variable
1524 accordingly, but you can speed it up a very little bit, if you define
1525 this boolean variable yourself.
1529 Defaults to C<@>. By setting it to an empty string you can generate a
1530 Makefile that echos all commands. Mainly used in debugging MakeMaker
1535 Boolean. Attribute to inhibit descending into subdirectories.
1539 In general any generated Makefile checks for the current version of
1540 MakeMaker and the version the Makefile was built under. If NO_VC is
1541 set, the version check is neglected. Do not write this into your
1542 Makefile.PL, use it interactively instead.
1546 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1547 string containing all object files, e.g. "tkpBind.o
1548 tkpButton.o tkpCanvas.o"
1552 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1553 passed to subdirectory makes.
1557 Perl binary for tasks that can be done by miniperl
1561 The call to the program that is able to compile perlmain.c. Defaults
1566 Same as above for architecture dependent files
1570 Directory containing the Perl library to use.
1574 Directory containing the Perl source code (use of this should be
1575 avoided, it may be undefined)
1579 Desired permission for read/writable files. Defaults to C<644>.
1580 See also L<MM_Unix/perm_rw>.
1584 Desired permission for executable files. Defaults to C<755>.
1585 See also L<MM_Unix/perm_rwx>.
1589 Ref to hash of files to be processed as perl programs. MakeMaker
1590 will default to any found *.PL file (except Makefile.PL) being keys
1591 and the basename of the file being the value. E.g.
1593 {'foobar.PL' => 'foobar'}
1595 The *.PL files are expected to produce output to the target files
1596 themselves. If multiple files can be generated from the same *.PL
1597 file then the value in the hash can be a reference to an array of
1598 target file names. E.g.
1600 {'foobar.PL' => ['foobar1','foobar2']}
1604 Hashref of .pm files and *.pl files to be installed. e.g.
1606 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1608 By default this will include *.pm and *.pl and the files found in
1609 the PMLIBDIRS directories. Defining PM in the
1610 Makefile.PL will override PMLIBDIRS.
1614 Ref to array of subdirectories containing library files. Defaults to
1615 [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
1616 they contain will be installed in the corresponding location in the
1617 library. A libscan() method can be used to alter the behaviour.
1618 Defining PM in the Makefile.PL will override PMLIBDIRS.
1620 =item PPM_INSTALL_EXEC
1622 Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl)
1624 =item PPM_INSTALL_SCRIPT
1626 Name of the script that gets executed by the Perl Package Manager after
1627 the installation of a package.
1631 Can be used to set the three INSTALL* attributes in one go (except for
1632 probably INSTALLMAN1DIR, if it is not below PREFIX according to
1633 %Config). They will have PREFIX as a common directory node and will
1634 branch from that node into lib/, lib/ARCHNAME or whatever Configure
1635 decided at the build time of your perl (unless you override one of
1640 Hashref: Names of modules that need to be available to run this
1641 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1642 desired version is the value. If the required version number is 0, we
1643 only check if any version is installed already.
1647 Arryref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1648 Makefile. Caution! Do not use the SKIP attribute for the neglectible
1649 speedup. It may seriously damage the resulting Makefile. Only use it,
1650 if you really need it.
1654 Ref to array of typemap file names. Use this when the typemaps are
1655 in some directory other than the current directory or when they are
1656 not named B<typemap>. The last typemap in the list takes
1657 precedence. A typemap in the current directory has highest
1658 precedence, even if it isn't listed in TYPEMAPS. The default system
1659 typemap has lowest precedence.
1663 Your version number for distributing the package. This defaults to
1668 Instead of specifying the VERSION in the Makefile.PL you can let
1669 MakeMaker parse a file to determine the version number. The parsing
1670 routine requires that the file named by VERSION_FROM contains one
1671 single line to compute the version number. The first line in the file
1672 that contains the regular expression
1674 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
1676 will be evaluated with eval() and the value of the named variable
1677 B<after> the eval() will be assigned to the VERSION attribute of the
1678 MakeMaker object. The following lines will be parsed o.k.:
1682 ( $VERSION ) = '$Revision: 1.222 $ ' =~ /\$Revision:\s+([^\s]+)/;
1683 $FOO::VERSION = '1.10';
1684 *FOO::VERSION = \'1.11';
1686 but these will fail:
1688 my $VERSION = '1.01';
1689 local $VERSION = '1.02';
1690 local $FOO::VERSION = '1.30';
1692 The file named in VERSION_FROM is not added as a dependency to
1693 Makefile. This is not really correct, but it would be a major pain
1694 during development to have to rewrite the Makefile for any smallish
1695 change in that file. If you want to make sure that the Makefile
1696 contains the correct VERSION macro after any change of the file, you
1697 would have to do something like
1699 depend => { Makefile => '$(VERSION_FROM)' }
1701 See attribute C<depend> below.
1705 Hashref of .xs files. MakeMaker will default this. e.g.
1707 {'name_of_file.xs' => 'name_of_file.c'}
1709 The .c files will automatically be included in the list of files
1710 deleted by a make clean.
1714 String of options to pass to xsubpp. This might include C<-C++> or
1715 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
1720 May be set to an empty string, which is identical to C<-prototypes>, or
1721 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
1722 defaults to the empty string.
1726 Your version number for the .xs file of this package. This defaults
1727 to the value of the VERSION attribute.
1731 =head2 Additional lowercase attributes
1733 can be used to pass parameters to the methods which implement that
1734 part of the Makefile.
1740 {FILES => "*.xyz foo"}
1744 {ANY_TARGET => ANY_DEPENDECY, ...}
1748 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
1749 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
1750 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
1752 If you specify COMPRESS, then SUFFIX should also be altered, as it is
1753 needed to tell make the target file of the compression. Setting
1754 DIST_CP to ln can be useful, if you need to preserve the timestamps on
1755 your files. DIST_CP can take the values 'cp', which copies the file,
1756 'ln', which links the file, and 'best' which copies symbolic links and
1757 links the rest. Default is 'best'.
1761 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
1765 {LINKTYPE => 'static', 'dynamic' or ''}
1767 NB: Extensions that have nothing but *.pm files had to say
1771 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1772 can be deleted safely. MakeMaker recognizes, when there's nothing to
1777 {ANY_MACRO => ANY_VALUE, ...}
1781 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
1787 =item tool_autosplit
1793 =head2 Overriding MakeMaker Methods
1795 If you cannot achieve the desired Makefile behaviour by specifying
1796 attributes you may define private subroutines in the Makefile.PL.
1797 Each subroutines returns the text it wishes to have written to
1798 the Makefile. To override a section of the Makefile you can
1801 sub MY::c_o { "new literal text" }
1803 or you can edit the default by saying something like:
1806 package MY; # so that "SUPER" works right
1807 my $inherited = shift->SUPER::c_o(@_);
1808 $inherited =~ s/old text/new text/;
1812 If you are running experiments with embedding perl as a library into
1813 other applications, you might find MakeMaker is not sufficient. You'd
1814 better have a look at ExtUtils::Embed which is a collection of utilities
1817 If you still need a different solution, try to develop another
1818 subroutine that fits your needs and submit the diffs to
1819 F<perl5-porters@perl.org> or F<comp.lang.perl.moderated> as appropriate.
1821 For a complete description of all MakeMaker methods see L<ExtUtils::MM_Unix>.
1823 Here is a simple example of how to add a new target to the generated
1828 $(MYEXTLIB): sdbm/Makefile
1829 cd sdbm && $(MAKE) all
1834 =head2 Hintsfile support
1836 MakeMaker.pm uses the architecture specific information from
1837 Config.pm. In addition it evaluates architecture specific hints files
1838 in a C<hints/> directory. The hints files are expected to be named
1839 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
1840 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
1841 MakeMaker within the WriteMakefile() subroutine, and can be used to
1842 execute commands as well as to include special variables. The rules
1843 which hintsfile is chosen are the same as in Configure.
1845 The hintsfile is eval()ed immediately after the arguments given to
1846 WriteMakefile are stuffed into a hash reference $self but before this
1847 reference becomes blessed. So if you want to do the equivalent to
1848 override or create an attribute you would say something like
1850 $self->{LIBS} = ['-ldbm -lucb -lc'];
1852 =head2 Distribution Support
1854 For authors of extensions MakeMaker provides several Makefile
1855 targets. Most of the support comes from the ExtUtils::Manifest module,
1856 where additional documentation can be found.
1860 =item make distcheck
1862 reports which files are below the build directory but not in the
1863 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
1866 =item make skipcheck
1868 reports which files are skipped due to the entries in the
1869 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
1872 =item make distclean
1874 does a realclean first and then the distcheck. Note that this is not
1875 needed to build a new distribution as long as you are sure, that the
1876 MANIFEST file is ok.
1880 rewrites the MANIFEST file, adding all remaining files found (See
1881 ExtUtils::Manifest::mkmanifest() for details)
1885 Copies all the files that are in the MANIFEST file to a newly created
1886 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
1887 exists, it will be removed first.
1891 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
1892 a make test in that directory.
1896 First does a distdir. Then a command $(PREOP) which defaults to a null
1897 command, followed by $(TOUNIX), which defaults to a null command under
1898 UNIX, and will convert files in distribution directory to UNIX format
1899 otherwise. Next it runs C<tar> on that directory into a tarfile and
1900 deletes the directory. Finishes with a command $(POSTOP) which
1901 defaults to a null command.
1905 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
1907 =item make uutardist
1909 Runs a tardist first and uuencodes the tarfile.
1913 First does a distdir. Then a command $(PREOP) which defaults to a null
1914 command. Next it runs C<shar> on that directory into a sharfile and
1915 deletes the intermediate directory again. Finishes with a command
1916 $(POSTOP) which defaults to a null command. Note: For shdist to work
1917 properly a C<shar> program that can handle directories is mandatory.
1921 First does a distdir. Then a command $(PREOP) which defaults to a null
1922 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
1923 zipfile. Then deletes that directory. Finishes with a command
1924 $(POSTOP) which defaults to a null command.
1928 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
1932 Customization of the dist targets can be done by specifying a hash
1933 reference to the dist attribute of the WriteMakefile call. The
1934 following parameters are recognized:
1937 COMPRESS ('gzip --best')
1940 TO_UNIX (depends on the system)
1941 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
1951 WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" })
1953 =head2 Disabling an extension
1955 If some events detected in F<Makefile.PL> imply that there is no way
1956 to create the Module, but this is a normal state of things, then you
1957 can create a F<Makefile> which does nothing, but succeeds on all the
1958 "usual" build targets. To do so, use
1960 ExtUtils::MakeMaker::WriteEmptyMakefile();
1962 instead of WriteMakefile().
1964 This may be useful if other modules expect this module to be I<built>
1965 OK, as opposed to I<work> OK (say, this system-dependent module builds
1966 in a subdirectory of some other distribution, or is listed as a
1967 dependency in a CPAN::Bundle, but the functionality is supported by
1968 different means on the current architecture).
1976 Command line options used by C<MakeMaker-E<gt>new()>, and thus by
1977 C<WriteMakefile()>. The string is split on whitespace, and the result
1978 is processed before any actual command line arguments are processed.
1984 ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib,
1985 ExtUtils::Install, ExtUtils::Embed
1989 Andy Dougherty <F<doughera@lafcol.lafayette.edu>>, Andreas KE<ouml>nig
1990 <F<A.Koenig@franz.ww.TU-Berlin.DE>>, Tim Bunce <F<Tim.Bunce@ig.co.uk>>.
1991 VMS support by Charles Bailey <F<bailey@newman.upenn.edu>>. OS/2
1992 support by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>. Contact the
1993 makemaker mailing list C<mailto:makemaker@franz.ww.tu-berlin.de>, if
1994 you have any questions.