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