1
mirror of https://github.com/rclone/rclone synced 2024-12-23 14:23:44 +01:00

docs/size: extend documentation of size command

This commit is contained in:
albertony 2022-04-10 13:21:12 +02:00
parent 86bd5f6922
commit d77736c21a
2 changed files with 20 additions and 0 deletions

View File

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

View File

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