"rsync for cloud storage" - Google Drive, S3, Dropbox, Backblaze B2, One Drive, Swift, Hubic, Wasabi, Google Cloud Storage, Azure Blob, Azure Files, Yandex Files
Go azure-blobazure-blob-storageazure-filesbackblaze-b2cloud-storagedropboxencryptionftpfuse-filesystemgogolanggoogle-cloud-storagegoogle-driveonedriveopenstack-swiftrclones3sftpsyncwebdav
docs: change use of parameter type SIZE to SizeSuffix consistent with flags and cli help
albertony865d4b2bda57
diff --git a/docs/content/docs.md b/docs/content/docs.mdindex aa0d6b453..1a71e80f9 100644--- a/docs/content/docs.md+++ b/docs/content/docs.md@@ -660,7 +660,7 @@ formats:### 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,`G` for GiB, `T` for TiB and `P` for PiB may be used. These arethe 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 ineffect at the start of the transfer.-### --buffer-size=SIZE+### --buffer-size=SizeSuffixUse this sized buffer to speed up file transfers. Each `--transfer`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 aspossible.-### --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. Ifnot set or set to `0` or `off` this will not limit the amount of memoryin use.@@ -1699,7 +1699,7 @@ This tells rclone not to delete more than N files. If that limit isexceeded then a fatal error will be generated and rclone will stop theoperation in progress.-### --max-delete-size=SIZE+### --max-delete-size=SizeSuffixRclone will stop deleting files when the total size of deletions hasreached 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.-### --max-transfer=SIZE+### --max-transfer=SizeSuffixRclone will stop transferring when it has reached the size specified.Defaults to off.@@ -1896,10 +1896,10 @@ if you are reading and writing to an OS X filing system this will beThis 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-in memory before writing to disk for each thread.+When transferring with multiple threads, rclone will buffer the specified+number of bytes in memory before writing to disk for each thread.This can improve performance if the underlying filesystem does not dealwell 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).-### --multi-thread-cutoff=SIZE {#multi-thread-cutoff}+### --multi-thread-cutoff=SizeSuffix {#multi-thread-cutoff}-When transferring files above SIZE to capable backends, rclone will-use multiple threads to transfer the file (default 256M).+When transferring files above specified size to capable backends,+rclone will use multiple threads to transfer the file (default 256M).Capable backends are marked in the[overview](/overview/#optional-features) as `MultithreadUpload`. (They