From 21008b4cd511b0052b597ff64a605e0508863d45 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B8rn=20Smith?= <bjornsmith@gmail.com>
Date: Fri, 1 Sep 2023 11:57:42 +0200
Subject: [PATCH] docs: sftp: add note regarding format of server_command
Elaborate exactly how server_command should be used in the configuration file
---
backend/sftp/sftp.go | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/backend/sftp/sftp.go b/backend/sftp/sftp.go
index 5b213bf55..d9c300bfb 100644
--- a/backend/sftp/sftp.go
+++ b/backend/sftp/sftp.go
@@ -232,7 +232,16 @@ E.g. the second example above should be rewritten as:
Default: "",
Help: `Specifies the path or command to run a sftp server on the remote host.
-The subsystem option is ignored when server_command is defined.`,
+The subsystem option is ignored when server_command is defined.
+
+If adding server_command to the configuration file please note that
+it should not be enclosed in quotes, since that will make rclone fail.
+
+A working example is:
+
+ [remote_name]
+ type = sftp
+ server_command = sudo /usr/libexec/openssh/sftp-server`,
Advanced: true,
}, {
Name: "use_fstat",