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 = $^O 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;
92 require ExtUtils::MM_Win32;
95 require ExtUtils::MM_Cygwin;
100 # The use of the Version_check target has been dropped between perl
101 # 5.5.63 and 5.5.64. We must keep the subroutine for a while so that
102 # old Makefiles can satisfy the Version_check target.
105 my($checkversion) = @_;
106 die "Your Makefile was built with ExtUtils::MakeMaker v $checkversion.
107 Current Version is $ExtUtils::MakeMaker::VERSION. There have been considerable
108 changes in the meantime.
109 Please rerun 'perl Makefile.PL' to regenerate the Makefile.\n"
110 if $checkversion < $Version_OK;
111 printf STDOUT "%s %s %s %s.\n", "Makefile built with ExtUtils::MakeMaker v",
112 $checkversion, "Current Version is", $VERSION
113 unless $checkversion == $VERSION;
117 $_[0] =~ /^Use of uninitialized value/ && return;
118 $_[0] =~ /used only once/ && return;
119 $_[0] =~ /^Subroutine\s+[\w:]+\s+redefined/ && return;
124 Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
125 local $SIG{__WARN__} = \&warnhandler;
128 MM->new(\%att)->flush;
133 $ISA_TTY = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ; # Pipe?
134 Carp::confess("prompt function called without an argument") unless defined $mess;
135 my $dispdef = defined $def ? "[$def] " : " ";
136 $def = defined $def ? $def : "";
139 print "$mess $dispdef";
140 if ($ISA_TTY && !$ENV{PERL_MM_USE_DEFAULT}) {
141 chomp($ans = <STDIN>);
145 return ($ans ne '') ? $ans : $def;
148 sub eval_in_subdirs {
151 use Cwd qw(cwd abs_path);
153 local @INC = map eval {abs_path($_) if -e} || $_, @INC;
155 foreach $dir (@{$self->{DIR}}){
156 my($abs) = $self->catdir($pwd,$dir);
157 $self->eval_in_x($abs);
165 chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
167 # my $fh = new FileHandle;
168 # $fh->open("Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
170 open(FH,"Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
171 # my $eval = join "", <$fh>;
172 my $eval = join "", <FH>;
177 # if ($@ =~ /prerequisites/) {
178 # die "MakeMaker WARNING: $@";
180 # warn "WARNING from evaluation of $dir/Makefile.PL: $@";
182 warn "WARNING from evaluation of $dir/Makefile.PL: $@";
189 # package name for the classes into which the first object will be blessed
190 $PACKNAME = "PACK000";
194 AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION
195 C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
196 EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE FULLPERL FUNCLIST H
197 HTMLLIBPODS HTMLSCRIPTPODS IMPORTS
198 INC INCLUDE_EXT INSTALLARCHLIB INSTALLBIN INSTALLDIRS INSTALLHTMLPRIVLIBDIR
199 INSTALLHTMLSCRIPTDIR INSTALLHTMLSITELIBDIR INSTALLMAN1DIR
200 INSTALLMAN3DIR INSTALLPRIVLIB INSTALLSCRIPT INSTALLSITEARCH
201 INSTALLSITELIB INST_ARCHLIB INST_BIN INST_EXE INST_LIB
202 INST_HTMLLIBDIR INST_HTMLSCRIPTDIR
203 INST_MAN1DIR INST_MAN3DIR INST_SCRIPT LDFROM LIB LIBPERL_A LIBS
204 LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB
206 NAME NEEDS_LINKING NOECHO NORECURS NO_VC OBJECT OPTIMIZE PERL PERLMAINCC
207 PERLRUN PERLRUNINST PERL_ARCHLIB PERL_CORE
208 PERL_LIB PERL_SRC PERM_RW PERM_RWX
209 PL_FILES PM PM_FILTER PMLIBDIRS POLLUTE PPM_INSTALL_EXEC
210 PPM_INSTALL_SCRIPT PREFIX
211 PREREQ_FATAL PREREQ_PM PREREQ_PRINT PRINT_PREREQ
212 SKIP TEST_LIBS TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
213 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
215 MACPERL_SRC MACPERL_LIB MACLIBS_68K MACLIBS_PPC MACLIBS_SC MACLIBS_MRC
216 MACLIBS_ALL_68K MACLIBS_ALL_PPC MACLIBS_SHARED
219 # IMPORTS is used under OS/2 and Win32
221 # @Overridable is close to @MM_Sections but not identical. The
222 # order is important. Many subroutines declare macros. These
223 # depend on each other. Let's try to collect the macros up front,
224 # then pasthru, then the rules.
226 # MM_Sections are the sections we have to call explicitly
227 # in Overridable we have subroutines that are used indirectly
233 post_initialize const_config constants tool_autosplit tool_xsubpp
234 tools_other dist macro depend cflags const_loadlibs const_cccmd
239 c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs
240 dynamic_lib static static_lib htmlifypods manifypods processPL
242 clean realclean dist_basics dist_core dist_dir dist_test dist_ci
243 install force perldepend makefile staticmake test ppd
245 ); # loses section ordering
247 @Overridable = @MM_Sections;
248 push @Overridable, qw[
250 dir_target libscan makeaperl needs_linking perm_rw perm_rwx
251 subdir_x test_via_harness test_via_script
254 push @MM_Sections, qw[
256 pm_to_blib selfdocument
260 # Postamble needs to be the last that was always the case
261 push @MM_Sections, "postamble";
262 push @Overridable, "postamble";
264 # All sections are valid keys.
265 @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
267 # we will use all these variables in the Makefile
270 ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc
271 lib_ext obj_ext osname osvers ranlib sitelibexp sitearchexp so
276 foreach $item (@Attrib_help){
277 $Recognized_Att_Keys{$item} = 1;
279 foreach $item (@Get_from_Config) {
280 $Recognized_Att_Keys{uc $item} = $Config{$item};
281 print "Attribute '\U$item\E' => '$Config{$item}'\n"
286 # When we eval a Makefile.PL in a subdirectory, that one will ask
287 # us (the parent) for the values and will prepend "..", so that
288 # all files to be installed end up below OUR ./blib
293 INST_BIN 1 INST_EXE 1 INST_LIB 1 INST_ARCHLIB 1 INST_SCRIPT 1
294 MAP_TARGET 1 INST_HTMLLIBDIR 1 INST_HTMLSCRIPTDIR 1
295 INST_MAN1DIR 1 INST_MAN3DIR 1 PERL_SRC 1 PERL 1 FULLPERL 1
300 NEEDS_LINKING HAS_LINK_CODE
302 @Keep_after_flush{@keep} = (1) x @keep;
308 The extension you are trying to build apparently is rather old and
309 most probably outdated. We detect that from the fact, that a
310 subroutine "writeMakefile" is called, and this subroutine is not
311 supported anymore since about October 1994.
313 Please contact the author or look into CPAN (details about CPAN can be
314 found in the FAQ and at http:/www.perl.com) for a more recent version
315 of the extension. If you're really desperate, you can try to change
316 the subroutine name from writeMakefile to WriteMakefile and rerun
317 'perl Makefile.PL', but you're most probably left alone, when you do
325 sub ExtUtils::MakeMaker::new {
326 my($class,$self) = @_;
329 if ("@ARGV" =~ /\bPREREQ_PRINT\b/) {
330 require Data::Dumper;
331 print Data::Dumper->Dump([$self->{PREREQ_PM}], [qw(PREREQ_PM)]);
334 # PRINT_PREREQ is RedHatism.
335 if ("@ARGV" =~ /\bPRINT_PREREQ\b/) {
336 print join(" ", map { "perl($_)>=$self->{PREREQ_PM}->{$_} " } sort keys %{$self->{PREREQ_PM}}), "\n";
340 print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
341 if (-f "MANIFEST" && ! -f "Makefile"){
345 $self = {} unless (defined $self);
349 my %configure_att; # record &{$self->{CONFIGURE}} attributes
350 my(%initial_att) = %$self; # record initial attributes
352 my(%unsatisfied) = ();
354 foreach $prereq (sort keys %{$self->{PREREQ_PM}}) {
355 my $eval = "require $prereq";
359 warn "Warning: prerequisite $prereq $self->{PREREQ_PM}->{$prereq} not found.\n" unless $self->{PREREQ_FATAL};
360 $unsatisfied{$prereq} = 'not installed';
361 } elsif ($prereq->VERSION < $self->{PREREQ_PM}->{$prereq} ){
362 warn "Warning: prerequisite $prereq $self->{PREREQ_PM}->{$prereq} not found. We have"
363 . ($prereq->VERSION || 'unknown version') unless $self->{PREREQ_FATAL};
364 $unsatisfied{$prereq} = $self->{PREREQ_PM}->{$prereq} ? $self->{PREREQ_PM}->{$prereq} : 'unknown version' ;
367 if (%unsatisfied && $self->{PREREQ_FATAL}){
368 # unless (defined $ExtUtils::MakeMaker::useCPAN) {
369 my $failedprereqs = join ', ', map {"$_ $unsatisfied{$_}"} keys %unsatisfied;
370 die qq{MakeMaker FATAL: prerequisites not found ($failedprereqs)
371 Please install these modules first and rerun 'perl Makefile.PL'.\n};
372 # if ($ExtUtils::MakeMaker::hasCPAN) {
373 # $ExtUtils::MakeMaker::useCPAN = prompt(qq{Should I try to use the CPAN module to fetch them for you?},"yes");
375 # print qq{Hint: You may want to install the CPAN module to autofetch the needed modules\n};
376 # $ExtUtils::MakeMaker::useCPAN=0;
379 # if ($ExtUtils::MakeMaker::useCPAN) {
381 # CPAN->import(@unsatisfied);
383 # die qq{prerequisites not found (@unsatisfied)};
385 # warn qq{WARNING: prerequisites not found (@unsatisfied)};
388 if (defined $self->{CONFIGURE}) {
389 if (ref $self->{CONFIGURE} eq 'CODE') {
390 %configure_att = %{&{$self->{CONFIGURE}}};
391 $self = { %$self, %configure_att };
393 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
397 # This is for old Makefiles written pre 5.00, will go away
398 if ( Carp::longmess("") =~ /runsubdirpl/s ){
399 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
402 my $newclass = ++$PACKNAME;
403 local @Parent = @Parent; # Protect against non-local exits
406 print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
407 mv_all_methods("MY",$newclass);
408 bless $self, $newclass;
410 @{"$newclass\:\:ISA"} = 'MM';
413 if (defined $Parent[-2]){
414 $self->{PARENT} = $Parent[-2];
416 for $key (keys %Prepend_dot_dot) {
417 next unless defined $self->{PARENT}{$key};
418 $self->{$key} = $self->{PARENT}{$key};
419 # PERL and FULLPERL may be command verbs instead of full
420 # file specifications under VMS. If so, don't turn them
422 $self->{$key} = $self->catdir("..",$self->{$key})
423 unless $self->file_name_is_absolute($self->{$key})
424 || ($^O eq 'VMS' and ($key =~ /PERL$/ && $self->{$key} =~ /^[\w\-\$]+$/));
426 if ($self->{PARENT}) {
427 $self->{PARENT}->{CHILDREN}->{$newclass} = $self;
428 foreach my $opt (qw(POLLUTE PERL_CORE)) {
429 if (exists $self->{PARENT}->{$opt}
430 and not exists $self->{$opt})
432 # inherit, but only if already unspecified
433 $self->{$opt} = $self->{PARENT}->{$opt};
437 my @fm = grep /^FIRST_MAKEFILE=/, @ARGV;
438 parse_args($self,@fm) if @fm;
440 parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV);
443 $self->{NAME} ||= $self->guess_name;
445 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
449 if (! $self->{PERL_SRC} ) {
450 my($pthinks) = $self->canonpath($INC{'Config.pm'});
451 my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
452 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
453 if ($pthinks ne $cthinks &&
454 !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
455 print "Have $pthinks expected $cthinks\n";
457 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
460 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
462 print STDOUT <<END unless $self->{UNINSTALLED_PERL};
463 Your perl and your Config.pm seem to have different ideas about the architecture
465 Perl thinks: [$pthinks]
466 Config says: [$Config{archname}]
467 This may or may not cause problems. Please check your installation of perl if you
468 have problems building this extension.
473 $self->init_dirscan();
474 $self->init_others();
475 my($argv) = neatvalue(\@ARGV);
479 push @{$self->{RESULT}}, <<END;
480 # This Makefile is for the $self->{NAME} extension to perl.
482 # It was generated automatically by MakeMaker version
483 # $VERSION (Revision: $Revision) from the contents of
484 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
486 # ANY CHANGES MADE HERE WILL BE LOST!
488 # MakeMaker ARGV: $argv
490 # MakeMaker Parameters:
493 foreach $key (sort keys %initial_att){
494 my($v) = neatvalue($initial_att{$key});
495 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
497 push @{$self->{RESULT}}, "# $key => $v";
499 undef %initial_att; # free memory
501 if (defined $self->{CONFIGURE}) {
502 push @{$self->{RESULT}}, <<END;
504 # MakeMaker 'CONFIGURE' Parameters:
506 if (scalar(keys %configure_att) > 0) {
507 foreach $key (sort keys %configure_att){
508 my($v) = neatvalue($configure_att{$key});
509 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
511 push @{$self->{RESULT}}, "# $key => $v";
516 push @{$self->{RESULT}}, "# no values returned";
518 undef %configure_att; # free memory
521 # turn the SKIP array into a SKIPHASH hash
523 for $skip (@{$self->{SKIP} || []}) {
524 $self->{SKIPHASH}{$skip} = 1;
526 delete $self->{SKIP}; # free memory
528 if ($self->{PARENT}) {
529 for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
530 $self->{SKIPHASH}{$_} = 1;
534 # We run all the subdirectories now. They don't have much to query
535 # from the parent, but the parent has to query them: if they need linking!
536 unless ($self->{NORECURS}) {
537 $self->eval_in_subdirs if @{$self->{DIR}};
541 foreach $section ( @MM_Sections ){
542 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
543 my($skipit) = $self->skipcheck($section);
545 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
547 my(%a) = %{$self->{$section} || {}};
548 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
549 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
550 push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
554 push @{$self->{RESULT}}, "\n# End.";
559 sub WriteEmptyMakefile {
560 Carp::croak "WriteEmptyMakefile: Need even number of args" if @_ % 2;
561 local $SIG{__WARN__} = \&warnhandler;
564 my $self = MM->new(\%att);
565 if (-f "$self->{MAKEFILE}.old") {
566 chmod 0666, "$self->{MAKEFILE}.old";
567 unlink "$self->{MAKEFILE}.old" or warn "unlink $self->{MAKEFILE}.old: $!";
569 rename $self->{MAKEFILE}, "$self->{MAKEFILE}.old"
570 or warn "rename $self->{MAKEFILE} $self->{MAKEFILE}.old: $!"
571 if -f $self->{MAKEFILE};
572 open MF, '>', $self->{MAKEFILE} or die "open $self->{MAKEFILE} for write: $!";
585 close MF or die "close $self->{MAKEFILE} for write: $!";
589 print STDOUT "Checking if your kit is complete...\n";
590 require ExtUtils::Manifest;
591 $ExtUtils::Manifest::Quiet=$ExtUtils::Manifest::Quiet=1; #avoid warning
592 my(@missed)=ExtUtils::Manifest::manicheck();
594 print STDOUT "Warning: the following files are missing in your kit:\n";
595 print "\t", join "\n\t", @missed;
597 print STDOUT "Please inform the author.\n";
599 print STDOUT "Looks good\n";
604 my($self, @args) = @_;
606 unless (m/(.*?)=(.*)/){
607 help(),exit 1 if m/^help$/;
608 ++$Verbose if m/^verb/;
611 my($name, $value) = ($1, $2);
612 if ($value =~ m/^~(\w+)?/){ # tilde with optional username
613 $value =~ s [^~(\w*)]
615 ((getpwnam($1))[7] || "~$1") :
619 $self->{uc($name)} = $value;
622 # catch old-style 'potential_libs' and inform user how to 'upgrade'
623 if (defined $self->{potential_libs}){
624 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
625 if ($self->{potential_libs}){
626 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
628 print STDOUT "$msg deleted.\n";
630 $self->{LIBS} = [$self->{potential_libs}];
631 delete $self->{potential_libs};
633 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
634 if (defined $self->{ARMAYBE}){
635 my($armaybe) = $self->{ARMAYBE};
636 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
637 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
638 my(%dl) = %{$self->{dynamic_lib} || {}};
639 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
640 delete $self->{ARMAYBE};
642 if (defined $self->{LDTARGET}){
643 print STDOUT "LDTARGET should be changed to LDFROM\n";
644 $self->{LDFROM} = $self->{LDTARGET};
645 delete $self->{LDTARGET};
647 # Turn a DIR argument on the command line into an array
648 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
649 # So they can choose from the command line, which extensions they want
650 # the grep enables them to have some colons too much in case they
651 # have to build a list with the shell
652 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
654 # Turn a INCLUDE_EXT argument on the command line into an array
655 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
656 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
658 # Turn a EXCLUDE_EXT argument on the command line into an array
659 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
660 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
663 foreach $mmkey (sort keys %$self){
664 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
665 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
666 unless exists $Recognized_Att_Keys{$mmkey};
673 # We allow extension-specific hints files.
675 return unless -d "hints";
677 # First we look for the best hintsfile we have
679 my($hint)="${^O}_$Config{osvers}";
684 # Also try without trailing minor version numbers.
686 last if -f "hints/$hint.pl"; # found
688 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
690 return unless -f "hints/$hint.pl"; # really there
692 # execute the hintsfile:
694 # my $fh = new FileHandle;
695 # $fh->open("hints/$hint.pl");
697 open(FH,"hints/$hint.pl");
698 # @goodhints = <$fh>;
702 print STDOUT "Processing hints file hints/$hint.pl\n";
703 eval join('',@goodhints);
704 print STDOUT $@ if $@;
710 my($symtab) = \%{"${from}::"};
713 # Here you see the *current* list of methods that are overridable
714 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
715 # still trying to reduce the list to some reasonable minimum --
716 # because I want to make it easier for the user. A.K.
718 foreach $method (@Overridable) {
720 # We cannot say "next" here. Nick might call MY->makeaperl
721 # which isn't defined right now
723 # Above statement was written at 4.23 time when Tk-b8 was
724 # around. As Tk-b9 only builds with 5.002something and MM 5 is
725 # standard, we try to enable the next line again. It was
726 # commented out until MM 5.23
728 next unless defined &{"${from}::$method"};
730 *{"${to}::$method"} = \&{"${from}::$method"};
732 # delete would do, if we were sure, nobody ever called
733 # MY->makeaperl directly
735 # delete $symtab->{$method};
737 # If we delete a method, then it will be undefined and cannot
738 # be called. But as long as we have Makefile.PLs that rely on
739 # %MY:: being intact, we have to fill the hole with an
742 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
745 # We have to clean out %INC also, because the current directory is
746 # changed frequently and Graham Barr prefers to get his version
747 # out of a History.pl file which is "required" so woudn't get
748 # loaded again in another extension requiring a History.pl
750 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
751 # to core dump in the middle of a require statement. The required
752 # file was Tk/MMutil.pm. The consequence is, we have to be
753 # extremely careful when we try to give perl a reason to reload a
754 # library with same name. The workaround prefers to drop nothing
755 # from %INC and teach the writers not to use such libraries.
758 # foreach $inc (keys %INC) {
759 # #warn "***$inc*** deleted";
767 if ($section eq 'dynamic') {
768 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
769 "in skipped section 'dynamic_bs'\n"
770 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
771 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
772 "in skipped section 'dynamic_lib'\n"
773 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
775 if ($section eq 'dynamic_lib') {
776 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
777 "targets in skipped section 'dynamic_bs'\n"
778 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
780 if ($section eq 'static') {
781 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
782 "in skipped section 'static_lib'\n"
783 if $self->{SKIPHASH}{static_lib} && $Verbose;
785 return 'skipped' if $self->{SKIPHASH}{$section};
793 # my $fh = new FileHandle;
795 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
797 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
798 # $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
799 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
801 for $chunk (@{$self->{RESULT}}) {
802 # print $fh "$chunk\n";
808 my($finalname) = $self->{MAKEFILE};
809 rename("MakeMaker.tmp", $finalname);
810 chmod 0644, $finalname unless $Is_VMS;
812 if ($self->{PARENT}) {
813 foreach (keys %$self) { # safe memory
814 delete $self->{$_} unless $Keep_after_flush{$_};
818 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
821 # The following mkbootstrap() is only for installations that are calling
822 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
823 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
826 !!! Your Makefile has been built such a long time ago, !!!
827 !!! that is unlikely to work with current MakeMaker. !!!
828 !!! Please rebuild your Makefile !!!
832 # Ditto for mksymlists() as of MakeMaker 5.17
835 !!! Your Makefile has been built such a long time ago, !!!
836 !!! that is unlikely to work with current MakeMaker. !!!
837 !!! Please rebuild your Makefile !!!
843 return "undef" unless defined $v;
845 return "q[$v]" unless $t;
847 my(@m, $elem, @neat);
849 foreach $elem (@$v) {
850 push @neat, "q[$elem]";
852 push @m, join ", ", @neat;
856 return "$v" unless $t eq 'HASH';
858 while (($key,$val) = each %$v){
859 last unless defined $key; # cautious programming in case (undef,undef) is true
860 push(@m,"$key=>".neatvalue($val)) ;
862 return "{ ".join(', ',@m)." }";
869 push @m, "\n# Full list of MakeMaker attribute values:";
870 foreach $key (sort keys %$self){
871 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
872 my($v) = neatvalue($self->{$key});
873 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
875 push @m, "# $key => $v";
881 package ExtUtils::MakeMaker;
888 ExtUtils::MakeMaker - create an extension Makefile
892 C<use ExtUtils::MakeMaker;>
894 C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
898 C<MM-E<gt>new(\%att)-E<gt>flush;>
902 This utility is designed to write a Makefile for an extension module
903 from a Makefile.PL. It is based on the Makefile.SH model provided by
904 Andy Dougherty and the perl5-porters.
906 It splits the task of generating the Makefile into several subroutines
907 that can be individually overridden. Each subroutine returns the text
908 it wishes to have written to the Makefile.
910 MakeMaker is object oriented. Each directory below the current
911 directory that contains a Makefile.PL. Is treated as a separate
912 object. This makes it possible to write an unlimited number of
913 Makefiles with a single invocation of WriteMakefile().
915 =head2 How To Write A Makefile.PL
917 The short answer is: Don't.
919 Always begin with h2xs.
920 Always begin with h2xs!
921 ALWAYS BEGIN WITH H2XS!
923 even if you're not building around a header file, and even if you
924 don't have an XS component.
926 Run h2xs(1) before you start thinking about writing a module. For so
927 called pm-only modules that consist of C<*.pm> files only, h2xs has
928 the C<-X> switch. This will generate dummy files of all kinds that are
929 useful for the module developer.
931 The medium answer is:
933 use ExtUtils::MakeMaker;
934 WriteMakefile( NAME => "Foo::Bar" );
936 The long answer is the rest of the manpage :-)
938 =head2 Default Makefile Behaviour
940 The generated Makefile enables the user of the extension to invoke
942 perl Makefile.PL # optionally "perl Makefile.PL verbose"
944 make test # optionally set TEST_VERBOSE=1
945 make install # See below
947 The Makefile to be produced may be altered by adding arguments of the
948 form C<KEY=VALUE>. E.g.
950 perl Makefile.PL PREFIX=/tmp/myperl5
952 Other interesting targets in the generated Makefile are
954 make config # to check if the Makefile is up-to-date
955 make clean # delete local temp files (Makefile gets renamed)
956 make realclean # delete derived files (including ./blib)
957 make ci # check in all the files in the MANIFEST file
958 make dist # see below the Distribution Support section
962 MakeMaker checks for the existence of a file named F<test.pl> in the
963 current directory and if it exists it adds commands to the test target
964 of the generated Makefile that will execute the script with the proper
965 set of perl C<-I> options.
967 MakeMaker also checks for any files matching glob("t/*.t"). It will
968 add commands to the test target of the generated Makefile that execute
969 all matching files via the L<Test::Harness> module with the C<-I>
970 switches set correctly.
974 A useful variation of the above is the target C<testdb>. It runs the
975 test under the Perl debugger (see L<perldebug>). If the file
976 F<test.pl> exists in the current directory, it is used for the test.
978 If you want to debug some other testfile, set C<TEST_FILE> variable
981 make testdb TEST_FILE=t/mytest.t
983 By default the debugger is called using C<-d> option to perl. If you
984 want to specify some other option, set C<TESTDB_SW> variable:
986 make testdb TESTDB_SW=-Dx
990 make alone puts all relevant files into directories that are named by
991 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_HTMLLIBDIR,
992 INST_HTMLSCRIPTDIR, INST_MAN1DIR, and INST_MAN3DIR. All these default
993 to something below ./blib if you are I<not> building below the perl
994 source directory. If you I<are> building below the perl source,
995 INST_LIB and INST_ARCHLIB default to ../../lib, and INST_SCRIPT is not
998 The I<install> target of the generated Makefile copies the files found
999 below each of the INST_* directories to their INSTALL*
1000 counterparts. Which counterparts are chosen depends on the setting of
1001 INSTALLDIRS according to the following table:
1006 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH
1007 INST_LIB INSTALLPRIVLIB INSTALLSITELIB
1008 INST_HTMLLIBDIR INSTALLHTMLPRIVLIBDIR INSTALLHTMLSITELIBDIR
1009 INST_HTMLSCRIPTDIR INSTALLHTMLSCRIPTDIR
1011 INST_SCRIPT INSTALLSCRIPT
1012 INST_MAN1DIR INSTALLMAN1DIR
1013 INST_MAN3DIR INSTALLMAN3DIR
1015 The INSTALL... macros in turn default to their %Config
1016 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
1018 You can check the values of these variables on your system with
1022 And to check the sequence in which the library directories are
1023 searched by perl, run
1025 perl -le 'print join $/, @INC'
1028 =head2 PREFIX and LIB attribute
1030 PREFIX and LIB can be used to set several INSTALL* attributes in one
1031 go. The quickest way to install a module in a non-standard place might
1034 perl Makefile.PL LIB=~/lib
1036 This will install the module's architecture-independent files into
1037 ~/lib, the architecture-dependent files into ~/lib/$archname.
1039 Another way to specify many INSTALL directories with a single
1040 parameter is PREFIX.
1042 perl Makefile.PL PREFIX=~
1044 This will replace the string specified by C<$Config{prefix}> in all
1045 C<$Config{install*}> values.
1047 Note, that in both cases the tilde expansion is done by MakeMaker, not
1048 by perl by default, nor by make.
1050 Conflicts between parameters LIB,
1051 PREFIX and the various INSTALL* arguments are resolved so that:
1057 setting LIB overrides any setting of INSTALLPRIVLIB, INSTALLARCHLIB,
1058 INSTALLSITELIB, INSTALLSITEARCH (and they are not affected by PREFIX);
1062 without LIB, setting PREFIX replaces the initial C<$Config{prefix}>
1063 part of those INSTALL* arguments, even if the latter are explicitly
1064 set (but are set to still start with C<$Config{prefix}>).
1068 If the user has superuser privileges, and is not working on AFS
1069 or relatives, then the defaults for
1070 INSTALLPRIVLIB, INSTALLARCHLIB, INSTALLSCRIPT, etc. will be appropriate,
1071 and this incantation will be the best:
1073 perl Makefile.PL; make; make test
1076 make install per default writes some documentation of what has been
1077 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1078 can be bypassed by calling make pure_install.
1082 will have to specify the installation directories as these most
1083 probably have changed since perl itself has been installed. They will
1084 have to do this by calling
1086 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1087 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1090 Be careful to repeat this procedure every time you recompile an
1091 extension, unless you are sure the AFS installation directories are
1094 =head2 Static Linking of a new Perl Binary
1096 An extension that is built with the above steps is ready to use on
1097 systems supporting dynamic loading. On systems that do not support
1098 dynamic loading, any newly created extension has to be linked together
1099 with the available resources. MakeMaker supports the linking process
1100 by creating appropriate targets in the Makefile whenever an extension
1101 is built. You can invoke the corresponding section of the makefile with
1105 That produces a new perl binary in the current directory with all
1106 extensions linked in that can be found in INST_ARCHLIB, SITELIBEXP,
1107 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1108 UNIX, this is called Makefile.aperl (may be system dependent). If you
1109 want to force the creation of a new perl, it is recommended, that you
1110 delete this Makefile.aperl, so the directories are searched-through
1111 for linkable libraries again.
1113 The binary can be installed into the directory where perl normally
1114 resides on your machine with
1118 To produce a perl binary with a different name than C<perl>, either say
1120 perl Makefile.PL MAP_TARGET=myperl
1127 make myperl MAP_TARGET=myperl
1128 make inst_perl MAP_TARGET=myperl
1130 In any case you will be prompted with the correct invocation of the
1131 C<inst_perl> target that installs the new binary into INSTALLBIN.
1133 make inst_perl per default writes some documentation of what has been
1134 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1135 can be bypassed by calling make pure_inst_perl.
1137 Warning: the inst_perl: target will most probably overwrite your
1138 existing perl binary. Use with care!
1140 Sometimes you might want to build a statically linked perl although
1141 your system supports dynamic loading. In this case you may explicitly
1142 set the linktype with the invocation of the Makefile.PL or make:
1144 perl Makefile.PL LINKTYPE=static # recommended
1148 make LINKTYPE=static # works on most systems
1150 =head2 Determination of Perl Library and Installation Locations
1152 MakeMaker needs to know, or to guess, where certain things are
1153 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1154 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1155 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1157 Extensions may be built either using the contents of the perl source
1158 directory tree or from the installed perl library. The recommended way
1159 is to build extensions after you have run 'make install' on perl
1160 itself. You can do that in any directory on your hard disk that is not
1161 below the perl source tree. The support for extensions below the ext
1162 directory of the perl distribution is only good for the standard
1163 extensions that come with perl.
1165 If an extension is being built below the C<ext/> directory of the perl
1166 source then MakeMaker will set PERL_SRC automatically (e.g.,
1167 C<../..>). If PERL_SRC is defined and the extension is recognized as
1168 a standard extension, then other variables default to the following:
1171 PERL_LIB = PERL_SRC/lib
1172 PERL_ARCHLIB = PERL_SRC/lib
1174 INST_ARCHLIB = PERL_ARCHLIB
1176 If an extension is being built away from the perl source then MakeMaker
1177 will leave PERL_SRC undefined and default to using the installed copy
1178 of the perl library. The other variables default to the following:
1180 PERL_INC = $archlibexp/CORE
1181 PERL_LIB = $privlibexp
1182 PERL_ARCHLIB = $archlibexp
1183 INST_LIB = ./blib/lib
1184 INST_ARCHLIB = ./blib/arch
1186 If perl has not yet been installed then PERL_SRC can be defined on the
1187 command line as shown in the previous section.
1190 =head2 Which architecture dependent directory?
1192 If you don't want to keep the defaults for the INSTALL* macros,
1193 MakeMaker helps you to minimize the typing needed: the usual
1194 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1195 by Configure at perl compilation time. MakeMaker supports the user who
1196 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1197 then MakeMaker defaults the latter to be the same subdirectory of
1198 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1199 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1200 for INSTALLSITELIB and INSTALLSITEARCH.
1202 MakeMaker gives you much more freedom than needed to configure
1203 internal variables and get different results. It is worth to mention,
1204 that make(1) also lets you configure most of the variables that are
1205 used in the Makefile. But in the majority of situations this will not
1206 be necessary, and should only be done if the author of a package
1207 recommends it (or you know what you're doing).
1209 =head2 Using Attributes and Parameters
1211 The following attributes can be specified as arguments to WriteMakefile()
1212 or as NAME=VALUE pairs on the command line:
1218 One line description of the module. Will be included in PPD file.
1222 Name of the file that contains the package description. MakeMaker looks
1223 for a line in the POD matching /^($package\s-\s)(.*)/. This is typically
1224 the first line in the "=head1 NAME" section. $2 becomes the abstract.
1228 String containing name (and email address) of package author(s). Is used
1229 in PPD (Perl Package Description) files for PPM (Perl Package Manager).
1231 =item BINARY_LOCATION
1233 Used when creating PPD files for binary packages. It can be set to a
1234 full or relative path or URL to the binary archive for a particular
1235 architecture. For example:
1237 perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
1239 builds a PPD package that references a binary of the C<Agent> package,
1240 located in the C<x86> directory relative to the PPD itself.
1244 Ref to array of *.c file names. Initialised from a directory scan
1245 and the values portion of the XS attribute hash. This is not
1246 currently used by MakeMaker but may be handy in Makefile.PLs.
1250 String that will be included in the compiler call command line between
1251 the arguments INC and OPTIMIZE.
1255 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1256 config.sh. MakeMaker will add to CONFIG the following values anyway:
1276 CODE reference. The subroutine should return a hash reference. The
1277 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1278 be determined by some evaluation method.
1282 Something like C<"-DHAVE_UNISTD_H">
1286 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1291 Your name for distributing the package (by tar file). This defaults to
1296 Hashref of symbol names for routines to be made available as universal
1297 symbols. Each key/value pair consists of the package name and an
1298 array of routine names in that package. Used only under AIX, OS/2,
1299 VMS and Win32 at present. The routine names supplied will be expanded
1300 in the same way as XSUB names are expanded by the XS() macro.
1303 {"$(NAME)" => ["boot_$(NAME)" ] }
1307 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1308 "NetconfigPtr" => [ 'DESTROY'] }
1310 Please see the L<ExtUtils::Mksymlists> documentation for more information
1311 about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
1315 Array of symbol names for variables to be made available as universal symbols.
1316 Used only under AIX, OS/2, VMS and Win32 at present. Defaults to [].
1317 (e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
1321 Array of extension names to exclude when doing a static build. This
1322 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1323 details. (e.g. [ qw( Socket POSIX ) ] )
1325 This attribute may be most useful when specified as a string on the
1326 command line: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1330 Ref to array of executable files. The files will be copied to the
1331 INST_SCRIPT directory. Make realclean will delete them from there
1334 =item FIRST_MAKEFILE
1336 The name of the Makefile to be produced. Defaults to the contents of
1337 MAKEFILE, but can be overridden. This is used for the second Makefile
1338 that will be produced for the MAP_TARGET.
1342 Perl binary able to run this extension.
1346 This provides an alternate means to specify function names to be
1347 exported from the extension. Its value is a reference to an
1348 array of function names to be exported by the extension. These
1349 names are passed through unaltered to the linker options file.
1353 Ref to array of *.h file names. Similar to C.
1357 Hashref of .pm and .pod files. MakeMaker will default this to all
1358 .pod and any .pm files that include POD directives. The files listed
1359 here will be converted to HTML format and installed as was requested
1362 =item HTMLSCRIPTPODS
1364 Hashref of pod-containing files. MakeMaker will default this to all
1365 EXE_FILES files that include POD directives. The files listed
1366 here will be converted to HTML format and installed as was requested
1371 This attribute is used to specify names to be imported into the
1372 extension. It is only used on OS/2 and Win32.
1376 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1380 Array of extension names to be included when doing a static build.
1381 MakeMaker will normally build with all of the installed extensions when
1382 doing a static build, and that is usually the desired behavior. If
1383 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1384 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1386 It is not necessary to mention DynaLoader or the current extension when
1387 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1388 only DynaLoader and the current extension will be included in the build.
1390 This attribute may be most useful when specified as a string on the
1391 command line: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1393 =item INSTALLARCHLIB
1395 Used by 'make install', which copies files from INST_ARCHLIB to this
1396 directory if INSTALLDIRS is set to perl.
1400 Directory to install binary files (e.g. tkperl) into.
1404 Determines which of the two sets of installation directories to
1405 choose: installprivlib and installarchlib versus installsitelib and
1406 installsitearch. The first pair is chosen with INSTALLDIRS=perl, the
1407 second with INSTALLDIRS=site. Default is site.
1409 =item INSTALLHTMLPRIVLIBDIR
1411 This directory gets the HTML pages at 'make install' time. Defaults to
1412 $Config{installhtmlprivlibdir}.
1414 =item INSTALLHTMLSCRIPTDIR
1416 This directory gets the HTML pages at 'make install' time. Defaults to
1417 $Config{installhtmlscriptdir}.
1419 =item INSTALLHTMLSITELIBDIR
1421 This directory gets the HTML pages at 'make install' time. Defaults to
1422 $Config{installhtmlsitelibdir}.
1425 =item INSTALLMAN1DIR
1427 This directory gets the man pages at 'make install' time. Defaults to
1428 $Config{installman1dir}.
1430 =item INSTALLMAN3DIR
1432 This directory gets the man pages at 'make install' time. Defaults to
1433 $Config{installman3dir}.
1435 =item INSTALLPRIVLIB
1437 Used by 'make install', which copies files from INST_LIB to this
1438 directory if INSTALLDIRS is set to perl.
1442 Used by 'make install' which copies files from INST_SCRIPT to this
1445 =item INSTALLSITEARCH
1447 Used by 'make install', which copies files from INST_ARCHLIB to this
1448 directory if INSTALLDIRS is set to site (default).
1450 =item INSTALLSITELIB
1452 Used by 'make install', which copies files from INST_LIB to this
1453 directory if INSTALLDIRS is set to site (default).
1457 Same as INST_LIB for architecture dependent files.
1461 Directory to put real binary files during 'make'. These will be copied
1462 to INSTALLBIN during 'make install'
1466 Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you
1469 =item INST_HTMLLIBDIR
1471 Directory to hold the man pages in HTML format at 'make' time
1473 =item INST_HTMLSCRIPTDIR
1475 Directory to hold the man pages in HTML format at 'make' time
1479 Directory where we put library files of this extension while building
1484 Directory to hold the man pages at 'make' time
1488 Directory to hold the man pages at 'make' time
1492 Directory, where executable files should be installed during
1493 'make'. Defaults to "./blib/script", just to have a dummy location during
1494 testing. make install will copy the files in INST_SCRIPT to
1499 defaults to "$(OBJECT)" and is used in the ld command to specify
1500 what files to link/load from (also see dynamic_lib below for how to
1505 LIB should only be set at C<perl Makefile.PL> time but is allowed as a
1506 MakeMaker argument. It has the effect of
1507 setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any
1508 explicit setting of those arguments (or of PREFIX).
1509 INSTALLARCHLIB and INSTALLSITEARCH are set to the corresponding
1510 architecture subdirectory.
1514 The filename of the perllibrary that will be used together with this
1515 extension. Defaults to libperl.a.
1519 An anonymous array of alternative library
1520 specifications to be searched for (in order) until
1521 at least one library is found. E.g.
1523 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1525 Mind, that any element of the array
1526 contains a complete set of arguments for the ld
1527 command. So do not specify
1529 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1531 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1532 you specify a scalar as in
1534 'LIBS' => "-ltcl -ltk -lX11"
1536 MakeMaker will turn it into an array with one element.
1540 'static' or 'dynamic' (default unless usedl=undef in
1541 config.sh). Should only be used to force static linking (also see
1546 Boolean which tells MakeMaker, that it should include the rules to
1547 make a perl. This is handled automatically as a switch by
1548 MakeMaker. The user normally does not need it.
1552 The name of the Makefile to be produced.
1556 Hashref of pod-containing files. MakeMaker will default this to all
1557 EXE_FILES files that include POD directives. The files listed
1558 here will be converted to man pages and installed as was requested
1563 Hashref that assigns to *.pm and *.pod files the files into which the
1564 manpages are to be written. MakeMaker parses all *.pod and *.pm files
1565 for POD directives. Files that contain POD will be the default keys of
1566 the MAN3PODS hashref. These will then be converted to man pages during
1567 C<make> and will be installed during C<make install>.
1571 If it is intended, that a new perl binary be produced, this variable
1572 may hold a name for that binary. Defaults to perl
1576 If the extension links to a library that it builds set this to the
1577 name of the library (see SDBM_File)
1581 Perl module name for this extension (DBD::Oracle). This will default
1582 to the directory name but should be explicitly defined in the
1587 MakeMaker will figure out if an extension contains linkable code
1588 anywhere down the directory tree, and will set this variable
1589 accordingly, but you can speed it up a very little bit if you define
1590 this boolean variable yourself.
1594 Defaults to C<@>. By setting it to an empty string you can generate a
1595 Makefile that echos all commands. Mainly used in debugging MakeMaker
1600 Boolean. Attribute to inhibit descending into subdirectories.
1604 In general, any generated Makefile checks for the current version of
1605 MakeMaker and the version the Makefile was built under. If NO_VC is
1606 set, the version check is neglected. Do not write this into your
1607 Makefile.PL, use it interactively instead.
1611 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1612 string containing all object files, e.g. "tkpBind.o
1613 tkpButton.o tkpCanvas.o"
1615 (Where BASEEXT is the last component of NAME, and OBJ_EXT is $Config{obj_ext}.)
1619 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1620 passed to subdirectory makes.
1624 Perl binary for tasks that can be done by miniperl
1628 Set only when MakeMaker is building the extensions of the Perl core
1633 The call to the program that is able to compile perlmain.c. Defaults
1638 Same as for PERL_LIB, but for architecture dependent files.
1640 Used only when MakeMaker is building the extensions of the Perl core
1641 distribution (because normally $(PERL_ARCHLIB) is automatically in @INC,
1642 and adding it would get in the way of PERL5LIB).
1646 Directory containing the Perl library to use.
1648 Used only when MakeMaker is building the extensions of the Perl core
1649 distribution (because normally $(PERL_LIB) is automatically in @INC,
1650 and adding it would get in the way of PERL5LIB).
1652 =item PERL_MALLOC_OK
1654 defaults to 0. Should be set to TRUE if the extension can work with
1655 the memory allocation routines substituted by the Perl malloc() subsystem.
1656 This should be applicable to most extensions with exceptions of those
1662 with bugs in memory allocations which are caught by Perl's malloc();
1666 which interact with the memory allocator in other ways than via
1667 malloc(), realloc(), free(), calloc(), sbrk() and brk();
1671 which rely on special alignment which is not provided by Perl's malloc().
1675 B<NOTE.> Negligence to set this flag in I<any one> of loaded extension
1676 nullifies many advantages of Perl's malloc(), such as better usage of
1677 system resources, error detection, memory usage reporting, catchable failure
1678 of memory allocations, etc.
1682 Use this instead of $(PERL) or $(FULLPERL) when you wish to run perl.
1683 It will set up extra necessary flags for you.
1687 Use this instead of $(PERL) or $(FULLPERL) when you wish to run
1688 perl to work with modules. It will add things like -I$(INST_ARCH)
1689 and other necessary flags.
1693 Directory containing the Perl source code (use of this should be
1694 avoided, it may be undefined)
1698 Desired permission for read/writable files. Defaults to C<644>.
1699 See also L<MM_Unix/perm_rw>.
1703 Desired permission for executable files. Defaults to C<755>.
1704 See also L<MM_Unix/perm_rwx>.
1708 Ref to hash of files to be processed as perl programs. MakeMaker
1709 will default to any found *.PL file (except Makefile.PL) being keys
1710 and the basename of the file being the value. E.g.
1712 {'foobar.PL' => 'foobar'}
1714 The *.PL files are expected to produce output to the target files
1715 themselves. If multiple files can be generated from the same *.PL
1716 file then the value in the hash can be a reference to an array of
1717 target file names. E.g.
1719 {'foobar.PL' => ['foobar1','foobar2']}
1723 Hashref of .pm files and *.pl files to be installed. e.g.
1725 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1727 By default this will include *.pm and *.pl and the files found in
1728 the PMLIBDIRS directories. Defining PM in the
1729 Makefile.PL will override PMLIBDIRS.
1733 Ref to array of subdirectories containing library files. Defaults to
1734 [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
1735 they contain will be installed in the corresponding location in the
1736 library. A libscan() method can be used to alter the behaviour.
1737 Defining PM in the Makefile.PL will override PMLIBDIRS.
1739 (Where BASEEXT is the last component of NAME.)
1743 A filter program, in the traditional Unix sense (input from stdin, output
1744 to stdout) that is passed on each .pm file during the build (in the
1745 pm_to_blib() phase). It is empty by default, meaning no filtering is done.
1747 Great care is necessary when defining the command if quoting needs to be
1748 done. For instance, you would need to say:
1750 {'PM_FILTER' => 'grep -v \\"^\\#\\"'}
1752 to remove all the leading coments on the fly during the build. The
1753 extra \\ are necessary, unfortunately, because this variable is interpolated
1754 within the context of a Perl program built on the command line, and double
1755 quotes are what is used with the -e switch to build that command line. The
1756 # is escaped for the Makefile, since what is going to be generated will then
1759 PM_FILTER = grep -v \"^\#\"
1761 Without the \\ before the #, we'd have the start of a Makefile comment,
1762 and the macro would be incorrectly defined.
1766 Release 5.005 grandfathered old global symbol names by providing preprocessor
1767 macros for extension source compatibility. As of release 5.6, these
1768 preprocessor definitions are not available by default. The POLLUTE flag
1769 specifies that the old names should still be defined:
1771 perl Makefile.PL POLLUTE=1
1773 Please inform the module author if this is necessary to successfully install
1774 a module under 5.6 or later.
1776 =item PPM_INSTALL_EXEC
1778 Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl)
1780 =item PPM_INSTALL_SCRIPT
1782 Name of the script that gets executed by the Perl Package Manager after
1783 the installation of a package.
1787 Can be used to set the three INSTALL* attributes in one go (except for
1788 probably INSTALLMAN1DIR, if it is not below PREFIX according to
1789 %Config). They will have PREFIX as a common directory node and will
1790 branch from that node into lib/, lib/ARCHNAME or whatever Configure
1791 decided at the build time of your perl (unless you override one of
1796 Hashref: Names of modules that need to be available to run this
1797 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1798 desired version is the value. If the required version number is 0, we
1799 only check if any version is installed already.
1803 Bool. If this parameter is true, failing to have the required modules
1804 (or the right versions thereof) will be fatal. perl Makefile.PL will die
1805 with the proper message.
1807 Note: see L<Test::Harness> for a shortcut for stopping tests early if
1808 you are missing dependencies.
1810 Do I<not> use this parameter for simple requirements, which could be resolved
1811 at a later time, e.g. after an unsuccessful B<make test> of your module.
1813 It is I<extremely> rare to have to use C<PREREQ_FATAL> at all!
1817 Bool. If this parameter is true, the prerequisites will be printed to
1818 stdout and MakeMaker will exit. The output format is
1828 RedHatism for C<PREREQ_PRINT>. The output format is different, though:
1830 perl(A::B)>=Vers1 perl(C::D)>=Vers2 ...
1834 Arrayref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1835 Makefile. Caution! Do not use the SKIP attribute for the negligible
1836 speedup. It may seriously damage the resulting Makefile. Only use it
1837 if you really need it.
1841 The set of -I's necessary to run a "make test". Use as:
1842 $(PERL) $(TEST_LIBS) -e '...' for example.
1846 Ref to array of typemap file names. Use this when the typemaps are
1847 in some directory other than the current directory or when they are
1848 not named B<typemap>. The last typemap in the list takes
1849 precedence. A typemap in the current directory has highest
1850 precedence, even if it isn't listed in TYPEMAPS. The default system
1851 typemap has lowest precedence.
1855 Your version number for distributing the package. This defaults to
1860 Instead of specifying the VERSION in the Makefile.PL you can let
1861 MakeMaker parse a file to determine the version number. The parsing
1862 routine requires that the file named by VERSION_FROM contains one
1863 single line to compute the version number. The first line in the file
1864 that contains the regular expression
1866 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
1868 will be evaluated with eval() and the value of the named variable
1869 B<after> the eval() will be assigned to the VERSION attribute of the
1870 MakeMaker object. The following lines will be parsed o.k.:
1874 ( $VERSION ) = '$Revision: 1.222 $ ' =~ /\$Revision:\s+([^\s]+)/;
1875 $FOO::VERSION = '1.10';
1876 *FOO::VERSION = \'1.11';
1877 our $VERSION = 1.2.3; # new for perl5.6.0
1879 but these will fail:
1881 my $VERSION = '1.01';
1882 local $VERSION = '1.02';
1883 local $FOO::VERSION = '1.30';
1885 (Putting C<my> or C<local> on the preceding line will work o.k.)
1887 The file named in VERSION_FROM is not added as a dependency to
1888 Makefile. This is not really correct, but it would be a major pain
1889 during development to have to rewrite the Makefile for any smallish
1890 change in that file. If you want to make sure that the Makefile
1891 contains the correct VERSION macro after any change of the file, you
1892 would have to do something like
1894 depend => { Makefile => '$(VERSION_FROM)' }
1896 See attribute C<depend> below.
1900 Hashref of .xs files. MakeMaker will default this. e.g.
1902 {'name_of_file.xs' => 'name_of_file.c'}
1904 The .c files will automatically be included in the list of files
1905 deleted by a make clean.
1909 String of options to pass to xsubpp. This might include C<-C++> or
1910 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
1915 May be set to an empty string, which is identical to C<-prototypes>, or
1916 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
1917 defaults to the empty string.
1921 Your version number for the .xs file of this package. This defaults
1922 to the value of the VERSION attribute.
1926 =head2 Additional lowercase attributes
1928 can be used to pass parameters to the methods which implement that
1929 part of the Makefile.
1935 {FILES => "*.xyz foo"}
1939 {ANY_TARGET => ANY_DEPENDECY, ...}
1941 (ANY_TARGET must not be given a double-colon rule by MakeMaker.)
1945 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
1946 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
1947 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
1949 If you specify COMPRESS, then SUFFIX should also be altered, as it is
1950 needed to tell make the target file of the compression. Setting
1951 DIST_CP to ln can be useful, if you need to preserve the timestamps on
1952 your files. DIST_CP can take the values 'cp', which copies the file,
1953 'ln', which links the file, and 'best' which copies symbolic links and
1954 links the rest. Default is 'best'.
1958 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
1962 {LINKTYPE => 'static', 'dynamic' or ''}
1964 NB: Extensions that have nothing but *.pm files had to say
1968 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1969 can be deleted safely. MakeMaker recognizes when there's nothing to
1974 {ANY_MACRO => ANY_VALUE, ...}
1978 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
1984 =item tool_autosplit
1990 =head2 Overriding MakeMaker Methods
1992 If you cannot achieve the desired Makefile behaviour by specifying
1993 attributes you may define private subroutines in the Makefile.PL.
1994 Each subroutines returns the text it wishes to have written to
1995 the Makefile. To override a section of the Makefile you can
1998 sub MY::c_o { "new literal text" }
2000 or you can edit the default by saying something like:
2003 package MY; # so that "SUPER" works right
2004 my $inherited = shift->SUPER::c_o(@_);
2005 $inherited =~ s/old text/new text/;
2009 If you are running experiments with embedding perl as a library into
2010 other applications, you might find MakeMaker is not sufficient. You'd
2011 better have a look at ExtUtils::Embed which is a collection of utilities
2014 If you still need a different solution, try to develop another
2015 subroutine that fits your needs and submit the diffs to
2016 F<perl5-porters@perl.org> or F<comp.lang.perl.moderated> as appropriate.
2018 For a complete description of all MakeMaker methods see L<ExtUtils::MM_Unix>.
2020 Here is a simple example of how to add a new target to the generated
2025 $(MYEXTLIB): sdbm/Makefile
2026 cd sdbm && $(MAKE) all
2031 =head2 Hintsfile support
2033 MakeMaker.pm uses the architecture specific information from
2034 Config.pm. In addition it evaluates architecture specific hints files
2035 in a C<hints/> directory. The hints files are expected to be named
2036 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
2037 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
2038 MakeMaker within the WriteMakefile() subroutine, and can be used to
2039 execute commands as well as to include special variables. The rules
2040 which hintsfile is chosen are the same as in Configure.
2042 The hintsfile is eval()ed immediately after the arguments given to
2043 WriteMakefile are stuffed into a hash reference $self but before this
2044 reference becomes blessed. So if you want to do the equivalent to
2045 override or create an attribute you would say something like
2047 $self->{LIBS} = ['-ldbm -lucb -lc'];
2049 =head2 Distribution Support
2051 For authors of extensions MakeMaker provides several Makefile
2052 targets. Most of the support comes from the ExtUtils::Manifest module,
2053 where additional documentation can be found.
2057 =item make distcheck
2059 reports which files are below the build directory but not in the
2060 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
2063 =item make skipcheck
2065 reports which files are skipped due to the entries in the
2066 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
2069 =item make distclean
2071 does a realclean first and then the distcheck. Note that this is not
2072 needed to build a new distribution as long as you are sure that the
2073 MANIFEST file is ok.
2077 rewrites the MANIFEST file, adding all remaining files found (See
2078 ExtUtils::Manifest::mkmanifest() for details)
2082 Copies all the files that are in the MANIFEST file to a newly created
2083 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
2084 exists, it will be removed first.
2088 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
2089 a make test in that directory.
2093 First does a distdir. Then a command $(PREOP) which defaults to a null
2094 command, followed by $(TOUNIX), which defaults to a null command under
2095 UNIX, and will convert files in distribution directory to UNIX format
2096 otherwise. Next it runs C<tar> on that directory into a tarfile and
2097 deletes the directory. Finishes with a command $(POSTOP) which
2098 defaults to a null command.
2102 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
2104 =item make uutardist
2106 Runs a tardist first and uuencodes the tarfile.
2110 First does a distdir. Then a command $(PREOP) which defaults to a null
2111 command. Next it runs C<shar> on that directory into a sharfile and
2112 deletes the intermediate directory again. Finishes with a command
2113 $(POSTOP) which defaults to a null command. Note: For shdist to work
2114 properly a C<shar> program that can handle directories is mandatory.
2118 First does a distdir. Then a command $(PREOP) which defaults to a null
2119 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
2120 zipfile. Then deletes that directory. Finishes with a command
2121 $(POSTOP) which defaults to a null command.
2125 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
2129 Customization of the dist targets can be done by specifying a hash
2130 reference to the dist attribute of the WriteMakefile call. The
2131 following parameters are recognized:
2134 COMPRESS ('gzip --best')
2137 TO_UNIX (depends on the system)
2138 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
2148 WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" })
2150 =head2 Disabling an extension
2152 If some events detected in F<Makefile.PL> imply that there is no way
2153 to create the Module, but this is a normal state of things, then you
2154 can create a F<Makefile> which does nothing, but succeeds on all the
2155 "usual" build targets. To do so, use
2157 ExtUtils::MakeMaker::WriteEmptyMakefile();
2159 instead of WriteMakefile().
2161 This may be useful if other modules expect this module to be I<built>
2162 OK, as opposed to I<work> OK (say, this system-dependent module builds
2163 in a subdirectory of some other distribution, or is listed as a
2164 dependency in a CPAN::Bundle, but the functionality is supported by
2165 different means on the current architecture).
2173 Command line options used by C<MakeMaker-E<gt>new()>, and thus by
2174 C<WriteMakefile()>. The string is split on whitespace, and the result
2175 is processed before any actual command line arguments are processed.
2177 =item PERL_MM_USE_DEFAULT
2179 If set to a true value then MakeMaker's prompt function will
2180 always return the default without waiting for user input.
2186 ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib,
2187 ExtUtils::Install, ExtUtils::Embed
2191 Andy Dougherty <F<doughera@lafcol.lafayette.edu>>, Andreas KE<ouml>nig
2192 <F<andreas.koenig@mind.de>>, Tim Bunce <F<Tim.Bunce@ig.co.uk>>. VMS
2193 support by Charles Bailey <F<bailey@newman.upenn.edu>>. OS/2 support
2194 by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>.
2196 Contact the MakeMaker mailing list <F<makemaker@perl.org>> if you have
2199 Send patches and bug reports to <F<perlbug@perl.org>>.