diff --git a/MANUAL.html b/MANUAL.html index 7b39794fb..9cae8c1d8 100644 --- a/MANUAL.html +++ b/MANUAL.html @@ -81,7 +81,7 @@

rclone(1) User Manual

Nick Craig-Wood

-

Mar 18, 2022

+

Apr 29, 2022

Rclone syncs your files to cloud storage

rclone logo

@@ -144,6 +144,7 @@
  • Backblaze B2
  • Box
  • Ceph
    • +
  • China Mobile Ecloud Elastic Object Storage (EOS)
  • Citrix ShareFile
  • C14
  • DigitalOcean Spaces
    • @@ -1839,7 +1840,7 @@ umount /path/to/local/mount

    The size of the mounted file system will be set according to information retrieved from the remote, the same as returned by the rclone about command. Remotes with unlimited storage may report the used size only, then an additional 1 PiB of free space is assumed. If the remote does not support the about feature at all, then 1 PiB is set as both the total and the free size.

    Installing on Windows

    To run rclone mount on Windows, you will need to download and install WinFsp.

    -

    WinFsp is an open-source Windows File System Proxy which makes it easy to write user space file systems for Windows. It provides a FUSE emulation layer which rclone uses combination with cgofuse. Both of these packages are by Bill Zissimopoulos who was very helpful during the implementation of rclone mount for Windows.

    +

    WinFsp is an open-source Windows File System Proxy which makes it easy to write user space file systems for Windows. It provides a FUSE emulation layer which rclone uses combination with cgofuse. Both of these packages are by Bill Zissimopoulos who was very helpful during the implementation of rclone mount for Windows.

    Mounting modes on windows

    Unlike other operating systems, Microsoft Windows provides a different filesystem type for network and fixed drives. It optimises access on the assumption fixed disk drives are fast and reliable, while network drives have relatively high latency and less reliability. Some settings can also be differentiated between the two types, for example that Windows Explorer should just display icons and not create preview thumbnails for image and video files on network drives.

    In most cases, rclone will mount the remote as a normal, fixed disk drive by default. However, you can also choose to mount it as a remote network drive, often described as a network share. If you mount an rclone remote using the default, fixed drive mode and experience unexpected program errors, freezes or other issues, consider mounting as a network drive instead.

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

    Drives created as Administrator are not visible to other accounts, not even an account that was elevated to Administrator with the User Account Control (UAC) feature. A result of this is that if you mount to a drive letter from a Command Prompt run as Administrator, and then try to access the same drive from Windows Explorer (which does not run as Administrator), you will not be able to see the mounted drive.

    If you don't need to access the drive from applications running with administrative privileges, the easiest way around this is to always create the mount from a non-elevated command prompt.

    To make mapped drives available to the user account that created them regardless if elevated or not, there is a special Windows setting called linked connections that can be enabled.

    -

    It is also possible to make a drive mount available to everyone on the system, by running the process creating it as the built-in SYSTEM account. There are several ways to do this: One is to use the command-line utility PsExec, from Microsoft's Sysinternals suite, which has option -s to start processes as the SYSTEM account. Another alternative is to run the mount command from a Windows Scheduled Task, or a Windows Service, configured to run as the SYSTEM account. A third alternative is to use the WinFsp.Launcher infrastructure). Note that when running rclone as another user, it will not use the configuration file from your profile unless you tell it to with the --config option. Read more in the install documentation.

    +

    It is also possible to make a drive mount available to everyone on the system, by running the process creating it as the built-in SYSTEM account. There are several ways to do this: One is to use the command-line utility PsExec, from Microsoft's Sysinternals suite, which has option -s to start processes as the SYSTEM account. Another alternative is to run the mount command from a Windows Scheduled Task, or a Windows Service, configured to run as the SYSTEM account. A third alternative is to use the WinFsp.Launcher infrastructure). Note that when running rclone as another user, it will not use the configuration file from your profile unless you tell it to with the --config option. Read more in the install documentation.

    Note that mapping to a directory path, instead of a drive letter, does not suffer from the same limitations.

    Limitations

    Without the use of --vfs-cache-mode 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 rclone mount without --vfs-cache-mode writes or --vfs-cache-mode full. See the VFS File Caching section for more info.

    @@ -1936,7 +1937,7 @@ WantedBy=multi-user.target

    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

    -

    Using the --dir-cache-time flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the mount will appear immediately or invalidate the cache.

    +

    Using the --dir-cache-time flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache.

    --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)

    However, changes made directly on the cloud storage by the web 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 picked up within the polling interval.

    @@ -2013,19 +2014,19 @@ WantedBy=multi-user.target 
    --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.
    +--read-only Only allow read-only access.

    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 on disk cache file.

    --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)
    -

    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).

    +

    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 the cache (the related global flag --checkers has no effect on the VFS).

    --transfers int  Number of file transfers to run in parallel (default 4)

    VFS Case Sensitivity

    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.

    Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default.

    -

    The --vfs-case-insensitive mount flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the mounted file system as-is. If the flag is "true" (or appears without a value on 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.

    +

    The --vfs-case-insensitive VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the 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 the remote. 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 the underlying remote.

    +

    Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target.

    If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true".

    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.

    @@ -2058,7 +2059,7 @@ WantedBy=multi-user.target --noapplexattr Ignore all "com.apple.*" extended attributes (supported on OSX only) -o, --option stringArray Option for libfuse/WinFsp (repeat if required) --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) --vfs-cache-max-age duration Max age of objects in the cache (default 1h0m0s) @@ -2299,7 +2300,7 @@ ffmpeg - | rclone rcat remote:path/to/file

    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

    -

    Using the --dir-cache-time flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the mount will appear immediately or invalidate the cache.

    +

    Using the --dir-cache-time flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache.

    --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)

    However, changes made directly on the cloud storage by the web 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 picked up within the polling interval.

    @@ -2376,19 +2377,19 @@ ffmpeg - | rclone rcat remote:path/to/file 
    --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.
    +--read-only Only allow read-only access.

    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 on disk cache file.

    --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)
    -

    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).

    +

    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 the cache (the related global flag --checkers has no effect on the VFS).

    --transfers int  Number of file transfers to run in parallel (default 4)

    VFS Case Sensitivity

    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.

    Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default.

    -

    The --vfs-case-insensitive mount flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the mounted file system as-is. If the flag is "true" (or appears without a value on 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.

    +

    The --vfs-case-insensitive VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the 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 the remote. 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 the underlying remote.

    +

    Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target.

    If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true".

    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.

    @@ -2407,7 +2408,7 @@ ffmpeg - | rclone rcat remote:path/to/file --no-modtime Don't read/write the modification time (can speed things up) --no-seek Don't allow seeking in files --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) --vfs-cache-max-age duration Max age of objects in the cache (default 1h0m0s) @@ -2442,7 +2443,7 @@ ffmpeg - | rclone rcat remote:path/to/file

    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

    -

    Using the --dir-cache-time flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the mount will appear immediately or invalidate the cache.

    +

    Using the --dir-cache-time flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache.

    --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)

    However, changes made directly on the cloud storage by the web 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 picked up within the polling interval.

    @@ -2519,19 +2520,19 @@ ffmpeg - | rclone rcat remote:path/to/file 
    --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.
    +--read-only Only allow read-only access.

    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 on disk cache file.

    --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)
    -

    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).

    +

    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 the cache (the related global flag --checkers has no effect on the VFS).

    --transfers int  Number of file transfers to run in parallel (default 4)

    VFS Case Sensitivity

    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.

    Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default.

    -

    The --vfs-case-insensitive mount flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the mounted file system as-is. If the flag is "true" (or appears without a value on 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.

    +

    The --vfs-case-insensitive VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the 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 the remote. 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 the underlying remote.

    +

    Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target.

    If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true".

    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.

    @@ -2567,7 +2568,7 @@ ffmpeg - | rclone rcat remote:path/to/file --noapplexattr Ignore all "com.apple.*" extended attributes (supported on OSX only) -o, --option stringArray Option for libfuse/WinFsp (repeat if required) --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --socket-addr string Address <host:port> or absolute path (default: /run/docker/plugins/rclone.sock) --socket-gid int GID for unix socket (default: current process GID) (default 1000) --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) @@ -2606,7 +2607,7 @@ ffmpeg - | rclone rcat remote:path/to/file

    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

    -

    Using the --dir-cache-time flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the mount will appear immediately or invalidate the cache.

    +

    Using the --dir-cache-time flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache.

    --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)

    However, changes made directly on the cloud storage by the web 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 picked up within the polling interval.

    @@ -2683,19 +2684,19 @@ ffmpeg - | rclone rcat remote:path/to/file 
    --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.
    +--read-only Only allow read-only access.

    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 on disk cache file.

    --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)
    -

    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).

    +

    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 the cache (the related global flag --checkers has no effect on the VFS).

    --transfers int  Number of file transfers to run in parallel (default 4)

    VFS Case Sensitivity

    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.

    Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default.

    -

    The --vfs-case-insensitive mount flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the mounted file system as-is. If the flag is "true" (or appears without a value on 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.

    +

    The --vfs-case-insensitive VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the 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 the remote. 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 the underlying remote.

    +

    Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target.

    If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true".

    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.

    @@ -2748,7 +2749,7 @@ ffmpeg - | rclone rcat remote:path/to/file --passive-port string Passive port range to use (default "30000-32000") --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) --public-ip string Public IP address to advertise for passive connections - --read-only Mount read-only + --read-only Only allow read-only access --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) --user string User name for authentication (default "anonymous") @@ -2881,7 +2882,7 @@ htpasswd -B htpasswd anotherUser

    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

    -

    Using the --dir-cache-time flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the mount will appear immediately or invalidate the cache.

    +

    Using the --dir-cache-time flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache.

    --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)

    However, changes made directly on the cloud storage by the web 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 picked up within the polling interval.

    @@ -2958,19 +2959,19 @@ htpasswd -B htpasswd anotherUser 
    --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.
    +--read-only Only allow read-only access.

    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 on disk cache file.

    --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)
    -

    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).

    +

    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 the cache (the related global flag --checkers has no effect on the VFS).

    --transfers int  Number of file transfers to run in parallel (default 4)

    VFS Case Sensitivity

    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.

    Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default.

    -

    The --vfs-case-insensitive mount flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the mounted file system as-is. If the flag is "true" (or appears without a value on 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.

    +

    The --vfs-case-insensitive VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the 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 the remote. 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 the underlying remote.

    +

    Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target.

    If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true".

    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.

    @@ -2994,7 +2995,7 @@ htpasswd -B htpasswd anotherUser --no-seek Don't allow seeking in files --pass string Password for authentication --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --realm string Realm for authentication --salt string Password hashing salt (default "dlPL2MqE") --server-read-timeout duration Timeout for server reading data (default 1h0m0s) @@ -3207,7 +3208,7 @@ htpasswd -B htpasswd anotherUser

    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

    -

    Using the --dir-cache-time flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the mount will appear immediately or invalidate the cache.

    +

    Using the --dir-cache-time flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache.

    --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)

    However, changes made directly on the cloud storage by the web 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 picked up within the polling interval.

    @@ -3284,19 +3285,19 @@ htpasswd -B htpasswd anotherUser 
    --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.
    +--read-only Only allow read-only access.

    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 on disk cache file.

    --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)
    -

    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).

    +

    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 the cache (the related global flag --checkers has no effect on the VFS).

    --transfers int  Number of file transfers to run in parallel (default 4)

    VFS Case Sensitivity

    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.

    Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default.

    -

    The --vfs-case-insensitive mount flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the mounted file system as-is. If the flag is "true" (or appears without a value on 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.

    +

    The --vfs-case-insensitive VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the 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 the remote. 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 the underlying remote.

    +

    Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target.

    If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true".

    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.

    @@ -3348,7 +3349,7 @@ htpasswd -B htpasswd anotherUser --no-seek Don't allow seeking in files --pass string Password for authentication --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --stdio Run an sftp server on run stdin/stdout --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) @@ -3482,7 +3483,7 @@ htpasswd -B htpasswd anotherUser

    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

    -

    Using the --dir-cache-time flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the mount will appear immediately or invalidate the cache.

    +

    Using the --dir-cache-time flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache.

    --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)

    However, changes made directly on the cloud storage by the web 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 picked up within the polling interval.

    @@ -3559,19 +3560,19 @@ htpasswd -B htpasswd anotherUser 
    --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.
    +--read-only Only allow read-only access.

    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 on disk cache file.

    --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)
    -

    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).

    +

    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 the cache (the related global flag --checkers has no effect on the VFS).

    --transfers int  Number of file transfers to run in parallel (default 4)

    VFS Case Sensitivity

    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.

    Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default.

    -

    The --vfs-case-insensitive mount flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the mounted file system as-is. If the flag is "true" (or appears without a value on 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.

    +

    The --vfs-case-insensitive VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the 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 the remote. 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 the underlying remote.

    +

    Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target.

    If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true".

    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.

    @@ -3628,7 +3629,7 @@ htpasswd -B htpasswd anotherUser --no-seek Don't allow seeking in files --pass string Password for authentication --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --realm string Realm for authentication (default "rclone") --server-read-timeout duration Timeout for server reading data (default 1h0m0s) --server-write-timeout duration Timeout for server writing data (default 1h0m0s) @@ -4118,11 +4119,11 @@ pass = PDPcQVVjVtzFY-GTdDFozqBhTdsPg3qH

    --human-readable

    Rclone commands output values for sizes (e.g. number of bytes) and counts (e.g. number of files) either as raw numbers, or in human-readable format.

    In human-readable format the values are scaled to larger units, indicated with a suffix shown after the value, and rounded to three decimals. Rclone consistently uses binary units (powers of 2) for sizes and decimal units (powers of 10) for counts. The unit prefix for size is according to IEC standard notation, e.g. Ki for kibi. Used with byte unit, 1 KiB means 1024 Byte. In list type of output, only the unit prefix appended to the value (e.g. 9.762Ki), while in more textual output the full unit is shown (e.g. 9.762 KiB). For counts the SI standard notation is used, e.g. prefix k for kilo. Used with file counts, 1k means 1000 files.

    -

    The various list commands output raw numbers by default. Option --human-readable will make them output values in human-readable format instead (with the short unit prefix).

    -

    The about command outputs human-readable by default, with a command-specific option --full to output the raw numbers instead.

    -

    Command size outputs both human-readable and raw numbers in the same output.

    -

    The tree command also considers --human-readable, but it will not use the exact same notation as the other commands: It rounds to one decimal, and uses single letter suffix, e.g. K instead of Ki. The reason for this is that it relies on an external library.

    -

    The interactive command ncdu shows human-readable by default, and responds to key u for toggling human-readable format.

    +

    The various list commands output raw numbers by default. Option --human-readable will make them output values in human-readable format instead (with the short unit prefix).

    +

    The about command outputs human-readable by default, with a command-specific option --full to output the raw numbers instead.

    +

    Command size outputs both human-readable and raw numbers in the same output.

    +

    The tree command also considers --human-readable, but it will not use the exact same notation as the other commands: It rounds to one decimal, and uses single letter suffix, e.g. K instead of Ki. The reason for this is that it relies on an external library.

    +

    The interactive command ncdu shows human-readable by default, and responds to key u for toggling human-readable format.

    --ignore-case-sync

    Using this option will cause rclone to ignore the case of the files when synchronizing so files will not be copied/synced when the existing filenames are the same, even if the casing is different.

    --ignore-checksum

    @@ -4434,6 +4435,7 @@ y/n/s/!/q> n

    --transfers=N

    The number of file transfers to run in parallel. It can sometimes be useful to set this to a smaller number if the remote is giving a lot of timeouts or bigger if you have lots of bandwidth and a fast remote.

    The default is to run 4 file transfers in parallel.

    +

    Look at --multi-thread-streams if you would like to control single file transfers.

    -u, --update

    This forces rclone to skip any files which exist on the destination and have a modified time that is newer than the source file.

    This can be useful in avoiding needless transfers when transferring to a remote which doesn't support modification times directly (or when using --use-server-modtime to avoid extra API calls) as it is more accurate than a --size-only check and faster than using --checksum. On such remotes (or when using --use-server-modtime) the time checked will be the uploaded time.

    @@ -7805,7 +7807,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 (default "rclone/v1.58.0") + --user-agent string Set the user-agent to a specified string (default "rclone/v1.58.1") -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.

    @@ -9556,6 +9558,7 @@ y/e/d> y
  • AWS S3
  • Alibaba Cloud (Aliyun) Object Storage System (OSS)
  • Ceph
    • +
  • China Mobile Ecloud Elastic Object Storage (EOS)
  • DigitalOcean Spaces
  • Dreamhost
  • IBM COS S3
    • @@ -9593,7 +9596,7 @@ name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] -XX / Amazon S3 Compliant Storage Providers including AWS, Ceph, Dreamhost, IBM COS, Minio, and Tencent COS +XX / Amazon S3 Compliant Storage Providers including AWS, Ceph, ChinaMobile, Dreamhost, IBM COS, Minio, and Tencent COS \ "s3" [snip] Storage> s3 @@ -9979,7 +9982,7 @@ y/e/d>

    As mentioned in the Hashes section, small files that are not uploaded as multipart, use a different tag, causing the upload to fail. A simple solution is to set the --s3-upload-cutoff 0 and force all the files to be uploaded as multipart.

    Standard options

    -

    Here are the standard options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, RackCorp, SeaweedFS, and Tencent COS).

    +

    Here are the standard options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Digital Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, Netease, RackCorp, Scaleway, SeaweedFS, StackPath, Storj, Tencent COS and Wasabi).

    --s3-provider

    Choose your S3 provider.

    Properties:

    @@ -10002,6 +10005,10 @@ y/e/d> +
  • "ChinaMobile" +
  • "DigitalOcean"
    • -

    --s3-endpoint

    +

    --s3-endpoint

    Endpoint for OSS API.

    Properties:

    -

    --s3-endpoint

    +

    --s3-endpoint

    Endpoint for Scaleway Object Storage.

    Properties:

    -

    --s3-endpoint

    +

    --s3-endpoint

    Endpoint for StackPath Object Storage.

    Properties:

    -

    --s3-endpoint

    +

    --s3-endpoint

    Endpoint of the Shared Gateway.

    Properties:

    -

    --s3-endpoint

    +

    --s3-endpoint

    Endpoint for Tencent COS API.

    Properties:

    -

    --s3-endpoint

    +

    --s3-endpoint

    Endpoint for RackCorp Object Storage.

    Properties:

    -

    --s3-endpoint

    +

    --s3-endpoint

    Endpoint for S3 API.

    Required when using an S3 clone.

    Properties:

    --s3-location-constraint

    +

    Location constraint - must match endpoint.

    +

    Used when creating buckets only.

    +

    Properties:

    + +

    --s3-location-constraint

    Location constraint - must match endpoint when using IBM Cloud Public.

    For on-prem COS, do not make a selection from this list, hit enter.

    Properties:

    @@ -11331,7 +11606,7 @@ y/e/d> -

    --s3-location-constraint

    +

    --s3-location-constraint

    Location constraint - the location where your bucket will be located and your data stored.

    Properties:

    -

    --s3-location-constraint

    +

    --s3-location-constraint

    Location constraint - must be set to match the Region.

    Leave blank if not sure. Used when creating buckets only.

    Properties:

    @@ -11515,7 +11790,7 @@ y/e/d>

    --s3-storage-class

    +

    The storage class to use when storing new objects in ChinaMobile.

    +

    Properties:

    + +

    --s3-storage-class

    The storage class to use when storing new objects in Tencent COS.

    Properties:

    -

    --s3-storage-class

    +

    --s3-storage-class

    The storage class to use when storing new objects in S3.

    Properties:

    Advanced options

    -

    Here are the advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, RackCorp, SeaweedFS, and Tencent COS).

    +

    Here are the advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Digital Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, Netease, RackCorp, Scaleway, SeaweedFS, StackPath, Storj, Tencent COS and Wasabi).

    --s3-bucket-acl

    Canned ACL used when creating buckets.

    For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl

    @@ -11742,7 +12046,7 @@ y/e/d> -

    Limitations

    +

    Limitations

    SFTP supports checksums if the same login has shell access and md5sum or sha1sum as well as echo are in the remote's PATH. This remote checksumming (file hashing) is recommended and enabled by default. Disabling the checksumming may be required if you are connecting to SFTP servers which are not under your control, and to which the execution of remote commands is prohibited. Set the configuration option disable_hashcheck to true to disable checksumming.

    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.

    @@ -22784,9 +23335,6 @@ known_hosts_file = ~/.ssh/known_hosts

    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 and --contimeout are both supported.

    -

    C14

    -

    C14 is supported through the SFTP backend.

    -

    See C14's documentation

    rsync.net

    rsync.net is supported through the SFTP backend.

    See rsync.net's documentation of rclone examples.

    @@ -22849,7 +23397,7 @@ known_hosts_file = ~/.ssh/known_hosts
  • S3 backend: secret encryption key is shared with the gateway
    • -

    Configuration

    +

    Configuration

    To make a new Storj configuration you need one of the following: * Access Grant that someone else shared with you. * API Key of a Storj project you are a member of.

    Here is an example of how to make a remote called remote. First run:

     rclone config
    @@ -23079,7 +23627,7 @@ y/e/d> y 
    rclone sync -i --progress remote-us:bucket/path/to/dir/ remote-europe:bucket/path/to/dir/

    Or even between another cloud storage and Storj.

    rclone sync -i --progress s3:bucket/path/to/dir/ storj:bucket/path/to/dir/
    -

    Limitations

    +

    Limitations

    rclone about is not supported by the rclone Storj backend. Backends without this capability cannot determine free space for an rclone mount or use policy mfs (most free space) as a member of an rclone union remote.

    See List of backends that do not support rclone about See rclone about

    Known issues

    @@ -23087,7 +23635,7 @@ y/e/d> y

    To fix these, please raise your system limits. You can do this issuing a ulimit -n 65536 just before you run rclone. To change the limits more permanently you can add this to your shell startup script, e.g. $HOME/.bashrc, or change the system-wide configuration, usually /etc/sysctl.conf and/or /etc/security/limits.conf, but please refer to your operating system manual.

    SugarSync

    SugarSync is a cloud service that enables active synchronization of files across computers and other devices for file backup, access, syncing, and sharing.

    -

    Configuration

    +

    Configuration

    The initial setup for SugarSync involves getting a token from SugarSync which you can do with rclone. rclone config walks you through it.

    Here is an example of how to make a remote called remote. First run:

     rclone config
    @@ -23273,7 +23821,7 @@ y/e/d> y
  • Type: MultiEncoder
  • Default: Slash,Ctl,InvalidUtf8,Dot
    • -

    Limitations

    +

    Limitations

    rclone about is not supported by the SugarSync backend. Backends without this capability cannot determine free space for an rclone mount or use policy mfs (most free space) as a member of an rclone union remote.

    See List of backends that do not support rclone about See rclone about

    Tardigrade

    @@ -23282,7 +23830,7 @@ y/e/d> y

    This is a Backend for Uptobox file storage service. Uptobox is closer to a one-click hoster than a traditional cloud storage provider and therefore not suitable for long term storage.

    Paths are specified as remote:path

    Paths may be as deep as required, e.g. remote:directory/subdirectory.

    -

    Configuration

    +

    Configuration

    To configure an Uptobox backend you'll need your personal api token. You'll find it in your account settings

    Here is an example of how to make a remote called remote with the default setup. First run:

    rclone config
    @@ -23386,7 +23934,7 @@ y/e/d>
  • Type: MultiEncoder
  • Default: Slash,LtGt,DoubleQuote,BackQuote,Del,Ctl,LeftSpace,InvalidUtf8,Dot
    • -

    Limitations

    +

    Limitations

    Uptobox will delete inactive files that have not been accessed in 60 days.

    rclone about is not supported by this backend an overview of used space can however been seen in the uptobox web interface.

    Union

    @@ -23396,7 +23944,7 @@ y/e/d>

    Attribute :ro and :nc can be attach to the end of path to tag the remote as read only or no create, e.g. remote:directory/subdirectory:ro or remote:directory/subdirectory:nc.

    Subfolders can be used in upstream remotes. Assume a union remote named backup with the remotes mydrive:private/backup. Invoking rclone mkdir backup:desktop is exactly the same as invoking rclone mkdir mydrive:private/backup/desktop.

    There will be no special handling of paths containing .. segments. Invoking rclone mkdir backup:../desktop is exactly the same as invoking rclone mkdir mydrive:private/backup/../desktop.

    -

    Configuration

    +

    Configuration

    Here is an example of how to make a union called remote for local folders. First run:

     rclone config

    This will guide you through an interactive setup process:

    @@ -23669,7 +24217,7 @@ e/n/d/r/c/s/q> q

    WebDAV

    Paths are specified as remote:path

    Paths may be as deep as required, e.g. remote:directory/subdirectory.

    -

    Configuration

    +

    Configuration

    To configure the WebDAV remote you will need to have a URL for it, and a username and password. If you know what kind of system you are connecting to then rclone can enable extra features.

    Here is an example of how to make a remote called remote. First run:

     rclone config
    @@ -23922,7 +24470,7 @@ vendor = other bearer_token_command = oidc-token XDC

    Yandex Disk

    Yandex Disk is a cloud storage solution created by Yandex.

    -

    Configuration

    +

    Configuration

    Here is an example of making a yandex configuration. First run

    rclone config

    This will guide you through an interactive setup process:

    @@ -24058,13 +24606,13 @@ y/e/d> y
  • Type: MultiEncoder
  • Default: Slash,Del,Ctl,InvalidUtf8,Dot
    • -

    Limitations

    +

    Limitations

    When uploading very large files (bigger than about 5 GiB) you will need to increase the --timeout parameter. This is because Yandex pauses (perhaps to calculate the MD5SUM for the entire file) before returning confirmation that the file has been uploaded. The default handling of timeouts in rclone is to assume a 5 minute pause is an error and close the connection - you'll see net/http: timeout awaiting response headers errors in the logs if this is happening. Setting the timeout to twice the max size of file in GiB should be enough, so if you want to upload a 30 GiB file set a timeout of 2 * 30 = 60m, that is --timeout 60m.

    Having a Yandex Mail account is mandatory to use the Yandex.Disk subscription. Token generation will work without a mail account, but Rclone won't be able to complete any actions.

    [403 - DiskUnsupportedUserAccountTypeError] User account type is not supported.

    Zoho Workdrive

    Zoho WorkDrive is a cloud storage solution created by Zoho.

    -

    Configuration

    +

    Configuration

    Here is an example of making a zoho configuration. First run

    rclone config

    This will guide you through an interactive setup process:

    @@ -24240,7 +24788,7 @@ y/e/d>

    Local paths are specified as normal filesystem paths, e.g. /path/to/wherever, so

    rclone sync -i /home/source /tmp/destination

    Will sync /home/source to /tmp/destination.

    -

    Configuration

    +

    Configuration

    For consistencies sake one can also configure a remote of type local in the config file, and access the local filesystem using rclone remote paths, e.g. remote:path/to/wherever, but it is probably easier not to.

    Modified time

    Rclone reads and writes the modified time using an accuracy determined by the OS. Typically this is 1ns on Linux, 10 ns on Windows and 1 Second on OS X.

    @@ -24791,6 +25339,75 @@ $ tree /tmp/b
  • "error": return an error based on option value

    • Changelog

    +

    v1.58.1 - 2022-04-29

    +

    See commits

    +

    v1.58.0 - 2022-03-18

    See commits

    Bugs and Limitations

    -

    Limitations

    +

    Limitations

    Directory timestamps aren't preserved

    Rclone doesn't currently preserve the timestamps of directories. This is because rclone only really considers objects when syncing.

    Rclone struggles with millions of files in a directory/bucket

    diff --git a/MANUAL.md b/MANUAL.md index 06b37f0d2..9dcc98a56 100644 --- a/MANUAL.md +++ b/MANUAL.md @@ -1,6 +1,6 @@ % rclone(1) User Manual % Nick Craig-Wood -% Mar 18, 2022 +% Apr 29, 2022 # Rclone syncs your files to cloud storage @@ -109,6 +109,7 @@ WebDAV or S3, that work out of the box.) - Backblaze B2 - Box - Ceph +- China Mobile Ecloud Elastic Object Storage (EOS) - Citrix ShareFile - C14 - DigitalOcean Spaces @@ -3539,10 +3540,10 @@ at all, then 1 PiB is set as both the total and the free size. To run rclone mount on Windows, you will need to download and install [WinFsp](http://www.secfs.net/winfsp/). -[WinFsp](https://github.com/billziss-gh/winfsp) is an open-source +[WinFsp](https://github.com/winfsp/winfsp) is an open-source Windows File System Proxy which makes it easy to write user space file systems for Windows. It provides a FUSE emulation layer which rclone -uses combination with [cgofuse](https://github.com/billziss-gh/cgofuse). +uses combination with [cgofuse](https://github.com/winfsp/cgofuse). Both of these packages are by Bill Zissimopoulos who was very helpful during the implementation of rclone mount for Windows. @@ -3692,7 +3693,7 @@ from Microsoft's Sysinternals suite, which has option `-s` to start processes as the SYSTEM account. Another alternative is to run the mount command from a Windows Scheduled Task, or a Windows Service, configured to run as the SYSTEM account. A third alternative is to use the -[WinFsp.Launcher infrastructure](https://github.com/billziss-gh/winfsp/wiki/WinFsp-Service-Architecture)). +[WinFsp.Launcher infrastructure](https://github.com/winfsp/winfsp/wiki/WinFsp-Service-Architecture)). Note that when running rclone as another user, it will not use the configuration file from your profile unless you tell it to with the [`--config`](https://rclone.org/docs/#config-config-file) option. @@ -3874,7 +3875,7 @@ about files and directories (but not the data) in memory. Using the `--dir-cache-time` flag, you can control how long a directory should be considered up to date and not refreshed from the -backend. Changes made through the mount will appear immediately or +backend. Changes made through the VFS will appear immediately or invalidate the cache. --dir-cache-time duration Time to cache directory entries for (default 5m0s) @@ -4071,7 +4072,7 @@ 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. + --read-only Only allow read-only access. 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 @@ -4083,7 +4084,7 @@ on disk cache file. 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). +modified files from the cache (the related global flag `--checkers` has no effect on the VFS). --transfers int Number of file transfers to run in parallel (default 4) @@ -4100,22 +4101,22 @@ It is not allowed for two files in the same directory to differ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. -The `--vfs-case-insensitive` mount flag controls how rclone handles these -two cases. If its value is "false", rclone passes file names to the mounted -file system as-is. If the flag is "true" (or appears without a value on +The `--vfs-case-insensitive` VFS flag controls how rclone handles these +two cases. If its value is "false", rclone passes file names to the remote +as-is. If the flag is "true" (or appears without a value on the 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 +different than what is stored on the remote. 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. +controlled by the underlying remote. 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). +may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. If the flag is not provided on the command line, then its default value depends @@ -4169,7 +4170,7 @@ rclone mount remote:path /path/to/mountpoint [flags] --noapplexattr Ignore all "com.apple.*" extended attributes (supported on OSX only) -o, --option stringArray Option for libfuse/WinFsp (repeat if required) --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) --vfs-cache-max-age duration Max age of objects in the cache (default 1h0m0s) @@ -4723,7 +4724,7 @@ about files and directories (but not the data) in memory. Using the `--dir-cache-time` flag, you can control how long a directory should be considered up to date and not refreshed from the -backend. Changes made through the mount will appear immediately or +backend. Changes made through the VFS will appear immediately or invalidate the cache. --dir-cache-time duration Time to cache directory entries for (default 5m0s) @@ -4920,7 +4921,7 @@ 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. + --read-only Only allow read-only access. 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 @@ -4932,7 +4933,7 @@ on disk cache file. 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). +modified files from the cache (the related global flag `--checkers` has no effect on the VFS). --transfers int Number of file transfers to run in parallel (default 4) @@ -4949,22 +4950,22 @@ It is not allowed for two files in the same directory to differ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. -The `--vfs-case-insensitive` mount flag controls how rclone handles these -two cases. If its value is "false", rclone passes file names to the mounted -file system as-is. If the flag is "true" (or appears without a value on +The `--vfs-case-insensitive` VFS flag controls how rclone handles these +two cases. If its value is "false", rclone passes file names to the remote +as-is. If the flag is "true" (or appears without a value on the 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 +different than what is stored on the remote. 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. +controlled by the underlying remote. 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). +may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. If the flag is not provided on the command line, then its default value depends @@ -5004,7 +5005,7 @@ rclone serve dlna remote:path [flags] --no-modtime Don't read/write the modification time (can speed things up) --no-seek Don't allow seeking in files --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) --vfs-cache-max-age duration Max age of objects in the cache (default 1h0m0s) @@ -5091,7 +5092,7 @@ about files and directories (but not the data) in memory. Using the `--dir-cache-time` flag, you can control how long a directory should be considered up to date and not refreshed from the -backend. Changes made through the mount will appear immediately or +backend. Changes made through the VFS will appear immediately or invalidate the cache. --dir-cache-time duration Time to cache directory entries for (default 5m0s) @@ -5288,7 +5289,7 @@ 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. + --read-only Only allow read-only access. 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 @@ -5300,7 +5301,7 @@ on disk cache file. 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). +modified files from the cache (the related global flag `--checkers` has no effect on the VFS). --transfers int Number of file transfers to run in parallel (default 4) @@ -5317,22 +5318,22 @@ It is not allowed for two files in the same directory to differ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. -The `--vfs-case-insensitive` mount flag controls how rclone handles these -two cases. If its value is "false", rclone passes file names to the mounted -file system as-is. If the flag is "true" (or appears without a value on +The `--vfs-case-insensitive` VFS flag controls how rclone handles these +two cases. If its value is "false", rclone passes file names to the remote +as-is. If the flag is "true" (or appears without a value on the 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 +different than what is stored on the remote. 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. +controlled by the underlying remote. 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). +may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. If the flag is not provided on the command line, then its default value depends @@ -5389,7 +5390,7 @@ rclone serve docker [flags] --noapplexattr Ignore all "com.apple.*" extended attributes (supported on OSX only) -o, --option stringArray Option for libfuse/WinFsp (repeat if required) --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --socket-addr string Address or absolute path (default: /run/docker/plugins/rclone.sock) --socket-gid int GID for unix socket (default: current process GID) (default 1000) --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) @@ -5461,7 +5462,7 @@ about files and directories (but not the data) in memory. Using the `--dir-cache-time` flag, you can control how long a directory should be considered up to date and not refreshed from the -backend. Changes made through the mount will appear immediately or +backend. Changes made through the VFS will appear immediately or invalidate the cache. --dir-cache-time duration Time to cache directory entries for (default 5m0s) @@ -5658,7 +5659,7 @@ 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. + --read-only Only allow read-only access. 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 @@ -5670,7 +5671,7 @@ on disk cache file. 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). +modified files from the cache (the related global flag `--checkers` has no effect on the VFS). --transfers int Number of file transfers to run in parallel (default 4) @@ -5687,22 +5688,22 @@ It is not allowed for two files in the same directory to differ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. -The `--vfs-case-insensitive` mount flag controls how rclone handles these -two cases. If its value is "false", rclone passes file names to the mounted -file system as-is. If the flag is "true" (or appears without a value on +The `--vfs-case-insensitive` VFS flag controls how rclone handles these +two cases. If its value is "false", rclone passes file names to the remote +as-is. If the flag is "true" (or appears without a value on the 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 +different than what is stored on the remote. 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. +controlled by the underlying remote. 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). +may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. If the flag is not provided on the command line, then its default value depends @@ -5827,7 +5828,7 @@ rclone serve ftp remote:path [flags] --passive-port string Passive port range to use (default "30000-32000") --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) --public-ip string Public IP address to advertise for passive connections - --read-only Mount read-only + --read-only Only allow read-only access --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) --user string User name for authentication (default "anonymous") @@ -5972,7 +5973,7 @@ about files and directories (but not the data) in memory. Using the `--dir-cache-time` flag, you can control how long a directory should be considered up to date and not refreshed from the -backend. Changes made through the mount will appear immediately or +backend. Changes made through the VFS will appear immediately or invalidate the cache. --dir-cache-time duration Time to cache directory entries for (default 5m0s) @@ -6169,7 +6170,7 @@ 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. + --read-only Only allow read-only access. 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 @@ -6181,7 +6182,7 @@ on disk cache file. 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). +modified files from the cache (the related global flag `--checkers` has no effect on the VFS). --transfers int Number of file transfers to run in parallel (default 4) @@ -6198,22 +6199,22 @@ It is not allowed for two files in the same directory to differ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. -The `--vfs-case-insensitive` mount flag controls how rclone handles these -two cases. If its value is "false", rclone passes file names to the mounted -file system as-is. If the flag is "true" (or appears without a value on +The `--vfs-case-insensitive` VFS flag controls how rclone handles these +two cases. If its value is "false", rclone passes file names to the remote +as-is. If the flag is "true" (or appears without a value on the 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 +different than what is stored on the remote. 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. +controlled by the underlying remote. 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). +may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. If the flag is not provided on the command line, then its default value depends @@ -6258,7 +6259,7 @@ rclone serve http remote:path [flags] --no-seek Don't allow seeking in files --pass string Password for authentication --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --realm string Realm for authentication --salt string Password hashing salt (default "dlPL2MqE") --server-read-timeout duration Timeout for server reading data (default 1h0m0s) @@ -6564,7 +6565,7 @@ about files and directories (but not the data) in memory. Using the `--dir-cache-time` flag, you can control how long a directory should be considered up to date and not refreshed from the -backend. Changes made through the mount will appear immediately or +backend. Changes made through the VFS will appear immediately or invalidate the cache. --dir-cache-time duration Time to cache directory entries for (default 5m0s) @@ -6761,7 +6762,7 @@ 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. + --read-only Only allow read-only access. 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 @@ -6773,7 +6774,7 @@ on disk cache file. 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). +modified files from the cache (the related global flag `--checkers` has no effect on the VFS). --transfers int Number of file transfers to run in parallel (default 4) @@ -6790,22 +6791,22 @@ It is not allowed for two files in the same directory to differ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. -The `--vfs-case-insensitive` mount flag controls how rclone handles these -two cases. If its value is "false", rclone passes file names to the mounted -file system as-is. If the flag is "true" (or appears without a value on +The `--vfs-case-insensitive` VFS flag controls how rclone handles these +two cases. If its value is "false", rclone passes file names to the remote +as-is. If the flag is "true" (or appears without a value on the 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 +different than what is stored on the remote. 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. +controlled by the underlying remote. 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). +may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. If the flag is not provided on the command line, then its default value depends @@ -6929,7 +6930,7 @@ rclone serve sftp remote:path [flags] --no-seek Don't allow seeking in files --pass string Password for authentication --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --stdio Run an sftp server on run stdin/stdout --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) @@ -7079,7 +7080,7 @@ about files and directories (but not the data) in memory. Using the `--dir-cache-time` flag, you can control how long a directory should be considered up to date and not refreshed from the -backend. Changes made through the mount will appear immediately or +backend. Changes made through the VFS will appear immediately or invalidate the cache. --dir-cache-time duration Time to cache directory entries for (default 5m0s) @@ -7276,7 +7277,7 @@ 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. + --read-only Only allow read-only access. 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 @@ -7288,7 +7289,7 @@ on disk cache file. 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). +modified files from the cache (the related global flag `--checkers` has no effect on the VFS). --transfers int Number of file transfers to run in parallel (default 4) @@ -7305,22 +7306,22 @@ It is not allowed for two files in the same directory to differ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. -The `--vfs-case-insensitive` mount flag controls how rclone handles these -two cases. If its value is "false", rclone passes file names to the mounted -file system as-is. If the flag is "true" (or appears without a value on +The `--vfs-case-insensitive` VFS flag controls how rclone handles these +two cases. If its value is "false", rclone passes file names to the remote +as-is. If the flag is "true" (or appears without a value on the 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 +different than what is stored on the remote. 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. +controlled by the underlying remote. 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). +may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. If the flag is not provided on the command line, then its default value depends @@ -7449,7 +7450,7 @@ rclone serve webdav remote:path [flags] --no-seek Don't allow seeking in files --pass string Password for authentication --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --realm string Realm for authentication (default "rclone") --server-read-timeout duration Timeout for server reading data (default 1h0m0s) --server-write-timeout duration Timeout for server writing data (default 1h0m0s) @@ -8608,22 +8609,22 @@ unit prefix appended to the value (e.g. `9.762Ki`), while in more textual output the full unit is shown (e.g. `9.762 KiB`). For counts the SI standard notation is used, e.g. prefix `k` for kilo. Used with file counts, `1k` means 1000 files. -The various [list](commands/rclone_ls/) commands output raw numbers by default. +The various [list](https://rclone.org/commands/rclone_ls/) commands output raw numbers by default. Option `--human-readable` will make them output values in human-readable format instead (with the short unit prefix). -The [about](commands/rclone_about/) command outputs human-readable by default, +The [about](https://rclone.org/commands/rclone_about/) command outputs human-readable by default, with a command-specific option `--full` to output the raw numbers instead. -Command [size](commands/rclone_size/) outputs both human-readable and raw numbers +Command [size](https://rclone.org/commands/rclone_size/) outputs both human-readable and raw numbers in the same output. -The [tree](commands/rclone_tree/) command also considers `--human-readable`, but +The [tree](https://rclone.org/commands/rclone_tree/) command also considers `--human-readable`, but it will not use the exact same notation as the other commands: It rounds to one decimal, and uses single letter suffix, e.g. `K` instead of `Ki`. The reason for this is that it relies on an external library. -The interactive command [ncdu](commands/rclone_ncdu/) shows human-readable by +The interactive command [ncdu](https://rclone.org/commands/rclone_ncdu/) shows human-readable by default, and responds to key `u` for toggling human-readable format. ### --ignore-case-sync ### @@ -9462,6 +9463,8 @@ of timeouts or bigger if you have lots of bandwidth and a fast remote. The default is to run 4 file transfers in parallel. +Look at --multi-thread-streams if you would like to control single file transfers. + ### -u, --update ### This forces rclone to skip any files which exist on the destination @@ -13526,7 +13529,7 @@ These flags are available for every command. --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 (default "rclone/v1.58.0") + --user-agent string Set the user-agent to a specified string (default "rclone/v1.58.1") -v, --verbose count Print lots more stuff (repeat for more) ``` @@ -16281,6 +16284,7 @@ The S3 backend can be used with a number of different providers: - AWS S3 - Alibaba Cloud (Aliyun) Object Storage System (OSS) - Ceph +- China Mobile Ecloud Elastic Object Storage (EOS) - DigitalOcean Spaces - Dreamhost - IBM COS S3 @@ -16339,7 +16343,7 @@ name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] -XX / Amazon S3 Compliant Storage Providers including AWS, Ceph, Dreamhost, IBM COS, Minio, and Tencent COS +XX / Amazon S3 Compliant Storage Providers including AWS, Ceph, ChinaMobile, Dreamhost, IBM COS, Minio, and Tencent COS \ "s3" [snip] Storage> s3 @@ -16836,7 +16840,7 @@ A simple solution is to set the `--s3-upload-cutoff 0` and force all the files t ### Standard options -Here are the standard options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, RackCorp, SeaweedFS, and Tencent COS). +Here are the standard options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Digital Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, Netease, RackCorp, Scaleway, SeaweedFS, StackPath, Storj, Tencent COS and Wasabi). #### --s3-provider @@ -16855,6 +16859,8 @@ Properties: - Alibaba Cloud Object Storage System (OSS) formerly Aliyun - "Ceph" - Ceph Object Storage + - "ChinaMobile" + - China Mobile Ecloud Elastic Object Storage (EOS) - "DigitalOcean" - Digital Ocean Spaces - "Dreamhost" @@ -17096,7 +17102,7 @@ Properties: - Config: region - Env Var: RCLONE_S3_REGION -- Provider: !AWS,Alibaba,RackCorp,Scaleway,Storj,TencentCOS +- Provider: !AWS,Alibaba,ChinaMobile,RackCorp,Scaleway,Storj,TencentCOS - Type: string - Required: false - Examples: @@ -17123,6 +17129,80 @@ Properties: #### --s3-endpoint +Endpoint for China Mobile Ecloud Elastic Object Storage (EOS) API. + +Properties: + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Provider: ChinaMobile +- Type: string +- Required: false +- Examples: + - "eos-wuxi-1.cmecloud.cn" + - The default endpoint - a good choice if you are unsure. + - East China (Suzhou) + - "eos-jinan-1.cmecloud.cn" + - East China (Jinan) + - "eos-ningbo-1.cmecloud.cn" + - East China (Hangzhou) + - "eos-shanghai-1.cmecloud.cn" + - East China (Shanghai-1) + - "eos-zhengzhou-1.cmecloud.cn" + - Central China (Zhengzhou) + - "eos-hunan-1.cmecloud.cn" + - Central China (Changsha-1) + - "eos-zhuzhou-1.cmecloud.cn" + - Central China (Changsha-2) + - "eos-guangzhou-1.cmecloud.cn" + - South China (Guangzhou-2) + - "eos-dongguan-1.cmecloud.cn" + - South China (Guangzhou-3) + - "eos-beijing-1.cmecloud.cn" + - North China (Beijing-1) + - "eos-beijing-2.cmecloud.cn" + - North China (Beijing-2) + - "eos-beijing-4.cmecloud.cn" + - North China (Beijing-3) + - "eos-huhehaote-1.cmecloud.cn" + - North China (Huhehaote) + - "eos-chengdu-1.cmecloud.cn" + - Southwest China (Chengdu) + - "eos-chongqing-1.cmecloud.cn" + - Southwest China (Chongqing) + - "eos-guiyang-1.cmecloud.cn" + - Southwest China (Guiyang) + - "eos-xian-1.cmecloud.cn" + - Nouthwest China (Xian) + - "eos-yunnan.cmecloud.cn" + - Yunnan China (Kunming) + - "eos-yunnan-2.cmecloud.cn" + - Yunnan China (Kunming-2) + - "eos-tianjin-1.cmecloud.cn" + - Tianjin China (Tianjin) + - "eos-jilin-1.cmecloud.cn" + - Jilin China (Changchun) + - "eos-hubei-1.cmecloud.cn" + - Hubei China (Xiangyan) + - "eos-jiangxi-1.cmecloud.cn" + - Jiangxi China (Nanchang) + - "eos-gansu-1.cmecloud.cn" + - Gansu China (Lanzhou) + - "eos-shanxi-1.cmecloud.cn" + - Shanxi China (Taiyuan) + - "eos-liaoning-1.cmecloud.cn" + - Liaoning China (Shenyang) + - "eos-hebei-1.cmecloud.cn" + - Hebei China (Shijiazhuang) + - "eos-fujian-1.cmecloud.cn" + - Fujian China (Xiamen) + - "eos-guangxi-1.cmecloud.cn" + - Guangxi China (Nanning) + - "eos-anhui-1.cmecloud.cn" + - Anhui China (Huainan) + +#### --s3-endpoint + Endpoint for IBM COS S3 API. Specify if using an IBM COS On Premise. @@ -17490,7 +17570,7 @@ Properties: - Config: endpoint - Env Var: RCLONE_S3_ENDPOINT -- Provider: !AWS,IBMCOS,TencentCOS,Alibaba,Scaleway,StackPath,Storj,RackCorp +- Provider: !AWS,IBMCOS,TencentCOS,Alibaba,ChinaMobile,Scaleway,StackPath,Storj,RackCorp - Type: string - Required: false - Examples: @@ -17588,6 +17668,81 @@ Properties: #### --s3-location-constraint +Location constraint - must match endpoint. + +Used when creating buckets only. + +Properties: + +- Config: location_constraint +- Env Var: RCLONE_S3_LOCATION_CONSTRAINT +- Provider: ChinaMobile +- Type: string +- Required: false +- Examples: + - "wuxi1" + - East China (Suzhou) + - "jinan1" + - East China (Jinan) + - "ningbo1" + - East China (Hangzhou) + - "shanghai1" + - East China (Shanghai-1) + - "zhengzhou1" + - Central China (Zhengzhou) + - "hunan1" + - Central China (Changsha-1) + - "zhuzhou1" + - Central China (Changsha-2) + - "guangzhou1" + - South China (Guangzhou-2) + - "dongguan1" + - South China (Guangzhou-3) + - "beijing1" + - North China (Beijing-1) + - "beijing2" + - North China (Beijing-2) + - "beijing4" + - North China (Beijing-3) + - "huhehaote1" + - North China (Huhehaote) + - "chengdu1" + - Southwest China (Chengdu) + - "chongqing1" + - Southwest China (Chongqing) + - "guiyang1" + - Southwest China (Guiyang) + - "xian1" + - Nouthwest China (Xian) + - "yunnan" + - Yunnan China (Kunming) + - "yunnan2" + - Yunnan China (Kunming-2) + - "tianjin1" + - Tianjin China (Tianjin) + - "jilin1" + - Jilin China (Changchun) + - "hubei1" + - Hubei China (Xiangyan) + - "jiangxi1" + - Jiangxi China (Nanchang) + - "gansu1" + - Gansu China (Lanzhou) + - "shanxi1" + - Shanxi China (Taiyuan) + - "liaoning1" + - Liaoning China (Shenyang) + - "hebei1" + - Hebei China (Shijiazhuang) + - "fujian1" + - Fujian China (Xiamen) + - "guangxi1" + - Guangxi China (Nanning) + - "anhui1" + - Anhui China (Huainan) + +#### --s3-location-constraint + Location constraint - must match endpoint when using IBM Cloud Public. For on-prem COS, do not make a selection from this list, hit enter. @@ -17727,7 +17882,7 @@ Properties: - Config: location_constraint - Env Var: RCLONE_S3_LOCATION_CONSTRAINT -- Provider: !AWS,IBMCOS,Alibaba,RackCorp,Scaleway,StackPath,Storj,TencentCOS +- Provider: !AWS,IBMCOS,Alibaba,ChinaMobile,RackCorp,Scaleway,StackPath,Storj,TencentCOS - Type: string - Required: false @@ -17799,7 +17954,7 @@ Properties: - Config: server_side_encryption - Env Var: RCLONE_S3_SERVER_SIDE_ENCRYPTION -- Provider: AWS,Ceph,Minio +- Provider: AWS,Ceph,ChinaMobile,Minio - Type: string - Required: false - Examples: @@ -17881,6 +18036,27 @@ Properties: #### --s3-storage-class +The storage class to use when storing new objects in ChinaMobile. + +Properties: + +- Config: storage_class +- Env Var: RCLONE_S3_STORAGE_CLASS +- Provider: ChinaMobile +- Type: string +- Required: false +- Examples: + - "" + - Default + - "STANDARD" + - Standard storage class + - "GLACIER" + - Archive storage mode + - "STANDARD_IA" + - Infrequent access storage mode + +#### --s3-storage-class + The storage class to use when storing new objects in Tencent COS. Properties: @@ -17923,7 +18099,7 @@ Properties: ### Advanced options -Here are the advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, RackCorp, SeaweedFS, and Tencent COS). +Here are the advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Digital Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, Netease, RackCorp, Scaleway, SeaweedFS, StackPath, Storj, Tencent COS and Wasabi). #### --s3-bucket-acl @@ -17975,7 +18151,7 @@ Properties: - Config: sse_customer_algorithm - Env Var: RCLONE_S3_SSE_CUSTOMER_ALGORITHM -- Provider: AWS,Ceph,Minio +- Provider: AWS,Ceph,ChinaMobile,Minio - Type: string - Required: false - Examples: @@ -17992,7 +18168,7 @@ Properties: - Config: sse_customer_key - Env Var: RCLONE_S3_SSE_CUSTOMER_KEY -- Provider: AWS,Ceph,Minio +- Provider: AWS,Ceph,ChinaMobile,Minio - Type: string - Required: false - Examples: @@ -18010,7 +18186,7 @@ Properties: - Config: sse_customer_key_md5 - Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_MD5 -- Provider: AWS,Ceph,Minio +- Provider: AWS,Ceph,ChinaMobile,Minio - Type: string - Required: false - Examples: @@ -18585,7 +18761,7 @@ Options: -### Anonymous access to public buckets ### +### Anonymous access to public buckets If you want to use rclone to access a public bucket, configure with a blank `access_key_id` and `secret_access_key`. Your config should end @@ -18791,7 +18967,7 @@ Choose a number from below, or type in your own value \ "alias" 2 / Amazon Drive \ "amazon cloud drive" - 3 / Amazon S3 Complaint Storage Providers (Dreamhost, Ceph, Minio, IBM COS) + 3 / Amazon S3 Complaint Storage Providers (Dreamhost, Ceph, ChinaMobile, Minio, IBM COS) \ "s3" 4 / Backblaze B2 \ "b2" @@ -19048,6 +19224,9 @@ server_side_encryption = storage_class = ``` +[C14 Cold Storage](https://www.online.net/en/storage/c14-cold-storage) is the low-cost S3 Glacier alternative from Scaleway and it works the same way as on S3 by accepting the "GLACIER" `storage_class`. +So you can configure your remote with the `storage_class = GLACIER` option to upload directly to C14. Don't forget that in this state you can't read files back after, you will need to restore them to "STANDARD" storage_class first before being able to read them (see "restore" section above) + ### Seagate Lyve Cloud {#lyve} [Seagate Lyve Cloud](https://www.seagate.com/gb/en/services/cloud/storage/) is an S3 @@ -19073,7 +19252,7 @@ Choose `s3` backend Type of storage to configure. Choose a number from below, or type in your own value. [snip] -XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, RackCorp, SeaweedFS, and Tencent COS +XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, ChinaMobile, Digital Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, RackCorp, SeaweedFS, and Tencent COS \ (s3) [snip] Storage> s3 @@ -19260,7 +19439,7 @@ name> wasabi Type of storage to configure. Choose a number from below, or type in your own value [snip] -XX / Amazon S3 (also Dreamhost, Ceph, Minio) +XX / Amazon S3 (also Dreamhost, Ceph, ChinaMobile, Minio) \ "s3" [snip] Storage> s3 @@ -19374,7 +19553,7 @@ Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [snip] - 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS + 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, ChinaMobile, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS \ "s3" [snip] Storage> s3 @@ -19464,6 +19643,256 @@ d) Delete this remote y/e/d> y ``` +### China Mobile Ecloud Elastic Object Storage (EOS) {#china-mobile-ecloud-eos} + +Here is an example of making an [China Mobile Ecloud Elastic Object Storage (EOS)](https:///ecloud.10086.cn/home/product-introduction/eos/) +configuration. First run: + + rclone config + +This will guide you through an interactive setup process. + +``` +No remotes found, make a new one? +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> ChinaMobile +Option Storage. +Type of storage to configure. +Choose a number from below, or type in your own value. + ... + 5 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, ChinaMobile, Digital Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, RackCorp, SeaweedFS, and Tencent COS + \ (s3) + ... +Storage> s3 +Option provider. +Choose your S3 provider. +Choose a number from below, or type in your own value. +Press Enter to leave empty. + ... + 4 / China Mobile Ecloud Elastic Object Storage (EOS) + \ (ChinaMobile) + ... +provider> ChinaMobile +Option env_auth. +Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). +Only applies if access_key_id and secret_access_key is blank. +Choose a number from below, or type in your own boolean value (true or false). +Press Enter for the default (false). + 1 / Enter AWS credentials in the next step. + \ (false) + 2 / Get AWS credentials from the environment (env vars or IAM). + \ (true) +env_auth> +Option access_key_id. +AWS Access Key ID. +Leave blank for anonymous access or runtime credentials. +Enter a value. Press Enter to leave empty. +access_key_id> accesskeyid +Option secret_access_key. +AWS Secret Access Key (password). +Leave blank for anonymous access or runtime credentials. +Enter a value. Press Enter to leave empty. +secret_access_key> secretaccesskey +Option endpoint. +Endpoint for China Mobile Ecloud Elastic Object Storage (EOS) API. +Choose a number from below, or type in your own value. +Press Enter to leave empty. + / The default endpoint - a good choice if you are unsure. + 1 | East China (Suzhou) + \ (eos-wuxi-1.cmecloud.cn) + 2 / East China (Jinan) + \ (eos-jinan-1.cmecloud.cn) + 3 / East China (Hangzhou) + \ (eos-ningbo-1.cmecloud.cn) + 4 / East China (Shanghai-1) + \ (eos-shanghai-1.cmecloud.cn) + 5 / Central China (Zhengzhou) + \ (eos-zhengzhou-1.cmecloud.cn) + 6 / Central China (Changsha-1) + \ (eos-hunan-1.cmecloud.cn) + 7 / Central China (Changsha-2) + \ (eos-zhuzhou-1.cmecloud.cn) + 8 / South China (Guangzhou-2) + \ (eos-guangzhou-1.cmecloud.cn) + 9 / South China (Guangzhou-3) + \ (eos-dongguan-1.cmecloud.cn) +10 / North China (Beijing-1) + \ (eos-beijing-1.cmecloud.cn) +11 / North China (Beijing-2) + \ (eos-beijing-2.cmecloud.cn) +12 / North China (Beijing-3) + \ (eos-beijing-4.cmecloud.cn) +13 / North China (Huhehaote) + \ (eos-huhehaote-1.cmecloud.cn) +14 / Southwest China (Chengdu) + \ (eos-chengdu-1.cmecloud.cn) +15 / Southwest China (Chongqing) + \ (eos-chongqing-1.cmecloud.cn) +16 / Southwest China (Guiyang) + \ (eos-guiyang-1.cmecloud.cn) +17 / Nouthwest China (Xian) + \ (eos-xian-1.cmecloud.cn) +18 / Yunnan China (Kunming) + \ (eos-yunnan.cmecloud.cn) +19 / Yunnan China (Kunming-2) + \ (eos-yunnan-2.cmecloud.cn) +20 / Tianjin China (Tianjin) + \ (eos-tianjin-1.cmecloud.cn) +21 / Jilin China (Changchun) + \ (eos-jilin-1.cmecloud.cn) +22 / Hubei China (Xiangyan) + \ (eos-hubei-1.cmecloud.cn) +23 / Jiangxi China (Nanchang) + \ (eos-jiangxi-1.cmecloud.cn) +24 / Gansu China (Lanzhou) + \ (eos-gansu-1.cmecloud.cn) +25 / Shanxi China (Taiyuan) + \ (eos-shanxi-1.cmecloud.cn) +26 / Liaoning China (Shenyang) + \ (eos-liaoning-1.cmecloud.cn) +27 / Hebei China (Shijiazhuang) + \ (eos-hebei-1.cmecloud.cn) +28 / Fujian China (Xiamen) + \ (eos-fujian-1.cmecloud.cn) +29 / Guangxi China (Nanning) + \ (eos-guangxi-1.cmecloud.cn) +30 / Anhui China (Huainan) + \ (eos-anhui-1.cmecloud.cn) +endpoint> 1 +Option location_constraint. +Location constraint - must match endpoint. +Used when creating buckets only. +Choose a number from below, or type in your own value. +Press Enter to leave empty. + 1 / East China (Suzhou) + \ (wuxi1) + 2 / East China (Jinan) + \ (jinan1) + 3 / East China (Hangzhou) + \ (ningbo1) + 4 / East China (Shanghai-1) + \ (shanghai1) + 5 / Central China (Zhengzhou) + \ (zhengzhou1) + 6 / Central China (Changsha-1) + \ (hunan1) + 7 / Central China (Changsha-2) + \ (zhuzhou1) + 8 / South China (Guangzhou-2) + \ (guangzhou1) + 9 / South China (Guangzhou-3) + \ (dongguan1) +10 / North China (Beijing-1) + \ (beijing1) +11 / North China (Beijing-2) + \ (beijing2) +12 / North China (Beijing-3) + \ (beijing4) +13 / North China (Huhehaote) + \ (huhehaote1) +14 / Southwest China (Chengdu) + \ (chengdu1) +15 / Southwest China (Chongqing) + \ (chongqing1) +16 / Southwest China (Guiyang) + \ (guiyang1) +17 / Nouthwest China (Xian) + \ (xian1) +18 / Yunnan China (Kunming) + \ (yunnan) +19 / Yunnan China (Kunming-2) + \ (yunnan2) +20 / Tianjin China (Tianjin) + \ (tianjin1) +21 / Jilin China (Changchun) + \ (jilin1) +22 / Hubei China (Xiangyan) + \ (hubei1) +23 / Jiangxi China (Nanchang) + \ (jiangxi1) +24 / Gansu China (Lanzhou) + \ (gansu1) +25 / Shanxi China (Taiyuan) + \ (shanxi1) +26 / Liaoning China (Shenyang) + \ (liaoning1) +27 / Hebei China (Shijiazhuang) + \ (hebei1) +28 / Fujian China (Xiamen) + \ (fujian1) +29 / Guangxi China (Nanning) + \ (guangxi1) +30 / Anhui China (Huainan) + \ (anhui1) +location_constraint> 1 +Option acl. +Canned ACL used when creating buckets and storing or copying objects. +This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too. +For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl +Note that this ACL is applied when server-side copying objects as S3 +doesn't copy the ACL from the source but rather writes a fresh one. +Choose a number from below, or type in your own value. +Press Enter to leave empty. + / Owner gets FULL_CONTROL. + 1 | No one else has access rights (default). + \ (private) + / Owner gets FULL_CONTROL. + 2 | The AllUsers group gets READ access. + \ (public-read) + / Owner gets FULL_CONTROL. + 3 | The AllUsers group gets READ and WRITE access. + | Granting this on a bucket is generally not recommended. + \ (public-read-write) + / Owner gets FULL_CONTROL. + 4 | The AuthenticatedUsers group gets READ access. + \ (authenticated-read) + / Object owner gets FULL_CONTROL. +acl> private +Option server_side_encryption. +The server-side encryption algorithm used when storing this object in S3. +Choose a number from below, or type in your own value. +Press Enter to leave empty. + 1 / None + \ () + 2 / AES256 + \ (AES256) +server_side_encryption> +Option storage_class. +The storage class to use when storing new objects in ChinaMobile. +Choose a number from below, or type in your own value. +Press Enter to leave empty. + 1 / Default + \ () + 2 / Standard storage class + \ (STANDARD) + 3 / Archive storage mode + \ (GLACIER) + 4 / Infrequent access storage mode + \ (STANDARD_IA) +storage_class> +Edit advanced config? +y) Yes +n) No (default) +y/n> n +-------------------- +[ChinaMobile] +type = s3 +provider = ChinaMobile +access_key_id = accesskeyid +secret_access_key = secretaccesskey +endpoint = eos-wuxi-1.cmecloud.cn +location_constraint = wuxi1 +acl = private +-------------------- +y) Yes this is OK (default) +e) Edit this remote +d) Delete this remote +y/e/d> y +``` + ### Tencent COS {#tencent-cos} [Tencent Cloud Object Storage (COS)](https://intl.cloud.tencent.com/product/cos) is a distributed storage service offered by Tencent Cloud for unstructured data. It is secure, stable, massive, convenient, low-delay and low-cost. @@ -19497,7 +19926,7 @@ Choose a number from below, or type in your own value \ "alias" 3 / Amazon Drive \ "amazon cloud drive" - 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS + 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, ChinaMobile, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS \ "s3" [snip] Storage> s3 @@ -29164,8 +29593,7 @@ set](https://rclone.org/overview/#restricted-characters). - Akamai NetStorage -------------------------------------------------- +# Akamai NetStorage Paths are specified as `remote:` You may put subdirectories in too, e.g. `remote:/path/to/dir`. @@ -29180,6 +29608,8 @@ See all buckets rclone lsd remote: The initial setup for Netstorage involves getting an account and secret. Use `rclone config` to walk you through the setup process. +## Configuration + Here's an example of how to make a remote called `ns1`. 1. To begin the interactive configuration process, enter this command: @@ -29271,28 +29701,31 @@ y/e/d> y This remote is called `ns1` and can now be used. -### Example operations +## Example operations + Get started with rclone and NetStorage with these examples. For additional rclone commands, visit https://rclone.org/commands/. -##### See contents of a directory in your project +### See contents of a directory in your project rclone lsd ns1:/974012/testing/ -##### Sync the contents local with remote +### Sync the contents local with remote rclone sync . ns1:/974012/testing/ -##### Upload local content to remote +### Upload local content to remote rclone copy notes.txt ns1:/974012/testing/ -##### Delete content on remote +### Delete content on remote rclone delete ns1:/974012/testing/notes.txt -##### Move or copy content between CP codes. +### Move or copy content between CP codes. + Your credentials must have access to two CP codes on the same remote. You can't perform operations between different remotes. rclone move ns1:/974012/testing/notes.txt ns1:/974450/testing2/ +## Features ### Symlink Support @@ -29313,7 +29746,7 @@ With NetStorage, directories can exist in one of two forms: Rclone will intercept all file uploads and mkdir commands for the NetStorage remote and will explicitly issue the mkdir command for each directory in the uploading path. This will help with the interoperability with the other Akamai services such as SFTP and the Content Management Shell (CMShell). Rclone will not guarantee correctness of operations with implicit directories which might have been created as a result of using an upload API directly. -### ListR Feature +### `--fast-list` / ListR support NetStorage remote supports the ListR feature by using the "list" NetStorage API action to return a lexicographical list of all objects within the specified CP code, recursing into subdirectories as they're encountered. @@ -29325,7 +29758,7 @@ There are pros and cons of using the ListR method, refer to [rclone documentatio **Note**: There is a known limitation that "lsf -R" will display number of files in the directory and directory size as -1 when ListR method is used. The workaround is to pass "--disable listR" flag if these numbers are important in the output. -### Purge Feature +### Purge NetStorage remote supports the purge feature by using the "quick-delete" NetStorage API action. The quick-delete action is disabled by default for security reasons and can be enabled for the account through the Akamai portal. Rclone will first try to use quick-delete action for the purge command and if this functionality is disabled then will fall back to a standard delete method. @@ -30591,7 +31024,7 @@ are converted you will no longer need the ignore options above. It is a [known](https://github.com/OneDrive/onedrive-api-docs/issues/1068) issue that Sharepoint (not OneDrive or OneDrive for Business) may return "item not found" errors when users try to replace or delete uploaded files; this seems to -mainly affect Office files (.docx, .xlsx, etc.). As a workaround, you may use +mainly affect Office files (.docx, .xlsx, etc.) and web files (.html, .aspx, etc.). As a workaround, you may use the `--backup-dir ` command line argument so rclone moves the files to be replaced/deleted into a given backup directory (instead of directly replacing/deleting them). For example, to instruct rclone to move the files into @@ -32438,6 +32871,15 @@ Properties: +## Limitations + +put.io has rate limiting. When you hit a limit, rclone automatically +retries after waiting the amount of time requested by the server. + +If you want to avoid ever hitting these limits, you may use the +`--tpslimit` flag with a low number. Note that the imposed limits +may be different for different operations, and may change over time. + # Seafile This is a backend for the [Seafile](https://www.seafile.com/) storage service: @@ -32829,7 +33271,6 @@ Protocol](https://en.wikipedia.org/wiki/SSH_File_Transfer_Protocol). The SFTP backend can be used with a number of different providers: -- C14 - rsync.net @@ -33494,12 +33935,6 @@ with it: `--dump-headers`, `--dump-bodies`, `--dump-auth` Note that `--timeout` and `--contimeout` are both supported. -## C14 {#c14} - -C14 is supported through the SFTP backend. - -See [C14's documentation](https://www.online.net/en/storage/c14-cold-storage) - ## rsync.net {#rsync-net} rsync.net is supported through the SFTP backend. @@ -36048,6 +36483,48 @@ Options: # Changelog +## v1.58.1 - 2022-04-29 + +[See commits](https://github.com/rclone/rclone/compare/v1.58.0...v1.58.1) + +* Bug Fixes + * build: Update github.com/billziss-gh to github.com/winfsp (Nick Craig-Wood) + * filter: Fix timezone of `--min-age`/`-max-age` from UTC to local as documented (Nick Craig-Wood) + * rc/js: Correct RC method names (Sơn Trần-Nguyễn) + * docs + * Fix some links to command pages (albertony) + * Add `--multi-thread-streams` note to `--transfers`. (Zsolt Ero) +* Mount + * Fix `--devname` and fusermount: unknown option 'fsname' when mounting via rc (Nick Craig-Wood) +* VFS + * Remove wording which suggests VFS is only for mounting (Nick Craig-Wood) +* Dropbox + * Fix retries of multipart uploads with incorrect_offset error (Nick Craig-Wood) +* Google Cloud Storage + * Use the s3 pacer to speed up transactions (Nick Craig-Wood) + * pacer: Default the Google pacer to a burst of 100 to fix gcs pacing (Nick Craig-Wood) +* Jottacloud + * Fix scope in token request (albertony) +* Netstorage + * Fix unescaped HTML in documentation (Nick Craig-Wood) + * Make levels of headings consistent (Nick Craig-Wood) + * Add support contacts to netstorage doc (Nil Alexandrov) +* Onedrive + * Note that sharepoint also changes web files (.html, .aspx) (GH) +* Putio + * Handle rate limit errors (Berkan Teber) + * Fix multithread download and other ranged requests (rafma0) +* S3 + * Add ChinaMobile EOS to provider list (GuoXingbin) + * Sync providers in config description with providers (Nick Craig-Wood) +* SFTP + * Fix OpenSSH 8.8+ RSA keys incompatibility (KARBOWSKI Piotr) + * Note that Scaleway C14 is deprecating SFTP in favor of S3 (Adrien Rey-Jarthon) +* Storj + * Fix bucket creation on Move (Nick Craig-Wood) +* WebDAV + * Don't override Referer if user sets it (Nick Craig-Wood) + ## v1.58.0 - 2022-03-18 [See commits](https://github.com/rclone/rclone/compare/v1.57.0...v1.58.0) diff --git a/MANUAL.txt b/MANUAL.txt index 994bd6612..c73b6829f 100644 --- a/MANUAL.txt +++ b/MANUAL.txt @@ -1,6 +1,6 @@ rclone(1) User Manual Nick Craig-Wood -Mar 18, 2022 +Apr 29, 2022 Rclone syncs your files to cloud storage @@ -98,6 +98,7 @@ S3, that work out of the box.) - Backblaze B2 - Box - Ceph +- China Mobile Ecloud Elastic Object Storage (EOS) - Citrix ShareFile - C14 - DigitalOcean Spaces @@ -3553,7 +3554,7 @@ VFS Directory Cache Using the --dir-cache-time flag, you can control how long a directory should be considered up to date and not refreshed from the backend. -Changes made through the mount will appear immediately or invalidate the +Changes made through the VFS will appear immediately or invalidate the cache. --dir-cache-time duration Time to cache directory entries for (default 5m0s) @@ -3746,7 +3747,7 @@ 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. + --read-only Only allow read-only access. 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 @@ -3758,8 +3759,8 @@ cache file. 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). +parallel uploads of modified files from the cache (the related global +flag --checkers has no effect on the VFS). --transfers int Number of file transfers to run in parallel (default 4) @@ -3777,23 +3778,22 @@ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. -The --vfs-case-insensitive mount flag controls how rclone handles these +The --vfs-case-insensitive VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the -mounted file system as-is. If the flag is "true" (or appears without a -value on command line), rclone may perform a "fixup" as explained below. +remote as-is. If the flag is "true" (or appears without a value on the +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. +different than what is stored on the remote. 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 the underlying remote. Note that case sensitivity of the operating system running rclone (the -target) may differ from case sensitivity of a file system mounted by +target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. @@ -3846,7 +3846,7 @@ Options --noapplexattr Ignore all "com.apple.*" extended attributes (supported on OSX only) -o, --option stringArray Option for libfuse/WinFsp (repeat if required) --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) --vfs-cache-max-age duration Max age of objects in the cache (default 1h0m0s) @@ -4344,7 +4344,7 @@ VFS Directory Cache Using the --dir-cache-time flag, you can control how long a directory should be considered up to date and not refreshed from the backend. -Changes made through the mount will appear immediately or invalidate the +Changes made through the VFS will appear immediately or invalidate the cache. --dir-cache-time duration Time to cache directory entries for (default 5m0s) @@ -4537,7 +4537,7 @@ 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. + --read-only Only allow read-only access. 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 @@ -4549,8 +4549,8 @@ cache file. 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). +parallel uploads of modified files from the cache (the related global +flag --checkers has no effect on the VFS). --transfers int Number of file transfers to run in parallel (default 4) @@ -4568,23 +4568,22 @@ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. -The --vfs-case-insensitive mount flag controls how rclone handles these +The --vfs-case-insensitive VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the -mounted file system as-is. If the flag is "true" (or appears without a -value on command line), rclone may perform a "fixup" as explained below. +remote as-is. If the flag is "true" (or appears without a value on the +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. +different than what is stored on the remote. 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 the underlying remote. Note that case sensitivity of the operating system running rclone (the -target) may differ from case sensitivity of a file system mounted by +target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. @@ -4623,7 +4622,7 @@ Options --no-modtime Don't read/write the modification time (can speed things up) --no-seek Don't allow seeking in files --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) --vfs-cache-max-age duration Max age of objects in the cache (default 1h0m0s) @@ -4707,7 +4706,7 @@ VFS Directory Cache Using the --dir-cache-time flag, you can control how long a directory should be considered up to date and not refreshed from the backend. -Changes made through the mount will appear immediately or invalidate the +Changes made through the VFS will appear immediately or invalidate the cache. --dir-cache-time duration Time to cache directory entries for (default 5m0s) @@ -4900,7 +4899,7 @@ 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. + --read-only Only allow read-only access. 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 @@ -4912,8 +4911,8 @@ cache file. 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). +parallel uploads of modified files from the cache (the related global +flag --checkers has no effect on the VFS). --transfers int Number of file transfers to run in parallel (default 4) @@ -4931,23 +4930,22 @@ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. -The --vfs-case-insensitive mount flag controls how rclone handles these +The --vfs-case-insensitive VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the -mounted file system as-is. If the flag is "true" (or appears without a -value on command line), rclone may perform a "fixup" as explained below. +remote as-is. If the flag is "true" (or appears without a value on the +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. +different than what is stored on the remote. 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 the underlying remote. Note that case sensitivity of the operating system running rclone (the -target) may differ from case sensitivity of a file system mounted by +target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. @@ -5003,7 +5001,7 @@ Options --noapplexattr Ignore all "com.apple.*" extended attributes (supported on OSX only) -o, --option stringArray Option for libfuse/WinFsp (repeat if required) --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --socket-addr string Address or absolute path (default: /run/docker/plugins/rclone.sock) --socket-gid int GID for unix socket (default: current process GID) (default 1000) --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) @@ -5074,7 +5072,7 @@ VFS Directory Cache Using the --dir-cache-time flag, you can control how long a directory should be considered up to date and not refreshed from the backend. -Changes made through the mount will appear immediately or invalidate the +Changes made through the VFS will appear immediately or invalidate the cache. --dir-cache-time duration Time to cache directory entries for (default 5m0s) @@ -5267,7 +5265,7 @@ 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. + --read-only Only allow read-only access. 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 @@ -5279,8 +5277,8 @@ cache file. 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). +parallel uploads of modified files from the cache (the related global +flag --checkers has no effect on the VFS). --transfers int Number of file transfers to run in parallel (default 4) @@ -5298,23 +5296,22 @@ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. -The --vfs-case-insensitive mount flag controls how rclone handles these +The --vfs-case-insensitive VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the -mounted file system as-is. If the flag is "true" (or appears without a -value on command line), rclone may perform a "fixup" as explained below. +remote as-is. If the flag is "true" (or appears without a value on the +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. +different than what is stored on the remote. 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 the underlying remote. Note that case sensitivity of the operating system running rclone (the -target) may differ from case sensitivity of a file system mounted by +target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. @@ -5428,7 +5425,7 @@ Options --passive-port string Passive port range to use (default "30000-32000") --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) --public-ip string Public IP address to advertise for passive connections - --read-only Mount read-only + --read-only Only allow read-only access --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) --user string User name for authentication (default "anonymous") @@ -5598,7 +5595,7 @@ VFS Directory Cache Using the --dir-cache-time flag, you can control how long a directory should be considered up to date and not refreshed from the backend. -Changes made through the mount will appear immediately or invalidate the +Changes made through the VFS will appear immediately or invalidate the cache. --dir-cache-time duration Time to cache directory entries for (default 5m0s) @@ -5791,7 +5788,7 @@ 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. + --read-only Only allow read-only access. 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 @@ -5803,8 +5800,8 @@ cache file. 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). +parallel uploads of modified files from the cache (the related global +flag --checkers has no effect on the VFS). --transfers int Number of file transfers to run in parallel (default 4) @@ -5822,23 +5819,22 @@ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. -The --vfs-case-insensitive mount flag controls how rclone handles these +The --vfs-case-insensitive VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the -mounted file system as-is. If the flag is "true" (or appears without a -value on command line), rclone may perform a "fixup" as explained below. +remote as-is. If the flag is "true" (or appears without a value on the +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. +different than what is stored on the remote. 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 the underlying remote. Note that case sensitivity of the operating system running rclone (the -target) may differ from case sensitivity of a file system mounted by +target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. @@ -5882,7 +5878,7 @@ Options --no-seek Don't allow seeking in files --pass string Password for authentication --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --realm string Realm for authentication --salt string Password hashing salt (default "dlPL2MqE") --server-read-timeout duration Timeout for server reading data (default 1h0m0s) @@ -6205,7 +6201,7 @@ VFS Directory Cache Using the --dir-cache-time flag, you can control how long a directory should be considered up to date and not refreshed from the backend. -Changes made through the mount will appear immediately or invalidate the +Changes made through the VFS will appear immediately or invalidate the cache. --dir-cache-time duration Time to cache directory entries for (default 5m0s) @@ -6398,7 +6394,7 @@ 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. + --read-only Only allow read-only access. 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 @@ -6410,8 +6406,8 @@ cache file. 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). +parallel uploads of modified files from the cache (the related global +flag --checkers has no effect on the VFS). --transfers int Number of file transfers to run in parallel (default 4) @@ -6429,23 +6425,22 @@ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. -The --vfs-case-insensitive mount flag controls how rclone handles these +The --vfs-case-insensitive VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the -mounted file system as-is. If the flag is "true" (or appears without a -value on command line), rclone may perform a "fixup" as explained below. +remote as-is. If the flag is "true" (or appears without a value on the +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. +different than what is stored on the remote. 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 the underlying remote. Note that case sensitivity of the operating system running rclone (the -target) may differ from case sensitivity of a file system mounted by +target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. @@ -6558,7 +6553,7 @@ Options --no-seek Don't allow seeking in files --pass string Password for authentication --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --stdio Run an sftp server on run stdin/stdout --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) @@ -6731,7 +6726,7 @@ VFS Directory Cache Using the --dir-cache-time flag, you can control how long a directory should be considered up to date and not refreshed from the backend. -Changes made through the mount will appear immediately or invalidate the +Changes made through the VFS will appear immediately or invalidate the cache. --dir-cache-time duration Time to cache directory entries for (default 5m0s) @@ -6924,7 +6919,7 @@ 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. + --read-only Only allow read-only access. 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 @@ -6936,8 +6931,8 @@ cache file. 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). +parallel uploads of modified files from the cache (the related global +flag --checkers has no effect on the VFS). --transfers int Number of file transfers to run in parallel (default 4) @@ -6955,23 +6950,22 @@ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. -The --vfs-case-insensitive mount flag controls how rclone handles these +The --vfs-case-insensitive VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the -mounted file system as-is. If the flag is "true" (or appears without a -value on command line), rclone may perform a "fixup" as explained below. +remote as-is. If the flag is "true" (or appears without a value on the +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. +different than what is stored on the remote. 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 the underlying remote. Note that case sensitivity of the operating system running rclone (the -target) may differ from case sensitivity of a file system mounted by +target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. @@ -7089,7 +7083,7 @@ Options --no-seek Don't allow seeking in files --pass string Password for authentication --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --realm string Realm for authentication (default "rclone") --server-read-timeout duration Timeout for server reading data (default 1h0m0s) --server-write-timeout duration Timeout for server writing data (default 1h0m0s) @@ -9047,6 +9041,9 @@ timeouts or bigger if you have lots of bandwidth and a fast remote. The default is to run 4 file transfers in parallel. +Look at --multi-thread-streams if you would like to control single file +transfers. + -u, --update This forces rclone to skip any files which exist on the destination and @@ -13043,7 +13040,7 @@ These flags are available for every command. --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 (default "rclone/v1.58.0") + --user-agent string Set the user-agent to a specified string (default "rclone/v1.58.1") -v, --verbose count Print lots more stuff (repeat for more) Backend Flags @@ -15746,6 +15743,7 @@ The S3 backend can be used with a number of different providers: - AWS S3 - Alibaba Cloud (Aliyun) Object Storage System (OSS) - Ceph +- China Mobile Ecloud Elastic Object Storage (EOS) - DigitalOcean Spaces - Dreamhost - IBM COS S3 @@ -15803,7 +15801,7 @@ This will guide you through an interactive setup process. Type of storage to configure. Choose a number from below, or type in your own value [snip] - XX / Amazon S3 Compliant Storage Providers including AWS, Ceph, Dreamhost, IBM COS, Minio, and Tencent COS + XX / Amazon S3 Compliant Storage Providers including AWS, Ceph, ChinaMobile, Dreamhost, IBM COS, Minio, and Tencent COS \ "s3" [snip] Storage> s3 @@ -16304,9 +16302,9 @@ be uploaded as multipart. Standard options Here are the standard options specific to s3 (Amazon S3 Compliant -Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, -Dreamhost, IBM COS, Lyve Cloud, Minio, RackCorp, SeaweedFS, and Tencent -COS). +Storage Providers including AWS, Alibaba, Ceph, China Mobile, Digital +Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, Netease, RackCorp, +Scaleway, SeaweedFS, StackPath, Storj, Tencent COS and Wasabi). --s3-provider @@ -16325,6 +16323,8 @@ Properties: - Alibaba Cloud Object Storage System (OSS) formerly Aliyun - "Ceph" - Ceph Object Storage + - "ChinaMobile" + - China Mobile Ecloud Elastic Object Storage (EOS) - "DigitalOcean" - Digital Ocean Spaces - "Dreamhost" @@ -16567,7 +16567,8 @@ Properties: - Config: region - Env Var: RCLONE_S3_REGION -- Provider: !AWS,Alibaba,RackCorp,Scaleway,Storj,TencentCOS +- Provider: + !AWS,Alibaba,ChinaMobile,RackCorp,Scaleway,Storj,TencentCOS - Type: string - Required: false - Examples: @@ -16594,6 +16595,80 @@ Properties: --s3-endpoint +Endpoint for China Mobile Ecloud Elastic Object Storage (EOS) API. + +Properties: + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Provider: ChinaMobile +- Type: string +- Required: false +- Examples: + - "eos-wuxi-1.cmecloud.cn" + - The default endpoint - a good choice if you are unsure. + - East China (Suzhou) + - "eos-jinan-1.cmecloud.cn" + - East China (Jinan) + - "eos-ningbo-1.cmecloud.cn" + - East China (Hangzhou) + - "eos-shanghai-1.cmecloud.cn" + - East China (Shanghai-1) + - "eos-zhengzhou-1.cmecloud.cn" + - Central China (Zhengzhou) + - "eos-hunan-1.cmecloud.cn" + - Central China (Changsha-1) + - "eos-zhuzhou-1.cmecloud.cn" + - Central China (Changsha-2) + - "eos-guangzhou-1.cmecloud.cn" + - South China (Guangzhou-2) + - "eos-dongguan-1.cmecloud.cn" + - South China (Guangzhou-3) + - "eos-beijing-1.cmecloud.cn" + - North China (Beijing-1) + - "eos-beijing-2.cmecloud.cn" + - North China (Beijing-2) + - "eos-beijing-4.cmecloud.cn" + - North China (Beijing-3) + - "eos-huhehaote-1.cmecloud.cn" + - North China (Huhehaote) + - "eos-chengdu-1.cmecloud.cn" + - Southwest China (Chengdu) + - "eos-chongqing-1.cmecloud.cn" + - Southwest China (Chongqing) + - "eos-guiyang-1.cmecloud.cn" + - Southwest China (Guiyang) + - "eos-xian-1.cmecloud.cn" + - Nouthwest China (Xian) + - "eos-yunnan.cmecloud.cn" + - Yunnan China (Kunming) + - "eos-yunnan-2.cmecloud.cn" + - Yunnan China (Kunming-2) + - "eos-tianjin-1.cmecloud.cn" + - Tianjin China (Tianjin) + - "eos-jilin-1.cmecloud.cn" + - Jilin China (Changchun) + - "eos-hubei-1.cmecloud.cn" + - Hubei China (Xiangyan) + - "eos-jiangxi-1.cmecloud.cn" + - Jiangxi China (Nanchang) + - "eos-gansu-1.cmecloud.cn" + - Gansu China (Lanzhou) + - "eos-shanxi-1.cmecloud.cn" + - Shanxi China (Taiyuan) + - "eos-liaoning-1.cmecloud.cn" + - Liaoning China (Shenyang) + - "eos-hebei-1.cmecloud.cn" + - Hebei China (Shijiazhuang) + - "eos-fujian-1.cmecloud.cn" + - Fujian China (Xiamen) + - "eos-guangxi-1.cmecloud.cn" + - Guangxi China (Nanning) + - "eos-anhui-1.cmecloud.cn" + - Anhui China (Huainan) + +--s3-endpoint + Endpoint for IBM COS S3 API. Specify if using an IBM COS On Premise. @@ -16962,7 +17037,7 @@ Properties: - Config: endpoint - Env Var: RCLONE_S3_ENDPOINT - Provider: - !AWS,IBMCOS,TencentCOS,Alibaba,Scaleway,StackPath,Storj,RackCorp + !AWS,IBMCOS,TencentCOS,Alibaba,ChinaMobile,Scaleway,StackPath,Storj,RackCorp - Type: string - Required: false - Examples: @@ -17060,6 +17135,81 @@ Properties: --s3-location-constraint +Location constraint - must match endpoint. + +Used when creating buckets only. + +Properties: + +- Config: location_constraint +- Env Var: RCLONE_S3_LOCATION_CONSTRAINT +- Provider: ChinaMobile +- Type: string +- Required: false +- Examples: + - "wuxi1" + - East China (Suzhou) + - "jinan1" + - East China (Jinan) + - "ningbo1" + - East China (Hangzhou) + - "shanghai1" + - East China (Shanghai-1) + - "zhengzhou1" + - Central China (Zhengzhou) + - "hunan1" + - Central China (Changsha-1) + - "zhuzhou1" + - Central China (Changsha-2) + - "guangzhou1" + - South China (Guangzhou-2) + - "dongguan1" + - South China (Guangzhou-3) + - "beijing1" + - North China (Beijing-1) + - "beijing2" + - North China (Beijing-2) + - "beijing4" + - North China (Beijing-3) + - "huhehaote1" + - North China (Huhehaote) + - "chengdu1" + - Southwest China (Chengdu) + - "chongqing1" + - Southwest China (Chongqing) + - "guiyang1" + - Southwest China (Guiyang) + - "xian1" + - Nouthwest China (Xian) + - "yunnan" + - Yunnan China (Kunming) + - "yunnan2" + - Yunnan China (Kunming-2) + - "tianjin1" + - Tianjin China (Tianjin) + - "jilin1" + - Jilin China (Changchun) + - "hubei1" + - Hubei China (Xiangyan) + - "jiangxi1" + - Jiangxi China (Nanchang) + - "gansu1" + - Gansu China (Lanzhou) + - "shanxi1" + - Shanxi China (Taiyuan) + - "liaoning1" + - Liaoning China (Shenyang) + - "hebei1" + - Hebei China (Shijiazhuang) + - "fujian1" + - Fujian China (Xiamen) + - "guangxi1" + - Guangxi China (Nanning) + - "anhui1" + - Anhui China (Huainan) + +--s3-location-constraint + Location constraint - must match endpoint when using IBM Cloud Public. For on-prem COS, do not make a selection from this list, hit enter. @@ -17200,7 +17350,7 @@ Properties: - Config: location_constraint - Env Var: RCLONE_S3_LOCATION_CONSTRAINT - Provider: - !AWS,IBMCOS,Alibaba,RackCorp,Scaleway,StackPath,Storj,TencentCOS + !AWS,IBMCOS,Alibaba,ChinaMobile,RackCorp,Scaleway,StackPath,Storj,TencentCOS - Type: string - Required: false @@ -17282,7 +17432,7 @@ Properties: - Config: server_side_encryption - Env Var: RCLONE_S3_SERVER_SIDE_ENCRYPTION -- Provider: AWS,Ceph,Minio +- Provider: AWS,Ceph,ChinaMobile,Minio - Type: string - Required: false - Examples: @@ -17364,6 +17514,27 @@ Properties: --s3-storage-class +The storage class to use when storing new objects in ChinaMobile. + +Properties: + +- Config: storage_class +- Env Var: RCLONE_S3_STORAGE_CLASS +- Provider: ChinaMobile +- Type: string +- Required: false +- Examples: + - "" + - Default + - "STANDARD" + - Standard storage class + - "GLACIER" + - Archive storage mode + - "STANDARD_IA" + - Infrequent access storage mode + +--s3-storage-class + The storage class to use when storing new objects in Tencent COS. Properties: @@ -17408,9 +17579,9 @@ Properties: Advanced options Here are the advanced options specific to s3 (Amazon S3 Compliant -Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, -Dreamhost, IBM COS, Lyve Cloud, Minio, RackCorp, SeaweedFS, and Tencent -COS). +Storage Providers including AWS, Alibaba, Ceph, China Mobile, Digital +Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, Netease, RackCorp, +Scaleway, SeaweedFS, StackPath, Storj, Tencent COS and Wasabi). --s3-bucket-acl @@ -17464,7 +17635,7 @@ Properties: - Config: sse_customer_algorithm - Env Var: RCLONE_S3_SSE_CUSTOMER_ALGORITHM -- Provider: AWS,Ceph,Minio +- Provider: AWS,Ceph,ChinaMobile,Minio - Type: string - Required: false - Examples: @@ -17482,7 +17653,7 @@ Properties: - Config: sse_customer_key - Env Var: RCLONE_S3_SSE_CUSTOMER_KEY -- Provider: AWS,Ceph,Minio +- Provider: AWS,Ceph,ChinaMobile,Minio - Type: string - Required: false - Examples: @@ -17501,7 +17672,7 @@ Properties: - Config: sse_customer_key_md5 - Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_MD5 -- Provider: AWS,Ceph,Minio +- Provider: AWS,Ceph,ChinaMobile,Minio - Type: string - Required: false - Examples: @@ -18268,7 +18439,7 @@ To configure access to IBM COS S3, follow the steps below: \ "alias" 2 / Amazon Drive \ "amazon cloud drive" - 3 / Amazon S3 Complaint Storage Providers (Dreamhost, Ceph, Minio, IBM COS) + 3 / Amazon S3 Complaint Storage Providers (Dreamhost, Ceph, ChinaMobile, Minio, IBM COS) \ "s3" 4 / Backblaze B2 \ "b2" @@ -18517,6 +18688,14 @@ rclone like this: server_side_encryption = storage_class = +C14 Cold Storage is the low-cost S3 Glacier alternative from Scaleway +and it works the same way as on S3 by accepting the "GLACIER" +storage_class. So you can configure your remote with the +storage_class = GLACIER option to upload directly to C14. Don't forget +that in this state you can't read files back after, you will need to +restore them to "STANDARD" storage_class first before being able to read +them (see "restore" section above) + Seagate Lyve Cloud Seagate Lyve Cloud is an S3 compatible object storage platform from @@ -18539,7 +18718,7 @@ Choose s3 backend Type of storage to configure. Choose a number from below, or type in your own value. [snip] - XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, RackCorp, SeaweedFS, and Tencent COS + XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, ChinaMobile, Digital Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, RackCorp, SeaweedFS, and Tencent COS \ (s3) [snip] Storage> s3 @@ -18703,7 +18882,7 @@ rclone like this. Type of storage to configure. Choose a number from below, or type in your own value [snip] - XX / Amazon S3 (also Dreamhost, Ceph, Minio) + XX / Amazon S3 (also Dreamhost, Ceph, ChinaMobile, Minio) \ "s3" [snip] Storage> s3 @@ -18813,7 +18992,7 @@ This will guide you through an interactive setup process. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [snip] - 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS + 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, ChinaMobile, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS \ "s3" [snip] Storage> s3 @@ -18902,6 +19081,254 @@ This will guide you through an interactive setup process. d) Delete this remote y/e/d> y +China Mobile Ecloud Elastic Object Storage (EOS) + +Here is an example of making an China Mobile Ecloud Elastic Object +Storage (EOS) configuration. First run: + + rclone config + +This will guide you through an interactive setup process. + + No remotes found, make a new one? + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + name> ChinaMobile + Option Storage. + Type of storage to configure. + Choose a number from below, or type in your own value. + ... + 5 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, ChinaMobile, Digital Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, RackCorp, SeaweedFS, and Tencent COS + \ (s3) + ... + Storage> s3 + Option provider. + Choose your S3 provider. + Choose a number from below, or type in your own value. + Press Enter to leave empty. + ... + 4 / China Mobile Ecloud Elastic Object Storage (EOS) + \ (ChinaMobile) + ... + provider> ChinaMobile + Option env_auth. + Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). + Only applies if access_key_id and secret_access_key is blank. + Choose a number from below, or type in your own boolean value (true or false). + Press Enter for the default (false). + 1 / Enter AWS credentials in the next step. + \ (false) + 2 / Get AWS credentials from the environment (env vars or IAM). + \ (true) + env_auth> + Option access_key_id. + AWS Access Key ID. + Leave blank for anonymous access or runtime credentials. + Enter a value. Press Enter to leave empty. + access_key_id> accesskeyid + Option secret_access_key. + AWS Secret Access Key (password). + Leave blank for anonymous access or runtime credentials. + Enter a value. Press Enter to leave empty. + secret_access_key> secretaccesskey + Option endpoint. + Endpoint for China Mobile Ecloud Elastic Object Storage (EOS) API. + Choose a number from below, or type in your own value. + Press Enter to leave empty. + / The default endpoint - a good choice if you are unsure. + 1 | East China (Suzhou) + \ (eos-wuxi-1.cmecloud.cn) + 2 / East China (Jinan) + \ (eos-jinan-1.cmecloud.cn) + 3 / East China (Hangzhou) + \ (eos-ningbo-1.cmecloud.cn) + 4 / East China (Shanghai-1) + \ (eos-shanghai-1.cmecloud.cn) + 5 / Central China (Zhengzhou) + \ (eos-zhengzhou-1.cmecloud.cn) + 6 / Central China (Changsha-1) + \ (eos-hunan-1.cmecloud.cn) + 7 / Central China (Changsha-2) + \ (eos-zhuzhou-1.cmecloud.cn) + 8 / South China (Guangzhou-2) + \ (eos-guangzhou-1.cmecloud.cn) + 9 / South China (Guangzhou-3) + \ (eos-dongguan-1.cmecloud.cn) + 10 / North China (Beijing-1) + \ (eos-beijing-1.cmecloud.cn) + 11 / North China (Beijing-2) + \ (eos-beijing-2.cmecloud.cn) + 12 / North China (Beijing-3) + \ (eos-beijing-4.cmecloud.cn) + 13 / North China (Huhehaote) + \ (eos-huhehaote-1.cmecloud.cn) + 14 / Southwest China (Chengdu) + \ (eos-chengdu-1.cmecloud.cn) + 15 / Southwest China (Chongqing) + \ (eos-chongqing-1.cmecloud.cn) + 16 / Southwest China (Guiyang) + \ (eos-guiyang-1.cmecloud.cn) + 17 / Nouthwest China (Xian) + \ (eos-xian-1.cmecloud.cn) + 18 / Yunnan China (Kunming) + \ (eos-yunnan.cmecloud.cn) + 19 / Yunnan China (Kunming-2) + \ (eos-yunnan-2.cmecloud.cn) + 20 / Tianjin China (Tianjin) + \ (eos-tianjin-1.cmecloud.cn) + 21 / Jilin China (Changchun) + \ (eos-jilin-1.cmecloud.cn) + 22 / Hubei China (Xiangyan) + \ (eos-hubei-1.cmecloud.cn) + 23 / Jiangxi China (Nanchang) + \ (eos-jiangxi-1.cmecloud.cn) + 24 / Gansu China (Lanzhou) + \ (eos-gansu-1.cmecloud.cn) + 25 / Shanxi China (Taiyuan) + \ (eos-shanxi-1.cmecloud.cn) + 26 / Liaoning China (Shenyang) + \ (eos-liaoning-1.cmecloud.cn) + 27 / Hebei China (Shijiazhuang) + \ (eos-hebei-1.cmecloud.cn) + 28 / Fujian China (Xiamen) + \ (eos-fujian-1.cmecloud.cn) + 29 / Guangxi China (Nanning) + \ (eos-guangxi-1.cmecloud.cn) + 30 / Anhui China (Huainan) + \ (eos-anhui-1.cmecloud.cn) + endpoint> 1 + Option location_constraint. + Location constraint - must match endpoint. + Used when creating buckets only. + Choose a number from below, or type in your own value. + Press Enter to leave empty. + 1 / East China (Suzhou) + \ (wuxi1) + 2 / East China (Jinan) + \ (jinan1) + 3 / East China (Hangzhou) + \ (ningbo1) + 4 / East China (Shanghai-1) + \ (shanghai1) + 5 / Central China (Zhengzhou) + \ (zhengzhou1) + 6 / Central China (Changsha-1) + \ (hunan1) + 7 / Central China (Changsha-2) + \ (zhuzhou1) + 8 / South China (Guangzhou-2) + \ (guangzhou1) + 9 / South China (Guangzhou-3) + \ (dongguan1) + 10 / North China (Beijing-1) + \ (beijing1) + 11 / North China (Beijing-2) + \ (beijing2) + 12 / North China (Beijing-3) + \ (beijing4) + 13 / North China (Huhehaote) + \ (huhehaote1) + 14 / Southwest China (Chengdu) + \ (chengdu1) + 15 / Southwest China (Chongqing) + \ (chongqing1) + 16 / Southwest China (Guiyang) + \ (guiyang1) + 17 / Nouthwest China (Xian) + \ (xian1) + 18 / Yunnan China (Kunming) + \ (yunnan) + 19 / Yunnan China (Kunming-2) + \ (yunnan2) + 20 / Tianjin China (Tianjin) + \ (tianjin1) + 21 / Jilin China (Changchun) + \ (jilin1) + 22 / Hubei China (Xiangyan) + \ (hubei1) + 23 / Jiangxi China (Nanchang) + \ (jiangxi1) + 24 / Gansu China (Lanzhou) + \ (gansu1) + 25 / Shanxi China (Taiyuan) + \ (shanxi1) + 26 / Liaoning China (Shenyang) + \ (liaoning1) + 27 / Hebei China (Shijiazhuang) + \ (hebei1) + 28 / Fujian China (Xiamen) + \ (fujian1) + 29 / Guangxi China (Nanning) + \ (guangxi1) + 30 / Anhui China (Huainan) + \ (anhui1) + location_constraint> 1 + Option acl. + Canned ACL used when creating buckets and storing or copying objects. + This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too. + For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl + Note that this ACL is applied when server-side copying objects as S3 + doesn't copy the ACL from the source but rather writes a fresh one. + Choose a number from below, or type in your own value. + Press Enter to leave empty. + / Owner gets FULL_CONTROL. + 1 | No one else has access rights (default). + \ (private) + / Owner gets FULL_CONTROL. + 2 | The AllUsers group gets READ access. + \ (public-read) + / Owner gets FULL_CONTROL. + 3 | The AllUsers group gets READ and WRITE access. + | Granting this on a bucket is generally not recommended. + \ (public-read-write) + / Owner gets FULL_CONTROL. + 4 | The AuthenticatedUsers group gets READ access. + \ (authenticated-read) + / Object owner gets FULL_CONTROL. + acl> private + Option server_side_encryption. + The server-side encryption algorithm used when storing this object in S3. + Choose a number from below, or type in your own value. + Press Enter to leave empty. + 1 / None + \ () + 2 / AES256 + \ (AES256) + server_side_encryption> + Option storage_class. + The storage class to use when storing new objects in ChinaMobile. + Choose a number from below, or type in your own value. + Press Enter to leave empty. + 1 / Default + \ () + 2 / Standard storage class + \ (STANDARD) + 3 / Archive storage mode + \ (GLACIER) + 4 / Infrequent access storage mode + \ (STANDARD_IA) + storage_class> + Edit advanced config? + y) Yes + n) No (default) + y/n> n + -------------------- + [ChinaMobile] + type = s3 + provider = ChinaMobile + access_key_id = accesskeyid + secret_access_key = secretaccesskey + endpoint = eos-wuxi-1.cmecloud.cn + location_constraint = wuxi1 + acl = private + -------------------- + y) Yes this is OK (default) + e) Edit this remote + d) Delete this remote + y/e/d> y + Tencent COS Tencent Cloud Object Storage (COS) is a distributed storage service @@ -18932,7 +19359,7 @@ To configure access to Tencent COS, follow the steps below: \ "alias" 3 / Amazon Drive \ "amazon cloud drive" - 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS + 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, ChinaMobile, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS \ "s3" [snip] Storage> s3 @@ -28515,6 +28942,8 @@ See all buckets rclone lsd remote: The initial setup for Netstorage involves getting an account and secret. Use rclone config to walk you through the setup process. +Configuration + Here's an example of how to make a remote called ns1. 1. To begin the interactive configuration process, enter this command: @@ -28621,6 +29050,8 @@ You can't perform operations between different remotes. rclone move ns1:/974012/testing/notes.txt ns1:/974450/testing2/ +Features + Symlink Support The Netstorage backend changes the rclone --links, -l behavior. When @@ -28669,7 +29100,7 @@ Content Management Shell (CMShell). Rclone will not guarantee correctness of operations with implicit directories which might have been created as a result of using an upload API directly. -ListR Feature +--fast-list / ListR support NetStorage remote supports the ListR feature by using the "list" NetStorage API action to return a lexicographical list of all objects @@ -28696,7 +29127,7 @@ files in the directory and directory size as -1 when ListR method is used. The workaround is to pass "--disable listR" flag if these numbers are important in the output. -Purge Feature +Purge NetStorage remote supports the purge feature by using the "quick-delete" NetStorage API action. The quick-delete action is disabled by default @@ -29994,12 +30425,12 @@ Replacing/deleting existing files on Sharepoint gets "item not found" It is a known issue that Sharepoint (not OneDrive or OneDrive for Business) may return "item not found" errors when users try to replace or delete uploaded files; this seems to mainly affect Office files -(.docx, .xlsx, etc.). As a workaround, you may use the ---backup-dir command line argument so rclone moves the -files to be replaced/deleted into a given backup directory (instead of -directly replacing/deleting them). For example, to instruct rclone to -move the files into the directory rclone-backup-dir on backend -mysharepoint, you may use: +(.docx, .xlsx, etc.) and web files (.html, .aspx, etc.). As a +workaround, you may use the --backup-dir command line +argument so rclone moves the files to be replaced/deleted into a given +backup directory (instead of directly replacing/deleting them). For +example, to instruct rclone to move the files into the directory +rclone-backup-dir on backend mysharepoint, you may use: --backup-dir mysharepoint:rclone-backup-dir @@ -31807,6 +32238,15 @@ Properties: - Type: MultiEncoder - Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot +Limitations + +put.io has rate limiting. When you hit a limit, rclone automatically +retries after waiting the amount of time requested by the server. + +If you want to avoid ever hitting these limits, you may use the +--tpslimit flag with a low number. Note that the imposed limits may be +different for different operations, and may change over time. + Seafile This is a backend for the Seafile storage service: - It works with both @@ -32189,7 +32629,6 @@ SFTP is the Secure (or SSH) File Transfer Protocol. The SFTP backend can be used with a number of different providers: -- C14 - rsync.net SFTP runs over SSH v2 and is installed as standard with most modern SSH @@ -32848,12 +33287,6 @@ with it: --dump-headers, --dump-bodies, --dump-auth Note that --timeout and --contimeout are both supported. -C14 - -C14 is supported through the SFTP backend. - -See C14's documentation - rsync.net rsync.net is supported through the SFTP backend. @@ -35422,6 +35855,56 @@ Options: Changelog +v1.58.1 - 2022-04-29 + +See commits + +- Bug Fixes + - build: Update github.com/billziss-gh to github.com/winfsp (Nick + Craig-Wood) + - filter: Fix timezone of --min-age/-max-age from UTC to local as + documented (Nick Craig-Wood) + - rc/js: Correct RC method names (Sơn Trần-Nguyễn) + - docs + - Fix some links to command pages (albertony) + - Add --multi-thread-streams note to --transfers. (Zsolt Ero) +- Mount + - Fix --devname and fusermount: unknown option 'fsname' when + mounting via rc (Nick Craig-Wood) +- VFS + - Remove wording which suggests VFS is only for mounting (Nick + Craig-Wood) +- Dropbox + - Fix retries of multipart uploads with incorrect_offset error + (Nick Craig-Wood) +- Google Cloud Storage + - Use the s3 pacer to speed up transactions (Nick Craig-Wood) + - pacer: Default the Google pacer to a burst of 100 to fix gcs + pacing (Nick Craig-Wood) +- Jottacloud + - Fix scope in token request (albertony) +- Netstorage + - Fix unescaped HTML in documentation (Nick Craig-Wood) + - Make levels of headings consistent (Nick Craig-Wood) + - Add support contacts to netstorage doc (Nil Alexandrov) +- Onedrive + - Note that sharepoint also changes web files (.html, .aspx) (GH) +- Putio + - Handle rate limit errors (Berkan Teber) + - Fix multithread download and other ranged requests (rafma0) +- S3 + - Add ChinaMobile EOS to provider list (GuoXingbin) + - Sync providers in config description with providers (Nick + Craig-Wood) +- SFTP + - Fix OpenSSH 8.8+ RSA keys incompatibility (KARBOWSKI Piotr) + - Note that Scaleway C14 is deprecating SFTP in favor of S3 + (Adrien Rey-Jarthon) +- Storj + - Fix bucket creation on Move (Nick Craig-Wood) +- WebDAV + - Don't override Referer if user sets it (Nick Craig-Wood) + v1.58.0 - 2022-03-18 See commits diff --git a/docs/content/changelog.md b/docs/content/changelog.md index e983dddff..fab1db463 100644 --- a/docs/content/changelog.md +++ b/docs/content/changelog.md @@ -5,6 +5,48 @@ description: "Rclone Changelog" # Changelog +## v1.58.1 - 2022-04-29 + +[See commits](https://github.com/rclone/rclone/compare/v1.58.0...v1.58.1) + +* Bug Fixes + * build: Update github.com/billziss-gh to github.com/winfsp (Nick Craig-Wood) + * filter: Fix timezone of `--min-age`/`-max-age` from UTC to local as documented (Nick Craig-Wood) + * rc/js: Correct RC method names (Sơn Trần-Nguyễn) + * docs + * Fix some links to command pages (albertony) + * Add `--multi-thread-streams` note to `--transfers`. (Zsolt Ero) +* Mount + * Fix `--devname` and fusermount: unknown option 'fsname' when mounting via rc (Nick Craig-Wood) +* VFS + * Remove wording which suggests VFS is only for mounting (Nick Craig-Wood) +* Dropbox + * Fix retries of multipart uploads with incorrect_offset error (Nick Craig-Wood) +* Google Cloud Storage + * Use the s3 pacer to speed up transactions (Nick Craig-Wood) + * pacer: Default the Google pacer to a burst of 100 to fix gcs pacing (Nick Craig-Wood) +* Jottacloud + * Fix scope in token request (albertony) +* Netstorage + * Fix unescaped HTML in documentation (Nick Craig-Wood) + * Make levels of headings consistent (Nick Craig-Wood) + * Add support contacts to netstorage doc (Nil Alexandrov) +* Onedrive + * Note that sharepoint also changes web files (.html, .aspx) (GH) +* Putio + * Handle rate limit errors (Berkan Teber) + * Fix multithread download and other ranged requests (rafma0) +* S3 + * Add ChinaMobile EOS to provider list (GuoXingbin) + * Sync providers in config description with providers (Nick Craig-Wood) +* SFTP + * Fix OpenSSH 8.8+ RSA keys incompatibility (KARBOWSKI Piotr) + * Note that Scaleway C14 is deprecating SFTP in favor of S3 (Adrien Rey-Jarthon) +* Storj + * Fix bucket creation on Move (Nick Craig-Wood) +* WebDAV + * Don't override Referer if user sets it (Nick Craig-Wood) + ## v1.58.0 - 2022-03-18 [See commits](https://github.com/rclone/rclone/compare/v1.57.0...v1.58.0) diff --git a/docs/content/commands/rclone_mount.md b/docs/content/commands/rclone_mount.md index 8a7d3cefd..4f7f10ac4 100644 --- a/docs/content/commands/rclone_mount.md +++ b/docs/content/commands/rclone_mount.md @@ -75,10 +75,10 @@ at all, then 1 PiB is set as both the total and the free size. To run rclone mount on Windows, you will need to download and install [WinFsp](http://www.secfs.net/winfsp/). -[WinFsp](https://github.com/billziss-gh/winfsp) is an open-source +[WinFsp](https://github.com/winfsp/winfsp) is an open-source Windows File System Proxy which makes it easy to write user space file systems for Windows. It provides a FUSE emulation layer which rclone -uses combination with [cgofuse](https://github.com/billziss-gh/cgofuse). +uses combination with [cgofuse](https://github.com/winfsp/cgofuse). Both of these packages are by Bill Zissimopoulos who was very helpful during the implementation of rclone mount for Windows. @@ -228,7 +228,7 @@ from Microsoft's Sysinternals suite, which has option `-s` to start processes as the SYSTEM account. Another alternative is to run the mount command from a Windows Scheduled Task, or a Windows Service, configured to run as the SYSTEM account. A third alternative is to use the -[WinFsp.Launcher infrastructure](https://github.com/billziss-gh/winfsp/wiki/WinFsp-Service-Architecture)). +[WinFsp.Launcher infrastructure](https://github.com/winfsp/winfsp/wiki/WinFsp-Service-Architecture)). Note that when running rclone as another user, it will not use the configuration file from your profile unless you tell it to with the [`--config`](https://rclone.org/docs/#config-config-file) option. @@ -410,7 +410,7 @@ about files and directories (but not the data) in memory. Using the `--dir-cache-time` flag, you can control how long a directory should be considered up to date and not refreshed from the -backend. Changes made through the mount will appear immediately or +backend. Changes made through the VFS will appear immediately or invalidate the cache. --dir-cache-time duration Time to cache directory entries for (default 5m0s) @@ -607,7 +607,7 @@ 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. + --read-only Only allow read-only access. 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 @@ -619,7 +619,7 @@ on disk cache file. 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). +modified files from the cache (the related global flag `--checkers` has no effect on the VFS). --transfers int Number of file transfers to run in parallel (default 4) @@ -636,22 +636,22 @@ It is not allowed for two files in the same directory to differ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. -The `--vfs-case-insensitive` mount flag controls how rclone handles these -two cases. If its value is "false", rclone passes file names to the mounted -file system as-is. If the flag is "true" (or appears without a value on +The `--vfs-case-insensitive` VFS flag controls how rclone handles these +two cases. If its value is "false", rclone passes file names to the remote +as-is. If the flag is "true" (or appears without a value on the 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 +different than what is stored on the remote. 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. +controlled by the underlying remote. 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). +may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. If the flag is not provided on the command line, then its default value depends @@ -705,7 +705,7 @@ rclone mount remote:path /path/to/mountpoint [flags] --noapplexattr Ignore all "com.apple.*" extended attributes (supported on OSX only) -o, --option stringArray Option for libfuse/WinFsp (repeat if required) --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) --vfs-cache-max-age duration Max age of objects in the cache (default 1h0m0s) diff --git a/docs/content/commands/rclone_serve_dlna.md b/docs/content/commands/rclone_serve_dlna.md index 0ab69644e..c60ec2234 100644 --- a/docs/content/commands/rclone_serve_dlna.md +++ b/docs/content/commands/rclone_serve_dlna.md @@ -51,7 +51,7 @@ about files and directories (but not the data) in memory. Using the `--dir-cache-time` flag, you can control how long a directory should be considered up to date and not refreshed from the -backend. Changes made through the mount will appear immediately or +backend. Changes made through the VFS will appear immediately or invalidate the cache. --dir-cache-time duration Time to cache directory entries for (default 5m0s) @@ -248,7 +248,7 @@ 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. + --read-only Only allow read-only access. 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 @@ -260,7 +260,7 @@ on disk cache file. 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). +modified files from the cache (the related global flag `--checkers` has no effect on the VFS). --transfers int Number of file transfers to run in parallel (default 4) @@ -277,22 +277,22 @@ It is not allowed for two files in the same directory to differ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. -The `--vfs-case-insensitive` mount flag controls how rclone handles these -two cases. If its value is "false", rclone passes file names to the mounted -file system as-is. If the flag is "true" (or appears without a value on +The `--vfs-case-insensitive` VFS flag controls how rclone handles these +two cases. If its value is "false", rclone passes file names to the remote +as-is. If the flag is "true" (or appears without a value on the 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 +different than what is stored on the remote. 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. +controlled by the underlying remote. 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). +may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. If the flag is not provided on the command line, then its default value depends @@ -332,7 +332,7 @@ rclone serve dlna remote:path [flags] --no-modtime Don't read/write the modification time (can speed things up) --no-seek Don't allow seeking in files --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) --vfs-cache-max-age duration Max age of objects in the cache (default 1h0m0s) diff --git a/docs/content/commands/rclone_serve_docker.md b/docs/content/commands/rclone_serve_docker.md index 976c7a710..0b4220e9e 100644 --- a/docs/content/commands/rclone_serve_docker.md +++ b/docs/content/commands/rclone_serve_docker.md @@ -69,7 +69,7 @@ about files and directories (but not the data) in memory. Using the `--dir-cache-time` flag, you can control how long a directory should be considered up to date and not refreshed from the -backend. Changes made through the mount will appear immediately or +backend. Changes made through the VFS will appear immediately or invalidate the cache. --dir-cache-time duration Time to cache directory entries for (default 5m0s) @@ -266,7 +266,7 @@ 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. + --read-only Only allow read-only access. 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 @@ -278,7 +278,7 @@ on disk cache file. 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). +modified files from the cache (the related global flag `--checkers` has no effect on the VFS). --transfers int Number of file transfers to run in parallel (default 4) @@ -295,22 +295,22 @@ It is not allowed for two files in the same directory to differ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. -The `--vfs-case-insensitive` mount flag controls how rclone handles these -two cases. If its value is "false", rclone passes file names to the mounted -file system as-is. If the flag is "true" (or appears without a value on +The `--vfs-case-insensitive` VFS flag controls how rclone handles these +two cases. If its value is "false", rclone passes file names to the remote +as-is. If the flag is "true" (or appears without a value on the 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 +different than what is stored on the remote. 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. +controlled by the underlying remote. 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). +may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. If the flag is not provided on the command line, then its default value depends @@ -367,7 +367,7 @@ rclone serve docker [flags] --noapplexattr Ignore all "com.apple.*" extended attributes (supported on OSX only) -o, --option stringArray Option for libfuse/WinFsp (repeat if required) --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --socket-addr string Address or absolute path (default: /run/docker/plugins/rclone.sock) --socket-gid int GID for unix socket (default: current process GID) (default 1000) --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) diff --git a/docs/content/commands/rclone_serve_ftp.md b/docs/content/commands/rclone_serve_ftp.md index 5dfd4633f..535ded639 100644 --- a/docs/content/commands/rclone_serve_ftp.md +++ b/docs/content/commands/rclone_serve_ftp.md @@ -50,7 +50,7 @@ about files and directories (but not the data) in memory. Using the `--dir-cache-time` flag, you can control how long a directory should be considered up to date and not refreshed from the -backend. Changes made through the mount will appear immediately or +backend. Changes made through the VFS will appear immediately or invalidate the cache. --dir-cache-time duration Time to cache directory entries for (default 5m0s) @@ -247,7 +247,7 @@ 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. + --read-only Only allow read-only access. 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 @@ -259,7 +259,7 @@ on disk cache file. 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). +modified files from the cache (the related global flag `--checkers` has no effect on the VFS). --transfers int Number of file transfers to run in parallel (default 4) @@ -276,22 +276,22 @@ It is not allowed for two files in the same directory to differ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. -The `--vfs-case-insensitive` mount flag controls how rclone handles these -two cases. If its value is "false", rclone passes file names to the mounted -file system as-is. If the flag is "true" (or appears without a value on +The `--vfs-case-insensitive` VFS flag controls how rclone handles these +two cases. If its value is "false", rclone passes file names to the remote +as-is. If the flag is "true" (or appears without a value on the 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 +different than what is stored on the remote. 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. +controlled by the underlying remote. 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). +may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. If the flag is not provided on the command line, then its default value depends @@ -416,7 +416,7 @@ rclone serve ftp remote:path [flags] --passive-port string Passive port range to use (default "30000-32000") --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) --public-ip string Public IP address to advertise for passive connections - --read-only Mount read-only + --read-only Only allow read-only access --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) --user string User name for authentication (default "anonymous") diff --git a/docs/content/commands/rclone_serve_http.md b/docs/content/commands/rclone_serve_http.md index 418c18377..ca731b685 100644 --- a/docs/content/commands/rclone_serve_http.md +++ b/docs/content/commands/rclone_serve_http.md @@ -126,7 +126,7 @@ about files and directories (but not the data) in memory. Using the `--dir-cache-time` flag, you can control how long a directory should be considered up to date and not refreshed from the -backend. Changes made through the mount will appear immediately or +backend. Changes made through the VFS will appear immediately or invalidate the cache. --dir-cache-time duration Time to cache directory entries for (default 5m0s) @@ -323,7 +323,7 @@ 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. + --read-only Only allow read-only access. 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 @@ -335,7 +335,7 @@ on disk cache file. 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). +modified files from the cache (the related global flag `--checkers` has no effect on the VFS). --transfers int Number of file transfers to run in parallel (default 4) @@ -352,22 +352,22 @@ It is not allowed for two files in the same directory to differ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. -The `--vfs-case-insensitive` mount flag controls how rclone handles these -two cases. If its value is "false", rclone passes file names to the mounted -file system as-is. If the flag is "true" (or appears without a value on +The `--vfs-case-insensitive` VFS flag controls how rclone handles these +two cases. If its value is "false", rclone passes file names to the remote +as-is. If the flag is "true" (or appears without a value on the 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 +different than what is stored on the remote. 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. +controlled by the underlying remote. 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). +may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. If the flag is not provided on the command line, then its default value depends @@ -412,7 +412,7 @@ rclone serve http remote:path [flags] --no-seek Don't allow seeking in files --pass string Password for authentication --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --realm string Realm for authentication --salt string Password hashing salt (default "dlPL2MqE") --server-read-timeout duration Timeout for server reading data (default 1h0m0s) diff --git a/docs/content/commands/rclone_serve_sftp.md b/docs/content/commands/rclone_serve_sftp.md index 5995b9785..87b0ae313 100644 --- a/docs/content/commands/rclone_serve_sftp.md +++ b/docs/content/commands/rclone_serve_sftp.md @@ -79,7 +79,7 @@ about files and directories (but not the data) in memory. Using the `--dir-cache-time` flag, you can control how long a directory should be considered up to date and not refreshed from the -backend. Changes made through the mount will appear immediately or +backend. Changes made through the VFS will appear immediately or invalidate the cache. --dir-cache-time duration Time to cache directory entries for (default 5m0s) @@ -276,7 +276,7 @@ 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. + --read-only Only allow read-only access. 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 @@ -288,7 +288,7 @@ on disk cache file. 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). +modified files from the cache (the related global flag `--checkers` has no effect on the VFS). --transfers int Number of file transfers to run in parallel (default 4) @@ -305,22 +305,22 @@ It is not allowed for two files in the same directory to differ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. -The `--vfs-case-insensitive` mount flag controls how rclone handles these -two cases. If its value is "false", rclone passes file names to the mounted -file system as-is. If the flag is "true" (or appears without a value on +The `--vfs-case-insensitive` VFS flag controls how rclone handles these +two cases. If its value is "false", rclone passes file names to the remote +as-is. If the flag is "true" (or appears without a value on the 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 +different than what is stored on the remote. 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. +controlled by the underlying remote. 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). +may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. If the flag is not provided on the command line, then its default value depends @@ -444,7 +444,7 @@ rclone serve sftp remote:path [flags] --no-seek Don't allow seeking in files --pass string Password for authentication --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --stdio Run an sftp server on run stdin/stdout --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) diff --git a/docs/content/commands/rclone_serve_webdav.md b/docs/content/commands/rclone_serve_webdav.md index a240e67ab..172f001af 100644 --- a/docs/content/commands/rclone_serve_webdav.md +++ b/docs/content/commands/rclone_serve_webdav.md @@ -130,7 +130,7 @@ about files and directories (but not the data) in memory. Using the `--dir-cache-time` flag, you can control how long a directory should be considered up to date and not refreshed from the -backend. Changes made through the mount will appear immediately or +backend. Changes made through the VFS will appear immediately or invalidate the cache. --dir-cache-time duration Time to cache directory entries for (default 5m0s) @@ -327,7 +327,7 @@ 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. + --read-only Only allow read-only access. 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 @@ -339,7 +339,7 @@ on disk cache file. 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). +modified files from the cache (the related global flag `--checkers` has no effect on the VFS). --transfers int Number of file transfers to run in parallel (default 4) @@ -356,22 +356,22 @@ It is not allowed for two files in the same directory to differ only by case. Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. -The `--vfs-case-insensitive` mount flag controls how rclone handles these -two cases. If its value is "false", rclone passes file names to the mounted -file system as-is. If the flag is "true" (or appears without a value on +The `--vfs-case-insensitive` VFS flag controls how rclone handles these +two cases. If its value is "false", rclone passes file names to the remote +as-is. If the flag is "true" (or appears without a value on the 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 +different than what is stored on the remote. 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. +controlled by the underlying remote. 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). +may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target. If the flag is not provided on the command line, then its default value depends @@ -500,7 +500,7 @@ rclone serve webdav remote:path [flags] --no-seek Don't allow seeking in files --pass string Password for authentication --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --realm string Realm for authentication (default "rclone") --server-read-timeout duration Timeout for server reading data (default 1h0m0s) --server-write-timeout duration Timeout for server writing data (default 1h0m0s) diff --git a/docs/content/flags.md b/docs/content/flags.md index 12cd491f5..27634c1bb 100644 --- a/docs/content/flags.md +++ b/docs/content/flags.md @@ -157,7 +157,7 @@ These flags are available for every command. --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 (default "rclone/v1.58.0") + --user-agent string Set the user-agent to a specified string (default "rclone/v1.58.1") -v, --verbose count Print lots more stuff (repeat for more) ``` diff --git a/docs/content/netstorage.md b/docs/content/netstorage.md index 428fcc361..22587dbed 100644 --- a/docs/content/netstorage.md +++ b/docs/content/netstorage.md @@ -277,10 +277,4 @@ the object that will be the target of the symlink (for example, /links/mylink). Include the file extension for the object, if applicable. `rclone backend symlink ` -## Support - -If you have any questions or issues, please contact [Akamai Technical Support -via Control Center or by -phone](https://control.akamai.com/apps/support-ui/#/contact-support). - {{< rem autogenerated options stop >}} diff --git a/docs/content/s3.md b/docs/content/s3.md index 400bb3059..4b809ff90 100644 --- a/docs/content/s3.md +++ b/docs/content/s3.md @@ -567,7 +567,7 @@ A simple solution is to set the `--s3-upload-cutoff 0` and force all the files t {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/s3/s3.go then run make backenddocs" >}} ### Standard options -Here are the standard options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, ChinaMobile, Digital Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, RackCorp, SeaweedFS, and Tencent COS). +Here are the standard options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Digital Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, Netease, RackCorp, Scaleway, SeaweedFS, StackPath, Storj, Tencent COS and Wasabi). #### --s3-provider @@ -858,6 +858,8 @@ Properties: Endpoint for China Mobile Ecloud Elastic Object Storage (EOS) API. +Properties: + - Config: endpoint - Env Var: RCLONE_S3_ENDPOINT - Provider: ChinaMobile @@ -915,7 +917,7 @@ Endpoint for China Mobile Ecloud Elastic Object Storage (EOS) API. - Gansu China (Lanzhou) - "eos-shanxi-1.cmecloud.cn" - Shanxi China (Taiyuan) - - eos-liaoning-1.cmecloud.cn" + - "eos-liaoning-1.cmecloud.cn" - Liaoning China (Shenyang) - "eos-hebei-1.cmecloud.cn" - Hebei China (Shijiazhuang) @@ -1393,6 +1395,81 @@ Properties: #### --s3-location-constraint +Location constraint - must match endpoint. + +Used when creating buckets only. + +Properties: + +- Config: location_constraint +- Env Var: RCLONE_S3_LOCATION_CONSTRAINT +- Provider: ChinaMobile +- Type: string +- Required: false +- Examples: + - "wuxi1" + - East China (Suzhou) + - "jinan1" + - East China (Jinan) + - "ningbo1" + - East China (Hangzhou) + - "shanghai1" + - East China (Shanghai-1) + - "zhengzhou1" + - Central China (Zhengzhou) + - "hunan1" + - Central China (Changsha-1) + - "zhuzhou1" + - Central China (Changsha-2) + - "guangzhou1" + - South China (Guangzhou-2) + - "dongguan1" + - South China (Guangzhou-3) + - "beijing1" + - North China (Beijing-1) + - "beijing2" + - North China (Beijing-2) + - "beijing4" + - North China (Beijing-3) + - "huhehaote1" + - North China (Huhehaote) + - "chengdu1" + - Southwest China (Chengdu) + - "chongqing1" + - Southwest China (Chongqing) + - "guiyang1" + - Southwest China (Guiyang) + - "xian1" + - Nouthwest China (Xian) + - "yunnan" + - Yunnan China (Kunming) + - "yunnan2" + - Yunnan China (Kunming-2) + - "tianjin1" + - Tianjin China (Tianjin) + - "jilin1" + - Jilin China (Changchun) + - "hubei1" + - Hubei China (Xiangyan) + - "jiangxi1" + - Jiangxi China (Nanchang) + - "gansu1" + - Gansu China (Lanzhou) + - "shanxi1" + - Shanxi China (Taiyuan) + - "liaoning1" + - Liaoning China (Shenyang) + - "hebei1" + - Hebei China (Shijiazhuang) + - "fujian1" + - Fujian China (Xiamen) + - "guangxi1" + - Guangxi China (Nanning) + - "anhui1" + - Anhui China (Huainan) + +#### --s3-location-constraint + Location constraint - must match endpoint when using IBM Cloud Public. For on-prem COS, do not make a selection from this list, hit enter. @@ -1688,6 +1765,8 @@ Properties: The storage class to use when storing new objects in ChinaMobile. +Properties: + - Config: storage_class - Env Var: RCLONE_S3_STORAGE_CLASS - Provider: ChinaMobile @@ -1747,7 +1826,7 @@ Properties: ### Advanced options -Here are the advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, ChinaMobile, Digital Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, RackCorp, SeaweedFS, and Tencent COS). +Here are the advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Digital Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, Netease, RackCorp, Scaleway, SeaweedFS, StackPath, Storj, Tencent COS and Wasabi). #### --s3-bucket-acl diff --git a/rclone.1 b/rclone.1 index 157f41d56..7244e28ec 100644 --- a/rclone.1 +++ b/rclone.1 @@ -1,7 +1,7 @@ .\"t .\" Automatically generated by Pandoc 2.9.2.1 .\" -.TH "rclone" "1" "Mar 18, 2022" "User Manual" "" +.TH "rclone" "1" "Apr 29, 2022" "User Manual" "" .hy .SH Rclone syncs your files to cloud storage .PP @@ -157,6 +157,8 @@ Box .IP \[bu] 2 Ceph .IP \[bu] 2 +China Mobile Ecloud Elastic Object Storage (EOS) +.IP \[bu] 2 Citrix ShareFile .IP \[bu] 2 C14 @@ -4357,11 +4359,11 @@ feature at all, then 1 PiB is set as both the total and the free size. To run rclone mount on Windows, you will need to download and install WinFsp (http://www.secfs.net/winfsp/). .PP -WinFsp (https://github.com/billziss-gh/winfsp) is an open-source Windows -File System Proxy which makes it easy to write user space file systems -for Windows. +WinFsp (https://github.com/winfsp/winfsp) is an open-source Windows File +System Proxy which makes it easy to write user space file systems for +Windows. It provides a FUSE emulation layer which rclone uses combination with -cgofuse (https://github.com/billziss-gh/cgofuse). +cgofuse (https://github.com/winfsp/cgofuse). Both of these packages are by Bill Zissimopoulos who was very helpful during the implementation of rclone mount for Windows. .SS Mounting modes on windows @@ -4564,7 +4566,7 @@ to start processes as the SYSTEM account. Another alternative is to run the mount command from a Windows Scheduled Task, or a Windows Service, configured to run as the SYSTEM account. A third alternative is to use the WinFsp.Launcher -infrastructure (https://github.com/billziss-gh/winfsp/wiki/WinFsp-Service-Architecture)). +infrastructure (https://github.com/winfsp/winfsp/wiki/WinFsp-Service-Architecture)). Note that when running rclone as another user, it will not use the configuration file from your profile unless you tell it to with the \f[C]--config\f[R] (https://rclone.org/docs/#config-config-file) option. @@ -4781,7 +4783,7 @@ files and directories (but not the data) in memory. Using the \f[C]--dir-cache-time\f[R] flag, you can control how long a directory should be considered up to date and not refreshed from the backend. -Changes made through the mount will appear immediately or invalidate the +Changes made through the VFS will appear immediately or invalidate the cache. .IP .nf @@ -5023,7 +5025,7 @@ transaction. --no-checksum Don\[aq]t compare checksums on up/download. --no-modtime Don\[aq]t read/write the modification time (can speed things up). --no-seek Don\[aq]t allow seeking in files. ---read-only Mount read-only. +--read-only Only allow read-only access. \f[R] .fi .PP @@ -5041,8 +5043,8 @@ These flags only come into effect when not using an on disk cache file. .PP When using VFS write caching (\f[C]--vfs-cache-mode\f[R] with value writes or full), the global flag \f[C]--transfers\f[R] can be set to -adjust the number of parallel uploads of modified files from cache (the -related global flag \f[C]--checkers\f[R] have no effect on mount). +adjust the number of parallel uploads of modified files from the cache +(the related global flag \f[C]--checkers\f[R] has no effect on the VFS). .IP .nf \f[C] @@ -5065,15 +5067,15 @@ Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. .PP -The \f[C]--vfs-case-insensitive\f[R] mount flag controls how rclone +The \f[C]--vfs-case-insensitive\f[R] VFS flag controls how rclone handles these two cases. -If its value is \[dq]false\[dq], rclone passes file names to the mounted -file system as-is. -If the flag is \[dq]true\[dq] (or appears without a value on command +If its value is \[dq]false\[dq], rclone passes file names to the remote +as-is. +If the flag is \[dq]true\[dq] (or appears without a value on the command line), rclone may perform a \[dq]fixup\[dq] as explained below. .PP The user may specify a file name to open/delete/rename/etc with a case -different than what is stored on mounted file system. +different than what is stored on the remote. 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 @@ -5081,10 +5083,10 @@ 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. +the underlying remote. .PP Note that case sensitivity of the operating system running rclone (the -target) may differ from case sensitivity of a file system mounted by +target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether \[dq]fixup\[dq] is performed to satisfy the target. @@ -5144,7 +5146,7 @@ rclone mount remote:path /path/to/mountpoint [flags] --noapplexattr Ignore all \[dq]com.apple.*\[dq] extended attributes (supported on OSX only) -o, --option stringArray Option for libfuse/WinFsp (repeat if required) --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) --vfs-cache-max-age duration Max age of objects in the cache (default 1h0m0s) @@ -5790,7 +5792,7 @@ files and directories (but not the data) in memory. Using the \f[C]--dir-cache-time\f[R] flag, you can control how long a directory should be considered up to date and not refreshed from the backend. -Changes made through the mount will appear immediately or invalidate the +Changes made through the VFS will appear immediately or invalidate the cache. .IP .nf @@ -6032,7 +6034,7 @@ transaction. --no-checksum Don\[aq]t compare checksums on up/download. --no-modtime Don\[aq]t read/write the modification time (can speed things up). --no-seek Don\[aq]t allow seeking in files. ---read-only Mount read-only. +--read-only Only allow read-only access. \f[R] .fi .PP @@ -6050,8 +6052,8 @@ These flags only come into effect when not using an on disk cache file. .PP When using VFS write caching (\f[C]--vfs-cache-mode\f[R] with value writes or full), the global flag \f[C]--transfers\f[R] can be set to -adjust the number of parallel uploads of modified files from cache (the -related global flag \f[C]--checkers\f[R] have no effect on mount). +adjust the number of parallel uploads of modified files from the cache +(the related global flag \f[C]--checkers\f[R] has no effect on the VFS). .IP .nf \f[C] @@ -6074,15 +6076,15 @@ Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. .PP -The \f[C]--vfs-case-insensitive\f[R] mount flag controls how rclone +The \f[C]--vfs-case-insensitive\f[R] VFS flag controls how rclone handles these two cases. -If its value is \[dq]false\[dq], rclone passes file names to the mounted -file system as-is. -If the flag is \[dq]true\[dq] (or appears without a value on command +If its value is \[dq]false\[dq], rclone passes file names to the remote +as-is. +If the flag is \[dq]true\[dq] (or appears without a value on the command line), rclone may perform a \[dq]fixup\[dq] as explained below. .PP The user may specify a file name to open/delete/rename/etc with a case -different than what is stored on mounted file system. +different than what is stored on the remote. 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 @@ -6090,10 +6092,10 @@ 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. +the underlying remote. .PP Note that case sensitivity of the operating system running rclone (the -target) may differ from case sensitivity of a file system mounted by +target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether \[dq]fixup\[dq] is performed to satisfy the target. @@ -6139,7 +6141,7 @@ rclone serve dlna remote:path [flags] --no-modtime Don\[aq]t read/write the modification time (can speed things up) --no-seek Don\[aq]t allow seeking in files --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) --vfs-cache-max-age duration Max age of objects in the cache (default 1h0m0s) @@ -6236,7 +6238,7 @@ files and directories (but not the data) in memory. Using the \f[C]--dir-cache-time\f[R] flag, you can control how long a directory should be considered up to date and not refreshed from the backend. -Changes made through the mount will appear immediately or invalidate the +Changes made through the VFS will appear immediately or invalidate the cache. .IP .nf @@ -6478,7 +6480,7 @@ transaction. --no-checksum Don\[aq]t compare checksums on up/download. --no-modtime Don\[aq]t read/write the modification time (can speed things up). --no-seek Don\[aq]t allow seeking in files. ---read-only Mount read-only. +--read-only Only allow read-only access. \f[R] .fi .PP @@ -6496,8 +6498,8 @@ These flags only come into effect when not using an on disk cache file. .PP When using VFS write caching (\f[C]--vfs-cache-mode\f[R] with value writes or full), the global flag \f[C]--transfers\f[R] can be set to -adjust the number of parallel uploads of modified files from cache (the -related global flag \f[C]--checkers\f[R] have no effect on mount). +adjust the number of parallel uploads of modified files from the cache +(the related global flag \f[C]--checkers\f[R] has no effect on the VFS). .IP .nf \f[C] @@ -6520,15 +6522,15 @@ Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. .PP -The \f[C]--vfs-case-insensitive\f[R] mount flag controls how rclone +The \f[C]--vfs-case-insensitive\f[R] VFS flag controls how rclone handles these two cases. -If its value is \[dq]false\[dq], rclone passes file names to the mounted -file system as-is. -If the flag is \[dq]true\[dq] (or appears without a value on command +If its value is \[dq]false\[dq], rclone passes file names to the remote +as-is. +If the flag is \[dq]true\[dq] (or appears without a value on the command line), rclone may perform a \[dq]fixup\[dq] as explained below. .PP The user may specify a file name to open/delete/rename/etc with a case -different than what is stored on mounted file system. +different than what is stored on the remote. 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 @@ -6536,10 +6538,10 @@ 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. +the underlying remote. .PP Note that case sensitivity of the operating system running rclone (the -target) may differ from case sensitivity of a file system mounted by +target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether \[dq]fixup\[dq] is performed to satisfy the target. @@ -6602,7 +6604,7 @@ rclone serve docker [flags] --noapplexattr Ignore all \[dq]com.apple.*\[dq] extended attributes (supported on OSX only) -o, --option stringArray Option for libfuse/WinFsp (repeat if required) --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --socket-addr string Address or absolute path (default: /run/docker/plugins/rclone.sock) --socket-gid int GID for unix socket (default: current process GID) (default 1000) --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) @@ -6674,7 +6676,7 @@ files and directories (but not the data) in memory. Using the \f[C]--dir-cache-time\f[R] flag, you can control how long a directory should be considered up to date and not refreshed from the backend. -Changes made through the mount will appear immediately or invalidate the +Changes made through the VFS will appear immediately or invalidate the cache. .IP .nf @@ -6916,7 +6918,7 @@ transaction. --no-checksum Don\[aq]t compare checksums on up/download. --no-modtime Don\[aq]t read/write the modification time (can speed things up). --no-seek Don\[aq]t allow seeking in files. ---read-only Mount read-only. +--read-only Only allow read-only access. \f[R] .fi .PP @@ -6934,8 +6936,8 @@ These flags only come into effect when not using an on disk cache file. .PP When using VFS write caching (\f[C]--vfs-cache-mode\f[R] with value writes or full), the global flag \f[C]--transfers\f[R] can be set to -adjust the number of parallel uploads of modified files from cache (the -related global flag \f[C]--checkers\f[R] have no effect on mount). +adjust the number of parallel uploads of modified files from the cache +(the related global flag \f[C]--checkers\f[R] has no effect on the VFS). .IP .nf \f[C] @@ -6958,15 +6960,15 @@ Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. .PP -The \f[C]--vfs-case-insensitive\f[R] mount flag controls how rclone +The \f[C]--vfs-case-insensitive\f[R] VFS flag controls how rclone handles these two cases. -If its value is \[dq]false\[dq], rclone passes file names to the mounted -file system as-is. -If the flag is \[dq]true\[dq] (or appears without a value on command +If its value is \[dq]false\[dq], rclone passes file names to the remote +as-is. +If the flag is \[dq]true\[dq] (or appears without a value on the command line), rclone may perform a \[dq]fixup\[dq] as explained below. .PP The user may specify a file name to open/delete/rename/etc with a case -different than what is stored on mounted file system. +different than what is stored on the remote. 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 @@ -6974,10 +6976,10 @@ 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. +the underlying remote. .PP Note that case sensitivity of the operating system running rclone (the -target) may differ from case sensitivity of a file system mounted by +target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether \[dq]fixup\[dq] is performed to satisfy the target. @@ -7120,7 +7122,7 @@ rclone serve ftp remote:path [flags] --passive-port string Passive port range to use (default \[dq]30000-32000\[dq]) --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) --public-ip string Public IP address to advertise for passive connections - --read-only Mount read-only + --read-only Only allow read-only access --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) --user string User name for authentication (default \[dq]anonymous\[dq]) @@ -7344,7 +7346,7 @@ files and directories (but not the data) in memory. Using the \f[C]--dir-cache-time\f[R] flag, you can control how long a directory should be considered up to date and not refreshed from the backend. -Changes made through the mount will appear immediately or invalidate the +Changes made through the VFS will appear immediately or invalidate the cache. .IP .nf @@ -7586,7 +7588,7 @@ transaction. --no-checksum Don\[aq]t compare checksums on up/download. --no-modtime Don\[aq]t read/write the modification time (can speed things up). --no-seek Don\[aq]t allow seeking in files. ---read-only Mount read-only. +--read-only Only allow read-only access. \f[R] .fi .PP @@ -7604,8 +7606,8 @@ These flags only come into effect when not using an on disk cache file. .PP When using VFS write caching (\f[C]--vfs-cache-mode\f[R] with value writes or full), the global flag \f[C]--transfers\f[R] can be set to -adjust the number of parallel uploads of modified files from cache (the -related global flag \f[C]--checkers\f[R] have no effect on mount). +adjust the number of parallel uploads of modified files from the cache +(the related global flag \f[C]--checkers\f[R] has no effect on the VFS). .IP .nf \f[C] @@ -7628,15 +7630,15 @@ Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. .PP -The \f[C]--vfs-case-insensitive\f[R] mount flag controls how rclone +The \f[C]--vfs-case-insensitive\f[R] VFS flag controls how rclone handles these two cases. -If its value is \[dq]false\[dq], rclone passes file names to the mounted -file system as-is. -If the flag is \[dq]true\[dq] (or appears without a value on command +If its value is \[dq]false\[dq], rclone passes file names to the remote +as-is. +If the flag is \[dq]true\[dq] (or appears without a value on the command line), rclone may perform a \[dq]fixup\[dq] as explained below. .PP The user may specify a file name to open/delete/rename/etc with a case -different than what is stored on mounted file system. +different than what is stored on the remote. 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 @@ -7644,10 +7646,10 @@ 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. +the underlying remote. .PP Note that case sensitivity of the operating system running rclone (the -target) may differ from case sensitivity of a file system mounted by +target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether \[dq]fixup\[dq] is performed to satisfy the target. @@ -7698,7 +7700,7 @@ rclone serve http remote:path [flags] --no-seek Don\[aq]t allow seeking in files --pass string Password for authentication --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --realm string Realm for authentication --salt string Password hashing salt (default \[dq]dlPL2MqE\[dq]) --server-read-timeout duration Timeout for server reading data (default 1h0m0s) @@ -8105,7 +8107,7 @@ files and directories (but not the data) in memory. Using the \f[C]--dir-cache-time\f[R] flag, you can control how long a directory should be considered up to date and not refreshed from the backend. -Changes made through the mount will appear immediately or invalidate the +Changes made through the VFS will appear immediately or invalidate the cache. .IP .nf @@ -8347,7 +8349,7 @@ transaction. --no-checksum Don\[aq]t compare checksums on up/download. --no-modtime Don\[aq]t read/write the modification time (can speed things up). --no-seek Don\[aq]t allow seeking in files. ---read-only Mount read-only. +--read-only Only allow read-only access. \f[R] .fi .PP @@ -8365,8 +8367,8 @@ These flags only come into effect when not using an on disk cache file. .PP When using VFS write caching (\f[C]--vfs-cache-mode\f[R] with value writes or full), the global flag \f[C]--transfers\f[R] can be set to -adjust the number of parallel uploads of modified files from cache (the -related global flag \f[C]--checkers\f[R] have no effect on mount). +adjust the number of parallel uploads of modified files from the cache +(the related global flag \f[C]--checkers\f[R] has no effect on the VFS). .IP .nf \f[C] @@ -8389,15 +8391,15 @@ Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. .PP -The \f[C]--vfs-case-insensitive\f[R] mount flag controls how rclone +The \f[C]--vfs-case-insensitive\f[R] VFS flag controls how rclone handles these two cases. -If its value is \[dq]false\[dq], rclone passes file names to the mounted -file system as-is. -If the flag is \[dq]true\[dq] (or appears without a value on command +If its value is \[dq]false\[dq], rclone passes file names to the remote +as-is. +If the flag is \[dq]true\[dq] (or appears without a value on the command line), rclone may perform a \[dq]fixup\[dq] as explained below. .PP The user may specify a file name to open/delete/rename/etc with a case -different than what is stored on mounted file system. +different than what is stored on the remote. 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 @@ -8405,10 +8407,10 @@ 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. +the underlying remote. .PP Note that case sensitivity of the operating system running rclone (the -target) may differ from case sensitivity of a file system mounted by +target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether \[dq]fixup\[dq] is performed to satisfy the target. @@ -8550,7 +8552,7 @@ rclone serve sftp remote:path [flags] --no-seek Don\[aq]t allow seeking in files --pass string Password for authentication --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --stdio Run an sftp server on run stdin/stdout --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) @@ -8776,7 +8778,7 @@ files and directories (but not the data) in memory. Using the \f[C]--dir-cache-time\f[R] flag, you can control how long a directory should be considered up to date and not refreshed from the backend. -Changes made through the mount will appear immediately or invalidate the +Changes made through the VFS will appear immediately or invalidate the cache. .IP .nf @@ -9018,7 +9020,7 @@ transaction. --no-checksum Don\[aq]t compare checksums on up/download. --no-modtime Don\[aq]t read/write the modification time (can speed things up). --no-seek Don\[aq]t allow seeking in files. ---read-only Mount read-only. +--read-only Only allow read-only access. \f[R] .fi .PP @@ -9036,8 +9038,8 @@ These flags only come into effect when not using an on disk cache file. .PP When using VFS write caching (\f[C]--vfs-cache-mode\f[R] with value writes or full), the global flag \f[C]--transfers\f[R] can be set to -adjust the number of parallel uploads of modified files from cache (the -related global flag \f[C]--checkers\f[R] have no effect on mount). +adjust the number of parallel uploads of modified files from the cache +(the related global flag \f[C]--checkers\f[R] has no effect on the VFS). .IP .nf \f[C] @@ -9060,15 +9062,15 @@ Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default. .PP -The \f[C]--vfs-case-insensitive\f[R] mount flag controls how rclone +The \f[C]--vfs-case-insensitive\f[R] VFS flag controls how rclone handles these two cases. -If its value is \[dq]false\[dq], rclone passes file names to the mounted -file system as-is. -If the flag is \[dq]true\[dq] (or appears without a value on command +If its value is \[dq]false\[dq], rclone passes file names to the remote +as-is. +If the flag is \[dq]true\[dq] (or appears without a value on the command line), rclone may perform a \[dq]fixup\[dq] as explained below. .PP The user may specify a file name to open/delete/rename/etc with a case -different than what is stored on mounted file system. +different than what is stored on the remote. 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 @@ -9076,10 +9078,10 @@ 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. +the underlying remote. .PP Note that case sensitivity of the operating system running rclone (the -target) may differ from case sensitivity of a file system mounted by +target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether \[dq]fixup\[dq] is performed to satisfy the target. @@ -9226,7 +9228,7 @@ rclone serve webdav remote:path [flags] --no-seek Don\[aq]t allow seeking in files --pass string Password for authentication --poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) - --read-only Mount read-only + --read-only Only allow read-only access --realm string Realm for authentication (default \[dq]rclone\[dq]) --server-read-timeout duration Timeout for server reading data (default 1h0m0s) --server-write-timeout duration Timeout for server writing data (default 1h0m0s) @@ -10691,25 +10693,28 @@ For counts the SI standard notation is used, e.g. prefix \f[C]k\f[R] for kilo. Used with file counts, \f[C]1k\f[R] means 1000 files. .PP -The various list commands output raw numbers by default. +The various list (https://rclone.org/commands/rclone_ls/) commands +output raw numbers by default. Option \f[C]--human-readable\f[R] will make them output values in human-readable format instead (with the short unit prefix). .PP -The about command outputs human-readable by default, with a -command-specific option \f[C]--full\f[R] to output the raw numbers -instead. +The about (https://rclone.org/commands/rclone_about/) command outputs +human-readable by default, with a command-specific option +\f[C]--full\f[R] to output the raw numbers instead. .PP -Command size outputs both human-readable and raw numbers in the same -output. +Command size (https://rclone.org/commands/rclone_size/) outputs both +human-readable and raw numbers in the same output. .PP -The tree command also considers \f[C]--human-readable\f[R], but it will -not use the exact same notation as the other commands: It rounds to one -decimal, and uses single letter suffix, e.g. +The tree (https://rclone.org/commands/rclone_tree/) command also +considers \f[C]--human-readable\f[R], but it will not use the exact same +notation as the other commands: It rounds to one decimal, and uses +single letter suffix, e.g. \f[C]K\f[R] instead of \f[C]Ki\f[R]. The reason for this is that it relies on an external library. .PP -The interactive command ncdu shows human-readable by default, and -responds to key \f[C]u\f[R] for toggling human-readable format. +The interactive command ncdu (https://rclone.org/commands/rclone_ncdu/) +shows human-readable by default, and responds to key \f[C]u\f[R] for +toggling human-readable format. .SS --ignore-case-sync .PP Using this option will cause rclone to ignore the case of the files when @@ -11634,6 +11639,9 @@ is giving a lot of timeouts or bigger if you have lots of bandwidth and a fast remote. .PP The default is to run 4 file transfers in parallel. +.PP +Look at --multi-thread-streams if you would like to control single file +transfers. .SS -u, --update .PP This forces rclone to skip any files which exist on the destination and @@ -18316,7 +18324,7 @@ These flags are available for every command. --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 (default \[dq]rclone/v1.58.0\[dq]) + --user-agent string Set the user-agent to a specified string (default \[dq]rclone/v1.58.1\[dq]) -v, --verbose count Print lots more stuff (repeat for more) \f[R] .fi @@ -21785,6 +21793,8 @@ Alibaba Cloud (Aliyun) Object Storage System (OSS) .IP \[bu] 2 Ceph .IP \[bu] 2 +China Mobile Ecloud Elastic Object Storage (EOS) +.IP \[bu] 2 DigitalOcean Spaces .IP \[bu] 2 Dreamhost @@ -21876,7 +21886,7 @@ name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] -XX / Amazon S3 Compliant Storage Providers including AWS, Ceph, Dreamhost, IBM COS, Minio, and Tencent COS +XX / Amazon S3 Compliant Storage Providers including AWS, Ceph, ChinaMobile, Dreamhost, IBM COS, Minio, and Tencent COS \[rs] \[dq]s3\[dq] [snip] Storage> s3 @@ -22501,9 +22511,9 @@ all the files to be uploaded as multipart. .SS Standard options .PP Here are the standard options specific to s3 (Amazon S3 Compliant -Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, -Dreamhost, IBM COS, Lyve Cloud, Minio, RackCorp, SeaweedFS, and Tencent -COS). +Storage Providers including AWS, Alibaba, Ceph, China Mobile, Digital +Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, Netease, RackCorp, +Scaleway, SeaweedFS, StackPath, Storj, Tencent COS and Wasabi). .SS --s3-provider .PP Choose your S3 provider. @@ -22539,6 +22549,12 @@ Alibaba Cloud Object Storage System (OSS) formerly Aliyun Ceph Object Storage .RE .IP \[bu] 2 +\[dq]ChinaMobile\[dq] +.RS 2 +.IP \[bu] 2 +China Mobile Ecloud Elastic Object Storage (EOS) +.RE +.IP \[bu] 2 \[dq]DigitalOcean\[dq] .RS 2 .IP \[bu] 2 @@ -23084,7 +23100,7 @@ Config: region .IP \[bu] 2 Env Var: RCLONE_S3_REGION .IP \[bu] 2 -Provider: !AWS,Alibaba,RackCorp,Scaleway,Storj,TencentCOS +Provider: !AWS,Alibaba,ChinaMobile,RackCorp,Scaleway,Storj,TencentCOS .IP \[bu] 2 Type: string .IP \[bu] 2 @@ -23129,6 +23145,207 @@ Type: string Required: false .SS --s3-endpoint .PP +Endpoint for China Mobile Ecloud Elastic Object Storage (EOS) API. +.PP +Properties: +.IP \[bu] 2 +Config: endpoint +.IP \[bu] 2 +Env Var: RCLONE_S3_ENDPOINT +.IP \[bu] 2 +Provider: ChinaMobile +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Required: false +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]eos-wuxi-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +The default endpoint - a good choice if you are unsure. +.IP \[bu] 2 +East China (Suzhou) +.RE +.IP \[bu] 2 +\[dq]eos-jinan-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +East China (Jinan) +.RE +.IP \[bu] 2 +\[dq]eos-ningbo-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +East China (Hangzhou) +.RE +.IP \[bu] 2 +\[dq]eos-shanghai-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +East China (Shanghai-1) +.RE +.IP \[bu] 2 +\[dq]eos-zhengzhou-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +Central China (Zhengzhou) +.RE +.IP \[bu] 2 +\[dq]eos-hunan-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +Central China (Changsha-1) +.RE +.IP \[bu] 2 +\[dq]eos-zhuzhou-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +Central China (Changsha-2) +.RE +.IP \[bu] 2 +\[dq]eos-guangzhou-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +South China (Guangzhou-2) +.RE +.IP \[bu] 2 +\[dq]eos-dongguan-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +South China (Guangzhou-3) +.RE +.IP \[bu] 2 +\[dq]eos-beijing-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +North China (Beijing-1) +.RE +.IP \[bu] 2 +\[dq]eos-beijing-2.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +North China (Beijing-2) +.RE +.IP \[bu] 2 +\[dq]eos-beijing-4.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +North China (Beijing-3) +.RE +.IP \[bu] 2 +\[dq]eos-huhehaote-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +North China (Huhehaote) +.RE +.IP \[bu] 2 +\[dq]eos-chengdu-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +Southwest China (Chengdu) +.RE +.IP \[bu] 2 +\[dq]eos-chongqing-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +Southwest China (Chongqing) +.RE +.IP \[bu] 2 +\[dq]eos-guiyang-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +Southwest China (Guiyang) +.RE +.IP \[bu] 2 +\[dq]eos-xian-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +Nouthwest China (Xian) +.RE +.IP \[bu] 2 +\[dq]eos-yunnan.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +Yunnan China (Kunming) +.RE +.IP \[bu] 2 +\[dq]eos-yunnan-2.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +Yunnan China (Kunming-2) +.RE +.IP \[bu] 2 +\[dq]eos-tianjin-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +Tianjin China (Tianjin) +.RE +.IP \[bu] 2 +\[dq]eos-jilin-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +Jilin China (Changchun) +.RE +.IP \[bu] 2 +\[dq]eos-hubei-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +Hubei China (Xiangyan) +.RE +.IP \[bu] 2 +\[dq]eos-jiangxi-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +Jiangxi China (Nanchang) +.RE +.IP \[bu] 2 +\[dq]eos-gansu-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +Gansu China (Lanzhou) +.RE +.IP \[bu] 2 +\[dq]eos-shanxi-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +Shanxi China (Taiyuan) +.RE +.IP \[bu] 2 +\[dq]eos-liaoning-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +Liaoning China (Shenyang) +.RE +.IP \[bu] 2 +\[dq]eos-hebei-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +Hebei China (Shijiazhuang) +.RE +.IP \[bu] 2 +\[dq]eos-fujian-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +Fujian China (Xiamen) +.RE +.IP \[bu] 2 +\[dq]eos-guangxi-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +Guangxi China (Nanning) +.RE +.IP \[bu] 2 +\[dq]eos-anhui-1.cmecloud.cn\[dq] +.RS 2 +.IP \[bu] 2 +Anhui China (Huainan) +.RE +.RE +.SS --s3-endpoint +.PP Endpoint for IBM COS S3 API. .PP Specify if using an IBM COS On Premise. @@ -24073,7 +24290,7 @@ Config: endpoint Env Var: RCLONE_S3_ENDPOINT .IP \[bu] 2 Provider: -!AWS,IBMCOS,TencentCOS,Alibaba,Scaleway,StackPath,Storj,RackCorp +!AWS,IBMCOS,TencentCOS,Alibaba,ChinaMobile,Scaleway,StackPath,Storj,RackCorp .IP \[bu] 2 Type: string .IP \[bu] 2 @@ -24333,6 +24550,207 @@ AWS GovCloud (US) Region .RE .SS --s3-location-constraint .PP +Location constraint - must match endpoint. +.PP +Used when creating buckets only. +.PP +Properties: +.IP \[bu] 2 +Config: location_constraint +.IP \[bu] 2 +Env Var: RCLONE_S3_LOCATION_CONSTRAINT +.IP \[bu] 2 +Provider: ChinaMobile +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Required: false +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]wuxi1\[dq] +.RS 2 +.IP \[bu] 2 +East China (Suzhou) +.RE +.IP \[bu] 2 +\[dq]jinan1\[dq] +.RS 2 +.IP \[bu] 2 +East China (Jinan) +.RE +.IP \[bu] 2 +\[dq]ningbo1\[dq] +.RS 2 +.IP \[bu] 2 +East China (Hangzhou) +.RE +.IP \[bu] 2 +\[dq]shanghai1\[dq] +.RS 2 +.IP \[bu] 2 +East China (Shanghai-1) +.RE +.IP \[bu] 2 +\[dq]zhengzhou1\[dq] +.RS 2 +.IP \[bu] 2 +Central China (Zhengzhou) +.RE +.IP \[bu] 2 +\[dq]hunan1\[dq] +.RS 2 +.IP \[bu] 2 +Central China (Changsha-1) +.RE +.IP \[bu] 2 +\[dq]zhuzhou1\[dq] +.RS 2 +.IP \[bu] 2 +Central China (Changsha-2) +.RE +.IP \[bu] 2 +\[dq]guangzhou1\[dq] +.RS 2 +.IP \[bu] 2 +South China (Guangzhou-2) +.RE +.IP \[bu] 2 +\[dq]dongguan1\[dq] +.RS 2 +.IP \[bu] 2 +South China (Guangzhou-3) +.RE +.IP \[bu] 2 +\[dq]beijing1\[dq] +.RS 2 +.IP \[bu] 2 +North China (Beijing-1) +.RE +.IP \[bu] 2 +\[dq]beijing2\[dq] +.RS 2 +.IP \[bu] 2 +North China (Beijing-2) +.RE +.IP \[bu] 2 +\[dq]beijing4\[dq] +.RS 2 +.IP \[bu] 2 +North China (Beijing-3) +.RE +.IP \[bu] 2 +\[dq]huhehaote1\[dq] +.RS 2 +.IP \[bu] 2 +North China (Huhehaote) +.RE +.IP \[bu] 2 +\[dq]chengdu1\[dq] +.RS 2 +.IP \[bu] 2 +Southwest China (Chengdu) +.RE +.IP \[bu] 2 +\[dq]chongqing1\[dq] +.RS 2 +.IP \[bu] 2 +Southwest China (Chongqing) +.RE +.IP \[bu] 2 +\[dq]guiyang1\[dq] +.RS 2 +.IP \[bu] 2 +Southwest China (Guiyang) +.RE +.IP \[bu] 2 +\[dq]xian1\[dq] +.RS 2 +.IP \[bu] 2 +Nouthwest China (Xian) +.RE +.IP \[bu] 2 +\[dq]yunnan\[dq] +.RS 2 +.IP \[bu] 2 +Yunnan China (Kunming) +.RE +.IP \[bu] 2 +\[dq]yunnan2\[dq] +.RS 2 +.IP \[bu] 2 +Yunnan China (Kunming-2) +.RE +.IP \[bu] 2 +\[dq]tianjin1\[dq] +.RS 2 +.IP \[bu] 2 +Tianjin China (Tianjin) +.RE +.IP \[bu] 2 +\[dq]jilin1\[dq] +.RS 2 +.IP \[bu] 2 +Jilin China (Changchun) +.RE +.IP \[bu] 2 +\[dq]hubei1\[dq] +.RS 2 +.IP \[bu] 2 +Hubei China (Xiangyan) +.RE +.IP \[bu] 2 +\[dq]jiangxi1\[dq] +.RS 2 +.IP \[bu] 2 +Jiangxi China (Nanchang) +.RE +.IP \[bu] 2 +\[dq]gansu1\[dq] +.RS 2 +.IP \[bu] 2 +Gansu China (Lanzhou) +.RE +.IP \[bu] 2 +\[dq]shanxi1\[dq] +.RS 2 +.IP \[bu] 2 +Shanxi China (Taiyuan) +.RE +.IP \[bu] 2 +\[dq]liaoning1\[dq] +.RS 2 +.IP \[bu] 2 +Liaoning China (Shenyang) +.RE +.IP \[bu] 2 +\[dq]hebei1\[dq] +.RS 2 +.IP \[bu] 2 +Hebei China (Shijiazhuang) +.RE +.IP \[bu] 2 +\[dq]fujian1\[dq] +.RS 2 +.IP \[bu] 2 +Fujian China (Xiamen) +.RE +.IP \[bu] 2 +\[dq]guangxi1\[dq] +.RS 2 +.IP \[bu] 2 +Guangxi China (Nanning) +.RE +.IP \[bu] 2 +\[dq]anhui1\[dq] +.RS 2 +.IP \[bu] 2 +Anhui China (Huainan) +.RE +.RE +.SS --s3-location-constraint +.PP Location constraint - must match endpoint when using IBM Cloud Public. .PP For on-prem COS, do not make a selection from this list, hit enter. @@ -24692,7 +25110,7 @@ Config: location_constraint Env Var: RCLONE_S3_LOCATION_CONSTRAINT .IP \[bu] 2 Provider: -!AWS,IBMCOS,Alibaba,RackCorp,Scaleway,StackPath,Storj,TencentCOS +!AWS,IBMCOS,Alibaba,ChinaMobile,RackCorp,Scaleway,StackPath,Storj,TencentCOS .IP \[bu] 2 Type: string .IP \[bu] 2 @@ -24843,7 +25261,7 @@ Config: server_side_encryption .IP \[bu] 2 Env Var: RCLONE_S3_SERVER_SIDE_ENCRYPTION .IP \[bu] 2 -Provider: AWS,Ceph,Minio +Provider: AWS,Ceph,ChinaMobile,Minio .IP \[bu] 2 Type: string .IP \[bu] 2 @@ -25019,6 +25437,49 @@ Infrequent access storage mode .RE .SS --s3-storage-class .PP +The storage class to use when storing new objects in ChinaMobile. +.PP +Properties: +.IP \[bu] 2 +Config: storage_class +.IP \[bu] 2 +Env Var: RCLONE_S3_STORAGE_CLASS +.IP \[bu] 2 +Provider: ChinaMobile +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Required: false +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +Default +.RE +.IP \[bu] 2 +\[dq]STANDARD\[dq] +.RS 2 +.IP \[bu] 2 +Standard storage class +.RE +.IP \[bu] 2 +\[dq]GLACIER\[dq] +.RS 2 +.IP \[bu] 2 +Archive storage mode +.RE +.IP \[bu] 2 +\[dq]STANDARD_IA\[dq] +.RS 2 +.IP \[bu] 2 +Infrequent access storage mode +.RE +.RE +.SS --s3-storage-class +.PP The storage class to use when storing new objects in Tencent COS. .PP Properties: @@ -25104,9 +25565,9 @@ Prices are lower, but it needs to be restored first to be accessed. .SS Advanced options .PP Here are the advanced options specific to s3 (Amazon S3 Compliant -Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, -Dreamhost, IBM COS, Lyve Cloud, Minio, RackCorp, SeaweedFS, and Tencent -COS). +Storage Providers including AWS, Alibaba, Ceph, China Mobile, Digital +Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, Netease, RackCorp, +Scaleway, SeaweedFS, StackPath, Storj, Tencent COS and Wasabi). .SS --s3-bucket-acl .PP Canned ACL used when creating buckets. @@ -25190,7 +25651,7 @@ Config: sse_customer_algorithm .IP \[bu] 2 Env Var: RCLONE_S3_SSE_CUSTOMER_ALGORITHM .IP \[bu] 2 -Provider: AWS,Ceph,Minio +Provider: AWS,Ceph,ChinaMobile,Minio .IP \[bu] 2 Type: string .IP \[bu] 2 @@ -25222,7 +25683,7 @@ Config: sse_customer_key .IP \[bu] 2 Env Var: RCLONE_S3_SSE_CUSTOMER_KEY .IP \[bu] 2 -Provider: AWS,Ceph,Minio +Provider: AWS,Ceph,ChinaMobile,Minio .IP \[bu] 2 Type: string .IP \[bu] 2 @@ -25251,7 +25712,7 @@ Config: sse_customer_key_md5 .IP \[bu] 2 Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_MD5 .IP \[bu] 2 -Provider: AWS,Ceph,Minio +Provider: AWS,Ceph,ChinaMobile,Minio .IP \[bu] 2 Type: string .IP \[bu] 2 @@ -26192,7 +26653,7 @@ Choose a number from below, or type in your own value \[rs] \[dq]alias\[dq] 2 / Amazon Drive \[rs] \[dq]amazon cloud drive\[dq] - 3 / Amazon S3 Complaint Storage Providers (Dreamhost, Ceph, Minio, IBM COS) + 3 / Amazon S3 Complaint Storage Providers (Dreamhost, Ceph, ChinaMobile, Minio, IBM COS) \[rs] \[dq]s3\[dq] 4 / Backblaze B2 \[rs] \[dq]b2\[dq] @@ -26502,6 +26963,15 @@ server_side_encryption = storage_class = \f[R] .fi +.PP +C14 Cold Storage (https://www.online.net/en/storage/c14-cold-storage) is +the low-cost S3 Glacier alternative from Scaleway and it works the same +way as on S3 by accepting the \[dq]GLACIER\[dq] \f[C]storage_class\f[R]. +So you can configure your remote with the +\f[C]storage_class = GLACIER\f[R] option to upload directly to C14. +Don\[aq]t forget that in this state you can\[aq]t read files back after, +you will need to restore them to \[dq]STANDARD\[dq] storage_class first +before being able to read them (see \[dq]restore\[dq] section above) .SS Seagate Lyve Cloud .PP Seagate Lyve @@ -26533,7 +27003,7 @@ Choose \f[C]s3\f[R] backend Type of storage to configure. Choose a number from below, or type in your own value. [snip] -XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, RackCorp, SeaweedFS, and Tencent COS +XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, ChinaMobile, Digital Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, RackCorp, SeaweedFS, and Tencent COS \[rs] (s3) [snip] Storage> s3 @@ -26750,7 +27220,7 @@ name> wasabi Type of storage to configure. Choose a number from below, or type in your own value [snip] -XX / Amazon S3 (also Dreamhost, Ceph, Minio) +XX / Amazon S3 (also Dreamhost, Ceph, ChinaMobile, Minio) \[rs] \[dq]s3\[dq] [snip] Storage> s3 @@ -26872,7 +27342,7 @@ Type of storage to configure. Enter a string value. Press Enter for the default (\[dq]\[dq]). Choose a number from below, or type in your own value [snip] - 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS + 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, ChinaMobile, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS \[rs] \[dq]s3\[dq] [snip] Storage> s3 @@ -26962,6 +27432,263 @@ d) Delete this remote y/e/d> y \f[R] .fi +.SS China Mobile Ecloud Elastic Object Storage (EOS) +.PP +Here is an example of making an China Mobile Ecloud Elastic Object +Storage (EOS) (https:///ecloud.10086.cn/home/product-introduction/eos/) +configuration. +First run: +.IP +.nf +\f[C] +rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process. +.IP +.nf +\f[C] +No remotes found, make a new one? +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> ChinaMobile +Option Storage. +Type of storage to configure. +Choose a number from below, or type in your own value. + ... + 5 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, ChinaMobile, Digital Ocean, Dreamhost, IBM COS, Lyve Cloud, Minio, RackCorp, SeaweedFS, and Tencent COS + \[rs] (s3) + ... +Storage> s3 +Option provider. +Choose your S3 provider. +Choose a number from below, or type in your own value. +Press Enter to leave empty. + ... + 4 / China Mobile Ecloud Elastic Object Storage (EOS) + \[rs] (ChinaMobile) + ... +provider> ChinaMobile +Option env_auth. +Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). +Only applies if access_key_id and secret_access_key is blank. +Choose a number from below, or type in your own boolean value (true or false). +Press Enter for the default (false). + 1 / Enter AWS credentials in the next step. + \[rs] (false) + 2 / Get AWS credentials from the environment (env vars or IAM). + \[rs] (true) +env_auth> +Option access_key_id. +AWS Access Key ID. +Leave blank for anonymous access or runtime credentials. +Enter a value. Press Enter to leave empty. +access_key_id> accesskeyid +Option secret_access_key. +AWS Secret Access Key (password). +Leave blank for anonymous access or runtime credentials. +Enter a value. Press Enter to leave empty. +secret_access_key> secretaccesskey +Option endpoint. +Endpoint for China Mobile Ecloud Elastic Object Storage (EOS) API. +Choose a number from below, or type in your own value. +Press Enter to leave empty. + / The default endpoint - a good choice if you are unsure. + 1 | East China (Suzhou) + \[rs] (eos-wuxi-1.cmecloud.cn) + 2 / East China (Jinan) + \[rs] (eos-jinan-1.cmecloud.cn) + 3 / East China (Hangzhou) + \[rs] (eos-ningbo-1.cmecloud.cn) + 4 / East China (Shanghai-1) + \[rs] (eos-shanghai-1.cmecloud.cn) + 5 / Central China (Zhengzhou) + \[rs] (eos-zhengzhou-1.cmecloud.cn) + 6 / Central China (Changsha-1) + \[rs] (eos-hunan-1.cmecloud.cn) + 7 / Central China (Changsha-2) + \[rs] (eos-zhuzhou-1.cmecloud.cn) + 8 / South China (Guangzhou-2) + \[rs] (eos-guangzhou-1.cmecloud.cn) + 9 / South China (Guangzhou-3) + \[rs] (eos-dongguan-1.cmecloud.cn) +10 / North China (Beijing-1) + \[rs] (eos-beijing-1.cmecloud.cn) +11 / North China (Beijing-2) + \[rs] (eos-beijing-2.cmecloud.cn) +12 / North China (Beijing-3) + \[rs] (eos-beijing-4.cmecloud.cn) +13 / North China (Huhehaote) + \[rs] (eos-huhehaote-1.cmecloud.cn) +14 / Southwest China (Chengdu) + \[rs] (eos-chengdu-1.cmecloud.cn) +15 / Southwest China (Chongqing) + \[rs] (eos-chongqing-1.cmecloud.cn) +16 / Southwest China (Guiyang) + \[rs] (eos-guiyang-1.cmecloud.cn) +17 / Nouthwest China (Xian) + \[rs] (eos-xian-1.cmecloud.cn) +18 / Yunnan China (Kunming) + \[rs] (eos-yunnan.cmecloud.cn) +19 / Yunnan China (Kunming-2) + \[rs] (eos-yunnan-2.cmecloud.cn) +20 / Tianjin China (Tianjin) + \[rs] (eos-tianjin-1.cmecloud.cn) +21 / Jilin China (Changchun) + \[rs] (eos-jilin-1.cmecloud.cn) +22 / Hubei China (Xiangyan) + \[rs] (eos-hubei-1.cmecloud.cn) +23 / Jiangxi China (Nanchang) + \[rs] (eos-jiangxi-1.cmecloud.cn) +24 / Gansu China (Lanzhou) + \[rs] (eos-gansu-1.cmecloud.cn) +25 / Shanxi China (Taiyuan) + \[rs] (eos-shanxi-1.cmecloud.cn) +26 / Liaoning China (Shenyang) + \[rs] (eos-liaoning-1.cmecloud.cn) +27 / Hebei China (Shijiazhuang) + \[rs] (eos-hebei-1.cmecloud.cn) +28 / Fujian China (Xiamen) + \[rs] (eos-fujian-1.cmecloud.cn) +29 / Guangxi China (Nanning) + \[rs] (eos-guangxi-1.cmecloud.cn) +30 / Anhui China (Huainan) + \[rs] (eos-anhui-1.cmecloud.cn) +endpoint> 1 +Option location_constraint. +Location constraint - must match endpoint. +Used when creating buckets only. +Choose a number from below, or type in your own value. +Press Enter to leave empty. + 1 / East China (Suzhou) + \[rs] (wuxi1) + 2 / East China (Jinan) + \[rs] (jinan1) + 3 / East China (Hangzhou) + \[rs] (ningbo1) + 4 / East China (Shanghai-1) + \[rs] (shanghai1) + 5 / Central China (Zhengzhou) + \[rs] (zhengzhou1) + 6 / Central China (Changsha-1) + \[rs] (hunan1) + 7 / Central China (Changsha-2) + \[rs] (zhuzhou1) + 8 / South China (Guangzhou-2) + \[rs] (guangzhou1) + 9 / South China (Guangzhou-3) + \[rs] (dongguan1) +10 / North China (Beijing-1) + \[rs] (beijing1) +11 / North China (Beijing-2) + \[rs] (beijing2) +12 / North China (Beijing-3) + \[rs] (beijing4) +13 / North China (Huhehaote) + \[rs] (huhehaote1) +14 / Southwest China (Chengdu) + \[rs] (chengdu1) +15 / Southwest China (Chongqing) + \[rs] (chongqing1) +16 / Southwest China (Guiyang) + \[rs] (guiyang1) +17 / Nouthwest China (Xian) + \[rs] (xian1) +18 / Yunnan China (Kunming) + \[rs] (yunnan) +19 / Yunnan China (Kunming-2) + \[rs] (yunnan2) +20 / Tianjin China (Tianjin) + \[rs] (tianjin1) +21 / Jilin China (Changchun) + \[rs] (jilin1) +22 / Hubei China (Xiangyan) + \[rs] (hubei1) +23 / Jiangxi China (Nanchang) + \[rs] (jiangxi1) +24 / Gansu China (Lanzhou) + \[rs] (gansu1) +25 / Shanxi China (Taiyuan) + \[rs] (shanxi1) +26 / Liaoning China (Shenyang) + \[rs] (liaoning1) +27 / Hebei China (Shijiazhuang) + \[rs] (hebei1) +28 / Fujian China (Xiamen) + \[rs] (fujian1) +29 / Guangxi China (Nanning) + \[rs] (guangxi1) +30 / Anhui China (Huainan) + \[rs] (anhui1) +location_constraint> 1 +Option acl. +Canned ACL used when creating buckets and storing or copying objects. +This ACL is used for creating objects and if bucket_acl isn\[aq]t set, for creating buckets too. +For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl +Note that this ACL is applied when server-side copying objects as S3 +doesn\[aq]t copy the ACL from the source but rather writes a fresh one. +Choose a number from below, or type in your own value. +Press Enter to leave empty. + / Owner gets FULL_CONTROL. + 1 | No one else has access rights (default). + \[rs] (private) + / Owner gets FULL_CONTROL. + 2 | The AllUsers group gets READ access. + \[rs] (public-read) + / Owner gets FULL_CONTROL. + 3 | The AllUsers group gets READ and WRITE access. + | Granting this on a bucket is generally not recommended. + \[rs] (public-read-write) + / Owner gets FULL_CONTROL. + 4 | The AuthenticatedUsers group gets READ access. + \[rs] (authenticated-read) + / Object owner gets FULL_CONTROL. +acl> private +Option server_side_encryption. +The server-side encryption algorithm used when storing this object in S3. +Choose a number from below, or type in your own value. +Press Enter to leave empty. + 1 / None + \[rs] () + 2 / AES256 + \[rs] (AES256) +server_side_encryption> +Option storage_class. +The storage class to use when storing new objects in ChinaMobile. +Choose a number from below, or type in your own value. +Press Enter to leave empty. + 1 / Default + \[rs] () + 2 / Standard storage class + \[rs] (STANDARD) + 3 / Archive storage mode + \[rs] (GLACIER) + 4 / Infrequent access storage mode + \[rs] (STANDARD_IA) +storage_class> +Edit advanced config? +y) Yes +n) No (default) +y/n> n +-------------------- +[ChinaMobile] +type = s3 +provider = ChinaMobile +access_key_id = accesskeyid +secret_access_key = secretaccesskey +endpoint = eos-wuxi-1.cmecloud.cn +location_constraint = wuxi1 +acl = private +-------------------- +y) Yes this is OK (default) +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi .SS Tencent COS .PP Tencent Cloud Object Storage @@ -27004,7 +27731,7 @@ Choose a number from below, or type in your own value \[rs] \[dq]alias\[dq] 3 / Amazon Drive \[rs] \[dq]amazon cloud drive\[dq] - 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS + 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, ChinaMobile, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS \[rs] \[dq]s3\[dq] [snip] Storage> s3 @@ -39360,7 +40087,7 @@ to 1 nS. .PP The memory backend replaces the default restricted characters set (https://rclone.org/overview/#restricted-characters). -.SS Akamai NetStorage +.SH Akamai NetStorage .PP Paths are specified as \f[C]remote:\f[R] You may put subdirectories in too, e.g. @@ -39377,6 +40104,7 @@ For example, this is commonly configured with or without a CP code: * See all buckets rclone lsd remote: The initial setup for Netstorage involves getting an account and secret. Use \f[C]rclone config\f[R] to walk you through the setup process. +.SS Configuration .PP Here\[aq]s an example of how to make a remote called \f[C]ns1\f[R]. .IP "1." 3 @@ -39535,6 +40263,7 @@ You can\[aq]t perform operations between different remotes. rclone move ns1:/974012/testing/notes.txt ns1:/974450/testing2/ \f[R] .fi +.SS Features .SS Symlink Support .PP The Netstorage backend changes the rclone \f[C]--links, -l\f[R] @@ -39591,7 +40320,7 @@ such as SFTP and the Content Management Shell (CMShell). Rclone will not guarantee correctness of operations with implicit directories which might have been created as a result of using an upload API directly. -.SS ListR Feature +.SS \f[C]--fast-list\f[R] / ListR support .PP NetStorage remote supports the ListR feature by using the \[dq]list\[dq] NetStorage API action to return a lexicographical list of all objects @@ -39621,7 +40350,7 @@ display number of files in the directory and directory size as -1 when ListR method is used. The workaround is to pass \[dq]--disable listR\[dq] flag if these numbers are important in the output. -.SS Purge Feature +.SS Purge .PP NetStorage remote supports the purge feature by using the \[dq]quick-delete\[dq] NetStorage API action. @@ -41370,7 +42099,7 @@ known (https://github.com/OneDrive/onedrive-api-docs/issues/1068) issue that Sharepoint (not OneDrive or OneDrive for Business) may return \[dq]item not found\[dq] errors when users try to replace or delete uploaded files; this seems to mainly affect Office files (.docx, .xlsx, -etc.). +etc.) and web files (.html, .aspx, etc.). As a workaround, you may use the \f[C]--backup-dir \f[R] command line argument so rclone moves the files to be replaced/deleted into a given backup directory (instead of directly replacing/deleting @@ -43803,6 +44532,16 @@ Env Var: RCLONE_PUTIO_ENCODING Type: MultiEncoder .IP \[bu] 2 Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot +.SS Limitations +.PP +put.io has rate limiting. +When you hit a limit, rclone automatically retries after waiting the +amount of time requested by the server. +.PP +If you want to avoid ever hitting these limits, you may use the +\f[C]--tpslimit\f[R] flag with a low number. +Note that the imposed limits may be different for different operations, +and may change over time. .SH Seafile .PP This is a backend for the Seafile (https://www.seafile.com/) storage @@ -44299,8 +45038,6 @@ Protocol (https://en.wikipedia.org/wiki/SSH_File_Transfer_Protocol). .PP The SFTP backend can be used with a number of different providers: .IP \[bu] 2 -C14 -.IP \[bu] 2 rsync.net .PP SFTP runs over SSH v2 and is installed as standard with most modern SSH @@ -45144,12 +45881,6 @@ work with it: \f[C]--dump-headers\f[R], \f[C]--dump-bodies\f[R], .PP Note that \f[C]--timeout\f[R] and \f[C]--contimeout\f[R] are both supported. -.SS C14 -.PP -C14 is supported through the SFTP backend. -.PP -See C14\[aq]s -documentation (https://www.online.net/en/storage/c14-cold-storage) .SS rsync.net .PP rsync.net is supported through the SFTP backend. @@ -48759,6 +49490,118 @@ Options: .IP \[bu] 2 \[dq]error\[dq]: return an error based on option value .SH Changelog +.SS v1.58.1 - 2022-04-29 +.PP +See commits (https://github.com/rclone/rclone/compare/v1.58.0...v1.58.1) +.IP \[bu] 2 +Bug Fixes +.RS 2 +.IP \[bu] 2 +build: Update github.com/billziss-gh to github.com/winfsp (Nick +Craig-Wood) +.IP \[bu] 2 +filter: Fix timezone of \f[C]--min-age\f[R]/\f[C]-max-age\f[R] from UTC +to local as documented (Nick Craig-Wood) +.IP \[bu] 2 +rc/js: Correct RC method names (S\[u01A1]n Tr\[u1EA7]n-Nguy\[u1EC5]n) +.IP \[bu] 2 +docs +.RS 2 +.IP \[bu] 2 +Fix some links to command pages (albertony) +.IP \[bu] 2 +Add \f[C]--multi-thread-streams\f[R] note to \f[C]--transfers\f[R]. +(Zsolt Ero) +.RE +.RE +.IP \[bu] 2 +Mount +.RS 2 +.IP \[bu] 2 +Fix \f[C]--devname\f[R] and fusermount: unknown option \[aq]fsname\[aq] +when mounting via rc (Nick Craig-Wood) +.RE +.IP \[bu] 2 +VFS +.RS 2 +.IP \[bu] 2 +Remove wording which suggests VFS is only for mounting (Nick Craig-Wood) +.RE +.IP \[bu] 2 +Dropbox +.RS 2 +.IP \[bu] 2 +Fix retries of multipart uploads with incorrect_offset error (Nick +Craig-Wood) +.RE +.IP \[bu] 2 +Google Cloud Storage +.RS 2 +.IP \[bu] 2 +Use the s3 pacer to speed up transactions (Nick Craig-Wood) +.IP \[bu] 2 +pacer: Default the Google pacer to a burst of 100 to fix gcs pacing +(Nick Craig-Wood) +.RE +.IP \[bu] 2 +Jottacloud +.RS 2 +.IP \[bu] 2 +Fix scope in token request (albertony) +.RE +.IP \[bu] 2 +Netstorage +.RS 2 +.IP \[bu] 2 +Fix unescaped HTML in documentation (Nick Craig-Wood) +.IP \[bu] 2 +Make levels of headings consistent (Nick Craig-Wood) +.IP \[bu] 2 +Add support contacts to netstorage doc (Nil Alexandrov) +.RE +.IP \[bu] 2 +Onedrive +.RS 2 +.IP \[bu] 2 +Note that sharepoint also changes web files (.html, .aspx) (GH) +.RE +.IP \[bu] 2 +Putio +.RS 2 +.IP \[bu] 2 +Handle rate limit errors (Berkan Teber) +.IP \[bu] 2 +Fix multithread download and other ranged requests (rafma0) +.RE +.IP \[bu] 2 +S3 +.RS 2 +.IP \[bu] 2 +Add ChinaMobile EOS to provider list (GuoXingbin) +.IP \[bu] 2 +Sync providers in config description with providers (Nick Craig-Wood) +.RE +.IP \[bu] 2 +SFTP +.RS 2 +.IP \[bu] 2 +Fix OpenSSH 8.8+ RSA keys incompatibility (KARBOWSKI Piotr) +.IP \[bu] 2 +Note that Scaleway C14 is deprecating SFTP in favor of S3 (Adrien +Rey-Jarthon) +.RE +.IP \[bu] 2 +Storj +.RS 2 +.IP \[bu] 2 +Fix bucket creation on Move (Nick Craig-Wood) +.RE +.IP \[bu] 2 +WebDAV +.RS 2 +.IP \[bu] 2 +Don\[aq]t override Referer if user sets it (Nick Craig-Wood) +.RE .SS v1.58.0 - 2022-03-18 .PP See commits (https://github.com/rclone/rclone/compare/v1.57.0...v1.58.0)