Seth Woolley's Man Viewer

Manual for glob - man n glob

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

glob(1,3,7,n)(n)                      Tcl Built-In Commands                     glob(1,3,7,n)(n)



NAME
       glob(1,3,7,n) - Return names of files that match patterns

SYNOPSIS
       glob(1,3,7,n) ?switches? pattern ?pattern ...?


DESCRIPTION
       This  command  performs  file(1,n) name ``globbing'' in(1,8) a fashion similar to
       the csh shell.  It returns a list of the files whose names match any of
       the pattern arguments.

       If  the initial arguments to glob(1,3,7,n) start with - then they are treated as
       switches.  The following switches are currently supported:

       -directory directory
              Search for files which match the given patterns starting in(1,8)  the
              given  directory.   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(1,8) conjunction with -path, which is used to allow searching  for
              complete file(1,n) paths whose names may contain glob-sensitive char-
              acters.

       -join  The remaining pattern arguments are treated as a single  pattern
              obtained by joining the arguments with directory separators.

       -nocomplain
              Allows an empty list to be returned without error(8,n);  without this
              switch(1,n) an error(8,n) is returned if(3,n) the result list would be empty.

       -path pathPrefix
              Search for files with the given pathPrefix where the rest of the
              name  matches  the  given  patterns.   This allows searching for
              files with names similar to a given file(1,n) (as opposed to a direc-
              tory)  even  when  the  names contain glob-sensitive characters.
              This option may not be used in(1,8) conjunction with -directory.  For
              example, to find all files with the same root name as $path, but
              differing extensions, you should use glob(1,3,7,n) -path  [file(1,n)  rootname
              $path]  .* which will work even if(3,n) $path contains numerous glob-
              sensitive characters.

       -tails Only return the part of each file(1,n) found which follows  the  last
              directory  named(5,8)  in(1,8) any -directory or -path path specification.
              Thus glob(1,3,7,n) -tails -directory $dir *  is  equivalent  to  set(7,n,1 builtins)  pwd(1,n,1 builtins)
              [pwd(1,n,1 builtins)]  ;  cd  $dir ; glob(1,3,7,n) *; cd $pwd(1,n,1 builtins).  For -path specifications,
              the returned names will include the last path segment,  so  glob(1,3,7,n)
              -tails  -path  [file(1,n)  rootname  ~/foo.tex] .*  will return paths
              like foo.aux foo.bib foo.tex etc.

       -types typeList
              Only list files or directories which match typeList,  where  the
              items  in(1,8)  the  list have two forms.  The first form is like the
              -type option of the Unix find command: b (block special file(1,n)), c
              (character special file(1,n)), d (directory), f (plain file(1,n)), l (sym-
              bolic link(1,2)), p (named(5,8) pipe(2,8)), or s (socket(2,7,n)), where multiple types
              may  be specified in(1,8) the list.  Glob will return all files which
              match at least one of the types given.

              The second form specifies types where all the types  given  must
              match.   These  are  r,  w, x as file(1,n) permissions, and readonly,
              hidden 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.  TEXT).
              Items  which are of the form {macintosh type XXXX} or {macintosh
              creator XXXX} will match types or creators respectively.  Unrec-
              ognized  types,  or  specifications of multiple MacOS types/cre-
              ators will signal(2,7) an error.

              The two forms may be mixed, so -types {d f r w}  will  find  all
              regular  files OR directories that have both read(2,n,1 builtins) AND write(1,2) per-
              missions.  The following are equivalent:
                     glob(1,3,7,n) -type d * glob(1,3,7,n) */
              except that the first case doesn't return the trailing ``/'' and
              is more platform independent.

       --     Marks the end of switches.  The argument following this one will
              be treated as a pattern even if(3,n) it starts with a -.

       The pattern arguments may contain any of the following special  charac-
       ters:

       ?         Matches any single character.

       *         Matches any sequence of zero or more characters.

       [chars]   Matches  any  single character in(1,8) chars.  If chars contains a
                 sequence of the form a-b then any character between a  and  b
                 (inclusive) will match.

       \x        Matches the character x.

       {a,b,...} Matches any of the strings a, b, etc.

       On Unix, as with csh, a ``.'' at the beginning of a file(1,n)'s name or just
       after a ``/'' must be matched explicitly or with a {} construct, unless
       the  ``-types hidden'' flag is given (since ``.'' at the beginning of a
       file(1,n)'s name indicates that it is hidden).  On  other  platforms,  files
       beginning with a ``.'' are handled no differently to any others, except
       the special directories ``.'' and ``..'' which must be matched  explic-
       itly  (this is to avoid a recursive pattern like ``glob(1,3,7,n) -join * * * *''
       from recursing up the directory hierarchy as well as down).   In  addi-
       tion, all ``/'' characters must be matched explicitly.

       If the first character in(1,8) a pattern is ``~'' then it refers to the home
       directory for the user whose name follows the ``~''.  If the  ``~''  is
       followed  immediately  by  ``/'' then the value of the HOME environment
       variable is used.

       The glob(1,3,7,n) command differs from csh globbing in(1,8) two ways.  First, it does
       not  sort(1,3)  its  result list (use the lsort command if(3,n) you want the list
       sorted).  Second, glob(1,3,7,n) only returns the names of  files  that  actually
       exist;  in(1,8) csh no check for existence is made unless a pattern contains
       a ?, *, or [] construct.


PORTABILITY ISSUES
       Unlike other Tcl commands that will  accept(2,8)  both  network  and  native
       style  names  (see  the filename manual entry for details on how native
       and network names are specified), the glob(1,3,7,n) command only accepts  native
       names.

       Windows
              For  Windows  UNC names, the servername and sharename components
              of the path may not contain ?, *, or [] constructs.  On  Windows
              NT,  if(3,n) pattern is of the form ``~username@domain'' it refers to
              the home 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,  glob(1,3,7,n)  accepts patterns like ``.../'' and ``..../'' for
              successively higher up parent directories.

              Since the backslash character has a special meaning to the  glob(1,3,7,n)
              command,  glob(1,3,7,n) patterns containing Windows style path separators
              need special care. The  pattern  C:\\foo\\*  is  interpreted  as
              C:\foo\*  where \f will match the single character f and \* will
              match the single character * and will not be  interpreted  as  a
              wildcard  character.  One solution to this problem is to use the
              Unix style forward slash as  a  path  separator.  Windows  style
              paths can be converted to Unix style paths with the command file(1,n)
              join(1,n) $path (or file(1,n) normalize $path in(1,8) Tcl 8.4).

       Macintosh
              When using the options, -directory, -join or -path, glob(1,3,7,n) assumes
              the  directory  separator for the entire pattern is the standard
              ``:''.  When not using these options, glob(1,3,7,n) examines each pattern
              argument and uses ``/'' unless the pattern contains a ``:''.


SEE ALSO
       file(1,n)(n)


KEYWORDS
       exist, file(1,n), glob(1,3,7,n), pattern



Tcl                                   8.3                              glob(1,3,7,n)(n)

References for this manual (incoming links)