1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "File::Spec::Functions 3pm"
.TH File::Spec::Functions 3pm 2023-11-28 "perl v5.38.2" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
File::Spec::Functions \- portably perform operations on file names
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\& use File::Spec::Functions;
\& $x = catfile(\*(Aqa\*(Aq,\*(Aqb\*(Aq);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module exports convenience functions for all of the class methods
provided by File::Spec.
.PP
For a reference of available functions, please consult File::Spec::Unix,
which contains the entire set, and which is inherited by the modules for
other platforms. For further information, please see File::Spec::Mac,
File::Spec::OS2, File::Spec::Win32, or File::Spec::VMS.
.SS Exports
.IX Subsection "Exports"
The following functions are exported by default.
.PP
.Vb 9
\& canonpath
\& catdir
\& catfile
\& curdir
\& rootdir
\& updir
\& no_upwards
\& file_name_is_absolute
\& path
.Ve
.PP
The following functions are exported only by request.
.PP
.Vb 8
\& devnull
\& tmpdir
\& splitpath
\& splitdir
\& catpath
\& abs2rel
\& rel2abs
\& case_tolerant
.Ve
.PP
All the functions may be imported using the \f(CW\*(C`:ALL\*(C'\fR tag.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2004 by the Perl 5 Porters. All rights reserved.
.PP
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
File::Spec, File::Spec::Unix, File::Spec::Mac, File::Spec::OS2,
File::Spec::Win32, File::Spec::VMS, ExtUtils::MakeMaker
|