Version v1.58.0

docs/content/sftp.md

@@ -267,28 +267,34 @@ SSH host to connect to.
 
 E.g. "example.com".
 
+Properties:
+
 - Config:      host
 - Env Var:     RCLONE_SFTP_HOST
 - Type:        string
-- Default:     ""
+- Required:    true
 
 #### --sftp-user
 
-SSH username, leave blank for current username, $USER.
+SSH username.
+
+Properties:
 
 - Config:      user
 - Env Var:     RCLONE_SFTP_USER
 - Type:        string
-- Default:     ""
+- Default:     "$USER"
 
 #### --sftp-port
 
-SSH port, leave blank to use default (22).
+SSH port number.
+
+Properties:
 
 - Config:      port
 - Env Var:     RCLONE_SFTP_PORT
-- Type:        string
-- Default:     ""
+- Type:        int
+- Default:     22
 
 #### --sftp-pass
 
@@ -296,10 +302,12 @@ SSH password, leave blank to use ssh-agent.
 
 **NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
 
+Properties:
+
 - Config:      pass
 - Env Var:     RCLONE_SFTP_PASS
 - Type:        string
-- Default:     ""
+- Required:    false
 
 #### --sftp-key-pem
 
@@ -307,10 +315,12 @@ Raw PEM-encoded private key.
 
 If specified, will override key_file parameter.
 
+Properties:
+
 - Config:      key_pem
 - Env Var:     RCLONE_SFTP_KEY_PEM
 - Type:        string
-- Default:     ""
+- Required:    false
 
 #### --sftp-key-file
 
@@ -320,10 +330,12 @@ 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}`.
 
+Properties:
+
 - Config:      key_file
 - Env Var:     RCLONE_SFTP_KEY_FILE
 - Type:        string
-- Default:     ""
+- Required:    false
 
 #### --sftp-key-file-pass
 
@@ -334,10 +346,12 @@ in the new OpenSSH format can't be used.
 
 **NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
 
+Properties:
+
 - Config:      key_file_pass
 - Env Var:     RCLONE_SFTP_KEY_FILE_PASS
 - Type:        string
-- Default:     ""
+- Required:    false
 
 #### --sftp-pubkey-file
 
@@ -347,10 +361,12 @@ 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}`.
 
+Properties:
+
 - Config:      pubkey_file
 - Env Var:     RCLONE_SFTP_PUBKEY_FILE
 - Type:        string
-- Default:     ""
+- Required:    false
 
 #### --sftp-key-use-agent
 
@@ -360,6 +376,8 @@ When key-file is also set, the ".pub" file of the specified key-file is read and
 requested from the ssh-agent. This allows to avoid `Too many authentication failures for *username*` errors
 when the ssh-agent contains many keys.
 
+Properties:
+
 - Config:      key_use_agent
 - Env Var:     RCLONE_SFTP_KEY_USE_AGENT
 - Type:        bool
@@ -380,6 +398,8 @@ This enables the use of the following insecure ciphers and key exchange methods:
 
 Those algorithms are insecure and may allow plaintext data to be recovered by an attacker.
 
+Properties:
+
 - Config:      use_insecure_cipher
 - Env Var:     RCLONE_SFTP_USE_INSECURE_CIPHER
 - Type:        bool
@@ -396,6 +416,8 @@ Disable the execution of SSH commands to determine if remote file hashing is ava
 
 Leave blank or set to false to enable hashing (recommended), set to true to disable hashing.
 
+Properties:
+
 - Config:      disable_hashcheck
 - Env Var:     RCLONE_SFTP_DISABLE_HASHCHECK
 - Type:        bool
@@ -413,10 +435,12 @@ 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}`.
 
+Properties:
+
 - Config:      known_hosts_file
 - Env Var:     RCLONE_SFTP_KNOWN_HOSTS_FILE
 - Type:        string
-- Default:     ""
+- Required:    false
 - Examples:
     - "~/.ssh/known_hosts"
         - Use OpenSSH's known_hosts file.
@@ -430,6 +454,8 @@ If this is set and no password is supplied then rclone will:
 - not contact the ssh agent
 
 
+Properties:
+
 - Config:      ask_password
 - Env Var:     RCLONE_SFTP_ASK_PASSWORD
 - Type:        bool
@@ -444,21 +470,25 @@ different. This issue affects among others Synology NAS boxes.
 
 Shared folders can be found in directories representing volumes
 
-    rclone sync /home/local/directory remote:/directory --ssh-path-override /volume2/directory
+    rclone sync /home/local/directory remote:/directory --sftp-path-override /volume2/directory
 
 Home directory can be found in a shared folder called "home"
 
-    rclone sync /home/local/directory remote:/home/directory --ssh-path-override /volume1/homes/USER/directory
+    rclone sync /home/local/directory remote:/home/directory --sftp-path-override /volume1/homes/USER/directory
+
+Properties:
 
 - Config:      path_override
 - Env Var:     RCLONE_SFTP_PATH_OVERRIDE
 - Type:        string
-- Default:     ""
+- Required:    false
 
 #### --sftp-set-modtime
 
 Set the modified time on the remote if set.
 
+Properties:
+
 - Config:      set_modtime
 - Env Var:     RCLONE_SFTP_SET_MODTIME
 - Type:        bool
@@ -470,10 +500,12 @@ The command used to read md5 hashes.
 
 Leave blank for autodetect.
 
+Properties:
+
 - Config:      md5sum_command
 - Env Var:     RCLONE_SFTP_MD5SUM_COMMAND
 - Type:        string
-- Default:     ""
+- Required:    false
 
 #### --sftp-sha1sum-command
 
@@ -481,15 +513,19 @@ The command used to read sha1 hashes.
 
 Leave blank for autodetect.
 
+Properties:
+
 - Config:      sha1sum_command
 - Env Var:     RCLONE_SFTP_SHA1SUM_COMMAND
 - Type:        string
-- Default:     ""
+- Required:    false
 
 #### --sftp-skip-links
 
 Set to skip any symlinks and any other non regular files.
 
+Properties:
+
 - Config:      skip_links
 - Env Var:     RCLONE_SFTP_SKIP_LINKS
 - Type:        bool
@@ -499,6 +535,8 @@ Set to skip any symlinks and any other non regular files.
 
 Specifies the SSH2 subsystem on the remote host.
 
+Properties:
+
 - Config:      subsystem
 - Env Var:     RCLONE_SFTP_SUBSYSTEM
 - Type:        string
@@ -510,10 +548,12 @@ Specifies the path or command to run a sftp server on the remote host.
 
 The subsystem option is ignored when server_command is defined.
 
+Properties:
+
 - Config:      server_command
 - Env Var:     RCLONE_SFTP_SERVER_COMMAND
 - Type:        string
-- Default:     ""
+- Required:    false
 
 #### --sftp-use-fstat
 
@@ -528,6 +568,8 @@ It has been found that this helps with IBM Sterling SFTP servers which have
 any given time.
 
 
+Properties:
+
 - Config:      use_fstat
 - Env Var:     RCLONE_SFTP_USE_FSTAT
 - Type:        bool
@@ -551,6 +593,8 @@ Then you may need to enable this flag.
 If concurrent reads are disabled, the use_fstat option is ignored.
 
 
+Properties:
+
 - Config:      disable_concurrent_reads
 - Env Var:     RCLONE_SFTP_DISABLE_CONCURRENT_READS
 - Type:        bool
@@ -566,6 +610,8 @@ the performance greatly, especially for distant servers.
 This option disables concurrent writes should that be necessary.
 
 
+Properties:
+
 - Config:      disable_concurrent_writes
 - Env Var:     RCLONE_SFTP_DISABLE_CONCURRENT_WRITES
 - Type:        bool
@@ -581,6 +627,8 @@ given, rclone will empty the connection pool.
 Set to 0 to keep connections indefinitely.
 
 
+Properties:
+
 - Config:      idle_timeout
 - Env Var:     RCLONE_SFTP_IDLE_TIMEOUT
 - Type:        Duration