Commit | Line | Data |
---|---|---|
920dae64 AT |
1 | '\" |
2 | '\" Copyright (c) 1993 The Regents of the University of California. | |
3 | '\" Copyright (c) 1994-1996 Sun Microsystems, Inc. | |
4 | '\" | |
5 | '\" See the file "license.terms" for information on usage and redistribution | |
6 | '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. | |
7 | '\" | |
8 | '\" RCS: @(#) $Id: glob.n,v 1.12.2.1 2004/10/27 12:52:40 dkf Exp $ | |
9 | '\" | |
10 | '\" The definitions below are for supplemental macros used in Tcl/Tk | |
11 | '\" manual entries. | |
12 | '\" | |
13 | '\" .AP type name in/out ?indent? | |
14 | '\" Start paragraph describing an argument to a library procedure. | |
15 | '\" type is type of argument (int, etc.), in/out is either "in", "out", | |
16 | '\" or "in/out" to describe whether procedure reads or modifies arg, | |
17 | '\" and indent is equivalent to second arg of .IP (shouldn't ever be | |
18 | '\" needed; use .AS below instead) | |
19 | '\" | |
20 | '\" .AS ?type? ?name? | |
21 | '\" Give maximum sizes of arguments for setting tab stops. Type and | |
22 | '\" name are examples of largest possible arguments that will be passed | |
23 | '\" to .AP later. If args are omitted, default tab stops are used. | |
24 | '\" | |
25 | '\" .BS | |
26 | '\" Start box enclosure. From here until next .BE, everything will be | |
27 | '\" enclosed in one large box. | |
28 | '\" | |
29 | '\" .BE | |
30 | '\" End of box enclosure. | |
31 | '\" | |
32 | '\" .CS | |
33 | '\" Begin code excerpt. | |
34 | '\" | |
35 | '\" .CE | |
36 | '\" End code excerpt. | |
37 | '\" | |
38 | '\" .VS ?version? ?br? | |
39 | '\" Begin vertical sidebar, for use in marking newly-changed parts | |
40 | '\" of man pages. The first argument is ignored and used for recording | |
41 | '\" the version when the .VS was added, so that the sidebars can be | |
42 | '\" found and removed when they reach a certain age. If another argument | |
43 | '\" is present, then a line break is forced before starting the sidebar. | |
44 | '\" | |
45 | '\" .VE | |
46 | '\" End of vertical sidebar. | |
47 | '\" | |
48 | '\" .DS | |
49 | '\" Begin an indented unfilled display. | |
50 | '\" | |
51 | '\" .DE | |
52 | '\" End of indented unfilled display. | |
53 | '\" | |
54 | '\" .SO | |
55 | '\" Start of list of standard options for a Tk widget. The | |
56 | '\" options follow on successive lines, in four columns separated | |
57 | '\" by tabs. | |
58 | '\" | |
59 | '\" .SE | |
60 | '\" End of list of standard options for a Tk widget. | |
61 | '\" | |
62 | '\" .OP cmdName dbName dbClass | |
63 | '\" Start of description of a specific option. cmdName gives the | |
64 | '\" option's name as specified in the class command, dbName gives | |
65 | '\" the option's name in the option database, and dbClass gives | |
66 | '\" the option's class in the option database. | |
67 | '\" | |
68 | '\" .UL arg1 arg2 | |
69 | '\" Print arg1 underlined, then print arg2 normally. | |
70 | '\" | |
71 | '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $ | |
72 | '\" | |
73 | '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. | |
74 | .if t .wh -1.3i ^B | |
75 | .nr ^l \n(.l | |
76 | .ad b | |
77 | '\" # Start an argument description | |
78 | .de AP | |
79 | .ie !"\\$4"" .TP \\$4 | |
80 | .el \{\ | |
81 | . ie !"\\$2"" .TP \\n()Cu | |
82 | . el .TP 15 | |
83 | .\} | |
84 | .ta \\n()Au \\n()Bu | |
85 | .ie !"\\$3"" \{\ | |
86 | \&\\$1 \\fI\\$2\\fP (\\$3) | |
87 | .\".b | |
88 | .\} | |
89 | .el \{\ | |
90 | .br | |
91 | .ie !"\\$2"" \{\ | |
92 | \&\\$1 \\fI\\$2\\fP | |
93 | .\} | |
94 | .el \{\ | |
95 | \&\\fI\\$1\\fP | |
96 | .\} | |
97 | .\} | |
98 | .. | |
99 | '\" # define tabbing values for .AP | |
100 | .de AS | |
101 | .nr )A 10n | |
102 | .if !"\\$1"" .nr )A \\w'\\$1'u+3n | |
103 | .nr )B \\n()Au+15n | |
104 | .\" | |
105 | .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n | |
106 | .nr )C \\n()Bu+\\w'(in/out)'u+2n | |
107 | .. | |
108 | .AS Tcl_Interp Tcl_CreateInterp in/out | |
109 | '\" # BS - start boxed text | |
110 | '\" # ^y = starting y location | |
111 | '\" # ^b = 1 | |
112 | .de BS | |
113 | .br | |
114 | .mk ^y | |
115 | .nr ^b 1u | |
116 | .if n .nf | |
117 | .if n .ti 0 | |
118 | .if n \l'\\n(.lu\(ul' | |
119 | .if n .fi | |
120 | .. | |
121 | '\" # BE - end boxed text (draw box now) | |
122 | .de BE | |
123 | .nf | |
124 | .ti 0 | |
125 | .mk ^t | |
126 | .ie n \l'\\n(^lu\(ul' | |
127 | .el \{\ | |
128 | .\" Draw four-sided box normally, but don't draw top of | |
129 | .\" box if the box started on an earlier page. | |
130 | .ie !\\n(^b-1 \{\ | |
131 | \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' | |
132 | .\} | |
133 | .el \}\ | |
134 | \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' | |
135 | .\} | |
136 | .\} | |
137 | .fi | |
138 | .br | |
139 | .nr ^b 0 | |
140 | .. | |
141 | '\" # VS - start vertical sidebar | |
142 | '\" # ^Y = starting y location | |
143 | '\" # ^v = 1 (for troff; for nroff this doesn't matter) | |
144 | .de VS | |
145 | .if !"\\$2"" .br | |
146 | .mk ^Y | |
147 | .ie n 'mc \s12\(br\s0 | |
148 | .el .nr ^v 1u | |
149 | .. | |
150 | '\" # VE - end of vertical sidebar | |
151 | .de VE | |
152 | .ie n 'mc | |
153 | .el \{\ | |
154 | .ev 2 | |
155 | .nf | |
156 | .ti 0 | |
157 | .mk ^t | |
158 | \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' | |
159 | .sp -1 | |
160 | .fi | |
161 | .ev | |
162 | .\} | |
163 | .nr ^v 0 | |
164 | .. | |
165 | '\" # Special macro to handle page bottom: finish off current | |
166 | '\" # box/sidebar if in box/sidebar mode, then invoked standard | |
167 | '\" # page bottom macro. | |
168 | .de ^B | |
169 | .ev 2 | |
170 | 'ti 0 | |
171 | 'nf | |
172 | .mk ^t | |
173 | .if \\n(^b \{\ | |
174 | .\" Draw three-sided box if this is the box's first page, | |
175 | .\" draw two sides but no top otherwise. | |
176 | .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c | |
177 | .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c | |
178 | .\} | |
179 | .if \\n(^v \{\ | |
180 | .nr ^x \\n(^tu+1v-\\n(^Yu | |
181 | \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c | |
182 | .\} | |
183 | .bp | |
184 | 'fi | |
185 | .ev | |
186 | .if \\n(^b \{\ | |
187 | .mk ^y | |
188 | .nr ^b 2 | |
189 | .\} | |
190 | .if \\n(^v \{\ | |
191 | .mk ^Y | |
192 | .\} | |
193 | .. | |
194 | '\" # DS - begin display | |
195 | .de DS | |
196 | .RS | |
197 | .nf | |
198 | .sp | |
199 | .. | |
200 | '\" # DE - end display | |
201 | .de DE | |
202 | .fi | |
203 | .RE | |
204 | .sp | |
205 | .. | |
206 | '\" # SO - start of list of standard options | |
207 | .de SO | |
208 | .SH "STANDARD OPTIONS" | |
209 | .LP | |
210 | .nf | |
211 | .ta 5.5c 11c | |
212 | .ft B | |
213 | .. | |
214 | '\" # SE - end of list of standard options | |
215 | .de SE | |
216 | .fi | |
217 | .ft R | |
218 | .LP | |
219 | See the \\fBoptions\\fR manual entry for details on the standard options. | |
220 | .. | |
221 | '\" # OP - start of full description for a single option | |
222 | .de OP | |
223 | .LP | |
224 | .nf | |
225 | .ta 4c | |
226 | Command-Line Name: \\fB\\$1\\fR | |
227 | Database Name: \\fB\\$2\\fR | |
228 | Database Class: \\fB\\$3\\fR | |
229 | .fi | |
230 | .IP | |
231 | .. | |
232 | '\" # CS - begin code excerpt | |
233 | .de CS | |
234 | .RS | |
235 | .nf | |
236 | .ta .25i .5i .75i 1i | |
237 | .. | |
238 | '\" # CE - end code excerpt | |
239 | .de CE | |
240 | .fi | |
241 | .RE | |
242 | .. | |
243 | .de UL | |
244 | \\$1\l'|0\(ul'\\$2 | |
245 | .. | |
246 | .TH glob n 8.3 Tcl "Tcl Built-In Commands" | |
247 | .BS | |
248 | '\" Note: do not modify the .SH NAME line immediately below! | |
249 | .SH NAME | |
250 | glob \- Return names of files that match patterns | |
251 | .SH SYNOPSIS | |
252 | \fBglob \fR?\fIswitches\fR? \fIpattern \fR?\fIpattern ...\fR? | |
253 | .BE | |
254 | ||
255 | .SH DESCRIPTION | |
256 | .PP | |
257 | This command performs file name ``globbing'' in a fashion similar to | |
258 | the csh shell. It returns a list of the files whose names match any | |
259 | of the \fIpattern\fR arguments. | |
260 | .LP | |
261 | If the initial arguments to \fBglob\fR start with \fB\-\fR then | |
262 | they are treated as switches. The following switches are | |
263 | currently supported: | |
264 | .VS 8.3 | |
265 | .TP | |
266 | \fB\-directory\fR \fIdirectory\fR | |
267 | Search for files which match the given patterns starting in the given | |
268 | \fIdirectory\fR. This allows searching of directories whose name | |
269 | contains glob-sensitive characters without the need to quote such | |
270 | characters explicitly. This option may not be used in conjunction with | |
271 | \fB\-path\fR, which is used to allow searching for complete file paths | |
272 | whose names may contain glob-sensitive characters. | |
273 | .TP | |
274 | \fB\-join\fR | |
275 | The remaining pattern arguments are treated as a single pattern | |
276 | obtained by joining the arguments with directory separators. | |
277 | .VE 8.3 | |
278 | .TP | |
279 | \fB\-nocomplain\fR | |
280 | Allows an empty list to be returned without error; without this | |
281 | switch an error is returned if the result list would be empty. | |
282 | .VS 8.3 | |
283 | .TP | |
284 | \fB\-path\fR \fIpathPrefix\fR | |
285 | Search for files with the given \fIpathPrefix\fR where the rest of the name | |
286 | matches the given patterns. This allows searching for files with names | |
287 | similar to a given file (as opposed to a directory) even when the names | |
288 | contain glob-sensitive | |
289 | characters. This option may not be used in conjunction with | |
290 | \fB\-directory\fR. For example, to find all files with the same root name | |
291 | as $path, but differing extensions, you should use \fBglob | |
292 | -path [file rootname $path] .*\fR which will work even if $path contains | |
293 | numerous glob-sensitive characters. | |
294 | .TP | |
295 | \fB\-tails\fR | |
296 | Only return the part of each file found which follows the last directory | |
297 | named in any \fB\-directory\fR or \fB\-path\fR path specification. | |
298 | Thus \fBglob -tails -directory $dir *\fR is equivalent to | |
299 | \fBset pwd [pwd] ; cd $dir ; glob *; cd $pwd\fR. For | |
300 | \fB\-path\fR specifications, the returned names will include the last | |
301 | path segment, so \fBglob -tails -path [file rootname ~/foo.tex] .*\fR | |
302 | will return paths like \fBfoo.aux foo.bib foo.tex\fR etc. | |
303 | .TP | |
304 | \fB\-types\fR \fItypeList\fR | |
305 | Only list files or directories which match \fItypeList\fR, where the items | |
306 | in the list have two forms. The first form is like the \-type option of | |
307 | the Unix find command: | |
308 | \fIb\fR (block special file), | |
309 | \fIc\fR (character special file), | |
310 | \fId\fR (directory), | |
311 | \fIf\fR (plain file), | |
312 | \fIl\fR (symbolic link), | |
313 | \fIp\fR (named pipe), | |
314 | or \fIs\fR (socket), where multiple types may be specified in the list. | |
315 | \fBGlob\fR will return all files which match at least one of the types given. | |
316 | Note that symbolic links will be returned both if \fB\-types l\fR is given, | |
317 | or if the target of a link matches the requested type. So, a link to | |
318 | a directory will be returned if \fB\-types d\fR was specified. | |
319 | .RS | |
320 | .PP | |
321 | The second form specifies types where all the types given must match. | |
322 | These are \fIr\fR, \fIw\fR, \fIx\fR as file permissions, and | |
323 | \fIreadonly\fR, \fIhidden\fR as special permission cases. On the | |
324 | Macintosh, MacOS types and creators are also supported, where any item | |
325 | which is four characters long is assumed to be a MacOS type | |
326 | (e.g. \fBTEXT\fR). Items which are of the form \fI{macintosh type XXXX}\fR | |
327 | or \fI{macintosh creator XXXX}\fR will match types or creators | |
328 | respectively. Unrecognized types, or specifications of multiple MacOS | |
329 | types/creators will signal an error. | |
330 | .PP | |
331 | The two forms may be mixed, so \fB\-types {d f r w}\fR will find all | |
332 | regular files OR directories that have both read AND write permissions. | |
333 | The following are equivalent: | |
334 | .RS | |
335 | .CS | |
336 | \fBglob \-type d *\fR | |
337 | \fBglob */\fR | |
338 | .CE | |
339 | .RE | |
340 | except that the first case doesn't return the trailing ``/'' and | |
341 | is more platform independent. | |
342 | .RE | |
343 | .VE 8.3 | |
344 | .TP | |
345 | \fB\-\|\-\fR | |
346 | Marks the end of switches. The argument following this one will | |
347 | be treated as a \fIpattern\fR even if it starts with a \fB\-\fR. | |
348 | .PP | |
349 | The \fIpattern\fR arguments may contain any of the following | |
350 | special characters: | |
351 | .TP 10 | |
352 | \fB?\fR | |
353 | Matches any single character. | |
354 | .TP 10 | |
355 | \fB*\fR | |
356 | Matches any sequence of zero or more characters. | |
357 | .TP 10 | |
358 | \fB[\fIchars\fB]\fR | |
359 | Matches any single character in \fIchars\fR. If \fIchars\fR | |
360 | contains a sequence of the form \fIa\fB\-\fIb\fR then any | |
361 | character between \fIa\fR and \fIb\fR (inclusive) will match. | |
362 | .TP 10 | |
363 | \fB\e\fIx\fR | |
364 | Matches the character \fIx\fR. | |
365 | .TP 10 | |
366 | \fB{\fIa\fB,\fIb\fB,\fI...\fR} | |
367 | Matches any of the strings \fIa\fR, \fIb\fR, etc. | |
368 | .LP | |
369 | On Unix, as with csh, a ``.'' at the beginning of a file's name or just | |
370 | after a ``/'' must be matched explicitly or with a {} construct, | |
371 | unless the ``-types hidden'' flag is given (since ``.'' at the beginning | |
372 | of a file's name indicates that it is hidden). On other platforms, | |
373 | files beginning with a ``.'' are handled no differently to any others, | |
374 | except the special directories ``.'' and ``..'' which must be matched | |
375 | explicitly (this is to avoid a recursive pattern like ``glob -join * * | |
376 | * *'' from recursing up the directory hierarchy as well as down). | |
377 | In addition, all ``/'' characters must be matched explicitly. | |
378 | .LP | |
379 | If the first character in a \fIpattern\fR is ``~'' then it refers | |
380 | to the home directory for the user whose name follows the ``~''. | |
381 | If the ``~'' is followed immediately by ``/'' then the value of | |
382 | the HOME environment variable is used. | |
383 | .LP | |
384 | The \fBglob\fR command differs from csh globbing in two ways. | |
385 | First, it does not sort its result list (use the \fBlsort\fR | |
386 | command if you want the list sorted). | |
387 | Second, \fBglob\fR only returns the names of files that actually | |
388 | exist; in csh no check for existence is made unless a pattern | |
389 | contains a ?, *, or [] construct. | |
390 | .LP | |
391 | When the \fBglob\fR command returns relative paths whose filenames | |
392 | start with a tilde ``~'' (for example through \fBglob *\fR or | |
393 | \fBglob -tails\fR, the returned list will not quote the tilde with | |
394 | ``./''. This means care must be taken if those names are later to | |
395 | be used with \fBfile join\fR, to avoid them being interpreted as | |
396 | absolute paths pointing to a given user's home directory. | |
397 | .SH "PORTABILITY ISSUES" | |
398 | .PP | |
399 | Unlike other Tcl commands that will accept both network and native | |
400 | style names (see the \fBfilename\fR manual entry for details on how | |
401 | native and network names are specified), the \fBglob\fR command only | |
402 | accepts native names. | |
403 | .TP | |
404 | \fBWindows\fR | |
405 | . | |
406 | For Windows UNC names, the servername and sharename components of the path | |
407 | may not contain ?, *, or [] constructs. On Windows NT, if \fIpattern\fR is | |
408 | of the form ``\fB~\fIusername\fB@\fIdomain\fR'' it refers to the home | |
409 | directory of the user whose account information resides on the specified NT | |
410 | domain server. Otherwise, user account information is obtained from | |
411 | the local computer. On Windows 95 and 98, \fBglob\fR accepts patterns | |
412 | like ``.../'' and ``..../'' for successively higher up parent directories. | |
413 | ||
414 | . | |
415 | Since the backslash character has a special meaning to the glob | |
416 | command, glob patterns containing Windows style path separators need | |
417 | special care. The pattern \fIC:\e\efoo\e\e*\fR is interpreted as | |
418 | \fIC:\efoo\e*\fR where \fI\ef\fR will match the single character \fIf\fR | |
419 | and \fI\e*\fR will match the single character \fI*\fR and will not be | |
420 | interpreted as a wildcard character. One solution to this problem is | |
421 | to use the Unix style forward slash as a path separator. Windows style | |
422 | paths can be converted to Unix style paths with the command \fBfile | |
423 | join $path\fR (or \fBfile normalize $path\fR in Tcl 8.4). | |
424 | .TP | |
425 | \fBMacintosh\fR | |
426 | . | |
427 | When using the options, \fB\-directory\fR, \fB\-join\fR or \fB\-path\fR, glob | |
428 | assumes the directory separator for the entire pattern is the standard | |
429 | ``:''. When not using these options, glob examines each pattern argument | |
430 | and uses ``/'' unless the pattern contains a ``:''. | |
431 | .SH EXAMPLES | |
432 | Find all the Tcl files in the current directory: | |
433 | .CS | |
434 | \fBglob\fR *.tcl | |
435 | .CE | |
436 | .PP | |
437 | Find all the Tcl files in the user's home directory, irrespective of | |
438 | what the current directory is: | |
439 | .CS | |
440 | \fBglob\fR \-directory ~ *.tcl | |
441 | .CE | |
442 | .PP | |
443 | Find all subdirectories of the current directory: | |
444 | .CS | |
445 | \fBglob\fR \-type d * | |
446 | .CE | |
447 | .PP | |
448 | Find all files whose name contains an "a", a "b" or the sequence "cde": | |
449 | .CS | |
450 | \fBglob\fR \-type f *{a,b,cde}* | |
451 | .CE | |
452 | ||
453 | .SH "SEE ALSO" | |
454 | file(n) | |
455 | ||
456 | .SH KEYWORDS | |
457 | exist, file, glob, pattern |