diff options
| author | Eli Zaretskii <eliz@gnu.org> | 2005-05-06 13:08:15 +0000 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2005-05-06 13:08:15 +0000 |
| commit | c7c4bc11b1dbc9e17919788a409cd3ceb120f615 (patch) | |
| tree | 385552fce8b242103ab7f442b19803a99a41bc72 /lisp/files.el | |
| parent | 57a131fbc05820ea8afe802d61a95d6a0a2f4a09 (diff) | |
| download | emacs-c7c4bc11b1dbc9e17919788a409cd3ceb120f615.tar.gz | |
(locate-file): Doc fix.
Diffstat (limited to 'lisp/files.el')
| -rw-r--r-- | lisp/files.el | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/lisp/files.el b/lisp/files.el index ea4799968fe..e74e1adcf3d 100644 --- a/lisp/files.el +++ b/lisp/files.el @@ -632,8 +632,13 @@ The path separator is colon in GNU and GNU-like systems." (defun locate-file (filename path &optional suffixes predicate) "Search for FILENAME through PATH. +If found, return the absolute file name of FILENAME, with its suffixes; +otherwise return nil. +PATH should be a list of directories to look in, like the lists in +`exec-path' or `load-path'. If SUFFIXES is non-nil, it should be a list of suffixes to append to file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\"). +Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES. If non-nil, PREDICATE is used instead of `file-readable-p'. PREDICATE can also be an integer to pass to the `access' system call, in which case file-name handlers are ignored. This usage is deprecated. |