aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Albinus2018-11-16 13:05:49 +0100
committerMichael Albinus2018-11-16 13:05:49 +0100
commitcf7f44d07ed643848b89b03e517efe913250d2ef (patch)
tree1b31709dfaf73515d15e7c9a4f6cb920373c00e8
parent2cf9d9fed7de87a7b78fbc75a67a71fff00e8ffc (diff)
downloademacs-cf7f44d07ed643848b89b03e517efe913250d2ef.tar.gz
emacs-cf7f44d07ed643848b89b03e517efe913250d2ef.zip
Mention ELPA packages which add new methods to Tramp
* doc/misc/tramp.texi (Customizing Methods): Mention ELPA packages which add new methods to Tramp.
-rw-r--r--doc/misc/tramp.texi70
1 files changed, 69 insertions, 1 deletions
diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi
index 874c1da1d9f..8cd0a72fc8c 100644
--- a/doc/misc/tramp.texi
+++ b/doc/misc/tramp.texi
@@ -1491,6 +1491,74 @@ predefined methods. Any part of this list can be modified with more
1491suitable settings. Refer to the Lisp documentation of that variable, 1491suitable settings. Refer to the Lisp documentation of that variable,
1492accessible with @kbd{C-h v tramp-methods @key{RET}}. 1492accessible with @kbd{C-h v tramp-methods @key{RET}}.
1493 1493
1494In the ELPA archives, there are several examples of such extensions.
1495They can be installed with Emacs' Package Manager. This includes
1496
1497@table @samp
1498@c @item anything-tramp
1499@c @item counsel-tramp
1500@c @item helm-tramp
1501@c Contact Masashí Míyaura <masasam@users.noreply.github.com>
1502
1503@c @item ibuffer-tramp.el
1504@c Contact Svend Sorensen <svend@@ciffer.net>
1505
1506@item docker-tramp
1507@cindex method @option{docker}
1508@cindex @option{docker} method
1509Integration for Docker containers. A container is accessed via
1510@file{@trampfn{docker,user@@container,/path/to/file}}, where
1511@samp{user} is the (optional) user that you want to use, and
1512@samp{container} is the id or name of the container.
1513
1514@item kubernetes-tramp
1515@cindex method @option{kubectl}
1516@cindex @option{kubectl} method
1517Integration for Docker containers deployed in a Kubernetes cluster.
1518It is derived from @samp{docker-tramp}. A container is accessed via
1519@file{@trampfn{kubectl,user@@container,/path/to/file}}, @samp{user}
1520and @samp{container} have the same meaning as in @samp{docker-tramp}.
1521
1522@item lxc-tramp
1523@cindex method @option{lxc}
1524@cindex @option{lxc} method
1525Integration for LXC containers. A container is accessed via
1526@file{@trampfn{lxc,container,/path/to/file}}, @samp{container} has the
1527same meaning as in @samp{docker-tramp}. A @samp{user} specification
1528is ignored.
1529
1530@item lxd-tramp
1531@cindex method @option{lxd}
1532@cindex @option{lxd} method
1533Integration for LXD containers. A container is accessed via
1534@file{@trampfn{lxd,user@@container,/path/to/file}}, @samp{user} and
1535@samp{container} have the same meaning as in @samp{docker-tramp}.
1536
1537@item magit-tramp
1538@cindex method @option{git}
1539@cindex @option{git} method
1540Browing git repositories with @code{magit}. A versioned file is accessed via
1541@file{@trampfn{git,rev@@root-dir,/path/to/file}}. @samp{rev} is a git
1542revision, and @samp{root-dir} is a virtual host name for the root
1543directory, specified in @code{magit-tramp-hosts-alist}.
1544
1545@item tramp-hdfs
1546@cindex method @option{hdfs}
1547@cindex @option{hdfs} method
1548Access of a hadoop/hdfs file system. A file is accessed via
1549@file{@trampfn{hdfs,user@@node,/path/to/file}}, where @samp{user} is
1550the user that you want to use, and @samp{node} is the name of the
1551hadoop server.
1552
1553@item vagrant-tramp
1554@cindex method @option{vagrant}
1555@cindex @option{vagrant} method
1556Convenience method to access vagrant boxes. It is often used in
1557multi-hop file names like
1558@file{@value{prefix}vagrant@value{postfixhop}box|sudo@value{postfixhop}box@value{postfix}/path/to/file},
1559where @samp{box} is the name of the vagrant box.
1560@end table
1561
1494 1562
1495@node Customizing Completion 1563@node Customizing Completion
1496@section Selecting config files for user/host name completion 1564@section Selecting config files for user/host name completion
@@ -1671,7 +1739,7 @@ Set @code{auth-source-debug} to @code{t} to debug messages.
1671 1739
1672@vindex ange-ftp-netrc-filename 1740@vindex ange-ftp-netrc-filename
1673@strong{Note} that @file{auth-source.el} is not used for @option{ftp} 1741@strong{Note} that @file{auth-source.el} is not used for @option{ftp}
1674connections, because @value{tramp} passes the work to Ange FTP. If 1742connections, because @value{tramp} passes the work to Ange FTP@. If
1675you want, for example, use your @file{~/.authinfo.gpg} authentication 1743you want, for example, use your @file{~/.authinfo.gpg} authentication
1676file, you must customize @code{ange-ftp-netrc-filename}: 1744file, you must customize @code{ange-ftp-netrc-filename}:
1677 1745