(Acknowledgments): Use @dotless{i}.

[gnu-emacs] / man / tramp.texi

diff --git a/man/tramp.texi b/man/tramp.texi
index ccaa0cd3c61adbd17c878a9856888e2c360d9338..b85347461ca4a26ee07aeb8cd782046a933d8265 100644 (file)
--- a/man/tramp.texi
+++ b/man/tramp.texi
@@ -25,8 +25,8 @@
 @end macro
 
 @copying
 @end macro
 
 @copying

-Copyright @copyright{} 1999, 2000, 2001, 2002, 2003, 2004,
-   2005 Free Software Foundation, Inc.
+Copyright @copyright{} 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006
+Free Software Foundation, Inc.

 
 @quotation
 Permission is granted to copy, distribute and/or modify this document
 
 @quotation
 Permission is granted to copy, distribute and/or modify this document


@@ -111,7 +111,7 @@ Japanese translation}.
 @end ifset
 
 The latest release of @value{tramp} is available for
 @end ifset
 
 The latest release of @value{tramp} is available for

-@uref{http://ftp.gnu.org/gnu/tramp/, download}, or you may see
+@uref{ftp://ftp.gnu.org/gnu/tramp/, download}, or you may see

 @ref{Obtaining Tramp} for more details, including the CVS server
 details.
 
 @ref{Obtaining Tramp} for more details, including the CVS server
 details.
 


@@ -378,7 +378,7 @@ behind the scenes when you open a file with @value{tramp}.
 
 @value{tramp} is freely available on the Internet and the latest
 release may be downloaded from
 
 @value{tramp} is freely available on the Internet and the latest
 release may be downloaded from

-@uref{http://ftp.gnu.org/gnu/tramp/}. This release includes the full
+@uref{ftp://ftp.gnu.org/gnu/tramp/}. This release includes the full

 documentation and code for @value{tramp}, suitable for installation.
 But GNU Emacs (22 or later) includes @value{tramp} already, and there
 is a @value{tramp} package for XEmacs, as well.  So maybe it is easier
 documentation and code for @value{tramp}, suitable for installation.
 But GNU Emacs (22 or later) includes @value{tramp} already, and there
 is a @value{tramp} package for XEmacs, as well.  So maybe it is easier


@@ -698,7 +698,7 @@ remote host.
 
 Additionally, the method @option{plink1} is provided, which calls
 @samp{plink -1 -ssh} in order to use SSH protocol version 1
 
 Additionally, the method @option{plink1} is provided, which calls
 @samp{plink -1 -ssh} in order to use SSH protocol version 1

-explicitely.
+explicitly.

 
 CCC: Do we have to connect to the remote host once from the command
 line to accept the SSH key?  Maybe this can be made automatic?
 
 CCC: Do we have to connect to the remote host once from the command
 line to accept the SSH key?  Maybe this can be made automatic?


@@ -1261,12 +1261,12 @@ Example:
 
 Sometimes it is necessary to connect to the same remote host several
 times.  Reentering passwords again and again would be annoying, when
 
 Sometimes it is necessary to connect to the same remote host several
 times.  Reentering passwords again and again would be annoying, when

-the choosen method does not support access without password prompt
-throught own configuration.
+the chosen method does not support access without password prompt
+through own configuration.

 
 By default, @value{tramp} caches the passwords entered by you.  They will
 be reused next time if a connection needs them for the same user name
 
 By default, @value{tramp} caches the passwords entered by you.  They will
 be reused next time if a connection needs them for the same user name

-and host name, independant of the connection method.
+and host name, independently of the connection method.

 
 @vindex password-cache-expiry
 Passwords are not saved permanently, that means the password caching
 
 @vindex password-cache-expiry
 Passwords are not saved permanently, that means the password caching


@@ -1524,7 +1524,7 @@ When
 @end ifset
 is @code{nil} (the default), such problems do not occur.
 
 @end ifset
 is @code{nil} (the default), such problems do not occur.
 

-Therefore, it is usefull to set special values for @value{tramp}
+Therefore, it is useful to set special values for @value{tramp}

 files.  For example, the following statement effectively `turns off'
 the effect of
 @ifset emacs
 files.  For example, the following statement effectively `turns off'
 the effect of
 @ifset emacs


@@ -1831,9 +1831,15 @@ should you want to add your own.
 @section Filename completion
 @cindex filename completion
 
 @section Filename completion
 @cindex filename completion
 

-Filename completion works with @value{tramp} for both completing methods,
-user names and machine names (except multi hop methods) as well as for
-files on remote machines.
+Filename completion works with @value{tramp} for completion of method
+names, of user names and of machine names (except multi-hop methods)
+as well as for completion of file names on remote machines.
+@ifset emacs
+In order to enable this, Partial Completion mode must be set on.
+@ifinfo
+@xref{Completion Options, , , @value{emacsdir}}.
+@end ifinfo
+@end ifset

 
 If you, for example, type @kbd{C-x C-f @value{prefix}t
 @key{TAB}}, @value{tramp} might give you as result the choice for
 
 If you, for example, type @kbd{C-x C-f @value{prefix}t
 @key{TAB}}, @value{tramp} might give you as result the choice for


@@ -1925,12 +1931,16 @@ navigation in the @file{*Compilation*} buffer.
 @chapter Reporting Bugs and Problems
 @cindex bug reports
 
 @chapter Reporting Bugs and Problems
 @cindex bug reports
 

-Bugs and problems with @value{tramp} are actively worked on by the development
-team. Feature requests and suggestions are also more than welcome.
+Bugs and problems with @value{tramp} are actively worked on by the
+development team. Feature requests and suggestions are also more than
+welcome.

 
 

-The @value{tramp} mailing list is a great place to get information on working
-with @value{tramp}, solving problems and general discussion and advice on topics
-relating to the package.
+The @value{tramp} mailing list is a great place to get information on
+working with @value{tramp}, solving problems and general discussion
+and advice on topics relating to the package.  It is moderated so
+non-subscribers can post but messages will be delayed, possibly up to
+48 hours (or longer in case of holidays), until the moderator approves
+your message.

 
 The mailing list is at @email{tramp-devel@@gnu.org}.  Messages sent to
 this address go to all the subscribers. This is @emph{not} the address
 
 The mailing list is at @email{tramp-devel@@gnu.org}.  Messages sent to
 this address go to all the subscribers. This is @emph{not} the address


@@ -1946,7 +1956,9 @@ will automatically generate a buffer with the details of your system and
 
 When submitting a bug report, please try to describe in excruciating
 detail the steps required to reproduce the problem, the setup of the
 
 When submitting a bug report, please try to describe in excruciating
 detail the steps required to reproduce the problem, the setup of the

-remote machine and any special conditions that exist.
+remote machine and any special conditions that exist.  You should also
+check that your problem is not described already in @xref{Frequently
+Asked Questions}.

 
 If you can identify a minimal test case that reproduces the problem,
 include that with your bug report. This will make it much easier for the
 
 If you can identify a minimal test case that reproduces the problem,
 include that with your bug report. This will make it much easier for the


@@ -1964,7 +1976,7 @@ Where can I get the latest @value{tramp}?
 @value{tramp} is available under the URL below.
 
 @noindent
 @value{tramp} is available under the URL below.
 
 @noindent

-@uref{http://ftp.gnu.org/gnu/tramp/}
+@uref{ftp://ftp.gnu.org/gnu/tramp/}

 
 @noindent
 There is also a Savannah project page.
 
 @noindent
 There is also a Savannah project page.


@@ -1972,6 +1984,7 @@ There is also a Savannah project page.
 @noindent
 @uref{http://savannah.gnu.org/projects/tramp/}
 
 @noindent
 @uref{http://savannah.gnu.org/projects/tramp/}
 

+

 @item
 Which systems does it work on?
 
 @item
 Which systems does it work on?
 


@@ -2003,49 +2016,37 @@ Emacs?  I think there was some issue with @command{ssh}?
 
 
 @item
 
 
 @item

-I can't stop @value{ftppackagename} starting with @value{emacsname}
+@value{tramp} does not connect to the remote host

 
 

-@ifset emacs
-@value{ftppackagename} is loaded from @value{tramp} automatically if you
-require a file by the ftp method.  Unfortunately, there are some Lisp
-packages which make @value{ftppackagename} file name handlers active.
-You can see it applying @kbd{C-h v file-name-handler-alist}:
+When @value{tramp} does not connect to the remote host, there are two
+reasons heading the bug mailing list:

 
 

-@example
-file-name-handler-alist's value is
-(("^/[^/:]*\\'" . ange-ftp-completion-hook-function)
- ("^/[^/:]*[^/:.]:" . ange-ftp-hook-function)
- ("^/[^/]*$" . tramp-completion-file-name-handler)
- ("\\`/[^/:]+:" . tramp-file-name-handler)
- ("\\`/:" . file-name-non-special))
-@end example
+@itemize @minus

 
 

-Please try to find out which package is responsible for loading
-@value{ftppackagename}, and raise a bug report.
+@item
+Unknown characters in the prompt

 
 

-A workaround is to require @value{ftppackagename} before @value{tramp} in
-your @file{~/.emacs}, because @value{tramp} cleans up the entries in
-@code{file-name-handler-alist}:
+@value{tramp} needs to recognize the prompt on the remote machine
+after execution any command.  This is not possible, when the prompt
+contains unknown characters like escape sequences for coloring.  This
+should be avoided on the remote side.  @xref{Remote shell setup}. for
+setting the regular expression detecting the prompt.

 
 

-@lisp
-;; @value{ftppackagename} temporarily required
-(require 'ange-ftp)
-;; @value{tramp} cleans up @code{file-name-handler-alist}
-(require 'tramp)
-@end lisp
-@end ifset
+A special problem is the zsh, which uses left-hand side and right-hand
+side prompts in parallel.  Therefore, it is necessary to disable the
+zsh line editor on the remote host.  You shall add to @file{~/.zshrc}
+the following command: @command{[ $TERM = "dumb" ] && unsetopt zle}.

 
 

-@ifset xemacs
-Not all the older versions of @value{tramp} supported @value{emacsname}
-correctly.  The first thing to do is to make sure that you have the
-latest version of @value{tramp} installed.
-
-If you do, please try and find out exactly the conditions required for
-the @value{ftppackagename} handlers to fire.  If you can, putting a
-breakpoint on @code{efs-ftp-path} and sending in the stack trace along
-with your bug report would make it easier for the developers to work out
-what is going wrong.
-@end ifset
+@item
+@value{tramp} doesn't transfer strings with more than 500 characters
+correctly
+
+On some few systems, the implementation of @code{process-send-string}
+seems to be broken for longer strings.  This case, you should
+customize the variable @code{tramp-chunksize} to 500.  For a
+description how to determine whether this is necessary see the
+documentation of @code{tramp-chunksize}.
+@end itemize

 
 
 @item
 
 
 @item


@@ -2132,14 +2133,24 @@ fi
 
 
 @item
 
 
 @item

-@value{tramp} doesn't transfer strings with more than 500 characters
-correctly
+How can I disable @value{tramp}?

 
 

-On some few systems, the implementation of @code{process-send-string}
-seems to be broken for longer strings.  This case, you should
-customize the variable @code{tramp-chunksize} to 500.  For a
-description how to determine whether this is necessary see the
-documentation of @code{tramp-chunksize}.
+Shame on you, why did you read until now?
+
+@ifset emacs
+If you just want to have @value{ftppackagename} as default remote
+files access package, you should apply the following code:
+
+@lisp
+(setq tramp-default-method "ftp")
+@end lisp
+@end ifset
+
+Unloading @value{tramp} can be achieved by applying @kbd{M-x
+tramp-unload-tramp}.
+@ifset emacs
+This resets also the @value{ftppackagename} plugins.
+@end ifset

 @end itemize
 
 
 @end itemize
 
 


@@ -2358,7 +2369,7 @@ installed from the start.  If the filenames were unified, @value{tramp}
 would have to be installed from the start, too.
 
 @ifset xemacs
 would have to be installed from the start, too.
 
 @ifset xemacs

-@strong{Note:} If you'ld like to use a similar syntax like
+@strong{Note:} If you'd like to use a similar syntax like

 @value{ftppackagename}, you need the following settings in your init
 file:
 
 @value{ftppackagename}, you need the following settings in your init
 file: