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

build: improve backend docs autogenerated marker line

Browse Source 
Replace custom rem hugo shortcode template with HTML comment. HTML comments are now
allowed in Hugo without enabling unsafe HTML parsing.

Improve the text in the comment: Remove unnecessary quoting, and avoid impression that
make backenddocs has to be run and results committed, since we have a lint check which
will then report error because we want to prevent manual changes in autogenerated sections.

Disable the markdownlint rule line-length on the autogenerated marker line.

Make the autogenerated marker detection a bit more robust.

See #8942 for more details.
This commit is contained in:
albertony
2025-11-04 14:56:55 +01:00
parent 8f74e7d331
commit 0f3aa17fb6
72 changed files with 152 additions and 149 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
bin/check_autogenerated_edits.py
View File

@@ -51,9 +51,9 @@ def find_regions(lines):
regions = [] regions = []
start = None start = None
for i, line in enumerate(lines, 1): for i, line in enumerate(lines, 1):
if "rem autogenerated options start" in line: if line.lstrip().startswith("<!-- autogenerated options start "):
start = i start = i
elif "rem autogenerated options stop" in line and start is not None: elif start is not None and line.rstrip().endswith(" autogenerated options stop -->"):
regions.append((start, i)) regions.append((start, i))
start = None start = None
return regions return regions

24
bin/make_backend_docs.py
View File

@@ -9,10 +9,12 @@ import io
import subprocess import subprocess
from pathlib import Path from pathlib import Path
marker = "{{< rem autogenerated options" begin = "<!-- "
start = marker + " start" end = " -->"
stop = marker + " stop" marker = "autogenerated options"
end = ">}}" line_marker_start_prefix = begin + marker + " start "
line_marker_stop = begin + marker + " stop" + end
markdownlint_disable = begin + "markdownlint-disable-line line-length" + end
def find_backends(): def find_backends():
"""Return a list of all backends""" """Return a list of all backends"""
@@ -27,7 +29,7 @@ def output_backend_tool_docs(backend, out, cwd):
"""Output documentation for backend tool to out""" """Output documentation for backend tool to out"""
out.flush() out.flush()
subprocess.call(["./rclone", "--config=/notfound", "backend", "help", backend], stdout=out, stderr=subprocess.DEVNULL) subprocess.call(["./rclone", "--config=/notfound", "backend", "help", backend], stdout=out, stderr=subprocess.DEVNULL)
def alter_doc(backend): def alter_doc(backend):
"""Alter the documentation for backend""" """Alter the documentation for backend"""
rclone_bin_dir = Path(sys.path[0]).parent.absolute() rclone_bin_dir = Path(sys.path[0]).parent.absolute()
@@ -43,23 +45,23 @@ def alter_doc(backend):
in_docs = False in_docs = False
for line in in_file: for line in in_file:
if not in_docs: if not in_docs:
if start in line: if line.lstrip().startswith(line_marker_start_prefix):
in_docs = True in_docs = True
start_full = (start + "\" - DO NOT EDIT - instead edit fs.RegInfo in backend/%s/%s.go then run make backenddocs\" " + end + "\n") % (backend, backend) line_marker_start = (line_marker_start_prefix + "- DO NOT EDIT - instead edit fs.RegInfo in backend/%s/%s.go and run make backenddocs to verify" + end) % (backend, backend)
out_file.write(start_full) out_file.write(line_marker_start + " " + markdownlint_disable + "\n")
output_docs(backend, out_file, rclone_bin_dir) output_docs(backend, out_file, rclone_bin_dir)
output_backend_tool_docs(backend, out_file, rclone_bin_dir) output_backend_tool_docs(backend, out_file, rclone_bin_dir)
out_file.write(stop+" "+end+"\n") out_file.write(line_marker_stop + "\n")
altered = True altered = True
if not in_docs: if not in_docs:
out_file.write(line) out_file.write(line)
if in_docs: if in_docs:
if stop in line: if line.strip() == line_marker_stop:
in_docs = False in_docs = False
os.rename(doc_file, doc_file+"~") os.rename(doc_file, doc_file+"~")
os.rename(new_file, doc_file) os.rename(new_file, doc_file)
if not altered: if not altered:
raise ValueError("Didn't find '%s' markers for in %s" % (start, doc_file)) raise ValueError("Didn't find '%s' markers in %s" % (line_marker_start_prefix, doc_file))
def main(args): def main(args):

2
bin/make_manual.py
View File

@@ -152,7 +152,7 @@ def read_doc(doc):
# Make [...](/links/) absolute # Make [...](/links/) absolute
contents = re.sub(r'\]\((\/.*?\/(#.*)?)\)', r"](https://rclone.org\1)", contents) contents = re.sub(r'\]\((\/.*?\/(#.*)?)\)', r"](https://rclone.org\1)", contents)
# Add additional links on the front page # Add additional links on the front page
contents = re.sub(r'\{\{< rem MAINPAGELINK >\}\}', "- [Donate.](https://rclone.org/donate/)", contents) contents = re.sub(r'<!-- MAINPAGELINK -->', "- [Donate.](https://rclone.org/donate/)", contents)
# Interpret provider shortcode # Interpret provider shortcode
# {{< provider name="Amazon S3" home="https://aws.amazon.com/s3/" config="/s3/" >}} # {{< 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)

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 ' awk '
BEGIN {p=1} BEGIN {p=1}
/^\{\{< rem autogenerated start/ {print;system("cat /tmp/rclone/z.md");p=0} /^<!-- autogenerated start/ {print;system("cat /tmp/rclone/z.md");p=0}
/^\{\{< rem autogenerated stop/ {p=1} /^<!-- autogenerated stop/ {p=1}
p' docs/content/rc.md > /tmp/rclone/rc.md p' docs/content/rc.md > /tmp/rclone/rc.md
mv /tmp/rclone/rc.md docs/content/rc.md mv /tmp/rclone/rc.md docs/content/rc.md

2
docs/content/_index.md
View File

@@ -15,7 +15,7 @@ notoc: true
- [What providers does rclone support?](#providers) - [What providers does rclone support?](#providers)
- [Download](/downloads/) - [Download](/downloads/)
- [Install](/install/) - [Install](/install/)
{{< rem MAINPAGELINK >}} <!-- MAINPAGELINK -->
## About rclone {#about} ## About rclone {#about}

4
docs/content/alias.md
View File

@@ -104,7 +104,7 @@ Copy another local directory to the alias directory called source
rclone copy /home/source remote: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" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/alias/alias.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to alias (Alias for an existing remote). Here are the Standard options specific to alias (Alias for an existing remote).
@@ -137,4 +137,4 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->

5
docs/content/archive.md
View File

@@ -236,7 +236,8 @@ It would be possible to add ISO support fairly easily as the library we use ([go
It would be possible to add write support, but this would only be for creating new archives, not for updating existing archives. It would be possible to add write support, but this would only be for creating new archives, not for updating existing archives.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/archive/archive.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/archive/archive.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to archive (Read archives). Here are the Standard options specific to archive (Read archives).
@@ -283,4 +284,4 @@ Any metadata supported by the underlying remote is read and written.
See the [metadata](/docs/#metadata) docs for more info. See the [metadata](/docs/#metadata) docs for more info.
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->

4
docs/content/authors.md
View File

@@ -12,9 +12,9 @@ description: "Rclone Authors and Contributors"
## Contributors ## Contributors
{{< rem `email addresses removed from here need to be added to <!-- email addresses removed from here need to be added to
bin/.ignore-emails to make sure update-authors.py doesn't immediately 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> - Alex Couper <amcouper@gmail.com>
- Leonid Shalupov <leonid@shalupov.com> <shalupov@diverse.org.ru> - Leonid Shalupov <leonid@shalupov.com> <shalupov@diverse.org.ru>

4
docs/content/azureblob.md
View File

@@ -368,7 +368,7 @@ If you want to access resources with public anonymous access then set
rclone lsf :azureblob,account=ACCOUNT:CONTAINER rclone lsf :azureblob,account=ACCOUNT:CONTAINER
``` ```
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/azureblob/azureblob.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/azureblob/azureblob.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to azureblob (Microsoft Azure Blob Storage). Here are the Standard options specific to azureblob (Microsoft Azure Blob Storage).
@@ -1040,7 +1040,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
### Custom upload headers ### Custom upload headers

4
docs/content/azurefiles.md
View File

@@ -348,7 +348,7 @@ Setting this can be useful if you wish to use the `az` CLI on a host with
a System Managed Identity that you do not want to use. a System Managed Identity that you do not want to use.
Don't set `env_auth` at the same time. Don't set `env_auth` at the same time.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/azurefiles/azurefiles.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/azurefiles/azurefiles.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to azurefiles (Microsoft Azure Files). Here are the Standard options specific to azurefiles (Microsoft Azure Files).
@@ -793,7 +793,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
### Custom upload headers ### Custom upload headers

4
docs/content/b2.md
View File

@@ -371,7 +371,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" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/b2/b2.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to b2 (Backblaze B2). Here are the Standard options specific to b2 (Backblaze B2).
@@ -783,7 +783,7 @@ it would do.
rclone backend cleanup-hidden b2:bucket/path/to/dir rclone backend cleanup-hidden b2:bucket/path/to/dir
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/box.md
View File

@@ -277,7 +277,7 @@ So if the folder you want rclone to use has a URL which looks like
in the browser, then you use `11xxxxxxxxx8` as in the browser, then you use `11xxxxxxxxx8` as
the `root_folder_id` in the config. 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" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/box/box.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to box (Box). Here are the Standard options specific to box (Box).
@@ -509,7 +509,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/cache.md
View File

@@ -325,7 +325,7 @@ Params:
- **withData** = true/false to delete cached data (chunks) as - **withData** = true/false to delete cached data (chunks) as
well *(optional, false by default)* 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" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/cache/cache.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to cache (Cache a remote). Here are the Standard options specific to cache (Cache a remote).
@@ -716,4 +716,4 @@ Print stats on the cache backend in JSON format.
rclone backend stats remote: [options] [<arguments>+] rclone backend stats remote: [options] [<arguments>+]
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->

4
docs/content/chunker.md
View File

@@ -313,7 +313,7 @@ to keep rclone up-to-date to avoid data corruption.
Changing `transactions` is dangerous and requires explicit migration. Changing `transactions` is dangerous and requires explicit migration.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/chunker/chunker.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/chunker/chunker.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to chunker (Transparently chunk/split large files). Here are the Standard options specific to chunker (Transparently chunk/split large files).
@@ -481,4 +481,4 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->

4
docs/content/cloudinary.md
View File

@@ -133,7 +133,7 @@ rclone ls cloudinary-media-library:directory
Cloudinary stores md5 and timestamps for any successful Put automatically and read-only. Cloudinary stores md5 and timestamps for any successful Put automatically and read-only.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/cloudinary/cloudinary.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/cloudinary/cloudinary.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to cloudinary (Cloudinary). Here are the Standard options specific to cloudinary (Cloudinary).
@@ -254,4 +254,4 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->

4
docs/content/combine.md
View File

@@ -133,7 +133,7 @@ with the `AllDrives:` remote.
See [the Google Drive docs](/drive/#drives) for full info. See [the Google Drive docs](/drive/#drives) for full info.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/combine/combine.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/combine/combine.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to combine (Combine several remotes into one). Here are the Standard options specific to combine (Combine several remotes into one).
@@ -183,4 +183,4 @@ Any metadata supported by the underlying remote is read and written.
See the [metadata](/docs/#metadata) docs for more info. See the [metadata](/docs/#metadata) docs for more info.
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->

4
docs/content/compress.md
View File

@@ -124,7 +124,7 @@ The compressed files will be named `*.###########.gz` where `*` is the base
file and the `#` part is base64 encoded size of the uncompressed file. The file file and the `#` part is base64 encoded size of the uncompressed file. The file
names should not be changed by anything other than the rclone compression backend. names should not be changed by anything other than the rclone compression backend.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/compress/compress.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/compress/compress.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to compress (Compress a remote). Here are the Standard options specific to compress (Compress a remote).
@@ -219,4 +219,4 @@ Any metadata supported by the underlying remote is read and written.
See the [metadata](/docs/#metadata) docs for more info. See the [metadata](/docs/#metadata) docs for more info.
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->

4
docs/content/crypt.md
View File

@@ -418,7 +418,7 @@ Use the `rclone cryptcheck` command to check the
integrity of an encrypted remote instead of `rclone check` which can't integrity of an encrypted remote instead of `rclone check` which can't
check the checksums properly. check the checksums properly.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/crypt/crypt.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/crypt/crypt.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to crypt (Encrypt/Decrypt a remote). Here are the Standard options specific to crypt (Encrypt/Decrypt a remote).
@@ -697,7 +697,7 @@ Usage Example:
rclone rc backend/command command=decode fs=crypt: encryptedfile1 [encryptedfile2...] rclone rc backend/command command=decode fs=crypt: encryptedfile1 [encryptedfile2...]
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Backing up an encrypted remote ## Backing up an encrypted remote

4
docs/content/doi.md
View File

@@ -67,7 +67,7 @@ d) Delete this remote
y/e/d> y y/e/d> y
``` ```
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/doi/doi.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/doi/doi.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to doi (DOI datasets). Here are the Standard options specific to doi (DOI datasets).
@@ -188,4 +188,4 @@ will default to those currently in use.
It doesn't return anything. It doesn't return anything.
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->

4
docs/content/drive.md
View File

@@ -598,7 +598,7 @@ Google Documents.
| url | INI style link file | macOS, Windows | | url | INI style link file | macOS, Windows |
| webloc | macOS specific XML format | macOS | | 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" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/drive/drive.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to drive (Google Drive). Here are the Standard options specific to drive (Google Drive).
@@ -1792,7 +1792,7 @@ Third delete all orphaned files to the trash
rclone backend rescue drive: -o delete rclone backend rescue drive: -o delete
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/dropbox.md
View File

@@ -237,7 +237,7 @@ of supported formats at any time.
| html | HTML | HTML document | | html | HTML | HTML document |
| md | Markdown | Markdown text format | | md | Markdown | Markdown text format |
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/dropbox/dropbox.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/dropbox/dropbox.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to dropbox (Dropbox). Here are the Standard options specific to dropbox (Dropbox).
@@ -590,7 +590,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/fichier.md
View File

@@ -124,7 +124,7 @@ name:
Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
as they can't be used in JSON strings. 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" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/fichier/fichier.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to fichier (1Fichier). Here are the Standard options specific to fichier (1Fichier).
@@ -216,7 +216,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/filefabric.md
View File

@@ -161,7 +161,7 @@ $ rclone lsf --dirs-only -Fip --csv filefabric:
The ID for "S3 Storage" would be `120673761`. The ID for "S3 Storage" would be `120673761`.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/filefabric/filefabric.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/filefabric/filefabric.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to filefabric (Enterprise File Fabric). Here are the Standard options specific to filefabric (Enterprise File Fabric).
@@ -294,4 +294,4 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->

4
docs/content/filelu.md
View File

@@ -196,7 +196,7 @@ significant memory usage during list/sync operations. Ensure the
system running `rclone` has sufficient memory and CPU to handle these system running `rclone` has sufficient memory and CPU to handle these
operations. operations.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/filelu/filelu.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/filelu/filelu.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to filelu (FileLu Cloud Storage). Here are the Standard options specific to filelu (FileLu Cloud Storage).
@@ -240,7 +240,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/filescom.md
View File

@@ -126,7 +126,7 @@ selecting more checksums will not affect rclone's operations.
For use with rclone, selecting at least MD5 is recommended so rclone For use with rclone, selecting at least MD5 is recommended so rclone
can do an end to end integrity check. can do an end to end integrity check.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/filescom/filescom.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/filescom/filescom.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to filescom (Files.com). Here are the Standard options specific to filescom (Files.com).
@@ -205,4 +205,4 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->

4
docs/content/ftp.md
View File

@@ -200,7 +200,7 @@ This backend's interactive configuration wizard provides a selection of
sensible encoding settings for major FTP servers: ProFTPd, PureFTPd, VsFTPd. sensible encoding settings for major FTP servers: ProFTPd, PureFTPd, VsFTPd.
Just hit a selection number when prompted. Just hit a selection number when prompted.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/ftp/ftp.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/ftp/ftp.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to ftp (FTP). Here are the Standard options specific to ftp (FTP).
@@ -559,7 +559,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/gofile.md
View File

@@ -155,7 +155,7 @@ root_folder_id = d6341f53-ee65-4f29-9f59-d11e8070b2a0
To restrict rclone to the `Files` directory. To restrict rclone to the `Files` directory.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/gofile/gofile.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/gofile/gofile.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to gofile (Gofile). Here are the Standard options specific to gofile (Gofile).
@@ -243,7 +243,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/googlecloudstorage.md
View File

@@ -355,7 +355,7 @@ To avoid these possibly unnecessary updates, use `--modify-window 1s`.
Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
as they can't be used in JSON strings. 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" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/googlecloudstorage/googlecloudstorage.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)). Here are the Standard options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)).
@@ -818,7 +818,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/googlephotos.md
View File

@@ -244,7 +244,7 @@ filesystem and it is a good target for repeated syncing.
The `shared-album` directory shows albums shared with you or by you. The `shared-album` directory shows albums shared with you or by you.
This is similar to the Sharing tab in the Google Photos web interface. This is similar to the Sharing tab in the Google Photos web interface.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/googlephotos/googlephotos.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/googlephotos/googlephotos.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to google photos (Google Photos). Here are the Standard options specific to google photos (Google Photos).
@@ -538,7 +538,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/hasher.md
View File

@@ -175,7 +175,7 @@ or by full re-read/re-write of the files.
## Configuration reference ## Configuration reference
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/hasher/hasher.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/hasher/hasher.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to hasher (Better checksums for other remotes). Here are the Standard options specific to hasher (Better checksums for other remotes).
@@ -310,7 +310,7 @@ Usage Example:
rclone backend stickyimport hasher:subdir md5 remote:path/to/sum.md5 rclone backend stickyimport hasher:subdir md5 remote:path/to/sum.md5
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Implementation details (advanced) ## Implementation details (advanced)

4
docs/content/hdfs.md
View File

@@ -159,7 +159,7 @@ the following characters are also replaced:
Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8). Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8).
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/hdfs/hdfs.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/hdfs/hdfs.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to hdfs (Hadoop distributed file system). Here are the Standard options specific to hdfs (Hadoop distributed file system).
@@ -253,7 +253,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/hidrive.md
View File

@@ -208,7 +208,7 @@ explicitly needed. For this, the `disable_fetching_member_count` option can be u
See the below section about configuration options for more details. See the below section about configuration options for more details.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/hidrive/hidrive.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/hidrive/hidrive.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to hidrive (HiDrive). Here are the Standard options specific to hidrive (HiDrive).
@@ -458,7 +458,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/http.md
View File

@@ -137,7 +137,7 @@ or:
rclone lsd :http,url='https://beta.rclone.org': rclone lsd :http,url='https://beta.rclone.org':
``` ```
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/http/http.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/http/http.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to http (HTTP). Here are the Standard options specific to http (HTTP).
@@ -287,7 +287,7 @@ will default to those currently in use.
It doesn't return anything. It doesn't return anything.
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/iclouddrive.md
View File

@@ -105,7 +105,7 @@ need to wait a few hours or a day before you can get rclone to work - keep
clearing the config entry and running `rclone reconnect remote:` until rclone clearing the config entry and running `rclone reconnect remote:` until rclone
functions properly. functions properly.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/iclouddrive/iclouddrive.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/iclouddrive/iclouddrive.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to iclouddrive (iCloud Drive). Here are the Standard options specific to iclouddrive (iCloud Drive).
@@ -195,4 +195,4 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->

4
docs/content/imagekit.md
View File

@@ -112,7 +112,7 @@ ImageKit does not support modification times or hashes yet.
No checksums are supported. No checksums are supported.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/imagekit/imagekit.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/imagekit/imagekit.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to imagekit (ImageKit.io). Here are the Standard options specific to imagekit (ImageKit.io).
@@ -233,4 +233,4 @@ Here are the possible system metadata items for the imagekit backend.
See the [metadata](/docs/#metadata) docs for more info. See the [metadata](/docs/#metadata) docs for more info.
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->

4
docs/content/internetarchive.md
View File

@@ -183,7 +183,7 @@ d) Delete this remote
y/e/d> y y/e/d> y
``` ```
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/internetarchive/internetarchive.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/internetarchive/internetarchive.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to internetarchive (Internet Archive). Here are the Standard options specific to internetarchive (Internet Archive).
@@ -351,4 +351,4 @@ Here are the possible system metadata items for the internetarchive backend.
See the [metadata](/docs/#metadata) docs for more info. See the [metadata](/docs/#metadata) docs for more info.
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->

4
docs/content/jottacloud.md
View File

@@ -399,7 +399,7 @@ To view your current quota you can use the `rclone about remote:`
command which will display your usage limit (unless it is unlimited) command which will display your usage limit (unless it is unlimited)
and the current usage. and the current usage.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/jottacloud/jottacloud.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/jottacloud/jottacloud.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to jottacloud (Jottacloud). Here are the Standard options specific to jottacloud (Jottacloud).
@@ -582,7 +582,7 @@ Here are the possible system metadata items for the jottacloud backend.
See the [metadata](/docs/#metadata) docs for more info. See the [metadata](/docs/#metadata) docs for more info.
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/koofr.md
View File

@@ -119,7 +119,7 @@ the following characters are also replaced:
Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
as they can't be used in XML strings. 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" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/koofr/koofr.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to koofr (Koofr, Digi Storage and other Koofr-compatible storage providers). Here are the Standard options specific to koofr (Koofr, Digi Storage and other Koofr-compatible storage providers).
@@ -233,7 +233,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/linkbox.md
View File

@@ -54,7 +54,7 @@ y/e/d> y
``` ```
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/linkbox/linkbox.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/linkbox/linkbox.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to linkbox (Linkbox). Here are the Standard options specific to linkbox (Linkbox).
@@ -85,7 +85,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/local.md
View File

@@ -340,7 +340,7 @@ filesystem.
**NB** This flag is only available on Unix based systems. On systems **NB** This flag is only available on Unix based systems. On systems
where it isn't supported (e.g. Windows) it will be ignored. where it isn't supported (e.g. 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" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/local/local.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Advanced options ### Advanced options
Here are the Advanced options specific to local (Local Disk). Here are the Advanced options specific to local (Local Disk).
@@ -727,4 +727,4 @@ Options:
- "echo": echo the input arguments - "echo": echo the input arguments
- "error": return an error based on option value - "error": return an error based on option value
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->

4
docs/content/mailru.md
View File

@@ -186,7 +186,7 @@ the following characters are also replaced:
Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
as they can't be used in JSON strings. as they can't be used in JSON strings.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/mailru/mailru.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/mailru/mailru.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to mailru (Mail.ru Cloud). Here are the Standard options specific to mailru (Mail.ru Cloud).
@@ -457,7 +457,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/mega.md
View File

@@ -203,7 +203,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 and you are sure the user and the password are correct, likely you
have got the remote blocked for a while. 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" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/mega/mega.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to mega (Mega). Here are the Standard options specific to mega (Mega).
@@ -306,7 +306,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
### Process `killed` ### Process `killed`

4
docs/content/memory.md
View File

@@ -65,7 +65,7 @@ The memory backend supports MD5 hashes and modification times accurate to 1 nS.
The memory backend replaces the [default restricted characters The memory backend replaces the [default restricted characters
set](/overview/#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" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/memory/memory.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Advanced options ### Advanced options
Here are the Advanced options specific to memory (In memory object storage system.). Here are the Advanced options specific to memory (In memory object storage system.).
@@ -81,4 +81,4 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->

4
docs/content/netstorage.md
View File

@@ -242,7 +242,7 @@ for considerations when using "quick-delete". In general, using quick-delete
method will not delete the tree immediately and objects targeted for method will not delete the tree immediately and objects targeted for
quick-delete may still be accessible. quick-delete may still be accessible.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/netstorage/netstorage.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/netstorage/netstorage.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to netstorage (Akamai NetStorage). Here are the Standard options specific to netstorage (Akamai NetStorage).
@@ -356,4 +356,4 @@ the object that will be the target of the symlink (for example, /links/mylink).
Include the file extension for the object, if applicable. Include the file extension for the object, if applicable.
`rclone backend symlink <src> <path>` `rclone backend symlink <src> <path>`
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->

4
docs/content/onedrive.md
View File

@@ -314,7 +314,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 trash, so you will have to do that with one of Microsoft's apps or via
the OneDrive website. the OneDrive website.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/onedrive/onedrive.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/onedrive/onedrive.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to onedrive (Microsoft OneDrive). Here are the Standard options specific to onedrive (Microsoft OneDrive).
@@ -999,7 +999,7 @@ Here are the possible system metadata items for the onedrive backend.
See the [metadata](/docs/#metadata) docs for more info. See the [metadata](/docs/#metadata) docs for more info.
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
### Impersonate other users as Admin ### Impersonate other users as Admin

4
docs/content/opendrive.md
View File

@@ -110,7 +110,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), Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
as they can't be used in JSON strings. 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" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/opendrive/opendrive.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to opendrive (OpenDrive). Here are the Standard options specific to opendrive (OpenDrive).
@@ -199,7 +199,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/oracleobjectstorage/_index.md
View File

@@ -332,7 +332,7 @@ throughput (16M would be sensible). Increasing either of these will
use more memory. The default values are high enough to gain most of use more memory. The default values are high enough to gain most of
the possible performance without using too much memory. the possible performance without using too much memory.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/oracleobjectstorage/oracleobjectstorage.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/oracleobjectstorage/oracleobjectstorage.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to oracleobjectstorage (Oracle Cloud Infrastructure Object Storage). Here are the Standard options specific to oracleobjectstorage (Oracle Cloud Infrastructure Object Storage).
@@ -897,7 +897,7 @@ Options:
- "hours": The number of hours for which this object will be restored. Default is 24 hrs. - "hours": The number of hours for which this object will be restored. Default is 24 hrs.
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Tutorials ## Tutorials

4
docs/content/pcloud.md
View File

@@ -173,7 +173,7 @@ So if the folder you want rclone to use your is "My Music/", then use the return
id from ```rclone lsf``` command (ex. `dxxxxxxxx2`) as the `root_folder_id` variable id from ```rclone lsf``` command (ex. `dxxxxxxxx2`) as the `root_folder_id` variable
value in the config file. value in the config file.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/pcloud/pcloud.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/pcloud/pcloud.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to pcloud (Pcloud). Here are the Standard options specific to pcloud (Pcloud).
@@ -344,4 +344,4 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->

4
docs/content/pikpak.md
View File

@@ -80,7 +80,7 @@ but it does not support changing only the modification time
The MD5 hash algorithm is supported. The MD5 hash algorithm is supported.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/pikpak/pikpak.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/pikpak/pikpak.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to pikpak (PikPak). Here are the Standard options specific to pikpak (PikPak).
@@ -348,7 +348,7 @@ Result:
} }
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/pixeldrain.md
View File

@@ -107,7 +107,7 @@ IDs.
Enter this directory ID in the rclone config and you will be able to access the Enter this directory ID in the rclone config and you will be able to access the
directory. directory.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/pixeldrain/pixeldrain.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/pixeldrain/pixeldrain.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to pixeldrain (Pixeldrain Filesystem). Here are the Standard options specific to pixeldrain (Pixeldrain Filesystem).
@@ -178,4 +178,4 @@ Here are the possible system metadata items for the pixeldrain backend.
See the [metadata](/docs/#metadata) docs for more info. See the [metadata](/docs/#metadata) docs for more info.
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->

4
docs/content/premiumizeme.md
View File

@@ -113,7 +113,7 @@ the following characters are also replaced:
Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
as they can't be used in JSON strings. 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" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/premiumizeme/premiumizeme.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to premiumizeme (premiumize.me). Here are the Standard options specific to premiumizeme (premiumize.me).
@@ -238,7 +238,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/protondrive.md
View File

@@ -134,7 +134,7 @@ to be implemented, so updates from other clients won’t be reflected in the
cache. Thus, if there are concurrent clients accessing the same mount point, cache. Thus, if there are concurrent clients accessing the same mount point,
then we might have a problem with caching the stale data. then we might have a problem with caching the stale data.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/protondrive/protondrive.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/protondrive/protondrive.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to protondrive (Proton Drive). Here are the Standard options specific to protondrive (Proton Drive).
@@ -351,7 +351,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/putio.md
View File

@@ -122,7 +122,7 @@ the following characters are also replaced:
Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
as they can't be used in JSON strings. 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" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/putio/putio.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to putio (Put.io). Here are the Standard options specific to putio (Put.io).
@@ -233,7 +233,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/qingstor.md
View File

@@ -153,7 +153,7 @@ that 0x7F is not replaced.
Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
as they can't be used in JSON strings. 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" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/qingstor/qingstor.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to qingstor (QingCloud Object Storage). Here are the Standard options specific to qingstor (QingCloud Object Storage).
@@ -332,7 +332,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/quatrix.md
View File

@@ -168,7 +168,7 @@ Files you delete with rclone will end up in Trash and be stored there for 30 day
Quatrix also provides an API to permanently delete files and an API to empty the Quatrix also provides an API to permanently delete files and an API to empty the
Trash so that you can remove files permanently from your account. Trash so that you can remove files permanently from your account.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/quatrix/quatrix.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/quatrix/quatrix.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to quatrix (Quatrix by Maytech). Here are the Standard options specific to quatrix (Quatrix by Maytech).
@@ -278,7 +278,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Storage usage ## Storage usage

4
docs/content/rc.md
View File

@@ -577,7 +577,7 @@ And this is equivalent to `/tmp/dir`
``` ```
## Supported commands ## Supported commands
{{< rem autogenerated start "- run make rcdocs - don't edit here" >}} <!-- autogenerated start "- run make rcdocs - don't edit here" -->
### backend/command: Runs a backend command. {#backend-command} ### backend/command: Runs a backend command. {#backend-command}
This takes the following parameters: This takes the following parameters:
@@ -2363,7 +2363,7 @@ supplied and if there is only one VFS in use then that VFS will be
used. If there is more than one VFS in use then the "fs" parameter used. If there is more than one VFS in use then the "fs" parameter
must be supplied. must be supplied.
{{< rem autogenerated stop >}} <!-- autogenerated stop -->
## Accessing the remote control via HTTP {#api-http} ## Accessing the remote control via HTTP {#api-http}

4
docs/content/s3.md
View File

@@ -840,7 +840,7 @@ section, small files that are not uploaded as multipart, use a different tag, ca
the upload to fail. A simple solution is to set the `--s3-upload-cutoff 0` and force the upload to fail. A simple solution is to set the `--s3-upload-cutoff 0` and force
all the files to be uploaded as multipart. all the files to be uploaded as multipart.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/s3/s3.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/s3/s3.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, Exaba, FlashBlade, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu, Zata and others). Here are the Standard options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, Exaba, FlashBlade, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu, Zata and others).
@@ -2522,7 +2522,7 @@ will default to those currently in use.
It doesn't return anything. It doesn't return anything.
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
### Anonymous access to public buckets {#anonymous-access} ### Anonymous access to public buckets {#anonymous-access}

4
docs/content/seafile.md
View File

@@ -296,7 +296,7 @@ Versions between 6.0 and 6.3 haven't been tested and might not work properly.
Each new version of `rclone` is automatically tested against the [latest docker image](https://hub.docker.com/r/seafileltd/seafile-mc/) Each new version of `rclone` is automatically tested against the [latest docker image](https://hub.docker.com/r/seafileltd/seafile-mc/)
of the seafile community server. of the seafile community server.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/seafile/seafile.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/seafile/seafile.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to seafile (seafile). Here are the Standard options specific to seafile (seafile).
@@ -428,5 +428,5 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->

4
docs/content/sftp.md
View File

@@ -428,7 +428,7 @@ with a Windows OpenSSH server, rclone will use a built-in shell command
(see [shell access](#shell-access)). If none of the above is applicable, (see [shell access](#shell-access)). If none of the above is applicable,
`about` will fail. `about` will fail.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/sftp/sftp.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/sftp/sftp.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to sftp (SSH/SFTP). Here are the Standard options specific to sftp (SSH/SFTP).
@@ -1231,7 +1231,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/sharefile.md
View File

@@ -159,7 +159,7 @@ name:
Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
as they can't be used in JSON strings. 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" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/sharefile/sharefile.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to sharefile (Citrix Sharefile). Here are the Standard options specific to sharefile (Citrix Sharefile).
@@ -339,7 +339,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations
Note that ShareFile is case insensitive so you can't have a file called Note that ShareFile is case insensitive so you can't have a file called

4
docs/content/sia.md
View File

@@ -133,7 +133,7 @@ Once configured, you can then use `rclone` like this:
rclone copy /home/source mySia:backup rclone copy /home/source mySia:backup
``` ```
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/sia/sia.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/sia/sia.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to sia (Sia Decentralized Cloud). Here are the Standard options specific to sia (Sia Decentralized Cloud).
@@ -208,7 +208,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/smb.md
View File

@@ -115,7 +115,7 @@ d) Delete this remote
y/e/d> d y/e/d> d
``` ```
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/smb/smb.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/smb/smb.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to smb (SMB / CIFS). Here are the Standard options specific to smb (SMB / CIFS).
@@ -305,4 +305,4 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->

4
docs/content/storj.md
View File

@@ -225,7 +225,7 @@ d) Delete this remote
y/e/d> y y/e/d> y
``` ```
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/storj/storj.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/storj/storj.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to storj (Storj Decentralized Cloud Storage). Here are the Standard options specific to storj (Storj Decentralized Cloud Storage).
@@ -320,7 +320,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Usage ## Usage

4
docs/content/sugarsync.md
View File

@@ -129,7 +129,7 @@ However you can supply the flag `--sugarsync-hard-delete` or set the
config parameter `hard_delete = true` if you would like files to be config parameter `hard_delete = true` if you would like files to be
deleted straight away. deleted straight away.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/sugarsync/sugarsync.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/sugarsync/sugarsync.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to sugarsync (Sugarsync). Here are the Standard options specific to sugarsync (Sugarsync).
@@ -291,7 +291,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/swift.md
View File

@@ -258,7 +258,7 @@ The MD5 hash algorithm is supported.
Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
as they can't be used in JSON strings. as they can't be used in JSON strings.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/swift/swift.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/swift/swift.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to swift (OpenStack Swift (Rackspace Cloud Files, Blomp Cloud Storage, Memset Memstore, OVH)). Here are the Standard options specific to swift (OpenStack Swift (Rackspace Cloud Files, Blomp Cloud Storage, Memset Memstore, OVH)).
@@ -692,7 +692,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/ulozto.md
View File

@@ -164,7 +164,7 @@ root slug.
path. For example, if your remote's `root_folder_slug` corresponds to `/foo/bar`, path. For example, if your remote's `root_folder_slug` corresponds to `/foo/bar`,
`remote:baz/qux` will refer to `ABSOLUTE_ULOZTO_ROOT/foo/bar/baz/qux`. `remote:baz/qux` will refer to `ABSOLUTE_ULOZTO_ROOT/foo/bar/baz/qux`.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/ulozto/ulozto.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/ulozto/ulozto.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to ulozto (Uloz.to). Here are the Standard options specific to ulozto (Uloz.to).
@@ -257,7 +257,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/union.md
View File

@@ -233,7 +233,7 @@ Rclone does not manage the `:writeback` remote in any way other than writing
files back to it. So if you need to expire old files or manage the size then you files back to it. So if you need to expire old files or manage the size then you
will have to do this yourself. will have to do this yourself.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/union/union.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/union/union.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to union (Union merges the contents of several upstream fs). Here are the Standard options specific to union (Union merges the contents of several upstream fs).
@@ -332,4 +332,4 @@ Any metadata supported by the underlying remote is read and written.
See the [metadata](/docs/#metadata) docs for more info. See the [metadata](/docs/#metadata) docs for more info.
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->

4
docs/content/uptobox.md
View File

@@ -112,7 +112,7 @@ the following characters are also replaced:
Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
as they can't be used in XML strings. as they can't be used in XML strings.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/uptobox/uptobox.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/uptobox/uptobox.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to uptobox (Uptobox). Here are the Standard options specific to uptobox (Uptobox).
@@ -169,7 +169,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/webdav.md
View File

@@ -121,7 +121,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 appear on all objects, or only on objects which had a hash uploaded
with them. with them.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/webdav/webdav.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/webdav/webdav.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to webdav (WebDAV). Here are the Standard options specific to webdav (WebDAV).
@@ -350,7 +350,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Provider notes ## Provider notes

4
docs/content/yandex.md
View File

@@ -125,7 +125,7 @@ are replaced.
Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
as they can't be used in JSON strings. as they can't be used in JSON strings.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/yandex/yandex.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/yandex/yandex.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to yandex (Yandex Disk). Here are the Standard options specific to yandex (Yandex Disk).
@@ -258,7 +258,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Limitations ## Limitations

4
docs/content/zoho.md
View File

@@ -136,7 +136,7 @@ Only control characters and invalid UTF-8 are replaced. In addition most
Unicode full-width characters are not supported at all and will be removed Unicode full-width characters are not supported at all and will be removed
from filenames during upload. from filenames during upload.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/zoho/zoho.go then run make backenddocs" >}} <!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/zoho/zoho.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options ### Standard options
Here are the Standard options specific to zoho (Zoho). Here are the Standard options specific to zoho (Zoho).
@@ -286,7 +286,7 @@ Properties:
- Type: string - Type: string
- Required: false - Required: false
{{< rem autogenerated options stop >}} <!-- autogenerated options stop -->
## Setting up your own client_id ## Setting up your own client_id

0
docs/layouts/shortcodes/rem.html
View File