Debian Codegraph @

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