aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Albinus2018-02-13 08:35:50 +0100
committerMichael Albinus2018-02-13 08:35:50 +0100
commitf568c916b6d1e20e18fced8d773aa8f86e7c576f (patch)
treee0b1fe5de80a0713d183f863bf4d9335fae20212
parent92ca881dc83617a53fb057bcb9e91877cc848f9a (diff)
downloademacs-f568c916b6d1e20e18fced8d773aa8f86e7c576f.tar.gz
emacs-f568c916b6d1e20e18fced8d773aa8f86e7c576f.zip
* doc/misc/tramp.texi: Index more user options.
-rw-r--r--doc/misc/tramp.texi13
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi
index 8bb34e2c56d..161f48ca3c8 100644
--- a/doc/misc/tramp.texi
+++ b/doc/misc/tramp.texi
@@ -670,6 +670,7 @@ In case both @command{mimencode} and @command{uuencode} are
670unavailable, @value{tramp} first transfers a small Perl program to the 670unavailable, @value{tramp} first transfers a small Perl program to the
671remote host, and then tries that program for encoding and decoding. 671remote host, and then tries that program for encoding and decoding.
672 672
673@vindex tramp-inline-compress-start-size
673To increase transfer speeds for large text files, use compression 674To increase transfer speeds for large text files, use compression
674before encoding. The user option 675before encoding. The user option
675@option{tramp-inline-compress-start-size} specifies the file size for 676@option{tramp-inline-compress-start-size} specifies the file size for
@@ -1020,6 +1021,7 @@ can.
1020@cindex adb method 1021@cindex adb method
1021@cindex android (with adb method) 1022@cindex android (with adb method)
1022 1023
1024@vindex tramp-adb-program
1023This method uses Android Debug Bridge program for accessing Android 1025This method uses Android Debug Bridge program for accessing Android
1024devices. The Android Debug Bridge must be installed locally for 1026devices. The Android Debug Bridge must be installed locally for
1025@value{tramp} to work. Some GNU/Linux distributions provide Android 1027@value{tramp} to work. Some GNU/Linux distributions provide Android
@@ -1028,6 +1030,7 @@ is installed as part of the Android SDK@. @value{tramp} finds the
1028@command{adb} program either via the @env{PATH} environment variable 1030@command{adb} program either via the @env{PATH} environment variable
1029or the absolute path set in the user option @option{tramp-adb-program}. 1031or the absolute path set in the user option @option{tramp-adb-program}.
1030 1032
1033@vindex tramp-adb-connect-if-not-connected
1031@value{tramp} connects to Android devices with @option{adb} only when 1034@value{tramp} connects to Android devices with @option{adb} only when
1032the user option @option{tramp-adb-connect-if-not-connected} is not 1035the user option @option{tramp-adb-connect-if-not-connected} is not
1033@code{nil}. Otherwise, the connection must be established outside 1036@code{nil}. Otherwise, the connection must be established outside
@@ -1678,6 +1681,7 @@ Set @code{password-cache} to @code{nil} to disable password caching.
1678@cindex caching 1681@cindex caching
1679@vindex tramp-persistency-file-name 1682@vindex tramp-persistency-file-name
1680 1683
1684@vindex tramp-persistency-file-name
1681For faster initial connection times, @value{tramp} stores previous 1685For faster initial connection times, @value{tramp} stores previous
1682connection properties in a file specified by the user option 1686connection properties in a file specified by the user option
1683@option{tramp-persistency-file-name}. 1687@option{tramp-persistency-file-name}.
@@ -1880,6 +1884,7 @@ prompts, for which @value{tramp} uses @option{tramp-wrong-passwd-regexp}.
1880@cindex tset unix command 1884@cindex tset unix command
1881@vindex tramp-terminal-type 1885@vindex tramp-terminal-type
1882 1886
1887@vindex tramp-terminal-type
1883To suppress inappropriate prompts for terminal type, @value{tramp} 1888To suppress inappropriate prompts for terminal type, @value{tramp}
1884sets the @env{TERM} to @code{dumb} before the remote login process 1889sets the @env{TERM} to @code{dumb} before the remote login process
1885begins via the user option @option{tramp-terminal-type}. This will 1890begins via the user option @option{tramp-terminal-type}. This will
@@ -2153,6 +2158,8 @@ Disabling backups can be targeted to just the @option{su} and
2153@end group 2158@end group
2154@end lisp 2159@end lisp
2155 2160
2161@vindex backup-directory-alist
2162@vindex tramp-backup-directory-alist
2156Another option is to create better backup file naming with user and 2163Another option is to create better backup file naming with user and
2157host names prefixed to the file name. For example, transforming 2164host names prefixed to the file name. For example, transforming
2158@file{/etc/secretfile} to 2165@file{/etc/secretfile} to
@@ -2186,6 +2193,7 @@ The backup file name of
2186@file{@trampfn{su,root@@localhost,~/.emacs.d/backups/![su!root@@localhost]!etc!secretfile~}} 2193@file{@trampfn{su,root@@localhost,~/.emacs.d/backups/![su!root@@localhost]!etc!secretfile~}}
2187@end ifset 2194@end ifset
2188 2195
2196@vindex auto-save-file-name-transforms
2189Just as for backup files, similar issues of file naming affect 2197Just as for backup files, similar issues of file naming affect
2190auto-saving @value{tramp} files. Auto-saved files are saved in the 2198auto-saving @value{tramp} files. Auto-saved files are saved in the
2191directory specified by the user option 2199directory specified by the user option
@@ -2197,6 +2205,7 @@ compiled. Reset such values to a valid directory.
2197Set @option{auto-save-file-name-transforms} to @code{nil} to save 2205Set @option{auto-save-file-name-transforms} to @code{nil} to save
2198auto-saved files to the same directory as the original file. 2206auto-saved files to the same directory as the original file.
2199 2207
2208@vindex tramp-auto-save-directory
2200Alternatively, set the user option @option{tramp-auto-save-directory} 2209Alternatively, set the user option @option{tramp-auto-save-directory}
2201to direct all auto saves to that location. 2210to direct all auto saves to that location.
2202 2211
@@ -3284,6 +3293,7 @@ the following code in @file{~/.emacs} file.
3284How to get a Visual Warning when working with @samp{root} privileges? 3293How to get a Visual Warning when working with @samp{root} privileges?
3285Host indication in the mode line? 3294Host indication in the mode line?
3286 3295
3296@vindex tramp-theme-face-remapping-alist
3287Install @file{tramp-theme} from GNU ELPA via Emacs' Package Manager. 3297Install @file{tramp-theme} from GNU ELPA via Emacs' Package Manager.
3288Enable it via @kbd{M-x load-theme @key{RET} tramp}. Further 3298Enable it via @kbd{M-x load-theme @key{RET} tramp}. Further
3289customization is explained in user option 3299customization is explained in user option
@@ -3311,10 +3321,11 @@ then set them with a hook as follows:
3311@item 3321@item
3312Why is @file{~/.sh_history} file on the remote host growing? 3322Why is @file{~/.sh_history} file on the remote host growing?
3313 3323
3324@vindex tramp-histfile-override
3314Due to the remote shell saving tilde expansions triggered by 3325Due to the remote shell saving tilde expansions triggered by
3315@value{tramp}, the history file is probably growing rapidly. 3326@value{tramp}, the history file is probably growing rapidly.
3316@value{tramp} can suppress this behaviour with the user option 3327@value{tramp} can suppress this behaviour with the user option
3317@code{tramp-histfile-override}. When set to @code{t}, environment 3328@option{tramp-histfile-override}. When set to @code{t}, environment
3318variable @env{HISTFILE} is unset, and environment variables 3329variable @env{HISTFILE} is unset, and environment variables
3319@env{HISTFILESIZE} @env{HISTSIZE} are set to 0. 3330@env{HISTFILESIZE} @env{HISTSIZE} are set to 0.
3320 3331