]>
Commit | Line | Data |
---|---|---|
bf5a7247 | 1 | .\" Copyright (c) 1993 by Thomas Koenig (ig25@rz.uni-karlsruhe.de) |
fea681da | 2 | .\" |
93015253 | 3 | .\" %%%LICENSE_START(VERBATIM) |
fea681da MK |
4 | .\" Permission is granted to make and distribute verbatim copies of this |
5 | .\" manual provided the copyright notice and this permission notice are | |
6 | .\" preserved on all copies. | |
7 | .\" | |
8 | .\" Permission is granted to copy and distribute modified versions of this | |
9 | .\" manual under the conditions for verbatim copying, provided that the | |
10 | .\" entire resulting derived work is distributed under the terms of a | |
11 | .\" permission notice identical to this one. | |
c13182ef | 12 | .\" |
fea681da MK |
13 | .\" Since the Linux kernel and libraries are constantly changing, this |
14 | .\" manual page may be incorrect or out-of-date. The author(s) assume no | |
15 | .\" responsibility for errors or omissions, or for damages resulting from | |
16 | .\" the use of the information contained herein. The author(s) may not | |
17 | .\" have taken the same level of care in the production of this manual, | |
18 | .\" which is licensed free of charge, as they might when working | |
19 | .\" professionally. | |
c13182ef | 20 | .\" |
fea681da MK |
21 | .\" Formatted or processed versions of this manual, if unaccompanied by |
22 | .\" the source, must acknowledge the copyright and authors of this work. | |
4b72fb64 | 23 | .\" %%%LICENSE_END |
c08df37a | 24 | .\" |
fea681da MK |
25 | .\" Modified Wed Jul 28 11:12:17 1993 by Rik Faith (faith@cs.unc.edu) |
26 | .\" Modified Mon May 13 23:08:50 1996 by Martin Schulze (joey@linux.de) | |
27 | .\" Modified 11 May 1998 by Joseph S. Myers (jsm28@cam.ac.uk) | |
28 | .\" Modified 990912 by aeb | |
7c2cb022 MK |
29 | .\" 2007-10-10 mtk |
30 | .\" Added description of GLOB_TILDE_NOMATCH | |
31 | .\" Expanded the description of various flags | |
32 | .\" Various wording fixes. | |
fea681da | 33 | .\" |
7c2cb022 | 34 | .TH GLOB 3 2007-10-10 "GNU" "Linux Programmer's Manual" |
fea681da MK |
35 | .SH NAME |
36 | glob, globfree \- find pathnames matching a pattern, free memory from glob() | |
37 | .SH SYNOPSIS | |
38 | .nf | |
39 | .B #include <glob.h> | |
40 | .sp | |
41 | .BI "int glob(const char *" pattern ", int " flags , | |
defcceb3 | 42 | .br |
69f8784e | 43 | .BI " int (*" errfunc ") (const char *" epath ", int " eerrno ), |
defcceb3 | 44 | .br |
fea681da | 45 | .BI " glob_t *" pglob ); |
defcceb3 | 46 | .br |
fea681da MK |
47 | .BI "void globfree(glob_t *" pglob ); |
48 | .fi | |
49 | .SH DESCRIPTION | |
50 | The | |
63aa9df0 | 51 | .BR glob () |
fea681da MK |
52 | function searches for all the pathnames matching |
53 | .I pattern | |
54 | according to the rules used by the shell (see | |
55 | .BR glob (7)). | |
56 | No tilde expansion or parameter substitution is done; if you want | |
57 | these, use | |
58 | .BR wordexp (3). | |
59 | .PP | |
60 | The | |
63aa9df0 | 61 | .BR globfree () |
fea681da MK |
62 | function frees the dynamically allocated storage from an earlier call |
63 | to | |
63aa9df0 | 64 | .BR glob (). |
fea681da MK |
65 | .PP |
66 | The results of a | |
63aa9df0 | 67 | .BR glob () |
fea681da | 68 | call are stored in the structure pointed to by |
7c2cb022 MK |
69 | .IR pglob . |
70 | This structure is of type | |
f19a0f03 | 71 | .I glob_t |
7c2cb022 MK |
72 | (declared in |
73 | .IR <glob.h> ) | |
fea681da MK |
74 | and includes the following elements defined by POSIX.2 (more may be |
75 | present as an extension): | |
76 | .PP | |
77 | .br | |
088a639b | 78 | .in +4n |
fea681da | 79 | .nf |
b9f02710 MK |
80 | typedef struct { |
81 | size_t gl_pathc; /* Count of paths matched so far */ | |
82 | char **gl_pathv; /* List of matched pathnames. */ | |
a40ee90b | 83 | size_t gl_offs; /* Slots to reserve in \fIgl_pathv\fP. */ |
fea681da MK |
84 | } glob_t; |
85 | .fi | |
088a639b | 86 | .in |
fea681da MK |
87 | .PP |
88 | Results are stored in dynamically allocated storage. | |
89 | .PP | |
c4bb193f | 90 | The argument |
fea681da | 91 | .I flags |
7c2cb022 MK |
92 | is made up of the bitwise OR of zero or more the following symbolic |
93 | constants, which modify the behavior of | |
63aa9df0 | 94 | .BR glob (): |
fea681da MK |
95 | .TP |
96 | .B GLOB_ERR | |
7c2cb022 MK |
97 | Return upon a read error (because a directory does not |
98 | have read permission, for example). | |
99 | By default, | |
100 | .BR glob () | |
38f76cd2 | 101 | attempts carry on despite errors, |
7c2cb022 | 102 | reading all of the directories that it can. |
fea681da MK |
103 | .TP |
104 | .B GLOB_MARK | |
7c2cb022 | 105 | Append a slash to each path which corresponds to a directory. |
fea681da MK |
106 | .TP |
107 | .B GLOB_NOSORT | |
7c2cb022 MK |
108 | Don't sort the returned pathnames. |
109 | The only reason to do this is to save processing time. | |
110 | By default, the returned pathnames are sorted. | |
fea681da MK |
111 | .TP |
112 | .B GLOB_DOOFFS | |
7c2cb022 | 113 | Reserve |
94e9d9fe | 114 | .I pglob\->gl_offs |
7c2cb022 | 115 | slots at the beginning of the list of strings in |
94e9d9fe | 116 | .IR pglob\->pathv . |
7c2cb022 | 117 | The reserved slots contain NULL pointers. |
fea681da MK |
118 | .TP |
119 | .B GLOB_NOCHECK | |
7c2cb022 MK |
120 | If no pattern matches, return the original pattern. |
121 | By default, | |
122 | .BR glob () | |
123 | returns | |
124 | .B GLOB_NOMATCH | |
125 | if there are no matches. | |
fea681da MK |
126 | .TP |
127 | .B GLOB_APPEND | |
7c2cb022 MK |
128 | Append the results of this call to the vector of results |
129 | returned by a previous call to | |
130 | .BR glob (). | |
c13182ef | 131 | Do not set this flag on the first invocation of |
63aa9df0 | 132 | .BR glob (). |
fea681da MK |
133 | .TP |
134 | .B GLOB_NOESCAPE | |
f81fb444 | 135 | Don't allow backslash (\(aq\\\(aq) to be used as an escape |
7c2cb022 MK |
136 | character. |
137 | Normally, a backslash can be used to quote the following character, | |
138 | providing a mechanism to turn off the special meaning | |
139 | metacharacters. | |
fea681da | 140 | .PP |
7c2cb022 MK |
141 | .I flags |
142 | may also include any of the following, which are GNU | |
fea681da MK |
143 | extensions and not defined by POSIX.2: |
144 | .TP | |
145 | .B GLOB_PERIOD | |
7c2cb022 MK |
146 | Allow a leading period to be matched by metacharacters. |
147 | By default, metacharacters can't match a leading period. | |
fea681da MK |
148 | .TP |
149 | .B GLOB_ALTDIRFUNC | |
7c2cb022 | 150 | Use alternative functions |
94e9d9fe MK |
151 | .IR pglob\->gl_closedir , |
152 | .IR pglob\->gl_readdir , | |
153 | .IR pglob\->gl_opendir , | |
154 | .IR pglob\->gl_lstat ", and" | |
155 | .I pglob\->gl_stat | |
7c2cb022 MK |
156 | for file system access instead of the normal library |
157 | functions. | |
fea681da MK |
158 | .TP |
159 | .B GLOB_BRACE | |
7c2cb022 | 160 | Expand |
fea681da | 161 | .BR csh (1) |
7c2cb022 MK |
162 | style brace expressions of the form \fB{a,b}\fR. |
163 | Brace expressions can be nested. | |
164 | Thus, for example, specifying the pattern | |
165 | "{foo/{,cat,dog},bar}" would return the same results as four separate | |
166 | .BR glob () | |
167 | calls using the strings: | |
168 | "foo/", | |
169 | "foo/cat", | |
170 | "foo/dog", | |
171 | and | |
172 | "bar". | |
fea681da MK |
173 | .TP |
174 | .B GLOB_NOMAGIC | |
7c2cb022 MK |
175 | If the pattern contains no metacharacters |
176 | then it should be returned as the sole matching word, | |
177 | even if there is no file with that name. | |
fea681da MK |
178 | .TP |
179 | .B GLOB_TILDE | |
7c2cb022 | 180 | Carry out tilde expansion. |
f81fb444 MK |
181 | If a tilde (\(aq~\(aq) is the only character in the pattern, |
182 | or an initial tilde is followed immediately by a slash (\(aq/\(aq), | |
7c2cb022 MK |
183 | then the home directory of the caller is substituted for |
184 | the tilde. | |
185 | If an initial tilde is followed by a username (e.g., "~andrea/bin"), | |
186 | then the tilde and username are substituted by the home directory | |
187 | of that user. | |
188 | If the username is invalid, or the home directory cannot be | |
189 | determined, then no substitution is performed. | |
190 | .TP | |
191 | .B GLOB_TILDE_CHECK | |
192 | This provides behavior similar to that of | |
193 | .BR GLOB_TILDE . | |
194 | The difference is that if the username is invalid, or the | |
195 | home directory cannot be determined, then | |
196 | instead of using the pattern itself as the name, | |
197 | .BR glob () | |
198 | returns | |
199 | .BR GLOB_NOMATCH | |
200 | to indicate an error. | |
fea681da MK |
201 | .TP |
202 | .B GLOB_ONLYDIR | |
38f76cd2 | 203 | This is a |
7c2cb022 MK |
204 | .I hint |
205 | to | |
206 | .BR glob () | |
207 | that the caller is interested only in directories that match the pattern. | |
208 | If the implementation can easily determine file-type information, | |
24b74457 | 209 | then nondirectory files are not returned to the caller. |
7c2cb022 MK |
210 | However, the caller must still check that returned files |
211 | are directories. | |
212 | (The purpose of this flag is merely to optimize performance when | |
ed145e47 | 213 | the caller is interested only in directories.) |
fea681da MK |
214 | .PP |
215 | If | |
216 | .I errfunc | |
8478ee02 | 217 | is not NULL, |
fea681da MK |
218 | it will be called in case of an error with the arguments |
219 | .IR epath , | |
220 | a pointer to the path which failed, and | |
221 | .IR eerrno , | |
222 | the value of | |
223 | .I errno | |
224 | as returned from one of the calls to | |
91fe9d5c MK |
225 | .BR opendir (3), |
226 | .BR readdir (3), | |
c13182ef | 227 | or |
91fe9d5c | 228 | .BR stat (2). |
c13182ef | 229 | If |
fea681da | 230 | .I errfunc |
c7094399 | 231 | returns nonzero, or if |
fea681da | 232 | .B GLOB_ERR |
c13182ef | 233 | is set, |
63aa9df0 | 234 | .BR glob () |
fea681da MK |
235 | will terminate after the call to |
236 | .IR errfunc . | |
237 | .PP | |
c13182ef | 238 | Upon successful return, |
94e9d9fe | 239 | .I pglob\->gl_pathc |
fea681da | 240 | contains the number of matched pathnames and |
94e9d9fe | 241 | .I pglob\->gl_pathv |
7c2cb022 MK |
242 | contains a pointer to the list of pointers to matched pathnames. |
243 | The list of pointers is terminated by a NULL pointer. | |
fea681da MK |
244 | .PP |
245 | It is possible to call | |
63aa9df0 | 246 | .BR glob () |
c13182ef MK |
247 | several times. |
248 | In that case, the | |
fea681da MK |
249 | .B GLOB_APPEND |
250 | flag has to be set in | |
251 | .I flags | |
252 | on the second and later invocations. | |
253 | .PP | |
254 | As a GNU extension, | |
94e9d9fe | 255 | .I pglob\->gl_flags |
fea681da MK |
256 | is set to the flags specified, \fBor\fRed with |
257 | .B GLOB_MAGCHAR | |
258 | if any metacharacters were found. | |
47297adb | 259 | .SH RETURN VALUE |
c13182ef | 260 | On successful completion, |
63aa9df0 | 261 | .BR glob () |
fea681da MK |
262 | returns zero. |
263 | Other possible returns are: | |
264 | .TP | |
265 | .B GLOB_NOSPACE | |
266 | for running out of memory, | |
267 | .TP | |
268 | .B GLOB_ABORTED | |
269 | for a read error, and | |
270 | .TP | |
271 | .B GLOB_NOMATCH | |
272 | for no found matches. | |
47297adb | 273 | .SH CONFORMING TO |
2b2581ee MK |
274 | POSIX.2, POSIX.1-2001. |
275 | .SH NOTES | |
276 | The structure elements | |
277 | .I gl_pathc | |
278 | and | |
279 | .I gl_offs | |
280 | are declared as | |
0daa9e92 | 281 | .I size_t |
7c2cb022 | 282 | in glibc 2.1, as they should be according to POSIX.2, |
2b2581ee MK |
283 | but are declared as |
284 | .I int | |
285 | in libc4, libc5 and glibc 2.0. | |
286 | .SH BUGS | |
287 | The | |
288 | .BR glob () | |
289 | function may fail due to failure of underlying function calls, such as | |
290 | .BR malloc (3) | |
291 | or | |
292 | .BR opendir (3). | |
293 | These will store their error code in | |
294 | .IR errno . | |
9b336505 | 295 | .SH EXAMPLE |
fea681da | 296 | One example of use is the following code, which simulates typing |
defcceb3 | 297 | .sp |
296d592b MK |
298 | .in +4n |
299 | ls \-l *.c ../*.c | |
300 | .in | |
defcceb3 MK |
301 | .sp |
302 | in the shell: | |
fea681da | 303 | .nf |
296d592b | 304 | .in +4n |
fea681da MK |
305 | |
306 | glob_t globbuf; | |
307 | ||
308 | globbuf.gl_offs = 2; | |
309 | glob("*.c", GLOB_DOOFFS, NULL, &globbuf); | |
310 | glob("../*.c", GLOB_DOOFFS | GLOB_APPEND, NULL, &globbuf); | |
311 | globbuf.gl_pathv[0] = "ls"; | |
8c383102 | 312 | globbuf.gl_pathv[1] = "\-l"; |
fea681da | 313 | execvp("ls", &globbuf.gl_pathv[0]); |
088a639b | 314 | .in |
fea681da | 315 | .fi |
47297adb | 316 | .SH SEE ALSO |
fea681da MK |
317 | .BR ls (1), |
318 | .BR sh (1), | |
319 | .BR stat (2), | |
320 | .BR exec (3), | |
2ff9c803 | 321 | .BR fnmatch (3), |
fea681da MK |
322 | .BR malloc (3), |
323 | .BR opendir (3), | |
324 | .BR readdir (3), | |
325 | .BR wordexp (3), | |
326 | .BR glob (7) |