| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "ExtUtils::MM_Unix 3perl" |
| 58 |
.TH ExtUtils::MM_Unix 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide" |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
ExtUtils::MM_Unix \- methods used by ExtUtils::MakeMaker |
| 65 |
.SH SYNOPSIS |
| 66 |
.IX Header "SYNOPSIS" |
| 67 |
.Vb 1 |
| 68 |
\& require ExtUtils::MM_Unix; |
| 69 |
.Ve |
| 70 |
.SH DESCRIPTION |
| 71 |
.IX Header "DESCRIPTION" |
| 72 |
The methods provided by this package are designed to be used in |
| 73 |
conjunction with ExtUtils::MakeMaker. When MakeMaker writes a |
| 74 |
Makefile, it creates one or more objects that inherit their methods |
| 75 |
from a package MM. MM itself doesn't provide any methods, but |
| 76 |
it ISA ExtUtils::MM_Unix class. The inheritance tree of MM lets operating |
| 77 |
specific packages take the responsibility for all the methods provided |
| 78 |
by MM_Unix. We are trying to reduce the number of the necessary |
| 79 |
overrides by defining rather primitive operations within |
| 80 |
ExtUtils::MM_Unix. |
| 81 |
.PP |
| 82 |
If you are going to write a platform specific MM package, please try |
| 83 |
to limit the necessary overrides to primitive methods, and if it is not |
| 84 |
possible to do so, let's work out how to achieve that gain. |
| 85 |
.PP |
| 86 |
If you are overriding any of these methods in your Makefile.PL (in the |
| 87 |
MY class), please report that to the makemaker mailing list. We are |
| 88 |
trying to minimize the necessary method overrides and switch to data |
| 89 |
driven Makefile.PLs wherever possible. In the long run less methods |
| 90 |
will be overridable via the MY class. |
| 91 |
.SH METHODS |
| 92 |
.IX Header "METHODS" |
| 93 |
The following description of methods is still under |
| 94 |
development. Please refer to the code for not suitably documented |
| 95 |
sections and complain loudly to the [email protected] mailing list. |
| 96 |
Better yet, provide a patch. |
| 97 |
.PP |
| 98 |
Not all of the methods below are overridable in a |
| 99 |
Makefile.PL. Overridable methods are marked as (o). All methods are |
| 100 |
overridable by a platform specific MM_*.pm file. |
| 101 |
.PP |
| 102 |
Cross-platform methods are being moved into MM_Any. |
| 103 |
If you can't find something that used to be in here, look in MM_Any. |
| 104 |
.SS Methods |
| 105 |
.IX Subsection "Methods" |
| 106 |
.IP os_flavor 4 |
| 107 |
.IX Item "os_flavor" |
| 108 |
Simply says that we're Unix. |
| 109 |
.IP "c_o (o)" 4 |
| 110 |
.IX Item "c_o (o)" |
| 111 |
Defines the suffix rules to compile different flavors of C files to |
| 112 |
object files. |
| 113 |
.IP xs_obj_opt 4 |
| 114 |
.IX Item "xs_obj_opt" |
| 115 |
Takes the object file as an argument, and returns the portion of compile |
| 116 |
command-line that will output to the specified object file. |
| 117 |
.IP dbgoutflag 4 |
| 118 |
.IX Item "dbgoutflag" |
| 119 |
Returns a CC flag that tells the CC to emit a separate debugging symbol file |
| 120 |
when compiling an object file. |
| 121 |
.IP "cflags (o)" 4 |
| 122 |
.IX Item "cflags (o)" |
| 123 |
Does very much the same as the cflags script in the perl |
| 124 |
distribution. It doesn't return the whole compiler command line, but |
| 125 |
initializes all of its parts. The const_cccmd method then actually |
| 126 |
returns the definition of the CCCMD macro which uses these parts. |
| 127 |
.IP "const_cccmd (o)" 4 |
| 128 |
.IX Item "const_cccmd (o)" |
| 129 |
Returns the full compiler call for C programs and stores the |
| 130 |
definition in CONST_CCCMD. |
| 131 |
.IP "const_config (o)" 4 |
| 132 |
.IX Item "const_config (o)" |
| 133 |
Sets SHELL if needed, then defines a couple of constants in the Makefile |
| 134 |
that are imported from \f(CW%Config\fR. |
| 135 |
.IP "const_loadlibs (o)" 4 |
| 136 |
.IX Item "const_loadlibs (o)" |
| 137 |
Defines EXTRALIBS, LDLOADLIBS, BSLOADLIBS, LD_RUN_PATH. See |
| 138 |
ExtUtils::Liblist for details. |
| 139 |
.IP "constants (o)" 4 |
| 140 |
.IX Item "constants (o)" |
| 141 |
.Vb 1 |
| 142 |
\& my $make_frag = $mm\->constants; |
| 143 |
.Ve |
| 144 |
.Sp |
| 145 |
Prints out macros for lots of constants. |
| 146 |
.IP "depend (o)" 4 |
| 147 |
.IX Item "depend (o)" |
| 148 |
Same as macro for the depend attribute. |
| 149 |
.IP init_DEST 4 |
| 150 |
.IX Item "init_DEST" |
| 151 |
.Vb 1 |
| 152 |
\& $mm\->init_DEST |
| 153 |
.Ve |
| 154 |
.Sp |
| 155 |
Defines the DESTDIR and DEST* variables paralleling the INSTALL*. |
| 156 |
.IP init_dist 4 |
| 157 |
.IX Item "init_dist" |
| 158 |
.Vb 1 |
| 159 |
\& $mm\->init_dist; |
| 160 |
.Ve |
| 161 |
.Sp |
| 162 |
Defines a lot of macros for distribution support. |
| 163 |
.Sp |
| 164 |
.Vb 1 |
| 165 |
\& macro description default |
| 166 |
\& |
| 167 |
\& TAR tar command to use tar |
| 168 |
\& TARFLAGS flags to pass to TAR cvf |
| 169 |
\& |
| 170 |
\& ZIP zip command to use zip |
| 171 |
\& ZIPFLAGS flags to pass to ZIP \-r |
| 172 |
\& |
| 173 |
\& COMPRESS compression command to gzip \-\-best |
| 174 |
\& use for tarfiles |
| 175 |
\& SUFFIX suffix to put on .gz |
| 176 |
\& compressed files |
| 177 |
\& |
| 178 |
\& SHAR shar command to use shar |
| 179 |
\& |
| 180 |
\& PREOP extra commands to run before |
| 181 |
\& making the archive |
| 182 |
\& POSTOP extra commands to run after |
| 183 |
\& making the archive |
| 184 |
\& |
| 185 |
\& TO_UNIX a command to convert linefeeds |
| 186 |
\& to Unix style in your archive |
| 187 |
\& |
| 188 |
\& CI command to checkin your ci \-u |
| 189 |
\& sources to version control |
| 190 |
\& RCS_LABEL command to label your sources rcs \-Nv$(VERSION_SYM): \-q |
| 191 |
\& just after CI is run |
| 192 |
\& |
| 193 |
\& DIST_CP $how argument to manicopy() best |
| 194 |
\& when the distdir is created |
| 195 |
\& |
| 196 |
\& DIST_DEFAULT default target to use to tardist |
| 197 |
\& create a distribution |
| 198 |
\& |
| 199 |
\& DISTVNAME name of the resulting archive $(DISTNAME)\-$(VERSION) |
| 200 |
\& (minus suffixes) |
| 201 |
.Ve |
| 202 |
.IP "dist (o)" 4 |
| 203 |
.IX Item "dist (o)" |
| 204 |
.Vb 1 |
| 205 |
\& my $dist_macros = $mm\->dist(%overrides); |
| 206 |
.Ve |
| 207 |
.Sp |
| 208 |
Generates a make fragment defining all the macros initialized in |
| 209 |
init_dist. |
| 210 |
.Sp |
| 211 |
\&\f(CW%overrides\fR can be used to override any of the above. |
| 212 |
.IP "dist_basics (o)" 4 |
| 213 |
.IX Item "dist_basics (o)" |
| 214 |
Defines the targets distclean, distcheck, skipcheck, manifest, veryclean. |
| 215 |
.IP "dist_ci (o)" 4 |
| 216 |
.IX Item "dist_ci (o)" |
| 217 |
Defines a check in target for RCS. |
| 218 |
.IP "dist_core (o)" 4 |
| 219 |
.IX Item "dist_core (o)" |
| 220 |
.Vb 1 |
| 221 |
\& my $dist_make_fragment = $MM\->dist_core; |
| 222 |
.Ve |
| 223 |
.Sp |
| 224 |
Puts the targets necessary for 'make dist' together into one make |
| 225 |
fragment. |
| 226 |
.IP \fBdist_target\fR 4 |
| 227 |
.IX Item "dist_target" |
| 228 |
.Vb 1 |
| 229 |
\& my $make_frag = $MM\->dist_target; |
| 230 |
.Ve |
| 231 |
.Sp |
| 232 |
Returns the 'dist' target to make an archive for distribution. This |
| 233 |
target simply checks to make sure the Makefile is up-to-date and |
| 234 |
depends on $(DIST_DEFAULT). |
| 235 |
.IP \fBtardist_target\fR 4 |
| 236 |
.IX Item "tardist_target" |
| 237 |
.Vb 1 |
| 238 |
\& my $make_frag = $MM\->tardist_target; |
| 239 |
.Ve |
| 240 |
.Sp |
| 241 |
Returns the 'tardist' target which is simply so 'make tardist' works. |
| 242 |
The real work is done by the dynamically named \fBtardistfile_target()\fR |
| 243 |
method, tardist should have that as a dependency. |
| 244 |
.IP \fBzipdist_target\fR 4 |
| 245 |
.IX Item "zipdist_target" |
| 246 |
.Vb 1 |
| 247 |
\& my $make_frag = $MM\->zipdist_target; |
| 248 |
.Ve |
| 249 |
.Sp |
| 250 |
Returns the 'zipdist' target which is simply so 'make zipdist' works. |
| 251 |
The real work is done by the dynamically named \fBzipdistfile_target()\fR |
| 252 |
method, zipdist should have that as a dependency. |
| 253 |
.IP \fBtarfile_target\fR 4 |
| 254 |
.IX Item "tarfile_target" |
| 255 |
.Vb 1 |
| 256 |
\& my $make_frag = $MM\->tarfile_target; |
| 257 |
.Ve |
| 258 |
.Sp |
| 259 |
The name of this target is the name of the tarball generated by |
| 260 |
tardist. This target does the actual work of turning the distdir into |
| 261 |
a tarball. |
| 262 |
.IP zipfile_target 4 |
| 263 |
.IX Item "zipfile_target" |
| 264 |
.Vb 1 |
| 265 |
\& my $make_frag = $MM\->zipfile_target; |
| 266 |
.Ve |
| 267 |
.Sp |
| 268 |
The name of this target is the name of the zip file generated by |
| 269 |
zipdist. This target does the actual work of turning the distdir into |
| 270 |
a zip file. |
| 271 |
.IP uutardist_target 4 |
| 272 |
.IX Item "uutardist_target" |
| 273 |
.Vb 1 |
| 274 |
\& my $make_frag = $MM\->uutardist_target; |
| 275 |
.Ve |
| 276 |
.Sp |
| 277 |
Converts the tarfile into a uuencoded file |
| 278 |
.IP shdist_target 4 |
| 279 |
.IX Item "shdist_target" |
| 280 |
.Vb 1 |
| 281 |
\& my $make_frag = $MM\->shdist_target; |
| 282 |
.Ve |
| 283 |
.Sp |
| 284 |
Converts the distdir into a shell archive. |
| 285 |
.IP "dlsyms (o)" 4 |
| 286 |
.IX Item "dlsyms (o)" |
| 287 |
Used by some OS' to define DL_FUNCS and DL_VARS and write the *.exp files. |
| 288 |
.Sp |
| 289 |
Normally just returns an empty string. |
| 290 |
.IP "dynamic_bs (o)" 4 |
| 291 |
.IX Item "dynamic_bs (o)" |
| 292 |
Defines targets for bootstrap files. |
| 293 |
.IP "dynamic_lib (o)" 4 |
| 294 |
.IX Item "dynamic_lib (o)" |
| 295 |
Defines how to produce the *.so (or equivalent) files. |
| 296 |
.IP xs_dynamic_lib_macros 4 |
| 297 |
.IX Item "xs_dynamic_lib_macros" |
| 298 |
Defines the macros for the \f(CW\*(C`dynamic_lib\*(C'\fR section. |
| 299 |
.IP xs_make_dynamic_lib 4 |
| 300 |
.IX Item "xs_make_dynamic_lib" |
| 301 |
Defines the recipes for the \f(CW\*(C`dynamic_lib\*(C'\fR section. |
| 302 |
.IP exescan 4 |
| 303 |
.IX Item "exescan" |
| 304 |
Deprecated method. Use libscan instead. |
| 305 |
.IP extliblist 4 |
| 306 |
.IX Item "extliblist" |
| 307 |
Called by init_others, and calls ext ExtUtils::Liblist. See |
| 308 |
ExtUtils::Liblist for details. |
| 309 |
.IP find_perl 4 |
| 310 |
.IX Item "find_perl" |
| 311 |
Finds the executables PERL and FULLPERL |
| 312 |
.IP fixin 4 |
| 313 |
.IX Item "fixin" |
| 314 |
.Vb 1 |
| 315 |
\& $mm\->fixin(@files); |
| 316 |
.Ve |
| 317 |
.Sp |
| 318 |
Inserts the sharpbang or equivalent magic number to a set of \f(CW@files\fR. |
| 319 |
.IP "force (o)" 4 |
| 320 |
.IX Item "force (o)" |
| 321 |
Writes an empty FORCE: target. |
| 322 |
.IP guess_name 4 |
| 323 |
.IX Item "guess_name" |
| 324 |
Guess the name of this package by examining the working directory's |
| 325 |
name. MakeMaker calls this only if the developer has not supplied a |
| 326 |
NAME attribute. |
| 327 |
.IP has_link_code 4 |
| 328 |
.IX Item "has_link_code" |
| 329 |
Returns true if C, XS, MYEXTLIB or similar objects exist within this |
| 330 |
object that need a compiler. Does not descend into subdirectories as |
| 331 |
\&\fBneeds_linking()\fR does. |
| 332 |
.IP init_dirscan 4 |
| 333 |
.IX Item "init_dirscan" |
| 334 |
Scans the directory structure and initializes DIR, XS, XS_FILES, |
| 335 |
C, C_FILES, O_FILES, H, H_FILES, PL_FILES, EXE_FILES. |
| 336 |
.Sp |
| 337 |
Called by init_main. |
| 338 |
.IP init_MANPODS 4 |
| 339 |
.IX Item "init_MANPODS" |
| 340 |
Determines if man pages should be generated and initializes MAN1PODS |
| 341 |
and MAN3PODS as appropriate. |
| 342 |
.IP init_MAN1PODS 4 |
| 343 |
.IX Item "init_MAN1PODS" |
| 344 |
Initializes MAN1PODS from the list of EXE_FILES. |
| 345 |
.IP init_MAN3PODS 4 |
| 346 |
.IX Item "init_MAN3PODS" |
| 347 |
Initializes MAN3PODS from the list of PM files. |
| 348 |
.IP init_PM 4 |
| 349 |
.IX Item "init_PM" |
| 350 |
Initializes PMLIBDIRS and PM from PMLIBDIRS. |
| 351 |
.IP init_DIRFILESEP 4 |
| 352 |
.IX Item "init_DIRFILESEP" |
| 353 |
Using / for Unix. Called by init_main. |
| 354 |
.IP init_main 4 |
| 355 |
.IX Item "init_main" |
| 356 |
Initializes AR, AR_STATIC_ARGS, BASEEXT, CONFIG, DISTNAME, DLBASE, |
| 357 |
EXE_EXT, FULLEXT, FULLPERL, FULLPERLRUN, FULLPERLRUNINST, INST_*, |
| 358 |
INSTALL*, INSTALLDIRS, LIB_EXT, LIBPERL_A, MAP_TARGET, NAME, |
| 359 |
OBJ_EXT, PARENT_NAME, PERL, PERL_ARCHLIB, PERL_INC, PERL_LIB, |
| 360 |
PERL_SRC, PERLRUN, PERLRUNINST, PREFIX, VERSION, |
| 361 |
VERSION_SYM, XS_VERSION. |
| 362 |
.IP init_tools 4 |
| 363 |
.IX Item "init_tools" |
| 364 |
Initializes tools to use their common (and faster) Unix commands. |
| 365 |
.IP init_linker 4 |
| 366 |
.IX Item "init_linker" |
| 367 |
Unix has no need of special linker flags. |
| 368 |
.IP init_PERL 4 |
| 369 |
.IX Item "init_PERL" |
| 370 |
.Vb 1 |
| 371 |
\& $mm\->init_PERL; |
| 372 |
.Ve |
| 373 |
.Sp |
| 374 |
Called by init_main. Sets up ABSPERL, PERL, FULLPERL and all the |
| 375 |
*PERLRUN* permutations. |
| 376 |
.Sp |
| 377 |
.Vb 2 |
| 378 |
\& PERL is allowed to be miniperl |
| 379 |
\& FULLPERL must be a complete perl |
| 380 |
\& |
| 381 |
\& ABSPERL is PERL converted to an absolute path |
| 382 |
\& |
| 383 |
\& *PERLRUN contains everything necessary to run perl, find it\*(Aqs |
| 384 |
\& libraries, etc... |
| 385 |
\& |
| 386 |
\& *PERLRUNINST is *PERLRUN + everything necessary to find the |
| 387 |
\& modules being built. |
| 388 |
.Ve |
| 389 |
.IP init_platform 4 |
| 390 |
.IX Item "init_platform" |
| 391 |
.PD 0 |
| 392 |
.IP platform_constants 4 |
| 393 |
.IX Item "platform_constants" |
| 394 |
.PD |
| 395 |
Add MM_Unix_VERSION. |
| 396 |
.IP init_PERM 4 |
| 397 |
.IX Item "init_PERM" |
| 398 |
.Vb 1 |
| 399 |
\& $mm\->init_PERM |
| 400 |
.Ve |
| 401 |
.Sp |
| 402 |
Called by init_main. Initializes PERL_* |
| 403 |
.IP init_xs 4 |
| 404 |
.IX Item "init_xs" |
| 405 |
.Vb 1 |
| 406 |
\& $mm\->init_xs |
| 407 |
.Ve |
| 408 |
.Sp |
| 409 |
Sets up macros having to do with XS code. Currently just INST_STATIC, |
| 410 |
INST_DYNAMIC and INST_BOOT. |
| 411 |
.IP "install (o)" 4 |
| 412 |
.IX Item "install (o)" |
| 413 |
Defines the install target. |
| 414 |
.IP "installbin (o)" 4 |
| 415 |
.IX Item "installbin (o)" |
| 416 |
Defines targets to make and to install EXE_FILES. |
| 417 |
.IP "linkext (o)" 4 |
| 418 |
.IX Item "linkext (o)" |
| 419 |
Defines the linkext target which in turn defines the LINKTYPE. |
| 420 |
.IP lsdir 4 |
| 421 |
.IX Item "lsdir" |
| 422 |
Takes as arguments a directory name and a regular expression. Returns |
| 423 |
all entries in the directory that match the regular expression. |
| 424 |
.IP "macro (o)" 4 |
| 425 |
.IX Item "macro (o)" |
| 426 |
Simple subroutine to insert the macros defined by the macro attribute |
| 427 |
into the Makefile. |
| 428 |
.IP "makeaperl (o)" 4 |
| 429 |
.IX Item "makeaperl (o)" |
| 430 |
Called by staticmake. Defines how to write the Makefile to produce a |
| 431 |
static new perl. |
| 432 |
.Sp |
| 433 |
By default the Makefile produced includes all the static extensions in |
| 434 |
the perl library. (Purified versions of library files, e.g., |
| 435 |
DynaLoader_pure_p1_c0_032.a are automatically ignored to avoid link errors.) |
| 436 |
.IP "xs_static_lib_is_xs (o)" 4 |
| 437 |
.IX Item "xs_static_lib_is_xs (o)" |
| 438 |
Called by a utility method of makeaperl. Checks whether a given file |
| 439 |
is an XS library by seeing whether it defines any symbols starting |
| 440 |
with \f(CW\*(C`boot_\*(C'\fR (with an optional leading underscore \- needed on MacOS). |
| 441 |
.IP "makefile (o)" 4 |
| 442 |
.IX Item "makefile (o)" |
| 443 |
Defines how to rewrite the Makefile. |
| 444 |
.IP maybe_command 4 |
| 445 |
.IX Item "maybe_command" |
| 446 |
Returns true, if the argument is likely to be a command. |
| 447 |
.IP "needs_linking (o)" 4 |
| 448 |
.IX Item "needs_linking (o)" |
| 449 |
Does this module need linking? Looks into subdirectory objects (see |
| 450 |
also \fBhas_link_code()\fR) |
| 451 |
.IP parse_abstract 4 |
| 452 |
.IX Item "parse_abstract" |
| 453 |
parse a file and return what you think is the ABSTRACT |
| 454 |
.IP parse_version 4 |
| 455 |
.IX Item "parse_version" |
| 456 |
.Vb 1 |
| 457 |
\& my $version = MM\->parse_version($file); |
| 458 |
.Ve |
| 459 |
.Sp |
| 460 |
Parse a \f(CW$file\fR and return what \f(CW$VERSION\fR is set to by the first assignment. |
| 461 |
It will return the string "undef" if it can't figure out what \f(CW$VERSION\fR |
| 462 |
is. \f(CW$VERSION\fR should be for all to see, so \f(CW\*(C`our $VERSION\*(C'\fR or plain \f(CW$VERSION\fR |
| 463 |
are okay, but \f(CW\*(C`my $VERSION\*(C'\fR is not. |
| 464 |
.Sp |
| 465 |
\&\f(CW\*(C`package Foo VERSION\*(C'\fR is also checked for. The first version |
| 466 |
declaration found is used, but this may change as it differs from how |
| 467 |
Perl does it. |
| 468 |
.Sp |
| 469 |
\&\fBparse_version()\fR will try to \f(CW\*(C`use version\*(C'\fR before checking for |
| 470 |
\&\f(CW$VERSION\fR so the following will work. |
| 471 |
.Sp |
| 472 |
.Vb 1 |
| 473 |
\& $VERSION = qv(1.2.3); |
| 474 |
.Ve |
| 475 |
.IP "pasthru (o)" 4 |
| 476 |
.IX Item "pasthru (o)" |
| 477 |
Defines the string that is passed to recursive make calls in |
| 478 |
subdirectories. The variables like \f(CW\*(C`PASTHRU_DEFINE\*(C'\fR are used in each |
| 479 |
level, and passed downwards on the command-line with e.g. the value of |
| 480 |
that level's DEFINE. Example: |
| 481 |
.Sp |
| 482 |
.Vb 6 |
| 483 |
\& # Level 0 has DEFINE = \-Dfunky |
| 484 |
\& # This code will define level 0\*(Aqs PASTHRU=PASTHRU_DEFINE="$(DEFINE) |
| 485 |
\& # $(PASTHRU_DEFINE)" |
| 486 |
\& # Level 0\*(Aqs $(CCCMD) will include macros $(DEFINE) and $(PASTHRU_DEFINE) |
| 487 |
\& # So will level 1\*(Aqs, so when level 1 compiles, it will get right values |
| 488 |
\& # And so ad infinitum |
| 489 |
.Ve |
| 490 |
.IP perl_script 4 |
| 491 |
.IX Item "perl_script" |
| 492 |
Takes one argument, a file name, and returns the file name, if the |
| 493 |
argument is likely to be a perl script. On MM_Unix this is true for |
| 494 |
any ordinary, readable file. |
| 495 |
.IP "perldepend (o)" 4 |
| 496 |
.IX Item "perldepend (o)" |
| 497 |
Defines the dependency from all *.h files that come with the perl |
| 498 |
distribution. |
| 499 |
.IP pm_to_blib 4 |
| 500 |
.IX Item "pm_to_blib" |
| 501 |
Defines target that copies all files in the hash PM to their |
| 502 |
destination and autosplits them. See "DESCRIPTION" in ExtUtils::Install |
| 503 |
.IP ppd 4 |
| 504 |
.IX Item "ppd" |
| 505 |
Defines target that creates a PPD (Perl Package Description) file |
| 506 |
for a binary distribution. |
| 507 |
.IP prefixify 4 |
| 508 |
.IX Item "prefixify" |
| 509 |
.Vb 1 |
| 510 |
\& $MM\->prefixify($var, $prefix, $new_prefix, $default); |
| 511 |
.Ve |
| 512 |
.Sp |
| 513 |
Using either \f(CW$MM\fR\->{uc \f(CW$var\fR} || \f(CW$Config\fR{lc \f(CW$var\fR}, it will attempt to |
| 514 |
replace it's \f(CW$prefix\fR with a \f(CW$new_prefix\fR. |
| 515 |
.Sp |
| 516 |
Should the \f(CW$prefix\fR fail to match \fIAND\fR a PREFIX was given as an |
| 517 |
argument to \fBWriteMakefile()\fR it will set it to the \f(CW$new_prefix\fR + |
| 518 |
\&\f(CW$default\fR. This is for systems whose file layouts don't neatly fit into |
| 519 |
our ideas of prefixes. |
| 520 |
.Sp |
| 521 |
This is for heuristics which attempt to create directory structures |
| 522 |
that mirror those of the installed perl. |
| 523 |
.Sp |
| 524 |
For example: |
| 525 |
.Sp |
| 526 |
.Vb 1 |
| 527 |
\& $MM\->prefixify(\*(Aqinstallman1dir\*(Aq, \*(Aq/usr\*(Aq, \*(Aq/home/foo\*(Aq, \*(Aqman/man1\*(Aq); |
| 528 |
.Ve |
| 529 |
.Sp |
| 530 |
this will attempt to remove '/usr' from the front of the |
| 531 |
\&\f(CW$MM\fR\->{INSTALLMAN1DIR} path (initializing it to \f(CW$Config\fR{installman1dir} |
| 532 |
if necessary) and replace it with '/home/foo'. If this fails it will |
| 533 |
simply use '/home/foo/man/man1'. |
| 534 |
.IP "processPL (o)" 4 |
| 535 |
.IX Item "processPL (o)" |
| 536 |
Defines targets to run *.PL files. |
| 537 |
.IP specify_shell 4 |
| 538 |
.IX Item "specify_shell" |
| 539 |
Specify SHELL if needed \- not done on Unix. |
| 540 |
.IP quote_paren 4 |
| 541 |
.IX Item "quote_paren" |
| 542 |
Backslashes parentheses \f(CW\*(C`()\*(C'\fR in command line arguments. |
| 543 |
Doesn't handle recursive Makefile \f(CW\*(C`$(...)\*(C'\fR constructs, |
| 544 |
but handles simple ones. |
| 545 |
.IP replace_manpage_separator 4 |
| 546 |
.IX Item "replace_manpage_separator" |
| 547 |
.Vb 1 |
| 548 |
\& my $man_name = $MM\->replace_manpage_separator($file_path); |
| 549 |
.Ve |
| 550 |
.Sp |
| 551 |
Takes the name of a package, which may be a nested package, in the |
| 552 |
form 'Foo/Bar.pm' and replaces the slash with \f(CW\*(C`::\*(C'\fR or something else |
| 553 |
safe for a man page file name. Returns the replacement. |
| 554 |
.IP cd 4 |
| 555 |
.IX Item "cd" |
| 556 |
.PD 0 |
| 557 |
.IP oneliner 4 |
| 558 |
.IX Item "oneliner" |
| 559 |
.IP quote_literal 4 |
| 560 |
.IX Item "quote_literal" |
| 561 |
.PD |
| 562 |
Quotes macro literal value suitable for being used on a command line so |
| 563 |
that when expanded by make, will be received by command as given to |
| 564 |
this method: |
| 565 |
.Sp |
| 566 |
.Vb 6 |
| 567 |
\& my $quoted = $mm\->quote_literal(q{it isn\*(Aqt}); |
| 568 |
\& # returns: |
| 569 |
\& # \*(Aqit isn\*(Aq\e\*(Aq\*(Aqt\*(Aq |
| 570 |
\& print MAKEFILE "target:\en\etecho $quoted\en"; |
| 571 |
\& # when run "make target", will output: |
| 572 |
\& # it isn\*(Aqt |
| 573 |
.Ve |
| 574 |
.IP escape_newlines 4 |
| 575 |
.IX Item "escape_newlines" |
| 576 |
.PD 0 |
| 577 |
.IP max_exec_len 4 |
| 578 |
.IX Item "max_exec_len" |
| 579 |
.PD |
| 580 |
Using POSIX::ARG_MAX. Otherwise falling back to 4096. |
| 581 |
.IP "static (o)" 4 |
| 582 |
.IX Item "static (o)" |
| 583 |
Defines the static target. |
| 584 |
.IP xs_make_static_lib 4 |
| 585 |
.IX Item "xs_make_static_lib" |
| 586 |
Defines the recipes for the \f(CW\*(C`static_lib\*(C'\fR section. |
| 587 |
.IP static_lib_closures 4 |
| 588 |
.IX Item "static_lib_closures" |
| 589 |
Records \f(CW\*(C`$(EXTRALIBS)\*(C'\fR in \fIextralibs.ld\fR and \fI$(PERL_SRC)/ext.libs\fR. |
| 590 |
.IP static_lib_fixtures 4 |
| 591 |
.IX Item "static_lib_fixtures" |
| 592 |
Handles copying \f(CW\*(C`$(MYEXTLIB)\*(C'\fR as starter for final static library that |
| 593 |
then gets added to. |
| 594 |
.IP static_lib_pure_cmd 4 |
| 595 |
.IX Item "static_lib_pure_cmd" |
| 596 |
Defines how to run the archive utility. |
| 597 |
.IP "staticmake (o)" 4 |
| 598 |
.IX Item "staticmake (o)" |
| 599 |
Calls makeaperl. |
| 600 |
.IP "subdir_x (o)" 4 |
| 601 |
.IX Item "subdir_x (o)" |
| 602 |
Helper subroutine for subdirs |
| 603 |
.IP "subdirs (o)" 4 |
| 604 |
.IX Item "subdirs (o)" |
| 605 |
Defines targets to process subdirectories. |
| 606 |
.IP "test (o)" 4 |
| 607 |
.IX Item "test (o)" |
| 608 |
Defines the test targets. |
| 609 |
.IP "test_via_harness (override)" 4 |
| 610 |
.IX Item "test_via_harness (override)" |
| 611 |
For some reason which I forget, Unix machines like to have |
| 612 |
PERL_DL_NONLAZY set for tests. |
| 613 |
.IP "test_via_script (override)" 4 |
| 614 |
.IX Item "test_via_script (override)" |
| 615 |
Again, the PERL_DL_NONLAZY thing. |
| 616 |
.IP "tool_xsubpp (o)" 4 |
| 617 |
.IX Item "tool_xsubpp (o)" |
| 618 |
Determines typemaps, xsubpp version, prototype behaviour. |
| 619 |
.IP all_target 4 |
| 620 |
.IX Item "all_target" |
| 621 |
Build man pages, too |
| 622 |
.IP "top_targets (o)" 4 |
| 623 |
.IX Item "top_targets (o)" |
| 624 |
Defines the targets all, subdirs, config, and O_FILES |
| 625 |
.IP writedoc 4 |
| 626 |
.IX Item "writedoc" |
| 627 |
Obsolete, deprecated method. Not used since Version 5.21. |
| 628 |
.IP "xs_c (o)" 4 |
| 629 |
.IX Item "xs_c (o)" |
| 630 |
Defines the suffix rules to compile XS files to C. |
| 631 |
.IP "xs_cpp (o)" 4 |
| 632 |
.IX Item "xs_cpp (o)" |
| 633 |
Defines the suffix rules to compile XS files to C++. |
| 634 |
.IP "xs_o (o)" 4 |
| 635 |
.IX Item "xs_o (o)" |
| 636 |
Defines suffix rules to go from XS to object files directly. This was |
| 637 |
originally only intended for broken make implementations, but is now |
| 638 |
necessary for per-XS file under \f(CW\*(C`XSMULTI\*(C'\fR, since each XS file might |
| 639 |
have an individual \f(CW\*(C`$(VERSION)\*(C'\fR. |
| 640 |
.SH "SEE ALSO" |
| 641 |
.IX Header "SEE ALSO" |
| 642 |
ExtUtils::MakeMaker |