Version v1.59.0

docs/content/sftp.md

@@ -388,7 +388,7 @@ with a Windows OpenSSH server, rclone will use a built-in shell command
 {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/sftp/sftp.go then run make backenddocs" >}}
 ### Standard options
 
-Here are the standard options specific to sftp (SSH/SFTP Connection).
+Here are the Standard options specific to sftp (SSH/SFTP).
 
 #### --sftp-host
 
@@ -514,7 +514,7 @@ Properties:
 
 #### --sftp-use-insecure-cipher
 
-Enable the use of insecure ciphers and key exchange methods. 
+Enable the use of insecure ciphers and key exchange methods.
 
 This enables the use of the following insecure ciphers and key exchange methods:
 
@@ -554,7 +554,7 @@ Properties:
 
 ### Advanced options
 
-Here are the advanced options specific to sftp (SSH/SFTP Connection).
+Here are the Advanced options specific to sftp (SSH/SFTP).
 
 #### --sftp-known-hosts-file
 
@@ -592,16 +592,16 @@ Properties:
 
 #### --sftp-path-override
 
-Override path used by SSH connection.
+Override path used by SSH shell commands.
 
 This allows checksum calculation when SFTP and SSH paths are
 different. This issue affects among others Synology NAS boxes.
 
-Shared folders can be found in directories representing volumes
+E.g. if shared folders can be found in directories representing volumes:
 
     rclone sync /home/local/directory remote:/directory --sftp-path-override /volume2/directory
 
-Home directory can be found in a shared folder called "home"
+E.g. if home directory can be found in a shared folder called "home":
 
     rclone sync /home/local/directory remote:/home/directory --sftp-path-override /volume1/homes/USER/directory
 
@@ -623,6 +623,28 @@ Properties:
 - Type:        bool
 - Default:     true
 
+#### --sftp-shell-type
+
+The type of SSH shell on remote server, if any.
+
+Leave blank for autodetect.
+
+Properties:
+
+- Config:      shell_type
+- Env Var:     RCLONE_SFTP_SHELL_TYPE
+- Type:        string
+- Required:    false
+- Examples:
+    - "none"
+        - No shell access
+    - "unix"
+        - Unix shell
+    - "powershell"
+        - PowerShell
+    - "cmd"
+        - Windows Command Prompt
+
 #### --sftp-md5sum-command
 
 The command used to read md5 hashes.
@@ -763,6 +785,75 @@ Properties:
 - Type:        Duration
 - Default:     1m0s
 
+#### --sftp-chunk-size
+
+Upload and download chunk size.
+
+This controls the maximum packet size used in the SFTP protocol. The
+RFC limits this to 32768 bytes (32k), however a lot of servers
+support larger sizes and setting it larger will increase transfer
+speed dramatically on high latency links.
+
+Only use a setting higher than 32k if you always connect to the same
+server or after sufficiently broad testing.
+
+For example using the value of 252k with OpenSSH works well with its
+maximum packet size of 256k.
+
+If you get the error "failed to send packet header: EOF" when copying
+a large file, try lowering this number.
+
+
+Properties:
+
+- Config:      chunk_size
+- Env Var:     RCLONE_SFTP_CHUNK_SIZE
+- Type:        SizeSuffix
+- Default:     32Ki
+
+#### --sftp-concurrency
+
+The maximum number of outstanding requests for one file
+
+This controls the maximum number of outstanding requests for one file.
+Increasing it will increase throughput on high latency links at the
+cost of using more memory.
+
+
+Properties:
+
+- Config:      concurrency
+- Env Var:     RCLONE_SFTP_CONCURRENCY
+- Type:        int
+- Default:     64
+
+#### --sftp-set-env
+
+Environment variables to pass to sftp and commands
+
+Set environment variables in the form:
+
+    VAR=value
+
+to be passed to the sftp client and to any commands run (eg md5sum).
+
+Pass multiple variables space separated, eg
+
+    VAR1=value VAR2=value
+
+and pass variables with spaces in in quotes, eg
+
+    "VAR3=value with space" "VAR4=value with space" VAR5=nospacehere
+
+
+
+Properties:
+
+- Config:      set_env
+- Env Var:     RCLONE_SFTP_SET_ENV
+- Type:        SpaceSepList
+- Default:     
+
 {{< rem autogenerated options stop >}}
 
 ## Limitations