extern/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2024-11-30 04:15:26 +01:00
Code Issues Packages Projects Releases Wiki Activity
15e1a6bee7
rclone/docs/content/flags.md

568 lines
61 KiB
Markdown
Raw Normal View History

docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
---
title: "Global Flags"
description: "Rclone Global Flags"
---
# Global Flags
Version v1.49.0
2019-08-26 16:25:20 +02:00
This describes the global flags available to every rclone command
split into two groups, non backend and backend flags.
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
## Non Backend Flags
These flags are available for every command.
```
--ask-password Allow prompt for password for encrypted configuration. (default true)
--auto-confirm If enabled, do not request console confirmation.
--backup-dir string Make backups into hierarchy based in DIR.
--bind string Local address to bind to for outgoing connections, IPv4, IPv6 or name.
--buffer-size SizeSuffix In memory buffer size when reading files for each --transfer. (default 16M)
--bwlimit BwTimetable Bandwidth limit in kBytes/s, or use suffix b|k|M|G or a full timetable.
Version v1.53.0
2020-09-02 17:59:04 +02:00
--bwlimit-file BwTimetable Bandwidth limit per file in kBytes/s, or use suffix b|k|M|G or a full timetable.
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--ca-cert string CA certificate used to verify servers
--cache-dir string Directory rclone will use for caching. (default "$HOME/.cache/rclone")
docs: update all auto generated docs
2020-05-25 12:59:33 +02:00
--check-first Do all the checks before starting transfers.
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--checkers int Number of checkers to run in parallel. (default 8)
-c, --checksum Skip based on checksum (if available) & size, not mod-time & size
--client-cert string Client SSL certificate (PEM) for mutual TLS auth
--client-key string Client SSL private key (PEM) for mutual TLS auth
Version v1.51.0
2020-02-01 11:31:42 +01:00
--compare-dest string Include additional server-side path during comparison.
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--config string Config file. (default "$HOME/.config/rclone/rclone.conf")
--contimeout duration Connect timeout (default 1m0s)
Version v1.51.0
2020-02-01 11:31:42 +01:00
--copy-dest string Implies --compare-dest but also copies files from path into destination.
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--cpuprofile string Write cpu profile to file
docs: new flags
2020-05-17 18:54:52 +02:00
--cutoff-mode string Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default "HARD")
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--delete-after When synchronizing, delete files on destination after transferring (default)
--delete-before When synchronizing, delete files on destination before transferring
--delete-during When synchronizing, delete files during transfer
--delete-excluded Delete files on dest excluded from sync
--disable string Disable a comma separated list of features. Use help to see a list.
-n, --dry-run Do a trial run with no permanent changes
--dump DumpFlags List of items to dump from: headers,bodies,requests,responses,auth,filters,goroutines,openfiles
--dump-bodies Dump HTTP headers and bodies - may contain sensitive info
--dump-headers Dump HTTP headers - may contain sensitive info
docs: new flags
2020-05-17 18:54:52 +02:00
--error-on-no-transfer Sets exit code 9 if no files are transferred, useful in scripts
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--exclude stringArray Exclude files matching pattern
docs: new flags
2020-05-17 18:54:52 +02:00
--exclude-from stringArray Read exclude patterns from file (use - to read from stdin)
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--exclude-if-present string Exclude directories if filename is present
Version v1.51.0
2020-02-01 11:31:42 +01:00
--expect-continue-timeout duration Timeout when using expect / 100-continue in HTTP (default 1s)
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--fast-list Use recursive list if available. Uses more memory but fewer transactions.
docs: new flags
2020-05-17 18:54:52 +02:00
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
-f, --filter stringArray Add a file-filtering rule
docs: new flags
2020-05-17 18:54:52 +02:00
--filter-from stringArray Read filtering patterns from a file (use - to read from stdin)
--header stringArray Set HTTP header for all transactions
--header-download stringArray Set HTTP header for download transactions
--header-upload stringArray Set HTTP header for upload transactions
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--ignore-case Ignore case in filters (case insensitive)
--ignore-case-sync Ignore case when synchronizing
--ignore-checksum Skip post copy check of checksums.
--ignore-errors delete even if there are I/O errors
--ignore-existing Skip all files that exist on destination
--ignore-size Ignore size when skipping use mod-time or checksum.
-I, --ignore-times Don't skip files that match size and time - transfer all files
--immutable Do not modify files. Fail if existing files have been modified.
--include stringArray Include files matching pattern
docs: new flags
2020-05-17 18:54:52 +02:00
--include-from stringArray Read include patterns from file (use - to read from stdin)
Version v1.53.0
2020-09-02 17:59:04 +02:00
-i, --interactive Enable interactive mode
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--log-file string Log everything to this file
--log-format string Comma separated list of log format options (default "date,time")
--log-level string Log level DEBUG|INFO|NOTICE|ERROR (default "NOTICE")
Version v1.54.0
2021-02-02 14:42:35 +01:00
--log-systemd Activate systemd integration for the logger.
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--low-level-retries int Number of low level retries to do. (default 10)
--max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
--max-backlog int Maximum number of objects in sync or check backlog. (default 10000)
--max-delete int When synchronizing, limit the number of deletes (default -1)
--max-depth int If set limits the recursion depth to this. (default -1)
Version v1.51.0
2020-02-01 11:31:42 +01:00
--max-duration duration Maximum duration rclone will transfer data for.
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--max-size SizeSuffix Only transfer files smaller than this in k or suffix b|k|M|G (default off)
Version v1.49.0
2019-08-26 16:25:20 +02:00
--max-stats-groups int Maximum number of stats groups to keep in memory. On max oldest is discarded. (default 1000)
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--max-transfer SizeSuffix Maximum size of data to transfer. (default off)
--memprofile string Write memory profile to file
--min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
--min-size SizeSuffix Only transfer files bigger than this in k or suffix b|k|M|G (default off)
--modify-window duration Max time diff to be considered the same (default 1ns)
--multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size. (default 250M)
--multi-thread-streams int Max number of streams to use for multi-thread downloads. (default 4)
--no-check-certificate Do not verify the server SSL certificate. Insecure.
Version v1.51.0
2020-02-01 11:31:42 +01:00
--no-check-dest Don't check the destination, copy regardless.
Version v1.54.0
2021-02-02 14:42:35 +01:00
--no-console Hide console window. Supported on Windows only.
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--no-gzip-encoding Don't set Accept-Encoding: gzip.
--no-traverse Don't traverse destination file system on copy.
docs: new flags
2020-05-17 18:54:52 +02:00
--no-unicode-normalization Don't normalize unicode characters in filenames.
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--no-update-modtime Don't update destination mod-time if files identical.
docs: spelling: e.g. Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2020-10-13 23:49:58 +02:00
--order-by string Instructions on how to order the transfers, e.g. 'size,descending'
Version v1.51.0
2020-02-01 11:31:42 +01:00
--password-command SpaceSepList Command for supplying password for encrypted configuration.
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
-P, --progress Show progress during transfer.
Version v1.54.0
2021-02-02 14:42:35 +01:00
--progress-terminal-title Show progress on the terminal title. Requires -P/--progress.
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
-q, --quiet Print as little stuff as possible
--rc Enable the remote control server.
--rc-addr string IPaddress:Port or :Port to bind server to. (default "localhost:5572")
Version v1.49.0
2019-08-26 16:25:20 +02:00
--rc-allow-origin string Set the allowed origin for CORS.
--rc-baseurl string Prefix for URLs - leave blank for root.
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--rc-cert string SSL PEM key (concatenation of certificate and CA certificate)
--rc-client-ca string Client certificate authority to verify clients with
docs: new flags
2020-05-17 18:54:52 +02:00
--rc-enable-metrics Enable prometheus metrics on /metrics
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--rc-files string Path to local files to serve on the HTTP server.
--rc-htpasswd string htpasswd file - if not provided no authentication is done
--rc-job-expire-duration duration expire finished async jobs older than this value (default 1m0s)
--rc-job-expire-interval duration interval to check for expired async jobs (default 10s)
--rc-key string SSL PEM Private key
--rc-max-header-bytes int Maximum size of request header (default 4096)
--rc-no-auth Don't require auth for certain methods.
--rc-pass string Password for authentication.
--rc-realm string realm for authentication (default "rclone")
--rc-serve Enable the serving of remote objects.
--rc-server-read-timeout duration Timeout for server reading data (default 1h0m0s)
--rc-server-write-timeout duration Timeout for server writing data (default 1h0m0s)
docs: new flags
2020-05-17 18:54:52 +02:00
--rc-template string User Specified Template.
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--rc-user string User name for authentication.
Version v1.49.0
2019-08-26 16:25:20 +02:00
--rc-web-fetch-url string URL to fetch the releases for webgui. (default "https://api.github.com/repos/rclone/rclone-webui-react/releases/latest")
--rc-web-gui Launch WebGUI on localhost
rcd: move webgui apart; option to disable browser Fix #3601, #3785
2020-01-12 10:12:04 +01:00
--rc-web-gui-force-update Force update to latest version of web gui
Version v1.51.0
2020-02-01 11:31:42 +01:00
--rc-web-gui-no-open-browser Don't open the browser automatically
--rc-web-gui-update Check and update to latest version of web gui
Version v1.53.0
2020-09-02 17:59:04 +02:00
--refresh-times Refresh the modtime of remote files.
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--retries int Retry operations this many times if they fail (default 3)
--retries-sleep duration Interval between retrying operations if they fail, e.g 500ms, 60s, 5m. (0 to disable)
--size-only Skip based on size only, not mod-time or checksum
--stats duration Interval between printing stats, e.g 500ms, 60s, 5m. (0 to disable) (default 1m0s)
--stats-file-name-length int Max file name length in stats. 0 for no limit (default 45)
--stats-log-level string Log level to show --stats output DEBUG|INFO|NOTICE|ERROR (default "INFO")
--stats-one-line Make the stats fit on one line.
--stats-one-line-date Enables --stats-one-line and add current date/time prefix.
--stats-one-line-date-format string Enables --stats-one-line-date and uses custom formatted date. Enclose date string in double quotes ("). See https://golang.org/pkg/time/#Time.Format
--stats-unit string Show data rate in stats as either 'bits' or 'bytes'/s (default "bytes")
--streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown. Upload starts after reaching cutoff or when file ends. (default 100k)
Version v1.49.0
2019-08-26 16:25:20 +02:00
--suffix string Suffix to add to changed files.
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--suffix-keep-extension Preserve the extension when using --suffix.
--syslog Use Syslog for logging
docs: spelling: e.g. Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2020-10-13 23:49:58 +02:00
--syslog-facility string Facility for syslog, e.g. KERN,USER,... (default "DAEMON")
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--timeout duration IO idle timeout (default 5m0s)
--tpslimit float Limit HTTP transactions per second to this.
--tpslimit-burst int Max burst of transactions for --tpslimit. (default 1)
docs: spelling: server-side Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2020-10-13 23:43:40 +02:00
--track-renames When synchronizing, track file renames and do a server-side move if possible
Version v1.53.0
2020-09-02 17:59:04 +02:00
--track-renames-strategy string Strategies to use when synchronizing using track-renames hash|modtime|leaf (default "hash")
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--transfers int Number of file transfers to run in parallel. (default 4)
-u, --update Skip files that are newer on the destination.
--use-cookies Enable session cookiejar.
Version v1.49.0
2019-08-26 16:25:20 +02:00
--use-json-log Use json log format.
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
--use-mmap Use mmap allocator (see docs).
--use-server-modtime Use server modified time instead of object metadata
Version v1.54.0
2021-02-02 14:42:35 +01:00
--user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.54.0")
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
-v, --verbose count Print lots more stuff (repeat for more)
```
## Backend Flags
These flags are available for every command. They control the backends
and may be set in the config file.
```
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--acd-auth-url string Auth server URL.
Version v1.53.0
2020-09-02 17:59:04 +02:00
--acd-client-id string OAuth Client Id
--acd-client-secret string OAuth Client Secret
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--acd-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot)
--acd-templink-threshold SizeSuffix Files >= this size will be downloaded via their tempLink. (default 9G)
Version v1.53.0
2020-09-02 17:59:04 +02:00
--acd-token string OAuth Access Token as a JSON blob.
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--acd-token-url string Token server url.
--acd-upload-wait-per-gb Duration Additional time per GB to wait after a failed complete upload to see if it appears. (default 3m0s)
--alias-remote string Remote or path to alias.
--azureblob-access-tier string Access tier of blob: hot, cool or archive.
--azureblob-account string Storage Account Name (leave blank to use SAS URL or Emulator)
Version v1.54.0
2021-02-02 14:42:35 +01:00
--azureblob-archive-tier-delete Delete archive tier blobs before overwriting.
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--azureblob-chunk-size SizeSuffix Upload chunk size (<= 100MB). (default 4M)
--azureblob-disable-checksum Don't store MD5 checksum with object metadata.
--azureblob-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8)
--azureblob-endpoint string Endpoint for the service
--azureblob-key string Storage Account Key (leave blank to use SAS URL or Emulator)
--azureblob-list-chunk int Size of blob list. (default 5000)
--azureblob-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s)
--azureblob-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool.
Version v1.54.0
2021-02-02 14:42:35 +01:00
--azureblob-msi-client-id string Object ID of the user-assigned MSI to use, if any. Leave blank if msi_object_id or msi_mi_res_id specified.
--azureblob-msi-mi-res-id string Azure resource ID of the user-assigned MSI to use, if any. Leave blank if msi_client_id or msi_object_id specified.
--azureblob-msi-object-id string Object ID of the user-assigned MSI to use, if any. Leave blank if msi_client_id or msi_mi_res_id specified.
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--azureblob-sas-url string SAS URL for container level access only
Version v1.54.0
2021-02-02 14:42:35 +01:00
--azureblob-service-principal-file string Path to file containing credentials for use with a service principal.
--azureblob-upload-cutoff string Cutoff for switching to chunked upload (<= 256MB). (Deprecated)
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--azureblob-use-emulator Uses local storage emulator if provided as 'true' (leave blank if using real azure storage endpoint)
Version v1.54.0
2021-02-02 14:42:35 +01:00
--azureblob-use-msi Use a managed service identity to authenticate (only works in Azure)
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--b2-account string Account ID or Application Key ID
--b2-chunk-size SizeSuffix Upload chunk size. Must fit in memory. (default 96M)
Version v1.53.0
2020-09-02 17:59:04 +02:00
--b2-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4G)
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--b2-disable-checksum Disable checksums for large (> upload cutoff) files
--b2-download-auth-duration Duration Time before the authorization token will expire in s or suffix ms|s|m|h|d. (default 1w)
--b2-download-url string Custom endpoint for downloads.
--b2-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
--b2-endpoint string Endpoint for the service.
--b2-hard-delete Permanently delete files on remote removal, otherwise hide files.
--b2-key string Application Key
Version v1.53.0
2020-09-02 17:59:04 +02:00
--b2-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s)
--b2-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool.
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--b2-test-mode string A flag string for X-Bz-Test-Mode header for debugging.
--b2-upload-cutoff SizeSuffix Cutoff for switching to chunked upload. (default 200M)
--b2-versions Include old versions in directory listings.
Version v1.53.0
2020-09-02 17:59:04 +02:00
--box-access-token string Box App Primary Access Token
--box-auth-url string Auth server URL.
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--box-box-config-file string Box App config.json location
--box-box-sub-type string (default "user")
Version v1.53.0
2020-09-02 17:59:04 +02:00
--box-client-id string OAuth Client Id
--box-client-secret string OAuth Client Secret
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--box-commit-retries int Max number of times to try committing a multipart file. (default 100)
--box-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot)
--box-root-folder-id string Fill in for rclone to use a non root folder as its starting point.
Version v1.53.0
2020-09-02 17:59:04 +02:00
--box-token string OAuth Access Token as a JSON blob.
--box-token-url string Token server url.
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--box-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (>= 50MB). (default 50M)
--cache-chunk-clean-interval Duration How often should the cache perform cleanups of the chunk storage. (default 1m0s)
--cache-chunk-no-memory Disable the in-memory cache for storing chunks during streaming.
--cache-chunk-path string Directory to cache chunk files. (default "$HOME/.cache/rclone/cache-backend")
--cache-chunk-size SizeSuffix The size of a chunk (partial file data). (default 5M)
--cache-chunk-total-size SizeSuffix The total size that the chunks can take up on the local disk. (default 10G)
--cache-db-path string Directory to store file structure metadata DB. (default "$HOME/.cache/rclone/cache-backend")
--cache-db-purge Clear all the cached data for this remote on start.
--cache-db-wait-time Duration How long to wait for the DB to be available - 0 is unlimited (default 1s)
docs: spelling: etc. Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2020-10-14 00:07:12 +02:00
--cache-info-age Duration How long to cache file structure information (directory listings, file size, times, etc.). (default 6h0m0s)
docs: update all auto generated docs
2020-05-25 12:59:33 +02:00
--cache-plex-insecure string Skip all certificate verification when connecting to the Plex server
Version v1.53.0
2020-09-02 17:59:04 +02:00
--cache-plex-password string The password of the Plex user (obscured)
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--cache-plex-url string The URL of the Plex server
--cache-plex-username string The username of the Plex user
--cache-read-retries int How many times to retry a read from a cache storage. (default 10)
--cache-remote string Remote to cache.
--cache-rps int Limits the number of requests per second to the source FS (-1 to disable) (default -1)
--cache-tmp-upload-path string Directory to keep temporary files until they are uploaded.
--cache-tmp-wait-time Duration How long should files be stored in local cache before being uploaded (default 15s)
--cache-workers int How many workers should run in parallel to download chunks. (default 4)
--cache-writes Cache file data on writes through the FS
--chunker-chunk-size SizeSuffix Files larger than chunk size will be split in chunks. (default 2G)
--chunker-fail-hard Choose how chunker should handle files with missing or invalid chunks.
--chunker-hash-type string Choose how chunker handles hash sums. All modes but "none" require metadata. (default "md5")
--chunker-remote string Remote to chunk/unchunk.
Version v1.54.0
2021-02-02 14:42:35 +01:00
--compress-level int GZIP compression level (-2 to 9). (default -1)
--compress-mode string Compression mode. (default "gzip")
--compress-ram-cache-limit SizeSuffix Some remotes don't allow the upload of files with unknown size. (default 20M)
--compress-remote string Remote to compress.
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
-L, --copy-links Follow symlinks and copy the pointed to item.
--crypt-directory-name-encryption Option to either encrypt directory names or leave them intact. (default true)
--crypt-filename-encryption string How to encrypt the filenames. (default "standard")
Version v1.53.0
2020-09-02 17:59:04 +02:00
--crypt-password string Password or pass phrase for encryption. (obscured)
--crypt-password2 string Password or pass phrase for salt. Optional but recommended. (obscured)
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--crypt-remote string Remote to encrypt/decrypt.
docs: spelling: e.g. Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2020-10-13 23:49:58 +02:00
--crypt-server-side-across-configs Allow server-side operations (e.g. copy) to work across different crypt configs.
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--crypt-show-mapping For all files listed show how the names encrypt.
--drive-acknowledge-abuse Set to allow files which return cannotDownloadAbusiveFile to be downloaded.
--drive-allow-import-name-change Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time.
--drive-auth-owner-only Only consider files owned by the authenticated user.
Version v1.53.0
2020-09-02 17:59:04 +02:00
--drive-auth-url string Auth server URL.
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--drive-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 8M)
Version v1.54.0
2021-02-02 14:42:35 +01:00
--drive-client-id string Google Application Client Id
Version v1.53.0
2020-09-02 17:59:04 +02:00
--drive-client-secret string OAuth Client Secret
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--drive-disable-http2 Disable drive using http2 (default true)
--drive-encoding MultiEncoder This sets the encoding for the backend. (default InvalidUtf8)
--drive-export-formats string Comma separated list of preferred formats for downloading Google docs. (default "docx,xlsx,pptx,svg")
--drive-formats string Deprecated: see export_formats
--drive-impersonate string Impersonate this user when using a service account.
--drive-import-formats string Comma separated list of preferred formats for uploading Google docs.
--drive-keep-revision-forever Keep new head revision of each file forever.
--drive-list-chunk int Size of listing chunk 100-1000. 0 to disable. (default 1000)
--drive-pacer-burst int Number of API calls to allow without sleeping. (default 100)
--drive-pacer-min-sleep Duration Minimum time to sleep between API calls. (default 100ms)
--drive-root-folder-id string ID of the root folder
--drive-scope string Scope that rclone should use when requesting access from drive.
docs: spelling: e.g. Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2020-10-13 23:49:58 +02:00
--drive-server-side-across-configs Allow server-side operations (e.g. copy) to work across different drive configs.
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--drive-service-account-credentials string Service Account Credentials JSON blob
--drive-service-account-file string Service Account Credentials JSON file path
--drive-shared-with-me Only show files that are shared with me.
--drive-size-as-quota Show sizes as storage quota usage, not actual size.
--drive-skip-checksum-gphotos Skip MD5 checksum on Google photos and videos only.
--drive-skip-gdocs Skip google documents in all listings.
--drive-skip-shortcuts If set skip shortcut files
Version v1.53.0
2020-09-02 17:59:04 +02:00
--drive-starred-only Only show files that are starred.
Version v1.54.0
2021-02-02 14:42:35 +01:00
--drive-stop-on-download-limit Make download limit errors be fatal
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--drive-stop-on-upload-limit Make upload limit errors be fatal
--drive-team-drive string ID of the Team Drive
Version v1.53.0
2020-09-02 17:59:04 +02:00
--drive-token string OAuth Access Token as a JSON blob.
--drive-token-url string Token server url.
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--drive-trashed-only Only show files that are in the trash.
--drive-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 8M)
--drive-use-created-date Use file created date instead of modified date.,
--drive-use-shared-date Use date file was shared instead of modified date.
--drive-use-trash Send files to the trash instead of deleting permanently. (default true)
--drive-v2-download-min-size SizeSuffix If Object's are greater, use drive v2 API to download. (default off)
Version v1.53.0
2020-09-02 17:59:04 +02:00
--dropbox-auth-url string Auth server URL.
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--dropbox-chunk-size SizeSuffix Upload chunk size. (< 150M). (default 48M)
Version v1.53.0
2020-09-02 17:59:04 +02:00
--dropbox-client-id string OAuth Client Id
--dropbox-client-secret string OAuth Client Secret
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--dropbox-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot)
--dropbox-impersonate string Impersonate this user when using a business account.
Version v1.54.0
2021-02-02 14:42:35 +01:00
--dropbox-shared-files Instructs rclone to work on individual shared files.
--dropbox-shared-folders Instructs rclone to work on shared folders.
Version v1.53.0
2020-09-02 17:59:04 +02:00
--dropbox-token string OAuth Access Token as a JSON blob.
--dropbox-token-url string Token server url.
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--fichier-api-key string Your API Key, get it from https://1fichier.com/console/params.pl
--fichier-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot)
--fichier-shared-folder string If you want to download a shared folder, add this parameter
Version v1.54.0
2021-02-02 14:42:35 +01:00
--filefabric-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot)
--filefabric-permanent-token string Permanent Authentication Token
--filefabric-root-folder-id string ID of the root folder
--filefabric-token string Session Token
--filefabric-token-expiry string Token expiry time
--filefabric-url string URL of the Enterprise File Fabric to connect to
--filefabric-version string Version read from the file fabric
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--ftp-concurrency int Maximum number of FTP simultaneous connections, 0 for unlimited
--ftp-disable-epsv Disable using EPSV even if server advertises support
Version v1.54.0
2021-02-02 14:42:35 +01:00
--ftp-disable-mlsd Disable using MLSD even if server advertises support
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--ftp-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,RightSpace,Dot)
Version v1.54.0
2021-02-02 14:42:35 +01:00
--ftp-explicit-tls Use Explicit FTPS (FTP over TLS)
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--ftp-host string FTP host to connect to
--ftp-no-check-certificate Do not verify the TLS certificate of the server
Version v1.53.0
2020-09-02 17:59:04 +02:00
--ftp-pass string FTP password (obscured)
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--ftp-port string FTP port, leave blank to use default (21)
Version v1.54.0
2021-02-02 14:42:35 +01:00
--ftp-tls Use Implicit FTPS (FTP over TLS)
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--ftp-user string FTP username, leave blank for current username, $USER
Version v1.53.0
2020-09-02 17:59:04 +02:00
--gcs-anonymous Access public buckets and objects without credentials
--gcs-auth-url string Auth server URL.
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--gcs-bucket-acl string Access Control List for new buckets.
--gcs-bucket-policy-only Access checks should use bucket-level IAM policies.
Version v1.53.0
2020-09-02 17:59:04 +02:00
--gcs-client-id string OAuth Client Id
--gcs-client-secret string OAuth Client Secret
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--gcs-encoding MultiEncoder This sets the encoding for the backend. (default Slash,CrLf,InvalidUtf8,Dot)
--gcs-location string Location for the newly created buckets.
--gcs-object-acl string Access Control List for new objects.
--gcs-project-number string Project number.
--gcs-service-account-file string Service Account Credentials JSON file path
--gcs-storage-class string The storage class to use when storing objects in Google Cloud Storage.
Version v1.53.0
2020-09-02 17:59:04 +02:00
--gcs-token string OAuth Access Token as a JSON blob.
--gcs-token-url string Token server url.
--gphotos-auth-url string Auth server URL.
--gphotos-client-id string OAuth Client Id
--gphotos-client-secret string OAuth Client Secret
Version v1.54.0
2021-02-02 14:42:35 +01:00
--gphotos-include-archived Also view and download archived media.
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--gphotos-read-only Set to make the Google Photos backend read only.
--gphotos-read-size Set to read the size of media items.
--gphotos-start-year int Year limits the photos to be downloaded to those which are uploaded after the given year (default 2000)
Version v1.53.0
2020-09-02 17:59:04 +02:00
--gphotos-token string OAuth Access Token as a JSON blob.
--gphotos-token-url string Token server url.
Version v1.54.0
2021-02-02 14:42:35 +01:00
--hdfs-data-transfer-protection string Kerberos data transfer protection: authentication|integrity|privacy
--hdfs-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Colon,Del,Ctl,InvalidUtf8,Dot)
--hdfs-namenode string hadoop name node and port
--hdfs-service-principal-name string Kerberos service principal name for the namenode
--hdfs-username string hadoop user name
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--http-headers CommaSepList Set HTTP headers for all transactions
--http-no-head Don't use HEAD requests to find file sizes in dir listing
--http-no-slash Set this if the site doesn't end directories with /
--http-url string URL of http host to connect to
Version v1.53.0
2020-09-02 17:59:04 +02:00
--hubic-auth-url string Auth server URL.
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--hubic-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G)
Version v1.53.0
2020-09-02 17:59:04 +02:00
--hubic-client-id string OAuth Client Id
--hubic-client-secret string OAuth Client Secret
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--hubic-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8)
--hubic-no-chunk Don't chunk files during streaming upload.
Version v1.53.0
2020-09-02 17:59:04 +02:00
--hubic-token string OAuth Access Token as a JSON blob.
--hubic-token-url string Token server url.
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--jottacloud-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot)
--jottacloud-hard-delete Delete files permanently rather than putting them into the trash.
--jottacloud-md5-memory-limit SizeSuffix Files bigger than this will be cached on disk to calculate the MD5 if required. (default 10M)
--jottacloud-trashed-only Only show files that are in the trash.
--jottacloud-upload-resume-limit SizeSuffix Files bigger than this can be resumed if the upload fail's. (default 10M)
--koofr-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
--koofr-endpoint string The Koofr API endpoint to use (default "https://app.koofr.net")
--koofr-mountid string Mount ID of the mount to use. If omitted, the primary mount is used.
Version v1.53.0
2020-09-02 17:59:04 +02:00
--koofr-password string Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password) (obscured)
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--koofr-setmtime Does the backend support setting modification time. Set this to false if you use a mount ID that points to a Dropbox or Amazon Drive backend. (default true)
--koofr-user string Your Koofr user name
-l, --links Translate symlinks to/from regular files with a '.rclonelink' extension
--local-case-insensitive Force the filesystem to report itself as case insensitive
--local-case-sensitive Force the filesystem to report itself as case sensitive.
--local-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Dot)
--local-no-check-updated Don't check to see if the files change during upload
Version v1.53.0
2020-09-02 17:59:04 +02:00
--local-no-set-modtime Disable setting modtime
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--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
Version v1.54.0
2021-02-02 14:42:35 +01:00
--local-zero-size-links Assume the Stat size of links is zero (and read them instead)
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--mailru-check-hash What should copy do if file checksum is mismatched or invalid (default true)
--mailru-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot)
Version v1.53.0
2020-09-02 17:59:04 +02:00
--mailru-pass string Password (obscured)
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--mailru-speedup-enable Skip full upload if there is another file with same data hash. (default true)
--mailru-speedup-file-patterns string Comma separated list of file name patterns eligible for speedup (put by hash). (default "*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf")
--mailru-speedup-max-disk SizeSuffix This option allows you to disable speedup (put by hash) for large files (default 3G)
--mailru-speedup-max-memory SizeSuffix Files larger than the size given below will always be hashed on disk. (default 32M)
--mailru-user string User name (usually email)
--mega-debug Output more debug from Mega.
--mega-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot)
--mega-hard-delete Delete files permanently rather than putting them into the trash.
Version v1.53.0
2020-09-02 17:59:04 +02:00
--mega-pass string Password. (obscured)
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--mega-user string User name
-x, --one-file-system Don't cross filesystem boundaries (unix/macOS only).
Version v1.53.0
2020-09-02 17:59:04 +02:00
--onedrive-auth-url string Auth server URL.
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--onedrive-chunk-size SizeSuffix Chunk size to upload files with - must be multiple of 320k (327,680 bytes). (default 10M)
Version v1.53.0
2020-09-02 17:59:04 +02:00
--onedrive-client-id string OAuth Client Id
--onedrive-client-secret string OAuth Client Secret
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--onedrive-drive-id string The ID of the drive to use
--onedrive-drive-type string The type of the drive ( personal | business | documentLibrary )
Version v1.54.0
2021-02-02 14:42:35 +01:00
--onedrive-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot)
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--onedrive-expose-onenote-files Set to make OneNote files show up in directory listings.
Version v1.54.0
2021-02-02 14:42:35 +01:00
--onedrive-link-password string Set the password for links created by the link command.
--onedrive-link-scope string Set the scope of the links created by the link command. (default "anonymous")
--onedrive-link-type string Set the type of the links created by the link command. (default "view")
Version v1.53.0
2020-09-02 17:59:04 +02:00
--onedrive-no-versions Remove all versions on modifying operations
Version v1.54.0
2021-02-02 14:42:35 +01:00
--onedrive-region string Choose national cloud region for OneDrive. (default "global")
docs: spelling: e.g. Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2020-10-13 23:49:58 +02:00
--onedrive-server-side-across-configs Allow server-side operations (e.g. copy) to work across different onedrive configs.
Version v1.53.0
2020-09-02 17:59:04 +02:00
--onedrive-token string OAuth Access Token as a JSON blob.
--onedrive-token-url string Token server url.
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--opendrive-chunk-size SizeSuffix Files will be uploaded in chunks this size. (default 10M)
--opendrive-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot)
Version v1.53.0
2020-09-02 17:59:04 +02:00
--opendrive-password string Password. (obscured)
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--opendrive-username string Username
Version v1.53.0
2020-09-02 17:59:04 +02:00
--pcloud-auth-url string Auth server URL.
--pcloud-client-id string OAuth Client Id
--pcloud-client-secret string OAuth Client Secret
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--pcloud-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
Version v1.53.0
2020-09-02 17:59:04 +02:00
--pcloud-hostname string Hostname to connect to. (default "api.pcloud.com")
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--pcloud-root-folder-id string Fill in for rclone to use a non root folder as its starting point. (default "d0")
Version v1.53.0
2020-09-02 17:59:04 +02:00
--pcloud-token string OAuth Access Token as a JSON blob.
--pcloud-token-url string Token server url.
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--premiumizeme-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot)
--putio-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
--qingstor-access-key-id string QingStor Access Key ID
--qingstor-chunk-size SizeSuffix Chunk size to use for uploading. (default 4M)
--qingstor-connection-retries int Number of connection retries. (default 3)
--qingstor-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Ctl,InvalidUtf8)
--qingstor-endpoint string Enter an endpoint URL to connection QingStor API.
--qingstor-env-auth Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank.
--qingstor-secret-access-key string QingStor Secret Access Key (password)
--qingstor-upload-concurrency int Concurrency for multipart uploads. (default 1)
--qingstor-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M)
--qingstor-zone string Zone to connect to.
--s3-access-key-id string AWS Access Key ID.
--s3-acl string Canned ACL used when creating buckets and storing or copying objects.
--s3-bucket-acl string Canned ACL used when creating buckets.
--s3-chunk-size SizeSuffix Chunk size to use for uploading. (default 5M)
Version v1.53.0
2020-09-02 17:59:04 +02:00
--s3-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656G)
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--s3-disable-checksum Don't store MD5 checksum with object metadata
Version v1.54.0
2021-02-02 14:42:35 +01:00
--s3-disable-http2 Disable usage of http2 for S3 backends
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--s3-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot)
--s3-endpoint string Endpoint for S3 API.
--s3-env-auth Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
--s3-force-path-style If true use path style access if false use virtual hosted style. (default true)
--s3-leave-parts-on-error If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery.
--s3-list-chunk int Size of listing chunk (response list for each ListObject S3 request). (default 1000)
--s3-location-constraint string Location constraint - must be set to match the Region.
Version v1.53.0
2020-09-02 17:59:04 +02:00
--s3-max-upload-parts int Maximum number of parts in a multipart upload. (default 10000)
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--s3-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s)
--s3-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool.
docs: grammar: if, then Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2020-10-13 23:55:21 +02:00
--s3-no-check-bucket If set, don't attempt to check the bucket exists or create it
Version v1.54.0
2021-02-02 14:42:35 +01:00
--s3-no-head If set, don't HEAD uploaded objects to check integrity
Version v1.53.0
2020-09-02 17:59:04 +02:00
--s3-profile string Profile to use in the shared credentials file
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--s3-provider string Choose your S3 provider.
--s3-region string Region to connect to.
Version v1.54.0
2021-02-02 14:42:35 +01:00
--s3-requester-pays Enables requester pays option when interacting with S3 bucket.
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--s3-secret-access-key string AWS Secret Access Key (password)
--s3-server-side-encryption string The server-side encryption algorithm used when storing this object in S3.
--s3-session-token string An AWS session token
Version v1.53.0
2020-09-02 17:59:04 +02:00
--s3-shared-credentials-file string Path to the shared credentials file
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--s3-sse-customer-algorithm string If using SSE-C, the server-side encryption algorithm used when storing this object in S3.
docs: update all auto generated docs
2020-05-25 12:59:33 +02:00
--s3-sse-customer-key string If using SSE-C you must provide the secret encryption key used to encrypt/decrypt your data.
Version v1.54.0
2021-02-02 14:42:35 +01:00
--s3-sse-customer-key-md5 string If using SSE-C you may provide the secret encryption key MD5 checksum (optional).
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--s3-sse-kms-key-id string If using KMS ID you must provide the ARN of Key.
--s3-storage-class string The storage class to use when storing new objects in S3.
--s3-upload-concurrency int Concurrency for multipart uploads. (default 4)
--s3-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M)
--s3-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint.
--s3-v2-auth If true use v2 authentication.
docs: update all auto generated docs
2020-05-25 12:59:33 +02:00
--seafile-2fa Two-factor authentication ('true' if the account has 2FA enabled)
--seafile-create-library Should rclone create a library if it doesn't exist
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--seafile-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8)
--seafile-library string Name of the library. Leave blank to access all non-encrypted libraries.
Version v1.53.0
2020-09-02 17:59:04 +02:00
--seafile-library-key string Library password (for encrypted libraries only). Leave blank if you pass it through the command line. (obscured)
--seafile-pass string Password (obscured)
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--seafile-url string URL of seafile host to connect to
docs: update all auto generated docs
2020-05-25 12:59:33 +02:00
--seafile-user string User name (usually email address)
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--sftp-ask-password Allow asking for SFTP password when needed.
--sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available.
--sftp-host string SSH host to connect to
--sftp-key-file string Path to PEM-encoded private key file, leave blank or set key-use-agent to use ssh-agent.
Version v1.53.0
2020-09-02 17:59:04 +02:00
--sftp-key-file-pass string The passphrase to decrypt the PEM-encoded private key file. (obscured)
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--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.
Version v1.54.0
2021-02-02 14:42:35 +01:00
--sftp-known-hosts-file string Optional path to known_hosts file.
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--sftp-md5sum-command string The command used to read md5 hashes. Leave blank for autodetect.
Version v1.53.0
2020-09-02 17:59:04 +02:00
--sftp-pass string SSH password, leave blank to use ssh-agent. (obscured)
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--sftp-path-override string Override path used by SSH connection.
--sftp-port string SSH port, leave blank to use default (22)
Version v1.54.0
2021-02-02 14:42:35 +01:00
--sftp-pubkey-file string Optional path to public key file.
Version v1.53.0
2020-09-02 17:59:04 +02:00
--sftp-server-command string Specifies the path or command to run a sftp server on the remote host.
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--sftp-set-modtime Set the modified time on the remote if set. (default true)
--sftp-sha1sum-command string The command used to read sha1 hashes. Leave blank for autodetect.
--sftp-skip-links Set to skip any symlinks and any other non regular files.
Version v1.53.0
2020-09-02 17:59:04 +02:00
--sftp-subsystem string Specifies the SSH2 subsystem on the remote host. (default "sftp")
Version v1.54.0
2021-02-02 14:42:35 +01:00
--sftp-use-fstat If set use fstat instead of stat
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--sftp-use-insecure-cipher Enable the use of insecure ciphers and key exchange methods.
Version v1.54.0
2021-02-02 14:42:35 +01:00
--sftp-user string SSH username, leave blank for current username, $USER
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--sharefile-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 64M)
--sharefile-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot)
--sharefile-endpoint string Endpoint for API calls.
--sharefile-root-folder-id string ID of the root folder
--sharefile-upload-cutoff SizeSuffix Cutoff for switching to multipart upload. (default 128M)
--skip-links Don't warn about skipped symlinks.
--sugarsync-access-key-id string Sugarsync Access Key ID.
--sugarsync-app-id string Sugarsync App ID.
--sugarsync-authorization string Sugarsync authorization
--sugarsync-authorization-expiry string Sugarsync authorization expiry
--sugarsync-deleted-id string Sugarsync deleted folder id
--sugarsync-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Ctl,InvalidUtf8,Dot)
--sugarsync-hard-delete Permanently delete files if true
--sugarsync-private-access-key string Sugarsync Private Access Key
--sugarsync-refresh-token string Sugarsync refresh token
--sugarsync-root-id string Sugarsync root id
--sugarsync-user string Sugarsync user
--swift-application-credential-id string Application Credential ID (OS_APPLICATION_CREDENTIAL_ID)
--swift-application-credential-name string Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME)
--swift-application-credential-secret string Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET)
--swift-auth string Authentication URL for server (OS_AUTH_URL).
--swift-auth-token string Auth Token from alternate authentication - optional (OS_AUTH_TOKEN)
--swift-auth-version int AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION)
--swift-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G)
--swift-domain string User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME)
--swift-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8)
--swift-endpoint-type string Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE) (default "public")
--swift-env-auth Get swift credentials from environment variables in standard OpenStack form.
--swift-key string API key or password (OS_PASSWORD).
Version v1.54.0
2021-02-02 14:42:35 +01:00
--swift-leave-parts-on-error If true avoid calling abort upload on a failure. It should be set to true for resuming uploads across different sessions.
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--swift-no-chunk Don't chunk files during streaming upload.
--swift-region string Region name - optional (OS_REGION_NAME)
--swift-storage-policy string The storage policy to use when creating a new container
--swift-storage-url string Storage URL - optional (OS_STORAGE_URL)
--swift-tenant string Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME)
--swift-tenant-domain string Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME)
--swift-tenant-id string Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID)
--swift-user string User name to log in (OS_USERNAME).
--swift-user-id string User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID).
--tardigrade-access-grant string Access Grant.
--tardigrade-api-key string API Key.
--tardigrade-passphrase string Encryption Passphrase. To access existing objects enter passphrase used for uploading.
--tardigrade-provider string Choose an authentication method. (default "existing")
--tardigrade-satellite-address <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")
--union-search-policy string Policy to choose upstream on SEARCH category. (default "ff")
--union-upstreams string List of space separated upstreams.
docs: spelling: e.g. Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2020-10-13 23:49:58 +02:00
--webdav-bearer-token string Bearer token instead of user/pass (e.g. a Macaroon)
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--webdav-bearer-token-command string Command to run to get a bearer token
Version v1.53.0
2020-09-02 17:59:04 +02:00
--webdav-pass string Password. (obscured)
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--webdav-url string URL of http host to connect to
--webdav-user string User name
--webdav-vendor string Name of the Webdav site/service/software you are using
Version v1.53.0
2020-09-02 17:59:04 +02:00
--yandex-auth-url string Auth server URL.
--yandex-client-id string OAuth Client Id
--yandex-client-secret string OAuth Client Secret
docs: set unsafe HTML parsing to false and fix raw HTML insertion This means that markdown files can't contain <thing> any more.
2020-05-22 13:22:52 +02:00
--yandex-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot)
Version v1.53.0
2020-09-02 17:59:04 +02:00
--yandex-token string OAuth Access Token as a JSON blob.
--yandex-token-url string Token server url.
Version v1.54.0
2021-02-02 14:42:35 +01:00
--zoho-encoding MultiEncoder This sets the encoding for the backend. (default Del,Ctl,InvalidUtf8)
--zoho-region string Zoho region to connect to. You'll have to use the region you organization is registered in.
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 17:18:02 +02:00
```
Reference in New Issue Copy Permalink