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