# TRAMP User Manual

## Table of Contents

- tramp version 2.2.0 User Manual
- 1 An overview of tramp
- 2 Obtaining Tramp.
- 3 History of tramp
- 4 Configuring tramp for use
  - 4.1 Types of connections made to remote machines.
  - 4.2 Inline methods
  - 4.3 External methods
  - 4.4 GVFS based external methods
  - 4.5 Gateway methods
  - 4.6 Selecting a default method
    - 4.6.1 Which method is the right one for me?
  - 4.7 Selecting a default user
  - 4.8 Selecting a default host
  - 4.9 Connecting to a remote host using multiple hops
  - 4.10 Using Non-Standard Methods
  - 4.11 Selecting config files for user/host name completion
  - 4.12 Reusing passwords for several connections.
    - 4.12.1 Using an authentication file
    - 4.12.2 Caching passwords
  - 4.13 Reusing connection related information.
  - 4.14 How tramp finds and uses programs on the remote machine.
  - 4.15 Remote shell setup hints
  - 4.16 Auto-save and Backup configuration
  - 4.17 Issues with Cygwin ssh
- 5 Using tramp
  - 5.1 tramp filename conventions
  - 5.2 URL-like filename syntax
  - 5.3 Filename completion
  - 5.4 Integration with other GNU Emacs packages.
    - 5.4.1 Running remote programs that create local X11 windows
    - 5.4.2 Running shell-command on a remote host
    - 5.4.3 Running eshell on a remote host
    - 5.4.4 Running a debugger on a remote host
  - 5.5 Cleanup remote connections.
- 6 Reporting Bugs and Problems
- 7 Frequently Asked Questions
- 8 How file names, directories and localnames are mangled and managed.
  - 8.1 Breaking a localname into its components.
  - 8.2 Integration with external Lisp packages.
    - 8.2.1 Filename completion.
    - 8.2.2 File attributes cache.
- 9 How to Customize Traces
- 10 Debatable Issues and What Was Decided
- Appendix A GNU Free Documentation License
- Function Index
- Variable Index
- Concept Index

Next: Overview, Previous: (dir), Up: (dir)

## tramp version 2.2.0 User Manual

This file documents tramp version 2.2.0, a remote file editing package for GNU Emacs.

tramp stands for `Transparent Remote (file) Access, Multiple Protocol'. This package provides remote file editing, similar to Ange-FTP.

The difference is that Ange-FTP 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 latest release of tramp is available for download, or you may see Obtaining Tramp for more details, including the CVS 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, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 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. Buying copies from the FSF supports it in developing GNU and promoting software freedom.”

For the end user:

For the developer:

--- The Detailed Node Listing ---

Configuring tramp for use

Using tramp

How file names, directories and localnames are mangled and managed