1 BEGIN {require 5.002;} # MakeMaker 5.17 was the last MakeMaker that was compatible with perl5.001m
3 package ExtUtils::MakeMaker;
5 $Version = $VERSION = "5.4002";
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.211 $, 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
40 # $Version in mixed case will go away!
43 # Dummy package MM inherits actual methods from OS-specific
44 # default packages. We use this intermediate package so
45 # MY::XYZ->func() can call MM->func() and get the proper
46 # default routine without having to know under what OS
49 @MM::ISA = qw[ExtUtils::MM_Unix ExtUtils::Liblist ExtUtils::MakeMaker];
52 # Setup dummy package:
53 # MY exists for overriding methods to be defined within
58 ### sub AUTOLOAD { use Devel::Symdump; print Devel::Symdump->rnew->as_string; Carp::confess "hey why? $AUTOLOAD" }
63 # "predeclare the package: we only load it via AUTOLOAD
64 # but we have already mentioned it in @ISA
65 package ExtUtils::Liblist;
67 package ExtUtils::MakeMaker;
69 # Now we can can pull in the friends
71 $Is_VMS = $^O eq 'VMS';
72 $Is_OS2 = $^O eq 'os2';
73 $Is_Mac = $^O eq 'MacOS';
75 require ExtUtils::MM_Unix;
78 require ExtUtils::MM_VMS;
79 require VMS::Filespec; # is a noop as long as we require it within MM_VMS
82 require ExtUtils::MM_OS2;
85 require ExtUtils::MM_Mac;
88 # The SelfLoader would bring a lot of overhead for MakeMaker, because
89 # we know for sure we will use most of the autoloaded functions once
90 # we have to use one of them. So we write our own loader
94 if (defined fileno(DATA)) {
96 my $o = $/; # For future reads from the file.
108 warn "AUTOLOAD called unexpectedly for $AUTOLOAD";
110 defined(&$AUTOLOAD) or die "Myloader inconsistency error";
114 # The only subroutine we do not SelfLoad is Version_Check because it's
115 # called so often. Loading this minimum still requires 1.2 secs on my
119 my($checkversion) = @_;
120 die "Your Makefile was built with ExtUtils::MakeMaker v $checkversion.
121 Current Version is $ExtUtils::MakeMaker::VERSION. There have been considerable
122 changes in the meantime.
123 Please rerun 'perl Makefile.PL' to regenerate the Makefile.\n"
124 if $checkversion < $Version_OK;
125 printf STDOUT "%s %s %s %s.\n", "Makefile built with ExtUtils::MakeMaker v",
126 $checkversion, "Current Version is", $VERSION
127 unless $checkversion == $VERSION;
131 $_[0] =~ /^Use of uninitialized value/ && return;
132 $_[0] =~ /used only once/ && return;
133 $_[0] =~ /^Subroutine\s+[\w:]+\s+redefined/ && return;
137 sub ExtUtils::MakeMaker::eval_in_subdirs ;
138 sub ExtUtils::MakeMaker::eval_in_x ;
139 sub ExtUtils::MakeMaker::full_setup ;
140 sub ExtUtils::MakeMaker::writeMakefile ;
141 sub ExtUtils::MakeMaker::new ;
142 sub ExtUtils::MakeMaker::check_manifest ;
143 sub ExtUtils::MakeMaker::parse_args ;
144 sub ExtUtils::MakeMaker::check_hints ;
145 sub ExtUtils::MakeMaker::mv_all_methods ;
146 sub ExtUtils::MakeMaker::skipcheck ;
147 sub ExtUtils::MakeMaker::flush ;
148 sub ExtUtils::MakeMaker::mkbootstrap ;
149 sub ExtUtils::MakeMaker::mksymlists ;
150 sub ExtUtils::MakeMaker::neatvalue ;
151 sub ExtUtils::MakeMaker::selfdocument ;
152 sub ExtUtils::MakeMaker::WriteMakefile ;
153 sub ExtUtils::MakeMaker::prompt ;
159 package ExtUtils::MakeMaker;
162 Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
163 local $SIG{__WARN__} = \&warnhandler;
165 unless ($Setup_done++){
167 undef &ExtUtils::MakeMaker::full_setup; #safe memory
170 MM->new(\%att)->flush;
175 $ISA_TTY = -t STDIN && -t STDOUT ;
176 Carp::confess("prompt function called without an argument") unless defined $mess;
177 my $dispdef = defined $def ? "[$def] " : " ";
178 $def = defined $def ? $def : "";
182 print "$mess $dispdef";
183 chomp($ans = <STDIN>);
188 sub eval_in_subdirs {
194 foreach $dir (@{$self->{DIR}}){
195 my($abs) = $self->catdir($pwd,$dir);
196 $self->eval_in_x($abs);
204 chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
206 # my $fh = new FileHandle;
207 # $fh->open("Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
209 open(FH,"Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
210 # my $eval = join "", <$fh>;
211 my $eval = join "", <FH>;
216 # if ($@ =~ /prerequisites/) {
217 # die "MakeMaker WARNING: $@";
219 # warn "WARNING from evaluation of $dir/Makefile.PL: $@";
221 warn "WARNING from evaluation of $dir/Makefile.PL: $@";
229 # package name for the classes into which the first object will be blessed
230 $PACKNAME = "PACK000";
234 C CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
235 EXE_FILES EXCLUDE_EXT INCLUDE_EXT NO_VC FIRST_MAKEFILE FULLPERL H
236 INC INSTALLARCHLIB INSTALLBIN INSTALLDIRS INSTALLMAN1DIR
237 INSTALLMAN3DIR INSTALLPRIVLIB INSTALLSCRIPT INSTALLSITEARCH
238 INSTALLSITELIB INST_ARCHLIB INST_BIN INST_EXE INST_LIB
239 INST_MAN1DIR INST_MAN3DIR INST_SCRIPT LDFROM LIBPERL_A LIB LIBS
240 LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB
241 NAME NEEDS_LINKING NOECHO NORECURS OBJECT OPTIMIZE PERL PERLMAINCC
242 PERL_ARCHLIB PERL_LIB PERL_SRC PL_FILES PM PMLIBDIRS PREFIX
243 PREREQ_PM SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
244 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
252 # IMPORTS is used under OS/2
254 # ^^^ installpm is deprecated, will go about Summer 96
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
279 ); # loses section ordering
281 @Overridable = @MM_Sections;
282 push @Overridable, qw[
284 dir_target libscan makeaperl needs_linking subdir_x test_via_harness
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 ranlib sitelibexp sitearchexp so
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";
381 delete $self->{PREREQ_PM}{$prereq};
385 # unless (defined $ExtUtils::MakeMaker::useCPAN) {
386 # print qq{MakeMaker WARNING: prerequisites not found (@unsatisfied)
387 # Please install these modules first and rerun 'perl Makefile.PL'.\n};
388 # if ($ExtUtils::MakeMaker::hasCPAN) {
389 # $ExtUtils::MakeMaker::useCPAN = prompt(qq{Should I try to use the CPAN module to fetch them for you?},"yes");
391 # print qq{Hint: You may want to install the CPAN module to autofetch the needed modules\n};
392 # $ExtUtils::MakeMaker::useCPAN=0;
395 # if ($ExtUtils::MakeMaker::useCPAN) {
397 # CPAN->import(@unsatisfied);
399 # die qq{prerequisites not found (@unsatisfied)};
401 # warn qq{WARNING: prerequisites not found (@unsatisfied)};
404 if (defined $self->{CONFIGURE}) {
405 if (ref $self->{CONFIGURE} eq 'CODE') {
406 $self = { %$self, %{&{$self->{CONFIGURE}}}};
408 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
412 # This is for old Makefiles written pre 5.00, will go away
413 if ( Carp::longmess("") =~ /runsubdirpl/s ){
414 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
417 my $newclass = ++$PACKNAME;
420 print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
421 mv_all_methods("MY",$newclass);
422 bless $self, $newclass;
424 @{"$newclass\:\:ISA"} = 'MM';
427 if (defined $Parent[-2]){
428 $self->{PARENT} = $Parent[-2];
430 for $key (keys %Prepend_dot_dot) {
431 next unless defined $self->{PARENT}{$key};
432 $self->{$key} = $self->{PARENT}{$key};
433 # PERL and FULLPERL may be command verbs instead of full
434 # file specifications under VMS. If so, don't turn them
436 $self->{$key} = $self->catdir("..",$self->{$key})
437 unless $self->file_name_is_absolute($self->{$key})
438 || ($^O eq 'VMS' and ($key =~ /PERL$/ && $self->{$key} =~ /^[\w\-\$]+$/));
440 $self->{PARENT}->{CHILDREN}->{$newclass} = $self if $self->{PARENT};
442 parse_args($self,@ARGV);
445 $self->{NAME} ||= $self->guess_name;
447 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
451 if (! $self->{PERL_SRC} ) {
452 my($pthinks) = $INC{'Config.pm'};
453 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
454 if ($pthinks ne $self->catfile($Config{archlibexp},'Config.pm')){
455 $pthinks =~ s!/Config\.pm$!!;
458 Your perl and your Config.pm seem to have different ideas about the architecture
460 Perl thinks: [$pthinks]
461 Config says: [$Config{archname}]
462 This may or may not cause problems. Please check your installation of perl if you
463 have problems building this extension.
468 $self->init_dirscan();
469 $self->init_others();
471 push @{$self->{RESULT}}, <<END;
472 # This Makefile is for the $self->{NAME} extension to perl.
474 # It was generated automatically by MakeMaker version
475 # $VERSION (Revision: $Revision) from the contents of
476 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
478 # ANY CHANGES MADE HERE WILL BE LOST!
480 # MakeMaker Parameters:
483 foreach $key (sort keys %initial_att){
484 my($v) = neatvalue($initial_att{$key});
485 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
487 push @{$self->{RESULT}}, "# $key => $v";
490 # turn the SKIP array into a SKIPHASH hash
492 for $skip (@{$self->{SKIP} || []}) {
493 $self->{SKIPHASH}{$skip} = 1;
495 delete $self->{SKIP}; # free memory
497 if ($self->{PARENT}) {
498 for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
499 $self->{SKIPHASH}{$_} = 1;
503 # We run all the subdirectories now. They don't have much to query
504 # from the parent, but the parent has to query them: if they need linking!
505 unless ($self->{NORECURS}) {
506 $self->eval_in_subdirs if @{$self->{DIR}};
510 foreach $section ( @MM_Sections ){
511 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
512 my($skipit) = $self->skipcheck($section);
514 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
516 my(%a) = %{$self->{$section} || {}};
517 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
518 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
519 push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
523 push @{$self->{RESULT}}, "\n# End.";
530 print STDOUT "Checking if your kit is complete...\n";
531 require ExtUtils::Manifest;
532 $ExtUtils::Manifest::Quiet=$ExtUtils::Manifest::Quiet=1; #avoid warning
533 my(@missed)=ExtUtils::Manifest::manicheck();
535 print STDOUT "Warning: the following files are missing in your kit:\n";
536 print "\t", join "\n\t", @missed;
538 print STDOUT "Please inform the author.\n";
540 print STDOUT "Looks good\n";
545 my($self, @args) = @_;
547 unless (m/(.*?)=(.*)/){
548 help(),exit 1 if m/^help$/;
549 ++$Verbose if m/^verb/;
552 my($name, $value) = ($1, $2);
553 if ($value =~ m/^~(\w+)?/){ # tilde with optional username
554 $value =~ s [^~(\w*)]
556 ((getpwnam($1))[7] || "~$1") :
560 $self->{uc($name)} = $value;
563 # catch old-style 'potential_libs' and inform user how to 'upgrade'
564 if (defined $self->{potential_libs}){
565 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
566 if ($self->{potential_libs}){
567 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
569 print STDOUT "$msg deleted.\n";
571 $self->{LIBS} = [$self->{potential_libs}];
572 delete $self->{potential_libs};
574 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
575 if (defined $self->{ARMAYBE}){
576 my($armaybe) = $self->{ARMAYBE};
577 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
578 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
579 my(%dl) = %{$self->{dynamic_lib} || {}};
580 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
581 delete $self->{ARMAYBE};
583 if (defined $self->{LDTARGET}){
584 print STDOUT "LDTARGET should be changed to LDFROM\n";
585 $self->{LDFROM} = $self->{LDTARGET};
586 delete $self->{LDTARGET};
588 # Turn a DIR argument on the command line into an array
589 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
590 # So they can choose from the command line, which extensions they want
591 # the grep enables them to have some colons too much in case they
592 # have to build a list with the shell
593 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
595 # Turn a INCLUDE_EXT argument on the command line into an array
596 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
597 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
599 # Turn a EXCLUDE_EXT argument on the command line into an array
600 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
601 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
604 foreach $mmkey (sort keys %$self){
605 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
606 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
607 unless exists $Recognized_Att_Keys{$mmkey};
614 # We allow extension-specific hints files.
616 return unless -d "hints";
618 # First we look for the best hintsfile we have
620 my($hint)="${^O}_$Config{osvers}";
625 # Also try without trailing minor version numbers.
627 last if -f "hints/$hint.pl"; # found
629 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
631 return unless -f "hints/$hint.pl"; # really there
633 # execute the hintsfile:
635 # my $fh = new FileHandle;
636 # $fh->open("hints/$hint.pl");
638 open(FH,"hints/$hint.pl");
639 # @goodhints = <$fh>;
643 print STDOUT "Processing hints file hints/$hint.pl\n";
644 eval join('',@goodhints);
645 print STDOUT $@ if $@;
651 my($symtab) = \%{"${from}::"};
654 # Here you see the *current* list of methods that are overridable
655 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
656 # still trying to reduce the list to some reasonable minimum --
657 # because I want to make it easier for the user. A.K.
659 foreach $method (@Overridable) {
661 # We cannot say "next" here. Nick might call MY->makeaperl
662 # which isn't defined right now
664 # Above statement was written at 4.23 time when Tk-b8 was
665 # around. As Tk-b9 only builds with 5.002something and MM 5 is
666 # standard, we try to enable the next line again. It was
667 # commented out until MM 5.23
669 next unless defined &{"${from}::$method"};
671 *{"${to}::$method"} = \&{"${from}::$method"};
673 # delete would do, if we were sure, nobody ever called
674 # MY->makeaperl directly
676 # delete $symtab->{$method};
678 # If we delete a method, then it will be undefined and cannot
679 # be called. But as long as we have Makefile.PLs that rely on
680 # %MY:: being intact, we have to fill the hole with an
683 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
686 # We have to clean out %INC also, because the current directory is
687 # changed frequently and Graham Barr prefers to get his version
688 # out of a History.pl file which is "required" so woudn't get
689 # loaded again in another extension requiring a History.pl
691 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
692 # to core dump in the middle of a require statement. The required
693 # file was Tk/MMutil.pm. The consequence is, we have to be
694 # extremely careful when we try to give perl a reason to reload a
695 # library with same name. The workaround prefers to drop nothing
696 # from %INC and teach the writers not to use such libraries.
699 # foreach $inc (keys %INC) {
700 # #warn "***$inc*** deleted";
708 if ($section eq 'dynamic') {
709 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
710 "in skipped section 'dynamic_bs'\n"
711 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
712 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
713 "in skipped section 'dynamic_lib'\n"
714 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
716 if ($section eq 'dynamic_lib') {
717 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
718 "targets in skipped section 'dynamic_bs'\n"
719 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
721 if ($section eq 'static') {
722 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
723 "in skipped section 'static_lib'\n"
724 if $self->{SKIPHASH}{static_lib} && $Verbose;
726 return 'skipped' if $self->{SKIPHASH}{$section};
734 # my $fh = new FileHandle;
736 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
738 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
739 # $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
740 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
742 for $chunk (@{$self->{RESULT}}) {
743 # print $fh "$chunk\n";
749 my($finalname) = $self->{MAKEFILE};
750 rename("MakeMaker.tmp", $finalname);
751 chmod 0644, $finalname unless $Is_VMS;
753 if ($self->{PARENT}) {
754 foreach (keys %$self) { # safe memory
755 delete $self->{$_} unless $Keep_after_flush{$_};
759 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
762 # The following mkbootstrap() is only for installations that are calling
763 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
764 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
767 !!! Your Makefile has been built such a long time ago, !!!
768 !!! that is unlikely to work with current MakeMaker. !!!
769 !!! Please rebuild your Makefile !!!
773 # Ditto for mksymlists() as of MakeMaker 5.17
776 !!! Your Makefile has been built such a long time ago, !!!
777 !!! that is unlikely to work with current MakeMaker. !!!
778 !!! Please rebuild your Makefile !!!
784 return "undef" unless defined $v;
786 return "q[$v]" unless $t;
788 my(@m, $elem, @neat);
790 foreach $elem (@$v) {
791 push @neat, "q[$elem]";
793 push @m, join ", ", @neat;
797 return "$v" unless $t eq 'HASH';
799 while (($key,$val) = each %$v){
800 last unless defined $key; # cautious programming in case (undef,undef) is true
801 push(@m,"$key=>".neatvalue($val)) ;
803 return "{ ".join(', ',@m)." }";
810 push @m, "\n# Full list of MakeMaker attribute values:";
811 foreach $key (sort keys %$self){
812 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
813 my($v) = neatvalue($self->{$key});
814 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
816 push @m, "# $key => $v";
822 package ExtUtils::MakeMaker;
829 ExtUtils::MakeMaker - create an extension Makefile
833 C<use ExtUtils::MakeMaker;>
835 C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
839 C<MM-E<gt>new(\%att)-E<gt>flush;>
843 This utility is designed to write a Makefile for an extension module
844 from a Makefile.PL. It is based on the Makefile.SH model provided by
845 Andy Dougherty and the perl5-porters.
847 It splits the task of generating the Makefile into several subroutines
848 that can be individually overridden. Each subroutine returns the text
849 it wishes to have written to the Makefile.
851 MakeMaker is object oriented. Each directory below the current
852 directory that contains a Makefile.PL. Is treated as a separate
853 object. This makes it possible to write an unlimited number of
854 Makefiles with a single invocation of WriteMakefile().
856 =head2 How To Write A Makefile.PL
858 The short answer is: Don't.
860 Always begin with h2xs.
861 Always begin with h2xs!
862 ALWAYS BEGIN WITH H2XS!
864 even if you're not building around a header file, and even if you
865 don't have an XS component.
867 Run h2xs(1) before you start thinking about writing a module. For so
868 called pm-only modules that consist of C<*.pm> files only, h2xs has
869 the C<-X> switch. This will generate dummy files of all kinds that are
870 useful for the module developer.
872 The medium answer is:
874 use ExtUtils::MakeMaker;
875 WriteMakefile( NAME => "Foo::Bar" );
877 The long answer is the rest of the manpage :-)
879 =head2 Default Makefile Behaviour
881 The generated Makefile enables the user of the extension to invoke
883 perl Makefile.PL # optionally "perl Makefile.PL verbose"
885 make test # optionally set TEST_VERBOSE=1
886 make install # See below
888 The Makefile to be produced may be altered by adding arguments of the
889 form C<KEY=VALUE>. E.g.
891 perl Makefile.PL PREFIX=/tmp/myperl5
893 Other interesting targets in the generated Makefile are
895 make config # to check if the Makefile is up-to-date
896 make clean # delete local temp files (Makefile gets renamed)
897 make realclean # delete derived files (including ./blib)
898 make ci # check in all the files in the MANIFEST file
899 make dist # see below the Distribution Support section
903 MakeMaker checks for the existence of a file named F<test.pl> in the
904 current directory and if it exists it adds commands to the test target
905 of the generated Makefile that will execute the script with the proper
906 set of perl C<-I> options.
908 MakeMaker also checks for any files matching glob("t/*.t"). It will
909 add commands to the test target of the generated Makefile that execute
910 all matching files via the L<Test::Harness> module with the C<-I>
911 switches set correctly.
915 A useful variation of the above is the target C<testdb>. It runs the
916 test under the Perl debugger (see L<perldebug>). If the file
917 F<test.pl> exists in the current directory, it is used for the test.
919 If you want to debug some other testfile, set C<TEST_FILE> variable
922 make testdb TEST_FILE=t/mytest.t
924 By default the debugger is called using C<-d> option to perl. If you
925 want to specify some other option, set C<TESTDB_SW> variable:
927 make testdb TESTDB_SW=-Dx
931 make alone puts all relevant files into directories that are named by
932 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_MAN1DIR, and
933 INST_MAN3DIR. All these default to something below ./blib if you are
934 I<not> building below the perl source directory. If you I<are>
935 building below the perl source, INST_LIB and INST_ARCHLIB default to
936 ../../lib, and INST_SCRIPT is not defined.
938 The I<install> target of the generated Makefile copies the files found
939 below each of the INST_* directories to their INSTALL*
940 counterparts. Which counterparts are chosen depends on the setting of
941 INSTALLDIRS according to the following table:
946 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH
947 INST_LIB INSTALLPRIVLIB INSTALLSITELIB
949 INST_SCRIPT INSTALLSCRIPT
950 INST_MAN1DIR INSTALLMAN1DIR
951 INST_MAN3DIR INSTALLMAN3DIR
953 The INSTALL... macros in turn default to their %Config
954 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
956 You can check the values of these variables on your system with
960 And to check the sequence in which the library directories are
961 searched by perl, run
963 perl -le 'print join $/, @INC'
966 =head2 PREFIX and LIB attribute
968 PREFIX and LIB can be used to set several INSTALL* attributes in one
969 go. The quickest way to install a module in a non-standard place might
972 perl Makefile.PL LIB=~/lib
974 This will install the module's architecture-independent files into
975 ~/lib, the architecture-dependent files into ~/lib/$archname/auto.
977 Another way to specify many INSTALL directories with a single
980 perl Makefile.PL PREFIX=~
982 This will replace the string specified by $Config{prefix} in all
983 $Config{install*} values.
985 Note, that in both cases the tilde expansion is done by MakeMaker, not
986 by perl by default, nor by make. Conflicts between parmeters LIB,
987 PREFIX and the various INSTALL* arguments are resolved so that
990 If the user has superuser privileges, and is not working on AFS
991 (Andrew File System) or relatives, then the defaults for
992 INSTALLPRIVLIB, INSTALLARCHLIB, INSTALLSCRIPT, etc. will be appropriate,
993 and this incantation will be the best:
995 perl Makefile.PL; make; make test
998 make install per default writes some documentation of what has been
999 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1000 can be bypassed by calling make pure_install.
1004 will have to specify the installation directories as these most
1005 probably have changed since perl itself has been installed. They will
1006 have to do this by calling
1008 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1009 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1012 Be careful to repeat this procedure every time you recompile an
1013 extension, unless you are sure the AFS installation directories are
1016 =head2 Static Linking of a new Perl Binary
1018 An extension that is built with the above steps is ready to use on
1019 systems supporting dynamic loading. On systems that do not support
1020 dynamic loading, any newly created extension has to be linked together
1021 with the available resources. MakeMaker supports the linking process
1022 by creating appropriate targets in the Makefile whenever an extension
1023 is built. You can invoke the corresponding section of the makefile with
1027 That produces a new perl binary in the current directory with all
1028 extensions linked in that can be found in INST_ARCHLIB , SITELIBEXP,
1029 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1030 UNIX, this is called Makefile.aperl (may be system dependent). If you
1031 want to force the creation of a new perl, it is recommended, that you
1032 delete this Makefile.aperl, so the directories are searched-through
1033 for linkable libraries again.
1035 The binary can be installed into the directory where perl normally
1036 resides on your machine with
1040 To produce a perl binary with a different name than C<perl>, either say
1042 perl Makefile.PL MAP_TARGET=myperl
1049 make myperl MAP_TARGET=myperl
1050 make inst_perl MAP_TARGET=myperl
1052 In any case you will be prompted with the correct invocation of the
1053 C<inst_perl> target that installs the new binary into INSTALLBIN.
1055 make inst_perl per default writes some documentation of what has been
1056 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1057 can be bypassed by calling make pure_inst_perl.
1059 Warning: the inst_perl: target will most probably overwrite your
1060 existing perl binary. Use with care!
1062 Sometimes you might want to build a statically linked perl although
1063 your system supports dynamic loading. In this case you may explicitly
1064 set the linktype with the invocation of the Makefile.PL or make:
1066 perl Makefile.PL LINKTYPE=static # recommended
1070 make LINKTYPE=static # works on most systems
1072 =head2 Determination of Perl Library and Installation Locations
1074 MakeMaker needs to know, or to guess, where certain things are
1075 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1076 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1077 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1079 Extensions may be built either using the contents of the perl source
1080 directory tree or from the installed perl library. The recommended way
1081 is to build extensions after you have run 'make install' on perl
1082 itself. You can do that in any directory on your hard disk that is not
1083 below the perl source tree. The support for extensions below the ext
1084 directory of the perl distribution is only good for the standard
1085 extensions that come with perl.
1087 If an extension is being built below the C<ext/> directory of the perl
1088 source then MakeMaker will set PERL_SRC automatically (e.g.,
1089 C<../..>). If PERL_SRC is defined and the extension is recognized as
1090 a standard extension, then other variables default to the following:
1093 PERL_LIB = PERL_SRC/lib
1094 PERL_ARCHLIB = PERL_SRC/lib
1096 INST_ARCHLIB = PERL_ARCHLIB
1098 If an extension is being built away from the perl source then MakeMaker
1099 will leave PERL_SRC undefined and default to using the installed copy
1100 of the perl library. The other variables default to the following:
1102 PERL_INC = $archlibexp/CORE
1103 PERL_LIB = $privlibexp
1104 PERL_ARCHLIB = $archlibexp
1105 INST_LIB = ./blib/lib
1106 INST_ARCHLIB = ./blib/arch
1108 If perl has not yet been installed then PERL_SRC can be defined on the
1109 command line as shown in the previous section.
1112 =head2 Which architecture dependent directory?
1114 If you don't want to keep the defaults for the INSTALL* macros,
1115 MakeMaker helps you to minimize the typing needed: the usual
1116 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1117 by Configure at perl compilation time. MakeMaker supports the user who
1118 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1119 then MakeMaker defaults the latter to be the same subdirectory of
1120 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1121 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1122 for INSTALLSITELIB and INSTALLSITEARCH.
1124 MakeMaker gives you much more freedom than needed to configure
1125 internal variables and get different results. It is worth to mention,
1126 that make(1) also lets you configure most of the variables that are
1127 used in the Makefile. But in the majority of situations this will not
1128 be necessary, and should only be done, if the author of a package
1129 recommends it (or you know what you're doing).
1131 =head2 Using Attributes and Parameters
1133 The following attributes can be specified as arguments to WriteMakefile()
1134 or as NAME=VALUE pairs on the command line:
1138 # The following "=item C" is used by the attrib_help routine
1139 # likewise the "=back" below. So be careful when changing it!
1145 Ref to array of *.c file names. Initialised from a directory scan
1146 and the values portion of the XS attribute hash. This is not
1147 currently used by MakeMaker but may be handy in Makefile.PLs.
1151 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1152 config.sh. MakeMaker will add to CONFIG the following values anyway:
1172 CODE reference. The subroutine should return a hash reference. The
1173 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1174 be determined by some evaluation method.
1178 Something like C<"-DHAVE_UNISTD_H">
1182 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1187 Your name for distributing the package (by tar file). This defaults to
1192 Hashref of symbol names for routines to be made available as
1193 universal symbols. Each key/value pair consists of the package name
1194 and an array of routine names in that package. Used only under AIX
1195 (export lists) and VMS (linker options) at present. The routine
1196 names supplied will be expanded in the same way as XSUB names are
1197 expanded by the XS() macro. Defaults to
1199 {"$(NAME)" => ["boot_$(NAME)" ] }
1203 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1204 "NetconfigPtr" => [ 'DESTROY'] }
1208 Array of symbol names for variables to be made available as
1209 universal symbols. Used only under AIX (export lists) and VMS
1210 (linker options) at present. Defaults to []. (e.g. [ qw(
1211 Foo_version Foo_numstreams Foo_tree ) ])
1215 Array of extension names to exclude when doing a static build. This
1216 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1217 details. (e.g. [ qw( Socket POSIX ) ] )
1219 This attribute may be most useful when specified as a string on the
1220 commandline: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1224 Ref to array of executable files. The files will be copied to the
1225 INST_SCRIPT directory. Make realclean will delete them from there
1230 In general any generated Makefile checks for the current version of
1231 MakeMaker and the version the Makefile was built under. If NO_VC is
1232 set, the version check is neglected. Do not write this into your
1233 Makefile.PL, use it interactively instead.
1235 =item FIRST_MAKEFILE
1237 The name of the Makefile to be produced. Defaults to the contents of
1238 MAKEFILE, but can be overridden. This is used for the second Makefile
1239 that will be produced for the MAP_TARGET.
1243 Perl binary able to run this extension.
1247 Ref to array of *.h file names. Similar to C.
1251 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1255 Array of extension names to be included when doing a static build.
1256 MakeMaker will normally build with all of the installed extensions when
1257 doing a static build, and that is usually the desired behavior. If
1258 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1259 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1261 It is not necessary to mention DynaLoader or the current extension when
1262 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1263 only DynaLoader and the current extension will be included in the build.
1265 This attribute may be most useful when specified as a string on the
1266 commandline: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1268 =item INSTALLARCHLIB
1270 Used by 'make install', which copies files from INST_ARCHLIB to this
1271 directory if INSTALLDIRS is set to perl.
1275 Directory to install binary files (e.g. tkperl) into.
1279 Determines which of the two sets of installation directories to
1280 choose: installprivlib and installarchlib versus installsitelib and
1281 installsitearch. The first pair is chosen with INSTALLDIRS=perl, the
1282 second with INSTALLDIRS=site. Default is site.
1284 =item INSTALLMAN1DIR
1286 This directory gets the man pages at 'make install' time. Defaults to
1287 $Config{installman1dir}.
1289 =item INSTALLMAN3DIR
1291 This directory gets the man pages at 'make install' time. Defaults to
1292 $Config{installman3dir}.
1294 =item INSTALLPRIVLIB
1296 Used by 'make install', which copies files from INST_LIB to this
1297 directory if INSTALLDIRS is set to perl.
1301 Used by 'make install' which copies files from INST_SCRIPT to this
1304 =item INSTALLSITELIB
1306 Used by 'make install', which copies files from INST_LIB to this
1307 directory if INSTALLDIRS is set to site (default).
1309 =item INSTALLSITEARCH
1311 Used by 'make install', which copies files from INST_ARCHLIB to this
1312 directory if INSTALLDIRS is set to site (default).
1316 Same as INST_LIB for architecture dependent files.
1320 Directory to put real binary files during 'make'. These will be copied
1321 to INSTALLBIN during 'make install'
1325 Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you
1330 Directory where we put library files of this extension while building
1335 Directory to hold the man pages at 'make' time
1339 Directory to hold the man pages at 'make' time
1343 Directory, where executable files should be installed during
1344 'make'. Defaults to "./blib/bin", just to have a dummy location during
1345 testing. make install will copy the files in INST_SCRIPT to
1350 defaults to "$(OBJECT)" and is used in the ld command to specify
1351 what files to link/load from (also see dynamic_lib below for how to
1356 The filename of the perllibrary that will be used together with this
1357 extension. Defaults to libperl.a.
1361 LIB can only be set at C<perl Makefile.PL> time. It has the effect of
1362 setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any
1366 An anonymous array of alternative library
1367 specifications to be searched for (in order) until
1368 at least one library is found. E.g.
1370 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1372 Mind, that any element of the array
1373 contains a complete set of arguments for the ld
1374 command. So do not specify
1376 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1378 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1379 you specify a scalar as in
1381 'LIBS' => "-ltcl -ltk -lX11"
1383 MakeMaker will turn it into an array with one element.
1387 'static' or 'dynamic' (default unless usedl=undef in
1388 config.sh). Should only be used to force static linking (also see
1393 Boolean which tells MakeMaker, that it should include the rules to
1394 make a perl. This is handled automatically as a switch by
1395 MakeMaker. The user normally does not need it.
1399 The name of the Makefile to be produced.
1403 Hashref of pod-containing files. MakeMaker will default this to all
1404 EXE_FILES files that include POD directives. The files listed
1405 here will be converted to man pages and installed as was requested
1410 Hashref of .pm and .pod files. MakeMaker will default this to all
1411 .pod and any .pm files that include POD directives. The files listed
1412 here will be converted to man pages and installed as was requested
1417 If it is intended, that a new perl binary be produced, this variable
1418 may hold a name for that binary. Defaults to perl
1422 If the extension links to a library that it builds set this to the
1423 name of the library (see SDBM_File)
1427 Perl module name for this extension (DBD::Oracle). This will default
1428 to the directory name but should be explicitly defined in the
1433 MakeMaker will figure out, if an extension contains linkable code
1434 anywhere down the directory tree, and will set this variable
1435 accordingly, but you can speed it up a very little bit, if you define
1436 this boolean variable yourself.
1440 Defaults to C<@>. By setting it to an empty string you can generate a
1441 Makefile that echos all commands. Mainly used in debugging MakeMaker
1446 Boolean. Attribute to inhibit descending into subdirectories.
1450 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1451 string containing all object files, e.g. "tkpBind.o
1452 tkpButton.o tkpCanvas.o"
1456 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1457 passed to subdirectory makes.
1461 Perl binary for tasks that can be done by miniperl
1465 The call to the program that is able to compile perlmain.c. Defaults
1470 Same as above for architecture dependent files
1474 Directory containing the Perl library to use.
1478 Directory containing the Perl source code (use of this should be
1479 avoided, it may be undefined)
1483 Ref to hash of files to be processed as perl programs. MakeMaker
1484 will default to any found *.PL file (except Makefile.PL) being keys
1485 and the basename of the file being the value. E.g.
1487 {'foobar.PL' => 'foobar'}
1489 The *.PL files are expected to produce output to the target files
1494 Hashref of .pm files and *.pl files to be installed. e.g.
1496 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1498 By default this will include *.pm and *.pl. If a lib directory
1499 exists and is not listed in DIR (above) then any *.pm and *.pl files
1500 it contains will also be included by default. Defining PM in the
1501 Makefile.PL will override PMLIBDIRS.
1505 Ref to array of subdirectories containing library files. Defaults to
1506 [ 'lib', $(BASEEXT) ]. The directories will be scanned and any files
1507 they contain will be installed in the corresponding location in the
1508 library. A libscan() method can be used to alter the behaviour.
1509 Defining PM in the Makefile.PL will override PMLIBDIRS.
1513 Can be used to set the three INSTALL* attributes in one go (except for
1514 probably INSTALLMAN1DIR, if it is not below PREFIX according to
1515 %Config). They will have PREFIX as a common directory node and will
1516 branch from that node into lib/, lib/ARCHNAME or whatever Configure
1517 decided at the build time of your perl (unless you override one of
1522 Hashref: Names of modules that need to be available to run this
1523 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1524 desired version is the value. If the required version number is 0, we
1525 only check if any version is installed already.
1529 Arryref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1530 Makefile. Caution! Do not use the SKIP attribute for the neglectible
1531 speedup. It may seriously damage the resulting Makefile. Only use it,
1532 if you really need it.
1536 Ref to array of typemap file names. Use this when the typemaps are
1537 in some directory other than the current directory or when they are
1538 not named B<typemap>. The last typemap in the list takes
1539 precedence. A typemap in the current directory has highest
1540 precedence, even if it isn't listed in TYPEMAPS. The default system
1541 typemap has lowest precedence.
1545 Your version number for distributing the package. This defaults to
1550 Instead of specifying the VERSION in the Makefile.PL you can let
1551 MakeMaker parse a file to determine the version number. The parsing
1552 routine requires that the file named by VERSION_FROM contains one
1553 single line to compute the version number. The first line in the file
1554 that contains the regular expression
1556 /\$(([\w\:\']*)\bVERSION)\b.*\=/
1558 will be evaluated with eval() and the value of the named variable
1559 B<after> the eval() will be assigned to the VERSION attribute of the
1560 MakeMaker object. The following lines will be parsed o.k.:
1563 ( $VERSION ) = '$Revision: 1.211 $ ' =~ /\$Revision:\s+([^\s]+)/;
1564 $FOO::VERSION = '1.10';
1566 but these will fail:
1568 my $VERSION = '1.01';
1569 local $VERSION = '1.02';
1570 local $FOO::VERSION = '1.30';
1572 The file named in VERSION_FROM is added as a dependency to Makefile to
1573 guarantee, that the Makefile contains the correct VERSION macro after
1574 a change of the file.
1578 Hashref of .xs files. MakeMaker will default this. e.g.
1580 {'name_of_file.xs' => 'name_of_file.c'}
1582 The .c files will automatically be included in the list of files
1583 deleted by a make clean.
1587 String of options to pass to xsubpp. This might include C<-C++> or
1588 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
1593 May be set to an empty string, which is identical to C<-prototypes>, or
1594 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
1595 defaults to the empty string.
1599 Your version number for the .xs file of this package. This defaults
1600 to the value of the VERSION attribute.
1604 =head2 Additional lowercase attributes
1606 can be used to pass parameters to the methods which implement that
1607 part of the Makefile.
1613 {FILES => "*.xyz foo"}
1617 {ANY_TARGET => ANY_DEPENDECY, ...}
1621 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => 'gz',
1622 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
1623 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
1625 If you specify COMPRESS, then SUFFIX should also be altered, as it is
1626 needed to tell make the target file of the compression. Setting
1627 DIST_CP to ln can be useful, if you need to preserve the timestamps on
1628 your files. DIST_CP can take the values 'cp', which copies the file,
1629 'ln', which links the file, and 'best' which copies symbolic links and
1630 links the rest. Default is 'best'.
1634 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
1638 Deprecated as of MakeMaker 5.23. See L<ExtUtils::MM_Unix/pm_to_blib>.
1642 {LINKTYPE => 'static', 'dynamic' or ''}
1644 NB: Extensions that have nothing but *.pm files had to say
1648 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1649 can be deleted safely. MakeMaker recognizes, when there's nothing to
1654 {ANY_MACRO => ANY_VALUE, ...}
1658 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
1660 =item tool_autosplit
1668 # bug in pod2html, so leave the =back
1670 # Don't delete this cut, MM depends on it!
1672 =head2 Overriding MakeMaker Methods
1674 If you cannot achieve the desired Makefile behaviour by specifying
1675 attributes you may define private subroutines in the Makefile.PL.
1676 Each subroutines returns the text it wishes to have written to
1677 the Makefile. To override a section of the Makefile you can
1680 sub MY::c_o { "new literal text" }
1682 or you can edit the default by saying something like:
1685 my($inherited) = shift->SUPER::c_o(@_);
1686 $inherited =~ s/old text/new text/;
1690 If you running experiments with embedding perl as a library into other
1691 applications, you might find MakeMaker not sufficient. You'd better
1692 have a look at ExtUtils::embed which is a collection of utilities for
1695 If you still need a different solution, try to develop another
1696 subroutine, that fits your needs and submit the diffs to
1697 F<perl5-porters@nicoh.com> or F<comp.lang.perl.misc> as appropriate.
1699 For a complete description of all MakeMaker methods see L<ExtUtils::MM_Unix>.
1701 Here is a simple example of how to add a new target to the generated
1706 $(MYEXTLIB): sdbm/Makefile
1707 cd sdbm && $(MAKE) all
1712 =head2 Hintsfile support
1714 MakeMaker.pm uses the architecture specific information from
1715 Config.pm. In addition it evaluates architecture specific hints files
1716 in a C<hints/> directory. The hints files are expected to be named
1717 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
1718 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
1719 MakeMaker within the WriteMakefile() subroutine, and can be used to
1720 execute commands as well as to include special variables. The rules
1721 which hintsfile is chosen are the same as in Configure.
1723 The hintsfile is eval()ed immediately after the arguments given to
1724 WriteMakefile are stuffed into a hash reference $self but before this
1725 reference becomes blessed. So if you want to do the equivalent to
1726 override or create an attribute you would say something like
1728 $self->{LIBS} = ['-ldbm -lucb -lc'];
1730 =head2 Distribution Support
1732 For authors of extensions MakeMaker provides several Makefile
1733 targets. Most of the support comes from the ExtUtils::Manifest module,
1734 where additional documentation can be found.
1738 =item make distcheck
1740 reports which files are below the build directory but not in the
1741 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
1744 =item make skipcheck
1746 reports which files are skipped due to the entries in the
1747 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
1750 =item make distclean
1752 does a realclean first and then the distcheck. Note that this is not
1753 needed to build a new distribution as long as you are sure, that the
1754 MANIFEST file is ok.
1758 rewrites the MANIFEST file, adding all remaining files found (See
1759 ExtUtils::Manifest::mkmanifest() for details)
1763 Copies all the files that are in the MANIFEST file to a newly created
1764 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
1765 exists, it will be removed first.
1769 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
1770 a make test in that directory.
1774 First does a distdir. Then a command $(PREOP) which defaults to a null
1775 command, followed by $(TOUNIX), which defaults to a null command under
1776 UNIX, and will convert files in distribution directory to UNIX format
1777 otherwise. Next it runs C<tar> on that directory into a tarfile and
1778 deletes the directory. Finishes with a command $(POSTOP) which
1779 defaults to a null command.
1783 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
1785 =item make uutardist
1787 Runs a tardist first and uuencodes the tarfile.
1791 First does a distdir. Then a command $(PREOP) which defaults to a null
1792 command. Next it runs C<shar> on that directory into a sharfile and
1793 deletes the intermediate directory again. Finishes with a command
1794 $(POSTOP) which defaults to a null command. Note: For shdist to work
1795 properly a C<shar> program that can handle directories is mandatory.
1799 First does a distdir. Then a command $(PREOP) which defaults to a null
1800 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
1801 zipfile. Then deletes that directory. Finishes with a command
1802 $(POSTOP) which defaults to a null command.
1806 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
1810 Customization of the dist targets can be done by specifying a hash
1811 reference to the dist attribute of the WriteMakefile call. The
1812 following parameters are recognized:
1815 COMPRESS ('compress')
1818 TO_UNIX (depends on the system)
1819 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
1829 WriteMakefile( 'dist' => { COMPRESS=>"gzip", SUFFIX=>"gz" })
1833 ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib,
1834 ExtUtils::Install, ExtUtils::embed
1838 Andy Dougherty <F<doughera@lafcol.lafayette.edu>>, Andreas KE<ouml>nig
1839 <F<A.Koenig@franz.ww.TU-Berlin.DE>>, Tim Bunce <F<Tim.Bunce@ig.co.uk>>.
1840 VMS support by Charles Bailey <F<bailey@genetics.upenn.edu>>. OS/2
1841 support by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>. Contact the
1842 makemaker mailing list C<mailto:makemaker@franz.ww.tu-berlin.de>, if
1843 you have any questions.