From fa49971d4982497f36280ff3cdb8fe9195285a75 Mon Sep 17 00:00:00 2001 From: Nick Craig-Wood Date: Tue, 26 Jul 2022 17:53:35 +0100 Subject: [PATCH] docs: move time/duration option docs to the main docs --- docs/content/docs.md | 32 ++++++++++++++++++++++++++++---- docs/content/filtering.md | 26 ++++++++------------------ 2 files changed, 36 insertions(+), 22 deletions(-) diff --git a/docs/content/docs.md b/docs/content/docs.md index ed5894726..c031a94be 100644 --- a/docs/content/docs.md +++ b/docs/content/docs.md @@ -560,10 +560,34 @@ it to `false`. It is also possible to specify `--boolean=false` or parsed as `--boolean` and the `false` is parsed as an extra command line argument for rclone. -Options which use TIME use the go time parser. A duration string is a -possibly signed sequence of decimal numbers, each with optional -fraction and a unit suffix, such as "300ms", "-1.5h" or "2h45m". Valid -time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". +### Time or duration options {#time-option} + +TIME or DURATION options can be specified as a duration string or a +time string. + +A duration string is a possibly signed sequence of decimal numbers, +each with optional fraction and a unit suffix, such as "300ms", +"-1.5h" or "2h45m". Default units are seconds or the following +abbreviations are valid: + + * `ms` - Milliseconds + * `s` - Seconds + * `m` - Minutes + * `h` - Hours + * `d` - Days + * `w` - Weeks + * `M` - Months + * `y` - Years + +These can also be specified as an absolute time in the following +formats: + +- RFC3339 - e.g. `2006-01-02T15:04:05Z` or `2006-01-02T15:04:05+07:00` +- ISO8601 Date and time, local timezone - `2006-01-02T15:04:05` +- ISO8601 Date and time, local timezone - `2006-01-02 15:04:05` +- ISO8601 Date - `2006-01-02` (YYYY-MM-DD) + +### Size options {#size-option} Options which use SIZE use KiB (multiples of 1024 bytes) by default. However, a suffix of `B` for Byte, `K` for KiB, `M` for MiB, diff --git a/docs/content/filtering.md b/docs/content/filtering.md index 8fc3bf109..0b7d3d99c 100644 --- a/docs/content/filtering.md +++ b/docs/content/filtering.md @@ -677,6 +677,8 @@ Default units are `KiB` but abbreviations `K`, `M`, `G`, `T` or `P` are valid. E.g. `rclone ls remote: --min-size 50k` lists files on `remote:` of 50 KiB size or larger. +See [the size option docs](/docs/#size-option) for more info. + ### `--max-size` - Don't transfer any file larger than this Controls the maximum size file within the scope of an rclone command. @@ -685,33 +687,19 @@ Default units are `KiB` but abbreviations `K`, `M`, `G`, `T` or `P` are valid. E.g. `rclone ls remote: --max-size 1G` lists files on `remote:` of 1 GiB size or smaller. +See [the size option docs](/docs/#size-option) for more info. + ### `--max-age` - Don't transfer any file older than this Controls the maximum age of files within the scope of an rclone command. -Default units are seconds or the following abbreviations are valid: - - * `ms` - Milliseconds - * `s` - Seconds - * `m` - Minutes - * `h` - Hours - * `d` - Days - * `w` - Weeks - * `M` - Months - * `y` - Years - -`--max-age` can also be specified as an absolute time in the following -formats: - -- RFC3339 - e.g. `2006-01-02T15:04:05Z` or `2006-01-02T15:04:05+07:00` -- ISO8601 Date and time, local timezone - `2006-01-02T15:04:05` -- ISO8601 Date and time, local timezone - `2006-01-02 15:04:05` -- ISO8601 Date - `2006-01-02` (YYYY-MM-DD) `--max-age` applies only to files and not to directories. E.g. `rclone ls remote: --max-age 2d` lists files on `remote:` of 2 days old or less. +See [the time option docs](/docs/#time-option) for valid formats. + ### `--min-age` - Don't transfer any file younger than this Controls the minimum age of files within the scope of an rclone command. @@ -722,6 +710,8 @@ Controls the minimum age of files within the scope of an rclone command. E.g. `rclone ls remote: --min-age 2d` lists files on `remote:` of 2 days old or more. +See [the time option docs](/docs/#time-option) for valid formats. + ## Other flags ### `--delete-excluded` - Delete files on dest excluded from sync