raw/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 '\"
   8 '\" RCS: @(#) $Id: glob.n,v 1.1 2003/12/20 03:31:54 bbbush 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: glob.n,v 1.1 2003/12/20 03:31:54 bbbush 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.
 272 .TP
 273 \fB\-join\fR
 274 The remaining pattern arguments are treated as a single pattern
 275 obtained by joining the arguments with directory separators.
 276 .VE 8.3
 277 .TP
 278 \fB\-nocomplain\fR
 279 Allows an empty list to be returned without error;  without this
 280 switch an error is returned if the result list would be empty.
 281 .VS 8.3
 282 .TP
 283 \fB\-path\fR \fIpathPrefix\fR
 284 Search for files with the given \fIpathPrefix\fR where the rest of the name
 285 matches the given patterns.  This allows searching for files with names
 286 similar to a given file even when the names contain glob-sensitive
 287 characters.  This option may not be used in conjunction with
 288 \fB\-directory\fR.
 289 .TP
 290 \fB\-types\fR \fItypeList\fR
 291 Only list files or directories which match \fItypeList\fR, where the items
 292 in the list have two forms.  The first form is like the \-type option of
 293 the Unix find command:
 294 \fIb\fR (block special file),
 295 \fIc\fR (character special file),
 296 \fId\fR (directory),
 297 \fIf\fR (plain file),
 298 \fIl\fR (symbolic link),
 299 \fIp\fR (named pipe),
 300 or \fIs\fR (socket), where multiple types may be specified in the list.
 301 \fBGlob\fR will return all files which match at least one of the types given.
 302 .RS
 303 .PP
 304 The second form specifies types where all the types given must match.
 305 These are \fIr\fR, \fIw\fR, \fIx\fR as file permissions, and
 306 \fIreadonly\fR, \fIhidden\fR as special permission cases.  On the
 307 Macintosh, MacOS types and creators are also supported, where any item
 308 which is four characters long is assumed to be a MacOS type
 309 (e.g. \fBTEXT\fR).  Items which are of the form \fI{macintosh type XXXX}\fR
 310 or \fI{macintosh creator XXXX}\fR will match types or creators
 311 respectively.  Unrecognised types, or specifications of multiple MacOS
 312 types/creators will signal an error.
 313 .PP
 314 The two forms may be mixed, so \fB\-types {d f r w}\fR will find all
 315 regular files OR directories that have both read AND write permissions.
 316 The following are equivalent:
 317 .RS
 318 .CS
 319 \fBglob \-type d *\fR
 320 \fBglob */\fR
 321 .CE
 322 .RE
 323 except that the first case doesn't return the trailing ``/'' and
 324 is more platform independent.
 325 .RE
 326 .VE 8.3
 327 .TP
 328 \fB\-\|\-\fR
 329 Marks the end of switches.  The argument following this one will
 330 be treated as a \fIpattern\fR even if it starts with a \fB\-\fR.
 331 .PP
 332 The \fIpattern\fR arguments may contain any of the following
 333 special characters:
 334 .TP 10
 335 \fB?\fR
 336 Matches any single character.
 337 .TP 10
 338 \fB*\fR
 339 Matches any sequence of zero or more characters.
 340 .TP 10
 341 \fB[\fIchars\fB]\fR
 342 Matches any single character in \fIchars\fR.  If \fIchars\fR
 343 contains a sequence of the form \fIa\fB\-\fIb\fR then any
 344 character between \fIa\fR and \fIb\fR (inclusive) will match.
 345 .TP 10
 346 \fB\e\fIx\fR
 347 Matches the character \fIx\fR.
 348 .TP 10
 349 \fB{\fIa\fB,\fIb\fB,\fI...\fR}
 350 Matches any of the strings \fIa\fR, \fIb\fR, etc.
 351 .LP
 352 As with csh, a  ``.'' at the beginning of a file's name or just
 353 after a ``/'' must be matched explicitly or with a {} construct.
 354 In addition, all ``/'' characters must be matched explicitly.
 355 .LP
 356 If the first character in a \fIpattern\fR is ``~'' then it refers
 357 to the home directory for the user whose name follows the ``~''.
 358 If the ``~'' is followed immediately by ``/'' then the value of
 359 the HOME environment variable is used.
 360 .LP
 361 The \fBglob\fR command differs from csh globbing in two ways.
 362 First, it does not sort its result list (use the \fBlsort\fR
 363 command if you want the list sorted).
 364 Second, \fBglob\fR only returns the names of files that actually
 365 exist;  in csh no check for existence is made unless a pattern
 366 contains a ?, *, or [] construct.
 367
 368 .SH "PORTABILITY ISSUES"
 369 .PP
 370 Unlike other Tcl commands that will accept both network and native
 371 style names (see the \fBfilename\fR manual entry for details on how
 372 native and network names are specified), the \fBglob\fR command only
 373 accepts native names.
 374 .TP
 375 \fBWindows\fR
 376 .
 377 For Windows UNC names, the servername and sharename components of the path
 378 may not contain ?, *, or [] constructs.  On Windows NT, if \fIpattern\fR is
 379 of the form ``\fB~\fIusername\fB@\fIdomain\fR'' it refers to the home
 380 directory of the user whose account information resides on the specified NT
 381 domain server.  Otherwise, user account information is obtained from
 382 the local computer.  On Windows 95 and 98, \fBglob\fR accepts patterns
 383 like ``.../'' and ``..../'' for successively higher up parent directories.
 384 .TP
 385 \fBMacintosh\fR
 386 .
 387 When using the options, \fB\-dir\fR, \fB\-join\fR or \fB\-path\fR, glob
 388 assumes the directory separator for the entire pattern is the standard
 389 ``:''.  When not using these options, glob examines each pattern argument
 390 and uses ``/'' unless the pattern contains a ``:''.
 391
 392 .SH "SEE ALSO"
 393 file(n)
 394
 395 .SH KEYWORDS
 396 exist, file, glob, pattern