Index for Section 3

Alphabetical listing for F

Bottom of page

File::Spec::Epoc(3)
NAME
  File::Spec::Epoc - methods for Epoc file specs

SYNOPSIS
   require File::Spec::Epoc; # Done internally by File::Spec if needed

DESCRIPTION
  See File::Spec::Unix for a documentation of the methods provided there.
  This package overrides the implementation of these methods, not the
  semantics.

  This package is still work in progress ;-) o.flebbe@gmx.de

  devnull
      Returns a string representation of the null device.

  tmpdir
      Returns a string representation of a temporay directory:

  path
      Takes no argument, returns the environment variable PATH as an array.
      Since there is no search path supported, it returns undef, sorry.

  canonpath
      No physical check on the filesystem, but a logical cleanup of a path.
      On UNIX eliminated successive slashes and successive "/.".

  splitpath
	  ($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. Assumes
      that the last file is a path unless the path ends in '\\', '\\.',
      '\\..' or $no_file is true.  On Win32 this means that $no_file true
      makes this return ( $volume, $path, undef ).

      Separators accepted are \ and /.

      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.

  splitdir
      The opposite of the catdir() entry elsewhere in this document.

	  @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, leading empty
      and trailing directory entries can be returned, because these are
      significant on some OSs. So,

	  File::Spec->splitdir( "/a/b/c" );

      Yields:

	  ( '', 'a', 'b', '', 'c', '' )

  catpath
      Takes volume, directory and file portions and returns an entire path.
      Under Unix, $volume is ignored, and this is just like catfile(). On
      other OSs, the $volume become significant.

  abs2rel
      Takes a destination path and an optional base path returns a relative
      path from the base path to the destination path:

	  $rel_path = File::Spec->abs2rel( $destination ) ;
	  $rel_path = File::Spec->abs2rel( $destination, $base ) ;

      If $base is not present or '', then the cwd() entry elsewhere in this
      document 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() entry elsewhere
      in this document.

      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() entry elsewhere in this document.

      Based on code written by Shigio Yamaguchi.

      No checks against the filesystem are made.

  rel2abs
      Converts a relative path to an absolute path.

	  $abs_path = File::Spec->rel2abs( $destination ) ;
	  $abs_path = File::Spec->rel2abs( $destination, $base ) ;

      If $base is not present or '', then the cwd() entry elsewhere in this
      document 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() entry elsewhere
      in this document.

      Assumes that both paths are on the $base volume, and ignores the
      $destination 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.

      Based on code written by Shigio Yamaguchi.

      No checks against the filesystem are made.

SEE ALSO
  the File::Spec manpage

Index for Section 3

Alphabetical listing for F

Top of page