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';
75 require ExtUtils::MM_Unix;
78 require ExtUtils::MM_VMS;
79 require VMS::Filespec; # is a noop as long as we require it within MM_VMS
82 require ExtUtils::MM_OS2;
85 require ExtUtils::MM_MacOS;
88 require ExtUtils::MM_Win32;
91 require ExtUtils::MM_Cygwin;
96 # The use of the Version_check target has been dropped between perl
97 # 5.5.63 and 5.5.64. We must keep the subroutine for a while so that
98 # old Makefiles can satisfy the Version_check target.
101 my($checkversion) = @_;
102 die "Your Makefile was built with ExtUtils::MakeMaker v $checkversion.
103 Current Version is $ExtUtils::MakeMaker::VERSION. There have been considerable
104 changes in the meantime.
105 Please rerun 'perl Makefile.PL' to regenerate the Makefile.\n"
106 if $checkversion < $Version_OK;
107 printf STDOUT "%s %s %s %s.\n", "Makefile built with ExtUtils::MakeMaker v",
108 $checkversion, "Current Version is", $VERSION
109 unless $checkversion == $VERSION;
113 $_[0] =~ /^Use of uninitialized value/ && return;
114 $_[0] =~ /used only once/ && return;
115 $_[0] =~ /^Subroutine\s+[\w:]+\s+redefined/ && return;
120 Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
121 local $SIG{__WARN__} = \&warnhandler;
124 MM->new(\%att)->flush;
129 $ISA_TTY = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ; # Pipe?
130 Carp::confess("prompt function called without an argument") unless defined $mess;
131 my $dispdef = defined $def ? "[$def] " : " ";
132 $def = defined $def ? $def : "";
135 print "$mess $dispdef";
137 chomp($ans = <STDIN>);
141 return ($ans ne '') ? $ans : $def;
144 sub eval_in_subdirs {
150 foreach $dir (@{$self->{DIR}}){
151 my($abs) = $self->catdir($pwd,$dir);
152 $self->eval_in_x($abs);
160 chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
162 # my $fh = new FileHandle;
163 # $fh->open("Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
165 open(FH,"Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
166 # my $eval = join "", <$fh>;
167 my $eval = join "", <FH>;
172 # if ($@ =~ /prerequisites/) {
173 # die "MakeMaker WARNING: $@";
175 # warn "WARNING from evaluation of $dir/Makefile.PL: $@";
177 warn "WARNING from evaluation of $dir/Makefile.PL: $@";
184 # package name for the classes into which the first object will be blessed
185 $PACKNAME = "PACK000";
189 AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION
190 C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
191 EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE FULLPERL FUNCLIST H
192 HTMLLIBPODS HTMLSCRIPTPODS IMPORTS
193 INC INCLUDE_EXT INSTALLARCHLIB INSTALLBIN INSTALLDIRS INSTALLHTMLPRIVLIBDIR
194 INSTALLHTMLSCRIPTDIR INSTALLHTMLSITELIBDIR INSTALLMAN1DIR
195 INSTALLMAN3DIR INSTALLPRIVLIB INSTALLSCRIPT INSTALLSITEARCH
196 INSTALLSITELIB INST_ARCHLIB INST_BIN INST_EXE INST_LIB
197 INST_HTMLLIBDIR INST_HTMLSCRIPTDIR
198 INST_MAN1DIR INST_MAN3DIR INST_SCRIPT LDFROM LIB LIBPERL_A LIBS
199 LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB
201 NAME NEEDS_LINKING NOECHO NORECURS NO_VC OBJECT OPTIMIZE PERL PERLMAINCC
202 PERL_ARCHLIB PERL_LIB PERL_SRC PERM_RW PERM_RWX
203 PL_FILES PM PM_FILTER PMLIBDIRS POLLUTE PPM_INSTALL_EXEC
204 PPM_INSTALL_SCRIPT PREFIX
205 PREREQ_PM SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
206 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
209 MACPERL_SRC MACPERL_LIB MACLIBS_68K MACLIBS_PPC MACLIBS_SC MACLIBS_MRC
210 MACLIBS_ALL_68K MACLIBS_ALL_PPC MACLIBS_SHARED
213 # IMPORTS is used under OS/2 and Win32
215 # @Overridable is close to @MM_Sections but not identical. The
216 # order is important. Many subroutines declare macros. These
217 # depend on each other. Let's try to collect the macros up front,
218 # then pasthru, then the rules.
220 # MM_Sections are the sections we have to call explicitly
221 # in Overridable we have subroutines that are used indirectly
227 post_initialize const_config constants tool_autosplit tool_xsubpp
228 tools_other dist macro depend cflags const_loadlibs const_cccmd
233 c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs
234 dynamic_lib static static_lib htmlifypods manifypods processPL
236 clean realclean dist_basics dist_core dist_dir dist_test dist_ci
237 install force perldepend makefile staticmake test ppd
239 ); # loses section ordering
241 @Overridable = @MM_Sections;
242 push @Overridable, qw[
244 dir_target libscan makeaperl needs_linking perm_rw perm_rwx
245 subdir_x test_via_harness test_via_script
248 push @MM_Sections, qw[
250 pm_to_blib selfdocument
254 # Postamble needs to be the last that was always the case
255 push @MM_Sections, "postamble";
256 push @Overridable, "postamble";
258 # All sections are valid keys.
259 @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
261 # we will use all these variables in the Makefile
264 ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc
265 lib_ext obj_ext osname osvers ranlib sitelibexp sitearchexp so
270 foreach $item (@Attrib_help){
271 $Recognized_Att_Keys{$item} = 1;
273 foreach $item (@Get_from_Config) {
274 $Recognized_Att_Keys{uc $item} = $Config{$item};
275 print "Attribute '\U$item\E' => '$Config{$item}'\n"
280 # When we eval a Makefile.PL in a subdirectory, that one will ask
281 # us (the parent) for the values and will prepend "..", so that
282 # all files to be installed end up below OUR ./blib
287 INST_BIN 1 INST_EXE 1 INST_LIB 1 INST_ARCHLIB 1 INST_SCRIPT 1
288 MAP_TARGET 1 INST_HTMLLIBDIR 1 INST_HTMLSCRIPTDIR 1
289 INST_MAN1DIR 1 INST_MAN3DIR 1 PERL_SRC 1 PERL 1 FULLPERL 1
294 NEEDS_LINKING HAS_LINK_CODE
296 @Keep_after_flush{@keep} = (1) x @keep;
302 The extension you are trying to build apparently is rather old and
303 most probably outdated. We detect that from the fact, that a
304 subroutine "writeMakefile" is called, and this subroutine is not
305 supported anymore since about October 1994.
307 Please contact the author or look into CPAN (details about CPAN can be
308 found in the FAQ and at http:/www.perl.com) for a more recent version
309 of the extension. If you're really desperate, you can try to change
310 the subroutine name from writeMakefile to WriteMakefile and rerun
311 'perl Makefile.PL', but you're most probably left alone, when you do
319 sub ExtUtils::MakeMaker::new {
320 my($class,$self) = @_;
323 print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
324 if (-f "MANIFEST" && ! -f "Makefile"){
328 $self = {} unless (defined $self);
332 my(%initial_att) = %$self; # record initial attributes
335 foreach $prereq (sort keys %{$self->{PREREQ_PM}}) {
336 my $eval = "require $prereq";
340 warn "Warning: prerequisite $prereq failed to load: $@";
342 elsif ($prereq->VERSION < $self->{PREREQ_PM}->{$prereq} ){
343 warn "Warning: prerequisite $prereq $self->{PREREQ_PM}->{$prereq} not found";
344 # Why is/was this 'delete' here? We need PREREQ_PM later to make PPDs.
346 # delete $self->{PREREQ_PM}{$prereq};
350 # unless (defined $ExtUtils::MakeMaker::useCPAN) {
351 # print qq{MakeMaker WARNING: prerequisites not found (@unsatisfied)
352 # Please install these modules first and rerun 'perl Makefile.PL'.\n};
353 # if ($ExtUtils::MakeMaker::hasCPAN) {
354 # $ExtUtils::MakeMaker::useCPAN = prompt(qq{Should I try to use the CPAN module to fetch them for you?},"yes");
356 # print qq{Hint: You may want to install the CPAN module to autofetch the needed modules\n};
357 # $ExtUtils::MakeMaker::useCPAN=0;
360 # if ($ExtUtils::MakeMaker::useCPAN) {
362 # CPAN->import(@unsatisfied);
364 # die qq{prerequisites not found (@unsatisfied)};
366 # warn qq{WARNING: prerequisites not found (@unsatisfied)};
369 if (defined $self->{CONFIGURE}) {
370 if (ref $self->{CONFIGURE} eq 'CODE') {
371 $self = { %$self, %{&{$self->{CONFIGURE}}}};
373 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
377 # This is for old Makefiles written pre 5.00, will go away
378 if ( Carp::longmess("") =~ /runsubdirpl/s ){
379 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
382 my $newclass = ++$PACKNAME;
383 local @Parent = @Parent; # Protect against non-local exits
386 print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
387 mv_all_methods("MY",$newclass);
388 bless $self, $newclass;
390 @{"$newclass\:\:ISA"} = 'MM';
393 if (defined $Parent[-2]){
394 $self->{PARENT} = $Parent[-2];
396 for $key (keys %Prepend_dot_dot) {
397 next unless defined $self->{PARENT}{$key};
398 $self->{$key} = $self->{PARENT}{$key};
399 # PERL and FULLPERL may be command verbs instead of full
400 # file specifications under VMS. If so, don't turn them
402 $self->{$key} = $self->catdir("..",$self->{$key})
403 unless $self->file_name_is_absolute($self->{$key})
404 || ($^O eq 'VMS' and ($key =~ /PERL$/ && $self->{$key} =~ /^[\w\-\$]+$/));
406 if ($self->{PARENT}) {
407 $self->{PARENT}->{CHILDREN}->{$newclass} = $self;
408 foreach my $opt (qw(CAPI POLLUTE)) {
409 if (exists $self->{PARENT}->{$opt}
410 and not exists $self->{$opt})
412 # inherit, but only if already unspecified
413 $self->{$opt} = $self->{PARENT}->{$opt};
418 parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV);
421 $self->{NAME} ||= $self->guess_name;
423 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
427 if (! $self->{PERL_SRC} ) {
428 my($pthinks) = $self->canonpath($INC{'Config.pm'});
429 my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
430 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
431 if ($pthinks ne $cthinks &&
432 !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
433 print "Have $pthinks expected $cthinks\n";
435 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
438 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
440 print STDOUT <<END unless $self->{UNINSTALLED_PERL};
441 Your perl and your Config.pm seem to have different ideas about the architecture
443 Perl thinks: [$pthinks]
444 Config says: [$Config{archname}]
445 This may or may not cause problems. Please check your installation of perl if you
446 have problems building this extension.
451 $self->init_dirscan();
452 $self->init_others();
453 my($argv) = neatvalue(\@ARGV);
457 push @{$self->{RESULT}}, <<END;
458 # This Makefile is for the $self->{NAME} extension to perl.
460 # It was generated automatically by MakeMaker version
461 # $VERSION (Revision: $Revision) from the contents of
462 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
464 # ANY CHANGES MADE HERE WILL BE LOST!
466 # MakeMaker ARGV: $argv
468 # MakeMaker Parameters:
471 foreach $key (sort keys %initial_att){
472 my($v) = neatvalue($initial_att{$key});
473 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
475 push @{$self->{RESULT}}, "# $key => $v";
478 # turn the SKIP array into a SKIPHASH hash
480 for $skip (@{$self->{SKIP} || []}) {
481 $self->{SKIPHASH}{$skip} = 1;
483 delete $self->{SKIP}; # free memory
485 if ($self->{PARENT}) {
486 for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
487 $self->{SKIPHASH}{$_} = 1;
491 # We run all the subdirectories now. They don't have much to query
492 # from the parent, but the parent has to query them: if they need linking!
493 unless ($self->{NORECURS}) {
494 $self->eval_in_subdirs if @{$self->{DIR}};
498 foreach $section ( @MM_Sections ){
499 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
500 my($skipit) = $self->skipcheck($section);
502 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
504 my(%a) = %{$self->{$section} || {}};
505 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
506 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
507 push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
511 push @{$self->{RESULT}}, "\n# End.";
516 sub WriteEmptyMakefile {
517 if (-f 'Makefile.old') {
518 chmod 0666, 'Makefile.old';
519 unlink 'Makefile.old' or warn "unlink Makefile.old: $!";
521 rename 'Makefile', 'Makefile.old' or warn "rename Makefile Makefile.old: $!"
523 open MF, '> Makefile' or die "open Makefile for write: $!";
536 close MF or die "close Makefile for write: $!";
540 print STDOUT "Checking if your kit is complete...\n";
541 require ExtUtils::Manifest;
542 $ExtUtils::Manifest::Quiet=$ExtUtils::Manifest::Quiet=1; #avoid warning
543 my(@missed)=ExtUtils::Manifest::manicheck();
545 print STDOUT "Warning: the following files are missing in your kit:\n";
546 print "\t", join "\n\t", @missed;
548 print STDOUT "Please inform the author.\n";
550 print STDOUT "Looks good\n";
555 my($self, @args) = @_;
557 unless (m/(.*?)=(.*)/){
558 help(),exit 1 if m/^help$/;
559 ++$Verbose if m/^verb/;
562 my($name, $value) = ($1, $2);
563 if ($value =~ m/^~(\w+)?/){ # tilde with optional username
564 $value =~ s [^~(\w*)]
566 ((getpwnam($1))[7] || "~$1") :
570 $self->{uc($name)} = $value;
573 # catch old-style 'potential_libs' and inform user how to 'upgrade'
574 if (defined $self->{potential_libs}){
575 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
576 if ($self->{potential_libs}){
577 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
579 print STDOUT "$msg deleted.\n";
581 $self->{LIBS} = [$self->{potential_libs}];
582 delete $self->{potential_libs};
584 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
585 if (defined $self->{ARMAYBE}){
586 my($armaybe) = $self->{ARMAYBE};
587 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
588 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
589 my(%dl) = %{$self->{dynamic_lib} || {}};
590 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
591 delete $self->{ARMAYBE};
593 if (defined $self->{LDTARGET}){
594 print STDOUT "LDTARGET should be changed to LDFROM\n";
595 $self->{LDFROM} = $self->{LDTARGET};
596 delete $self->{LDTARGET};
598 # Turn a DIR argument on the command line into an array
599 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
600 # So they can choose from the command line, which extensions they want
601 # the grep enables them to have some colons too much in case they
602 # have to build a list with the shell
603 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
605 # Turn a INCLUDE_EXT argument on the command line into an array
606 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
607 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
609 # Turn a EXCLUDE_EXT argument on the command line into an array
610 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
611 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
614 foreach $mmkey (sort keys %$self){
615 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
616 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
617 unless exists $Recognized_Att_Keys{$mmkey};
624 # We allow extension-specific hints files.
626 return unless -d "hints";
628 # First we look for the best hintsfile we have
630 my($hint)="${^O}_$Config{osvers}";
635 # Also try without trailing minor version numbers.
637 last if -f "hints/$hint.pl"; # found
639 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
641 return unless -f "hints/$hint.pl"; # really there
643 # execute the hintsfile:
645 # my $fh = new FileHandle;
646 # $fh->open("hints/$hint.pl");
648 open(FH,"hints/$hint.pl");
649 # @goodhints = <$fh>;
653 print STDOUT "Processing hints file hints/$hint.pl\n";
654 eval join('',@goodhints);
655 print STDOUT $@ if $@;
661 my($symtab) = \%{"${from}::"};
664 # Here you see the *current* list of methods that are overridable
665 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
666 # still trying to reduce the list to some reasonable minimum --
667 # because I want to make it easier for the user. A.K.
669 foreach $method (@Overridable) {
671 # We cannot say "next" here. Nick might call MY->makeaperl
672 # which isn't defined right now
674 # Above statement was written at 4.23 time when Tk-b8 was
675 # around. As Tk-b9 only builds with 5.002something and MM 5 is
676 # standard, we try to enable the next line again. It was
677 # commented out until MM 5.23
679 next unless defined &{"${from}::$method"};
681 *{"${to}::$method"} = \&{"${from}::$method"};
683 # delete would do, if we were sure, nobody ever called
684 # MY->makeaperl directly
686 # delete $symtab->{$method};
688 # If we delete a method, then it will be undefined and cannot
689 # be called. But as long as we have Makefile.PLs that rely on
690 # %MY:: being intact, we have to fill the hole with an
693 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
696 # We have to clean out %INC also, because the current directory is
697 # changed frequently and Graham Barr prefers to get his version
698 # out of a History.pl file which is "required" so woudn't get
699 # loaded again in another extension requiring a History.pl
701 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
702 # to core dump in the middle of a require statement. The required
703 # file was Tk/MMutil.pm. The consequence is, we have to be
704 # extremely careful when we try to give perl a reason to reload a
705 # library with same name. The workaround prefers to drop nothing
706 # from %INC and teach the writers not to use such libraries.
709 # foreach $inc (keys %INC) {
710 # #warn "***$inc*** deleted";
718 if ($section eq 'dynamic') {
719 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
720 "in skipped section 'dynamic_bs'\n"
721 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
722 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
723 "in skipped section 'dynamic_lib'\n"
724 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
726 if ($section eq 'dynamic_lib') {
727 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
728 "targets in skipped section 'dynamic_bs'\n"
729 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
731 if ($section eq 'static') {
732 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
733 "in skipped section 'static_lib'\n"
734 if $self->{SKIPHASH}{static_lib} && $Verbose;
736 return 'skipped' if $self->{SKIPHASH}{$section};
744 # my $fh = new FileHandle;
746 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
748 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
749 # $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
750 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
752 for $chunk (@{$self->{RESULT}}) {
753 # print $fh "$chunk\n";
759 my($finalname) = $self->{MAKEFILE};
760 rename("MakeMaker.tmp", $finalname);
761 chmod 0644, $finalname unless $Is_VMS;
763 if ($self->{PARENT}) {
764 foreach (keys %$self) { # safe memory
765 delete $self->{$_} unless $Keep_after_flush{$_};
769 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
772 # The following mkbootstrap() is only for installations that are calling
773 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
774 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
777 !!! Your Makefile has been built such a long time ago, !!!
778 !!! that is unlikely to work with current MakeMaker. !!!
779 !!! Please rebuild your Makefile !!!
783 # Ditto for mksymlists() as of MakeMaker 5.17
786 !!! Your Makefile has been built such a long time ago, !!!
787 !!! that is unlikely to work with current MakeMaker. !!!
788 !!! Please rebuild your Makefile !!!
794 return "undef" unless defined $v;
796 return "q[$v]" unless $t;
798 my(@m, $elem, @neat);
800 foreach $elem (@$v) {
801 push @neat, "q[$elem]";
803 push @m, join ", ", @neat;
807 return "$v" unless $t eq 'HASH';
809 while (($key,$val) = each %$v){
810 last unless defined $key; # cautious programming in case (undef,undef) is true
811 push(@m,"$key=>".neatvalue($val)) ;
813 return "{ ".join(', ',@m)." }";
820 push @m, "\n# Full list of MakeMaker attribute values:";
821 foreach $key (sort keys %$self){
822 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
823 my($v) = neatvalue($self->{$key});
824 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
826 push @m, "# $key => $v";
832 package ExtUtils::MakeMaker;
839 ExtUtils::MakeMaker - create an extension Makefile
843 C<use ExtUtils::MakeMaker;>
845 C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
849 C<MM-E<gt>new(\%att)-E<gt>flush;>
853 This utility is designed to write a Makefile for an extension module
854 from a Makefile.PL. It is based on the Makefile.SH model provided by
855 Andy Dougherty and the perl5-porters.
857 It splits the task of generating the Makefile into several subroutines
858 that can be individually overridden. Each subroutine returns the text
859 it wishes to have written to the Makefile.
861 MakeMaker is object oriented. Each directory below the current
862 directory that contains a Makefile.PL. Is treated as a separate
863 object. This makes it possible to write an unlimited number of
864 Makefiles with a single invocation of WriteMakefile().
866 =head2 How To Write A Makefile.PL
868 The short answer is: Don't.
870 Always begin with h2xs.
871 Always begin with h2xs!
872 ALWAYS BEGIN WITH H2XS!
874 even if you're not building around a header file, and even if you
875 don't have an XS component.
877 Run h2xs(1) before you start thinking about writing a module. For so
878 called pm-only modules that consist of C<*.pm> files only, h2xs has
879 the C<-X> switch. This will generate dummy files of all kinds that are
880 useful for the module developer.
882 The medium answer is:
884 use ExtUtils::MakeMaker;
885 WriteMakefile( NAME => "Foo::Bar" );
887 The long answer is the rest of the manpage :-)
889 =head2 Default Makefile Behaviour
891 The generated Makefile enables the user of the extension to invoke
893 perl Makefile.PL # optionally "perl Makefile.PL verbose"
895 make test # optionally set TEST_VERBOSE=1
896 make install # See below
898 The Makefile to be produced may be altered by adding arguments of the
899 form C<KEY=VALUE>. E.g.
901 perl Makefile.PL PREFIX=/tmp/myperl5
903 Other interesting targets in the generated Makefile are
905 make config # to check if the Makefile is up-to-date
906 make clean # delete local temp files (Makefile gets renamed)
907 make realclean # delete derived files (including ./blib)
908 make ci # check in all the files in the MANIFEST file
909 make dist # see below the Distribution Support section
913 MakeMaker checks for the existence of a file named F<test.pl> in the
914 current directory and if it exists it adds commands to the test target
915 of the generated Makefile that will execute the script with the proper
916 set of perl C<-I> options.
918 MakeMaker also checks for any files matching glob("t/*.t"). It will
919 add commands to the test target of the generated Makefile that execute
920 all matching files via the L<Test::Harness> module with the C<-I>
921 switches set correctly.
925 A useful variation of the above is the target C<testdb>. It runs the
926 test under the Perl debugger (see L<perldebug>). If the file
927 F<test.pl> exists in the current directory, it is used for the test.
929 If you want to debug some other testfile, set C<TEST_FILE> variable
932 make testdb TEST_FILE=t/mytest.t
934 By default the debugger is called using C<-d> option to perl. If you
935 want to specify some other option, set C<TESTDB_SW> variable:
937 make testdb TESTDB_SW=-Dx
941 make alone puts all relevant files into directories that are named by
942 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_HTMLLIBDIR,
943 INST_HTMLSCRIPTDIR, INST_MAN1DIR, and INST_MAN3DIR. All these default
944 to something below ./blib if you are I<not> building below the perl
945 source directory. If you I<are> building below the perl source,
946 INST_LIB and INST_ARCHLIB default to ../../lib, and INST_SCRIPT is not
949 The I<install> target of the generated Makefile copies the files found
950 below each of the INST_* directories to their INSTALL*
951 counterparts. Which counterparts are chosen depends on the setting of
952 INSTALLDIRS according to the following table:
957 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH
958 INST_LIB INSTALLPRIVLIB INSTALLSITELIB
959 INST_HTMLLIBDIR INSTALLHTMLPRIVLIBDIR INSTALLHTMLSITELIBDIR
960 INST_HTMLSCRIPTDIR INSTALLHTMLSCRIPTDIR
962 INST_SCRIPT INSTALLSCRIPT
963 INST_MAN1DIR INSTALLMAN1DIR
964 INST_MAN3DIR INSTALLMAN3DIR
966 The INSTALL... macros in turn default to their %Config
967 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
969 You can check the values of these variables on your system with
973 And to check the sequence in which the library directories are
974 searched by perl, run
976 perl -le 'print join $/, @INC'
979 =head2 PREFIX and LIB attribute
981 PREFIX and LIB can be used to set several INSTALL* attributes in one
982 go. The quickest way to install a module in a non-standard place might
985 perl Makefile.PL LIB=~/lib
987 This will install the module's architecture-independent files into
988 ~/lib, the architecture-dependent files into ~/lib/$archname.
990 Another way to specify many INSTALL directories with a single
993 perl Makefile.PL PREFIX=~
995 This will replace the string specified by C<$Config{prefix}> in all
996 C<$Config{install*}> values.
998 Note, that in both cases the tilde expansion is done by MakeMaker, not
999 by perl by default, nor by make.
1001 Conflicts between parameters LIB,
1002 PREFIX and the various INSTALL* arguments are resolved so that:
1008 setting LIB overrides any setting of INSTALLPRIVLIB, INSTALLARCHLIB,
1009 INSTALLSITELIB, INSTALLSITEARCH (and they are not affected by PREFIX);
1013 without LIB, setting PREFIX replaces the initial C<$Config{prefix}>
1014 part of those INSTALL* arguments, even if the latter are explicitly
1015 set (but are set to still start with C<$Config{prefix}>).
1019 If the user has superuser privileges, and is not working on AFS
1020 or relatives, then the defaults for
1021 INSTALLPRIVLIB, INSTALLARCHLIB, INSTALLSCRIPT, etc. will be appropriate,
1022 and this incantation will be the best:
1024 perl Makefile.PL; make; make test
1027 make install per default writes some documentation of what has been
1028 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1029 can be bypassed by calling make pure_install.
1033 will have to specify the installation directories as these most
1034 probably have changed since perl itself has been installed. They will
1035 have to do this by calling
1037 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1038 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1041 Be careful to repeat this procedure every time you recompile an
1042 extension, unless you are sure the AFS installation directories are
1045 =head2 Static Linking of a new Perl Binary
1047 An extension that is built with the above steps is ready to use on
1048 systems supporting dynamic loading. On systems that do not support
1049 dynamic loading, any newly created extension has to be linked together
1050 with the available resources. MakeMaker supports the linking process
1051 by creating appropriate targets in the Makefile whenever an extension
1052 is built. You can invoke the corresponding section of the makefile with
1056 That produces a new perl binary in the current directory with all
1057 extensions linked in that can be found in INST_ARCHLIB , SITELIBEXP,
1058 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1059 UNIX, this is called Makefile.aperl (may be system dependent). If you
1060 want to force the creation of a new perl, it is recommended, that you
1061 delete this Makefile.aperl, so the directories are searched-through
1062 for linkable libraries again.
1064 The binary can be installed into the directory where perl normally
1065 resides on your machine with
1069 To produce a perl binary with a different name than C<perl>, either say
1071 perl Makefile.PL MAP_TARGET=myperl
1078 make myperl MAP_TARGET=myperl
1079 make inst_perl MAP_TARGET=myperl
1081 In any case you will be prompted with the correct invocation of the
1082 C<inst_perl> target that installs the new binary into INSTALLBIN.
1084 make inst_perl per default writes some documentation of what has been
1085 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1086 can be bypassed by calling make pure_inst_perl.
1088 Warning: the inst_perl: target will most probably overwrite your
1089 existing perl binary. Use with care!
1091 Sometimes you might want to build a statically linked perl although
1092 your system supports dynamic loading. In this case you may explicitly
1093 set the linktype with the invocation of the Makefile.PL or make:
1095 perl Makefile.PL LINKTYPE=static # recommended
1099 make LINKTYPE=static # works on most systems
1101 =head2 Determination of Perl Library and Installation Locations
1103 MakeMaker needs to know, or to guess, where certain things are
1104 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1105 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1106 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1108 Extensions may be built either using the contents of the perl source
1109 directory tree or from the installed perl library. The recommended way
1110 is to build extensions after you have run 'make install' on perl
1111 itself. You can do that in any directory on your hard disk that is not
1112 below the perl source tree. The support for extensions below the ext
1113 directory of the perl distribution is only good for the standard
1114 extensions that come with perl.
1116 If an extension is being built below the C<ext/> directory of the perl
1117 source then MakeMaker will set PERL_SRC automatically (e.g.,
1118 C<../..>). If PERL_SRC is defined and the extension is recognized as
1119 a standard extension, then other variables default to the following:
1122 PERL_LIB = PERL_SRC/lib
1123 PERL_ARCHLIB = PERL_SRC/lib
1125 INST_ARCHLIB = PERL_ARCHLIB
1127 If an extension is being built away from the perl source then MakeMaker
1128 will leave PERL_SRC undefined and default to using the installed copy
1129 of the perl library. The other variables default to the following:
1131 PERL_INC = $archlibexp/CORE
1132 PERL_LIB = $privlibexp
1133 PERL_ARCHLIB = $archlibexp
1134 INST_LIB = ./blib/lib
1135 INST_ARCHLIB = ./blib/arch
1137 If perl has not yet been installed then PERL_SRC can be defined on the
1138 command line as shown in the previous section.
1141 =head2 Which architecture dependent directory?
1143 If you don't want to keep the defaults for the INSTALL* macros,
1144 MakeMaker helps you to minimize the typing needed: the usual
1145 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1146 by Configure at perl compilation time. MakeMaker supports the user who
1147 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1148 then MakeMaker defaults the latter to be the same subdirectory of
1149 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1150 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1151 for INSTALLSITELIB and INSTALLSITEARCH.
1153 MakeMaker gives you much more freedom than needed to configure
1154 internal variables and get different results. It is worth to mention,
1155 that make(1) also lets you configure most of the variables that are
1156 used in the Makefile. But in the majority of situations this will not
1157 be necessary, and should only be done if the author of a package
1158 recommends it (or you know what you're doing).
1160 =head2 Using Attributes and Parameters
1162 The following attributes can be specified as arguments to WriteMakefile()
1163 or as NAME=VALUE pairs on the command line:
1169 One line description of the module. Will be included in PPD file.
1173 Name of the file that contains the package description. MakeMaker looks
1174 for a line in the POD matching /^($package\s-\s)(.*)/. This is typically
1175 the first line in the "=head1 NAME" section. $2 becomes the abstract.
1179 String containing name (and email address) of package author(s). Is used
1180 in PPD (Perl Package Description) files for PPM (Perl Package Manager).
1182 =item BINARY_LOCATION
1184 Used when creating PPD files for binary packages. It can be set to a
1185 full or relative path or URL to the binary archive for a particular
1186 architecture. For example:
1188 perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
1190 builds a PPD package that references a binary of the C<Agent> package,
1191 located in the C<x86> directory relative to the PPD itself.
1195 Ref to array of *.c file names. Initialised from a directory scan
1196 and the values portion of the XS attribute hash. This is not
1197 currently used by MakeMaker but may be handy in Makefile.PLs.
1201 [This attribute is obsolete in Perl 5.6. PERL_OBJECT builds are C-compatible
1204 Switch to force usage of the Perl C API even when compiling for PERL_OBJECT.
1206 Note that this attribute is passed through to any recursive build,
1207 but if and only if the submodule's Makefile.PL itself makes no mention
1208 of the 'CAPI' attribute.
1212 String that will be included in the compiler call command line between
1213 the arguments INC and OPTIMIZE.
1217 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1218 config.sh. MakeMaker will add to CONFIG the following values anyway:
1238 CODE reference. The subroutine should return a hash reference. The
1239 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1240 be determined by some evaluation method.
1244 Something like C<"-DHAVE_UNISTD_H">
1248 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1253 Your name for distributing the package (by tar file). This defaults to
1258 Hashref of symbol names for routines to be made available as universal
1259 symbols. Each key/value pair consists of the package name and an
1260 array of routine names in that package. Used only under AIX, OS/2,
1261 VMS and Win32 at present. The routine names supplied will be expanded
1262 in the same way as XSUB names are expanded by the XS() macro.
1265 {"$(NAME)" => ["boot_$(NAME)" ] }
1269 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1270 "NetconfigPtr" => [ 'DESTROY'] }
1272 Please see the L<ExtUtils::Mksymlists> documentation for more information
1273 about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
1277 Array of symbol names for variables to be made available as universal symbols.
1278 Used only under AIX, OS/2, VMS and Win32 at present. Defaults to [].
1279 (e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
1283 Array of extension names to exclude when doing a static build. This
1284 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1285 details. (e.g. [ qw( Socket POSIX ) ] )
1287 This attribute may be most useful when specified as a string on the
1288 command line: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1292 Ref to array of executable files. The files will be copied to the
1293 INST_SCRIPT directory. Make realclean will delete them from there
1296 =item FIRST_MAKEFILE
1298 The name of the Makefile to be produced. Defaults to the contents of
1299 MAKEFILE, but can be overridden. This is used for the second Makefile
1300 that will be produced for the MAP_TARGET.
1304 Perl binary able to run this extension.
1308 This provides an alternate means to specify function names to be
1309 exported from the extension. Its value is a reference to an
1310 array of function names to be exported by the extension. These
1311 names are passed through unaltered to the linker options file.
1315 Ref to array of *.h file names. Similar to C.
1319 Hashref of .pm and .pod files. MakeMaker will default this to all
1320 .pod and any .pm files that include POD directives. The files listed
1321 here will be converted to HTML format and installed as was requested
1324 =item HTMLSCRIPTPODS
1326 Hashref of pod-containing files. MakeMaker will default this to all
1327 EXE_FILES files that include POD directives. The files listed
1328 here will be converted to HTML format and installed as was requested
1333 This attribute is used to specify names to be imported into the
1334 extension. It is only used on OS/2 and Win32.
1338 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1342 Array of extension names to be included when doing a static build.
1343 MakeMaker will normally build with all of the installed extensions when
1344 doing a static build, and that is usually the desired behavior. If
1345 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1346 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1348 It is not necessary to mention DynaLoader or the current extension when
1349 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1350 only DynaLoader and the current extension will be included in the build.
1352 This attribute may be most useful when specified as a string on the
1353 command line: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1355 =item INSTALLARCHLIB
1357 Used by 'make install', which copies files from INST_ARCHLIB to this
1358 directory if INSTALLDIRS is set to perl.
1362 Directory to install binary files (e.g. tkperl) into.
1366 Determines which of the two sets of installation directories to
1367 choose: installprivlib and installarchlib versus installsitelib and
1368 installsitearch. The first pair is chosen with INSTALLDIRS=perl, the
1369 second with INSTALLDIRS=site. Default is site.
1371 =item INSTALLHTMLPRIVLIBDIR
1373 This directory gets the HTML pages at 'make install' time. Defaults to
1374 $Config{installhtmlprivlibdir}.
1376 =item INSTALLHTMLSCRIPTDIR
1378 This directory gets the HTML pages at 'make install' time. Defaults to
1379 $Config{installhtmlscriptdir}.
1381 =item INSTALLHTMLSITELIBDIR
1383 This directory gets the HTML pages at 'make install' time. Defaults to
1384 $Config{installhtmlsitelibdir}.
1387 =item INSTALLMAN1DIR
1389 This directory gets the man pages at 'make install' time. Defaults to
1390 $Config{installman1dir}.
1392 =item INSTALLMAN3DIR
1394 This directory gets the man pages at 'make install' time. Defaults to
1395 $Config{installman3dir}.
1397 =item INSTALLPRIVLIB
1399 Used by 'make install', which copies files from INST_LIB to this
1400 directory if INSTALLDIRS is set to perl.
1404 Used by 'make install' which copies files from INST_SCRIPT to this
1407 =item INSTALLSITEARCH
1409 Used by 'make install', which copies files from INST_ARCHLIB to this
1410 directory if INSTALLDIRS is set to site (default).
1412 =item INSTALLSITELIB
1414 Used by 'make install', which copies files from INST_LIB to this
1415 directory if INSTALLDIRS is set to site (default).
1419 Same as INST_LIB for architecture dependent files.
1423 Directory to put real binary files during 'make'. These will be copied
1424 to INSTALLBIN during 'make install'
1428 Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you
1431 =item INST_HTMLLIBDIR
1433 Directory to hold the man pages in HTML format at 'make' time
1435 =item INST_HTMLSCRIPTDIR
1437 Directory to hold the man pages in HTML format at 'make' time
1441 Directory where we put library files of this extension while building
1446 Directory to hold the man pages at 'make' time
1450 Directory to hold the man pages at 'make' time
1454 Directory, where executable files should be installed during
1455 'make'. Defaults to "./blib/script", just to have a dummy location during
1456 testing. make install will copy the files in INST_SCRIPT to
1461 defaults to "$(OBJECT)" and is used in the ld command to specify
1462 what files to link/load from (also see dynamic_lib below for how to
1467 LIB should only be set at C<perl Makefile.PL> time but is allowed as a
1468 MakeMaker argument. It has the effect of
1469 setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any
1470 explicit setting of those arguments (or of PREFIX).
1471 INSTALLARCHLIB and INSTALLSITEARCH are set to the corresponding
1472 architecture subdirectory.
1476 The filename of the perllibrary that will be used together with this
1477 extension. Defaults to libperl.a.
1481 An anonymous array of alternative library
1482 specifications to be searched for (in order) until
1483 at least one library is found. E.g.
1485 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1487 Mind, that any element of the array
1488 contains a complete set of arguments for the ld
1489 command. So do not specify
1491 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1493 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1494 you specify a scalar as in
1496 'LIBS' => "-ltcl -ltk -lX11"
1498 MakeMaker will turn it into an array with one element.
1502 'static' or 'dynamic' (default unless usedl=undef in
1503 config.sh). Should only be used to force static linking (also see
1508 Boolean which tells MakeMaker, that it should include the rules to
1509 make a perl. This is handled automatically as a switch by
1510 MakeMaker. The user normally does not need it.
1514 The name of the Makefile to be produced.
1518 Hashref of pod-containing files. MakeMaker will default this to all
1519 EXE_FILES files that include POD directives. The files listed
1520 here will be converted to man pages and installed as was requested
1525 Hashref that assigns to *.pm and *.pod files the files into which the
1526 manpages are to be written. MakeMaker parses all *.pod and *.pm files
1527 for POD directives. Files that contain POD will be the default keys of
1528 the MAN3PODS hashref. These will then be converted to man pages during
1529 C<make> and will be installed during C<make install>.
1533 If it is intended, that a new perl binary be produced, this variable
1534 may hold a name for that binary. Defaults to perl
1538 If the extension links to a library that it builds set this to the
1539 name of the library (see SDBM_File)
1543 Perl module name for this extension (DBD::Oracle). This will default
1544 to the directory name but should be explicitly defined in the
1549 MakeMaker will figure out if an extension contains linkable code
1550 anywhere down the directory tree, and will set this variable
1551 accordingly, but you can speed it up a very little bit if you define
1552 this boolean variable yourself.
1556 Defaults to C<@>. By setting it to an empty string you can generate a
1557 Makefile that echos all commands. Mainly used in debugging MakeMaker
1562 Boolean. Attribute to inhibit descending into subdirectories.
1566 In general, any generated Makefile checks for the current version of
1567 MakeMaker and the version the Makefile was built under. If NO_VC is
1568 set, the version check is neglected. Do not write this into your
1569 Makefile.PL, use it interactively instead.
1573 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1574 string containing all object files, e.g. "tkpBind.o
1575 tkpButton.o tkpCanvas.o"
1577 (Where BASEEXT is the last component of NAME, and OBJ_EXT is $Config{obj_ext}.)
1581 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1582 passed to subdirectory makes.
1586 Perl binary for tasks that can be done by miniperl
1590 The call to the program that is able to compile perlmain.c. Defaults
1595 Same as below, but for architecture dependent files.
1599 Directory containing the Perl library to use.
1601 =item PERL_MALLOC_OK
1603 defaults to 0. Should be set to TRUE if the extension can work with
1604 the memory allocation routines substituted by the Perl malloc() subsystem.
1605 This should be applicable to most extensions with exceptions of those
1611 with bugs in memory allocations which are caught by Perl's malloc();
1615 which interact with the memory allocator in other ways than via
1616 malloc(), realloc(), free(), calloc(), sbrk() and brk();
1620 which rely on special alignment which is not provided by Perl's malloc().
1624 B<NOTE.> Negligence to set this flag in I<any one> of loaded extension
1625 nullifies many advantages of Perl's malloc(), such as better usage of
1626 system resources, error detection, memory usage reporting, catchable failure
1627 of memory allocations, etc.
1631 Directory containing the Perl source code (use of this should be
1632 avoided, it may be undefined)
1636 Desired permission for read/writable files. Defaults to C<644>.
1637 See also L<MM_Unix/perm_rw>.
1641 Desired permission for executable files. Defaults to C<755>.
1642 See also L<MM_Unix/perm_rwx>.
1646 Ref to hash of files to be processed as perl programs. MakeMaker
1647 will default to any found *.PL file (except Makefile.PL) being keys
1648 and the basename of the file being the value. E.g.
1650 {'foobar.PL' => 'foobar'}
1652 The *.PL files are expected to produce output to the target files
1653 themselves. If multiple files can be generated from the same *.PL
1654 file then the value in the hash can be a reference to an array of
1655 target file names. E.g.
1657 {'foobar.PL' => ['foobar1','foobar2']}
1661 Hashref of .pm files and *.pl files to be installed. e.g.
1663 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1665 By default this will include *.pm and *.pl and the files found in
1666 the PMLIBDIRS directories. Defining PM in the
1667 Makefile.PL will override PMLIBDIRS.
1671 Ref to array of subdirectories containing library files. Defaults to
1672 [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
1673 they contain will be installed in the corresponding location in the
1674 library. A libscan() method can be used to alter the behaviour.
1675 Defining PM in the Makefile.PL will override PMLIBDIRS.
1677 (Where BASEEXT is the last component of NAME.)
1681 A filter program, in the traditional Unix sense (input from stdin, output
1682 to stdout) that is passed on each .pm file during the build (in the
1683 pm_to_blib() phase). It is empty by default, meaning no filtering is done.
1685 Great care is necessary when defining the command if quoting needs to be
1686 done. For instance, you would need to say:
1688 {'PM_FILTER' => 'grep -v \\"^\\#\\"'}
1690 to remove all the leading coments on the fly during the build. The
1691 extra \\ are necessary, unfortunately, because this variable is interpolated
1692 within the context of a Perl program built on the command line, and double
1693 quotes are what is used with the -e switch to build that command line. The
1694 # is escaped for the Makefile, since what is going to be generated will then
1697 PM_FILTER = grep -v \"^\#\"
1699 Without the \\ before the #, we'd have the start of a Makefile comment,
1700 and the macro would be incorrectly defined.
1704 Release 5.005 grandfathered old global symbol names by providing preprocessor
1705 macros for extension source compatibility. As of release 5.6, these
1706 preprocessor definitions are not available by default. The POLLUTE flag
1707 specifies that the old names should still be defined:
1709 perl Makefile.PL POLLUTE=1
1711 Please inform the module author if this is necessary to successfully install
1712 a module under 5.6 or later.
1714 =item PPM_INSTALL_EXEC
1716 Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl)
1718 =item PPM_INSTALL_SCRIPT
1720 Name of the script that gets executed by the Perl Package Manager after
1721 the installation of a package.
1725 Can be used to set the three INSTALL* attributes in one go (except for
1726 probably INSTALLMAN1DIR, if it is not below PREFIX according to
1727 %Config). They will have PREFIX as a common directory node and will
1728 branch from that node into lib/, lib/ARCHNAME or whatever Configure
1729 decided at the build time of your perl (unless you override one of
1734 Hashref: Names of modules that need to be available to run this
1735 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1736 desired version is the value. If the required version number is 0, we
1737 only check if any version is installed already.
1741 Arryref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1742 Makefile. Caution! Do not use the SKIP attribute for the negligible
1743 speedup. It may seriously damage the resulting Makefile. Only use it
1744 if you really need it.
1748 Ref to array of typemap file names. Use this when the typemaps are
1749 in some directory other than the current directory or when they are
1750 not named B<typemap>. The last typemap in the list takes
1751 precedence. A typemap in the current directory has highest
1752 precedence, even if it isn't listed in TYPEMAPS. The default system
1753 typemap has lowest precedence.
1757 Your version number for distributing the package. This defaults to
1762 Instead of specifying the VERSION in the Makefile.PL you can let
1763 MakeMaker parse a file to determine the version number. The parsing
1764 routine requires that the file named by VERSION_FROM contains one
1765 single line to compute the version number. The first line in the file
1766 that contains the regular expression
1768 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
1770 will be evaluated with eval() and the value of the named variable
1771 B<after> the eval() will be assigned to the VERSION attribute of the
1772 MakeMaker object. The following lines will be parsed o.k.:
1776 ( $VERSION ) = '$Revision: 1.222 $ ' =~ /\$Revision:\s+([^\s]+)/;
1777 $FOO::VERSION = '1.10';
1778 *FOO::VERSION = \'1.11';
1779 our $VERSION = 1.2.3; # new for perl5.6.0
1781 but these will fail:
1783 my $VERSION = '1.01';
1784 local $VERSION = '1.02';
1785 local $FOO::VERSION = '1.30';
1787 (Putting C<my> or C<local> on the preceding line will work o.k.)
1789 The file named in VERSION_FROM is not added as a dependency to
1790 Makefile. This is not really correct, but it would be a major pain
1791 during development to have to rewrite the Makefile for any smallish
1792 change in that file. If you want to make sure that the Makefile
1793 contains the correct VERSION macro after any change of the file, you
1794 would have to do something like
1796 depend => { Makefile => '$(VERSION_FROM)' }
1798 See attribute C<depend> below.
1802 Hashref of .xs files. MakeMaker will default this. e.g.
1804 {'name_of_file.xs' => 'name_of_file.c'}
1806 The .c files will automatically be included in the list of files
1807 deleted by a make clean.
1811 String of options to pass to xsubpp. This might include C<-C++> or
1812 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
1817 May be set to an empty string, which is identical to C<-prototypes>, or
1818 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
1819 defaults to the empty string.
1823 Your version number for the .xs file of this package. This defaults
1824 to the value of the VERSION attribute.
1828 =head2 Additional lowercase attributes
1830 can be used to pass parameters to the methods which implement that
1831 part of the Makefile.
1837 {FILES => "*.xyz foo"}
1841 {ANY_TARGET => ANY_DEPENDECY, ...}
1843 (ANY_TARGET must not be given a double-colon rule by MakeMaker.)
1847 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
1848 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
1849 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
1851 If you specify COMPRESS, then SUFFIX should also be altered, as it is
1852 needed to tell make the target file of the compression. Setting
1853 DIST_CP to ln can be useful, if you need to preserve the timestamps on
1854 your files. DIST_CP can take the values 'cp', which copies the file,
1855 'ln', which links the file, and 'best' which copies symbolic links and
1856 links the rest. Default is 'best'.
1860 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
1864 {LINKTYPE => 'static', 'dynamic' or ''}
1866 NB: Extensions that have nothing but *.pm files had to say
1870 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1871 can be deleted safely. MakeMaker recognizes when there's nothing to
1876 {ANY_MACRO => ANY_VALUE, ...}
1880 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
1886 =item tool_autosplit
1892 =head2 Overriding MakeMaker Methods
1894 If you cannot achieve the desired Makefile behaviour by specifying
1895 attributes you may define private subroutines in the Makefile.PL.
1896 Each subroutines returns the text it wishes to have written to
1897 the Makefile. To override a section of the Makefile you can
1900 sub MY::c_o { "new literal text" }
1902 or you can edit the default by saying something like:
1905 package MY; # so that "SUPER" works right
1906 my $inherited = shift->SUPER::c_o(@_);
1907 $inherited =~ s/old text/new text/;
1911 If you are running experiments with embedding perl as a library into
1912 other applications, you might find MakeMaker is not sufficient. You'd
1913 better have a look at ExtUtils::Embed which is a collection of utilities
1916 If you still need a different solution, try to develop another
1917 subroutine that fits your needs and submit the diffs to
1918 F<perl5-porters@perl.org> or F<comp.lang.perl.moderated> as appropriate.
1920 For a complete description of all MakeMaker methods see L<ExtUtils::MM_Unix>.
1922 Here is a simple example of how to add a new target to the generated
1927 $(MYEXTLIB): sdbm/Makefile
1928 cd sdbm && $(MAKE) all
1933 =head2 Hintsfile support
1935 MakeMaker.pm uses the architecture specific information from
1936 Config.pm. In addition it evaluates architecture specific hints files
1937 in a C<hints/> directory. The hints files are expected to be named
1938 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
1939 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
1940 MakeMaker within the WriteMakefile() subroutine, and can be used to
1941 execute commands as well as to include special variables. The rules
1942 which hintsfile is chosen are the same as in Configure.
1944 The hintsfile is eval()ed immediately after the arguments given to
1945 WriteMakefile are stuffed into a hash reference $self but before this
1946 reference becomes blessed. So if you want to do the equivalent to
1947 override or create an attribute you would say something like
1949 $self->{LIBS} = ['-ldbm -lucb -lc'];
1951 =head2 Distribution Support
1953 For authors of extensions MakeMaker provides several Makefile
1954 targets. Most of the support comes from the ExtUtils::Manifest module,
1955 where additional documentation can be found.
1959 =item make distcheck
1961 reports which files are below the build directory but not in the
1962 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
1965 =item make skipcheck
1967 reports which files are skipped due to the entries in the
1968 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
1971 =item make distclean
1973 does a realclean first and then the distcheck. Note that this is not
1974 needed to build a new distribution as long as you are sure that the
1975 MANIFEST file is ok.
1979 rewrites the MANIFEST file, adding all remaining files found (See
1980 ExtUtils::Manifest::mkmanifest() for details)
1984 Copies all the files that are in the MANIFEST file to a newly created
1985 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
1986 exists, it will be removed first.
1990 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
1991 a make test in that directory.
1995 First does a distdir. Then a command $(PREOP) which defaults to a null
1996 command, followed by $(TOUNIX), which defaults to a null command under
1997 UNIX, and will convert files in distribution directory to UNIX format
1998 otherwise. Next it runs C<tar> on that directory into a tarfile and
1999 deletes the directory. Finishes with a command $(POSTOP) which
2000 defaults to a null command.
2004 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
2006 =item make uutardist
2008 Runs a tardist first and uuencodes the tarfile.
2012 First does a distdir. Then a command $(PREOP) which defaults to a null
2013 command. Next it runs C<shar> on that directory into a sharfile and
2014 deletes the intermediate directory again. Finishes with a command
2015 $(POSTOP) which defaults to a null command. Note: For shdist to work
2016 properly a C<shar> program that can handle directories is mandatory.
2020 First does a distdir. Then a command $(PREOP) which defaults to a null
2021 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
2022 zipfile. Then deletes that directory. Finishes with a command
2023 $(POSTOP) which defaults to a null command.
2027 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
2031 Customization of the dist targets can be done by specifying a hash
2032 reference to the dist attribute of the WriteMakefile call. The
2033 following parameters are recognized:
2036 COMPRESS ('gzip --best')
2039 TO_UNIX (depends on the system)
2040 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
2050 WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" })
2052 =head2 Disabling an extension
2054 If some events detected in F<Makefile.PL> imply that there is no way
2055 to create the Module, but this is a normal state of things, then you
2056 can create a F<Makefile> which does nothing, but succeeds on all the
2057 "usual" build targets. To do so, use
2059 ExtUtils::MakeMaker::WriteEmptyMakefile();
2061 instead of WriteMakefile().
2063 This may be useful if other modules expect this module to be I<built>
2064 OK, as opposed to I<work> OK (say, this system-dependent module builds
2065 in a subdirectory of some other distribution, or is listed as a
2066 dependency in a CPAN::Bundle, but the functionality is supported by
2067 different means on the current architecture).
2075 Command line options used by C<MakeMaker-E<gt>new()>, and thus by
2076 C<WriteMakefile()>. The string is split on whitespace, and the result
2077 is processed before any actual command line arguments are processed.
2083 ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib,
2084 ExtUtils::Install, ExtUtils::Embed
2088 Andy Dougherty <F<doughera@lafcol.lafayette.edu>>, Andreas KE<ouml>nig
2089 <F<andreas.koenig@mind.de>>, Tim Bunce <F<Tim.Bunce@ig.co.uk>>. VMS
2090 support by Charles Bailey <F<bailey@newman.upenn.edu>>. OS/2 support
2091 by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>.
2093 Send patches and bug reports to <F<perlbug@perl.org>>.