jgaunt/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2025-12-06 00:03:32 +00:00
Code Issues Projects Releases Wiki Activity

docs: improve description of option types

Browse Source
This commit is contained in:
albertony
2025-01-17 14:20:57 +01:00
parent aa4aead63c
commit 6b2cd7c631
3 changed files with 42 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
backend/s3/s3.go
View File

@@ -2635,7 +2635,7 @@ The parameter should be a date, "2006-01-02", datetime "2006-01-02
Note that when using this no file write operations are permitted, Note that when using this no file write operations are permitted,
so you can't upload files or delete them. so you can't upload files or delete them.
See [the time option docs](/docs/#time-option) for valid formats. See [the time option docs](/docs/#time-options) for valid formats.
`, `,
Default: fs.Time{}, Default: fs.Time{},
Advanced: true, Advanced: true,

57
docs/content/docs.md
View File

@@ -609,7 +609,8 @@ way of reading those already.
Options Options
------- -------
Rclone has a number of options to control its behaviour. Rclone has a number of options to control its behaviour. These are
documented below, and in the [flags](/flags) page.
Options that take parameters can have the values passed in two ways, Options that take parameters can have the values passed in two ways,
`--option=value` or `--option value`. However boolean (true/false) `--option=value` or `--option value`. However boolean (true/false)
@@ -631,15 +632,33 @@ although some may also have different parameters such as `DumpFlags`
or just `string` and the help text explains that this will be or just `string` and the help text explains that this will be
interpreted as a list. interpreted as a list.
### Time or duration options {#time-option} Floating-point values with fractional part must use period (`.`)
as decimal separator, common in English-speaking countries, regardless
of your configured system locale. Parameter type `float` accepts decimal
and hexadecimal floating-point numbers as defined by the Go syntax for
[floating-point literals](https://go.dev/ref/spec#Floating-point_literals).
Options that take a `Duration` can be specified as a duration string ### Time and duration options {#time-options}
or a time string.
A duration string is a possibly signed sequence of decimal numbers, Options that take a `Time` or `Duration` parameter must be specified
each with optional fraction and a unit suffix, such as "300ms", as a formatted string describing an absolute or relative time. Note
"-1.5h" or "2h45m". Default units are seconds or the following that both `Time` and `Duration` parameter types can be expressed as
abbreviations are valid: either absolute or relative time, just with different interpretations,
e.g. a relative time will be treated as an offset from the current time
when passed as a `Time` value.
An absolute time can be specified as a string in one of 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)
A relative time is a string with a, possibly signed, sequence of decimal
numbers, each with optional fraction, and each with a unit suffix. If
the string only contains a single number, then the unit suffix is optional
and will default to seconds, i.e. a plain decimal value will be treated
as a number of seconds. The following suffixes are valid:
* `ms` - Milliseconds * `ms` - Milliseconds
* `s` - Seconds * `s` - Seconds
@@ -650,21 +669,19 @@ abbreviations are valid:
* `M` - Months * `M` - Months
* `y` - Years * `y` - Years
These can also be specified as an absolute time in the following Examples: "10", "300ms", "-1.5h" or "2h45m".
formats:
- RFC3339 - e.g. `2006-01-02T15:04:05Z` or `2006-01-02T15:04:05+07:00` ### Size options
- 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 that take a SizeSuffix parameter can be specified as an
integer value, which will then be assumed to represent a KiB
Options which use SizeSuffix use KiB (multiples of 1024 bytes) by default. value (multiples of 1024 bytes) by default. The interpretation
However, a suffix of `B` for Byte, `K` for KiB, `M` for MiB, can be changed by appending a suffix: `B` for Byte, `K` for KiB,
`G` for GiB, `T` for TiB and `P` for PiB may be used. These are `M` for MiB, `G` for GiB, `T` for TiB and `P` for PiB. These are
the binary units, e.g. 1, 2\*\*10, 2\*\*20, 2\*\*30 respectively. the binary units, e.g. 1, 2\*\*10, 2\*\*20, 2\*\*30 respectively.
See also [--human-readable](#human-readable).
### --backup-dir ### --backup-dir
When using `sync`, `copy` or `move` any files which would have been When using `sync`, `copy` or `move` any files which would have been
@@ -1080,7 +1097,7 @@ If a file or directory does have a modification time rclone can read
then rclone will display this fixed time instead. then rclone will display this fixed time instead.
The default is `2000-01-01 00:00:00 UTC`. This can be configured in The default is `2000-01-01 00:00:00 UTC`. This can be configured in
any of the ways shown in [the time or duration options](#time-option). any of the ways shown in [time options](#time-options).
For example `--default-time 2020-06-01` to set the default time to the For example `--default-time 2020-06-01` to set the default time to the
1st of June 2020 or `--default-time 0s` to set the default time to the 1st of June 2020 or `--default-time 0s` to set the default time to the

8
docs/content/filtering.md
View File

@@ -683,7 +683,7 @@ Default units are `KiB` but abbreviations `B`, `K`, `M`, `G`, `T` or `P` are val
E.g. `rclone ls remote: --min-size 50k` lists files on `remote:` of 50 KiB E.g. `rclone ls remote: --min-size 50k` lists files on `remote:` of 50 KiB
size or larger. size or larger.
See [the size option docs](/docs/#size-option) for more info. See [the size option docs](/docs/#size-options) for more info.
### `--max-size` - Don't transfer any file larger than this ### `--max-size` - Don't transfer any file larger than this
@@ -693,7 +693,7 @@ Default units are `KiB` but abbreviations `B`, `K`, `M`, `G`, `T` or `P` are val
E.g. `rclone ls remote: --max-size 1G` lists files on `remote:` of 1 GiB E.g. `rclone ls remote: --max-size 1G` lists files on `remote:` of 1 GiB
size or smaller. size or smaller.
See [the size option docs](/docs/#size-option) for more info. See [the size option docs](/docs/#size-options) for more info.
### `--max-age` - Don't transfer any file older than this ### `--max-age` - Don't transfer any file older than this
@@ -704,7 +704,7 @@ Controls the maximum age of files within the scope of an rclone command.
E.g. `rclone ls remote: --max-age 2d` lists files on `remote:` of 2 days E.g. `rclone ls remote: --max-age 2d` lists files on `remote:` of 2 days
old or less. old or less.
See [the time option docs](/docs/#time-option) for valid formats. See [the time option docs](/docs/#time-options) for valid formats.
### `--min-age` - Don't transfer any file younger than this ### `--min-age` - Don't transfer any file younger than this
@@ -716,7 +716,7 @@ 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 E.g. `rclone ls remote: --min-age 2d` lists files on `remote:` of 2 days
old or more. old or more.
See [the time option docs](/docs/#time-option) for valid formats. See [the time option docs](/docs/#time-options) for valid formats.
### `--hash-filter` - Deterministically select a subset of files {#hash-filter} ### `--hash-filter` - Deterministically select a subset of files {#hash-filter}