Debian Codegraph @

upstream/opensuse-tumbleweed/man3/ExtUtils::Command::MM.3pm

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