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