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