aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Albinus2018-07-26 11:54:33 +0200
committerMichael Albinus2018-07-26 11:54:33 +0200
commit5cfb7a39baa0a5857915dca65e5880bc3c0c6072 (patch)
tree632ab51d10ea038d320e810676dfc37175f7558a
parent6f8f358e7327a69fbc8f7b5a3fd5b3b170af505e (diff)
downloademacs-5cfb7a39baa0a5857915dca65e5880bc3c0c6072.tar.gz
emacs-5cfb7a39baa0a5857915dca65e5880bc3c0c6072.zip
Copyedits in tramp.texi, improved example with bash's readline
* doc/misc/tramp.texi (all): Unify some wordings. (Frequently Asked Questions): Update example with bash's readline.
-rw-r--r--doc/misc/tramp.texi52
1 files changed, 28 insertions, 24 deletions
diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi
index f05da84745a..222f6c86b9e 100644
--- a/doc/misc/tramp.texi
+++ b/doc/misc/tramp.texi
@@ -1239,7 +1239,7 @@ improvement is not always true.
1239@cindex default user 1239@cindex default user
1240 1240
1241@defopt tramp-default-user 1241@defopt tramp-default-user
1242@value{tramp} file name can omit the user name part since 1242A @value{tramp} file name can omit the user name part since
1243@value{tramp} substitutes the currently logged-in user name. However 1243@value{tramp} substitutes the currently logged-in user name. However
1244this substitution can be overridden with @code{tramp-default-user}. 1244this substitution can be overridden with @code{tramp-default-user}.
1245For example: 1245For example:
@@ -1452,7 +1452,7 @@ support this command.
1452 1452
1453@subsection Tunneling with ssh 1453@subsection Tunneling with ssh
1454 1454
1455With ssh, you could use the @code{ProxyCommand} entry in the 1455With ssh, you could use the @code{ProxyCommand} entry in
1456@file{~/.ssh/config}: 1456@file{~/.ssh/config}:
1457 1457
1458@example 1458@example
@@ -1588,12 +1588,12 @@ A function dedicated to @file{/etc/hosts} for host names.
1588@item @code{tramp-parse-passwd} 1588@item @code{tramp-parse-passwd}
1589@findex tramp-parse-passwd 1589@findex tramp-parse-passwd
1590 1590
1591A function which parses @file{/etc/passwd} files for user names. 1591A function which parses @file{/etc/passwd} for user names.
1592 1592
1593@item @code{tramp-parse-etc-group} 1593@item @code{tramp-parse-etc-group}
1594@findex tramp-parse-etc-group 1594@findex tramp-parse-etc-group
1595 1595
1596A function which parses @file{/etc/group} files for group names. 1596A function which parses @file{/etc/group} for group names.
1597 1597
1598@item @code{tramp-parse-netrc} 1598@item @code{tramp-parse-netrc}
1599@findex tramp-parse-netrc 1599@findex tramp-parse-netrc
@@ -2186,7 +2186,7 @@ of the secretfile is now owned by the user logged in from
2186When @code{backup-directory-alist} is @code{nil} (the default), such 2186When @code{backup-directory-alist} is @code{nil} (the default), such
2187problems do not occur. 2187problems do not occur.
2188 2188
2189To ``turn off'' the backup feature for @value{tramp} files and stop 2189To ``turn off'' the backup feature for remote files and stop
2190@value{tramp} from saving to the backup directory, use this: 2190@value{tramp} from saving to the backup directory, use this:
2191 2191
2192@lisp 2192@lisp
@@ -2248,12 +2248,11 @@ The backup file name of
2248 2248
2249@vindex auto-save-file-name-transforms 2249@vindex auto-save-file-name-transforms
2250Just as for backup files, similar issues of file naming affect 2250Just as for backup files, similar issues of file naming affect
2251auto-saving @value{tramp} files. Auto-saved files are saved in the 2251auto-saving remote files. Auto-saved files are saved in the directory
2252directory specified by the user option 2252specified by the user option @code{auto-save-file-name-transforms}.
2253@code{auto-save-file-name-transforms}. By default this is set to 2253By default this is set to the local temporary directory. But in some
2254the local temporary directory. But in some versions of Debian 2254versions of Debian GNU/Linux, this points to the source directory
2255GNU/Linux, this points to the source directory where the Emacs was 2255where the Emacs was compiled. Reset such values to a valid directory.
2256compiled. Reset such values to a valid directory.
2257 2256
2258Set @code{auto-save-file-name-transforms} to @code{nil} to save 2257Set @code{auto-save-file-name-transforms} to @code{nil} to save
2259auto-saved files to the same directory as the original file. 2258auto-saved files to the same directory as the original file.
@@ -2756,8 +2755,8 @@ hard-coded, fixed name. Note that using @code{:0} for X11 display name
2756here will not work as expected. 2755here will not work as expected.
2757 2756
2758An alternate approach is specify @code{ForwardX11 yes} or 2757An alternate approach is specify @code{ForwardX11 yes} or
2759@code{ForwardX11Trusted yes} in the file @file{~/.ssh/config} on the 2758@code{ForwardX11Trusted yes} in @file{~/.ssh/config} on the local
2760local host. 2759host.
2761 2760
2762 2761
2763@subsection Running @code{shell} on a remote host 2762@subsection Running @code{shell} on a remote host
@@ -3199,12 +3198,17 @@ source "$@{HOME@}/.iterm2_shell_integration.bash"
3199@end group 3198@end group
3200@end example 3199@end example
3201 3200
3202And finally, bash's readline shall not use key bindings like 3201And finally, bash's readline should not use key bindings like
3203@samp{C-j} to commands. Disable reading the readline initialization 3202@samp{C-j} to commands. Disable this in your @file{~/.inputrc}:
3204file:
3205 3203
3206@example 3204@example
3207[ $TERM = "dumb" ] && INPUTRC=/dev/null 3205@group
3206$if term=dumb
3207# Don't bind Control-J or it messes up @value{tramp}.
3208$else
3209"\C-j": next-history
3210$endif
3211@end group
3208@end example 3212@end example
3209 3213
3210@item 3214@item
@@ -3333,13 +3337,13 @@ When testing, ensure the remote shell is the same shell
3333How to get notified after @value{tramp} completes file transfers? 3337How to get notified after @value{tramp} completes file transfers?
3334 3338
3335Make Emacs beep after reading from or writing to the remote host with 3339Make Emacs beep after reading from or writing to the remote host with
3336the following code in @file{~/.emacs} file. 3340the following code in @file{~/.emacs}.
3337 3341
3338@lisp 3342@lisp
3339@group 3343@group
3340(defadvice tramp-handle-write-region 3344(defadvice tramp-handle-write-region
3341 (after tramp-write-beep-advice activate) 3345 (after tramp-write-beep-advice activate)
3342 "Make tramp beep after writing a file." 3346 "Make @value{tramp} beep after writing a file."
3343 (interactive) 3347 (interactive)
3344 (beep)) 3348 (beep))
3345@end group 3349@end group
@@ -3347,7 +3351,7 @@ the following code in @file{~/.emacs} file.
3347@group 3351@group
3348(defadvice tramp-handle-do-copy-or-rename-file 3352(defadvice tramp-handle-do-copy-or-rename-file
3349 (after tramp-copy-beep-advice activate) 3353 (after tramp-copy-beep-advice activate)
3350 "Make tramp beep after copying a file." 3354 "Make @value{tramp} beep after copying a file."
3351 (interactive) 3355 (interactive)
3352 (beep)) 3356 (beep))
3353@end group 3357@end group
@@ -3355,7 +3359,7 @@ the following code in @file{~/.emacs} file.
3355@group 3359@group
3356(defadvice tramp-handle-insert-file-contents 3360(defadvice tramp-handle-insert-file-contents
3357 (after tramp-insert-beep-advice activate) 3361 (after tramp-insert-beep-advice activate)
3358 "Make tramp beep after inserting a file." 3362 "Make @value{tramp} beep after inserting a file."
3359 (interactive) 3363 (interactive)
3360 (beep)) 3364 (beep))
3361@end group 3365@end group
@@ -3393,7 +3397,7 @@ then set them with a hook as follows:
3393 3397
3394 3398
3395@item 3399@item
3396Why is @file{~/.sh_history} file on the remote host growing? 3400Why is @file{~/.sh_history} on the remote host growing?
3397 3401
3398@vindex tramp-histfile-override 3402@vindex tramp-histfile-override
3399@vindex HISTFILE@r{, environment variable} 3403@vindex HISTFILE@r{, environment variable}
@@ -3414,7 +3418,7 @@ undesired results when using @command{bash} as remote shell.
3414Another approach is to disable @value{tramp}'s handling of the 3418Another approach is to disable @value{tramp}'s handling of the
3415@env{HISTFILE} at all by setting @code{tramp-histfile-override} to 3419@env{HISTFILE} at all by setting @code{tramp-histfile-override} to
3416@code{nil}. In this case, saving history could be turned off by 3420@code{nil}. In this case, saving history could be turned off by
3417putting this shell code in the @file{.bashrc} or @file{.kshrc} file: 3421putting this shell code in @file{.bashrc} or @file{.kshrc}:
3418 3422
3419@example 3423@example
3420@group 3424@group
@@ -3431,7 +3435,7 @@ fi
3431@end example 3435@end example
3432 3436
3433For @option{ssh}-based method, add the following line to your 3437For @option{ssh}-based method, add the following line to your
3434@file{~/.ssh/environment} file: 3438@file{~/.ssh/environment}:
3435 3439
3436@example 3440@example
3437HISTFILE=/dev/null 3441HISTFILE=/dev/null