| 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::Command::MM 3perl" |
| 58 |
.TH ExtUtils::Command::MM 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::Command::MM \- Commands for the MM's to use in Makefiles |
| 65 |
.SH SYNOPSIS |
| 66 |
.IX Header "SYNOPSIS" |
| 67 |
.Vb 1 |
| 68 |
\& perl "\-MExtUtils::Command::MM" \-e "function" "\-\-" arguments... |
| 69 |
.Ve |
| 70 |
.SH DESCRIPTION |
| 71 |
.IX Header "DESCRIPTION" |
| 72 |
\&\fBFOR INTERNAL USE ONLY!\fR The interface is not stable. |
| 73 |
.PP |
| 74 |
ExtUtils::Command::MM encapsulates code which would otherwise have to |
| 75 |
be done with large "one" liners. |
| 76 |
.PP |
| 77 |
Any $(FOO) used in the examples are make variables, not Perl. |
| 78 |
.IP \fBtest_harness\fR 4 |
| 79 |
.IX Item "test_harness" |
| 80 |
.Vb 1 |
| 81 |
\& test_harness($verbose, @test_libs); |
| 82 |
.Ve |
| 83 |
.Sp |
| 84 |
Runs the tests on \f(CW@ARGV\fR via Test::Harness passing through the \f(CW$verbose\fR |
| 85 |
flag. Any \f(CW@test_libs\fR will be unshifted onto the test's \f(CW@INC\fR. |
| 86 |
.Sp |
| 87 |
\&\f(CW@test_libs\fR are run in alphabetical order. |
| 88 |
.IP \fBpod2man\fR 4 |
| 89 |
.IX Item "pod2man" |
| 90 |
.Vb 5 |
| 91 |
\& pod2man( \*(Aq\-\-option=value\*(Aq, |
| 92 |
\& $podfile1 => $manpage1, |
| 93 |
\& $podfile2 => $manpage2, |
| 94 |
\& ... |
| 95 |
\& ); |
| 96 |
\& |
| 97 |
\& # or args on @ARGV |
| 98 |
.Ve |
| 99 |
.Sp |
| 100 |
\&\fBpod2man()\fR is a function performing most of the duties of the pod2man |
| 101 |
program. Its arguments are exactly the same as pod2man as of 5.8.0 |
| 102 |
with the addition of: |
| 103 |
.Sp |
| 104 |
.Vb 1 |
| 105 |
\& \-\-perm_rw octal permission to set the resulting manpage to |
| 106 |
.Ve |
| 107 |
.Sp |
| 108 |
And the removal of: |
| 109 |
.Sp |
| 110 |
.Vb 2 |
| 111 |
\& \-\-verbose/\-v |
| 112 |
\& \-\-help/\-h |
| 113 |
.Ve |
| 114 |
.Sp |
| 115 |
If no arguments are given to pod2man it will read from \f(CW@ARGV\fR. |
| 116 |
.Sp |
| 117 |
If Pod::Man is unavailable, this function will warn and return undef. |
| 118 |
.IP \fBwarn_if_old_packlist\fR 4 |
| 119 |
.IX Item "warn_if_old_packlist" |
| 120 |
.Vb 1 |
| 121 |
\& perl "\-MExtUtils::Command::MM" \-e warn_if_old_packlist <somefile> |
| 122 |
.Ve |
| 123 |
.Sp |
| 124 |
Displays a warning that an old packlist file was found. Reads the |
| 125 |
filename from \f(CW@ARGV\fR. |
| 126 |
.IP \fBperllocal_install\fR 4 |
| 127 |
.IX Item "perllocal_install" |
| 128 |
.Vb 2 |
| 129 |
\& perl "\-MExtUtils::Command::MM" \-e perllocal_install |
| 130 |
\& <type> <module name> <key> <value> ... |
| 131 |
\& |
| 132 |
\& # VMS only, key|value pairs come on STDIN |
| 133 |
\& perl "\-MExtUtils::Command::MM" \-e perllocal_install |
| 134 |
\& <type> <module name> < <key>|<value> ... |
| 135 |
.Ve |
| 136 |
.Sp |
| 137 |
Prints a fragment of POD suitable for appending to perllocal.pod. |
| 138 |
Arguments are read from \f(CW@ARGV\fR. |
| 139 |
.Sp |
| 140 |
\&'type' is the type of what you're installing. Usually 'Module'. |
| 141 |
.Sp |
| 142 |
\&'module name' is simply the name of your module. (Foo::Bar) |
| 143 |
.Sp |
| 144 |
Key/value pairs are extra information about the module. Fields include: |
| 145 |
.Sp |
| 146 |
.Vb 5 |
| 147 |
\& installed into which directory your module was out into |
| 148 |
\& LINKTYPE dynamic or static linking |
| 149 |
\& VERSION module version number |
| 150 |
\& EXE_FILES any executables installed in a space separated |
| 151 |
\& list |
| 152 |
.Ve |
| 153 |
.IP \fBuninstall\fR 4 |
| 154 |
.IX Item "uninstall" |
| 155 |
.Vb 1 |
| 156 |
\& perl "\-MExtUtils::Command::MM" \-e uninstall <packlist> |
| 157 |
.Ve |
| 158 |
.Sp |
| 159 |
A wrapper around \fBExtUtils::Install::uninstall()\fR. Warns that |
| 160 |
uninstallation is deprecated and doesn't actually perform the |
| 161 |
uninstallation. |
| 162 |
.IP \fBtest_s\fR 4 |
| 163 |
.IX Item "test_s" |
| 164 |
.Vb 1 |
| 165 |
\& perl "\-MExtUtils::Command::MM" \-e test_s <file> |
| 166 |
.Ve |
| 167 |
.Sp |
| 168 |
Tests if a file exists and is not empty (size > 0). |
| 169 |
\&\fIExits\fR with 0 if it does, 1 if it does not. |
| 170 |
.IP \fBcp_nonempty\fR 4 |
| 171 |
.IX Item "cp_nonempty" |
| 172 |
.Vb 1 |
| 173 |
\& perl "\-MExtUtils::Command::MM" \-e cp_nonempty <srcfile> <dstfile> <perm> |
| 174 |
.Ve |
| 175 |
.Sp |
| 176 |
Tests if the source file exists and is not empty (size > 0). If it is not empty |
| 177 |
it copies it to the given destination with the given permissions. |