lib/ExtUtils/MakeMaker.pm

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