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