Version v1.51.0

This commit is contained in:
Nick Craig-Wood 2020-02-01 10:31:42 +00:00
parent 9f99c20232
commit 43daecd89b
107 changed files with 38444 additions and 25727 deletions

15786
MANUAL.html generated

File diff suppressed because one or more lines are too long

1481
MANUAL.md generated

File diff suppressed because it is too large Load Diff

14872
MANUAL.txt generated

File diff suppressed because it is too large Load Diff

View File

@ -9,12 +9,13 @@ This file describes how to make the various kinds of releases
## Making a release ## Making a release
* git checkout master
* git pull
* git status - make sure everything is checked in * git status - make sure everything is checked in
* Check travis & appveyor builds are green * Check GitHub actions build for master is Green
* make check
* make test # see integration test server or run locally * make test # see integration test server or run locally
* make tag * make tag
* edit docs/content/changelog.md * edit docs/content/changelog.md # make sure to remove duplicate logs from point releases
* make tidy * make tidy
* make doc * make doc
* git status - to check for new man pages - git add them * git status - to check for new man pages - git add them

View File

@ -1 +1 @@
v1.50.2 v1.51.0

View File

@ -262,6 +262,17 @@ underlying S3 storage.
- Type: SizeSuffix - Type: SizeSuffix
- Default: 9G - Default: 9G
#### --acd-encoding
This sets the encoding for the backend.
See: the [encoding section in the overview](/overview/#encoding) for more info.
- Config: encoding
- Env Var: RCLONE_ACD_ENCODING
- Type: MultiEncoder
- Default: Slash,InvalidUtf8,Dot
<!--- autogenerated options stop --> <!--- autogenerated options stop -->
### Limitations ### ### Limitations ###

View File

@ -272,6 +272,17 @@ tiering blob to "Hot" or "Cool".
- Type: string - Type: string
- Default: "" - Default: ""
#### --azureblob-encoding
This sets the encoding for the backend.
See: the [encoding section in the overview](/overview/#encoding) for more info.
- Config: encoding
- Env Var: RCLONE_AZUREBLOB_ENCODING
- Type: MultiEncoder
- Default: Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8
<!--- autogenerated options stop --> <!--- autogenerated options stop -->
### Limitations ### ### Limitations ###

View File

@ -457,5 +457,16 @@ The minimum value is 1 second. The maximum value is one week.
- Type: Duration - Type: Duration
- Default: 1w - Default: 1w
#### --b2-encoding
This sets the encoding for the backend.
See: the [encoding section in the overview](/overview/#encoding) for more info.
- Config: encoding
- Env Var: RCLONE_B2_ENCODING
- Type: MultiEncoder
- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
<!--- autogenerated options stop --> <!--- autogenerated options stop -->

View File

@ -298,6 +298,17 @@ Max number of times to try committing a multipart file.
- Type: int - Type: int
- Default: 100 - Default: 100
#### --box-encoding
This sets the encoding for the backend.
See: the [encoding section in the overview](/overview/#encoding) for more info.
- Config: encoding
- Env Var: RCLONE_BOX_ENCODING
- Type: MultiEncoder
- Default: Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot
<!--- autogenerated options stop --> <!--- autogenerated options stop -->
### Limitations ### ### Limitations ###

View File

@ -1,11 +1,148 @@
--- ---
title: "Documentation" title: "Documentation"
description: "Rclone Changelog" description: "Rclone Changelog"
date: "2019-11-19" date: "2020-02-01"
--- ---
# Changelog # Changelog
## v1.51.0 - 2020-02-01
* New backends
* [Memory](/memory) (Nick Craig-Wood)
* [Sugarsync](/sugarsync) (Nick Craig-Wood)
* New Features
* Adjust all backends to have `--backend-encoding` parameter (Nick Craig-Wood)
* this enables the encoding for special characters to be adjusted or disabled
* Add `--max-duration` flag to control the maximum duration of a transfer session (boosh)
* Add `--expect-continue-timeout` flag, default 1s (Nick Craig-Wood)
* Add `--no-check-dest` flag for copying without testing the destination (Nick Craig-Wood)
* Implement `--order-by` flag to order transfers (Nick Craig-Wood)
* accounting
* Don't show entries in both transferring and checking (Nick Craig-Wood)
* Add option to delete stats (Aleksandar Jankovic)
* build
* Compress the test builds with gzip (Nick Craig-Wood)
* Implement a framework for starting test servers during tests (Nick Craig-Wood)
* cmd: Always print elapsed time to tenth place seconds in progress (Gary Kim)
* config
* Add `--password-command` to allow dynamic config password (Damon Permezel)
* Give config questions default values (Nick Craig-Wood)
* Check a remote exists when creating a new one (Nick Craig-Wood)
* copyurl: Add `--stdout` flag to write to stdout (Nick Craig-Wood)
* dedupe: Implement keep smallest too (Nick Craig-Wood)
* hashsum: Add flag `--base64` flag (landall)
* lsf: Speed up on s3/swift/etc by not reading mimetype by default (Nick Craig-Wood)
* lsjson: Add `--no-mimetype` flag (Nick Craig-Wood)
* rc: Add methods to turn on blocking and mutex profiling (Nick Craig-Wood)
* rcd
* Adding group parameter to stats (Chaitanya)
* Move webgui apart; option to disable browser (Xiaoxing Ye)
* serve sftp: Add support for public key with auth proxy (Paul Tinsley)
* stats: Show deletes in stats and hide zero stats (anuar45)
* Bug Fixes
* accounting
* Fix error counter counting multiple times (Ankur Gupta)
* Fix error count shown as checks (Cnly)
* Clear finished transfer in stats-reset (Maciej Zimnoch)
* Added StatsInfo locking in statsGroups sum function (Michał Matczuk)
* asyncreader: Fix EOF error (buengese)
* check: Fix `--one-way` recursing more directories than it needs to (Nick Craig-Wood)
* chunkedreader: Disable hash calculation for first segment (Nick Craig-Wood)
* config
* Do not open browser on headless on drive/gcs/google photos (Xiaoxing Ye)
* SetValueAndSave ignore error if config section does not exist yet (buengese)
* cmd: Fix completion with an encrypted config (Danil Semelenov)
* dbhashsum: Stop it returning UNSUPPORTED on dropbox (Nick Craig-Wood)
* dedupe: Add missing modes to help string (Nick Craig-Wood)
* operations
* Fix dedupe continuing on errors like insufficientFilePermisson (SezalAgrawal)
* Clear accounting before low level retry (Maciej Zimnoch)
* Write debug message when hashes could not be checked (Ole Schütt)
* Move interface assertion to tests to remove pflag dependency (Nick Craig-Wood)
* Make NewOverrideObjectInfo public and factor uses (Nick Craig-Wood)
* proxy: Replace use of bcrypt with sha256 (Nick Craig-Wood)
* vendor
* Update bazil.org/fuse to fix FreeBSD 12.1 (Nick Craig-Wood)
* Update github.com/t3rm1n4l/go-mega to fix mega "illegal base64 data at input byte 22" (Nick Craig-Wood)
* Update termbox-go to fix ncdu command on FreeBSD (Kuang-che Wu)
* Update t3rm1n4l/go-mega - fixes mega: couldn't login: crypto/aes: invalid key size 0 (Nick Craig-Wood)
* Mount
* Enable async reads for a 20% speedup (Nick Craig-Wood)
* Replace use of WriteAt with Write for cache mode >= writes and O_APPEND (Brett Dutro)
* Make sure we call unmount when exiting (Nick Craig-Wood)
* Don't build on go1.10 as bazil/fuse no longer supports it (Nick Craig-Wood)
* When setting dates discard out of range dates (Nick Craig-Wood)
* VFS
* Add a newly created file straight into the directory (Nick Craig-Wood)
* Only calculate one hash for reads for a speedup (Nick Craig-Wood)
* Make ReadAt for non cached files work better with non-sequential reads (Nick Craig-Wood)
* Fix edge cases when reading ModTime from file (Nick Craig-Wood)
* Make sure existing files opened for write show correct size (Nick Craig-Wood)
* Don't cache the path in RW file objects to fix renaming (Nick Craig-Wood)
* Fix rename of open files when using the VFS cache (Nick Craig-Wood)
* When renaming files in the cache, rename the cache item in memory too (Nick Craig-Wood)
* Fix open file renaming on drive when using `--vfs-cache-mode writes` (Nick Craig-Wood)
* Fix incorrect modtime for mv into mount with `--vfs-cache-modes writes` (Nick Craig-Wood)
* On rename, rename in cache too if the file exists (Anagh Kumar Baranwal)
* Local
* Make source file being updated errors be NoLowLevelRetry errors (Nick Craig-Wood)
* Fix update of hidden files on Windows (Nick Craig-Wood)
* Cache
* Follow move of upstream library github.com/coreos/bbolt github.com/etcd-io/bbolt (Nick Craig-Wood)
* Fix `fatal error: concurrent map writes` (Nick Craig-Wood)
* Crypt
* Reorder the filename encryption options (Thomas Eales)
* Correctly handle trailing dot (buengese)
* Chunker
* Reduce length of temporary suffix (Ivan Andreev)
* Drive
* Add `--drive-stop-on-upload-limit` flag to stop syncs when upload limit reached (Nick Craig-Wood)
* Add `--drive-use-shared-date` to use date file was shared instead of modified date (Garry McNulty)
* Make sure invalid auth for teamdrives always reports an error (Nick Craig-Wood)
* Fix `--fast-list` when using appDataFolder (Nick Craig-Wood)
* Use multipart resumable uploads for streaming and uploads in mount (Nick Craig-Wood)
* Log an ERROR if an incomplete search is returned (Nick Craig-Wood)
* Hide dangerous config from the configurator (Nick Craig-Wood)
* Dropbox
* Treat `insufficient_space` errors as non retriable errors (Nick Craig-Wood)
* Jottacloud
* Use new auth method used by official client (buengese)
* Add URL to generate Login Token to config wizard (Nick Craig-Wood)
* Add support whitelabel versions (buengese)
* Koofr
* Use rclone HTTP client. (jaKa)
* Onedrive
* Add Sites.Read.All permission (Benjamin Richter)
* Add support "Retry-After" header (Motonori IWAMURO)
* Opendrive
* Implement `--opendrive-chunk-size` (Nick Craig-Wood)
* S3
* Re-implement multipart upload to fix memory issues (Nick Craig-Wood)
* Add `--s3-copy-cutoff` for size to switch to multipart copy (Nick Craig-Wood)
* Add new region Asia Patific (Hong Kong) (Outvi V)
* Reduce memory usage streaming files by reducing max stream upload size (Nick Craig-Wood)
* Add `--s3-list-chunk` option for bucket listing (Thomas Kriechbaumer)
* Force path style bucket access to off for AWS deprecation (Nick Craig-Wood)
* Use AWS web identity role provider if available (Tennix)
* Add StackPath Object Storage Support (Dave Koston)
* Fix ExpiryWindow value (Aleksandar Jankovic)
* Fix DisableChecksum condition (Aleksandar Janković)
* Fix URL decoding of NextMarker (Nick Craig-Wood)
* SFTP
* Add `--sftp-skip-links` to skip symlinks and non regular files (Nick Craig-Wood)
* Retry Creation of Connection (Sebastian Brandt)
* Fix "failed to parse private key file: ssh: not an encrypted key" error (Nick Craig-Wood)
* Open files for update write only to fix AWS SFTP interop (Nick Craig-Wood)
* Swift
* Reserve segments of dynamic large object when delete objects in container what was enabled versioning. (Nguyễn Hữu Luân)
* Fix parsing of X-Object-Manifest (Nick Craig-Wood)
* Update OVH API endpoint (unbelauscht)
* WebDAV
* Make nextcloud only upload SHA1 checksums (Nick Craig-Wood)
* Fix case of "Bearer" in Authorization: header to agree with RFC (Nick Craig-Wood)
* Add Referer header to fix problems with WAFs (Nick Craig-Wood)
## v1.50.2 - 2019-11-19 ## v1.50.2 - 2019-11-19
* Bug Fixes * Bug Fixes

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone" title: "rclone"
slug: rclone slug: rclone
url: /commands/rclone/ url: /commands/rclone/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone about" title: "rclone about"
slug: rclone_about slug: rclone_about
url: /commands/rclone_about/ url: /commands/rclone_about/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone authorize" title: "rclone authorize"
slug: rclone_authorize slug: rclone_authorize
url: /commands/rclone_authorize/ url: /commands/rclone_authorize/
@ -15,6 +15,9 @@ Remote authorization. Used to authorize a remote or headless
rclone from a machine with a browser - use as instructed by rclone from a machine with a browser - use as instructed by
rclone config. rclone config.
Use the --auth-no-open-browser to prevent rclone to open auth
link in default browser automatically.
``` ```
rclone authorize [flags] rclone authorize [flags]
``` ```
@ -22,8 +25,8 @@ rclone authorize [flags]
### Options ### Options
``` ```
--auth-no-open-browser Do not automatically open auth link in default browser --auth-no-open-browser Do not automatically open auth link in default browser
-h, --help help for authorize -h, --help help for authorize
``` ```
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone cachestats" title: "rclone cachestats"
slug: rclone_cachestats slug: rclone_cachestats
url: /commands/rclone_cachestats/ url: /commands/rclone_cachestats/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone cat" title: "rclone cat"
slug: rclone_cat slug: rclone_cat
url: /commands/rclone_cat/ url: /commands/rclone_cat/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone check" title: "rclone check"
slug: rclone_check slug: rclone_check
url: /commands/rclone_check/ url: /commands/rclone_check/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone cleanup" title: "rclone cleanup"
slug: rclone_cleanup slug: rclone_cleanup
url: /commands/rclone_cleanup/ url: /commands/rclone_cleanup/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone config" title: "rclone config"
slug: rclone_config slug: rclone_config
url: /commands/rclone_config/ url: /commands/rclone_config/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone config create" title: "rclone config create"
slug: rclone_config_create slug: rclone_config_create
url: /commands/rclone_config_create/ url: /commands/rclone_config_create/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone config delete" title: "rclone config delete"
slug: rclone_config_delete slug: rclone_config_delete
url: /commands/rclone_config_delete/ url: /commands/rclone_config_delete/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone config disconnect" title: "rclone config disconnect"
slug: rclone_config_disconnect slug: rclone_config_disconnect
url: /commands/rclone_config_disconnect/ url: /commands/rclone_config_disconnect/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone config dump" title: "rclone config dump"
slug: rclone_config_dump slug: rclone_config_dump
url: /commands/rclone_config_dump/ url: /commands/rclone_config_dump/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone config edit" title: "rclone config edit"
slug: rclone_config_edit slug: rclone_config_edit
url: /commands/rclone_config_edit/ url: /commands/rclone_config_edit/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone config file" title: "rclone config file"
slug: rclone_config_file slug: rclone_config_file
url: /commands/rclone_config_file/ url: /commands/rclone_config_file/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone config password" title: "rclone config password"
slug: rclone_config_password slug: rclone_config_password
url: /commands/rclone_config_password/ url: /commands/rclone_config_password/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone config providers" title: "rclone config providers"
slug: rclone_config_providers slug: rclone_config_providers
url: /commands/rclone_config_providers/ url: /commands/rclone_config_providers/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone config reconnect" title: "rclone config reconnect"
slug: rclone_config_reconnect slug: rclone_config_reconnect
url: /commands/rclone_config_reconnect/ url: /commands/rclone_config_reconnect/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone config show" title: "rclone config show"
slug: rclone_config_show slug: rclone_config_show
url: /commands/rclone_config_show/ url: /commands/rclone_config_show/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone config update" title: "rclone config update"
slug: rclone_config_update slug: rclone_config_update
url: /commands/rclone_config_update/ url: /commands/rclone_config_update/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone config userinfo" title: "rclone config userinfo"
slug: rclone_config_userinfo slug: rclone_config_userinfo
url: /commands/rclone_config_userinfo/ url: /commands/rclone_config_userinfo/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone copy" title: "rclone copy"
slug: rclone_copy slug: rclone_copy
url: /commands/rclone_copy/ url: /commands/rclone_copy/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone copyto" title: "rclone copyto"
slug: rclone_copyto slug: rclone_copyto
url: /commands/rclone_copyto/ url: /commands/rclone_copyto/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone copyurl" title: "rclone copyurl"
slug: rclone_copyurl slug: rclone_copyurl
url: /commands/rclone_copyurl/ url: /commands/rclone_copyurl/
@ -11,10 +11,15 @@ Copy url content to dest.
### Synopsis ### Synopsis
Download urls content and copy it to destination Download a URL's content and copy it to the destination without saving
without saving it in tmp storage. it in temporary storage.
Setting --auto-filename flag will cause retrieving file name from url and using it in destination path. Setting --auto-filename will cause the file name to be retreived from
the from URL (after any redirections) and used in the destination
path.
Setting --stdout or making the output file name "-" will cause the
output to be written to standard output.
``` ```
@ -24,8 +29,9 @@ rclone copyurl https://example.com dest:path [flags]
### Options ### Options
``` ```
-a, --auto-filename Get the file name from the url and use it for destination file path -a, --auto-filename Get the file name from the URL and use it for destination file path
-h, --help help for copyurl -h, --help help for copyurl
--stdout Write the output to stdout rather than a file
``` ```
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone cryptcheck" title: "rclone cryptcheck"
slug: rclone_cryptcheck slug: rclone_cryptcheck
url: /commands/rclone_cryptcheck/ url: /commands/rclone_cryptcheck/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone cryptdecode" title: "rclone cryptdecode"
slug: rclone_cryptdecode slug: rclone_cryptdecode
url: /commands/rclone_cryptdecode/ url: /commands/rclone_cryptdecode/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone dbhashsum" title: "rclone dbhashsum"
slug: rclone_dbhashsum slug: rclone_dbhashsum
url: /commands/rclone_dbhashsum/ url: /commands/rclone_dbhashsum/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone dedupe" title: "rclone dedupe"
slug: rclone_dedupe slug: rclone_dedupe
url: /commands/rclone_dedupe/ url: /commands/rclone_dedupe/
@ -81,6 +81,7 @@ Dedupe can be run non interactively using the `--dedupe-mode` flag or by using a
* `--dedupe-mode newest` - removes identical files then keeps the newest one. * `--dedupe-mode newest` - removes identical files then keeps the newest one.
* `--dedupe-mode oldest` - removes identical files then keeps the oldest one. * `--dedupe-mode oldest` - removes identical files then keeps the oldest one.
* `--dedupe-mode largest` - removes identical files then keeps the largest one. * `--dedupe-mode largest` - removes identical files then keeps the largest one.
* `--dedupe-mode smallest` - removes identical files then keeps the smallest one.
* `--dedupe-mode rename` - removes identical files then renames the rest to be different. * `--dedupe-mode rename` - removes identical files then renames the rest to be different.
For example to rename all the identically named photos in your Google Photos directory, do For example to rename all the identically named photos in your Google Photos directory, do
@ -99,7 +100,7 @@ rclone dedupe [mode] remote:path [flags]
### Options ### Options
``` ```
--dedupe-mode string Dedupe mode interactive|skip|first|newest|oldest|rename. (default "interactive") --dedupe-mode string Dedupe mode interactive|skip|first|newest|oldest|largest|smallest|rename. (default "interactive")
-h, --help help for dedupe -h, --help help for dedupe
``` ```

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone delete" title: "rclone delete"
slug: rclone_delete slug: rclone_delete
url: /commands/rclone_delete/ url: /commands/rclone_delete/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone deletefile" title: "rclone deletefile"
slug: rclone_deletefile slug: rclone_deletefile
url: /commands/rclone_deletefile/ url: /commands/rclone_deletefile/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone genautocomplete" title: "rclone genautocomplete"
slug: rclone_genautocomplete slug: rclone_genautocomplete
url: /commands/rclone_genautocomplete/ url: /commands/rclone_genautocomplete/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone genautocomplete bash" title: "rclone genautocomplete bash"
slug: rclone_genautocomplete_bash slug: rclone_genautocomplete_bash
url: /commands/rclone_genautocomplete_bash/ url: /commands/rclone_genautocomplete_bash/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone genautocomplete zsh" title: "rclone genautocomplete zsh"
slug: rclone_genautocomplete_zsh slug: rclone_genautocomplete_zsh
url: /commands/rclone_genautocomplete_zsh/ url: /commands/rclone_genautocomplete_zsh/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone gendocs" title: "rclone gendocs"
slug: rclone_gendocs slug: rclone_gendocs
url: /commands/rclone_gendocs/ url: /commands/rclone_gendocs/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone hashsum" title: "rclone hashsum"
slug: rclone_hashsum slug: rclone_hashsum
url: /commands/rclone_hashsum/ url: /commands/rclone_hashsum/
@ -36,7 +36,8 @@ rclone hashsum <hash> remote:path [flags]
### Options ### Options
``` ```
-h, --help help for hashsum --base64 Output base64 encoded hashsum
-h, --help help for hashsum
``` ```
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone link" title: "rclone link"
slug: rclone_link slug: rclone_link
url: /commands/rclone_link/ url: /commands/rclone_link/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone listremotes" title: "rclone listremotes"
slug: rclone_listremotes slug: rclone_listremotes
url: /commands/rclone_listremotes/ url: /commands/rclone_listremotes/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone ls" title: "rclone ls"
slug: rclone_ls slug: rclone_ls
url: /commands/rclone_ls/ url: /commands/rclone_ls/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone lsd" title: "rclone lsd"
slug: rclone_lsd slug: rclone_lsd
url: /commands/rclone_lsd/ url: /commands/rclone_lsd/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone lsf" title: "rclone lsf"
slug: rclone_lsf slug: rclone_lsf
url: /commands/rclone_lsf/ url: /commands/rclone_lsf/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone lsjson" title: "rclone lsjson"
slug: rclone_lsjson slug: rclone_lsjson
url: /commands/rclone_lsjson/ url: /commands/rclone_lsjson/
@ -36,7 +36,9 @@ The output is an array of Items, where each Item looks like this
If --hash is not specified the Hashes property won't be emitted. If --hash is not specified the Hashes property won't be emitted.
If --no-modtime is specified then ModTime will be blank. If --no-modtime is specified then ModTime will be blank. This can speed things up on remotes where reading the ModTime takes an extra request (eg s3, swift).
If --no-mimetype is specified then MimeType will be blank. This can speed things up on remotes where reading the MimeType takes an extra request (eg s3, swift).
If --encrypted is not specified the Encrypted won't be emitted. If --encrypted is not specified the Encrypted won't be emitted.
@ -94,14 +96,15 @@ rclone lsjson remote:path [flags]
### Options ### Options
``` ```
--dirs-only Show only directories in the listing. --dirs-only Show only directories in the listing.
-M, --encrypted Show the encrypted names. -M, --encrypted Show the encrypted names.
--files-only Show only files in the listing. --files-only Show only files in the listing.
--hash Include hashes in the output (may take longer). --hash Include hashes in the output (may take longer).
-h, --help help for lsjson -h, --help help for lsjson
--no-modtime Don't read the modification time (can speed things up). --no-mimetype Don't read the mime type (can speed things up).
--original Show the ID of the underlying Object. --no-modtime Don't read the modification time (can speed things up).
-R, --recursive Recurse into the listing. --original Show the ID of the underlying Object.
-R, --recursive Recurse into the listing.
``` ```
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone lsl" title: "rclone lsl"
slug: rclone_lsl slug: rclone_lsl
url: /commands/rclone_lsl/ url: /commands/rclone_lsl/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone md5sum" title: "rclone md5sum"
slug: rclone_md5sum slug: rclone_md5sum
url: /commands/rclone_md5sum/ url: /commands/rclone_md5sum/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone mkdir" title: "rclone mkdir"
slug: rclone_mkdir slug: rclone_mkdir
url: /commands/rclone_mkdir/ url: /commands/rclone_mkdir/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone mount" title: "rclone mount"
slug: rclone_mount slug: rclone_mount
url: /commands/rclone_mount/ url: /commands/rclone_mount/
@ -65,28 +65,6 @@ infrastructure](https://github.com/billziss-gh/winfsp/wiki/WinFsp-Service-Archit
which creates drives accessible for everyone on the system or which creates drives accessible for everyone on the system or
alternatively using [the nssm service manager](https://nssm.cc/usage). alternatively using [the nssm service manager](https://nssm.cc/usage).
#### Mount as a network drive
By default, rclone will mount the remote as a normal drive. However, you can also mount it as a **Network Drive**
(or **Network Share**, as mentioned in some places)
Unlike other systems, Windows provides a different filesystem type for network drives.
Windows and other programs treat the network drives and fixed/removable drives differently:
In network drives, many I/O operations are optimized, as the high latency and low reliability
(compared to a normal drive) of a network is expected.
Although many people prefer network shares to be mounted as normal system drives, this might cause
some issues, such as programs not working as expected or freezes and errors while operating with the
mounted remote in Windows Explorer. If you experience any of those, consider mounting rclone remotes as network shares,
as Windows expects normal drives to be fast and reliable, while cloud storage is far from that.
See also [Limitations](#limitations) section below for more info
Add `--fuse-flag --VolumePrefix=\server\share` to your `mount` command, **replacing `share` with any other
name of your choice if you are mounting more than one remote**. Otherwise, the mountpoints will conflict and
your mounted filesystems will overlap.
[Read more about drive mapping](https://en.wikipedia.org/wiki/Drive_mapping)
### Limitations ### Limitations
Without the use of "--vfs-cache-mode" this can only write files Without the use of "--vfs-cache-mode" this can only write files

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone move" title: "rclone move"
slug: rclone_move slug: rclone_move
url: /commands/rclone_move/ url: /commands/rclone_move/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone moveto" title: "rclone moveto"
slug: rclone_moveto slug: rclone_moveto
url: /commands/rclone_moveto/ url: /commands/rclone_moveto/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone ncdu" title: "rclone ncdu"
slug: rclone_ncdu slug: rclone_ncdu
url: /commands/rclone_ncdu/ url: /commands/rclone_ncdu/
@ -31,6 +31,7 @@ Here are the keys - press '?' to toggle the help on and off
g toggle graph g toggle graph
n,s,C sort by name,size,count n,s,C sort by name,size,count
d delete file/directory d delete file/directory
y copy current path to clipbard
Y display current path Y display current path
^L refresh screen ^L refresh screen
? to toggle help on and off ? to toggle help on and off

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone obscure" title: "rclone obscure"
slug: rclone_obscure slug: rclone_obscure
url: /commands/rclone_obscure/ url: /commands/rclone_obscure/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone purge" title: "rclone purge"
slug: rclone_purge slug: rclone_purge
url: /commands/rclone_purge/ url: /commands/rclone_purge/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone rc" title: "rclone rc"
slug: rclone_rc slug: rclone_rc
url: /commands/rclone_rc/ url: /commands/rclone_rc/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone rcat" title: "rclone rcat"
slug: rclone_rcat slug: rclone_rcat
url: /commands/rclone_rcat/ url: /commands/rclone_rcat/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone rcd" title: "rclone rcd"
slug: rclone_rcd slug: rclone_rcd
url: /commands/rclone_rcd/ url: /commands/rclone_rcd/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone rmdir" title: "rclone rmdir"
slug: rclone_rmdir slug: rclone_rmdir
url: /commands/rclone_rmdir/ url: /commands/rclone_rmdir/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone rmdirs" title: "rclone rmdirs"
slug: rclone_rmdirs slug: rclone_rmdirs
url: /commands/rclone_rmdirs/ url: /commands/rclone_rmdirs/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone serve" title: "rclone serve"
slug: rclone_serve slug: rclone_serve
url: /commands/rclone_serve/ url: /commands/rclone_serve/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone serve dlna" title: "rclone serve dlna"
slug: rclone_serve_dlna slug: rclone_serve_dlna
url: /commands/rclone_serve_dlna/ url: /commands/rclone_serve_dlna/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone serve ftp" title: "rclone serve ftp"
slug: rclone_serve_ftp slug: rclone_serve_ftp
url: /commands/rclone_serve_ftp/ url: /commands/rclone_serve_ftp/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone serve http" title: "rclone serve http"
slug: rclone_serve_http slug: rclone_serve_http
url: /commands/rclone_serve_http/ url: /commands/rclone_serve_http/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone serve restic" title: "rclone serve restic"
slug: rclone_serve_restic slug: rclone_serve_restic
url: /commands/rclone_serve_restic/ url: /commands/rclone_serve_restic/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone serve sftp" title: "rclone serve sftp"
slug: rclone_serve_sftp slug: rclone_serve_sftp
url: /commands/rclone_serve_sftp/ url: /commands/rclone_serve_sftp/
@ -22,9 +22,9 @@ The server will log errors. Use -v to see access logs.
--bwlimit will be respected for file transfers. Use --stats to --bwlimit will be respected for file transfers. Use --stats to
control the stats printing. control the stats printing.
You must provide some means of authentication, either with `--user`/`--pass`, You must provide some means of authentication, either with --user/--pass,
an authorized keys file (specify location with `--authorized-keys` - the an authorized keys file (specify location with --authorized-keys - the
default is the same as ssh), an `--auth-proxy`, or set the --no-auth flag for no default is the same as ssh) or set the --no-auth flag for no
authentication when logging in. authentication when logging in.
Note that this also implements a small number of shell commands so Note that this also implements a small number of shell commands so
@ -183,13 +183,11 @@ rclone will use that program to generate backends on the fly which
then are used to authenticate incoming requests. This uses a simple then are used to authenticate incoming requests. This uses a simple
JSON based protocl with input on STDIN and output on STDOUT. JSON based protocl with input on STDIN and output on STDOUT.
> **PLEASE NOTE:** `--auth-proxy` and `--authorized-keys` cannot be used together, if `--auth-proxy` is set the authorized keys option will be ignored.
There is an example program There is an example program
[bin/test_proxy.py](https://github.com/rclone/rclone/blob/master/test_proxy.py) [bin/test_proxy.py](https://github.com/rclone/rclone/blob/master/test_proxy.py)
in the rclone source code. in the rclone source code.
The program's job is to take a `user` and `pass` or `public_key` on the input and turn The program's job is to take a `user` and `pass` on the input and turn
those into the config for a backend on STDOUT in JSON format. This those into the config for a backend on STDOUT in JSON format. This
config will have any default parameters for the backend added, but it config will have any default parameters for the backend added, but it
won't use configuration from environment variables or command line won't use configuration from environment variables or command line
@ -202,7 +200,7 @@ This config generated must have this extra parameter
And it may have this parameter And it may have this parameter
- `_obscure` - comma separated strings for parameters to obscure - `_obscure` - comma separated strings for parameters to obscure
If password authentication was used by the client, input to the proxy process (on STDIN) would look similar to this: For example the program might take this on STDIN
``` ```
{ {
@ -211,16 +209,7 @@ If password authentication was used by the client, input to the proxy process (o
} }
``` ```
If public-key authentication was used by the client, input to the proxy process (on STDIN) would look similar to this: And return this on STDOUT
```
{
"user": "me",
"public_key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc+4BlQz1s6tWT5VxBu1YlR9w39BUAom4qDKuH+uqLMDIaS5F7D6lNwOuPylvyV/LgMFsgJV4QZ52Kws7mNgdsCEDTvfLz5Pt9Qtp6Gnah3kA0cmbXcfQFaO50Ojnz/W1ozg2z5evKmGtyYMtywTXvH/KVh5WjhbpQ/ERgu+1pbgwWkpWNBM8TCO8D85PSpxtkdpEdkaiGtKA6U+6ZOtdCqd88EasyMEBWLVSx9bvqMVsD8plYstXOm5CCptGWWqckZBIqp0YBP6atw/ANRESD3cIJ4dOO+qlWkLR5npAZZTx2Qqh+hVw6qqTFB+JQdf"
}
```
And as an example return this on STDOUT
``` ```
{ {
@ -234,7 +223,7 @@ And as an example return this on STDOUT
``` ```
This would mean that an SFTP backend would be created on the fly for This would mean that an SFTP backend would be created on the fly for
the `user` and `pass`/`public_key` returned in the output to the host given. Note the `user` and `pass` returned in the output to the host given. Note
that since `_obscure` is set to `pass`, rclone will obscure the `pass` that since `_obscure` is set to `pass`, rclone will obscure the `pass`
parameter before creating the backend (which is required for sftp parameter before creating the backend (which is required for sftp
backends). backends).
@ -246,8 +235,8 @@ in the output and the user to `user`. For security you'd probably want
to restrict the `host` to a limited list. to restrict the `host` to a limited list.
Note that an internal cache is keyed on `user` so only use that for Note that an internal cache is keyed on `user` so only use that for
configuration, don't use `pass` or `public_key`. This also means that if a user's configuration, don't use `pass`. This also means that if a user's
password or public-key is changed the cache will need to expire (which takes 5 mins) password is changed the cache will need to expire (which takes 5 mins)
before it takes effect. before it takes effect.
This can be used to build general purpose proxies to any kind of This can be used to build general purpose proxies to any kind of

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone serve webdav" title: "rclone serve webdav"
slug: rclone_serve_webdav slug: rclone_serve_webdav
url: /commands/rclone_serve_webdav/ url: /commands/rclone_serve_webdav/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone settier" title: "rclone settier"
slug: rclone_settier slug: rclone_settier
url: /commands/rclone_settier/ url: /commands/rclone_settier/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone sha1sum" title: "rclone sha1sum"
slug: rclone_sha1sum slug: rclone_sha1sum
url: /commands/rclone_sha1sum/ url: /commands/rclone_sha1sum/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone size" title: "rclone size"
slug: rclone_size slug: rclone_size
url: /commands/rclone_size/ url: /commands/rclone_size/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone sync" title: "rclone sync"
slug: rclone_sync slug: rclone_sync
url: /commands/rclone_sync/ url: /commands/rclone_sync/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone touch" title: "rclone touch"
slug: rclone_touch slug: rclone_touch
url: /commands/rclone_touch/ url: /commands/rclone_touch/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone tree" title: "rclone tree"
slug: rclone_tree slug: rclone_tree
url: /commands/rclone_tree/ url: /commands/rclone_tree/

View File

@ -1,5 +1,5 @@
--- ---
date: 2019-10-26T11:04:03+01:00 date: 2020-02-01T10:26:53Z
title: "rclone version" title: "rclone version"
slug: rclone_version slug: rclone_version
url: /commands/rclone_version/ url: /commands/rclone_version/

View File

@ -297,12 +297,12 @@ How to encrypt the filenames.
- Type: string - Type: string
- Default: "standard" - Default: "standard"
- Examples: - Examples:
- "off"
- Don't encrypt the file names. Adds a ".bin" extension only.
- "standard" - "standard"
- Encrypt the filenames see the docs for the details. - Encrypt the filenames see the docs for the details.
- "obfuscate" - "obfuscate"
- Very simple filename obfuscation. - Very simple filename obfuscation.
- "off"
- Don't encrypt the file names. Adds a ".bin" extension only.
#### --crypt-directory-name-encryption #### --crypt-directory-name-encryption

View File

@ -735,6 +735,21 @@ or move the photos locally and use the date the image was taken
- Type: bool - Type: bool
- Default: false - Default: false
#### --drive-use-shared-date
Use date file was shared instead of modified date.
Note that, as with "--drive-use-created-date", this flag may have
unexpected consequences when uploading/downloading files.
If both this flag and "--drive-use-created-date" are set, the created
date is used.
- Config: use_shared_date
- Env Var: RCLONE_DRIVE_USE_SHARED_DATE
- Type: bool
- Default: false
#### --drive-list-chunk #### --drive-list-chunk
Size of listing chunk 100-1000. 0 to disable. Size of listing chunk 100-1000. 0 to disable.
@ -820,10 +835,20 @@ Keep new head revision of each file forever.
#### --drive-size-as-quota #### --drive-size-as-quota
Show storage quota usage for file size. Show sizes as storage quota usage, not actual size.
The storage used by a file is the size of the current version plus any Show the size of a file as the the storage quota used. This is the
older versions that have been set to keep forever. current version plus any older versions that have been set to keep
forever.
**WARNING**: This flag may have some unexpected consequences.
It is not recommended to set this flag in your config - the
recommended usage is using the flag form --drive-size-as-quota when
doing rclone ls/lsl/lsf/lsjson/etc only.
If you do use this flag for syncing (not recommended) then you will
need to use --ignore size also.
- Config: size_as_quota - Config: size_as_quota
- Env Var: RCLONE_DRIVE_SIZE_AS_QUOTA - Env Var: RCLONE_DRIVE_SIZE_AS_QUOTA
@ -889,6 +914,38 @@ See: https://github.com/rclone/rclone/issues/3631
- Type: bool - Type: bool
- Default: true - Default: true
#### --drive-stop-on-upload-limit
Make upload limit errors be fatal
At the time of writing it is only possible to upload 750GB of data to
Google Drive a day (this is an undocumented limit). When this limit is
reached Google Drive produces a slightly different error message. When
this flag is set it causes these errors to be fatal. These will stop
the in-progress sync.
Note that this detection is relying on error message strings which
Google don't document so it may break in the future.
See: https://github.com/rclone/rclone/issues/3857
- Config: stop_on_upload_limit
- Env Var: RCLONE_DRIVE_STOP_ON_UPLOAD_LIMIT
- Type: bool
- Default: false
#### --drive-encoding
This sets the encoding for the backend.
See: the [encoding section in the overview](/overview/#encoding) for more info.
- Config: encoding
- Env Var: RCLONE_DRIVE_ENCODING
- Type: MultiEncoder
- Default: InvalidUtf8
<!--- autogenerated options stop --> <!--- autogenerated options stop -->
### Limitations ### ### Limitations ###

View File

@ -174,6 +174,17 @@ Impersonate this user when using a business account.
- Type: string - Type: string
- Default: "" - Default: ""
#### --dropbox-encoding
This sets the encoding for the backend.
See: the [encoding section in the overview](/overview/#encoding) for more info.
- Config: encoding
- Env Var: RCLONE_DROPBOX_ENCODING
- Type: MultiEncoder
- Default: Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot
<!--- autogenerated options stop --> <!--- autogenerated options stop -->
### Limitations ### ### Limitations ###

View File

@ -140,4 +140,15 @@ If you want to download a shared folder, add this parameter
- Type: string - Type: string
- Default: "" - Default: ""
#### --fichier-encoding
This sets the encoding for the backend.
See: the [encoding section in the overview](/overview/#encoding) for more info.
- Config: encoding
- Env Var: RCLONE_FICHIER_ENCODING
- Type: MultiEncoder
- Default: Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot
<!--- autogenerated options stop --> <!--- autogenerated options stop -->

View File

@ -1,7 +1,7 @@
--- ---
title: "Global Flags" title: "Global Flags"
description: "Rclone Global Flags" description: "Rclone Global Flags"
date: "2019-10-26T11:04:03+01:00" date: "2020-02-01T10:26:53Z"
--- ---
# Global Flags # Global Flags
@ -26,10 +26,10 @@ These flags are available for every command.
-c, --checksum Skip based on checksum (if available) & size, not mod-time & size -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-cert string Client SSL certificate (PEM) for mutual TLS auth
--client-key string Client SSL private key (PEM) for mutual TLS auth --client-key string Client SSL private key (PEM) for mutual TLS auth
--compare-dest string use DIR to server side copy flies from. --compare-dest string Include additional server-side path during comparison.
--config string Config file. (default "$HOME/.config/rclone/rclone.conf") --config string Config file. (default "$HOME/.config/rclone/rclone.conf")
--contimeout duration Connect timeout (default 1m0s) --contimeout duration Connect timeout (default 1m0s)
--copy-dest string Compare dest to DIR also. --copy-dest string Implies --compare-dest but also copies files from path into destination.
--cpuprofile string Write cpu profile to file --cpuprofile string Write cpu profile to file
--delete-after When synchronizing, delete files on destination after transferring (default) --delete-after When synchronizing, delete files on destination after transferring (default)
--delete-before When synchronizing, delete files on destination before transferring --delete-before When synchronizing, delete files on destination before transferring
@ -43,6 +43,7 @@ These flags are available for every command.
--exclude stringArray Exclude files matching pattern --exclude stringArray Exclude files matching pattern
--exclude-from stringArray Read exclude patterns from file --exclude-from stringArray Read exclude patterns from file
--exclude-if-present string Exclude directories if filename is present --exclude-if-present string Exclude directories if filename is present
--expect-continue-timeout duration Timeout when using expect / 100-continue in HTTP (default 1s)
--fast-list Use recursive list if available. Uses more memory but fewer transactions. --fast-list Use recursive list if available. Uses more memory but fewer transactions.
--files-from stringArray Read list of source-file names from file --files-from stringArray Read list of source-file names from file
-f, --filter stringArray Add a file-filtering rule -f, --filter stringArray Add a file-filtering rule
@ -65,6 +66,7 @@ These flags are available for every command.
--max-backlog int Maximum number of objects in sync or check backlog. (default 10000) --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-delete int When synchronizing, limit the number of deletes (default -1)
--max-depth int If set limits the recursion depth to this. (default -1) --max-depth int If set limits the recursion depth to this. (default -1)
--max-duration duration Maximum duration rclone will transfer data for.
--max-size SizeSuffix Only transfer files smaller than this in k or suffix b|k|M|G (default off) --max-size SizeSuffix Only transfer files smaller than this in k or suffix b|k|M|G (default off)
--max-stats-groups int Maximum number of stats groups to keep in memory. On max oldest is discarded. (default 1000) --max-stats-groups int Maximum number of stats groups to keep in memory. On max oldest is discarded. (default 1000)
--max-transfer SizeSuffix Maximum size of data to transfer. (default off) --max-transfer SizeSuffix Maximum size of data to transfer. (default off)
@ -75,9 +77,12 @@ These flags are available for every command.
--multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size. (default 250M) --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) --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. --no-check-certificate Do not verify the server SSL certificate. Insecure.
--no-check-dest Don't check the destination, copy regardless.
--no-gzip-encoding Don't set Accept-Encoding: gzip. --no-gzip-encoding Don't set Accept-Encoding: gzip.
--no-traverse Don't traverse destination file system on copy. --no-traverse Don't traverse destination file system on copy.
--no-update-modtime Don't update destination mod-time if files identical. --no-update-modtime Don't update destination mod-time if files identical.
--order-by string Instructions on how to order the transfers, eg 'size,descending'
--password-command SpaceSepList Command for supplying password for encrypted configuration.
-P, --progress Show progress during transfer. -P, --progress Show progress during transfer.
-q, --quiet Print as little stuff as possible -q, --quiet Print as little stuff as possible
--rc Enable the remote control server. --rc Enable the remote control server.
@ -101,9 +106,9 @@ These flags are available for every command.
--rc-user string User name for authentication. --rc-user string User name for authentication.
--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-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 --rc-web-gui Launch WebGUI on localhost
--rc-web-gui-update Check and update to latest version of web gui
--rc-web-gui-force-update Force update to latest version of web gui --rc-web-gui-force-update Force update to latest version of web gui
--rc-web-gui-no-open-browser Don't open browser automatically --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
--retries int Retry operations this many times if they fail (default 3) --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) --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 --size-only Skip based on size only, not mod-time or checksum
@ -129,7 +134,7 @@ These flags are available for every command.
--use-json-log Use json log format. --use-json-log Use json log format.
--use-mmap Use mmap allocator (see docs). --use-mmap Use mmap allocator (see docs).
--use-server-modtime Use server modified time instead of object metadata --use-server-modtime Use server modified time instead of object metadata
--user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.50.0") --user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.51.0")
-v, --verbose count Print lots more stuff (repeat for more) -v, --verbose count Print lots more stuff (repeat for more)
``` ```
@ -142,6 +147,7 @@ and may be set in the config file.
--acd-auth-url string Auth server URL. --acd-auth-url string Auth server URL.
--acd-client-id string Amazon Application Client ID. --acd-client-id string Amazon Application Client ID.
--acd-client-secret string Amazon Application Client Secret. --acd-client-secret string Amazon Application Client Secret.
--acd-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot)
--acd-templink-threshold SizeSuffix Files >= this size will be downloaded via their tempLink. (default 9G) --acd-templink-threshold SizeSuffix Files >= this size will be downloaded via their tempLink. (default 9G)
--acd-token-url string Token server url. --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) --acd-upload-wait-per-gb Duration Additional time per GB to wait after a failed complete upload to see if it appears. (default 3m0s)
@ -149,6 +155,7 @@ and may be set in the config file.
--azureblob-access-tier string Access tier of blob: hot, cool or archive. --azureblob-access-tier string Access tier of blob: hot, cool or archive.
--azureblob-account string Storage Account Name (leave blank to use SAS URL or Emulator) --azureblob-account string Storage Account Name (leave blank to use SAS URL or Emulator)
--azureblob-chunk-size SizeSuffix Upload chunk size (<= 100MB). (default 4M) --azureblob-chunk-size SizeSuffix Upload chunk size (<= 100MB). (default 4M)
--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-endpoint string Endpoint for the service
--azureblob-key string Storage Account Key (leave blank to use SAS URL or Emulator) --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-list-chunk int Size of blob list. (default 5000)
@ -160,6 +167,7 @@ and may be set in the config file.
--b2-disable-checksum Disable checksums for large (> upload cutoff) files --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-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-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-endpoint string Endpoint for the service.
--b2-hard-delete Permanently delete files on remote removal, otherwise hide files. --b2-hard-delete Permanently delete files on remote removal, otherwise hide files.
--b2-key string Application Key --b2-key string Application Key
@ -171,6 +179,7 @@ and may be set in the config file.
--box-client-id string Box App Client Id. --box-client-id string Box App Client Id.
--box-client-secret string Box App Client Secret --box-client-secret string Box App Client Secret
--box-commit-retries int Max number of times to try committing a multipart file. (default 100) --box-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-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (>= 50MB). (default 50M) --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-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-no-memory Disable the in-memory cache for storing chunks during streaming.
@ -214,6 +223,7 @@ and may be set in the config file.
--drive-client-id string Google Application Client Id --drive-client-id string Google Application Client Id
--drive-client-secret string Google Application Client Secret --drive-client-secret string Google Application Client Secret
--drive-disable-http2 Disable drive using http2 (default true) --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-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-formats string Deprecated: see export_formats
--drive-impersonate string Impersonate this user when using a service account. --drive-impersonate string Impersonate this user when using a service account.
@ -228,23 +238,28 @@ and may be set in the config file.
--drive-service-account-credentials string Service Account Credentials JSON blob --drive-service-account-credentials string Service Account Credentials JSON blob
--drive-service-account-file string Service Account Credentials JSON file path --drive-service-account-file string Service Account Credentials JSON file path
--drive-shared-with-me Only show files that are shared with me. --drive-shared-with-me Only show files that are shared with me.
--drive-size-as-quota Show storage quota usage for file size. --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-checksum-gphotos Skip MD5 checksum on Google photos and videos only.
--drive-skip-gdocs Skip google documents in all listings. --drive-skip-gdocs Skip google documents in all listings.
--drive-stop-on-upload-limit Make upload limit errors be fatal
--drive-team-drive string ID of the Team Drive --drive-team-drive string ID of the Team Drive
--drive-trashed-only Only show files that are in the trash. --drive-trashed-only Only show files that are in the trash.
--drive-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 8M) --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-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-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) --drive-v2-download-min-size SizeSuffix If Object's are greater, use drive v2 API to download. (default off)
--dropbox-chunk-size SizeSuffix Upload chunk size. (< 150M). (default 48M) --dropbox-chunk-size SizeSuffix Upload chunk size. (< 150M). (default 48M)
--dropbox-client-id string Dropbox App Client Id --dropbox-client-id string Dropbox App Client Id
--dropbox-client-secret string Dropbox App Client Secret --dropbox-client-secret string Dropbox App Client Secret
--dropbox-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot)
--dropbox-impersonate string Impersonate this user when using a business account. --dropbox-impersonate string Impersonate this user when using a business account.
--fichier-api-key string Your API Key, get it from https://1fichier.com/console/params.pl --fichier-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 --fichier-shared-folder string If you want to download a shared folder, add this parameter
--ftp-concurrency int Maximum number of FTP simultaneous connections, 0 for unlimited --ftp-concurrency int Maximum number of FTP simultaneous connections, 0 for unlimited
--ftp-disable-epsv Disable using EPSV even if server advertises support --ftp-disable-epsv Disable using EPSV even if server advertises support
--ftp-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,RightSpace,Dot)
--ftp-host string FTP host to connect to --ftp-host string FTP host to connect to
--ftp-no-check-certificate Do not verify the TLS certificate of the server --ftp-no-check-certificate Do not verify the TLS certificate of the server
--ftp-pass string FTP password --ftp-pass string FTP password
@ -255,6 +270,7 @@ and may be set in the config file.
--gcs-bucket-policy-only Access checks should use bucket-level IAM policies. --gcs-bucket-policy-only Access checks should use bucket-level IAM policies.
--gcs-client-id string Google Application Client Id --gcs-client-id string Google Application Client Id
--gcs-client-secret string Google Application Client Secret --gcs-client-secret string Google Application Client Secret
--gcs-encoding MultiEncoder This sets the encoding for the backend. (default Slash,CrLf,InvalidUtf8,Dot)
--gcs-location string Location for the newly created buckets. --gcs-location string Location for the newly created buckets.
--gcs-object-acl string Access Control List for new objects. --gcs-object-acl string Access Control List for new objects.
--gcs-project-number string Project number. --gcs-project-number string Project number.
@ -271,11 +287,14 @@ and may be set in the config file.
--hubic-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) --hubic-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G)
--hubic-client-id string Hubic Client Id --hubic-client-id string Hubic Client Id
--hubic-client-secret string Hubic Client Secret --hubic-client-secret string Hubic Client Secret
--hubic-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8)
--hubic-no-chunk Don't chunk files during streaming upload. --hubic-no-chunk Don't chunk files during streaming upload.
--jottacloud-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot)
--jottacloud-hard-delete Delete files permanently rather than putting them into the trash. --jottacloud-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-md5-memory-limit SizeSuffix Files bigger than this will be cached on disk to calculate the MD5 if required. (default 10M)
--jottacloud-unlink Remove existing public link to file/folder with link command rather than creating. --jottacloud-unlink Remove existing public link to file/folder with link command rather than creating.
--jottacloud-upload-resume-limit SizeSuffix Files bigger than this can be resumed if the upload fail's. (default 10M) --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-endpoint string The Koofr API endpoint to use (default "https://app.koofr.net")
--koofr-mountid string Mount ID of the mount to use. If omitted, the primary mount is used. --koofr-mountid string Mount ID of the mount to use. If omitted, the primary mount is used.
--koofr-password string Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password) --koofr-password string Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password)
@ -284,10 +303,12 @@ and may be set in the config file.
-l, --links Translate symlinks to/from regular files with a '.rclonelink' extension -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-insensitive Force the filesystem to report itself as case insensitive
--local-case-sensitive Force the filesystem to report itself as case sensitive. --local-case-sensitive Force the filesystem to report itself as case sensitive.
--local-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Dot)
--local-no-check-updated Don't check to see if the files change during upload --local-no-check-updated Don't check to see if the files change during upload
--local-no-unicode-normalization Don't apply unicode normalization to paths and filenames (Deprecated) --local-no-unicode-normalization Don't apply unicode normalization to paths and filenames (Deprecated)
--local-nounc string Disable UNC (long path names) conversion on Windows --local-nounc string Disable UNC (long path names) conversion on Windows
--mailru-check-hash What should copy do if file checksum is mismatched or invalid (default true) --mailru-check-hash What should copy do if file checksum is mismatched or invalid (default true)
--mailru-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot)
--mailru-pass string Password --mailru-pass string Password
--mailru-speedup-enable Skip full upload if there is another file with same data hash. (default true) --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-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")
@ -295,6 +316,7 @@ and may be set in the config file.
--mailru-speedup-max-memory SizeSuffix Files larger than the size given below will always be hashed on disk. (default 32M) --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) --mailru-user string User name (usually email)
--mega-debug Output more debug from Mega. --mega-debug Output more debug from Mega.
--mega-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot)
--mega-hard-delete Delete files permanently rather than putting them into the trash. --mega-hard-delete Delete files permanently rather than putting them into the trash.
--mega-pass string Password. --mega-pass string Password.
--mega-user string User name --mega-user string User name
@ -304,14 +326,21 @@ and may be set in the config file.
--onedrive-client-secret string Microsoft App Client Secret --onedrive-client-secret string Microsoft App Client Secret
--onedrive-drive-id string The ID of the drive to use --onedrive-drive-id string The ID of the drive to use
--onedrive-drive-type string The type of the drive ( personal | business | documentLibrary ) --onedrive-drive-type string The type of the drive ( personal | business | documentLibrary )
--onedrive-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot)
--onedrive-expose-onenote-files Set to make OneNote files show up in directory listings. --onedrive-expose-onenote-files Set to make OneNote files show up in directory listings.
--opendrive-chunk-size SizeSuffix Files will be uploaded in chunks this size. (default 10M)
--opendrive-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot)
--opendrive-password string Password. --opendrive-password string Password.
--opendrive-username string Username --opendrive-username string Username
--pcloud-client-id string Pcloud App Client Id --pcloud-client-id string Pcloud App Client Id
--pcloud-client-secret string Pcloud App Client Secret --pcloud-client-secret string Pcloud App Client Secret
--pcloud-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
--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-access-key-id string QingStor Access Key ID
--qingstor-chunk-size SizeSuffix Chunk size to use for uploading. (default 4M) --qingstor-chunk-size SizeSuffix Chunk size to use for uploading. (default 4M)
--qingstor-connection-retries int Number of connection retries. (default 3) --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 a endpoint URL to connection QingStor API. --qingstor-endpoint string Enter a 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-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-secret-access-key string QingStor Secret Access Key (password)
@ -322,11 +351,14 @@ and may be set in the config file.
--s3-acl string Canned ACL used when creating buckets and storing or copying objects. --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-bucket-acl string Canned ACL used when creating buckets.
--s3-chunk-size SizeSuffix Chunk size to use for uploading. (default 5M) --s3-chunk-size SizeSuffix Chunk size to use for uploading. (default 5M)
--s3-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 5G)
--s3-disable-checksum Don't store MD5 checksum with object metadata --s3-disable-checksum Don't store MD5 checksum with object metadata
--s3-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot)
--s3-endpoint string Endpoint for S3 API. --s3-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-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-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-leave-parts-on-error If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery.
--s3-list-chunk int Size of listing chunk (response list for each ListObject S3 request). (default 1000)
--s3-location-constraint string Location constraint - must be set to match the Region. --s3-location-constraint string Location constraint - must be set to match the Region.
--s3-provider string Choose your S3 provider. --s3-provider string Choose your S3 provider.
--s3-region string Region to connect to. --s3-region string Region to connect to.
@ -351,13 +383,26 @@ and may be set in the config file.
--sftp-port string SSH port, leave blank to use default (22) --sftp-port string SSH port, leave blank to use default (22)
--sftp-set-modtime Set the modified time on the remote if set. (default true) --sftp-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-sha1sum-command string The command used to read sha1 hashes. Leave blank for autodetect.
--sftp-skip-links Set to skip any symlinks and any other non regular files.
--sftp-use-insecure-cipher Enable the use of insecure ciphers and key exchange methods. --sftp-use-insecure-cipher Enable the use of insecure ciphers and key exchange methods.
--sftp-user string SSH username, leave blank for current username, ncw --sftp-user string SSH username, leave blank for current username, ncw
--sharefile-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 64M) --sharefile-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-endpoint string Endpoint for API calls.
--sharefile-root-folder-id string ID of the root folder --sharefile-root-folder-id string ID of the root folder
--sharefile-upload-cutoff SizeSuffix Cutoff for switching to multipart upload. (default 128M) --sharefile-upload-cutoff SizeSuffix Cutoff for switching to multipart upload. (default 128M)
--skip-links Don't warn about skipped symlinks. --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-id string Application Credential ID (OS_APPLICATION_CREDENTIAL_ID)
--swift-application-credential-name string Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME) --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-application-credential-secret string Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET)
@ -366,6 +411,7 @@ and may be set in the config file.
--swift-auth-version int AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION) --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-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-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-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-env-auth Get swift credentials from environment variables in standard OpenStack form.
--swift-key string API key or password (OS_PASSWORD). --swift-key string API key or password (OS_PASSWORD).
@ -387,5 +433,6 @@ and may be set in the config file.
--webdav-vendor string Name of the Webdav site/service/software you are using --webdav-vendor string Name of the Webdav site/service/software you are using
--yandex-client-id string Yandex Client Id --yandex-client-id string Yandex Client Id
--yandex-client-secret string Yandex Client Secret --yandex-client-secret string Yandex Client Secret
--yandex-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot)
--yandex-unlink Remove existing public link to file/folder with link command rather than creating. --yandex-unlink Remove existing public link to file/folder with link command rather than creating.
``` ```

View File

@ -212,6 +212,17 @@ Disable using EPSV even if server advertises support
- Type: bool - Type: bool
- Default: false - Default: false
#### --ftp-encoding
This sets the encoding for the backend.
See: the [encoding section in the overview](/overview/#encoding) for more info.
- Config: encoding
- Env Var: RCLONE_FTP_ENCODING
- Type: MultiEncoder
- Default: Slash,Del,Ctl,RightSpace,Dot
<!--- autogenerated options stop --> <!--- autogenerated options stop -->
### Limitations ### ### Limitations ###

View File

@ -425,4 +425,19 @@ The storage class to use when storing objects in Google Cloud Storage.
- "DURABLE_REDUCED_AVAILABILITY" - "DURABLE_REDUCED_AVAILABILITY"
- Durable reduced availability storage class - Durable reduced availability storage class
### Advanced Options
Here are the advanced options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)).
#### --gcs-encoding
This sets the encoding for the backend.
See: the [encoding section in the overview](/overview/#encoding) for more info.
- Config: encoding
- Env Var: RCLONE_GCS_ENCODING
- Type: MultiEncoder
- Default: Slash,CrLf,InvalidUtf8,Dot
<!--- autogenerated options stop --> <!--- autogenerated options stop -->

View File

@ -165,6 +165,17 @@ copy operations.
- Type: bool - Type: bool
- Default: false - Default: false
#### --hubic-encoding
This sets the encoding for the backend.
See: the [encoding section in the overview](/overview/#encoding) for more info.
- Config: encoding
- Env Var: RCLONE_HUBIC_ENCODING
- Type: MultiEncoder
- Default: Slash,InvalidUtf8
<!--- autogenerated options stop --> <!--- autogenerated options stop -->
### Limitations ### ### Limitations ###

View File

@ -202,6 +202,17 @@ Files bigger than this can be resumed if the upload fail's.
- Type: SizeSuffix - Type: SizeSuffix
- Default: 10M - Default: 10M
#### --jottacloud-encoding
This sets the encoding for the backend.
See: the [encoding section in the overview](/overview/#encoding) for more info.
- Config: encoding
- Env Var: RCLONE_JOTTACLOUD_ENCODING
- Type: MultiEncoder
- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot
<!--- autogenerated options stop --> <!--- autogenerated options stop -->
### Limitations ### ### Limitations ###

View File

@ -152,6 +152,17 @@ Does the backend support setting modification time. Set this to false if you use
- Type: bool - Type: bool
- Default: true - Default: true
#### --koofr-encoding
This sets the encoding for the backend.
See: the [encoding section in the overview](/overview/#encoding) for more info.
- Config: encoding
- Env Var: RCLONE_KOOFR_ENCODING
- Type: MultiEncoder
- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
<!--- autogenerated options stop --> <!--- autogenerated options stop -->
### Limitations ### ### Limitations ###

View File

@ -413,4 +413,15 @@ to override the default choice.
- Type: bool - Type: bool
- Default: false - Default: false
#### --local-encoding
This sets the encoding for the backend.
See: the [encoding section in the overview](/overview/#encoding) for more info.
- Config: encoding
- Env Var: RCLONE_LOCAL_ENCODING
- Type: MultiEncoder
- Default: Slash,Dot
<!--- autogenerated options stop --> <!--- autogenerated options stop -->

View File

@ -300,4 +300,15 @@ Supported quirks: atomicmkdir binlist gzip insecure retry400
- Type: string - Type: string
- Default: "" - Default: ""
#### --mailru-encoding
This sets the encoding for the backend.
See: the [encoding section in the overview](/overview/#encoding) for more info.
- Config: encoding
- Env Var: RCLONE_MAILRU_ENCODING
- Type: MultiEncoder
- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot
<!--- autogenerated options stop --> <!--- autogenerated options stop -->

View File

@ -203,6 +203,17 @@ permanently delete objects instead.
- Type: bool - Type: bool
- Default: false - Default: false
#### --mega-encoding
This sets the encoding for the backend.
See: the [encoding section in the overview](/overview/#encoding) for more info.
- Config: encoding
- Env Var: RCLONE_MEGA_ENCODING
- Type: MultiEncoder
- Default: Slash,InvalidUtf8,Dot
<!--- autogenerated options stop --> <!--- autogenerated options stop -->
### Limitations ### ### Limitations ###

View File

@ -267,6 +267,17 @@ listing, set this option.
- Type: bool - Type: bool
- Default: false - Default: false
#### --onedrive-encoding
This sets the encoding for the backend.
See: the [encoding section in the overview](/overview/#encoding) for more info.
- Config: encoding
- Env Var: RCLONE_ONEDRIVE_ENCODING
- Type: MultiEncoder
- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot
<!--- autogenerated options stop --> <!--- autogenerated options stop -->
### Limitations ### ### Limitations ###

View File

@ -122,6 +122,33 @@ Password.
- Type: string - Type: string
- Default: "" - Default: ""
### Advanced Options
Here are the advanced options specific to opendrive (OpenDrive).
#### --opendrive-encoding
This sets the encoding for the backend.
See: the [encoding section in the overview](/overview/#encoding) for more info.
- Config: encoding
- Env Var: RCLONE_OPENDRIVE_ENCODING
- Type: MultiEncoder
- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot
#### --opendrive-chunk-size
Files will be uploaded in chunks this size.
Note that these chunks are buffered in memory so increasing them will
increase memory use.
- Config: chunk_size
- Env Var: RCLONE_OPENDRIVE_CHUNK_SIZE
- Type: SizeSuffix
- Default: 10M
<!--- autogenerated options stop --> <!--- autogenerated options stop -->
### Limitations ### ### Limitations ###

View File

@ -137,4 +137,19 @@ Leave blank normally.
- Type: string - Type: string
- Default: "" - Default: ""
### Advanced Options
Here are the advanced options specific to pcloud (Pcloud).
#### --pcloud-encoding
This sets the encoding for the backend.
See: the [encoding section in the overview](/overview/#encoding) for more info.
- Config: encoding
- Env Var: RCLONE_PCLOUD_ENCODING
- Type: MultiEncoder
- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
<!--- autogenerated options stop --> <!--- autogenerated options stop -->

View File

@ -118,6 +118,21 @@ This is not normally used - use oauth instead.
- Type: string - Type: string
- Default: "" - Default: ""
### Advanced Options
Here are the advanced options specific to premiumizeme (premiumize.me).
#### --premiumizeme-encoding
This sets the encoding for the backend.
See: the [encoding section in the overview](/overview/#encoding) for more info.
- Config: encoding
- Env Var: RCLONE_PREMIUMIZEME_ENCODING
- Type: MultiEncoder
- Default: Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot
<!--- autogenerated options stop --> <!--- autogenerated options stop -->
### Limitations ### ### Limitations ###

View File

@ -109,4 +109,19 @@ 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.
<!--- 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 then run make backenddocs -->
### Advanced Options
Here are the advanced options specific to putio (Put.io).
#### --putio-encoding
This sets the encoding for the backend.
See: the [encoding section in the overview](/overview/#encoding) for more info.
- Config: encoding
- Env Var: RCLONE_PUTIO_ENCODING
- Type: MultiEncoder
- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
<!--- autogenerated options stop --> <!--- autogenerated options stop -->

View File

@ -266,4 +266,15 @@ this may help to speed up the transfers.
- Type: int - Type: int
- Default: 1 - Default: 1
#### --qingstor-encoding
This sets the encoding for the backend.
See: the [encoding section in the overview](/overview/#encoding) for more info.
- Config: encoding
- Env Var: RCLONE_QINGSTOR_ENCODING
- Type: MultiEncoder
- Default: Slash,Ctl,InvalidUtf8
<!--- autogenerated options stop --> <!--- autogenerated options stop -->

View File

@ -531,9 +531,17 @@ Returns the following values:
Values for "transferring", "checking" and "lastError" are only assigned if data is available. Values for "transferring", "checking" and "lastError" are only assigned if data is available.
The value for "eta" is null if an eta cannot be determined. The value for "eta" is null if an eta cannot be determined.
### core/stats-delete: Delete stats group. {#core/stats-delete}
This deletes entire stats group
Parameters
- group - name of the stats group (string)
### core/stats-reset: Reset stats. {#core/stats-reset} ### core/stats-reset: Reset stats. {#core/stats-reset}
This clears counters, errors and finished transfers for all stats or specific This clears counters, errors and finished transfers for all stats or specific
stats group if group is provided. stats group if group is provided.
Parameters Parameters

View File

@ -566,7 +566,7 @@ Region to connect to.
- Asia Pacific (Mumbai) - Asia Pacific (Mumbai)
- Needs location constraint ap-south-1. - Needs location constraint ap-south-1.
- "ap-east-1" - "ap-east-1"
- Asia Pacific (Hong Kong) Region - Asia Patific (Hong Kong) Region
- Needs location constraint ap-east-1. - Needs location constraint ap-east-1.
- "sa-east-1" - "sa-east-1"
- South America (Sao Paulo) Region - South America (Sao Paulo) Region
@ -1051,8 +1051,10 @@ The minimum is 0 and the maximum is 5GB.
Chunk size to use for uploading. Chunk size to use for uploading.
When uploading files larger than upload_cutoff they will be uploaded When uploading files larger than upload_cutoff or files with unknown
as multipart uploads using this chunk size. size (eg from "rclone rcat" or uploaded with "rclone mount" or google
photos or google docs) they will be uploaded as multipart uploads
using this chunk size.
Note that "--s3-upload-concurrency" chunks of this size are buffered Note that "--s3-upload-concurrency" chunks of this size are buffered
in memory per transfer. in memory per transfer.
@ -1060,11 +1062,34 @@ in memory per transfer.
If you are transferring large files over high speed links and you have If you are transferring large files over high speed links and you have
enough memory, then increasing this will speed up the transfers. enough memory, then increasing this will speed up the transfers.
Rclone will automatically increase the chunk size when uploading a
large file of known size to stay below the 10,000 chunks limit.
Files of unknown size are uploaded with the configured
chunk_size. Since the default chunk size is 5MB and there can be at
most 10,000 chunks, this means that by default the maximum size of
file you can stream upload is 48GB. If you wish to stream upload
larger files then you will need to increase chunk_size.
- Config: chunk_size - Config: chunk_size
- Env Var: RCLONE_S3_CHUNK_SIZE - Env Var: RCLONE_S3_CHUNK_SIZE
- Type: SizeSuffix - Type: SizeSuffix
- Default: 5M - Default: 5M
#### --s3-copy-cutoff
Cutoff for switching to multipart copy
Any files larger than this that need to be server side copied will be
copied in chunks of this size.
The minimum is 0 and the maximum is 5GB.
- Config: copy_cutoff
- Env Var: RCLONE_S3_COPY_CUTOFF
- Type: SizeSuffix
- Default: 5G
#### --s3-disable-checksum #### --s3-disable-checksum
Don't store MD5 checksum with object metadata Don't store MD5 checksum with object metadata
@ -1108,7 +1133,9 @@ if false then rclone will use virtual path style. See [the AWS S3
docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro) docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro)
for more info. for more info.
Some providers (eg Aliyun OSS or Netease COS) require this set to false. Some providers (eg AWS, Aliyun OSS or Netease COS) require this set to
false - rclone will do this automatically based on the provider
setting.
- Config: force_path_style - Config: force_path_style
- Env Var: RCLONE_S3_FORCE_PATH_STYLE - Env Var: RCLONE_S3_FORCE_PATH_STYLE
@ -1169,6 +1196,17 @@ In Ceph, this can be increased with the "rgw list buckets max chunk" option.
- Type: int - Type: int
- Default: 1000 - Default: 1000
#### --s3-encoding
This sets the encoding for the backend.
See: the [encoding section in the overview](/overview/#encoding) for more info.
- Config: encoding
- Env Var: RCLONE_S3_ENCODING
- Type: MultiEncoder
- Default: Slash,InvalidUtf8,Dot
<!--- autogenerated options stop --> <!--- autogenerated options stop -->
### Anonymous access to public buckets ### ### Anonymous access to public buckets ###

View File

@ -320,6 +320,15 @@ The command used to read sha1 hashes. Leave blank for autodetect.
- Type: string - Type: string
- Default: "" - Default: ""
#### --sftp-skip-links
Set to skip any symlinks and any other non regular files.
- Config: skip_links
- Env Var: RCLONE_SFTP_SKIP_LINKS
- Type: bool
- Default: false
<!--- autogenerated options stop --> <!--- autogenerated options stop -->
### Limitations ### ### Limitations ###

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