diff options
| author | Michael Albinus | 2015-07-21 14:59:18 +0200 |
|---|---|---|
| committer | Michael Albinus | 2015-07-21 14:59:18 +0200 |
| commit | b0dbf4c038d53ccce6ecf592c6d5b1ffcc084ad0 (patch) | |
| tree | 91b0521e809dee52fbc509feb1a4b59dd5679a84 /doc | |
| parent | b6ac30ab435596f1be6023ad22471bf570a11c4a (diff) | |
| download | emacs-b0dbf4c038d53ccce6ecf592c6d5b1ffcc084ad0.tar.gz emacs-b0dbf4c038d53ccce6ecf592c6d5b1ffcc084ad0.zip | |
Sync with Tramp repository
* doc/misc/tramp.texi (Configuration): Note, that Tramp must be
required prior changing its configuration.
(Connection caching, Predefined connection information)
(Remote shell setup): Fix typos.
(Predefined connection information): Describe, how to overwrite
parameters of `tramp-methods'.
(Remote programs, Remote processes, Traces and Profiles):
Simplify example.
(Remote programs): Remove superfluous comment.
* doc/misc/trampver.texi: Update release number.
* lisp/net/tramp-cache.el (tramp-connection-properties): Adapt docstring.
* lisp/net/tramp-gvfs.el (tramp-gvfs-do-copy-or-rename-file): New defun.
(tramp-gvfs-handle-copy-file, tramp-gvfs-handle-rename-file): Use it.
(tramp-gvfs-handle-make-directory): Reimplement PARENTS handling,
"gvfs-mkdir -p ..." does not work robust.
(tramp-gvfs-maybe-open-connection): Adapt `tramp-get-method-parameter' call.
* lisp/net/tramp-sh.el (tramp-methods):
Add `tramp-remote-shell-login' parameter where it fits.
(tramp-get-remote-path): Use it.
(tramp-make-copy-program-file-name): Fix quoting for "psftp" method.
(all): Adapt `tramp-get-method-parameter' calls.
* lisp/net/tramp.el (tramp-methods): Adapt docstring.
(tramp-get-method-parameter): Replace argument METHOD by VEC.
Check also for hits in `tramp-connection-properties'. Adapt docstring.
(tramp-get-remote-tmpdir): Cache only the local name of tmpdir.
(all): Adapt `tramp-get-method-parameter' calls.
* lisp/net/trampver.el Update release number.
* test/automated/tramp-tests.el (tramp--instrument-test-case):
Add "^make-symbolic-link not supported$" to `debug-ignored-errors'.
(tramp-test13-make-directory, tramp--test-adb-p)
(tramp--test-smb-or-windows-nt-p): Simplify.
(tramp--test-ftp-p, tramp--test-gvfs-p): New defuns.
(tramp--test-special-characters): Fix docstring. Add gvfs and ftp tests.
(tramp--test-utf8): Fix docstring.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/misc/tramp.texi | 74 | ||||
| -rw-r--r-- | doc/misc/trampver.texi | 2 |
2 files changed, 52 insertions, 24 deletions
diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi index ece851ded93..c9af6ddea47 100644 --- a/doc/misc/tramp.texi +++ b/doc/misc/tramp.texi | |||
| @@ -217,7 +217,7 @@ Configuring @value{tramp} for use | |||
| 217 | * Connection caching:: Reusing connection related information. | 217 | * Connection caching:: Reusing connection related information. |
| 218 | * Predefined connection information:: | 218 | * Predefined connection information:: |
| 219 | Setting own connection related information. | 219 | Setting own connection related information. |
| 220 | * Remote Programs:: How @value{tramp} finds and uses programs on the remote host. | 220 | * Remote programs:: How @value{tramp} finds and uses programs on the remote host. |
| 221 | * Remote shell setup:: Remote shell setup hints. | 221 | * Remote shell setup:: Remote shell setup hints. |
| 222 | * Android shell setup:: Android shell setup hints. | 222 | * Android shell setup:: Android shell setup hints. |
| 223 | * Auto-save and Backup:: Auto-save and Backup. | 223 | * Auto-save and Backup:: Auto-save and Backup. |
| @@ -524,6 +524,15 @@ can use to connect to remote hosts and transfer files | |||
| 524 | If you don't know which method is right for you, see @xref{Default | 524 | If you don't know which method is right for you, see @xref{Default |
| 525 | Method}. | 525 | Method}. |
| 526 | 526 | ||
| 527 | @strong{Note:} In the following description, setting of user options | ||
| 528 | or variables is explained. Not all of them are autoloaded by | ||
| 529 | @value{emacsname}. All examples expect, that you have loaded | ||
| 530 | @value{tramp} first: | ||
| 531 | |||
| 532 | @lisp | ||
| 533 | (require 'tramp) | ||
| 534 | @end lisp | ||
| 535 | |||
| 527 | 536 | ||
| 528 | @menu | 537 | @menu |
| 529 | * Connection types:: Types of connections made to remote hosts. | 538 | * Connection types:: Types of connections made to remote hosts. |
| @@ -548,7 +557,7 @@ Method}. | |||
| 548 | * Connection caching:: Reusing connection related information. | 557 | * Connection caching:: Reusing connection related information. |
| 549 | * Predefined connection information:: | 558 | * Predefined connection information:: |
| 550 | Setting own connection related information. | 559 | Setting own connection related information. |
| 551 | * Remote Programs:: How @value{tramp} finds and uses programs on the remote host. | 560 | * Remote programs:: How @value{tramp} finds and uses programs on the remote host. |
| 552 | * Remote shell setup:: Remote shell setup hints. | 561 | * Remote shell setup:: Remote shell setup hints. |
| 553 | * Android shell setup:: Android shell setup hints. | 562 | * Android shell setup:: Android shell setup hints. |
| 554 | * Auto-save and Backup:: Auto-save and Backup. | 563 | * Auto-save and Backup:: Auto-save and Backup. |
| @@ -622,7 +631,7 @@ it may require access to external commands to perform that task. | |||
| 622 | @command{mimencode} (part of the @command{metamail} package) or | 631 | @command{mimencode} (part of the @command{metamail} package) or |
| 623 | @command{uuencode} on the remote host. The first reliable command | 632 | @command{uuencode} on the remote host. The first reliable command |
| 624 | will be used. The search path can be customized, see @ref{Remote | 633 | will be used. The search path can be customized, see @ref{Remote |
| 625 | Programs}. | 634 | programs}. |
| 626 | 635 | ||
| 627 | If both commands aren't available on the remote host, @value{tramp} | 636 | If both commands aren't available on the remote host, @value{tramp} |
| 628 | transfers a small piece of Perl code to the remote host, and tries to | 637 | transfers a small piece of Perl code to the remote host, and tries to |
| @@ -1726,10 +1735,10 @@ Using such persistent information can be disabled by setting | |||
| 1726 | @code{tramp-persistency-file-name} to @code{nil}. | 1735 | @code{tramp-persistency-file-name} to @code{nil}. |
| 1727 | 1736 | ||
| 1728 | Once consequence of reusing connection related information is that | 1737 | Once consequence of reusing connection related information is that |
| 1729 | @var{tramp} needs to distinguish hosts. If you, for example, run a | 1738 | @value{tramp} needs to distinguish hosts. If you, for example, run a |
| 1730 | local @code{sshd} on port 3001, which tunnels @command{ssh} to another | 1739 | local @code{sshd} on port 3001, which tunnels @command{ssh} to another |
| 1731 | host, you could access both @file{@trampfn{ssh, , localhost,}} and | 1740 | host, you could access both @file{@trampfn{ssh, , localhost,}} and |
| 1732 | @file{@trampfn{ssh, , localhost#3001,}}. @var{tramp} would use the | 1741 | @file{@trampfn{ssh, , localhost#3001,}}. @value{tramp} would use the |
| 1733 | same host related information (like paths, Perl variants, etc) for | 1742 | same host related information (like paths, Perl variants, etc) for |
| 1734 | both connections, although the information is valid only for one of | 1743 | both connections, although the information is valid only for one of |
| 1735 | them. | 1744 | them. |
| @@ -1748,10 +1757,11 @@ connection again. | |||
| 1748 | @node Predefined connection information | 1757 | @node Predefined connection information |
| 1749 | @section Setting own connection related information | 1758 | @section Setting own connection related information |
| 1750 | 1759 | ||
| 1751 | Sometimes, @var{tramp} is not able to detect correct connection | 1760 | Sometimes, method specific arguments in @code{tramp-methods} do not |
| 1752 | related information. In such cases, you could tell @var{tramp} which | 1761 | fit your needs. Sometimes, @value{tramp} is not able to detect |
| 1753 | value it has to take. Since this could result in errors, it has to be | 1762 | correct connection related information. In such cases, you could tell |
| 1754 | used with care. | 1763 | @value{tramp} which value it has to take. Since this could result in |
| 1764 | errors, it has to be used with care. | ||
| 1755 | 1765 | ||
| 1756 | @vindex tramp-connection-properties | 1766 | @vindex tramp-connection-properties |
| 1757 | Such settings can be performed via the list | 1767 | Such settings can be performed via the list |
| @@ -1759,13 +1769,35 @@ Such settings can be performed via the list | |||
| 1759 | form @code{(@var{regexp} @var{property} @var{value})}. @var{regexp} | 1769 | form @code{(@var{regexp} @var{property} @var{value})}. @var{regexp} |
| 1760 | matches remote file names for which a property shall be predefined. | 1770 | matches remote file names for which a property shall be predefined. |
| 1761 | It can be @code{nil}. @var{property} is a string, and @var{value} the | 1771 | It can be @code{nil}. @var{property} is a string, and @var{value} the |
| 1762 | corresponding value. @var{property} could be any property found in | 1772 | corresponding value. |
| 1763 | the file @code{tramp-persistency-file-name}. | ||
| 1764 | 1773 | ||
| 1765 | A special property is @code{"busybox"}. This must be set, if the | 1774 | @var{property} could be any method specific parameter found in |
| 1766 | remote host runs a very restricted busybox as shell, which closes the | 1775 | @code{tramp-methods}. The parameter key in @code{tramp-methods} is a |
| 1776 | symbol name @code{tramp-<foo>}. In order to overwrite it, | ||
| 1777 | @var{property} must be the string @samp{<foo>}. If you, for example, | ||
| 1778 | want to change the remote shell to be used on a remote machine, you | ||
| 1779 | could apply | ||
| 1780 | |||
| 1781 | @lisp | ||
| 1782 | (add-to-list 'tramp-connection-properties | ||
| 1783 | (list (regexp-quote "@trampfn{ssh, user, randomhost.your.domain,}") | ||
| 1784 | "remote-shell" "/bin/ksh")) | ||
| 1785 | (add-to-list 'tramp-connection-properties | ||
| 1786 | (list (regexp-quote "@trampfn{ssh, user, randomhost.your.domain,}") | ||
| 1787 | "remote-shell-login" '("-"))) | ||
| 1788 | @end lisp | ||
| 1789 | |||
| 1790 | This would overwrite the @code{tramp-remote-shell} and | ||
| 1791 | @code{tramp-remote-shell-login} parameters in @code{tramp-methods}, to | ||
| 1792 | be used on that remote host. | ||
| 1793 | |||
| 1794 | @var{property} could also be any property found in the file | ||
| 1795 | @code{tramp-persistency-file-name}. | ||
| 1796 | |||
| 1797 | A special property is @samp{busybox}. This must be set, if the remote | ||
| 1798 | host runs a very restricted busybox as shell, which closes the | ||
| 1767 | connection at will. Since there is no reliable test for this, | 1799 | connection at will. Since there is no reliable test for this, |
| 1768 | @var{tramp} must be indicated this way. Example: | 1800 | @value{tramp} must be indicated this way. Example: |
| 1769 | 1801 | ||
| 1770 | @lisp | 1802 | @lisp |
| 1771 | (add-to-list 'tramp-connection-properties | 1803 | (add-to-list 'tramp-connection-properties |
| @@ -1774,7 +1806,7 @@ connection at will. Since there is no reliable test for this, | |||
| 1774 | @end lisp | 1806 | @end lisp |
| 1775 | 1807 | ||
| 1776 | 1808 | ||
| 1777 | @node Remote Programs | 1809 | @node Remote programs |
| 1778 | @section How @value{tramp} finds and uses programs on the remote host | 1810 | @section How @value{tramp} finds and uses programs on the remote host |
| 1779 | 1811 | ||
| 1780 | @value{tramp} depends on a number of programs on the remote host in order to | 1812 | @value{tramp} depends on a number of programs on the remote host in order to |
| @@ -1821,9 +1853,6 @@ To add a directory to the remote search path, you could use code such | |||
| 1821 | as: | 1853 | as: |
| 1822 | 1854 | ||
| 1823 | @lisp | 1855 | @lisp |
| 1824 | @i{;; We load @value{tramp} to define the variable.} | ||
| 1825 | (require 'tramp) | ||
| 1826 | @i{;; We have @command{perl} in "/usr/local/perl/bin"} | ||
| 1827 | (add-to-list 'tramp-remote-path "/usr/local/perl/bin") | 1856 | (add-to-list 'tramp-remote-path "/usr/local/perl/bin") |
| 1828 | @end lisp | 1857 | @end lisp |
| 1829 | 1858 | ||
| @@ -1892,7 +1921,7 @@ to be set correctly to recognize the shell prompt on the remote host. | |||
| 1892 | 1921 | ||
| 1893 | Note that @value{tramp} requires the match for @code{shell-prompt-pattern} | 1922 | Note that @value{tramp} requires the match for @code{shell-prompt-pattern} |
| 1894 | to be at the end of the buffer. Many people have something like the | 1923 | to be at the end of the buffer. Many people have something like the |
| 1895 | following as the value for the variable: @code{"^[^>$][>$] *"}. Now | 1924 | following as the value for the variable: @samp{^[^>$][>$] *}. Now |
| 1896 | suppose your shell prompt is @code{a <b> c $ }. In this case, | 1925 | suppose your shell prompt is @code{a <b> c $ }. In this case, |
| 1897 | @value{tramp} recognizes the @code{>} character as the end of the prompt, | 1926 | @value{tramp} recognizes the @code{>} character as the end of the prompt, |
| 1898 | but it is not at the end of the buffer. | 1927 | but it is not at the end of the buffer. |
| @@ -2688,7 +2717,7 @@ this is welcome! | |||
| 2688 | When your program is not found in the default search path | 2717 | When your program is not found in the default search path |
| 2689 | @value{tramp} sets on the remote host, you should either use an | 2718 | @value{tramp} sets on the remote host, you should either use an |
| 2690 | absolute path, or extend @code{tramp-remote-path} (see @ref{Remote | 2719 | absolute path, or extend @code{tramp-remote-path} (see @ref{Remote |
| 2691 | Programs}): | 2720 | programs}): |
| 2692 | 2721 | ||
| 2693 | @lisp | 2722 | @lisp |
| 2694 | (add-to-list 'tramp-remote-path "~/bin") | 2723 | (add-to-list 'tramp-remote-path "~/bin") |
| @@ -2698,8 +2727,8 @@ Programs}): | |||
| 2698 | The environment for your program can be adapted by customizing | 2727 | The environment for your program can be adapted by customizing |
| 2699 | @code{tramp-remote-process-environment}. This variable is a list of | 2728 | @code{tramp-remote-process-environment}. This variable is a list of |
| 2700 | strings. It is structured like @code{process-environment}. Each | 2729 | strings. It is structured like @code{process-environment}. Each |
| 2701 | element is a string of the form @code{"ENVVARNAME=VALUE"}. An entry | 2730 | element is a string of the form @samp{ENVVARNAME=VALUE}. An entry |
| 2702 | @code{"ENVVARNAME="} disables the corresponding environment variable, | 2731 | @samp{ENVVARNAME=} disables the corresponding environment variable, |
| 2703 | which might have been set in your init file like @file{~/.profile}. | 2732 | which might have been set in your init file like @file{~/.profile}. |
| 2704 | 2733 | ||
| 2705 | @noindent | 2734 | @noindent |
| @@ -3930,7 +3959,6 @@ Sometimes, it might be even necessary to step through @value{tramp} | |||
| 3930 | function call traces. Such traces are enabled by the following code: | 3959 | function call traces. Such traces are enabled by the following code: |
| 3931 | 3960 | ||
| 3932 | @lisp | 3961 | @lisp |
| 3933 | (require 'tramp) | ||
| 3934 | (require 'trace) | 3962 | (require 'trace) |
| 3935 | (dolist (elt (all-completions "tramp-" obarray 'functionp)) | 3963 | (dolist (elt (all-completions "tramp-" obarray 'functionp)) |
| 3936 | (trace-function-background (intern elt))) | 3964 | (trace-function-background (intern elt))) |
diff --git a/doc/misc/trampver.texi b/doc/misc/trampver.texi index fc6f4c58606..dccf3175386 100644 --- a/doc/misc/trampver.texi +++ b/doc/misc/trampver.texi | |||
| @@ -8,7 +8,7 @@ | |||
| 8 | @c In the Tramp GIT, the version number is auto-frobbed from | 8 | @c In the Tramp GIT, the version number is auto-frobbed from |
| 9 | @c configure.ac, so you should edit that file and run | 9 | @c configure.ac, so you should edit that file and run |
| 10 | @c "autoconf && ./configure" to change the version number. | 10 | @c "autoconf && ./configure" to change the version number. |
| 11 | @set trampver 2.2.12 | 11 | @set trampver 2.2.13-pre |
| 12 | 12 | ||
| 13 | @c Other flags from configuration | 13 | @c Other flags from configuration |
| 14 | @set instprefix /usr/local | 14 | @set instprefix /usr/local |