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.61 $, 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;
50 my $mm = MM->new(\%att);
57 # Basic signatures of the attributes WriteMakefile takes. Each is the
58 # reference type. Empty value indicate it takes a non-reference
65 BINARY_LOCATION => '',
75 EXCLUDE_EXT => 'array',
80 FULLPERLRUNINST => '',
85 INCLUDE_EXT => 'array',
93 INSTALLSITEARCH => '',
96 INSTALLSITEMAN1DIR => '',
97 INSTALLSITEMAN3DIR => '',
98 INSTALLVENDORARCH => '',
99 INSTALLVENDORBIN => '',
100 INSTALLVENDORLIB => '',
101 INSTALLVENDORMAN1DIR => '',
102 INSTALLVENDORMAN3DIR => '',
109 _KEEP_AFTER_FLUSH => '',
113 LIBS => ['array',''],
133 PERL_MALLOC_OK => '',
141 PMLIBDIRS => 'array',
144 PPM_INSTALL_EXEC => '',
145 PPM_INSTALL_SCRIPT => '',
166 dynamic_lib=> 'hash',
171 tool_autosplit => 'hash',
184 while( my($key, $val) = each %$att ) {
185 my $sig = $Att_Sigs{$key};
186 unless( defined $sig ) {
187 warn "WARNING: $key is not a known parameter.\n";
191 my @sigs = ref $sig ? @$sig : $sig;
192 my $given = lc ref $val;
193 unless( grep $given eq $_, @sigs ) {
194 my $takes = join " or ", map { $_ ne '' ? "$_ reference"
197 my $has = $given ne '' ? "$given reference"
199 warn "WARNING: $key takes a $takes not a $has.\n".
200 " Please inform the author.\n";
201 $att->{$key} = $Default_Att{$sigs[0]};
208 $ISA_TTY = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ; # Pipe?
209 Carp::confess("prompt function called without an argument")
210 unless defined $mess;
211 my $dispdef = defined $def ? "[$def] " : " ";
212 $def = defined $def ? $def : "";
216 print "$mess $dispdef";
217 if ($ISA_TTY && !$ENV{PERL_MM_USE_DEFAULT}) {
222 else { # user hit ctrl-D
229 return (!defined $ans || $ans eq '') ? $def : $ans;
232 sub eval_in_subdirs {
234 use Cwd qw(cwd abs_path);
235 my $pwd = cwd() || die "Can't figure out your cwd!";
237 local @INC = map eval {abs_path($_) if -e} || $_, @INC;
238 push @INC, '.'; # '.' has to always be at the end of @INC
240 foreach my $dir (@{$self->{DIR}}){
241 my($abs) = $self->catdir($pwd,$dir);
242 $self->eval_in_x($abs);
249 chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
256 # if ($@ =~ /prerequisites/) {
257 # die "MakeMaker WARNING: $@";
259 # warn "WARNING from evaluation of $dir/Makefile.PL: $@";
261 die "ERROR from evaluation of $dir/Makefile.PL: $@";
268 # package name for the classes into which the first object will be blessed
269 $PACKNAME = "PACK000";
271 my @attrib_help = qw/
273 AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION
274 C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
275 EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE
276 FULLPERL FULLPERLRUN FULLPERLRUNINST
278 INST_ARCHLIB INST_SCRIPT INST_BIN INST_LIB INST_MAN1DIR INST_MAN3DIR
280 PREFIX SITEPREFIX VENDORPREFIX
281 INSTALLPRIVLIB INSTALLSITELIB INSTALLVENDORLIB
282 INSTALLARCHLIB INSTALLSITEARCH INSTALLVENDORARCH
283 INSTALLBIN INSTALLSITEBIN INSTALLVENDORBIN
284 INSTALLMAN1DIR INSTALLMAN3DIR
285 INSTALLSITEMAN1DIR INSTALLSITEMAN3DIR
286 INSTALLVENDORMAN1DIR INSTALLVENDORMAN3DIR
288 PERL_LIB PERL_ARCHLIB
289 SITELIBEXP SITEARCHEXP
290 INC INCLUDE_EXT LDFROM LIB LIBPERL_A LIBS
291 LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB
293 NAME NEEDS_LINKING NOECHO NORECURS NO_VC OBJECT OPTIMIZE PERL PERLMAINCC
294 PERLRUN PERLRUNINST PERL_CORE
295 PERL_SRC PERM_RW PERM_RWX
296 PL_FILES PM PM_FILTER PMLIBDIRS POLLUTE PPM_INSTALL_EXEC
297 PPM_INSTALL_SCRIPT PREREQ_FATAL PREREQ_PM PREREQ_PRINT PRINT_PREREQ
298 SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
299 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
301 MACPERL_SRC MACPERL_LIB MACLIBS_68K MACLIBS_PPC MACLIBS_SC MACLIBS_MRC
302 MACLIBS_ALL_68K MACLIBS_ALL_PPC MACLIBS_SHARED
305 # IMPORTS is used under OS/2 and Win32
307 # @Overridable is close to @MM_Sections but not identical. The
308 # order is important. Many subroutines declare macros. These
309 # depend on each other. Let's try to collect the macros up front,
310 # then pasthru, then the rules.
312 # MM_Sections are the sections we have to call explicitly
313 # in Overridable we have subroutines that are used indirectly
319 post_initialize const_config constants tool_autosplit tool_xsubpp
320 tools_other dist macro depend cflags const_loadlibs const_cccmd
325 c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs
326 dynamic_lib static static_lib manifypods processPL
328 clean realclean dist_basics dist_core dist_dir dist_test dist_ci
329 install force perldepend makefile staticmake test ppd
331 ); # loses section ordering
333 @Overridable = @MM_Sections;
334 push @Overridable, qw[
336 dir_target libscan makeaperl needs_linking perm_rw perm_rwx
337 subdir_x test_via_harness test_via_script init_PERL
340 push @MM_Sections, qw[
342 pm_to_blib selfdocument
346 # Postamble needs to be the last that was always the case
347 push @MM_Sections, "postamble";
348 push @Overridable, "postamble";
350 # All sections are valid keys.
351 @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
353 # we will use all these variables in the Makefile
356 ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc
357 lib_ext obj_ext osname osvers ranlib sitelibexp sitearchexp so
361 foreach my $item (@attrib_help){
362 $Recognized_Att_Keys{$item} = 1;
364 foreach my $item (@Get_from_Config) {
365 $Recognized_Att_Keys{uc $item} = $Config{$item};
366 print "Attribute '\U$item\E' => '$Config{$item}'\n"
371 # When we eval a Makefile.PL in a subdirectory, that one will ask
372 # us (the parent) for the values and will prepend "..", so that
373 # all files to be installed end up below OUR ./blib
375 @Prepend_parent = qw(
376 INST_BIN INST_LIB INST_ARCHLIB INST_SCRIPT
377 MAP_TARGET INST_MAN1DIR INST_MAN3DIR PERL_SRC
382 NEEDS_LINKING HAS_LINK_CODE
384 @Keep_after_flush{@keep} = (1) x @keep;
390 The extension you are trying to build apparently is rather old and
391 most probably outdated. We detect that from the fact, that a
392 subroutine "writeMakefile" is called, and this subroutine is not
393 supported anymore since about October 1994.
395 Please contact the author or look into CPAN (details about CPAN can be
396 found in the FAQ and at http:/www.perl.com) for a more recent version
397 of the extension. If you're really desperate, you can try to change
398 the subroutine name from writeMakefile to WriteMakefile and rerun
399 'perl Makefile.PL', but you're most probably left alone, when you do
408 my($class,$self) = @_;
411 if ("@ARGV" =~ /\bPREREQ_PRINT\b/) {
412 require Data::Dumper;
413 print Data::Dumper->Dump([$self->{PREREQ_PM}], [qw(PREREQ_PM)]);
416 # PRINT_PREREQ is RedHatism.
417 if ("@ARGV" =~ /\bPRINT_PREREQ\b/) {
418 print join(" ", map { "perl($_)>=$self->{PREREQ_PM}->{$_} " } sort keys %{$self->{PREREQ_PM}}), "\n";
422 print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
423 if (-f "MANIFEST" && ! -f "Makefile"){
427 $self = {} unless (defined $self);
431 my %configure_att; # record &{$self->{CONFIGURE}} attributes
432 my(%initial_att) = %$self; # record initial attributes
434 my(%unsatisfied) = ();
435 foreach my $prereq (sort keys %{$self->{PREREQ_PM}}) {
436 eval "require $prereq";
438 my $pr_version = $prereq->VERSION || 0;
441 warn sprintf "Warning: prerequisite %s %s not found.\n",
442 $prereq, $self->{PREREQ_PM}{$prereq}
443 unless $self->{PREREQ_FATAL};
444 $unsatisfied{$prereq} = 'not installed';
445 } elsif ($pr_version < $self->{PREREQ_PM}->{$prereq} ){
446 warn sprintf "Warning: prerequisite %s %s not found. We have %s.\n",
447 $prereq, $self->{PREREQ_PM}{$prereq},
448 ($pr_version || 'unknown version')
449 unless $self->{PREREQ_FATAL};
450 $unsatisfied{$prereq} = $self->{PREREQ_PM}->{$prereq} ?
451 $self->{PREREQ_PM}->{$prereq} : 'unknown version' ;
454 if (%unsatisfied && $self->{PREREQ_FATAL}){
455 my $failedprereqs = join ', ', map {"$_ $unsatisfied{$_}"}
457 die qq{MakeMaker FATAL: prerequisites not found ($failedprereqs)\n
458 Please install these modules first and rerun 'perl Makefile.PL'.\n};
461 if (defined $self->{CONFIGURE}) {
462 if (ref $self->{CONFIGURE} eq 'CODE') {
463 %configure_att = %{&{$self->{CONFIGURE}}};
464 $self = { %$self, %configure_att };
466 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
470 # This is for old Makefiles written pre 5.00, will go away
471 if ( Carp::longmess("") =~ /runsubdirpl/s ){
472 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
475 my $newclass = ++$PACKNAME;
476 local @Parent = @Parent; # Protect against non-local exits
479 print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
480 mv_all_methods("MY",$newclass);
481 bless $self, $newclass;
483 require ExtUtils::MY;
484 @{"$newclass\:\:ISA"} = 'MM';
487 if (defined $Parent[-2]){
488 $self->{PARENT} = $Parent[-2];
490 for $key (@Prepend_parent) {
491 next unless defined $self->{PARENT}{$key};
492 $self->{$key} = $self->{PARENT}{$key};
493 unless ($^O eq 'VMS' && $key =~ /PERL$/) {
494 $self->{$key} = $self->catdir("..",$self->{$key})
495 unless $self->file_name_is_absolute($self->{$key});
497 # PERL or FULLPERL will be a command verb or even a
498 # command with an argument instead of a full file
499 # specification under VMS. So, don't turn the command
500 # into a filespec, but do add a level to the path of
501 # the argument if not already absolute.
502 my @cmd = split /\s+/, $self->{$key};
503 $cmd[1] = $self->catfile('[-]',$cmd[1])
504 unless (@cmd < 2) || $self->file_name_is_absolute($cmd[1]);
505 $self->{$key} = join(' ', @cmd);
508 if ($self->{PARENT}) {
509 $self->{PARENT}->{CHILDREN}->{$newclass} = $self;
510 foreach my $opt (qw(POLLUTE PERL_CORE)) {
511 if (exists $self->{PARENT}->{$opt}
512 and not exists $self->{$opt})
514 # inherit, but only if already unspecified
515 $self->{$opt} = $self->{PARENT}->{$opt};
519 my @fm = grep /^FIRST_MAKEFILE=/, @ARGV;
520 parse_args($self,@fm) if @fm;
522 parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV);
525 $self->{NAME} ||= $self->guess_name;
527 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
531 if (! $self->{PERL_SRC} ) {
532 require VMS::Filespec if $Is_VMS;
533 my($pthinks) = $self->canonpath($INC{'Config.pm'});
534 my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
535 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
536 if ($pthinks ne $cthinks &&
537 !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
538 print "Have $pthinks expected $cthinks\n";
540 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
543 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
545 print STDOUT <<END unless $self->{UNINSTALLED_PERL};
546 Your perl and your Config.pm seem to have different ideas about the
547 architecture they are running on.
548 Perl thinks: [$pthinks]
549 Config says: [$Config{archname}]
550 This may or may not cause problems. Please check your installation of perl
551 if you have problems building this extension.
556 $self->init_dirscan();
557 $self->init_others();
559 my($argv) = neatvalue(\@ARGV);
563 push @{$self->{RESULT}}, <<END;
564 # This Makefile is for the $self->{NAME} extension to perl.
566 # It was generated automatically by MakeMaker version
567 # $VERSION (Revision: $Revision) from the contents of
568 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
570 # ANY CHANGES MADE HERE WILL BE LOST!
572 # MakeMaker ARGV: $argv
574 # MakeMaker Parameters:
577 foreach my $key (sort keys %initial_att){
578 my($v) = neatvalue($initial_att{$key});
579 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
581 push @{$self->{RESULT}}, "# $key => $v";
583 undef %initial_att; # free memory
585 if (defined $self->{CONFIGURE}) {
586 push @{$self->{RESULT}}, <<END;
588 # MakeMaker 'CONFIGURE' Parameters:
590 if (scalar(keys %configure_att) > 0) {
591 foreach my $key (sort keys %configure_att){
592 my($v) = neatvalue($configure_att{$key});
593 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
595 push @{$self->{RESULT}}, "# $key => $v";
600 push @{$self->{RESULT}}, "# no values returned";
602 undef %configure_att; # free memory
605 # turn the SKIP array into a SKIPHASH hash
607 for $skip (@{$self->{SKIP} || []}) {
608 $self->{SKIPHASH}{$skip} = 1;
610 delete $self->{SKIP}; # free memory
612 if ($self->{PARENT}) {
613 for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
614 $self->{SKIPHASH}{$_} = 1;
618 # We run all the subdirectories now. They don't have much to query
619 # from the parent, but the parent has to query them: if they need linking!
620 unless ($self->{NORECURS}) {
621 $self->eval_in_subdirs if @{$self->{DIR}};
624 foreach my $section ( @MM_Sections ){
625 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
626 my($skipit) = $self->skipcheck($section);
628 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
630 my(%a) = %{$self->{$section} || {}};
631 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
632 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
633 push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
637 push @{$self->{RESULT}}, "\n# End.";
642 sub WriteEmptyMakefile {
643 Carp::croak "WriteEmptyMakefile: Need even number of args" if @_ % 2;
646 my $self = MM->new(\%att);
647 if (-f "$self->{MAKEFILE}.old") {
648 chmod 0666, "$self->{MAKEFILE}.old";
649 unlink "$self->{MAKEFILE}.old" or warn "unlink $self->{MAKEFILE}.old: $!";
651 rename $self->{MAKEFILE}, "$self->{MAKEFILE}.old"
652 or warn "rename $self->{MAKEFILE} $self->{MAKEFILE}.old: $!"
653 if -f $self->{MAKEFILE};
654 open MF, '>'.$self->{MAKEFILE} or die "open $self->{MAKEFILE} for write: $!";
667 close MF or die "close $self->{MAKEFILE} for write: $!";
671 print STDOUT "Checking if your kit is complete...\n";
672 require ExtUtils::Manifest;
674 $ExtUtils::Manifest::Quiet = $ExtUtils::Manifest::Quiet = 1;
675 my(@missed) = ExtUtils::Manifest::manicheck();
677 print STDOUT "Warning: the following files are missing in your kit:\n";
678 print "\t", join "\n\t", @missed;
680 print STDOUT "Please inform the author.\n";
682 print STDOUT "Looks good\n";
687 my($self, @args) = @_;
689 unless (m/(.*?)=(.*)/) {
690 help(),exit 1 if m/^help$/;
691 ++$Verbose if m/^verb/;
694 my($name, $value) = ($1, $2);
695 if ($value =~ m/^~(\w+)?/) { # tilde with optional username
696 $value =~ s [^~(\w*)]
698 ((getpwnam($1))[7] || "~$1") :
702 $self->{uc($name)} = $value;
705 # catch old-style 'potential_libs' and inform user how to 'upgrade'
706 if (defined $self->{potential_libs}){
707 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
708 if ($self->{potential_libs}){
709 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
711 print STDOUT "$msg deleted.\n";
713 $self->{LIBS} = [$self->{potential_libs}];
714 delete $self->{potential_libs};
716 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
717 if (defined $self->{ARMAYBE}){
718 my($armaybe) = $self->{ARMAYBE};
719 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
720 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
721 my(%dl) = %{$self->{dynamic_lib} || {}};
722 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
723 delete $self->{ARMAYBE};
725 if (defined $self->{LDTARGET}){
726 print STDOUT "LDTARGET should be changed to LDFROM\n";
727 $self->{LDFROM} = $self->{LDTARGET};
728 delete $self->{LDTARGET};
730 # Turn a DIR argument on the command line into an array
731 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
732 # So they can choose from the command line, which extensions they want
733 # the grep enables them to have some colons too much in case they
734 # have to build a list with the shell
735 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
737 # Turn a INCLUDE_EXT argument on the command line into an array
738 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
739 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
741 # Turn a EXCLUDE_EXT argument on the command line into an array
742 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
743 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
746 foreach my $mmkey (sort keys %$self){
747 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
748 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
749 unless exists $Recognized_Att_Keys{$mmkey};
756 # We allow extension-specific hints files.
758 return unless -d "hints";
760 # First we look for the best hintsfile we have
761 my($hint)="${^O}_$Config{osvers}";
766 # Also try without trailing minor version numbers.
768 last if -f "hints/$hint.pl"; # found
770 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
772 my $hint_file = "hints/$hint.pl";
774 return unless -f $hint_file; # really there
776 _run_hintfile($self, $hint_file);
781 local($self) = shift; # make $self available to the hint file.
782 my($hint_file) = shift;
785 print STDERR "Processing hints file $hint_file\n";
786 my $ret = do "./$hint_file";
787 unless( defined $ret ) {
788 print STDERR $@ if $@;
795 my($symtab) = \%{"${from}::"};
797 # Here you see the *current* list of methods that are overridable
798 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
799 # still trying to reduce the list to some reasonable minimum --
800 # because I want to make it easier for the user. A.K.
802 local $SIG{__WARN__} = sub {
803 # can't use 'no warnings redefined', 5.6 only
804 warn @_ unless $_[0] =~ /^Subroutine .* redefined/
806 foreach my $method (@Overridable) {
808 # We cannot say "next" here. Nick might call MY->makeaperl
809 # which isn't defined right now
811 # Above statement was written at 4.23 time when Tk-b8 was
812 # around. As Tk-b9 only builds with 5.002something and MM 5 is
813 # standard, we try to enable the next line again. It was
814 # commented out until MM 5.23
816 next unless defined &{"${from}::$method"};
818 *{"${to}::$method"} = \&{"${from}::$method"};
820 # delete would do, if we were sure, nobody ever called
821 # MY->makeaperl directly
823 # delete $symtab->{$method};
825 # If we delete a method, then it will be undefined and cannot
826 # be called. But as long as we have Makefile.PLs that rely on
827 # %MY:: being intact, we have to fill the hole with an
830 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
833 # We have to clean out %INC also, because the current directory is
834 # changed frequently and Graham Barr prefers to get his version
835 # out of a History.pl file which is "required" so woudn't get
836 # loaded again in another extension requiring a History.pl
838 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
839 # to core dump in the middle of a require statement. The required
840 # file was Tk/MMutil.pm. The consequence is, we have to be
841 # extremely careful when we try to give perl a reason to reload a
842 # library with same name. The workaround prefers to drop nothing
843 # from %INC and teach the writers not to use such libraries.
846 # foreach $inc (keys %INC) {
847 # #warn "***$inc*** deleted";
855 if ($section eq 'dynamic') {
856 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
857 "in skipped section 'dynamic_bs'\n"
858 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
859 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
860 "in skipped section 'dynamic_lib'\n"
861 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
863 if ($section eq 'dynamic_lib') {
864 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
865 "targets in skipped section 'dynamic_bs'\n"
866 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
868 if ($section eq 'static') {
869 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
870 "in skipped section 'static_lib'\n"
871 if $self->{SKIPHASH}{static_lib} && $Verbose;
873 return 'skipped' if $self->{SKIPHASH}{$section};
881 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
883 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
884 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
886 for $chunk (@{$self->{RESULT}}) {
891 my($finalname) = $self->{MAKEFILE};
892 rename("MakeMaker.tmp", $finalname);
893 chmod 0644, $finalname unless $Is_VMS;
895 if ($self->{PARENT} && !$self->{_KEEP_AFTER_FLUSH}) {
896 foreach (keys %$self) { # safe memory
897 delete $self->{$_} unless $Keep_after_flush{$_};
901 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
904 # The following mkbootstrap() is only for installations that are calling
905 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
906 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
909 !!! Your Makefile has been built such a long time ago, !!!
910 !!! that is unlikely to work with current MakeMaker. !!!
911 !!! Please rebuild your Makefile !!!
915 # Ditto for mksymlists() as of MakeMaker 5.17
918 !!! Your Makefile has been built such a long time ago, !!!
919 !!! that is unlikely to work with current MakeMaker. !!!
920 !!! Please rebuild your Makefile !!!
926 return "undef" unless defined $v;
928 return "q[$v]" unless $t;
932 foreach my $elem (@$v) {
933 push @neat, "q[$elem]";
935 push @m, join ", ", @neat;
939 return "$v" unless $t eq 'HASH';
941 while (($key,$val) = each %$v){
942 last unless defined $key; # cautious programming in case (undef,undef) is true
943 push(@m,"$key=>".neatvalue($val)) ;
945 return "{ ".join(', ',@m)." }";
952 push @m, "\n# Full list of MakeMaker attribute values:";
953 foreach my $key (sort keys %$self){
954 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
955 my($v) = neatvalue($self->{$key});
956 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
958 push @m, "# $key => $v";
970 ExtUtils::MakeMaker - create an extension Makefile
974 use ExtUtils::MakeMaker;
976 WriteMakefile( ATTRIBUTE => VALUE [, ...] );
980 This utility is designed to write a Makefile for an extension module
981 from a Makefile.PL. It is based on the Makefile.SH model provided by
982 Andy Dougherty and the perl5-porters.
984 It splits the task of generating the Makefile into several subroutines
985 that can be individually overridden. Each subroutine returns the text
986 it wishes to have written to the Makefile.
988 MakeMaker is object oriented. Each directory below the current
989 directory that contains a Makefile.PL is treated as a separate
990 object. This makes it possible to write an unlimited number of
991 Makefiles with a single invocation of WriteMakefile().
993 =head2 How To Write A Makefile.PL
995 The short answer is: Don't.
997 Always begin with h2xs.
998 Always begin with h2xs!
999 ALWAYS BEGIN WITH H2XS!
1001 even if you're not building around a header file, and even if you
1002 don't have an XS component.
1004 Run h2xs(1) before you start thinking about writing a module. For so
1005 called pm-only modules that consist of C<*.pm> files only, h2xs has
1006 the C<-X> switch. This will generate dummy files of all kinds that are
1007 useful for the module developer.
1009 The medium answer is:
1011 use ExtUtils::MakeMaker;
1012 WriteMakefile( NAME => "Foo::Bar" );
1014 The long answer is the rest of the manpage :-)
1016 =head2 Default Makefile Behaviour
1018 The generated Makefile enables the user of the extension to invoke
1020 perl Makefile.PL # optionally "perl Makefile.PL verbose"
1022 make test # optionally set TEST_VERBOSE=1
1023 make install # See below
1025 The Makefile to be produced may be altered by adding arguments of the
1026 form C<KEY=VALUE>. E.g.
1028 perl Makefile.PL PREFIX=/tmp/myperl5
1030 Other interesting targets in the generated Makefile are
1032 make config # to check if the Makefile is up-to-date
1033 make clean # delete local temp files (Makefile gets renamed)
1034 make realclean # delete derived files (including ./blib)
1035 make ci # check in all the files in the MANIFEST file
1036 make dist # see below the Distribution Support section
1040 MakeMaker checks for the existence of a file named F<test.pl> in the
1041 current directory and if it exists it execute the script with the
1042 proper set of perl C<-I> options.
1044 MakeMaker also checks for any files matching glob("t/*.t"). It will
1045 execute all matching files in alphabetical order via the
1046 L<Test::Harness> module with the C<-I> switches set correctly.
1048 If you'd like to see the raw output of your tests, set the
1049 C<TEST_VERBOSE> variable to true.
1051 make test TEST_VERBOSE=1
1055 A useful variation of the above is the target C<testdb>. It runs the
1056 test under the Perl debugger (see L<perldebug>). If the file
1057 F<test.pl> exists in the current directory, it is used for the test.
1059 If you want to debug some other testfile, set the C<TEST_FILE> variable
1062 make testdb TEST_FILE=t/mytest.t
1064 By default the debugger is called using C<-d> option to perl. If you
1065 want to specify some other option, set the C<TESTDB_SW> variable:
1067 make testdb TESTDB_SW=-Dx
1071 make alone puts all relevant files into directories that are named by
1072 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_MAN1DIR and
1073 INST_MAN3DIR. All these default to something below ./blib if you are
1074 I<not> building below the perl source directory. If you I<are>
1075 building below the perl source, INST_LIB and INST_ARCHLIB default to
1076 ../../lib, and INST_SCRIPT is not defined.
1078 The I<install> target of the generated Makefile copies the files found
1079 below each of the INST_* directories to their INSTALL*
1080 counterparts. Which counterparts are chosen depends on the setting of
1081 INSTALLDIRS according to the following table:
1086 PREFIX SITEPREFIX VENDORPREFIX
1087 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH INSTALLVENDORARCH
1088 INST_LIB INSTALLPRIVLIB INSTALLSITELIB INSTALLVENDORLIB
1089 INST_BIN INSTALLBIN INSTALLSITEBIN INSTALLVENDORBIN
1090 INST_SCRIPT INSTALLSCRIPT INSTALLSCRIPT INSTALLSCRIPT
1091 INST_MAN1DIR INSTALLMAN1DIR INSTALLSITEMAN1DIR INSTALLVENDORMAN1DIR
1092 INST_MAN3DIR INSTALLMAN3DIR INSTALLSITEMAN3DIR INSTALLVENDORMAN3DIR
1094 The INSTALL... macros in turn default to their %Config
1095 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
1097 You can check the values of these variables on your system with
1101 And to check the sequence in which the library directories are
1102 searched by perl, run
1104 perl -le 'print join $/, @INC'
1107 =head2 PREFIX and LIB attribute
1109 PREFIX and LIB can be used to set several INSTALL* attributes in one
1110 go. The quickest way to install a module in a non-standard place might
1113 perl Makefile.PL PREFIX=~
1115 This will install all files in the module under your home directory,
1116 with man pages and libraries going into an appropriate place (usually
1119 Another way to specify many INSTALL directories with a single
1122 perl Makefile.PL LIB=~/lib
1124 This will install the module's architecture-independent files into
1125 ~/lib, the architecture-dependent files into ~/lib/$archname.
1127 Note, that in both cases the tilde expansion is done by MakeMaker, not
1128 by perl by default, nor by make.
1130 Conflicts between parameters LIB, PREFIX and the various INSTALL*
1131 arguments are resolved so that:
1137 setting LIB overrides any setting of INSTALLPRIVLIB, INSTALLARCHLIB,
1138 INSTALLSITELIB, INSTALLSITEARCH (and they are not affected by PREFIX);
1142 without LIB, setting PREFIX replaces the initial C<$Config{prefix}>
1143 part of those INSTALL* arguments, even if the latter are explicitly
1144 set (but are set to still start with C<$Config{prefix}>).
1148 If the user has superuser privileges, and is not working on AFS or
1149 relatives, then the defaults for INSTALLPRIVLIB, INSTALLARCHLIB,
1150 INSTALLSCRIPT, etc. will be appropriate, and this incantation will be
1158 make install per default writes some documentation of what has been
1159 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1160 can be bypassed by calling make pure_install.
1164 will have to specify the installation directories as these most
1165 probably have changed since perl itself has been installed. They will
1166 have to do this by calling
1168 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1169 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1172 Be careful to repeat this procedure every time you recompile an
1173 extension, unless you are sure the AFS installation directories are
1176 =head2 Static Linking of a new Perl Binary
1178 An extension that is built with the above steps is ready to use on
1179 systems supporting dynamic loading. On systems that do not support
1180 dynamic loading, any newly created extension has to be linked together
1181 with the available resources. MakeMaker supports the linking process
1182 by creating appropriate targets in the Makefile whenever an extension
1183 is built. You can invoke the corresponding section of the makefile with
1187 That produces a new perl binary in the current directory with all
1188 extensions linked in that can be found in INST_ARCHLIB, SITELIBEXP,
1189 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1190 UNIX, this is called Makefile.aperl (may be system dependent). If you
1191 want to force the creation of a new perl, it is recommended, that you
1192 delete this Makefile.aperl, so the directories are searched-through
1193 for linkable libraries again.
1195 The binary can be installed into the directory where perl normally
1196 resides on your machine with
1200 To produce a perl binary with a different name than C<perl>, either say
1202 perl Makefile.PL MAP_TARGET=myperl
1209 make myperl MAP_TARGET=myperl
1210 make inst_perl MAP_TARGET=myperl
1212 In any case you will be prompted with the correct invocation of the
1213 C<inst_perl> target that installs the new binary into INSTALLBIN.
1215 make inst_perl per default writes some documentation of what has been
1216 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1217 can be bypassed by calling make pure_inst_perl.
1219 Warning: the inst_perl: target will most probably overwrite your
1220 existing perl binary. Use with care!
1222 Sometimes you might want to build a statically linked perl although
1223 your system supports dynamic loading. In this case you may explicitly
1224 set the linktype with the invocation of the Makefile.PL or make:
1226 perl Makefile.PL LINKTYPE=static # recommended
1230 make LINKTYPE=static # works on most systems
1232 =head2 Determination of Perl Library and Installation Locations
1234 MakeMaker needs to know, or to guess, where certain things are
1235 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1236 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1237 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1239 Extensions may be built either using the contents of the perl source
1240 directory tree or from the installed perl library. The recommended way
1241 is to build extensions after you have run 'make install' on perl
1242 itself. You can do that in any directory on your hard disk that is not
1243 below the perl source tree. The support for extensions below the ext
1244 directory of the perl distribution is only good for the standard
1245 extensions that come with perl.
1247 If an extension is being built below the C<ext/> directory of the perl
1248 source then MakeMaker will set PERL_SRC automatically (e.g.,
1249 C<../..>). If PERL_SRC is defined and the extension is recognized as
1250 a standard extension, then other variables default to the following:
1253 PERL_LIB = PERL_SRC/lib
1254 PERL_ARCHLIB = PERL_SRC/lib
1256 INST_ARCHLIB = PERL_ARCHLIB
1258 If an extension is being built away from the perl source then MakeMaker
1259 will leave PERL_SRC undefined and default to using the installed copy
1260 of the perl library. The other variables default to the following:
1262 PERL_INC = $archlibexp/CORE
1263 PERL_LIB = $privlibexp
1264 PERL_ARCHLIB = $archlibexp
1265 INST_LIB = ./blib/lib
1266 INST_ARCHLIB = ./blib/arch
1268 If perl has not yet been installed then PERL_SRC can be defined on the
1269 command line as shown in the previous section.
1272 =head2 Which architecture dependent directory?
1274 If you don't want to keep the defaults for the INSTALL* macros,
1275 MakeMaker helps you to minimize the typing needed: the usual
1276 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1277 by Configure at perl compilation time. MakeMaker supports the user who
1278 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1279 then MakeMaker defaults the latter to be the same subdirectory of
1280 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1281 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1282 for INSTALLSITELIB and INSTALLSITEARCH.
1284 MakeMaker gives you much more freedom than needed to configure
1285 internal variables and get different results. It is worth to mention,
1286 that make(1) also lets you configure most of the variables that are
1287 used in the Makefile. But in the majority of situations this will not
1288 be necessary, and should only be done if the author of a package
1289 recommends it (or you know what you're doing).
1291 =head2 Using Attributes and Parameters
1293 The following attributes can be specified as arguments to WriteMakefile()
1294 or as NAME=VALUE pairs on the command line:
1300 One line description of the module. Will be included in PPD file.
1304 Name of the file that contains the package description. MakeMaker looks
1305 for a line in the POD matching /^($package\s-\s)(.*)/. This is typically
1306 the first line in the "=head1 NAME" section. $2 becomes the abstract.
1310 String containing name (and email address) of package author(s). Is used
1311 in PPD (Perl Package Description) files for PPM (Perl Package Manager).
1313 =item BINARY_LOCATION
1315 Used when creating PPD files for binary packages. It can be set to a
1316 full or relative path or URL to the binary archive for a particular
1317 architecture. For example:
1319 perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
1321 builds a PPD package that references a binary of the C<Agent> package,
1322 located in the C<x86> directory relative to the PPD itself.
1326 Ref to array of *.c file names. Initialised from a directory scan
1327 and the values portion of the XS attribute hash. This is not
1328 currently used by MakeMaker but may be handy in Makefile.PLs.
1332 String that will be included in the compiler call command line between
1333 the arguments INC and OPTIMIZE.
1337 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1338 config.sh. MakeMaker will add to CONFIG the following values anyway:
1358 CODE reference. The subroutine should return a hash reference. The
1359 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1360 be determined by some evaluation method.
1364 Something like C<"-DHAVE_UNISTD_H">
1368 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1373 Your name for distributing the package (by tar file). This defaults to
1378 Hashref of symbol names for routines to be made available as universal
1379 symbols. Each key/value pair consists of the package name and an
1380 array of routine names in that package. Used only under AIX, OS/2,
1381 VMS and Win32 at present. The routine names supplied will be expanded
1382 in the same way as XSUB names are expanded by the XS() macro.
1385 {"$(NAME)" => ["boot_$(NAME)" ] }
1389 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1390 "NetconfigPtr" => [ 'DESTROY'] }
1392 Please see the L<ExtUtils::Mksymlists> documentation for more information
1393 about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
1397 Array of symbol names for variables to be made available as universal symbols.
1398 Used only under AIX, OS/2, VMS and Win32 at present. Defaults to [].
1399 (e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
1403 Array of extension names to exclude when doing a static build. This
1404 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1405 details. (e.g. [ qw( Socket POSIX ) ] )
1407 This attribute may be most useful when specified as a string on the
1408 command line: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1412 Ref to array of executable files. The files will be copied to the
1413 INST_SCRIPT directory. Make realclean will delete them from there
1416 =item FIRST_MAKEFILE
1418 The name of the Makefile to be produced. Defaults to the contents of
1419 MAKEFILE, but can be overridden. This is used for the second Makefile
1420 that will be produced for the MAP_TARGET.
1424 Perl binary able to run this extension, load XS modules, etc...
1428 Like PERLRUN, except it uses FULLPERL.
1430 =item FULLPERLRUNINST
1432 Like PERLRUNINST, except it uses FULLPERL.
1436 This provides an alternate means to specify function names to be
1437 exported from the extension. Its value is a reference to an
1438 array of function names to be exported by the extension. These
1439 names are passed through unaltered to the linker options file.
1443 Ref to array of *.h file names. Similar to C.
1447 This attribute is used to specify names to be imported into the
1448 extension. Takes a hash ref.
1450 It is only used on OS/2 and Win32.
1454 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1458 Array of extension names to be included when doing a static build.
1459 MakeMaker will normally build with all of the installed extensions when
1460 doing a static build, and that is usually the desired behavior. If
1461 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1462 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1464 It is not necessary to mention DynaLoader or the current extension when
1465 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1466 only DynaLoader and the current extension will be included in the build.
1468 This attribute may be most useful when specified as a string on the
1469 command line: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1471 =item INSTALLARCHLIB
1473 Used by 'make install', which copies files from INST_ARCHLIB to this
1474 directory if INSTALLDIRS is set to perl.
1478 Directory to install binary files (e.g. tkperl) into if
1483 Determines which of the sets of installation directories to choose:
1484 perl, site or vendor. Defaults to site.
1486 =item INSTALLMAN1DIR
1488 =item INSTALLMAN3DIR
1490 These directories get the man pages at 'make install' time if
1491 INSTALLDIRS=perl. Defaults to $Config{installman*dir}.
1493 If set to 'none', no man pages will be installed.
1495 =item INSTALLPRIVLIB
1497 Used by 'make install', which copies files from INST_LIB to this
1498 directory if INSTALLDIRS is set to perl.
1500 Defaults to $Config{installprivlib}.
1504 Used by 'make install' which copies files from INST_SCRIPT to this
1507 =item INSTALLSITEARCH
1509 Used by 'make install', which copies files from INST_ARCHLIB to this
1510 directory if INSTALLDIRS is set to site (default).
1512 =item INSTALLSITEBIN
1514 Used by 'make install', which copies files from INST_BIN to this
1515 directory if INSTALLDIRS is set to site (default).
1517 =item INSTALLSITELIB
1519 Used by 'make install', which copies files from INST_LIB to this
1520 directory if INSTALLDIRS is set to site (default).
1522 =item INSTALLSITEMAN1DIR
1524 =item INSTALLSITEMAN3DIR
1526 These directories get the man pages at 'make install' time if
1527 INSTALLDIRS=site (default). Defaults to
1528 $(SITEPREFIX)/man/man$(MAN*EXT).
1530 If set to 'none', no man pages will be installed.
1532 =item INSTALLVENDORARCH
1534 Used by 'make install', which copies files from INST_ARCHLIB to this
1535 directory if INSTALLDIRS is set to vendor.
1537 =item INSTALLVENDORBIN
1539 Used by 'make install', which copies files from INST_BIN to this
1540 directory if INSTALLDIRS is set to vendor.
1542 =item INSTALLVENDORLIB
1544 Used by 'make install', which copies files from INST_LIB to this
1545 directory if INSTALLDIRS is set to vendor.
1547 =item INSTALLVENDORMAN1DIR
1549 =item INSTALLVENDORMAN3DIR
1551 These directories get the man pages at 'make install' time if
1552 INSTALLDIRS=vendor. Defaults to $(VENDORPREFIX)/man/man$(MAN*EXT).
1554 If set to 'none', no man pages will be installed.
1558 Same as INST_LIB for architecture dependent files.
1562 Directory to put real binary files during 'make'. These will be copied
1563 to INSTALLBIN during 'make install'
1567 Directory where we put library files of this extension while building
1572 Directory to hold the man pages at 'make' time
1576 Directory to hold the man pages at 'make' time
1580 Directory, where executable files should be installed during
1581 'make'. Defaults to "./blib/script", just to have a dummy location during
1582 testing. make install will copy the files in INST_SCRIPT to
1587 Defaults to "$(OBJECT)" and is used in the ld command to specify
1588 what files to link/load from (also see dynamic_lib below for how to
1593 LIB should only be set at C<perl Makefile.PL> time but is allowed as a
1594 MakeMaker argument. It has the effect of setting both INSTALLPRIVLIB
1595 and INSTALLSITELIB to that value regardless any explicit setting of
1596 those arguments (or of PREFIX). INSTALLARCHLIB and INSTALLSITEARCH
1597 are set to the corresponding architecture subdirectory.
1601 The filename of the perllibrary that will be used together with this
1602 extension. Defaults to libperl.a.
1606 An anonymous array of alternative library
1607 specifications to be searched for (in order) until
1608 at least one library is found. E.g.
1610 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1612 Mind, that any element of the array
1613 contains a complete set of arguments for the ld
1614 command. So do not specify
1616 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1618 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1619 you specify a scalar as in
1621 'LIBS' => "-ltcl -ltk -lX11"
1623 MakeMaker will turn it into an array with one element.
1627 'static' or 'dynamic' (default unless usedl=undef in
1628 config.sh). Should only be used to force static linking (also see
1633 Boolean which tells MakeMaker, that it should include the rules to
1634 make a perl. This is handled automatically as a switch by
1635 MakeMaker. The user normally does not need it.
1639 The name of the Makefile to be produced.
1643 Hashref of pod-containing files. MakeMaker will default this to all
1644 EXE_FILES files that include POD directives. The files listed
1645 here will be converted to man pages and installed as was requested
1650 Hashref that assigns to *.pm and *.pod files the files into which the
1651 manpages are to be written. MakeMaker parses all *.pod and *.pm files
1652 for POD directives. Files that contain POD will be the default keys of
1653 the MAN3PODS hashref. These will then be converted to man pages during
1654 C<make> and will be installed during C<make install>.
1658 If it is intended, that a new perl binary be produced, this variable
1659 may hold a name for that binary. Defaults to perl
1663 If the extension links to a library that it builds set this to the
1664 name of the library (see SDBM_File)
1668 Perl module name for this extension (DBD::Oracle). This will default
1669 to the directory name but should be explicitly defined in the
1674 MakeMaker will figure out if an extension contains linkable code
1675 anywhere down the directory tree, and will set this variable
1676 accordingly, but you can speed it up a very little bit if you define
1677 this boolean variable yourself.
1681 Defaults to C<@>. By setting it to an empty string you can generate a
1682 Makefile that echos all commands. Mainly used in debugging MakeMaker
1687 Boolean. Attribute to inhibit descending into subdirectories.
1691 In general, any generated Makefile checks for the current version of
1692 MakeMaker and the version the Makefile was built under. If NO_VC is
1693 set, the version check is neglected. Do not write this into your
1694 Makefile.PL, use it interactively instead.
1698 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1699 string containing all object files, e.g. "tkpBind.o
1700 tkpButton.o tkpCanvas.o"
1702 (Where BASEEXT is the last component of NAME, and OBJ_EXT is $Config{obj_ext}.)
1706 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1707 passed to subdirectory makes.
1711 Perl binary for tasks that can be done by miniperl
1715 Set only when MakeMaker is building the extensions of the Perl core
1720 The call to the program that is able to compile perlmain.c. Defaults
1725 Same as for PERL_LIB, but for architecture dependent files.
1727 Used only when MakeMaker is building the extensions of the Perl core
1728 distribution (because normally $(PERL_ARCHLIB) is automatically in @INC,
1729 and adding it would get in the way of PERL5LIB).
1733 Directory containing the Perl library to use.
1735 Used only when MakeMaker is building the extensions of the Perl core
1736 distribution (because normally $(PERL_LIB) is automatically in @INC,
1737 and adding it would get in the way of PERL5LIB).
1739 =item PERL_MALLOC_OK
1741 defaults to 0. Should be set to TRUE if the extension can work with
1742 the memory allocation routines substituted by the Perl malloc() subsystem.
1743 This should be applicable to most extensions with exceptions of those
1749 with bugs in memory allocations which are caught by Perl's malloc();
1753 which interact with the memory allocator in other ways than via
1754 malloc(), realloc(), free(), calloc(), sbrk() and brk();
1758 which rely on special alignment which is not provided by Perl's malloc().
1762 B<NOTE.> Negligence to set this flag in I<any one> of loaded extension
1763 nullifies many advantages of Perl's malloc(), such as better usage of
1764 system resources, error detection, memory usage reporting, catchable failure
1765 of memory allocations, etc.
1769 Use this instead of $(PERL) when you wish to run perl. It will set up
1770 extra necessary flags for you.
1774 Use this instead of $(PERL) when you wish to run perl to work with
1775 modules. It will add things like -I$(INST_ARCH) and other necessary
1776 flags so perl can see the modules you're about to install.
1780 Directory containing the Perl source code (use of this should be
1781 avoided, it may be undefined)
1785 Desired permission for read/writable files. Defaults to C<644>.
1786 See also L<MM_Unix/perm_rw>.
1790 Desired permission for executable files. Defaults to C<755>.
1791 See also L<MM_Unix/perm_rwx>.
1795 Ref to hash of files to be processed as perl programs. MakeMaker
1796 will default to any found *.PL file (except Makefile.PL) being keys
1797 and the basename of the file being the value. E.g.
1799 {'foobar.PL' => 'foobar'}
1801 The *.PL files are expected to produce output to the target files
1802 themselves. If multiple files can be generated from the same *.PL
1803 file then the value in the hash can be a reference to an array of
1804 target file names. E.g.
1806 {'foobar.PL' => ['foobar1','foobar2']}
1810 Hashref of .pm files and *.pl files to be installed. e.g.
1812 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1814 By default this will include *.pm and *.pl and the files found in
1815 the PMLIBDIRS directories. Defining PM in the
1816 Makefile.PL will override PMLIBDIRS.
1820 Ref to array of subdirectories containing library files. Defaults to
1821 [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
1822 they contain will be installed in the corresponding location in the
1823 library. A libscan() method can be used to alter the behaviour.
1824 Defining PM in the Makefile.PL will override PMLIBDIRS.
1826 (Where BASEEXT is the last component of NAME.)
1830 A filter program, in the traditional Unix sense (input from stdin, output
1831 to stdout) that is passed on each .pm file during the build (in the
1832 pm_to_blib() phase). It is empty by default, meaning no filtering is done.
1834 Great care is necessary when defining the command if quoting needs to be
1835 done. For instance, you would need to say:
1837 {'PM_FILTER' => 'grep -v \\"^\\#\\"'}
1839 to remove all the leading coments on the fly during the build. The
1840 extra \\ are necessary, unfortunately, because this variable is interpolated
1841 within the context of a Perl program built on the command line, and double
1842 quotes are what is used with the -e switch to build that command line. The
1843 # is escaped for the Makefile, since what is going to be generated will then
1846 PM_FILTER = grep -v \"^\#\"
1848 Without the \\ before the #, we'd have the start of a Makefile comment,
1849 and the macro would be incorrectly defined.
1853 Release 5.005 grandfathered old global symbol names by providing preprocessor
1854 macros for extension source compatibility. As of release 5.6, these
1855 preprocessor definitions are not available by default. The POLLUTE flag
1856 specifies that the old names should still be defined:
1858 perl Makefile.PL POLLUTE=1
1860 Please inform the module author if this is necessary to successfully install
1861 a module under 5.6 or later.
1863 =item PPM_INSTALL_EXEC
1865 Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl)
1867 =item PPM_INSTALL_SCRIPT
1869 Name of the script that gets executed by the Perl Package Manager after
1870 the installation of a package.
1874 This overrides all the default install locations. Man pages,
1875 libraries, scripts, etc... MakeMaker will try to make an educated
1876 guess about where to place things under the new PREFIX based on your
1877 Config defaults. Failing that, it will fall back to a structure
1878 which should be sensible for your platform.
1880 If you specify LIB or any INSTALL* variables they will not be effected
1883 Defaults to $Config{installprefixexp}.
1887 Bool. If this parameter is true, failing to have the required modules
1888 (or the right versions thereof) will be fatal. perl Makefile.PL will die
1889 with the proper message.
1891 Note: see L<Test::Harness> for a shortcut for stopping tests early if
1892 you are missing dependencies.
1894 Do I<not> use this parameter for simple requirements, which could be resolved
1895 at a later time, e.g. after an unsuccessful B<make test> of your module.
1897 It is I<extremely> rare to have to use C<PREREQ_FATAL> at all!
1901 Hashref: Names of modules that need to be available to run this
1902 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1903 desired version is the value. If the required version number is 0, we
1904 only check if any version is installed already.
1908 Bool. If this parameter is true, the prerequisites will be printed to
1909 stdout and MakeMaker will exit. The output format is
1919 RedHatism for C<PREREQ_PRINT>. The output format is different, though:
1921 perl(A::B)>=Vers1 perl(C::D)>=Vers2 ...
1925 Like PREFIX, but only for the site install locations.
1927 Defaults to PREFIX (if set) or $Config{siteprefixexp}. Perls prior to
1928 5.6.0 didn't have an explicit siteprefix in the Config. In those
1929 cases $Config{installprefix} will be used.
1933 Arrayref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1934 Makefile. Caution! Do not use the SKIP attribute for the negligible
1935 speedup. It may seriously damage the resulting Makefile. Only use it
1936 if you really need it.
1940 Ref to array of typemap file names. Use this when the typemaps are
1941 in some directory other than the current directory or when they are
1942 not named B<typemap>. The last typemap in the list takes
1943 precedence. A typemap in the current directory has highest
1944 precedence, even if it isn't listed in TYPEMAPS. The default system
1945 typemap has lowest precedence.
1949 Like PREFIX, but only for the vendor install locations.
1951 Defaults to PREFIX (if set) or $Config{vendorprefixexp}
1955 If true, make install will be verbose
1959 Your version number for distributing the package. This defaults to
1964 Instead of specifying the VERSION in the Makefile.PL you can let
1965 MakeMaker parse a file to determine the version number. The parsing
1966 routine requires that the file named by VERSION_FROM contains one
1967 single line to compute the version number. The first line in the file
1968 that contains the regular expression
1970 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
1972 will be evaluated with eval() and the value of the named variable
1973 B<after> the eval() will be assigned to the VERSION attribute of the
1974 MakeMaker object. The following lines will be parsed o.k.:
1978 ( $VERSION ) = '$Revision: 1.61 $ ' =~ /\$Revision:\s+([^\s]+)/;
1979 $FOO::VERSION = '1.10';
1980 *FOO::VERSION = \'1.11';
1981 our $VERSION = 1.2.3; # new for perl5.6.0
1983 but these will fail:
1985 my $VERSION = '1.01';
1986 local $VERSION = '1.02';
1987 local $FOO::VERSION = '1.30';
1989 (Putting C<my> or C<local> on the preceding line will work o.k.)
1991 The file named in VERSION_FROM is not added as a dependency to
1992 Makefile. This is not really correct, but it would be a major pain
1993 during development to have to rewrite the Makefile for any smallish
1994 change in that file. If you want to make sure that the Makefile
1995 contains the correct VERSION macro after any change of the file, you
1996 would have to do something like
1998 depend => { Makefile => '$(VERSION_FROM)' }
2000 See attribute C<depend> below.
2004 Hashref of .xs files. MakeMaker will default this. e.g.
2006 {'name_of_file.xs' => 'name_of_file.c'}
2008 The .c files will automatically be included in the list of files
2009 deleted by a make clean.
2013 String of options to pass to xsubpp. This might include C<-C++> or
2014 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
2019 May be set to an empty string, which is identical to C<-prototypes>, or
2020 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
2021 defaults to the empty string.
2025 Your version number for the .xs file of this package. This defaults
2026 to the value of the VERSION attribute.
2030 =head2 Additional lowercase attributes
2032 can be used to pass parameters to the methods which implement that
2033 part of the Makefile.
2039 {FILES => "*.xyz foo"}
2043 {ANY_TARGET => ANY_DEPENDECY, ...}
2045 (ANY_TARGET must not be given a double-colon rule by MakeMaker.)
2049 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
2050 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
2051 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
2053 If you specify COMPRESS, then SUFFIX should also be altered, as it is
2054 needed to tell make the target file of the compression. Setting
2055 DIST_CP to ln can be useful, if you need to preserve the timestamps on
2056 your files. DIST_CP can take the values 'cp', which copies the file,
2057 'ln', which links the file, and 'best' which copies symbolic links and
2058 links the rest. Default is 'best'.
2062 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
2066 {LINKTYPE => 'static', 'dynamic' or ''}
2068 NB: Extensions that have nothing but *.pm files had to say
2072 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
2073 can be deleted safely. MakeMaker recognizes when there's nothing to
2078 {ANY_MACRO => ANY_VALUE, ...}
2082 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
2088 =item tool_autosplit
2094 =head2 Overriding MakeMaker Methods
2096 If you cannot achieve the desired Makefile behaviour by specifying
2097 attributes you may define private subroutines in the Makefile.PL.
2098 Each subroutine returns the text it wishes to have written to
2099 the Makefile. To override a section of the Makefile you can
2102 sub MY::c_o { "new literal text" }
2104 or you can edit the default by saying something like:
2106 package MY; # so that "SUPER" works right
2108 my $inherited = shift->SUPER::c_o(@_);
2109 $inherited =~ s/old text/new text/;
2113 If you are running experiments with embedding perl as a library into
2114 other applications, you might find MakeMaker is not sufficient. You'd
2115 better have a look at ExtUtils::Embed which is a collection of utilities
2118 If you still need a different solution, try to develop another
2119 subroutine that fits your needs and submit the diffs to
2120 F<makemaker@perl.org>
2122 For a complete description of all MakeMaker methods see
2123 L<ExtUtils::MM_Unix>.
2125 Here is a simple example of how to add a new target to the generated
2129 return <<'MAKE_FRAG';
2130 $(MYEXTLIB): sdbm/Makefile
2131 cd sdbm && $(MAKE) all
2137 =head2 Hintsfile support
2139 MakeMaker.pm uses the architecture specific information from
2140 Config.pm. In addition it evaluates architecture specific hints files
2141 in a C<hints/> directory. The hints files are expected to be named
2142 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
2143 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
2144 MakeMaker within the WriteMakefile() subroutine, and can be used to
2145 execute commands as well as to include special variables. The rules
2146 which hintsfile is chosen are the same as in Configure.
2148 The hintsfile is eval()ed immediately after the arguments given to
2149 WriteMakefile are stuffed into a hash reference $self but before this
2150 reference becomes blessed. So if you want to do the equivalent to
2151 override or create an attribute you would say something like
2153 $self->{LIBS} = ['-ldbm -lucb -lc'];
2155 =head2 Distribution Support
2157 For authors of extensions MakeMaker provides several Makefile
2158 targets. Most of the support comes from the ExtUtils::Manifest module,
2159 where additional documentation can be found.
2163 =item make distcheck
2165 reports which files are below the build directory but not in the
2166 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
2169 =item make skipcheck
2171 reports which files are skipped due to the entries in the
2172 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
2175 =item make distclean
2177 does a realclean first and then the distcheck. Note that this is not
2178 needed to build a new distribution as long as you are sure that the
2179 MANIFEST file is ok.
2183 rewrites the MANIFEST file, adding all remaining files found (See
2184 ExtUtils::Manifest::mkmanifest() for details)
2188 Copies all the files that are in the MANIFEST file to a newly created
2189 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
2190 exists, it will be removed first.
2194 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
2195 a make test in that directory.
2199 First does a distdir. Then a command $(PREOP) which defaults to a null
2200 command, followed by $(TOUNIX), which defaults to a null command under
2201 UNIX, and will convert files in distribution directory to UNIX format
2202 otherwise. Next it runs C<tar> on that directory into a tarfile and
2203 deletes the directory. Finishes with a command $(POSTOP) which
2204 defaults to a null command.
2208 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
2210 =item make uutardist
2212 Runs a tardist first and uuencodes the tarfile.
2216 First does a distdir. Then a command $(PREOP) which defaults to a null
2217 command. Next it runs C<shar> on that directory into a sharfile and
2218 deletes the intermediate directory again. Finishes with a command
2219 $(POSTOP) which defaults to a null command. Note: For shdist to work
2220 properly a C<shar> program that can handle directories is mandatory.
2224 First does a distdir. Then a command $(PREOP) which defaults to a null
2225 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
2226 zipfile. Then deletes that directory. Finishes with a command
2227 $(POSTOP) which defaults to a null command.
2231 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
2235 Customization of the dist targets can be done by specifying a hash
2236 reference to the dist attribute of the WriteMakefile call. The
2237 following parameters are recognized:
2240 COMPRESS ('gzip --best')
2243 TO_UNIX (depends on the system)
2244 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
2254 WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" })
2256 =head2 Disabling an extension
2258 If some events detected in F<Makefile.PL> imply that there is no way
2259 to create the Module, but this is a normal state of things, then you
2260 can create a F<Makefile> which does nothing, but succeeds on all the
2261 "usual" build targets. To do so, use
2263 ExtUtils::MakeMaker::WriteEmptyMakefile();
2265 instead of WriteMakefile().
2267 This may be useful if other modules expect this module to be I<built>
2268 OK, as opposed to I<work> OK (say, this system-dependent module builds
2269 in a subdirectory of some other distribution, or is listed as a
2270 dependency in a CPAN::Bundle, but the functionality is supported by
2271 different means on the current architecture).
2279 Command line options used by C<MakeMaker-E<gt>new()>, and thus by
2280 C<WriteMakefile()>. The string is split on whitespace, and the result
2281 is processed before any actual command line arguments are processed.
2283 =item PERL_MM_USE_DEFAULT
2285 If set to a true value then MakeMaker's prompt function will
2286 always return the default without waiting for user input.
2292 ExtUtils::MM_Unix, ExtUtils::Manifest ExtUtils::Install,
2297 Andy Dougherty <F<doughera@lafayette.edu>>, Andreas KE<ouml>nig
2298 <F<andreas.koenig@mind.de>>, Tim Bunce <F<timb@cpan.org>>. VMS
2299 support by Charles Bailey <F<bailey@newman.upenn.edu>>. OS/2 support
2300 by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>.
2302 Currently maintained by Michael G Schwern <F<schwern@pobox.com>>
2304 Send patches and ideas to <F<makemaker@perl.org>>.
2306 Send bug reports via http://rt.cpan.org/. Please send your
2307 generated Makefile along with your report.
2309 For more up-to-date information, see http://www.makemaker.org.