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