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