[elpa] master 2d22e05 363/399: doc/ivy.org: Add more info on TRAMP

[Oleh Krehel]

branch: master
commit 2d22e05932b6e0478689049f33257bd0c0b4f65f
Author: Oleh Krehel <address@hidden>
Commit: Oleh Krehel <address@hidden>

    doc/ivy.org: Add more info on TRAMP
    
    Re #1487
---
 doc/ivy.org  | 16 ++++++++++++++++
 doc/ivy.texi | 20 ++++++++++++++++++++
 2 files changed, 36 insertions(+)

diff --git a/doc/ivy.org b/doc/ivy.org
index 151592d..2815474 100644
--- a/doc/ivy.org
+++ b/doc/ivy.org
@@ -1022,6 +1022,22 @@ bindings that work here:
      files previously opened. It also works with TRAMP files.
 
 *** Using TRAMP
+:PROPERTIES:
+:CUSTOM_ID: using-tramp
+:END:
+- ~~~ (tilde) ::
+     Move to the home directory. Either the local or the remote one, depending 
on the
+     current directory. The boolean option =ivy-magic-tilde= decides whether 
the binding to
+     do this is ~~~ or ~~/~.
+
+- ~//~ (double slash) ::
+     Move to the root directory. Either the local or the remote one, depending 
on the
+     current directory. Here, you can also select a TRAMP connection method, 
such as =ssh=
+     or =scpx=.
+
+- ~/ RET~ ::
+     Move the the local root directory.
+
 From any directory, with the empty input, inputting =/ssh:= and pressing
 ~C-j~ (or ~RET~, which is the same thing) completes for host and user
 names.
diff --git a/doc/ivy.texi b/doc/ivy.texi
index 8cc2711..ae23ef9 100644
--- a/doc/ivy.texi
+++ b/doc/ivy.texi
@@ -1360,6 +1360,26 @@ files previously opened. It also works with TRAMP files.
 @node Using TRAMP
 @subsection Using TRAMP
 
+@subsubheading @kbd{~} (tilde)
+@kindex ~
+@indentedblock
+Move to the home directory. Either the local or the remote one, depending on 
the
+current directory. The boolean option @code{ivy-magic-tilde} decides whether 
the binding to
+do this is @kbd{~} or @kbd{~/}.
+@end indentedblock
+@subsubheading @kbd{//} (double slash)
+@kindex //
+@indentedblock
+Move to the root directory. Either the local or the remote one, depending on 
the
+current directory. Here, you can also select a TRAMP connection method, such 
as @code{ssh}
+or @code{scpx}.
+@end indentedblock
+@subsubheading @kbd{/ RET}
+@kindex / RET
+@indentedblock
+Move the the local root directory.
+@end indentedblock
+
 From any directory, with the empty input, inputting @code{/ssh:} and pressing
 @kbd{C-j} (or @kbd{RET}, which is the same thing) completes for host and user
 names.