* tramp.texi (External packages): New section.

2 files changed, 37 insertions, 0 deletions

diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog
index 74820aa539..c05f6c40bc 100644
--- a/doc/misc/ChangeLog
+++ b/doc/misc/ChangeLog
@@ -1,3 +1,7 @@
+2007-10-06  Michael Albinus  <[email protected]>
+
+	* tramp.texi (External packages): New section.
+
 2007-09-26  Carsten Dominik  <[email protected]>
 
 	* org.texi: Change links to webpage and maintained email.
diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi
index ea0bf9d411..e5cd5e1a33 100644
--- a/doc/misc/tramp.texi
+++ b/doc/misc/tramp.texi
@@ -231,6 +231,9 @@ Things related to Version Control that don't fit elsewhere
 How file names, directories and localnames are mangled and managed
 
 * Localname deconstruction::    Breaking a localname into its components.
+@ifset emacs
+* External packages::           Integration with external Lisp packages.
+@end ifset
 
 @end detailmenu
 @end menu
@@ -3119,6 +3122,9 @@ system basis and the results cached to improve performance.
 
 @menu
 * Localname deconstruction::    Breaking a localname into its components.
+@ifset emacs
+* External packages::           Integration with external Lisp packages.
+@end ifset
 @end menu
 
 
@@ -3138,6 +3144,33 @@ This allows the platform specific hacks in the original handlers to take
 effect while preserving the @value{tramp} file name information.
 
 
+@ifset emacs
+@node External packages
+@section Integration with external Lisp packages.
+
+While reading filenames in the minibuffer, @value{tramp} must decide
+whether it completes possible incomplete filenames, or not.  Imagine
+there is the following situation: You have typed @kbd{C-x C-f
+@value{prefix}ssh@value{postfixhop} @key{TAB}}.  @value{tramp} cannot
+know, whether @option{ssh} is a method or a host name.  It checks
+therefore the last input character you have typed.  If this is
+@key{TAB}, @key{SPACE} or @kbd{?}, @value{tramp} assumes that you are
+still in filename completion, and it does not connect to the possible
+remote host @option{ssh}.
+
+@vindex tramp-completion-mode
+External packages, which use other characters for completing filenames
+in the minibuffer, must signal this to @value{tramp}.  For this case,
+the variable @code{tramp-completion-mode} can be bound temporarily to
+a non-nil value.
+
+@lisp
+(let ((tramp-completion-mode t))
+  ...)
+@end lisp
+@end ifset
+
+
 @node Traces and Profiles
 @chapter How to Customize Traces