diff options
| author | Michael Albinus | 2018-11-24 14:01:36 +0100 |
|---|---|---|
| committer | Michael Albinus | 2018-11-24 14:01:36 +0100 |
| commit | a7d9c38da52f413410e17a65d1e90b89edb6cbc4 (patch) | |
| tree | cc5b65b86be9b631f416c1f1ae48eb7693d31e0b /doc/misc | |
| parent | 5f9b29673fa29d27b7c165ecd5bbc7c3c06b138b (diff) | |
| download | emacs-a7d9c38da52f413410e17a65d1e90b89edb6cbc4.tar.gz emacs-a7d9c38da52f413410e17a65d1e90b89edb6cbc4.zip | |
Add Tramp rclone method
* doc/misc/tramp.texi (Top): Remove "History".
(History): Remove node.
(Quick Start Guide): New section "Using rclone".
(External methods) <rclone>: Describe.
* etc/NEWS: Mention Tramp rclone method.
* lisp/net/tramp-rclone.el: New file.
Diffstat (limited to 'doc/misc')
| -rw-r--r-- | doc/misc/tramp.texi | 81 |
1 files changed, 54 insertions, 27 deletions
diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi index 5a375b120de..d5a45ad27c6 100644 --- a/doc/misc/tramp.texi +++ b/doc/misc/tramp.texi | |||
| @@ -86,7 +86,6 @@ Archive}. | |||
| 86 | For the end user: | 86 | For the end user: |
| 87 | 87 | ||
| 88 | * Obtaining @value{tramp}:: How to obtain @value{tramp}. | 88 | * Obtaining @value{tramp}:: How to obtain @value{tramp}. |
| 89 | * History:: History of @value{tramp}. | ||
| 90 | @ifset installchapter | 89 | @ifset installchapter |
| 91 | * Installation:: Installing @value{tramp} with your Emacs. | 90 | * Installation:: Installing @value{tramp} with your Emacs. |
| 92 | @end ifset | 91 | @end ifset |
| @@ -379,32 +378,6 @@ $ autoconf | |||
| 379 | @end example | 378 | @end example |
| 380 | 379 | ||
| 381 | 380 | ||
| 382 | @node History | ||
| 383 | @chapter History of @value{tramp} | ||
| 384 | @cindex history | ||
| 385 | @cindex development history | ||
| 386 | |||
| 387 | @value{tramp} development started at the end of November 1998 as | ||
| 388 | @file{rssh.el}. It provided only one method of access. It used | ||
| 389 | @command{ssh} for login and @command{scp} to transfer file contents. | ||
| 390 | The name was changed to @file{rcp.el} before it got its present name | ||
| 391 | @value{tramp}. New methods of remote access were added, so was support | ||
| 392 | for version control. | ||
| 393 | |||
| 394 | April 2000 was the first time when multi-hop methods were added. In | ||
| 395 | July 2002, @value{tramp} unified file names with Ange FTP@. In July | ||
| 396 | 2004, proxy hosts replaced multi-hop methods. Running commands on | ||
| 397 | remote hosts was introduced in December 2005. Support for gateways | ||
| 398 | since April 2007 (and removed in December 2016). GVFS integration | ||
| 399 | started in February 2009. Remote commands on MS Windows hosts since | ||
| 400 | September 2011. Ad-hoc multi-hop methods (with a changed syntax) | ||
| 401 | re-enabled in November 2011. In November 2012, added Juergen | ||
| 402 | Hoetzel's @file{tramp-adb.el}. Archive file names are supported since | ||
| 403 | December 2017. | ||
| 404 | |||
| 405 | XEmacs support was stopped in January 2016. Since March 2017, | ||
| 406 | @value{tramp} syntax mandates a method. | ||
| 407 | |||
| 408 | @c Installation chapter is necessary only in case of standalone | 381 | @c Installation chapter is necessary only in case of standalone |
| 409 | @c installation. Text taken from trampinst.texi. | 382 | @c installation. Text taken from trampinst.texi. |
| 410 | @ifset installchapter | 383 | @ifset installchapter |
| @@ -562,6 +535,18 @@ be accessed via the @command{adb} command. No user or host name is | |||
| 562 | needed. The file name syntax is @file{@trampfn{adb,,/path/to/file}}. | 535 | needed. The file name syntax is @file{@trampfn{adb,,/path/to/file}}. |
| 563 | 536 | ||
| 564 | 537 | ||
| 538 | @anchor{Quick Start Guide: @option{rclone} method} | ||
| 539 | @section Using @command{rclone} | ||
| 540 | @cindex method @option{rclone} | ||
| 541 | @cindex @option{rclone} method | ||
| 542 | |||
| 543 | A convenient way to access system storages is the @command{rclone} | ||
| 544 | program. If you have configured a storage in @command{rclone} under a | ||
| 545 | name @samp{storage} (for example), you could access it via the remote | ||
| 546 | file name syntax @file{@trampfn{rclone,storage,/path/to/file}}. User | ||
| 547 | names are not needed. | ||
| 548 | |||
| 549 | |||
| 565 | @node Configuration | 550 | @node Configuration |
| 566 | @chapter Configuring @value{tramp} | 551 | @chapter Configuring @value{tramp} |
| 567 | @cindex configuration | 552 | @cindex configuration |
| @@ -1054,6 +1039,48 @@ specified using @file{device#42} host name syntax or @value{tramp} can | |||
| 1054 | use the default value as declared in @command{adb} command. Port | 1039 | use the default value as declared in @command{adb} command. Port |
| 1055 | numbers are not applicable to Android devices connected through USB@. | 1040 | numbers are not applicable to Android devices connected through USB@. |
| 1056 | 1041 | ||
| 1042 | |||
| 1043 | @item @option{rclone} | ||
| 1044 | @cindex method @option{rclone} | ||
| 1045 | @cindex @option{rclone} method | ||
| 1046 | |||
| 1047 | @vindex tramp-rclone-program | ||
| 1048 | The program @command{rclone} allows to access different system | ||
| 1049 | storages in the cloud, see @url{https://rclone.org/} for a list of | ||
| 1050 | supported systems. If the @command{rclone} program isn't found in | ||
| 1051 | your @env{PATH} environment variable, you can tell Tramp its absolute | ||
| 1052 | path via the user option @code{tramp-rclone-program}. | ||
| 1053 | |||
| 1054 | A system storage must be configured via the @command{rclone config} | ||
| 1055 | command, outside Emacs. If you have configured a storage in | ||
| 1056 | @command{rclone} under a name @samp{storage} (for example), you could | ||
| 1057 | access it via the remote file name | ||
| 1058 | |||
| 1059 | @example | ||
| 1060 | @trampfn{rclone,storage,/path/to/file} | ||
| 1061 | @end example | ||
| 1062 | |||
| 1063 | User names are part of the @command{rclone} configuration, and not | ||
| 1064 | needed in the remote file name. If a user name is contained in the | ||
| 1065 | remote file name, it is ignored. | ||
| 1066 | |||
| 1067 | Internally, Tramp mounts the remote system storage at location | ||
| 1068 | @file{/tmp/tramp.rclone.storage}, with @file{storage} being the name | ||
| 1069 | of the configured system storage. | ||
| 1070 | |||
| 1071 | Optional flags to the different @option{rclone} operations could be | ||
| 1072 | passed as connection property, @xref{Predefined connection | ||
| 1073 | information}. Supported properties are @samp{mount-args}, | ||
| 1074 | @samp{copyto-args} and @samp{moveto-args}. | ||
| 1075 | |||
| 1076 | Access via @option{rclone} is slow. If you have an alternative method | ||
| 1077 | for accessing the system storage, you shall prefer this. @ref{GVFS | ||
| 1078 | based methods} for example, methods @option{gdrive} and | ||
| 1079 | @option{nextcloud}. | ||
| 1080 | |||
| 1081 | @strong{Note}: The @option{rclone} method is experimental, don't use | ||
| 1082 | it in production systems! | ||
| 1083 | |||
| 1057 | @end table | 1084 | @end table |
| 1058 | 1085 | ||
| 1059 | 1086 | ||