summaryrefslogtreecommitdiffstats
path: root/lisp
diff options
context:
space:
mode:
authorMartin Polden <mpolden@mpolden.no>2024-02-22 11:25:43 +0100
committerMartin Polden <mpolden@mpolden.no>2024-02-22 11:25:43 +0100
commit11a72e9f32147f4d91ac4e8da12d513f66fcdc1a (patch)
tree2328a2a32a6758b959619d597b0b9a843ac165e4 /lisp
parenta41f5c5eb85d19cc369c163ad38516aa3cb95aab (diff)
tramp: update doc
Diffstat (limited to 'lisp')
-rw-r--r--lisp/init-tramp.el11
1 files changed, 7 insertions, 4 deletions
diff --git a/lisp/init-tramp.el b/lisp/init-tramp.el
index 8c9c579..ae279d0 100644
--- a/lisp/init-tramp.el
+++ b/lisp/init-tramp.el
@@ -5,10 +5,13 @@
(defun mpolden/sudo-file-name (filename)
"Add a sudo-like TRAMP method to FILENAME.
-If FILENAME already contains a sudo-like method, do nothing. If
-FILENAME is accessed over SSH, replace \"/ssh:\" with
-\"/sudo:\" or \"/doas:\". Otherwise, assume FILENAME is a local
-path and prefix it with \"/sudo::\" or \"/doas::\"."
+If FILENAME already contains a sudo-like method, return FILENAME
+unchanged. If FILENAME is accessed over SSH, replace \"/ssh:\"
+with \"/sudo:\". Otherwise, assume FILENAME is a local path and
+prefix it with \"/sudo::\".
+
+If doas is available on the remote host, the doas method is used
+instead of sudo."
;; sudo:remote-host works because of the special tramp-default-proxies-alist
;; configuration below
(let* ((splitname (split-string filename ":"))