Version v1.57.0

docs/content/sftp.md

@@ -252,25 +252,24 @@ are using one of these servers, you can set the option `set_modtime = false` in
 your RClone backend configuration to disable this behaviour.
 
 {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/sftp/sftp.go then run make backenddocs" >}}
-### Standard Options
+### Standard options
 
 Here are the standard options specific to sftp (SSH/SFTP Connection).
 
 #### --sftp-host
 
-SSH host to connect to
+SSH host to connect to.
+
+E.g. "example.com".
 
 - Config:      host
 - Env Var:     RCLONE_SFTP_HOST
 - Type:        string
 - Default:     ""
-- Examples:
-    - "example.com"
-        - Connect to example.com
 
 #### --sftp-user
 
-SSH username, leave blank for current username, $USER
+SSH username, leave blank for current username, $USER.
 
 - Config:      user
 - Env Var:     RCLONE_SFTP_USER
@@ -279,7 +278,7 @@ SSH username, leave blank for current username, $USER
 
 #### --sftp-port
 
-SSH port, leave blank to use default (22)
+SSH port, leave blank to use default (22).
 
 - Config:      port
 - Env Var:     RCLONE_SFTP_PORT
@@ -299,7 +298,9 @@ SSH password, leave blank to use ssh-agent.
 
 #### --sftp-key-pem
 
-Raw PEM-encoded private key, If specified, will override key_file parameter.
+Raw PEM-encoded private key.
+
+If specified, will override key_file parameter.
 
 - Config:      key_pem
 - Env Var:     RCLONE_SFTP_KEY_PEM
@@ -308,11 +309,12 @@ Raw PEM-encoded private key, If specified, will override key_file parameter.
 
 #### --sftp-key-file
 
-Path to PEM-encoded private key file, leave blank or set key-use-agent to use ssh-agent.
+Path to PEM-encoded private key file.
+
+Leave blank or set key-use-agent to use ssh-agent.
 
 Leading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`.
 
-
 - Config:      key_file
 - Env Var:     RCLONE_SFTP_KEY_FILE
 - Type:        string
@@ -340,7 +342,6 @@ Set this if you have a signed certificate you want to use for authentication.
 
 Leading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`.
 
-
 - Config:      pubkey_file
 - Env Var:     RCLONE_SFTP_PUBKEY_FILE
 - Type:        string
@@ -387,6 +388,7 @@ Those algorithms are insecure and may allow plaintext data to be recovered by an
 #### --sftp-disable-hashcheck
 
 Disable the execution of SSH commands to determine if remote file hashing is available.
+
 Leave blank or set to false to enable hashing (recommended), set to true to disable hashing.
 
 - Config:      disable_hashcheck
@@ -394,7 +396,7 @@ Leave blank or set to false to enable hashing (recommended), set to true to disa
 - Type:        bool
 - Default:     false
 
-### Advanced Options
+### Advanced options
 
 Here are the advanced options specific to sftp (SSH/SFTP Connection).
 
@@ -406,14 +408,13 @@ Set this value to enable server host key validation.
 
 Leading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`.
 
-
 - Config:      known_hosts_file
 - Env Var:     RCLONE_SFTP_KNOWN_HOSTS_FILE
 - Type:        string
 - Default:     ""
 - Examples:
     - "~/.ssh/known_hosts"
-        - Use OpenSSH's known_hosts file
+        - Use OpenSSH's known_hosts file.
 
 #### --sftp-ask-password
 
@@ -460,7 +461,9 @@ Set the modified time on the remote if set.
 
 #### --sftp-md5sum-command
 
-The command used to read md5 hashes. Leave blank for autodetect.
+The command used to read md5 hashes.
+
+Leave blank for autodetect.
 
 - Config:      md5sum_command
 - Env Var:     RCLONE_SFTP_MD5SUM_COMMAND
@@ -469,7 +472,9 @@ The command used to read md5 hashes. Leave blank for autodetect.
 
 #### --sftp-sha1sum-command
 
-The command used to read sha1 hashes. Leave blank for autodetect.
+The command used to read sha1 hashes.
+
+Leave blank for autodetect.
 
 - Config:      sha1sum_command
 - Env Var:     RCLONE_SFTP_SHA1SUM_COMMAND
@@ -507,7 +512,7 @@ The subsystem option is ignored when server_command is defined.
 
 #### --sftp-use-fstat
 
-If set use fstat instead of stat
+If set use fstat instead of stat.
 
 Some servers limit the amount of open files and calling Stat after opening
 the file will throw an error from the server. Setting this flag will call
@@ -525,7 +530,7 @@ any given time.
 
 #### --sftp-disable-concurrent-reads
 
-If set don't use concurrent reads
+If set don't use concurrent reads.
 
 Normally concurrent reads are safe to use and not using them will
 degrade performance, so this option is disabled by default.
@@ -548,7 +553,7 @@ If concurrent reads are disabled, the use_fstat option is ignored.
 
 #### --sftp-disable-concurrent-writes
 
-If set don't use concurrent writes
+If set don't use concurrent writes.
 
 Normally rclone uses concurrent writes to upload files. This improves
 the performance greatly, especially for distant servers.
@@ -563,7 +568,7 @@ This option disables concurrent writes should that be necessary.
 
 #### --sftp-idle-timeout
 
-Max time before closing idle connections
+Max time before closing idle connections.
 
 If no connections have been returned to the connection pool in the time
 given, rclone will empty the connection pool.