8 my %module = (MacOS => 'Mac',
14 my $module = $module{$^O} || 'Unix';
15 require "File/Spec/$module.pm";
16 @ISA = ("File::Spec::$module");
24 File::Spec - portably perform operations on file names
30 $x=File::Spec->catfile('a', 'b', 'c');
32 which returns 'a/b/c' under Unix. Or:
34 use File::Spec::Functions;
36 $x = catfile('a', 'b', 'c');
40 This module is designed to support operations commonly performed on file
41 specifications (usually called "file names", but not to be confused with the
42 contents of a file, or Perl's file handles), such as concatenating several
43 directory and file names into a single path, or determining whether a path
44 is rooted. It is based on code directly taken from MakeMaker 5.17, code
45 written by Andreas KE<ouml>nig, Andy Dougherty, Charles Bailey, Ilya
46 Zakharevich, Paul Schinder, and others.
48 Since these functions are different for most operating systems, each set of
49 OS specific routines is available in a separate module, including:
57 The module appropriate for the current OS is automatically loaded by
58 File::Spec. Since some modules (like VMS) make use of facilities available
59 only under that OS, it may not be possible to load all modules under all
62 Since File::Spec is object oriented, subroutines should not be called directly,
65 File::Spec::catfile('a','b');
67 but rather as class methods:
69 File::Spec->catfile('a','b');
71 For simple uses, L<File::Spec::Functions> provides convenient functional
72 forms of these methods.
80 No physical check on the filesystem, but a logical cleanup of a
83 $cpath = File::Spec->canonpath( $path ) ;
87 Concatenate two or more directory names to form a complete path ending
88 with a directory. But remove the trailing slash from the resulting
89 string, because it doesn't look good, isn't necessary and confuses
90 OS2. Of course, if this is the root directory, don't cut off the
93 $path = File::Spec->catdir( @directories );
97 Concatenate one or more directory names and a filename to form a
98 complete path ending with a filename
100 $path = File::Spec->catfile( @directories, $filename );
104 Returns a string representation of the current directory.
106 $curdir = File::Spec->curdir();
110 Returns a string representation of the null device.
112 $devnull = File::Spec->devnull();
116 Returns a string representation of the root directory.
118 $rootdir = File::Spec->rootdir();
122 Returns a string representation of the first writable directory from a
123 list of possible temporary directories. Returns "" if no writable
124 temporary directories are found. The list of directories checked
125 depends on the platform; e.g. File::Spec::Unix checks $ENV{TMPDIR} and
128 $tmpdir = File::Spec->tmpdir();
132 Returns a string representation of the parent directory.
134 $updir = File::Spec->updir();
138 Given a list of file names, strip out those that refer to a parent
139 directory. (Does not strip symlinks, only '.', '..', and equivalents.)
141 @paths = File::Spec->no_upwards( @paths );
145 Returns a true or false value indicating, respectively, that alphabetic
146 is not or is significant when comparing file specifications.
148 $is_case_tolerant = File::Spec->case_tolerant();
150 =item file_name_is_absolute
152 Takes as argument a path and returns true if it is an absolute path.
154 $is_absolute = File::Spec->file_name_is_absolute( $path );
156 This does not consult the local filesystem on Unix, Win32, OS/2, or
157 Mac OS (Classic). It does consult the working environment for VMS
158 (see L<File::Spec::VMS/file_name_is_absolute>).
162 Takes no argument, returns the environment variable PATH as an array.
164 @PATH = File::Spec->path();
168 join is the same as catfile.
172 Splits a path in to volume, directory, and filename portions. On systems
173 with no concept of volume, returns undef for volume.
175 ($volume,$directories,$file) = File::Spec->splitpath( $path );
176 ($volume,$directories,$file) = File::Spec->splitpath( $path, $no_file );
178 For systems with no syntax differentiating filenames from directories,
179 assumes that the last file is a path unless $no_file is true or a
180 trailing separator or /. or /.. is present. On Unix this means that $no_file
181 true makes this return ( '', $path, '' ).
183 The directory portion may or may not be returned with a trailing '/'.
185 The results can be passed to L</catpath()> to get back a path equivalent to
186 (usually identical to) the original path.
190 The opposite of L</catdir()>.
192 @dirs = File::Spec->splitdir( $directories );
194 $directories must be only the directory portion of the path on systems
195 that have the concept of a volume or that have path syntax that differentiates
196 files from directories.
198 Unlike just splitting the directories on the separator, empty
199 directory names (C<''>) can be returned, because these are significant
204 Takes volume, directory and file portions and returns an entire path. Under
205 Unix, $volume is ignored, and directory and file are catenated. A '/' is
206 inserted if need be. On other OSs, $volume is significant.
208 $full_path = File::Spec->catpath( $volume, $directory, $file );
212 Takes a destination path and an optional base path returns a relative path
213 from the base path to the destination path:
215 $rel_path = File::Spec->abs2rel( $path ) ;
216 $rel_path = File::Spec->abs2rel( $path, $base ) ;
218 If $base is not present or '', then L<cwd()|Cwd> is used. If $base is relative,
219 then it is converted to absolute form using L</rel2abs()>. This means that it
220 is taken to be relative to L<cwd()|Cwd>.
222 On systems with the concept of a volume, this assumes that both paths
223 are on the $destination volume, and ignores the $base volume.
225 On systems that have a grammar that indicates filenames, this ignores the
226 $base filename as well. Otherwise all path components are assumed to be
229 If $path is relative, it is converted to absolute form using L</rel2abs()>.
230 This means that it is taken to be relative to L<cwd()|Cwd>.
232 No checks against the filesystem are made. On VMS, there is
233 interaction with the working environment, as logicals and
236 Based on code written by Shigio Yamaguchi.
240 Converts a relative path to an absolute path.
242 $abs_path = File::Spec->rel2abs( $path ) ;
243 $abs_path = File::Spec->rel2abs( $path, $base ) ;
245 If $base is not present or '', then L<cwd()|Cwd> is used. If $base is relative,
246 then it is converted to absolute form using L</rel2abs()>. This means that it
247 is taken to be relative to L<cwd()|Cwd>.
249 On systems with the concept of a volume, this assumes that both paths
250 are on the $base volume, and ignores the $path volume.
252 On systems that have a grammar that indicates filenames, this ignores the
253 $base filename as well. Otherwise all path components are assumed to be
256 If $path is absolute, it is cleaned up and returned using L</canonpath()>.
258 No checks against the filesystem are made. On VMS, there is
259 interaction with the working environment, as logicals and
262 Based on code written by Shigio Yamaguchi.
266 For further information, please see L<File::Spec::Unix>,
267 L<File::Spec::Mac>, L<File::Spec::OS2>, L<File::Spec::Win32>, or
272 L<File::Spec::Unix>, L<File::Spec::Mac>, L<File::Spec::OS2>,
273 L<File::Spec::Win32>, L<File::Spec::VMS>, L<File::Spec::Functions>,
274 L<ExtUtils::MakeMaker>
278 Kenneth Albanowski <kjahds@kjahds.com>, Andy Dougherty
279 <doughera@lafcol.lafayette.edu>, Andreas KE<ouml>nig
280 <A.Koenig@franz.ww.TU-Berlin.DE>, Tim Bunce <Tim.Bunce@ig.co.uk.
281 VMS support by Charles Bailey <bailey@newman.upenn.edu>.
282 OS/2 support by Ilya Zakharevich <ilya@math.ohio-state.edu>.
283 Mac support by Paul Schinder <schinder@pobox.com>, and Thomas Wegner
284 <wegner_thomas@yahoo.com>. abs2rel() and rel2abs() written by Shigio
285 Yamaguchi <shigio@tamacom.com>, modified by Barrie Slaymaker
286 <barries@slaysys.com>. splitpath(), splitdir(), catpath() and
287 catdir() by Barrie Slaymaker.