From 74b8cbfb841c1b5491d5f840b2c541e91177bd6c Mon Sep 17 00:00:00 2001 From: Nick Craig-Wood Date: Fri, 22 May 2020 12:22:52 +0100 Subject: [PATCH] docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain any more. --- Makefile | 1 + backend/tardigrade/fs.go | 2 +- bin/make_backend_docs.py | 7 +- bin/make_manual.py | 10 +- bin/make_rc_docs.sh | 4 +- cmd/config/config.go | 18 +- cmd/ncdu/ncdu.go | 2 +- cmd/serve/restic/restic.go | 2 +- docs/config.json | 2 +- docs/content/_index.md | 12 +- docs/content/alias.md | 6 +- docs/content/amazonclouddrive.md | 6 +- docs/content/authors.md | 4 +- docs/content/azureblob.md | 40 +- docs/content/b2.md | 11 +- docs/content/box.md | 6 +- docs/content/cache.md | 34 +- docs/content/chunker.md | 6 +- docs/content/commands/rclone.md | 2 +- docs/content/commands/rclone_about.md | 2 +- docs/content/commands/rclone_authorize.md | 2 +- docs/content/commands/rclone_backend.md | 2 +- docs/content/commands/rclone_cat.md | 2 +- docs/content/commands/rclone_check.md | 2 +- docs/content/commands/rclone_cleanup.md | 2 +- docs/content/commands/rclone_config.md | 4 +- docs/content/commands/rclone_config_create.md | 8 +- docs/content/commands/rclone_config_delete.md | 10 +- .../commands/rclone_config_disconnect.md | 2 +- docs/content/commands/rclone_config_dump.md | 2 +- docs/content/commands/rclone_config_edit.md | 2 +- docs/content/commands/rclone_config_file.md | 2 +- .../commands/rclone_config_password.md | 6 +- .../commands/rclone_config_providers.md | 2 +- .../commands/rclone_config_reconnect.md | 2 +- docs/content/commands/rclone_config_show.md | 2 +- docs/content/commands/rclone_config_update.md | 6 +- .../commands/rclone_config_userinfo.md | 2 +- docs/content/commands/rclone_copy.md | 2 +- docs/content/commands/rclone_copyto.md | 2 +- docs/content/commands/rclone_copyurl.md | 2 +- docs/content/commands/rclone_cryptcheck.md | 2 +- docs/content/commands/rclone_cryptdecode.md | 2 +- docs/content/commands/rclone_dedupe.md | 2 +- docs/content/commands/rclone_delete.md | 2 +- docs/content/commands/rclone_deletefile.md | 2 +- .../commands/rclone_genautocomplete.md | 2 +- .../commands/rclone_genautocomplete_bash.md | 2 +- .../commands/rclone_genautocomplete_fish.md | 2 +- .../commands/rclone_genautocomplete_zsh.md | 2 +- docs/content/commands/rclone_gendocs.md | 2 +- docs/content/commands/rclone_hashsum.md | 2 +- docs/content/commands/rclone_link.md | 2 +- docs/content/commands/rclone_listremotes.md | 2 +- docs/content/commands/rclone_ls.md | 2 +- docs/content/commands/rclone_lsd.md | 2 +- docs/content/commands/rclone_lsf.md | 2 +- docs/content/commands/rclone_lsjson.md | 2 +- docs/content/commands/rclone_lsl.md | 2 +- docs/content/commands/rclone_md5sum.md | 2 +- docs/content/commands/rclone_mkdir.md | 2 +- docs/content/commands/rclone_mount.md | 2 +- docs/content/commands/rclone_move.md | 2 +- docs/content/commands/rclone_moveto.md | 2 +- docs/content/commands/rclone_ncdu.md | 4 +- docs/content/commands/rclone_obscure.md | 2 +- docs/content/commands/rclone_purge.md | 2 +- docs/content/commands/rclone_rc.md | 2 +- docs/content/commands/rclone_rcat.md | 2 +- docs/content/commands/rclone_rcd.md | 2 +- docs/content/commands/rclone_rmdir.md | 2 +- docs/content/commands/rclone_rmdirs.md | 2 +- docs/content/commands/rclone_serve.md | 2 +- docs/content/commands/rclone_serve_dlna.md | 2 +- docs/content/commands/rclone_serve_ftp.md | 2 +- docs/content/commands/rclone_serve_http.md | 2 +- docs/content/commands/rclone_serve_restic.md | 4 +- docs/content/commands/rclone_serve_sftp.md | 2 +- docs/content/commands/rclone_serve_webdav.md | 2 +- docs/content/commands/rclone_settier.md | 2 +- docs/content/commands/rclone_sha1sum.md | 2 +- docs/content/commands/rclone_size.md | 2 +- docs/content/commands/rclone_sync.md | 2 +- docs/content/commands/rclone_touch.md | 2 +- docs/content/commands/rclone_tree.md | 2 +- docs/content/commands/rclone_version.md | 2 +- docs/content/crypt.md | 55 +- docs/content/donate.md | 51 +- docs/content/drive.md | 90 ++- docs/content/dropbox.md | 6 +- docs/content/fichier.md | 6 +- docs/content/flags.md | 648 +++++++++--------- docs/content/ftp.md | 6 +- docs/content/googlecloudstorage.md | 6 +- docs/content/googlephotos.md | 15 +- docs/content/http.md | 6 +- docs/content/hubic.md | 6 +- docs/content/jottacloud.md | 6 +- docs/content/koofr.md | 6 +- docs/content/local.md | 22 +- docs/content/mailru.md | 6 +- docs/content/mega.md | 6 +- docs/content/memory.md | 6 +- docs/content/onedrive.md | 25 +- docs/content/opendrive.md | 6 +- docs/content/overview.md | 2 +- docs/content/pcloud.md | 6 +- docs/content/premiumizeme.md | 6 +- docs/content/putio.md | 6 +- docs/content/qingstor.md | 8 +- docs/content/rc.md | 6 +- docs/content/s3.md | 101 ++- docs/content/seafile.md | 28 +- docs/content/sftp.md | 15 +- docs/content/sharefile.md | 6 +- docs/content/sugarsync.md | 6 +- docs/content/swift.md | 6 +- docs/content/tardigrade.md | 10 +- docs/content/union.md | 12 +- docs/content/webdav.md | 6 +- docs/content/yandex.md | 6 +- docs/layouts/shortcodes/asciinema.html | 1 + docs/layouts/shortcodes/color.html | 1 + docs/layouts/shortcodes/icon.html | 1 + docs/layouts/shortcodes/img.html | 1 + .../layouts/shortcodes/monthly_donations.html | 16 + .../layouts/shortcodes/one_off_donations.html | 25 + docs/layouts/shortcodes/rem.html | 0 128 files changed, 945 insertions(+), 645 deletions(-) create mode 100644 docs/layouts/shortcodes/asciinema.html create mode 100644 docs/layouts/shortcodes/color.html create mode 100644 docs/layouts/shortcodes/icon.html create mode 100644 docs/layouts/shortcodes/img.html create mode 100644 docs/layouts/shortcodes/monthly_donations.html create mode 100644 docs/layouts/shortcodes/one_off_donations.html create mode 100644 docs/layouts/shortcodes/rem.html diff --git a/Makefile b/Makefile index c9c9deed2..05a7e6df0 100644 --- a/Makefile +++ b/Makefile @@ -138,6 +138,7 @@ clean: website: rm -rf docs/public cd docs && hugo + @if grep -R "raw HTML omitted" docs/public ; then echo "ERROR: found unescaped HTML - fix the markdown source" ; fi upload_website: website rclone -v sync docs/public memstore:www-rclone-org diff --git a/backend/tardigrade/fs.go b/backend/tardigrade/fs.go index 1a08f5cba..13ceaf6c3 100644 --- a/backend/tardigrade/fs.go +++ b/backend/tardigrade/fs.go @@ -103,7 +103,7 @@ func init() { }, { Name: "satellite_address", - Help: "Satellite Address. Custom satellite address should match the format: @
:.", + Help: "Satellite Address. Custom satellite address should match the format: `@
:`.", Required: false, Provider: newProvider, Default: "us-central-1.tardigrade.io", diff --git a/bin/make_backend_docs.py b/bin/make_backend_docs.py index b3df88808..a1391229d 100755 --- a/bin/make_backend_docs.py +++ b/bin/make_backend_docs.py @@ -7,9 +7,10 @@ import os import io import subprocess -marker = "\n" % (backend, backend) + start_full = (start + "\" - DO NOT EDIT - instead edit fs.RegInfo in backend/%s/%s.go then run make backenddocs\" " + end + "\n") % (backend, backend) out_file.write(start_full) output_docs(backend, out_file) output_backend_tool_docs(backend, out_file) - out_file.write(stop+" -->\n") + out_file.write(stop+" "+end+"\n") altered = True if not in_docs: out_file.write(line) diff --git a/bin/make_manual.py b/bin/make_manual.py index 26cd64512..5899642dd 100755 --- a/bin/make_manual.py +++ b/bin/make_manual.py @@ -111,15 +111,21 @@ def read_doc(doc): contents = parts[2].strip()+"\n\n" # Remove icons contents = re.sub(r'}} + contents = re.sub(r'\{\{<\s*img\s+(.*?)>\}\}', r"", contents) # Make any img tags absolute contents = re.sub(r'(', "- [Donate.](https://rclone.org/donate/)", contents) + contents = re.sub(r'\{\{< rem MAINPAGELINK >\}\}', "- [Donate.](https://rclone.org/donate/)", contents) # Interpret provider shortcode # {{< provider name="Amazon S3" home="https://aws.amazon.com/s3/" config="/s3/" >}} - contents = re.sub(r'\{\{<\s+provider.*?name="(.*?)".*?>\}\}', r"- \1", contents) + contents = re.sub(r'\{\{<\s*provider.*?name="(.*?)".*?>\}\}', r"- \1", contents) + # Remove remaining shortcodes + contents = re.sub(r'\{\{<.*?>\}\}', r"", contents) + contents = re.sub(r'\{\{%.*?%\}\}', r"", contents) return contents def check_docs(docpath): diff --git a/bin/make_rc_docs.sh b/bin/make_rc_docs.sh index 279e6302b..55520228c 100755 --- a/bin/make_rc_docs.sh +++ b/bin/make_rc_docs.sh @@ -15,8 +15,8 @@ fusermount -u -z /tmp/rclone/rc_mount > /dev/null 2>&1 || umount /tmp/rclone/rc_ awk ' BEGIN {p=1} - /^ +{{< rem MAINPAGELINK >}} ## About rclone {#about} @@ -156,7 +156,7 @@ such as WebDAV or S3 that work out of the box. Links - * [Home page](https://rclone.org/) - * [GitHub project page for source and bug tracker](https://github.com/rclone/rclone) - * [Rclone Forum](https://forum.rclone.org) - * [Downloads](/downloads/) + * {{< icon "fa fa-home" >}} [Home page](https://rclone.org/) + * {{< icon "fab fa-github" >}} [GitHub project page for source and bug tracker](https://github.com/rclone/rclone) + * {{< icon "fa fa-comments" >}} [Rclone Forum](https://forum.rclone.org) + * {{< icon "fas fa-cloud-download-alt" >}}[Downloads](/downloads/) diff --git a/docs/content/alias.md b/docs/content/alias.md index d47b32d90..e52a5a751 100644 --- a/docs/content/alias.md +++ b/docs/content/alias.md @@ -4,7 +4,7 @@ description: "Remote Aliases" date: "2018-01-30" --- - Alias +{{< icon "fa fa-link" >}} Alias ----------------------------------------- The `alias` remote provides a new name for another remote. @@ -88,7 +88,7 @@ Copy another local directory to the alias directory called source rclone copy /home/source remote:source - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/alias/alias.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to alias (Alias for an existing remote). @@ -103,4 +103,4 @@ Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path". - Type: string - Default: "" - +{{< rem autogenerated options stop >}} diff --git a/docs/content/amazonclouddrive.md b/docs/content/amazonclouddrive.md index 9d69390fa..3e53c049e 100644 --- a/docs/content/amazonclouddrive.md +++ b/docs/content/amazonclouddrive.md @@ -4,7 +4,7 @@ description: "Rclone docs for Amazon Drive" date: "2017-06-10" --- - Amazon Drive +{{< icon "fab fa-amazon" >}} Amazon Drive ----------------------------------------- Amazon Drive, formerly known as Amazon Cloud Drive, is a cloud storage @@ -159,7 +159,7 @@ Let's say you usually use `amazon.co.uk`. When you authenticate with rclone it will take you to an `amazon.com` page to log in. Your `amazon.co.uk` email and password should work here just fine. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/amazonclouddrive/amazonclouddrive.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to amazon cloud drive (Amazon Drive). @@ -273,7 +273,7 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Type: MultiEncoder - Default: Slash,InvalidUtf8,Dot - +{{< rem autogenerated options stop >}} ### Limitations ### diff --git a/docs/content/authors.md b/docs/content/authors.md index c68141536..23d06de08 100644 --- a/docs/content/authors.md +++ b/docs/content/authors.md @@ -12,9 +12,9 @@ Authors Contributors ------------ - +put them back in again.` >}} * Alex Couper * Leonid Shalupov diff --git a/docs/content/azureblob.md b/docs/content/azureblob.md index e79af93ab..d25a5a372 100644 --- a/docs/content/azureblob.md +++ b/docs/content/azureblob.md @@ -4,7 +4,7 @@ description: "Rclone docs for Microsoft Azure Blob Storage" date: "2017-07-30" --- - Microsoft Azure Blob Storage +{{< icon "fab fa-windows" >}} Microsoft Azure Blob Storage ----------------------------------------- Paths are specified as `remote:container` (or `remote:` for the `lsd` @@ -168,7 +168,7 @@ upload which means that there is a limit of 9.5TB of multipart uploads in progress as Azure won't allow more than that amount of uncommitted blocks. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/azureblob/azureblob.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to azureblob (Microsoft Azure Blob Storage). @@ -282,6 +282,40 @@ tiering blob to "Hot" or "Cool". - Type: string - Default: "" +#### --azureblob-disable-checksum + +Don't store MD5 checksum with object metadata. + +Normally rclone will calculate the MD5 checksum of the input before +uploading it so it can add it to metadata on the object. This is great +for data integrity checking but can cause long delays for large files +to start uploading. + +- Config: disable_checksum +- Env Var: RCLONE_AZUREBLOB_DISABLE_CHECKSUM +- Type: bool +- Default: false + +#### --azureblob-memory-pool-flush-time + +How often internal memory buffer pools will be flushed. +Uploads which requires additional buffers (f.e multipart) will use memory pool for allocations. +This option controls how often unused buffers will be removed from the pool. + +- Config: memory_pool_flush_time +- Env Var: RCLONE_AZUREBLOB_MEMORY_POOL_FLUSH_TIME +- Type: Duration +- Default: 1m0s + +#### --azureblob-memory-pool-use-mmap + +Whether to use mmap buffers in internal memory pool. + +- Config: memory_pool_use_mmap +- Env Var: RCLONE_AZUREBLOB_MEMORY_POOL_USE_MMAP +- Type: bool +- Default: false + #### --azureblob-encoding This sets the encoding for the backend. @@ -293,7 +327,7 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Type: MultiEncoder - Default: Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8 - +{{< rem autogenerated options stop >}} ### Limitations ### diff --git a/docs/content/b2.md b/docs/content/b2.md index 93f4ba90c..63606b72e 100644 --- a/docs/content/b2.md +++ b/docs/content/b2.md @@ -4,7 +4,7 @@ description: "Backblaze B2" date: "2016-10-25" --- -Backblaze B2 +{{< icon "fa fa-fire" >}} Backblaze B2 ---------------------------------------- B2 is [Backblaze's cloud storage system](https://www.backblaze.com/b2/). @@ -319,7 +319,7 @@ https://f002.backblazeb2.com/file/bucket/path/folder/file3?Authorization=xxxxxxx ``` - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/b2/b2.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to b2 (Backblaze B2). @@ -426,6 +426,11 @@ minimum size. Disable checksums for large (> upload cutoff) files +Normally rclone will calculate the SHA1 checksum of the input before +uploading it so it can add it to metadata on the object. This is great +for data integrity checking but can cause long delays for large files +to start uploading. + - Config: disable_checksum - Env Var: RCLONE_B2_DISABLE_CHECKSUM - Type: bool @@ -468,5 +473,5 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Type: MultiEncoder - Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot - +{{< rem autogenerated options stop >}} diff --git a/docs/content/box.md b/docs/content/box.md index 447096e17..bdb01f385 100644 --- a/docs/content/box.md +++ b/docs/content/box.md @@ -4,7 +4,7 @@ description: "Rclone docs for Box" date: "2015-10-14" --- - Box +{{< icon "fa fa-archive" >}} Box ----------------------------------------- Paths are specified as `remote:path` @@ -249,7 +249,7 @@ So if the folder you want rclone to use has a URL which looks like in the browser, then you use `11xxxxxxxxx8` as the `root_folder_id` in the config. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/box/box.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to box (Box). @@ -340,7 +340,7 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Type: MultiEncoder - Default: Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot - +{{< rem autogenerated options stop >}} ### Limitations ### diff --git a/docs/content/cache.md b/docs/content/cache.md index f4e67e324..510a3c613 100644 --- a/docs/content/cache.md +++ b/docs/content/cache.md @@ -4,7 +4,7 @@ description: "Rclone docs for cache remote" date: "2017-09-03" --- - Cache (BETA) +{{< icon "fa fa-archive" >}} Cache (BETA) ----------------------------------------- The `cache` remote wraps another existing remote and stores file structure @@ -257,13 +257,13 @@ using the `crypt` remote. `crypt` uses a similar technique to wrap around an existing remote and handles this translation in a seamless way. There is an issue with wrapping the remotes in this order: -**cloud remote** -> **crypt** -> **cache** +{{}}**cloud remote** -> **crypt** -> **cache**{{}} During testing, I experienced a lot of bans with the remotes in this order. I suspect it might be related to how crypt opens files on the cloud provider which makes it think we're downloading the full file instead of small chunks. Organizing the remotes in this order yields better results: -**cloud remote** -> **cache** -> **crypt** +{{}}**cloud remote** -> **cache** -> **crypt**{{}} #### absolute remote paths #### @@ -290,7 +290,7 @@ Params: - **remote** = path to remote **(required)** - **withData** = true/false to delete cached data (chunks) as well _(optional, false by default)_ - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/cache/cache.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to cache (Cache a remote). @@ -405,7 +405,7 @@ The plex token for authentication - auto set normally #### --cache-plex-insecure -Skip all certificate verification when connecting to the Plex server +Skip all certificate verifications when connecting to the Plex server - Config: plex_insecure - Env Var: RCLONE_CACHE_PLEX_INSECURE @@ -601,4 +601,26 @@ If you set it to 0 then it will wait forever. - Type: Duration - Default: 1s - +### Backend commands + +Here are the commands specific to the cache backend. + +Run them with with + + rclone backend COMMAND remote: + +The help below will explain what arguments each command takes. + +See [the "rclone backend" command](/commands/rclone_backend/) for more +info on how to pass options and arguments. + +These can be run on a running backend using the rc command +[backend/command](/rc/#backend/command). + +#### stats + +Print stats on the cache backend in JSON format. + + rclone backend stats remote: [options] [+] + +{{< rem autogenerated options stop >}} diff --git a/docs/content/chunker.md b/docs/content/chunker.md index 27dd19a8c..b0db86f9f 100644 --- a/docs/content/chunker.md +++ b/docs/content/chunker.md @@ -4,7 +4,7 @@ description: "Split-chunking overlay remote" date: "2019-08-30" --- -Chunker (BETA) +{{< icon "fa fa-cut" >}}Chunker (BETA) ---------------------------------------- The `chunker` overlay transparently splits large files into smaller chunks @@ -301,7 +301,7 @@ that property (so you can't have a file called "Hello.doc" and "hello.doc" in the same directory). - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/chunker/chunker.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to chunker (Transparently chunk/split large files). @@ -408,4 +408,4 @@ Choose how chunker should handle files with missing or invalid chunks. - "false" - Warn user, skip incomplete file and proceed. - +{{< rem autogenerated options stop >}} diff --git a/docs/content/commands/rclone.md b/docs/content/commands/rclone.md index 705ebc1cc..1dc478802 100644 --- a/docs/content/commands/rclone.md +++ b/docs/content/commands/rclone.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone" description: "Show help for rclone commands, flags and backends." slug: rclone diff --git a/docs/content/commands/rclone_about.md b/docs/content/commands/rclone_about.md index c12c74c6d..d7c1f2791 100644 --- a/docs/content/commands/rclone_about.md +++ b/docs/content/commands/rclone_about.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone about" description: "Get quota information from the remote." slug: rclone_about diff --git a/docs/content/commands/rclone_authorize.md b/docs/content/commands/rclone_authorize.md index c67a1ea84..4a13ae8d0 100644 --- a/docs/content/commands/rclone_authorize.md +++ b/docs/content/commands/rclone_authorize.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone authorize" description: "Remote authorization." slug: rclone_authorize diff --git a/docs/content/commands/rclone_backend.md b/docs/content/commands/rclone_backend.md index 415f72854..17372c1e5 100644 --- a/docs/content/commands/rclone_backend.md +++ b/docs/content/commands/rclone_backend.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone backend" description: "Run a backend specific command." slug: rclone_backend diff --git a/docs/content/commands/rclone_cat.md b/docs/content/commands/rclone_cat.md index 2b229806f..1c00df65b 100644 --- a/docs/content/commands/rclone_cat.md +++ b/docs/content/commands/rclone_cat.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone cat" description: "Concatenates any files and sends them to stdout." slug: rclone_cat diff --git a/docs/content/commands/rclone_check.md b/docs/content/commands/rclone_check.md index 2bf483f4b..aefa968ea 100644 --- a/docs/content/commands/rclone_check.md +++ b/docs/content/commands/rclone_check.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone check" description: "Checks the files in the source and destination match." slug: rclone_check diff --git a/docs/content/commands/rclone_cleanup.md b/docs/content/commands/rclone_cleanup.md index b593b80b6..049428a22 100644 --- a/docs/content/commands/rclone_cleanup.md +++ b/docs/content/commands/rclone_cleanup.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone cleanup" description: "Clean up the remote if possible" slug: rclone_cleanup diff --git a/docs/content/commands/rclone_config.md b/docs/content/commands/rclone_config.md index 027049506..558a80bba 100644 --- a/docs/content/commands/rclone_config.md +++ b/docs/content/commands/rclone_config.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone config" description: "Enter an interactive configuration session." slug: rclone_config @@ -33,7 +33,7 @@ See the [global flags page](/flags/) for global options not listed here. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone config create](/commands/rclone_config_create/) - Create a new remote with name, type and options. -* [rclone config delete](/commands/rclone_config_delete/) - Delete an existing remote . +* [rclone config delete](/commands/rclone_config_delete/) - Delete an existing remote `name`. * [rclone config disconnect](/commands/rclone_config_disconnect/) - Disconnects user from remote * [rclone config dump](/commands/rclone_config_dump/) - Dump the config file as JSON. * [rclone config edit](/commands/rclone_config_edit/) - Enter an interactive configuration session. diff --git a/docs/content/commands/rclone_config_create.md b/docs/content/commands/rclone_config_create.md index 94424f300..4d9d4bf2b 100644 --- a/docs/content/commands/rclone_config_create.md +++ b/docs/content/commands/rclone_config_create.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone config create" description: "Create a new remote with name, type and options." slug: rclone_config_create @@ -13,8 +13,8 @@ Create a new remote with name, type and options. ## Synopsis -Create a new remote of with and options. The options -should be passed in in pairs of . +Create a new remote of `name` with `type` and options. The options +should be passed in in pairs of `key` `value`. For example to make a swift remote of name myremote using auto config you would do: @@ -45,7 +45,7 @@ using remote authorization you would do this: ``` -rclone config create [ ]* [flags] +rclone config create `name` `type` [`key` `value`]* [flags] ``` ## Options diff --git a/docs/content/commands/rclone_config_delete.md b/docs/content/commands/rclone_config_delete.md index 92111dbb2..02c9aeebc 100644 --- a/docs/content/commands/rclone_config_delete.md +++ b/docs/content/commands/rclone_config_delete.md @@ -1,21 +1,21 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone config delete" -description: "Delete an existing remote ." +description: "Delete an existing remote `name`." slug: rclone_config_delete url: /commands/rclone_config_delete/ # autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/delete/ and as part of making a release run "make commanddocs" --- # rclone config delete -Delete an existing remote . +Delete an existing remote `name`. ## Synopsis -Delete an existing remote . +Delete an existing remote `name`. ``` -rclone config delete [flags] +rclone config delete `name` [flags] ``` ## Options diff --git a/docs/content/commands/rclone_config_disconnect.md b/docs/content/commands/rclone_config_disconnect.md index 46a8f2a33..c2ada9c39 100644 --- a/docs/content/commands/rclone_config_disconnect.md +++ b/docs/content/commands/rclone_config_disconnect.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone config disconnect" description: "Disconnects user from remote" slug: rclone_config_disconnect diff --git a/docs/content/commands/rclone_config_dump.md b/docs/content/commands/rclone_config_dump.md index c0bd07ca6..f12b23b92 100644 --- a/docs/content/commands/rclone_config_dump.md +++ b/docs/content/commands/rclone_config_dump.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone config dump" description: "Dump the config file as JSON." slug: rclone_config_dump diff --git a/docs/content/commands/rclone_config_edit.md b/docs/content/commands/rclone_config_edit.md index 11feb27ce..11aaad64b 100644 --- a/docs/content/commands/rclone_config_edit.md +++ b/docs/content/commands/rclone_config_edit.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone config edit" description: "Enter an interactive configuration session." slug: rclone_config_edit diff --git a/docs/content/commands/rclone_config_file.md b/docs/content/commands/rclone_config_file.md index 4d2fb9943..74d8e34f5 100644 --- a/docs/content/commands/rclone_config_file.md +++ b/docs/content/commands/rclone_config_file.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone config file" description: "Show path of configuration file in use." slug: rclone_config_file diff --git a/docs/content/commands/rclone_config_password.md b/docs/content/commands/rclone_config_password.md index f6e3d69ad..e7ffc61cf 100644 --- a/docs/content/commands/rclone_config_password.md +++ b/docs/content/commands/rclone_config_password.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone config password" description: "Update password in an existing remote." slug: rclone_config_password @@ -14,7 +14,7 @@ Update password in an existing remote. Update an existing remote's password. The password -should be passed in in pairs of . +should be passed in in pairs of `key` `value`. For example to set password of a remote of name myremote you would do: @@ -25,7 +25,7 @@ both support obscuring passwords directly. ``` -rclone config password [ ]+ [flags] +rclone config password `name` [`key` `value`]+ [flags] ``` ## Options diff --git a/docs/content/commands/rclone_config_providers.md b/docs/content/commands/rclone_config_providers.md index dd0f330fe..4d043fdc1 100644 --- a/docs/content/commands/rclone_config_providers.md +++ b/docs/content/commands/rclone_config_providers.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone config providers" description: "List in JSON format all the providers and options." slug: rclone_config_providers diff --git a/docs/content/commands/rclone_config_reconnect.md b/docs/content/commands/rclone_config_reconnect.md index 213a255ab..395c4cae6 100644 --- a/docs/content/commands/rclone_config_reconnect.md +++ b/docs/content/commands/rclone_config_reconnect.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone config reconnect" description: "Re-authenticates user with remote." slug: rclone_config_reconnect diff --git a/docs/content/commands/rclone_config_show.md b/docs/content/commands/rclone_config_show.md index f1e108737..41c6e9dff 100644 --- a/docs/content/commands/rclone_config_show.md +++ b/docs/content/commands/rclone_config_show.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone config show" description: "Print (decrypted) config file, or the config for a single remote." slug: rclone_config_show diff --git a/docs/content/commands/rclone_config_update.md b/docs/content/commands/rclone_config_update.md index e557e878b..4b123291c 100644 --- a/docs/content/commands/rclone_config_update.md +++ b/docs/content/commands/rclone_config_update.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone config update" description: "Update options in an existing remote." slug: rclone_config_update @@ -14,7 +14,7 @@ Update options in an existing remote. Update an existing remote's options. The options should be passed in -in pairs of . +in pairs of `key` `value`. For example to update the env_auth field of a remote of name myremote you would do: @@ -41,7 +41,7 @@ require this add an extra parameter thus: ``` -rclone config update [ ]+ [flags] +rclone config update `name` [`key` `value`]+ [flags] ``` ## Options diff --git a/docs/content/commands/rclone_config_userinfo.md b/docs/content/commands/rclone_config_userinfo.md index 94c3e48da..88ee276cb 100644 --- a/docs/content/commands/rclone_config_userinfo.md +++ b/docs/content/commands/rclone_config_userinfo.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone config userinfo" description: "Prints info about logged in user of remote." slug: rclone_config_userinfo diff --git a/docs/content/commands/rclone_copy.md b/docs/content/commands/rclone_copy.md index 23c45538f..d475bf71d 100644 --- a/docs/content/commands/rclone_copy.md +++ b/docs/content/commands/rclone_copy.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone copy" description: "Copy files from source to dest, skipping already copied" slug: rclone_copy diff --git a/docs/content/commands/rclone_copyto.md b/docs/content/commands/rclone_copyto.md index 18eed5d66..9a9fce250 100644 --- a/docs/content/commands/rclone_copyto.md +++ b/docs/content/commands/rclone_copyto.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone copyto" description: "Copy files from source to dest, skipping already copied" slug: rclone_copyto diff --git a/docs/content/commands/rclone_copyurl.md b/docs/content/commands/rclone_copyurl.md index 4935a4ca6..f5a1d3582 100644 --- a/docs/content/commands/rclone_copyurl.md +++ b/docs/content/commands/rclone_copyurl.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone copyurl" description: "Copy url content to dest." slug: rclone_copyurl diff --git a/docs/content/commands/rclone_cryptcheck.md b/docs/content/commands/rclone_cryptcheck.md index 0211d5522..10a1353f8 100644 --- a/docs/content/commands/rclone_cryptcheck.md +++ b/docs/content/commands/rclone_cryptcheck.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone cryptcheck" description: "Cryptcheck checks the integrity of a crypted remote." slug: rclone_cryptcheck diff --git a/docs/content/commands/rclone_cryptdecode.md b/docs/content/commands/rclone_cryptdecode.md index 693033093..aeec350ba 100644 --- a/docs/content/commands/rclone_cryptdecode.md +++ b/docs/content/commands/rclone_cryptdecode.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone cryptdecode" description: "Cryptdecode returns unencrypted file names." slug: rclone_cryptdecode diff --git a/docs/content/commands/rclone_dedupe.md b/docs/content/commands/rclone_dedupe.md index 7e933d9d0..9fe6965e5 100644 --- a/docs/content/commands/rclone_dedupe.md +++ b/docs/content/commands/rclone_dedupe.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone dedupe" description: "Interactively find duplicate files and delete/rename them." slug: rclone_dedupe diff --git a/docs/content/commands/rclone_delete.md b/docs/content/commands/rclone_delete.md index fa64e1f3b..60581a388 100644 --- a/docs/content/commands/rclone_delete.md +++ b/docs/content/commands/rclone_delete.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone delete" description: "Remove the contents of path." slug: rclone_delete diff --git a/docs/content/commands/rclone_deletefile.md b/docs/content/commands/rclone_deletefile.md index 3c5d23950..5f94ee22c 100644 --- a/docs/content/commands/rclone_deletefile.md +++ b/docs/content/commands/rclone_deletefile.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone deletefile" description: "Remove a single file from remote." slug: rclone_deletefile diff --git a/docs/content/commands/rclone_genautocomplete.md b/docs/content/commands/rclone_genautocomplete.md index 958bec4af..c4f7d03b3 100644 --- a/docs/content/commands/rclone_genautocomplete.md +++ b/docs/content/commands/rclone_genautocomplete.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone genautocomplete" description: "Output completion script for a given shell." slug: rclone_genautocomplete diff --git a/docs/content/commands/rclone_genautocomplete_bash.md b/docs/content/commands/rclone_genautocomplete_bash.md index 2149119b2..24fb2dd8f 100644 --- a/docs/content/commands/rclone_genautocomplete_bash.md +++ b/docs/content/commands/rclone_genautocomplete_bash.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone genautocomplete bash" description: "Output bash completion script for rclone." slug: rclone_genautocomplete_bash diff --git a/docs/content/commands/rclone_genautocomplete_fish.md b/docs/content/commands/rclone_genautocomplete_fish.md index 4ec23f01a..df0874bb6 100644 --- a/docs/content/commands/rclone_genautocomplete_fish.md +++ b/docs/content/commands/rclone_genautocomplete_fish.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone genautocomplete fish" description: "Output fish completion script for rclone." slug: rclone_genautocomplete_fish diff --git a/docs/content/commands/rclone_genautocomplete_zsh.md b/docs/content/commands/rclone_genautocomplete_zsh.md index 22082b1d1..c2cc988ad 100644 --- a/docs/content/commands/rclone_genautocomplete_zsh.md +++ b/docs/content/commands/rclone_genautocomplete_zsh.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone genautocomplete zsh" description: "Output zsh completion script for rclone." slug: rclone_genautocomplete_zsh diff --git a/docs/content/commands/rclone_gendocs.md b/docs/content/commands/rclone_gendocs.md index cd5e82b7b..d0c148739 100644 --- a/docs/content/commands/rclone_gendocs.md +++ b/docs/content/commands/rclone_gendocs.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone gendocs" description: "Output markdown docs for rclone to the directory supplied." slug: rclone_gendocs diff --git a/docs/content/commands/rclone_hashsum.md b/docs/content/commands/rclone_hashsum.md index 8127f1213..a84db73e7 100644 --- a/docs/content/commands/rclone_hashsum.md +++ b/docs/content/commands/rclone_hashsum.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone hashsum" description: "Produces a hashsum file for all the objects in the path." slug: rclone_hashsum diff --git a/docs/content/commands/rclone_link.md b/docs/content/commands/rclone_link.md index e99a3a376..1524cda5c 100644 --- a/docs/content/commands/rclone_link.md +++ b/docs/content/commands/rclone_link.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone link" description: "Generate public link to file/folder." slug: rclone_link diff --git a/docs/content/commands/rclone_listremotes.md b/docs/content/commands/rclone_listremotes.md index 3b0af32d6..19a6988a7 100644 --- a/docs/content/commands/rclone_listremotes.md +++ b/docs/content/commands/rclone_listremotes.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone listremotes" description: "List all the remotes in the config file." slug: rclone_listremotes diff --git a/docs/content/commands/rclone_ls.md b/docs/content/commands/rclone_ls.md index 5407eba5e..0b92ef86c 100644 --- a/docs/content/commands/rclone_ls.md +++ b/docs/content/commands/rclone_ls.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone ls" description: "List the objects in the path with size and path." slug: rclone_ls diff --git a/docs/content/commands/rclone_lsd.md b/docs/content/commands/rclone_lsd.md index c2a2c25fc..bd0b0f06b 100644 --- a/docs/content/commands/rclone_lsd.md +++ b/docs/content/commands/rclone_lsd.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone lsd" description: "List all directories/containers/buckets in the path." slug: rclone_lsd diff --git a/docs/content/commands/rclone_lsf.md b/docs/content/commands/rclone_lsf.md index 3311bd2ad..ac7d61615 100644 --- a/docs/content/commands/rclone_lsf.md +++ b/docs/content/commands/rclone_lsf.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone lsf" description: "List directories and objects in remote:path formatted for parsing" slug: rclone_lsf diff --git a/docs/content/commands/rclone_lsjson.md b/docs/content/commands/rclone_lsjson.md index 0edf316f0..25cec72ae 100644 --- a/docs/content/commands/rclone_lsjson.md +++ b/docs/content/commands/rclone_lsjson.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone lsjson" description: "List directories and objects in the path in JSON format." slug: rclone_lsjson diff --git a/docs/content/commands/rclone_lsl.md b/docs/content/commands/rclone_lsl.md index f523517f8..a8bb3e594 100644 --- a/docs/content/commands/rclone_lsl.md +++ b/docs/content/commands/rclone_lsl.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone lsl" description: "List the objects in path with modification time, size and path." slug: rclone_lsl diff --git a/docs/content/commands/rclone_md5sum.md b/docs/content/commands/rclone_md5sum.md index 8011cfa9a..c503e78b5 100644 --- a/docs/content/commands/rclone_md5sum.md +++ b/docs/content/commands/rclone_md5sum.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone md5sum" description: "Produces an md5sum file for all the objects in the path." slug: rclone_md5sum diff --git a/docs/content/commands/rclone_mkdir.md b/docs/content/commands/rclone_mkdir.md index 1ec015e08..976fb50ee 100644 --- a/docs/content/commands/rclone_mkdir.md +++ b/docs/content/commands/rclone_mkdir.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone mkdir" description: "Make the path if it doesn't already exist." slug: rclone_mkdir diff --git a/docs/content/commands/rclone_mount.md b/docs/content/commands/rclone_mount.md index 424ec39d5..db93c51e3 100644 --- a/docs/content/commands/rclone_mount.md +++ b/docs/content/commands/rclone_mount.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone mount" description: "Mount the remote as file system on a mountpoint." slug: rclone_mount diff --git a/docs/content/commands/rclone_move.md b/docs/content/commands/rclone_move.md index 2853b766b..fd721f574 100644 --- a/docs/content/commands/rclone_move.md +++ b/docs/content/commands/rclone_move.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone move" description: "Move files from source to dest." slug: rclone_move diff --git a/docs/content/commands/rclone_moveto.md b/docs/content/commands/rclone_moveto.md index 556cefe7a..a6d948512 100644 --- a/docs/content/commands/rclone_moveto.md +++ b/docs/content/commands/rclone_moveto.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone moveto" description: "Move file or directory from source to dest." slug: rclone_moveto diff --git a/docs/content/commands/rclone_ncdu.md b/docs/content/commands/rclone_ncdu.md index 02103e146..b19c7d272 100644 --- a/docs/content/commands/rclone_ncdu.md +++ b/docs/content/commands/rclone_ncdu.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone ncdu" description: "Explore a remote with a text based user interface." slug: rclone_ncdu @@ -17,7 +17,7 @@ This displays a text based user interface allowing the navigation of a remote. It is most useful for answering the question - "What is using all my disk space?". - +{{< asciinema 157793 >}} To make the user interface it first scans the entire remote given and builds an in memory representation. rclone ncdu can be used during diff --git a/docs/content/commands/rclone_obscure.md b/docs/content/commands/rclone_obscure.md index 2ae7af971..99f51fbdc 100644 --- a/docs/content/commands/rclone_obscure.md +++ b/docs/content/commands/rclone_obscure.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone obscure" description: "Obscure password for use in the rclone.conf" slug: rclone_obscure diff --git a/docs/content/commands/rclone_purge.md b/docs/content/commands/rclone_purge.md index 249890eba..19230f4b6 100644 --- a/docs/content/commands/rclone_purge.md +++ b/docs/content/commands/rclone_purge.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone purge" description: "Remove the path and all of its contents." slug: rclone_purge diff --git a/docs/content/commands/rclone_rc.md b/docs/content/commands/rclone_rc.md index cf076481d..8a11e12f9 100644 --- a/docs/content/commands/rclone_rc.md +++ b/docs/content/commands/rclone_rc.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone rc" description: "Run a command against a running rclone." slug: rclone_rc diff --git a/docs/content/commands/rclone_rcat.md b/docs/content/commands/rclone_rcat.md index c604db76b..cb53f0e69 100644 --- a/docs/content/commands/rclone_rcat.md +++ b/docs/content/commands/rclone_rcat.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone rcat" description: "Copies standard input to file on remote." slug: rclone_rcat diff --git a/docs/content/commands/rclone_rcd.md b/docs/content/commands/rclone_rcd.md index 8cdc2498f..0a86d7be9 100644 --- a/docs/content/commands/rclone_rcd.md +++ b/docs/content/commands/rclone_rcd.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone rcd" description: "Run rclone listening to remote control commands only." slug: rclone_rcd diff --git a/docs/content/commands/rclone_rmdir.md b/docs/content/commands/rclone_rmdir.md index 9fe0de2ca..9116f240d 100644 --- a/docs/content/commands/rclone_rmdir.md +++ b/docs/content/commands/rclone_rmdir.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone rmdir" description: "Remove the path if empty." slug: rclone_rmdir diff --git a/docs/content/commands/rclone_rmdirs.md b/docs/content/commands/rclone_rmdirs.md index e3d187e13..21826a7be 100644 --- a/docs/content/commands/rclone_rmdirs.md +++ b/docs/content/commands/rclone_rmdirs.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone rmdirs" description: "Remove empty directories under the path." slug: rclone_rmdirs diff --git a/docs/content/commands/rclone_serve.md b/docs/content/commands/rclone_serve.md index 3817e1266..099478809 100644 --- a/docs/content/commands/rclone_serve.md +++ b/docs/content/commands/rclone_serve.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone serve" description: "Serve a remote over a protocol." slug: rclone_serve diff --git a/docs/content/commands/rclone_serve_dlna.md b/docs/content/commands/rclone_serve_dlna.md index ce9a62861..f9edd0e35 100644 --- a/docs/content/commands/rclone_serve_dlna.md +++ b/docs/content/commands/rclone_serve_dlna.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone serve dlna" description: "Serve remote:path over DLNA" slug: rclone_serve_dlna diff --git a/docs/content/commands/rclone_serve_ftp.md b/docs/content/commands/rclone_serve_ftp.md index d8cffb3fd..fa64729b2 100644 --- a/docs/content/commands/rclone_serve_ftp.md +++ b/docs/content/commands/rclone_serve_ftp.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone serve ftp" description: "Serve remote:path over FTP." slug: rclone_serve_ftp diff --git a/docs/content/commands/rclone_serve_http.md b/docs/content/commands/rclone_serve_http.md index 5b18d73c3..e23bce059 100644 --- a/docs/content/commands/rclone_serve_http.md +++ b/docs/content/commands/rclone_serve_http.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone serve http" description: "Serve the remote over HTTP." slug: rclone_serve_http diff --git a/docs/content/commands/rclone_serve_restic.md b/docs/content/commands/rclone_serve_restic.md index 72b8a7f1b..b92f3149e 100644 --- a/docs/content/commands/rclone_serve_restic.md +++ b/docs/content/commands/rclone_serve_restic.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone serve restic" description: "Serve the remote for restic's REST API." slug: rclone_serve_restic @@ -88,7 +88,7 @@ these **must** end with /. Eg ### Private repositories #### The "--private-repos" flag can be used to limit users to repositories starting -with a path of "//". +with a path of `//`. ## Server options diff --git a/docs/content/commands/rclone_serve_sftp.md b/docs/content/commands/rclone_serve_sftp.md index 0af03623c..bed91e716 100644 --- a/docs/content/commands/rclone_serve_sftp.md +++ b/docs/content/commands/rclone_serve_sftp.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone serve sftp" description: "Serve the remote over SFTP." slug: rclone_serve_sftp diff --git a/docs/content/commands/rclone_serve_webdav.md b/docs/content/commands/rclone_serve_webdav.md index 8e55c8f03..ccb086211 100644 --- a/docs/content/commands/rclone_serve_webdav.md +++ b/docs/content/commands/rclone_serve_webdav.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone serve webdav" description: "Serve remote:path over webdav." slug: rclone_serve_webdav diff --git a/docs/content/commands/rclone_settier.md b/docs/content/commands/rclone_settier.md index 228305b8f..60cab68d3 100644 --- a/docs/content/commands/rclone_settier.md +++ b/docs/content/commands/rclone_settier.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone settier" description: "Changes storage class/tier of objects in remote." slug: rclone_settier diff --git a/docs/content/commands/rclone_sha1sum.md b/docs/content/commands/rclone_sha1sum.md index 539534cc6..790feb9f1 100644 --- a/docs/content/commands/rclone_sha1sum.md +++ b/docs/content/commands/rclone_sha1sum.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone sha1sum" description: "Produces an sha1sum file for all the objects in the path." slug: rclone_sha1sum diff --git a/docs/content/commands/rclone_size.md b/docs/content/commands/rclone_size.md index 774e134eb..d66ad45c8 100644 --- a/docs/content/commands/rclone_size.md +++ b/docs/content/commands/rclone_size.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone size" description: "Prints the total size and number of objects in remote:path." slug: rclone_size diff --git a/docs/content/commands/rclone_sync.md b/docs/content/commands/rclone_sync.md index 9d23f15ad..9fef7f362 100644 --- a/docs/content/commands/rclone_sync.md +++ b/docs/content/commands/rclone_sync.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone sync" description: "Make source and dest identical, modifying destination only." slug: rclone_sync diff --git a/docs/content/commands/rclone_touch.md b/docs/content/commands/rclone_touch.md index 4cab3a96d..5e7265ac7 100644 --- a/docs/content/commands/rclone_touch.md +++ b/docs/content/commands/rclone_touch.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone touch" description: "Create new file or change file modification time." slug: rclone_touch diff --git a/docs/content/commands/rclone_tree.md b/docs/content/commands/rclone_tree.md index 248ad56b1..a04698474 100644 --- a/docs/content/commands/rclone_tree.md +++ b/docs/content/commands/rclone_tree.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone tree" description: "List the contents of the remote in a tree like fashion." slug: rclone_tree diff --git a/docs/content/commands/rclone_version.md b/docs/content/commands/rclone_version.md index 1a97fb700..07eb4fb42 100644 --- a/docs/content/commands/rclone_version.md +++ b/docs/content/commands/rclone_version.md @@ -1,5 +1,5 @@ --- -date: 2020-05-22T09:52:00+01:00 +date: 2020-05-22T15:09:46+01:00 title: "rclone version" description: "Show the version number." slug: rclone_version diff --git a/docs/content/crypt.md b/docs/content/crypt.md index caa98ffa5..7ca68c467 100644 --- a/docs/content/crypt.md +++ b/docs/content/crypt.md @@ -4,7 +4,7 @@ description: "Encryption overlay remote" date: "2016-07-28" --- -Crypt +{{< icon "fa fa-lock" >}}Crypt ---------------------------------------- The `crypt` remote encrypts and decrypts another remote. @@ -277,7 +277,7 @@ Note that you should use the `rclone cryptcheck` command to check the integrity of a crypted remote instead of `rclone check` which can't check the checksums properly. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/crypt/crypt.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to crypt (Encrypt/Decrypt a remote). @@ -313,6 +313,8 @@ How to encrypt the filenames. Option to either encrypt directory names or leave them intact. +NB If filename_encryption is "off" then this option will do nothing. + - Config: directory_name_encryption - Env Var: RCLONE_CRYPT_DIRECTORY_NAME_ENCRYPTION - Type: bool @@ -363,7 +365,54 @@ names, or for debugging purposes. - Type: bool - Default: false - +### Backend commands + +Here are the commands specific to the crypt backend. + +Run them with with + + rclone backend COMMAND remote: + +The help below will explain what arguments each command takes. + +See [the "rclone backend" command](/commands/rclone_backend/) for more +info on how to pass options and arguments. + +These can be run on a running backend using the rc command +[backend/command](/rc/#backend/command). + +#### encode + +Encode the given filename(s) + + rclone backend encode remote: [options] [+] + +This encodes the filenames given as arguments returning a list of +strings of the encoded results. + +Usage Example: + + rclone backend encode crypt: file1 [file2...] + rclone rc backend/command command=encode fs=crypt: file1 [file2...] + + +#### decode + +Decode the given filename(s) + + rclone backend decode remote: [options] [+] + +This decodes the filenames given as arguments returning a list of +strings of the decoded results. It will return an error if any of the +inputs are invalid. + +Usage Example: + + rclone backend decode crypt: encryptedfile1 [encryptedfile2...] + rclone rc backend/command command=decode fs=crypt: encryptedfile1 [encryptedfile2...] + + +{{< rem autogenerated options stop >}} ## Backing up a crypted remote ## diff --git a/docs/content/donate.md b/docs/content/donate.md index 2ed278ed1..505dae81e 100644 --- a/docs/content/donate.md +++ b/docs/content/donate.md @@ -5,7 +5,7 @@ type: page date: "2020-05-15" --- -# Donations to the rclone project +# {{< icon "fa fa-heart heart" >}} Donations to the rclone project Donations help us continue to develop rclone as free open source software. @@ -21,7 +21,7 @@ Nick Craig-Wood If you are a personal user and you would like to support the project with sponsorship as a way of saying thank you then that would be most -appreciated +appreciated {{< icon "fa fa-heart heart" >}} ## Business users @@ -32,7 +32,7 @@ project you rely on stays healthy and well maintained. If you run one of the cloud storage providers that rclone supports and rclone is driving revenue your way then you know it makes sense to -sponsor the project +sponsor the project {{< icon "far fa-smile" >}} Note that GitHub sponsors will provide proper tax invoices appropriate for your country. @@ -44,53 +44,14 @@ run so this is our preferred option. A small amount every month is much better for us than a one off donation as it alows us to plan for the future. - +{{< monthly_donations >}} ## One off donations If you don't want to contribute monthly then of course we'd love a one off donation. -
-
- -
- Donate in $ USD - Donate in £ GBP - Donate in € EUR -
-
- Paypal.me -
- -
- Bitcoin: scan or click the image or copy the address - - - - -
-
-
+{{< one_off_donations >}} If you require a receipt or wish to contribute in a different way then -please drop me an email. +please [drop me an email](mailto:nick@craig-wood.com). diff --git a/docs/content/drive.md b/docs/content/drive.md index 79945a625..8d8982e13 100644 --- a/docs/content/drive.md +++ b/docs/content/drive.md @@ -4,7 +4,7 @@ description: "Rclone docs for Google drive" date: "2016-04-12" --- - Google Drive +{{< icon "fab fa-google" >}} Google Drive ----------------------------------------- Paths are specified as `drive:path` @@ -535,7 +535,7 @@ Google Documents. | url | INI style link file | macOS, Windows | | webloc | macOS specific XML format | macOS | - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/drive/drive.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to drive (Google Drive). @@ -678,7 +678,7 @@ videos. Setting this flag will cause Google photos and videos to return a blank MD5 checksum. -Google photos are identified by being in the "photos" space. +Google photos are identifed by being in the "photos" space. Corrupted checksums are caused by Google modifying the image/video but not updating the checksum. @@ -1000,7 +1000,89 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Type: MultiEncoder - Default: InvalidUtf8 - +### Backend commands + +Here are the commands specific to the drive backend. + +Run them with with + + rclone backend COMMAND remote: + +The help below will explain what arguments each command takes. + +See [the "rclone backend" command](/commands/rclone_backend/) for more +info on how to pass options and arguments. + +These can be run on a running backend using the rc command +[backend/command](/rc/#backend/command). + +#### get + +Get command for fetching the drive config parameters + + rclone backend get remote: [options] [+] + +This is a get command which will be used to fetch the various drive config parameters + +Usage Examples: + + rclone backend get drive: [-o service_account_file] [-o chunk_size] + rclone rc backend/command command=get fs=drive: [-o service_account_file] [-o chunk_size] + + +Options: + +- "chunk_size": show the current upload chunk size +- "service_account_file": show the current service account file + +#### set + +Set command for updating the drive config parameters + + rclone backend set remote: [options] [+] + +This is a set command which will be used to update the various drive config parameters + +Usage Examples: + + rclone backend set drive: [-o service_account_file=sa.json] [-o chunk_size=67108864] + rclone rc backend/command command=set fs=drive: [-o service_account_file=sa.json] [-o chunk_size=67108864] + + +Options: + +- "chunk_size": update the current upload chunk size +- "service_account_file": update the current service account file + +#### shortcut + +Create shortcuts from files or directories + + rclone backend shortcut remote: [options] [+] + +This command creates shortcuts from files or directories. + +Usage: + + rclone backend shortcut drive: source_item destination_shortcut + rclone backend shortcut drive: source_item -o target=drive2: destination_shortcut + +In the first example this creates a shortcut from the "source_item" +which can be a file or a directory to the "destination_shortcut". The +"source_item" and the "destination_shortcut" should be relative paths +from "drive:" + +In the second example this creates a shortcut from the "source_item" +relative to "drive:" to the "destination_shortcut" relative to +"drive2:". This may fail with a permission error if the user +authenticated with "drive2:" can't read files from "drive:". + + +Options: + +- "target": optional target remote for the shortcut destination + +{{< rem autogenerated options stop >}} ### Limitations ### diff --git a/docs/content/dropbox.md b/docs/content/dropbox.md index 0c6feb54e..de1413a12 100644 --- a/docs/content/dropbox.md +++ b/docs/content/dropbox.md @@ -4,7 +4,7 @@ description: "Rclone docs for Dropbox" date: "2020-03-18" --- - Dropbox +{{< icon "fab fa-dropbox" >}} Dropbox --------------------------------- Paths are specified as `remote:path` @@ -120,7 +120,7 @@ These only get replaced if they are the last character in the name: Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), as they can't be used in JSON strings. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/dropbox/dropbox.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to dropbox (Dropbox). @@ -185,7 +185,7 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Type: MultiEncoder - Default: Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot - +{{< rem autogenerated options stop >}} ### Limitations ### diff --git a/docs/content/fichier.md b/docs/content/fichier.md index db09a2c23..9836d8b7d 100644 --- a/docs/content/fichier.md +++ b/docs/content/fichier.md @@ -4,7 +4,7 @@ description: "Rclone docs for 1Fichier" date: "2015-10-14" --- - 1Fichier +{{< icon "fa fa-archive" >}} 1Fichier ----------------------------------------- This is a backend for the [1fichier](https://1fichier.com) cloud @@ -113,7 +113,7 @@ name: Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), as they can't be used in JSON strings. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/fichier/fichier.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to fichier (1Fichier). @@ -151,4 +151,4 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Type: MultiEncoder - Default: Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot - +{{< rem autogenerated options stop >}} diff --git a/docs/content/flags.md b/docs/content/flags.md index 46c175093..0dbc5fe58 100755 --- a/docs/content/flags.md +++ b/docs/content/flags.md @@ -1,7 +1,7 @@ --- title: "Global Flags" description: "Rclone Global Flags" -date: "2020-05-18T10:38:09+01:00" +date: "2020-05-22T15:09:46+01:00" --- # Global Flags @@ -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.51.0-346-g560d2619-new-docs-beta") + --user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.51.0-383-g3bc9a985-new-docs-beta") -v, --verbose count Print lots more stuff (repeat for more) ``` @@ -154,325 +154,327 @@ These flags are available for every command. They control the backends and may be set in the config file. ``` - --acd-auth-url string Auth server URL. - --acd-client-id string Amazon Application Client ID. - --acd-client-secret string Amazon Application Client Secret. - --acd-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) - --acd-templink-threshold SizeSuffix Files >= this size will be downloaded via their tempLink. (default 9G) - --acd-token-url string Token server url. - --acd-upload-wait-per-gb Duration Additional time per GB to wait after a failed complete upload to see if it appears. (default 3m0s) - --alias-remote string Remote or path to alias. - --azureblob-access-tier string Access tier of blob: hot, cool or archive. - --azureblob-account string Storage Account Name (leave blank to use SAS URL or Emulator) - --azureblob-chunk-size SizeSuffix Upload chunk size (<= 100MB). (default 4M) - --azureblob-disable-checksum Don't store MD5 checksum with object metadata. - --azureblob-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8) - --azureblob-endpoint string Endpoint for the service - --azureblob-key string Storage Account Key (leave blank to use SAS URL or Emulator) - --azureblob-list-chunk int Size of blob list. (default 5000) - --azureblob-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) - --azureblob-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool. - --azureblob-sas-url string SAS URL for container level access only - --azureblob-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (<= 256MB). (default 256M) - --azureblob-use-emulator Uses local storage emulator if provided as 'true' (leave blank if using real azure storage endpoint) - --b2-account string Account ID or Application Key ID - --b2-chunk-size SizeSuffix Upload chunk size. Must fit in memory. (default 96M) - --b2-disable-checksum Disable checksums for large (> upload cutoff) files - --b2-download-auth-duration Duration Time before the authorization token will expire in s or suffix ms|s|m|h|d. (default 1w) - --b2-download-url string Custom endpoint for downloads. - --b2-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) - --b2-endpoint string Endpoint for the service. - --b2-hard-delete Permanently delete files on remote removal, otherwise hide files. - --b2-key string Application Key - --b2-test-mode string A flag string for X-Bz-Test-Mode header for debugging. - --b2-upload-cutoff SizeSuffix Cutoff for switching to chunked upload. (default 200M) - --b2-versions Include old versions in directory listings. - --box-box-config-file string Box App config.json location - --box-box-sub-type string (default "user") - --box-client-id string Box App Client Id. - --box-client-secret string Box App Client Secret - --box-commit-retries int Max number of times to try committing a multipart file. (default 100) - --box-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot) - --box-root-folder-id string Fill in for rclone to use a non root folder as its starting point. - --box-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (>= 50MB). (default 50M) - --cache-chunk-clean-interval Duration How often should the cache perform cleanups of the chunk storage. (default 1m0s) - --cache-chunk-no-memory Disable the in-memory cache for storing chunks during streaming. - --cache-chunk-path string Directory to cache chunk files. (default "$HOME/.cache/rclone/cache-backend") - --cache-chunk-size SizeSuffix The size of a chunk (partial file data). (default 5M) - --cache-chunk-total-size SizeSuffix The total size that the chunks can take up on the local disk. (default 10G) - --cache-db-path string Directory to store file structure metadata DB. (default "$HOME/.cache/rclone/cache-backend") - --cache-db-purge Clear all the cached data for this remote on start. - --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 verifications when connecting to the Plex server - --cache-plex-password string The password of the Plex user - --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) - --cache-remote string Remote to cache. - --cache-rps int Limits the number of requests per second to the source FS (-1 to disable) (default -1) - --cache-tmp-upload-path string Directory to keep temporary files until they are uploaded. - --cache-tmp-wait-time Duration How long should files be stored in local cache before being uploaded (default 15s) - --cache-workers int How many workers should run in parallel to download chunks. (default 4) - --cache-writes Cache file data on writes through the FS - --chunker-chunk-size SizeSuffix Files larger than chunk size will be split in chunks. (default 2G) - --chunker-fail-hard Choose how chunker should handle files with missing or invalid chunks. - --chunker-hash-type string Choose how chunker handles hash sums. All modes but "none" require metadata. (default "md5") - --chunker-meta-format string Format of the metadata object or "none". By default "simplejson". (default "simplejson") - --chunker-name-format string String format of chunk file names. (default "*.rclone_chunk.###") - --chunker-remote string Remote to chunk/unchunk. - --chunker-start-from int Minimum valid chunk number. Usually 0 or 1. (default 1) - -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-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. - --drive-allow-import-name-change Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time. - --drive-alternate-export Use alternate export URLs for google documents export., - --drive-auth-owner-only Only consider files owned by the authenticated user. - --drive-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 8M) - --drive-client-id string Google Application Client Id - --drive-client-secret string Google Application Client Secret - --drive-disable-http2 Disable drive using http2 (default true) - --drive-encoding MultiEncoder This sets the encoding for the backend. (default InvalidUtf8) - --drive-export-formats string Comma separated list of preferred formats for downloading Google docs. (default "docx,xlsx,pptx,svg") - --drive-formats string Deprecated: see export_formats - --drive-impersonate string Impersonate this user when using a service account. - --drive-import-formats string Comma separated list of preferred formats for uploading Google docs. - --drive-keep-revision-forever Keep new head revision of each file forever. - --drive-list-chunk int Size of listing chunk 100-1000. 0 to disable. (default 1000) - --drive-pacer-burst int Number of API calls to allow without sleeping. (default 100) - --drive-pacer-min-sleep Duration Minimum time to sleep between API calls. (default 100ms) - --drive-root-folder-id string ID of the root folder - --drive-scope string Scope that rclone should use when requesting access from drive. - --drive-server-side-across-configs Allow server side operations (eg copy) to work across different drive configs. - --drive-service-account-credentials string Service Account Credentials JSON blob - --drive-service-account-file string Service Account Credentials JSON file path - --drive-shared-with-me Only show files that are shared with me. - --drive-size-as-quota Show sizes as storage quota usage, not actual size. - --drive-skip-checksum-gphotos Skip MD5 checksum on Google photos and videos only. - --drive-skip-gdocs Skip google documents in all listings. - --drive-skip-shortcuts If set skip shortcut files - --drive-stop-on-upload-limit Make upload limit errors be fatal - --drive-team-drive string ID of the Team Drive - --drive-trashed-only Only show files that are in the trash. - --drive-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 8M) - --drive-use-created-date Use file created date instead of modified date., - --drive-use-shared-date Use date file was shared instead of modified date. - --drive-use-trash Send files to the trash instead of deleting permanently. (default true) - --drive-v2-download-min-size SizeSuffix If Object's are greater, use drive v2 API to download. (default off) - --dropbox-chunk-size SizeSuffix Upload chunk size. (< 150M). (default 48M) - --dropbox-client-id string Dropbox App Client Id - --dropbox-client-secret string Dropbox App Client Secret - --dropbox-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot) - --dropbox-impersonate string Impersonate this user when using a business account. - --fichier-api-key string Your API Key, get it from https://1fichier.com/console/params.pl - --fichier-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot) - --fichier-shared-folder string If you want to download a shared folder, add this parameter - --ftp-concurrency int Maximum number of FTP simultaneous connections, 0 for unlimited - --ftp-disable-epsv Disable using EPSV even if server advertises support - --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-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 - --gcs-bucket-acl string Access Control List for new buckets. - --gcs-bucket-policy-only Access checks should use bucket-level IAM policies. - --gcs-client-id string Google Application Client Id - --gcs-client-secret string Google Application Client Secret - --gcs-encoding MultiEncoder This sets the encoding for the backend. (default Slash,CrLf,InvalidUtf8,Dot) - --gcs-location string Location for the newly created buckets. - --gcs-object-acl string Access Control List for new objects. - --gcs-project-number string Project number. - --gcs-service-account-file string Service Account Credentials JSON file path - --gcs-storage-class string The storage class to use when storing objects in Google Cloud Storage. - --gphotos-client-id string Google Application Client Id - --gphotos-client-secret string Google Application Client Secret - --gphotos-read-only Set to make the Google Photos backend read only. - --gphotos-read-size Set to read the size of media items. - --gphotos-start-year int Year limits the photos to be downloaded to those which are uploaded after the given year (default 2000) - --http-headers CommaSepList Set HTTP headers for all transactions - --http-no-head Don't use HEAD requests to find file sizes in dir listing - --http-no-slash Set this if the site doesn't end directories with / - --http-url string URL of http host to connect to - --hubic-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) - --hubic-client-id string Hubic Client Id - --hubic-client-secret string Hubic Client Secret - --hubic-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8) - --hubic-no-chunk Don't chunk files during streaming upload. - --jottacloud-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot) - --jottacloud-hard-delete Delete files permanently rather than putting them into the trash. - --jottacloud-md5-memory-limit SizeSuffix Files bigger than this will be cached on disk to calculate the MD5 if required. (default 10M) - --jottacloud-trashed-only Only show files that are in the trash. - --jottacloud-unlink Remove existing public link to file/folder with link command rather than creating. - --jottacloud-upload-resume-limit SizeSuffix Files bigger than this can be resumed if the upload fail's. (default 10M) - --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-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 - --local-case-insensitive Force the filesystem to report itself as case insensitive - --local-case-sensitive Force the filesystem to report itself as case sensitive. - --local-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Dot) - --local-no-check-updated Don't check to see if the files change during upload - --local-no-unicode-normalization Don't apply unicode normalization to paths and filenames (Deprecated) - --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-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) - --mailru-speedup-max-memory SizeSuffix Files larger than the size given below will always be hashed on disk. (default 32M) - --mailru-user string User name (usually email) - --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-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) - --onedrive-client-id string Microsoft App Client Id - --onedrive-client-secret string Microsoft App Client Secret - --onedrive-drive-id string The ID of the drive to use - --onedrive-drive-type string The type of the drive ( personal | business | documentLibrary ) - --onedrive-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot) - --onedrive-expose-onenote-files Set to make OneNote files show up in directory listings. - --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-username string Username - --pcloud-client-id string Pcloud App Client Id - --pcloud-client-secret string Pcloud App Client Secret - --pcloud-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) - --pcloud-root-folder-id string Fill in for rclone to use a non root folder as its starting point. (default "d0") - --premiumizeme-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot) - --putio-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) - --qingstor-access-key-id string QingStor Access Key ID - --qingstor-chunk-size SizeSuffix Chunk size to use for uploading. (default 4M) - --qingstor-connection-retries int Number of connection retries. (default 3) - --qingstor-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Ctl,InvalidUtf8) - --qingstor-endpoint string Enter an endpoint URL to connection QingStor API. - --qingstor-env-auth Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank. - --qingstor-secret-access-key string QingStor Secret Access Key (password) - --qingstor-upload-concurrency int Concurrency for multipart uploads. (default 1) - --qingstor-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) - --qingstor-zone string Zone to connect to. - --s3-access-key-id string AWS Access Key ID. - --s3-acl string Canned ACL used when creating buckets and storing or copying objects. - --s3-bucket-acl string Canned ACL used when creating buckets. - --s3-chunk-size SizeSuffix Chunk size to use for uploading. (default 5M) - --s3-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 5G) - --s3-disable-checksum Don't store MD5 checksum with object metadata - --s3-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) - --s3-endpoint string Endpoint for S3 API. - --s3-env-auth Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). - --s3-force-path-style If true use path style access if false use virtual hosted style. (default true) - --s3-leave-parts-on-error If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery. - --s3-list-chunk int Size of listing chunk (response list for each ListObject S3 request). (default 1000) - --s3-location-constraint string Location constraint - must be set to match the Region. - --s3-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) - --s3-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool. - --s3-provider string Choose your S3 provider. - --s3-region string Region to connect to. - --s3-secret-access-key string AWS Secret Access Key (password) - --s3-server-side-encryption string The server-side encryption algorithm used when storing this object in S3. - --s3-session-token string An AWS session token - --s3-sse-customer-algorithm string If using SSE-C, the server-side encryption algorithm used when storing this object in S3. - --s3-sse-customer-key string If using SSE-C you must provide the secret encyption key used to encrypt/decrypt your data. - --s3-sse-customer-key-md5 string If using SSE-C you must provide the secret encryption key MD5 checksum. - --s3-sse-kms-key-id string If using KMS ID you must provide the ARN of Key. - --s3-storage-class string The storage class to use when storing new objects in S3. - --s3-upload-concurrency int Concurrency for multipart uploads. (default 4) - --s3-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) - --s3-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint. - --s3-v2-auth If true use v2 authentication. - --seafile-create-library Should create 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-url string URL of seafile host to connect to - --seafile-user string User name - --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-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-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) - --sftp-sha1sum-command string The command used to read sha1 hashes. Leave blank for autodetect. - --sftp-skip-links Set to skip any symlinks and any other non regular files. - --sftp-use-insecure-cipher Enable the use of insecure ciphers and key exchange methods. - --sftp-user string SSH username, leave blank for current username, ncw - --sharefile-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 64M) - --sharefile-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot) - --sharefile-endpoint string Endpoint for API calls. - --sharefile-root-folder-id string ID of the root folder - --sharefile-upload-cutoff SizeSuffix Cutoff for switching to multipart upload. (default 128M) - --skip-links Don't warn about skipped symlinks. - --sugarsync-access-key-id string Sugarsync Access Key ID. - --sugarsync-app-id string Sugarsync App ID. - --sugarsync-authorization string Sugarsync authorization - --sugarsync-authorization-expiry string Sugarsync authorization expiry - --sugarsync-deleted-id string Sugarsync deleted folder id - --sugarsync-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Ctl,InvalidUtf8,Dot) - --sugarsync-hard-delete Permanently delete files if true - --sugarsync-private-access-key string Sugarsync Private Access Key - --sugarsync-refresh-token string Sugarsync refresh token - --sugarsync-root-id string Sugarsync root id - --sugarsync-user string Sugarsync user - --swift-application-credential-id string Application Credential ID (OS_APPLICATION_CREDENTIAL_ID) - --swift-application-credential-name string Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME) - --swift-application-credential-secret string Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET) - --swift-auth string Authentication URL for server (OS_AUTH_URL). - --swift-auth-token string Auth Token from alternate authentication - optional (OS_AUTH_TOKEN) - --swift-auth-version int AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION) - --swift-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) - --swift-domain string User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME) - --swift-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8) - --swift-endpoint-type string Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE) (default "public") - --swift-env-auth Get swift credentials from environment variables in standard OpenStack form. - --swift-key string API key or password (OS_PASSWORD). - --swift-no-chunk Don't chunk files during streaming upload. - --swift-region string Region name - optional (OS_REGION_NAME) - --swift-storage-policy string The storage policy to use when creating a new container - --swift-storage-url string Storage URL - optional (OS_STORAGE_URL) - --swift-tenant string Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME) - --swift-tenant-domain string Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME) - --swift-tenant-id string Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID) - --swift-user string User name to log in (OS_USERNAME). - --swift-user-id string User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID). - --tardigrade-access-grant string Access Grant. - --tardigrade-api-key string API Key. - --tardigrade-passphrase string Encryption Passphrase. To access existing objects enter passphrase used for uploading. - --tardigrade-provider string Choose an authentication method. (default "existing") - --tardigrade-satellite-address string Satellite Address. Custom satellite address should match the format: @
:. (default "us-central-1.tardigrade.io") - --union-action-policy string Policy to choose upstream on ACTION category. (default "epall") - --union-cache-time int Cache time of usage and free space (in seconds). This option is only useful when a path preserving policy is used. (default 120) - --union-create-policy string Policy to choose upstream on CREATE category. (default "epmfs") - --union-search-policy string Policy to choose upstream on SEARCH category. (default "ff") - --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-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 - --yandex-client-id string Yandex Client Id - --yandex-client-secret string Yandex Client Secret - --yandex-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot) - --yandex-unlink Remove existing public link to file/folder with link command rather than creating. + --acd-auth-url string Auth server URL. + --acd-client-id string Amazon Application Client ID. + --acd-client-secret string Amazon Application Client Secret. + --acd-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) + --acd-templink-threshold SizeSuffix Files >= this size will be downloaded via their tempLink. (default 9G) + --acd-token-url string Token server url. + --acd-upload-wait-per-gb Duration Additional time per GB to wait after a failed complete upload to see if it appears. (default 3m0s) + --alias-remote string Remote or path to alias. + --azureblob-access-tier string Access tier of blob: hot, cool or archive. + --azureblob-account string Storage Account Name (leave blank to use SAS URL or Emulator) + --azureblob-chunk-size SizeSuffix Upload chunk size (<= 100MB). (default 4M) + --azureblob-disable-checksum Don't store MD5 checksum with object metadata. + --azureblob-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8) + --azureblob-endpoint string Endpoint for the service + --azureblob-key string Storage Account Key (leave blank to use SAS URL or Emulator) + --azureblob-list-chunk int Size of blob list. (default 5000) + --azureblob-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) + --azureblob-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool. + --azureblob-sas-url string SAS URL for container level access only + --azureblob-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (<= 256MB). (default 256M) + --azureblob-use-emulator Uses local storage emulator if provided as 'true' (leave blank if using real azure storage endpoint) + --b2-account string Account ID or Application Key ID + --b2-chunk-size SizeSuffix Upload chunk size. Must fit in memory. (default 96M) + --b2-disable-checksum Disable checksums for large (> upload cutoff) files + --b2-download-auth-duration Duration Time before the authorization token will expire in s or suffix ms|s|m|h|d. (default 1w) + --b2-download-url string Custom endpoint for downloads. + --b2-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) + --b2-endpoint string Endpoint for the service. + --b2-hard-delete Permanently delete files on remote removal, otherwise hide files. + --b2-key string Application Key + --b2-test-mode string A flag string for X-Bz-Test-Mode header for debugging. + --b2-upload-cutoff SizeSuffix Cutoff for switching to chunked upload. (default 200M) + --b2-versions Include old versions in directory listings. + --box-box-config-file string Box App config.json location + --box-box-sub-type string (default "user") + --box-client-id string Box App Client Id. + --box-client-secret string Box App Client Secret + --box-commit-retries int Max number of times to try committing a multipart file. (default 100) + --box-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot) + --box-root-folder-id string Fill in for rclone to use a non root folder as its starting point. + --box-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (>= 50MB). (default 50M) + --cache-chunk-clean-interval Duration How often should the cache perform cleanups of the chunk storage. (default 1m0s) + --cache-chunk-no-memory Disable the in-memory cache for storing chunks during streaming. + --cache-chunk-path string Directory to cache chunk files. (default "$HOME/.cache/rclone/cache-backend") + --cache-chunk-size SizeSuffix The size of a chunk (partial file data). (default 5M) + --cache-chunk-total-size SizeSuffix The total size that the chunks can take up on the local disk. (default 10G) + --cache-db-path string Directory to store file structure metadata DB. (default "$HOME/.cache/rclone/cache-backend") + --cache-db-purge Clear all the cached data for this remote on start. + --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 verifications when connecting to the Plex server + --cache-plex-password string The password of the Plex user + --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) + --cache-remote string Remote to cache. + --cache-rps int Limits the number of requests per second to the source FS (-1 to disable) (default -1) + --cache-tmp-upload-path string Directory to keep temporary files until they are uploaded. + --cache-tmp-wait-time Duration How long should files be stored in local cache before being uploaded (default 15s) + --cache-workers int How many workers should run in parallel to download chunks. (default 4) + --cache-writes Cache file data on writes through the FS + --chunker-chunk-size SizeSuffix Files larger than chunk size will be split in chunks. (default 2G) + --chunker-fail-hard Choose how chunker should handle files with missing or invalid chunks. + --chunker-hash-type string Choose how chunker handles hash sums. All modes but "none" require metadata. (default "md5") + --chunker-meta-format string Format of the metadata object or "none". By default "simplejson". (default "simplejson") + --chunker-name-format string String format of chunk file names. (default "*.rclone_chunk.###") + --chunker-remote string Remote to chunk/unchunk. + --chunker-start-from int Minimum valid chunk number. Usually 0 or 1. (default 1) + -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-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. + --drive-allow-import-name-change Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time. + --drive-alternate-export Use alternate export URLs for google documents export., + --drive-auth-owner-only Only consider files owned by the authenticated user. + --drive-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 8M) + --drive-client-id string Google Application Client Id + --drive-client-secret string Google Application Client Secret + --drive-disable-http2 Disable drive using http2 (default true) + --drive-encoding MultiEncoder This sets the encoding for the backend. (default InvalidUtf8) + --drive-export-formats string Comma separated list of preferred formats for downloading Google docs. (default "docx,xlsx,pptx,svg") + --drive-formats string Deprecated: see export_formats + --drive-impersonate string Impersonate this user when using a service account. + --drive-import-formats string Comma separated list of preferred formats for uploading Google docs. + --drive-keep-revision-forever Keep new head revision of each file forever. + --drive-list-chunk int Size of listing chunk 100-1000. 0 to disable. (default 1000) + --drive-pacer-burst int Number of API calls to allow without sleeping. (default 100) + --drive-pacer-min-sleep Duration Minimum time to sleep between API calls. (default 100ms) + --drive-root-folder-id string ID of the root folder + --drive-scope string Scope that rclone should use when requesting access from drive. + --drive-server-side-across-configs Allow server side operations (eg copy) to work across different drive configs. + --drive-service-account-credentials string Service Account Credentials JSON blob + --drive-service-account-file string Service Account Credentials JSON file path + --drive-shared-with-me Only show files that are shared with me. + --drive-size-as-quota Show sizes as storage quota usage, not actual size. + --drive-skip-checksum-gphotos Skip MD5 checksum on Google photos and videos only. + --drive-skip-gdocs Skip google documents in all listings. + --drive-skip-shortcuts If set skip shortcut files + --drive-stop-on-upload-limit Make upload limit errors be fatal + --drive-team-drive string ID of the Team Drive + --drive-trashed-only Only show files that are in the trash. + --drive-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 8M) + --drive-use-created-date Use file created date instead of modified date., + --drive-use-shared-date Use date file was shared instead of modified date. + --drive-use-trash Send files to the trash instead of deleting permanently. (default true) + --drive-v2-download-min-size SizeSuffix If Object's are greater, use drive v2 API to download. (default off) + --dropbox-chunk-size SizeSuffix Upload chunk size. (< 150M). (default 48M) + --dropbox-client-id string Dropbox App Client Id + --dropbox-client-secret string Dropbox App Client Secret + --dropbox-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot) + --dropbox-impersonate string Impersonate this user when using a business account. + --fichier-api-key string Your API Key, get it from https://1fichier.com/console/params.pl + --fichier-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot) + --fichier-shared-folder string If you want to download a shared folder, add this parameter + --ftp-concurrency int Maximum number of FTP simultaneous connections, 0 for unlimited + --ftp-disable-epsv Disable using EPSV even if server advertises support + --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-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 + --gcs-bucket-acl string Access Control List for new buckets. + --gcs-bucket-policy-only Access checks should use bucket-level IAM policies. + --gcs-client-id string Google Application Client Id + --gcs-client-secret string Google Application Client Secret + --gcs-encoding MultiEncoder This sets the encoding for the backend. (default Slash,CrLf,InvalidUtf8,Dot) + --gcs-location string Location for the newly created buckets. + --gcs-object-acl string Access Control List for new objects. + --gcs-project-number string Project number. + --gcs-service-account-file string Service Account Credentials JSON file path + --gcs-storage-class string The storage class to use when storing objects in Google Cloud Storage. + --gphotos-client-id string Google Application Client Id + --gphotos-client-secret string Google Application Client Secret + --gphotos-read-only Set to make the Google Photos backend read only. + --gphotos-read-size Set to read the size of media items. + --gphotos-start-year int Year limits the photos to be downloaded to those which are uploaded after the given year (default 2000) + --http-headers CommaSepList Set HTTP headers for all transactions + --http-no-head Don't use HEAD requests to find file sizes in dir listing + --http-no-slash Set this if the site doesn't end directories with / + --http-url string URL of http host to connect to + --hubic-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) + --hubic-client-id string Hubic Client Id + --hubic-client-secret string Hubic Client Secret + --hubic-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8) + --hubic-no-chunk Don't chunk files during streaming upload. + --jottacloud-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot) + --jottacloud-hard-delete Delete files permanently rather than putting them into the trash. + --jottacloud-md5-memory-limit SizeSuffix Files bigger than this will be cached on disk to calculate the MD5 if required. (default 10M) + --jottacloud-trashed-only Only show files that are in the trash. + --jottacloud-unlink Remove existing public link to file/folder with link command rather than creating. + --jottacloud-upload-resume-limit SizeSuffix Files bigger than this can be resumed if the upload fail's. (default 10M) + --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-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 + --local-case-insensitive Force the filesystem to report itself as case insensitive + --local-case-sensitive Force the filesystem to report itself as case sensitive. + --local-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Dot) + --local-no-check-updated Don't check to see if the files change during upload + --local-no-sparse Disable sparse files for multi-thread downloads + --local-no-unicode-normalization Don't apply unicode normalization to paths and filenames (Deprecated) + --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-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) + --mailru-speedup-max-memory SizeSuffix Files larger than the size given below will always be hashed on disk. (default 32M) + --mailru-user string User name (usually email) + --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-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) + --onedrive-client-id string Microsoft App Client Id + --onedrive-client-secret string Microsoft App Client Secret + --onedrive-drive-id string The ID of the drive to use + --onedrive-drive-type string The type of the drive ( personal | business | documentLibrary ) + --onedrive-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot) + --onedrive-expose-onenote-files Set to make OneNote files show up in directory listings. + --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-username string Username + --pcloud-client-id string Pcloud App Client Id + --pcloud-client-secret string Pcloud App Client Secret + --pcloud-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) + --pcloud-root-folder-id string Fill in for rclone to use a non root folder as its starting point. (default "d0") + --premiumizeme-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot) + --putio-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) + --qingstor-access-key-id string QingStor Access Key ID + --qingstor-chunk-size SizeSuffix Chunk size to use for uploading. (default 4M) + --qingstor-connection-retries int Number of connection retries. (default 3) + --qingstor-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Ctl,InvalidUtf8) + --qingstor-endpoint string Enter an endpoint URL to connection QingStor API. + --qingstor-env-auth Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank. + --qingstor-secret-access-key string QingStor Secret Access Key (password) + --qingstor-upload-concurrency int Concurrency for multipart uploads. (default 1) + --qingstor-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) + --qingstor-zone string Zone to connect to. + --s3-access-key-id string AWS Access Key ID. + --s3-acl string Canned ACL used when creating buckets and storing or copying objects. + --s3-bucket-acl string Canned ACL used when creating buckets. + --s3-chunk-size SizeSuffix Chunk size to use for uploading. (default 5M) + --s3-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 5G) + --s3-disable-checksum Don't store MD5 checksum with object metadata + --s3-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) + --s3-endpoint string Endpoint for S3 API. + --s3-env-auth Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). + --s3-force-path-style If true use path style access if false use virtual hosted style. (default true) + --s3-leave-parts-on-error If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery. + --s3-list-chunk int Size of listing chunk (response list for each ListObject S3 request). (default 1000) + --s3-location-constraint string Location constraint - must be set to match the Region. + --s3-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) + --s3-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool. + --s3-provider string Choose your S3 provider. + --s3-region string Region to connect to. + --s3-secret-access-key string AWS Secret Access Key (password) + --s3-server-side-encryption string The server-side encryption algorithm used when storing this object in S3. + --s3-session-token string An AWS session token + --s3-sse-customer-algorithm string If using SSE-C, the server-side encryption algorithm used when storing this object in S3. + --s3-sse-customer-key string If using SSE-C you must provide the secret encyption key used to encrypt/decrypt your data. + --s3-sse-customer-key-md5 string If using SSE-C you must provide the secret encryption key MD5 checksum. + --s3-sse-kms-key-id string If using KMS ID you must provide the ARN of Key. + --s3-storage-class string The storage class to use when storing new objects in S3. + --s3-upload-concurrency int Concurrency for multipart uploads. (default 4) + --s3-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) + --s3-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint. + --s3-v2-auth If true use v2 authentication. + --seafile-create-library Should create 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-url string URL of seafile host to connect to + --seafile-user string User name + --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-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-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) + --sftp-sha1sum-command string The command used to read sha1 hashes. Leave blank for autodetect. + --sftp-skip-links Set to skip any symlinks and any other non regular files. + --sftp-use-insecure-cipher Enable the use of insecure ciphers and key exchange methods. + --sftp-user string SSH username, leave blank for current username, ncw + --sharefile-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 64M) + --sharefile-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot) + --sharefile-endpoint string Endpoint for API calls. + --sharefile-root-folder-id string ID of the root folder + --sharefile-upload-cutoff SizeSuffix Cutoff for switching to multipart upload. (default 128M) + --skip-links Don't warn about skipped symlinks. + --sugarsync-access-key-id string Sugarsync Access Key ID. + --sugarsync-app-id string Sugarsync App ID. + --sugarsync-authorization string Sugarsync authorization + --sugarsync-authorization-expiry string Sugarsync authorization expiry + --sugarsync-deleted-id string Sugarsync deleted folder id + --sugarsync-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Ctl,InvalidUtf8,Dot) + --sugarsync-hard-delete Permanently delete files if true + --sugarsync-private-access-key string Sugarsync Private Access Key + --sugarsync-refresh-token string Sugarsync refresh token + --sugarsync-root-id string Sugarsync root id + --sugarsync-user string Sugarsync user + --swift-application-credential-id string Application Credential ID (OS_APPLICATION_CREDENTIAL_ID) + --swift-application-credential-name string Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME) + --swift-application-credential-secret string Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET) + --swift-auth string Authentication URL for server (OS_AUTH_URL). + --swift-auth-token string Auth Token from alternate authentication - optional (OS_AUTH_TOKEN) + --swift-auth-version int AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION) + --swift-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) + --swift-domain string User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME) + --swift-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8) + --swift-endpoint-type string Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE) (default "public") + --swift-env-auth Get swift credentials from environment variables in standard OpenStack form. + --swift-key string API key or password (OS_PASSWORD). + --swift-no-chunk Don't chunk files during streaming upload. + --swift-region string Region name - optional (OS_REGION_NAME) + --swift-storage-policy string The storage policy to use when creating a new container + --swift-storage-url string Storage URL - optional (OS_STORAGE_URL) + --swift-tenant string Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME) + --swift-tenant-domain string Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME) + --swift-tenant-id string Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID) + --swift-user string User name to log in (OS_USERNAME). + --swift-user-id string User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID). + --tardigrade-access-grant string Access Grant. + --tardigrade-api-key string API Key. + --tardigrade-passphrase string Encryption Passphrase. To access existing objects enter passphrase used for uploading. + --tardigrade-provider string Choose an authentication method. (default "existing") + --tardigrade-satellite-address @
: Satellite Address. Custom satellite address should match the format: @
:. (default "us-central-1.tardigrade.io") + --union-action-policy string Policy to choose upstream on ACTION category. (default "epall") + --union-cache-time int Cache time of usage and free space (in seconds). This option is only useful when a path preserving policy is used. (default 120) + --union-create-policy string Policy to choose upstream on CREATE category. (default "epmfs") + --union-search-policy string Policy to choose upstream on SEARCH category. (default "ff") + --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-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 + --yandex-client-id string Yandex Client Id + --yandex-client-secret string Yandex Client Secret + --yandex-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot) + --yandex-unlink Remove existing public link to file/folder with link command rather than creating. ``` diff --git a/docs/content/ftp.md b/docs/content/ftp.md index b75c2c921..d1109331e 100644 --- a/docs/content/ftp.md +++ b/docs/content/ftp.md @@ -4,7 +4,7 @@ description: "Rclone docs for FTP backend" date: "2017-01-01" --- - FTP +{{< icon "fa fa-file" >}} FTP ------------------------------ FTP is the File Transfer Protocol. FTP support is provided using the @@ -134,7 +134,7 @@ FTP supports implicit FTP over TLS servers (FTPS). This has to be enabled in the config for the remote. The default FTPS port is `990` so the port will likely have to be explicitly set in the config for the remote. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/ftp/ftp.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to ftp (FTP Connection). @@ -229,7 +229,7 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Type: MultiEncoder - Default: Slash,Del,Ctl,RightSpace,Dot - +{{< rem autogenerated options stop >}} ### Limitations ### diff --git a/docs/content/googlecloudstorage.md b/docs/content/googlecloudstorage.md index 4f04e5a59..01976e8ed 100644 --- a/docs/content/googlecloudstorage.md +++ b/docs/content/googlecloudstorage.md @@ -4,7 +4,7 @@ description: "Rclone docs for Google Cloud Storage" date: "2017-07-18" --- - Google Cloud Storage +{{< icon "fab fa-google" >}} Google Cloud Storage ------------------------------------------------- Paths are specified as `remote:bucket` (or `remote:` for the `lsd` @@ -251,7 +251,7 @@ RFC3339 format accurate to 1ns. Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), as they can't be used in JSON strings. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/googlecloudstorage/googlecloudstorage.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)). @@ -460,4 +460,4 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Type: MultiEncoder - Default: Slash,CrLf,InvalidUtf8,Dot - +{{< rem autogenerated options stop >}} diff --git a/docs/content/googlephotos.md b/docs/content/googlephotos.md index 6ab42611a..cdef00818 100644 --- a/docs/content/googlephotos.md +++ b/docs/content/googlephotos.md @@ -4,7 +4,7 @@ description: "Rclone docs for Google Photos" date: "2019-06-25" --- - Google Photos +{{< icon "fa fa-images" >}} Google Photos ------------------------------------------------- The rclone backend for [Google Photos](https://www.google.com/photos/about/) is @@ -309,7 +309,7 @@ Rclone cannot delete files anywhere except under `album`. The Google Photos API does not support deleting albums - see [bug #135714733](https://issuetracker.google.com/issues/135714733). - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/googlephotos/googlephotos.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to google photos (Google Photos). @@ -365,4 +365,13 @@ you want to read the media. - Type: bool - Default: false - +#### --gphotos-start-year + +Year limits the photos to be downloaded to those which are uploaded after the given year + +- Config: start_year +- Env Var: RCLONE_GPHOTOS_START_YEAR +- Type: int +- Default: 2000 + +{{< rem autogenerated options stop >}} diff --git a/docs/content/http.md b/docs/content/http.md index d4081fd0b..1044da181 100644 --- a/docs/content/http.md +++ b/docs/content/http.md @@ -4,7 +4,7 @@ description: "Read only remote for HTTP servers" date: "2017-06-19" --- - HTTP +{{< icon "fa fa-globe" >}} HTTP ------------------------------------------------- The HTTP remote is a read only remote for reading files of a @@ -100,7 +100,7 @@ without a config file: rclone lsd --http-url https://beta.rclone.org :http: - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/http/http.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to http (http Connection). @@ -186,4 +186,4 @@ If you set this option, rclone will not do the HEAD request. This will mean - Type: bool - Default: false - +{{< rem autogenerated options stop >}} diff --git a/docs/content/hubic.md b/docs/content/hubic.md index 67ec609a7..560c826b0 100644 --- a/docs/content/hubic.md +++ b/docs/content/hubic.md @@ -4,7 +4,7 @@ description: "Rclone docs for Hubic" date: "2016-05-27" --- - Hubic +{{< icon "fa fa-space-shuttle" >}} Hubic ----------------------------------------- Paths are specified as `remote:path` @@ -106,7 +106,7 @@ amongst others) for storing the modification time for an object. Note that Hubic wraps the Swift backend, so most of the properties of are the same. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/hubic/hubic.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to hubic (Hubic). @@ -176,7 +176,7 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Type: MultiEncoder - Default: Slash,InvalidUtf8 - +{{< rem autogenerated options stop >}} ### Limitations ### diff --git a/docs/content/jottacloud.md b/docs/content/jottacloud.md index e68900fba..89eef037a 100644 --- a/docs/content/jottacloud.md +++ b/docs/content/jottacloud.md @@ -4,7 +4,7 @@ description: "Rclone docs for Jottacloud" date: "2018-08-07" --- - Jottacloud +{{< icon "fa fa-cloud" >}} Jottacloud ----------------------------------------- Jottacloud is a cloud storage service provider from a Norwegian company, using its own datacenters in Norway. @@ -176,7 +176,7 @@ To view your current quota you can use the `rclone about remote:` command which will display your usage limit (unless it is unlimited) and the current usage. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/jottacloud/jottacloud.go then run make backenddocs" >}} ### Advanced Options Here are the advanced options specific to jottacloud (Jottacloud). @@ -239,7 +239,7 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Type: MultiEncoder - Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot - +{{< rem autogenerated options stop >}} ### Limitations diff --git a/docs/content/koofr.md b/docs/content/koofr.md index 078dae210..c1e10d445 100644 --- a/docs/content/koofr.md +++ b/docs/content/koofr.md @@ -4,7 +4,7 @@ description: "Rclone docs for Koofr" date: "2019-02-25" --- - Koofr +{{< icon "fa fa-suitcase" >}} Koofr ----------------------------------------- Paths are specified as `remote:path` @@ -98,7 +98,7 @@ the following characters are also replaced: Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), as they can't be used in XML strings. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/koofr/koofr.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to koofr (Koofr). @@ -163,7 +163,7 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Type: MultiEncoder - Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot - +{{< rem autogenerated options stop >}} ### Limitations ### diff --git a/docs/content/local.md b/docs/content/local.md index bf2f75772..4d141a936 100644 --- a/docs/content/local.md +++ b/docs/content/local.md @@ -4,7 +4,7 @@ description: "Rclone docs for the local filesystem" date: "2014-04-26" --- - Local Filesystem +{{< icon "fas fa-hdd" >}} Local Filesystem ------------------------------------------- Local paths are specified as normal filesystem paths, eg `/path/to/wherever`, so @@ -298,7 +298,7 @@ filesystem. **NB** This flag is only available on Unix based systems. On systems where it isn't supported (eg Windows) it will be ignored. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/local/local.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to local (Local Disk). @@ -413,6 +413,20 @@ to override the default choice. - Type: bool - Default: false +#### --local-no-sparse + +Disable sparse files for multi-thread downloads + +On Windows platforms rclone will make sparse files when doing +multi-thread downloads. This avoids long pauses on large files where +the OS zeros the file. However sparse files may be undesirable as they +cause disk fragmentation and can be slow to work with. + +- Config: no_sparse +- Env Var: RCLONE_LOCAL_NO_SPARSE +- Type: bool +- Default: false + #### --local-encoding This sets the encoding for the backend. @@ -428,7 +442,7 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. Here are the commands specific to the local backend. -Run them with +Run them with with rclone backend COMMAND remote: @@ -454,4 +468,4 @@ Options: - "echo": echo the input arguments - "error": return an error based on option value - +{{< rem autogenerated options stop >}} diff --git a/docs/content/mailru.md b/docs/content/mailru.md index 054f00b0d..c0baf5973 100644 --- a/docs/content/mailru.md +++ b/docs/content/mailru.md @@ -4,7 +4,7 @@ description: "Mail.ru Cloud" date: "2019-08-04" --- - Mail.ru Cloud +{{< icon "fas fa-at" >}} Mail.ru Cloud ---------------------------------------- [Mail.ru Cloud](https://cloud.mail.ru/) is a cloud storage provided by a Russian internet company [Mail.Ru Group](https://mail.ru). The official desktop client is [Disk-O:](https://disk-o.cloud/), available only on Windows. (Please note that official sites are in Russian) @@ -164,7 +164,7 @@ site for the total uploaded size limits. Note that Mailru is case insensitive so you can't have a file called "Hello.doc" and one called "hello.doc". - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/mailru/mailru.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to mailru (Mail.ru Cloud). @@ -313,4 +313,4 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Type: MultiEncoder - Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot - +{{< rem autogenerated options stop >}} diff --git a/docs/content/mega.md b/docs/content/mega.md index bb89acba0..5c46e4ea2 100644 --- a/docs/content/mega.md +++ b/docs/content/mega.md @@ -4,7 +4,7 @@ description: "Rclone docs for Mega" date: "2018-04-09" --- - Mega +{{< icon "fa fa-archive" >}} Mega ----------------------------------------- [Mega](https://mega.nz/) is a cloud storage and file hosting service @@ -151,7 +151,7 @@ So, if rclone was working nicely and suddenly you are unable to log-in and you are sure the user and the password are correct, likely you have got the remote blocked for a while. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/mega/mega.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to mega (Mega). @@ -214,7 +214,7 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Type: MultiEncoder - Default: Slash,InvalidUtf8,Dot - +{{< rem autogenerated options stop >}} ### Limitations ### diff --git a/docs/content/memory.md b/docs/content/memory.md index b79649695..c93f8efcd 100644 --- a/docs/content/memory.md +++ b/docs/content/memory.md @@ -4,7 +4,7 @@ description: "Rclone docs for Memory backend" date: "2020-01-18" --- - Memory +{{< icon "fas fa-memory" >}} Memory ----------------------------------------- The memory backend is an in RAM backend. It does not persist its @@ -62,5 +62,5 @@ The memory backend supports MD5 hashes and modification times accurate to 1 nS. The memory backend replaces the [default restricted characters set](/overview/#restricted-characters). - - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/memory/memory.go then run make backenddocs" >}} +{{< rem autogenerated options stop >}} diff --git a/docs/content/onedrive.md b/docs/content/onedrive.md index 50de10364..e9fcbcff6 100644 --- a/docs/content/onedrive.md +++ b/docs/content/onedrive.md @@ -4,7 +4,7 @@ description: "Rclone docs for Microsoft OneDrive" date: "2015-10-14" --- - Microsoft OneDrive +{{< icon "fab fa-windows" >}} Microsoft OneDrive ----------------------------------------- Paths are specified as `remote:path` @@ -193,7 +193,7 @@ doesn't provide an API to permanently delete files, nor to empty the trash, so you will have to do that with one of Microsoft's apps or via the OneDrive website. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/onedrive/onedrive.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to onedrive (Microsoft OneDrive). @@ -226,8 +226,9 @@ Here are the advanced options specific to onedrive (Microsoft OneDrive). Chunk size to upload files with - must be multiple of 320k (327,680 bytes). -Above this size files will be chunked - must be multiple of 320k (327,680 bytes). Note -that the chunks will be buffered into memory. +Above this size files will be chunked - must be multiple of 320k (327,680 bytes) and +should not exceed 250M (262,144,000 bytes) else you may encounter \"Microsoft.SharePoint.Client.InvalidClientQueryException: The request message is too big.\" +Note that the chunks will be buffered into memory. - Config: chunk_size - Env Var: RCLONE_ONEDRIVE_CHUNK_SIZE @@ -267,6 +268,20 @@ listing, set this option. - Type: bool - Default: false +#### --onedrive-server-side-across-configs + +Allow server side operations (eg copy) to work across different onedrive configs. + +This can be useful if you wish to do a server side copy between two +different Onedrives. Note that this isn't enabled by default +because it isn't easy to tell if it will work between any two +configurations. + +- Config: server_side_across_configs +- Env Var: RCLONE_ONEDRIVE_SERVER_SIDE_ACROSS_CONFIGS +- Type: bool +- Default: false + #### --onedrive-encoding This sets the encoding for the backend. @@ -278,7 +293,7 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Type: MultiEncoder - Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot - +{{< rem autogenerated options stop >}} ### Limitations ### diff --git a/docs/content/opendrive.md b/docs/content/opendrive.md index 1739f7cb1..145095ec8 100644 --- a/docs/content/opendrive.md +++ b/docs/content/opendrive.md @@ -4,7 +4,7 @@ description: "Rclone docs for OpenDrive" date: "2017-08-07" --- - OpenDrive +{{< icon "fa fa-file" >}} OpenDrive ------------------------------------ Paths are specified as `remote:path` @@ -99,7 +99,7 @@ These only get replaced if they are the first or last character in the name: Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), as they can't be used in JSON strings. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/opendrive/opendrive.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to opendrive (OpenDrive). @@ -149,7 +149,7 @@ increase memory use. - Type: SizeSuffix - Default: 10M - +{{< rem autogenerated options stop >}} ### Limitations ### diff --git a/docs/content/overview.md b/docs/content/overview.md index 95dbff92f..80950f399 100644 --- a/docs/content/overview.md +++ b/docs/content/overview.md @@ -260,7 +260,7 @@ will show you the defaults for the backends. | LtGt | `<`, `>` | | None | No characters are encoded | | Percent | `%` | -| Pipe | \| | +| Pipe | \| | | Question | `?` | | RightCrLfHtVt | CR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the right of a string | | RightPeriod | `.` on the right of a string | diff --git a/docs/content/pcloud.md b/docs/content/pcloud.md index 9e7f3a94b..4fc1d1202 100644 --- a/docs/content/pcloud.md +++ b/docs/content/pcloud.md @@ -4,7 +4,7 @@ description: "Rclone docs for pCloud" date: "2017-10-01" --- - pCloud +{{< icon "fa fa-cloud" >}} pCloud ----------------------------------------- Paths are specified as `remote:path` @@ -134,7 +134,7 @@ So if the folder you want rclone to use has a URL which looks like in the browser, then you use `5xxxxxxxx8` as the `root_folder_id` in the config. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/pcloud/pcloud.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to pcloud (Pcloud). @@ -183,4 +183,4 @@ Fill in for rclone to use a non root folder as its starting point. - Type: string - Default: "d0" - +{{< rem autogenerated options stop >}} diff --git a/docs/content/premiumizeme.md b/docs/content/premiumizeme.md index e58d72820..3869ee11f 100644 --- a/docs/content/premiumizeme.md +++ b/docs/content/premiumizeme.md @@ -4,7 +4,7 @@ description: "Rclone docs for premiumize.me" date: "2019-08-10" --- - premiumize.me +{{< icon "fa fa-user" >}} premiumize.me ----------------------------------------- Paths are specified as `remote:path` @@ -101,7 +101,7 @@ the following characters are also replaced: Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), as they can't be used in JSON strings. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/premiumizeme/premiumizeme.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to premiumizeme (premiumize.me). @@ -133,7 +133,7 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Type: MultiEncoder - Default: Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot - +{{< rem autogenerated options stop >}} ### Limitations ### diff --git a/docs/content/putio.md b/docs/content/putio.md index dfe964d41..e5ffc72ee 100644 --- a/docs/content/putio.md +++ b/docs/content/putio.md @@ -4,7 +4,7 @@ description: "Rclone docs for put.io" date: "2019-08-08" --- - put.io +{{< icon "fas fa-parking" >}} put.io --------------------------------- Paths are specified as `remote:path` @@ -108,7 +108,7 @@ the following characters are also replaced: Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), as they can't be used in JSON strings. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/putio/putio.go then run make backenddocs" >}} ### Advanced Options Here are the advanced options specific to putio (Put.io). @@ -124,4 +124,4 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Type: MultiEncoder - Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot - +{{< rem autogenerated options stop >}} diff --git a/docs/content/qingstor.md b/docs/content/qingstor.md index ba8b06c7c..19374afe4 100644 --- a/docs/content/qingstor.md +++ b/docs/content/qingstor.md @@ -4,7 +4,7 @@ description: "Rclone docs for QingStor Object Storage" date: "2017-06-26" --- - QingStor +{{< icon "fas fa-hdd" >}} QingStor --------------------------------------- Paths are specified as `remote:bucket` (or `remote:` for the `lsd` @@ -141,7 +141,7 @@ that 0x7F is not replaced. Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), as they can't be used in JSON strings. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/qingstor/qingstor.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to qingstor (QingCloud Object Storage). @@ -260,7 +260,7 @@ Concurrency for multipart uploads. This is the number of chunks of the same file that are uploaded concurrently. -NB if you set this to > 1 then the checksums of multipart uploads +NB if you set this to > 1 then the checksums of multpart uploads become corrupted (the uploads themselves are not corrupted though). If you are uploading small numbers of large file over high speed link @@ -283,4 +283,4 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Type: MultiEncoder - Default: Slash,Ctl,InvalidUtf8 - +{{< rem autogenerated options stop >}} diff --git a/docs/content/rc.md b/docs/content/rc.md index 772a9d8b6..2db75280a 100644 --- a/docs/content/rc.md +++ b/docs/content/rc.md @@ -255,7 +255,7 @@ $ rclone rc job/list } ``` -### Assigning operations to groups with _group = +### Assigning operations to groups with _group = value Each rc call has its own stats group for tracking its metrics. By default grouping is done by the composite group name from prefix `job/` and id of the @@ -275,7 +275,7 @@ $ rclone rc --json '{ "group": "job/1" }' core/stats ``` ## Supported commands - +{{< rem autogenerated start "- run make rcdocs - don't edit here" >}} ### backend/command: Runs a backend command. {#backend-command} This takes the following parameters @@ -1159,7 +1159,7 @@ starting with dir will refresh that directory, eg If the parameter recursive=true is given the whole directory tree will get refreshed. This refresh will use --fast-list if enabled. - +{{< rem autogenerated stop >}} ## Accessing the remote control via HTTP diff --git a/docs/content/s3.md b/docs/content/s3.md index 341a250c5..343409719 100644 --- a/docs/content/s3.md +++ b/docs/content/s3.md @@ -4,7 +4,7 @@ description: "Rclone docs for Amazon S3" date: "2016-07-11" --- - Amazon S3 Storage Providers +{{< icon "fab fa-amazon" >}} Amazon S3 Storage Providers -------------------------------------------------------- The S3 backend can be used with a number of different providers: @@ -441,7 +441,7 @@ the object(s) in question before using rclone. Note that rclone only speaks the S3 API it does not speak the Glacier Vault API, so rclone cannot directly access Glacier Vaults. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/s3/s3.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)). @@ -678,22 +678,6 @@ Specify if using an IBM COS On Premise. #### --s3-endpoint -Endpoint for StackPath Object Storage API. - -- Config: endpoint -- Env Var: RCLONE_S3_ENDPOINT -- Type: string -- Default: "" -- Examples: - - "s3.us-east-2.stackpathstorage.com" - - US East Endpoint - - "s3.us-west-1.stackpathstorage.com" - - US West Endpoint - - "s3.eu-central-1.stackpathstorage.com" - - EU Endpoint - -#### --s3-endpoint - Endpoint for OSS API. - Config: endpoint @@ -742,6 +726,22 @@ Endpoint for OSS API. #### --s3-endpoint +Endpoint for StackPath Object Storage. + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Type: string +- Default: "" +- Examples: + - "s3.us-east-2.stackpathstorage.com" + - US East Endpoint + - "s3.us-west-1.stackpathstorage.com" + - US West Endpoint + - "s3.eu-central-1.stackpathstorage.com" + - EU Endpoint + +#### --s3-endpoint + Endpoint for S3 API. Required when using an S3 clone. @@ -1035,6 +1035,44 @@ isn't set then "acl" is used instead. - "authenticated-read" - Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. +#### --s3-sse-customer-algorithm + +If using SSE-C, the server-side encryption algorithm used when storing this object in S3. + +- Config: sse_customer_algorithm +- Env Var: RCLONE_S3_SSE_CUSTOMER_ALGORITHM +- Type: string +- Default: "" +- Examples: + - "" + - None + - "AES256" + - AES256 + +#### --s3-sse-customer-key + +If using SSE-C you must provide the secret encyption key used to encrypt/decrypt your data. + +- Config: sse_customer_key +- Env Var: RCLONE_S3_SSE_CUSTOMER_KEY +- Type: string +- Default: "" +- Examples: + - "" + - None + +#### --s3-sse-customer-key-md5 + +If using SSE-C you must provide the secret encryption key MD5 checksum. + +- Config: sse_customer_key_md5 +- Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_MD5 +- Type: string +- Default: "" +- Examples: + - "" + - None + #### --s3-upload-cutoff Cutoff for switching to chunked upload @@ -1094,6 +1132,11 @@ The minimum is 0 and the maximum is 5GB. Don't store MD5 checksum with object metadata +Normally rclone will calculate the MD5 checksum of the input before +uploading it so it can add it to metadata on the object. This is great +for data integrity checking but can cause long delays for large files +to start uploading. + - Config: disable_checksum - Env Var: RCLONE_S3_DISABLE_CHECKSUM - Type: bool @@ -1207,7 +1250,27 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Type: MultiEncoder - Default: Slash,InvalidUtf8,Dot - +#### --s3-memory-pool-flush-time + +How often internal memory buffer pools will be flushed. +Uploads which requires additional buffers (f.e multipart) will use memory pool for allocations. +This option controls how often unused buffers will be removed from the pool. + +- Config: memory_pool_flush_time +- Env Var: RCLONE_S3_MEMORY_POOL_FLUSH_TIME +- Type: Duration +- Default: 1m0s + +#### --s3-memory-pool-use-mmap + +Whether to use mmap buffers in internal memory pool. + +- Config: memory_pool_use_mmap +- Env Var: RCLONE_S3_MEMORY_POOL_USE_MMAP +- Type: bool +- Default: false + +{{< rem autogenerated options stop >}} ### Anonymous access to public buckets ### diff --git a/docs/content/seafile.md b/docs/content/seafile.md index db845560c..7e9f24c4e 100644 --- a/docs/content/seafile.md +++ b/docs/content/seafile.md @@ -4,7 +4,7 @@ description: "Seafile" date: "2020-05-19" --- -Seafile +{{< icon "fa fa-server" >}}Seafile ---------------------------------------- This is a backend for the [Seafile](https://www.seafile.com/) storage service: @@ -265,7 +265,7 @@ It has been actively tested using the [seafile docker image](https://github.com/ Versions below 6.0 are not supported. Versions between 6.0 and 6.3 haven't been tested and might not work properly. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/seafile/seafile.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to seafile (seafile). @@ -284,7 +284,7 @@ URL of seafile host to connect to #### --seafile-user -User name (usually email address) +User name - Config: user - Env Var: RCLONE_SEAFILE_USER @@ -300,15 +300,6 @@ Password - Type: string - Default: "" -#### --seafile-2fa - -Two-factor authentication ('true' if the account has 2FA enabled) - -- Config: 2fa -- Env Var: RCLONE_SEAFILE_2FA -- Type: bool -- Default: false - #### --seafile-library Name of the library. Leave blank to access all non-encrypted libraries. @@ -327,22 +318,13 @@ Library password (for encrypted libraries only). Leave blank if you pass it thro - Type: string - Default: "" -#### --seafile-auth-token - -Authentication token - -- Config: auth_token -- Env Var: RCLONE_SEAFILE_AUTH_TOKEN -- Type: string -- Default: "" - ### Advanced Options Here are the advanced options specific to seafile (seafile). #### --seafile-create-library -Should rclone create a library if it doesn't exist +Should create library if it doesn't exist - Config: create_library - Env Var: RCLONE_SEAFILE_CREATE_LIBRARY @@ -360,5 +342,5 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Type: MultiEncoder - Default: Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8 - +{{< rem autogenerated options stop >}} diff --git a/docs/content/sftp.md b/docs/content/sftp.md index e65825c3a..9bd224cf7 100644 --- a/docs/content/sftp.md +++ b/docs/content/sftp.md @@ -4,7 +4,7 @@ description: "SFTP" date: "2017-02-01" --- - SFTP +{{< icon "fa fa-server" >}} SFTP ---------------------------------------- SFTP is the [Secure (or SSH) File Transfer @@ -152,7 +152,7 @@ upload (for example, certain configurations of ProFTPd with mod_sftp). If you are using one of these servers, you can set the option `set_modtime = false` in your RClone backend configuration to disable this behaviour. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/sftp/sftp.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to sftp (SSH/SFTP Connection). @@ -196,6 +196,15 @@ SSH password, leave blank to use ssh-agent. - Type: string - Default: "" +#### --sftp-key-pem + +Raw PEM-encoded private key, If specified, will override key_file parameter. + +- Config: key_pem +- Env Var: RCLONE_SFTP_KEY_PEM +- Type: string +- Default: "" + #### --sftp-key-file Path to PEM-encoded private key file, leave blank or set key-use-agent to use ssh-agent. @@ -339,7 +348,7 @@ Set to skip any symlinks and any other non regular files. - Type: bool - Default: false - +{{< rem autogenerated options stop >}} ### Limitations ### diff --git a/docs/content/sharefile.md b/docs/content/sharefile.md index 38dda8cd4..b96d1e9f1 100644 --- a/docs/content/sharefile.md +++ b/docs/content/sharefile.md @@ -4,7 +4,7 @@ description: "Rclone docs for Citrix ShareFile" date: "2019-09-30" --- -## Citrix ShareFile +## {{< icon "fas fa-share-square" >}} Citrix ShareFile [Citrix ShareFile](https://sharefile.com) is a secure file sharing and transfer service aimed as business. @@ -153,7 +153,7 @@ name: Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), as they can't be used in JSON strings. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/sharefile/sharefile.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to sharefile (Citrix Sharefile). @@ -232,4 +232,4 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Type: MultiEncoder - Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot - +{{< rem autogenerated options stop >}} diff --git a/docs/content/sugarsync.md b/docs/content/sugarsync.md index 360c2487c..ad8612da9 100644 --- a/docs/content/sugarsync.md +++ b/docs/content/sugarsync.md @@ -4,7 +4,7 @@ description: "Rclone docs for SugarSync" date: "2020-01-17" --- - SugarSync +{{< icon "fas fa-dove" >}} SugarSync ----------------------------------------- [SugarSync](https://sugarsync.com) is a cloud service that enables @@ -120,7 +120,7 @@ config parameter `hard_delete = true` if you would like files to be deleted straight away. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/sugarsync/sugarsync.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to sugarsync (Sugarsync). @@ -249,4 +249,4 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Type: MultiEncoder - Default: Slash,Ctl,InvalidUtf8,Dot - +{{< rem autogenerated options stop >}} diff --git a/docs/content/swift.md b/docs/content/swift.md index d1fad6ab6..030a8af27 100644 --- a/docs/content/swift.md +++ b/docs/content/swift.md @@ -4,7 +4,7 @@ description: "Swift" date: "2014-04-26" --- -Swift +{{< icon "fa fa-space-shuttle" >}}Swift ---------------------------------------- Swift refers to [OpenStack Object Storage](https://docs.openstack.org/swift/latest/). @@ -223,7 +223,7 @@ sufficient to determine if it is "dirty". By using `--update` along with `--use-server-modtime`, you can avoid the extra API call and simply upload files whose local modtime is newer than the time it was last uploaded. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/swift/swift.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to swift (Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)). @@ -472,7 +472,7 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Type: MultiEncoder - Default: Slash,InvalidUtf8 - +{{< rem autogenerated options stop >}} ### Modified time ### diff --git a/docs/content/tardigrade.md b/docs/content/tardigrade.md index 3b063b4ef..a253e7186 100644 --- a/docs/content/tardigrade.md +++ b/docs/content/tardigrade.md @@ -4,7 +4,7 @@ description: "Rclone docs for Tardigrade" date: "2020-04-24" --- - Tardigrade +{{< icon "fas fa-dove" >}} Tardigrade ----------------------------------------- [Tardigrade](https://tardigrade.io) is an encrypted, secure, and @@ -93,7 +93,7 @@ Choose a number from below, or type in your own value 2 / Create a new access grant from satellite address, API key, and passphrase. \ "new" provider> new -Satellite Address. Custom satellite address should match the format: @
:. +Satellite Address. Custom satellite address should match the format: `@
:`. Enter a string value. Press Enter for the default ("us-central-1.tardigrade.io"). Choose a number from below, or type in your own value 1 / US Central 1 @@ -238,7 +238,7 @@ Or even between another cloud storage and Tardigrade. rclone sync --progress s3:bucket/path/to/dir/ tardigrade:bucket/path/to/dir/ - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/tardigrade/tardigrade.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to tardigrade (Tardigrade Decentralized Cloud Storage). @@ -268,7 +268,7 @@ Access Grant. #### --tardigrade-satellite-address -Satellite Address. Custom satellite address should match the format: @
:. +Satellite Address. Custom satellite address should match the format: `@
:`. - Config: satellite_address - Env Var: RCLONE_TARDIGRADE_SATELLITE_ADDRESS @@ -300,4 +300,4 @@ Encryption Passphrase. To access existing objects enter passphrase used for uplo - Type: string - Default: "" - +{{< rem autogenerated options stop >}} diff --git a/docs/content/union.md b/docs/content/union.md index b66267498..348380de4 100644 --- a/docs/content/union.md +++ b/docs/content/union.md @@ -4,7 +4,7 @@ description: "Remote Unification" date: "2020-01-25" --- - Union +{{< icon "fa fa-link" >}} Union ----------------------------------------- The `union` remote provides a unification similar to UnionFS using other remotes. @@ -173,7 +173,7 @@ Copy another local directory to the union directory called source, which will be rclone copy C:\source remote:source - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/union/union.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to union (Union merges the contents of several upstream fs). @@ -191,7 +191,7 @@ Can be 'upstreama:test/dir upstreamb:', '"upstreama:test/space:ro dir" upstreamb #### --union-action-policy -Policy to choose upstream on ACTION class. +Policy to choose upstream on ACTION category. - Config: action_policy - Env Var: RCLONE_UNION_ACTION_POLICY @@ -200,7 +200,7 @@ Policy to choose upstream on ACTION class. #### --union-create-policy -Policy to choose upstream on CREATE class. +Policy to choose upstream on CREATE category. - Config: create_policy - Env Var: RCLONE_UNION_CREATE_POLICY @@ -209,7 +209,7 @@ Policy to choose upstream on CREATE class. #### --union-search-policy -Policy to choose upstream on SEARCH class. +Policy to choose upstream on SEARCH category. - Config: search_policy - Env Var: RCLONE_UNION_SEARCH_POLICY @@ -225,4 +225,4 @@ Cache time of usage and free space (in seconds). This option is only useful when - Type: int - Default: 120 - +{{< rem autogenerated options stop >}} diff --git a/docs/content/webdav.md b/docs/content/webdav.md index 6f23b8200..57ac8b93a 100644 --- a/docs/content/webdav.md +++ b/docs/content/webdav.md @@ -4,7 +4,7 @@ description: "Rclone docs for WebDAV" date: "2017-10-01" --- - WebDAV +{{< icon "fa fa-globe" >}} WebDAV ----------------------------------------- Paths are specified as `remote:path` @@ -105,7 +105,7 @@ Depending on the exact version of Owncloud or Nextcloud hashes may appear on all objects, or only on objects which had a hash uploaded with them. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/webdav/webdav.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to webdav (Webdav). @@ -180,7 +180,7 @@ Command to run to get a bearer token - Type: string - Default: "" - +{{< rem autogenerated options stop >}} ## Provider notes ## diff --git a/docs/content/yandex.md b/docs/content/yandex.md index 9dbc0dd40..adfdc7dc8 100644 --- a/docs/content/yandex.md +++ b/docs/content/yandex.md @@ -4,7 +4,7 @@ description: "Yandex Disk" date: "2015-12-30" --- -Yandex Disk +{{< icon "fa fa-space-shuttle" >}}Yandex Disk ---------------------------------------- [Yandex Disk](https://disk.yandex.com) is a cloud storage solution created by [Yandex](https://yandex.com). @@ -126,7 +126,7 @@ to twice the max size of file in GB should be enough, so if you want to upload a 30GB file set a timeout of `2 * 30 = 60m`, that is `--timeout 60m`. - +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/yandex/yandex.go then run make backenddocs" >}} ### Standard Options Here are the standard options specific to yandex (Yandex Disk). @@ -176,4 +176,4 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Type: MultiEncoder - Default: Slash,Del,Ctl,InvalidUtf8,Dot - +{{< rem autogenerated options stop >}} diff --git a/docs/layouts/shortcodes/asciinema.html b/docs/layouts/shortcodes/asciinema.html new file mode 100644 index 000000000..76909cd95 --- /dev/null +++ b/docs/layouts/shortcodes/asciinema.html @@ -0,0 +1 @@ + diff --git a/docs/layouts/shortcodes/color.html b/docs/layouts/shortcodes/color.html new file mode 100644 index 000000000..e2a9247d0 --- /dev/null +++ b/docs/layouts/shortcodes/color.html @@ -0,0 +1 @@ +{{ .Inner }} diff --git a/docs/layouts/shortcodes/icon.html b/docs/layouts/shortcodes/icon.html new file mode 100644 index 000000000..b6b0a50b2 --- /dev/null +++ b/docs/layouts/shortcodes/icon.html @@ -0,0 +1 @@ + diff --git a/docs/layouts/shortcodes/img.html b/docs/layouts/shortcodes/img.html new file mode 100644 index 000000000..01ed8d07e --- /dev/null +++ b/docs/layouts/shortcodes/img.html @@ -0,0 +1 @@ +{{ .Get diff --git a/docs/layouts/shortcodes/monthly_donations.html b/docs/layouts/shortcodes/monthly_donations.html new file mode 100644 index 000000000..eaea4aca3 --- /dev/null +++ b/docs/layouts/shortcodes/monthly_donations.html @@ -0,0 +1,16 @@ + diff --git a/docs/layouts/shortcodes/one_off_donations.html b/docs/layouts/shortcodes/one_off_donations.html new file mode 100644 index 000000000..cb9ea9ca9 --- /dev/null +++ b/docs/layouts/shortcodes/one_off_donations.html @@ -0,0 +1,25 @@ +
+
+ +
+ Donate in $ USD + Donate in £ GBP + Donate in € EUR +
+
+ Paypal.me +
+ +
+ Bitcoin: scan or click the image or copy the address + + + + +
+
+
diff --git a/docs/layouts/shortcodes/rem.html b/docs/layouts/shortcodes/rem.html new file mode 100644 index 000000000..e69de29bb