From 19a8b66ceee2ef681a64159e950e7097a453a55a Mon Sep 17 00:00:00 2001
From: edwardxml <56691903+edwardxml@users.noreply.github.com>
Date: Fri, 27 Nov 2020 14:08:52 +0000
Subject: [PATCH] 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)
---
 cmd/about/about.go                 | 23 +++++++++++++----------
 docs/README.md                     |  2 +-
 docs/content/amazonclouddrive.md   |  9 +++++++++
 docs/content/azureblob.md          |  9 ++++++++-
 docs/content/b2.md                 | 10 ++++++++++
 docs/content/box.md                |  9 +++++++++
 docs/content/fichier.md            | 10 ++++++++++
 docs/content/ftp.md                |  6 ++++--
 docs/content/googlecloudstorage.md | 10 ++++++++++
 docs/content/googlephotos.md       |  8 ++++++++
 docs/content/http.md               | 10 ++++++++++
 docs/content/opendrive.md          |  9 +++++++++
 docs/content/overview.md           |  2 ++
 docs/content/qingstor.md           | 10 ++++++++++
 docs/content/s3.md                 | 13 ++++++++++++-
 docs/content/sharefile.md          | 10 ++++++++++
 docs/content/sugarsync.md          | 10 ++++++++++
 docs/content/tardigrade.md         | 10 ++++++++++
 18 files changed, 155 insertions(+), 15 deletions(-)

diff --git a/cmd/about/about.go b/cmd/about/about.go
index 9b5d83df9..d06c8d599 100644
--- a/cmd/about/about.go
+++ b/cmd/about/about.go
@@ -44,10 +44,10 @@ var commandDefinition = &cobra.Command{
 	Use:   "about remote:",
 	Short: `Get quota information from the remote.`,
 	Long: `
-Get quota information from the remote, like bytes used/free/quota and bytes
-used in the trash. Not supported by all remotes.
+` + "`rclone about`" + `prints quota information about a remote to standard
+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
     Used:    7.444G
@@ -59,16 +59,15 @@ Where the fields are:
 
   * Total: total size available.
   * Used: total size used
-  * Free: total amount this user could upload.
-  * Trashed: total amount in the trash
+  * Free: total space available to this user.
+  * Trashed: total space used by trash
   * Other: total amount in other storage (e.g. Gmail, Google Photos)
   * Objects: total number of objects in the storage
 
-Note that not all the backends provide all the fields - they will be
-missing if they are not known for that backend.  Where it is known
-that the value is unlimited the value will also be omitted.
+Not all backends print all fields. Information is not included if it is not
+provided by a backend. Where the value is unlimited it is 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
     Used:    7993453766
@@ -76,7 +75,7 @@ Use the --full flag to see the numbers written out in full, e.g.
     Trashed: 104857602
     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,
@@ -85,6 +84,10 @@ Use the --json flag for a computer readable output, e.g.
         "other": 8849156022,
         "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) {
 		cmd.CheckArgs(1, 1, command, args)
diff --git a/docs/README.md b/docs/README.md
index e5b1c3561..a82f8529e 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,6 +1,6 @@
 # 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.
 
 See the `content` directory for the docs in markdown format.
diff --git a/docs/content/amazonclouddrive.md b/docs/content/amazonclouddrive.md
index 73e0d7a0c..a16175408 100644
--- a/docs/content/amazonclouddrive.md
+++ b/docs/content/amazonclouddrive.md
@@ -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
 the maximum size of uploaded files. Note that `--max-size` does not split
 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/)
+
diff --git a/docs/content/azureblob.md b/docs/content/azureblob.md
index ddc590f5e..c4d174995 100644
--- a/docs/content/azureblob.md
+++ b/docs/content/azureblob.md
@@ -327,12 +327,19 @@ See: the [encoding section in the overview](/overview/#encoding) for more info.
 - Default:     Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8
 
 {{< rem autogenerated options stop >}}
-
 ### Limitations ###
 
 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.
 
+`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 ###
 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
diff --git a/docs/content/b2.md b/docs/content/b2.md
index 82e113d9a..3d6703f72 100644
--- a/docs/content/b2.md
+++ b/docs/content/b2.md
@@ -513,4 +513,14 @@ See: the [encoding section in the overview](/overview/#encoding) for more info.
 - Default:     Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
 
 {{< 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/)
+
 
diff --git a/docs/content/box.md b/docs/content/box.md
index 237c88c62..a1d7710b3 100644
--- a/docs/content/box.md
+++ b/docs/content/box.md
@@ -408,3 +408,12 @@ and from an identical looking unicode equivalent `＼` (U+FF3C Fullwidth
 Reverse Solidus).
 
 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/)
+
diff --git a/docs/content/fichier.md b/docs/content/fichier.md
index fa789e504..d2a2dc8f0 100644
--- a/docs/content/fichier.md
+++ b/docs/content/fichier.md
@@ -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
 
 {{< 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/)
+
diff --git a/docs/content/ftp.md b/docs/content/ftp.md
index b80da56d5..1f8444b66 100644
--- a/docs/content/ftp.md
+++ b/docs/content/ftp.md
@@ -229,7 +229,6 @@ See: the [encoding section in the overview](/overview/#encoding) for more info.
 
 ### Limitations ###
 
-
 Modified times are not supported. Times you see on the FTP server
 through rclone are time of upload.
 
@@ -239,7 +238,10 @@ file sizes.
 `rclone about` is not supported by the FTP 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. [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`,
 `--dump bodies`, `--dump auth` for debugging isn't the same as
diff --git a/docs/content/googlecloudstorage.md b/docs/content/googlecloudstorage.md
index 2db32ef15..449036199 100644
--- a/docs/content/googlecloudstorage.md
+++ b/docs/content/googlecloudstorage.md
@@ -509,3 +509,13 @@ See: the [encoding section in the overview](/overview/#encoding) for more info.
 - Default:     Slash,CrLf,InvalidUtf8,Dot
 
 {{< 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/)
+
diff --git a/docs/content/googlephotos.md b/docs/content/googlephotos.md
index 452f10122..158520adc 100644
--- a/docs/content/googlephotos.md
+++ b/docs/content/googlephotos.md
@@ -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
 **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
 
 When Images are downloaded this strips EXIF location (according to the
diff --git a/docs/content/http.md b/docs/content/http.md
index 823474b76..79aedd7b5 100644
--- a/docs/content/http.md
+++ b/docs/content/http.md
@@ -186,3 +186,13 @@ If you set this option, rclone will not do the HEAD request.  This will mean
 - Default:     false
 
 {{< 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/)
+
diff --git a/docs/content/opendrive.md b/docs/content/opendrive.md
index 1e0a406b5..9da9a6fae 100644
--- a/docs/content/opendrive.md
+++ b/docs/content/opendrive.md
@@ -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 `?`
 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/)
+
+
diff --git a/docs/content/overview.md b/docs/content/overview.md
index 9cffb8cf6..da42b6426 100644
--- a/docs/content/overview.md
+++ b/docs/content/overview.md
@@ -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 union remote.
 
+See [rclone about command](https://rclone.org/commands/rclone_about/)
+
 ### EmptyDir ###
 
 The remote supports empty directories. See [Limitations](/bugs/#limitations)
diff --git a/docs/content/qingstor.md b/docs/content/qingstor.md
index 794c539be..b1bb4b42e 100644
--- a/docs/content/qingstor.md
+++ b/docs/content/qingstor.md
@@ -283,3 +283,13 @@ See: the [encoding section in the overview](/overview/#encoding) for more info.
 - Default:     Slash,Ctl,InvalidUtf8
 
 {{< 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/)
+
diff --git a/docs/content/s3.md b/docs/content/s3.md
index 0312195cd..37b4fa1fb 100644
--- a/docs/content/s3.md
+++ b/docs/content/s3.md
@@ -2430,8 +2430,19 @@ Name                 Type
 cos                  s3
 ```
 
-### Netease NOS  ###
+### Netease NOS
 
 For Netease NOS configure as per the configurator `rclone config`
 setting the provider `Netease`.  This will automatically set
 `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/)
+
diff --git a/docs/content/sharefile.md b/docs/content/sharefile.md
index a24ee5525..cdf499be5 100644
--- a/docs/content/sharefile.md
+++ b/docs/content/sharefile.md
@@ -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
 
 {{< 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/)
+
diff --git a/docs/content/sugarsync.md b/docs/content/sugarsync.md
index 82a629639..b68b0bea9 100644
--- a/docs/content/sugarsync.md
+++ b/docs/content/sugarsync.md
@@ -249,3 +249,13 @@ See: the [encoding section in the overview](/overview/#encoding) for more info.
 - Default:     Slash,Ctl,InvalidUtf8,Dot
 
 {{< 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/)
+
diff --git a/docs/content/tardigrade.md b/docs/content/tardigrade.md
index 464f9402d..ca448b0d2 100644
--- a/docs/content/tardigrade.md
+++ b/docs/content/tardigrade.md
@@ -300,3 +300,13 @@ Encryption Passphrase. To access existing objects enter passphrase used for uplo
 - Default:     ""
 
 {{< 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/)
+