Mercurial > emacs
annotate man/tramp.texi @ 82621:8bdedd5fc7a2
Move refcards from etc/ to etc/refcards/
author | Glenn Morris <rgm@gnu.org> |
---|---|
date | Wed, 22 Aug 2007 07:17:41 +0000 |
parents | e6c6021c376b |
children | b83d0dadb2a7 |
rev | line source |
---|---|
45861 | 1 \input texinfo @c -*-texinfo-*- |
81939
7cd8ee60cf68
* tramp.texi: Move @setfilename ../info/tramp up, outside the header
Michael Albinus <michael.albinus@gmx.de>
parents:
81831
diff
changeset
|
2 @setfilename ../info/tramp |
45861 | 3 @c %**start of header |
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. |
50495
cf8b9e443180
2003-04-08 Michael Albinus <Michael.Albinus@alcatel.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50342
diff
changeset
|
14 |
cf8b9e443180
2003-04-08 Michael Albinus <Michael.Albinus@alcatel.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50342
diff
changeset
|
15 @c Additionally, flags are set with respect to the Emacs flavor; and |
cf8b9e443180
2003-04-08 Michael Albinus <Michael.Albinus@alcatel.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50342
diff
changeset
|
16 @c depending whether Tramp is packaged into (X)Emacs, or standalone. |
cf8b9e443180
2003-04-08 Michael Albinus <Michael.Albinus@alcatel.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50342
diff
changeset
|
17 |
50338
155b4b78aa3b
* tramp.el: Version 2.0.31 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49996
diff
changeset
|
18 @include trampver.texi |
45861 | 19 |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
20 @c Macro for formatting a filename according to the repective syntax. |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
21 @c xxx and yyy are auxiliary macros in order to omit leading and |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
22 @c trailing whitespace. Not very elegant, but I don't know it better. |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
23 |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
24 @macro xxx {one}@c |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
25 @set \one\@c |
81759 | 26 @end macro |
27 | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
28 @macro yyy {one, two}@c |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
29 @xxx{x\one\}@c |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
30 @ifclear x@c |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
31 \one\@w{}\two\@c |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
32 @end ifclear |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
33 @clear x\one\@c |
81759 | 34 @end macro |
35 | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
36 @macro trampfn {method, user, host, localname}@c |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
37 @value{prefix}@yyy{\method\,@value{postfixhop}}@yyy{\user\,@@}\host\@value{postfix}\localname\@c |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
38 @end macro |
45861 | 39 |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
40 @copying |
81759 | 41 Copyright @copyright{} 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, |
42 2007 Free Software Foundation, Inc. | |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
43 |
52869
4c969f6bcb01
(Inline methods): Small grammar fix.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
44 @quotation |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
45 Permission is granted to copy, distribute and/or modify this document |
65555
69b3598a61c5
Update all manuals to specify GFDL version 1.2.
Romain Francoise <romain@orebokech.com>
parents:
64890
diff
changeset
|
46 under the terms of the GNU Free Documentation License, Version 1.2 or |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
47 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
|
48 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
|
49 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
|
50 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
|
51 License'' in the Emacs manual. |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
52 |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
53 (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
|
54 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
|
55 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
|
56 |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
57 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
|
58 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
|
59 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
|
60 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
|
61 @end quotation |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
62 @end copying |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
63 |
51604
f57bfce0ddaf
Version 2.0.35 of Tramp released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50495
diff
changeset
|
64 @c Entries for @command{install-info} to use |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
65 @dircategory @value{emacsname} |
51604
f57bfce0ddaf
Version 2.0.35 of Tramp released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50495
diff
changeset
|
66 @direntry |
f57bfce0ddaf
Version 2.0.35 of Tramp released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50495
diff
changeset
|
67 * TRAMP: (tramp). Transparent Remote Access, Multiple Protocol |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
68 @value{emacsname} remote file access via rsh and rcp. |
51604
f57bfce0ddaf
Version 2.0.35 of Tramp released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50495
diff
changeset
|
69 @end direntry |
f57bfce0ddaf
Version 2.0.35 of Tramp released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50495
diff
changeset
|
70 |
45861 | 71 @tex |
72 | |
73 @titlepage | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
74 @title @value{tramp} version @value{trampver} User Manual |
45861 | 75 |
76 @author by Daniel Pittman | |
77 @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
|
78 |
45861 | 79 @page |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
80 @insertcopying |
45861 | 81 |
82 @end titlepage | |
83 @page | |
84 | |
85 @end tex | |
86 | |
87 @ifnottex | |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
88 @node Top, Overview, (dir), (dir) |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
89 @top @value{tramp} version @value{trampver} User Manual |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
90 |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
91 This file documents @value{tramp} version @value{trampver}, a remote file |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
92 editing package for @value{emacsname}. |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
93 |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
94 @value{tramp} stands for `Transparent Remote (file) Access, Multiple |
45861 | 95 Protocol'. This package provides remote file editing, similar to |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
96 @value{ftppackagename}. |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
97 |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
98 The difference is that @value{ftppackagename} uses FTP to transfer |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
99 files between the local and the remote host, whereas @value{tramp} uses a |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
100 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
|
101 programs, such as @command{ssh}/@command{scp}. |
45861 | 102 |
103 You can find the latest version of this document on the web at | |
60763
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
104 @uref{http://www.gnu.org/software/tramp/}. |
45861 | 105 |
50495
cf8b9e443180
2003-04-08 Michael Albinus <Michael.Albinus@alcatel.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50342
diff
changeset
|
106 @c Pointer to the other Emacs flavor is necessary only in case of |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
107 @c standalone installation. |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
108 @ifset installchapter |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
109 The manual has been generated for @value{emacsname}. |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
110 @ifinfo |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
111 If you want to read the info pages for @value{emacsothername}, you |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
112 should read in @ref{Installation} how to create them. |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
113 @end ifinfo |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
114 @ifhtml |
63636 | 115 If you're using the other Emacs flavor, you should read the |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
116 @uref{@value{emacsotherfilename}, @value{emacsothername}} pages. |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
117 @end ifhtml |
50495
cf8b9e443180
2003-04-08 Michael Albinus <Michael.Albinus@alcatel.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50342
diff
changeset
|
118 @end ifset |
cf8b9e443180
2003-04-08 Michael Albinus <Michael.Albinus@alcatel.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50342
diff
changeset
|
119 |
45861 | 120 @ifhtml |
53207
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
121 @ifset jamanual |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
122 This manual is also available as a @uref{@value{japanesemanual}, |
53207
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
123 Japanese translation}. |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
124 @end ifset |
45861 | 125 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
126 The latest release of @value{tramp} is available for |
68335
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
127 @uref{ftp://ftp.gnu.org/gnu/tramp/, download}, or you may see |
60763
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
128 @ref{Obtaining Tramp} for more details, including the CVS server |
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
129 details. |
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
130 |
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
131 @value{tramp} also has a @uref{http://savannah.gnu.org/projects/tramp/, |
45861 | 132 Savannah Project Page}. |
133 @end ifhtml | |
134 | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
135 There is a mailing list for @value{tramp}, available at |
60763
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
136 @email{tramp-devel@@gnu.org}, and archived at |
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
137 @uref{http://lists.gnu.org/archive/html/tramp-devel/, the |
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
138 @value{tramp} Mail Archive}. |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
139 @ifhtml |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
140 Older archives are located at |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
141 @uref{http://sourceforge.net/mailarchive/forum.php?forum=tramp-devel, |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
142 SourceForge Mail Archive} and |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
143 @uref{http://www.mail-archive.com/emacs-rcp@@ls6.cs.uni-dortmund.de/, |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
144 The Mail Archive}. |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
145 @c in HTML output, there's no new paragraph. |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
146 @*@* |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
147 @end ifhtml |
45861 | 148 |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
149 @insertcopying |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
150 |
45861 | 151 @end ifnottex |
152 | |
153 @menu | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
154 * Overview:: What @value{tramp} can and cannot do. |
45861 | 155 |
156 For the end user: | |
50495
cf8b9e443180
2003-04-08 Michael Albinus <Michael.Albinus@alcatel.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50342
diff
changeset
|
157 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
158 * Obtaining Tramp:: How to obtain @value{tramp}. |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
159 * History:: History of @value{tramp}. |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
160 @ifset installchapter |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
161 * Installation:: Installing @value{tramp} with your @value{emacsname}. |
50495
cf8b9e443180
2003-04-08 Michael Albinus <Michael.Albinus@alcatel.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50342
diff
changeset
|
162 @end ifset |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
163 * Configuration:: Configuring @value{tramp} for use. |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
164 * Usage:: An overview of the operation of @value{tramp}. |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
165 * Bug Reports:: Reporting Bugs and Problems. |
45861 | 166 * Frequently Asked Questions:: Questions and answers from the mailing list. |
53207
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
167 * Concept Index:: An item for each concept. |
45861 | 168 |
169 For the developer: | |
50495
cf8b9e443180
2003-04-08 Michael Albinus <Michael.Albinus@alcatel.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50342
diff
changeset
|
170 |
45861 | 171 * 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
|
172 * Files directories and localnames:: How file names, directories and localnames are mangled and managed. |
81759 | 173 * Traces and Profiles:: How to Customize Traces. |
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 |
77235 | 176 * GNU Free Documentation License:: The license for this documentation. |
177 | |
45861 | 178 @detailmenu |
179 --- The Detailed Node Listing --- | |
50495
cf8b9e443180
2003-04-08 Michael Albinus <Michael.Albinus@alcatel.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50342
diff
changeset
|
180 @c |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
181 @ifset installchapter |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
182 Installing @value{tramp} with your @value{emacsname} |
50495
cf8b9e443180
2003-04-08 Michael Albinus <Michael.Albinus@alcatel.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50342
diff
changeset
|
183 |
cf8b9e443180
2003-04-08 Michael Albinus <Michael.Albinus@alcatel.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50342
diff
changeset
|
184 * Installation parameters:: Parameters in order to control installation. |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
185 * Load paths:: How to plug-in @value{tramp} into your environment. |
53207
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
186 * Japanese manual:: Japanese manual. |
50495
cf8b9e443180
2003-04-08 Michael Albinus <Michael.Albinus@alcatel.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50342
diff
changeset
|
187 |
cf8b9e443180
2003-04-08 Michael Albinus <Michael.Albinus@alcatel.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50342
diff
changeset
|
188 @end ifset |
45861 | 189 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
190 Configuring @value{tramp} for use |
45861 | 191 |
192 * Connection types:: Types of connections made to remote machines. | |
193 * Inline methods:: Inline methods. | |
194 * External transfer methods:: External transfer methods. | |
81759 | 195 @ifset emacsgw |
196 * Gateway methods:: Gateway methods. | |
197 @end ifset | |
45861 | 198 * Default Method:: Selecting a default method. |
81759 | 199 * Default User:: Selecting a default user. |
200 * Default Host:: Selecting a default host. | |
201 * Multi-hops:: Connecting to a remote host using multiple hops. | |
45861 | 202 * 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
|
203 * Customizing Completion:: Selecting config files for user/host name completion. |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
204 * Password caching:: Reusing passwords for several connections. |
81759 | 205 * Connection caching:: Reusing connection related information. |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
206 * Remote Programs:: How @value{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
|
207 * 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
|
208 * 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
|
209 * Auto-save and Backup:: Auto-save and Backup. |
45861 | 210 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
211 Using @value{tramp} |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
212 |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
213 * Filename Syntax:: @value{tramp} filename conventions. |
81759 | 214 * Alternative Syntax:: URL-like filename syntax. |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
215 * Filename completion:: Filename completion. |
81827
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
216 * Remote processes:: Integration with other @value{emacsname} packages. |
45861 | 217 |
218 The inner workings of remote version control | |
219 | |
220 * Version Controlled Files:: Determining if a file is under version control. | |
221 * Remote Commands:: Executing the version control commands on the remote machine. | |
222 * Changed workfiles:: Detecting if the working file has changed. | |
223 * 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
|
224 * Miscellaneous Version Control:: Things related to Version Control that don't fit elsewhere. |
45861 | 225 |
226 Things related to Version Control that don't fit elsewhere | |
227 | |
228 * Remote File Ownership:: How VC determines who owns a workfile. | |
229 * Back-end Versions:: How VC determines what release your RCS is. | |
230 | |
50495
cf8b9e443180
2003-04-08 Michael Albinus <Michael.Albinus@alcatel.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50342
diff
changeset
|
231 How file names, directories and localnames are mangled and managed |
49996
bda88bfc6c5e
Version 2.0.30 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49610
diff
changeset
|
232 |
50338
155b4b78aa3b
* tramp.el: Version 2.0.31 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49996
diff
changeset
|
233 * Localname deconstruction:: Breaking a localname into its components. |
45861 | 234 |
235 @end detailmenu | |
236 @end menu | |
237 | |
238 @node Overview | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
239 @chapter An overview of @value{tramp} |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
240 @cindex overview |
45861 | 241 |
81759 | 242 After the installation of @value{tramp} into your @value{emacsname}, you |
243 will be able to access files on remote machines as though they were | |
244 local. Access to the remote file system for editing files, version | |
245 control, and @code{dired} are transparently enabled. | |
45861 | 246 |
247 Your access to the remote machine can be with the @command{rsh}, | |
248 @command{rlogin}, @command{telnet} programs or with any similar | |
53207
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
249 connection method. This connection must pass @acronym{ASCII} |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
250 successfully to be usable but need not be 8-bit clean. |
45861 | 251 |
252 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
|
253 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
|
254 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
|
255 access is disabled. |
45861 | 256 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
257 The majority of activity carried out by @value{tramp} requires only that |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
258 the remote login is possible and is carried out at the terminal. In |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
259 order to access remote files @value{tramp} needs to transfer their content |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
260 to the local machine temporarily. |
45861 | 261 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
262 @value{tramp} can transfer files between the machines in a variety of ways. |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
263 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
|
264 machines in question. |
45861 | 265 |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
266 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
|
267 transfer package such as @command{rcp}, @command{scp} or |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
268 @command{rsync}. |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
269 |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
270 If the remote copy methods are not suitable for you, @value{tramp} also |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
271 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
|
272 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
|
273 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
|
274 faster for small files. |
45861 | 275 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
276 Within these limitations, @value{tramp} is quite powerful. It is worth |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
277 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
|
278 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
|
279 edges and problems with the code now and then. |
45861 | 280 |
281 It is finished enough that the developers use it for day to day work but | |
282 the installation and setup can be a little difficult to master, as can | |
283 the terminology. | |
284 | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
285 @value{tramp} is still under active development and any problems you encounter, |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
286 trivial or major, should be reported to the @value{tramp} developers. |
45861 | 287 @xref{Bug Reports}. |
288 | |
289 | |
290 @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
|
291 @cindex behind the scenes |
46366 | 292 @cindex details of operation |
293 @cindex how it works | |
45861 | 294 |
295 This section tries to explain what goes on behind the scenes when you | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
296 access a remote file through @value{tramp}. |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
297 |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
298 Suppose you type @kbd{C-x C-f} and enter part of an @value{tramp} file name, |
45861 | 299 then hit @kbd{@key{TAB}} for completion. Suppose further that this is |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
300 the first time that @value{tramp} is invoked for the host in question. Here's |
45861 | 301 what happens: |
302 | |
303 @itemize | |
304 @item | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
305 @value{tramp} discovers that it needs a connection to the host. So it |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
306 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
|
307 @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
|
308 Communication with this process happens through an |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
309 @value{emacsname} buffer, that is, the output from the remote end |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
310 goes into a buffer. |
45861 | 311 |
312 @item | |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
313 The remote host may prompt for a login name (for @command{telnet}). |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
314 The login name is given in the file name, so @value{tramp} sends the |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
315 login name and a newline. |
45861 | 316 |
317 @item | |
318 The remote host may prompt for a password or pass phrase (for | |
319 @command{rsh} or for @command{telnet} after sending the login name). | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
320 @value{tramp} displays the prompt in the minibuffer, asking you for the |
45861 | 321 password or pass phrase. |
322 | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
323 You enter the password or pass phrase. @value{tramp} sends it to the remote |
45861 | 324 host, followed by a newline. |
325 | |
326 @item | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
327 @value{tramp} now waits for the shell prompt or for a message that the login |
45861 | 328 failed. |
329 | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
330 If @value{tramp} sees neither of them after a certain period of time (a minute, |
45861 | 331 say), then it issues an error message saying that it couldn't find the |
332 remote shell prompt and shows you what the remote host has sent. | |
333 | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
334 If @value{tramp} sees a @samp{login failed} message, it tells you so, |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
335 aborts the login attempt and allows you to try again. |
45861 | 336 |
337 @item | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
338 Suppose that the login was successful and @value{tramp} sees the shell prompt |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
339 from the remote host. Now @value{tramp} invokes @command{/bin/sh} because |
45861 | 340 Bourne shells and C shells have different command |
341 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
|
342 shell doesn't recognize @samp{exec /bin/sh} as a valid command. |
45861 | 343 Maybe you use the Scheme shell @command{scsh}@dots{}} |
344 | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
345 After the Bourne shell has come up, @value{tramp} sends a few commands to |
45861 | 346 ensure a good working environment. It turns off echoing, it sets the |
347 shell prompt, and a few other things. | |
348 | |
349 @item | |
350 Now the remote shell is up and it good working order. Remember, what | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
351 was supposed to happen is that @value{tramp} tries to find out what files exist |
45861 | 352 on the remote host so that it can do filename completion. |
353 | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
354 So, @value{tramp} basically issues @command{cd} and @command{ls} commands and |
45861 | 355 also sometimes @command{echo} with globbing. Another command that is |
356 often used is @command{test} to find out whether a file is writable or a | |
357 directory or the like. The output of each command is parsed for the | |
358 necessary operation. | |
359 | |
360 @item | |
361 Suppose you are finished with filename completion, have entered @kbd{C-x | |
362 C-f}, a full file name and hit @kbd{@key{RET}}. Now comes the time to | |
363 transfer the file contents from the remote host to the local host so | |
364 that you can edit them. | |
365 | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
366 See above for an explanation of how @value{tramp} transfers the file contents. |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
367 |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
368 For inline transfers, @value{tramp} issues a command like @samp{mimencode -b |
45861 | 369 /path/to/remote/file}, waits until the output has accumulated in the |
370 buffer that's used for communication, then decodes that output to | |
371 produce the file contents. | |
372 | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
373 For out-of-band transfers, @value{tramp} issues a command like the following: |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
374 @example |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
375 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
|
376 @end example |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
377 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
|
378 buffer and deletes the temporary file. |
45861 | 379 |
380 @item | |
381 You now edit the buffer contents, blithely unaware of what has happened | |
382 behind the scenes. (Unless you have read this section, that is.) When | |
383 you are finished, you type @kbd{C-x C-s} to save the buffer. | |
384 | |
385 @item | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
386 Again, @value{tramp} transfers the file contents to the remote host either |
45861 | 387 inline or out-of-band. This is the reverse of what happens when reading |
388 the file. | |
389 @end itemize | |
390 | |
391 I hope this has provided you with a basic overview of what happens | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
392 behind the scenes when you open a file with @value{tramp}. |
45861 | 393 |
394 | |
395 @c For the end user | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
396 @node Obtaining Tramp |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
397 @chapter Obtaining Tramp. |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
398 @cindex obtaining Tramp |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
399 |
60763
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
400 @value{tramp} is freely available on the Internet and the latest |
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
401 release may be downloaded from |
81759 | 402 @uref{ftp://ftp.gnu.org/gnu/tramp/}. This release includes the full |
60763
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
403 documentation and code for @value{tramp}, suitable for installation. |
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
404 But GNU Emacs (22 or later) includes @value{tramp} already, and there |
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
405 is a @value{tramp} package for XEmacs, as well. So maybe it is easier |
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
406 to just use those. But if you want the bleeding edge, read |
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
407 on@dots{...} |
45861 | 408 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
409 For the especially brave, @value{tramp} is available from CVS. The CVS |
50338
155b4b78aa3b
* tramp.el: Version 2.0.31 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49996
diff
changeset
|
410 version is the latest version of the code and may contain incomplete |
81759 | 411 features or new issues. Use these versions at your own risk. |
45861 | 412 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
413 Instructions for obtaining the latest development version of @value{tramp} |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
414 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
|
415 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
|
416 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
|
417 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
418 @noindent |
60763
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
419 @uref{http://savannah.gnu.org/projects/tramp/} |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
420 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
421 @noindent |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
422 Or follow the example session below: |
45861 | 423 |
424 @example | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
425 ] @strong{cd ~/@value{emacsdir}} |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
426 ] @strong{export CVS_RSH="ssh"} |
60763
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
427 ] @strong{cvs -z3 -d:ext:anoncvs@@savannah.gnu.org:/cvsroot/tramp co tramp} |
45861 | 428 @end example |
429 | |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
430 @noindent |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
431 You should now have a directory @file{~/@value{emacsdir}/tramp} |
81759 | 432 containing the latest version of @value{tramp}. You can fetch the latest |
50338
155b4b78aa3b
* tramp.el: Version 2.0.31 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49996
diff
changeset
|
433 updates from the repository by issuing the command: |
45861 | 434 |
435 @example | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
436 ] @strong{cd ~/@value{emacsdir}/tramp} |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
437 ] @strong{export CVS_RSH="ssh"} |
45861 | 438 ] @strong{cvs update -d} |
439 @end example | |
440 | |
50338
155b4b78aa3b
* tramp.el: Version 2.0.31 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49996
diff
changeset
|
441 @noindent |
155b4b78aa3b
* tramp.el: Version 2.0.31 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49996
diff
changeset
|
442 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
|
443 @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
|
444 script: |
155b4b78aa3b
* tramp.el: Version 2.0.31 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49996
diff
changeset
|
445 |
155b4b78aa3b
* tramp.el: Version 2.0.31 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49996
diff
changeset
|
446 @example |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
447 ] @strong{cd ~/@value{emacsdir}/tramp} |
50338
155b4b78aa3b
* tramp.el: Version 2.0.31 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49996
diff
changeset
|
448 ] @strong{autoconf} |
155b4b78aa3b
* tramp.el: Version 2.0.31 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49996
diff
changeset
|
449 @end example |
155b4b78aa3b
* tramp.el: Version 2.0.31 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49996
diff
changeset
|
450 |
81759 | 451 People who have no direct CVS access (maybe because sitting behind a |
452 blocking firewall), can try the | |
453 @uref{http://savannah.gnu.org/cvs-backup/tramp-sources.tar.gz, Nightly | |
454 CVS Tree Tarball} instead of. | |
455 | |
45861 | 456 |
457 @node History | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
458 @chapter History of @value{tramp} |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
459 @cindex history |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
460 @cindex development history |
45861 | 461 |
462 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
|
463 @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
|
464 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
|
465 @command{scp} to transfer the file contents. After a while, the name |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
466 was changed to @file{rcp.el}, and now it's @value{tramp}. Along the way, |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
467 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
|
468 file contents were added. Support for VC was added. |
45861 | 469 |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
470 The most recent addition of major features were the multi-hop methods |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
471 added in April 2000 and the unification of @value{tramp} and Ange-FTP |
81759 | 472 filenames in July 2002. In July 2004, multi-hop methods have been |
473 replaced by proxy hosts. Running commands on remote hosts was | |
474 introduced in December 2005. | |
475 @ifset emacsgw | |
476 Support of gateways exists since April 2007. | |
477 @end ifset | |
478 | |
479 In December 2001, @value{tramp} has been added to the XEmacs package | |
480 repository. Being part of the GNU Emacs repository happened in June | |
481 2002, the first release including @value{tramp} was GNU Emacs 22.1. | |
482 | |
483 @value{tramp} is also a GNU/Linux Debian package since February 2001. | |
484 | |
45861 | 485 |
50495
cf8b9e443180
2003-04-08 Michael Albinus <Michael.Albinus@alcatel.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50342
diff
changeset
|
486 @c Installation chapter is necessary only in case of standalone |
cf8b9e443180
2003-04-08 Michael Albinus <Michael.Albinus@alcatel.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50342
diff
changeset
|
487 @c installation. Text taken from trampinst.texi. |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
488 @ifset installchapter |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
489 @include trampinst.texi |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
490 @end ifset |
45861 | 491 |
492 @node Configuration | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
493 @chapter Configuring @value{tramp} for use |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
494 @cindex configuration |
45861 | 495 |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
496 @cindex default configuration |
73808
2889a065b1d4
* lisp/net/tramp.el (tramp-default-method): scp is the default method.
Michael Albinus <michael.albinus@gmx.de>
parents:
73425
diff
changeset
|
497 @value{tramp} is (normally) fully functional when it is initially |
2889a065b1d4
* lisp/net/tramp.el (tramp-default-method): scp is the default method.
Michael Albinus <michael.albinus@gmx.de>
parents:
73425
diff
changeset
|
498 installed. It is initially configured to use the @command{scp} |
2889a065b1d4
* lisp/net/tramp.el (tramp-default-method): scp is the default method.
Michael Albinus <michael.albinus@gmx.de>
parents:
73425
diff
changeset
|
499 program to connect to the remote host. So in the easiest case, you |
2889a065b1d4
* lisp/net/tramp.el (tramp-default-method): scp is the default method.
Michael Albinus <michael.albinus@gmx.de>
parents:
73425
diff
changeset
|
500 just type @kbd{C-x C-f} and then enter the filename |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
501 @file{@trampfn{, user, machine, /path/to.file}}. |
45861 | 502 |
503 On some hosts, there are problems with opening a connection. These are | |
504 related to the behavior of the remote shell. See @xref{Remote shell | |
505 setup}, for details on this. | |
506 | |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
507 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
|
508 host, you should change the default connection and transfer method |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
509 that @value{tramp} uses. There are several different methods that @value{tramp} |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
510 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
|
511 (@pxref{Connection types}). |
45861 | 512 |
53207
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
513 If you don't know which method is right for you, see @xref{Default |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
514 Method}. |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
515 |
45861 | 516 |
517 @menu | |
518 * Connection types:: Types of connections made to remote machines. | |
519 * Inline methods:: Inline methods. | |
520 * External transfer methods:: External transfer methods. | |
81759 | 521 @ifset emacsgw |
522 * Gateway methods:: Gateway methods. | |
523 @end ifset | |
45861 | 524 * Default Method:: Selecting a default method. |
53207
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
525 Here we also try to help those who |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
526 don't have the foggiest which method |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
527 is right for them. |
81759 | 528 * Default User:: Selecting a default user. |
529 * Default Host:: Selecting a default host. | |
530 * Multi-hops:: Connecting to a remote host using multiple hops. | |
45861 | 531 * 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
|
532 * Customizing Completion:: Selecting config files for user/host name completion. |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
533 * Password caching:: Reusing passwords for several connections. |
81759 | 534 * Connection caching:: Reusing connection related information. |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
535 * Remote Programs:: How @value{tramp} finds and uses programs on the remote machine. |
45861 | 536 * Remote shell setup:: Remote shell setup hints. |
537 * 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
|
538 * Auto-save and Backup:: Auto-save and Backup. |
45861 | 539 @end menu |
540 | |
541 | |
542 @node Connection types | |
543 @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
|
544 @cindex connection types, overview |
45861 | 545 |
546 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
|
547 advantages and limitations. Both types of connection make use of a |
45861 | 548 remote shell access program such as @command{rsh}, @command{ssh} or |
549 @command{telnet} to connect to the remote machine. | |
550 | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
551 This connection is used to perform many of the operations that @value{tramp} |
45861 | 552 requires to make the remote file system transparently accessible from |
81759 | 553 the local machine. It is only when visiting files that the methods |
45861 | 554 differ. |
555 | |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
556 @cindex inline methods |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
557 @cindex external transfer methods |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
558 @cindex external methods |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
559 @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
|
560 @cindex methods, inline |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
561 @cindex methods, external transfer |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
562 @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
|
563 Loading or saving a remote file requires that the content of the file |
81759 | 564 be transfered between the two machines. The content of the file can be |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
565 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
|
566 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
|
567 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
|
568 @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
|
569 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
|
570 methods} (@dfn{external methods} for short). |
45861 | 571 |
572 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
|
573 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
|
574 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
|
575 inline. |
45861 | 576 |
577 The one exception to this rule are the @command{scp} based transfer | |
578 methods. While these methods do see better performance when actually | |
579 transferring files, the overhead of the cryptographic negotiation at | |
580 startup may drown out the improvement in file transfer times. | |
581 | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
582 External transfer methods should be configured such a way that they |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
583 don't require a password (with @command{ssh-agent}, or such alike). |
81759 | 584 Modern @command{scp} implementations offer options to reuse existing |
585 @command{ssh} connections, see method @command{scpc}. If it isn't | |
586 possible, you should consider @ref{Password caching}, otherwise you | |
587 will be prompted for a password every copy action. | |
45861 | 588 |
589 | |
590 @node Inline methods | |
591 @section Inline methods | |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
592 @cindex inline methods |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
593 @cindex methods, inline |
45861 | 594 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
595 The inline methods in @value{tramp} are quite powerful and can work in |
45861 | 596 situations where you cannot use an external transfer program to connect. |
597 Inline methods are the only methods that work when connecting to the | |
598 remote machine via telnet. (There are also strange inline methods which | |
599 allow you to transfer files between @emph{user identities} rather than | |
600 hosts, see below.) | |
601 | |
602 These methods depend on the existence of a suitable encoding and | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
603 decoding command on remote machine. Locally, @value{tramp} may be able to |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
604 use features of @value{emacsname} to decode and encode the files or |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
605 it may require access to external commands to perform that task. |
45861 | 606 |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
607 @cindex uuencode |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
608 @cindex mimencode |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
609 @cindex base-64 encoding |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
610 @value{tramp} checks the availability and usability of commands like |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
611 @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
|
612 @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
|
613 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
|
614 Programs}. |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
615 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
616 If both commands aren't available on the remote host, @value{tramp} |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
617 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
|
618 apply it for encoding and decoding. |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
619 |
45861 | 620 |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
621 @table @asis |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
622 @item @option{rsh} |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
623 @cindex method rsh |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
624 @cindex rsh method |
45861 | 625 |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
626 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
|
627 connection it is recommended for very local host topology only. |
45861 | 628 |
51604
f57bfce0ddaf
Version 2.0.35 of Tramp released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50495
diff
changeset
|
629 On operating systems which provide the command @command{remsh} instead |
f57bfce0ddaf
Version 2.0.35 of Tramp released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50495
diff
changeset
|
630 of @command{rsh}, you can use the method @option{remsh}. This is true |
f57bfce0ddaf
Version 2.0.35 of Tramp released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50495
diff
changeset
|
631 for HP-UX or Cray UNICOS, for example. |
f57bfce0ddaf
Version 2.0.35 of Tramp released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50495
diff
changeset
|
632 |
45861 | 633 |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
634 @item @option{ssh} |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
635 @cindex method ssh |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
636 @cindex ssh method |
45861 | 637 |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
638 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
|
639 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
|
640 making the connection more secure. |
45861 | 641 |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
642 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
|
643 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
|
644 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
|
645 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
|
646 @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
|
647 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
|
648 |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
649 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
|
650 @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
|
651 know what these are, you do not need these options. |
45861 | 652 |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
653 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
|
654 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
|
655 (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
|
656 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
|
657 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
|
658 |
45861 | 659 |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
660 @item @option{telnet} |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
661 @cindex method telnet |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
662 @cindex telnet method |
45861 | 663 |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
664 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
|
665 as the @option{rsh} method. |
45861 | 666 |
667 | |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
668 @item @option{su} |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
669 @cindex method su |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
670 @cindex su method |
45861 | 671 |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
672 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
|
673 the @command{su} program to allow you to edit files as another user. |
81759 | 674 With other words, a specified host name in the file name is silently |
675 ignored. | |
45861 | 676 |
677 | |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
678 @item @option{sudo} |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
679 @cindex method sudo |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
680 @cindex sudo method |
45861 | 681 |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
682 This is similar to the @option{su} method, but it uses @command{sudo} |
45861 | 683 rather than @command{su} to become a different user. |
684 | |
685 Note that @command{sudo} must be configured to allow you to start a | |
686 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
|
687 @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
|
688 easy to implement, so I haven't got around to it, yet. |
45861 | 689 |
690 | |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
691 @item @option{sshx} |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
692 @cindex method sshx |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
693 @cindex sshx method |
45861 | 694 |
52869
4c969f6bcb01
(Inline methods): Small grammar fix.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
695 As you would expect, this is similar to @option{ssh}, only a little |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
696 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
|
697 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
|
698 @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
|
699 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
|
700 questions when logging in. This procedure avoids these questions, and |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
701 just gives @value{tramp} a more-or-less `standard' login shell to work |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
702 with. |
45861 | 703 |
46346
49f06e689a20
* files.texi (Remote Files): Explain new unified file name synatx.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46010
diff
changeset
|
704 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
|
705 @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
|
706 sure you want to continue connecting?'' if the host key of the remote |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
707 host is not known. @value{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
|
708 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
|
709 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
|
710 |
45861 | 711 This is also useful for Windows users where @command{ssh}, when |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
712 invoked from an @value{emacsname} buffer, tells them that it is not |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
713 allocating a pseudo tty. When this happens, the login shell is wont |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
714 to not print any shell prompt, which confuses @value{tramp} mightily. |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
715 For reasons unknown, some Windows ports for @command{ssh} require the |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
716 doubled @samp{-t} option. |
45861 | 717 |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
718 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
|
719 |
45861 | 720 |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
721 @item @option{krlogin} |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
722 @cindex method krlogin |
81759 | 723 @cindex krlogin method |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
724 @cindex Kerberos (with krlogin method) |
45861 | 725 |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
726 This method is also similar to @option{ssh}. It only uses the |
45861 | 727 @command{krlogin -x} command to log in to the remote host. |
728 | |
729 | |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
730 @item @option{plink} |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
731 @cindex method plink |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
732 @cindex plink method |
45861 | 733 |
734 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
|
735 implementation of SSH. It uses @samp{plink -ssh} to log in to the |
45861 | 736 remote host. |
737 | |
81759 | 738 This supports the @samp{-P} kludge. |
739 | |
740 Additionally, the methods @option{plink1} and @option{plink2} are | |
741 provided, which call @samp{plink -1 -ssh} or @samp{plink -2 -ssh} in | |
742 order to use SSH protocol version 1 or 2 explicitly. | |
51604
f57bfce0ddaf
Version 2.0.35 of Tramp released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50495
diff
changeset
|
743 |
45861 | 744 CCC: Do we have to connect to the remote host once from the command |
745 line to accept the SSH key? Maybe this can be made automatic? | |
746 | |
81759 | 747 CCC: Say something about the first shell command failing. This might |
748 be due to a wrong setting of @code{tramp-rsh-end-of-line}. | |
749 | |
750 | |
751 @item @option{plinkx} | |
752 @cindex method plinkx | |
753 @cindex plinkx method | |
754 | |
755 Another method using PuTTY on Windows. Instead of host names, it | |
756 expects PuTTY session names, calling @samp{plink -load @var{session} | |
757 -t"}. User names are relevant only in case the corresponding session | |
758 hasn't defined a user name. Different port numbers must be defined in | |
759 the session. | |
760 | |
761 | |
762 @item @option{fish} | |
763 @cindex method fish | |
764 @cindex fish method | |
765 | |
766 This is an experimental implementation of the fish protocol, known from | |
767 the GNU Midnight Commander or the KDE Konqueror. @value{tramp} expects | |
768 the fish server implementation from the KDE kioslave. That means, the | |
769 file @file{~/.fishsrv.pl} is expected to reside on the remote host. | |
770 | |
771 The implementation lacks good performance. The code is offered anyway, | |
772 maybe somebody can improve the performance. | |
46010
d07b0e5f80b9
(tramp-open-connection-rsh): Support a kludgy feature for the
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
45979
diff
changeset
|
773 |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
774 @end table |
45861 | 775 |
776 | |
777 @node External transfer methods | |
778 @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
|
779 @cindex methods, external transfer |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
780 @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
|
781 @cindex external transfer methods |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
782 @cindex out-of-band methods |
45861 | 783 |
784 The external transfer methods operate through multiple channels, using | |
785 the remote shell connection for many actions while delegating file | |
786 transfers to an external transfer utility. | |
787 | |
788 This saves the overhead of encoding and decoding that multiplexing the | |
789 transfer through the one connection has with the inline methods. | |
790 | |
81759 | 791 Since external transfer methods need their own overhead opening a new |
792 channel, all files which are smaller than @var{tramp-copy-size-limit} | |
793 are still transferred with the corresponding inline method. It should | |
794 provide a fair trade-off between both approaches. | |
45861 | 795 |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
796 @table @asis |
45861 | 797 @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
|
798 @cindex method rcp |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
799 @cindex rcp method |
46366 | 800 @cindex rcp (with rcp method) |
801 @cindex rsh (with rcp method) | |
45861 | 802 |
803 This method uses the @command{rsh} and @command{rcp} commands to connect | |
51604
f57bfce0ddaf
Version 2.0.35 of Tramp released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50495
diff
changeset
|
804 to the remote machine and transfer files. This is probably the fastest |
45861 | 805 connection method available. |
806 | |
51604
f57bfce0ddaf
Version 2.0.35 of Tramp released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50495
diff
changeset
|
807 The alternative method @option{remcp} uses the @command{remsh} and |
f57bfce0ddaf
Version 2.0.35 of Tramp released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50495
diff
changeset
|
808 @command{rcp} commands. It should be applied on machines where |
f57bfce0ddaf
Version 2.0.35 of Tramp released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50495
diff
changeset
|
809 @command{remsh} is used instead of @command{rsh}. |
f57bfce0ddaf
Version 2.0.35 of Tramp released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50495
diff
changeset
|
810 |
45861 | 811 |
812 @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
|
813 @cindex method scp |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
814 @cindex scp method |
46366 | 815 @cindex scp (with scp method) |
816 @cindex ssh (with scp method) | |
45861 | 817 |
818 Using @command{ssh} to connect to the remote host and @command{scp} to | |
819 transfer files between the machines is the best method for securely | |
820 connecting to a remote machine and accessing files. | |
821 | |
81759 | 822 The performance of this option is also quite good. It may be slower than |
45861 | 823 the inline methods when you often open and close small files however. |
824 The cost of the cryptographic handshake at the start of an @command{scp} | |
825 session can begin to absorb the advantage that the lack of encoding and | |
826 decoding presents. | |
827 | |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
828 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
|
829 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
|
830 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
|
831 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
|
832 @file{~/.ssh/config}, the SSH configuration file, which protocol |
53207
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
833 should be used, and use the regular @option{scp} method.) |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
834 |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
835 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
|
836 @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
|
837 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
|
838 |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
839 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
|
840 feature where you can specify a port number to connect to in the host |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
841 name. For example, the host name @file{host#42} tells @value{tramp} to |
81759 | 842 specify @samp{-p 42} in the argument list for @command{ssh}, and to |
843 specify @samp{-P 42} in the argument list for @command{scp}. | |
844 | |
845 | |
846 @item @option{sftp} --- @command{ssh} and @command{sftp} | |
847 @cindex method sftp | |
848 @cindex sftp method | |
849 @cindex sftp (with sftp method) | |
850 @cindex ssh (with sftp method) | |
851 | |
852 That is mostly the same method as @option{scp}, but using | |
853 @command{sftp} as transfer command. So the same remarks are valid. | |
854 | |
855 This command does not work like @value{ftppackagename}, where | |
856 @command{ftp} is called interactively, and all commands are send from | |
857 within this session. Instead of, @command{ssh} is used for login. | |
858 | |
859 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
|
860 |
45861 | 861 |
862 @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
|
863 @cindex method rsync |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
864 @cindex rsync method |
46366 | 865 @cindex rsync (with rsync method) |
866 @cindex ssh (with rsync method) | |
45861 | 867 |
868 Using the @command{ssh} command to connect securely to the remote | |
869 machine and the @command{rsync} command to transfer files is almost | |
870 identical to the @option{scp} method. | |
871 | |
872 While @command{rsync} performs much better than @command{scp} when | |
873 transferring files that exist on both hosts, this advantage is lost if | |
874 the file exists only on one side of the connection. | |
875 | |
876 The @command{rsync} based method may be considerably faster than the | |
81759 | 877 @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
|
878 files to the local machine is no faster than with a direct copy. |
45861 | 879 |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
880 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
|
881 |
45861 | 882 |
883 @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
|
884 @cindex method scpx |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
885 @cindex scpx method |
46366 | 886 @cindex scp (with scpx method) |
887 @cindex ssh (with scpx method) | |
45861 | 888 |
52871
f0730b222101
(External transfer methods): Small grammar fix.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52869
diff
changeset
|
889 As you would 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
|
890 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
|
891 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
|
892 @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
|
893 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
|
894 questions when logging in. This procedure avoids these questions, and |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
895 just gives @value{tramp} a more-or-less `standard' login shell to work |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
896 with. |
45861 | 897 |
898 This is also useful for Windows users where @command{ssh}, when | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
899 invoked from an @value{emacsname} buffer, tells them that it is not |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
900 allocating a pseudo tty. When this happens, the login shell is wont |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
901 to not print any shell prompt, which confuses @value{tramp} mightily. |
45861 | 902 |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
903 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
|
904 |
45861 | 905 |
74738
1f9822a38f41
* tramp.texi (External transfer methods): Describe new method `scpc'.
Michael Albinus <michael.albinus@gmx.de>
parents:
73808
diff
changeset
|
906 @item @option{scpc} --- @command{ssh} and @command{scp} |
1f9822a38f41
* tramp.texi (External transfer methods): Describe new method `scpc'.
Michael Albinus <michael.albinus@gmx.de>
parents:
73808
diff
changeset
|
907 @cindex method scpx |
1f9822a38f41
* tramp.texi (External transfer methods): Describe new method `scpc'.
Michael Albinus <michael.albinus@gmx.de>
parents:
73808
diff
changeset
|
908 @cindex scpx method |
1f9822a38f41
* tramp.texi (External transfer methods): Describe new method `scpc'.
Michael Albinus <michael.albinus@gmx.de>
parents:
73808
diff
changeset
|
909 @cindex scp (with scpx method) |
1f9822a38f41
* tramp.texi (External transfer methods): Describe new method `scpc'.
Michael Albinus <michael.albinus@gmx.de>
parents:
73808
diff
changeset
|
910 @cindex ssh (with scpx method) |
1f9822a38f41
* tramp.texi (External transfer methods): Describe new method `scpc'.
Michael Albinus <michael.albinus@gmx.de>
parents:
73808
diff
changeset
|
911 |
1f9822a38f41
* tramp.texi (External transfer methods): Describe new method `scpc'.
Michael Albinus <michael.albinus@gmx.de>
parents:
73808
diff
changeset
|
912 Newer versions of @option{ssh} (for example OpenSSH 4) offer an option |
1f9822a38f41
* tramp.texi (External transfer methods): Describe new method `scpc'.
Michael Albinus <michael.albinus@gmx.de>
parents:
73808
diff
changeset
|
913 @option{ControlMaster}. This allows @option{scp} to reuse an existing |
1f9822a38f41
* tramp.texi (External transfer methods): Describe new method `scpc'.
Michael Albinus <michael.albinus@gmx.de>
parents:
73808
diff
changeset
|
914 @option{ssh} channel, which increases performance. |
1f9822a38f41
* tramp.texi (External transfer methods): Describe new method `scpc'.
Michael Albinus <michael.albinus@gmx.de>
parents:
73808
diff
changeset
|
915 |
1f9822a38f41
* tramp.texi (External transfer methods): Describe new method `scpc'.
Michael Albinus <michael.albinus@gmx.de>
parents:
73808
diff
changeset
|
916 Before you use this method, you shall check whether your @option{ssh} |
1f9822a38f41
* tramp.texi (External transfer methods): Describe new method `scpc'.
Michael Albinus <michael.albinus@gmx.de>
parents:
73808
diff
changeset
|
917 implementation does support this option. Try from the command line |
1f9822a38f41
* tramp.texi (External transfer methods): Describe new method `scpc'.
Michael Albinus <michael.albinus@gmx.de>
parents:
73808
diff
changeset
|
918 |
1f9822a38f41
* tramp.texi (External transfer methods): Describe new method `scpc'.
Michael Albinus <michael.albinus@gmx.de>
parents:
73808
diff
changeset
|
919 @example |
1f9822a38f41
* tramp.texi (External transfer methods): Describe new method `scpc'.
Michael Albinus <michael.albinus@gmx.de>
parents:
73808
diff
changeset
|
920 ssh localhost -o ControlMaster=yes |
1f9822a38f41
* tramp.texi (External transfer methods): Describe new method `scpc'.
Michael Albinus <michael.albinus@gmx.de>
parents:
73808
diff
changeset
|
921 @end example |
1f9822a38f41
* tramp.texi (External transfer methods): Describe new method `scpc'.
Michael Albinus <michael.albinus@gmx.de>
parents:
73808
diff
changeset
|
922 |
1f9822a38f41
* tramp.texi (External transfer methods): Describe new method `scpc'.
Michael Albinus <michael.albinus@gmx.de>
parents:
73808
diff
changeset
|
923 This method supports the @samp{-p} hack. |
1f9822a38f41
* tramp.texi (External transfer methods): Describe new method `scpc'.
Michael Albinus <michael.albinus@gmx.de>
parents:
73808
diff
changeset
|
924 |
1f9822a38f41
* tramp.texi (External transfer methods): Describe new method `scpc'.
Michael Albinus <michael.albinus@gmx.de>
parents:
73808
diff
changeset
|
925 |
45861 | 926 @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
|
927 @cindex method pscp |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
928 @cindex pscp method |
46366 | 929 @cindex pscp (with pscp method) |
930 @cindex plink (with pscp method) | |
931 @cindex PuTTY (with pscp method) | |
45861 | 932 |
933 This method is similar to @option{scp}, but it uses the | |
934 @command{plink} command to connect to the remote host, and it uses | |
935 @command{pscp} for transferring the files. These programs are part | |
936 of PuTTY, an SSH implementation for Windows. | |
937 | |
81759 | 938 This method supports the @samp{-P} hack. |
939 | |
940 | |
941 @item @option{psftp} --- @command{plink} and @command{psftp} | |
942 @cindex method psftp | |
943 @cindex psftp method | |
944 @cindex psftp (with psftp method) | |
945 @cindex plink (with psftp method) | |
946 @cindex PuTTY (with psftp method) | |
947 | |
948 As you would expect, this method is similar to @option{sftp}, but it | |
949 uses the @command{plink} command to connect to the remote host, and it | |
950 uses @command{psftp} for transferring the files. These programs are | |
951 part of PuTTY, an SSH implementation for Windows. | |
952 | |
953 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
|
954 |
45861 | 955 |
956 @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
|
957 @cindex method fcp |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
958 @cindex fcp method |
46366 | 959 @cindex fsh (with fcp method) |
960 @cindex fcp (with fcp method) | |
45861 | 961 |
962 This method is similar to @option{scp}, but it uses the @command{fsh} | |
963 command to connect to the remote host, and it uses @command{fcp} for | |
964 transferring the files. @command{fsh/fcp} are a front-end for | |
965 @command{ssh} which allow for reusing the same @command{ssh} session | |
966 for submitting several commands. This avoids the startup overhead of | |
967 @command{scp} (which has to establish a secure connection whenever it | |
968 is called). Note, however, that you can also use one of the inline | |
969 methods to achieve a similar effect. | |
970 | |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
971 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
|
972 /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
|
973 @command{fsh @var{host} -l @var{user}}. |
45861 | 974 |
46366 | 975 @cindex method fsh |
976 @cindex fsh method | |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
977 |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
978 There is no inline method using @command{fsh} as the multiplexing |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
979 provided by the program is not very useful in our context. @value{tramp} |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
980 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
|
981 anyway. |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
982 |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
983 |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
984 @item @option{ftp} |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
985 @cindex method ftp |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
986 @cindex ftp method |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
987 |
81759 | 988 This is not a native @value{tramp} method. Instead of, it forwards all |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
989 requests to @value{ftppackagename}. |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
990 @ifset xemacs |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
991 This works only for unified filenames, see @ref{Issues}. |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
992 @end ifset |
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
993 |
48974
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
994 |
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
995 @item @option{smb} --- @command{smbclient} |
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
996 @cindex method smb |
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
997 @cindex smb method |
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
998 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
999 This is another not natural @value{tramp} method. It uses the |
48974
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
1000 @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
|
1001 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
|
1002 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
|
1003 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
|
1004 Windows XP. |
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
1005 |
49996
bda88bfc6c5e
Version 2.0.30 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49610
diff
changeset
|
1006 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
|
1007 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
|
1008 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
|
1009 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
|
1010 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
|
1011 |
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
1012 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
|
1013 always for a password if you access another share on the same host. |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1014 This can be suppressed by @ref{Password caching}. |
48974
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
1015 |
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
1016 MS Windows uses for authorization both a user name and a domain name. |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1017 Because of this, the @value{tramp} syntax has been extended: you can |
48974
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
1018 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
|
1019 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
|
1020 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
|
1021 @code{BIZARRE}, and edit @file{.emacs} in the home directory (share |
81759 | 1022 @code{daniel$}) I would specify the filename @file{@trampfn{smb, |
1023 daniel%BIZARRE, melancholia, /daniel$$/.emacs}}. | |
1024 | |
1025 Depending on the Windows domain configuration, a Windows user might be | |
1026 considered as domain user per default. In order to connect as local | |
1027 user, the WINS name of that machine must be given as domain name. | |
1028 Usually, it is the machine name in capital letters. In the example | |
1029 above, the local user @code{daniel} would be specified as | |
1030 @file{@trampfn{smb, daniel%MELANCHOLIA, melancholia, /daniel$$/.emacs}}. | |
48974
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
1031 |
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
1032 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
|
1033 name is specified at all, the anonymous user (without password |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1034 prompting) is assumed. This is different from all other @value{tramp} |
48974
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
1035 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
|
1036 |
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
1037 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
|
1038 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1039 @strong{Please note:} If @value{emacsname} runs locally under MS |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1040 Windows, this method isn't available. Instead of, you can use UNC |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1041 file names like @file{//melancholia/daniel$$/.emacs}. The only |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1042 disadvantage is that there's no possibility to specify another user |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1043 name. |
48974
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
1044 |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
1045 @end table |
45861 | 1046 |
81759 | 1047 |
1048 @ifset emacsgw | |
1049 @node Gateway methods | |
1050 @section Gateway methods | |
1051 @cindex methods, gateway | |
1052 @cindex gateway methods | |
1053 | |
1054 Gateway methods are not methods to access a remote host directly. | |
1055 These methods are intended to pass firewalls or proxy servers. | |
1056 Therefore, they can be used for proxy host declarations | |
1057 (@pxref{Multi-hops}) only. | |
1058 | |
1059 A gateway method must come always along with a method who supports | |
1060 port setting (referred to as @samp{-p} kludge). This is because | |
1061 @value{tramp} targets the accompanied method to | |
1062 @file{localhost#random_port}, from where the firewall or proxy server | |
1063 is accessed to. | |
1064 | |
1065 Gateway methods support user name and password declarations. These | |
1066 are used to authenticate towards the corresponding firewall or proxy | |
1067 server. They can be passed only if your friendly administrator has | |
1068 granted your access. | |
1069 | |
1070 @table @asis | |
1071 @item @option{tunnel} | |
1072 @cindex method tunnel | |
1073 @cindex tunnel method | |
1074 | |
1075 This method implements an HTTP tunnel via the @command{CONNECT} | |
1076 command (see RFC 2616, 2817). Any HTTP 1.1 compliant (proxy) server | |
1077 shall support this command. | |
1078 | |
1079 As authentication method, only @option{Basic Authentication} (see RFC | |
1080 2617) is implemented so far. If no port number is given in the | |
1081 declaration, port @option{8080} is used for the proxy server. | |
1082 | |
1083 | |
1084 @item @option{socks} | |
1085 @cindex method socks | |
1086 @cindex socks method | |
1087 | |
1088 The @command{socks} method provides access to SOCKSv5 servers (see | |
1089 RFC 1928). @option{Username/Password Authentication} according to RFC | |
1090 1929 is supported. | |
1091 | |
1092 The default port number of the socks server is @option{1080}, if not | |
1093 specified otherwise. | |
45861 | 1094 |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
1095 @end table |
81759 | 1096 @end ifset |
45861 | 1097 |
1098 | |
1099 @node Default Method | |
1100 @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
|
1101 @cindex default method |
45861 | 1102 |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
1103 @vindex tramp-default-method |
45861 | 1104 When you select an appropriate transfer method for your typical usage |
53207
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1105 you should set the variable @code{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
|
1106 choice. This variable controls which method will be used when a method |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1107 is not specified in the @value{tramp} file name. For example: |
45861 | 1108 |
1109 @lisp | |
73808
2889a065b1d4
* lisp/net/tramp.el (tramp-default-method): scp is the default method.
Michael Albinus <michael.albinus@gmx.de>
parents:
73425
diff
changeset
|
1110 (setq tramp-default-method "ssh") |
45861 | 1111 @end lisp |
1112 | |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
1113 @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
|
1114 You can also specify different methods for certain user/host |
53207
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1115 combinations, via the variable @code{tramp-default-method-alist}. For |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
1116 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
|
1117 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
|
1118 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
|
1119 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
|
1120 the machine @samp{localhost}. |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
1121 |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
1122 @lisp |
47772
e2d9dd69445b
Move @copying to standard place. Use
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47578
diff
changeset
|
1123 (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
|
1124 (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
|
1125 (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
|
1126 '("\\`localhost\\'" "\\`root\\'" "su")) |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
1127 @end lisp |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
1128 |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
1129 @noindent |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
1130 See the documentation for the variable |
53207
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1131 @code{tramp-default-method-alist} for more details. |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
1132 |
45861 | 1133 External transfer methods are normally preferable to inline transfer |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1134 methods, giving better performance. |
45861 | 1135 |
1136 @xref{Inline methods}. | |
1137 @xref{External transfer methods}. | |
1138 | |
1139 Another consideration with the selection of transfer methods is the | |
1140 environment you will use them in and, especially when used over the | |
1141 Internet, the security implications of your preferred method. | |
1142 | |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1143 The @option{rsh} and @option{telnet} methods send your password as |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1144 plain text as you log in to the remote machine, as well as |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1145 transferring the files in such a way that the content can easily be |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1146 read from other machines. |
45861 | 1147 |
1148 If you need to connect to remote systems that are accessible from the | |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1149 Internet, you should give serious thought to using @option{ssh} based |
81759 | 1150 methods to connect. These provide a much higher level of security, |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1151 making it a non-trivial exercise for someone to obtain your password |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1152 or read the content of the files you are editing. |
45861 | 1153 |
53207
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1154 |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1155 @subsection Which method is the right one for me? |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1156 @cindex choosing the right method |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1157 |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1158 Given all of the above, you are probably thinking that this is all fine |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1159 and good, but it's not helping you to choose a method! Right you are. |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1160 As a developer, we don't want to boss our users around but give them |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1161 maximum freedom instead. However, the reality is that some users would |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1162 like to have some guidance, so here I'll try to give you this guidance |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1163 without bossing you around. You tell me whether it works @dots{} |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1164 |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1165 My suggestion is to use an inline method. For large files, out-of-band |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1166 methods might be more efficient, but I guess that most people will want |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1167 to edit mostly small files. |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1168 |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1169 I guess that these days, most people can access a remote machine by |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1170 using @command{ssh}. So I suggest that you use the @option{ssh} |
81759 | 1171 method. So, type @kbd{C-x C-f @trampfn{ssh, root, otherhost, |
1172 /etc/motd} @key{RET}} to edit the @file{/etc/motd} file on the other | |
1173 host. | |
53207
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1174 |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1175 If you can't use @option{ssh} to log in to the remote host, then |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1176 select a method that uses a program that works. For instance, Windows |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1177 users might like the @option{plink} method which uses the PuTTY |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1178 implementation of @command{ssh}. Or you use Kerberos and thus like |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1179 @option{krlogin}. |
53207
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1180 |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1181 For the special case of editing files on the local host as another |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1182 user, see the @option{su} or @option{sudo} methods. They offer |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1183 shortened syntax for the @samp{root} account, like |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
1184 @file{@trampfn{su, , , /etc/motd}}. |
81759 | 1185 |
1186 People who edit large files may want to consider @option{scpc} instead | |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1187 of @option{ssh}, or @option{pscp} instead of @option{plink}. These |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1188 out-of-band methods are faster than inline methods for large files. |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1189 Note, however, that out-of-band methods suffer from some limitations. |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1190 Please try first whether you really get a noticeable speed advantage |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1191 from using an out-of-band method! Maybe even for large files, inline |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1192 methods are fast enough. |
53207
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1193 |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1194 |
81759 | 1195 @node Default User |
1196 @section Selecting a default user | |
1197 @cindex default user | |
1198 | |
1199 The user part of a @value{tramp} file name can be omitted. Usually, | |
1200 it is replaced by the user name you are logged in. Often, this is not | |
1201 what you want. A typical use of @value{tramp} might be to edit some | |
1202 files with root permissions on the local host. This case, you should | |
1203 set the variable @code{tramp-default-user} to reflect that choice. | |
1204 For example: | |
1205 | |
1206 @lisp | |
1207 (setq tramp-default-user "root") | |
1208 @end lisp | |
1209 | |
1210 @code{tramp-default-user} is regarded as obsolete, and will be removed | |
1211 soon. | |
1212 | |
1213 @vindex tramp-default-user-alist | |
1214 You can also specify different users for certain method/host | |
1215 combinations, via the variable @code{tramp-default-user-alist}. For | |
1216 example, if you always have to use the user @samp{john} in the domain | |
1217 @samp{somewhere.else}, you can specify the following: | |
1218 | |
1219 @lisp | |
1220 (add-to-list 'tramp-default-user-alist | |
1221 '("ssh" ".*\\.somewhere\\.else\\'" "john")) | |
1222 @end lisp | |
1223 | |
1224 @noindent | |
1225 See the documentation for the variable | |
1226 @code{tramp-default-user-alist} for more details. | |
1227 | |
1228 One trap to fall in must be known. If @value{tramp} finds a default | |
1229 user, this user will be passed always to the connection command as | |
1230 parameter (for example @samp{ssh here.somewhere.else -l john}. If you | |
1231 have specified another user for your command in its configuration | |
1232 files, @value{tramp} cannot know it, and the remote access will fail. | |
1233 If you have specified in the given example in @file{~/.ssh/config} the | |
1234 lines | |
1235 | |
1236 @example | |
1237 Host here.somewhere.else | |
1238 User lily | |
1239 @end example | |
1240 | |
1241 @noindent | |
1242 than you must discard selecting a default user by @value{tramp}. This | |
1243 will be done by setting it to @code{nil} (or @samp{lily}, likewise): | |
1244 | |
1245 @lisp | |
1246 (add-to-list 'tramp-default-user-alist | |
1247 '("ssh" "\\`here\\.somewhere\\.else\\'" nil)) | |
1248 @end lisp | |
1249 | |
1250 The last entry in @code{tramp-default-user-alist} could be your | |
1251 default user you'll apply predominantly. You shall @emph{append} it | |
1252 to that list at the end: | |
1253 | |
1254 @lisp | |
1255 (add-to-list 'tramp-default-user-alist '(nil nil "jonas") t) | |
1256 @end lisp | |
1257 | |
1258 | |
1259 @node Default Host | |
1260 @section Selecting a default host | |
1261 @cindex default host | |
1262 | |
1263 @vindex tramp-default-host | |
1264 Finally, it is even possible to omit the host name part of a | |
1265 @value{tramp} file name. This case, the value of the variable | |
1266 @code{tramp-default-host} is used. Per default, it is initialized | |
1267 with the host name your local @value{emacsname} is running. | |
1268 | |
1269 If you, for example, use @value{tramp} mainly to contact the host | |
1270 @samp{target} as user @samp{john}, you can specify: | |
1271 | |
1272 @lisp | |
1273 (setq tramp-default-user "john" | |
1274 tramp-default-host "target") | |
1275 @end lisp | |
1276 | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
1277 Then the simple file name @samp{@trampfn{ssh, , ,}} will connect you |
81759 | 1278 to John's home directory on target. |
1279 @ifset emacs | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
1280 Note, however, that the most simplification @samp{/::} won't work, |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
1281 because @samp{/:} is the prefix for quoted file names. |
81759 | 1282 @end ifset |
1283 | |
1284 | |
1285 @node Multi-hops | |
1286 @section Connecting to a remote host using multiple hops | |
1287 @cindex multi-hop | |
1288 @cindex proxy hosts | |
1289 | |
1290 Sometimes, the methods described before are not sufficient. Sometimes, | |
1291 it is not possible to connect to a remote host using a simple command. | |
1292 For example, if you are in a secured network, you might have to log in | |
1293 to a `bastion host' first before you can connect to the outside world. | |
1294 Of course, the target host may also require a bastion host. | |
1295 | |
1296 @vindex tramp-default-proxies-alist | |
1297 In order to specify such multiple hops, it is possible to define a proxy | |
1298 host to pass through, via the variable | |
1299 @code{tramp-default-proxies-alist}. This variable keeps a list of | |
1300 triples (@var{host} @var{user} @var{proxy}). | |
1301 | |
1302 The first matching item specifies the proxy host to be passed for a | |
1303 file name located on a remote target matching @var{user}@@@var{host}. | |
1304 @var{host} and @var{user} are regular expressions or @code{nil}, which | |
1305 is interpreted as a regular expression which always matches. | |
1306 | |
1307 @var{proxy} must be a Tramp filename which localname part is ignored. | |
1308 Method and user name on @var{proxy} are optional, which is interpreted | |
1309 with the default values. | |
1310 @ifset emacsgw | |
1311 The method must be an inline or gateway method (@pxref{Inline | |
1312 methods}, @pxref{Gateway methods}). | |
1313 @end ifset | |
1314 @ifclear emacsgw | |
1315 The method must be an inline method (@pxref{Inline methods}). | |
1316 @end ifclear | |
1317 If @var{proxy} is @code{nil}, no additional hop is required reaching | |
1318 @var{user}@@@var{host}. | |
1319 | |
1320 If you, for example, must pass the host @samp{bastion.your.domain} as | |
1321 user @samp{bird} for any remote host which is not located in your local | |
1322 domain, you can set | |
1323 | |
1324 @lisp | |
1325 (add-to-list 'tramp-default-proxies-alist | |
1326 '("\\." nil "@trampfn{ssh, bird, bastion.your.domain,}")) | |
1327 (add-to-list 'tramp-default-proxies-alist | |
1328 '("\\.your\\.domain\\'" nil nil)) | |
1329 @end lisp | |
1330 | |
1331 Please note the order of the code. @code{add-to-list} adds elements at the | |
1332 beginning of a list. Therefore, most relevant rules must be added last. | |
1333 | |
1334 Proxy hosts can be cascaded. If there is another host called | |
1335 @samp{jump.your.domain}, which is the only one in your local domain who | |
1336 is allowed connecting @samp{bastion.your.domain}, you can add another | |
1337 rule: | |
1338 | |
1339 @lisp | |
1340 (add-to-list 'tramp-default-proxies-alist | |
1341 '("\\`bastion\\.your\\.domain\\'" | |
1342 "\\`bird\\'" | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
1343 "@trampfn{ssh, , jump.your.domain,}")) |
81759 | 1344 @end lisp |
1345 | |
1346 @var{proxy} can contain the patterns @code{%h} or @code{%u}. These | |
1347 patterns are replaced by the strings matching @var{host} or | |
1348 @var{user}, respectively. | |
1349 | |
1350 If you, for example, wants to work as @samp{root} on hosts in the | |
1351 domain @samp{your.domain}, but login as @samp{root} is disabled for | |
1352 non-local access, you might add the following rule: | |
1353 | |
1354 @lisp | |
1355 (add-to-list 'tramp-default-proxies-alist | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
1356 '("\\.your\\.domain\\'" "\\`root\\'" "@trampfn{ssh, , %h,}")) |
81759 | 1357 @end lisp |
1358 | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
1359 Opening @file{@trampfn{sudo, , randomhost.your.domain,}} would connect |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
1360 first @samp{randomhost.your.domain} via @code{ssh} under your account |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
1361 name, and perform @code{sudo -u root} on that host afterwards. It is |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
1362 important to know that the given method is applied on the host which |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
1363 has been reached so far. @code{sudo -u root}, applied on your local |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
1364 host, wouldn't be useful here. |
81759 | 1365 |
1366 This is the recommended configuration to work as @samp{root} on remote | |
1367 Ubuntu hosts. | |
1368 | |
1369 @ifset emacsgw | |
1370 Finally, @code{tramp-default-proxies-alist} can be used to pass | |
1371 firewalls or proxy servers. Imagine your local network has a host | |
1372 @samp{proxy.your.domain} which is used on port 3128 as HTTP proxy to | |
1373 the outer world. Your friendly administrator has granted you access | |
1374 under your user name to @samp{host.other.domain} on that proxy | |
1375 server.@footnote{HTTP tunnels are intended for secure SSL/TLS | |
1376 communication. Therefore, many proxy server restrict the tunnels to | |
1377 related target ports. You might need to run your ssh server on your | |
1378 target host @samp{host.other.domain} on such a port, like 443 (https). | |
1379 See @uref{http://savannah.gnu.org/maintenance/CvsFromBehindFirewall} | |
1380 for discussion of ethical issues.} You would need to add the | |
1381 following rule: | |
1382 | |
1383 @lisp | |
1384 (add-to-list 'tramp-default-proxies-alist | |
1385 '("\\`host\\.other\\.domain\\'" nil | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
1386 "@trampfn{tunnel, , proxy.your.domain#3128,}")) |
81759 | 1387 @end lisp |
1388 | |
1389 Gateway methods can be declared as first hop only in a multiple hop | |
1390 chain. | |
1391 @end ifset | |
1392 | |
1393 | |
45861 | 1394 @node Customizing Methods |
1395 @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
|
1396 @cindex customizing methods |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
1397 @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
|
1398 @cindex create your own methods |
45861 | 1399 |
1400 There is a variable @code{tramp-methods} which you can change if the | |
1401 predefined methods don't seem right. | |
1402 | |
1403 For the time being, I'll refer you to the Lisp documentation of that | |
1404 variable, accessible with @kbd{C-h v tramp-methods @key{RET}}. | |
1405 | |
1406 | |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1407 @node Customizing Completion |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1408 @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
|
1409 @cindex customizing completion |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1410 @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
|
1411 @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
|
1412 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1413 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
|
1414 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
|
1415 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
|
1416 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
|
1417 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
|
1418 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
|
1419 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1420 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
|
1421 @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
|
1422 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
|
1423 this variable: |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1424 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1425 @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
|
1426 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
|
1427 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1428 Example: |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1429 @example |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1430 (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
|
1431 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1432 @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
|
1433 (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
|
1434 @end example |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1435 @end defun |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1436 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1437 @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
|
1438 This function sets @var{function-list} as list of completion functions |
52869
4c969f6bcb01
(Inline methods): Small grammar fix.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
1439 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
|
1440 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1441 Example: |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1442 @example |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1443 (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
|
1444 '((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
|
1445 (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
|
1446 |
ffda74ab6dc4
2003-02-05 Kai Gro?ohann <kai.grossjohann@uni-duisburg.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49600
diff
changeset
|
1447 @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
|
1448 (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
|
1449 @end example |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1450 @end defun |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1451 |
49610
ffda74ab6dc4
2003-02-05 Kai Gro?ohann <kai.grossjohann@uni-duisburg.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49600
diff
changeset
|
1452 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
|
1453 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1454 @table @asis |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1455 @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
|
1456 @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
|
1457 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1458 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
|
1459 @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
|
1460 specified. |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1461 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1462 @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
|
1463 @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
|
1464 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1465 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
|
1466 @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
|
1467 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
|
1468 |
49610
ffda74ab6dc4
2003-02-05 Kai Gro?ohann <kai.grossjohann@uni-duisburg.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49600
diff
changeset
|
1469 @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
|
1470 @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
|
1471 |
51604
f57bfce0ddaf
Version 2.0.35 of Tramp released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50495
diff
changeset
|
1472 This function returns the host nicknames defined by @code{Host} entries |
49610
ffda74ab6dc4
2003-02-05 Kai Gro?ohann <kai.grossjohann@uni-duisburg.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49600
diff
changeset
|
1473 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
|
1474 |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1475 @item @code{tramp-parse-shostkeys} |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1476 @findex tramp-parse-shostkeys |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1477 |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1478 SSH2 parsing of directories @file{/etc/ssh2/hostkeys/*} and |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1479 @file{~/ssh2/hostkeys/*}. Hosts are coded in file names |
63710
d20f7349d704
(Customizing Completion, Auto-save and Backup): Texinfo usage fixes.
Richard M. Stallman <rms@gnu.org>
parents:
63669
diff
changeset
|
1480 @file{hostkey_@var{portnumber}_@var{host-name}.pub}. User names |
d20f7349d704
(Customizing Completion, Auto-save and Backup): Texinfo usage fixes.
Richard M. Stallman <rms@gnu.org>
parents:
63669
diff
changeset
|
1481 are always @code{nil}. |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1482 |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1483 @item @code{tramp-parse-sknownhosts} |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1484 @findex tramp-parse-shostkeys |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1485 |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1486 Another SSH2 style parsing of directories like |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1487 @file{/etc/ssh2/knownhosts/*} and @file{~/ssh2/knownhosts/*}. This |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1488 case, hosts names are coded in file names |
63710
d20f7349d704
(Customizing Completion, Auto-save and Backup): Texinfo usage fixes.
Richard M. Stallman <rms@gnu.org>
parents:
63669
diff
changeset
|
1489 @file{@var{host-name}.@var{algorithm}.pub}. User names are always @code{nil}. |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1490 |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1491 @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
|
1492 @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
|
1493 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1494 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
|
1495 host names only. |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1496 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1497 @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
|
1498 @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
|
1499 |
47578
6e910ba94c42
Version 2.0.22 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47577
diff
changeset
|
1500 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
|
1501 can return user names only. |
6e910ba94c42
Version 2.0.22 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47577
diff
changeset
|
1502 |
6e910ba94c42
Version 2.0.22 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47577
diff
changeset
|
1503 @item @code{tramp-parse-netrc} |
6e910ba94c42
Version 2.0.22 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47577
diff
changeset
|
1504 @findex tramp-parse-netrc |
6e910ba94c42
Version 2.0.22 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47577
diff
changeset
|
1505 |
6e910ba94c42
Version 2.0.22 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47577
diff
changeset
|
1506 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
|
1507 @end table |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1508 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1509 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
|
1510 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
|
1511 the following conventions: |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1512 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1513 @defun my-tramp-parse file |
81759 | 1514 @var{file} must be either a file name on your host, or @code{nil}. |
1515 The function must return a list of (@var{user} @var{host}), which are | |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1516 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
|
1517 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1518 Example: |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1519 @example |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1520 (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
|
1521 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1522 @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
|
1523 @end example |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1524 @end defun |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1525 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1526 |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1527 @node Password caching |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1528 @section Reusing passwords for several connections. |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1529 @cindex passwords |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1530 |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1531 Sometimes it is necessary to connect to the same remote host several |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1532 times. Reentering passwords again and again would be annoying, when |
71224
b7261e09f8e4
* cc-mode.texi (Getting Started, Indentation Commands, Config Basics)
Romain Francoise <romain@orebokech.com>
parents:
71068
diff
changeset
|
1533 the chosen method does not support access without password prompt |
b7261e09f8e4
* cc-mode.texi (Getting Started, Indentation Commands, Config Basics)
Romain Francoise <romain@orebokech.com>
parents:
71068
diff
changeset
|
1534 through own configuration. |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1535 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1536 By default, @value{tramp} caches the passwords entered by you. They will |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1537 be reused next time if a connection needs them for the same user name |
71224
b7261e09f8e4
* cc-mode.texi (Getting Started, Indentation Commands, Config Basics)
Romain Francoise <romain@orebokech.com>
parents:
71068
diff
changeset
|
1538 and host name, independently of the connection method. |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1539 |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1540 @vindex password-cache-expiry |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1541 Passwords are not saved permanently, that means the password caching |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1542 is limited to the lifetime of your @value{emacsname} session. You |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1543 can influence the lifetime of password caching by customizing the |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1544 variable @code{password-cache-expiry}. The value is the number of |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1545 seconds how long passwords are cached. Setting it to @code{nil} |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1546 disables the expiration. |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1547 |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1548 @findex tramp-clear-passwd |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1549 A password is removed from the cache if a connection isn't established |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1550 successfully. You can remove a password from the cache also by |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1551 executing @kbd{M-x tramp-clear-passwd} in a buffer containing a |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1552 related remote file or directory. |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1553 |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1554 @vindex password-cache |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1555 If you don't like this feature for security reasons, password caching |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1556 can be disabled totally by customizing the variable |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1557 @code{password-cache} (setting it to @code{nil}). |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1558 |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1559 Implementation Note: password caching is based on the package |
81759 | 1560 @file{password.el} in No Gnus. For the time being, it is activated |
1561 only when this package is seen in the @code{load-path} while loading | |
1562 @value{tramp}. | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1563 @ifset installchapter |
81759 | 1564 If you don't use No Gnus, you can take @file{password.el} from the |
1565 @value{tramp} @file{contrib} directory, see @ref{Installation | |
1566 parameters}. | |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1567 @end ifset |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1568 It will be activated mandatory once No Gnus has found its way into |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1569 @value{emacsname}. |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1570 |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1571 |
81759 | 1572 @node Connection caching |
1573 @section Reusing connection related information. | |
1574 @cindex caching | |
1575 | |
1576 @vindex tramp-persistency-file-name | |
1577 In order to reduce initial connection time, @value{tramp} stores | |
1578 connection related information persistently. The variable | |
1579 @code{tramp-persistency-file-name} keeps the file name where these | |
1580 information are written. Its default value is | |
1581 @ifset emacs | |
1582 @file{~/.emacs.d/tramp}. | |
1583 @end ifset | |
1584 @ifset xemacs | |
1585 @file{~/.xemacs/tramp}. | |
1586 @end ifset | |
1587 It is recommended to choose a local file name. | |
1588 | |
1589 @value{tramp} reads this file during startup, and writes it when | |
1590 exiting @value{emacsname}. You can simply remove this file if | |
1591 @value{tramp} shall be urged to recompute these information next | |
1592 @value{emacsname} startup time. | |
1593 | |
1594 Using such persistent information can be disabled by setting | |
1595 @code{tramp-persistency-file-name} to @code{nil}. | |
1596 | |
1597 | |
45861 | 1598 @node Remote Programs |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1599 @section How @value{tramp} finds and uses programs on the remote machine. |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1600 |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1601 @value{tramp} depends on a number of programs on the remote host in order to |
45861 | 1602 function, including @command{ls}, @command{test}, @command{find} and |
1603 @command{cat}. | |
1604 | |
1605 In addition to these required tools, there are various tools that may be | |
81759 | 1606 required based on the connection method. See @ref{Inline methods} and |
45861 | 1607 @ref{External transfer methods} for details on these. |
1608 | |
1609 Certain other tools, such as @command{perl} (or @command{perl5}) and | |
81759 | 1610 @command{grep} will be used if they can be found. When they are |
45861 | 1611 available, they are used to improve the performance and accuracy of |
1612 remote file access. | |
1613 | |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
1614 @vindex tramp-remote-path |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1615 When @value{tramp} connects to the remote machine, it searches for the |
81759 | 1616 programs that it can use. The variable @code{tramp-remote-path} |
1617 controls the directories searched on the remote machine. | |
45861 | 1618 |
1619 By default, this is set to a reasonable set of defaults for most | |
81759 | 1620 machines. The symbol @code{tramp-default-remote-path} is a place |
1621 holder, it is replaced by the list of directories received via the | |
1622 command @command{getconf PATH} on your remote machine. For example, | |
1623 on GNU Debian this is @file{/bin:/usr/bin}, whereas on Solaris this is | |
1624 @file{/usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin}. It is | |
1625 recommended to apply this symbol on top of @code{tramp-remote-path}. | |
1626 | |
1627 It is possible, however, that your local (or remote ;) system | |
45861 | 1628 administrator has put the tools you want in some obscure local |
1629 directory. | |
1630 | |
82604
e6c6021c376b
* tramp.texi (Remote Programs): Persistency file must be cleared when
Michael Albinus <michael.albinus@gmx.de>
parents:
82200
diff
changeset
|
1631 In this case, you can still use them with @value{tramp}. You simply |
e6c6021c376b
* tramp.texi (Remote Programs): Persistency file must be cleared when
Michael Albinus <michael.albinus@gmx.de>
parents:
82200
diff
changeset
|
1632 need to add code to your @file{.emacs} to add the directory to the |
e6c6021c376b
* tramp.texi (Remote Programs): Persistency file must be cleared when
Michael Albinus <michael.albinus@gmx.de>
parents:
82200
diff
changeset
|
1633 remote path. This will then be searched by @value{tramp} when you |
e6c6021c376b
* tramp.texi (Remote Programs): Persistency file must be cleared when
Michael Albinus <michael.albinus@gmx.de>
parents:
82200
diff
changeset
|
1634 connect and the software found. |
45861 | 1635 |
1636 To add a directory to the remote search path, you could use code such | |
1637 as: | |
1638 | |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1639 @lisp |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1640 @i{;; We load @value{tramp} to define the variable.} |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1641 (require 'tramp) |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1642 @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
|
1643 (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
|
1644 @end lisp |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1645 |
82604
e6c6021c376b
* tramp.texi (Remote Programs): Persistency file must be cleared when
Michael Albinus <michael.albinus@gmx.de>
parents:
82200
diff
changeset
|
1646 @value{tramp} caches several information, like the Perl binary |
e6c6021c376b
* tramp.texi (Remote Programs): Persistency file must be cleared when
Michael Albinus <michael.albinus@gmx.de>
parents:
82200
diff
changeset
|
1647 location. The changed remote search path wouldn't affect these |
e6c6021c376b
* tramp.texi (Remote Programs): Persistency file must be cleared when
Michael Albinus <michael.albinus@gmx.de>
parents:
82200
diff
changeset
|
1648 settings. In order to force @value{tramp} to recompute these values, |
e6c6021c376b
* tramp.texi (Remote Programs): Persistency file must be cleared when
Michael Albinus <michael.albinus@gmx.de>
parents:
82200
diff
changeset
|
1649 you must exit @value{emacsname}, remove your persistency file |
e6c6021c376b
* tramp.texi (Remote Programs): Persistency file must be cleared when
Michael Albinus <michael.albinus@gmx.de>
parents:
82200
diff
changeset
|
1650 (@pxref{Connection caching}), and restart @value{emacsname}. |
e6c6021c376b
* tramp.texi (Remote Programs): Persistency file must be cleared when
Michael Albinus <michael.albinus@gmx.de>
parents:
82200
diff
changeset
|
1651 |
45861 | 1652 |
1653 @node Remote shell setup | |
1654 @comment node-name, next, previous, up | |
1655 @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
|
1656 @cindex remote shell setup |
46366 | 1657 @cindex @file{.profile} file |
1658 @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
|
1659 @cindex shell init files |
45861 | 1660 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1661 As explained in the @ref{Overview} section, @value{tramp} connects to the |
45861 | 1662 remote host and talks to the shell it finds there. Of course, when you |
1663 log in, the shell executes its init files. Suppose your init file | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1664 requires you to enter the birth date of your mother; clearly @value{tramp} |
45861 | 1665 does not know this and hence fails to log you in to that host. |
1666 | |
1667 There are different possible strategies for pursuing this problem. One | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1668 strategy is to enable @value{tramp} to deal with all possible situations. |
45861 | 1669 This is a losing battle, since it is not possible to deal with |
1670 @emph{all} situations. The other strategy is to require you to set up | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1671 the remote host such that it behaves like @value{tramp} expects. This might |
45861 | 1672 be inconvenient because you have to invest a lot of effort into shell |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1673 setup before you can begin to use @value{tramp}. |
45861 | 1674 |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1675 The package, therefore, pursues a combined approach. It tries to |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1676 figure out some of the more common setups, and only requires you to |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1677 avoid really exotic stuff. For example, it looks through a list of |
45861 | 1678 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
|
1679 knows that it is not obvious how to check whether a file exists, and |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1680 therefore it tries different possibilities. (On some hosts and |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1681 shells, the command @command{test -e} does the trick, on some hosts |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1682 the shell builtin doesn't work but the program @command{/usr/bin/test |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1683 -e} or @command{/bin/test -e} works. And on still other hosts, |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1684 @command{ls -d} is the right way to do this.) |
45861 | 1685 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1686 Below you find a discussion of a few things that @value{tramp} does not deal |
45861 | 1687 with, and that you therefore have to set up correctly. |
1688 | |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
1689 @table @asis |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
1690 @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
|
1691 @vindex shell-prompt-pattern |
45861 | 1692 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1693 After logging in to the remote host, @value{tramp} has to wait for the remote |
45861 | 1694 shell startup to finish before it can send commands to the remote |
1695 shell. The strategy here is to wait for the shell prompt. In order to | |
1696 recognize the shell prompt, the variable @code{shell-prompt-pattern} has | |
1697 to be set correctly to recognize the shell prompt on the remote host. | |
1698 | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1699 Note that @value{tramp} requires the match for @code{shell-prompt-pattern} |
48974
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
1700 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
|
1701 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
|
1702 suppose your shell prompt is @code{a <b> c $ }. In this case, |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1703 @value{tramp} recognizes the @code{>} character as the end of the prompt, |
48974
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
1704 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
|
1705 |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1706 @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
|
1707 @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
|
1708 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1709 This regular expression is used by @value{tramp} in the same way as |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1710 @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
|
1711 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
|
1712 might be different from the prompt from a local shell --- after all, |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1713 the whole point of @value{tramp} is to log in to remote hosts as a |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1714 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
|
1715 @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
|
1716 @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
|
1717 circumstances. |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1718 |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1719 @item @command{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
|
1720 @cindex Unix command tset |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
1721 @cindex tset Unix command |
45861 | 1722 |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1723 Some people invoke the @command{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
|
1724 scripts which asks the user about the terminal type of the shell. |
81759 | 1725 Maybe some shells ask other questions when they are started. |
1726 @value{tramp} does not know how to answer these questions. There are | |
1727 two approaches for dealing with this problem. One approach is to take | |
1728 care that the shell does not ask any questions when invoked from | |
1729 @value{tramp}. You can do this by checking the @code{TERM} | |
1730 environment variable, it will be set to @code{dumb} when connecting. | |
45861 | 1731 |
1732 @vindex tramp-terminal-type | |
1733 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
|
1734 to @code{dumb}. |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
1735 |
81759 | 1736 @vindex tramp-actions-before-shell |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1737 The other approach is to teach @value{tramp} about these questions. See |
81759 | 1738 the variable @code{tramp-actions-before-shell}. Example: |
1739 | |
1740 @lisp | |
1741 (defconst my-tramp-prompt-regexp | |
1742 (concat (regexp-opt '("Enter the birth date of your mother:") t) | |
1743 "\\s-*") | |
1744 "Regular expression matching my login prompt question.") | |
1745 | |
1746 (defun my-tramp-action (proc vec) | |
1747 "Enter \"19000101\" in order to give a correct answer." | |
1748 (save-window-excursion | |
1749 (with-current-buffer (tramp-get-connection-buffer vec) | |
1750 (tramp-message vec 6 "\n%s" (buffer-string)) | |
1751 (tramp-send-string vec "19000101")))) | |
1752 | |
1753 (add-to-list 'tramp-actions-before-shell | |
1754 '(my-tramp-prompt-regexp my-tramp-action)) | |
1755 @end lisp | |
45861 | 1756 |
53207
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1757 |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1758 @item Environment variables named like users in @file{.profile} |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1759 |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1760 If you have a user named frumple and set the variable @code{FRUMPLE} in |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1761 your shell environment, then this might cause trouble. Maybe rename |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1762 the variable to @code{FRUMPLE_DIR} or the like. |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1763 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1764 This weird effect was actually reported by a @value{tramp} user! |
53207
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1765 |
83d9437acbf3
2003-11-30 Kai Grossjohann <kai.grossjohann@gmx.net>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
52979
diff
changeset
|
1766 |
51967
2693b0669cc1
Tramp 2.0.36 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
51604
diff
changeset
|
1767 @item Non-Bourne commands in @file{.profile} |
2693b0669cc1
Tramp 2.0.36 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
51604
diff
changeset
|
1768 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1769 After logging in to the remote host, @value{tramp} issues the command |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1770 @command{exec /bin/sh}. (Actually, the command is slightly |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1771 different.) When @command{/bin/sh} is executed, it reads some init |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1772 files, such as @file{~/.shrc} or @file{~/.profile}. |
51967
2693b0669cc1
Tramp 2.0.36 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
51604
diff
changeset
|
1773 |
2693b0669cc1
Tramp 2.0.36 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
51604
diff
changeset
|
1774 Now, some people have a login shell which is not @code{/bin/sh} but a |
2693b0669cc1
Tramp 2.0.36 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
51604
diff
changeset
|
1775 Bourne-ish shell such as bash or ksh. Some of these people might put |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1776 their shell setup into the files @file{~/.shrc} or @file{~/.profile}. |
51967
2693b0669cc1
Tramp 2.0.36 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
51604
diff
changeset
|
1777 This way, it is possible for non-Bourne constructs to end up in those |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1778 files. Then, @command{exec /bin/sh} might cause the Bourne shell to |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1779 barf on those constructs. |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1780 |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1781 As an example, imagine somebody putting @command{export FOO=bar} into |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1782 the file @file{~/.profile}. The standard Bourne shell does not |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1783 understand this syntax and will emit a syntax error when it reaches |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1784 this line. |
51967
2693b0669cc1
Tramp 2.0.36 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
51604
diff
changeset
|
1785 |
2693b0669cc1
Tramp 2.0.36 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
51604
diff
changeset
|
1786 Another example is the tilde (@code{~}) character, say when adding |
2693b0669cc1
Tramp 2.0.36 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
51604
diff
changeset
|
1787 @file{~/bin} to @code{$PATH}. Many Bourne shells will not expand this |
2693b0669cc1
Tramp 2.0.36 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
51604
diff
changeset
|
1788 character, and since there is usually no directory whose name consists |
2693b0669cc1
Tramp 2.0.36 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
51604
diff
changeset
|
1789 of the single character tilde, strange things will happen. |
2693b0669cc1
Tramp 2.0.36 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
51604
diff
changeset
|
1790 |
2693b0669cc1
Tramp 2.0.36 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
51604
diff
changeset
|
1791 What can you do about this? |
2693b0669cc1
Tramp 2.0.36 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
51604
diff
changeset
|
1792 |
81759 | 1793 Well, one possibility is to make sure that everything in |
1794 @file{~/.shrc} and @file{~/.profile} on all remote hosts is | |
1795 Bourne-compatible. In the above example, instead of @command{export | |
1796 FOO=bar}, you might use @command{FOO=bar; export FOO} instead. | |
51967
2693b0669cc1
Tramp 2.0.36 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
51604
diff
changeset
|
1797 |
2693b0669cc1
Tramp 2.0.36 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
51604
diff
changeset
|
1798 The other possibility is to put your non-Bourne shell setup into some |
2693b0669cc1
Tramp 2.0.36 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
51604
diff
changeset
|
1799 other files. For example, bash reads the file @file{~/.bash_profile} |
2693b0669cc1
Tramp 2.0.36 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
51604
diff
changeset
|
1800 instead of @file{~/.profile}, if the former exists. So bash |
2693b0669cc1
Tramp 2.0.36 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
51604
diff
changeset
|
1801 aficionados just rename their @file{~/.profile} to |
2693b0669cc1
Tramp 2.0.36 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
51604
diff
changeset
|
1802 @file{~/.bash_profile} on all remote hosts, and Bob's your uncle. |
2693b0669cc1
Tramp 2.0.36 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
51604
diff
changeset
|
1803 |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1804 The @value{tramp} developers would like to circumvent this problem, so |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1805 if you have an idea about it, please tell us. However, we are afraid |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1806 it is not that simple: before saying @command{exec /bin/sh}, |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1807 @value{tramp} does not know which kind of shell it might be talking |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1808 to. It could be a Bourne-ish shell like ksh or bash, or it could be a |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1809 csh derivative like tcsh, or it could be zsh, or even rc. If the |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1810 shell is Bourne-ish already, then it might be prudent to omit the |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1811 @command{exec /bin/sh} step. But how to find out if the shell is |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1812 Bourne-ish? |
51967
2693b0669cc1
Tramp 2.0.36 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
51604
diff
changeset
|
1813 |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
1814 @end table |
45861 | 1815 |
1816 | |
50338
155b4b78aa3b
* tramp.el: Version 2.0.31 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49996
diff
changeset
|
1817 @node Auto-save and Backup |
155b4b78aa3b
* tramp.el: Version 2.0.31 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49996
diff
changeset
|
1818 @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
|
1819 @cindex auto-save |
155b4b78aa3b
* tramp.el: Version 2.0.31 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49996
diff
changeset
|
1820 @cindex backup |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1821 @ifset emacs |
50338
155b4b78aa3b
* tramp.el: Version 2.0.31 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49996
diff
changeset
|
1822 @vindex backup-directory-alist |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1823 @end ifset |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1824 @ifset xemacs |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1825 @vindex bkup-backup-directory-info |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1826 @end ifset |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1827 |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1828 Normally, @value{emacsname} writes backup files to the same directory |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1829 as the original files, but this behavior can be changed via the |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1830 variable |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1831 @ifset emacs |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1832 @code{backup-directory-alist}. |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1833 @end ifset |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1834 @ifset xemacs |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1835 @code{bkup-backup-directory-info}. |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1836 @end ifset |
81759 | 1837 In connection with @value{tramp}, this can have unexpected side |
1838 effects. Suppose that you specify that all backups should go to the | |
1839 directory @file{~/.emacs.d/backups/}, and then you edit the file | |
1840 @file{@trampfn{su, root, localhost, /etc/secretfile}}. The effect is | |
1841 that the backup file will be owned by you and not by root, thus | |
1842 possibly enabling others to see it even if they were not intended to | |
1843 see it. | |
50338
155b4b78aa3b
* tramp.el: Version 2.0.31 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49996
diff
changeset
|
1844 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1845 When |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1846 @ifset emacs |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1847 @code{backup-directory-alist} |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1848 @end ifset |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1849 @ifset xemacs |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1850 @code{bkup-backup-directory-info} |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1851 @end ifset |
63710
d20f7349d704
(Customizing Completion, Auto-save and Backup): Texinfo usage fixes.
Richard M. Stallman <rms@gnu.org>
parents:
63669
diff
changeset
|
1852 is @code{nil} (the default), such problems do not occur. |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1853 |
71224
b7261e09f8e4
* cc-mode.texi (Getting Started, Indentation Commands, Config Basics)
Romain Francoise <romain@orebokech.com>
parents:
71068
diff
changeset
|
1854 Therefore, it is useful to set special values for @value{tramp} |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1855 files. For example, the following statement effectively `turns off' |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1856 the effect of |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1857 @ifset emacs |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1858 @code{backup-directory-alist} |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1859 @end ifset |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1860 @ifset xemacs |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1861 @code{bkup-backup-directory-info} |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1862 @end ifset |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1863 for @value{tramp} files: |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1864 |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1865 @ifset emacs |
50338
155b4b78aa3b
* tramp.el: Version 2.0.31 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49996
diff
changeset
|
1866 @lisp |
155b4b78aa3b
* tramp.el: Version 2.0.31 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49996
diff
changeset
|
1867 (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
|
1868 (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
|
1869 @end lisp |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1870 @end ifset |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1871 @ifset xemacs |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1872 @lisp |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1873 (require 'backup-dir) |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1874 (add-to-list 'bkup-backup-directory-info |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1875 (list tramp-file-name-regexp "")) |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1876 @end lisp |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1877 @end ifset |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1878 |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1879 Another possibility is to use the @value{tramp} variable |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1880 @ifset emacs |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1881 @code{tramp-backup-directory-alist}. |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1882 @end ifset |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1883 @ifset xemacs |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1884 @code{tramp-bkup-backup-directory-info}. |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1885 @end ifset |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1886 This variable has the same meaning like |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1887 @ifset emacs |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1888 @code{backup-directory-alist}. |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1889 @end ifset |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1890 @ifset xemacs |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1891 @code{bkup-backup-directory-info}. |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1892 @end ifset |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1893 If a @value{tramp} file is backed up, and DIRECTORY is an absolute |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1894 local file name, DIRECTORY is prepended with the @value{tramp} file |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1895 name prefix of the file to be backed up. |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1896 |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1897 @noindent |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1898 Example: |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1899 |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1900 @ifset emacs |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1901 @lisp |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1902 (add-to-list 'backup-directory-alist |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1903 (cons "." "~/.emacs.d/backups/")) |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1904 (setq tramp-backup-directory-alist backup-directory-alist) |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1905 @end lisp |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1906 @end ifset |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1907 @ifset xemacs |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1908 @lisp |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1909 (require 'backup-dir) |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1910 (add-to-list 'bkup-backup-directory-info |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1911 (list "." "~/.emacs.d/backups/" 'full-path)) |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1912 (setq tramp-bkup-backup-directory-info bkup-backup-directory-info) |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1913 @end lisp |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1914 @end ifset |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1915 |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1916 @noindent |
81759 | 1917 The backup file name of @file{@trampfn{su, root, localhost, |
1918 /etc/secretfile}} would be | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1919 @ifset emacs |
81759 | 1920 @file{@trampfn{su, root, localhost, |
1921 ~/.emacs.d/backups/!su:root@@localhost:!etc!secretfile~}} | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1922 @end ifset |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1923 @ifset xemacs |
81759 | 1924 @file{@trampfn{su, root, localhost, |
1925 ~/.emacs.d/backups/![su!root@@localhost]!etc!secretfile~}} | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1926 @end ifset |
50338
155b4b78aa3b
* tramp.el: Version 2.0.31 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49996
diff
changeset
|
1927 |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1928 The same problem can happen with auto-saving files. |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1929 @ifset emacs |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1930 Since @value{emacsname} 21, the variable |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1931 @code{auto-save-file-name-transforms} keeps information, on which |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1932 directory an auto-saved file should go. By default, it is initialized |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1933 for @value{tramp} files to the local temporary directory. |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1934 |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1935 On some versions of @value{emacsname}, namely the version built for |
60763
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
1936 Debian GNU/Linux, the variable @code{auto-save-file-name-transforms} |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1937 contains the directory where @value{emacsname} was built. A |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1938 workaround is to manually set the variable to a sane value. |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1939 |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1940 If auto-saved files should go into the same directory as the original |
63669
2fd498512c5d
(Customizing Completion, Auto-save and Backup): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63636
diff
changeset
|
1941 files, @code{auto-save-file-name-transforms} should be set to @code{nil}. |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1942 |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1943 Another possibility is to set the variable |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1944 @code{tramp-auto-save-directory} to a proper value. |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1945 @end ifset |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1946 @ifset xemacs |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1947 For this purpose you can set the variable @code{auto-save-directory} |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1948 to a proper value. |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1949 @end ifset |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1950 |
50338
155b4b78aa3b
* tramp.el: Version 2.0.31 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49996
diff
changeset
|
1951 |
45861 | 1952 @node Windows setup hints |
1953 @section Issues with Cygwin ssh | |
46366 | 1954 @cindex Cygwin, issues |
45861 | 1955 |
1956 This section needs a lot of work! Please help. | |
1957 | |
48974
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
1958 @cindex method sshx with Cygwin |
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
1959 @cindex sshx method with Cygwin |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1960 The recent Cygwin installation of @command{ssh} works only with a |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1961 Cygwinized @value{emacsname}. You can check it by typing @kbd{M-x |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1962 eshell}, and starting @kbd{ssh test.machine}. The problem is evident |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1963 if you see a message like this: |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1964 |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1965 @example |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1966 Pseudo-terminal will not be allocated because stdin is not a terminal. |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1967 @end example |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1968 |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1969 Older @command{ssh} versions of Cygwin are told to cooperate with |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1970 @value{tramp} selecting @option{sshx} as the connection method. You |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1971 can find information about setting up Cygwin in their FAQ at |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1972 @uref{http://cygwin.com/faq/}. |
45861 | 1973 |
48974
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
1974 @cindex method scpx with Cygwin |
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
1975 @cindex scpx method with Cygwin |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1976 If you wish to use the @option{scpx} connection method, then you might |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1977 have the problem that @value{emacsname} calls @command{scp} with a |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1978 Windows filename such as @code{c:/foo}. The Cygwin version of |
81759 | 1979 @command{scp} does not know about Windows filenames and interprets |
1980 this as a remote filename on the host @code{c}. | |
48974
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
1981 |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1982 One possible workaround is to write a wrapper script for @option{scp} |
48974
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
1983 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
|
1984 |
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
1985 @cindex Cygwin and ssh-agent |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
1986 @cindex SSH_AUTH_SOCK and @value{emacsname} on Windows |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1987 If you want to use either @option{ssh} based method on Windows, then |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1988 you might encounter problems with @command{ssh-agent}. Using this |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1989 program, you can avoid typing the pass-phrase every time you log in. |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1990 However, if you start @value{emacsname} from a desktop shortcut, then |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1991 the environment variable @code{SSH_AUTH_SOCK} is not set and so |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1992 @value{emacsname} and thus @value{tramp} and thus @command{ssh} and |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1993 @command{scp} started from @value{tramp} cannot communicate with |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1994 @command{ssh-agent}. It works better to start @value{emacsname} from |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
1995 the shell. |
48974
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
1996 |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
1997 If anyone knows how to start @command{ssh-agent} under Windows in such a |
48974
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
1998 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
|
1999 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
|
2000 |
45861 | 2001 |
2002 @node Usage | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2003 @chapter Using @value{tramp} |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2004 @cindex using @value{tramp} |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2005 |
81759 | 2006 Once you have installed @value{tramp} it will operate fairly |
2007 transparently. You will be able to access files on any remote machine | |
2008 that you can log in to as though they were local. | |
45861 | 2009 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2010 Files are specified to @value{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
|
2011 details of the system to connect to. This is similar to the syntax used |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2012 by the @value{ftppackagename} package. |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2013 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2014 @cindex type-ahead |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
2015 Something that might happen which surprises you is that |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2016 @value{emacsname} remembers all your keystrokes, so if you see a |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2017 password prompt from @value{emacsname}, say, and hit @kbd{@key{RET}} |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
2018 twice instead of once, then the second keystroke will be processed by |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2019 @value{emacsname} after @value{tramp} has done its thing. Why, this |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
2020 type-ahead is normal behavior, you say. Right you are, but be aware |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
2021 that opening a remote file might take quite a while, maybe half a |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
2022 minute when a connection needs to be opened. Maybe after half a |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
2023 minute you have already forgotten that you hit that key! |
45861 | 2024 |
2025 @menu | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2026 * Filename Syntax:: @value{tramp} filename conventions. |
81759 | 2027 * Alternative Syntax:: URL-like filename syntax. |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2028 * Filename completion:: Filename completion. |
81827
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2029 * Remote processes:: Integration with other @value{emacsname} packages. |
45861 | 2030 @end menu |
2031 | |
2032 | |
2033 @node Filename Syntax | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2034 @section @value{tramp} filename conventions |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
2035 @cindex filename syntax |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
2036 @cindex filename examples |
45861 | 2037 |
81759 | 2038 To access the file @var{localname} on the remote machine @var{machine} |
82604
e6c6021c376b
* tramp.texi (Remote Programs): Persistency file must be cleared when
Michael Albinus <michael.albinus@gmx.de>
parents:
82200
diff
changeset
|
2039 you would specify the filename @file{@trampfn{, , machine, |
e6c6021c376b
* tramp.texi (Remote Programs): Persistency file must be cleared when
Michael Albinus <michael.albinus@gmx.de>
parents:
82200
diff
changeset
|
2040 localname}}. This will connect to @var{machine} and transfer the file |
e6c6021c376b
* tramp.texi (Remote Programs): Persistency file must be cleared when
Michael Albinus <michael.albinus@gmx.de>
parents:
82200
diff
changeset
|
2041 using the default method. @xref{Default Method}. |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2042 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2043 Some examples of @value{tramp} filenames are shown below. |
45861 | 2044 |
2045 @table @file | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2046 @item @trampfn{, , melancholia, .emacs} |
45861 | 2047 Edit the file @file{.emacs} in your home directory on the machine |
2048 @code{melancholia}. | |
2049 | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2050 @item @trampfn{, , melancholia.danann.net, .emacs} |
45861 | 2051 This edits the same file, using the fully qualified domain name of |
2052 the machine. | |
2053 | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2054 @item @trampfn{, , melancholia, ~/.emacs} |
45861 | 2055 This also edits the same file --- the @file{~} is expanded to your |
2056 home directory on the remote machine, just like it is locally. | |
2057 | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2058 @item @trampfn{, , melancholia, ~daniel/.emacs} |
45861 | 2059 This edits the file @file{.emacs} in the home directory of the user |
81759 | 2060 @code{daniel} on the machine @code{melancholia}. The @file{~<user>} |
45861 | 2061 construct is expanded to the home directory of that user on the remote |
2062 machine. | |
2063 | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2064 @item @trampfn{, , melancholia, /etc/squid.conf} |
45861 | 2065 This edits the file @file{/etc/squid.conf} on the machine |
2066 @code{melancholia}. | |
2067 | |
2068 @end table | |
2069 | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2070 Unless you specify a different name to use, @value{tramp} will use the |
81759 | 2071 current local user name as the remote user name to log in with. If you |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2072 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
|
2073 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
|
2074 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2075 To log in to the remote machine as a specific user, you use the syntax |
82604
e6c6021c376b
* tramp.texi (Remote Programs): Persistency file must be cleared when
Michael Albinus <michael.albinus@gmx.de>
parents:
82200
diff
changeset
|
2076 @file{@trampfn{, user, machine, path/to.file}}. That means that |
e6c6021c376b
* tramp.texi (Remote Programs): Persistency file must be cleared when
Michael Albinus <michael.albinus@gmx.de>
parents:
82200
diff
changeset
|
2077 connecting to @code{melancholia} as @code{daniel} and editing |
e6c6021c376b
* tramp.texi (Remote Programs): Persistency file must be cleared when
Michael Albinus <michael.albinus@gmx.de>
parents:
82200
diff
changeset
|
2078 @file{.emacs} in your home directory you would specify |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2079 @file{@trampfn{, daniel, melancholia, .emacs}}. |
45861 | 2080 |
2081 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
|
2082 (@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
|
2083 @ifset emacs |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2084 This is done by putting the method before the user and host name, as |
81759 | 2085 in @file{@value{prefix}@var{method}@value{postfixhop}} (Note the |
2086 trailing colon). | |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2087 @end ifset |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2088 @ifset xemacs |
81759 | 2089 This is done by replacing the initial @file{@value{prefix}} with |
2090 @file{@value{prefix}<method>@value{postfixhop}}. (Note the trailing | |
2091 slash!). | |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2092 @end ifset |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2093 The user, machine and file specification remain the same. |
45861 | 2094 |
46348 | 2095 So, to connect to the machine @code{melancholia} as @code{daniel}, |
81759 | 2096 using the @option{ssh} method to transfer files, and edit |
2097 @file{.emacs} in my home directory I would specify the filename | |
2098 @file{@trampfn{ssh, daniel, melancholia, .emacs}}. | |
2099 | |
2100 | |
2101 @node Alternative Syntax | |
2102 @section URL-like filename syntax | |
2103 @cindex filename syntax | |
2104 @cindex filename examples | |
2105 | |
2106 Additionally to the syntax described in the previous chapter, it is | |
2107 possible to use a URL-like syntax for @value{tramp}. This can be | |
2108 switched on by customizing the variable @code{tramp-syntax}. Please | |
2109 note that this feature is experimental for the time being. | |
2110 | |
2111 The variable @code{tramp-syntax} must be set before requiring @value{tramp}: | |
2112 | |
2113 @lisp | |
2114 (setq tramp-syntax 'url) | |
2115 (require 'tramp) | |
2116 @end lisp | |
2117 | |
2118 Then, a @value{tramp} filename would look like this: | |
2119 @file{/@var{method}://@var{user}@@@var{machine}:@var{port}/@var{path/to.file}}. | |
2120 @file{/@var{method}://} is mandatory, all other parts are optional. | |
2121 @file{:@var{port}} is useful for methods only who support this. | |
2122 | |
2123 The last example from the previous section would look like this: | |
2124 @file{/ssh://daniel@@melancholia/.emacs}. | |
2125 | |
2126 For the time being, @code{tramp-syntax} can have the following values: | |
2127 | |
2128 @itemize @w{} | |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2129 @ifset emacs |
81759 | 2130 @item @code{ftp} -- That is the default syntax |
2131 @item @code{url} -- URL-like syntax | |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2132 @end ifset |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2133 @ifset xemacs |
81759 | 2134 @item @code{sep} -- That is the default syntax |
2135 @item @code{url} -- URL-like syntax | |
2136 @item @code{ftp} -- EFS-like syntax | |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2137 @end ifset |
81759 | 2138 @end itemize |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2139 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2140 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2141 @node Filename completion |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2142 @section Filename completion |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2143 @cindex filename completion |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2144 |
70532
eabc2170431c
* tramp.texi (Filename completion): Improve wording.
Michael Albinus <michael.albinus@gmx.de>
parents:
70487
diff
changeset
|
2145 Filename completion works with @value{tramp} for completion of method |
81759 | 2146 names, of user names and of machine names as well as for completion of |
2147 file names on remote machines. | |
70487
737e59692915
* mini.texi (Completion Options):
Michael Albinus <michael.albinus@gmx.de>
parents:
68335
diff
changeset
|
2148 @ifset emacs |
81759 | 2149 In order to enable this, Partial Completion mode must be set |
2150 on@footnote{If you don't use Partial Completion mode, but want to | |
2151 keep full completion, load @value{tramp} like this in your | |
2152 @file{.emacs}: | |
2153 | |
2154 @lisp | |
2155 ;; Preserve Tramp's completion features. | |
2156 (let ((partial-completion-mode t)) | |
2157 (require 'tramp)) | |
2158 @end lisp | |
2159 }. | |
70487
737e59692915
* mini.texi (Completion Options):
Michael Albinus <michael.albinus@gmx.de>
parents:
68335
diff
changeset
|
2160 @ifinfo |
737e59692915
* mini.texi (Completion Options):
Michael Albinus <michael.albinus@gmx.de>
parents:
68335
diff
changeset
|
2161 @xref{Completion Options, , , @value{emacsdir}}. |
737e59692915
* mini.texi (Completion Options):
Michael Albinus <michael.albinus@gmx.de>
parents:
68335
diff
changeset
|
2162 @end ifinfo |
737e59692915
* mini.texi (Completion Options):
Michael Albinus <michael.albinus@gmx.de>
parents:
68335
diff
changeset
|
2163 @end ifset |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2164 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2165 If you, for example, type @kbd{C-x C-f @value{prefix}t |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2166 @key{TAB}}, @value{tramp} might give you as result the choice for |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2167 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2168 @example |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2169 @ifset emacs |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2170 @value{prefixhop}telnet@value{postfixhop} tmp/ |
81759 | 2171 @value{prefixhop}toto@value{postfix} |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2172 @end ifset |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2173 @ifset xemacs |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2174 @value{prefixhop}telnet@value{postfixhop} @value{prefixhop}toto@value{postfix} |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2175 @end ifset |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2176 @end example |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48974
diff
changeset
|
2177 |
81759 | 2178 @samp{@value{prefixhop}telnet@value{postfixhop}} |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2179 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
|
2180 @ifset emacs |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2181 @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
|
2182 machine, |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2183 @end ifset |
81759 | 2184 and @samp{@value{prefixhop}toto@value{postfix}} |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2185 might be a host @value{tramp} has detected in your @file{~/.ssh/known_hosts} |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2186 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
|
2187 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2188 If you go on to type @kbd{e @key{TAB}}, the minibuffer is completed to |
81759 | 2189 @samp{@value{prefix}telnet@value{postfixhop}}. |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2190 Next @kbd{@key{TAB}} brings you all machine names @value{tramp} detects in |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2191 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
|
2192 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2193 @example |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2194 @trampfn{telnet, , 127.0.0.1,} @trampfn{telnet, , 192.168.0.1,} |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2195 @trampfn{telnet, , localhost,} @trampfn{telnet, , melancholia.danann.net,} |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2196 @trampfn{telnet, , melancholia,} |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2197 @end example |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2198 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2199 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
|
2200 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
|
2201 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2202 If the configuration files (@pxref{Customizing Completion}), which |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2203 @value{tramp} uses for analysis of completion, offer user names, those user |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2204 names will be taken into account as well. |
45861 | 2205 |
81759 | 2206 Remote machines, which have been visited in the past and kept |
2207 persistently (@pxref{Connection caching}), will be offered too. | |
2208 | |
2209 Once the remote machine identification is completed, it comes to | |
2210 filename completion on the remote host. This works pretty much like | |
2211 for files on the local host, with the exception that minibuffer | |
2212 killing via a double-slash works only on the filename part, except | |
2213 that filename part starts with @file{//}. | |
2214 @ifinfo | |
2215 @xref{Minibuffer File, , , @value{emacsdir}}. | |
2216 @end ifinfo | |
2217 | |
2218 @ifset emacs | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2219 As example, @kbd{@trampfn{telnet, , melancholia, /usr/local/bin//etc} |
81759 | 2220 @key{TAB}} would result in |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2221 @file{@trampfn{telnet, , melancholia, /etc}}, whereas |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2222 @kbd{@trampfn{telnet, , melancholia, //etc} @key{TAB}} reduces the |
81759 | 2223 minibuffer contents to @file{/etc}. A triple-slash stands for the |
2224 default behaviour, | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2225 i.e. @kbd{@trampfn{telnet, , melancholia, /usr/local/bin///etc} |
81759 | 2226 @key{TAB}} expands directly to @file{/etc}. |
2227 @end ifset | |
2228 | |
2229 @ifset xemacs | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2230 As example, @kbd{@trampfn{telnet, , melancholia, /usr/local/bin//}} |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2231 would result in @file{@trampfn{telnet, , melancholia, /}}, whereas |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2232 @kbd{@trampfn{telnet, , melancholia, //}} expands the minibuffer |
81759 | 2233 contents to @file{/}. |
2234 @end ifset | |
2235 | |
2236 | |
2237 @node Remote processes | |
81827
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2238 @section Integration with other @value{emacsname} packages. |
59582
92796330257a
Sync with Tramp 2.0.47.
Michael Albinus <michael.albinus@gmx.de>
parents:
57463
diff
changeset
|
2239 @cindex compile |
92796330257a
Sync with Tramp 2.0.47.
Michael Albinus <michael.albinus@gmx.de>
parents:
57463
diff
changeset
|
2240 @cindex recompile |
81827
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2241 |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2242 @value{tramp} supports running processes on a remote host. This |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2243 allows to exploit @value{emacsname} packages without modification for |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2244 remote file names. It does not work for the @option{ftp} and |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2245 @option{smb} methods. |
81759 | 2246 |
2247 Remote processes are started when a corresponding command is executed | |
2248 from a buffer belonging to a remote file or directory. Up to now, the | |
2249 packages @file{compile.el} (commands like @code{compile} and | |
2250 @code{grep}) and @file{gud.el} (@code{gdb} or @code{perldb}) have been | |
2251 integrated. Integration of further packages is planned, any help for | |
2252 this is welcome! | |
2253 | |
2254 When your program is not found in the default search path | |
2255 @value{tramp} sets on the remote machine, you should either use an | |
2256 absolute path, or extend @code{tramp-remote-path} (see @ref{Remote | |
2257 Programs}): | |
2258 | |
2259 @lisp | |
2260 (add-to-list 'tramp-remote-path "~/bin") | |
2261 (add-to-list 'tramp-remote-path "/appli/pub/bin") | |
2262 @end lisp | |
2263 | |
2264 The environment for your program can be adapted by customizing | |
2265 @code{tramp-remote-process-environment}. This variable is a list of | |
2266 strings. It is structured like @code{process-environment}. Each | |
2267 element is a string of the form ENVVARNAME=VALUE. An entry | |
2268 ENVVARNAME= disables the corresponding environment variable, which | |
2269 might have been set in your init file like @file{~/.profile}. | |
2270 | |
2271 @noindent | |
2272 Adding an entry can be performed via @code{add-to-list}: | |
59582
92796330257a
Sync with Tramp 2.0.47.
Michael Albinus <michael.albinus@gmx.de>
parents:
57463
diff
changeset
|
2273 |
92796330257a
Sync with Tramp 2.0.47.
Michael Albinus <michael.albinus@gmx.de>
parents:
57463
diff
changeset
|
2274 @lisp |
81759 | 2275 (add-to-list 'tramp-remote-process-environment "JAVA_HOME=/opt/java") |
2276 @end lisp | |
2277 | |
2278 Changing or removing an existing entry is not encouraged. The default | |
2279 values are chosen for proper @value{tramp} work. Nevertheless, if for | |
2280 example a paranoid system administrator disallows changing the | |
2281 @var{$HISTORY} environment variable, you can customize | |
2282 @code{tramp-remote-process-environment}, or you can apply the | |
2283 following code in your @file{.emacs}: | |
2284 | |
2285 @lisp | |
2286 (let ((process-environment tramp-remote-process-environment)) | |
2287 (setenv "HISTORY" nil) | |
2288 (setq tramp-remote-process-environment process-environment)) | |
59582
92796330257a
Sync with Tramp 2.0.47.
Michael Albinus <michael.albinus@gmx.de>
parents:
57463
diff
changeset
|
2289 @end lisp |
92796330257a
Sync with Tramp 2.0.47.
Michael Albinus <michael.albinus@gmx.de>
parents:
57463
diff
changeset
|
2290 |
81759 | 2291 If you use other @value{emacsname} packages which do not run |
2292 out-of-the-box on a remote host, please let us know. We will try to | |
2293 integrate them as well. @xref{Bug Reports}. | |
2294 | |
2295 | |
2296 @subsection Running eshell on a remote host | |
2297 @cindex eshell | |
2298 | |
2299 @value{tramp} is integrated into @file{eshell.el}. That is, you can | |
2300 open an interactive shell on your remote host, and run commands there. | |
2301 After you have started @code{eshell}, you could perform commands like | |
2302 this: | |
2303 | |
2304 @example | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2305 @b{~ $} cd @trampfn{sudo, , , /etc} @key{RET} |
81827
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2306 @b{@trampfn{sudo, root, host, /etc} $} hostname @key{RET} |
81759 | 2307 host |
81827
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2308 @b{@trampfn{sudo, root, host, /etc} $} id @key{RET} |
81759 | 2309 uid=0(root) gid=0(root) groups=0(root) |
81827
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2310 @b{@trampfn{sudo, root, host, /etc} $} find-file shadow @key{RET} |
81759 | 2311 #<buffer shadow> |
2312 @b{@trampfn{sudo, root, host, /etc} $} | |
2313 @end example | |
59582
92796330257a
Sync with Tramp 2.0.47.
Michael Albinus <michael.albinus@gmx.de>
parents:
57463
diff
changeset
|
2314 |
92796330257a
Sync with Tramp 2.0.47.
Michael Albinus <michael.albinus@gmx.de>
parents:
57463
diff
changeset
|
2315 |
81939
7cd8ee60cf68
* tramp.texi: Move @setfilename ../info/tramp up, outside the header
Michael Albinus <michael.albinus@gmx.de>
parents:
81831
diff
changeset
|
2316 @anchor{Running a debugger on a remote host} |
81827
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2317 @subsection Running a debugger on a remote host |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2318 @cindex gud |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2319 @cindex gdb |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2320 @cindex perldb |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2321 |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2322 @file{gud.el} offers an unified interface to several symbolic |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2323 debuggers |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2324 @ifset emacs |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2325 @ifinfo |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2326 (@ref{Debuggers, , , @value{emacsdir}}). |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2327 @end ifinfo |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2328 @end ifset |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2329 With @value{tramp}, it is possible to debug programs on |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2330 remote hosts. You can call @code{gdb} with a remote file name: |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2331 |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2332 @example |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2333 @kbd{M-x gdb @key{RET}} |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2334 @b{Run gdb (like this):} gdb --annotate=3 @trampfn{ssh, , host, ~/myprog} @key{RET} |
81827
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2335 @end example |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2336 |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2337 The file name can also be relative to a remote default directory. |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2338 Given you are in a buffer that belongs to the remote directory |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2339 @trampfn{ssh, , host, /home/user}, you could call |
81827
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2340 |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2341 @example |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2342 @kbd{M-x perldb @key{RET}} |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2343 @b{Run perldb (like this):} perl -d myprog.pl @key{RET} |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2344 @end example |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2345 |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2346 It is not possible to use just the absolute local part of a remote |
81939
7cd8ee60cf68
* tramp.texi: Move @setfilename ../info/tramp up, outside the header
Michael Albinus <michael.albinus@gmx.de>
parents:
81831
diff
changeset
|
2347 file name as program to debug, like @kbd{perl -d |
7cd8ee60cf68
* tramp.texi: Move @setfilename ../info/tramp up, outside the header
Michael Albinus <michael.albinus@gmx.de>
parents:
81831
diff
changeset
|
2348 /home/user/myprog.pl}, though. |
7cd8ee60cf68
* tramp.texi: Move @setfilename ../info/tramp up, outside the header
Michael Albinus <michael.albinus@gmx.de>
parents:
81831
diff
changeset
|
2349 |
7cd8ee60cf68
* tramp.texi: Move @setfilename ../info/tramp up, outside the header
Michael Albinus <michael.albinus@gmx.de>
parents:
81831
diff
changeset
|
2350 Arguments of the program to be debugged are taken literally. That |
7cd8ee60cf68
* tramp.texi: Move @setfilename ../info/tramp up, outside the header
Michael Albinus <michael.albinus@gmx.de>
parents:
81831
diff
changeset
|
2351 means file names as arguments must be given as ordinary relative or |
7cd8ee60cf68
* tramp.texi: Move @setfilename ../info/tramp up, outside the header
Michael Albinus <michael.albinus@gmx.de>
parents:
81831
diff
changeset
|
2352 absolute file names, without any remote specification. |
81827
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2353 |
7b0fef180aa2
* tramp.texi (Remote processes): Don't call it "experimental" any
Michael Albinus <michael.albinus@gmx.de>
parents:
81759
diff
changeset
|
2354 |
45861 | 2355 @node Bug Reports |
2356 @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
|
2357 @cindex bug reports |
45861 | 2358 |
72569
7457615d594a
Sync with Tramp 2.0.54.
Michael Albinus <michael.albinus@gmx.de>
parents:
71224
diff
changeset
|
2359 Bugs and problems with @value{tramp} are actively worked on by the |
81759 | 2360 development team. Feature requests and suggestions are also more than |
72569
7457615d594a
Sync with Tramp 2.0.54.
Michael Albinus <michael.albinus@gmx.de>
parents:
71224
diff
changeset
|
2361 welcome. |
7457615d594a
Sync with Tramp 2.0.54.
Michael Albinus <michael.albinus@gmx.de>
parents:
71224
diff
changeset
|
2362 |
7457615d594a
Sync with Tramp 2.0.54.
Michael Albinus <michael.albinus@gmx.de>
parents:
71224
diff
changeset
|
2363 The @value{tramp} mailing list is a great place to get information on |
7457615d594a
Sync with Tramp 2.0.54.
Michael Albinus <michael.albinus@gmx.de>
parents:
71224
diff
changeset
|
2364 working with @value{tramp}, solving problems and general discussion |
7457615d594a
Sync with Tramp 2.0.54.
Michael Albinus <michael.albinus@gmx.de>
parents:
71224
diff
changeset
|
2365 and advice on topics relating to the package. It is moderated so |
7457615d594a
Sync with Tramp 2.0.54.
Michael Albinus <michael.albinus@gmx.de>
parents:
71224
diff
changeset
|
2366 non-subscribers can post but messages will be delayed, possibly up to |
7457615d594a
Sync with Tramp 2.0.54.
Michael Albinus <michael.albinus@gmx.de>
parents:
71224
diff
changeset
|
2367 48 hours (or longer in case of holidays), until the moderator approves |
7457615d594a
Sync with Tramp 2.0.54.
Michael Albinus <michael.albinus@gmx.de>
parents:
71224
diff
changeset
|
2368 your message. |
45861 | 2369 |
60763
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
2370 The mailing list is at @email{tramp-devel@@gnu.org}. Messages sent to |
81759 | 2371 this address go to all the subscribers. This is @emph{not} the address |
60763
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
2372 to send subscription requests to. |
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
2373 |
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
2374 Subscribing to the list is performed via |
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
2375 @uref{http://lists.gnu.org/mailman/listinfo/tramp-devel/, |
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
2376 the @value{tramp} Mail Subscription Page}. |
45861 | 2377 |
81759 | 2378 To report a bug in @value{tramp}, you should execute @kbd{M-x |
2379 tramp-bug}. This will automatically generate a buffer with the details | |
2380 of your system and @value{tramp} version. | |
45861 | 2381 |
2382 When submitting a bug report, please try to describe in excruciating | |
2383 detail the steps required to reproduce the problem, the setup of the | |
68335
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2384 remote machine and any special conditions that exist. You should also |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2385 check that your problem is not described already in @xref{Frequently |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2386 Asked Questions}. |
45861 | 2387 |
2388 If you can identify a minimal test case that reproduces the problem, | |
81759 | 2389 include that with your bug report. This will make it much easier for |
2390 the development team to analyze and correct the problem. | |
2391 | |
2392 Before reporting the bug, you should set the verbosity level to 6 | |
2393 (@pxref{Traces and Profiles, Traces}) in the @file{~/.emacs} file and | |
2394 repeat the bug. Then, include the contents of the @file{*tramp/foo*} | |
2395 and @file{*debug tramp/foo*} buffers in your bug report. A verbosity | |
2396 level greater than 6 will produce a very huge debug buffer, which is | |
2397 mostly not necessary for the analysis. | |
2398 | |
2399 Please be aware that, with a verbosity level of 6 or greater, the | |
2400 contents of files and directories will be included in the debug | |
2401 buffer. Passwords you've typed will never be included there. | |
2402 | |
45861 | 2403 |
2404 @node Frequently Asked Questions | |
2405 @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
|
2406 @cindex frequently asked questions |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
2407 @cindex FAQ |
45861 | 2408 |
2409 @itemize @bullet | |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
2410 @item |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2411 Where can I get the latest @value{tramp}? |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2412 |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2413 @value{tramp} is available under the URL below. |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2414 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2415 @noindent |
68335
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2416 @uref{ftp://ftp.gnu.org/gnu/tramp/} |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2417 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2418 @noindent |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2419 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
|
2420 |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
2421 @noindent |
60763
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
2422 @uref{http://savannah.gnu.org/projects/tramp/} |
45861 | 2423 |
68335
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2424 |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
2425 @item |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
2426 Which systems does it work on? |
45861 | 2427 |
81759 | 2428 The package has been used successfully on GNU Emacs 21, GNU Emacs 22 |
2429 and XEmacs 21 (starting with 21.4). Gateway methods are supported for | |
2430 GNU Emacs 22 only. | |
45861 | 2431 |
2432 The package was intended to work on Unix, and it really expects a | |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
2433 Unix-like system on the remote end (except the @option{smb} method), |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2434 but some people seemed to have some success getting it to work on MS |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2435 Windows NT/2000/XP @value{emacsname}. |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2436 |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2437 There is some informations on @value{tramp} on NT at the following URL; |
48974
d29e4e3d4f5d
(External transfer methods): New method `smb'. From
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
47772
diff
changeset
|
2438 many thanks to Joe Stoy for providing the information: |
45861 | 2439 @uref{ftp://ftp.comlab.ox.ac.uk/tmp/Joe.Stoy/} |
2440 | |
81759 | 2441 @c The link is broken. I've contacted Tom for clarification. Michael. |
57463
40298ea4d83f
Sync with Tramp 2.0.45.
Michael Albinus <michael.albinus@gmx.de>
parents:
55421
diff
changeset
|
2442 @ignore |
45861 | 2443 The above mostly contains patches to old ssh versions; Tom Roche has a |
2444 Web page with instructions: | |
2445 @uref{http://www4.ncsu.edu/~tlroche/plinkTramp.html} | |
57463
40298ea4d83f
Sync with Tramp 2.0.45.
Michael Albinus <michael.albinus@gmx.de>
parents:
55421
diff
changeset
|
2446 @end ignore |
45861 | 2447 |
81759 | 2448 @item |
2449 How could I speed up @value{tramp}? | |
2450 | |
2451 In the backstage, @value{tramp} needs a lot of operations on the | |
2452 remote host. The time for transferring data from and to the remote | |
2453 host as well as the time needed to perform the operations there count. | |
2454 In order to speed up @value{tramp}, one could either try to avoid some | |
2455 of the operations, or one could try to improve their performance. | |
2456 | |
2457 Use an external transfer method, like @option{scpc}. | |
2458 | |
2459 Use caching. This is already enabled by default. Information about | |
82200
b85800eebe46
* tramp.texi (Frequently Asked Questions): Point to mode line
Michael Albinus <michael.albinus@gmx.de>
parents:
82023
diff
changeset
|
2460 the remote host as well as the remote files are cached for reuse. The |
81759 | 2461 information about remote hosts is kept in the file specified in |
2462 @code{tramp-persistency-file-name}. Keep this file. | |
2463 | |
2464 Disable version control. If you access remote files which are not | |
2465 under version control, a lot of check operations can be avoided by | |
2466 disabling VC. This can be achieved by | |
2467 | |
2468 @lisp | |
2469 (setq vc-handled-backends nil) | |
2470 @end lisp | |
2471 | |
2472 Disable excessive traces. The default trace level of @value{tramp}, | |
2473 defined in the variable @code{tramp-verbose}, is 3. You should | |
2474 increase this level only temporarily, hunting bugs. | |
2475 | |
45861 | 2476 |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
2477 @item |
68335
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2478 @value{tramp} does not connect to the remote host |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2479 |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2480 When @value{tramp} does not connect to the remote host, there are two |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2481 reasons heading the bug mailing list: |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2482 |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2483 @itemize @minus |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2484 |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2485 @item |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2486 Unknown characters in the prompt |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2487 |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2488 @value{tramp} needs to recognize the prompt on the remote machine |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2489 after execution any command. This is not possible, when the prompt |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2490 contains unknown characters like escape sequences for coloring. This |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2491 should be avoided on the remote side. @xref{Remote shell setup}. for |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2492 setting the regular expression detecting the prompt. |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2493 |
81759 | 2494 You can check your settings after an unsuccessful connection by |
2495 switching to the @value{tramp} connection buffer @file{*tramp/foo*}, | |
2496 setting the cursor at the top of the buffer, and applying the expression | |
2497 | |
2498 @example | |
2499 @kbd{M-: (re-search-forward (concat tramp-shell-prompt-pattern "$"))} | |
2500 @end example | |
2501 | |
2502 If it fails, or the cursor is not moved at the end of the buffer, your | |
2503 prompt is not recognised correctly. | |
2504 | |
71068
14f10023ee06
* tramp.texi (Frequently Asked Questions): Disable zsh zle.
Michael Albinus <michael.albinus@gmx.de>
parents:
70532
diff
changeset
|
2505 A special problem is the zsh, which uses left-hand side and right-hand |
14f10023ee06
* tramp.texi (Frequently Asked Questions): Disable zsh zle.
Michael Albinus <michael.albinus@gmx.de>
parents:
70532
diff
changeset
|
2506 side prompts in parallel. Therefore, it is necessary to disable the |
14f10023ee06
* tramp.texi (Frequently Asked Questions): Disable zsh zle.
Michael Albinus <michael.albinus@gmx.de>
parents:
70532
diff
changeset
|
2507 zsh line editor on the remote host. You shall add to @file{~/.zshrc} |
77986
0cc9b64806d2
Sync with Tramp 2.0.56.
Michael Albinus <michael.albinus@gmx.de>
parents:
77235
diff
changeset
|
2508 the following command: |
0cc9b64806d2
Sync with Tramp 2.0.56.
Michael Albinus <michael.albinus@gmx.de>
parents:
77235
diff
changeset
|
2509 |
0cc9b64806d2
Sync with Tramp 2.0.56.
Michael Albinus <michael.albinus@gmx.de>
parents:
77235
diff
changeset
|
2510 @example |
0cc9b64806d2
Sync with Tramp 2.0.56.
Michael Albinus <michael.albinus@gmx.de>
parents:
77235
diff
changeset
|
2511 [ $TERM = "dumb" ] && unsetopt zle && PS1='$ ' |
0cc9b64806d2
Sync with Tramp 2.0.56.
Michael Albinus <michael.albinus@gmx.de>
parents:
77235
diff
changeset
|
2512 @end example |
71068
14f10023ee06
* tramp.texi (Frequently Asked Questions): Disable zsh zle.
Michael Albinus <michael.albinus@gmx.de>
parents:
70532
diff
changeset
|
2513 |
81759 | 2514 |
68335
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2515 @item |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2516 @value{tramp} doesn't transfer strings with more than 500 characters |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2517 correctly |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2518 |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2519 On some few systems, the implementation of @code{process-send-string} |
81759 | 2520 seems to be broken for longer strings. It is reported for HP-UX, |
2521 FreeBSD and Tru64 Unix, for example. This case, you should customize | |
2522 the variable @code{tramp-chunksize} to 500. For a description how to | |
2523 determine whether this is necessary see the documentation of | |
2524 @code{tramp-chunksize}. | |
2525 | |
2526 Additionally, it will be useful to set @code{file-precious-flag} to | |
2527 @code{t} for @value{tramp} files. Then the file contents will be | |
2528 written into a temporary file first, which is checked for correct | |
2529 checksum. | |
2530 @ifinfo | |
2531 @pxref{Saving Buffers, , , elisp} | |
2532 @end ifinfo | |
2533 | |
2534 @lisp | |
2535 (add-hook | |
2536 'find-file-hooks | |
2537 '(lambda () | |
2538 (when (file-remote-p default-directory) | |
2539 (set (make-local-variable 'file-precious-flag) t)))) | |
2540 @end lisp | |
2541 | |
68335
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2542 @end itemize |
45861 | 2543 |
2544 | |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
2545 @item |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2546 File name completion does not work with @value{tramp} |
45861 | 2547 |
2548 When you log in to the remote machine, do you see the output of | |
2549 @command{ls} in color? If so, this may be the cause of your problems. | |
2550 | |
2551 @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
|
2552 emulator interprets to set the colors. These escape sequences will |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2553 confuse @value{tramp} however. |
45861 | 2554 |
2555 In your @file{.bashrc}, @file{.profile} or equivalent on the remote | |
2556 machine you probably have an alias configured that adds the option | |
2557 @option{--color=yes} or @option{--color=auto}. | |
2558 | |
2559 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
|
2560 display the output of @command{ls} in color. If you still cannot use |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2561 filename completion, report a bug to the @value{tramp} developers. |
45861 | 2562 |
2563 | |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
2564 @item |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
2565 File name completion does not work in large directories |
45861 | 2566 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2567 @value{tramp} uses globbing for some operations. (Globbing means to use the |
45861 | 2568 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
|
2569 command lines, especially in directories with many files. Some shells |
45861 | 2570 choke on long command lines, or don't cope well with the globbing |
2571 itself. | |
2572 | |
2573 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
|
2574 a command like @samp{ls -d * ..?* > /dev/null} and see if it hangs. |
45861 | 2575 Note that you must first start the right shell, which might be |
2576 @command{/bin/sh}, @command{ksh} or @command{bash}, depending on which | |
2577 of those supports tilde expansion. | |
2578 | |
2579 | |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
2580 @item |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2581 How can I get notified when @value{tramp} file transfers are complete? |
45861 | 2582 |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
2583 The following snippet can be put in your @file{~/.emacs} file. It |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2584 makes @value{emacsname} beep after reading from or writing to the |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
2585 remote host. |
45861 | 2586 |
2587 @lisp | |
2588 (defadvice tramp-handle-write-region | |
2589 (after tramp-write-beep-advice activate) | |
2590 " make tramp beep after writing a file." | |
2591 (interactive) | |
2592 (beep)) | |
81759 | 2593 |
45861 | 2594 (defadvice tramp-handle-do-copy-or-rename-file |
2595 (after tramp-copy-beep-advice activate) | |
2596 " make tramp beep after copying a file." | |
2597 (interactive) | |
2598 (beep)) | |
81759 | 2599 |
45861 | 2600 (defadvice tramp-handle-insert-file-contents |
2601 (after tramp-copy-beep-advice activate) | |
2602 " make tramp beep after copying a file." | |
2603 (interactive) | |
2604 (beep)) | |
2605 @end lisp | |
2606 | |
2607 | |
81759 | 2608 @ifset emacs |
2609 @item | |
2610 I'ld like to see a host indication in the mode line when I'm remote | |
2611 | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2612 The following code has been tested with @value{emacsname} 22.1. You |
81759 | 2613 should put it into your @file{~/.emacs}: |
2614 | |
2615 @lisp | |
2616 (defconst my-mode-line-buffer-identification | |
2617 (list | |
2618 '(:eval | |
2619 (let ((host-name | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2620 (if (file-remote-p default-directory) |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2621 (tramp-file-name-host |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2622 (tramp-dissect-file-name default-directory)) |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2623 (system-name)))) |
81759 | 2624 (if (string-match "^[^0-9][^.]*\\(\\..*\\)" host-name) |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2625 (substring host-name 0 (match-beginning 1)) |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2626 host-name))) |
81759 | 2627 ": %12b")) |
2628 | |
2629 (setq-default | |
2630 mode-line-buffer-identification | |
2631 my-mode-line-buffer-identification) | |
2632 | |
2633 (add-hook | |
2634 'dired-mode-hook | |
2635 '(lambda () | |
2636 (setq | |
2637 mode-line-buffer-identification | |
2638 my-mode-line-buffer-identification))) | |
2639 @end lisp | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2640 |
82200
b85800eebe46
* tramp.texi (Frequently Asked Questions): Point to mode line
Michael Albinus <michael.albinus@gmx.de>
parents:
82023
diff
changeset
|
2641 Since @value{emacsname} 23.1, the mode line contains an indication if |
b85800eebe46
* tramp.texi (Frequently Asked Questions): Point to mode line
Michael Albinus <michael.albinus@gmx.de>
parents:
82023
diff
changeset
|
2642 @code{default-directory} for the current buffer is on a remote host. |
b85800eebe46
* tramp.texi (Frequently Asked Questions): Point to mode line
Michael Albinus <michael.albinus@gmx.de>
parents:
82023
diff
changeset
|
2643 The corresponding tooltip includes the name of that host. If you |
b85800eebe46
* tramp.texi (Frequently Asked Questions): Point to mode line
Michael Albinus <michael.albinus@gmx.de>
parents:
82023
diff
changeset
|
2644 still want the host name as part of the mode line, you can use the |
b85800eebe46
* tramp.texi (Frequently Asked Questions): Point to mode line
Michael Albinus <michael.albinus@gmx.de>
parents:
82023
diff
changeset
|
2645 example above, but the @code{:eval} clause can be simplified: |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2646 |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2647 @lisp |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2648 '(:eval |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2649 (let ((host-name |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2650 (or (file-remote-p default-directory 'host) |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2651 (system-name)))) |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2652 (if (string-match "^[^0-9][^.]*\\(\\..*\\)" host-name) |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2653 (substring host-name 0 (match-beginning 1)) |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2654 host-name))) |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2655 @end lisp |
81759 | 2656 @end ifset |
2657 | |
2658 | |
2659 @ifset emacs | |
2660 @item | |
2661 My remote host does not understand default directory listing options | |
2662 | |
2663 @value{emacsname} computes the @command{dired} options depending on | |
2664 the local host you are working. If your @command{ls} command on the | |
2665 remote host does not understand those options, you can change them | |
2666 like this: | |
2667 | |
2668 @lisp | |
2669 (add-hook | |
2670 'dired-before-readin-hook | |
2671 '(lambda () | |
2672 (when (file-remote-p default-directory) | |
2673 (setq dired-actual-switches "-al")))) | |
2674 @end lisp | |
2675 @end ifset | |
2676 | |
2677 | |
46361
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
2678 @item |
a3acca116f2f
Comply with Texinfo coding standards. Suggestions by Eli.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46348
diff
changeset
|
2679 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
|
2680 growing and growing. What's that? |
45861 | 2681 |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
2682 Sometimes, @value{tramp} starts @command{ksh} on the remote host for |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
2683 tilde expansion. Maybe @command{ksh} saves the history by default. |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
2684 @value{tramp} tries to turn off saving the history, but maybe you have |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
2685 to help. For example, you could put this in your @file{.kshrc}: |
45861 | 2686 |
2687 @example | |
2688 if [ -f $HOME/.sh_history ] ; then | |
2689 /bin/rm $HOME/.sh_history | |
2690 fi | |
2691 if [ "$@{HISTFILE-unset@}" != "unset" ] ; then | |
2692 unset HISTFILE | |
2693 fi | |
2694 if [ "$@{HISTSIZE-unset@}" != "unset" ] ; then | |
2695 unset HISTSIZE | |
2696 fi | |
2697 @end example | |
2698 | |
49996
bda88bfc6c5e
Version 2.0.30 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49610
diff
changeset
|
2699 |
81759 | 2700 @item There are longish file names to type. How to shorten this? |
2701 | |
2702 Let's say you need regularly access to @file{@trampfn{ssh, news, | |
2703 news.my.domain, /opt/news/etc}}, which is boring to type again and | |
2704 again. The following approaches can be mixed: | |
2705 | |
2706 @enumerate | |
2707 | |
2708 @item Use default values for method and user name: | |
2709 | |
2710 You can define default methods and user names for hosts, | |
2711 (@pxref{Default Method}, @pxref{Default User}): | |
2712 | |
2713 @lisp | |
2714 (setq tramp-default-method "ssh" | |
2715 tramp-default-user "news") | |
2716 @end lisp | |
2717 | |
2718 The file name left to type would be | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2719 @kbd{C-x C-f @trampfn{, , news.my.domain, /opt/news/etc}}. |
81759 | 2720 |
2721 Note, that there are some useful settings already. Accessing your | |
2722 local host as @samp{root} user, is possible just by @kbd{C-x C-f | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2723 @trampfn{su, , ,}}. |
81759 | 2724 |
2725 @item Use configuration possibilities of your method: | |
2726 | |
2727 Several connection methods (i.e. the programs used) offer powerful | |
2728 configuration possibilities (@pxref{Customizing Completion}). In the | |
2729 given case, this could be @file{~/.ssh/config}: | |
2730 | |
2731 @example | |
2732 Host xy | |
2733 HostName news.my.domain | |
2734 User news | |
2735 @end example | |
2736 | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2737 The file name left to type would be @kbd{C-x C-f @trampfn{ssh, , xy, |
81759 | 2738 /opt/news/etc}}. Depending on files in your directories, it is even |
2739 possible to complete the hostname with @kbd{C-x C-f | |
2740 @value{prefix}ssh@value{postfixhop}x @key{TAB}}. | |
2741 | |
2742 @item Use environment variables: | |
2743 | |
2744 File names typed in the minibuffer can be expanded by environment | |
2745 variables. You can set them outside @value{emacsname}, or even with | |
2746 Lisp: | |
2747 | |
2748 @lisp | |
2749 (setenv "xy" "@trampfn{ssh, news, news.my.domain, /opt/news/etc/}") | |
2750 @end lisp | |
2751 | |
2752 Then you need simply to type @kbd{C-x C-f $xy @key{RET}}, and here you | |
2753 are. The disadvantage is, that you cannot edit the file name, because | |
2754 environment variables are not expanded during editing in the | |
2755 minibuffer. | |
2756 | |
2757 @item Define own keys: | |
2758 | |
2759 You can define your own key sequences in @value{emacsname}, which can | |
2760 be used instead of @kbd{C-x C-f}: | |
2761 | |
2762 @lisp | |
2763 (global-set-key | |
2764 [(control x) (control y)] | |
2765 (lambda () | |
2766 (interactive) | |
2767 (find-file | |
2768 (read-file-name | |
2769 "Find Tramp file: " | |
2770 "@trampfn{ssh, news, news.my.domain, /opt/news/etc/}")))) | |
2771 @end lisp | |
2772 | |
2773 Simply typing @kbd{C-x C-y} would initialize the minibuffer for | |
2774 editing with your beloved file name. | |
2775 | |
2776 See also @uref{http://www.emacswiki.org/cgi-bin/wiki/TrampMode, the | |
2777 Emacs Wiki} for a more comprehensive example. | |
2778 | |
2779 @item Define own abbreviation (1): | |
2780 | |
2781 It is possible to define an own abbreviation list for expanding file | |
2782 names: | |
2783 | |
2784 @lisp | |
2785 (add-to-list | |
2786 'directory-abbrev-alist | |
2787 '("^/xy" . "@trampfn{ssh, news, news.my.domain, /opt/news/etc/}")) | |
2788 @end lisp | |
2789 | |
2790 This shortens the file openening command to @kbd{C-x C-f /xy | |
2791 @key{RET}}. The disadvantage is, again, that you cannot edit the file | |
2792 name, because the expansion happens after entering the file name only. | |
2793 | |
2794 @item Define own abbreviation (2): | |
2795 | |
2796 The @code{abbrev-mode} gives more flexibility for editing the | |
2797 minibuffer: | |
2798 | |
2799 @lisp | |
2800 (define-abbrev-table 'my-tramp-abbrev-table | |
2801 '(("xy" "@trampfn{ssh, news, news.my.domain, /opt/news/etc/}"))) | |
2802 | |
2803 (add-hook | |
2804 'minibuffer-setup-hook | |
2805 '(lambda () | |
2806 (abbrev-mode 1) | |
2807 (setq local-abbrev-table my-tramp-abbrev-table))) | |
2808 | |
2809 (defadvice minibuffer-complete | |
2810 (before my-minibuffer-complete activate) | |
2811 (expand-abbrev)) | |
2812 | |
2813 ;; If you use partial-completion-mode | |
2814 (defadvice PC-do-completion | |
2815 (before my-PC-do-completion activate) | |
2816 (expand-abbrev)) | |
2817 @end lisp | |
2818 | |
2819 After entering @kbd{C-x C-f xy @key{TAB}}, the minibuffer is | |
2820 expanded, and you can continue editing. | |
2821 | |
2822 @item Use bookmarks: | |
2823 | |
2824 Bookmarks can be used to visit Tramp files or directories. | |
2825 @ifinfo | |
2826 @pxref{Bookmarks, , , @value{emacsdir}} | |
2827 @end ifinfo | |
2828 | |
2829 When you have opened @file{@trampfn{ssh, news, news.my.domain, | |
2830 /opt/news/etc/}}, you should save the bookmark via | |
2831 @ifset emacs | |
2832 @kbd{@key{menu-bar} @key{edit} @key{bookmarks} @key{set}}. | |
2833 @end ifset | |
2834 @ifset xemacs | |
2835 @kbd{@key{menu-bar} @key{view} @key{bookmarks} @key{set}}. | |
2836 @end ifset | |
2837 | |
2838 Later on, you can always navigate to that bookmark via | |
2839 @ifset emacs | |
2840 @kbd{@key{menu-bar} @key{edit} @key{bookmarks} @key{jump}}. | |
2841 @end ifset | |
2842 @ifset xemacs | |
2843 @kbd{@key{menu-bar} @key{view} @key{bookmarks} @key{jump}}. | |
2844 @end ifset | |
2845 | |
2846 @item Use recent files: | |
2847 | |
2848 @ifset emacs | |
2849 @file{recentf} | |
2850 @end ifset | |
2851 @ifset xemacs | |
2852 @file{recent-files} | |
2853 @end ifset | |
2854 remembers visited places. | |
2855 @ifinfo | |
2856 @ifset emacs | |
2857 @pxref{File Conveniences, , , @value{emacsdir}} | |
2858 @end ifset | |
2859 @ifset xemacs | |
2860 @pxref{recent-files, , , edit-utils} | |
2861 @end ifset | |
2862 @end ifinfo | |
2863 | |
2864 You could keep remote file names in the recent list without checking | |
2865 their readability through a remote access: | |
2866 | |
2867 @lisp | |
2868 @ifset emacs | |
2869 (recentf-mode 1) | |
2870 @end ifset | |
2871 @ifset xemacs | |
2872 (recent-files-initialize) | |
2873 (add-hook | |
2874 'find-file-hooks | |
2875 (lambda () | |
2876 (when (file-remote-p (buffer-file-name)) | |
2877 (recent-files-make-permanent))) | |
2878 'append) | |
2879 @end ifset | |
2880 @end lisp | |
2881 | |
2882 The list of files opened recently is reachable via | |
2883 @ifset emacs | |
2884 @kbd{@key{menu-bar} @key{file} @key{Open Recent}}. | |
2885 @end ifset | |
2886 @ifset xemacs | |
2887 @kbd{@key{menu-bar} @key{Recent Files}}. | |
2888 @end ifset | |
2889 | |
2890 @ifset emacs | |
2891 @item Use filecache: | |
2892 | |
2893 @file{filecache} remembers visited places. Add the directory into | |
2894 the cache: | |
2895 | |
2896 @lisp | |
2897 (eval-after-load "filecache" | |
2898 '(file-cache-add-directory | |
2899 "@trampfn{ssh, news, news.my.domain, /opt/news/etc/}")) | |
2900 @end lisp | |
2901 | |
2902 Whenever you want to load a file, you can enter @kbd{C-x C-f | |
2903 C-@key{TAB}} in the minibuffer. The completion is done for the given | |
2904 directory. | |
2905 @end ifset | |
2906 | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2907 @ifset emacs |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2908 @item Use bbdb: |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2909 |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2910 @file{bbdb} has a built-in feature for @value{ftppackagename} files, |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2911 which works also for @value{tramp}. |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2912 @ifinfo |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2913 @pxref{bbdb-ftp, Storing FTP sites in the BBDB, , bbdb} |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2914 @end ifinfo |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2915 |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2916 You need to load @file{bbdb}: |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2917 |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2918 @lisp |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2919 (require 'bbdb) |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2920 (bbdb-initialize) |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2921 @end lisp |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2922 |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2923 Then you can create a BBDB entry via @kbd{M-x bbdb-create-ftp-site}. |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2924 Because BBDB is not prepared for @value{tramp} syntax, you must |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2925 specify a method together with the user name, when needed. Example: |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2926 |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2927 @example |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2928 @kbd{M-x bbdb-create-ftp-site @key{RET}} |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2929 @b{Ftp Site:} news.my.domain @key{RET} |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2930 @b{Ftp Directory:} /opt/news/etc/ @key{RET} |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2931 @b{Ftp Username:} ssh@value{postfixhop}news @key{RET} |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2932 @b{Company:} @key{RET} |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2933 @b{Additional Comments:} @key{RET} |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2934 @end example |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2935 |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2936 When you have opened your BBDB buffer, you can access such an entry by |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2937 pressing the key @key{F}. |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2938 @end ifset |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2939 |
81759 | 2940 @end enumerate |
2941 | |
82023
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2942 I would like to thank all @value{tramp} users, who have contributed to |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2943 the different recipes! |
25571c49ded1
Sync with Tramp 2.1.10.
Michael Albinus <michael.albinus@gmx.de>
parents:
81939
diff
changeset
|
2944 |
81759 | 2945 |
63710
d20f7349d704
(Customizing Completion, Auto-save and Backup): Texinfo usage fixes.
Richard M. Stallman <rms@gnu.org>
parents:
63669
diff
changeset
|
2946 @item |
68335
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2947 How can I disable @value{tramp}? |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2948 |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2949 Shame on you, why did you read until now? |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2950 |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2951 @ifset emacs |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2952 If you just want to have @value{ftppackagename} as default remote |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2953 files access package, you should apply the following code: |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2954 |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2955 @lisp |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2956 (setq tramp-default-method "ftp") |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2957 @end lisp |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2958 @end ifset |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2959 |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2960 Unloading @value{tramp} can be achieved by applying @kbd{M-x |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2961 tramp-unload-tramp}. |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2962 @ifset emacs |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2963 This resets also the @value{ftppackagename} plugins. |
118ceefc8263
Sync with Tramp 2.0.52.
Michael Albinus <michael.albinus@gmx.de>
parents:
65555
diff
changeset
|
2964 @end ifset |
45861 | 2965 @end itemize |
2966 | |
2967 | |
2968 @c For the developer | |
2969 @node Version Control | |
2970 @chapter The inner workings of remote version control | |
51604
f57bfce0ddaf
Version 2.0.35 of Tramp released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50495
diff
changeset
|
2971 @cindex Version Control |
45861 | 2972 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2973 Unlike @value{ftppackagename}, @value{tramp} has full shell access to the |
81759 | 2974 remote machine. This makes it possible to provide version control for |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2975 files accessed under @value{tramp}. |
45861 | 2976 |
2977 The actual version control binaries must be installed on the remote | |
2978 machine, accessible in the directories specified in | |
81759 | 2979 @code{tramp-remote-path}. |
45861 | 2980 |
2981 This transparent integration with the version control systems is one of | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2982 the most valuable features provided by @value{tramp}, but it is far from perfect. |
45861 | 2983 Work is ongoing to improve the transparency of the system. |
2984 | |
2985 @menu | |
2986 * Version Controlled Files:: Determining if a file is under version control. | |
2987 * Remote Commands:: Executing the version control commands on the remote machine. | |
2988 * Changed workfiles:: Detecting if the working file has changed. | |
2989 * 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
|
2990 * Miscellaneous Version Control:: Things related to Version Control that don't fit elsewhere. |
45861 | 2991 @end menu |
2992 | |
2993 | |
2994 @node Version Controlled Files | |
2995 @section Determining if a file is under version control | |
2996 | |
2997 The VC package uses the existence of on-disk revision control master | |
81759 | 2998 files to determine if a given file is under revision control. These file |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
2999 tests happen on the remote machine through the standard @value{tramp} mechanisms. |
45861 | 3000 |
3001 | |
3002 @node Remote Commands | |
3003 @section Executing the version control commands on the remote machine | |
3004 | |
3005 There are no hooks provided by VC to allow intercepting of the version | |
81759 | 3006 control command execution. The calls occur through the |
45861 | 3007 @code{call-process} mechanism, a function that is somewhat more |
3008 efficient than the @code{shell-command} function but that does not | |
3009 provide hooks for remote execution of commands. | |
3010 | |
3011 To work around this, the functions @code{vc-do-command} and | |
3012 @code{vc-simple-command} have been advised to intercept requests for | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
3013 operations on files accessed via @value{tramp}. |
45861 | 3014 |
3015 In the case of a remote file, the @code{shell-command} interface is | |
3016 used, with some wrapper code, to provide the same functionality on the | |
52869
4c969f6bcb01
(Inline methods): Small grammar fix.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
3017 remote machine as would be seen on the local machine. |
45861 | 3018 |
3019 | |
3020 @node Changed workfiles | |
3021 @section Detecting if the working file has changed | |
3022 | |
3023 As there is currently no way to get access to the mtime of a file on a | |
3024 remote machine in a portable way, the @code{vc-workfile-unchanged-p} | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
3025 function is advised to call an @value{tramp} specific function for remote files. |
45861 | 3026 |
3027 The @code{tramp-vc-workfile-unchanged-p} function uses the functioning VC | |
3028 diff functionality to determine if any changes have occurred between the | |
3029 workfile and the version control master. | |
3030 | |
3031 This requires that a shell command be executed remotely, a process that | |
3032 is notably heavier-weight than the mtime comparison used for local | |
81759 | 3033 files. Unfortunately, unless a portable solution to the issue is found, |
45861 | 3034 this will remain the cost of remote version control. |
3035 | |
3036 | |
3037 @node Checking out files | |
3038 @section Bringing the workfile out of the repository | |
3039 | |
3040 VC will, by default, check for remote files and refuse to act on them | |
81759 | 3041 when checking out files from the repository. To work around this |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
3042 problem, the function @code{vc-checkout} knows about @value{tramp} files and |
45861 | 3043 allows version control to occur. |
3044 | |
3045 | |
3046 @node Miscellaneous Version Control | |
3047 @section Things related to Version Control that don't fit elsewhere | |
3048 | |
3049 Minor implementation details, &c. | |
3050 | |
3051 @menu | |
3052 * Remote File Ownership:: How VC determines who owns a workfile. | |
3053 * Back-end Versions:: How VC determines what release your RCS is. | |
3054 @end menu | |
3055 | |
3056 | |
3057 @node Remote File Ownership | |
3058 @subsection How VC determines who owns a workfile | |
3059 | |
81759 | 3060 @value{emacsname} provides the @code{user-login-name} function to |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
3061 return the login name of the current user as well as mapping from |
81759 | 3062 arbitrary user id values back to login names. The VC code uses this |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
3063 functionality to map from the uid of the owner of a workfile to the |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
3064 login name in some circumstances. |
45861 | 3065 |
3066 This will not, for obvious reasons, work if the remote system has a | |
81759 | 3067 different set of logins. As such, it is necessary to delegate to the |
45861 | 3068 remote machine the job of determining the login name associated with a |
3069 uid. | |
3070 | |
3071 Unfortunately, with the profusion of distributed management systems such | |
3072 as @code{NIS}, @code{NIS+} and @code{NetInfo}, there is no simple, | |
3073 reliable and portable method for performing this mapping. | |
3074 | |
3075 Thankfully, the only place in the VC code that depends on the mapping of | |
81759 | 3076 a uid to a login name is the @code{vc-file-owner} function. This returns |
45861 | 3077 the login of the owner of the file as a string. |
3078 | |
3079 This function has been advised to use the output of @command{ls} on the | |
3080 remote machine to determine the login name, delegating the problem of | |
3081 mapping the uid to the login to the remote system which should know more | |
3082 about it than I do. | |
3083 | |
3084 | |
3085 @node Back-end Versions | |
3086 @subsection How VC determines what release your RCS is | |
3087 | |
3088 VC needs to know what release your revision control binaries you are | |
3089 running as not all features VC supports are available with older | |
3090 versions of @command{rcs(1)}, @command{cvs(1)} or @command{sccs(1)}. | |
3091 | |
3092 The default implementation of VC determines this value the first time it | |
3093 is needed and then stores the value globally to avoid the overhead of | |
3094 executing a process and parsing its output each time the information is | |
3095 needed. | |
3096 | |
3097 Unfortunately, life is not quite so easy when remote version control | |
81759 | 3098 comes into the picture. Each remote machine may have a different version |
45861 | 3099 of the version control tools and, while this is painful, we need to |
3100 ensure that unavailable features are not used remotely. | |
3101 | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
3102 To resolve this issue, @value{tramp} currently takes the sledgehammer |
45861 | 3103 approach of making the release values of the revision control tools |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
3104 local to each @value{tramp} buffer, forcing VC to determine these values |
45861 | 3105 again each time a new file is visited. |
3106 | |
81759 | 3107 This has, quite obviously, some performance implications. Thankfully, |
45861 | 3108 most of the common operations performed by VC do not actually require |
81759 | 3109 that the remote version be known. This makes the problem far less |
45861 | 3110 apparent. |
3111 | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
3112 Eventually these values will be captured by @value{tramp} on a system by |
45861 | 3113 system basis and the results cached to improve performance. |
3114 | |
3115 | |
49996
bda88bfc6c5e
Version 2.0.30 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49610
diff
changeset
|
3116 @node Files directories and localnames |
bda88bfc6c5e
Version 2.0.30 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49610
diff
changeset
|
3117 @chapter How file names, directories and localnames are mangled and managed. |
45861 | 3118 |
3119 @menu | |
49996
bda88bfc6c5e
Version 2.0.30 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49610
diff
changeset
|
3120 * Localname deconstruction:: Breaking a localname into its components. |
45861 | 3121 @end menu |
3122 | |
3123 | |
49996
bda88bfc6c5e
Version 2.0.30 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49610
diff
changeset
|
3124 @node Localname deconstruction |
bda88bfc6c5e
Version 2.0.30 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49610
diff
changeset
|
3125 @section Breaking a localname into its components. |
bda88bfc6c5e
Version 2.0.30 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49610
diff
changeset
|
3126 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
3127 @value{tramp} file names are somewhat different, obviously, to ordinary file |
81759 | 3128 names. As such, the lisp functions @code{file-name-directory} and |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
3129 @code{file-name-nondirectory} are overridden within the @value{tramp} |
49996
bda88bfc6c5e
Version 2.0.30 released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
49610
diff
changeset
|
3130 package. |
45861 | 3131 |
81759 | 3132 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
|
3133 dissect the filename, call the original handler on the localname and |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
3134 then rebuild the @value{tramp} file name with the result. |
45861 | 3135 |
3136 This allows the platform specific hacks in the original handlers to take | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
3137 effect while preserving the @value{tramp} file name information. |
45861 | 3138 |
3139 | |
81759 | 3140 @node Traces and Profiles |
3141 @chapter How to Customize Traces | |
3142 | |
3143 All @value{tramp} messages are raised with a verbosity level. The | |
3144 verbosity level can be any number between 0 and 10. Only messages with | |
3145 a verbosity level less than or equal to @code{tramp-verbose} are | |
3146 displayed. | |
3147 | |
3148 The verbosity levels are | |
3149 | |
3150 @w{ 0} silent (no @value{tramp} messages at all) | |
3151 @*@indent @w{ 1} errors | |
3152 @*@indent @w{ 2} warnings | |
3153 @*@indent @w{ 3} connection to remote hosts (default verbosity) | |
3154 @*@indent @w{ 4} activities | |
3155 @*@indent @w{ 5} internal | |
3156 @*@indent @w{ 6} sent and received strings | |
3157 @*@indent @w{ 7} file caching | |
3158 @*@indent @w{ 8} connection properties | |
3159 @*@indent @w{10} traces (huge) | |
3160 | |
3161 When @code{tramp-verbose} is greater than or equal to 4, the messages | |
3162 are also written into a @value{tramp} debug buffer. This debug buffer | |
3163 is useful for analysing problems; sending a @value{tramp} bug report | |
3164 should be done with @code{tramp-verbose} set to a verbosity level of at | |
3165 least 6 (@pxref{Bug Reports}). | |
3166 | |
3167 The debug buffer is in | |
3168 @ifinfo | |
3169 @ref{Outline Mode, , , @value{emacsdir}}. | |
3170 @end ifinfo | |
3171 @ifnotinfo | |
3172 Outline Mode. | |
3173 @end ifnotinfo | |
3174 That means, you can change the level of messages to be viewed. If you | |
3175 want, for example, see only messages up to verbosity level 5, you must | |
3176 enter @kbd{C-u 6 C-c C-q}. | |
3177 @ifinfo | |
3178 Other keys for navigating are described in | |
3179 @ref{Outline Visibility, , , @value{emacsdir}}. | |
3180 @end ifinfo | |
3181 | |
3182 @value{tramp} errors are handled internally in order to raise the | |
3183 verbosity level 1 messages. When you want to get a Lisp backtrace in | |
3184 case of an error, you need to set both | |
3185 | |
3186 @lisp | |
3187 (setq debug-on-error t | |
3188 debug-on-signal t) | |
3189 @end lisp | |
3190 | |
3191 Sometimes, it might be even necessary to step through @value{tramp} | |
3192 function call traces. Such traces are enabled by the following code: | |
3193 | |
3194 @lisp | |
3195 (require 'tramp) | |
3196 (require 'trace) | |
3197 (mapcar 'trace-function-background | |
3198 (mapcar 'intern | |
3199 (all-completions "tramp-" obarray 'functionp))) | |
3200 (untrace-function 'tramp-read-passwd) | |
3201 (untrace-function 'tramp-gw-basic-authentication) | |
3202 @end lisp | |
3203 | |
3204 The function call traces are inserted in the buffer | |
3205 @file{*trace-output*}. @code{tramp-read-passwd} and | |
3206 @code{tramp-gw-basic-authentication} shall be disabled when the | |
3207 function call traces are added to @value{tramp}, because both | |
3208 functions return password strings, which should not be distributed. | |
3209 | |
3210 | |
45861 | 3211 @node Issues |
3212 @chapter Debatable Issues and What Was Decided | |
3213 | |
3214 @itemize @bullet | |
3215 @item The uuencode method does not always work. | |
3216 | |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
3217 Due to the design of @value{tramp}, the encoding and decoding programs |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
3218 need to read from stdin and write to stdout. On some systems, |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
3219 @command{uudecode -o -} will read stdin and write the decoded file to |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
3220 stdout, on other systems @command{uudecode -p} does the same thing. |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
3221 But some systems have uudecode implementations which cannot do this at |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
3222 all---it is not possible to call these uudecode implementations with |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
3223 suitable parameters so that they write to stdout. |
45861 | 3224 |
3225 Of course, this could be circumvented: the @code{begin foo 644} line | |
3226 could be rewritten to put in some temporary file name, then | |
64772
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
3227 @command{uudecode} could be called, then the temp file could be |
060177e931f8
Sync with Tramp 2.0.50.
Michael Albinus <michael.albinus@gmx.de>
parents:
63710
diff
changeset
|
3228 printed and deleted. |
45861 | 3229 |
3230 But I have decided that this is too fragile to reliably work, so on some | |
3231 systems you'll have to do without the uuencode methods. | |
3232 | |
60763
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
3233 @item The @value{tramp} filename syntax differs between GNU Emacs and XEmacs. |
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
3234 |
3ba8f94e9cfa
Sync with Tramp 2.0.48.
Michael Albinus <michael.albinus@gmx.de>
parents:
59996
diff
changeset
|
3235 The GNU Emacs maintainers wish to use a unified filename syntax for |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
3236 Ange-FTP and @value{tramp} so that users don't have to learn a new |
46348 | 3237 syntax. It is sufficient to learn some extensions to the old syntax. |
3238 | |
3239 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
|
3240 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
|
3241 uses EFS for downloading new packages. So, obviously, EFS has to be |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
3242 installed from the start. If the filenames were unified, @value{tramp} |
46348 | 3243 would have to be installed from the start, too. |
3244 | |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
3245 @ifset xemacs |
71224
b7261e09f8e4
* cc-mode.texi (Getting Started, Indentation Commands, Config Basics)
Romain Francoise <romain@orebokech.com>
parents:
71068
diff
changeset
|
3246 @strong{Note:} If you'd like to use a similar syntax like |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
3247 @value{ftppackagename}, you need the following settings in your init |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
3248 file: |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
3249 |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
3250 @lisp |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
3251 (setq tramp-unified-filenames t) |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
3252 (require 'tramp) |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
3253 @end lisp |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
3254 |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
3255 The autoload of the @value{emacsname} @value{tramp} package must be |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
3256 disabled. This can be achieved by setting file permissions @code{000} |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
3257 to the files @file{.../xemacs-packages/lisp/tramp/auto-autoloads.el*}. |
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
3258 |
81759 | 3259 In case of unified filenames, all @value{emacsname} download sites are |
3260 added to @code{tramp-default-method-alist} with default method | |
3261 @option{ftp} @xref{Default Method}. These settings shouldn't be | |
3262 touched for proper working of the @value{emacsname} package system. | |
55421
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
3263 |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
3264 The syntax for unified filenames is described in the @value{tramp} manual |
5be9c6254f06
2004-05-07 Kai Grossjohann <kai@emptydomain.de>
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
54203
diff
changeset
|
3265 for @value{emacsothername}. |
54198
c1bfc266f10a
Tramp: sync with upstream version 2.0.39.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
53207
diff
changeset
|
3266 @end ifset |
45861 | 3267 @end itemize |
3268 | |
77235 | 3269 @node GNU Free Documentation License |
3270 @appendix GNU Free Documentation License | |
3271 @include doclicense.texi | |
3272 | |
51604
f57bfce0ddaf
Version 2.0.35 of Tramp released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50495
diff
changeset
|
3273 @node Concept Index |
f57bfce0ddaf
Version 2.0.35 of Tramp released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50495
diff
changeset
|
3274 @comment node-name, next, previous, up |
f57bfce0ddaf
Version 2.0.35 of Tramp released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50495
diff
changeset
|
3275 @unnumbered Concept Index |
f57bfce0ddaf
Version 2.0.35 of Tramp released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50495
diff
changeset
|
3276 @printindex cp |
f57bfce0ddaf
Version 2.0.35 of Tramp released.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
50495
diff
changeset
|
3277 @contents |
45861 | 3278 @c End of tramp.texi - the TRAMP User Manual |
3279 @bye | |
3280 | |
3281 @c TODO | |
3282 @c | |
3283 @c * Say something about the .login and .profile files of the remote | |
3284 @c shells. | |
3285 @c * Explain how tramp.el works in principle: open a shell on a remote | |
3286 @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
|
3287 @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
|
3288 @c It seems that "external" is also used instead of "out-of-band". |
45861 | 3289 |
47576
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
3290 @c * M. Albinus |
b31c8ab7336a
Sync with version 2.0.20. Lengthy ChangeLog follows:
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
46918
diff
changeset
|
3291 @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
|
3292 @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
|
3293 @c ** Consistent small or capitalized words especially in menues. |
54203 | 3294 |
3295 @ignore | |
3296 arch-tag: f96dd66e-6dd3-4c92-8d77-9c56205ba808 | |
3297 @end ignore |