diff --git a/MANUAL.html b/MANUAL.html index 9d85a4095..c2eebde23 100644 --- a/MANUAL.html +++ b/MANUAL.html @@ -17,7 +17,7 @@

rclone(1) User Manual

Nick Craig-Wood

-

Nov 19, 2020

+

Jan 20, 2021

Rclone syncs your files to cloud storage

rclone logo

@@ -4330,12 +4330,21 @@ rclone rc core/bwlimit rate=1M
  • command - a string with the command name
  • arg - a list of arguments for the backend command
  • opt - a map of string to string of options
    • +
  • returnType - one of ("COMBINED_OUTPUT", "STREAM", "STREAM_ONLY_STDOUT", "STREAM_ONLY_STDERR") +

    • Returns

    For example

    rclone rc core/command command=ls -a mydrive:/ -o max-depth=1
@@ -5098,7 +5107,7 @@ Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
 
 
 Dropbox
-DBHASH †
+DBHASH ¹
 Yes
 Yes
 No
@@ -5170,7 +5179,7 @@ Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
 
 
 Mail.ru Cloud
-Mailru ‡‡‡
+Mailru ⁶
 Yes
 Yes
 No
@@ -5202,7 +5211,7 @@ Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
 
 
 Microsoft OneDrive
-SHA1 ‡‡
+SHA1 ⁵
 Yes
 Yes
 No
@@ -5213,7 +5222,7 @@ Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
 MD5
 Yes
 Yes
-Partial *
+Partial ⁸
 -
 
 
@@ -5226,7 +5235,7 @@ Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
 
 
 pCloud
-MD5, SHA1
+MD5, SHA1 ⁷
 Yes
 No
 No
@@ -5266,7 +5275,7 @@ Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
 
 
 SFTP
-MD5, SHA1 ‡
+MD5, SHA1 ²
 Yes
 Depends
 No
@@ -5290,8 +5299,8 @@ Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
 
 
 WebDAV
-MD5, SHA1 ††
-Yes †††
+MD5, SHA1 ³
+Yes ⁴
 Depends
 No
 -
@@ -5314,15 +5323,18 @@ Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
 
 
 
+
    Notes
    
+
    ¹ Dropbox supports its own custom hash. This is an SHA256 sum of all the 4MB block SHA256s.
    
+
    ² SFTP supports checksums if the same login has shell access and md5sum or sha1sum as well as echo are in the remote's PATH.
    
+
    ³ WebDAV supports hashes when used with Owncloud and Nextcloud only.
    
+
    ⁴ WebDAV supports modtimes when used with Owncloud and Nextcloud only.
    
+
    ⁵ Microsoft OneDrive Personal supports SHA1 hashes, whereas OneDrive for business and SharePoint server support Microsoft's own QuickXorHash.
    
+
    ⁶ Mail.ru uses its own modified SHA1 hash
    
+
    ⁷ pCloud only supports SHA1 (not MD5) in its EU region
    
+
    ⁸ Opendrive does not support creation of duplicate files using their web client interface or other stock clients, but the underlying storage platform has been determined to allow duplicate files, and it is possible to create them with rclone. It may be that this is a mistake or an unsupported feature.
    
 
    Hash
    
 
    The cloud storage system supports various hash types of the objects. The hashes are used when transferring data as an integrity check and can be specifically used with the --checksum flag in syncs and in the check command.
    
 
    To use the verify checksums when transferring between cloud storage systems they must support a common hash type.
    
-
    † Note that Dropbox supports its own custom hash. This is an SHA256 sum of all the 4MB block SHA256s.
    
-
    ‡ SFTP supports checksums if the same login has shell access and md5sum or sha1sum as well as echo are in the remote's PATH.
    
-
    †† WebDAV supports hashes when used with Owncloud and Nextcloud only.
    
-
    ††† WebDAV supports modtimes when used with Owncloud and Nextcloud only.
    
-
    ‡‡ Microsoft OneDrive Personal supports SHA1 hashes, whereas OneDrive for business and SharePoint server support Microsoft's own QuickXorHash.
    
-
    ‡‡‡ Mail.ru uses its own modified SHA1 hash
    
 
    ModTime
    
 
    The cloud storage system supports setting modification times on objects. If it does then this enables a using the modification times as part of the sync. If not then only the size will be checked by default, though the MD5SUM can be checked with the --checksum flag.
    
 
    All cloud storage systems support some kind of date on the object and these will be set when transferring from the cloud storage system.
    
@@ -5339,7 +5351,6 @@ Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
 
    Duplicate files
    
 
    If a cloud storage system allows duplicate files then it can have two objects with the same name.
    
 
    This confuses rclone greatly when syncing - use the rclone dedupe command to rename or remove duplicates.
    
-
    * Opendrive does not support creation of duplicate files using their web client interface or other stock clients, but the underlying storage platform has been determined to allow duplicate files, and it is possible to create them with rclone. It may be that this is a mistake or an unsupported feature.
    
 
    Restricted filenames
    
 
    Some cloud storage systems might have restrictions on the characters that are usable in file or directory names. When rclone detects such a name during a file upload, it will transparently replace the restricted characters with similar looking Unicode characters.
    
 
    This process is designed to avoid ambiguous file names as much as possible and allow to move files between many cloud storage systems transparently.
    
@@ -6291,7 +6302,7 @@ Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
       --use-json-log                         Use json log format.
       --use-mmap                             Use mmap allocator (see docs).
       --use-server-modtime                   Use server modified time instead of object metadata
-      --user-agent string                    Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.53.3")
+      --user-agent string                    Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.53.4")
   -v, --verbose count                        Print lots more stuff (repeat for more)

    Backend Flags

    These flags are available for every command. They control the backends and may be set in the config file.

    @@ -16160,7 +16171,8 @@ y/e/d> y 
    rclone copy /home/source remote:backup

    Modified time and hashes

    pCloud allows modification times to be set on objects accurate to 1 second. These will be used to detect whether objects need syncing or not. In order to set a Modification time pCloud requires the object be re-uploaded.

    -

    pCloud supports MD5 and SHA1 type hashes, so you can use the --checksum flag.

    +

    pCloud supports MD5 and SHA1 type hashes in the US region but and SHA1 only in the EU region, so you can use the --checksum flag.

    +

    (Note that pCloud also support SHA256 in the EU region, but rclone does not have support for that yet.)

    Restricted filename characters

    In addition to the default restricted characters set the following characters are also replaced:

    @@ -18552,6 +18564,71 @@ $ tree /tmp/b
  • "error": return an error based on option value

    • Changelog

    +

    v1.53.4 - 2021-01-20

    +

    See commits

    +

    v1.53.3 - 2020-11-19

    See commits