forked from TrueCloudLab/rclone
docs: update rclone about docs
Create a full loop of documentation for rclone about, backends overview and individual backend pages. Discussion: https://github.com/rclone/rclone/pull/4774 relates Previously pull was requested, in part, under ref https://github.com/rclone/rclone/pull/4801 Notes: Introduce a tentative draft see-link format the end of sections to try rather than lots of in-para links. Update about.go incl link to list of backends not supporting about. In list of backends not supporting about, include link to about command reference. I appreciate there may be decisions to make going forward about whether command links should be code formatted, and using proper pretty url links, but I have fudged that for now. Update backend pages that do not support about with wording used previously for ftp - it is in passive voice but I can live with it. (my own wording and fault). The note is applied to a limitations section. If one does not already exist it is created (even if there are other limitations with their own sections)
This commit is contained in:
parent
07dee18d6b
commit
19a8b66cee
18 changed files with 155 additions and 15 deletions
|
@ -44,10 +44,10 @@ var commandDefinition = &cobra.Command{
|
||||||
Use: "about remote:",
|
Use: "about remote:",
|
||||||
Short: `Get quota information from the remote.`,
|
Short: `Get quota information from the remote.`,
|
||||||
Long: `
|
Long: `
|
||||||
Get quota information from the remote, like bytes used/free/quota and bytes
|
` + "`rclone about`" + `prints quota information about a remote to standard
|
||||||
used in the trash. Not supported by all remotes.
|
output. The output is typically used, free, quota and trash contents.
|
||||||
|
|
||||||
This will print to stdout something like this:
|
E.g. Typical output from` + "`rclone about remote:`" + `is:
|
||||||
|
|
||||||
Total: 17G
|
Total: 17G
|
||||||
Used: 7.444G
|
Used: 7.444G
|
||||||
|
@ -59,16 +59,15 @@ Where the fields are:
|
||||||
|
|
||||||
* Total: total size available.
|
* Total: total size available.
|
||||||
* Used: total size used
|
* Used: total size used
|
||||||
* Free: total amount this user could upload.
|
* Free: total space available to this user.
|
||||||
* Trashed: total amount in the trash
|
* Trashed: total space used by trash
|
||||||
* Other: total amount in other storage (e.g. Gmail, Google Photos)
|
* Other: total amount in other storage (e.g. Gmail, Google Photos)
|
||||||
* Objects: total number of objects in the storage
|
* Objects: total number of objects in the storage
|
||||||
|
|
||||||
Note that not all the backends provide all the fields - they will be
|
Not all backends print all fields. Information is not included if it is not
|
||||||
missing if they are not known for that backend. Where it is known
|
provided by a backend. Where the value is unlimited it is omitted.
|
||||||
that the value is unlimited the value will also be omitted.
|
|
||||||
|
|
||||||
Use the --full flag to see the numbers written out in full, e.g.
|
Applying a ` + "`--full`" + ` flag to the command prints the bytes in full, e.g.
|
||||||
|
|
||||||
Total: 18253611008
|
Total: 18253611008
|
||||||
Used: 7993453766
|
Used: 7993453766
|
||||||
|
@ -76,7 +75,7 @@ Use the --full flag to see the numbers written out in full, e.g.
|
||||||
Trashed: 104857602
|
Trashed: 104857602
|
||||||
Other: 8849156022
|
Other: 8849156022
|
||||||
|
|
||||||
Use the --json flag for a computer readable output, e.g.
|
A ` + "`--json`" + `flag generates conveniently computer readable output, e.g.
|
||||||
|
|
||||||
{
|
{
|
||||||
"total": 18253611008,
|
"total": 18253611008,
|
||||||
|
@ -85,6 +84,10 @@ Use the --json flag for a computer readable output, e.g.
|
||||||
"other": 8849156022,
|
"other": 8849156022,
|
||||||
"free": 1411001220
|
"free": 1411001220
|
||||||
}
|
}
|
||||||
|
|
||||||
|
Not all backends support the ` + "`rclone about`" + ` command.
|
||||||
|
|
||||||
|
See [List of backends that do not support about](https://rclone.org/overview/#optional-features)
|
||||||
`,
|
`,
|
||||||
Run: func(command *cobra.Command, args []string) {
|
Run: func(command *cobra.Command, args []string) {
|
||||||
cmd.CheckArgs(1, 1, command, args)
|
cmd.CheckArgs(1, 1, command, args)
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Docs
|
# Docs
|
||||||
|
|
||||||
This directory tree is uses to build all the different docs for
|
This directory tree is used to build all the different docs for
|
||||||
rclone.
|
rclone.
|
||||||
|
|
||||||
See the `content` directory for the docs in markdown format.
|
See the `content` directory for the docs in markdown format.
|
||||||
|
|
|
@ -307,3 +307,12 @@ because of file size, so it will retry the operation, as any other
|
||||||
failure. To avoid this problem, use `--max-size 50000M` option to limit
|
failure. To avoid this problem, use `--max-size 50000M` option to limit
|
||||||
the maximum size of uploaded files. Note that `--max-size` does not split
|
the maximum size of uploaded files. Note that `--max-size` does not split
|
||||||
files into segments, it only ignores files over this size.
|
files into segments, it only ignores files over this size.
|
||||||
|
|
||||||
|
`rclone about` is not supported by the Amazon Drive backend. Backends without
|
||||||
|
this capability cannot determine free space for an rclone mount or
|
||||||
|
use policy `mfs` (most free space) as a member of an rclone union
|
||||||
|
remote.
|
||||||
|
|
||||||
|
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
|
||||||
|
See [rclone about](https://rclone.org/commands/rclone_about/)
|
||||||
|
|
||||||
|
|
|
@ -327,12 +327,19 @@ See: the [encoding section in the overview](/overview/#encoding) for more info.
|
||||||
- Default: Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8
|
- Default: Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
### Limitations ###
|
### Limitations ###
|
||||||
|
|
||||||
MD5 sums are only uploaded with chunked files if the source has an MD5
|
MD5 sums are only uploaded with chunked files if the source has an MD5
|
||||||
sum. This will always be the case for a local to azure copy.
|
sum. This will always be the case for a local to azure copy.
|
||||||
|
|
||||||
|
`rclone about` is not supported by the Microsoft Azure Blob storage backend. Backends without
|
||||||
|
this capability cannot determine free space for an rclone mount or
|
||||||
|
use policy `mfs` (most free space) as a member of an rclone union
|
||||||
|
remote.
|
||||||
|
|
||||||
|
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
|
||||||
|
See [rclone about](https://rclone.org/commands/rclone_about/)
|
||||||
|
|
||||||
### Azure Storage Emulator Support ###
|
### Azure Storage Emulator Support ###
|
||||||
You can test rclone with storage emulator locally, to do this make sure azure storage emulator
|
You can test rclone with storage emulator locally, to do this make sure azure storage emulator
|
||||||
installed locally and set up a new remote with `rclone config` follow instructions described in
|
installed locally and set up a new remote with `rclone config` follow instructions described in
|
||||||
|
|
|
@ -513,4 +513,14 @@ See: the [encoding section in the overview](/overview/#encoding) for more info.
|
||||||
- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
|
- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
### Limitations
|
||||||
|
|
||||||
|
`rclone about` is not supported by the B2 backend. Backends without
|
||||||
|
this capability cannot determine free space for an rclone mount or
|
||||||
|
use policy `mfs` (most free space) as a member of an rclone union
|
||||||
|
remote.
|
||||||
|
|
||||||
|
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
|
||||||
|
See [rclone about](https://rclone.org/commands/rclone_about/)
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -408,3 +408,12 @@ and from an identical looking unicode equivalent `\` (U+FF3C Fullwidth
|
||||||
Reverse Solidus).
|
Reverse Solidus).
|
||||||
|
|
||||||
Box only supports filenames up to 255 characters in length.
|
Box only supports filenames up to 255 characters in length.
|
||||||
|
|
||||||
|
`rclone about` is not supported by the Box backend. Backends without
|
||||||
|
this capability cannot determine free space for an rclone mount or
|
||||||
|
use policy `mfs` (most free space) as a member of an rclone union
|
||||||
|
remote.
|
||||||
|
|
||||||
|
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
|
||||||
|
See [rclone about](https://rclone.org/commands/rclone_about/)
|
||||||
|
|
||||||
|
|
|
@ -151,3 +151,13 @@ See: the [encoding section in the overview](/overview/#encoding) for more info.
|
||||||
- Default: Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot
|
- Default: Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
### Limitations
|
||||||
|
|
||||||
|
`rclone about` is not supported by the 1Fichier backend. Backends without
|
||||||
|
this capability cannot determine free space for an rclone mount or
|
||||||
|
use policy `mfs` (most free space) as a member of an rclone union
|
||||||
|
remote.
|
||||||
|
|
||||||
|
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
|
||||||
|
See [rclone about](https://rclone.org/commands/rclone_about/)
|
||||||
|
|
||||||
|
|
|
@ -229,7 +229,6 @@ See: the [encoding section in the overview](/overview/#encoding) for more info.
|
||||||
|
|
||||||
### Limitations ###
|
### Limitations ###
|
||||||
|
|
||||||
|
|
||||||
Modified times are not supported. Times you see on the FTP server
|
Modified times are not supported. Times you see on the FTP server
|
||||||
through rclone are time of upload.
|
through rclone are time of upload.
|
||||||
|
|
||||||
|
@ -239,7 +238,10 @@ file sizes.
|
||||||
`rclone about` is not supported by the FTP backend. Backends without
|
`rclone about` is not supported by the FTP backend. Backends without
|
||||||
this capability cannot determine free space for an rclone mount or
|
this capability cannot determine free space for an rclone mount or
|
||||||
use policy `mfs` (most free space) as a member of an rclone union
|
use policy `mfs` (most free space) as a member of an rclone union
|
||||||
remote. [More](https://rclone.org/overview/#optional-features)
|
remote.
|
||||||
|
|
||||||
|
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
|
||||||
|
See [rclone about](https://rclone.org/commands/rclone_about/)
|
||||||
|
|
||||||
The implementation of : `--dump headers`,
|
The implementation of : `--dump headers`,
|
||||||
`--dump bodies`, `--dump auth` for debugging isn't the same as
|
`--dump bodies`, `--dump auth` for debugging isn't the same as
|
||||||
|
|
|
@ -509,3 +509,13 @@ See: the [encoding section in the overview](/overview/#encoding) for more info.
|
||||||
- Default: Slash,CrLf,InvalidUtf8,Dot
|
- Default: Slash,CrLf,InvalidUtf8,Dot
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
### Limitations
|
||||||
|
|
||||||
|
`rclone about` is not supported by the Google Cloud Storage backend. Backends without
|
||||||
|
this capability cannot determine free space for an rclone mount or
|
||||||
|
use policy `mfs` (most free space) as a member of an rclone union
|
||||||
|
remote.
|
||||||
|
|
||||||
|
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
|
||||||
|
See [rclone about](https://rclone.org/commands/rclone_about/)
|
||||||
|
|
||||||
|
|
|
@ -234,6 +234,14 @@ are stored in full resolution at "original quality" and **will** count
|
||||||
towards your storage quota in your Google Account. The API does
|
towards your storage quota in your Google Account. The API does
|
||||||
**not** offer a way to upload in "high quality" mode..
|
**not** offer a way to upload in "high quality" mode..
|
||||||
|
|
||||||
|
`rclone about` is not supported by the Google Photos backend. Backends without
|
||||||
|
this capability cannot determine free space for an rclone mount or
|
||||||
|
use policy `mfs` (most free space) as a member of an rclone union
|
||||||
|
remote.
|
||||||
|
|
||||||
|
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
|
||||||
|
See [rclone about](https://rclone.org/commands/rclone_about/)
|
||||||
|
|
||||||
### Downloading Images
|
### Downloading Images
|
||||||
|
|
||||||
When Images are downloaded this strips EXIF location (according to the
|
When Images are downloaded this strips EXIF location (according to the
|
||||||
|
|
|
@ -186,3 +186,13 @@ If you set this option, rclone will not do the HEAD request. This will mean
|
||||||
- Default: false
|
- Default: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
### Limitations
|
||||||
|
|
||||||
|
`rclone about` is not supported by the HTTP backend. Backends without
|
||||||
|
this capability cannot determine free space for an rclone mount or
|
||||||
|
use policy `mfs` (most free space) as a member of an rclone union
|
||||||
|
remote.
|
||||||
|
|
||||||
|
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
|
||||||
|
See [rclone about](https://rclone.org/commands/rclone_about/)
|
||||||
|
|
||||||
|
|
|
@ -163,3 +163,12 @@ platforms they are common. Rclone will map these names to and from an
|
||||||
identical looking unicode equivalent. For example if a file has a `?`
|
identical looking unicode equivalent. For example if a file has a `?`
|
||||||
in it will be mapped to `?` instead.
|
in it will be mapped to `?` instead.
|
||||||
|
|
||||||
|
`rclone about` is not supported by the OpenDrive backend. Backends without
|
||||||
|
this capability cannot determine free space for an rclone mount or
|
||||||
|
use policy `mfs` (most free space) as a member of an rclone union
|
||||||
|
remote.
|
||||||
|
|
||||||
|
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
|
||||||
|
See [rclone about](https://rclone.org/commands/rclone_about/)
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -439,6 +439,8 @@ Backends without about capability cannot determine free space for an
|
||||||
rclone mount, or use policy `mfs` (most free space) as a member of an
|
rclone mount, or use policy `mfs` (most free space) as a member of an
|
||||||
rclone union remote.
|
rclone union remote.
|
||||||
|
|
||||||
|
See [rclone about command](https://rclone.org/commands/rclone_about/)
|
||||||
|
|
||||||
### EmptyDir ###
|
### EmptyDir ###
|
||||||
|
|
||||||
The remote supports empty directories. See [Limitations](/bugs/#limitations)
|
The remote supports empty directories. See [Limitations](/bugs/#limitations)
|
||||||
|
|
|
@ -283,3 +283,13 @@ See: the [encoding section in the overview](/overview/#encoding) for more info.
|
||||||
- Default: Slash,Ctl,InvalidUtf8
|
- Default: Slash,Ctl,InvalidUtf8
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
### Limitations
|
||||||
|
|
||||||
|
`rclone about` is not supported by the qingstor backend. Backends without
|
||||||
|
this capability cannot determine free space for an rclone mount or
|
||||||
|
use policy `mfs` (most free space) as a member of an rclone union
|
||||||
|
remote.
|
||||||
|
|
||||||
|
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
|
||||||
|
See [rclone about](https://rclone.org/commands/rclone_about/)
|
||||||
|
|
||||||
|
|
|
@ -2430,8 +2430,19 @@ Name Type
|
||||||
cos s3
|
cos s3
|
||||||
```
|
```
|
||||||
|
|
||||||
### Netease NOS ###
|
### Netease NOS
|
||||||
|
|
||||||
For Netease NOS configure as per the configurator `rclone config`
|
For Netease NOS configure as per the configurator `rclone config`
|
||||||
setting the provider `Netease`. This will automatically set
|
setting the provider `Netease`. This will automatically set
|
||||||
`force_path_style = false` which is necessary for it to run properly.
|
`force_path_style = false` which is necessary for it to run properly.
|
||||||
|
|
||||||
|
### Limitations
|
||||||
|
|
||||||
|
`rclone about` is not supported by the S3 backend. Backends without
|
||||||
|
this capability cannot determine free space for an rclone mount or
|
||||||
|
use policy `mfs` (most free space) as a member of an rclone union
|
||||||
|
remote.
|
||||||
|
|
||||||
|
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
|
||||||
|
See [rclone about](https://rclone.org/commands/rclone_about/)
|
||||||
|
|
||||||
|
|
|
@ -232,3 +232,13 @@ See: the [encoding section in the overview](/overview/#encoding) for more info.
|
||||||
- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot
|
- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
### Limitations
|
||||||
|
|
||||||
|
`rclone about` is not supported by the Citrix ShareFile backend. Backends without
|
||||||
|
this capability cannot determine free space for an rclone mount or
|
||||||
|
use policy `mfs` (most free space) as a member of an rclone union
|
||||||
|
remote.
|
||||||
|
|
||||||
|
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
|
||||||
|
See [rclone about](https://rclone.org/commands/rclone_about/)
|
||||||
|
|
||||||
|
|
|
@ -249,3 +249,13 @@ See: the [encoding section in the overview](/overview/#encoding) for more info.
|
||||||
- Default: Slash,Ctl,InvalidUtf8,Dot
|
- Default: Slash,Ctl,InvalidUtf8,Dot
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
### Limitations
|
||||||
|
|
||||||
|
`rclone about` is not supported by the SugarSync backend. Backends without
|
||||||
|
this capability cannot determine free space for an rclone mount or
|
||||||
|
use policy `mfs` (most free space) as a member of an rclone union
|
||||||
|
remote.
|
||||||
|
|
||||||
|
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
|
||||||
|
See [rclone about](https://rclone.org/commands/rclone_about/)
|
||||||
|
|
||||||
|
|
|
@ -300,3 +300,13 @@ Encryption Passphrase. To access existing objects enter passphrase used for uplo
|
||||||
- Default: ""
|
- Default: ""
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
### Limitations
|
||||||
|
|
||||||
|
`rclone about` is not supported by the rclone Tardigrade backend. Backends without
|
||||||
|
this capability cannot determine free space for an rclone mount or
|
||||||
|
use policy `mfs` (most free space) as a member of an rclone union
|
||||||
|
remote.
|
||||||
|
|
||||||
|
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
|
||||||
|
See [rclone about](https://rclone.org/commands/rclone_about/)
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue