1 BEGIN {require 5.002;} # MakeMaker 5.17 was the last MakeMaker that was compatible with perl5.001m
3 package ExtUtils::MakeMaker;
6 $Version_OK = "5.17"; # Makefiles older than $Version_OK will die
7 # (Will be checked from MakeMaker version 4.13 onwards)
8 ($Revision = substr(q$Revision: 1.222 $, 10)) =~ s/\s+$//;
19 @ISA @EXPORT @EXPORT_OK $AUTOLOAD
20 $ISA_TTY $Is_Mac $Is_OS2 $Is_VMS $Revision $Setup_done
21 $VERSION $Verbose $Version_OK %Config %Keep_after_flush
22 %MM_Sections %Prepend_dot_dot %Recognized_Att_Keys
23 @Get_from_Config @MM_Sections @Overridable @Parent
28 # &DynaLoader::mod2fname should be available to miniperl, thus
29 # should be a pseudo-builtin (cmp. os2.c).
30 #eval {require DynaLoader;};
33 # Set up the inheritance before we pull in the MM_* packages, because they
34 # import variables and functions from here
37 @EXPORT = qw(&WriteMakefile &writeMakefile $Verbose &prompt);
38 @EXPORT_OK = qw($VERSION &Version_check &neatvalue &mkbootstrap &mksymlists);
41 # Dummy package MM inherits actual methods from OS-specific
42 # default packages. We use this intermediate package so
43 # MY::XYZ->func() can call MM->func() and get the proper
44 # default routine without having to know under what OS
47 @MM::ISA = qw[ExtUtils::MM_Unix ExtUtils::Liblist ExtUtils::MakeMaker];
50 # Setup dummy package:
51 # MY exists for overriding methods to be defined within
56 ### sub AUTOLOAD { use Devel::Symdump; print Devel::Symdump->rnew->as_string; Carp::confess "hey why? $AUTOLOAD" }
61 # "predeclare the package: we only load it via AUTOLOAD
62 # but we have already mentioned it in @ISA
63 package ExtUtils::Liblist;
65 package ExtUtils::MakeMaker;
67 # Now we can pull in the friends
69 $Is_VMS = $^O eq 'VMS';
70 $Is_OS2 = $^O eq 'os2';
71 $Is_Mac = $^O eq 'MacOS';
72 $Is_Win32 = $^O eq 'MSWin32';
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_Mac;
87 require ExtUtils::MM_Win32;
90 # The SelfLoader would bring a lot of overhead for MakeMaker, because
91 # we know for sure we will use most of the autoloaded functions once
92 # we have to use one of them. So we write our own loader
96 if (defined fileno(DATA)) {
98 my $o = $/; # For future reads from the file.
110 warn "AUTOLOAD called unexpectedly for $AUTOLOAD";
112 defined(&$AUTOLOAD) or die "Myloader inconsistency error";
116 # The only subroutine we do not SelfLoad is Version_Check because it's
117 # called so often. Loading this minimum still requires 1.2 secs on my
121 my($checkversion) = @_;
122 die "Your Makefile was built with ExtUtils::MakeMaker v $checkversion.
123 Current Version is $ExtUtils::MakeMaker::VERSION. There have been considerable
124 changes in the meantime.
125 Please rerun 'perl Makefile.PL' to regenerate the Makefile.\n"
126 if $checkversion < $Version_OK;
127 printf STDOUT "%s %s %s %s.\n", "Makefile built with ExtUtils::MakeMaker v",
128 $checkversion, "Current Version is", $VERSION
129 unless $checkversion == $VERSION;
133 $_[0] =~ /^Use of uninitialized value/ && return;
134 $_[0] =~ /used only once/ && return;
135 $_[0] =~ /^Subroutine\s+[\w:]+\s+redefined/ && return;
139 sub ExtUtils::MakeMaker::eval_in_subdirs ;
140 sub ExtUtils::MakeMaker::eval_in_x ;
141 sub ExtUtils::MakeMaker::full_setup ;
142 sub ExtUtils::MakeMaker::writeMakefile ;
143 sub ExtUtils::MakeMaker::new ;
144 sub ExtUtils::MakeMaker::check_manifest ;
145 sub ExtUtils::MakeMaker::parse_args ;
146 sub ExtUtils::MakeMaker::check_hints ;
147 sub ExtUtils::MakeMaker::mv_all_methods ;
148 sub ExtUtils::MakeMaker::skipcheck ;
149 sub ExtUtils::MakeMaker::flush ;
150 sub ExtUtils::MakeMaker::mkbootstrap ;
151 sub ExtUtils::MakeMaker::mksymlists ;
152 sub ExtUtils::MakeMaker::neatvalue ;
153 sub ExtUtils::MakeMaker::selfdocument ;
154 sub ExtUtils::MakeMaker::WriteMakefile ;
155 sub ExtUtils::MakeMaker::prompt ($;$) ;
161 package ExtUtils::MakeMaker;
164 Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
165 local $SIG{__WARN__} = \&warnhandler;
167 unless ($Setup_done++){
169 undef &ExtUtils::MakeMaker::full_setup; #safe memory
172 MM->new(\%att)->flush;
177 $ISA_TTY = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ; # Pipe?
178 Carp::confess("prompt function called without an argument") unless defined $mess;
179 my $dispdef = defined $def ? "[$def] " : " ";
180 $def = defined $def ? $def : "";
183 print "$mess $dispdef";
185 chomp($ans = <STDIN>);
189 return ($ans ne '') ? $ans : $def;
192 sub eval_in_subdirs {
198 foreach $dir (@{$self->{DIR}}){
199 my($abs) = $self->catdir($pwd,$dir);
200 $self->eval_in_x($abs);
208 chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
210 # my $fh = new FileHandle;
211 # $fh->open("Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
213 open(FH,"Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
214 # my $eval = join "", <$fh>;
215 my $eval = join "", <FH>;
220 # if ($@ =~ /prerequisites/) {
221 # die "MakeMaker WARNING: $@";
223 # warn "WARNING from evaluation of $dir/Makefile.PL: $@";
225 warn "WARNING from evaluation of $dir/Makefile.PL: $@";
233 # package name for the classes into which the first object will be blessed
234 $PACKNAME = "PACK000";
238 AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION
239 C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
240 EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE FULLPERL FUNCLIST H IMPORTS
241 INC INCLUDE_EXT INSTALLARCHLIB INSTALLBIN INSTALLDIRS INSTALLMAN1DIR
242 INSTALLMAN3DIR INSTALLPRIVLIB INSTALLSCRIPT INSTALLSITEARCH
243 INSTALLSITELIB INST_ARCHLIB INST_BIN INST_EXE INST_LIB
244 INST_MAN1DIR INST_MAN3DIR INST_SCRIPT LDFROM LIB LIBPERL_A LIBS
245 LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB
246 NAME NEEDS_LINKING NOECHO NORECURS NO_VC OBJECT OPTIMIZE PERL PERLMAINCC
247 PERL_ARCHLIB PERL_LIB PERL_SRC PERM_RW PERM_RWX
248 PL_FILES PM PMLIBDIRS PPM_INSTALL_EXEC PPM_INSTALL_SCRIPT PREFIX
249 PREREQ_PM SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
250 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
254 # IMPORTS is used under OS/2 and Win32
256 # @Overridable is close to @MM_Sections but not identical. The
257 # order is important. Many subroutines declare macros. These
258 # depend on each other. Let's try to collect the macros up front,
259 # then pasthru, then the rules.
261 # MM_Sections are the sections we have to call explicitly
262 # in Overridable we have subroutines that are used indirectly
268 post_initialize const_config constants tool_autosplit tool_xsubpp
269 tools_other dist macro depend cflags const_loadlibs const_cccmd
274 c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs
275 dynamic_lib static static_lib manifypods processPL installbin subdirs
276 clean realclean dist_basics dist_core dist_dir dist_test dist_ci
277 install force perldepend makefile staticmake test ppd
279 ); # loses section ordering
281 @Overridable = @MM_Sections;
282 push @Overridable, qw[
284 dir_target libscan makeaperl needs_linking perm_rw perm_rwx
285 subdir_x test_via_harness test_via_script
289 push @MM_Sections, qw[
291 pm_to_blib selfdocument
295 # Postamble needs to be the last that was always the case
296 push @MM_Sections, "postamble";
297 push @Overridable, "postamble";
299 # All sections are valid keys.
300 @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
302 # we will use all these variables in the Makefile
305 ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc
306 lib_ext obj_ext osname osvers ranlib sitelibexp sitearchexp so exe_ext
310 foreach $item (@Attrib_help){
311 $Recognized_Att_Keys{$item} = 1;
313 foreach $item (@Get_from_Config) {
314 $Recognized_Att_Keys{uc $item} = $Config{$item};
315 print "Attribute '\U$item\E' => '$Config{$item}'\n"
320 # When we eval a Makefile.PL in a subdirectory, that one will ask
321 # us (the parent) for the values and will prepend "..", so that
322 # all files to be installed end up below OUR ./blib
327 INST_BIN 1 INST_EXE 1 INST_LIB 1 INST_ARCHLIB 1 INST_SCRIPT
328 1 MAP_TARGET 1 INST_MAN1DIR 1 INST_MAN3DIR 1 PERL_SRC 1
334 NEEDS_LINKING HAS_LINK_CODE
336 @Keep_after_flush{@keep} = (1) x @keep;
342 The extension you are trying to build apparently is rather old and
343 most probably outdated. We detect that from the fact, that a
344 subroutine "writeMakefile" is called, and this subroutine is not
345 supported anymore since about October 1994.
347 Please contact the author or look into CPAN (details about CPAN can be
348 found in the FAQ and at http:/www.perl.com) for a more recent version
349 of the extension. If you're really desperate, you can try to change
350 the subroutine name from writeMakefile to WriteMakefile and rerun
351 'perl Makefile.PL', but you're most probably left alone, when you do
359 sub ExtUtils::MakeMaker::new {
360 my($class,$self) = @_;
363 print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
364 if (-f "MANIFEST" && ! -f "Makefile"){
368 $self = {} unless (defined $self);
372 my(%initial_att) = %$self; # record initial attributes
375 foreach $prereq (sort keys %{$self->{PREREQ_PM}}) {
376 my $eval = "use $prereq $self->{PREREQ_PM}->{$prereq}";
379 warn "Warning: prerequisite $prereq $self->{PREREQ_PM}->{$prereq} not found";
380 # Why is/was this 'delete' here? We need PREREQ_PM later to make PPDs.
382 # delete $self->{PREREQ_PM}{$prereq};
386 # unless (defined $ExtUtils::MakeMaker::useCPAN) {
387 # print qq{MakeMaker WARNING: prerequisites not found (@unsatisfied)
388 # Please install these modules first and rerun 'perl Makefile.PL'.\n};
389 # if ($ExtUtils::MakeMaker::hasCPAN) {
390 # $ExtUtils::MakeMaker::useCPAN = prompt(qq{Should I try to use the CPAN module to fetch them for you?},"yes");
392 # print qq{Hint: You may want to install the CPAN module to autofetch the needed modules\n};
393 # $ExtUtils::MakeMaker::useCPAN=0;
396 # if ($ExtUtils::MakeMaker::useCPAN) {
398 # CPAN->import(@unsatisfied);
400 # die qq{prerequisites not found (@unsatisfied)};
402 # warn qq{WARNING: prerequisites not found (@unsatisfied)};
405 if (defined $self->{CONFIGURE}) {
406 if (ref $self->{CONFIGURE} eq 'CODE') {
407 $self = { %$self, %{&{$self->{CONFIGURE}}}};
409 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
413 # This is for old Makefiles written pre 5.00, will go away
414 if ( Carp::longmess("") =~ /runsubdirpl/s ){
415 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
418 my $newclass = ++$PACKNAME;
419 local @Parent = @Parent; # Protect against non-local exits
422 print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
423 mv_all_methods("MY",$newclass);
424 bless $self, $newclass;
426 @{"$newclass\:\:ISA"} = 'MM';
429 if (defined $Parent[-2]){
430 $self->{PARENT} = $Parent[-2];
432 for $key (keys %Prepend_dot_dot) {
433 next unless defined $self->{PARENT}{$key};
434 $self->{$key} = $self->{PARENT}{$key};
435 # PERL and FULLPERL may be command verbs instead of full
436 # file specifications under VMS. If so, don't turn them
438 $self->{$key} = $self->catdir("..",$self->{$key})
439 unless $self->file_name_is_absolute($self->{$key})
440 || ($^O eq 'VMS' and ($key =~ /PERL$/ && $self->{$key} =~ /^[\w\-\$]+$/));
442 if ($self->{PARENT}) {
443 $self->{PARENT}->{CHILDREN}->{$newclass} = $self;
444 if (exists $self->{PARENT}->{CAPI}
445 and not exists $self->{CAPI})
447 # inherit, but only if already unspecified
448 $self->{CAPI} = $self->{PARENT}->{CAPI};
452 parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV);
455 $self->{NAME} ||= $self->guess_name;
457 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
461 if (! $self->{PERL_SRC} ) {
462 my($pthinks) = $self->canonpath($INC{'Config.pm'});
463 my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
464 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
465 if ($pthinks ne $cthinks &&
466 !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
467 print "Have $pthinks expected $cthinks\n";
469 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
472 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
475 Your perl and your Config.pm seem to have different ideas about the architecture
477 Perl thinks: [$pthinks]
478 Config says: [$Config{archname}]
479 This may or may not cause problems. Please check your installation of perl if you
480 have problems building this extension.
485 $self->init_dirscan();
486 $self->init_others();
487 my($argv) = neatvalue(\@ARGV);
491 push @{$self->{RESULT}}, <<END;
492 # This Makefile is for the $self->{NAME} extension to perl.
494 # It was generated automatically by MakeMaker version
495 # $VERSION (Revision: $Revision) from the contents of
496 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
498 # ANY CHANGES MADE HERE WILL BE LOST!
500 # MakeMaker ARGV: $argv
502 # MakeMaker Parameters:
505 foreach $key (sort keys %initial_att){
506 my($v) = neatvalue($initial_att{$key});
507 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
509 push @{$self->{RESULT}}, "# $key => $v";
512 # turn the SKIP array into a SKIPHASH hash
514 for $skip (@{$self->{SKIP} || []}) {
515 $self->{SKIPHASH}{$skip} = 1;
517 delete $self->{SKIP}; # free memory
519 if ($self->{PARENT}) {
520 for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
521 $self->{SKIPHASH}{$_} = 1;
525 # We run all the subdirectories now. They don't have much to query
526 # from the parent, but the parent has to query them: if they need linking!
527 unless ($self->{NORECURS}) {
528 $self->eval_in_subdirs if @{$self->{DIR}};
532 foreach $section ( @MM_Sections ){
533 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
534 my($skipit) = $self->skipcheck($section);
536 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
538 my(%a) = %{$self->{$section} || {}};
539 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
540 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
541 push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
545 push @{$self->{RESULT}}, "\n# End.";
550 sub WriteEmptyMakefile {
551 if (-f 'Makefile.old') {
552 chmod 0666, 'Makefile.old';
553 unlink 'Makefile.old' or warn "unlink Makefile.old: $!";
555 rename 'Makefile', 'Makefile.old' or warn "rename Makefile Makefile.old: $!"
557 open MF, '> Makefile' or die "open Makefile for write: $!";
570 close MF or die "close Makefile for write: $!";
574 print STDOUT "Checking if your kit is complete...\n";
575 require ExtUtils::Manifest;
576 $ExtUtils::Manifest::Quiet=$ExtUtils::Manifest::Quiet=1; #avoid warning
577 my(@missed)=ExtUtils::Manifest::manicheck();
579 print STDOUT "Warning: the following files are missing in your kit:\n";
580 print "\t", join "\n\t", @missed;
582 print STDOUT "Please inform the author.\n";
584 print STDOUT "Looks good\n";
589 my($self, @args) = @_;
591 unless (m/(.*?)=(.*)/){
592 help(),exit 1 if m/^help$/;
593 ++$Verbose if m/^verb/;
596 my($name, $value) = ($1, $2);
597 if ($value =~ m/^~(\w+)?/){ # tilde with optional username
598 $value =~ s [^~(\w*)]
600 ((getpwnam($1))[7] || "~$1") :
604 $self->{uc($name)} = $value;
607 # catch old-style 'potential_libs' and inform user how to 'upgrade'
608 if (defined $self->{potential_libs}){
609 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
610 if ($self->{potential_libs}){
611 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
613 print STDOUT "$msg deleted.\n";
615 $self->{LIBS} = [$self->{potential_libs}];
616 delete $self->{potential_libs};
618 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
619 if (defined $self->{ARMAYBE}){
620 my($armaybe) = $self->{ARMAYBE};
621 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
622 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
623 my(%dl) = %{$self->{dynamic_lib} || {}};
624 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
625 delete $self->{ARMAYBE};
627 if (defined $self->{LDTARGET}){
628 print STDOUT "LDTARGET should be changed to LDFROM\n";
629 $self->{LDFROM} = $self->{LDTARGET};
630 delete $self->{LDTARGET};
632 # Turn a DIR argument on the command line into an array
633 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
634 # So they can choose from the command line, which extensions they want
635 # the grep enables them to have some colons too much in case they
636 # have to build a list with the shell
637 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
639 # Turn a INCLUDE_EXT argument on the command line into an array
640 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
641 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
643 # Turn a EXCLUDE_EXT argument on the command line into an array
644 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
645 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
648 foreach $mmkey (sort keys %$self){
649 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
650 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
651 unless exists $Recognized_Att_Keys{$mmkey};
658 # We allow extension-specific hints files.
660 return unless -d "hints";
662 # First we look for the best hintsfile we have
664 my($hint)="${^O}_$Config{osvers}";
669 # Also try without trailing minor version numbers.
671 last if -f "hints/$hint.pl"; # found
673 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
675 return unless -f "hints/$hint.pl"; # really there
677 # execute the hintsfile:
679 # my $fh = new FileHandle;
680 # $fh->open("hints/$hint.pl");
682 open(FH,"hints/$hint.pl");
683 # @goodhints = <$fh>;
687 print STDOUT "Processing hints file hints/$hint.pl\n";
688 eval join('',@goodhints);
689 print STDOUT $@ if $@;
695 my($symtab) = \%{"${from}::"};
698 # Here you see the *current* list of methods that are overridable
699 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
700 # still trying to reduce the list to some reasonable minimum --
701 # because I want to make it easier for the user. A.K.
703 foreach $method (@Overridable) {
705 # We cannot say "next" here. Nick might call MY->makeaperl
706 # which isn't defined right now
708 # Above statement was written at 4.23 time when Tk-b8 was
709 # around. As Tk-b9 only builds with 5.002something and MM 5 is
710 # standard, we try to enable the next line again. It was
711 # commented out until MM 5.23
713 next unless defined &{"${from}::$method"};
715 *{"${to}::$method"} = \&{"${from}::$method"};
717 # delete would do, if we were sure, nobody ever called
718 # MY->makeaperl directly
720 # delete $symtab->{$method};
722 # If we delete a method, then it will be undefined and cannot
723 # be called. But as long as we have Makefile.PLs that rely on
724 # %MY:: being intact, we have to fill the hole with an
727 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
730 # We have to clean out %INC also, because the current directory is
731 # changed frequently and Graham Barr prefers to get his version
732 # out of a History.pl file which is "required" so woudn't get
733 # loaded again in another extension requiring a History.pl
735 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
736 # to core dump in the middle of a require statement. The required
737 # file was Tk/MMutil.pm. The consequence is, we have to be
738 # extremely careful when we try to give perl a reason to reload a
739 # library with same name. The workaround prefers to drop nothing
740 # from %INC and teach the writers not to use such libraries.
743 # foreach $inc (keys %INC) {
744 # #warn "***$inc*** deleted";
752 if ($section eq 'dynamic') {
753 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
754 "in skipped section 'dynamic_bs'\n"
755 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
756 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
757 "in skipped section 'dynamic_lib'\n"
758 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
760 if ($section eq 'dynamic_lib') {
761 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
762 "targets in skipped section 'dynamic_bs'\n"
763 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
765 if ($section eq 'static') {
766 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
767 "in skipped section 'static_lib'\n"
768 if $self->{SKIPHASH}{static_lib} && $Verbose;
770 return 'skipped' if $self->{SKIPHASH}{$section};
778 # my $fh = new FileHandle;
780 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
782 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
783 # $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
784 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
786 for $chunk (@{$self->{RESULT}}) {
787 # print $fh "$chunk\n";
793 my($finalname) = $self->{MAKEFILE};
794 rename("MakeMaker.tmp", $finalname);
795 chmod 0644, $finalname unless $Is_VMS;
797 if ($self->{PARENT}) {
798 foreach (keys %$self) { # safe memory
799 delete $self->{$_} unless $Keep_after_flush{$_};
803 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
806 # The following mkbootstrap() is only for installations that are calling
807 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
808 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
811 !!! Your Makefile has been built such a long time ago, !!!
812 !!! that is unlikely to work with current MakeMaker. !!!
813 !!! Please rebuild your Makefile !!!
817 # Ditto for mksymlists() as of MakeMaker 5.17
820 !!! Your Makefile has been built such a long time ago, !!!
821 !!! that is unlikely to work with current MakeMaker. !!!
822 !!! Please rebuild your Makefile !!!
828 return "undef" unless defined $v;
830 return "q[$v]" unless $t;
832 my(@m, $elem, @neat);
834 foreach $elem (@$v) {
835 push @neat, "q[$elem]";
837 push @m, join ", ", @neat;
841 return "$v" unless $t eq 'HASH';
843 while (($key,$val) = each %$v){
844 last unless defined $key; # cautious programming in case (undef,undef) is true
845 push(@m,"$key=>".neatvalue($val)) ;
847 return "{ ".join(', ',@m)." }";
854 push @m, "\n# Full list of MakeMaker attribute values:";
855 foreach $key (sort keys %$self){
856 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
857 my($v) = neatvalue($self->{$key});
858 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
860 push @m, "# $key => $v";
866 package ExtUtils::MakeMaker;
873 ExtUtils::MakeMaker - create an extension Makefile
877 C<use ExtUtils::MakeMaker;>
879 C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
883 C<MM-E<gt>new(\%att)-E<gt>flush;>
887 This utility is designed to write a Makefile for an extension module
888 from a Makefile.PL. It is based on the Makefile.SH model provided by
889 Andy Dougherty and the perl5-porters.
891 It splits the task of generating the Makefile into several subroutines
892 that can be individually overridden. Each subroutine returns the text
893 it wishes to have written to the Makefile.
895 MakeMaker is object oriented. Each directory below the current
896 directory that contains a Makefile.PL. Is treated as a separate
897 object. This makes it possible to write an unlimited number of
898 Makefiles with a single invocation of WriteMakefile().
900 =head2 How To Write A Makefile.PL
902 The short answer is: Don't.
904 Always begin with h2xs.
905 Always begin with h2xs!
906 ALWAYS BEGIN WITH H2XS!
908 even if you're not building around a header file, and even if you
909 don't have an XS component.
911 Run h2xs(1) before you start thinking about writing a module. For so
912 called pm-only modules that consist of C<*.pm> files only, h2xs has
913 the C<-X> switch. This will generate dummy files of all kinds that are
914 useful for the module developer.
916 The medium answer is:
918 use ExtUtils::MakeMaker;
919 WriteMakefile( NAME => "Foo::Bar" );
921 The long answer is the rest of the manpage :-)
923 =head2 Default Makefile Behaviour
925 The generated Makefile enables the user of the extension to invoke
927 perl Makefile.PL # optionally "perl Makefile.PL verbose"
929 make test # optionally set TEST_VERBOSE=1
930 make install # See below
932 The Makefile to be produced may be altered by adding arguments of the
933 form C<KEY=VALUE>. E.g.
935 perl Makefile.PL PREFIX=/tmp/myperl5
937 Other interesting targets in the generated Makefile are
939 make config # to check if the Makefile is up-to-date
940 make clean # delete local temp files (Makefile gets renamed)
941 make realclean # delete derived files (including ./blib)
942 make ci # check in all the files in the MANIFEST file
943 make dist # see below the Distribution Support section
947 MakeMaker checks for the existence of a file named F<test.pl> in the
948 current directory and if it exists it adds commands to the test target
949 of the generated Makefile that will execute the script with the proper
950 set of perl C<-I> options.
952 MakeMaker also checks for any files matching glob("t/*.t"). It will
953 add commands to the test target of the generated Makefile that execute
954 all matching files via the L<Test::Harness> module with the C<-I>
955 switches set correctly.
959 A useful variation of the above is the target C<testdb>. It runs the
960 test under the Perl debugger (see L<perldebug>). If the file
961 F<test.pl> exists in the current directory, it is used for the test.
963 If you want to debug some other testfile, set C<TEST_FILE> variable
966 make testdb TEST_FILE=t/mytest.t
968 By default the debugger is called using C<-d> option to perl. If you
969 want to specify some other option, set C<TESTDB_SW> variable:
971 make testdb TESTDB_SW=-Dx
975 make alone puts all relevant files into directories that are named by
976 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_MAN1DIR, and
977 INST_MAN3DIR. All these default to something below ./blib if you are
978 I<not> building below the perl source directory. If you I<are>
979 building below the perl source, INST_LIB and INST_ARCHLIB default to
980 ../../lib, and INST_SCRIPT is not defined.
982 The I<install> target of the generated Makefile copies the files found
983 below each of the INST_* directories to their INSTALL*
984 counterparts. Which counterparts are chosen depends on the setting of
985 INSTALLDIRS according to the following table:
990 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH
991 INST_LIB INSTALLPRIVLIB INSTALLSITELIB
993 INST_SCRIPT INSTALLSCRIPT
994 INST_MAN1DIR INSTALLMAN1DIR
995 INST_MAN3DIR INSTALLMAN3DIR
997 The INSTALL... macros in turn default to their %Config
998 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
1000 You can check the values of these variables on your system with
1004 And to check the sequence in which the library directories are
1005 searched by perl, run
1007 perl -le 'print join $/, @INC'
1010 =head2 PREFIX and LIB attribute
1012 PREFIX and LIB can be used to set several INSTALL* attributes in one
1013 go. The quickest way to install a module in a non-standard place might
1016 perl Makefile.PL LIB=~/lib
1018 This will install the module's architecture-independent files into
1019 ~/lib, the architecture-dependent files into ~/lib/$archname/auto.
1021 Another way to specify many INSTALL directories with a single
1022 parameter is PREFIX.
1024 perl Makefile.PL PREFIX=~
1026 This will replace the string specified by $Config{prefix} in all
1027 $Config{install*} values.
1029 Note, that in both cases the tilde expansion is done by MakeMaker, not
1030 by perl by default, nor by make. Conflicts between parameters LIB,
1031 PREFIX and the various INSTALL* arguments are resolved so that
1034 If the user has superuser privileges, and is not working on AFS
1035 (Andrew File System) or relatives, then the defaults for
1036 INSTALLPRIVLIB, INSTALLARCHLIB, INSTALLSCRIPT, etc. will be appropriate,
1037 and this incantation will be the best:
1039 perl Makefile.PL; make; make test
1042 make install per default writes some documentation of what has been
1043 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1044 can be bypassed by calling make pure_install.
1048 will have to specify the installation directories as these most
1049 probably have changed since perl itself has been installed. They will
1050 have to do this by calling
1052 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1053 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1056 Be careful to repeat this procedure every time you recompile an
1057 extension, unless you are sure the AFS installation directories are
1060 =head2 Static Linking of a new Perl Binary
1062 An extension that is built with the above steps is ready to use on
1063 systems supporting dynamic loading. On systems that do not support
1064 dynamic loading, any newly created extension has to be linked together
1065 with the available resources. MakeMaker supports the linking process
1066 by creating appropriate targets in the Makefile whenever an extension
1067 is built. You can invoke the corresponding section of the makefile with
1071 That produces a new perl binary in the current directory with all
1072 extensions linked in that can be found in INST_ARCHLIB , SITELIBEXP,
1073 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1074 UNIX, this is called Makefile.aperl (may be system dependent). If you
1075 want to force the creation of a new perl, it is recommended, that you
1076 delete this Makefile.aperl, so the directories are searched-through
1077 for linkable libraries again.
1079 The binary can be installed into the directory where perl normally
1080 resides on your machine with
1084 To produce a perl binary with a different name than C<perl>, either say
1086 perl Makefile.PL MAP_TARGET=myperl
1093 make myperl MAP_TARGET=myperl
1094 make inst_perl MAP_TARGET=myperl
1096 In any case you will be prompted with the correct invocation of the
1097 C<inst_perl> target that installs the new binary into INSTALLBIN.
1099 make inst_perl per default writes some documentation of what has been
1100 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1101 can be bypassed by calling make pure_inst_perl.
1103 Warning: the inst_perl: target will most probably overwrite your
1104 existing perl binary. Use with care!
1106 Sometimes you might want to build a statically linked perl although
1107 your system supports dynamic loading. In this case you may explicitly
1108 set the linktype with the invocation of the Makefile.PL or make:
1110 perl Makefile.PL LINKTYPE=static # recommended
1114 make LINKTYPE=static # works on most systems
1116 =head2 Determination of Perl Library and Installation Locations
1118 MakeMaker needs to know, or to guess, where certain things are
1119 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1120 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1121 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1123 Extensions may be built either using the contents of the perl source
1124 directory tree or from the installed perl library. The recommended way
1125 is to build extensions after you have run 'make install' on perl
1126 itself. You can do that in any directory on your hard disk that is not
1127 below the perl source tree. The support for extensions below the ext
1128 directory of the perl distribution is only good for the standard
1129 extensions that come with perl.
1131 If an extension is being built below the C<ext/> directory of the perl
1132 source then MakeMaker will set PERL_SRC automatically (e.g.,
1133 C<../..>). If PERL_SRC is defined and the extension is recognized as
1134 a standard extension, then other variables default to the following:
1137 PERL_LIB = PERL_SRC/lib
1138 PERL_ARCHLIB = PERL_SRC/lib
1140 INST_ARCHLIB = PERL_ARCHLIB
1142 If an extension is being built away from the perl source then MakeMaker
1143 will leave PERL_SRC undefined and default to using the installed copy
1144 of the perl library. The other variables default to the following:
1146 PERL_INC = $archlibexp/CORE
1147 PERL_LIB = $privlibexp
1148 PERL_ARCHLIB = $archlibexp
1149 INST_LIB = ./blib/lib
1150 INST_ARCHLIB = ./blib/arch
1152 If perl has not yet been installed then PERL_SRC can be defined on the
1153 command line as shown in the previous section.
1156 =head2 Which architecture dependent directory?
1158 If you don't want to keep the defaults for the INSTALL* macros,
1159 MakeMaker helps you to minimize the typing needed: the usual
1160 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1161 by Configure at perl compilation time. MakeMaker supports the user who
1162 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1163 then MakeMaker defaults the latter to be the same subdirectory of
1164 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1165 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1166 for INSTALLSITELIB and INSTALLSITEARCH.
1168 MakeMaker gives you much more freedom than needed to configure
1169 internal variables and get different results. It is worth to mention,
1170 that make(1) also lets you configure most of the variables that are
1171 used in the Makefile. But in the majority of situations this will not
1172 be necessary, and should only be done, if the author of a package
1173 recommends it (or you know what you're doing).
1175 =head2 Using Attributes and Parameters
1177 The following attributes can be specified as arguments to WriteMakefile()
1178 or as NAME=VALUE pairs on the command line:
1184 String containing name (and email address) of package author(s). Is used
1185 in PPD (Perl Package Description) files for PPM (Perl Package Manager).
1189 One line description of the module. Will be included in PPD file.
1193 Name of the file that contains the package description. MakeMaker looks
1194 for a line in the POD matching /^($package\s-\s)(.*)/. This is typically
1195 the first line in the "=head1 NAME" section. $2 becomes the abstract.
1197 =item BINARY_LOCATION
1199 Used when creating PPD files for binary packages. It can be set to a
1200 full or relative path or URL to the binary archive for a particular
1201 architecture. For example:
1203 perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
1205 builds a PPD package that references a binary of the C<Agent> package,
1206 located in the C<x86> directory relative to the PPD itself.
1210 Ref to array of *.c file names. Initialised from a directory scan
1211 and the values portion of the XS attribute hash. This is not
1212 currently used by MakeMaker but may be handy in Makefile.PLs.
1216 Switch to force usage of the Perl C API even when compiling for PERL_OBJECT.
1218 Note that this attribute is passed through to any recursive build,
1219 but if and only if the submodule's Makefile.PL itself makes no mention
1220 of the 'CAPI' attribute.
1224 String that will be included in the compiler call command line between
1225 the arguments INC and OPTIMIZE.
1229 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1230 config.sh. MakeMaker will add to CONFIG the following values anyway:
1250 CODE reference. The subroutine should return a hash reference. The
1251 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1252 be determined by some evaluation method.
1256 Something like C<"-DHAVE_UNISTD_H">
1260 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1265 Your name for distributing the package (by tar file). This defaults to
1270 Hashref of symbol names for routines to be made available as universal
1271 symbols. Each key/value pair consists of the package name and an
1272 array of routine names in that package. Used only under AIX, OS/2,
1273 VMS and Win32 at present. The routine names supplied will be expanded
1274 in the same way as XSUB names are expanded by the XS() macro.
1277 {"$(NAME)" => ["boot_$(NAME)" ] }
1281 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1282 "NetconfigPtr" => [ 'DESTROY'] }
1284 Please see the L<ExtUtils::Mksymlists> documentation for more information
1285 about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
1289 Array of symbol names for variables to be made available as universal symbols.
1290 Used only under AIX, OS/2, VMS and Win32 at present. Defaults to [].
1291 (e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
1295 Array of extension names to exclude when doing a static build. This
1296 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1297 details. (e.g. [ qw( Socket POSIX ) ] )
1299 This attribute may be most useful when specified as a string on the
1300 command line: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1304 Ref to array of executable files. The files will be copied to the
1305 INST_SCRIPT directory. Make realclean will delete them from there
1308 =item FIRST_MAKEFILE
1310 The name of the Makefile to be produced. Defaults to the contents of
1311 MAKEFILE, but can be overridden. This is used for the second Makefile
1312 that will be produced for the MAP_TARGET.
1316 Perl binary able to run this extension.
1320 This provides an alternate means to specify function names to be
1321 exported from the extension. Its value is a reference to an
1322 array of function names to be exported by the extension. These
1323 names are passed through unaltered to the linker options file.
1327 Ref to array of *.h file names. Similar to C.
1331 This attribute is used to specify names to be imported into the
1332 extension. It is only used on OS/2 and Win32.
1336 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1340 Array of extension names to be included when doing a static build.
1341 MakeMaker will normally build with all of the installed extensions when
1342 doing a static build, and that is usually the desired behavior. If
1343 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1344 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1346 It is not necessary to mention DynaLoader or the current extension when
1347 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1348 only DynaLoader and the current extension will be included in the build.
1350 This attribute may be most useful when specified as a string on the
1351 command line: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1353 =item INSTALLARCHLIB
1355 Used by 'make install', which copies files from INST_ARCHLIB to this
1356 directory if INSTALLDIRS is set to perl.
1360 Directory to install binary files (e.g. tkperl) into.
1364 Determines which of the two sets of installation directories to
1365 choose: installprivlib and installarchlib versus installsitelib and
1366 installsitearch. The first pair is chosen with INSTALLDIRS=perl, the
1367 second with INSTALLDIRS=site. Default is site.
1369 =item INSTALLMAN1DIR
1371 This directory gets the man pages at 'make install' time. Defaults to
1372 $Config{installman1dir}.
1374 =item INSTALLMAN3DIR
1376 This directory gets the man pages at 'make install' time. Defaults to
1377 $Config{installman3dir}.
1379 =item INSTALLPRIVLIB
1381 Used by 'make install', which copies files from INST_LIB to this
1382 directory if INSTALLDIRS is set to perl.
1386 Used by 'make install' which copies files from INST_SCRIPT to this
1389 =item INSTALLSITEARCH
1391 Used by 'make install', which copies files from INST_ARCHLIB to this
1392 directory if INSTALLDIRS is set to site (default).
1394 =item INSTALLSITELIB
1396 Used by 'make install', which copies files from INST_LIB to this
1397 directory if INSTALLDIRS is set to site (default).
1401 Same as INST_LIB for architecture dependent files.
1405 Directory to put real binary files during 'make'. These will be copied
1406 to INSTALLBIN during 'make install'
1410 Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you
1415 Directory where we put library files of this extension while building
1420 Directory to hold the man pages at 'make' time
1424 Directory to hold the man pages at 'make' time
1428 Directory, where executable files should be installed during
1429 'make'. Defaults to "./blib/bin", just to have a dummy location during
1430 testing. make install will copy the files in INST_SCRIPT to
1435 defaults to "$(OBJECT)" and is used in the ld command to specify
1436 what files to link/load from (also see dynamic_lib below for how to
1441 LIB can only be set at C<perl Makefile.PL> time. It has the effect of
1442 setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any
1446 The filename of the perllibrary that will be used together with this
1447 extension. Defaults to libperl.a.
1451 An anonymous array of alternative library
1452 specifications to be searched for (in order) until
1453 at least one library is found. E.g.
1455 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1457 Mind, that any element of the array
1458 contains a complete set of arguments for the ld
1459 command. So do not specify
1461 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1463 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1464 you specify a scalar as in
1466 'LIBS' => "-ltcl -ltk -lX11"
1468 MakeMaker will turn it into an array with one element.
1472 'static' or 'dynamic' (default unless usedl=undef in
1473 config.sh). Should only be used to force static linking (also see
1478 Boolean which tells MakeMaker, that it should include the rules to
1479 make a perl. This is handled automatically as a switch by
1480 MakeMaker. The user normally does not need it.
1484 The name of the Makefile to be produced.
1488 Hashref of pod-containing files. MakeMaker will default this to all
1489 EXE_FILES files that include POD directives. The files listed
1490 here will be converted to man pages and installed as was requested
1495 Hashref of .pm and .pod files. MakeMaker will default this to all
1496 .pod and any .pm files that include POD directives. The files listed
1497 here will be converted to man pages and installed as was requested
1502 If it is intended, that a new perl binary be produced, this variable
1503 may hold a name for that binary. Defaults to perl
1507 If the extension links to a library that it builds set this to the
1508 name of the library (see SDBM_File)
1512 Perl module name for this extension (DBD::Oracle). This will default
1513 to the directory name but should be explicitly defined in the
1518 MakeMaker will figure out, if an extension contains linkable code
1519 anywhere down the directory tree, and will set this variable
1520 accordingly, but you can speed it up a very little bit, if you define
1521 this boolean variable yourself.
1525 Defaults to C<@>. By setting it to an empty string you can generate a
1526 Makefile that echos all commands. Mainly used in debugging MakeMaker
1531 Boolean. Attribute to inhibit descending into subdirectories.
1535 In general any generated Makefile checks for the current version of
1536 MakeMaker and the version the Makefile was built under. If NO_VC is
1537 set, the version check is neglected. Do not write this into your
1538 Makefile.PL, use it interactively instead.
1542 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1543 string containing all object files, e.g. "tkpBind.o
1544 tkpButton.o tkpCanvas.o"
1548 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1549 passed to subdirectory makes.
1553 Perl binary for tasks that can be done by miniperl
1557 The call to the program that is able to compile perlmain.c. Defaults
1562 Same as above for architecture dependent files
1566 Directory containing the Perl library to use.
1570 Directory containing the Perl source code (use of this should be
1571 avoided, it may be undefined)
1575 Desired permission for read/writable files. Defaults to C<644>.
1576 See also L<MM_Unix/perm_rw>.
1580 Desired permission for executable files. Defaults to C<755>.
1581 See also L<MM_Unix/perm_rwx>.
1585 Ref to hash of files to be processed as perl programs. MakeMaker
1586 will default to any found *.PL file (except Makefile.PL) being keys
1587 and the basename of the file being the value. E.g.
1589 {'foobar.PL' => 'foobar'}
1591 The *.PL files are expected to produce output to the target files
1592 themselves. If multiple files can be generated from the same *.PL
1593 file then the value in the hash can be a reference to an array of
1594 target file names. E.g.
1596 {'foobar.PL' => ['foobar1','foobar2']}
1600 Hashref of .pm files and *.pl files to be installed. e.g.
1602 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1604 By default this will include *.pm and *.pl and the files found in
1605 the PMLIBDIRS directories. Defining PM in the
1606 Makefile.PL will override PMLIBDIRS.
1610 Ref to array of subdirectories containing library files. Defaults to
1611 [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
1612 they contain will be installed in the corresponding location in the
1613 library. A libscan() method can be used to alter the behaviour.
1614 Defining PM in the Makefile.PL will override PMLIBDIRS.
1616 =item PPM_INSTALL_EXEC
1618 Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl)
1620 =item PPM_INSTALL_SCRIPT
1622 Name of the script that gets executed by the Perl Package Manager after
1623 the installation of a package.
1627 Can be used to set the three INSTALL* attributes in one go (except for
1628 probably INSTALLMAN1DIR, if it is not below PREFIX according to
1629 %Config). They will have PREFIX as a common directory node and will
1630 branch from that node into lib/, lib/ARCHNAME or whatever Configure
1631 decided at the build time of your perl (unless you override one of
1636 Hashref: Names of modules that need to be available to run this
1637 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1638 desired version is the value. If the required version number is 0, we
1639 only check if any version is installed already.
1643 Arryref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1644 Makefile. Caution! Do not use the SKIP attribute for the neglectible
1645 speedup. It may seriously damage the resulting Makefile. Only use it,
1646 if you really need it.
1650 Ref to array of typemap file names. Use this when the typemaps are
1651 in some directory other than the current directory or when they are
1652 not named B<typemap>. The last typemap in the list takes
1653 precedence. A typemap in the current directory has highest
1654 precedence, even if it isn't listed in TYPEMAPS. The default system
1655 typemap has lowest precedence.
1659 Your version number for distributing the package. This defaults to
1664 Instead of specifying the VERSION in the Makefile.PL you can let
1665 MakeMaker parse a file to determine the version number. The parsing
1666 routine requires that the file named by VERSION_FROM contains one
1667 single line to compute the version number. The first line in the file
1668 that contains the regular expression
1670 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
1672 will be evaluated with eval() and the value of the named variable
1673 B<after> the eval() will be assigned to the VERSION attribute of the
1674 MakeMaker object. The following lines will be parsed o.k.:
1678 ( $VERSION ) = '$Revision: 1.222 $ ' =~ /\$Revision:\s+([^\s]+)/;
1679 $FOO::VERSION = '1.10';
1680 *FOO::VERSION = \'1.11';
1682 but these will fail:
1684 my $VERSION = '1.01';
1685 local $VERSION = '1.02';
1686 local $FOO::VERSION = '1.30';
1688 The file named in VERSION_FROM is not added as a dependency to
1689 Makefile. This is not really correct, but it would be a major pain
1690 during development to have to rewrite the Makefile for any smallish
1691 change in that file. If you want to make sure that the Makefile
1692 contains the correct VERSION macro after any change of the file, you
1693 would have to do something like
1695 depend => { Makefile => '$(VERSION_FROM)' }
1697 See attribute C<depend> below.
1701 Hashref of .xs files. MakeMaker will default this. e.g.
1703 {'name_of_file.xs' => 'name_of_file.c'}
1705 The .c files will automatically be included in the list of files
1706 deleted by a make clean.
1710 String of options to pass to xsubpp. This might include C<-C++> or
1711 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
1716 May be set to an empty string, which is identical to C<-prototypes>, or
1717 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
1718 defaults to the empty string.
1722 Your version number for the .xs file of this package. This defaults
1723 to the value of the VERSION attribute.
1727 =head2 Additional lowercase attributes
1729 can be used to pass parameters to the methods which implement that
1730 part of the Makefile.
1736 {FILES => "*.xyz foo"}
1740 {ANY_TARGET => ANY_DEPENDECY, ...}
1744 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
1745 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
1746 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
1748 If you specify COMPRESS, then SUFFIX should also be altered, as it is
1749 needed to tell make the target file of the compression. Setting
1750 DIST_CP to ln can be useful, if you need to preserve the timestamps on
1751 your files. DIST_CP can take the values 'cp', which copies the file,
1752 'ln', which links the file, and 'best' which copies symbolic links and
1753 links the rest. Default is 'best'.
1757 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
1761 {LINKTYPE => 'static', 'dynamic' or ''}
1763 NB: Extensions that have nothing but *.pm files had to say
1767 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1768 can be deleted safely. MakeMaker recognizes, when there's nothing to
1773 {ANY_MACRO => ANY_VALUE, ...}
1777 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
1779 =item tool_autosplit
1785 =head2 Overriding MakeMaker Methods
1787 If you cannot achieve the desired Makefile behaviour by specifying
1788 attributes you may define private subroutines in the Makefile.PL.
1789 Each subroutines returns the text it wishes to have written to
1790 the Makefile. To override a section of the Makefile you can
1793 sub MY::c_o { "new literal text" }
1795 or you can edit the default by saying something like:
1798 package MY; # so that "SUPER" works right
1799 my $inherited = shift->SUPER::c_o(@_);
1800 $inherited =~ s/old text/new text/;
1804 If you are running experiments with embedding perl as a library into
1805 other applications, you might find MakeMaker is not sufficient. You'd
1806 better have a look at ExtUtils::Embed which is a collection of utilities
1809 If you still need a different solution, try to develop another
1810 subroutine that fits your needs and submit the diffs to
1811 F<perl5-porters@perl.org> or F<comp.lang.perl.moderated> as appropriate.
1813 For a complete description of all MakeMaker methods see L<ExtUtils::MM_Unix>.
1815 Here is a simple example of how to add a new target to the generated
1820 $(MYEXTLIB): sdbm/Makefile
1821 cd sdbm && $(MAKE) all
1826 =head2 Hintsfile support
1828 MakeMaker.pm uses the architecture specific information from
1829 Config.pm. In addition it evaluates architecture specific hints files
1830 in a C<hints/> directory. The hints files are expected to be named
1831 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
1832 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
1833 MakeMaker within the WriteMakefile() subroutine, and can be used to
1834 execute commands as well as to include special variables. The rules
1835 which hintsfile is chosen are the same as in Configure.
1837 The hintsfile is eval()ed immediately after the arguments given to
1838 WriteMakefile are stuffed into a hash reference $self but before this
1839 reference becomes blessed. So if you want to do the equivalent to
1840 override or create an attribute you would say something like
1842 $self->{LIBS} = ['-ldbm -lucb -lc'];
1844 =head2 Distribution Support
1846 For authors of extensions MakeMaker provides several Makefile
1847 targets. Most of the support comes from the ExtUtils::Manifest module,
1848 where additional documentation can be found.
1852 =item make distcheck
1854 reports which files are below the build directory but not in the
1855 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
1858 =item make skipcheck
1860 reports which files are skipped due to the entries in the
1861 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
1864 =item make distclean
1866 does a realclean first and then the distcheck. Note that this is not
1867 needed to build a new distribution as long as you are sure, that the
1868 MANIFEST file is ok.
1872 rewrites the MANIFEST file, adding all remaining files found (See
1873 ExtUtils::Manifest::mkmanifest() for details)
1877 Copies all the files that are in the MANIFEST file to a newly created
1878 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
1879 exists, it will be removed first.
1883 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
1884 a make test in that directory.
1888 First does a distdir. Then a command $(PREOP) which defaults to a null
1889 command, followed by $(TOUNIX), which defaults to a null command under
1890 UNIX, and will convert files in distribution directory to UNIX format
1891 otherwise. Next it runs C<tar> on that directory into a tarfile and
1892 deletes the directory. Finishes with a command $(POSTOP) which
1893 defaults to a null command.
1897 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
1899 =item make uutardist
1901 Runs a tardist first and uuencodes the tarfile.
1905 First does a distdir. Then a command $(PREOP) which defaults to a null
1906 command. Next it runs C<shar> on that directory into a sharfile and
1907 deletes the intermediate directory again. Finishes with a command
1908 $(POSTOP) which defaults to a null command. Note: For shdist to work
1909 properly a C<shar> program that can handle directories is mandatory.
1913 First does a distdir. Then a command $(PREOP) which defaults to a null
1914 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
1915 zipfile. Then deletes that directory. Finishes with a command
1916 $(POSTOP) which defaults to a null command.
1920 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
1924 Customization of the dist targets can be done by specifying a hash
1925 reference to the dist attribute of the WriteMakefile call. The
1926 following parameters are recognized:
1929 COMPRESS ('gzip --best')
1932 TO_UNIX (depends on the system)
1933 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
1943 WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" })
1945 =head2 Disabling an extension
1947 If some events detected in F<Makefile.PL> imply that there is no way
1948 to create the Module, but this is a normal state of things, then you
1949 can create a F<Makefile> which does nothing, but succeeds on all the
1950 "usual" build targets. To do so, use
1952 ExtUtils::MakeMaker::WriteEmptyMakefile();
1954 instead of WriteMakefile().
1956 This may be useful if other modules expect this module to be I<built>
1957 OK, as opposed to I<work> OK (say, this system-dependent module builds
1958 in a subdirectory of some other distribution, or is listed as a
1959 dependency in a CPAN::Bundle, but the functionality is supported by
1960 different means on the current architecture).
1968 Command line options used by C<MakeMaker-E<gt>new()>, and thus by
1969 C<WriteMakefile()>. The string is split on whitespace, and the result
1970 is processed before any actual command line arguments are processed.
1976 ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib,
1977 ExtUtils::Install, ExtUtils::Embed
1981 Andy Dougherty <F<doughera@lafcol.lafayette.edu>>, Andreas KE<ouml>nig
1982 <F<A.Koenig@franz.ww.TU-Berlin.DE>>, Tim Bunce <F<Tim.Bunce@ig.co.uk>>.
1983 VMS support by Charles Bailey <F<bailey@newman.upenn.edu>>. OS/2
1984 support by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>. Contact the
1985 makemaker mailing list C<mailto:makemaker@franz.ww.tu-berlin.de>, if
1986 you have any questions.