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