1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-11-24 07:20:37 +00:00

; 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.
This commit is contained in:
Robert Pluim 2024-11-13 17:10:57 +01:00
parent f69f54c454
commit 8f6ff233ef

View File

@ -1507,7 +1507,7 @@ absolute path via the user option @code{tramp-rclone-program}.
A system storage must be configured via the @command{rclone config} A system storage must be configured via the @command{rclone config}
command, outside Emacs. If you have configured a storage in command, outside Emacs. If you have configured a storage in
@command{rclone} under a name @samp{storage} (for example), you could @command{rclone} under a name @samp{storage} (for example), you can
access it via the remote file name access it via the remote file name
@example @example
@ -1548,7 +1548,7 @@ User name and port number are optional. This method does not support
password handling, the file system must either be mounted already, or password handling, the file system must either be mounted already, or
the connection must be established passwordless via ssh keys. the connection must be established passwordless via ssh keys.
The mount point and mount arguments could be passed as connection The mount point and mount arguments can be passed as connection
properties, @xref{Setup of sshfs method}. properties, @xref{Setup of sshfs method}.
@end table @end table
@ -1877,7 +1877,7 @@ support this command.
@subsection Tunneling with ssh @subsection Tunneling with ssh
@vindex ProxyCommand@r{, ssh option} @vindex ProxyCommand@r{, ssh option}
With @command{ssh}, you could use the @option{ProxyCommand} entry in With @command{ssh}, you can use the @option{ProxyCommand} entry in
@file{~/.ssh/config}: @file{~/.ssh/config}:
@example @example
@ -2270,7 +2270,7 @@ The parameters @code{tramp-remote-shell} and
@code{tramp-remote-shell-login} in @code{tramp-methods} now have new @code{tramp-remote-shell-login} in @code{tramp-methods} now have new
values for the remote host. values for the remote host.
@var{property} could also be any property found in @var{property} can also be any property found in
@code{tramp-persistency-file-name}. @code{tramp-persistency-file-name}.
@ -2420,7 +2420,7 @@ variables, @xref{Connection Variables, , , emacs}.
@ifnotinfo @ifnotinfo
variables. variables.
@end ifnotinfo @end ifnotinfo
You could define your own search directories like this: You can define your own search directories like this:
@lisp @lisp
@group @group
@ -2594,10 +2594,10 @@ prompts, for which @value{tramp} uses @code{tramp-wrong-passwd-regexp}.
@value{tramp} uses the user option @code{tramp-terminal-type} to set @value{tramp} uses the user option @code{tramp-terminal-type} to set
the remote environment variable @env{TERM} for the shells it runs. the remote environment variable @env{TERM} for the shells it runs.
By default, it is @t{"dumb"}, but this could be changed. A dumb By default, it is @t{"dumb"}, but this can be changed. A dumb
terminal is best suited to run the background sessions of terminal is best suited to run the background sessions of
@value{tramp}. However, running interactive remote shells might @value{tramp}. However, running interactive remote shells might
require a different setting. This could be achieved by tweaking the require a different setting. This can be achieved by tweaking the
@env{TERM} environment variable in @code{process-environment}. @env{TERM} environment variable in @code{process-environment}.
@lisp @lisp
@ -2633,7 +2633,7 @@ process, @xref{Interactive Shell, , , emacs}.
@ifnotinfo @ifnotinfo
process. process.
@end ifnotinfo @end ifnotinfo
@value{tramp} adds its own package version to this string, which could @value{tramp} adds its own package version to this string, which can
be used for further tests in an inferior shell. The string of that be used for further tests in an inferior shell. The string of that
environment variable looks always like environment variable looks always like
@ -2853,7 +2853,8 @@ Host *
The corresponding PuTTY configuration is in the @option{Connection} The corresponding PuTTY configuration is in the @option{Connection}
entry, @option{Seconds between keepalives} option. Set this to 5. entry, @option{Seconds between keepalives} option. Set this to 5.
There is no counter which could be set. PuTTY does not have a configuration option equivalent to OpenSSH's
@option{ServerAliveCountMax}.
@anchor{Using ssh connection sharing} @anchor{Using ssh connection sharing}
@ -3904,7 +3905,7 @@ directory has been used already.
The methods @option{adb}, @option{rclone} and @option{sshfs} do not The methods @option{adb}, @option{rclone} and @option{sshfs} do not
support home directory expansion at all. However, @value{tramp} keeps support home directory expansion at all. However, @value{tramp} keeps
the home directory in the cache. Therefore, those methods could be the home directory in the cache. Therefore, those methods can be
configured to expand a home directory via a connection property, configured to expand a home directory via a connection property,
@xref{Predefined connection information}. Example: @xref{Predefined connection information}. Example:
@ -4104,18 +4105,18 @@ Due to the remote shell saving tilde expansions triggered by
@code{tramp-histfile-override}. When set to @code{t}, environment @code{tramp-histfile-override}. When set to @code{t}, environment
variable @env{HISTFILE} is unset, and environment variables variable @env{HISTFILE} is unset, and environment variables
@env{HISTFILESIZE} and @env{HISTSIZE} are set to 0. Don't use this @env{HISTFILESIZE} and @env{HISTSIZE} are set to 0. Don't use this
with @command{bash} 5.0.0. There is a bug in @command{bash} which with @command{bash} 5.0.0@: that version has a bug which
lets @command{bash} die. causes @command{bash} to die.
Alternatively, @code{tramp-histfile-override} could be a string. Alternatively, @code{tramp-histfile-override} can be a string.
Environment variable @env{HISTFILE} is set to this file name then. Be The environment variable @env{HISTFILE} is then set to this file name. Be
careful when setting to @file{/dev/null}; this might result in careful if using @file{/dev/null}; this might result in undesired
undesired results when using @command{bash} as remote shell. results when using @command{bash} as remote shell.
Another approach is to disable @value{tramp}'s handling of the Another approach is to completely disable @value{tramp}'s handling of
@env{HISTFILE} at all by setting @code{tramp-histfile-override} to the @env{HISTFILE} by setting @code{tramp-histfile-override} to
@code{nil}. In this case, saving history could be turned off by @code{nil}. In this case, saving history can be turned off by putting
putting this shell code in @file{.bashrc} or @file{.kshrc}: this shell code in @file{.bashrc} or @file{.kshrc}:
@example @example
@group @group
@ -4152,7 +4153,7 @@ ensures the correct name of the remote shell program.
When @code{explicit-shell-file-name} is equal to @code{nil}, calling When @code{explicit-shell-file-name} is equal to @code{nil}, calling
@code{shell} interactively will prompt for a shell name. @code{shell} interactively will prompt for a shell name.
You could use connection-local variables for setting different values You can use connection-local variables for setting different values
of @code{explicit-shell-file-name} for different remote hosts. of @code{explicit-shell-file-name} for different remote hosts.
@ifinfo @ifinfo
@xref{Connection Variables, , , emacs}. @xref{Connection Variables, , , emacs}.
@ -4442,11 +4443,11 @@ the @code{process-attributes} output plus the key @code{pid}, and
be be
@multitable {@bullet{} @code{numberp}} {--- a string of @var{number} width, could contain spaces} @multitable {@bullet{} @code{numberp}} {--- a string of @var{number} width, can contain spaces}
@item @bullet{} @code{numberp} @tab --- a number @item @bullet{} @code{numberp} @tab --- a number
@item @bullet{} @code{stringp} @tab --- a string without spaces @item @bullet{} @code{stringp} @tab --- a string without spaces
@item @bullet{} @var{number} @item @bullet{} @var{number}
@tab --- a string of @var{number} width, could contain spaces @tab --- a string of @var{number} width, can contain spaces
@item @bullet{} @code{nil} @tab --- a string until end of line @item @bullet{} @code{nil} @tab --- a string until end of line
@end multitable @end multitable
@ -4690,7 +4691,7 @@ anymore.
@deffn Command tramp-rename-files source target @deffn Command tramp-rename-files source target
Replace in all buffers the visiting file name from @var{source} to Replace in all buffers the visiting file name from @var{source} to
@var{target}. @var{source} is a remote directory name, which could @var{target}. @var{source} is a remote directory name, which can
contain also a localname part. @var{target} is the directory name contain also a localname part. @var{target} is the directory name
@var{source} is replaced with. Often, @var{target} is a remote @var{source} is replaced with. Often, @var{target} is a remote
directory name on another host, but it can also be a local directory 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
alist of cons cells @code{(source . target)}. The first matching item alist of cons cells @code{(source . target)}. The first matching item
specifies the target to be applied for renaming buffer file names from specifies the target to be applied for renaming buffer file names from
source via @code{tramp-rename-files}. @code{source} is a regular source via @code{tramp-rename-files}. @code{source} is a regular
expressions, which matches a remote file name. @code{target} must be expression, which is used to match a remote file name. @code{target}
a directory name, which could be remote (including remote directories must be a directory name, which can be remote (including remote
@value{tramp} infers by default, such as @file{@trampfn{method,user@@host,}}). directories which @value{tramp} infers by default, such as
@file{@trampfn{method,user@@host,}}).
@code{target} can contain the patterns @code{%m}, @code{%u} or @code{target} can contain the format specifiers @code{%m}, @code{%u},
@code{%h}, which are replaced by the method name, user name or host or @code{%h}, which are replaced by the method name, user name, or host
name of @code{source} when calling @code{tramp-rename-files}. name of @code{source} respectively when calling @code{tramp-rename-files}.
@code{source} could also be a Lisp form, which will be evaluated. The @code{source} can also be a Lisp form, which is evaluated. The result
result must be a string or @code{nil}, which is interpreted as a must be a string (which is used as a regular expression to match) or
regular expression which always matches. @code{nil}, which is interpreted as a regular expression which always
matches.
Example entries: Example entries:
@ -5001,7 +5004,7 @@ constant @code{tramp-archive-compression-suffixes}. They are
row are possible, like @file{/path/to/dir/file.tar.gz.uu/dir/file}. row are possible, like @file{/path/to/dir/file.tar.gz.uu/dir/file}.
@vindex tramp-archive-all-gvfs-methods @vindex tramp-archive-all-gvfs-methods
An archive file name could be a remote file name, as in An archive file name can be a remote file name, as in
@file{/ftp:anonymous@@ftp.gnu.org:/gnu/tramp/tramp-2.4.5.tar.gz/INSTALL}. @file{/ftp:anonymous@@ftp.gnu.org:/gnu/tramp/tramp-2.4.5.tar.gz/INSTALL}.
Since all file operations are mapped internally to @acronym{GVFS} Since all file operations are mapped internally to @acronym{GVFS}
operations, remote file names supported by @code{tramp-gvfs} perform operations, remote file names supported by @code{tramp-gvfs} perform
@ -5011,7 +5014,7 @@ the similar @samp{/scp:user@@host:...}. See the constant
@code{tramp-archive-all-gvfs-methods} for a complete list of @code{tramp-archive-all-gvfs-methods} for a complete list of
@code{tramp-gvfs} supported method names. @code{tramp-gvfs} supported method names.
If @code{url-handler-mode} is enabled, archives could be visited via If @code{url-handler-mode} is enabled, archives can be visited via
URLs, like URLs, like
@file{https://ftp.gnu.org/gnu/tramp/tramp-2.4.5.tar.gz/INSTALL}. This @file{https://ftp.gnu.org/gnu/tramp/tramp-2.4.5.tar.gz/INSTALL}. This
allows complex file operations like allows complex file operations like
@ -5039,7 +5042,7 @@ coreutils_8.28-1_amd64.deb/control.tar.gz/control"))
@end lisp @end lisp
@vindex tramp-archive-enabled @vindex tramp-archive-enabled
In order to disable file archives, you could add the following form to In order to disable file archives, you can add the following form to
your init file: your init file:
@lisp @lisp
@ -5115,21 +5118,21 @@ When including @value{tramp}'s messages in the bug report, increase
the verbosity level to 6 (@pxref{Traces and Profiles, Traces}) in the the verbosity level to 6 (@pxref{Traces and Profiles, Traces}) in the
@file{~/.emacs} file before repeating steps to the bug. Include the @file{~/.emacs} file before repeating steps to the bug. Include the
contents of the @file{*tramp/foo*} and @file{*debug tramp/foo*} contents of the @file{*tramp/foo*} and @file{*debug tramp/foo*}
buffers with the bug report. Both buffers could contain buffers with the bug report. Since those buffers could contain
non-@acronym{ASCII} characters which are relevant for analysis, append non-@acronym{ASCII} characters which are relevant for analysis, append
the buffers as attachments to the bug report. This is also needed in the buffers as attachments to the bug report rather than placing them
order to avoid line breaks during mail transfer. inline. This is also needed in order to avoid line breaks getting added
or deleted during mail transfer.
If you send the message from Emacs, you are asked about to append If you send the message from Emacs, you are asked whether to append
these buffers to the bug report. If you use an external mail program, these buffers to the bug report. If you use an external mail program,
you must save these buffers to files, and append them with that mail you must save these buffers to files, and append them with that mail
program. program.
@strong{Note} that a verbosity level greater than 6 is not necessary @strong{Note} that a verbosity level greater than 6 is not necessary at
at this stage. Also note that a verbosity level of 6 or greater, the this stage. Also note that with a verbosity level of 6 or greater, the
contents of files and directories will be included in the debug contents of files and directories will be included in the debug buffer.
buffer. Passwords typed in @value{tramp} will never be included Passwords typed in @value{tramp} will never be included there.
there.
@node Frequently Asked Questions @node Frequently Asked Questions
@ -5312,7 +5315,7 @@ as value of the @env{TERM} environment variable. If you want to use
another value for @env{TERM}, change @code{tramp-terminal-type} and another value for @env{TERM}, change @code{tramp-terminal-type} and
this line accordingly. this line accordingly.
Alternatively, you could set the remote login shell explicitly. See Alternatively, you can set the remote login shell explicitly. See
@ref{Remote shell setup} for discussion of this technique, @ref{Remote shell setup} for discussion of this technique,
When using fish shell on remote hosts, disable fancy formatting by When using fish shell on remote hosts, disable fancy formatting by
@ -5619,7 +5622,7 @@ encrypted}), which are deleted anyway.
@c Since Emacs 30. @c Since Emacs 30.
@vindex trash-directory @vindex trash-directory
If you want to trash a remote file into a remote trash directory, you If you want to trash a remote file into a remote trash directory, you
could configure the user option @code{trash-directory} to a can configure the user option @code{trash-directory} to a
connection-local value. connection-local value.
@ifinfo @ifinfo
@xref{Connection Variables, , , emacs}. @xref{Connection Variables, , , emacs}.
@ -5658,7 +5661,7 @@ is @file{@trampfn{ssh,news@@news.my.domain,/opt/news/etc}}, then:
Use simplified syntax: Use simplified syntax:
If you always apply the default method (@pxref{Default Method}), you If you always apply the default method (@pxref{Default Method}), you
could use the simplified @value{tramp} syntax (@pxref{Change file name can use the simplified @value{tramp} syntax (@pxref{Change file name
syntax}): syntax}):
@lisp @lisp
@ -5968,7 +5971,7 @@ the buffer is remote. See the optional arguments of
How to save files when a remote host isn't reachable anymore? How to save files when a remote host isn't reachable anymore?
If the local machine Emacs is running on changes its network If the local machine Emacs is running on changes its network
integration, remote hosts could become unreachable. This happens for integration, remote hosts could become unreachable. This happens, for
example, if the local machine is moved between your office and your example, if the local machine is moved between your office and your
home without restarting Emacs. home without restarting Emacs.
@ -5988,9 +5991,9 @@ an unresponsive remote host could trigger @code{recentf} to connect
that host again and again. that host again and again.
If you find the cleanup disturbing, because the file names in If you find the cleanup disturbing, because the file names in
@code{recentf-list} are precious to you, you could add the following @code{recentf-list} are precious to you, you can add the following
two forms in your @file{~/.emacs} after loading the @code{tramp} and two forms in your @file{~/.emacs} (after loading the @code{tramp} and
@code{recentf} packages: @code{recentf} packages):
@vindex tramp-cleanup-connection-hook @vindex tramp-cleanup-connection-hook
@vindex tramp-cleanup-all-connections-hook @vindex tramp-cleanup-all-connections-hook