1 # $Id: /local/ExtUtils-MakeMaker/lib/ExtUtils/MakeMaker.pm 27436 2007-02-21T15:59:55.429725Z schwern $
2 package ExtUtils::MakeMaker;
4 BEGIN {require 5.005_03;}
7 use ExtUtils::MakeMaker::Config;
12 @ISA @EXPORT @EXPORT_OK
13 $VERSION $Verbose %Config
14 @Prepend_parent @Parent
15 %Recognized_Att_Keys @Get_from_Config @MM_Sections @Overridable
19 # Has to be on its own line with no $ after it to avoid being noticed by
20 # the version control system
21 use vars qw($Revision);
25 ($Revision) = q$Revision: 27436 $ =~ /Revision:\s+(\S+)/;
28 @EXPORT = qw(&WriteMakefile &writeMakefile $Verbose &prompt);
29 @EXPORT_OK = qw($VERSION &neatvalue &mkbootstrap &mksymlists
32 # These will go away once the last of the Win32 & VMS specific code is
34 my $Is_VMS = $^O eq 'VMS';
35 my $Is_Win32 = $^O eq 'MSWin32';
37 # Our filename for diagnostic and debugging purposes. More reliable
38 # than %INC (think caseless filesystems)
43 require ExtUtils::MM; # Things like CPAN assume loading ExtUtils::MakeMaker
46 require ExtUtils::MY; # XXX pre-5.8 versions of ExtUtils::Embed expect
47 # loading ExtUtils::MakeMaker will give them MY.
48 # This will go when Embed is it's own CPAN module.
52 Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
59 my $mm = MM->new(\%att);
66 # Basic signatures of the attributes WriteMakefile takes. Each is the
67 # reference type. Empty value indicate it takes a non-reference
77 EXCLUDE_EXT => 'array',
82 INCLUDE_EXT => 'array',
89 PMLIBPARENTDIRS => 'array',
94 _KEEP_AFTER_FLUSH => '',
105 tool_autosplit => 'hash',
108 @Att_Sigs{keys %Recognized_Att_Keys} = ('') x keys %Recognized_Att_Keys;
109 @Att_Sigs{keys %Special_Sigs} = values %Special_Sigs;
115 while( my($key, $val) = each %$att ) {
116 my $sig = $Att_Sigs{$key};
117 unless( defined $sig ) {
118 warn "WARNING: $key is not a known parameter.\n";
122 my @sigs = ref $sig ? @$sig : $sig;
123 my $given = lc ref $val;
124 unless( grep $given eq $_, @sigs ) {
125 my $takes = join " or ", map { $_ ne '' ? "$_ reference"
128 my $has = $given ne '' ? "$given reference"
130 warn "WARNING: $key takes a $takes not a $has.\n".
131 " Please inform the author.\n";
137 my($mess, $def) = @_;
138 Carp::confess("prompt function called without an argument")
139 unless defined $mess;
141 my $isa_tty = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ;
143 my $dispdef = defined $def ? "[$def] " : " ";
144 $def = defined $def ? $def : "";
148 print "$mess $dispdef";
151 if ($ENV{PERL_MM_USE_DEFAULT} || (!$isa_tty && eof STDIN)) {
159 else { # user hit ctrl-D
164 return (!defined $ans || $ans eq '') ? $def : $ans;
167 sub eval_in_subdirs {
169 use Cwd qw(cwd abs_path);
170 my $pwd = cwd() || die "Can't figure out your cwd!";
172 local @INC = map eval {abs_path($_) if -e} || $_, @INC;
173 push @INC, '.'; # '.' has to always be at the end of @INC
175 foreach my $dir (@{$self->{DIR}}){
176 my($abs) = $self->catdir($pwd,$dir);
177 eval { $self->eval_in_x($abs); };
186 chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
193 # if ($@ =~ /prerequisites/) {
194 # die "MakeMaker WARNING: $@";
196 # warn "WARNING from evaluation of $dir/Makefile.PL: $@";
198 die "ERROR from evaluation of $dir/Makefile.PL: $@";
203 # package name for the classes into which the first object will be blessed
204 my $PACKNAME = 'PACK000';
209 my @attrib_help = qw/
211 AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION
212 C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
213 EXCLUDE_EXT EXE_FILES EXTRA_META FIRST_MAKEFILE
214 FULLPERL FULLPERLRUN FULLPERLRUNINST
217 INST_ARCHLIB INST_SCRIPT INST_BIN INST_LIB INST_MAN1DIR INST_MAN3DIR
219 DESTDIR PREFIX INSTALL_BASE
220 PERLPREFIX SITEPREFIX VENDORPREFIX
221 INSTALLPRIVLIB INSTALLSITELIB INSTALLVENDORLIB
222 INSTALLARCHLIB INSTALLSITEARCH INSTALLVENDORARCH
223 INSTALLBIN INSTALLSITEBIN INSTALLVENDORBIN
224 INSTALLMAN1DIR INSTALLMAN3DIR
225 INSTALLSITEMAN1DIR INSTALLSITEMAN3DIR
226 INSTALLVENDORMAN1DIR INSTALLVENDORMAN3DIR
227 INSTALLSCRIPT INSTALLSITESCRIPT INSTALLVENDORSCRIPT
228 PERL_LIB PERL_ARCHLIB
229 SITELIBEXP SITEARCHEXP
231 INC INCLUDE_EXT LDFROM LIB LIBPERL_A LIBS LICENSE
232 LINKTYPE MAKE MAKEAPERL MAKEFILE MAKEFILE_OLD MAN1PODS MAN3PODS MAP_TARGET
233 MYEXTLIB NAME NEEDS_LINKING NOECHO NO_META NORECURS NO_VC OBJECT OPTIMIZE
234 PERL_MALLOC_OK PERL PERLMAINCC PERLRUN PERLRUNINST PERL_CORE
235 PERL_SRC PERM_RW PERM_RWX
236 PL_FILES PM PM_FILTER PMLIBDIRS PMLIBPARENTDIRS POLLUTE PPM_INSTALL_EXEC
237 PPM_INSTALL_SCRIPT PREREQ_FATAL PREREQ_PM PREREQ_PRINT PRINT_PREREQ
238 SIGN SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
239 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
242 MACPERL_SRC MACPERL_LIB MACLIBS_68K MACLIBS_PPC MACLIBS_SC MACLIBS_MRC
243 MACLIBS_ALL_68K MACLIBS_ALL_PPC MACLIBS_SHARED
246 # IMPORTS is used under OS/2 and Win32
248 # @Overridable is close to @MM_Sections but not identical. The
249 # order is important. Many subroutines declare macros. These
250 # depend on each other. Let's try to collect the macros up front,
251 # then pasthru, then the rules.
253 # MM_Sections are the sections we have to call explicitly
254 # in Overridable we have subroutines that are used indirectly
260 post_initialize const_config constants platform_constants
261 tool_autosplit tool_xsubpp tools_other
265 dist macro depend cflags const_loadlibs const_cccmd
272 top_targets blibdirs linkext dlsyms dynamic dynamic_bs
273 dynamic_lib static static_lib manifypods processPL
275 clean_subdirs clean realclean_subdirs realclean
277 dist_basics dist_core distdir dist_test dist_ci distmeta distsignature
278 install force perldepend makefile staticmake test ppd
280 ); # loses section ordering
282 @Overridable = @MM_Sections;
283 push @Overridable, qw[
285 libscan makeaperl needs_linking perm_rw perm_rwx
286 subdir_x test_via_harness test_via_script
288 init_VERSION init_dist init_INST init_INSTALL init_DEST init_dirscan
289 init_PM init_MANPODS init_xs init_PERL init_DIRFILESEP init_linker
292 push @MM_Sections, qw[
294 pm_to_blib selfdocument
298 # Postamble needs to be the last that was always the case
299 push @MM_Sections, "postamble";
300 push @Overridable, "postamble";
302 # All sections are valid keys.
303 @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
305 # we will use all these variables in the Makefile
308 ar cc cccdlflags ccdlflags dlext dlsrc exe_ext full_ar ld
309 lddlflags ldflags libc lib_ext obj_ext osname osvers ranlib
310 sitelibexp sitearchexp so
313 # 5.5.3 doesn't have any concept of vendor libs
314 push @Get_from_Config, qw( vendorarchexp vendorlibexp ) if $] >= 5.006;
316 foreach my $item (@attrib_help){
317 $Recognized_Att_Keys{$item} = 1;
319 foreach my $item (@Get_from_Config) {
320 $Recognized_Att_Keys{uc $item} = $Config{$item};
321 print "Attribute '\U$item\E' => '$Config{$item}'\n"
326 # When we eval a Makefile.PL in a subdirectory, that one will ask
327 # us (the parent) for the values and will prepend "..", so that
328 # all files to be installed end up below OUR ./blib
330 @Prepend_parent = qw(
331 INST_BIN INST_LIB INST_ARCHLIB INST_SCRIPT
332 MAP_TARGET INST_MAN1DIR INST_MAN3DIR PERL_SRC
340 The extension you are trying to build apparently is rather old and
341 most probably outdated. We detect that from the fact, that a
342 subroutine "writeMakefile" is called, and this subroutine is not
343 supported anymore since about October 1994.
345 Please contact the author or look into CPAN (details about CPAN can be
346 found in the FAQ and at http:/www.perl.com) for a more recent version
347 of the extension. If you're really desperate, you can try to change
348 the subroutine name from writeMakefile to WriteMakefile and rerun
349 'perl Makefile.PL', but you're most probably left alone, when you do
358 my($class,$self) = @_;
361 # Store the original args passed to WriteMakefile()
362 foreach my $k (keys %$self) {
363 $self->{ARGS}{$k} = $self->{$k};
366 if ("@ARGV" =~ /\bPREREQ_PRINT\b/) {
367 require Data::Dumper;
368 print Data::Dumper->Dump([$self->{PREREQ_PM}], [qw(PREREQ_PM)]);
372 # PRINT_PREREQ is RedHatism.
373 if ("@ARGV" =~ /\bPRINT_PREREQ\b/) {
374 print join(" ", map { "perl($_)>=$self->{PREREQ_PM}->{$_} " }
375 sort keys %{$self->{PREREQ_PM}}), "\n";
379 print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
380 if (-f "MANIFEST" && ! -f "Makefile"){
384 $self = {} unless (defined $self);
388 my %configure_att; # record &{$self->{CONFIGURE}} attributes
389 my(%initial_att) = %$self; # record initial attributes
391 my(%unsatisfied) = ();
392 foreach my $prereq (sort keys %{$self->{PREREQ_PM}}) {
393 # 5.8.0 has a bug with require Foo::Bar alone in an eval, so an
394 # extra statement is a workaround.
395 my $file = "$prereq.pm";
397 eval { require $file };
399 my $pr_version = $prereq->VERSION || 0;
401 # convert X.Y_Z alpha version #s to X.YZ for easier comparisons
402 $pr_version =~ s/(\d+)\.(\d+)_(\d+)/$1.$2$3/;
405 warn sprintf "Warning: prerequisite %s %s not found.\n",
406 $prereq, $self->{PREREQ_PM}{$prereq}
407 unless $self->{PREREQ_FATAL};
408 $unsatisfied{$prereq} = 'not installed';
409 } elsif ($pr_version < $self->{PREREQ_PM}->{$prereq} ){
410 warn sprintf "Warning: prerequisite %s %s not found. We have %s.\n",
411 $prereq, $self->{PREREQ_PM}{$prereq},
412 ($pr_version || 'unknown version')
413 unless $self->{PREREQ_FATAL};
414 $unsatisfied{$prereq} = $self->{PREREQ_PM}->{$prereq} ?
415 $self->{PREREQ_PM}->{$prereq} : 'unknown version' ;
418 if (%unsatisfied && $self->{PREREQ_FATAL}){
419 my $failedprereqs = join ', ', map {"$_ $unsatisfied{$_}"}
421 die qq{MakeMaker FATAL: prerequisites not found ($failedprereqs)\n
422 Please install these modules first and rerun 'perl Makefile.PL'.\n};
425 if (defined $self->{CONFIGURE}) {
426 if (ref $self->{CONFIGURE} eq 'CODE') {
427 %configure_att = %{&{$self->{CONFIGURE}}};
428 $self = { %$self, %configure_att };
430 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
434 # This is for old Makefiles written pre 5.00, will go away
435 if ( Carp::longmess("") =~ /runsubdirpl/s ){
436 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
439 my $newclass = ++$PACKNAME;
440 local @Parent = @Parent; # Protect against non-local exits
443 print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
444 mv_all_methods("MY",$newclass);
445 bless $self, $newclass;
447 require ExtUtils::MY;
448 @{"$newclass\:\:ISA"} = 'MM';
451 if (defined $Parent[-2]){
452 $self->{PARENT} = $Parent[-2];
454 for $key (@Prepend_parent) {
455 next unless defined $self->{PARENT}{$key};
457 # Don't stomp on WriteMakefile() args.
458 next if defined $self->{ARGS}{$key} and
459 $self->{ARGS}{$key} eq $self->{$key};
461 $self->{$key} = $self->{PARENT}{$key};
463 unless ($Is_VMS && $key =~ /PERL$/) {
464 $self->{$key} = $self->catdir("..",$self->{$key})
465 unless $self->file_name_is_absolute($self->{$key});
467 # PERL or FULLPERL will be a command verb or even a
468 # command with an argument instead of a full file
469 # specification under VMS. So, don't turn the command
470 # into a filespec, but do add a level to the path of
471 # the argument if not already absolute.
472 my @cmd = split /\s+/, $self->{$key};
473 $cmd[1] = $self->catfile('[-]',$cmd[1])
474 unless (@cmd < 2) || $self->file_name_is_absolute($cmd[1]);
475 $self->{$key} = join(' ', @cmd);
478 if ($self->{PARENT}) {
479 $self->{PARENT}->{CHILDREN}->{$newclass} = $self;
480 foreach my $opt (qw(POLLUTE PERL_CORE)) {
481 if (exists $self->{PARENT}->{$opt}
482 and not exists $self->{$opt})
484 # inherit, but only if already unspecified
485 $self->{$opt} = $self->{PARENT}->{$opt};
489 my @fm = grep /^FIRST_MAKEFILE=/, @ARGV;
490 parse_args($self,@fm) if @fm;
492 parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV);
495 $self->{NAME} ||= $self->guess_name;
497 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
511 $self->init_DIRFILESEP;
513 $self->init_ABSTRACT;
515 if (! $self->{PERL_SRC} ) {
516 require VMS::Filespec if $Is_VMS;
517 my($pthinks) = $self->canonpath($INC{'Config.pm'});
518 my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
519 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
520 if ($pthinks ne $cthinks &&
521 !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
522 print "Have $pthinks expected $cthinks\n";
524 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
527 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
529 print STDOUT <<END unless $self->{UNINSTALLED_PERL};
530 Your perl and your Config.pm seem to have different ideas about the
531 architecture they are running on.
532 Perl thinks: [$pthinks]
533 Config says: [$Config{archname}]
534 This may or may not cause problems. Please check your installation of perl
535 if you have problems building this extension.
540 $self->init_others();
541 $self->init_platform();
543 my($argv) = neatvalue(\@ARGV);
547 push @{$self->{RESULT}}, <<END;
548 # This Makefile is for the $self->{NAME} extension to perl.
550 # It was generated automatically by MakeMaker version
551 # $VERSION (Revision: $Revision) from the contents of
552 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
554 # ANY CHANGES MADE HERE WILL BE LOST!
556 # MakeMaker ARGV: $argv
558 # MakeMaker Parameters:
561 foreach my $key (sort keys %initial_att){
562 next if $key eq 'ARGS';
564 my($v) = neatvalue($initial_att{$key});
565 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
567 push @{$self->{RESULT}}, "# $key => $v";
569 undef %initial_att; # free memory
571 if (defined $self->{CONFIGURE}) {
572 push @{$self->{RESULT}}, <<END;
574 # MakeMaker 'CONFIGURE' Parameters:
576 if (scalar(keys %configure_att) > 0) {
577 foreach my $key (sort keys %configure_att){
578 next if $key eq 'ARGS';
579 my($v) = neatvalue($configure_att{$key});
580 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
582 push @{$self->{RESULT}}, "# $key => $v";
587 push @{$self->{RESULT}}, "# no values returned";
589 undef %configure_att; # free memory
592 # turn the SKIP array into a SKIPHASH hash
594 for $skip (@{$self->{SKIP} || []}) {
595 $self->{SKIPHASH}{$skip} = 1;
597 delete $self->{SKIP}; # free memory
599 if ($self->{PARENT}) {
600 for (qw/install dist dist_basics dist_core distdir dist_test dist_ci/) {
601 $self->{SKIPHASH}{$_} = 1;
605 # We run all the subdirectories now. They don't have much to query
606 # from the parent, but the parent has to query them: if they need linking!
607 unless ($self->{NORECURS}) {
608 $self->eval_in_subdirs if @{$self->{DIR}};
611 foreach my $section ( @MM_Sections ){
612 # Support for new foo_target() methods.
613 my $method = $section;
614 $method .= '_target' unless $self->can($method);
616 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
617 my($skipit) = $self->skipcheck($section);
619 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
621 my(%a) = %{$self->{$section} || {}};
622 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
623 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
624 push @{$self->{RESULT}}, $self->nicetext($self->$method( %a ));
628 push @{$self->{RESULT}}, "\n# End.";
633 sub WriteEmptyMakefile {
634 Carp::croak "WriteEmptyMakefile: Need an even number of args" if @_ % 2;
637 my $self = MM->new(\%att);
638 my $new = $self->{FIRST_MAKEFILE};
639 my $old = $self->{MAKEFILE_OLD};
641 _unlink($old) or warn "unlink $old: $!";
644 _rename($new, $old) or warn "rename $new => $old: $!"
646 open MF, '>'.$new or die "open $new for write: $!";
659 close MF or die "close $new for write: $!";
663 print STDOUT "Checking if your kit is complete...\n";
664 require ExtUtils::Manifest;
666 $ExtUtils::Manifest::Quiet = $ExtUtils::Manifest::Quiet = 1;
667 my(@missed) = ExtUtils::Manifest::manicheck();
669 print STDOUT "Warning: the following files are missing in your kit:\n";
670 print "\t", join "\n\t", @missed;
672 print STDOUT "Please inform the author.\n";
674 print STDOUT "Looks good\n";
679 my($self, @args) = @_;
681 unless (m/(.*?)=(.*)/) {
682 ++$Verbose if m/^verb/;
685 my($name, $value) = ($1, $2);
686 if ($value =~ m/^~(\w+)?/) { # tilde with optional username
687 $value =~ s [^~(\w*)]
689 ((getpwnam($1))[7] || "~$1") :
694 # Remember the original args passed it. It will be useful later.
695 $self->{ARGS}{uc $name} = $self->{uc $name} = $value;
698 # catch old-style 'potential_libs' and inform user how to 'upgrade'
699 if (defined $self->{potential_libs}){
700 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
701 if ($self->{potential_libs}){
702 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
704 print STDOUT "$msg deleted.\n";
706 $self->{LIBS} = [$self->{potential_libs}];
707 delete $self->{potential_libs};
709 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
710 if (defined $self->{ARMAYBE}){
711 my($armaybe) = $self->{ARMAYBE};
712 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
713 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
714 my(%dl) = %{$self->{dynamic_lib} || {}};
715 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
716 delete $self->{ARMAYBE};
718 if (defined $self->{LDTARGET}){
719 print STDOUT "LDTARGET should be changed to LDFROM\n";
720 $self->{LDFROM} = $self->{LDTARGET};
721 delete $self->{LDTARGET};
723 # Turn a DIR argument on the command line into an array
724 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
725 # So they can choose from the command line, which extensions they want
726 # the grep enables them to have some colons too much in case they
727 # have to build a list with the shell
728 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
730 # Turn a INCLUDE_EXT argument on the command line into an array
731 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
732 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
734 # Turn a EXCLUDE_EXT argument on the command line into an array
735 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
736 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
739 foreach my $mmkey (sort keys %$self){
740 next if $mmkey eq 'ARGS';
741 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
742 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
743 unless exists $Recognized_Att_Keys{$mmkey};
750 # We allow extension-specific hints files.
753 my $curdir = File::Spec->curdir;
755 my $hint_dir = File::Spec->catdir($curdir, "hints");
756 return unless -d $hint_dir;
758 # First we look for the best hintsfile we have
759 my($hint)="${^O}_$Config{osvers}";
764 # Also try without trailing minor version numbers.
766 last if -f File::Spec->catfile($hint_dir, "$hint.pl"); # found
768 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
770 my $hint_file = File::Spec->catfile($hint_dir, "$hint.pl");
772 return unless -f $hint_file; # really there
774 _run_hintfile($self, $hint_file);
779 local($self) = shift; # make $self available to the hint file.
780 my($hint_file) = shift;
783 print STDERR "Processing hints file $hint_file\n";
785 # Just in case the ./ isn't on the hint file, which File::Spec can
786 # often strip off, we bung the curdir into @INC
787 local @INC = (File::Spec->curdir, @INC);
788 my $ret = do $hint_file;
789 if( !defined $ret ) {
790 my $error = $@ || $!;
798 my($symtab) = \%{"${from}::"};
800 # Here you see the *current* list of methods that are overridable
801 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
802 # still trying to reduce the list to some reasonable minimum --
803 # because I want to make it easier for the user. A.K.
805 local $SIG{__WARN__} = sub {
806 # can't use 'no warnings redefined', 5.6 only
807 warn @_ unless $_[0] =~ /^Subroutine .* redefined/
809 foreach my $method (@Overridable) {
811 # We cannot say "next" here. Nick might call MY->makeaperl
812 # which isn't defined right now
814 # Above statement was written at 4.23 time when Tk-b8 was
815 # around. As Tk-b9 only builds with 5.002something and MM 5 is
816 # standard, we try to enable the next line again. It was
817 # commented out until MM 5.23
819 next unless defined &{"${from}::$method"};
821 *{"${to}::$method"} = \&{"${from}::$method"};
823 # delete would do, if we were sure, nobody ever called
824 # MY->makeaperl directly
826 # delete $symtab->{$method};
828 # If we delete a method, then it will be undefined and cannot
829 # be called. But as long as we have Makefile.PLs that rely on
830 # %MY:: being intact, we have to fill the hole with an
833 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
836 # We have to clean out %INC also, because the current directory is
837 # changed frequently and Graham Barr prefers to get his version
838 # out of a History.pl file which is "required" so woudn't get
839 # loaded again in another extension requiring a History.pl
841 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
842 # to core dump in the middle of a require statement. The required
843 # file was Tk/MMutil.pm. The consequence is, we have to be
844 # extremely careful when we try to give perl a reason to reload a
845 # library with same name. The workaround prefers to drop nothing
846 # from %INC and teach the writers not to use such libraries.
849 # foreach $inc (keys %INC) {
850 # #warn "***$inc*** deleted";
858 if ($section eq 'dynamic') {
859 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
860 "in skipped section 'dynamic_bs'\n"
861 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
862 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
863 "in skipped section 'dynamic_lib'\n"
864 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
866 if ($section eq 'dynamic_lib') {
867 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
868 "targets in skipped section 'dynamic_bs'\n"
869 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
871 if ($section eq 'static') {
872 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
873 "in skipped section 'static_lib'\n"
874 if $self->{SKIPHASH}{static_lib} && $Verbose;
876 return 'skipped' if $self->{SKIPHASH}{$section};
884 my($finalname) = $self->{FIRST_MAKEFILE};
885 print STDOUT "Writing $finalname for $self->{NAME}\n";
887 unlink($finalname, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : ());
888 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
890 for $chunk (@{$self->{RESULT}}) {
895 _rename("MakeMaker.tmp", $finalname) or
896 warn "rename MakeMaker.tmp => $finalname: $!";
897 chmod 0644, $finalname unless $Is_VMS;
899 my %keep = map { ($_ => 1) } qw(NEEDS_LINKING HAS_LINK_CODE);
901 if ($self->{PARENT} && !$self->{_KEEP_AFTER_FLUSH}) {
902 foreach (keys %$self) { # safe memory
903 delete $self->{$_} unless $keep{$_};
907 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
911 # This is a rename for OS's where the target must be unlinked first.
913 my($src, $dest) = @_;
916 return rename $src, $dest;
919 # This is an unlink for OS's where the target must be writable first.
923 return unlink @files;
927 # The following mkbootstrap() is only for installations that are calling
928 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
929 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
932 !!! Your Makefile has been built such a long time ago, !!!
933 !!! that is unlikely to work with current MakeMaker. !!!
934 !!! Please rebuild your Makefile !!!
938 # Ditto for mksymlists() as of MakeMaker 5.17
941 !!! Your Makefile has been built such a long time ago, !!!
942 !!! that is unlikely to work with current MakeMaker. !!!
943 !!! Please rebuild your Makefile !!!
949 return "undef" unless defined $v;
951 return "q[$v]" unless $t;
955 foreach my $elem (@$v) {
956 push @neat, "q[$elem]";
958 push @m, join ", ", @neat;
962 return "$v" unless $t eq 'HASH';
964 while (($key,$val) = each %$v){
965 last unless defined $key; # cautious programming in case (undef,undef) is true
966 push(@m,"$key=>".neatvalue($val)) ;
968 return "{ ".join(', ',@m)." }";
975 push @m, "\n# Full list of MakeMaker attribute values:";
976 foreach my $key (sort keys %$self){
977 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
978 my($v) = neatvalue($self->{$key});
979 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
981 push @m, "# $key => $v";
993 ExtUtils::MakeMaker - Create a module Makefile
997 use ExtUtils::MakeMaker;
999 WriteMakefile( ATTRIBUTE => VALUE [, ...] );
1003 This utility is designed to write a Makefile for an extension module
1004 from a Makefile.PL. It is based on the Makefile.SH model provided by
1005 Andy Dougherty and the perl5-porters.
1007 It splits the task of generating the Makefile into several subroutines
1008 that can be individually overridden. Each subroutine returns the text
1009 it wishes to have written to the Makefile.
1011 MakeMaker is object oriented. Each directory below the current
1012 directory that contains a Makefile.PL is treated as a separate
1013 object. This makes it possible to write an unlimited number of
1014 Makefiles with a single invocation of WriteMakefile().
1016 =head2 How To Write A Makefile.PL
1018 See ExtUtils::MakeMaker::Tutorial.
1020 The long answer is the rest of the manpage :-)
1022 =head2 Default Makefile Behaviour
1024 The generated Makefile enables the user of the extension to invoke
1026 perl Makefile.PL # optionally "perl Makefile.PL verbose"
1028 make test # optionally set TEST_VERBOSE=1
1029 make install # See below
1031 The Makefile to be produced may be altered by adding arguments of the
1032 form C<KEY=VALUE>. E.g.
1034 perl Makefile.PL INSTALL_BASE=~
1036 Other interesting targets in the generated Makefile are
1038 make config # to check if the Makefile is up-to-date
1039 make clean # delete local temp files (Makefile gets renamed)
1040 make realclean # delete derived files (including ./blib)
1041 make ci # check in all the files in the MANIFEST file
1042 make dist # see below the Distribution Support section
1046 MakeMaker checks for the existence of a file named F<test.pl> in the
1047 current directory and if it exists it execute the script with the
1048 proper set of perl C<-I> options.
1050 MakeMaker also checks for any files matching glob("t/*.t"). It will
1051 execute all matching files in alphabetical order via the
1052 L<Test::Harness> module with the C<-I> switches set correctly.
1054 If you'd like to see the raw output of your tests, set the
1055 C<TEST_VERBOSE> variable to true.
1057 make test TEST_VERBOSE=1
1061 A useful variation of the above is the target C<testdb>. It runs the
1062 test under the Perl debugger (see L<perldebug>). If the file
1063 F<test.pl> exists in the current directory, it is used for the test.
1065 If you want to debug some other testfile, set the C<TEST_FILE> variable
1068 make testdb TEST_FILE=t/mytest.t
1070 By default the debugger is called using C<-d> option to perl. If you
1071 want to specify some other option, set the C<TESTDB_SW> variable:
1073 make testdb TESTDB_SW=-Dx
1077 make alone puts all relevant files into directories that are named by
1078 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_MAN1DIR and
1079 INST_MAN3DIR. All these default to something below ./blib if you are
1080 I<not> building below the perl source directory. If you I<are>
1081 building below the perl source, INST_LIB and INST_ARCHLIB default to
1082 ../../lib, and INST_SCRIPT is not defined.
1084 The I<install> target of the generated Makefile copies the files found
1085 below each of the INST_* directories to their INSTALL*
1086 counterparts. Which counterparts are chosen depends on the setting of
1087 INSTALLDIRS according to the following table:
1092 PERLPREFIX SITEPREFIX VENDORPREFIX
1093 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH INSTALLVENDORARCH
1094 INST_LIB INSTALLPRIVLIB INSTALLSITELIB INSTALLVENDORLIB
1095 INST_BIN INSTALLBIN INSTALLSITEBIN INSTALLVENDORBIN
1096 INST_SCRIPT INSTALLSCRIPT INSTALLSITESCRIPT INSTALLVENDORSCRIPT
1097 INST_MAN1DIR INSTALLMAN1DIR INSTALLSITEMAN1DIR INSTALLVENDORMAN1DIR
1098 INST_MAN3DIR INSTALLMAN3DIR INSTALLSITEMAN3DIR INSTALLVENDORMAN3DIR
1100 The INSTALL... macros in turn default to their %Config
1101 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
1103 You can check the values of these variables on your system with
1107 And to check the sequence in which the library directories are
1108 searched by perl, run
1110 perl -le 'print join $/, @INC'
1112 Sometimes older versions of the module you're installing live in other
1113 directories in @INC. Because Perl loads the first version of a module it
1114 finds, not the newest, you might accidentally get one of these older
1115 versions even after installing a brand new version. To delete I<all other
1116 versions of the module you're installing> (not simply older ones) set the
1119 make install UNINST=1
1124 INSTALL_BASE can be passed into Makefile.PL to change where your
1125 module will be installed. INSTALL_BASE is more like what everyone
1126 else calls "prefix" than PREFIX is.
1128 To have everything installed in your home directory, do the following.
1130 # Unix users, INSTALL_BASE=~ works fine
1131 perl Makefile.PL INSTALL_BASE=/path/to/your/home/dir
1133 Like PREFIX, it sets several INSTALL* attributes at once. Unlike
1134 PREFIX it is easy to predict where the module will end up. The
1135 installation pattern looks like this:
1137 INSTALLARCHLIB INSTALL_BASE/lib/perl5/$Config{archname}
1138 INSTALLPRIVLIB INSTALL_BASE/lib/perl5
1139 INSTALLBIN INSTALL_BASE/bin
1140 INSTALLSCRIPT INSTALL_BASE/bin
1141 INSTALLMAN1DIR INSTALL_BASE/man/man1
1142 INSTALLMAN3DIR INSTALL_BASE/man/man3
1144 INSTALL_BASE in MakeMaker and C<--install_base> in Module::Build (as
1145 of 0.28) install to the same location. If you want MakeMaker and
1146 Module::Build to install to the same location simply set INSTALL_BASE
1147 and C<--install_base> to the same location.
1149 INSTALL_BASE was added in 6.31.
1152 =head2 PREFIX and LIB attribute
1154 PREFIX and LIB can be used to set several INSTALL* attributes in one
1155 go. Here's an example for installing into your home directory.
1157 # Unix users, PREFIX=~ works fine
1158 perl Makefile.PL PREFIX=/path/to/your/home/dir
1160 This will install all files in the module under your home directory,
1161 with man pages and libraries going into an appropriate place (usually
1162 ~/man and ~/lib). How the exact location is determined is complicated
1163 and depends on how your Perl was configured. INSTALL_BASE works more
1164 like what other build systems call "prefix" than PREFIX and we
1165 recommend you use that instead.
1167 Another way to specify many INSTALL directories with a single
1170 perl Makefile.PL LIB=~/lib
1172 This will install the module's architecture-independent files into
1173 ~/lib, the architecture-dependent files into ~/lib/$archname.
1175 Note, that in both cases the tilde expansion is done by MakeMaker, not
1176 by perl by default, nor by make.
1178 Conflicts between parameters LIB, PREFIX and the various INSTALL*
1179 arguments are resolved so that:
1185 setting LIB overrides any setting of INSTALLPRIVLIB, INSTALLARCHLIB,
1186 INSTALLSITELIB, INSTALLSITEARCH (and they are not affected by PREFIX);
1190 without LIB, setting PREFIX replaces the initial C<$Config{prefix}>
1191 part of those INSTALL* arguments, even if the latter are explicitly
1192 set (but are set to still start with C<$Config{prefix}>).
1196 If the user has superuser privileges, and is not working on AFS or
1197 relatives, then the defaults for INSTALLPRIVLIB, INSTALLARCHLIB,
1198 INSTALLSCRIPT, etc. will be appropriate, and this incantation will be
1206 make install per default writes some documentation of what has been
1207 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1208 can be bypassed by calling make pure_install.
1212 will have to specify the installation directories as these most
1213 probably have changed since perl itself has been installed. They will
1214 have to do this by calling
1216 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1217 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1220 Be careful to repeat this procedure every time you recompile an
1221 extension, unless you are sure the AFS installation directories are
1224 =head2 Static Linking of a new Perl Binary
1226 An extension that is built with the above steps is ready to use on
1227 systems supporting dynamic loading. On systems that do not support
1228 dynamic loading, any newly created extension has to be linked together
1229 with the available resources. MakeMaker supports the linking process
1230 by creating appropriate targets in the Makefile whenever an extension
1231 is built. You can invoke the corresponding section of the makefile with
1235 That produces a new perl binary in the current directory with all
1236 extensions linked in that can be found in INST_ARCHLIB, SITELIBEXP,
1237 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1238 UNIX, this is called Makefile.aperl (may be system dependent). If you
1239 want to force the creation of a new perl, it is recommended, that you
1240 delete this Makefile.aperl, so the directories are searched-through
1241 for linkable libraries again.
1243 The binary can be installed into the directory where perl normally
1244 resides on your machine with
1248 To produce a perl binary with a different name than C<perl>, either say
1250 perl Makefile.PL MAP_TARGET=myperl
1257 make myperl MAP_TARGET=myperl
1258 make inst_perl MAP_TARGET=myperl
1260 In any case you will be prompted with the correct invocation of the
1261 C<inst_perl> target that installs the new binary into INSTALLBIN.
1263 make inst_perl per default writes some documentation of what has been
1264 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1265 can be bypassed by calling make pure_inst_perl.
1267 Warning: the inst_perl: target will most probably overwrite your
1268 existing perl binary. Use with care!
1270 Sometimes you might want to build a statically linked perl although
1271 your system supports dynamic loading. In this case you may explicitly
1272 set the linktype with the invocation of the Makefile.PL or make:
1274 perl Makefile.PL LINKTYPE=static # recommended
1278 make LINKTYPE=static # works on most systems
1280 =head2 Determination of Perl Library and Installation Locations
1282 MakeMaker needs to know, or to guess, where certain things are
1283 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1284 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1285 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1287 Extensions may be built either using the contents of the perl source
1288 directory tree or from the installed perl library. The recommended way
1289 is to build extensions after you have run 'make install' on perl
1290 itself. You can do that in any directory on your hard disk that is not
1291 below the perl source tree. The support for extensions below the ext
1292 directory of the perl distribution is only good for the standard
1293 extensions that come with perl.
1295 If an extension is being built below the C<ext/> directory of the perl
1296 source then MakeMaker will set PERL_SRC automatically (e.g.,
1297 C<../..>). If PERL_SRC is defined and the extension is recognized as
1298 a standard extension, then other variables default to the following:
1301 PERL_LIB = PERL_SRC/lib
1302 PERL_ARCHLIB = PERL_SRC/lib
1304 INST_ARCHLIB = PERL_ARCHLIB
1306 If an extension is being built away from the perl source then MakeMaker
1307 will leave PERL_SRC undefined and default to using the installed copy
1308 of the perl library. The other variables default to the following:
1310 PERL_INC = $archlibexp/CORE
1311 PERL_LIB = $privlibexp
1312 PERL_ARCHLIB = $archlibexp
1313 INST_LIB = ./blib/lib
1314 INST_ARCHLIB = ./blib/arch
1316 If perl has not yet been installed then PERL_SRC can be defined on the
1317 command line as shown in the previous section.
1320 =head2 Which architecture dependent directory?
1322 If you don't want to keep the defaults for the INSTALL* macros,
1323 MakeMaker helps you to minimize the typing needed: the usual
1324 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1325 by Configure at perl compilation time. MakeMaker supports the user who
1326 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1327 then MakeMaker defaults the latter to be the same subdirectory of
1328 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1329 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1330 for INSTALLSITELIB and INSTALLSITEARCH.
1332 MakeMaker gives you much more freedom than needed to configure
1333 internal variables and get different results. It is worth to mention,
1334 that make(1) also lets you configure most of the variables that are
1335 used in the Makefile. But in the majority of situations this will not
1336 be necessary, and should only be done if the author of a package
1337 recommends it (or you know what you're doing).
1339 =head2 Using Attributes and Parameters
1341 The following attributes may be specified as arguments to WriteMakefile()
1342 or as NAME=VALUE pairs on the command line.
1348 One line description of the module. Will be included in PPD file.
1352 Name of the file that contains the package description. MakeMaker looks
1353 for a line in the POD matching /^($package\s-\s)(.*)/. This is typically
1354 the first line in the "=head1 NAME" section. $2 becomes the abstract.
1358 String containing name (and email address) of package author(s). Is used
1359 in PPD (Perl Package Description) files for PPM (Perl Package Manager).
1361 =item BINARY_LOCATION
1363 Used when creating PPD files for binary packages. It can be set to a
1364 full or relative path or URL to the binary archive for a particular
1365 architecture. For example:
1367 perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
1369 builds a PPD package that references a binary of the C<Agent> package,
1370 located in the C<x86> directory relative to the PPD itself.
1374 Ref to array of *.c file names. Initialised from a directory scan
1375 and the values portion of the XS attribute hash. This is not
1376 currently used by MakeMaker but may be handy in Makefile.PLs.
1380 String that will be included in the compiler call command line between
1381 the arguments INC and OPTIMIZE.
1385 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1386 config.sh. MakeMaker will add to CONFIG the following values anyway:
1406 CODE reference. The subroutine should return a hash reference. The
1407 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1408 be determined by some evaluation method.
1412 Something like C<"-DHAVE_UNISTD_H">
1416 This is the root directory into which the code will be installed. It
1417 I<prepends itself to the normal prefix>. For example, if your code
1418 would normally go into F</usr/local/lib/perl> you could set DESTDIR=~/tmp/
1419 and installation would go into F<~/tmp/usr/local/lib/perl>.
1421 This is primarily of use for people who repackage Perl modules.
1423 NOTE: Due to the nature of make, it is important that you put the trailing
1424 slash on your DESTDIR. F<~/tmp/> not F<~/tmp>.
1428 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1433 A safe filename for the package.
1435 Defaults to NAME above but with :: replaced with -.
1437 For example, Foo::Bar becomes Foo-Bar.
1441 Your name for distributing the package with the version number
1442 included. This is used by 'make dist' to name the resulting archive
1445 Defaults to DISTNAME-VERSION.
1447 For example, version 1.04 of Foo::Bar becomes Foo-Bar-1.04.
1449 On some OS's where . has special meaning VERSION_SYM may be used in
1454 Hashref of symbol names for routines to be made available as universal
1455 symbols. Each key/value pair consists of the package name and an
1456 array of routine names in that package. Used only under AIX, OS/2,
1457 VMS and Win32 at present. The routine names supplied will be expanded
1458 in the same way as XSUB names are expanded by the XS() macro.
1461 {"$(NAME)" => ["boot_$(NAME)" ] }
1465 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1466 "NetconfigPtr" => [ 'DESTROY'] }
1468 Please see the L<ExtUtils::Mksymlists> documentation for more information
1469 about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
1473 Array of symbol names for variables to be made available as universal symbols.
1474 Used only under AIX, OS/2, VMS and Win32 at present. Defaults to [].
1475 (e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
1479 Array of extension names to exclude when doing a static build. This
1480 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1481 details. (e.g. [ qw( Socket POSIX ) ] )
1483 This attribute may be most useful when specified as a string on the
1484 command line: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1488 Ref to array of executable files. The files will be copied to the
1489 INST_SCRIPT directory. Make realclean will delete them from there
1492 If your executables start with something like #!perl or
1493 #!/usr/bin/perl MakeMaker will change this to the path of the perl
1494 'Makefile.PL' was invoked with so the programs will be sure to run
1495 properly even if perl is not in /usr/bin/perl.
1497 =item FIRST_MAKEFILE
1499 The name of the Makefile to be produced. This is used for the second
1500 Makefile that will be produced for the MAP_TARGET.
1502 Defaults to 'Makefile' or 'Descrip.MMS' on VMS.
1504 (Note: we couldn't use MAKEFILE because dmake uses this for something
1509 Perl binary able to run this extension, load XS modules, etc...
1513 Like PERLRUN, except it uses FULLPERL.
1515 =item FULLPERLRUNINST
1517 Like PERLRUNINST, except it uses FULLPERL.
1521 This provides an alternate means to specify function names to be
1522 exported from the extension. Its value is a reference to an
1523 array of function names to be exported by the extension. These
1524 names are passed through unaltered to the linker options file.
1528 Ref to array of *.h file names. Similar to C.
1532 This attribute is used to specify names to be imported into the
1533 extension. Takes a hash ref.
1535 It is only used on OS/2 and Win32.
1539 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1543 Array of extension names to be included when doing a static build.
1544 MakeMaker will normally build with all of the installed extensions when
1545 doing a static build, and that is usually the desired behavior. If
1546 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1547 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1549 It is not necessary to mention DynaLoader or the current extension when
1550 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1551 only DynaLoader and the current extension will be included in the build.
1553 This attribute may be most useful when specified as a string on the
1554 command line: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1556 =item INSTALLARCHLIB
1558 Used by 'make install', which copies files from INST_ARCHLIB to this
1559 directory if INSTALLDIRS is set to perl.
1563 Directory to install binary files (e.g. tkperl) into if
1568 Determines which of the sets of installation directories to choose:
1569 perl, site or vendor. Defaults to site.
1571 =item INSTALLMAN1DIR
1573 =item INSTALLMAN3DIR
1575 These directories get the man pages at 'make install' time if
1576 INSTALLDIRS=perl. Defaults to $Config{installman*dir}.
1578 If set to 'none', no man pages will be installed.
1580 =item INSTALLPRIVLIB
1582 Used by 'make install', which copies files from INST_LIB to this
1583 directory if INSTALLDIRS is set to perl.
1585 Defaults to $Config{installprivlib}.
1589 Used by 'make install' which copies files from INST_SCRIPT to this
1590 directory if INSTALLDIRS=perl.
1592 =item INSTALLSITEARCH
1594 Used by 'make install', which copies files from INST_ARCHLIB to this
1595 directory if INSTALLDIRS is set to site (default).
1597 =item INSTALLSITEBIN
1599 Used by 'make install', which copies files from INST_BIN to this
1600 directory if INSTALLDIRS is set to site (default).
1602 =item INSTALLSITELIB
1604 Used by 'make install', which copies files from INST_LIB to this
1605 directory if INSTALLDIRS is set to site (default).
1607 =item INSTALLSITEMAN1DIR
1609 =item INSTALLSITEMAN3DIR
1611 These directories get the man pages at 'make install' time if
1612 INSTALLDIRS=site (default). Defaults to
1613 $(SITEPREFIX)/man/man$(MAN*EXT).
1615 If set to 'none', no man pages will be installed.
1617 =item INSTALLSITESCRIPT
1619 Used by 'make install' which copies files from INST_SCRIPT to this
1620 directory if INSTALLDIRS is set to site (default).
1622 =item INSTALLVENDORARCH
1624 Used by 'make install', which copies files from INST_ARCHLIB to this
1625 directory if INSTALLDIRS is set to vendor.
1627 =item INSTALLVENDORBIN
1629 Used by 'make install', which copies files from INST_BIN to this
1630 directory if INSTALLDIRS is set to vendor.
1632 =item INSTALLVENDORLIB
1634 Used by 'make install', which copies files from INST_LIB to this
1635 directory if INSTALLDIRS is set to vendor.
1637 =item INSTALLVENDORMAN1DIR
1639 =item INSTALLVENDORMAN3DIR
1641 These directories get the man pages at 'make install' time if
1642 INSTALLDIRS=vendor. Defaults to $(VENDORPREFIX)/man/man$(MAN*EXT).
1644 If set to 'none', no man pages will be installed.
1646 =item INSTALLVENDORSCRIPT
1648 Used by 'make install' which copies files from INST_SCRIPT to this
1649 directory if INSTALLDIRS is set to is set to vendor.
1653 Same as INST_LIB for architecture dependent files.
1657 Directory to put real binary files during 'make'. These will be copied
1658 to INSTALLBIN during 'make install'
1662 Directory where we put library files of this extension while building
1667 Directory to hold the man pages at 'make' time
1671 Directory to hold the man pages at 'make' time
1675 Directory, where executable files should be installed during
1676 'make'. Defaults to "./blib/script", just to have a dummy location during
1677 testing. make install will copy the files in INST_SCRIPT to
1682 Program to be used to link libraries for dynamic loading.
1684 Defaults to $Config{ld}.
1688 Any special flags that might need to be passed to ld to create a
1689 shared library suitable for dynamic loading. It is up to the makefile
1690 to use it. (See L<Config/lddlflags>)
1692 Defaults to $Config{lddlflags}.
1696 Defaults to "$(OBJECT)" and is used in the ld command to specify
1697 what files to link/load from (also see dynamic_lib below for how to
1702 LIB should only be set at C<perl Makefile.PL> time but is allowed as a
1703 MakeMaker argument. It has the effect of setting both INSTALLPRIVLIB
1704 and INSTALLSITELIB to that value regardless any explicit setting of
1705 those arguments (or of PREFIX). INSTALLARCHLIB and INSTALLSITEARCH
1706 are set to the corresponding architecture subdirectory.
1710 The filename of the perllibrary that will be used together with this
1711 extension. Defaults to libperl.a.
1715 An anonymous array of alternative library
1716 specifications to be searched for (in order) until
1717 at least one library is found. E.g.
1719 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1721 Mind, that any element of the array
1722 contains a complete set of arguments for the ld
1723 command. So do not specify
1725 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1727 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1728 you specify a scalar as in
1730 'LIBS' => "-ltcl -ltk -lX11"
1732 MakeMaker will turn it into an array with one element.
1736 The licensing terms of your distribution. Generally its "perl" for the
1737 same license as Perl itself.
1739 See L<Module::Build::Authoring> for the list of options.
1741 Defaults to "unknown".
1745 'static' or 'dynamic' (default unless usedl=undef in
1746 config.sh). Should only be used to force static linking (also see
1751 Variant of make you intend to run the generated Makefile with. This
1752 parameter lets Makefile.PL know what make quirks to account for when
1753 generating the Makefile.
1755 MakeMaker also honors the MAKE environment variable. This parameter
1758 Currently the only significant values are 'dmake' and 'nmake' for Windows
1761 Defaults to $Config{make}.
1765 Boolean which tells MakeMaker, that it should include the rules to
1766 make a perl. This is handled automatically as a switch by
1767 MakeMaker. The user normally does not need it.
1771 When 'make clean' or similar is run, the $(FIRST_MAKEFILE) will be
1772 backed up at this location.
1774 Defaults to $(FIRST_MAKEFILE).old or $(FIRST_MAKEFILE)_old on VMS.
1778 Hashref of pod-containing files. MakeMaker will default this to all
1779 EXE_FILES files that include POD directives. The files listed
1780 here will be converted to man pages and installed as was requested
1785 Hashref that assigns to *.pm and *.pod files the files into which the
1786 manpages are to be written. MakeMaker parses all *.pod and *.pm files
1787 for POD directives. Files that contain POD will be the default keys of
1788 the MAN3PODS hashref. These will then be converted to man pages during
1789 C<make> and will be installed during C<make install>.
1793 If it is intended, that a new perl binary be produced, this variable
1794 may hold a name for that binary. Defaults to perl
1798 If the extension links to a library that it builds set this to the
1799 name of the library (see SDBM_File)
1803 Perl module name for this extension (DBD::Oracle). This will default
1804 to the directory name but should be explicitly defined in the
1809 MakeMaker will figure out if an extension contains linkable code
1810 anywhere down the directory tree, and will set this variable
1811 accordingly, but you can speed it up a very little bit if you define
1812 this boolean variable yourself.
1816 Command so make does not print the literal commands its running.
1818 By setting it to an empty string you can generate a Makefile that
1819 prints all commands. Mainly used in debugging MakeMaker itself.
1825 Boolean. Attribute to inhibit descending into subdirectories.
1829 When true, suppresses the generation and addition to the MANIFEST of
1830 the META.yml module meta-data file during 'make distdir'.
1836 In general, any generated Makefile checks for the current version of
1837 MakeMaker and the version the Makefile was built under. If NO_VC is
1838 set, the version check is neglected. Do not write this into your
1839 Makefile.PL, use it interactively instead.
1843 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1844 string containing all object files, e.g. "tkpBind.o
1845 tkpButton.o tkpCanvas.o"
1847 (Where BASEEXT is the last component of NAME, and OBJ_EXT is $Config{obj_ext}.)
1851 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1852 passed to subdirectory makes.
1856 Perl binary for tasks that can be done by miniperl
1860 Set only when MakeMaker is building the extensions of the Perl core
1865 The call to the program that is able to compile perlmain.c. Defaults
1870 Same as for PERL_LIB, but for architecture dependent files.
1872 Used only when MakeMaker is building the extensions of the Perl core
1873 distribution (because normally $(PERL_ARCHLIB) is automatically in @INC,
1874 and adding it would get in the way of PERL5LIB).
1878 Directory containing the Perl library to use.
1880 Used only when MakeMaker is building the extensions of the Perl core
1881 distribution (because normally $(PERL_LIB) is automatically in @INC,
1882 and adding it would get in the way of PERL5LIB).
1884 =item PERL_MALLOC_OK
1886 defaults to 0. Should be set to TRUE if the extension can work with
1887 the memory allocation routines substituted by the Perl malloc() subsystem.
1888 This should be applicable to most extensions with exceptions of those
1894 with bugs in memory allocations which are caught by Perl's malloc();
1898 which interact with the memory allocator in other ways than via
1899 malloc(), realloc(), free(), calloc(), sbrk() and brk();
1903 which rely on special alignment which is not provided by Perl's malloc().
1907 B<NOTE.> Negligence to set this flag in I<any one> of loaded extension
1908 nullifies many advantages of Perl's malloc(), such as better usage of
1909 system resources, error detection, memory usage reporting, catchable failure
1910 of memory allocations, etc.
1914 Directory under which core modules are to be installed.
1916 Defaults to $Config{installprefixexp} falling back to
1917 $Config{installprefix}, $Config{prefixexp} or $Config{prefix} should
1918 $Config{installprefixexp} not exist.
1920 Overridden by PREFIX.
1924 Use this instead of $(PERL) when you wish to run perl. It will set up
1925 extra necessary flags for you.
1929 Use this instead of $(PERL) when you wish to run perl to work with
1930 modules. It will add things like -I$(INST_ARCH) and other necessary
1931 flags so perl can see the modules you're about to install.
1935 Directory containing the Perl source code (use of this should be
1936 avoided, it may be undefined)
1940 Desired permission for read/writable files. Defaults to C<644>.
1941 See also L<MM_Unix/perm_rw>.
1945 Desired permission for executable files. Defaults to C<755>.
1946 See also L<MM_Unix/perm_rwx>.
1950 MakeMaker can run programs to generate files for you at build time.
1951 By default any file named *.PL (except Makefile.PL and Build.PL) in
1952 the top level directory will be assumed to be a Perl program and run
1953 passing its own basename in as an argument. For example...
1957 This behavior can be overridden by supplying your own set of files to
1958 search. PL_FILES accepts a hash ref, the key being the file to run
1959 and the value is passed in as the first argument when the PL file is run.
1961 PL_FILES => {'bin/foobar.PL' => 'bin/foobar'}
1963 Would run bin/foobar.PL like this:
1965 perl bin/foobar.PL bin/foobar
1967 If multiple files from one program are desired an array ref can be used.
1969 PL_FILES => {'bin/foobar.PL' => [qw(bin/foobar1 bin/foobar2)]}
1971 In this case the program will be run multiple times using each target file.
1973 perl bin/foobar.PL bin/foobar1
1974 perl bin/foobar.PL bin/foobar2
1976 PL files are normally run B<after> pm_to_blib and include INST_LIB and
1977 INST_ARCH in its C<@INC> so the just built modules can be
1978 accessed... unless the PL file is making a module (or anything else in
1979 PM) in which case it is run B<before> pm_to_blib and does not include
1980 INST_LIB and INST_ARCH in its C<@INC>. This apparently odd behavior
1981 is there for backwards compatibility (and its somewhat DWIM).
1986 Hashref of .pm files and *.pl files to be installed. e.g.
1988 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1990 By default this will include *.pm and *.pl and the files found in
1991 the PMLIBDIRS directories. Defining PM in the
1992 Makefile.PL will override PMLIBDIRS.
1996 Ref to array of subdirectories containing library files. Defaults to
1997 [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
1998 they contain will be installed in the corresponding location in the
1999 library. A libscan() method can be used to alter the behaviour.
2000 Defining PM in the Makefile.PL will override PMLIBDIRS.
2002 (Where BASEEXT is the last component of NAME.)
2006 A filter program, in the traditional Unix sense (input from stdin, output
2007 to stdout) that is passed on each .pm file during the build (in the
2008 pm_to_blib() phase). It is empty by default, meaning no filtering is done.
2010 Great care is necessary when defining the command if quoting needs to be
2011 done. For instance, you would need to say:
2013 {'PM_FILTER' => 'grep -v \\"^\\#\\"'}
2015 to remove all the leading comments on the fly during the build. The
2016 extra \\ are necessary, unfortunately, because this variable is interpolated
2017 within the context of a Perl program built on the command line, and double
2018 quotes are what is used with the -e switch to build that command line. The
2019 # is escaped for the Makefile, since what is going to be generated will then
2022 PM_FILTER = grep -v \"^\#\"
2024 Without the \\ before the #, we'd have the start of a Makefile comment,
2025 and the macro would be incorrectly defined.
2029 Release 5.005 grandfathered old global symbol names by providing preprocessor
2030 macros for extension source compatibility. As of release 5.6, these
2031 preprocessor definitions are not available by default. The POLLUTE flag
2032 specifies that the old names should still be defined:
2034 perl Makefile.PL POLLUTE=1
2036 Please inform the module author if this is necessary to successfully install
2037 a module under 5.6 or later.
2039 =item PPM_INSTALL_EXEC
2041 Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl)
2043 =item PPM_INSTALL_SCRIPT
2045 Name of the script that gets executed by the Perl Package Manager after
2046 the installation of a package.
2050 This overrides all the default install locations. Man pages,
2051 libraries, scripts, etc... MakeMaker will try to make an educated
2052 guess about where to place things under the new PREFIX based on your
2053 Config defaults. Failing that, it will fall back to a structure
2054 which should be sensible for your platform.
2056 If you specify LIB or any INSTALL* variables they will not be effected
2061 Bool. If this parameter is true, failing to have the required modules
2062 (or the right versions thereof) will be fatal. perl Makefile.PL will die
2063 with the proper message.
2065 Note: see L<Test::Harness> for a shortcut for stopping tests early if
2066 you are missing dependencies.
2068 Do I<not> use this parameter for simple requirements, which could be resolved
2069 at a later time, e.g. after an unsuccessful B<make test> of your module.
2071 It is I<extremely> rare to have to use C<PREREQ_FATAL> at all!
2075 Hashref: Names of modules that need to be available to run this
2076 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
2077 desired version is the value. If the required version number is 0, we
2078 only check if any version is installed already.
2082 Bool. If this parameter is true, the prerequisites will be printed to
2083 stdout and MakeMaker will exit. The output format is an evalable hash
2094 RedHatism for C<PREREQ_PRINT>. The output format is different, though:
2096 perl(A::B)>=Vers1 perl(C::D)>=Vers2 ...
2100 Like PERLPREFIX, but only for the site install locations.
2102 Defaults to $Config{siteprefixexp}. Perls prior to 5.6.0 didn't have
2103 an explicit siteprefix in the Config. In those cases
2104 $Config{installprefix} will be used.
2106 Overridable by PREFIX
2110 When true, perform the generation and addition to the MANIFEST of the
2111 SIGNATURE file in the distdir during 'make distdir', via 'cpansign
2114 Note that you need to install the Module::Signature module to
2115 perform this operation.
2121 Arrayref. E.g. [qw(name1 name2)] skip (do not write) sections of the
2122 Makefile. Caution! Do not use the SKIP attribute for the negligible
2123 speedup. It may seriously damage the resulting Makefile. Only use it
2124 if you really need it.
2128 Ref to array of typemap file names. Use this when the typemaps are
2129 in some directory other than the current directory or when they are
2130 not named B<typemap>. The last typemap in the list takes
2131 precedence. A typemap in the current directory has highest
2132 precedence, even if it isn't listed in TYPEMAPS. The default system
2133 typemap has lowest precedence.
2137 Like PERLPREFIX, but only for the vendor install locations.
2139 Defaults to $Config{vendorprefixexp}.
2141 Overridable by PREFIX
2145 If true, make install will be verbose
2149 Your version number for distributing the package. This defaults to
2154 Instead of specifying the VERSION in the Makefile.PL you can let
2155 MakeMaker parse a file to determine the version number. The parsing
2156 routine requires that the file named by VERSION_FROM contains one
2157 single line to compute the version number. The first line in the file
2158 that contains the regular expression
2160 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
2162 will be evaluated with eval() and the value of the named variable
2163 B<after> the eval() will be assigned to the VERSION attribute of the
2164 MakeMaker object. The following lines will be parsed o.k.:
2168 $VERSION = (q$Revision: 27436 $) =~ /(\d+)/g;
2169 $FOO::VERSION = '1.10';
2170 *FOO::VERSION = \'1.11';
2171 our $VERSION = 1.2.3; # new for perl5.6.0
2173 but these will fail:
2175 my $VERSION = '1.01';
2176 local $VERSION = '1.02';
2177 local $FOO::VERSION = '1.30';
2179 (Putting C<my> or C<local> on the preceding line will work o.k.)
2181 The file named in VERSION_FROM is not added as a dependency to
2182 Makefile. This is not really correct, but it would be a major pain
2183 during development to have to rewrite the Makefile for any smallish
2184 change in that file. If you want to make sure that the Makefile
2185 contains the correct VERSION macro after any change of the file, you
2186 would have to do something like
2188 depend => { Makefile => '$(VERSION_FROM)' }
2190 See attribute C<depend> below.
2194 A sanitized VERSION with . replaced by _. For places where . has
2195 special meaning (some filesystems, RCS labels, etc...)
2199 Hashref of .xs files. MakeMaker will default this. e.g.
2201 {'name_of_file.xs' => 'name_of_file.c'}
2203 The .c files will automatically be included in the list of files
2204 deleted by a make clean.
2208 String of options to pass to xsubpp. This might include C<-C++> or
2209 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
2214 May be set to an empty string, which is identical to C<-prototypes>, or
2215 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
2216 defaults to the empty string.
2220 Your version number for the .xs file of this package. This defaults
2221 to the value of the VERSION attribute.
2225 =head2 Additional lowercase attributes
2227 can be used to pass parameters to the methods which implement that
2228 part of the Makefile. Parameters are specified as a hash ref but are
2229 passed to the method as a hash.
2235 {FILES => "*.xyz foo"}
2239 {ANY_TARGET => ANY_DEPENDENCY, ...}
2241 (ANY_TARGET must not be given a double-colon rule by MakeMaker.)
2245 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
2246 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
2247 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
2249 If you specify COMPRESS, then SUFFIX should also be altered, as it is
2250 needed to tell make the target file of the compression. Setting
2251 DIST_CP to ln can be useful, if you need to preserve the timestamps on
2252 your files. DIST_CP can take the values 'cp', which copies the file,
2253 'ln', which links the file, and 'best' which copies symbolic links and
2254 links the rest. Default is 'best'.
2258 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
2262 {LINKTYPE => 'static', 'dynamic' or ''}
2264 NB: Extensions that have nothing but *.pm files had to say
2268 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
2269 can be deleted safely. MakeMaker recognizes when there's nothing to
2274 {ANY_MACRO => ANY_VALUE, ...}
2278 Anything put here will be passed to MY::postamble() if you have one.
2282 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
2288 =item tool_autosplit
2294 =head2 Overriding MakeMaker Methods
2296 If you cannot achieve the desired Makefile behaviour by specifying
2297 attributes you may define private subroutines in the Makefile.PL.
2298 Each subroutine returns the text it wishes to have written to
2299 the Makefile. To override a section of the Makefile you can
2302 sub MY::c_o { "new literal text" }
2304 or you can edit the default by saying something like:
2306 package MY; # so that "SUPER" works right
2308 my $inherited = shift->SUPER::c_o(@_);
2309 $inherited =~ s/old text/new text/;
2313 If you are running experiments with embedding perl as a library into
2314 other applications, you might find MakeMaker is not sufficient. You'd
2315 better have a look at ExtUtils::Embed which is a collection of utilities
2318 If you still need a different solution, try to develop another
2319 subroutine that fits your needs and submit the diffs to
2320 C<makemaker@perl.org>
2322 For a complete description of all MakeMaker methods see
2323 L<ExtUtils::MM_Unix>.
2325 Here is a simple example of how to add a new target to the generated
2329 return <<'MAKE_FRAG';
2330 $(MYEXTLIB): sdbm/Makefile
2331 cd sdbm && $(MAKE) all
2336 =head2 The End Of Cargo Cult Programming
2338 WriteMakefile() now does some basic sanity checks on its parameters to
2339 protect against typos and malformatted values. This means some things
2340 which happened to work in the past will now throw warnings and
2341 possibly produce internal errors.
2343 Some of the most common mistakes:
2347 =item C<< MAN3PODS => ' ' >>
2349 This is commonly used to suppress the creation of man pages. MAN3PODS
2350 takes a hash ref not a string, but the above worked by accident in old
2351 versions of MakeMaker.
2353 The correct code is C<< MAN3PODS => { } >>.
2358 =head2 Hintsfile support
2360 MakeMaker.pm uses the architecture specific information from
2361 Config.pm. In addition it evaluates architecture specific hints files
2362 in a C<hints/> directory. The hints files are expected to be named
2363 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
2364 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
2365 MakeMaker within the WriteMakefile() subroutine, and can be used to
2366 execute commands as well as to include special variables. The rules
2367 which hintsfile is chosen are the same as in Configure.
2369 The hintsfile is eval()ed immediately after the arguments given to
2370 WriteMakefile are stuffed into a hash reference $self but before this
2371 reference becomes blessed. So if you want to do the equivalent to
2372 override or create an attribute you would say something like
2374 $self->{LIBS} = ['-ldbm -lucb -lc'];
2376 =head2 Distribution Support
2378 For authors of extensions MakeMaker provides several Makefile
2379 targets. Most of the support comes from the ExtUtils::Manifest module,
2380 where additional documentation can be found.
2384 =item make distcheck
2386 reports which files are below the build directory but not in the
2387 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
2390 =item make skipcheck
2392 reports which files are skipped due to the entries in the
2393 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
2396 =item make distclean
2398 does a realclean first and then the distcheck. Note that this is not
2399 needed to build a new distribution as long as you are sure that the
2400 MANIFEST file is ok.
2404 rewrites the MANIFEST file, adding all remaining files found (See
2405 ExtUtils::Manifest::mkmanifest() for details)
2409 Copies all the files that are in the MANIFEST file to a newly created
2410 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
2411 exists, it will be removed first.
2413 Additionally, it will create a META.yml module meta-data file in the
2414 distdir and add this to the distdir's MANFIEST. You can shut this
2415 behavior off with the NO_META flag.
2419 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
2420 a make test in that directory.
2424 First does a distdir. Then a command $(PREOP) which defaults to a null
2425 command, followed by $(TOUNIX), which defaults to a null command under
2426 UNIX, and will convert files in distribution directory to UNIX format
2427 otherwise. Next it runs C<tar> on that directory into a tarfile and
2428 deletes the directory. Finishes with a command $(POSTOP) which
2429 defaults to a null command.
2433 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
2435 =item make uutardist
2437 Runs a tardist first and uuencodes the tarfile.
2441 First does a distdir. Then a command $(PREOP) which defaults to a null
2442 command. Next it runs C<shar> on that directory into a sharfile and
2443 deletes the intermediate directory again. Finishes with a command
2444 $(POSTOP) which defaults to a null command. Note: For shdist to work
2445 properly a C<shar> program that can handle directories is mandatory.
2449 First does a distdir. Then a command $(PREOP) which defaults to a null
2450 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
2451 zipfile. Then deletes that directory. Finishes with a command
2452 $(POSTOP) which defaults to a null command.
2456 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
2460 Customization of the dist targets can be done by specifying a hash
2461 reference to the dist attribute of the WriteMakefile call. The
2462 following parameters are recognized:
2465 COMPRESS ('gzip --best')
2468 TO_UNIX (depends on the system)
2469 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
2479 WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" })
2482 =head2 Module Meta-Data
2484 Long plaguing users of MakeMaker based modules has been the problem of
2485 getting basic information about the module out of the sources
2486 I<without> running the F<Makefile.PL> and doing a bunch of messy
2487 heuristics on the resulting F<Makefile>. To this end a simple module
2488 meta-data file has been introduced, F<META.yml>.
2490 F<META.yml> is a YAML document (see http://www.yaml.org) containing
2491 basic information about the module (name, version, prerequisites...)
2492 in an easy to read format. The format is developed and defined by the
2493 Module::Build developers (see
2494 http://module-build.sourceforge.net/META-spec.html)
2496 MakeMaker will automatically generate a F<META.yml> file for you and
2497 add it to your F<MANIFEST> as part of the 'distdir' target (and thus
2498 the 'dist' target). This is intended to seamlessly and rapidly
2499 populate CPAN with module meta-data. If you wish to shut this feature
2500 off, set the C<NO_META> C<WriteMakefile()> flag to true.
2503 =head2 Disabling an extension
2505 If some events detected in F<Makefile.PL> imply that there is no way
2506 to create the Module, but this is a normal state of things, then you
2507 can create a F<Makefile> which does nothing, but succeeds on all the
2508 "usual" build targets. To do so, use
2510 use ExtUtils::MakeMaker qw(WriteEmptyMakefile);
2511 WriteEmptyMakefile();
2513 instead of WriteMakefile().
2515 This may be useful if other modules expect this module to be I<built>
2516 OK, as opposed to I<work> OK (say, this system-dependent module builds
2517 in a subdirectory of some other distribution, or is listed as a
2518 dependency in a CPAN::Bundle, but the functionality is supported by
2519 different means on the current architecture).
2521 =head2 Other Handy Functions
2527 my $value = prompt($message);
2528 my $value = prompt($message, $default);
2530 The C<prompt()> function provides an easy way to request user input
2531 used to write a makefile. It displays the $message as a prompt for
2532 input. If a $default is provided it will be used as a default. The
2533 function returns the $value selected by the user.
2535 If C<prompt()> detects that it is not running interactively and there
2536 is nothing on STDIN or if the PERL_MM_USE_DEFAULT environment variable
2537 is set to true, the $default will be used without prompting. This
2538 prevents automated processes from blocking on user input.
2540 If no $default is provided an empty string will be used instead.
2551 Command line options used by C<MakeMaker-E<gt>new()>, and thus by
2552 C<WriteMakefile()>. The string is split on whitespace, and the result
2553 is processed before any actual command line arguments are processed.
2555 =item PERL_MM_USE_DEFAULT
2557 If set to a true value then MakeMaker's prompt function will
2558 always return the default without waiting for user input.
2562 Same as the PERL_CORE parameter. The parameter overrides this.
2568 L<Module::Build> is a pure-Perl alternative to MakeMaker which does
2569 not rely on make or any other external utility. It is easier to
2570 extend to suit your needs.
2572 L<Module::Install> is a wrapper around MakeMaker which adds features
2573 not normally available.
2575 L<ExtUtils::ModuleMaker> and L<Module::Starter> are both modules to
2576 help you setup your distribution.
2580 Andy Dougherty C<doughera@lafayette.edu>, Andreas KE<ouml>nig
2581 C<andreas.koenig@mind.de>, Tim Bunce C<timb@cpan.org>. VMS
2582 support by Charles Bailey C<bailey@newman.upenn.edu>. OS/2 support
2583 by Ilya Zakharevich C<ilya@math.ohio-state.edu>.
2585 Currently maintained by Michael G Schwern C<schwern@pobox.com>
2587 Send patches and ideas to C<makemaker@perl.org>.
2589 Send bug reports via http://rt.cpan.org/. Please send your
2590 generated Makefile along with your report.
2592 For more up-to-date information, see L<http://www.makemaker.org>.
2596 This program is free software; you can redistribute it and/or
2597 modify it under the same terms as Perl itself.
2599 See L<http://www.perl.com/perl/misc/Artistic.html>