changeset 46346:49f06e689a20

* files.texi (Remote Files): Explain new unified file name synatx. * tramp.texi: Remove version variables. (Inline methods): Clarify which questions `smx' deals with. (Remote shell setup): shell-prompt-pattern must match at end of buffer.
author Kai Großjohann <kgrossjo@eu.uu.net>
date Sat, 13 Jul 2002 10:52:22 +0000
parents 38401651e92c
children 3996ea20e5e3
files man/ChangeLog man/files.texi man/tramp.texi
diffstat 3 files changed, 61 insertions(+), 39 deletions(-) [+]
line wrap: on
line diff
--- a/man/ChangeLog	Fri Jul 12 23:57:49 2002 +0000
+++ b/man/ChangeLog	Sat Jul 13 10:52:22 2002 +0000
@@ -1,3 +1,12 @@
+2002-07-13  Kai Gro,b_(Bjohann  <Kai.Grossjohann@CS.Uni-Dortmund.DE>
+
+	* files.texi (Remote Files): Explain new unified file name synatx.
+
+	* tramp.texi: Remove version variables.
+	(Inline methods): Clarify which questions `smx' deals with.
+	(Remote shell setup): shell-prompt-pattern must match at end of
+	buffer.
+
 2002-06-17  David Kastrup  <David.Kastrup@t-online.de>
 
 	* tramp.texi: use correct @setfilename
--- a/man/files.texi	Fri Jul 12 23:57:49 2002 +0000
+++ b/man/files.texi	Sat Jul 13 10:52:22 2002 +0000
@@ -2977,42 +2977,55 @@
 @section Remote Files
 
 @cindex Tramp
-  In the following, file access via FTP will be discussed.  In
-addition to that facility, it is also possible to access remote files
-through a shell connection.  @xref{Top, The Tramp Manual,, tramp, The
-Tramp Manual}.
-
 @cindex FTP
 @cindex remote file access
-  You can refer to files on other machines using a special file name syntax:
+  You can refer to files on other machines using a special file name
+syntax:
 
 @example
 @group
 /@var{host}:@var{filename}
 /@var{user}@@@var{host}:@var{filename}
 /@var{user}@@@var{host}#@var{port}:@var{filename}
+/@var{method}:@var{user}@@@var{host}:@var{filename}
+/@var{method}:@var{user}@@@var{host}#@var{port}:@var{filename}
 @end group
 @end example
 
 @noindent
-When you do this, Emacs uses the FTP program to read and write files on
-the specified host.  It logs in through FTP using your user name or the
-name @var{user}.  It may ask you for a password from time to time; this
-is used for logging in on @var{host}.  The form using @var{port} allows
-you to access servers running on a non-default TCP port.
-
-For using Tramp, the file name syntax looks like this:
-
-@example
-@group
-/[@var{host}]@var{filename}
-/[@var{user}@@@var{host}]@var{filename}
-/[@var{method}/@var{user}@@@var{host}]@var{filename}
-@end group
-@end example
+When you do this, Emacs may use the FTP program to access files on the
+remote host, or Emacs may use a remote-login program (such as
+@command{ssh}, @command{rlogin}, or @command{telnet}) to do this.
+
+You can always specify in the file name which method should be used to
+access the remote files, for example
+@file{/ftp:@var{user}@@@var{host}:@var{filename}} will use FTP, whereas
+@file{/sm:@var{user}@@@var{host}:@var{filename}} will use
+@command{ssh}.  When no method is specified in the file name, Emacs
+determines a default method according to the following rules:
+
+@enumerate
+@item
+If the host name starts with @samp{ftp.} (with dot), then Emacs assumes
+the @command{ftp} method.
+@item
+If the user name is @samp{ftp} or @samp{anonymous}, then Emacs assumes
+the @command{ftp} method.
+@item
+Otherwise, Emacs assumes the @command{sm} method.
+@end enumerate
 
 @noindent
-Note that the square brackets are part of the file names.
+Remote file access through FTP is handled by the Ange-FTP package, which
+is documented in the following.  Remote file access through the other
+methods is handled by the Tramp package, which has its own manual.
+@xref{Top, The Tramp Manual,, tramp, The Tramp Manual}.
+
+When the Ange-FTP package is used, Emacs logs in through FTP using your
+user name or the name @var{user}.  It may ask you for a password from
+time to time; this is used for logging in on @var{host}.  The form using
+@var{port} allows you to access servers running on a non-default TCP
+port.
 
 @cindex backups for remote files
 @vindex ange-ftp-make-backup-files
--- a/man/tramp.texi	Fri Jul 12 23:57:49 2002 +0000
+++ b/man/tramp.texi	Sat Jul 13 10:52:22 2002 +0000
@@ -8,12 +8,6 @@
 @c This is *so* much nicer :)
 @footnotestyle end
 
-@c Version values, for easy modification
-@c NOTE: The 'UPDATED' value is updated by the 'time-stamp' function.
-@c       If you change it by hand, the modifications will not stay.
-@set VERSION $Revision: 1.3 $
-@set UPDATED Monday, 17 June, 2002
-
 
 @c Entries for @command{install-info} to use
 @direntry
@@ -61,7 +55,6 @@
 
 @titlepage
 @title @tramp{} User Manual
-@subtitle Last updated @value{UPDATED}
 
 @author by Daniel Pittman
 @author based on documentation by Kai Gro@ss{}johann
@@ -102,9 +95,6 @@
 @command{rsh} and @command{rcp} or other work-alike programs, such as
 @command{ssh}/@command{scp}.
 
-This is version @value{VERSION} of the @tramp{} manual, last updated on
-@value{UPDATED}.
-
 You can find the latest version of this document on the web at
 @uref{http://www.freesoftware.fsf.org/tramp/}.
 
@@ -726,6 +716,13 @@
 logging in.  This procedure avoids these questions, and just gives
 @tramp{} a more-or-less `standard' login shell to work with.
 
+Note that this procedure does not eliminate questions asked by
+@command{ssh} itself.  For example, @command{ssh} might ask ``Are you
+sure you want to continue connecting?'' if the host key of the remote
+host is not known.  Tramp does not know how to deal with such a
+question (yet), therefore you will need to make sure that you can log
+in without such questions.
+
 This is also useful for Windows users where @command{ssh}, when
 invoked from an Emacs buffer, tells them that it is not allocating a
 pseudo tty.  When this happens, the login shell is wont to not print
@@ -1091,6 +1088,13 @@
 recognize the shell prompt, the variable @code{shell-prompt-pattern} has
 to be set correctly to recognize the shell prompt on the remote host.
 
+Note that Tramp requires the match for @code{shell-prompt-pattern} to
+be at the end of the buffer.  Many people have something like the
+following as the value for the variable: @code{"^[^>$][>$] *"}.  Now
+suppose your shell prompt is @code{a <b> c $ }.  In this case, Tramp
+recognizes the @code{>} character as the end of the prompt, but it is
+not at the end of the buffer.
+
 @item @code{tset} and other questions
 
 Some people invoke the @code{tset} program from their shell startup
@@ -1640,11 +1644,7 @@
 @c   shells.
 @c * Explain how tramp.el works in principle: open a shell on a remote
 @c   host and then send commands to it.
+@c * Mention that bookmarks are a cool feature to go along with Tramp.
+@c * Make terminology "inline" vs "out-of-band" consistent.
+@c   It seems that "external" is also used instead of "out-of-band".
 
-@c Local Variables:
-@c eval: (add-hook 'write-file-functions 'time-stamp)
-@c time-stamp-start: "@set UPDATED "
-@c time-stamp-format: "%:a, %:d %:b, %:y"
-@c time-stamp-end: "$"
-@c time-stamp-line-limit: 50
-@c End: