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