22

✏️ Editing: Path::Class.3pm

.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Path::Class 3"
.TH Path::Class 3 "2024-02-18" "perl v5.26.3" "User Contributed Perl Documentation"
.\" 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"
Path::Class \- Cross\-platform path specification manipulation
.SH "VERSION"
.IX Header "VERSION"
version 0.37
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Path::Class;
\&  
\&  my $dir  = dir(\*(Aqfoo\*(Aq, \*(Aqbar\*(Aq);       # Path::Class::Dir object
\&  my $file = file(\*(Aqbob\*(Aq, \*(Aqfile.txt\*(Aq); # Path::Class::File object
\&  
\&  # Stringifies to \*(Aqfoo/bar\*(Aq on Unix, \*(Aqfoo\ebar\*(Aq on Windows, etc.
\&  print "dir: $dir\en";
\&  
\&  # Stringifies to \*(Aqbob/file.txt\*(Aq on Unix, \*(Aqbob\efile.txt\*(Aq on Windows
\&  print "file: $file\en";
\&  
\&  my $subdir  = $dir\->subdir(\*(Aqbaz\*(Aq);  # foo/bar/baz
\&  my $parent  = $subdir\->parent;      # foo/bar
\&  my $parent2 = $parent\->parent;      # foo
\&  
\&  my $dir2 = $file\->dir;              # bob
\&
\&  # Work with foreign paths
\&  use Path::Class qw(foreign_file foreign_dir);
\&  my $file = foreign_file(\*(AqMac\*(Aq, \*(Aq:foo:file.txt\*(Aq);
\&  print $file\->dir;                   # :foo:
\&  print $file\->as_foreign(\*(AqWin32\*(Aq);   # foo\efile.txt
\&  
\&  # Interact with the underlying filesystem:
\&  
\&  # $dir_handle is an IO::Dir object
\&  my $dir_handle = $dir\->open or die "Can\*(Aqt read $dir: $!";
\&  
\&  # $file_handle is an IO::File object
\&  my $file_handle = $file\->open($mode) or die "Can\*(Aqt read $file: $!";
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Path::Class\*(C'\fR is a module for manipulation of file and directory
specifications (strings describing their locations, like
\&\f(CW\*(Aq/home/ken/foo.txt\*(Aq\fR or \f(CW\*(AqC:\eWindows\eFoo.txt\*(Aq\fR) in a cross-platform
manner.  It supports pretty much every platform Perl runs on,
including Unix, Windows, Mac, \s-1VMS,\s0 Epoc, Cygwin, \s-1OS/2,\s0 and NetWare.
.PP
The well-known module File::Spec also provides this service, but
it's sort of awkward to use well, so people sometimes avoid it, or use
it in a way that won't actually work properly on platforms
significantly different than the ones they've tested their code on.
.PP
In fact, \f(CW\*(C`Path::Class\*(C'\fR uses \f(CW\*(C`File::Spec\*(C'\fR internally, wrapping all
the unsightly details so you can concentrate on your application code.
Whereas \f(CW\*(C`File::Spec\*(C'\fR provides functions for some common path
manipulations, \f(CW\*(C`Path::Class\*(C'\fR provides an object-oriented model of the
world of path specifications and their underlying semantics.
\&\f(CW\*(C`File::Spec\*(C'\fR doesn't create any objects, and its classes represent
the different ways in which paths must be manipulated on various
platforms (not a very intuitive concept).  \f(CW\*(C`Path::Class\*(C'\fR creates
objects representing files and directories, and provides methods that
relate them to each other.  For instance, the following \f(CW\*(C`File::Spec\*(C'\fR
code:
.PP
.Vb 3
\& my $absolute = File::Spec\->file_name_is_absolute(
\&                  File::Spec\->catfile( @dirs, $file )
\&                );
.Ve
.PP
can be written using \f(CW\*(C`Path::Class\*(C'\fR as
.PP
.Vb 1
\& my $absolute = Path::Class::File\->new( @dirs, $file )\->is_absolute;
.Ve
.PP
or even as
.PP
.Vb 1
\& my $absolute = file( @dirs, $file )\->is_absolute;
.Ve
.PP
Similar readability improvements should happen all over the place when
using \f(CW\*(C`Path::Class\*(C'\fR.
.PP
Using \f(CW\*(C`Path::Class\*(C'\fR can help solve real problems in your code too \-
for instance, how many people actually take the \*(L"volume\*(R" (like \f(CW\*(C`C:\*(C'\fR
on Windows) into account when writing \f(CW\*(C`File::Spec\*(C'\fR\-using code?  I
thought not.  But if you use \f(CW\*(C`Path::Class\*(C'\fR, your file and directory objects
will know what volumes they refer to and do the right thing.
.PP
The guts of the \f(CW\*(C`Path::Class\*(C'\fR code live in the Path::Class::File
and Path::Class::Dir modules, so please see those
modules' documentation for more details about how to use them.
.SS "\s-1EXPORT\s0"
.IX Subsection "EXPORT"
The following functions are exported by default.
.IP "file" 4
.IX Item "file"
A synonym for \f(CW\*(C`Path::Class::File\->new\*(C'\fR.
.IP "dir" 4
.IX Item "dir"
A synonym for \f(CW\*(C`Path::Class::Dir\->new\*(C'\fR.
.PP
If you would like to prevent their export, you may explicitly pass an
empty list to perl's \f(CW\*(C`use\*(C'\fR, i.e. \f(CW\*(C`use Path::Class ()\*(C'\fR.
.PP
The following are exported only on demand.
.IP "foreign_file" 4
.IX Item "foreign_file"
A synonym for \f(CW\*(C`Path::Class::File\->new_foreign\*(C'\fR.
.IP "foreign_dir" 4
.IX Item "foreign_dir"
A synonym for \f(CW\*(C`Path::Class::Dir\->new_foreign\*(C'\fR.
.IP "tempdir" 4
.IX Item "tempdir"
Create a new Path::Class::Dir instance pointed to temporary directory.
.Sp
.Vb 1
\&  my $temp = Path::Class::tempdir(CLEANUP => 1);
.Ve
.Sp
A synonym for \f(CW\*(C`Path::Class::Dir\->new(File::Temp::tempdir(@_))\*(C'\fR.
.SH "Notes on Cross-Platform Compatibility"
.IX Header "Notes on Cross-Platform Compatibility"
Although it is much easier to write cross-platform-friendly code with
this module than with \f(CW\*(C`File::Spec\*(C'\fR, there are still some issues to be
aware of.
.IP "\(bu" 4
On some platforms, notably \s-1VMS\s0 and some older versions of \s-1DOS\s0 (I think),
all filenames must have an extension.  Thus if you create a file
called \fIfoo/bar\fR and then ask for a list of files in the directory
\&\fIfoo\fR, you may find a file called \fIbar.\fR instead of the \fIbar\fR you
were expecting.  Thus it might be a good idea to use an extension in
the first place.
.SH "AUTHOR"
.IX Header "AUTHOR"
Ken Williams, KWILLIAMS@cpan.org
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) Ken Williams.  All rights reserved.
.PP
This library 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"
Path::Class::Dir, Path::Class::File, File::Spec

MR SKB