| 1 | .\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13 |
| 2 | .\" |
| 3 | .\" Standard preamble: |
| 4 | .\" ======================================================================== |
| 5 | .de Sh \" Subsection heading |
| 6 | .br |
| 7 | .if t .Sp |
| 8 | .ne 5 |
| 9 | .PP |
| 10 | \fB\\$1\fR |
| 11 | .PP |
| 12 | .. |
| 13 | .de Sp \" Vertical space (when we can't use .PP) |
| 14 | .if t .sp .5v |
| 15 | .if n .sp |
| 16 | .. |
| 17 | .de Vb \" Begin verbatim text |
| 18 | .ft CW |
| 19 | .nf |
| 20 | .ne \\$1 |
| 21 | .. |
| 22 | .de Ve \" End verbatim text |
| 23 | .ft R |
| 24 | .fi |
| 25 | .. |
| 26 | .\" Set up some character translations and predefined strings. \*(-- will |
| 27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
| 28 | .\" double quote, and \*(R" will give a right double quote. | will give a |
| 29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to |
| 30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' |
| 31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. |
| 32 | .tr \(*W-|\(bv\*(Tr |
| 33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
| 34 | .ie n \{\ |
| 35 | . ds -- \(*W- |
| 36 | . ds PI pi |
| 37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
| 38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
| 39 | . ds L" "" |
| 40 | . ds R" "" |
| 41 | . ds C` "" |
| 42 | . ds C' "" |
| 43 | 'br\} |
| 44 | .el\{\ |
| 45 | . ds -- \|\(em\| |
| 46 | . ds PI \(*p |
| 47 | . ds L" `` |
| 48 | . ds R" '' |
| 49 | 'br\} |
| 50 | .\" |
| 51 | .\" If the F register is turned on, we'll generate index entries on stderr for |
| 52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index |
| 53 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
| 54 | .\" output yourself in some meaningful fashion. |
| 55 | .if \nF \{\ |
| 56 | . de IX |
| 57 | . tm Index:\\$1\t\\n%\t"\\$2" |
| 58 | .. |
| 59 | . nr % 0 |
| 60 | . rr F |
| 61 | .\} |
| 62 | .\" |
| 63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 64 | .\" way too many mistakes in technical documents. |
| 65 | .hy 0 |
| 66 | .if n .na |
| 67 | .\" |
| 68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
| 69 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
| 70 | . \" fudge factors for nroff and troff |
| 71 | .if n \{\ |
| 72 | . ds #H 0 |
| 73 | . ds #V .8m |
| 74 | . ds #F .3m |
| 75 | . ds #[ \f1 |
| 76 | . ds #] \fP |
| 77 | .\} |
| 78 | .if t \{\ |
| 79 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
| 80 | . ds #V .6m |
| 81 | . ds #F 0 |
| 82 | . ds #[ \& |
| 83 | . ds #] \& |
| 84 | .\} |
| 85 | . \" simple accents for nroff and troff |
| 86 | .if n \{\ |
| 87 | . ds ' \& |
| 88 | . ds ` \& |
| 89 | . ds ^ \& |
| 90 | . ds , \& |
| 91 | . ds ~ ~ |
| 92 | . ds / |
| 93 | .\} |
| 94 | .if t \{\ |
| 95 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
| 96 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
| 97 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
| 98 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
| 99 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
| 100 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
| 101 | .\} |
| 102 | . \" troff and (daisy-wheel) nroff accents |
| 103 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
| 104 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
| 105 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
| 106 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
| 107 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
| 108 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
| 109 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
| 110 | .ds ae a\h'-(\w'a'u*4/10)'e |
| 111 | .ds Ae A\h'-(\w'A'u*4/10)'E |
| 112 | . \" corrections for vroff |
| 113 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
| 114 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
| 115 | . \" for low resolution devices (crt and lpr) |
| 116 | .if \n(.H>23 .if \n(.V>19 \ |
| 117 | \{\ |
| 118 | . ds : e |
| 119 | . ds 8 ss |
| 120 | . ds o a |
| 121 | . ds d- d\h'-1'\(ga |
| 122 | . ds D- D\h'-1'\(hy |
| 123 | . ds th \o'bp' |
| 124 | . ds Th \o'LP' |
| 125 | . ds ae ae |
| 126 | . ds Ae AE |
| 127 | .\} |
| 128 | .rm #[ #] #H #V #F C |
| 129 | .\" ======================================================================== |
| 130 | .\" |
| 131 | .IX Title "ExtUtils::MM_Any 3" |
| 132 | .TH ExtUtils::MM_Any 3 "2003-08-18" "perl v5.8.0" "User Contributed Perl Documentation" |
| 133 | .SH "NAME" |
| 134 | ExtUtils::MM_Any \- Platform\-agnostic MM methods |
| 135 | .SH "SYNOPSIS" |
| 136 | .IX Header "SYNOPSIS" |
| 137 | .Vb 1 |
| 138 | \& FOR INTERNAL USE ONLY! |
| 139 | .Ve |
| 140 | .PP |
| 141 | .Vb 1 |
| 142 | \& package ExtUtils::MM_SomeOS; |
| 143 | .Ve |
| 144 | .PP |
| 145 | .Vb 4 |
| 146 | \& # Temporarily, you have to subclass both. Put MM_Any first. |
| 147 | \& require ExtUtils::MM_Any; |
| 148 | \& require ExtUtils::MM_Unix; |
| 149 | \& @ISA = qw(ExtUtils::MM_Any ExtUtils::Unix); |
| 150 | .Ve |
| 151 | .SH "DESCRIPTION" |
| 152 | .IX Header "DESCRIPTION" |
| 153 | \&\fB\s-1FOR\s0 \s-1INTERNAL\s0 \s-1USE\s0 \s-1ONLY\s0!\fR |
| 154 | .PP |
| 155 | ExtUtils::MM_Any is a superclass for the ExtUtils::MM_* set of |
| 156 | modules. It contains methods which are either inherently |
| 157 | cross-platform or are written in a cross-platform manner. |
| 158 | .PP |
| 159 | Subclass off of ExtUtils::MM_Any \fIand\fR ExtUtils::MM_Unix. This is a |
| 160 | temporary solution. |
| 161 | .PP |
| 162 | \&\fB\s-1THIS\s0 \s-1MAY\s0 \s-1BE\s0 \s-1TEMPORARY\s0!\fR |
| 163 | .SH "Inherently Cross-Platform Methods" |
| 164 | .IX Header "Inherently Cross-Platform Methods" |
| 165 | These are methods which are by their nature cross-platform and should |
| 166 | always be cross\-platform. |
| 167 | .IP "installvars" 4 |
| 168 | .IX Item "installvars" |
| 169 | .Vb 1 |
| 170 | \& my @installvars = $mm->installvars; |
| 171 | .Ve |
| 172 | .Sp |
| 173 | A list of all the INSTALL* variables without the \s-1INSTALL\s0 prefix. Useful |
| 174 | for iteration or building related variable sets. |
| 175 | .IP "os_flavor_is" 4 |
| 176 | .IX Item "os_flavor_is" |
| 177 | .Vb 2 |
| 178 | \& $mm->os_flavor_is($this_flavor); |
| 179 | \& $mm->os_flavor_is(@one_of_these_flavors); |
| 180 | .Ve |
| 181 | .Sp |
| 182 | Checks to see if the current operating system is one of the given flavors. |
| 183 | .Sp |
| 184 | This is useful for code like: |
| 185 | .Sp |
| 186 | .Vb 6 |
| 187 | \& if( $mm->os_flavor_is('Unix') ) { |
| 188 | \& $out = `foo 2>&1`; |
| 189 | \& } |
| 190 | \& else { |
| 191 | \& $out = `foo`; |
| 192 | \& } |
| 193 | .Ve |
| 194 | .IP "dir_targets \fB\s-1DEPRECATED\s0\fR" 4 |
| 195 | .IX Item "dir_targets DEPRECATED" |
| 196 | .Vb 1 |
| 197 | \& my $make_frag = $mm->dir_target(@directories); |
| 198 | .Ve |
| 199 | .Sp |
| 200 | \&\fIThis function is deprecated\fR its use is no longer necessary and is |
| 201 | \&\fIonly provided for backwards compatibility\fR. It is now a no\-op. |
| 202 | blibdirs_target provides a much simpler mechanism and \fIpm_to_blib()\fR can |
| 203 | create its own directories anyway. |
| 204 | .IP "blibdirs_target (o)" 4 |
| 205 | .IX Item "blibdirs_target (o)" |
| 206 | .Vb 1 |
| 207 | \& my $make_frag = $mm->blibdirs_target; |
| 208 | .Ve |
| 209 | .Sp |
| 210 | Creates the blibdirs.ts target which creates all the directories we use in |
| 211 | blib/. |
| 212 | .Sh "File::Spec wrappers" |
| 213 | .IX Subsection "File::Spec wrappers" |
| 214 | ExtUtils::MM_Any is a subclass of File::Spec. The methods noted here |
| 215 | override File::Spec. |
| 216 | .IP "catfile" 4 |
| 217 | .IX Item "catfile" |
| 218 | File::Spec <= 0.83 has a bug where the file part of catfile is not |
| 219 | canonicalized. This override fixes that bug. |
| 220 | .SH "Thought To Be Cross-Platform Methods" |
| 221 | .IX Header "Thought To Be Cross-Platform Methods" |
| 222 | These are methods which are thought to be cross-platform by virtue of |
| 223 | having been written in a way to avoid incompatibilities. They may |
| 224 | require partial overrides. |
| 225 | .IP "\fBsplit_command\fR" 4 |
| 226 | .IX Item "split_command" |
| 227 | .Vb 1 |
| 228 | \& my @cmds = $MM->split_command($cmd, @args); |
| 229 | .Ve |
| 230 | .Sp |
| 231 | Most \s-1OS\s0 have a maximum command length they can execute at once. Large |
| 232 | modules can easily generate commands well past that limit. Its |
| 233 | necessary to split long commands up into a series of shorter commands. |
| 234 | .Sp |
| 235 | \&\fIsplit_command()\fR will return a series of \f(CW@cmds\fR each processing part of |
| 236 | the args. Collectively they will process all the arguments. Each |
| 237 | individual line in \f(CW@cmds\fR will not be longer than the |
| 238 | \&\f(CW$self\fR\->max_exec_len being careful to take into account macro expansion. |
| 239 | .Sp |
| 240 | $cmd should include any switches and repeated initial arguments. |
| 241 | .Sp |
| 242 | If no \f(CW@args\fR are given, no \f(CW@cmds\fR will be returned. |
| 243 | .Sp |
| 244 | Pairs of arguments will always be preserved in a single command, this |
| 245 | is a heuristic for things like pm_to_blib and pod2man which work on |
| 246 | pairs of arguments. This makes things like this safe: |
| 247 | .Sp |
| 248 | .Vb 1 |
| 249 | \& $self->split_command($cmd, %pod2man); |
| 250 | .Ve |
| 251 | .IP "\fBecho\fR" 4 |
| 252 | .IX Item "echo" |
| 253 | .Vb 3 |
| 254 | \& my @commands = $MM->echo($text); |
| 255 | \& my @commands = $MM->echo($text, $file); |
| 256 | \& my @commands = $MM->echo($text, $file, $appending); |
| 257 | .Ve |
| 258 | .Sp |
| 259 | Generates a set of \f(CW@commands\fR which print the \f(CW$text\fR to a \f(CW$file\fR. |
| 260 | .Sp |
| 261 | If \f(CW$file\fR is not given, output goes to \s-1STDOUT\s0. |
| 262 | .Sp |
| 263 | If \f(CW$appending\fR is true the \f(CW$file\fR will be appended to rather than |
| 264 | overwritten. |
| 265 | .IP "init_VERSION" 4 |
| 266 | .IX Item "init_VERSION" |
| 267 | .Vb 1 |
| 268 | \& $mm->init_VERSION |
| 269 | .Ve |
| 270 | .Sp |
| 271 | Initialize macros representing versions of MakeMaker and other tools |
| 272 | .Sp |
| 273 | \&\s-1MAKEMAKER:\s0 path to the MakeMaker module. |
| 274 | .Sp |
| 275 | \&\s-1MM_VERSION:\s0 ExtUtils::MakeMaker Version |
| 276 | .Sp |
| 277 | \&\s-1MM_REVISION:\s0 ExtUtils::MakeMaker version control revision (for backwards |
| 278 | compat) |
| 279 | .Sp |
| 280 | \&\s-1VERSION:\s0 version of your module |
| 281 | .Sp |
| 282 | \&\s-1VERSION_MACRO:\s0 which macro represents the version (usually '\s-1VERSION\s0') |
| 283 | .Sp |
| 284 | \&\s-1VERSION_SYM:\s0 like version but safe for use as an \s-1RCS\s0 revision number |
| 285 | .Sp |
| 286 | \&\s-1DEFINE_VERSION:\s0 \-D line to set the module version when compiling |
| 287 | .Sp |
| 288 | \&\s-1XS_VERSION:\s0 version in your .xs file. Defaults to $(\s-1VERSION\s0) |
| 289 | .Sp |
| 290 | \&\s-1XS_VERSION_MACRO:\s0 which macro represents the \s-1XS\s0 version. |
| 291 | .Sp |
| 292 | \&\s-1XS_DEFINE_VERSION:\s0 \-D line to set the xs version when compiling. |
| 293 | .Sp |
| 294 | Called by init_main. |
| 295 | .IP "wraplist" 4 |
| 296 | .IX Item "wraplist" |
| 297 | Takes an array of items and turns them into a well-formatted list of |
| 298 | arguments. In most cases this is simply something like: |
| 299 | .Sp |
| 300 | .Vb 3 |
| 301 | \& FOO \e |
| 302 | \& BAR \e |
| 303 | \& BAZ |
| 304 | .Ve |
| 305 | .IP "manifypods" 4 |
| 306 | .IX Item "manifypods" |
| 307 | Defines targets and routines to translate the pods into manpages and |
| 308 | put them into the INST_* directories. |
| 309 | .IP "manifypods_target" 4 |
| 310 | .IX Item "manifypods_target" |
| 311 | .Vb 1 |
| 312 | \& my $manifypods_target = $self->manifypods_target; |
| 313 | .Ve |
| 314 | .Sp |
| 315 | Generates the manifypods target. This target generates man pages from |
| 316 | all \s-1POD\s0 files in \s-1MAN1PODS\s0 and \s-1MAN3PODS\s0. |
| 317 | .IP "makemakerdflt_target" 4 |
| 318 | .IX Item "makemakerdflt_target" |
| 319 | .Vb 1 |
| 320 | \& my $make_frag = $mm->makemakerdflt_target |
| 321 | .Ve |
| 322 | .Sp |
| 323 | Returns a make fragment with the makemakerdeflt_target specified. |
| 324 | This target is the first target in the Makefile, is the default target |
| 325 | and simply points off to 'all' just in case any make variant gets |
| 326 | confused or something gets snuck in before the real 'all' target. |
| 327 | .IP "special_targets" 4 |
| 328 | .IX Item "special_targets" |
| 329 | .Vb 1 |
| 330 | \& my $make_frag = $mm->special_targets |
| 331 | .Ve |
| 332 | .Sp |
| 333 | Returns a make fragment containing any targets which have special |
| 334 | meaning to make. For example, .SUFFIXES and .PHONY. |
| 335 | .IP "POD2MAN_macro" 4 |
| 336 | .IX Item "POD2MAN_macro" |
| 337 | .Vb 1 |
| 338 | \& my $pod2man_macro = $self->POD2MAN_macro |
| 339 | .Ve |
| 340 | .Sp |
| 341 | Returns a definition for the \s-1POD2MAN\s0 macro. This is a program |
| 342 | which emulates the pod2man utility. You can add more switches to the |
| 343 | command by simply appending them on the macro. |
| 344 | .Sp |
| 345 | Typical usage: |
| 346 | .Sp |
| 347 | .Vb 1 |
| 348 | \& $(POD2MAN) --section=3 --perm_rw=$(PERM_RW) podfile1 man_page1 ... |
| 349 | .Ve |
| 350 | .IP "test_via_harness" 4 |
| 351 | .IX Item "test_via_harness" |
| 352 | .Vb 1 |
| 353 | \& my $command = $mm->test_via_harness($perl, $tests); |
| 354 | .Ve |
| 355 | .Sp |
| 356 | Returns a \f(CW$command\fR line which runs the given set of \f(CW$tests\fR with |
| 357 | Test::Harness and the given \f(CW$perl\fR. |
| 358 | .Sp |
| 359 | Used on the t/*.t files. |
| 360 | .IP "test_via_script" 4 |
| 361 | .IX Item "test_via_script" |
| 362 | .Vb 1 |
| 363 | \& my $command = $mm->test_via_script($perl, $script); |
| 364 | .Ve |
| 365 | .Sp |
| 366 | Returns a \f(CW$command\fR line which just runs a single test without |
| 367 | Test::Harness. No checks are done on the results, they're just |
| 368 | printed. |
| 369 | .Sp |
| 370 | Used for test.pl, since they don't always follow Test::Harness |
| 371 | formatting. |
| 372 | .IP "libscan" 4 |
| 373 | .IX Item "libscan" |
| 374 | .Vb 1 |
| 375 | \& my $wanted = $self->libscan($path); |
| 376 | .Ve |
| 377 | .Sp |
| 378 | Takes a path to a file or dir and returns an empty string if we don't |
| 379 | want to include this file in the library. Otherwise it returns the |
| 380 | the \f(CW$path\fR unchanged. |
| 381 | .Sp |
| 382 | Mainly used to exclude \s-1RCS\s0, \s-1CVS\s0, and \s-1SCCS\s0 directories from |
| 383 | installation. |
| 384 | .IP "tool_autosplit" 4 |
| 385 | .IX Item "tool_autosplit" |
| 386 | Defines a simple perl call that runs autosplit. May be deprecated by |
| 387 | pm_to_blib soon. |
| 388 | .IP "all_target" 4 |
| 389 | .IX Item "all_target" |
| 390 | Generate the default target 'all'. |
| 391 | .IP "metafile_target" 4 |
| 392 | .IX Item "metafile_target" |
| 393 | .Vb 1 |
| 394 | \& my $target = $mm->metafile_target; |
| 395 | .Ve |
| 396 | .Sp |
| 397 | Generate the metafile target. |
| 398 | .Sp |
| 399 | Writes the file \s-1META\s0.yml, \s-1YAML\s0 encoded meta-data about the module. The |
| 400 | format follows Module::Build's as closely as possible. Additionally, we |
| 401 | include: |
| 402 | .Sp |
| 403 | .Vb 2 |
| 404 | \& version_from |
| 405 | \& installdirs |
| 406 | .Ve |
| 407 | .IP "signature_target" 4 |
| 408 | .IX Item "signature_target" |
| 409 | .Vb 1 |
| 410 | \& my $target = $mm->signature_target; |
| 411 | .Ve |
| 412 | .Sp |
| 413 | Generate the signature target. |
| 414 | .Sp |
| 415 | Writes the file \s-1SIGNATURE\s0 with \*(L"cpansign \-s\*(R". |
| 416 | .IP "metafile_addtomanifest_target" 4 |
| 417 | .IX Item "metafile_addtomanifest_target" |
| 418 | .Vb 1 |
| 419 | \& my $target = $mm->metafile_addtomanifest_target |
| 420 | .Ve |
| 421 | .Sp |
| 422 | Adds the \s-1META\s0.yml file to the \s-1MANIFEST\s0. |
| 423 | .IP "signature_addtomanifest_target" 4 |
| 424 | .IX Item "signature_addtomanifest_target" |
| 425 | .Vb 1 |
| 426 | \& my $target = $mm->signature_addtomanifest_target |
| 427 | .Ve |
| 428 | .Sp |
| 429 | Adds the \s-1META\s0.yml file to the \s-1MANIFEST\s0. |
| 430 | .Sh "Abstract methods" |
| 431 | .IX Subsection "Abstract methods" |
| 432 | Methods which cannot be made cross-platform and each subclass will |
| 433 | have to do their own implementation. |
| 434 | .IP "oneliner" 4 |
| 435 | .IX Item "oneliner" |
| 436 | .Vb 2 |
| 437 | \& my $oneliner = $MM->oneliner($perl_code); |
| 438 | \& my $oneliner = $MM->oneliner($perl_code, \e@switches); |
| 439 | .Ve |
| 440 | .Sp |
| 441 | This will generate a perl one-liner safe for the particular platform |
| 442 | you're on based on the given \f(CW$perl_code\fR and \f(CW@switches\fR (a \-e is |
| 443 | assumed) suitable for using in a make target. It will use the proper |
| 444 | shell quoting and escapes. |
| 445 | .Sp |
| 446 | $(\s-1PERLRUN\s0) will be used as perl. |
| 447 | .Sp |
| 448 | Any newlines in \f(CW$perl_code\fR will be escaped. Leading and trailing |
| 449 | newlines will be stripped. Makes this idiom much easier: |
| 450 | .Sp |
| 451 | .Vb 4 |
| 452 | \& my $code = $MM->oneliner(<<'CODE', [...switches...]); |
| 453 | \&some code here |
| 454 | \&another line here |
| 455 | \&CODE |
| 456 | .Ve |
| 457 | .Sp |
| 458 | Usage might be something like: |
| 459 | .Sp |
| 460 | .Vb 3 |
| 461 | \& # an echo emulation |
| 462 | \& $oneliner = $MM->oneliner('print "Foo\en"'); |
| 463 | \& $make = '$oneliner > somefile'; |
| 464 | .Ve |
| 465 | .Sp |
| 466 | All dollar signs must be doubled in the \f(CW$perl_code\fR if you expect them |
| 467 | to be interpreted normally, otherwise it will be considered a make |
| 468 | macro. Also remember to quote make macros else it might be used as a |
| 469 | bareword. For example: |
| 470 | .Sp |
| 471 | .Vb 2 |
| 472 | \& # Assign the value of the $(VERSION_FROM) make macro to $vf. |
| 473 | \& $oneliner = $MM->oneliner('$$vf = "$(VERSION_FROM)"'); |
| 474 | .Ve |
| 475 | .Sp |
| 476 | Its currently very simple and may be expanded sometime in the figure |
| 477 | to include more flexible code and switches. |
| 478 | .IP "\fBquote_literal\fR" 4 |
| 479 | .IX Item "quote_literal" |
| 480 | .Vb 1 |
| 481 | \& my $safe_text = $MM->quote_literal($text); |
| 482 | .Ve |
| 483 | .Sp |
| 484 | This will quote \f(CW$text\fR so it is interpreted literally in the shell. |
| 485 | .Sp |
| 486 | For example, on Unix this would escape any single-quotes in \f(CW$text\fR and |
| 487 | put single-quotes around the whole thing. |
| 488 | .IP "\fBescape_newlines\fR" 4 |
| 489 | .IX Item "escape_newlines" |
| 490 | .Vb 1 |
| 491 | \& my $escaped_text = $MM->escape_newlines($text); |
| 492 | .Ve |
| 493 | .Sp |
| 494 | Shell escapes newlines in \f(CW$text\fR. |
| 495 | .IP "max_exec_len" 4 |
| 496 | .IX Item "max_exec_len" |
| 497 | .Vb 1 |
| 498 | \& my $max_exec_len = $MM->max_exec_len; |
| 499 | .Ve |
| 500 | .Sp |
| 501 | Calculates the maximum command size the \s-1OS\s0 can exec. Effectively, |
| 502 | this is the max size of a shell command line. |
| 503 | .IP "\fBinit_others\fR" 4 |
| 504 | .IX Item "init_others" |
| 505 | .Vb 1 |
| 506 | \& $MM->init_others(); |
| 507 | .Ve |
| 508 | .Sp |
| 509 | Initializes the macro definitions used by \fItools_other()\fR and places them |
| 510 | in the \f(CW$MM\fR object. |
| 511 | .Sp |
| 512 | If there is no description, its the same as the parameter to |
| 513 | \&\fIWriteMakefile()\fR documented in ExtUtils::MakeMaker. |
| 514 | .Sp |
| 515 | Defines at least these macros. |
| 516 | .Sp |
| 517 | .Vb 1 |
| 518 | \& Macro Description |
| 519 | .Ve |
| 520 | .Sp |
| 521 | .Vb 2 |
| 522 | \& NOOP Do nothing |
| 523 | \& NOECHO Tell make not to display the command itself |
| 524 | .Ve |
| 525 | .Sp |
| 526 | .Vb 4 |
| 527 | \& MAKEFILE |
| 528 | \& FIRST_MAKEFILE |
| 529 | \& MAKEFILE_OLD |
| 530 | \& MAKE_APERL_FILE File used by MAKE_APERL |
| 531 | .Ve |
| 532 | .Sp |
| 533 | .Vb 2 |
| 534 | \& SHELL Program used to run |
| 535 | \& shell commands |
| 536 | .Ve |
| 537 | .Sp |
| 538 | .Vb 9 |
| 539 | \& ECHO Print text adding a newline on the end |
| 540 | \& RM_F Remove a file |
| 541 | \& RM_RF Remove a directory |
| 542 | \& TOUCH Update a file's timestamp |
| 543 | \& TEST_F Test for a file's existence |
| 544 | \& CP Copy a file |
| 545 | \& MV Move a file |
| 546 | \& CHMOD Change permissions on a |
| 547 | \& file |
| 548 | .Ve |
| 549 | .Sp |
| 550 | .Vb 2 |
| 551 | \& UMASK_NULL Nullify umask |
| 552 | \& DEV_NULL Supress all command output |
| 553 | .Ve |
| 554 | .IP "init_DIRFILESEP" 4 |
| 555 | .IX Item "init_DIRFILESEP" |
| 556 | .Vb 2 |
| 557 | \& $MM->init_DIRFILESEP; |
| 558 | \& my $dirfilesep = $MM->{DIRFILESEP}; |
| 559 | .Ve |
| 560 | .Sp |
| 561 | Initializes the \s-1DIRFILESEP\s0 macro which is the seperator between the |
| 562 | directory and filename in a filepath. ie. / on Unix, \e on Win32 and |
| 563 | nothing on \s-1VMS\s0. |
| 564 | .Sp |
| 565 | For example: |
| 566 | .Sp |
| 567 | .Vb 2 |
| 568 | \& # instead of $(INST_ARCHAUTODIR)/extralibs.ld |
| 569 | \& $(INST_ARCHAUTODIR)$(DIRFILESEP)extralibs.ld |
| 570 | .Ve |
| 571 | .Sp |
| 572 | Something of a hack but it prevents a lot of code duplication between |
| 573 | MM_* variants. |
| 574 | .Sp |
| 575 | Do not use this as a seperator between directories. Some operating |
| 576 | systems use different seperators between subdirectories as between |
| 577 | directories and filenames (for example: VOLUME:[dir1.dir2]file on \s-1VMS\s0). |
| 578 | .IP "init_linker" 4 |
| 579 | .IX Item "init_linker" |
| 580 | .Vb 1 |
| 581 | \& $mm->init_linker; |
| 582 | .Ve |
| 583 | .Sp |
| 584 | Initialize macros which have to do with linking. |
| 585 | .Sp |
| 586 | \&\s-1PERL_ARCHIVE:\s0 path to libperl.a equivalent to be linked to dynamic |
| 587 | extensions. |
| 588 | .Sp |
| 589 | \&\s-1PERL_ARCHIVE_AFTER:\s0 path to a library which should be put on the |
| 590 | linker command line \fIafter\fR the external libraries to be linked to |
| 591 | dynamic extensions. This may be needed if the linker is one\-pass, and |
| 592 | Perl includes some overrides for C \s-1RTL\s0 functions, such as \fImalloc()\fR. |
| 593 | .Sp |
| 594 | \&\s-1EXPORT_LIST:\s0 name of a file that is passed to linker to define symbols |
| 595 | to be exported. |
| 596 | .Sp |
| 597 | Some OSes do not need these in which case leave it blank. |
| 598 | .IP "init_platform" 4 |
| 599 | .IX Item "init_platform" |
| 600 | .Vb 1 |
| 601 | \& $mm->init_platform |
| 602 | .Ve |
| 603 | .Sp |
| 604 | Initialize any macros which are for platform specific use only. |
| 605 | .Sp |
| 606 | A typical one is the version number of your \s-1OS\s0 specific mocule. |
| 607 | (ie. MM_Unix_VERSION or \s-1MM_VMS_VERSION\s0). |
| 608 | .IP "platform_constants" 4 |
| 609 | .IX Item "platform_constants" |
| 610 | .Vb 1 |
| 611 | \& my $make_frag = $mm->platform_constants |
| 612 | .Ve |
| 613 | .Sp |
| 614 | Returns a make fragment defining all the macros initialized in |
| 615 | \&\fIinit_platform()\fR rather than put them in \fIconstants()\fR. |
| 616 | .IP "os_flavor" 4 |
| 617 | .IX Item "os_flavor" |
| 618 | .Vb 1 |
| 619 | \& my @os_flavor = $mm->os_flavor; |
| 620 | .Ve |
| 621 | .Sp |
| 622 | @os_flavor is the style of operating system this is, usually |
| 623 | corresponding to the MM_*.pm file we're using. |
| 624 | .Sp |
| 625 | The first element of \f(CW@os_flavor\fR is the major family (ie. Unix, |
| 626 | Windows, \s-1VMS\s0, \s-1OS/2\s0, etc...) and the rest are sub families. |
| 627 | .Sp |
| 628 | Some examples: |
| 629 | .Sp |
| 630 | .Vb 6 |
| 631 | \& Cygwin98 ('Unix', 'Cygwin', 'Cygwin9x') |
| 632 | \& Windows NT ('Win32', 'WinNT') |
| 633 | \& Win98 ('Win32', 'Win9x') |
| 634 | \& Linux ('Unix', 'Linux') |
| 635 | \& MacOS X ('Unix', 'Darwin', 'MacOS', 'MacOS X') |
| 636 | \& OS/2 ('OS/2') |
| 637 | .Ve |
| 638 | .Sp |
| 639 | This is used to write code for styles of operating system. |
| 640 | See \fIos_flavor_is()\fR for use. |
| 641 | .SH "AUTHOR" |
| 642 | .IX Header "AUTHOR" |
| 643 | Michael G Schwern <schwern@pobox.com> and the denizens of |
| 644 | makemaker@perl.org with code from ExtUtils::MM_Unix and |
| 645 | ExtUtils::MM_Win32. |