jgaunt/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2025-12-06 00:03:32 +00:00
Code Issues Projects Releases Wiki Activity

Version v1.69.2

Browse Source
This commit is contained in:
Nick Craig-Wood
2025-05-01 15:33:17 +01:00
parent 3d3ea9ee30
commit 13875b4500
21 changed files with 544 additions and 178 deletions
Download Patch File Download Diff File Expand all files Collapse all files

113
MANUAL.html generated
View File

@@ -5,6 +5,7 @@
<meta name="generator" content="pandoc" /> <meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<meta name="author" content="Nick Craig-Wood" /> <meta name="author" content="Nick Craig-Wood" />
<meta name="dcterms.date" content="2025-05-01" />
<title>rclone(1) User Manual</title> <title>rclone(1) User Manual</title>
<style> <style>
code{white-space: pre-wrap;} code{white-space: pre-wrap;}
@@ -81,7 +82,7 @@
<header id="title-block-header"> <header id="title-block-header">
<h1 class="title">rclone(1) User Manual</h1> <h1 class="title">rclone(1) User Manual</h1>
<p class="author">Nick Craig-Wood</p> <p class="author">Nick Craig-Wood</p>
<p class="date">Feb 14, 2025</p> <p class="date">May 01, 2025</p>
</header> </header>
<h1 id="name">NAME</h1> <h1 id="name">NAME</h1>
<p>rclone - manage files on cloud storage</p> <p>rclone - manage files on cloud storage</p>
@@ -1694,9 +1695,10 @@ Other: 8849156022</code></pre>
<p>Remote authorization.</p> <p>Remote authorization.</p>
<h2 id="synopsis-19">Synopsis</h2> <h2 id="synopsis-19">Synopsis</h2>
<p>Remote authorization. Used to authorize a remote or headless rclone from a machine with a browser - use as instructed by rclone config.</p> <p>Remote authorization. Used to authorize a remote or headless rclone from a machine with a browser - use as instructed by rclone config.</p>
<p>The command requires 1-3 arguments: - fs name (e.g., "drive", "s3", etc.) - Either a base64 encoded JSON blob obtained from a previous rclone config session - Or a client_id and client_secret pair obtained from the remote service</p>
<p>Use --auth-no-open-browser to prevent rclone to open auth link in default browser automatically.</p> <p>Use --auth-no-open-browser to prevent rclone to open auth link in default browser automatically.</p>
<p>Use --template to generate HTML output via a custom Go template. If a blank string is provided as an argument to this flag, the default template is used.</p> <p>Use --template to generate HTML output via a custom Go template. If a blank string is provided as an argument to this flag, the default template is used.</p>
<pre><code>rclone authorize [flags]</code></pre> <pre><code>rclone authorize &lt;fs name&gt; [base64_json_blob | client_id client_secret] [flags]</code></pre>
<h2 id="options-19">Options</h2> <h2 id="options-19">Options</h2>
<pre><code> --auth-no-open-browser Do not automatically open auth link in default browser <pre><code> --auth-no-open-browser Do not automatically open auth link in default browser
-h, --help help for authorize -h, --help help for authorize
@@ -2421,6 +2423,7 @@ if src is directory
copy it to dst, overwriting existing files if they exist copy it to dst, overwriting existing files if they exist
see copy command for full details</code></pre> see copy command for full details</code></pre>
<p>This doesn't transfer files that are identical on src and dst, testing by size and modification time or MD5SUM. It doesn't delete files from the destination.</p> <p>This doesn't transfer files that are identical on src and dst, testing by size and modification time or MD5SUM. It doesn't delete files from the destination.</p>
<p><em>If you are looking to copy just a byte range of a file, please see 'rclone cat --offset X --count Y'</em></p>
<p><strong>Note</strong>: Use the <code>-P</code>/<code>--progress</code> flag to view real-time transfer statistics</p> <p><strong>Note</strong>: Use the <code>-P</code>/<code>--progress</code> flag to view real-time transfer statistics</p>
<pre><code>rclone copyto source:path dest:path [flags]</code></pre> <pre><code>rclone copyto source:path dest:path [flags]</code></pre>
<h2 id="options-48">Options</h2> <h2 id="options-48">Options</h2>
@@ -2503,7 +2506,7 @@ if src is directory
<h2 id="synopsis-42">Synopsis</h2> <h2 id="synopsis-42">Synopsis</h2>
<p>Download a URL's content and copy it to the destination without saving it in temporary storage.</p> <p>Download a URL's content and copy it to the destination without saving it in temporary storage.</p>
<p>Setting <code>--auto-filename</code> will attempt to automatically determine the filename from the URL (after any redirections) and used in the destination path.</p> <p>Setting <code>--auto-filename</code> will attempt to automatically determine the filename from the URL (after any redirections) and used in the destination path.</p>
<p>With <code>--auto-filename-header</code> in addition, if a specific filename is set in HTTP headers, it will be used instead of the name from the URL. With <code>--print-filename</code> in addition, the resulting file name will be printed.</p> <p>With <code>--header-filename</code> in addition, if a specific filename is set in HTTP headers, it will be used instead of the name from the URL. With <code>--print-filename</code> in addition, the resulting file name will be printed.</p>
<p>Setting <code>--no-clobber</code> will prevent overwriting file on the destination if there is one with the same name.</p> <p>Setting <code>--no-clobber</code> will prevent overwriting file on the destination if there is one with the same name.</p>
<p>Setting <code>--stdout</code> or making the output file name <code>-</code> will cause the output to be written to standard output.</p> <p>Setting <code>--stdout</code> or making the output file name <code>-</code> will cause the output to be written to standard output.</p>
<h2 id="troubleshooting">Troubleshooting</h2> <h2 id="troubleshooting">Troubleshooting</h2>
@@ -3198,7 +3201,7 @@ WantedBy=multi-user.target</code></pre>
<p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p> <p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p> <p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p> <p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p>
<p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p> <p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-space</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-space</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p>
<p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p> <p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p>
<p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode &gt; off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p> <p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode &gt; off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p>
<h3 id="vfs-cache-mode-off">--vfs-cache-mode off</h3> <h3 id="vfs-cache-mode-off">--vfs-cache-mode off</h3>
@@ -3737,7 +3740,7 @@ WantedBy=multi-user.target</code></pre>
<p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p> <p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p> <p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p> <p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p>
<p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p> <p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-space</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-space</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p>
<p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p> <p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p>
<p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode &gt; off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p> <p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode &gt; off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p>
<h3 id="vfs-cache-mode-off-1">--vfs-cache-mode off</h3> <h3 id="vfs-cache-mode-off-1">--vfs-cache-mode off</h3>
@@ -4321,7 +4324,7 @@ htpasswd -B htpasswd anotherUser</code></pre>
<p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p> <p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p> <p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p> <p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p>
<p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p> <p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-space</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-space</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p>
<p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p> <p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p>
<p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode &gt; off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p> <p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode &gt; off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p>
<h3 id="vfs-cache-mode-off-2">--vfs-cache-mode off</h3> <h3 id="vfs-cache-mode-off-2">--vfs-cache-mode off</h3>
@@ -4544,7 +4547,7 @@ htpasswd -B htpasswd anotherUser</code></pre>
<p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p> <p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p> <p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p> <p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p>
<p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p> <p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-space</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-space</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p>
<p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p> <p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p>
<p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode &gt; off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p> <p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode &gt; off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p>
<h3 id="vfs-cache-mode-off-3">--vfs-cache-mode off</h3> <h3 id="vfs-cache-mode-off-3">--vfs-cache-mode off</h3>
@@ -4788,7 +4791,7 @@ htpasswd -B htpasswd anotherUser</code></pre>
<p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p> <p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p> <p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p> <p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p>
<p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p> <p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-space</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-space</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p>
<p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p> <p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p>
<p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode &gt; off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p> <p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode &gt; off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p>
<h3 id="vfs-cache-mode-off-4">--vfs-cache-mode off</h3> <h3 id="vfs-cache-mode-off-4">--vfs-cache-mode off</h3>
@@ -5181,7 +5184,7 @@ htpasswd -B htpasswd anotherUser</code></pre>
<p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p> <p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p> <p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p> <p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p>
<p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p> <p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-space</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-space</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p>
<p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p> <p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p>
<p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode &gt; off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p> <p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode &gt; off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p>
<h3 id="vfs-cache-mode-off-5">--vfs-cache-mode off</h3> <h3 id="vfs-cache-mode-off-5">--vfs-cache-mode off</h3>
@@ -5455,7 +5458,7 @@ htpasswd -B htpasswd anotherUser</code></pre>
<p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p> <p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p> <p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p> <p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p>
<p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p> <p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-space</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-space</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p>
<p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p> <p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p>
<p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode &gt; off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p> <p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode &gt; off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p>
<h3 id="vfs-cache-mode-off-6">--vfs-cache-mode off</h3> <h3 id="vfs-cache-mode-off-6">--vfs-cache-mode off</h3>
@@ -5739,7 +5742,7 @@ htpasswd -B htpasswd anotherUser</code></pre>
<p><code>serve s3</code> is considered <strong>Experimental</strong> so use with care.</p> <p><code>serve s3</code> is considered <strong>Experimental</strong> so use with care.</p>
<p>S3 server supports Signature Version 4 authentication. Just use <code>--auth-key accessKey,secretKey</code> and set the <code>Authorization</code> header correctly in the request. (See the <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">AWS docs</a>).</p> <p>S3 server supports Signature Version 4 authentication. Just use <code>--auth-key accessKey,secretKey</code> and set the <code>Authorization</code> header correctly in the request. (See the <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">AWS docs</a>).</p>
<p><code>--auth-key</code> can be repeated for multiple auth pairs. If <code>--auth-key</code> is not provided then <code>serve s3</code> will allow anonymous access.</p> <p><code>--auth-key</code> can be repeated for multiple auth pairs. If <code>--auth-key</code> is not provided then <code>serve s3</code> will allow anonymous access.</p>
<p>Please note that some clients may require HTTPS endpoints. See <a href="#ssl-tls">the SSL docs</a> for more information.</p> <p>Please note that some clients may require HTTPS endpoints. See <a href="#tls-ssl">the SSL docs</a> for more information.</p>
<p>This command uses the <a href="#vfs-virtual-file-system">VFS directory cache</a>. All the functionality will work with <code>--vfs-cache-mode off</code>. Using <code>--vfs-cache-mode full</code> (or <code>writes</code>) can be used to cache objects locally to improve performance.</p> <p>This command uses the <a href="#vfs-virtual-file-system">VFS directory cache</a>. All the functionality will work with <code>--vfs-cache-mode off</code>. Using <code>--vfs-cache-mode full</code> (or <code>writes</code>) can be used to cache objects locally to improve performance.</p>
<p>Use <code>--force-path-style=false</code> if you want to use the bucket name as a part of the hostname (such as mybucket.local)</p> <p>Use <code>--force-path-style=false</code> if you want to use the bucket name as a part of the hostname (such as mybucket.local)</p>
<p>Use <code>--etag-hash</code> if you want to change the hash uses for the <code>ETag</code>. Note that using anything other than <code>MD5</code> (the default) is likely to cause problems for S3 clients which rely on the Etag being the MD5.</p> <p>Use <code>--etag-hash</code> if you want to change the hash uses for the <code>ETag</code>. Note that using anything other than <code>MD5</code> (the default) is likely to cause problems for S3 clients which rely on the Etag being the MD5.</p>
@@ -5859,7 +5862,7 @@ htpasswd -B htpasswd anotherUser</code></pre>
<p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p> <p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p> <p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p> <p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p>
<p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p> <p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-space</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-space</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p>
<p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p> <p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p>
<p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode &gt; off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p> <p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode &gt; off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p>
<h3 id="vfs-cache-mode-off-7">--vfs-cache-mode off</h3> <h3 id="vfs-cache-mode-off-7">--vfs-cache-mode off</h3>
@@ -6108,7 +6111,7 @@ htpasswd -B htpasswd anotherUser</code></pre>
<p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p> <p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p> <p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p> <p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p>
<p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p> <p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-space</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-space</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p>
<p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p> <p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p>
<p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode &gt; off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p> <p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode &gt; off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p>
<h3 id="vfs-cache-mode-off-8">--vfs-cache-mode off</h3> <h3 id="vfs-cache-mode-off-8">--vfs-cache-mode off</h3>
@@ -6513,7 +6516,7 @@ htpasswd -B htpasswd anotherUser</code></pre>
<p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p> <p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p> <p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p> <p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p>
<p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p> <p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-space</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-space</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p>
<p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p> <p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p>
<p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode &gt; off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p> <p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode &gt; off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p>
<h3 id="vfs-cache-mode-off-9">--vfs-cache-mode off</h3> <h3 id="vfs-cache-mode-off-9">--vfs-cache-mode off</h3>
@@ -12289,7 +12292,7 @@ Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
--tpslimit float Limit HTTP transactions per second to this --tpslimit float Limit HTTP transactions per second to this
--tpslimit-burst int Max burst of transactions for --tpslimit (default 1) --tpslimit-burst int Max burst of transactions for --tpslimit (default 1)
--use-cookies Enable session cookiejar --use-cookies Enable session cookiejar
--user-agent string Set the user-agent to a specified string (default &quot;rclone/v1.69.1&quot;)</code></pre> --user-agent string Set the user-agent to a specified string (default &quot;rclone/v1.69.2&quot;)</code></pre>
<h2 id="performance">Performance</h2> <h2 id="performance">Performance</h2>
<p>Flags helpful for increasing performance.</p> <p>Flags helpful for increasing performance.</p>
<pre><code> --buffer-size SizeSuffix In memory buffer size when reading files for each --transfer (default 16Mi) <pre><code> --buffer-size SizeSuffix In memory buffer size when reading files for each --transfer (default 16Mi)
@@ -13238,7 +13241,7 @@ Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
<p>In the first example we will use the <a href="https://rclone.org/sftp/">SFTP</a> rclone volume with Docker engine on a standalone Ubuntu machine.</p> <p>In the first example we will use the <a href="https://rclone.org/sftp/">SFTP</a> rclone volume with Docker engine on a standalone Ubuntu machine.</p>
<p>Start from <a href="https://docs.docker.com/engine/install/">installing Docker</a> on the host.</p> <p>Start from <a href="https://docs.docker.com/engine/install/">installing Docker</a> on the host.</p>
<p>The <em>FUSE</em> driver is a prerequisite for rclone mounting and should be installed on host:</p> <p>The <em>FUSE</em> driver is a prerequisite for rclone mounting and should be installed on host:</p>
<pre><code>sudo apt-get -y install fuse</code></pre> <pre><code>sudo apt-get -y install fuse3</code></pre>
<p>Create two directories required by rclone docker plugin:</p> <p>Create two directories required by rclone docker plugin:</p>
<pre><code>sudo mkdir -p /var/lib/docker-plugins/rclone/config <pre><code>sudo mkdir -p /var/lib/docker-plugins/rclone/config
sudo mkdir -p /var/lib/docker-plugins/rclone/cache</code></pre> sudo mkdir -p /var/lib/docker-plugins/rclone/cache</code></pre>
@@ -15152,7 +15155,7 @@ $ rclone -q --s3-versions ls s3:cleanup-test
<h3 id="glacier-and-glacier-deep-archive">Glacier and Glacier Deep Archive</h3> <h3 id="glacier-and-glacier-deep-archive">Glacier and Glacier Deep Archive</h3>
<p>You can upload objects using the glacier storage class or transition them to glacier using a <a href="http://docs.aws.amazon.com/AmazonS3/latest/user-guide/create-lifecycle.html">lifecycle policy</a>. The bucket can still be synced or copied into normally, but if rclone tries to access data from the glacier storage class you will see an error like below.</p> <p>You can upload objects using the glacier storage class or transition them to glacier using a <a href="http://docs.aws.amazon.com/AmazonS3/latest/user-guide/create-lifecycle.html">lifecycle policy</a>. The bucket can still be synced or copied into normally, but if rclone tries to access data from the glacier storage class you will see an error like below.</p>
<pre><code>2017/09/11 19:07:43 Failed to sync: failed to open source object: Object in GLACIER, restore first: path/to/file</code></pre> <pre><code>2017/09/11 19:07:43 Failed to sync: failed to open source object: Object in GLACIER, restore first: path/to/file</code></pre>
<p>In this case you need to <a href="http://docs.aws.amazon.com/AmazonS3/latest/user-guide/restore-archived-objects.html">restore</a> the object(s) in question before using rclone.</p> <p>In this case you need to <a href="http://docs.aws.amazon.com/AmazonS3/latest/user-guide/restore-archived-objects.html">restore</a> the object(s) in question before accessing object contents. The <a href="#restore">restore</a> section below shows how to do this with rclone.</p>
<p>Note that rclone only speaks the S3 API it does not speak the Glacier Vault API, so rclone cannot directly access Glacier Vaults.</p> <p>Note that rclone only speaks the S3 API it does not speak the Glacier Vault API, so rclone cannot directly access Glacier Vaults.</p>
<h3 id="object-lock-enabled-s3-bucket">Object-lock enabled S3 bucket</h3> <h3 id="object-lock-enabled-s3-bucket">Object-lock enabled S3 bucket</h3>
<p>According to AWS's <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-overview.html#object-lock-permission">documentation on S3 Object Lock</a>:</p> <p>According to AWS's <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-overview.html#object-lock-permission">documentation on S3 Object Lock</a>:</p>
@@ -16512,7 +16515,7 @@ Windows: &quot;%USERPROFILE%\.aws\credentials&quot;</code></pre>
<pre><code>rclone backend restore remote: [options] [&lt;arguments&gt;+]</code></pre> <pre><code>rclone backend restore remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This command can be used to restore one or more objects from GLACIER to normal storage or from INTELLIGENT-TIERING Archive Access / Deep Archive Access tier to the Frequent Access tier.</p> <p>This command can be used to restore one or more objects from GLACIER to normal storage or from INTELLIGENT-TIERING Archive Access / Deep Archive Access tier to the Frequent Access tier.</p>
<p>Usage Examples:</p> <p>Usage Examples:</p>
<pre><code>rclone backend restore s3:bucket/path/to/object -o priority=PRIORITY -o lifetime=DAYS <pre><code>rclone backend restore s3:bucket/path/to/ --include /object -o priority=PRIORITY -o lifetime=DAYS
rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY -o lifetime=DAYS rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY -o lifetime=DAYS
rclone backend restore s3:bucket -o priority=PRIORITY -o lifetime=DAYS rclone backend restore s3:bucket -o priority=PRIORITY -o lifetime=DAYS
rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY</code></pre> rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY</code></pre>
@@ -19889,7 +19892,7 @@ e) Edit this remote
d) Delete this remote d) Delete this remote
y/e/d&gt; y</code></pre> y/e/d&gt; y</code></pre>
<p>See the <a href="https://rclone.org/remote_setup/">remote setup docs</a> for how to set it up on a machine with no Internet browser available.</p> <p>See the <a href="https://rclone.org/remote_setup/">remote setup docs</a> for how to set it up on a machine with no Internet browser available.</p>
<p>Note that rclone runs a webserver on your local machine to collect the token as returned from Box. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on <code>http://127.0.0.1:53682/</code> and this it may require you to unblock it temporarily if you are running a host firewall.</p> <p>Note that rclone runs a webserver on your local machine to collect the token as returned from Box. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on <code>http://127.0.0.1:53682/</code> and this may require you to unblock it temporarily if you are running a host firewall.</p>
<p>Once configured you can then use <code>rclone</code> like this,</p> <p>Once configured you can then use <code>rclone</code> like this,</p>
<p>List directories in top level of your Box</p> <p>List directories in top level of your Box</p>
<pre><code>rclone lsd remote:</code></pre> <pre><code>rclone lsd remote:</code></pre>
@@ -35553,7 +35556,7 @@ server_command = sudo /usr/libexec/openssh/sftp-server</code></pre>
<li>Required: false</li> <li>Required: false</li>
</ul> </ul>
<h2 id="limitations-36">Limitations</h2> <h2 id="limitations-36">Limitations</h2>
<p>On 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 <code>disable_hashcheck</code> is a good idea.</p> <p>On some SFTP servers (e.g. Synology) the paths are different for SSH and SFTP so the hashes can't be calculated properly. You can either use <a href="#--sftp-path-override"><code>--sftp-path-override</code></a> or <a href="#--sftp-disable-hashcheck"><code>disable_hashcheck</code></a>.</p>
<p>The only ssh agent supported under Windows is Putty's pageant.</p> <p>The only ssh agent supported under Windows is Putty's pageant.</p>
<p>The Go SSH library disables the use of the aes128-cbc cipher by default, due to security concerns. This can be re-enabled on a per-connection basis by setting the <code>use_insecure_cipher</code> setting in the configuration file to <code>true</code>. Further details on the insecurity of this cipher can be found <a href="http://www.isg.rhul.ac.uk/~kp/SandPfinal.pdf">in this paper</a>.</p> <p>The Go SSH library disables the use of the aes128-cbc cipher by default, due to security concerns. This can be re-enabled on a per-connection basis by setting the <code>use_insecure_cipher</code> setting in the configuration file to <code>true</code>. Further details on the insecurity of this cipher can be found <a href="http://www.isg.rhul.ac.uk/~kp/SandPfinal.pdf">in this paper</a>.</p>
<p>SFTP isn't supported under plan9 until <a href="https://github.com/pkg/sftp/issues/156">this issue</a> is fixed.</p> <p>SFTP isn't supported under plan9 until <a href="https://github.com/pkg/sftp/issues/156">this issue</a> is fixed.</p>
@@ -38311,6 +38314,69 @@ $ tree /tmp/c
<li>"error": return an error based on option value</li> <li>"error": return an error based on option value</li>
</ul> </ul>
<h1 id="changelog-1">Changelog</h1> <h1 id="changelog-1">Changelog</h1>
<h2 id="v1.69.2---2025-05-01">v1.69.2 - 2025-05-01</h2>
<p><a href="https://github.com/rclone/rclone/compare/v1.69.1...v1.69.2">See commits</a></p>
<ul>
<li>Bug fixes
<ul>
<li>accounting: Fix percentDiff calculation -- (Anagh Kumar Baranwal)</li>
<li>build
<ul>
<li>Update github.com/golang-jwt/jwt/v4 from 4.5.1 to 4.5.2 to fix CVE-2025-30204 (dependabot[bot])</li>
<li>Update github.com/golang-jwt/jwt/v5 from 5.2.1 to 5.2.2 to fix CVE-2025-30204 (dependabot[bot])</li>
<li>Update golang.org/x/crypto to v0.35.0 to fix CVE-2025-22869 (Nick Craig-Wood)</li>
<li>Update golang.org/x/net from 0.36.0 to 0.38.0 to fix CVE-2025-22870 (dependabot[bot])</li>
<li>Update golang.org/x/net to 0.36.0. to fix CVE-2025-22869 (dependabot[bot])</li>
<li>Stop building with go &lt; go1.23 as security updates forbade it (Nick Craig-Wood)</li>
<li>Fix docker plugin build (Anagh Kumar Baranwal)</li>
</ul></li>
<li>cmd: Fix crash if rclone is invoked without any arguments (Janne Hellsten)</li>
<li>config: Read configuration passwords from stdin even when terminated with EOF (Samantha Bowen)</li>
<li>doc fixes (Andrew Kreimer, Danny Garside, eccoisle, Ed Craig-Wood, emyarod, jack, Jugal Kishore, Markus Gerstel, Michael Kebe, Nick Craig-Wood, simonmcnair, simwai, Zachary Vorhies)</li>
<li>fs: Fix corruption of SizeSuffix with "B" suffix in config (eg --min-size) (Nick Craig-Wood)</li>
<li>lib/http: Fix race between Serve() and Shutdown() (Nick Craig-Wood)</li>
<li>object: Fix memory object out of bounds Seek (Nick Craig-Wood)</li>
<li>operations: Fix call fmt.Errorf with wrong err (alingse)</li>
<li>rc
<ul>
<li>Disable the metrics server when running <code>rclone rc</code> (hiddenmarten)</li>
<li>Fix debug/* commands not being available over unix sockets (Nick Craig-Wood)</li>
</ul></li>
<li>serve nfs: Fix unlikely crash (Nick Craig-Wood)</li>
<li>stats: Fix the speed not getting updated after a pause in the processing (Anagh Kumar Baranwal)</li>
<li>sync
<ul>
<li>Fix cpu spinning when empty directory finding with leading slashes (Nick Craig-Wood)</li>
<li>Copy dir modtimes even when copyEmptySrcDirs is false (ll3006)</li>
</ul></li>
</ul></li>
<li>VFS
<ul>
<li>Fix directory cache serving stale data (Lorenz Brun)</li>
<li>Fix inefficient directory caching when directory reads are slow (huanghaojun)</li>
<li>Fix integration test failures (Nick Craig-Wood)</li>
</ul></li>
<li>Drive
<ul>
<li>Metadata: fix error when setting copy-requires-writer-permission on a folder (Nick Craig-Wood)</li>
</ul></li>
<li>Dropbox
<ul>
<li>Retry link without expiry (Dave Vasilevsky)</li>
</ul></li>
<li>HTTP
<ul>
<li>Correct root if definitely pointing to a file (nielash)</li>
</ul></li>
<li>Iclouddrive
<ul>
<li>Fix so created files are writable (Ben Alex)</li>
</ul></li>
<li>Onedrive
<ul>
<li>Fix metadata ordering in permissions (Nick Craig-Wood)</li>
</ul></li>
</ul>
<h2 id="v1.69.1---2025-02-14">v1.69.1 - 2025-02-14</h2> <h2 id="v1.69.1---2025-02-14">v1.69.1 - 2025-02-14</h2>
<p><a href="https://github.com/rclone/rclone/compare/v1.69.0...v1.69.1">See commits</a></p> <p><a href="https://github.com/rclone/rclone/compare/v1.69.0...v1.69.1">See commits</a></p>
<ul> <ul>
@@ -38390,7 +38456,7 @@ $ tree /tmp/c
<li>http servers: Disable automatic authentication skipping for unix sockets in http servers (Moises Lima) <li>http servers: Disable automatic authentication skipping for unix sockets in http servers (Moises Lima)
<ul> <ul>
<li>This was making it impossible to use unix sockets with an proxy</li> <li>This was making it impossible to use unix sockets with an proxy</li>
<li>This might now cause rclone to need authenticaton where it didn't before</li> <li>This might now cause rclone to need authentication where it didn't before</li>
</ul></li> </ul></li>
<li>oauthutil: add support for OAuth client credential flow (Martin Hassack, Nick Craig-Wood)</li> <li>oauthutil: add support for OAuth client credential flow (Martin Hassack, Nick Craig-Wood)</li>
<li>operations: make log messages consistent for mkdir/rmdir at INFO level (Nick Craig-Wood)</li> <li>operations: make log messages consistent for mkdir/rmdir at INFO level (Nick Craig-Wood)</li>
@@ -39430,7 +39496,7 @@ $ tree /tmp/c
<li>Refactor version info and icon resource handling on windows (albertony)</li> <li>Refactor version info and icon resource handling on windows (albertony)</li>
</ul></li> </ul></li>
<li>doc updates (albertony, alfish2000, asdffdsazqqq, Dimitri Papadopoulos, Herby Gillot, Joda Stößer, Manoj Ghosh, Nick Craig-Wood)</li> <li>doc updates (albertony, alfish2000, asdffdsazqqq, Dimitri Papadopoulos, Herby Gillot, Joda Stößer, Manoj Ghosh, Nick Craig-Wood)</li>
<li>Implement <code>--metadata-mapper</code> to transform metatadata with a user supplied program (Nick Craig-Wood)</li> <li>Implement <code>--metadata-mapper</code> to transform metadata with a user supplied program (Nick Craig-Wood)</li>
<li>Add <code>ChunkWriterDoesntSeek</code> feature flag and set it for b2 (Nick Craig-Wood)</li> <li>Add <code>ChunkWriterDoesntSeek</code> feature flag and set it for b2 (Nick Craig-Wood)</li>
<li>lib/http: Export basic go string functions for use in <code>--template</code> (Gabriel Espinoza)</li> <li>lib/http: Export basic go string functions for use in <code>--template</code> (Gabriel Espinoza)</li>
<li>makefile: Use POSIX compatible install arguments (Mina Galić)</li> <li>makefile: Use POSIX compatible install arguments (Mina Galić)</li>
@@ -39605,7 +39671,7 @@ $ tree /tmp/c
<li>B2 <li>B2
<ul> <ul>
<li>Fix multipart upload: corrupted on transfer: sizes differ XXX vs 0 (Nick Craig-Wood)</li> <li>Fix multipart upload: corrupted on transfer: sizes differ XXX vs 0 (Nick Craig-Wood)</li>
<li>Fix locking window when getting mutipart upload URL (Nick Craig-Wood)</li> <li>Fix locking window when getting multipart upload URL (Nick Craig-Wood)</li>
<li>Fix server side copies greater than 4GB (Nick Craig-Wood)</li> <li>Fix server side copies greater than 4GB (Nick Craig-Wood)</li>
<li>Fix chunked streaming uploads (Nick Craig-Wood)</li> <li>Fix chunked streaming uploads (Nick Craig-Wood)</li>
<li>Reduce default <code>--b2-upload-concurrency</code> to 4 to reduce memory usage (Nick Craig-Wood)</li> <li>Reduce default <code>--b2-upload-concurrency</code> to 4 to reduce memory usage (Nick Craig-Wood)</li>
@@ -47606,7 +47672,6 @@ THE SOFTWARE.</code></pre>
<li>ben-ba <a href="mailto:benjamin.brauner@gmx.de" class="email">benjamin.brauner@gmx.de</a></li> <li>ben-ba <a href="mailto:benjamin.brauner@gmx.de" class="email">benjamin.brauner@gmx.de</a></li>
<li>Eli Orzitzer <a href="mailto:e_orz@yahoo.com" class="email">e_orz@yahoo.com</a></li> <li>Eli Orzitzer <a href="mailto:e_orz@yahoo.com" class="email">e_orz@yahoo.com</a></li>
<li>Anthony Metzidis <a href="mailto:anthony.metzidis@gmail.com" class="email">anthony.metzidis@gmail.com</a></li> <li>Anthony Metzidis <a href="mailto:anthony.metzidis@gmail.com" class="email">anthony.metzidis@gmail.com</a></li>
<li>emyarod <a href="mailto:afw5059@gmail.com" class="email">afw5059@gmail.com</a></li>
<li>keongalvin <a href="mailto:keongalvin@gmail.com" class="email">keongalvin@gmail.com</a></li> <li>keongalvin <a href="mailto:keongalvin@gmail.com" class="email">keongalvin@gmail.com</a></li>
<li>rarspace01 <a href="mailto:rarspace01@users.noreply.github.com" class="email">rarspace01@users.noreply.github.com</a></li> <li>rarspace01 <a href="mailto:rarspace01@users.noreply.github.com" class="email">rarspace01@users.noreply.github.com</a></li>
<li>Paul Stern <a href="mailto:paulstern45@gmail.com" class="email">paulstern45@gmail.com</a></li> <li>Paul Stern <a href="mailto:paulstern45@gmail.com" class="email">paulstern45@gmail.com</a></li>

120
MANUAL.md generated
View File

@@ -1,6 +1,6 @@
% rclone(1) User Manual % rclone(1) User Manual
% Nick Craig-Wood % Nick Craig-Wood
% Feb 14, 2025 % May 01, 2025
# NAME # NAME
@@ -2858,13 +2858,18 @@ Remote authorization. Used to authorize a remote or headless
rclone from a machine with a browser - use as instructed by rclone from a machine with a browser - use as instructed by
rclone config. rclone config.
The command requires 1-3 arguments:
- fs name (e.g., "drive", "s3", etc.)
- Either a base64 encoded JSON blob obtained from a previous rclone config session
- Or a client_id and client_secret pair obtained from the remote service
Use --auth-no-open-browser to prevent rclone to open auth Use --auth-no-open-browser to prevent rclone to open auth
link in default browser automatically. link in default browser automatically.
Use --template to generate HTML output via a custom Go template. If a blank string is provided as an argument to this flag, the default template is used. Use --template to generate HTML output via a custom Go template. If a blank string is provided as an argument to this flag, the default template is used.
``` ```
rclone authorize [flags] rclone authorize <fs name> [base64_json_blob | client_id client_secret] [flags]
``` ```
## Options ## Options
@@ -4232,6 +4237,8 @@ This doesn't transfer files that are identical on src and dst, testing
by size and modification time or MD5SUM. It doesn't delete files from by size and modification time or MD5SUM. It doesn't delete files from
the destination. the destination.
*If you are looking to copy just a byte range of a file, please see 'rclone cat --offset X --count Y'*
**Note**: Use the `-P`/`--progress` flag to view real-time transfer statistics **Note**: Use the `-P`/`--progress` flag to view real-time transfer statistics
@@ -4353,7 +4360,7 @@ Setting `--auto-filename` will attempt to automatically determine the
filename from the URL (after any redirections) and used in the filename from the URL (after any redirections) and used in the
destination path. destination path.
With `--auto-filename-header` in addition, if a specific filename is With `--header-filename` in addition, if a specific filename is
set in HTTP headers, it will be used instead of the name from the URL. set in HTTP headers, it will be used instead of the name from the URL.
With `--print-filename` in addition, the resulting file name will be With `--print-filename` in addition, the resulting file name will be
printed. printed.
@@ -5861,11 +5868,11 @@ seconds. If rclone is quit or dies with files that haven't been
uploaded, these will be uploaded next time rclone is run with the same uploaded, these will be uploaded next time rclone is run with the same
flags. flags.
If using `--vfs-cache-max-size` or `--vfs-cache-min-free-size` note If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note
that the cache may exceed these quotas for two reasons. Firstly that the cache may exceed these quotas for two reasons. Firstly
because it is only checked every `--vfs-cache-poll-interval`. Secondly because it is only checked every `--vfs-cache-poll-interval`. Secondly
because open files cannot be evicted from the cache. When because open files cannot be evicted from the cache. When
`--vfs-cache-max-size` or `--vfs-cache-min-free-size` is exceeded, `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded,
rclone will attempt to evict the least accessed files from the cache rclone will attempt to evict the least accessed files from the cache
first. rclone will start with files that haven't been accessed for the first. rclone will start with files that haven't been accessed for the
longest. This cache flushing strategy is efficient and more relevant longest. This cache flushing strategy is efficient and more relevant
@@ -7123,11 +7130,11 @@ seconds. If rclone is quit or dies with files that haven't been
uploaded, these will be uploaded next time rclone is run with the same uploaded, these will be uploaded next time rclone is run with the same
flags. flags.
If using `--vfs-cache-max-size` or `--vfs-cache-min-free-size` note If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note
that the cache may exceed these quotas for two reasons. Firstly that the cache may exceed these quotas for two reasons. Firstly
because it is only checked every `--vfs-cache-poll-interval`. Secondly because it is only checked every `--vfs-cache-poll-interval`. Secondly
because open files cannot be evicted from the cache. When because open files cannot be evicted from the cache. When
`--vfs-cache-max-size` or `--vfs-cache-min-free-size` is exceeded, `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded,
rclone will attempt to evict the least accessed files from the cache rclone will attempt to evict the least accessed files from the cache
first. rclone will start with files that haven't been accessed for the first. rclone will start with files that haven't been accessed for the
longest. This cache flushing strategy is efficient and more relevant longest. This cache flushing strategy is efficient and more relevant
@@ -8251,11 +8258,11 @@ seconds. If rclone is quit or dies with files that haven't been
uploaded, these will be uploaded next time rclone is run with the same uploaded, these will be uploaded next time rclone is run with the same
flags. flags.
If using `--vfs-cache-max-size` or `--vfs-cache-min-free-size` note If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note
that the cache may exceed these quotas for two reasons. Firstly that the cache may exceed these quotas for two reasons. Firstly
because it is only checked every `--vfs-cache-poll-interval`. Secondly because it is only checked every `--vfs-cache-poll-interval`. Secondly
because open files cannot be evicted from the cache. When because open files cannot be evicted from the cache. When
`--vfs-cache-max-size` or `--vfs-cache-min-free-size` is exceeded, `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded,
rclone will attempt to evict the least accessed files from the cache rclone will attempt to evict the least accessed files from the cache
first. rclone will start with files that haven't been accessed for the first. rclone will start with files that haven't been accessed for the
longest. This cache flushing strategy is efficient and more relevant longest. This cache flushing strategy is efficient and more relevant
@@ -8806,11 +8813,11 @@ seconds. If rclone is quit or dies with files that haven't been
uploaded, these will be uploaded next time rclone is run with the same uploaded, these will be uploaded next time rclone is run with the same
flags. flags.
If using `--vfs-cache-max-size` or `--vfs-cache-min-free-size` note If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note
that the cache may exceed these quotas for two reasons. Firstly that the cache may exceed these quotas for two reasons. Firstly
because it is only checked every `--vfs-cache-poll-interval`. Secondly because it is only checked every `--vfs-cache-poll-interval`. Secondly
because open files cannot be evicted from the cache. When because open files cannot be evicted from the cache. When
`--vfs-cache-max-size` or `--vfs-cache-min-free-size` is exceeded, `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded,
rclone will attempt to evict the least accessed files from the cache rclone will attempt to evict the least accessed files from the cache
first. rclone will start with files that haven't been accessed for the first. rclone will start with files that haven't been accessed for the
longest. This cache flushing strategy is efficient and more relevant longest. This cache flushing strategy is efficient and more relevant
@@ -9363,11 +9370,11 @@ seconds. If rclone is quit or dies with files that haven't been
uploaded, these will be uploaded next time rclone is run with the same uploaded, these will be uploaded next time rclone is run with the same
flags. flags.
If using `--vfs-cache-max-size` or `--vfs-cache-min-free-size` note If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note
that the cache may exceed these quotas for two reasons. Firstly that the cache may exceed these quotas for two reasons. Firstly
because it is only checked every `--vfs-cache-poll-interval`. Secondly because it is only checked every `--vfs-cache-poll-interval`. Secondly
because open files cannot be evicted from the cache. When because open files cannot be evicted from the cache. When
`--vfs-cache-max-size` or `--vfs-cache-min-free-size` is exceeded, `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded,
rclone will attempt to evict the least accessed files from the cache rclone will attempt to evict the least accessed files from the cache
first. rclone will start with files that haven't been accessed for the first. rclone will start with files that haven't been accessed for the
longest. This cache flushing strategy is efficient and more relevant longest. This cache flushing strategy is efficient and more relevant
@@ -10101,11 +10108,11 @@ seconds. If rclone is quit or dies with files that haven't been
uploaded, these will be uploaded next time rclone is run with the same uploaded, these will be uploaded next time rclone is run with the same
flags. flags.
If using `--vfs-cache-max-size` or `--vfs-cache-min-free-size` note If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note
that the cache may exceed these quotas for two reasons. Firstly that the cache may exceed these quotas for two reasons. Firstly
because it is only checked every `--vfs-cache-poll-interval`. Secondly because it is only checked every `--vfs-cache-poll-interval`. Secondly
because open files cannot be evicted from the cache. When because open files cannot be evicted from the cache. When
`--vfs-cache-max-size` or `--vfs-cache-min-free-size` is exceeded, `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded,
rclone will attempt to evict the least accessed files from the cache rclone will attempt to evict the least accessed files from the cache
first. rclone will start with files that haven't been accessed for the first. rclone will start with files that haven't been accessed for the
longest. This cache flushing strategy is efficient and more relevant longest. This cache flushing strategy is efficient and more relevant
@@ -10778,11 +10785,11 @@ seconds. If rclone is quit or dies with files that haven't been
uploaded, these will be uploaded next time rclone is run with the same uploaded, these will be uploaded next time rclone is run with the same
flags. flags.
If using `--vfs-cache-max-size` or `--vfs-cache-min-free-size` note If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note
that the cache may exceed these quotas for two reasons. Firstly that the cache may exceed these quotas for two reasons. Firstly
because it is only checked every `--vfs-cache-poll-interval`. Secondly because it is only checked every `--vfs-cache-poll-interval`. Secondly
because open files cannot be evicted from the cache. When because open files cannot be evicted from the cache. When
`--vfs-cache-max-size` or `--vfs-cache-min-free-size` is exceeded, `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded,
rclone will attempt to evict the least accessed files from the cache rclone will attempt to evict the least accessed files from the cache
first. rclone will start with files that haven't been accessed for the first. rclone will start with files that haven't been accessed for the
longest. This cache flushing strategy is efficient and more relevant longest. This cache flushing strategy is efficient and more relevant
@@ -11427,7 +11434,7 @@ docs](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html)).
access. access.
Please note that some clients may require HTTPS endpoints. See [the Please note that some clients may require HTTPS endpoints. See [the
SSL docs](#ssl-tls) for more information. SSL docs](#tls-ssl) for more information.
This command uses the [VFS directory cache](#vfs-virtual-file-system). This command uses the [VFS directory cache](#vfs-virtual-file-system).
All the functionality will work with `--vfs-cache-mode off`. Using All the functionality will work with `--vfs-cache-mode off`. Using
@@ -11734,11 +11741,11 @@ seconds. If rclone is quit or dies with files that haven't been
uploaded, these will be uploaded next time rclone is run with the same uploaded, these will be uploaded next time rclone is run with the same
flags. flags.
If using `--vfs-cache-max-size` or `--vfs-cache-min-free-size` note If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note
that the cache may exceed these quotas for two reasons. Firstly that the cache may exceed these quotas for two reasons. Firstly
because it is only checked every `--vfs-cache-poll-interval`. Secondly because it is only checked every `--vfs-cache-poll-interval`. Secondly
because open files cannot be evicted from the cache. When because open files cannot be evicted from the cache. When
`--vfs-cache-max-size` or `--vfs-cache-min-free-size` is exceeded, `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded,
rclone will attempt to evict the least accessed files from the cache rclone will attempt to evict the least accessed files from the cache
first. rclone will start with files that haven't been accessed for the first. rclone will start with files that haven't been accessed for the
longest. This cache flushing strategy is efficient and more relevant longest. This cache flushing strategy is efficient and more relevant
@@ -12328,11 +12335,11 @@ seconds. If rclone is quit or dies with files that haven't been
uploaded, these will be uploaded next time rclone is run with the same uploaded, these will be uploaded next time rclone is run with the same
flags. flags.
If using `--vfs-cache-max-size` or `--vfs-cache-min-free-size` note If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note
that the cache may exceed these quotas for two reasons. Firstly that the cache may exceed these quotas for two reasons. Firstly
because it is only checked every `--vfs-cache-poll-interval`. Secondly because it is only checked every `--vfs-cache-poll-interval`. Secondly
because open files cannot be evicted from the cache. When because open files cannot be evicted from the cache. When
`--vfs-cache-max-size` or `--vfs-cache-min-free-size` is exceeded, `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded,
rclone will attempt to evict the least accessed files from the cache rclone will attempt to evict the least accessed files from the cache
first. rclone will start with files that haven't been accessed for the first. rclone will start with files that haven't been accessed for the
longest. This cache flushing strategy is efficient and more relevant longest. This cache flushing strategy is efficient and more relevant
@@ -13109,11 +13116,11 @@ seconds. If rclone is quit or dies with files that haven't been
uploaded, these will be uploaded next time rclone is run with the same uploaded, these will be uploaded next time rclone is run with the same
flags. flags.
If using `--vfs-cache-max-size` or `--vfs-cache-min-free-size` note If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note
that the cache may exceed these quotas for two reasons. Firstly that the cache may exceed these quotas for two reasons. Firstly
because it is only checked every `--vfs-cache-poll-interval`. Secondly because it is only checked every `--vfs-cache-poll-interval`. Secondly
because open files cannot be evicted from the cache. When because open files cannot be evicted from the cache. When
`--vfs-cache-max-size` or `--vfs-cache-min-free-size` is exceeded, `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded,
rclone will attempt to evict the least accessed files from the cache rclone will attempt to evict the least accessed files from the cache
first. rclone will start with files that haven't been accessed for the first. rclone will start with files that haven't been accessed for the
longest. This cache flushing strategy is efficient and more relevant longest. This cache flushing strategy is efficient and more relevant
@@ -21097,7 +21104,7 @@ Flags for general networking and HTTP stuff.
--tpslimit float Limit HTTP transactions per second to this --tpslimit float Limit HTTP transactions per second to this
--tpslimit-burst int Max burst of transactions for --tpslimit (default 1) --tpslimit-burst int Max burst of transactions for --tpslimit (default 1)
--use-cookies Enable session cookiejar --use-cookies Enable session cookiejar
--user-agent string Set the user-agent to a specified string (default "rclone/v1.69.1") --user-agent string Set the user-agent to a specified string (default "rclone/v1.69.2")
``` ```
@@ -22141,7 +22148,7 @@ on the host.
The _FUSE_ driver is a prerequisite for rclone mounting and should be The _FUSE_ driver is a prerequisite for rclone mounting and should be
installed on host: installed on host:
``` ```
sudo apt-get -y install fuse sudo apt-get -y install fuse3
``` ```
Create two directories required by rclone docker plugin: Create two directories required by rclone docker plugin:
@@ -25783,7 +25790,8 @@ tries to access data from the glacier storage class you will see an error like b
2017/09/11 19:07:43 Failed to sync: failed to open source object: Object in GLACIER, restore first: path/to/file 2017/09/11 19:07:43 Failed to sync: failed to open source object: Object in GLACIER, restore first: path/to/file
In this case you need to [restore](http://docs.aws.amazon.com/AmazonS3/latest/user-guide/restore-archived-objects.html) In this case you need to [restore](http://docs.aws.amazon.com/AmazonS3/latest/user-guide/restore-archived-objects.html)
the object(s) in question before using rclone. the object(s) in question before accessing object contents.
The [restore](#restore) section below shows how to do this with rclone.
Note that rclone only speaks the S3 API it does not speak the Glacier Note that rclone only speaks the S3 API it does not speak the Glacier
Vault API, so rclone cannot directly access Glacier Vaults. Vault API, so rclone cannot directly access Glacier Vaults.
@@ -27186,7 +27194,7 @@ or from INTELLIGENT-TIERING Archive Access / Deep Archive Access tier to the Fre
Usage Examples: Usage Examples:
rclone backend restore s3:bucket/path/to/object -o priority=PRIORITY -o lifetime=DAYS rclone backend restore s3:bucket/path/to/ --include /object -o priority=PRIORITY -o lifetime=DAYS
rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY -o lifetime=DAYS rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY -o lifetime=DAYS
rclone backend restore s3:bucket -o priority=PRIORITY -o lifetime=DAYS rclone backend restore s3:bucket -o priority=PRIORITY -o lifetime=DAYS
rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY
@@ -31592,7 +31600,7 @@ machine with no Internet browser available.
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Box. This only runs from the moment it opens token as returned from Box. This only runs from the moment it opens
your browser to the moment you get back the verification code. This your browser to the moment you get back the verification code. This
is on `http://127.0.0.1:53682/` and this it may require you to unblock is on `http://127.0.0.1:53682/` and this may require you to unblock
it temporarily if you are running a host firewall. it temporarily if you are running a host firewall.
Once configured you can then use `rclone` like this, Once configured you can then use `rclone` like this,
@@ -53113,7 +53121,8 @@ Properties:
On some SFTP servers (e.g. Synology) the paths are different On some SFTP servers (e.g. Synology) the paths are different
for SSH and SFTP so the hashes can't be calculated properly. for SSH and SFTP so the hashes can't be calculated properly.
For them using `disable_hashcheck` is a good idea. You can either use [`--sftp-path-override`](#--sftp-path-override)
or [`disable_hashcheck`](#--sftp-disable-hashcheck).
The only ssh agent supported under Windows is Putty's pageant. The only ssh agent supported under Windows is Putty's pageant.
@@ -56649,6 +56658,50 @@ Options:
# Changelog # Changelog
## v1.69.2 - 2025-05-01
[See commits](https://github.com/rclone/rclone/compare/v1.69.1...v1.69.2)
* Bug fixes
* accounting: Fix percentDiff calculation -- (Anagh Kumar Baranwal)
* build
* Update github.com/golang-jwt/jwt/v4 from 4.5.1 to 4.5.2 to fix CVE-2025-30204 (dependabot[bot])
* Update github.com/golang-jwt/jwt/v5 from 5.2.1 to 5.2.2 to fix CVE-2025-30204 (dependabot[bot])
* Update golang.org/x/crypto to v0.35.0 to fix CVE-2025-22869 (Nick Craig-Wood)
* Update golang.org/x/net from 0.36.0 to 0.38.0 to fix CVE-2025-22870 (dependabot[bot])
* Update golang.org/x/net to 0.36.0. to fix CVE-2025-22869 (dependabot[bot])
* Stop building with go < go1.23 as security updates forbade it (Nick Craig-Wood)
* Fix docker plugin build (Anagh Kumar Baranwal)
* cmd: Fix crash if rclone is invoked without any arguments (Janne Hellsten)
* config: Read configuration passwords from stdin even when terminated with EOF (Samantha Bowen)
* doc fixes (Andrew Kreimer, Danny Garside, eccoisle, Ed Craig-Wood, emyarod, jack, Jugal Kishore, Markus Gerstel, Michael Kebe, Nick Craig-Wood, simonmcnair, simwai, Zachary Vorhies)
* fs: Fix corruption of SizeSuffix with "B" suffix in config (eg --min-size) (Nick Craig-Wood)
* lib/http: Fix race between Serve() and Shutdown() (Nick Craig-Wood)
* object: Fix memory object out of bounds Seek (Nick Craig-Wood)
* operations: Fix call fmt.Errorf with wrong err (alingse)
* rc
* Disable the metrics server when running `rclone rc` (hiddenmarten)
* Fix debug/* commands not being available over unix sockets (Nick Craig-Wood)
* serve nfs: Fix unlikely crash (Nick Craig-Wood)
* stats: Fix the speed not getting updated after a pause in the processing (Anagh Kumar Baranwal)
* sync
* Fix cpu spinning when empty directory finding with leading slashes (Nick Craig-Wood)
* Copy dir modtimes even when copyEmptySrcDirs is false (ll3006)
* VFS
* Fix directory cache serving stale data (Lorenz Brun)
* Fix inefficient directory caching when directory reads are slow (huanghaojun)
* Fix integration test failures (Nick Craig-Wood)
* Drive
* Metadata: fix error when setting copy-requires-writer-permission on a folder (Nick Craig-Wood)
* Dropbox
* Retry link without expiry (Dave Vasilevsky)
* HTTP
* Correct root if definitely pointing to a file (nielash)
* Iclouddrive
* Fix so created files are writable (Ben Alex)
* Onedrive
* Fix metadata ordering in permissions (Nick Craig-Wood)
## v1.69.1 - 2025-02-14 ## v1.69.1 - 2025-02-14
[See commits](https://github.com/rclone/rclone/compare/v1.69.0...v1.69.1) [See commits](https://github.com/rclone/rclone/compare/v1.69.0...v1.69.1)
@@ -56704,7 +56757,7 @@ Options:
* fs: Make `--links` flag global and add new `--local-links` and `--vfs-links` flags (Nick Craig-Wood) * fs: Make `--links` flag global and add new `--local-links` and `--vfs-links` flags (Nick Craig-Wood)
* http servers: Disable automatic authentication skipping for unix sockets in http servers (Moises Lima) * http servers: Disable automatic authentication skipping for unix sockets in http servers (Moises Lima)
* This was making it impossible to use unix sockets with an proxy * This was making it impossible to use unix sockets with an proxy
* This might now cause rclone to need authenticaton where it didn't before * This might now cause rclone to need authentication where it didn't before
* oauthutil: add support for OAuth client credential flow (Martin Hassack, Nick Craig-Wood) * oauthutil: add support for OAuth client credential flow (Martin Hassack, Nick Craig-Wood)
* operations: make log messages consistent for mkdir/rmdir at INFO level (Nick Craig-Wood) * operations: make log messages consistent for mkdir/rmdir at INFO level (Nick Craig-Wood)
* rc: Add `relative` to [vfs/queue-set-expiry](https://rclone.org/rc/#vfs-queue-set-expiry) (Nick Craig-Wood) * rc: Add `relative` to [vfs/queue-set-expiry](https://rclone.org/rc/#vfs-queue-set-expiry) (Nick Craig-Wood)
@@ -57382,7 +57435,7 @@ instead of of `--size-only`, when `check` is not available.
* Update all dependencies (Nick Craig-Wood) * Update all dependencies (Nick Craig-Wood)
* Refactor version info and icon resource handling on windows (albertony) * Refactor version info and icon resource handling on windows (albertony)
* doc updates (albertony, alfish2000, asdffdsazqqq, Dimitri Papadopoulos, Herby Gillot, Joda Stößer, Manoj Ghosh, Nick Craig-Wood) * doc updates (albertony, alfish2000, asdffdsazqqq, Dimitri Papadopoulos, Herby Gillot, Joda Stößer, Manoj Ghosh, Nick Craig-Wood)
* Implement `--metadata-mapper` to transform metatadata with a user supplied program (Nick Craig-Wood) * Implement `--metadata-mapper` to transform metadata with a user supplied program (Nick Craig-Wood)
* Add `ChunkWriterDoesntSeek` feature flag and set it for b2 (Nick Craig-Wood) * Add `ChunkWriterDoesntSeek` feature flag and set it for b2 (Nick Craig-Wood)
* lib/http: Export basic go string functions for use in `--template` (Gabriel Espinoza) * lib/http: Export basic go string functions for use in `--template` (Gabriel Espinoza)
* makefile: Use POSIX compatible install arguments (Mina Galić) * makefile: Use POSIX compatible install arguments (Mina Galić)
@@ -57497,7 +57550,7 @@ instead of of `--size-only`, when `check` is not available.
* Fix "fatal error: concurrent map writes" (Nick Craig-Wood) * Fix "fatal error: concurrent map writes" (Nick Craig-Wood)
* B2 * B2
* Fix multipart upload: corrupted on transfer: sizes differ XXX vs 0 (Nick Craig-Wood) * Fix multipart upload: corrupted on transfer: sizes differ XXX vs 0 (Nick Craig-Wood)
* Fix locking window when getting mutipart upload URL (Nick Craig-Wood) * Fix locking window when getting multipart upload URL (Nick Craig-Wood)
* Fix server side copies greater than 4GB (Nick Craig-Wood) * Fix server side copies greater than 4GB (Nick Craig-Wood)
* Fix chunked streaming uploads (Nick Craig-Wood) * Fix chunked streaming uploads (Nick Craig-Wood)
* Reduce default `--b2-upload-concurrency` to 4 to reduce memory usage (Nick Craig-Wood) * Reduce default `--b2-upload-concurrency` to 4 to reduce memory usage (Nick Craig-Wood)
@@ -63404,7 +63457,6 @@ put them back in again.` >}}
* ben-ba <benjamin.brauner@gmx.de> * ben-ba <benjamin.brauner@gmx.de>
* Eli Orzitzer <e_orz@yahoo.com> * Eli Orzitzer <e_orz@yahoo.com>
* Anthony Metzidis <anthony.metzidis@gmail.com> * Anthony Metzidis <anthony.metzidis@gmail.com>
* emyarod <afw5059@gmail.com>
* keongalvin <keongalvin@gmail.com> * keongalvin <keongalvin@gmail.com>
* rarspace01 <rarspace01@users.noreply.github.com> * rarspace01 <rarspace01@users.noreply.github.com>
* Paul Stern <paulstern45@gmail.com> * Paul Stern <paulstern45@gmail.com>

165
MANUAL.txt generated
View File

@@ -1,6 +1,6 @@
rclone(1) User Manual rclone(1) User Manual
Nick Craig-Wood Nick Craig-Wood
Feb 14, 2025 May 01, 2025
NAME NAME
@@ -2668,6 +2668,11 @@ Synopsis
Remote authorization. Used to authorize a remote or headless rclone from Remote authorization. Used to authorize a remote or headless rclone from
a machine with a browser - use as instructed by rclone config. a machine with a browser - use as instructed by rclone config.
The command requires 1-3 arguments: - fs name (e.g., "drive", "s3",
etc.) - Either a base64 encoded JSON blob obtained from a previous
rclone config session - Or a client_id and client_secret pair obtained
from the remote service
Use --auth-no-open-browser to prevent rclone to open auth link in Use --auth-no-open-browser to prevent rclone to open auth link in
default browser automatically. default browser automatically.
@@ -2675,7 +2680,7 @@ Use --template to generate HTML output via a custom Go template. If a
blank string is provided as an argument to this flag, the default blank string is provided as an argument to this flag, the default
template is used. template is used.
rclone authorize [flags] rclone authorize <fs name> [base64_json_blob | client_id client_secret] [flags]
Options Options
@@ -3904,6 +3909,9 @@ This doesn't transfer files that are identical on src and dst, testing
by size and modification time or MD5SUM. It doesn't delete files from by size and modification time or MD5SUM. It doesn't delete files from
the destination. the destination.
If you are looking to copy just a byte range of a file, please see
'rclone cat --offset X --count Y'
Note: Use the -P/--progress flag to view real-time transfer statistics Note: Use the -P/--progress flag to view real-time transfer statistics
rclone copyto source:path dest:path [flags] rclone copyto source:path dest:path [flags]
@@ -4012,8 +4020,8 @@ Setting --auto-filename will attempt to automatically determine the
filename from the URL (after any redirections) and used in the filename from the URL (after any redirections) and used in the
destination path. destination path.
With --auto-filename-header in addition, if a specific filename is set With --header-filename in addition, if a specific filename is set in
in HTTP headers, it will be used instead of the name from the URL. With HTTP headers, it will be used instead of the name from the URL. With
--print-filename in addition, the resulting file name will be printed. --print-filename in addition, the resulting file name will be printed.
Setting --no-clobber will prevent overwriting file on the destination if Setting --no-clobber will prevent overwriting file on the destination if
@@ -5441,11 +5449,11 @@ and if they haven't been accessed for --vfs-write-back seconds. If
rclone is quit or dies with files that haven't been uploaded, these will rclone is quit or dies with files that haven't been uploaded, these will
be uploaded next time rclone is run with the same flags. be uploaded next time rclone is run with the same flags.
If using --vfs-cache-max-size or --vfs-cache-min-free-size note that the If using --vfs-cache-max-size or --vfs-cache-min-free-space note that
cache may exceed these quotas for two reasons. Firstly because it is the cache may exceed these quotas for two reasons. Firstly because it is
only checked every --vfs-cache-poll-interval. Secondly because open only checked every --vfs-cache-poll-interval. Secondly because open
files cannot be evicted from the cache. When --vfs-cache-max-size or files cannot be evicted from the cache. When --vfs-cache-max-size or
--vfs-cache-min-free-size is exceeded, rclone will attempt to evict the --vfs-cache-min-free-space is exceeded, rclone will attempt to evict the
least accessed files from the cache first. rclone will start with files least accessed files from the cache first. rclone will start with files
that haven't been accessed for the longest. This cache flushing strategy that haven't been accessed for the longest. This cache flushing strategy
is efficient and more relevant files are likely to remain cached. is efficient and more relevant files are likely to remain cached.
@@ -6673,11 +6681,11 @@ and if they haven't been accessed for --vfs-write-back seconds. If
rclone is quit or dies with files that haven't been uploaded, these will rclone is quit or dies with files that haven't been uploaded, these will
be uploaded next time rclone is run with the same flags. be uploaded next time rclone is run with the same flags.
If using --vfs-cache-max-size or --vfs-cache-min-free-size note that the If using --vfs-cache-max-size or --vfs-cache-min-free-space note that
cache may exceed these quotas for two reasons. Firstly because it is the cache may exceed these quotas for two reasons. Firstly because it is
only checked every --vfs-cache-poll-interval. Secondly because open only checked every --vfs-cache-poll-interval. Secondly because open
files cannot be evicted from the cache. When --vfs-cache-max-size or files cannot be evicted from the cache. When --vfs-cache-max-size or
--vfs-cache-min-free-size is exceeded, rclone will attempt to evict the --vfs-cache-min-free-space is exceeded, rclone will attempt to evict the
least accessed files from the cache first. rclone will start with files least accessed files from the cache first. rclone will start with files
that haven't been accessed for the longest. This cache flushing strategy that haven't been accessed for the longest. This cache flushing strategy
is efficient and more relevant files are likely to remain cached. is efficient and more relevant files are likely to remain cached.
@@ -7789,11 +7797,11 @@ and if they haven't been accessed for --vfs-write-back seconds. If
rclone is quit or dies with files that haven't been uploaded, these will rclone is quit or dies with files that haven't been uploaded, these will
be uploaded next time rclone is run with the same flags. be uploaded next time rclone is run with the same flags.
If using --vfs-cache-max-size or --vfs-cache-min-free-size note that the If using --vfs-cache-max-size or --vfs-cache-min-free-space note that
cache may exceed these quotas for two reasons. Firstly because it is the cache may exceed these quotas for two reasons. Firstly because it is
only checked every --vfs-cache-poll-interval. Secondly because open only checked every --vfs-cache-poll-interval. Secondly because open
files cannot be evicted from the cache. When --vfs-cache-max-size or files cannot be evicted from the cache. When --vfs-cache-max-size or
--vfs-cache-min-free-size is exceeded, rclone will attempt to evict the --vfs-cache-min-free-space is exceeded, rclone will attempt to evict the
least accessed files from the cache first. rclone will start with files least accessed files from the cache first. rclone will start with files
that haven't been accessed for the longest. This cache flushing strategy that haven't been accessed for the longest. This cache flushing strategy
is efficient and more relevant files are likely to remain cached. is efficient and more relevant files are likely to remain cached.
@@ -8334,11 +8342,11 @@ and if they haven't been accessed for --vfs-write-back seconds. If
rclone is quit or dies with files that haven't been uploaded, these will rclone is quit or dies with files that haven't been uploaded, these will
be uploaded next time rclone is run with the same flags. be uploaded next time rclone is run with the same flags.
If using --vfs-cache-max-size or --vfs-cache-min-free-size note that the If using --vfs-cache-max-size or --vfs-cache-min-free-space note that
cache may exceed these quotas for two reasons. Firstly because it is the cache may exceed these quotas for two reasons. Firstly because it is
only checked every --vfs-cache-poll-interval. Secondly because open only checked every --vfs-cache-poll-interval. Secondly because open
files cannot be evicted from the cache. When --vfs-cache-max-size or files cannot be evicted from the cache. When --vfs-cache-max-size or
--vfs-cache-min-free-size is exceeded, rclone will attempt to evict the --vfs-cache-min-free-space is exceeded, rclone will attempt to evict the
least accessed files from the cache first. rclone will start with files least accessed files from the cache first. rclone will start with files
that haven't been accessed for the longest. This cache flushing strategy that haven't been accessed for the longest. This cache flushing strategy
is efficient and more relevant files are likely to remain cached. is efficient and more relevant files are likely to remain cached.
@@ -8883,11 +8891,11 @@ and if they haven't been accessed for --vfs-write-back seconds. If
rclone is quit or dies with files that haven't been uploaded, these will rclone is quit or dies with files that haven't been uploaded, these will
be uploaded next time rclone is run with the same flags. be uploaded next time rclone is run with the same flags.
If using --vfs-cache-max-size or --vfs-cache-min-free-size note that the If using --vfs-cache-max-size or --vfs-cache-min-free-space note that
cache may exceed these quotas for two reasons. Firstly because it is the cache may exceed these quotas for two reasons. Firstly because it is
only checked every --vfs-cache-poll-interval. Secondly because open only checked every --vfs-cache-poll-interval. Secondly because open
files cannot be evicted from the cache. When --vfs-cache-max-size or files cannot be evicted from the cache. When --vfs-cache-max-size or
--vfs-cache-min-free-size is exceeded, rclone will attempt to evict the --vfs-cache-min-free-space is exceeded, rclone will attempt to evict the
least accessed files from the cache first. rclone will start with files least accessed files from the cache first. rclone will start with files
that haven't been accessed for the longest. This cache flushing strategy that haven't been accessed for the longest. This cache flushing strategy
is efficient and more relevant files are likely to remain cached. is efficient and more relevant files are likely to remain cached.
@@ -9640,11 +9648,11 @@ and if they haven't been accessed for --vfs-write-back seconds. If
rclone is quit or dies with files that haven't been uploaded, these will rclone is quit or dies with files that haven't been uploaded, these will
be uploaded next time rclone is run with the same flags. be uploaded next time rclone is run with the same flags.
If using --vfs-cache-max-size or --vfs-cache-min-free-size note that the If using --vfs-cache-max-size or --vfs-cache-min-free-space note that
cache may exceed these quotas for two reasons. Firstly because it is the cache may exceed these quotas for two reasons. Firstly because it is
only checked every --vfs-cache-poll-interval. Secondly because open only checked every --vfs-cache-poll-interval. Secondly because open
files cannot be evicted from the cache. When --vfs-cache-max-size or files cannot be evicted from the cache. When --vfs-cache-max-size or
--vfs-cache-min-free-size is exceeded, rclone will attempt to evict the --vfs-cache-min-free-space is exceeded, rclone will attempt to evict the
least accessed files from the cache first. rclone will start with files least accessed files from the cache first. rclone will start with files
that haven't been accessed for the longest. This cache flushing strategy that haven't been accessed for the longest. This cache flushing strategy
is efficient and more relevant files are likely to remain cached. is efficient and more relevant files are likely to remain cached.
@@ -10296,11 +10304,11 @@ and if they haven't been accessed for --vfs-write-back seconds. If
rclone is quit or dies with files that haven't been uploaded, these will rclone is quit or dies with files that haven't been uploaded, these will
be uploaded next time rclone is run with the same flags. be uploaded next time rclone is run with the same flags.
If using --vfs-cache-max-size or --vfs-cache-min-free-size note that the If using --vfs-cache-max-size or --vfs-cache-min-free-space note that
cache may exceed these quotas for two reasons. Firstly because it is the cache may exceed these quotas for two reasons. Firstly because it is
only checked every --vfs-cache-poll-interval. Secondly because open only checked every --vfs-cache-poll-interval. Secondly because open
files cannot be evicted from the cache. When --vfs-cache-max-size or files cannot be evicted from the cache. When --vfs-cache-max-size or
--vfs-cache-min-free-size is exceeded, rclone will attempt to evict the --vfs-cache-min-free-space is exceeded, rclone will attempt to evict the
least accessed files from the cache first. rclone will start with files least accessed files from the cache first. rclone will start with files
that haven't been accessed for the longest. This cache flushing strategy that haven't been accessed for the longest. This cache flushing strategy
is efficient and more relevant files are likely to remain cached. is efficient and more relevant files are likely to remain cached.
@@ -11224,11 +11232,11 @@ and if they haven't been accessed for --vfs-write-back seconds. If
rclone is quit or dies with files that haven't been uploaded, these will rclone is quit or dies with files that haven't been uploaded, these will
be uploaded next time rclone is run with the same flags. be uploaded next time rclone is run with the same flags.
If using --vfs-cache-max-size or --vfs-cache-min-free-size note that the If using --vfs-cache-max-size or --vfs-cache-min-free-space note that
cache may exceed these quotas for two reasons. Firstly because it is the cache may exceed these quotas for two reasons. Firstly because it is
only checked every --vfs-cache-poll-interval. Secondly because open only checked every --vfs-cache-poll-interval. Secondly because open
files cannot be evicted from the cache. When --vfs-cache-max-size or files cannot be evicted from the cache. When --vfs-cache-max-size or
--vfs-cache-min-free-size is exceeded, rclone will attempt to evict the --vfs-cache-min-free-space is exceeded, rclone will attempt to evict the
least accessed files from the cache first. rclone will start with files least accessed files from the cache first. rclone will start with files
that haven't been accessed for the longest. This cache flushing strategy that haven't been accessed for the longest. This cache flushing strategy
is efficient and more relevant files are likely to remain cached. is efficient and more relevant files are likely to remain cached.
@@ -11811,11 +11819,11 @@ and if they haven't been accessed for --vfs-write-back seconds. If
rclone is quit or dies with files that haven't been uploaded, these will rclone is quit or dies with files that haven't been uploaded, these will
be uploaded next time rclone is run with the same flags. be uploaded next time rclone is run with the same flags.
If using --vfs-cache-max-size or --vfs-cache-min-free-size note that the If using --vfs-cache-max-size or --vfs-cache-min-free-space note that
cache may exceed these quotas for two reasons. Firstly because it is the cache may exceed these quotas for two reasons. Firstly because it is
only checked every --vfs-cache-poll-interval. Secondly because open only checked every --vfs-cache-poll-interval. Secondly because open
files cannot be evicted from the cache. When --vfs-cache-max-size or files cannot be evicted from the cache. When --vfs-cache-max-size or
--vfs-cache-min-free-size is exceeded, rclone will attempt to evict the --vfs-cache-min-free-space is exceeded, rclone will attempt to evict the
least accessed files from the cache first. rclone will start with files least accessed files from the cache first. rclone will start with files
that haven't been accessed for the longest. This cache flushing strategy that haven't been accessed for the longest. This cache flushing strategy
is efficient and more relevant files are likely to remain cached. is efficient and more relevant files are likely to remain cached.
@@ -12611,11 +12619,11 @@ and if they haven't been accessed for --vfs-write-back seconds. If
rclone is quit or dies with files that haven't been uploaded, these will rclone is quit or dies with files that haven't been uploaded, these will
be uploaded next time rclone is run with the same flags. be uploaded next time rclone is run with the same flags.
If using --vfs-cache-max-size or --vfs-cache-min-free-size note that the If using --vfs-cache-max-size or --vfs-cache-min-free-space note that
cache may exceed these quotas for two reasons. Firstly because it is the cache may exceed these quotas for two reasons. Firstly because it is
only checked every --vfs-cache-poll-interval. Secondly because open only checked every --vfs-cache-poll-interval. Secondly because open
files cannot be evicted from the cache. When --vfs-cache-max-size or files cannot be evicted from the cache. When --vfs-cache-max-size or
--vfs-cache-min-free-size is exceeded, rclone will attempt to evict the --vfs-cache-min-free-space is exceeded, rclone will attempt to evict the
least accessed files from the cache first. rclone will start with files least accessed files from the cache first. rclone will start with files
that haven't been accessed for the longest. This cache flushing strategy that haven't been accessed for the longest. This cache flushing strategy
is efficient and more relevant files are likely to remain cached. is efficient and more relevant files are likely to remain cached.
@@ -20646,7 +20654,7 @@ Flags for general networking and HTTP stuff.
--tpslimit float Limit HTTP transactions per second to this --tpslimit float Limit HTTP transactions per second to this
--tpslimit-burst int Max burst of transactions for --tpslimit (default 1) --tpslimit-burst int Max burst of transactions for --tpslimit (default 1)
--use-cookies Enable session cookiejar --use-cookies Enable session cookiejar
--user-agent string Set the user-agent to a specified string (default "rclone/v1.69.1") --user-agent string Set the user-agent to a specified string (default "rclone/v1.69.2")
Performance Performance
@@ -21651,7 +21659,7 @@ Start from installing Docker on the host.
The FUSE driver is a prerequisite for rclone mounting and should be The FUSE driver is a prerequisite for rclone mounting and should be
installed on host: installed on host:
sudo apt-get -y install fuse sudo apt-get -y install fuse3
Create two directories required by rclone docker plugin: Create two directories required by rclone docker plugin:
@@ -25296,8 +25304,9 @@ glacier storage class you will see an error like below.
2017/09/11 19:07:43 Failed to sync: failed to open source object: Object in GLACIER, restore first: path/to/file 2017/09/11 19:07:43 Failed to sync: failed to open source object: Object in GLACIER, restore first: path/to/file
In this case you need to restore the object(s) in question before using In this case you need to restore the object(s) in question before
rclone. accessing object contents. The restore section below shows how to do
this with rclone.
Note that rclone only speaks the S3 API it does not speak the Glacier Note that rclone only speaks the S3 API it does not speak the Glacier
Vault API, so rclone cannot directly access Glacier Vaults. Vault API, so rclone cannot directly access Glacier Vaults.
@@ -26728,7 +26737,7 @@ Access tier to the Frequent Access tier.
Usage Examples: Usage Examples:
rclone backend restore s3:bucket/path/to/object -o priority=PRIORITY -o lifetime=DAYS rclone backend restore s3:bucket/path/to/ --include /object -o priority=PRIORITY -o lifetime=DAYS
rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY -o lifetime=DAYS rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY -o lifetime=DAYS
rclone backend restore s3:bucket -o priority=PRIORITY -o lifetime=DAYS rclone backend restore s3:bucket -o priority=PRIORITY -o lifetime=DAYS
rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY
@@ -30952,7 +30961,7 @@ Internet browser available.
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Box. This only runs from the moment it opens your token as returned from Box. This only runs from the moment it opens your
browser to the moment you get back the verification code. This is on browser to the moment you get back the verification code. This is on
http://127.0.0.1:53682/ and this it may require you to unblock it http://127.0.0.1:53682/ and this may require you to unblock it
temporarily if you are running a host firewall. temporarily if you are running a host firewall.
Once configured you can then use rclone like this, Once configured you can then use rclone like this,
@@ -52734,8 +52743,8 @@ Properties:
Limitations Limitations
On some SFTP servers (e.g. Synology) the paths are different for SSH and On 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 SFTP so the hashes can't be calculated properly. You can either use
disable_hashcheck is a good idea. --sftp-path-override or disable_hashcheck.
The only ssh agent supported under Windows is Putty's pageant. The only ssh agent supported under Windows is Putty's pageant.
@@ -56315,6 +56324,71 @@ Options:
Changelog Changelog
v1.69.2 - 2025-05-01
See commits
- Bug fixes
- accounting: Fix percentDiff calculation -- (Anagh Kumar
Baranwal)
- build
- Update github.com/golang-jwt/jwt/v4 from 4.5.1 to 4.5.2 to
fix CVE-2025-30204 (dependabot[bot])
- Update github.com/golang-jwt/jwt/v5 from 5.2.1 to 5.2.2 to
fix CVE-2025-30204 (dependabot[bot])
- Update golang.org/x/crypto to v0.35.0 to fix CVE-2025-22869
(Nick Craig-Wood)
- Update golang.org/x/net from 0.36.0 to 0.38.0 to fix
CVE-2025-22870 (dependabot[bot])
- Update golang.org/x/net to 0.36.0. to fix CVE-2025-22869
(dependabot[bot])
- Stop building with go < go1.23 as security updates forbade
it (Nick Craig-Wood)
- Fix docker plugin build (Anagh Kumar Baranwal)
- cmd: Fix crash if rclone is invoked without any arguments (Janne
Hellsten)
- config: Read configuration passwords from stdin even when
terminated with EOF (Samantha Bowen)
- doc fixes (Andrew Kreimer, Danny Garside, eccoisle, Ed
Craig-Wood, emyarod, jack, Jugal Kishore, Markus Gerstel,
Michael Kebe, Nick Craig-Wood, simonmcnair, simwai, Zachary
Vorhies)
- fs: Fix corruption of SizeSuffix with "B" suffix in config (eg
--min-size) (Nick Craig-Wood)
- lib/http: Fix race between Serve() and Shutdown() (Nick
Craig-Wood)
- object: Fix memory object out of bounds Seek (Nick Craig-Wood)
- operations: Fix call fmt.Errorf with wrong err (alingse)
- rc
- Disable the metrics server when running rclone rc
(hiddenmarten)
- Fix debug/* commands not being available over unix sockets
(Nick Craig-Wood)
- serve nfs: Fix unlikely crash (Nick Craig-Wood)
- stats: Fix the speed not getting updated after a pause in the
processing (Anagh Kumar Baranwal)
- sync
- Fix cpu spinning when empty directory finding with leading
slashes (Nick Craig-Wood)
- Copy dir modtimes even when copyEmptySrcDirs is false
(ll3006)
- VFS
- Fix directory cache serving stale data (Lorenz Brun)
- Fix inefficient directory caching when directory reads are slow
(huanghaojun)
- Fix integration test failures (Nick Craig-Wood)
- Drive
- Metadata: fix error when setting copy-requires-writer-permission
on a folder (Nick Craig-Wood)
- Dropbox
- Retry link without expiry (Dave Vasilevsky)
- HTTP
- Correct root if definitely pointing to a file (nielash)
- Iclouddrive
- Fix so created files are writable (Ben Alex)
- Onedrive
- Fix metadata ordering in permissions (Nick Craig-Wood)
v1.69.1 - 2025-02-14 v1.69.1 - 2025-02-14
See commits See commits
@@ -56391,7 +56465,7 @@ See commits
sockets in http servers (Moises Lima) sockets in http servers (Moises Lima)
- This was making it impossible to use unix sockets with an - This was making it impossible to use unix sockets with an
proxy proxy
- This might now cause rclone to need authenticaton where it - This might now cause rclone to need authentication where it
didn't before didn't before
- oauthutil: add support for OAuth client credential flow (Martin - oauthutil: add support for OAuth client credential flow (Martin
Hassack, Nick Craig-Wood) Hassack, Nick Craig-Wood)
@@ -57336,7 +57410,7 @@ See commits
- doc updates (albertony, alfish2000, asdffdsazqqq, Dimitri - doc updates (albertony, alfish2000, asdffdsazqqq, Dimitri
Papadopoulos, Herby Gillot, Joda Stößer, Manoj Ghosh, Nick Papadopoulos, Herby Gillot, Joda Stößer, Manoj Ghosh, Nick
Craig-Wood) Craig-Wood)
- Implement --metadata-mapper to transform metatadata with a user - Implement --metadata-mapper to transform metadata with a user
supplied program (Nick Craig-Wood) supplied program (Nick Craig-Wood)
- Add ChunkWriterDoesntSeek feature flag and set it for b2 (Nick - Add ChunkWriterDoesntSeek feature flag and set it for b2 (Nick
Craig-Wood) Craig-Wood)
@@ -57498,7 +57572,7 @@ See commits
- B2 - B2
- Fix multipart upload: corrupted on transfer: sizes differ XXX vs - Fix multipart upload: corrupted on transfer: sizes differ XXX vs
0 (Nick Craig-Wood) 0 (Nick Craig-Wood)
- Fix locking window when getting mutipart upload URL (Nick - Fix locking window when getting multipart upload URL (Nick
Craig-Wood) Craig-Wood)
- Fix server side copies greater than 4GB (Nick Craig-Wood) - Fix server side copies greater than 4GB (Nick Craig-Wood)
- Fix chunked streaming uploads (Nick Craig-Wood) - Fix chunked streaming uploads (Nick Craig-Wood)
@@ -64888,7 +64962,6 @@ email addresses removed from here need to be added to bin/.ignore-emails to make
- ben-ba benjamin.brauner@gmx.de - ben-ba benjamin.brauner@gmx.de
- Eli Orzitzer e_orz@yahoo.com - Eli Orzitzer e_orz@yahoo.com
- Anthony Metzidis anthony.metzidis@gmail.com - Anthony Metzidis anthony.metzidis@gmail.com
- emyarod afw5059@gmail.com
- keongalvin keongalvin@gmail.com - keongalvin keongalvin@gmail.com
- rarspace01 rarspace01@users.noreply.github.com - rarspace01 rarspace01@users.noreply.github.com
- Paul Stern paulstern45@gmail.com - Paul Stern paulstern45@gmail.com

44
docs/content/changelog.md
View File

@@ -5,6 +5,50 @@ description: "Rclone Changelog"
# Changelog # Changelog
## v1.69.2 - 2025-05-01
[See commits](https://github.com/rclone/rclone/compare/v1.69.1...v1.69.2)
* Bug fixes
* accounting: Fix percentDiff calculation -- (Anagh Kumar Baranwal)
* build
* Update github.com/golang-jwt/jwt/v4 from 4.5.1 to 4.5.2 to fix CVE-2025-30204 (dependabot[bot])
* Update github.com/golang-jwt/jwt/v5 from 5.2.1 to 5.2.2 to fix CVE-2025-30204 (dependabot[bot])
* Update golang.org/x/crypto to v0.35.0 to fix CVE-2025-22869 (Nick Craig-Wood)
* Update golang.org/x/net from 0.36.0 to 0.38.0 to fix CVE-2025-22870 (dependabot[bot])
* Update golang.org/x/net to 0.36.0. to fix CVE-2025-22869 (dependabot[bot])
* Stop building with go < go1.23 as security updates forbade it (Nick Craig-Wood)
* Fix docker plugin build (Anagh Kumar Baranwal)
* cmd: Fix crash if rclone is invoked without any arguments (Janne Hellsten)
* config: Read configuration passwords from stdin even when terminated with EOF (Samantha Bowen)
* doc fixes (Andrew Kreimer, Danny Garside, eccoisle, Ed Craig-Wood, emyarod, jack, Jugal Kishore, Markus Gerstel, Michael Kebe, Nick Craig-Wood, simonmcnair, simwai, Zachary Vorhies)
* fs: Fix corruption of SizeSuffix with "B" suffix in config (eg --min-size) (Nick Craig-Wood)
* lib/http: Fix race between Serve() and Shutdown() (Nick Craig-Wood)
* object: Fix memory object out of bounds Seek (Nick Craig-Wood)
* operations: Fix call fmt.Errorf with wrong err (alingse)
* rc
* Disable the metrics server when running `rclone rc` (hiddenmarten)
* Fix debug/* commands not being available over unix sockets (Nick Craig-Wood)
* serve nfs: Fix unlikely crash (Nick Craig-Wood)
* stats: Fix the speed not getting updated after a pause in the processing (Anagh Kumar Baranwal)
* sync
* Fix cpu spinning when empty directory finding with leading slashes (Nick Craig-Wood)
* Copy dir modtimes even when copyEmptySrcDirs is false (ll3006)
* VFS
* Fix directory cache serving stale data (Lorenz Brun)
* Fix inefficient directory caching when directory reads are slow (huanghaojun)
* Fix integration test failures (Nick Craig-Wood)
* Drive
* Metadata: fix error when setting copy-requires-writer-permission on a folder (Nick Craig-Wood)
* Dropbox
* Retry link without expiry (Dave Vasilevsky)
* HTTP
* Correct root if definitely pointing to a file (nielash)
* Iclouddrive
* Fix so created files are writable (Ben Alex)
* Onedrive
* Fix metadata ordering in permissions (Nick Craig-Wood)
## v1.69.1 - 2025-02-14 ## v1.69.1 - 2025-02-14
[See commits](https://github.com/rclone/rclone/compare/v1.69.0...v1.69.1) [See commits](https://github.com/rclone/rclone/compare/v1.69.0...v1.69.1)

2
docs/content/commands/rclone.md
View File

@@ -965,7 +965,7 @@ rclone [flags]
--use-json-log Use json log format --use-json-log Use json log format
--use-mmap Use mmap allocator (see docs) --use-mmap Use mmap allocator (see docs)
--use-server-modtime Use server modified time instead of object metadata --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.69.1") --user-agent string Set the user-agent to a specified string (default "rclone/v1.69.2")
-v, --verbose count Print lots more stuff (repeat for more) -v, --verbose count Print lots more stuff (repeat for more)
-V, --version Print the version number -V, --version Print the version number
--webdav-auth-redirect Preserve authentication on redirect --webdav-auth-redirect Preserve authentication on redirect

7
docs/content/commands/rclone_authorize.md
View File

@@ -14,13 +14,18 @@ Remote authorization. Used to authorize a remote or headless
rclone from a machine with a browser - use as instructed by rclone from a machine with a browser - use as instructed by
rclone config. rclone config.
The command requires 1-3 arguments:
- fs name (e.g., "drive", "s3", etc.)
- Either a base64 encoded JSON blob obtained from a previous rclone config session
- Or a client_id and client_secret pair obtained from the remote service
Use --auth-no-open-browser to prevent rclone to open auth Use --auth-no-open-browser to prevent rclone to open auth
link in default browser automatically. link in default browser automatically.
Use --template to generate HTML output via a custom Go template. If a blank string is provided as an argument to this flag, the default template is used. Use --template to generate HTML output via a custom Go template. If a blank string is provided as an argument to this flag, the default template is used.
``` ```
rclone authorize [flags] rclone authorize <fs name> [base64_json_blob | client_id client_secret] [flags]
``` ```
## Options ## Options

2
docs/content/commands/rclone_copyto.md
View File

@@ -36,6 +36,8 @@ This doesn't transfer files that are identical on src and dst, testing
by size and modification time or MD5SUM. It doesn't delete files from by size and modification time or MD5SUM. It doesn't delete files from
the destination. the destination.
*If you are looking to copy just a byte range of a file, please see 'rclone cat --offset X --count Y'*
**Note**: Use the `-P`/`--progress` flag to view real-time transfer statistics **Note**: Use the `-P`/`--progress` flag to view real-time transfer statistics

2
docs/content/commands/rclone_copyurl.md
View File

@@ -17,7 +17,7 @@ Setting `--auto-filename` will attempt to automatically determine the
filename from the URL (after any redirections) and used in the filename from the URL (after any redirections) and used in the
destination path. destination path.
With `--auto-filename-header` in addition, if a specific filename is With `--header-filename` in addition, if a specific filename is
set in HTTP headers, it will be used instead of the name from the URL. set in HTTP headers, it will be used instead of the name from the URL.
With `--print-filename` in addition, the resulting file name will be With `--print-filename` in addition, the resulting file name will be
printed. printed.

4
docs/content/commands/rclone_mount.md
View File

@@ -571,11 +571,11 @@ seconds. If rclone is quit or dies with files that haven't been
uploaded, these will be uploaded next time rclone is run with the same uploaded, these will be uploaded next time rclone is run with the same
flags. flags.
If using `--vfs-cache-max-size` or `--vfs-cache-min-free-size` note If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note
that the cache may exceed these quotas for two reasons. Firstly that the cache may exceed these quotas for two reasons. Firstly
because it is only checked every `--vfs-cache-poll-interval`. Secondly because it is only checked every `--vfs-cache-poll-interval`. Secondly
because open files cannot be evicted from the cache. When because open files cannot be evicted from the cache. When
`--vfs-cache-max-size` or `--vfs-cache-min-free-size` is exceeded, `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded,
rclone will attempt to evict the least accessed files from the cache rclone will attempt to evict the least accessed files from the cache
first. rclone will start with files that haven't been accessed for the first. rclone will start with files that haven't been accessed for the
longest. This cache flushing strategy is efficient and more relevant longest. This cache flushing strategy is efficient and more relevant

4
docs/content/commands/rclone_nfsmount.md
View File

@@ -572,11 +572,11 @@ seconds. If rclone is quit or dies with files that haven't been
uploaded, these will be uploaded next time rclone is run with the same uploaded, these will be uploaded next time rclone is run with the same
flags. flags.
If using `--vfs-cache-max-size` or `--vfs-cache-min-free-size` note If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note
that the cache may exceed these quotas for two reasons. Firstly that the cache may exceed these quotas for two reasons. Firstly
because it is only checked every `--vfs-cache-poll-interval`. Secondly because it is only checked every `--vfs-cache-poll-interval`. Secondly
because open files cannot be evicted from the cache. When because open files cannot be evicted from the cache. When
`--vfs-cache-max-size` or `--vfs-cache-min-free-size` is exceeded, `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded,
rclone will attempt to evict the least accessed files from the cache rclone will attempt to evict the least accessed files from the cache
first. rclone will start with files that haven't been accessed for the first. rclone will start with files that haven't been accessed for the
longest. This cache flushing strategy is efficient and more relevant longest. This cache flushing strategy is efficient and more relevant

4
docs/content/commands/rclone_serve_dlna.md
View File

@@ -134,11 +134,11 @@ seconds. If rclone is quit or dies with files that haven't been
uploaded, these will be uploaded next time rclone is run with the same uploaded, these will be uploaded next time rclone is run with the same
flags. flags.
If using `--vfs-cache-max-size` or `--vfs-cache-min-free-size` note If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note
that the cache may exceed these quotas for two reasons. Firstly that the cache may exceed these quotas for two reasons. Firstly
because it is only checked every `--vfs-cache-poll-interval`. Secondly because it is only checked every `--vfs-cache-poll-interval`. Secondly
because open files cannot be evicted from the cache. When because open files cannot be evicted from the cache. When
`--vfs-cache-max-size` or `--vfs-cache-min-free-size` is exceeded, `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded,
rclone will attempt to evict the least accessed files from the cache rclone will attempt to evict the least accessed files from the cache
first. rclone will start with files that haven't been accessed for the first. rclone will start with files that haven't been accessed for the
longest. This cache flushing strategy is efficient and more relevant longest. This cache flushing strategy is efficient and more relevant

4
docs/content/commands/rclone_serve_docker.md
View File

@@ -146,11 +146,11 @@ seconds. If rclone is quit or dies with files that haven't been
uploaded, these will be uploaded next time rclone is run with the same uploaded, these will be uploaded next time rclone is run with the same
flags. flags.
If using `--vfs-cache-max-size` or `--vfs-cache-min-free-size` note If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note
that the cache may exceed these quotas for two reasons. Firstly that the cache may exceed these quotas for two reasons. Firstly
because it is only checked every `--vfs-cache-poll-interval`. Secondly because it is only checked every `--vfs-cache-poll-interval`. Secondly
because open files cannot be evicted from the cache. When because open files cannot be evicted from the cache. When
`--vfs-cache-max-size` or `--vfs-cache-min-free-size` is exceeded, `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded,
rclone will attempt to evict the least accessed files from the cache rclone will attempt to evict the least accessed files from the cache
first. rclone will start with files that haven't been accessed for the first. rclone will start with files that haven't been accessed for the
longest. This cache flushing strategy is efficient and more relevant longest. This cache flushing strategy is efficient and more relevant

4
docs/content/commands/rclone_serve_ftp.md
View File

@@ -127,11 +127,11 @@ seconds. If rclone is quit or dies with files that haven't been
uploaded, these will be uploaded next time rclone is run with the same uploaded, these will be uploaded next time rclone is run with the same
flags. flags.
If using `--vfs-cache-max-size` or `--vfs-cache-min-free-size` note If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note
that the cache may exceed these quotas for two reasons. Firstly that the cache may exceed these quotas for two reasons. Firstly
because it is only checked every `--vfs-cache-poll-interval`. Secondly because it is only checked every `--vfs-cache-poll-interval`. Secondly
because open files cannot be evicted from the cache. When because open files cannot be evicted from the cache. When
`--vfs-cache-max-size` or `--vfs-cache-min-free-size` is exceeded, `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded,
rclone will attempt to evict the least accessed files from the cache rclone will attempt to evict the least accessed files from the cache
first. rclone will start with files that haven't been accessed for the first. rclone will start with files that haven't been accessed for the
longest. This cache flushing strategy is efficient and more relevant longest. This cache flushing strategy is efficient and more relevant

4
docs/content/commands/rclone_serve_http.md
View File

@@ -245,11 +245,11 @@ seconds. If rclone is quit or dies with files that haven't been
uploaded, these will be uploaded next time rclone is run with the same uploaded, these will be uploaded next time rclone is run with the same
flags. flags.
If using `--vfs-cache-max-size` or `--vfs-cache-min-free-size` note If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note
that the cache may exceed these quotas for two reasons. Firstly that the cache may exceed these quotas for two reasons. Firstly
because it is only checked every `--vfs-cache-poll-interval`. Secondly because it is only checked every `--vfs-cache-poll-interval`. Secondly
because open files cannot be evicted from the cache. When because open files cannot be evicted from the cache. When
`--vfs-cache-max-size` or `--vfs-cache-min-free-size` is exceeded, `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded,
rclone will attempt to evict the least accessed files from the cache rclone will attempt to evict the least accessed files from the cache
first. rclone will start with files that haven't been accessed for the first. rclone will start with files that haven't been accessed for the
longest. This cache flushing strategy is efficient and more relevant longest. This cache flushing strategy is efficient and more relevant

4
docs/content/commands/rclone_serve_nfs.md
View File

@@ -176,11 +176,11 @@ seconds. If rclone is quit or dies with files that haven't been
uploaded, these will be uploaded next time rclone is run with the same uploaded, these will be uploaded next time rclone is run with the same
flags. flags.
If using `--vfs-cache-max-size` or `--vfs-cache-min-free-size` note If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note
that the cache may exceed these quotas for two reasons. Firstly that the cache may exceed these quotas for two reasons. Firstly
because it is only checked every `--vfs-cache-poll-interval`. Secondly because it is only checked every `--vfs-cache-poll-interval`. Secondly
because open files cannot be evicted from the cache. When because open files cannot be evicted from the cache. When
`--vfs-cache-max-size` or `--vfs-cache-min-free-size` is exceeded, `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded,
rclone will attempt to evict the least accessed files from the cache rclone will attempt to evict the least accessed files from the cache
first. rclone will start with files that haven't been accessed for the first. rclone will start with files that haven't been accessed for the
longest. This cache flushing strategy is efficient and more relevant longest. This cache flushing strategy is efficient and more relevant

6
docs/content/commands/rclone_serve_s3.md
View File

@@ -27,7 +27,7 @@ docs](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html)).
access. access.
Please note that some clients may require HTTPS endpoints. See [the Please note that some clients may require HTTPS endpoints. See [the
SSL docs](#ssl-tls) for more information. SSL docs](#tls-ssl) for more information.
This command uses the [VFS directory cache](#vfs-virtual-file-system). This command uses the [VFS directory cache](#vfs-virtual-file-system).
All the functionality will work with `--vfs-cache-mode off`. Using All the functionality will work with `--vfs-cache-mode off`. Using
@@ -334,11 +334,11 @@ seconds. If rclone is quit or dies with files that haven't been
uploaded, these will be uploaded next time rclone is run with the same uploaded, these will be uploaded next time rclone is run with the same
flags. flags.
If using `--vfs-cache-max-size` or `--vfs-cache-min-free-size` note If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note
that the cache may exceed these quotas for two reasons. Firstly that the cache may exceed these quotas for two reasons. Firstly
because it is only checked every `--vfs-cache-poll-interval`. Secondly because it is only checked every `--vfs-cache-poll-interval`. Secondly
because open files cannot be evicted from the cache. When because open files cannot be evicted from the cache. When
`--vfs-cache-max-size` or `--vfs-cache-min-free-size` is exceeded, `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded,
rclone will attempt to evict the least accessed files from the cache rclone will attempt to evict the least accessed files from the cache
first. rclone will start with files that haven't been accessed for the first. rclone will start with files that haven't been accessed for the
longest. This cache flushing strategy is efficient and more relevant longest. This cache flushing strategy is efficient and more relevant

4
docs/content/commands/rclone_serve_sftp.md
View File

@@ -170,11 +170,11 @@ seconds. If rclone is quit or dies with files that haven't been
uploaded, these will be uploaded next time rclone is run with the same uploaded, these will be uploaded next time rclone is run with the same
flags. flags.
If using `--vfs-cache-max-size` or `--vfs-cache-min-free-size` note If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note
that the cache may exceed these quotas for two reasons. Firstly that the cache may exceed these quotas for two reasons. Firstly
because it is only checked every `--vfs-cache-poll-interval`. Secondly because it is only checked every `--vfs-cache-poll-interval`. Secondly
because open files cannot be evicted from the cache. When because open files cannot be evicted from the cache. When
`--vfs-cache-max-size` or `--vfs-cache-min-free-size` is exceeded, `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded,
rclone will attempt to evict the least accessed files from the cache rclone will attempt to evict the least accessed files from the cache
first. rclone will start with files that haven't been accessed for the first. rclone will start with files that haven't been accessed for the
longest. This cache flushing strategy is efficient and more relevant longest. This cache flushing strategy is efficient and more relevant

4
docs/content/commands/rclone_serve_webdav.md
View File

@@ -288,11 +288,11 @@ seconds. If rclone is quit or dies with files that haven't been
uploaded, these will be uploaded next time rclone is run with the same uploaded, these will be uploaded next time rclone is run with the same
flags. flags.
If using `--vfs-cache-max-size` or `--vfs-cache-min-free-size` note If using `--vfs-cache-max-size` or `--vfs-cache-min-free-space` note
that the cache may exceed these quotas for two reasons. Firstly that the cache may exceed these quotas for two reasons. Firstly
because it is only checked every `--vfs-cache-poll-interval`. Secondly because it is only checked every `--vfs-cache-poll-interval`. Secondly
because open files cannot be evicted from the cache. When because open files cannot be evicted from the cache. When
`--vfs-cache-max-size` or `--vfs-cache-min-free-size` is exceeded, `--vfs-cache-max-size` or `--vfs-cache-min-free-space` is exceeded,
rclone will attempt to evict the least accessed files from the cache rclone will attempt to evict the least accessed files from the cache
first. rclone will start with files that haven't been accessed for the first. rclone will start with files that haven't been accessed for the
longest. This cache flushing strategy is efficient and more relevant longest. This cache flushing strategy is efficient and more relevant

2
docs/content/flags.md
View File

@@ -116,7 +116,7 @@ Flags for general networking and HTTP stuff.
--tpslimit float Limit HTTP transactions per second to this --tpslimit float Limit HTTP transactions per second to this
--tpslimit-burst int Max burst of transactions for --tpslimit (default 1) --tpslimit-burst int Max burst of transactions for --tpslimit (default 1)
--use-cookies Enable session cookiejar --use-cookies Enable session cookiejar
--user-agent string Set the user-agent to a specified string (default "rclone/v1.69.1") --user-agent string Set the user-agent to a specified string (default "rclone/v1.69.2")
``` ```

2
docs/content/s3.md
View File

@@ -2175,7 +2175,7 @@ or from INTELLIGENT-TIERING Archive Access / Deep Archive Access tier to the Fre
Usage Examples: Usage Examples:
rclone backend restore s3:bucket/path/to/object -o priority=PRIORITY -o lifetime=DAYS rclone backend restore s3:bucket/path/to/ --include /object -o priority=PRIORITY -o lifetime=DAYS
rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY -o lifetime=DAYS rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY -o lifetime=DAYS
rclone backend restore s3:bucket -o priority=PRIORITY -o lifetime=DAYS rclone backend restore s3:bucket -o priority=PRIORITY -o lifetime=DAYS
rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY

221
rclone.1 generated
View File

@@ -1,7 +1,7 @@
.\"t .\"t
.\" Automatically generated by Pandoc 2.9.2.1 .\" Automatically generated by Pandoc 2.9.2.1
.\" .\"
.TH "rclone" "1" "Feb 14, 2025" "User Manual" "" .TH "rclone" "1" "May 01, 2025" "User Manual" ""
.hy .hy
.SH NAME .SH NAME
.PP .PP
@@ -3583,6 +3583,11 @@ Remote authorization.
Used to authorize a remote or headless rclone from a machine with a Used to authorize a remote or headless rclone from a machine with a
browser - use as instructed by rclone config. browser - use as instructed by rclone config.
.PP .PP
The command requires 1-3 arguments: - fs name (e.g., \[dq]drive\[dq],
\[dq]s3\[dq], etc.) - Either a base64 encoded JSON blob obtained from a
previous rclone config session - Or a client_id and client_secret pair
obtained from the remote service
.PP
Use --auth-no-open-browser to prevent rclone to open auth link in Use --auth-no-open-browser to prevent rclone to open auth link in
default browser automatically. default browser automatically.
.PP .PP
@@ -3592,7 +3597,7 @@ template is used.
.IP .IP
.nf .nf
\f[C] \f[C]
rclone authorize [flags] rclone authorize <fs name> [base64_json_blob | client_id client_secret] [flags]
\f[R] \f[R]
.fi .fi
.SS Options .SS Options
@@ -5211,6 +5216,9 @@ This doesn\[aq]t transfer files that are identical on src and dst,
testing by size and modification time or MD5SUM. testing by size and modification time or MD5SUM.
It doesn\[aq]t delete files from the destination. It doesn\[aq]t delete files from the destination.
.PP .PP
\f[I]If you are looking to copy just a byte range of a file, please see
\[aq]rclone cat --offset X --count Y\[aq]\f[R]
.PP
\f[B]Note\f[R]: Use the \f[C]-P\f[R]/\f[C]--progress\f[R] flag to view \f[B]Note\f[R]: Use the \f[C]-P\f[R]/\f[C]--progress\f[R] flag to view
real-time transfer statistics real-time transfer statistics
.IP .IP
@@ -5338,9 +5346,8 @@ Setting \f[C]--auto-filename\f[R] will attempt to automatically
determine the filename from the URL (after any redirections) and used in determine the filename from the URL (after any redirections) and used in
the destination path. the destination path.
.PP .PP
With \f[C]--auto-filename-header\f[R] in addition, if a specific With \f[C]--header-filename\f[R] in addition, if a specific filename is
filename is set in HTTP headers, it will be used instead of the name set in HTTP headers, it will be used instead of the name from the URL.
from the URL.
With \f[C]--print-filename\f[R] in addition, the resulting file name With \f[C]--print-filename\f[R] in addition, the resulting file name
will be printed. will be printed.
.PP .PP
@@ -7178,13 +7185,13 @@ If rclone is quit or dies with files that haven\[aq]t been uploaded,
these will be uploaded next time rclone is run with the same flags. these will be uploaded next time rclone is run with the same flags.
.PP .PP
If using \f[C]--vfs-cache-max-size\f[R] or If using \f[C]--vfs-cache-max-size\f[R] or
\f[C]--vfs-cache-min-free-size\f[R] note that the cache may exceed these \f[C]--vfs-cache-min-free-space\f[R] note that the cache may exceed
quotas for two reasons. these quotas for two reasons.
Firstly because it is only checked every Firstly because it is only checked every
\f[C]--vfs-cache-poll-interval\f[R]. \f[C]--vfs-cache-poll-interval\f[R].
Secondly because open files cannot be evicted from the cache. Secondly because open files cannot be evicted from the cache.
When \f[C]--vfs-cache-max-size\f[R] or When \f[C]--vfs-cache-max-size\f[R] or
\f[C]--vfs-cache-min-free-size\f[R] is exceeded, rclone will attempt to \f[C]--vfs-cache-min-free-space\f[R] is exceeded, rclone will attempt to
evict the least accessed files from the cache first. evict the least accessed files from the cache first.
rclone will start with files that haven\[aq]t been accessed for the rclone will start with files that haven\[aq]t been accessed for the
longest. longest.
@@ -8698,13 +8705,13 @@ If rclone is quit or dies with files that haven\[aq]t been uploaded,
these will be uploaded next time rclone is run with the same flags. these will be uploaded next time rclone is run with the same flags.
.PP .PP
If using \f[C]--vfs-cache-max-size\f[R] or If using \f[C]--vfs-cache-max-size\f[R] or
\f[C]--vfs-cache-min-free-size\f[R] note that the cache may exceed these \f[C]--vfs-cache-min-free-space\f[R] note that the cache may exceed
quotas for two reasons. these quotas for two reasons.
Firstly because it is only checked every Firstly because it is only checked every
\f[C]--vfs-cache-poll-interval\f[R]. \f[C]--vfs-cache-poll-interval\f[R].
Secondly because open files cannot be evicted from the cache. Secondly because open files cannot be evicted from the cache.
When \f[C]--vfs-cache-max-size\f[R] or When \f[C]--vfs-cache-max-size\f[R] or
\f[C]--vfs-cache-min-free-size\f[R] is exceeded, rclone will attempt to \f[C]--vfs-cache-min-free-space\f[R] is exceeded, rclone will attempt to
evict the least accessed files from the cache first. evict the least accessed files from the cache first.
rclone will start with files that haven\[aq]t been accessed for the rclone will start with files that haven\[aq]t been accessed for the
longest. longest.
@@ -10147,13 +10154,13 @@ If rclone is quit or dies with files that haven\[aq]t been uploaded,
these will be uploaded next time rclone is run with the same flags. these will be uploaded next time rclone is run with the same flags.
.PP .PP
If using \f[C]--vfs-cache-max-size\f[R] or If using \f[C]--vfs-cache-max-size\f[R] or
\f[C]--vfs-cache-min-free-size\f[R] note that the cache may exceed these \f[C]--vfs-cache-min-free-space\f[R] note that the cache may exceed
quotas for two reasons. these quotas for two reasons.
Firstly because it is only checked every Firstly because it is only checked every
\f[C]--vfs-cache-poll-interval\f[R]. \f[C]--vfs-cache-poll-interval\f[R].
Secondly because open files cannot be evicted from the cache. Secondly because open files cannot be evicted from the cache.
When \f[C]--vfs-cache-max-size\f[R] or When \f[C]--vfs-cache-max-size\f[R] or
\f[C]--vfs-cache-min-free-size\f[R] is exceeded, rclone will attempt to \f[C]--vfs-cache-min-free-space\f[R] is exceeded, rclone will attempt to
evict the least accessed files from the cache first. evict the least accessed files from the cache first.
rclone will start with files that haven\[aq]t been accessed for the rclone will start with files that haven\[aq]t been accessed for the
longest. longest.
@@ -10808,13 +10815,13 @@ If rclone is quit or dies with files that haven\[aq]t been uploaded,
these will be uploaded next time rclone is run with the same flags. these will be uploaded next time rclone is run with the same flags.
.PP .PP
If using \f[C]--vfs-cache-max-size\f[R] or If using \f[C]--vfs-cache-max-size\f[R] or
\f[C]--vfs-cache-min-free-size\f[R] note that the cache may exceed these \f[C]--vfs-cache-min-free-space\f[R] note that the cache may exceed
quotas for two reasons. these quotas for two reasons.
Firstly because it is only checked every Firstly because it is only checked every
\f[C]--vfs-cache-poll-interval\f[R]. \f[C]--vfs-cache-poll-interval\f[R].
Secondly because open files cannot be evicted from the cache. Secondly because open files cannot be evicted from the cache.
When \f[C]--vfs-cache-max-size\f[R] or When \f[C]--vfs-cache-max-size\f[R] or
\f[C]--vfs-cache-min-free-size\f[R] is exceeded, rclone will attempt to \f[C]--vfs-cache-min-free-space\f[R] is exceeded, rclone will attempt to
evict the least accessed files from the cache first. evict the least accessed files from the cache first.
rclone will start with files that haven\[aq]t been accessed for the rclone will start with files that haven\[aq]t been accessed for the
longest. longest.
@@ -11460,13 +11467,13 @@ If rclone is quit or dies with files that haven\[aq]t been uploaded,
these will be uploaded next time rclone is run with the same flags. these will be uploaded next time rclone is run with the same flags.
.PP .PP
If using \f[C]--vfs-cache-max-size\f[R] or If using \f[C]--vfs-cache-max-size\f[R] or
\f[C]--vfs-cache-min-free-size\f[R] note that the cache may exceed these \f[C]--vfs-cache-min-free-space\f[R] note that the cache may exceed
quotas for two reasons. these quotas for two reasons.
Firstly because it is only checked every Firstly because it is only checked every
\f[C]--vfs-cache-poll-interval\f[R]. \f[C]--vfs-cache-poll-interval\f[R].
Secondly because open files cannot be evicted from the cache. Secondly because open files cannot be evicted from the cache.
When \f[C]--vfs-cache-max-size\f[R] or When \f[C]--vfs-cache-max-size\f[R] or
\f[C]--vfs-cache-min-free-size\f[R] is exceeded, rclone will attempt to \f[C]--vfs-cache-min-free-space\f[R] is exceeded, rclone will attempt to
evict the least accessed files from the cache first. evict the least accessed files from the cache first.
rclone will start with files that haven\[aq]t been accessed for the rclone will start with files that haven\[aq]t been accessed for the
longest. longest.
@@ -12425,13 +12432,13 @@ If rclone is quit or dies with files that haven\[aq]t been uploaded,
these will be uploaded next time rclone is run with the same flags. these will be uploaded next time rclone is run with the same flags.
.PP .PP
If using \f[C]--vfs-cache-max-size\f[R] or If using \f[C]--vfs-cache-max-size\f[R] or
\f[C]--vfs-cache-min-free-size\f[R] note that the cache may exceed these \f[C]--vfs-cache-min-free-space\f[R] note that the cache may exceed
quotas for two reasons. these quotas for two reasons.
Firstly because it is only checked every Firstly because it is only checked every
\f[C]--vfs-cache-poll-interval\f[R]. \f[C]--vfs-cache-poll-interval\f[R].
Secondly because open files cannot be evicted from the cache. Secondly because open files cannot be evicted from the cache.
When \f[C]--vfs-cache-max-size\f[R] or When \f[C]--vfs-cache-max-size\f[R] or
\f[C]--vfs-cache-min-free-size\f[R] is exceeded, rclone will attempt to \f[C]--vfs-cache-min-free-space\f[R] is exceeded, rclone will attempt to
evict the least accessed files from the cache first. evict the least accessed files from the cache first.
rclone will start with files that haven\[aq]t been accessed for the rclone will start with files that haven\[aq]t been accessed for the
longest. longest.
@@ -13227,13 +13234,13 @@ If rclone is quit or dies with files that haven\[aq]t been uploaded,
these will be uploaded next time rclone is run with the same flags. these will be uploaded next time rclone is run with the same flags.
.PP .PP
If using \f[C]--vfs-cache-max-size\f[R] or If using \f[C]--vfs-cache-max-size\f[R] or
\f[C]--vfs-cache-min-free-size\f[R] note that the cache may exceed these \f[C]--vfs-cache-min-free-space\f[R] note that the cache may exceed
quotas for two reasons. these quotas for two reasons.
Firstly because it is only checked every Firstly because it is only checked every
\f[C]--vfs-cache-poll-interval\f[R]. \f[C]--vfs-cache-poll-interval\f[R].
Secondly because open files cannot be evicted from the cache. Secondly because open files cannot be evicted from the cache.
When \f[C]--vfs-cache-max-size\f[R] or When \f[C]--vfs-cache-max-size\f[R] or
\f[C]--vfs-cache-min-free-size\f[R] is exceeded, rclone will attempt to \f[C]--vfs-cache-min-free-space\f[R] is exceeded, rclone will attempt to
evict the least accessed files from the cache first. evict the least accessed files from the cache first.
rclone will start with files that haven\[aq]t been accessed for the rclone will start with files that haven\[aq]t been accessed for the
longest. longest.
@@ -14366,13 +14373,13 @@ If rclone is quit or dies with files that haven\[aq]t been uploaded,
these will be uploaded next time rclone is run with the same flags. these will be uploaded next time rclone is run with the same flags.
.PP .PP
If using \f[C]--vfs-cache-max-size\f[R] or If using \f[C]--vfs-cache-max-size\f[R] or
\f[C]--vfs-cache-min-free-size\f[R] note that the cache may exceed these \f[C]--vfs-cache-min-free-space\f[R] note that the cache may exceed
quotas for two reasons. these quotas for two reasons.
Firstly because it is only checked every Firstly because it is only checked every
\f[C]--vfs-cache-poll-interval\f[R]. \f[C]--vfs-cache-poll-interval\f[R].
Secondly because open files cannot be evicted from the cache. Secondly because open files cannot be evicted from the cache.
When \f[C]--vfs-cache-max-size\f[R] or When \f[C]--vfs-cache-max-size\f[R] or
\f[C]--vfs-cache-min-free-size\f[R] is exceeded, rclone will attempt to \f[C]--vfs-cache-min-free-space\f[R] is exceeded, rclone will attempt to
evict the least accessed files from the cache first. evict the least accessed files from the cache first.
rclone will start with files that haven\[aq]t been accessed for the rclone will start with files that haven\[aq]t been accessed for the
longest. longest.
@@ -15072,13 +15079,13 @@ If rclone is quit or dies with files that haven\[aq]t been uploaded,
these will be uploaded next time rclone is run with the same flags. these will be uploaded next time rclone is run with the same flags.
.PP .PP
If using \f[C]--vfs-cache-max-size\f[R] or If using \f[C]--vfs-cache-max-size\f[R] or
\f[C]--vfs-cache-min-free-size\f[R] note that the cache may exceed these \f[C]--vfs-cache-min-free-space\f[R] note that the cache may exceed
quotas for two reasons. these quotas for two reasons.
Firstly because it is only checked every Firstly because it is only checked every
\f[C]--vfs-cache-poll-interval\f[R]. \f[C]--vfs-cache-poll-interval\f[R].
Secondly because open files cannot be evicted from the cache. Secondly because open files cannot be evicted from the cache.
When \f[C]--vfs-cache-max-size\f[R] or When \f[C]--vfs-cache-max-size\f[R] or
\f[C]--vfs-cache-min-free-size\f[R] is exceeded, rclone will attempt to \f[C]--vfs-cache-min-free-space\f[R] is exceeded, rclone will attempt to
evict the least accessed files from the cache first. evict the least accessed files from the cache first.
rclone will start with files that haven\[aq]t been accessed for the rclone will start with files that haven\[aq]t been accessed for the
longest. longest.
@@ -16090,13 +16097,13 @@ If rclone is quit or dies with files that haven\[aq]t been uploaded,
these will be uploaded next time rclone is run with the same flags. these will be uploaded next time rclone is run with the same flags.
.PP .PP
If using \f[C]--vfs-cache-max-size\f[R] or If using \f[C]--vfs-cache-max-size\f[R] or
\f[C]--vfs-cache-min-free-size\f[R] note that the cache may exceed these \f[C]--vfs-cache-min-free-space\f[R] note that the cache may exceed
quotas for two reasons. these quotas for two reasons.
Firstly because it is only checked every Firstly because it is only checked every
\f[C]--vfs-cache-poll-interval\f[R]. \f[C]--vfs-cache-poll-interval\f[R].
Secondly because open files cannot be evicted from the cache. Secondly because open files cannot be evicted from the cache.
When \f[C]--vfs-cache-max-size\f[R] or When \f[C]--vfs-cache-max-size\f[R] or
\f[C]--vfs-cache-min-free-size\f[R] is exceeded, rclone will attempt to \f[C]--vfs-cache-min-free-space\f[R] is exceeded, rclone will attempt to
evict the least accessed files from the cache first. evict the least accessed files from the cache first.
rclone will start with files that haven\[aq]t been accessed for the rclone will start with files that haven\[aq]t been accessed for the
longest. longest.
@@ -28524,7 +28531,7 @@ Flags for general networking and HTTP stuff.
--tpslimit float Limit HTTP transactions per second to this --tpslimit float Limit HTTP transactions per second to this
--tpslimit-burst int Max burst of transactions for --tpslimit (default 1) --tpslimit-burst int Max burst of transactions for --tpslimit (default 1)
--use-cookies Enable session cookiejar --use-cookies Enable session cookiejar
--user-agent string Set the user-agent to a specified string (default \[dq]rclone/v1.69.1\[dq]) --user-agent string Set the user-agent to a specified string (default \[dq]rclone/v1.69.2\[dq])
\f[R] \f[R]
.fi .fi
.SS Performance .SS Performance
@@ -29571,7 +29578,7 @@ should be installed on host:
.IP .IP
.nf .nf
\f[C] \f[C]
sudo apt-get -y install fuse sudo apt-get -y install fuse3
\f[R] \f[R]
.fi .fi
.PP .PP
@@ -34410,7 +34417,8 @@ error like below.
.PP .PP
In this case you need to In this case you need to
restore (http://docs.aws.amazon.com/AmazonS3/latest/user-guide/restore-archived-objects.html) restore (http://docs.aws.amazon.com/AmazonS3/latest/user-guide/restore-archived-objects.html)
the object(s) in question before using rclone. the object(s) in question before accessing object contents.
The restore section below shows how to do this with rclone.
.PP .PP
Note that rclone only speaks the S3 API it does not speak the Glacier Note that rclone only speaks the S3 API it does not speak the Glacier
Vault API, so rclone cannot directly access Glacier Vaults. Vault API, so rclone cannot directly access Glacier Vaults.
@@ -36691,7 +36699,7 @@ Usage Examples:
.IP .IP
.nf .nf
\f[C] \f[C]
rclone backend restore s3:bucket/path/to/object -o priority=PRIORITY -o lifetime=DAYS rclone backend restore s3:bucket/path/to/ --include /object -o priority=PRIORITY -o lifetime=DAYS
rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY -o lifetime=DAYS rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY -o lifetime=DAYS
rclone backend restore s3:bucket -o priority=PRIORITY -o lifetime=DAYS rclone backend restore s3:bucket -o priority=PRIORITY -o lifetime=DAYS
rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY
@@ -41752,8 +41760,8 @@ Note that rclone runs a webserver on your local machine to collect the
token as returned from Box. token as returned from Box.
This only runs from the moment it opens your browser to the moment you This only runs from the moment it opens your browser to the moment you
get back the verification code. get back the verification code.
This is on \f[C]http://127.0.0.1:53682/\f[R] and this it may require you This is on \f[C]http://127.0.0.1:53682/\f[R] and this may require you to
to unblock it temporarily if you are running a host firewall. unblock it temporarily if you are running a host firewall.
.PP .PP
Once configured you can then use \f[C]rclone\f[R] like this, Once configured you can then use \f[C]rclone\f[R] like this,
.PP .PP
@@ -70151,7 +70159,8 @@ Required: false
On some SFTP servers (e.g. On some SFTP servers (e.g.
Synology) the paths are different for SSH and SFTP so the hashes Synology) the paths are different for SSH and SFTP so the hashes
can\[aq]t be calculated properly. can\[aq]t be calculated properly.
For them using \f[C]disable_hashcheck\f[R] is a good idea. You can either use \f[C]--sftp-path-override\f[R] or
\f[C]disable_hashcheck\f[R].
.PP .PP
The only ssh agent supported under Windows is Putty\[aq]s pageant. The only ssh agent supported under Windows is Putty\[aq]s pageant.
.PP .PP
@@ -75039,6 +75048,124 @@ Options:
.IP \[bu] 2 .IP \[bu] 2
\[dq]error\[dq]: return an error based on option value \[dq]error\[dq]: return an error based on option value
.SH Changelog .SH Changelog
.SS v1.69.2 - 2025-05-01
.PP
See commits (https://github.com/rclone/rclone/compare/v1.69.1...v1.69.2)
.IP \[bu] 2
Bug fixes
.RS 2
.IP \[bu] 2
accounting: Fix percentDiff calculation -- (Anagh Kumar Baranwal)
.IP \[bu] 2
build
.RS 2
.IP \[bu] 2
Update github.com/golang-jwt/jwt/v4 from 4.5.1 to 4.5.2 to fix
CVE-2025-30204 (dependabot[bot])
.IP \[bu] 2
Update github.com/golang-jwt/jwt/v5 from 5.2.1 to 5.2.2 to fix
CVE-2025-30204 (dependabot[bot])
.IP \[bu] 2
Update golang.org/x/crypto to v0.35.0 to fix CVE-2025-22869 (Nick
Craig-Wood)
.IP \[bu] 2
Update golang.org/x/net from 0.36.0 to 0.38.0 to fix CVE-2025-22870
(dependabot[bot])
.IP \[bu] 2
Update golang.org/x/net to 0.36.0.
to fix CVE-2025-22869 (dependabot[bot])
.IP \[bu] 2
Stop building with go < go1.23 as security updates forbade it (Nick
Craig-Wood)
.IP \[bu] 2
Fix docker plugin build (Anagh Kumar Baranwal)
.RE
.IP \[bu] 2
cmd: Fix crash if rclone is invoked without any arguments (Janne
Hellsten)
.IP \[bu] 2
config: Read configuration passwords from stdin even when terminated
with EOF (Samantha Bowen)
.IP \[bu] 2
doc fixes (Andrew Kreimer, Danny Garside, eccoisle, Ed Craig-Wood,
emyarod, jack, Jugal Kishore, Markus Gerstel, Michael Kebe, Nick
Craig-Wood, simonmcnair, simwai, Zachary Vorhies)
.IP \[bu] 2
fs: Fix corruption of SizeSuffix with \[dq]B\[dq] suffix in config (eg
--min-size) (Nick Craig-Wood)
.IP \[bu] 2
lib/http: Fix race between Serve() and Shutdown() (Nick Craig-Wood)
.IP \[bu] 2
object: Fix memory object out of bounds Seek (Nick Craig-Wood)
.IP \[bu] 2
operations: Fix call fmt.Errorf with wrong err (alingse)
.IP \[bu] 2
rc
.RS 2
.IP \[bu] 2
Disable the metrics server when running \f[C]rclone rc\f[R]
(hiddenmarten)
.IP \[bu] 2
Fix debug/* commands not being available over unix sockets (Nick
Craig-Wood)
.RE
.IP \[bu] 2
serve nfs: Fix unlikely crash (Nick Craig-Wood)
.IP \[bu] 2
stats: Fix the speed not getting updated after a pause in the processing
(Anagh Kumar Baranwal)
.IP \[bu] 2
sync
.RS 2
.IP \[bu] 2
Fix cpu spinning when empty directory finding with leading slashes (Nick
Craig-Wood)
.IP \[bu] 2
Copy dir modtimes even when copyEmptySrcDirs is false (ll3006)
.RE
.RE
.IP \[bu] 2
VFS
.RS 2
.IP \[bu] 2
Fix directory cache serving stale data (Lorenz Brun)
.IP \[bu] 2
Fix inefficient directory caching when directory reads are slow
(huanghaojun)
.IP \[bu] 2
Fix integration test failures (Nick Craig-Wood)
.RE
.IP \[bu] 2
Drive
.RS 2
.IP \[bu] 2
Metadata: fix error when setting copy-requires-writer-permission on a
folder (Nick Craig-Wood)
.RE
.IP \[bu] 2
Dropbox
.RS 2
.IP \[bu] 2
Retry link without expiry (Dave Vasilevsky)
.RE
.IP \[bu] 2
HTTP
.RS 2
.IP \[bu] 2
Correct root if definitely pointing to a file (nielash)
.RE
.IP \[bu] 2
Iclouddrive
.RS 2
.IP \[bu] 2
Fix so created files are writable (Ben Alex)
.RE
.IP \[bu] 2
Onedrive
.RS 2
.IP \[bu] 2
Fix metadata ordering in permissions (Nick Craig-Wood)
.RE
.SS v1.69.1 - 2025-02-14 .SS v1.69.1 - 2025-02-14
.PP .PP
See commits (https://github.com/rclone/rclone/compare/v1.69.0...v1.69.1) See commits (https://github.com/rclone/rclone/compare/v1.69.0...v1.69.1)
@@ -75183,7 +75310,7 @@ in http servers (Moises Lima)
.IP \[bu] 2 .IP \[bu] 2
This was making it impossible to use unix sockets with an proxy This was making it impossible to use unix sockets with an proxy
.IP \[bu] 2 .IP \[bu] 2
This might now cause rclone to need authenticaton where it didn\[aq]t This might now cause rclone to need authentication where it didn\[aq]t
before before
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
@@ -77109,8 +77236,8 @@ Refactor version info and icon resource handling on windows (albertony)
doc updates (albertony, alfish2000, asdffdsazqqq, Dimitri Papadopoulos, doc updates (albertony, alfish2000, asdffdsazqqq, Dimitri Papadopoulos,
Herby Gillot, Joda St\[:o]\[ss]er, Manoj Ghosh, Nick Craig-Wood) Herby Gillot, Joda St\[:o]\[ss]er, Manoj Ghosh, Nick Craig-Wood)
.IP \[bu] 2 .IP \[bu] 2
Implement \f[C]--metadata-mapper\f[R] to transform metatadata with a Implement \f[C]--metadata-mapper\f[R] to transform metadata with a user
user supplied program (Nick Craig-Wood) supplied program (Nick Craig-Wood)
.IP \[bu] 2 .IP \[bu] 2
Add \f[C]ChunkWriterDoesntSeek\f[R] feature flag and set it for b2 (Nick Add \f[C]ChunkWriterDoesntSeek\f[R] feature flag and set it for b2 (Nick
Craig-Wood) Craig-Wood)
@@ -77430,7 +77557,7 @@ B2
Fix multipart upload: corrupted on transfer: sizes differ XXX vs 0 (Nick Fix multipart upload: corrupted on transfer: sizes differ XXX vs 0 (Nick
Craig-Wood) Craig-Wood)
.IP \[bu] 2 .IP \[bu] 2
Fix locking window when getting mutipart upload URL (Nick Craig-Wood) Fix locking window when getting multipart upload URL (Nick Craig-Wood)
.IP \[bu] 2 .IP \[bu] 2
Fix server side copies greater than 4GB (Nick Craig-Wood) Fix server side copies greater than 4GB (Nick Craig-Wood)
.IP \[bu] 2 .IP \[bu] 2
@@ -91986,8 +92113,6 @@ Eli Orzitzer <e_orz@yahoo.com>
.IP \[bu] 2 .IP \[bu] 2
Anthony Metzidis <anthony.metzidis@gmail.com> Anthony Metzidis <anthony.metzidis@gmail.com>
.IP \[bu] 2 .IP \[bu] 2
emyarod <afw5059@gmail.com>
.IP \[bu] 2
keongalvin <keongalvin@gmail.com> keongalvin <keongalvin@gmail.com>
.IP \[bu] 2 .IP \[bu] 2
rarspace01 <rarspace01@users.noreply.github.com> rarspace01 <rarspace01@users.noreply.github.com>