Mercurial > emacs
comparison lispref/files.texi @ 81762:44be65f35e43
* files.texi (Magic File Names): Introduce optional parameter
CONNECTED for `file-remote-p'.
author | Michael Albinus <michael.albinus@gmx.de> |
---|---|
date | Sun, 08 Jul 2007 18:08:36 +0000 |
parents | 326bae23bda1 |
children | 665f8d0fb99f 988f1edc9674 |
comparison
equal
deleted
inserted
replaced
81761:c8bb24d5506d | 81762:44be65f35e43 |
---|---|
2766 If @var{filename} is local, whether magic or not, this function does | 2766 If @var{filename} is local, whether magic or not, this function does |
2767 nothing and returns @code{nil}. Otherwise it returns the file name | 2767 nothing and returns @code{nil}. Otherwise it returns the file name |
2768 of the local copy file. | 2768 of the local copy file. |
2769 @end defun | 2769 @end defun |
2770 | 2770 |
2771 @defun file-remote-p filename | 2771 @defun file-remote-p filename &optional connected |
2772 This function tests whether @var{filename} is a remote file. If | 2772 This function tests whether @var{filename} is a remote file. If |
2773 @var{filename} is local (not remote), the return value is @code{nil}. | 2773 @var{filename} is local (not remote), the return value is @code{nil}. |
2774 If @var{filename} is indeed remote, the return value is a string that | 2774 If @var{filename} is indeed remote, the return value is a string that |
2775 identifies the remote system. | 2775 identifies the remote system. |
2776 | 2776 |
2777 This identifier string can include a host name and a user name, as | 2777 This identifier string can include a host name and a user name, as |
2778 well as characters designating the method used to access the remote | 2778 well as characters designating the method used to access the remote |
2779 system. For example, the remote identifier string for the filename | 2779 system. For example, the remote identifier string for the filename |
2780 @code{/ssh:user@@host:/some/file} is @code{/ssh:user@@host:}. | 2780 @code{/sudo::/some/file} is @code{/sudo:root@@localhost:}. |
2781 | 2781 |
2782 If @code{file-remote-p} returns the same identifier for two different | 2782 If @code{file-remote-p} returns the same identifier for two different |
2783 filenames, that means they are stored on the same file system and can | 2783 filenames, that means they are stored on the same file system and can |
2784 be accessed locally with respect to each other. This means, for | 2784 be accessed locally with respect to each other. This means, for |
2785 example, that it is possible to start a remote process accessing both | 2785 example, that it is possible to start a remote process accessing both |
2786 files at the same time. Implementors of file handlers need to ensure | 2786 files at the same time. Implementors of file handlers need to ensure |
2787 this principle is valid. | 2787 this principle is valid. |
2788 | |
2789 The optional parameter @var{connected}, when passed non-@code{nil}, | |
2790 triggers an additional check whether the remote system has been | |
2791 connected already. The function returns then @code{nil} if there is | |
2792 no corresponding open connection, even if @var{filename} is remote. | |
2793 This can be used to avoid unnecessary connection attempts. | |
2788 @end defun | 2794 @end defun |
2789 | 2795 |
2790 @defun unhandled-file-name-directory filename | 2796 @defun unhandled-file-name-directory filename |
2791 This function returns the name of a directory that is not magic. It | 2797 This function returns the name of a directory that is not magic. It |
2792 uses the directory part of @var{filename} if that is not magic. For a | 2798 uses the directory part of @var{filename} if that is not magic. For a |