| 1 | .\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13 |
| 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::Basename 3" |
| 132 | .TH File::Basename 3 "2002-06-01" "perl v5.8.0" "Perl Programmers Reference Guide" |
| 133 | .SH "NAME" |
| 134 | fileparse \- split a pathname into pieces |
| 135 | .PP |
| 136 | basename \- extract just the filename from a path |
| 137 | .PP |
| 138 | dirname \- extract just the directory from a path |
| 139 | .SH "SYNOPSIS" |
| 140 | .IX Header "SYNOPSIS" |
| 141 | .Vb 1 |
| 142 | \& use File::Basename; |
| 143 | .Ve |
| 144 | .PP |
| 145 | .Vb 4 |
| 146 | \& ($name,$path,$suffix) = fileparse($fullname,@suffixlist) |
| 147 | \& fileparse_set_fstype($os_string); |
| 148 | \& $basename = basename($fullname,@suffixlist); |
| 149 | \& $dirname = dirname($fullname); |
| 150 | .Ve |
| 151 | .PP |
| 152 | .Vb 4 |
| 153 | \& ($name,$path,$suffix) = fileparse("lib/File/Basename.pm",qr{\e.pm}); |
| 154 | \& fileparse_set_fstype("VMS"); |
| 155 | \& $basename = basename("lib/File/Basename.pm",qr{\e.pm}); |
| 156 | \& $dirname = dirname("lib/File/Basename.pm"); |
| 157 | .Ve |
| 158 | .SH "DESCRIPTION" |
| 159 | .IX Header "DESCRIPTION" |
| 160 | These routines allow you to parse file specifications into useful |
| 161 | pieces using the syntax of different operating systems. |
| 162 | .IP "fileparse_set_fstype" 4 |
| 163 | .IX Item "fileparse_set_fstype" |
| 164 | You select the syntax via the routine \fIfileparse_set_fstype()\fR. |
| 165 | .Sp |
| 166 | If the argument passed to it contains one of the substrings |
| 167 | \&\*(L"\s-1VMS\s0\*(R", \*(L"\s-1MSDOS\s0\*(R", \*(L"MacOS\*(R", \*(L"AmigaOS\*(R" or \*(L"MSWin32\*(R", the file specification |
| 168 | syntax of that operating system is used in future calls to |
| 169 | \&\fIfileparse()\fR, \fIbasename()\fR, and \fIdirname()\fR. If it contains none of |
| 170 | these substrings, Unix syntax is used. This pattern matching is |
| 171 | case\-insensitive. If you've selected \s-1VMS\s0 syntax, and the file |
| 172 | specification you pass to one of these routines contains a \*(L"/\*(R", |
| 173 | they assume you are using Unix emulation and apply the Unix syntax |
| 174 | rules instead, for that function call only. |
| 175 | .Sp |
| 176 | If the argument passed to it contains one of the substrings \*(L"\s-1VMS\s0\*(R", |
| 177 | \&\*(L"\s-1MSDOS\s0\*(R", \*(L"MacOS\*(R", \*(L"AmigaOS\*(R", \*(L"os2\*(R", \*(L"MSWin32\*(R" or \*(L"\s-1RISCOS\s0\*(R", then the pattern |
| 178 | matching for suffix removal is performed without regard for case, |
| 179 | since those systems are not case-sensitive when opening existing files |
| 180 | (though some of them preserve case on file creation). |
| 181 | .Sp |
| 182 | If you haven't called \fIfileparse_set_fstype()\fR, the syntax is chosen |
| 183 | by examining the builtin variable \f(CW$^O\fR according to these rules. |
| 184 | .IP "fileparse" 4 |
| 185 | .IX Item "fileparse" |
| 186 | The \fIfileparse()\fR routine divides a file specification into three |
| 187 | parts: a leading \fBpath\fR, a file \fBname\fR, and a \fBsuffix\fR. The |
| 188 | \&\fBpath\fR contains everything up to and including the last directory |
| 189 | separator in the input file specification. The remainder of the input |
| 190 | file specification is then divided into \fBname\fR and \fBsuffix\fR based on |
| 191 | the optional patterns you specify in \f(CW@suffixlist\fR. Each element of |
| 192 | this list can be a qr-quoted pattern (or a string which is interpreted |
| 193 | as a regular expression), and is matched |
| 194 | against the end of \fBname\fR. If this succeeds, the matching portion of |
| 195 | \&\fBname\fR is removed and prepended to \fBsuffix\fR. By proper use of |
| 196 | \&\f(CW@suffixlist\fR, you can remove file types or versions for examination. |
| 197 | .Sp |
| 198 | You are guaranteed that if you concatenate \fBpath\fR, \fBname\fR, and |
| 199 | \&\fBsuffix\fR together in that order, the result will denote the same |
| 200 | file as the input file specification. |
| 201 | .SH "EXAMPLES" |
| 202 | .IX Header "EXAMPLES" |
| 203 | Using Unix file syntax: |
| 204 | .PP |
| 205 | .Vb 2 |
| 206 | \& ($base,$path,$type) = fileparse('/virgil/aeneid/draft.book7', |
| 207 | \& qr{\e.book\ed+}); |
| 208 | .Ve |
| 209 | .PP |
| 210 | would yield |
| 211 | .PP |
| 212 | .Vb 3 |
| 213 | \& $base eq 'draft' |
| 214 | \& $path eq '/virgil/aeneid/', |
| 215 | \& $type eq '.book7' |
| 216 | .Ve |
| 217 | .PP |
| 218 | Similarly, using \s-1VMS\s0 syntax: |
| 219 | .PP |
| 220 | .Vb 2 |
| 221 | \& ($name,$dir,$type) = fileparse('Doc_Root:[Help]Rhetoric.Rnh', |
| 222 | \& qr{\e..*}); |
| 223 | .Ve |
| 224 | .PP |
| 225 | would yield |
| 226 | .PP |
| 227 | .Vb 3 |
| 228 | \& $name eq 'Rhetoric' |
| 229 | \& $dir eq 'Doc_Root:[Help]' |
| 230 | \& $type eq '.Rnh' |
| 231 | .Ve |
| 232 | .ie n .IP """basename""" 4 |
| 233 | .el .IP "\f(CWbasename\fR" 4 |
| 234 | .IX Item "basename" |
| 235 | The \fIbasename()\fR routine returns the first element of the list produced |
| 236 | by calling \fIfileparse()\fR with the same arguments, except that it always |
| 237 | quotes metacharacters in the given suffixes. It is provided for |
| 238 | programmer compatibility with the Unix shell command \fIbasename\fR\|(1). |
| 239 | .ie n .IP """dirname""" 4 |
| 240 | .el .IP "\f(CWdirname\fR" 4 |
| 241 | .IX Item "dirname" |
| 242 | The \fIdirname()\fR routine returns the directory portion of the input file |
| 243 | specification. When using \s-1VMS\s0 or MacOS syntax, this is identical to the |
| 244 | second element of the list produced by calling \fIfileparse()\fR with the same |
| 245 | input file specification. (Under \s-1VMS\s0, if there is no directory information |
| 246 | in the input file specification, then the current default device and |
| 247 | directory are returned.) When using Unix or \s-1MSDOS\s0 syntax, the return |
| 248 | value conforms to the behavior of the Unix shell command \fIdirname\fR\|(1). This |
| 249 | is usually the same as the behavior of \fIfileparse()\fR, but differs in some |
| 250 | cases. For example, for the input file specification \fIlib/\fR, \fIfileparse()\fR |
| 251 | considers the directory name to be \fIlib/\fR, while \fIdirname()\fR considers the |
| 252 | directory name to be \fI.\fR). |