lib/ExtUtils/MakeMaker.pm

   1 BEGIN {require 5.002;} # MakeMaker 5.17 was the last MakeMaker that was compatible with perl5.001m
   2
   3 package ExtUtils::MakeMaker;
   4
   5 $VERSION = "5.48_03";
   6 $Version_OK = "5.17";   # Makefiles older than $Version_OK will die
   7                         # (Will be checked from MakeMaker version 4.13 onwards)
   8 ($Revision = substr(q$Revision: 1.4 $, 10)) =~ s/\s+$//;
   9
  10
  11
  12 require Exporter;
  13 use Config;
  14 use Carp ();
  15
  16 use vars qw(
  17             @ISA @EXPORT @EXPORT_OK $AUTOLOAD
  18             $ISA_TTY $Revision $VERSION $Verbose $Version_OK %Config
  19             %Keep_after_flush %MM_Sections %Prepend_dot_dot
  20             %Recognized_Att_Keys @Get_from_Config @MM_Sections @Overridable
  21             @Parent $PACKNAME
  22            );
  23 use strict;
  24
  25 # &DynaLoader::mod2fname should be available to miniperl, thus
  26 # should be a pseudo-builtin (cmp. os2.c).
  27 #eval {require DynaLoader;};
  28
  29 #
  30 # Set up the inheritance before we pull in the MM_* packages, because they
  31 # import variables and functions from here
  32 #
  33 @ISA = qw(Exporter);
  34 @EXPORT = qw(&WriteMakefile &writeMakefile $Verbose &prompt);
  35 @EXPORT_OK = qw($VERSION &Version_check &neatvalue &mkbootstrap &mksymlists);
  36
  37 #
  38 # Dummy package MM inherits actual methods from OS-specific
  39 # default packages.  We use this intermediate package so
  40 # MY::XYZ->func() can call MM->func() and get the proper
  41 # default routine without having to know under what OS
  42 # it's running.
  43 #
  44 @MM::ISA = qw[ExtUtils::MM_Unix ExtUtils::Liblist::Kid ExtUtils::MakeMaker];
  45
  46 #
  47 # Setup dummy package:
  48 # MY exists for overriding methods to be defined within
  49 #
  50 {
  51     package MY;
  52     @MY::ISA = qw(MM);
  53 ###    sub AUTOLOAD { use Devel::Symdump; print Devel::Symdump->rnew->as_string; Carp::confess "hey why? $AUTOLOAD" }
  54     package MM;
  55     sub DESTROY {}
  56 }
  57
  58 # "predeclare the package: we only load it via AUTOLOAD
  59 # but we have already mentioned it in @ISA
  60 package ExtUtils::Liblist::Kid;
  61
  62 package ExtUtils::MakeMaker;
  63 #
  64 # Now we can pull in the friends
  65 #
  66 my $Is_VMS     = $^O eq 'VMS';
  67 my $Is_OS2     = $^O eq 'os2';
  68 my $Is_Mac     = $^O eq 'MacOS';
  69 my $Is_Win32   = $^O eq 'MSWin32';
  70 my $Is_Cygwin  = $^O eq 'cygwin';
  71 my $Is_NetWare = $Config{osname} eq 'NetWare';
  72 my $Is_BeOS    = $^O =~ /beos/i;    # XXX should this be that loose?
  73
  74 require ExtUtils::MM_Unix;
  75
  76 if ($Is_VMS) {
  77     require ExtUtils::MM_VMS;
  78     require VMS::Filespec; # is a noop as long as we require it within MM_VMS
  79 }
  80 if ($Is_OS2) {
  81     require ExtUtils::MM_OS2;
  82 }
  83 if ($Is_Mac) {
  84     require ExtUtils::MM_MacOS;
  85 }
  86 if ($Is_NetWare) {
  87     require ExtUtils::MM_NW5;
  88     $Is_Win32 = 0;
  89 }
  90 if ($Is_Win32) {
  91     require ExtUtils::MM_Win32;
  92 }
  93 if ($Is_Cygwin) {
  94     require ExtUtils::MM_Cygwin;
  95 }
  96 if ($Is_BeOS) {
  97     require ExtUtils::MM_BeOS;
  98 }
  99
 100 full_setup();
 101
 102 # The use of the Version_check target has been dropped between perl
 103 # 5.5.63 and 5.5.64. We must keep the subroutine for a while so that
 104 # old Makefiles can satisfy the Version_check target.
 105
 106 sub Version_check {
 107     my($checkversion) = @_;
 108     die "Your Makefile was built with ExtUtils::MakeMaker v $checkversion.
 109 Current Version is $ExtUtils::MakeMaker::VERSION. There have been considerable
 110 changes in the meantime.
 111 Please rerun 'perl Makefile.PL' to regenerate the Makefile.\n"
 112     if $checkversion < $Version_OK;
 113     printf STDOUT "%s %s %s %s.\n", "Makefile built with ExtUtils::MakeMaker v",
 114     $checkversion, "Current Version is", $VERSION
 115         unless $checkversion == $VERSION;
 116 }
 117
 118 sub warnhandler {
 119     $_[0] =~ /^Use of uninitialized value/ && return;
 120     $_[0] =~ /used only once/ && return;
 121     $_[0] =~ /^Subroutine\s+[\w:]+\s+redefined/ && return;
 122     warn @_;
 123 }
 124
 125 sub WriteMakefile {
 126     Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
 127     local $SIG{__WARN__} = \&warnhandler;
 128
 129     my %att = @_;
 130     MM->new(\%att)->flush;
 131 }
 132
 133 sub prompt ($;$) {
 134     my($mess,$def)=@_;
 135     $ISA_TTY = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ;   # Pipe?
 136     Carp::confess("prompt function called without an argument") unless defined $mess;
 137     my $dispdef = defined $def ? "[$def] " : " ";
 138     $def = defined $def ? $def : "";
 139     my $ans;
 140     local $|=1;
 141     print "$mess $dispdef";
 142     if ($ISA_TTY && !$ENV{PERL_MM_USE_DEFAULT}) {
 143         chomp($ans = <STDIN>);
 144     } else {
 145         print "$def\n";
 146     }
 147     return ($ans ne '') ? $ans : $def;
 148 }
 149
 150 sub eval_in_subdirs {
 151     my($self) = @_;
 152     use Cwd qw(cwd abs_path);
 153     my $pwd = cwd();
 154     local @INC = map eval {abs_path($_) if -e} || $_, @INC;
 155
 156     foreach my $dir (@{$self->{DIR}}){
 157         my($abs) = $self->catdir($pwd,$dir);
 158         $self->eval_in_x($abs);
 159     }
 160     chdir $pwd;
 161 }
 162
 163 sub eval_in_x {
 164     my($self,$dir) = @_;
 165     package main;
 166     chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
 167
 168     eval { do './Makefile.PL' };
 169     if ($@) {
 170 #         if ($@ =~ /prerequisites/) {
 171 #             die "MakeMaker WARNING: $@";
 172 #         } else {
 173 #             warn "WARNING from evaluation of $dir/Makefile.PL: $@";
 174 #         }
 175         warn "WARNING from evaluation of $dir/Makefile.PL: $@";
 176     }
 177 }
 178
 179 sub full_setup {
 180     $Verbose ||= 0;
 181
 182     # package name for the classes into which the first object will be blessed
 183     $PACKNAME = "PACK000";
 184
 185     my @attrib_help = qw/
 186
 187     AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION
 188     C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
 189     EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE FULLPERL FUNCLIST H
 190     HTMLLIBPODS HTMLSCRIPTPODS IMPORTS
 191     INC INCLUDE_EXT INSTALLARCHLIB INSTALLBIN INSTALLDIRS INSTALLHTMLPRIVLIBDIR
 192     INSTALLHTMLSCRIPTDIR INSTALLHTMLSITELIBDIR INSTALLMAN1DIR
 193     INSTALLMAN3DIR INSTALLPRIVLIB INSTALLSCRIPT INSTALLSITEARCH
 194     INSTALLSITELIB INST_ARCHLIB INST_BIN INST_EXE INST_LIB
 195     INST_HTMLLIBDIR INST_HTMLSCRIPTDIR
 196     INST_MAN1DIR INST_MAN3DIR INST_SCRIPT LDFROM LIB LIBPERL_A LIBS
 197     LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB
 198     PERL_MALLOC_OK
 199     NAME NEEDS_LINKING NOECHO NORECURS NO_VC OBJECT OPTIMIZE PERL PERLMAINCC
 200     PERLRUN PERLRUNINST PERL_ARCHLIB PERL_CORE
 201     PERL_LIB PERL_SRC PERM_RW PERM_RWX
 202     PL_FILES PM PM_FILTER PMLIBDIRS POLLUTE PPM_INSTALL_EXEC
 203     PPM_INSTALL_SCRIPT PREFIX
 204     PREREQ_FATAL PREREQ_PM PREREQ_PRINT PRINT_PREREQ
 205     SKIP TEST_LIBS TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
 206     XS_VERSION clean depend dist dynamic_lib linkext macro realclean
 207     tool_autosplit
 208     MACPERL_SRC MACPERL_LIB MACLIBS_68K MACLIBS_PPC MACLIBS_SC MACLIBS_MRC
 209     MACLIBS_ALL_68K MACLIBS_ALL_PPC MACLIBS_SHARED
 210         /;
 211
 212     # IMPORTS is used under OS/2 and Win32
 213
 214     # @Overridable is close to @MM_Sections but not identical.  The
 215     # order is important. Many subroutines declare macros. These
 216     # depend on each other. Let's try to collect the macros up front,
 217     # then pasthru, then the rules.
 218
 219     # MM_Sections are the sections we have to call explicitly
 220     # in Overridable we have subroutines that are used indirectly
 221
 222
 223     @MM_Sections =
 224         qw(
 225
 226  post_initialize const_config constants tool_autosplit tool_xsubpp
 227  tools_other dist macro depend cflags const_loadlibs const_cccmd
 228  post_constants
 229
 230  pasthru
 231
 232  c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs
 233  dynamic_lib static static_lib htmlifypods manifypods processPL
 234  installbin subdirs
 235  clean realclean dist_basics dist_core dist_dir dist_test dist_ci
 236  install force perldepend makefile staticmake test ppd
 237
 238           ); # loses section ordering
 239
 240     @Overridable = @MM_Sections;
 241     push @Overridable, qw[
 242
 243  dir_target libscan makeaperl needs_linking perm_rw perm_rwx
 244  subdir_x test_via_harness test_via_script
 245                          ];
 246
 247     push @MM_Sections, qw[
 248
 249  pm_to_blib selfdocument
 250
 251                          ];
 252
 253     # Postamble needs to be the last that was always the case
 254     push @MM_Sections, "postamble";
 255     push @Overridable, "postamble";
 256
 257     # All sections are valid keys.
 258     @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
 259
 260     # we will use all these variables in the Makefile
 261     @Get_from_Config =
 262         qw(
 263            ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc
 264            lib_ext obj_ext osname osvers ranlib sitelibexp sitearchexp so
 265            exe_ext full_ar
 266           );
 267
 268     foreach my $item (@attrib_help){
 269         $Recognized_Att_Keys{$item} = 1;
 270     }
 271     foreach my $item (@Get_from_Config) {
 272         $Recognized_Att_Keys{uc $item} = $Config{$item};
 273         print "Attribute '\U$item\E' => '$Config{$item}'\n"
 274             if ($Verbose >= 2);
 275     }
 276
 277     #
 278     # When we eval a Makefile.PL in a subdirectory, that one will ask
 279     # us (the parent) for the values and will prepend "..", so that
 280     # all files to be installed end up below OUR ./blib
 281     #
 282     %Prepend_dot_dot =
 283         qw(
 284
 285            INST_BIN 1 INST_EXE 1 INST_LIB 1 INST_ARCHLIB 1 INST_SCRIPT 1
 286            MAP_TARGET 1 INST_HTMLLIBDIR 1 INST_HTMLSCRIPTDIR 1
 287            INST_MAN1DIR 1 INST_MAN3DIR 1 PERL_SRC 1 PERL 1 FULLPERL 1
 288
 289           );
 290
 291     my @keep = qw/
 292         NEEDS_LINKING HAS_LINK_CODE
 293         /;
 294     @Keep_after_flush{@keep} = (1) x @keep;
 295 }
 296
 297 sub writeMakefile {
 298     die <<END;
 299
 300 The extension you are trying to build apparently is rather old and
 301 most probably outdated. We detect that from the fact, that a
 302 subroutine "writeMakefile" is called, and this subroutine is not
 303 supported anymore since about October 1994.
 304
 305 Please contact the author or look into CPAN (details about CPAN can be
 306 found in the FAQ and at http:/www.perl.com) for a more recent version
 307 of the extension. If you're really desperate, you can try to change
 308 the subroutine name from writeMakefile to WriteMakefile and rerun
 309 'perl Makefile.PL', but you're most probably left alone, when you do
 310 so.
 311
 312 The MakeMaker team
 313
 314 END
 315 }
 316
 317 sub ExtUtils::MakeMaker::new {
 318     my($class,$self) = @_;
 319     my($key);
 320
 321     if ("@ARGV" =~ /\bPREREQ_PRINT\b/) {
 322         require Data::Dumper;
 323         print Data::Dumper->Dump([$self->{PREREQ_PM}], [qw(PREREQ_PM)]);
 324    }
 325
 326     # PRINT_PREREQ is RedHatism.
 327     if ("@ARGV" =~ /\bPRINT_PREREQ\b/) {
 328         print join(" ", map { "perl($_)>=$self->{PREREQ_PM}->{$_} " } sort keys %{$self->{PREREQ_PM}}), "\n";
 329         exit 0;
 330    }
 331
 332     print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
 333     if (-f "MANIFEST" && ! -f "Makefile"){
 334         check_manifest();
 335     }
 336
 337     $self = {} unless (defined $self);
 338
 339     check_hints($self);
 340
 341     my %configure_att;         # record &{$self->{CONFIGURE}} attributes
 342     my(%initial_att) = %$self; # record initial attributes
 343
 344     my(%unsatisfied) = ();
 345     foreach my $prereq (sort keys %{$self->{PREREQ_PM}}) {
 346         eval "require $prereq";
 347
 348         if ($@) {
 349             warn "Warning: prerequisite $prereq $self->{PREREQ_PM}->{$prereq} not found.\n" unless $self->{PREREQ_FATAL};
 350             $unsatisfied{$prereq} = 'not installed';
 351         } elsif ($prereq->VERSION < $self->{PREREQ_PM}->{$prereq} ){
 352             warn "Warning: prerequisite $prereq $self->{PREREQ_PM}->{$prereq} not found. We have "
 353                . ($prereq->VERSION || 'unknown version') unless $self->{PREREQ_FATAL};
 354             $unsatisfied{$prereq} = $self->{PREREQ_PM}->{$prereq} ? $self->{PREREQ_PM}->{$prereq} : 'unknown version' ;
 355         }
 356     }
 357     if (%unsatisfied && $self->{PREREQ_FATAL}){
 358 #         unless (defined $ExtUtils::MakeMaker::useCPAN) {
 359         my $failedprereqs = join ', ', map {"$_ $unsatisfied{$_}"} keys %unsatisfied;
 360         die qq{MakeMaker FATAL: prerequisites not found ($failedprereqs)
 361                  Please install these modules first and rerun 'perl Makefile.PL'.\n};
 362 #             if ($ExtUtils::MakeMaker::hasCPAN) {
 363 #                 $ExtUtils::MakeMaker::useCPAN = prompt(qq{Should I try to use the CPAN module to fetch them for you?},"yes");
 364 #             } else {
 365 #                 print qq{Hint: You may want to install the CPAN module to autofetch the needed modules\n};
 366 #                 $ExtUtils::MakeMaker::useCPAN=0;
 367 #             }
 368 #         }
 369 #         if ($ExtUtils::MakeMaker::useCPAN) {
 370 #             require CPAN;
 371 #             CPAN->import(@unsatisfied);
 372 #         } else {
 373 #             die qq{prerequisites not found (@unsatisfied)};
 374 #         }
 375 #       warn qq{WARNING: prerequisites not found (@unsatisfied)};
 376     }
 377
 378     if (defined $self->{CONFIGURE}) {
 379         if (ref $self->{CONFIGURE} eq 'CODE') {
 380             %configure_att = %{&{$self->{CONFIGURE}}};
 381             $self = { %$self, %configure_att };
 382         } else {
 383             Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
 384         }
 385     }
 386
 387     # This is for old Makefiles written pre 5.00, will go away
 388     if ( Carp::longmess("") =~ /runsubdirpl/s ){
 389         Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
 390     }
 391
 392     my $newclass = ++$PACKNAME;
 393     local @Parent = @Parent;    # Protect against non-local exits
 394     {
 395         no strict 'refs';
 396         print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
 397         mv_all_methods("MY",$newclass);
 398         bless $self, $newclass;
 399         push @Parent, $self;
 400         @{"$newclass\:\:ISA"} = 'MM';
 401     }
 402
 403     if (defined $Parent[-2]){
 404         $self->{PARENT} = $Parent[-2];
 405         my $key;
 406         for $key (keys %Prepend_dot_dot) {
 407             next unless defined $self->{PARENT}{$key};
 408             $self->{$key} = $self->{PARENT}{$key};
 409                 # PERL and FULLPERL may be command verbs instead of full
 410                 # file specifications under VMS.  If so, don't turn them
 411                 # into a filespec.
 412             $self->{$key} = $self->catdir("..",$self->{$key})
 413                 unless $self->file_name_is_absolute($self->{$key})
 414                 || ($^O eq 'VMS' and ($key =~ /PERL$/ && $self->{$key} =~ /^[\w\-\$]+$/));
 415         }
 416         if ($self->{PARENT}) {
 417             $self->{PARENT}->{CHILDREN}->{$newclass} = $self;
 418             foreach my $opt (qw(POLLUTE PERL_CORE)) {
 419                 if (exists $self->{PARENT}->{$opt}
 420                     and not exists $self->{$opt})
 421                     {
 422                         # inherit, but only if already unspecified
 423                         $self->{$opt} = $self->{PARENT}->{$opt};
 424                     }
 425             }
 426         }
 427         my @fm = grep /^FIRST_MAKEFILE=/, @ARGV;
 428         parse_args($self,@fm) if @fm;
 429     } else {
 430         parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV);
 431     }
 432
 433     $self->{NAME} ||= $self->guess_name;
 434
 435     ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
 436
 437     $self->init_main();
 438
 439     if (! $self->{PERL_SRC} ) {
 440         my($pthinks) = $self->canonpath($INC{'Config.pm'});
 441         my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
 442         $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
 443         if ($pthinks ne $cthinks &&
 444             !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
 445             print "Have $pthinks expected $cthinks\n";
 446             if ($Is_Win32) {
 447                 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
 448             }
 449             else {
 450                 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
 451             }
 452             print STDOUT <<END unless $self->{UNINSTALLED_PERL};
 453 Your perl and your Config.pm seem to have different ideas about the architecture
 454 they are running on.
 455 Perl thinks: [$pthinks]
 456 Config says: [$Config{archname}]
 457 This may or may not cause problems. Please check your installation of perl if you
 458 have problems building this extension.
 459 END
 460         }
 461     }
 462
 463     $self->init_dirscan();
 464     $self->init_others();
 465     my($argv) = neatvalue(\@ARGV);
 466     $argv =~ s/^\[/(/;
 467     $argv =~ s/\]$/)/;
 468
 469     push @{$self->{RESULT}}, <<END;
 470 # This Makefile is for the $self->{NAME} extension to perl.
 471 #
 472 # It was generated automatically by MakeMaker version
 473 # $VERSION (Revision: $Revision) from the contents of
 474 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
 475 #
 476 #       ANY CHANGES MADE HERE WILL BE LOST!
 477 #
 478 #   MakeMaker ARGV: $argv
 479 #
 480 #   MakeMaker Parameters:
 481 END
 482
 483     foreach my $key (sort keys %initial_att){
 484         my($v) = neatvalue($initial_att{$key});
 485         $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
 486         $v =~ tr/\n/ /s;
 487         push @{$self->{RESULT}}, "#     $key => $v";
 488     }
 489     undef %initial_att;        # free memory
 490
 491     if (defined $self->{CONFIGURE}) {
 492        push @{$self->{RESULT}}, <<END;
 493
 494 #   MakeMaker 'CONFIGURE' Parameters:
 495 END
 496         if (scalar(keys %configure_att) > 0) {
 497             foreach my $key (sort keys %configure_att){
 498                my($v) = neatvalue($configure_att{$key});
 499                $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
 500                $v =~ tr/\n/ /s;
 501                push @{$self->{RESULT}}, "#     $key => $v";
 502             }
 503         }
 504         else
 505         {
 506            push @{$self->{RESULT}}, "# no values returned";
 507         }
 508         undef %configure_att;  # free memory
 509     }
 510
 511     # turn the SKIP array into a SKIPHASH hash
 512     my (%skip,$skip);
 513     for $skip (@{$self->{SKIP} || []}) {
 514         $self->{SKIPHASH}{$skip} = 1;
 515     }
 516     delete $self->{SKIP}; # free memory
 517
 518     if ($self->{PARENT}) {
 519         for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
 520             $self->{SKIPHASH}{$_} = 1;
 521         }
 522     }
 523
 524     # We run all the subdirectories now. They don't have much to query
 525     # from the parent, but the parent has to query them: if they need linking!
 526     unless ($self->{NORECURS}) {
 527         $self->eval_in_subdirs if @{$self->{DIR}};
 528     }
 529
 530     foreach my $section ( @MM_Sections ){
 531         print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
 532         my($skipit) = $self->skipcheck($section);
 533         if ($skipit){
 534             push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
 535         } else {
 536             my(%a) = %{$self->{$section} || {}};
 537             push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
 538             push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
 539             push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
 540         }
 541     }
 542
 543     push @{$self->{RESULT}}, "\n# End.";
 544
 545     $self;
 546 }
 547
 548 sub WriteEmptyMakefile {
 549     Carp::croak "WriteEmptyMakefile: Need even number of args" if @_ % 2;
 550     local $SIG{__WARN__} = \&warnhandler;
 551
 552     my %att = @_;
 553     my $self = MM->new(\%att);
 554     if (-f "$self->{MAKEFILE}.old") {
 555       chmod 0666, "$self->{MAKEFILE}.old";
 556       unlink "$self->{MAKEFILE}.old" or warn "unlink $self->{MAKEFILE}.old: $!";
 557     }
 558     rename $self->{MAKEFILE}, "$self->{MAKEFILE}.old"
 559       or warn "rename $self->{MAKEFILE} $self->{MAKEFILE}.old: $!"
 560         if -f $self->{MAKEFILE};
 561     open MF, '>', $self->{MAKEFILE} or die "open $self->{MAKEFILE} for write: $!";
 562     print MF <<'EOP';
 563 all:
 564
 565 clean:
 566
 567 install:
 568
 569 makemakerdflt:
 570
 571 test:
 572
 573 EOP
 574     close MF or die "close $self->{MAKEFILE} for write: $!";
 575 }
 576
 577 sub check_manifest {
 578     print STDOUT "Checking if your kit is complete...\n";
 579     require ExtUtils::Manifest;
 580     # avoid warning
 581     $ExtUtils::Manifest::Quiet = $ExtUtils::Manifest::Quiet = 1;
 582     my(@missed) = ExtUtils::Manifest::manicheck();
 583     if (@missed) {
 584         print STDOUT "Warning: the following files are missing in your kit:\n";
 585         print "\t", join "\n\t", @missed;
 586         print STDOUT "\n";
 587         print STDOUT "Please inform the author.\n";
 588     } else {
 589         print STDOUT "Looks good\n";
 590     }
 591 }
 592
 593 sub parse_args{
 594     my($self, @args) = @_;
 595     foreach (@args) {
 596         unless (m/(.*?)=(.*)/) {
 597             help(),exit 1 if m/^help$/;
 598             ++$Verbose if m/^verb/;
 599             next;
 600         }
 601         my($name, $value) = ($1, $2);
 602         if ($value =~ m/^~(\w+)?/) { # tilde with optional username
 603             $value =~ s [^~(\w*)]
 604                 [$1 ?
 605                  ((getpwnam($1))[7] || "~$1") :
 606                  (getpwuid($>))[7]
 607                  ]ex;
 608         }
 609         $self->{uc($name)} = $value;
 610     }
 611
 612     # catch old-style 'potential_libs' and inform user how to 'upgrade'
 613     if (defined $self->{potential_libs}){
 614         my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
 615         if ($self->{potential_libs}){
 616             print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
 617         } else {
 618             print STDOUT "$msg deleted.\n";
 619         }
 620         $self->{LIBS} = [$self->{potential_libs}];
 621         delete $self->{potential_libs};
 622     }
 623     # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
 624     if (defined $self->{ARMAYBE}){
 625         my($armaybe) = $self->{ARMAYBE};
 626         print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
 627                         "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
 628         my(%dl) = %{$self->{dynamic_lib} || {}};
 629         $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
 630         delete $self->{ARMAYBE};
 631     }
 632     if (defined $self->{LDTARGET}){
 633         print STDOUT "LDTARGET should be changed to LDFROM\n";
 634         $self->{LDFROM} = $self->{LDTARGET};
 635         delete $self->{LDTARGET};
 636     }
 637     # Turn a DIR argument on the command line into an array
 638     if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
 639         # So they can choose from the command line, which extensions they want
 640         # the grep enables them to have some colons too much in case they
 641         # have to build a list with the shell
 642         $self->{DIR} = [grep $_, split ":", $self->{DIR}];
 643     }
 644     # Turn a INCLUDE_EXT argument on the command line into an array
 645     if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
 646         $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
 647     }
 648     # Turn a EXCLUDE_EXT argument on the command line into an array
 649     if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
 650         $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
 651     }
 652
 653     foreach my $mmkey (sort keys %$self){
 654         print STDOUT "  $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
 655         print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
 656             unless exists $Recognized_Att_Keys{$mmkey};
 657     }
 658     $| = 1 if $Verbose;
 659 }
 660
 661 sub check_hints {
 662     my($self) = @_;
 663     # We allow extension-specific hints files.
 664
 665     return unless -d "hints";
 666
 667     # First we look for the best hintsfile we have
 668     my($hint)="${^O}_$Config{osvers}";
 669     $hint =~ s/\./_/g;
 670     $hint =~ s/_$//;
 671     return unless $hint;
 672
 673     # Also try without trailing minor version numbers.
 674     while (1) {
 675         last if -f "hints/$hint.pl";      # found
 676     } continue {
 677         last unless $hint =~ s/_[^_]*$//; # nothing to cut off
 678     }
 679     my $hint_file = "hints/$hint.pl";
 680
 681     return unless -f $hint_file;    # really there
 682
 683     # execute the hintsfile:
 684     print STDERR "Processing hints file $hint_file\n";
 685     {
 686         local *HINT;
 687         open(HINT, $hint_file) || die "Can't open $hint_file: $!";
 688         eval join '', <HINT>;
 689         close HINT;
 690     }
 691     print STDERR $@ if $@;
 692 }
 693
 694 sub mv_all_methods {
 695     my($from,$to) = @_;
 696     no strict 'refs';
 697     my($symtab) = \%{"${from}::"};
 698
 699     # Here you see the *current* list of methods that are overridable
 700     # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
 701     # still trying to reduce the list to some reasonable minimum --
 702     # because I want to make it easier for the user. A.K.
 703
 704     foreach my $method (@Overridable) {
 705
 706         # We cannot say "next" here. Nick might call MY->makeaperl
 707         # which isn't defined right now
 708
 709         # Above statement was written at 4.23 time when Tk-b8 was
 710         # around. As Tk-b9 only builds with 5.002something and MM 5 is
 711         # standard, we try to enable the next line again. It was
 712         # commented out until MM 5.23
 713
 714         next unless defined &{"${from}::$method"};
 715
 716         *{"${to}::$method"} = \&{"${from}::$method"};
 717
 718         # delete would do, if we were sure, nobody ever called
 719         # MY->makeaperl directly
 720
 721         # delete $symtab->{$method};
 722
 723         # If we delete a method, then it will be undefined and cannot
 724         # be called.  But as long as we have Makefile.PLs that rely on
 725         # %MY:: being intact, we have to fill the hole with an
 726         # inheriting method:
 727
 728         eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
 729     }
 730
 731     # We have to clean out %INC also, because the current directory is
 732     # changed frequently and Graham Barr prefers to get his version
 733     # out of a History.pl file which is "required" so woudn't get
 734     # loaded again in another extension requiring a History.pl
 735
 736     # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
 737     # to core dump in the middle of a require statement. The required
 738     # file was Tk/MMutil.pm.  The consequence is, we have to be
 739     # extremely careful when we try to give perl a reason to reload a
 740     # library with same name.  The workaround prefers to drop nothing
 741     # from %INC and teach the writers not to use such libraries.
 742
 743 #    my $inc;
 744 #    foreach $inc (keys %INC) {
 745 #       #warn "***$inc*** deleted";
 746 #       delete $INC{$inc};
 747 #    }
 748 }
 749
 750 sub skipcheck {
 751     my($self) = shift;
 752     my($section) = @_;
 753     if ($section eq 'dynamic') {
 754         print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
 755         "in skipped section 'dynamic_bs'\n"
 756             if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
 757         print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
 758         "in skipped section 'dynamic_lib'\n"
 759             if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
 760     }
 761     if ($section eq 'dynamic_lib') {
 762         print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
 763         "targets in skipped section 'dynamic_bs'\n"
 764             if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
 765     }
 766     if ($section eq 'static') {
 767         print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
 768         "in skipped section 'static_lib'\n"
 769             if $self->{SKIPHASH}{static_lib} && $Verbose;
 770     }
 771     return 'skipped' if $self->{SKIPHASH}{$section};
 772     return '';
 773 }
 774
 775 sub flush {
 776     my $self = shift;
 777     my($chunk);
 778 #    use FileHandle ();
 779 #    my $fh = new FileHandle;
 780     local *FH;
 781     print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
 782
 783     unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
 784 #    $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
 785     open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
 786
 787     for $chunk (@{$self->{RESULT}}) {
 788 #       print $fh "$chunk\n";
 789         print FH "$chunk\n";
 790     }
 791
 792 #    $fh->close;
 793     close FH;
 794     my($finalname) = $self->{MAKEFILE};
 795     rename("MakeMaker.tmp", $finalname);
 796     chmod 0644, $finalname unless $Is_VMS;
 797
 798     if ($self->{PARENT}) {
 799         foreach (keys %$self) { # safe memory
 800             delete $self->{$_} unless $Keep_after_flush{$_};
 801         }
 802     }
 803
 804     system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
 805 }
 806
 807 # The following mkbootstrap() is only for installations that are calling
 808 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
 809 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
 810 sub mkbootstrap {
 811     die <<END;
 812 !!! Your Makefile has been built such a long time ago, !!!
 813 !!! that is unlikely to work with current MakeMaker.   !!!
 814 !!! Please rebuild your Makefile                       !!!
 815 END
 816 }
 817
 818 # Ditto for mksymlists() as of MakeMaker 5.17
 819 sub mksymlists {
 820     die <<END;
 821 !!! Your Makefile has been built such a long time ago, !!!
 822 !!! that is unlikely to work with current MakeMaker.   !!!
 823 !!! Please rebuild your Makefile                       !!!
 824 END
 825 }
 826
 827 sub neatvalue {
 828     my($v) = @_;
 829     return "undef" unless defined $v;
 830     my($t) = ref $v;
 831     return "q[$v]" unless $t;
 832     if ($t eq 'ARRAY') {
 833         my(@m, @neat);
 834         push @m, "[";
 835         foreach my $elem (@$v) {
 836             push @neat, "q[$elem]";
 837         }
 838         push @m, join ", ", @neat;
 839         push @m, "]";
 840         return join "", @m;
 841     }
 842     return "$v" unless $t eq 'HASH';
 843     my(@m, $key, $val);
 844     while (($key,$val) = each %$v){
 845         last unless defined $key; # cautious programming in case (undef,undef) is true
 846         push(@m,"$key=>".neatvalue($val)) ;
 847     }
 848     return "{ ".join(', ',@m)." }";
 849 }
 850
 851 sub selfdocument {
 852     my($self) = @_;
 853     my(@m);
 854     if ($Verbose){
 855         push @m, "\n# Full list of MakeMaker attribute values:";
 856         foreach my $key (sort keys %$self){
 857             next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
 858             my($v) = neatvalue($self->{$key});
 859             $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
 860             $v =~ tr/\n/ /s;
 861             push @m, "# $key => $v";
 862         }
 863     }
 864     join "\n", @m;
 865 }
 866
 867 package ExtUtils::MakeMaker;
 868 1;
 869
 870 __END__
 871
 872 =head1 NAME
 873
 874 ExtUtils::MakeMaker - create an extension Makefile
 875
 876 =head1 SYNOPSIS
 877
 878 C<use ExtUtils::MakeMaker;>
 879
 880 C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
 881
 882 which is really
 883
 884 C<MM-E<gt>new(\%att)-E<gt>flush;>
 885
 886 =head1 DESCRIPTION
 887
 888 This utility is designed to write a Makefile for an extension module
 889 from a Makefile.PL. It is based on the Makefile.SH model provided by
 890 Andy Dougherty and the perl5-porters.
 891
 892 It splits the task of generating the Makefile into several subroutines
 893 that can be individually overridden.  Each subroutine returns the text
 894 it wishes to have written to the Makefile.
 895
 896 MakeMaker is object oriented. Each directory below the current
 897 directory that contains a Makefile.PL. Is treated as a separate
 898 object. This makes it possible to write an unlimited number of
 899 Makefiles with a single invocation of WriteMakefile().
 900
 901 =head2 How To Write A Makefile.PL
 902
 903 The short answer is: Don't.
 904
 905         Always begin with h2xs.
 906         Always begin with h2xs!
 907         ALWAYS BEGIN WITH H2XS!
 908
 909 even if you're not building around a header file, and even if you
 910 don't have an XS component.
 911
 912 Run h2xs(1) before you start thinking about writing a module. For so
 913 called pm-only modules that consist of C<*.pm> files only, h2xs has
 914 the C<-X> switch. This will generate dummy files of all kinds that are
 915 useful for the module developer.
 916
 917 The medium answer is:
 918
 919     use ExtUtils::MakeMaker;
 920     WriteMakefile( NAME => "Foo::Bar" );
 921
 922 The long answer is the rest of the manpage :-)
 923
 924 =head2 Default Makefile Behaviour
 925
 926 The generated Makefile enables the user of the extension to invoke
 927
 928   perl Makefile.PL # optionally "perl Makefile.PL verbose"
 929   make
 930   make test        # optionally set TEST_VERBOSE=1
 931   make install     # See below
 932
 933 The Makefile to be produced may be altered by adding arguments of the
 934 form C<KEY=VALUE>. E.g.
 935
 936   perl Makefile.PL PREFIX=/tmp/myperl5
 937
 938 Other interesting targets in the generated Makefile are
 939
 940   make config     # to check if the Makefile is up-to-date
 941   make clean      # delete local temp files (Makefile gets renamed)
 942   make realclean  # delete derived files (including ./blib)
 943   make ci         # check in all the files in the MANIFEST file
 944   make dist       # see below the Distribution Support section
 945
 946 =head2 make test
 947
 948 MakeMaker checks for the existence of a file named F<test.pl> in the
 949 current directory and if it exists it adds commands to the test target
 950 of the generated Makefile that will execute the script with the proper
 951 set of perl C<-I> options.
 952
 953 MakeMaker also checks for any files matching glob("t/*.t"). It will
 954 add commands to the test target of the generated Makefile that execute
 955 all matching files via the L<Test::Harness> module with the C<-I>
 956 switches set correctly.
 957
 958 =head2 make testdb
 959
 960 A useful variation of the above is the target C<testdb>. It runs the
 961 test under the Perl debugger (see L<perldebug>). If the file
 962 F<test.pl> exists in the current directory, it is used for the test.
 963
 964 If you want to debug some other testfile, set C<TEST_FILE> variable
 965 thusly:
 966
 967   make testdb TEST_FILE=t/mytest.t
 968
 969 By default the debugger is called using C<-d> option to perl. If you
 970 want to specify some other option, set C<TESTDB_SW> variable:
 971
 972   make testdb TESTDB_SW=-Dx
 973
 974 =head2 make install
 975
 976 make alone puts all relevant files into directories that are named by
 977 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_HTMLLIBDIR,
 978 INST_HTMLSCRIPTDIR, INST_MAN1DIR, and INST_MAN3DIR.  All these default
 979 to something below ./blib if you are I<not> building below the perl
 980 source directory. If you I<are> building below the perl source,
 981 INST_LIB and INST_ARCHLIB default to ../../lib, and INST_SCRIPT is not
 982 defined.
 983
 984 The I<install> target of the generated Makefile copies the files found
 985 below each of the INST_* directories to their INSTALL*
 986 counterparts. Which counterparts are chosen depends on the setting of
 987 INSTALLDIRS according to the following table:
 988
 989                                  INSTALLDIRS set to
 990                               perl                site
 991
 992     INST_ARCHLIB        INSTALLARCHLIB        INSTALLSITEARCH
 993     INST_LIB            INSTALLPRIVLIB        INSTALLSITELIB
 994     INST_HTMLLIBDIR     INSTALLHTMLPRIVLIBDIR INSTALLHTMLSITELIBDIR
 995     INST_HTMLSCRIPTDIR            INSTALLHTMLSCRIPTDIR
 996     INST_BIN                      INSTALLBIN
 997     INST_SCRIPT                   INSTALLSCRIPT
 998     INST_MAN1DIR                  INSTALLMAN1DIR
 999     INST_MAN3DIR                  INSTALLMAN3DIR
1000
1001 The INSTALL... macros in turn default to their %Config
1002 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
1003
1004 You can check the values of these variables on your system with
1005
1006     perl '-V:install.*'
1007
1008 And to check the sequence in which the library directories are
1009 searched by perl, run
1010
1011     perl -le 'print join $/, @INC'
1012
1013
1014 =head2 PREFIX and LIB attribute
1015
1016 PREFIX and LIB can be used to set several INSTALL* attributes in one
1017 go. The quickest way to install a module in a non-standard place might
1018 be
1019
1020     perl Makefile.PL LIB=~/lib
1021
1022 This will install the module's architecture-independent files into
1023 ~/lib, the architecture-dependent files into ~/lib/$archname.
1024
1025 Another way to specify many INSTALL directories with a single
1026 parameter is PREFIX.
1027
1028     perl Makefile.PL PREFIX=~
1029
1030 This will replace the string specified by C<$Config{prefix}> in all
1031 C<$Config{install*}> values.
1032
1033 Note, that in both cases the tilde expansion is done by MakeMaker, not
1034 by perl by default, nor by make.
1035
1036 Conflicts between parameters LIB,
1037 PREFIX and the various INSTALL* arguments are resolved so that:
1038
1039 =over 4
1040
1041 =item *
1042
1043 setting LIB overrides any setting of INSTALLPRIVLIB, INSTALLARCHLIB,
1044 INSTALLSITELIB, INSTALLSITEARCH (and they are not affected by PREFIX);
1045
1046 =item *
1047
1048 without LIB, setting PREFIX replaces the initial C<$Config{prefix}>
1049 part of those INSTALL* arguments, even if the latter are explicitly
1050 set (but are set to still start with C<$Config{prefix}>).
1051
1052 =back
1053
1054 If the user has superuser privileges, and is not working on AFS
1055 or relatives, then the defaults for
1056 INSTALLPRIVLIB, INSTALLARCHLIB, INSTALLSCRIPT, etc. will be appropriate,
1057 and this incantation will be the best:
1058
1059     perl Makefile.PL; make; make test
1060     make install
1061
1062 make install per default writes some documentation of what has been
1063 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1064 can be bypassed by calling make pure_install.
1065
1066 =head2 AFS users
1067
1068 will have to specify the installation directories as these most
1069 probably have changed since perl itself has been installed. They will
1070 have to do this by calling
1071
1072     perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1073         INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1074     make
1075
1076 Be careful to repeat this procedure every time you recompile an
1077 extension, unless you are sure the AFS installation directories are
1078 still valid.
1079
1080 =head2 Static Linking of a new Perl Binary
1081
1082 An extension that is built with the above steps is ready to use on
1083 systems supporting dynamic loading. On systems that do not support
1084 dynamic loading, any newly created extension has to be linked together
1085 with the available resources. MakeMaker supports the linking process
1086 by creating appropriate targets in the Makefile whenever an extension
1087 is built. You can invoke the corresponding section of the makefile with
1088
1089     make perl
1090
1091 That produces a new perl binary in the current directory with all
1092 extensions linked in that can be found in INST_ARCHLIB, SITELIBEXP,
1093 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1094 UNIX, this is called Makefile.aperl (may be system dependent). If you
1095 want to force the creation of a new perl, it is recommended, that you
1096 delete this Makefile.aperl, so the directories are searched-through
1097 for linkable libraries again.
1098
1099 The binary can be installed into the directory where perl normally
1100 resides on your machine with
1101
1102     make inst_perl
1103
1104 To produce a perl binary with a different name than C<perl>, either say
1105
1106     perl Makefile.PL MAP_TARGET=myperl
1107     make myperl
1108     make inst_perl
1109
1110 or say
1111
1112     perl Makefile.PL
1113     make myperl MAP_TARGET=myperl
1114     make inst_perl MAP_TARGET=myperl
1115
1116 In any case you will be prompted with the correct invocation of the
1117 C<inst_perl> target that installs the new binary into INSTALLBIN.
1118
1119 make inst_perl per default writes some documentation of what has been
1120 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1121 can be bypassed by calling make pure_inst_perl.
1122
1123 Warning: the inst_perl: target will most probably overwrite your
1124 existing perl binary. Use with care!
1125
1126 Sometimes you might want to build a statically linked perl although
1127 your system supports dynamic loading. In this case you may explicitly
1128 set the linktype with the invocation of the Makefile.PL or make:
1129
1130     perl Makefile.PL LINKTYPE=static    # recommended
1131
1132 or
1133
1134     make LINKTYPE=static                # works on most systems
1135
1136 =head2 Determination of Perl Library and Installation Locations
1137
1138 MakeMaker needs to know, or to guess, where certain things are
1139 located.  Especially INST_LIB and INST_ARCHLIB (where to put the files
1140 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1141 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1142
1143 Extensions may be built either using the contents of the perl source
1144 directory tree or from the installed perl library. The recommended way
1145 is to build extensions after you have run 'make install' on perl
1146 itself. You can do that in any directory on your hard disk that is not
1147 below the perl source tree. The support for extensions below the ext
1148 directory of the perl distribution is only good for the standard
1149 extensions that come with perl.
1150
1151 If an extension is being built below the C<ext/> directory of the perl
1152 source then MakeMaker will set PERL_SRC automatically (e.g.,
1153 C<../..>).  If PERL_SRC is defined and the extension is recognized as
1154 a standard extension, then other variables default to the following:
1155
1156   PERL_INC     = PERL_SRC
1157   PERL_LIB     = PERL_SRC/lib
1158   PERL_ARCHLIB = PERL_SRC/lib
1159   INST_LIB     = PERL_LIB
1160   INST_ARCHLIB = PERL_ARCHLIB
1161
1162 If an extension is being built away from the perl source then MakeMaker
1163 will leave PERL_SRC undefined and default to using the installed copy
1164 of the perl library. The other variables default to the following:
1165
1166   PERL_INC     = $archlibexp/CORE
1167   PERL_LIB     = $privlibexp
1168   PERL_ARCHLIB = $archlibexp
1169   INST_LIB     = ./blib/lib
1170   INST_ARCHLIB = ./blib/arch
1171
1172 If perl has not yet been installed then PERL_SRC can be defined on the
1173 command line as shown in the previous section.
1174
1175
1176 =head2 Which architecture dependent directory?
1177
1178 If you don't want to keep the defaults for the INSTALL* macros,
1179 MakeMaker helps you to minimize the typing needed: the usual
1180 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1181 by Configure at perl compilation time. MakeMaker supports the user who
1182 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1183 then MakeMaker defaults the latter to be the same subdirectory of
1184 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1185 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1186 for INSTALLSITELIB and INSTALLSITEARCH.
1187
1188 MakeMaker gives you much more freedom than needed to configure
1189 internal variables and get different results. It is worth to mention,
1190 that make(1) also lets you configure most of the variables that are
1191 used in the Makefile. But in the majority of situations this will not
1192 be necessary, and should only be done if the author of a package
1193 recommends it (or you know what you're doing).
1194
1195 =head2 Using Attributes and Parameters
1196
1197 The following attributes can be specified as arguments to WriteMakefile()
1198 or as NAME=VALUE pairs on the command line:
1199
1200 =over 2
1201
1202 =item ABSTRACT
1203
1204 One line description of the module. Will be included in PPD file.
1205
1206 =item ABSTRACT_FROM
1207
1208 Name of the file that contains the package description. MakeMaker looks
1209 for a line in the POD matching /^($package\s-\s)(.*)/. This is typically
1210 the first line in the "=head1 NAME" section. $2 becomes the abstract.
1211
1212 =item AUTHOR
1213
1214 String containing name (and email address) of package author(s). Is used
1215 in PPD (Perl Package Description) files for PPM (Perl Package Manager).
1216
1217 =item BINARY_LOCATION
1218
1219 Used when creating PPD files for binary packages.  It can be set to a
1220 full or relative path or URL to the binary archive for a particular
1221 architecture.  For example:
1222
1223         perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
1224
1225 builds a PPD package that references a binary of the C<Agent> package,
1226 located in the C<x86> directory relative to the PPD itself.
1227
1228 =item C
1229
1230 Ref to array of *.c file names. Initialised from a directory scan
1231 and the values portion of the XS attribute hash. This is not
1232 currently used by MakeMaker but may be handy in Makefile.PLs.
1233
1234 =item CCFLAGS
1235
1236 String that will be included in the compiler call command line between
1237 the arguments INC and OPTIMIZE.
1238
1239 =item CONFIG
1240
1241 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1242 config.sh. MakeMaker will add to CONFIG the following values anyway:
1243 ar
1244 cc
1245 cccdlflags
1246 ccdlflags
1247 dlext
1248 dlsrc
1249 ld
1250 lddlflags
1251 ldflags
1252 libc
1253 lib_ext
1254 obj_ext
1255 ranlib
1256 sitelibexp
1257 sitearchexp
1258 so
1259
1260 =item CONFIGURE
1261
1262 CODE reference. The subroutine should return a hash reference. The
1263 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1264 be determined by some evaluation method.
1265
1266 =item DEFINE
1267
1268 Something like C<"-DHAVE_UNISTD_H">
1269
1270 =item DIR
1271
1272 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1273 ] in ext/SDBM_File
1274
1275 =item DISTNAME
1276
1277 Your name for distributing the package (by tar file). This defaults to
1278 NAME above.
1279
1280 =item DL_FUNCS
1281
1282 Hashref of symbol names for routines to be made available as universal
1283 symbols.  Each key/value pair consists of the package name and an
1284 array of routine names in that package.  Used only under AIX, OS/2,
1285 VMS and Win32 at present.  The routine names supplied will be expanded
1286 in the same way as XSUB names are expanded by the XS() macro.
1287 Defaults to
1288
1289   {"$(NAME)" => ["boot_$(NAME)" ] }
1290
1291 e.g.
1292
1293   {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1294    "NetconfigPtr" => [ 'DESTROY'] }
1295
1296 Please see the L<ExtUtils::Mksymlists> documentation for more information
1297 about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
1298
1299 =item DL_VARS
1300
1301 Array of symbol names for variables to be made available as universal symbols.
1302 Used only under AIX, OS/2, VMS and Win32 at present.  Defaults to [].
1303 (e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
1304
1305 =item EXCLUDE_EXT
1306
1307 Array of extension names to exclude when doing a static build.  This
1308 is ignored if INCLUDE_EXT is present.  Consult INCLUDE_EXT for more
1309 details.  (e.g.  [ qw( Socket POSIX ) ] )
1310
1311 This attribute may be most useful when specified as a string on the
1312 command line:  perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1313
1314 =item EXE_FILES
1315
1316 Ref to array of executable files. The files will be copied to the
1317 INST_SCRIPT directory. Make realclean will delete them from there
1318 again.
1319
1320 =item FIRST_MAKEFILE
1321
1322 The name of the Makefile to be produced. Defaults to the contents of
1323 MAKEFILE, but can be overridden. This is used for the second Makefile
1324 that will be produced for the MAP_TARGET.
1325
1326 =item FULLPERL
1327
1328 Perl binary able to run this extension.
1329
1330 =item FUNCLIST
1331
1332 This provides an alternate means to specify function names to be
1333 exported from the extension.  Its value is a reference to an
1334 array of function names to be exported by the extension.  These
1335 names are passed through unaltered to the linker options file.
1336
1337 =item H
1338
1339 Ref to array of *.h file names. Similar to C.
1340
1341 =item HTMLLIBPODS
1342
1343 Hashref of .pm and .pod files.  MakeMaker will default this to all
1344  .pod and any .pm files that include POD directives.  The files listed
1345 here will be converted to HTML format and installed as was requested
1346 at Configure time.
1347
1348 =item HTMLSCRIPTPODS
1349
1350 Hashref of pod-containing files.  MakeMaker will default this to all
1351 EXE_FILES files that include POD directives.  The files listed
1352 here will be converted to HTML format and installed as was requested
1353 at Configure time.
1354
1355 =item IMPORTS
1356
1357 This attribute is used to specify names to be imported into the
1358 extension. It is only used on OS/2 and Win32.
1359
1360 =item INC
1361
1362 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1363
1364 =item INCLUDE_EXT
1365
1366 Array of extension names to be included when doing a static build.
1367 MakeMaker will normally build with all of the installed extensions when
1368 doing a static build, and that is usually the desired behavior.  If
1369 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1370 which are explicitly mentioned. (e.g.  [ qw( Socket POSIX ) ])
1371
1372 It is not necessary to mention DynaLoader or the current extension when
1373 filling in INCLUDE_EXT.  If the INCLUDE_EXT is mentioned but is empty then
1374 only DynaLoader and the current extension will be included in the build.
1375
1376 This attribute may be most useful when specified as a string on the
1377 command line:  perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1378
1379 =item INSTALLARCHLIB
1380
1381 Used by 'make install', which copies files from INST_ARCHLIB to this
1382 directory if INSTALLDIRS is set to perl.
1383
1384 =item INSTALLBIN
1385
1386 Directory to install binary files (e.g. tkperl) into.
1387
1388 =item INSTALLDIRS
1389
1390 Determines which of the two sets of installation directories to
1391 choose: installprivlib and installarchlib versus installsitelib and
1392 installsitearch. The first pair is chosen with INSTALLDIRS=perl, the
1393 second with INSTALLDIRS=site. Default is site.
1394
1395 =item INSTALLHTMLPRIVLIBDIR
1396
1397 This directory gets the HTML pages at 'make install' time. Defaults to
1398 $Config{installhtmlprivlibdir}.
1399
1400 =item INSTALLHTMLSCRIPTDIR
1401
1402 This directory gets the HTML pages at 'make install' time. Defaults to
1403 $Config{installhtmlscriptdir}.
1404
1405 =item INSTALLHTMLSITELIBDIR
1406
1407 This directory gets the HTML pages at 'make install' time. Defaults to
1408 $Config{installhtmlsitelibdir}.
1409
1410
1411 =item INSTALLMAN1DIR
1412
1413 This directory gets the man pages at 'make install' time. Defaults to
1414 $Config{installman1dir}.
1415
1416 =item INSTALLMAN3DIR
1417
1418 This directory gets the man pages at 'make install' time. Defaults to
1419 $Config{installman3dir}.
1420
1421 =item INSTALLPRIVLIB
1422
1423 Used by 'make install', which copies files from INST_LIB to this
1424 directory if INSTALLDIRS is set to perl.
1425
1426 =item INSTALLSCRIPT
1427
1428 Used by 'make install' which copies files from INST_SCRIPT to this
1429 directory.
1430
1431 =item INSTALLSITEARCH
1432
1433 Used by 'make install', which copies files from INST_ARCHLIB to this
1434 directory if INSTALLDIRS is set to site (default).
1435
1436 =item INSTALLSITELIB
1437
1438 Used by 'make install', which copies files from INST_LIB to this
1439 directory if INSTALLDIRS is set to site (default).
1440
1441 =item INST_ARCHLIB
1442
1443 Same as INST_LIB for architecture dependent files.
1444
1445 =item INST_BIN
1446
1447 Directory to put real binary files during 'make'. These will be copied
1448 to INSTALLBIN during 'make install'
1449
1450 =item INST_EXE
1451
1452 Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you
1453 need to use it.
1454
1455 =item INST_HTMLLIBDIR
1456
1457 Directory to hold the man pages in HTML format at 'make' time
1458
1459 =item INST_HTMLSCRIPTDIR
1460
1461 Directory to hold the man pages in HTML format at 'make' time
1462
1463 =item INST_LIB
1464
1465 Directory where we put library files of this extension while building
1466 it.
1467
1468 =item INST_MAN1DIR
1469
1470 Directory to hold the man pages at 'make' time
1471
1472 =item INST_MAN3DIR
1473
1474 Directory to hold the man pages at 'make' time
1475
1476 =item INST_SCRIPT
1477
1478 Directory, where executable files should be installed during
1479 'make'. Defaults to "./blib/script", just to have a dummy location during
1480 testing. make install will copy the files in INST_SCRIPT to
1481 INSTALLSCRIPT.
1482
1483 =item LDFROM
1484
1485 defaults to "$(OBJECT)" and is used in the ld command to specify
1486 what files to link/load from (also see dynamic_lib below for how to
1487 specify ld flags)
1488
1489 =item LIB
1490
1491 LIB should only be set at C<perl Makefile.PL> time but is allowed as a
1492 MakeMaker argument. It has the effect of
1493 setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any
1494 explicit setting of those arguments (or of PREFIX).
1495 INSTALLARCHLIB and INSTALLSITEARCH are set to the corresponding
1496 architecture subdirectory.
1497
1498 =item LIBPERL_A
1499
1500 The filename of the perllibrary that will be used together with this
1501 extension. Defaults to libperl.a.
1502
1503 =item LIBS
1504
1505 An anonymous array of alternative library
1506 specifications to be searched for (in order) until
1507 at least one library is found. E.g.
1508
1509   'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1510
1511 Mind, that any element of the array
1512 contains a complete set of arguments for the ld
1513 command. So do not specify
1514
1515   'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1516
1517 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1518 you specify a scalar as in
1519
1520   'LIBS' => "-ltcl -ltk -lX11"
1521
1522 MakeMaker will turn it into an array with one element.
1523
1524 =item LINKTYPE
1525
1526 'static' or 'dynamic' (default unless usedl=undef in
1527 config.sh). Should only be used to force static linking (also see
1528 linkext below).
1529
1530 =item MAKEAPERL
1531
1532 Boolean which tells MakeMaker, that it should include the rules to
1533 make a perl. This is handled automatically as a switch by
1534 MakeMaker. The user normally does not need it.
1535
1536 =item MAKEFILE
1537
1538 The name of the Makefile to be produced.
1539
1540 =item MAN1PODS
1541
1542 Hashref of pod-containing files. MakeMaker will default this to all
1543 EXE_FILES files that include POD directives. The files listed
1544 here will be converted to man pages and installed as was requested
1545 at Configure time.
1546
1547 =item MAN3PODS
1548
1549 Hashref that assigns to *.pm and *.pod files the files into which the
1550 manpages are to be written. MakeMaker parses all *.pod and *.pm files
1551 for POD directives. Files that contain POD will be the default keys of
1552 the MAN3PODS hashref. These will then be converted to man pages during
1553 C<make> and will be installed during C<make install>.
1554
1555 =item MAP_TARGET
1556
1557 If it is intended, that a new perl binary be produced, this variable
1558 may hold a name for that binary. Defaults to perl
1559
1560 =item MYEXTLIB
1561
1562 If the extension links to a library that it builds set this to the
1563 name of the library (see SDBM_File)
1564
1565 =item NAME
1566
1567 Perl module name for this extension (DBD::Oracle). This will default
1568 to the directory name but should be explicitly defined in the
1569 Makefile.PL.
1570
1571 =item NEEDS_LINKING
1572
1573 MakeMaker will figure out if an extension contains linkable code
1574 anywhere down the directory tree, and will set this variable
1575 accordingly, but you can speed it up a very little bit if you define
1576 this boolean variable yourself.
1577
1578 =item NOECHO
1579
1580 Defaults to C<@>. By setting it to an empty string you can generate a
1581 Makefile that echos all commands. Mainly used in debugging MakeMaker
1582 itself.
1583
1584 =item NORECURS
1585
1586 Boolean.  Attribute to inhibit descending into subdirectories.
1587
1588 =item NO_VC
1589
1590 In general, any generated Makefile checks for the current version of
1591 MakeMaker and the version the Makefile was built under. If NO_VC is
1592 set, the version check is neglected. Do not write this into your
1593 Makefile.PL, use it interactively instead.
1594
1595 =item OBJECT
1596
1597 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1598 string containing all object files, e.g. "tkpBind.o
1599 tkpButton.o tkpCanvas.o"
1600
1601 (Where BASEEXT is the last component of NAME, and OBJ_EXT is $Config{obj_ext}.)
1602
1603 =item OPTIMIZE
1604
1605 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1606 passed to subdirectory makes.
1607
1608 =item PERL
1609
1610 Perl binary for tasks that can be done by miniperl
1611
1612 =item PERL_CORE
1613
1614 Set only when MakeMaker is building the extensions of the Perl core
1615 distribution.
1616
1617 =item PERLMAINCC
1618
1619 The call to the program that is able to compile perlmain.c. Defaults
1620 to $(CC).
1621
1622 =item PERL_ARCHLIB
1623
1624 Same as for PERL_LIB, but for architecture dependent files.
1625
1626 Used only when MakeMaker is building the extensions of the Perl core
1627 distribution (because normally $(PERL_ARCHLIB) is automatically in @INC,
1628 and adding it would get in the way of PERL5LIB).
1629
1630 =item PERL_LIB
1631
1632 Directory containing the Perl library to use.
1633
1634 Used only when MakeMaker is building the extensions of the Perl core
1635 distribution (because normally $(PERL_LIB) is automatically in @INC,
1636 and adding it would get in the way of PERL5LIB).
1637
1638 =item PERL_MALLOC_OK
1639
1640 defaults to 0.  Should be set to TRUE if the extension can work with
1641 the memory allocation routines substituted by the Perl malloc() subsystem.
1642 This should be applicable to most extensions with exceptions of those
1643
1644 =over 4
1645
1646 =item *
1647
1648 with bugs in memory allocations which are caught by Perl's malloc();
1649
1650 =item *
1651
1652 which interact with the memory allocator in other ways than via
1653 malloc(), realloc(), free(), calloc(), sbrk() and brk();
1654
1655 =item *
1656
1657 which rely on special alignment which is not provided by Perl's malloc().
1658
1659 =back
1660
1661 B<NOTE.>  Negligence to set this flag in I<any one> of loaded extension
1662 nullifies many advantages of Perl's malloc(), such as better usage of
1663 system resources, error detection, memory usage reporting, catchable failure
1664 of memory allocations, etc.
1665
1666 =item PERLRUN
1667
1668 Use this instead of $(PERL) or $(FULLPERL) when you wish to run perl.
1669 It will set up extra necessary flags for you.
1670
1671 =item PERLRUNINST
1672
1673 Use this instead of $(PERL) or $(FULLPERL) when you wish to run
1674 perl to work with modules.  It will add things like -I$(INST_ARCH)
1675 and other necessary flags.
1676
1677 =item PERL_SRC
1678
1679 Directory containing the Perl source code (use of this should be
1680 avoided, it may be undefined)
1681
1682 =item PERM_RW
1683
1684 Desired permission for read/writable files. Defaults to C<644>.
1685 See also L<MM_Unix/perm_rw>.
1686
1687 =item PERM_RWX
1688
1689 Desired permission for executable files. Defaults to C<755>.
1690 See also L<MM_Unix/perm_rwx>.
1691
1692 =item PL_FILES
1693
1694 Ref to hash of files to be processed as perl programs. MakeMaker
1695 will default to any found *.PL file (except Makefile.PL) being keys
1696 and the basename of the file being the value. E.g.
1697
1698   {'foobar.PL' => 'foobar'}
1699
1700 The *.PL files are expected to produce output to the target files
1701 themselves. If multiple files can be generated from the same *.PL
1702 file then the value in the hash can be a reference to an array of
1703 target file names. E.g.
1704
1705   {'foobar.PL' => ['foobar1','foobar2']}
1706
1707 =item PM
1708
1709 Hashref of .pm files and *.pl files to be installed.  e.g.
1710
1711   {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1712
1713 By default this will include *.pm and *.pl and the files found in
1714 the PMLIBDIRS directories.  Defining PM in the
1715 Makefile.PL will override PMLIBDIRS.
1716
1717 =item PMLIBDIRS
1718
1719 Ref to array of subdirectories containing library files.  Defaults to
1720 [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
1721 they contain will be installed in the corresponding location in the
1722 library.  A libscan() method can be used to alter the behaviour.
1723 Defining PM in the Makefile.PL will override PMLIBDIRS.
1724
1725 (Where BASEEXT is the last component of NAME.)
1726
1727 =item PM_FILTER
1728
1729 A filter program, in the traditional Unix sense (input from stdin, output
1730 to stdout) that is passed on each .pm file during the build (in the
1731 pm_to_blib() phase).  It is empty by default, meaning no filtering is done.
1732
1733 Great care is necessary when defining the command if quoting needs to be
1734 done.  For instance, you would need to say:
1735
1736   {'PM_FILTER' => 'grep -v \\"^\\#\\"'}
1737
1738 to remove all the leading coments on the fly during the build.  The
1739 extra \\ are necessary, unfortunately, because this variable is interpolated
1740 within the context of a Perl program built on the command line, and double
1741 quotes are what is used with the -e switch to build that command line.  The
1742 # is escaped for the Makefile, since what is going to be generated will then
1743 be:
1744
1745   PM_FILTER = grep -v \"^\#\"
1746
1747 Without the \\ before the #, we'd have the start of a Makefile comment,
1748 and the macro would be incorrectly defined.
1749
1750 =item POLLUTE
1751
1752 Release 5.005 grandfathered old global symbol names by providing preprocessor
1753 macros for extension source compatibility.  As of release 5.6, these
1754 preprocessor definitions are not available by default.  The POLLUTE flag
1755 specifies that the old names should still be defined:
1756
1757   perl Makefile.PL POLLUTE=1
1758
1759 Please inform the module author if this is necessary to successfully install
1760 a module under 5.6 or later.
1761
1762 =item PPM_INSTALL_EXEC
1763
1764 Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl)
1765
1766 =item PPM_INSTALL_SCRIPT
1767
1768 Name of the script that gets executed by the Perl Package Manager after
1769 the installation of a package.
1770
1771 =item PREFIX
1772
1773 Can be used to set the three INSTALL* attributes in one go (except for
1774 probably INSTALLMAN1DIR, if it is not below PREFIX according to
1775 %Config).  They will have PREFIX as a common directory node and will
1776 branch from that node into lib/, lib/ARCHNAME or whatever Configure
1777 decided at the build time of your perl (unless you override one of
1778 them, of course).
1779
1780 =item PREREQ_PM
1781
1782 Hashref: Names of modules that need to be available to run this
1783 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1784 desired version is the value. If the required version number is 0, we
1785 only check if any version is installed already.
1786
1787 =item PREREQ_FATAL
1788
1789 Bool. If this parameter is true, failing to have the required modules
1790 (or the right versions thereof) will be fatal. perl Makefile.PL will die
1791 with the proper message.
1792
1793 Note: see L<Test::Harness> for a shortcut for stopping tests early if
1794 you are missing dependencies.
1795
1796 Do I<not> use this parameter for simple requirements, which could be resolved
1797 at a later time, e.g. after an unsuccessful B<make test> of your module.
1798
1799 It is I<extremely> rare to have to use C<PREREQ_FATAL> at all!
1800
1801 =item PREREQ_PRINT
1802
1803 Bool.  If this parameter is true, the prerequisites will be printed to
1804 stdout and MakeMaker will exit.  The output format is
1805
1806 $PREREQ_PM = {
1807                'A::B' => Vers1,
1808                'C::D' => Vers2,
1809                ...
1810              };
1811
1812 =item PRINT_PREREQ
1813
1814 RedHatism for C<PREREQ_PRINT>.  The output format is different, though:
1815
1816     perl(A::B)>=Vers1 perl(C::D)>=Vers2 ...
1817
1818 =item SKIP
1819
1820 Arrayref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1821 Makefile. Caution! Do not use the SKIP attribute for the negligible
1822 speedup. It may seriously damage the resulting Makefile. Only use it
1823 if you really need it.
1824
1825 =item TEST_LIBS
1826
1827 The set of -I's necessary to run a "make test".  Use as:
1828 $(PERL) $(TEST_LIBS) -e '...' for example.
1829
1830 =item TYPEMAPS
1831
1832 Ref to array of typemap file names.  Use this when the typemaps are
1833 in some directory other than the current directory or when they are
1834 not named B<typemap>.  The last typemap in the list takes
1835 precedence.  A typemap in the current directory has highest
1836 precedence, even if it isn't listed in TYPEMAPS.  The default system
1837 typemap has lowest precedence.
1838
1839 =item VERSION
1840
1841 Your version number for distributing the package.  This defaults to
1842 0.1.
1843
1844 =item VERSION_FROM
1845
1846 Instead of specifying the VERSION in the Makefile.PL you can let
1847 MakeMaker parse a file to determine the version number. The parsing
1848 routine requires that the file named by VERSION_FROM contains one
1849 single line to compute the version number. The first line in the file
1850 that contains the regular expression
1851
1852     /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
1853
1854 will be evaluated with eval() and the value of the named variable
1855 B<after> the eval() will be assigned to the VERSION attribute of the
1856 MakeMaker object. The following lines will be parsed o.k.:
1857
1858     $VERSION = '1.00';
1859     *VERSION = \'1.01';
1860     ( $VERSION ) = '$Revision: 1.4 $ ' =~ /\$Revision:\s+([^\s]+)/;
1861     $FOO::VERSION = '1.10';
1862     *FOO::VERSION = \'1.11';
1863     our $VERSION = 1.2.3;       # new for perl5.6.0
1864
1865 but these will fail:
1866
1867     my $VERSION = '1.01';
1868     local $VERSION = '1.02';
1869     local $FOO::VERSION = '1.30';
1870
1871 (Putting C<my> or C<local> on the preceding line will work o.k.)
1872
1873 The file named in VERSION_FROM is not added as a dependency to
1874 Makefile. This is not really correct, but it would be a major pain
1875 during development to have to rewrite the Makefile for any smallish
1876 change in that file. If you want to make sure that the Makefile
1877 contains the correct VERSION macro after any change of the file, you
1878 would have to do something like
1879
1880     depend => { Makefile => '$(VERSION_FROM)' }
1881
1882 See attribute C<depend> below.
1883
1884 =item XS
1885
1886 Hashref of .xs files. MakeMaker will default this.  e.g.
1887
1888   {'name_of_file.xs' => 'name_of_file.c'}
1889
1890 The .c files will automatically be included in the list of files
1891 deleted by a make clean.
1892
1893 =item XSOPT
1894
1895 String of options to pass to xsubpp.  This might include C<-C++> or
1896 C<-extern>.  Do not include typemaps here; the TYPEMAP parameter exists for
1897 that purpose.
1898
1899 =item XSPROTOARG
1900
1901 May be set to an empty string, which is identical to C<-prototypes>, or
1902 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
1903 defaults to the empty string.
1904
1905 =item XS_VERSION
1906
1907 Your version number for the .xs file of this package.  This defaults
1908 to the value of the VERSION attribute.
1909
1910 =back
1911
1912 =head2 Additional lowercase attributes
1913
1914 can be used to pass parameters to the methods which implement that
1915 part of the Makefile.
1916
1917 =over 2
1918
1919 =item clean
1920
1921   {FILES => "*.xyz foo"}
1922
1923 =item depend
1924
1925   {ANY_TARGET => ANY_DEPENDECY, ...}
1926
1927 (ANY_TARGET must not be given a double-colon rule by MakeMaker.)
1928
1929 =item dist
1930
1931   {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
1932   SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
1933   ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
1934
1935 If you specify COMPRESS, then SUFFIX should also be altered, as it is
1936 needed to tell make the target file of the compression. Setting
1937 DIST_CP to ln can be useful, if you need to preserve the timestamps on
1938 your files. DIST_CP can take the values 'cp', which copies the file,
1939 'ln', which links the file, and 'best' which copies symbolic links and
1940 links the rest. Default is 'best'.
1941
1942 =item dynamic_lib
1943
1944   {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
1945
1946 =item linkext
1947
1948   {LINKTYPE => 'static', 'dynamic' or ''}
1949
1950 NB: Extensions that have nothing but *.pm files had to say
1951
1952   {LINKTYPE => ''}
1953
1954 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1955 can be deleted safely. MakeMaker recognizes when there's nothing to
1956 be linked.
1957
1958 =item macro
1959
1960   {ANY_MACRO => ANY_VALUE, ...}
1961
1962 =item realclean
1963
1964   {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
1965
1966 =item test
1967
1968   {TESTS => 't/*.t'}
1969
1970 =item tool_autosplit
1971
1972   {MAXLEN => 8}
1973
1974 =back
1975
1976 =head2 Overriding MakeMaker Methods
1977
1978 If you cannot achieve the desired Makefile behaviour by specifying
1979 attributes you may define private subroutines in the Makefile.PL.
1980 Each subroutines returns the text it wishes to have written to
1981 the Makefile. To override a section of the Makefile you can
1982 either say:
1983
1984         sub MY::c_o { "new literal text" }
1985
1986 or you can edit the default by saying something like:
1987
1988         sub MY::c_o {
1989             package MY; # so that "SUPER" works right
1990             my $inherited = shift->SUPER::c_o(@_);
1991             $inherited =~ s/old text/new text/;
1992             $inherited;
1993         }
1994
1995 If you are running experiments with embedding perl as a library into
1996 other applications, you might find MakeMaker is not sufficient. You'd
1997 better have a look at ExtUtils::Embed which is a collection of utilities
1998 for embedding.
1999
2000 If you still need a different solution, try to develop another
2001 subroutine that fits your needs and submit the diffs to
2002 F<perl5-porters@perl.org> or F<comp.lang.perl.moderated> as appropriate.
2003
2004 For a complete description of all MakeMaker methods see L<ExtUtils::MM_Unix>.
2005
2006 Here is a simple example of how to add a new target to the generated
2007 Makefile:
2008
2009     sub MY::postamble {
2010         '
2011     $(MYEXTLIB): sdbm/Makefile
2012             cd sdbm && $(MAKE) all
2013     ';
2014     }
2015
2016
2017 =head2 Hintsfile support
2018
2019 MakeMaker.pm uses the architecture specific information from
2020 Config.pm. In addition it evaluates architecture specific hints files
2021 in a C<hints/> directory. The hints files are expected to be named
2022 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
2023 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
2024 MakeMaker within the WriteMakefile() subroutine, and can be used to
2025 execute commands as well as to include special variables. The rules
2026 which hintsfile is chosen are the same as in Configure.
2027
2028 The hintsfile is eval()ed immediately after the arguments given to
2029 WriteMakefile are stuffed into a hash reference $self but before this
2030 reference becomes blessed. So if you want to do the equivalent to
2031 override or create an attribute you would say something like
2032
2033     $self->{LIBS} = ['-ldbm -lucb -lc'];
2034
2035 =head2 Distribution Support
2036
2037 For authors of extensions MakeMaker provides several Makefile
2038 targets. Most of the support comes from the ExtUtils::Manifest module,
2039 where additional documentation can be found.
2040
2041 =over 4
2042
2043 =item    make distcheck
2044
2045 reports which files are below the build directory but not in the
2046 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
2047 details)
2048
2049 =item    make skipcheck
2050
2051 reports which files are skipped due to the entries in the
2052 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
2053 details)
2054
2055 =item    make distclean
2056
2057 does a realclean first and then the distcheck. Note that this is not
2058 needed to build a new distribution as long as you are sure that the
2059 MANIFEST file is ok.
2060
2061 =item    make manifest
2062
2063 rewrites the MANIFEST file, adding all remaining files found (See
2064 ExtUtils::Manifest::mkmanifest() for details)
2065
2066 =item    make distdir
2067
2068 Copies all the files that are in the MANIFEST file to a newly created
2069 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
2070 exists, it will be removed first.
2071
2072 =item   make disttest
2073
2074 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
2075 a make test in that directory.
2076
2077 =item    make tardist
2078
2079 First does a distdir. Then a command $(PREOP) which defaults to a null
2080 command, followed by $(TOUNIX), which defaults to a null command under
2081 UNIX, and will convert files in distribution directory to UNIX format
2082 otherwise. Next it runs C<tar> on that directory into a tarfile and
2083 deletes the directory. Finishes with a command $(POSTOP) which
2084 defaults to a null command.
2085
2086 =item    make dist
2087
2088 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
2089
2090 =item    make uutardist
2091
2092 Runs a tardist first and uuencodes the tarfile.
2093
2094 =item    make shdist
2095
2096 First does a distdir. Then a command $(PREOP) which defaults to a null
2097 command. Next it runs C<shar> on that directory into a sharfile and
2098 deletes the intermediate directory again. Finishes with a command
2099 $(POSTOP) which defaults to a null command.  Note: For shdist to work
2100 properly a C<shar> program that can handle directories is mandatory.
2101
2102 =item    make zipdist
2103
2104 First does a distdir. Then a command $(PREOP) which defaults to a null
2105 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
2106 zipfile. Then deletes that directory. Finishes with a command
2107 $(POSTOP) which defaults to a null command.
2108
2109 =item    make ci
2110
2111 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
2112
2113 =back
2114
2115 Customization of the dist targets can be done by specifying a hash
2116 reference to the dist attribute of the WriteMakefile call. The
2117 following parameters are recognized:
2118
2119     CI           ('ci -u')
2120     COMPRESS     ('gzip --best')
2121     POSTOP       ('@ :')
2122     PREOP        ('@ :')
2123     TO_UNIX      (depends on the system)
2124     RCS_LABEL    ('rcs -q -Nv$(VERSION_SYM):')
2125     SHAR         ('shar')
2126     SUFFIX       ('.gz')
2127     TAR          ('tar')
2128     TARFLAGS     ('cvf')
2129     ZIP          ('zip')
2130     ZIPFLAGS     ('-r')
2131
2132 An example:
2133
2134     WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" })
2135
2136 =head2 Disabling an extension
2137
2138 If some events detected in F<Makefile.PL> imply that there is no way
2139 to create the Module, but this is a normal state of things, then you
2140 can create a F<Makefile> which does nothing, but succeeds on all the
2141 "usual" build targets.  To do so, use
2142
2143    ExtUtils::MakeMaker::WriteEmptyMakefile();
2144
2145 instead of WriteMakefile().
2146
2147 This may be useful if other modules expect this module to be I<built>
2148 OK, as opposed to I<work> OK (say, this system-dependent module builds
2149 in a subdirectory of some other distribution, or is listed as a
2150 dependency in a CPAN::Bundle, but the functionality is supported by
2151 different means on the current architecture).
2152
2153 =head1 ENVIRONMENT
2154
2155 =over 8
2156
2157 =item PERL_MM_OPT
2158
2159 Command line options used by C<MakeMaker-E<gt>new()>, and thus by
2160 C<WriteMakefile()>.  The string is split on whitespace, and the result
2161 is processed before any actual command line arguments are processed.
2162
2163 =item PERL_MM_USE_DEFAULT
2164
2165 If set to a true value then MakeMaker's prompt function will
2166 always return the default without waiting for user input.
2167
2168 =back
2169
2170 =head1 SEE ALSO
2171
2172 ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib,
2173 ExtUtils::Install, ExtUtils::Embed
2174
2175 =head1 AUTHORS
2176
2177 Andy Dougherty <F<doughera@lafcol.lafayette.edu>>, Andreas KE<ouml>nig
2178 <F<andreas.koenig@mind.de>>, Tim Bunce <F<Tim.Bunce@ig.co.uk>>.  VMS
2179 support by Charles Bailey <F<bailey@newman.upenn.edu>>.  OS/2 support
2180 by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>.
2181
2182 Contact the MakeMaker mailing list <F<makemaker@perl.org>> if you have
2183 any questions.
2184
2185 Send patches and bug reports to <F<perlbug@perl.org>>.
2186
2187 =cut