diff options
| author | Robert Pluim | 2024-11-13 17:10:57 +0100 |
|---|---|---|
| committer | Robert Pluim | 2024-11-14 13:56:04 +0100 |
| commit | 8f6ff233ef11e7cc19c524228f48b732a98aa284 (patch) | |
| tree | f128ca364157df839e15dee46c27c49563f3e734 /doc | |
| parent | f69f54c454eb3c0f8ff8c55cfd2b7832ea1709cf (diff) | |
| download | emacs-8f6ff233ef11e7cc19c524228f48b732a98aa284.tar.gz emacs-8f6ff233ef11e7cc19c524228f48b732a98aa284.zip | |
; TRAMP manual spelling and grammar fixes
* doc/misc/tramp.texi (FUSE-based methods):
(Firewalls):
(Predefined connection information):
(Remote programs):
(Remote shell setup):
(Ssh setup):
(Home directories):
(Remote processes):
(Renaming remote files):
(Archive file names):
(Bug Reports):
(Frequently Asked Questions): Use "can" instead of "could" where
it makes sense.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/misc/tramp.texi | 107 |
1 files changed, 55 insertions, 52 deletions
diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi index 0d7f9c11a6b..3ea48774b59 100644 --- a/doc/misc/tramp.texi +++ b/doc/misc/tramp.texi | |||
| @@ -1507,7 +1507,7 @@ absolute path via the user option @code{tramp-rclone-program}. | |||
| 1507 | 1507 | ||
| 1508 | A system storage must be configured via the @command{rclone config} | 1508 | A system storage must be configured via the @command{rclone config} |
| 1509 | command, outside Emacs. If you have configured a storage in | 1509 | command, outside Emacs. If you have configured a storage in |
| 1510 | @command{rclone} under a name @samp{storage} (for example), you could | 1510 | @command{rclone} under a name @samp{storage} (for example), you can |
| 1511 | access it via the remote file name | 1511 | access it via the remote file name |
| 1512 | 1512 | ||
| 1513 | @example | 1513 | @example |
| @@ -1548,7 +1548,7 @@ User name and port number are optional. This method does not support | |||
| 1548 | password handling, the file system must either be mounted already, or | 1548 | password handling, the file system must either be mounted already, or |
| 1549 | the connection must be established passwordless via ssh keys. | 1549 | the connection must be established passwordless via ssh keys. |
| 1550 | 1550 | ||
| 1551 | The mount point and mount arguments could be passed as connection | 1551 | The mount point and mount arguments can be passed as connection |
| 1552 | properties, @xref{Setup of sshfs method}. | 1552 | properties, @xref{Setup of sshfs method}. |
| 1553 | 1553 | ||
| 1554 | @end table | 1554 | @end table |
| @@ -1877,7 +1877,7 @@ support this command. | |||
| 1877 | @subsection Tunneling with ssh | 1877 | @subsection Tunneling with ssh |
| 1878 | 1878 | ||
| 1879 | @vindex ProxyCommand@r{, ssh option} | 1879 | @vindex ProxyCommand@r{, ssh option} |
| 1880 | With @command{ssh}, you could use the @option{ProxyCommand} entry in | 1880 | With @command{ssh}, you can use the @option{ProxyCommand} entry in |
| 1881 | @file{~/.ssh/config}: | 1881 | @file{~/.ssh/config}: |
| 1882 | 1882 | ||
| 1883 | @example | 1883 | @example |
| @@ -2270,7 +2270,7 @@ The parameters @code{tramp-remote-shell} and | |||
| 2270 | @code{tramp-remote-shell-login} in @code{tramp-methods} now have new | 2270 | @code{tramp-remote-shell-login} in @code{tramp-methods} now have new |
| 2271 | values for the remote host. | 2271 | values for the remote host. |
| 2272 | 2272 | ||
| 2273 | @var{property} could also be any property found in | 2273 | @var{property} can also be any property found in |
| 2274 | @code{tramp-persistency-file-name}. | 2274 | @code{tramp-persistency-file-name}. |
| 2275 | 2275 | ||
| 2276 | 2276 | ||
| @@ -2420,7 +2420,7 @@ variables, @xref{Connection Variables, , , emacs}. | |||
| 2420 | @ifnotinfo | 2420 | @ifnotinfo |
| 2421 | variables. | 2421 | variables. |
| 2422 | @end ifnotinfo | 2422 | @end ifnotinfo |
| 2423 | You could define your own search directories like this: | 2423 | You can define your own search directories like this: |
| 2424 | 2424 | ||
| 2425 | @lisp | 2425 | @lisp |
| 2426 | @group | 2426 | @group |
| @@ -2594,10 +2594,10 @@ prompts, for which @value{tramp} uses @code{tramp-wrong-passwd-regexp}. | |||
| 2594 | 2594 | ||
| 2595 | @value{tramp} uses the user option @code{tramp-terminal-type} to set | 2595 | @value{tramp} uses the user option @code{tramp-terminal-type} to set |
| 2596 | the remote environment variable @env{TERM} for the shells it runs. | 2596 | the remote environment variable @env{TERM} for the shells it runs. |
| 2597 | By default, it is @t{"dumb"}, but this could be changed. A dumb | 2597 | By default, it is @t{"dumb"}, but this can be changed. A dumb |
| 2598 | terminal is best suited to run the background sessions of | 2598 | terminal is best suited to run the background sessions of |
| 2599 | @value{tramp}. However, running interactive remote shells might | 2599 | @value{tramp}. However, running interactive remote shells might |
| 2600 | require a different setting. This could be achieved by tweaking the | 2600 | require a different setting. This can be achieved by tweaking the |
| 2601 | @env{TERM} environment variable in @code{process-environment}. | 2601 | @env{TERM} environment variable in @code{process-environment}. |
| 2602 | 2602 | ||
| 2603 | @lisp | 2603 | @lisp |
| @@ -2633,7 +2633,7 @@ process, @xref{Interactive Shell, , , emacs}. | |||
| 2633 | @ifnotinfo | 2633 | @ifnotinfo |
| 2634 | process. | 2634 | process. |
| 2635 | @end ifnotinfo | 2635 | @end ifnotinfo |
| 2636 | @value{tramp} adds its own package version to this string, which could | 2636 | @value{tramp} adds its own package version to this string, which can |
| 2637 | be used for further tests in an inferior shell. The string of that | 2637 | be used for further tests in an inferior shell. The string of that |
| 2638 | environment variable looks always like | 2638 | environment variable looks always like |
| 2639 | 2639 | ||
| @@ -2853,7 +2853,8 @@ Host * | |||
| 2853 | 2853 | ||
| 2854 | The corresponding PuTTY configuration is in the @option{Connection} | 2854 | The corresponding PuTTY configuration is in the @option{Connection} |
| 2855 | entry, @option{Seconds between keepalives} option. Set this to 5. | 2855 | entry, @option{Seconds between keepalives} option. Set this to 5. |
| 2856 | There is no counter which could be set. | 2856 | PuTTY does not have a configuration option equivalent to OpenSSH's |
| 2857 | @option{ServerAliveCountMax}. | ||
| 2857 | 2858 | ||
| 2858 | 2859 | ||
| 2859 | @anchor{Using ssh connection sharing} | 2860 | @anchor{Using ssh connection sharing} |
| @@ -3904,7 +3905,7 @@ directory has been used already. | |||
| 3904 | 3905 | ||
| 3905 | The methods @option{adb}, @option{rclone} and @option{sshfs} do not | 3906 | The methods @option{adb}, @option{rclone} and @option{sshfs} do not |
| 3906 | support home directory expansion at all. However, @value{tramp} keeps | 3907 | support home directory expansion at all. However, @value{tramp} keeps |
| 3907 | the home directory in the cache. Therefore, those methods could be | 3908 | the home directory in the cache. Therefore, those methods can be |
| 3908 | configured to expand a home directory via a connection property, | 3909 | configured to expand a home directory via a connection property, |
| 3909 | @xref{Predefined connection information}. Example: | 3910 | @xref{Predefined connection information}. Example: |
| 3910 | 3911 | ||
| @@ -4104,18 +4105,18 @@ Due to the remote shell saving tilde expansions triggered by | |||
| 4104 | @code{tramp-histfile-override}. When set to @code{t}, environment | 4105 | @code{tramp-histfile-override}. When set to @code{t}, environment |
| 4105 | variable @env{HISTFILE} is unset, and environment variables | 4106 | variable @env{HISTFILE} is unset, and environment variables |
| 4106 | @env{HISTFILESIZE} and @env{HISTSIZE} are set to 0. Don't use this | 4107 | @env{HISTFILESIZE} and @env{HISTSIZE} are set to 0. Don't use this |
| 4107 | with @command{bash} 5.0.0. There is a bug in @command{bash} which | 4108 | with @command{bash} 5.0.0@: that version has a bug which |
| 4108 | lets @command{bash} die. | 4109 | causes @command{bash} to die. |
| 4109 | 4110 | ||
| 4110 | Alternatively, @code{tramp-histfile-override} could be a string. | 4111 | Alternatively, @code{tramp-histfile-override} can be a string. |
| 4111 | Environment variable @env{HISTFILE} is set to this file name then. Be | 4112 | The environment variable @env{HISTFILE} is then set to this file name. Be |
| 4112 | careful when setting to @file{/dev/null}; this might result in | 4113 | careful if using @file{/dev/null}; this might result in undesired |
| 4113 | undesired results when using @command{bash} as remote shell. | 4114 | results when using @command{bash} as remote shell. |
| 4114 | 4115 | ||
| 4115 | Another approach is to disable @value{tramp}'s handling of the | 4116 | Another approach is to completely disable @value{tramp}'s handling of |
| 4116 | @env{HISTFILE} at all by setting @code{tramp-histfile-override} to | 4117 | the @env{HISTFILE} by setting @code{tramp-histfile-override} to |
| 4117 | @code{nil}. In this case, saving history could be turned off by | 4118 | @code{nil}. In this case, saving history can be turned off by putting |
| 4118 | putting this shell code in @file{.bashrc} or @file{.kshrc}: | 4119 | this shell code in @file{.bashrc} or @file{.kshrc}: |
| 4119 | 4120 | ||
| 4120 | @example | 4121 | @example |
| 4121 | @group | 4122 | @group |
| @@ -4152,7 +4153,7 @@ ensures the correct name of the remote shell program. | |||
| 4152 | When @code{explicit-shell-file-name} is equal to @code{nil}, calling | 4153 | When @code{explicit-shell-file-name} is equal to @code{nil}, calling |
| 4153 | @code{shell} interactively will prompt for a shell name. | 4154 | @code{shell} interactively will prompt for a shell name. |
| 4154 | 4155 | ||
| 4155 | You could use connection-local variables for setting different values | 4156 | You can use connection-local variables for setting different values |
| 4156 | of @code{explicit-shell-file-name} for different remote hosts. | 4157 | of @code{explicit-shell-file-name} for different remote hosts. |
| 4157 | @ifinfo | 4158 | @ifinfo |
| 4158 | @xref{Connection Variables, , , emacs}. | 4159 | @xref{Connection Variables, , , emacs}. |
| @@ -4442,11 +4443,11 @@ the @code{process-attributes} output plus the key @code{pid}, and | |||
| 4442 | be | 4443 | be |
| 4443 | 4444 | ||
| 4444 | 4445 | ||
| 4445 | @multitable {@bullet{} @code{numberp}} {--- a string of @var{number} width, could contain spaces} | 4446 | @multitable {@bullet{} @code{numberp}} {--- a string of @var{number} width, can contain spaces} |
| 4446 | @item @bullet{} @code{numberp} @tab --- a number | 4447 | @item @bullet{} @code{numberp} @tab --- a number |
| 4447 | @item @bullet{} @code{stringp} @tab --- a string without spaces | 4448 | @item @bullet{} @code{stringp} @tab --- a string without spaces |
| 4448 | @item @bullet{} @var{number} | 4449 | @item @bullet{} @var{number} |
| 4449 | @tab --- a string of @var{number} width, could contain spaces | 4450 | @tab --- a string of @var{number} width, can contain spaces |
| 4450 | @item @bullet{} @code{nil} @tab --- a string until end of line | 4451 | @item @bullet{} @code{nil} @tab --- a string until end of line |
| 4451 | @end multitable | 4452 | @end multitable |
| 4452 | 4453 | ||
| @@ -4690,7 +4691,7 @@ anymore. | |||
| 4690 | 4691 | ||
| 4691 | @deffn Command tramp-rename-files source target | 4692 | @deffn Command tramp-rename-files source target |
| 4692 | Replace in all buffers the visiting file name from @var{source} to | 4693 | Replace in all buffers the visiting file name from @var{source} to |
| 4693 | @var{target}. @var{source} is a remote directory name, which could | 4694 | @var{target}. @var{source} is a remote directory name, which can |
| 4694 | contain also a localname part. @var{target} is the directory name | 4695 | contain also a localname part. @var{target} is the directory name |
| 4695 | @var{source} is replaced with. Often, @var{target} is a remote | 4696 | @var{source} is replaced with. Often, @var{target} is a remote |
| 4696 | directory name on another host, but it can also be a local directory | 4697 | directory name on another host, but it can also be a local directory |
| @@ -4739,17 +4740,19 @@ The default target for renaming remote buffer file names. This is an | |||
| 4739 | alist of cons cells @code{(source . target)}. The first matching item | 4740 | alist of cons cells @code{(source . target)}. The first matching item |
| 4740 | specifies the target to be applied for renaming buffer file names from | 4741 | specifies the target to be applied for renaming buffer file names from |
| 4741 | source via @code{tramp-rename-files}. @code{source} is a regular | 4742 | source via @code{tramp-rename-files}. @code{source} is a regular |
| 4742 | expressions, which matches a remote file name. @code{target} must be | 4743 | expression, which is used to match a remote file name. @code{target} |
| 4743 | a directory name, which could be remote (including remote directories | 4744 | must be a directory name, which can be remote (including remote |
| 4744 | @value{tramp} infers by default, such as @file{@trampfn{method,user@@host,}}). | 4745 | directories which @value{tramp} infers by default, such as |
| 4746 | @file{@trampfn{method,user@@host,}}). | ||
| 4745 | 4747 | ||
| 4746 | @code{target} can contain the patterns @code{%m}, @code{%u} or | 4748 | @code{target} can contain the format specifiers @code{%m}, @code{%u}, |
| 4747 | @code{%h}, which are replaced by the method name, user name or host | 4749 | or @code{%h}, which are replaced by the method name, user name, or host |
| 4748 | name of @code{source} when calling @code{tramp-rename-files}. | 4750 | name of @code{source} respectively when calling @code{tramp-rename-files}. |
| 4749 | 4751 | ||
| 4750 | @code{source} could also be a Lisp form, which will be evaluated. The | 4752 | @code{source} can also be a Lisp form, which is evaluated. The result |
| 4751 | result must be a string or @code{nil}, which is interpreted as a | 4753 | must be a string (which is used as a regular expression to match) or |
| 4752 | regular expression which always matches. | 4754 | @code{nil}, which is interpreted as a regular expression which always |
| 4755 | matches. | ||
| 4753 | 4756 | ||
| 4754 | Example entries: | 4757 | Example entries: |
| 4755 | 4758 | ||
| @@ -5001,7 +5004,7 @@ constant @code{tramp-archive-compression-suffixes}. They are | |||
| 5001 | row are possible, like @file{/path/to/dir/file.tar.gz.uu/dir/file}. | 5004 | row are possible, like @file{/path/to/dir/file.tar.gz.uu/dir/file}. |
| 5002 | 5005 | ||
| 5003 | @vindex tramp-archive-all-gvfs-methods | 5006 | @vindex tramp-archive-all-gvfs-methods |
| 5004 | An archive file name could be a remote file name, as in | 5007 | An archive file name can be a remote file name, as in |
| 5005 | @file{/ftp:anonymous@@ftp.gnu.org:/gnu/tramp/tramp-2.4.5.tar.gz/INSTALL}. | 5008 | @file{/ftp:anonymous@@ftp.gnu.org:/gnu/tramp/tramp-2.4.5.tar.gz/INSTALL}. |
| 5006 | Since all file operations are mapped internally to @acronym{GVFS} | 5009 | Since all file operations are mapped internally to @acronym{GVFS} |
| 5007 | operations, remote file names supported by @code{tramp-gvfs} perform | 5010 | operations, remote file names supported by @code{tramp-gvfs} perform |
| @@ -5011,7 +5014,7 @@ the similar @samp{/scp:user@@host:...}. See the constant | |||
| 5011 | @code{tramp-archive-all-gvfs-methods} for a complete list of | 5014 | @code{tramp-archive-all-gvfs-methods} for a complete list of |
| 5012 | @code{tramp-gvfs} supported method names. | 5015 | @code{tramp-gvfs} supported method names. |
| 5013 | 5016 | ||
| 5014 | If @code{url-handler-mode} is enabled, archives could be visited via | 5017 | If @code{url-handler-mode} is enabled, archives can be visited via |
| 5015 | URLs, like | 5018 | URLs, like |
| 5016 | @file{https://ftp.gnu.org/gnu/tramp/tramp-2.4.5.tar.gz/INSTALL}. This | 5019 | @file{https://ftp.gnu.org/gnu/tramp/tramp-2.4.5.tar.gz/INSTALL}. This |
| 5017 | allows complex file operations like | 5020 | allows complex file operations like |
| @@ -5039,7 +5042,7 @@ coreutils_8.28-1_amd64.deb/control.tar.gz/control")) | |||
| 5039 | @end lisp | 5042 | @end lisp |
| 5040 | 5043 | ||
| 5041 | @vindex tramp-archive-enabled | 5044 | @vindex tramp-archive-enabled |
| 5042 | In order to disable file archives, you could add the following form to | 5045 | In order to disable file archives, you can add the following form to |
| 5043 | your init file: | 5046 | your init file: |
| 5044 | 5047 | ||
| 5045 | @lisp | 5048 | @lisp |
| @@ -5115,21 +5118,21 @@ When including @value{tramp}'s messages in the bug report, increase | |||
| 5115 | the verbosity level to 6 (@pxref{Traces and Profiles, Traces}) in the | 5118 | the verbosity level to 6 (@pxref{Traces and Profiles, Traces}) in the |
| 5116 | @file{~/.emacs} file before repeating steps to the bug. Include the | 5119 | @file{~/.emacs} file before repeating steps to the bug. Include the |
| 5117 | contents of the @file{*tramp/foo*} and @file{*debug tramp/foo*} | 5120 | contents of the @file{*tramp/foo*} and @file{*debug tramp/foo*} |
| 5118 | buffers with the bug report. Both buffers could contain | 5121 | buffers with the bug report. Since those buffers could contain |
| 5119 | non-@acronym{ASCII} characters which are relevant for analysis, append | 5122 | non-@acronym{ASCII} characters which are relevant for analysis, append |
| 5120 | the buffers as attachments to the bug report. This is also needed in | 5123 | the buffers as attachments to the bug report rather than placing them |
| 5121 | order to avoid line breaks during mail transfer. | 5124 | inline. This is also needed in order to avoid line breaks getting added |
| 5125 | or deleted during mail transfer. | ||
| 5122 | 5126 | ||
| 5123 | If you send the message from Emacs, you are asked about to append | 5127 | If you send the message from Emacs, you are asked whether to append |
| 5124 | these buffers to the bug report. If you use an external mail program, | 5128 | these buffers to the bug report. If you use an external mail program, |
| 5125 | you must save these buffers to files, and append them with that mail | 5129 | you must save these buffers to files, and append them with that mail |
| 5126 | program. | 5130 | program. |
| 5127 | 5131 | ||
| 5128 | @strong{Note} that a verbosity level greater than 6 is not necessary | 5132 | @strong{Note} that a verbosity level greater than 6 is not necessary at |
| 5129 | at this stage. Also note that a verbosity level of 6 or greater, the | 5133 | this stage. Also note that with a verbosity level of 6 or greater, the |
| 5130 | contents of files and directories will be included in the debug | 5134 | contents of files and directories will be included in the debug buffer. |
| 5131 | buffer. Passwords typed in @value{tramp} will never be included | 5135 | Passwords typed in @value{tramp} will never be included there. |
| 5132 | there. | ||
| 5133 | 5136 | ||
| 5134 | 5137 | ||
| 5135 | @node Frequently Asked Questions | 5138 | @node Frequently Asked Questions |
| @@ -5312,7 +5315,7 @@ as value of the @env{TERM} environment variable. If you want to use | |||
| 5312 | another value for @env{TERM}, change @code{tramp-terminal-type} and | 5315 | another value for @env{TERM}, change @code{tramp-terminal-type} and |
| 5313 | this line accordingly. | 5316 | this line accordingly. |
| 5314 | 5317 | ||
| 5315 | Alternatively, you could set the remote login shell explicitly. See | 5318 | Alternatively, you can set the remote login shell explicitly. See |
| 5316 | @ref{Remote shell setup} for discussion of this technique, | 5319 | @ref{Remote shell setup} for discussion of this technique, |
| 5317 | 5320 | ||
| 5318 | When using fish shell on remote hosts, disable fancy formatting by | 5321 | When using fish shell on remote hosts, disable fancy formatting by |
| @@ -5619,7 +5622,7 @@ encrypted}), which are deleted anyway. | |||
| 5619 | @c Since Emacs 30. | 5622 | @c Since Emacs 30. |
| 5620 | @vindex trash-directory | 5623 | @vindex trash-directory |
| 5621 | If you want to trash a remote file into a remote trash directory, you | 5624 | If you want to trash a remote file into a remote trash directory, you |
| 5622 | could configure the user option @code{trash-directory} to a | 5625 | can configure the user option @code{trash-directory} to a |
| 5623 | connection-local value. | 5626 | connection-local value. |
| 5624 | @ifinfo | 5627 | @ifinfo |
| 5625 | @xref{Connection Variables, , , emacs}. | 5628 | @xref{Connection Variables, , , emacs}. |
| @@ -5658,7 +5661,7 @@ is @file{@trampfn{ssh,news@@news.my.domain,/opt/news/etc}}, then: | |||
| 5658 | Use simplified syntax: | 5661 | Use simplified syntax: |
| 5659 | 5662 | ||
| 5660 | If you always apply the default method (@pxref{Default Method}), you | 5663 | If you always apply the default method (@pxref{Default Method}), you |
| 5661 | could use the simplified @value{tramp} syntax (@pxref{Change file name | 5664 | can use the simplified @value{tramp} syntax (@pxref{Change file name |
| 5662 | syntax}): | 5665 | syntax}): |
| 5663 | 5666 | ||
| 5664 | @lisp | 5667 | @lisp |
| @@ -5968,7 +5971,7 @@ the buffer is remote. See the optional arguments of | |||
| 5968 | How to save files when a remote host isn't reachable anymore? | 5971 | How to save files when a remote host isn't reachable anymore? |
| 5969 | 5972 | ||
| 5970 | If the local machine Emacs is running on changes its network | 5973 | If the local machine Emacs is running on changes its network |
| 5971 | integration, remote hosts could become unreachable. This happens for | 5974 | integration, remote hosts could become unreachable. This happens, for |
| 5972 | example, if the local machine is moved between your office and your | 5975 | example, if the local machine is moved between your office and your |
| 5973 | home without restarting Emacs. | 5976 | home without restarting Emacs. |
| 5974 | 5977 | ||
| @@ -5988,9 +5991,9 @@ an unresponsive remote host could trigger @code{recentf} to connect | |||
| 5988 | that host again and again. | 5991 | that host again and again. |
| 5989 | 5992 | ||
| 5990 | If you find the cleanup disturbing, because the file names in | 5993 | If you find the cleanup disturbing, because the file names in |
| 5991 | @code{recentf-list} are precious to you, you could add the following | 5994 | @code{recentf-list} are precious to you, you can add the following |
| 5992 | two forms in your @file{~/.emacs} after loading the @code{tramp} and | 5995 | two forms in your @file{~/.emacs} (after loading the @code{tramp} and |
| 5993 | @code{recentf} packages: | 5996 | @code{recentf} packages): |
| 5994 | 5997 | ||
| 5995 | @vindex tramp-cleanup-connection-hook | 5998 | @vindex tramp-cleanup-connection-hook |
| 5996 | @vindex tramp-cleanup-all-connections-hook | 5999 | @vindex tramp-cleanup-all-connections-hook |