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