Debian Codegraph @

upstream/debian-unstable/man3/ExtUtils::MM_VMS.3perl

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