diff options
Diffstat (limited to 'doc/glob.n')
| -rw-r--r-- | doc/glob.n | 69 |
1 files changed, 63 insertions, 6 deletions
@@ -5,10 +5,10 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: glob.n,v 1.5 1999/11/19 06:33:58 hobbs Exp $ +'\" RCS: @(#) $Id: glob.n,v 1.6 1999/12/12 22:46:38 hobbs Exp $ '\" .so man.macros -.TH glob n 8.1 Tcl "Tcl Built-In Commands" +.TH glob n 8.3 Tcl "Tcl Built-In Commands" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME @@ -26,11 +26,70 @@ of the \fIpattern\fR arguments. If the initial arguments to \fBglob\fR start with \fB\-\fR then they are treated as switches. The following switches are currently supported: -.TP 15 +.VS 8.3 +.TP +\fB\-directory\fR \fIdirectory\fR +Search for files which match the given patterns starting in the given +\fIdirectory\fR. This allows searching of directories whose name +contains glob-sensitive characters without the need to quote such +characters explicitly. This option may not be used in conjunction with +\fB\-path\fR. +.TP +\fB\-join\fR +The remaining pattern arguments are treated as a single pattern +obtained by joining the arguments with directory separators. +.VE 8.3 +.TP \fB\-nocomplain\fR Allows an empty list to be returned without error; without this switch an error is returned if the result list would be empty. -.TP 15 +.VS 8.3 +.TP +\fB\-path\fR \fIpathPrefix\fR +Search for files with the given \fIpathPrefix\fR where the rest of the name +matches the given patterns. This allows searching for files with names +similar to a given file even when the names contain glob-sensitive +characters. This option may not be used in conjunction with +\fB\-directory\fR. +.TP +\fB\-types\fR \fItypeList\fR +Only list files or directories which match \fItypeList\fR, where the items +in the list have two forms. The first form is like the \-type option of +the Unix find command: +\fIb\fR (block special file), +\fIc\fR (character special file), +\fId\fR (directory), +\fIf\fR (plain file), +\fIl\fR (symbolic link), +\fIp\fR (named pipe), +or \fIs\fR (socket), where multiple types may be specified in the list. +\fBGlob\fR will return all files which match at least one of the types given. +.RS +.PP +The second form specifies types where all the types given must match. +These are \fIr\fR, \fIw\fR, \fIx\fR as file permissions, and +\fIreadonly\fR, \fIhidden\fR as special permission cases. On the +Macintosh, MacOS types and creators are also supported, where any item +which is four characters long is assumed to be a MacOS type +(e.g. \fBTEXT\fR). Items which are of the form \fI{macintosh type XXXX}\fR +or \fI{macintosh creator XXXX}\fR will match types or creators +respectively. Unrecognised types, or specifications of multiple MacOS +types/creators will signal an error. +.PP +The two forms may be mixed, so \fB\-types {d f r w}\fR will find all +regular files OR directories that have both read AND write permissions. +The following are equivalent: +.RS +.CS +\fBglob \-type d *\fR +\fBglob */\fR +.CE +.RE +except that the first case doesn't return the trailing ``/'' and +is more platform independent. +.RE +.VE 8.3 +.TP \fB\-\|\-\fR Marks the end of switches. The argument following this one will be treated as a \fIpattern\fR even if it starts with a \fB\-\fR. @@ -77,7 +136,6 @@ Unlike other Tcl commands that will accept both network and native style names (see the \fBfilename\fR manual entry for details on how native and network names are specified), the \fBglob\fR command only accepts native names. -.VS 8.1 .TP \fBWindows\fR . @@ -88,7 +146,6 @@ directory of the user whose account information resides on the specified NT domain server. Otherwise, user account information is obtained from the local computer. On Windows 95 and 98, \fBglob\fR accepts patterns like ``.../'' and ``..../'' for successively higher up parent directories. -.VE .SH KEYWORDS exist, file, glob, pattern |