diff options
Diffstat (limited to 'doc/misc')
| -rw-r--r-- | doc/misc/tramp.texi | 32 |
1 files changed, 24 insertions, 8 deletions
diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi index ae544b08712..e21df5ac39b 100644 --- a/doc/misc/tramp.texi +++ b/doc/misc/tramp.texi | |||
| @@ -681,6 +681,7 @@ In case both @command{mimencode} and @command{uuencode} are | |||
| 681 | unavailable, @value{tramp} first transfers a small Perl program to the | 681 | unavailable, @value{tramp} first transfers a small Perl program to the |
| 682 | remote host, and then tries that program for encoding and decoding. | 682 | remote host, and then tries that program for encoding and decoding. |
| 683 | 683 | ||
| 684 | @vindex tramp-inline-compress-start-size | ||
| 684 | To increase transfer speeds for large text files, use compression | 685 | To increase transfer speeds for large text files, use compression |
| 685 | before encoding. The user option | 686 | before encoding. The user option |
| 686 | @option{tramp-inline-compress-start-size} specifies the file size for | 687 | @option{tramp-inline-compress-start-size} specifies the file size for |
| @@ -1023,6 +1024,7 @@ can. | |||
| 1023 | @cindex @option{adb} method | 1024 | @cindex @option{adb} method |
| 1024 | @cindex android (with @option{adb} method) | 1025 | @cindex android (with @option{adb} method) |
| 1025 | 1026 | ||
| 1027 | @vindex tramp-adb-program | ||
| 1026 | This method uses Android Debug Bridge program for accessing Android | 1028 | This method uses Android Debug Bridge program for accessing Android |
| 1027 | devices. The Android Debug Bridge must be installed locally for | 1029 | devices. The Android Debug Bridge must be installed locally for |
| 1028 | @value{tramp} to work. Some GNU/Linux distributions provide Android | 1030 | @value{tramp} to work. Some GNU/Linux distributions provide Android |
| @@ -1031,6 +1033,7 @@ is installed as part of the Android SDK@. @value{tramp} finds the | |||
| 1031 | @command{adb} program either via the @env{PATH} environment variable | 1033 | @command{adb} program either via the @env{PATH} environment variable |
| 1032 | or the absolute path set in the user option @option{tramp-adb-program}. | 1034 | or the absolute path set in the user option @option{tramp-adb-program}. |
| 1033 | 1035 | ||
| 1036 | @vindex tramp-adb-connect-if-not-connected | ||
| 1034 | @value{tramp} connects to Android devices with @option{adb} only when | 1037 | @value{tramp} connects to Android devices with @option{adb} only when |
| 1035 | the user option @option{tramp-adb-connect-if-not-connected} is not | 1038 | the user option @option{tramp-adb-connect-if-not-connected} is not |
| 1036 | @code{nil}. Otherwise, the connection must be established outside | 1039 | @code{nil}. Otherwise, the connection must be established outside |
| @@ -1696,6 +1699,7 @@ Set @code{password-cache} to @code{nil} to disable password caching. | |||
| 1696 | @cindex caching | 1699 | @cindex caching |
| 1697 | @vindex tramp-persistency-file-name | 1700 | @vindex tramp-persistency-file-name |
| 1698 | 1701 | ||
| 1702 | @vindex tramp-persistency-file-name | ||
| 1699 | For faster initial connection times, @value{tramp} stores previous | 1703 | For faster initial connection times, @value{tramp} stores previous |
| 1700 | connection properties in a file specified by the user option | 1704 | connection properties in a file specified by the user option |
| 1701 | @option{tramp-persistency-file-name}. | 1705 | @option{tramp-persistency-file-name}. |
| @@ -1898,6 +1902,7 @@ prompts, for which @value{tramp} uses @option{tramp-wrong-passwd-regexp}. | |||
| 1898 | @cindex @command{tset} unix command | 1902 | @cindex @command{tset} unix command |
| 1899 | @vindex tramp-terminal-type | 1903 | @vindex tramp-terminal-type |
| 1900 | 1904 | ||
| 1905 | @vindex tramp-terminal-type | ||
| 1901 | To suppress inappropriate prompts for terminal type, @value{tramp} | 1906 | To suppress inappropriate prompts for terminal type, @value{tramp} |
| 1902 | sets the @env{TERM} to @code{dumb} before the remote login process | 1907 | sets the @env{TERM} to @code{dumb} before the remote login process |
| 1903 | begins via the user option @option{tramp-terminal-type}. This will | 1908 | begins via the user option @option{tramp-terminal-type}. This will |
| @@ -2171,6 +2176,8 @@ Disabling backups can be targeted to just the @option{su} and | |||
| 2171 | @end group | 2176 | @end group |
| 2172 | @end lisp | 2177 | @end lisp |
| 2173 | 2178 | ||
| 2179 | @vindex backup-directory-alist | ||
| 2180 | @vindex tramp-backup-directory-alist | ||
| 2174 | Another option is to create better backup file naming with user and | 2181 | Another option is to create better backup file naming with user and |
| 2175 | host names prefixed to the file name. For example, transforming | 2182 | host names prefixed to the file name. For example, transforming |
| 2176 | @file{/etc/secretfile} to | 2183 | @file{/etc/secretfile} to |
| @@ -2204,6 +2211,7 @@ The backup file name of | |||
| 2204 | @file{@trampfn{su,root@@localhost,~/.emacs.d/backups/![su!root@@localhost]!etc!secretfile~}} | 2211 | @file{@trampfn{su,root@@localhost,~/.emacs.d/backups/![su!root@@localhost]!etc!secretfile~}} |
| 2205 | @end ifset | 2212 | @end ifset |
| 2206 | 2213 | ||
| 2214 | @vindex auto-save-file-name-transforms | ||
| 2207 | Just as for backup files, similar issues of file naming affect | 2215 | Just as for backup files, similar issues of file naming affect |
| 2208 | auto-saving @value{tramp} files. Auto-saved files are saved in the | 2216 | auto-saving @value{tramp} files. Auto-saved files are saved in the |
| 2209 | directory specified by the user option | 2217 | directory specified by the user option |
| @@ -2215,6 +2223,7 @@ compiled. Reset such values to a valid directory. | |||
| 2215 | Set @option{auto-save-file-name-transforms} to @code{nil} to save | 2223 | Set @option{auto-save-file-name-transforms} to @code{nil} to save |
| 2216 | auto-saved files to the same directory as the original file. | 2224 | auto-saved files to the same directory as the original file. |
| 2217 | 2225 | ||
| 2226 | @vindex tramp-auto-save-directory | ||
| 2218 | Alternatively, set the user option @option{tramp-auto-save-directory} | 2227 | Alternatively, set the user option @option{tramp-auto-save-directory} |
| 2219 | to direct all auto saves to that location. | 2228 | to direct all auto saves to that location. |
| 2220 | 2229 | ||
| @@ -2615,6 +2624,7 @@ upon first connection. Alternatively, use an absolute path or extend | |||
| 2615 | @end group | 2624 | @end group |
| 2616 | @end lisp | 2625 | @end lisp |
| 2617 | 2626 | ||
| 2627 | @vindex tramp-remote-process-environment | ||
| 2618 | Customize user option @option{tramp-remote-process-environment} to | 2628 | Customize user option @option{tramp-remote-process-environment} to |
| 2619 | suit the remote program's environment for the remote host. | 2629 | suit the remote program's environment for the remote host. |
| 2620 | @option{tramp-remote-process-environment} is a list of strings | 2630 | @option{tramp-remote-process-environment} is a list of strings |
| @@ -2660,11 +2670,13 @@ this. You could overwrite this behavior by evaluating | |||
| 2660 | @end group | 2670 | @end group |
| 2661 | @end lisp | 2671 | @end lisp |
| 2662 | 2672 | ||
| 2663 | @value{tramp} does not use the defaults specified in | 2673 | In addition to @option{tramp-remote-process-environment}, you can set |
| 2664 | @code{process-environment} for running @code{process-file} or | 2674 | environment variables for invidivual remote process calls by |
| 2665 | @code{start-file-process} on remote hosts. When values from | 2675 | let-binding @code{process-environment}. @value{tramp} will apply any |
| 2666 | @code{process-environment} are needed for remote processes, then set | 2676 | entries which are not present in the global default value of |
| 2667 | them as follows: | 2677 | @code{process-environment} (overriding |
| 2678 | @option{tramp-remote-process-environment} settings, if they conflict). | ||
| 2679 | For example: | ||
| 2668 | 2680 | ||
| 2669 | @lisp | 2681 | @lisp |
| 2670 | @group | 2682 | @group |
| @@ -2673,8 +2685,10 @@ them as follows: | |||
| 2673 | @end group | 2685 | @end group |
| 2674 | @end lisp | 2686 | @end lisp |
| 2675 | 2687 | ||
| 2676 | This works only for environment variables not already set in the | 2688 | Let-binding in this way works regardless of whether the process to be |
| 2677 | @code{process-environment}. | 2689 | called is local or remote, since @value{tramp} would add just the |
| 2690 | @env{HGPLAIN} setting and local processes would take whole value of | ||
| 2691 | @code{process-environment} along with the new value of @env{HGPLAIN}. | ||
| 2678 | 2692 | ||
| 2679 | For integrating other Emacs packages so @value{tramp} can execute | 2693 | For integrating other Emacs packages so @value{tramp} can execute |
| 2680 | remotely, please file a bug report. @xref{Bug Reports}. | 2694 | remotely, please file a bug report. @xref{Bug Reports}. |
| @@ -3507,6 +3521,7 @@ the following code in @file{~/.emacs} file. | |||
| 3507 | How to get a Visual Warning when working with @samp{root} privileges? | 3521 | How to get a Visual Warning when working with @samp{root} privileges? |
| 3508 | Host indication in the mode line? | 3522 | Host indication in the mode line? |
| 3509 | 3523 | ||
| 3524 | @vindex tramp-theme-face-remapping-alist | ||
| 3510 | Install @file{tramp-theme} from GNU ELPA via Emacs' Package Manager. | 3525 | Install @file{tramp-theme} from GNU ELPA via Emacs' Package Manager. |
| 3511 | Enable it via @kbd{M-x load-theme @key{RET} tramp}. Further | 3526 | Enable it via @kbd{M-x load-theme @key{RET} tramp}. Further |
| 3512 | customization is explained in user option | 3527 | customization is explained in user option |
| @@ -3534,10 +3549,11 @@ then set them with a hook as follows: | |||
| 3534 | @item | 3549 | @item |
| 3535 | Why is @file{~/.sh_history} file on the remote host growing? | 3550 | Why is @file{~/.sh_history} file on the remote host growing? |
| 3536 | 3551 | ||
| 3552 | @vindex tramp-histfile-override | ||
| 3537 | Due to the remote shell saving tilde expansions triggered by | 3553 | Due to the remote shell saving tilde expansions triggered by |
| 3538 | @value{tramp}, the history file is probably growing rapidly. | 3554 | @value{tramp}, the history file is probably growing rapidly. |
| 3539 | @value{tramp} can suppress this behaviour with the user option | 3555 | @value{tramp} can suppress this behaviour with the user option |
| 3540 | @code{tramp-histfile-override}. When set to @code{t}, environment | 3556 | @option{tramp-histfile-override}. When set to @code{t}, environment |
| 3541 | variable @env{HISTFILE} is unset, and environment variables | 3557 | variable @env{HISTFILE} is unset, and environment variables |
| 3542 | @env{HISTFILESIZE} @env{HISTSIZE} are set to 0. | 3558 | @env{HISTFILESIZE} @env{HISTSIZE} are set to 0. |
| 3543 | 3559 | ||