jgaunt/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2026-01-04 01:23:24 +00:00
Code Issues Projects Releases Wiki Activity

docs: update rclone about docs

Browse Source 
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:
edwardxml
2020-11-27 14:08:52 +00:00
committed by GitHub
parent 07dee18d6b
commit 19a8b66cee
18 changed files with 155 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
cmd/about/about.go
View File

@@ -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)