1 # $FreeBSD: src/contrib/perl5/lib/ExtUtils/MakeMaker.pm,v 1.2 1999/12/04 12:35:56 marcel Exp $
3 BEGIN {require 5.002;} # MakeMaker 5.17 was the last MakeMaker that was compatible with perl5.001m
5 package ExtUtils::MakeMaker;
8 $Version_OK = "5.17"; # Makefiles older than $Version_OK will die
9 # (Will be checked from MakeMaker version 4.13 onwards)
10 ($Revision = substr(q$Revision: 1.222 $, 10)) =~ s/\s+$//;
21 @ISA @EXPORT @EXPORT_OK $AUTOLOAD
22 $ISA_TTY $Is_Mac $Is_OS2 $Is_VMS $Revision $Setup_done
23 $VERSION $Verbose $Version_OK %Config %Keep_after_flush
24 %MM_Sections %Prepend_dot_dot %Recognized_Att_Keys
25 @Get_from_Config @MM_Sections @Overridable @Parent
30 # &DynaLoader::mod2fname should be available to miniperl, thus
31 # should be a pseudo-builtin (cmp. os2.c).
32 #eval {require DynaLoader;};
35 # Set up the inheritance before we pull in the MM_* packages, because they
36 # import variables and functions from here
39 @EXPORT = qw(&WriteMakefile &writeMakefile $Verbose &prompt);
40 @EXPORT_OK = qw($VERSION &Version_check &neatvalue &mkbootstrap &mksymlists);
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 pull in the friends
71 $Is_VMS = $^O eq 'VMS';
72 $Is_OS2 = $^O eq 'os2';
73 $Is_Mac = $^O eq 'MacOS';
74 $Is_Win32 = $^O eq 'MSWin32';
76 require ExtUtils::MM_Unix;
79 require ExtUtils::MM_VMS;
80 require VMS::Filespec; # is a noop as long as we require it within MM_VMS
83 require ExtUtils::MM_OS2;
86 require ExtUtils::MM_Mac;
89 require ExtUtils::MM_Win32;
92 # The SelfLoader would bring a lot of overhead for MakeMaker, because
93 # we know for sure we will use most of the autoloaded functions once
94 # we have to use one of them. So we write our own loader
98 if (defined fileno(DATA)) {
100 my $o = $/; # For future reads from the file.
112 warn "AUTOLOAD called unexpectedly for $AUTOLOAD";
114 defined(&$AUTOLOAD) or die "Myloader inconsistency error";
118 # The only subroutine we do not SelfLoad is Version_Check because it's
119 # called so often. Loading this minimum still requires 1.2 secs on my
123 my($checkversion) = @_;
124 die "Your Makefile was built with ExtUtils::MakeMaker v $checkversion.
125 Current Version is $ExtUtils::MakeMaker::VERSION. There have been considerable
126 changes in the meantime.
127 Please rerun 'perl Makefile.PL' to regenerate the Makefile.\n"
128 if $checkversion < $Version_OK;
129 printf STDOUT "%s %s %s %s.\n", "Makefile built with ExtUtils::MakeMaker v",
130 $checkversion, "Current Version is", $VERSION
131 unless $checkversion == $VERSION;
135 $_[0] =~ /^Use of uninitialized value/ && return;
136 $_[0] =~ /used only once/ && return;
137 $_[0] =~ /^Subroutine\s+[\w:]+\s+redefined/ && return;
141 sub ExtUtils::MakeMaker::eval_in_subdirs ;
142 sub ExtUtils::MakeMaker::eval_in_x ;
143 sub ExtUtils::MakeMaker::full_setup ;
144 sub ExtUtils::MakeMaker::writeMakefile ;
145 sub ExtUtils::MakeMaker::new ;
146 sub ExtUtils::MakeMaker::check_manifest ;
147 sub ExtUtils::MakeMaker::parse_args ;
148 sub ExtUtils::MakeMaker::check_hints ;
149 sub ExtUtils::MakeMaker::mv_all_methods ;
150 sub ExtUtils::MakeMaker::skipcheck ;
151 sub ExtUtils::MakeMaker::flush ;
152 sub ExtUtils::MakeMaker::mkbootstrap ;
153 sub ExtUtils::MakeMaker::mksymlists ;
154 sub ExtUtils::MakeMaker::neatvalue ;
155 sub ExtUtils::MakeMaker::selfdocument ;
156 sub ExtUtils::MakeMaker::WriteMakefile ;
157 sub ExtUtils::MakeMaker::prompt ($;$) ;
163 package ExtUtils::MakeMaker;
166 Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
167 local $SIG{__WARN__} = \&warnhandler;
169 unless ($Setup_done++){
171 undef &ExtUtils::MakeMaker::full_setup; #safe memory
174 MM->new(\%att)->flush;
179 $ISA_TTY = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ; # Pipe?
180 Carp::confess("prompt function called without an argument") unless defined $mess;
181 my $dispdef = defined $def ? "[$def] " : " ";
182 $def = defined $def ? $def : "";
185 print "$mess $dispdef";
187 chomp($ans = <STDIN>);
191 return ($ans ne '') ? $ans : $def;
194 sub eval_in_subdirs {
200 foreach $dir (@{$self->{DIR}}){
201 my($abs) = $self->catdir($pwd,$dir);
202 $self->eval_in_x($abs);
210 chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
212 # my $fh = new FileHandle;
213 # $fh->open("Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
215 open(FH,"Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
216 # my $eval = join "", <$fh>;
217 my $eval = join "", <FH>;
222 # if ($@ =~ /prerequisites/) {
223 # die "MakeMaker WARNING: $@";
225 # warn "WARNING from evaluation of $dir/Makefile.PL: $@";
227 warn "WARNING from evaluation of $dir/Makefile.PL: $@";
235 # package name for the classes into which the first object will be blessed
236 $PACKNAME = "PACK000";
240 AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION
241 C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
242 EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE FULLPERL FUNCLIST H IMPORTS
243 INC INCLUDE_EXT INSTALLARCHLIB INSTALLBIN INSTALLDIRS INSTALLMAN1DIR
244 INSTALLMAN3DIR INSTALLPRIVLIB INSTALLSCRIPT INSTALLSITEARCH
245 INSTALLSITELIB INST_ARCHLIB INST_BIN INST_EXE INST_LIB
246 INST_MAN1DIR INST_MAN3DIR INST_SCRIPT LDFROM LIB LIBPERL_A LIBS
247 LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB
248 NAME NEEDS_LINKING NOECHO NORECURS NO_VC OBJECT OPTIMIZE PERL PERLMAINCC
249 PERL_ARCHLIB PERL_LIB PERL_SRC PERM_RW PERM_RWX
250 PL_FILES PM PMLIBDIRS PPM_INSTALL_EXEC PPM_INSTALL_SCRIPT PREFIX
251 PREREQ_PM SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
252 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
256 # IMPORTS is used under OS/2 and Win32
258 # @Overridable is close to @MM_Sections but not identical. The
259 # order is important. Many subroutines declare macros. These
260 # depend on each other. Let's try to collect the macros up front,
261 # then pasthru, then the rules.
263 # MM_Sections are the sections we have to call explicitly
264 # in Overridable we have subroutines that are used indirectly
270 post_initialize const_config constants tool_autosplit tool_xsubpp
271 tools_other dist macro depend cflags const_loadlibs const_cccmd
276 c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs
277 dynamic_lib static static_lib manifypods processPL installbin subdirs
278 clean realclean dist_basics dist_core dist_dir dist_test dist_ci
279 install force perldepend makefile staticmake test ppd
281 ); # loses section ordering
283 @Overridable = @MM_Sections;
284 push @Overridable, qw[
286 dir_target libscan makeaperl needs_linking perm_rw perm_rwx
287 subdir_x test_via_harness test_via_script
291 push @MM_Sections, qw[
293 pm_to_blib selfdocument
297 # Postamble needs to be the last that was always the case
298 push @MM_Sections, "postamble";
299 push @Overridable, "postamble";
301 # All sections are valid keys.
302 @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
304 # we will use all these variables in the Makefile
307 ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc
308 lib_ext obj_ext osname osvers ranlib sitelibexp sitearchexp so exe_ext
312 foreach $item (@Attrib_help){
313 $Recognized_Att_Keys{$item} = 1;
315 foreach $item (@Get_from_Config) {
316 $Recognized_Att_Keys{uc $item} = $Config{$item};
317 print "Attribute '\U$item\E' => '$Config{$item}'\n"
322 # When we eval a Makefile.PL in a subdirectory, that one will ask
323 # us (the parent) for the values and will prepend "..", so that
324 # all files to be installed end up below OUR ./blib
329 INST_BIN 1 INST_EXE 1 INST_LIB 1 INST_ARCHLIB 1 INST_SCRIPT
330 1 MAP_TARGET 1 INST_MAN1DIR 1 INST_MAN3DIR 1 PERL_SRC 1
335 NEEDS_LINKING HAS_LINK_CODE
337 @Keep_after_flush{@keep} = (1) x @keep;
343 The extension you are trying to build apparently is rather old and
344 most probably outdated. We detect that from the fact, that a
345 subroutine "writeMakefile" is called, and this subroutine is not
346 supported anymore since about October 1994.
348 Please contact the author or look into CPAN (details about CPAN can be
349 found in the FAQ and at http:/www.perl.com) for a more recent version
350 of the extension. If you're really desperate, you can try to change
351 the subroutine name from writeMakefile to WriteMakefile and rerun
352 'perl Makefile.PL', but you're most probably left alone, when you do
360 sub ExtUtils::MakeMaker::new {
361 my($class,$self) = @_;
364 print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
365 if (-f "MANIFEST" && ! -f "Makefile"){
369 $self = {} unless (defined $self);
373 my(%initial_att) = %$self; # record initial attributes
376 foreach $prereq (sort keys %{$self->{PREREQ_PM}}) {
377 my $eval = "use $prereq $self->{PREREQ_PM}->{$prereq}";
380 warn "Warning: prerequisite $prereq $self->{PREREQ_PM}->{$prereq} not found";
381 # Why is/was this 'delete' here? We need PREREQ_PM later to make PPDs.
383 # delete $self->{PREREQ_PM}{$prereq};
387 # unless (defined $ExtUtils::MakeMaker::useCPAN) {
388 # print qq{MakeMaker WARNING: prerequisites not found (@unsatisfied)
389 # Please install these modules first and rerun 'perl Makefile.PL'.\n};
390 # if ($ExtUtils::MakeMaker::hasCPAN) {
391 # $ExtUtils::MakeMaker::useCPAN = prompt(qq{Should I try to use the CPAN module to fetch them for you?},"yes");
393 # print qq{Hint: You may want to install the CPAN module to autofetch the needed modules\n};
394 # $ExtUtils::MakeMaker::useCPAN=0;
397 # if ($ExtUtils::MakeMaker::useCPAN) {
399 # CPAN->import(@unsatisfied);
401 # die qq{prerequisites not found (@unsatisfied)};
403 # warn qq{WARNING: prerequisites not found (@unsatisfied)};
406 if (defined $self->{CONFIGURE}) {
407 if (ref $self->{CONFIGURE} eq 'CODE') {
408 $self = { %$self, %{&{$self->{CONFIGURE}}}};
410 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
414 # This is for old Makefiles written pre 5.00, will go away
415 if ( Carp::longmess("") =~ /runsubdirpl/s ){
416 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
419 my $newclass = ++$PACKNAME;
420 local @Parent = @Parent; # Protect against non-local exits
423 print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
424 mv_all_methods("MY",$newclass);
425 bless $self, $newclass;
427 @{"$newclass\:\:ISA"} = 'MM';
430 if (defined $Parent[-2]){
431 $self->{PARENT} = $Parent[-2];
433 for $key (keys %Prepend_dot_dot) {
434 next unless defined $self->{PARENT}{$key};
435 $self->{$key} = $self->{PARENT}{$key};
436 # PERL and FULLPERL may be command verbs instead of full
437 # file specifications under VMS. If so, don't turn them
439 $self->{$key} = $self->catdir("..",$self->{$key})
440 unless $self->file_name_is_absolute($self->{$key})
441 || ($^O eq 'VMS' and ($key =~ /PERL$/ && $self->{$key} =~ /^[\w\-\$]+$/));
443 if ($self->{PARENT}) {
444 $self->{PARENT}->{CHILDREN}->{$newclass} = $self;
445 if (exists $self->{PARENT}->{CAPI}
446 and not exists $self->{CAPI})
448 # inherit, but only if already unspecified
449 $self->{CAPI} = $self->{PARENT}->{CAPI};
453 parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV);
456 $self->{NAME} ||= $self->guess_name;
458 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
462 if (! $self->{PERL_SRC} ) {
463 my($pthinks) = $self->canonpath($INC{'Config.pm'});
464 my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
465 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
466 if ($pthinks ne $cthinks &&
467 !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
468 print "Have $pthinks expected $cthinks\n";
470 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
473 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
476 Your perl and your Config.pm seem to have different ideas about the architecture
478 Perl thinks: [$pthinks]
479 Config says: [$Config{archname}]
480 This may or may not cause problems. Please check your installation of perl if you
481 have problems building this extension.
486 $self->init_dirscan();
487 $self->init_others();
488 my($argv) = neatvalue(\@ARGV);
492 push @{$self->{RESULT}}, <<END;
493 # This Makefile is for the $self->{NAME} extension to perl.
495 # It was generated automatically by MakeMaker version
496 # $VERSION (Revision: $Revision) from the contents of
497 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
499 # ANY CHANGES MADE HERE WILL BE LOST!
501 # MakeMaker ARGV: $argv
503 # MakeMaker Parameters:
506 foreach $key (sort keys %initial_att){
507 my($v) = neatvalue($initial_att{$key});
508 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
510 push @{$self->{RESULT}}, "# $key => $v";
513 # turn the SKIP array into a SKIPHASH hash
515 for $skip (@{$self->{SKIP} || []}) {
516 $self->{SKIPHASH}{$skip} = 1;
518 delete $self->{SKIP}; # free memory
520 if ($self->{PARENT}) {
521 for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
522 $self->{SKIPHASH}{$_} = 1;
526 # We run all the subdirectories now. They don't have much to query
527 # from the parent, but the parent has to query them: if they need linking!
528 unless ($self->{NORECURS}) {
529 $self->eval_in_subdirs if @{$self->{DIR}};
533 foreach $section ( @MM_Sections ){
534 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
535 my($skipit) = $self->skipcheck($section);
537 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
539 my(%a) = %{$self->{$section} || {}};
540 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
541 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
542 push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
546 push @{$self->{RESULT}}, "\n# End.";
551 sub WriteEmptyMakefile {
552 if (-f 'Makefile.old') {
553 chmod 0666, 'Makefile.old';
554 unlink 'Makefile.old' or warn "unlink Makefile.old: $!";
556 rename 'Makefile', 'Makefile.old' or warn "rename Makefile Makefile.old: $!"
558 open MF, '> Makefile' or die "open Makefile for write: $!";
571 close MF or die "close Makefile for write: $!";
575 print STDOUT "Checking if your kit is complete...\n";
576 require ExtUtils::Manifest;
577 $ExtUtils::Manifest::Quiet=$ExtUtils::Manifest::Quiet=1; #avoid warning
578 my(@missed)=ExtUtils::Manifest::manicheck();
580 print STDOUT "Warning: the following files are missing in your kit:\n";
581 print "\t", join "\n\t", @missed;
583 print STDOUT "Please inform the author.\n";
585 print STDOUT "Looks good\n";
590 my($self, @args) = @_;
592 unless (m/(.*?)=(.*)/){
593 help(),exit 1 if m/^help$/;
594 ++$Verbose if m/^verb/;
597 my($name, $value) = ($1, $2);
598 if ($value =~ m/^~(\w+)?/){ # tilde with optional username
599 $value =~ s [^~(\w*)]
601 ((getpwnam($1))[7] || "~$1") :
605 $self->{uc($name)} = $value;
608 # catch old-style 'potential_libs' and inform user how to 'upgrade'
609 if (defined $self->{potential_libs}){
610 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
611 if ($self->{potential_libs}){
612 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
614 print STDOUT "$msg deleted.\n";
616 $self->{LIBS} = [$self->{potential_libs}];
617 delete $self->{potential_libs};
619 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
620 if (defined $self->{ARMAYBE}){
621 my($armaybe) = $self->{ARMAYBE};
622 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
623 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
624 my(%dl) = %{$self->{dynamic_lib} || {}};
625 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
626 delete $self->{ARMAYBE};
628 if (defined $self->{LDTARGET}){
629 print STDOUT "LDTARGET should be changed to LDFROM\n";
630 $self->{LDFROM} = $self->{LDTARGET};
631 delete $self->{LDTARGET};
633 # Turn a DIR argument on the command line into an array
634 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
635 # So they can choose from the command line, which extensions they want
636 # the grep enables them to have some colons too much in case they
637 # have to build a list with the shell
638 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
640 # Turn a INCLUDE_EXT argument on the command line into an array
641 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
642 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
644 # Turn a EXCLUDE_EXT argument on the command line into an array
645 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
646 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
649 foreach $mmkey (sort keys %$self){
650 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
651 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
652 unless exists $Recognized_Att_Keys{$mmkey};
659 # We allow extension-specific hints files.
661 return unless -d "hints";
663 # First we look for the best hintsfile we have
665 my($hint)="${^O}_$Config{osvers}";
670 # Also try without trailing minor version numbers.
672 last if -f "hints/$hint.pl"; # found
674 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
676 return unless -f "hints/$hint.pl"; # really there
678 # execute the hintsfile:
680 # my $fh = new FileHandle;
681 # $fh->open("hints/$hint.pl");
683 open(FH,"hints/$hint.pl");
684 # @goodhints = <$fh>;
688 print STDOUT "Processing hints file hints/$hint.pl\n";
689 eval join('',@goodhints);
690 print STDOUT $@ if $@;
696 my($symtab) = \%{"${from}::"};
699 # Here you see the *current* list of methods that are overridable
700 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
701 # still trying to reduce the list to some reasonable minimum --
702 # because I want to make it easier for the user. A.K.
704 foreach $method (@Overridable) {
706 # We cannot say "next" here. Nick might call MY->makeaperl
707 # which isn't defined right now
709 # Above statement was written at 4.23 time when Tk-b8 was
710 # around. As Tk-b9 only builds with 5.002something and MM 5 is
711 # standard, we try to enable the next line again. It was
712 # commented out until MM 5.23
714 next unless defined &{"${from}::$method"};
716 *{"${to}::$method"} = \&{"${from}::$method"};
718 # delete would do, if we were sure, nobody ever called
719 # MY->makeaperl directly
721 # delete $symtab->{$method};
723 # If we delete a method, then it will be undefined and cannot
724 # be called. But as long as we have Makefile.PLs that rely on
725 # %MY:: being intact, we have to fill the hole with an
728 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
731 # We have to clean out %INC also, because the current directory is
732 # changed frequently and Graham Barr prefers to get his version
733 # out of a History.pl file which is "required" so woudn't get
734 # loaded again in another extension requiring a History.pl
736 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
737 # to core dump in the middle of a require statement. The required
738 # file was Tk/MMutil.pm. The consequence is, we have to be
739 # extremely careful when we try to give perl a reason to reload a
740 # library with same name. The workaround prefers to drop nothing
741 # from %INC and teach the writers not to use such libraries.
744 # foreach $inc (keys %INC) {
745 # #warn "***$inc*** deleted";
753 if ($section eq 'dynamic') {
754 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
755 "in skipped section 'dynamic_bs'\n"
756 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
757 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
758 "in skipped section 'dynamic_lib'\n"
759 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
761 if ($section eq 'dynamic_lib') {
762 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
763 "targets in skipped section 'dynamic_bs'\n"
764 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
766 if ($section eq 'static') {
767 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
768 "in skipped section 'static_lib'\n"
769 if $self->{SKIPHASH}{static_lib} && $Verbose;
771 return 'skipped' if $self->{SKIPHASH}{$section};
779 # my $fh = new FileHandle;
781 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
783 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
784 # $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
785 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
787 for $chunk (@{$self->{RESULT}}) {
788 # print $fh "$chunk\n";
794 my($finalname) = $self->{MAKEFILE};
795 rename("MakeMaker.tmp", $finalname);
796 chmod 0644, $finalname unless $Is_VMS;
798 if ($self->{PARENT}) {
799 foreach (keys %$self) { # safe memory
800 delete $self->{$_} unless $Keep_after_flush{$_};
804 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
807 # The following mkbootstrap() is only for installations that are calling
808 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
809 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
812 !!! Your Makefile has been built such a long time ago, !!!
813 !!! that is unlikely to work with current MakeMaker. !!!
814 !!! Please rebuild your Makefile !!!
818 # Ditto for mksymlists() as of MakeMaker 5.17
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 !!!
829 return "undef" unless defined $v;
831 return "q[$v]" unless $t;
833 my(@m, $elem, @neat);
835 foreach $elem (@$v) {
836 push @neat, "q[$elem]";
838 push @m, join ", ", @neat;
842 return "$v" unless $t eq 'HASH';
844 while (($key,$val) = each %$v){
845 last unless defined $key; # cautious programming in case (undef,undef) is true
846 push(@m,"$key=>".neatvalue($val)) ;
848 return "{ ".join(', ',@m)." }";
855 push @m, "\n# Full list of MakeMaker attribute values:";
856 foreach $key (sort keys %$self){
857 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
858 my($v) = neatvalue($self->{$key});
859 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
861 push @m, "# $key => $v";
867 package ExtUtils::MakeMaker;
874 ExtUtils::MakeMaker - create an extension Makefile
878 C<use ExtUtils::MakeMaker;>
880 C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
884 C<MM-E<gt>new(\%att)-E<gt>flush;>
888 This utility is designed to write a Makefile for an extension module
889 from a Makefile.PL. It is based on the Makefile.SH model provided by
890 Andy Dougherty and the perl5-porters.
892 It splits the task of generating the Makefile into several subroutines
893 that can be individually overridden. Each subroutine returns the text
894 it wishes to have written to the Makefile.
896 MakeMaker is object oriented. Each directory below the current
897 directory that contains a Makefile.PL. Is treated as a separate
898 object. This makes it possible to write an unlimited number of
899 Makefiles with a single invocation of WriteMakefile().
901 =head2 How To Write A Makefile.PL
903 The short answer is: Don't.
905 Always begin with h2xs.
906 Always begin with h2xs!
907 ALWAYS BEGIN WITH H2XS!
909 even if you're not building around a header file, and even if you
910 don't have an XS component.
912 Run h2xs(1) before you start thinking about writing a module. For so
913 called pm-only modules that consist of C<*.pm> files only, h2xs has
914 the C<-X> switch. This will generate dummy files of all kinds that are
915 useful for the module developer.
917 The medium answer is:
919 use ExtUtils::MakeMaker;
920 WriteMakefile( NAME => "Foo::Bar" );
922 The long answer is the rest of the manpage :-)
924 =head2 Default Makefile Behaviour
926 The generated Makefile enables the user of the extension to invoke
928 perl Makefile.PL # optionally "perl Makefile.PL verbose"
930 make test # optionally set TEST_VERBOSE=1
931 make install # See below
933 The Makefile to be produced may be altered by adding arguments of the
934 form C<KEY=VALUE>. E.g.
936 perl Makefile.PL PREFIX=/tmp/myperl5
938 Other interesting targets in the generated Makefile are
940 make config # to check if the Makefile is up-to-date
941 make clean # delete local temp files (Makefile gets renamed)
942 make realclean # delete derived files (including ./blib)
943 make ci # check in all the files in the MANIFEST file
944 make dist # see below the Distribution Support section
948 MakeMaker checks for the existence of a file named F<test.pl> in the
949 current directory and if it exists it adds commands to the test target
950 of the generated Makefile that will execute the script with the proper
951 set of perl C<-I> options.
953 MakeMaker also checks for any files matching glob("t/*.t"). It will
954 add commands to the test target of the generated Makefile that execute
955 all matching files via the L<Test::Harness> module with the C<-I>
956 switches set correctly.
960 A useful variation of the above is the target C<testdb>. It runs the
961 test under the Perl debugger (see L<perldebug>). If the file
962 F<test.pl> exists in the current directory, it is used for the test.
964 If you want to debug some other testfile, set C<TEST_FILE> variable
967 make testdb TEST_FILE=t/mytest.t
969 By default the debugger is called using C<-d> option to perl. If you
970 want to specify some other option, set C<TESTDB_SW> variable:
972 make testdb TESTDB_SW=-Dx
976 make alone puts all relevant files into directories that are named by
977 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_MAN1DIR, and
978 INST_MAN3DIR. All these default to something below ./blib if you are
979 I<not> building below the perl source directory. If you I<are>
980 building below the perl source, INST_LIB and INST_ARCHLIB default to
981 ../../lib, and INST_SCRIPT is not defined.
983 The I<install> target of the generated Makefile copies the files found
984 below each of the INST_* directories to their INSTALL*
985 counterparts. Which counterparts are chosen depends on the setting of
986 INSTALLDIRS according to the following table:
991 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH
992 INST_LIB INSTALLPRIVLIB INSTALLSITELIB
994 INST_SCRIPT INSTALLSCRIPT
995 INST_MAN1DIR INSTALLMAN1DIR
996 INST_MAN3DIR INSTALLMAN3DIR
998 The INSTALL... macros in turn default to their %Config
999 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
1001 You can check the values of these variables on your system with
1005 And to check the sequence in which the library directories are
1006 searched by perl, run
1008 perl -le 'print join $/, @INC'
1011 =head2 PREFIX and LIB attribute
1013 PREFIX and LIB can be used to set several INSTALL* attributes in one
1014 go. The quickest way to install a module in a non-standard place might
1017 perl Makefile.PL LIB=~/lib
1019 This will install the module's architecture-independent files into
1020 ~/lib, the architecture-dependent files into ~/lib/$archname/auto.
1022 Another way to specify many INSTALL directories with a single
1023 parameter is PREFIX.
1025 perl Makefile.PL PREFIX=~
1027 This will replace the string specified by $Config{prefix} in all
1028 $Config{install*} values.
1030 Note, that in both cases the tilde expansion is done by MakeMaker, not
1031 by perl by default, nor by make. Conflicts between parameters LIB,
1032 PREFIX and the various INSTALL* arguments are resolved so that
1035 If the user has superuser privileges, and is not working on AFS
1036 (Andrew File System) or relatives, then the defaults for
1037 INSTALLPRIVLIB, INSTALLARCHLIB, INSTALLSCRIPT, etc. will be appropriate,
1038 and this incantation will be the best:
1040 perl Makefile.PL; make; make test
1043 make install per default writes some documentation of what has been
1044 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1045 can be bypassed by calling make pure_install.
1049 will have to specify the installation directories as these most
1050 probably have changed since perl itself has been installed. They will
1051 have to do this by calling
1053 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1054 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1057 Be careful to repeat this procedure every time you recompile an
1058 extension, unless you are sure the AFS installation directories are
1061 =head2 Static Linking of a new Perl Binary
1063 An extension that is built with the above steps is ready to use on
1064 systems supporting dynamic loading. On systems that do not support
1065 dynamic loading, any newly created extension has to be linked together
1066 with the available resources. MakeMaker supports the linking process
1067 by creating appropriate targets in the Makefile whenever an extension
1068 is built. You can invoke the corresponding section of the makefile with
1072 That produces a new perl binary in the current directory with all
1073 extensions linked in that can be found in INST_ARCHLIB , SITELIBEXP,
1074 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1075 UNIX, this is called Makefile.aperl (may be system dependent). If you
1076 want to force the creation of a new perl, it is recommended, that you
1077 delete this Makefile.aperl, so the directories are searched-through
1078 for linkable libraries again.
1080 The binary can be installed into the directory where perl normally
1081 resides on your machine with
1085 To produce a perl binary with a different name than C<perl>, either say
1087 perl Makefile.PL MAP_TARGET=myperl
1094 make myperl MAP_TARGET=myperl
1095 make inst_perl MAP_TARGET=myperl
1097 In any case you will be prompted with the correct invocation of the
1098 C<inst_perl> target that installs the new binary into INSTALLBIN.
1100 make inst_perl per default writes some documentation of what has been
1101 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1102 can be bypassed by calling make pure_inst_perl.
1104 Warning: the inst_perl: target will most probably overwrite your
1105 existing perl binary. Use with care!
1107 Sometimes you might want to build a statically linked perl although
1108 your system supports dynamic loading. In this case you may explicitly
1109 set the linktype with the invocation of the Makefile.PL or make:
1111 perl Makefile.PL LINKTYPE=static # recommended
1115 make LINKTYPE=static # works on most systems
1117 =head2 Determination of Perl Library and Installation Locations
1119 MakeMaker needs to know, or to guess, where certain things are
1120 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1121 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1122 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1124 Extensions may be built either using the contents of the perl source
1125 directory tree or from the installed perl library. The recommended way
1126 is to build extensions after you have run 'make install' on perl
1127 itself. You can do that in any directory on your hard disk that is not
1128 below the perl source tree. The support for extensions below the ext
1129 directory of the perl distribution is only good for the standard
1130 extensions that come with perl.
1132 If an extension is being built below the C<ext/> directory of the perl
1133 source then MakeMaker will set PERL_SRC automatically (e.g.,
1134 C<../..>). If PERL_SRC is defined and the extension is recognized as
1135 a standard extension, then other variables default to the following:
1138 PERL_LIB = PERL_SRC/lib
1139 PERL_ARCHLIB = PERL_SRC/lib
1141 INST_ARCHLIB = PERL_ARCHLIB
1143 If an extension is being built away from the perl source then MakeMaker
1144 will leave PERL_SRC undefined and default to using the installed copy
1145 of the perl library. The other variables default to the following:
1147 PERL_INC = $archlibexp/CORE
1148 PERL_LIB = $privlibexp
1149 PERL_ARCHLIB = $archlibexp
1150 INST_LIB = ./blib/lib
1151 INST_ARCHLIB = ./blib/arch
1153 If perl has not yet been installed then PERL_SRC can be defined on the
1154 command line as shown in the previous section.
1157 =head2 Which architecture dependent directory?
1159 If you don't want to keep the defaults for the INSTALL* macros,
1160 MakeMaker helps you to minimize the typing needed: the usual
1161 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1162 by Configure at perl compilation time. MakeMaker supports the user who
1163 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1164 then MakeMaker defaults the latter to be the same subdirectory of
1165 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1166 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1167 for INSTALLSITELIB and INSTALLSITEARCH.
1169 MakeMaker gives you much more freedom than needed to configure
1170 internal variables and get different results. It is worth to mention,
1171 that make(1) also lets you configure most of the variables that are
1172 used in the Makefile. But in the majority of situations this will not
1173 be necessary, and should only be done, if the author of a package
1174 recommends it (or you know what you're doing).
1176 =head2 Using Attributes and Parameters
1178 The following attributes can be specified as arguments to WriteMakefile()
1179 or as NAME=VALUE pairs on the command line:
1185 String containing name (and email address) of package author(s). Is used
1186 in PPD (Perl Package Description) files for PPM (Perl Package Manager).
1190 One line description of the module. Will be included in PPD file.
1194 Name of the file that contains the package description. MakeMaker looks
1195 for a line in the POD matching /^($package\s-\s)(.*)/. This is typically
1196 the first line in the "=head1 NAME" section. $2 becomes the abstract.
1198 =item BINARY_LOCATION
1200 Used when creating PPD files for binary packages. It can be set to a
1201 full or relative path or URL to the binary archive for a particular
1202 architecture. For example:
1204 perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
1206 builds a PPD package that references a binary of the C<Agent> package,
1207 located in the C<x86> directory relative to the PPD itself.
1211 Ref to array of *.c file names. Initialised from a directory scan
1212 and the values portion of the XS attribute hash. This is not
1213 currently used by MakeMaker but may be handy in Makefile.PLs.
1217 Switch to force usage of the Perl C API even when compiling for PERL_OBJECT.
1219 Note that this attribute is passed through to any recursive build,
1220 but if and only if the submodule's Makefile.PL itself makes no mention
1221 of the 'CAPI' attribute.
1225 String that will be included in the compiler call command line between
1226 the arguments INC and OPTIMIZE.
1230 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1231 config.sh. MakeMaker will add to CONFIG the following values anyway:
1251 CODE reference. The subroutine should return a hash reference. The
1252 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1253 be determined by some evaluation method.
1257 Something like C<"-DHAVE_UNISTD_H">
1261 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1266 Your name for distributing the package (by tar file). This defaults to
1271 Hashref of symbol names for routines to be made available as universal
1272 symbols. Each key/value pair consists of the package name and an
1273 array of routine names in that package. Used only under AIX, OS/2,
1274 VMS and Win32 at present. The routine names supplied will be expanded
1275 in the same way as XSUB names are expanded by the XS() macro.
1278 {"$(NAME)" => ["boot_$(NAME)" ] }
1282 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1283 "NetconfigPtr" => [ 'DESTROY'] }
1285 Please see the L<ExtUtils::Mksymlists> documentation for more information
1286 about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
1290 Array of symbol names for variables to be made available as universal symbols.
1291 Used only under AIX, OS/2, VMS and Win32 at present. Defaults to [].
1292 (e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
1296 Array of extension names to exclude when doing a static build. This
1297 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1298 details. (e.g. [ qw( Socket POSIX ) ] )
1300 This attribute may be most useful when specified as a string on the
1301 command line: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1305 Ref to array of executable files. The files will be copied to the
1306 INST_SCRIPT directory. Make realclean will delete them from there
1309 =item FIRST_MAKEFILE
1311 The name of the Makefile to be produced. Defaults to the contents of
1312 MAKEFILE, but can be overridden. This is used for the second Makefile
1313 that will be produced for the MAP_TARGET.
1317 Perl binary able to run this extension.
1321 This provides an alternate means to specify function names to be
1322 exported from the extension. Its value is a reference to an
1323 array of function names to be exported by the extension. These
1324 names are passed through unaltered to the linker options file.
1328 Ref to array of *.h file names. Similar to C.
1332 This attribute is used to specify names to be imported into the
1333 extension. It is only used on OS/2 and Win32.
1337 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1341 Array of extension names to be included when doing a static build.
1342 MakeMaker will normally build with all of the installed extensions when
1343 doing a static build, and that is usually the desired behavior. If
1344 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1345 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1347 It is not necessary to mention DynaLoader or the current extension when
1348 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1349 only DynaLoader and the current extension will be included in the build.
1351 This attribute may be most useful when specified as a string on the
1352 command line: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1354 =item INSTALLARCHLIB
1356 Used by 'make install', which copies files from INST_ARCHLIB to this
1357 directory if INSTALLDIRS is set to perl.
1361 Directory to install binary files (e.g. tkperl) into.
1365 Determines which of the two sets of installation directories to
1366 choose: installprivlib and installarchlib versus installsitelib and
1367 installsitearch. The first pair is chosen with INSTALLDIRS=perl, the
1368 second with INSTALLDIRS=site. Default is site.
1370 =item INSTALLMAN1DIR
1372 This directory gets the man pages at 'make install' time. Defaults to
1373 $Config{installman1dir}.
1375 =item INSTALLMAN3DIR
1377 This directory gets the man pages at 'make install' time. Defaults to
1378 $Config{installman3dir}.
1380 =item INSTALLPRIVLIB
1382 Used by 'make install', which copies files from INST_LIB to this
1383 directory if INSTALLDIRS is set to perl.
1387 Used by 'make install' which copies files from INST_SCRIPT to this
1390 =item INSTALLSITEARCH
1392 Used by 'make install', which copies files from INST_ARCHLIB to this
1393 directory if INSTALLDIRS is set to site (default).
1395 =item INSTALLSITELIB
1397 Used by 'make install', which copies files from INST_LIB to this
1398 directory if INSTALLDIRS is set to site (default).
1402 Same as INST_LIB for architecture dependent files.
1406 Directory to put real binary files during 'make'. These will be copied
1407 to INSTALLBIN during 'make install'
1411 Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you
1416 Directory where we put library files of this extension while building
1421 Directory to hold the man pages at 'make' time
1425 Directory to hold the man pages at 'make' time
1429 Directory, where executable files should be installed during
1430 'make'. Defaults to "./blib/bin", just to have a dummy location during
1431 testing. make install will copy the files in INST_SCRIPT to
1436 defaults to "$(OBJECT)" and is used in the ld command to specify
1437 what files to link/load from (also see dynamic_lib below for how to
1442 LIB can only be set at C<perl Makefile.PL> time. It has the effect of
1443 setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any
1447 The filename of the perllibrary that will be used together with this
1448 extension. Defaults to libperl.a.
1452 An anonymous array of alternative library
1453 specifications to be searched for (in order) until
1454 at least one library is found. E.g.
1456 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1458 Mind, that any element of the array
1459 contains a complete set of arguments for the ld
1460 command. So do not specify
1462 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1464 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1465 you specify a scalar as in
1467 'LIBS' => "-ltcl -ltk -lX11"
1469 MakeMaker will turn it into an array with one element.
1473 'static' or 'dynamic' (default unless usedl=undef in
1474 config.sh). Should only be used to force static linking (also see
1479 Boolean which tells MakeMaker, that it should include the rules to
1480 make a perl. This is handled automatically as a switch by
1481 MakeMaker. The user normally does not need it.
1485 The name of the Makefile to be produced.
1489 Hashref of pod-containing files. MakeMaker will default this to all
1490 EXE_FILES files that include POD directives. The files listed
1491 here will be converted to man pages and installed as was requested
1496 Hashref of .pm and .pod files. MakeMaker will default this to all
1497 .pod and any .pm files that include POD directives. The files listed
1498 here will be converted to man pages and installed as was requested
1503 If it is intended, that a new perl binary be produced, this variable
1504 may hold a name for that binary. Defaults to perl
1508 If the extension links to a library that it builds set this to the
1509 name of the library (see SDBM_File)
1513 Perl module name for this extension (DBD::Oracle). This will default
1514 to the directory name but should be explicitly defined in the
1519 MakeMaker will figure out, if an extension contains linkable code
1520 anywhere down the directory tree, and will set this variable
1521 accordingly, but you can speed it up a very little bit, if you define
1522 this boolean variable yourself.
1526 Defaults to C<@>. By setting it to an empty string you can generate a
1527 Makefile that echos all commands. Mainly used in debugging MakeMaker
1532 Boolean. Attribute to inhibit descending into subdirectories.
1536 In general any generated Makefile checks for the current version of
1537 MakeMaker and the version the Makefile was built under. If NO_VC is
1538 set, the version check is neglected. Do not write this into your
1539 Makefile.PL, use it interactively instead.
1543 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1544 string containing all object files, e.g. "tkpBind.o
1545 tkpButton.o tkpCanvas.o"
1549 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1550 passed to subdirectory makes.
1554 Perl binary for tasks that can be done by miniperl
1558 The call to the program that is able to compile perlmain.c. Defaults
1563 Same as above for architecture dependent files
1567 Directory containing the Perl library to use.
1571 Directory containing the Perl source code (use of this should be
1572 avoided, it may be undefined)
1576 Desired permission for read/writable files. Defaults to C<644>.
1577 See also L<MM_Unix/perm_rw>.
1581 Desired permission for executable files. Defaults to C<755>.
1582 See also L<MM_Unix/perm_rwx>.
1586 Ref to hash of files to be processed as perl programs. MakeMaker
1587 will default to any found *.PL file (except Makefile.PL) being keys
1588 and the basename of the file being the value. E.g.
1590 {'foobar.PL' => 'foobar'}
1592 The *.PL files are expected to produce output to the target files
1593 themselves. If multiple files can be generated from the same *.PL
1594 file then the value in the hash can be a reference to an array of
1595 target file names. E.g.
1597 {'foobar.PL' => ['foobar1','foobar2']}
1601 Hashref of .pm files and *.pl files to be installed. e.g.
1603 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1605 By default this will include *.pm and *.pl and the files found in
1606 the PMLIBDIRS directories. Defining PM in the
1607 Makefile.PL will override PMLIBDIRS.
1611 Ref to array of subdirectories containing library files. Defaults to
1612 [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
1613 they contain will be installed in the corresponding location in the
1614 library. A libscan() method can be used to alter the behaviour.
1615 Defining PM in the Makefile.PL will override PMLIBDIRS.
1617 =item PPM_INSTALL_EXEC
1619 Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl)
1621 =item PPM_INSTALL_SCRIPT
1623 Name of the script that gets executed by the Perl Package Manager after
1624 the installation of a package.
1628 Can be used to set the three INSTALL* attributes in one go (except for
1629 probably INSTALLMAN1DIR, if it is not below PREFIX according to
1630 %Config). They will have PREFIX as a common directory node and will
1631 branch from that node into lib/, lib/ARCHNAME or whatever Configure
1632 decided at the build time of your perl (unless you override one of
1637 Hashref: Names of modules that need to be available to run this
1638 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1639 desired version is the value. If the required version number is 0, we
1640 only check if any version is installed already.
1644 Arryref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1645 Makefile. Caution! Do not use the SKIP attribute for the neglectible
1646 speedup. It may seriously damage the resulting Makefile. Only use it,
1647 if you really need it.
1651 Ref to array of typemap file names. Use this when the typemaps are
1652 in some directory other than the current directory or when they are
1653 not named B<typemap>. The last typemap in the list takes
1654 precedence. A typemap in the current directory has highest
1655 precedence, even if it isn't listed in TYPEMAPS. The default system
1656 typemap has lowest precedence.
1660 Your version number for distributing the package. This defaults to
1665 Instead of specifying the VERSION in the Makefile.PL you can let
1666 MakeMaker parse a file to determine the version number. The parsing
1667 routine requires that the file named by VERSION_FROM contains one
1668 single line to compute the version number. The first line in the file
1669 that contains the regular expression
1671 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
1673 will be evaluated with eval() and the value of the named variable
1674 B<after> the eval() will be assigned to the VERSION attribute of the
1675 MakeMaker object. The following lines will be parsed o.k.:
1679 ( $VERSION ) = '$Revision: 1.222 $ ' =~ /\$Revision:\s+([^\s]+)/;
1680 $FOO::VERSION = '1.10';
1681 *FOO::VERSION = \'1.11';
1683 but these will fail:
1685 my $VERSION = '1.01';
1686 local $VERSION = '1.02';
1687 local $FOO::VERSION = '1.30';
1689 The file named in VERSION_FROM is not added as a dependency to
1690 Makefile. This is not really correct, but it would be a major pain
1691 during development to have to rewrite the Makefile for any smallish
1692 change in that file. If you want to make sure that the Makefile
1693 contains the correct VERSION macro after any change of the file, you
1694 would have to do something like
1696 depend => { Makefile => '$(VERSION_FROM)' }
1698 See attribute C<depend> below.
1702 Hashref of .xs files. MakeMaker will default this. e.g.
1704 {'name_of_file.xs' => 'name_of_file.c'}
1706 The .c files will automatically be included in the list of files
1707 deleted by a make clean.
1711 String of options to pass to xsubpp. This might include C<-C++> or
1712 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
1717 May be set to an empty string, which is identical to C<-prototypes>, or
1718 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
1719 defaults to the empty string.
1723 Your version number for the .xs file of this package. This defaults
1724 to the value of the VERSION attribute.
1728 =head2 Additional lowercase attributes
1730 can be used to pass parameters to the methods which implement that
1731 part of the Makefile.
1737 {FILES => "*.xyz foo"}
1741 {ANY_TARGET => ANY_DEPENDECY, ...}
1745 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
1746 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
1747 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
1749 If you specify COMPRESS, then SUFFIX should also be altered, as it is
1750 needed to tell make the target file of the compression. Setting
1751 DIST_CP to ln can be useful, if you need to preserve the timestamps on
1752 your files. DIST_CP can take the values 'cp', which copies the file,
1753 'ln', which links the file, and 'best' which copies symbolic links and
1754 links the rest. Default is 'best'.
1758 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
1762 {LINKTYPE => 'static', 'dynamic' or ''}
1764 NB: Extensions that have nothing but *.pm files had to say
1768 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1769 can be deleted safely. MakeMaker recognizes, when there's nothing to
1774 {ANY_MACRO => ANY_VALUE, ...}
1778 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
1780 =item tool_autosplit
1786 =head2 Overriding MakeMaker Methods
1788 If you cannot achieve the desired Makefile behaviour by specifying
1789 attributes you may define private subroutines in the Makefile.PL.
1790 Each subroutines returns the text it wishes to have written to
1791 the Makefile. To override a section of the Makefile you can
1794 sub MY::c_o { "new literal text" }
1796 or you can edit the default by saying something like:
1799 package MY; # so that "SUPER" works right
1800 my $inherited = shift->SUPER::c_o(@_);
1801 $inherited =~ s/old text/new text/;
1805 If you are running experiments with embedding perl as a library into
1806 other applications, you might find MakeMaker is not sufficient. You'd
1807 better have a look at ExtUtils::Embed which is a collection of utilities
1810 If you still need a different solution, try to develop another
1811 subroutine that fits your needs and submit the diffs to
1812 F<perl5-porters@perl.org> or F<comp.lang.perl.moderated> as appropriate.
1814 For a complete description of all MakeMaker methods see L<ExtUtils::MM_Unix>.
1816 Here is a simple example of how to add a new target to the generated
1821 $(MYEXTLIB): sdbm/Makefile
1822 cd sdbm && $(MAKE) all
1827 =head2 Hintsfile support
1829 MakeMaker.pm uses the architecture specific information from
1830 Config.pm. In addition it evaluates architecture specific hints files
1831 in a C<hints/> directory. The hints files are expected to be named
1832 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
1833 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
1834 MakeMaker within the WriteMakefile() subroutine, and can be used to
1835 execute commands as well as to include special variables. The rules
1836 which hintsfile is chosen are the same as in Configure.
1838 The hintsfile is eval()ed immediately after the arguments given to
1839 WriteMakefile are stuffed into a hash reference $self but before this
1840 reference becomes blessed. So if you want to do the equivalent to
1841 override or create an attribute you would say something like
1843 $self->{LIBS} = ['-ldbm -lucb -lc'];
1845 =head2 Distribution Support
1847 For authors of extensions MakeMaker provides several Makefile
1848 targets. Most of the support comes from the ExtUtils::Manifest module,
1849 where additional documentation can be found.
1853 =item make distcheck
1855 reports which files are below the build directory but not in the
1856 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
1859 =item make skipcheck
1861 reports which files are skipped due to the entries in the
1862 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
1865 =item make distclean
1867 does a realclean first and then the distcheck. Note that this is not
1868 needed to build a new distribution as long as you are sure, that the
1869 MANIFEST file is ok.
1873 rewrites the MANIFEST file, adding all remaining files found (See
1874 ExtUtils::Manifest::mkmanifest() for details)
1878 Copies all the files that are in the MANIFEST file to a newly created
1879 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
1880 exists, it will be removed first.
1884 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
1885 a make test in that directory.
1889 First does a distdir. Then a command $(PREOP) which defaults to a null
1890 command, followed by $(TOUNIX), which defaults to a null command under
1891 UNIX, and will convert files in distribution directory to UNIX format
1892 otherwise. Next it runs C<tar> on that directory into a tarfile and
1893 deletes the directory. Finishes with a command $(POSTOP) which
1894 defaults to a null command.
1898 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
1900 =item make uutardist
1902 Runs a tardist first and uuencodes the tarfile.
1906 First does a distdir. Then a command $(PREOP) which defaults to a null
1907 command. Next it runs C<shar> on that directory into a sharfile and
1908 deletes the intermediate directory again. Finishes with a command
1909 $(POSTOP) which defaults to a null command. Note: For shdist to work
1910 properly a C<shar> program that can handle directories is mandatory.
1914 First does a distdir. Then a command $(PREOP) which defaults to a null
1915 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
1916 zipfile. Then deletes that directory. Finishes with a command
1917 $(POSTOP) which defaults to a null command.
1921 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
1925 Customization of the dist targets can be done by specifying a hash
1926 reference to the dist attribute of the WriteMakefile call. The
1927 following parameters are recognized:
1930 COMPRESS ('gzip --best')
1933 TO_UNIX (depends on the system)
1934 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
1944 WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" })
1946 =head2 Disabling an extension
1948 If some events detected in F<Makefile.PL> imply that there is no way
1949 to create the Module, but this is a normal state of things, then you
1950 can create a F<Makefile> which does nothing, but succeeds on all the
1951 "usual" build targets. To do so, use
1953 ExtUtils::MakeMaker::WriteEmptyMakefile();
1955 instead of WriteMakefile().
1957 This may be useful if other modules expect this module to be I<built>
1958 OK, as opposed to I<work> OK (say, this system-dependent module builds
1959 in a subdirectory of some other distribution, or is listed as a
1960 dependency in a CPAN::Bundle, but the functionality is supported by
1961 different means on the current architecture).
1969 Command line options used by C<MakeMaker-E<gt>new()>, and thus by
1970 C<WriteMakefile()>. The string is split on whitespace, and the result
1971 is processed before any actual command line arguments are processed.
1977 ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib,
1978 ExtUtils::Install, ExtUtils::Embed
1982 Andy Dougherty <F<doughera@lafcol.lafayette.edu>>, Andreas KE<ouml>nig
1983 <F<A.Koenig@franz.ww.TU-Berlin.DE>>, Tim Bunce <F<Tim.Bunce@ig.co.uk>>.
1984 VMS support by Charles Bailey <F<bailey@newman.upenn.edu>>. OS/2
1985 support by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>. Contact the
1986 makemaker mailing list C<mailto:makemaker@franz.ww.tu-berlin.de>, if
1987 you have any questions.