1 .\" Copyright (c) 1989, 1991, 1993, 1994
2 .\" The Regents of the University of California. All rights reserved.
4 .\" This code is derived from software contributed to Berkeley by
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of the University nor the names of its contributors
15 .\" may be used to endorse or promote products derived from this software
16 .\" without specific prior written permission.
18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 .Nd generate pathnames matching a pattern
42 .Fn glob "const char * restrict pattern" "int flags" "int (*errfunc)(const char *, int)" "glob_t * restrict pglob"
44 .Fn globfree "glob_t *pglob"
49 is a pathname generator that implements the rules for file name pattern
50 matching used by the shell.
54 defines the structure type
56 which contains at least the following fields:
59 size_t gl_pathc; /* count of total paths so far */
60 size_t gl_matchc; /* count of paths matching pattern */
61 size_t gl_offs; /* reserved at beginning of gl_pathv */
62 int gl_flags; /* returned flags */
63 char **gl_pathv; /* list of paths matching pattern */
69 is a pointer to a pathname pattern to be expanded.
73 matches all accessible pathnames against the pattern and creates
74 a list of the pathnames that match.
75 In order to have access to a pathname,
77 requires search permission on every component of a path except the last
78 and read permission on each directory of any filename component of
80 that contains any of the special characters
89 stores the number of matched pathnames into the
91 field, and a pointer to a list of pointers to pathnames into the
94 The first pointer after the last pathname is
96 If the pattern does not match any pathnames, the returned number of
97 matched paths is set to zero.
99 It is the caller's responsibility to create the structure pointed to by
103 function allocates other space as needed, including the memory pointed
109 is used to modify the behavior of
113 is the bitwise inclusive
115 of any of the following
118 .Bl -tag -width GLOB_ALTDIRFUNC
120 Append pathnames generated to the ones from a previous call (or calls)
125 will be the total matches found by this call and the previous call(s).
126 The pathnames are appended to, not merged with the pathnames returned by
127 the previous call(s).
128 Between calls, the caller must not change the setting of the
130 flag, nor change the value of
134 is set, nor (obviously) call
144 is used to specify how many
146 pointers to prepend to the beginning
158 pathname pointers, followed by a
164 to return when it encounters a directory that it cannot open or read.
167 continues to find matches.
169 Each pathname that is a directory that matches
176 does not match any pathname, then
181 with the number of total pathnames set to 1, and the number of matched
183 The effect of backslash escaping is present in the pattern returned.
185 By default, a backslash
187 character is used to escape the following character in the pattern,
188 avoiding any special interpretation of the character.
191 is set, backslash escaping is disabled.
193 By default, the pathnames are sorted in ascending
196 this flag prevents that sorting (speeding up
200 The following values may also be included in
202 however, they are non-standard extensions to
204 .Bl -tag -width GLOB_ALTDIRFUNC
205 .It Dv GLOB_ALTDIRFUNC
206 The following additional fields in the pglob structure have been
207 initialized with alternate functions for glob to use to open, read,
208 and close directories and to get stat information on names found
209 in those directories.
211 void *(*gl_opendir)(const char * name);
212 struct dirent *(*gl_readdir)(void *);
213 void (*gl_closedir)(void *);
214 int (*gl_lstat)(const char *name, struct stat *st);
215 int (*gl_stat)(const char *name, struct stat *st);
218 This extension is provided to allow programs such as
220 to provide globbing from directories stored on tape.
222 Pre-process the pattern string to expand
228 is left unexpanded for historical reasons (and
230 does the same thing to
238 function if the pattern included globbing characters.
239 See the description of the usage of the
241 structure member for more details.
245 but it only appends the
247 if it does not contain any of the special characters ``*'', ``?'' or ``[''.
249 is provided to simplify implementing the historic
251 globbing behavior and should probably not be used anywhere else.
253 Expand patterns that start with
255 to user name home directories.
257 Limit the total number of returned pathnames to the value provided in
261 This option should be set for programs
262 that can be coerced into a denial of service attack
263 via patterns that expand to a very large number of matches,
264 such as a long string of
268 If, during the search, a directory is encountered that cannot be opened
275 .Fa \*(lp*errfunc\*(rp Ns ( Fa path , errno ) ,
278 flag will cause an immediate
279 return when this happens.
285 stops the scan and returns
291 to reflect any paths already matched.
292 This also happens if an error is encountered and
296 regardless of the return value of
301 is not set and either
307 returns zero, the error is ignored.
311 function frees any space associated with
313 from a previous call(s) to
316 On successful completion,
319 In addition the fields of
321 contain the values described below:
322 .Bl -tag -width GLOB_NOCHECK
324 contains the total number of matched pathnames so far.
325 This includes other matches from previous invocations of
331 contains the number of matched pathnames in the current invocation of
334 contains a copy of the
336 argument with the bit
340 contained any of the special characters ``*'', ``?'' or ``['', cleared
343 contains a pointer to a
344 .Dv NULL Ns -terminated
345 list of matched pathnames.
348 is zero, the contents of
355 terminates due to an error, it sets errno and returns one of the
356 following non-zero constants, which are defined in the include
359 .Bl -tag -width GLOB_NOCHECK
361 An attempt to allocate memory failed, or if
365 was specified in the flags and
366 .Fa pglob\->gl_matchc
367 or more patterns were matched.
369 The scan was stopped because an error was encountered and either
372 .Fa \*(lp*errfunc\*(rp\*(lp\*(rp
375 The pattern did not match a pathname and
384 are still set as specified above.
386 A rough equivalent of
388 can be obtained with the
390 .Bd -literal -offset indent
394 glob("*.c", GLOB_DOOFFS, NULL, &g);
395 glob("*.h", GLOB_DOOFFS | GLOB_APPEND, NULL, &g);
396 g.gl_pathv[0] = "ls";
397 g.gl_pathv[1] = "-l";
398 execvp("ls", g.gl_pathv);
405 The current implementation of the
411 Collating symbol expressions, equivalence class expressions and
412 character class expressions are not supported.
415 .Dv GLOB_ALTDIRFUNC ,
426 are extensions to the
429 should not be used by applications striving for strict
436 functions first appeared in
441 may cause unchecked errors.
446 may fail and set errno for any of the errors specified for the