Document GLOB_ONLYDIR.
authordrepper <drepper>
Fri, 31 Oct 1997 22:43:54 +0000 (22:43 +0000)
committerdrepper <drepper>
Fri, 31 Oct 1997 22:43:54 +0000 (22:43 +0000)
manual/pattern.texi

index 596b72d..0fc5e81 100644 (file)
@@ -466,6 +466,21 @@ glob ("~homer/bin/*", GLOB_TILDE, NULL, &result)
 @end smallexample
 
 This functionality is equivalent to what is available in C-shells.
+
+@comment glob.h
+@comment GNU
+@item GLOB_ONLYDIR
+If this flag is used the globbing function takes this as a
+@strong{hint} that the caller is only interested in directories
+matching the pattern.  If the information about the type of the file
+is easily available non-directories will be rejected but no extra
+work will be done to determine the information for each file.  I.e.,
+the caller must still be able to filter directories out.
+
+This functionality is only available witht eh GNU @code{glob}
+implementation.  It is mainly used internally to increase the
+performance but might be useful for a user as well and therefore is
+documented here.
 @end table
 
 Calling @code{glob} will in most cases allocate resources which are used