aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMichael Albinus2024-11-15 15:10:34 +0100
committerMichael Albinus2024-11-15 15:10:34 +0100
commitdf4bc525a81a532619869eaa8a2bb6e404011d75 (patch)
treea658bdd04e8c02b2a430be5f82fab0d71fc8de20 /doc
parent310ce93d02c5317be589803fbde96fd20b96e496 (diff)
parentc29c54410ea889bafc1bb4a29664827bc893b7d4 (diff)
downloademacs-df4bc525a81a532619869eaa8a2bb6e404011d75.tar.gz
emacs-df4bc525a81a532619869eaa8a2bb6e404011d75.zip
Merge from origin/emacs-30
c29c54410ea * lisp/subr.el (read-number): Document collision with 'fo... 68337106f91 ; Fix TRAMP manual indexing 8f6ff233ef1 ; TRAMP manual spelling and grammar fixes
Diffstat (limited to 'doc')
-rw-r--r--doc/misc/tramp.texi329
1 files changed, 166 insertions, 163 deletions
diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi
index d429ef33780..72f9428cffc 100644
--- a/doc/misc/tramp.texi
+++ b/doc/misc/tramp.texi
@@ -819,18 +819,18 @@ availability and usability of one of the commands defined in
819@code{tramp-inline-compress-commands}. 819@code{tramp-inline-compress-commands}.
820 820
821@table @asis 821@table @asis
822@item @option{rsh}
823@cindex method @option{rsh} 822@cindex method @option{rsh}
824@cindex @option{rsh} method 823@cindex @option{rsh} method
824@item @option{rsh}
825 825
826@command{rsh} is an option for connecting to hosts within local 826@command{rsh} is an option for connecting to hosts within local
827networks since @command{rsh} is not as secure as other methods. 827networks since @command{rsh} is not as secure as other methods.
828There should be no reason to use it, as @command{ssh} is a both a 828There should be no reason to use it, as @command{ssh} is a both a
829complete replacement and ubiquitous. 829complete replacement and ubiquitous.
830 830
831@item @option{ssh}
832@cindex method @option{ssh} 831@cindex method @option{ssh}
833@cindex @option{ssh} method 832@cindex @option{ssh} method
833@item @option{ssh}
834 834
835@command{ssh} is a more secure option than others to connect to a 835@command{ssh} is a more secure option than others to connect to a
836remote host. 836remote host.
@@ -840,25 +840,25 @@ example, a host on port 42 is specified as @file{host#42} (the real
840host name, a hash sign, then a port number). It is the same as passing 840host name, a hash sign, then a port number). It is the same as passing
841@samp{-p 42} to the @command{ssh} command. 841@samp{-p 42} to the @command{ssh} command.
842 842
843@item @option{telnet}
844@cindex method @option{telnet} 843@cindex method @option{telnet}
845@cindex @option{telnet} method 844@cindex @option{telnet} method
845@item @option{telnet}
846 846
847Connecting to a remote host with @command{telnet} is as insecure 847Connecting to a remote host with @command{telnet} is as insecure
848as the @option{rsh} method. 848as the @option{rsh} method.
849 849
850@item @option{su}
851@cindex method @option{su} 850@cindex method @option{su}
852@cindex @option{su} method 851@cindex @option{su} method
852@item @option{su}
853 853
854Instead of connecting to a remote host, @command{su} program allows 854Instead of connecting to a remote host, @command{su} program allows
855editing as another user. The host can be either @samp{localhost} or 855editing as another user. The host can be either @samp{localhost} or
856the host returned by the function @command{(system-name)}. See 856the host returned by the function @command{(system-name)}. See
857@ref{Multi-hops} for an exception to this behavior. 857@ref{Multi-hops} for an exception to this behavior.
858 858
859@item @option{androidsu}
860@cindex method @option{androidsu} 859@cindex method @option{androidsu}
861@cindex @option{androidsu} method 860@cindex @option{androidsu} method
861@item @option{androidsu}
862 862
863Because the default implementation of the @option{su} method and other 863Because the default implementation of the @option{su} method and other
864shell-based methods conflict with non-standard @command{su} 864shell-based methods conflict with non-standard @command{su}
@@ -871,9 +871,9 @@ multi-hops are unsupported.
871This is an optional method, @pxref{Optional methods}. It is enabled by 871This is an optional method, @pxref{Optional methods}. It is enabled by
872default on @code{android} systems only. 872default on @code{android} systems only.
873 873
874@item @option{sudo}
875@cindex method @option{sudo} 874@cindex method @option{sudo}
876@cindex @option{sudo} method 875@cindex @option{sudo} method
876@item @option{sudo}
877 877
878Similar to @option{su} method, @option{sudo} uses @command{sudo}. 878Similar to @option{su} method, @option{sudo} uses @command{sudo}.
879@command{sudo} must have sufficient rights to start a shell. 879@command{sudo} must have sufficient rights to start a shell.
@@ -882,17 +882,17 @@ For security reasons, a @option{sudo} connection is disabled after a
882predefined timeout (5 minutes by default). This can be changed, 882predefined timeout (5 minutes by default). This can be changed,
883@pxref{Predefined connection information}. 883@pxref{Predefined connection information}.
884 884
885@item @option{doas}
886@cindex method @option{doas} 885@cindex method @option{doas}
887@cindex @option{doas} method 886@cindex @option{doas} method
887@item @option{doas}
888 888
889This method is used on OpenBSD like the @command{sudo} command. Like 889This method is used on OpenBSD like the @command{sudo} command. Like
890the @option{sudo} method, a @option{doas} connection is disabled after 890the @option{sudo} method, a @option{doas} connection is disabled after
891a predefined timeout. 891a predefined timeout.
892 892
893@item @option{run0}
894@cindex method @option{run0} 893@cindex method @option{run0}
895@cindex @option{run0} method 894@cindex @option{run0} method
895@item @option{run0}
896 896
897@c This requires systemd 256. Check with 'systemd-run --version'. 897@c This requires systemd 256. Check with 'systemd-run --version'.
898This method is used on @code{systemd}-based hosts. A @option{run0} 898This method is used on @code{systemd}-based hosts. A @option{run0}
@@ -900,9 +900,9 @@ connection is disabled after a predefined timeout as well.
900 900
901This is an optional method, @pxref{Optional methods}. 901This is an optional method, @pxref{Optional methods}.
902 902
903@item @option{sg}
904@cindex method @option{sg} 903@cindex method @option{sg}
905@cindex @option{sg} method 904@cindex @option{sg} method
905@item @option{sg}
906 906
907The @command{sg} program allows editing as different group. The host 907The @command{sg} program allows editing as different group. The host
908can be either @samp{localhost} or the host returned by the function 908can be either @samp{localhost} or the host returned by the function
@@ -910,9 +910,9 @@ can be either @samp{localhost} or the host returned by the function
910denotes a group name. See @ref{Multi-hops} for an exception to this 910denotes a group name. See @ref{Multi-hops} for an exception to this
911behavior. 911behavior.
912 912
913@item @option{sshx}
914@cindex method @option{sshx} 913@cindex method @option{sshx}
915@cindex @option{sshx} method 914@cindex @option{sshx} method
915@item @option{sshx}
916 916
917Works like @option{ssh} but without the extra authentication prompts. 917Works like @option{ssh} but without the extra authentication prompts.
918@option{sshx} uses @samp{ssh -t -t -l @var{user} -o 918@option{sshx} uses @samp{ssh -t -t -l @var{user} -o
@@ -933,27 +933,27 @@ missing shell prompts that confuses @value{tramp}.
933 933
934@option{sshx} supports the @samp{-p} argument. 934@option{sshx} supports the @samp{-p} argument.
935 935
936@item @option{krlogin}
937@cindex method @option{krlogin} 936@cindex method @option{krlogin}
938@cindex @option{krlogin} method 937@cindex @option{krlogin} method
939@cindex kerberos (with @option{krlogin} method) 938@cindex kerberos (with @option{krlogin} method)
939@item @option{krlogin}
940 940
941This method is also similar to @option{ssh}. It uses the 941This method is also similar to @option{ssh}. It uses the
942@command{krlogin -x} command only for remote host login. 942@command{krlogin -x} command only for remote host login.
943 943
944This method is an optional method, @pxref{Optional methods}. 944This method is an optional method, @pxref{Optional methods}.
945 945
946@item @option{ksu}
947@cindex method @option{ksu} 946@cindex method @option{ksu}
948@cindex @option{ksu} method 947@cindex @option{ksu} method
949@cindex kerberos (with @option{ksu} method) 948@cindex kerberos (with @option{ksu} method)
949@item @option{ksu}
950 950
951This is another method from the Kerberos suite. It behaves like 951This is another method from the Kerberos suite. It behaves like
952@option{su}. It is an optional method, @pxref{Optional methods}. 952@option{su}. It is an optional method, @pxref{Optional methods}.
953 953
954@item @option{plink}
955@cindex method @option{plink} 954@cindex method @option{plink}
956@cindex @option{plink} method 955@cindex @option{plink} method
956@item @option{plink}
957 957
958@option{plink} method is for MS Windows users with the PuTTY 958@option{plink} method is for MS Windows users with the PuTTY
959implementation of SSH@. It uses @samp{plink -ssh} to log in to the 959implementation of SSH@. It uses @samp{plink -ssh} to log in to the
@@ -964,9 +964,9 @@ session.
964 964
965@option{plink} method supports the @samp{-P} argument. 965@option{plink} method supports the @samp{-P} argument.
966 966
967@item @option{plinkx}
968@cindex method @option{plinkx} 967@cindex method @option{plinkx}
969@cindex @option{plinkx} method 968@cindex @option{plinkx} method
969@item @option{plinkx}
970 970
971Another method using PuTTY on MS Windows with session names instead of 971Another method using PuTTY on MS Windows with session names instead of
972host names. @option{plinkx} calls @samp{plink -load @var{session} 972host names. @option{plinkx} calls @samp{plink -load @var{session}
@@ -982,9 +982,9 @@ The following methods allow to access running containers in different
982ways: 982ways:
983 983
984@table @asis 984@table @asis
985@item @option{docker}
986@cindex method @option{docker} 985@cindex method @option{docker}
987@cindex @option{docker} method 986@cindex @option{docker} method
987@item @option{docker}
988 988
989Integration for Docker containers. The host name may be either a 989Integration for Docker containers. The host name may be either a
990running container's name or ID, as returned by @samp{docker ps}. 990running container's name or ID, as returned by @samp{docker ps}.
@@ -994,9 +994,9 @@ If the @command{docker} program isn't found in your @env{PATH}
994environment variable, you can tell @value{tramp} its absolute path via 994environment variable, you can tell @value{tramp} its absolute path via
995the user option @code{tramp-docker-program}. 995the user option @code{tramp-docker-program}.
996 996
997@item @option{podman}
998@cindex method @option{podman} 997@cindex method @option{podman}
999@cindex @option{podman} method 998@cindex @option{podman} method
999@item @option{podman}
1000 1000
1001Podman is an alternative to @option{docker} which may be run rootless, 1001Podman is an alternative to @option{docker} which may be run rootless,
1002if desired. 1002if desired.
@@ -1006,9 +1006,9 @@ If the @command{podman} program isn't found in your @env{PATH}
1006environment variable, you can tell @value{tramp} its absolute path via 1006environment variable, you can tell @value{tramp} its absolute path via
1007the user option @code{tramp-podman-program}. 1007the user option @code{tramp-podman-program}.
1008 1008
1009@item @option{kubernetes}
1010@cindex method @option{kubernetes} 1009@cindex method @option{kubernetes}
1011@cindex @option{kubernetes} method 1010@cindex @option{kubernetes} method
1011@item @option{kubernetes}
1012 1012
1013Integration for containers in Kubernetes pods. The host name is 1013Integration for containers in Kubernetes pods. The host name is
1014@samp{@var{pod}}, or @samp{@var{container}.@var{pod}} if an explicit 1014@samp{@var{pod}}, or @samp{@var{container}.@var{pod}} if an explicit
@@ -1025,12 +1025,12 @@ tell @value{tramp} its absolute path via the user option
1025 1025
1026This method does not support user names. 1026This method does not support user names.
1027 1027
1028@item @option{toolbox}
1029@item @option{distrobox}
1030@cindex method @option{toolbox} 1028@cindex method @option{toolbox}
1031@cindex @option{toolbox} method 1029@cindex @option{toolbox} method
1030@item @option{toolbox}
1032@cindex method @option{distrobox} 1031@cindex method @option{distrobox}
1033@cindex @option{distrobox} method 1032@cindex @option{distrobox} method
1033@item @option{distrobox}
1034 1034
1035Integration of Toolbox or Distrobox system containers, respectively. 1035Integration of Toolbox or Distrobox system containers, respectively.
1036The host name may be either a container's name or ID, as returned by 1036The host name may be either a container's name or ID, as returned by
@@ -1051,9 +1051,9 @@ absolute path via the user option @code{tramp-toolbox-program} or
1051These are optional methods, @pxref{Optional methods}. They do not 1051These are optional methods, @pxref{Optional methods}. They do not
1052support user names. 1052support user names.
1053 1053
1054@item @option{flatpak}
1055@cindex method @option{flatpak} 1054@cindex method @option{flatpak}
1056@cindex @option{flatpak} method 1055@cindex @option{flatpak} method
1056@item @option{flatpak}
1057 1057
1058Integration of Flatpak sandboxes. The host name may be either an 1058Integration of Flatpak sandboxes. The host name may be either an
1059application ID, a sandbox instance ID, or a PID, as returned by 1059application ID, a sandbox instance ID, or a PID, as returned by
@@ -1067,9 +1067,9 @@ the user option @code{tramp-flatpak-program}.
1067This is an optional method, @pxref{Optional methods}. It does not 1067This is an optional method, @pxref{Optional methods}. It does not
1068support user names. 1068support user names.
1069 1069
1070@item @option{apptainer}
1071@cindex method @option{apptainer} 1070@cindex method @option{apptainer}
1072@cindex @option{apptainer} method 1071@cindex @option{apptainer} method
1072@item @option{apptainer}
1073 1073
1074Integration of Apptainer instances. The host name is the instance 1074Integration of Apptainer instances. The host name is the instance
1075name, as returned by @samp{apptainer instance list}. 1075name, as returned by @samp{apptainer instance list}.
@@ -1082,9 +1082,9 @@ the user option @code{tramp-apptainer-program}.
1082This is an optional method, @pxref{Optional methods}. It does not 1082This is an optional method, @pxref{Optional methods}. It does not
1083support user names. 1083support user names.
1084 1084
1085@item @option{nspawn}
1086@cindex method @option{nspawn} 1085@cindex method @option{nspawn}
1087@cindex @option{nspawn} method 1086@cindex @option{nspawn} method
1087@item @option{nspawn}
1088 1088
1089Integration of @code{systemd-nspawn} instances. The host name is the 1089Integration of @code{systemd-nspawn} instances. The host name is the
1090instance name, as returned by @samp{machinectl list --all}. 1090instance name, as returned by @samp{machinectl list --all}.
@@ -1116,10 +1116,10 @@ files smaller than @code{tramp-copy-size-limit} still use inline
1116methods. 1116methods.
1117 1117
1118@table @asis 1118@table @asis
1119@item @option{rcp}
1120@cindex method @option{rcp} 1119@cindex method @option{rcp}
1121@cindex @option{rcp} method 1120@cindex @option{rcp} method
1122@cindex @command{rsh} (with @option{rcp} method) 1121@cindex @command{rsh} (with @option{rcp} method)
1122@item @option{rcp}
1123 1123
1124This method uses the @command{rsh} and @command{rcp} commands to 1124This method uses the @command{rsh} and @command{rcp} commands to
1125connect to the remote host and transfer files. This is the fastest 1125connect to the remote host and transfer files. This is the fastest
@@ -1128,10 +1128,10 @@ access method available.
1128The alternative method @option{remcp} uses the @command{remsh} and 1128The alternative method @option{remcp} uses the @command{remsh} and
1129@command{rcp} commands. 1129@command{rcp} commands.
1130 1130
1131@item @option{scp}
1132@cindex method @option{scp} 1131@cindex method @option{scp}
1133@cindex @option{scp} method 1132@cindex @option{scp} method
1134@cindex @command{ssh} (with @option{scp} method) 1133@cindex @command{ssh} (with @option{scp} method)
1134@item @option{scp}
1135 1135
1136Using a combination of @command{ssh} to connect and @command{scp} to 1136Using a combination of @command{ssh} to connect and @command{scp} to
1137transfer is the most secure. While the performance is good, it is 1137transfer is the most secure. While the performance is good, it is
@@ -1144,10 +1144,10 @@ port numbers. For example, @file{host#42} passes @samp{-p 42} in the
1144argument list to @command{ssh}, and @samp{-P 42} in the argument list 1144argument list to @command{ssh}, and @samp{-P 42} in the argument list
1145to @command{scp}. 1145to @command{scp}.
1146 1146
1147@item @option{rsync}
1148@cindex method @option{rsync} 1147@cindex method @option{rsync}
1149@cindex @option{rsync} method 1148@cindex @option{rsync} method
1150@cindex @command{ssh} (with @option{rsync} method) 1149@cindex @command{ssh} (with @option{rsync} method)
1150@item @option{rsync}
1151 1151
1152@command{ssh} command to connect in combination with @command{rsync} 1152@command{ssh} command to connect in combination with @command{rsync}
1153command to transfer is similar to the @option{scp} method. 1153command to transfer is similar to the @option{scp} method.
@@ -1158,10 +1158,10 @@ is lost if the file exists only on one side of the connection.
1158 1158
1159This method supports the @samp{-p} argument. 1159This method supports the @samp{-p} argument.
1160 1160
1161@item @option{scpx}
1162@cindex method @option{scpx} 1161@cindex method @option{scpx}
1163@cindex @option{scpx} method 1162@cindex @option{scpx} method
1164@cindex @command{ssh} (with @option{scpx} method) 1163@cindex @command{ssh} (with @option{scpx} method)
1164@item @option{scpx}
1165 1165
1166@option{scpx} is useful to avoid login shell questions. It is similar 1166@option{scpx} is useful to avoid login shell questions. It is similar
1167in performance to @option{scp}. @option{scpx} uses @samp{ssh -t -t -l 1167in performance to @option{scp}. @option{scpx} uses @samp{ssh -t -t -l
@@ -1175,16 +1175,16 @@ missing shell prompts that confuses @value{tramp}.
1175 1175
1176This method supports the @samp{-p} argument. 1176This method supports the @samp{-p} argument.
1177 1177
1178@item @option{pscp}
1179@item @option{psftp}
1180@cindex method @option{pscp} 1178@cindex method @option{pscp}
1181@cindex @option{pscp} method 1179@cindex @option{pscp} method
1182@cindex @command{plink} (with @option{pscp} method) 1180@cindex @command{plink} (with @option{pscp} method)
1183@cindex @command{putty} (with @option{pscp} method) 1181@cindex @command{putty} (with @option{pscp} method)
1182@item @option{pscp}
1184@cindex method @option{psftp} 1183@cindex method @option{psftp}
1185@cindex @option{psftp} method 1184@cindex @option{psftp} method
1186@cindex @command{plink} (with @option{psftp} method) 1185@cindex @command{plink} (with @option{psftp} method)
1187@cindex @command{putty} (with @option{psftp} method) 1186@cindex @command{putty} (with @option{psftp} method)
1187@item @option{psftp}
1188 1188
1189These methods are similar to @option{scp} or @option{sftp}, but they 1189These methods are similar to @option{scp} or @option{sftp}, but they
1190use the @command{plink} command to connect to the remote host, and 1190use the @command{plink} command to connect to the remote host, and
@@ -1198,12 +1198,12 @@ session.
1198 1198
1199These methods support the @samp{-P} argument. 1199These methods support the @samp{-P} argument.
1200 1200
1201@item @option{dockercp}
1202@item @option{podmancp}
1203@cindex method @option{dockercp} 1201@cindex method @option{dockercp}
1204@cindex @option{dockercp} method 1202@cindex @option{dockercp} method
1203@item @option{dockercp}
1205@cindex method @option{podmancp} 1204@cindex method @option{podmancp}
1206@cindex @option{podmancp} method 1205@cindex @option{podmancp} method
1206@item @option{podmancp}
1207 1207
1208These methods are similar to @option{docker} or @option{podman}, but 1208These methods are similar to @option{docker} or @option{podman}, but
1209they use the command @command{docker cp} or @command{podman cp} for 1209they use the command @command{docker cp} or @command{podman cp} for
@@ -1212,10 +1212,10 @@ transferring large files.
1212These copy commands do not support file globs, and they ignore a user 1212These copy commands do not support file globs, and they ignore a user
1213name. 1213name.
1214 1214
1215@item @option{fcp}
1216@cindex method @option{fcp} 1215@cindex method @option{fcp}
1217@cindex @option{fcp} method 1216@cindex @option{fcp} method
1218@cindex @command{fsh} (with @option{fcp} method) 1217@cindex @command{fsh} (with @option{fcp} method)
1218@item @option{fcp}
1219 1219
1220This method is similar to @option{scp}, but uses @command{fsh} to 1220This method is similar to @option{scp}, but uses @command{fsh} to
1221connect and @command{fcp} to transfer files. @command{fsh/fcp}, a 1221connect and @command{fcp} to transfer files. @command{fsh/fcp}, a
@@ -1236,10 +1236,10 @@ and @value{tramp} keeps that one connection open.
1236 1236
1237This is an optional method, @pxref{Optional methods}. 1237This is an optional method, @pxref{Optional methods}.
1238 1238
1239@item @option{nc}
1240@cindex method @option{nc} 1239@cindex method @option{nc}
1241@cindex @option{nc} method 1240@cindex @option{nc} method
1242@cindex @command{telnet} (with @option{nc} method) 1241@cindex @command{telnet} (with @option{nc} method)
1242@item @option{nc}
1243 1243
1244Using @command{telnet} to connect and @command{nc} to transfer files 1244Using @command{telnet} to connect and @command{nc} to transfer files
1245is sometimes the only combination suitable for accessing routers or 1245is sometimes the only combination suitable for accessing routers or
@@ -1249,9 +1249,9 @@ decode programs.
1249 1249
1250This is an optional method, @pxref{Optional methods}. 1250This is an optional method, @pxref{Optional methods}.
1251 1251
1252@item @option{sudoedit}
1253@cindex method @option{sudoedit} 1252@cindex method @option{sudoedit}
1254@cindex @option{sudoedit} method 1253@cindex @option{sudoedit} method
1254@item @option{sudoedit}
1255 1255
1256The @option{sudoedit} method facilitates editing a file as a different 1256The @option{sudoedit} method facilitates editing a file as a different
1257user on the local host. You could regard this as @value{tramp}'s 1257user on the local host. You could regard this as @value{tramp}'s
@@ -1273,19 +1273,19 @@ use any host name in the remote file name, like
1273Like the @option{sudo} method, a @option{sudoedit} password expires 1273Like the @option{sudo} method, a @option{sudoedit} password expires
1274after a predefined timeout. 1274after a predefined timeout.
1275 1275
1276@item @option{ftp}
1277@cindex method @option{ftp} 1276@cindex method @option{ftp}
1278@cindex @option{ftp} method 1277@cindex @option{ftp} method
1278@item @option{ftp}
1279 1279
1280When @value{tramp} uses @option{ftp}, it forwards requests to whatever 1280When @value{tramp} uses @option{ftp}, it forwards requests to whatever
1281ftp program is specified by Ange FTP@. This external program must be 1281ftp program is specified by Ange FTP@. This external program must be
1282capable of servicing requests from @value{tramp}. 1282capable of servicing requests from @value{tramp}.
1283 1283
1284@item @option{smb}
1285@cindex method @option{smb} 1284@cindex method @option{smb}
1286@cindex @option{smb} method 1285@cindex @option{smb} method
1287@cindex ms windows (with @option{smb} method) 1286@cindex ms windows (with @option{smb} method)
1288@cindex @command{smbclient} 1287@cindex @command{smbclient}
1288@item @option{smb}
1289 1289
1290This non-native @value{tramp} method connects via the Server Message 1290This non-native @value{tramp} method connects via the Server Message
1291Block (SMB) networking protocol to hosts running file servers that are 1291Block (SMB) networking protocol to hosts running file servers that are
@@ -1354,10 +1354,10 @@ UNC file name specification does not allow the specification of a
1354different user name for authentication like the @command{smbclient} 1354different user name for authentication like the @command{smbclient}
1355can. 1355can.
1356 1356
1357@item @option{adb}
1358@cindex method @option{adb} 1357@cindex method @option{adb}
1359@cindex @option{adb} method 1358@cindex @option{adb} method
1360@cindex android (with @option{adb} method) 1359@cindex android (with @option{adb} method)
1360@item @option{adb}
1361 1361
1362@vindex tramp-adb-program 1362@vindex tramp-adb-program
1363@vindex PATH@r{, environment variable} 1363@vindex PATH@r{, environment variable}
@@ -1412,22 +1412,22 @@ Emacs must have the message bus system, D-Bus integration active,
1412@pxref{Top, , D-Bus, dbus}. 1412@pxref{Top, , D-Bus, dbus}.
1413 1413
1414@table @asis 1414@table @asis
1415@item @option{afp}
1416@cindex method @option{afp} 1415@cindex method @option{afp}
1417@cindex @option{afp} method 1416@cindex @option{afp} method
1417@item @option{afp}
1418 1418
1419This method is for connecting to remote hosts with the Apple Filing 1419This method is for connecting to remote hosts with the Apple Filing
1420Protocol for accessing files on macOS volumes. @value{tramp} access 1420Protocol for accessing files on macOS volumes. @value{tramp} access
1421syntax requires a leading volume (share) name, for example: 1421syntax requires a leading volume (share) name, for example:
1422@file{@trampfn{afp,user@@host,/volume}}. 1422@file{@trampfn{afp,user@@host,/volume}}.
1423 1423
1424@item @option{dav}
1425@item @option{davs}
1426@cindex WebDAV 1424@cindex WebDAV
1427@cindex method @option{dav} 1425@cindex method @option{dav}
1428@cindex method @option{davs}
1429@cindex @option{dav} method 1426@cindex @option{dav} method
1427@item @option{dav}
1428@cindex method @option{davs}
1430@cindex @option{davs} method 1429@cindex @option{davs} method
1430@item @option{davs}
1431 1431
1432@option{dav} method provides access to WebDAV files and directories 1432@option{dav} method provides access to WebDAV files and directories
1433based on standard protocols, such as HTTP@. @option{davs} does the same 1433based on standard protocols, such as HTTP@. @option{davs} does the same
@@ -1438,11 +1438,11 @@ as it is common for OwnCloud or NextCloud file names, are not
1438supported by these methods. See method @option{nextcloud} for 1438supported by these methods. See method @option{nextcloud} for
1439handling them. 1439handling them.
1440 1440
1441@item @option{gdrive}
1442@cindex @acronym{GNOME} Online Accounts 1441@cindex @acronym{GNOME} Online Accounts
1443@cindex method @option{gdrive} 1442@cindex method @option{gdrive}
1444@cindex @option{gdrive} method 1443@cindex @option{gdrive} method
1445@cindex google drive 1444@cindex google drive
1445@item @option{gdrive}
1446 1446
1447Via the @option{gdrive} method it is possible to access your Google 1447Via the @option{gdrive} method it is possible to access your Google
1448Drive online storage. User and host name of the remote file name are 1448Drive online storage. User and host name of the remote file name are
@@ -1456,10 +1456,10 @@ could produce unexpected behavior in case two files in the same
1456directory have the same @code{display-name}, such a situation must be 1456directory have the same @code{display-name}, such a situation must be
1457avoided. 1457avoided.
1458 1458
1459@item @option{mtp}
1460@cindex method @option{mtp} 1459@cindex method @option{mtp}
1461@cindex @option{mtp} method 1460@cindex @option{mtp} method
1462@cindex media 1461@cindex media
1462@item @option{mtp}
1463 1463
1464Media devices, like cell phones, tablets, cameras, can be accessed via 1464Media devices, like cell phones, tablets, cameras, can be accessed via
1465the @option{mtp} method. Just the device name is needed in order to 1465the @option{mtp} method. Just the device name is needed in order to
@@ -1475,10 +1475,10 @@ different parts of their file system.
1475name when a single media device is connected. @value{tramp} instead 1475name when a single media device is connected. @value{tramp} instead
1476uses @file{@trampfn{mtp,,}} as the default name. 1476uses @file{@trampfn{mtp,,}} as the default name.
1477 1477
1478@item @option{nextcloud}
1479@cindex method @option{nextcloud} 1478@cindex method @option{nextcloud}
1480@cindex @option{nextcloud} method 1479@cindex @option{nextcloud} method
1481@cindex nextcloud 1480@cindex nextcloud
1481@item @option{nextcloud}
1482 1482
1483As the name indicates, the method @option{nextcloud} allows you to 1483As the name indicates, the method @option{nextcloud} allows you to
1484access OwnCloud or NextCloud hosted files and directories. Like the 1484access OwnCloud or NextCloud hosted files and directories. Like the
@@ -1486,9 +1486,9 @@ access OwnCloud or NextCloud hosted files and directories. Like the
1486@command{Online Accounts} application outside Emacs. The method 1486@command{Online Accounts} application outside Emacs. The method
1487supports port numbers. 1487supports port numbers.
1488 1488
1489@item @option{sftp}
1490@cindex method @option{sftp} 1489@cindex method @option{sftp}
1491@cindex @option{sftp} method 1490@cindex @option{sftp} method
1491@item @option{sftp}
1492 1492
1493This method uses @command{sftp} in order to securely access remote 1493This method uses @command{sftp} in order to securely access remote
1494hosts. @command{sftp} is a more secure option for connecting to hosts 1494hosts. @command{sftp} is a more secure option for connecting to hosts
@@ -1537,9 +1537,9 @@ operation on them. For some of the file name operations this is not
1537possible, @value{tramp} emulates those operations otherwise. 1537possible, @value{tramp} emulates those operations otherwise.
1538 1538
1539@table @asis 1539@table @asis
1540@item @option{rclone}
1541@cindex method @option{rclone} 1540@cindex method @option{rclone}
1542@cindex @option{rclone} method 1541@cindex @option{rclone} method
1542@item @option{rclone}
1543 1543
1544@vindex tramp-rclone-program 1544@vindex tramp-rclone-program
1545The program @command{rclone} enables accessing different system 1545The program @command{rclone} enables accessing different system
@@ -1550,7 +1550,7 @@ absolute path via the user option @code{tramp-rclone-program}.
1550 1550
1551A system storage must be configured via the @command{rclone config} 1551A system storage must be configured via the @command{rclone config}
1552command, outside Emacs. If you have configured a storage in 1552command, outside Emacs. If you have configured a storage in
1553@command{rclone} under a name @samp{storage} (for example), you could 1553@command{rclone} under a name @samp{storage} (for example), you can
1554access it via the remote file name 1554access it via the remote file name
1555 1555
1556@example 1556@example
@@ -1566,9 +1566,9 @@ for accessing the system storage, you should use it.
1566@ref{GVFS-based methods} for example, methods @option{gdrive} and 1566@ref{GVFS-based methods} for example, methods @option{gdrive} and
1567@option{nextcloud}. 1567@option{nextcloud}.
1568 1568
1569@item @option{sshfs}
1570@cindex method @option{sshfs} 1569@cindex method @option{sshfs}
1571@cindex @option{sshfs} method 1570@cindex @option{sshfs} method
1571@item @option{sshfs}
1572 1572
1573@vindex tramp-sshfs-program 1573@vindex tramp-sshfs-program
1574On local hosts which have installed the @command{sshfs} client for 1574On local hosts which have installed the @command{sshfs} client for
@@ -1591,7 +1591,7 @@ User name and port number are optional. This method does not support
1591password handling, the file system must either be mounted already, or 1591password handling, the file system must either be mounted already, or
1592the connection must be established passwordless via ssh keys. 1592the connection must be established passwordless via ssh keys.
1593 1593
1594The mount point and mount arguments could be passed as connection 1594The mount point and mount arguments can be passed as connection
1595properties, @xref{Setup of sshfs method}. 1595properties, @xref{Setup of sshfs method}.
1596 1596
1597@end table 1597@end table
@@ -1920,7 +1920,7 @@ support this command.
1920@subsection Tunneling with ssh 1920@subsection Tunneling with ssh
1921 1921
1922@vindex ProxyCommand@r{, ssh option} 1922@vindex ProxyCommand@r{, ssh option}
1923With @command{ssh}, you could use the @option{ProxyCommand} entry in 1923With @command{ssh}, you can use the @option{ProxyCommand} entry in
1924@file{~/.ssh/config}: 1924@file{~/.ssh/config}:
1925 1925
1926@example 1926@example
@@ -1981,42 +1981,42 @@ Integration for Incus containers. A container is accessed via
1981@samp{container} have the same meaning as with the @option{docker} 1981@samp{container} have the same meaning as with the @option{docker}
1982method. 1982method.
1983 1983
1984@item lxc-tramp
1985@cindex method @option{lxc} 1984@cindex method @option{lxc}
1986@cindex @option{lxc} method 1985@cindex @option{lxc} method
1986@item lxc-tramp
1987Integration for LXC containers. A container is accessed via 1987Integration for LXC containers. A container is accessed via
1988@file{@trampfn{lxc,container,/path/to/file}}, @samp{container} has the 1988@file{@trampfn{lxc,container,/path/to/file}}, @samp{container} has the
1989same meaning as with the @option{docker} method. A @samp{user} 1989same meaning as with the @option{docker} method. A @samp{user}
1990specification is ignored. 1990specification is ignored.
1991 1991
1992@item lxd-tramp
1993@cindex method @option{lxd} 1992@cindex method @option{lxd}
1994@cindex @option{lxd} method 1993@cindex @option{lxd} method
1994@item lxd-tramp
1995Integration for LXD containers. A container is accessed via 1995Integration for LXD containers. A container is accessed via
1996@file{@trampfn{lxd,user@@container,/path/to/file}}, @samp{user} and 1996@file{@trampfn{lxd,user@@container,/path/to/file}}, @samp{user} and
1997@samp{container} have the same meaning as with the @option{docker} 1997@samp{container} have the same meaning as with the @option{docker}
1998method. 1998method.
1999 1999
2000@item magit-tramp
2001@cindex method @option{git} 2000@cindex method @option{git}
2002@cindex @option{git} method 2001@cindex @option{git} method
2002@item magit-tramp
2003Browsing Git repositories with @code{magit}. A versioned file is 2003Browsing Git repositories with @code{magit}. A versioned file is
2004accessed via @file{@trampfn{git,rev@@root-dir,/path/to/file}}. 2004accessed via @file{@trampfn{git,rev@@root-dir,/path/to/file}}.
2005@samp{rev} is a Git revision, and @samp{root-dir} is a virtual host 2005@samp{rev} is a Git revision, and @samp{root-dir} is a virtual host
2006name for the root directory, specified in 2006name for the root directory, specified in
2007@code{magit-tramp-hosts-alist}. 2007@code{magit-tramp-hosts-alist}.
2008 2008
2009@item tramp-hdfs
2010@cindex method @option{hdfs} 2009@cindex method @option{hdfs}
2011@cindex @option{hdfs} method 2010@cindex @option{hdfs} method
2011@item tramp-hdfs
2012Access of a hadoop/hdfs file system. A file is accessed via 2012Access of a hadoop/hdfs file system. A file is accessed via
2013@file{@trampfn{hdfs,user@@node,/path/to/file}}, where @samp{user} is 2013@file{@trampfn{hdfs,user@@node,/path/to/file}}, where @samp{user} is
2014the user that you want to use, and @samp{node} is the name of the 2014the user that you want to use, and @samp{node} is the name of the
2015hadoop server. 2015hadoop server.
2016 2016
2017@item vagrant-tramp
2018@cindex method @option{vagrant} 2017@cindex method @option{vagrant}
2019@cindex @option{vagrant} method 2018@cindex @option{vagrant} method
2019@item vagrant-tramp
2020Convenience method to access vagrant boxes. It is often used in 2020Convenience method to access vagrant boxes. It is often used in
2021multi-hop file names like 2021multi-hop file names like
2022@file{@trampfn{vagrant@value{postfixhop}box|sudo,box,/path/to/file}}, 2022@file{@trampfn{vagrant@value{postfixhop}box|sudo,box,/path/to/file}},
@@ -2327,7 +2327,7 @@ The parameters @code{tramp-remote-shell} and
2327@code{tramp-remote-shell-login} in @code{tramp-methods} now have new 2327@code{tramp-remote-shell-login} in @code{tramp-methods} now have new
2328values for the remote host. 2328values for the remote host.
2329 2329
2330@var{property} could also be any property found in 2330@var{property} can also be any property found in
2331@code{tramp-persistency-file-name}. 2331@code{tramp-persistency-file-name}.
2332 2332
2333 2333
@@ -2477,7 +2477,7 @@ variables, @xref{Connection Variables, , , emacs}.
2477@ifnotinfo 2477@ifnotinfo
2478variables. 2478variables.
2479@end ifnotinfo 2479@end ifnotinfo
2480You could define your own search directories like this: 2480You can define your own search directories like this:
2481 2481
2482@lisp 2482@lisp
2483@group 2483@group
@@ -2601,10 +2601,10 @@ which may not be the same as the local login shell prompt,
2601@value{tramp} sets a similar default value for both prompts. 2601@value{tramp} sets a similar default value for both prompts.
2602 2602
2603@vindex tramp-password-prompt-regexp 2603@vindex tramp-password-prompt-regexp
2604@vindex tramp-otp-password-prompt-regexp
2605@vindex tramp-wrong-passwd-regexp
2606@item @code{tramp-password-prompt-regexp} 2604@item @code{tramp-password-prompt-regexp}
2605@vindex tramp-otp-password-prompt-regexp
2607@item @code{tramp-otp-password-prompt-regexp} 2606@item @code{tramp-otp-password-prompt-regexp}
2607@vindex tramp-wrong-passwd-regexp
2608@item @code{tramp-wrong-passwd-regexp} 2608@item @code{tramp-wrong-passwd-regexp}
2609 2609
2610@value{tramp} uses @code{tramp-password-prompt-regexp} to 2610@value{tramp} uses @code{tramp-password-prompt-regexp} to
@@ -2651,10 +2651,10 @@ prompts, for which @value{tramp} uses @code{tramp-wrong-passwd-regexp}.
2651 2651
2652@value{tramp} uses the user option @code{tramp-terminal-type} to set 2652@value{tramp} uses the user option @code{tramp-terminal-type} to set
2653the remote environment variable @env{TERM} for the shells it runs. 2653the remote environment variable @env{TERM} for the shells it runs.
2654By default, it is @t{"dumb"}, but this could be changed. A dumb 2654By default, it is @t{"dumb"}, but this can be changed. A dumb
2655terminal is best suited to run the background sessions of 2655terminal is best suited to run the background sessions of
2656@value{tramp}. However, running interactive remote shells might 2656@value{tramp}. However, running interactive remote shells might
2657require a different setting. This could be achieved by tweaking the 2657require a different setting. This can be achieved by tweaking the
2658@env{TERM} environment variable in @code{process-environment}. 2658@env{TERM} environment variable in @code{process-environment}.
2659 2659
2660@lisp 2660@lisp
@@ -2690,7 +2690,7 @@ process, @xref{Interactive Shell, , , emacs}.
2690@ifnotinfo 2690@ifnotinfo
2691process. 2691process.
2692@end ifnotinfo 2692@end ifnotinfo
2693@value{tramp} adds its own package version to this string, which could 2693@value{tramp} adds its own package version to this string, which can
2694be used for further tests in an inferior shell. The string of that 2694be used for further tests in an inferior shell. The string of that
2695environment variable looks always like 2695environment variable looks always like
2696 2696
@@ -2701,9 +2701,9 @@ echo $INSIDE_EMACS
2701@end group 2701@end group
2702@end example 2702@end example
2703 2703
2704@item @command{tset} and other questions
2705@cindex unix command @command{tset} 2704@cindex unix command @command{tset}
2706@cindex @command{tset} unix command 2705@cindex @command{tset} unix command
2706@item @command{tset} and other questions
2707 2707
2708To suppress inappropriate prompts for terminal type, @value{tramp} 2708To suppress inappropriate prompts for terminal type, @value{tramp}
2709sets the @env{TERM} environment variable before the remote login 2709sets the @env{TERM} environment variable before the remote login
@@ -2817,9 +2817,9 @@ fi
2817@xref{Interactive Shell, , , emacs}. 2817@xref{Interactive Shell, , , emacs}.
2818@end ifinfo 2818@end ifinfo
2819 2819
2820@item @command{busybox} / @command{nc}
2821@cindex unix command @command{nc} 2820@cindex unix command @command{nc}
2822@cindex @command{nc} unix command 2821@cindex @command{nc} unix command
2822@item @command{busybox} / @command{nc}
2823 2823
2824@value{tramp}'s @option{nc} method uses the @command{nc} command to 2824@value{tramp}'s @option{nc} method uses the @command{nc} command to
2825install and execute a listener as follows (see @code{tramp-methods}): 2825install and execute a listener as follows (see @code{tramp-methods}):
@@ -2910,7 +2910,8 @@ Host *
2910 2910
2911The corresponding PuTTY configuration is in the @option{Connection} 2911The corresponding PuTTY configuration is in the @option{Connection}
2912entry, @option{Seconds between keepalives} option. Set this to 5. 2912entry, @option{Seconds between keepalives} option. Set this to 5.
2913There is no counter which could be set. 2913PuTTY does not have a configuration option equivalent to OpenSSH's
2914@option{ServerAliveCountMax}.
2914 2915
2915 2916
2916@anchor{Using ssh connection sharing} 2917@anchor{Using ssh connection sharing}
@@ -3674,8 +3675,8 @@ This command changes the syntax @value{tramp} uses for remote file
3674names. Beside the @code{default} value, @var{syntax} can be 3675names. Beside the @code{default} value, @var{syntax} can be
3675 3676
3676@itemize 3677@itemize
3677@item @code{simplified}
3678@cindex simplified syntax 3678@cindex simplified syntax
3679@item @code{simplified}
3679 3680
3680This remote file name syntax is similar to the syntax used by Ange FTP@. 3681This remote file name syntax is similar to the syntax used by Ange FTP@.
3681A remote file name has the form 3682A remote file name has the form
@@ -3683,8 +3684,8 @@ A remote file name has the form
3683@samp{user@@} part is optional, and the method is determined by 3684@samp{user@@} part is optional, and the method is determined by
3684@ref{Default Method}. 3685@ref{Default Method}.
3685 3686
3686@item @code{separate}
3687@cindex separate syntax 3687@cindex separate syntax
3688@item @code{separate}
3688 3689
3689@clear unified 3690@clear unified
3690@set separate 3691@set separate
@@ -3995,7 +3996,7 @@ directory has been used already.
3995 3996
3996The methods @option{adb}, @option{rclone} and @option{sshfs} do not 3997The methods @option{adb}, @option{rclone} and @option{sshfs} do not
3997support home directory expansion at all. However, @value{tramp} keeps 3998support home directory expansion at all. However, @value{tramp} keeps
3998the home directory in the cache. Therefore, those methods could be 3999the home directory in the cache. Therefore, those methods can be
3999configured to expand a home directory via a connection property, 4000configured to expand a home directory via a connection property,
4000@xref{Predefined connection information}. Example: 4001@xref{Predefined connection information}. Example:
4001 4002
@@ -4195,18 +4196,18 @@ Due to the remote shell saving tilde expansions triggered by
4195@code{tramp-histfile-override}. When set to @code{t}, environment 4196@code{tramp-histfile-override}. When set to @code{t}, environment
4196variable @env{HISTFILE} is unset, and environment variables 4197variable @env{HISTFILE} is unset, and environment variables
4197@env{HISTFILESIZE} and @env{HISTSIZE} are set to 0. Don't use this 4198@env{HISTFILESIZE} and @env{HISTSIZE} are set to 0. Don't use this
4198with @command{bash} 5.0.0. There is a bug in @command{bash} which 4199with @command{bash} 5.0.0@: that version has a bug which
4199lets @command{bash} die. 4200causes @command{bash} to die.
4200 4201
4201Alternatively, @code{tramp-histfile-override} could be a string. 4202Alternatively, @code{tramp-histfile-override} can be a string.
4202Environment variable @env{HISTFILE} is set to this file name then. Be 4203The environment variable @env{HISTFILE} is then set to this file name. Be
4203careful when setting to @file{/dev/null}; this might result in 4204careful if using @file{/dev/null}; this might result in undesired
4204undesired results when using @command{bash} as remote shell. 4205results when using @command{bash} as remote shell.
4205 4206
4206Another approach is to disable @value{tramp}'s handling of the 4207Another approach is to completely disable @value{tramp}'s handling of
4207@env{HISTFILE} at all by setting @code{tramp-histfile-override} to 4208the @env{HISTFILE} by setting @code{tramp-histfile-override} to
4208@code{nil}. In this case, saving history could be turned off by 4209@code{nil}. In this case, saving history can be turned off by putting
4209putting this shell code in @file{.bashrc} or @file{.kshrc}: 4210this shell code in @file{.bashrc} or @file{.kshrc}:
4210 4211
4211@example 4212@example
4212@group 4213@group
@@ -4243,7 +4244,7 @@ ensures the correct name of the remote shell program.
4243When @code{explicit-shell-file-name} is equal to @code{nil}, calling 4244When @code{explicit-shell-file-name} is equal to @code{nil}, calling
4244@code{shell} interactively will prompt for a shell name. 4245@code{shell} interactively will prompt for a shell name.
4245 4246
4246You could use connection-local variables for setting different values 4247You can use connection-local variables for setting different values
4247of @code{explicit-shell-file-name} for different remote hosts. 4248of @code{explicit-shell-file-name} for different remote hosts.
4248@ifinfo 4249@ifinfo
4249@xref{Connection Variables, , , emacs}. 4250@xref{Connection Variables, , , emacs}.
@@ -4533,11 +4534,11 @@ the @code{process-attributes} output plus the key @code{pid}, and
4533be 4534be
4534 4535
4535 4536
4536@multitable {@bullet{} @code{numberp}} {--- a string of @var{number} width, could contain spaces} 4537@multitable {@bullet{} @code{numberp}} {--- a string of @var{number} width, can contain spaces}
4537@item @bullet{} @code{numberp} @tab --- a number 4538@item @bullet{} @code{numberp} @tab --- a number
4538@item @bullet{} @code{stringp} @tab --- a string without spaces 4539@item @bullet{} @code{stringp} @tab --- a string without spaces
4539@item @bullet{} @var{number} 4540@item @bullet{} @var{number}
4540@tab --- a string of @var{number} width, could contain spaces 4541@tab --- a string of @var{number} width, can contain spaces
4541@item @bullet{} @code{nil} @tab --- a string until end of line 4542@item @bullet{} @code{nil} @tab --- a string until end of line
4542@end multitable 4543@end multitable
4543 4544
@@ -4781,7 +4782,7 @@ anymore.
4781 4782
4782@deffn Command tramp-rename-files source target 4783@deffn Command tramp-rename-files source target
4783Replace in all buffers the visiting file name from @var{source} to 4784Replace in all buffers the visiting file name from @var{source} to
4784@var{target}. @var{source} is a remote directory name, which could 4785@var{target}. @var{source} is a remote directory name, which can
4785contain also a localname part. @var{target} is the directory name 4786contain also a localname part. @var{target} is the directory name
4786@var{source} is replaced with. Often, @var{target} is a remote 4787@var{source} is replaced with. Often, @var{target} is a remote
4787directory name on another host, but it can also be a local directory 4788directory name on another host, but it can also be a local directory
@@ -4830,17 +4831,19 @@ The default target for renaming remote buffer file names. This is an
4830alist of cons cells @code{(source . target)}. The first matching item 4831alist of cons cells @code{(source . target)}. The first matching item
4831specifies the target to be applied for renaming buffer file names from 4832specifies the target to be applied for renaming buffer file names from
4832source via @code{tramp-rename-files}. @code{source} is a regular 4833source via @code{tramp-rename-files}. @code{source} is a regular
4833expressions, which matches a remote file name. @code{target} must be 4834expression, which is used to match a remote file name. @code{target}
4834a directory name, which could be remote (including remote directories 4835must be a directory name, which can be remote (including remote
4835@value{tramp} infers by default, such as @file{@trampfn{method,user@@host,}}). 4836directories which @value{tramp} infers by default, such as
4837@file{@trampfn{method,user@@host,}}).
4836 4838
4837@code{target} can contain the patterns @code{%m}, @code{%u} or 4839@code{target} can contain the format specifiers @code{%m}, @code{%u},
4838@code{%h}, which are replaced by the method name, user name or host 4840or @code{%h}, which are replaced by the method name, user name, or host
4839name of @code{source} when calling @code{tramp-rename-files}. 4841name of @code{source} respectively when calling @code{tramp-rename-files}.
4840 4842
4841@code{source} could also be a Lisp form, which will be evaluated. The 4843@code{source} can also be a Lisp form, which is evaluated. The result
4842result must be a string or @code{nil}, which is interpreted as a 4844must be a string (which is used as a regular expression to match) or
4843regular expression which always matches. 4845@code{nil}, which is interpreted as a regular expression which always
4846matches.
4844 4847
4845Example entries: 4848Example entries:
4846 4849
@@ -4920,90 +4923,87 @@ archive file names. Accepted suffixes are listed in the constant
4920@code{tramp-archive-suffixes}. They are 4923@code{tramp-archive-suffixes}. They are
4921 4924
4922@itemize 4925@itemize
4923@item @samp{.7z} ---
49247-Zip archives
4925@cindex @file{7z} file archive suffix 4926@cindex @file{7z} file archive suffix
4926@cindex file archive suffix @file{7z} 4927@cindex file archive suffix @file{7z}
4928@item @samp{.7z} ---
49297-Zip archives
4927 4930
4928@item @samp{.apk} ---
4929Android package kits
4930@cindex @file{apk} file archive suffix 4931@cindex @file{apk} file archive suffix
4931@cindex file archive suffix @file{apk} 4932@cindex file archive suffix @file{apk}
4933@item @samp{.apk} ---
4934Android package kits
4932 4935
4933@item @samp{.ar} ---
4934UNIX archiver formats
4935@cindex @file{ar} file archive suffix 4936@cindex @file{ar} file archive suffix
4936@cindex file archive suffix @file{ar} 4937@cindex file archive suffix @file{ar}
4938@item @samp{.ar} ---
4939UNIX archiver formats
4937 4940
4938@item @samp{.cab}, @samp{.CAB} ---
4939Microsoft Windows cabinets
4940@cindex @file{cab} file archive suffix 4941@cindex @file{cab} file archive suffix
4941@cindex @file{CAB} file archive suffix 4942@cindex @file{CAB} file archive suffix
4942@cindex file archive suffix @file{cab} 4943@cindex file archive suffix @file{cab}
4943@cindex file archive suffix @file{CAB} 4944@cindex file archive suffix @file{CAB}
4945@item @samp{.cab}, @samp{.CAB} ---
4946Microsoft Windows cabinets
4944 4947
4945@item @samp{.cpio} ---
4946CPIO archives
4947@cindex @file{cpio} file archive suffix 4948@cindex @file{cpio} file archive suffix
4948@cindex file archive suffix @file{cpio} 4949@cindex file archive suffix @file{cpio}
4950@item @samp{.cpio} ---
4951CPIO archives
4949 4952
4950@item @samp{.crate} ---
4951Cargo (Rust) packages
4952@cindex @file{crate} file archive suffix 4953@cindex @file{crate} file archive suffix
4953@cindex file archive suffix @file{crate} 4954@cindex file archive suffix @file{crate}
4955@item @samp{.crate} ---
4956Cargo (Rust) packages
4954 4957
4955@item @samp{.deb} ---
4956Debian packages
4957@cindex @file{deb} file archive suffix 4958@cindex @file{deb} file archive suffix
4958@cindex file archive suffix @file{deb} 4959@cindex file archive suffix @file{deb}
4960@item @samp{.deb} ---
4961Debian packages
4959 4962
4960@item @samp{.depot} ---
4961HP-UX SD depots
4962@cindex @file{depot} file archive suffix 4963@cindex @file{depot} file archive suffix
4963@cindex file archive suffix @file{depot} 4964@cindex file archive suffix @file{depot}
4965@item @samp{.depot} ---
4966HP-UX SD depots
4964 4967
4965@item @samp{.epub} ---
4966Electronic publications
4967@cindex @file{epub} file archive suffix 4968@cindex @file{epub} file archive suffix
4968@cindex file archive suffix @file{epub} 4969@cindex file archive suffix @file{epub}
4970@item @samp{.epub} ---
4971Electronic publications
4969 4972
4970@item @samp{.exe} ---
4971Self extracting Microsoft Windows EXE files
4972@cindex @file{exe} file archive suffix 4973@cindex @file{exe} file archive suffix
4973@cindex file archive suffix @file{exe} 4974@cindex file archive suffix @file{exe}
4975@item @samp{.exe} ---
4976Self extracting Microsoft Windows EXE files
4974 4977
4975@item @samp{.iso} ---
4976ISO 9660 images
4977@cindex @file{iso} file archive suffix 4978@cindex @file{iso} file archive suffix
4978@cindex file archive suffix @file{iso} 4979@cindex file archive suffix @file{iso}
4980@item @samp{.iso} ---
4981ISO 9660 images
4979 4982
4980@item @samp{.jar} ---
4981Java archives
4982@cindex @file{jar} file archive suffix 4983@cindex @file{jar} file archive suffix
4983@cindex file archive suffix @file{jar} 4984@cindex file archive suffix @file{jar}
4985@item @samp{.jar} ---
4986Java archives
4984 4987
4985@item @samp{.lzh}, @samp{.LZH} ---
4986Microsoft Windows compressed LHA archives
4987@cindex @file{lzh} file archive suffix 4988@cindex @file{lzh} file archive suffix
4988@cindex @file{LZH} file archive suffix 4989@cindex @file{LZH} file archive suffix
4989@cindex file archive suffix @file{lzh} 4990@cindex file archive suffix @file{lzh}
4990@cindex file archive suffix @file{LZH} 4991@cindex file archive suffix @file{LZH}
4992@item @samp{.lzh}, @samp{.LZH} ---
4993Microsoft Windows compressed LHA archives
4991 4994
4992@item @samp{.msu}, @samp{.MSU} ---
4993Microsoft Windows Update packages
4994@cindex @file{msu} file archive suffix 4995@cindex @file{msu} file archive suffix
4995@cindex @file{MSU} file archive suffix 4996@cindex @file{MSU} file archive suffix
4996@cindex file archive suffix @file{msu} 4997@cindex file archive suffix @file{msu}
4997@cindex file archive suffix @file{MSU} 4998@cindex file archive suffix @file{MSU}
4999@item @samp{.msu}, @samp{.MSU} ---
5000Microsoft Windows Update packages
4998 5001
4999@item @samp{.mtree} ---
5000BSD mtree format
5001@cindex @file{mtree} file archive suffix 5002@cindex @file{mtree} file archive suffix
5002@cindex file archive suffix @file{mtree} 5003@cindex file archive suffix @file{mtree}
5004@item @samp{.mtree} ---
5005BSD mtree format
5003 5006
5004@item @samp{.odb}, @samp{.odf}, @samp{.odg}, @samp{.odp}, @samp{.ods},
5005@samp{.odt} ---
5006OpenDocument formats
5007@cindex @file{odb} file archive suffix 5007@cindex @file{odb} file archive suffix
5008@cindex @file{odf} file archive suffix 5008@cindex @file{odf} file archive suffix
5009@cindex @file{odg} file archive suffix 5009@cindex @file{odg} file archive suffix
@@ -5016,30 +5016,30 @@ OpenDocument formats
5016@cindex file archive suffix @file{odp} 5016@cindex file archive suffix @file{odp}
5017@cindex file archive suffix @file{ods} 5017@cindex file archive suffix @file{ods}
5018@cindex file archive suffix @file{odt} 5018@cindex file archive suffix @file{odt}
5019@item @samp{.odb}, @samp{.odf}, @samp{.odg}, @samp{.odp}, @samp{.ods},
5020@samp{.odt} ---
5021OpenDocument formats
5019 5022
5020@item @samp{.pax} ---
5021Posix archives
5022@cindex @file{pax} file archive suffix 5023@cindex @file{pax} file archive suffix
5023@cindex file archive suffix @file{pax} 5024@cindex file archive suffix @file{pax}
5025@item @samp{.pax} ---
5026Posix archives
5024 5027
5025@item @samp{.rar} ---
5026RAR archives
5027@cindex @file{rar} file archive suffix 5028@cindex @file{rar} file archive suffix
5028@cindex file archive suffix @file{rar} 5029@cindex file archive suffix @file{rar}
5030@item @samp{.rar} ---
5031RAR archives
5029 5032
5030@item @samp{.rpm} ---
5031Red Hat packages
5032@cindex @file{rpm} file archive suffix 5033@cindex @file{rpm} file archive suffix
5033@cindex file archive suffix @file{rpm} 5034@cindex file archive suffix @file{rpm}
5035@item @samp{.rpm} ---
5036Red Hat packages
5034 5037
5035@item @samp{.shar} ---
5036Shell archives
5037@cindex @file{shar} file archive suffix 5038@cindex @file{shar} file archive suffix
5038@cindex file archive suffix @file{shar} 5039@cindex file archive suffix @file{shar}
5040@item @samp{.shar} ---
5041Shell archives
5039 5042
5040@item @samp{.tar}, @samp{.tbz}, @samp{.tgz}, @samp{.tlz}, @samp{.txz},
5041@samp{.tzst} ---
5042(Compressed) tape archives
5043@cindex @file{tar} file archive suffix 5043@cindex @file{tar} file archive suffix
5044@cindex @file{tbz} file archive suffix 5044@cindex @file{tbz} file archive suffix
5045@cindex @file{tgz} file archive suffix 5045@cindex @file{tgz} file archive suffix
@@ -5052,33 +5052,36 @@ Shell archives
5052@cindex file archive suffix @file{tlz} 5052@cindex file archive suffix @file{tlz}
5053@cindex file archive suffix @file{txz} 5053@cindex file archive suffix @file{txz}
5054@cindex file archive suffix @file{tzst} 5054@cindex file archive suffix @file{tzst}
5055@item @samp{.tar}, @samp{.tbz}, @samp{.tgz}, @samp{.tlz}, @samp{.txz},
5056@samp{.tzst} ---
5057(Compressed) tape archives
5055 5058
5056@item @samp{.warc} ---
5057Web archives
5058@cindex @file{warc} file archive suffix 5059@cindex @file{warc} file archive suffix
5059@cindex file archive suffix @file{warc} 5060@cindex file archive suffix @file{warc}
5061@item @samp{.warc} ---
5062Web archives
5060 5063
5061@item @samp{.xar} ---
5062macOS XAR archives
5063@cindex @file{xar} file archive suffix 5064@cindex @file{xar} file archive suffix
5064@cindex file archive suffix @file{xar} 5065@cindex file archive suffix @file{xar}
5066@item @samp{.xar} ---
5067macOS XAR archives
5065 5068
5066@item @samp{.xpi} ---
5067XPInstall Mozilla addons
5068@cindex @file{xpi} file archive suffix 5069@cindex @file{xpi} file archive suffix
5069@cindex file archive suffix @file{xpi} 5070@cindex file archive suffix @file{xpi}
5071@item @samp{.xpi} ---
5072XPInstall Mozilla addons
5070 5073
5071@item @samp{.xps} ---
5072Open XML Paper Specification (OpenXPS) documents
5073@cindex @file{xps} file archive suffix 5074@cindex @file{xps} file archive suffix
5074@cindex file archive suffix @file{xps} 5075@cindex file archive suffix @file{xps}
5076@item @samp{.xps} ---
5077Open XML Paper Specification (OpenXPS) documents
5075 5078
5076@item @samp{.zip}, @samp{.ZIP} ---
5077ZIP archives
5078@cindex @file{zip} file archive suffix 5079@cindex @file{zip} file archive suffix
5079@cindex @file{ZIP} file archive suffix 5080@cindex @file{ZIP} file archive suffix
5080@cindex file archive suffix @file{zip} 5081@cindex file archive suffix @file{zip}
5081@cindex file archive suffix @file{ZIP} 5082@cindex file archive suffix @file{ZIP}
5083@item @samp{.zip}, @samp{.ZIP} ---
5084ZIP archives
5082@end itemize 5085@end itemize
5083 5086
5084@vindex tramp-archive-compression-suffixes 5087@vindex tramp-archive-compression-suffixes
@@ -5092,7 +5095,7 @@ constant @code{tramp-archive-compression-suffixes}. They are
5092row are possible, like @file{/path/to/dir/file.tar.gz.uu/dir/file}. 5095row are possible, like @file{/path/to/dir/file.tar.gz.uu/dir/file}.
5093 5096
5094@vindex tramp-archive-all-gvfs-methods 5097@vindex tramp-archive-all-gvfs-methods
5095An archive file name could be a remote file name, as in 5098An archive file name can be a remote file name, as in
5096@file{/ftp:anonymous@@ftp.gnu.org:/gnu/tramp/tramp-2.4.5.tar.gz/INSTALL}. 5099@file{/ftp:anonymous@@ftp.gnu.org:/gnu/tramp/tramp-2.4.5.tar.gz/INSTALL}.
5097Since all file operations are mapped internally to @acronym{GVFS} 5100Since all file operations are mapped internally to @acronym{GVFS}
5098operations, remote file names supported by @code{tramp-gvfs} perform 5101operations, remote file names supported by @code{tramp-gvfs} perform
@@ -5102,7 +5105,7 @@ than the similar @samp{/scp:user@@host:@dots{}}. See the constant
5102@code{tramp-archive-all-gvfs-methods} for a complete list of 5105@code{tramp-archive-all-gvfs-methods} for a complete list of
5103@code{tramp-gvfs} supported method names. 5106@code{tramp-gvfs} supported method names.
5104 5107
5105If @code{url-handler-mode} is enabled, archives could be visited via 5108If @code{url-handler-mode} is enabled, archives can be visited via
5106URLs, like 5109URLs, like
5107@file{https://ftp.gnu.org/gnu/tramp/tramp-2.4.5.tar.gz/INSTALL}. This 5110@file{https://ftp.gnu.org/gnu/tramp/tramp-2.4.5.tar.gz/INSTALL}. This
5108allows complex file operations like 5111allows complex file operations like
@@ -5130,7 +5133,7 @@ coreutils_8.28-1_amd64.deb/control.tar.gz/control"))
5130@end lisp 5133@end lisp
5131 5134
5132@vindex tramp-archive-enabled 5135@vindex tramp-archive-enabled
5133In order to disable file archives, you could add the following form to 5136In order to disable file archives, you can add the following form to
5134your init file: 5137your init file:
5135 5138
5136@lisp 5139@lisp
@@ -5206,21 +5209,21 @@ When including @value{tramp}'s messages in the bug report, increase
5206the verbosity level to 6 (@pxref{Traces and Profiles, Traces}) in the 5209the verbosity level to 6 (@pxref{Traces and Profiles, Traces}) in the
5207@file{~/.emacs} file before repeating steps to the bug. Include the 5210@file{~/.emacs} file before repeating steps to the bug. Include the
5208contents of the @file{*tramp/foo*} and @file{*debug tramp/foo*} 5211contents of the @file{*tramp/foo*} and @file{*debug tramp/foo*}
5209buffers with the bug report. Both buffers could contain 5212buffers with the bug report. Since those buffers could contain
5210non-@acronym{ASCII} characters which are relevant for analysis, append 5213non-@acronym{ASCII} characters which are relevant for analysis, append
5211the buffers as attachments to the bug report. This is also needed in 5214the buffers as attachments to the bug report rather than placing them
5212order to avoid line breaks during mail transfer. 5215inline. This is also needed in order to avoid line breaks getting added
5216or deleted during mail transfer.
5213 5217
5214If you send the message from Emacs, you are asked about to append 5218If you send the message from Emacs, you are asked whether to append
5215these buffers to the bug report. If you use an external mail program, 5219these buffers to the bug report. If you use an external mail program,
5216you must save these buffers to files, and append them with that mail 5220you must save these buffers to files, and append them with that mail
5217program. 5221program.
5218 5222
5219@strong{Note} that a verbosity level greater than 6 is not necessary 5223@strong{Note} that a verbosity level greater than 6 is not necessary at
5220at this stage. Also note that a verbosity level of 6 or greater, the 5224this stage. Also note that with a verbosity level of 6 or greater, the
5221contents of files and directories will be included in the debug 5225contents of files and directories will be included in the debug buffer.
5222buffer. Passwords typed in @value{tramp} will never be included 5226Passwords typed in @value{tramp} will never be included there.
5223there.
5224 5227
5225If you find, that using @value{tramp} with @command{emacs -Q} doesn't 5228If you find, that using @value{tramp} with @command{emacs -Q} doesn't
5226cause any problem, you might check your init file for the suspicious 5229cause any problem, you might check your init file for the suspicious
@@ -5439,7 +5442,7 @@ as value of the @env{TERM} environment variable. If you want to use
5439another value for @env{TERM}, change @code{tramp-terminal-type} and 5442another value for @env{TERM}, change @code{tramp-terminal-type} and
5440this line accordingly. 5443this line accordingly.
5441 5444
5442Alternatively, you could set the remote login shell explicitly. See 5445Alternatively, you can set the remote login shell explicitly. See
5443@ref{Remote shell setup} for discussion of this technique, 5446@ref{Remote shell setup} for discussion of this technique,
5444 5447
5445When using fish shell on remote hosts, disable fancy formatting by 5448When using fish shell on remote hosts, disable fancy formatting by
@@ -5747,7 +5750,7 @@ encrypted}), which are deleted anyway.
5747@c Since Emacs 30. 5750@c Since Emacs 30.
5748@vindex trash-directory 5751@vindex trash-directory
5749If you want to trash a remote file into a remote trash directory, you 5752If you want to trash a remote file into a remote trash directory, you
5750could configure the user option @code{trash-directory} to a 5753can configure the user option @code{trash-directory} to a
5751connection-local value. 5754connection-local value.
5752@ifinfo 5755@ifinfo
5753@xref{Connection Variables, , , emacs}. 5756@xref{Connection Variables, , , emacs}.
@@ -5786,7 +5789,7 @@ is @file{@trampfn{ssh,news@@news.my.domain,/opt/news/etc}}, then:
5786Use simplified syntax: 5789Use simplified syntax:
5787 5790
5788If you always apply the default method (@pxref{Default Method}), you 5791If you always apply the default method (@pxref{Default Method}), you
5789could use the simplified @value{tramp} syntax (@pxref{Change file name 5792can use the simplified @value{tramp} syntax (@pxref{Change file name
5790syntax}): 5793syntax}):
5791 5794
5792@lisp 5795@lisp
@@ -6098,7 +6101,7 @@ the buffer is remote. See the optional arguments of
6098How to save files when a remote host isn't reachable anymore? 6101How to save files when a remote host isn't reachable anymore?
6099 6102
6100If the local machine Emacs is running on changes its network 6103If the local machine Emacs is running on changes its network
6101integration, remote hosts could become unreachable. This happens for 6104integration, remote hosts could become unreachable. This happens, for
6102example, if the local machine is moved between your office and your 6105example, if the local machine is moved between your office and your
6103home without restarting Emacs. 6106home without restarting Emacs.
6104 6107
@@ -6118,9 +6121,9 @@ an unresponsive remote host could trigger @code{recentf} to connect
6118that host again and again. 6121that host again and again.
6119 6122
6120If you find the cleanup disturbing, because the file names in 6123If you find the cleanup disturbing, because the file names in
6121@code{recentf-list} are precious to you, you could add the following 6124@code{recentf-list} are precious to you, you can add the following
6122two forms in your @file{~/.emacs} after loading the @code{tramp} and 6125two forms in your @file{~/.emacs} (after loading the @code{tramp} and
6123@code{recentf} packages: 6126@code{recentf} packages):
6124 6127
6125@vindex tramp-cleanup-connection-hook 6128@vindex tramp-cleanup-connection-hook
6126@vindex tramp-cleanup-all-connections-hook 6129@vindex tramp-cleanup-all-connections-hook