1 package ExtUtils::MakeMaker;
3 BEGIN {require 5.005_03;}
6 $Version_OK = "5.49"; # Makefiles older than $Version_OK will die
7 # (Will be checked from MakeMaker version 4.13 onwards)
8 ($Revision = substr(q$Revision: 1.51 $, 10)) =~ s/\s+$//;
15 @ISA @EXPORT @EXPORT_OK
16 $ISA_TTY $Revision $VERSION $Verbose $Version_OK %Config
17 %Keep_after_flush %MM_Sections @Prepend_parent
18 %Recognized_Att_Keys @Get_from_Config @MM_Sections @Overridable
24 @EXPORT = qw(&WriteMakefile &writeMakefile $Verbose &prompt);
25 @EXPORT_OK = qw($VERSION &neatvalue &mkbootstrap &mksymlists);
27 # These will go away once the last of the Win32 & VMS specific code is
29 my $Is_VMS = $^O eq 'VMS';
30 my $Is_Win32 = $^O eq 'MSWin32';
34 require ExtUtils::MM; # Things like CPAN assume loading ExtUtils::MakeMaker
37 require ExtUtils::MY; # XXX pre-5.8 versions of ExtUtils::Embed expect
38 # loading ExtUtils::MakeMaker will give them MY.
39 # This will go when Embed is it's own CPAN module.
43 Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
47 my $mm = MM->new(\%att);
55 $ISA_TTY = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ; # Pipe?
56 Carp::confess("prompt function called without an argument")
58 my $dispdef = defined $def ? "[$def] " : " ";
59 $def = defined $def ? $def : "";
63 print "$mess $dispdef";
64 if ($ISA_TTY && !$ENV{PERL_MM_USE_DEFAULT}) {
69 else { # user hit ctrl-D
76 return (!defined $ans || $ans eq '') ? $def : $ans;
81 use Cwd qw(cwd abs_path);
82 my $pwd = cwd() || die "Can't figure out your cwd!";
84 local @INC = map eval {abs_path($_) if -e} || $_, @INC;
85 push @INC, '.'; # '.' has to always be at the end of @INC
87 foreach my $dir (@{$self->{DIR}}){
88 my($abs) = $self->catdir($pwd,$dir);
89 $self->eval_in_x($abs);
96 chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
103 # if ($@ =~ /prerequisites/) {
104 # die "MakeMaker WARNING: $@";
106 # warn "WARNING from evaluation of $dir/Makefile.PL: $@";
108 die "ERROR from evaluation of $dir/Makefile.PL: $@";
115 # package name for the classes into which the first object will be blessed
116 $PACKNAME = "PACK000";
118 my @attrib_help = qw/
120 AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION
121 C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
122 EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE
123 FULLPERL FULLPERLRUN FULLPERLRUNINST
125 INST_ARCHLIB INST_SCRIPT INST_BIN INST_LIB INST_MAN1DIR INST_MAN3DIR
127 PREFIX SITEPREFIX VENDORPREFIX
128 INSTALLPRIVLIB INSTALLSITELIB INSTALLVENDORLIB
129 INSTALLARCHLIB INSTALLSITEARCH INSTALLVENDORARCH
130 INSTALLBIN INSTALLSITEBIN INSTALLVENDORBIN
131 INSTALLMAN1DIR INSTALLMAN3DIR
132 INSTALLSITEMAN1DIR INSTALLSITEMAN3DIR
133 INSTALLVENDORMAN1DIR INSTALLVENDORMAN3DIR
135 PERL_LIB PERL_ARCHLIB
136 SITELIBEXP SITEARCHEXP
137 INC INCLUDE_EXT LDFROM LIB LIBPERL_A LIBS
138 LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB
140 NAME NEEDS_LINKING NOECHO NORECURS NO_VC OBJECT OPTIMIZE PERL PERLMAINCC
141 PERLRUN PERLRUNINST PERL_CORE
142 PERL_SRC PERM_RW PERM_RWX
143 PL_FILES PM PM_FILTER PMLIBDIRS POLLUTE PPM_INSTALL_EXEC
144 PPM_INSTALL_SCRIPT PREREQ_FATAL PREREQ_PM PREREQ_PRINT PRINT_PREREQ
145 SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
146 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
148 MACPERL_SRC MACPERL_LIB MACLIBS_68K MACLIBS_PPC MACLIBS_SC MACLIBS_MRC
149 MACLIBS_ALL_68K MACLIBS_ALL_PPC MACLIBS_SHARED
152 # IMPORTS is used under OS/2 and Win32
154 # @Overridable is close to @MM_Sections but not identical. The
155 # order is important. Many subroutines declare macros. These
156 # depend on each other. Let's try to collect the macros up front,
157 # then pasthru, then the rules.
159 # MM_Sections are the sections we have to call explicitly
160 # in Overridable we have subroutines that are used indirectly
166 post_initialize const_config constants tool_autosplit tool_xsubpp
167 tools_other dist macro depend cflags const_loadlibs const_cccmd
172 c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs
173 dynamic_lib static static_lib manifypods processPL
175 clean realclean dist_basics dist_core dist_dir dist_test dist_ci
176 install force perldepend makefile staticmake test ppd
178 ); # loses section ordering
180 @Overridable = @MM_Sections;
181 push @Overridable, qw[
183 dir_target libscan makeaperl needs_linking perm_rw perm_rwx
184 subdir_x test_via_harness test_via_script init_PERL
187 push @MM_Sections, qw[
189 pm_to_blib selfdocument
193 # Postamble needs to be the last that was always the case
194 push @MM_Sections, "postamble";
195 push @Overridable, "postamble";
197 # All sections are valid keys.
198 @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
200 # we will use all these variables in the Makefile
203 ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc
204 lib_ext obj_ext osname osvers ranlib sitelibexp sitearchexp so
208 foreach my $item (@attrib_help){
209 $Recognized_Att_Keys{$item} = 1;
211 foreach my $item (@Get_from_Config) {
212 $Recognized_Att_Keys{uc $item} = $Config{$item};
213 print "Attribute '\U$item\E' => '$Config{$item}'\n"
218 # When we eval a Makefile.PL in a subdirectory, that one will ask
219 # us (the parent) for the values and will prepend "..", so that
220 # all files to be installed end up below OUR ./blib
222 @Prepend_parent = qw(
223 INST_BIN INST_LIB INST_ARCHLIB INST_SCRIPT
224 MAP_TARGET INST_MAN1DIR INST_MAN3DIR PERL_SRC
229 NEEDS_LINKING HAS_LINK_CODE
231 @Keep_after_flush{@keep} = (1) x @keep;
237 The extension you are trying to build apparently is rather old and
238 most probably outdated. We detect that from the fact, that a
239 subroutine "writeMakefile" is called, and this subroutine is not
240 supported anymore since about October 1994.
242 Please contact the author or look into CPAN (details about CPAN can be
243 found in the FAQ and at http:/www.perl.com) for a more recent version
244 of the extension. If you're really desperate, you can try to change
245 the subroutine name from writeMakefile to WriteMakefile and rerun
246 'perl Makefile.PL', but you're most probably left alone, when you do
255 my($class,$self) = @_;
258 if ("@ARGV" =~ /\bPREREQ_PRINT\b/) {
259 require Data::Dumper;
260 print Data::Dumper->Dump([$self->{PREREQ_PM}], [qw(PREREQ_PM)]);
263 # PRINT_PREREQ is RedHatism.
264 if ("@ARGV" =~ /\bPRINT_PREREQ\b/) {
265 print join(" ", map { "perl($_)>=$self->{PREREQ_PM}->{$_} " } sort keys %{$self->{PREREQ_PM}}), "\n";
269 print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
270 if (-f "MANIFEST" && ! -f "Makefile"){
274 $self = {} unless (defined $self);
278 my %configure_att; # record &{$self->{CONFIGURE}} attributes
279 my(%initial_att) = %$self; # record initial attributes
281 my(%unsatisfied) = ();
282 foreach my $prereq (sort keys %{$self->{PREREQ_PM}}) {
283 eval "require $prereq";
285 my $pr_version = $prereq->VERSION || 0;
288 warn sprintf "Warning: prerequisite %s %s not found.\n",
289 $prereq, $self->{PREREQ_PM}{$prereq}
290 unless $self->{PREREQ_FATAL};
291 $unsatisfied{$prereq} = 'not installed';
292 } elsif ($pr_version < $self->{PREREQ_PM}->{$prereq} ){
293 warn sprintf "Warning: prerequisite %s %s not found. We have %s.\n",
294 $prereq, $self->{PREREQ_PM}{$prereq},
295 ($pr_version || 'unknown version')
296 unless $self->{PREREQ_FATAL};
297 $unsatisfied{$prereq} = $self->{PREREQ_PM}->{$prereq} ?
298 $self->{PREREQ_PM}->{$prereq} : 'unknown version' ;
301 if (%unsatisfied && $self->{PREREQ_FATAL}){
302 my $failedprereqs = join ', ', map {"$_ $unsatisfied{$_}"}
304 die qq{MakeMaker FATAL: prerequisites not found ($failedprereqs)\n
305 Please install these modules first and rerun 'perl Makefile.PL'.\n};
308 if (defined $self->{CONFIGURE}) {
309 if (ref $self->{CONFIGURE} eq 'CODE') {
310 %configure_att = %{&{$self->{CONFIGURE}}};
311 $self = { %$self, %configure_att };
313 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
317 # This is for old Makefiles written pre 5.00, will go away
318 if ( Carp::longmess("") =~ /runsubdirpl/s ){
319 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
322 my $newclass = ++$PACKNAME;
323 local @Parent = @Parent; # Protect against non-local exits
326 print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
327 mv_all_methods("MY",$newclass);
328 bless $self, $newclass;
330 require ExtUtils::MY;
331 @{"$newclass\:\:ISA"} = 'MM';
334 if (defined $Parent[-2]){
335 $self->{PARENT} = $Parent[-2];
337 for $key (@Prepend_parent) {
338 next unless defined $self->{PARENT}{$key};
339 $self->{$key} = $self->{PARENT}{$key};
340 unless ($^O eq 'VMS' && $key =~ /PERL$/) {
341 $self->{$key} = $self->catdir("..",$self->{$key})
342 unless $self->file_name_is_absolute($self->{$key});
344 # PERL or FULLPERL will be a command verb or even a
345 # command with an argument instead of a full file
346 # specification under VMS. So, don't turn the command
347 # into a filespec, but do add a level to the path of
348 # the argument if not already absolute.
349 my @cmd = split /\s+/, $self->{$key};
350 $cmd[1] = $self->catfile('[-]',$cmd[1])
351 unless (@cmd < 2) || $self->file_name_is_absolute($cmd[1]);
352 $self->{$key} = join(' ', @cmd);
355 if ($self->{PARENT}) {
356 $self->{PARENT}->{CHILDREN}->{$newclass} = $self;
357 foreach my $opt (qw(POLLUTE PERL_CORE)) {
358 if (exists $self->{PARENT}->{$opt}
359 and not exists $self->{$opt})
361 # inherit, but only if already unspecified
362 $self->{$opt} = $self->{PARENT}->{$opt};
366 my @fm = grep /^FIRST_MAKEFILE=/, @ARGV;
367 parse_args($self,@fm) if @fm;
369 parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV);
372 $self->{NAME} ||= $self->guess_name;
374 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
378 if (! $self->{PERL_SRC} ) {
379 require VMS::Filespec if $Is_VMS;
380 my($pthinks) = $self->canonpath($INC{'Config.pm'});
381 my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
382 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
383 if ($pthinks ne $cthinks &&
384 !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
385 print "Have $pthinks expected $cthinks\n";
387 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
390 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
392 print STDOUT <<END unless $self->{UNINSTALLED_PERL};
393 Your perl and your Config.pm seem to have different ideas about the
394 architecture they are running on.
395 Perl thinks: [$pthinks]
396 Config says: [$Config{archname}]
397 This may or may not cause problems. Please check your installation of perl
398 if you have problems building this extension.
403 $self->init_dirscan();
404 $self->init_others();
406 my($argv) = neatvalue(\@ARGV);
410 push @{$self->{RESULT}}, <<END;
411 # This Makefile is for the $self->{NAME} extension to perl.
413 # It was generated automatically by MakeMaker version
414 # $VERSION (Revision: $Revision) from the contents of
415 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
417 # ANY CHANGES MADE HERE WILL BE LOST!
419 # MakeMaker ARGV: $argv
421 # MakeMaker Parameters:
424 foreach my $key (sort keys %initial_att){
425 my($v) = neatvalue($initial_att{$key});
426 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
428 push @{$self->{RESULT}}, "# $key => $v";
430 undef %initial_att; # free memory
432 if (defined $self->{CONFIGURE}) {
433 push @{$self->{RESULT}}, <<END;
435 # MakeMaker 'CONFIGURE' Parameters:
437 if (scalar(keys %configure_att) > 0) {
438 foreach my $key (sort keys %configure_att){
439 my($v) = neatvalue($configure_att{$key});
440 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
442 push @{$self->{RESULT}}, "# $key => $v";
447 push @{$self->{RESULT}}, "# no values returned";
449 undef %configure_att; # free memory
452 # turn the SKIP array into a SKIPHASH hash
454 for $skip (@{$self->{SKIP} || []}) {
455 $self->{SKIPHASH}{$skip} = 1;
457 delete $self->{SKIP}; # free memory
459 if ($self->{PARENT}) {
460 for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
461 $self->{SKIPHASH}{$_} = 1;
465 # We run all the subdirectories now. They don't have much to query
466 # from the parent, but the parent has to query them: if they need linking!
467 unless ($self->{NORECURS}) {
468 $self->eval_in_subdirs if @{$self->{DIR}};
471 foreach my $section ( @MM_Sections ){
472 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
473 my($skipit) = $self->skipcheck($section);
475 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
477 my(%a) = %{$self->{$section} || {}};
478 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
479 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
480 push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
484 push @{$self->{RESULT}}, "\n# End.";
489 sub WriteEmptyMakefile {
490 Carp::croak "WriteEmptyMakefile: Need even number of args" if @_ % 2;
493 my $self = MM->new(\%att);
494 if (-f "$self->{MAKEFILE}.old") {
495 chmod 0666, "$self->{MAKEFILE}.old";
496 unlink "$self->{MAKEFILE}.old" or warn "unlink $self->{MAKEFILE}.old: $!";
498 rename $self->{MAKEFILE}, "$self->{MAKEFILE}.old"
499 or warn "rename $self->{MAKEFILE} $self->{MAKEFILE}.old: $!"
500 if -f $self->{MAKEFILE};
501 open MF, '>'.$self->{MAKEFILE} or die "open $self->{MAKEFILE} for write: $!";
514 close MF or die "close $self->{MAKEFILE} for write: $!";
518 print STDOUT "Checking if your kit is complete...\n";
519 require ExtUtils::Manifest;
521 $ExtUtils::Manifest::Quiet = $ExtUtils::Manifest::Quiet = 1;
522 my(@missed) = ExtUtils::Manifest::manicheck();
524 print STDOUT "Warning: the following files are missing in your kit:\n";
525 print "\t", join "\n\t", @missed;
527 print STDOUT "Please inform the author.\n";
529 print STDOUT "Looks good\n";
534 my($self, @args) = @_;
536 unless (m/(.*?)=(.*)/) {
537 help(),exit 1 if m/^help$/;
538 ++$Verbose if m/^verb/;
541 my($name, $value) = ($1, $2);
542 if ($value =~ m/^~(\w+)?/) { # tilde with optional username
543 $value =~ s [^~(\w*)]
545 ((getpwnam($1))[7] || "~$1") :
549 $self->{uc($name)} = $value;
552 # catch old-style 'potential_libs' and inform user how to 'upgrade'
553 if (defined $self->{potential_libs}){
554 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
555 if ($self->{potential_libs}){
556 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
558 print STDOUT "$msg deleted.\n";
560 $self->{LIBS} = [$self->{potential_libs}];
561 delete $self->{potential_libs};
563 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
564 if (defined $self->{ARMAYBE}){
565 my($armaybe) = $self->{ARMAYBE};
566 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
567 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
568 my(%dl) = %{$self->{dynamic_lib} || {}};
569 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
570 delete $self->{ARMAYBE};
572 if (defined $self->{LDTARGET}){
573 print STDOUT "LDTARGET should be changed to LDFROM\n";
574 $self->{LDFROM} = $self->{LDTARGET};
575 delete $self->{LDTARGET};
577 # Turn a DIR argument on the command line into an array
578 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
579 # So they can choose from the command line, which extensions they want
580 # the grep enables them to have some colons too much in case they
581 # have to build a list with the shell
582 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
584 # Turn a INCLUDE_EXT argument on the command line into an array
585 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
586 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
588 # Turn a EXCLUDE_EXT argument on the command line into an array
589 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
590 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
593 foreach my $mmkey (sort keys %$self){
594 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
595 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
596 unless exists $Recognized_Att_Keys{$mmkey};
603 # We allow extension-specific hints files.
605 return unless -d "hints";
607 # First we look for the best hintsfile we have
608 my($hint)="${^O}_$Config{osvers}";
613 # Also try without trailing minor version numbers.
615 last if -f "hints/$hint.pl"; # found
617 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
619 my $hint_file = "hints/$hint.pl";
621 return unless -f $hint_file; # really there
623 _run_hintfile($self, $hint_file);
628 local($self) = shift; # make $self available to the hint file.
629 my($hint_file) = shift;
632 print STDERR "Processing hints file $hint_file\n";
633 my $ret = do "./$hint_file";
634 unless( defined $ret ) {
635 print STDERR $@ if $@;
642 my($symtab) = \%{"${from}::"};
644 # Here you see the *current* list of methods that are overridable
645 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
646 # still trying to reduce the list to some reasonable minimum --
647 # because I want to make it easier for the user. A.K.
649 local $SIG{__WARN__} = sub {
650 # can't use 'no warnings redefined', 5.6 only
651 warn @_ unless $_[0] =~ /^Subroutine .* redefined/
653 foreach my $method (@Overridable) {
655 # We cannot say "next" here. Nick might call MY->makeaperl
656 # which isn't defined right now
658 # Above statement was written at 4.23 time when Tk-b8 was
659 # around. As Tk-b9 only builds with 5.002something and MM 5 is
660 # standard, we try to enable the next line again. It was
661 # commented out until MM 5.23
663 next unless defined &{"${from}::$method"};
665 *{"${to}::$method"} = \&{"${from}::$method"};
667 # delete would do, if we were sure, nobody ever called
668 # MY->makeaperl directly
670 # delete $symtab->{$method};
672 # If we delete a method, then it will be undefined and cannot
673 # be called. But as long as we have Makefile.PLs that rely on
674 # %MY:: being intact, we have to fill the hole with an
677 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
680 # We have to clean out %INC also, because the current directory is
681 # changed frequently and Graham Barr prefers to get his version
682 # out of a History.pl file which is "required" so woudn't get
683 # loaded again in another extension requiring a History.pl
685 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
686 # to core dump in the middle of a require statement. The required
687 # file was Tk/MMutil.pm. The consequence is, we have to be
688 # extremely careful when we try to give perl a reason to reload a
689 # library with same name. The workaround prefers to drop nothing
690 # from %INC and teach the writers not to use such libraries.
693 # foreach $inc (keys %INC) {
694 # #warn "***$inc*** deleted";
702 if ($section eq 'dynamic') {
703 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
704 "in skipped section 'dynamic_bs'\n"
705 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
706 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
707 "in skipped section 'dynamic_lib'\n"
708 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
710 if ($section eq 'dynamic_lib') {
711 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
712 "targets in skipped section 'dynamic_bs'\n"
713 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
715 if ($section eq 'static') {
716 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
717 "in skipped section 'static_lib'\n"
718 if $self->{SKIPHASH}{static_lib} && $Verbose;
720 return 'skipped' if $self->{SKIPHASH}{$section};
728 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
730 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
731 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
733 for $chunk (@{$self->{RESULT}}) {
738 my($finalname) = $self->{MAKEFILE};
739 rename("MakeMaker.tmp", $finalname);
740 chmod 0644, $finalname unless $Is_VMS;
742 if ($self->{PARENT} && !$self->{_KEEP_AFTER_FLUSH}) {
743 foreach (keys %$self) { # safe memory
744 delete $self->{$_} unless $Keep_after_flush{$_};
748 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
751 # The following mkbootstrap() is only for installations that are calling
752 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
753 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
756 !!! Your Makefile has been built such a long time ago, !!!
757 !!! that is unlikely to work with current MakeMaker. !!!
758 !!! Please rebuild your Makefile !!!
762 # Ditto for mksymlists() as of MakeMaker 5.17
765 !!! Your Makefile has been built such a long time ago, !!!
766 !!! that is unlikely to work with current MakeMaker. !!!
767 !!! Please rebuild your Makefile !!!
773 return "undef" unless defined $v;
775 return "q[$v]" unless $t;
779 foreach my $elem (@$v) {
780 push @neat, "q[$elem]";
782 push @m, join ", ", @neat;
786 return "$v" unless $t eq 'HASH';
788 while (($key,$val) = each %$v){
789 last unless defined $key; # cautious programming in case (undef,undef) is true
790 push(@m,"$key=>".neatvalue($val)) ;
792 return "{ ".join(', ',@m)." }";
799 push @m, "\n# Full list of MakeMaker attribute values:";
800 foreach my $key (sort keys %$self){
801 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
802 my($v) = neatvalue($self->{$key});
803 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
805 push @m, "# $key => $v";
817 ExtUtils::MakeMaker - create an extension Makefile
821 use ExtUtils::MakeMaker;
823 WriteMakefile( ATTRIBUTE => VALUE [, ...] );
827 This utility is designed to write a Makefile for an extension module
828 from a Makefile.PL. It is based on the Makefile.SH model provided by
829 Andy Dougherty and the perl5-porters.
831 It splits the task of generating the Makefile into several subroutines
832 that can be individually overridden. Each subroutine returns the text
833 it wishes to have written to the Makefile.
835 MakeMaker is object oriented. Each directory below the current
836 directory that contains a Makefile.PL is treated as a separate
837 object. This makes it possible to write an unlimited number of
838 Makefiles with a single invocation of WriteMakefile().
840 =head2 How To Write A Makefile.PL
842 The short answer is: Don't.
844 Always begin with h2xs.
845 Always begin with h2xs!
846 ALWAYS BEGIN WITH H2XS!
848 even if you're not building around a header file, and even if you
849 don't have an XS component.
851 Run h2xs(1) before you start thinking about writing a module. For so
852 called pm-only modules that consist of C<*.pm> files only, h2xs has
853 the C<-X> switch. This will generate dummy files of all kinds that are
854 useful for the module developer.
856 The medium answer is:
858 use ExtUtils::MakeMaker;
859 WriteMakefile( NAME => "Foo::Bar" );
861 The long answer is the rest of the manpage :-)
863 =head2 Default Makefile Behaviour
865 The generated Makefile enables the user of the extension to invoke
867 perl Makefile.PL # optionally "perl Makefile.PL verbose"
869 make test # optionally set TEST_VERBOSE=1
870 make install # See below
872 The Makefile to be produced may be altered by adding arguments of the
873 form C<KEY=VALUE>. E.g.
875 perl Makefile.PL PREFIX=/tmp/myperl5
877 Other interesting targets in the generated Makefile are
879 make config # to check if the Makefile is up-to-date
880 make clean # delete local temp files (Makefile gets renamed)
881 make realclean # delete derived files (including ./blib)
882 make ci # check in all the files in the MANIFEST file
883 make dist # see below the Distribution Support section
887 MakeMaker checks for the existence of a file named F<test.pl> in the
888 current directory and if it exists it adds commands to the test target
889 of the generated Makefile that will execute the script with the proper
890 set of perl C<-I> options.
892 MakeMaker also checks for any files matching glob("t/*.t"). It will
893 add commands to the test target of the generated Makefile that execute
894 all matching files in alphabetical order via the L<Test::Harness>
895 module with the C<-I> switches set correctly.
899 A useful variation of the above is the target C<testdb>. It runs the
900 test under the Perl debugger (see L<perldebug>). If the file
901 F<test.pl> exists in the current directory, it is used for the test.
903 If you want to debug some other testfile, set C<TEST_FILE> variable
906 make testdb TEST_FILE=t/mytest.t
908 By default the debugger is called using C<-d> option to perl. If you
909 want to specify some other option, set C<TESTDB_SW> variable:
911 make testdb TESTDB_SW=-Dx
915 make alone puts all relevant files into directories that are named by
916 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_MAN1DIR and
917 INST_MAN3DIR. All these default to something below ./blib if you are
918 I<not> building below the perl source directory. If you I<are>
919 building below the perl source, INST_LIB and INST_ARCHLIB default to
920 ../../lib, and INST_SCRIPT is not defined.
922 The I<install> target of the generated Makefile copies the files found
923 below each of the INST_* directories to their INSTALL*
924 counterparts. Which counterparts are chosen depends on the setting of
925 INSTALLDIRS according to the following table:
930 PREFIX SITEPREFIX VENDORPREFIX
931 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH INSTALLVENDORARCH
932 INST_LIB INSTALLPRIVLIB INSTALLSITELIB INSTALLVENDORLIB
933 INST_BIN INSTALLBIN INSTALLSITEBIN INSTALLVENDORBIN
934 INST_SCRIPT INSTALLSCRIPT INSTALLSCRIPT INSTALLSCRIPT
935 INST_MAN1DIR INSTALLMAN1DIR INSTALLSITEMAN1DIR INSTALLVENDORMAN1DIR
936 INST_MAN3DIR INSTALLMAN3DIR INSTALLSITEMAN3DIR INSTALLVENDORMAN3DIR
938 The INSTALL... macros in turn default to their %Config
939 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
941 You can check the values of these variables on your system with
945 And to check the sequence in which the library directories are
946 searched by perl, run
948 perl -le 'print join $/, @INC'
951 =head2 PREFIX and LIB attribute
953 PREFIX and LIB can be used to set several INSTALL* attributes in one
954 go. The quickest way to install a module in a non-standard place might
957 perl Makefile.PL PREFIX=~
959 This will install all files in the module under your home directory,
960 with man pages and libraries going into an appropriate place (usually
963 Another way to specify many INSTALL directories with a single
966 perl Makefile.PL LIB=~/lib
968 This will install the module's architecture-independent files into
969 ~/lib, the architecture-dependent files into ~/lib/$archname.
971 Note, that in both cases the tilde expansion is done by MakeMaker, not
972 by perl by default, nor by make.
974 Conflicts between parameters LIB, PREFIX and the various INSTALL*
975 arguments are resolved so that:
981 setting LIB overrides any setting of INSTALLPRIVLIB, INSTALLARCHLIB,
982 INSTALLSITELIB, INSTALLSITEARCH (and they are not affected by PREFIX);
986 without LIB, setting PREFIX replaces the initial C<$Config{prefix}>
987 part of those INSTALL* arguments, even if the latter are explicitly
988 set (but are set to still start with C<$Config{prefix}>).
992 If the user has superuser privileges, and is not working on AFS or
993 relatives, then the defaults for INSTALLPRIVLIB, INSTALLARCHLIB,
994 INSTALLSCRIPT, etc. will be appropriate, and this incantation will be
1002 make install per default writes some documentation of what has been
1003 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1004 can be bypassed by calling make pure_install.
1008 will have to specify the installation directories as these most
1009 probably have changed since perl itself has been installed. They will
1010 have to do this by calling
1012 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1013 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1016 Be careful to repeat this procedure every time you recompile an
1017 extension, unless you are sure the AFS installation directories are
1020 =head2 Static Linking of a new Perl Binary
1022 An extension that is built with the above steps is ready to use on
1023 systems supporting dynamic loading. On systems that do not support
1024 dynamic loading, any newly created extension has to be linked together
1025 with the available resources. MakeMaker supports the linking process
1026 by creating appropriate targets in the Makefile whenever an extension
1027 is built. You can invoke the corresponding section of the makefile with
1031 That produces a new perl binary in the current directory with all
1032 extensions linked in that can be found in INST_ARCHLIB, SITELIBEXP,
1033 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1034 UNIX, this is called Makefile.aperl (may be system dependent). If you
1035 want to force the creation of a new perl, it is recommended, that you
1036 delete this Makefile.aperl, so the directories are searched-through
1037 for linkable libraries again.
1039 The binary can be installed into the directory where perl normally
1040 resides on your machine with
1044 To produce a perl binary with a different name than C<perl>, either say
1046 perl Makefile.PL MAP_TARGET=myperl
1053 make myperl MAP_TARGET=myperl
1054 make inst_perl MAP_TARGET=myperl
1056 In any case you will be prompted with the correct invocation of the
1057 C<inst_perl> target that installs the new binary into INSTALLBIN.
1059 make inst_perl per default writes some documentation of what has been
1060 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1061 can be bypassed by calling make pure_inst_perl.
1063 Warning: the inst_perl: target will most probably overwrite your
1064 existing perl binary. Use with care!
1066 Sometimes you might want to build a statically linked perl although
1067 your system supports dynamic loading. In this case you may explicitly
1068 set the linktype with the invocation of the Makefile.PL or make:
1070 perl Makefile.PL LINKTYPE=static # recommended
1074 make LINKTYPE=static # works on most systems
1076 =head2 Determination of Perl Library and Installation Locations
1078 MakeMaker needs to know, or to guess, where certain things are
1079 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1080 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1081 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1083 Extensions may be built either using the contents of the perl source
1084 directory tree or from the installed perl library. The recommended way
1085 is to build extensions after you have run 'make install' on perl
1086 itself. You can do that in any directory on your hard disk that is not
1087 below the perl source tree. The support for extensions below the ext
1088 directory of the perl distribution is only good for the standard
1089 extensions that come with perl.
1091 If an extension is being built below the C<ext/> directory of the perl
1092 source then MakeMaker will set PERL_SRC automatically (e.g.,
1093 C<../..>). If PERL_SRC is defined and the extension is recognized as
1094 a standard extension, then other variables default to the following:
1097 PERL_LIB = PERL_SRC/lib
1098 PERL_ARCHLIB = PERL_SRC/lib
1100 INST_ARCHLIB = PERL_ARCHLIB
1102 If an extension is being built away from the perl source then MakeMaker
1103 will leave PERL_SRC undefined and default to using the installed copy
1104 of the perl library. The other variables default to the following:
1106 PERL_INC = $archlibexp/CORE
1107 PERL_LIB = $privlibexp
1108 PERL_ARCHLIB = $archlibexp
1109 INST_LIB = ./blib/lib
1110 INST_ARCHLIB = ./blib/arch
1112 If perl has not yet been installed then PERL_SRC can be defined on the
1113 command line as shown in the previous section.
1116 =head2 Which architecture dependent directory?
1118 If you don't want to keep the defaults for the INSTALL* macros,
1119 MakeMaker helps you to minimize the typing needed: the usual
1120 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1121 by Configure at perl compilation time. MakeMaker supports the user who
1122 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1123 then MakeMaker defaults the latter to be the same subdirectory of
1124 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1125 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1126 for INSTALLSITELIB and INSTALLSITEARCH.
1128 MakeMaker gives you much more freedom than needed to configure
1129 internal variables and get different results. It is worth to mention,
1130 that make(1) also lets you configure most of the variables that are
1131 used in the Makefile. But in the majority of situations this will not
1132 be necessary, and should only be done if the author of a package
1133 recommends it (or you know what you're doing).
1135 =head2 Using Attributes and Parameters
1137 The following attributes can be specified as arguments to WriteMakefile()
1138 or as NAME=VALUE pairs on the command line:
1144 One line description of the module. Will be included in PPD file.
1148 Name of the file that contains the package description. MakeMaker looks
1149 for a line in the POD matching /^($package\s-\s)(.*)/. This is typically
1150 the first line in the "=head1 NAME" section. $2 becomes the abstract.
1154 String containing name (and email address) of package author(s). Is used
1155 in PPD (Perl Package Description) files for PPM (Perl Package Manager).
1157 =item BINARY_LOCATION
1159 Used when creating PPD files for binary packages. It can be set to a
1160 full or relative path or URL to the binary archive for a particular
1161 architecture. For example:
1163 perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
1165 builds a PPD package that references a binary of the C<Agent> package,
1166 located in the C<x86> directory relative to the PPD itself.
1170 Ref to array of *.c file names. Initialised from a directory scan
1171 and the values portion of the XS attribute hash. This is not
1172 currently used by MakeMaker but may be handy in Makefile.PLs.
1176 String that will be included in the compiler call command line between
1177 the arguments INC and OPTIMIZE.
1181 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1182 config.sh. MakeMaker will add to CONFIG the following values anyway:
1202 CODE reference. The subroutine should return a hash reference. The
1203 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1204 be determined by some evaluation method.
1208 Something like C<"-DHAVE_UNISTD_H">
1212 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1217 Your name for distributing the package (by tar file). This defaults to
1222 Hashref of symbol names for routines to be made available as universal
1223 symbols. Each key/value pair consists of the package name and an
1224 array of routine names in that package. Used only under AIX, OS/2,
1225 VMS and Win32 at present. The routine names supplied will be expanded
1226 in the same way as XSUB names are expanded by the XS() macro.
1229 {"$(NAME)" => ["boot_$(NAME)" ] }
1233 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1234 "NetconfigPtr" => [ 'DESTROY'] }
1236 Please see the L<ExtUtils::Mksymlists> documentation for more information
1237 about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
1241 Array of symbol names for variables to be made available as universal symbols.
1242 Used only under AIX, OS/2, VMS and Win32 at present. Defaults to [].
1243 (e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
1247 Array of extension names to exclude when doing a static build. This
1248 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1249 details. (e.g. [ qw( Socket POSIX ) ] )
1251 This attribute may be most useful when specified as a string on the
1252 command line: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1256 Ref to array of executable files. The files will be copied to the
1257 INST_SCRIPT directory. Make realclean will delete them from there
1260 =item FIRST_MAKEFILE
1262 The name of the Makefile to be produced. Defaults to the contents of
1263 MAKEFILE, but can be overridden. This is used for the second Makefile
1264 that will be produced for the MAP_TARGET.
1268 Perl binary able to run this extension, load XS modules, etc...
1272 Like PERLRUN, except it uses FULLPERL.
1274 =item FULLPERLRUNINST
1276 Like PERLRUNINST, except it uses FULLPERL.
1280 This provides an alternate means to specify function names to be
1281 exported from the extension. Its value is a reference to an
1282 array of function names to be exported by the extension. These
1283 names are passed through unaltered to the linker options file.
1287 Ref to array of *.h file names. Similar to C.
1291 This attribute is used to specify names to be imported into the
1292 extension. It is only used on OS/2 and Win32.
1296 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1300 Array of extension names to be included when doing a static build.
1301 MakeMaker will normally build with all of the installed extensions when
1302 doing a static build, and that is usually the desired behavior. If
1303 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1304 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1306 It is not necessary to mention DynaLoader or the current extension when
1307 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1308 only DynaLoader and the current extension will be included in the build.
1310 This attribute may be most useful when specified as a string on the
1311 command line: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1313 =item INSTALLARCHLIB
1315 Used by 'make install', which copies files from INST_ARCHLIB to this
1316 directory if INSTALLDIRS is set to perl.
1320 Directory to install binary files (e.g. tkperl) into if
1325 Determines which of the sets of installation directories to choose:
1326 perl, site or vendor. Defaults to site.
1328 =item INSTALLMAN1DIR
1330 =item INSTALLMAN3DIR
1332 These directories get the man pages at 'make install' time if
1333 INSTALLDIRS=perl. Defaults to $Config{installman*dir}.
1335 If set to 'none', no man pages will be installed.
1337 =item INSTALLPRIVLIB
1339 Used by 'make install', which copies files from INST_LIB to this
1340 directory if INSTALLDIRS is set to perl.
1342 Defaults to $Config{installprivlib}.
1346 Used by 'make install' which copies files from INST_SCRIPT to this
1349 =item INSTALLSITEARCH
1351 Used by 'make install', which copies files from INST_ARCHLIB to this
1352 directory if INSTALLDIRS is set to site (default).
1354 =item INSTALLSITEBIN
1356 Used by 'make install', which copies files from INST_BIN to this
1357 directory if INSTALLDIRS is set to site (default).
1359 =item INSTALLSITELIB
1361 Used by 'make install', which copies files from INST_LIB to this
1362 directory if INSTALLDIRS is set to site (default).
1364 =item INSTALLSITEMAN1DIR
1366 =item INSTALLSITEMAN3DIR
1368 These directories get the man pages at 'make install' time if
1369 INSTALLDIRS=site (default). Defaults to
1370 $(SITEPREFIX)/man/man$(MAN*EXT).
1372 If set to 'none', no man pages will be installed.
1374 =item INSTALLVENDORARCH
1376 Used by 'make install', which copies files from INST_ARCHLIB to this
1377 directory if INSTALLDIRS is set to vendor.
1379 =item INSTALLVENDORBIN
1381 Used by 'make install', which copies files from INST_BIN to this
1382 directory if INSTALLDIRS is set to vendor.
1384 =item INSTALLVENDORLIB
1386 Used by 'make install', which copies files from INST_LIB to this
1387 directory if INSTALLDIRS is set to vendor.
1389 =item INSTALLVENDORMAN1DIR
1391 =item INSTALLVENDORMAN3DIR
1393 These directories get the man pages at 'make install' time if
1394 INSTALLDIRS=vendor. Defaults to $(VENDORPREFIX)/man/man$(MAN*EXT).
1396 If set to 'none', no man pages will be installed.
1400 Same as INST_LIB for architecture dependent files.
1404 Directory to put real binary files during 'make'. These will be copied
1405 to INSTALLBIN during 'make install'
1409 Directory where we put library files of this extension while building
1414 Directory to hold the man pages at 'make' time
1418 Directory to hold the man pages at 'make' time
1422 Directory, where executable files should be installed during
1423 'make'. Defaults to "./blib/script", just to have a dummy location during
1424 testing. make install will copy the files in INST_SCRIPT to
1429 defaults to "$(OBJECT)" and is used in the ld command to specify
1430 what files to link/load from (also see dynamic_lib below for how to
1435 LIB should only be set at C<perl Makefile.PL> time but is allowed as a
1436 MakeMaker argument. It has the effect of setting both INSTALLPRIVLIB
1437 and INSTALLSITELIB to that value regardless any explicit setting of
1438 those arguments (or of PREFIX). INSTALLARCHLIB and INSTALLSITEARCH
1439 are set to the corresponding architecture subdirectory.
1443 The filename of the perllibrary that will be used together with this
1444 extension. Defaults to libperl.a.
1448 An anonymous array of alternative library
1449 specifications to be searched for (in order) until
1450 at least one library is found. E.g.
1452 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1454 Mind, that any element of the array
1455 contains a complete set of arguments for the ld
1456 command. So do not specify
1458 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1460 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1461 you specify a scalar as in
1463 'LIBS' => "-ltcl -ltk -lX11"
1465 MakeMaker will turn it into an array with one element.
1469 'static' or 'dynamic' (default unless usedl=undef in
1470 config.sh). Should only be used to force static linking (also see
1475 Boolean which tells MakeMaker, that it should include the rules to
1476 make a perl. This is handled automatically as a switch by
1477 MakeMaker. The user normally does not need it.
1481 The name of the Makefile to be produced.
1485 Hashref of pod-containing files. MakeMaker will default this to all
1486 EXE_FILES files that include POD directives. The files listed
1487 here will be converted to man pages and installed as was requested
1492 Hashref that assigns to *.pm and *.pod files the files into which the
1493 manpages are to be written. MakeMaker parses all *.pod and *.pm files
1494 for POD directives. Files that contain POD will be the default keys of
1495 the MAN3PODS hashref. These will then be converted to man pages during
1496 C<make> and will be installed during C<make install>.
1500 If it is intended, that a new perl binary be produced, this variable
1501 may hold a name for that binary. Defaults to perl
1505 If the extension links to a library that it builds set this to the
1506 name of the library (see SDBM_File)
1510 Perl module name for this extension (DBD::Oracle). This will default
1511 to the directory name but should be explicitly defined in the
1516 MakeMaker will figure out if an extension contains linkable code
1517 anywhere down the directory tree, and will set this variable
1518 accordingly, but you can speed it up a very little bit if you define
1519 this boolean variable yourself.
1523 Defaults to C<@>. By setting it to an empty string you can generate a
1524 Makefile that echos all commands. Mainly used in debugging MakeMaker
1529 Boolean. Attribute to inhibit descending into subdirectories.
1533 In general, any generated Makefile checks for the current version of
1534 MakeMaker and the version the Makefile was built under. If NO_VC is
1535 set, the version check is neglected. Do not write this into your
1536 Makefile.PL, use it interactively instead.
1540 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1541 string containing all object files, e.g. "tkpBind.o
1542 tkpButton.o tkpCanvas.o"
1544 (Where BASEEXT is the last component of NAME, and OBJ_EXT is $Config{obj_ext}.)
1548 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1549 passed to subdirectory makes.
1553 Perl binary for tasks that can be done by miniperl
1557 Set only when MakeMaker is building the extensions of the Perl core
1562 The call to the program that is able to compile perlmain.c. Defaults
1567 Same as for PERL_LIB, but for architecture dependent files.
1569 Used only when MakeMaker is building the extensions of the Perl core
1570 distribution (because normally $(PERL_ARCHLIB) is automatically in @INC,
1571 and adding it would get in the way of PERL5LIB).
1575 Directory containing the Perl library to use.
1577 Used only when MakeMaker is building the extensions of the Perl core
1578 distribution (because normally $(PERL_LIB) is automatically in @INC,
1579 and adding it would get in the way of PERL5LIB).
1581 =item PERL_MALLOC_OK
1583 defaults to 0. Should be set to TRUE if the extension can work with
1584 the memory allocation routines substituted by the Perl malloc() subsystem.
1585 This should be applicable to most extensions with exceptions of those
1591 with bugs in memory allocations which are caught by Perl's malloc();
1595 which interact with the memory allocator in other ways than via
1596 malloc(), realloc(), free(), calloc(), sbrk() and brk();
1600 which rely on special alignment which is not provided by Perl's malloc().
1604 B<NOTE.> Negligence to set this flag in I<any one> of loaded extension
1605 nullifies many advantages of Perl's malloc(), such as better usage of
1606 system resources, error detection, memory usage reporting, catchable failure
1607 of memory allocations, etc.
1611 Use this instead of $(PERL) when you wish to run perl. It will set up
1612 extra necessary flags for you.
1616 Use this instead of $(PERL) when you wish to run perl to work with
1617 modules. It will add things like -I$(INST_ARCH) and other necessary
1618 flags so perl can see the modules you're about to install.
1622 Directory containing the Perl source code (use of this should be
1623 avoided, it may be undefined)
1627 Desired permission for read/writable files. Defaults to C<644>.
1628 See also L<MM_Unix/perm_rw>.
1632 Desired permission for executable files. Defaults to C<755>.
1633 See also L<MM_Unix/perm_rwx>.
1637 Ref to hash of files to be processed as perl programs. MakeMaker
1638 will default to any found *.PL file (except Makefile.PL) being keys
1639 and the basename of the file being the value. E.g.
1641 {'foobar.PL' => 'foobar'}
1643 The *.PL files are expected to produce output to the target files
1644 themselves. If multiple files can be generated from the same *.PL
1645 file then the value in the hash can be a reference to an array of
1646 target file names. E.g.
1648 {'foobar.PL' => ['foobar1','foobar2']}
1652 Hashref of .pm files and *.pl files to be installed. e.g.
1654 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1656 By default this will include *.pm and *.pl and the files found in
1657 the PMLIBDIRS directories. Defining PM in the
1658 Makefile.PL will override PMLIBDIRS.
1662 Ref to array of subdirectories containing library files. Defaults to
1663 [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
1664 they contain will be installed in the corresponding location in the
1665 library. A libscan() method can be used to alter the behaviour.
1666 Defining PM in the Makefile.PL will override PMLIBDIRS.
1668 (Where BASEEXT is the last component of NAME.)
1672 A filter program, in the traditional Unix sense (input from stdin, output
1673 to stdout) that is passed on each .pm file during the build (in the
1674 pm_to_blib() phase). It is empty by default, meaning no filtering is done.
1676 Great care is necessary when defining the command if quoting needs to be
1677 done. For instance, you would need to say:
1679 {'PM_FILTER' => 'grep -v \\"^\\#\\"'}
1681 to remove all the leading coments on the fly during the build. The
1682 extra \\ are necessary, unfortunately, because this variable is interpolated
1683 within the context of a Perl program built on the command line, and double
1684 quotes are what is used with the -e switch to build that command line. The
1685 # is escaped for the Makefile, since what is going to be generated will then
1688 PM_FILTER = grep -v \"^\#\"
1690 Without the \\ before the #, we'd have the start of a Makefile comment,
1691 and the macro would be incorrectly defined.
1695 Release 5.005 grandfathered old global symbol names by providing preprocessor
1696 macros for extension source compatibility. As of release 5.6, these
1697 preprocessor definitions are not available by default. The POLLUTE flag
1698 specifies that the old names should still be defined:
1700 perl Makefile.PL POLLUTE=1
1702 Please inform the module author if this is necessary to successfully install
1703 a module under 5.6 or later.
1705 =item PPM_INSTALL_EXEC
1707 Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl)
1709 =item PPM_INSTALL_SCRIPT
1711 Name of the script that gets executed by the Perl Package Manager after
1712 the installation of a package.
1716 This overrides all the default install locations. Man pages,
1717 libraries, scripts, etc... MakeMaker will try to make an educated
1718 guess about where to place things under the new PREFIX based on your
1719 Config defaults. Failing that, it will fall back to a structure
1720 which should be sensible for your platform.
1722 If you specify LIB or any INSTALL* variables they will not be effected
1725 Defaults to $Config{installprefixexp}.
1729 Hashref: Names of modules that need to be available to run this
1730 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1731 desired version is the value. If the required version number is 0, we
1732 only check if any version is installed already.
1736 Bool. If this parameter is true, failing to have the required modules
1737 (or the right versions thereof) will be fatal. perl Makefile.PL will die
1738 with the proper message.
1740 Note: see L<Test::Harness> for a shortcut for stopping tests early if
1741 you are missing dependencies.
1743 Do I<not> use this parameter for simple requirements, which could be resolved
1744 at a later time, e.g. after an unsuccessful B<make test> of your module.
1746 It is I<extremely> rare to have to use C<PREREQ_FATAL> at all!
1750 Bool. If this parameter is true, the prerequisites will be printed to
1751 stdout and MakeMaker will exit. The output format is
1761 RedHatism for C<PREREQ_PRINT>. The output format is different, though:
1763 perl(A::B)>=Vers1 perl(C::D)>=Vers2 ...
1767 Like PREFIX, but only for the site install locations.
1769 Defaults to PREFIX (if set) or $Config{siteprefixexp}. Perls prior to
1770 5.6.0 didn't have an explicit siteprefix in the Config. In those
1771 cases $Config{installprefix} will be used.
1775 Arrayref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1776 Makefile. Caution! Do not use the SKIP attribute for the negligible
1777 speedup. It may seriously damage the resulting Makefile. Only use it
1778 if you really need it.
1782 Ref to array of typemap file names. Use this when the typemaps are
1783 in some directory other than the current directory or when they are
1784 not named B<typemap>. The last typemap in the list takes
1785 precedence. A typemap in the current directory has highest
1786 precedence, even if it isn't listed in TYPEMAPS. The default system
1787 typemap has lowest precedence.
1791 Like PREFIX, but only for the vendor install locations.
1793 Defaults to PREFIX (if set) or $Config{vendorprefixexp}
1797 If true, make install will be verbose
1801 Your version number for distributing the package. This defaults to
1806 Instead of specifying the VERSION in the Makefile.PL you can let
1807 MakeMaker parse a file to determine the version number. The parsing
1808 routine requires that the file named by VERSION_FROM contains one
1809 single line to compute the version number. The first line in the file
1810 that contains the regular expression
1812 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
1814 will be evaluated with eval() and the value of the named variable
1815 B<after> the eval() will be assigned to the VERSION attribute of the
1816 MakeMaker object. The following lines will be parsed o.k.:
1820 ( $VERSION ) = '$Revision: 1.51 $ ' =~ /\$Revision:\s+([^\s]+)/;
1821 $FOO::VERSION = '1.10';
1822 *FOO::VERSION = \'1.11';
1823 our $VERSION = 1.2.3; # new for perl5.6.0
1825 but these will fail:
1827 my $VERSION = '1.01';
1828 local $VERSION = '1.02';
1829 local $FOO::VERSION = '1.30';
1831 (Putting C<my> or C<local> on the preceding line will work o.k.)
1833 The file named in VERSION_FROM is not added as a dependency to
1834 Makefile. This is not really correct, but it would be a major pain
1835 during development to have to rewrite the Makefile for any smallish
1836 change in that file. If you want to make sure that the Makefile
1837 contains the correct VERSION macro after any change of the file, you
1838 would have to do something like
1840 depend => { Makefile => '$(VERSION_FROM)' }
1842 See attribute C<depend> below.
1846 Hashref of .xs files. MakeMaker will default this. e.g.
1848 {'name_of_file.xs' => 'name_of_file.c'}
1850 The .c files will automatically be included in the list of files
1851 deleted by a make clean.
1855 String of options to pass to xsubpp. This might include C<-C++> or
1856 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
1861 May be set to an empty string, which is identical to C<-prototypes>, or
1862 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
1863 defaults to the empty string.
1867 Your version number for the .xs file of this package. This defaults
1868 to the value of the VERSION attribute.
1872 =head2 Additional lowercase attributes
1874 can be used to pass parameters to the methods which implement that
1875 part of the Makefile.
1881 {FILES => "*.xyz foo"}
1885 {ANY_TARGET => ANY_DEPENDECY, ...}
1887 (ANY_TARGET must not be given a double-colon rule by MakeMaker.)
1891 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
1892 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
1893 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
1895 If you specify COMPRESS, then SUFFIX should also be altered, as it is
1896 needed to tell make the target file of the compression. Setting
1897 DIST_CP to ln can be useful, if you need to preserve the timestamps on
1898 your files. DIST_CP can take the values 'cp', which copies the file,
1899 'ln', which links the file, and 'best' which copies symbolic links and
1900 links the rest. Default is 'best'.
1904 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
1908 {LINKTYPE => 'static', 'dynamic' or ''}
1910 NB: Extensions that have nothing but *.pm files had to say
1914 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1915 can be deleted safely. MakeMaker recognizes when there's nothing to
1920 {ANY_MACRO => ANY_VALUE, ...}
1924 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
1930 =item tool_autosplit
1936 =head2 Overriding MakeMaker Methods
1938 If you cannot achieve the desired Makefile behaviour by specifying
1939 attributes you may define private subroutines in the Makefile.PL.
1940 Each subroutine returns the text it wishes to have written to
1941 the Makefile. To override a section of the Makefile you can
1944 sub MY::c_o { "new literal text" }
1946 or you can edit the default by saying something like:
1948 package MY; # so that "SUPER" works right
1950 my $inherited = shift->SUPER::c_o(@_);
1951 $inherited =~ s/old text/new text/;
1955 If you are running experiments with embedding perl as a library into
1956 other applications, you might find MakeMaker is not sufficient. You'd
1957 better have a look at ExtUtils::Embed which is a collection of utilities
1960 If you still need a different solution, try to develop another
1961 subroutine that fits your needs and submit the diffs to
1962 F<makemaker@perl.org>
1964 For a complete description of all MakeMaker methods see
1965 L<ExtUtils::MM_Unix>.
1967 Here is a simple example of how to add a new target to the generated
1971 return <<'MAKE_FRAG';
1972 $(MYEXTLIB): sdbm/Makefile
1973 cd sdbm && $(MAKE) all
1979 =head2 Hintsfile support
1981 MakeMaker.pm uses the architecture specific information from
1982 Config.pm. In addition it evaluates architecture specific hints files
1983 in a C<hints/> directory. The hints files are expected to be named
1984 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
1985 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
1986 MakeMaker within the WriteMakefile() subroutine, and can be used to
1987 execute commands as well as to include special variables. The rules
1988 which hintsfile is chosen are the same as in Configure.
1990 The hintsfile is eval()ed immediately after the arguments given to
1991 WriteMakefile are stuffed into a hash reference $self but before this
1992 reference becomes blessed. So if you want to do the equivalent to
1993 override or create an attribute you would say something like
1995 $self->{LIBS} = ['-ldbm -lucb -lc'];
1997 =head2 Distribution Support
1999 For authors of extensions MakeMaker provides several Makefile
2000 targets. Most of the support comes from the ExtUtils::Manifest module,
2001 where additional documentation can be found.
2005 =item make distcheck
2007 reports which files are below the build directory but not in the
2008 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
2011 =item make skipcheck
2013 reports which files are skipped due to the entries in the
2014 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
2017 =item make distclean
2019 does a realclean first and then the distcheck. Note that this is not
2020 needed to build a new distribution as long as you are sure that the
2021 MANIFEST file is ok.
2025 rewrites the MANIFEST file, adding all remaining files found (See
2026 ExtUtils::Manifest::mkmanifest() for details)
2030 Copies all the files that are in the MANIFEST file to a newly created
2031 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
2032 exists, it will be removed first.
2036 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
2037 a make test in that directory.
2041 First does a distdir. Then a command $(PREOP) which defaults to a null
2042 command, followed by $(TOUNIX), which defaults to a null command under
2043 UNIX, and will convert files in distribution directory to UNIX format
2044 otherwise. Next it runs C<tar> on that directory into a tarfile and
2045 deletes the directory. Finishes with a command $(POSTOP) which
2046 defaults to a null command.
2050 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
2052 =item make uutardist
2054 Runs a tardist first and uuencodes the tarfile.
2058 First does a distdir. Then a command $(PREOP) which defaults to a null
2059 command. Next it runs C<shar> on that directory into a sharfile and
2060 deletes the intermediate directory again. Finishes with a command
2061 $(POSTOP) which defaults to a null command. Note: For shdist to work
2062 properly a C<shar> program that can handle directories is mandatory.
2066 First does a distdir. Then a command $(PREOP) which defaults to a null
2067 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
2068 zipfile. Then deletes that directory. Finishes with a command
2069 $(POSTOP) which defaults to a null command.
2073 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
2077 Customization of the dist targets can be done by specifying a hash
2078 reference to the dist attribute of the WriteMakefile call. The
2079 following parameters are recognized:
2082 COMPRESS ('gzip --best')
2085 TO_UNIX (depends on the system)
2086 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
2096 WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" })
2098 =head2 Disabling an extension
2100 If some events detected in F<Makefile.PL> imply that there is no way
2101 to create the Module, but this is a normal state of things, then you
2102 can create a F<Makefile> which does nothing, but succeeds on all the
2103 "usual" build targets. To do so, use
2105 ExtUtils::MakeMaker::WriteEmptyMakefile();
2107 instead of WriteMakefile().
2109 This may be useful if other modules expect this module to be I<built>
2110 OK, as opposed to I<work> OK (say, this system-dependent module builds
2111 in a subdirectory of some other distribution, or is listed as a
2112 dependency in a CPAN::Bundle, but the functionality is supported by
2113 different means on the current architecture).
2121 Command line options used by C<MakeMaker-E<gt>new()>, and thus by
2122 C<WriteMakefile()>. The string is split on whitespace, and the result
2123 is processed before any actual command line arguments are processed.
2125 =item PERL_MM_USE_DEFAULT
2127 If set to a true value then MakeMaker's prompt function will
2128 always return the default without waiting for user input.
2134 ExtUtils::MM_Unix, ExtUtils::Manifest ExtUtils::Install,
2139 Andy Dougherty <F<doughera@lafayette.edu>>, Andreas KE<ouml>nig
2140 <F<andreas.koenig@mind.de>>, Tim Bunce <F<timb@cpan.org>>. VMS
2141 support by Charles Bailey <F<bailey@newman.upenn.edu>>. OS/2 support
2142 by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>.
2144 Currently maintained by Michael G Schwern <F<schwern@pobox.com>>
2146 Send patches and ideas to <F<makemaker@perl.org>>.
2148 Send bug reports via http://rt.cpan.org/. Please send your
2149 generated Makefile along with your report.
2151 For more up-to-date information, see http://www.makemaker.org.