TrueCloudLab/rclone
16
0
Fork 2
Code Issues 1 Pull requests 1 Projects Releases Packages Wiki Activity Actions

docs: set unsafe HTML parsing to false and fix raw HTML insertion

Browse source 
This means that markdown files can't contain <thing> any more.
This commit is contained in:
Nick Craig-Wood 2020-05-22 12:22:52 +01:00
parent 06427371eb
commit 74b8cbfb84
128 changed files with 945 additions and 645 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
Makefile
View file

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

2
backend/tardigrade/fs.go
View file

@ -103,7 +103,7 @@ func init() {
},
{
Name: "satellite_address",
Help: "Satellite Address. Custom satellite address should match the format: <nodeid>@<address>:<port>.",
Help: "Satellite Address. Custom satellite address should match the format: `<nodeid>@<address>:<port>`.",
Required: false,
Provider: newProvider,
Default: "us-central-1.tardigrade.io",

7
bin/make_backend_docs.py
View file

@ -7,9 +7,10 @@ import os
import io
import subprocess
marker = "<!--- autogenerated options"
marker = "{{< rem autogenerated options"
start = marker + " start"
stop = marker + " stop"
end = ">}}"
def find_backends():
"""Return a list of all backends"""
@ -38,11 +39,11 @@ def alter_doc(backend):
if not in_docs:
if start in line:
in_docs = True
start_full = start + " - DO NOT EDIT, instead edit fs.RegInfo in backend/%s/%s.go then run make backenddocs -->\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)

10
bin/make_manual.py
View file

@ -111,15 +111,21 @@ def read_doc(doc):
contents = parts[2].strip()+"\n\n"
# Remove icons
contents = re.sub(r'<i class="fa.*?</i>\s*', "", contents)
# Interpret img shortcodes
# {{< img ... >}}
contents = re.sub(r'\{\{<\s*img\s+(.*?)>\}\}', r"<img \1>", contents)
# Make any img tags absolute
contents = re.sub(r'(<img.*?src=")/', r"\1https://rclone.org/", contents)
# Make [...](/links/) absolute
contents = re.sub(r'\]\((\/.*?\/(#.*)?)\)', r"](https://rclone.org\1)", contents)
# Add additional links on the front page
contents = re.sub(r'<!--MAINPAGELINK-->', "- [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):

4
bin/make_rc_docs.sh
View file

@ -15,8 +15,8 @@ fusermount -u -z /tmp/rclone/rc_mount > /dev/null 2>&1 || umount /tmp/rclone/rc_
awk '
BEGIN {p=1}
/^<!--- autogenerated start/ {print;system("cat /tmp/rclone/z.md");p=0}
/^<!--- autogenerated stop/ {p=1}
/^\{\{< rem autogenerated start/ {print;system("cat /tmp/rclone/z.md");p=0}
/^\{\{< rem autogenerated stop/ {p=1}
p' docs/content/rc.md > /tmp/rclone/rc.md
mv /tmp/rclone/rc.md docs/content/rc.md

18
cmd/config/config.go
View file

@ -116,11 +116,11 @@ are 100% certain you are already passing obscured passwords then use
`
var configCreateCommand = &cobra.Command{
Use: "create <name> <type> [<key> <value>]*",
Use: "create `name` `type` [`key` `value`]*",
Short: `Create a new remote with name, type and options.`,
Long: `
Create a new remote of <name> with <type> and options. The options
should be passed in pairs of <key> <value>.
Create a new remote of ` + "`name`" + ` with ` + "`type`" + ` and options. The options
should be passed in pairs of ` + "`key` `value`" + `.
For example to make a swift remote of name myremote using auto config
you would do:
@ -159,11 +159,11 @@ func init() {
}
var configUpdateCommand = &cobra.Command{
Use: "update <name> [<key> <value>]+",
Use: "update `name` [`key` `value`]+",
Short: `Update options in an existing remote.`,
Long: `
Update an existing remote's options. The options should be passed in
in pairs of <key> <value>.
in pairs of ` + "`key` `value`" + `.
For example to update the env_auth field of a remote of name myremote
you would do:
@ -191,8 +191,8 @@ require this add an extra parameter thus:
}
var configDeleteCommand = &cobra.Command{
Use: "delete <name>",
Short: `Delete an existing remote <name>.`,
Use: "delete `name`",
Short: "Delete an existing remote `name`.",
Run: func(command *cobra.Command, args []string) {
cmd.CheckArgs(1, 1, command, args)
config.DeleteRemote(args[0])
@ -200,11 +200,11 @@ var configDeleteCommand = &cobra.Command{
}
var configPasswordCommand = &cobra.Command{
Use: "password <name> [<key> <value>]+",
Use: "password `name` [`key` `value`]+",
Short: `Update password in an existing remote.`,
Long: `
Update an existing remote's password. The password
should be passed in pairs of <key> <value>.
should be passed in pairs of ` + "`key` `value`" + `.
For example to set password of a remote of name myremote you would do:

2
cmd/ncdu/ncdu.go
View file

@ -35,7 +35,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?".
<script src="https://asciinema.org/a/157793.js" id="asciicast-157793" async></script>
{{< 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

2
cmd/serve/restic/restic.go
View file

@ -118,7 +118,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 "/<username>/".
with a path of ` + "`/<username>/`" + `.
` + httplib.Help,
Run: func(command *cobra.Command, args []string) {
cmd.CheckArgs(1, 1, command, args)

2
docs/config.json
View file

@ -25,7 +25,7 @@
"autoHeadingIDType": "blackfriday"
},
"renderer": {
"unsafe": true
"unsafe": false
}
}
}

12
docs/content/_index.md
View file

@ -7,7 +7,7 @@ date: "2020-05-16"
# Rclone syncs your files to cloud storage
<img width="50%" src="/img/logo_on_light__horizontal_color.svg" alt="rclone logo" style="float:right; padding: 5px;">
{{< img width="50%" src="/img/logo_on_light__horizontal_color.svg" alt="rclone logo" style="float:right; padding: 5px;" >}}
- [About rclone.](#about)
- [What is rclone for.](#what)
@ -15,7 +15,7 @@ date: "2020-05-16"
- [What providers does rclone support.](#providers)
- [Download.](/downloads/)
- [Install.](/install/)
<!--MAINPAGELINK-->
{{< rem MAINPAGELINK >}}
## About rclone {#about}
@ -156,7 +156,7 @@ such as WebDAV or S3 that work out of the box.
Links
* <i class="fa fa-home"></i> [Home page](https://rclone.org/)
* <i class="fab fa-github"></i> [GitHub project page for source and bug tracker](https://github.com/rclone/rclone)
* <i class="fa fa-comments"></i> [Rclone Forum](https://forum.rclone.org)
* <i class="fas fa-cloud-download-alt"></i>[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/)

6
docs/content/alias.md
View file

@ -4,7 +4,7 @@ description: "Remote Aliases"
date: "2018-01-30"
---
<i class="fa fa-link"></i> 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
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/alias/alias.go then run make backenddocs -->
{{< 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: ""
<!--- autogenerated options stop -->
{{< rem autogenerated options stop >}}

6
docs/content/amazonclouddrive.md
View file

@ -4,7 +4,7 @@ description: "Rclone docs for Amazon Drive"
date: "2017-06-10"
---
<i class="fab fa-amazon"></i> 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.
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/amazonclouddrive/amazonclouddrive.go then run make backenddocs -->
{{< 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
<!--- autogenerated options stop -->
{{< rem autogenerated options stop >}}
### Limitations ###

4
docs/content/authors.md
View file

@ -12,9 +12,9 @@ Authors
Contributors
------------
<!--- NB email addresses removed from here need to be addeed to
{{< rem `email addresses removed from here need to be addeed to
bin/.ignore-emails to make sure update-authors.py doesn't immediately
put them back in again. -->
put them back in again.` >}}
* Alex Couper <amcouper@gmail.com>
* Leonid Shalupov <leonid@shalupov.com> <shalupov@diverse.org.ru>

40
docs/content/azureblob.md
View file

@ -4,7 +4,7 @@ description: "Rclone docs for Microsoft Azure Blob Storage"
date: "2017-07-30"
---
<i class="fab fa-windows"></i> 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.
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/azureblob/azureblob.go then run make backenddocs -->
{{< 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
<!--- autogenerated options stop -->
{{< rem autogenerated options stop >}}
### Limitations ###

11
docs/content/b2.md
View file

@ -4,7 +4,7 @@ description: "Backblaze B2"
date: "2016-10-25"
---
<i class="fa fa-fire"></i>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
```
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/b2/b2.go then run make backenddocs -->
{{< 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
<!--- autogenerated options stop -->
{{< rem autogenerated options stop >}}

6
docs/content/box.md
View file

@ -4,7 +4,7 @@ description: "Rclone docs for Box"
date: "2015-10-14"
---
<i class="fa fa-archive"></i> 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.
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/box/box.go then run make backenddocs -->
{{< 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
<!--- autogenerated options stop -->
{{< rem autogenerated options stop >}}
### Limitations ###

34
docs/content/cache.md
View file

@ -4,7 +4,7 @@ description: "Rclone docs for cache remote"
date: "2017-09-03"
---
<i class="fa fa-archive"></i> 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:
<span style="color:red">**cloud remote** -> **crypt** -> **cache**</span>
{{<color red>}}**cloud remote** -> **crypt** -> **cache**{{</color>}}
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:
<span style="color:green">**cloud remote** -> **cache** -> **crypt**</span>
{{<color green>}}**cloud remote** -> **cache** -> **crypt**{{</color>}}
#### 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)_
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/cache/cache.go then run make backenddocs -->
{{< 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
<!--- autogenerated options stop -->
### 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] [<arguments>+]
{{< rem autogenerated options stop >}}

6
docs/content/chunker.md
View file

@ -4,7 +4,7 @@ description: "Split-chunking overlay remote"
date: "2019-08-30"
---
<i class="fa fa-cut"></i>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).
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/chunker/chunker.go then run make backenddocs -->
{{< 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.
<!--- autogenerated options stop -->
{{< rem autogenerated options stop >}}

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

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

2
docs/content/commands/rclone_about.md
View file

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

2
docs/content/commands/rclone_authorize.md
View file

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

2
docs/content/commands/rclone_backend.md
View file

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

2
docs/content/commands/rclone_cat.md
View file

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

2
docs/content/commands/rclone_check.md
View file

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

2
docs/content/commands/rclone_cleanup.md
View file

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

4
docs/content/commands/rclone_config.md
View file

@ -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 <name>.
* [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.

8
docs/content/commands/rclone_config_create.md
View file

@ -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 <name> with <type> and options. The options
should be passed in in pairs of <key> <value>.
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 <name> <type> [<key> <value>]* [flags]
rclone config create `name` `type` [`key` `value`]* [flags]
```
## Options

10
docs/content/commands/rclone_config_delete.md
View file

@ -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 <name>."
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 <name>.
Delete an existing remote `name`.
## Synopsis
Delete an existing remote <name>.
Delete an existing remote `name`.
```
rclone config delete <name> [flags]
rclone config delete `name` [flags]
```
## Options

2
docs/content/commands/rclone_config_disconnect.md
View file

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

2
docs/content/commands/rclone_config_dump.md
View file

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

2
docs/content/commands/rclone_config_edit.md
View file

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

2
docs/content/commands/rclone_config_file.md
View file

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

6
docs/content/commands/rclone_config_password.md
View file

@ -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 <key> <value>.
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 <name> [<key> <value>]+ [flags]
rclone config password `name` [`key` `value`]+ [flags]
```
## Options

2
docs/content/commands/rclone_config_providers.md
View file

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

2
docs/content/commands/rclone_config_reconnect.md
View file

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

2
docs/content/commands/rclone_config_show.md
View file

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

6
docs/content/commands/rclone_config_update.md
View file

@ -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 <key> <value>.
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 <name> [<key> <value>]+ [flags]
rclone config update `name` [`key` `value`]+ [flags]
```
## Options

2
docs/content/commands/rclone_config_userinfo.md
View file

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

2
docs/content/commands/rclone_copy.md
View file

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

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

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

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

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

2
docs/content/commands/rclone_cryptcheck.md
View file

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

2
docs/content/commands/rclone_cryptdecode.md
View file

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

2
docs/content/commands/rclone_dedupe.md
View file

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

2
docs/content/commands/rclone_delete.md
View file

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

2
docs/content/commands/rclone_deletefile.md
View file

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

2
docs/content/commands/rclone_genautocomplete.md
View file

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

2
docs/content/commands/rclone_genautocomplete_bash.md
View file

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

2
docs/content/commands/rclone_genautocomplete_fish.md
View file

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

2
docs/content/commands/rclone_genautocomplete_zsh.md
View file

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

2
docs/content/commands/rclone_gendocs.md
View file

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

2
docs/content/commands/rclone_hashsum.md
View file

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

2
docs/content/commands/rclone_link.md
View file

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

2
docs/content/commands/rclone_listremotes.md
View file

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

2
docs/content/commands/rclone_ls.md
View file

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

2
docs/content/commands/rclone_lsd.md
View file

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

2
docs/content/commands/rclone_lsf.md
View file

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

2
docs/content/commands/rclone_lsjson.md
View file

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

2
docs/content/commands/rclone_lsl.md
View file

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

2
docs/content/commands/rclone_md5sum.md
View file

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

2
docs/content/commands/rclone_mkdir.md
View file

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

2
docs/content/commands/rclone_mount.md
View file

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

2
docs/content/commands/rclone_move.md
View file

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

2
docs/content/commands/rclone_moveto.md
View file

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

4
docs/content/commands/rclone_ncdu.md
View file

@ -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?".
<script src="https://asciinema.org/a/157793.js" id="asciicast-157793" async></script>
{{< 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

2
docs/content/commands/rclone_obscure.md
View file

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

2
docs/content/commands/rclone_purge.md
View file

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

2
docs/content/commands/rclone_rc.md
View file

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

2
docs/content/commands/rclone_rcat.md
View file

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

2
docs/content/commands/rclone_rcd.md
View file

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

2
docs/content/commands/rclone_rmdir.md
View file

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

2
docs/content/commands/rclone_rmdirs.md
View file

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

2
docs/content/commands/rclone_serve.md
View file

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

2
docs/content/commands/rclone_serve_dlna.md
View file

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

2
docs/content/commands/rclone_serve_ftp.md
View file

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

2
docs/content/commands/rclone_serve_http.md
View file

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

4
docs/content/commands/rclone_serve_restic.md
View file

@ -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 "/<username>/".
with a path of `/<username>/`.
## Server options

2
docs/content/commands/rclone_serve_sftp.md
View file

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

2
docs/content/commands/rclone_serve_webdav.md
View file

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

2
docs/content/commands/rclone_settier.md
View file

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

2
docs/content/commands/rclone_sha1sum.md
View file

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

2
docs/content/commands/rclone_size.md
View file

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

2
docs/content/commands/rclone_sync.md
View file

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

2
docs/content/commands/rclone_touch.md
View file

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

2
docs/content/commands/rclone_tree.md
View file

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

2
docs/content/commands/rclone_version.md
View file

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

55
docs/content/crypt.md
View file

@ -4,7 +4,7 @@ description: "Encryption overlay remote"
date: "2016-07-28"
---
<i class="fa fa-lock"></i>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.
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/crypt/crypt.go then run make backenddocs -->
{{< 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
<!--- autogenerated options stop -->
### 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] [<arguments>+]
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] [<arguments>+]
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 ##

51
docs/content/donate.md
View file

@ -5,7 +5,7 @@ type: page
date: "2020-05-15"
---
# <i class="fa fa-heart heart"></i> 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 <i class="fa fa-heart heart"></i>
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 <i class="far fa-smile"></i>
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.
<div>
<a class="btn btn-secondary" role="button" href="https://github.com/sponsors/ncw" target="_blank"><i class="fab fa-github" aria-hidden="true"></i> GitHub Sponsors</a>
<div class="dropdown" style="display: inline;">
<a class="btn btn-secondary dropdown-toggle" href="#" role="button" id="dropdownMenuButton" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
<i class="fab fa-paypal" aria-hidden="true"></i> Paypal
</a>
<div class="dropdown-menu" aria-labelledby="dropdownMenuButton">
<span class="dropdown-item"><small class="text-muted">Please check the "monthly" box</small></span>
<a class="dropdown-item" target="_blank" href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=B9JZV25DCP2SJ&source=url">Donate in $ USD</a>
<a class="dropdown-item" target="_blank" href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RGRFXCDDHK3LW&source=url">Donate in £ GBP</a>
<a class="dropdown-item" target="_blank" href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=Y2AMZXSALFBR4&source=url">Donate in € EUR</a>
</div>
</div>
<a class="btn btn-secondary" role="button" href="https://github.com/sponsors/ncw" target="_blank"><i class="fab fa-patreon" aria-hidden="true"></i> Patreon</a>
<a class="btn btn-secondary" role="button" href="https://github.com/sponsors/ncw" target="_blank">Liberapay</a>
</div>
{{< monthly_donations >}}
## One off donations
If you don't want to contribute monthly then of course we'd love a one
off donation.
<div>
<div class="dropdown" style="display: inline;">
<a class="btn btn-secondary dropdown-toggle" href="#" role="button" id="dropdownMenuButton" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
<i class="fab fa-paypal" aria-hidden="true"></i> Paypal
</a>
<div class="dropdown-menu" aria-labelledby="dropdownMenuButton">
<a class="dropdown-item" target="_blank" href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=B9JZV25DCP2SJ&source=url">Donate in $ USD</a>
<a class="dropdown-item" target="_blank" href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RGRFXCDDHK3LW&source=url">Donate in £ GBP</a>
<a class="dropdown-item" target="_blank" href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=Y2AMZXSALFBR4&source=url">Donate in € EUR</a>
</div>
</div>
<a class="btn btn-secondary" role="button" href="https://www.paypal.me/nickcw" target="_blank"><i class="fab fa-paypal" aria-hidden="true"></i> Paypal.me</a>
<div class="dropdown" style="display: inline;">
<a class="btn btn-secondary dropdown-toggle" href="#" role="button" id="dropdownMenuButton" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
<i class="fab fa-bitcoin" aria-hidden="true"></i> Bitcoin
</a>
<div class="dropdown-menu" aria-labelledby="dropdownMenuButton">
<span class="dropdown-item">Bitcoin: scan or click the image or copy the address</span>
<a class="dropdown-item" target="_blank" href="bitcoin:19j3oLUsqBcTRvZ2LSq2phVjsAAJ86xSnk"><img src="/img/ncw-bitcoin-address.png"></a>
<span class="dropdown-item">
<input type="text" value="19j3oLUsqBcTRvZ2LSq2phVjsAAJ86xSnk" size="30" readonly>
<button class="btn btn-secondary copy-to-clipboard" type="button" data-toggle="tooltip" data-placement="button" title="Copy to Clipboard"><i class="fas fa-copy" aria-hidden="true"></i></button></span>
</div>
</div>
</div>
{{< one_off_donations >}}
If you require a receipt or wish to contribute in a different way then
please <a href="mailto:nick@craig-wood.com">drop me an email</a>.
please [drop me an email](mailto:nick@craig-wood.com).

90
docs/content/drive.md
View file

@ -4,7 +4,7 @@ description: "Rclone docs for Google drive"
date: "2016-04-12"
---
<i class="fab fa-google"></i> 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 |
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/drive/drive.go then run make backenddocs -->
{{< 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
<!--- autogenerated options stop -->
### 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] [<arguments>+]
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] [<arguments>+]
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] [<arguments>+]
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 ###

6
docs/content/dropbox.md
View file

@ -4,7 +4,7 @@ description: "Rclone docs for Dropbox"
date: "2020-03-18"
---
<i class="fab fa-dropbox"></i> 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.
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/dropbox/dropbox.go then run make backenddocs -->
{{< 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
<!--- autogenerated options stop -->
{{< rem autogenerated options stop >}}
### Limitations ###

6
docs/content/fichier.md
View file

@ -4,7 +4,7 @@ description: "Rclone docs for 1Fichier"
date: "2015-10-14"
---
<i class="fa fa-archive"></i> 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.
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/fichier/fichier.go then run make backenddocs -->
{{< 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
<!--- autogenerated options stop -->
{{< rem autogenerated options stop >}}

8
docs/content/flags.md
View file

@ -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)
```
@ -322,6 +322,7 @@ and may be set in the config file.
--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)
@ -407,6 +408,7 @@ and may be set in the config file.
--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.
@ -459,7 +461,7 @@ and may be set in the config file.
--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: <nodeid>@<address>:<port>. (default "us-central-1.tardigrade.io")
--tardigrade-satellite-address <nodeid>@<address>:<port> Satellite Address. Custom satellite address should match the format: <nodeid>@<address>:<port>. (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")

6
docs/content/ftp.md
View file

@ -4,7 +4,7 @@ description: "Rclone docs for FTP backend"
date: "2017-01-01"
---
<i class="fa fa-file"></i> 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.
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/ftp/ftp.go then run make backenddocs -->
{{< 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
<!--- autogenerated options stop -->
{{< rem autogenerated options stop >}}
### Limitations ###

6
docs/content/googlecloudstorage.md
View file

@ -4,7 +4,7 @@ description: "Rclone docs for Google Cloud Storage"
date: "2017-07-18"
---
<i class="fab fa-google"></i> 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.
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/googlecloudstorage/googlecloudstorage.go then run make backenddocs -->
{{< 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
<!--- autogenerated options stop -->
{{< rem autogenerated options stop >}}

15
docs/content/googlephotos.md
View file

@ -4,7 +4,7 @@ description: "Rclone docs for Google Photos"
date: "2019-06-25"
---
<i class="fa fa-images"></i> 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).
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/googlephotos/googlephotos.go then run make backenddocs -->
{{< 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
<!--- autogenerated options stop -->
#### --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 >}}

6
docs/content/http.md
View file

@ -4,7 +4,7 @@ description: "Read only remote for HTTP servers"
date: "2017-06-19"
---
<i class="fa fa-globe"></i> 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:
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/http/http.go then run make backenddocs -->
{{< 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
<!--- autogenerated options stop -->
{{< rem autogenerated options stop >}}

6
docs/content/hubic.md
View file

@ -4,7 +4,7 @@ description: "Rclone docs for Hubic"
date: "2016-05-27"
---
<i class="fa fa-space-shuttle"></i> 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.
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/hubic/hubic.go then run make backenddocs -->
{{< 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
<!--- autogenerated options stop -->
{{< rem autogenerated options stop >}}
### Limitations ###

6
docs/content/jottacloud.md
View file

@ -4,7 +4,7 @@ description: "Rclone docs for Jottacloud"
date: "2018-08-07"
---
<i class="fa fa-cloud"></i> 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.
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/jottacloud/jottacloud.go then run make backenddocs -->
{{< 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
<!--- autogenerated options stop -->
{{< rem autogenerated options stop >}}
### Limitations

6
docs/content/koofr.md
View file

@ -4,7 +4,7 @@ description: "Rclone docs for Koofr"
date: "2019-02-25"
---
<i class="fa fa-suitcase"></i> 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.
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/koofr/koofr.go then run make backenddocs -->
{{< 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
<!--- autogenerated options stop -->
{{< rem autogenerated options stop >}}
### Limitations ###

22
docs/content/local.md
View file

@ -4,7 +4,7 @@ description: "Rclone docs for the local filesystem"
date: "2014-04-26"
---
<i class="fas fa-hdd"></i> 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.
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/local/local.go then run make backenddocs -->
{{< 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
<!--- autogenerated options stop -->
{{< rem autogenerated options stop >}}

Some files were not shown because too many files have changed in this diff Show more