From d77736c21a12e99f455d66fe07ade25e7eb74bef Mon Sep 17 00:00:00 2001
From: albertony <12441419+albertony@users.noreply.github.com>
Date: Sun, 10 Apr 2022 13:21:12 +0200
Subject: [PATCH] docs/size: extend documentation of size command
---
cmd/size/size.go | 19 +++++++++++++++++++
docs/content/rc.md | 1 +
2 files changed, 20 insertions(+)
diff --git a/cmd/size/size.go b/cmd/size/size.go
index 1d9cf625b..5ed51c7a6 100644
--- a/cmd/size/size.go
+++ b/cmd/size/size.go
@@ -24,6 +24,25 @@ func init() {
var commandDefinition = &cobra.Command{
Use: "size remote:path",
Short: `Prints the total size and number of objects in remote:path.`,
+ Long: `
+Counts objects in the path and calculates the total size. Prints the
+result to standard output.
+
+By default the output is in human-readable format, but shows values in
+both human-readable format as well as the raw numbers (global option
+` + "`--human-readable`" + ` is not considered). Use option ` + "`--json`" + `
+to format output as JSON instead.
+
+Recurses by default, use ` + "`--max-depth 1`" + ` to stop the
+recursion.
+
+Some backends do not always provide file sizes, see for example
+[Google Photos](/googlephotos/#size) and
+[Google Drive](/drive/#limitations-of-google-docs).
+Rclone will then show a notice in the log indicating how many such
+files were encountered, and count them in as empty files in the output
+of the size command.
+`,
Run: func(command *cobra.Command, args []string) {
cmd.CheckArgs(1, 1, command, args)
fsrc := cmd.NewFsSrc(args)
diff --git a/docs/content/rc.md b/docs/content/rc.md
index 49162e897..769b1de26 100644
--- a/docs/content/rc.md
+++ b/docs/content/rc.md
@@ -1285,6 +1285,7 @@ Returns:
- count - number of files
- bytes - number of bytes in those files
+- sizeless - number of files with unknown size, included in count but not accounted for in bytes
See the [size command](/commands/rclone_size/) command for more information on the above.