Commit | Line | Data |
---|---|---|
fb7933a3 KG |
1 | \input texinfo @c -*-texinfo-*- |
2 | @c %**start of header | |
6344cbf1 | 3 | @setfilename ../info/tramp |
fb7933a3 KG |
4 | @settitle TRAMP User Manual |
5 | @setchapternewpage odd | |
6 | @c %**end of header | |
7 | ||
8 | @c This is *so* much nicer :) | |
9 | @footnotestyle end | |
10 | ||
16674e4f KG |
11 | @c In the Tramp CVS, the version number is auto-frobbed from the |
12 | @c Makefile, so you should edit the top-level Makefile to change | |
13 | @c the version number. | |
14 | @macro trampver{} | |
abc6be8d | 15 | 2.0.28 |
16674e4f | 16 | @end macro |
fb7933a3 KG |
17 | |
18 | @c Entries for @command{install-info} to use | |
92eeeafc | 19 | @dircategory Emacs |
fb7933a3 KG |
20 | @direntry |
21 | * TRAMP: (tramp). Transparent Remote Access, Multiple Protocol | |
22 | Emacs remote file access via rsh and rcp. | |
23 | @end direntry | |
24 | ||
25 | @c Macro to make formatting of the tramp program name consistent. | |
26 | @macro tramp | |
27 | @sc{tramp} | |
28 | @end macro | |
29 | ||
16674e4f KG |
30 | @c Distinguish between GNU Emacs and XEmacs. Derived from the |
31 | @c Makefile variable $(EMACS-ID). Valid values are `emacs' and `xemacs'. | |
32 | @set emacs | |
33 | ||
34 | @c Some flags which make the text independent on the (X)Emacs flavor. | |
35 | @c GNU Emacs values. | |
36 | @ifset emacs | |
37 | @set emacs-name Emacs | |
38 | @set emacs-dir emacs | |
39 | @set ftp-package-name Ange-FTP | |
40 | @set tramp-prefix / | |
41 | @set tramp-prefix-single-hop | |
42 | @set tramp-postfix : | |
43 | @set tramp-postfix-single-hop : | |
44 | @set tramp-postfix-multi-hop : | |
45 | @end ifset | |
46 | ||
47 | @c XEmacs counterparts. | |
48 | @ifset xemacs | |
49 | @set emacs-name XEmacs | |
50 | @set emacs-dir xemacs | |
51 | @set ftp-package-name EFS | |
52 | @set tramp-prefix /[ | |
53 | @set tramp-prefix-single-hop [ | |
54 | @set tramp-postfix ] | |
55 | @set tramp-postfix-single-hop / | |
56 | @set tramp-postfix-multi-hop : | |
57 | @end ifset | |
58 | ||
59 | @c Macros for formatting a filename. | |
60 | @c trampfn is for a full filename, trampfnmhp means method, host, path | |
61 | @c were given, and so on. | |
62 | @macro trampfn(method, user, host, path) | |
63 | @value{tramp-prefix}@value{method}@value{user}@@@value{host}@value{tramp-postfix}@value{path} | |
64 | @end macro | |
fb7933a3 | 65 | |
f08d9f0e KG |
66 | @copying |
67 | Copyright @copyright{} 1999, 2000, 2001, 2002 Free Software | |
68 | Foundation, Inc. | |
69 | ||
177c0ea7 | 70 | @quotation |
f08d9f0e KG |
71 | Permission is granted to copy, distribute and/or modify this document |
72 | under the terms of the GNU Free Documentation License, Version 1.1 or | |
73 | any later version published by the Free Software Foundation; with no | |
74 | Invariant Sections, with the Front-Cover texts being ``A GNU | |
75 | Manual'', and with the Back-Cover Texts as in (a) below. A copy of the | |
76 | license is included in the section entitled ``GNU Free Documentation | |
77 | License'' in the Emacs manual. | |
78 | ||
79 | (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify | |
80 | this GNU Manual, like GNU software. Copies published by the Free | |
81 | Software Foundation raise funds for GNU development.'' | |
82 | ||
83 | This document is part of a collection distributed under the GNU Free | |
84 | Documentation License. If you want to distribute this document | |
85 | separately from the collection, you can do so by adding a copy of the | |
86 | license to the document, as described in section 6 of the license. | |
87 | @end quotation | |
88 | @end copying | |
89 | ||
fb7933a3 KG |
90 | @tex |
91 | ||
92 | @titlepage | |
16674e4f | 93 | @title @tramp{} version @trampver{} User Manual |
fb7933a3 KG |
94 | |
95 | @author by Daniel Pittman | |
96 | @author based on documentation by Kai Gro@ss{}johann | |
f08d9f0e | 97 | |
fb7933a3 | 98 | @page |
f08d9f0e | 99 | @insertcopying |
fb7933a3 | 100 | |
fb7933a3 KG |
101 | @end titlepage |
102 | @page | |
103 | ||
104 | @end tex | |
105 | ||
106 | @ifnottex | |
92eeeafc | 107 | @node Top, Overview, (dir), (dir) |
16674e4f KG |
108 | @top @tramp{} version @trampver{} User Manual |
109 | ||
110 | This file documents @tramp{} version @trampver{}, a remote file | |
111 | editing package for @value{emacs-name}. | |
fb7933a3 KG |
112 | |
113 | @tramp{} stands for `Transparent Remote (file) Access, Multiple | |
114 | Protocol'. This package provides remote file editing, similar to | |
16674e4f | 115 | @value{ftp-package-name}. |
fb7933a3 | 116 | |
16674e4f KG |
117 | The difference is that @value{ftp-package-name} uses FTP to transfer |
118 | files between the local and the remote host, whereas @tramp{} uses a | |
119 | combination of @command{rsh} and @command{rcp} or other work-alike | |
120 | programs, such as @command{ssh}/@command{scp}. | |
fb7933a3 | 121 | |
fb7933a3 KG |
122 | You can find the latest version of this document on the web at |
123 | @uref{http://www.freesoftware.fsf.org/tramp/}. | |
124 | ||
125 | @ifhtml | |
126 | This manual is also available as a @uref{tramp_ja.html, Japanese | |
127 | translation}. | |
128 | ||
129 | The latest release of @tramp{} is available for | |
130 | @uref{http://savannah.gnu.org/download/tramp/, | |
131 | download}, or you may see @ref{Obtaining @tramp{}} for more details, | |
132 | including the CVS server details. | |
133 | ||
134 | @tramp{} also has a @uref{https://savannah.gnu.org/projects/tramp/, | |
135 | Savannah Project Page}. | |
136 | @end ifhtml | |
137 | ||
138 | There is a mailing list for @tramp{}, available at | |
139 | @email{tramp-devel@@mail.freesoftware.fsf.org}, and archived at | |
140 | @uref{http://www.mail-archive.com/emacs-rcp@@ls6.cs.uni-dortmund.de/} as | |
141 | well as the usual Savannah archives. | |
142 | ||
f08d9f0e KG |
143 | @insertcopying |
144 | ||
fb7933a3 KG |
145 | @end ifnottex |
146 | ||
147 | @menu | |
fb7933a3 KG |
148 | * Overview:: What @tramp{} can and cannot do. |
149 | ||
150 | For the end user: | |
151 | * Obtaining @tramp{}:: How to obtain @tramp{}. | |
16674e4f KG |
152 | * History:: History of @tramp{}. |
153 | * Installation:: Installing @tramp{} with your @value{emacs-name}. | |
fb7933a3 KG |
154 | * Configuration:: Configuring @tramp{} for use. |
155 | * Usage:: An overview of the operation of @tramp{}. | |
16674e4f | 156 | * Bug Reports:: Reporting Bugs and Problems. |
fb7933a3 KG |
157 | * Frequently Asked Questions:: Questions and answers from the mailing list. |
158 | ||
159 | For the developer: | |
160 | * Version Control:: The inner workings of remote version control. | |
161 | * Files directories and paths:: How file names, directories and paths are mangled and managed. | |
16674e4f | 162 | * Issues:: Debatable Issues and What Was Decided. |
fb7933a3 KG |
163 | |
164 | @detailmenu | |
165 | --- The Detailed Node Listing --- | |
166 | ||
167 | Configuring @tramp{} for use | |
168 | ||
169 | * Connection types:: Types of connections made to remote machines. | |
170 | * Inline methods:: Inline methods. | |
171 | * External transfer methods:: External transfer methods. | |
172 | * Multi-hop Methods:: Connecting to a remote host using multiple hops. | |
173 | * Default Method:: Selecting a default method. | |
174 | * Customizing Methods:: Using Non-Standard Methods. | |
16674e4f | 175 | * Customizing Completion:: Selecting config files for user/host name completion. |
fb7933a3 | 176 | * Remote Programs:: How @tramp{} finds and uses programs on the remote machine. |
16674e4f KG |
177 | * Remote shell setup:: Remote shell setup hints. |
178 | * Windows setup hints:: Issues with Cygwin ssh. | |
fb7933a3 KG |
179 | |
180 | Using @tramp | |
181 | ||
182 | * Filename Syntax:: @tramp{} filename conventions. | |
16674e4f KG |
183 | * Multi-hop filename syntax:: Multi-hop filename conventions. |
184 | * Filename completion:: Filename completion. | |
185 | * Dired:: Dired. | |
fb7933a3 KG |
186 | |
187 | The inner workings of remote version control | |
188 | ||
189 | * Version Controlled Files:: Determining if a file is under version control. | |
190 | * Remote Commands:: Executing the version control commands on the remote machine. | |
191 | * Changed workfiles:: Detecting if the working file has changed. | |
192 | * Checking out files:: Bringing the workfile out of the repository. | |
16674e4f | 193 | * Miscellaneous Version Control:: Things related to Version Control that don't fit elsewhere. |
fb7933a3 KG |
194 | |
195 | Things related to Version Control that don't fit elsewhere | |
196 | ||
197 | * Remote File Ownership:: How VC determines who owns a workfile. | |
198 | * Back-end Versions:: How VC determines what release your RCS is. | |
199 | ||
200 | How file names, directories and paths are mangled and managed. | |
201 | ||
202 | * Path deconstruction:: Breaking a path into its components. | |
203 | ||
204 | @end detailmenu | |
205 | @end menu | |
206 | ||
fb7933a3 KG |
207 | @node Overview |
208 | @chapter An overview of @tramp | |
92eeeafc | 209 | @cindex overview |
fb7933a3 | 210 | |
16674e4f KG |
211 | After the installation of @tramp{} into your @value{emacs-name}, you |
212 | will be able to access files on remote machines as though they were | |
213 | local. Access to the remote file system for editing files, version | |
214 | control, and @command{dired} are transparently enabled. | |
fb7933a3 KG |
215 | |
216 | Your access to the remote machine can be with the @command{rsh}, | |
217 | @command{rlogin}, @command{telnet} programs or with any similar | |
92eeeafc | 218 | connection method. This connection must pass ASCII successfully to be |
fb7933a3 KG |
219 | usable but need not be 8-bit clean. |
220 | ||
221 | The package provides support for @command{ssh} connections out of the | |
92eeeafc KG |
222 | box, one of the more common uses of the package. This allows |
223 | relatively secure access to machines, especially if @command{ftp} | |
224 | access is disabled. | |
fb7933a3 | 225 | |
92eeeafc KG |
226 | The majority of activity carried out by @tramp{} requires only that |
227 | the remote login is possible and is carried out at the terminal. In | |
228 | order to access remote files @tramp{} needs to transfer their content | |
229 | to the local machine temporarily. | |
fb7933a3 | 230 | |
92eeeafc KG |
231 | @tramp{} can transfer files between the machines in a variety of ways. |
232 | The details are easy to select, depending on your needs and the | |
233 | machines in question. | |
fb7933a3 | 234 | |
92eeeafc KG |
235 | The fastest transfer methods (for large files) rely on a remote file |
236 | transfer package such as @command{rcp}, @command{scp} or | |
237 | @command{rsync}. The use of these methods is only possible if the | |
238 | file copy command does not ask for a password for the remote machine. | |
fb7933a3 KG |
239 | |
240 | If the remote copy methods are not suitable for you, @tramp{} also | |
92eeeafc KG |
241 | supports the use of encoded transfers directly through the shell. |
242 | This requires that the @command{mimencode} or @command{uuencode} tools | |
243 | are available on the remote machine. These methods are generally | |
244 | faster for small files. | |
fb7933a3 | 245 | |
92eeeafc KG |
246 | Within these limitations, @tramp{} is quite powerful. It is worth |
247 | noting that, as of the time of writing, it is far from a polished | |
248 | end-user product. For a while yet you should expect to run into rough | |
249 | edges and problems with the code now and then. | |
fb7933a3 KG |
250 | |
251 | It is finished enough that the developers use it for day to day work but | |
252 | the installation and setup can be a little difficult to master, as can | |
253 | the terminology. | |
254 | ||
255 | @tramp{} is still under active development and any problems you encounter, | |
256 | trivial or major, should be reported to the @tramp{} developers. | |
257 | @xref{Bug Reports}. | |
258 | ||
259 | ||
260 | @subsubheading Behind the scenes | |
92eeeafc | 261 | @cindex behind the scenes |
e28e4d20 KG |
262 | @cindex details of operation |
263 | @cindex how it works | |
fb7933a3 KG |
264 | |
265 | This section tries to explain what goes on behind the scenes when you | |
266 | access a remote file through @tramp{}. | |
267 | ||
268 | Suppose you type @kbd{C-x C-f} and enter part of an @tramp{} file name, | |
269 | then hit @kbd{@key{TAB}} for completion. Suppose further that this is | |
270 | the first time that @tramp{} is invoked for the host in question. Here's | |
271 | what happens: | |
272 | ||
273 | @itemize | |
274 | @item | |
92eeeafc KG |
275 | @tramp{} discovers that it needs a connection to the host. So it |
276 | invokes @samp{telnet @var{host}} or @samp{rsh @var{host} -l | |
277 | @var{user}} or a similar tool to connect to the remote host. | |
16674e4f KG |
278 | Communication with this process happens through an |
279 | @value{emacs-name} buffer, that is, the output from the remote end | |
280 | goes into a buffer. | |
fb7933a3 KG |
281 | |
282 | @item | |
283 | The remote host may prompt for a login name (for @command{telnet}). The | |
284 | login name is given in the file name, so @tramp{} sends the login name and | |
285 | a newline. | |
286 | ||
287 | @item | |
288 | The remote host may prompt for a password or pass phrase (for | |
289 | @command{rsh} or for @command{telnet} after sending the login name). | |
290 | @tramp{} displays the prompt in the minibuffer, asking you for the | |
291 | password or pass phrase. | |
292 | ||
293 | You enter the password or pass phrase. @tramp{} sends it to the remote | |
294 | host, followed by a newline. | |
295 | ||
296 | @item | |
297 | @tramp{} now waits for the shell prompt or for a message that the login | |
298 | failed. | |
299 | ||
300 | If @tramp{} sees neither of them after a certain period of time (a minute, | |
301 | say), then it issues an error message saying that it couldn't find the | |
302 | remote shell prompt and shows you what the remote host has sent. | |
303 | ||
16674e4f KG |
304 | If @tramp{} sees a @samp{login failed} message, it tells you so, |
305 | aborts the login attempt and allows you to try again. | |
fb7933a3 KG |
306 | |
307 | @item | |
308 | Suppose that the login was successful and @tramp{} sees the shell prompt | |
309 | from the remote host. Now @tramp{} invokes @command{/bin/sh} because | |
310 | Bourne shells and C shells have different command | |
311 | syntaxes.@footnote{Invoking @command{/bin/sh} will fail if your login | |
92eeeafc | 312 | shell doesn't recognize @samp{exec /bin/sh} as a valid command. |
fb7933a3 KG |
313 | Maybe you use the Scheme shell @command{scsh}@dots{}} |
314 | ||
315 | After the Bourne shell has come up, @tramp{} sends a few commands to | |
316 | ensure a good working environment. It turns off echoing, it sets the | |
317 | shell prompt, and a few other things. | |
318 | ||
319 | @item | |
320 | Now the remote shell is up and it good working order. Remember, what | |
321 | was supposed to happen is that @tramp{} tries to find out what files exist | |
322 | on the remote host so that it can do filename completion. | |
323 | ||
324 | So, @tramp{} basically issues @command{cd} and @command{ls} commands and | |
325 | also sometimes @command{echo} with globbing. Another command that is | |
326 | often used is @command{test} to find out whether a file is writable or a | |
327 | directory or the like. The output of each command is parsed for the | |
328 | necessary operation. | |
329 | ||
330 | @item | |
331 | Suppose you are finished with filename completion, have entered @kbd{C-x | |
332 | C-f}, a full file name and hit @kbd{@key{RET}}. Now comes the time to | |
333 | transfer the file contents from the remote host to the local host so | |
334 | that you can edit them. | |
335 | ||
336 | See above for an explanation of how @tramp{} transfers the file contents. | |
337 | ||
92eeeafc | 338 | For inline transfers, @tramp{} issues a command like @samp{mimencode -b |
fb7933a3 KG |
339 | /path/to/remote/file}, waits until the output has accumulated in the |
340 | buffer that's used for communication, then decodes that output to | |
341 | produce the file contents. | |
342 | ||
16674e4f KG |
343 | For out-of-band transfers, @tramp{} issues a command like the following: |
344 | @example | |
345 | rcp user@@host:/path/to/remote/file /tmp/tramp.4711 | |
346 | @end example | |
347 | It then reads the local temporary file @file{/tmp/tramp.4711} into a | |
348 | buffer and deletes the temporary file. | |
fb7933a3 KG |
349 | |
350 | @item | |
351 | You now edit the buffer contents, blithely unaware of what has happened | |
352 | behind the scenes. (Unless you have read this section, that is.) When | |
353 | you are finished, you type @kbd{C-x C-s} to save the buffer. | |
354 | ||
355 | @item | |
356 | Again, @tramp{} transfers the file contents to the remote host either | |
357 | inline or out-of-band. This is the reverse of what happens when reading | |
358 | the file. | |
359 | ||
360 | @end itemize | |
361 | ||
362 | I hope this has provided you with a basic overview of what happens | |
363 | behind the scenes when you open a file with @tramp{}. | |
364 | ||
365 | ||
366 | @c For the end user | |
367 | @node Obtaining @tramp{} | |
368 | @chapter Obtaining @tramp{}. | |
92eeeafc | 369 | @cindex obtaining Tramp |
fb7933a3 KG |
370 | |
371 | @tramp{} is freely available on the Internet and the latest release may be | |
372 | downloaded from | |
373 | @uref{ftp://ls6-ftp.cs.uni-dortmund.de/pub/src/emacs/tramp.tar.gz}. This | |
374 | release includes the full documentation and code for @tramp{}, suitable | |
92eeeafc KG |
375 | for installation. But Emacs (21.4 or later) includes @tramp{} |
376 | already, and there is a @tramp{} package for XEmacs, as well. So | |
377 | maybe it is easier to just use those. But if you want the bleeding | |
378 | edge, read on@dots{...} | |
fb7933a3 | 379 | |
92eeeafc | 380 | For the especially brave, @tramp{} is available from CVS. The CVS version |
fb7933a3 KG |
381 | is the latest version of the code and may contain incomplete features or |
382 | new issues. Use these versions at your own risk. | |
383 | ||
384 | Instructions for obtaining the latest development version of @tramp{} | |
16674e4f KG |
385 | from CVS can be found by going to the Savannah project page at the |
386 | following URL and then clicking on the CVS link in the navigation bar at | |
387 | the top. | |
388 | ||
389 | @noindent | |
390 | @uref{http://savannah.gnu.org/projects/tramp/} | |
391 | ||
392 | @noindent | |
393 | Or follow the example session below: | |
fb7933a3 KG |
394 | |
395 | @example | |
16674e4f | 396 | ] @strong{cd ~/@value{emacs-dir}} |
fb7933a3 KG |
397 | ] @strong{cvs -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/tramp login} |
398 | ||
399 | (Logging in to anoncvs@@subversions.gnu.org) | |
400 | CVS password: @strong{(just hit RET here)} | |
401 | @dots{} | |
402 | ||
403 | ] @strong{cvs -z3 -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/tramp co tramp} | |
404 | @end example | |
405 | ||
16674e4f KG |
406 | @noindent |
407 | You should now have a directory @file{~/@value{emacs-dir}/tramp} containing the latest | |
fb7933a3 KG |
408 | version of @tramp{}. You can fetch the latest updates from the repository |
409 | by issuing the command: | |
410 | ||
411 | @example | |
16674e4f | 412 | ] @strong{cd ~/@value{emacs-dir}/tramp} |
fb7933a3 KG |
413 | ] @strong{cvs update -d} |
414 | @end example | |
415 | ||
416 | ||
417 | @node History | |
418 | @chapter History of @tramp{} | |
92eeeafc KG |
419 | @cindex history |
420 | @cindex development history | |
fb7933a3 KG |
421 | |
422 | Development was started end of November 1998. The package was called | |
92eeeafc KG |
423 | @file{rssh.el}, back then. It only provided one method to access a |
424 | file, using @command{ssh} to log in to a remote host and using | |
425 | @command{scp} to transfer the file contents. After a while, the name | |
426 | was changed to @file{rcp.el}, and now it's @tramp{}. Along the way, | |
427 | many more methods for getting a remote shell and for transferring the | |
428 | file contents were added. Support for VC was added. | |
fb7933a3 | 429 | |
92eeeafc KG |
430 | The most recent addition of major features were the multi-hop methods |
431 | added in April 2000 and the unification of @tramp{} and Ange-FTP | |
432 | filenames in July 2002. | |
fb7933a3 KG |
433 | |
434 | ||
435 | @node Installation | |
16674e4f | 436 | @chapter Installing @tramp{} into @value{emacs-name}. |
92eeeafc | 437 | @cindex installation |
fb7933a3 | 438 | |
16674e4f KG |
439 | If you use the version that comes with your @value{emacs-name}, the |
440 | following information is not necessary. Installing @tramp{} into your | |
441 | @value{emacs-name} is a relatively easy process, at least compared | |
442 | to rebuilding your machine from scratch. ;) | |
fb7933a3 KG |
443 | |
444 | Seriously though, the installation should be a fairly simple matter. | |
445 | ||
446 | The easiest way to proceed is as follows: | |
447 | ||
16674e4f | 448 | @itemize @bullet |
fb7933a3 | 449 | @item |
16674e4f | 450 | Choose a directory, say @file{~/@value{emacs-dir}/}. Change into that directory and |
fb7933a3 | 451 | unpack the tarball. This will give you a directory |
16674e4f | 452 | @file{~/@value{emacs-dir}/tramp/} which contains subdirectories @file{lisp} for the |
fb7933a3 KG |
453 | Lisp code and @file{texi} for the documentation. |
454 | ||
455 | @item | |
456 | Optionally byte-compile all files in the Lisp directory, | |
16674e4f KG |
457 | @file{~/@value{emacs-dir}/tramp/lisp/}, by issuing a command like the following from |
458 | the top level directory @file{~/@value{emacs-dir}/tramp/}: | |
459 | ||
fb7933a3 | 460 | @example |
16674e4f | 461 | make EMACS=@value{emacs-dir} all |
fb7933a3 KG |
462 | @end example |
463 | ||
464 | @item | |
16674e4f | 465 | NOTE: If you run into problems running the example @command{make} |
abc6be8d | 466 | command, don't despair. You can still byte compile the @file{*.el} |
16674e4f KG |
467 | files by opening @value{emacs-name} in @command{dired} (@command{C-x |
468 | d}) mode, at @file{~/@value{emacs-dir}/tramp/lisp}. Mark the lisp files with | |
469 | @kbd{m}, then press @kbd{B} to byte compile your selections. | |
470 | ||
471 | Something similar can be done to create the info manual. Just change | |
472 | to directory @file{~/@value{emacs-dir}/tramp/texi} and load the | |
473 | @file{tramp.texi} file in @value{emacs-name}. Then press @kbd{M-x | |
474 | makeinfo-buffer @key{RET}} to generate @file{tramp.info}. | |
fb7933a3 KG |
475 | |
476 | @item | |
16674e4f KG |
477 | Tell @value{emacs-name} about the new Lisp directory and the |
478 | @tramp{} package with the following lines in @file{~/.emacs}: | |
479 | ||
fb7933a3 | 480 | @lisp |
16674e4f | 481 | (add-to-list 'load-path "~/@value{emacs-dir}/tramp/lisp/") |
fb7933a3 KG |
482 | (require 'tramp) |
483 | @end lisp | |
484 | ||
485 | @item | |
486 | To be able to read the Info documentation, create a file | |
16674e4f KG |
487 | @file{~/@value{emacs-dir}/tramp/texi/dir} using the |
488 | @command{install-info} command, and add the directory to the search | |
fb7933a3 KG |
489 | path for Info. |
490 | ||
fb7933a3 | 491 | NOTE: |
16674e4f KG |
492 | On systems using the @cite{gnu} version of @command{install-info}, the |
493 | @command{install-info} syntax is very direct and simple. One can | |
494 | change to directory @file{~/@value{emacs-dir}/tramp/texi} and type: | |
495 | ||
fb7933a3 | 496 | @example |
16674e4f KG |
497 | install-info tramp.info dir |
498 | @end example | |
499 | ||
fb7933a3 KG |
500 | and a @file{dir} file will be created with the @tramp{} |
501 | entry. The info reader will know how to interpret it, but must | |
502 | be told where to find it (see below). If you want anything fancier | |
92eeeafc | 503 | you'll need to look through @kbd{man install-info}. |
fb7933a3 | 504 | |
16674e4f KG |
505 | Debian gnu/linux doesn't default to @cite{gnu} @command{install-info} |
506 | and uses its own version. This version does not create a @file{dir} | |
507 | file for you from scratch. You must provide a skeleton @file{dir} | |
508 | file it recognizes. One can be found in a default installation of | |
509 | @value{emacs-name} at @file{/usr/info/dir}. Copy the top of this file | |
510 | down to the first occurrence of @code{* Menu} including that line plus | |
511 | one more blank line, to your working directory | |
512 | @file{~/@value{emacs-dir}/tramp/texi}, or use the sample | |
513 | @file{~/@value{emacs-dir}/tramp/texi/dir_sample}. | |
514 | ||
515 | Once a @file{dir} file is in place, this command will make the entry: | |
516 | ||
517 | @example | |
518 | install-info --infodir=. tramp.info | |
fb7933a3 KG |
519 | @end example |
520 | ||
16674e4f KG |
521 | If you want it in a specific category see @kbd{man install-info} for |
522 | further details. | |
523 | ||
fb7933a3 | 524 | If the environment variable @env{INFOPATH} is set, add the directory |
16674e4f KG |
525 | @file{~/@value{emacs-dir}/tramp/texi/} to it. Else, add the directory to |
526 | @ifset emacs | |
fb7933a3 | 527 | @code{Info-default-directory-list}, as follows: |
16674e4f | 528 | |
fb7933a3 | 529 | @lisp |
16674e4f | 530 | (add-to-list 'Info-default-directory-list "~/@value{emacs-dir}/tramp/texi/") |
fb7933a3 | 531 | @end lisp |
16674e4f KG |
532 | @end ifset |
533 | @ifset xemacs | |
534 | @code{Info-directory-list}, as follows: | |
535 | @lisp | |
536 | (add-to-list 'Info-directory-list "~/@value{emacs-dir}/tramp/texi/") | |
537 | @end lisp | |
538 | @end ifset | |
fb7933a3 KG |
539 | |
540 | @end itemize | |
541 | ||
16674e4f KG |
542 | @ifset xemacs |
543 | For @value{emacs-name}, the package @file{fsf-compat} must be installed. | |
fb7933a3 KG |
544 | For details on package installation, see @ref{Packages, , ,xemacs}. |
545 | @ifhtml | |
16674e4f KG |
546 | (If the previous link doesn't work, try the @value{emacs-name} |
547 | documentation at | |
548 | @uref{http://www.xemacs.org/Documentation/packageGuide.html,the | |
549 | @value{emacs-name} site}.) | |
fb7933a3 | 550 | @end ifhtml |
16674e4f | 551 | @end ifset |
fb7933a3 KG |
552 | |
553 | @node Configuration | |
554 | @chapter Configuring @tramp{} for use | |
92eeeafc | 555 | @cindex configuration |
fb7933a3 | 556 | |
92eeeafc | 557 | @cindex default configuration |
fb7933a3 | 558 | @tramp{} is (normally) fully functional when it is initially |
16674e4f | 559 | installed. It is initially configured to use the @command{ssh} program |
92eeeafc KG |
560 | to connect to the remote host and to use base-64 encoding (on the |
561 | remote host, via @command{mimencode}, and on the local host via the | |
562 | built-in support for base-64 encoding in Emacs). | |
fb7933a3 KG |
563 | |
564 | On some hosts, there are problems with opening a connection. These are | |
565 | related to the behavior of the remote shell. See @xref{Remote shell | |
566 | setup}, for details on this. | |
567 | ||
92eeeafc KG |
568 | If you do not wish to use these commands to connect to the remote |
569 | host, you should change the default connection and transfer method | |
570 | that @tramp uses. There are several different methods that @tramp{} | |
571 | can use to connect to remote machines and transfer files | |
572 | (@pxref{Connection types}). | |
fb7933a3 KG |
573 | |
574 | ||
575 | @menu | |
576 | * Connection types:: Types of connections made to remote machines. | |
577 | * Inline methods:: Inline methods. | |
578 | * External transfer methods:: External transfer methods. | |
579 | * Multi-hop Methods:: Connecting to a remote host using multiple hops. | |
580 | * Default Method:: Selecting a default method. | |
581 | * Customizing Methods:: Using Non-Standard Methods. | |
16674e4f | 582 | * Customizing Completion:: Selecting config files for user/host name completion. |
fb7933a3 KG |
583 | * Remote Programs:: How @tramp{} finds and uses programs on the remote machine. |
584 | * Remote shell setup:: Remote shell setup hints. | |
585 | * Windows setup hints:: Issues with Cygwin ssh. | |
586 | @end menu | |
587 | ||
588 | ||
589 | @node Connection types | |
590 | @section Types of connections made to remote machines. | |
92eeeafc | 591 | @cindex connection types, overview |
fb7933a3 KG |
592 | |
593 | There are two basic types of transfer methods, each with its own | |
92eeeafc | 594 | advantages and limitations. Both types of connection make use of a |
fb7933a3 KG |
595 | remote shell access program such as @command{rsh}, @command{ssh} or |
596 | @command{telnet} to connect to the remote machine. | |
597 | ||
598 | This connection is used to perform many of the operations that @tramp | |
599 | requires to make the remote file system transparently accessible from | |
600 | the local machine. It is only when visiting files that the methods | |
601 | differ. | |
602 | ||
92eeeafc KG |
603 | @cindex inline methods |
604 | @cindex external transfer methods | |
605 | @cindex external methods | |
606 | @cindex out-of-band methods | |
607 | @cindex methods, inline | |
608 | @cindex methods, external transfer | |
609 | @cindex methods, out-of-band | |
610 | Loading or saving a remote file requires that the content of the file | |
16674e4f KG |
611 | be transfered between the two machines. The content of the file can be |
612 | transfered over the same connection used to log in to the remote | |
613 | machine or the file can be transfered through another connection using | |
92eeeafc KG |
614 | a remote copy program such as @command{rcp}, @command{scp} or |
615 | @command{rsync}. The former are called @dfn{inline methods}, the | |
616 | latter are called @dfn{out-of-band methods} or @dfn{external transfer | |
617 | methods} (@dfn{external methods} for short). | |
fb7933a3 KG |
618 | |
619 | The performance of the external transfer methods is generally better | |
92eeeafc KG |
620 | than that of the inline methods, at least for large files. This is |
621 | caused by the need to encode and decode the data when transferring | |
622 | inline. | |
fb7933a3 KG |
623 | |
624 | The one exception to this rule are the @command{scp} based transfer | |
625 | methods. While these methods do see better performance when actually | |
626 | transferring files, the overhead of the cryptographic negotiation at | |
627 | startup may drown out the improvement in file transfer times. | |
628 | ||
629 | External transfer methods do require that the remote copy command is not | |
630 | interactive --- that is, the command does not prompt you for a password. | |
631 | If you cannot perform remote copies without a password, you will need to | |
632 | use an inline transfer method to work with @tramp{}. | |
633 | ||
92eeeafc KG |
634 | @cindex multi-hop methods |
635 | @cindex methods, multi-hop | |
fb7933a3 KG |
636 | A variant of the inline methods are the @dfn{multi-hop methods}. |
637 | These methods allow you to connect a remote host using a number `hops', | |
638 | each of which connects to a different host. This is useful if you are | |
639 | in a secured network where you need to go through a bastion host to | |
640 | connect to the outside world. | |
641 | ||
642 | ||
643 | @node Inline methods | |
644 | @section Inline methods | |
92eeeafc KG |
645 | @cindex inline methods |
646 | @cindex methods, inline | |
fb7933a3 KG |
647 | |
648 | The inline methods in @tramp{} are quite powerful and can work in | |
649 | situations where you cannot use an external transfer program to connect. | |
650 | Inline methods are the only methods that work when connecting to the | |
651 | remote machine via telnet. (There are also strange inline methods which | |
652 | allow you to transfer files between @emph{user identities} rather than | |
653 | hosts, see below.) | |
654 | ||
655 | These methods depend on the existence of a suitable encoding and | |
92eeeafc | 656 | decoding command on remote machine. Locally, @tramp{} may be able to use |
fb7933a3 KG |
657 | features of Emacs to decode and encode the files or it may require |
658 | access to external commands to perform that task. | |
659 | ||
92eeeafc | 660 | @cindex uuencode |
92eeeafc KG |
661 | @cindex mimencode |
662 | @cindex base-64 encoding | |
f08d9f0e KG |
663 | @tramp{} checks the availability and usability of commands like |
664 | @command{mimencode} (part of the @command{metamail} package) or | |
665 | @command{uuencode} on the remote host. The first reliable command | |
666 | will be used. The search path can be customized, see @ref{Remote | |
667 | Programs}. | |
fb7933a3 | 668 | |
abc6be8d | 669 | If both commands aren't available on the remote host, @tramp{} |
f08d9f0e KG |
670 | transfers a small piece of Perl code to the remote host, and tries to |
671 | apply it for encoding and decoding. | |
fb7933a3 | 672 | |
fb7933a3 | 673 | |
f08d9f0e KG |
674 | @table @asis |
675 | @item @option{rsh} | |
676 | @cindex method rsh | |
677 | @cindex rsh method | |
fb7933a3 | 678 | |
f08d9f0e KG |
679 | Connect to the remote host with @command{rsh}. Due to the unsecure |
680 | connection it is recommended for very local host topology only. | |
fb7933a3 | 681 | |
fb7933a3 | 682 | |
f08d9f0e KG |
683 | @item @option{ssh} |
684 | @cindex method ssh | |
685 | @cindex ssh method | |
fb7933a3 | 686 | |
f08d9f0e KG |
687 | Connect to the remote host with @command{ssh}. This is identical to |
688 | the previous option except that the @command{ssh} package is used, | |
689 | making the connection more secure. | |
fb7933a3 | 690 | |
f08d9f0e KG |
691 | There are also two variants, @option{ssh1} and @option{ssh2}, that |
692 | call @samp{ssh -1} and @samp{ssh -2}, respectively. This way, you can | |
90dc758d KG |
693 | explicitly select whether you want to use the SSH protocol version 1 |
694 | or 2 to connect to the remote host. (You can also specify in | |
695 | @file{~/.ssh/config}, the SSH configuration file, which protocol | |
f08d9f0e | 696 | should be used, and use the regular @option{ssh} method.) |
90dc758d | 697 | |
f08d9f0e KG |
698 | Two other variants, @option{ssh1_old} and @option{ssh2_old}, use the |
699 | @command{ssh1} and @command{ssh2} commands explicitly. If you don't | |
700 | know what these are, you do not need these options. | |
fb7933a3 | 701 | |
16674e4f | 702 | All the methods based on @command{ssh} have an additional kludgy |
8e3a1104 KG |
703 | feature: you can specify a host name which looks like @file{host#42} |
704 | (the real host name, then a hash sign, then a port number). This | |
705 | means to connect to the given host but to also pass @code{-p 42} as | |
706 | arguments to the @command{ssh} command. | |
707 | ||
fb7933a3 | 708 | |
f08d9f0e KG |
709 | @item @option{telnet} |
710 | @cindex method telnet | |
711 | @cindex telnet method | |
fb7933a3 | 712 | |
f08d9f0e KG |
713 | Connect to the remote host with @command{telnet}. This is as unsecure |
714 | as the @option{rsh} method. | |
fb7933a3 | 715 | |
fb7933a3 | 716 | |
f08d9f0e | 717 | @item @option{su} |
92eeeafc KG |
718 | @cindex method su |
719 | @cindex su method | |
fb7933a3 | 720 | |
f08d9f0e KG |
721 | This method does not connect to a remote host at all, rather it uses |
722 | the @command{su} program to allow you to edit files as another user. | |
fb7933a3 | 723 | |
fb7933a3 | 724 | |
f08d9f0e KG |
725 | @item @option{sudo} |
726 | @cindex method sudo | |
727 | @cindex sudo method | |
fb7933a3 | 728 | |
f08d9f0e | 729 | This is similar to the @option{su} method, but it uses @command{sudo} |
fb7933a3 KG |
730 | rather than @command{su} to become a different user. |
731 | ||
732 | Note that @command{sudo} must be configured to allow you to start a | |
733 | shell as the user. It would be nice if it was sufficient if | |
f08d9f0e KG |
734 | @command{ls} and @command{mimencode} were allowed, but that is not |
735 | easy to implement, so I haven't got around to it, yet. | |
fb7933a3 | 736 | |
fb7933a3 | 737 | |
f08d9f0e KG |
738 | @item @option{sshx} |
739 | @cindex method sshx | |
740 | @cindex sshx method | |
741 | @cindex Cygwin (with sshx method) | |
fb7933a3 | 742 | |
f08d9f0e KG |
743 | As you expect, this is similar to @option{ssh}, only a little |
744 | different. Whereas @option{ssh} opens a normal interactive shell on | |
92eeeafc | 745 | the remote host, this option uses @samp{ssh -t -t @var{host} -l |
16674e4f | 746 | @var{user} /bin/sh} to open a connection. This is useful for users |
92eeeafc KG |
747 | where the normal login shell is set up to ask them a number of |
748 | questions when logging in. This procedure avoids these questions, and | |
749 | just gives @tramp{} a more-or-less `standard' login shell to work | |
750 | with. | |
fb7933a3 | 751 | |
83fa16cf KG |
752 | Note that this procedure does not eliminate questions asked by |
753 | @command{ssh} itself. For example, @command{ssh} might ask ``Are you | |
754 | sure you want to continue connecting?'' if the host key of the remote | |
abc6be8d | 755 | host is not known. @tramp{} does not know how to deal with such a |
83fa16cf KG |
756 | question (yet), therefore you will need to make sure that you can log |
757 | in without such questions. | |
758 | ||
fb7933a3 KG |
759 | This is also useful for Windows users where @command{ssh}, when |
760 | invoked from an Emacs buffer, tells them that it is not allocating a | |
761 | pseudo tty. When this happens, the login shell is wont to not print | |
92eeeafc KG |
762 | any shell prompt, which confuses @tramp{} mightily. For reasons |
763 | unknown, some Windows ports for @command{ssh} (maybe the Cygwin one) | |
764 | require the doubled @samp{-t} option. | |
fb7933a3 | 765 | |
92eeeafc | 766 | This supports the @samp{-p} kludge. |
8e3a1104 | 767 | |
fb7933a3 | 768 | |
f08d9f0e KG |
769 | @item @option{krlogin} |
770 | @cindex method krlogin | |
771 | @cindex km krlogin | |
772 | @cindex Kerberos (with krlogin method) | |
fb7933a3 | 773 | |
f08d9f0e | 774 | This method is also similar to @option{ssh}. It only uses the |
fb7933a3 KG |
775 | @command{krlogin -x} command to log in to the remote host. |
776 | ||
777 | ||
f08d9f0e KG |
778 | @item @option{plink} |
779 | @cindex method plink | |
780 | @cindex plink method | |
fb7933a3 KG |
781 | |
782 | This method is mostly interesting for Windows users using the PuTTY | |
92eeeafc | 783 | implementation of SSH. It uses @samp{plink -ssh} to log in to the |
fb7933a3 KG |
784 | remote host. |
785 | ||
786 | CCC: Do we have to connect to the remote host once from the command | |
787 | line to accept the SSH key? Maybe this can be made automatic? | |
788 | ||
abc6be8d KG |
789 | CCC: Does @command{plink} support the @samp{-p} option? @tramp{} will |
790 | support that, anyway. | |
8e3a1104 | 791 | |
92eeeafc | 792 | @end table |
fb7933a3 KG |
793 | |
794 | ||
795 | ||
796 | @node External transfer methods | |
797 | @section External transfer methods | |
92eeeafc KG |
798 | @cindex methods, external transfer |
799 | @cindex methods, out-of-band | |
800 | @cindex external transfer methods | |
801 | @cindex out-of-band methods | |
fb7933a3 KG |
802 | |
803 | The external transfer methods operate through multiple channels, using | |
804 | the remote shell connection for many actions while delegating file | |
805 | transfers to an external transfer utility. | |
806 | ||
807 | This saves the overhead of encoding and decoding that multiplexing the | |
808 | transfer through the one connection has with the inline methods. | |
809 | ||
810 | If you want to use an external transfer method you @emph{must} be able | |
811 | to execute the transfer utility to copy files to and from the remote | |
812 | machine without any interaction. | |
813 | ||
92eeeafc | 814 | @cindex ssh-agent |
fb7933a3 KG |
815 | This means that you will need to use @command{ssh-agent} if you use the |
816 | @command{scp} program for transfers, or maybe your version of | |
817 | @command{scp} accepts a password on the command line.@footnote{PuTTY's | |
818 | @command{pscp} allows you to specify the password on the command line.} | |
819 | If you use @command{rsync} via @command{ssh} then the same rule must | |
820 | apply to that connection. | |
821 | ||
822 | If you cannot get @command{scp} to run without asking for a password but | |
823 | would still like to use @command{ssh} to secure your connection, have a | |
824 | look at the @command{ssh} based inline methods. | |
825 | ||
826 | ||
92eeeafc | 827 | @table @asis |
fb7933a3 | 828 | @item @option{rcp} --- @command{rsh} and @command{rcp} |
92eeeafc KG |
829 | @cindex method rcp |
830 | @cindex rcp method | |
e28e4d20 KG |
831 | @cindex rcp (with rcp method) |
832 | @cindex rsh (with rcp method) | |
fb7933a3 KG |
833 | |
834 | This method uses the @command{rsh} and @command{rcp} commands to connect | |
835 | to the remote machine and transfer files. This is probably the fastest | |
836 | connection method available. | |
837 | ||
838 | ||
839 | @item @option{scp} --- @command{ssh} and @command{scp} | |
92eeeafc KG |
840 | @cindex method scp |
841 | @cindex scp method | |
e28e4d20 KG |
842 | @cindex scp (with scp method) |
843 | @cindex ssh (with scp method) | |
fb7933a3 KG |
844 | |
845 | Using @command{ssh} to connect to the remote host and @command{scp} to | |
846 | transfer files between the machines is the best method for securely | |
847 | connecting to a remote machine and accessing files. | |
848 | ||
849 | The performance of this option is also quite good. It may be slower than | |
850 | the inline methods when you often open and close small files however. | |
851 | The cost of the cryptographic handshake at the start of an @command{scp} | |
852 | session can begin to absorb the advantage that the lack of encoding and | |
853 | decoding presents. | |
854 | ||
f08d9f0e KG |
855 | There are also two variants, @option{scp1} and @option{scp2}, that |
856 | call @samp{ssh -1} and @samp{ssh -2}, respectively. This way, you can | |
857 | explicitly select whether you want to use the SSH protocol version 1 | |
858 | or 2 to connect to the remote host. (You can also specify in | |
859 | @file{~/.ssh/config}, the SSH configuration file, which protocol | |
860 | should be used, and use the regular @option{ssh} method.) | |
861 | ||
862 | Two other variants, @option{scp1_old} and @option{scp2_old}, use the | |
863 | @command{ssh1} and @command{ssh2} commands explicitly. If you don't | |
864 | know what these are, you do not need these options. | |
865 | ||
16674e4f | 866 | All the @command{ssh} based methods support the kludgy @samp{-p} |
8e3a1104 | 867 | feature where you can specify a port number to connect to in the host |
abc6be8d | 868 | name. For example, the host name @file{host#42} tells @tramp{} to |
92eeeafc | 869 | specify @samp{-p 42} in the argument list for @command{ssh}. |
8e3a1104 | 870 | |
fb7933a3 KG |
871 | |
872 | @item @option{rsync} --- @command{ssh} and @command{rsync} | |
92eeeafc KG |
873 | @cindex method rsync |
874 | @cindex rsync method | |
e28e4d20 KG |
875 | @cindex rsync (with rsync method) |
876 | @cindex ssh (with rsync method) | |
fb7933a3 KG |
877 | |
878 | Using the @command{ssh} command to connect securely to the remote | |
879 | machine and the @command{rsync} command to transfer files is almost | |
880 | identical to the @option{scp} method. | |
881 | ||
882 | While @command{rsync} performs much better than @command{scp} when | |
883 | transferring files that exist on both hosts, this advantage is lost if | |
884 | the file exists only on one side of the connection. | |
885 | ||
886 | The @command{rsync} based method may be considerably faster than the | |
887 | @command{rcp} based methods when writing to the remote system. Reading | |
abc6be8d | 888 | files to the local machine is no faster than with a direct copy. |
fb7933a3 | 889 | |
92eeeafc | 890 | This method supports the @samp{-p} hack. |
8e3a1104 | 891 | |
fb7933a3 KG |
892 | |
893 | @item @option{scpx} --- @command{ssh} and @command{scp} | |
92eeeafc KG |
894 | @cindex method scpx |
895 | @cindex scpx method | |
e28e4d20 KG |
896 | @cindex scp (with scpx method) |
897 | @cindex ssh (with scpx method) | |
898 | @cindex Cygwin (with scpx method) | |
fb7933a3 KG |
899 | |
900 | As you expect, this is similar to @option{scp}, only a little | |
92eeeafc KG |
901 | different. Whereas @option{scp} opens a normal interactive shell on |
902 | the remote host, this option uses @samp{ssh -t -t @var{host} -l | |
903 | @var{user} /bin/sh} to open a connection. This is useful for users | |
904 | where the normal login shell is set up to ask them a number of | |
905 | questions when logging in. This procedure avoids these questions, and | |
906 | just gives @tramp{} a more-or-less `standard' login shell to work | |
907 | with. | |
fb7933a3 KG |
908 | |
909 | This is also useful for Windows users where @command{ssh}, when | |
910 | invoked from an Emacs buffer, tells them that it is not allocating a | |
911 | pseudo tty. When this happens, the login shell is wont to not print | |
92eeeafc KG |
912 | any shell prompt, which confuses @tramp{} mightily. Maybe this |
913 | applies to the Cygwin port of SSH. | |
fb7933a3 | 914 | |
92eeeafc | 915 | This method supports the @samp{-p} hack. |
8e3a1104 | 916 | |
fb7933a3 KG |
917 | |
918 | @item @option{pscp} --- @command{plink} and @command{pscp} | |
92eeeafc KG |
919 | @cindex method pscp |
920 | @cindex pscp method | |
e28e4d20 KG |
921 | @cindex pscp (with pscp method) |
922 | @cindex plink (with pscp method) | |
923 | @cindex PuTTY (with pscp method) | |
fb7933a3 KG |
924 | |
925 | This method is similar to @option{scp}, but it uses the | |
926 | @command{plink} command to connect to the remote host, and it uses | |
927 | @command{pscp} for transferring the files. These programs are part | |
928 | of PuTTY, an SSH implementation for Windows. | |
929 | ||
92eeeafc | 930 | CCC: Does @command{plink} support the @samp{-p} hack? |
8e3a1104 | 931 | |
fb7933a3 KG |
932 | |
933 | @item @option{fcp} --- @command{fsh} and @command{fcp} | |
92eeeafc KG |
934 | @cindex method fcp |
935 | @cindex fcp method | |
e28e4d20 KG |
936 | @cindex fsh (with fcp method) |
937 | @cindex fcp (with fcp method) | |
fb7933a3 KG |
938 | |
939 | This method is similar to @option{scp}, but it uses the @command{fsh} | |
940 | command to connect to the remote host, and it uses @command{fcp} for | |
941 | transferring the files. @command{fsh/fcp} are a front-end for | |
942 | @command{ssh} which allow for reusing the same @command{ssh} session | |
943 | for submitting several commands. This avoids the startup overhead of | |
944 | @command{scp} (which has to establish a secure connection whenever it | |
945 | is called). Note, however, that you can also use one of the inline | |
946 | methods to achieve a similar effect. | |
947 | ||
92eeeafc KG |
948 | This method uses the command @samp{fsh @var{host} -l @var{user} |
949 | /bin/sh -i} to establish the connection, it does not work to just say | |
950 | @command{fsh @var{host} -l @var{user}}. | |
fb7933a3 | 951 | |
e28e4d20 KG |
952 | @cindex method fsh |
953 | @cindex fsh method | |
92eeeafc KG |
954 | There is no inline method using @command{fsh} as the multiplexing |
955 | provided by the program is not very useful in our context. @tramp{} | |
956 | opens just one connection to the remote host and then keeps it open, | |
957 | anyway. | |
958 | ||
f08d9f0e KG |
959 | |
960 | @ifset emacs | |
961 | @item @option{ftp} | |
962 | @cindex method ftp | |
963 | @cindex ftp method | |
964 | ||
abc6be8d | 965 | This is not a native @tramp{} method. Instead of, it forwards all |
f08d9f0e KG |
966 | requests to @value{ftp-package-name}. |
967 | @end ifset | |
968 | ||
abc6be8d KG |
969 | |
970 | @item @option{smb} --- @command{smbclient} | |
971 | @cindex method smb | |
972 | @cindex smb method | |
973 | ||
974 | This is another not natural @tramp{} method. It uses the | |
975 | @command{smbclient} command on different Unices in order to connect to | |
976 | an SMB server. An SMB server might be a Samba (or CIFS) server on | |
977 | another UNIX host or, more interesting, a host running MS Windows. So | |
978 | far, it is tested towards MS Windows NT, MS Windows 2000, and MS | |
979 | Windows XP. | |
980 | ||
981 | The first directory in the path must be a share name on the remote | |
982 | host. Remember, that the @code{$} character in which default shares | |
983 | usually end, must be written @code{$$} due to environment variable | |
984 | substitution in file names. If no share name is given (i.e. remote | |
985 | directory @code{/}), all available shares are listed. | |
986 | ||
987 | Since authorization is done on share level, you will be prompted | |
988 | always for a password if you access another share on the same host. | |
989 | Due to security reasons, the password is not cached. | |
990 | ||
991 | MS Windows uses for authorization both a user name and a domain name. | |
992 | Because of this, the @tramp{} syntax has been extended: you can | |
993 | specify a user name which looks like @code{user%domain} (the real user | |
994 | name, then a percent sign, then the domain name). So, to connect to | |
995 | the machine @code{melancholia} as user @code{daniel} of the domain | |
996 | @code{BIZARRE}, and edit @file{.emacs} in the home directory (share | |
997 | @code{daniel$}) I would specify the filename | |
998 | @file{@value{tramp-prefix}smb@value{tramp-postfix-single-hop}daniel%BIZARRE@@melancholia@value{tramp-postfix}/daniel$$/.emacs}. | |
999 | ||
1000 | The domain name as well as the user name are optional. If no user | |
1001 | name is specified at all, the anonymous user (without password | |
1002 | prompting) is assumed. This is different from all other @tramp{} | |
1003 | methods, where in such a case the local user name is taken. | |
1004 | ||
1005 | The @option{smb} method supports the @samp{-p} hack. | |
1006 | ||
1007 | @strong{Please note:} If Emacs runs locally under MS Windows, this | |
1008 | method isn't available. Instead of, you can use UNC file names like | |
1009 | @file{//melancholia/daniel$$/.emacs}. The only disadvantage is that | |
1010 | there's no possiblity to specify another user name. | |
1011 | ||
92eeeafc | 1012 | @end table |
fb7933a3 KG |
1013 | |
1014 | @node Multi-hop Methods | |
1015 | @section Connecting to a remote host using multiple hops | |
92eeeafc KG |
1016 | @cindex multi-hop methods |
1017 | @cindex methods, multi-hop | |
fb7933a3 KG |
1018 | |
1019 | Sometimes, the methods described before are not sufficient. Sometimes, | |
1020 | it is not possible to connect to a remote host using a simple command. | |
1021 | For example, if you are in a secured network, you might have to log in | |
1022 | to a `bastion host' first before you can connect to the outside world. | |
1023 | Of course, the target host may also require a bastion host. The format | |
1024 | of multi-hop filenames is slightly different than the format of normal | |
1025 | @tramp{} methods. | |
1026 | ||
92eeeafc KG |
1027 | @cindex method multi |
1028 | @cindex multi method | |
f08d9f0e KG |
1029 | A multi-hop file name specifies a method, a number of hops, and a path |
1030 | name on the remote system. The method name is always | |
1031 | @option{multi}. | |
fb7933a3 | 1032 | |
f08d9f0e KG |
1033 | Each hop consists of a @dfn{hop method} specification, a user name and |
1034 | a host name. The hop method can be an inline method only. The | |
1035 | following hop methods are (currently) available: | |
fb7933a3 | 1036 | |
92eeeafc KG |
1037 | @table @option |
1038 | @item telnet | |
1039 | @cindex hop method telnet | |
1040 | @cindex telnet hop method | |
fb7933a3 KG |
1041 | |
1042 | Uses the well-known @command{telnet} program to connect to the host. | |
1043 | Whereas user name and host name are supplied in the file name, the | |
1044 | user is queried for the password. | |
1045 | ||
92eeeafc KG |
1046 | @item rsh |
1047 | @cindex hop method rsh | |
1048 | @cindex rsh hop method | |
fb7933a3 KG |
1049 | |
1050 | This uses @command{rsh} to connect to the host. You do not need to | |
1051 | enter a password unless @command{rsh} explicitly asks for it. | |
1052 | ||
92eeeafc KG |
1053 | @item ssh |
1054 | @cindex hop method ssh | |
1055 | @cindex ssh hop method | |
fb7933a3 KG |
1056 | |
1057 | This uses @command{ssh} to connect to the host. You might have to enter | |
1058 | a password or a pass phrase. | |
1059 | ||
92eeeafc KG |
1060 | @item su |
1061 | @cindex hop method su | |
1062 | @cindex su hop method | |
fb7933a3 KG |
1063 | |
1064 | This method does not actually contact a different host, but it allows | |
1065 | you to become a different user on the host you're currently on. This | |
1066 | might be useful if you want to edit files as root, but the remote host | |
1067 | does not allow remote root logins. In this case you can use | |
1068 | @option{telnet}, @option{rsh} or @option{ssh} to connect to the | |
1069 | remote host as a non-root user, then use an @option{su} hop to become | |
1070 | root. But @option{su} need not be the last hop in a sequence, you could | |
1071 | also use it somewhere in the middle, if the need arises. | |
1072 | ||
f08d9f0e | 1073 | Even though you @emph{must} specify both user and host with an |
fb7933a3 KG |
1074 | @option{su} hop, the host name is ignored and only the user name is |
1075 | used. | |
1076 | ||
92eeeafc KG |
1077 | @item sudo |
1078 | @cindex hop method sudo | |
1079 | @cindex sudo hop method | |
fb7933a3 KG |
1080 | |
1081 | This is similar to the @option{su} hop, except that it uses | |
1082 | @command{sudo} rather than @command{su} to become a different user. | |
1083 | ||
92eeeafc | 1084 | @end table |
fb7933a3 | 1085 | |
92eeeafc KG |
1086 | Some people might wish to use port forwarding with @command{ssh} or |
1087 | maybe they have to use a nonstandard port. This can be accomplished | |
1088 | by putting a stanza in @file{~/.ssh/config} for the account which | |
1089 | specifies a different port number for a certain host name. But it can | |
f08d9f0e KG |
1090 | also be accomplished within @tramp{}, by adding a multi-hop method. |
1091 | For example: | |
fb7933a3 KG |
1092 | |
1093 | @lisp | |
16674e4f KG |
1094 | (add-to-list |
1095 | 'tramp-multi-connection-function-alist | |
1096 | '("sshf" tramp-multi-connect-rlogin "ssh %h -l %u -p 4400%n")) | |
fb7933a3 KG |
1097 | @end lisp |
1098 | ||
16674e4f | 1099 | Now you can use an @code{sshf} hop which connects to port 4400 instead of |
fb7933a3 KG |
1100 | the standard port. |
1101 | ||
1102 | ||
1103 | @node Default Method | |
1104 | @section Selecting a default method | |
92eeeafc | 1105 | @cindex default method |
fb7933a3 | 1106 | |
92eeeafc | 1107 | @vindex tramp-default-method |
fb7933a3 KG |
1108 | When you select an appropriate transfer method for your typical usage |
1109 | you should set the variable @var{tramp-default-method} to reflect that | |
92eeeafc | 1110 | choice. This variable controls which method will be used when a method |
fb7933a3 KG |
1111 | is not specified in the @tramp{} file path. For example: |
1112 | ||
1113 | @lisp | |
1114 | (setq tramp-default-method "scp") | |
1115 | @end lisp | |
1116 | ||
92eeeafc KG |
1117 | @vindex tramp-default-method-alist |
1118 | You can also specify different methods for certain user/host | |
1119 | combinations, via the variable @var{tramp-default-method-alist}. For | |
f08d9f0e | 1120 | example, the following two lines specify to use the @option{ssh} |
92eeeafc KG |
1121 | method for all user names matching @samp{john} and the @option{rsync} |
1122 | method for all host names matching @samp{lily}. The third line | |
f08d9f0e | 1123 | specifies to use the @option{su} method for the user @samp{root} on |
92eeeafc KG |
1124 | the machine @samp{localhost}. |
1125 | ||
1126 | @lisp | |
f08d9f0e | 1127 | (add-to-list 'tramp-default-method-alist '("" "john" "ssh")) |
92eeeafc KG |
1128 | (add-to-list 'tramp-default-method-alist '("lily" "" "rsync")) |
1129 | (add-to-list 'tramp-default-method-alist | |
f08d9f0e | 1130 | '("\\`localhost\\'" "\\`root\\'" "su")) |
92eeeafc KG |
1131 | @end lisp |
1132 | ||
1133 | @noindent | |
1134 | See the documentation for the variable | |
1135 | @var{tramp-default-method-alist} for more details. | |
1136 | ||
fb7933a3 KG |
1137 | External transfer methods are normally preferable to inline transfer |
1138 | methods, giving better performance. They may not be useful if you use | |
1139 | many remote machines where you cannot log in without a password. | |
1140 | ||
1141 | @xref{Inline methods}. | |
1142 | @xref{External transfer methods}. | |
1143 | @xref{Multi-hop Methods}. | |
1144 | ||
1145 | Another consideration with the selection of transfer methods is the | |
1146 | environment you will use them in and, especially when used over the | |
1147 | Internet, the security implications of your preferred method. | |
1148 | ||
1149 | The @command{rsh} and @command{telnet} methods send your password as | |
1150 | plain text as you log in to the remote machine, as well as transferring | |
1151 | the files in such a way that the content can easily be read from other | |
1152 | machines. | |
1153 | ||
1154 | If you need to connect to remote systems that are accessible from the | |
1155 | Internet, you should give serious thought to using @command{ssh} based | |
1156 | methods to connect. These provide a much higher level of security, | |
1157 | making it a non-trivial exercise for someone to obtain your password or | |
1158 | read the content of the files you are editing. | |
1159 | ||
1160 | @node Customizing Methods | |
1161 | @section Using Non-Standard Methods | |
92eeeafc KG |
1162 | @cindex customizing methods |
1163 | @cindex using non-standard methods | |
1164 | @cindex create your own methods | |
fb7933a3 KG |
1165 | |
1166 | There is a variable @code{tramp-methods} which you can change if the | |
1167 | predefined methods don't seem right. | |
1168 | ||
1169 | For the time being, I'll refer you to the Lisp documentation of that | |
1170 | variable, accessible with @kbd{C-h v tramp-methods @key{RET}}. | |
1171 | ||
1172 | ||
16674e4f KG |
1173 | @node Customizing Completion |
1174 | @section Selecting config files for user/host name completion | |
1175 | @cindex customizing completion | |
1176 | @cindex selecting config files | |
1177 | @vindex tramp-completion-function-alist | |
1178 | ||
1179 | The variable @code{tramp-completion-function-alist} is intended to | |
abc6be8d | 1180 | customize which files are taken into account for user and host name |
16674e4f KG |
1181 | completion (@pxref{Filename completion}). For every method, it keeps |
1182 | a set of configuration files, accompanied by a Lisp function able to | |
1183 | parse that file. Entries in @code{tramp-completion-function-alist} | |
1184 | have the form (@var{method} @var{pair1} @var{pair2} ...). | |
1185 | ||
1186 | Each @var{pair} is composed of (@var{function} @var{file}). | |
1187 | @var{function} is responsible to extract user names and host names | |
1188 | from @var{file} for completion. There are two functions which access | |
1189 | this variable: | |
1190 | ||
1191 | @defun tramp-get-completion-function method | |
1192 | This function returns the list of completion functions for @var{method}. | |
1193 | ||
1194 | Example: | |
1195 | @example | |
1196 | (tramp-get-completion-function "rsh") | |
1197 | ||
1198 | @result{} ((tramp-parse-rhosts "/etc/hosts.equiv") | |
1199 | (tramp-parse-rhosts "~/.rhosts")) | |
1200 | @end example | |
1201 | @end defun | |
1202 | ||
1203 | @defun tramp-set-completion-function method function-list | |
1204 | This function sets @var{function-list} as list of completion functions | |
177c0ea7 | 1205 | for @var{method}. |
16674e4f KG |
1206 | |
1207 | Example: | |
1208 | @example | |
1209 | (tramp-set-completion-function "ssh" | |
1210 | '((tramp-parse-shosts "/etc/ssh_known_hosts") | |
1211 | (tramp-parse-shosts "~/.ssh/known_hosts"))) | |
1212 | ||
1213 | @result{} ((tramp-parse-shosts "/etc/ssh_known_hosts") | |
1214 | (tramp-parse-shosts "~/.ssh/known_hosts")) | |
1215 | @end example | |
1216 | @end defun | |
1217 | ||
1218 | The following predefined functions parsing configuration files exists: | |
1219 | ||
1220 | @table @asis | |
1221 | @item @code{tramp-parse-rhosts} | |
1222 | @findex tramp-parse-rhosts | |
1223 | ||
1224 | This function parses files which are syntactical equivalent to | |
1225 | @file{~/.rhosts}. It returns both host names and user names, if | |
1226 | specified. | |
1227 | ||
1228 | @item @code{tramp-parse-shosts} | |
1229 | @findex tramp-parse-shosts | |
1230 | ||
1231 | This function parses files which are syntactical equivalent to | |
1232 | @file{/etc/ssh_known_hosts}. Since there are no user names specified | |
1233 | in such files, it can return host names only. | |
1234 | ||
1235 | @item @code{tramp-parse-hosts} | |
1236 | @findex tramp-parse-hosts | |
1237 | ||
1238 | A function dedicated to @file{/etc/hosts} style files. It returns | |
1239 | host names only. | |
1240 | ||
1241 | @item @code{tramp-parse-passwd} | |
1242 | @findex tramp-parse-passwd | |
1243 | ||
292ffc15 KG |
1244 | A function which parses @file{/etc/passwd} like files. Obviously, it |
1245 | can return user names only. | |
16674e4f | 1246 | |
292ffc15 KG |
1247 | @item @code{tramp-parse-netrc} |
1248 | @findex tramp-parse-netrc | |
1249 | ||
1250 | Finally, a function which parses @file{~/.netrc} like files. | |
1251 | @end table | |
16674e4f KG |
1252 | |
1253 | If you want to keep your own data in a file, with your own structure, | |
1254 | you might provide such a function as well. This function must meet | |
1255 | the following conventions: | |
1256 | ||
1257 | @defun my-tramp-parse file | |
1258 | @var{file} must be either a file name on your host, or @code{nil}. The | |
1259 | function must return a list of (@var{user} @var{host}), which are | |
1260 | taken as candidates for user and host name completion. | |
1261 | ||
1262 | Example: | |
1263 | @example | |
1264 | (my-tramp-parse "~/.my-tramp-hosts") | |
1265 | ||
1266 | @result{} ((nil "toto") ("daniel" "melancholia")) | |
1267 | @end example | |
1268 | @end defun | |
1269 | ||
1270 | ||
fb7933a3 KG |
1271 | @node Remote Programs |
1272 | @section How @tramp{} finds and uses programs on the remote machine. | |
1273 | ||
1274 | @tramp{} depends on a number of programs on the remote host in order to | |
1275 | function, including @command{ls}, @command{test}, @command{find} and | |
1276 | @command{cat}. | |
1277 | ||
1278 | In addition to these required tools, there are various tools that may be | |
1279 | required based on the connection method. See @ref{Inline methods} and | |
1280 | @ref{External transfer methods} for details on these. | |
1281 | ||
1282 | Certain other tools, such as @command{perl} (or @command{perl5}) and | |
1283 | @command{grep} will be used if they can be found. When they are | |
1284 | available, they are used to improve the performance and accuracy of | |
1285 | remote file access. | |
1286 | ||
92eeeafc | 1287 | @vindex tramp-remote-path |
fb7933a3 KG |
1288 | When @tramp{} connects to the remote machine, it searches for the |
1289 | programs that it can use. The variable @var{tramp-remote-path} controls | |
1290 | the directories searched on the remote machine. | |
1291 | ||
1292 | By default, this is set to a reasonable set of defaults for most | |
1293 | machines. It is possible, however, that your local (or remote ;) system | |
1294 | administrator has put the tools you want in some obscure local | |
1295 | directory. | |
1296 | ||
1297 | In this case, you can still use them with @tramp{}. You simply need to | |
1298 | add code to your @file{.emacs} to add the directory to the remote path. | |
1299 | This will then be searched by @tramp{} when you connect and the software | |
1300 | found. | |
1301 | ||
1302 | To add a directory to the remote search path, you could use code such | |
1303 | as: | |
1304 | ||
16674e4f KG |
1305 | @lisp |
1306 | @i{;; We load @tramp{} to define the variable.} | |
1307 | (require 'tramp) | |
1308 | @i{;; We have @command{perl} in "/usr/local/perl/bin"} | |
92eeeafc | 1309 | (add-to-list 'tramp-remote-path "/usr/local/perl/bin") |
16674e4f KG |
1310 | @end lisp |
1311 | ||
fb7933a3 KG |
1312 | |
1313 | @node Remote shell setup | |
1314 | @comment node-name, next, previous, up | |
1315 | @section Remote shell setup hints | |
92eeeafc | 1316 | @cindex remote shell setup |
e28e4d20 KG |
1317 | @cindex @file{.profile} file |
1318 | @cindex @file{.login} file | |
92eeeafc | 1319 | @cindex shell init files |
fb7933a3 KG |
1320 | |
1321 | As explained in the @ref{Overview} section, @tramp{} connects to the | |
1322 | remote host and talks to the shell it finds there. Of course, when you | |
1323 | log in, the shell executes its init files. Suppose your init file | |
16674e4f | 1324 | requires you to enter the birth date of your mother; clearly @tramp{} |
fb7933a3 KG |
1325 | does not know this and hence fails to log you in to that host. |
1326 | ||
1327 | There are different possible strategies for pursuing this problem. One | |
1328 | strategy is to enable @tramp{} to deal with all possible situations. | |
1329 | This is a losing battle, since it is not possible to deal with | |
1330 | @emph{all} situations. The other strategy is to require you to set up | |
1331 | the remote host such that it behaves like @tramp{} expect. This might | |
1332 | be inconvenient because you have to invest a lot of effort into shell | |
1333 | setup before you can begin to use @tramp{}. | |
1334 | ||
1335 | The package, therefore, pursues a combined approach. It tries to figure | |
1336 | out some of the more common setups, and only requires you to avoid | |
1337 | really exotic stuff. For example, it looks through a list of | |
1338 | directories to find some programs on the remote host. And also, it | |
abc6be8d | 1339 | knows that it is not obvious how to check whether a file exists, and |
fb7933a3 KG |
1340 | therefore it tries different possibilities. (On some hosts and shells, |
1341 | the command @code{test -e} does the trick, on some hosts the shell | |
1342 | builtin doesn't work but the program @code{/usr/bin/test -e} or | |
1343 | @code{/bin/test -e} works. And on still other hosts, @code{ls -d} is | |
1344 | the right way to do this.) | |
1345 | ||
1346 | Below you find a discussion of a few things that @tramp{} does not deal | |
1347 | with, and that you therefore have to set up correctly. | |
1348 | ||
92eeeafc KG |
1349 | @table @asis |
1350 | @item @var{shell-prompt-pattern} | |
fb7933a3 | 1351 | @vindex shell-prompt-pattern |
92eeeafc | 1352 | |
fb7933a3 KG |
1353 | After logging in to the remote host, @tramp{} has to wait for the remote |
1354 | shell startup to finish before it can send commands to the remote | |
1355 | shell. The strategy here is to wait for the shell prompt. In order to | |
1356 | recognize the shell prompt, the variable @code{shell-prompt-pattern} has | |
1357 | to be set correctly to recognize the shell prompt on the remote host. | |
1358 | ||
abc6be8d KG |
1359 | Note that @tramp{} requires the match for @code{shell-prompt-pattern} |
1360 | to be at the end of the buffer. Many people have something like the | |
83fa16cf | 1361 | following as the value for the variable: @code{"^[^>$][>$] *"}. Now |
abc6be8d KG |
1362 | suppose your shell prompt is @code{a <b> c $ }. In this case, |
1363 | @tramp{} recognizes the @code{>} character as the end of the prompt, | |
1364 | but it is not at the end of the buffer. | |
83fa16cf | 1365 | |
16674e4f KG |
1366 | @item @var{tramp-shell-prompt-pattern} |
1367 | @vindex tramp-shell-prompt-pattern | |
1368 | ||
1369 | This regular expression is used by @tramp{} in the same way as | |
1370 | @code{shell-prompt-pattern}, to match prompts from the remote shell. | |
1371 | This second variable exists because the prompt from the remote shell | |
1372 | might be different from the prompt from a local shell --- after all, | |
1373 | the whole point of @tramp{} is to log in to remote hosts as a | |
1374 | different user. The default value of | |
1375 | @code{tramp-shell-prompt-pattern} is the same as the default value of | |
1376 | @code{shell-prompt-pattern}, which is reported to work well in many | |
1377 | circumstances. | |
1378 | ||
fb7933a3 | 1379 | @item @code{tset} and other questions |
92eeeafc KG |
1380 | @cindex Unix command tset |
1381 | @cindex tset Unix command | |
fb7933a3 KG |
1382 | |
1383 | Some people invoke the @code{tset} program from their shell startup | |
16674e4f KG |
1384 | scripts which asks the user about the terminal type of the shell. |
1385 | Maybe some shells ask other questions when they are started. @tramp{} | |
1386 | does not know how to answer these questions. There are two approaches | |
1387 | for dealing with this problem. One approach is to take care that the | |
1388 | shell does not ask any questions when invoked from @tramp{}. You can | |
1389 | do this by checking the @code{TERM} environment variable, it will be | |
1390 | set to @code{dumb} when connecting. | |
fb7933a3 KG |
1391 | |
1392 | @vindex tramp-terminal-type | |
1393 | The variable @code{tramp-terminal-type} can be used to change this value | |
16674e4f KG |
1394 | to @code{dumb}. |
1395 | ||
1396 | The other approach is to teach @tramp{} about these questions. See | |
1397 | the variables @code{tramp-actions-before-shell} and | |
1398 | @code{tramp-multi-actions} (for multi-hop connections). | |
fb7933a3 | 1399 | |
92eeeafc | 1400 | @end table |
fb7933a3 KG |
1401 | |
1402 | ||
1403 | @node Windows setup hints | |
1404 | @section Issues with Cygwin ssh | |
e28e4d20 | 1405 | @cindex Cygwin, issues |
fb7933a3 KG |
1406 | |
1407 | This section needs a lot of work! Please help. | |
1408 | ||
abc6be8d KG |
1409 | @cindex method sshx with Cygwin |
1410 | @cindex sshx method with Cygwin | |
fb7933a3 KG |
1411 | If you use the Cygwin installation of ssh (you have to explicitly select |
1412 | it in the installer), then it should work out of the box to just select | |
abc6be8d | 1413 | @code{sshx} as the connection method. You can find information about |
fb7933a3 KG |
1414 | setting up Cygwin in their FAQ at @uref{http://cygwin.com/faq/}. |
1415 | ||
abc6be8d KG |
1416 | @cindex method scpx with Cygwin |
1417 | @cindex scpx method with Cygwin | |
1418 | If you wish to use the @code{scpx} connection method, then you might | |
1419 | have the problem that Emacs calls @code{scp} with a Windows filename | |
1420 | such as @code{c:/foo}. The Cygwin version of @code{scp} does not know | |
1421 | about Windows filenames and interprets this as a remote filename on the | |
1422 | host @code{c}. | |
1423 | ||
1424 | One possible workaround is to write a wrapper script for @code{scp} | |
1425 | which converts the Windows filename to a Cygwinized filename. | |
1426 | ||
1427 | I guess that another workaround is to run Emacs under Cygwin, or to run | |
1428 | a Cygwinized Emacs. | |
1429 | ||
1430 | @cindex Cygwin and ssh-agent | |
1431 | @cindex SSH_AUTH_SOCK and Emacs on Windows | |
1432 | If you want to use either @code{ssh} based method on Windows, then you | |
1433 | might encounter problems with @code{ssh-agent}. Using this program, | |
1434 | you can avoid typing the pass-phrase every time you log in (and the | |
1435 | @code{scpx} method more or less requires you to use @code{ssh-agent} | |
1436 | because it does not allow you to type a password or pass-phrase). | |
1437 | However, if you start Emacs from a desktop shortcut, then the | |
1438 | environment variable @code{SSH_AUTH_SOCK} is not set and so Emacs and | |
1439 | thus @tramp{} and thus @code{ssh} and @code{scp} started from @tramp{} | |
1440 | cannot communicate with @code{ssh-agent}. It works better to start | |
1441 | Emacs from the shell. | |
1442 | ||
1443 | If anyone knows how to start @code{ssh-agent} under Windows in such a | |
1444 | way that desktop shortcuts can profit, please holler. I don't really | |
1445 | know anything at all about Windows@dots{} | |
1446 | ||
fb7933a3 KG |
1447 | |
1448 | @node Usage | |
1449 | @chapter Using @tramp | |
92eeeafc | 1450 | @cindex using @tramp |
fb7933a3 KG |
1451 | |
1452 | Once you have installed @tramp{} it will operate fairly transparently. You | |
1453 | will be able to access files on any remote machine that you can log in | |
1454 | to as though they were local. | |
1455 | ||
1456 | Files are specified to @tramp{} using a formalized syntax specifying the | |
92eeeafc | 1457 | details of the system to connect to. This is similar to the syntax used |
16674e4f KG |
1458 | by the @value{ftp-package-name} package. |
1459 | ||
1460 | @cindex type-ahead | |
1461 | Something that might happen which surprises you is that Emacs | |
1462 | remembers all your keystrokes, so if you see a password prompt from | |
1463 | Emacs, say, and hit @kbd{@key{RET}} twice instead of once, then the | |
1464 | second keystroke will be processed by Emacs after @tramp{} has done | |
1465 | its thing. Why, this type-ahead is normal behavior, you say. Right | |
1466 | you are, but be aware that opening a remote file might take quite a | |
1467 | while, maybe half a minute when a connection needs to be opened. | |
1468 | Maybe after half a minute you have already forgotten that you hit that | |
1469 | key! | |
fb7933a3 KG |
1470 | |
1471 | @menu | |
1472 | * Filename Syntax:: @tramp{} filename conventions. | |
16674e4f KG |
1473 | * Multi-hop filename syntax:: Multi-hop filename conventions. |
1474 | * Filename completion:: Filename completion. | |
1475 | * Dired:: Dired. | |
fb7933a3 KG |
1476 | @end menu |
1477 | ||
1478 | ||
1479 | @node Filename Syntax | |
1480 | @section @tramp{} filename conventions | |
92eeeafc KG |
1481 | @cindex filename syntax |
1482 | @cindex filename examples | |
fb7933a3 | 1483 | |
16674e4f KG |
1484 | To access the file @var{path} on the remote machine @var{machine} you |
1485 | would specify the filename | |
1486 | @file{@value{tramp-prefix}@var{machine}@value{tramp-postfix}@var{path}}. | |
1487 | This will connect to @var{machine} and transfer the file using the | |
1488 | default method. @xref{Default Method}. | |
fb7933a3 | 1489 | |
16674e4f | 1490 | Some examples of @tramp{} filenames are shown below. |
fb7933a3 KG |
1491 | |
1492 | @table @file | |
16674e4f | 1493 | @item @value{tramp-prefix}melancholia@value{tramp-postfix}.emacs |
fb7933a3 KG |
1494 | Edit the file @file{.emacs} in your home directory on the machine |
1495 | @code{melancholia}. | |
1496 | ||
16674e4f | 1497 | @item @value{tramp-prefix}melancholia.danann.net@value{tramp-postfix}.emacs |
fb7933a3 KG |
1498 | This edits the same file, using the fully qualified domain name of |
1499 | the machine. | |
1500 | ||
16674e4f | 1501 | @item @value{tramp-prefix}melancholia@value{tramp-postfix}~/.emacs |
fb7933a3 KG |
1502 | This also edits the same file --- the @file{~} is expanded to your |
1503 | home directory on the remote machine, just like it is locally. | |
1504 | ||
16674e4f | 1505 | @item @value{tramp-prefix}melancholia@value{tramp-postfix}~daniel/.emacs |
fb7933a3 KG |
1506 | This edits the file @file{.emacs} in the home directory of the user |
1507 | @code{daniel} on the machine @code{melancholia}. The @file{~<user>} | |
1508 | construct is expanded to the home directory of that user on the remote | |
1509 | machine. | |
1510 | ||
16674e4f | 1511 | @item @value{tramp-prefix}melancholia@value{tramp-postfix}/etc/squid.conf |
fb7933a3 KG |
1512 | This edits the file @file{/etc/squid.conf} on the machine |
1513 | @code{melancholia}. | |
1514 | ||
1515 | @end table | |
1516 | ||
16674e4f KG |
1517 | Unless you specify a different name to use, @tramp{} will use the |
1518 | current local user name as the remote user name to log in with. If you | |
1519 | need to log in as a different user, you can specify the user name as | |
1520 | part of the filename. | |
fb7933a3 | 1521 | |
16674e4f KG |
1522 | To log in to the remote machine as a specific user, you use the syntax |
1523 | @file{@value{tramp-prefix}@var{user}@@@var{machine}@value{tramp-postfix}/@var{path/to.file}}. | |
1524 | That means that connecting to @code{melancholia} as @code{daniel} and | |
f37fc5a7 | 1525 | editing @file{.emacs} in your home directory you would specify |
16674e4f | 1526 | @file{@value{tramp-prefix}daniel@@melancholia@value{tramp-postfix}.emacs}. |
fb7933a3 KG |
1527 | |
1528 | It is also possible to specify other file transfer methods | |
16674e4f KG |
1529 | (@pxref{Default Method}) as part of the filename. |
1530 | @ifset emacs | |
1531 | This is done by putting the method before the user and host name, as | |
1532 | in | |
1533 | @file{@value{tramp-prefix}@var{method}@value{tramp-postfix-single-hop}} | |
abc6be8d | 1534 | (Note the trailing colon). |
16674e4f KG |
1535 | @end ifset |
1536 | @ifset xemacs | |
1537 | This is done by replacing the initial | |
1538 | @file{@value{tramp-prefix}} with | |
1539 | @file{@value{tramp-prefix}<method>@value{tramp-postfix-single-hop}}. | |
1540 | (Note the trailing slash!). | |
1541 | @end ifset | |
1542 | The user, machine and file specification remain the same. | |
fb7933a3 | 1543 | |
f37fc5a7 KG |
1544 | So, to connect to the machine @code{melancholia} as @code{daniel}, |
1545 | using the @option{su} method to transfer files, and edit @file{.emacs} | |
1546 | in my home directory I would specify the filename | |
16674e4f | 1547 | @file{@value{tramp-prefix}su@value{tramp-postfix-single-hop}daniel@@melancholia@value{tramp-postfix}.emacs}. |
fb7933a3 KG |
1548 | |
1549 | ||
1550 | @node Multi-hop filename syntax | |
1551 | @section Multi-hop filename conventions | |
92eeeafc KG |
1552 | @cindex filename syntax for multi-hop files |
1553 | @cindex multi-hop filename syntax | |
fb7933a3 KG |
1554 | |
1555 | The syntax of multi-hop file names is necessarily slightly different | |
16674e4f KG |
1556 | than the syntax of other @tramp{} file names. Here's an example |
1557 | multi-hop file name, first in Emacs syntax and then in XEmacs syntax: | |
fb7933a3 | 1558 | |
16674e4f KG |
1559 | @example |
1560 | @value{tramp-prefix}multi@value{tramp-postfix-single-hop}rsh@value{tramp-postfix-multi-hop}out@@gate@value{tramp-postfix-single-hop}telnet@value{tramp-postfix-multi-hop}kai@@real.host@value{tramp-postfix}/path/to.file | |
1561 | @end example | |
fb7933a3 KG |
1562 | |
1563 | This is quite a mouthful. So let's go through it step by step. The | |
16674e4f KG |
1564 | file name consists of three parts. |
1565 | @ifset emacs | |
1566 | The parts are separated by colons | |
1567 | @end ifset | |
1568 | @ifset xemacs | |
1569 | The parts are separated by slashes and square brackets. | |
1570 | @end ifset | |
1571 | The first part is @file{@value{tramp-prefix}multi}, the method | |
1572 | specification. The second part is | |
1573 | @file{rsh@value{tramp-postfix-multi-hop}out@@gate@value{tramp-postfix-single-hop}telnet@value{tramp-postfix-multi-hop}kai@@real.host} | |
1574 | and specifies the hops. The final part is @file{/path/to.file} and | |
1575 | specifies the file name on the remote host. | |
fb7933a3 | 1576 | |
abc6be8d | 1577 | The first part and the final part should be clear. See @ref{Multi-hop |
fb7933a3 KG |
1578 | Methods}, for a list of alternatives for the method specification. |
1579 | ||
16674e4f KG |
1580 | The second part can be subdivided again into components, so-called |
1581 | hops. In the above file name, there are two hops, | |
1582 | @file{rsh@value{tramp-postfix-multi-hop}out@@gate} and | |
1583 | @file{telnet@value{tramp-postfix-multi-hop}kai@@real.host}. | |
fb7933a3 KG |
1584 | |
1585 | Each hop can @emph{again} be subdivided into (three) components, the | |
1586 | @dfn{hop method}, the @dfn{user name} and the @dfn{host name}. The | |
1587 | meaning of the second and third component should be clear, and the hop | |
1588 | method says what program to use to perform that hop. | |
1589 | ||
16674e4f KG |
1590 | The first hop, @file{rsh@value{tramp-postfix-multi-hop}out@@gate}, |
1591 | says to use @command{rsh} to log in as user @code{out} to the host | |
1592 | @code{gate}. Starting at that host, the second hop, | |
1593 | @file{telnet@value{tramp-postfix-multi-hop}kai@@real.host}, says to | |
1594 | use @command{telnet} to log in as user @code{kai} to host | |
1595 | @code{real.host}. | |
1596 | ||
1597 | @xref{Multi-hop Methods}, for a list of possible hop method values. | |
1598 | The variable @code{tramp-multi-connection-function-alist} contains the | |
1599 | list of possible hop methods and information on how to execute them, | |
1600 | should you want to add your own. | |
fb7933a3 | 1601 | |
16674e4f KG |
1602 | |
1603 | @node Filename completion | |
1604 | @section Filename completion | |
1605 | @cindex filename completion | |
1606 | ||
1607 | Filename completion works with @tramp{} for both completing methods, | |
1608 | user names and machine names (except multi hop methods) as well as for | |
1609 | files on remote machines. | |
1610 | ||
1611 | If you, for example, type @kbd{C-x C-f @value{tramp-prefix}t | |
1612 | @key{TAB}}, @tramp{} might give you as result the choice for | |
1613 | ||
1614 | @example | |
1615 | @ifset emacs | |
1616 | @value{tramp-prefix-single-hop}telnet@value{tramp-postfix-single-hop} tmp/ | |
1617 | @value{tramp-prefix-single-hop}toto@value{tramp-postfix} | |
1618 | @end ifset | |
1619 | @ifset xemacs | |
1620 | @value{tramp-prefix-single-hop}telnet@value{tramp-postfix-single-hop} @value{tramp-prefix-single-hop}toto@value{tramp-postfix} | |
1621 | @end ifset | |
1622 | @end example | |
177c0ea7 | 1623 | |
16674e4f KG |
1624 | @samp{@value{tramp-prefix-single-hop}telnet@value{tramp-postfix-single-hop}} |
1625 | is a possible completion for the respective method, | |
1626 | @ifset emacs | |
1627 | @samp{tmp/} stands for the directory @file{/tmp} on your local | |
1628 | machine, | |
1629 | @end ifset | |
1630 | and @samp{@value{tramp-prefix-single-hop}toto@value{tramp-postfix}} | |
1631 | might be a host @tramp has detected in your @file{~/.ssh/known_hosts} | |
1632 | file (given you're using default method @option{ssh}). | |
1633 | ||
1634 | If you go on to type @kbd{e @key{TAB}}, the minibuffer is completed to | |
1635 | @samp{@value{tramp-prefix}telnet@value{tramp-postfix-single-hop}}. | |
1636 | Next @kbd{@key{TAB}} brings you all machine names @tramp{} detects in | |
1637 | your @file{/etc/hosts} file, let's say | |
1638 | ||
1639 | @example | |
1640 | @value{tramp-prefix-single-hop}telnet@value{tramp-postfix-single-hop}127.0.0.1@value{tramp-postfix} @value{tramp-prefix-single-hop}telnet@value{tramp-postfix-single-hop}192.168.0.1@value{tramp-postfix} | |
1641 | @value{tramp-prefix-single-hop}telnet@value{tramp-postfix-single-hop}localhost@value{tramp-postfix} @value{tramp-prefix-single-hop}telnet@value{tramp-postfix-single-hop}melancholia.danann.net@value{tramp-postfix} | |
1642 | @value{tramp-prefix-single-hop}telnet@value{tramp-postfix-single-hop}melancholia@value{tramp-postfix} | |
1643 | @end example | |
1644 | ||
1645 | Now you can choose the desired machine, and you can continue to | |
1646 | complete file names on that machine. | |
1647 | ||
1648 | As filename completion needs to fetch the listing of files from the | |
1649 | remote machine, this feature is sometimes fairly slow. As @tramp{} | |
1650 | does not yet cache the results of directory listing, there is no gain | |
1651 | in performance the second time you complete filenames. | |
1652 | ||
1653 | If the configuration files (@pxref{Customizing Completion}), which | |
1654 | @tramp{} uses for analysis of completion, offer user names, those user | |
1655 | names will be taken into account as well. | |
fb7933a3 KG |
1656 | |
1657 | ||
1658 | @node Dired | |
16674e4f | 1659 | @section Dired |
92eeeafc | 1660 | @cindex dired |
fb7933a3 KG |
1661 | |
1662 | @tramp{} works transparently with dired, enabling you to use this powerful | |
1663 | file management tool to manage files on any machine you have access to | |
1664 | over the Internet. | |
1665 | ||
fb7933a3 | 1666 | If you need to browse a directory tree, Dired is a better choice, at |
92eeeafc | 1667 | present, than filename completion. Dired has its own cache mechanism |
fb7933a3 KG |
1668 | and will only fetch the directory listing once. |
1669 | ||
1670 | ||
1671 | @node Bug Reports | |
1672 | @chapter Reporting Bugs and Problems | |
92eeeafc | 1673 | @cindex bug reports |
fb7933a3 KG |
1674 | |
1675 | Bugs and problems with @tramp{} are actively worked on by the development | |
1676 | team. Feature requests and suggestions are also more than welcome. | |
1677 | ||
1678 | The @tramp{} mailing list is a great place to get information on working | |
1679 | with @tramp{}, solving problems and general discussion and advice on topics | |
1680 | relating to the package. | |
1681 | ||
1682 | The mailing list is at @email{tramp-devel@@mail.freesoftware.fsf.org}. | |
1683 | Messages sent to this address go to all the subscribers. This is | |
1684 | @emph{not} the address to send subscription requests to. | |
1685 | ||
1686 | For help on subscribing to the list, send mail to the administrative | |
1687 | address, @email{tramp-devel-request@@mail.freesoftware.fsf.org}, with the | |
1688 | subject @samp{help}. | |
1689 | ||
1690 | To report a bug in @tramp{}, you should execute @kbd{M-x tramp-bug}. This | |
1691 | will automatically generate a buffer with the details of your system and | |
1692 | @tramp{} version. | |
1693 | ||
1694 | When submitting a bug report, please try to describe in excruciating | |
1695 | detail the steps required to reproduce the problem, the setup of the | |
1696 | remote machine and any special conditions that exist. | |
1697 | ||
1698 | If you can identify a minimal test case that reproduces the problem, | |
1699 | include that with your bug report. This will make it much easier for the | |
1700 | development team to analyze and correct the problem. | |
1701 | ||
1702 | @node Frequently Asked Questions | |
1703 | @chapter Frequently Asked Questions | |
92eeeafc KG |
1704 | @cindex frequently asked questions |
1705 | @cindex FAQ | |
fb7933a3 KG |
1706 | |
1707 | @itemize @bullet | |
92eeeafc KG |
1708 | @item |
1709 | Where can I get the latest @tramp{}? | |
fb7933a3 | 1710 | |
16674e4f | 1711 | @tramp{} is available under the URL below. |
fb7933a3 | 1712 | |
16674e4f KG |
1713 | @noindent |
1714 | @uref{ftp://ls6-ftp.cs.uni-dortmund.de/pub/src/emacs/tramp.tar.gz} | |
1715 | ||
1716 | @noindent | |
1717 | There is also a Savannah project page. | |
1718 | ||
1719 | @noindent | |
1720 | @uref{https://savannah.gnu.org/projects/tramp/} | |
fb7933a3 | 1721 | |
92eeeafc KG |
1722 | @item |
1723 | Which systems does it work on? | |
fb7933a3 KG |
1724 | |
1725 | The package has been used successfully on Emacs 20 and Emacs 21, as well | |
1726 | as XEmacs 21. XEmacs 20 is more problematic, see the notes in | |
1727 | @file{tramp.el}. I don't think anybody has really tried it on Emacs 19. | |
1728 | ||
1729 | The package was intended to work on Unix, and it really expects a | |
1730 | Unix-like system on the remote end, but some people seemed to have some | |
1731 | success getting it to work on NT Emacs. | |
1732 | ||
abc6be8d KG |
1733 | There is some informations on @tramp{} on NT at the following URL; |
1734 | many thanks to Joe Stoy for providing the information: | |
fb7933a3 KG |
1735 | @uref{ftp://ftp.comlab.ox.ac.uk/tmp/Joe.Stoy/} |
1736 | ||
1737 | The above mostly contains patches to old ssh versions; Tom Roche has a | |
1738 | Web page with instructions: | |
1739 | @uref{http://www4.ncsu.edu/~tlroche/plinkTramp.html} | |
1740 | ||
1741 | ??? Is the XEmacs info correct? | |
1742 | ||
1743 | ??? Can somebody provide some information for getting it to work on NT | |
1744 | Emacs? I think there was some issue with @command{ssh}? | |
1745 | ||
1746 | ||
92eeeafc KG |
1747 | @item |
1748 | I can't stop EFS starting with XEmacs | |
fb7933a3 KG |
1749 | |
1750 | Not all the older versions of @tramp{} supported XEmacs correctly. The | |
1751 | first thing to do is to make sure that you have the latest version of | |
1752 | @tramp{} installed. | |
1753 | ||
1754 | If you do, please try and find out exactly the conditions required for | |
16674e4f | 1755 | the EFS handlers to fire. If you can, putting a breakpoint on |
fb7933a3 | 1756 | @code{efs-ftp-path} and sending in the stack trace along with your bug |
16674e4f KG |
1757 | report would make it easier for the developers to work out what is |
1758 | going wrong. | |
fb7933a3 KG |
1759 | |
1760 | ||
92eeeafc KG |
1761 | @item |
1762 | File name completion does not work with @tramp{} | |
fb7933a3 KG |
1763 | |
1764 | When you log in to the remote machine, do you see the output of | |
1765 | @command{ls} in color? If so, this may be the cause of your problems. | |
1766 | ||
1767 | @command{ls} outputs @acronym{ANSI} escape sequences that your terminal | |
1768 | emulator interprets to set the colors. These escape sequences will | |
1769 | confuse @tramp{} however. | |
1770 | ||
1771 | In your @file{.bashrc}, @file{.profile} or equivalent on the remote | |
1772 | machine you probably have an alias configured that adds the option | |
1773 | @option{--color=yes} or @option{--color=auto}. | |
1774 | ||
1775 | You should remove that alias and ensure that a new login @emph{does not} | |
1776 | display the output of @command{ls} in color. If you still cannot use | |
1777 | filename completion, report a bug to the @tramp{} developers. | |
1778 | ||
1779 | ||
92eeeafc KG |
1780 | @item |
1781 | File name completion does not work in large directories | |
fb7933a3 KG |
1782 | |
1783 | @tramp{} uses globbing for some operations. (Globbing means to use the | |
1784 | shell to expand wildcards such as `*.c'.) This might create long | |
abc6be8d | 1785 | command lines, especially in directories with many files. Some shells |
fb7933a3 KG |
1786 | choke on long command lines, or don't cope well with the globbing |
1787 | itself. | |
1788 | ||
1789 | If you have a large directory on the remote end, you may wish to execute | |
92eeeafc | 1790 | a command like @samp{ls -d * ..?* > /dev/null} and see if it hangs. |
fb7933a3 KG |
1791 | Note that you must first start the right shell, which might be |
1792 | @command{/bin/sh}, @command{ksh} or @command{bash}, depending on which | |
1793 | of those supports tilde expansion. | |
1794 | ||
1795 | ||
92eeeafc KG |
1796 | @item |
1797 | What kinds of systems does @tramp{} work on | |
fb7933a3 KG |
1798 | |
1799 | @tramp{} really expects the remote system to be a Unix-like system. The | |
1800 | local system should preferably be Unix-like, as well, but @tramp{} might | |
1801 | work on NT with some tweaking. | |
1802 | ||
1803 | ||
92eeeafc KG |
1804 | @item |
1805 | How can I get notified when @tramp{} file transfers are complete? | |
fb7933a3 KG |
1806 | |
1807 | The following snippet can be put in your @file{~/.emacs} file. It makes | |
1808 | Emacs beep after reading from or writing to the remote host. | |
1809 | ||
1810 | @lisp | |
1811 | (defadvice tramp-handle-write-region | |
1812 | (after tramp-write-beep-advice activate) | |
1813 | " make tramp beep after writing a file." | |
1814 | (interactive) | |
1815 | (beep)) | |
1816 | (defadvice tramp-handle-do-copy-or-rename-file | |
1817 | (after tramp-copy-beep-advice activate) | |
1818 | " make tramp beep after copying a file." | |
1819 | (interactive) | |
1820 | (beep)) | |
1821 | (defadvice tramp-handle-insert-file-contents | |
1822 | (after tramp-copy-beep-advice activate) | |
1823 | " make tramp beep after copying a file." | |
1824 | (interactive) | |
1825 | (beep)) | |
1826 | @end lisp | |
1827 | ||
1828 | ||
92eeeafc KG |
1829 | @item |
1830 | There's this @file{~/.sh_history} file on the remote host which keeps | |
1831 | growing and growing. What's that? | |
fb7933a3 KG |
1832 | |
1833 | Sometimes, @tramp{} starts @code{ksh} on the remote host for tilde | |
1834 | expansion. Maybe @code{ksh} saves the history by default. @tramp{} | |
1835 | tries to turn off saving the history, but maybe you have to help. For | |
1836 | example, you could put this in your @file{.kshrc}: | |
1837 | ||
1838 | @example | |
1839 | if [ -f $HOME/.sh_history ] ; then | |
1840 | /bin/rm $HOME/.sh_history | |
1841 | fi | |
1842 | if [ "$@{HISTFILE-unset@}" != "unset" ] ; then | |
1843 | unset HISTFILE | |
1844 | fi | |
1845 | if [ "$@{HISTSIZE-unset@}" != "unset" ] ; then | |
1846 | unset HISTSIZE | |
1847 | fi | |
1848 | @end example | |
1849 | ||
1850 | @end itemize | |
1851 | ||
1852 | ||
1853 | @c For the developer | |
1854 | @node Version Control | |
1855 | @chapter The inner workings of remote version control | |
1856 | ||
16674e4f KG |
1857 | Unlike @value{ftp-package-name}, @tramp{} has full shell access to the |
1858 | remote machine. This makes it possible to provide version control for | |
1859 | files accessed under @tramp{}. | |
fb7933a3 KG |
1860 | |
1861 | The actual version control binaries must be installed on the remote | |
1862 | machine, accessible in the directories specified in | |
1863 | @var{tramp-remote-path}. | |
1864 | ||
1865 | This transparent integration with the version control systems is one of | |
1866 | the most valuable features provided by @tramp{}, but it is far from perfect. | |
1867 | Work is ongoing to improve the transparency of the system. | |
1868 | ||
1869 | @menu | |
1870 | * Version Controlled Files:: Determining if a file is under version control. | |
1871 | * Remote Commands:: Executing the version control commands on the remote machine. | |
1872 | * Changed workfiles:: Detecting if the working file has changed. | |
1873 | * Checking out files:: Bringing the workfile out of the repository. | |
16674e4f | 1874 | * Miscellaneous Version Control:: Things related to Version Control that don't fit elsewhere. |
fb7933a3 KG |
1875 | @end menu |
1876 | ||
1877 | ||
1878 | @node Version Controlled Files | |
1879 | @section Determining if a file is under version control | |
1880 | ||
1881 | The VC package uses the existence of on-disk revision control master | |
1882 | files to determine if a given file is under revision control. These file | |
1883 | tests happen on the remote machine through the standard @tramp{} mechanisms. | |
1884 | ||
1885 | ||
1886 | @node Remote Commands | |
1887 | @section Executing the version control commands on the remote machine | |
1888 | ||
1889 | There are no hooks provided by VC to allow intercepting of the version | |
1890 | control command execution. The calls occur through the | |
1891 | @code{call-process} mechanism, a function that is somewhat more | |
1892 | efficient than the @code{shell-command} function but that does not | |
1893 | provide hooks for remote execution of commands. | |
1894 | ||
1895 | To work around this, the functions @code{vc-do-command} and | |
1896 | @code{vc-simple-command} have been advised to intercept requests for | |
1897 | operations on files accessed via @tramp{}. | |
1898 | ||
1899 | In the case of a remote file, the @code{shell-command} interface is | |
1900 | used, with some wrapper code, to provide the same functionality on the | |
177c0ea7 | 1901 | remote machine as would be seen on the local machine. |
fb7933a3 KG |
1902 | |
1903 | ||
1904 | @node Changed workfiles | |
1905 | @section Detecting if the working file has changed | |
1906 | ||
1907 | As there is currently no way to get access to the mtime of a file on a | |
1908 | remote machine in a portable way, the @code{vc-workfile-unchanged-p} | |
1909 | function is advised to call an @tramp{} specific function for remote files. | |
1910 | ||
1911 | The @code{tramp-vc-workfile-unchanged-p} function uses the functioning VC | |
1912 | diff functionality to determine if any changes have occurred between the | |
1913 | workfile and the version control master. | |
1914 | ||
1915 | This requires that a shell command be executed remotely, a process that | |
1916 | is notably heavier-weight than the mtime comparison used for local | |
1917 | files. Unfortunately, unless a portable solution to the issue is found, | |
1918 | this will remain the cost of remote version control. | |
1919 | ||
1920 | ||
1921 | @node Checking out files | |
1922 | @section Bringing the workfile out of the repository | |
1923 | ||
1924 | VC will, by default, check for remote files and refuse to act on them | |
1925 | when checking out files from the repository. To work around this | |
1926 | problem, the function @code{vc-checkout} knows about @tramp{} files and | |
1927 | allows version control to occur. | |
1928 | ||
1929 | ||
1930 | @node Miscellaneous Version Control | |
1931 | @section Things related to Version Control that don't fit elsewhere | |
1932 | ||
1933 | Minor implementation details, &c. | |
1934 | ||
1935 | @menu | |
1936 | * Remote File Ownership:: How VC determines who owns a workfile. | |
1937 | * Back-end Versions:: How VC determines what release your RCS is. | |
1938 | @end menu | |
1939 | ||
1940 | ||
1941 | @node Remote File Ownership | |
1942 | @subsection How VC determines who owns a workfile | |
1943 | ||
1944 | Emacs provides the @code{user-full-name} function to return the login name | |
1945 | of the current user as well as mapping from arbitrary user id values | |
1946 | back to login names. The VC code uses this functionality to map from the | |
1947 | uid of the owner of a workfile to the login name in some circumstances. | |
1948 | ||
1949 | This will not, for obvious reasons, work if the remote system has a | |
1950 | different set of logins. As such, it is necessary to delegate to the | |
1951 | remote machine the job of determining the login name associated with a | |
1952 | uid. | |
1953 | ||
1954 | Unfortunately, with the profusion of distributed management systems such | |
1955 | as @code{NIS}, @code{NIS+} and @code{NetInfo}, there is no simple, | |
1956 | reliable and portable method for performing this mapping. | |
1957 | ||
1958 | Thankfully, the only place in the VC code that depends on the mapping of | |
1959 | a uid to a login name is the @code{vc-file-owner} function. This returns | |
1960 | the login of the owner of the file as a string. | |
1961 | ||
1962 | This function has been advised to use the output of @command{ls} on the | |
1963 | remote machine to determine the login name, delegating the problem of | |
1964 | mapping the uid to the login to the remote system which should know more | |
1965 | about it than I do. | |
1966 | ||
1967 | ||
1968 | @node Back-end Versions | |
1969 | @subsection How VC determines what release your RCS is | |
1970 | ||
1971 | VC needs to know what release your revision control binaries you are | |
1972 | running as not all features VC supports are available with older | |
1973 | versions of @command{rcs(1)}, @command{cvs(1)} or @command{sccs(1)}. | |
1974 | ||
1975 | The default implementation of VC determines this value the first time it | |
1976 | is needed and then stores the value globally to avoid the overhead of | |
1977 | executing a process and parsing its output each time the information is | |
1978 | needed. | |
1979 | ||
1980 | Unfortunately, life is not quite so easy when remote version control | |
1981 | comes into the picture. Each remote machine may have a different version | |
1982 | of the version control tools and, while this is painful, we need to | |
1983 | ensure that unavailable features are not used remotely. | |
1984 | ||
1985 | To resolve this issue, @tramp{} currently takes the sledgehammer | |
1986 | approach of making the release values of the revision control tools | |
1987 | local to each @tramp{} buffer, forcing VC to determine these values | |
1988 | again each time a new file is visited. | |
1989 | ||
1990 | This has, quite obviously, some performance implications. Thankfully, | |
1991 | most of the common operations performed by VC do not actually require | |
1992 | that the remote version be known. This makes the problem far less | |
1993 | apparent. | |
1994 | ||
1995 | Eventually these values will be captured by @tramp{} on a system by | |
1996 | system basis and the results cached to improve performance. | |
1997 | ||
1998 | ||
1999 | @node Files directories and paths | |
2000 | @chapter How file names, directories and paths are mangled and managed. | |
2001 | ||
2002 | @menu | |
2003 | * Path deconstruction:: Breaking a path into its components. | |
2004 | @end menu | |
2005 | ||
2006 | ||
2007 | @node Path deconstruction | |
2008 | @section Breaking a path into its components. | |
2009 | ||
2010 | @tramp{} filenames are somewhat different, obviously, to ordinary path | |
2011 | names. As such, the lisp functions @code{file-name-directory} and | |
2012 | @code{file-name-nondirectory} are overridden within the @tramp{} package. | |
2013 | ||
2014 | Their replacements are reasonably simplistic in their approach. They | |
2015 | dissect the filename, call the original handler on the remote path and | |
2016 | then rebuild the @tramp{} path with the result. | |
2017 | ||
2018 | This allows the platform specific hacks in the original handlers to take | |
2019 | effect while preserving the @tramp{} path information. | |
2020 | ||
2021 | ||
2022 | @node Issues | |
2023 | @chapter Debatable Issues and What Was Decided | |
2024 | ||
2025 | @itemize @bullet | |
2026 | @item The uuencode method does not always work. | |
2027 | ||
2028 | Due to the design of @tramp{}, the encoding and decoding programs need to | |
2029 | read from stdin and write to stdout. On some systems, @code{uudecode -o | |
2030 | -} will read stdin and write the decoded file to stdout, on other | |
2031 | systems @code{uudecode -p} does the same thing. But some systems have | |
2032 | uudecode implementations which cannot do this at all---it is not | |
2033 | possible to call these uudecode implementations with suitable parameters | |
2034 | so that they write to stdout. | |
2035 | ||
2036 | Of course, this could be circumvented: the @code{begin foo 644} line | |
2037 | could be rewritten to put in some temporary file name, then | |
2038 | @code{uudecode} could be called, then the temp file could be printed and | |
2039 | deleted. | |
2040 | ||
2041 | But I have decided that this is too fragile to reliably work, so on some | |
2042 | systems you'll have to do without the uuencode methods. | |
2043 | ||
2044 | @item @tramp{} does not work on XEmacs 20. | |
2045 | ||
2046 | This is because it requires the macro @code{with-timeout} which does not | |
2047 | appear to exist in XEmacs 20. I'm somewhat reluctant to add an | |
2048 | emulation macro to @tramp{}, but if somebody who uses XEmacs 20 steps | |
2049 | forward and wishes to implement and test it, please contact me or the | |
2050 | mailing list. | |
2051 | ||
f37fc5a7 KG |
2052 | @item The @tramp{} filename syntax differs between Emacs and XEmacs. |
2053 | ||
2054 | The Emacs maintainers wish to use a unified filename syntax for | |
2055 | Ange-FTP and @tramp{} so that users don't have to learn a new | |
2056 | syntax. It is sufficient to learn some extensions to the old syntax. | |
2057 | ||
2058 | For the XEmacs maintainers, the problems caused from using a unified | |
abc6be8d KG |
2059 | filename syntax are greater than the gains. The XEmacs package system |
2060 | uses EFS for downloading new packages. So, obviously, EFS has to be | |
2061 | installed from the start. If the filenames were unified, @tramp{} | |
f37fc5a7 KG |
2062 | would have to be installed from the start, too. |
2063 | ||
fb7933a3 KG |
2064 | @end itemize |
2065 | ||
2066 | ||
2067 | @c End of tramp.texi - the TRAMP User Manual | |
2068 | @bye | |
2069 | ||
2070 | @c TODO | |
2071 | @c | |
2072 | @c * Say something about the .login and .profile files of the remote | |
2073 | @c shells. | |
2074 | @c * Explain how tramp.el works in principle: open a shell on a remote | |
2075 | @c host and then send commands to it. | |
83fa16cf KG |
2076 | @c * Mention that bookmarks are a cool feature to go along with Tramp. |
2077 | @c * Make terminology "inline" vs "out-of-band" consistent. | |
2078 | @c It seems that "external" is also used instead of "out-of-band". | |
fb7933a3 | 2079 | |
16674e4f KG |
2080 | @c * M. Albinus |
2081 | @c ** Use `filename' resp. `file name' consistently. | |
2082 | @c ** Use `host' resp. `machine' consistently. | |
2083 | @c ** Consistent small or capitalized words especially in menues. |