From 843b77aaaa3deb367605fd592b8fba476436e244 Mon Sep 17 00:00:00 2001
From: albertony <12441419+albertony@users.noreply.github.com>
Date: Sat, 11 Sep 2021 18:29:57 +0200
Subject: [PATCH] docs/ftp: improved default value description of port and
 username options

See #5551
---
 backend/ftp/ftp.go    | 10 ++++++----
 backend/sftp/sftp.go  | 10 ++++++----
 docs/content/flags.md |  4 ++--
 docs/content/ftp.md   |  8 ++++----
 docs/content/sftp.md  |  6 ++++--
 5 files changed, 22 insertions(+), 16 deletions(-)

diff --git a/backend/ftp/ftp.go b/backend/ftp/ftp.go
index 15cbb5260..c7a475d88 100644
--- a/backend/ftp/ftp.go
+++ b/backend/ftp/ftp.go
@@ -52,11 +52,13 @@ func init() {
 			Help:     "FTP host to connect to.\n\nE.g. \"ftp.example.com\".",
 			Required: true,
 		}, {
-			Name: "user",
-			Help: "FTP username, leave blank for current username, " + currentUser + ".",
+			Name:    "user",
+			Help:    "FTP username.",
+			Default: currentUser,
 		}, {
-			Name: "port",
-			Help: "FTP port, leave blank to use default (21).",
+			Name:    "port",
+			Help:    "FTP port number.",
+			Default: 21,
 		}, {
 			Name:       "pass",
 			Help:       "FTP password.",
diff --git a/backend/sftp/sftp.go b/backend/sftp/sftp.go
index 7df0f5286..35e21ac2d 100644
--- a/backend/sftp/sftp.go
+++ b/backend/sftp/sftp.go
@@ -60,11 +60,13 @@ func init() {
 			Help:     "SSH host to connect to.\n\nE.g. \"example.com\".",
 			Required: true,
 		}, {
-			Name: "user",
-			Help: "SSH username, leave blank for current username, " + currentUser + ".",
+			Name:    "user",
+			Help:    "SSH username.",
+			Default: currentUser,
 		}, {
-			Name: "port",
-			Help: "SSH port, leave blank to use default (22).",
+			Name:    "port",
+			Help:    "SSH port number.",
+			Default: 22,
 		}, {
 			Name:       "pass",
 			Help:       "SSH password, leave blank to use ssh-agent.",
diff --git a/docs/content/flags.md b/docs/content/flags.md
index fc59849b8..0911539bd 100644
--- a/docs/content/flags.md
+++ b/docs/content/flags.md
@@ -339,7 +339,7 @@ and may be set in the config file.
       --ftp-idle-timeout Duration                    Max time before closing idle connections (default 1m0s)
       --ftp-no-check-certificate                     Do not verify the TLS certificate of the server
       --ftp-pass string                              FTP password (obscured)
-      --ftp-port string                              FTP port, leave blank to use default (21)
+      --ftp-port string                              FTP port number (default 21)
       --ftp-shut-timeout Duration                    Maximum time to wait for data connection closing status (default 1m0s)
       --ftp-tls                                      Use Implicit FTPS (FTP over TLS)
       --ftp-tls-cache-size int                       Size of TLS session cache for all control and data connections (default 32)
@@ -528,7 +528,7 @@ and may be set in the config file.
       --sftp-md5sum-command string                   The command used to read md5 hashes
       --sftp-pass string                             SSH password, leave blank to use ssh-agent (obscured)
       --sftp-path-override string                    Override path used by SSH connection
-      --sftp-port string                             SSH port, leave blank to use default (22)
+      --sftp-port string                             SSH port number (default 22)
       --sftp-pubkey-file string                      Optional path to public key file
       --sftp-server-command string                   Specifies the path or command to run a sftp server on the remote host
       --sftp-set-modtime                             Set the modified time on the remote if set (default true)
diff --git a/docs/content/ftp.md b/docs/content/ftp.md
index 85a696aab..82cffde5e 100644
--- a/docs/content/ftp.md
+++ b/docs/content/ftp.md
@@ -51,11 +51,11 @@ Choose a number from below, or type in your own value
  1 / Connect to ftp.example.com
    \ "ftp.example.com"
 host> ftp.example.com
-FTP username, leave blank for current username, $USER
-Enter a string value. Press Enter for the default ("").
+FTP username
+Enter a string value. Press Enter for the default ("$USER").
 user> 
-FTP port, leave blank to use default (21)
-Enter a string value. Press Enter for the default ("").
+FTP port number
+Enter a signed integer. Press Enter for the default (21).
 port> 
 FTP password
 y) Yes type in my own password
diff --git a/docs/content/sftp.md b/docs/content/sftp.md
index 8236afb3c..f15a22f8a 100644
--- a/docs/content/sftp.md
+++ b/docs/content/sftp.md
@@ -56,9 +56,11 @@ Choose a number from below, or type in your own value
  1 / Connect to example.com
    \ "example.com"
 host> example.com
-SSH username, leave blank for current username, $USER
+SSH username
+Enter a string value. Press Enter for the default ("$USER").
 user> sftpuser
-SSH port, leave blank to use default (22)
+SSH port number
+Enter a signed integer. Press Enter for the default (22).
 port>
 SSH password, leave blank to use ssh-agent.
 y) Yes type in my own password