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