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+$//;
17 @ISA @EXPORT @EXPORT_OK $AUTOLOAD
18 $ISA_TTY $Revision $VERSION $Verbose $Version_OK %Config
19 %Keep_after_flush %MM_Sections %Prepend_dot_dot
20 %Recognized_Att_Keys @Get_from_Config @MM_Sections @Overridable
25 # &DynaLoader::mod2fname should be available to miniperl, thus
26 # should be a pseudo-builtin (cmp. os2.c).
27 #eval {require DynaLoader;};
30 # Set up the inheritance before we pull in the MM_* packages, because they
31 # import variables and functions from here
34 @EXPORT = qw(&WriteMakefile &writeMakefile $Verbose &prompt);
35 @EXPORT_OK = qw($VERSION &Version_check &neatvalue &mkbootstrap &mksymlists);
38 # Dummy package MM inherits actual methods from OS-specific
39 # default packages. We use this intermediate package so
40 # MY::XYZ->func() can call MM->func() and get the proper
41 # default routine without having to know under what OS
44 @MM::ISA = qw[ExtUtils::MM_Unix ExtUtils::Liblist::Kid ExtUtils::MakeMaker];
47 # Setup dummy package:
48 # MY exists for overriding methods to be defined within
53 ### sub AUTOLOAD { use Devel::Symdump; print Devel::Symdump->rnew->as_string; Carp::confess "hey why? $AUTOLOAD" }
58 # "predeclare the package: we only load it via AUTOLOAD
59 # but we have already mentioned it in @ISA
60 package ExtUtils::Liblist::Kid;
62 package ExtUtils::MakeMaker;
64 # Now we can pull in the friends
66 my $Is_VMS = $^O eq 'VMS';
67 my $Is_OS2 = $^O eq 'os2';
68 my $Is_Mac = $^O eq 'MacOS';
69 my $Is_Win32 = $^O eq 'MSWin32';
70 my $Is_Cygwin = $^O eq 'cygwin';
71 my $Is_NetWare = $Config{osname} eq 'NetWare';
72 my $Is_BeOS = $^O =~ /beos/i; # XXX should this be that loose?
74 require ExtUtils::MM_Unix;
77 require ExtUtils::MM_VMS;
78 require VMS::Filespec; # is a noop as long as we require it within MM_VMS
81 require ExtUtils::MM_OS2;
84 require ExtUtils::MM_MacOS;
87 require ExtUtils::MM_NW5;
91 require ExtUtils::MM_Win32;
94 require ExtUtils::MM_Cygwin;
97 require ExtUtils::MM_BeOS;
102 # The use of the Version_check target has been dropped between perl
103 # 5.5.63 and 5.5.64. We must keep the subroutine for a while so that
104 # old Makefiles can satisfy the Version_check target.
107 my($checkversion) = @_;
108 die "Your Makefile was built with ExtUtils::MakeMaker v $checkversion.
109 Current Version is $ExtUtils::MakeMaker::VERSION. There have been considerable
110 changes in the meantime.
111 Please rerun 'perl Makefile.PL' to regenerate the Makefile.\n"
112 if $checkversion < $Version_OK;
113 printf STDOUT "%s %s %s %s.\n", "Makefile built with ExtUtils::MakeMaker v",
114 $checkversion, "Current Version is", $VERSION
115 unless $checkversion == $VERSION;
119 $_[0] =~ /^Use of uninitialized value/ && return;
120 $_[0] =~ /used only once/ && return;
121 $_[0] =~ /^Subroutine\s+[\w:]+\s+redefined/ && return;
126 Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
127 local $SIG{__WARN__} = \&warnhandler;
130 MM->new(\%att)->flush;
135 $ISA_TTY = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ; # Pipe?
136 Carp::confess("prompt function called without an argument") unless defined $mess;
137 my $dispdef = defined $def ? "[$def] " : " ";
138 $def = defined $def ? $def : "";
141 print "$mess $dispdef";
142 if ($ISA_TTY && !$ENV{PERL_MM_USE_DEFAULT}) {
143 chomp($ans = <STDIN>);
147 return ($ans ne '') ? $ans : $def;
150 sub eval_in_subdirs {
152 use Cwd qw(cwd abs_path);
154 local @INC = map eval {abs_path($_) if -e} || $_, @INC;
156 foreach my $dir (@{$self->{DIR}}){
157 my($abs) = $self->catdir($pwd,$dir);
158 $self->eval_in_x($abs);
167 Carp::carp("Couldn't change to directory $dir: $!");
171 open(FH,"Makefile.PL") or
172 Carp::carp("Couldn't open Makefile.PL in $dir");
174 my $eval = join "", <FH>;
176 # eval, not do, since we need lexical variables
181 # if ($@ =~ /prerequisites/) {
182 # die "MakeMaker WARNING: $@";
184 # warn "WARNING from evaluation of $dir/Makefile.PL: $@";
186 warn "WARNING from evaluation of $dir/Makefile.PL: $@";
193 # package name for the classes into which the first object will be blessed
194 $PACKNAME = "PACK000";
196 my @attrib_help = qw/
198 AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION
199 C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
200 EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE FULLPERL FUNCLIST H
201 HTMLLIBPODS HTMLSCRIPTPODS IMPORTS
202 INC INCLUDE_EXT INSTALLARCHLIB INSTALLBIN INSTALLDIRS INSTALLHTMLPRIVLIBDIR
203 INSTALLHTMLSCRIPTDIR INSTALLHTMLSITELIBDIR INSTALLMAN1DIR
204 INSTALLMAN3DIR INSTALLPRIVLIB INSTALLSCRIPT INSTALLSITEARCH
205 INSTALLSITELIB INST_ARCHLIB INST_BIN INST_EXE INST_LIB
206 INST_HTMLLIBDIR INST_HTMLSCRIPTDIR
207 INST_MAN1DIR INST_MAN3DIR INST_SCRIPT LDFROM LIB LIBPERL_A LIBS
208 LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB
210 NAME NEEDS_LINKING NOECHO NORECURS NO_VC OBJECT OPTIMIZE PERL PERLMAINCC
211 PERLRUN PERLRUNINST PERL_ARCHLIB PERL_CORE
212 PERL_LIB PERL_SRC PERM_RW PERM_RWX
213 PL_FILES PM PM_FILTER PMLIBDIRS POLLUTE PPM_INSTALL_EXEC
214 PPM_INSTALL_SCRIPT PREFIX
215 PREREQ_FATAL PREREQ_PM PREREQ_PRINT PRINT_PREREQ
216 SKIP TEST_LIBS TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
217 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
219 MACPERL_SRC MACPERL_LIB MACLIBS_68K MACLIBS_PPC MACLIBS_SC MACLIBS_MRC
220 MACLIBS_ALL_68K MACLIBS_ALL_PPC MACLIBS_SHARED
223 # IMPORTS is used under OS/2 and Win32
225 # @Overridable is close to @MM_Sections but not identical. The
226 # order is important. Many subroutines declare macros. These
227 # depend on each other. Let's try to collect the macros up front,
228 # then pasthru, then the rules.
230 # MM_Sections are the sections we have to call explicitly
231 # in Overridable we have subroutines that are used indirectly
237 post_initialize const_config constants tool_autosplit tool_xsubpp
238 tools_other dist macro depend cflags const_loadlibs const_cccmd
243 c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs
244 dynamic_lib static static_lib htmlifypods manifypods processPL
246 clean realclean dist_basics dist_core dist_dir dist_test dist_ci
247 install force perldepend makefile staticmake test ppd
249 ); # loses section ordering
251 @Overridable = @MM_Sections;
252 push @Overridable, qw[
254 dir_target libscan makeaperl needs_linking perm_rw perm_rwx
255 subdir_x test_via_harness test_via_script
258 push @MM_Sections, qw[
260 pm_to_blib selfdocument
264 # Postamble needs to be the last that was always the case
265 push @MM_Sections, "postamble";
266 push @Overridable, "postamble";
268 # All sections are valid keys.
269 @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
271 # we will use all these variables in the Makefile
274 ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc
275 lib_ext obj_ext osname osvers ranlib sitelibexp sitearchexp so
279 foreach my $item (@attrib_help){
280 $Recognized_Att_Keys{$item} = 1;
282 foreach my $item (@Get_from_Config) {
283 $Recognized_Att_Keys{uc $item} = $Config{$item};
284 print "Attribute '\U$item\E' => '$Config{$item}'\n"
289 # When we eval a Makefile.PL in a subdirectory, that one will ask
290 # us (the parent) for the values and will prepend "..", so that
291 # all files to be installed end up below OUR ./blib
296 INST_BIN 1 INST_EXE 1 INST_LIB 1 INST_ARCHLIB 1 INST_SCRIPT 1
297 MAP_TARGET 1 INST_HTMLLIBDIR 1 INST_HTMLSCRIPTDIR 1
298 INST_MAN1DIR 1 INST_MAN3DIR 1 PERL_SRC 1 PERL 1 FULLPERL 1
303 NEEDS_LINKING HAS_LINK_CODE
305 @Keep_after_flush{@keep} = (1) x @keep;
311 The extension you are trying to build apparently is rather old and
312 most probably outdated. We detect that from the fact, that a
313 subroutine "writeMakefile" is called, and this subroutine is not
314 supported anymore since about October 1994.
316 Please contact the author or look into CPAN (details about CPAN can be
317 found in the FAQ and at http:/www.perl.com) for a more recent version
318 of the extension. If you're really desperate, you can try to change
319 the subroutine name from writeMakefile to WriteMakefile and rerun
320 'perl Makefile.PL', but you're most probably left alone, when you do
328 sub ExtUtils::MakeMaker::new {
329 my($class,$self) = @_;
332 if ("@ARGV" =~ /\bPREREQ_PRINT\b/) {
333 require Data::Dumper;
334 print Data::Dumper->Dump([$self->{PREREQ_PM}], [qw(PREREQ_PM)]);
337 # PRINT_PREREQ is RedHatism.
338 if ("@ARGV" =~ /\bPRINT_PREREQ\b/) {
339 print join(" ", map { "perl($_)>=$self->{PREREQ_PM}->{$_} " } sort keys %{$self->{PREREQ_PM}}), "\n";
343 print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
344 if (-f "MANIFEST" && ! -f "Makefile"){
348 $self = {} unless (defined $self);
352 my %configure_att; # record &{$self->{CONFIGURE}} attributes
353 my(%initial_att) = %$self; # record initial attributes
355 my(%unsatisfied) = ();
356 foreach my $prereq (sort keys %{$self->{PREREQ_PM}}) {
357 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 my $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 my $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}};
541 foreach my $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;
592 $ExtUtils::Manifest::Quiet = $ExtUtils::Manifest::Quiet = 1;
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 my $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
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:
693 print STDOUT "Processing hints file hints/$hint.pl\n";
694 eval { do "hints/$hint.pl" };
695 print STDOUT $@ if $@;
701 my($symtab) = \%{"${from}::"};
703 # Here you see the *current* list of methods that are overridable
704 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
705 # still trying to reduce the list to some reasonable minimum --
706 # because I want to make it easier for the user. A.K.
708 foreach my $method (@Overridable) {
710 # We cannot say "next" here. Nick might call MY->makeaperl
711 # which isn't defined right now
713 # Above statement was written at 4.23 time when Tk-b8 was
714 # around. As Tk-b9 only builds with 5.002something and MM 5 is
715 # standard, we try to enable the next line again. It was
716 # commented out until MM 5.23
718 next unless defined &{"${from}::$method"};
720 *{"${to}::$method"} = \&{"${from}::$method"};
722 # delete would do, if we were sure, nobody ever called
723 # MY->makeaperl directly
725 # delete $symtab->{$method};
727 # If we delete a method, then it will be undefined and cannot
728 # be called. But as long as we have Makefile.PLs that rely on
729 # %MY:: being intact, we have to fill the hole with an
732 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
735 # We have to clean out %INC also, because the current directory is
736 # changed frequently and Graham Barr prefers to get his version
737 # out of a History.pl file which is "required" so woudn't get
738 # loaded again in another extension requiring a History.pl
740 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
741 # to core dump in the middle of a require statement. The required
742 # file was Tk/MMutil.pm. The consequence is, we have to be
743 # extremely careful when we try to give perl a reason to reload a
744 # library with same name. The workaround prefers to drop nothing
745 # from %INC and teach the writers not to use such libraries.
748 # foreach $inc (keys %INC) {
749 # #warn "***$inc*** deleted";
757 if ($section eq 'dynamic') {
758 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
759 "in skipped section 'dynamic_bs'\n"
760 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
761 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
762 "in skipped section 'dynamic_lib'\n"
763 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
765 if ($section eq 'dynamic_lib') {
766 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
767 "targets in skipped section 'dynamic_bs'\n"
768 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
770 if ($section eq 'static') {
771 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
772 "in skipped section 'static_lib'\n"
773 if $self->{SKIPHASH}{static_lib} && $Verbose;
775 return 'skipped' if $self->{SKIPHASH}{$section};
783 # my $fh = new FileHandle;
785 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
787 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
788 # $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
789 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
791 for $chunk (@{$self->{RESULT}}) {
792 # print $fh "$chunk\n";
798 my($finalname) = $self->{MAKEFILE};
799 rename("MakeMaker.tmp", $finalname);
800 chmod 0644, $finalname unless $Is_VMS;
802 if ($self->{PARENT}) {
803 foreach (keys %$self) { # safe memory
804 delete $self->{$_} unless $Keep_after_flush{$_};
808 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
811 # The following mkbootstrap() is only for installations that are calling
812 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
813 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
816 !!! Your Makefile has been built such a long time ago, !!!
817 !!! that is unlikely to work with current MakeMaker. !!!
818 !!! Please rebuild your Makefile !!!
822 # Ditto for mksymlists() as of MakeMaker 5.17
825 !!! Your Makefile has been built such a long time ago, !!!
826 !!! that is unlikely to work with current MakeMaker. !!!
827 !!! Please rebuild your Makefile !!!
833 return "undef" unless defined $v;
835 return "q[$v]" unless $t;
839 foreach my $elem (@$v) {
840 push @neat, "q[$elem]";
842 push @m, join ", ", @neat;
846 return "$v" unless $t eq 'HASH';
848 while (($key,$val) = each %$v){
849 last unless defined $key; # cautious programming in case (undef,undef) is true
850 push(@m,"$key=>".neatvalue($val)) ;
852 return "{ ".join(', ',@m)." }";
859 push @m, "\n# Full list of MakeMaker attribute values:";
860 foreach my $key (sort keys %$self){
861 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
862 my($v) = neatvalue($self->{$key});
863 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
865 push @m, "# $key => $v";
871 package ExtUtils::MakeMaker;
878 ExtUtils::MakeMaker - create an extension Makefile
882 C<use ExtUtils::MakeMaker;>
884 C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
888 C<MM-E<gt>new(\%att)-E<gt>flush;>
892 This utility is designed to write a Makefile for an extension module
893 from a Makefile.PL. It is based on the Makefile.SH model provided by
894 Andy Dougherty and the perl5-porters.
896 It splits the task of generating the Makefile into several subroutines
897 that can be individually overridden. Each subroutine returns the text
898 it wishes to have written to the Makefile.
900 MakeMaker is object oriented. Each directory below the current
901 directory that contains a Makefile.PL. Is treated as a separate
902 object. This makes it possible to write an unlimited number of
903 Makefiles with a single invocation of WriteMakefile().
905 =head2 How To Write A Makefile.PL
907 The short answer is: Don't.
909 Always begin with h2xs.
910 Always begin with h2xs!
911 ALWAYS BEGIN WITH H2XS!
913 even if you're not building around a header file, and even if you
914 don't have an XS component.
916 Run h2xs(1) before you start thinking about writing a module. For so
917 called pm-only modules that consist of C<*.pm> files only, h2xs has
918 the C<-X> switch. This will generate dummy files of all kinds that are
919 useful for the module developer.
921 The medium answer is:
923 use ExtUtils::MakeMaker;
924 WriteMakefile( NAME => "Foo::Bar" );
926 The long answer is the rest of the manpage :-)
928 =head2 Default Makefile Behaviour
930 The generated Makefile enables the user of the extension to invoke
932 perl Makefile.PL # optionally "perl Makefile.PL verbose"
934 make test # optionally set TEST_VERBOSE=1
935 make install # See below
937 The Makefile to be produced may be altered by adding arguments of the
938 form C<KEY=VALUE>. E.g.
940 perl Makefile.PL PREFIX=/tmp/myperl5
942 Other interesting targets in the generated Makefile are
944 make config # to check if the Makefile is up-to-date
945 make clean # delete local temp files (Makefile gets renamed)
946 make realclean # delete derived files (including ./blib)
947 make ci # check in all the files in the MANIFEST file
948 make dist # see below the Distribution Support section
952 MakeMaker checks for the existence of a file named F<test.pl> in the
953 current directory and if it exists it adds commands to the test target
954 of the generated Makefile that will execute the script with the proper
955 set of perl C<-I> options.
957 MakeMaker also checks for any files matching glob("t/*.t"). It will
958 add commands to the test target of the generated Makefile that execute
959 all matching files via the L<Test::Harness> module with the C<-I>
960 switches set correctly.
964 A useful variation of the above is the target C<testdb>. It runs the
965 test under the Perl debugger (see L<perldebug>). If the file
966 F<test.pl> exists in the current directory, it is used for the test.
968 If you want to debug some other testfile, set C<TEST_FILE> variable
971 make testdb TEST_FILE=t/mytest.t
973 By default the debugger is called using C<-d> option to perl. If you
974 want to specify some other option, set C<TESTDB_SW> variable:
976 make testdb TESTDB_SW=-Dx
980 make alone puts all relevant files into directories that are named by
981 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_HTMLLIBDIR,
982 INST_HTMLSCRIPTDIR, INST_MAN1DIR, and INST_MAN3DIR. All these default
983 to something below ./blib if you are I<not> building below the perl
984 source directory. If you I<are> building below the perl source,
985 INST_LIB and INST_ARCHLIB default to ../../lib, and INST_SCRIPT is not
988 The I<install> target of the generated Makefile copies the files found
989 below each of the INST_* directories to their INSTALL*
990 counterparts. Which counterparts are chosen depends on the setting of
991 INSTALLDIRS according to the following table:
996 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH
997 INST_LIB INSTALLPRIVLIB INSTALLSITELIB
998 INST_HTMLLIBDIR INSTALLHTMLPRIVLIBDIR INSTALLHTMLSITELIBDIR
999 INST_HTMLSCRIPTDIR INSTALLHTMLSCRIPTDIR
1001 INST_SCRIPT INSTALLSCRIPT
1002 INST_MAN1DIR INSTALLMAN1DIR
1003 INST_MAN3DIR INSTALLMAN3DIR
1005 The INSTALL... macros in turn default to their %Config
1006 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
1008 You can check the values of these variables on your system with
1012 And to check the sequence in which the library directories are
1013 searched by perl, run
1015 perl -le 'print join $/, @INC'
1018 =head2 PREFIX and LIB attribute
1020 PREFIX and LIB can be used to set several INSTALL* attributes in one
1021 go. The quickest way to install a module in a non-standard place might
1024 perl Makefile.PL LIB=~/lib
1026 This will install the module's architecture-independent files into
1027 ~/lib, the architecture-dependent files into ~/lib/$archname.
1029 Another way to specify many INSTALL directories with a single
1030 parameter is PREFIX.
1032 perl Makefile.PL PREFIX=~
1034 This will replace the string specified by C<$Config{prefix}> in all
1035 C<$Config{install*}> values.
1037 Note, that in both cases the tilde expansion is done by MakeMaker, not
1038 by perl by default, nor by make.
1040 Conflicts between parameters LIB,
1041 PREFIX and the various INSTALL* arguments are resolved so that:
1047 setting LIB overrides any setting of INSTALLPRIVLIB, INSTALLARCHLIB,
1048 INSTALLSITELIB, INSTALLSITEARCH (and they are not affected by PREFIX);
1052 without LIB, setting PREFIX replaces the initial C<$Config{prefix}>
1053 part of those INSTALL* arguments, even if the latter are explicitly
1054 set (but are set to still start with C<$Config{prefix}>).
1058 If the user has superuser privileges, and is not working on AFS
1059 or relatives, then the defaults for
1060 INSTALLPRIVLIB, INSTALLARCHLIB, INSTALLSCRIPT, etc. will be appropriate,
1061 and this incantation will be the best:
1063 perl Makefile.PL; make; make test
1066 make install per default writes some documentation of what has been
1067 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1068 can be bypassed by calling make pure_install.
1072 will have to specify the installation directories as these most
1073 probably have changed since perl itself has been installed. They will
1074 have to do this by calling
1076 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1077 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1080 Be careful to repeat this procedure every time you recompile an
1081 extension, unless you are sure the AFS installation directories are
1084 =head2 Static Linking of a new Perl Binary
1086 An extension that is built with the above steps is ready to use on
1087 systems supporting dynamic loading. On systems that do not support
1088 dynamic loading, any newly created extension has to be linked together
1089 with the available resources. MakeMaker supports the linking process
1090 by creating appropriate targets in the Makefile whenever an extension
1091 is built. You can invoke the corresponding section of the makefile with
1095 That produces a new perl binary in the current directory with all
1096 extensions linked in that can be found in INST_ARCHLIB, SITELIBEXP,
1097 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1098 UNIX, this is called Makefile.aperl (may be system dependent). If you
1099 want to force the creation of a new perl, it is recommended, that you
1100 delete this Makefile.aperl, so the directories are searched-through
1101 for linkable libraries again.
1103 The binary can be installed into the directory where perl normally
1104 resides on your machine with
1108 To produce a perl binary with a different name than C<perl>, either say
1110 perl Makefile.PL MAP_TARGET=myperl
1117 make myperl MAP_TARGET=myperl
1118 make inst_perl MAP_TARGET=myperl
1120 In any case you will be prompted with the correct invocation of the
1121 C<inst_perl> target that installs the new binary into INSTALLBIN.
1123 make inst_perl per default writes some documentation of what has been
1124 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1125 can be bypassed by calling make pure_inst_perl.
1127 Warning: the inst_perl: target will most probably overwrite your
1128 existing perl binary. Use with care!
1130 Sometimes you might want to build a statically linked perl although
1131 your system supports dynamic loading. In this case you may explicitly
1132 set the linktype with the invocation of the Makefile.PL or make:
1134 perl Makefile.PL LINKTYPE=static # recommended
1138 make LINKTYPE=static # works on most systems
1140 =head2 Determination of Perl Library and Installation Locations
1142 MakeMaker needs to know, or to guess, where certain things are
1143 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1144 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1145 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1147 Extensions may be built either using the contents of the perl source
1148 directory tree or from the installed perl library. The recommended way
1149 is to build extensions after you have run 'make install' on perl
1150 itself. You can do that in any directory on your hard disk that is not
1151 below the perl source tree. The support for extensions below the ext
1152 directory of the perl distribution is only good for the standard
1153 extensions that come with perl.
1155 If an extension is being built below the C<ext/> directory of the perl
1156 source then MakeMaker will set PERL_SRC automatically (e.g.,
1157 C<../..>). If PERL_SRC is defined and the extension is recognized as
1158 a standard extension, then other variables default to the following:
1161 PERL_LIB = PERL_SRC/lib
1162 PERL_ARCHLIB = PERL_SRC/lib
1164 INST_ARCHLIB = PERL_ARCHLIB
1166 If an extension is being built away from the perl source then MakeMaker
1167 will leave PERL_SRC undefined and default to using the installed copy
1168 of the perl library. The other variables default to the following:
1170 PERL_INC = $archlibexp/CORE
1171 PERL_LIB = $privlibexp
1172 PERL_ARCHLIB = $archlibexp
1173 INST_LIB = ./blib/lib
1174 INST_ARCHLIB = ./blib/arch
1176 If perl has not yet been installed then PERL_SRC can be defined on the
1177 command line as shown in the previous section.
1180 =head2 Which architecture dependent directory?
1182 If you don't want to keep the defaults for the INSTALL* macros,
1183 MakeMaker helps you to minimize the typing needed: the usual
1184 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1185 by Configure at perl compilation time. MakeMaker supports the user who
1186 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1187 then MakeMaker defaults the latter to be the same subdirectory of
1188 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1189 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1190 for INSTALLSITELIB and INSTALLSITEARCH.
1192 MakeMaker gives you much more freedom than needed to configure
1193 internal variables and get different results. It is worth to mention,
1194 that make(1) also lets you configure most of the variables that are
1195 used in the Makefile. But in the majority of situations this will not
1196 be necessary, and should only be done if the author of a package
1197 recommends it (or you know what you're doing).
1199 =head2 Using Attributes and Parameters
1201 The following attributes can be specified as arguments to WriteMakefile()
1202 or as NAME=VALUE pairs on the command line:
1208 One line description of the module. Will be included in PPD file.
1212 Name of the file that contains the package description. MakeMaker looks
1213 for a line in the POD matching /^($package\s-\s)(.*)/. This is typically
1214 the first line in the "=head1 NAME" section. $2 becomes the abstract.
1218 String containing name (and email address) of package author(s). Is used
1219 in PPD (Perl Package Description) files for PPM (Perl Package Manager).
1221 =item BINARY_LOCATION
1223 Used when creating PPD files for binary packages. It can be set to a
1224 full or relative path or URL to the binary archive for a particular
1225 architecture. For example:
1227 perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
1229 builds a PPD package that references a binary of the C<Agent> package,
1230 located in the C<x86> directory relative to the PPD itself.
1234 Ref to array of *.c file names. Initialised from a directory scan
1235 and the values portion of the XS attribute hash. This is not
1236 currently used by MakeMaker but may be handy in Makefile.PLs.
1240 String that will be included in the compiler call command line between
1241 the arguments INC and OPTIMIZE.
1245 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1246 config.sh. MakeMaker will add to CONFIG the following values anyway:
1266 CODE reference. The subroutine should return a hash reference. The
1267 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1268 be determined by some evaluation method.
1272 Something like C<"-DHAVE_UNISTD_H">
1276 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1281 Your name for distributing the package (by tar file). This defaults to
1286 Hashref of symbol names for routines to be made available as universal
1287 symbols. Each key/value pair consists of the package name and an
1288 array of routine names in that package. Used only under AIX, OS/2,
1289 VMS and Win32 at present. The routine names supplied will be expanded
1290 in the same way as XSUB names are expanded by the XS() macro.
1293 {"$(NAME)" => ["boot_$(NAME)" ] }
1297 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1298 "NetconfigPtr" => [ 'DESTROY'] }
1300 Please see the L<ExtUtils::Mksymlists> documentation for more information
1301 about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
1305 Array of symbol names for variables to be made available as universal symbols.
1306 Used only under AIX, OS/2, VMS and Win32 at present. Defaults to [].
1307 (e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
1311 Array of extension names to exclude when doing a static build. This
1312 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1313 details. (e.g. [ qw( Socket POSIX ) ] )
1315 This attribute may be most useful when specified as a string on the
1316 command line: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1320 Ref to array of executable files. The files will be copied to the
1321 INST_SCRIPT directory. Make realclean will delete them from there
1324 =item FIRST_MAKEFILE
1326 The name of the Makefile to be produced. Defaults to the contents of
1327 MAKEFILE, but can be overridden. This is used for the second Makefile
1328 that will be produced for the MAP_TARGET.
1332 Perl binary able to run this extension.
1336 This provides an alternate means to specify function names to be
1337 exported from the extension. Its value is a reference to an
1338 array of function names to be exported by the extension. These
1339 names are passed through unaltered to the linker options file.
1343 Ref to array of *.h file names. Similar to C.
1347 Hashref of .pm and .pod files. MakeMaker will default this to all
1348 .pod and any .pm files that include POD directives. The files listed
1349 here will be converted to HTML format and installed as was requested
1352 =item HTMLSCRIPTPODS
1354 Hashref of pod-containing files. MakeMaker will default this to all
1355 EXE_FILES files that include POD directives. The files listed
1356 here will be converted to HTML format and installed as was requested
1361 This attribute is used to specify names to be imported into the
1362 extension. It is only used on OS/2 and Win32.
1366 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1370 Array of extension names to be included when doing a static build.
1371 MakeMaker will normally build with all of the installed extensions when
1372 doing a static build, and that is usually the desired behavior. If
1373 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1374 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1376 It is not necessary to mention DynaLoader or the current extension when
1377 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1378 only DynaLoader and the current extension will be included in the build.
1380 This attribute may be most useful when specified as a string on the
1381 command line: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1383 =item INSTALLARCHLIB
1385 Used by 'make install', which copies files from INST_ARCHLIB to this
1386 directory if INSTALLDIRS is set to perl.
1390 Directory to install binary files (e.g. tkperl) into.
1394 Determines which of the two sets of installation directories to
1395 choose: installprivlib and installarchlib versus installsitelib and
1396 installsitearch. The first pair is chosen with INSTALLDIRS=perl, the
1397 second with INSTALLDIRS=site. Default is site.
1399 =item INSTALLHTMLPRIVLIBDIR
1401 This directory gets the HTML pages at 'make install' time. Defaults to
1402 $Config{installhtmlprivlibdir}.
1404 =item INSTALLHTMLSCRIPTDIR
1406 This directory gets the HTML pages at 'make install' time. Defaults to
1407 $Config{installhtmlscriptdir}.
1409 =item INSTALLHTMLSITELIBDIR
1411 This directory gets the HTML pages at 'make install' time. Defaults to
1412 $Config{installhtmlsitelibdir}.
1415 =item INSTALLMAN1DIR
1417 This directory gets the man pages at 'make install' time. Defaults to
1418 $Config{installman1dir}.
1420 =item INSTALLMAN3DIR
1422 This directory gets the man pages at 'make install' time. Defaults to
1423 $Config{installman3dir}.
1425 =item INSTALLPRIVLIB
1427 Used by 'make install', which copies files from INST_LIB to this
1428 directory if INSTALLDIRS is set to perl.
1432 Used by 'make install' which copies files from INST_SCRIPT to this
1435 =item INSTALLSITEARCH
1437 Used by 'make install', which copies files from INST_ARCHLIB to this
1438 directory if INSTALLDIRS is set to site (default).
1440 =item INSTALLSITELIB
1442 Used by 'make install', which copies files from INST_LIB to this
1443 directory if INSTALLDIRS is set to site (default).
1447 Same as INST_LIB for architecture dependent files.
1451 Directory to put real binary files during 'make'. These will be copied
1452 to INSTALLBIN during 'make install'
1456 Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you
1459 =item INST_HTMLLIBDIR
1461 Directory to hold the man pages in HTML format at 'make' time
1463 =item INST_HTMLSCRIPTDIR
1465 Directory to hold the man pages in HTML format at 'make' time
1469 Directory where we put library files of this extension while building
1474 Directory to hold the man pages at 'make' time
1478 Directory to hold the man pages at 'make' time
1482 Directory, where executable files should be installed during
1483 'make'. Defaults to "./blib/script", just to have a dummy location during
1484 testing. make install will copy the files in INST_SCRIPT to
1489 defaults to "$(OBJECT)" and is used in the ld command to specify
1490 what files to link/load from (also see dynamic_lib below for how to
1495 LIB should only be set at C<perl Makefile.PL> time but is allowed as a
1496 MakeMaker argument. It has the effect of
1497 setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any
1498 explicit setting of those arguments (or of PREFIX).
1499 INSTALLARCHLIB and INSTALLSITEARCH are set to the corresponding
1500 architecture subdirectory.
1504 The filename of the perllibrary that will be used together with this
1505 extension. Defaults to libperl.a.
1509 An anonymous array of alternative library
1510 specifications to be searched for (in order) until
1511 at least one library is found. E.g.
1513 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1515 Mind, that any element of the array
1516 contains a complete set of arguments for the ld
1517 command. So do not specify
1519 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1521 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1522 you specify a scalar as in
1524 'LIBS' => "-ltcl -ltk -lX11"
1526 MakeMaker will turn it into an array with one element.
1530 'static' or 'dynamic' (default unless usedl=undef in
1531 config.sh). Should only be used to force static linking (also see
1536 Boolean which tells MakeMaker, that it should include the rules to
1537 make a perl. This is handled automatically as a switch by
1538 MakeMaker. The user normally does not need it.
1542 The name of the Makefile to be produced.
1546 Hashref of pod-containing files. MakeMaker will default this to all
1547 EXE_FILES files that include POD directives. The files listed
1548 here will be converted to man pages and installed as was requested
1553 Hashref that assigns to *.pm and *.pod files the files into which the
1554 manpages are to be written. MakeMaker parses all *.pod and *.pm files
1555 for POD directives. Files that contain POD will be the default keys of
1556 the MAN3PODS hashref. These will then be converted to man pages during
1557 C<make> and will be installed during C<make install>.
1561 If it is intended, that a new perl binary be produced, this variable
1562 may hold a name for that binary. Defaults to perl
1566 If the extension links to a library that it builds set this to the
1567 name of the library (see SDBM_File)
1571 Perl module name for this extension (DBD::Oracle). This will default
1572 to the directory name but should be explicitly defined in the
1577 MakeMaker will figure out if an extension contains linkable code
1578 anywhere down the directory tree, and will set this variable
1579 accordingly, but you can speed it up a very little bit if you define
1580 this boolean variable yourself.
1584 Defaults to C<@>. By setting it to an empty string you can generate a
1585 Makefile that echos all commands. Mainly used in debugging MakeMaker
1590 Boolean. Attribute to inhibit descending into subdirectories.
1594 In general, any generated Makefile checks for the current version of
1595 MakeMaker and the version the Makefile was built under. If NO_VC is
1596 set, the version check is neglected. Do not write this into your
1597 Makefile.PL, use it interactively instead.
1601 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1602 string containing all object files, e.g. "tkpBind.o
1603 tkpButton.o tkpCanvas.o"
1605 (Where BASEEXT is the last component of NAME, and OBJ_EXT is $Config{obj_ext}.)
1609 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1610 passed to subdirectory makes.
1614 Perl binary for tasks that can be done by miniperl
1618 Set only when MakeMaker is building the extensions of the Perl core
1623 The call to the program that is able to compile perlmain.c. Defaults
1628 Same as for PERL_LIB, but for architecture dependent files.
1630 Used only when MakeMaker is building the extensions of the Perl core
1631 distribution (because normally $(PERL_ARCHLIB) is automatically in @INC,
1632 and adding it would get in the way of PERL5LIB).
1636 Directory containing the Perl library to use.
1638 Used only when MakeMaker is building the extensions of the Perl core
1639 distribution (because normally $(PERL_LIB) is automatically in @INC,
1640 and adding it would get in the way of PERL5LIB).
1642 =item PERL_MALLOC_OK
1644 defaults to 0. Should be set to TRUE if the extension can work with
1645 the memory allocation routines substituted by the Perl malloc() subsystem.
1646 This should be applicable to most extensions with exceptions of those
1652 with bugs in memory allocations which are caught by Perl's malloc();
1656 which interact with the memory allocator in other ways than via
1657 malloc(), realloc(), free(), calloc(), sbrk() and brk();
1661 which rely on special alignment which is not provided by Perl's malloc().
1665 B<NOTE.> Negligence to set this flag in I<any one> of loaded extension
1666 nullifies many advantages of Perl's malloc(), such as better usage of
1667 system resources, error detection, memory usage reporting, catchable failure
1668 of memory allocations, etc.
1672 Use this instead of $(PERL) or $(FULLPERL) when you wish to run perl.
1673 It will set up extra necessary flags for you.
1677 Use this instead of $(PERL) or $(FULLPERL) when you wish to run
1678 perl to work with modules. It will add things like -I$(INST_ARCH)
1679 and other necessary flags.
1683 Directory containing the Perl source code (use of this should be
1684 avoided, it may be undefined)
1688 Desired permission for read/writable files. Defaults to C<644>.
1689 See also L<MM_Unix/perm_rw>.
1693 Desired permission for executable files. Defaults to C<755>.
1694 See also L<MM_Unix/perm_rwx>.
1698 Ref to hash of files to be processed as perl programs. MakeMaker
1699 will default to any found *.PL file (except Makefile.PL) being keys
1700 and the basename of the file being the value. E.g.
1702 {'foobar.PL' => 'foobar'}
1704 The *.PL files are expected to produce output to the target files
1705 themselves. If multiple files can be generated from the same *.PL
1706 file then the value in the hash can be a reference to an array of
1707 target file names. E.g.
1709 {'foobar.PL' => ['foobar1','foobar2']}
1713 Hashref of .pm files and *.pl files to be installed. e.g.
1715 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1717 By default this will include *.pm and *.pl and the files found in
1718 the PMLIBDIRS directories. Defining PM in the
1719 Makefile.PL will override PMLIBDIRS.
1723 Ref to array of subdirectories containing library files. Defaults to
1724 [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
1725 they contain will be installed in the corresponding location in the
1726 library. A libscan() method can be used to alter the behaviour.
1727 Defining PM in the Makefile.PL will override PMLIBDIRS.
1729 (Where BASEEXT is the last component of NAME.)
1733 A filter program, in the traditional Unix sense (input from stdin, output
1734 to stdout) that is passed on each .pm file during the build (in the
1735 pm_to_blib() phase). It is empty by default, meaning no filtering is done.
1737 Great care is necessary when defining the command if quoting needs to be
1738 done. For instance, you would need to say:
1740 {'PM_FILTER' => 'grep -v \\"^\\#\\"'}
1742 to remove all the leading coments on the fly during the build. The
1743 extra \\ are necessary, unfortunately, because this variable is interpolated
1744 within the context of a Perl program built on the command line, and double
1745 quotes are what is used with the -e switch to build that command line. The
1746 # is escaped for the Makefile, since what is going to be generated will then
1749 PM_FILTER = grep -v \"^\#\"
1751 Without the \\ before the #, we'd have the start of a Makefile comment,
1752 and the macro would be incorrectly defined.
1756 Release 5.005 grandfathered old global symbol names by providing preprocessor
1757 macros for extension source compatibility. As of release 5.6, these
1758 preprocessor definitions are not available by default. The POLLUTE flag
1759 specifies that the old names should still be defined:
1761 perl Makefile.PL POLLUTE=1
1763 Please inform the module author if this is necessary to successfully install
1764 a module under 5.6 or later.
1766 =item PPM_INSTALL_EXEC
1768 Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl)
1770 =item PPM_INSTALL_SCRIPT
1772 Name of the script that gets executed by the Perl Package Manager after
1773 the installation of a package.
1777 Can be used to set the three INSTALL* attributes in one go (except for
1778 probably INSTALLMAN1DIR, if it is not below PREFIX according to
1779 %Config). They will have PREFIX as a common directory node and will
1780 branch from that node into lib/, lib/ARCHNAME or whatever Configure
1781 decided at the build time of your perl (unless you override one of
1786 Hashref: Names of modules that need to be available to run this
1787 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1788 desired version is the value. If the required version number is 0, we
1789 only check if any version is installed already.
1793 Bool. If this parameter is true, failing to have the required modules
1794 (or the right versions thereof) will be fatal. perl Makefile.PL will die
1795 with the proper message.
1797 Note: see L<Test::Harness> for a shortcut for stopping tests early if
1798 you are missing dependencies.
1800 Do I<not> use this parameter for simple requirements, which could be resolved
1801 at a later time, e.g. after an unsuccessful B<make test> of your module.
1803 It is I<extremely> rare to have to use C<PREREQ_FATAL> at all!
1807 Bool. If this parameter is true, the prerequisites will be printed to
1808 stdout and MakeMaker will exit. The output format is
1818 RedHatism for C<PREREQ_PRINT>. The output format is different, though:
1820 perl(A::B)>=Vers1 perl(C::D)>=Vers2 ...
1824 Arrayref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1825 Makefile. Caution! Do not use the SKIP attribute for the negligible
1826 speedup. It may seriously damage the resulting Makefile. Only use it
1827 if you really need it.
1831 The set of -I's necessary to run a "make test". Use as:
1832 $(PERL) $(TEST_LIBS) -e '...' for example.
1836 Ref to array of typemap file names. Use this when the typemaps are
1837 in some directory other than the current directory or when they are
1838 not named B<typemap>. The last typemap in the list takes
1839 precedence. A typemap in the current directory has highest
1840 precedence, even if it isn't listed in TYPEMAPS. The default system
1841 typemap has lowest precedence.
1845 Your version number for distributing the package. This defaults to
1850 Instead of specifying the VERSION in the Makefile.PL you can let
1851 MakeMaker parse a file to determine the version number. The parsing
1852 routine requires that the file named by VERSION_FROM contains one
1853 single line to compute the version number. The first line in the file
1854 that contains the regular expression
1856 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
1858 will be evaluated with eval() and the value of the named variable
1859 B<after> the eval() will be assigned to the VERSION attribute of the
1860 MakeMaker object. The following lines will be parsed o.k.:
1864 ( $VERSION ) = '$Revision: 1.222 $ ' =~ /\$Revision:\s+([^\s]+)/;
1865 $FOO::VERSION = '1.10';
1866 *FOO::VERSION = \'1.11';
1867 our $VERSION = 1.2.3; # new for perl5.6.0
1869 but these will fail:
1871 my $VERSION = '1.01';
1872 local $VERSION = '1.02';
1873 local $FOO::VERSION = '1.30';
1875 (Putting C<my> or C<local> on the preceding line will work o.k.)
1877 The file named in VERSION_FROM is not added as a dependency to
1878 Makefile. This is not really correct, but it would be a major pain
1879 during development to have to rewrite the Makefile for any smallish
1880 change in that file. If you want to make sure that the Makefile
1881 contains the correct VERSION macro after any change of the file, you
1882 would have to do something like
1884 depend => { Makefile => '$(VERSION_FROM)' }
1886 See attribute C<depend> below.
1890 Hashref of .xs files. MakeMaker will default this. e.g.
1892 {'name_of_file.xs' => 'name_of_file.c'}
1894 The .c files will automatically be included in the list of files
1895 deleted by a make clean.
1899 String of options to pass to xsubpp. This might include C<-C++> or
1900 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
1905 May be set to an empty string, which is identical to C<-prototypes>, or
1906 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
1907 defaults to the empty string.
1911 Your version number for the .xs file of this package. This defaults
1912 to the value of the VERSION attribute.
1916 =head2 Additional lowercase attributes
1918 can be used to pass parameters to the methods which implement that
1919 part of the Makefile.
1925 {FILES => "*.xyz foo"}
1929 {ANY_TARGET => ANY_DEPENDECY, ...}
1931 (ANY_TARGET must not be given a double-colon rule by MakeMaker.)
1935 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
1936 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
1937 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
1939 If you specify COMPRESS, then SUFFIX should also be altered, as it is
1940 needed to tell make the target file of the compression. Setting
1941 DIST_CP to ln can be useful, if you need to preserve the timestamps on
1942 your files. DIST_CP can take the values 'cp', which copies the file,
1943 'ln', which links the file, and 'best' which copies symbolic links and
1944 links the rest. Default is 'best'.
1948 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
1952 {LINKTYPE => 'static', 'dynamic' or ''}
1954 NB: Extensions that have nothing but *.pm files had to say
1958 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1959 can be deleted safely. MakeMaker recognizes when there's nothing to
1964 {ANY_MACRO => ANY_VALUE, ...}
1968 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
1974 =item tool_autosplit
1980 =head2 Overriding MakeMaker Methods
1982 If you cannot achieve the desired Makefile behaviour by specifying
1983 attributes you may define private subroutines in the Makefile.PL.
1984 Each subroutines returns the text it wishes to have written to
1985 the Makefile. To override a section of the Makefile you can
1988 sub MY::c_o { "new literal text" }
1990 or you can edit the default by saying something like:
1993 package MY; # so that "SUPER" works right
1994 my $inherited = shift->SUPER::c_o(@_);
1995 $inherited =~ s/old text/new text/;
1999 If you are running experiments with embedding perl as a library into
2000 other applications, you might find MakeMaker is not sufficient. You'd
2001 better have a look at ExtUtils::Embed which is a collection of utilities
2004 If you still need a different solution, try to develop another
2005 subroutine that fits your needs and submit the diffs to
2006 F<perl5-porters@perl.org> or F<comp.lang.perl.moderated> as appropriate.
2008 For a complete description of all MakeMaker methods see L<ExtUtils::MM_Unix>.
2010 Here is a simple example of how to add a new target to the generated
2015 $(MYEXTLIB): sdbm/Makefile
2016 cd sdbm && $(MAKE) all
2021 =head2 Hintsfile support
2023 MakeMaker.pm uses the architecture specific information from
2024 Config.pm. In addition it evaluates architecture specific hints files
2025 in a C<hints/> directory. The hints files are expected to be named
2026 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
2027 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
2028 MakeMaker within the WriteMakefile() subroutine, and can be used to
2029 execute commands as well as to include special variables. The rules
2030 which hintsfile is chosen are the same as in Configure.
2032 The hintsfile is eval()ed immediately after the arguments given to
2033 WriteMakefile are stuffed into a hash reference $self but before this
2034 reference becomes blessed. So if you want to do the equivalent to
2035 override or create an attribute you would say something like
2037 $self->{LIBS} = ['-ldbm -lucb -lc'];
2039 =head2 Distribution Support
2041 For authors of extensions MakeMaker provides several Makefile
2042 targets. Most of the support comes from the ExtUtils::Manifest module,
2043 where additional documentation can be found.
2047 =item make distcheck
2049 reports which files are below the build directory but not in the
2050 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
2053 =item make skipcheck
2055 reports which files are skipped due to the entries in the
2056 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
2059 =item make distclean
2061 does a realclean first and then the distcheck. Note that this is not
2062 needed to build a new distribution as long as you are sure that the
2063 MANIFEST file is ok.
2067 rewrites the MANIFEST file, adding all remaining files found (See
2068 ExtUtils::Manifest::mkmanifest() for details)
2072 Copies all the files that are in the MANIFEST file to a newly created
2073 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
2074 exists, it will be removed first.
2078 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
2079 a make test in that directory.
2083 First does a distdir. Then a command $(PREOP) which defaults to a null
2084 command, followed by $(TOUNIX), which defaults to a null command under
2085 UNIX, and will convert files in distribution directory to UNIX format
2086 otherwise. Next it runs C<tar> on that directory into a tarfile and
2087 deletes the directory. Finishes with a command $(POSTOP) which
2088 defaults to a null command.
2092 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
2094 =item make uutardist
2096 Runs a tardist first and uuencodes the tarfile.
2100 First does a distdir. Then a command $(PREOP) which defaults to a null
2101 command. Next it runs C<shar> on that directory into a sharfile and
2102 deletes the intermediate directory again. Finishes with a command
2103 $(POSTOP) which defaults to a null command. Note: For shdist to work
2104 properly a C<shar> program that can handle directories is mandatory.
2108 First does a distdir. Then a command $(PREOP) which defaults to a null
2109 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
2110 zipfile. Then deletes that directory. Finishes with a command
2111 $(POSTOP) which defaults to a null command.
2115 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
2119 Customization of the dist targets can be done by specifying a hash
2120 reference to the dist attribute of the WriteMakefile call. The
2121 following parameters are recognized:
2124 COMPRESS ('gzip --best')
2127 TO_UNIX (depends on the system)
2128 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
2138 WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" })
2140 =head2 Disabling an extension
2142 If some events detected in F<Makefile.PL> imply that there is no way
2143 to create the Module, but this is a normal state of things, then you
2144 can create a F<Makefile> which does nothing, but succeeds on all the
2145 "usual" build targets. To do so, use
2147 ExtUtils::MakeMaker::WriteEmptyMakefile();
2149 instead of WriteMakefile().
2151 This may be useful if other modules expect this module to be I<built>
2152 OK, as opposed to I<work> OK (say, this system-dependent module builds
2153 in a subdirectory of some other distribution, or is listed as a
2154 dependency in a CPAN::Bundle, but the functionality is supported by
2155 different means on the current architecture).
2163 Command line options used by C<MakeMaker-E<gt>new()>, and thus by
2164 C<WriteMakefile()>. The string is split on whitespace, and the result
2165 is processed before any actual command line arguments are processed.
2167 =item PERL_MM_USE_DEFAULT
2169 If set to a true value then MakeMaker's prompt function will
2170 always return the default without waiting for user input.
2176 ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib,
2177 ExtUtils::Install, ExtUtils::Embed
2181 Andy Dougherty <F<doughera@lafcol.lafayette.edu>>, Andreas KE<ouml>nig
2182 <F<andreas.koenig@mind.de>>, Tim Bunce <F<Tim.Bunce@ig.co.uk>>. VMS
2183 support by Charles Bailey <F<bailey@newman.upenn.edu>>. OS/2 support
2184 by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>.
2186 Contact the MakeMaker mailing list <F<makemaker@perl.org>> if you have
2189 Send patches and bug reports to <F<perlbug@perl.org>>.