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';
73 $Is_Cygwin= $^O =~ /cygwin/i;
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 require ExtUtils::MM_Win32;
91 require ExtUtils::MM_Cygwin;
94 # The SelfLoader would bring a lot of overhead for MakeMaker, because
95 # we know for sure we will use most of the autoloaded functions once
96 # we have to use one of them. So we write our own loader
100 if (defined fileno(DATA)) {
101 my $fh = select DATA;
102 my $o = $/; # For future reads from the file.
114 warn "AUTOLOAD called unexpectedly for $AUTOLOAD";
116 defined(&$AUTOLOAD) or die "Myloader inconsistency error";
120 # The only subroutine we do not SelfLoad is Version_Check because it's
121 # called so often. Loading this minimum still requires 1.2 secs on my
125 my($checkversion) = @_;
126 die "Your Makefile was built with ExtUtils::MakeMaker v $checkversion.
127 Current Version is $ExtUtils::MakeMaker::VERSION. There have been considerable
128 changes in the meantime.
129 Please rerun 'perl Makefile.PL' to regenerate the Makefile.\n"
130 if $checkversion < $Version_OK;
131 printf STDOUT "%s %s %s %s.\n", "Makefile built with ExtUtils::MakeMaker v",
132 $checkversion, "Current Version is", $VERSION
133 unless $checkversion == $VERSION;
137 $_[0] =~ /^Use of uninitialized value/ && return;
138 $_[0] =~ /used only once/ && return;
139 $_[0] =~ /^Subroutine\s+[\w:]+\s+redefined/ && return;
143 sub ExtUtils::MakeMaker::eval_in_subdirs ;
144 sub ExtUtils::MakeMaker::eval_in_x ;
145 sub ExtUtils::MakeMaker::full_setup ;
146 sub ExtUtils::MakeMaker::writeMakefile ;
147 sub ExtUtils::MakeMaker::new ;
148 sub ExtUtils::MakeMaker::check_manifest ;
149 sub ExtUtils::MakeMaker::parse_args ;
150 sub ExtUtils::MakeMaker::check_hints ;
151 sub ExtUtils::MakeMaker::mv_all_methods ;
152 sub ExtUtils::MakeMaker::skipcheck ;
153 sub ExtUtils::MakeMaker::flush ;
154 sub ExtUtils::MakeMaker::mkbootstrap ;
155 sub ExtUtils::MakeMaker::mksymlists ;
156 sub ExtUtils::MakeMaker::neatvalue ;
157 sub ExtUtils::MakeMaker::selfdocument ;
158 sub ExtUtils::MakeMaker::WriteMakefile ;
159 sub ExtUtils::MakeMaker::prompt ($;$) ;
165 package ExtUtils::MakeMaker;
168 Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
169 local $SIG{__WARN__} = \&warnhandler;
171 unless ($Setup_done++){
173 undef &ExtUtils::MakeMaker::full_setup; #safe memory
176 MM->new(\%att)->flush;
181 $ISA_TTY = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ; # Pipe?
182 Carp::confess("prompt function called without an argument") unless defined $mess;
183 my $dispdef = defined $def ? "[$def] " : " ";
184 $def = defined $def ? $def : "";
187 print "$mess $dispdef";
189 chomp($ans = <STDIN>);
193 return ($ans ne '') ? $ans : $def;
196 sub eval_in_subdirs {
202 foreach $dir (@{$self->{DIR}}){
203 my($abs) = $self->catdir($pwd,$dir);
204 $self->eval_in_x($abs);
212 chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
214 # my $fh = new FileHandle;
215 # $fh->open("Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
217 open(FH,"Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
218 # my $eval = join "", <$fh>;
219 my $eval = join "", <FH>;
224 # if ($@ =~ /prerequisites/) {
225 # die "MakeMaker WARNING: $@";
227 # warn "WARNING from evaluation of $dir/Makefile.PL: $@";
229 warn "WARNING from evaluation of $dir/Makefile.PL: $@";
237 # package name for the classes into which the first object will be blessed
238 $PACKNAME = "PACK000";
242 AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION
243 C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
244 EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE FULLPERL FUNCLIST H
245 HTMLLIBPODS HTMLSCRIPTPOD IMPORTS
246 INC INCLUDE_EXT INSTALLARCHLIB INSTALLBIN INSTALLDIRS INSTALLHTMLPRIVLIBDIR
247 INSTALLHTMLSCRIPTDIR INSTALLHTMLSITELIBDIR INSTALLMAN1DIR
248 INSTALLMAN3DIR INSTALLPRIVLIB INSTALLSCRIPT INSTALLSITEARCH
249 INSTALLSITELIB INST_ARCHLIB INST_BIN INST_EXE INST_LIB
250 INST_HTMLLIBDIR INST_HTMLSCRIPTDIR
251 INST_MAN1DIR INST_MAN3DIR INST_SCRIPT LDFROM LIB LIBPERL_A LIBS
252 LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB
253 NAME NEEDS_LINKING NOECHO NORECURS NO_VC OBJECT OPTIMIZE PERL PERLMAINCC
254 PERL_ARCHLIB PERL_LIB PERL_SRC PERM_RW PERM_RWX
255 PL_FILES PM PMLIBDIRS POLLUTE PPM_INSTALL_EXEC PPM_INSTALL_SCRIPT PREFIX
256 PREREQ_PM SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
257 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
261 # IMPORTS is used under OS/2 and Win32
263 # @Overridable is close to @MM_Sections but not identical. The
264 # order is important. Many subroutines declare macros. These
265 # depend on each other. Let's try to collect the macros up front,
266 # then pasthru, then the rules.
268 # MM_Sections are the sections we have to call explicitly
269 # in Overridable we have subroutines that are used indirectly
275 post_initialize const_config constants tool_autosplit tool_xsubpp
276 tools_other dist macro depend cflags const_loadlibs const_cccmd
281 c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs
282 dynamic_lib static static_lib htmlifypods manifypods processPL
284 clean realclean dist_basics dist_core dist_dir dist_test dist_ci
285 install force perldepend makefile staticmake test ppd
287 ); # loses section ordering
289 @Overridable = @MM_Sections;
290 push @Overridable, qw[
292 dir_target libscan makeaperl needs_linking perm_rw perm_rwx
293 subdir_x test_via_harness test_via_script
297 push @MM_Sections, qw[
299 pm_to_blib selfdocument
303 # Postamble needs to be the last that was always the case
304 push @MM_Sections, "postamble";
305 push @Overridable, "postamble";
307 # All sections are valid keys.
308 @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
310 # we will use all these variables in the Makefile
313 ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc
314 lib_ext obj_ext osname osvers ranlib sitelibexp sitearchexp so exe_ext
318 foreach $item (@Attrib_help){
319 $Recognized_Att_Keys{$item} = 1;
321 foreach $item (@Get_from_Config) {
322 $Recognized_Att_Keys{uc $item} = $Config{$item};
323 print "Attribute '\U$item\E' => '$Config{$item}'\n"
328 # When we eval a Makefile.PL in a subdirectory, that one will ask
329 # us (the parent) for the values and will prepend "..", so that
330 # all files to be installed end up below OUR ./blib
335 INST_BIN 1 INST_EXE 1 INST_LIB 1 INST_ARCHLIB 1 INST_SCRIPT 1
336 MAP_TARGET 1 INST_HTMLLIBDIR 1 INST_HTMLSCRIPTDIR 1
337 INST_MAN1DIR 1 INST_MAN3DIR 1 PERL_SRC 1 PERL 1 FULLPERL 1
342 NEEDS_LINKING HAS_LINK_CODE
344 @Keep_after_flush{@keep} = (1) x @keep;
350 The extension you are trying to build apparently is rather old and
351 most probably outdated. We detect that from the fact, that a
352 subroutine "writeMakefile" is called, and this subroutine is not
353 supported anymore since about October 1994.
355 Please contact the author or look into CPAN (details about CPAN can be
356 found in the FAQ and at http:/www.perl.com) for a more recent version
357 of the extension. If you're really desperate, you can try to change
358 the subroutine name from writeMakefile to WriteMakefile and rerun
359 'perl Makefile.PL', but you're most probably left alone, when you do
367 sub ExtUtils::MakeMaker::new {
368 my($class,$self) = @_;
371 print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
372 if (-f "MANIFEST" && ! -f "Makefile"){
376 $self = {} unless (defined $self);
380 my(%initial_att) = %$self; # record initial attributes
383 foreach $prereq (sort keys %{$self->{PREREQ_PM}}) {
384 my $eval = "use $prereq $self->{PREREQ_PM}->{$prereq}";
387 warn "Warning: prerequisite $prereq $self->{PREREQ_PM}->{$prereq} not found";
388 # Why is/was this 'delete' here? We need PREREQ_PM later to make PPDs.
390 # delete $self->{PREREQ_PM}{$prereq};
394 # unless (defined $ExtUtils::MakeMaker::useCPAN) {
395 # print qq{MakeMaker WARNING: prerequisites not found (@unsatisfied)
396 # Please install these modules first and rerun 'perl Makefile.PL'.\n};
397 # if ($ExtUtils::MakeMaker::hasCPAN) {
398 # $ExtUtils::MakeMaker::useCPAN = prompt(qq{Should I try to use the CPAN module to fetch them for you?},"yes");
400 # print qq{Hint: You may want to install the CPAN module to autofetch the needed modules\n};
401 # $ExtUtils::MakeMaker::useCPAN=0;
404 # if ($ExtUtils::MakeMaker::useCPAN) {
406 # CPAN->import(@unsatisfied);
408 # die qq{prerequisites not found (@unsatisfied)};
410 # warn qq{WARNING: prerequisites not found (@unsatisfied)};
413 if (defined $self->{CONFIGURE}) {
414 if (ref $self->{CONFIGURE} eq 'CODE') {
415 $self = { %$self, %{&{$self->{CONFIGURE}}}};
417 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
421 # This is for old Makefiles written pre 5.00, will go away
422 if ( Carp::longmess("") =~ /runsubdirpl/s ){
423 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
426 my $newclass = ++$PACKNAME;
427 local @Parent = @Parent; # Protect against non-local exits
430 print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
431 mv_all_methods("MY",$newclass);
432 bless $self, $newclass;
434 @{"$newclass\:\:ISA"} = 'MM';
437 if (defined $Parent[-2]){
438 $self->{PARENT} = $Parent[-2];
440 for $key (keys %Prepend_dot_dot) {
441 next unless defined $self->{PARENT}{$key};
442 $self->{$key} = $self->{PARENT}{$key};
443 # PERL and FULLPERL may be command verbs instead of full
444 # file specifications under VMS. If so, don't turn them
446 $self->{$key} = $self->catdir("..",$self->{$key})
447 unless $self->file_name_is_absolute($self->{$key})
448 || ($^O eq 'VMS' and ($key =~ /PERL$/ && $self->{$key} =~ /^[\w\-\$]+$/));
450 if ($self->{PARENT}) {
451 $self->{PARENT}->{CHILDREN}->{$newclass} = $self;
452 foreach my $opt (qw(CAPI POLLUTE)) {
453 if (exists $self->{PARENT}->{$opt}
454 and not exists $self->{$opt})
456 # inherit, but only if already unspecified
457 $self->{$opt} = $self->{PARENT}->{$opt};
462 parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV);
465 $self->{NAME} ||= $self->guess_name;
467 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
471 if (! $self->{PERL_SRC} ) {
472 my($pthinks) = $self->canonpath($INC{'Config.pm'});
473 my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
474 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
475 if ($pthinks ne $cthinks &&
476 !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
477 print "Have $pthinks expected $cthinks\n";
479 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
482 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
485 Your perl and your Config.pm seem to have different ideas about the architecture
487 Perl thinks: [$pthinks]
488 Config says: [$Config{archname}]
489 This may or may not cause problems. Please check your installation of perl if you
490 have problems building this extension.
495 $self->init_dirscan();
496 $self->init_others();
497 my($argv) = neatvalue(\@ARGV);
501 push @{$self->{RESULT}}, <<END;
502 # This Makefile is for the $self->{NAME} extension to perl.
504 # It was generated automatically by MakeMaker version
505 # $VERSION (Revision: $Revision) from the contents of
506 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
508 # ANY CHANGES MADE HERE WILL BE LOST!
510 # MakeMaker ARGV: $argv
512 # MakeMaker Parameters:
515 foreach $key (sort keys %initial_att){
516 my($v) = neatvalue($initial_att{$key});
517 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
519 push @{$self->{RESULT}}, "# $key => $v";
522 # turn the SKIP array into a SKIPHASH hash
524 for $skip (@{$self->{SKIP} || []}) {
525 $self->{SKIPHASH}{$skip} = 1;
527 delete $self->{SKIP}; # free memory
529 if ($self->{PARENT}) {
530 for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
531 $self->{SKIPHASH}{$_} = 1;
535 # We run all the subdirectories now. They don't have much to query
536 # from the parent, but the parent has to query them: if they need linking!
537 unless ($self->{NORECURS}) {
538 $self->eval_in_subdirs if @{$self->{DIR}};
542 foreach $section ( @MM_Sections ){
543 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
544 my($skipit) = $self->skipcheck($section);
546 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
548 my(%a) = %{$self->{$section} || {}};
549 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
550 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
551 push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
555 push @{$self->{RESULT}}, "\n# End.";
560 sub WriteEmptyMakefile {
561 if (-f 'Makefile.old') {
562 chmod 0666, 'Makefile.old';
563 unlink 'Makefile.old' or warn "unlink Makefile.old: $!";
565 rename 'Makefile', 'Makefile.old' or warn "rename Makefile Makefile.old: $!"
567 open MF, '> Makefile' or die "open Makefile for write: $!";
580 close MF or die "close Makefile for write: $!";
584 print STDOUT "Checking if your kit is complete...\n";
585 require ExtUtils::Manifest;
586 $ExtUtils::Manifest::Quiet=$ExtUtils::Manifest::Quiet=1; #avoid warning
587 my(@missed)=ExtUtils::Manifest::manicheck();
589 print STDOUT "Warning: the following files are missing in your kit:\n";
590 print "\t", join "\n\t", @missed;
592 print STDOUT "Please inform the author.\n";
594 print STDOUT "Looks good\n";
599 my($self, @args) = @_;
601 unless (m/(.*?)=(.*)/){
602 help(),exit 1 if m/^help$/;
603 ++$Verbose if m/^verb/;
606 my($name, $value) = ($1, $2);
607 if ($value =~ m/^~(\w+)?/){ # tilde with optional username
608 $value =~ s [^~(\w*)]
610 ((getpwnam($1))[7] || "~$1") :
614 $self->{uc($name)} = $value;
617 # catch old-style 'potential_libs' and inform user how to 'upgrade'
618 if (defined $self->{potential_libs}){
619 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
620 if ($self->{potential_libs}){
621 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
623 print STDOUT "$msg deleted.\n";
625 $self->{LIBS} = [$self->{potential_libs}];
626 delete $self->{potential_libs};
628 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
629 if (defined $self->{ARMAYBE}){
630 my($armaybe) = $self->{ARMAYBE};
631 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
632 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
633 my(%dl) = %{$self->{dynamic_lib} || {}};
634 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
635 delete $self->{ARMAYBE};
637 if (defined $self->{LDTARGET}){
638 print STDOUT "LDTARGET should be changed to LDFROM\n";
639 $self->{LDFROM} = $self->{LDTARGET};
640 delete $self->{LDTARGET};
642 # Turn a DIR argument on the command line into an array
643 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
644 # So they can choose from the command line, which extensions they want
645 # the grep enables them to have some colons too much in case they
646 # have to build a list with the shell
647 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
649 # Turn a INCLUDE_EXT argument on the command line into an array
650 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
651 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
653 # Turn a EXCLUDE_EXT argument on the command line into an array
654 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
655 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
658 foreach $mmkey (sort keys %$self){
659 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
660 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
661 unless exists $Recognized_Att_Keys{$mmkey};
668 # We allow extension-specific hints files.
670 return unless -d "hints";
672 # First we look for the best hintsfile we have
674 my($hint)="${^O}_$Config{osvers}";
679 # Also try without trailing minor version numbers.
681 last if -f "hints/$hint.pl"; # found
683 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
685 return unless -f "hints/$hint.pl"; # really there
687 # execute the hintsfile:
689 # my $fh = new FileHandle;
690 # $fh->open("hints/$hint.pl");
692 open(FH,"hints/$hint.pl");
693 # @goodhints = <$fh>;
697 print STDOUT "Processing hints file hints/$hint.pl\n";
698 eval join('',@goodhints);
699 print STDOUT $@ if $@;
705 my($symtab) = \%{"${from}::"};
708 # Here you see the *current* list of methods that are overridable
709 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
710 # still trying to reduce the list to some reasonable minimum --
711 # because I want to make it easier for the user. A.K.
713 foreach $method (@Overridable) {
715 # We cannot say "next" here. Nick might call MY->makeaperl
716 # which isn't defined right now
718 # Above statement was written at 4.23 time when Tk-b8 was
719 # around. As Tk-b9 only builds with 5.002something and MM 5 is
720 # standard, we try to enable the next line again. It was
721 # commented out until MM 5.23
723 next unless defined &{"${from}::$method"};
725 *{"${to}::$method"} = \&{"${from}::$method"};
727 # delete would do, if we were sure, nobody ever called
728 # MY->makeaperl directly
730 # delete $symtab->{$method};
732 # If we delete a method, then it will be undefined and cannot
733 # be called. But as long as we have Makefile.PLs that rely on
734 # %MY:: being intact, we have to fill the hole with an
737 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
740 # We have to clean out %INC also, because the current directory is
741 # changed frequently and Graham Barr prefers to get his version
742 # out of a History.pl file which is "required" so woudn't get
743 # loaded again in another extension requiring a History.pl
745 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
746 # to core dump in the middle of a require statement. The required
747 # file was Tk/MMutil.pm. The consequence is, we have to be
748 # extremely careful when we try to give perl a reason to reload a
749 # library with same name. The workaround prefers to drop nothing
750 # from %INC and teach the writers not to use such libraries.
753 # foreach $inc (keys %INC) {
754 # #warn "***$inc*** deleted";
762 if ($section eq 'dynamic') {
763 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
764 "in skipped section 'dynamic_bs'\n"
765 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
766 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
767 "in skipped section 'dynamic_lib'\n"
768 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
770 if ($section eq 'dynamic_lib') {
771 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
772 "targets in skipped section 'dynamic_bs'\n"
773 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
775 if ($section eq 'static') {
776 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
777 "in skipped section 'static_lib'\n"
778 if $self->{SKIPHASH}{static_lib} && $Verbose;
780 return 'skipped' if $self->{SKIPHASH}{$section};
788 # my $fh = new FileHandle;
790 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
792 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
793 # $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
794 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
796 for $chunk (@{$self->{RESULT}}) {
797 # print $fh "$chunk\n";
803 my($finalname) = $self->{MAKEFILE};
804 rename("MakeMaker.tmp", $finalname);
805 chmod 0644, $finalname unless $Is_VMS;
807 if ($self->{PARENT}) {
808 foreach (keys %$self) { # safe memory
809 delete $self->{$_} unless $Keep_after_flush{$_};
813 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
816 # The following mkbootstrap() is only for installations that are calling
817 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
818 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
821 !!! Your Makefile has been built such a long time ago, !!!
822 !!! that is unlikely to work with current MakeMaker. !!!
823 !!! Please rebuild your Makefile !!!
827 # Ditto for mksymlists() as of MakeMaker 5.17
830 !!! Your Makefile has been built such a long time ago, !!!
831 !!! that is unlikely to work with current MakeMaker. !!!
832 !!! Please rebuild your Makefile !!!
838 return "undef" unless defined $v;
840 return "q[$v]" unless $t;
842 my(@m, $elem, @neat);
844 foreach $elem (@$v) {
845 push @neat, "q[$elem]";
847 push @m, join ", ", @neat;
851 return "$v" unless $t eq 'HASH';
853 while (($key,$val) = each %$v){
854 last unless defined $key; # cautious programming in case (undef,undef) is true
855 push(@m,"$key=>".neatvalue($val)) ;
857 return "{ ".join(', ',@m)." }";
864 push @m, "\n# Full list of MakeMaker attribute values:";
865 foreach $key (sort keys %$self){
866 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
867 my($v) = neatvalue($self->{$key});
868 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
870 push @m, "# $key => $v";
876 package ExtUtils::MakeMaker;
883 ExtUtils::MakeMaker - create an extension Makefile
887 C<use ExtUtils::MakeMaker;>
889 C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
893 C<MM-E<gt>new(\%att)-E<gt>flush;>
897 This utility is designed to write a Makefile for an extension module
898 from a Makefile.PL. It is based on the Makefile.SH model provided by
899 Andy Dougherty and the perl5-porters.
901 It splits the task of generating the Makefile into several subroutines
902 that can be individually overridden. Each subroutine returns the text
903 it wishes to have written to the Makefile.
905 MakeMaker is object oriented. Each directory below the current
906 directory that contains a Makefile.PL. Is treated as a separate
907 object. This makes it possible to write an unlimited number of
908 Makefiles with a single invocation of WriteMakefile().
910 =head2 How To Write A Makefile.PL
912 The short answer is: Don't.
914 Always begin with h2xs.
915 Always begin with h2xs!
916 ALWAYS BEGIN WITH H2XS!
918 even if you're not building around a header file, and even if you
919 don't have an XS component.
921 Run h2xs(1) before you start thinking about writing a module. For so
922 called pm-only modules that consist of C<*.pm> files only, h2xs has
923 the C<-X> switch. This will generate dummy files of all kinds that are
924 useful for the module developer.
926 The medium answer is:
928 use ExtUtils::MakeMaker;
929 WriteMakefile( NAME => "Foo::Bar" );
931 The long answer is the rest of the manpage :-)
933 =head2 Default Makefile Behaviour
935 The generated Makefile enables the user of the extension to invoke
937 perl Makefile.PL # optionally "perl Makefile.PL verbose"
939 make test # optionally set TEST_VERBOSE=1
940 make install # See below
942 The Makefile to be produced may be altered by adding arguments of the
943 form C<KEY=VALUE>. E.g.
945 perl Makefile.PL PREFIX=/tmp/myperl5
947 Other interesting targets in the generated Makefile are
949 make config # to check if the Makefile is up-to-date
950 make clean # delete local temp files (Makefile gets renamed)
951 make realclean # delete derived files (including ./blib)
952 make ci # check in all the files in the MANIFEST file
953 make dist # see below the Distribution Support section
957 MakeMaker checks for the existence of a file named F<test.pl> in the
958 current directory and if it exists it adds commands to the test target
959 of the generated Makefile that will execute the script with the proper
960 set of perl C<-I> options.
962 MakeMaker also checks for any files matching glob("t/*.t"). It will
963 add commands to the test target of the generated Makefile that execute
964 all matching files via the L<Test::Harness> module with the C<-I>
965 switches set correctly.
969 A useful variation of the above is the target C<testdb>. It runs the
970 test under the Perl debugger (see L<perldebug>). If the file
971 F<test.pl> exists in the current directory, it is used for the test.
973 If you want to debug some other testfile, set C<TEST_FILE> variable
976 make testdb TEST_FILE=t/mytest.t
978 By default the debugger is called using C<-d> option to perl. If you
979 want to specify some other option, set C<TESTDB_SW> variable:
981 make testdb TESTDB_SW=-Dx
985 make alone puts all relevant files into directories that are named by
986 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_HTMLLIBDIR,
987 INST_HTMLSCRIPTDIR, INST_MAN1DIR, and INST_MAN3DIR. All these default
988 to something below ./blib if you are I<not> building below the perl
989 source directory. If you I<are> building below the perl source,
990 INST_LIB and INST_ARCHLIB default to ../../lib, and INST_SCRIPT is not
993 The I<install> target of the generated Makefile copies the files found
994 below each of the INST_* directories to their INSTALL*
995 counterparts. Which counterparts are chosen depends on the setting of
996 INSTALLDIRS according to the following table:
1001 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH
1002 INST_LIB INSTALLPRIVLIB INSTALLSITELIB
1003 INST_HTMLLIBDIR INSTALLHTMLPRIVLIBDIR INSTALLHTMLSITELIBDIR
1004 INST_HTMLSCRIPTDIR INSTALLHTMLSCRIPTDIR
1006 INST_SCRIPT INSTALLSCRIPT
1007 INST_MAN1DIR INSTALLMAN1DIR
1008 INST_MAN3DIR INSTALLMAN3DIR
1010 The INSTALL... macros in turn default to their %Config
1011 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
1013 You can check the values of these variables on your system with
1017 And to check the sequence in which the library directories are
1018 searched by perl, run
1020 perl -le 'print join $/, @INC'
1023 =head2 PREFIX and LIB attribute
1025 PREFIX and LIB can be used to set several INSTALL* attributes in one
1026 go. The quickest way to install a module in a non-standard place might
1029 perl Makefile.PL LIB=~/lib
1031 This will install the module's architecture-independent files into
1032 ~/lib, the architecture-dependent files into ~/lib/$archname/auto.
1034 Another way to specify many INSTALL directories with a single
1035 parameter is PREFIX.
1037 perl Makefile.PL PREFIX=~
1039 This will replace the string specified by $Config{prefix} in all
1040 $Config{install*} values.
1042 Note, that in both cases the tilde expansion is done by MakeMaker, not
1043 by perl by default, nor by make. Conflicts between parameters LIB,
1044 PREFIX and the various INSTALL* arguments are resolved so that
1047 If the user has superuser privileges, and is not working on AFS
1048 (Andrew File System) or relatives, then the defaults for
1049 INSTALLPRIVLIB, INSTALLARCHLIB, INSTALLSCRIPT, etc. will be appropriate,
1050 and this incantation will be the best:
1052 perl Makefile.PL; make; make test
1055 make install per default writes some documentation of what has been
1056 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1057 can be bypassed by calling make pure_install.
1061 will have to specify the installation directories as these most
1062 probably have changed since perl itself has been installed. They will
1063 have to do this by calling
1065 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1066 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1069 Be careful to repeat this procedure every time you recompile an
1070 extension, unless you are sure the AFS installation directories are
1073 =head2 Static Linking of a new Perl Binary
1075 An extension that is built with the above steps is ready to use on
1076 systems supporting dynamic loading. On systems that do not support
1077 dynamic loading, any newly created extension has to be linked together
1078 with the available resources. MakeMaker supports the linking process
1079 by creating appropriate targets in the Makefile whenever an extension
1080 is built. You can invoke the corresponding section of the makefile with
1084 That produces a new perl binary in the current directory with all
1085 extensions linked in that can be found in INST_ARCHLIB , SITELIBEXP,
1086 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1087 UNIX, this is called Makefile.aperl (may be system dependent). If you
1088 want to force the creation of a new perl, it is recommended, that you
1089 delete this Makefile.aperl, so the directories are searched-through
1090 for linkable libraries again.
1092 The binary can be installed into the directory where perl normally
1093 resides on your machine with
1097 To produce a perl binary with a different name than C<perl>, either say
1099 perl Makefile.PL MAP_TARGET=myperl
1106 make myperl MAP_TARGET=myperl
1107 make inst_perl MAP_TARGET=myperl
1109 In any case you will be prompted with the correct invocation of the
1110 C<inst_perl> target that installs the new binary into INSTALLBIN.
1112 make inst_perl per default writes some documentation of what has been
1113 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1114 can be bypassed by calling make pure_inst_perl.
1116 Warning: the inst_perl: target will most probably overwrite your
1117 existing perl binary. Use with care!
1119 Sometimes you might want to build a statically linked perl although
1120 your system supports dynamic loading. In this case you may explicitly
1121 set the linktype with the invocation of the Makefile.PL or make:
1123 perl Makefile.PL LINKTYPE=static # recommended
1127 make LINKTYPE=static # works on most systems
1129 =head2 Determination of Perl Library and Installation Locations
1131 MakeMaker needs to know, or to guess, where certain things are
1132 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1133 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1134 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1136 Extensions may be built either using the contents of the perl source
1137 directory tree or from the installed perl library. The recommended way
1138 is to build extensions after you have run 'make install' on perl
1139 itself. You can do that in any directory on your hard disk that is not
1140 below the perl source tree. The support for extensions below the ext
1141 directory of the perl distribution is only good for the standard
1142 extensions that come with perl.
1144 If an extension is being built below the C<ext/> directory of the perl
1145 source then MakeMaker will set PERL_SRC automatically (e.g.,
1146 C<../..>). If PERL_SRC is defined and the extension is recognized as
1147 a standard extension, then other variables default to the following:
1150 PERL_LIB = PERL_SRC/lib
1151 PERL_ARCHLIB = PERL_SRC/lib
1153 INST_ARCHLIB = PERL_ARCHLIB
1155 If an extension is being built away from the perl source then MakeMaker
1156 will leave PERL_SRC undefined and default to using the installed copy
1157 of the perl library. The other variables default to the following:
1159 PERL_INC = $archlibexp/CORE
1160 PERL_LIB = $privlibexp
1161 PERL_ARCHLIB = $archlibexp
1162 INST_LIB = ./blib/lib
1163 INST_ARCHLIB = ./blib/arch
1165 If perl has not yet been installed then PERL_SRC can be defined on the
1166 command line as shown in the previous section.
1169 =head2 Which architecture dependent directory?
1171 If you don't want to keep the defaults for the INSTALL* macros,
1172 MakeMaker helps you to minimize the typing needed: the usual
1173 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1174 by Configure at perl compilation time. MakeMaker supports the user who
1175 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1176 then MakeMaker defaults the latter to be the same subdirectory of
1177 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1178 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1179 for INSTALLSITELIB and INSTALLSITEARCH.
1181 MakeMaker gives you much more freedom than needed to configure
1182 internal variables and get different results. It is worth to mention,
1183 that make(1) also lets you configure most of the variables that are
1184 used in the Makefile. But in the majority of situations this will not
1185 be necessary, and should only be done, if the author of a package
1186 recommends it (or you know what you're doing).
1188 =head2 Using Attributes and Parameters
1190 The following attributes can be specified as arguments to WriteMakefile()
1191 or as NAME=VALUE pairs on the command line:
1197 String containing name (and email address) of package author(s). Is used
1198 in PPD (Perl Package Description) files for PPM (Perl Package Manager).
1202 One line description of the module. Will be included in PPD file.
1206 Name of the file that contains the package description. MakeMaker looks
1207 for a line in the POD matching /^($package\s-\s)(.*)/. This is typically
1208 the first line in the "=head1 NAME" section. $2 becomes the abstract.
1210 =item BINARY_LOCATION
1212 Used when creating PPD files for binary packages. It can be set to a
1213 full or relative path or URL to the binary archive for a particular
1214 architecture. For example:
1216 perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
1218 builds a PPD package that references a binary of the C<Agent> package,
1219 located in the C<x86> directory relative to the PPD itself.
1223 Ref to array of *.c file names. Initialised from a directory scan
1224 and the values portion of the XS attribute hash. This is not
1225 currently used by MakeMaker but may be handy in Makefile.PLs.
1229 [This attribute is obsolete in Perl 5.6. PERL_OBJECT builds are C-compatible
1232 Switch to force usage of the Perl C API even when compiling for PERL_OBJECT.
1234 Note that this attribute is passed through to any recursive build,
1235 but if and only if the submodule's Makefile.PL itself makes no mention
1236 of the 'CAPI' attribute.
1240 String that will be included in the compiler call command line between
1241 the arguments INC and OPTIMIZE.
1245 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1246 config.sh. MakeMaker will add to CONFIG the following values anyway:
1266 CODE reference. The subroutine should return a hash reference. The
1267 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1268 be determined by some evaluation method.
1272 Something like C<"-DHAVE_UNISTD_H">
1276 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1281 Your name for distributing the package (by tar file). This defaults to
1286 Hashref of symbol names for routines to be made available as universal
1287 symbols. Each key/value pair consists of the package name and an
1288 array of routine names in that package. Used only under AIX, OS/2,
1289 VMS and Win32 at present. The routine names supplied will be expanded
1290 in the same way as XSUB names are expanded by the XS() macro.
1293 {"$(NAME)" => ["boot_$(NAME)" ] }
1297 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1298 "NetconfigPtr" => [ 'DESTROY'] }
1300 Please see the L<ExtUtils::Mksymlists> documentation for more information
1301 about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
1305 Array of symbol names for variables to be made available as universal symbols.
1306 Used only under AIX, OS/2, VMS and Win32 at present. Defaults to [].
1307 (e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
1311 Array of extension names to exclude when doing a static build. This
1312 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1313 details. (e.g. [ qw( Socket POSIX ) ] )
1315 This attribute may be most useful when specified as a string on the
1316 command line: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1320 Ref to array of executable files. The files will be copied to the
1321 INST_SCRIPT directory. Make realclean will delete them from there
1324 =item FIRST_MAKEFILE
1326 The name of the Makefile to be produced. Defaults to the contents of
1327 MAKEFILE, but can be overridden. This is used for the second Makefile
1328 that will be produced for the MAP_TARGET.
1332 Perl binary able to run this extension.
1336 This provides an alternate means to specify function names to be
1337 exported from the extension. Its value is a reference to an
1338 array of function names to be exported by the extension. These
1339 names are passed through unaltered to the linker options file.
1343 Ref to array of *.h file names. Similar to C.
1347 Hashref of .pm and .pod files. MakeMaker will default this to all
1348 .pod and any .pm files that include POD directives. The files listed
1349 here will be converted to HTML format and installed as was requested
1352 =item HTMLSCRIPTPODS
1354 Hashref of pod-containing files. MakeMaker will default this to all
1355 EXE_FILES files that include POD directives. The files listed
1356 here will be converted to HTML format and installed as was requested
1361 This attribute is used to specify names to be imported into the
1362 extension. It is only used on OS/2 and Win32.
1366 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1370 Array of extension names to be included when doing a static build.
1371 MakeMaker will normally build with all of the installed extensions when
1372 doing a static build, and that is usually the desired behavior. If
1373 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1374 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1376 It is not necessary to mention DynaLoader or the current extension when
1377 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1378 only DynaLoader and the current extension will be included in the build.
1380 This attribute may be most useful when specified as a string on the
1381 command line: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1383 =item INSTALLARCHLIB
1385 Used by 'make install', which copies files from INST_ARCHLIB to this
1386 directory if INSTALLDIRS is set to perl.
1390 Directory to install binary files (e.g. tkperl) into.
1394 Determines which of the two sets of installation directories to
1395 choose: installprivlib and installarchlib versus installsitelib and
1396 installsitearch. The first pair is chosen with INSTALLDIRS=perl, the
1397 second with INSTALLDIRS=site. Default is site.
1399 =item INSTALLHTMLPRIVLIBDIR
1401 This directory gets the HTML pages at 'make install' time. Defaults to
1402 $Config{installhtmlprivlibdir}.
1404 =item INSTALLHTMLSCRIPTDIR
1406 This directory gets the HTML pages at 'make install' time. Defaults to
1407 $Config{installhtmlscriptdir}.
1409 =item INSTALLHTMLSITELIBDIR
1411 This directory gets the HTML pages at 'make install' time. Defaults to
1412 $Config{installhtmlsitelibdir}.
1415 =item INSTALLMAN1DIR
1417 This directory gets the man pages at 'make install' time. Defaults to
1418 $Config{installman1dir}.
1420 =item INSTALLMAN3DIR
1422 This directory gets the man pages at 'make install' time. Defaults to
1423 $Config{installman3dir}.
1425 =item INSTALLPRIVLIB
1427 Used by 'make install', which copies files from INST_LIB to this
1428 directory if INSTALLDIRS is set to perl.
1432 Used by 'make install' which copies files from INST_SCRIPT to this
1435 =item INSTALLSITEARCH
1437 Used by 'make install', which copies files from INST_ARCHLIB to this
1438 directory if INSTALLDIRS is set to site (default).
1440 =item INSTALLSITELIB
1442 Used by 'make install', which copies files from INST_LIB to this
1443 directory if INSTALLDIRS is set to site (default).
1447 Same as INST_LIB for architecture dependent files.
1451 Directory to put real binary files during 'make'. These will be copied
1452 to INSTALLBIN during 'make install'
1456 Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you
1461 Directory where we put library files of this extension while building
1464 =item INST_HTMLLIBDIR
1466 Directory to hold the man pages in HTML format at 'make' time
1468 =item INST_HTMLSCRIPTDIR
1470 Directory to hold the man pages in HTML format at 'make' time
1474 Directory to hold the man pages at 'make' time
1478 Directory to hold the man pages at 'make' time
1482 Directory, where executable files should be installed during
1483 'make'. Defaults to "./blib/bin", just to have a dummy location during
1484 testing. make install will copy the files in INST_SCRIPT to
1489 defaults to "$(OBJECT)" and is used in the ld command to specify
1490 what files to link/load from (also see dynamic_lib below for how to
1495 LIB can only be set at C<perl Makefile.PL> time. It has the effect of
1496 setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any
1500 The filename of the perllibrary that will be used together with this
1501 extension. Defaults to libperl.a.
1505 An anonymous array of alternative library
1506 specifications to be searched for (in order) until
1507 at least one library is found. E.g.
1509 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1511 Mind, that any element of the array
1512 contains a complete set of arguments for the ld
1513 command. So do not specify
1515 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1517 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1518 you specify a scalar as in
1520 'LIBS' => "-ltcl -ltk -lX11"
1522 MakeMaker will turn it into an array with one element.
1526 'static' or 'dynamic' (default unless usedl=undef in
1527 config.sh). Should only be used to force static linking (also see
1532 Boolean which tells MakeMaker, that it should include the rules to
1533 make a perl. This is handled automatically as a switch by
1534 MakeMaker. The user normally does not need it.
1538 The name of the Makefile to be produced.
1542 Hashref of pod-containing files. MakeMaker will default this to all
1543 EXE_FILES files that include POD directives. The files listed
1544 here will be converted to man pages and installed as was requested
1549 Hashref of .pm and .pod files. MakeMaker will default this to all
1550 .pod and any .pm files that include POD directives. The files listed
1551 here will be converted to man pages and installed as was requested
1556 If it is intended, that a new perl binary be produced, this variable
1557 may hold a name for that binary. Defaults to perl
1561 If the extension links to a library that it builds set this to the
1562 name of the library (see SDBM_File)
1566 Perl module name for this extension (DBD::Oracle). This will default
1567 to the directory name but should be explicitly defined in the
1572 MakeMaker will figure out, if an extension contains linkable code
1573 anywhere down the directory tree, and will set this variable
1574 accordingly, but you can speed it up a very little bit, if you define
1575 this boolean variable yourself.
1579 Defaults to C<@>. By setting it to an empty string you can generate a
1580 Makefile that echos all commands. Mainly used in debugging MakeMaker
1585 Boolean. Attribute to inhibit descending into subdirectories.
1589 In general any generated Makefile checks for the current version of
1590 MakeMaker and the version the Makefile was built under. If NO_VC is
1591 set, the version check is neglected. Do not write this into your
1592 Makefile.PL, use it interactively instead.
1596 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1597 string containing all object files, e.g. "tkpBind.o
1598 tkpButton.o tkpCanvas.o"
1602 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1603 passed to subdirectory makes.
1607 Perl binary for tasks that can be done by miniperl
1611 The call to the program that is able to compile perlmain.c. Defaults
1616 Same as above for architecture dependent files
1620 Directory containing the Perl library to use.
1624 Directory containing the Perl source code (use of this should be
1625 avoided, it may be undefined)
1629 Desired permission for read/writable files. Defaults to C<644>.
1630 See also L<MM_Unix/perm_rw>.
1634 Desired permission for executable files. Defaults to C<755>.
1635 See also L<MM_Unix/perm_rwx>.
1639 Ref to hash of files to be processed as perl programs. MakeMaker
1640 will default to any found *.PL file (except Makefile.PL) being keys
1641 and the basename of the file being the value. E.g.
1643 {'foobar.PL' => 'foobar'}
1645 The *.PL files are expected to produce output to the target files
1646 themselves. If multiple files can be generated from the same *.PL
1647 file then the value in the hash can be a reference to an array of
1648 target file names. E.g.
1650 {'foobar.PL' => ['foobar1','foobar2']}
1654 Hashref of .pm files and *.pl files to be installed. e.g.
1656 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1658 By default this will include *.pm and *.pl and the files found in
1659 the PMLIBDIRS directories. Defining PM in the
1660 Makefile.PL will override PMLIBDIRS.
1664 Ref to array of subdirectories containing library files. Defaults to
1665 [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
1666 they contain will be installed in the corresponding location in the
1667 library. A libscan() method can be used to alter the behaviour.
1668 Defining PM in the Makefile.PL will override PMLIBDIRS.
1672 Release 5.005 grandfathered old global symbol names by providing preprocessor
1673 macros for extension source compatibility. As of release 5.006, these
1674 preprocessor definitions are not available by default. The POLLUTE flag
1675 specifies that the old names should still be defined:
1677 perl Makefile.PL POLLUTE=1
1679 Please inform the module author if this is necessary to successfully install
1680 a module under 5.006 or later.
1682 =item PPM_INSTALL_EXEC
1684 Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl)
1686 =item PPM_INSTALL_SCRIPT
1688 Name of the script that gets executed by the Perl Package Manager after
1689 the installation of a package.
1693 Can be used to set the three INSTALL* attributes in one go (except for
1694 probably INSTALLMAN1DIR, if it is not below PREFIX according to
1695 %Config). They will have PREFIX as a common directory node and will
1696 branch from that node into lib/, lib/ARCHNAME or whatever Configure
1697 decided at the build time of your perl (unless you override one of
1702 Hashref: Names of modules that need to be available to run this
1703 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1704 desired version is the value. If the required version number is 0, we
1705 only check if any version is installed already.
1709 Arryref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1710 Makefile. Caution! Do not use the SKIP attribute for the neglectible
1711 speedup. It may seriously damage the resulting Makefile. Only use it,
1712 if you really need it.
1716 Ref to array of typemap file names. Use this when the typemaps are
1717 in some directory other than the current directory or when they are
1718 not named B<typemap>. The last typemap in the list takes
1719 precedence. A typemap in the current directory has highest
1720 precedence, even if it isn't listed in TYPEMAPS. The default system
1721 typemap has lowest precedence.
1725 Your version number for distributing the package. This defaults to
1730 Instead of specifying the VERSION in the Makefile.PL you can let
1731 MakeMaker parse a file to determine the version number. The parsing
1732 routine requires that the file named by VERSION_FROM contains one
1733 single line to compute the version number. The first line in the file
1734 that contains the regular expression
1736 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
1738 will be evaluated with eval() and the value of the named variable
1739 B<after> the eval() will be assigned to the VERSION attribute of the
1740 MakeMaker object. The following lines will be parsed o.k.:
1744 ( $VERSION ) = '$Revision: 1.222 $ ' =~ /\$Revision:\s+([^\s]+)/;
1745 $FOO::VERSION = '1.10';
1746 *FOO::VERSION = \'1.11';
1748 but these will fail:
1750 my $VERSION = '1.01';
1751 local $VERSION = '1.02';
1752 local $FOO::VERSION = '1.30';
1754 The file named in VERSION_FROM is not added as a dependency to
1755 Makefile. This is not really correct, but it would be a major pain
1756 during development to have to rewrite the Makefile for any smallish
1757 change in that file. If you want to make sure that the Makefile
1758 contains the correct VERSION macro after any change of the file, you
1759 would have to do something like
1761 depend => { Makefile => '$(VERSION_FROM)' }
1763 See attribute C<depend> below.
1767 Hashref of .xs files. MakeMaker will default this. e.g.
1769 {'name_of_file.xs' => 'name_of_file.c'}
1771 The .c files will automatically be included in the list of files
1772 deleted by a make clean.
1776 String of options to pass to xsubpp. This might include C<-C++> or
1777 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
1782 May be set to an empty string, which is identical to C<-prototypes>, or
1783 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
1784 defaults to the empty string.
1788 Your version number for the .xs file of this package. This defaults
1789 to the value of the VERSION attribute.
1793 =head2 Additional lowercase attributes
1795 can be used to pass parameters to the methods which implement that
1796 part of the Makefile.
1802 {FILES => "*.xyz foo"}
1806 {ANY_TARGET => ANY_DEPENDECY, ...}
1810 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
1811 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
1812 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
1814 If you specify COMPRESS, then SUFFIX should also be altered, as it is
1815 needed to tell make the target file of the compression. Setting
1816 DIST_CP to ln can be useful, if you need to preserve the timestamps on
1817 your files. DIST_CP can take the values 'cp', which copies the file,
1818 'ln', which links the file, and 'best' which copies symbolic links and
1819 links the rest. Default is 'best'.
1823 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
1827 {LINKTYPE => 'static', 'dynamic' or ''}
1829 NB: Extensions that have nothing but *.pm files had to say
1833 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1834 can be deleted safely. MakeMaker recognizes, when there's nothing to
1839 {ANY_MACRO => ANY_VALUE, ...}
1843 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
1849 =item tool_autosplit
1855 =head2 Overriding MakeMaker Methods
1857 If you cannot achieve the desired Makefile behaviour by specifying
1858 attributes you may define private subroutines in the Makefile.PL.
1859 Each subroutines returns the text it wishes to have written to
1860 the Makefile. To override a section of the Makefile you can
1863 sub MY::c_o { "new literal text" }
1865 or you can edit the default by saying something like:
1868 package MY; # so that "SUPER" works right
1869 my $inherited = shift->SUPER::c_o(@_);
1870 $inherited =~ s/old text/new text/;
1874 If you are running experiments with embedding perl as a library into
1875 other applications, you might find MakeMaker is not sufficient. You'd
1876 better have a look at ExtUtils::Embed which is a collection of utilities
1879 If you still need a different solution, try to develop another
1880 subroutine that fits your needs and submit the diffs to
1881 F<perl5-porters@perl.org> or F<comp.lang.perl.moderated> as appropriate.
1883 For a complete description of all MakeMaker methods see L<ExtUtils::MM_Unix>.
1885 Here is a simple example of how to add a new target to the generated
1890 $(MYEXTLIB): sdbm/Makefile
1891 cd sdbm && $(MAKE) all
1896 =head2 Hintsfile support
1898 MakeMaker.pm uses the architecture specific information from
1899 Config.pm. In addition it evaluates architecture specific hints files
1900 in a C<hints/> directory. The hints files are expected to be named
1901 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
1902 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
1903 MakeMaker within the WriteMakefile() subroutine, and can be used to
1904 execute commands as well as to include special variables. The rules
1905 which hintsfile is chosen are the same as in Configure.
1907 The hintsfile is eval()ed immediately after the arguments given to
1908 WriteMakefile are stuffed into a hash reference $self but before this
1909 reference becomes blessed. So if you want to do the equivalent to
1910 override or create an attribute you would say something like
1912 $self->{LIBS} = ['-ldbm -lucb -lc'];
1914 =head2 Distribution Support
1916 For authors of extensions MakeMaker provides several Makefile
1917 targets. Most of the support comes from the ExtUtils::Manifest module,
1918 where additional documentation can be found.
1922 =item make distcheck
1924 reports which files are below the build directory but not in the
1925 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
1928 =item make skipcheck
1930 reports which files are skipped due to the entries in the
1931 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
1934 =item make distclean
1936 does a realclean first and then the distcheck. Note that this is not
1937 needed to build a new distribution as long as you are sure, that the
1938 MANIFEST file is ok.
1942 rewrites the MANIFEST file, adding all remaining files found (See
1943 ExtUtils::Manifest::mkmanifest() for details)
1947 Copies all the files that are in the MANIFEST file to a newly created
1948 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
1949 exists, it will be removed first.
1953 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
1954 a make test in that directory.
1958 First does a distdir. Then a command $(PREOP) which defaults to a null
1959 command, followed by $(TOUNIX), which defaults to a null command under
1960 UNIX, and will convert files in distribution directory to UNIX format
1961 otherwise. Next it runs C<tar> on that directory into a tarfile and
1962 deletes the directory. Finishes with a command $(POSTOP) which
1963 defaults to a null command.
1967 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
1969 =item make uutardist
1971 Runs a tardist first and uuencodes the tarfile.
1975 First does a distdir. Then a command $(PREOP) which defaults to a null
1976 command. Next it runs C<shar> on that directory into a sharfile and
1977 deletes the intermediate directory again. Finishes with a command
1978 $(POSTOP) which defaults to a null command. Note: For shdist to work
1979 properly a C<shar> program that can handle directories is mandatory.
1983 First does a distdir. Then a command $(PREOP) which defaults to a null
1984 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
1985 zipfile. Then deletes that directory. Finishes with a command
1986 $(POSTOP) which defaults to a null command.
1990 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
1994 Customization of the dist targets can be done by specifying a hash
1995 reference to the dist attribute of the WriteMakefile call. The
1996 following parameters are recognized:
1999 COMPRESS ('gzip --best')
2002 TO_UNIX (depends on the system)
2003 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
2013 WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" })
2015 =head2 Disabling an extension
2017 If some events detected in F<Makefile.PL> imply that there is no way
2018 to create the Module, but this is a normal state of things, then you
2019 can create a F<Makefile> which does nothing, but succeeds on all the
2020 "usual" build targets. To do so, use
2022 ExtUtils::MakeMaker::WriteEmptyMakefile();
2024 instead of WriteMakefile().
2026 This may be useful if other modules expect this module to be I<built>
2027 OK, as opposed to I<work> OK (say, this system-dependent module builds
2028 in a subdirectory of some other distribution, or is listed as a
2029 dependency in a CPAN::Bundle, but the functionality is supported by
2030 different means on the current architecture).
2038 Command line options used by C<MakeMaker-E<gt>new()>, and thus by
2039 C<WriteMakefile()>. The string is split on whitespace, and the result
2040 is processed before any actual command line arguments are processed.
2046 ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib,
2047 ExtUtils::Install, ExtUtils::Embed
2051 Andy Dougherty <F<doughera@lafcol.lafayette.edu>>, Andreas KE<ouml>nig
2052 <F<A.Koenig@franz.ww.TU-Berlin.DE>>, Tim Bunce <F<Tim.Bunce@ig.co.uk>>.
2053 VMS support by Charles Bailey <F<bailey@newman.upenn.edu>>. OS/2
2054 support by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>. Contact the
2055 makemaker mailing list C<mailto:makemaker@franz.ww.tu-berlin.de>, if
2056 you have any questions.