docs: clearify buffer-size is per transfer/filehandle

This commit is contained in:
Fabian Möller 2018-08-15 13:23:57 +02:00 committed by Nick Craig-Wood
parent 552eb8e06b
commit 6dc5aa7454
3 changed files with 22 additions and 1 deletions

View file

@ -27,6 +27,23 @@ Or individual files or directories:
rclone rc vfs/forget file=path/to/file dir=path/to/dir
### File Buffering
The ` + "`--buffer-size`" + ` flag determines the amount of memory,
that will be used to buffer data in advance.
Each open file descriptor will try to keep the specified amount of
data in memory at all times. The buffered data is bound to one file
descriptor and won't be shared between multiple open file descriptors
of the same file.
This flag is a upper limit for the used memory per file descriptor.
The buffer will only use memory for data that is downloaded but not
not yet read. If the buffer is empty, only a small amount of memory
will be used.
The maximum memory used by rclone for buffering can be up to
` + "`--buffer-size * open files`" + `.
### File Caching
**NB** File caching is **EXPERIMENTAL** - use with care!