Skip to content

"rsync for cloud storage" - Google Drive, S3, Dropbox, Backblaze B2, One Drive, Swift, Hubic, Wasabi, Google Cloud Storage, Azure Blob, Azure Files, Yandex Files

docs: use the term backend name instead of fs name for authorize command

albertony54e8bb89f790
diff --git a/cmd/authorize/authorize.go b/cmd/authorize/authorize.go
index 4284aa286..2e7348562 100644
--- a/cmd/authorize/authorize.go
+++ b/cmd/authorize/authorize.go
@@ -23,7 +23,7 @@ func init() {
}
var commandDefinition = &cobra.Command{
- Use: "authorize <fs name> [base64_json_blob | client_id client_secret]",
+ Use: "authorize <backendname> [base64_json_blob | client_id client_secret]",
Short: `Remote authorization.`,
Long: `Remote authorization. Used to authorize a remote or headless
rclone from a machine with a browser - use as instructed by
@@ -31,7 +31,7 @@ rclone config.
The command requires 1-3 arguments:
-- fs name (e.g., "drive", "s3", etc.)
+- Name of a backend (e.g. "drive", "s3")
- Either a base64 encoded JSON blob obtained from a previous rclone config session
- Or a client_id and client_secret pair obtained from the remote service
diff --git a/cmd/authorize/authorize_test.go b/cmd/authorize/authorize_test.go
index 364da5ed1..eace8b6e3 100644
--- a/cmd/authorize/authorize_test.go
+++ b/cmd/authorize/authorize_test.go
@@ -10,7 +10,7 @@ import (
func TestAuthorizeCommand(t *testing.T) {
// Test that the Use string is correctly formatted
- if commandDefinition.Use != "authorize <fs name> [base64_json_blob | client_id client_secret]" {
+ if commandDefinition.Use != "authorize <backendname> [base64_json_blob | client_id client_secret]" {
t.Errorf("Command Use string doesn't match expected format: %s", commandDefinition.Use)
}
@@ -26,7 +26,7 @@ func TestAuthorizeCommand(t *testing.T) {
}
helpOutput := buf.String()
- if !strings.Contains(helpOutput, "authorize <fs name>") {
+ if !strings.Contains(helpOutput, "authorize <backendname>") {
t.Errorf("Help output doesn't contain correct usage information")
}
}
diff --git a/fs/config/authorize.go b/fs/config/authorize.go
index 8f3aa86ce..37be3ae43 100644
--- a/fs/config/authorize.go
+++ b/fs/config/authorize.go
@@ -12,9 +12,9 @@ import (
//
// It expects 1, 2 or 3 arguments
//
-// rclone authorize "fs name"
-// rclone authorize "fs name" "base64 encoded JSON blob"
-// rclone authorize "fs name" "client id" "client secret"
+// rclone authorize "backend name"
+// rclone authorize "backend name" "base64 encoded JSON blob"
+// rclone authorize "backend name" "client id" "client secret"
func Authorize(ctx context.Context, args []string, noAutoBrowser bool, templateFile string) error {
ctx = suppressConfirm(ctx)
ctx = fs.ConfigOAuthOnly(ctx)