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: fix missing punctuation in backend commands short description

albertony0dd56ff2a391
diff --git a/backend/b2/b2.go b/backend/b2/b2.go
index 7d1df41f3..bf2b11c4a 100644
--- a/backend/b2/b2.go
+++ b/backend/b2/b2.go
@@ -2357,7 +2357,7 @@ func (o *Object) ID() string {
var lifecycleHelp = fs.CommandHelp{
Name: "lifecycle",
- Short: "Read or set the lifecycle for a bucket",
+ Short: "Read or set the lifecycle for a bucket.",
Long: `This command can be used to read or set the lifecycle for a bucket.
Usage Examples:
diff --git a/backend/crypt/crypt.go b/backend/crypt/crypt.go
index 976648fdc..9979b4a9e 100644
--- a/backend/crypt/crypt.go
+++ b/backend/crypt/crypt.go
@@ -923,7 +923,7 @@ func (f *Fs) ChangeNotify(ctx context.Context, notifyFunc func(string, fs.EntryT
var commandHelp = []fs.CommandHelp{
{
Name: "encode",
- Short: "Encode the given filename(s)",
+ Short: "Encode the given filename(s).",
Long: `This encodes the filenames given as arguments returning a list of
strings of the encoded results.
@@ -935,7 +935,7 @@ Usage Example:
},
{
Name: "decode",
- Short: "Decode the given filename(s)",
+ Short: "Decode the given filename(s).",
Long: `This decodes the filenames given as arguments returning a list of
strings of the decoded results. It will return an error if any of the
inputs are invalid.
diff --git a/backend/drive/drive.go b/backend/drive/drive.go
index b68f137f7..944d41850 100644
--- a/backend/drive/drive.go
+++ b/backend/drive/drive.go
@@ -3664,7 +3664,7 @@ func (f *Fs) rescue(ctx context.Context, dirID string, delete bool) (err error)
var commandHelp = []fs.CommandHelp{{
Name: "get",
- Short: "Get command for fetching the drive config parameters",
+ Short: "Get command for fetching the drive config parameters.",
Long: `This is a get command which will be used to fetch the various drive config parameters
Usage Examples:
@@ -3678,7 +3678,7 @@ Usage Examples:
},
}, {
Name: "set",
- Short: "Set command for updating the drive config parameters",
+ Short: "Set command for updating the drive config parameters.",
Long: `This is a set command which will be used to update the various drive config parameters
Usage Examples:
@@ -3692,7 +3692,7 @@ Usage Examples:
},
}, {
Name: "shortcut",
- Short: "Create shortcuts from files or directories",
+ Short: "Create shortcuts from files or directories.",
Long: `This command creates shortcuts from files or directories.
Usage:
@@ -3715,7 +3715,7 @@ authenticated with "drive2:" can't read files from "drive:".
},
}, {
Name: "drives",
- Short: "List the Shared Drives available to this account",
+ Short: "List the Shared Drives available to this account.",
Long: `This command lists the Shared Drives (Team Drives) available to this
account.
@@ -3762,7 +3762,7 @@ drives combined into one directory tree.
`,
}, {
Name: "untrash",
- Short: "Untrash files and directories",
+ Short: "Untrash files and directories.",
Long: `This command untrashes all the files and directories in the directory
passed in recursively.
@@ -3785,7 +3785,7 @@ Result:
`,
}, {
Name: "copyid",
- Short: "Copy files by ID",
+ Short: "Copy files by ID.",
Long: `This command copies files by ID
Usage:
@@ -3808,7 +3808,7 @@ Use the --interactive/-i or --dry-run flag to see what would be copied before co
`,
}, {
Name: "moveid",
- Short: "Move files by ID",
+ Short: "Move files by ID.",
Long: `This command moves files by ID
Usage:
@@ -3830,13 +3830,13 @@ Use the --interactive/-i or --dry-run flag to see what would be moved beforehand
`,
}, {
Name: "exportformats",
- Short: "Dump the export formats for debug purposes",
+ Short: "Dump the export formats for debug purposes.",
}, {
Name: "importformats",
- Short: "Dump the import formats for debug purposes",
+ Short: "Dump the import formats for debug purposes.",
}, {
Name: "query",
- Short: "List files using Google Drive query language",
+ Short: "List files using Google Drive query language.",
Long: `This command lists files based on a query
Usage:
@@ -3877,7 +3877,7 @@ The result is a JSON array of matches, for example:
]`,
}, {
Name: "rescue",
- Short: "Rescue or delete any orphaned files",
+ Short: "Rescue or delete any orphaned files.",
Long: `This command rescues or deletes any orphaned files or directories.
Sometimes files can get orphaned in Google Drive. This means that they
diff --git a/backend/hasher/commands.go b/backend/hasher/commands.go
index 2797e5d4f..3f8c45fca 100644
--- a/backend/hasher/commands.go
+++ b/backend/hasher/commands.go
@@ -43,29 +43,29 @@ func (f *Fs) Command(ctx context.Context, name string, arg []string, opt map[str
var commandHelp = []fs.CommandHelp{{
Name: "drop",
- Short: "Drop cache",
+ Short: "Drop cache.",
Long: `Completely drop checksum cache.
Usage Example:
rclone backend drop hasher:
`,
}, {
Name: "dump",
- Short: "Dump the database",
+ Short: "Dump the database.",
Long: "Dump cache records covered by the current remote",
}, {
Name: "fulldump",
- Short: "Full dump of the database",
+ Short: "Full dump of the database.",
Long: "Dump all cache records in the database",
}, {
Name: "import",
- Short: "Import a SUM file",
+ Short: "Import a SUM file.",
Long: `Amend hash cache from a SUM file and bind checksums to files by size/time.
Usage Example:
rclone backend import hasher:subdir md5 /path/to/sum.md5
`,
}, {
Name: "stickyimport",
- Short: "Perform fast import of a SUM file",
+ Short: "Perform fast import of a SUM file.",
Long: `Fill hash cache from a SUM file without verifying file fingerprints.
Usage Example:
rclone backend stickyimport hasher:subdir md5 remote:path/to/sum.md5
diff --git a/backend/local/local.go b/backend/local/local.go
index 61669d01e..b7ee82da6 100644
--- a/backend/local/local.go
+++ b/backend/local/local.go
@@ -1070,7 +1070,7 @@ func (f *Fs) Hashes() hash.Set {
var commandHelp = []fs.CommandHelp{
{
Name: "noop",
- Short: "A null operation for testing backend commands",
+ Short: "A null operation for testing backend commands.",
Long: `This is a test command which has some options
you can try to change the output.`,
Opts: map[string]string{
diff --git a/backend/netstorage/netstorage.go b/backend/netstorage/netstorage.go
index 74964bd07..592cb0535 100755
--- a/backend/netstorage/netstorage.go
+++ b/backend/netstorage/netstorage.go
@@ -87,7 +87,7 @@ Please choose the 'y' option to set your own password then enter your secret.`,
var commandHelp = []fs.CommandHelp{{
Name: "du",
- Short: "Return disk usage information for a specified directory",
+ Short: "Return disk usage information for a specified directory.",
Long: `The usage information returned, includes the targeted directory as well as all
files stored in any sub-directories that may exist.`,
}, {
diff --git a/backend/oracleobjectstorage/command.go b/backend/oracleobjectstorage/command.go
index fa687fef8..8c2fb877f 100644
--- a/backend/oracleobjectstorage/command.go
+++ b/backend/oracleobjectstorage/command.go
@@ -30,7 +30,7 @@ const (
var commandHelp = []fs.CommandHelp{{
Name: operationRename,
- Short: "change the name of an object",
+ Short: "change the name of an object.",
Long: `This command can be used to rename a object.
Usage Examples:
@@ -40,7 +40,7 @@ Usage Examples:
Opts: nil,
}, {
Name: operationListMultiPart,
- Short: "List the unfinished multipart uploads",
+ Short: "List the unfinished multipart uploads.",
Long: `This command lists the unfinished multipart uploads in JSON format.
rclone backend list-multipart-uploads oos:bucket/path/to/object
@@ -82,7 +82,7 @@ Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc.
},
}, {
Name: operationRestore,
- Short: "Restore objects from Archive to Standard storage",
+ Short: "Restore objects from Archive to Standard storage.",
Long: `This command can be used to restore one or more objects from Archive to Standard storage.
Usage Examples:
diff --git a/backend/pikpak/pikpak.go b/backend/pikpak/pikpak.go
index e8638af39..acafc3378 100644
--- a/backend/pikpak/pikpak.go
+++ b/backend/pikpak/pikpak.go
@@ -1678,7 +1678,7 @@ func (f *Fs) decompressDir(ctx context.Context, filename, id, password string, s
var commandHelp = []fs.CommandHelp{{
Name: "addurl",
- Short: "Add offline download task for url",
+ Short: "Add offline download task for url.",
Long: `This command adds offline download task for url.
Usage:
@@ -1690,7 +1690,7 @@ download will fallback to default 'My Pack' folder.
`,
}, {
Name: "decompress",
- Short: "Request decompress of a file/files in a folder",
+ Short: "Request decompress of a file/files in a folder.",
Long: `This command requests decompress of file/files in a folder.
Usage:
diff --git a/backend/s3/s3.go b/backend/s3/s3.go
index 79c618566..f04336486 100644
--- a/backend/s3/s3.go
+++ b/backend/s3/s3.go
@@ -2902,7 +2902,7 @@ func (f *Fs) PublicLink(ctx context.Context, remote string, expire fs.Duration,
var commandHelp = []fs.CommandHelp{{
Name: "restore",
- Short: "Restore objects from GLACIER or INTELLIGENT-TIERING archive tier",
+ Short: "Restore objects from GLACIER or INTELLIGENT-TIERING archive tier.",
Long: `This command can be used to restore one or more objects from GLACIER to normal storage
or from INTELLIGENT-TIERING Archive Access / Deep Archive Access tier to the Frequent Access tier.
@@ -2944,7 +2944,7 @@ if not.
},
}, {
Name: "restore-status",
- Short: "Show the restore status for objects being restored from GLACIER or INTELLIGENT-TIERING storage",
+ Short: "Show the restore status for objects being restored from GLACIER or INTELLIGENT-TIERING storage.",
Long: `This command can be used to show the status for objects being restored from GLACIER to normal storage
or from INTELLIGENT-TIERING Archive Access / Deep Archive Access tier to the Frequent Access tier.
@@ -2993,7 +2993,7 @@ It returns a list of status dictionaries.
},
}, {
Name: "list-multipart-uploads",
- Short: "List the unfinished multipart uploads",
+ Short: "List the unfinished multipart uploads.",
Long: `This command lists the unfinished multipart uploads in JSON format.
rclone backend list-multipart s3:bucket/path/to/object