1 package ExtUtils::MakeMaker;
3 BEGIN {require 5.005_03;}
6 ($Revision) = q$Revision: 1.124 $ =~ /Revision:\s+(\S+)/;
14 @ISA @EXPORT @EXPORT_OK
15 $Revision $VERSION $Verbose %Config
16 @Prepend_parent @Parent
17 %Recognized_Att_Keys @Get_from_Config @MM_Sections @Overridable
23 @EXPORT = qw(&WriteMakefile &writeMakefile $Verbose &prompt);
24 @EXPORT_OK = qw($VERSION &neatvalue &mkbootstrap &mksymlists);
26 # These will go away once the last of the Win32 & VMS specific code is
28 my $Is_VMS = $^O eq 'VMS';
29 my $Is_Win32 = $^O eq 'MSWin32';
31 # Our filename for diagnostic and debugging purposes. More reliable
32 # than %INC (think caseless filesystems)
37 require ExtUtils::MM; # Things like CPAN assume loading ExtUtils::MakeMaker
40 require ExtUtils::MY; # XXX pre-5.8 versions of ExtUtils::Embed expect
41 # loading ExtUtils::MakeMaker will give them MY.
42 # This will go when Embed is it's own CPAN module.
46 Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
53 my $mm = MM->new(\%att);
60 # Basic signatures of the attributes WriteMakefile takes. Each is the
61 # reference type. Empty value indicate it takes a non-reference
71 EXCLUDE_EXT => 'array',
76 INCLUDE_EXT => 'array',
87 _KEEP_AFTER_FLUSH => '',
98 tool_autosplit => 'hash',
101 @Att_Sigs{keys %Recognized_Att_Keys} = ('') x keys %Recognized_Att_Keys;
102 @Att_Sigs{keys %Special_Sigs} = values %Special_Sigs;
108 while( my($key, $val) = each %$att ) {
109 my $sig = $Att_Sigs{$key};
110 unless( defined $sig ) {
111 warn "WARNING: $key is not a known parameter.\n";
115 my @sigs = ref $sig ? @$sig : $sig;
116 my $given = lc ref $val;
117 unless( grep $given eq $_, @sigs ) {
118 my $takes = join " or ", map { $_ ne '' ? "$_ reference"
121 my $has = $given ne '' ? "$given reference"
123 warn "WARNING: $key takes a $takes not a $has.\n".
124 " Please inform the author.\n";
130 my($mess, $def) = @_;
131 Carp::confess("prompt function called without an argument")
132 unless defined $mess;
134 my $isa_tty = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ;
136 my $dispdef = defined $def ? "[$def] " : " ";
137 $def = defined $def ? $def : "";
141 print "$mess $dispdef";
144 if ($ENV{PERL_MM_USE_DEFAULT} || (!$isa_tty && eof STDIN)) {
152 else { # user hit ctrl-D
157 return (!defined $ans || $ans eq '') ? $def : $ans;
160 sub eval_in_subdirs {
162 use Cwd qw(cwd abs_path);
163 my $pwd = cwd() || die "Can't figure out your cwd!";
165 local @INC = map eval {abs_path($_) if -e} || $_, @INC;
166 push @INC, '.'; # '.' has to always be at the end of @INC
168 foreach my $dir (@{$self->{DIR}}){
169 my($abs) = $self->catdir($pwd,$dir);
170 $self->eval_in_x($abs);
177 chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
184 # if ($@ =~ /prerequisites/) {
185 # die "MakeMaker WARNING: $@";
187 # warn "WARNING from evaluation of $dir/Makefile.PL: $@";
189 die "ERROR from evaluation of $dir/Makefile.PL: $@";
194 # package name for the classes into which the first object will be blessed
195 my $PACKNAME = 'PACK000';
200 my @attrib_help = qw/
202 AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION
203 C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
204 EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE
205 FULLPERL FULLPERLRUN FULLPERLRUNINST
208 INST_ARCHLIB INST_SCRIPT INST_BIN INST_LIB INST_MAN1DIR INST_MAN3DIR
211 PERLPREFIX SITEPREFIX VENDORPREFIX
212 INSTALLPRIVLIB INSTALLSITELIB INSTALLVENDORLIB
213 INSTALLARCHLIB INSTALLSITEARCH INSTALLVENDORARCH
214 INSTALLBIN INSTALLSITEBIN INSTALLVENDORBIN
215 INSTALLMAN1DIR INSTALLMAN3DIR
216 INSTALLSITEMAN1DIR INSTALLSITEMAN3DIR
217 INSTALLVENDORMAN1DIR INSTALLVENDORMAN3DIR
219 PERL_LIB PERL_ARCHLIB
220 SITELIBEXP SITEARCHEXP
222 INC INCLUDE_EXT LDFROM LIB LIBPERL_A LIBS
223 LINKTYPE MAKEAPERL MAKEFILE MAKEFILE_OLD MAN1PODS MAN3PODS MAP_TARGET
224 MYEXTLIB NAME NEEDS_LINKING NOECHO NO_META NORECURS NO_VC OBJECT OPTIMIZE
225 PERL_MALLOC_OK PERL PERLMAINCC PERLRUN PERLRUNINST PERL_CORE
226 PERL_SRC PERM_RW PERM_RWX
227 PL_FILES PM PM_FILTER PMLIBDIRS POLLUTE PPM_INSTALL_EXEC
228 PPM_INSTALL_SCRIPT PREREQ_FATAL PREREQ_PM PREREQ_PRINT PRINT_PREREQ
229 SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
230 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
233 MACPERL_SRC MACPERL_LIB MACLIBS_68K MACLIBS_PPC MACLIBS_SC MACLIBS_MRC
234 MACLIBS_ALL_68K MACLIBS_ALL_PPC MACLIBS_SHARED
237 # IMPORTS is used under OS/2 and Win32
239 # @Overridable is close to @MM_Sections but not identical. The
240 # order is important. Many subroutines declare macros. These
241 # depend on each other. Let's try to collect the macros up front,
242 # then pasthru, then the rules.
244 # MM_Sections are the sections we have to call explicitly
245 # in Overridable we have subroutines that are used indirectly
251 post_initialize const_config constants platform_constants
252 tool_autosplit tool_xsubpp tools_other
256 dist macro depend cflags const_loadlibs const_cccmd
263 top_targets linkext dlsyms dynamic dynamic_bs
264 dynamic_lib static static_lib manifypods processPL
266 clean_subdirs clean realclean_subdirs realclean
267 metafile metafile_addtomanifest
268 dist_basics dist_core distdir dist_test dist_ci
269 install force perldepend makefile staticmake test ppd
271 ); # loses section ordering
273 @Overridable = @MM_Sections;
274 push @Overridable, qw[
276 dir_target libscan makeaperl needs_linking perm_rw perm_rwx
277 subdir_x test_via_harness test_via_script init_PERL
280 push @MM_Sections, qw[
282 pm_to_blib selfdocument
286 # Postamble needs to be the last that was always the case
287 push @MM_Sections, "postamble";
288 push @Overridable, "postamble";
290 # All sections are valid keys.
291 @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
293 # we will use all these variables in the Makefile
296 ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc
297 lib_ext obj_ext osname osvers ranlib sitelibexp sitearchexp so
301 # 5.5.3 doesn't have any concept of vendor libs
302 push @Get_from_Config, qw( vendorarchexp vendorlibexp ) if $] >= 5.006;
304 foreach my $item (@attrib_help){
305 $Recognized_Att_Keys{$item} = 1;
307 foreach my $item (@Get_from_Config) {
308 $Recognized_Att_Keys{uc $item} = $Config{$item};
309 print "Attribute '\U$item\E' => '$Config{$item}'\n"
314 # When we eval a Makefile.PL in a subdirectory, that one will ask
315 # us (the parent) for the values and will prepend "..", so that
316 # all files to be installed end up below OUR ./blib
318 @Prepend_parent = qw(
319 INST_BIN INST_LIB INST_ARCHLIB INST_SCRIPT
320 MAP_TARGET INST_MAN1DIR INST_MAN3DIR PERL_SRC
328 The extension you are trying to build apparently is rather old and
329 most probably outdated. We detect that from the fact, that a
330 subroutine "writeMakefile" is called, and this subroutine is not
331 supported anymore since about October 1994.
333 Please contact the author or look into CPAN (details about CPAN can be
334 found in the FAQ and at http:/www.perl.com) for a more recent version
335 of the extension. If you're really desperate, you can try to change
336 the subroutine name from writeMakefile to WriteMakefile and rerun
337 'perl Makefile.PL', but you're most probably left alone, when you do
346 my($class,$self) = @_;
349 # Store the original args passed to WriteMakefile()
350 foreach my $k (keys %$self) {
351 $self->{ARGS}{$k} = $self->{$k};
354 if ("@ARGV" =~ /\bPREREQ_PRINT\b/) {
355 require Data::Dumper;
356 print Data::Dumper->Dump([$self->{PREREQ_PM}], [qw(PREREQ_PM)]);
359 # PRINT_PREREQ is RedHatism.
360 if ("@ARGV" =~ /\bPRINT_PREREQ\b/) {
361 print join(" ", map { "perl($_)>=$self->{PREREQ_PM}->{$_} " } sort keys %{$self->{PREREQ_PM}}), "\n";
365 print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
366 if (-f "MANIFEST" && ! -f "Makefile"){
370 $self = {} unless (defined $self);
374 my %configure_att; # record &{$self->{CONFIGURE}} attributes
375 my(%initial_att) = %$self; # record initial attributes
377 my(%unsatisfied) = ();
378 foreach my $prereq (sort keys %{$self->{PREREQ_PM}}) {
379 # 5.8.0 has a bug with require Foo::Bar alone in an eval, so an
380 # extra statement is a workaround.
381 eval "require $prereq; 0";
383 my $pr_version = $prereq->VERSION || 0;
385 # convert X.Y_Z alpha version #s to X.YZ for easier comparisons
386 $pr_version =~ s/(\d+)\.(\d+)_(\d+)/$1.$2$3/;
389 warn sprintf "Warning: prerequisite %s %s not found.\n",
390 $prereq, $self->{PREREQ_PM}{$prereq}
391 unless $self->{PREREQ_FATAL};
392 $unsatisfied{$prereq} = 'not installed';
393 } elsif ($pr_version < $self->{PREREQ_PM}->{$prereq} ){
394 warn sprintf "Warning: prerequisite %s %s not found. We have %s.\n",
395 $prereq, $self->{PREREQ_PM}{$prereq},
396 ($pr_version || 'unknown version')
397 unless $self->{PREREQ_FATAL};
398 $unsatisfied{$prereq} = $self->{PREREQ_PM}->{$prereq} ?
399 $self->{PREREQ_PM}->{$prereq} : 'unknown version' ;
402 if (%unsatisfied && $self->{PREREQ_FATAL}){
403 my $failedprereqs = join ', ', map {"$_ $unsatisfied{$_}"}
405 die qq{MakeMaker FATAL: prerequisites not found ($failedprereqs)\n
406 Please install these modules first and rerun 'perl Makefile.PL'.\n};
409 if (defined $self->{CONFIGURE}) {
410 if (ref $self->{CONFIGURE} eq 'CODE') {
411 %configure_att = %{&{$self->{CONFIGURE}}};
412 $self = { %$self, %configure_att };
414 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
418 # This is for old Makefiles written pre 5.00, will go away
419 if ( Carp::longmess("") =~ /runsubdirpl/s ){
420 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
423 my $newclass = ++$PACKNAME;
424 local @Parent = @Parent; # Protect against non-local exits
427 print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
428 mv_all_methods("MY",$newclass);
429 bless $self, $newclass;
431 require ExtUtils::MY;
432 @{"$newclass\:\:ISA"} = 'MM';
435 if (defined $Parent[-2]){
436 $self->{PARENT} = $Parent[-2];
438 for $key (@Prepend_parent) {
439 next unless defined $self->{PARENT}{$key};
441 # Don't stomp on WriteMakefile() args.
442 next if defined $self->{ARGS}{$key} and
443 $self->{ARGS}{$key} eq $self->{$key};
445 $self->{$key} = $self->{PARENT}{$key};
447 unless ($Is_VMS && $key =~ /PERL$/) {
448 $self->{$key} = $self->catdir("..",$self->{$key})
449 unless $self->file_name_is_absolute($self->{$key});
451 # PERL or FULLPERL will be a command verb or even a
452 # command with an argument instead of a full file
453 # specification under VMS. So, don't turn the command
454 # into a filespec, but do add a level to the path of
455 # the argument if not already absolute.
456 my @cmd = split /\s+/, $self->{$key};
457 $cmd[1] = $self->catfile('[-]',$cmd[1])
458 unless (@cmd < 2) || $self->file_name_is_absolute($cmd[1]);
459 $self->{$key} = join(' ', @cmd);
462 if ($self->{PARENT}) {
463 $self->{PARENT}->{CHILDREN}->{$newclass} = $self;
464 foreach my $opt (qw(POLLUTE PERL_CORE)) {
465 if (exists $self->{PARENT}->{$opt}
466 and not exists $self->{$opt})
468 # inherit, but only if already unspecified
469 $self->{$opt} = $self->{PARENT}->{$opt};
473 my @fm = grep /^FIRST_MAKEFILE=/, @ARGV;
474 parse_args($self,@fm) if @fm;
476 parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV);
479 $self->{NAME} ||= $self->guess_name;
481 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
492 $self->init_DIRFILESEP;
495 if (! $self->{PERL_SRC} ) {
496 require VMS::Filespec if $Is_VMS;
497 my($pthinks) = $self->canonpath($INC{'Config.pm'});
498 my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
499 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
500 if ($pthinks ne $cthinks &&
501 !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
502 print "Have $pthinks expected $cthinks\n";
504 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
507 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
509 print STDOUT <<END unless $self->{UNINSTALLED_PERL};
510 Your perl and your Config.pm seem to have different ideas about the
511 architecture they are running on.
512 Perl thinks: [$pthinks]
513 Config says: [$Config{archname}]
514 This may or may not cause problems. Please check your installation of perl
515 if you have problems building this extension.
520 $self->init_others();
521 $self->init_platform();
523 my($argv) = neatvalue(\@ARGV);
527 push @{$self->{RESULT}}, <<END;
528 # This Makefile is for the $self->{NAME} extension to perl.
530 # It was generated automatically by MakeMaker version
531 # $VERSION (Revision: $Revision) from the contents of
532 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
534 # ANY CHANGES MADE HERE WILL BE LOST!
536 # MakeMaker ARGV: $argv
538 # MakeMaker Parameters:
541 foreach my $key (sort keys %initial_att){
542 next if $key eq 'ARGS';
544 my($v) = neatvalue($initial_att{$key});
545 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
547 push @{$self->{RESULT}}, "# $key => $v";
549 undef %initial_att; # free memory
551 if (defined $self->{CONFIGURE}) {
552 push @{$self->{RESULT}}, <<END;
554 # MakeMaker 'CONFIGURE' Parameters:
556 if (scalar(keys %configure_att) > 0) {
557 foreach my $key (sort keys %configure_att){
558 next if $key eq 'ARGS';
559 my($v) = neatvalue($configure_att{$key});
560 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
562 push @{$self->{RESULT}}, "# $key => $v";
567 push @{$self->{RESULT}}, "# no values returned";
569 undef %configure_att; # free memory
572 # turn the SKIP array into a SKIPHASH hash
574 for $skip (@{$self->{SKIP} || []}) {
575 $self->{SKIPHASH}{$skip} = 1;
577 delete $self->{SKIP}; # free memory
579 if ($self->{PARENT}) {
580 for (qw/install dist dist_basics dist_core distdir dist_test dist_ci/) {
581 $self->{SKIPHASH}{$_} = 1;
585 # We run all the subdirectories now. They don't have much to query
586 # from the parent, but the parent has to query them: if they need linking!
587 unless ($self->{NORECURS}) {
588 $self->eval_in_subdirs if @{$self->{DIR}};
591 foreach my $section ( @MM_Sections ){
592 # Support for new foo_target() methods.
593 my $method = $section;
594 $method .= '_target' unless $self->can($method);
596 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
597 my($skipit) = $self->skipcheck($section);
599 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
601 my(%a) = %{$self->{$section} || {}};
602 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
603 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
604 push @{$self->{RESULT}}, $self->nicetext($self->$method( %a ));
608 push @{$self->{RESULT}}, "\n# End.";
613 sub WriteEmptyMakefile {
614 Carp::croak "WriteEmptyMakefile: Need even number of args" if @_ % 2;
617 my $self = MM->new(\%att);
618 if (-f $self->{MAKEFILE_OLD}) {
619 _unlink($self->{MAKEFILE_OLD}) or
620 warn "unlink $self->{MAKEFILE_OLD}: $!";
622 if ( -f $self->{MAKEFILE} ) {
623 _rename($self->{MAKEFILE}, $self->{MAKEFILE_OLD}) or
624 warn "rename $self->{MAKEFILE} => $self->{MAKEFILE_OLD}: $!"
626 open MF, '>'.$self->{MAKEFILE} or die "open $self->{MAKEFILE} for write: $!";
639 close MF or die "close $self->{MAKEFILE} for write: $!";
643 print STDOUT "Checking if your kit is complete...\n";
644 require ExtUtils::Manifest;
646 $ExtUtils::Manifest::Quiet = $ExtUtils::Manifest::Quiet = 1;
647 my(@missed) = ExtUtils::Manifest::manicheck();
649 print STDOUT "Warning: the following files are missing in your kit:\n";
650 print "\t", join "\n\t", @missed;
652 print STDOUT "Please inform the author.\n";
654 print STDOUT "Looks good\n";
659 my($self, @args) = @_;
661 unless (m/(.*?)=(.*)/) {
662 help(),exit 1 if m/^help$/;
663 ++$Verbose if m/^verb/;
666 my($name, $value) = ($1, $2);
667 if ($value =~ m/^~(\w+)?/) { # tilde with optional username
668 $value =~ s [^~(\w*)]
670 ((getpwnam($1))[7] || "~$1") :
675 # Remember the original args passed it. It will be useful later.
676 $self->{ARGS}{uc $name} = $self->{uc $name} = $value;
679 # catch old-style 'potential_libs' and inform user how to 'upgrade'
680 if (defined $self->{potential_libs}){
681 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
682 if ($self->{potential_libs}){
683 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
685 print STDOUT "$msg deleted.\n";
687 $self->{LIBS} = [$self->{potential_libs}];
688 delete $self->{potential_libs};
690 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
691 if (defined $self->{ARMAYBE}){
692 my($armaybe) = $self->{ARMAYBE};
693 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
694 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
695 my(%dl) = %{$self->{dynamic_lib} || {}};
696 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
697 delete $self->{ARMAYBE};
699 if (defined $self->{LDTARGET}){
700 print STDOUT "LDTARGET should be changed to LDFROM\n";
701 $self->{LDFROM} = $self->{LDTARGET};
702 delete $self->{LDTARGET};
704 # Turn a DIR argument on the command line into an array
705 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
706 # So they can choose from the command line, which extensions they want
707 # the grep enables them to have some colons too much in case they
708 # have to build a list with the shell
709 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
711 # Turn a INCLUDE_EXT argument on the command line into an array
712 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
713 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
715 # Turn a EXCLUDE_EXT argument on the command line into an array
716 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
717 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
720 foreach my $mmkey (sort keys %$self){
721 next if $mmkey eq 'ARGS';
722 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
723 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
724 unless exists $Recognized_Att_Keys{$mmkey};
731 # We allow extension-specific hints files.
734 my $curdir = File::Spec->curdir;
736 my $hint_dir = File::Spec->catdir($curdir, "hints");
737 return unless -d $hint_dir;
739 # First we look for the best hintsfile we have
740 my($hint)="${^O}_$Config{osvers}";
745 # Also try without trailing minor version numbers.
747 last if -f File::Spec->catfile($hint_dir, "$hint.pl"); # found
749 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
751 my $hint_file = File::Spec->catfile($hint_dir, "$hint.pl");
753 return unless -f $hint_file; # really there
755 _run_hintfile($self, $hint_file);
760 local($self) = shift; # make $self available to the hint file.
761 my($hint_file) = shift;
764 print STDERR "Processing hints file $hint_file\n";
766 # Just in case the ./ isn't on the hint file, which File::Spec can
767 # often strip off, we bung the curdir into @INC
768 local @INC = (File::Spec->curdir, @INC);
769 my $ret = do $hint_file;
770 if( !defined $ret ) {
771 my $error = $@ || $!;
779 my($symtab) = \%{"${from}::"};
781 # Here you see the *current* list of methods that are overridable
782 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
783 # still trying to reduce the list to some reasonable minimum --
784 # because I want to make it easier for the user. A.K.
786 local $SIG{__WARN__} = sub {
787 # can't use 'no warnings redefined', 5.6 only
788 warn @_ unless $_[0] =~ /^Subroutine .* redefined/
790 foreach my $method (@Overridable) {
792 # We cannot say "next" here. Nick might call MY->makeaperl
793 # which isn't defined right now
795 # Above statement was written at 4.23 time when Tk-b8 was
796 # around. As Tk-b9 only builds with 5.002something and MM 5 is
797 # standard, we try to enable the next line again. It was
798 # commented out until MM 5.23
800 next unless defined &{"${from}::$method"};
802 *{"${to}::$method"} = \&{"${from}::$method"};
804 # delete would do, if we were sure, nobody ever called
805 # MY->makeaperl directly
807 # delete $symtab->{$method};
809 # If we delete a method, then it will be undefined and cannot
810 # be called. But as long as we have Makefile.PLs that rely on
811 # %MY:: being intact, we have to fill the hole with an
814 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
817 # We have to clean out %INC also, because the current directory is
818 # changed frequently and Graham Barr prefers to get his version
819 # out of a History.pl file which is "required" so woudn't get
820 # loaded again in another extension requiring a History.pl
822 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
823 # to core dump in the middle of a require statement. The required
824 # file was Tk/MMutil.pm. The consequence is, we have to be
825 # extremely careful when we try to give perl a reason to reload a
826 # library with same name. The workaround prefers to drop nothing
827 # from %INC and teach the writers not to use such libraries.
830 # foreach $inc (keys %INC) {
831 # #warn "***$inc*** deleted";
839 if ($section eq 'dynamic') {
840 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
841 "in skipped section 'dynamic_bs'\n"
842 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
843 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
844 "in skipped section 'dynamic_lib'\n"
845 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
847 if ($section eq 'dynamic_lib') {
848 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
849 "targets in skipped section 'dynamic_bs'\n"
850 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
852 if ($section eq 'static') {
853 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
854 "in skipped section 'static_lib'\n"
855 if $self->{SKIPHASH}{static_lib} && $Verbose;
857 return 'skipped' if $self->{SKIPHASH}{$section};
865 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
867 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
868 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
870 for $chunk (@{$self->{RESULT}}) {
875 my($finalname) = $self->{MAKEFILE};
876 _rename("MakeMaker.tmp", $finalname) or
877 warn "rename MakeMaker.tmp => $finalname: $!";
878 chmod 0644, $finalname unless $Is_VMS;
880 my %keep = map { ($_ => 1) } qw(NEEDS_LINKING HAS_LINK_CODE);
882 if ($self->{PARENT} && !$self->{_KEEP_AFTER_FLUSH}) {
883 foreach (keys %$self) { # safe memory
884 delete $self->{$_} unless $keep{$_};
888 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
892 # This is a rename for OS's where the target must be unlinked first.
894 my($src, $dest) = @_;
897 return rename $src, $dest;
900 # This is an unlink for OS's where the target must be writable first.
904 return unlink @files;
908 # The following mkbootstrap() is only for installations that are calling
909 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
910 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
913 !!! Your Makefile has been built such a long time ago, !!!
914 !!! that is unlikely to work with current MakeMaker. !!!
915 !!! Please rebuild your Makefile !!!
919 # Ditto for mksymlists() as of MakeMaker 5.17
922 !!! Your Makefile has been built such a long time ago, !!!
923 !!! that is unlikely to work with current MakeMaker. !!!
924 !!! Please rebuild your Makefile !!!
930 return "undef" unless defined $v;
932 return "q[$v]" unless $t;
936 foreach my $elem (@$v) {
937 push @neat, "q[$elem]";
939 push @m, join ", ", @neat;
943 return "$v" unless $t eq 'HASH';
945 while (($key,$val) = each %$v){
946 last unless defined $key; # cautious programming in case (undef,undef) is true
947 push(@m,"$key=>".neatvalue($val)) ;
949 return "{ ".join(', ',@m)." }";
956 push @m, "\n# Full list of MakeMaker attribute values:";
957 foreach my $key (sort keys %$self){
958 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
959 my($v) = neatvalue($self->{$key});
960 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
962 push @m, "# $key => $v";
974 ExtUtils::MakeMaker - Create a module Makefile
978 use ExtUtils::MakeMaker;
980 WriteMakefile( ATTRIBUTE => VALUE [, ...] );
984 This utility is designed to write a Makefile for an extension module
985 from a Makefile.PL. It is based on the Makefile.SH model provided by
986 Andy Dougherty and the perl5-porters.
988 It splits the task of generating the Makefile into several subroutines
989 that can be individually overridden. Each subroutine returns the text
990 it wishes to have written to the Makefile.
992 MakeMaker is object oriented. Each directory below the current
993 directory that contains a Makefile.PL is treated as a separate
994 object. This makes it possible to write an unlimited number of
995 Makefiles with a single invocation of WriteMakefile().
997 =head2 How To Write A Makefile.PL
999 See ExtUtils::MakeMaker::Tutorial.
1001 The long answer is the rest of the manpage :-)
1003 =head2 Default Makefile Behaviour
1005 The generated Makefile enables the user of the extension to invoke
1007 perl Makefile.PL # optionally "perl Makefile.PL verbose"
1009 make test # optionally set TEST_VERBOSE=1
1010 make install # See below
1012 The Makefile to be produced may be altered by adding arguments of the
1013 form C<KEY=VALUE>. E.g.
1015 perl Makefile.PL PREFIX=/tmp/myperl5
1017 Other interesting targets in the generated Makefile are
1019 make config # to check if the Makefile is up-to-date
1020 make clean # delete local temp files (Makefile gets renamed)
1021 make realclean # delete derived files (including ./blib)
1022 make ci # check in all the files in the MANIFEST file
1023 make dist # see below the Distribution Support section
1027 MakeMaker checks for the existence of a file named F<test.pl> in the
1028 current directory and if it exists it execute the script with the
1029 proper set of perl C<-I> options.
1031 MakeMaker also checks for any files matching glob("t/*.t"). It will
1032 execute all matching files in alphabetical order via the
1033 L<Test::Harness> module with the C<-I> switches set correctly.
1035 If you'd like to see the raw output of your tests, set the
1036 C<TEST_VERBOSE> variable to true.
1038 make test TEST_VERBOSE=1
1042 A useful variation of the above is the target C<testdb>. It runs the
1043 test under the Perl debugger (see L<perldebug>). If the file
1044 F<test.pl> exists in the current directory, it is used for the test.
1046 If you want to debug some other testfile, set the C<TEST_FILE> variable
1049 make testdb TEST_FILE=t/mytest.t
1051 By default the debugger is called using C<-d> option to perl. If you
1052 want to specify some other option, set the C<TESTDB_SW> variable:
1054 make testdb TESTDB_SW=-Dx
1058 make alone puts all relevant files into directories that are named by
1059 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_MAN1DIR and
1060 INST_MAN3DIR. All these default to something below ./blib if you are
1061 I<not> building below the perl source directory. If you I<are>
1062 building below the perl source, INST_LIB and INST_ARCHLIB default to
1063 ../../lib, and INST_SCRIPT is not defined.
1065 The I<install> target of the generated Makefile copies the files found
1066 below each of the INST_* directories to their INSTALL*
1067 counterparts. Which counterparts are chosen depends on the setting of
1068 INSTALLDIRS according to the following table:
1073 PERLPREFIX SITEPREFIX VENDORPREFIX
1074 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH INSTALLVENDORARCH
1075 INST_LIB INSTALLPRIVLIB INSTALLSITELIB INSTALLVENDORLIB
1076 INST_BIN INSTALLBIN INSTALLSITEBIN INSTALLVENDORBIN
1077 INST_SCRIPT INSTALLSCRIPT INSTALLSCRIPT INSTALLSCRIPT
1078 INST_MAN1DIR INSTALLMAN1DIR INSTALLSITEMAN1DIR INSTALLVENDORMAN1DIR
1079 INST_MAN3DIR INSTALLMAN3DIR INSTALLSITEMAN3DIR INSTALLVENDORMAN3DIR
1081 The INSTALL... macros in turn default to their %Config
1082 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
1084 You can check the values of these variables on your system with
1088 And to check the sequence in which the library directories are
1089 searched by perl, run
1091 perl -le 'print join $/, @INC'
1094 =head2 PREFIX and LIB attribute
1096 PREFIX and LIB can be used to set several INSTALL* attributes in one
1097 go. The quickest way to install a module in a non-standard place might
1100 perl Makefile.PL PREFIX=~
1102 This will install all files in the module under your home directory,
1103 with man pages and libraries going into an appropriate place (usually
1106 Another way to specify many INSTALL directories with a single
1109 perl Makefile.PL LIB=~/lib
1111 This will install the module's architecture-independent files into
1112 ~/lib, the architecture-dependent files into ~/lib/$archname.
1114 Note, that in both cases the tilde expansion is done by MakeMaker, not
1115 by perl by default, nor by make.
1117 Conflicts between parameters LIB, PREFIX and the various INSTALL*
1118 arguments are resolved so that:
1124 setting LIB overrides any setting of INSTALLPRIVLIB, INSTALLARCHLIB,
1125 INSTALLSITELIB, INSTALLSITEARCH (and they are not affected by PREFIX);
1129 without LIB, setting PREFIX replaces the initial C<$Config{prefix}>
1130 part of those INSTALL* arguments, even if the latter are explicitly
1131 set (but are set to still start with C<$Config{prefix}>).
1135 If the user has superuser privileges, and is not working on AFS or
1136 relatives, then the defaults for INSTALLPRIVLIB, INSTALLARCHLIB,
1137 INSTALLSCRIPT, etc. will be appropriate, and this incantation will be
1145 make install per default writes some documentation of what has been
1146 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1147 can be bypassed by calling make pure_install.
1151 will have to specify the installation directories as these most
1152 probably have changed since perl itself has been installed. They will
1153 have to do this by calling
1155 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1156 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1159 Be careful to repeat this procedure every time you recompile an
1160 extension, unless you are sure the AFS installation directories are
1163 =head2 Static Linking of a new Perl Binary
1165 An extension that is built with the above steps is ready to use on
1166 systems supporting dynamic loading. On systems that do not support
1167 dynamic loading, any newly created extension has to be linked together
1168 with the available resources. MakeMaker supports the linking process
1169 by creating appropriate targets in the Makefile whenever an extension
1170 is built. You can invoke the corresponding section of the makefile with
1174 That produces a new perl binary in the current directory with all
1175 extensions linked in that can be found in INST_ARCHLIB, SITELIBEXP,
1176 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1177 UNIX, this is called Makefile.aperl (may be system dependent). If you
1178 want to force the creation of a new perl, it is recommended, that you
1179 delete this Makefile.aperl, so the directories are searched-through
1180 for linkable libraries again.
1182 The binary can be installed into the directory where perl normally
1183 resides on your machine with
1187 To produce a perl binary with a different name than C<perl>, either say
1189 perl Makefile.PL MAP_TARGET=myperl
1196 make myperl MAP_TARGET=myperl
1197 make inst_perl MAP_TARGET=myperl
1199 In any case you will be prompted with the correct invocation of the
1200 C<inst_perl> target that installs the new binary into INSTALLBIN.
1202 make inst_perl per default writes some documentation of what has been
1203 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1204 can be bypassed by calling make pure_inst_perl.
1206 Warning: the inst_perl: target will most probably overwrite your
1207 existing perl binary. Use with care!
1209 Sometimes you might want to build a statically linked perl although
1210 your system supports dynamic loading. In this case you may explicitly
1211 set the linktype with the invocation of the Makefile.PL or make:
1213 perl Makefile.PL LINKTYPE=static # recommended
1217 make LINKTYPE=static # works on most systems
1219 =head2 Determination of Perl Library and Installation Locations
1221 MakeMaker needs to know, or to guess, where certain things are
1222 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1223 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1224 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1226 Extensions may be built either using the contents of the perl source
1227 directory tree or from the installed perl library. The recommended way
1228 is to build extensions after you have run 'make install' on perl
1229 itself. You can do that in any directory on your hard disk that is not
1230 below the perl source tree. The support for extensions below the ext
1231 directory of the perl distribution is only good for the standard
1232 extensions that come with perl.
1234 If an extension is being built below the C<ext/> directory of the perl
1235 source then MakeMaker will set PERL_SRC automatically (e.g.,
1236 C<../..>). If PERL_SRC is defined and the extension is recognized as
1237 a standard extension, then other variables default to the following:
1240 PERL_LIB = PERL_SRC/lib
1241 PERL_ARCHLIB = PERL_SRC/lib
1243 INST_ARCHLIB = PERL_ARCHLIB
1245 If an extension is being built away from the perl source then MakeMaker
1246 will leave PERL_SRC undefined and default to using the installed copy
1247 of the perl library. The other variables default to the following:
1249 PERL_INC = $archlibexp/CORE
1250 PERL_LIB = $privlibexp
1251 PERL_ARCHLIB = $archlibexp
1252 INST_LIB = ./blib/lib
1253 INST_ARCHLIB = ./blib/arch
1255 If perl has not yet been installed then PERL_SRC can be defined on the
1256 command line as shown in the previous section.
1259 =head2 Which architecture dependent directory?
1261 If you don't want to keep the defaults for the INSTALL* macros,
1262 MakeMaker helps you to minimize the typing needed: the usual
1263 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1264 by Configure at perl compilation time. MakeMaker supports the user who
1265 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1266 then MakeMaker defaults the latter to be the same subdirectory of
1267 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1268 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1269 for INSTALLSITELIB and INSTALLSITEARCH.
1271 MakeMaker gives you much more freedom than needed to configure
1272 internal variables and get different results. It is worth to mention,
1273 that make(1) also lets you configure most of the variables that are
1274 used in the Makefile. But in the majority of situations this will not
1275 be necessary, and should only be done if the author of a package
1276 recommends it (or you know what you're doing).
1278 =head2 Using Attributes and Parameters
1280 The following attributes may be specified as arguments to WriteMakefile()
1281 or as NAME=VALUE pairs on the command line.
1287 One line description of the module. Will be included in PPD file.
1291 Name of the file that contains the package description. MakeMaker looks
1292 for a line in the POD matching /^($package\s-\s)(.*)/. This is typically
1293 the first line in the "=head1 NAME" section. $2 becomes the abstract.
1297 String containing name (and email address) of package author(s). Is used
1298 in PPD (Perl Package Description) files for PPM (Perl Package Manager).
1300 =item BINARY_LOCATION
1302 Used when creating PPD files for binary packages. It can be set to a
1303 full or relative path or URL to the binary archive for a particular
1304 architecture. For example:
1306 perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
1308 builds a PPD package that references a binary of the C<Agent> package,
1309 located in the C<x86> directory relative to the PPD itself.
1313 Ref to array of *.c file names. Initialised from a directory scan
1314 and the values portion of the XS attribute hash. This is not
1315 currently used by MakeMaker but may be handy in Makefile.PLs.
1319 String that will be included in the compiler call command line between
1320 the arguments INC and OPTIMIZE.
1324 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1325 config.sh. MakeMaker will add to CONFIG the following values anyway:
1345 CODE reference. The subroutine should return a hash reference. The
1346 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1347 be determined by some evaluation method.
1351 Something like C<"-DHAVE_UNISTD_H">
1355 This is the root directory into which the code will be installed. It
1356 I<prepends itself to the normal prefix>. For example, if your code
1357 would normally go into /usr/local/lib/perl you could set DESTDIR=/tmp/
1358 and installation would go into /tmp/usr/local/lib/perl.
1360 This is primarily of use for people who repackage Perl modules.
1362 NOTE: Due to the nature of make, it is important that you put the trailing
1363 slash on your DESTDIR. "/tmp/" not "/tmp".
1367 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1372 A safe filename for the package.
1374 Defaults to NAME above but with :: replaced with -.
1376 For example, Foo::Bar becomes Foo-Bar.
1380 Your name for distributing the package with the version number
1381 included. This is used by 'make dist' to name the resulting archive
1384 Defaults to DISTNAME-VERSION.
1386 For example, version 1.04 of Foo::Bar becomes Foo-Bar-1.04.
1388 On some OS's where . has special meaning VERSION_SYM may be used in
1393 Hashref of symbol names for routines to be made available as universal
1394 symbols. Each key/value pair consists of the package name and an
1395 array of routine names in that package. Used only under AIX, OS/2,
1396 VMS and Win32 at present. The routine names supplied will be expanded
1397 in the same way as XSUB names are expanded by the XS() macro.
1400 {"$(NAME)" => ["boot_$(NAME)" ] }
1404 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1405 "NetconfigPtr" => [ 'DESTROY'] }
1407 Please see the L<ExtUtils::Mksymlists> documentation for more information
1408 about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
1412 Array of symbol names for variables to be made available as universal symbols.
1413 Used only under AIX, OS/2, VMS and Win32 at present. Defaults to [].
1414 (e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
1418 Array of extension names to exclude when doing a static build. This
1419 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1420 details. (e.g. [ qw( Socket POSIX ) ] )
1422 This attribute may be most useful when specified as a string on the
1423 command line: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1427 Ref to array of executable files. The files will be copied to the
1428 INST_SCRIPT directory. Make realclean will delete them from there
1431 If your executables start with something like #!perl or
1432 #!/usr/bin/perl MakeMaker will change this to the path of the perl
1433 'Makefile.PL' was invoked with so the programs will be sure to run
1434 properly even if perl is not in /usr/bin/perl.
1436 =item FIRST_MAKEFILE
1438 The name of the Makefile to be produced. This is used for the second
1439 Makefile that will be produced for the MAP_TARGET.
1441 Defaults to 'Makefile' or 'Descrip.MMS' on VMS.
1443 (Note: we couldn't use MAKEFILE because dmake uses this for something
1448 Perl binary able to run this extension, load XS modules, etc...
1452 Like PERLRUN, except it uses FULLPERL.
1454 =item FULLPERLRUNINST
1456 Like PERLRUNINST, except it uses FULLPERL.
1460 This provides an alternate means to specify function names to be
1461 exported from the extension. Its value is a reference to an
1462 array of function names to be exported by the extension. These
1463 names are passed through unaltered to the linker options file.
1467 Ref to array of *.h file names. Similar to C.
1471 This attribute is used to specify names to be imported into the
1472 extension. Takes a hash ref.
1474 It is only used on OS/2 and Win32.
1478 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1482 Array of extension names to be included when doing a static build.
1483 MakeMaker will normally build with all of the installed extensions when
1484 doing a static build, and that is usually the desired behavior. If
1485 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1486 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1488 It is not necessary to mention DynaLoader or the current extension when
1489 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1490 only DynaLoader and the current extension will be included in the build.
1492 This attribute may be most useful when specified as a string on the
1493 command line: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1495 =item INSTALLARCHLIB
1497 Used by 'make install', which copies files from INST_ARCHLIB to this
1498 directory if INSTALLDIRS is set to perl.
1502 Directory to install binary files (e.g. tkperl) into if
1507 Determines which of the sets of installation directories to choose:
1508 perl, site or vendor. Defaults to site.
1510 =item INSTALLMAN1DIR
1512 =item INSTALLMAN3DIR
1514 These directories get the man pages at 'make install' time if
1515 INSTALLDIRS=perl. Defaults to $Config{installman*dir}.
1517 If set to 'none', no man pages will be installed.
1519 =item INSTALLPRIVLIB
1521 Used by 'make install', which copies files from INST_LIB to this
1522 directory if INSTALLDIRS is set to perl.
1524 Defaults to $Config{installprivlib}.
1528 Used by 'make install' which copies files from INST_SCRIPT to this
1531 =item INSTALLSITEARCH
1533 Used by 'make install', which copies files from INST_ARCHLIB to this
1534 directory if INSTALLDIRS is set to site (default).
1536 =item INSTALLSITEBIN
1538 Used by 'make install', which copies files from INST_BIN to this
1539 directory if INSTALLDIRS is set to site (default).
1541 =item INSTALLSITELIB
1543 Used by 'make install', which copies files from INST_LIB to this
1544 directory if INSTALLDIRS is set to site (default).
1546 =item INSTALLSITEMAN1DIR
1548 =item INSTALLSITEMAN3DIR
1550 These directories get the man pages at 'make install' time if
1551 INSTALLDIRS=site (default). Defaults to
1552 $(SITEPREFIX)/man/man$(MAN*EXT).
1554 If set to 'none', no man pages will be installed.
1556 =item INSTALLVENDORARCH
1558 Used by 'make install', which copies files from INST_ARCHLIB to this
1559 directory if INSTALLDIRS is set to vendor.
1561 =item INSTALLVENDORBIN
1563 Used by 'make install', which copies files from INST_BIN to this
1564 directory if INSTALLDIRS is set to vendor.
1566 =item INSTALLVENDORLIB
1568 Used by 'make install', which copies files from INST_LIB to this
1569 directory if INSTALLDIRS is set to vendor.
1571 =item INSTALLVENDORMAN1DIR
1573 =item INSTALLVENDORMAN3DIR
1575 These directories get the man pages at 'make install' time if
1576 INSTALLDIRS=vendor. Defaults to $(VENDORPREFIX)/man/man$(MAN*EXT).
1578 If set to 'none', no man pages will be installed.
1582 Same as INST_LIB for architecture dependent files.
1586 Directory to put real binary files during 'make'. These will be copied
1587 to INSTALLBIN during 'make install'
1591 Directory where we put library files of this extension while building
1596 Directory to hold the man pages at 'make' time
1600 Directory to hold the man pages at 'make' time
1604 Directory, where executable files should be installed during
1605 'make'. Defaults to "./blib/script", just to have a dummy location during
1606 testing. make install will copy the files in INST_SCRIPT to
1611 Program to be used to link libraries for dynamic loading.
1613 Defaults to $Config{ld}.
1617 Any special flags that might need to be passed to ld to create a
1618 shared library suitable for dynamic loading. It is up to the makefile
1619 to use it. (See L<Config/lddlflags>)
1621 Defaults to $Config{lddlflags}.
1625 Defaults to "$(OBJECT)" and is used in the ld command to specify
1626 what files to link/load from (also see dynamic_lib below for how to
1631 LIB should only be set at C<perl Makefile.PL> time but is allowed as a
1632 MakeMaker argument. It has the effect of setting both INSTALLPRIVLIB
1633 and INSTALLSITELIB to that value regardless any explicit setting of
1634 those arguments (or of PREFIX). INSTALLARCHLIB and INSTALLSITEARCH
1635 are set to the corresponding architecture subdirectory.
1639 The filename of the perllibrary that will be used together with this
1640 extension. Defaults to libperl.a.
1644 An anonymous array of alternative library
1645 specifications to be searched for (in order) until
1646 at least one library is found. E.g.
1648 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1650 Mind, that any element of the array
1651 contains a complete set of arguments for the ld
1652 command. So do not specify
1654 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1656 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1657 you specify a scalar as in
1659 'LIBS' => "-ltcl -ltk -lX11"
1661 MakeMaker will turn it into an array with one element.
1665 'static' or 'dynamic' (default unless usedl=undef in
1666 config.sh). Should only be used to force static linking (also see
1671 Boolean which tells MakeMaker, that it should include the rules to
1672 make a perl. This is handled automatically as a switch by
1673 MakeMaker. The user normally does not need it.
1677 When 'make clean' or similar is run, the $(FIRST_MAKEFILE) will be
1678 backed up at this location.
1680 Defaults to $(FIRST_MAKEFILE).old or $(FIRST_MAKEFILE)_old on VMS.
1684 Hashref of pod-containing files. MakeMaker will default this to all
1685 EXE_FILES files that include POD directives. The files listed
1686 here will be converted to man pages and installed as was requested
1691 Hashref that assigns to *.pm and *.pod files the files into which the
1692 manpages are to be written. MakeMaker parses all *.pod and *.pm files
1693 for POD directives. Files that contain POD will be the default keys of
1694 the MAN3PODS hashref. These will then be converted to man pages during
1695 C<make> and will be installed during C<make install>.
1699 If it is intended, that a new perl binary be produced, this variable
1700 may hold a name for that binary. Defaults to perl
1704 If the extension links to a library that it builds set this to the
1705 name of the library (see SDBM_File)
1709 Perl module name for this extension (DBD::Oracle). This will default
1710 to the directory name but should be explicitly defined in the
1715 MakeMaker will figure out if an extension contains linkable code
1716 anywhere down the directory tree, and will set this variable
1717 accordingly, but you can speed it up a very little bit if you define
1718 this boolean variable yourself.
1722 Command so make does not print the literal commands its running.
1724 By setting it to an empty string you can generate a Makefile that
1725 prints all commands. Mainly used in debugging MakeMaker itself.
1731 Boolean. Attribute to inhibit descending into subdirectories.
1735 When true, suppresses the generation and addition to the MANIFEST of
1736 the META.yml module meta-data file during 'make distdir'.
1742 In general, any generated Makefile checks for the current version of
1743 MakeMaker and the version the Makefile was built under. If NO_VC is
1744 set, the version check is neglected. Do not write this into your
1745 Makefile.PL, use it interactively instead.
1749 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1750 string containing all object files, e.g. "tkpBind.o
1751 tkpButton.o tkpCanvas.o"
1753 (Where BASEEXT is the last component of NAME, and OBJ_EXT is $Config{obj_ext}.)
1757 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1758 passed to subdirectory makes.
1762 Perl binary for tasks that can be done by miniperl
1766 Set only when MakeMaker is building the extensions of the Perl core
1771 The call to the program that is able to compile perlmain.c. Defaults
1776 Same as for PERL_LIB, but for architecture dependent files.
1778 Used only when MakeMaker is building the extensions of the Perl core
1779 distribution (because normally $(PERL_ARCHLIB) is automatically in @INC,
1780 and adding it would get in the way of PERL5LIB).
1784 Directory containing the Perl library to use.
1786 Used only when MakeMaker is building the extensions of the Perl core
1787 distribution (because normally $(PERL_LIB) is automatically in @INC,
1788 and adding it would get in the way of PERL5LIB).
1790 =item PERL_MALLOC_OK
1792 defaults to 0. Should be set to TRUE if the extension can work with
1793 the memory allocation routines substituted by the Perl malloc() subsystem.
1794 This should be applicable to most extensions with exceptions of those
1800 with bugs in memory allocations which are caught by Perl's malloc();
1804 which interact with the memory allocator in other ways than via
1805 malloc(), realloc(), free(), calloc(), sbrk() and brk();
1809 which rely on special alignment which is not provided by Perl's malloc().
1813 B<NOTE.> Negligence to set this flag in I<any one> of loaded extension
1814 nullifies many advantages of Perl's malloc(), such as better usage of
1815 system resources, error detection, memory usage reporting, catchable failure
1816 of memory allocations, etc.
1820 Directory under which core modules are to be installed.
1822 Defaults to $Config{installprefixexp} falling back to
1823 $Config{installprefix}, $Config{prefixexp} or $Config{prefix} should
1824 $Config{installprefixexp} not exist.
1826 Overridden by PREFIX.
1830 Use this instead of $(PERL) when you wish to run perl. It will set up
1831 extra necessary flags for you.
1835 Use this instead of $(PERL) when you wish to run perl to work with
1836 modules. It will add things like -I$(INST_ARCH) and other necessary
1837 flags so perl can see the modules you're about to install.
1841 Directory containing the Perl source code (use of this should be
1842 avoided, it may be undefined)
1846 Desired permission for read/writable files. Defaults to C<644>.
1847 See also L<MM_Unix/perm_rw>.
1851 Desired permission for executable files. Defaults to C<755>.
1852 See also L<MM_Unix/perm_rwx>.
1856 Ref to hash of files to be processed as perl programs. MakeMaker
1857 will default to any found *.PL file (except Makefile.PL) being keys
1858 and the basename of the file being the value. E.g.
1860 {'foobar.PL' => 'foobar'}
1862 The *.PL files are expected to produce output to the target files
1863 themselves. If multiple files can be generated from the same *.PL
1864 file then the value in the hash can be a reference to an array of
1865 target file names. E.g.
1867 {'foobar.PL' => ['foobar1','foobar2']}
1871 Hashref of .pm files and *.pl files to be installed. e.g.
1873 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1875 By default this will include *.pm and *.pl and the files found in
1876 the PMLIBDIRS directories. Defining PM in the
1877 Makefile.PL will override PMLIBDIRS.
1881 Ref to array of subdirectories containing library files. Defaults to
1882 [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
1883 they contain will be installed in the corresponding location in the
1884 library. A libscan() method can be used to alter the behaviour.
1885 Defining PM in the Makefile.PL will override PMLIBDIRS.
1887 (Where BASEEXT is the last component of NAME.)
1891 A filter program, in the traditional Unix sense (input from stdin, output
1892 to stdout) that is passed on each .pm file during the build (in the
1893 pm_to_blib() phase). It is empty by default, meaning no filtering is done.
1895 Great care is necessary when defining the command if quoting needs to be
1896 done. For instance, you would need to say:
1898 {'PM_FILTER' => 'grep -v \\"^\\#\\"'}
1900 to remove all the leading coments on the fly during the build. The
1901 extra \\ are necessary, unfortunately, because this variable is interpolated
1902 within the context of a Perl program built on the command line, and double
1903 quotes are what is used with the -e switch to build that command line. The
1904 # is escaped for the Makefile, since what is going to be generated will then
1907 PM_FILTER = grep -v \"^\#\"
1909 Without the \\ before the #, we'd have the start of a Makefile comment,
1910 and the macro would be incorrectly defined.
1914 Release 5.005 grandfathered old global symbol names by providing preprocessor
1915 macros for extension source compatibility. As of release 5.6, these
1916 preprocessor definitions are not available by default. The POLLUTE flag
1917 specifies that the old names should still be defined:
1919 perl Makefile.PL POLLUTE=1
1921 Please inform the module author if this is necessary to successfully install
1922 a module under 5.6 or later.
1924 =item PPM_INSTALL_EXEC
1926 Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl)
1928 =item PPM_INSTALL_SCRIPT
1930 Name of the script that gets executed by the Perl Package Manager after
1931 the installation of a package.
1935 This overrides all the default install locations. Man pages,
1936 libraries, scripts, etc... MakeMaker will try to make an educated
1937 guess about where to place things under the new PREFIX based on your
1938 Config defaults. Failing that, it will fall back to a structure
1939 which should be sensible for your platform.
1941 If you specify LIB or any INSTALL* variables they will not be effected
1946 Bool. If this parameter is true, failing to have the required modules
1947 (or the right versions thereof) will be fatal. perl Makefile.PL will die
1948 with the proper message.
1950 Note: see L<Test::Harness> for a shortcut for stopping tests early if
1951 you are missing dependencies.
1953 Do I<not> use this parameter for simple requirements, which could be resolved
1954 at a later time, e.g. after an unsuccessful B<make test> of your module.
1956 It is I<extremely> rare to have to use C<PREREQ_FATAL> at all!
1960 Hashref: Names of modules that need to be available to run this
1961 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1962 desired version is the value. If the required version number is 0, we
1963 only check if any version is installed already.
1967 Bool. If this parameter is true, the prerequisites will be printed to
1968 stdout and MakeMaker will exit. The output format is
1978 RedHatism for C<PREREQ_PRINT>. The output format is different, though:
1980 perl(A::B)>=Vers1 perl(C::D)>=Vers2 ...
1984 Like PERLPREFIX, but only for the site install locations.
1986 Defaults to $Config{siteprefixexp}. Perls prior to 5.6.0 didn't have
1987 an explicit siteprefix in the Config. In those cases
1988 $Config{installprefix} will be used.
1990 Overridable by PREFIX
1994 Arrayref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1995 Makefile. Caution! Do not use the SKIP attribute for the negligible
1996 speedup. It may seriously damage the resulting Makefile. Only use it
1997 if you really need it.
2001 Ref to array of typemap file names. Use this when the typemaps are
2002 in some directory other than the current directory or when they are
2003 not named B<typemap>. The last typemap in the list takes
2004 precedence. A typemap in the current directory has highest
2005 precedence, even if it isn't listed in TYPEMAPS. The default system
2006 typemap has lowest precedence.
2010 Like PERLPREFIX, but only for the vendor install locations.
2012 Defaults to $Config{vendorprefixexp}.
2014 Overridable by PREFIX
2018 If true, make install will be verbose
2022 Your version number for distributing the package. This defaults to
2027 Instead of specifying the VERSION in the Makefile.PL you can let
2028 MakeMaker parse a file to determine the version number. The parsing
2029 routine requires that the file named by VERSION_FROM contains one
2030 single line to compute the version number. The first line in the file
2031 that contains the regular expression
2033 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
2035 will be evaluated with eval() and the value of the named variable
2036 B<after> the eval() will be assigned to the VERSION attribute of the
2037 MakeMaker object. The following lines will be parsed o.k.:
2041 $VERSION = sprintf "%d.%03d", q$Revision: 1.124 $ =~ /(\d+)/g;
2042 $FOO::VERSION = '1.10';
2043 *FOO::VERSION = \'1.11';
2044 our $VERSION = 1.2.3; # new for perl5.6.0
2046 but these will fail:
2048 my $VERSION = '1.01';
2049 local $VERSION = '1.02';
2050 local $FOO::VERSION = '1.30';
2052 (Putting C<my> or C<local> on the preceding line will work o.k.)
2054 The file named in VERSION_FROM is not added as a dependency to
2055 Makefile. This is not really correct, but it would be a major pain
2056 during development to have to rewrite the Makefile for any smallish
2057 change in that file. If you want to make sure that the Makefile
2058 contains the correct VERSION macro after any change of the file, you
2059 would have to do something like
2061 depend => { Makefile => '$(VERSION_FROM)' }
2063 See attribute C<depend> below.
2067 A sanitized VERSION with . replaced by _. For places where . has
2068 special meaning (some filesystems, RCS labels, etc...)
2072 Hashref of .xs files. MakeMaker will default this. e.g.
2074 {'name_of_file.xs' => 'name_of_file.c'}
2076 The .c files will automatically be included in the list of files
2077 deleted by a make clean.
2081 String of options to pass to xsubpp. This might include C<-C++> or
2082 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
2087 May be set to an empty string, which is identical to C<-prototypes>, or
2088 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
2089 defaults to the empty string.
2093 Your version number for the .xs file of this package. This defaults
2094 to the value of the VERSION attribute.
2098 =head2 Additional lowercase attributes
2100 can be used to pass parameters to the methods which implement that
2101 part of the Makefile. Parameters are specified as a hash ref but are
2102 passed to the method as a hash.
2108 {FILES => "*.xyz foo"}
2112 {ANY_TARGET => ANY_DEPENDECY, ...}
2114 (ANY_TARGET must not be given a double-colon rule by MakeMaker.)
2118 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
2119 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
2120 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
2122 If you specify COMPRESS, then SUFFIX should also be altered, as it is
2123 needed to tell make the target file of the compression. Setting
2124 DIST_CP to ln can be useful, if you need to preserve the timestamps on
2125 your files. DIST_CP can take the values 'cp', which copies the file,
2126 'ln', which links the file, and 'best' which copies symbolic links and
2127 links the rest. Default is 'best'.
2131 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
2135 {LINKTYPE => 'static', 'dynamic' or ''}
2137 NB: Extensions that have nothing but *.pm files had to say
2141 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
2142 can be deleted safely. MakeMaker recognizes when there's nothing to
2147 {ANY_MACRO => ANY_VALUE, ...}
2151 Anything put here will be passed to MY::postamble() if you have one.
2155 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
2161 =item tool_autosplit
2167 =head2 Overriding MakeMaker Methods
2169 If you cannot achieve the desired Makefile behaviour by specifying
2170 attributes you may define private subroutines in the Makefile.PL.
2171 Each subroutine returns the text it wishes to have written to
2172 the Makefile. To override a section of the Makefile you can
2175 sub MY::c_o { "new literal text" }
2177 or you can edit the default by saying something like:
2179 package MY; # so that "SUPER" works right
2181 my $inherited = shift->SUPER::c_o(@_);
2182 $inherited =~ s/old text/new text/;
2186 If you are running experiments with embedding perl as a library into
2187 other applications, you might find MakeMaker is not sufficient. You'd
2188 better have a look at ExtUtils::Embed which is a collection of utilities
2191 If you still need a different solution, try to develop another
2192 subroutine that fits your needs and submit the diffs to
2193 F<makemaker@perl.org>
2195 For a complete description of all MakeMaker methods see
2196 L<ExtUtils::MM_Unix>.
2198 Here is a simple example of how to add a new target to the generated
2202 return <<'MAKE_FRAG';
2203 $(MYEXTLIB): sdbm/Makefile
2204 cd sdbm && $(MAKE) all
2209 =head2 The End Of Cargo Cult Programming
2211 WriteMakefile() now does some basic sanity checks on its parameters to
2212 protect against typos and malformatted values. This means some things
2213 which happened to work in the past will now throw warnings and
2214 possibly produce internal errors.
2216 Some of the most common mistakes:
2220 =item C<<MAN3PODS => ' '>>
2222 This is commonly used to supress the creation of man pages. MAN3PODS
2223 takes a hash ref not a string, but the above worked by accident in old
2224 versions of MakeMaker.
2226 The correct code is C<<MAN3PODS => { }>>.
2231 =head2 Hintsfile support
2233 MakeMaker.pm uses the architecture specific information from
2234 Config.pm. In addition it evaluates architecture specific hints files
2235 in a C<hints/> directory. The hints files are expected to be named
2236 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
2237 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
2238 MakeMaker within the WriteMakefile() subroutine, and can be used to
2239 execute commands as well as to include special variables. The rules
2240 which hintsfile is chosen are the same as in Configure.
2242 The hintsfile is eval()ed immediately after the arguments given to
2243 WriteMakefile are stuffed into a hash reference $self but before this
2244 reference becomes blessed. So if you want to do the equivalent to
2245 override or create an attribute you would say something like
2247 $self->{LIBS} = ['-ldbm -lucb -lc'];
2249 =head2 Distribution Support
2251 For authors of extensions MakeMaker provides several Makefile
2252 targets. Most of the support comes from the ExtUtils::Manifest module,
2253 where additional documentation can be found.
2257 =item make distcheck
2259 reports which files are below the build directory but not in the
2260 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
2263 =item make skipcheck
2265 reports which files are skipped due to the entries in the
2266 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
2269 =item make distclean
2271 does a realclean first and then the distcheck. Note that this is not
2272 needed to build a new distribution as long as you are sure that the
2273 MANIFEST file is ok.
2277 rewrites the MANIFEST file, adding all remaining files found (See
2278 ExtUtils::Manifest::mkmanifest() for details)
2282 Copies all the files that are in the MANIFEST file to a newly created
2283 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
2284 exists, it will be removed first.
2286 Additionally, it will create a META.yml module meta-data file and add
2287 this to your MANFIEST. You can shut this behavior off with the NO_META
2292 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
2293 a make test in that directory.
2297 First does a distdir. Then a command $(PREOP) which defaults to a null
2298 command, followed by $(TOUNIX), which defaults to a null command under
2299 UNIX, and will convert files in distribution directory to UNIX format
2300 otherwise. Next it runs C<tar> on that directory into a tarfile and
2301 deletes the directory. Finishes with a command $(POSTOP) which
2302 defaults to a null command.
2306 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
2308 =item make uutardist
2310 Runs a tardist first and uuencodes the tarfile.
2314 First does a distdir. Then a command $(PREOP) which defaults to a null
2315 command. Next it runs C<shar> on that directory into a sharfile and
2316 deletes the intermediate directory again. Finishes with a command
2317 $(POSTOP) which defaults to a null command. Note: For shdist to work
2318 properly a C<shar> program that can handle directories is mandatory.
2322 First does a distdir. Then a command $(PREOP) which defaults to a null
2323 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
2324 zipfile. Then deletes that directory. Finishes with a command
2325 $(POSTOP) which defaults to a null command.
2329 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
2333 Customization of the dist targets can be done by specifying a hash
2334 reference to the dist attribute of the WriteMakefile call. The
2335 following parameters are recognized:
2338 COMPRESS ('gzip --best')
2341 TO_UNIX (depends on the system)
2342 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
2352 WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" })
2355 =head2 Module Meta-Data
2357 Long plaguing users of MakeMaker based modules has been the problem of
2358 getting basic information about the module out of the sources
2359 I<without> running the F<Makefile.PL> and doing a bunch of messy
2360 heuristics on the resulting F<Makefile>. To this end a simple module
2361 meta-data file has been introduced, F<META.yml>.
2363 F<META.yml> is a YAML document (see http://www.yaml.org) containing
2364 basic information about the module (name, version, prerequisites...)
2365 in an easy to read format. The format is developed and defined by the
2366 Module::Build developers.
2368 MakeMaker will automatically generate a F<META.yml> file for you and
2369 add it to your F<MANIFEST> as part of the 'distdir' target (and thus
2370 the 'dist' target). This is intended to seamlessly and rapidly
2371 populate CPAN with module meta-data. If you wish to shut this feature
2372 off, set the C<NO_META> C<WriteMakefile()> flag to true.
2375 =head2 Disabling an extension
2377 If some events detected in F<Makefile.PL> imply that there is no way
2378 to create the Module, but this is a normal state of things, then you
2379 can create a F<Makefile> which does nothing, but succeeds on all the
2380 "usual" build targets. To do so, use
2382 ExtUtils::MakeMaker::WriteEmptyMakefile();
2384 instead of WriteMakefile().
2386 This may be useful if other modules expect this module to be I<built>
2387 OK, as opposed to I<work> OK (say, this system-dependent module builds
2388 in a subdirectory of some other distribution, or is listed as a
2389 dependency in a CPAN::Bundle, but the functionality is supported by
2390 different means on the current architecture).
2392 =head2 Other Handy Functions
2398 my $value = prompt($message);
2399 my $value = prompt($message, $default);
2401 The C<prompt()> function provides an easy way to request user input
2402 used to write a makefile. It displays the $message as a prompt for
2403 input. If a $default is provided it will be used as a default. The
2404 function returns the $value selected by the user.
2406 If C<prompt()> detects that it is not running interactively and there
2407 is nothing on STDIN or if the PERL_MM_USE_DEFAULT environment variable
2408 is set to true, the $default will be used without prompting. This
2409 prevents automated processes from blocking on user input.
2411 If no $default is provided an empty string will be used instead.
2422 Command line options used by C<MakeMaker-E<gt>new()>, and thus by
2423 C<WriteMakefile()>. The string is split on whitespace, and the result
2424 is processed before any actual command line arguments are processed.
2426 =item PERL_MM_USE_DEFAULT
2428 If set to a true value then MakeMaker's prompt function will
2429 always return the default without waiting for user input.
2435 ExtUtils::MM_Unix, ExtUtils::Manifest ExtUtils::Install,
2440 Andy Dougherty <F<doughera@lafayette.edu>>, Andreas KE<ouml>nig
2441 <F<andreas.koenig@mind.de>>, Tim Bunce <F<timb@cpan.org>>. VMS
2442 support by Charles Bailey <F<bailey@newman.upenn.edu>>. OS/2 support
2443 by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>.
2445 Currently maintained by Michael G Schwern <F<schwern@pobox.com>>
2447 Send patches and ideas to <F<makemaker@perl.org>>.
2449 Send bug reports via http://rt.cpan.org/. Please send your
2450 generated Makefile along with your report.
2452 For more up-to-date information, see http://www.makemaker.org.
2456 This program is free software; you can redistribute it and/or
2457 modify it under the same terms as Perl itself.
2459 See F<http://www.perl.com/perl/misc/Artistic.html>