mirror of
https://github.com/rclone/rclone.git
synced 2025-12-06 00:03:32 +00:00
docs: fix markdownlint issue md046/code-block-style in backend command docs
This commit is contained in:
@@ -2364,10 +2364,13 @@ Usage Examples:
|
|||||||
|
|
||||||
To show the current lifecycle rules:
|
To show the current lifecycle rules:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend lifecycle b2:bucket
|
rclone backend lifecycle b2:bucket
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
This will dump something like this showing the lifecycle rules.
|
This will dump something like this showing the lifecycle rules.
|
||||||
|
|
||||||
|
` + "```json" + `
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"daysFromHidingToDeleting": 1,
|
"daysFromHidingToDeleting": 1,
|
||||||
@@ -2376,13 +2379,16 @@ This will dump something like this showing the lifecycle rules.
|
|||||||
"fileNamePrefix": ""
|
"fileNamePrefix": ""
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
If there are no lifecycle rules (the default) then it will just return [].
|
If there are no lifecycle rules (the default) then it will just return [].
|
||||||
|
|
||||||
To reset the current lifecycle rules:
|
To reset the current lifecycle rules:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend lifecycle b2:bucket -o daysFromHidingToDeleting=30
|
rclone backend lifecycle b2:bucket -o daysFromHidingToDeleting=30
|
||||||
rclone backend lifecycle b2:bucket -o daysFromUploadingToHiding=5 -o daysFromHidingToDeleting=1
|
rclone backend lifecycle b2:bucket -o daysFromUploadingToHiding=5 -o daysFromHidingToDeleting=1
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
This will run and then print the new lifecycle rules as above.
|
This will run and then print the new lifecycle rules as above.
|
||||||
|
|
||||||
@@ -2394,7 +2400,9 @@ the daysFromHidingToDeleting to 1 day. You can enable hard_delete in
|
|||||||
the config also which will mean deletions won't cause versions but
|
the config also which will mean deletions won't cause versions but
|
||||||
overwrites will still cause versions to be made.
|
overwrites will still cause versions to be made.
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend lifecycle b2:bucket -o daysFromHidingToDeleting=1
|
rclone backend lifecycle b2:bucket -o daysFromHidingToDeleting=1
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
See: https://www.backblaze.com/docs/cloud-storage-lifecycle-rules
|
See: https://www.backblaze.com/docs/cloud-storage-lifecycle-rules
|
||||||
`,
|
`,
|
||||||
@@ -2484,8 +2492,10 @@ max-age, which defaults to 24 hours.
|
|||||||
Note that you can use --interactive/-i or --dry-run with this command to see what
|
Note that you can use --interactive/-i or --dry-run with this command to see what
|
||||||
it would do.
|
it would do.
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend cleanup b2:bucket/path/to/object
|
rclone backend cleanup b2:bucket/path/to/object
|
||||||
rclone backend cleanup -o max-age=7w b2:bucket/path/to/object
|
rclone backend cleanup -o max-age=7w b2:bucket/path/to/object
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc.
|
Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc.
|
||||||
`,
|
`,
|
||||||
@@ -2513,7 +2523,9 @@ var cleanupHiddenHelp = fs.CommandHelp{
|
|||||||
Note that you can use --interactive/-i or --dry-run with this command to see what
|
Note that you can use --interactive/-i or --dry-run with this command to see what
|
||||||
it would do.
|
it would do.
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend cleanup-hidden b2:bucket/path/to/dir
|
rclone backend cleanup-hidden b2:bucket/path/to/dir
|
||||||
|
` + "```" + `
|
||||||
`,
|
`,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -929,8 +929,10 @@ strings of the encoded results.
|
|||||||
|
|
||||||
Usage Example:
|
Usage Example:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend encode crypt: file1 [file2...]
|
rclone backend encode crypt: file1 [file2...]
|
||||||
rclone rc backend/command command=encode fs=crypt: file1 [file2...]
|
rclone rc backend/command command=encode fs=crypt: file1 [file2...]
|
||||||
|
` + "```" + `
|
||||||
`,
|
`,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -942,8 +944,10 @@ inputs are invalid.
|
|||||||
|
|
||||||
Usage Example:
|
Usage Example:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend decode crypt: encryptedfile1 [encryptedfile2...]
|
rclone backend decode crypt: encryptedfile1 [encryptedfile2...]
|
||||||
rclone rc backend/command command=decode fs=crypt: encryptedfile1 [encryptedfile2...]
|
rclone rc backend/command command=decode fs=crypt: encryptedfile1 [encryptedfile2...]
|
||||||
|
` + "```" + `
|
||||||
`,
|
`,
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -563,7 +563,11 @@ var commandHelp = []fs.CommandHelp{{
|
|||||||
Short: "Show metadata about the DOI.",
|
Short: "Show metadata about the DOI.",
|
||||||
Long: `This command returns a JSON object with some information about the DOI.
|
Long: `This command returns a JSON object with some information about the DOI.
|
||||||
|
|
||||||
rclone backend medatadata doi:
|
Usage example:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
|
rclone backend metadata doi:
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
It returns a JSON object representing metadata about the DOI.
|
It returns a JSON object representing metadata about the DOI.
|
||||||
`,
|
`,
|
||||||
@@ -573,11 +577,13 @@ It returns a JSON object representing metadata about the DOI.
|
|||||||
Long: `This set command can be used to update the config parameters
|
Long: `This set command can be used to update the config parameters
|
||||||
for a running doi backend.
|
for a running doi backend.
|
||||||
|
|
||||||
Usage Examples:
|
Usage examples:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend set doi: [-o opt_name=opt_value] [-o opt_name2=opt_value2]
|
rclone backend set doi: [-o opt_name=opt_value] [-o opt_name2=opt_value2]
|
||||||
rclone rc backend/command command=set fs=doi: [-o opt_name=opt_value] [-o opt_name2=opt_value2]
|
rclone rc backend/command command=set fs=doi: [-o opt_name=opt_value] [-o opt_name2=opt_value2]
|
||||||
rclone rc backend/command command=set fs=doi: -o doi=NEW_DOI
|
rclone rc backend/command command=set fs=doi: -o doi=NEW_DOI
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
The option keys are named as they are in the config file.
|
The option keys are named as they are in the config file.
|
||||||
|
|
||||||
|
|||||||
@@ -3669,8 +3669,10 @@ var commandHelp = []fs.CommandHelp{{
|
|||||||
|
|
||||||
Usage Examples:
|
Usage Examples:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend get drive: [-o service_account_file] [-o chunk_size]
|
rclone backend get drive: [-o service_account_file] [-o chunk_size]
|
||||||
rclone rc backend/command command=get fs=drive: [-o service_account_file] [-o chunk_size]
|
rclone rc backend/command command=get fs=drive: [-o service_account_file] [-o chunk_size]
|
||||||
|
` + "```" + `
|
||||||
`,
|
`,
|
||||||
Opts: map[string]string{
|
Opts: map[string]string{
|
||||||
"chunk_size": "show the current upload chunk size",
|
"chunk_size": "show the current upload chunk size",
|
||||||
@@ -3683,8 +3685,10 @@ Usage Examples:
|
|||||||
|
|
||||||
Usage Examples:
|
Usage Examples:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend set drive: [-o service_account_file=sa.json] [-o chunk_size=67108864]
|
rclone backend set drive: [-o service_account_file=sa.json] [-o chunk_size=67108864]
|
||||||
rclone rc backend/command command=set fs=drive: [-o service_account_file=sa.json] [-o chunk_size=67108864]
|
rclone rc backend/command command=set fs=drive: [-o service_account_file=sa.json] [-o chunk_size=67108864]
|
||||||
|
` + "```" + `
|
||||||
`,
|
`,
|
||||||
Opts: map[string]string{
|
Opts: map[string]string{
|
||||||
"chunk_size": "update the current upload chunk size",
|
"chunk_size": "update the current upload chunk size",
|
||||||
@@ -3697,8 +3701,10 @@ Usage Examples:
|
|||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend shortcut drive: source_item destination_shortcut
|
rclone backend shortcut drive: source_item destination_shortcut
|
||||||
rclone backend shortcut drive: source_item -o target=drive2: destination_shortcut
|
rclone backend shortcut drive: source_item -o target=drive2: destination_shortcut
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
In the first example this creates a shortcut from the "source_item"
|
In the first example this creates a shortcut from the "source_item"
|
||||||
which can be a file or a directory to the "destination_shortcut". The
|
which can be a file or a directory to the "destination_shortcut". The
|
||||||
@@ -3721,10 +3727,13 @@ account.
|
|||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend [-o config] drives drive:
|
rclone backend [-o config] drives drive:
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
This will return a JSON list of objects like this
|
This will return a JSON list of objects like this:
|
||||||
|
|
||||||
|
` + "```json" + `
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"id": "0ABCDEF-01234567890",
|
"id": "0ABCDEF-01234567890",
|
||||||
@@ -3737,11 +3746,13 @@ This will return a JSON list of objects like this
|
|||||||
"name": "Test Drive"
|
"name": "Test Drive"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
With the -o config parameter it will output the list in a format
|
With the -o config parameter it will output the list in a format
|
||||||
suitable for adding to a config file to make aliases for all the
|
suitable for adding to a config file to make aliases for all the
|
||||||
drives found and a combined drive.
|
drives found and a combined drive.
|
||||||
|
|
||||||
|
` + "```ini" + `
|
||||||
[My Drive]
|
[My Drive]
|
||||||
type = alias
|
type = alias
|
||||||
remote = drive,team_drive=0ABCDEF-01234567890,root_folder_id=:
|
remote = drive,team_drive=0ABCDEF-01234567890,root_folder_id=:
|
||||||
@@ -3753,6 +3764,7 @@ drives found and a combined drive.
|
|||||||
[AllDrives]
|
[AllDrives]
|
||||||
type = combine
|
type = combine
|
||||||
upstreams = "My Drive=My Drive:" "Test Drive=Test Drive:"
|
upstreams = "My Drive=My Drive:" "Test Drive=Test Drive:"
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
Adding this to the rclone config file will cause those team drives to
|
Adding this to the rclone config file will cause those team drives to
|
||||||
be accessible with the aliases shown. Any illegal characters will be
|
be accessible with the aliases shown. Any illegal characters will be
|
||||||
@@ -3768,20 +3780,24 @@ passed in recursively.
|
|||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
|
|
||||||
This takes an optional directory to trash which make this easier to
|
` + "```console" + `
|
||||||
use via the API.
|
|
||||||
|
|
||||||
rclone backend untrash drive:directory
|
rclone backend untrash drive:directory
|
||||||
rclone backend --interactive untrash drive:directory subdir
|
rclone backend --interactive untrash drive:directory subdir
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
|
This takes an optional directory to trash which make this easier to
|
||||||
|
use via the API.
|
||||||
|
|
||||||
Use the --interactive/-i or --dry-run flag to see what would be restored before restoring it.
|
Use the --interactive/-i or --dry-run flag to see what would be restored before restoring it.
|
||||||
|
|
||||||
Result:
|
Result:
|
||||||
|
|
||||||
|
` + "```json" + `
|
||||||
{
|
{
|
||||||
"Untrashed": 17,
|
"Untrashed": 17,
|
||||||
"Errors": 0
|
"Errors": 0
|
||||||
}
|
}
|
||||||
|
` + "```" + `
|
||||||
`,
|
`,
|
||||||
}, {
|
}, {
|
||||||
Name: "copyid",
|
Name: "copyid",
|
||||||
@@ -3790,8 +3806,10 @@ Result:
|
|||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend copyid drive: ID path
|
rclone backend copyid drive: ID path
|
||||||
rclone backend copyid drive: ID1 path1 ID2 path2
|
rclone backend copyid drive: ID1 path1 ID2 path2
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
It copies the drive file with ID given to the path (an rclone path which
|
It copies the drive file with ID given to the path (an rclone path which
|
||||||
will be passed internally to rclone copyto). The ID and path pairs can be
|
will be passed internally to rclone copyto). The ID and path pairs can be
|
||||||
@@ -3813,8 +3831,10 @@ Use the --interactive/-i or --dry-run flag to see what would be copied before co
|
|||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend moveid drive: ID path
|
rclone backend moveid drive: ID path
|
||||||
rclone backend moveid drive: ID1 path1 ID2 path2
|
rclone backend moveid drive: ID1 path1 ID2 path2
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
It moves the drive file with ID given to the path (an rclone path which
|
It moves the drive file with ID given to the path (an rclone path which
|
||||||
will be passed internally to rclone moveto).
|
will be passed internally to rclone moveto).
|
||||||
@@ -3841,23 +3861,30 @@ Use the --interactive/-i or --dry-run flag to see what would be moved beforehand
|
|||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend query drive: query
|
rclone backend query drive: query
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
The query syntax is documented at [Google Drive Search query terms and
|
The query syntax is documented at [Google Drive Search query terms and
|
||||||
operators](https://developers.google.com/drive/api/guides/ref-search-terms).
|
operators](https://developers.google.com/drive/api/guides/ref-search-terms).
|
||||||
|
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend query drive: "'0ABc9DEFGHIJKLMNop0QRatUVW3X' in parents and name contains 'foo'"
|
rclone backend query drive: "'0ABc9DEFGHIJKLMNop0QRatUVW3X' in parents and name contains 'foo'"
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
If the query contains literal ' or \ characters, these need to be escaped with
|
If the query contains literal ' or \ characters, these need to be escaped with
|
||||||
\ characters. "'" becomes "\'" and "\" becomes "\\\", for example to match a
|
\ characters. "'" becomes "\'" and "\" becomes "\\\", for example to match a
|
||||||
file named "foo ' \.txt":
|
file named "foo ' \.txt":
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend query drive: "name = 'foo \' \\\.txt'"
|
rclone backend query drive: "name = 'foo \' \\\.txt'"
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
The result is a JSON array of matches, for example:
|
The result is a JSON array of matches, for example:
|
||||||
|
|
||||||
|
` + "```json" + `
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"createdTime": "2017-06-29T19:58:28.537Z",
|
"createdTime": "2017-06-29T19:58:28.537Z",
|
||||||
@@ -3874,7 +3901,9 @@ The result is a JSON array of matches, for example:
|
|||||||
"size": "311",
|
"size": "311",
|
||||||
"webViewLink": "https://drive.google.com/file/d/0AxBe_CDEF4zkGHI4d0FjYko2QkD/view?usp=drivesdk\u0026resourcekey=0-ABCDEFGHIXJQpIGqBJq3MC"
|
"webViewLink": "https://drive.google.com/file/d/0AxBe_CDEF4zkGHI4d0FjYko2QkD/view?usp=drivesdk\u0026resourcekey=0-ABCDEFGHIXJQpIGqBJq3MC"
|
||||||
}
|
}
|
||||||
]`,
|
]
|
||||||
|
` + "```console" + `
|
||||||
|
`,
|
||||||
}, {
|
}, {
|
||||||
Name: "rescue",
|
Name: "rescue",
|
||||||
Short: "Rescue or delete any orphaned files.",
|
Short: "Rescue or delete any orphaned files.",
|
||||||
@@ -3892,19 +3921,27 @@ This can be used in 3 ways.
|
|||||||
|
|
||||||
First, list all orphaned files
|
First, list all orphaned files
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend rescue drive:
|
rclone backend rescue drive:
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
Second rescue all orphaned files to the directory indicated
|
Second rescue all orphaned files to the directory indicated
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend rescue drive: "relative/path/to/rescue/directory"
|
rclone backend rescue drive: "relative/path/to/rescue/directory"
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
e.g. To rescue all orphans to a directory called "Orphans" in the top level
|
e.g. To rescue all orphans to a directory called "Orphans" in the top level
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend rescue drive: Orphans
|
rclone backend rescue drive: Orphans
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
Third delete all orphaned files to the trash
|
Third delete all orphaned files to the trash
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend rescue drive: -o delete
|
rclone backend rescue drive: -o delete
|
||||||
|
` + "```" + `
|
||||||
`,
|
`,
|
||||||
}}
|
}}
|
||||||
|
|
||||||
|
|||||||
@@ -46,7 +46,10 @@ var commandHelp = []fs.CommandHelp{{
|
|||||||
Short: "Drop cache.",
|
Short: "Drop cache.",
|
||||||
Long: `Completely drop checksum cache.
|
Long: `Completely drop checksum cache.
|
||||||
Usage Example:
|
Usage Example:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend drop hasher:
|
rclone backend drop hasher:
|
||||||
|
` + "```" + `
|
||||||
`,
|
`,
|
||||||
}, {
|
}, {
|
||||||
Name: "dump",
|
Name: "dump",
|
||||||
@@ -60,15 +63,23 @@ Usage Example:
|
|||||||
Name: "import",
|
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.
|
Long: `Amend hash cache from a SUM file and bind checksums to files by size/time.
|
||||||
Usage Example:
|
|
||||||
|
Usage example:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend import hasher:subdir md5 /path/to/sum.md5
|
rclone backend import hasher:subdir md5 /path/to/sum.md5
|
||||||
|
` + "```" + `
|
||||||
`,
|
`,
|
||||||
}, {
|
}, {
|
||||||
Name: "stickyimport",
|
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.
|
Long: `Fill hash cache from a SUM file without verifying file fingerprints.
|
||||||
Usage Example:
|
|
||||||
|
Usage example:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend stickyimport hasher:subdir md5 remote:path/to/sum.md5
|
rclone backend stickyimport hasher:subdir md5 remote:path/to/sum.md5
|
||||||
|
` + "```" + `
|
||||||
`,
|
`,
|
||||||
}}
|
}}
|
||||||
|
|
||||||
|
|||||||
@@ -724,9 +724,11 @@ for a running http backend.
|
|||||||
|
|
||||||
Usage Examples:
|
Usage Examples:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend set remote: [-o opt_name=opt_value] [-o opt_name2=opt_value2]
|
rclone backend set remote: [-o opt_name=opt_value] [-o opt_name2=opt_value2]
|
||||||
rclone rc backend/command command=set fs=remote: [-o opt_name=opt_value] [-o opt_name2=opt_value2]
|
rclone rc backend/command command=set fs=remote: [-o opt_name=opt_value] [-o opt_name2=opt_value2]
|
||||||
rclone rc backend/command command=set fs=remote: -o url=https://example.com
|
rclone rc backend/command command=set fs=remote: -o url=https://example.com
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
The option keys are named as they are in the config file.
|
The option keys are named as they are in the config file.
|
||||||
|
|
||||||
|
|||||||
@@ -35,7 +35,9 @@ var commandHelp = []fs.CommandHelp{{
|
|||||||
|
|
||||||
Usage Examples:
|
Usage Examples:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend rename oos:bucket relative-object-path-under-bucket object-new-name
|
rclone backend rename oos:bucket relative-object-path-under-bucket object-new-name
|
||||||
|
` + "```" + `
|
||||||
`,
|
`,
|
||||||
Opts: nil,
|
Opts: nil,
|
||||||
}, {
|
}, {
|
||||||
@@ -43,7 +45,11 @@ Usage Examples:
|
|||||||
Short: "List the unfinished multipart uploads.",
|
Short: "List the unfinished multipart uploads.",
|
||||||
Long: `This command lists the unfinished multipart uploads in JSON format.
|
Long: `This command lists the unfinished multipart uploads in JSON format.
|
||||||
|
|
||||||
|
Usage Examples:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend list-multipart-uploads oos:bucket/path/to/object
|
rclone backend list-multipart-uploads oos:bucket/path/to/object
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
It returns a dictionary of buckets with values as lists of unfinished
|
It returns a dictionary of buckets with values as lists of unfinished
|
||||||
multipart uploads.
|
multipart uploads.
|
||||||
@@ -51,6 +57,8 @@ multipart uploads.
|
|||||||
You can call it with no bucket in which case it lists all bucket, with
|
You can call it with no bucket in which case it lists all bucket, with
|
||||||
a bucket or with a bucket and path.
|
a bucket or with a bucket and path.
|
||||||
|
|
||||||
|
|
||||||
|
` + "```json" + `
|
||||||
{
|
{
|
||||||
"test-bucket": [
|
"test-bucket": [
|
||||||
{
|
{
|
||||||
@@ -62,6 +70,7 @@ a bucket or with a bucket and path.
|
|||||||
"storageTier": "Standard"
|
"storageTier": "Standard"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
}
|
||||||
`,
|
`,
|
||||||
}, {
|
}, {
|
||||||
Name: operationCleanup,
|
Name: operationCleanup,
|
||||||
@@ -72,8 +81,12 @@ max-age which defaults to 24 hours.
|
|||||||
Note that you can use --interactive/-i or --dry-run with this command to see what
|
Note that you can use --interactive/-i or --dry-run with this command to see what
|
||||||
it would do.
|
it would do.
|
||||||
|
|
||||||
|
Usage Examples:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend cleanup oos:bucket/path/to/object
|
rclone backend cleanup oos:bucket/path/to/object
|
||||||
rclone backend cleanup -o max-age=7w oos:bucket/path/to/object
|
rclone backend cleanup -o max-age=7w oos:bucket/path/to/object
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc.
|
Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc.
|
||||||
`,
|
`,
|
||||||
@@ -87,21 +100,28 @@ Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc.
|
|||||||
|
|
||||||
Usage Examples:
|
Usage Examples:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend restore oos:bucket/path/to/directory -o hours=HOURS
|
rclone backend restore oos:bucket/path/to/directory -o hours=HOURS
|
||||||
rclone backend restore oos:bucket -o hours=HOURS
|
rclone backend restore oos:bucket -o hours=HOURS
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
This flag also obeys the filters. Test first with --interactive/-i or --dry-run flags
|
This flag also obeys the filters. Test first with --interactive/-i or --dry-run flags
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone --interactive backend restore --include "*.txt" oos:bucket/path -o hours=72
|
rclone --interactive backend restore --include "*.txt" oos:bucket/path -o hours=72
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
All the objects shown will be marked for restore, then
|
All the objects shown will be marked for restore, then
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend restore --include "*.txt" oos:bucket/path -o hours=72
|
rclone backend restore --include "*.txt" oos:bucket/path -o hours=72
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
It returns a list of status dictionaries with Object Name and Status
|
It returns a list of status dictionaries with Object Name and Status
|
||||||
keys. The Status will be "RESTORED"" if it was successful or an error message
|
keys. The Status will be "RESTORED"" if it was successful or an error message
|
||||||
if not.
|
if not.
|
||||||
|
|
||||||
|
` + "```json" + `
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"Object": "test.txt"
|
"Object": "test.txt"
|
||||||
@@ -112,6 +132,7 @@ All the objects shown will be marked for restore, then
|
|||||||
"Status": "RESTORED",
|
"Status": "RESTORED",
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
` + "```" + `
|
||||||
`,
|
`,
|
||||||
Opts: map[string]string{
|
Opts: map[string]string{
|
||||||
"hours": "The number of hours for which this object will be restored. Default is 24 hrs.",
|
"hours": "The number of hours for which this object will be restored. Default is 24 hrs.",
|
||||||
|
|||||||
@@ -1683,7 +1683,9 @@ var commandHelp = []fs.CommandHelp{{
|
|||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend addurl pikpak:dirpath url
|
rclone backend addurl pikpak:dirpath url
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
Downloads will be stored in 'dirpath'. If 'dirpath' is invalid,
|
Downloads will be stored in 'dirpath'. If 'dirpath' is invalid,
|
||||||
download will fallback to default 'My Pack' folder.
|
download will fallback to default 'My Pack' folder.
|
||||||
@@ -1695,8 +1697,10 @@ download will fallback to default 'My Pack' folder.
|
|||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend decompress pikpak:dirpath {filename} -o password=password
|
rclone backend decompress pikpak:dirpath {filename} -o password=password
|
||||||
rclone backend decompress pikpak:dirpath {filename} -o delete-src-file
|
rclone backend decompress pikpak:dirpath {filename} -o delete-src-file
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
An optional argument 'filename' can be specified for a file located in
|
An optional argument 'filename' can be specified for a file located in
|
||||||
'pikpak:dirpath'. You may want to pass '-o password=password' for a
|
'pikpak:dirpath'. You may want to pass '-o password=password' for a
|
||||||
@@ -1705,11 +1709,13 @@ source files after decompression finished.
|
|||||||
|
|
||||||
Result:
|
Result:
|
||||||
|
|
||||||
|
` + "```json" + `
|
||||||
{
|
{
|
||||||
"Decompressed": 17,
|
"Decompressed": 17,
|
||||||
"SourceDeleted": 0,
|
"SourceDeleted": 0,
|
||||||
"Errors": 0
|
"Errors": 0
|
||||||
}
|
}
|
||||||
|
` + "```" + `
|
||||||
`,
|
`,
|
||||||
}}
|
}}
|
||||||
|
|
||||||
|
|||||||
@@ -2908,23 +2908,30 @@ or from INTELLIGENT-TIERING Archive Access / Deep Archive Access tier to the Fre
|
|||||||
|
|
||||||
Usage Examples:
|
Usage Examples:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend restore s3:bucket/path/to/ --include /object -o priority=PRIORITY -o lifetime=DAYS
|
rclone backend restore s3:bucket/path/to/ --include /object -o priority=PRIORITY -o lifetime=DAYS
|
||||||
rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY -o lifetime=DAYS
|
rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY -o lifetime=DAYS
|
||||||
rclone backend restore s3:bucket -o priority=PRIORITY -o lifetime=DAYS
|
rclone backend restore s3:bucket -o priority=PRIORITY -o lifetime=DAYS
|
||||||
rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY
|
rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
This flag also obeys the filters. Test first with --interactive/-i or --dry-run flags
|
This flag also obeys the filters. Test first with --interactive/-i or --dry-run flags
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone --interactive backend restore --include "*.txt" s3:bucket/path -o priority=Standard -o lifetime=1
|
rclone --interactive backend restore --include "*.txt" s3:bucket/path -o priority=Standard -o lifetime=1
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
All the objects shown will be marked for restore, then
|
All the objects shown will be marked for restore, then
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend restore --include "*.txt" s3:bucket/path -o priority=Standard -o lifetime=1
|
rclone backend restore --include "*.txt" s3:bucket/path -o priority=Standard -o lifetime=1
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
It returns a list of status dictionaries with Remote and Status
|
It returns a list of status dictionaries with Remote and Status
|
||||||
keys. The Status will be OK if it was successful or an error message
|
keys. The Status will be OK if it was successful or an error message
|
||||||
if not.
|
if not.
|
||||||
|
|
||||||
|
` + "```json" + `
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"Status": "OK",
|
"Status": "OK",
|
||||||
@@ -2935,7 +2942,7 @@ if not.
|
|||||||
"Remote": "test/file4.txt"
|
"Remote": "test/file4.txt"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
` + "```" + `
|
||||||
`,
|
`,
|
||||||
Opts: map[string]string{
|
Opts: map[string]string{
|
||||||
"priority": "Priority of restore: Standard|Expedited|Bulk",
|
"priority": "Priority of restore: Standard|Expedited|Bulk",
|
||||||
@@ -2950,14 +2957,17 @@ or from INTELLIGENT-TIERING Archive Access / Deep Archive Access tier to the Fre
|
|||||||
|
|
||||||
Usage Examples:
|
Usage Examples:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend restore-status s3:bucket/path/to/object
|
rclone backend restore-status s3:bucket/path/to/object
|
||||||
rclone backend restore-status s3:bucket/path/to/directory
|
rclone backend restore-status s3:bucket/path/to/directory
|
||||||
rclone backend restore-status -o all s3:bucket/path/to/directory
|
rclone backend restore-status -o all s3:bucket/path/to/directory
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
This command does not obey the filters.
|
This command does not obey the filters.
|
||||||
|
|
||||||
It returns a list of status dictionaries.
|
It returns a list of status dictionaries.
|
||||||
|
|
||||||
|
` + "```json" + `
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"Remote": "file.txt",
|
"Remote": "file.txt",
|
||||||
@@ -2987,6 +2997,7 @@ It returns a list of status dictionaries.
|
|||||||
"StorageClass": "INTELLIGENT_TIERING"
|
"StorageClass": "INTELLIGENT_TIERING"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
` + "```" + `
|
||||||
`,
|
`,
|
||||||
Opts: map[string]string{
|
Opts: map[string]string{
|
||||||
"all": "if set then show all objects, not just ones with restore status",
|
"all": "if set then show all objects, not just ones with restore status",
|
||||||
@@ -2996,7 +3007,11 @@ It returns a list of status dictionaries.
|
|||||||
Short: "List the unfinished multipart uploads.",
|
Short: "List the unfinished multipart uploads.",
|
||||||
Long: `This command lists the unfinished multipart uploads in JSON format.
|
Long: `This command lists the unfinished multipart uploads in JSON format.
|
||||||
|
|
||||||
|
Usage Examples:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend list-multipart s3:bucket/path/to/object
|
rclone backend list-multipart s3:bucket/path/to/object
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
It returns a dictionary of buckets with values as lists of unfinished
|
It returns a dictionary of buckets with values as lists of unfinished
|
||||||
multipart uploads.
|
multipart uploads.
|
||||||
@@ -3004,6 +3019,7 @@ multipart uploads.
|
|||||||
You can call it with no bucket in which case it lists all bucket, with
|
You can call it with no bucket in which case it lists all bucket, with
|
||||||
a bucket or with a bucket and path.
|
a bucket or with a bucket and path.
|
||||||
|
|
||||||
|
` + "```json" + `
|
||||||
{
|
{
|
||||||
"rclone": [
|
"rclone": [
|
||||||
{
|
{
|
||||||
@@ -3024,7 +3040,7 @@ a bucket or with a bucket and path.
|
|||||||
"rclone-1000files": [],
|
"rclone-1000files": [],
|
||||||
"rclone-dst": []
|
"rclone-dst": []
|
||||||
}
|
}
|
||||||
|
` + "```" + `
|
||||||
`,
|
`,
|
||||||
}, {
|
}, {
|
||||||
Name: "cleanup",
|
Name: "cleanup",
|
||||||
@@ -3035,8 +3051,12 @@ max-age which defaults to 24 hours.
|
|||||||
Note that you can use --interactive/-i or --dry-run with this command to see what
|
Note that you can use --interactive/-i or --dry-run with this command to see what
|
||||||
it would do.
|
it would do.
|
||||||
|
|
||||||
|
Usage Examples:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend cleanup s3:bucket/path/to/object
|
rclone backend cleanup s3:bucket/path/to/object
|
||||||
rclone backend cleanup -o max-age=7w s3:bucket/path/to/object
|
rclone backend cleanup -o max-age=7w s3:bucket/path/to/object
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc.
|
Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc.
|
||||||
`,
|
`,
|
||||||
@@ -3052,7 +3072,11 @@ on a versions enabled bucket.
|
|||||||
Note that you can use --interactive/-i or --dry-run with this command to see what
|
Note that you can use --interactive/-i or --dry-run with this command to see what
|
||||||
it would do.
|
it would do.
|
||||||
|
|
||||||
|
Usage Examples:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend cleanup-hidden s3:bucket/path/to/dir
|
rclone backend cleanup-hidden s3:bucket/path/to/dir
|
||||||
|
` + "```" + `
|
||||||
`,
|
`,
|
||||||
}, {
|
}, {
|
||||||
Name: "versioning",
|
Name: "versioning",
|
||||||
@@ -3061,9 +3085,13 @@ it would do.
|
|||||||
passed and then returns the current versioning status for the bucket
|
passed and then returns the current versioning status for the bucket
|
||||||
supplied.
|
supplied.
|
||||||
|
|
||||||
|
Usage Examples:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend versioning s3:bucket # read status only
|
rclone backend versioning s3:bucket # read status only
|
||||||
rclone backend versioning s3:bucket Enabled
|
rclone backend versioning s3:bucket Enabled
|
||||||
rclone backend versioning s3:bucket Suspended
|
rclone backend versioning s3:bucket Suspended
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
It may return "Enabled", "Suspended" or "Unversioned". Note that once versioning
|
It may return "Enabled", "Suspended" or "Unversioned". Note that once versioning
|
||||||
has been enabled the status can't be set back to "Unversioned".
|
has been enabled the status can't be set back to "Unversioned".
|
||||||
@@ -3076,9 +3104,11 @@ for a running s3 backend.
|
|||||||
|
|
||||||
Usage Examples:
|
Usage Examples:
|
||||||
|
|
||||||
|
` + "```console" + `
|
||||||
rclone backend set s3: [-o opt_name=opt_value] [-o opt_name2=opt_value2]
|
rclone backend set s3: [-o opt_name=opt_value] [-o opt_name2=opt_value2]
|
||||||
rclone rc backend/command command=set fs=s3: [-o opt_name=opt_value] [-o opt_name2=opt_value2]
|
rclone rc backend/command command=set fs=s3: [-o opt_name=opt_value] [-o opt_name2=opt_value2]
|
||||||
rclone rc backend/command command=set fs=s3: -o session_token=X -o access_key_id=X -o secret_access_key=X
|
rclone rc backend/command command=set fs=s3: -o session_token=X -o access_key_id=X -o secret_access_key=X
|
||||||
|
` + "```" + `
|
||||||
|
|
||||||
The option keys are named as they are in the config file.
|
The option keys are named as they are in the config file.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user