diff options
Diffstat (limited to 'doc/misc/tramp.texi')
| -rw-r--r-- | doc/misc/tramp.texi | 110 |
1 files changed, 56 insertions, 54 deletions
diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi index d48fa319fb2..e6a454be4c8 100644 --- a/doc/misc/tramp.texi +++ b/doc/misc/tramp.texi @@ -125,7 +125,7 @@ Configuring @value{tramp} for use * Connection types:: Types of connections to remote hosts. * Inline methods:: Inline methods. * External methods:: External methods. -* GVFS based methods:: GVFS based external methods. +* GVFS-based methods:: @acronym{GVFS}-based external methods. * Default Method:: Selecting a default method. * Default User:: Selecting a default user. * Default Host:: Selecting a default host. @@ -545,9 +545,9 @@ of the local file name is the share exported by the remote host, @anchor{Quick Start Guide: GVFS-based methods} -@section Using GVFS-based methods +@section Using @acronym{GVFS}-based methods @cindex methods, gvfs -@cindex gvfs based methods +@cindex gvfs-based methods @cindex method @option{sftp} @cindex @option{sftp} method @cindex method @option{afp} @@ -557,10 +557,9 @@ of the local file name is the share exported by the remote host, @cindex @option{dav} method @cindex @option{davs} method -On systems, which have installed the virtual file system for the -@acronym{GNOME} Desktop (GVFS), its offered methods could be used by -@value{tramp}. Examples are -@file{@trampfn{sftp,user@@host,/path/to/file}}, +On systems, which have installed @acronym{GVFS, the GNOME Virtual File +System}, its offered methods could be used by @value{tramp}. Examples +are @file{@trampfn{sftp,user@@host,/path/to/file}}, @file{@trampfn{afp,user@@host,/path/to/file}} (accessing Apple's AFP file system), @file{@trampfn{dav,user@@host,/path/to/file}} and @file{@trampfn{davs,user@@host,/path/to/file}} (for WebDAV shares). @@ -576,10 +575,10 @@ file system), @file{@trampfn{dav,user@@host,/path/to/file}} and @cindex @option{nextcloud} method @cindex nextcloud -GVFS-based methods include also @acronym{GNOME} Online Accounts, which -support the @option{Files} service. These are the Google Drive file -system, and the OwnCloud/NextCloud file system. The file name syntax -is here always +@acronym{GVFS}-based methods include also @acronym{GNOME} Online +Accounts, which support the @option{Files} service. These are the +Google Drive file system, and the OwnCloud/NextCloud file system. The +file name syntax is here always @file{@trampfn{gdrive,john.doe@@gmail.com,/path/to/file}} (@samp{john.doe@@gmail.com} stands here for your Google Drive account), or @file{@trampfn{nextcloud,user@@host#8081,/path/to/file}} @@ -645,7 +644,7 @@ might be used in your init file: * Connection types:: Types of connections to remote hosts. * Inline methods:: Inline methods. * External methods:: External methods. -* GVFS based methods:: GVFS based external methods. +* GVFS-based methods:: @acronym{GVFS}-based external methods. * Default Method:: Selecting a default method. Here we also try to help those who don't have the foggiest which method @@ -1170,8 +1169,8 @@ information}. Supported properties are @samp{mount-args}, @samp{copyto-args} and @samp{moveto-args}. Access via @option{rclone} is slow. If you have an alternative method -for accessing the system storage, you shall prefer this. @ref{GVFS -based methods} for example, methods @option{gdrive} and +for accessing the system storage, you shall prefer this. +@ref{GVFS-based methods} for example, methods @option{gdrive} and @option{nextcloud}. @strong{Note}: The @option{rclone} method is experimental, don't use @@ -1180,20 +1179,20 @@ it in production systems! @end table -@node GVFS based methods -@section GVFS based external methods +@node GVFS-based methods +@section @acronym{GVFS}-based external methods @cindex methods, gvfs -@cindex gvfs based methods +@cindex gvfs-based methods @cindex dbus -GVFS is the virtual file system for the @acronym{GNOME} Desktop, -@uref{https://en.wikipedia.org/wiki/GVFS}. Remote files on GVFS are -mounted locally through FUSE and @value{tramp} uses this locally -mounted directory internally. +@acronym{GVFS} is the virtual file system for the @acronym{GNOME} +Desktop, @uref{https://en.wikipedia.org/wiki/GVFS}. Remote files on +@acronym{GVFS} are mounted locally through FUSE and @value{tramp} uses +this locally mounted directory internally. -Emacs uses the D-Bus mechanism to communicate with GVFS@. Emacs must -have the message bus system, D-Bus integration active, @pxref{Top, , -D-Bus, dbus}. +Emacs uses the D-Bus mechanism to communicate with @acronym{GVFS}@. +Emacs must have the message bus system, D-Bus integration active, +@pxref{Top, , D-Bus, dbus}. @table @asis @item @option{afp} @@ -1216,9 +1215,10 @@ syntax requires a leading volume (share) name, for example: based on standard protocols, such as HTTP@. @option{davs} does the same but with SSL encryption. Both methods support the port numbers. -Paths being part of the WebDAV volume to be mounted by GVFS, as it is -common for OwnCloud or NextCloud file names, are not supported by -these methods. See method @option{nextcloud} for handling them. +Paths being part of the WebDAV volume to be mounted by @acronym{GVFS}, +as it is common for OwnCloud or NextCloud file names, are not +supported by these methods. See method @option{nextcloud} for +handling them. @item @option{gdrive} @cindex method @option{gdrive} @@ -1259,18 +1259,19 @@ that for security reasons refuse @command{ssh} connections. @end table @defopt tramp-gvfs-methods -This user option is a list of external methods for GVFS@. By default, -this list includes @option{afp}, @option{dav}, @option{davs}, -@option{gdrive}, @option{nextcloud} and @option{sftp}. Other methods -to include are @option{ftp}, @option{http}, @option{https} and -@option{smb}. These methods are not intended to be used directly as -GVFS based method. Instead, they are added here for the benefit of -@ref{Archive file names}. - -If you want to use GVFS-based @option{ftp} or @option{smb} methods, -you must add them to @code{tramp-gvfs-methods}, and you must disable -the corresponding Tramp package by setting @code{tramp-ftp-method} or -@code{tramp-smb-method} to @code{nil}, respectively: +This user option is a list of external methods for @acronym{GVFS}@. +By default, this list includes @option{afp}, @option{dav}, +@option{davs}, @option{gdrive}, @option{nextcloud} and @option{sftp}. +Other methods to include are @option{ftp}, @option{http}, +@option{https} and @option{smb}. These methods are not intended to be +used directly as @acronym{GVFS}-based method. Instead, they are added +here for the benefit of @ref{Archive file names}. + +If you want to use @acronym{GVFS}-based @option{ftp} or @option{smb} +methods, you must add them to @code{tramp-gvfs-methods}, and you must +disable the corresponding Tramp package by setting +@code{tramp-ftp-method} or @code{tramp-smb-method} to @code{nil}, +respectively: @lisp @group @@ -2937,9 +2938,10 @@ host when the variable @code{default-directory} is remote: @end group @end lisp -Remote processes do not apply to GVFS (see @ref{GVFS based methods}) -because the remote file system is mounted on the local host and -@value{tramp} just accesses by changing the @code{default-directory}. +Remote processes do not apply to @acronym{GVFS} (see @ref{GVFS-based +methods}) because the remote file system is mounted on the local host +and @value{tramp} just accesses by changing the +@code{default-directory}. @value{tramp} starts a remote process when a command is executed in a remote file or directory buffer. As of now, these packages have been @@ -3323,10 +3325,10 @@ killing all buffers related to remote connections. @cindex archive method @value{tramp} offers also transparent access to files inside file -archives. This is possible only on machines which have installed the -virtual file system for the @acronym{GNOME} Desktop (GVFS), @ref{GVFS -based methods}. Internally, file archives are mounted via the GVFS -@option{archive} method. +archives. This is possible only on machines which have installed +@acronym{GVFS, the GNOME Virtual File System}, @ref{GVFS-based +methods}. Internally, file archives are mounted via the +@acronym{GVFS} @option{archive} method. A file archive is a regular file of kind @file{/path/to/dir/file.EXT}. The extension @samp{.EXT} identifies the type of the file archive. A @@ -3349,9 +3351,9 @@ file names as well. @vindex tramp-archive-suffixes File archives are identified by the file name extension @samp{.EXT}. -Since GVFS uses internally the library @code{libarchive(3)}, all -suffixes, which are accepted by this library, work also for archive -file names. Accepted suffixes are listed in the constant +Since @acronym{GVFS} uses internally the library @code{libarchive(3)}, +all suffixes, which are accepted by this library, work also for +archive file names. Accepted suffixes are listed in the constant @code{tramp-archive-suffixes}. They are @itemize @@ -3519,11 +3521,11 @@ row are possible, like @file{/path/to/dir/file.tar.gz.uu/dir/file}. @vindex tramp-archive-all-gvfs-methods An archive file name could be a remote file name, as in @file{/ftp:anonymous@@ftp.gnu.org:/gnu/tramp/tramp-2.3.2.tar.gz/INSTALL}. -Since all file operations are mapped internally to GVFS operations, -remote file names supported by @code{tramp-gvfs} perform better, -because no local copy of the file archive must be downloaded first. -For example, @samp{/sftp:user@@host:...} performs better than the -similar @samp{/scp:user@@host:...}. See the constant +Since all file operations are mapped internally to @acronym{GVFS} +operations, remote file names supported by @code{tramp-gvfs} perform +better, because no local copy of the file archive must be downloaded +first. For example, @samp{/sftp:user@@host:...} performs better than +the similar @samp{/scp:user@@host:...}. See the constant @code{tramp-archive-all-gvfs-methods} for a complete list of @code{tramp-gvfs} supported method names. |