Debian Codegraph @

upstream/opensuse-tumbleweed/man3/ExtUtils::MM_VMS.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::MM_VMS 3pm"
61 .TH ExtUtils::MM_VMS 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::MM_VMS \- methods to override UN*X behaviour in ExtUtils::MakeMaker
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 3
71 \& Do not use this directly.
72 \& Instead, use ExtUtils::MM and it will figure out which MM_*
73 \& class to use for you.
74 .Ve
75 .SH DESCRIPTION
76 .IX Header "DESCRIPTION"
77 See ExtUtils::MM_Unix for a documentation of the methods provided
78 there. This package overrides the implementation of these methods, not
79 the semantics.
80 .SS "Methods always loaded"
81 .IX Subsection "Methods always loaded"
82 .IP wraplist 4
83 .IX Item "wraplist"
84 Converts a list into a string wrapped at approximately 80 columns.
85 .SS Methods
86 .IX Subsection "Methods"
87 Those methods which override default MM_Unix methods are marked
88 "(override)", while methods unique to MM_VMS are marked "(specific)".
89 For overridden methods, documentation is limited to an explanation
90 of why this method overrides the MM_Unix method; see the ExtUtils::MM_Unix
91 documentation for more details.
92 .IP "guess_name (override)" 4
93 .IX Item "guess_name (override)"
94 Try to determine name of extension being built. We begin with the name
95 of the current directory. Since VMS filenames are case\-insensitive,
96 however, we look for a \fI.pm\fR file whose name matches that of the current
97 directory (presumably the \*(Aqmain\*(Aq \fI.pm\fR file for this extension), and try
98 to find a \f(CW\*(C`package\*(C'\fR statement from which to obtain the Mixed::Case
99 package name.
100 .IP "find_perl (override)" 4
101 .IX Item "find_perl (override)"
102 Use VMS file specification syntax and CLI commands to find and
103 invoke Perl images.
104 .IP "_fixin_replace_shebang (override)" 4
105 .IX Item "_fixin_replace_shebang (override)"
106 Helper routine for MM\->\fBfixin()\fR, overridden
107 because there\*(Aqs no such thing as an
108 actual shebang line that will be interpreted by the shell, so we just prepend
109 \&\f(CW$Config\fR{startperl} and preserve the shebang line argument for any switches it
110 may contain.
111 .IP "maybe_command (override)" 4
112 .IX Item "maybe_command (override)"
113 Follows VMS naming conventions for executable files.
114 If the name passed in doesn\*(Aqt exactly match an executable file,
115 appends \fI.Exe\fR (or equivalent) to check for executable image, and \fI.Com\fR
116 to check for DCL procedure. If this fails, checks directories in DCL$PATH
117 and finally \fISys$System:\fR for an executable file having the name specified,
118 with or without the \fI.Exe\fR\-equivalent suffix.
119 .IP "pasthru (override)" 4
120 .IX Item "pasthru (override)"
121 The list of macro definitions to be passed through must be specified using
122 the /MACRO qualifier and must not add another /DEFINE qualifier. We prepend
123 our own comma here to the contents of $(PASTHRU_DEFINE) because it is often
124 empty and a comma always present in CCFLAGS would generate a missing
125 qualifier value error.
126 .IP "pm_to_blib (override)" 4
127 .IX Item "pm_to_blib (override)"
128 VMS wants a dot in every file so we can\*(Aqt have one called \*(Aqpm_to_blib\*(Aq,
129 it becomes \*(Aqpm_to_blib.\*(Aq and MMS/K isn\*(Aqt smart enough to know that when
130 you have a target called \*(Aqpm_to_blib\*(Aq it should look for \*(Aqpm_to_blib.\*(Aq.
131 .Sp
132 So in VMS its pm_to_blib.ts.
133 .IP "perl_script (override)" 4
134 .IX Item "perl_script (override)"
135 If name passed in doesn\*(Aqt specify a readable file, appends \fI.com\fR or
136 \&\fI.pl\fR and tries again, since it\*(Aqs customary to have file types on all files
137 under VMS.
138 .IP replace_manpage_separator 4
139 .IX Item "replace_manpage_separator"
140 Use as separator a character which is legal in a VMS\-syntax file name.
141 .IP init_DEST 4
142 .IX Item "init_DEST"
143 (override) Because of the difficulty concatenating VMS filepaths we
144 must pre\-expand the DEST* variables.
145 .IP init_DIRFILESEP 4
146 .IX Item "init_DIRFILESEP"
147 No separator between a directory path and a filename on VMS.
148 .IP "init_main (override)" 4
149 .IX Item "init_main (override)"
150 .PD 0
151 .IP "init_tools (override)" 4
152 .IX Item "init_tools (override)"
153 .PD
154 Provide VMS\-specific forms of various utility commands.
155 .Sp
156 Sets DEV_NULL to nothing because I don\*(Aqt know how to do it on VMS.
157 .Sp
158 Changes EQUALIZE_TIMESTAMP to set revision date of target file to
159 one second later than source file, since MMK interprets precisely
160 equal revision dates for a source and target file as a sign that the
161 target needs to be updated.
162 .IP "init_platform (override)" 4
163 .IX Item "init_platform (override)"
164 Add PERL_VMS, MM_VMS_REVISION and MM_VMS_VERSION.
165 .Sp
166 MM_VMS_REVISION is for backwards compatibility before MM_VMS had a
167 \&\f(CW$VERSION\fR.
168 .IP platform_constants 4
169 .IX Item "platform_constants"
170 .PD 0
171 .IP "init_VERSION (override)" 4
172 .IX Item "init_VERSION (override)"
173 .PD
174 Override the *DEFINE_VERSION macros with VMS semantics. Translate the
175 MAKEMAKER filepath to VMS style.
176 .IP "constants (override)" 4
177 .IX Item "constants (override)"
178 Fixes up numerous file and directory macros to insure VMS syntax
179 regardless of input syntax. Also makes lists of files
180 comma\-separated.
181 .IP special_targets 4
182 .IX Item "special_targets"
183 Clear the default .SUFFIXES and put in our own list.
184 .IP "cflags (override)" 4
185 .IX Item "cflags (override)"
186 Bypass shell script and produce qualifiers for CC directly (but warn
187 user if a shell script for this extension exists). Fold multiple
188 /Defines into one, since some C compilers pay attention to only one
189 instance of this qualifier on the command line.
190 .IP "const_cccmd (override)" 4
191 .IX Item "const_cccmd (override)"
192 Adds directives to point C preprocessor to the right place when
193 handling #include <sys/foo.h> directives. Also constructs CC
194 command line a bit differently than MM_Unix method.
195 .IP "tools_other (override)" 4
196 .IX Item "tools_other (override)"
197 Throw in some dubious extra macros for Makefile args.
198 .Sp
199 Also keep around the old $(SAY) macro in case somebody\*(Aqs using it.
200 .IP "init_dist (override)" 4
201 .IX Item "init_dist (override)"
202 VMSish defaults for some values.
203 .Sp
204 .Vb 1
205 \& macro description default
206 \&
207 \& ZIPFLAGS flags to pass to ZIP \-Vu
208 \&
209 \& COMPRESS compression command to gzip
210 \& use for tarfiles
211 \& SUFFIX suffix to put on \-gz
212 \& compressed files
213 \&
214 \& SHAR shar command to use vms_share
215 \&
216 \& DIST_DEFAULT default target to use to tardist
217 \& create a distribution
218 \&
219 \& DISTVNAME Use VERSION_SYM instead of $(DISTNAME)\-$(VERSION_SYM)
220 \& VERSION for the name
221 .Ve
222 .IP "c_o (override)" 4
223 .IX Item "c_o (override)"
224 Use VMS syntax on command line. In particular, $(DEFINE) and
225 $(PERL_INC) have been pulled into $(CCCMD). Also use MM[SK] macros.
226 .IP "xs_c (override)" 4
227 .IX Item "xs_c (override)"
228 Use MM[SK] macros.
229 .IP "xs_o (override)" 4
230 .IX Item "xs_o (override)"
231 Use MM[SK] macros, and VMS command line for C compiler.
232 .IP "_xsbuild_replace_macro (override)" 4
233 .IX Item "_xsbuild_replace_macro (override)"
234 There is no simple replacement possible since a qualifier and all its
235 subqualifiers must be considered together, so we use our own utility
236 routine for the replacement.
237 .IP "_xsbuild_value (override)" 4
238 .IX Item "_xsbuild_value (override)"
239 Convert the extension spec to Unix format, as that\*(Aqs what will
240 match what\*(Aqs in the XSBUILD data structure.
241 .IP "dlsyms (override)" 4
242 .IX Item "dlsyms (override)"
243 Create VMS linker options files specifying universal symbols for this
244 extension\*(Aqs shareable image(s), and listing other shareable images or
245 libraries to which it should be linked.
246 .IP xs_obj_opt 4
247 .IX Item "xs_obj_opt"
248 Override to fixup \-o flags.
249 .IP "dynamic_lib (override)" 4
250 .IX Item "dynamic_lib (override)"
251 Use VMS Link command.
252 .IP "xs_make_static_lib (override)" 4
253 .IX Item "xs_make_static_lib (override)"
254 Use VMS commands to manipulate object library.
255 .IP "static_lib_pure_cmd (override)" 4
256 .IX Item "static_lib_pure_cmd (override)"
257 Use VMS commands to manipulate object library.
258 .IP xs_static_lib_is_xs 4
259 .IX Item "xs_static_lib_is_xs"
260 .PD 0
261 .IP extra_clean_files 4
262 .IX Item "extra_clean_files"
263 .PD
264 Clean up some OS specific files. Plus the temp file used to shorten
265 a lot of commands. And the name mangler database.
266 .IP zipfile_target 4
267 .IX Item "zipfile_target"
268 .PD 0
269 .IP tarfile_target 4
270 .IX Item "tarfile_target"
271 .IP shdist_target 4
272 .IX Item "shdist_target"
273 .PD
274 Syntax for invoking shar, tar and zip differs from that for Unix.
275 .IP "install (override)" 4
276 .IX Item "install (override)"
277 Work around DCL\*(Aqs 255 character limit several times,and use
278 VMS\-style command line quoting in a few cases.
279 .IP "perldepend (override)" 4
280 .IX Item "perldepend (override)"
281 Use VMS\-style syntax for files; it\*(Aqs cheaper to just do it directly here
282 than to have the MM_Unix method call \f(CW\*(C`catfile\*(C'\fR
283 repeatedly. Also, if we have to rebuild Config.pm, use MM[SK] to do it.
284 .IP "makeaperl (override)" 4
285 .IX Item "makeaperl (override)"
286 Undertake to build a new set of Perl images using VMS commands. Since
287 VMS does dynamic loading, it\*(Aqs not necessary to statically link each
288 extension into the Perl image, so this isn\*(Aqt the normal build path.
289 Consequently, it hasn\*(Aqt really been tested, and may well be incomplete.
290 .IP "maketext_filter (override)" 4
291 .IX Item "maketext_filter (override)"
292 Ensure that colons marking targets are preceded by space, in order
293 to distinguish the target delimiter from a colon appearing as
294 part of a filespec.
295 .IP "prefixify (override)" 4
296 .IX Item "prefixify (override)"
297 prefixifying on VMS is simple. Each should simply be:
298 .Sp
299 .Vb 1
300 \& perl_root:[some.dir]
301 .Ve
302 .Sp
303 which can just be converted to:
304 .Sp
305 .Vb 1
306 \& volume:[your.prefix.some.dir]
307 .Ve
308 .Sp
309 otherwise you get the default layout.
310 .Sp
311 In effect, your search prefix is ignored and \f(CW$Config\fR{vms_prefix} is
312 used instead.
313 .IP cd 4
314 .IX Item "cd"
315 .PD 0
316 .IP oneliner 4
317 .IX Item "oneliner"
318 .IP \fBecho\fR 4
319 .IX Item "echo"
320 .PD
321 perl trips up on "<foo>" thinking it\*(Aqs an input redirect. So we use the
322 native Write command instead. Besides, it\*(Aqs faster.
323 .IP quote_literal 4
324 .IX Item "quote_literal"
325 .PD 0
326 .IP escape_dollarsigns 4
327 .IX Item "escape_dollarsigns"
328 .PD
329 Quote, don\*(Aqt escape.
330 .IP escape_all_dollarsigns 4
331 .IX Item "escape_all_dollarsigns"
332 Quote, don\*(Aqt escape.
333 .IP escape_newlines 4
334 .IX Item "escape_newlines"
335 .PD 0
336 .IP max_exec_len 4
337 .IX Item "max_exec_len"
338 .PD
339 256 characters.
340 .IP init_linker 4
341 .IX Item "init_linker"
342 .PD 0
343 .IP "catdir (override)" 4
344 .IX Item "catdir (override)"
345 .IP "catfile (override)" 4
346 .IX Item "catfile (override)"
347 .PD
348 Eliminate the macros in the output to the MMS/MMK file.
349 .Sp
350 (File::Spec::VMS used to do this for us, but it\*(Aqs being removed)
351 .IP eliminate_macros 4
352 .IX Item "eliminate_macros"
353 Expands MM[KS]/Make macros in a text string, using the contents of
354 identically named elements of \f(CW%$self\fR, and returns the result
355 as a file specification in Unix syntax.
356 .Sp
357 NOTE: This is the canonical version of the method. The version in
358 File::Spec::VMS is deprecated.
359 .IP fixpath 4
360 .IX Item "fixpath"
361 .Vb 2
362 \& my $path = $mm\->fixpath($path);
363 \& my $path = $mm\->fixpath($path, $is_dir);
364 .Ve
365 .Sp
366 Catchall routine to clean up problem MM[SK]/Make macros. Expands macros
367 in any directory specification, in order to avoid juxtaposing two
368 VMS\-syntax directories when MM[SK] is run. Also expands expressions which
369 are all macro, so that we can tell how long the expansion is, and avoid
370 overrunning DCL\*(Aqs command buffer when MM[KS] is running.
371 .Sp
372 \&\fBfixpath()\fR checks to see whether the result matches the name of a
373 directory in the current default directory and returns a directory or
374 file specification accordingly. \f(CW$is_dir\fR can be set to true to
375 force \fBfixpath()\fR to consider the path to be a directory or false to force
376 it to be a file.
377 .Sp
378 NOTE: This is the canonical version of the method. The version in
379 File::Spec::VMS is deprecated.
380 .IP os_flavor 4
381 .IX Item "os_flavor"
382 VMS is VMS.
383 .IP "is_make_type (override)" 4
384 .IX Item "is_make_type (override)"
385 None of the make types being checked for is viable on VMS,
386 plus our \f(CW$self\fR\->{MAKE} is an unexpanded (and unexpandable)
387 macro whose value is known only to the make utility itself.
388 .IP "make_type (override)" 4
389 .IX Item "make_type (override)"
390 Returns a suitable string describing the type of makefile being written.
391 .SH AUTHOR
392 .IX Header "AUTHOR"
393 Original author Charles Bailey \[email protected]\fR
394 .PP
395 Maintained by Michael G Schwern \[email protected]\fR
396 .PP
397 See ExtUtils::MakeMaker for patching and contact information.