2017-11-14 04:54:21 +11:00
|
|
|
package vfs
|
|
|
|
|
2020-05-25 17:50:20 +10:00
|
|
|
import (
|
|
|
|
"strings"
|
|
|
|
)
|
|
|
|
|
2017-11-14 04:54:21 +11:00
|
|
|
// Help contains text describing file and directory caching to add to
|
|
|
|
// the command help.
|
2020-05-25 17:50:20 +10:00
|
|
|
// Warning: "!" (sic) will be replaced by backticks below,
|
|
|
|
// but the pipe character "|" can be used as is.
|
|
|
|
var Help = strings.ReplaceAll(`
|
2020-06-27 03:28:33 +10:00
|
|
|
### VFS - Virtual File System
|
2017-11-14 04:54:21 +11:00
|
|
|
|
2020-06-27 03:28:33 +10:00
|
|
|
This command uses the VFS layer. This adapts the cloud storage objects
|
|
|
|
that rclone uses into something which looks much more like a disk
|
|
|
|
filing system.
|
|
|
|
|
|
|
|
Cloud storage objects have lots of properties which aren't like disk
|
|
|
|
files - you can't extend them or write to the middle of them, so the
|
|
|
|
VFS layer has to deal with that. Because there is no one right way of
|
|
|
|
doing this there are various options explained below.
|
|
|
|
|
|
|
|
The VFS layer also implements a directory cache - this caches info
|
|
|
|
about files and directories (but not the data) in memory.
|
|
|
|
|
|
|
|
### VFS Directory Cache
|
|
|
|
|
2020-05-25 17:50:20 +10:00
|
|
|
Using the !--dir-cache-time! flag, you can control how long a
|
2017-11-14 04:54:21 +11:00
|
|
|
directory should be considered up to date and not refreshed from the
|
2020-06-27 03:28:33 +10:00
|
|
|
backend. Changes made through the mount will appear immediately or
|
|
|
|
invalidate the cache.
|
2017-11-14 04:54:21 +11:00
|
|
|
|
2021-08-16 19:30:01 +10:00
|
|
|
--dir-cache-time duration Time to cache directory entries for (default 5m0s)
|
|
|
|
--poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s)
|
2020-06-27 03:28:33 +10:00
|
|
|
|
2020-09-02 23:24:44 +10:00
|
|
|
However, changes made directly on the cloud storage by the web
|
2020-06-27 03:28:33 +10:00
|
|
|
interface or a different copy of rclone will only be picked up once
|
|
|
|
the directory cache expires if the backend configured does not support
|
|
|
|
polling for changes. If the backend supports polling, changes will be
|
2020-09-02 23:24:44 +10:00
|
|
|
picked up within the polling interval.
|
2020-06-27 03:28:33 +10:00
|
|
|
|
2020-05-25 17:50:20 +10:00
|
|
|
You can send a !SIGHUP! signal to rclone for it to flush all
|
2020-06-27 03:28:33 +10:00
|
|
|
directory caches, regardless of how old they are. Assuming only one
|
|
|
|
rclone instance is running, you can reset the cache like this:
|
2017-11-14 04:54:21 +11:00
|
|
|
|
|
|
|
kill -SIGHUP $(pidof rclone)
|
|
|
|
|
2018-03-17 07:45:34 +11:00
|
|
|
If you configure rclone with a [remote control](/rc) then you can use
|
|
|
|
rclone rc to flush the whole directory cache:
|
|
|
|
|
|
|
|
rclone rc vfs/forget
|
|
|
|
|
|
|
|
Or individual files or directories:
|
|
|
|
|
|
|
|
rclone rc vfs/forget file=path/to/file dir=path/to/dir
|
|
|
|
|
2020-06-27 03:28:33 +10:00
|
|
|
### VFS File Buffering
|
2018-08-15 21:23:57 +10:00
|
|
|
|
2020-05-25 17:50:20 +10:00
|
|
|
The !--buffer-size! flag determines the amount of memory,
|
2018-08-15 21:23:57 +10:00
|
|
|
that will be used to buffer data in advance.
|
|
|
|
|
2020-06-27 03:28:33 +10:00
|
|
|
Each open file will try to keep the specified amount of data in memory
|
|
|
|
at all times. The buffered data is bound to one open file and won't be
|
|
|
|
shared.
|
|
|
|
|
|
|
|
This flag is a upper limit for the used memory per open file. 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.
|
2018-08-15 21:23:57 +10:00
|
|
|
|
|
|
|
The maximum memory used by rclone for buffering can be up to
|
2020-05-25 17:50:20 +10:00
|
|
|
!--buffer-size * open files!.
|
2018-08-15 21:23:57 +10:00
|
|
|
|
2020-06-27 03:28:33 +10:00
|
|
|
### VFS File Caching
|
2017-11-14 04:54:21 +11:00
|
|
|
|
2020-06-27 03:28:33 +10:00
|
|
|
These flags control the VFS file caching options. File caching is
|
|
|
|
necessary to make the VFS layer appear compatible with a normal file
|
|
|
|
system. It can be disabled at the cost of some compatibility.
|
2017-11-14 04:54:21 +11:00
|
|
|
|
2020-06-27 03:28:33 +10:00
|
|
|
For example you'll need to enable VFS caching if you want to read and
|
|
|
|
write simultaneously to a file. See below for more details.
|
2017-12-02 23:06:05 +11:00
|
|
|
|
2020-06-27 03:28:33 +10:00
|
|
|
Note that the VFS cache is separate from the cache backend and you may
|
|
|
|
find that you need one or the other or both.
|
2017-12-02 23:06:05 +11:00
|
|
|
|
2018-02-12 04:48:03 +11:00
|
|
|
--cache-dir string Directory rclone will use for caching.
|
2020-06-27 03:28:33 +10:00
|
|
|
--vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off)
|
2021-08-16 19:30:01 +10:00
|
|
|
--vfs-cache-max-age duration Max age of objects in the cache (default 1h0m0s)
|
|
|
|
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
|
|
|
--vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s)
|
|
|
|
--vfs-write-back duration Time to writeback files after last use when using cache (default 5s)
|
2017-11-14 04:54:21 +11:00
|
|
|
|
2020-05-25 17:50:20 +10:00
|
|
|
If run with !-vv! rclone will print the location of the file cache. The
|
2017-11-14 04:54:21 +11:00
|
|
|
files are stored in the user cache file area which is OS dependent but
|
2020-05-25 17:50:20 +10:00
|
|
|
can be controlled with !--cache-dir! or setting the appropriate
|
2017-11-14 04:54:21 +11:00
|
|
|
environment variable.
|
|
|
|
|
2020-05-25 17:50:20 +10:00
|
|
|
The cache has 4 different modes selected by !--vfs-cache-mode!.
|
2017-11-14 04:54:21 +11:00
|
|
|
The higher the cache mode the more compatible rclone becomes at the
|
|
|
|
cost of using disk space.
|
|
|
|
|
|
|
|
Note that files are written back to the remote only when they are
|
2021-08-20 03:29:41 +10:00
|
|
|
closed and if they haven't been accessed for !--vfs-write-back!
|
|
|
|
seconds. If rclone is quit or dies with files that haven't been
|
2020-06-27 03:28:33 +10:00
|
|
|
uploaded, these will be uploaded next time rclone is run with the same
|
|
|
|
flags.
|
2017-11-14 04:54:21 +11:00
|
|
|
|
2020-05-25 17:50:20 +10:00
|
|
|
If using !--vfs-cache-max-size! note that the cache may exceed this size
|
2019-02-02 10:35:03 +11:00
|
|
|
for two reasons. Firstly because it is only checked every
|
2020-05-25 17:50:20 +10:00
|
|
|
!--vfs-cache-poll-interval!. Secondly because open files cannot be
|
2019-02-02 10:35:03 +11:00
|
|
|
evicted from the cache.
|
|
|
|
|
2021-02-17 04:15:05 +11:00
|
|
|
You **should not** run two copies of rclone using the same VFS cache
|
|
|
|
with the same or overlapping remotes if using !--vfs-cache-mode > off!.
|
|
|
|
This can potentially cause data corruption if you do. You can work
|
|
|
|
around this by giving each rclone its own cache hierarchy with
|
|
|
|
!--cache-dir!. You don't need to worry about this if the remotes in
|
|
|
|
use don't overlap.
|
|
|
|
|
2018-01-19 06:16:21 +11:00
|
|
|
#### --vfs-cache-mode off
|
2017-11-14 04:54:21 +11:00
|
|
|
|
2020-09-02 23:24:44 +10:00
|
|
|
In this mode (the default) the cache will read directly from the remote and write
|
2017-11-14 04:54:21 +11:00
|
|
|
directly to the remote without caching anything on disk.
|
|
|
|
|
|
|
|
This will mean some operations are not possible
|
|
|
|
|
|
|
|
* Files can't be opened for both read AND write
|
|
|
|
* Files opened for write can't be seeked
|
2017-11-21 05:01:42 +11:00
|
|
|
* Existing files opened for write must have O_TRUNC set
|
|
|
|
* Files open for read with O_TRUNC will be opened write only
|
2017-11-14 04:54:21 +11:00
|
|
|
* Files open for write only will behave as if O_TRUNC was supplied
|
|
|
|
* Open modes O_APPEND, O_TRUNC are ignored
|
|
|
|
* If an upload fails it can't be retried
|
|
|
|
|
2018-01-19 06:16:21 +11:00
|
|
|
#### --vfs-cache-mode minimal
|
2017-11-14 04:54:21 +11:00
|
|
|
|
|
|
|
This is very similar to "off" except that files opened for read AND
|
2020-09-02 23:24:44 +10:00
|
|
|
write will be buffered to disk. This means that files opened for
|
2017-11-14 04:54:21 +11:00
|
|
|
write will be a lot more compatible, but uses the minimal disk space.
|
|
|
|
|
|
|
|
These operations are not possible
|
|
|
|
|
|
|
|
* Files opened for write only can't be seeked
|
2017-11-21 05:01:42 +11:00
|
|
|
* Existing files opened for write must have O_TRUNC set
|
2017-11-14 04:54:21 +11:00
|
|
|
* Files opened for write only will ignore O_APPEND, O_TRUNC
|
|
|
|
* If an upload fails it can't be retried
|
|
|
|
|
2018-01-19 06:16:21 +11:00
|
|
|
#### --vfs-cache-mode writes
|
2017-11-14 04:54:21 +11:00
|
|
|
|
|
|
|
In this mode files opened for read only are still read directly from
|
|
|
|
the remote, write only and read/write files are buffered to disk
|
|
|
|
first.
|
|
|
|
|
|
|
|
This mode should support all normal file system operations.
|
|
|
|
|
2020-06-27 03:28:33 +10:00
|
|
|
If an upload fails it will be retried at exponentially increasing
|
|
|
|
intervals up to 1 minute.
|
2017-11-14 04:54:21 +11:00
|
|
|
|
2018-01-19 06:16:21 +11:00
|
|
|
#### --vfs-cache-mode full
|
2017-11-14 04:54:21 +11:00
|
|
|
|
2020-06-27 03:28:33 +10:00
|
|
|
In this mode all reads and writes are buffered to and from disk. When
|
|
|
|
data is read from the remote this is buffered to disk as well.
|
2017-11-14 04:54:21 +11:00
|
|
|
|
2020-06-27 03:28:33 +10:00
|
|
|
In this mode the files in the cache will be sparse files and rclone
|
Spelling fixes
Fix spelling of: above, already, anonymous, associated,
authentication, bandwidth, because, between, blocks, calculate,
candidates, cautious, changelog, cleaner, clipboard, command,
completely, concurrently, considered, constructs, corrupt, current,
daemon, dependencies, deprecated, directory, dispatcher, download,
eligible, ellipsis, encrypter, endpoint, entrieslist, essentially,
existing writers, existing, expires, filesystem, flushing, frequently,
hierarchy, however, implementation, implements, inaccurate,
individually, insensitive, longer, maximum, metadata, modified,
multipart, namedirfirst, nextcloud, obscured, opened, optional,
owncloud, pacific, passphrase, password, permanently, persimmon,
positive, potato, protocol, quota, receiving, recommends, referring,
requires, revisited, satisfied, satisfies, satisfy, semver,
serialized, session, storage, strategies, stringlist, successful,
supported, surprise, temporarily, temporary, transactions, unneeded,
update, uploads, wrapped
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2020-10-09 11:17:24 +11:00
|
|
|
will keep track of which bits of the files it has downloaded.
|
2017-12-02 23:06:05 +11:00
|
|
|
|
2020-06-27 03:28:33 +10:00
|
|
|
So if an application only reads the starts of each file, then rclone
|
|
|
|
will only buffer the start of the file. These files will appear to be
|
|
|
|
their full size in the cache, but they will be sparse files with only
|
|
|
|
the data that has been downloaded present in them.
|
2017-11-14 04:54:21 +11:00
|
|
|
|
2020-06-27 03:28:33 +10:00
|
|
|
This mode should support all normal file system operations and is
|
2021-08-20 03:29:41 +10:00
|
|
|
otherwise identical to !--vfs-cache-mode! writes.
|
2020-06-27 03:28:33 +10:00
|
|
|
|
2021-08-20 03:29:41 +10:00
|
|
|
When reading a file rclone will read !--buffer-size! plus
|
|
|
|
!--vfs-read-ahead! bytes ahead. The !--buffer-size! is buffered in memory
|
|
|
|
whereas the !--vfs-read-ahead! is buffered on disk.
|
2020-08-05 18:57:03 +10:00
|
|
|
|
2021-08-20 03:29:41 +10:00
|
|
|
When using this mode it is recommended that !--buffer-size! is not set
|
|
|
|
too large and !--vfs-read-ahead! is set large if required.
|
2020-08-05 18:57:03 +10:00
|
|
|
|
2020-09-12 00:34:58 +10:00
|
|
|
**IMPORTANT** not all file systems support sparse files. In particular
|
|
|
|
FAT/exFAT do not. Rclone will perform very badly if the cache
|
|
|
|
directory is on a filesystem which doesn't support sparse files and it
|
|
|
|
will log an ERROR message if one is detected.
|
|
|
|
|
2022-03-22 03:15:12 +11:00
|
|
|
#### Fingerprinting
|
|
|
|
|
|
|
|
Various parts of the VFS use fingerprinting to see if a local file
|
|
|
|
copy has changed relative to a remote file. Fingerprints are made
|
|
|
|
from:
|
|
|
|
|
|
|
|
- size
|
|
|
|
- modification time
|
|
|
|
- hash
|
|
|
|
|
|
|
|
where available on an object.
|
|
|
|
|
|
|
|
On some backends some of these attributes are slow to read (they take
|
|
|
|
an extra API call per object, or extra work per object).
|
|
|
|
|
|
|
|
For example !hash! is slow with the !local! and !sftp! backends as
|
|
|
|
they have to read the entire file and hash it, and !modtime! is slow
|
|
|
|
with the !s3!, !swift!, !ftp! and !qinqstor! backends because they
|
|
|
|
need to do an extra API call to fetch it.
|
|
|
|
|
|
|
|
If you use the !--vfs-fast-fingerprint! flag then rclone will not
|
|
|
|
include the slow operations in the fingerprint. This makes the
|
|
|
|
fingerprinting less accurate but much faster and will improve the
|
|
|
|
opening time of cached files.
|
|
|
|
|
|
|
|
If you are running a vfs cache over !local!, !s3! or !swift! backends
|
|
|
|
then using this flag is recommended.
|
|
|
|
|
|
|
|
Note that if you change the value of this flag, the fingerprints of
|
|
|
|
the files in the cache may be invalidated and the files will need to
|
|
|
|
be downloaded again.
|
|
|
|
|
2021-08-20 03:29:41 +10:00
|
|
|
### VFS Chunked Reading
|
|
|
|
|
|
|
|
When rclone reads files from a remote it reads them in chunks. This
|
|
|
|
means that rather than requesting the whole file rclone reads the
|
|
|
|
chunk specified. This can reduce the used download quota for some
|
|
|
|
remotes by requesting only chunks from the remote that are actually
|
|
|
|
read, at the cost of an increased number of requests.
|
|
|
|
|
|
|
|
These flags control the chunking:
|
|
|
|
|
|
|
|
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128M)
|
|
|
|
--vfs-read-chunk-size-limit SizeSuffix Max chunk doubling size (default off)
|
|
|
|
|
|
|
|
Rclone will start reading a chunk of size !--vfs-read-chunk-size!,
|
|
|
|
and then double the size for each read. When !--vfs-read-chunk-size-limit! is
|
|
|
|
specified, and greater than !--vfs-read-chunk-size!, the chunk size for each
|
|
|
|
open file will get doubled only until the specified value is reached. If the
|
|
|
|
value is "off", which is the default, the limit is disabled and the chunk size
|
|
|
|
will grow indefinitely.
|
|
|
|
|
|
|
|
With !--vfs-read-chunk-size 100M! and !--vfs-read-chunk-size-limit 0!
|
|
|
|
the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on.
|
|
|
|
When !--vfs-read-chunk-size-limit 500M! is specified, the result would be
|
|
|
|
0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on.
|
|
|
|
|
|
|
|
Setting !--vfs-read-chunk-size! to !0! or "off" disables chunked reading.
|
|
|
|
|
2020-06-27 03:28:33 +10:00
|
|
|
### VFS Performance
|
|
|
|
|
|
|
|
These flags may be used to enable/disable features of the VFS for
|
2021-08-20 03:29:41 +10:00
|
|
|
performance or other reasons. See also the [chunked reading](#vfs-chunked-reading)
|
|
|
|
feature.
|
2020-06-27 03:28:33 +10:00
|
|
|
|
2021-08-20 03:29:41 +10:00
|
|
|
In particular S3 and Swift benefit hugely from the !--no-modtime! flag
|
|
|
|
(or use !--use-server-modtime! for a slightly different effect) as each
|
2020-06-27 03:28:33 +10:00
|
|
|
read of the modification time takes a transaction.
|
|
|
|
|
|
|
|
--no-checksum Don't compare checksums on up/download.
|
|
|
|
--no-modtime Don't read/write the modification time (can speed things up).
|
|
|
|
--no-seek Don't allow seeking in files.
|
|
|
|
--read-only Mount read-only.
|
|
|
|
|
|
|
|
Sometimes rclone is delivered reads or writes out of order. Rather
|
|
|
|
than seeking rclone will wait a short time for the in sequence read or
|
|
|
|
write to come in. These flags only come into effect when not using an
|
2020-09-02 23:24:44 +10:00
|
|
|
on disk cache file.
|
2017-11-14 04:54:21 +11:00
|
|
|
|
2021-08-16 19:30:01 +10:00
|
|
|
--vfs-read-wait duration Time to wait for in-sequence read before seeking (default 20ms)
|
|
|
|
--vfs-write-wait duration Time to wait for in-sequence write before giving error (default 1s)
|
2020-02-11 01:52:31 +11:00
|
|
|
|
2021-08-20 03:29:41 +10:00
|
|
|
When using VFS write caching (!--vfs-cache-mode! with value writes or full),
|
|
|
|
the global flag !--transfers! can be set to adjust the number of parallel uploads of
|
|
|
|
modified files from cache (the related global flag !--checkers! have no effect on mount).
|
2020-11-14 00:03:14 +11:00
|
|
|
|
2021-08-16 19:30:01 +10:00
|
|
|
--transfers int Number of file transfers to run in parallel (default 4)
|
2020-11-14 00:03:14 +11:00
|
|
|
|
2020-06-27 03:28:33 +10:00
|
|
|
### VFS Case Sensitivity
|
2020-02-11 01:52:31 +11:00
|
|
|
|
|
|
|
Linux file systems are case-sensitive: two files can differ only
|
|
|
|
by case, and the exact case must be used when opening a file.
|
|
|
|
|
|
|
|
File systems in modern Windows are case-insensitive but case-preserving:
|
|
|
|
although existing files can be opened using any case, the exact case used
|
|
|
|
to create the file is preserved and available for programs to query.
|
|
|
|
It is not allowed for two files in the same directory to differ only by case.
|
|
|
|
|
2020-05-20 20:54:33 +10:00
|
|
|
Usually file systems on macOS are case-insensitive. It is possible to make macOS
|
2021-08-20 03:29:41 +10:00
|
|
|
file systems case-sensitive but that is not the default.
|
2020-02-11 01:52:31 +11:00
|
|
|
|
2020-05-25 17:50:20 +10:00
|
|
|
The !--vfs-case-insensitive! mount flag controls how rclone handles these
|
2020-02-11 01:52:31 +11:00
|
|
|
two cases. If its value is "false", rclone passes file names to the mounted
|
2020-06-27 03:28:33 +10:00
|
|
|
file system as-is. If the flag is "true" (or appears without a value on
|
2020-02-11 01:52:31 +11:00
|
|
|
command line), rclone may perform a "fixup" as explained below.
|
|
|
|
|
|
|
|
The user may specify a file name to open/delete/rename/etc with a case
|
|
|
|
different than what is stored on mounted file system. If an argument refers
|
|
|
|
to an existing file with exactly the same name, then the case of the existing
|
|
|
|
file on the disk will be used. However, if a file name with exactly the same
|
|
|
|
name is not found but a name differing only by case exists, rclone will
|
|
|
|
transparently fixup the name. This fixup happens only when an existing file
|
|
|
|
is requested. Case sensitivity of file names created anew by rclone is
|
|
|
|
controlled by an underlying mounted file system.
|
|
|
|
|
|
|
|
Note that case sensitivity of the operating system running rclone (the target)
|
|
|
|
may differ from case sensitivity of a file system mounted by rclone (the source).
|
|
|
|
The flag controls whether "fixup" is performed to satisfy the target.
|
|
|
|
|
2020-09-02 23:24:44 +10:00
|
|
|
If the flag is not provided on the command line, then its default value depends
|
2020-05-20 20:54:33 +10:00
|
|
|
on the operating system where rclone runs: "true" on Windows and macOS, "false"
|
2020-02-11 01:52:31 +11:00
|
|
|
otherwise. If the flag is provided without a value, then it is "true".
|
2021-02-18 07:36:13 +11:00
|
|
|
|
|
|
|
### Alternate report of used bytes
|
|
|
|
|
|
|
|
Some backends, most notably S3, do not report the amount of bytes used.
|
|
|
|
If you need this information to be available when running !df! on the
|
|
|
|
filesystem, then pass the flag !--vfs-used-is-size! to rclone.
|
|
|
|
With this flag set, instead of relying on the backend to report this
|
|
|
|
information, rclone will scan the whole remote similar to !rclone size!
|
|
|
|
and compute the total used space itself.
|
|
|
|
|
|
|
|
_WARNING._ Contrary to !rclone size!, this flag ignores filters so that the
|
|
|
|
result is accurate. However, this is very inefficient and may cost lots of API
|
|
|
|
calls resulting in extra charges. Use it as a last resort and only with caching.
|
2020-05-25 17:50:20 +10:00
|
|
|
`, "!", "`")
|