Next: File::Spec::VMS | Previous: File::Spec::OS2 | [Table of Contents] | [Index] |
File::Spec::Unix - methods used by File::Spec
require File::Spec::Unix; # Done automatically by File::Spec
Methods for manipulating file specifications.
$cpath = File::Spec->canonpath( $path ) ;
$ENV{TMPDIR} /tmp
This does not consult the local filesystem on Unix, Win32, or OS/2. It does sometimes on MacOS (see the file_name_is_absolute entry in the File::Spec::MacOS manpage). It does consult the working environment for VMS (see the file_name_is_absolute entry in the File::Spec::VMS manpage).
($volume,$directories,$file) = File::Spec->splitpath( $path ); ($volume,$directories,$file) = File::Spec->splitpath( $path, $no_file );Splits a path in to volume, directory, and filename portions. On systems with no concept of volume, returns undef for volume.
For systems with no syntax differentiating filenames from directories, assumes that the last file is a path unless $no_file is true or a trailing separator or /. or /.. is present. On Unix this means that $no_file true makes this return ( '', $path, '' ).
The directory portion may or may not be returned with a trailing '/'.
The results can be passed to the catpath() entry elsewhere in this document to get back a path equivalent to (usually identical to) the original path.
@dirs = File::Spec->splitdir( $directories );
$directories must be only the directory portion of the path on systems that have the concept of a volume or that have path syntax that differentiates files from directories.
Unlike just splitting the directories on the separator, empty
directory names (''
) can be returned, because these are significant
on some OSs (e.g. MacOS).
On Unix, File::Spec->splitdir( "/a/b//c/" );
Yields: ( '', 'a', 'b', '', 'c', '' )
$rel_path = File::Spec->abs2rel( $path ) ; $rel_path = File::Spec->abs2rel( $path, $base ) ;
If $base is not present or '', then the cwd() manpage is used. If $base is relative, then it is converted to absolute form using the rel2abs() entry elsewhere in this document. This means that it is taken to be relative to the cwd() manpage.
On systems with the concept of a volume, this assumes that both paths are on the $destination volume, and ignores the $base volume.
On systems that have a grammar that indicates filenames, this ignores the $base filename as well. Otherwise all path components are assumed to be directories.
If $path is relative, it is converted to absolute form using the rel2abs() entry elsewhere in this document. This means that it is taken to be relative to the cwd() manpage.
No checks against the filesystem are made on most systems. On MacOS, the filesystem may be consulted (see the file_name_is_absolute entry in the File::Spec::MacOS manpage). On VMS, there is interaction with the working environment, as logicals and macros are expanded.
Based on code written by Shigio Yamaguchi.
$abs_path = File::Spec->rel2abs( $path ) ; $abs_path = File::Spec->rel2abs( $path, $base ) ;
If $base is not present or '', then the cwd() manpage is used. If $base is relative, then it is converted to absolute form using the rel2abs() entry elsewhere in this document. This means that it is taken to be relative to the cwd() manpage.
On systems with the concept of a volume, this assumes that both paths are on the $base volume, and ignores the $path volume.
On systems that have a grammar that indicates filenames, this ignores the $base filename as well. Otherwise all path components are assumed to be directories.
If $path is absolute, it is cleaned up and returned using the canonpath() entry elsewhere in this document.
No checks against the filesystem are made on most systems. On MacOS, the filesystem may be consulted (see the file_name_is_absolute entry in the File::Spec::MacOS manpage). On VMS, there is interaction with the working environment, as logicals and macros are expanded.
Based on code written by Shigio Yamaguchi.
the File::Spec manpage