local-lib5/man/man3/File::Spec::Win32.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "File::Spec::Win32 3"
 132 .TH File::Spec::Win32 3 "2009-05-10" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 File::Spec::Win32 \- methods for Win32 file specs
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 1
 138 \& require File::Spec::Win32; # Done internally by File::Spec if needed
 139 .Ve
 140 .SH "DESCRIPTION"
 141 .IX Header "DESCRIPTION"
 142 See File::Spec::Unix for a documentation of the methods provided
 143 there. This package overrides the implementation of these methods, not
 144 the semantics.
 145 .IP "devnull" 4
 146 .IX Item "devnull"
 147 Returns a string representation of the null device.
 148 .IP "tmpdir" 4
 149 .IX Item "tmpdir"
 150 Returns a string representation of the first existing directory
 151 from the following list:
 152 .Sp
 153 .Vb 8
 154 \&    $ENV{TMPDIR}
 155 \&    $ENV{TEMP}
 156 \&    $ENV{TMP}
 157 \&    SYS:/temp
 158 \&    C:\esystem\etemp
 159 \&    C:/temp
 160 \&    /tmp
 161 \&    /
 162 .Ve
 163 .Sp
 164 The SYS:/temp is preferred in Novell NetWare and the C:\esystem\etemp
 165 for Symbian (the File::Spec::Win32 is used also for those platforms).
 166 .Sp
 167 Since Perl 5.8.0, if running under taint mode, and if the environment
 168 variables are tainted, they are not used.
 169 .IP "case_tolerant" 4
 170 .IX Item "case_tolerant"
 171 MSWin32 case-tolerance depends on \fIGetVolumeInformation()\fR \f(CW$ouFsFlags\fR == \s-1FS_CASE_SENSITIVE\s0,
 172 indicating the case significance when comparing file specifications.
 173 Since \s-1XP\s0 \s-1FS_CASE_SENSITIVE\s0 is effectively disabled for the \s-1NT\s0 subsubsystem.
 174 See http://cygwin.com/ml/cygwin/2007\-07/msg00891.html
 175 Default: 1
 176 .IP "file_name_is_absolute" 4
 177 .IX Item "file_name_is_absolute"
 178 As of right now, this returns 2 if the path is absolute with a
 179 volume, 1 if it's absolute with no volume, 0 otherwise.
 180 .IP "catfile" 4
 181 .IX Item "catfile"
 182 Concatenate one or more directory names and a filename to form a
 183 complete path ending with a filename
 184 .IP "canonpath" 4
 185 .IX Item "canonpath"
 186 No physical check on the filesystem, but a logical cleanup of a
 187 path. On \s-1UNIX\s0 eliminated successive slashes and successive \*(L"/.\*(R".
 188 On Win32 makes
 189 .Sp
 190 .Vb 2
 191 \&        dir1\edir2\edir3\e..\e..\edir4 \-> \edir\edir4 and even
 192 \&        dir1\edir2\edir3\e...\edir4   \-> \edir\edir4
 193 .Ve
 194 .IP "splitpath" 4
 195 .IX Item "splitpath"
 196 .Vb 2
 197 \&    ($volume,$directories,$file) = File::Spec\->splitpath( $path );
 198 \&    ($volume,$directories,$file) = File::Spec\->splitpath( $path, $no_file );
 199 .Ve
 200 .Sp
 201 Splits a path into volume, directory, and filename portions. Assumes that
 202 the last file is a path unless the path ends in '\e\e', '\e\e.', '\e\e..'
 203 or \f(CW$no_file\fR is true.  On Win32 this means that \f(CW$no_file\fR true makes this return
 204 ( \f(CW$volume\fR, \f(CW$path\fR, '' ).
 205 .Sp
 206 Separators accepted are \e and /.
 207 .Sp
 208 Volumes can be drive letters or \s-1UNC\s0 sharenames (\e\eserver\eshare).
 209 .Sp
 210 The results can be passed to \*(L"catpath\*(R" to get back a path equivalent to
 211 (usually identical to) the original path.
 212 .IP "splitdir" 4
 213 .IX Item "splitdir"
 214 The opposite of \fIcatdir()\fR.
 215 .Sp
 216 .Vb 1
 217 \&    @dirs = File::Spec\->splitdir( $directories );
 218 .Ve
 219 .Sp
 220 $directories must be only the directory portion of the path on systems
 221 that have the concept of a volume or that have path syntax that differentiates
 222 files from directories.
 223 .Sp
 224 Unlike just splitting the directories on the separator, leading empty and
 225 trailing directory entries can be returned, because these are significant
 226 on some OSs. So,
 227 .Sp
 228 .Vb 1
 229 \&    File::Spec\->splitdir( "/a/b/c" );
 230 .Ve
 231 .Sp
 232 Yields:
 233 .Sp
 234 .Vb 1
 235 \&    ( '', 'a', 'b', '', 'c', '' )
 236 .Ve
 237 .IP "catpath" 4
 238 .IX Item "catpath"
 239 Takes volume, directory and file portions and returns an entire path. Under
 240 Unix, \f(CW$volume\fR is ignored, and this is just like \fIcatfile()\fR. On other OSs,
 241 the \f(CW$volume\fR become significant.
 242 .Sh "Note For File::Spec::Win32 Maintainers"
 243 .IX Subsection "Note For File::Spec::Win32 Maintainers"
 244 Novell NetWare inherits its File::Spec behaviour from File::Spec::Win32.
 245 .SH "COPYRIGHT"
 246 .IX Header "COPYRIGHT"
 247 Copyright (c) 2004,2007 by the Perl 5 Porters.  All rights reserved.
 248 .PP
 249 This program is free software; you can redistribute it and/or modify
 250 it under the same terms as Perl itself.
 251 .SH "SEE ALSO"
 252 .IX Header "SEE ALSO"
 253 See File::Spec and File::Spec::Unix.  This package overrides the
 254 implementation of these methods, not the semantics.