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