mirror of
https://github.com/rclone/rclone.git
synced 2025-01-10 08:18:27 +01:00
Version v1.52.1
This commit is contained in:
parent
f9493ff1db
commit
31dc78905e
124
MANUAL.html
generated
124
MANUAL.html
generated
@ -5,7 +5,6 @@
|
||||
<meta name="generator" content="pandoc" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
|
||||
<meta name="author" content="Nick Craig-Wood" />
|
||||
<meta name="dcterms.date" content="2020-05-27" />
|
||||
<title>rclone(1) User Manual</title>
|
||||
<style type="text/css">
|
||||
code{white-space: pre-wrap;}
|
||||
@ -18,31 +17,31 @@
|
||||
<header id="title-block-header">
|
||||
<h1 class="title">rclone(1) User Manual</h1>
|
||||
<p class="author">Nick Craig-Wood</p>
|
||||
<p class="date">May 27, 2020</p>
|
||||
<p class="date">Jun 10, 2020</p>
|
||||
</header>
|
||||
<h1 id="rclone-syncs-your-files-to-cloud-storage">Rclone syncs your files to cloud storage</h1>
|
||||
<p><img width="50%" src="https://rclone.org/img/logo_on_light__horizontal_color.svg" alt="rclone logo" style="float:right; padding: 5px;" ></p>
|
||||
<ul>
|
||||
<li><a href="#about">About rclone</a></li>
|
||||
<li><a href="#what">What can rclone do for you</a></li>
|
||||
<li><a href="#features">What features does rclone have</a></li>
|
||||
<li><a href="#providers">What providers does rclone support</a></li>
|
||||
<li><a href="#what">What can rclone do for you?</a></li>
|
||||
<li><a href="#features">What features does rclone have?</a></li>
|
||||
<li><a href="#providers">What providers does rclone support?</a></li>
|
||||
<li><a href="https://rclone.org/downloads/">Download</a></li>
|
||||
<li><a href="https://rclone.org/install/">Install</a></li>
|
||||
<li><a href="https://rclone.org/donate/">Donate.</a></li>
|
||||
</ul>
|
||||
<h2 id="about">About rclone</h2>
|
||||
<p>Rclone is a command line program to manage files on cloud storage. It is a feature rich alternative to cloud vendors’ web storage interfaces. <a href="#providers">Over 40 cloud storage products</a> support rclone including S3 object stores, business & consumer file storage services, as well as standard transfer protocols.</p>
|
||||
<p>Rclone has powerful cloud equivalents to the unix commands rsync, cp, mv, mount, ls, ncdu, tree, rm, and cat. Rclone’s familiar syntax includes shell pipeline support, and <code>--dry-run</code> protection. It can be used at the command line, in scripts or via its <a href="/rc">API</a>.</p>
|
||||
<p>Users have called rclone <em>“The Swiss army knife of cloud storage”</em> and <em>“Technology indistinguishable from magic”</em>.</p>
|
||||
<p>Rclone really looks after your data. It preserves timestamps and verifies your data at all times. Transfers over limited bandwidth; intermittent connections, or subject to quota can be restarted, from the last good file transferred. You can <a href="https://rclone.org/commands/rclone_check/">check</a> the integrity of your files. Where possible, rclone employs server side transfers to minimise local bandwidth use and transfers from one provider to another without using your local disk.</p>
|
||||
<p>Rclone has powerful cloud equivalents to the unix commands rsync, cp, mv, mount, ls, ncdu, tree, rm, and cat. Rclone’s familiar syntax includes shell pipeline support, and <code>--dry-run</code> protection. It is used at the command line, in scripts or via its <a href="/rc">API</a>.</p>
|
||||
<p>Users call rclone <em>“The Swiss army knife of cloud storage”</em>, and <em>“Technology indistinguishable from magic”</em>.</p>
|
||||
<p>Rclone really looks after your data. It preserves timestamps and verifies checksums at all times. Transfers over limited bandwidth; intermittent connections, or subject to quota can be restarted, from the last good file transferred. You can <a href="https://rclone.org/commands/rclone_check/">check</a> the integrity of your files. Where possible, rclone employs server side transfers to minimise local bandwidth use and transfers from one provider to another without using local disk.</p>
|
||||
<p>Virtual backends wrap local and cloud file systems to apply <a href="https://rclone.org/crypt/">encryption</a>, <a href="https://rclone.org/cache/">caching</a>, <a href="https://rclone.org/chunker/">chunking</a> and <a href="https://rclone.org/union/">joining</a>.</p>
|
||||
<p>Rclone can <a href="https://rclone.org/commands/rclone_mount/">mount</a> any local, cloud or virtual filesystem as a disk on Windows, macOS, linux and FreeBSD, and also serve these over <a href="https://rclone.org/commands/rclone_serve_sftp/">SFTP</a>, <a href="https://rclone.org/commands/rclone_serve_http/">HTTP</a>, <a href="https://rclone.org/commands/rclone_serve_webdav/">WebDAV</a>, <a href="https://rclone.org/commands/rclone_serve_ftp/">FTP</a> and <a href="https://rclone.org/commands/rclone_serve_dlna/">DLNA</a>.</p>
|
||||
<p>Rclone <a href="https://rclone.org/commands/rclone_mount/">mounts</a> any local, cloud or virtual filesystem as a disk on Windows, macOS, linux and FreeBSD, and also serves these over <a href="https://rclone.org/commands/rclone_serve_sftp/">SFTP</a>, <a href="https://rclone.org/commands/rclone_serve_http/">HTTP</a>, <a href="https://rclone.org/commands/rclone_serve_webdav/">WebDAV</a>, <a href="https://rclone.org/commands/rclone_serve_ftp/">FTP</a> and <a href="https://rclone.org/commands/rclone_serve_dlna/">DLNA</a>.</p>
|
||||
<p>Rclone is mature, open source software originally inspired by rsync and written in <a href="https://golang.org">Go</a>. The friendly support community are familiar with varied use cases. Official Ubuntu, Debian, Fedora, Brew and Chocolatey repos. include rclone. For the latest version <a href="https://rclone.org/downloads/">downloading from rclone.org</a> is recommended.</p>
|
||||
<p>Rclone is widely used on Linux, Windows and Mac. Third party developers have built innovative backup, restore, GUI and business process solutions using the rclone command line or API.</p>
|
||||
<p>Let rclone do the heavy lifting of communicating with cloud storage.</p>
|
||||
<h2 id="what">What can rclone do for you</h2>
|
||||
<p>Rclone can help you:</p>
|
||||
<p>Rclone is widely used on Linux, Windows and Mac. Third party developers create innovative backup, restore, GUI and business process solutions using the rclone command line or API.</p>
|
||||
<p>Rclone does the heavy lifting of communicating with cloud storage.</p>
|
||||
<h2 id="what">What can rclone do for you?</h2>
|
||||
<p>Rclone helps you:</p>
|
||||
<ul>
|
||||
<li>Backup (and encrypt) files to cloud storage</li>
|
||||
<li>Restore (and decrypt) files from cloud storage</li>
|
||||
@ -71,7 +70,7 @@
|
||||
<li>Experimental <a href="https://rclone.org/gui/">Web based GUI</a></li>
|
||||
</ul>
|
||||
<h2 id="providers">Supported providers</h2>
|
||||
<p>(There are many other providers, built on standard protocols such as WebDAV or S3, that work out of the box.)</p>
|
||||
<p>(There are many others, built on standard protocols such as WebDAV or S3, that work out of the box.)</p>
|
||||
<ul>
|
||||
<li>1Fichier</li>
|
||||
<li>Alibaba Cloud (Aliyun) Object Storage System (OSS)</li>
|
||||
@ -1564,9 +1563,11 @@ if src is directory
|
||||
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li>
|
||||
</ul>
|
||||
<h1 id="rclone-obscure">rclone obscure</h1>
|
||||
<p>Obscure password for use in the rclone.conf</p>
|
||||
<p>Obscure password for use in the rclone config file</p>
|
||||
<h2 id="synopsis-52">Synopsis</h2>
|
||||
<p>Obscure password for use in the rclone.conf</p>
|
||||
<p>In the rclone config file, human readable passwords are obscured. Obscuring them is done by encrypting them and writing them out in base64. This is <strong>not</strong> a secure way of encrypting these passwords as rclone can decrypt them - it is to prevent “eyedropping” - namely someone seeing a password in the rclone config file by accident.</p>
|
||||
<p>Many equally important things (like access tokens) are not obscured in the config file. However it is very hard to shoulder surf a 64 character hex token.</p>
|
||||
<p>If you want to encrypt the config file then please use config file encryption - see <a href="https://rclone.org/commands/rclone_config/">rclone config</a> for more info.</p>
|
||||
<pre><code>rclone obscure password [flags]</code></pre>
|
||||
<h2 id="options-52">Options</h2>
|
||||
<pre><code> -h, --help help for obscure</code></pre>
|
||||
@ -5865,7 +5866,7 @@ Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
|
||||
--use-json-log Use json log format.
|
||||
--use-mmap Use mmap allocator (see docs).
|
||||
--use-server-modtime Use server modified time instead of object metadata
|
||||
--user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.52.0")
|
||||
--user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.52.1")
|
||||
-v, --verbose count Print lots more stuff (repeat for more)</code></pre>
|
||||
<h2 id="backend-flags">Backend Flags</h2>
|
||||
<p>These flags are available for every command. They control the backends and may be set in the config file.</p>
|
||||
@ -5920,7 +5921,7 @@ Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
|
||||
--cache-db-wait-time Duration How long to wait for the DB to be available - 0 is unlimited (default 1s)
|
||||
--cache-info-age Duration How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
|
||||
--cache-plex-insecure string Skip all certificate verification when connecting to the Plex server
|
||||
--cache-plex-password string The password of the Plex user
|
||||
--cache-plex-password string The password of the Plex user (obscured)
|
||||
--cache-plex-url string The URL of the Plex server
|
||||
--cache-plex-username string The username of the Plex user
|
||||
--cache-read-retries int How many times to retry a read from a cache storage. (default 10)
|
||||
@ -5940,8 +5941,8 @@ Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
|
||||
-L, --copy-links Follow symlinks and copy the pointed to item.
|
||||
--crypt-directory-name-encryption Option to either encrypt directory names or leave them intact. (default true)
|
||||
--crypt-filename-encryption string How to encrypt the filenames. (default "standard")
|
||||
--crypt-password string Password or pass phrase for encryption.
|
||||
--crypt-password2 string Password or pass phrase for salt. Optional but recommended.
|
||||
--crypt-password string Password or pass phrase for encryption. (obscured)
|
||||
--crypt-password2 string Password or pass phrase for salt. Optional but recommended. (obscured)
|
||||
--crypt-remote string Remote to encrypt/decrypt.
|
||||
--crypt-show-mapping For all files listed show how the names encrypt.
|
||||
--drive-acknowledge-abuse Set to allow files which return cannotDownloadAbusiveFile to be downloaded.
|
||||
@ -5992,7 +5993,7 @@ Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
|
||||
--ftp-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,RightSpace,Dot)
|
||||
--ftp-host string FTP host to connect to
|
||||
--ftp-no-check-certificate Do not verify the TLS certificate of the server
|
||||
--ftp-pass string FTP password
|
||||
--ftp-pass string FTP password (obscured)
|
||||
--ftp-port string FTP port, leave blank to use default (21)
|
||||
--ftp-tls Use FTP over TLS (Implicit)
|
||||
--ftp-user string FTP username, leave blank for current username, $USER
|
||||
@ -6029,7 +6030,7 @@ Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
|
||||
--koofr-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||
--koofr-endpoint string The Koofr API endpoint to use (default "https://app.koofr.net")
|
||||
--koofr-mountid string Mount ID of the mount to use. If omitted, the primary mount is used.
|
||||
--koofr-password string Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password)
|
||||
--koofr-password string Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password) (obscured)
|
||||
--koofr-setmtime Does the backend support setting modification time. Set this to false if you use a mount ID that points to a Dropbox or Amazon Drive backend. (default true)
|
||||
--koofr-user string Your Koofr user name
|
||||
-l, --links Translate symlinks to/from regular files with a '.rclonelink' extension
|
||||
@ -6042,7 +6043,7 @@ Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
|
||||
--local-nounc string Disable UNC (long path names) conversion on Windows
|
||||
--mailru-check-hash What should copy do if file checksum is mismatched or invalid (default true)
|
||||
--mailru-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||
--mailru-pass string Password
|
||||
--mailru-pass string Password (obscured)
|
||||
--mailru-speedup-enable Skip full upload if there is another file with same data hash. (default true)
|
||||
--mailru-speedup-file-patterns string Comma separated list of file name patterns eligible for speedup (put by hash). (default "*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf")
|
||||
--mailru-speedup-max-disk SizeSuffix This option allows you to disable speedup (put by hash) for large files (default 3G)
|
||||
@ -6051,7 +6052,7 @@ Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
|
||||
--mega-debug Output more debug from Mega.
|
||||
--mega-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot)
|
||||
--mega-hard-delete Delete files permanently rather than putting them into the trash.
|
||||
--mega-pass string Password.
|
||||
--mega-pass string Password. (obscured)
|
||||
--mega-user string User name
|
||||
-x, --one-file-system Don't cross filesystem boundaries (unix/macOS only).
|
||||
--onedrive-chunk-size SizeSuffix Chunk size to upload files with - must be multiple of 320k (327,680 bytes). (default 10M)
|
||||
@ -6064,7 +6065,7 @@ Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
|
||||
--onedrive-server-side-across-configs Allow server side operations (eg copy) to work across different onedrive configs.
|
||||
--opendrive-chunk-size SizeSuffix Files will be uploaded in chunks this size. (default 10M)
|
||||
--opendrive-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot)
|
||||
--opendrive-password string Password.
|
||||
--opendrive-password string Password. (obscured)
|
||||
--opendrive-username string Username
|
||||
--pcloud-client-id string Pcloud App Client Id
|
||||
--pcloud-client-secret string Pcloud App Client Secret
|
||||
@ -6115,19 +6116,19 @@ Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
|
||||
--seafile-create-library Should rclone create a library if it doesn't exist
|
||||
--seafile-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8)
|
||||
--seafile-library string Name of the library. Leave blank to access all non-encrypted libraries.
|
||||
--seafile-library-key string Library password (for encrypted libraries only). Leave blank if you pass it through the command line.
|
||||
--seafile-pass string Password
|
||||
--seafile-library-key string Library password (for encrypted libraries only). Leave blank if you pass it through the command line. (obscured)
|
||||
--seafile-pass string Password (obscured)
|
||||
--seafile-url string URL of seafile host to connect to
|
||||
--seafile-user string User name (usually email address)
|
||||
--sftp-ask-password Allow asking for SFTP password when needed.
|
||||
--sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available.
|
||||
--sftp-host string SSH host to connect to
|
||||
--sftp-key-file string Path to PEM-encoded private key file, leave blank or set key-use-agent to use ssh-agent.
|
||||
--sftp-key-file-pass string The passphrase to decrypt the PEM-encoded private key file.
|
||||
--sftp-key-file-pass string The passphrase to decrypt the PEM-encoded private key file. (obscured)
|
||||
--sftp-key-pem string Raw PEM-encoded private key, If specified, will override key_file parameter.
|
||||
--sftp-key-use-agent When set forces the usage of the ssh-agent.
|
||||
--sftp-md5sum-command string The command used to read md5 hashes. Leave blank for autodetect.
|
||||
--sftp-pass string SSH password, leave blank to use ssh-agent.
|
||||
--sftp-pass string SSH password, leave blank to use ssh-agent. (obscured)
|
||||
--sftp-path-override string Override path used by SSH connection.
|
||||
--sftp-port string SSH port, leave blank to use default (22)
|
||||
--sftp-set-modtime Set the modified time on the remote if set. (default true)
|
||||
@ -6185,7 +6186,7 @@ Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
|
||||
--union-upstreams string List of space separated upstreams.
|
||||
--webdav-bearer-token string Bearer token instead of user/pass (eg a Macaroon)
|
||||
--webdav-bearer-token-command string Command to run to get a bearer token
|
||||
--webdav-pass string Password.
|
||||
--webdav-pass string Password. (obscured)
|
||||
--webdav-url string URL of http host to connect to
|
||||
--webdav-user string User name
|
||||
--webdav-vendor string Name of the Webdav site/service/software you are using
|
||||
@ -9304,6 +9305,7 @@ chunk_total_size = 10G</code></pre>
|
||||
</ul>
|
||||
<h4 id="cache-plex-password">–cache-plex-password</h4>
|
||||
<p>The password of the Plex user</p>
|
||||
<p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p>
|
||||
<ul>
|
||||
<li>Config: plex_password</li>
|
||||
<li>Env Var: RCLONE_CACHE_PLEX_PASSWORD</li>
|
||||
@ -10195,6 +10197,7 @@ $ rclone -q ls secret:
|
||||
</ul>
|
||||
<h4 id="crypt-password">–crypt-password</h4>
|
||||
<p>Password or pass phrase for encryption.</p>
|
||||
<p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p>
|
||||
<ul>
|
||||
<li>Config: password</li>
|
||||
<li>Env Var: RCLONE_CRYPT_PASSWORD</li>
|
||||
@ -10203,6 +10206,7 @@ $ rclone -q ls secret:
|
||||
</ul>
|
||||
<h4 id="crypt-password2">–crypt-password2</h4>
|
||||
<p>Password or pass phrase for salt. Optional but recommended. Should be different to the previous password.</p>
|
||||
<p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p>
|
||||
<ul>
|
||||
<li>Config: password2</li>
|
||||
<li>Env Var: RCLONE_CRYPT_PASSWORD2</li>
|
||||
@ -10621,6 +10625,7 @@ y/e/d> y</code></pre>
|
||||
</ul>
|
||||
<h4 id="ftp-pass">–ftp-pass</h4>
|
||||
<p>FTP password</p>
|
||||
<p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p>
|
||||
<ul>
|
||||
<li>Config: pass</li>
|
||||
<li>Env Var: RCLONE_FTP_PASS</li>
|
||||
@ -11379,7 +11384,7 @@ trashed=false and 'c' in parents</code></pre>
|
||||
<li>When deleting with <code>rclone rmdir</code> or <code>rclone purge</code> the shortcut is deleted not the linked folder.</li>
|
||||
<li><strong>NB</strong> When deleting with <code>rclone remove</code> or <code>rclone mount</code> the contents of the linked folder will be deleted.</li>
|
||||
</ul>
|
||||
<p>It isn’t currently possible to create shortcuts with rclone.</p>
|
||||
<p>The <a href="https://rclone.org/commands/rclone_backend/">rclone backend</a> command can be used to create shortcuts.</p>
|
||||
<p>Shortcuts can be completely ignored with the <code>--drive-skip-shortcuts</code> flag or the corresponding <code>skip_shortcuts</code> configuration setting.</p>
|
||||
<h3 id="emptying-trash">Emptying trash</h3>
|
||||
<p>If you wish to empty your trash you can use the <code>rclone cleanup remote:</code> command which will permanently delete all your trashed files. This command does not take any path arguments.</p>
|
||||
@ -12776,6 +12781,7 @@ y/e/d> y</code></pre>
|
||||
</ul>
|
||||
<h4 id="koofr-password">–koofr-password</h4>
|
||||
<p>Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password)</p>
|
||||
<p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p>
|
||||
<ul>
|
||||
<li>Config: password</li>
|
||||
<li>Env Var: RCLONE_KOOFR_PASSWORD</li>
|
||||
@ -12976,6 +12982,7 @@ y/e/d> y</code></pre>
|
||||
</ul>
|
||||
<h4 id="mailru-pass">–mailru-pass</h4>
|
||||
<p>Password</p>
|
||||
<p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p>
|
||||
<ul>
|
||||
<li>Config: pass</li>
|
||||
<li>Env Var: RCLONE_MAILRU_PASS</li>
|
||||
@ -13223,6 +13230,7 @@ y/e/d> y</code></pre>
|
||||
</ul>
|
||||
<h4 id="mega-pass">–mega-pass</h4>
|
||||
<p>Password.</p>
|
||||
<p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p>
|
||||
<ul>
|
||||
<li>Config: pass</li>
|
||||
<li>Env Var: RCLONE_MEGA_PASS</li>
|
||||
@ -14022,6 +14030,7 @@ y/e/d> y</code></pre>
|
||||
</ul>
|
||||
<h4 id="opendrive-password">–opendrive-password</h4>
|
||||
<p>Password.</p>
|
||||
<p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p>
|
||||
<ul>
|
||||
<li>Config: password</li>
|
||||
<li>Env Var: RCLONE_OPENDRIVE_PASSWORD</li>
|
||||
@ -15244,6 +15253,7 @@ http://my.seafile.server/d/9ea2455f6f55478bbb0d/</code></pre>
|
||||
</ul>
|
||||
<h4 id="seafile-pass">–seafile-pass</h4>
|
||||
<p>Password</p>
|
||||
<p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p>
|
||||
<ul>
|
||||
<li>Config: pass</li>
|
||||
<li>Env Var: RCLONE_SEAFILE_PASS</li>
|
||||
@ -15268,6 +15278,7 @@ http://my.seafile.server/d/9ea2455f6f55478bbb0d/</code></pre>
|
||||
</ul>
|
||||
<h4 id="seafile-library-key">–seafile-library-key</h4>
|
||||
<p>Library password (for encrypted libraries only). Leave blank if you pass it through the command line.</p>
|
||||
<p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p>
|
||||
<ul>
|
||||
<li>Config: library_key</li>
|
||||
<li>Env Var: RCLONE_SEAFILE_LIBRARY_KEY</li>
|
||||
@ -15426,6 +15437,7 @@ y/e/d> y</code></pre>
|
||||
</ul>
|
||||
<h4 id="sftp-pass">–sftp-pass</h4>
|
||||
<p>SSH password, leave blank to use ssh-agent.</p>
|
||||
<p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p>
|
||||
<ul>
|
||||
<li>Config: pass</li>
|
||||
<li>Env Var: RCLONE_SFTP_PASS</li>
|
||||
@ -15451,6 +15463,7 @@ y/e/d> y</code></pre>
|
||||
<h4 id="sftp-key-file-pass">–sftp-key-file-pass</h4>
|
||||
<p>The passphrase to decrypt the PEM-encoded private key file.</p>
|
||||
<p>Only PEM encrypted key files (old OpenSSH format) are supported. Encrypted keys in the new OpenSSH format can’t be used.</p>
|
||||
<p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p>
|
||||
<ul>
|
||||
<li>Config: key_file_pass</li>
|
||||
<li>Env Var: RCLONE_SFTP_KEY_FILE_PASS</li>
|
||||
@ -16368,6 +16381,7 @@ y/e/d> y</code></pre>
|
||||
</ul>
|
||||
<h4 id="webdav-pass">–webdav-pass</h4>
|
||||
<p>Password.</p>
|
||||
<p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p>
|
||||
<ul>
|
||||
<li>Config: pass</li>
|
||||
<li>Env Var: RCLONE_WEBDAV_PASS</li>
|
||||
@ -17045,6 +17059,54 @@ $ tree /tmp/b
|
||||
<li>“error”: return an error based on option value</li>
|
||||
</ul>
|
||||
<h1 id="changelog">Changelog</h1>
|
||||
<h2 id="v1.52.1---2020-06-10">v1.52.1 - 2020-06-10</h2>
|
||||
<p><a href="https://github.com/rclone/rclone/compare/v1.52.0...v1.52.1">See commits</a></p>
|
||||
<ul>
|
||||
<li>Bug Fixes
|
||||
<ul>
|
||||
<li>lib/file: Fix SetSparse on Windows 7 which fixes downloads of files > 250MB (Nick Craig-Wood)</li>
|
||||
<li>build
|
||||
<ul>
|
||||
<li>Update go.mod to go1.14 to enable -mod=vendor build (Nick Craig-Wood)</li>
|
||||
<li>Remove quicktest from Dockerfile (Nick Craig-Wood)</li>
|
||||
<li>Build Docker images with GitHub actions (Matteo Pietro Dazzi)</li>
|
||||
<li>Update Docker build workflows (Nick Craig-Wood)</li>
|
||||
<li>Set user_allow_other in /etc/fuse.conf in the Docker image (Nick Craig-Wood)</li>
|
||||
<li>Fix xgo build after go1.14 go.mod update (Nick Craig-Wood)</li>
|
||||
</ul></li>
|
||||
<li>docs
|
||||
<ul>
|
||||
<li>Add link to source and modified time to footer of every page (Nick Craig-Wood)</li>
|
||||
<li>Remove manually set dates and use git dates instead (Nick Craig-Wood)</li>
|
||||
<li>Minor tense, punctuation, brevity and positivity changes for the home page (edwardxml)</li>
|
||||
<li>Remove leading slash in page reference in footer when present (Nick Craig-Wood)</li>
|
||||
<li>Note commands which need obscured input in the docs (Nick Craig-Wood)</li>
|
||||
<li>obscure: Write more help as we are referencing it elsewhere (Nick Craig-Wood)</li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
<li>VFS
|
||||
<ul>
|
||||
<li>Fix OS vs Unix path confusion - fixes ChangeNotify on Windows (Nick Craig-Wood)</li>
|
||||
</ul></li>
|
||||
<li>Drive
|
||||
<ul>
|
||||
<li>Fix missing items when listing using –fast-list / ListR (Nick Craig-Wood)</li>
|
||||
</ul></li>
|
||||
<li>Putio
|
||||
<ul>
|
||||
<li>Fix panic on Object.Open (Cenk Alti)</li>
|
||||
</ul></li>
|
||||
<li>S3
|
||||
<ul>
|
||||
<li>Fix upload of single files into buckets without create permission (Nick Craig-Wood)</li>
|
||||
<li>Fix –header-upload (Nick Craig-Wood)</li>
|
||||
</ul></li>
|
||||
<li>Tardigrade
|
||||
<ul>
|
||||
<li>Fix listing bug by upgrading to v1.0.7</li>
|
||||
<li>Set UserAgent to rclone (Caleb Case)</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
<h2 id="v1.52.0---2020-05-27">v1.52.0 - 2020-05-27</h2>
|
||||
<p>Special thanks to Martin Michlmayr for proof reading and correcting all the docs and Edward Barker for helping re-write the front page.</p>
|
||||
<p><a href="https://github.com/rclone/rclone/compare/v1.51.0...v1.52.0">See commits</a></p>
|
||||
|
136
MANUAL.md
generated
136
MANUAL.md
generated
@ -1,15 +1,15 @@
|
||||
% rclone(1) User Manual
|
||||
% Nick Craig-Wood
|
||||
% May 27, 2020
|
||||
% Jun 10, 2020
|
||||
|
||||
# Rclone syncs your files to cloud storage
|
||||
|
||||
<img width="50%" src="https://rclone.org/img/logo_on_light__horizontal_color.svg" alt="rclone logo" style="float:right; padding: 5px;" >
|
||||
|
||||
- [About rclone](#about)
|
||||
- [What can rclone do for you](#what)
|
||||
- [What features does rclone have](#features)
|
||||
- [What providers does rclone support](#providers)
|
||||
- [What can rclone do for you?](#what)
|
||||
- [What features does rclone have?](#features)
|
||||
- [What providers does rclone support?](#providers)
|
||||
- [Download](https://rclone.org/downloads/)
|
||||
- [Install](https://rclone.org/install/)
|
||||
- [Donate.](https://rclone.org/donate/)
|
||||
@ -24,20 +24,20 @@ services, as well as standard transfer protocols.
|
||||
|
||||
Rclone has powerful cloud equivalents to the unix commands rsync, cp,
|
||||
mv, mount, ls, ncdu, tree, rm, and cat. Rclone's familiar syntax
|
||||
includes shell pipeline support, and `--dry-run` protection. It can be
|
||||
includes shell pipeline support, and `--dry-run` protection. It is
|
||||
used at the command line, in scripts or via its [API](/rc).
|
||||
|
||||
Users have called rclone *"The Swiss army knife of cloud storage"* and
|
||||
Users call rclone *"The Swiss army knife of cloud storage"*, and
|
||||
*"Technology indistinguishable from magic"*.
|
||||
|
||||
Rclone really looks after your data. It preserves timestamps and
|
||||
verifies your data at all times. Transfers over limited bandwidth;
|
||||
verifies checksums at all times. Transfers over limited bandwidth;
|
||||
intermittent connections, or subject to quota can be restarted, from
|
||||
the last good file transferred. You can
|
||||
[check](https://rclone.org/commands/rclone_check/) the integrity of your files. Where
|
||||
possible, rclone employs server side transfers to minimise local
|
||||
bandwidth use and transfers from one provider to another without
|
||||
using your local disk.
|
||||
using local disk.
|
||||
|
||||
Virtual backends wrap local and cloud file systems to apply
|
||||
[encryption](https://rclone.org/crypt/),
|
||||
@ -45,9 +45,9 @@ Virtual backends wrap local and cloud file systems to apply
|
||||
[chunking](https://rclone.org/chunker/) and
|
||||
[joining](https://rclone.org/union/).
|
||||
|
||||
Rclone can [mount](https://rclone.org/commands/rclone_mount/) any local, cloud or
|
||||
Rclone [mounts](https://rclone.org/commands/rclone_mount/) any local, cloud or
|
||||
virtual filesystem as a disk on Windows,
|
||||
macOS, linux and FreeBSD, and also serve these over
|
||||
macOS, linux and FreeBSD, and also serves these over
|
||||
[SFTP](https://rclone.org/commands/rclone_serve_sftp/),
|
||||
[HTTP](https://rclone.org/commands/rclone_serve_http/),
|
||||
[WebDAV](https://rclone.org/commands/rclone_serve_webdav/),
|
||||
@ -61,14 +61,14 @@ Fedora, Brew and Chocolatey repos. include rclone. For the latest
|
||||
version [downloading from rclone.org](https://rclone.org/downloads/) is recommended.
|
||||
|
||||
Rclone is widely used on Linux, Windows and Mac. Third party
|
||||
developers have built innovative backup, restore, GUI and business
|
||||
developers create innovative backup, restore, GUI and business
|
||||
process solutions using the rclone command line or API.
|
||||
|
||||
Let rclone do the heavy lifting of communicating with cloud storage.
|
||||
Rclone does the heavy lifting of communicating with cloud storage.
|
||||
|
||||
## What can rclone do for you {#what}
|
||||
## What can rclone do for you? {#what}
|
||||
|
||||
Rclone can help you:
|
||||
Rclone helps you:
|
||||
|
||||
- Backup (and encrypt) files to cloud storage
|
||||
- Restore (and decrypt) files from cloud storage
|
||||
@ -96,7 +96,7 @@ Rclone can help you:
|
||||
|
||||
## Supported providers {#providers}
|
||||
|
||||
(There are many other providers, built on standard protocols such as
|
||||
(There are many others, built on standard protocols such as
|
||||
WebDAV or S3, that work out of the box.)
|
||||
|
||||
|
||||
@ -3126,11 +3126,24 @@ See the [global flags page](https://rclone.org/flags/) for global options not li
|
||||
|
||||
# rclone obscure
|
||||
|
||||
Obscure password for use in the rclone.conf
|
||||
Obscure password for use in the rclone config file
|
||||
|
||||
## Synopsis
|
||||
|
||||
Obscure password for use in the rclone.conf
|
||||
In the rclone config file, human readable passwords are
|
||||
obscured. Obscuring them is done by encrypting them and writing them
|
||||
out in base64. This is **not** a secure way of encrypting these
|
||||
passwords as rclone can decrypt them - it is to prevent "eyedropping"
|
||||
- namely someone seeing a password in the rclone config file by
|
||||
accident.
|
||||
|
||||
Many equally important things (like access tokens) are not obscured in
|
||||
the config file. However it is very hard to shoulder surf a 64
|
||||
character hex token.
|
||||
|
||||
If you want to encrypt the config file then please use config file
|
||||
encryption - see [rclone config](https://rclone.org/commands/rclone_config/) for more
|
||||
info.
|
||||
|
||||
```
|
||||
rclone obscure password [flags]
|
||||
@ -9670,7 +9683,7 @@ These flags are available for every command.
|
||||
--use-json-log Use json log format.
|
||||
--use-mmap Use mmap allocator (see docs).
|
||||
--use-server-modtime Use server modified time instead of object metadata
|
||||
--user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.52.0")
|
||||
--user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.52.1")
|
||||
-v, --verbose count Print lots more stuff (repeat for more)
|
||||
```
|
||||
|
||||
@ -9731,7 +9744,7 @@ and may be set in the config file.
|
||||
--cache-db-wait-time Duration How long to wait for the DB to be available - 0 is unlimited (default 1s)
|
||||
--cache-info-age Duration How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
|
||||
--cache-plex-insecure string Skip all certificate verification when connecting to the Plex server
|
||||
--cache-plex-password string The password of the Plex user
|
||||
--cache-plex-password string The password of the Plex user (obscured)
|
||||
--cache-plex-url string The URL of the Plex server
|
||||
--cache-plex-username string The username of the Plex user
|
||||
--cache-read-retries int How many times to retry a read from a cache storage. (default 10)
|
||||
@ -9751,8 +9764,8 @@ and may be set in the config file.
|
||||
-L, --copy-links Follow symlinks and copy the pointed to item.
|
||||
--crypt-directory-name-encryption Option to either encrypt directory names or leave them intact. (default true)
|
||||
--crypt-filename-encryption string How to encrypt the filenames. (default "standard")
|
||||
--crypt-password string Password or pass phrase for encryption.
|
||||
--crypt-password2 string Password or pass phrase for salt. Optional but recommended.
|
||||
--crypt-password string Password or pass phrase for encryption. (obscured)
|
||||
--crypt-password2 string Password or pass phrase for salt. Optional but recommended. (obscured)
|
||||
--crypt-remote string Remote to encrypt/decrypt.
|
||||
--crypt-show-mapping For all files listed show how the names encrypt.
|
||||
--drive-acknowledge-abuse Set to allow files which return cannotDownloadAbusiveFile to be downloaded.
|
||||
@ -9803,7 +9816,7 @@ and may be set in the config file.
|
||||
--ftp-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,RightSpace,Dot)
|
||||
--ftp-host string FTP host to connect to
|
||||
--ftp-no-check-certificate Do not verify the TLS certificate of the server
|
||||
--ftp-pass string FTP password
|
||||
--ftp-pass string FTP password (obscured)
|
||||
--ftp-port string FTP port, leave blank to use default (21)
|
||||
--ftp-tls Use FTP over TLS (Implicit)
|
||||
--ftp-user string FTP username, leave blank for current username, $USER
|
||||
@ -9840,7 +9853,7 @@ and may be set in the config file.
|
||||
--koofr-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||
--koofr-endpoint string The Koofr API endpoint to use (default "https://app.koofr.net")
|
||||
--koofr-mountid string Mount ID of the mount to use. If omitted, the primary mount is used.
|
||||
--koofr-password string Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password)
|
||||
--koofr-password string Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password) (obscured)
|
||||
--koofr-setmtime Does the backend support setting modification time. Set this to false if you use a mount ID that points to a Dropbox or Amazon Drive backend. (default true)
|
||||
--koofr-user string Your Koofr user name
|
||||
-l, --links Translate symlinks to/from regular files with a '.rclonelink' extension
|
||||
@ -9853,7 +9866,7 @@ and may be set in the config file.
|
||||
--local-nounc string Disable UNC (long path names) conversion on Windows
|
||||
--mailru-check-hash What should copy do if file checksum is mismatched or invalid (default true)
|
||||
--mailru-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||
--mailru-pass string Password
|
||||
--mailru-pass string Password (obscured)
|
||||
--mailru-speedup-enable Skip full upload if there is another file with same data hash. (default true)
|
||||
--mailru-speedup-file-patterns string Comma separated list of file name patterns eligible for speedup (put by hash). (default "*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf")
|
||||
--mailru-speedup-max-disk SizeSuffix This option allows you to disable speedup (put by hash) for large files (default 3G)
|
||||
@ -9862,7 +9875,7 @@ and may be set in the config file.
|
||||
--mega-debug Output more debug from Mega.
|
||||
--mega-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot)
|
||||
--mega-hard-delete Delete files permanently rather than putting them into the trash.
|
||||
--mega-pass string Password.
|
||||
--mega-pass string Password. (obscured)
|
||||
--mega-user string User name
|
||||
-x, --one-file-system Don't cross filesystem boundaries (unix/macOS only).
|
||||
--onedrive-chunk-size SizeSuffix Chunk size to upload files with - must be multiple of 320k (327,680 bytes). (default 10M)
|
||||
@ -9875,7 +9888,7 @@ and may be set in the config file.
|
||||
--onedrive-server-side-across-configs Allow server side operations (eg copy) to work across different onedrive configs.
|
||||
--opendrive-chunk-size SizeSuffix Files will be uploaded in chunks this size. (default 10M)
|
||||
--opendrive-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot)
|
||||
--opendrive-password string Password.
|
||||
--opendrive-password string Password. (obscured)
|
||||
--opendrive-username string Username
|
||||
--pcloud-client-id string Pcloud App Client Id
|
||||
--pcloud-client-secret string Pcloud App Client Secret
|
||||
@ -9926,19 +9939,19 @@ and may be set in the config file.
|
||||
--seafile-create-library Should rclone create a library if it doesn't exist
|
||||
--seafile-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8)
|
||||
--seafile-library string Name of the library. Leave blank to access all non-encrypted libraries.
|
||||
--seafile-library-key string Library password (for encrypted libraries only). Leave blank if you pass it through the command line.
|
||||
--seafile-pass string Password
|
||||
--seafile-library-key string Library password (for encrypted libraries only). Leave blank if you pass it through the command line. (obscured)
|
||||
--seafile-pass string Password (obscured)
|
||||
--seafile-url string URL of seafile host to connect to
|
||||
--seafile-user string User name (usually email address)
|
||||
--sftp-ask-password Allow asking for SFTP password when needed.
|
||||
--sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available.
|
||||
--sftp-host string SSH host to connect to
|
||||
--sftp-key-file string Path to PEM-encoded private key file, leave blank or set key-use-agent to use ssh-agent.
|
||||
--sftp-key-file-pass string The passphrase to decrypt the PEM-encoded private key file.
|
||||
--sftp-key-file-pass string The passphrase to decrypt the PEM-encoded private key file. (obscured)
|
||||
--sftp-key-pem string Raw PEM-encoded private key, If specified, will override key_file parameter.
|
||||
--sftp-key-use-agent When set forces the usage of the ssh-agent.
|
||||
--sftp-md5sum-command string The command used to read md5 hashes. Leave blank for autodetect.
|
||||
--sftp-pass string SSH password, leave blank to use ssh-agent.
|
||||
--sftp-pass string SSH password, leave blank to use ssh-agent. (obscured)
|
||||
--sftp-path-override string Override path used by SSH connection.
|
||||
--sftp-port string SSH port, leave blank to use default (22)
|
||||
--sftp-set-modtime Set the modified time on the remote if set. (default true)
|
||||
@ -9996,7 +10009,7 @@ and may be set in the config file.
|
||||
--union-upstreams string List of space separated upstreams.
|
||||
--webdav-bearer-token string Bearer token instead of user/pass (eg a Macaroon)
|
||||
--webdav-bearer-token-command string Command to run to get a bearer token
|
||||
--webdav-pass string Password.
|
||||
--webdav-pass string Password. (obscured)
|
||||
--webdav-url string URL of http host to connect to
|
||||
--webdav-user string User name
|
||||
--webdav-vendor string Name of the Webdav site/service/software you are using
|
||||
@ -13622,6 +13635,8 @@ The username of the Plex user
|
||||
|
||||
The password of the Plex user
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/).
|
||||
|
||||
- Config: plex_password
|
||||
- Env Var: RCLONE_CACHE_PLEX_PASSWORD
|
||||
- Type: string
|
||||
@ -14880,6 +14895,8 @@ NB If filename_encryption is "off" then this option will do nothing.
|
||||
|
||||
Password or pass phrase for encryption.
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/).
|
||||
|
||||
- Config: password
|
||||
- Env Var: RCLONE_CRYPT_PASSWORD
|
||||
- Type: string
|
||||
@ -14890,6 +14907,8 @@ Password or pass phrase for encryption.
|
||||
Password or pass phrase for salt. Optional but recommended.
|
||||
Should be different to the previous password.
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/).
|
||||
|
||||
- Config: password2
|
||||
- Env Var: RCLONE_CRYPT_PASSWORD2
|
||||
- Type: string
|
||||
@ -15480,6 +15499,8 @@ FTP port, leave blank to use default (21)
|
||||
|
||||
FTP password
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/).
|
||||
|
||||
- Config: pass
|
||||
- Env Var: RCLONE_FTP_PASS
|
||||
- Type: string
|
||||
@ -16426,7 +16447,7 @@ For shortcuts pointing to folders:
|
||||
- When deleting with `rclone rmdir` or `rclone purge` the shortcut is deleted not the linked folder.
|
||||
- **NB** When deleting with `rclone remove` or `rclone mount` the contents of the linked folder will be deleted.
|
||||
|
||||
It isn't currently possible to create shortcuts with rclone.
|
||||
The [rclone backend](https://rclone.org/commands/rclone_backend/) command can be used to create shortcuts.
|
||||
|
||||
Shortcuts can be completely ignored with the `--drive-skip-shortcuts` flag
|
||||
or the corresponding `skip_shortcuts` configuration setting.
|
||||
@ -18312,6 +18333,8 @@ Your Koofr user name
|
||||
|
||||
Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password)
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/).
|
||||
|
||||
- Config: password
|
||||
- Env Var: RCLONE_KOOFR_PASSWORD
|
||||
- Type: string
|
||||
@ -18544,6 +18567,8 @@ User name (usually email)
|
||||
|
||||
Password
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/).
|
||||
|
||||
- Config: pass
|
||||
- Env Var: RCLONE_MAILRU_PASS
|
||||
- Type: string
|
||||
@ -18842,6 +18867,8 @@ User name
|
||||
|
||||
Password.
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/).
|
||||
|
||||
- Config: pass
|
||||
- Env Var: RCLONE_MEGA_PASS
|
||||
- Type: string
|
||||
@ -19818,6 +19845,8 @@ Username
|
||||
|
||||
Password.
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/).
|
||||
|
||||
- Config: password
|
||||
- Env Var: RCLONE_OPENDRIVE_PASSWORD
|
||||
- Type: string
|
||||
@ -21394,6 +21423,8 @@ User name (usually email address)
|
||||
|
||||
Password
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/).
|
||||
|
||||
- Config: pass
|
||||
- Env Var: RCLONE_SEAFILE_PASS
|
||||
- Type: string
|
||||
@ -21421,6 +21452,8 @@ Name of the library. Leave blank to access all non-encrypted libraries.
|
||||
|
||||
Library password (for encrypted libraries only). Leave blank if you pass it through the command line.
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/).
|
||||
|
||||
- Config: library_key
|
||||
- Env Var: RCLONE_SEAFILE_LIBRARY_KEY
|
||||
- Type: string
|
||||
@ -21650,6 +21683,8 @@ SSH port, leave blank to use default (22)
|
||||
|
||||
SSH password, leave blank to use ssh-agent.
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/).
|
||||
|
||||
- Config: pass
|
||||
- Env Var: RCLONE_SFTP_PASS
|
||||
- Type: string
|
||||
@ -21680,6 +21715,8 @@ The passphrase to decrypt the PEM-encoded private key file.
|
||||
Only PEM encrypted key files (old OpenSSH format) are supported. Encrypted keys
|
||||
in the new OpenSSH format can't be used.
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/).
|
||||
|
||||
- Config: key_file_pass
|
||||
- Env Var: RCLONE_SFTP_KEY_FILE_PASS
|
||||
- Type: string
|
||||
@ -22778,6 +22815,8 @@ User name
|
||||
|
||||
Password.
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/).
|
||||
|
||||
- Config: pass
|
||||
- Env Var: RCLONE_WEBDAV_PASS
|
||||
- Type: string
|
||||
@ -23596,6 +23635,39 @@ Options:
|
||||
|
||||
# Changelog
|
||||
|
||||
## v1.52.1 - 2020-06-10
|
||||
|
||||
[See commits](https://github.com/rclone/rclone/compare/v1.52.0...v1.52.1)
|
||||
|
||||
* Bug Fixes
|
||||
* lib/file: Fix SetSparse on Windows 7 which fixes downloads of files > 250MB (Nick Craig-Wood)
|
||||
* build
|
||||
* Update go.mod to go1.14 to enable -mod=vendor build (Nick Craig-Wood)
|
||||
* Remove quicktest from Dockerfile (Nick Craig-Wood)
|
||||
* Build Docker images with GitHub actions (Matteo Pietro Dazzi)
|
||||
* Update Docker build workflows (Nick Craig-Wood)
|
||||
* Set user_allow_other in /etc/fuse.conf in the Docker image (Nick Craig-Wood)
|
||||
* Fix xgo build after go1.14 go.mod update (Nick Craig-Wood)
|
||||
* docs
|
||||
* Add link to source and modified time to footer of every page (Nick Craig-Wood)
|
||||
* Remove manually set dates and use git dates instead (Nick Craig-Wood)
|
||||
* Minor tense, punctuation, brevity and positivity changes for the home page (edwardxml)
|
||||
* Remove leading slash in page reference in footer when present (Nick Craig-Wood)
|
||||
* Note commands which need obscured input in the docs (Nick Craig-Wood)
|
||||
* obscure: Write more help as we are referencing it elsewhere (Nick Craig-Wood)
|
||||
* VFS
|
||||
* Fix OS vs Unix path confusion - fixes ChangeNotify on Windows (Nick Craig-Wood)
|
||||
* Drive
|
||||
* Fix missing items when listing using --fast-list / ListR (Nick Craig-Wood)
|
||||
* Putio
|
||||
* Fix panic on Object.Open (Cenk Alti)
|
||||
* S3
|
||||
* Fix upload of single files into buckets without create permission (Nick Craig-Wood)
|
||||
* Fix --header-upload (Nick Craig-Wood)
|
||||
* Tardigrade
|
||||
* Fix listing bug by upgrading to v1.0.7
|
||||
* Set UserAgent to rclone (Caleb Case)
|
||||
|
||||
## v1.52.0 - 2020-05-27
|
||||
|
||||
Special thanks to Martin Michlmayr for proof reading and correcting
|
||||
|
156
MANUAL.txt
generated
156
MANUAL.txt
generated
@ -1,6 +1,6 @@
|
||||
rclone(1) User Manual
|
||||
Nick Craig-Wood
|
||||
May 27, 2020
|
||||
Jun 10, 2020
|
||||
|
||||
|
||||
|
||||
@ -8,9 +8,9 @@ RCLONE SYNCS YOUR FILES TO CLOUD STORAGE
|
||||
|
||||
|
||||
- About rclone
|
||||
- What can rclone do for you
|
||||
- What features does rclone have
|
||||
- What providers does rclone support
|
||||
- What can rclone do for you?
|
||||
- What features does rclone have?
|
||||
- What providers does rclone support?
|
||||
- Download
|
||||
- Install
|
||||
- Donate.
|
||||
@ -26,26 +26,26 @@ transfer protocols.
|
||||
|
||||
Rclone has powerful cloud equivalents to the unix commands rsync, cp,
|
||||
mv, mount, ls, ncdu, tree, rm, and cat. Rclone’s familiar syntax
|
||||
includes shell pipeline support, and --dry-run protection. It can be
|
||||
used at the command line, in scripts or via its API.
|
||||
includes shell pipeline support, and --dry-run protection. It is used at
|
||||
the command line, in scripts or via its API.
|
||||
|
||||
Users have called rclone _“The Swiss army knife of cloud storage”_ and
|
||||
Users call rclone _“The Swiss army knife of cloud storage”_, and
|
||||
_“Technology indistinguishable from magic”_.
|
||||
|
||||
Rclone really looks after your data. It preserves timestamps and
|
||||
verifies your data at all times. Transfers over limited bandwidth;
|
||||
verifies checksums at all times. Transfers over limited bandwidth;
|
||||
intermittent connections, or subject to quota can be restarted, from the
|
||||
last good file transferred. You can check the integrity of your files.
|
||||
Where possible, rclone employs server side transfers to minimise local
|
||||
bandwidth use and transfers from one provider to another without using
|
||||
your local disk.
|
||||
local disk.
|
||||
|
||||
Virtual backends wrap local and cloud file systems to apply encryption,
|
||||
caching, chunking and joining.
|
||||
|
||||
Rclone can mount any local, cloud or virtual filesystem as a disk on
|
||||
Windows, macOS, linux and FreeBSD, and also serve these over SFTP, HTTP,
|
||||
WebDAV, FTP and DLNA.
|
||||
Rclone mounts any local, cloud or virtual filesystem as a disk on
|
||||
Windows, macOS, linux and FreeBSD, and also serves these over SFTP,
|
||||
HTTP, WebDAV, FTP and DLNA.
|
||||
|
||||
Rclone is mature, open source software originally inspired by rsync and
|
||||
written in Go. The friendly support community are familiar with varied
|
||||
@ -54,15 +54,15 @@ include rclone. For the latest version downloading from rclone.org is
|
||||
recommended.
|
||||
|
||||
Rclone is widely used on Linux, Windows and Mac. Third party developers
|
||||
have built innovative backup, restore, GUI and business process
|
||||
solutions using the rclone command line or API.
|
||||
create innovative backup, restore, GUI and business process solutions
|
||||
using the rclone command line or API.
|
||||
|
||||
Let rclone do the heavy lifting of communicating with cloud storage.
|
||||
Rclone does the heavy lifting of communicating with cloud storage.
|
||||
|
||||
|
||||
What can rclone do for you
|
||||
What can rclone do for you?
|
||||
|
||||
Rclone can help you:
|
||||
Rclone helps you:
|
||||
|
||||
- Backup (and encrypt) files to cloud storage
|
||||
- Restore (and decrypt) files from cloud storage
|
||||
@ -94,8 +94,8 @@ Features
|
||||
|
||||
Supported providers
|
||||
|
||||
(There are many other providers, built on standard protocols such as
|
||||
WebDAV or S3, that work out of the box.)
|
||||
(There are many others, built on standard protocols such as WebDAV or
|
||||
S3, that work out of the box.)
|
||||
|
||||
- 1Fichier
|
||||
- Alibaba Cloud (Aliyun) Object Storage System (OSS)
|
||||
@ -3157,12 +3157,23 @@ SEE ALSO
|
||||
RCLONE OBSCURE
|
||||
|
||||
|
||||
Obscure password for use in the rclone.conf
|
||||
Obscure password for use in the rclone config file
|
||||
|
||||
|
||||
Synopsis
|
||||
|
||||
Obscure password for use in the rclone.conf
|
||||
In the rclone config file, human readable passwords are obscured.
|
||||
Obscuring them is done by encrypting them and writing them out in
|
||||
base64. This is NOT a secure way of encrypting these passwords as rclone
|
||||
can decrypt them - it is to prevent “eyedropping” - namely someone
|
||||
seeing a password in the rclone config file by accident.
|
||||
|
||||
Many equally important things (like access tokens) are not obscured in
|
||||
the config file. However it is very hard to shoulder surf a 64 character
|
||||
hex token.
|
||||
|
||||
If you want to encrypt the config file then please use config file
|
||||
encryption - see rclone config for more info.
|
||||
|
||||
rclone obscure password [flags]
|
||||
|
||||
@ -9741,7 +9752,7 @@ These flags are available for every command.
|
||||
--use-json-log Use json log format.
|
||||
--use-mmap Use mmap allocator (see docs).
|
||||
--use-server-modtime Use server modified time instead of object metadata
|
||||
--user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.52.0")
|
||||
--user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.52.1")
|
||||
-v, --verbose count Print lots more stuff (repeat for more)
|
||||
|
||||
|
||||
@ -9801,7 +9812,7 @@ and may be set in the config file.
|
||||
--cache-db-wait-time Duration How long to wait for the DB to be available - 0 is unlimited (default 1s)
|
||||
--cache-info-age Duration How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
|
||||
--cache-plex-insecure string Skip all certificate verification when connecting to the Plex server
|
||||
--cache-plex-password string The password of the Plex user
|
||||
--cache-plex-password string The password of the Plex user (obscured)
|
||||
--cache-plex-url string The URL of the Plex server
|
||||
--cache-plex-username string The username of the Plex user
|
||||
--cache-read-retries int How many times to retry a read from a cache storage. (default 10)
|
||||
@ -9821,8 +9832,8 @@ and may be set in the config file.
|
||||
-L, --copy-links Follow symlinks and copy the pointed to item.
|
||||
--crypt-directory-name-encryption Option to either encrypt directory names or leave them intact. (default true)
|
||||
--crypt-filename-encryption string How to encrypt the filenames. (default "standard")
|
||||
--crypt-password string Password or pass phrase for encryption.
|
||||
--crypt-password2 string Password or pass phrase for salt. Optional but recommended.
|
||||
--crypt-password string Password or pass phrase for encryption. (obscured)
|
||||
--crypt-password2 string Password or pass phrase for salt. Optional but recommended. (obscured)
|
||||
--crypt-remote string Remote to encrypt/decrypt.
|
||||
--crypt-show-mapping For all files listed show how the names encrypt.
|
||||
--drive-acknowledge-abuse Set to allow files which return cannotDownloadAbusiveFile to be downloaded.
|
||||
@ -9873,7 +9884,7 @@ and may be set in the config file.
|
||||
--ftp-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,RightSpace,Dot)
|
||||
--ftp-host string FTP host to connect to
|
||||
--ftp-no-check-certificate Do not verify the TLS certificate of the server
|
||||
--ftp-pass string FTP password
|
||||
--ftp-pass string FTP password (obscured)
|
||||
--ftp-port string FTP port, leave blank to use default (21)
|
||||
--ftp-tls Use FTP over TLS (Implicit)
|
||||
--ftp-user string FTP username, leave blank for current username, $USER
|
||||
@ -9910,7 +9921,7 @@ and may be set in the config file.
|
||||
--koofr-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||
--koofr-endpoint string The Koofr API endpoint to use (default "https://app.koofr.net")
|
||||
--koofr-mountid string Mount ID of the mount to use. If omitted, the primary mount is used.
|
||||
--koofr-password string Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password)
|
||||
--koofr-password string Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password) (obscured)
|
||||
--koofr-setmtime Does the backend support setting modification time. Set this to false if you use a mount ID that points to a Dropbox or Amazon Drive backend. (default true)
|
||||
--koofr-user string Your Koofr user name
|
||||
-l, --links Translate symlinks to/from regular files with a '.rclonelink' extension
|
||||
@ -9923,7 +9934,7 @@ and may be set in the config file.
|
||||
--local-nounc string Disable UNC (long path names) conversion on Windows
|
||||
--mailru-check-hash What should copy do if file checksum is mismatched or invalid (default true)
|
||||
--mailru-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||
--mailru-pass string Password
|
||||
--mailru-pass string Password (obscured)
|
||||
--mailru-speedup-enable Skip full upload if there is another file with same data hash. (default true)
|
||||
--mailru-speedup-file-patterns string Comma separated list of file name patterns eligible for speedup (put by hash). (default "*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf")
|
||||
--mailru-speedup-max-disk SizeSuffix This option allows you to disable speedup (put by hash) for large files (default 3G)
|
||||
@ -9932,7 +9943,7 @@ and may be set in the config file.
|
||||
--mega-debug Output more debug from Mega.
|
||||
--mega-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot)
|
||||
--mega-hard-delete Delete files permanently rather than putting them into the trash.
|
||||
--mega-pass string Password.
|
||||
--mega-pass string Password. (obscured)
|
||||
--mega-user string User name
|
||||
-x, --one-file-system Don't cross filesystem boundaries (unix/macOS only).
|
||||
--onedrive-chunk-size SizeSuffix Chunk size to upload files with - must be multiple of 320k (327,680 bytes). (default 10M)
|
||||
@ -9945,7 +9956,7 @@ and may be set in the config file.
|
||||
--onedrive-server-side-across-configs Allow server side operations (eg copy) to work across different onedrive configs.
|
||||
--opendrive-chunk-size SizeSuffix Files will be uploaded in chunks this size. (default 10M)
|
||||
--opendrive-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot)
|
||||
--opendrive-password string Password.
|
||||
--opendrive-password string Password. (obscured)
|
||||
--opendrive-username string Username
|
||||
--pcloud-client-id string Pcloud App Client Id
|
||||
--pcloud-client-secret string Pcloud App Client Secret
|
||||
@ -9996,19 +10007,19 @@ and may be set in the config file.
|
||||
--seafile-create-library Should rclone create a library if it doesn't exist
|
||||
--seafile-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8)
|
||||
--seafile-library string Name of the library. Leave blank to access all non-encrypted libraries.
|
||||
--seafile-library-key string Library password (for encrypted libraries only). Leave blank if you pass it through the command line.
|
||||
--seafile-pass string Password
|
||||
--seafile-library-key string Library password (for encrypted libraries only). Leave blank if you pass it through the command line. (obscured)
|
||||
--seafile-pass string Password (obscured)
|
||||
--seafile-url string URL of seafile host to connect to
|
||||
--seafile-user string User name (usually email address)
|
||||
--sftp-ask-password Allow asking for SFTP password when needed.
|
||||
--sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available.
|
||||
--sftp-host string SSH host to connect to
|
||||
--sftp-key-file string Path to PEM-encoded private key file, leave blank or set key-use-agent to use ssh-agent.
|
||||
--sftp-key-file-pass string The passphrase to decrypt the PEM-encoded private key file.
|
||||
--sftp-key-file-pass string The passphrase to decrypt the PEM-encoded private key file. (obscured)
|
||||
--sftp-key-pem string Raw PEM-encoded private key, If specified, will override key_file parameter.
|
||||
--sftp-key-use-agent When set forces the usage of the ssh-agent.
|
||||
--sftp-md5sum-command string The command used to read md5 hashes. Leave blank for autodetect.
|
||||
--sftp-pass string SSH password, leave blank to use ssh-agent.
|
||||
--sftp-pass string SSH password, leave blank to use ssh-agent. (obscured)
|
||||
--sftp-path-override string Override path used by SSH connection.
|
||||
--sftp-port string SSH port, leave blank to use default (22)
|
||||
--sftp-set-modtime Set the modified time on the remote if set. (default true)
|
||||
@ -10066,7 +10077,7 @@ and may be set in the config file.
|
||||
--union-upstreams string List of space separated upstreams.
|
||||
--webdav-bearer-token string Bearer token instead of user/pass (eg a Macaroon)
|
||||
--webdav-bearer-token-command string Command to run to get a bearer token
|
||||
--webdav-pass string Password.
|
||||
--webdav-pass string Password. (obscured)
|
||||
--webdav-url string URL of http host to connect to
|
||||
--webdav-user string User name
|
||||
--webdav-vendor string Name of the Webdav site/service/software you are using
|
||||
@ -13652,6 +13663,8 @@ The username of the Plex user
|
||||
|
||||
The password of the Plex user
|
||||
|
||||
NB Input to this must be obscured - see rclone obscure.
|
||||
|
||||
- Config: plex_password
|
||||
- Env Var: RCLONE_CACHE_PLEX_PASSWORD
|
||||
- Type: string
|
||||
@ -14887,6 +14900,8 @@ NB If filename_encryption is “off” then this option will do nothing.
|
||||
|
||||
Password or pass phrase for encryption.
|
||||
|
||||
NB Input to this must be obscured - see rclone obscure.
|
||||
|
||||
- Config: password
|
||||
- Env Var: RCLONE_CRYPT_PASSWORD
|
||||
- Type: string
|
||||
@ -14897,6 +14912,8 @@ Password or pass phrase for encryption.
|
||||
Password or pass phrase for salt. Optional but recommended. Should be
|
||||
different to the previous password.
|
||||
|
||||
NB Input to this must be obscured - see rclone obscure.
|
||||
|
||||
- Config: password2
|
||||
- Env Var: RCLONE_CRYPT_PASSWORD2
|
||||
- Type: string
|
||||
@ -15478,6 +15495,8 @@ FTP port, leave blank to use default (21)
|
||||
|
||||
FTP password
|
||||
|
||||
NB Input to this must be obscured - see rclone obscure.
|
||||
|
||||
- Config: pass
|
||||
- Env Var: RCLONE_FTP_PASS
|
||||
- Type: string
|
||||
@ -16418,7 +16437,7 @@ For shortcuts pointing to folders:
|
||||
- NB When deleting with rclone remove or rclone mount the contents of
|
||||
the linked folder will be deleted.
|
||||
|
||||
It isn’t currently possible to create shortcuts with rclone.
|
||||
The rclone backend command can be used to create shortcuts.
|
||||
|
||||
Shortcuts can be completely ignored with the --drive-skip-shortcuts flag
|
||||
or the corresponding skip_shortcuts configuration setting.
|
||||
@ -18315,6 +18334,8 @@ Your Koofr user name
|
||||
Your Koofr password for rclone (generate one at
|
||||
https://app.koofr.net/app/admin/preferences/password)
|
||||
|
||||
NB Input to this must be obscured - see rclone obscure.
|
||||
|
||||
- Config: password
|
||||
- Env Var: RCLONE_KOOFR_PASSWORD
|
||||
- Type: string
|
||||
@ -18550,6 +18571,8 @@ User name (usually email)
|
||||
|
||||
Password
|
||||
|
||||
NB Input to this must be obscured - see rclone obscure.
|
||||
|
||||
- Config: pass
|
||||
- Env Var: RCLONE_MAILRU_PASS
|
||||
- Type: string
|
||||
@ -18848,6 +18871,8 @@ User name
|
||||
|
||||
Password.
|
||||
|
||||
NB Input to this must be obscured - see rclone obscure.
|
||||
|
||||
- Config: pass
|
||||
- Env Var: RCLONE_MEGA_PASS
|
||||
- Type: string
|
||||
@ -19834,6 +19859,8 @@ Username
|
||||
|
||||
Password.
|
||||
|
||||
NB Input to this must be obscured - see rclone obscure.
|
||||
|
||||
- Config: password
|
||||
- Env Var: RCLONE_OPENDRIVE_PASSWORD
|
||||
- Type: string
|
||||
@ -21379,6 +21406,8 @@ User name (usually email address)
|
||||
|
||||
Password
|
||||
|
||||
NB Input to this must be obscured - see rclone obscure.
|
||||
|
||||
- Config: pass
|
||||
- Env Var: RCLONE_SEAFILE_PASS
|
||||
- Type: string
|
||||
@ -21407,6 +21436,8 @@ Name of the library. Leave blank to access all non-encrypted libraries.
|
||||
Library password (for encrypted libraries only). Leave blank if you pass
|
||||
it through the command line.
|
||||
|
||||
NB Input to this must be obscured - see rclone obscure.
|
||||
|
||||
- Config: library_key
|
||||
- Env Var: RCLONE_SEAFILE_LIBRARY_KEY
|
||||
- Type: string
|
||||
@ -21634,6 +21665,8 @@ SSH port, leave blank to use default (22)
|
||||
|
||||
SSH password, leave blank to use ssh-agent.
|
||||
|
||||
NB Input to this must be obscured - see rclone obscure.
|
||||
|
||||
- Config: pass
|
||||
- Env Var: RCLONE_SFTP_PASS
|
||||
- Type: string
|
||||
@ -21666,6 +21699,8 @@ The passphrase to decrypt the PEM-encoded private key file.
|
||||
Only PEM encrypted key files (old OpenSSH format) are supported.
|
||||
Encrypted keys in the new OpenSSH format can’t be used.
|
||||
|
||||
NB Input to this must be obscured - see rclone obscure.
|
||||
|
||||
- Config: key_file_pass
|
||||
- Env Var: RCLONE_SFTP_KEY_FILE_PASS
|
||||
- Type: string
|
||||
@ -22826,6 +22861,8 @@ User name
|
||||
|
||||
Password.
|
||||
|
||||
NB Input to this must be obscured - see rclone obscure.
|
||||
|
||||
- Config: pass
|
||||
- Env Var: RCLONE_WEBDAV_PASS
|
||||
- Type: string
|
||||
@ -23597,6 +23634,53 @@ Options:
|
||||
CHANGELOG
|
||||
|
||||
|
||||
v1.52.1 - 2020-06-10
|
||||
|
||||
See commits
|
||||
|
||||
- Bug Fixes
|
||||
- lib/file: Fix SetSparse on Windows 7 which fixes downloads of
|
||||
files > 250MB (Nick Craig-Wood)
|
||||
- build
|
||||
- Update go.mod to go1.14 to enable -mod=vendor build (Nick
|
||||
Craig-Wood)
|
||||
- Remove quicktest from Dockerfile (Nick Craig-Wood)
|
||||
- Build Docker images with GitHub actions (Matteo Pietro
|
||||
Dazzi)
|
||||
- Update Docker build workflows (Nick Craig-Wood)
|
||||
- Set user_allow_other in /etc/fuse.conf in the Docker image
|
||||
(Nick Craig-Wood)
|
||||
- Fix xgo build after go1.14 go.mod update (Nick Craig-Wood)
|
||||
- docs
|
||||
- Add link to source and modified time to footer of every page
|
||||
(Nick Craig-Wood)
|
||||
- Remove manually set dates and use git dates instead (Nick
|
||||
Craig-Wood)
|
||||
- Minor tense, punctuation, brevity and positivity changes for
|
||||
the home page (edwardxml)
|
||||
- Remove leading slash in page reference in footer when
|
||||
present (Nick Craig-Wood)
|
||||
- Note commands which need obscured input in the docs (Nick
|
||||
Craig-Wood)
|
||||
- obscure: Write more help as we are referencing it elsewhere
|
||||
(Nick Craig-Wood)
|
||||
- VFS
|
||||
- Fix OS vs Unix path confusion - fixes ChangeNotify on Windows
|
||||
(Nick Craig-Wood)
|
||||
- Drive
|
||||
- Fix missing items when listing using –fast-list / ListR (Nick
|
||||
Craig-Wood)
|
||||
- Putio
|
||||
- Fix panic on Object.Open (Cenk Alti)
|
||||
- S3
|
||||
- Fix upload of single files into buckets without create
|
||||
permission (Nick Craig-Wood)
|
||||
- Fix –header-upload (Nick Craig-Wood)
|
||||
- Tardigrade
|
||||
- Fix listing bug by upgrading to v1.0.7
|
||||
- Set UserAgent to rclone (Caleb Case)
|
||||
|
||||
|
||||
v1.52.0 - 2020-05-27
|
||||
|
||||
Special thanks to Martin Michlmayr for proof reading and correcting all
|
||||
|
@ -343,6 +343,8 @@ The username of the Plex user
|
||||
|
||||
The password of the Plex user
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
|
||||
|
||||
- Config: plex_password
|
||||
- Env Var: RCLONE_CACHE_PLEX_PASSWORD
|
||||
- Type: string
|
||||
|
@ -5,6 +5,39 @@ description: "Rclone Changelog"
|
||||
|
||||
# Changelog
|
||||
|
||||
## v1.52.1 - 2020-06-10
|
||||
|
||||
[See commits](https://github.com/rclone/rclone/compare/v1.52.0...v1.52.1)
|
||||
|
||||
* Bug Fixes
|
||||
* lib/file: Fix SetSparse on Windows 7 which fixes downloads of files > 250MB (Nick Craig-Wood)
|
||||
* build
|
||||
* Update go.mod to go1.14 to enable -mod=vendor build (Nick Craig-Wood)
|
||||
* Remove quicktest from Dockerfile (Nick Craig-Wood)
|
||||
* Build Docker images with GitHub actions (Matteo Pietro Dazzi)
|
||||
* Update Docker build workflows (Nick Craig-Wood)
|
||||
* Set user_allow_other in /etc/fuse.conf in the Docker image (Nick Craig-Wood)
|
||||
* Fix xgo build after go1.14 go.mod update (Nick Craig-Wood)
|
||||
* docs
|
||||
* Add link to source and modified time to footer of every page (Nick Craig-Wood)
|
||||
* Remove manually set dates and use git dates instead (Nick Craig-Wood)
|
||||
* Minor tense, punctuation, brevity and positivity changes for the home page (edwardxml)
|
||||
* Remove leading slash in page reference in footer when present (Nick Craig-Wood)
|
||||
* Note commands which need obscured input in the docs (Nick Craig-Wood)
|
||||
* obscure: Write more help as we are referencing it elsewhere (Nick Craig-Wood)
|
||||
* VFS
|
||||
* Fix OS vs Unix path confusion - fixes ChangeNotify on Windows (Nick Craig-Wood)
|
||||
* Drive
|
||||
* Fix missing items when listing using --fast-list / ListR (Nick Craig-Wood)
|
||||
* Putio
|
||||
* Fix panic on Object.Open (Cenk Alti)
|
||||
* S3
|
||||
* Fix upload of single files into buckets without create permission (Nick Craig-Wood)
|
||||
* Fix --header-upload (Nick Craig-Wood)
|
||||
* Tardigrade
|
||||
* Fix listing bug by upgrading to v1.0.7
|
||||
* Set UserAgent to rclone (Caleb Case)
|
||||
|
||||
## v1.52.0 - 2020-05-27
|
||||
|
||||
Special thanks to Martin Michlmayr for proof reading and correcting
|
||||
|
@ -65,7 +65,7 @@ See the [global flags page](/flags/) for global options not listed here.
|
||||
* [rclone move](/commands/rclone_move/) - Move files from source to dest.
|
||||
* [rclone moveto](/commands/rclone_moveto/) - Move file or directory from source to dest.
|
||||
* [rclone ncdu](/commands/rclone_ncdu/) - Explore a remote with a text based user interface.
|
||||
* [rclone obscure](/commands/rclone_obscure/) - Obscure password for use in the rclone.conf
|
||||
* [rclone obscure](/commands/rclone_obscure/) - Obscure password for use in the rclone config file
|
||||
* [rclone purge](/commands/rclone_purge/) - Remove the path and all of its contents.
|
||||
* [rclone rc](/commands/rclone_rc/) - Run a command against a running rclone.
|
||||
* [rclone rcat](/commands/rclone_rcat/) - Copies standard input to file on remote.
|
||||
|
@ -1,17 +1,30 @@
|
||||
---
|
||||
title: "rclone obscure"
|
||||
description: "Obscure password for use in the rclone.conf"
|
||||
description: "Obscure password for use in the rclone config file"
|
||||
slug: rclone_obscure
|
||||
url: /commands/rclone_obscure/
|
||||
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/obscure/ and as part of making a release run "make commanddocs"
|
||||
---
|
||||
# rclone obscure
|
||||
|
||||
Obscure password for use in the rclone.conf
|
||||
Obscure password for use in the rclone config file
|
||||
|
||||
## Synopsis
|
||||
|
||||
Obscure password for use in the rclone.conf
|
||||
In the rclone config file, human readable passwords are
|
||||
obscured. Obscuring them is done by encrypting them and writing them
|
||||
out in base64. This is **not** a secure way of encrypting these
|
||||
passwords as rclone can decrypt them - it is to prevent "eyedropping"
|
||||
- namely someone seeing a password in the rclone config file by
|
||||
accident.
|
||||
|
||||
Many equally important things (like access tokens) are not obscured in
|
||||
the config file. However it is very hard to shoulder surf a 64
|
||||
character hex token.
|
||||
|
||||
If you want to encrypt the config file then please use config file
|
||||
encryption - see [rclone config](/commands/rclone_config/) for more
|
||||
info.
|
||||
|
||||
```
|
||||
rclone obscure password [flags]
|
||||
|
@ -328,6 +328,8 @@ NB If filename_encryption is "off" then this option will do nothing.
|
||||
|
||||
Password or pass phrase for encryption.
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
|
||||
|
||||
- Config: password
|
||||
- Env Var: RCLONE_CRYPT_PASSWORD
|
||||
- Type: string
|
||||
@ -338,6 +340,8 @@ Password or pass phrase for encryption.
|
||||
Password or pass phrase for salt. Optional but recommended.
|
||||
Should be different to the previous password.
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
|
||||
|
||||
- Config: password2
|
||||
- Env Var: RCLONE_CRYPT_PASSWORD2
|
||||
- Type: string
|
||||
|
@ -144,7 +144,7 @@ These flags are available for every command.
|
||||
--use-json-log Use json log format.
|
||||
--use-mmap Use mmap allocator (see docs).
|
||||
--use-server-modtime Use server modified time instead of object metadata
|
||||
--user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.52.0")
|
||||
--user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.52.1")
|
||||
-v, --verbose count Print lots more stuff (repeat for more)
|
||||
```
|
||||
|
||||
@ -205,7 +205,7 @@ and may be set in the config file.
|
||||
--cache-db-wait-time Duration How long to wait for the DB to be available - 0 is unlimited (default 1s)
|
||||
--cache-info-age Duration How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
|
||||
--cache-plex-insecure string Skip all certificate verification when connecting to the Plex server
|
||||
--cache-plex-password string The password of the Plex user
|
||||
--cache-plex-password string The password of the Plex user (obscured)
|
||||
--cache-plex-url string The URL of the Plex server
|
||||
--cache-plex-username string The username of the Plex user
|
||||
--cache-read-retries int How many times to retry a read from a cache storage. (default 10)
|
||||
@ -225,8 +225,8 @@ and may be set in the config file.
|
||||
-L, --copy-links Follow symlinks and copy the pointed to item.
|
||||
--crypt-directory-name-encryption Option to either encrypt directory names or leave them intact. (default true)
|
||||
--crypt-filename-encryption string How to encrypt the filenames. (default "standard")
|
||||
--crypt-password string Password or pass phrase for encryption.
|
||||
--crypt-password2 string Password or pass phrase for salt. Optional but recommended.
|
||||
--crypt-password string Password or pass phrase for encryption. (obscured)
|
||||
--crypt-password2 string Password or pass phrase for salt. Optional but recommended. (obscured)
|
||||
--crypt-remote string Remote to encrypt/decrypt.
|
||||
--crypt-show-mapping For all files listed show how the names encrypt.
|
||||
--drive-acknowledge-abuse Set to allow files which return cannotDownloadAbusiveFile to be downloaded.
|
||||
@ -277,7 +277,7 @@ and may be set in the config file.
|
||||
--ftp-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,RightSpace,Dot)
|
||||
--ftp-host string FTP host to connect to
|
||||
--ftp-no-check-certificate Do not verify the TLS certificate of the server
|
||||
--ftp-pass string FTP password
|
||||
--ftp-pass string FTP password (obscured)
|
||||
--ftp-port string FTP port, leave blank to use default (21)
|
||||
--ftp-tls Use FTP over TLS (Implicit)
|
||||
--ftp-user string FTP username, leave blank for current username, $USER
|
||||
@ -314,7 +314,7 @@ and may be set in the config file.
|
||||
--koofr-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||
--koofr-endpoint string The Koofr API endpoint to use (default "https://app.koofr.net")
|
||||
--koofr-mountid string Mount ID of the mount to use. If omitted, the primary mount is used.
|
||||
--koofr-password string Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password)
|
||||
--koofr-password string Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password) (obscured)
|
||||
--koofr-setmtime Does the backend support setting modification time. Set this to false if you use a mount ID that points to a Dropbox or Amazon Drive backend. (default true)
|
||||
--koofr-user string Your Koofr user name
|
||||
-l, --links Translate symlinks to/from regular files with a '.rclonelink' extension
|
||||
@ -327,7 +327,7 @@ and may be set in the config file.
|
||||
--local-nounc string Disable UNC (long path names) conversion on Windows
|
||||
--mailru-check-hash What should copy do if file checksum is mismatched or invalid (default true)
|
||||
--mailru-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||
--mailru-pass string Password
|
||||
--mailru-pass string Password (obscured)
|
||||
--mailru-speedup-enable Skip full upload if there is another file with same data hash. (default true)
|
||||
--mailru-speedup-file-patterns string Comma separated list of file name patterns eligible for speedup (put by hash). (default "*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf")
|
||||
--mailru-speedup-max-disk SizeSuffix This option allows you to disable speedup (put by hash) for large files (default 3G)
|
||||
@ -336,7 +336,7 @@ and may be set in the config file.
|
||||
--mega-debug Output more debug from Mega.
|
||||
--mega-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot)
|
||||
--mega-hard-delete Delete files permanently rather than putting them into the trash.
|
||||
--mega-pass string Password.
|
||||
--mega-pass string Password. (obscured)
|
||||
--mega-user string User name
|
||||
-x, --one-file-system Don't cross filesystem boundaries (unix/macOS only).
|
||||
--onedrive-chunk-size SizeSuffix Chunk size to upload files with - must be multiple of 320k (327,680 bytes). (default 10M)
|
||||
@ -349,7 +349,7 @@ and may be set in the config file.
|
||||
--onedrive-server-side-across-configs Allow server side operations (eg copy) to work across different onedrive configs.
|
||||
--opendrive-chunk-size SizeSuffix Files will be uploaded in chunks this size. (default 10M)
|
||||
--opendrive-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot)
|
||||
--opendrive-password string Password.
|
||||
--opendrive-password string Password. (obscured)
|
||||
--opendrive-username string Username
|
||||
--pcloud-client-id string Pcloud App Client Id
|
||||
--pcloud-client-secret string Pcloud App Client Secret
|
||||
@ -400,19 +400,19 @@ and may be set in the config file.
|
||||
--seafile-create-library Should rclone create a library if it doesn't exist
|
||||
--seafile-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8)
|
||||
--seafile-library string Name of the library. Leave blank to access all non-encrypted libraries.
|
||||
--seafile-library-key string Library password (for encrypted libraries only). Leave blank if you pass it through the command line.
|
||||
--seafile-pass string Password
|
||||
--seafile-library-key string Library password (for encrypted libraries only). Leave blank if you pass it through the command line. (obscured)
|
||||
--seafile-pass string Password (obscured)
|
||||
--seafile-url string URL of seafile host to connect to
|
||||
--seafile-user string User name (usually email address)
|
||||
--sftp-ask-password Allow asking for SFTP password when needed.
|
||||
--sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available.
|
||||
--sftp-host string SSH host to connect to
|
||||
--sftp-key-file string Path to PEM-encoded private key file, leave blank or set key-use-agent to use ssh-agent.
|
||||
--sftp-key-file-pass string The passphrase to decrypt the PEM-encoded private key file.
|
||||
--sftp-key-file-pass string The passphrase to decrypt the PEM-encoded private key file. (obscured)
|
||||
--sftp-key-pem string Raw PEM-encoded private key, If specified, will override key_file parameter.
|
||||
--sftp-key-use-agent When set forces the usage of the ssh-agent.
|
||||
--sftp-md5sum-command string The command used to read md5 hashes. Leave blank for autodetect.
|
||||
--sftp-pass string SSH password, leave blank to use ssh-agent.
|
||||
--sftp-pass string SSH password, leave blank to use ssh-agent. (obscured)
|
||||
--sftp-path-override string Override path used by SSH connection.
|
||||
--sftp-port string SSH port, leave blank to use default (22)
|
||||
--sftp-set-modtime Set the modified time on the remote if set. (default true)
|
||||
@ -470,7 +470,7 @@ and may be set in the config file.
|
||||
--union-upstreams string List of space separated upstreams.
|
||||
--webdav-bearer-token string Bearer token instead of user/pass (eg a Macaroon)
|
||||
--webdav-bearer-token-command string Command to run to get a bearer token
|
||||
--webdav-pass string Password.
|
||||
--webdav-pass string Password. (obscured)
|
||||
--webdav-url string URL of http host to connect to
|
||||
--webdav-user string User name
|
||||
--webdav-vendor string Name of the Webdav site/service/software you are using
|
||||
|
@ -172,6 +172,8 @@ FTP port, leave blank to use default (21)
|
||||
|
||||
FTP password
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
|
||||
|
||||
- Config: pass
|
||||
- Env Var: RCLONE_FTP_PASS
|
||||
- Type: string
|
||||
|
@ -115,6 +115,8 @@ Your Koofr user name
|
||||
|
||||
Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password)
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
|
||||
|
||||
- Config: password
|
||||
- Env Var: RCLONE_KOOFR_PASSWORD
|
||||
- Type: string
|
||||
|
@ -181,6 +181,8 @@ User name (usually email)
|
||||
|
||||
Password
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
|
||||
|
||||
- Config: pass
|
||||
- Env Var: RCLONE_MAILRU_PASS
|
||||
- Type: string
|
||||
|
@ -168,6 +168,8 @@ User name
|
||||
|
||||
Password.
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
|
||||
|
||||
- Config: pass
|
||||
- Env Var: RCLONE_MEGA_PASS
|
||||
- Type: string
|
||||
|
@ -116,6 +116,8 @@ Username
|
||||
|
||||
Password.
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
|
||||
|
||||
- Config: password
|
||||
- Env Var: RCLONE_OPENDRIVE_PASSWORD
|
||||
- Type: string
|
||||
|
@ -294,6 +294,8 @@ User name (usually email address)
|
||||
|
||||
Password
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
|
||||
|
||||
- Config: pass
|
||||
- Env Var: RCLONE_SEAFILE_PASS
|
||||
- Type: string
|
||||
@ -321,6 +323,8 @@ Name of the library. Leave blank to access all non-encrypted libraries.
|
||||
|
||||
Library password (for encrypted libraries only). Leave blank if you pass it through the command line.
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
|
||||
|
||||
- Config: library_key
|
||||
- Env Var: RCLONE_SEAFILE_LIBRARY_KEY
|
||||
- Type: string
|
||||
|
@ -192,6 +192,8 @@ SSH port, leave blank to use default (22)
|
||||
|
||||
SSH password, leave blank to use ssh-agent.
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
|
||||
|
||||
- Config: pass
|
||||
- Env Var: RCLONE_SFTP_PASS
|
||||
- Type: string
|
||||
@ -222,6 +224,8 @@ The passphrase to decrypt the PEM-encoded private key file.
|
||||
Only PEM encrypted key files (old OpenSSH format) are supported. Encrypted keys
|
||||
in the new OpenSSH format can't be used.
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
|
||||
|
||||
- Config: key_file_pass
|
||||
- Env Var: RCLONE_SFTP_KEY_FILE_PASS
|
||||
- Type: string
|
||||
|
@ -152,6 +152,8 @@ User name
|
||||
|
||||
Password.
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
|
||||
|
||||
- Config: pass
|
||||
- Env Var: RCLONE_WEBDAV_PASS
|
||||
- Type: string
|
||||
|
@ -1 +1 @@
|
||||
v1.52.0
|
||||
v1.52.1
|
@ -1,4 +1,4 @@
|
||||
package fs
|
||||
|
||||
// Version of rclone
|
||||
var Version = "v1.52.0"
|
||||
var Version = "v1.52.1"
|
||||
|
205
rclone.1
generated
205
rclone.1
generated
@ -1,18 +1,18 @@
|
||||
.\"t
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "rclone" "1" "May 27, 2020" "User Manual" ""
|
||||
.TH "rclone" "1" "Jun 10, 2020" "User Manual" ""
|
||||
.hy
|
||||
.SH Rclone syncs your files to cloud storage
|
||||
.PP
|
||||
.IP \[bu] 2
|
||||
About rclone
|
||||
.IP \[bu] 2
|
||||
What can rclone do for you
|
||||
What can rclone do for you?
|
||||
.IP \[bu] 2
|
||||
What features does rclone have
|
||||
What features does rclone have?
|
||||
.IP \[bu] 2
|
||||
What providers does rclone support
|
||||
What providers does rclone support?
|
||||
.IP \[bu] 2
|
||||
Download (https://rclone.org/downloads/)
|
||||
.IP \[bu] 2
|
||||
@ -32,21 +32,21 @@ Rclone has powerful cloud equivalents to the unix commands rsync, cp,
|
||||
mv, mount, ls, ncdu, tree, rm, and cat.
|
||||
Rclone\[cq]s familiar syntax includes shell pipeline support, and
|
||||
\f[C]\-\-dry\-run\f[R] protection.
|
||||
It can be used at the command line, in scripts or via its API (/rc).
|
||||
It is used at the command line, in scripts or via its API (/rc).
|
||||
.PP
|
||||
Users have called rclone \f[I]\[lq]The Swiss army knife of cloud
|
||||
storage\[rq]\f[R] and \f[I]\[lq]Technology indistinguishable from
|
||||
Users call rclone \f[I]\[lq]The Swiss army knife of cloud
|
||||
storage\[rq]\f[R], and \f[I]\[lq]Technology indistinguishable from
|
||||
magic\[rq]\f[R].
|
||||
.PP
|
||||
Rclone really looks after your data.
|
||||
It preserves timestamps and verifies your data at all times.
|
||||
It preserves timestamps and verifies checksums at all times.
|
||||
Transfers over limited bandwidth; intermittent connections, or subject
|
||||
to quota can be restarted, from the last good file transferred.
|
||||
You can check (https://rclone.org/commands/rclone_check/) the integrity
|
||||
of your files.
|
||||
Where possible, rclone employs server side transfers to minimise local
|
||||
bandwidth use and transfers from one provider to another without using
|
||||
your local disk.
|
||||
local disk.
|
||||
.PP
|
||||
Virtual backends wrap local and cloud file systems to apply
|
||||
encryption (https://rclone.org/crypt/),
|
||||
@ -54,9 +54,9 @@ caching (https://rclone.org/cache/),
|
||||
chunking (https://rclone.org/chunker/) and
|
||||
joining (https://rclone.org/union/).
|
||||
.PP
|
||||
Rclone can mount (https://rclone.org/commands/rclone_mount/) any local,
|
||||
Rclone mounts (https://rclone.org/commands/rclone_mount/) any local,
|
||||
cloud or virtual filesystem as a disk on Windows, macOS, linux and
|
||||
FreeBSD, and also serve these over
|
||||
FreeBSD, and also serves these over
|
||||
SFTP (https://rclone.org/commands/rclone_serve_sftp/),
|
||||
HTTP (https://rclone.org/commands/rclone_serve_http/),
|
||||
WebDAV (https://rclone.org/commands/rclone_serve_webdav/),
|
||||
@ -72,13 +72,13 @@ For the latest version downloading from
|
||||
rclone.org (https://rclone.org/downloads/) is recommended.
|
||||
.PP
|
||||
Rclone is widely used on Linux, Windows and Mac.
|
||||
Third party developers have built innovative backup, restore, GUI and
|
||||
Third party developers create innovative backup, restore, GUI and
|
||||
business process solutions using the rclone command line or API.
|
||||
.PP
|
||||
Let rclone do the heavy lifting of communicating with cloud storage.
|
||||
.SS What can rclone do for you
|
||||
Rclone does the heavy lifting of communicating with cloud storage.
|
||||
.SS What can rclone do for you?
|
||||
.PP
|
||||
Rclone can help you:
|
||||
Rclone helps you:
|
||||
.IP \[bu] 2
|
||||
Backup (and encrypt) files to cloud storage
|
||||
.IP \[bu] 2
|
||||
@ -136,8 +136,8 @@ HTTP (https://rclone.org/commands/rclone_serve_http/)/WebDav (https://rclone.org
|
||||
Experimental Web based GUI (https://rclone.org/gui/)
|
||||
.SS Supported providers
|
||||
.PP
|
||||
(There are many other providers, built on standard protocols such as
|
||||
WebDAV or S3, that work out of the box.)
|
||||
(There are many others, built on standard protocols such as WebDAV or
|
||||
S3, that work out of the box.)
|
||||
.IP \[bu] 2
|
||||
1Fichier
|
||||
.IP \[bu] 2
|
||||
@ -3793,10 +3793,23 @@ rclone (https://rclone.org/commands/rclone/) \- Show help for rclone
|
||||
commands, flags and backends.
|
||||
.SH rclone obscure
|
||||
.PP
|
||||
Obscure password for use in the rclone.conf
|
||||
Obscure password for use in the rclone config file
|
||||
.SS Synopsis
|
||||
.PP
|
||||
Obscure password for use in the rclone.conf
|
||||
In the rclone config file, human readable passwords are obscured.
|
||||
Obscuring them is done by encrypting them and writing them out in
|
||||
base64.
|
||||
This is \f[B]not\f[R] a secure way of encrypting these passwords as
|
||||
rclone can decrypt them \- it is to prevent \[lq]eyedropping\[rq] \-
|
||||
namely someone seeing a password in the rclone config file by accident.
|
||||
.PP
|
||||
Many equally important things (like access tokens) are not obscured in
|
||||
the config file.
|
||||
However it is very hard to shoulder surf a 64 character hex token.
|
||||
.PP
|
||||
If you want to encrypt the config file then please use config file
|
||||
encryption \- see rclone
|
||||
config (https://rclone.org/commands/rclone_config/) for more info.
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
@ -13028,7 +13041,7 @@ These flags are available for every command.
|
||||
\-\-use\-json\-log Use json log format.
|
||||
\-\-use\-mmap Use mmap allocator (see docs).
|
||||
\-\-use\-server\-modtime Use server modified time instead of object metadata
|
||||
\-\-user\-agent string Set the user\-agent to a specified string. The default is rclone/ version (default \[dq]rclone/v1.52.0\[dq])
|
||||
\-\-user\-agent string Set the user\-agent to a specified string. The default is rclone/ version (default \[dq]rclone/v1.52.1\[dq])
|
||||
\-v, \-\-verbose count Print lots more stuff (repeat for more)
|
||||
\f[R]
|
||||
.fi
|
||||
@ -13090,7 +13103,7 @@ They control the backends and may be set in the config file.
|
||||
\-\-cache\-db\-wait\-time Duration How long to wait for the DB to be available \- 0 is unlimited (default 1s)
|
||||
\-\-cache\-info\-age Duration How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
|
||||
\-\-cache\-plex\-insecure string Skip all certificate verification when connecting to the Plex server
|
||||
\-\-cache\-plex\-password string The password of the Plex user
|
||||
\-\-cache\-plex\-password string The password of the Plex user (obscured)
|
||||
\-\-cache\-plex\-url string The URL of the Plex server
|
||||
\-\-cache\-plex\-username string The username of the Plex user
|
||||
\-\-cache\-read\-retries int How many times to retry a read from a cache storage. (default 10)
|
||||
@ -13110,8 +13123,8 @@ They control the backends and may be set in the config file.
|
||||
\-L, \-\-copy\-links Follow symlinks and copy the pointed to item.
|
||||
\-\-crypt\-directory\-name\-encryption Option to either encrypt directory names or leave them intact. (default true)
|
||||
\-\-crypt\-filename\-encryption string How to encrypt the filenames. (default \[dq]standard\[dq])
|
||||
\-\-crypt\-password string Password or pass phrase for encryption.
|
||||
\-\-crypt\-password2 string Password or pass phrase for salt. Optional but recommended.
|
||||
\-\-crypt\-password string Password or pass phrase for encryption. (obscured)
|
||||
\-\-crypt\-password2 string Password or pass phrase for salt. Optional but recommended. (obscured)
|
||||
\-\-crypt\-remote string Remote to encrypt/decrypt.
|
||||
\-\-crypt\-show\-mapping For all files listed show how the names encrypt.
|
||||
\-\-drive\-acknowledge\-abuse Set to allow files which return cannotDownloadAbusiveFile to be downloaded.
|
||||
@ -13162,7 +13175,7 @@ They control the backends and may be set in the config file.
|
||||
\-\-ftp\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,RightSpace,Dot)
|
||||
\-\-ftp\-host string FTP host to connect to
|
||||
\-\-ftp\-no\-check\-certificate Do not verify the TLS certificate of the server
|
||||
\-\-ftp\-pass string FTP password
|
||||
\-\-ftp\-pass string FTP password (obscured)
|
||||
\-\-ftp\-port string FTP port, leave blank to use default (21)
|
||||
\-\-ftp\-tls Use FTP over TLS (Implicit)
|
||||
\-\-ftp\-user string FTP username, leave blank for current username, $USER
|
||||
@ -13199,7 +13212,7 @@ They control the backends and may be set in the config file.
|
||||
\-\-koofr\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||
\-\-koofr\-endpoint string The Koofr API endpoint to use (default \[dq]https://app.koofr.net\[dq])
|
||||
\-\-koofr\-mountid string Mount ID of the mount to use. If omitted, the primary mount is used.
|
||||
\-\-koofr\-password string Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password)
|
||||
\-\-koofr\-password string Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password) (obscured)
|
||||
\-\-koofr\-setmtime Does the backend support setting modification time. Set this to false if you use a mount ID that points to a Dropbox or Amazon Drive backend. (default true)
|
||||
\-\-koofr\-user string Your Koofr user name
|
||||
\-l, \-\-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension
|
||||
@ -13212,7 +13225,7 @@ They control the backends and may be set in the config file.
|
||||
\-\-local\-nounc string Disable UNC (long path names) conversion on Windows
|
||||
\-\-mailru\-check\-hash What should copy do if file checksum is mismatched or invalid (default true)
|
||||
\-\-mailru\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||
\-\-mailru\-pass string Password
|
||||
\-\-mailru\-pass string Password (obscured)
|
||||
\-\-mailru\-speedup\-enable Skip full upload if there is another file with same data hash. (default true)
|
||||
\-\-mailru\-speedup\-file\-patterns string Comma separated list of file name patterns eligible for speedup (put by hash). (default \[dq]*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf\[dq])
|
||||
\-\-mailru\-speedup\-max\-disk SizeSuffix This option allows you to disable speedup (put by hash) for large files (default 3G)
|
||||
@ -13221,7 +13234,7 @@ They control the backends and may be set in the config file.
|
||||
\-\-mega\-debug Output more debug from Mega.
|
||||
\-\-mega\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot)
|
||||
\-\-mega\-hard\-delete Delete files permanently rather than putting them into the trash.
|
||||
\-\-mega\-pass string Password.
|
||||
\-\-mega\-pass string Password. (obscured)
|
||||
\-\-mega\-user string User name
|
||||
\-x, \-\-one\-file\-system Don\[aq]t cross filesystem boundaries (unix/macOS only).
|
||||
\-\-onedrive\-chunk\-size SizeSuffix Chunk size to upload files with \- must be multiple of 320k (327,680 bytes). (default 10M)
|
||||
@ -13234,7 +13247,7 @@ They control the backends and may be set in the config file.
|
||||
\-\-onedrive\-server\-side\-across\-configs Allow server side operations (eg copy) to work across different onedrive configs.
|
||||
\-\-opendrive\-chunk\-size SizeSuffix Files will be uploaded in chunks this size. (default 10M)
|
||||
\-\-opendrive\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot)
|
||||
\-\-opendrive\-password string Password.
|
||||
\-\-opendrive\-password string Password. (obscured)
|
||||
\-\-opendrive\-username string Username
|
||||
\-\-pcloud\-client\-id string Pcloud App Client Id
|
||||
\-\-pcloud\-client\-secret string Pcloud App Client Secret
|
||||
@ -13285,19 +13298,19 @@ They control the backends and may be set in the config file.
|
||||
\-\-seafile\-create\-library Should rclone create a library if it doesn\[aq]t exist
|
||||
\-\-seafile\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8)
|
||||
\-\-seafile\-library string Name of the library. Leave blank to access all non\-encrypted libraries.
|
||||
\-\-seafile\-library\-key string Library password (for encrypted libraries only). Leave blank if you pass it through the command line.
|
||||
\-\-seafile\-pass string Password
|
||||
\-\-seafile\-library\-key string Library password (for encrypted libraries only). Leave blank if you pass it through the command line. (obscured)
|
||||
\-\-seafile\-pass string Password (obscured)
|
||||
\-\-seafile\-url string URL of seafile host to connect to
|
||||
\-\-seafile\-user string User name (usually email address)
|
||||
\-\-sftp\-ask\-password Allow asking for SFTP password when needed.
|
||||
\-\-sftp\-disable\-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available.
|
||||
\-\-sftp\-host string SSH host to connect to
|
||||
\-\-sftp\-key\-file string Path to PEM\-encoded private key file, leave blank or set key\-use\-agent to use ssh\-agent.
|
||||
\-\-sftp\-key\-file\-pass string The passphrase to decrypt the PEM\-encoded private key file.
|
||||
\-\-sftp\-key\-file\-pass string The passphrase to decrypt the PEM\-encoded private key file. (obscured)
|
||||
\-\-sftp\-key\-pem string Raw PEM\-encoded private key, If specified, will override key_file parameter.
|
||||
\-\-sftp\-key\-use\-agent When set forces the usage of the ssh\-agent.
|
||||
\-\-sftp\-md5sum\-command string The command used to read md5 hashes. Leave blank for autodetect.
|
||||
\-\-sftp\-pass string SSH password, leave blank to use ssh\-agent.
|
||||
\-\-sftp\-pass string SSH password, leave blank to use ssh\-agent. (obscured)
|
||||
\-\-sftp\-path\-override string Override path used by SSH connection.
|
||||
\-\-sftp\-port string SSH port, leave blank to use default (22)
|
||||
\-\-sftp\-set\-modtime Set the modified time on the remote if set. (default true)
|
||||
@ -13355,7 +13368,7 @@ They control the backends and may be set in the config file.
|
||||
\-\-union\-upstreams string List of space separated upstreams.
|
||||
\-\-webdav\-bearer\-token string Bearer token instead of user/pass (eg a Macaroon)
|
||||
\-\-webdav\-bearer\-token\-command string Command to run to get a bearer token
|
||||
\-\-webdav\-pass string Password.
|
||||
\-\-webdav\-pass string Password. (obscured)
|
||||
\-\-webdav\-url string URL of http host to connect to
|
||||
\-\-webdav\-user string User name
|
||||
\-\-webdav\-vendor string Name of the Webdav site/service/software you are using
|
||||
@ -18490,6 +18503,9 @@ Default: \[dq]\[dq]
|
||||
.SS \[en]cache\-plex\-password
|
||||
.PP
|
||||
The password of the Plex user
|
||||
.PP
|
||||
\f[B]NB\f[R] Input to this must be obscured \- see rclone
|
||||
obscure (https://rclone.org/commands/rclone_obscure/).
|
||||
.IP \[bu] 2
|
||||
Config: plex_password
|
||||
.IP \[bu] 2
|
||||
@ -20145,6 +20161,9 @@ Don\[cq]t encrypt directory names, leave them intact.
|
||||
.SS \[en]crypt\-password
|
||||
.PP
|
||||
Password or pass phrase for encryption.
|
||||
.PP
|
||||
\f[B]NB\f[R] Input to this must be obscured \- see rclone
|
||||
obscure (https://rclone.org/commands/rclone_obscure/).
|
||||
.IP \[bu] 2
|
||||
Config: password
|
||||
.IP \[bu] 2
|
||||
@ -20158,6 +20177,9 @@ Default: \[dq]\[dq]
|
||||
Password or pass phrase for salt.
|
||||
Optional but recommended.
|
||||
Should be different to the previous password.
|
||||
.PP
|
||||
\f[B]NB\f[R] Input to this must be obscured \- see rclone
|
||||
obscure (https://rclone.org/commands/rclone_obscure/).
|
||||
.IP \[bu] 2
|
||||
Config: password2
|
||||
.IP \[bu] 2
|
||||
@ -20929,6 +20951,9 @@ Default: \[dq]\[dq]
|
||||
.SS \[en]ftp\-pass
|
||||
.PP
|
||||
FTP password
|
||||
.PP
|
||||
\f[B]NB\f[R] Input to this must be obscured \- see rclone
|
||||
obscure (https://rclone.org/commands/rclone_obscure/).
|
||||
.IP \[bu] 2
|
||||
Config: pass
|
||||
.IP \[bu] 2
|
||||
@ -22215,7 +22240,8 @@ shortcut is deleted not the linked folder.
|
||||
\f[C]rclone mount\f[R] the contents of the linked folder will be
|
||||
deleted.
|
||||
.PP
|
||||
It isn\[cq]t currently possible to create shortcuts with rclone.
|
||||
The rclone backend (https://rclone.org/commands/rclone_backend/) command
|
||||
can be used to create shortcuts.
|
||||
.PP
|
||||
Shortcuts can be completely ignored with the
|
||||
\f[C]\-\-drive\-skip\-shortcuts\f[R] flag or the corresponding
|
||||
@ -24748,6 +24774,9 @@ Default: \[dq]\[dq]
|
||||
.PP
|
||||
Your Koofr password for rclone (generate one at
|
||||
https://app.koofr.net/app/admin/preferences/password)
|
||||
.PP
|
||||
\f[B]NB\f[R] Input to this must be obscured \- see rclone
|
||||
obscure (https://rclone.org/commands/rclone_obscure/).
|
||||
.IP \[bu] 2
|
||||
Config: password
|
||||
.IP \[bu] 2
|
||||
@ -25084,6 +25113,9 @@ Default: \[dq]\[dq]
|
||||
.SS \[en]mailru\-pass
|
||||
.PP
|
||||
Password
|
||||
.PP
|
||||
\f[B]NB\f[R] Input to this must be obscured \- see rclone
|
||||
obscure (https://rclone.org/commands/rclone_obscure/).
|
||||
.IP \[bu] 2
|
||||
Config: pass
|
||||
.IP \[bu] 2
|
||||
@ -25520,6 +25552,9 @@ Default: \[dq]\[dq]
|
||||
.SS \[en]mega\-pass
|
||||
.PP
|
||||
Password.
|
||||
.PP
|
||||
\f[B]NB\f[R] Input to this must be obscured \- see rclone
|
||||
obscure (https://rclone.org/commands/rclone_obscure/).
|
||||
.IP \[bu] 2
|
||||
Config: pass
|
||||
.IP \[bu] 2
|
||||
@ -26959,6 +26994,9 @@ Default: \[dq]\[dq]
|
||||
.SS \[en]opendrive\-password
|
||||
.PP
|
||||
Password.
|
||||
.PP
|
||||
\f[B]NB\f[R] Input to this must be obscured \- see rclone
|
||||
obscure (https://rclone.org/commands/rclone_obscure/).
|
||||
.IP \[bu] 2
|
||||
Config: password
|
||||
.IP \[bu] 2
|
||||
@ -28998,6 +29036,9 @@ Default: \[dq]\[dq]
|
||||
.SS \[en]seafile\-pass
|
||||
.PP
|
||||
Password
|
||||
.PP
|
||||
\f[B]NB\f[R] Input to this must be obscured \- see rclone
|
||||
obscure (https://rclone.org/commands/rclone_obscure/).
|
||||
.IP \[bu] 2
|
||||
Config: pass
|
||||
.IP \[bu] 2
|
||||
@ -29033,6 +29074,9 @@ Default: \[dq]\[dq]
|
||||
.PP
|
||||
Library password (for encrypted libraries only).
|
||||
Leave blank if you pass it through the command line.
|
||||
.PP
|
||||
\f[B]NB\f[R] Input to this must be obscured \- see rclone
|
||||
obscure (https://rclone.org/commands/rclone_obscure/).
|
||||
.IP \[bu] 2
|
||||
Config: library_key
|
||||
.IP \[bu] 2
|
||||
@ -29322,6 +29366,9 @@ Default: \[dq]\[dq]
|
||||
.SS \[en]sftp\-pass
|
||||
.PP
|
||||
SSH password, leave blank to use ssh\-agent.
|
||||
.PP
|
||||
\f[B]NB\f[R] Input to this must be obscured \- see rclone
|
||||
obscure (https://rclone.org/commands/rclone_obscure/).
|
||||
.IP \[bu] 2
|
||||
Config: pass
|
||||
.IP \[bu] 2
|
||||
@ -29360,6 +29407,9 @@ The passphrase to decrypt the PEM\-encoded private key file.
|
||||
.PP
|
||||
Only PEM encrypted key files (old OpenSSH format) are supported.
|
||||
Encrypted keys in the new OpenSSH format can\[cq]t be used.
|
||||
.PP
|
||||
\f[B]NB\f[R] Input to this must be obscured \- see rclone
|
||||
obscure (https://rclone.org/commands/rclone_obscure/).
|
||||
.IP \[bu] 2
|
||||
Config: key_file_pass
|
||||
.IP \[bu] 2
|
||||
@ -30918,6 +30968,9 @@ Default: \[dq]\[dq]
|
||||
.SS \[en]webdav\-pass
|
||||
.PP
|
||||
Password.
|
||||
.PP
|
||||
\f[B]NB\f[R] Input to this must be obscured \- see rclone
|
||||
obscure (https://rclone.org/commands/rclone_obscure/).
|
||||
.IP \[bu] 2
|
||||
Config: pass
|
||||
.IP \[bu] 2
|
||||
@ -32170,6 +32223,90 @@ Options:
|
||||
.IP \[bu] 2
|
||||
\[lq]error\[rq]: return an error based on option value
|
||||
.SH Changelog
|
||||
.SS v1.52.1 \- 2020\-06\-10
|
||||
.PP
|
||||
See commits (https://github.com/rclone/rclone/compare/v1.52.0...v1.52.1)
|
||||
.IP \[bu] 2
|
||||
Bug Fixes
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
lib/file: Fix SetSparse on Windows 7 which fixes downloads of files >
|
||||
250MB (Nick Craig\-Wood)
|
||||
.IP \[bu] 2
|
||||
build
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
Update go.mod to go1.14 to enable \-mod=vendor build (Nick Craig\-Wood)
|
||||
.IP \[bu] 2
|
||||
Remove quicktest from Dockerfile (Nick Craig\-Wood)
|
||||
.IP \[bu] 2
|
||||
Build Docker images with GitHub actions (Matteo Pietro Dazzi)
|
||||
.IP \[bu] 2
|
||||
Update Docker build workflows (Nick Craig\-Wood)
|
||||
.IP \[bu] 2
|
||||
Set user_allow_other in /etc/fuse.conf in the Docker image (Nick
|
||||
Craig\-Wood)
|
||||
.IP \[bu] 2
|
||||
Fix xgo build after go1.14 go.mod update (Nick Craig\-Wood)
|
||||
.RE
|
||||
.IP \[bu] 2
|
||||
docs
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
Add link to source and modified time to footer of every page (Nick
|
||||
Craig\-Wood)
|
||||
.IP \[bu] 2
|
||||
Remove manually set dates and use git dates instead (Nick Craig\-Wood)
|
||||
.IP \[bu] 2
|
||||
Minor tense, punctuation, brevity and positivity changes for the home
|
||||
page (edwardxml)
|
||||
.IP \[bu] 2
|
||||
Remove leading slash in page reference in footer when present (Nick
|
||||
Craig\-Wood)
|
||||
.IP \[bu] 2
|
||||
Note commands which need obscured input in the docs (Nick Craig\-Wood)
|
||||
.IP \[bu] 2
|
||||
obscure: Write more help as we are referencing it elsewhere (Nick
|
||||
Craig\-Wood)
|
||||
.RE
|
||||
.RE
|
||||
.IP \[bu] 2
|
||||
VFS
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
Fix OS vs Unix path confusion \- fixes ChangeNotify on Windows (Nick
|
||||
Craig\-Wood)
|
||||
.RE
|
||||
.IP \[bu] 2
|
||||
Drive
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
Fix missing items when listing using \[en]fast\-list / ListR (Nick
|
||||
Craig\-Wood)
|
||||
.RE
|
||||
.IP \[bu] 2
|
||||
Putio
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
Fix panic on Object.Open (Cenk Alti)
|
||||
.RE
|
||||
.IP \[bu] 2
|
||||
S3
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
Fix upload of single files into buckets without create permission (Nick
|
||||
Craig\-Wood)
|
||||
.IP \[bu] 2
|
||||
Fix \[en]header\-upload (Nick Craig\-Wood)
|
||||
.RE
|
||||
.IP \[bu] 2
|
||||
Tardigrade
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
Fix listing bug by upgrading to v1.0.7
|
||||
.IP \[bu] 2
|
||||
Set UserAgent to rclone (Caleb Case)
|
||||
.RE
|
||||
.SS v1.52.0 \- 2020\-05\-27
|
||||
.PP
|
||||
Special thanks to Martin Michlmayr for proof reading and correcting all
|
||||
|
Loading…
Reference in New Issue
Block a user