util/X86LINUX64/man/mann/glob.n

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