Cwd(3p) Perl Programmers Reference Guide Cwd(3p)

Cwd(3p) Perl Programmers Reference Guide Cwd(3p) #

Cwd(3p) Perl Programmers Reference Guide Cwd(3p)

NNAAMMEE #

 Cwd - get pathname of current working directory

SSYYNNOOPPSSIISS #

     use Cwd;
     my $dir = getcwd;

     use Cwd 'abs_path';
     my $abs_path = abs_path($file);

DDEESSCCRRIIPPTTIIOONN #

 This module provides functions for determining the pathname of the
 current working directory.  It is recommended that getcwd (or another
 *ccwwdd(()) function) be used in _a_l_l code to ensure portability.

 By default, it exports the functions ccwwdd(()), ggeettccwwdd(()), ffaassttccwwdd(()), and
 ffaassttggeettccwwdd(()) (and, on Win32, ggeettddccwwdd(())) into the caller's namespace.

ggeettccwwdd aanndd ffrriieennddss Each of these functions are called without arguments and return the absolute path of the current working directory.

 getcwd
         my $cwd = getcwd();

     Returns the current working directory.  On error returns "undef",
     with $! set to indicate the error.

     Exposes the POSIX function ggeettccwwdd(3) or re-implements it if it's not
     available.

 cwd
         my $cwd = cwd();

     The ccwwdd(()) is the most natural form for the current architecture.  For
     most systems it is identical to `pwd` (but without the trailing line
     terminator).

 fastcwd
         my $cwd = fastcwd();

     A more dangerous version of ggeettccwwdd(()), but potentially faster.

     It might conceivably cchhddiirr(()) you out of a directory that it can't
     cchhddiirr(()) you back into.  If fastcwd encounters a problem it will
     return undef but will probably leave you in a different directory.
     For a measure of extra security, if everything appears to have
     worked, the ffaassttccwwdd(()) function will check that it leaves you in the
     same directory that it started in.  If it has changed it will "die"
     with the message "Unstable directory path, current directory changed
     unexpectedly".  That should never happen.

 fastgetcwd
       my $cwd = fastgetcwd();

     The ffaassttggeettccwwdd(()) function is provided as a synonym for ccwwdd(()).

 getdcwd
         my $cwd = getdcwd();
         my $cwd = getdcwd('C:');

     The ggeettddccwwdd(()) function is also provided on Win32 to get the current
     working directory on the specified drive, since Windows maintains a
     separate current working directory for each drive.  If no drive is
     specified then the current drive is assumed.

     This function simply calls the Microsoft C library __ggeettddccwwdd(())
     function.

aabbss__ppaatthh aanndd ffrriieennddss These functions are exported only on request. They each take a single argument and return the absolute pathname for it. If no argument is given they’ll use the current working directory.

 abs_path
       my $abs_path = abs_path($file);

     Uses the same algorithm as ggeettccwwdd(()).  Symbolic links and relative-
     path components ("." and "..") are resolved to return the canonical
     pathname, just like rreeaallppaatthh(3).  On error returns "undef", with $!
     set to indicate the error.

 realpath
       my $abs_path = realpath($file);

     A synonym for aabbss__ppaatthh(()).

 fast_abs_path
       my $abs_path = fast_abs_path($file);

     A more dangerous, but potentially faster version of abs_path.

$$EENNVV{{PPWWDD}} #

 If you ask to override your cchhddiirr(()) built-in function,

   use Cwd qw(chdir);

 then your PWD environment variable will be kept up to date.  Note that it
 will only be kept up to date if all packages which use chdir import it
 from Cwd.

NNOOTTEESS #

 •   Since the path separators are different on some operating systems
     ('/' on Unix, ':' on MacPerl, etc...) we recommend you use the
     File::Spec modules wherever portability is a concern.

 •   Actually, on Mac OS, the "getcwd()", "fastgetcwd()" and "fastcwd()"
     functions are all aliases for the "cwd()" function, which, on Mac OS,
     calls `pwd`.  Likewise, the "abs_path()" function is an alias for
     "fast_abs_path()".

AAUUTTHHOORR #

 Maintained by perl5-porters <_p_e_r_l_5_-_p_o_r_t_e_r_s_@_p_e_r_l_._o_r_g>.

CCOOPPYYRRIIGGHHTT #

 Copyright (c) 2004 by the Perl 5 Porters.  All rights reserved.

 This program is free software; you can redistribute it and/or modify it
 under the same terms as Perl itself.

 Portions of the C code in this library are copyright (c) 1994 by the
 Regents of the University of California.  All rights reserved.  The
 license on this code is compatible with the licensing of the rest of the
 distribution - please see the source code in _C_w_d_._x_s for the details.

SSEEEE AALLSSOO #

 File::chdir

perl v5.36.3 2023-02-15 Cwd(3p)