jgaunt/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2025-12-16 08:13:29 +00:00
Code Issues Projects Releases Wiki Activity

docs: change use of parameter type SIZE to SizeSuffix consistent with flags and cli help

Browse Source
This commit is contained in:
albertony
2025-01-17 12:47:27 +01:00
parent 3cb1e65eb6
commit 865d4b2bda
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/content/docs.md
View File

@@ -660,7 +660,7 @@ formats:
### Size options {#size-option} ### Size options {#size-option}
Options which use SIZE use KiB (multiples of 1024 bytes) by default. Options which use SizeSuffix use KiB (multiples of 1024 bytes) by default.
However, a suffix of `B` for Byte, `K` for KiB, `M` for MiB, However, a suffix of `B` for Byte, `K` for KiB, `M` for MiB,
`G` for GiB, `T` for TiB and `P` for PiB may be used. These are `G` for GiB, `T` for TiB and `P` for PiB may be used. 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.
@@ -821,7 +821,7 @@ This can be used in conjunction with `--bwlimit`.
Note that if a schedule is provided the file will use the schedule in Note that if a schedule is provided the file will use the schedule in
effect at the start of the transfer. effect at the start of the transfer.
### --buffer-size=SIZE ### --buffer-size=SizeSuffix
Use this sized buffer to speed up file transfers. Each `--transfer` Use this sized buffer to speed up file transfers. Each `--transfer`
will use this much memory for buffering. will use this much memory for buffering.
@@ -1649,9 +1649,9 @@ of the remote which may be desirable.
Setting this to a negative number will make the backlog as large as Setting this to a negative number will make the backlog as large as
possible. possible.
### --max-buffer-memory=SIZE {#max-buffer-memory} ### --max-buffer-memory=SizeSuffix {#max-buffer-memory}
If set, don't allocate more than SIZE amount of memory as buffers. If If set, don't allocate more than given amount of memory as buffers. If
not set or set to `0` or `off` this will not limit the amount of memory not set or set to `0` or `off` this will not limit the amount of memory
in use. in use.
@@ -1699,7 +1699,7 @@ This tells rclone not to delete more than N files. If that limit is
exceeded then a fatal error will be generated and rclone will stop the exceeded then a fatal error will be generated and rclone will stop the
operation in progress. operation in progress.
### --max-delete-size=SIZE ### --max-delete-size=SizeSuffix
Rclone will stop deleting files when the total size of deletions has Rclone will stop deleting files when the total size of deletions has
reached the size specified. It defaults to off. reached the size specified. It defaults to off.
@@ -1736,7 +1736,7 @@ Use `--cutoff-mode` to modify this behaviour.
Rclone will exit with exit code 10 if the duration limit is reached. Rclone will exit with exit code 10 if the duration limit is reached.
### --max-transfer=SIZE ### --max-transfer=SizeSuffix
Rclone will stop transferring when it has reached the size specified. Rclone will stop transferring when it has reached the size specified.
Defaults to off. Defaults to off.
@@ -1896,10 +1896,10 @@ if you are reading and writing to an OS X filing system this will be
This command line flag allows you to override that computed default. This command line flag allows you to override that computed default.
### --multi-thread-write-buffer-size=SIZE ### --multi-thread-write-buffer-size=SizeSuffix
When transferring with multiple threads, rclone will buffer SIZE bytes When transferring with multiple threads, rclone will buffer the specified
in memory before writing to disk for each thread. number of bytes in memory before writing to disk for each thread.
This can improve performance if the underlying filesystem does not deal This can improve performance if the underlying filesystem does not deal
well with a lot of small writes in different positions of the file, so well with a lot of small writes in different positions of the file, so
@@ -1923,10 +1923,10 @@ but not `OpenChunkWriter`) don't have a natural chunk size.
In this case the value of this option is used (default 64Mi). In this case the value of this option is used (default 64Mi).
### --multi-thread-cutoff=SIZE {#multi-thread-cutoff} ### --multi-thread-cutoff=SizeSuffix {#multi-thread-cutoff}
When transferring files above SIZE to capable backends, rclone will When transferring files above specified size to capable backends,
use multiple threads to transfer the file (default 256M). rclone will use multiple threads to transfer the file (default 256M).
Capable backends are marked in the Capable backends are marked in the
[overview](/overview/#optional-features) as `MultithreadUpload`. (They [overview](/overview/#optional-features) as `MultithreadUpload`. (They