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
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::Kid 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::Kid;
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 eq 'cygwin';
74 $Is_NetWare = $Config{'osname'} eq 'NetWare';
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_MacOS;
89 require ExtUtils::MM_NW5;
93 require ExtUtils::MM_Win32;
96 require ExtUtils::MM_Cygwin;
101 # The use of the Version_check target has been dropped between perl
102 # 5.5.63 and 5.5.64. We must keep the subroutine for a while so that
103 # old Makefiles can satisfy the Version_check target.
106 my($checkversion) = @_;
107 die "Your Makefile was built with ExtUtils::MakeMaker v $checkversion.
108 Current Version is $ExtUtils::MakeMaker::VERSION. There have been considerable
109 changes in the meantime.
110 Please rerun 'perl Makefile.PL' to regenerate the Makefile.\n"
111 if $checkversion < $Version_OK;
112 printf STDOUT "%s %s %s %s.\n", "Makefile built with ExtUtils::MakeMaker v",
113 $checkversion, "Current Version is", $VERSION
114 unless $checkversion == $VERSION;
118 $_[0] =~ /^Use of uninitialized value/ && return;
119 $_[0] =~ /used only once/ && return;
120 $_[0] =~ /^Subroutine\s+[\w:]+\s+redefined/ && return;
125 Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
126 local $SIG{__WARN__} = \&warnhandler;
129 MM->new(\%att)->flush;
134 $ISA_TTY = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ; # Pipe?
135 Carp::confess("prompt function called without an argument") unless defined $mess;
136 my $dispdef = defined $def ? "[$def] " : " ";
137 $def = defined $def ? $def : "";
140 print "$mess $dispdef";
141 if ($ISA_TTY && !$ENV{PERL_MM_USE_DEFAULT}) {
142 chomp($ans = <STDIN>);
146 return ($ans ne '') ? $ans : $def;
149 sub eval_in_subdirs {
152 use Cwd qw(cwd abs_path);
154 local @INC = map eval {abs_path($_) if -e} || $_, @INC;
156 foreach $dir (@{$self->{DIR}}){
157 my($abs) = $self->catdir($pwd,$dir);
158 $self->eval_in_x($abs);
166 chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
168 # my $fh = new FileHandle;
169 # $fh->open("Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
171 open(FH,"Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
172 # my $eval = join "", <$fh>;
173 my $eval = join "", <FH>;
178 # if ($@ =~ /prerequisites/) {
179 # die "MakeMaker WARNING: $@";
181 # warn "WARNING from evaluation of $dir/Makefile.PL: $@";
183 warn "WARNING from evaluation of $dir/Makefile.PL: $@";
190 # package name for the classes into which the first object will be blessed
191 $PACKNAME = "PACK000";
195 AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION
196 C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
197 EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE FULLPERL FUNCLIST H
198 HTMLLIBPODS HTMLSCRIPTPODS IMPORTS
199 INC INCLUDE_EXT INSTALLARCHLIB INSTALLBIN INSTALLDIRS INSTALLHTMLPRIVLIBDIR
200 INSTALLHTMLSCRIPTDIR INSTALLHTMLSITELIBDIR INSTALLMAN1DIR
201 INSTALLMAN3DIR INSTALLPRIVLIB INSTALLSCRIPT INSTALLSITEARCH
202 INSTALLSITELIB INST_ARCHLIB INST_BIN INST_EXE INST_LIB
203 INST_HTMLLIBDIR INST_HTMLSCRIPTDIR
204 INST_MAN1DIR INST_MAN3DIR INST_SCRIPT LDFROM LIB LIBPERL_A LIBS
205 LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB
207 NAME NEEDS_LINKING NOECHO NORECURS NO_VC OBJECT OPTIMIZE PERL PERLMAINCC
208 PERLRUN PERLRUNINST PERL_ARCHLIB PERL_CORE
209 PERL_LIB PERL_SRC PERM_RW PERM_RWX
210 PL_FILES PM PM_FILTER PMLIBDIRS POLLUTE PPM_INSTALL_EXEC
211 PPM_INSTALL_SCRIPT PREFIX
212 PREREQ_FATAL PREREQ_PM PREREQ_PRINT PRINT_PREREQ
213 SKIP TEST_LIBS TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
214 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
216 MACPERL_SRC MACPERL_LIB MACLIBS_68K MACLIBS_PPC MACLIBS_SC MACLIBS_MRC
217 MACLIBS_ALL_68K MACLIBS_ALL_PPC MACLIBS_SHARED
220 # IMPORTS is used under OS/2 and Win32
222 # @Overridable is close to @MM_Sections but not identical. The
223 # order is important. Many subroutines declare macros. These
224 # depend on each other. Let's try to collect the macros up front,
225 # then pasthru, then the rules.
227 # MM_Sections are the sections we have to call explicitly
228 # in Overridable we have subroutines that are used indirectly
234 post_initialize const_config constants tool_autosplit tool_xsubpp
235 tools_other dist macro depend cflags const_loadlibs const_cccmd
240 c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs
241 dynamic_lib static static_lib htmlifypods manifypods processPL
243 clean realclean dist_basics dist_core dist_dir dist_test dist_ci
244 install force perldepend makefile staticmake test ppd
246 ); # loses section ordering
248 @Overridable = @MM_Sections;
249 push @Overridable, qw[
251 dir_target libscan makeaperl needs_linking perm_rw perm_rwx
252 subdir_x test_via_harness test_via_script
255 push @MM_Sections, qw[
257 pm_to_blib selfdocument
261 # Postamble needs to be the last that was always the case
262 push @MM_Sections, "postamble";
263 push @Overridable, "postamble";
265 # All sections are valid keys.
266 @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
268 # we will use all these variables in the Makefile
271 ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc
272 lib_ext obj_ext osname osvers ranlib sitelibexp sitearchexp so
277 foreach $item (@Attrib_help){
278 $Recognized_Att_Keys{$item} = 1;
280 foreach $item (@Get_from_Config) {
281 $Recognized_Att_Keys{uc $item} = $Config{$item};
282 print "Attribute '\U$item\E' => '$Config{$item}'\n"
287 # When we eval a Makefile.PL in a subdirectory, that one will ask
288 # us (the parent) for the values and will prepend "..", so that
289 # all files to be installed end up below OUR ./blib
294 INST_BIN 1 INST_EXE 1 INST_LIB 1 INST_ARCHLIB 1 INST_SCRIPT 1
295 MAP_TARGET 1 INST_HTMLLIBDIR 1 INST_HTMLSCRIPTDIR 1
296 INST_MAN1DIR 1 INST_MAN3DIR 1 PERL_SRC 1 PERL 1 FULLPERL 1
301 NEEDS_LINKING HAS_LINK_CODE
303 @Keep_after_flush{@keep} = (1) x @keep;
309 The extension you are trying to build apparently is rather old and
310 most probably outdated. We detect that from the fact, that a
311 subroutine "writeMakefile" is called, and this subroutine is not
312 supported anymore since about October 1994.
314 Please contact the author or look into CPAN (details about CPAN can be
315 found in the FAQ and at http:/www.perl.com) for a more recent version
316 of the extension. If you're really desperate, you can try to change
317 the subroutine name from writeMakefile to WriteMakefile and rerun
318 'perl Makefile.PL', but you're most probably left alone, when you do
326 sub ExtUtils::MakeMaker::new {
327 my($class,$self) = @_;
330 if ("@ARGV" =~ /\bPREREQ_PRINT\b/) {
331 require Data::Dumper;
332 print Data::Dumper->Dump([$self->{PREREQ_PM}], [qw(PREREQ_PM)]);
335 # PRINT_PREREQ is RedHatism.
336 if ("@ARGV" =~ /\bPRINT_PREREQ\b/) {
337 print join(" ", map { "perl($_)>=$self->{PREREQ_PM}->{$_} " } sort keys %{$self->{PREREQ_PM}}), "\n";
341 print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
342 if (-f "MANIFEST" && ! -f "Makefile"){
346 $self = {} unless (defined $self);
350 my %configure_att; # record &{$self->{CONFIGURE}} attributes
351 my(%initial_att) = %$self; # record initial attributes
353 my(%unsatisfied) = ();
355 foreach $prereq (sort keys %{$self->{PREREQ_PM}}) {
356 my $eval = "require $prereq";
360 warn "Warning: prerequisite $prereq $self->{PREREQ_PM}->{$prereq} not found.\n" unless $self->{PREREQ_FATAL};
361 $unsatisfied{$prereq} = 'not installed';
362 } elsif ($prereq->VERSION < $self->{PREREQ_PM}->{$prereq} ){
363 warn "Warning: prerequisite $prereq $self->{PREREQ_PM}->{$prereq} not found. We have"
364 . ($prereq->VERSION || 'unknown version') unless $self->{PREREQ_FATAL};
365 $unsatisfied{$prereq} = $self->{PREREQ_PM}->{$prereq} ? $self->{PREREQ_PM}->{$prereq} : 'unknown version' ;
368 if (%unsatisfied && $self->{PREREQ_FATAL}){
369 # unless (defined $ExtUtils::MakeMaker::useCPAN) {
370 my $failedprereqs = join ', ', map {"$_ $unsatisfied{$_}"} keys %unsatisfied;
371 die qq{MakeMaker FATAL: prerequisites not found ($failedprereqs)
372 Please install these modules first and rerun 'perl Makefile.PL'.\n};
373 # if ($ExtUtils::MakeMaker::hasCPAN) {
374 # $ExtUtils::MakeMaker::useCPAN = prompt(qq{Should I try to use the CPAN module to fetch them for you?},"yes");
376 # print qq{Hint: You may want to install the CPAN module to autofetch the needed modules\n};
377 # $ExtUtils::MakeMaker::useCPAN=0;
380 # if ($ExtUtils::MakeMaker::useCPAN) {
382 # CPAN->import(@unsatisfied);
384 # die qq{prerequisites not found (@unsatisfied)};
386 # warn qq{WARNING: prerequisites not found (@unsatisfied)};
389 if (defined $self->{CONFIGURE}) {
390 if (ref $self->{CONFIGURE} eq 'CODE') {
391 %configure_att = %{&{$self->{CONFIGURE}}};
392 $self = { %$self, %configure_att };
394 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
398 # This is for old Makefiles written pre 5.00, will go away
399 if ( Carp::longmess("") =~ /runsubdirpl/s ){
400 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
403 my $newclass = ++$PACKNAME;
404 local @Parent = @Parent; # Protect against non-local exits
407 print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
408 mv_all_methods("MY",$newclass);
409 bless $self, $newclass;
411 @{"$newclass\:\:ISA"} = 'MM';
414 if (defined $Parent[-2]){
415 $self->{PARENT} = $Parent[-2];
417 for $key (keys %Prepend_dot_dot) {
418 next unless defined $self->{PARENT}{$key};
419 $self->{$key} = $self->{PARENT}{$key};
420 # PERL and FULLPERL may be command verbs instead of full
421 # file specifications under VMS. If so, don't turn them
423 $self->{$key} = $self->catdir("..",$self->{$key})
424 unless $self->file_name_is_absolute($self->{$key})
425 || ($^O eq 'VMS' and ($key =~ /PERL$/ && $self->{$key} =~ /^[\w\-\$]+$/));
427 if ($self->{PARENT}) {
428 $self->{PARENT}->{CHILDREN}->{$newclass} = $self;
429 foreach my $opt (qw(POLLUTE PERL_CORE)) {
430 if (exists $self->{PARENT}->{$opt}
431 and not exists $self->{$opt})
433 # inherit, but only if already unspecified
434 $self->{$opt} = $self->{PARENT}->{$opt};
438 my @fm = grep /^FIRST_MAKEFILE=/, @ARGV;
439 parse_args($self,@fm) if @fm;
441 parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV);
444 $self->{NAME} ||= $self->guess_name;
446 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
450 if (! $self->{PERL_SRC} ) {
451 my($pthinks) = $self->canonpath($INC{'Config.pm'});
452 my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
453 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
454 if ($pthinks ne $cthinks &&
455 !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
456 print "Have $pthinks expected $cthinks\n";
458 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
461 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
463 print STDOUT <<END unless $self->{UNINSTALLED_PERL};
464 Your perl and your Config.pm seem to have different ideas about the architecture
466 Perl thinks: [$pthinks]
467 Config says: [$Config{archname}]
468 This may or may not cause problems. Please check your installation of perl if you
469 have problems building this extension.
474 $self->init_dirscan();
475 $self->init_others();
476 my($argv) = neatvalue(\@ARGV);
480 push @{$self->{RESULT}}, <<END;
481 # This Makefile is for the $self->{NAME} extension to perl.
483 # It was generated automatically by MakeMaker version
484 # $VERSION (Revision: $Revision) from the contents of
485 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
487 # ANY CHANGES MADE HERE WILL BE LOST!
489 # MakeMaker ARGV: $argv
491 # MakeMaker Parameters:
494 foreach $key (sort keys %initial_att){
495 my($v) = neatvalue($initial_att{$key});
496 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
498 push @{$self->{RESULT}}, "# $key => $v";
500 undef %initial_att; # free memory
502 if (defined $self->{CONFIGURE}) {
503 push @{$self->{RESULT}}, <<END;
505 # MakeMaker 'CONFIGURE' Parameters:
507 if (scalar(keys %configure_att) > 0) {
508 foreach $key (sort keys %configure_att){
509 my($v) = neatvalue($configure_att{$key});
510 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
512 push @{$self->{RESULT}}, "# $key => $v";
517 push @{$self->{RESULT}}, "# no values returned";
519 undef %configure_att; # free memory
522 # turn the SKIP array into a SKIPHASH hash
524 for $skip (@{$self->{SKIP} || []}) {
525 $self->{SKIPHASH}{$skip} = 1;
527 delete $self->{SKIP}; # free memory
529 if ($self->{PARENT}) {
530 for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
531 $self->{SKIPHASH}{$_} = 1;
535 # We run all the subdirectories now. They don't have much to query
536 # from the parent, but the parent has to query them: if they need linking!
537 unless ($self->{NORECURS}) {
538 $self->eval_in_subdirs if @{$self->{DIR}};
542 foreach $section ( @MM_Sections ){
543 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
544 my($skipit) = $self->skipcheck($section);
546 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
548 my(%a) = %{$self->{$section} || {}};
549 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
550 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
551 push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
555 push @{$self->{RESULT}}, "\n# End.";
560 sub WriteEmptyMakefile {
561 Carp::croak "WriteEmptyMakefile: Need even number of args" if @_ % 2;
562 local $SIG{__WARN__} = \&warnhandler;
565 my $self = MM->new(\%att);
566 if (-f "$self->{MAKEFILE}.old") {
567 chmod 0666, "$self->{MAKEFILE}.old";
568 unlink "$self->{MAKEFILE}.old" or warn "unlink $self->{MAKEFILE}.old: $!";
570 rename $self->{MAKEFILE}, "$self->{MAKEFILE}.old"
571 or warn "rename $self->{MAKEFILE} $self->{MAKEFILE}.old: $!"
572 if -f $self->{MAKEFILE};
573 open MF, '>', $self->{MAKEFILE} or die "open $self->{MAKEFILE} for write: $!";
586 close MF or die "close $self->{MAKEFILE} for write: $!";
590 print STDOUT "Checking if your kit is complete...\n";
591 require ExtUtils::Manifest;
592 $ExtUtils::Manifest::Quiet=$ExtUtils::Manifest::Quiet=1; #avoid warning
593 my(@missed)=ExtUtils::Manifest::manicheck();
595 print STDOUT "Warning: the following files are missing in your kit:\n";
596 print "\t", join "\n\t", @missed;
598 print STDOUT "Please inform the author.\n";
600 print STDOUT "Looks good\n";
605 my($self, @args) = @_;
607 unless (m/(.*?)=(.*)/){
608 help(),exit 1 if m/^help$/;
609 ++$Verbose if m/^verb/;
612 my($name, $value) = ($1, $2);
613 if ($value =~ m/^~(\w+)?/){ # tilde with optional username
614 $value =~ s [^~(\w*)]
616 ((getpwnam($1))[7] || "~$1") :
620 $self->{uc($name)} = $value;
623 # catch old-style 'potential_libs' and inform user how to 'upgrade'
624 if (defined $self->{potential_libs}){
625 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
626 if ($self->{potential_libs}){
627 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
629 print STDOUT "$msg deleted.\n";
631 $self->{LIBS} = [$self->{potential_libs}];
632 delete $self->{potential_libs};
634 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
635 if (defined $self->{ARMAYBE}){
636 my($armaybe) = $self->{ARMAYBE};
637 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
638 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
639 my(%dl) = %{$self->{dynamic_lib} || {}};
640 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
641 delete $self->{ARMAYBE};
643 if (defined $self->{LDTARGET}){
644 print STDOUT "LDTARGET should be changed to LDFROM\n";
645 $self->{LDFROM} = $self->{LDTARGET};
646 delete $self->{LDTARGET};
648 # Turn a DIR argument on the command line into an array
649 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
650 # So they can choose from the command line, which extensions they want
651 # the grep enables them to have some colons too much in case they
652 # have to build a list with the shell
653 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
655 # Turn a INCLUDE_EXT argument on the command line into an array
656 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
657 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
659 # Turn a EXCLUDE_EXT argument on the command line into an array
660 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
661 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
664 foreach $mmkey (sort keys %$self){
665 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
666 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
667 unless exists $Recognized_Att_Keys{$mmkey};
674 # We allow extension-specific hints files.
676 return unless -d "hints";
678 # First we look for the best hintsfile we have
680 my($hint)="${^O}_$Config{osvers}";
685 # Also try without trailing minor version numbers.
687 last if -f "hints/$hint.pl"; # found
689 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
691 return unless -f "hints/$hint.pl"; # really there
693 # execute the hintsfile:
695 # my $fh = new FileHandle;
696 # $fh->open("hints/$hint.pl");
698 open(FH,"hints/$hint.pl");
699 # @goodhints = <$fh>;
703 print STDOUT "Processing hints file hints/$hint.pl\n";
704 eval join('',@goodhints);
705 print STDOUT $@ if $@;
711 my($symtab) = \%{"${from}::"};
714 # Here you see the *current* list of methods that are overridable
715 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
716 # still trying to reduce the list to some reasonable minimum --
717 # because I want to make it easier for the user. A.K.
719 foreach $method (@Overridable) {
721 # We cannot say "next" here. Nick might call MY->makeaperl
722 # which isn't defined right now
724 # Above statement was written at 4.23 time when Tk-b8 was
725 # around. As Tk-b9 only builds with 5.002something and MM 5 is
726 # standard, we try to enable the next line again. It was
727 # commented out until MM 5.23
729 next unless defined &{"${from}::$method"};
731 *{"${to}::$method"} = \&{"${from}::$method"};
733 # delete would do, if we were sure, nobody ever called
734 # MY->makeaperl directly
736 # delete $symtab->{$method};
738 # If we delete a method, then it will be undefined and cannot
739 # be called. But as long as we have Makefile.PLs that rely on
740 # %MY:: being intact, we have to fill the hole with an
743 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
746 # We have to clean out %INC also, because the current directory is
747 # changed frequently and Graham Barr prefers to get his version
748 # out of a History.pl file which is "required" so woudn't get
749 # loaded again in another extension requiring a History.pl
751 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
752 # to core dump in the middle of a require statement. The required
753 # file was Tk/MMutil.pm. The consequence is, we have to be
754 # extremely careful when we try to give perl a reason to reload a
755 # library with same name. The workaround prefers to drop nothing
756 # from %INC and teach the writers not to use such libraries.
759 # foreach $inc (keys %INC) {
760 # #warn "***$inc*** deleted";
768 if ($section eq 'dynamic') {
769 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
770 "in skipped section 'dynamic_bs'\n"
771 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
772 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
773 "in skipped section 'dynamic_lib'\n"
774 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
776 if ($section eq 'dynamic_lib') {
777 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
778 "targets in skipped section 'dynamic_bs'\n"
779 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
781 if ($section eq 'static') {
782 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
783 "in skipped section 'static_lib'\n"
784 if $self->{SKIPHASH}{static_lib} && $Verbose;
786 return 'skipped' if $self->{SKIPHASH}{$section};
794 # my $fh = new FileHandle;
796 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
798 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
799 # $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
800 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
802 for $chunk (@{$self->{RESULT}}) {
803 # print $fh "$chunk\n";
809 my($finalname) = $self->{MAKEFILE};
810 rename("MakeMaker.tmp", $finalname);
811 chmod 0644, $finalname unless $Is_VMS;
813 if ($self->{PARENT}) {
814 foreach (keys %$self) { # safe memory
815 delete $self->{$_} unless $Keep_after_flush{$_};
819 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
822 # The following mkbootstrap() is only for installations that are calling
823 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
824 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
827 !!! Your Makefile has been built such a long time ago, !!!
828 !!! that is unlikely to work with current MakeMaker. !!!
829 !!! Please rebuild your Makefile !!!
833 # Ditto for mksymlists() as of MakeMaker 5.17
836 !!! Your Makefile has been built such a long time ago, !!!
837 !!! that is unlikely to work with current MakeMaker. !!!
838 !!! Please rebuild your Makefile !!!
844 return "undef" unless defined $v;
846 return "q[$v]" unless $t;
848 my(@m, $elem, @neat);
850 foreach $elem (@$v) {
851 push @neat, "q[$elem]";
853 push @m, join ", ", @neat;
857 return "$v" unless $t eq 'HASH';
859 while (($key,$val) = each %$v){
860 last unless defined $key; # cautious programming in case (undef,undef) is true
861 push(@m,"$key=>".neatvalue($val)) ;
863 return "{ ".join(', ',@m)." }";
870 push @m, "\n# Full list of MakeMaker attribute values:";
871 foreach $key (sort keys %$self){
872 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
873 my($v) = neatvalue($self->{$key});
874 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
876 push @m, "# $key => $v";
882 package ExtUtils::MakeMaker;
889 ExtUtils::MakeMaker - create an extension Makefile
893 C<use ExtUtils::MakeMaker;>
895 C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
899 C<MM-E<gt>new(\%att)-E<gt>flush;>
903 This utility is designed to write a Makefile for an extension module
904 from a Makefile.PL. It is based on the Makefile.SH model provided by
905 Andy Dougherty and the perl5-porters.
907 It splits the task of generating the Makefile into several subroutines
908 that can be individually overridden. Each subroutine returns the text
909 it wishes to have written to the Makefile.
911 MakeMaker is object oriented. Each directory below the current
912 directory that contains a Makefile.PL. Is treated as a separate
913 object. This makes it possible to write an unlimited number of
914 Makefiles with a single invocation of WriteMakefile().
916 =head2 How To Write A Makefile.PL
918 The short answer is: Don't.
920 Always begin with h2xs.
921 Always begin with h2xs!
922 ALWAYS BEGIN WITH H2XS!
924 even if you're not building around a header file, and even if you
925 don't have an XS component.
927 Run h2xs(1) before you start thinking about writing a module. For so
928 called pm-only modules that consist of C<*.pm> files only, h2xs has
929 the C<-X> switch. This will generate dummy files of all kinds that are
930 useful for the module developer.
932 The medium answer is:
934 use ExtUtils::MakeMaker;
935 WriteMakefile( NAME => "Foo::Bar" );
937 The long answer is the rest of the manpage :-)
939 =head2 Default Makefile Behaviour
941 The generated Makefile enables the user of the extension to invoke
943 perl Makefile.PL # optionally "perl Makefile.PL verbose"
945 make test # optionally set TEST_VERBOSE=1
946 make install # See below
948 The Makefile to be produced may be altered by adding arguments of the
949 form C<KEY=VALUE>. E.g.
951 perl Makefile.PL PREFIX=/tmp/myperl5
953 Other interesting targets in the generated Makefile are
955 make config # to check if the Makefile is up-to-date
956 make clean # delete local temp files (Makefile gets renamed)
957 make realclean # delete derived files (including ./blib)
958 make ci # check in all the files in the MANIFEST file
959 make dist # see below the Distribution Support section
963 MakeMaker checks for the existence of a file named F<test.pl> in the
964 current directory and if it exists it adds commands to the test target
965 of the generated Makefile that will execute the script with the proper
966 set of perl C<-I> options.
968 MakeMaker also checks for any files matching glob("t/*.t"). It will
969 add commands to the test target of the generated Makefile that execute
970 all matching files via the L<Test::Harness> module with the C<-I>
971 switches set correctly.
975 A useful variation of the above is the target C<testdb>. It runs the
976 test under the Perl debugger (see L<perldebug>). If the file
977 F<test.pl> exists in the current directory, it is used for the test.
979 If you want to debug some other testfile, set C<TEST_FILE> variable
982 make testdb TEST_FILE=t/mytest.t
984 By default the debugger is called using C<-d> option to perl. If you
985 want to specify some other option, set C<TESTDB_SW> variable:
987 make testdb TESTDB_SW=-Dx
991 make alone puts all relevant files into directories that are named by
992 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_HTMLLIBDIR,
993 INST_HTMLSCRIPTDIR, INST_MAN1DIR, and INST_MAN3DIR. All these default
994 to something below ./blib if you are I<not> building below the perl
995 source directory. If you I<are> building below the perl source,
996 INST_LIB and INST_ARCHLIB default to ../../lib, and INST_SCRIPT is not
999 The I<install> target of the generated Makefile copies the files found
1000 below each of the INST_* directories to their INSTALL*
1001 counterparts. Which counterparts are chosen depends on the setting of
1002 INSTALLDIRS according to the following table:
1007 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH
1008 INST_LIB INSTALLPRIVLIB INSTALLSITELIB
1009 INST_HTMLLIBDIR INSTALLHTMLPRIVLIBDIR INSTALLHTMLSITELIBDIR
1010 INST_HTMLSCRIPTDIR INSTALLHTMLSCRIPTDIR
1012 INST_SCRIPT INSTALLSCRIPT
1013 INST_MAN1DIR INSTALLMAN1DIR
1014 INST_MAN3DIR INSTALLMAN3DIR
1016 The INSTALL... macros in turn default to their %Config
1017 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
1019 You can check the values of these variables on your system with
1023 And to check the sequence in which the library directories are
1024 searched by perl, run
1026 perl -le 'print join $/, @INC'
1029 =head2 PREFIX and LIB attribute
1031 PREFIX and LIB can be used to set several INSTALL* attributes in one
1032 go. The quickest way to install a module in a non-standard place might
1035 perl Makefile.PL LIB=~/lib
1037 This will install the module's architecture-independent files into
1038 ~/lib, the architecture-dependent files into ~/lib/$archname.
1040 Another way to specify many INSTALL directories with a single
1041 parameter is PREFIX.
1043 perl Makefile.PL PREFIX=~
1045 This will replace the string specified by C<$Config{prefix}> in all
1046 C<$Config{install*}> values.
1048 Note, that in both cases the tilde expansion is done by MakeMaker, not
1049 by perl by default, nor by make.
1051 Conflicts between parameters LIB,
1052 PREFIX and the various INSTALL* arguments are resolved so that:
1058 setting LIB overrides any setting of INSTALLPRIVLIB, INSTALLARCHLIB,
1059 INSTALLSITELIB, INSTALLSITEARCH (and they are not affected by PREFIX);
1063 without LIB, setting PREFIX replaces the initial C<$Config{prefix}>
1064 part of those INSTALL* arguments, even if the latter are explicitly
1065 set (but are set to still start with C<$Config{prefix}>).
1069 If the user has superuser privileges, and is not working on AFS
1070 or relatives, then the defaults for
1071 INSTALLPRIVLIB, INSTALLARCHLIB, INSTALLSCRIPT, etc. will be appropriate,
1072 and this incantation will be the best:
1074 perl Makefile.PL; make; make test
1077 make install per default writes some documentation of what has been
1078 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1079 can be bypassed by calling make pure_install.
1083 will have to specify the installation directories as these most
1084 probably have changed since perl itself has been installed. They will
1085 have to do this by calling
1087 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1088 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1091 Be careful to repeat this procedure every time you recompile an
1092 extension, unless you are sure the AFS installation directories are
1095 =head2 Static Linking of a new Perl Binary
1097 An extension that is built with the above steps is ready to use on
1098 systems supporting dynamic loading. On systems that do not support
1099 dynamic loading, any newly created extension has to be linked together
1100 with the available resources. MakeMaker supports the linking process
1101 by creating appropriate targets in the Makefile whenever an extension
1102 is built. You can invoke the corresponding section of the makefile with
1106 That produces a new perl binary in the current directory with all
1107 extensions linked in that can be found in INST_ARCHLIB, SITELIBEXP,
1108 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1109 UNIX, this is called Makefile.aperl (may be system dependent). If you
1110 want to force the creation of a new perl, it is recommended, that you
1111 delete this Makefile.aperl, so the directories are searched-through
1112 for linkable libraries again.
1114 The binary can be installed into the directory where perl normally
1115 resides on your machine with
1119 To produce a perl binary with a different name than C<perl>, either say
1121 perl Makefile.PL MAP_TARGET=myperl
1128 make myperl MAP_TARGET=myperl
1129 make inst_perl MAP_TARGET=myperl
1131 In any case you will be prompted with the correct invocation of the
1132 C<inst_perl> target that installs the new binary into INSTALLBIN.
1134 make inst_perl per default writes some documentation of what has been
1135 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1136 can be bypassed by calling make pure_inst_perl.
1138 Warning: the inst_perl: target will most probably overwrite your
1139 existing perl binary. Use with care!
1141 Sometimes you might want to build a statically linked perl although
1142 your system supports dynamic loading. In this case you may explicitly
1143 set the linktype with the invocation of the Makefile.PL or make:
1145 perl Makefile.PL LINKTYPE=static # recommended
1149 make LINKTYPE=static # works on most systems
1151 =head2 Determination of Perl Library and Installation Locations
1153 MakeMaker needs to know, or to guess, where certain things are
1154 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1155 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1156 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1158 Extensions may be built either using the contents of the perl source
1159 directory tree or from the installed perl library. The recommended way
1160 is to build extensions after you have run 'make install' on perl
1161 itself. You can do that in any directory on your hard disk that is not
1162 below the perl source tree. The support for extensions below the ext
1163 directory of the perl distribution is only good for the standard
1164 extensions that come with perl.
1166 If an extension is being built below the C<ext/> directory of the perl
1167 source then MakeMaker will set PERL_SRC automatically (e.g.,
1168 C<../..>). If PERL_SRC is defined and the extension is recognized as
1169 a standard extension, then other variables default to the following:
1172 PERL_LIB = PERL_SRC/lib
1173 PERL_ARCHLIB = PERL_SRC/lib
1175 INST_ARCHLIB = PERL_ARCHLIB
1177 If an extension is being built away from the perl source then MakeMaker
1178 will leave PERL_SRC undefined and default to using the installed copy
1179 of the perl library. The other variables default to the following:
1181 PERL_INC = $archlibexp/CORE
1182 PERL_LIB = $privlibexp
1183 PERL_ARCHLIB = $archlibexp
1184 INST_LIB = ./blib/lib
1185 INST_ARCHLIB = ./blib/arch
1187 If perl has not yet been installed then PERL_SRC can be defined on the
1188 command line as shown in the previous section.
1191 =head2 Which architecture dependent directory?
1193 If you don't want to keep the defaults for the INSTALL* macros,
1194 MakeMaker helps you to minimize the typing needed: the usual
1195 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1196 by Configure at perl compilation time. MakeMaker supports the user who
1197 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1198 then MakeMaker defaults the latter to be the same subdirectory of
1199 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1200 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1201 for INSTALLSITELIB and INSTALLSITEARCH.
1203 MakeMaker gives you much more freedom than needed to configure
1204 internal variables and get different results. It is worth to mention,
1205 that make(1) also lets you configure most of the variables that are
1206 used in the Makefile. But in the majority of situations this will not
1207 be necessary, and should only be done if the author of a package
1208 recommends it (or you know what you're doing).
1210 =head2 Using Attributes and Parameters
1212 The following attributes can be specified as arguments to WriteMakefile()
1213 or as NAME=VALUE pairs on the command line:
1219 One line description of the module. Will be included in PPD file.
1223 Name of the file that contains the package description. MakeMaker looks
1224 for a line in the POD matching /^($package\s-\s)(.*)/. This is typically
1225 the first line in the "=head1 NAME" section. $2 becomes the abstract.
1229 String containing name (and email address) of package author(s). Is used
1230 in PPD (Perl Package Description) files for PPM (Perl Package Manager).
1232 =item BINARY_LOCATION
1234 Used when creating PPD files for binary packages. It can be set to a
1235 full or relative path or URL to the binary archive for a particular
1236 architecture. For example:
1238 perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
1240 builds a PPD package that references a binary of the C<Agent> package,
1241 located in the C<x86> directory relative to the PPD itself.
1245 Ref to array of *.c file names. Initialised from a directory scan
1246 and the values portion of the XS attribute hash. This is not
1247 currently used by MakeMaker but may be handy in Makefile.PLs.
1251 String that will be included in the compiler call command line between
1252 the arguments INC and OPTIMIZE.
1256 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1257 config.sh. MakeMaker will add to CONFIG the following values anyway:
1277 CODE reference. The subroutine should return a hash reference. The
1278 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1279 be determined by some evaluation method.
1283 Something like C<"-DHAVE_UNISTD_H">
1287 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1292 Your name for distributing the package (by tar file). This defaults to
1297 Hashref of symbol names for routines to be made available as universal
1298 symbols. Each key/value pair consists of the package name and an
1299 array of routine names in that package. Used only under AIX, OS/2,
1300 VMS and Win32 at present. The routine names supplied will be expanded
1301 in the same way as XSUB names are expanded by the XS() macro.
1304 {"$(NAME)" => ["boot_$(NAME)" ] }
1308 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1309 "NetconfigPtr" => [ 'DESTROY'] }
1311 Please see the L<ExtUtils::Mksymlists> documentation for more information
1312 about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
1316 Array of symbol names for variables to be made available as universal symbols.
1317 Used only under AIX, OS/2, VMS and Win32 at present. Defaults to [].
1318 (e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
1322 Array of extension names to exclude when doing a static build. This
1323 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1324 details. (e.g. [ qw( Socket POSIX ) ] )
1326 This attribute may be most useful when specified as a string on the
1327 command line: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1331 Ref to array of executable files. The files will be copied to the
1332 INST_SCRIPT directory. Make realclean will delete them from there
1335 =item FIRST_MAKEFILE
1337 The name of the Makefile to be produced. Defaults to the contents of
1338 MAKEFILE, but can be overridden. This is used for the second Makefile
1339 that will be produced for the MAP_TARGET.
1343 Perl binary able to run this extension.
1347 This provides an alternate means to specify function names to be
1348 exported from the extension. Its value is a reference to an
1349 array of function names to be exported by the extension. These
1350 names are passed through unaltered to the linker options file.
1354 Ref to array of *.h file names. Similar to C.
1358 Hashref of .pm and .pod files. MakeMaker will default this to all
1359 .pod and any .pm files that include POD directives. The files listed
1360 here will be converted to HTML format and installed as was requested
1363 =item HTMLSCRIPTPODS
1365 Hashref of pod-containing files. MakeMaker will default this to all
1366 EXE_FILES files that include POD directives. The files listed
1367 here will be converted to HTML format and installed as was requested
1372 This attribute is used to specify names to be imported into the
1373 extension. It is only used on OS/2 and Win32.
1377 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1381 Array of extension names to be included when doing a static build.
1382 MakeMaker will normally build with all of the installed extensions when
1383 doing a static build, and that is usually the desired behavior. If
1384 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1385 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1387 It is not necessary to mention DynaLoader or the current extension when
1388 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1389 only DynaLoader and the current extension will be included in the build.
1391 This attribute may be most useful when specified as a string on the
1392 command line: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1394 =item INSTALLARCHLIB
1396 Used by 'make install', which copies files from INST_ARCHLIB to this
1397 directory if INSTALLDIRS is set to perl.
1401 Directory to install binary files (e.g. tkperl) into.
1405 Determines which of the two sets of installation directories to
1406 choose: installprivlib and installarchlib versus installsitelib and
1407 installsitearch. The first pair is chosen with INSTALLDIRS=perl, the
1408 second with INSTALLDIRS=site. Default is site.
1410 =item INSTALLHTMLPRIVLIBDIR
1412 This directory gets the HTML pages at 'make install' time. Defaults to
1413 $Config{installhtmlprivlibdir}.
1415 =item INSTALLHTMLSCRIPTDIR
1417 This directory gets the HTML pages at 'make install' time. Defaults to
1418 $Config{installhtmlscriptdir}.
1420 =item INSTALLHTMLSITELIBDIR
1422 This directory gets the HTML pages at 'make install' time. Defaults to
1423 $Config{installhtmlsitelibdir}.
1426 =item INSTALLMAN1DIR
1428 This directory gets the man pages at 'make install' time. Defaults to
1429 $Config{installman1dir}.
1431 =item INSTALLMAN3DIR
1433 This directory gets the man pages at 'make install' time. Defaults to
1434 $Config{installman3dir}.
1436 =item INSTALLPRIVLIB
1438 Used by 'make install', which copies files from INST_LIB to this
1439 directory if INSTALLDIRS is set to perl.
1443 Used by 'make install' which copies files from INST_SCRIPT to this
1446 =item INSTALLSITEARCH
1448 Used by 'make install', which copies files from INST_ARCHLIB to this
1449 directory if INSTALLDIRS is set to site (default).
1451 =item INSTALLSITELIB
1453 Used by 'make install', which copies files from INST_LIB to this
1454 directory if INSTALLDIRS is set to site (default).
1458 Same as INST_LIB for architecture dependent files.
1462 Directory to put real binary files during 'make'. These will be copied
1463 to INSTALLBIN during 'make install'
1467 Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you
1470 =item INST_HTMLLIBDIR
1472 Directory to hold the man pages in HTML format at 'make' time
1474 =item INST_HTMLSCRIPTDIR
1476 Directory to hold the man pages in HTML format at 'make' time
1480 Directory where we put library files of this extension while building
1485 Directory to hold the man pages at 'make' time
1489 Directory to hold the man pages at 'make' time
1493 Directory, where executable files should be installed during
1494 'make'. Defaults to "./blib/script", just to have a dummy location during
1495 testing. make install will copy the files in INST_SCRIPT to
1500 defaults to "$(OBJECT)" and is used in the ld command to specify
1501 what files to link/load from (also see dynamic_lib below for how to
1506 LIB should only be set at C<perl Makefile.PL> time but is allowed as a
1507 MakeMaker argument. It has the effect of
1508 setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any
1509 explicit setting of those arguments (or of PREFIX).
1510 INSTALLARCHLIB and INSTALLSITEARCH are set to the corresponding
1511 architecture subdirectory.
1515 The filename of the perllibrary that will be used together with this
1516 extension. Defaults to libperl.a.
1520 An anonymous array of alternative library
1521 specifications to be searched for (in order) until
1522 at least one library is found. E.g.
1524 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1526 Mind, that any element of the array
1527 contains a complete set of arguments for the ld
1528 command. So do not specify
1530 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1532 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1533 you specify a scalar as in
1535 'LIBS' => "-ltcl -ltk -lX11"
1537 MakeMaker will turn it into an array with one element.
1541 'static' or 'dynamic' (default unless usedl=undef in
1542 config.sh). Should only be used to force static linking (also see
1547 Boolean which tells MakeMaker, that it should include the rules to
1548 make a perl. This is handled automatically as a switch by
1549 MakeMaker. The user normally does not need it.
1553 The name of the Makefile to be produced.
1557 Hashref of pod-containing files. MakeMaker will default this to all
1558 EXE_FILES files that include POD directives. The files listed
1559 here will be converted to man pages and installed as was requested
1564 Hashref that assigns to *.pm and *.pod files the files into which the
1565 manpages are to be written. MakeMaker parses all *.pod and *.pm files
1566 for POD directives. Files that contain POD will be the default keys of
1567 the MAN3PODS hashref. These will then be converted to man pages during
1568 C<make> and will be installed during C<make install>.
1572 If it is intended, that a new perl binary be produced, this variable
1573 may hold a name for that binary. Defaults to perl
1577 If the extension links to a library that it builds set this to the
1578 name of the library (see SDBM_File)
1582 Perl module name for this extension (DBD::Oracle). This will default
1583 to the directory name but should be explicitly defined in the
1588 MakeMaker will figure out if an extension contains linkable code
1589 anywhere down the directory tree, and will set this variable
1590 accordingly, but you can speed it up a very little bit if you define
1591 this boolean variable yourself.
1595 Defaults to C<@>. By setting it to an empty string you can generate a
1596 Makefile that echos all commands. Mainly used in debugging MakeMaker
1601 Boolean. Attribute to inhibit descending into subdirectories.
1605 In general, any generated Makefile checks for the current version of
1606 MakeMaker and the version the Makefile was built under. If NO_VC is
1607 set, the version check is neglected. Do not write this into your
1608 Makefile.PL, use it interactively instead.
1612 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1613 string containing all object files, e.g. "tkpBind.o
1614 tkpButton.o tkpCanvas.o"
1616 (Where BASEEXT is the last component of NAME, and OBJ_EXT is $Config{obj_ext}.)
1620 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1621 passed to subdirectory makes.
1625 Perl binary for tasks that can be done by miniperl
1629 Set only when MakeMaker is building the extensions of the Perl core
1634 The call to the program that is able to compile perlmain.c. Defaults
1639 Same as for PERL_LIB, but for architecture dependent files.
1641 Used only when MakeMaker is building the extensions of the Perl core
1642 distribution (because normally $(PERL_ARCHLIB) is automatically in @INC,
1643 and adding it would get in the way of PERL5LIB).
1647 Directory containing the Perl library to use.
1649 Used only when MakeMaker is building the extensions of the Perl core
1650 distribution (because normally $(PERL_LIB) is automatically in @INC,
1651 and adding it would get in the way of PERL5LIB).
1653 =item PERL_MALLOC_OK
1655 defaults to 0. Should be set to TRUE if the extension can work with
1656 the memory allocation routines substituted by the Perl malloc() subsystem.
1657 This should be applicable to most extensions with exceptions of those
1663 with bugs in memory allocations which are caught by Perl's malloc();
1667 which interact with the memory allocator in other ways than via
1668 malloc(), realloc(), free(), calloc(), sbrk() and brk();
1672 which rely on special alignment which is not provided by Perl's malloc().
1676 B<NOTE.> Negligence to set this flag in I<any one> of loaded extension
1677 nullifies many advantages of Perl's malloc(), such as better usage of
1678 system resources, error detection, memory usage reporting, catchable failure
1679 of memory allocations, etc.
1683 Use this instead of $(PERL) or $(FULLPERL) when you wish to run perl.
1684 It will set up extra necessary flags for you.
1688 Use this instead of $(PERL) or $(FULLPERL) when you wish to run
1689 perl to work with modules. It will add things like -I$(INST_ARCH)
1690 and other necessary flags.
1694 Directory containing the Perl source code (use of this should be
1695 avoided, it may be undefined)
1699 Desired permission for read/writable files. Defaults to C<644>.
1700 See also L<MM_Unix/perm_rw>.
1704 Desired permission for executable files. Defaults to C<755>.
1705 See also L<MM_Unix/perm_rwx>.
1709 Ref to hash of files to be processed as perl programs. MakeMaker
1710 will default to any found *.PL file (except Makefile.PL) being keys
1711 and the basename of the file being the value. E.g.
1713 {'foobar.PL' => 'foobar'}
1715 The *.PL files are expected to produce output to the target files
1716 themselves. If multiple files can be generated from the same *.PL
1717 file then the value in the hash can be a reference to an array of
1718 target file names. E.g.
1720 {'foobar.PL' => ['foobar1','foobar2']}
1724 Hashref of .pm files and *.pl files to be installed. e.g.
1726 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1728 By default this will include *.pm and *.pl and the files found in
1729 the PMLIBDIRS directories. Defining PM in the
1730 Makefile.PL will override PMLIBDIRS.
1734 Ref to array of subdirectories containing library files. Defaults to
1735 [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
1736 they contain will be installed in the corresponding location in the
1737 library. A libscan() method can be used to alter the behaviour.
1738 Defining PM in the Makefile.PL will override PMLIBDIRS.
1740 (Where BASEEXT is the last component of NAME.)
1744 A filter program, in the traditional Unix sense (input from stdin, output
1745 to stdout) that is passed on each .pm file during the build (in the
1746 pm_to_blib() phase). It is empty by default, meaning no filtering is done.
1748 Great care is necessary when defining the command if quoting needs to be
1749 done. For instance, you would need to say:
1751 {'PM_FILTER' => 'grep -v \\"^\\#\\"'}
1753 to remove all the leading coments on the fly during the build. The
1754 extra \\ are necessary, unfortunately, because this variable is interpolated
1755 within the context of a Perl program built on the command line, and double
1756 quotes are what is used with the -e switch to build that command line. The
1757 # is escaped for the Makefile, since what is going to be generated will then
1760 PM_FILTER = grep -v \"^\#\"
1762 Without the \\ before the #, we'd have the start of a Makefile comment,
1763 and the macro would be incorrectly defined.
1767 Release 5.005 grandfathered old global symbol names by providing preprocessor
1768 macros for extension source compatibility. As of release 5.6, these
1769 preprocessor definitions are not available by default. The POLLUTE flag
1770 specifies that the old names should still be defined:
1772 perl Makefile.PL POLLUTE=1
1774 Please inform the module author if this is necessary to successfully install
1775 a module under 5.6 or later.
1777 =item PPM_INSTALL_EXEC
1779 Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl)
1781 =item PPM_INSTALL_SCRIPT
1783 Name of the script that gets executed by the Perl Package Manager after
1784 the installation of a package.
1788 Can be used to set the three INSTALL* attributes in one go (except for
1789 probably INSTALLMAN1DIR, if it is not below PREFIX according to
1790 %Config). They will have PREFIX as a common directory node and will
1791 branch from that node into lib/, lib/ARCHNAME or whatever Configure
1792 decided at the build time of your perl (unless you override one of
1797 Hashref: Names of modules that need to be available to run this
1798 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1799 desired version is the value. If the required version number is 0, we
1800 only check if any version is installed already.
1804 Bool. If this parameter is true, failing to have the required modules
1805 (or the right versions thereof) will be fatal. perl Makefile.PL will die
1806 with the proper message.
1808 Note: see L<Test::Harness> for a shortcut for stopping tests early if
1809 you are missing dependencies.
1811 Do I<not> use this parameter for simple requirements, which could be resolved
1812 at a later time, e.g. after an unsuccessful B<make test> of your module.
1814 It is I<extremely> rare to have to use C<PREREQ_FATAL> at all!
1818 Bool. If this parameter is true, the prerequisites will be printed to
1819 stdout and MakeMaker will exit. The output format is
1829 RedHatism for C<PREREQ_PRINT>. The output format is different, though:
1831 perl(A::B)>=Vers1 perl(C::D)>=Vers2 ...
1835 Arrayref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1836 Makefile. Caution! Do not use the SKIP attribute for the negligible
1837 speedup. It may seriously damage the resulting Makefile. Only use it
1838 if you really need it.
1842 The set of -I's necessary to run a "make test". Use as:
1843 $(PERL) $(TEST_LIBS) -e '...' for example.
1847 Ref to array of typemap file names. Use this when the typemaps are
1848 in some directory other than the current directory or when they are
1849 not named B<typemap>. The last typemap in the list takes
1850 precedence. A typemap in the current directory has highest
1851 precedence, even if it isn't listed in TYPEMAPS. The default system
1852 typemap has lowest precedence.
1856 Your version number for distributing the package. This defaults to
1861 Instead of specifying the VERSION in the Makefile.PL you can let
1862 MakeMaker parse a file to determine the version number. The parsing
1863 routine requires that the file named by VERSION_FROM contains one
1864 single line to compute the version number. The first line in the file
1865 that contains the regular expression
1867 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
1869 will be evaluated with eval() and the value of the named variable
1870 B<after> the eval() will be assigned to the VERSION attribute of the
1871 MakeMaker object. The following lines will be parsed o.k.:
1875 ( $VERSION ) = '$Revision: 1.222 $ ' =~ /\$Revision:\s+([^\s]+)/;
1876 $FOO::VERSION = '1.10';
1877 *FOO::VERSION = \'1.11';
1878 our $VERSION = 1.2.3; # new for perl5.6.0
1880 but these will fail:
1882 my $VERSION = '1.01';
1883 local $VERSION = '1.02';
1884 local $FOO::VERSION = '1.30';
1886 (Putting C<my> or C<local> on the preceding line will work o.k.)
1888 The file named in VERSION_FROM is not added as a dependency to
1889 Makefile. This is not really correct, but it would be a major pain
1890 during development to have to rewrite the Makefile for any smallish
1891 change in that file. If you want to make sure that the Makefile
1892 contains the correct VERSION macro after any change of the file, you
1893 would have to do something like
1895 depend => { Makefile => '$(VERSION_FROM)' }
1897 See attribute C<depend> below.
1901 Hashref of .xs files. MakeMaker will default this. e.g.
1903 {'name_of_file.xs' => 'name_of_file.c'}
1905 The .c files will automatically be included in the list of files
1906 deleted by a make clean.
1910 String of options to pass to xsubpp. This might include C<-C++> or
1911 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
1916 May be set to an empty string, which is identical to C<-prototypes>, or
1917 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
1918 defaults to the empty string.
1922 Your version number for the .xs file of this package. This defaults
1923 to the value of the VERSION attribute.
1927 =head2 Additional lowercase attributes
1929 can be used to pass parameters to the methods which implement that
1930 part of the Makefile.
1936 {FILES => "*.xyz foo"}
1940 {ANY_TARGET => ANY_DEPENDECY, ...}
1942 (ANY_TARGET must not be given a double-colon rule by MakeMaker.)
1946 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
1947 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
1948 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
1950 If you specify COMPRESS, then SUFFIX should also be altered, as it is
1951 needed to tell make the target file of the compression. Setting
1952 DIST_CP to ln can be useful, if you need to preserve the timestamps on
1953 your files. DIST_CP can take the values 'cp', which copies the file,
1954 'ln', which links the file, and 'best' which copies symbolic links and
1955 links the rest. Default is 'best'.
1959 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
1963 {LINKTYPE => 'static', 'dynamic' or ''}
1965 NB: Extensions that have nothing but *.pm files had to say
1969 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1970 can be deleted safely. MakeMaker recognizes when there's nothing to
1975 {ANY_MACRO => ANY_VALUE, ...}
1979 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
1985 =item tool_autosplit
1991 =head2 Overriding MakeMaker Methods
1993 If you cannot achieve the desired Makefile behaviour by specifying
1994 attributes you may define private subroutines in the Makefile.PL.
1995 Each subroutines returns the text it wishes to have written to
1996 the Makefile. To override a section of the Makefile you can
1999 sub MY::c_o { "new literal text" }
2001 or you can edit the default by saying something like:
2004 package MY; # so that "SUPER" works right
2005 my $inherited = shift->SUPER::c_o(@_);
2006 $inherited =~ s/old text/new text/;
2010 If you are running experiments with embedding perl as a library into
2011 other applications, you might find MakeMaker is not sufficient. You'd
2012 better have a look at ExtUtils::Embed which is a collection of utilities
2015 If you still need a different solution, try to develop another
2016 subroutine that fits your needs and submit the diffs to
2017 F<perl5-porters@perl.org> or F<comp.lang.perl.moderated> as appropriate.
2019 For a complete description of all MakeMaker methods see L<ExtUtils::MM_Unix>.
2021 Here is a simple example of how to add a new target to the generated
2026 $(MYEXTLIB): sdbm/Makefile
2027 cd sdbm && $(MAKE) all
2032 =head2 Hintsfile support
2034 MakeMaker.pm uses the architecture specific information from
2035 Config.pm. In addition it evaluates architecture specific hints files
2036 in a C<hints/> directory. The hints files are expected to be named
2037 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
2038 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
2039 MakeMaker within the WriteMakefile() subroutine, and can be used to
2040 execute commands as well as to include special variables. The rules
2041 which hintsfile is chosen are the same as in Configure.
2043 The hintsfile is eval()ed immediately after the arguments given to
2044 WriteMakefile are stuffed into a hash reference $self but before this
2045 reference becomes blessed. So if you want to do the equivalent to
2046 override or create an attribute you would say something like
2048 $self->{LIBS} = ['-ldbm -lucb -lc'];
2050 =head2 Distribution Support
2052 For authors of extensions MakeMaker provides several Makefile
2053 targets. Most of the support comes from the ExtUtils::Manifest module,
2054 where additional documentation can be found.
2058 =item make distcheck
2060 reports which files are below the build directory but not in the
2061 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
2064 =item make skipcheck
2066 reports which files are skipped due to the entries in the
2067 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
2070 =item make distclean
2072 does a realclean first and then the distcheck. Note that this is not
2073 needed to build a new distribution as long as you are sure that the
2074 MANIFEST file is ok.
2078 rewrites the MANIFEST file, adding all remaining files found (See
2079 ExtUtils::Manifest::mkmanifest() for details)
2083 Copies all the files that are in the MANIFEST file to a newly created
2084 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
2085 exists, it will be removed first.
2089 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
2090 a make test in that directory.
2094 First does a distdir. Then a command $(PREOP) which defaults to a null
2095 command, followed by $(TOUNIX), which defaults to a null command under
2096 UNIX, and will convert files in distribution directory to UNIX format
2097 otherwise. Next it runs C<tar> on that directory into a tarfile and
2098 deletes the directory. Finishes with a command $(POSTOP) which
2099 defaults to a null command.
2103 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
2105 =item make uutardist
2107 Runs a tardist first and uuencodes the tarfile.
2111 First does a distdir. Then a command $(PREOP) which defaults to a null
2112 command. Next it runs C<shar> on that directory into a sharfile and
2113 deletes the intermediate directory again. Finishes with a command
2114 $(POSTOP) which defaults to a null command. Note: For shdist to work
2115 properly a C<shar> program that can handle directories is mandatory.
2119 First does a distdir. Then a command $(PREOP) which defaults to a null
2120 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
2121 zipfile. Then deletes that directory. Finishes with a command
2122 $(POSTOP) which defaults to a null command.
2126 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
2130 Customization of the dist targets can be done by specifying a hash
2131 reference to the dist attribute of the WriteMakefile call. The
2132 following parameters are recognized:
2135 COMPRESS ('gzip --best')
2138 TO_UNIX (depends on the system)
2139 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
2149 WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" })
2151 =head2 Disabling an extension
2153 If some events detected in F<Makefile.PL> imply that there is no way
2154 to create the Module, but this is a normal state of things, then you
2155 can create a F<Makefile> which does nothing, but succeeds on all the
2156 "usual" build targets. To do so, use
2158 ExtUtils::MakeMaker::WriteEmptyMakefile();
2160 instead of WriteMakefile().
2162 This may be useful if other modules expect this module to be I<built>
2163 OK, as opposed to I<work> OK (say, this system-dependent module builds
2164 in a subdirectory of some other distribution, or is listed as a
2165 dependency in a CPAN::Bundle, but the functionality is supported by
2166 different means on the current architecture).
2174 Command line options used by C<MakeMaker-E<gt>new()>, and thus by
2175 C<WriteMakefile()>. The string is split on whitespace, and the result
2176 is processed before any actual command line arguments are processed.
2178 =item PERL_MM_USE_DEFAULT
2180 If set to a true value then MakeMaker's prompt function will
2181 always return the default without waiting for user input.
2187 ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib,
2188 ExtUtils::Install, ExtUtils::Embed
2192 Andy Dougherty <F<doughera@lafcol.lafayette.edu>>, Andreas KE<ouml>nig
2193 <F<andreas.koenig@mind.de>>, Tim Bunce <F<Tim.Bunce@ig.co.uk>>. VMS
2194 support by Charles Bailey <F<bailey@newman.upenn.edu>>. OS/2 support
2195 by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>.
2197 Contact the MakeMaker mailing list <F<makemaker@perl.org>> if you have
2200 Send patches and bug reports to <F<perlbug@perl.org>>.