File: glob.3

package info (click to toggle)
manpages-es 1.24a-6
  • links: PTS
  • area: main
  • in suites: potato
  • size: 4,256 kB
  • ctags: 7
  • sloc: makefile: 66; sh: 62
file content (260 lines) | stat: -rw-r--r-- 7,008 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
.\" (c) 1993 by Thomas Koenig (ig25@rz.uni-karlsruhe.de)
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one
.\" 
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\" 
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\" License.
.\" Modified Wed Jul 28 11:12:17 1993 by Rik Faith (faith@cs.unc.edu)
.\" Modified Mon May 13 23:08:50 1996 by Martin Schulze (joey@linux.de)
.\" Translated into Spanish Wed Feb 25 21:09:30 CET 1998 by Gerardo
.\" Aburruzaga Garca <gerardo.aburruzaga@uca.es>
.\" Modified 11 May 1998 by Joseph S. Myers (jsm28@cam.ac.uk)
.\" Translation revised Tue Aug 18 1998 by Juan Piernas <piernas@ditec.um.es>
.\"
.TH GLOB 3  "11 Mayo 1998" "GNU" "Manual del Programador de Linux"
.SH NOMBRE
glob, globfree \- encuentra nombres de caminos que concuerdan con un
patrn, libera la memoria ocupada por glob()
.SH SINOPSIS
.nf
.B #include <glob.h>
.sp
.BI "int glob(const char *" patron ", int " flags ","
.nl
.BI "         int " funcerr "(const char * " epath ", int " eerrno ),
.nl
.BI "         glob_t " "*pglob" );
.nl
.BI "void globfree(glob_t *" pglob ");"
.fi
.SH DESCRIPCIN
La funcin
.B glob()
busca todos los nombres de camino de los ficheros que concuerden con
.I patron
segn las reglas usadas por el interprete de comandos o shell.
No se realiza ni expansin de la tilde (~) ni sustitucin
de parmetros; si quiere esto, use
.BR wordexp (3).
.PP
La funcin
.B globfree()
libera el almacenamiento alojado dinmicamente en una llamada anterior
a
.BR glob() .
.PP
Los resultados de una llamada a
.B glob()
se guardan en la estructura a la que apunte
.IR pglob ,
que es un
.B glob_t
que se declara en
.B <glob.h>
e incluye los siguientes elementos definidos por POSIX.2 (se pueden
presentar ms como extensiones GNU):
.PP
.br
.nf
.in 10
typedef struct
{
.in 14
    int gl_pathc;    /* N de caminos concordantes hasta ahora  */
    char **gl_pathv; /* Lista de los caminos concordantes.  */
    int gl_offs;     /* Sitios a reservar en `gl_pathv'.  */
.in 10
} glob_t;
.fi
.PP
Los resultados se almacenan en memoria obtenida dinmicamente.
.PP
El parmetro
.I flags
se construye mediante un \fBO\fR-lgico
de cero o ms de las constantes simblicas siguientes, que modifican el
comportamiento de
.BR glob() :
.TP
.B GLOB_ERR
que significa regresar en cuanto haya un error de lectura (porque un
directorio no haya concedido permiso de lectura, por ejemplo),
.TP
.B GLOB_MARK
que quiere decir aadir una barra inclinada a cada camino que
corresponda a un directorio,
.TP
.B GLOB_NOSORT
que quiere decir no ordenar los nombres de caminos devueltos (se
ordenan si no se dice nada),
.TP
.B GLOB_DOOFS
que quiere decir que se reservarn
.I pglob->gl_offs
sitios al principio de la lista de cadenas de caracteres en
.IR pglob->pathv ,
.TP
.B GLOB_NOCHECK
que quiere decir que, si ningn patrn concuerda, hay que devolver el
patrn original.
.TP
.B GLOB_APPEND
que quiere decir aadir a los resultados de una llamada anterior. No
active esta opcin la primera vez que llame a
.BR glob() .
.TP
.B GLOB_NOESCAPE
que quiere decir que los meta-caracteres no pueden ser protegidos por
barras inclinadas invertidas.
.PP
Las opciones tambin pueden incluir algunas de las siguientes constantes,
que son extensiones GNU no definidar por POSIX.2:
.TP
.B GLOB_PERIOD
que quiere decir que un punto inicial puede concordar con
meta-caracteres,
.TP
.B GLOB_ALTDIRFUNC
que quiere decir que se usen las funciones alternativas
.IR pglob->gl_closedir ,
.IR pglob->gl_readdir ,
.IR pglob->gl_opendir ,
.I pglob->gl_lstat
y
.I pglob->gl_stat
para acceder al sistema de ficheros, en lugar de las funciones normales de
biblioteca,
.TP
.B GLOB_BRACE
que quiere decir que se expandan las expresiones de llaves \fB{a,b}\fR
al estilo
.BR csh (1).
.TP
.B GLOB_NOMAGIC
que quiere decir que se devuelva el patrn si no contiene meta-caracteres,
.TP
.B GLOB_TILDE
que indica que se lleve a cabo la expansin de la tilde (~), y
.TP
.B GLOB_ONLYDIR
que significa que slo se tengan en cuenta los directorios.
.PP
Si
.I funcerr
no es
.BR NULL ,
se llamar en caso de error con los argumentos
.IR epath ,
un puntero al camino que ha fallado, y
.IR eerrno ,
el valor de
.I errno
segn es devuelto por una de las llamadas a
.BR opendir() ", " readdir() ", o " stat() .
Si
.I funcerr
devuelve no cero, o si
.B GLOB_ERR
est activado,
.B glob()
terminar justo tras la llamada a
.IR funcerr .
.PP
Tras un regreso con xito de la funcin,
.I pglob->gl_pathc
contiene el nmero de nombres de caminos que han concordado y
.I pglob->gl_pathv
un puntero a la lista de nombres de caminos que han concordado. El
primer puntero tras el ltimo nombre de camino es
.BR NULL .
.PP
Es posible el llamar a
.B glob()
varias veces. En ese caso, la opcin
.B GLOB_APPEND
tiene que estar activa en
.I flags
en la segunda llamada y posteriores.
.PP
Como extensin GNU, a
.I pglob->gl_flags
se le asignan las opciones especificadas, operadas mediante un
\fBO\fR-lgico con
.B GLOB_MAGCHAR
si se encontr cualquier meta-carcter.
.SH "VALOR DEVUELTO"
Tras una terminacin con xito,
.B glob()
devuelve cero.
Otras posibles devoluciones son:
.TP
.B GLOB_NOSPACE
si no tenemos bastante memoria,
.TP
.B GLOB_ABORT
para un error de lectura, y
.TP
.B GLOB_NOMATCH
si no se ha encontrado nada.
.SH "EJEMPLOS"
Un ejemplo del modo de empleo es el siguiente cdigo, que simula la
orden 
.nl
.B ls -l *.c ../*.c
.nl
en el shell.
.nf
.in 10

glob_t globbuf;

globbuf.gl_offs = 2;
glob("*.c", GLOB_DOOFS, NULL, &globbuf);
glob("../*.c", GLOB_DOOFS | GLOB_APPEND, NULL, &globbuf);
globbuf.gl_pathv[0] = "ls";
globbuf.gl_pathv[1] = "-l";
execvp("ls", &globbuf.gl_pathv[0]);
.fi
.SH "CONFORME A"
POSIX.2
.SH "FALLOS"
La funcin
.B glob()
puede fallar debido a un error en las funciones subyacentes, como 
.BR malloc() " u " opendir() .
stas guardarn su cdigo de error en
.IR errno .
.PP
Los elementos de estructura
.I gl_pathc
y
.I gl_offs
se deberan declarar como
.BR size_t ,
de acuerdo a POSIX.2, pero se declaran como
.BR int .
.SH "VASE TAMBIN"
.BR ls (1),
.BR sh (1),
.BR stat (2),
.BR exec (3),
.BR malloc (3),
.BR opendir (3),
.BR readdir (3),
.BR wordexp (3),