3 package ExtUtils::MakeMaker;
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.19 $, 10)) =~ s/\s+$//;
15 @ISA @EXPORT @EXPORT_OK
16 $ISA_TTY $Revision $VERSION $Verbose $Version_OK %Config
17 %Keep_after_flush %MM_Sections @Prepend_dot_dot
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
38 $_[0] =~ /^Use of uninitialized value/ && return;
39 $_[0] =~ /used only once/ && return;
40 $_[0] =~ /^Subroutine\s+[\w:]+\s+redefined/ && return;
45 Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
46 local $SIG{__WARN__} = \&warnhandler;
50 MM->new(\%att)->flush;
55 $ISA_TTY = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ; # Pipe?
56 Carp::confess("prompt function called without an argument") unless defined $mess;
57 my $dispdef = defined $def ? "[$def] " : " ";
58 $def = defined $def ? $def : "";
62 print "$mess $dispdef";
63 if ($ISA_TTY && !$ENV{PERL_MM_USE_DEFAULT}) {
68 else { # user hit ctrl-D
75 return (!defined $ans || $ans eq '') ? $def : $ans;
80 use Cwd qw(cwd abs_path);
82 local @INC = map eval {abs_path($_) if -e} || $_, @INC;
83 push @INC, '.'; # '.' has to always be at the end of @INC
85 foreach my $dir (@{$self->{DIR}}){
86 my($abs) = $self->catdir($pwd,$dir);
87 $self->eval_in_x($abs);
94 chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
101 # if ($@ =~ /prerequisites/) {
102 # die "MakeMaker WARNING: $@";
104 # warn "WARNING from evaluation of $dir/Makefile.PL: $@";
106 warn "WARNING from evaluation of $dir/Makefile.PL: $@";
113 # package name for the classes into which the first object will be blessed
114 $PACKNAME = "PACK000";
116 my @attrib_help = qw/
118 AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION
119 C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
120 EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE FULLPERL FUNCLIST H
122 INC INCLUDE_EXT INSTALLARCHLIB INSTALLBIN INSTALLDIRS
124 INSTALLMAN3DIR INSTALLPRIVLIB INSTALLSCRIPT INSTALLSITEARCH
125 INSTALLSITELIB INST_ARCHLIB INST_BIN INST_EXE INST_LIB
126 INST_MAN1DIR INST_MAN3DIR INST_SCRIPT LDFROM LIB LIBPERL_A LIBS
127 LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB
129 NAME NEEDS_LINKING NOECHO NORECURS NO_VC OBJECT OPTIMIZE PERL PERLMAINCC
130 PERLRUN PERLRUNINST PERL_ARCHLIB PERL_CORE
131 PERL_LIB PERL_SRC PERM_RW PERM_RWX
132 PL_FILES PM PM_FILTER PMLIBDIRS POLLUTE PPM_INSTALL_EXEC
133 PPM_INSTALL_SCRIPT PREFIX
134 PREREQ_FATAL PREREQ_PM PREREQ_PRINT PRINT_PREREQ
135 SKIP TEST_LIBS TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
136 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
138 MACPERL_SRC MACPERL_LIB MACLIBS_68K MACLIBS_PPC MACLIBS_SC MACLIBS_MRC
139 MACLIBS_ALL_68K MACLIBS_ALL_PPC MACLIBS_SHARED
142 # IMPORTS is used under OS/2 and Win32
144 # @Overridable is close to @MM_Sections but not identical. The
145 # order is important. Many subroutines declare macros. These
146 # depend on each other. Let's try to collect the macros up front,
147 # then pasthru, then the rules.
149 # MM_Sections are the sections we have to call explicitly
150 # in Overridable we have subroutines that are used indirectly
156 post_initialize const_config constants tool_autosplit tool_xsubpp
157 tools_other dist macro depend cflags const_loadlibs const_cccmd
162 c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs
163 dynamic_lib static static_lib manifypods processPL
165 clean realclean dist_basics dist_core dist_dir dist_test dist_ci
166 install force perldepend makefile staticmake test ppd
168 ); # loses section ordering
170 @Overridable = @MM_Sections;
171 push @Overridable, qw[
173 dir_target libscan makeaperl needs_linking perm_rw perm_rwx
174 subdir_x test_via_harness test_via_script
177 push @MM_Sections, qw[
179 pm_to_blib selfdocument
183 # Postamble needs to be the last that was always the case
184 push @MM_Sections, "postamble";
185 push @Overridable, "postamble";
187 # All sections are valid keys.
188 @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
190 # we will use all these variables in the Makefile
193 ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc
194 lib_ext obj_ext osname osvers ranlib sitelibexp sitearchexp so
198 foreach my $item (@attrib_help){
199 $Recognized_Att_Keys{$item} = 1;
201 foreach my $item (@Get_from_Config) {
202 $Recognized_Att_Keys{uc $item} = $Config{$item};
203 print "Attribute '\U$item\E' => '$Config{$item}'\n"
208 # When we eval a Makefile.PL in a subdirectory, that one will ask
209 # us (the parent) for the values and will prepend "..", so that
210 # all files to be installed end up below OUR ./blib
212 @Prepend_dot_dot = qw(
213 INST_BIN INST_EXE INST_LIB INST_ARCHLIB INST_SCRIPT
214 MAP_TARGET INST_MAN1DIR INST_MAN3DIR PERL_SRC
219 NEEDS_LINKING HAS_LINK_CODE
221 @Keep_after_flush{@keep} = (1) x @keep;
227 The extension you are trying to build apparently is rather old and
228 most probably outdated. We detect that from the fact, that a
229 subroutine "writeMakefile" is called, and this subroutine is not
230 supported anymore since about October 1994.
232 Please contact the author or look into CPAN (details about CPAN can be
233 found in the FAQ and at http:/www.perl.com) for a more recent version
234 of the extension. If you're really desperate, you can try to change
235 the subroutine name from writeMakefile to WriteMakefile and rerun
236 'perl Makefile.PL', but you're most probably left alone, when you do
245 my($class,$self) = @_;
248 if ("@ARGV" =~ /\bPREREQ_PRINT\b/) {
249 require Data::Dumper;
250 print Data::Dumper->Dump([$self->{PREREQ_PM}], [qw(PREREQ_PM)]);
253 # PRINT_PREREQ is RedHatism.
254 if ("@ARGV" =~ /\bPRINT_PREREQ\b/) {
255 print join(" ", map { "perl($_)>=$self->{PREREQ_PM}->{$_} " } sort keys %{$self->{PREREQ_PM}}), "\n";
259 print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
260 if (-f "MANIFEST" && ! -f "Makefile"){
264 $self = {} unless (defined $self);
268 my %configure_att; # record &{$self->{CONFIGURE}} attributes
269 my(%initial_att) = %$self; # record initial attributes
271 my(%unsatisfied) = ();
272 foreach my $prereq (sort keys %{$self->{PREREQ_PM}}) {
273 eval "require $prereq";
276 warn sprintf "Warning: prerequisite %s %s not found.\n",
277 $prereq, $self->{PREREQ_PM}{$prereq}
278 unless $self->{PREREQ_FATAL};
279 $unsatisfied{$prereq} = 'not installed';
280 } elsif ($prereq->VERSION < $self->{PREREQ_PM}->{$prereq} ){
281 warn "Warning: prerequisite %s %s not found. We have %s.\n",
282 $prereq, $self->{PREREQ_PM}{$prereq},
283 ($prereq->VERSION || 'unknown version')
284 unless $self->{PREREQ_FATAL};
285 $unsatisfied{$prereq} = $self->{PREREQ_PM}->{$prereq} ?
286 $self->{PREREQ_PM}->{$prereq} : 'unknown version' ;
289 if (%unsatisfied && $self->{PREREQ_FATAL}){
290 my $failedprereqs = join ', ', map {"$_ $unsatisfied{$_}"}
292 die qq{MakeMaker FATAL: prerequisites not found ($failedprereqs)\n
293 Please install these modules first and rerun 'perl Makefile.PL'.\n};
296 if (defined $self->{CONFIGURE}) {
297 if (ref $self->{CONFIGURE} eq 'CODE') {
298 %configure_att = %{&{$self->{CONFIGURE}}};
299 $self = { %$self, %configure_att };
301 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
305 # This is for old Makefiles written pre 5.00, will go away
306 if ( Carp::longmess("") =~ /runsubdirpl/s ){
307 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
310 my $newclass = ++$PACKNAME;
311 local @Parent = @Parent; # Protect against non-local exits
314 print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
315 mv_all_methods("MY",$newclass);
316 bless $self, $newclass;
318 require ExtUtils::MY;
319 @{"$newclass\:\:ISA"} = 'MM';
322 if (defined $Parent[-2]){
323 $self->{PARENT} = $Parent[-2];
325 for $key (@Prepend_dot_dot) {
326 next unless defined $self->{PARENT}{$key};
327 $self->{$key} = $self->{PARENT}{$key};
328 unless ($^O eq 'VMS' && $key =~ /PERL$/) {
329 $self->{$key} = $self->catdir("..",$self->{$key})
330 unless $self->file_name_is_absolute($self->{$key});
332 # PERL or FULLPERL will be a command verb or even a
333 # command with an argument instead of a full file
334 # specification under VMS. So, don't turn the command
335 # into a filespec, but do add a level to the path of
336 # the argument if not already absolute.
337 my @cmd = split /\s+/, $self->{$key};
338 $cmd[1] = $self->catfile('[-]',$cmd[1])
339 unless (@cmd < 2) || $self->file_name_is_absolute($cmd[1]);
340 $self->{$key} = join(' ', @cmd);
343 if ($self->{PARENT}) {
344 $self->{PARENT}->{CHILDREN}->{$newclass} = $self;
345 foreach my $opt (qw(POLLUTE PERL_CORE)) {
346 if (exists $self->{PARENT}->{$opt}
347 and not exists $self->{$opt})
349 # inherit, but only if already unspecified
350 $self->{$opt} = $self->{PARENT}->{$opt};
354 my @fm = grep /^FIRST_MAKEFILE=/, @ARGV;
355 parse_args($self,@fm) if @fm;
357 parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV);
360 $self->{NAME} ||= $self->guess_name;
362 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
366 if (! $self->{PERL_SRC} ) {
367 require VMS::Filespec if $Is_VMS;
368 my($pthinks) = $self->canonpath($INC{'Config.pm'});
369 my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
370 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
371 if ($pthinks ne $cthinks &&
372 !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
373 print "Have $pthinks expected $cthinks\n";
375 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
378 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
380 print STDOUT <<END unless $self->{UNINSTALLED_PERL};
381 Your perl and your Config.pm seem to have different ideas about the
382 architecture they are running on.
383 Perl thinks: [$pthinks]
384 Config says: [$Config{archname}]
385 This may or may not cause problems. Please check your installation of perl
386 if you have problems building this extension.
391 $self->init_dirscan();
392 $self->init_others();
393 my($argv) = neatvalue(\@ARGV);
397 push @{$self->{RESULT}}, <<END;
398 # This Makefile is for the $self->{NAME} extension to perl.
400 # It was generated automatically by MakeMaker version
401 # $VERSION (Revision: $Revision) from the contents of
402 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
404 # ANY CHANGES MADE HERE WILL BE LOST!
406 # MakeMaker ARGV: $argv
408 # MakeMaker Parameters:
411 foreach my $key (sort keys %initial_att){
412 my($v) = neatvalue($initial_att{$key});
413 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
415 push @{$self->{RESULT}}, "# $key => $v";
417 undef %initial_att; # free memory
419 if (defined $self->{CONFIGURE}) {
420 push @{$self->{RESULT}}, <<END;
422 # MakeMaker 'CONFIGURE' Parameters:
424 if (scalar(keys %configure_att) > 0) {
425 foreach my $key (sort keys %configure_att){
426 my($v) = neatvalue($configure_att{$key});
427 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
429 push @{$self->{RESULT}}, "# $key => $v";
434 push @{$self->{RESULT}}, "# no values returned";
436 undef %configure_att; # free memory
439 # turn the SKIP array into a SKIPHASH hash
441 for $skip (@{$self->{SKIP} || []}) {
442 $self->{SKIPHASH}{$skip} = 1;
444 delete $self->{SKIP}; # free memory
446 if ($self->{PARENT}) {
447 for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
448 $self->{SKIPHASH}{$_} = 1;
452 # We run all the subdirectories now. They don't have much to query
453 # from the parent, but the parent has to query them: if they need linking!
454 unless ($self->{NORECURS}) {
455 $self->eval_in_subdirs if @{$self->{DIR}};
458 foreach my $section ( @MM_Sections ){
459 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
460 my($skipit) = $self->skipcheck($section);
462 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
464 my(%a) = %{$self->{$section} || {}};
465 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
466 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
467 push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
471 push @{$self->{RESULT}}, "\n# End.";
476 sub WriteEmptyMakefile {
477 Carp::croak "WriteEmptyMakefile: Need even number of args" if @_ % 2;
478 local $SIG{__WARN__} = \&warnhandler;
481 my $self = MM->new(\%att);
482 if (-f "$self->{MAKEFILE}.old") {
483 chmod 0666, "$self->{MAKEFILE}.old";
484 unlink "$self->{MAKEFILE}.old" or warn "unlink $self->{MAKEFILE}.old: $!";
486 rename $self->{MAKEFILE}, "$self->{MAKEFILE}.old"
487 or warn "rename $self->{MAKEFILE} $self->{MAKEFILE}.old: $!"
488 if -f $self->{MAKEFILE};
489 open MF, '>', $self->{MAKEFILE} or die "open $self->{MAKEFILE} for write: $!";
502 close MF or die "close $self->{MAKEFILE} for write: $!";
506 print STDOUT "Checking if your kit is complete...\n";
507 require ExtUtils::Manifest;
509 $ExtUtils::Manifest::Quiet = $ExtUtils::Manifest::Quiet = 1;
510 my(@missed) = ExtUtils::Manifest::manicheck();
512 print STDOUT "Warning: the following files are missing in your kit:\n";
513 print "\t", join "\n\t", @missed;
515 print STDOUT "Please inform the author.\n";
517 print STDOUT "Looks good\n";
522 my($self, @args) = @_;
524 unless (m/(.*?)=(.*)/) {
525 help(),exit 1 if m/^help$/;
526 ++$Verbose if m/^verb/;
529 my($name, $value) = ($1, $2);
530 if ($value =~ m/^~(\w+)?/) { # tilde with optional username
531 $value =~ s [^~(\w*)]
533 ((getpwnam($1))[7] || "~$1") :
537 $self->{uc($name)} = $value;
540 # catch old-style 'potential_libs' and inform user how to 'upgrade'
541 if (defined $self->{potential_libs}){
542 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
543 if ($self->{potential_libs}){
544 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
546 print STDOUT "$msg deleted.\n";
548 $self->{LIBS} = [$self->{potential_libs}];
549 delete $self->{potential_libs};
551 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
552 if (defined $self->{ARMAYBE}){
553 my($armaybe) = $self->{ARMAYBE};
554 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
555 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
556 my(%dl) = %{$self->{dynamic_lib} || {}};
557 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
558 delete $self->{ARMAYBE};
560 if (defined $self->{LDTARGET}){
561 print STDOUT "LDTARGET should be changed to LDFROM\n";
562 $self->{LDFROM} = $self->{LDTARGET};
563 delete $self->{LDTARGET};
565 # Turn a DIR argument on the command line into an array
566 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
567 # So they can choose from the command line, which extensions they want
568 # the grep enables them to have some colons too much in case they
569 # have to build a list with the shell
570 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
572 # Turn a INCLUDE_EXT argument on the command line into an array
573 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
574 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
576 # Turn a EXCLUDE_EXT argument on the command line into an array
577 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
578 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
581 foreach my $mmkey (sort keys %$self){
582 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
583 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
584 unless exists $Recognized_Att_Keys{$mmkey};
591 # We allow extension-specific hints files.
593 return unless -d "hints";
595 # First we look for the best hintsfile we have
596 my($hint)="${^O}_$Config{osvers}";
601 # Also try without trailing minor version numbers.
603 last if -f "hints/$hint.pl"; # found
605 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
607 my $hint_file = "hints/$hint.pl";
609 return unless -f $hint_file; # really there
611 _run_hintfile($self, $hint_file);
616 local($self) = shift; # make $self available to the hint file.
617 my($hint_file) = shift;
619 print STDERR "Processing hints file $hint_file\n";
622 print STDERR "Couldn't open hint file: $!" if $!;
623 print STDERR $@ if $@;
629 my($symtab) = \%{"${from}::"};
631 # Here you see the *current* list of methods that are overridable
632 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
633 # still trying to reduce the list to some reasonable minimum --
634 # because I want to make it easier for the user. A.K.
636 foreach my $method (@Overridable) {
638 # We cannot say "next" here. Nick might call MY->makeaperl
639 # which isn't defined right now
641 # Above statement was written at 4.23 time when Tk-b8 was
642 # around. As Tk-b9 only builds with 5.002something and MM 5 is
643 # standard, we try to enable the next line again. It was
644 # commented out until MM 5.23
646 next unless defined &{"${from}::$method"};
648 *{"${to}::$method"} = \&{"${from}::$method"};
650 # delete would do, if we were sure, nobody ever called
651 # MY->makeaperl directly
653 # delete $symtab->{$method};
655 # If we delete a method, then it will be undefined and cannot
656 # be called. But as long as we have Makefile.PLs that rely on
657 # %MY:: being intact, we have to fill the hole with an
660 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
663 # We have to clean out %INC also, because the current directory is
664 # changed frequently and Graham Barr prefers to get his version
665 # out of a History.pl file which is "required" so woudn't get
666 # loaded again in another extension requiring a History.pl
668 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
669 # to core dump in the middle of a require statement. The required
670 # file was Tk/MMutil.pm. The consequence is, we have to be
671 # extremely careful when we try to give perl a reason to reload a
672 # library with same name. The workaround prefers to drop nothing
673 # from %INC and teach the writers not to use such libraries.
676 # foreach $inc (keys %INC) {
677 # #warn "***$inc*** deleted";
685 if ($section eq 'dynamic') {
686 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
687 "in skipped section 'dynamic_bs'\n"
688 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
689 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
690 "in skipped section 'dynamic_lib'\n"
691 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
693 if ($section eq 'dynamic_lib') {
694 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
695 "targets in skipped section 'dynamic_bs'\n"
696 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
698 if ($section eq 'static') {
699 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
700 "in skipped section 'static_lib'\n"
701 if $self->{SKIPHASH}{static_lib} && $Verbose;
703 return 'skipped' if $self->{SKIPHASH}{$section};
711 # my $fh = new FileHandle;
713 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
715 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
716 # $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
717 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
719 for $chunk (@{$self->{RESULT}}) {
720 # print $fh "$chunk\n";
726 my($finalname) = $self->{MAKEFILE};
727 rename("MakeMaker.tmp", $finalname);
728 chmod 0644, $finalname unless $Is_VMS;
730 if ($self->{PARENT}) {
731 foreach (keys %$self) { # safe memory
732 delete $self->{$_} unless $Keep_after_flush{$_};
736 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
739 # The following mkbootstrap() is only for installations that are calling
740 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
741 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
744 !!! Your Makefile has been built such a long time ago, !!!
745 !!! that is unlikely to work with current MakeMaker. !!!
746 !!! Please rebuild your Makefile !!!
750 # Ditto for mksymlists() as of MakeMaker 5.17
753 !!! Your Makefile has been built such a long time ago, !!!
754 !!! that is unlikely to work with current MakeMaker. !!!
755 !!! Please rebuild your Makefile !!!
761 return "undef" unless defined $v;
763 return "q[$v]" unless $t;
767 foreach my $elem (@$v) {
768 push @neat, "q[$elem]";
770 push @m, join ", ", @neat;
774 return "$v" unless $t eq 'HASH';
776 while (($key,$val) = each %$v){
777 last unless defined $key; # cautious programming in case (undef,undef) is true
778 push(@m,"$key=>".neatvalue($val)) ;
780 return "{ ".join(', ',@m)." }";
787 push @m, "\n# Full list of MakeMaker attribute values:";
788 foreach my $key (sort keys %$self){
789 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
790 my($v) = neatvalue($self->{$key});
791 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
793 push @m, "# $key => $v";
805 ExtUtils::MakeMaker - create an extension Makefile
809 C<use ExtUtils::MakeMaker;>
811 C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
815 C<MM-E<gt>new(\%att)-E<gt>flush;>
819 This utility is designed to write a Makefile for an extension module
820 from a Makefile.PL. It is based on the Makefile.SH model provided by
821 Andy Dougherty and the perl5-porters.
823 It splits the task of generating the Makefile into several subroutines
824 that can be individually overridden. Each subroutine returns the text
825 it wishes to have written to the Makefile.
827 MakeMaker is object oriented. Each directory below the current
828 directory that contains a Makefile.PL. Is treated as a separate
829 object. This makes it possible to write an unlimited number of
830 Makefiles with a single invocation of WriteMakefile().
832 =head2 How To Write A Makefile.PL
834 The short answer is: Don't.
836 Always begin with h2xs.
837 Always begin with h2xs!
838 ALWAYS BEGIN WITH H2XS!
840 even if you're not building around a header file, and even if you
841 don't have an XS component.
843 Run h2xs(1) before you start thinking about writing a module. For so
844 called pm-only modules that consist of C<*.pm> files only, h2xs has
845 the C<-X> switch. This will generate dummy files of all kinds that are
846 useful for the module developer.
848 The medium answer is:
850 use ExtUtils::MakeMaker;
851 WriteMakefile( NAME => "Foo::Bar" );
853 The long answer is the rest of the manpage :-)
855 =head2 Default Makefile Behaviour
857 The generated Makefile enables the user of the extension to invoke
859 perl Makefile.PL # optionally "perl Makefile.PL verbose"
861 make test # optionally set TEST_VERBOSE=1
862 make install # See below
864 The Makefile to be produced may be altered by adding arguments of the
865 form C<KEY=VALUE>. E.g.
867 perl Makefile.PL PREFIX=/tmp/myperl5
869 Other interesting targets in the generated Makefile are
871 make config # to check if the Makefile is up-to-date
872 make clean # delete local temp files (Makefile gets renamed)
873 make realclean # delete derived files (including ./blib)
874 make ci # check in all the files in the MANIFEST file
875 make dist # see below the Distribution Support section
879 MakeMaker checks for the existence of a file named F<test.pl> in the
880 current directory and if it exists it adds commands to the test target
881 of the generated Makefile that will execute the script with the proper
882 set of perl C<-I> options.
884 MakeMaker also checks for any files matching glob("t/*.t"). It will
885 add commands to the test target of the generated Makefile that execute
886 all matching files via the L<Test::Harness> module with the C<-I>
887 switches set correctly.
891 A useful variation of the above is the target C<testdb>. It runs the
892 test under the Perl debugger (see L<perldebug>). If the file
893 F<test.pl> exists in the current directory, it is used for the test.
895 If you want to debug some other testfile, set C<TEST_FILE> variable
898 make testdb TEST_FILE=t/mytest.t
900 By default the debugger is called using C<-d> option to perl. If you
901 want to specify some other option, set C<TESTDB_SW> variable:
903 make testdb TESTDB_SW=-Dx
907 make alone puts all relevant files into directories that are named by
908 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_MAN1DIR and
909 INST_MAN3DIR. All these default to something below ./blib if you are
910 I<not> building below the perl source directory. If you I<are>
911 building below the perl source, INST_LIB and INST_ARCHLIB default to
912 ../../lib, and INST_SCRIPT is not defined.
914 The I<install> target of the generated Makefile copies the files found
915 below each of the INST_* directories to their INSTALL*
916 counterparts. Which counterparts are chosen depends on the setting of
917 INSTALLDIRS according to the following table:
922 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH
923 INST_LIB INSTALLPRIVLIB INSTALLSITELIB
925 INST_SCRIPT INSTALLSCRIPT
926 INST_MAN1DIR INSTALLMAN1DIR
927 INST_MAN3DIR INSTALLMAN3DIR
929 The INSTALL... macros in turn default to their %Config
930 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
932 You can check the values of these variables on your system with
936 And to check the sequence in which the library directories are
937 searched by perl, run
939 perl -le 'print join $/, @INC'
942 =head2 PREFIX and LIB attribute
944 PREFIX and LIB can be used to set several INSTALL* attributes in one
945 go. The quickest way to install a module in a non-standard place might
948 perl Makefile.PL PREFIX=~
950 This will install all files in the module under your home directory,
951 with man pages and libraries going into an appropriate place (usually
954 Another way to specify many INSTALL directories with a single
957 perl Makefile.PL LIB=~/lib
959 This will install the module's architecture-independent files into
960 ~/lib, the architecture-dependent files into ~/lib/$archname.
962 Note, that in both cases the tilde expansion is done by MakeMaker, not
963 by perl by default, nor by make.
965 Conflicts between parameters LIB, PREFIX and the various INSTALL*
966 arguments are resolved so that:
972 setting LIB overrides any setting of INSTALLPRIVLIB, INSTALLARCHLIB,
973 INSTALLSITELIB, INSTALLSITEARCH (and they are not affected by PREFIX);
977 without LIB, setting PREFIX replaces the initial C<$Config{prefix}>
978 part of those INSTALL* arguments, even if the latter are explicitly
979 set (but are set to still start with C<$Config{prefix}>).
983 If the user has superuser privileges, and is not working on AFS or
984 relatives, then the defaults for INSTALLPRIVLIB, INSTALLARCHLIB,
985 INSTALLSCRIPT, etc. will be appropriate, and this incantation will be
988 perl Makefile.PL; make; make test
991 make install per default writes some documentation of what has been
992 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
993 can be bypassed by calling make pure_install.
997 will have to specify the installation directories as these most
998 probably have changed since perl itself has been installed. They will
999 have to do this by calling
1001 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1002 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1005 Be careful to repeat this procedure every time you recompile an
1006 extension, unless you are sure the AFS installation directories are
1009 =head2 Static Linking of a new Perl Binary
1011 An extension that is built with the above steps is ready to use on
1012 systems supporting dynamic loading. On systems that do not support
1013 dynamic loading, any newly created extension has to be linked together
1014 with the available resources. MakeMaker supports the linking process
1015 by creating appropriate targets in the Makefile whenever an extension
1016 is built. You can invoke the corresponding section of the makefile with
1020 That produces a new perl binary in the current directory with all
1021 extensions linked in that can be found in INST_ARCHLIB, SITELIBEXP,
1022 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1023 UNIX, this is called Makefile.aperl (may be system dependent). If you
1024 want to force the creation of a new perl, it is recommended, that you
1025 delete this Makefile.aperl, so the directories are searched-through
1026 for linkable libraries again.
1028 The binary can be installed into the directory where perl normally
1029 resides on your machine with
1033 To produce a perl binary with a different name than C<perl>, either say
1035 perl Makefile.PL MAP_TARGET=myperl
1042 make myperl MAP_TARGET=myperl
1043 make inst_perl MAP_TARGET=myperl
1045 In any case you will be prompted with the correct invocation of the
1046 C<inst_perl> target that installs the new binary into INSTALLBIN.
1048 make inst_perl per default writes some documentation of what has been
1049 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1050 can be bypassed by calling make pure_inst_perl.
1052 Warning: the inst_perl: target will most probably overwrite your
1053 existing perl binary. Use with care!
1055 Sometimes you might want to build a statically linked perl although
1056 your system supports dynamic loading. In this case you may explicitly
1057 set the linktype with the invocation of the Makefile.PL or make:
1059 perl Makefile.PL LINKTYPE=static # recommended
1063 make LINKTYPE=static # works on most systems
1065 =head2 Determination of Perl Library and Installation Locations
1067 MakeMaker needs to know, or to guess, where certain things are
1068 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1069 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1070 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1072 Extensions may be built either using the contents of the perl source
1073 directory tree or from the installed perl library. The recommended way
1074 is to build extensions after you have run 'make install' on perl
1075 itself. You can do that in any directory on your hard disk that is not
1076 below the perl source tree. The support for extensions below the ext
1077 directory of the perl distribution is only good for the standard
1078 extensions that come with perl.
1080 If an extension is being built below the C<ext/> directory of the perl
1081 source then MakeMaker will set PERL_SRC automatically (e.g.,
1082 C<../..>). If PERL_SRC is defined and the extension is recognized as
1083 a standard extension, then other variables default to the following:
1086 PERL_LIB = PERL_SRC/lib
1087 PERL_ARCHLIB = PERL_SRC/lib
1089 INST_ARCHLIB = PERL_ARCHLIB
1091 If an extension is being built away from the perl source then MakeMaker
1092 will leave PERL_SRC undefined and default to using the installed copy
1093 of the perl library. The other variables default to the following:
1095 PERL_INC = $archlibexp/CORE
1096 PERL_LIB = $privlibexp
1097 PERL_ARCHLIB = $archlibexp
1098 INST_LIB = ./blib/lib
1099 INST_ARCHLIB = ./blib/arch
1101 If perl has not yet been installed then PERL_SRC can be defined on the
1102 command line as shown in the previous section.
1105 =head2 Which architecture dependent directory?
1107 If you don't want to keep the defaults for the INSTALL* macros,
1108 MakeMaker helps you to minimize the typing needed: the usual
1109 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1110 by Configure at perl compilation time. MakeMaker supports the user who
1111 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1112 then MakeMaker defaults the latter to be the same subdirectory of
1113 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1114 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1115 for INSTALLSITELIB and INSTALLSITEARCH.
1117 MakeMaker gives you much more freedom than needed to configure
1118 internal variables and get different results. It is worth to mention,
1119 that make(1) also lets you configure most of the variables that are
1120 used in the Makefile. But in the majority of situations this will not
1121 be necessary, and should only be done if the author of a package
1122 recommends it (or you know what you're doing).
1124 =head2 Using Attributes and Parameters
1126 The following attributes can be specified as arguments to WriteMakefile()
1127 or as NAME=VALUE pairs on the command line:
1133 One line description of the module. Will be included in PPD file.
1137 Name of the file that contains the package description. MakeMaker looks
1138 for a line in the POD matching /^($package\s-\s)(.*)/. This is typically
1139 the first line in the "=head1 NAME" section. $2 becomes the abstract.
1143 String containing name (and email address) of package author(s). Is used
1144 in PPD (Perl Package Description) files for PPM (Perl Package Manager).
1146 =item BINARY_LOCATION
1148 Used when creating PPD files for binary packages. It can be set to a
1149 full or relative path or URL to the binary archive for a particular
1150 architecture. For example:
1152 perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
1154 builds a PPD package that references a binary of the C<Agent> package,
1155 located in the C<x86> directory relative to the PPD itself.
1159 Ref to array of *.c file names. Initialised from a directory scan
1160 and the values portion of the XS attribute hash. This is not
1161 currently used by MakeMaker but may be handy in Makefile.PLs.
1165 String that will be included in the compiler call command line between
1166 the arguments INC and OPTIMIZE.
1170 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1171 config.sh. MakeMaker will add to CONFIG the following values anyway:
1191 CODE reference. The subroutine should return a hash reference. The
1192 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1193 be determined by some evaluation method.
1197 Something like C<"-DHAVE_UNISTD_H">
1201 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1206 Your name for distributing the package (by tar file). This defaults to
1211 Hashref of symbol names for routines to be made available as universal
1212 symbols. Each key/value pair consists of the package name and an
1213 array of routine names in that package. Used only under AIX, OS/2,
1214 VMS and Win32 at present. The routine names supplied will be expanded
1215 in the same way as XSUB names are expanded by the XS() macro.
1218 {"$(NAME)" => ["boot_$(NAME)" ] }
1222 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1223 "NetconfigPtr" => [ 'DESTROY'] }
1225 Please see the L<ExtUtils::Mksymlists> documentation for more information
1226 about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
1230 Array of symbol names for variables to be made available as universal symbols.
1231 Used only under AIX, OS/2, VMS and Win32 at present. Defaults to [].
1232 (e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
1236 Array of extension names to exclude when doing a static build. This
1237 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1238 details. (e.g. [ qw( Socket POSIX ) ] )
1240 This attribute may be most useful when specified as a string on the
1241 command line: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1245 Ref to array of executable files. The files will be copied to the
1246 INST_SCRIPT directory. Make realclean will delete them from there
1249 =item FIRST_MAKEFILE
1251 The name of the Makefile to be produced. Defaults to the contents of
1252 MAKEFILE, but can be overridden. This is used for the second Makefile
1253 that will be produced for the MAP_TARGET.
1257 Perl binary able to run this extension.
1261 This provides an alternate means to specify function names to be
1262 exported from the extension. Its value is a reference to an
1263 array of function names to be exported by the extension. These
1264 names are passed through unaltered to the linker options file.
1268 Ref to array of *.h file names. Similar to C.
1272 This attribute is used to specify names to be imported into the
1273 extension. It is only used on OS/2 and Win32.
1277 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1281 Array of extension names to be included when doing a static build.
1282 MakeMaker will normally build with all of the installed extensions when
1283 doing a static build, and that is usually the desired behavior. If
1284 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1285 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1287 It is not necessary to mention DynaLoader or the current extension when
1288 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1289 only DynaLoader and the current extension will be included in the build.
1291 This attribute may be most useful when specified as a string on the
1292 command line: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1294 =item INSTALLARCHLIB
1296 Used by 'make install', which copies files from INST_ARCHLIB to this
1297 directory if INSTALLDIRS is set to perl.
1301 Directory to install binary files (e.g. tkperl) into.
1305 Determines which of the two sets of installation directories to
1306 choose: installprivlib and installarchlib versus installsitelib and
1307 installsitearch. The first pair is chosen with INSTALLDIRS=perl, the
1308 second with INSTALLDIRS=site. Default is site.
1310 =item INSTALLMAN1DIR
1312 This directory gets the man pages at 'make install' time. Defaults to
1313 $Config{installman1dir}.
1315 =item INSTALLMAN3DIR
1317 This directory gets the man pages at 'make install' time. Defaults to
1318 $Config{installman3dir}.
1320 =item INSTALLPRIVLIB
1322 Used by 'make install', which copies files from INST_LIB to this
1323 directory if INSTALLDIRS is set to perl.
1327 Used by 'make install' which copies files from INST_SCRIPT to this
1330 =item INSTALLSITEARCH
1332 Used by 'make install', which copies files from INST_ARCHLIB to this
1333 directory if INSTALLDIRS is set to site (default).
1335 =item INSTALLSITELIB
1337 Used by 'make install', which copies files from INST_LIB to this
1338 directory if INSTALLDIRS is set to site (default).
1342 Same as INST_LIB for architecture dependent files.
1346 Directory to put real binary files during 'make'. These will be copied
1347 to INSTALLBIN during 'make install'
1351 Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you
1356 Directory where we put library files of this extension while building
1361 Directory to hold the man pages at 'make' time
1365 Directory to hold the man pages at 'make' time
1369 Directory, where executable files should be installed during
1370 'make'. Defaults to "./blib/script", just to have a dummy location during
1371 testing. make install will copy the files in INST_SCRIPT to
1376 defaults to "$(OBJECT)" and is used in the ld command to specify
1377 what files to link/load from (also see dynamic_lib below for how to
1382 LIB should only be set at C<perl Makefile.PL> time but is allowed as a
1383 MakeMaker argument. It has the effect of setting both INSTALLPRIVLIB
1384 and INSTALLSITELIB to that value regardless any explicit setting of
1385 those arguments (or of PREFIX). INSTALLARCHLIB and INSTALLSITEARCH
1386 are set to the corresponding architecture subdirectory.
1390 The filename of the perllibrary that will be used together with this
1391 extension. Defaults to libperl.a.
1395 An anonymous array of alternative library
1396 specifications to be searched for (in order) until
1397 at least one library is found. E.g.
1399 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1401 Mind, that any element of the array
1402 contains a complete set of arguments for the ld
1403 command. So do not specify
1405 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1407 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1408 you specify a scalar as in
1410 'LIBS' => "-ltcl -ltk -lX11"
1412 MakeMaker will turn it into an array with one element.
1416 'static' or 'dynamic' (default unless usedl=undef in
1417 config.sh). Should only be used to force static linking (also see
1422 Boolean which tells MakeMaker, that it should include the rules to
1423 make a perl. This is handled automatically as a switch by
1424 MakeMaker. The user normally does not need it.
1428 The name of the Makefile to be produced.
1432 Hashref of pod-containing files. MakeMaker will default this to all
1433 EXE_FILES files that include POD directives. The files listed
1434 here will be converted to man pages and installed as was requested
1439 Hashref that assigns to *.pm and *.pod files the files into which the
1440 manpages are to be written. MakeMaker parses all *.pod and *.pm files
1441 for POD directives. Files that contain POD will be the default keys of
1442 the MAN3PODS hashref. These will then be converted to man pages during
1443 C<make> and will be installed during C<make install>.
1447 If it is intended, that a new perl binary be produced, this variable
1448 may hold a name for that binary. Defaults to perl
1452 If the extension links to a library that it builds set this to the
1453 name of the library (see SDBM_File)
1457 Perl module name for this extension (DBD::Oracle). This will default
1458 to the directory name but should be explicitly defined in the
1463 MakeMaker will figure out if an extension contains linkable code
1464 anywhere down the directory tree, and will set this variable
1465 accordingly, but you can speed it up a very little bit if you define
1466 this boolean variable yourself.
1470 Defaults to C<@>. By setting it to an empty string you can generate a
1471 Makefile that echos all commands. Mainly used in debugging MakeMaker
1476 Boolean. Attribute to inhibit descending into subdirectories.
1480 In general, any generated Makefile checks for the current version of
1481 MakeMaker and the version the Makefile was built under. If NO_VC is
1482 set, the version check is neglected. Do not write this into your
1483 Makefile.PL, use it interactively instead.
1487 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1488 string containing all object files, e.g. "tkpBind.o
1489 tkpButton.o tkpCanvas.o"
1491 (Where BASEEXT is the last component of NAME, and OBJ_EXT is $Config{obj_ext}.)
1495 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1496 passed to subdirectory makes.
1500 Perl binary for tasks that can be done by miniperl
1504 Set only when MakeMaker is building the extensions of the Perl core
1509 The call to the program that is able to compile perlmain.c. Defaults
1514 Same as for PERL_LIB, but for architecture dependent files.
1516 Used only when MakeMaker is building the extensions of the Perl core
1517 distribution (because normally $(PERL_ARCHLIB) is automatically in @INC,
1518 and adding it would get in the way of PERL5LIB).
1522 Directory containing the Perl library to use.
1524 Used only when MakeMaker is building the extensions of the Perl core
1525 distribution (because normally $(PERL_LIB) is automatically in @INC,
1526 and adding it would get in the way of PERL5LIB).
1528 =item PERL_MALLOC_OK
1530 defaults to 0. Should be set to TRUE if the extension can work with
1531 the memory allocation routines substituted by the Perl malloc() subsystem.
1532 This should be applicable to most extensions with exceptions of those
1538 with bugs in memory allocations which are caught by Perl's malloc();
1542 which interact with the memory allocator in other ways than via
1543 malloc(), realloc(), free(), calloc(), sbrk() and brk();
1547 which rely on special alignment which is not provided by Perl's malloc().
1551 B<NOTE.> Negligence to set this flag in I<any one> of loaded extension
1552 nullifies many advantages of Perl's malloc(), such as better usage of
1553 system resources, error detection, memory usage reporting, catchable failure
1554 of memory allocations, etc.
1558 Use this instead of $(PERL) or $(FULLPERL) when you wish to run perl.
1559 It will set up extra necessary flags for you.
1563 Use this instead of $(PERL) or $(FULLPERL) when you wish to run
1564 perl to work with modules. It will add things like -I$(INST_ARCH)
1565 and other necessary flags.
1569 Directory containing the Perl source code (use of this should be
1570 avoided, it may be undefined)
1574 Desired permission for read/writable files. Defaults to C<644>.
1575 See also L<MM_Unix/perm_rw>.
1579 Desired permission for executable files. Defaults to C<755>.
1580 See also L<MM_Unix/perm_rwx>.
1584 Ref to hash of files to be processed as perl programs. MakeMaker
1585 will default to any found *.PL file (except Makefile.PL) being keys
1586 and the basename of the file being the value. E.g.
1588 {'foobar.PL' => 'foobar'}
1590 The *.PL files are expected to produce output to the target files
1591 themselves. If multiple files can be generated from the same *.PL
1592 file then the value in the hash can be a reference to an array of
1593 target file names. E.g.
1595 {'foobar.PL' => ['foobar1','foobar2']}
1599 Hashref of .pm files and *.pl files to be installed. e.g.
1601 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1603 By default this will include *.pm and *.pl and the files found in
1604 the PMLIBDIRS directories. Defining PM in the
1605 Makefile.PL will override PMLIBDIRS.
1609 Ref to array of subdirectories containing library files. Defaults to
1610 [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
1611 they contain will be installed in the corresponding location in the
1612 library. A libscan() method can be used to alter the behaviour.
1613 Defining PM in the Makefile.PL will override PMLIBDIRS.
1615 (Where BASEEXT is the last component of NAME.)
1619 A filter program, in the traditional Unix sense (input from stdin, output
1620 to stdout) that is passed on each .pm file during the build (in the
1621 pm_to_blib() phase). It is empty by default, meaning no filtering is done.
1623 Great care is necessary when defining the command if quoting needs to be
1624 done. For instance, you would need to say:
1626 {'PM_FILTER' => 'grep -v \\"^\\#\\"'}
1628 to remove all the leading coments on the fly during the build. The
1629 extra \\ are necessary, unfortunately, because this variable is interpolated
1630 within the context of a Perl program built on the command line, and double
1631 quotes are what is used with the -e switch to build that command line. The
1632 # is escaped for the Makefile, since what is going to be generated will then
1635 PM_FILTER = grep -v \"^\#\"
1637 Without the \\ before the #, we'd have the start of a Makefile comment,
1638 and the macro would be incorrectly defined.
1642 Release 5.005 grandfathered old global symbol names by providing preprocessor
1643 macros for extension source compatibility. As of release 5.6, these
1644 preprocessor definitions are not available by default. The POLLUTE flag
1645 specifies that the old names should still be defined:
1647 perl Makefile.PL POLLUTE=1
1649 Please inform the module author if this is necessary to successfully install
1650 a module under 5.6 or later.
1652 =item PPM_INSTALL_EXEC
1654 Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl)
1656 =item PPM_INSTALL_SCRIPT
1658 Name of the script that gets executed by the Perl Package Manager after
1659 the installation of a package.
1663 This overrides all the default install locations. Man pages,
1664 libraries, scripts, etc... MakeMaker will try to make an educated
1665 guess about where to place things under the new PREFIX based on your
1666 Config defaults. Failing that, it will fall back to a structure
1667 which should be sensible for your platform.
1669 If you specify LIB or any INSTALL* variables they will not be effected
1674 Hashref: Names of modules that need to be available to run this
1675 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1676 desired version is the value. If the required version number is 0, we
1677 only check if any version is installed already.
1681 Bool. If this parameter is true, failing to have the required modules
1682 (or the right versions thereof) will be fatal. perl Makefile.PL will die
1683 with the proper message.
1685 Note: see L<Test::Harness> for a shortcut for stopping tests early if
1686 you are missing dependencies.
1688 Do I<not> use this parameter for simple requirements, which could be resolved
1689 at a later time, e.g. after an unsuccessful B<make test> of your module.
1691 It is I<extremely> rare to have to use C<PREREQ_FATAL> at all!
1695 Bool. If this parameter is true, the prerequisites will be printed to
1696 stdout and MakeMaker will exit. The output format is
1706 RedHatism for C<PREREQ_PRINT>. The output format is different, though:
1708 perl(A::B)>=Vers1 perl(C::D)>=Vers2 ...
1712 Arrayref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1713 Makefile. Caution! Do not use the SKIP attribute for the negligible
1714 speedup. It may seriously damage the resulting Makefile. Only use it
1715 if you really need it.
1719 The set of -I's necessary to run a "make test". Use as:
1720 $(PERL) $(TEST_LIBS) -e '...' for example.
1722 The paths will be absolute.
1726 Ref to array of typemap file names. Use this when the typemaps are
1727 in some directory other than the current directory or when they are
1728 not named B<typemap>. The last typemap in the list takes
1729 precedence. A typemap in the current directory has highest
1730 precedence, even if it isn't listed in TYPEMAPS. The default system
1731 typemap has lowest precedence.
1735 Your version number for distributing the package. This defaults to
1740 Instead of specifying the VERSION in the Makefile.PL you can let
1741 MakeMaker parse a file to determine the version number. The parsing
1742 routine requires that the file named by VERSION_FROM contains one
1743 single line to compute the version number. The first line in the file
1744 that contains the regular expression
1746 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
1748 will be evaluated with eval() and the value of the named variable
1749 B<after> the eval() will be assigned to the VERSION attribute of the
1750 MakeMaker object. The following lines will be parsed o.k.:
1754 ( $VERSION ) = '$Revision: 1.19 $ ' =~ /\$Revision:\s+([^\s]+)/;
1755 $FOO::VERSION = '1.10';
1756 *FOO::VERSION = \'1.11';
1757 our $VERSION = 1.2.3; # new for perl5.6.0
1759 but these will fail:
1761 my $VERSION = '1.01';
1762 local $VERSION = '1.02';
1763 local $FOO::VERSION = '1.30';
1765 (Putting C<my> or C<local> on the preceding line will work o.k.)
1767 The file named in VERSION_FROM is not added as a dependency to
1768 Makefile. This is not really correct, but it would be a major pain
1769 during development to have to rewrite the Makefile for any smallish
1770 change in that file. If you want to make sure that the Makefile
1771 contains the correct VERSION macro after any change of the file, you
1772 would have to do something like
1774 depend => { Makefile => '$(VERSION_FROM)' }
1776 See attribute C<depend> below.
1780 Hashref of .xs files. MakeMaker will default this. e.g.
1782 {'name_of_file.xs' => 'name_of_file.c'}
1784 The .c files will automatically be included in the list of files
1785 deleted by a make clean.
1789 String of options to pass to xsubpp. This might include C<-C++> or
1790 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
1795 May be set to an empty string, which is identical to C<-prototypes>, or
1796 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
1797 defaults to the empty string.
1801 Your version number for the .xs file of this package. This defaults
1802 to the value of the VERSION attribute.
1806 =head2 Additional lowercase attributes
1808 can be used to pass parameters to the methods which implement that
1809 part of the Makefile.
1815 {FILES => "*.xyz foo"}
1819 {ANY_TARGET => ANY_DEPENDECY, ...}
1821 (ANY_TARGET must not be given a double-colon rule by MakeMaker.)
1825 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
1826 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
1827 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
1829 If you specify COMPRESS, then SUFFIX should also be altered, as it is
1830 needed to tell make the target file of the compression. Setting
1831 DIST_CP to ln can be useful, if you need to preserve the timestamps on
1832 your files. DIST_CP can take the values 'cp', which copies the file,
1833 'ln', which links the file, and 'best' which copies symbolic links and
1834 links the rest. Default is 'best'.
1838 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
1842 {LINKTYPE => 'static', 'dynamic' or ''}
1844 NB: Extensions that have nothing but *.pm files had to say
1848 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1849 can be deleted safely. MakeMaker recognizes when there's nothing to
1854 {ANY_MACRO => ANY_VALUE, ...}
1858 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
1864 =item tool_autosplit
1870 =head2 Overriding MakeMaker Methods
1872 If you cannot achieve the desired Makefile behaviour by specifying
1873 attributes you may define private subroutines in the Makefile.PL.
1874 Each subroutines returns the text it wishes to have written to
1875 the Makefile. To override a section of the Makefile you can
1878 sub MY::c_o { "new literal text" }
1880 or you can edit the default by saying something like:
1883 package MY; # so that "SUPER" works right
1884 my $inherited = shift->SUPER::c_o(@_);
1885 $inherited =~ s/old text/new text/;
1889 If you are running experiments with embedding perl as a library into
1890 other applications, you might find MakeMaker is not sufficient. You'd
1891 better have a look at ExtUtils::Embed which is a collection of utilities
1894 If you still need a different solution, try to develop another
1895 subroutine that fits your needs and submit the diffs to
1896 F<perl5-porters@perl.org> or F<comp.lang.perl.moderated> as appropriate.
1898 For a complete description of all MakeMaker methods see L<ExtUtils::MM_Unix>.
1900 Here is a simple example of how to add a new target to the generated
1905 $(MYEXTLIB): sdbm/Makefile
1906 cd sdbm && $(MAKE) all
1911 =head2 Hintsfile support
1913 MakeMaker.pm uses the architecture specific information from
1914 Config.pm. In addition it evaluates architecture specific hints files
1915 in a C<hints/> directory. The hints files are expected to be named
1916 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
1917 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
1918 MakeMaker within the WriteMakefile() subroutine, and can be used to
1919 execute commands as well as to include special variables. The rules
1920 which hintsfile is chosen are the same as in Configure.
1922 The hintsfile is eval()ed immediately after the arguments given to
1923 WriteMakefile are stuffed into a hash reference $self but before this
1924 reference becomes blessed. So if you want to do the equivalent to
1925 override or create an attribute you would say something like
1927 $self->{LIBS} = ['-ldbm -lucb -lc'];
1929 =head2 Distribution Support
1931 For authors of extensions MakeMaker provides several Makefile
1932 targets. Most of the support comes from the ExtUtils::Manifest module,
1933 where additional documentation can be found.
1937 =item make distcheck
1939 reports which files are below the build directory but not in the
1940 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
1943 =item make skipcheck
1945 reports which files are skipped due to the entries in the
1946 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
1949 =item make distclean
1951 does a realclean first and then the distcheck. Note that this is not
1952 needed to build a new distribution as long as you are sure that the
1953 MANIFEST file is ok.
1957 rewrites the MANIFEST file, adding all remaining files found (See
1958 ExtUtils::Manifest::mkmanifest() for details)
1962 Copies all the files that are in the MANIFEST file to a newly created
1963 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
1964 exists, it will be removed first.
1968 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
1969 a make test in that directory.
1973 First does a distdir. Then a command $(PREOP) which defaults to a null
1974 command, followed by $(TOUNIX), which defaults to a null command under
1975 UNIX, and will convert files in distribution directory to UNIX format
1976 otherwise. Next it runs C<tar> on that directory into a tarfile and
1977 deletes the directory. Finishes with a command $(POSTOP) which
1978 defaults to a null command.
1982 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
1984 =item make uutardist
1986 Runs a tardist first and uuencodes the tarfile.
1990 First does a distdir. Then a command $(PREOP) which defaults to a null
1991 command. Next it runs C<shar> on that directory into a sharfile and
1992 deletes the intermediate directory again. Finishes with a command
1993 $(POSTOP) which defaults to a null command. Note: For shdist to work
1994 properly a C<shar> program that can handle directories is mandatory.
1998 First does a distdir. Then a command $(PREOP) which defaults to a null
1999 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
2000 zipfile. Then deletes that directory. Finishes with a command
2001 $(POSTOP) which defaults to a null command.
2005 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
2009 Customization of the dist targets can be done by specifying a hash
2010 reference to the dist attribute of the WriteMakefile call. The
2011 following parameters are recognized:
2014 COMPRESS ('gzip --best')
2017 TO_UNIX (depends on the system)
2018 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
2028 WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" })
2030 =head2 Disabling an extension
2032 If some events detected in F<Makefile.PL> imply that there is no way
2033 to create the Module, but this is a normal state of things, then you
2034 can create a F<Makefile> which does nothing, but succeeds on all the
2035 "usual" build targets. To do so, use
2037 ExtUtils::MakeMaker::WriteEmptyMakefile();
2039 instead of WriteMakefile().
2041 This may be useful if other modules expect this module to be I<built>
2042 OK, as opposed to I<work> OK (say, this system-dependent module builds
2043 in a subdirectory of some other distribution, or is listed as a
2044 dependency in a CPAN::Bundle, but the functionality is supported by
2045 different means on the current architecture).
2053 Command line options used by C<MakeMaker-E<gt>new()>, and thus by
2054 C<WriteMakefile()>. The string is split on whitespace, and the result
2055 is processed before any actual command line arguments are processed.
2057 =item PERL_MM_USE_DEFAULT
2059 If set to a true value then MakeMaker's prompt function will
2060 always return the default without waiting for user input.
2066 ExtUtils::MM_Unix, ExtUtils::Manifest ExtUtils::Install,
2071 Andy Dougherty <F<doughera@lafcol.lafayette.edu>>, Andreas KE<ouml>nig
2072 <F<andreas.koenig@mind.de>>, Tim Bunce <F<Tim.Bunce@ig.co.uk>>. VMS
2073 support by Charles Bailey <F<bailey@newman.upenn.edu>>. OS/2 support
2074 by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>.
2076 Currently maintained by Michael G Schwern <F<schwern@pobox.com>>
2078 Send patches and ideas to <F<makemaker@perl.org>>.
2080 Send bug reports via http://rt.cpan.org/.