map-over-directory

$Revision: 5.0.2.2 $

Function

Package: EXCL

Arguments: (function directory &key filter prune-directories include-directories)

This function can be used to walk a directory structure rooted at directory. function is applied to each file in the directory, recursively. directory can contain wildcards. This function is called for the side effects of applying function to files (and optionally directories) in directory. No useful value is returned.

If filter is non-nil, then its value should be a function used to filter out candidate files and directories. The filter function takes one argument, a pathname, and returns a non-nil value if function should be called on this file. It does not prevent recursion if the pathname is a directory.

If include-directories is non-nil, then function also gets called on directories.

prune-directories, if specified, must be a list of strings naming directories with no punctuation (i.e. no slashes). Any directory encountered during the operation with that name will be ignored (neither it nor its contents nor its subdirectories will be mapped over). For example, suppose subdirectories foo and bar each have a subdirectory CVS.

:prune-directories '("CVS")

then will cause foo/CVS and bar/CVS both to be ignored. There is no way to have foo/CVS considered and bar/CVS ignored with this argument.

The general documentation description is in introduction.htm. The index is in index.htm.