| 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::DosGlob 3" |
| 132 | .TH File::DosGlob 3 "2002-06-01" "perl v5.8.0" "Perl Programmers Reference Guide" |
| 133 | .SH "NAME" |
| 134 | File::DosGlob \- DOS like globbing and then some |
| 135 | .SH "SYNOPSIS" |
| 136 | .IX Header "SYNOPSIS" |
| 137 | .Vb 1 |
| 138 | \& require 5.004; |
| 139 | .Ve |
| 140 | .PP |
| 141 | .Vb 2 |
| 142 | \& # override CORE::glob in current package |
| 143 | \& use File::DosGlob 'glob'; |
| 144 | .Ve |
| 145 | .PP |
| 146 | .Vb 2 |
| 147 | \& # override CORE::glob in ALL packages (use with extreme caution!) |
| 148 | \& use File::DosGlob 'GLOBAL_glob'; |
| 149 | .Ve |
| 150 | .PP |
| 151 | .Vb 2 |
| 152 | \& @perlfiles = glob "..\e\epe?l/*.p?"; |
| 153 | \& print <..\e\epe?l/*.p?>; |
| 154 | .Ve |
| 155 | .PP |
| 156 | .Vb 2 |
| 157 | \& # from the command line (overrides only in main::) |
| 158 | \& > perl -MFile::DosGlob=glob -e "print <../pe*/*p?>" |
| 159 | .Ve |
| 160 | .SH "DESCRIPTION" |
| 161 | .IX Header "DESCRIPTION" |
| 162 | A module that implements DOS-like globbing with a few enhancements. |
| 163 | It is largely compatible with perlglob.exe (the M$ setargv.obj |
| 164 | version) in all but one respect\*(--it understands wildcards in |
| 165 | directory components. |
| 166 | .PP |
| 167 | For example, \f(CW\*(C`<..\e\el*b\e\efile/*glob.p?\*(C'\fR> will work as expected (in |
| 168 | that it will find something like '..\elib\eFile/DosGlob.pm' alright). |
| 169 | Note that all path components are case\-insensitive, and that |
| 170 | backslashes and forward slashes are both accepted, and preserved. |
| 171 | You may have to double the backslashes if you are putting them in |
| 172 | literally, due to double-quotish parsing of the pattern by perl. |
| 173 | .PP |
| 174 | Spaces in the argument delimit distinct patterns, so |
| 175 | \&\f(CW\*(C`glob('*.exe *.dll')\*(C'\fR globs all filenames that end in \f(CW\*(C`.exe\*(C'\fR |
| 176 | or \f(CW\*(C`.dll\*(C'\fR. If you want to put in literal spaces in the glob |
| 177 | pattern, you can escape them with either double quotes, or backslashes. |
| 178 | e.g. \f(CW\*(C`glob('c:/"Program Files"/*/*.dll')\*(C'\fR, or |
| 179 | \&\f(CW\*(C`glob('c:/Program\e Files/*/*.dll')\*(C'\fR. The argument is tokenized using |
| 180 | \&\f(CW\*(C`Text::ParseWords::parse_line()\*(C'\fR, so see Text::ParseWords for details |
| 181 | of the quoting rules used. |
| 182 | .PP |
| 183 | Extending it to csh patterns is left as an exercise to the reader. |
| 184 | .SH "NOTES" |
| 185 | .IX Header "NOTES" |
| 186 | .IP "\(bu" 4 |
| 187 | Mac \s-1OS\s0 (Classic) users should note a few differences. The specification |
| 188 | of pathnames in glob patterns adheres to the usual Mac \s-1OS\s0 conventions: |
| 189 | The path separator is a colon ':', not a slash '/' or backslash '\e'. A |
| 190 | full path always begins with a volume name. A relative pathname on Mac |
| 191 | \&\s-1OS\s0 must always begin with a ':', except when specifying a file or |
| 192 | directory name in the current working directory, where the leading colon |
| 193 | is optional. If specifying a volume name only, a trailing ':' is |
| 194 | required. Due to these rules, a glob like <*:> will find all |
| 195 | mounted volumes, while a glob like <*> or <:*> will find |
| 196 | all files and directories in the current directory. |
| 197 | .Sp |
| 198 | Note that updirs in the glob pattern are resolved before the matching begins, |
| 199 | i.e. a pattern like \*(L"*HD:t?p::a*\*(R" will be matched as \*(L"*HD:a*\*(R". Note also, |
| 200 | that a single trailing ':' in the pattern is ignored (unless it's a volume |
| 201 | name pattern like \*(L"*HD:\*(R"), i.e. a glob like <:*:> will find both directories |
| 202 | \&\fIand\fR files (and not, as one might expect, only directories). |
| 203 | .Sp |
| 204 | The metachars '*', '?' and the escape char '\e' are valid characters in |
| 205 | volume, directory and file names on Mac \s-1OS\s0. Hence, if you want to match |
| 206 | a '*', '?' or '\e' literally, you have to escape these characters. Due to |
| 207 | perl's quoting rules, things may get a bit complicated, when you want to |
| 208 | match a string like '\e*' literally, or when you want to match '\e' literally, |
| 209 | but treat the immediately following character '*' as metachar. So, here's a |
| 210 | rule of thumb (applies to both single\- and double-quoted strings): escape |
| 211 | each '*' or '?' or '\e' with a backslash, if you want to treat them literally, |
| 212 | and then double each backslash and your are done. E.g. |
| 213 | .Sp |
| 214 | \&\- Match '\e*' literally |
| 215 | .Sp |
| 216 | .Vb 2 |
| 217 | \& escape both '\e' and '*' : '\e\e\e*' |
| 218 | \& double the backslashes : '\e\e\e\e\e\e*' |
| 219 | .Ve |
| 220 | .Sp |
| 221 | (Internally, the glob routine sees a '\e\e\e*', which means that both '\e' and |
| 222 | \&'*' are escaped.) |
| 223 | .Sp |
| 224 | \&\- Match '\e' literally, treat '*' as metachar |
| 225 | .Sp |
| 226 | .Vb 2 |
| 227 | \& escape '\e' but not '*' : '\e\e*' |
| 228 | \& double the backslashes : '\e\e\e\e*' |
| 229 | .Ve |
| 230 | .Sp |
| 231 | (Internally, the glob routine sees a '\e\e*', which means that '\e' is escaped and |
| 232 | \&'*' is not.) |
| 233 | .Sp |
| 234 | Note that you also have to quote literal spaces in the glob pattern, as described |
| 235 | above. |
| 236 | .SH "EXPORTS (by request only)" |
| 237 | .IX Header "EXPORTS (by request only)" |
| 238 | \&\fIglob()\fR |
| 239 | .SH "BUGS" |
| 240 | .IX Header "BUGS" |
| 241 | Should probably be built into the core, and needs to stop |
| 242 | pandering to \s-1DOS\s0 habits. Needs a dose of optimizium too. |
| 243 | .SH "AUTHOR" |
| 244 | .IX Header "AUTHOR" |
| 245 | Gurusamy Sarathy <gsar@activestate.com> |
| 246 | .SH "HISTORY" |
| 247 | .IX Header "HISTORY" |
| 248 | .IP "\(bu" 4 |
| 249 | Support for globally overriding \fIglob()\fR (\s-1GSAR\s0 3\-JUN\-98) |
| 250 | .IP "\(bu" 4 |
| 251 | Scalar context, independent iterator context fixes (\s-1GSAR\s0 15\-SEP\-97) |
| 252 | .IP "\(bu" 4 |
| 253 | A few dir-vs-file optimizations result in glob importation being |
| 254 | 10 times faster than using perlglob.exe, and using perlglob.bat is |
| 255 | only twice as slow as perlglob.exe (\s-1GSAR\s0 28\-MAY\-97) |
| 256 | .IP "\(bu" 4 |
| 257 | Several cleanups prompted by lack of compatible perlglob.exe |
| 258 | under Borland (\s-1GSAR\s0 27\-MAY\-97) |
| 259 | .IP "\(bu" 4 |
| 260 | Initial version (\s-1GSAR\s0 20\-FEB\-97) |
| 261 | .SH "SEE ALSO" |
| 262 | .IX Header "SEE ALSO" |
| 263 | perl |
| 264 | .PP |
| 265 | perlglob.bat |
| 266 | .PP |
| 267 | Text::ParseWords |