aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMichael Albinus2019-08-22 14:50:38 +0200
committerMichael Albinus2019-08-22 14:50:38 +0200
commitef8531d262081d91ecf2a4f349bc63a0fede90d4 (patch)
tree0dc3a9368400613bcbdf5d970116915a0a12fe3c /doc
parente5defc3e0fc753231d04db514d650c731d12bf1e (diff)
downloademacs-ef8531d262081d91ecf2a4f349bc63a0fede90d4.tar.gz
emacs-ef8531d262081d91ecf2a4f349bc63a0fede90d4.zip
* doc/misc/tramp.texi: Use @acronym{GVFS}.
Diffstat (limited to 'doc')
-rw-r--r--doc/misc/tramp.texi110
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
125* Connection types:: Types of connections to remote hosts. 125* Connection types:: Types of connections to remote hosts.
126* Inline methods:: Inline methods. 126* Inline methods:: Inline methods.
127* External methods:: External methods. 127* External methods:: External methods.
128* GVFS based methods:: GVFS based external methods. 128* GVFS-based methods:: @acronym{GVFS}-based external methods.
129* Default Method:: Selecting a default method. 129* Default Method:: Selecting a default method.
130* Default User:: Selecting a default user. 130* Default User:: Selecting a default user.
131* Default Host:: Selecting a default host. 131* Default Host:: Selecting a default host.
@@ -545,9 +545,9 @@ of the local file name is the share exported by the remote host,
545 545
546 546
547@anchor{Quick Start Guide: GVFS-based methods} 547@anchor{Quick Start Guide: GVFS-based methods}
548@section Using GVFS-based methods 548@section Using @acronym{GVFS}-based methods
549@cindex methods, gvfs 549@cindex methods, gvfs
550@cindex gvfs based methods 550@cindex gvfs-based methods
551@cindex method @option{sftp} 551@cindex method @option{sftp}
552@cindex @option{sftp} method 552@cindex @option{sftp} method
553@cindex method @option{afp} 553@cindex method @option{afp}
@@ -557,10 +557,9 @@ of the local file name is the share exported by the remote host,
557@cindex @option{dav} method 557@cindex @option{dav} method
558@cindex @option{davs} method 558@cindex @option{davs} method
559 559
560On systems, which have installed the virtual file system for the 560On systems, which have installed @acronym{GVFS, the GNOME Virtual File
561@acronym{GNOME} Desktop (GVFS), its offered methods could be used by 561System}, its offered methods could be used by @value{tramp}. Examples
562@value{tramp}. Examples are 562are @file{@trampfn{sftp,user@@host,/path/to/file}},
563@file{@trampfn{sftp,user@@host,/path/to/file}},
564@file{@trampfn{afp,user@@host,/path/to/file}} (accessing Apple's AFP 563@file{@trampfn{afp,user@@host,/path/to/file}} (accessing Apple's AFP
565file system), @file{@trampfn{dav,user@@host,/path/to/file}} and 564file system), @file{@trampfn{dav,user@@host,/path/to/file}} and
566@file{@trampfn{davs,user@@host,/path/to/file}} (for WebDAV shares). 565@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
576@cindex @option{nextcloud} method 575@cindex @option{nextcloud} method
577@cindex nextcloud 576@cindex nextcloud
578 577
579GVFS-based methods include also @acronym{GNOME} Online Accounts, which 578@acronym{GVFS}-based methods include also @acronym{GNOME} Online
580support the @option{Files} service. These are the Google Drive file 579Accounts, which support the @option{Files} service. These are the
581system, and the OwnCloud/NextCloud file system. The file name syntax 580Google Drive file system, and the OwnCloud/NextCloud file system. The
582is here always 581file name syntax is here always
583@file{@trampfn{gdrive,john.doe@@gmail.com,/path/to/file}} 582@file{@trampfn{gdrive,john.doe@@gmail.com,/path/to/file}}
584(@samp{john.doe@@gmail.com} stands here for your Google Drive 583(@samp{john.doe@@gmail.com} stands here for your Google Drive
585account), or @file{@trampfn{nextcloud,user@@host#8081,/path/to/file}} 584account), or @file{@trampfn{nextcloud,user@@host#8081,/path/to/file}}
@@ -645,7 +644,7 @@ might be used in your init file:
645* Connection types:: Types of connections to remote hosts. 644* Connection types:: Types of connections to remote hosts.
646* Inline methods:: Inline methods. 645* Inline methods:: Inline methods.
647* External methods:: External methods. 646* External methods:: External methods.
648* GVFS based methods:: GVFS based external methods. 647* GVFS-based methods:: @acronym{GVFS}-based external methods.
649* Default Method:: Selecting a default method. 648* Default Method:: Selecting a default method.
650 Here we also try to help those who 649 Here we also try to help those who
651 don't have the foggiest which method 650 don't have the foggiest which method
@@ -1170,8 +1169,8 @@ information}. Supported properties are @samp{mount-args},
1170@samp{copyto-args} and @samp{moveto-args}. 1169@samp{copyto-args} and @samp{moveto-args}.
1171 1170
1172Access via @option{rclone} is slow. If you have an alternative method 1171Access via @option{rclone} is slow. If you have an alternative method
1173for accessing the system storage, you shall prefer this. @ref{GVFS 1172for accessing the system storage, you shall prefer this.
1174based methods} for example, methods @option{gdrive} and 1173@ref{GVFS-based methods} for example, methods @option{gdrive} and
1175@option{nextcloud}. 1174@option{nextcloud}.
1176 1175
1177@strong{Note}: The @option{rclone} method is experimental, don't use 1176@strong{Note}: The @option{rclone} method is experimental, don't use
@@ -1180,20 +1179,20 @@ it in production systems!
1180@end table 1179@end table
1181 1180
1182 1181
1183@node GVFS based methods 1182@node GVFS-based methods
1184@section GVFS based external methods 1183@section @acronym{GVFS}-based external methods
1185@cindex methods, gvfs 1184@cindex methods, gvfs
1186@cindex gvfs based methods 1185@cindex gvfs-based methods
1187@cindex dbus 1186@cindex dbus
1188 1187
1189GVFS is the virtual file system for the @acronym{GNOME} Desktop, 1188@acronym{GVFS} is the virtual file system for the @acronym{GNOME}
1190@uref{https://en.wikipedia.org/wiki/GVFS}. Remote files on GVFS are 1189Desktop, @uref{https://en.wikipedia.org/wiki/GVFS}. Remote files on
1191mounted locally through FUSE and @value{tramp} uses this locally 1190@acronym{GVFS} are mounted locally through FUSE and @value{tramp} uses
1192mounted directory internally. 1191this locally mounted directory internally.
1193 1192
1194Emacs uses the D-Bus mechanism to communicate with GVFS@. Emacs must 1193Emacs uses the D-Bus mechanism to communicate with @acronym{GVFS}@.
1195have the message bus system, D-Bus integration active, @pxref{Top, , 1194Emacs must have the message bus system, D-Bus integration active,
1196D-Bus, dbus}. 1195@pxref{Top, , D-Bus, dbus}.
1197 1196
1198@table @asis 1197@table @asis
1199@item @option{afp} 1198@item @option{afp}
@@ -1216,9 +1215,10 @@ syntax requires a leading volume (share) name, for example:
1216based on standard protocols, such as HTTP@. @option{davs} does the same 1215based on standard protocols, such as HTTP@. @option{davs} does the same
1217but with SSL encryption. Both methods support the port numbers. 1216but with SSL encryption. Both methods support the port numbers.
1218 1217
1219Paths being part of the WebDAV volume to be mounted by GVFS, as it is 1218Paths being part of the WebDAV volume to be mounted by @acronym{GVFS},
1220common for OwnCloud or NextCloud file names, are not supported by 1219as it is common for OwnCloud or NextCloud file names, are not
1221these methods. See method @option{nextcloud} for handling them. 1220supported by these methods. See method @option{nextcloud} for
1221handling them.
1222 1222
1223@item @option{gdrive} 1223@item @option{gdrive}
1224@cindex method @option{gdrive} 1224@cindex method @option{gdrive}
@@ -1259,18 +1259,19 @@ that for security reasons refuse @command{ssh} connections.
1259@end table 1259@end table
1260 1260
1261@defopt tramp-gvfs-methods 1261@defopt tramp-gvfs-methods
1262This user option is a list of external methods for GVFS@. By default, 1262This user option is a list of external methods for @acronym{GVFS}@.
1263this list includes @option{afp}, @option{dav}, @option{davs}, 1263By default, this list includes @option{afp}, @option{dav},
1264@option{gdrive}, @option{nextcloud} and @option{sftp}. Other methods 1264@option{davs}, @option{gdrive}, @option{nextcloud} and @option{sftp}.
1265to include are @option{ftp}, @option{http}, @option{https} and 1265Other methods to include are @option{ftp}, @option{http},
1266@option{smb}. These methods are not intended to be used directly as 1266@option{https} and @option{smb}. These methods are not intended to be
1267GVFS based method. Instead, they are added here for the benefit of 1267used directly as @acronym{GVFS}-based method. Instead, they are added
1268@ref{Archive file names}. 1268here for the benefit of @ref{Archive file names}.
1269 1269
1270If you want to use GVFS-based @option{ftp} or @option{smb} methods, 1270If you want to use @acronym{GVFS}-based @option{ftp} or @option{smb}
1271you must add them to @code{tramp-gvfs-methods}, and you must disable 1271methods, you must add them to @code{tramp-gvfs-methods}, and you must
1272the corresponding Tramp package by setting @code{tramp-ftp-method} or 1272disable the corresponding Tramp package by setting
1273@code{tramp-smb-method} to @code{nil}, respectively: 1273@code{tramp-ftp-method} or @code{tramp-smb-method} to @code{nil},
1274respectively:
1274 1275
1275@lisp 1276@lisp
1276@group 1277@group
@@ -2937,9 +2938,10 @@ host when the variable @code{default-directory} is remote:
2937@end group 2938@end group
2938@end lisp 2939@end lisp
2939 2940
2940Remote processes do not apply to GVFS (see @ref{GVFS based methods}) 2941Remote processes do not apply to @acronym{GVFS} (see @ref{GVFS-based
2941because the remote file system is mounted on the local host and 2942methods}) because the remote file system is mounted on the local host
2942@value{tramp} just accesses by changing the @code{default-directory}. 2943and @value{tramp} just accesses by changing the
2944@code{default-directory}.
2943 2945
2944@value{tramp} starts a remote process when a command is executed in a 2946@value{tramp} starts a remote process when a command is executed in a
2945remote file or directory buffer. As of now, these packages have been 2947remote file or directory buffer. As of now, these packages have been
@@ -3323,10 +3325,10 @@ killing all buffers related to remote connections.
3323@cindex archive method 3325@cindex archive method
3324 3326
3325@value{tramp} offers also transparent access to files inside file 3327@value{tramp} offers also transparent access to files inside file
3326archives. This is possible only on machines which have installed the 3328archives. This is possible only on machines which have installed
3327virtual file system for the @acronym{GNOME} Desktop (GVFS), @ref{GVFS 3329@acronym{GVFS, the GNOME Virtual File System}, @ref{GVFS-based
3328based methods}. Internally, file archives are mounted via the GVFS 3330methods}. Internally, file archives are mounted via the
3329@option{archive} method. 3331@acronym{GVFS} @option{archive} method.
3330 3332
3331A file archive is a regular file of kind @file{/path/to/dir/file.EXT}. 3333A file archive is a regular file of kind @file{/path/to/dir/file.EXT}.
3332The extension @samp{.EXT} identifies the type of the file archive. A 3334The extension @samp{.EXT} identifies the type of the file archive. A
@@ -3349,9 +3351,9 @@ file names as well.
3349 3351
3350@vindex tramp-archive-suffixes 3352@vindex tramp-archive-suffixes
3351File archives are identified by the file name extension @samp{.EXT}. 3353File archives are identified by the file name extension @samp{.EXT}.
3352Since GVFS uses internally the library @code{libarchive(3)}, all 3354Since @acronym{GVFS} uses internally the library @code{libarchive(3)},
3353suffixes, which are accepted by this library, work also for archive 3355all suffixes, which are accepted by this library, work also for
3354file names. Accepted suffixes are listed in the constant 3356archive file names. Accepted suffixes are listed in the constant
3355@code{tramp-archive-suffixes}. They are 3357@code{tramp-archive-suffixes}. They are
3356 3358
3357@itemize 3359@itemize
@@ -3519,11 +3521,11 @@ row are possible, like @file{/path/to/dir/file.tar.gz.uu/dir/file}.
3519@vindex tramp-archive-all-gvfs-methods 3521@vindex tramp-archive-all-gvfs-methods
3520An archive file name could be a remote file name, as in 3522An archive file name could be a remote file name, as in
3521@file{/ftp:anonymous@@ftp.gnu.org:/gnu/tramp/tramp-2.3.2.tar.gz/INSTALL}. 3523@file{/ftp:anonymous@@ftp.gnu.org:/gnu/tramp/tramp-2.3.2.tar.gz/INSTALL}.
3522Since all file operations are mapped internally to GVFS operations, 3524Since all file operations are mapped internally to @acronym{GVFS}
3523remote file names supported by @code{tramp-gvfs} perform better, 3525operations, remote file names supported by @code{tramp-gvfs} perform
3524because no local copy of the file archive must be downloaded first. 3526better, because no local copy of the file archive must be downloaded
3525For example, @samp{/sftp:user@@host:...} performs better than the 3527first. For example, @samp{/sftp:user@@host:...} performs better than
3526similar @samp{/scp:user@@host:...}. See the constant 3528the similar @samp{/scp:user@@host:...}. See the constant
3527@code{tramp-archive-all-gvfs-methods} for a complete list of 3529@code{tramp-archive-all-gvfs-methods} for a complete list of
3528@code{tramp-gvfs} supported method names. 3530@code{tramp-gvfs} supported method names.
3529 3531