diff options
author | Richard M. Stallman <rms@gnu.org> | 2003-08-06 01:28:35 +0000 |
---|---|---|
committer | Richard M. Stallman <rms@gnu.org> | 2003-08-06 01:28:35 +0000 |
commit | 104ad648645ec53bd6d2497be86b7bce62b945dc (patch) | |
tree | 5de8173e88e857f3f2a74afe94d8448317ae7112 /lispref/files.texi | |
parent | a756468d977f42ea99130622b9472374309ee1dd (diff) | |
download | emacs-104ad648645ec53bd6d2497be86b7bce62b945dc.tar.gz |
(Magic File Names): Add file-remote-p. Clarify file-local-copy.
Diffstat (limited to 'lispref/files.texi')
-rw-r--r-- | lispref/files.texi | 23 |
1 files changed, 15 insertions, 8 deletions
diff --git a/lispref/files.texi b/lispref/files.texi index c594f0a78a0..24059df24ab 100644 --- a/lispref/files.texi +++ b/lispref/files.texi @@ -2461,15 +2461,22 @@ for comparison with @code{inhibit-file-name-operation}. @end defun @defun file-local-copy filename -This function copies file @var{filename} to an ordinary non-magic file, -if it isn't one already. - -If @var{filename} specifies a magic file name, which programs -outside Emacs cannot directly read or write, this copies the contents to -an ordinary file and returns that file's name. +This function copies file @var{filename} to an ordinary non-magic file +on the local machine, if it isn't on the local machine already. Magic +file names should handle the @code{file-local-copy} operation if they +refer to files on other machines. A magic file name that is used for +other purposes than remote file access should not handle +@code{file-local-copy}; then this function will treat the file as +local. + +If @var{filename} is local, whether magic or not, this function does +nothing and returns @code{nil}. Otherwise it returns the file name +of the local copy file. +@end defun -If @var{filename} is an ordinary file name, not magic, then this function -does nothing and returns @code{nil}. +@defun file-remote-p filename +This functions return @code{t} if @var{filename} is a remote file---that is, +a magic file name that handles @code{file-local-copy}. @end defun @defun unhandled-file-name-directory filename |