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