github-mirror/rclone
2
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2024-11-26 02:09:55 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Clean up mount.go and vfs/help.go docs

Browse Source 
* Title cleanups
* Typos
* `rclone mount vs rclone sync/copy` update with `File Caching`
This commit is contained in:
Jody Frankowski 2018-01-18 20:16:21 +01:00 committed by Nick Craig-Wood
parent 25a41e1945
commit 5e73acd40a
2 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
cmd/mountlib/mount.go
View File

@ -86,7 +86,7 @@ When that happens, it is the user's responsibility to stop the mount manually wi
# OS X # OS X
umount /path/to/local/mount umount /path/to/local/mount
### Installing on Windows ### ### Installing on Windows
To run rclone ` + commandName + ` on Windows, you will need to To run rclone ` + commandName + ` on Windows, you will need to
download and install [WinFsp](http://www.secfs.net/winfsp/). download and install [WinFsp](http://www.secfs.net/winfsp/).
@ -99,7 +99,7 @@ uses combination with
packages are by Bill Zissimopoulos who was very helpful during the packages are by Bill Zissimopoulos who was very helpful during the
implementation of rclone ` + commandName + ` for Windows. implementation of rclone ` + commandName + ` for Windows.
#### Windows caveats #### #### Windows caveats
Note that drives created as Administrator are not visible by other Note that drives created as Administrator are not visible by other
accounts (including the account that was elevated as accounts (including the account that was elevated as
@ -114,9 +114,9 @@ account (using [the WinFsp.Launcher
infrastructure](https://github.com/billziss-gh/winfsp/wiki/WinFsp-Service-Architecture)) infrastructure](https://github.com/billziss-gh/winfsp/wiki/WinFsp-Service-Architecture))
which creates drives accessible for everyone on the system. which creates drives accessible for everyone on the system.
### Limitations ### ### Limitations
This can only write files seqentially, it can only seek when reading. This can only write files sequentially, it can only seek when reading.
This means that many applications won't work with their files on an This means that many applications won't work with their files on an
rclone mount. rclone mount.
@ -130,21 +130,21 @@ the directory cache.
Only supported on Linux, FreeBSD, OS X and Windows at the moment. Only supported on Linux, FreeBSD, OS X and Windows at the moment.
### rclone ` + commandName + ` vs rclone sync/copy ## ### rclone ` + commandName + ` vs rclone sync/copy
File systems expect things to be 100% reliable, whereas cloud storage File systems expect things to be 100% reliable, whereas cloud storage
systems are a long way from 100% reliable. The rclone sync/copy systems are a long way from 100% reliable. The rclone sync/copy
commands cope with this with lots of retries. However rclone ` + commandName + ` commands cope with this with lots of retries. However rclone ` + commandName + `
can't use retries in the same way without making local copies of the can't use retries in the same way without making local copies of the
uploads. This might happen in the future, but for the moment rclone uploads. Look at the **EXPERIMENTAL** [file caching](#file-caching)
` + commandName + ` won't do that, so will be less reliable than the rclone command. for solutions to make ` + commandName + ` mount more reliable.
### Filters ### ### Filters
Note that all the rclone filters can be used to select a subset of the Note that all the rclone filters can be used to select a subset of the
files to be visible in the mount. files to be visible in the mount.
### systemd ### ### systemd
When running rclone ` + commandName + ` as a systemd service, it is possible When running rclone ` + commandName + ` as a systemd service, it is possible
to use Type=notify. In this case the service will enter the started state to use Type=notify. In this case the service will enter the started state

16
vfs/help.go
View File

@ -3,7 +3,7 @@ package vfs
// Help contains text describing file and directory caching to add to // Help contains text describing file and directory caching to add to
// the command help. // the command help.
var Help = ` var Help = `
### Directory Cache ### ### Directory Cache
Using the ` + "`--dir-cache-time`" + ` flag, you can set how long a Using the ` + "`--dir-cache-time`" + ` flag, you can set how long a
directory should be considered up to date and not refreshed from the directory should be considered up to date and not refreshed from the
@ -18,12 +18,12 @@ like this:
kill -SIGHUP $(pidof rclone) kill -SIGHUP $(pidof rclone)
### File Caching ### ### File Caching
**NB** File caching is **EXPERIMENTAL** - use with care! **NB** File caching is **EXPERIMENTAL** - use with care!
These flags control the VFS file caching options. The VFS layer is These flags control the VFS file caching options. The VFS layer is
used by rclone mount to make a cloud storage systm work more like a used by rclone mount to make a cloud storage system work more like a
normal file system. normal file system.
You'll need to enable VFS caching if you want, for example, to read You'll need to enable VFS caching if you want, for example, to read
@ -51,7 +51,7 @@ closed so if rclone is quit or dies with open files then these won't
get written back to the remote. However they will still be in the on get written back to the remote. However they will still be in the on
disk cache. disk cache.
#### --vfs-cache-mode off #### #### --vfs-cache-mode off
In this mode the cache will read directly from the remote and write In this mode the cache will read directly from the remote and write
directly to the remote without caching anything on disk. directly to the remote without caching anything on disk.
@ -66,7 +66,7 @@ This will mean some operations are not possible
* Open modes O_APPEND, O_TRUNC are ignored * Open modes O_APPEND, O_TRUNC are ignored
* If an upload fails it can't be retried * If an upload fails it can't be retried
#### --vfs-cache-mode minimal #### #### --vfs-cache-mode minimal
This is very similar to "off" except that files opened for read AND This is very similar to "off" except that files opened for read AND
write will be buffered to disks. This means that files opened for write will be buffered to disks. This means that files opened for
@ -79,7 +79,7 @@ These operations are not possible
* Files opened for write only will ignore O_APPEND, O_TRUNC * Files opened for write only will ignore O_APPEND, O_TRUNC
* If an upload fails it can't be retried * If an upload fails it can't be retried
#### --vfs-cache-mode writes #### #### --vfs-cache-mode writes
In this mode files opened for read only are still read directly from 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 the remote, write only and read/write files are buffered to disk
@ -89,14 +89,14 @@ This mode should support all normal file system operations.
If an upload fails it will be retried up to --low-level-retries times. If an upload fails it will be retried up to --low-level-retries times.
#### --vfs-cache-mode full #### #### --vfs-cache-mode full
In this mode all reads and writes are buffered to and from disk. When In this mode all reads and writes are buffered to and from disk. When
a file is opened for read it will be downloaded in its entirety first. a file is opened for read it will be downloaded in its entirety first.
This may be appropriate for your needs, or you may prefer to look at This may be appropriate for your needs, or you may prefer to look at
the cache backend which does a much more sophisticated job of caching, the cache backend which does a much more sophisticated job of caching,
including caching directory heirachies and chunks of files.q including caching directory hierarchies and chunks of files.
In this mode, unlike the others, when a file is written to the disk, In this mode, unlike the others, when a file is written to the disk,
it will be kept on the disk after it is written to the remote. It it will be kept on the disk after it is written to the remote. It