mirror of
https://github.com/rclone/rclone.git
synced 2025-11-23 21:44:49 +02:00
docs: fix markdownlint issues and other styling improvements in backend command docs
This commit is contained in:
albertony
@@ -2903,10 +2903,11 @@ 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.",
|
||||
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.
|
||||
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.
|
||||
|
||||
Usage Examples:
|
||||
Usage examples:
|
||||
|
||||
` + "```console" + `
|
||||
rclone backend restore s3:bucket/path/to/ --include /object -o priority=PRIORITY -o lifetime=DAYS
|
||||
@@ -2915,13 +2916,14 @@ rclone backend restore s3:bucket -o priority=PRIORITY -o lifetime=DAYS
|
||||
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
|
||||
` + "```" + `
|
||||
|
||||
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
|
||||
@@ -2942,20 +2944,21 @@ if not.
|
||||
"Remote": "test/file4.txt"
|
||||
}
|
||||
]
|
||||
` + "```" + `
|
||||
`,
|
||||
` + "```",
|
||||
Opts: map[string]string{
|
||||
"priority": "Priority of restore: Standard|Expedited|Bulk",
|
||||
"lifetime": "Lifetime of the active copy in days, ignored for INTELLIGENT-TIERING storage",
|
||||
"priority": "Priority of restore: Standard|Expedited|Bulk",
|
||||
"lifetime": `Lifetime of the active copy in days, ignored for INTELLIGENT-TIERING
|
||||
storage.`,
|
||||
"description": "The optional description for the job.",
|
||||
},
|
||||
}, {
|
||||
Name: "restore-status",
|
||||
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.
|
||||
Short: "Show the status for objects being restored from GLACIER or INTELLIGENT-TIERING.",
|
||||
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.
|
||||
|
||||
Usage Examples:
|
||||
Usage examples:
|
||||
|
||||
` + "```console" + `
|
||||
rclone backend restore-status s3:bucket/path/to/object
|
||||
@@ -2965,7 +2968,7 @@ rclone backend restore-status -o all s3:bucket/path/to/directory
|
||||
|
||||
This command does not obey the filters.
|
||||
|
||||
It returns a list of status dictionaries.
|
||||
It returns a list of status dictionaries:
|
||||
|
||||
` + "```json" + `
|
||||
[
|
||||
@@ -2997,17 +3000,16 @@ It returns a list of status dictionaries.
|
||||
"StorageClass": "INTELLIGENT_TIERING"
|
||||
}
|
||||
]
|
||||
` + "```" + `
|
||||
`,
|
||||
` + "```",
|
||||
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.",
|
||||
},
|
||||
}, {
|
||||
Name: "list-multipart-uploads",
|
||||
Short: "List the unfinished multipart uploads.",
|
||||
Long: `This command lists the unfinished multipart uploads in JSON format.
|
||||
|
||||
Usage Examples:
|
||||
Usage examples:
|
||||
|
||||
` + "```console" + `
|
||||
rclone backend list-multipart s3:bucket/path/to/object
|
||||
@@ -3040,28 +3042,26 @@ a bucket or with a bucket and path.
|
||||
"rclone-1000files": [],
|
||||
"rclone-dst": []
|
||||
}
|
||||
` + "```" + `
|
||||
`,
|
||||
` + "```",
|
||||
}, {
|
||||
Name: "cleanup",
|
||||
Short: "Remove unfinished multipart uploads.",
|
||||
Long: `This command removes unfinished multipart uploads of age greater than
|
||||
max-age which defaults to 24 hours.
|
||||
|
||||
Note that you can use --interactive/-i or --dry-run with this command to see what
|
||||
it would do.
|
||||
Note that you can use --interactive/-i or --dry-run with this command to see
|
||||
what it would do.
|
||||
|
||||
Usage Examples:
|
||||
Usage examples:
|
||||
|
||||
` + "```console" + `
|
||||
rclone backend cleanup 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.`,
|
||||
Opts: map[string]string{
|
||||
"max-age": "Max age of upload to delete",
|
||||
"max-age": "Max age of upload to delete.",
|
||||
},
|
||||
}, {
|
||||
Name: "cleanup-hidden",
|
||||
@@ -3069,15 +3069,14 @@ Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc.
|
||||
Long: `This command removes any old hidden versions of files
|
||||
on a versions enabled bucket.
|
||||
|
||||
Note that you can use --interactive/-i or --dry-run with this command to see what
|
||||
it would do.
|
||||
Note that you can use --interactive/-i or --dry-run with this command to see
|
||||
what it would do.
|
||||
|
||||
Usage Examples:
|
||||
Usage example:
|
||||
|
||||
` + "```console" + `
|
||||
rclone backend cleanup-hidden s3:bucket/path/to/dir
|
||||
` + "```" + `
|
||||
`,
|
||||
` + "```",
|
||||
}, {
|
||||
Name: "versioning",
|
||||
Short: "Set/get versioning support for a bucket.",
|
||||
@@ -3085,7 +3084,7 @@ rclone backend cleanup-hidden s3:bucket/path/to/dir
|
||||
passed and then returns the current versioning status for the bucket
|
||||
supplied.
|
||||
|
||||
Usage Examples:
|
||||
Usage examples:
|
||||
|
||||
` + "```console" + `
|
||||
rclone backend versioning s3:bucket # read status only
|
||||
@@ -3093,16 +3092,15 @@ rclone backend versioning s3:bucket Enabled
|
||||
rclone backend versioning s3:bucket Suspended
|
||||
` + "```" + `
|
||||
|
||||
It may return "Enabled", "Suspended" or "Unversioned". Note that once versioning
|
||||
has been enabled the status can't be set back to "Unversioned".
|
||||
`,
|
||||
It may return "Enabled", "Suspended" or "Unversioned". Note that once
|
||||
versioning has been enabled the status can't be set back to "Unversioned".`,
|
||||
}, {
|
||||
Name: "set",
|
||||
Short: "Set command for updating the config parameters.",
|
||||
Long: `This set command can be used to update the config parameters
|
||||
for a running s3 backend.
|
||||
|
||||
Usage Examples:
|
||||
Usage examples:
|
||||
|
||||
` + "```console" + `
|
||||
rclone backend set s3: [-o opt_name=opt_value] [-o opt_name2=opt_value2]
|
||||
@@ -3116,8 +3114,7 @@ This rebuilds the connection to the s3 backend when it is called with
|
||||
the new parameters. Only new parameters need be passed as the values
|
||||
will default to those currently in use.
|
||||
|
||||
It doesn't return anything.
|
||||
`,
|
||||
It doesn't return anything.`,
|
||||
}}
|
||||
|
||||
// Command the backend to run a named command
|
||||
|
||||
Reference in New Issue
Block a user