Debian Codegraph @

upstream/opensuse-tumbleweed/man3/File::Spec::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 "File::Spec::VMS 3pm"
61 .TH File::Spec::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 File::Spec::VMS \- methods for VMS file specs
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& require File::Spec::VMS; # Done internally by File::Spec if needed
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 See File::Spec::Unix for a documentation of the methods provided
76 there. This package overrides the implementation of these methods, not
77 the semantics.
78 .PP
79 The default behavior is to allow either VMS or Unix syntax on input and to
80 return VMS syntax on output unless Unix syntax has been explicitly requested
81 via the \f(CW\*(C`DECC$FILENAME_UNIX_REPORT\*(C'\fR CRTL feature.
82 .IP "canonpath (override)" 4
83 .IX Item "canonpath (override)"
84 Removes redundant portions of file specifications and returns results
85 in native syntax unless Unix filename reporting has been enabled.
86 .IP "catdir (override)" 4
87 .IX Item "catdir (override)"
88 Concatenates a list of file specifications, and returns the result as a
89 native directory specification unless the Unix filename reporting feature
90 has been enabled. No check is made for "impossible" cases (e.g. elements
91 other than the first being absolute filespecs).
92 .IP "catfile (override)" 4
93 .IX Item "catfile (override)"
94 Concatenates a list of directory specifications with a filename specification
95 to build a path.
96 .IP "curdir (override)" 4
97 .IX Item "curdir (override)"
98 Returns a string representation of the current directory: \*(Aq[]\*(Aq or \*(Aq.\*(Aq
99 .IP "devnull (override)" 4
100 .IX Item "devnull (override)"
101 Returns a string representation of the null device: \*(Aq_NLA0:\*(Aq or \*(Aq/dev/null\*(Aq
102 .IP "rootdir (override)" 4
103 .IX Item "rootdir (override)"
104 Returns a string representation of the root directory: \*(AqSYS$DISK:[000000]\*(Aq
105 or \*(Aq/\*(Aq
106 .IP "tmpdir (override)" 4
107 .IX Item "tmpdir (override)"
108 Returns a string representation of the first writable directory
109 from the following list or \*(Aq\*(Aq if none are writable:
110 .Sp
111 .Vb 3
112 \& /tmp if C<DECC$FILENAME_UNIX_REPORT> is enabled.
113 \& sys$scratch:
114 \& $ENV{TMPDIR}
115 .Ve
116 .Sp
117 If running under taint mode, and if \f(CW$ENV\fR{TMPDIR}
118 is tainted, it is not used.
119 .IP "updir (override)" 4
120 .IX Item "updir (override)"
121 Returns a string representation of the parent directory: \*(Aq[\-]\*(Aq or \*(Aq..\*(Aq
122 .IP "case_tolerant (override)" 4
123 .IX Item "case_tolerant (override)"
124 VMS file specification syntax is case\-tolerant.
125 .IP "path (override)" 4
126 .IX Item "path (override)"
127 Translate logical name DCL$PATH as a searchlist, rather than trying
128 to \f(CW\*(C`split\*(C'\fR string value of \f(CW$ENV{\*(AqPATH\*(Aq}\fR.
129 .IP "file_name_is_absolute (override)" 4
130 .IX Item "file_name_is_absolute (override)"
131 Checks for VMS directory spec as well as Unix separators.
132 .IP "splitpath (override)" 4
133 .IX Item "splitpath (override)"
134 .Vb 3
135 \& ($volume,$directories,$file) = File::Spec\->splitpath( $path );
136 \& ($volume,$directories,$file) = File::Spec\->splitpath( $path,
137 \& $no_file );
138 .Ve
139 .Sp
140 Passing a true value for \f(CW$no_file\fR indicates that the path being
141 split only contains directory components, even on systems where you
142 can usually (when not supporting a foreign syntax) tell the difference
143 between directories and files at a glance.
144 .IP "splitdir (override)" 4
145 .IX Item "splitdir (override)"
146 Split a directory specification into the components.
147 .IP "catpath (override)" 4
148 .IX Item "catpath (override)"
149 Construct a complete filespec.
150 .IP "abs2rel (override)" 4
151 .IX Item "abs2rel (override)"
152 Attempt to convert an absolute file specification to a relative specification.
153 .IP "rel2abs (override)" 4
154 .IX Item "rel2abs (override)"
155 Return an absolute file specification from a relative one.
156 .SH COPYRIGHT
157 .IX Header "COPYRIGHT"
158 Copyright (c) 2004\-14 by the Perl 5 Porters. All rights reserved.
159 .PP
160 This program is free software; you can redistribute it and/or modify
161 it under the same terms as Perl itself.
162 .SH "SEE ALSO"
163 .IX Header "SEE ALSO"
164 See File::Spec and File::Spec::Unix. This package overrides the
165 implementation of these methods, not the semantics.
166 .PP
167 An explanation of VMS file specs can be found at
168 <http://h71000.www7.hp.com/doc/731FINAL/4506/4506pro_014.html#apps_locating_naming_files>.