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. All advertising materials mentioning features or use of this software
15 .\" must display the following acknowledgement:
16 .\" This product includes software developed by the University of
17 .\" California, Berkeley and its contributors.
18 .\" 4. Neither the name of the University nor the names of its contributors
19 .\" may be used to endorse or promote products derived from this software
20 .\" without specific prior written permission.
22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 .\" @(#)glob.3 8.3 (Berkeley) 4/16/94
43 .Nd generate pathnames matching a pattern
47 .Fn glob "const char *pattern" "int flags" "int (*errfunc)(const char *, int)" "glob_t *pglob"
49 .Fn globfree "glob_t *pglob"
54 is a pathname generator that implements the rules for file name pattern
55 matching used by the shell.
59 defines the structure type
61 which contains at least the following fields:
64 int gl_pathc; /* count of total paths so far */
65 int gl_matchc; /* count of paths matching pattern */
66 int gl_offs; /* reserved at beginning of gl_pathv */
67 int gl_flags; /* returned flags */
68 char **gl_pathv; /* list of paths matching pattern */
74 is a pointer to a pathname pattern to be expanded.
78 matches all accessible pathnames against the pattern and creates
79 a list of the pathnames that match.
80 In order to have access to a pathname,
82 requires search permission on every component of a path except the last
83 and read permission on each directory of any filename component of
85 that contains any of the special characters
94 stores the number of matched pathnames into the
96 field, and a pointer to a list of pointers to pathnames into the
99 The first pointer after the last pathname is
101 If the pattern does not match any pathnames, the returned number of
102 matched paths is set to zero.
104 It is the caller's responsibility to create the structure pointed to by
108 function allocates other space as needed, including the memory pointed
114 is used to modify the behavior of
118 is the bitwise inclusive
120 of any of the following
123 .Bl -tag -width GLOB_ALTDIRFUNC
125 Append pathnames generated to the ones from a previous call (or calls)
130 will be the total matches found by this call and the previous call(s).
131 The pathnames are appended to, not merged with the pathnames returned by
132 the previous call(s).
133 Between calls, the caller must not change the setting of the
135 flag, nor change the value of
139 is set, nor (obviously) call
149 is used to specify how many
151 pointers to prepend to the beginning
163 pathname pointers, followed by a
169 to return when it encounters a directory that it cannot open or read.
172 continues to find matches.
174 Each pathname that is a directory that matches
181 does not match any pathname, then
186 with the number of total pathnames is set to 1, and the number of matched
190 is set, its effect is present in the pattern returned.
192 By default, the pathnames are sorted in ascending
195 this flag prevents that sorting (speeding up
199 The following values may also be included in
201 however, they are non-standard extensions to
203 .Bl -tag -width GLOB_ALTDIRFUNC
204 .It Dv GLOB_ALTDIRFUNC
205 The following additional fields in the pglob structure have been
206 initialized with alternate functions for glob to use to open, read,
207 and close directories and to get stat information on names found
208 in those directories.
210 void *(*gl_opendir)(const char * name);
211 struct dirent *(*gl_readdir)(void *);
212 void (*gl_closedir)(void *);
213 int (*gl_lstat)(const char *name, struct stat *st);
214 int (*gl_stat)(const char *name, struct stat *st);
217 This extension is provided to allow programs such as
219 to provide globbing from directories stored on tape.
221 Pre-process the pattern string to expand
227 is left unexpanded for historical reasons (and
229 does the same thing to
237 function if the pattern included globbing characters.
238 See the description of the usage of the
240 structure member for more details.
244 but it only appends the
246 if it does not contain any of the special characters ``*'', ``?'' or ``[''.
248 is provided to simplify implementing the historic
250 globbing behavior and should probably not be used anywhere else.
254 character for quoting: every occurrence of
255 a backslash followed by a character in the pattern is replaced by that
256 character, avoiding any special interpretation of the character.
258 Expand patterns that start with
260 to user name home directories.
263 If, during the search, a directory is encountered that cannot be opened
270 .Fa (*errfunc)(path, errno) .
271 This may be unintuitive: a pattern like
278 is not a directory, resulting in a
281 The error routine can suppress this action by testing for
287 flag will still cause an immediate
288 return when this happens.
294 stops the scan and returns
300 to reflect any paths already matched.
301 This also happens if an error is encountered and
305 regardless of the return value of
310 is not set and either
316 returns zero, the error is ignored.
320 function frees any space associated with
322 from a previous call(s) to
325 On successful completion,
328 In addition the fields of
330 contain the values described below:
331 .Bl -tag -width GLOB_NOCHECK
333 contains the total number of matched pathnames so far.
334 This includes other matches from previous invocations of
340 contains the number of matched pathnames in the current invocation of
343 contains a copy of the
345 parameter with the bit
349 contained any of the special characters ``*'', ``?'' or ``['', cleared
352 contains a pointer to a
353 .Dv NULL Ns -terminated
354 list of matched pathnames.
357 is zero, the contents of
364 terminates due to an error, it sets errno and returns one of the
365 following non-zero constants, which are defined in the include
368 .Bl -tag -width GLOB_NOCHECK
370 An attempt to allocate memory failed.
372 The scan was stopped because an error was encountered and either
383 are still set as specified above.
385 A rough equivalent of
387 can be obtained with the
389 .Bd -literal -offset indent
393 glob("*.c", GLOB_DOOFFS, NULL, &g);
394 glob("*.h", GLOB_DOOFFS | GLOB_APPEND, NULL, &g);
395 g.gl_pathv[0] = "ls";
396 g.gl_pathv[1] = "-l";
397 execvp("ls", g.gl_pathv);
406 function is expected to be
408 compatible with the exception
421 should not be used by applications striving for strict
429 functions first appeared in
434 may cause unchecked errors.
439 may fail and set errno for any of the errors specified for the
projects / FreeBSD / FreeBSD.git / blob