From e2531e08bec806f9bb9108999f2a234d6799996d Mon Sep 17 00:00:00 2001 From: Nick Craig-Wood Date: Mon, 8 Mar 2021 10:04:23 +0000 Subject: [PATCH] Version v1.54.1 --- MANUAL.html | 302 +++++++---- MANUAL.md | 341 ++++++++---- MANUAL.txt | 358 +++++++++---- docs/content/changelog.md | 37 ++ docs/content/commands/rclone_mount.md | 7 + docs/content/commands/rclone_serve_dlna.md | 7 + docs/content/commands/rclone_serve_ftp.md | 7 + docs/content/commands/rclone_serve_http.md | 7 + docs/content/commands/rclone_serve_sftp.md | 7 + docs/content/commands/rclone_serve_webdav.md | 7 + docs/content/dropbox.md | 15 + docs/content/flags.md | 9 +- docs/content/rc.md | 4 + docs/content/zoho.md | 49 ++ rclone.1 | 519 +++++++++++++------ 15 files changed, 1228 insertions(+), 448 deletions(-) diff --git a/MANUAL.html b/MANUAL.html index c34d361e4..6bb49edcc 100644 --- a/MANUAL.html +++ b/MANUAL.html @@ -17,7 +17,7 @@

rclone(1) User Manual

Nick Craig-Wood

-

Feb 02, 2021

+

Mar 08, 2021

Rclone syncs your files to cloud storage

rclone logo

@@ -1475,7 +1475,7 @@ rclone mount remote:path/to/files * --volname \\cloud\remote

The bucket based remotes (e.g. Swift, S3, Google Compute Storage, B2, Hubic) do not support the concept of empty directories, so empty directories will have a tendency to disappear once they fall out of the directory cache.

Only supported on Linux, FreeBSD, OS X and Windows at the moment.

rclone mount vs rclone sync/copy

-

File systems expect things to be 100% reliable, whereas cloud storage systems are a long way from 100% reliable. The rclone sync/copy commands cope with this with lots of retries. However rclone mount can't use retries in the same way without making local copies of the uploads. Look at the VFS file caching section for solutions to make mount more reliable.

+

File systems expect things to be 100% reliable, whereas cloud storage systems are a long way from 100% reliable. The rclone sync/copy commands cope with this with lots of retries. However rclone mount can't use retries in the same way without making local copies of the uploads. Look at the VFS File Caching for solutions to make mount more reliable.

Attribute caching

You can use the flag --attr-timeout to set the time the kernel caches the attributes (size, modification time, etc.) for directory entries.

The default is 1s which caches files just long enough to avoid too many callbacks to rclone from the kernel.

@@ -1526,6 +1526,7 @@ rclone mount remote:path/to/files * --volname \\cloud\remote

The cache has 4 different modes selected by --vfs-cache-mode. 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 closed and if they haven't been accessed for --vfs-write-back second. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.

If using --vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.

+

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.

--vfs-cache-mode off

In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk.

This will mean some operations are not possible

@@ -1848,6 +1849,7 @@ ffmpeg - | rclone rcat remote:path/to/file

The cache has 4 different modes selected by --vfs-cache-mode. 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 closed and if they haven't been accessed for --vfs-write-back second. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.

If using --vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.

+

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.

--vfs-cache-mode off

In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk.

This will mean some operations are not possible

@@ -1982,6 +1984,7 @@ ffmpeg - | rclone rcat remote:path/to/file

The cache has 4 different modes selected by --vfs-cache-mode. 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 closed and if they haven't been accessed for --vfs-write-back second. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.

If using --vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.

+

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.

--vfs-cache-mode off

In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk.

This will mean some operations are not possible

@@ -2246,6 +2249,7 @@ htpasswd -B htpasswd anotherUser

The cache has 4 different modes selected by --vfs-cache-mode. 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 closed and if they haven't been accessed for --vfs-write-back second. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.

If using --vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.

+

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.

--vfs-cache-mode off

In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk.

This will mean some operations are not possible

@@ -2558,6 +2562,7 @@ htpasswd -B htpasswd anotherUser

The cache has 4 different modes selected by --vfs-cache-mode. 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 closed and if they haven't been accessed for --vfs-write-back second. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.

If using --vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.

+

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.

--vfs-cache-mode off

In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk.

This will mean some operations are not possible

@@ -2823,6 +2828,7 @@ htpasswd -B htpasswd anotherUser

The cache has 4 different modes selected by --vfs-cache-mode. 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 closed and if they haven't been accessed for --vfs-write-back second. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.

If using --vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.

+

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.

--vfs-cache-mode off

In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk.

This will mean some operations are not possible

@@ -4085,7 +4091,7 @@ dir1/dir2/dir3/.ignore

The command rclone ls --exclude-if-present .ignore dir1 does not list dir3, file3 or .ignore.

--exclude-if-present can only be used once in an rclone command.

Common pitfalls

-

The most frequent filter support issues on the rclone forum are:

+

The most frequent filter support issues on the rclone forum are:

--dropbox-impersonate

Impersonate this user when using a business account.

+

Note that if you want to use impersonate, you should make sure this flag is set when running "rclone config" as this will cause rclone to request the "members.read" scope which it won't normally. This is needed to lookup a members email address into the internal ID that dropbox uses in the API.

+

Using the "members.read" scope will require a Dropbox Team Admin to approve during the OAuth flow.

+

You will have to use your own App (setting your own client_id and client_secret) to use this option as currently rclone's default set of permissions doesn't include "members.read". This can be added once v1.55 or later is in use everywhere.

Note: in case you configured a specific root folder on gdrive and rclone is unable to access the contents of that folder when using --drive-impersonate, do this instead: - in the gdrive web interface, share your root folder with the user/email of the new Service Account you created/selected at step #1 - use rclone without specifying the --drive-impersonate option, like this: rclone -v foo@example.com lsf gdrive:backup

-

Team drives

-

If you want to configure the remote to point to a Google Team Drive then answer y to the question Configure this as a team drive?.

-

This will fetch the list of Team Drives from google and allow you to configure which one you want to use. You can also type in a team drive ID if you prefer.

+

Shared drives (team drives)

+

If you want to configure the remote to point to a Google Shared Drive (previously known as Team Drives) then answer y to the question Configure this as a Shared Drive (Team Drive)?.

+

This will fetch the list of Shared Drives from google and allow you to configure which one you want to use. You can also type in a Shared Drive ID if you prefer.

For example:

-
Configure this as a team drive?
+
Configure this as a Shared Drive (Team Drive)?
 y) Yes
 n) No
 y/n> y
-Fetching team drive list...
+Fetching Shared Drive list...
 Choose a number from below, or type in your own value
  1 / Rclone Test
    \ "xxxxxxxxxxxxxxxxxxxx"
@@ -13249,7 +13270,7 @@ Choose a number from below, or type in your own value
    \ "yyyyyyyyyyyyyyyyyyyy"
  3 / Rclone Test 3
    \ "zzzzzzzzzzzzzzzzzzzz"
-Enter a Team Drive ID> 1
+Enter a Shared Drive ID> 1
 --------------------
 [remote]
 client_id =
@@ -13659,7 +13680,7 @@ trashed=false and 'c' in parents

 
  • Default: ""
    • 
 
 
    --drive-team-drive
    
-
    ID of the Team Drive
    
+
    ID of the Shared Drive (Team Drive)
    
 
      
 
    • Config: team_drive
      • 
 
    • Env Var: RCLONE_DRIVE_TEAM_DRIVE
      • 
@@ -13972,9 +13993,9 @@ rclone backend shortcut drive: source_item -o target=drive2: destination_shortcu
 
    • "target": optional target remote for the shortcut destination
      • 
 
    
 
    drives
    
-
    List the shared drives available to this account
    
+
    List the Shared Drives available to this account
    
 
    rclone backend drives remote: [options] [<arguments>+]
    
-
    This command lists the shared drives (teamdrives) available to this account.
    
+
    This command lists the Shared Drives (Team Drives) available to this account.
    
 
    Usage:
    
 
    rclone backend drives drive:
    
 
    This will return a JSON list of objects like this
    
@@ -18173,7 +18194,7 @@ known_hosts_file = ~/.ssh/known_hosts

    SFTP also supports about if the same login has shell access and df are in the remote's PATH. about will return the total space, free space, and used space on the remote for the disk of the specified path on the remote or, if not set, the disk of the root on the remote. about will fail if it does not have shell access or if df is not in the remote's PATH.

    Note that some SFTP servers (e.g. Synology) the paths are different for SSH and SFTP so the hashes can't be calculated properly. For them using disable_hashcheck is a good idea.

    The only ssh agent supported under Windows is Putty's pageant.

    -

    The Go SSH library disables the use of the aes128-cbc cipher by default, due to security concerns. This can be re-enabled on a per-connection basis by setting the use_insecure_cipher setting in the configuration file to true. Further details on the insecurity of this cipher can be found [in this paper] (http://www.isg.rhul.ac.uk/~kp/SandPfinal.pdf).

    +

    The Go SSH library disables the use of the aes128-cbc cipher by default, due to security concerns. This can be re-enabled on a per-connection basis by setting the use_insecure_cipher setting in the configuration file to true. Further details on the insecurity of this cipher can be found in this paper.

    SFTP isn't supported under plan9 until this issue is fixed.

    Note that since SFTP isn't HTTP based the following flags don't work with it: --dump-headers, --dump-bodies, --dump-auth

    Note that --timeout isn't supported (but --contimeout is).

    @@ -19267,6 +19288,22 @@ y/e/d>

    Only control characters and invalid UTF-8 are replaced. In addition most Unicode full-width characters are not supported at all and will be removed from filenames during upload.

    Standard Options

    Here are the standard options specific to zoho (Zoho).

    +

    --zoho-client-id

    +

    OAuth Client Id Leave blank normally.

    + +

    --zoho-client-secret

    +

    OAuth Client Secret Leave blank normally.

    +

    --zoho-region

    Zoho region to connect to. You'll have to use the region you organization is registered in.

    Advanced Options

    Here are the advanced options specific to zoho (Zoho).

    +

    --zoho-token

    +

    OAuth Access Token as a JSON blob.

    + +

    --zoho-auth-url

    +

    Auth server URL. Leave blank to use the provider defaults.

    + +

    --zoho-token-url

    +

    Token server url. Leave blank to use the provider defaults.

    +

    --zoho-encoding

    This sets the encoding for the backend.

    See: the encoding section in the overview for more info.

    @@ -19824,12 +19885,68 @@ $ tree /tmp/b
  • "error": return an error based on option value

    • Changelog

    +

    v1.54.1 - 2021-03-08

    +

    See commits

    +

    v1.54.0 - 2021-02-02

    See commits