@c In the Tramp CVS, the version number is auto-frobbed from
@c configure.ac, so you should edit that file and run
@c "autoconf && ./configure" to change the version number.
-@include trampver.texi
-
-@c Entries for @command{install-info} to use
-@dircategory Emacs
-@direntry
-* TRAMP: (tramp). Transparent Remote Access, Multiple Protocol
- Emacs remote file access via rsh and rcp.
-@end direntry
-
-@c Macro to make formatting of the tramp program name consistent.
-@macro tramp
-@sc{tramp}
-@end macro
-
-@c Some flags which make the text independent on the (X)Emacs flavor.
-@c "emacs" resp "xemacs" are set in the Makefile.
-@c Emacs values.
-@ifset emacs
-@set emacs-name Emacs
-@set emacs-dir emacs
-@set ftp-package-name Ange-FTP
-@set tramp-prefix /
-@set tramp-prefix-single-hop
-@set tramp-postfix :
-@set tramp-postfix-single-hop :
-@set tramp-postfix-multi-hop :
-@end ifset
+@c Additionally, flags are set with respect to the Emacs flavor; and
+@c depending whether Tramp is packaged into (X)Emacs, or standalone.
-@c XEmacs counterparts.
-@ifset xemacs
-@set emacs-name XEmacs
-@set emacs-dir xemacs
-@set ftp-package-name EFS
-@set tramp-prefix /[
-@set tramp-prefix-single-hop [
-@set tramp-postfix ]
-@set tramp-postfix-single-hop /
-@set tramp-postfix-multi-hop :
-@end ifset
+@include trampver.texi
@c Macros for formatting a filename.
@c trampfn is for a full filename, trampfnmhp means method, host, localname
@c were given, and so on.
@macro trampfn(method, user, host, localname)
-@value{tramp-prefix}@value{method}@value{user}@@@value{host}@value{tramp-postfix}@value{localname}
+@value{prefix}@value{method}@value{user}@@@value{host}@value{postfix}@value{localname}
@end macro
@copying
-Copyright @copyright{} 1999, 2000, 2001, 2002, 2003 Free Software
-Foundation, Inc.
+Copyright @copyright{} 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
+Free Software Foundation, Inc.
-@quotation
+@quotation
Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.1 or
+under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with the Front-Cover texts being ``A GNU
Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
@end quotation
@end copying
+@c Entries for @command{install-info} to use
+@dircategory @value{emacsname}
+@direntry
+* TRAMP: (tramp). Transparent Remote Access, Multiple Protocol
+ @value{emacsname} remote file access via rsh and rcp.
+@end direntry
+
@tex
@titlepage
-@title @tramp{} version @trampver{} User Manual
+@title @value{tramp} version @value{trampver} User Manual
@author by Daniel Pittman
@author based on documentation by Kai Gro@ss{}johann
@ifnottex
@node Top, Overview, (dir), (dir)
-@top @tramp{} version @trampver{} User Manual
+@top @value{tramp} version @value{trampver} User Manual
-This file documents @tramp{} version @trampver{}, a remote file
-editing package for @value{emacs-name}.
+This file documents @value{tramp} version @value{trampver}, a remote file
+editing package for @value{emacsname}.
-@tramp{} stands for `Transparent Remote (file) Access, Multiple
+@value{tramp} stands for `Transparent Remote (file) Access, Multiple
Protocol'. This package provides remote file editing, similar to
-@value{ftp-package-name}.
+@value{ftppackagename}.
-The difference is that @value{ftp-package-name} uses FTP to transfer
-files between the local and the remote host, whereas @tramp{} uses a
+The difference is that @value{ftppackagename} uses FTP to transfer
+files between the local and the remote host, whereas @value{tramp} uses a
combination of @command{rsh} and @command{rcp} or other work-alike
programs, such as @command{ssh}/@command{scp}.
You can find the latest version of this document on the web at
-@uref{http://www.freesoftware.fsf.org/tramp/}.
+@uref{http://www.gnu.org/software/tramp/}.
+
+@c Pointer to the other Emacs flavor is necessary only in case of
+@c standalone installation.
+@ifset installchapter
+The manual has been generated for @value{emacsname}.
+@ifinfo
+If you want to read the info pages for @value{emacsothername}, you
+should read in @ref{Installation} how to create them.
+@end ifinfo
+@ifhtml
+If you're using the other Emacs flavor, you should read the
+@uref{@value{emacsotherfilename}, @value{emacsothername}} pages.
+@end ifhtml
+@end ifset
@ifhtml
-This manual is also available as a @uref{tramp_ja.html, Japanese
-translation}.
+@ifset jamanual
+This manual is also available as a @uref{@value{japanesemanual},
+Japanese translation}.
+@end ifset
-The latest release of @tramp{} is available for
-@uref{http://savannah.gnu.org/download/tramp/,
-download}, or you may see @ref{Obtaining @tramp{}} for more details,
-including the CVS server details.
+The latest release of @value{tramp} is available for
+@uref{ftp://ftp.gnu.org/gnu/tramp/, download}, or you may see
+@ref{Obtaining Tramp} for more details, including the CVS server
+details.
-@tramp{} also has a @uref{https://savannah.gnu.org/projects/tramp/,
+@value{tramp} also has a @uref{http://savannah.gnu.org/projects/tramp/,
Savannah Project Page}.
@end ifhtml
-There is a mailing list for @tramp{}, available at
-@email{tramp-devel@@mail.freesoftware.fsf.org}, and archived at
-@uref{http://www.mail-archive.com/emacs-rcp@@ls6.cs.uni-dortmund.de/} as
-well as the usual Savannah archives.
+There is a mailing list for @value{tramp}, available at
+@email{tramp-devel@@gnu.org}, and archived at
+@uref{http://lists.gnu.org/archive/html/tramp-devel/, the
+@value{tramp} Mail Archive}.
+@ifhtml
+Older archives are located at
+@uref{http://sourceforge.net/mailarchive/forum.php?forum=tramp-devel,
+SourceForge Mail Archive} and
+@uref{http://www.mail-archive.com/emacs-rcp@@ls6.cs.uni-dortmund.de/,
+The Mail Archive}.
+@c in HTML output, there's no new paragraph.
+@*@*
+@end ifhtml
@insertcopying
@end ifnottex
@menu
-* Overview:: What @tramp{} can and cannot do.
+* Overview:: What @value{tramp} can and cannot do.
For the end user:
-* Obtaining @tramp{}:: How to obtain @tramp{}.
-* History:: History of @tramp{}.
-* Installation:: Installing @tramp{} with your @value{emacs-name}.
-* Configuration:: Configuring @tramp{} for use.
-* Usage:: An overview of the operation of @tramp{}.
+
+* Obtaining Tramp:: How to obtain @value{tramp}.
+* History:: History of @value{tramp}.
+@ifset installchapter
+* Installation:: Installing @value{tramp} with your @value{emacsname}.
+@end ifset
+* Configuration:: Configuring @value{tramp} for use.
+* Usage:: An overview of the operation of @value{tramp}.
* Bug Reports:: Reporting Bugs and Problems.
* Frequently Asked Questions:: Questions and answers from the mailing list.
+* Concept Index:: An item for each concept.
For the developer:
+
* Version Control:: The inner workings of remote version control.
* Files directories and localnames:: How file names, directories and localnames are mangled and managed.
* Issues:: Debatable Issues and What Was Decided.
+* GNU Free Documentation License:: The license for this documentation.
+
@detailmenu
--- The Detailed Node Listing ---
+@c
+@ifset installchapter
+Installing @value{tramp} with your @value{emacsname}
+
+* Installation parameters:: Parameters in order to control installation.
+* Load paths:: How to plug-in @value{tramp} into your environment.
+* Japanese manual:: Japanese manual.
+
+@end ifset
-Configuring @tramp{} for use
+Configuring @value{tramp} for use
* Connection types:: Types of connections made to remote machines.
* Inline methods:: Inline methods.
* Default Method:: Selecting a default method.
* Customizing Methods:: Using Non-Standard Methods.
* Customizing Completion:: Selecting config files for user/host name completion.
-* Remote Programs:: How @tramp{} finds and uses programs on the remote machine.
+* Password caching:: Reusing passwords for several connections.
+* Remote Programs:: How @value{tramp} finds and uses programs on the remote machine.
* Remote shell setup:: Remote shell setup hints.
* Windows setup hints:: Issues with Cygwin ssh.
* Auto-save and Backup:: Auto-save and Backup.
-Using @tramp
+Using @value{tramp}
-* Filename Syntax:: @tramp{} filename conventions.
+* Filename Syntax:: @value{tramp} filename conventions.
* Multi-hop filename syntax:: Multi-hop filename conventions.
* Filename completion:: Filename completion.
* Dired:: Dired.
+* Compilation:: Compile remote files.
The inner workings of remote version control
* Remote File Ownership:: How VC determines who owns a workfile.
* Back-end Versions:: How VC determines what release your RCS is.
-How file names, directories and localnames are mangled and managed.
+How file names, directories and localnames are mangled and managed
* Localname deconstruction:: Breaking a localname into its components.
@end menu
@node Overview
-@chapter An overview of @tramp
+@chapter An overview of @value{tramp}
@cindex overview
-After the installation of @tramp{} into your @value{emacs-name}, you
-will be able to access files on remote machines as though they were
-local. Access to the remote file system for editing files, version
-control, and @command{dired} are transparently enabled.
+After the installation of @value{tramp} into your @value{emacsname},
+you will be able to access files on remote machines as though they
+were local. Access to the remote file system for editing files,
+version control, and @code{dired} are transparently enabled.
Your access to the remote machine can be with the @command{rsh},
@command{rlogin}, @command{telnet} programs or with any similar
-connection method. This connection must pass ASCII successfully to be
-usable but need not be 8-bit clean.
+connection method. This connection must pass @acronym{ASCII}
+successfully to be usable but need not be 8-bit clean.
The package provides support for @command{ssh} connections out of the
box, one of the more common uses of the package. This allows
relatively secure access to machines, especially if @command{ftp}
access is disabled.
-The majority of activity carried out by @tramp{} requires only that
+The majority of activity carried out by @value{tramp} requires only that
the remote login is possible and is carried out at the terminal. In
-order to access remote files @tramp{} needs to transfer their content
+order to access remote files @value{tramp} needs to transfer their content
to the local machine temporarily.
-@tramp{} can transfer files between the machines in a variety of ways.
+@value{tramp} can transfer files between the machines in a variety of ways.
The details are easy to select, depending on your needs and the
machines in question.
The fastest transfer methods (for large files) rely on a remote file
transfer package such as @command{rcp}, @command{scp} or
-@command{rsync}. The use of these methods is only possible if the
-file copy command does not ask for a password for the remote machine.
+@command{rsync}.
-If the remote copy methods are not suitable for you, @tramp{} also
+If the remote copy methods are not suitable for you, @value{tramp} also
supports the use of encoded transfers directly through the shell.
This requires that the @command{mimencode} or @command{uuencode} tools
are available on the remote machine. These methods are generally
faster for small files.
-Within these limitations, @tramp{} is quite powerful. It is worth
+Within these limitations, @value{tramp} is quite powerful. It is worth
noting that, as of the time of writing, it is far from a polished
end-user product. For a while yet you should expect to run into rough
edges and problems with the code now and then.
the installation and setup can be a little difficult to master, as can
the terminology.
-@tramp{} is still under active development and any problems you encounter,
-trivial or major, should be reported to the @tramp{} developers.
+@value{tramp} is still under active development and any problems you encounter,
+trivial or major, should be reported to the @value{tramp} developers.
@xref{Bug Reports}.
@cindex how it works
This section tries to explain what goes on behind the scenes when you
-access a remote file through @tramp{}.
+access a remote file through @value{tramp}.
-Suppose you type @kbd{C-x C-f} and enter part of an @tramp{} file name,
+Suppose you type @kbd{C-x C-f} and enter part of an @value{tramp} file name,
then hit @kbd{@key{TAB}} for completion. Suppose further that this is
-the first time that @tramp{} is invoked for the host in question. Here's
+the first time that @value{tramp} is invoked for the host in question. Here's
what happens:
@itemize
@item
-@tramp{} discovers that it needs a connection to the host. So it
+@value{tramp} discovers that it needs a connection to the host. So it
invokes @samp{telnet @var{host}} or @samp{rsh @var{host} -l
@var{user}} or a similar tool to connect to the remote host.
Communication with this process happens through an
-@value{emacs-name} buffer, that is, the output from the remote end
+@value{emacsname} buffer, that is, the output from the remote end
goes into a buffer.
@item
-The remote host may prompt for a login name (for @command{telnet}). The
-login name is given in the file name, so @tramp{} sends the login name and
-a newline.
+The remote host may prompt for a login name (for @command{telnet}).
+The login name is given in the file name, so @value{tramp} sends the
+login name and a newline.
@item
The remote host may prompt for a password or pass phrase (for
@command{rsh} or for @command{telnet} after sending the login name).
-@tramp{} displays the prompt in the minibuffer, asking you for the
+@value{tramp} displays the prompt in the minibuffer, asking you for the
password or pass phrase.
-You enter the password or pass phrase. @tramp{} sends it to the remote
+You enter the password or pass phrase. @value{tramp} sends it to the remote
host, followed by a newline.
@item
-@tramp{} now waits for the shell prompt or for a message that the login
+@value{tramp} now waits for the shell prompt or for a message that the login
failed.
-If @tramp{} sees neither of them after a certain period of time (a minute,
+If @value{tramp} sees neither of them after a certain period of time (a minute,
say), then it issues an error message saying that it couldn't find the
remote shell prompt and shows you what the remote host has sent.
-If @tramp{} sees a @samp{login failed} message, it tells you so,
+If @value{tramp} sees a @samp{login failed} message, it tells you so,
aborts the login attempt and allows you to try again.
@item
-Suppose that the login was successful and @tramp{} sees the shell prompt
-from the remote host. Now @tramp{} invokes @command{/bin/sh} because
+Suppose that the login was successful and @value{tramp} sees the shell prompt
+from the remote host. Now @value{tramp} invokes @command{/bin/sh} because
Bourne shells and C shells have different command
syntaxes.@footnote{Invoking @command{/bin/sh} will fail if your login
shell doesn't recognize @samp{exec /bin/sh} as a valid command.
Maybe you use the Scheme shell @command{scsh}@dots{}}
-After the Bourne shell has come up, @tramp{} sends a few commands to
+After the Bourne shell has come up, @value{tramp} sends a few commands to
ensure a good working environment. It turns off echoing, it sets the
shell prompt, and a few other things.
@item
Now the remote shell is up and it good working order. Remember, what
-was supposed to happen is that @tramp{} tries to find out what files exist
+was supposed to happen is that @value{tramp} tries to find out what files exist
on the remote host so that it can do filename completion.
-So, @tramp{} basically issues @command{cd} and @command{ls} commands and
+So, @value{tramp} basically issues @command{cd} and @command{ls} commands and
also sometimes @command{echo} with globbing. Another command that is
often used is @command{test} to find out whether a file is writable or a
directory or the like. The output of each command is parsed for the
transfer the file contents from the remote host to the local host so
that you can edit them.
-See above for an explanation of how @tramp{} transfers the file contents.
+See above for an explanation of how @value{tramp} transfers the file contents.
-For inline transfers, @tramp{} issues a command like @samp{mimencode -b
+For inline transfers, @value{tramp} issues a command like @samp{mimencode -b
/path/to/remote/file}, waits until the output has accumulated in the
buffer that's used for communication, then decodes that output to
produce the file contents.
-For out-of-band transfers, @tramp{} issues a command like the following:
+For out-of-band transfers, @value{tramp} issues a command like the following:
@example
rcp user@@host:/path/to/remote/file /tmp/tramp.4711
@end example
you are finished, you type @kbd{C-x C-s} to save the buffer.
@item
-Again, @tramp{} transfers the file contents to the remote host either
+Again, @value{tramp} transfers the file contents to the remote host either
inline or out-of-band. This is the reverse of what happens when reading
the file.
-
@end itemize
I hope this has provided you with a basic overview of what happens
-behind the scenes when you open a file with @tramp{}.
+behind the scenes when you open a file with @value{tramp}.
@c For the end user
-@node Obtaining @tramp{}
-@chapter Obtaining @tramp{}.
+@node Obtaining Tramp
+@chapter Obtaining Tramp.
@cindex obtaining Tramp
-@tramp{} is freely available on the Internet and the latest release
-may be downloaded from
-@uref{http://savannah.nongnu.org/download/tramp/}. This
-release includes the full documentation and code for @tramp{},
-suitable for installation. But Emacs (21.4 or later) includes
-@tramp{} already, and there is a @tramp{} package for XEmacs, as well.
-So maybe it is easier to just use those. But if you want the bleeding
-edge, read on@dots{...}
+@value{tramp} is freely available on the Internet and the latest
+release may be downloaded from
+@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
+to just use those. But if you want the bleeding edge, read
+on@dots{...}
-For the especially brave, @tramp{} is available from CVS. The CVS
+For the especially brave, @value{tramp} is available from CVS. The CVS
version is the latest version of the code and may contain incomplete
features or new issues. Use these versions at your own risk.
-Instructions for obtaining the latest development version of @tramp{}
+Instructions for obtaining the latest development version of @value{tramp}
from CVS can be found by going to the Savannah project page at the
following URL and then clicking on the CVS link in the navigation bar
at the top.
Or follow the example session below:
@example
-] @strong{cd ~/@value{emacs-dir}}
-] @strong{cvs -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/tramp login}
-
-(Logging in to anoncvs@@subversions.gnu.org)
-CVS password: @strong{(just hit RET here)}
-@dots{}
-
-] @strong{cvs -z3 -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/tramp co tramp}
+] @strong{cd ~/@value{emacsdir}}
+] @strong{export CVS_RSH="ssh"}
+] @strong{cvs -z3 -d:ext:anoncvs@@savannah.gnu.org:/cvsroot/tramp co tramp}
@end example
@noindent
-You should now have a directory @file{~/@value{emacs-dir}/tramp}
-containing the latest version of @tramp{}. You can fetch the latest
+You should now have a directory @file{~/@value{emacsdir}/tramp}
+containing the latest version of @value{tramp}. You can fetch the latest
updates from the repository by issuing the command:
@example
-] @strong{cd ~/@value{emacs-dir}/tramp}
+] @strong{cd ~/@value{emacsdir}/tramp}
+] @strong{export CVS_RSH="ssh"}
] @strong{cvs update -d}
@end example
script:
@example
-] @strong{cd ~/@value{emacs-dir}/tramp}
+] @strong{cd ~/@value{emacsdir}/tramp}
] @strong{autoconf}
@end example
@node History
-@chapter History of @tramp{}
+@chapter History of @value{tramp}
@cindex history
@cindex development history
@file{rssh.el}, back then. It only provided one method to access a
file, using @command{ssh} to log in to a remote host and using
@command{scp} to transfer the file contents. After a while, the name
-was changed to @file{rcp.el}, and now it's @tramp{}. Along the way,
+was changed to @file{rcp.el}, and now it's @value{tramp}. Along the way,
many more methods for getting a remote shell and for transferring the
file contents were added. Support for VC was added.
The most recent addition of major features were the multi-hop methods
-added in April 2000 and the unification of @tramp{} and Ange-FTP
+added in April 2000 and the unification of @value{tramp} and Ange-FTP
filenames in July 2002.
-
-@node Installation
-@chapter Installing @tramp{} into @value{emacs-name}.
-@cindex installation
-
-If you use the version that comes with your @value{emacs-name}, the
-following information is not necessary. Installing @tramp{} into your
-@value{emacs-name} is a relatively easy process, at least compared
-to rebuilding your machine from scratch. ;)
-
-Seriously though, the installation should be a fairly simple matter.
-The easiest way to proceed is as follows:
-
-@itemize @bullet
-@item
-Choose a directory, say @file{~/@value{emacs-dir}/}. Change into that
-directory and unpack the tarball. This will give you a directory
-@file{~/@value{emacs-dir}/tramp-@trampver{}/} which contains
-subdirectories @file{lisp} for the Lisp code and @file{texi} for the
-documentation. Make a symbolic link:
-
-@example
-ln -s tramp-@trampver{} tramp
-@end example
-
-@item
-@command{cd} to @file{~/@value{emacs-dir}/tramp/} and type
-@command{./configure} to configure Tramp for your system.
-
-Running `configure' takes awhile. While running, it prints some
-messages telling which features it is checking for.
-
-@item
-Type @command{make} to build the byte-compiled Lisp files as well as
-the Info manual.
-
-@item
-Type @command{make install} to install the Tramp Lisp files and Info
-manual.
-
-@item
-You can remove the byte-compiled Lisp files and the Info manual from
-the source directory by typing @command{make clean}. To also remove
-the files that @command{configure} created, type @command{make
-distclean}.
-
-@item
-NOTE: If you run into problems running the example @command{make}
-command, don't despair. You can still byte compile the @file{*.el}
-files by opening @value{emacs-name} in @command{dired} (@command{C-x
-d}) mode, at @file{~/@value{emacs-dir}/tramp/lisp}. Mark the lisp files with
-@kbd{m}, then press @kbd{B} to byte compile your selections.
-
-Something similar can be done to create the info manual. Just change
-to directory @file{~/@value{emacs-dir}/tramp/texi} and load the
-@file{tramp.texi} file in @value{emacs-name}. Then press @kbd{M-x
-texinfo-format-buffer @key{RET}} to generate
-@file{~/@value{emacs-dir}/tramp/info/tramp}.
-@end itemize
-
-@menu
-* Installation parameters:: Parameters in order to control installation.
-* Load paths:: How to plug-in @tramp{} into your environment.
-@end menu
-
-@node Installation parameters
-@section Parameters in order to control installation.
-@cindex installation
-
-By default, @command{make install} will install @tramp{}'s files in
-@file{@value{lispdir}} and @file{@value{infodir}}. You can specify an
-installation prefix other than @file{@value{prefix}} by giving
-@command{configure} the option @command{--prefix=PATH}.
-
-If your installed copy of Emacs is named something other than
-@command{@value{emacs-dir}}, you will need to tell `make' where to find it so
-that it can correctly byte-compile the @tramp{} sources.
-
-Also, the @command{--prefix=PATH} option to @command{configure} may
-not be general enough to set the paths you want. If not, you can pass
-variables to the @command{make} command to control the installation.
-For a complete list of tweakable variables, look in the makefile.
-
-For example, to put the Lisp files in @file{~/elisp} and the Info file
-in @file{~/info}, you would type:
-
-@example
-./configure
-make
-make lispdir=~/elisp infodir=~/info install
-@end example
-
-@tramp{} has some packages in its @file{contrib} directory which are
-missing in older Emacsen. If you want to use them, you must use the
-@command{USE_CONTRIB} environment variable:
-
-@example
-make USE_CONTRIB=1
-make USE_CONTRIB=1 install
-@end example
-
-@node Load paths
-@section How to plug-in @tramp{} into your environment.
-@cindex installation
-
-If you don't install @tramp{} into the intended directories, but prefer
-to use from the source directory, you need to add the following lines
-into your @file{.emacs}:
-
-@lisp
-(add-to-list 'load-path "~/@value{emacs-dir}/tramp/lisp/")
-(add-to-list 'load-path "~/@value{emacs-dir}/tramp/contrib/")
-(require 'tramp)
-@end lisp
-
-The second load-path must be used only if you've applied the
-@command{USE_CONTRIB} parameter.
-
-@ifset xemacs
-NOTE: For @value{emacs-name}, the package @file{fsf-compat} must be
-installed. For details on package installation, see @ref{Packages, ,
-,xemacs}.
-@ifhtml
-(If the previous link doesn't work, try the @value{emacs-name}
-documentation at
-@uref{http://www.xemacs.org/Documentation/packageGuide.html,the
-@value{emacs-name} site}.)
-@end ifhtml
-@end ifset
-
-To be able to read the Info documentation, create a file
-@file{~/@value{emacs-dir}/tramp/info/dir} using the
-@command{install-info} command, and add the directory to the search
-path for Info.
-
-NOTE:
-On systems using the @cite{gnu} version of @command{install-info}, the
-@command{install-info} syntax is very direct and simple. One can
-change to directory @file{~/@value{emacs-dir}/tramp/info} and type:
-
-@example
-install-info tramp dir
-@end example
-
-and a @file{dir} file will be created with the @tramp{}
-entry. The info reader will know how to interpret it, but must
-be told where to find it (see below). If you want anything fancier
-you'll need to look through @kbd{man install-info}.
-
-Debian gnu/linux doesn't default to @cite{gnu} @command{install-info}
-and uses its own version. This version does not create a @file{dir}
-file for you from scratch. You must provide a skeleton @file{dir}
-file it recognizes. One can be found in a default installation of
-@value{emacs-name} at @file{/usr/info/dir}. Copy the top of this file
-down to the first occurrence of @code{* Menu} including that line plus
-one more blank line, to your working directory
-@file{~/@value{emacs-dir}/tramp/info}, or use the sample
-@file{~/@value{emacs-dir}/tramp/texi/dir_sample}.
-
-Once a @file{dir} file is in place, this command will make the entry:
-
-@example
-install-info --infodir=. tramp
-@end example
-
-If you want it in a specific category see @kbd{man install-info} for
-further details.
-
-If the environment variable @env{INFOPATH} is set, add the directory
-@file{~/@value{emacs-dir}/tramp/info/} to it. Else, add the directory to
-@ifset emacs
-@code{Info-default-directory-list}, as follows:
-
-@lisp
-(add-to-list 'Info-default-directory-list "~/@value{emacs-dir}/tramp/info/")
-@end lisp
-@end ifset
-@ifset xemacs
-@code{Info-directory-list}, as follows:
-@lisp
-(add-to-list 'Info-directory-list "~/@value{emacs-dir}/tramp/info/")
-@end lisp
+@c Installation chapter is necessary only in case of standalone
+@c installation. Text taken from trampinst.texi.
+@ifset installchapter
+@include trampinst.texi
@end ifset
@node Configuration
-@chapter Configuring @tramp{} for use
+@chapter Configuring @value{tramp} for use
@cindex configuration
@cindex default configuration
-@tramp{} is (normally) fully functional when it is initially
-installed. It is initially configured to use the @command{ssh} program
-to connect to the remote host and to use base-64 encoding (on the
-remote host, via @command{mimencode}, and on the local host via the
-built-in support for base-64 encoding in Emacs).
+@value{tramp} is (normally) fully functional when it is initially
+installed. It is initially configured to use the @command{scp}
+program to connect to the remote host. So in the easiest case, you
+just type @kbd{C-x C-f} and then enter the filename
+@file{@value{prefix}@var{user}@@@var{machine}@value{postfix}@var{/path/to.file}}.
On some hosts, there are problems with opening a connection. These are
related to the behavior of the remote shell. See @xref{Remote shell
If you do not wish to use these commands to connect to the remote
host, you should change the default connection and transfer method
-that @tramp uses. There are several different methods that @tramp{}
+that @value{tramp} uses. There are several different methods that @value{tramp}
can use to connect to remote machines and transfer files
(@pxref{Connection types}).
+If you don't know which method is right for you, see @xref{Default
+Method}.
+
@menu
* Connection types:: Types of connections made to remote machines.
* External transfer methods:: External transfer methods.
* Multi-hop Methods:: Connecting to a remote host using multiple hops.
* Default Method:: Selecting a default method.
+ Here we also try to help those who
+ don't have the foggiest which method
+ is right for them.
* Customizing Methods:: Using Non-Standard Methods.
* Customizing Completion:: Selecting config files for user/host name completion.
-* Remote Programs:: How @tramp{} finds and uses programs on the remote machine.
+* Password caching:: Reusing passwords for several connections.
+* Remote Programs:: How @value{tramp} finds and uses programs on the remote machine.
* Remote shell setup:: Remote shell setup hints.
* Windows setup hints:: Issues with Cygwin ssh.
* Auto-save and Backup:: Auto-save and Backup.
remote shell access program such as @command{rsh}, @command{ssh} or
@command{telnet} to connect to the remote machine.
-This connection is used to perform many of the operations that @tramp
+This connection is used to perform many of the operations that @value{tramp}
requires to make the remote file system transparently accessible from
the local machine. It is only when visiting files that the methods
differ.
transferring files, the overhead of the cryptographic negotiation at
startup may drown out the improvement in file transfer times.
-External transfer methods do require that the remote copy command is not
-interactive --- that is, the command does not prompt you for a password.
-If you cannot perform remote copies without a password, you will need to
-use an inline transfer method to work with @tramp{}.
+External transfer methods should be configured such a way that they
+don't require a password (with @command{ssh-agent}, or such alike).
+If it isn't possible, you should consider @ref{Password caching},
+otherwise you will be prompted for a password every copy action.
@cindex multi-hop methods
@cindex methods, multi-hop
@cindex inline methods
@cindex methods, inline
-The inline methods in @tramp{} are quite powerful and can work in
+The inline methods in @value{tramp} are quite powerful and can work in
situations where you cannot use an external transfer program to connect.
Inline methods are the only methods that work when connecting to the
remote machine via telnet. (There are also strange inline methods which
hosts, see below.)
These methods depend on the existence of a suitable encoding and
-decoding command on remote machine. Locally, @tramp{} may be able to use
-features of Emacs to decode and encode the files or it may require
-access to external commands to perform that task.
+decoding command on remote machine. Locally, @value{tramp} may be able to
+use features of @value{emacsname} to decode and encode the files or
+it may require access to external commands to perform that task.
@cindex uuencode
@cindex mimencode
@cindex base-64 encoding
-@tramp{} checks the availability and usability of commands like
+@value{tramp} checks the availability and usability of commands like
@command{mimencode} (part of the @command{metamail} package) or
@command{uuencode} on the remote host. The first reliable command
will be used. The search path can be customized, see @ref{Remote
Programs}.
-If both commands aren't available on the remote host, @tramp{}
+If both commands aren't available on the remote host, @value{tramp}
transfers a small piece of Perl code to the remote host, and tries to
apply it for encoding and decoding.
Connect to the remote host with @command{rsh}. Due to the unsecure
connection it is recommended for very local host topology only.
+On operating systems which provide the command @command{remsh} instead
+of @command{rsh}, you can use the method @option{remsh}. This is true
+for HP-UX or Cray UNICOS, for example.
+
@item @option{ssh}
@cindex method ssh
@item @option{sshx}
@cindex method sshx
@cindex sshx method
-@cindex Cygwin (with sshx method)
-As you expect, this is similar to @option{ssh}, only a little
+As you would expect, this is similar to @option{ssh}, only a little
different. Whereas @option{ssh} opens a normal interactive shell on
the remote host, this option uses @samp{ssh -t -t @var{host} -l
@var{user} /bin/sh} to open a connection. This is useful for users
where the normal login shell is set up to ask them a number of
questions when logging in. This procedure avoids these questions, and
-just gives @tramp{} a more-or-less `standard' login shell to work
+just gives @value{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
+host is not known. @value{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
-any shell prompt, which confuses @tramp{} mightily. For reasons
-unknown, some Windows ports for @command{ssh} (maybe the Cygwin one)
-require the doubled @samp{-t} option.
+invoked from an @value{emacsname} buffer, tells them that it is not
+allocating a pseudo tty. When this happens, the login shell is wont
+to not print any shell prompt, which confuses @value{tramp} mightily.
+For reasons unknown, some Windows ports for @command{ssh} require the
+doubled @samp{-t} option.
This supports the @samp{-p} kludge.
implementation of SSH. It uses @samp{plink -ssh} to log in to the
remote host.
+Additionally, the method @option{plink1} is provided, which calls
+@samp{plink -1 -ssh} in order to use SSH protocol version 1
+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: Does @command{plink} support the @samp{-p} option? @tramp{} will
+CCC: Does @command{plink} support the @samp{-p} option? @value{tramp} will
support that, anyway.
@end table
This saves the overhead of encoding and decoding that multiplexing the
transfer through the one connection has with the inline methods.
-If you want to use an external transfer method you @emph{must} be able
-to execute the transfer utility to copy files to and from the remote
+If you want to use an external transfer method you should be able to
+execute the transfer utility to copy files to and from the remote
machine without any interaction.
@cindex ssh-agent
If you use @command{rsync} via @command{ssh} then the same rule must
apply to that connection.
-If you cannot get @command{scp} to run without asking for a password but
-would still like to use @command{ssh} to secure your connection, have a
-look at the @command{ssh} based inline methods.
+If you cannot get an external method to run without asking for a
+password you should consider @ref{Password caching}.
@table @asis
@cindex rsh (with rcp method)
This method uses the @command{rsh} and @command{rcp} commands to connect
-to the remote machine and transfer files. This is probably the fastest
+to the remote machine and transfer files. This is probably the fastest
connection method available.
+The alternative method @option{remcp} uses the @command{remsh} and
+@command{rcp} commands. It should be applied on machines where
+@command{remsh} is used instead of @command{rsh}.
+
@item @option{scp} --- @command{ssh} and @command{scp}
@cindex method scp
explicitly select whether you want to use the SSH protocol version 1
or 2 to connect to the remote host. (You can also specify in
@file{~/.ssh/config}, the SSH configuration file, which protocol
-should be used, and use the regular @option{ssh} method.)
+should be used, and use the regular @option{scp} method.)
Two other variants, @option{scp1_old} and @option{scp2_old}, use the
@command{ssh1} and @command{ssh2} commands explicitly. If you don't
All the @command{ssh} based methods support the kludgy @samp{-p}
feature where you can specify a port number to connect to in the host
-name. For example, the host name @file{host#42} tells @tramp{} to
+name. For example, the host name @file{host#42} tells @value{tramp} to
specify @samp{-p 42} in the argument list for @command{ssh}.
@cindex scpx method
@cindex scp (with scpx method)
@cindex ssh (with scpx method)
-@cindex Cygwin (with scpx method)
-As you expect, this is similar to @option{scp}, only a little
+As you would expect, this is similar to @option{scp}, only a little
different. Whereas @option{scp} opens a normal interactive shell on
the remote host, this option uses @samp{ssh -t -t @var{host} -l
@var{user} /bin/sh} to open a connection. This is useful for users
where the normal login shell is set up to ask them a number of
questions when logging in. This procedure avoids these questions, and
-just gives @tramp{} a more-or-less `standard' login shell to work
+just gives @value{tramp} a more-or-less `standard' login shell to work
with.
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
-any shell prompt, which confuses @tramp{} mightily. Maybe this
-applies to the Cygwin port of SSH.
+invoked from an @value{emacsname} buffer, tells them that it is not
+allocating a pseudo tty. When this happens, the login shell is wont
+to not print any shell prompt, which confuses @value{tramp} mightily.
+
+This method supports the @samp{-p} hack.
+
+
+@item @option{scpc} --- @command{ssh} and @command{scp}
+@cindex method scpx
+@cindex scpx method
+@cindex scp (with scpx method)
+@cindex ssh (with scpx method)
+
+Newer versions of @option{ssh} (for example OpenSSH 4) offer an option
+@option{ControlMaster}. This allows @option{scp} to reuse an existing
+@option{ssh} channel, which increases performance.
+
+Before you use this method, you shall check whether your @option{ssh}
+implementation does support this option. Try from the command line
+
+@example
+ssh localhost -o ControlMaster=yes
+@end example
This method supports the @samp{-p} hack.
@cindex method fsh
@cindex fsh method
+
There is no inline method using @command{fsh} as the multiplexing
-provided by the program is not very useful in our context. @tramp{}
+provided by the program is not very useful in our context. @value{tramp}
opens just one connection to the remote host and then keeps it open,
anyway.
-@ifset emacs
@item @option{ftp}
@cindex method ftp
@cindex ftp method
-This is not a native @tramp{} method. Instead of, it forwards all
-requests to @value{ftp-package-name}.
+This is not a native @value{tramp} method. Instead of, it forwards all
+requests to @value{ftppackagename}.
+@ifset xemacs
+This works only for unified filenames, see @ref{Issues}.
@end ifset
@cindex method smb
@cindex smb method
-This is another not natural @tramp{} method. It uses the
+This is another not natural @value{tramp} method. It uses the
@command{smbclient} command on different Unices in order to connect to
an SMB server. An SMB server might be a Samba (or CIFS) server on
another UNIX host or, more interesting, a host running MS Windows. So
Since authorization is done on share level, you will be prompted
always for a password if you access another share on the same host.
-Due to security reasons, the password is not cached.
+This can be suppressed by @ref{Password caching}.
MS Windows uses for authorization both a user name and a domain name.
-Because of this, the @tramp{} syntax has been extended: you can
+Because of this, the @value{tramp} syntax has been extended: you can
specify a user name which looks like @code{user%domain} (the real user
name, then a percent sign, then the domain name). So, to connect to
the machine @code{melancholia} as user @code{daniel} of the domain
@code{BIZARRE}, and edit @file{.emacs} in the home directory (share
@code{daniel$}) I would specify the filename
-@file{@value{tramp-prefix}smb@value{tramp-postfix-single-hop}daniel%BIZARRE@@melancholia@value{tramp-postfix}/daniel$$/.emacs}.
+@file{@value{prefix}smb@value{postfixsinglehop}daniel%BIZARRE@@melancholia@value{postfix}/daniel$$/.emacs}.
The domain name as well as the user name are optional. If no user
name is specified at all, the anonymous user (without password
-prompting) is assumed. This is different from all other @tramp{}
+prompting) is assumed. This is different from all other @value{tramp}
methods, where in such a case the local user name is taken.
The @option{smb} method supports the @samp{-p} hack.
-@strong{Please note:} If Emacs runs locally under MS Windows, this
-method isn't available. Instead of, you can use UNC file names like
-@file{//melancholia/daniel$$/.emacs}. The only disadvantage is that
-there's no possiblity to specify another user name.
+@strong{Please note:} If @value{emacsname} runs locally under MS
+Windows, this method isn't available. Instead of, you can use UNC
+file names like @file{//melancholia/daniel$$/.emacs}. The only
+disadvantage is that there's no possibility to specify another user
+name.
@end table
to a `bastion host' first before you can connect to the outside world.
Of course, the target host may also require a bastion host. The format
of multi-hop filenames is slightly different than the format of normal
-@tramp{} methods.
+@value{tramp} methods.
@cindex method multi
@cindex multi method
This uses @command{rsh} to connect to the host. You do not need to
enter a password unless @command{rsh} explicitly asks for it.
+The variant @option{remsh} uses the @command{remsh} command. It
+should be applied on machines where @command{remsh} is used instead of
+@command{rsh}.
+
@item ssh
@cindex hop method ssh
@cindex ssh hop method
maybe they have to use a nonstandard port. This can be accomplished
by putting a stanza in @file{~/.ssh/config} for the account which
specifies a different port number for a certain host name. But it can
-also be accomplished within @tramp{}, by adding a multi-hop method.
+also be accomplished within @value{tramp}, by adding a multi-hop method.
For example:
@lisp
'("sshf" tramp-multi-connect-rlogin "ssh %h -l %u -p 4400%n"))
@end lisp
-Now you can use an @code{sshf} hop which connects to port 4400 instead of
+Now you can use an @option{sshf} hop which connects to port 4400 instead of
the standard port.
@vindex tramp-default-method
When you select an appropriate transfer method for your typical usage
-you should set the variable @var{tramp-default-method} to reflect that
+you should set the variable @code{tramp-default-method} to reflect that
choice. This variable controls which method will be used when a method
-is not specified in the @tramp{} file name. For example:
+is not specified in the @value{tramp} file name. For example:
@lisp
-(setq tramp-default-method "scp")
+(setq tramp-default-method "ssh")
@end lisp
@vindex tramp-default-method-alist
You can also specify different methods for certain user/host
-combinations, via the variable @var{tramp-default-method-alist}. For
+combinations, via the variable @code{tramp-default-method-alist}. For
example, the following two lines specify to use the @option{ssh}
method for all user names matching @samp{john} and the @option{rsync}
method for all host names matching @samp{lily}. The third line
@noindent
See the documentation for the variable
-@var{tramp-default-method-alist} for more details.
+@code{tramp-default-method-alist} for more details.
External transfer methods are normally preferable to inline transfer
-methods, giving better performance. They may not be useful if you use
-many remote machines where you cannot log in without a password.
+methods, giving better performance.
@xref{Inline methods}.
@xref{External transfer methods}.
environment you will use them in and, especially when used over the
Internet, the security implications of your preferred method.
-The @command{rsh} and @command{telnet} methods send your password as
-plain text as you log in to the remote machine, as well as transferring
-the files in such a way that the content can easily be read from other
-machines.
+The @option{rsh} and @option{telnet} methods send your password as
+plain text as you log in to the remote machine, as well as
+transferring the files in such a way that the content can easily be
+read from other machines.
If you need to connect to remote systems that are accessible from the
-Internet, you should give serious thought to using @command{ssh} based
+Internet, you should give serious thought to using @option{ssh} based
methods to connect. These provide a much higher level of security,
-making it a non-trivial exercise for someone to obtain your password or
-read the content of the files you are editing.
+making it a non-trivial exercise for someone to obtain your password
+or read the content of the files you are editing.
+
+
+@subsection Which method is the right one for me?
+@cindex choosing the right method
+
+Given all of the above, you are probably thinking that this is all fine
+and good, but it's not helping you to choose a method! Right you are.
+As a developer, we don't want to boss our users around but give them
+maximum freedom instead. However, the reality is that some users would
+like to have some guidance, so here I'll try to give you this guidance
+without bossing you around. You tell me whether it works @dots{}
+
+My suggestion is to use an inline method. For large files, out-of-band
+methods might be more efficient, but I guess that most people will want
+to edit mostly small files.
+
+I guess that these days, most people can access a remote machine by
+using @command{ssh}. So I suggest that you use the @option{ssh}
+method. So, type @kbd{C-x C-f
+@value{prefix}ssh@value{postfixsinglehop}root@@otherhost@value{postfix}/etc/motd
+@key{RET}} to edit the @file{/etc/motd} file on the other host.
+
+If you can't use @option{ssh} to log in to the remote host, then
+select a method that uses a program that works. For instance, Windows
+users might like the @option{plink} method which uses the PuTTY
+implementation of @command{ssh}. Or you use Kerberos and thus like
+@option{krlogin}.
+
+For the special case of editing files on the local host as another
+user, see the @option{su} or @option{sudo} methods. They offer
+shortened syntax for the @samp{root} account, like
+@file{@value{prefix}su@value{postfixsinglehop}@value{postfix}/etc/motd}.
+
+People who edit large files may want to consider @option{scp} instead
+of @option{ssh}, or @option{pscp} instead of @option{plink}. These
+out-of-band methods are faster than inline methods for large files.
+Note, however, that out-of-band methods suffer from some limitations.
+Please try first whether you really get a noticeable speed advantage
+from using an out-of-band method! Maybe even for large files, inline
+methods are fast enough.
+
@node Customizing Methods
@section Using Non-Standard Methods
@defun tramp-set-completion-function method function-list
This function sets @var{function-list} as list of completion functions
-for @var{method}.
+for @var{method}.
Example:
@example
@item @code{tramp-parse-sconfig}
@findex tramp-parse-shosts
-This function returns the host nicnames defined by @code{Host} entries
+This function returns the host nicknames defined by @code{Host} entries
in @file{~/.ssh/config} style files.
+@item @code{tramp-parse-shostkeys}
+@findex tramp-parse-shostkeys
+
+SSH2 parsing of directories @file{/etc/ssh2/hostkeys/*} and
+@file{~/ssh2/hostkeys/*}. Hosts are coded in file names
+@file{hostkey_@var{portnumber}_@var{host-name}.pub}. User names
+are always @code{nil}.
+
+@item @code{tramp-parse-sknownhosts}
+@findex tramp-parse-shostkeys
+
+Another SSH2 style parsing of directories like
+@file{/etc/ssh2/knownhosts/*} and @file{~/ssh2/knownhosts/*}. This
+case, hosts names are coded in file names
+@file{@var{host-name}.@var{algorithm}.pub}. User names are always @code{nil}.
+
@item @code{tramp-parse-hosts}
@findex tramp-parse-hosts
@end defun
+@node Password caching
+@section Reusing passwords for several connections.
+@cindex passwords
+
+Sometimes it is necessary to connect to the same remote host several
+times. Reentering passwords again and again would be annoying, when
+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
+and host name, independently of the connection method.
+
+@vindex password-cache-expiry
+Passwords are not saved permanently, that means the password caching
+is limited to the lifetime of your @value{emacsname} session. You
+can influence the lifetime of password caching by customizing the
+variable @code{password-cache-expiry}. The value is the number of
+seconds how long passwords are cached. Setting it to @code{nil}
+disables the expiration.
+
+@findex tramp-clear-passwd
+A password is removed from the cache if a connection isn't established
+successfully. You can remove a password from the cache also by
+executing @kbd{M-x tramp-clear-passwd} in a buffer containing a
+related remote file or directory.
+
+@vindex password-cache
+If you don't like this feature for security reasons, password caching
+can be disabled totally by customizing the variable
+@code{password-cache} (setting it to @code{nil}).
+
+Implementation Note: password caching is based on the package
+password.el in No Gnus. For the time being, it is activated only when
+this package is seen in the @code{load-path} while loading @value{tramp}.
+@ifset installchapter
+If you don't use No Gnus, you can take password.el from the @value{tramp}
+@file{contrib} directory, see @ref{Installation parameters}.
+@end ifset
+It will be activated mandatory once No Gnus has found its way into
+@value{emacsname}.
+
+
@node Remote Programs
-@section How @tramp{} finds and uses programs on the remote machine.
+@section How @value{tramp} finds and uses programs on the remote machine.
-@tramp{} depends on a number of programs on the remote host in order to
+@value{tramp} depends on a number of programs on the remote host in order to
function, including @command{ls}, @command{test}, @command{find} and
@command{cat}.
remote file access.
@vindex tramp-remote-path
-When @tramp{} connects to the remote machine, it searches for the
+When @value{tramp} connects to the remote machine, it searches for the
programs that it can use. The variable @var{tramp-remote-path} controls
the directories searched on the remote machine.
administrator has put the tools you want in some obscure local
directory.
-In this case, you can still use them with @tramp{}. You simply need to
+In this case, you can still use them with @value{tramp}. You simply need to
add code to your @file{.emacs} to add the directory to the remote path.
-This will then be searched by @tramp{} when you connect and the software
+This will then be searched by @value{tramp} when you connect and the software
found.
To add a directory to the remote search path, you could use code such
as:
@lisp
-@i{;; We load @tramp{} to define the variable.}
+@i{;; We load @value{tramp} to define the variable.}
(require 'tramp)
@i{;; We have @command{perl} in "/usr/local/perl/bin"}
(add-to-list 'tramp-remote-path "/usr/local/perl/bin")
@cindex @file{.login} file
@cindex shell init files
-As explained in the @ref{Overview} section, @tramp{} connects to the
+As explained in the @ref{Overview} section, @value{tramp} connects to the
remote host and talks to the shell it finds there. Of course, when you
log in, the shell executes its init files. Suppose your init file
-requires you to enter the birth date of your mother; clearly @tramp{}
+requires you to enter the birth date of your mother; clearly @value{tramp}
does not know this and hence fails to log you in to that host.
There are different possible strategies for pursuing this problem. One
-strategy is to enable @tramp{} to deal with all possible situations.
+strategy is to enable @value{tramp} to deal with all possible situations.
This is a losing battle, since it is not possible to deal with
@emph{all} situations. The other strategy is to require you to set up
-the remote host such that it behaves like @tramp{} expect. This might
+the remote host such that it behaves like @value{tramp} expects. This might
be inconvenient because you have to invest a lot of effort into shell
-setup before you can begin to use @tramp{}.
+setup before you can begin to use @value{tramp}.
-The package, therefore, pursues a combined approach. It tries to figure
-out some of the more common setups, and only requires you to avoid
-really exotic stuff. For example, it looks through a list of
+The package, therefore, pursues a combined approach. It tries to
+figure out some of the more common setups, and only requires you to
+avoid really exotic stuff. For example, it looks through a list of
directories to find some programs on the remote host. And also, it
knows that it is not obvious how to check whether a file exists, and
-therefore it tries different possibilities. (On some hosts and shells,
-the command @code{test -e} does the trick, on some hosts the shell
-builtin doesn't work but the program @code{/usr/bin/test -e} or
-@code{/bin/test -e} works. And on still other hosts, @code{ls -d} is
-the right way to do this.)
+therefore it tries different possibilities. (On some hosts and
+shells, the command @command{test -e} does the trick, on some hosts
+the shell builtin doesn't work but the program @command{/usr/bin/test
+-e} or @command{/bin/test -e} works. And on still other hosts,
+@command{ls -d} is the right way to do this.)
-Below you find a discussion of a few things that @tramp{} does not deal
+Below you find a discussion of a few things that @value{tramp} does not deal
with, and that you therefore have to set up correctly.
@table @asis
@item @var{shell-prompt-pattern}
@vindex shell-prompt-pattern
-After logging in to the remote host, @tramp{} has to wait for the remote
+After logging in to the remote host, @value{tramp} has to wait for the remote
shell startup to finish before it can send commands to the remote
shell. The strategy here is to wait for the shell prompt. In order to
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}
+Note that @value{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,
+@value{tramp} recognizes the @code{>} character as the end of the prompt,
but it is not at the end of the buffer.
@item @var{tramp-shell-prompt-pattern}
@vindex tramp-shell-prompt-pattern
-This regular expression is used by @tramp{} in the same way as
+This regular expression is used by @value{tramp} in the same way as
@code{shell-prompt-pattern}, to match prompts from the remote shell.
This second variable exists because the prompt from the remote shell
might be different from the prompt from a local shell --- after all,
-the whole point of @tramp{} is to log in to remote hosts as a
+the whole point of @value{tramp} is to log in to remote hosts as a
different user. The default value of
@code{tramp-shell-prompt-pattern} is the same as the default value of
@code{shell-prompt-pattern}, which is reported to work well in many
circumstances.
-@item @code{tset} and other questions
+@item @command{tset} and other questions
@cindex Unix command tset
@cindex tset Unix command
-Some people invoke the @code{tset} program from their shell startup
+Some people invoke the @command{tset} program from their shell startup
scripts which asks the user about the terminal type of the shell.
-Maybe some shells ask other questions when they are started. @tramp{}
+Maybe some shells ask other questions when they are started. @value{tramp}
does not know how to answer these questions. There are two approaches
for dealing with this problem. One approach is to take care that the
-shell does not ask any questions when invoked from @tramp{}. You can
+shell does not ask any questions when invoked from @value{tramp}. You can
do this by checking the @code{TERM} environment variable, it will be
set to @code{dumb} when connecting.
The variable @code{tramp-terminal-type} can be used to change this value
to @code{dumb}.
-The other approach is to teach @tramp{} about these questions. See
+The other approach is to teach @value{tramp} about these questions. See
the variables @code{tramp-actions-before-shell} and
@code{tramp-multi-actions} (for multi-hop connections).
+
+@item Environment variables named like users in @file{.profile}
+
+If you have a user named frumple and set the variable @code{FRUMPLE} in
+your shell environment, then this might cause trouble. Maybe rename
+the variable to @code{FRUMPLE_DIR} or the like.
+
+This weird effect was actually reported by a @value{tramp} user!
+
+
+@item Non-Bourne commands in @file{.profile}
+
+After logging in to the remote host, @value{tramp} issues the command
+@command{exec /bin/sh}. (Actually, the command is slightly
+different.) When @command{/bin/sh} is executed, it reads some init
+files, such as @file{~/.shrc} or @file{~/.profile}.
+
+Now, some people have a login shell which is not @code{/bin/sh} but a
+Bourne-ish shell such as bash or ksh. Some of these people might put
+their shell setup into the files @file{~/.shrc} or @file{~/.profile}.
+This way, it is possible for non-Bourne constructs to end up in those
+files. Then, @command{exec /bin/sh} might cause the Bourne shell to
+barf on those constructs.
+
+As an example, imagine somebody putting @command{export FOO=bar} into
+the file @file{~/.profile}. The standard Bourne shell does not
+understand this syntax and will emit a syntax error when it reaches
+this line.
+
+Another example is the tilde (@code{~}) character, say when adding
+@file{~/bin} to @code{$PATH}. Many Bourne shells will not expand this
+character, and since there is usually no directory whose name consists
+of the single character tilde, strange things will happen.
+
+What can you do about this?
+
+Well, one possibility is to make sure that everything in @file{~/.shrc}
+and @file{~/.profile} on all remote hosts is Bourne-compatible. In the
+above example, instead of @command{export FOO=bar}, you might use
+@command{FOO=bar; export FOO} instead.
+
+The other possibility is to put your non-Bourne shell setup into some
+other files. For example, bash reads the file @file{~/.bash_profile}
+instead of @file{~/.profile}, if the former exists. So bash
+aficionados just rename their @file{~/.profile} to
+@file{~/.bash_profile} on all remote hosts, and Bob's your uncle.
+
+The @value{tramp} developers would like to circumvent this problem, so
+if you have an idea about it, please tell us. However, we are afraid
+it is not that simple: before saying @command{exec /bin/sh},
+@value{tramp} does not know which kind of shell it might be talking
+to. It could be a Bourne-ish shell like ksh or bash, or it could be a
+csh derivative like tcsh, or it could be zsh, or even rc. If the
+shell is Bourne-ish already, then it might be prudent to omit the
+@command{exec /bin/sh} step. But how to find out if the shell is
+Bourne-ish?
+
@end table
@section Auto-save and Backup configuration
@cindex auto-save
@cindex backup
+@ifset emacs
@vindex backup-directory-alist
+@end ifset
+@ifset xemacs
+@vindex bkup-backup-directory-info
+@end ifset
-Explaining auto-save is still to do.
+Normally, @value{emacsname} writes backup files to the same directory
+as the original files, but this behavior can be changed via the
+variable
+@ifset emacs
+@code{backup-directory-alist}.
+@end ifset
+@ifset xemacs
+@code{bkup-backup-directory-info}.
+@end ifset
+In connection with @value{tramp}, this can have unexpected side effects.
+Suppose that you specify that all backups should go to the directory
+@file{~/.emacs.d/backups/}, and then you edit the file
+@file{@value{prefix}su@value{postfixsinglehop}root@@localhost@value{postfix}/etc/secretfile}.
+The effect is that the backup file will be owned by you and not by
+root, thus possibly enabling others to see it even if they were not
+intended to see it.
+
+When
+@ifset emacs
+@code{backup-directory-alist}
+@end ifset
+@ifset xemacs
+@code{bkup-backup-directory-info}
+@end ifset
+is @code{nil} (the default), such problems do not occur.
-Normally, Emacs writes backup files to the same directory as the
-original files, but this behavior can be changed via the variable
-@code{backup-directory-alist}. In connection with @tramp{}, this can
-have unexpected side effects. Suppose that you specify that all backups
-should go to the directory @file{~/.emacs.d/backups/}, and then you edit
-the file @file{/su:root@@localhost:/etc/secretfile}. The effect is that
-the backup file will be owned by you and not by root, thus possibly
-enabling others to see it even if they were not intended to see it.
+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
+@code{backup-directory-alist}
+@end ifset
+@ifset xemacs
+@code{bkup-backup-directory-info}
+@end ifset
+for @value{tramp} files:
+
+@ifset emacs
+@lisp
+(add-to-list 'backup-directory-alist
+ (cons tramp-file-name-regexp nil))
+@end lisp
+@end ifset
+@ifset xemacs
+@lisp
+(require 'backup-dir)
+(add-to-list 'bkup-backup-directory-info
+ (list tramp-file-name-regexp ""))
+@end lisp
+@end ifset
-When @code{backup-directory-alist} is nil (the default), such problems
-do not occur.
+Another possibility is to use the @value{tramp} variable
+@ifset emacs
+@code{tramp-backup-directory-alist}.
+@end ifset
+@ifset xemacs
+@code{tramp-bkup-backup-directory-info}.
+@end ifset
+This variable has the same meaning like
+@ifset emacs
+@code{backup-directory-alist}.
+@end ifset
+@ifset xemacs
+@code{bkup-backup-directory-info}.
+@end ifset
+If a @value{tramp} file is backed up, and DIRECTORY is an absolute
+local file name, DIRECTORY is prepended with the @value{tramp} file
+name prefix of the file to be backed up.
-If you wish to customize the variable, the workaround is to include
-special settings for Tramp files. For example, the following statement
-effectively `turns off' the effect of @code{backup-directory-alist} for
-@tramp{} files:
+@noindent
+Example:
+@ifset emacs
@lisp
-(require 'tramp)
(add-to-list 'backup-directory-alist
- (cons tramp-file-name-regexp nil))
+ (cons "." "~/.emacs.d/backups/"))
+(setq tramp-backup-directory-alist backup-directory-alist)
@end lisp
+@end ifset
+@ifset xemacs
+@lisp
+(require 'backup-dir)
+(add-to-list 'bkup-backup-directory-info
+ (list "." "~/.emacs.d/backups/" 'full-path))
+(setq tramp-bkup-backup-directory-info bkup-backup-directory-info)
+@end lisp
+@end ifset
+
+@noindent
+The backup file name of
+@file{@value{prefix}su@value{postfixsinglehop}root@@localhost@value{postfix}/etc/secretfile}
+would be
+@ifset emacs
+@file{@value{prefix}su@value{postfixsinglehop}root@@localhost@value{postfix}~/.emacs.d/backups/!su:root@@localhost:!etc!secretfile~}
+@end ifset
+@ifset xemacs
+@file{@value{prefix}su@value{postfixsinglehop}root@@localhost@value{postfix}~/.emacs.d/backups/![su!root@@localhost]!etc!secretfile~}
+@end ifset
+
+The same problem can happen with auto-saving files.
+@ifset emacs
+Since @value{emacsname} 21, the variable
+@code{auto-save-file-name-transforms} keeps information, on which
+directory an auto-saved file should go. By default, it is initialized
+for @value{tramp} files to the local temporary directory.
+
+On some versions of @value{emacsname}, namely the version built for
+Debian GNU/Linux, the variable @code{auto-save-file-name-transforms}
+contains the directory where @value{emacsname} was built. A
+workaround is to manually set the variable to a sane value.
+
+If auto-saved files should go into the same directory as the original
+files, @code{auto-save-file-name-transforms} should be set to @code{nil}.
+
+Another possibility is to set the variable
+@code{tramp-auto-save-directory} to a proper value.
+@end ifset
+@ifset xemacs
+For this purpose you can set the variable @code{auto-save-directory}
+to a proper value.
+@end ifset
@node Windows setup hints
@cindex method sshx with Cygwin
@cindex sshx method with Cygwin
-If you use the Cygwin installation of ssh (you have to explicitly select
-it in the installer), then it should work out of the box to just select
-@code{sshx} as the connection method. You can find information about
-setting up Cygwin in their FAQ at @uref{http://cygwin.com/faq/}.
+The recent Cygwin installation of @command{ssh} works only with a
+Cygwinized @value{emacsname}. You can check it by typing @kbd{M-x
+eshell}, and starting @kbd{ssh test.machine}. The problem is evident
+if you see a message like this:
+
+@example
+Pseudo-terminal will not be allocated because stdin is not a terminal.
+@end example
+
+Older @command{ssh} versions of Cygwin are told to cooperate with
+@value{tramp} selecting @option{sshx} as the connection method. You
+can find information about setting up Cygwin in their FAQ at
+@uref{http://cygwin.com/faq/}.
@cindex method scpx with Cygwin
@cindex scpx method with Cygwin
-If you wish to use the @code{scpx} connection method, then you might
-have the problem that Emacs calls @code{scp} with a Windows filename
-such as @code{c:/foo}. The Cygwin version of @code{scp} does not know
-about Windows filenames and interprets this as a remote filename on the
-host @code{c}.
+If you wish to use the @option{scpx} connection method, then you might
+have the problem that @value{emacsname} calls @command{scp} with a
+Windows filename such as @code{c:/foo}. The Cygwin version of
+@command{scp} does not know about Windows filenames and interprets this
+as a remote filename on the host @code{c}.
-One possible workaround is to write a wrapper script for @code{scp}
+One possible workaround is to write a wrapper script for @option{scp}
which converts the Windows filename to a Cygwinized filename.
-I guess that another workaround is to run Emacs under Cygwin, or to run
-a Cygwinized Emacs.
-
@cindex Cygwin and ssh-agent
-@cindex SSH_AUTH_SOCK and Emacs on Windows
-If you want to use either @code{ssh} based method on Windows, then you
-might encounter problems with @code{ssh-agent}. Using this program,
-you can avoid typing the pass-phrase every time you log in (and the
-@code{scpx} method more or less requires you to use @code{ssh-agent}
-because it does not allow you to type a password or pass-phrase).
-However, if you start Emacs from a desktop shortcut, then the
-environment variable @code{SSH_AUTH_SOCK} is not set and so Emacs and
-thus @tramp{} and thus @code{ssh} and @code{scp} started from @tramp{}
-cannot communicate with @code{ssh-agent}. It works better to start
-Emacs from the shell.
-
-If anyone knows how to start @code{ssh-agent} under Windows in such a
+@cindex SSH_AUTH_SOCK and @value{emacsname} on Windows
+If you want to use either @option{ssh} based method on Windows, then
+you might encounter problems with @command{ssh-agent}. Using this
+program, you can avoid typing the pass-phrase every time you log in.
+However, if you start @value{emacsname} from a desktop shortcut, then
+the environment variable @code{SSH_AUTH_SOCK} is not set and so
+@value{emacsname} and thus @value{tramp} and thus @command{ssh} and
+@command{scp} started from @value{tramp} cannot communicate with
+@command{ssh-agent}. It works better to start @value{emacsname} from
+the shell.
+
+If anyone knows how to start @command{ssh-agent} under Windows in such a
way that desktop shortcuts can profit, please holler. I don't really
know anything at all about Windows@dots{}
@node Usage
-@chapter Using @tramp
-@cindex using @tramp
+@chapter Using @value{tramp}
+@cindex using @value{tramp}
-Once you have installed @tramp{} it will operate fairly transparently. You
+Once you have installed @value{tramp} it will operate fairly transparently. You
will be able to access files on any remote machine that you can log in
to as though they were local.
-Files are specified to @tramp{} using a formalized syntax specifying the
+Files are specified to @value{tramp} using a formalized syntax specifying the
details of the system to connect to. This is similar to the syntax used
-by the @value{ftp-package-name} package.
+by the @value{ftppackagename} package.
@cindex type-ahead
-Something that might happen which surprises you is that Emacs
-remembers all your keystrokes, so if you see a password prompt from
-Emacs, say, and hit @kbd{@key{RET}} twice instead of once, then the
-second keystroke will be processed by Emacs after @tramp{} has done
-its thing. Why, this type-ahead is normal behavior, you say. Right
-you are, but be aware that opening a remote file might take quite a
-while, maybe half a minute when a connection needs to be opened.
-Maybe after half a minute you have already forgotten that you hit that
-key!
+Something that might happen which surprises you is that
+@value{emacsname} remembers all your keystrokes, so if you see a
+password prompt from @value{emacsname}, say, and hit @kbd{@key{RET}}
+twice instead of once, then the second keystroke will be processed by
+@value{emacsname} after @value{tramp} has done its thing. Why, this
+type-ahead is normal behavior, you say. Right you are, but be aware
+that opening a remote file might take quite a while, maybe half a
+minute when a connection needs to be opened. Maybe after half a
+minute you have already forgotten that you hit that key!
@menu
-* Filename Syntax:: @tramp{} filename conventions.
+* Filename Syntax:: @value{tramp} filename conventions.
* Multi-hop filename syntax:: Multi-hop filename conventions.
* Filename completion:: Filename completion.
* Dired:: Dired.
+* Compilation:: Compile remote files.
@end menu
@node Filename Syntax
-@section @tramp{} filename conventions
+@section @value{tramp} filename conventions
@cindex filename syntax
@cindex filename examples
To access the file @var{localname} on the remote machine @var{machine} you
would specify the filename
-@file{@value{tramp-prefix}@var{machine}@value{tramp-postfix}@var{localname}}.
+@file{@value{prefix}@var{machine}@value{postfix}@var{localname}}.
This will connect to @var{machine} and transfer the file using the
default method. @xref{Default Method}.
-Some examples of @tramp{} filenames are shown below.
+Some examples of @value{tramp} filenames are shown below.
@table @file
-@item @value{tramp-prefix}melancholia@value{tramp-postfix}.emacs
+@item @value{prefix}melancholia@value{postfix}.emacs
Edit the file @file{.emacs} in your home directory on the machine
@code{melancholia}.
-@item @value{tramp-prefix}melancholia.danann.net@value{tramp-postfix}.emacs
+@item @value{prefix}melancholia.danann.net@value{postfix}.emacs
This edits the same file, using the fully qualified domain name of
the machine.
-@item @value{tramp-prefix}melancholia@value{tramp-postfix}~/.emacs
+@item @value{prefix}melancholia@value{postfix}~/.emacs
This also edits the same file --- the @file{~} is expanded to your
home directory on the remote machine, just like it is locally.
-@item @value{tramp-prefix}melancholia@value{tramp-postfix}~daniel/.emacs
+@item @value{prefix}melancholia@value{postfix}~daniel/.emacs
This edits the file @file{.emacs} in the home directory of the user
@code{daniel} on the machine @code{melancholia}. The @file{~<user>}
construct is expanded to the home directory of that user on the remote
machine.
-@item @value{tramp-prefix}melancholia@value{tramp-postfix}/etc/squid.conf
+@item @value{prefix}melancholia@value{postfix}/etc/squid.conf
This edits the file @file{/etc/squid.conf} on the machine
@code{melancholia}.
@end table
-Unless you specify a different name to use, @tramp{} will use the
+Unless you specify a different name to use, @value{tramp} will use the
current local user name as the remote user name to log in with. If you
need to log in as a different user, you can specify the user name as
part of the filename.
To log in to the remote machine as a specific user, you use the syntax
-@file{@value{tramp-prefix}@var{user}@@@var{machine}@value{tramp-postfix}/@var{path/to.file}}.
+@file{@value{prefix}@var{user}@@@var{machine}@value{postfix}/@var{path/to.file}}.
That means that connecting to @code{melancholia} as @code{daniel} and
editing @file{.emacs} in your home directory you would specify
-@file{@value{tramp-prefix}daniel@@melancholia@value{tramp-postfix}.emacs}.
+@file{@value{prefix}daniel@@melancholia@value{postfix}.emacs}.
It is also possible to specify other file transfer methods
(@pxref{Default Method}) as part of the filename.
@ifset emacs
This is done by putting the method before the user and host name, as
in
-@file{@value{tramp-prefix}@var{method}@value{tramp-postfix-single-hop}}
+@file{@value{prefix}@var{method}@value{postfixsinglehop}}
(Note the trailing colon).
@end ifset
@ifset xemacs
This is done by replacing the initial
-@file{@value{tramp-prefix}} with
-@file{@value{tramp-prefix}<method>@value{tramp-postfix-single-hop}}.
+@file{@value{prefix}} with
+@file{@value{prefix}<method>@value{postfixsinglehop}}.
(Note the trailing slash!).
@end ifset
The user, machine and file specification remain the same.
So, to connect to the machine @code{melancholia} as @code{daniel},
-using the @option{su} method to transfer files, and edit @file{.emacs}
+using the @option{ssh} method to transfer files, and edit @file{.emacs}
in my home directory I would specify the filename
-@file{@value{tramp-prefix}su@value{tramp-postfix-single-hop}daniel@@melancholia@value{tramp-postfix}.emacs}.
+@file{@value{prefix}ssh@value{postfixsinglehop}daniel@@melancholia@value{postfix}.emacs}.
@node Multi-hop filename syntax
@cindex multi-hop filename syntax
The syntax of multi-hop file names is necessarily slightly different
-than the syntax of other @tramp{} file names. Here's an example
-multi-hop file name, first in Emacs syntax and then in XEmacs syntax:
+than the syntax of other @value{tramp} file names. Here's an example
+multi-hop file name:
@example
-@value{tramp-prefix}multi@value{tramp-postfix-single-hop}rsh@value{tramp-postfix-multi-hop}out@@gate@value{tramp-postfix-single-hop}telnet@value{tramp-postfix-multi-hop}kai@@real.host@value{tramp-postfix}/path/to.file
+@value{prefix}multi@value{postfixsinglehop}rsh@value{postfixmultihop}out@@gate@value{postfixsinglehop}telnet@value{postfixmultihop}kai@@real.host@value{postfix}/path/to.file
@end example
This is quite a mouthful. So let's go through it step by step. The
@ifset xemacs
The parts are separated by slashes and square brackets.
@end ifset
-The first part is @file{@value{tramp-prefix}multi}, the method
+The first part is @file{@value{prefix}multi}, the method
specification. The second part is
-@file{rsh@value{tramp-postfix-multi-hop}out@@gate@value{tramp-postfix-single-hop}telnet@value{tramp-postfix-multi-hop}kai@@real.host}
+@file{rsh@value{postfixmultihop}out@@gate@value{postfixsinglehop}telnet@value{postfixmultihop}kai@@real.host}
and specifies the hops. The final part is @file{/path/to.file} and
specifies the file name on the remote host.
The second part can be subdivided again into components, so-called
hops. In the above file name, there are two hops,
-@file{rsh@value{tramp-postfix-multi-hop}out@@gate} and
-@file{telnet@value{tramp-postfix-multi-hop}kai@@real.host}.
+@file{rsh@value{postfixmultihop}out@@gate} and
+@file{telnet@value{postfixmultihop}kai@@real.host}.
Each hop can @emph{again} be subdivided into (three) components, the
@dfn{hop method}, the @dfn{user name} and the @dfn{host name}. The
meaning of the second and third component should be clear, and the hop
method says what program to use to perform that hop.
-The first hop, @file{rsh@value{tramp-postfix-multi-hop}out@@gate},
+The first hop, @file{rsh@value{postfixmultihop}out@@gate},
says to use @command{rsh} to log in as user @code{out} to the host
@code{gate}. Starting at that host, the second hop,
-@file{telnet@value{tramp-postfix-multi-hop}kai@@real.host}, says to
+@file{telnet@value{postfixmultihop}kai@@real.host}, says to
use @command{telnet} to log in as user @code{kai} to host
@code{real.host}.
@section Filename completion
@cindex filename completion
-Filename completion works with @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{tramp-prefix}t
-@key{TAB}}, @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
@example
@ifset emacs
-@value{tramp-prefix-single-hop}telnet@value{tramp-postfix-single-hop} tmp/
-@value{tramp-prefix-single-hop}toto@value{tramp-postfix}
+@value{prefixsinglehop}telnet@value{postfixsinglehop} tmp/
+@value{prefixsinglehop}toto@value{postfix}
@end ifset
@ifset xemacs
-@value{tramp-prefix-single-hop}telnet@value{tramp-postfix-single-hop} @value{tramp-prefix-single-hop}toto@value{tramp-postfix}
+@value{prefixsinglehop}telnet@value{postfixsinglehop} @value{prefixsinglehop}toto@value{postfix}
@end ifset
@end example
-@samp{@value{tramp-prefix-single-hop}telnet@value{tramp-postfix-single-hop}}
+@samp{@value{prefixsinglehop}telnet@value{postfixsinglehop}}
is a possible completion for the respective method,
@ifset emacs
@samp{tmp/} stands for the directory @file{/tmp} on your local
machine,
@end ifset
-and @samp{@value{tramp-prefix-single-hop}toto@value{tramp-postfix}}
-might be a host @tramp has detected in your @file{~/.ssh/known_hosts}
+and @samp{@value{prefixsinglehop}toto@value{postfix}}
+might be a host @value{tramp} has detected in your @file{~/.ssh/known_hosts}
file (given you're using default method @option{ssh}).
If you go on to type @kbd{e @key{TAB}}, the minibuffer is completed to
-@samp{@value{tramp-prefix}telnet@value{tramp-postfix-single-hop}}.
-Next @kbd{@key{TAB}} brings you all machine names @tramp{} detects in
+@samp{@value{prefix}telnet@value{postfixsinglehop}}.
+Next @kbd{@key{TAB}} brings you all machine names @value{tramp} detects in
your @file{/etc/hosts} file, let's say
@example
-@value{tramp-prefix-single-hop}telnet@value{tramp-postfix-single-hop}127.0.0.1@value{tramp-postfix} @value{tramp-prefix-single-hop}telnet@value{tramp-postfix-single-hop}192.168.0.1@value{tramp-postfix}
-@value{tramp-prefix-single-hop}telnet@value{tramp-postfix-single-hop}localhost@value{tramp-postfix} @value{tramp-prefix-single-hop}telnet@value{tramp-postfix-single-hop}melancholia.danann.net@value{tramp-postfix}
-@value{tramp-prefix-single-hop}telnet@value{tramp-postfix-single-hop}melancholia@value{tramp-postfix}
+@value{prefixsinglehop}telnet@value{postfixsinglehop}127.0.0.1@value{postfix} @value{prefixsinglehop}telnet@value{postfixsinglehop}192.168.0.1@value{postfix}
+@value{prefixsinglehop}telnet@value{postfixsinglehop}localhost@value{postfix} @value{prefixsinglehop}telnet@value{postfixsinglehop}melancholia.danann.net@value{postfix}
+@value{prefixsinglehop}telnet@value{postfixsinglehop}melancholia@value{postfix}
@end example
Now you can choose the desired machine, and you can continue to
complete file names on that machine.
As filename completion needs to fetch the listing of files from the
-remote machine, this feature is sometimes fairly slow. As @tramp{}
+remote machine, this feature is sometimes fairly slow. As @value{tramp}
does not yet cache the results of directory listing, there is no gain
in performance the second time you complete filenames.
If the configuration files (@pxref{Customizing Completion}), which
-@tramp{} uses for analysis of completion, offer user names, those user
+@value{tramp} uses for analysis of completion, offer user names, those user
names will be taken into account as well.
@section Dired
@cindex dired
-@tramp{} works transparently with dired, enabling you to use this powerful
+@value{tramp} works transparently with dired, enabling you to use this powerful
file management tool to manage files on any machine you have access to
over the Internet.
and will only fetch the directory listing once.
+@node Compilation
+@section Compile remote files
+@cindex compile
+@cindex recompile
+
+@value{tramp} provides commands for compilation of files on remote
+machines. In order to get them loaded, you need to require
+@file{tramp-util.el}:
+
+@lisp
+(require 'tramp-util)
+@end lisp
+
+Afterwards, you can use the commands @code{tramp-compile} and
+@code{tramp-recompile} instead of @code{compile} and @code{recompile},
+respectively; @inforef{Compilation, ,@value{emacsdir}}. This does not
+work for the @option{ftp} and @option{smb} methods.
+
+The corresponding key bindings and menu entries calling these commands
+are redefined automatically for buffers associated with remote files.
+
+After finishing the compilation, you can use the usual commands like
+@code{previous-error}, @code{next-error} and @code{first-error} for
+navigation in the @file{*Compilation*} buffer.
+
+
@node Bug Reports
@chapter Reporting Bugs and Problems
@cindex bug reports
-Bugs and problems with @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 @tramp{} mailing list is a great place to get information on working
-with @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@@mail.freesoftware.fsf.org}.
-Messages sent to this address go to all the subscribers. This is
-@emph{not} the address to send subscription requests to.
+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
+to send subscription requests to.
-For help on subscribing to the list, send mail to the administrative
-address, @email{tramp-devel-request@@mail.freesoftware.fsf.org}, with the
-subject @samp{help}.
+Subscribing to the list is performed via
+@uref{http://lists.gnu.org/mailman/listinfo/tramp-devel/,
+the @value{tramp} Mail Subscription Page}.
-To report a bug in @tramp{}, you should execute @kbd{M-x tramp-bug}. This
+To report a bug in @value{tramp}, you should execute @kbd{M-x tramp-bug}. This
will automatically generate a buffer with the details of your system and
-@tramp{} version.
+@value{tramp} version.
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
@itemize @bullet
@item
-Where can I get the latest @tramp{}?
+Where can I get the latest @value{tramp}?
-@tramp{} is available under the URL below.
+@value{tramp} is available under the URL below.
@noindent
-@uref{http://savannah.nongnu.org/download/tramp/}
+@uref{ftp://ftp.gnu.org/gnu/tramp/}
@noindent
There is also a Savannah project page.
@noindent
-@uref{https://savannah.gnu.org/projects/tramp/}
+@uref{http://savannah.gnu.org/projects/tramp/}
+
@item
Which systems does it work on?
-The package has been used successfully on Emacs 20 and Emacs 21, as well
-as XEmacs 21. XEmacs 20 is more problematic, see the notes in
-@file{tramp.el}. I don't think anybody has really tried it on Emacs 19.
+The package has been used successfully on GNU Emacs 20, GNU Emacs 21
+and GNU Emacs 22, as well as XEmacs 21. XEmacs 20 is more
+problematic, see the notes in @file{tramp.el}. I don't think anybody
+has really tried it on GNU Emacs 19.
The package was intended to work on Unix, and it really expects a
-Unix-like system on the remote end, but some people seemed to have some
-success getting it to work on NT Emacs.
+Unix-like system on the remote end (except the @option{smb} method),
+but some people seemed to have some success getting it to work on MS
+Windows NT/2000/XP @value{emacsname}.
-There is some informations on @tramp{} on NT at the following URL;
+There is some informations on @value{tramp} on NT at the following URL;
many thanks to Joe Stoy for providing the information:
@uref{ftp://ftp.comlab.ox.ac.uk/tmp/Joe.Stoy/}
+@c The link is broken. I've contacted Tom for clarification. Michael.
+@ignore
The above mostly contains patches to old ssh versions; Tom Roche has a
Web page with instructions:
@uref{http://www4.ncsu.edu/~tlroche/plinkTramp.html}
-
-??? Is the XEmacs info correct?
-
-??? Can somebody provide some information for getting it to work on NT
-Emacs? I think there was some issue with @command{ssh}?
+@end ignore
@item
-I can't stop @value{ftp-package-name} starting with @value{emacs-name}
+@value{tramp} does not connect to the remote host
-@ifset emacs
-@value{ftp-package-name} is loaded from @tramp{} automatically if you
-require a file by the ftp method. Unfortunately, there are some Lisp
-packages which make @value{ftp-package-name} 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{ftp-package-name}, and raise a bug report.
+@item
+Unknown characters in the prompt
-A workaround is to require @value{ftp-package-name} before @tramp{} in
-your @file{~/.emacs}, because @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{ftp-package-name} temporarily required
-(require 'ange-ftp)
-;; @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 @tramp{} supported @value{emacs-name}
-correctly. The first thing to do is to make sure that you have the
-latest version of @tramp{} installed.
-
-If you do, please try and find out exactly the conditions required for
-the @value{ftp-package-name} 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
-File name completion does not work with @tramp{}
+File name completion does not work with @value{tramp}
When you log in to the remote machine, do you see the output of
@command{ls} in color? If so, this may be the cause of your problems.
@command{ls} outputs @acronym{ANSI} escape sequences that your terminal
emulator interprets to set the colors. These escape sequences will
-confuse @tramp{} however.
+confuse @value{tramp} however.
In your @file{.bashrc}, @file{.profile} or equivalent on the remote
machine you probably have an alias configured that adds the option
You should remove that alias and ensure that a new login @emph{does not}
display the output of @command{ls} in color. If you still cannot use
-filename completion, report a bug to the @tramp{} developers.
+filename completion, report a bug to the @value{tramp} developers.
@item
File name completion does not work in large directories
-@tramp{} uses globbing for some operations. (Globbing means to use the
+@value{tramp} uses globbing for some operations. (Globbing means to use the
shell to expand wildcards such as `*.c'.) This might create long
command lines, especially in directories with many files. Some shells
choke on long command lines, or don't cope well with the globbing
@item
-What kinds of systems does @tramp{} work on
-
-@tramp{} really expects the remote system to be a Unix-like system. The
-local system should preferably be Unix-like, as well, but @tramp{} might
-work on NT with some tweaking.
+How can I get notified when @value{tramp} file transfers are complete?
-
-@item
-How can I get notified when @tramp{} file transfers are complete?
-
-The following snippet can be put in your @file{~/.emacs} file. It makes
-Emacs beep after reading from or writing to the remote host.
+The following snippet can be put in your @file{~/.emacs} file. It
+makes @value{emacsname} beep after reading from or writing to the
+remote host.
@lisp
(defadvice tramp-handle-write-region
There's this @file{~/.sh_history} file on the remote host which keeps
growing and growing. What's that?
-Sometimes, @tramp{} starts @code{ksh} on the remote host for tilde
-expansion. Maybe @code{ksh} saves the history by default. @tramp{}
-tries to turn off saving the history, but maybe you have to help. For
-example, you could put this in your @file{.kshrc}:
+Sometimes, @value{tramp} starts @command{ksh} on the remote host for
+tilde expansion. Maybe @command{ksh} saves the history by default.
+@value{tramp} tries to turn off saving the history, but maybe you have
+to help. For example, you could put this in your @file{.kshrc}:
@example
if [ -f $HOME/.sh_history ] ; then
@end example
-@item @tramp{} doesn't transfer strings with more than 500 characters
-correctly
+@item
+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
@c For the developer
@node Version Control
@chapter The inner workings of remote version control
+@cindex Version Control
-Unlike @value{ftp-package-name}, @tramp{} has full shell access to the
+Unlike @value{ftppackagename}, @value{tramp} has full shell access to the
remote machine. This makes it possible to provide version control for
-files accessed under @tramp{}.
+files accessed under @value{tramp}.
The actual version control binaries must be installed on the remote
machine, accessible in the directories specified in
@var{tramp-remote-path}.
This transparent integration with the version control systems is one of
-the most valuable features provided by @tramp{}, but it is far from perfect.
+the most valuable features provided by @value{tramp}, but it is far from perfect.
Work is ongoing to improve the transparency of the system.
@menu
The VC package uses the existence of on-disk revision control master
files to determine if a given file is under revision control. These file
-tests happen on the remote machine through the standard @tramp{} mechanisms.
+tests happen on the remote machine through the standard @value{tramp} mechanisms.
@node Remote Commands
To work around this, the functions @code{vc-do-command} and
@code{vc-simple-command} have been advised to intercept requests for
-operations on files accessed via @tramp{}.
+operations on files accessed via @value{tramp}.
In the case of a remote file, the @code{shell-command} interface is
used, with some wrapper code, to provide the same functionality on the
-remote machine as would be seen on the local machine.
+remote machine as would be seen on the local machine.
@node Changed workfiles
As there is currently no way to get access to the mtime of a file on a
remote machine in a portable way, the @code{vc-workfile-unchanged-p}
-function is advised to call an @tramp{} specific function for remote files.
+function is advised to call an @value{tramp} specific function for remote files.
The @code{tramp-vc-workfile-unchanged-p} function uses the functioning VC
diff functionality to determine if any changes have occurred between the
VC will, by default, check for remote files and refuse to act on them
when checking out files from the repository. To work around this
-problem, the function @code{vc-checkout} knows about @tramp{} files and
+problem, the function @code{vc-checkout} knows about @value{tramp} files and
allows version control to occur.
@node Remote File Ownership
@subsection How VC determines who owns a workfile
-Emacs provides the @code{user-full-name} function to return the login name
-of the current user as well as mapping from arbitrary user id values
-back to login names. The VC code uses this functionality to map from the
-uid of the owner of a workfile to the login name in some circumstances.
+@value{emacsname} provides the @code{user-full-name} function to
+return the login name of the current user as well as mapping from
+arbitrary user id values back to login names. The VC code uses this
+functionality to map from the uid of the owner of a workfile to the
+login name in some circumstances.
This will not, for obvious reasons, work if the remote system has a
different set of logins. As such, it is necessary to delegate to the
of the version control tools and, while this is painful, we need to
ensure that unavailable features are not used remotely.
-To resolve this issue, @tramp{} currently takes the sledgehammer
+To resolve this issue, @value{tramp} currently takes the sledgehammer
approach of making the release values of the revision control tools
-local to each @tramp{} buffer, forcing VC to determine these values
+local to each @value{tramp} buffer, forcing VC to determine these values
again each time a new file is visited.
This has, quite obviously, some performance implications. Thankfully,
that the remote version be known. This makes the problem far less
apparent.
-Eventually these values will be captured by @tramp{} on a system by
+Eventually these values will be captured by @value{tramp} on a system by
system basis and the results cached to improve performance.
@node Localname deconstruction
@section Breaking a localname into its components.
-@tramp{} file names are somewhat different, obviously, to ordinary file
+@value{tramp} file names are somewhat different, obviously, to ordinary file
names. As such, the lisp functions @code{file-name-directory} and
-@code{file-name-nondirectory} are overridden within the @tramp{}
+@code{file-name-nondirectory} are overridden within the @value{tramp}
package.
Their replacements are reasonably simplistic in their approach. They
dissect the filename, call the original handler on the localname and
-then rebuild the @tramp{} file name with the result.
+then rebuild the @value{tramp} file name with the result.
This allows the platform specific hacks in the original handlers to take
-effect while preserving the @tramp{} file name information.
+effect while preserving the @value{tramp} file name information.
@node Issues
@itemize @bullet
@item The uuencode method does not always work.
-Due to the design of @tramp{}, the encoding and decoding programs need to
-read from stdin and write to stdout. On some systems, @code{uudecode -o
--} will read stdin and write the decoded file to stdout, on other
-systems @code{uudecode -p} does the same thing. But some systems have
-uudecode implementations which cannot do this at all---it is not
-possible to call these uudecode implementations with suitable parameters
-so that they write to stdout.
+Due to the design of @value{tramp}, the encoding and decoding programs
+need to read from stdin and write to stdout. On some systems,
+@command{uudecode -o -} will read stdin and write the decoded file to
+stdout, on other systems @command{uudecode -p} does the same thing.
+But some systems have uudecode implementations which cannot do this at
+all---it is not possible to call these uudecode implementations with
+suitable parameters so that they write to stdout.
Of course, this could be circumvented: the @code{begin foo 644} line
could be rewritten to put in some temporary file name, then
-@code{uudecode} could be called, then the temp file could be printed and
-deleted.
+@command{uudecode} could be called, then the temp file could be
+printed and deleted.
But I have decided that this is too fragile to reliably work, so on some
systems you'll have to do without the uuencode methods.
-@item @tramp{} does not work on XEmacs 20.
+@item @value{tramp} does not work on XEmacs 20.
This is because it requires the macro @code{with-timeout} which does not
appear to exist in XEmacs 20. I'm somewhat reluctant to add an
-emulation macro to @tramp{}, but if somebody who uses XEmacs 20 steps
+emulation macro to @value{tramp}, but if somebody who uses XEmacs 20 steps
forward and wishes to implement and test it, please contact me or the
mailing list.
-@item The @tramp{} filename syntax differs between Emacs and XEmacs.
+@item The @value{tramp} filename syntax differs between GNU Emacs and XEmacs.
-The Emacs maintainers wish to use a unified filename syntax for
-Ange-FTP and @tramp{} so that users don't have to learn a new
+The GNU Emacs maintainers wish to use a unified filename syntax for
+Ange-FTP and @value{tramp} so that users don't have to learn a new
syntax. It is sufficient to learn some extensions to the old syntax.
For the XEmacs maintainers, the problems caused from using a unified
filename syntax are greater than the gains. The XEmacs package system
uses EFS for downloading new packages. So, obviously, EFS has to be
-installed from the start. If the filenames were unified, @tramp{}
+installed from the start. If the filenames were unified, @value{tramp}
would have to be installed from the start, too.
+@ifset xemacs
+@strong{Note:} If you'd like to use a similar syntax like
+@value{ftppackagename}, you need the following settings in your init
+file:
+
+@lisp
+(setq tramp-unified-filenames t)
+(require 'tramp)
+@end lisp
+
+The autoload of the @value{emacsname} @value{tramp} package must be
+disabled. This can be achieved by setting file permissions @code{000}
+to the files @file{.../xemacs-packages/lisp/tramp/auto-autoloads.el*}.
+
+In case of unified filenames, all @value{emacsname} download sites
+are added to @code{tramp-default-method-alist} with default method
+@option{ftp} @xref{Default Method}. These settings shouldn't be touched
+for proper working of the @value{emacsname} package system.
+
+The syntax for unified filenames is described in the @value{tramp} manual
+for @value{emacsothername}.
+@end ifset
@end itemize
+@node GNU Free Documentation License
+@appendix GNU Free Documentation License
+@include doclicense.texi
+@node Concept Index
+@comment node-name, next, previous, up
+@unnumbered Concept Index
+@printindex cp
+@contents
@c End of tramp.texi - the TRAMP User Manual
@bye
@c ** Use `filename' resp. `file name' consistently.
@c ** Use `host' resp. `machine' consistently.
@c ** Consistent small or capitalized words especially in menues.
+
+@ignore
+ arch-tag: f96dd66e-6dd3-4c92-8d77-9c56205ba808
+@end ignore
HCoop / bpt / emacs.git / blobdiff