TRAMP User Manual

Table of Contents

Next: , Previous: (dir), Up: (dir)   [Contents][Index]

TRAMP version 2.2.9 User Manual

This file documents TRAMP version 2.2.9, a remote file editing package for XEmacs.

TRAMP stands for ‘Transparent Remote (file) Access, Multiple Protocol’. This package provides remote file editing, similar to EFS.

The difference is that EFS uses FTP to transfer files between the local and the remote host, whereas TRAMP uses a combination of rsh and rcp or other work-alike programs, such as ssh/scp.

You can find the latest version of this document on the web at http://www.gnu.org/software/tramp/.

The manual has been generated for XEmacs. If you’re using the other Emacs flavor, you should read the Emacs pages.

The latest release of TRAMP is available for download, or you may see Obtaining Tramp for more details, including the Git server details.

TRAMP also has a Savannah Project Page.

There is a mailing list for TRAMP, available at tramp-devel@gnu.org, and archived at the TRAMP Mail Archive. Older archives are located at SourceForge Mail Archive and The Mail Archive.

Copyright © 1999–2014 Free Software Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 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 license is included in the section entitled “GNU Free Documentation License”.

(a) The FSF’s Back-Cover Text is: “You have the freedom to copy and modify this GNU manual.”


Next: , Up: Top   [Contents][Index]

1 An overview of TRAMP

After the installation of TRAMP into your XEmacs, you will be able to access files on remote hosts as though they were local. Access to the remote file system for editing files, version control, and dired are transparently enabled.

Your access to the remote host can be with the rsh, rlogin, telnet programs or with any similar connection method. This connection must pass ASCII successfully to be usable but need not be 8-bit clean.

The package provides support for ssh connections out of the box, one of the more common uses of the package. This allows relatively secure access to hosts, especially if ftp access is disabled.

Under Windows, TRAMP is integrated with the PuTTY package, using the plink program.

The majority of activity carried out by 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 to the local host temporarily.

TRAMP can transfer files between the hosts in a variety of ways. The details are easy to select, depending on your needs and the hosts in question.

The fastest transfer methods for large files rely on a remote file transfer package such as rcp, scp, rsync or (under Windows) pscp.

If the remote copy methods are not suitable for you, TRAMP also supports the use of encoded transfers directly through the shell. This requires that the mimencode or uuencode tools are available on the remote host. These methods are generally faster for small files.

TRAMP is still under active development and any problems you encounter, trivial or major, should be reported to the TRAMP developers. See Bug Reports.

Behind the scenes

This section tries to explain what goes on behind the scenes when you access a remote file through TRAMP.

Suppose you type C-x C-f and enter part of an TRAMP file name, then hit TAB for completion. Suppose further that this is the first time that TRAMP is invoked for the host in question. Here’s what happens:

I hope this has provided you with a basic overview of what happens behind the scenes when you open a file with TRAMP.


Next: , Previous: Overview, Up: Top   [Contents][Index]

2 Obtaining Tramp.

TRAMP is freely available on the Internet and the latest release may be downloaded from ftp://ftp.gnu.org/gnu/tramp/. This release includes the full documentation and code for TRAMP, suitable for installation. But Emacs (22 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…

For the especially brave, TRAMP is available from Git. The Git 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 from Git can be found by going to the Savannah project page at the following URL and then clicking on the Git link in the navigation bar at the top.

http://savannah.gnu.org/projects/tramp/

Or follow the example session below:

] cd ~/xemacs
] git clone git://git.savannah.gnu.org/tramp.git

Tramp developers use instead

] git clone login@git.sv.gnu.org:/srv/git/tramp.git

You should now have a directory ~/xemacs/tramp containing the latest version of TRAMP. You can fetch the latest updates from the repository by issuing the command:

] cd ~/xemacs/tramp
] git pull

Once you’ve got updated files from the Git repository, you need to run autoconf in order to get an up-to-date configure script:

] cd ~/xemacs/tramp
] autoconf

Next: , Previous: Obtaining Tramp, Up: Top   [Contents][Index]

3 History of TRAMP

Development was started end of November 1998. The package was called rssh.el, back then. It only provided one method to access a file, using ssh to log in to a remote host and using scp to transfer the file contents. After a while, the name was changed to rcp.el, and now it’s 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.

After that, there were added the multi-hop methods in April 2000 and the unification of TRAMP and Ange-FTP file names in July 2002. In July 2004, multi-hop methods have been replaced by proxy hosts. Running commands on remote hosts was introduced in December 2005. Support of gateways exists since April 2007. GVFS integration started in February 2009. Ad-hoc multi-hop methods (with a changed syntax) have been reenabled in November 2011. In November 2012, Juergen Hoetzel’s tramp-adb.el has been added.

In December 2001, TRAMP has been added to the XEmacs package repository. Being part of the Emacs repository happened in June 2002, the first release including TRAMP was Emacs 22.1.

TRAMP is also a Debian GNU/Linux package since February 2001.


Next: , Previous: History, Up: Top   [Contents][Index]

4 Installing TRAMP into XEmacs.

If you use the version that comes with your XEmacs, the following information is not necessary. Installing TRAMP into your XEmacs 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:


Next: , Up: Installation   [Contents][Index]

4.1 Parameters in order to control installation.

There are some Lisp packages which are not contained in older XEmacsen by default yet. In order to make a link for them into Tramp’s contrib directory, you must use the --with-contrib option:

./configure --with-contrib

By default, make install will install TRAMP’s files in /usr/local/share/emacs/site-lisp and /usr/local/share/info. You can specify an installation prefix other than /usr/local by giving configure the option --prefix=PATH.

If your installed copy of XEmacs is named something other than xemacs, you will need to tell ‘make’ where to find it so that it can correctly byte-compile the TRAMP sources.

For example, to force the use of Emacs you might do this:

./configure --with-emacs

You can even pass the XEmacs or Emacs command to be called:

./configure --with-emacs=emacs22

If you specify the absolute path of the command, it must not contain whitespaces. If you need it, the corresponding path shall be appended to the PATH environment variable.

The syntax of TRAMP file names is different for XEmacs and Emacs. The Info manual will be generated for the Emacs flavor choosen in the configure phase. If you want the Info manual for the other version, you need to set the variable EMACS_INFO to make:

./configure --with-xemacs
make EMACS_INFO=emacs

Also, the --prefix=PATH option to configure may not be general enough to set the paths you want. If not, you can declare the directories Lisp and Info files should be installed.

For example, to put the Lisp files in ~/elisp and the Info file in ~/info, you would type:

./configure --with-lispdir=$HOME/elisp --infodir=$HOME/info

On MS Windows, given Emacs is installed at C:/Program Files/Emacs, you should apply

./configure --with-lispdir='C:/Program Files/Emacs/site-lisp' \
            --infodir='C:/Program Files/Emacs/info'

make supports the DESTDIR variable for staged installation; See (standards)Command Variables:

make DESTDIR=/tmp install

Running configure might result in errors or warnings. The output explains in detail what’s going wrong.

In case of errors, it is mandatory to fix them before continuation. This can be missing or wrong versions of xemacs, XEmacs packages, make, or makeinfo.

Warnings let configure (and the whole installation process) continue, but parts of Tramp aren’t installed. This can happen with missing or wrong versions of texi2dvi or install-info. Here you can decide yourself whether you want to renounce on the related feature (tramp.dvi file for printed output, Tramp entry in Info’s dir file), or whether you want to adapt your PATH environment variable, and rerun configure. An alternative is calling the missed parts manually later on.


Previous: Installation parameters, Up: Installation   [Contents][Index]

4.2 How to plug-in TRAMP into your environment.

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 .emacs:

(add-to-list 'load-path "~/xemacs/tramp/lisp/")
(require 'tramp)

NOTE: For XEmacs, the package fsf-compat must be installed. For details on package installation, see (xemacs)Packages. (If the previous link doesn’t work, try the XEmacs documentation at the XEmacs site.)

If the environment variable INFOPATH is set, add the directory ~/xemacs/tramp/info/ to it. Else, add the directory to Info-directory-list, as follows:

(add-to-list 'Info-directory-list "~/xemacs/tramp/info/")

Next: , Previous: Installation, Up: Top   [Contents][Index]

5 Configuring TRAMP for use

TRAMP is (normally) fully functional when it is initially installed. It is initially configured to use the scp program to connect to the remote host. So in the easiest case, you just type C-x C-f and then enter the file name /[user@host]/path/to.file.

On some hosts, there are problems with opening a connection. These are related to the behavior of the remote shell. See See Remote shell setup, for details on this.

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 can use to connect to remote hosts and transfer files (see Connection types).

If you don’t know which method is right for you, see See Default Method.


Next: , Up: Configuration   [Contents][Index]

5.1 Types of connections made to remote hosts

There are two basic types of transfer methods, each with its own advantages and limitations. Both types of connection make use of a remote shell access program such as rsh, ssh or telnet to connect to the remote host.

This connection is used to perform many of the operations that TRAMP requires to make the remote file system transparently accessible from the local host. It is only when visiting files that the methods differ.

Loading or saving a remote file requires that the content of the file be transferred between the two hosts. The content of the file can be transferred using one of two methods: the inline method over the same connection used to log in to the remote host, or the external method through another connection using a remote copy program such as rcp, scp or rsync.

The performance of the external methods is generally better than that of the inline methods, at least for large files. This is caused by the need to encode and decode the data when transferring inline.

The one exception to this rule are the scp based transfer methods. While these methods do see better performance when actually transferring files, the overhead of the cryptographic negotiation at startup may drown out the improvement in file transfer times.

External methods should be configured such a way that they don’t require a password (with ssh-agent, or such alike). Modern scp implementations offer options to reuse existing ssh connections, which will be enabled by default if available. If it isn’t possible, you should consider Password handling, otherwise you will be prompted for a password every copy action.


Next: , Previous: Connection types, Up: Configuration   [Contents][Index]

5.2 Inline methods

The inline methods in 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 host via telnet. (There are also strange inline methods which allow you to transfer files between user identities rather than hosts, see below.)

These methods depend on the existence of a suitable encoding and decoding command on remote host. Locally, TRAMP may be able to use features of XEmacs to decode and encode the files or it may require access to external commands to perform that task.

TRAMP checks the availability and usability of commands like mimencode (part of the metamail package) or uuencode on the remote host. The first reliable command will be used. The search path can be customized, see Remote Programs.

If both commands aren’t available on the remote host, TRAMP transfers a small piece of Perl code to the remote host, and tries to apply it for encoding and decoding.

The variable tramp-inline-compress-start-size controls, whether a file shall be compressed before encoding. This could increase transfer speed for large text files.

rsh

Connect to the remote host with rsh. Due to the unsecure connection it is recommended for very local host topology only.

On operating systems which provide the command remsh instead of rsh, you can use the method remsh. This is true for HP-UX or Cray UNICOS, for example.

ssh

Connect to the remote host with ssh. This is identical to the previous option except that the ssh package is used, making the connection more secure.

All the methods based on ssh have an additional feature: you can specify a host name which looks like host#42 (the real host name, then a hash sign, then a port number). This means to connect to the given host but to also pass -p 42 as arguments to the ssh command.

telnet

Connect to the remote host with telnet. This is as unsecure as the rsh method.

su

This method does not connect to a remote host at all, rather it uses the su program to allow you to edit files as another user. That means, the specified host name in the file name must be either ‘localhost’ or the host name as returned by the function (system-name). For an exception of this rule see Multi-hops.

sudo

This is similar to the su method, but it uses sudo rather than su to become a different user.

Note that sudo must be configured to allow you to start a shell as the user. It would be nice if it was sufficient if ls and mimencode were allowed, but that is not easy to implement, so I haven’t got around to it, yet.

sshx

As you would expect, this is similar to ssh, only a little different. Whereas ssh opens a normal interactive shell on the remote host, this option uses ‘ssh -t -t host -l 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 with.

Note that this procedure does not eliminate questions asked by ssh itself. For example, ssh might ask “Are you sure you want to continue connecting?” if the host key of the remote host is not known. TRAMP does not know how to deal with such a question (yet), therefore you will need to make sure that you can log in without such questions.

This is also useful for Windows users where ssh, when invoked from an XEmacs 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.

This supports the ‘-p’ argument.

krlogin

This method is also similar to ssh. It only uses the krlogin -x command to log in to the remote host.

ksu

This is another method from the Kerberos suite. It behaves like su.

plink

This method is mostly interesting for Windows users using the PuTTY implementation of SSH. It uses ‘plink -ssh’ to log in to the remote host.

This supports the ‘-P’ argument.

plinkx

Another method using PuTTY on Windows. Instead of host names, it expects PuTTY session names, calling ‘plink -load session -t"’. User names are relevant only in case the corresponding session hasn’t defined a user name. Different port numbers must be defined in the session.


Next: , Previous: Inline methods, Up: Configuration   [Contents][Index]

5.3 External methods

The external methods operate through multiple channels, using the remote shell connection for many actions while delegating file transfers to an external transfer utility.

This saves the overhead of encoding and decoding that multiplexing the transfer through the one connection has with the inline methods.

Since external methods need their own overhead opening a new channel, all files which are smaller than tramp-copy-size-limit are still transferred with the corresponding inline method. It should provide a fair trade-off between both approaches.

rcprsh and rcp

This method uses the rsh and rcp commands to connect to the remote host and transfer files. This is probably the fastest connection method available.

The alternative method remcp uses the remsh and rcp commands. It should be applied on hosts where remsh is used instead of rsh.

scpssh and scp

Using ssh to connect to the remote host and scp to transfer files between the hosts is the best method for securely connecting to a remote host and accessing files.

The performance of this option is also quite good. It may be slower than the inline methods when you often open and close small files however. The cost of the cryptographic handshake at the start of an scp session can begin to absorb the advantage that the lack of encoding and decoding presents.

All the ssh based methods support the ‘-p’ feature where you can specify a port number to connect to in the host name. For example, the host name host#42 tells TRAMP to specify ‘-p 42’ in the argument list for ssh, and to specify ‘-P 42’ in the argument list for scp.

sftpssh and sftp

That is mostly the same method as scp, but using sftp as transfer command. So the same remarks are valid.

This command does not work like EFS, where ftp is called interactively, and all commands are send from within this session. Instead of, ssh is used for login.

This method supports the ‘-p’ argument.

rsyncssh and rsync

Using the ssh command to connect securely to the remote host and the rsync command to transfer files is almost identical to the scp method.

While rsync performs much better than scp when transferring files that exist on both hosts, this advantage is lost if the file exists only on one side of the connection. A file can exists on both the remote and local host, when you copy a file from/to a remote host. When you just open a file from the remote host (or write a file there), a temporary file on the local side is kept as long as the corresponding buffer, visiting this file, is alive.

This method supports the ‘-p’ argument.

scpxssh and scp

As you would expect, this is similar to scp, only a little different. Whereas scp opens a normal interactive shell on the remote host, this option uses ‘ssh -t -t host -l 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 with.

This is also useful for Windows users where ssh, when invoked from an XEmacs 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.

This method supports the ‘-p’ argument.

pscpplink and pscp

This method is similar to scp, but it uses the plink command to connect to the remote host, and it uses pscp for transferring the files. These programs are part of PuTTY, an SSH implementation for Windows.

This method supports the ‘-P’ argument.

psftpplink and psftp

As you would expect, this method is similar to sftp, but it uses the plink command to connect to the remote host, and it uses psftp for transferring the files. These programs are part of PuTTY, an SSH implementation for Windows.

This method supports the ‘-P’ argument.

fcpfsh and fcp

This method is similar to scp, but it uses the fsh command to connect to the remote host, and it uses fcp for transferring the files. fsh/fcp are a front-end for ssh which allow for reusing the same ssh session for submitting several commands. This avoids the startup overhead of scp (which has to establish a secure connection whenever it is called). Note, however, that you can also use one of the inline methods to achieve a similar effect.

This method uses the command ‘fsh host -l user /bin/sh -i’ to establish the connection, it does not work to just say fsh host -l user.

There is no inline method using fsh as the multiplexing provided by the program is not very useful in our context. TRAMP opens just one connection to the remote host and then keeps it open, anyway.

ftp

This is not a native TRAMP method. Instead, it forwards all requests to EFS. This works only for unified file names, see Issues.

smbsmbclient

This is another not native TRAMP method. It uses the 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 far, it is tested against MS Windows NT, MS Windows 2000, MS Windows XP, MS Windows Vista, and MS Windows 7.

The first directory in the localname must be a share name on the remote host. Remember that the $ character, in which default shares usually end, must be written $$ due to environment variable substitution in file names. If no share name is given (i.e., remote directory /), all available shares are listed.

Since authorization is done on share level, you will always be prompted for a password if you access another share on the same host. This can be suppressed by Password handling.

For authorization, MS Windows uses both a user name and a domain name. Because of this, the TRAMP syntax has been extended: you can specify a user name which looks like user%domain (the real user name, then a percent sign, then the domain name). So, to connect to the host melancholia as user daniel of the domain BIZARRE, and edit .emacs in the home directory (share daniel$) I would specify the file name /[smb/daniel%BIZARRE@melancholia]/daniel$$/.emacs.

Depending on the Windows domain configuration, a Windows user might be considered as domain user per default. In order to connect as local user, the WINS name of that host must be given as domain name. Usually, it is the host name in capital letters. In the example above, the local user daniel would be specified as /[smb/daniel%MELANCHOLIA@melancholia]/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 methods, where in such a case the local user name is taken.

The smb method supports the ‘-p’ argument.

Please note: If XEmacs runs locally under MS Windows, this method isn’t available. Instead, you can use UNC file names like //melancholia/daniel$$/.emacs. The only disadvantage is that there’s no possibility to specify another user name.

adb

This special method uses the Android Debug Bridge for accessing Android devices. The Android Debug Bridge must be installed locally. Some GNU/Linux distributions offer it for installation, otherwise it can be installed as part of the Android SDK. If the adb program is not found via the PATH environment variable, the variable tramp-adb-program must point to its absolute path.

Tramp does not connect Android devices to adb. This must be performed outside XEmacs. If there is exactly one Android device connected to adb, a host name is not needed in the remote file name. The default TRAMP name to be used is /[adb/] therefore. Otherwise, one could find potential host names with the command adb devices.

Usually, the adb method does not need any user name. It runs under the permissions of the adbd process on the Android device. If a user name is specified, TRAMP applies an su on the device. This does not work with all Android devices, especially with unrooted ones. In that case, an error message is displayed.


Next: , Previous: External methods, Up: Configuration   [Contents][Index]

5.4 GVFS based external methods

The connection methods described in this section are based on GVFS http://en.wikipedia.org/wiki/GVFS. Via GVFS, the remote filesystem is mounted locally through FUSE. TRAMP uses this local mounted directory internally.

The communication with GVFS is implemented via D-Bus messages. Therefore, your XEmacs must have D-Bus integration, see (dbus)D-Bus.

dav

This method provides access to WebDAV files and directories. There exists also the external method davs, which uses SSL encryption for the access.

Both methods support the port number specification as discussed above.

obex

OBEX is an FTP-like access protocol for simple devices, like cell phones. For the time being, TRAMP only supports OBEX over Bluetooth.

synce

The synce method allows communication with Windows Mobile devices. Beside GVFS for mounting remote files and directories via FUSE, it also needs the SYNCE-GVFS plugin.

User Option: tramp-gvfs-methods

This customer option, a list, defines the external methods which shall be used with GVFS. Per default, these are dav, davs, obex and synce. Other possible values are ftp, sftp and smb.


Next: , Previous: GVFS based methods, Up: Configuration   [Contents][Index]

5.5 Gateway methods

Gateway methods are not methods to access a remote host directly. These methods are intended to pass firewalls or proxy servers. Therefore, they can be used for proxy host declarations (see Multi-hops) only.

A gateway method must always come along with a method which supports port setting. This is because TRAMP targets the accompanied method to localhost#random_port, from where the firewall or proxy server is accessed.

Gateway methods support user name and password declarations. These are used to authenticate towards the corresponding firewall or proxy server. They can be passed only if your friendly administrator has granted your access.

tunnel

This method implements an HTTP tunnel via the CONNECT command (see RFC 2616, 2817). Any HTTP 1.1 compliant (proxy) server shall support this command.

As authentication method, only Basic Authentication (see RFC 2617) is implemented so far. If no port number is given in the declaration, port 8080 is used for the proxy server.

socks

The socks method provides access to SOCKSv5 servers (see RFC 1928). Username/Password Authentication according to RFC 1929 is supported.

The default port number of the socks server is 1080, if not specified otherwise.


Next: , Previous: Gateway methods, Up: Configuration   [Contents][Index]

5.6 Selecting a default method

When you select an appropriate transfer method for your typical usage you should set the variable 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:

(setq tramp-default-method "ssh")

You can also specify different methods for certain user/host combinations, via the variable tramp-default-method-alist. For example, the following two lines specify to use the ssh method for all user names matching ‘john’ and the rsync method for all host names matching ‘lily’. The third line specifies to use the su method for the user ‘root’ on the host ‘localhost’.

(add-to-list 'tramp-default-method-alist '("" "john" "ssh"))
(add-to-list 'tramp-default-method-alist '("lily" "" "rsync"))
(add-to-list 'tramp-default-method-alist
             '("\\`localhost\\'" "\\`root\\'" "su"))

See the documentation for the variable tramp-default-method-alist for more details.

External methods are normally preferable to inline methods, giving better performance.

See Inline methods. See External methods.

Another consideration with the selection of transfer methods is the environment you will use them in and, especially when used over the Internet, the security implications of your preferred method.

The rsh and telnet methods send your password as plain text as you log in to the remote host, as well as transferring the files in such a way that the content can easily be read from other hosts.

If you need to connect to remote systems that are accessible from the Internet, you should give serious thought to using 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.

5.6.1 Which method is the right one for me?

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 …

My suggestion is to use an inline method. For large files, external methods might be more efficient, but I guess that most people will want to edit mostly small files. And if you access large text files, compression (driven by tramp-inline-compress-start-size) shall still result in good performance.

I guess that these days, most people can access a remote host by using ssh. So I suggest that you use the ssh method. So, type C-x C-f /[ssh/root@otherhost]/etc/motd RET to edit the /etc/motd file on the other host.

If you can’t use 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 plink method which uses the PuTTY implementation of ssh. Or you use Kerberos and thus like krlogin.

For the special case of editing files on the local host as another user, see the su or sudo methods. They offer shortened syntax for the ‘root’ account, like /[su/]/etc/motd.

People who edit large files may want to consider scp instead of ssh, or pscp instead of plink. These external methods are faster than inline methods for large files. Note, however, that external methods suffer from some limitations. Please try first whether you really get a noticeable speed advantage from using an external method! Maybe even for large files, inline methods are fast enough.


Next: , Previous: Default Method, Up: Configuration   [Contents][Index]

5.7 Selecting a default user

The user part of a TRAMP file name can be omitted. Usually, it is replaced by the user name you are logged in. Often, this is not what you want. A typical use of TRAMP might be to edit some files with root permissions on the local host. This case, you should set the variable tramp-default-user to reflect that choice. For example:

(setq tramp-default-user "root")

tramp-default-user is regarded as obsolete, and will be removed soon.

You can also specify different users for certain method/host combinations, via the variable tramp-default-user-alist. For example, if you always have to use the user ‘john’ in the domain ‘somewhere.else’, you can specify the following:

(add-to-list 'tramp-default-user-alist
             '("ssh" ".*\\.somewhere\\.else\\'" "john"))

See the documentation for the variable tramp-default-user-alist for more details.

One trap to fall in must be known. If TRAMP finds a default user, this user will be passed always to the connection command as parameter (for example ssh here.somewhere.else -l john. If you have specified another user for your command in its configuration files, TRAMP cannot know it, and the remote access will fail. If you have specified in the given example in ~/.ssh/config the lines

Host here.somewhere.else
     User lily

than you must discard selecting a default user by TRAMP. This will be done by setting it to nil (or ‘lily’, likewise):

(add-to-list 'tramp-default-user-alist
             '("ssh" "\\`here\\.somewhere\\.else\\'" nil))

The last entry in tramp-default-user-alist could be your default user you’ll apply predominantly. You shall append it to that list at the end:

(add-to-list 'tramp-default-user-alist '(nil nil "jonas") t)

Next: , Previous: Default User, Up: Configuration   [Contents][Index]

5.8 Selecting a default host

Finally, it is even possible to omit the host name part of a TRAMP file name. This case, the value of the variable tramp-default-host is used. Per default, it is initialized with the host name your local XEmacs is running.

If you, for example, use TRAMP mainly to contact the host ‘target’ as user ‘john’, you can specify:

(setq tramp-default-user "john"
      tramp-default-host "target")

Then the simple file name ‘/[ssh/]’ will connect you to John’s home directory on target.

Like with methods and users, you can also specify different default hosts for certain method/user combinations via the variable tramp-default-host-alist. Usually, this isn’t necessary, because tramp-default-host should be sufficient. For some methods, like adb, that default value must be overwritten, which is already the initial value of tramp-default-host-alist.

See the documentation for the variable tramp-default-host-alist for more details.


Next: , Previous: Default Host, Up: Configuration   [Contents][Index]

5.9 Connecting to a remote host using multiple hops

Sometimes, the methods described before are not sufficient. Sometimes, it is not possible to connect to a remote host using a simple command. For example, if you are in a secured network, you might have to log in to a bastion host first before you can connect to the outside world. Of course, the target host may also require a bastion host.

User Option: tramp-default-proxies-alist

In order to specify multiple hops, it is possible to define a proxy host to pass through, via the variable tramp-default-proxies-alist. This variable keeps a list of triples (host user proxy).

The first matching item specifies the proxy host to be passed for a file name located on a remote target matching user@host. host and user are regular expressions or nil, which is interpreted as a regular expression which always matches.

proxy must be a Tramp file name which localname part is ignored. Method and user name on proxy are optional, which is interpreted with the default values. The method must be an inline or gateway method (see Inline methods, see Gateway methods). If proxy is nil, no additional hop is required reaching user@host.

If you, for example, must pass the host ‘bastion.your.domain’ as user ‘bird’ for any remote host which is not located in your local domain, you can set

(add-to-list 'tramp-default-proxies-alist
             '("\\." nil "/[ssh/bird@bastion.your.domain]"))
(add-to-list 'tramp-default-proxies-alist
             '("\\.your\\.domain\\'" nil nil))

Please note the order of the code. add-to-list adds elements at the beginning of a list. Therefore, most relevant rules must be added last.

Proxy hosts can be cascaded. If there is another host called ‘jump.your.domain’, which is the only one in your local domain who is allowed connecting ‘bastion.your.domain’, you can add another rule:

(add-to-list 'tramp-default-proxies-alist
             '("\\`bastion\\.your\\.domain\\'"
               "\\`bird\\'"
               "/[ssh/jump.your.domain]"))

proxy can contain the patterns %h or %u. These patterns are replaced by the strings matching host or user, respectively.

If you, for example, wants to work as ‘root’ on hosts in the domain ‘your.domain’, but login as ‘root’ is disabled for non-local access, you might add the following rule:

(add-to-list 'tramp-default-proxies-alist
             '("\\.your\\.domain\\'" "\\`root\\'" "/[ssh/%h]"))

Opening /[sudo/randomhost.your.domain] would connect first ‘randomhost.your.domain’ via ssh under your account name, and perform sudo -u root on that host afterwards. It is important to know that the given method is applied on the host which has been reached so far. sudo -u root, applied on your local host, wouldn’t be useful here.

host, user and proxy can also be Lisp forms. These forms are evaluated, and must return a string, or nil. The previous example could be generalized then: For all hosts except my local one connect via ssh first, and apply sudo -u root afterwards:

(add-to-list 'tramp-default-proxies-alist
             '(nil "\\`root\\'" "/[ssh/%h]"))
(add-to-list 'tramp-default-proxies-alist
             '((regexp-quote (system-name)) nil nil))

This is the recommended configuration to work as ‘root’ on remote Ubuntu hosts.

Finally, tramp-default-proxies-alist can be used to pass firewalls or proxy servers. Imagine your local network has a host ‘proxy.your.domain’ which is used on port 3128 as HTTP proxy to the outer world. Your friendly administrator has granted you access under your user name to ‘host.other.domain’ on that proxy server.2 You would need to add the following rule:

(add-to-list 'tramp-default-proxies-alist
             '("\\`host\\.other\\.domain\\'" nil
               "/[tunnel/proxy.your.domain#3128]"))

Gateway methods can be declared as first hop only in a multiple hop chain.

Hops to be passed tend to be restricted firewalls and alike. Sometimes they offer limited features only, like running rbash (restricted bash). This must be told to TRAMP.

User Option: tramp-restricted-shell-hosts-alist

This variable keeps a list of regular expressions, which denote hosts running a registered shell like "rbash". Those hosts can be used as proxies only.

If the bastion host from the example above runs a restricted shell, you shall apply

(add-to-list 'tramp-restricted-shell-hosts-alist
             "\\`bastion\\.your\\.domain\\'")

Next: , Previous: Multi-hops, Up: Configuration   [Contents][Index]

5.10 Using Non-Standard Methods

There is a variable tramp-methods which you can change if the predefined methods don’t seem right.

For the time being, I’ll refer you to the Lisp documentation of that variable, accessible with C-h v tramp-methods RET.


Next: , Previous: Customizing Methods, Up: Configuration   [Contents][Index]

5.11 Selecting config files for user/host name completion

The variable tramp-completion-function-alist is intended to customize which files are taken into account for user and host name completion (see File name completion). For every method, it keeps a set of configuration files, accompanied by a Lisp function able to parse that file. Entries in tramp-completion-function-alist have the form (method pair1 pair2 ...).

Each pair is composed of (function file). function is responsible to extract user names and host names from file for completion. There are two functions which access this variable:

Function: tramp-get-completion-function method

This function returns the list of completion functions for method.

Example:

(tramp-get-completion-function "rsh")

     ⇒ ((tramp-parse-rhosts "/etc/hosts.equiv")
         (tramp-parse-rhosts "~/.rhosts"))
Function: tramp-set-completion-function method function-list

This function sets function-list as list of completion functions for method.

Example:

(tramp-set-completion-function "ssh"
 '((tramp-parse-sconfig "/etc/ssh_config")
   (tramp-parse-sconfig "~/.ssh/config")))

     ⇒ ((tramp-parse-sconfig "/etc/ssh_config")
         (tramp-parse-sconfig "~/.ssh/config"))

The following predefined functions parsing configuration files exist:

tramp-parse-rhosts

This function parses files which are syntactical equivalent to ~/.rhosts. It returns both host names and user names, if specified.

tramp-parse-shosts

This function parses files which are syntactical equivalent to ~/.ssh/known_hosts. Since there are no user names specified in such files, it can return host names only.

tramp-parse-sconfig

This function returns the host nicknames defined by Host entries in ~/.ssh/config style files.

tramp-parse-shostkeys

SSH2 parsing of directories /etc/ssh2/hostkeys/* and ~/ssh2/hostkeys/*. Hosts are coded in file names hostkey_portnumber_host-name.pub. User names are always nil.

tramp-parse-sknownhosts

Another SSH2 style parsing of directories like /etc/ssh2/knownhosts/* and ~/ssh2/knownhosts/*. This case, hosts names are coded in file names host-name.algorithm.pub. User names are always nil.

tramp-parse-hosts

A function dedicated to /etc/hosts style files. It returns host names only.

tramp-parse-passwd

A function which parses /etc/passwd like files. Obviously, it can return user names only.

tramp-parse-netrc

Finally, a function which parses ~/.netrc like files. This includes also ~/.authinfo-style files.

If you want to keep your own data in a file, with your own structure, you might provide such a function as well. This function must meet the following conventions:

Function: my-tramp-parse file

file must be either a file name on your host, or nil. The function must return a list of (user host), which are taken as candidates for user and host name completion.

Example:

(my-tramp-parse "~/.my-tramp-hosts")

     ⇒ ((nil "toto") ("daniel" "melancholia"))

Next: , Previous: Customizing Completion, Up: Configuration   [Contents][Index]

5.12 Reusing passwords for several connections

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.

The best recommendation is to use the method’s own mechanism for password handling. Consider ssh-agent for ssh-like methods, or pageant for plink-like methods.

However, if you cannot apply such native password handling, TRAMP offers alternatives.

5.12.1 Using an authentication file

The package auth-source.el, originally developed in No Gnus, offers the possibility to read passwords from a file, like FTP does it from ~/.netrc. The default authentication file is ~/.authinfo.gpg, this can be changed via the variable auth-sources.

A typical entry in the authentication file would be

machine melancholia port scp login daniel password geheim

The port can be any TRAMP method (see Inline methods, see External methods), to match only this method. When you omit the port, you match all TRAMP methods.

In case of problems, setting auth-source-debug to t gives useful debug messages.

5.12.2 Caching passwords

If there is no authentication file, 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.

Passwords are not saved permanently, that means the password caching is limited to the lifetime of your XEmacs session. You can influence the lifetime of password caching by customizing the variable password-cache-expiry. The value is the number of seconds how long passwords are cached. Setting it to nil disables the expiration.

If you don’t like this feature for security reasons, password caching can be disabled totally by customizing the variable password-cache (setting it to nil).

Implementation Note: password caching is based on the package password-cache.el. For the time being, it is activated only when this package is seen in the load-path while loading TRAMP. If you don’t use No Gnus, you can take password.el from the TRAMP contrib directory, see Installation parameters.


Next: , Previous: Password handling, Up: Configuration   [Contents][Index]

5.13 Reusing connection related information

In order to reduce initial connection time, TRAMP stores connection related information persistently. The variable tramp-persistency-file-name keeps the file name where these information are written. Its default value is ~/.xemacs/tramp. It is recommended to choose a local file name.

TRAMP reads this file during startup, and writes it when exiting XEmacs. You can simply remove this file if TRAMP shall be urged to recompute these information next XEmacs startup time.

Using such persistent information can be disabled by setting tramp-persistency-file-name to nil.

Once consequence of reusing connection related information is that tramp needs to distinguish hosts. If you, for example, run a local sshd on port 3001, which tunnels ssh to another host, you could access both /[ssh/localhost] and /[ssh/localhost#3001]. tramp would use the same host related information (like paths, Perl variants, etc) for both connections, although the information is valid only for one of them.

In order to avoid trouble, you must use another host name for one of the connections, like introducing a Host section in ~/.ssh/config (see Frequently Asked Questions) or applying multiple hops (see Multi-hops).

When TRAMP detects a changed operating system version on a remote host (via the command uname -sr), it flushes all connection related information for this host, and opens the connection again.


Next: , Previous: Connection caching, Up: Configuration   [Contents][Index]

5.14 Setting own connection related information

Sometimes, tramp is not able to detect correct connection related information. In such cases, you could tell tramp which value it has to take. Since this could result in errors, it has to be used with care.

Such settings can be performed via the list tramp-connection-properties. An entry in this list has the form (regexp property value). regexp matches remote file names for which a property shall be predefined. It can be nil. property is a string, and value the corresponding value. property could be any property found in the file tramp-persistency-file-name.

A special property is "busybox". This must be set, if the remote host runs a very restricted busybox as shell, which closes the connection at will. Since there is no reliable test for this, tramp must be indicated this way. Example:

(add-to-list 'tramp-connection-properties
             (list (regexp-quote "/[ssh/user@randomhost.your.domain]")
                   "busybox" t))

Next: , Previous: Predefined connection information, Up: Configuration   [Contents][Index]

5.15 How TRAMP finds and uses programs on the remote host

TRAMP depends on a number of programs on the remote host in order to function, including ls, test, find and cat.

In addition to these required tools, there are various tools that may be required based on the connection method. See Inline methods and External methods for details on these.

Certain other tools, such as perl (or perl5) and grep will be used if they can be found. When they are available, they are used to improve the performance and accuracy of remote file access.

User Option: tramp-remote-path

When TRAMP connects to the remote host, it searches for the programs that it can use. The variable tramp-remote-path controls the directories searched on the remote host.

By default, this is set to a reasonable set of defaults for most hosts. The symbol tramp-default-remote-path is a place holder, it is replaced by the list of directories received via the command getconf PATH on your remote host. For example, on Debian GNU/Linux this is /bin:/usr/bin, whereas on Solaris this is /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin. It is recommended to apply this symbol on top of tramp-remote-path.

It is possible, however, that your local (or remote ;) system 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 add code to your .emacs to add the directory to the remote path. This will then be searched by TRAMP when you connect and the software found.

To add a directory to the remote search path, you could use code such as:

;; We load TRAMP to define the variable.
(require 'tramp)
;; We have perl in "/usr/local/perl/bin"
(add-to-list 'tramp-remote-path "/usr/local/perl/bin")

Another possibility is to reuse the path settings of your remote account when you log in. Usually, these settings are overwritten, because they might not be useful for TRAMP. The place holder tramp-own-remote-path preserves these settings. You can activate it via

(add-to-list 'tramp-remote-path 'tramp-own-remote-path)

TRAMP caches several information, like the Perl binary location. The changed remote search path wouldn’t affect these settings. In order to force TRAMP to recompute these values, you must exit XEmacs, remove your persistency file (see Connection caching), and restart XEmacs.


Next: , Previous: Remote Programs, Up: Configuration   [Contents][Index]

5.16 Remote shell setup hints

As explained in the Overview section, 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 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. This is a losing battle, since it is not possible to deal with all situations. The other strategy is to require you to set up the remote host such that it behaves like 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.

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 test -e does the trick, on some hosts the shell builtin doesn’t work but the program /usr/bin/test -e or /bin/test -e works. And on still other hosts, ls -d is the right way to do this.)

Below you find a discussion of a few things that TRAMP does not deal with, and that you therefore have to set up correctly.

shell-prompt-pattern

After logging in to the remote host, 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 shell-prompt-pattern has to be set correctly to recognize the shell prompt on the remote host.

Note that TRAMP requires the match for shell-prompt-pattern to be at the end of the buffer. Many people have something like the following as the value for the variable: "^[^>$][>$] *". Now suppose your shell prompt is a <b> c $ . In this case, TRAMP recognizes the > character as the end of the prompt, but it is not at the end of the buffer.

tramp-shell-prompt-pattern

This regular expression is used by TRAMP in the same way as 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 different user. The default value of tramp-shell-prompt-pattern is the same as the default value of shell-prompt-pattern, which is reported to work well in many circumstances.

tramp-password-prompt-regexp

During login, TRAMP might be forced to enter a password or a passphrase. The difference between both is that a password is requested from the shell on the remote host, while a passphrase is needed for accessing local authentication information, like your ssh key.

tramp-password-prompt-regexp handles the detection of such requests for English environments. When you use another localization of your (local or remote) host, you might need to adapt this. Example:

(setq
  tramp-password-prompt-regexp
    (concat
      "^.*"
      (regexp-opt
        '("passphrase" "Passphrase"
          ;; English
          "password" "Password"
          ;; Deutsch
          "passwort" "Passwort"
          ;; Français
          "mot de passe" "Mot de passe") t)
      ".*:\0? *"))

In parallel, it might also be necessary to adapt tramp-wrong-passwd-regexp.

tset and other questions

Some people invoke the 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 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 do this by checking the TERM environment variable, it will be set to dumb when connecting.

The variable tramp-terminal-type can be used to change this value to dumb.

The other approach is to teach TRAMP about these questions. See the variable tramp-actions-before-shell. Example:

(defconst my-tramp-prompt-regexp
  (concat (regexp-opt '("Enter the birth date of your mother:") t)
          "\\s-*")
  "Regular expression matching my login prompt question.")

(defun my-tramp-action (proc vec)
  "Enter \"19000101\" in order to give a correct answer."
  (save-window-excursion
    (with-current-buffer (tramp-get-connection-buffer vec)
      (tramp-message vec 6 "\n%s" (buffer-string))
      (tramp-send-string vec "19000101"))))

(add-to-list 'tramp-actions-before-shell
             '(my-tramp-prompt-regexp my-tramp-action))
Environment variables named like users in .profile

If you have a user named frumple and set the variable FRUMPLE in your shell environment, then this might cause trouble. Maybe rename the variable to FRUMPLE_DIR or the like.

This weird effect was actually reported by a TRAMP user!

Non-Bourne commands in .profile

After logging in to the remote host, TRAMP issues the command exec /bin/sh. (Actually, the command is slightly different.) When /bin/sh is executed, it reads some init files, such as ~/.shrc or ~/.profile.

Now, some people have a login shell which is not /bin/sh but a Bourne-ish shell such as bash or ksh. Some of these people might put their shell setup into the files ~/.shrc or ~/.profile. This way, it is possible for non-Bourne constructs to end up in those files. Then, exec /bin/sh might cause the Bourne shell to barf on those constructs.

As an example, imagine somebody putting export FOO=bar into the 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 (~) character, say when adding ~/bin to 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 ~/.shrc and ~/.profile on all remote hosts is Bourne-compatible. In the above example, instead of export FOO=bar, you might use 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 ~/.bash_profile instead of ~/.profile, if the former exists. So bash aficionados just rename their ~/.profile to ~/.bash_profile on all remote hosts, and Bob’s your uncle.

The 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 exec /bin/sh, 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 exec /bin/sh step. But how to find out if the shell is Bourne-ish?

Interactive shell prompt

TRAMP redefines the shell prompt in order to parse the shell’s output robustly. When calling an interactive shell by M-x shell, this doesn’t look nice.

You can redefine the shell prompt by checking the environment variable INSIDE_EMACS, which is set by TRAMP, in your startup script ~/.emacs_SHELLNAME. SHELLNAME might be the string bash or similar, in case of doubt you could set it the environment variable ESHELL in your .emacs:

(setenv "ESHELL" "bash")

Your file ~/.emacs_SHELLNAME could contain code like

# Reset the prompt for remote Tramp shells.
if [ "${INSIDE_EMACS/*tramp*/tramp}" == "tramp" ] ; then
   PS1="[\u@\h \w]$ "
fi

Next: , Previous: Remote shell setup, Up: Configuration   [Contents][Index]

5.17 Android shell setup hints

Android devices use a restricted shell. They can be accessed via the adb method. However, this restricts the access to a USB connection, and it requires the installation of the Android SDK on the local host.

When an sshd process runs on the Android device, like provided by the SSHDroid app, any ssh-based method can be used. This requires some special settings.

The default shell /bin/sh does not exist. Instead, you shall use just sh, which invokes the shell installed on the device. You can instruct TRAMP by this form:

(add-to-list 'tramp-connection-properties
	     (list (regexp-quote "192.168.0.26") "remote-shell" "sh"))

with ‘192.168.0.26’ being the IP address of your Android device (see Predefined connection information).

The user settings for the PATH environment variable must be preserved. It has also been reported, that the commands in /system/xbin are better suited than the ones in /system/bin. Add these setting:

(add-to-list 'tramp-remote-path 'tramp-own-remote-path)
(add-to-list 'tramp-remote-path "/system/xbin")

If the Android device is not ‘rooted’, you must give the shell a writable directory for temporary files:

(add-to-list 'tramp-remote-process-environment "TMPDIR=$HOME")

Now you shall be able to open a remote connection with C-x C-f /[ssh/192.168.0.26#2222], given that sshd listens on port ‘2222’.

It is also recommended to add a corresponding entry to your ~/.ssh/config for that connection, like

Host android
     HostName 192.168.0.26
     User root
     Port 2222

In this case, you must change the setting for the remote shell to

(add-to-list 'tramp-connection-properties
	     (list (regexp-quote "android") "remote-shell" "sh"))

You would open the connection with C-x C-f /[ssh/android] then.


Next: , Previous: Android shell setup, Up: Configuration   [Contents][Index]

5.18 Auto-save and Backup configuration

Normally, XEmacs writes backup files to the same directory as the original files, but this behavior can be changed via the variable bkup-backup-directory-info. In connection with TRAMP, this can have unexpected side effects. Suppose that you specify that all backups should go to the directory ~/.emacs.d/backups/, and then you edit the 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.

When bkup-backup-directory-info is nil (the default), such problems do not occur.

Therefore, it is useful to set special values for TRAMP files. For example, the following statement effectively ‘turns off’ the effect of bkup-backup-directory-info for TRAMP files:

(require 'backup-dir)
(add-to-list 'bkup-backup-directory-info
             (list tramp-file-name-regexp ""))

Another possibility is to use the TRAMP variable tramp-bkup-backup-directory-info. This variable has the same meaning like bkup-backup-directory-info. If a TRAMP file is backed up, and DIRECTORY is an absolute local file name, DIRECTORY is prepended with the TRAMP file name prefix of the file to be backed up.

Example:

(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)

The backup file name of /[su/root@localhost]/etc/secretfile would be /[su/root@localhost]~/.emacs.d/backups/![su!root@localhost]!etc!secretfile~

The same problem can happen with auto-saving files. For this purpose you can set the variable auto-save-directory to a proper value.


Previous: Auto-save and Backup, Up: Configuration   [Contents][Index]

5.19 Issues with Cygwin ssh

This section needs a lot of work! Please help.

The recent Cygwin installation of ssh works only with a Cygwinized XEmacs. You can check it by typing M-x eshell, and starting ssh test.host. The problem is evident if you see a message like this:

Pseudo-terminal will not be allocated because stdin is not a terminal.

Older ssh versions of Cygwin are told to cooperate with TRAMP selecting sshx as the connection method. You can find information about setting up Cygwin in their FAQ at http://cygwin.com/faq/.

If you wish to use the scpx connection method, then you might have the problem that XEmacs calls scp with a Windows file name such as c:/foo. The Cygwin version of scp does not know about Windows file names and interprets this as a remote file name on the host c.

One possible workaround is to write a wrapper script for scp which converts the Windows file name to a Cygwinized file name.

If you want to use either ssh based method on Windows, then you might encounter problems with ssh-agent. Using this program, you can avoid typing the pass-phrase every time you log in. However, if you start XEmacs from a desktop shortcut, then the environment variable SSH_AUTH_SOCK is not set and so XEmacs and thus TRAMP and thus ssh and scp started from TRAMP cannot communicate with ssh-agent. It works better to start XEmacs from the shell.

If anyone knows how to start 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…


Next: , Previous: Configuration, Up: Top   [Contents][Index]

6 Using TRAMP

Once you have installed TRAMP it will operate fairly transparently. You will be able to access files on any remote host that you can log in to as though they were local.

Files are specified to TRAMP using a formalized syntax specifying the details of the system to connect to. This is similar to the syntax used by the EFS package.

Something that might happen which surprises you is that XEmacs remembers all your keystrokes, so if you see a password prompt from XEmacs, say, and hit RET twice instead of once, then the second keystroke will be processed by XEmacs 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!


Next: , Up: Usage   [Contents][Index]

6.1 TRAMP file name conventions

To access the file localname on the remote host host you would specify the file name /[host]localname. This will connect to host and transfer the file using the default method. See Default Method.

Some examples of TRAMP file names are shown below.

/[melancholia].emacs

Edit the file .emacs in your home directory on the host melancholia.

/[melancholia.danann.net].emacs

This edits the same file, using the fully qualified domain name of the host.

/[melancholia]~/.emacs

This also edits the same file; the ~ is expanded to your home directory on the remote host, just like it is locally.

/[melancholia]~daniel/.emacs

This edits the file .emacs in the home directory of the user daniel on the host melancholia. The ~<user> construct is expanded to the home directory of that user on the remote host.

/[melancholia]/etc/squid.conf

This edits the file /etc/squid.conf on the host melancholia.

host can also be an IPv4 or IPv6 address, like in /[127.0.0.1].emacs or /[::1].emacs.

Unless you specify a different name to use, 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 file name.

To log in to the remote host as a specific user, you use the syntax /[user@host]path/to.file. That means that connecting to melancholia as daniel and editing .emacs in your home directory you would specify /[daniel@melancholia].emacs.

It is also possible to specify other file transfer methods (see Inline methods, see External methods) as part of the file name. This is done by replacing the initial /[ with /[<method>/. (Note the trailing slash!). The user, host and file specification remain the same.

So, to connect to the host melancholia as daniel, using the ssh method to transfer files, and edit .emacs in my home directory I would specify the file name /[ssh/daniel@melancholia].emacs.

Finally, for some methods it is possible to specify a different port number than the default one, given by the method. This is specified by adding #<port> to the host name, like in /[ssh/daniel@melancholia#42].emacs.


Next: , Previous: File name Syntax, Up: Usage   [Contents][Index]

6.2 File name completion

File name completion works with TRAMP for completion of method names, of user names and of host names as well as for completion of file names on remote hosts.

If you, for example, type C-x C-f /[t TAB, TRAMP might give you as result the choice for

[telnet/
[toto]

[telnet/’ is a possible completion for the respective method, and ‘[toto]’ might be a host TRAMP has detected in your ~/.ssh/known_hosts file (given you’re using default method ssh).

If you go on to type e TAB, the minibuffer is completed to ‘/[telnet/’. Next TAB brings you all host names TRAMP detects in your /etc/hosts file, let’s say

/[telnet/127.0.0.1]
/[telnet/192.168.0.1]
/[telnet/::1]
/[telnet/localhost]
/[telnet/melancholia.danann.net]
/[telnet/melancholia]

Now you can choose the desired host, and you can continue to complete file names on that host.

If the configuration files (see Customizing Completion), which TRAMP uses for analysis of completion, offer user names, those user names will be taken into account as well.

Remote hosts which have been visited in the past and kept persistently (see Connection caching) will be offered too.

Once the remote host identification is completed, it comes to file name completion on the remote host. This works pretty much like for files on the local host, with the exception that minibuffer killing via a double-slash works only on the file name part, except that file name part starts with //.

Example:

C-x C-f /[telnet/melancholia]/usr/local/bin//
     -| /[telnet/melancholia]/

C-x C-f /[telnet/melancholia]//
     -| /

A remote directory might have changed its contents out of XEmacs control, for example by creation or deletion of files by other processes. Therefore, during file name completion, the remote directory contents are reread regularly in order to detect such changes, which would be invisible otherwise (see Connection caching).

User Option: tramp-completion-reread-directory-timeout

This variable defines the number of seconds since last remote command before rereading a directory contents. A value of 0 would require an immediate reread during file name completion, nil means to use always cached values for the directory contents.


Next: , Previous: File name completion, Up: Usage   [Contents][Index]

6.3 Declaring multiple hops in the file name

Multiple hops are configured with the variable tramp-default-proxies-alist (see Multi-hops). However, sometimes it is desirable to reach a remote host immediately, without configuration changes. This can be reached by an ad-hoc specification of the proxies.

A proxy looks like a remote file name specification without the local file name part. It is prepended to the target remote file name, separated by ‘|’. As an example, a remote file on ‘you@remotehost’, passing the proxy ‘bird@bastion’, could be opened by

C-x C-f /[ssh/bird@bastion|ssh/you@remotehost]/path

Multiple hops can be cascaded, separating all proxies by ‘|’. The proxies can also contain the patterns %h or %u.

The ad-hoc definition is added on the fly to tramp-default-proxies-alist. Therefore, during the lifetime of the XEmacs session it is not necessary to enter this ad-hoc specification, again. The remote file name ‘/[ssh/you@remotehost]/path’ would be sufficient from now on.

User Option: tramp-save-ad-hoc-proxies

This customer option controls whether ad-hoc definitions are kept persistently in tramp-default-proxies-alist. That means, those definitions are available also for future XEmacs sessions.


Next: , Previous: Ad-hoc multi-hops, Up: Usage   [Contents][Index]

6.4 Integration with other XEmacs packages

TRAMP supports running processes on a remote host. This allows to exploit XEmacs packages without modification for remote file names. It does not work for the ftp method. Association of a pty, as specified in start-file-process, is not supported.

process-file and start-file-process work on the remote host when the variable default-directory is remote:

(let ((default-directory "/ssh:remote.host:"))
  (start-file-process "grep" (get-buffer-create "*grep*")
                      "/bin/sh" "-c" "grep -e tramp *"))

If the remote host is mounted via GVFS (see GVFS based methods), the remote filesystem is mounted locally. Therefore, there are no remote processes; all processes run still locally on your host with an adapted default-directory. This section does not apply for such connection methods.

Remote processes are started when a corresponding command is executed from a buffer belonging to a remote file or directory. Up to now, the packages compile.el (commands like compile and grep) and gud.el (gdb or perldb) have been integrated. Integration of further packages is planned, any help for this is welcome!

When your program is not found in the default search path TRAMP sets on the remote host, you should either use an absolute path, or extend tramp-remote-path (see Remote Programs):

(add-to-list 'tramp-remote-path "~/bin")
(add-to-list 'tramp-remote-path "/appli/pub/bin")

The environment for your program can be adapted by customizing tramp-remote-process-environment. This variable is a list of strings. It is structured like process-environment. Each element is a string of the form "ENVVARNAME=VALUE". An entry "ENVVARNAME=" disables the corresponding environment variable, which might have been set in your init file like ~/.profile.

Adding an entry can be performed via add-to-list:

(add-to-list 'tramp-remote-process-environment "JAVA_HOME=/opt/java")

Changing or removing an existing entry is not encouraged. The default values are chosen for proper TRAMP work. Nevertheless, if for example a paranoid system administrator disallows changing the HISTORY environment variable, you can customize tramp-remote-process-environment, or you can apply the following code in your .emacs:

(let ((process-environment tramp-remote-process-environment))
  (setenv "HISTORY" nil)
  (setq tramp-remote-process-environment process-environment))

If you use other XEmacs packages which do not run out-of-the-box on a remote host, please let us know. We will try to integrate them as well. See Bug Reports.

6.4.1 Running remote programs that create local X11 windows

If you want to run a remote program, which shall connect the X11 server you are using with your local host, you can set the DISPLAY environment variable on the remote host:

(add-to-list 'tramp-remote-process-environment
             (format "DISPLAY=%s" (getenv "DISPLAY")))

(getenv "DISPLAY") shall return a string containing a host name, which can be interpreted on the remote host; otherwise you might use a fixed host name. Strings like :0 cannot be used properly on the remote host.

Another trick might be that you put ForwardX11 yes or ForwardX11Trusted yes to your ~/.ssh/config file for that host.

6.4.2 Running shell on a remote host

Calling M-x shell in a buffer related to a remote host runs the local shell as defined in shell-file-name. This might be also a valid file name for a shell to be applied on the remote host, but it will fail at least when your local and remote hosts belong to different system types, like ‘windows-nt’ and ‘gnu/linux’.

You must set the variable explicit-shell-file-name to the shell file name on the remote host, in order to start that shell on the remote host.

6.4.3 Running shell-command on a remote host

shell-command allows to execute commands in a shell, either synchronously, either asynchronously. This works also on remote hosts. Example:

C-x C-f /[sudo/] RET
M-! tail -f /var/log/syslog.log & RET

You will see the buffer *Async Shell Command*, containing the continuous output of the tail command.

6.4.4 Running eshell on a remote host

TRAMP is integrated into eshell.el. That is, you can open an interactive shell on your remote host, and run commands there. After you have started M-x eshell, you could perform commands like this:

~ $ cd /[sudo/]/etc RET
/[sudo/root@host]/etc $ hostname RET
host
/[sudo/root@host]/etc $ id RET
uid=0(root) gid=0(root) groups=0(root)
/[sudo/root@host]/etc $ find-file shadow RET
#<buffer shadow>
/[sudo/root@host]/etc $

6.4.5 Running a debugger on a remote host

gud.el offers an unified interface to several symbolic debuggers With TRAMP, it is possible to debug programs on remote hosts. You can call gdb with a remote file name:

M-x gdb RET
Run gdb (like this): gdb --annotate=3 /[ssh/host]~/myprog RET

The file name can also be relative to a remote default directory. Given you are in a buffer that belongs to the remote directory /[ssh/host]/home/user, you could call

M-x perldb RET
Run perldb (like this): perl -d myprog.pl RET

It is not possible to use just the absolute local part of a remote file name as program to debug, like perl -d /home/user/myprog.pl, though.

Arguments of the program to be debugged are taken literally. That means, file names as arguments must be given as ordinary relative or absolute file names, without any remote specification.

6.4.6 Running remote processes on Windows hosts

With the help of the winexe it is possible tu run processes on a remote Windows host. TRAMP has implemented this for process-file and start-file-process.

The variable tramp-smb-winexe-program must contain the file name of your local winexe command. On the remote host, Powershell V2.0 must be installed; it is used to run the remote process.

In order to open a remote shell on the Windows host via M-x shell, you must set the variables explicit-shell-file-name and explicit-*-args. If you want, for example, run cmd, you must set:

(setq explicit-shell-file-name "cmd"
      explicit-cmd-args '("/q"))

In case of running powershell as remote shell, the settings are

(setq explicit-shell-file-name "powershell"
      explicit-powershell-args '("-file" "-"))

Previous: Remote processes, Up: Usage   [Contents][Index]

6.5 Cleanup remote connections

Sometimes it is useful to cleanup remote connections. The following commands support this.

Command: tramp-cleanup-connection vec

This command flushes all connection related objects. vec is the internal representation of a remote connection. Called interactively, the command offers all active remote connections in the minibuffer as remote file name prefix like /[method/user@host]. The cleanup includes password cache (see Password handling), file cache, connection cache (see Connection caching), connection buffers.

Command: tramp-cleanup-this-connection

This command flushes all objects of the current buffer’s remote connection. The same objects are removed as in tramp-cleanup-connection.

Command: tramp-cleanup-all-connections

This command flushes objects for all active remote connections. The same objects are removed as in tramp-cleanup-connection.

Command: tramp-cleanup-all-buffers

Like in tramp-cleanup-all-connections, all remote connections are cleaned up. Additionally all buffers, which are related to a remote connection, are killed.


Next: , Previous: Usage, Up: Top   [Contents][Index]

7 Reporting Bugs and Problems

Bugs and problems with 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. 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 tramp-devel@gnu.org. Messages sent to this address go to all the subscribers. This is not the address to send subscription requests to.

Subscribing to the list is performed via the TRAMP Mail Subscription Page.

To report a bug in TRAMP, you should execute M-x tramp-bug. This will automatically generate a buffer with the details of your system and 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 host and any special conditions that exist. You should also check that your problem is not described already in See 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 development team to analyze and correct the problem.

Sometimes, there might be also problems due to Tramp caches. Flush all caches before running the test, Cleanup remote connections.

Before reporting the bug, you should set the verbosity level to 6 (see Traces) in the ~/.emacs file and repeat the bug. Then, include the contents of the *tramp/foo* and *debug tramp/foo* buffers in your bug report. A verbosity level greater than 6 will produce a very huge debug buffer, which is mostly not necessary for the analysis.

Please be aware that, with a verbosity level of 6 or greater, the contents of files and directories will be included in the debug buffer. Passwords you’ve typed will never be included there.


Next: , Previous: Bug Reports, Up: Top   [Contents][Index]

8 Frequently Asked Questions


Next: , Previous: Frequently Asked Questions, Up: Top   [Contents][Index]

9 How file names, directories and localnames are mangled and managed.


Up: Files directories and localnames   [Contents][Index]

9.1 Breaking a localname into its components

TRAMP file names are somewhat different, obviously, to ordinary file names. As such, the lisp functions file-name-directory and file-name-nondirectory are overridden within the TRAMP package.

Their replacements are reasonably simplistic in their approach. They dissect the file name, call the original handler on the localname and then rebuild the 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.


Next: , Previous: Files directories and localnames, Up: Top   [Contents][Index]

10 How to Customize Traces

All TRAMP messages are raised with a verbosity level. The verbosity level can be any number between 0 and 10. Only messages with a verbosity level less than or equal to tramp-verbose are displayed.

The verbosity levels are

 0 silent (no TRAMP messages at all)
 1 errors
 2 warnings
 3 connection to remote hosts (default verbosity)
 4 activities
 5 internal
 6 sent and received strings
 7 file caching
 8 connection properties
 9 test commands
10 traces (huge)

When tramp-verbose is greater than or equal to 4, the messages are also written into a TRAMP debug buffer. This debug buffer is useful for analyzing problems; sending a TRAMP bug report should be done with tramp-verbose set to a verbosity level of at least 6 (see Bug Reports).

The debug buffer is in Outline Mode. That means, you can change the level of messages to be viewed. If you want, for example, see only messages up to verbosity level 5, you must enter C-u 6 C-c C-q.

TRAMP errors are handled internally in order to raise the verbosity level 1 messages. When you want to get a Lisp backtrace in case of an error, you need to set both

(setq debug-on-error t
      debug-on-signal t)

Sometimes, it might be even necessary to step through TRAMP function call traces. Such traces are enabled by the following code:

(require 'tramp)
(require 'trace)
(dolist (elt (all-completions "tramp-" obarray 'functionp))
  (trace-function-background (intern elt)))
(untrace-function 'tramp-read-passwd)
(untrace-function 'tramp-gw-basic-authentication)

The function call traces are inserted in the buffer *trace-output*. tramp-read-passwd and tramp-gw-basic-authentication shall be disabled when the function call traces are added to TRAMP, because both functions return password strings, which should not be distributed.


Next: , Previous: Traces and Profiles, Up: Top   [Contents][Index]

11 Debatable Issues and What Was Decided


Next: , Previous: Issues, Up: Top   [Contents][Index]

Appendix A GNU Free Documentation License

Version 1.3, 3 November 2008
Copyright © 2000, 2001, 2002, 2007, 2008, 2009 Free Software Foundation, Inc.
http://fsf.org/

Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
  1. PREAMBLE

    The purpose of this License is to make a manual, textbook, or other functional and useful document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.

    This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.

    We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.

  2. APPLICABILITY AND DEFINITIONS

    This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The “Document”, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.

    A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.

    A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document’s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.

    The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.

    The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.

    A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque”.

    Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.

    The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work’s title, preceding the beginning of the body of the text.

    The “publisher” means any person or entity that distributes copies of the Document to the public.

    A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.

    The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.

  3. VERBATIM COPYING

    You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.

    You may also lend copies, under the same conditions stated above, and you may publicly display copies.

  4. COPYING IN QUANTITY

    If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document’s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.

    If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.

    If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.

    It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.

  5. MODIFICATIONS

    You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:

    1. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.
    2. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.
    3. State on the Title page the name of the publisher of the Modified Version, as the publisher.
    4. Preserve all the copyright notices of the Document.
    5. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
    6. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.
    7. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document’s license notice.
    8. Include an unaltered copy of this License.
    9. Preserve the section Entitled “History”, Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled “History” in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.
    10. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the “History” section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.
    11. For any section Entitled “Acknowledgements” or “Dedications”, Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.
    12. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.
    13. Delete any section Entitled “Endorsements”. Such a section may not be included in the Modified Version.
    14. Do not retitle any existing section to be Entitled “Endorsements” or to conflict in title with any Invariant Section.
    15. Preserve any Warranty Disclaimers.

    If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles.

    You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.

    You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.

    The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.

  6. COMBINING DOCUMENTS

    You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.

    The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.

    In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements.”

  7. COLLECTIONS OF DOCUMENTS

    You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.

    You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.

  8. AGGREGATION WITH INDEPENDENT WORKS

    A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights of the compilation’s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.

    If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document’s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.

  9. TRANSLATION

    Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.

    If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.

  10. TERMINATION

    You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License.

    However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.

    Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.

    Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it.

  11. FUTURE REVISIONS OF THIS LICENSE

    The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.

    Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Document.

  12. RELICENSING

    “Massive Multiauthor Collaboration Site” (or “MMC Site”) means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A “Massive Multiauthor Collaboration” (or “MMC”) contained in the site means any set of copyrightable works thus published on the MMC site.

    “CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization.

    “Incorporate” means to publish or republish a Document, in whole or in part, as part of another Document.

    An MMC is “eligible for relicensing” if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008.

    The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing.

ADDENDUM: How to use this License for your documents

To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:

  Copyright (C)  year  your name.
  Permission is granted to copy, distribute and/or modify this document
  under the terms of the GNU Free Documentation License, Version 1.3
  or any later version published by the Free Software Foundation;
  with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
  Texts.  A copy of the license is included in the section entitled ``GNU
  Free Documentation License''.

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with…Texts.” line with this:

    with the Invariant Sections being list their titles, with
    the Front-Cover Texts being list, and with the Back-Cover Texts
    being list.

If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.

If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.


Next: , Previous: GNU Free Documentation License, Up: Top   [Contents][Index]

Function Index

Jump to:   M   T  
Index Entry  Section

M
my-tramp-parse: Customizing Completion

T
tramp-bug: Bug Reports
tramp-cleanup-all-buffers: Cleanup remote connections
tramp-cleanup-all-connections: Cleanup remote connections
tramp-cleanup-connection: Cleanup remote connections
tramp-cleanup-this-connection: Cleanup remote connections
tramp-get-completion-function: Customizing Completion
tramp-parse-hosts: Customizing Completion
tramp-parse-netrc: Customizing Completion
tramp-parse-passwd: Customizing Completion
tramp-parse-rhosts: Customizing Completion
tramp-parse-shostkeys: Customizing Completion
tramp-parse-shostkeys: Customizing Completion
tramp-parse-shosts: Customizing Completion
tramp-parse-shosts: Customizing Completion
tramp-set-completion-function: Customizing Completion

Jump to:   M   T  

Next: , Previous: Function Index, Up: Top   [Contents][Index]

Variable Index

Jump to:   A   B   P   S   T  
Index Entry  Section

A
auth-sources: Password handling

B
bkup-backup-directory-info: Auto-save and Backup

P
password-cache: Password handling
password-cache-expiry: Password handling

S
shell-prompt-pattern: Remote shell setup

T
tramp-actions-before-shell: Remote shell setup
tramp-completion-function-alist: Customizing Completion
tramp-completion-reread-directory-timeout: File name completion
tramp-connection-properties: Predefined connection information
tramp-default-host: Default Host
tramp-default-host-alist: Default Host
tramp-default-method: Default Method
tramp-default-method-alist: Default Method
tramp-default-proxies-alist: Multi-hops
tramp-default-proxies-alist: Multi-hops
tramp-default-remote-path: Remote Programs
tramp-default-user-alist: Default User
tramp-gvfs-methods: GVFS based methods
tramp-own-remote-path: Remote Programs
tramp-password-prompt-regexp: Remote shell setup
tramp-persistency-file-name: Connection caching
tramp-remote-path: Remote Programs
tramp-remote-path: Remote Programs
tramp-restricted-shell-hosts-alist: Multi-hops
tramp-restricted-shell-hosts-alist: Multi-hops
tramp-save-ad-hoc-proxies: Ad-hoc multi-hops
tramp-save-ad-hoc-proxies: Ad-hoc multi-hops
tramp-shell-prompt-pattern: Remote shell setup
tramp-terminal-type: Remote shell setup
tramp-wrong-passwd-regexp: Remote shell setup

Jump to:   A   B   P   S   T  

Previous: Variable Index, Up: Top   [Contents][Index]

Concept Index

Jump to:   .  
A   B   C   D   E   F   G   H   I   K   M   O   P   R   S   T   U   W  
Index Entry  Section

.
.login file: Remote shell setup
.profile file: Remote shell setup

A
adb method: External methods
android shell setup: Android shell setup
auto-save: Auto-save and Backup

B
backup: Auto-save and Backup
base-64 encoding: Inline methods
behind the scenes: Overview
bug reports: Bug Reports

C
caching: Connection caching
choosing the right method: Default Method
cleanup: Cleanup remote connections
compile: Remote processes
configuration: Configuration
connection types, overview: Connection types
create your own methods: Customizing Methods
customizing completion: Customizing Completion
customizing methods: Customizing Methods
Cygwin and ssh-agent: Windows setup hints
Cygwin, issues: Windows setup hints

D
dav method: GVFS based methods
davs method: GVFS based methods
dbus: GVFS based methods
default configuration: Configuration
default host: Default Host
default method: Default Method
default user: Default User
details of operation: Overview
development history: History

E
eshell: Remote processes
external methods: Connection types
external methods: External methods

F
FAQ: Frequently Asked Questions
fcp (with fcp method): External methods
fcp method: External methods
file name completion: File name completion
file name examples: File name Syntax
file name syntax: File name Syntax
frequently asked questions: Frequently Asked Questions
fsh (with fcp method): External methods
fsh method: External methods
ftp method: External methods

G
gateway methods: Gateway methods
gdb: Remote processes
gud: Remote processes
gvfs based methods: GVFS based methods

H
history: History
how it works: Overview

I
inline methods: Connection types
inline methods: Inline methods
installation: Installation
installation: Installation parameters
installation: Load paths

K
Kerberos (with krlogin method): Inline methods
Kerberos (with ksu method): Inline methods
krlogin method: Inline methods
ksu method: Inline methods

M
method adb: External methods
method dav: GVFS based methods
method davs: GVFS based methods
method fcp: External methods
method fsh: External methods
method ftp: External methods
method krlogin: Inline methods
method ksu: Inline methods
method obex: GVFS based methods
method plink: Inline methods
method plinkx: Inline methods
method pscp: External methods
method psftp: External methods
method rcp: External methods
method rsh: Inline methods
method rsync: External methods
method scp: External methods
method scpx: External methods
method scpx with Cygwin: Windows setup hints
method sftp: External methods
method smb: External methods
method socks: Gateway methods
method ssh: Inline methods
method sshx: Inline methods
method sshx with Cygwin: Windows setup hints
method su: Inline methods
method sudo: Inline methods
method synce: GVFS based methods
method telnet: Inline methods
method tunnel: Gateway methods
methods, external: Connection types
methods, external: External methods
methods, gateway: Gateway methods
methods, gvfs: GVFS based methods
methods, inline: Connection types
methods, inline: Inline methods
mimencode: Inline methods
multi-hop: Multi-hops
multi-hop, ad-hoc: Ad-hoc multi-hops

O
obex method: GVFS based methods
obtaining Tramp: Obtaining Tramp
overview: Overview

P
passwords: Password handling
perldb: Remote processes
plink (with pscp method): External methods
plink (with psftp method): External methods
plink method: Inline methods
plinkx method: Inline methods
powershell: Remote processes
proxy hosts: Multi-hops
proxy hosts, ad-hoc: Ad-hoc multi-hops
pscp (with pscp method): External methods
pscp method: External methods
psftp (with psftp method): External methods
psftp method: External methods
PuTTY (with pscp method): External methods
PuTTY (with psftp method): External methods

R
rcp (with rcp method): External methods
rcp method: External methods
recompile: Remote processes
remote shell setup: Remote shell setup
rsh (with rcp method): External methods
rsh method: Inline methods
rsync (with rsync method): External methods
rsync method: External methods

S
scp (with scp method): External methods
scp (with scpx method): External methods
scp method: External methods
scpx method: External methods
scpx method with Cygwin: Windows setup hints
selecting config files: Customizing Completion
sftp (with sftp method): External methods
sftp method: External methods
shell: Remote processes
shell init files: Remote shell setup
shell-command: Remote processes
smb method: External methods
socks method: Gateway methods
ssh (with rsync method): External methods
ssh (with scp method): External methods
ssh (with scpx method): External methods
ssh (with sftp method): External methods
ssh method: Inline methods
sshx method: Inline methods
sshx method with Cygwin: Windows setup hints
SSH_AUTH_SOCK and XEmacs on Windows: Windows setup hints
su method: Inline methods
sudo method: Inline methods
synce method: GVFS based methods

T
telnet method: Inline methods
tset Unix command: Remote shell setup
tunnel method: Gateway methods
type-ahead: Usage

U
Unix command tset: Remote shell setup
using non-standard methods: Customizing Methods
using TRAMP: Usage
uuencode: Inline methods

W
winexe: Remote processes

Jump to:   .  
A   B   C   D   E   F   G   H   I   K   M   O   P   R   S   T   U   W  

Footnotes

(1)

Invoking /bin/sh will fail if your login shell doesn’t recognize ‘exec /bin/sh’ as a valid command. Maybe you use the Scheme shell scsh

(2)

HTTP tunnels are intended for secure SSL/TLS communication. Therefore, many proxy server restrict the tunnels to related target ports. You might need to run your ssh server on your target host ‘host.other.domain’ on such a port, like 443 (https). See http://savannah.gnu.org/maintenance/CvsFromBehindFirewall for discussion of ethical issues.