Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / File::Spec::VMS.3
CommitLineData
86530b38
AT
1.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v
15.if n .sp
16..
17.de Vb \" Begin verbatim text
18.ft CW
19.nf
20.ne \\$1
21..
22.de Ve \" End verbatim text
23.ft R
24.fi
25..
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
43'br\}
44.el\{\
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
49'br\}
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
58..
59. nr % 0
60. rr F
61.\}
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
71.if n \{\
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
77.\}
78.if t \{\
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
84.\}
85. \" simple accents for nroff and troff
86.if n \{\
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
93.\}
94.if t \{\
95. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101.\}
102. \" troff and (daisy-wheel) nroff accents
103.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110.ds ae a\h'-(\w'a'u*4/10)'e
111.ds Ae A\h'-(\w'A'u*4/10)'E
112. \" corrections for vroff
113.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115. \" for low resolution devices (crt and lpr)
116.if \n(.H>23 .if \n(.V>19 \
117\{\
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
127.\}
128.rm #[ #] #H #V #F C
129.\" ========================================================================
130.\"
131.IX Title "File::Spec::VMS 3"
132.TH File::Spec::VMS 3 "2002-06-01" "perl v5.8.0" "Perl Programmers Reference Guide"
133.SH "NAME"
134File::Spec::VMS \- methods for VMS file specs
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137.Vb 1
138\& require File::Spec::VMS; # Done internally by File::Spec if needed
139.Ve
140.SH "DESCRIPTION"
141.IX Header "DESCRIPTION"
142See File::Spec::Unix for a documentation of the methods provided
143there. This package overrides the implementation of these methods, not
144the semantics.
145.IP "eliminate_macros" 4
146.IX Item "eliminate_macros"
147Expands MM[\s-1KS\s0]/Make macros in a text string, using the contents of
148identically named elements of \f(CW%$self\fR, and returns the result
149as a file specification in Unix syntax.
150.IP "fixpath" 4
151.IX Item "fixpath"
152Catchall routine to clean up problem MM[\s-1SK\s0]/Make macros. Expands macros
153in any directory specification, in order to avoid juxtaposing two
154VMS-syntax directories when MM[\s-1SK\s0] is run. Also expands expressions which
155are all macro, so that we can tell how long the expansion is, and avoid
156overrunning \s-1DCL\s0's command buffer when MM[\s-1KS\s0] is running.
157.Sp
158If optional second argument has a \s-1TRUE\s0 value, then the return string is
159a VMS-syntax directory specification, if it is \s-1FALSE\s0, the return string
160is a VMS-syntax file specification, and if it is not specified, \fIfixpath()\fR
161checks to see whether it matches the name of a directory in the current
162default directory, and returns a directory or file specification accordingly.
163.Sh "Methods always loaded"
164.IX Subsection "Methods always loaded"
165.IP "canonpath (override)" 4
166.IX Item "canonpath (override)"
167Removes redundant portions of file specifications according to \s-1VMS\s0 syntax.
168.IP "catdir" 4
169.IX Item "catdir"
170Concatenates a list of file specifications, and returns the result as a
171VMS-syntax directory specification. No check is made for \*(L"impossible\*(R"
172cases (e.g. elements other than the first being absolute filespecs).
173.IP "catfile" 4
174.IX Item "catfile"
175Concatenates a list of file specifications, and returns the result as a
176VMS-syntax file specification.
177.IP "curdir (override)" 4
178.IX Item "curdir (override)"
179Returns a string representation of the current directory: '[]'
180.IP "devnull (override)" 4
181.IX Item "devnull (override)"
182Returns a string representation of the null device: '_NLA0:'
183.IP "rootdir (override)" 4
184.IX Item "rootdir (override)"
185Returns a string representation of the root directory: 'SYS$DISK:[000000]'
186.IP "tmpdir (override)" 4
187.IX Item "tmpdir (override)"
188Returns a string representation of the first writable directory
189from the following list or '' if none are writable:
190.Sp
191.Vb 2
192\& sys$scratch:
193\& $ENV{TMPDIR}
194.Ve
195.Sp
196Since perl 5.8.0, if running under taint mode, and if \f(CW$ENV\fR{\s-1TMPDIR\s0}
197is tainted, it is not used.
198.IP "updir (override)" 4
199.IX Item "updir (override)"
200Returns a string representation of the parent directory: '[\-]'
201.IP "case_tolerant (override)" 4
202.IX Item "case_tolerant (override)"
203\&\s-1VMS\s0 file specification syntax is case\-tolerant.
204.IP "path (override)" 4
205.IX Item "path (override)"
206Translate logical name \s-1DCL$PATH\s0 as a searchlist, rather than trying
207to \f(CW\*(C`split\*(C'\fR string value of \f(CW$ENV{'PATH'}\fR.
208.IP "file_name_is_absolute (override)" 4
209.IX Item "file_name_is_absolute (override)"
210Checks for \s-1VMS\s0 directory spec as well as Unix separators.
211.IP "splitpath (override)" 4
212.IX Item "splitpath (override)"
213Splits using \s-1VMS\s0 syntax.
214.IP "splitdir (override)" 4
215.IX Item "splitdir (override)"
216Split dirspec using \s-1VMS\s0 syntax.
217.IP "catpath (override)" 4
218.IX Item "catpath (override)"
219Construct a complete filespec using \s-1VMS\s0 syntax
220.IP "abs2rel (override)" 4
221.IX Item "abs2rel (override)"
222Use \s-1VMS\s0 syntax when converting filespecs.
223.IP "rel2abs (override)" 4
224.IX Item "rel2abs (override)"
225Use \s-1VMS\s0 syntax when converting filespecs.
226.SH "SEE ALSO"
227.IX Header "SEE ALSO"
228File::Spec