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 $self->{CAPI} = $self->{PARENT}->{CAPI};
447 parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV);
450 $self->{NAME} ||= $self->guess_name;
452 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
456 if (! $self->{PERL_SRC} ) {
457 my($pthinks) = $self->canonpath($INC{'Config.pm'});
458 my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
459 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
460 if ($pthinks ne $cthinks &&
461 !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
462 print "Have $pthinks expected $cthinks\n";
464 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
467 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
470 Your perl and your Config.pm seem to have different ideas about the architecture
472 Perl thinks: [$pthinks]
473 Config says: [$Config{archname}]
474 This may or may not cause problems. Please check your installation of perl if you
475 have problems building this extension.
480 $self->init_dirscan();
481 $self->init_others();
482 my($argv) = neatvalue(\@ARGV);
486 push @{$self->{RESULT}}, <<END;
487 # This Makefile is for the $self->{NAME} extension to perl.
489 # It was generated automatically by MakeMaker version
490 # $VERSION (Revision: $Revision) from the contents of
491 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
493 # ANY CHANGES MADE HERE WILL BE LOST!
495 # MakeMaker ARGV: $argv
497 # MakeMaker Parameters:
500 foreach $key (sort keys %initial_att){
501 my($v) = neatvalue($initial_att{$key});
502 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
504 push @{$self->{RESULT}}, "# $key => $v";
507 # turn the SKIP array into a SKIPHASH hash
509 for $skip (@{$self->{SKIP} || []}) {
510 $self->{SKIPHASH}{$skip} = 1;
512 delete $self->{SKIP}; # free memory
514 if ($self->{PARENT}) {
515 for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
516 $self->{SKIPHASH}{$_} = 1;
520 # We run all the subdirectories now. They don't have much to query
521 # from the parent, but the parent has to query them: if they need linking!
522 unless ($self->{NORECURS}) {
523 $self->eval_in_subdirs if @{$self->{DIR}};
527 foreach $section ( @MM_Sections ){
528 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
529 my($skipit) = $self->skipcheck($section);
531 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
533 my(%a) = %{$self->{$section} || {}};
534 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
535 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
536 push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
540 push @{$self->{RESULT}}, "\n# End.";
545 sub WriteEmptyMakefile {
546 if (-f 'Makefile.old') {
547 chmod 0666, 'Makefile.old';
548 unlink 'Makefile.old' or warn "unlink Makefile.old: $!";
550 rename 'Makefile', 'Makefile.old' or warn "rename Makefile Makefile.old: $!"
552 open MF, '> Makefile' or die "open Makefile for write: $!";
565 close MF or die "close Makefile for write: $!";
569 print STDOUT "Checking if your kit is complete...\n";
570 require ExtUtils::Manifest;
571 $ExtUtils::Manifest::Quiet=$ExtUtils::Manifest::Quiet=1; #avoid warning
572 my(@missed)=ExtUtils::Manifest::manicheck();
574 print STDOUT "Warning: the following files are missing in your kit:\n";
575 print "\t", join "\n\t", @missed;
577 print STDOUT "Please inform the author.\n";
579 print STDOUT "Looks good\n";
584 my($self, @args) = @_;
586 unless (m/(.*?)=(.*)/){
587 help(),exit 1 if m/^help$/;
588 ++$Verbose if m/^verb/;
591 my($name, $value) = ($1, $2);
592 if ($value =~ m/^~(\w+)?/){ # tilde with optional username
593 $value =~ s [^~(\w*)]
595 ((getpwnam($1))[7] || "~$1") :
599 $self->{uc($name)} = $value;
602 # catch old-style 'potential_libs' and inform user how to 'upgrade'
603 if (defined $self->{potential_libs}){
604 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
605 if ($self->{potential_libs}){
606 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
608 print STDOUT "$msg deleted.\n";
610 $self->{LIBS} = [$self->{potential_libs}];
611 delete $self->{potential_libs};
613 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
614 if (defined $self->{ARMAYBE}){
615 my($armaybe) = $self->{ARMAYBE};
616 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
617 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
618 my(%dl) = %{$self->{dynamic_lib} || {}};
619 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
620 delete $self->{ARMAYBE};
622 if (defined $self->{LDTARGET}){
623 print STDOUT "LDTARGET should be changed to LDFROM\n";
624 $self->{LDFROM} = $self->{LDTARGET};
625 delete $self->{LDTARGET};
627 # Turn a DIR argument on the command line into an array
628 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
629 # So they can choose from the command line, which extensions they want
630 # the grep enables them to have some colons too much in case they
631 # have to build a list with the shell
632 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
634 # Turn a INCLUDE_EXT argument on the command line into an array
635 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
636 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
638 # Turn a EXCLUDE_EXT argument on the command line into an array
639 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
640 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
643 foreach $mmkey (sort keys %$self){
644 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
645 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
646 unless exists $Recognized_Att_Keys{$mmkey};
653 # We allow extension-specific hints files.
655 return unless -d "hints";
657 # First we look for the best hintsfile we have
659 my($hint)="${^O}_$Config{osvers}";
664 # Also try without trailing minor version numbers.
666 last if -f "hints/$hint.pl"; # found
668 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
670 return unless -f "hints/$hint.pl"; # really there
672 # execute the hintsfile:
674 # my $fh = new FileHandle;
675 # $fh->open("hints/$hint.pl");
677 open(FH,"hints/$hint.pl");
678 # @goodhints = <$fh>;
682 print STDOUT "Processing hints file hints/$hint.pl\n";
683 eval join('',@goodhints);
684 print STDOUT $@ if $@;
690 my($symtab) = \%{"${from}::"};
693 # Here you see the *current* list of methods that are overridable
694 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
695 # still trying to reduce the list to some reasonable minimum --
696 # because I want to make it easier for the user. A.K.
698 foreach $method (@Overridable) {
700 # We cannot say "next" here. Nick might call MY->makeaperl
701 # which isn't defined right now
703 # Above statement was written at 4.23 time when Tk-b8 was
704 # around. As Tk-b9 only builds with 5.002something and MM 5 is
705 # standard, we try to enable the next line again. It was
706 # commented out until MM 5.23
708 next unless defined &{"${from}::$method"};
710 *{"${to}::$method"} = \&{"${from}::$method"};
712 # delete would do, if we were sure, nobody ever called
713 # MY->makeaperl directly
715 # delete $symtab->{$method};
717 # If we delete a method, then it will be undefined and cannot
718 # be called. But as long as we have Makefile.PLs that rely on
719 # %MY:: being intact, we have to fill the hole with an
722 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
725 # We have to clean out %INC also, because the current directory is
726 # changed frequently and Graham Barr prefers to get his version
727 # out of a History.pl file which is "required" so woudn't get
728 # loaded again in another extension requiring a History.pl
730 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
731 # to core dump in the middle of a require statement. The required
732 # file was Tk/MMutil.pm. The consequence is, we have to be
733 # extremely careful when we try to give perl a reason to reload a
734 # library with same name. The workaround prefers to drop nothing
735 # from %INC and teach the writers not to use such libraries.
738 # foreach $inc (keys %INC) {
739 # #warn "***$inc*** deleted";
747 if ($section eq 'dynamic') {
748 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
749 "in skipped section 'dynamic_bs'\n"
750 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
751 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
752 "in skipped section 'dynamic_lib'\n"
753 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
755 if ($section eq 'dynamic_lib') {
756 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
757 "targets in skipped section 'dynamic_bs'\n"
758 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
760 if ($section eq 'static') {
761 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
762 "in skipped section 'static_lib'\n"
763 if $self->{SKIPHASH}{static_lib} && $Verbose;
765 return 'skipped' if $self->{SKIPHASH}{$section};
773 # my $fh = new FileHandle;
775 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
777 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
778 # $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
779 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
781 for $chunk (@{$self->{RESULT}}) {
782 # print $fh "$chunk\n";
788 my($finalname) = $self->{MAKEFILE};
789 rename("MakeMaker.tmp", $finalname);
790 chmod 0644, $finalname unless $Is_VMS;
792 if ($self->{PARENT}) {
793 foreach (keys %$self) { # safe memory
794 delete $self->{$_} unless $Keep_after_flush{$_};
798 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
801 # The following mkbootstrap() is only for installations that are calling
802 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
803 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
806 !!! Your Makefile has been built such a long time ago, !!!
807 !!! that is unlikely to work with current MakeMaker. !!!
808 !!! Please rebuild your Makefile !!!
812 # Ditto for mksymlists() as of MakeMaker 5.17
815 !!! Your Makefile has been built such a long time ago, !!!
816 !!! that is unlikely to work with current MakeMaker. !!!
817 !!! Please rebuild your Makefile !!!
823 return "undef" unless defined $v;
825 return "q[$v]" unless $t;
827 my(@m, $elem, @neat);
829 foreach $elem (@$v) {
830 push @neat, "q[$elem]";
832 push @m, join ", ", @neat;
836 return "$v" unless $t eq 'HASH';
838 while (($key,$val) = each %$v){
839 last unless defined $key; # cautious programming in case (undef,undef) is true
840 push(@m,"$key=>".neatvalue($val)) ;
842 return "{ ".join(', ',@m)." }";
849 push @m, "\n# Full list of MakeMaker attribute values:";
850 foreach $key (sort keys %$self){
851 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
852 my($v) = neatvalue($self->{$key});
853 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
855 push @m, "# $key => $v";
861 package ExtUtils::MakeMaker;
868 ExtUtils::MakeMaker - create an extension Makefile
872 C<use ExtUtils::MakeMaker;>
874 C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
878 C<MM-E<gt>new(\%att)-E<gt>flush;>
882 This utility is designed to write a Makefile for an extension module
883 from a Makefile.PL. It is based on the Makefile.SH model provided by
884 Andy Dougherty and the perl5-porters.
886 It splits the task of generating the Makefile into several subroutines
887 that can be individually overridden. Each subroutine returns the text
888 it wishes to have written to the Makefile.
890 MakeMaker is object oriented. Each directory below the current
891 directory that contains a Makefile.PL. Is treated as a separate
892 object. This makes it possible to write an unlimited number of
893 Makefiles with a single invocation of WriteMakefile().
895 =head2 How To Write A Makefile.PL
897 The short answer is: Don't.
899 Always begin with h2xs.
900 Always begin with h2xs!
901 ALWAYS BEGIN WITH H2XS!
903 even if you're not building around a header file, and even if you
904 don't have an XS component.
906 Run h2xs(1) before you start thinking about writing a module. For so
907 called pm-only modules that consist of C<*.pm> files only, h2xs has
908 the C<-X> switch. This will generate dummy files of all kinds that are
909 useful for the module developer.
911 The medium answer is:
913 use ExtUtils::MakeMaker;
914 WriteMakefile( NAME => "Foo::Bar" );
916 The long answer is the rest of the manpage :-)
918 =head2 Default Makefile Behaviour
920 The generated Makefile enables the user of the extension to invoke
922 perl Makefile.PL # optionally "perl Makefile.PL verbose"
924 make test # optionally set TEST_VERBOSE=1
925 make install # See below
927 The Makefile to be produced may be altered by adding arguments of the
928 form C<KEY=VALUE>. E.g.
930 perl Makefile.PL PREFIX=/tmp/myperl5
932 Other interesting targets in the generated Makefile are
934 make config # to check if the Makefile is up-to-date
935 make clean # delete local temp files (Makefile gets renamed)
936 make realclean # delete derived files (including ./blib)
937 make ci # check in all the files in the MANIFEST file
938 make dist # see below the Distribution Support section
942 MakeMaker checks for the existence of a file named F<test.pl> in the
943 current directory and if it exists it adds commands to the test target
944 of the generated Makefile that will execute the script with the proper
945 set of perl C<-I> options.
947 MakeMaker also checks for any files matching glob("t/*.t"). It will
948 add commands to the test target of the generated Makefile that execute
949 all matching files via the L<Test::Harness> module with the C<-I>
950 switches set correctly.
954 A useful variation of the above is the target C<testdb>. It runs the
955 test under the Perl debugger (see L<perldebug>). If the file
956 F<test.pl> exists in the current directory, it is used for the test.
958 If you want to debug some other testfile, set C<TEST_FILE> variable
961 make testdb TEST_FILE=t/mytest.t
963 By default the debugger is called using C<-d> option to perl. If you
964 want to specify some other option, set C<TESTDB_SW> variable:
966 make testdb TESTDB_SW=-Dx
970 make alone puts all relevant files into directories that are named by
971 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_MAN1DIR, and
972 INST_MAN3DIR. All these default to something below ./blib if you are
973 I<not> building below the perl source directory. If you I<are>
974 building below the perl source, INST_LIB and INST_ARCHLIB default to
975 ../../lib, and INST_SCRIPT is not defined.
977 The I<install> target of the generated Makefile copies the files found
978 below each of the INST_* directories to their INSTALL*
979 counterparts. Which counterparts are chosen depends on the setting of
980 INSTALLDIRS according to the following table:
985 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH
986 INST_LIB INSTALLPRIVLIB INSTALLSITELIB
988 INST_SCRIPT INSTALLSCRIPT
989 INST_MAN1DIR INSTALLMAN1DIR
990 INST_MAN3DIR INSTALLMAN3DIR
992 The INSTALL... macros in turn default to their %Config
993 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
995 You can check the values of these variables on your system with
999 And to check the sequence in which the library directories are
1000 searched by perl, run
1002 perl -le 'print join $/, @INC'
1005 =head2 PREFIX and LIB attribute
1007 PREFIX and LIB can be used to set several INSTALL* attributes in one
1008 go. The quickest way to install a module in a non-standard place might
1011 perl Makefile.PL LIB=~/lib
1013 This will install the module's architecture-independent files into
1014 ~/lib, the architecture-dependent files into ~/lib/$archname/auto.
1016 Another way to specify many INSTALL directories with a single
1017 parameter is PREFIX.
1019 perl Makefile.PL PREFIX=~
1021 This will replace the string specified by $Config{prefix} in all
1022 $Config{install*} values.
1024 Note, that in both cases the tilde expansion is done by MakeMaker, not
1025 by perl by default, nor by make. Conflicts between parmeters LIB,
1026 PREFIX and the various INSTALL* arguments are resolved so that
1029 If the user has superuser privileges, and is not working on AFS
1030 (Andrew File System) or relatives, then the defaults for
1031 INSTALLPRIVLIB, INSTALLARCHLIB, INSTALLSCRIPT, etc. will be appropriate,
1032 and this incantation will be the best:
1034 perl Makefile.PL; make; make test
1037 make install per default writes some documentation of what has been
1038 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1039 can be bypassed by calling make pure_install.
1043 will have to specify the installation directories as these most
1044 probably have changed since perl itself has been installed. They will
1045 have to do this by calling
1047 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1048 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1051 Be careful to repeat this procedure every time you recompile an
1052 extension, unless you are sure the AFS installation directories are
1055 =head2 Static Linking of a new Perl Binary
1057 An extension that is built with the above steps is ready to use on
1058 systems supporting dynamic loading. On systems that do not support
1059 dynamic loading, any newly created extension has to be linked together
1060 with the available resources. MakeMaker supports the linking process
1061 by creating appropriate targets in the Makefile whenever an extension
1062 is built. You can invoke the corresponding section of the makefile with
1066 That produces a new perl binary in the current directory with all
1067 extensions linked in that can be found in INST_ARCHLIB , SITELIBEXP,
1068 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1069 UNIX, this is called Makefile.aperl (may be system dependent). If you
1070 want to force the creation of a new perl, it is recommended, that you
1071 delete this Makefile.aperl, so the directories are searched-through
1072 for linkable libraries again.
1074 The binary can be installed into the directory where perl normally
1075 resides on your machine with
1079 To produce a perl binary with a different name than C<perl>, either say
1081 perl Makefile.PL MAP_TARGET=myperl
1088 make myperl MAP_TARGET=myperl
1089 make inst_perl MAP_TARGET=myperl
1091 In any case you will be prompted with the correct invocation of the
1092 C<inst_perl> target that installs the new binary into INSTALLBIN.
1094 make inst_perl per default writes some documentation of what has been
1095 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1096 can be bypassed by calling make pure_inst_perl.
1098 Warning: the inst_perl: target will most probably overwrite your
1099 existing perl binary. Use with care!
1101 Sometimes you might want to build a statically linked perl although
1102 your system supports dynamic loading. In this case you may explicitly
1103 set the linktype with the invocation of the Makefile.PL or make:
1105 perl Makefile.PL LINKTYPE=static # recommended
1109 make LINKTYPE=static # works on most systems
1111 =head2 Determination of Perl Library and Installation Locations
1113 MakeMaker needs to know, or to guess, where certain things are
1114 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1115 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1116 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1118 Extensions may be built either using the contents of the perl source
1119 directory tree or from the installed perl library. The recommended way
1120 is to build extensions after you have run 'make install' on perl
1121 itself. You can do that in any directory on your hard disk that is not
1122 below the perl source tree. The support for extensions below the ext
1123 directory of the perl distribution is only good for the standard
1124 extensions that come with perl.
1126 If an extension is being built below the C<ext/> directory of the perl
1127 source then MakeMaker will set PERL_SRC automatically (e.g.,
1128 C<../..>). If PERL_SRC is defined and the extension is recognized as
1129 a standard extension, then other variables default to the following:
1132 PERL_LIB = PERL_SRC/lib
1133 PERL_ARCHLIB = PERL_SRC/lib
1135 INST_ARCHLIB = PERL_ARCHLIB
1137 If an extension is being built away from the perl source then MakeMaker
1138 will leave PERL_SRC undefined and default to using the installed copy
1139 of the perl library. The other variables default to the following:
1141 PERL_INC = $archlibexp/CORE
1142 PERL_LIB = $privlibexp
1143 PERL_ARCHLIB = $archlibexp
1144 INST_LIB = ./blib/lib
1145 INST_ARCHLIB = ./blib/arch
1147 If perl has not yet been installed then PERL_SRC can be defined on the
1148 command line as shown in the previous section.
1151 =head2 Which architecture dependent directory?
1153 If you don't want to keep the defaults for the INSTALL* macros,
1154 MakeMaker helps you to minimize the typing needed: the usual
1155 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1156 by Configure at perl compilation time. MakeMaker supports the user who
1157 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1158 then MakeMaker defaults the latter to be the same subdirectory of
1159 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1160 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1161 for INSTALLSITELIB and INSTALLSITEARCH.
1163 MakeMaker gives you much more freedom than needed to configure
1164 internal variables and get different results. It is worth to mention,
1165 that make(1) also lets you configure most of the variables that are
1166 used in the Makefile. But in the majority of situations this will not
1167 be necessary, and should only be done, if the author of a package
1168 recommends it (or you know what you're doing).
1170 =head2 Using Attributes and Parameters
1172 The following attributes can be specified as arguments to WriteMakefile()
1173 or as NAME=VALUE pairs on the command line:
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).
1184 One line description of the module. Will be included in PPD file.
1188 Name of the file that contains the package description. MakeMaker looks
1189 for a line in the POD matching /^($package\s-\s)(.*)/. This is typically
1190 the first line in the "=head1 NAME" section. $2 becomes the abstract.
1192 =item BINARY_LOCATION
1194 Used when creating PPD files for binary packages. It can be set to a
1195 full or relative path or URL to the binary archive for a particular
1196 architecture. For example:
1198 perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
1200 builds a PPD package that references a binary of the C<Agent> package,
1201 located in the C<x86> directory relative to the PPD itself.
1205 Ref to array of *.c file names. Initialised from a directory scan
1206 and the values portion of the XS attribute hash. This is not
1207 currently used by MakeMaker but may be handy in Makefile.PLs.
1211 Switch to force usage of the Perl C API even when compiling for PERL_OBJECT.
1215 String that will be included in the compiler call command line between
1216 the arguments INC and OPTIMIZE.
1220 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1221 config.sh. MakeMaker will add to CONFIG the following values anyway:
1241 CODE reference. The subroutine should return a hash reference. The
1242 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1243 be determined by some evaluation method.
1247 Something like C<"-DHAVE_UNISTD_H">
1251 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1256 Your name for distributing the package (by tar file). This defaults to
1261 Hashref of symbol names for routines to be made available as universal
1262 symbols. Each key/value pair consists of the package name and an
1263 array of routine names in that package. Used only under AIX, OS/2,
1264 VMS and Win32 at present. The routine names supplied will be expanded
1265 in the same way as XSUB names are expanded by the XS() macro.
1268 {"$(NAME)" => ["boot_$(NAME)" ] }
1272 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1273 "NetconfigPtr" => [ 'DESTROY'] }
1275 Please see the L<ExtUtils::Mksymlists> documentation for more information
1276 about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
1280 Array of symbol names for variables to be made available as universal symbols.
1281 Used only under AIX, OS/2, VMS and Win32 at present. Defaults to [].
1282 (e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
1286 Array of extension names to exclude when doing a static build. This
1287 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1288 details. (e.g. [ qw( Socket POSIX ) ] )
1290 This attribute may be most useful when specified as a string on the
1291 commandline: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1295 Ref to array of executable files. The files will be copied to the
1296 INST_SCRIPT directory. Make realclean will delete them from there
1299 =item FIRST_MAKEFILE
1301 The name of the Makefile to be produced. Defaults to the contents of
1302 MAKEFILE, but can be overridden. This is used for the second Makefile
1303 that will be produced for the MAP_TARGET.
1307 Perl binary able to run this extension.
1311 This provides an alternate means to specify function names to be
1312 exported from the extension. Its value is a reference to an
1313 array of function names to be exported by the extension. These
1314 names are passed through unaltered to the linker options file.
1318 Ref to array of *.h file names. Similar to C.
1322 This attribute is used to specify names to be imported into the
1323 extension. It is only used on OS/2 and Win32.
1327 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1331 Array of extension names to be included when doing a static build.
1332 MakeMaker will normally build with all of the installed extensions when
1333 doing a static build, and that is usually the desired behavior. If
1334 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1335 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1337 It is not necessary to mention DynaLoader or the current extension when
1338 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1339 only DynaLoader and the current extension will be included in the build.
1341 This attribute may be most useful when specified as a string on the
1342 commandline: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1344 =item INSTALLARCHLIB
1346 Used by 'make install', which copies files from INST_ARCHLIB to this
1347 directory if INSTALLDIRS is set to perl.
1351 Directory to install binary files (e.g. tkperl) into.
1355 Determines which of the two sets of installation directories to
1356 choose: installprivlib and installarchlib versus installsitelib and
1357 installsitearch. The first pair is chosen with INSTALLDIRS=perl, the
1358 second with INSTALLDIRS=site. Default is site.
1360 =item INSTALLMAN1DIR
1362 This directory gets the man pages at 'make install' time. Defaults to
1363 $Config{installman1dir}.
1365 =item INSTALLMAN3DIR
1367 This directory gets the man pages at 'make install' time. Defaults to
1368 $Config{installman3dir}.
1370 =item INSTALLPRIVLIB
1372 Used by 'make install', which copies files from INST_LIB to this
1373 directory if INSTALLDIRS is set to perl.
1377 Used by 'make install' which copies files from INST_SCRIPT to this
1380 =item INSTALLSITEARCH
1382 Used by 'make install', which copies files from INST_ARCHLIB to this
1383 directory if INSTALLDIRS is set to site (default).
1385 =item INSTALLSITELIB
1387 Used by 'make install', which copies files from INST_LIB to this
1388 directory if INSTALLDIRS is set to site (default).
1392 Same as INST_LIB for architecture dependent files.
1396 Directory to put real binary files during 'make'. These will be copied
1397 to INSTALLBIN during 'make install'
1401 Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you
1406 Directory where we put library files of this extension while building
1411 Directory to hold the man pages at 'make' time
1415 Directory to hold the man pages at 'make' time
1419 Directory, where executable files should be installed during
1420 'make'. Defaults to "./blib/bin", just to have a dummy location during
1421 testing. make install will copy the files in INST_SCRIPT to
1426 defaults to "$(OBJECT)" and is used in the ld command to specify
1427 what files to link/load from (also see dynamic_lib below for how to
1432 LIB can only be set at C<perl Makefile.PL> time. It has the effect of
1433 setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any
1437 The filename of the perllibrary that will be used together with this
1438 extension. Defaults to libperl.a.
1442 An anonymous array of alternative library
1443 specifications to be searched for (in order) until
1444 at least one library is found. E.g.
1446 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1448 Mind, that any element of the array
1449 contains a complete set of arguments for the ld
1450 command. So do not specify
1452 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1454 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1455 you specify a scalar as in
1457 'LIBS' => "-ltcl -ltk -lX11"
1459 MakeMaker will turn it into an array with one element.
1463 'static' or 'dynamic' (default unless usedl=undef in
1464 config.sh). Should only be used to force static linking (also see
1469 Boolean which tells MakeMaker, that it should include the rules to
1470 make a perl. This is handled automatically as a switch by
1471 MakeMaker. The user normally does not need it.
1475 The name of the Makefile to be produced.
1479 Hashref of pod-containing files. MakeMaker will default this to all
1480 EXE_FILES files that include POD directives. The files listed
1481 here will be converted to man pages and installed as was requested
1486 Hashref of .pm and .pod files. MakeMaker will default this to all
1487 .pod and any .pm files that include POD directives. The files listed
1488 here will be converted to man pages and installed as was requested
1493 If it is intended, that a new perl binary be produced, this variable
1494 may hold a name for that binary. Defaults to perl
1498 If the extension links to a library that it builds set this to the
1499 name of the library (see SDBM_File)
1503 Perl module name for this extension (DBD::Oracle). This will default
1504 to the directory name but should be explicitly defined in the
1509 MakeMaker will figure out, if an extension contains linkable code
1510 anywhere down the directory tree, and will set this variable
1511 accordingly, but you can speed it up a very little bit, if you define
1512 this boolean variable yourself.
1516 Defaults to C<@>. By setting it to an empty string you can generate a
1517 Makefile that echos all commands. Mainly used in debugging MakeMaker
1522 Boolean. Attribute to inhibit descending into subdirectories.
1526 In general any generated Makefile checks for the current version of
1527 MakeMaker and the version the Makefile was built under. If NO_VC is
1528 set, the version check is neglected. Do not write this into your
1529 Makefile.PL, use it interactively instead.
1533 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1534 string containing all object files, e.g. "tkpBind.o
1535 tkpButton.o tkpCanvas.o"
1539 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1540 passed to subdirectory makes.
1544 Perl binary for tasks that can be done by miniperl
1548 The call to the program that is able to compile perlmain.c. Defaults
1553 Same as above for architecture dependent files
1557 Directory containing the Perl library to use.
1561 Directory containing the Perl source code (use of this should be
1562 avoided, it may be undefined)
1566 Desired Permission for read/writable files. Defaults to C<644>.
1567 See also L<MM_Unix/perm_rw>.
1571 Desired permission for executable files. Defaults to C<755>.
1572 See also L<MM_Unix/perm_rwx>.
1576 Ref to hash of files to be processed as perl programs. MakeMaker
1577 will default to any found *.PL file (except Makefile.PL) being keys
1578 and the basename of the file being the value. E.g.
1580 {'foobar.PL' => 'foobar'}
1582 The *.PL files are expected to produce output to the target files
1583 themselves. If multiple files can be generated from the same *.PL
1584 file then the value in the hash can be a reference to an array of
1585 target file names. E.g.
1587 {'foobar.PL' => ['foobar1','foobar2']}
1591 Hashref of .pm files and *.pl files to be installed. e.g.
1593 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1595 By default this will include *.pm and *.pl and the files found in
1596 the PMLIBDIRS directories. Defining PM in the
1597 Makefile.PL will override PMLIBDIRS.
1601 Ref to array of subdirectories containing library files. Defaults to
1602 [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
1603 they contain will be installed in the corresponding location in the
1604 library. A libscan() method can be used to alter the behaviour.
1605 Defining PM in the Makefile.PL will override PMLIBDIRS.
1607 =item PPM_INSTALL_EXEC
1609 Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl)
1611 =item PPM_INSTALL_SCRIPT
1613 Name of the script that gets executed by the Perl Package Manager after
1614 the installation of a package.
1618 Can be used to set the three INSTALL* attributes in one go (except for
1619 probably INSTALLMAN1DIR, if it is not below PREFIX according to
1620 %Config). They will have PREFIX as a common directory node and will
1621 branch from that node into lib/, lib/ARCHNAME or whatever Configure
1622 decided at the build time of your perl (unless you override one of
1627 Hashref: Names of modules that need to be available to run this
1628 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1629 desired version is the value. If the required version number is 0, we
1630 only check if any version is installed already.
1634 Arryref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1635 Makefile. Caution! Do not use the SKIP attribute for the neglectible
1636 speedup. It may seriously damage the resulting Makefile. Only use it,
1637 if you really need it.
1641 Ref to array of typemap file names. Use this when the typemaps are
1642 in some directory other than the current directory or when they are
1643 not named B<typemap>. The last typemap in the list takes
1644 precedence. A typemap in the current directory has highest
1645 precedence, even if it isn't listed in TYPEMAPS. The default system
1646 typemap has lowest precedence.
1650 Your version number for distributing the package. This defaults to
1655 Instead of specifying the VERSION in the Makefile.PL you can let
1656 MakeMaker parse a file to determine the version number. The parsing
1657 routine requires that the file named by VERSION_FROM contains one
1658 single line to compute the version number. The first line in the file
1659 that contains the regular expression
1661 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
1663 will be evaluated with eval() and the value of the named variable
1664 B<after> the eval() will be assigned to the VERSION attribute of the
1665 MakeMaker object. The following lines will be parsed o.k.:
1669 ( $VERSION ) = '$Revision: 1.222 $ ' =~ /\$Revision:\s+([^\s]+)/;
1670 $FOO::VERSION = '1.10';
1671 *FOO::VERSION = \'1.11';
1673 but these will fail:
1675 my $VERSION = '1.01';
1676 local $VERSION = '1.02';
1677 local $FOO::VERSION = '1.30';
1679 The file named in VERSION_FROM is not added as a dependency to
1680 Makefile. This is not really correct, but it would be a major pain
1681 during development to have to rewrite the Makefile for any smallish
1682 change in that file. If you want to make sure that the Makefile
1683 contains the correct VERSION macro after any change of the file, you
1684 would have to do something like
1686 depend => { Makefile => '$(VERSION_FROM)' }
1688 See attribute C<depend> below.
1692 Hashref of .xs files. MakeMaker will default this. e.g.
1694 {'name_of_file.xs' => 'name_of_file.c'}
1696 The .c files will automatically be included in the list of files
1697 deleted by a make clean.
1701 String of options to pass to xsubpp. This might include C<-C++> or
1702 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
1707 May be set to an empty string, which is identical to C<-prototypes>, or
1708 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
1709 defaults to the empty string.
1713 Your version number for the .xs file of this package. This defaults
1714 to the value of the VERSION attribute.
1718 =head2 Additional lowercase attributes
1720 can be used to pass parameters to the methods which implement that
1721 part of the Makefile.
1727 {FILES => "*.xyz foo"}
1731 {ANY_TARGET => ANY_DEPENDECY, ...}
1735 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
1736 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
1737 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
1739 If you specify COMPRESS, then SUFFIX should also be altered, as it is
1740 needed to tell make the target file of the compression. Setting
1741 DIST_CP to ln can be useful, if you need to preserve the timestamps on
1742 your files. DIST_CP can take the values 'cp', which copies the file,
1743 'ln', which links the file, and 'best' which copies symbolic links and
1744 links the rest. Default is 'best'.
1748 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
1752 {LINKTYPE => 'static', 'dynamic' or ''}
1754 NB: Extensions that have nothing but *.pm files had to say
1758 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1759 can be deleted safely. MakeMaker recognizes, when there's nothing to
1764 {ANY_MACRO => ANY_VALUE, ...}
1768 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
1770 =item tool_autosplit
1776 =head2 Overriding MakeMaker Methods
1778 If you cannot achieve the desired Makefile behaviour by specifying
1779 attributes you may define private subroutines in the Makefile.PL.
1780 Each subroutines returns the text it wishes to have written to
1781 the Makefile. To override a section of the Makefile you can
1784 sub MY::c_o { "new literal text" }
1786 or you can edit the default by saying something like:
1789 package MY; # so that "SUPER" works right
1790 my $inherited = shift->SUPER::c_o(@_);
1791 $inherited =~ s/old text/new text/;
1795 If you are running experiments with embedding perl as a library into
1796 other applications, you might find MakeMaker is not sufficient. You'd
1797 better have a look at ExtUtils::Embed which is a collection of utilities
1800 If you still need a different solution, try to develop another
1801 subroutine that fits your needs and submit the diffs to
1802 F<perl5-porters@perl.org> or F<comp.lang.perl.moderated> as appropriate.
1804 For a complete description of all MakeMaker methods see L<ExtUtils::MM_Unix>.
1806 Here is a simple example of how to add a new target to the generated
1811 $(MYEXTLIB): sdbm/Makefile
1812 cd sdbm && $(MAKE) all
1817 =head2 Hintsfile support
1819 MakeMaker.pm uses the architecture specific information from
1820 Config.pm. In addition it evaluates architecture specific hints files
1821 in a C<hints/> directory. The hints files are expected to be named
1822 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
1823 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
1824 MakeMaker within the WriteMakefile() subroutine, and can be used to
1825 execute commands as well as to include special variables. The rules
1826 which hintsfile is chosen are the same as in Configure.
1828 The hintsfile is eval()ed immediately after the arguments given to
1829 WriteMakefile are stuffed into a hash reference $self but before this
1830 reference becomes blessed. So if you want to do the equivalent to
1831 override or create an attribute you would say something like
1833 $self->{LIBS} = ['-ldbm -lucb -lc'];
1835 =head2 Distribution Support
1837 For authors of extensions MakeMaker provides several Makefile
1838 targets. Most of the support comes from the ExtUtils::Manifest module,
1839 where additional documentation can be found.
1843 =item make distcheck
1845 reports which files are below the build directory but not in the
1846 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
1849 =item make skipcheck
1851 reports which files are skipped due to the entries in the
1852 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
1855 =item make distclean
1857 does a realclean first and then the distcheck. Note that this is not
1858 needed to build a new distribution as long as you are sure, that the
1859 MANIFEST file is ok.
1863 rewrites the MANIFEST file, adding all remaining files found (See
1864 ExtUtils::Manifest::mkmanifest() for details)
1868 Copies all the files that are in the MANIFEST file to a newly created
1869 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
1870 exists, it will be removed first.
1874 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
1875 a make test in that directory.
1879 First does a distdir. Then a command $(PREOP) which defaults to a null
1880 command, followed by $(TOUNIX), which defaults to a null command under
1881 UNIX, and will convert files in distribution directory to UNIX format
1882 otherwise. Next it runs C<tar> on that directory into a tarfile and
1883 deletes the directory. Finishes with a command $(POSTOP) which
1884 defaults to a null command.
1888 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
1890 =item make uutardist
1892 Runs a tardist first and uuencodes the tarfile.
1896 First does a distdir. Then a command $(PREOP) which defaults to a null
1897 command. Next it runs C<shar> on that directory into a sharfile and
1898 deletes the intermediate directory again. Finishes with a command
1899 $(POSTOP) which defaults to a null command. Note: For shdist to work
1900 properly a C<shar> program that can handle directories is mandatory.
1904 First does a distdir. Then a command $(PREOP) which defaults to a null
1905 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
1906 zipfile. Then deletes that directory. Finishes with a command
1907 $(POSTOP) which defaults to a null command.
1911 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
1915 Customization of the dist targets can be done by specifying a hash
1916 reference to the dist attribute of the WriteMakefile call. The
1917 following parameters are recognized:
1920 COMPRESS ('gzip --best')
1923 TO_UNIX (depends on the system)
1924 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
1934 WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" })
1936 =head2 Disabling an extension
1938 If some events detected in F<Makefile.PL> imply that there is no way
1939 to create the Module, but this is a normal state of things, then you
1940 can create a F<Makefile> which does nothing, but succeeds on all the
1941 "usual" build targets. To do so, use
1943 ExtUtils::MakeMaker::WriteEmptyMakefile();
1945 instead of WriteMakefile().
1947 This may be useful if other modules expect this module to be I<built>
1948 OK, as opposed to I<work> OK (say, this system-dependent module builds
1949 in a subdirectory of some other distribution, or is listed as a
1950 dependency in a CPAN::Bundle, but the functionality is supported by
1951 different means on the current architecture).
1959 Command line options used by C<MakeMaker-E<gt>new()>, and thus by
1960 C<WriteMakefile()>. The string is split on whitespace, and the result
1961 is processed before any actual command line arguments are processed.
1967 ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib,
1968 ExtUtils::Install, ExtUtils::Embed
1972 Andy Dougherty <F<doughera@lafcol.lafayette.edu>>, Andreas KE<ouml>nig
1973 <F<A.Koenig@franz.ww.TU-Berlin.DE>>, Tim Bunce <F<Tim.Bunce@ig.co.uk>>.
1974 VMS support by Charles Bailey <F<bailey@newman.upenn.edu>>. OS/2
1975 support by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>. Contact the
1976 makemaker mailing list C<mailto:makemaker@franz.ww.tu-berlin.de>, if
1977 you have any questions.