mirror of https://github.com/rclone/rclone.git
Version v1.66.0
This commit is contained in:
Nick Craig-Wood
parent
b7422a4fc8
commit
b6013a5e68
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,14 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
if [[ ! -z $(git status --short --untracked-files=no) ]]; then
|
||||||
|
echo "Detected uncommitted changes - commit before running this"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "Installing deadlock detector - use 'git reset --hard HEAD' to undo"
|
||||||
|
|
||||||
|
go get -v github.com/sasha-s/go-deadlock/...
|
||||||
|
find . -type f -name "*.go" -print0 | xargs -0 sed -i~ 's/sync.RWMutex/deadlock.RWMutex/; s/sync.Mutex/deadlock.Mutex/;'
|
||||||
|
goimports -w .
|
||||||
|
|
||||||
|
echo "Done"
|
||||||
|
|
@ -112,4 +112,19 @@ Properties:
|
||||||
- Type: string
|
- Type: string
|
||||||
- Required: true
|
- Required: true
|
||||||
|
|
||||||
|
### Advanced options
|
||||||
|
|
||||||
|
Here are the Advanced options specific to alias (Alias for an existing remote).
|
||||||
|
|
||||||
|
#### --alias-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_ALIAS_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
|
||||||
|
|
@ -831,6 +831,35 @@ Properties:
|
||||||
- Type: bool
|
- Type: bool
|
||||||
- Default: false
|
- Default: false
|
||||||
|
|
||||||
|
#### --azureblob-delete-snapshots
|
||||||
|
|
||||||
|
Set to specify how to deal with snapshots on blob deletion.
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: delete_snapshots
|
||||||
|
- Env Var: RCLONE_AZUREBLOB_DELETE_SNAPSHOTS
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
- Choices:
|
||||||
|
- ""
|
||||||
|
- By default, the delete operation fails if a blob has snapshots
|
||||||
|
- "include"
|
||||||
|
- Specify 'include' to remove the root blob and all its snapshots
|
||||||
|
- "only"
|
||||||
|
- Specify 'only' to remove only the snapshots but keep the root blob.
|
||||||
|
|
||||||
|
#### --azureblob-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_AZUREBLOB_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
### Custom upload headers
|
### Custom upload headers
|
||||||
|
|
|
||||||
|
|
@ -687,6 +687,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8,Dot
|
- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8,Dot
|
||||||
|
|
||||||
|
#### --azurefiles-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_AZUREFILES_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
### Custom upload headers
|
### Custom upload headers
|
||||||
|
|
|
||||||
|
|
@ -554,9 +554,12 @@ Properties:
|
||||||
|
|
||||||
#### --b2-download-auth-duration
|
#### --b2-download-auth-duration
|
||||||
|
|
||||||
Time before the authorization token will expire in s or suffix ms|s|m|h|d.
|
Time before the public link authorization token will expire in s or suffix ms|s|m|h|d.
|
||||||
|
|
||||||
|
This is used in combination with "rclone link" for making files
|
||||||
|
accessible to the public and sets the duration before the download
|
||||||
|
authorization token will expire.
|
||||||
|
|
||||||
The duration before the download authorization token will expire.
|
|
||||||
The minimum value is 1 second. The maximum value is one week.
|
The minimum value is 1 second. The maximum value is one week.
|
||||||
|
|
||||||
Properties:
|
Properties:
|
||||||
|
|
@ -632,6 +635,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
|
- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
|
||||||
|
|
||||||
|
#### --b2-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_B2_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
## Backend commands
|
## Backend commands
|
||||||
|
|
||||||
Here are the commands specific to the b2 backend.
|
Here are the commands specific to the b2 backend.
|
||||||
|
|
|
||||||
|
|
@ -473,6 +473,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot
|
- Default: Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot
|
||||||
|
|
||||||
|
#### --box-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_BOX_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
|
||||||
|
|
@ -664,6 +664,17 @@ Properties:
|
||||||
- Type: Duration
|
- Type: Duration
|
||||||
- Default: 1s
|
- Default: 1s
|
||||||
|
|
||||||
|
#### --cache-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_CACHE_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
## Backend commands
|
## Backend commands
|
||||||
|
|
||||||
Here are the commands specific to the cache backend.
|
Here are the commands specific to the cache backend.
|
||||||
|
|
|
||||||
|
|
@ -5,6 +5,176 @@ description: "Rclone Changelog"
|
||||||
|
|
||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## v1.66.0 - 2024-03-10
|
||||||
|
|
||||||
|
[See commits](https://github.com/rclone/rclone/compare/v1.65.0...v1.66.0)
|
||||||
|
|
||||||
|
* Major features
|
||||||
|
* Rclone will now sync directory modification times if the backend supports it.
|
||||||
|
* This can be disabled with [--no-update-dir-modtime](/docs/#no-update-dir-modtime)
|
||||||
|
* See [the overview](/overview/#features) and look for the `D` flags in the `ModTime` column to see which backends support it.
|
||||||
|
* Rclone will now sync directory metadata if the backend supports it when `-M`/`--metadata` is in use.
|
||||||
|
* See [the overview](/overview/#features) and look for the `D` flags in the `Metadata` column to see which backends support it.
|
||||||
|
* Bisync has received many updates see below for more details or [bisync's changelog](/bisync/#changelog)
|
||||||
|
* Removed backends
|
||||||
|
* amazonclouddrive: Remove Amazon Drive backend code and docs (Nick Craig-Wood)
|
||||||
|
* New Features
|
||||||
|
* backend
|
||||||
|
* Add description field for all backends (Paul Stern)
|
||||||
|
* build
|
||||||
|
* Update to go1.22 and make go1.20 the minimum required version (Nick Craig-Wood)
|
||||||
|
* Fix `CVE-2024-24786` by upgrading `google.golang.org/protobuf` (Nick Craig-Wood)
|
||||||
|
* check: Respect `--no-unicode-normalization` and `--ignore-case-sync` for `--checkfile` (nielash)
|
||||||
|
* cmd: Much improved shell auto completion which reduces the size of the completion file and works faster (Nick Craig-Wood)
|
||||||
|
* doc updates (albertony, ben-ba, Eli, emyarod, huajin tong, Jack Provance, kapitainsky, keongalvin, Nick Craig-Wood, nielash, rarspace01, rzitzer, Tera, Vincent Murphy)
|
||||||
|
* fs: Add more detailed logging for file includes/excludes (Kyle Reynolds)
|
||||||
|
* lsf
|
||||||
|
* Add `--time-format` flag (nielash)
|
||||||
|
* Make metadata appear for directories (Nick Craig-Wood)
|
||||||
|
* lsjson: Make metadata appear for directories (Nick Craig-Wood)
|
||||||
|
* rc
|
||||||
|
* Add `srcFs` and `dstFs` to `core/stats` and `core/transferred` stats (Nick Craig-Wood)
|
||||||
|
* Add `operations/hashsum` to the rc as `rclone hashsum` equivalent (Nick Craig-Wood)
|
||||||
|
* Add `config/paths` to the rc as `rclone config paths` equivalent (Nick Craig-Wood)
|
||||||
|
* sync
|
||||||
|
* Optionally report list of synced paths to file (nielash)
|
||||||
|
* Implement directory sync for mod times and metadata (Nick Craig-Wood)
|
||||||
|
* Don't set directory modtimes if already set (nielash)
|
||||||
|
* Don't sync directory modtimes from backends which don't have directories (Nick Craig-Wood)
|
||||||
|
* Bug Fixes
|
||||||
|
* backend
|
||||||
|
* Make backends which use oauth implement the `Shutdown` and shutdown the oauth properly (rkonfj)
|
||||||
|
* bisync
|
||||||
|
* Handle unicode and case normalization consistently (nielash)
|
||||||
|
* Partial uploads known issue on `local`/`ftp`/`sftp` has been resolved (unless using `--inplace`) (nielash)
|
||||||
|
* Fixed handling of unicode normalization and case insensitivity, support for [`--fix-case`](/docs/#fix-case), [`--ignore-case-sync`](/docs/#ignore-case-sync), [`--no-unicode-normalization`](/docs/#no-unicode-normalization) (nielash)
|
||||||
|
* Bisync no longer fails to find the correct listing file when configs are overridden with backend-specific flags. (nielash)
|
||||||
|
* nfsmount
|
||||||
|
* Fix exit after external unmount (nielash)
|
||||||
|
* Fix `--volname` being ignored (nielash)
|
||||||
|
* operations
|
||||||
|
* Fix renaming a file on macOS (nielash)
|
||||||
|
* Fix case-insensitive moves in operations.Move (nielash)
|
||||||
|
* Fix TestCaseInsensitiveMoveFileDryRun on chunker integration tests (nielash)
|
||||||
|
* Fix TestMkdirModTime test (Nick Craig-Wood)
|
||||||
|
* Fix TestSetDirModTime for backends with SetDirModTime but not Metadata (Nick Craig-Wood)
|
||||||
|
* Fix typo in log messages (nielash)
|
||||||
|
* serve nfs: Fix writing files via Finder on macOS (nielash)
|
||||||
|
* serve restic: Fix error handling (Michael Eischer)
|
||||||
|
* serve webdav: Fix `--baseurl` without leading / (Nick Craig-Wood)
|
||||||
|
* stats: Fix race between ResetCounters and stopAverageLoop called from time.AfterFunc (Nick Craig-Wood)
|
||||||
|
* sync
|
||||||
|
* `--fix-case` flag to rename case insensitive dest (nielash)
|
||||||
|
* Use operations.DirMove instead of sync.MoveDir for `--fix-case` (nielash)
|
||||||
|
* systemd: Fix detection and switch to the coreos package everywhere rather than having 2 separate libraries (Anagh Kumar Baranwal)
|
||||||
|
* Mount
|
||||||
|
* Fix macOS not noticing errors with `--daemon` (Nick Craig-Wood)
|
||||||
|
* Notice daemon dying much quicker (Nick Craig-Wood)
|
||||||
|
* VFS
|
||||||
|
* Fix unicode normalization on macOS (nielash)
|
||||||
|
* Bisync
|
||||||
|
* Copies and deletes are now handled in one operation instead of two (nielash)
|
||||||
|
* `--track-renames` and `--backup-dir` are now supported (nielash)
|
||||||
|
* Final listings are now generated from sync results, to avoid needing to re-list (nielash)
|
||||||
|
* Bisync is now much more resilient to changes that happen during a bisync run, and far less prone to critical errors / undetected changes (nielash)
|
||||||
|
* Bisync is now capable of rolling a file listing back in cases of uncertainty, essentially marking the file as needing to be rechecked next time. (nielash)
|
||||||
|
* A few basic terminal colors are now supported, controllable with [`--color`](/docs/#color-when) (`AUTO`|`NEVER`|`ALWAYS`) (nielash)
|
||||||
|
* Initial listing snapshots of Path1 and Path2 are now generated concurrently, using the same "march" infrastructure as `check` and `sync`, for performance improvements and less risk of error. (nielash)
|
||||||
|
* `--resync` is now much more efficient (especially for users of `--create-empty-src-dirs`) (nielash)
|
||||||
|
* Google Docs (and other files of unknown size) are now supported (with the same options as in `sync`) (nielash)
|
||||||
|
* Equality checks before a sync conflict rename now fall back to `cryptcheck` (when possible) or `--download`, (nielash)
|
||||||
|
instead of of `--size-only`, when `check` is not available.
|
||||||
|
* Bisync now fully supports comparing based on any combination of size, modtime, and checksum, lifting the prior restriction on backends without modtime support. (nielash)
|
||||||
|
* Bisync now supports a "Graceful Shutdown" mode to cleanly cancel a run early without requiring `--resync`. (nielash)
|
||||||
|
* New `--recover` flag allows robust recovery in the event of interruptions, without requiring `--resync`. (nielash)
|
||||||
|
* A new `--max-lock` setting allows lock files to automatically renew and expire, for better automatic recovery when a run is interrupted. (nielash)
|
||||||
|
* Bisync now supports auto-resolving sync conflicts and customizing rename behavior with new [`--conflict-resolve`](#conflict-resolve), [`--conflict-loser`](#conflict-loser), and [`--conflict-suffix`](#conflict-suffix) flags. (nielash)
|
||||||
|
* A new [`--resync-mode`](#resync-mode) flag allows more control over which version of a file gets kept during a `--resync`. (nielash)
|
||||||
|
* Bisync now supports [`--retries`](/docs/#retries-int) and [`--retries-sleep`](/docs/#retries-sleep-time) (when [`--resilient`](#resilient) is set.) (nielash)
|
||||||
|
* Clarify file operation directions in dry-run logs (Kyle Reynolds)
|
||||||
|
* Local
|
||||||
|
* Fix cleanRootPath on Windows after go1.21.4 stdlib update (nielash)
|
||||||
|
* Implement setting modification time on directories (nielash)
|
||||||
|
* Implement modtime and metadata for directories (Nick Craig-Wood)
|
||||||
|
* Fix setting of btime on directories on Windows (Nick Craig-Wood)
|
||||||
|
* Delete backend implementation of Purge to speed up and make stats (Nick Craig-Wood)
|
||||||
|
* Support metadata setting and mapping on server side Move (Nick Craig-Wood)
|
||||||
|
* Cache
|
||||||
|
* Implement setting modification time on directories (if supported by wrapped remote) (nielash)
|
||||||
|
* Implement setting metadata on directories (Nick Craig-Wood)
|
||||||
|
* Crypt
|
||||||
|
* Implement setting modification time on directories (if supported by wrapped remote) (nielash)
|
||||||
|
* Implement setting metadata on directories (Nick Craig-Wood)
|
||||||
|
* Improve handling of undecryptable file names (nielash)
|
||||||
|
* Add missing error check spotted by linter (Nick Craig-Wood)
|
||||||
|
* Azure Blob
|
||||||
|
* Implement `--azureblob-delete-snapshots` (Nick Craig-Wood)
|
||||||
|
* B2
|
||||||
|
* Clarify exactly what `--b2-download-auth-duration` does in the docs (Nick Craig-Wood)
|
||||||
|
* Chunker
|
||||||
|
* Implement setting modification time on directories (if supported by wrapped remote) (nielash)
|
||||||
|
* Implement setting metadata on directories (Nick Craig-Wood)
|
||||||
|
* Combine
|
||||||
|
* Implement setting modification time on directories (if supported by wrapped remote) (nielash)
|
||||||
|
* Implement setting metadata on directories (Nick Craig-Wood)
|
||||||
|
* Fix directory metadata error on upstream root (nielash)
|
||||||
|
* Fix directory move across upstreams (nielash)
|
||||||
|
* Compress
|
||||||
|
* Implement setting modification time on directories (if supported by wrapped remote) (nielash)
|
||||||
|
* Implement setting metadata on directories (Nick Craig-Wood)
|
||||||
|
* Drive
|
||||||
|
* Implement setting modification time on directories (nielash)
|
||||||
|
* Implement modtime and metadata setting for directories (Nick Craig-Wood)
|
||||||
|
* Support metadata setting and mapping on server side Move,Copy (Nick Craig-Wood)
|
||||||
|
* FTP
|
||||||
|
* Fix mkdir with rsftp which is returning the wrong code (Nick Craig-Wood)
|
||||||
|
* Hasher
|
||||||
|
* Implement setting modification time on directories (if supported by wrapped remote) (nielash)
|
||||||
|
* Implement setting metadata on directories (Nick Craig-Wood)
|
||||||
|
* Fix error from trying to stop an already-stopped db (nielash)
|
||||||
|
* Look for cached hash if passed hash unexpectedly blank (nielash)
|
||||||
|
* Imagekit
|
||||||
|
* Updated docs and web content (Harshit Budhraja)
|
||||||
|
* Updated overview - supported operations (Harshit Budhraja)
|
||||||
|
* Mega
|
||||||
|
* Fix panic with go1.22 (Nick Craig-Wood)
|
||||||
|
* Netstorage
|
||||||
|
* Fix Root to return correct directory when pointing to a file (Nick Craig-Wood)
|
||||||
|
* Onedrive
|
||||||
|
* Add metadata support (nielash)
|
||||||
|
* Opendrive
|
||||||
|
* Fix moving file/folder within the same parent dir (nielash)
|
||||||
|
* Oracle Object Storage
|
||||||
|
* Support `backend restore` command (Nikhil Ahuja)
|
||||||
|
* Support workload identity authentication for OKE (Anders Swanson)
|
||||||
|
* Protondrive
|
||||||
|
* Fix encoding of Root method (Nick Craig-Wood)
|
||||||
|
* Quatrix
|
||||||
|
* Fix `Content-Range` header (Volodymyr)
|
||||||
|
* Add option to skip project folders (Oksana Zhykina)
|
||||||
|
* Fix Root to return correct directory when pointing to a file (Nick Craig-Wood)
|
||||||
|
* S3
|
||||||
|
* Add `--s3-version-deleted` to show delete markers in listings when using versions. (Nick Craig-Wood)
|
||||||
|
* Add IPv6 support with option `--s3-use-dual-stack` (Anthony Metzidis)
|
||||||
|
* Copy parts in parallel when doing chunked server side copy (Nick Craig-Wood)
|
||||||
|
* GCS provider: fix server side copy of files bigger than 5G (Nick Craig-Wood)
|
||||||
|
* Support metadata setting and mapping on server side Copy (Nick Craig-Wood)
|
||||||
|
* Seafile
|
||||||
|
* Fix download/upload error when `FILE_SERVER_ROOT` is relative (DanielEgbers)
|
||||||
|
* Fix Root to return correct directory when pointing to a file (Nick Craig-Wood)
|
||||||
|
* SFTP
|
||||||
|
* Implement setting modification time on directories (nielash)
|
||||||
|
* Set directory modtimes update on write flag (Nick Craig-Wood)
|
||||||
|
* Shorten wait delay for external ssh binaries now that we are using go1.20 (Nick Craig-Wood)
|
||||||
|
* Swift
|
||||||
|
* Avoid unnecessary container versioning check (Joe Cai)
|
||||||
|
* Union
|
||||||
|
* Implement setting modification time on directories (if supported by wrapped remote) (nielash)
|
||||||
|
* Implement setting metadata on directories (Nick Craig-Wood)
|
||||||
|
* WebDAV
|
||||||
|
* Reduce priority of chunks upload log (Gabriel Ramos)
|
||||||
|
* owncloud: Add config `owncloud_exclude_shares` which allows to exclude shared files and folders when listing remote resources (Thomas Müller)
|
||||||
|
|
||||||
## v1.65.2 - 2024-01-24
|
## v1.65.2 - 2024-01-24
|
||||||
|
|
||||||
[See commits](https://github.com/rclone/rclone/compare/v1.65.1...v1.65.2)
|
[See commits](https://github.com/rclone/rclone/compare/v1.65.1...v1.65.2)
|
||||||
|
|
@ -3435,7 +3605,7 @@ all the docs and Edward Barker for helping re-write the front page.
|
||||||
* this is for building web native GUIs for rclone
|
* this is for building web native GUIs for rclone
|
||||||
* Optionally serving objects on the rc http server
|
* Optionally serving objects on the rc http server
|
||||||
* Ensure rclone fails to start up if the `--rc` port is in use already
|
* Ensure rclone fails to start up if the `--rc` port is in use already
|
||||||
* See [the rc docs](https://rclone.org/rc/) for more info
|
* See [the rc docs](/rc/) for more info
|
||||||
* sync/copy/move
|
* sync/copy/move
|
||||||
* Make `--files-from` only read the objects specified and don't scan directories (Nick Craig-Wood)
|
* Make `--files-from` only read the objects specified and don't scan directories (Nick Craig-Wood)
|
||||||
* This is a huge speed improvement for destinations with lots of files
|
* This is a huge speed improvement for destinations with lots of files
|
||||||
|
|
|
||||||
|
|
@ -477,4 +477,15 @@ Properties:
|
||||||
- If meta format is set to "none", rename transactions will always be used.
|
- If meta format is set to "none", rename transactions will always be used.
|
||||||
- This method is EXPERIMENTAL, don't use on production systems.
|
- This method is EXPERIMENTAL, don't use on production systems.
|
||||||
|
|
||||||
|
#### --chunker-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_CHUNKER_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
|
||||||
|
|
@ -154,6 +154,21 @@ Properties:
|
||||||
- Type: SpaceSepList
|
- Type: SpaceSepList
|
||||||
- Default:
|
- Default:
|
||||||
|
|
||||||
|
### Advanced options
|
||||||
|
|
||||||
|
Here are the Advanced options specific to combine (Combine several remotes into one).
|
||||||
|
|
||||||
|
#### --combine-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_COMBINE_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
### Metadata
|
### Metadata
|
||||||
|
|
||||||
Any metadata supported by the underlying remote is read and written.
|
Any metadata supported by the underlying remote is read and written.
|
||||||
|
|
|
||||||
|
|
@ -27,14 +27,7 @@ rclone [flags]
|
||||||
### Options
|
### Options
|
||||||
|
|
||||||
```
|
```
|
||||||
--acd-auth-url string Auth server URL
|
--alias-description string Description of the remote
|
||||||
--acd-client-id string OAuth Client Id
|
|
||||||
--acd-client-secret string OAuth Client Secret
|
|
||||||
--acd-encoding Encoding The encoding for the backend (default Slash,InvalidUtf8,Dot)
|
|
||||||
--acd-templink-threshold SizeSuffix Files >= this size will be downloaded via their tempLink (default 9Gi)
|
|
||||||
--acd-token string OAuth Access Token as a JSON blob
|
|
||||||
--acd-token-url string Token server url
|
|
||||||
--acd-upload-wait-per-gb Duration Additional time per GiB to wait after a failed complete upload to see if it appears (default 3m0s)
|
|
||||||
--alias-remote string Remote or path to alias
|
--alias-remote string Remote or path to alias
|
||||||
--ask-password Allow prompt for password for encrypted configuration (default true)
|
--ask-password Allow prompt for password for encrypted configuration (default true)
|
||||||
--auto-confirm If enabled, do not request console confirmation
|
--auto-confirm If enabled, do not request console confirmation
|
||||||
|
|
@ -47,6 +40,8 @@ rclone [flags]
|
||||||
--azureblob-client-id string The ID of the client in use
|
--azureblob-client-id string The ID of the client in use
|
||||||
--azureblob-client-secret string One of the service principal's client secrets
|
--azureblob-client-secret string One of the service principal's client secrets
|
||||||
--azureblob-client-send-certificate-chain Send the certificate chain when using certificate auth
|
--azureblob-client-send-certificate-chain Send the certificate chain when using certificate auth
|
||||||
|
--azureblob-delete-snapshots string Set to specify how to deal with snapshots on blob deletion
|
||||||
|
--azureblob-description string Description of the remote
|
||||||
--azureblob-directory-markers Upload an empty object with a trailing slash when a new directory is created
|
--azureblob-directory-markers Upload an empty object with a trailing slash when a new directory is created
|
||||||
--azureblob-disable-checksum Don't store MD5 checksum with object metadata
|
--azureblob-disable-checksum Don't store MD5 checksum with object metadata
|
||||||
--azureblob-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8)
|
--azureblob-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8)
|
||||||
|
|
@ -77,6 +72,7 @@ rclone [flags]
|
||||||
--azurefiles-client-secret string One of the service principal's client secrets
|
--azurefiles-client-secret string One of the service principal's client secrets
|
||||||
--azurefiles-client-send-certificate-chain Send the certificate chain when using certificate auth
|
--azurefiles-client-send-certificate-chain Send the certificate chain when using certificate auth
|
||||||
--azurefiles-connection-string string Azure Files Connection String
|
--azurefiles-connection-string string Azure Files Connection String
|
||||||
|
--azurefiles-description string Description of the remote
|
||||||
--azurefiles-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8,Dot)
|
--azurefiles-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8,Dot)
|
||||||
--azurefiles-endpoint string Endpoint for the service
|
--azurefiles-endpoint string Endpoint for the service
|
||||||
--azurefiles-env-auth Read credentials from runtime (environment variables, CLI or MSI)
|
--azurefiles-env-auth Read credentials from runtime (environment variables, CLI or MSI)
|
||||||
|
|
@ -96,8 +92,9 @@ rclone [flags]
|
||||||
--b2-account string Account ID or Application Key ID
|
--b2-account string Account ID or Application Key ID
|
||||||
--b2-chunk-size SizeSuffix Upload chunk size (default 96Mi)
|
--b2-chunk-size SizeSuffix Upload chunk size (default 96Mi)
|
||||||
--b2-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4Gi)
|
--b2-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4Gi)
|
||||||
|
--b2-description string Description of the remote
|
||||||
--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 public link 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 Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
--b2-encoding Encoding 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
|
||||||
|
|
@ -118,6 +115,7 @@ rclone [flags]
|
||||||
--box-client-id string OAuth Client Id
|
--box-client-id string OAuth Client Id
|
||||||
--box-client-secret string OAuth Client Secret
|
--box-client-secret string OAuth 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-description string Description of the remote
|
||||||
--box-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot)
|
--box-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot)
|
||||||
--box-impersonate string Impersonate this user ID when using a service account
|
--box-impersonate string Impersonate this user ID when using a service account
|
||||||
--box-list-chunk int Size of listing chunk 1-1000 (default 1000)
|
--box-list-chunk int Size of listing chunk 1-1000 (default 1000)
|
||||||
|
|
@ -138,6 +136,7 @@ rclone [flags]
|
||||||
--cache-db-path string Directory to store file structure metadata DB (default "$HOME/.cache/rclone/cache-backend")
|
--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-purge Clear all the cached data for this remote on start
|
||||||
--cache-db-wait-time Duration How long to wait for the DB to be available - 0 is unlimited (default 1s)
|
--cache-db-wait-time Duration How long to wait for the DB to be available - 0 is unlimited (default 1s)
|
||||||
|
--cache-description string Description of the remote
|
||||||
--cache-dir string Directory rclone will use for caching (default "$HOME/.cache/rclone")
|
--cache-dir string Directory rclone will use for caching (default "$HOME/.cache/rclone")
|
||||||
--cache-info-age Duration How long to cache file structure information (directory listings, file size, times, etc.) (default 6h0m0s)
|
--cache-info-age Duration How long to cache file structure information (directory listings, file size, times, etc.) (default 6h0m0s)
|
||||||
--cache-plex-insecure string Skip all certificate verification when connecting to the Plex server
|
--cache-plex-insecure string Skip all certificate verification when connecting to the Plex server
|
||||||
|
|
@ -155,14 +154,17 @@ rclone [flags]
|
||||||
--checkers int Number of checkers to run in parallel (default 8)
|
--checkers int Number of checkers to run in parallel (default 8)
|
||||||
-c, --checksum Check for changes with size & checksum (if available, or fallback to size only).
|
-c, --checksum Check for changes with size & checksum (if available, or fallback to size only).
|
||||||
--chunker-chunk-size SizeSuffix Files larger than chunk size will be split in chunks (default 2Gi)
|
--chunker-chunk-size SizeSuffix Files larger than chunk size will be split in chunks (default 2Gi)
|
||||||
|
--chunker-description string Description of the remote
|
||||||
--chunker-fail-hard Choose how chunker should handle files with missing or invalid chunks
|
--chunker-fail-hard Choose how chunker should handle files with missing or invalid chunks
|
||||||
--chunker-hash-type string Choose how chunker handles hash sums (default "md5")
|
--chunker-hash-type string Choose how chunker handles hash sums (default "md5")
|
||||||
--chunker-remote string Remote to chunk/unchunk
|
--chunker-remote string Remote to chunk/unchunk
|
||||||
--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
|
||||||
--color AUTO|NEVER|ALWAYS When to show colors (and other ANSI codes) AUTO|NEVER|ALWAYS (default AUTO)
|
--color AUTO|NEVER|ALWAYS When to show colors (and other ANSI codes) AUTO|NEVER|ALWAYS (default AUTO)
|
||||||
|
--combine-description string Description of the remote
|
||||||
--combine-upstreams SpaceSepList Upstreams for combining
|
--combine-upstreams SpaceSepList Upstreams for combining
|
||||||
--compare-dest stringArray Include additional comma separated server-side paths during comparison
|
--compare-dest stringArray Include additional comma separated server-side paths during comparison
|
||||||
|
--compress-description string Description of the remote
|
||||||
--compress-level int GZIP compression level (-2 to 9) (default -1)
|
--compress-level int GZIP compression level (-2 to 9) (default -1)
|
||||||
--compress-mode string Compression mode (default "gzip")
|
--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 20Mi)
|
--compress-ram-cache-limit SizeSuffix Some remotes don't allow the upload of files with unknown size (default 20Mi)
|
||||||
|
|
@ -172,6 +174,7 @@ rclone [flags]
|
||||||
--copy-dest stringArray Implies --compare-dest but also copies files from paths into destination
|
--copy-dest stringArray Implies --compare-dest but also copies files from paths into destination
|
||||||
-L, --copy-links Follow symlinks and copy the pointed to item
|
-L, --copy-links Follow symlinks and copy the pointed to item
|
||||||
--cpuprofile string Write cpu profile to file
|
--cpuprofile string Write cpu profile to file
|
||||||
|
--crypt-description string Description of the remote
|
||||||
--crypt-directory-name-encryption Option to either encrypt directory names or leave them intact (default true)
|
--crypt-directory-name-encryption Option to either encrypt directory names or leave them intact (default true)
|
||||||
--crypt-filename-encoding string How to encode the encrypted filename to text string (default "base32")
|
--crypt-filename-encoding string How to encode the encrypted filename to text string (default "base32")
|
||||||
--crypt-filename-encryption string How to encrypt the filenames (default "standard")
|
--crypt-filename-encryption string How to encrypt the filenames (default "standard")
|
||||||
|
|
@ -182,6 +185,7 @@ rclone [flags]
|
||||||
--crypt-remote string Remote to encrypt/decrypt
|
--crypt-remote string Remote to encrypt/decrypt
|
||||||
--crypt-server-side-across-configs Deprecated: use --server-side-across-configs instead
|
--crypt-server-side-across-configs Deprecated: use --server-side-across-configs instead
|
||||||
--crypt-show-mapping For all files listed show how the names encrypt
|
--crypt-show-mapping For all files listed show how the names encrypt
|
||||||
|
--crypt-strict-names If set, this will raise an error when crypt comes across a filename that can't be decrypted
|
||||||
--crypt-suffix string If this is set it will override the default suffix of ".bin" (default ".bin")
|
--crypt-suffix string If this is set it will override the default suffix of ".bin" (default ".bin")
|
||||||
--cutoff-mode HARD|SOFT|CAUTIOUS Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD)
|
--cutoff-mode HARD|SOFT|CAUTIOUS Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD)
|
||||||
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
|
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
|
||||||
|
|
@ -200,6 +204,7 @@ rclone [flags]
|
||||||
--drive-client-id string Google Application Client Id
|
--drive-client-id string Google Application Client Id
|
||||||
--drive-client-secret string OAuth Client Secret
|
--drive-client-secret string OAuth Client Secret
|
||||||
--drive-copy-shortcut-content Server side copy contents of shortcuts instead of the shortcut
|
--drive-copy-shortcut-content Server side copy contents of shortcuts instead of the shortcut
|
||||||
|
--drive-description string Description of the remote
|
||||||
--drive-disable-http2 Disable drive using http2 (default true)
|
--drive-disable-http2 Disable drive using http2 (default true)
|
||||||
--drive-encoding Encoding The encoding for the backend (default InvalidUtf8)
|
--drive-encoding Encoding The encoding for the backend (default InvalidUtf8)
|
||||||
--drive-env-auth Get IAM credentials from runtime (environment variables or instance meta data if no env vars)
|
--drive-env-auth Get IAM credentials from runtime (environment variables or instance meta data if no env vars)
|
||||||
|
|
@ -248,6 +253,7 @@ rclone [flags]
|
||||||
--dropbox-chunk-size SizeSuffix Upload chunk size (< 150Mi) (default 48Mi)
|
--dropbox-chunk-size SizeSuffix Upload chunk size (< 150Mi) (default 48Mi)
|
||||||
--dropbox-client-id string OAuth Client Id
|
--dropbox-client-id string OAuth Client Id
|
||||||
--dropbox-client-secret string OAuth Client Secret
|
--dropbox-client-secret string OAuth Client Secret
|
||||||
|
--dropbox-description string Description of the remote
|
||||||
--dropbox-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot)
|
--dropbox-encoding Encoding 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
|
||||||
--dropbox-pacer-min-sleep Duration Minimum time to sleep between API calls (default 10ms)
|
--dropbox-pacer-min-sleep Duration Minimum time to sleep between API calls (default 10ms)
|
||||||
|
|
@ -268,10 +274,12 @@ rclone [flags]
|
||||||
--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
|
||||||
--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-cdn Set if you wish to use CDN download links
|
--fichier-cdn Set if you wish to use CDN download links
|
||||||
|
--fichier-description string Description of the remote
|
||||||
--fichier-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot)
|
--fichier-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot)
|
||||||
--fichier-file-password string If you want to download a shared file that is password protected, add this parameter (obscured)
|
--fichier-file-password string If you want to download a shared file that is password protected, add this parameter (obscured)
|
||||||
--fichier-folder-password string If you want to list the files in a shared folder that is password protected, add this parameter (obscured)
|
--fichier-folder-password string If you want to list the files in a shared folder that is password protected, add this parameter (obscured)
|
||||||
--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
|
||||||
|
--filefabric-description string Description of the remote
|
||||||
--filefabric-encoding Encoding The encoding for the backend (default Slash,Del,Ctl,InvalidUtf8,Dot)
|
--filefabric-encoding Encoding The encoding for the backend (default Slash,Del,Ctl,InvalidUtf8,Dot)
|
||||||
--filefabric-permanent-token string Permanent Authentication Token
|
--filefabric-permanent-token string Permanent Authentication Token
|
||||||
--filefabric-root-folder-id string ID of the root folder
|
--filefabric-root-folder-id string ID of the root folder
|
||||||
|
|
@ -283,11 +291,13 @@ rclone [flags]
|
||||||
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (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)
|
||||||
-f, --filter stringArray Add a file filtering rule
|
-f, --filter stringArray Add a file filtering rule
|
||||||
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
|
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
|
||||||
|
--fix-case Force rename of case insensitive dest to match source
|
||||||
--fs-cache-expire-duration Duration Cache remotes for this long (0 to disable caching) (default 5m0s)
|
--fs-cache-expire-duration Duration Cache remotes for this long (0 to disable caching) (default 5m0s)
|
||||||
--fs-cache-expire-interval Duration Interval to check for expired remotes (default 1m0s)
|
--fs-cache-expire-interval Duration Interval to check for expired remotes (default 1m0s)
|
||||||
--ftp-ask-password Allow asking for FTP password when needed
|
--ftp-ask-password Allow asking for FTP password when needed
|
||||||
--ftp-close-timeout Duration Maximum time to wait for a response to close (default 1m0s)
|
--ftp-close-timeout Duration Maximum time to wait for a response to close (default 1m0s)
|
||||||
--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-description string Description of the remote
|
||||||
--ftp-disable-epsv Disable using EPSV even if server advertises support
|
--ftp-disable-epsv Disable using EPSV even if server advertises support
|
||||||
--ftp-disable-mlsd Disable using MLSD even if server advertises support
|
--ftp-disable-mlsd Disable using MLSD even if server advertises support
|
||||||
--ftp-disable-tls13 Disable TLS 1.3 (workaround for FTP servers with buggy TLS)
|
--ftp-disable-tls13 Disable TLS 1.3 (workaround for FTP servers with buggy TLS)
|
||||||
|
|
@ -313,6 +323,7 @@ rclone [flags]
|
||||||
--gcs-client-id string OAuth Client Id
|
--gcs-client-id string OAuth Client Id
|
||||||
--gcs-client-secret string OAuth Client Secret
|
--gcs-client-secret string OAuth Client Secret
|
||||||
--gcs-decompress If set this will decompress gzip encoded objects
|
--gcs-decompress If set this will decompress gzip encoded objects
|
||||||
|
--gcs-description string Description of the remote
|
||||||
--gcs-directory-markers Upload an empty object with a trailing slash when a new directory is created
|
--gcs-directory-markers Upload an empty object with a trailing slash when a new directory is created
|
||||||
--gcs-encoding Encoding The encoding for the backend (default Slash,CrLf,InvalidUtf8,Dot)
|
--gcs-encoding Encoding The encoding for the backend (default Slash,CrLf,InvalidUtf8,Dot)
|
||||||
--gcs-endpoint string Endpoint for the service
|
--gcs-endpoint string Endpoint for the service
|
||||||
|
|
@ -333,6 +344,7 @@ rclone [flags]
|
||||||
--gphotos-batch-timeout Duration Max time to allow an idle upload batch before uploading (default 0s)
|
--gphotos-batch-timeout Duration Max time to allow an idle upload batch before uploading (default 0s)
|
||||||
--gphotos-client-id string OAuth Client Id
|
--gphotos-client-id string OAuth Client Id
|
||||||
--gphotos-client-secret string OAuth Client Secret
|
--gphotos-client-secret string OAuth Client Secret
|
||||||
|
--gphotos-description string Description of the remote
|
||||||
--gphotos-encoding Encoding The encoding for the backend (default Slash,CrLf,InvalidUtf8,Dot)
|
--gphotos-encoding Encoding The encoding for the backend (default Slash,CrLf,InvalidUtf8,Dot)
|
||||||
--gphotos-include-archived Also view and download archived media
|
--gphotos-include-archived Also view and download archived media
|
||||||
--gphotos-read-only Set to make the Google Photos backend read only
|
--gphotos-read-only Set to make the Google Photos backend read only
|
||||||
|
|
@ -341,10 +353,12 @@ rclone [flags]
|
||||||
--gphotos-token string OAuth Access Token as a JSON blob
|
--gphotos-token string OAuth Access Token as a JSON blob
|
||||||
--gphotos-token-url string Token server url
|
--gphotos-token-url string Token server url
|
||||||
--hasher-auto-size SizeSuffix Auto-update checksum for files smaller than this size (disabled by default)
|
--hasher-auto-size SizeSuffix Auto-update checksum for files smaller than this size (disabled by default)
|
||||||
|
--hasher-description string Description of the remote
|
||||||
--hasher-hashes CommaSepList Comma separated list of supported checksum types (default md5,sha1)
|
--hasher-hashes CommaSepList Comma separated list of supported checksum types (default md5,sha1)
|
||||||
--hasher-max-age Duration Maximum time to keep checksums in cache (0 = no cache, off = cache forever) (default off)
|
--hasher-max-age Duration Maximum time to keep checksums in cache (0 = no cache, off = cache forever) (default off)
|
||||||
--hasher-remote string Remote to cache checksums for (e.g. myRemote:path)
|
--hasher-remote string Remote to cache checksums for (e.g. myRemote:path)
|
||||||
--hdfs-data-transfer-protection string Kerberos data transfer protection: authentication|integrity|privacy
|
--hdfs-data-transfer-protection string Kerberos data transfer protection: authentication|integrity|privacy
|
||||||
|
--hdfs-description string Description of the remote
|
||||||
--hdfs-encoding Encoding The encoding for the backend (default Slash,Colon,Del,Ctl,InvalidUtf8,Dot)
|
--hdfs-encoding Encoding The encoding for the backend (default Slash,Colon,Del,Ctl,InvalidUtf8,Dot)
|
||||||
--hdfs-namenode CommaSepList Hadoop name nodes and ports
|
--hdfs-namenode CommaSepList Hadoop name nodes and ports
|
||||||
--hdfs-service-principal-name string Kerberos service principal name for the namenode
|
--hdfs-service-principal-name string Kerberos service principal name for the namenode
|
||||||
|
|
@ -357,6 +371,7 @@ rclone [flags]
|
||||||
--hidrive-chunk-size SizeSuffix Chunksize for chunked uploads (default 48Mi)
|
--hidrive-chunk-size SizeSuffix Chunksize for chunked uploads (default 48Mi)
|
||||||
--hidrive-client-id string OAuth Client Id
|
--hidrive-client-id string OAuth Client Id
|
||||||
--hidrive-client-secret string OAuth Client Secret
|
--hidrive-client-secret string OAuth Client Secret
|
||||||
|
--hidrive-description string Description of the remote
|
||||||
--hidrive-disable-fetching-member-count Do not fetch number of objects in directories unless it is absolutely necessary
|
--hidrive-disable-fetching-member-count Do not fetch number of objects in directories unless it is absolutely necessary
|
||||||
--hidrive-encoding Encoding The encoding for the backend (default Slash,Dot)
|
--hidrive-encoding Encoding The encoding for the backend (default Slash,Dot)
|
||||||
--hidrive-endpoint string Endpoint for the service (default "https://api.hidrive.strato.com/2.1")
|
--hidrive-endpoint string Endpoint for the service (default "https://api.hidrive.strato.com/2.1")
|
||||||
|
|
@ -367,6 +382,7 @@ rclone [flags]
|
||||||
--hidrive-token-url string Token server url
|
--hidrive-token-url string Token server url
|
||||||
--hidrive-upload-concurrency int Concurrency for chunked uploads (default 4)
|
--hidrive-upload-concurrency int Concurrency for chunked uploads (default 4)
|
||||||
--hidrive-upload-cutoff SizeSuffix Cutoff/Threshold for chunked uploads (default 96Mi)
|
--hidrive-upload-cutoff SizeSuffix Cutoff/Threshold for chunked uploads (default 96Mi)
|
||||||
|
--http-description string Description of the remote
|
||||||
--http-headers CommaSepList Set HTTP headers for all transactions
|
--http-headers CommaSepList Set HTTP headers for all transactions
|
||||||
--http-no-head Don't use HEAD requests
|
--http-no-head Don't use HEAD requests
|
||||||
--http-no-slash Set this if the site doesn't end directories with /
|
--http-no-slash Set this if the site doesn't end directories with /
|
||||||
|
|
@ -378,7 +394,8 @@ rclone [flags]
|
||||||
--ignore-errors Delete even if there are I/O errors
|
--ignore-errors Delete even if there are I/O errors
|
||||||
--ignore-existing Skip all files that exist on destination
|
--ignore-existing Skip all files that exist on destination
|
||||||
--ignore-size Ignore size when skipping use modtime or checksum
|
--ignore-size Ignore size when skipping use modtime or checksum
|
||||||
-I, --ignore-times Don't skip files that match size and time - transfer all files
|
-I, --ignore-times Don't skip items that match size and time - transfer all unconditionally
|
||||||
|
--imagekit-description string Description of the remote
|
||||||
--imagekit-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Dollar,Question,Hash,Percent,BackSlash,Del,Ctl,InvalidUtf8,Dot,SquareBracket)
|
--imagekit-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Dollar,Question,Hash,Percent,BackSlash,Del,Ctl,InvalidUtf8,Dot,SquareBracket)
|
||||||
--imagekit-endpoint string You can find your ImageKit.io URL endpoint in your [dashboard](https://imagekit.io/dashboard/developer/api-keys)
|
--imagekit-endpoint string You can find your ImageKit.io URL endpoint in your [dashboard](https://imagekit.io/dashboard/developer/api-keys)
|
||||||
--imagekit-only-signed Restrict unsigned image URLs If you have configured Restrict unsigned image URLs in your dashboard settings, set this to true
|
--imagekit-only-signed Restrict unsigned image URLs If you have configured Restrict unsigned image URLs in your dashboard settings, set this to true
|
||||||
|
|
@ -392,6 +409,7 @@ rclone [flags]
|
||||||
--inplace Download directly to destination file instead of atomic download to temp/rename
|
--inplace Download directly to destination file instead of atomic download to temp/rename
|
||||||
-i, --interactive Enable interactive mode
|
-i, --interactive Enable interactive mode
|
||||||
--internetarchive-access-key-id string IAS3 Access Key
|
--internetarchive-access-key-id string IAS3 Access Key
|
||||||
|
--internetarchive-description string Description of the remote
|
||||||
--internetarchive-disable-checksum Don't ask the server to test against MD5 checksum calculated by rclone (default true)
|
--internetarchive-disable-checksum Don't ask the server to test against MD5 checksum calculated by rclone (default true)
|
||||||
--internetarchive-encoding Encoding The encoding for the backend (default Slash,LtGt,CrLf,Del,Ctl,InvalidUtf8,Dot)
|
--internetarchive-encoding Encoding The encoding for the backend (default Slash,LtGt,CrLf,Del,Ctl,InvalidUtf8,Dot)
|
||||||
--internetarchive-endpoint string IAS3 Endpoint (default "https://s3.us.archive.org")
|
--internetarchive-endpoint string IAS3 Endpoint (default "https://s3.us.archive.org")
|
||||||
|
|
@ -401,6 +419,7 @@ rclone [flags]
|
||||||
--jottacloud-auth-url string Auth server URL
|
--jottacloud-auth-url string Auth server URL
|
||||||
--jottacloud-client-id string OAuth Client Id
|
--jottacloud-client-id string OAuth Client Id
|
||||||
--jottacloud-client-secret string OAuth Client Secret
|
--jottacloud-client-secret string OAuth Client Secret
|
||||||
|
--jottacloud-description string Description of the remote
|
||||||
--jottacloud-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot)
|
--jottacloud-encoding Encoding 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 10Mi)
|
--jottacloud-md5-memory-limit SizeSuffix Files bigger than this will be cached on disk to calculate the MD5 if required (default 10Mi)
|
||||||
|
|
@ -409,6 +428,7 @@ rclone [flags]
|
||||||
--jottacloud-token-url string Token server url
|
--jottacloud-token-url string Token server url
|
||||||
--jottacloud-trashed-only Only show files that are in the trash
|
--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 10Mi)
|
--jottacloud-upload-resume-limit SizeSuffix Files bigger than this can be resumed if the upload fail's (default 10Mi)
|
||||||
|
--koofr-description string Description of the remote
|
||||||
--koofr-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
--koofr-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||||
--koofr-endpoint string The Koofr API endpoint to use
|
--koofr-endpoint string The Koofr API endpoint to use
|
||||||
--koofr-mountid string Mount ID of the mount to use
|
--koofr-mountid string Mount ID of the mount to use
|
||||||
|
|
@ -417,10 +437,12 @@ rclone [flags]
|
||||||
--koofr-setmtime Does the backend support setting modification time (default true)
|
--koofr-setmtime Does the backend support setting modification time (default true)
|
||||||
--koofr-user string Your user name
|
--koofr-user string Your user name
|
||||||
--kv-lock-time Duration Maximum time to keep key-value database locked by process (default 1s)
|
--kv-lock-time Duration Maximum time to keep key-value database locked by process (default 1s)
|
||||||
|
--linkbox-description string Description of the remote
|
||||||
--linkbox-token string Token from https://www.linkbox.to/admin/account
|
--linkbox-token string Token from https://www.linkbox.to/admin/account
|
||||||
-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-description string Description of the remote
|
||||||
--local-encoding Encoding The encoding for the backend (default Slash,Dot)
|
--local-encoding Encoding 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-preallocate Disable preallocation of disk space for transferred files
|
--local-no-preallocate Disable preallocation of disk space for transferred files
|
||||||
|
|
@ -438,6 +460,7 @@ rclone [flags]
|
||||||
--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-client-id string OAuth Client Id
|
--mailru-client-id string OAuth Client Id
|
||||||
--mailru-client-secret string OAuth Client Secret
|
--mailru-client-secret string OAuth Client Secret
|
||||||
|
--mailru-description string Description of the remote
|
||||||
--mailru-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
--mailru-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||||
--mailru-pass string Password (obscured)
|
--mailru-pass string Password (obscured)
|
||||||
--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)
|
||||||
|
|
@ -457,11 +480,13 @@ rclone [flags]
|
||||||
--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)
|
||||||
--mega-debug Output more debug from Mega
|
--mega-debug Output more debug from Mega
|
||||||
|
--mega-description string Description of the remote
|
||||||
--mega-encoding Encoding The encoding for the backend (default Slash,InvalidUtf8,Dot)
|
--mega-encoding Encoding 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 (obscured)
|
--mega-pass string Password (obscured)
|
||||||
--mega-use-https Use HTTPS for transfers
|
--mega-use-https Use HTTPS for transfers
|
||||||
--mega-user string User name
|
--mega-user string User name
|
||||||
|
--memory-description string Description of the remote
|
||||||
--memprofile string Write memory profile to file
|
--memprofile string Write memory profile to file
|
||||||
-M, --metadata If set, preserve metadata when copying objects
|
-M, --metadata If set, preserve metadata when copying objects
|
||||||
--metadata-exclude stringArray Exclude metadatas matching pattern
|
--metadata-exclude stringArray Exclude metadatas matching pattern
|
||||||
|
|
@ -480,6 +505,7 @@ rclone [flags]
|
||||||
--multi-thread-streams int Number of streams to use for multi-thread downloads (default 4)
|
--multi-thread-streams int Number of streams to use for multi-thread downloads (default 4)
|
||||||
--multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki)
|
--multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki)
|
||||||
--netstorage-account string Set the NetStorage account name
|
--netstorage-account string Set the NetStorage account name
|
||||||
|
--netstorage-description string Description of the remote
|
||||||
--netstorage-host string Domain+path of NetStorage host to connect to
|
--netstorage-host string Domain+path of NetStorage host to connect to
|
||||||
--netstorage-protocol string Select between HTTP or HTTPS protocol (default "https")
|
--netstorage-protocol string Select between HTTP or HTTPS protocol (default "https")
|
||||||
--netstorage-secret string Set the NetStorage account secret/G2O key for authentication (obscured)
|
--netstorage-secret string Set the NetStorage account secret/G2O key for authentication (obscured)
|
||||||
|
|
@ -489,6 +515,7 @@ rclone [flags]
|
||||||
--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-unicode-normalization Don't normalize unicode characters in filenames
|
--no-unicode-normalization Don't normalize unicode characters in filenames
|
||||||
|
--no-update-dir-modtime Don't update directory modification times
|
||||||
--no-update-modtime Don't update destination modtime if files identical
|
--no-update-modtime Don't update destination modtime if files identical
|
||||||
-x, --one-file-system Don't cross filesystem boundaries (unix/macOS only)
|
-x, --one-file-system Don't cross filesystem boundaries (unix/macOS only)
|
||||||
--onedrive-access-scopes SpaceSepList Set scopes to be requested by rclone (default Files.Read Files.ReadWrite Files.Read.All Files.ReadWrite.All Sites.Read.All offline_access)
|
--onedrive-access-scopes SpaceSepList Set scopes to be requested by rclone (default Files.Read Files.ReadWrite Files.Read.All Files.ReadWrite.All Sites.Read.All offline_access)
|
||||||
|
|
@ -498,6 +525,7 @@ rclone [flags]
|
||||||
--onedrive-client-id string OAuth Client Id
|
--onedrive-client-id string OAuth Client Id
|
||||||
--onedrive-client-secret string OAuth Client Secret
|
--onedrive-client-secret string OAuth Client Secret
|
||||||
--onedrive-delta If set rclone will use delta listing to implement recursive listings
|
--onedrive-delta If set rclone will use delta listing to implement recursive listings
|
||||||
|
--onedrive-description string Description of the remote
|
||||||
--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 Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot)
|
--onedrive-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot)
|
||||||
|
|
@ -507,6 +535,7 @@ rclone [flags]
|
||||||
--onedrive-link-scope string Set the scope of the links created by the link command (default "anonymous")
|
--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")
|
--onedrive-link-type string Set the type of the links created by the link command (default "view")
|
||||||
--onedrive-list-chunk int Size of listing chunk (default 1000)
|
--onedrive-list-chunk int Size of listing chunk (default 1000)
|
||||||
|
--onedrive-metadata-permissions Bits Control whether permissions should be read or written in metadata (default off)
|
||||||
--onedrive-no-versions Remove all versions on modifying operations
|
--onedrive-no-versions Remove all versions on modifying operations
|
||||||
--onedrive-region string Choose national cloud region for OneDrive (default "global")
|
--onedrive-region string Choose national cloud region for OneDrive (default "global")
|
||||||
--onedrive-root-folder-id string ID of the root folder
|
--onedrive-root-folder-id string ID of the root folder
|
||||||
|
|
@ -520,6 +549,7 @@ rclone [flags]
|
||||||
--oos-config-profile string Profile name inside the oci config file (default "Default")
|
--oos-config-profile string Profile name inside the oci config file (default "Default")
|
||||||
--oos-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656Gi)
|
--oos-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656Gi)
|
||||||
--oos-copy-timeout Duration Timeout for copy (default 1m0s)
|
--oos-copy-timeout Duration Timeout for copy (default 1m0s)
|
||||||
|
--oos-description string Description of the remote
|
||||||
--oos-disable-checksum Don't store MD5 checksum with object metadata
|
--oos-disable-checksum Don't store MD5 checksum with object metadata
|
||||||
--oos-encoding Encoding The encoding for the backend (default Slash,InvalidUtf8,Dot)
|
--oos-encoding Encoding The encoding for the backend (default Slash,InvalidUtf8,Dot)
|
||||||
--oos-endpoint string Endpoint for Object storage API
|
--oos-endpoint string Endpoint for Object storage API
|
||||||
|
|
@ -538,6 +568,7 @@ rclone [flags]
|
||||||
--oos-upload-concurrency int Concurrency for multipart uploads (default 10)
|
--oos-upload-concurrency int Concurrency for multipart uploads (default 10)
|
||||||
--oos-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi)
|
--oos-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi)
|
||||||
--opendrive-chunk-size SizeSuffix Files will be uploaded in chunks this size (default 10Mi)
|
--opendrive-chunk-size SizeSuffix Files will be uploaded in chunks this size (default 10Mi)
|
||||||
|
--opendrive-description string Description of the remote
|
||||||
--opendrive-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot)
|
--opendrive-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot)
|
||||||
--opendrive-password string Password (obscured)
|
--opendrive-password string Password (obscured)
|
||||||
--opendrive-username string Username
|
--opendrive-username string Username
|
||||||
|
|
@ -547,6 +578,7 @@ rclone [flags]
|
||||||
--pcloud-auth-url string Auth server URL
|
--pcloud-auth-url string Auth server URL
|
||||||
--pcloud-client-id string OAuth Client Id
|
--pcloud-client-id string OAuth Client Id
|
||||||
--pcloud-client-secret string OAuth Client Secret
|
--pcloud-client-secret string OAuth Client Secret
|
||||||
|
--pcloud-description string Description of the remote
|
||||||
--pcloud-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
--pcloud-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||||
--pcloud-hostname string Hostname to connect to (default "api.pcloud.com")
|
--pcloud-hostname string Hostname to connect to (default "api.pcloud.com")
|
||||||
--pcloud-password string Your pcloud password (obscured)
|
--pcloud-password string Your pcloud password (obscured)
|
||||||
|
|
@ -557,6 +589,7 @@ rclone [flags]
|
||||||
--pikpak-auth-url string Auth server URL
|
--pikpak-auth-url string Auth server URL
|
||||||
--pikpak-client-id string OAuth Client Id
|
--pikpak-client-id string OAuth Client Id
|
||||||
--pikpak-client-secret string OAuth Client Secret
|
--pikpak-client-secret string OAuth Client Secret
|
||||||
|
--pikpak-description string Description of the remote
|
||||||
--pikpak-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,RightSpace,RightPeriod,InvalidUtf8,Dot)
|
--pikpak-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,RightSpace,RightPeriod,InvalidUtf8,Dot)
|
||||||
--pikpak-hash-memory-limit SizeSuffix Files bigger than this will be cached on disk to calculate hash if required (default 10Mi)
|
--pikpak-hash-memory-limit SizeSuffix Files bigger than this will be cached on disk to calculate hash if required (default 10Mi)
|
||||||
--pikpak-pass string Pikpak password (obscured)
|
--pikpak-pass string Pikpak password (obscured)
|
||||||
|
|
@ -569,6 +602,7 @@ rclone [flags]
|
||||||
--premiumizeme-auth-url string Auth server URL
|
--premiumizeme-auth-url string Auth server URL
|
||||||
--premiumizeme-client-id string OAuth Client Id
|
--premiumizeme-client-id string OAuth Client Id
|
||||||
--premiumizeme-client-secret string OAuth Client Secret
|
--premiumizeme-client-secret string OAuth Client Secret
|
||||||
|
--premiumizeme-description string Description of the remote
|
||||||
--premiumizeme-encoding Encoding The encoding for the backend (default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
--premiumizeme-encoding Encoding The encoding for the backend (default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||||
--premiumizeme-token string OAuth Access Token as a JSON blob
|
--premiumizeme-token string OAuth Access Token as a JSON blob
|
||||||
--premiumizeme-token-url string Token server url
|
--premiumizeme-token-url string Token server url
|
||||||
|
|
@ -576,6 +610,7 @@ rclone [flags]
|
||||||
--progress-terminal-title Show progress on the terminal title (requires -P/--progress)
|
--progress-terminal-title Show progress on the terminal title (requires -P/--progress)
|
||||||
--protondrive-2fa string The 2FA code
|
--protondrive-2fa string The 2FA code
|
||||||
--protondrive-app-version string The app version string (default "macos-drive@1.0.0-alpha.1+rclone")
|
--protondrive-app-version string The app version string (default "macos-drive@1.0.0-alpha.1+rclone")
|
||||||
|
--protondrive-description string Description of the remote
|
||||||
--protondrive-enable-caching Caches the files and folders metadata to reduce API calls (default true)
|
--protondrive-enable-caching Caches the files and folders metadata to reduce API calls (default true)
|
||||||
--protondrive-encoding Encoding The encoding for the backend (default Slash,LeftSpace,RightSpace,InvalidUtf8,Dot)
|
--protondrive-encoding Encoding The encoding for the backend (default Slash,LeftSpace,RightSpace,InvalidUtf8,Dot)
|
||||||
--protondrive-mailbox-password string The mailbox password of your two-password proton account (obscured)
|
--protondrive-mailbox-password string The mailbox password of your two-password proton account (obscured)
|
||||||
|
|
@ -586,12 +621,14 @@ rclone [flags]
|
||||||
--putio-auth-url string Auth server URL
|
--putio-auth-url string Auth server URL
|
||||||
--putio-client-id string OAuth Client Id
|
--putio-client-id string OAuth Client Id
|
||||||
--putio-client-secret string OAuth Client Secret
|
--putio-client-secret string OAuth Client Secret
|
||||||
|
--putio-description string Description of the remote
|
||||||
--putio-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
--putio-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||||
--putio-token string OAuth Access Token as a JSON blob
|
--putio-token string OAuth Access Token as a JSON blob
|
||||||
--putio-token-url string Token server url
|
--putio-token-url string Token server url
|
||||||
--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 4Mi)
|
--qingstor-chunk-size SizeSuffix Chunk size to use for uploading (default 4Mi)
|
||||||
--qingstor-connection-retries int Number of connection retries (default 3)
|
--qingstor-connection-retries int Number of connection retries (default 3)
|
||||||
|
--qingstor-description string Description of the remote
|
||||||
--qingstor-encoding Encoding The encoding for the backend (default Slash,Ctl,InvalidUtf8)
|
--qingstor-encoding Encoding The encoding for the backend (default Slash,Ctl,InvalidUtf8)
|
||||||
--qingstor-endpoint string Enter an endpoint URL to connection QingStor API
|
--qingstor-endpoint string Enter an endpoint URL to connection QingStor API
|
||||||
--qingstor-env-auth Get QingStor credentials from runtime
|
--qingstor-env-auth Get QingStor credentials from runtime
|
||||||
|
|
@ -600,12 +637,14 @@ rclone [flags]
|
||||||
--qingstor-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi)
|
--qingstor-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi)
|
||||||
--qingstor-zone string Zone to connect to
|
--qingstor-zone string Zone to connect to
|
||||||
--quatrix-api-key string API key for accessing Quatrix account
|
--quatrix-api-key string API key for accessing Quatrix account
|
||||||
|
--quatrix-description string Description of the remote
|
||||||
--quatrix-effective-upload-time string Wanted upload time for one chunk (default "4s")
|
--quatrix-effective-upload-time string Wanted upload time for one chunk (default "4s")
|
||||||
--quatrix-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
--quatrix-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||||
--quatrix-hard-delete Delete files permanently rather than putting them into the trash
|
--quatrix-hard-delete Delete files permanently rather than putting them into the trash
|
||||||
--quatrix-host string Host name of Quatrix account
|
--quatrix-host string Host name of Quatrix account
|
||||||
--quatrix-maximal-summary-chunk-size SizeSuffix The maximal summary for all chunks. It should not be less than 'transfers'*'minimal_chunk_size' (default 95.367Mi)
|
--quatrix-maximal-summary-chunk-size SizeSuffix The maximal summary for all chunks. It should not be less than 'transfers'*'minimal_chunk_size' (default 95.367Mi)
|
||||||
--quatrix-minimal-chunk-size SizeSuffix The minimal size for one chunk (default 9.537Mi)
|
--quatrix-minimal-chunk-size SizeSuffix The minimal size for one chunk (default 9.537Mi)
|
||||||
|
--quatrix-skip-project-folders Skip project folders in operations
|
||||||
-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
|
||||||
--rc-addr stringArray IPaddress:Port or :Port to bind server to (default [localhost:5572])
|
--rc-addr stringArray IPaddress:Port or :Port to bind server to (default [localhost:5572])
|
||||||
|
|
@ -644,6 +683,7 @@ rclone [flags]
|
||||||
--s3-chunk-size SizeSuffix Chunk size to use for uploading (default 5Mi)
|
--s3-chunk-size SizeSuffix Chunk size to use for uploading (default 5Mi)
|
||||||
--s3-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656Gi)
|
--s3-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656Gi)
|
||||||
--s3-decompress If set this will decompress gzip encoded objects
|
--s3-decompress If set this will decompress gzip encoded objects
|
||||||
|
--s3-description string Description of the remote
|
||||||
--s3-directory-markers Upload an empty object with a trailing slash when a new directory is created
|
--s3-directory-markers Upload an empty object with a trailing slash when a new directory is created
|
||||||
--s3-disable-checksum Don't store MD5 checksum with object metadata
|
--s3-disable-checksum Don't store MD5 checksum with object metadata
|
||||||
--s3-disable-http2 Disable usage of http2 for S3 backends
|
--s3-disable-http2 Disable usage of http2 for S3 backends
|
||||||
|
|
@ -678,19 +718,22 @@ rclone [flags]
|
||||||
--s3-sse-kms-key-id string If using KMS ID you must provide the ARN of Key
|
--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-storage-class string The storage class to use when storing new objects in S3
|
||||||
--s3-sts-endpoint string Endpoint for STS
|
--s3-sts-endpoint string Endpoint for STS
|
||||||
--s3-upload-concurrency int Concurrency for multipart uploads (default 4)
|
--s3-upload-concurrency int Concurrency for multipart uploads and copies (default 4)
|
||||||
--s3-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi)
|
--s3-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi)
|
||||||
--s3-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint
|
--s3-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint
|
||||||
--s3-use-accept-encoding-gzip Accept-Encoding: gzip Whether to send Accept-Encoding: gzip header (default unset)
|
--s3-use-accept-encoding-gzip Accept-Encoding: gzip Whether to send Accept-Encoding: gzip header (default unset)
|
||||||
--s3-use-already-exists Tristate Set if rclone should report BucketAlreadyExists errors on bucket creation (default unset)
|
--s3-use-already-exists Tristate Set if rclone should report BucketAlreadyExists errors on bucket creation (default unset)
|
||||||
|
--s3-use-dual-stack If true use AWS S3 dual-stack endpoint (IPv6 support)
|
||||||
--s3-use-multipart-etag Tristate Whether to use ETag in multipart uploads for verification (default unset)
|
--s3-use-multipart-etag Tristate Whether to use ETag in multipart uploads for verification (default unset)
|
||||||
--s3-use-multipart-uploads Tristate Set if rclone should use multipart uploads (default unset)
|
--s3-use-multipart-uploads Tristate Set if rclone should use multipart uploads (default unset)
|
||||||
--s3-use-presigned-request Whether to use a presigned request or PutObject for single part uploads
|
--s3-use-presigned-request Whether to use a presigned request or PutObject for single part uploads
|
||||||
--s3-v2-auth If true use v2 authentication
|
--s3-v2-auth If true use v2 authentication
|
||||||
--s3-version-at Time Show file versions as they were at the specified time (default off)
|
--s3-version-at Time Show file versions as they were at the specified time (default off)
|
||||||
|
--s3-version-deleted Show deleted file markers when using versions
|
||||||
--s3-versions Include old versions in directory listings
|
--s3-versions Include old versions in directory listings
|
||||||
--seafile-2fa Two-factor authentication ('true' if the account has 2FA enabled)
|
--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
|
--seafile-create-library Should rclone create a library if it doesn't exist
|
||||||
|
--seafile-description string Description of the remote
|
||||||
--seafile-encoding Encoding The encoding for the backend (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8)
|
--seafile-encoding Encoding The encoding for the backend (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8)
|
||||||
--seafile-library string Name of the library
|
--seafile-library string Name of the library
|
||||||
--seafile-library-key string Library password (for encrypted libraries only) (obscured)
|
--seafile-library-key string Library password (for encrypted libraries only) (obscured)
|
||||||
|
|
@ -703,6 +746,7 @@ rclone [flags]
|
||||||
--sftp-ciphers SpaceSepList Space separated list of ciphers to be used for session encryption, ordered by preference
|
--sftp-ciphers SpaceSepList Space separated list of ciphers to be used for session encryption, ordered by preference
|
||||||
--sftp-concurrency int The maximum number of outstanding requests for one file (default 64)
|
--sftp-concurrency int The maximum number of outstanding requests for one file (default 64)
|
||||||
--sftp-copy-is-hardlink Set to enable server side copies using hardlinks
|
--sftp-copy-is-hardlink Set to enable server side copies using hardlinks
|
||||||
|
--sftp-description string Description of the remote
|
||||||
--sftp-disable-concurrent-reads If set don't use concurrent reads
|
--sftp-disable-concurrent-reads If set don't use concurrent reads
|
||||||
--sftp-disable-concurrent-writes If set don't use concurrent writes
|
--sftp-disable-concurrent-writes If set don't use concurrent writes
|
||||||
--sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available
|
--sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available
|
||||||
|
|
@ -737,6 +781,7 @@ rclone [flags]
|
||||||
--sharefile-chunk-size SizeSuffix Upload chunk size (default 64Mi)
|
--sharefile-chunk-size SizeSuffix Upload chunk size (default 64Mi)
|
||||||
--sharefile-client-id string OAuth Client Id
|
--sharefile-client-id string OAuth Client Id
|
||||||
--sharefile-client-secret string OAuth Client Secret
|
--sharefile-client-secret string OAuth Client Secret
|
||||||
|
--sharefile-description string Description of the remote
|
||||||
--sharefile-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot)
|
--sharefile-encoding Encoding 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
|
||||||
|
|
@ -745,11 +790,13 @@ rclone [flags]
|
||||||
--sharefile-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (default 128Mi)
|
--sharefile-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (default 128Mi)
|
||||||
--sia-api-password string Sia Daemon API Password (obscured)
|
--sia-api-password string Sia Daemon API Password (obscured)
|
||||||
--sia-api-url string Sia daemon API URL, like http://sia.daemon.host:9980 (default "http://127.0.0.1:9980")
|
--sia-api-url string Sia daemon API URL, like http://sia.daemon.host:9980 (default "http://127.0.0.1:9980")
|
||||||
|
--sia-description string Description of the remote
|
||||||
--sia-encoding Encoding The encoding for the backend (default Slash,Question,Hash,Percent,Del,Ctl,InvalidUtf8,Dot)
|
--sia-encoding Encoding The encoding for the backend (default Slash,Question,Hash,Percent,Del,Ctl,InvalidUtf8,Dot)
|
||||||
--sia-user-agent string Siad User Agent (default "Sia-Agent")
|
--sia-user-agent string Siad User Agent (default "Sia-Agent")
|
||||||
--size-only Skip based on size only, not modtime or checksum
|
--size-only Skip based on size only, not modtime or checksum
|
||||||
--skip-links Don't warn about skipped symlinks
|
--skip-links Don't warn about skipped symlinks
|
||||||
--smb-case-insensitive Whether the server is configured to be case-insensitive (default true)
|
--smb-case-insensitive Whether the server is configured to be case-insensitive (default true)
|
||||||
|
--smb-description string Description of the remote
|
||||||
--smb-domain string Domain name for NTLM authentication (default "WORKGROUP")
|
--smb-domain string Domain name for NTLM authentication (default "WORKGROUP")
|
||||||
--smb-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot)
|
--smb-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot)
|
||||||
--smb-hide-special-share Hide special shares (e.g. print$) which users aren't supposed to access (default true)
|
--smb-hide-special-share Hide special shares (e.g. print$) which users aren't supposed to access (default true)
|
||||||
|
|
@ -768,6 +815,7 @@ rclone [flags]
|
||||||
--stats-unit string Show data rate in stats as either 'bits' or 'bytes' per second (default "bytes")
|
--stats-unit string Show data rate in stats as either 'bits' or 'bytes' per second (default "bytes")
|
||||||
--storj-access-grant string Access grant
|
--storj-access-grant string Access grant
|
||||||
--storj-api-key string API key
|
--storj-api-key string API key
|
||||||
|
--storj-description string Description of the remote
|
||||||
--storj-passphrase string Encryption passphrase
|
--storj-passphrase string Encryption passphrase
|
||||||
--storj-provider string Choose an authentication method (default "existing")
|
--storj-provider string Choose an authentication method (default "existing")
|
||||||
--storj-satellite-address string Satellite address (default "us1.storj.io")
|
--storj-satellite-address string Satellite address (default "us1.storj.io")
|
||||||
|
|
@ -779,6 +827,7 @@ rclone [flags]
|
||||||
--sugarsync-authorization string Sugarsync authorization
|
--sugarsync-authorization string Sugarsync authorization
|
||||||
--sugarsync-authorization-expiry string Sugarsync authorization expiry
|
--sugarsync-authorization-expiry string Sugarsync authorization expiry
|
||||||
--sugarsync-deleted-id string Sugarsync deleted folder id
|
--sugarsync-deleted-id string Sugarsync deleted folder id
|
||||||
|
--sugarsync-description string Description of the remote
|
||||||
--sugarsync-encoding Encoding The encoding for the backend (default Slash,Ctl,InvalidUtf8,Dot)
|
--sugarsync-encoding Encoding The encoding for the backend (default Slash,Ctl,InvalidUtf8,Dot)
|
||||||
--sugarsync-hard-delete Permanently delete files if true
|
--sugarsync-hard-delete Permanently delete files if true
|
||||||
--sugarsync-private-access-key string Sugarsync Private Access Key
|
--sugarsync-private-access-key string Sugarsync Private Access Key
|
||||||
|
|
@ -792,6 +841,7 @@ rclone [flags]
|
||||||
--swift-auth-token string Auth Token from alternate authentication - optional (OS_AUTH_TOKEN)
|
--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-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 5Gi)
|
--swift-chunk-size SizeSuffix Above this size files will be chunked into a _segments container (default 5Gi)
|
||||||
|
--swift-description string Description of the remote
|
||||||
--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 Encoding The encoding for the backend (default Slash,InvalidUtf8)
|
--swift-encoding Encoding 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")
|
||||||
|
|
@ -820,25 +870,29 @@ rclone [flags]
|
||||||
--union-action-policy string Policy to choose upstream on ACTION category (default "epall")
|
--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) (default 120)
|
--union-cache-time int Cache time of usage and free space (in seconds) (default 120)
|
||||||
--union-create-policy string Policy to choose upstream on CREATE category (default "epmfs")
|
--union-create-policy string Policy to choose upstream on CREATE category (default "epmfs")
|
||||||
|
--union-description string Description of the remote
|
||||||
--union-min-free-space SizeSuffix Minimum viable free space for lfs/eplfs policies (default 1Gi)
|
--union-min-free-space SizeSuffix Minimum viable free space for lfs/eplfs policies (default 1Gi)
|
||||||
--union-search-policy string Policy to choose upstream on SEARCH category (default "ff")
|
--union-search-policy string Policy to choose upstream on SEARCH category (default "ff")
|
||||||
--union-upstreams string List of space separated upstreams
|
--union-upstreams string List of space separated upstreams
|
||||||
-u, --update Skip files that are newer on the destination
|
-u, --update Skip files that are newer on the destination
|
||||||
--uptobox-access-token string Your access token
|
--uptobox-access-token string Your access token
|
||||||
|
--uptobox-description string Description of the remote
|
||||||
--uptobox-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,BackQuote,Del,Ctl,LeftSpace,InvalidUtf8,Dot)
|
--uptobox-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,BackQuote,Del,Ctl,LeftSpace,InvalidUtf8,Dot)
|
||||||
--uptobox-private Set to make uploaded files private
|
--uptobox-private Set to make uploaded files private
|
||||||
--use-cookies Enable session cookiejar
|
--use-cookies Enable session cookiejar
|
||||||
--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 (default "rclone/v1.65.0")
|
--user-agent string Set the user-agent to a specified string (default "rclone/v1.66.0")
|
||||||
-v, --verbose count Print lots more stuff (repeat for more)
|
-v, --verbose count Print lots more stuff (repeat for more)
|
||||||
-V, --version Print the version number
|
-V, --version Print the version number
|
||||||
--webdav-bearer-token string Bearer token instead of user/pass (e.g. a Macaroon)
|
--webdav-bearer-token string Bearer token instead of user/pass (e.g. a Macaroon)
|
||||||
--webdav-bearer-token-command string Command to run to get a bearer token
|
--webdav-bearer-token-command string Command to run to get a bearer token
|
||||||
|
--webdav-description string Description of the remote
|
||||||
--webdav-encoding string The encoding for the backend
|
--webdav-encoding string The encoding for the backend
|
||||||
--webdav-headers CommaSepList Set HTTP headers for all transactions
|
--webdav-headers CommaSepList Set HTTP headers for all transactions
|
||||||
--webdav-nextcloud-chunk-size SizeSuffix Nextcloud upload chunk size (default 10Mi)
|
--webdav-nextcloud-chunk-size SizeSuffix Nextcloud upload chunk size (default 10Mi)
|
||||||
|
--webdav-owncloud-exclude-shares Exclude ownCloud shares
|
||||||
--webdav-pacer-min-sleep Duration Minimum time to sleep between API calls (default 10ms)
|
--webdav-pacer-min-sleep Duration Minimum time to sleep between API calls (default 10ms)
|
||||||
--webdav-pass string Password (obscured)
|
--webdav-pass string Password (obscured)
|
||||||
--webdav-url string URL of http host to connect to
|
--webdav-url string URL of http host to connect to
|
||||||
|
|
@ -847,6 +901,7 @@ rclone [flags]
|
||||||
--yandex-auth-url string Auth server URL
|
--yandex-auth-url string Auth server URL
|
||||||
--yandex-client-id string OAuth Client Id
|
--yandex-client-id string OAuth Client Id
|
||||||
--yandex-client-secret string OAuth Client Secret
|
--yandex-client-secret string OAuth Client Secret
|
||||||
|
--yandex-description string Description of the remote
|
||||||
--yandex-encoding Encoding The encoding for the backend (default Slash,Del,Ctl,InvalidUtf8,Dot)
|
--yandex-encoding Encoding The encoding for the backend (default Slash,Del,Ctl,InvalidUtf8,Dot)
|
||||||
--yandex-hard-delete Delete files permanently rather than putting them into the trash
|
--yandex-hard-delete Delete files permanently rather than putting them into the trash
|
||||||
--yandex-token string OAuth Access Token as a JSON blob
|
--yandex-token string OAuth Access Token as a JSON blob
|
||||||
|
|
@ -854,6 +909,7 @@ rclone [flags]
|
||||||
--zoho-auth-url string Auth server URL
|
--zoho-auth-url string Auth server URL
|
||||||
--zoho-client-id string OAuth Client Id
|
--zoho-client-id string OAuth Client Id
|
||||||
--zoho-client-secret string OAuth Client Secret
|
--zoho-client-secret string OAuth Client Secret
|
||||||
|
--zoho-description string Description of the remote
|
||||||
--zoho-encoding Encoding The encoding for the backend (default Del,Ctl,InvalidUtf8)
|
--zoho-encoding Encoding The encoding for the backend (default Del,Ctl,InvalidUtf8)
|
||||||
--zoho-region string Zoho region to connect to
|
--zoho-region string Zoho region to connect to
|
||||||
--zoho-token string OAuth Access Token as a JSON blob
|
--zoho-token string OAuth Access Token as a JSON blob
|
||||||
|
|
@ -874,7 +930,7 @@ rclone [flags]
|
||||||
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.
|
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.
|
||||||
* [rclone copy](/commands/rclone_copy/) - Copy files from source to dest, skipping identical files.
|
* [rclone copy](/commands/rclone_copy/) - Copy files from source to dest, skipping identical files.
|
||||||
* [rclone copyto](/commands/rclone_copyto/) - Copy files from source to dest, skipping identical files.
|
* [rclone copyto](/commands/rclone_copyto/) - Copy files from source to dest, skipping identical files.
|
||||||
* [rclone copyurl](/commands/rclone_copyurl/) - Copy url content to dest.
|
* [rclone copyurl](/commands/rclone_copyurl/) - Copy the contents of the URL supplied content to dest:path.
|
||||||
* [rclone cryptcheck](/commands/rclone_cryptcheck/) - Cryptcheck checks the integrity of an encrypted remote.
|
* [rclone cryptcheck](/commands/rclone_cryptcheck/) - Cryptcheck checks the integrity of an encrypted remote.
|
||||||
* [rclone cryptdecode](/commands/rclone_cryptdecode/) - Cryptdecode returns unencrypted file names.
|
* [rclone cryptdecode](/commands/rclone_cryptdecode/) - Cryptdecode returns unencrypted file names.
|
||||||
* [rclone dedupe](/commands/rclone_dedupe/) - Interactively find duplicate filenames and delete/rename them.
|
* [rclone dedupe](/commands/rclone_dedupe/) - Interactively find duplicate filenames and delete/rename them.
|
||||||
|
|
@ -895,6 +951,7 @@ rclone [flags]
|
||||||
* [rclone move](/commands/rclone_move/) - Move files from source to dest.
|
* [rclone move](/commands/rclone_move/) - Move files from source to dest.
|
||||||
* [rclone moveto](/commands/rclone_moveto/) - Move file or directory from source to dest.
|
* [rclone moveto](/commands/rclone_moveto/) - Move file or directory from source to dest.
|
||||||
* [rclone ncdu](/commands/rclone_ncdu/) - Explore a remote with a text based user interface.
|
* [rclone ncdu](/commands/rclone_ncdu/) - Explore a remote with a text based user interface.
|
||||||
|
* [rclone nfsmount](/commands/rclone_nfsmount/) - Mount the remote as file system on a mountpoint.
|
||||||
* [rclone obscure](/commands/rclone_obscure/) - Obscure password for use in the rclone config file.
|
* [rclone obscure](/commands/rclone_obscure/) - Obscure password for use in the rclone config file.
|
||||||
* [rclone purge](/commands/rclone_purge/) - Remove the path and all of its contents.
|
* [rclone purge](/commands/rclone_purge/) - Remove the path and all of its contents.
|
||||||
* [rclone rc](/commands/rclone_rc/) - Run a command against a running rclone.
|
* [rclone rc](/commands/rclone_rc/) - Run a command against a running rclone.
|
||||||
|
|
|
||||||
|
|
@ -4,6 +4,7 @@ description: "Perform bidirectional synchronization between two paths."
|
||||||
slug: rclone_bisync
|
slug: rclone_bisync
|
||||||
url: /commands/rclone_bisync/
|
url: /commands/rclone_bisync/
|
||||||
groups: Filter,Copy,Important
|
groups: Filter,Copy,Important
|
||||||
|
status: Beta
|
||||||
versionIntroduced: v1.58
|
versionIntroduced: v1.58
|
||||||
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/bisync/ and as part of making a release run "make commanddocs"
|
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/bisync/ and as part of making a release run "make commanddocs"
|
||||||
---
|
---
|
||||||
|
|
@ -23,6 +24,11 @@ On each successive run it will:
|
||||||
Changes include `New`, `Newer`, `Older`, and `Deleted` files.
|
Changes include `New`, `Newer`, `Older`, and `Deleted` files.
|
||||||
- Propagate changes on Path1 to Path2, and vice-versa.
|
- Propagate changes on Path1 to Path2, and vice-versa.
|
||||||
|
|
||||||
|
Bisync is **in beta** and is considered an **advanced command**, so use with care.
|
||||||
|
Make sure you have read and understood the entire [manual](https://rclone.org/bisync)
|
||||||
|
(especially the [Limitations](https://rclone.org/bisync/#limitations) section) before using,
|
||||||
|
or data loss can result. Questions can be asked in the [Rclone Forum](https://forum.rclone.org/).
|
||||||
|
|
||||||
See [full bisync description](https://rclone.org/bisync/) for details.
|
See [full bisync description](https://rclone.org/bisync/) for details.
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -33,20 +39,31 @@ rclone bisync remote1:path1 remote2:path2 [flags]
|
||||||
## Options
|
## Options
|
||||||
|
|
||||||
```
|
```
|
||||||
|
--backup-dir1 string --backup-dir for Path1. Must be a non-overlapping path on the same remote.
|
||||||
|
--backup-dir2 string --backup-dir for Path2. Must be a non-overlapping path on the same remote.
|
||||||
--check-access Ensure expected RCLONE_TEST files are found on both Path1 and Path2 filesystems, else abort.
|
--check-access Ensure expected RCLONE_TEST files are found on both Path1 and Path2 filesystems, else abort.
|
||||||
--check-filename string Filename for --check-access (default: RCLONE_TEST)
|
--check-filename string Filename for --check-access (default: RCLONE_TEST)
|
||||||
--check-sync string Controls comparison of final listings: true|false|only (default: true) (default "true")
|
--check-sync string Controls comparison of final listings: true|false|only (default: true) (default "true")
|
||||||
|
--compare string Comma-separated list of bisync-specific compare options ex. 'size,modtime,checksum' (default: 'size,modtime')
|
||||||
|
--conflict-loser ConflictLoserAction Action to take on the loser of a sync conflict (when there is a winner) or on both files (when there is no winner): , num, pathname, delete (default: num)
|
||||||
|
--conflict-resolve string Automatically resolve conflicts by preferring the version that is: none, path1, path2, newer, older, larger, smaller (default: none) (default "none")
|
||||||
|
--conflict-suffix string Suffix to use when renaming a --conflict-loser. Can be either one string or two comma-separated strings to assign different suffixes to Path1/Path2. (default: 'conflict')
|
||||||
--create-empty-src-dirs Sync creation and deletion of empty directories. (Not compatible with --remove-empty-dirs)
|
--create-empty-src-dirs Sync creation and deletion of empty directories. (Not compatible with --remove-empty-dirs)
|
||||||
|
--download-hash Compute hash by downloading when otherwise unavailable. (warning: may be slow and use lots of data!)
|
||||||
--filters-file string Read filtering patterns from a file
|
--filters-file string Read filtering patterns from a file
|
||||||
--force Bypass --max-delete safety check and run the sync. Consider using with --verbose
|
--force Bypass --max-delete safety check and run the sync. Consider using with --verbose
|
||||||
-h, --help help for bisync
|
-h, --help help for bisync
|
||||||
--ignore-listing-checksum Do not use checksums for listings (add --ignore-checksum to additionally skip post-copy checksum checks)
|
--ignore-listing-checksum Do not use checksums for listings (add --ignore-checksum to additionally skip post-copy checksum checks)
|
||||||
--localtime Use local time in listings (default: UTC)
|
--max-lock Duration Consider lock files older than this to be expired (default: 0 (never expire)) (minimum: 2m) (default 0s)
|
||||||
--no-cleanup Retain working files (useful for troubleshooting and testing).
|
--no-cleanup Retain working files (useful for troubleshooting and testing).
|
||||||
|
--no-slow-hash Ignore listing checksums only on backends where they are slow
|
||||||
|
--recover Automatically recover from interruptions without requiring --resync.
|
||||||
--remove-empty-dirs Remove ALL empty directories at the final cleanup step.
|
--remove-empty-dirs Remove ALL empty directories at the final cleanup step.
|
||||||
--resilient Allow future runs to retry after certain less-serious errors, instead of requiring --resync. Use at your own risk!
|
--resilient Allow future runs to retry after certain less-serious errors, instead of requiring --resync. Use at your own risk!
|
||||||
-1, --resync Performs the resync run. Path1 files may overwrite Path2 versions. Consider using --verbose or --dry-run first.
|
-1, --resync Performs the resync run. Equivalent to --resync-mode path1. Consider using --verbose or --dry-run first.
|
||||||
--workdir string Use custom working dir - useful for testing. (default: $HOME/.cache/rclone/bisync)
|
--resync-mode string During resync, prefer the version that is: path1, path2, newer, older, larger, smaller (default: path1 if --resync, otherwise none for no resync.) (default "none")
|
||||||
|
--slow-hash-sync-only Ignore slow checksums for listings and deltas, but still consider them during sync calls.
|
||||||
|
--workdir string Use custom working dir - useful for testing. (default: {WORKDIR})
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -64,7 +81,7 @@ Flags for anything which can Copy a file.
|
||||||
--ignore-checksum Skip post copy check of checksums
|
--ignore-checksum Skip post copy check of checksums
|
||||||
--ignore-existing Skip all files that exist on destination
|
--ignore-existing Skip all files that exist on destination
|
||||||
--ignore-size Ignore size when skipping use modtime or checksum
|
--ignore-size Ignore size when skipping use modtime or checksum
|
||||||
-I, --ignore-times Don't skip files that match size and time - transfer all files
|
-I, --ignore-times Don't skip items that match size and time - transfer all unconditionally
|
||||||
--immutable Do not modify files, fail if existing files have been modified
|
--immutable Do not modify files, fail if existing files have been modified
|
||||||
--inplace Download directly to destination file instead of atomic download to temp/rename
|
--inplace Download directly to destination file instead of atomic download to temp/rename
|
||||||
--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)
|
||||||
|
|
@ -78,6 +95,7 @@ Flags for anything which can Copy a file.
|
||||||
--multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki)
|
--multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki)
|
||||||
--no-check-dest Don't check the destination, copy regardless
|
--no-check-dest Don't check the destination, copy regardless
|
||||||
--no-traverse Don't traverse destination file system on copy
|
--no-traverse Don't traverse destination file system on copy
|
||||||
|
--no-update-dir-modtime Don't update directory modification times
|
||||||
--no-update-modtime Don't update destination modtime if files identical
|
--no-update-modtime Don't update destination modtime if files identical
|
||||||
--order-by string Instructions on how to order the transfers, e.g. 'size,descending'
|
--order-by string Instructions on how to order the transfers, e.g. 'size,descending'
|
||||||
--partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial")
|
--partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial")
|
||||||
|
|
|
||||||
|
|
@ -65,6 +65,15 @@ recently very efficiently like this:
|
||||||
|
|
||||||
rclone copy --max-age 24h --no-traverse /path/to/src remote:
|
rclone copy --max-age 24h --no-traverse /path/to/src remote:
|
||||||
|
|
||||||
|
|
||||||
|
Rclone will sync the modification times of files and directories if
|
||||||
|
the backend supports it. If metadata syncing is required then use the
|
||||||
|
`--metadata` flag.
|
||||||
|
|
||||||
|
Note that the modification time and metadata for the root directory
|
||||||
|
will **not** be synced. See https://github.com/rclone/rclone/issues/7652
|
||||||
|
for more info.
|
||||||
|
|
||||||
**Note**: Use the `-P`/`--progress` flag to view real-time transfer statistics.
|
**Note**: Use the `-P`/`--progress` flag to view real-time transfer statistics.
|
||||||
|
|
||||||
**Note**: Use the `--dry-run` or the `--interactive`/`-i` flag to test without copying anything.
|
**Note**: Use the `--dry-run` or the `--interactive`/`-i` flag to test without copying anything.
|
||||||
|
|
@ -96,7 +105,7 @@ Flags for anything which can Copy a file.
|
||||||
--ignore-checksum Skip post copy check of checksums
|
--ignore-checksum Skip post copy check of checksums
|
||||||
--ignore-existing Skip all files that exist on destination
|
--ignore-existing Skip all files that exist on destination
|
||||||
--ignore-size Ignore size when skipping use modtime or checksum
|
--ignore-size Ignore size when skipping use modtime or checksum
|
||||||
-I, --ignore-times Don't skip files that match size and time - transfer all files
|
-I, --ignore-times Don't skip items that match size and time - transfer all unconditionally
|
||||||
--immutable Do not modify files, fail if existing files have been modified
|
--immutable Do not modify files, fail if existing files have been modified
|
||||||
--inplace Download directly to destination file instead of atomic download to temp/rename
|
--inplace Download directly to destination file instead of atomic download to temp/rename
|
||||||
--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)
|
||||||
|
|
@ -110,6 +119,7 @@ Flags for anything which can Copy a file.
|
||||||
--multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki)
|
--multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki)
|
||||||
--no-check-dest Don't check the destination, copy regardless
|
--no-check-dest Don't check the destination, copy regardless
|
||||||
--no-traverse Don't traverse destination file system on copy
|
--no-traverse Don't traverse destination file system on copy
|
||||||
|
--no-update-dir-modtime Don't update directory modification times
|
||||||
--no-update-modtime Don't update destination modtime if files identical
|
--no-update-modtime Don't update destination modtime if files identical
|
||||||
--order-by string Instructions on how to order the transfers, e.g. 'size,descending'
|
--order-by string Instructions on how to order the transfers, e.g. 'size,descending'
|
||||||
--partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial")
|
--partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial")
|
||||||
|
|
|
||||||
|
|
@ -68,7 +68,7 @@ Flags for anything which can Copy a file.
|
||||||
--ignore-checksum Skip post copy check of checksums
|
--ignore-checksum Skip post copy check of checksums
|
||||||
--ignore-existing Skip all files that exist on destination
|
--ignore-existing Skip all files that exist on destination
|
||||||
--ignore-size Ignore size when skipping use modtime or checksum
|
--ignore-size Ignore size when skipping use modtime or checksum
|
||||||
-I, --ignore-times Don't skip files that match size and time - transfer all files
|
-I, --ignore-times Don't skip items that match size and time - transfer all unconditionally
|
||||||
--immutable Do not modify files, fail if existing files have been modified
|
--immutable Do not modify files, fail if existing files have been modified
|
||||||
--inplace Download directly to destination file instead of atomic download to temp/rename
|
--inplace Download directly to destination file instead of atomic download to temp/rename
|
||||||
--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)
|
||||||
|
|
@ -82,6 +82,7 @@ Flags for anything which can Copy a file.
|
||||||
--multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki)
|
--multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki)
|
||||||
--no-check-dest Don't check the destination, copy regardless
|
--no-check-dest Don't check the destination, copy regardless
|
||||||
--no-traverse Don't traverse destination file system on copy
|
--no-traverse Don't traverse destination file system on copy
|
||||||
|
--no-update-dir-modtime Don't update directory modification times
|
||||||
--no-update-modtime Don't update destination modtime if files identical
|
--no-update-modtime Don't update destination modtime if files identical
|
||||||
--order-by string Instructions on how to order the transfers, e.g. 'size,descending'
|
--order-by string Instructions on how to order the transfers, e.g. 'size,descending'
|
||||||
--partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial")
|
--partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial")
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
---
|
---
|
||||||
title: "rclone copyurl"
|
title: "rclone copyurl"
|
||||||
description: "Copy url content to dest."
|
description: "Copy the contents of the URL supplied content to dest:path."
|
||||||
slug: rclone_copyurl
|
slug: rclone_copyurl
|
||||||
url: /commands/rclone_copyurl/
|
url: /commands/rclone_copyurl/
|
||||||
groups: Important
|
groups: Important
|
||||||
|
|
@ -9,7 +9,7 @@ versionIntroduced: v1.43
|
||||||
---
|
---
|
||||||
# rclone copyurl
|
# rclone copyurl
|
||||||
|
|
||||||
Copy url content to dest.
|
Copy the contents of the URL supplied content to dest:path.
|
||||||
|
|
||||||
## Synopsis
|
## Synopsis
|
||||||
|
|
||||||
|
|
@ -17,11 +17,14 @@ Copy url content to dest.
|
||||||
Download a URL's content and copy it to the destination without saving
|
Download a URL's content and copy it to the destination without saving
|
||||||
it in temporary storage.
|
it in temporary storage.
|
||||||
|
|
||||||
Setting `--auto-filename` will attempt to automatically determine the filename from the URL
|
Setting `--auto-filename` will attempt to automatically determine the
|
||||||
(after any redirections) and used in the destination path.
|
filename from the URL (after any redirections) and used in the
|
||||||
With `--auto-filename-header` in
|
destination path.
|
||||||
addition, if a specific filename is set in HTTP headers, it will be used instead of the name from the URL.
|
|
||||||
With `--print-filename` in addition, the resulting file name will be printed.
|
With `--auto-filename-header` in addition, if a specific filename is
|
||||||
|
set in HTTP headers, it will be used instead of the name from the URL.
|
||||||
|
With `--print-filename` in addition, the resulting file name will be
|
||||||
|
printed.
|
||||||
|
|
||||||
Setting `--no-clobber` will prevent overwriting file on the
|
Setting `--no-clobber` will prevent overwriting file on the
|
||||||
destination if there is one with the same name.
|
destination if there is one with the same name.
|
||||||
|
|
@ -29,6 +32,17 @@ destination if there is one with the same name.
|
||||||
Setting `--stdout` or making the output file name `-`
|
Setting `--stdout` or making the output file name `-`
|
||||||
will cause the output to be written to standard output.
|
will cause the output to be written to standard output.
|
||||||
|
|
||||||
|
## Troublshooting
|
||||||
|
|
||||||
|
If you can't get `rclone copyurl` to work then here are some things you can try:
|
||||||
|
|
||||||
|
- `--disable-http2` rclone will use HTTP2 if available - try disabling it
|
||||||
|
- `--bind 0.0.0.0` rclone will use IPv6 if available - try disabling it
|
||||||
|
- `--bind ::0` to disable IPv4
|
||||||
|
- `--user agent curl` - some sites have whitelists for curl's user-agent - try that
|
||||||
|
- Make sure the site works with `curl` directly
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
```
|
```
|
||||||
rclone copyurl https://example.com dest:path [flags]
|
rclone copyurl https://example.com dest:path [flags]
|
||||||
|
|
|
||||||
|
|
@ -15,7 +15,7 @@ List all the remotes in the config file and defined in environment variables.
|
||||||
|
|
||||||
rclone listremotes lists all the available remotes from the config file.
|
rclone listremotes lists all the available remotes from the config file.
|
||||||
|
|
||||||
When used with the `--long` flag it lists the types too.
|
When used with the `--long` flag it lists the types and the descriptions too.
|
||||||
|
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
@ -26,7 +26,7 @@ rclone listremotes [flags]
|
||||||
|
|
||||||
```
|
```
|
||||||
-h, --help help for listremotes
|
-h, --help help for listremotes
|
||||||
--long Show the type as well as names
|
--long Show the type and the description as well as names
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -109,6 +109,19 @@ those only (without traversing the whole directory structure):
|
||||||
rclone lsf --absolute --files-only --max-age 1d /path/to/local > new_files
|
rclone lsf --absolute --files-only --max-age 1d /path/to/local > new_files
|
||||||
rclone copy --files-from-raw new_files /path/to/local remote:path
|
rclone copy --files-from-raw new_files /path/to/local remote:path
|
||||||
|
|
||||||
|
The default time format is `'2006-01-02 15:04:05'`.
|
||||||
|
[Other formats](https://pkg.go.dev/time#pkg-constants) can be specified with the `--time-format` flag.
|
||||||
|
Examples:
|
||||||
|
|
||||||
|
rclone lsf remote:path --format pt --time-format 'Jan 2, 2006 at 3:04pm (MST)'
|
||||||
|
rclone lsf remote:path --format pt --time-format '2006-01-02 15:04:05.000000000'
|
||||||
|
rclone lsf remote:path --format pt --time-format '2006-01-02T15:04:05.999999999Z07:00'
|
||||||
|
rclone lsf remote:path --format pt --time-format RFC3339
|
||||||
|
rclone lsf remote:path --format pt --time-format DateOnly
|
||||||
|
rclone lsf remote:path --format pt --time-format max
|
||||||
|
`--time-format max` will automatically truncate '`2006-01-02 15:04:05.000000000`'
|
||||||
|
to the maximum precision supported by the remote.
|
||||||
|
|
||||||
|
|
||||||
Any of the filtering options can be applied to this command.
|
Any of the filtering options can be applied to this command.
|
||||||
|
|
||||||
|
|
@ -150,6 +163,7 @@ rclone lsf remote:path [flags]
|
||||||
-h, --help help for lsf
|
-h, --help help for lsf
|
||||||
-R, --recursive Recurse into the listing
|
-R, --recursive Recurse into the listing
|
||||||
-s, --separator string Separator for the items in the format (default ";")
|
-s, --separator string Separator for the items in the format (default ";")
|
||||||
|
-t, --time-format string Specify a custom time format, or 'max' for max precision supported by remote (default: 2006-01-02 15:04:05)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -272,12 +272,21 @@ Mounting on macOS can be done either via [built-in NFS server](/commands/rclone_
|
||||||
FUSE driver utilizing a macOS kernel extension (kext). FUSE-T is an alternative FUSE system
|
FUSE driver utilizing a macOS kernel extension (kext). FUSE-T is an alternative FUSE system
|
||||||
which "mounts" via an NFSv4 local server.
|
which "mounts" via an NFSv4 local server.
|
||||||
|
|
||||||
# NFS mount
|
#### Unicode Normalization
|
||||||
|
|
||||||
|
It is highly recommended to keep the default of `--no-unicode-normalization=false`
|
||||||
|
for all `mount` and `serve` commands on macOS. For details, see [vfs-case-sensitivity](https://rclone.org/commands/rclone_mount/#vfs-case-sensitivity).
|
||||||
|
|
||||||
|
### NFS mount
|
||||||
|
|
||||||
This method spins up an NFS server using [serve nfs](/commands/rclone_serve_nfs/) command and mounts
|
This method spins up an NFS server using [serve nfs](/commands/rclone_serve_nfs/) command and mounts
|
||||||
it to the specified mountpoint. If you run this in background mode using |--daemon|, you will need to
|
it to the specified mountpoint. If you run this in background mode using |--daemon|, you will need to
|
||||||
send SIGTERM signal to the rclone process using |kill| command to stop the mount.
|
send SIGTERM signal to the rclone process using |kill| command to stop the mount.
|
||||||
|
|
||||||
|
Note that `--nfs-cache-handle-limit` controls the maximum number of cached file handles stored by the `nfsmount` caching handler.
|
||||||
|
This should not be set too low or you may experience errors when trying to access files. The default is 1000000,
|
||||||
|
but consider lowering this limit if the server's system resource usage causes problems.
|
||||||
|
|
||||||
### macFUSE Notes
|
### macFUSE Notes
|
||||||
|
|
||||||
If installing macFUSE using [dmg packages](https://github.com/osxfuse/osxfuse/releases) from
|
If installing macFUSE using [dmg packages](https://github.com/osxfuse/osxfuse/releases) from
|
||||||
|
|
@ -306,15 +315,6 @@ This means that viewing files with various tools, notably macOS Finder, will cau
|
||||||
to update the modification time of the file. This may make rclone upload a full new copy
|
to update the modification time of the file. This may make rclone upload a full new copy
|
||||||
of the file.
|
of the file.
|
||||||
|
|
||||||
#### Unicode Normalization
|
|
||||||
|
|
||||||
Rclone includes flags for unicode normalization with macFUSE that should be updated
|
|
||||||
for FUSE-T. See [this forum post](https://forum.rclone.org/t/some-unicode-forms-break-mount-on-macos-with-fuse-t/36403)
|
|
||||||
and [FUSE-T issue #16](https://github.com/macos-fuse-t/fuse-t/issues/16). The following
|
|
||||||
flag should be added to the `rclone mount` command.
|
|
||||||
|
|
||||||
-o modules=iconv,from_code=UTF-8,to_code=UTF-8
|
|
||||||
|
|
||||||
#### Read Only mounts
|
#### Read Only mounts
|
||||||
|
|
||||||
When mounting with `--read-only`, attempts to write to files will fail *silently* as
|
When mounting with `--read-only`, attempts to write to files will fail *silently* as
|
||||||
|
|
@ -786,6 +786,28 @@ If the flag is not provided on the command line, then its default value depends
|
||||||
on the operating system where rclone runs: "true" on Windows and macOS, "false"
|
on the operating system where rclone runs: "true" on Windows and macOS, "false"
|
||||||
otherwise. If the flag is provided without a value, then it is "true".
|
otherwise. If the flag is provided without a value, then it is "true".
|
||||||
|
|
||||||
|
The `--no-unicode-normalization` flag controls whether a similar "fixup" is
|
||||||
|
performed for filenames that differ but are [canonically
|
||||||
|
equivalent](https://en.wikipedia.org/wiki/Unicode_equivalence) with respect to
|
||||||
|
unicode. Unicode normalization can be particularly helpful for users of macOS,
|
||||||
|
which prefers form NFD instead of the NFC used by most other platforms. It is
|
||||||
|
therefore highly recommended to keep the default of `false` on macOS, to avoid
|
||||||
|
encoding compatibility issues.
|
||||||
|
|
||||||
|
In the (probably unlikely) event that a directory has multiple duplicate
|
||||||
|
filenames after applying case and unicode normalization, the `--vfs-block-norm-dupes`
|
||||||
|
flag allows hiding these duplicates. This comes with a performance tradeoff, as
|
||||||
|
rclone will have to scan the entire directory for duplicates when listing a
|
||||||
|
directory. For this reason, it is recommended to leave this disabled if not
|
||||||
|
needed. However, macOS users may wish to consider using it, as otherwise, if a
|
||||||
|
remote directory contains both NFC and NFD versions of the same filename, an odd
|
||||||
|
situation will occur: both versions of the file will be visible in the mount,
|
||||||
|
and both will appear to be editable, however, editing either version will
|
||||||
|
actually result in only the NFD version getting edited under the hood. `--vfs-block-
|
||||||
|
norm-dupes` prevents this confusion by detecting this scenario, hiding the
|
||||||
|
duplicates, and logging an error, similar to how this is handled in `rclone
|
||||||
|
sync`.
|
||||||
|
|
||||||
## VFS Disk Options
|
## VFS Disk Options
|
||||||
|
|
||||||
This flag allows you to manually set the statistics about the filing system.
|
This flag allows you to manually set the statistics about the filing system.
|
||||||
|
|
@ -844,6 +866,7 @@ rclone mount remote:path /path/to/mountpoint [flags]
|
||||||
--read-only Only allow read-only access
|
--read-only Only allow read-only access
|
||||||
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
||||||
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
||||||
|
--vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost)
|
||||||
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||||
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||||
--vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off)
|
--vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off)
|
||||||
|
|
@ -856,7 +879,7 @@ rclone mount remote:path /path/to/mountpoint [flags]
|
||||||
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi)
|
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi)
|
||||||
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off)
|
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off)
|
||||||
--vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms)
|
--vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms)
|
||||||
--vfs-refresh Refreshes the directory cache recursively on start
|
--vfs-refresh Refreshes the directory cache recursively in the background on start
|
||||||
--vfs-used-is-size rclone size Use the rclone size algorithm for Used size
|
--vfs-used-is-size rclone size Use the rclone size algorithm for Used size
|
||||||
--vfs-write-back Duration Time to writeback files after last use when using cache (default 5s)
|
--vfs-write-back Duration Time to writeback files after last use when using cache (default 5s)
|
||||||
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
|
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
|
||||||
|
|
|
||||||
|
|
@ -39,6 +39,14 @@ whether rclone lists the destination directory or not. Supplying this
|
||||||
option when moving a small number of files into a large destination
|
option when moving a small number of files into a large destination
|
||||||
can speed transfers up greatly.
|
can speed transfers up greatly.
|
||||||
|
|
||||||
|
Rclone will sync the modification times of files and directories if
|
||||||
|
the backend supports it. If metadata syncing is required then use the
|
||||||
|
`--metadata` flag.
|
||||||
|
|
||||||
|
Note that the modification time and metadata for the root directory
|
||||||
|
will **not** be synced. See https://github.com/rclone/rclone/issues/7652
|
||||||
|
for more info.
|
||||||
|
|
||||||
**Important**: Since this can cause data loss, test first with the
|
**Important**: Since this can cause data loss, test first with the
|
||||||
`--dry-run` or the `--interactive`/`-i` flag.
|
`--dry-run` or the `--interactive`/`-i` flag.
|
||||||
|
|
||||||
|
|
@ -72,7 +80,7 @@ Flags for anything which can Copy a file.
|
||||||
--ignore-checksum Skip post copy check of checksums
|
--ignore-checksum Skip post copy check of checksums
|
||||||
--ignore-existing Skip all files that exist on destination
|
--ignore-existing Skip all files that exist on destination
|
||||||
--ignore-size Ignore size when skipping use modtime or checksum
|
--ignore-size Ignore size when skipping use modtime or checksum
|
||||||
-I, --ignore-times Don't skip files that match size and time - transfer all files
|
-I, --ignore-times Don't skip items that match size and time - transfer all unconditionally
|
||||||
--immutable Do not modify files, fail if existing files have been modified
|
--immutable Do not modify files, fail if existing files have been modified
|
||||||
--inplace Download directly to destination file instead of atomic download to temp/rename
|
--inplace Download directly to destination file instead of atomic download to temp/rename
|
||||||
--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)
|
||||||
|
|
@ -86,6 +94,7 @@ Flags for anything which can Copy a file.
|
||||||
--multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki)
|
--multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki)
|
||||||
--no-check-dest Don't check the destination, copy regardless
|
--no-check-dest Don't check the destination, copy regardless
|
||||||
--no-traverse Don't traverse destination file system on copy
|
--no-traverse Don't traverse destination file system on copy
|
||||||
|
--no-update-dir-modtime Don't update directory modification times
|
||||||
--no-update-modtime Don't update destination modtime if files identical
|
--no-update-modtime Don't update destination modtime if files identical
|
||||||
--order-by string Instructions on how to order the transfers, e.g. 'size,descending'
|
--order-by string Instructions on how to order the transfers, e.g. 'size,descending'
|
||||||
--partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial")
|
--partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial")
|
||||||
|
|
|
||||||
|
|
@ -71,7 +71,7 @@ Flags for anything which can Copy a file.
|
||||||
--ignore-checksum Skip post copy check of checksums
|
--ignore-checksum Skip post copy check of checksums
|
||||||
--ignore-existing Skip all files that exist on destination
|
--ignore-existing Skip all files that exist on destination
|
||||||
--ignore-size Ignore size when skipping use modtime or checksum
|
--ignore-size Ignore size when skipping use modtime or checksum
|
||||||
-I, --ignore-times Don't skip files that match size and time - transfer all files
|
-I, --ignore-times Don't skip items that match size and time - transfer all unconditionally
|
||||||
--immutable Do not modify files, fail if existing files have been modified
|
--immutable Do not modify files, fail if existing files have been modified
|
||||||
--inplace Download directly to destination file instead of atomic download to temp/rename
|
--inplace Download directly to destination file instead of atomic download to temp/rename
|
||||||
--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)
|
||||||
|
|
@ -85,6 +85,7 @@ Flags for anything which can Copy a file.
|
||||||
--multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki)
|
--multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki)
|
||||||
--no-check-dest Don't check the destination, copy regardless
|
--no-check-dest Don't check the destination, copy regardless
|
||||||
--no-traverse Don't traverse destination file system on copy
|
--no-traverse Don't traverse destination file system on copy
|
||||||
|
--no-update-dir-modtime Don't update directory modification times
|
||||||
--no-update-modtime Don't update destination modtime if files identical
|
--no-update-modtime Don't update destination modtime if files identical
|
||||||
--order-by string Instructions on how to order the transfers, e.g. 'size,descending'
|
--order-by string Instructions on how to order the transfers, e.g. 'size,descending'
|
||||||
--partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial")
|
--partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial")
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,929 @@
|
||||||
|
---
|
||||||
|
title: "rclone nfsmount"
|
||||||
|
description: "Mount the remote as file system on a mountpoint."
|
||||||
|
slug: rclone_nfsmount
|
||||||
|
url: /commands/rclone_nfsmount/
|
||||||
|
groups: Filter
|
||||||
|
status: Experimental
|
||||||
|
versionIntroduced: v1.65
|
||||||
|
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/nfsmount/ and as part of making a release run "make commanddocs"
|
||||||
|
---
|
||||||
|
# rclone nfsmount
|
||||||
|
|
||||||
|
Mount the remote as file system on a mountpoint.
|
||||||
|
|
||||||
|
## Synopsis
|
||||||
|
|
||||||
|
rclone nfsmount allows Linux, FreeBSD, macOS and Windows to
|
||||||
|
mount any of Rclone's cloud storage systems as a file system with
|
||||||
|
FUSE.
|
||||||
|
|
||||||
|
First set up your remote using `rclone config`. Check it works with `rclone ls` etc.
|
||||||
|
|
||||||
|
On Linux and macOS, you can run mount in either foreground or background (aka
|
||||||
|
daemon) mode. Mount runs in foreground mode by default. Use the `--daemon` flag
|
||||||
|
to force background mode. On Windows you can run mount in foreground only,
|
||||||
|
the flag is ignored.
|
||||||
|
|
||||||
|
In background mode rclone acts as a generic Unix mount program: the main
|
||||||
|
program starts, spawns background rclone process to setup and maintain the
|
||||||
|
mount, waits until success or timeout and exits with appropriate code
|
||||||
|
(killing the child process if it fails).
|
||||||
|
|
||||||
|
On Linux/macOS/FreeBSD start the mount like this, where `/path/to/local/mount`
|
||||||
|
is an **empty** **existing** directory:
|
||||||
|
|
||||||
|
rclone nfsmount remote:path/to/files /path/to/local/mount
|
||||||
|
|
||||||
|
On Windows you can start a mount in different ways. See [below](#mounting-modes-on-windows)
|
||||||
|
for details. If foreground mount is used interactively from a console window,
|
||||||
|
rclone will serve the mount and occupy the console so another window should be
|
||||||
|
used to work with the mount until rclone is interrupted e.g. by pressing Ctrl-C.
|
||||||
|
|
||||||
|
The following examples will mount to an automatically assigned drive,
|
||||||
|
to specific drive letter `X:`, to path `C:\path\parent\mount`
|
||||||
|
(where parent directory or drive must exist, and mount must **not** exist,
|
||||||
|
and is not supported when [mounting as a network drive](#mounting-modes-on-windows)), and
|
||||||
|
the last example will mount as network share `\\cloud\remote` and map it to an
|
||||||
|
automatically assigned drive:
|
||||||
|
|
||||||
|
rclone nfsmount remote:path/to/files *
|
||||||
|
rclone nfsmount remote:path/to/files X:
|
||||||
|
rclone nfsmount remote:path/to/files C:\path\parent\mount
|
||||||
|
rclone nfsmount remote:path/to/files \\cloud\remote
|
||||||
|
|
||||||
|
When the program ends while in foreground mode, either via Ctrl+C or receiving
|
||||||
|
a SIGINT or SIGTERM signal, the mount should be automatically stopped.
|
||||||
|
|
||||||
|
When running in background mode the user will have to stop the mount manually:
|
||||||
|
|
||||||
|
# Linux
|
||||||
|
fusermount -u /path/to/local/mount
|
||||||
|
# OS X
|
||||||
|
umount /path/to/local/mount
|
||||||
|
|
||||||
|
The umount operation can fail, for example when the mountpoint is busy.
|
||||||
|
When that happens, it is the user's responsibility to stop the mount manually.
|
||||||
|
|
||||||
|
The size of the mounted file system will be set according to information retrieved
|
||||||
|
from the remote, the same as returned by the [rclone about](https://rclone.org/commands/rclone_about/)
|
||||||
|
command. Remotes with unlimited storage may report the used size only,
|
||||||
|
then an additional 1 PiB of free space is assumed. If the remote does not
|
||||||
|
[support](https://rclone.org/overview/#optional-features) the about feature
|
||||||
|
at all, then 1 PiB is set as both the total and the free size.
|
||||||
|
|
||||||
|
## Installing on Windows
|
||||||
|
|
||||||
|
To run rclone nfsmount on Windows, you will need to
|
||||||
|
download and install [WinFsp](http://www.secfs.net/winfsp/).
|
||||||
|
|
||||||
|
[WinFsp](https://github.com/winfsp/winfsp) is an open-source
|
||||||
|
Windows File System Proxy which makes it easy to write user space file
|
||||||
|
systems for Windows. It provides a FUSE emulation layer which rclone
|
||||||
|
uses combination with [cgofuse](https://github.com/winfsp/cgofuse).
|
||||||
|
Both of these packages are by Bill Zissimopoulos who was very helpful
|
||||||
|
during the implementation of rclone nfsmount for Windows.
|
||||||
|
|
||||||
|
### Mounting modes on windows
|
||||||
|
|
||||||
|
Unlike other operating systems, Microsoft Windows provides a different filesystem
|
||||||
|
type for network and fixed drives. It optimises access on the assumption fixed
|
||||||
|
disk drives are fast and reliable, while network drives have relatively high latency
|
||||||
|
and less reliability. Some settings can also be differentiated between the two types,
|
||||||
|
for example that Windows Explorer should just display icons and not create preview
|
||||||
|
thumbnails for image and video files on network drives.
|
||||||
|
|
||||||
|
In most cases, rclone will mount the remote as a normal, fixed disk drive by default.
|
||||||
|
However, you can also choose to mount it as a remote network drive, often described
|
||||||
|
as a network share. If you mount an rclone remote using the default, fixed drive mode
|
||||||
|
and experience unexpected program errors, freezes or other issues, consider mounting
|
||||||
|
as a network drive instead.
|
||||||
|
|
||||||
|
When mounting as a fixed disk drive you can either mount to an unused drive letter,
|
||||||
|
or to a path representing a **nonexistent** subdirectory of an **existing** parent
|
||||||
|
directory or drive. Using the special value `*` will tell rclone to
|
||||||
|
automatically assign the next available drive letter, starting with Z: and moving backward.
|
||||||
|
Examples:
|
||||||
|
|
||||||
|
rclone nfsmount remote:path/to/files *
|
||||||
|
rclone nfsmount remote:path/to/files X:
|
||||||
|
rclone nfsmount remote:path/to/files C:\path\parent\mount
|
||||||
|
rclone nfsmount remote:path/to/files X:
|
||||||
|
|
||||||
|
Option `--volname` can be used to set a custom volume name for the mounted
|
||||||
|
file system. The default is to use the remote name and path.
|
||||||
|
|
||||||
|
To mount as network drive, you can add option `--network-mode`
|
||||||
|
to your nfsmount command. Mounting to a directory path is not supported in
|
||||||
|
this mode, it is a limitation Windows imposes on junctions, so the remote must always
|
||||||
|
be mounted to a drive letter.
|
||||||
|
|
||||||
|
rclone nfsmount remote:path/to/files X: --network-mode
|
||||||
|
|
||||||
|
A volume name specified with `--volname` will be used to create the network share path.
|
||||||
|
A complete UNC path, such as `\\cloud\remote`, optionally with path
|
||||||
|
`\\cloud\remote\madeup\path`, will be used as is. Any other
|
||||||
|
string will be used as the share part, after a default prefix `\\server\`.
|
||||||
|
If no volume name is specified then `\\server\share` will be used.
|
||||||
|
You must make sure the volume name is unique when you are mounting more than one drive,
|
||||||
|
or else the mount command will fail. The share name will treated as the volume label for
|
||||||
|
the mapped drive, shown in Windows Explorer etc, while the complete
|
||||||
|
`\\server\share` will be reported as the remote UNC path by
|
||||||
|
`net use` etc, just like a normal network drive mapping.
|
||||||
|
|
||||||
|
If you specify a full network share UNC path with `--volname`, this will implicitly
|
||||||
|
set the `--network-mode` option, so the following two examples have same result:
|
||||||
|
|
||||||
|
rclone nfsmount remote:path/to/files X: --network-mode
|
||||||
|
rclone nfsmount remote:path/to/files X: --volname \\server\share
|
||||||
|
|
||||||
|
You may also specify the network share UNC path as the mountpoint itself. Then rclone
|
||||||
|
will automatically assign a drive letter, same as with `*` and use that as
|
||||||
|
mountpoint, and instead use the UNC path specified as the volume name, as if it were
|
||||||
|
specified with the `--volname` option. This will also implicitly set
|
||||||
|
the `--network-mode` option. This means the following two examples have same result:
|
||||||
|
|
||||||
|
rclone nfsmount remote:path/to/files \\cloud\remote
|
||||||
|
rclone nfsmount remote:path/to/files * --volname \\cloud\remote
|
||||||
|
|
||||||
|
There is yet another way to enable network mode, and to set the share path,
|
||||||
|
and that is to pass the "native" libfuse/WinFsp option directly:
|
||||||
|
`--fuse-flag --VolumePrefix=\server\share`. Note that the path
|
||||||
|
must be with just a single backslash prefix in this case.
|
||||||
|
|
||||||
|
|
||||||
|
*Note:* In previous versions of rclone this was the only supported method.
|
||||||
|
|
||||||
|
[Read more about drive mapping](https://en.wikipedia.org/wiki/Drive_mapping)
|
||||||
|
|
||||||
|
See also [Limitations](#limitations) section below.
|
||||||
|
|
||||||
|
### Windows filesystem permissions
|
||||||
|
|
||||||
|
The FUSE emulation layer on Windows must convert between the POSIX-based
|
||||||
|
permission model used in FUSE, and the permission model used in Windows,
|
||||||
|
based on access-control lists (ACL).
|
||||||
|
|
||||||
|
The mounted filesystem will normally get three entries in its access-control list (ACL),
|
||||||
|
representing permissions for the POSIX permission scopes: Owner, group and others.
|
||||||
|
By default, the owner and group will be taken from the current user, and the built-in
|
||||||
|
group "Everyone" will be used to represent others. The user/group can be customized
|
||||||
|
with FUSE options "UserName" and "GroupName",
|
||||||
|
e.g. `-o UserName=user123 -o GroupName="Authenticated Users"`.
|
||||||
|
The permissions on each entry will be set according to [options](#options)
|
||||||
|
`--dir-perms` and `--file-perms`, which takes a value in traditional Unix
|
||||||
|
[numeric notation](https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation).
|
||||||
|
|
||||||
|
The default permissions corresponds to `--file-perms 0666 --dir-perms 0777`,
|
||||||
|
i.e. read and write permissions to everyone. This means you will not be able
|
||||||
|
to start any programs from the mount. To be able to do that you must add
|
||||||
|
execute permissions, e.g. `--file-perms 0777 --dir-perms 0777` to add it
|
||||||
|
to everyone. If the program needs to write files, chances are you will
|
||||||
|
have to enable [VFS File Caching](#vfs-file-caching) as well (see also
|
||||||
|
[limitations](#limitations)). Note that the default write permission have
|
||||||
|
some restrictions for accounts other than the owner, specifically it lacks
|
||||||
|
the "write extended attributes", as explained next.
|
||||||
|
|
||||||
|
The mapping of permissions is not always trivial, and the result you see in
|
||||||
|
Windows Explorer may not be exactly like you expected. For example, when setting
|
||||||
|
a value that includes write access for the group or others scope, this will be
|
||||||
|
mapped to individual permissions "write attributes", "write data" and
|
||||||
|
"append data", but not "write extended attributes". Windows will then show this
|
||||||
|
as basic permission "Special" instead of "Write", because "Write" also covers
|
||||||
|
the "write extended attributes" permission. When setting digit 0 for group or
|
||||||
|
others, to indicate no permissions, they will still get individual permissions
|
||||||
|
"read attributes", "read extended attributes" and "read permissions". This is
|
||||||
|
done for compatibility reasons, e.g. to allow users without additional
|
||||||
|
permissions to be able to read basic metadata about files like in Unix.
|
||||||
|
|
||||||
|
WinFsp 2021 (version 1.9) introduced a new FUSE option "FileSecurity",
|
||||||
|
that allows the complete specification of file security descriptors using
|
||||||
|
[SDDL](https://docs.microsoft.com/en-us/windows/win32/secauthz/security-descriptor-string-format).
|
||||||
|
With this you get detailed control of the resulting permissions, compared
|
||||||
|
to use of the POSIX permissions described above, and no additional permissions
|
||||||
|
will be added automatically for compatibility with Unix. Some example use
|
||||||
|
cases will following.
|
||||||
|
|
||||||
|
If you set POSIX permissions for only allowing access to the owner,
|
||||||
|
using `--file-perms 0600 --dir-perms 0700`, the user group and the built-in
|
||||||
|
"Everyone" group will still be given some special permissions, as described
|
||||||
|
above. Some programs may then (incorrectly) interpret this as the file being
|
||||||
|
accessible by everyone, for example an SSH client may warn about "unprotected
|
||||||
|
private key file". You can work around this by specifying
|
||||||
|
`-o FileSecurity="D:P(A;;FA;;;OW)"`, which sets file all access (FA) to the
|
||||||
|
owner (OW), and nothing else.
|
||||||
|
|
||||||
|
When setting write permissions then, except for the owner, this does not
|
||||||
|
include the "write extended attributes" permission, as mentioned above.
|
||||||
|
This may prevent applications from writing to files, giving permission denied
|
||||||
|
error instead. To set working write permissions for the built-in "Everyone"
|
||||||
|
group, similar to what it gets by default but with the addition of the
|
||||||
|
"write extended attributes", you can specify
|
||||||
|
`-o FileSecurity="D:P(A;;FRFW;;;WD)"`, which sets file read (FR) and file
|
||||||
|
write (FW) to everyone (WD). If file execute (FX) is also needed, then change
|
||||||
|
to `-o FileSecurity="D:P(A;;FRFWFX;;;WD)"`, or set file all access (FA) to
|
||||||
|
get full access permissions, including delete, with
|
||||||
|
`-o FileSecurity="D:P(A;;FA;;;WD)"`.
|
||||||
|
|
||||||
|
### Windows caveats
|
||||||
|
|
||||||
|
Drives created as Administrator are not visible to other accounts,
|
||||||
|
not even an account that was elevated to Administrator with the
|
||||||
|
User Account Control (UAC) feature. A result of this is that if you mount
|
||||||
|
to a drive letter from a Command Prompt run as Administrator, and then try
|
||||||
|
to access the same drive from Windows Explorer (which does not run as
|
||||||
|
Administrator), you will not be able to see the mounted drive.
|
||||||
|
|
||||||
|
If you don't need to access the drive from applications running with
|
||||||
|
administrative privileges, the easiest way around this is to always
|
||||||
|
create the mount from a non-elevated command prompt.
|
||||||
|
|
||||||
|
To make mapped drives available to the user account that created them
|
||||||
|
regardless if elevated or not, there is a special Windows setting called
|
||||||
|
[linked connections](https://docs.microsoft.com/en-us/troubleshoot/windows-client/networking/mapped-drives-not-available-from-elevated-command#detail-to-configure-the-enablelinkedconnections-registry-entry)
|
||||||
|
that can be enabled.
|
||||||
|
|
||||||
|
It is also possible to make a drive mount available to everyone on the system,
|
||||||
|
by running the process creating it as the built-in SYSTEM account.
|
||||||
|
There are several ways to do this: One is to use the command-line
|
||||||
|
utility [PsExec](https://docs.microsoft.com/en-us/sysinternals/downloads/psexec),
|
||||||
|
from Microsoft's Sysinternals suite, which has option `-s` to start
|
||||||
|
processes as the SYSTEM account. Another alternative is to run the mount
|
||||||
|
command from a Windows Scheduled Task, or a Windows Service, configured
|
||||||
|
to run as the SYSTEM account. A third alternative is to use the
|
||||||
|
[WinFsp.Launcher infrastructure](https://github.com/winfsp/winfsp/wiki/WinFsp-Service-Architecture)).
|
||||||
|
Read more in the [install documentation](https://rclone.org/install/).
|
||||||
|
Note that when running rclone as another user, it will not use
|
||||||
|
the configuration file from your profile unless you tell it to
|
||||||
|
with the [`--config`](https://rclone.org/docs/#config-config-file) option.
|
||||||
|
Note also that it is now the SYSTEM account that will have the owner
|
||||||
|
permissions, and other accounts will have permissions according to the
|
||||||
|
group or others scopes. As mentioned above, these will then not get the
|
||||||
|
"write extended attributes" permission, and this may prevent writing to
|
||||||
|
files. You can work around this with the FileSecurity option, see
|
||||||
|
example above.
|
||||||
|
|
||||||
|
Note that mapping to a directory path, instead of a drive letter,
|
||||||
|
does not suffer from the same limitations.
|
||||||
|
|
||||||
|
## Mounting on macOS
|
||||||
|
|
||||||
|
Mounting on macOS can be done either via [built-in NFS server](/commands/rclone_serve_nfs/), [macFUSE](https://osxfuse.github.io/)
|
||||||
|
(also known as osxfuse) or [FUSE-T](https://www.fuse-t.org/). macFUSE is a traditional
|
||||||
|
FUSE driver utilizing a macOS kernel extension (kext). FUSE-T is an alternative FUSE system
|
||||||
|
which "mounts" via an NFSv4 local server.
|
||||||
|
|
||||||
|
#### Unicode Normalization
|
||||||
|
|
||||||
|
It is highly recommended to keep the default of `--no-unicode-normalization=false`
|
||||||
|
for all `mount` and `serve` commands on macOS. For details, see [vfs-case-sensitivity](https://rclone.org/commands/rclone_mount/#vfs-case-sensitivity).
|
||||||
|
|
||||||
|
### NFS mount
|
||||||
|
|
||||||
|
This method spins up an NFS server using [serve nfs](/commands/rclone_serve_nfs/) command and mounts
|
||||||
|
it to the specified mountpoint. If you run this in background mode using |--daemon|, you will need to
|
||||||
|
send SIGTERM signal to the rclone process using |kill| command to stop the mount.
|
||||||
|
|
||||||
|
Note that `--nfs-cache-handle-limit` controls the maximum number of cached file handles stored by the `nfsmount` caching handler.
|
||||||
|
This should not be set too low or you may experience errors when trying to access files. The default is 1000000,
|
||||||
|
but consider lowering this limit if the server's system resource usage causes problems.
|
||||||
|
|
||||||
|
### macFUSE Notes
|
||||||
|
|
||||||
|
If installing macFUSE using [dmg packages](https://github.com/osxfuse/osxfuse/releases) from
|
||||||
|
the website, rclone will locate the macFUSE libraries without any further intervention.
|
||||||
|
If however, macFUSE is installed using the [macports](https://www.macports.org/) package manager,
|
||||||
|
the following addition steps are required.
|
||||||
|
|
||||||
|
sudo mkdir /usr/local/lib
|
||||||
|
cd /usr/local/lib
|
||||||
|
sudo ln -s /opt/local/lib/libfuse.2.dylib
|
||||||
|
|
||||||
|
### FUSE-T Limitations, Caveats, and Notes
|
||||||
|
|
||||||
|
There are some limitations, caveats, and notes about how it works. These are current as
|
||||||
|
of FUSE-T version 1.0.14.
|
||||||
|
|
||||||
|
#### ModTime update on read
|
||||||
|
|
||||||
|
As per the [FUSE-T wiki](https://github.com/macos-fuse-t/fuse-t/wiki#caveats):
|
||||||
|
|
||||||
|
> File access and modification times cannot be set separately as it seems to be an
|
||||||
|
> issue with the NFS client which always modifies both. Can be reproduced with
|
||||||
|
> 'touch -m' and 'touch -a' commands
|
||||||
|
|
||||||
|
This means that viewing files with various tools, notably macOS Finder, will cause rlcone
|
||||||
|
to update the modification time of the file. This may make rclone upload a full new copy
|
||||||
|
of the file.
|
||||||
|
|
||||||
|
#### Read Only mounts
|
||||||
|
|
||||||
|
When mounting with `--read-only`, attempts to write to files will fail *silently* as
|
||||||
|
opposed to with a clear warning as in macFUSE.
|
||||||
|
|
||||||
|
## Limitations
|
||||||
|
|
||||||
|
Without the use of `--vfs-cache-mode` this can only write files
|
||||||
|
sequentially, it can only seek when reading. This means that many
|
||||||
|
applications won't work with their files on an rclone mount without
|
||||||
|
`--vfs-cache-mode writes` or `--vfs-cache-mode full`.
|
||||||
|
See the [VFS File Caching](#vfs-file-caching) section for more info.
|
||||||
|
When using NFS mount on macOS, if you don't specify |--vfs-cache-mode|
|
||||||
|
the mount point will be read-only.
|
||||||
|
|
||||||
|
The bucket-based remotes (e.g. Swift, S3, Google Compute Storage, B2)
|
||||||
|
do not support the concept of empty directories, so empty
|
||||||
|
directories will have a tendency to disappear once they fall out of
|
||||||
|
the directory cache.
|
||||||
|
|
||||||
|
When `rclone mount` is invoked on Unix with `--daemon` flag, the main rclone
|
||||||
|
program will wait for the background mount to become ready or until the timeout
|
||||||
|
specified by the `--daemon-wait` flag. On Linux it can check mount status using
|
||||||
|
ProcFS so the flag in fact sets **maximum** time to wait, while the real wait
|
||||||
|
can be less. On macOS / BSD the time to wait is constant and the check is
|
||||||
|
performed only at the end. We advise you to set wait time on macOS reasonably.
|
||||||
|
|
||||||
|
Only supported on Linux, FreeBSD, OS X and Windows at the moment.
|
||||||
|
|
||||||
|
## rclone nfsmount vs rclone sync/copy
|
||||||
|
|
||||||
|
File systems expect things to be 100% reliable, whereas cloud storage
|
||||||
|
systems are a long way from 100% reliable. The rclone sync/copy
|
||||||
|
commands cope with this with lots of retries. However rclone nfsmount
|
||||||
|
can't use retries in the same way without making local copies of the
|
||||||
|
uploads. Look at the [VFS File Caching](#vfs-file-caching)
|
||||||
|
for solutions to make nfsmount more reliable.
|
||||||
|
|
||||||
|
## Attribute caching
|
||||||
|
|
||||||
|
You can use the flag `--attr-timeout` to set the time the kernel caches
|
||||||
|
the attributes (size, modification time, etc.) for directory entries.
|
||||||
|
|
||||||
|
The default is `1s` which caches files just long enough to avoid
|
||||||
|
too many callbacks to rclone from the kernel.
|
||||||
|
|
||||||
|
In theory 0s should be the correct value for filesystems which can
|
||||||
|
change outside the control of the kernel. However this causes quite a
|
||||||
|
few problems such as
|
||||||
|
[rclone using too much memory](https://github.com/rclone/rclone/issues/2157),
|
||||||
|
[rclone not serving files to samba](https://forum.rclone.org/t/rclone-1-39-vs-1-40-mount-issue/5112)
|
||||||
|
and [excessive time listing directories](https://github.com/rclone/rclone/issues/2095#issuecomment-371141147).
|
||||||
|
|
||||||
|
The kernel can cache the info about a file for the time given by
|
||||||
|
`--attr-timeout`. You may see corruption if the remote file changes
|
||||||
|
length during this window. It will show up as either a truncated file
|
||||||
|
or a file with garbage on the end. With `--attr-timeout 1s` this is
|
||||||
|
very unlikely but not impossible. The higher you set `--attr-timeout`
|
||||||
|
the more likely it is. The default setting of "1s" is the lowest
|
||||||
|
setting which mitigates the problems above.
|
||||||
|
|
||||||
|
If you set it higher (`10s` or `1m` say) then the kernel will call
|
||||||
|
back to rclone less often making it more efficient, however there is
|
||||||
|
more chance of the corruption issue above.
|
||||||
|
|
||||||
|
If files don't change on the remote outside of the control of rclone
|
||||||
|
then there is no chance of corruption.
|
||||||
|
|
||||||
|
This is the same as setting the attr_timeout option in mount.fuse.
|
||||||
|
|
||||||
|
## Filters
|
||||||
|
|
||||||
|
Note that all the rclone filters can be used to select a subset of the
|
||||||
|
files to be visible in the mount.
|
||||||
|
|
||||||
|
## systemd
|
||||||
|
|
||||||
|
When running rclone nfsmount as a systemd service, it is possible
|
||||||
|
to use Type=notify. In this case the service will enter the started state
|
||||||
|
after the mountpoint has been successfully set up.
|
||||||
|
Units having the rclone nfsmount service specified as a requirement
|
||||||
|
will see all files and folders immediately in this mode.
|
||||||
|
|
||||||
|
Note that systemd runs mount units without any environment variables including
|
||||||
|
`PATH` or `HOME`. This means that tilde (`~`) expansion will not work
|
||||||
|
and you should provide `--config` and `--cache-dir` explicitly as absolute
|
||||||
|
paths via rclone arguments.
|
||||||
|
Since mounting requires the `fusermount` program, rclone will use the fallback
|
||||||
|
PATH of `/bin:/usr/bin` in this scenario. Please ensure that `fusermount`
|
||||||
|
is present on this PATH.
|
||||||
|
|
||||||
|
## Rclone as Unix mount helper
|
||||||
|
|
||||||
|
The core Unix program `/bin/mount` normally takes the `-t FSTYPE` argument
|
||||||
|
then runs the `/sbin/mount.FSTYPE` helper program passing it mount options
|
||||||
|
as `-o key=val,...` or `--opt=...`. Automount (classic or systemd) behaves
|
||||||
|
in a similar way.
|
||||||
|
|
||||||
|
rclone by default expects GNU-style flags `--key val`. To run it as a mount
|
||||||
|
helper you should symlink rclone binary to `/sbin/mount.rclone` and optionally
|
||||||
|
`/usr/bin/rclonefs`, e.g. `ln -s /usr/bin/rclone /sbin/mount.rclone`.
|
||||||
|
rclone will detect it and translate command-line arguments appropriately.
|
||||||
|
|
||||||
|
Now you can run classic mounts like this:
|
||||||
|
```
|
||||||
|
mount sftp1:subdir /mnt/data -t rclone -o vfs_cache_mode=writes,sftp_key_file=/path/to/pem
|
||||||
|
```
|
||||||
|
|
||||||
|
or create systemd mount units:
|
||||||
|
```
|
||||||
|
# /etc/systemd/system/mnt-data.mount
|
||||||
|
[Unit]
|
||||||
|
Description=Mount for /mnt/data
|
||||||
|
[Mount]
|
||||||
|
Type=rclone
|
||||||
|
What=sftp1:subdir
|
||||||
|
Where=/mnt/data
|
||||||
|
Options=rw,_netdev,allow_other,args2env,vfs-cache-mode=writes,config=/etc/rclone.conf,cache-dir=/var/rclone
|
||||||
|
```
|
||||||
|
|
||||||
|
optionally accompanied by systemd automount unit
|
||||||
|
```
|
||||||
|
# /etc/systemd/system/mnt-data.automount
|
||||||
|
[Unit]
|
||||||
|
Description=AutoMount for /mnt/data
|
||||||
|
[Automount]
|
||||||
|
Where=/mnt/data
|
||||||
|
TimeoutIdleSec=600
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
|
```
|
||||||
|
|
||||||
|
or add in `/etc/fstab` a line like
|
||||||
|
```
|
||||||
|
sftp1:subdir /mnt/data rclone rw,noauto,nofail,_netdev,x-systemd.automount,args2env,vfs_cache_mode=writes,config=/etc/rclone.conf,cache_dir=/var/cache/rclone 0 0
|
||||||
|
```
|
||||||
|
|
||||||
|
or use classic Automountd.
|
||||||
|
Remember to provide explicit `config=...,cache-dir=...` as a workaround for
|
||||||
|
mount units being run without `HOME`.
|
||||||
|
|
||||||
|
Rclone in the mount helper mode will split `-o` argument(s) by comma, replace `_`
|
||||||
|
by `-` and prepend `--` to get the command-line flags. Options containing commas
|
||||||
|
or spaces can be wrapped in single or double quotes. Any inner quotes inside outer
|
||||||
|
quotes of the same type should be doubled.
|
||||||
|
|
||||||
|
Mount option syntax includes a few extra options treated specially:
|
||||||
|
|
||||||
|
- `env.NAME=VALUE` will set an environment variable for the mount process.
|
||||||
|
This helps with Automountd and Systemd.mount which don't allow setting
|
||||||
|
custom environment for mount helpers.
|
||||||
|
Typically you will use `env.HTTPS_PROXY=proxy.host:3128` or `env.HOME=/root`
|
||||||
|
- `command=cmount` can be used to run `cmount` or any other rclone command
|
||||||
|
rather than the default `mount`.
|
||||||
|
- `args2env` will pass mount options to the mount helper running in background
|
||||||
|
via environment variables instead of command line arguments. This allows to
|
||||||
|
hide secrets from such commands as `ps` or `pgrep`.
|
||||||
|
- `vv...` will be transformed into appropriate `--verbose=N`
|
||||||
|
- standard mount options like `x-systemd.automount`, `_netdev`, `nosuid` and alike
|
||||||
|
are intended only for Automountd and ignored by rclone.
|
||||||
|
## VFS - Virtual File System
|
||||||
|
|
||||||
|
This command uses the VFS layer. This adapts the cloud storage objects
|
||||||
|
that rclone uses into something which looks much more like a disk
|
||||||
|
filing system.
|
||||||
|
|
||||||
|
Cloud storage objects have lots of properties which aren't like disk
|
||||||
|
files - you can't extend them or write to the middle of them, so the
|
||||||
|
VFS layer has to deal with that. Because there is no one right way of
|
||||||
|
doing this there are various options explained below.
|
||||||
|
|
||||||
|
The VFS layer also implements a directory cache - this caches info
|
||||||
|
about files and directories (but not the data) in memory.
|
||||||
|
|
||||||
|
## VFS Directory Cache
|
||||||
|
|
||||||
|
Using the `--dir-cache-time` flag, you can control how long a
|
||||||
|
directory should be considered up to date and not refreshed from the
|
||||||
|
backend. Changes made through the VFS will appear immediately or
|
||||||
|
invalidate the cache.
|
||||||
|
|
||||||
|
--dir-cache-time duration Time to cache directory entries for (default 5m0s)
|
||||||
|
--poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s)
|
||||||
|
|
||||||
|
However, changes made directly on the cloud storage by the web
|
||||||
|
interface or a different copy of rclone will only be picked up once
|
||||||
|
the directory cache expires if the backend configured does not support
|
||||||
|
polling for changes. If the backend supports polling, changes will be
|
||||||
|
picked up within the polling interval.
|
||||||
|
|
||||||
|
You can send a `SIGHUP` signal to rclone for it to flush all
|
||||||
|
directory caches, regardless of how old they are. Assuming only one
|
||||||
|
rclone instance is running, you can reset the cache like this:
|
||||||
|
|
||||||
|
kill -SIGHUP $(pidof rclone)
|
||||||
|
|
||||||
|
If you configure rclone with a [remote control](/rc) then you can use
|
||||||
|
rclone rc to flush the whole directory cache:
|
||||||
|
|
||||||
|
rclone rc vfs/forget
|
||||||
|
|
||||||
|
Or individual files or directories:
|
||||||
|
|
||||||
|
rclone rc vfs/forget file=path/to/file dir=path/to/dir
|
||||||
|
|
||||||
|
## VFS File Buffering
|
||||||
|
|
||||||
|
The `--buffer-size` flag determines the amount of memory,
|
||||||
|
that will be used to buffer data in advance.
|
||||||
|
|
||||||
|
Each open file will try to keep the specified amount of data in memory
|
||||||
|
at all times. The buffered data is bound to one open file and won't be
|
||||||
|
shared.
|
||||||
|
|
||||||
|
This flag is a upper limit for the used memory per open file. The
|
||||||
|
buffer will only use memory for data that is downloaded but not not
|
||||||
|
yet read. If the buffer is empty, only a small amount of memory will
|
||||||
|
be used.
|
||||||
|
|
||||||
|
The maximum memory used by rclone for buffering can be up to
|
||||||
|
`--buffer-size * open files`.
|
||||||
|
|
||||||
|
## VFS File Caching
|
||||||
|
|
||||||
|
These flags control the VFS file caching options. File caching is
|
||||||
|
necessary to make the VFS layer appear compatible with a normal file
|
||||||
|
system. It can be disabled at the cost of some compatibility.
|
||||||
|
|
||||||
|
For example you'll need to enable VFS caching if you want to read and
|
||||||
|
write simultaneously to a file. See below for more details.
|
||||||
|
|
||||||
|
Note that the VFS cache is separate from the cache backend and you may
|
||||||
|
find that you need one or the other or both.
|
||||||
|
|
||||||
|
--cache-dir string Directory rclone will use for caching.
|
||||||
|
--vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off)
|
||||||
|
--vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||||
|
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||||
|
--vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off)
|
||||||
|
--vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s)
|
||||||
|
--vfs-write-back duration Time to writeback files after last use when using cache (default 5s)
|
||||||
|
|
||||||
|
If run with `-vv` rclone will print the location of the file cache. The
|
||||||
|
files are stored in the user cache file area which is OS dependent but
|
||||||
|
can be controlled with `--cache-dir` or setting the appropriate
|
||||||
|
environment variable.
|
||||||
|
|
||||||
|
The cache has 4 different modes selected by `--vfs-cache-mode`.
|
||||||
|
The higher the cache mode the more compatible rclone becomes at the
|
||||||
|
cost of using disk space.
|
||||||
|
|
||||||
|
Note that files are written back to the remote only when they are
|
||||||
|
closed and if they haven't been accessed for `--vfs-write-back`
|
||||||
|
seconds. If rclone is quit or dies with files that haven't been
|
||||||
|
uploaded, these will be uploaded next time rclone is run with the same
|
||||||
|
flags.
|
||||||
|
|
||||||
|
If using `--vfs-cache-max-size` or `--vfs-cache-min-free-size` note
|
||||||
|
that the cache may exceed these quotas for two reasons. Firstly
|
||||||
|
because it is only checked every `--vfs-cache-poll-interval`. Secondly
|
||||||
|
because open files cannot be evicted from the cache. When
|
||||||
|
`--vfs-cache-max-size` or `--vfs-cache-min-free-size` is exceeded,
|
||||||
|
rclone will attempt to evict the least accessed files from the cache
|
||||||
|
first. rclone will start with files that haven't been accessed for the
|
||||||
|
longest. This cache flushing strategy is efficient and more relevant
|
||||||
|
files are likely to remain cached.
|
||||||
|
|
||||||
|
The `--vfs-cache-max-age` will evict files from the cache
|
||||||
|
after the set time since last access has passed. The default value of
|
||||||
|
1 hour will start evicting files from cache that haven't been accessed
|
||||||
|
for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0
|
||||||
|
and will wait for 1 more hour before evicting. Specify the time with
|
||||||
|
standard notation, s, m, h, d, w .
|
||||||
|
|
||||||
|
You **should not** run two copies of rclone using the same VFS cache
|
||||||
|
with the same or overlapping remotes if using `--vfs-cache-mode > off`.
|
||||||
|
This can potentially cause data corruption if you do. You can work
|
||||||
|
around this by giving each rclone its own cache hierarchy with
|
||||||
|
`--cache-dir`. You don't need to worry about this if the remotes in
|
||||||
|
use don't overlap.
|
||||||
|
|
||||||
|
### --vfs-cache-mode off
|
||||||
|
|
||||||
|
In this mode (the default) the cache will read directly from the remote and write
|
||||||
|
directly to the remote without caching anything on disk.
|
||||||
|
|
||||||
|
This will mean some operations are not possible
|
||||||
|
|
||||||
|
* Files can't be opened for both read AND write
|
||||||
|
* Files opened for write can't be seeked
|
||||||
|
* Existing files opened for write must have O_TRUNC set
|
||||||
|
* Files open for read with O_TRUNC will be opened write only
|
||||||
|
* Files open for write only will behave as if O_TRUNC was supplied
|
||||||
|
* Open modes O_APPEND, O_TRUNC are ignored
|
||||||
|
* If an upload fails it can't be retried
|
||||||
|
|
||||||
|
### --vfs-cache-mode minimal
|
||||||
|
|
||||||
|
This is very similar to "off" except that files opened for read AND
|
||||||
|
write will be buffered to disk. This means that files opened for
|
||||||
|
write will be a lot more compatible, but uses the minimal disk space.
|
||||||
|
|
||||||
|
These operations are not possible
|
||||||
|
|
||||||
|
* Files opened for write only can't be seeked
|
||||||
|
* Existing files opened for write must have O_TRUNC set
|
||||||
|
* Files opened for write only will ignore O_APPEND, O_TRUNC
|
||||||
|
* If an upload fails it can't be retried
|
||||||
|
|
||||||
|
### --vfs-cache-mode writes
|
||||||
|
|
||||||
|
In this mode files opened for read only are still read directly from
|
||||||
|
the remote, write only and read/write files are buffered to disk
|
||||||
|
first.
|
||||||
|
|
||||||
|
This mode should support all normal file system operations.
|
||||||
|
|
||||||
|
If an upload fails it will be retried at exponentially increasing
|
||||||
|
intervals up to 1 minute.
|
||||||
|
|
||||||
|
### --vfs-cache-mode full
|
||||||
|
|
||||||
|
In this mode all reads and writes are buffered to and from disk. When
|
||||||
|
data is read from the remote this is buffered to disk as well.
|
||||||
|
|
||||||
|
In this mode the files in the cache will be sparse files and rclone
|
||||||
|
will keep track of which bits of the files it has downloaded.
|
||||||
|
|
||||||
|
So if an application only reads the starts of each file, then rclone
|
||||||
|
will only buffer the start of the file. These files will appear to be
|
||||||
|
their full size in the cache, but they will be sparse files with only
|
||||||
|
the data that has been downloaded present in them.
|
||||||
|
|
||||||
|
This mode should support all normal file system operations and is
|
||||||
|
otherwise identical to `--vfs-cache-mode` writes.
|
||||||
|
|
||||||
|
When reading a file rclone will read `--buffer-size` plus
|
||||||
|
`--vfs-read-ahead` bytes ahead. The `--buffer-size` is buffered in memory
|
||||||
|
whereas the `--vfs-read-ahead` is buffered on disk.
|
||||||
|
|
||||||
|
When using this mode it is recommended that `--buffer-size` is not set
|
||||||
|
too large and `--vfs-read-ahead` is set large if required.
|
||||||
|
|
||||||
|
**IMPORTANT** not all file systems support sparse files. In particular
|
||||||
|
FAT/exFAT do not. Rclone will perform very badly if the cache
|
||||||
|
directory is on a filesystem which doesn't support sparse files and it
|
||||||
|
will log an ERROR message if one is detected.
|
||||||
|
|
||||||
|
### Fingerprinting
|
||||||
|
|
||||||
|
Various parts of the VFS use fingerprinting to see if a local file
|
||||||
|
copy has changed relative to a remote file. Fingerprints are made
|
||||||
|
from:
|
||||||
|
|
||||||
|
- size
|
||||||
|
- modification time
|
||||||
|
- hash
|
||||||
|
|
||||||
|
where available on an object.
|
||||||
|
|
||||||
|
On some backends some of these attributes are slow to read (they take
|
||||||
|
an extra API call per object, or extra work per object).
|
||||||
|
|
||||||
|
For example `hash` is slow with the `local` and `sftp` backends as
|
||||||
|
they have to read the entire file and hash it, and `modtime` is slow
|
||||||
|
with the `s3`, `swift`, `ftp` and `qinqstor` backends because they
|
||||||
|
need to do an extra API call to fetch it.
|
||||||
|
|
||||||
|
If you use the `--vfs-fast-fingerprint` flag then rclone will not
|
||||||
|
include the slow operations in the fingerprint. This makes the
|
||||||
|
fingerprinting less accurate but much faster and will improve the
|
||||||
|
opening time of cached files.
|
||||||
|
|
||||||
|
If you are running a vfs cache over `local`, `s3` or `swift` backends
|
||||||
|
then using this flag is recommended.
|
||||||
|
|
||||||
|
Note that if you change the value of this flag, the fingerprints of
|
||||||
|
the files in the cache may be invalidated and the files will need to
|
||||||
|
be downloaded again.
|
||||||
|
|
||||||
|
## VFS Chunked Reading
|
||||||
|
|
||||||
|
When rclone reads files from a remote it reads them in chunks. This
|
||||||
|
means that rather than requesting the whole file rclone reads the
|
||||||
|
chunk specified. This can reduce the used download quota for some
|
||||||
|
remotes by requesting only chunks from the remote that are actually
|
||||||
|
read, at the cost of an increased number of requests.
|
||||||
|
|
||||||
|
These flags control the chunking:
|
||||||
|
|
||||||
|
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128M)
|
||||||
|
--vfs-read-chunk-size-limit SizeSuffix Max chunk doubling size (default off)
|
||||||
|
|
||||||
|
Rclone will start reading a chunk of size `--vfs-read-chunk-size`,
|
||||||
|
and then double the size for each read. When `--vfs-read-chunk-size-limit` is
|
||||||
|
specified, and greater than `--vfs-read-chunk-size`, the chunk size for each
|
||||||
|
open file will get doubled only until the specified value is reached. If the
|
||||||
|
value is "off", which is the default, the limit is disabled and the chunk size
|
||||||
|
will grow indefinitely.
|
||||||
|
|
||||||
|
With `--vfs-read-chunk-size 100M` and `--vfs-read-chunk-size-limit 0`
|
||||||
|
the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on.
|
||||||
|
When `--vfs-read-chunk-size-limit 500M` is specified, the result would be
|
||||||
|
0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on.
|
||||||
|
|
||||||
|
Setting `--vfs-read-chunk-size` to `0` or "off" disables chunked reading.
|
||||||
|
|
||||||
|
## VFS Performance
|
||||||
|
|
||||||
|
These flags may be used to enable/disable features of the VFS for
|
||||||
|
performance or other reasons. See also the [chunked reading](#vfs-chunked-reading)
|
||||||
|
feature.
|
||||||
|
|
||||||
|
In particular S3 and Swift benefit hugely from the `--no-modtime` flag
|
||||||
|
(or use `--use-server-modtime` for a slightly different effect) as each
|
||||||
|
read of the modification time takes a transaction.
|
||||||
|
|
||||||
|
--no-checksum Don't compare checksums on up/download.
|
||||||
|
--no-modtime Don't read/write the modification time (can speed things up).
|
||||||
|
--no-seek Don't allow seeking in files.
|
||||||
|
--read-only Only allow read-only access.
|
||||||
|
|
||||||
|
Sometimes rclone is delivered reads or writes out of order. Rather
|
||||||
|
than seeking rclone will wait a short time for the in sequence read or
|
||||||
|
write to come in. These flags only come into effect when not using an
|
||||||
|
on disk cache file.
|
||||||
|
|
||||||
|
--vfs-read-wait duration Time to wait for in-sequence read before seeking (default 20ms)
|
||||||
|
--vfs-write-wait duration Time to wait for in-sequence write before giving error (default 1s)
|
||||||
|
|
||||||
|
When using VFS write caching (`--vfs-cache-mode` with value writes or full),
|
||||||
|
the global flag `--transfers` can be set to adjust the number of parallel uploads of
|
||||||
|
modified files from the cache (the related global flag `--checkers` has no effect on the VFS).
|
||||||
|
|
||||||
|
--transfers int Number of file transfers to run in parallel (default 4)
|
||||||
|
|
||||||
|
## VFS Case Sensitivity
|
||||||
|
|
||||||
|
Linux file systems are case-sensitive: two files can differ only
|
||||||
|
by case, and the exact case must be used when opening a file.
|
||||||
|
|
||||||
|
File systems in modern Windows are case-insensitive but case-preserving:
|
||||||
|
although existing files can be opened using any case, the exact case used
|
||||||
|
to create the file is preserved and available for programs to query.
|
||||||
|
It is not allowed for two files in the same directory to differ only by case.
|
||||||
|
|
||||||
|
Usually file systems on macOS are case-insensitive. It is possible to make macOS
|
||||||
|
file systems case-sensitive but that is not the default.
|
||||||
|
|
||||||
|
The `--vfs-case-insensitive` VFS flag controls how rclone handles these
|
||||||
|
two cases. If its value is "false", rclone passes file names to the remote
|
||||||
|
as-is. If the flag is "true" (or appears without a value on the
|
||||||
|
command line), rclone may perform a "fixup" as explained below.
|
||||||
|
|
||||||
|
The user may specify a file name to open/delete/rename/etc with a case
|
||||||
|
different than what is stored on the remote. If an argument refers
|
||||||
|
to an existing file with exactly the same name, then the case of the existing
|
||||||
|
file on the disk will be used. However, if a file name with exactly the same
|
||||||
|
name is not found but a name differing only by case exists, rclone will
|
||||||
|
transparently fixup the name. This fixup happens only when an existing file
|
||||||
|
is requested. Case sensitivity of file names created anew by rclone is
|
||||||
|
controlled by the underlying remote.
|
||||||
|
|
||||||
|
Note that case sensitivity of the operating system running rclone (the target)
|
||||||
|
may differ from case sensitivity of a file system presented by rclone (the source).
|
||||||
|
The flag controls whether "fixup" is performed to satisfy the target.
|
||||||
|
|
||||||
|
If the flag is not provided on the command line, then its default value depends
|
||||||
|
on the operating system where rclone runs: "true" on Windows and macOS, "false"
|
||||||
|
otherwise. If the flag is provided without a value, then it is "true".
|
||||||
|
|
||||||
|
The `--no-unicode-normalization` flag controls whether a similar "fixup" is
|
||||||
|
performed for filenames that differ but are [canonically
|
||||||
|
equivalent](https://en.wikipedia.org/wiki/Unicode_equivalence) with respect to
|
||||||
|
unicode. Unicode normalization can be particularly helpful for users of macOS,
|
||||||
|
which prefers form NFD instead of the NFC used by most other platforms. It is
|
||||||
|
therefore highly recommended to keep the default of `false` on macOS, to avoid
|
||||||
|
encoding compatibility issues.
|
||||||
|
|
||||||
|
In the (probably unlikely) event that a directory has multiple duplicate
|
||||||
|
filenames after applying case and unicode normalization, the `--vfs-block-norm-dupes`
|
||||||
|
flag allows hiding these duplicates. This comes with a performance tradeoff, as
|
||||||
|
rclone will have to scan the entire directory for duplicates when listing a
|
||||||
|
directory. For this reason, it is recommended to leave this disabled if not
|
||||||
|
needed. However, macOS users may wish to consider using it, as otherwise, if a
|
||||||
|
remote directory contains both NFC and NFD versions of the same filename, an odd
|
||||||
|
situation will occur: both versions of the file will be visible in the mount,
|
||||||
|
and both will appear to be editable, however, editing either version will
|
||||||
|
actually result in only the NFD version getting edited under the hood. `--vfs-block-
|
||||||
|
norm-dupes` prevents this confusion by detecting this scenario, hiding the
|
||||||
|
duplicates, and logging an error, similar to how this is handled in `rclone
|
||||||
|
sync`.
|
||||||
|
|
||||||
|
## VFS Disk Options
|
||||||
|
|
||||||
|
This flag allows you to manually set the statistics about the filing system.
|
||||||
|
It can be useful when those statistics cannot be read correctly automatically.
|
||||||
|
|
||||||
|
--vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1)
|
||||||
|
|
||||||
|
## Alternate report of used bytes
|
||||||
|
|
||||||
|
Some backends, most notably S3, do not report the amount of bytes used.
|
||||||
|
If you need this information to be available when running `df` on the
|
||||||
|
filesystem, then pass the flag `--vfs-used-is-size` to rclone.
|
||||||
|
With this flag set, instead of relying on the backend to report this
|
||||||
|
information, rclone will scan the whole remote similar to `rclone size`
|
||||||
|
and compute the total used space itself.
|
||||||
|
|
||||||
|
_WARNING._ Contrary to `rclone size`, this flag ignores filters so that the
|
||||||
|
result is accurate. However, this is very inefficient and may cost lots of API
|
||||||
|
calls resulting in extra charges. Use it as a last resort and only with caching.
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
rclone nfsmount remote:path /path/to/mountpoint [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Options
|
||||||
|
|
||||||
|
```
|
||||||
|
--addr string IPaddress:Port or :Port to bind server to
|
||||||
|
--allow-non-empty Allow mounting over a non-empty directory (not supported on Windows)
|
||||||
|
--allow-other Allow access to other users (not supported on Windows)
|
||||||
|
--allow-root Allow access to root user (not supported on Windows)
|
||||||
|
--async-read Use asynchronous reads (not supported on Windows) (default true)
|
||||||
|
--attr-timeout Duration Time for which file/directory attributes are cached (default 1s)
|
||||||
|
--daemon Run mount in background and exit parent process (as background output is suppressed, use --log-file with --log-format=pid,... to monitor) (not supported on Windows)
|
||||||
|
--daemon-timeout Duration Time limit for rclone to respond to kernel (not supported on Windows) (default 0s)
|
||||||
|
--daemon-wait Duration Time to wait for ready mount from daemon (maximum time on Linux, constant sleep time on OSX/BSD) (not supported on Windows) (default 1m0s)
|
||||||
|
--debug-fuse Debug the FUSE internals - needs -v
|
||||||
|
--default-permissions Makes kernel enforce access control based on the file mode (not supported on Windows)
|
||||||
|
--devname string Set the device name - default is remote:path
|
||||||
|
--dir-cache-time Duration Time to cache directory entries for (default 5m0s)
|
||||||
|
--dir-perms FileMode Directory permissions (default 0777)
|
||||||
|
--file-perms FileMode File permissions (default 0666)
|
||||||
|
--fuse-flag stringArray Flags or arguments to be passed direct to libfuse/WinFsp (repeat if required)
|
||||||
|
--gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000)
|
||||||
|
-h, --help help for nfsmount
|
||||||
|
--max-read-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads (not supported on Windows) (default 128Ki)
|
||||||
|
--mount-case-insensitive Tristate Tell the OS the mount is case insensitive (true) or sensitive (false) regardless of the backend (auto) (default unset)
|
||||||
|
--network-mode Mount as remote network drive, instead of fixed disk drive (supported on Windows only)
|
||||||
|
--nfs-cache-handle-limit int max file handles cached simultaneously (min 5) (default 1000000)
|
||||||
|
--no-checksum Don't compare checksums on up/download
|
||||||
|
--no-modtime Don't read/write the modification time (can speed things up)
|
||||||
|
--no-seek Don't allow seeking in files
|
||||||
|
--noappledouble Ignore Apple Double (._) and .DS_Store files (supported on OSX only) (default true)
|
||||||
|
--noapplexattr Ignore all "com.apple.*" extended attributes (supported on OSX only)
|
||||||
|
-o, --option stringArray Option for libfuse/WinFsp (repeat if required)
|
||||||
|
--poll-interval Duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s)
|
||||||
|
--read-only Only allow read-only access
|
||||||
|
--sudo Use sudo to run the mount command as root.
|
||||||
|
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
||||||
|
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
||||||
|
--vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost)
|
||||||
|
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||||
|
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||||
|
--vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off)
|
||||||
|
--vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off)
|
||||||
|
--vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s)
|
||||||
|
--vfs-case-insensitive If a file name not found, find a case insensitive match
|
||||||
|
--vfs-disk-space-total-size SizeSuffix Specify the total space of disk (default off)
|
||||||
|
--vfs-fast-fingerprint Use fast (less accurate) fingerprints for change detection
|
||||||
|
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
|
||||||
|
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi)
|
||||||
|
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off)
|
||||||
|
--vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms)
|
||||||
|
--vfs-refresh Refreshes the directory cache recursively in the background on start
|
||||||
|
--vfs-used-is-size rclone size Use the rclone size algorithm for Used size
|
||||||
|
--vfs-write-back Duration Time to writeback files after last use when using cache (default 5s)
|
||||||
|
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
|
||||||
|
--volname string Set the volume name (supported on Windows and OSX only)
|
||||||
|
--write-back-cache Makes kernel buffer writes before sending them to rclone (without this, writethrough caching is used) (not supported on Windows)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## Filter Options
|
||||||
|
|
||||||
|
Flags for filtering directory listings.
|
||||||
|
|
||||||
|
```
|
||||||
|
--delete-excluded Delete files on dest excluded from sync
|
||||||
|
--exclude stringArray Exclude files matching pattern
|
||||||
|
--exclude-from stringArray Read file exclude patterns from file (use - to read from stdin)
|
||||||
|
--exclude-if-present stringArray Exclude directories if filename is present
|
||||||
|
--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)
|
||||||
|
-f, --filter stringArray Add a file filtering rule
|
||||||
|
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
|
||||||
|
--ignore-case Ignore case in filters (case insensitive)
|
||||||
|
--include stringArray Include files matching pattern
|
||||||
|
--include-from stringArray Read file include patterns from file (use - to read from stdin)
|
||||||
|
--max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
|
||||||
|
--max-depth int If set limits the recursion depth to this (default -1)
|
||||||
|
--max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
|
||||||
|
--metadata-exclude stringArray Exclude metadatas matching pattern
|
||||||
|
--metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin)
|
||||||
|
--metadata-filter stringArray Add a metadata filtering rule
|
||||||
|
--metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin)
|
||||||
|
--metadata-include stringArray Include metadatas matching pattern
|
||||||
|
--metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin)
|
||||||
|
--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 KiB or suffix B|K|M|G|T|P (default off)
|
||||||
|
```
|
||||||
|
|
||||||
|
See the [global flags page](/flags/) for global options not listed here.
|
||||||
|
|
||||||
|
# SEE ALSO
|
||||||
|
|
||||||
|
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.
|
||||||
|
|
||||||
|
|
@ -347,6 +347,28 @@ If the flag is not provided on the command line, then its default value depends
|
||||||
on the operating system where rclone runs: "true" on Windows and macOS, "false"
|
on the operating system where rclone runs: "true" on Windows and macOS, "false"
|
||||||
otherwise. If the flag is provided without a value, then it is "true".
|
otherwise. If the flag is provided without a value, then it is "true".
|
||||||
|
|
||||||
|
The `--no-unicode-normalization` flag controls whether a similar "fixup" is
|
||||||
|
performed for filenames that differ but are [canonically
|
||||||
|
equivalent](https://en.wikipedia.org/wiki/Unicode_equivalence) with respect to
|
||||||
|
unicode. Unicode normalization can be particularly helpful for users of macOS,
|
||||||
|
which prefers form NFD instead of the NFC used by most other platforms. It is
|
||||||
|
therefore highly recommended to keep the default of `false` on macOS, to avoid
|
||||||
|
encoding compatibility issues.
|
||||||
|
|
||||||
|
In the (probably unlikely) event that a directory has multiple duplicate
|
||||||
|
filenames after applying case and unicode normalization, the `--vfs-block-norm-dupes`
|
||||||
|
flag allows hiding these duplicates. This comes with a performance tradeoff, as
|
||||||
|
rclone will have to scan the entire directory for duplicates when listing a
|
||||||
|
directory. For this reason, it is recommended to leave this disabled if not
|
||||||
|
needed. However, macOS users may wish to consider using it, as otherwise, if a
|
||||||
|
remote directory contains both NFC and NFD versions of the same filename, an odd
|
||||||
|
situation will occur: both versions of the file will be visible in the mount,
|
||||||
|
and both will appear to be editable, however, editing either version will
|
||||||
|
actually result in only the NFD version getting edited under the hood. `--vfs-block-
|
||||||
|
norm-dupes` prevents this confusion by detecting this scenario, hiding the
|
||||||
|
duplicates, and logging an error, similar to how this is handled in `rclone
|
||||||
|
sync`.
|
||||||
|
|
||||||
## VFS Disk Options
|
## VFS Disk Options
|
||||||
|
|
||||||
This flag allows you to manually set the statistics about the filing system.
|
This flag allows you to manually set the statistics about the filing system.
|
||||||
|
|
@ -392,6 +414,7 @@ rclone serve dlna remote:path [flags]
|
||||||
--read-only Only allow read-only access
|
--read-only Only allow read-only access
|
||||||
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
||||||
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
||||||
|
--vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost)
|
||||||
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||||
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||||
--vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off)
|
--vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off)
|
||||||
|
|
@ -404,7 +427,7 @@ rclone serve dlna remote:path [flags]
|
||||||
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi)
|
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi)
|
||||||
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off)
|
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off)
|
||||||
--vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms)
|
--vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms)
|
||||||
--vfs-refresh Refreshes the directory cache recursively on start
|
--vfs-refresh Refreshes the directory cache recursively in the background on start
|
||||||
--vfs-used-is-size rclone size Use the rclone size algorithm for Used size
|
--vfs-used-is-size rclone size Use the rclone size algorithm for Used size
|
||||||
--vfs-write-back Duration Time to writeback files after last use when using cache (default 5s)
|
--vfs-write-back Duration Time to writeback files after last use when using cache (default 5s)
|
||||||
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
|
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
|
||||||
|
|
|
||||||
|
|
@ -362,6 +362,28 @@ If the flag is not provided on the command line, then its default value depends
|
||||||
on the operating system where rclone runs: "true" on Windows and macOS, "false"
|
on the operating system where rclone runs: "true" on Windows and macOS, "false"
|
||||||
otherwise. If the flag is provided without a value, then it is "true".
|
otherwise. If the flag is provided without a value, then it is "true".
|
||||||
|
|
||||||
|
The `--no-unicode-normalization` flag controls whether a similar "fixup" is
|
||||||
|
performed for filenames that differ but are [canonically
|
||||||
|
equivalent](https://en.wikipedia.org/wiki/Unicode_equivalence) with respect to
|
||||||
|
unicode. Unicode normalization can be particularly helpful for users of macOS,
|
||||||
|
which prefers form NFD instead of the NFC used by most other platforms. It is
|
||||||
|
therefore highly recommended to keep the default of `false` on macOS, to avoid
|
||||||
|
encoding compatibility issues.
|
||||||
|
|
||||||
|
In the (probably unlikely) event that a directory has multiple duplicate
|
||||||
|
filenames after applying case and unicode normalization, the `--vfs-block-norm-dupes`
|
||||||
|
flag allows hiding these duplicates. This comes with a performance tradeoff, as
|
||||||
|
rclone will have to scan the entire directory for duplicates when listing a
|
||||||
|
directory. For this reason, it is recommended to leave this disabled if not
|
||||||
|
needed. However, macOS users may wish to consider using it, as otherwise, if a
|
||||||
|
remote directory contains both NFC and NFD versions of the same filename, an odd
|
||||||
|
situation will occur: both versions of the file will be visible in the mount,
|
||||||
|
and both will appear to be editable, however, editing either version will
|
||||||
|
actually result in only the NFD version getting edited under the hood. `--vfs-block-
|
||||||
|
norm-dupes` prevents this confusion by detecting this scenario, hiding the
|
||||||
|
duplicates, and logging an error, similar to how this is handled in `rclone
|
||||||
|
sync`.
|
||||||
|
|
||||||
## VFS Disk Options
|
## VFS Disk Options
|
||||||
|
|
||||||
This flag allows you to manually set the statistics about the filing system.
|
This flag allows you to manually set the statistics about the filing system.
|
||||||
|
|
@ -425,6 +447,7 @@ rclone serve docker [flags]
|
||||||
--socket-gid int GID for unix socket (default: current process GID) (default 1000)
|
--socket-gid int GID for unix socket (default: current process GID) (default 1000)
|
||||||
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
||||||
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
||||||
|
--vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost)
|
||||||
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||||
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||||
--vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off)
|
--vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off)
|
||||||
|
|
@ -437,7 +460,7 @@ rclone serve docker [flags]
|
||||||
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi)
|
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi)
|
||||||
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off)
|
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off)
|
||||||
--vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms)
|
--vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms)
|
||||||
--vfs-refresh Refreshes the directory cache recursively on start
|
--vfs-refresh Refreshes the directory cache recursively in the background on start
|
||||||
--vfs-used-is-size rclone size Use the rclone size algorithm for Used size
|
--vfs-used-is-size rclone size Use the rclone size algorithm for Used size
|
||||||
--vfs-write-back Duration Time to writeback files after last use when using cache (default 5s)
|
--vfs-write-back Duration Time to writeback files after last use when using cache (default 5s)
|
||||||
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
|
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
|
||||||
|
|
|
||||||
|
|
@ -344,6 +344,28 @@ If the flag is not provided on the command line, then its default value depends
|
||||||
on the operating system where rclone runs: "true" on Windows and macOS, "false"
|
on the operating system where rclone runs: "true" on Windows and macOS, "false"
|
||||||
otherwise. If the flag is provided without a value, then it is "true".
|
otherwise. If the flag is provided without a value, then it is "true".
|
||||||
|
|
||||||
|
The `--no-unicode-normalization` flag controls whether a similar "fixup" is
|
||||||
|
performed for filenames that differ but are [canonically
|
||||||
|
equivalent](https://en.wikipedia.org/wiki/Unicode_equivalence) with respect to
|
||||||
|
unicode. Unicode normalization can be particularly helpful for users of macOS,
|
||||||
|
which prefers form NFD instead of the NFC used by most other platforms. It is
|
||||||
|
therefore highly recommended to keep the default of `false` on macOS, to avoid
|
||||||
|
encoding compatibility issues.
|
||||||
|
|
||||||
|
In the (probably unlikely) event that a directory has multiple duplicate
|
||||||
|
filenames after applying case and unicode normalization, the `--vfs-block-norm-dupes`
|
||||||
|
flag allows hiding these duplicates. This comes with a performance tradeoff, as
|
||||||
|
rclone will have to scan the entire directory for duplicates when listing a
|
||||||
|
directory. For this reason, it is recommended to leave this disabled if not
|
||||||
|
needed. However, macOS users may wish to consider using it, as otherwise, if a
|
||||||
|
remote directory contains both NFC and NFD versions of the same filename, an odd
|
||||||
|
situation will occur: both versions of the file will be visible in the mount,
|
||||||
|
and both will appear to be editable, however, editing either version will
|
||||||
|
actually result in only the NFD version getting edited under the hood. `--vfs-block-
|
||||||
|
norm-dupes` prevents this confusion by detecting this scenario, hiding the
|
||||||
|
duplicates, and logging an error, similar to how this is handled in `rclone
|
||||||
|
sync`.
|
||||||
|
|
||||||
## VFS Disk Options
|
## VFS Disk Options
|
||||||
|
|
||||||
This flag allows you to manually set the statistics about the filing system.
|
This flag allows you to manually set the statistics about the filing system.
|
||||||
|
|
@ -376,7 +398,7 @@ together, if `--auth-proxy` is set the authorized keys option will be
|
||||||
ignored.
|
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/bin/test_proxy.py)
|
||||||
in the rclone source code.
|
in the rclone source code.
|
||||||
|
|
||||||
The program's job is to take a `user` and `pass` on the input and turn
|
The program's job is to take a `user` and `pass` on the input and turn
|
||||||
|
|
@ -473,6 +495,7 @@ rclone serve ftp remote:path [flags]
|
||||||
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
||||||
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
||||||
--user string User name for authentication (default "anonymous")
|
--user string User name for authentication (default "anonymous")
|
||||||
|
--vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost)
|
||||||
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||||
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||||
--vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off)
|
--vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off)
|
||||||
|
|
@ -485,7 +508,7 @@ rclone serve ftp remote:path [flags]
|
||||||
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi)
|
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi)
|
||||||
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off)
|
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off)
|
||||||
--vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms)
|
--vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms)
|
||||||
--vfs-refresh Refreshes the directory cache recursively on start
|
--vfs-refresh Refreshes the directory cache recursively in the background on start
|
||||||
--vfs-used-is-size rclone size Use the rclone size algorithm for Used size
|
--vfs-used-is-size rclone size Use the rclone size algorithm for Used size
|
||||||
--vfs-write-back Duration Time to writeback files after last use when using cache (default 5s)
|
--vfs-write-back Duration Time to writeback files after last use when using cache (default 5s)
|
||||||
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
|
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
|
||||||
|
|
|
||||||
|
|
@ -445,6 +445,28 @@ If the flag is not provided on the command line, then its default value depends
|
||||||
on the operating system where rclone runs: "true" on Windows and macOS, "false"
|
on the operating system where rclone runs: "true" on Windows and macOS, "false"
|
||||||
otherwise. If the flag is provided without a value, then it is "true".
|
otherwise. If the flag is provided without a value, then it is "true".
|
||||||
|
|
||||||
|
The `--no-unicode-normalization` flag controls whether a similar "fixup" is
|
||||||
|
performed for filenames that differ but are [canonically
|
||||||
|
equivalent](https://en.wikipedia.org/wiki/Unicode_equivalence) with respect to
|
||||||
|
unicode. Unicode normalization can be particularly helpful for users of macOS,
|
||||||
|
which prefers form NFD instead of the NFC used by most other platforms. It is
|
||||||
|
therefore highly recommended to keep the default of `false` on macOS, to avoid
|
||||||
|
encoding compatibility issues.
|
||||||
|
|
||||||
|
In the (probably unlikely) event that a directory has multiple duplicate
|
||||||
|
filenames after applying case and unicode normalization, the `--vfs-block-norm-dupes`
|
||||||
|
flag allows hiding these duplicates. This comes with a performance tradeoff, as
|
||||||
|
rclone will have to scan the entire directory for duplicates when listing a
|
||||||
|
directory. For this reason, it is recommended to leave this disabled if not
|
||||||
|
needed. However, macOS users may wish to consider using it, as otherwise, if a
|
||||||
|
remote directory contains both NFC and NFD versions of the same filename, an odd
|
||||||
|
situation will occur: both versions of the file will be visible in the mount,
|
||||||
|
and both will appear to be editable, however, editing either version will
|
||||||
|
actually result in only the NFD version getting edited under the hood. `--vfs-block-
|
||||||
|
norm-dupes` prevents this confusion by detecting this scenario, hiding the
|
||||||
|
duplicates, and logging an error, similar to how this is handled in `rclone
|
||||||
|
sync`.
|
||||||
|
|
||||||
## VFS Disk Options
|
## VFS Disk Options
|
||||||
|
|
||||||
This flag allows you to manually set the statistics about the filing system.
|
This flag allows you to manually set the statistics about the filing system.
|
||||||
|
|
@ -477,7 +499,7 @@ together, if `--auth-proxy` is set the authorized keys option will be
|
||||||
ignored.
|
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/bin/test_proxy.py)
|
||||||
in the rclone source code.
|
in the rclone source code.
|
||||||
|
|
||||||
The program's job is to take a `user` and `pass` on the input and turn
|
The program's job is to take a `user` and `pass` on the input and turn
|
||||||
|
|
@ -583,6 +605,7 @@ rclone serve http remote:path [flags]
|
||||||
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
||||||
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
||||||
--user string User name for authentication
|
--user string User name for authentication
|
||||||
|
--vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost)
|
||||||
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||||
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||||
--vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off)
|
--vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off)
|
||||||
|
|
@ -595,7 +618,7 @@ rclone serve http remote:path [flags]
|
||||||
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi)
|
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi)
|
||||||
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off)
|
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off)
|
||||||
--vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms)
|
--vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms)
|
||||||
--vfs-refresh Refreshes the directory cache recursively on start
|
--vfs-refresh Refreshes the directory cache recursively in the background on start
|
||||||
--vfs-used-is-size rclone size Use the rclone size algorithm for Used size
|
--vfs-used-is-size rclone size Use the rclone size algorithm for Used size
|
||||||
--vfs-write-back Duration Time to writeback files after last use when using cache (default 5s)
|
--vfs-write-back Duration Time to writeback files after last use when using cache (default 5s)
|
||||||
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
|
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
|
||||||
|
|
|
||||||
|
|
@ -4,6 +4,7 @@ description: "Serve the remote as an NFS mount"
|
||||||
slug: rclone_serve_nfs
|
slug: rclone_serve_nfs
|
||||||
url: /commands/rclone_serve_nfs/
|
url: /commands/rclone_serve_nfs/
|
||||||
groups: Filter
|
groups: Filter
|
||||||
|
status: Experimental
|
||||||
versionIntroduced: v1.65
|
versionIntroduced: v1.65
|
||||||
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/serve/nfs/ and as part of making a release run "make commanddocs"
|
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/serve/nfs/ and as part of making a release run "make commanddocs"
|
||||||
---
|
---
|
||||||
|
|
@ -26,7 +27,9 @@ NFS mount over local network, you need to specify the listening address and port
|
||||||
|
|
||||||
Modifying files through NFS protocol requires VFS caching. Usually you will need to specify `--vfs-cache-mode`
|
Modifying files through NFS protocol requires VFS caching. Usually you will need to specify `--vfs-cache-mode`
|
||||||
in order to be able to write to the mountpoint (full is recommended). If you don't specify VFS cache mode,
|
in order to be able to write to the mountpoint (full is recommended). If you don't specify VFS cache mode,
|
||||||
the mount will be read-only.
|
the mount will be read-only. Note also that `--nfs-cache-handle-limit` controls the maximum number of cached file handles stored by the caching handler.
|
||||||
|
This should not be set too low or you may experience errors when trying to access files. The default is `1000000`, but consider lowering this limit if
|
||||||
|
the server's system resource usage causes problems.
|
||||||
|
|
||||||
To serve NFS over the network use following command:
|
To serve NFS over the network use following command:
|
||||||
|
|
||||||
|
|
@ -353,6 +356,28 @@ If the flag is not provided on the command line, then its default value depends
|
||||||
on the operating system where rclone runs: "true" on Windows and macOS, "false"
|
on the operating system where rclone runs: "true" on Windows and macOS, "false"
|
||||||
otherwise. If the flag is provided without a value, then it is "true".
|
otherwise. If the flag is provided without a value, then it is "true".
|
||||||
|
|
||||||
|
The `--no-unicode-normalization` flag controls whether a similar "fixup" is
|
||||||
|
performed for filenames that differ but are [canonically
|
||||||
|
equivalent](https://en.wikipedia.org/wiki/Unicode_equivalence) with respect to
|
||||||
|
unicode. Unicode normalization can be particularly helpful for users of macOS,
|
||||||
|
which prefers form NFD instead of the NFC used by most other platforms. It is
|
||||||
|
therefore highly recommended to keep the default of `false` on macOS, to avoid
|
||||||
|
encoding compatibility issues.
|
||||||
|
|
||||||
|
In the (probably unlikely) event that a directory has multiple duplicate
|
||||||
|
filenames after applying case and unicode normalization, the `--vfs-block-norm-dupes`
|
||||||
|
flag allows hiding these duplicates. This comes with a performance tradeoff, as
|
||||||
|
rclone will have to scan the entire directory for duplicates when listing a
|
||||||
|
directory. For this reason, it is recommended to leave this disabled if not
|
||||||
|
needed. However, macOS users may wish to consider using it, as otherwise, if a
|
||||||
|
remote directory contains both NFC and NFD versions of the same filename, an odd
|
||||||
|
situation will occur: both versions of the file will be visible in the mount,
|
||||||
|
and both will appear to be editable, however, editing either version will
|
||||||
|
actually result in only the NFD version getting edited under the hood. `--vfs-block-
|
||||||
|
norm-dupes` prevents this confusion by detecting this scenario, hiding the
|
||||||
|
duplicates, and logging an error, similar to how this is handled in `rclone
|
||||||
|
sync`.
|
||||||
|
|
||||||
## VFS Disk Options
|
## VFS Disk Options
|
||||||
|
|
||||||
This flag allows you to manually set the statistics about the filing system.
|
This flag allows you to manually set the statistics about the filing system.
|
||||||
|
|
@ -387,6 +412,7 @@ rclone serve nfs remote:path [flags]
|
||||||
--file-perms FileMode File permissions (default 0666)
|
--file-perms FileMode File permissions (default 0666)
|
||||||
--gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000)
|
--gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000)
|
||||||
-h, --help help for nfs
|
-h, --help help for nfs
|
||||||
|
--nfs-cache-handle-limit int max file handles cached simultaneously (min 5) (default 1000000)
|
||||||
--no-checksum Don't compare checksums on up/download
|
--no-checksum Don't compare checksums on up/download
|
||||||
--no-modtime Don't read/write the modification time (can speed things up)
|
--no-modtime Don't read/write the modification time (can speed things up)
|
||||||
--no-seek Don't allow seeking in files
|
--no-seek Don't allow seeking in files
|
||||||
|
|
@ -394,6 +420,7 @@ rclone serve nfs remote:path [flags]
|
||||||
--read-only Only allow read-only access
|
--read-only Only allow read-only access
|
||||||
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
||||||
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
||||||
|
--vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost)
|
||||||
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||||
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||||
--vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off)
|
--vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off)
|
||||||
|
|
@ -406,7 +433,7 @@ rclone serve nfs remote:path [flags]
|
||||||
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi)
|
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi)
|
||||||
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off)
|
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off)
|
||||||
--vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms)
|
--vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms)
|
||||||
--vfs-refresh Refreshes the directory cache recursively on start
|
--vfs-refresh Refreshes the directory cache recursively in the background on start
|
||||||
--vfs-used-is-size rclone size Use the rclone size algorithm for Used size
|
--vfs-used-is-size rclone size Use the rclone size algorithm for Used size
|
||||||
--vfs-write-back Duration Time to writeback files after last use when using cache (default 5s)
|
--vfs-write-back Duration Time to writeback files after last use when using cache (default 5s)
|
||||||
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
|
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
|
||||||
|
|
|
||||||
|
|
@ -487,6 +487,28 @@ If the flag is not provided on the command line, then its default value depends
|
||||||
on the operating system where rclone runs: "true" on Windows and macOS, "false"
|
on the operating system where rclone runs: "true" on Windows and macOS, "false"
|
||||||
otherwise. If the flag is provided without a value, then it is "true".
|
otherwise. If the flag is provided without a value, then it is "true".
|
||||||
|
|
||||||
|
The `--no-unicode-normalization` flag controls whether a similar "fixup" is
|
||||||
|
performed for filenames that differ but are [canonically
|
||||||
|
equivalent](https://en.wikipedia.org/wiki/Unicode_equivalence) with respect to
|
||||||
|
unicode. Unicode normalization can be particularly helpful for users of macOS,
|
||||||
|
which prefers form NFD instead of the NFC used by most other platforms. It is
|
||||||
|
therefore highly recommended to keep the default of `false` on macOS, to avoid
|
||||||
|
encoding compatibility issues.
|
||||||
|
|
||||||
|
In the (probably unlikely) event that a directory has multiple duplicate
|
||||||
|
filenames after applying case and unicode normalization, the `--vfs-block-norm-dupes`
|
||||||
|
flag allows hiding these duplicates. This comes with a performance tradeoff, as
|
||||||
|
rclone will have to scan the entire directory for duplicates when listing a
|
||||||
|
directory. For this reason, it is recommended to leave this disabled if not
|
||||||
|
needed. However, macOS users may wish to consider using it, as otherwise, if a
|
||||||
|
remote directory contains both NFC and NFD versions of the same filename, an odd
|
||||||
|
situation will occur: both versions of the file will be visible in the mount,
|
||||||
|
and both will appear to be editable, however, editing either version will
|
||||||
|
actually result in only the NFD version getting edited under the hood. `--vfs-block-
|
||||||
|
norm-dupes` prevents this confusion by detecting this scenario, hiding the
|
||||||
|
duplicates, and logging an error, similar to how this is handled in `rclone
|
||||||
|
sync`.
|
||||||
|
|
||||||
## VFS Disk Options
|
## VFS Disk Options
|
||||||
|
|
||||||
This flag allows you to manually set the statistics about the filing system.
|
This flag allows you to manually set the statistics about the filing system.
|
||||||
|
|
@ -541,6 +563,7 @@ rclone serve s3 remote:path [flags]
|
||||||
--server-write-timeout Duration Timeout for server writing data (default 1h0m0s)
|
--server-write-timeout Duration Timeout for server writing data (default 1h0m0s)
|
||||||
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
||||||
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
||||||
|
--vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost)
|
||||||
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||||
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||||
--vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off)
|
--vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off)
|
||||||
|
|
@ -553,7 +576,7 @@ rclone serve s3 remote:path [flags]
|
||||||
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi)
|
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi)
|
||||||
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off)
|
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off)
|
||||||
--vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms)
|
--vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms)
|
||||||
--vfs-refresh Refreshes the directory cache recursively on start
|
--vfs-refresh Refreshes the directory cache recursively in the background on start
|
||||||
--vfs-used-is-size rclone size Use the rclone size algorithm for Used size
|
--vfs-used-is-size rclone size Use the rclone size algorithm for Used size
|
||||||
--vfs-write-back Duration Time to writeback files after last use when using cache (default 5s)
|
--vfs-write-back Duration Time to writeback files after last use when using cache (default 5s)
|
||||||
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
|
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
|
||||||
|
|
|
||||||
|
|
@ -376,6 +376,28 @@ If the flag is not provided on the command line, then its default value depends
|
||||||
on the operating system where rclone runs: "true" on Windows and macOS, "false"
|
on the operating system where rclone runs: "true" on Windows and macOS, "false"
|
||||||
otherwise. If the flag is provided without a value, then it is "true".
|
otherwise. If the flag is provided without a value, then it is "true".
|
||||||
|
|
||||||
|
The `--no-unicode-normalization` flag controls whether a similar "fixup" is
|
||||||
|
performed for filenames that differ but are [canonically
|
||||||
|
equivalent](https://en.wikipedia.org/wiki/Unicode_equivalence) with respect to
|
||||||
|
unicode. Unicode normalization can be particularly helpful for users of macOS,
|
||||||
|
which prefers form NFD instead of the NFC used by most other platforms. It is
|
||||||
|
therefore highly recommended to keep the default of `false` on macOS, to avoid
|
||||||
|
encoding compatibility issues.
|
||||||
|
|
||||||
|
In the (probably unlikely) event that a directory has multiple duplicate
|
||||||
|
filenames after applying case and unicode normalization, the `--vfs-block-norm-dupes`
|
||||||
|
flag allows hiding these duplicates. This comes with a performance tradeoff, as
|
||||||
|
rclone will have to scan the entire directory for duplicates when listing a
|
||||||
|
directory. For this reason, it is recommended to leave this disabled if not
|
||||||
|
needed. However, macOS users may wish to consider using it, as otherwise, if a
|
||||||
|
remote directory contains both NFC and NFD versions of the same filename, an odd
|
||||||
|
situation will occur: both versions of the file will be visible in the mount,
|
||||||
|
and both will appear to be editable, however, editing either version will
|
||||||
|
actually result in only the NFD version getting edited under the hood. `--vfs-block-
|
||||||
|
norm-dupes` prevents this confusion by detecting this scenario, hiding the
|
||||||
|
duplicates, and logging an error, similar to how this is handled in `rclone
|
||||||
|
sync`.
|
||||||
|
|
||||||
## VFS Disk Options
|
## VFS Disk Options
|
||||||
|
|
||||||
This flag allows you to manually set the statistics about the filing system.
|
This flag allows you to manually set the statistics about the filing system.
|
||||||
|
|
@ -408,7 +430,7 @@ together, if `--auth-proxy` is set the authorized keys option will be
|
||||||
ignored.
|
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/bin/test_proxy.py)
|
||||||
in the rclone source code.
|
in the rclone source code.
|
||||||
|
|
||||||
The program's job is to take a `user` and `pass` on the input and turn
|
The program's job is to take a `user` and `pass` on the input and turn
|
||||||
|
|
@ -505,6 +527,7 @@ rclone serve sftp remote:path [flags]
|
||||||
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
||||||
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
||||||
--user string User name for authentication
|
--user string User name for authentication
|
||||||
|
--vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost)
|
||||||
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||||
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||||
--vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off)
|
--vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off)
|
||||||
|
|
@ -517,7 +540,7 @@ rclone serve sftp remote:path [flags]
|
||||||
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi)
|
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi)
|
||||||
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off)
|
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off)
|
||||||
--vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms)
|
--vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms)
|
||||||
--vfs-refresh Refreshes the directory cache recursively on start
|
--vfs-refresh Refreshes the directory cache recursively in the background on start
|
||||||
--vfs-used-is-size rclone size Use the rclone size algorithm for Used size
|
--vfs-used-is-size rclone size Use the rclone size algorithm for Used size
|
||||||
--vfs-write-back Duration Time to writeback files after last use when using cache (default 5s)
|
--vfs-write-back Duration Time to writeback files after last use when using cache (default 5s)
|
||||||
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
|
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
|
||||||
|
|
|
||||||
|
|
@ -474,6 +474,28 @@ If the flag is not provided on the command line, then its default value depends
|
||||||
on the operating system where rclone runs: "true" on Windows and macOS, "false"
|
on the operating system where rclone runs: "true" on Windows and macOS, "false"
|
||||||
otherwise. If the flag is provided without a value, then it is "true".
|
otherwise. If the flag is provided without a value, then it is "true".
|
||||||
|
|
||||||
|
The `--no-unicode-normalization` flag controls whether a similar "fixup" is
|
||||||
|
performed for filenames that differ but are [canonically
|
||||||
|
equivalent](https://en.wikipedia.org/wiki/Unicode_equivalence) with respect to
|
||||||
|
unicode. Unicode normalization can be particularly helpful for users of macOS,
|
||||||
|
which prefers form NFD instead of the NFC used by most other platforms. It is
|
||||||
|
therefore highly recommended to keep the default of `false` on macOS, to avoid
|
||||||
|
encoding compatibility issues.
|
||||||
|
|
||||||
|
In the (probably unlikely) event that a directory has multiple duplicate
|
||||||
|
filenames after applying case and unicode normalization, the `--vfs-block-norm-dupes`
|
||||||
|
flag allows hiding these duplicates. This comes with a performance tradeoff, as
|
||||||
|
rclone will have to scan the entire directory for duplicates when listing a
|
||||||
|
directory. For this reason, it is recommended to leave this disabled if not
|
||||||
|
needed. However, macOS users may wish to consider using it, as otherwise, if a
|
||||||
|
remote directory contains both NFC and NFD versions of the same filename, an odd
|
||||||
|
situation will occur: both versions of the file will be visible in the mount,
|
||||||
|
and both will appear to be editable, however, editing either version will
|
||||||
|
actually result in only the NFD version getting edited under the hood. `--vfs-block-
|
||||||
|
norm-dupes` prevents this confusion by detecting this scenario, hiding the
|
||||||
|
duplicates, and logging an error, similar to how this is handled in `rclone
|
||||||
|
sync`.
|
||||||
|
|
||||||
## VFS Disk Options
|
## VFS Disk Options
|
||||||
|
|
||||||
This flag allows you to manually set the statistics about the filing system.
|
This flag allows you to manually set the statistics about the filing system.
|
||||||
|
|
@ -614,6 +636,7 @@ rclone serve webdav remote:path [flags]
|
||||||
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
||||||
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
||||||
--user string User name for authentication
|
--user string User name for authentication
|
||||||
|
--vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost)
|
||||||
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||||
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||||
--vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off)
|
--vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off)
|
||||||
|
|
@ -626,7 +649,7 @@ rclone serve webdav remote:path [flags]
|
||||||
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi)
|
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi)
|
||||||
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off)
|
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off)
|
||||||
--vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms)
|
--vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms)
|
||||||
--vfs-refresh Refreshes the directory cache recursively on start
|
--vfs-refresh Refreshes the directory cache recursively in the background on start
|
||||||
--vfs-used-is-size rclone size Use the rclone size algorithm for Used size
|
--vfs-used-is-size rclone size Use the rclone size algorithm for Used size
|
||||||
--vfs-write-back Duration Time to writeback files after last use when using cache (default 5s)
|
--vfs-write-back Duration Time to writeback files after last use when using cache (default 5s)
|
||||||
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
|
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
|
||||||
|
|
|
||||||
|
|
@ -43,15 +43,22 @@ the destination from the sync with a filter rule or by putting an
|
||||||
exclude-if-present file inside the destination directory and sync to a
|
exclude-if-present file inside the destination directory and sync to a
|
||||||
destination that is inside the source directory.
|
destination that is inside the source directory.
|
||||||
|
|
||||||
|
Rclone will sync the modification times of files and directories if
|
||||||
|
the backend supports it. If metadata syncing is required then use the
|
||||||
|
`--metadata` flag.
|
||||||
|
|
||||||
|
Note that the modification time and metadata for the root directory
|
||||||
|
will **not** be synced. See https://github.com/rclone/rclone/issues/7652
|
||||||
|
for more info.
|
||||||
|
|
||||||
**Note**: Use the `-P`/`--progress` flag to view real-time transfer statistics
|
**Note**: Use the `-P`/`--progress` flag to view real-time transfer statistics
|
||||||
|
|
||||||
**Note**: Use the `rclone dedupe` command to deal with "Duplicate object/directory found in source/destination - ignoring" errors.
|
**Note**: Use the `rclone dedupe` command to deal with "Duplicate object/directory found in source/destination - ignoring" errors.
|
||||||
See [this forum post](https://forum.rclone.org/t/sync-not-clearing-duplicates/14372) for more info.
|
See [this forum post](https://forum.rclone.org/t/sync-not-clearing-duplicates/14372) for more info.
|
||||||
|
|
||||||
## Logger Flags
|
# Logger Flags
|
||||||
|
|
||||||
The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match`
|
The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match` and `--error` flags write paths, one per line, to the file name (or
|
||||||
and `--error` flags write paths, one per line, to the file name (or
|
|
||||||
stdout if it is `-`) supplied. What they write is described in the
|
stdout if it is `-`) supplied. What they write is described in the
|
||||||
help below. For example `--differ` will write all paths which are
|
help below. For example `--differ` will write all paths which are
|
||||||
present on both the source and destination but different.
|
present on both the source and destination but different.
|
||||||
|
|
@ -86,6 +93,7 @@ Note also that each file is logged during the sync, as opposed to after, so it
|
||||||
is most useful as a predictor of what SHOULD happen to each file
|
is most useful as a predictor of what SHOULD happen to each file
|
||||||
(which may or may not match what actually DID.)
|
(which may or may not match what actually DID.)
|
||||||
|
|
||||||
|
|
||||||
```
|
```
|
||||||
rclone sync source:path dest:path [flags]
|
rclone sync source:path dest:path [flags]
|
||||||
```
|
```
|
||||||
|
|
@ -93,8 +101,24 @@ rclone sync source:path dest:path [flags]
|
||||||
## Options
|
## Options
|
||||||
|
|
||||||
```
|
```
|
||||||
|
--absolute Put a leading / in front of path names
|
||||||
|
--combined string Make a combined report of changes to this file
|
||||||
--create-empty-src-dirs Create empty source dirs on destination after sync
|
--create-empty-src-dirs Create empty source dirs on destination after sync
|
||||||
|
--csv Output in CSV format
|
||||||
|
--dest-after string Report all files that exist on the dest post-sync
|
||||||
|
--differ string Report all non-matching files to this file
|
||||||
|
-d, --dir-slash Append a slash to directory names (default true)
|
||||||
|
--dirs-only Only list directories
|
||||||
|
--error string Report all files with errors (hashing or reading) to this file
|
||||||
|
--files-only Only list files (default true)
|
||||||
|
-F, --format string Output format - see lsf help for details (default "p")
|
||||||
|
--hash h Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default "md5")
|
||||||
-h, --help help for sync
|
-h, --help help for sync
|
||||||
|
--match string Report all matching files to this file
|
||||||
|
--missing-on-dst string Report all files missing from the destination to this file
|
||||||
|
--missing-on-src string Report all files missing from the source to this file
|
||||||
|
-s, --separator string Separator for the items in the format (default ";")
|
||||||
|
-t, --timeformat string Specify a custom time format, or 'max' for max precision supported by remote (default: 2006-01-02 15:04:05)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -112,7 +136,7 @@ Flags for anything which can Copy a file.
|
||||||
--ignore-checksum Skip post copy check of checksums
|
--ignore-checksum Skip post copy check of checksums
|
||||||
--ignore-existing Skip all files that exist on destination
|
--ignore-existing Skip all files that exist on destination
|
||||||
--ignore-size Ignore size when skipping use modtime or checksum
|
--ignore-size Ignore size when skipping use modtime or checksum
|
||||||
-I, --ignore-times Don't skip files that match size and time - transfer all files
|
-I, --ignore-times Don't skip items that match size and time - transfer all unconditionally
|
||||||
--immutable Do not modify files, fail if existing files have been modified
|
--immutable Do not modify files, fail if existing files have been modified
|
||||||
--inplace Download directly to destination file instead of atomic download to temp/rename
|
--inplace Download directly to destination file instead of atomic download to temp/rename
|
||||||
--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)
|
||||||
|
|
@ -126,6 +150,7 @@ Flags for anything which can Copy a file.
|
||||||
--multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki)
|
--multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki)
|
||||||
--no-check-dest Don't check the destination, copy regardless
|
--no-check-dest Don't check the destination, copy regardless
|
||||||
--no-traverse Don't traverse destination file system on copy
|
--no-traverse Don't traverse destination file system on copy
|
||||||
|
--no-update-dir-modtime Don't update directory modification times
|
||||||
--no-update-modtime Don't update destination modtime if files identical
|
--no-update-modtime Don't update destination modtime if files identical
|
||||||
--order-by string Instructions on how to order the transfers, e.g. 'size,descending'
|
--order-by string Instructions on how to order the transfers, e.g. 'size,descending'
|
||||||
--partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial")
|
--partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial")
|
||||||
|
|
@ -145,6 +170,7 @@ Flags just used for `rclone sync`.
|
||||||
--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
|
||||||
--delete-during When synchronizing, delete files during transfer
|
--delete-during When synchronizing, delete files during transfer
|
||||||
|
--fix-case Force rename of case insensitive dest to match source
|
||||||
--ignore-errors Delete even if there are I/O errors
|
--ignore-errors Delete even if there are I/O errors
|
||||||
--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-delete-size SizeSuffix When synchronizing, limit the total size of deletes (default off)
|
--max-delete-size SizeSuffix When synchronizing, limit the total size of deletes (default off)
|
||||||
|
|
|
||||||
|
|
@ -158,6 +158,17 @@ Properties:
|
||||||
- Type: SizeSuffix
|
- Type: SizeSuffix
|
||||||
- Default: 20Mi
|
- Default: 20Mi
|
||||||
|
|
||||||
|
#### --compress-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_COMPRESS_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
### Metadata
|
### Metadata
|
||||||
|
|
||||||
Any metadata supported by the underlying remote is read and written.
|
Any metadata supported by the underlying remote is read and written.
|
||||||
|
|
|
||||||
|
|
@ -579,6 +579,22 @@ Properties:
|
||||||
- Type: bool
|
- Type: bool
|
||||||
- Default: false
|
- Default: false
|
||||||
|
|
||||||
|
#### --crypt-strict-names
|
||||||
|
|
||||||
|
If set, this will raise an error when crypt comes across a filename that can't be decrypted.
|
||||||
|
|
||||||
|
(By default, rclone will just log a NOTICE and continue as normal.)
|
||||||
|
This can happen if encrypted and unencrypted files are stored in the same
|
||||||
|
directory (which is not recommended.) It may also indicate a more serious
|
||||||
|
problem that should be investigated.
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: strict_names
|
||||||
|
- Env Var: RCLONE_CRYPT_STRICT_NAMES
|
||||||
|
- Type: bool
|
||||||
|
- Default: false
|
||||||
|
|
||||||
#### --crypt-filename-encoding
|
#### --crypt-filename-encoding
|
||||||
|
|
||||||
How to encode the encrypted filename to text string.
|
How to encode the encrypted filename to text string.
|
||||||
|
|
@ -616,6 +632,17 @@ Properties:
|
||||||
- Type: string
|
- Type: string
|
||||||
- Default: ".bin"
|
- Default: ".bin"
|
||||||
|
|
||||||
|
#### --crypt-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_CRYPT_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
### Metadata
|
### Metadata
|
||||||
|
|
||||||
Any metadata supported by the underlying remote is read and written.
|
Any metadata supported by the underlying remote is read and written.
|
||||||
|
|
|
||||||
|
|
@ -1386,10 +1386,23 @@ Properties:
|
||||||
- "true"
|
- "true"
|
||||||
- Get GCP IAM credentials from the environment (env vars or IAM).
|
- Get GCP IAM credentials from the environment (env vars or IAM).
|
||||||
|
|
||||||
|
#### --drive-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_DRIVE_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
### Metadata
|
### Metadata
|
||||||
|
|
||||||
User metadata is stored in the properties field of the drive object.
|
User metadata is stored in the properties field of the drive object.
|
||||||
|
|
||||||
|
Metadata is supported on files and directories.
|
||||||
|
|
||||||
Here are the possible system metadata items for the drive backend.
|
Here are the possible system metadata items for the drive backend.
|
||||||
|
|
||||||
| Name | Help | Type | Example | Read Only |
|
| Name | Help | Type | Example | Read Only |
|
||||||
|
|
|
||||||
|
|
@ -453,6 +453,17 @@ Properties:
|
||||||
- Type: Duration
|
- Type: Duration
|
||||||
- Default: 10m0s
|
- Default: 10m0s
|
||||||
|
|
||||||
|
#### --dropbox-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_DROPBOX_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
|
||||||
|
|
@ -195,6 +195,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot
|
- Default: Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot
|
||||||
|
|
||||||
|
#### --fichier-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_FICHIER_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
|
||||||
|
|
@ -274,4 +274,15 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,Del,Ctl,InvalidUtf8,Dot
|
- Default: Slash,Del,Ctl,InvalidUtf8,Dot
|
||||||
|
|
||||||
|
#### --filefabric-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_FILEFABRIC_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
|
||||||
|
|
@ -23,7 +23,7 @@ Flags for anything which can Copy a file.
|
||||||
--ignore-checksum Skip post copy check of checksums
|
--ignore-checksum Skip post copy check of checksums
|
||||||
--ignore-existing Skip all files that exist on destination
|
--ignore-existing Skip all files that exist on destination
|
||||||
--ignore-size Ignore size when skipping use modtime or checksum
|
--ignore-size Ignore size when skipping use modtime or checksum
|
||||||
-I, --ignore-times Don't skip files that match size and time - transfer all files
|
-I, --ignore-times Don't skip items that match size and time - transfer all unconditionally
|
||||||
--immutable Do not modify files, fail if existing files have been modified
|
--immutable Do not modify files, fail if existing files have been modified
|
||||||
--inplace Download directly to destination file instead of atomic download to temp/rename
|
--inplace Download directly to destination file instead of atomic download to temp/rename
|
||||||
--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)
|
||||||
|
|
@ -37,6 +37,7 @@ Flags for anything which can Copy a file.
|
||||||
--multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki)
|
--multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki)
|
||||||
--no-check-dest Don't check the destination, copy regardless
|
--no-check-dest Don't check the destination, copy regardless
|
||||||
--no-traverse Don't traverse destination file system on copy
|
--no-traverse Don't traverse destination file system on copy
|
||||||
|
--no-update-dir-modtime Don't update directory modification times
|
||||||
--no-update-modtime Don't update destination modtime if files identical
|
--no-update-modtime Don't update destination modtime if files identical
|
||||||
--order-by string Instructions on how to order the transfers, e.g. 'size,descending'
|
--order-by string Instructions on how to order the transfers, e.g. 'size,descending'
|
||||||
--partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial")
|
--partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial")
|
||||||
|
|
@ -57,6 +58,7 @@ Flags just used for `rclone sync`.
|
||||||
--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
|
||||||
--delete-during When synchronizing, delete files during transfer
|
--delete-during When synchronizing, delete files during transfer
|
||||||
|
--fix-case Force rename of case insensitive dest to match source
|
||||||
--ignore-errors Delete even if there are I/O errors
|
--ignore-errors Delete even if there are I/O errors
|
||||||
--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-delete-size SizeSuffix When synchronizing, limit the total size of deletes (default off)
|
--max-delete-size SizeSuffix When synchronizing, limit the total size of deletes (default off)
|
||||||
|
|
@ -112,7 +114,7 @@ General networking and HTTP stuff.
|
||||||
--tpslimit float Limit HTTP transactions per second to this
|
--tpslimit float Limit HTTP transactions per second to this
|
||||||
--tpslimit-burst int Max burst of transactions for --tpslimit (default 1)
|
--tpslimit-burst int Max burst of transactions for --tpslimit (default 1)
|
||||||
--use-cookies Enable session cookiejar
|
--use-cookies Enable session cookiejar
|
||||||
--user-agent string Set the user-agent to a specified string (default "rclone/v1.65.0")
|
--user-agent string Set the user-agent to a specified string (default "rclone/v1.66.0")
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -296,14 +298,7 @@ Flags to control the Remote Control API.
|
||||||
Backend only flags. These can be set in the config file also.
|
Backend only flags. These can be set in the config file also.
|
||||||
|
|
||||||
```
|
```
|
||||||
--acd-auth-url string Auth server URL
|
--alias-description string Description of the remote
|
||||||
--acd-client-id string OAuth Client Id
|
|
||||||
--acd-client-secret string OAuth Client Secret
|
|
||||||
--acd-encoding Encoding The encoding for the backend (default Slash,InvalidUtf8,Dot)
|
|
||||||
--acd-templink-threshold SizeSuffix Files >= this size will be downloaded via their tempLink (default 9Gi)
|
|
||||||
--acd-token string OAuth Access Token as a JSON blob
|
|
||||||
--acd-token-url string Token server url
|
|
||||||
--acd-upload-wait-per-gb Duration Additional time per GiB to wait after a failed complete upload to see if it appears (default 3m0s)
|
|
||||||
--alias-remote string Remote or path to alias
|
--alias-remote string Remote or path to alias
|
||||||
--azureblob-access-tier string Access tier of blob: hot, cool, cold or archive
|
--azureblob-access-tier string Access tier of blob: hot, cool, cold or archive
|
||||||
--azureblob-account string Azure Storage Account Name
|
--azureblob-account string Azure Storage Account Name
|
||||||
|
|
@ -314,6 +309,8 @@ Backend only flags. These can be set in the config file also.
|
||||||
--azureblob-client-id string The ID of the client in use
|
--azureblob-client-id string The ID of the client in use
|
||||||
--azureblob-client-secret string One of the service principal's client secrets
|
--azureblob-client-secret string One of the service principal's client secrets
|
||||||
--azureblob-client-send-certificate-chain Send the certificate chain when using certificate auth
|
--azureblob-client-send-certificate-chain Send the certificate chain when using certificate auth
|
||||||
|
--azureblob-delete-snapshots string Set to specify how to deal with snapshots on blob deletion
|
||||||
|
--azureblob-description string Description of the remote
|
||||||
--azureblob-directory-markers Upload an empty object with a trailing slash when a new directory is created
|
--azureblob-directory-markers Upload an empty object with a trailing slash when a new directory is created
|
||||||
--azureblob-disable-checksum Don't store MD5 checksum with object metadata
|
--azureblob-disable-checksum Don't store MD5 checksum with object metadata
|
||||||
--azureblob-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8)
|
--azureblob-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8)
|
||||||
|
|
@ -344,6 +341,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--azurefiles-client-secret string One of the service principal's client secrets
|
--azurefiles-client-secret string One of the service principal's client secrets
|
||||||
--azurefiles-client-send-certificate-chain Send the certificate chain when using certificate auth
|
--azurefiles-client-send-certificate-chain Send the certificate chain when using certificate auth
|
||||||
--azurefiles-connection-string string Azure Files Connection String
|
--azurefiles-connection-string string Azure Files Connection String
|
||||||
|
--azurefiles-description string Description of the remote
|
||||||
--azurefiles-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8,Dot)
|
--azurefiles-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8,Dot)
|
||||||
--azurefiles-endpoint string Endpoint for the service
|
--azurefiles-endpoint string Endpoint for the service
|
||||||
--azurefiles-env-auth Read credentials from runtime (environment variables, CLI or MSI)
|
--azurefiles-env-auth Read credentials from runtime (environment variables, CLI or MSI)
|
||||||
|
|
@ -363,8 +361,9 @@ Backend only flags. These can be set in the config file also.
|
||||||
--b2-account string Account ID or Application Key ID
|
--b2-account string Account ID or Application Key ID
|
||||||
--b2-chunk-size SizeSuffix Upload chunk size (default 96Mi)
|
--b2-chunk-size SizeSuffix Upload chunk size (default 96Mi)
|
||||||
--b2-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4Gi)
|
--b2-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4Gi)
|
||||||
|
--b2-description string Description of the remote
|
||||||
--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 public link 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 Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
--b2-encoding Encoding 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
|
||||||
|
|
@ -383,6 +382,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--box-client-id string OAuth Client Id
|
--box-client-id string OAuth Client Id
|
||||||
--box-client-secret string OAuth Client Secret
|
--box-client-secret string OAuth 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-description string Description of the remote
|
||||||
--box-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot)
|
--box-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot)
|
||||||
--box-impersonate string Impersonate this user ID when using a service account
|
--box-impersonate string Impersonate this user ID when using a service account
|
||||||
--box-list-chunk int Size of listing chunk 1-1000 (default 1000)
|
--box-list-chunk int Size of listing chunk 1-1000 (default 1000)
|
||||||
|
|
@ -399,6 +399,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--cache-db-path string Directory to store file structure metadata DB (default "$HOME/.cache/rclone/cache-backend")
|
--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-purge Clear all the cached data for this remote on start
|
||||||
--cache-db-wait-time Duration How long to wait for the DB to be available - 0 is unlimited (default 1s)
|
--cache-db-wait-time Duration How long to wait for the DB to be available - 0 is unlimited (default 1s)
|
||||||
|
--cache-description string Description of the remote
|
||||||
--cache-info-age Duration How long to cache file structure information (directory listings, file size, times, etc.) (default 6h0m0s)
|
--cache-info-age Duration How long to cache file structure information (directory listings, file size, times, etc.) (default 6h0m0s)
|
||||||
--cache-plex-insecure string Skip all certificate verification when connecting to the Plex server
|
--cache-plex-insecure string Skip all certificate verification when connecting to the Plex server
|
||||||
--cache-plex-password string The password of the Plex user (obscured)
|
--cache-plex-password string The password of the Plex user (obscured)
|
||||||
|
|
@ -412,15 +413,19 @@ Backend only flags. These can be set in the config file also.
|
||||||
--cache-workers int How many workers should run in parallel to download chunks (default 4)
|
--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
|
--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 2Gi)
|
--chunker-chunk-size SizeSuffix Files larger than chunk size will be split in chunks (default 2Gi)
|
||||||
|
--chunker-description string Description of the remote
|
||||||
--chunker-fail-hard Choose how chunker should handle files with missing or invalid chunks
|
--chunker-fail-hard Choose how chunker should handle files with missing or invalid chunks
|
||||||
--chunker-hash-type string Choose how chunker handles hash sums (default "md5")
|
--chunker-hash-type string Choose how chunker handles hash sums (default "md5")
|
||||||
--chunker-remote string Remote to chunk/unchunk
|
--chunker-remote string Remote to chunk/unchunk
|
||||||
|
--combine-description string Description of the remote
|
||||||
--combine-upstreams SpaceSepList Upstreams for combining
|
--combine-upstreams SpaceSepList Upstreams for combining
|
||||||
|
--compress-description string Description of the remote
|
||||||
--compress-level int GZIP compression level (-2 to 9) (default -1)
|
--compress-level int GZIP compression level (-2 to 9) (default -1)
|
||||||
--compress-mode string Compression mode (default "gzip")
|
--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 20Mi)
|
--compress-ram-cache-limit SizeSuffix Some remotes don't allow the upload of files with unknown size (default 20Mi)
|
||||||
--compress-remote string Remote to compress
|
--compress-remote string Remote to compress
|
||||||
-L, --copy-links Follow symlinks and copy the pointed to item
|
-L, --copy-links Follow symlinks and copy the pointed to item
|
||||||
|
--crypt-description string Description of the remote
|
||||||
--crypt-directory-name-encryption Option to either encrypt directory names or leave them intact (default true)
|
--crypt-directory-name-encryption Option to either encrypt directory names or leave them intact (default true)
|
||||||
--crypt-filename-encoding string How to encode the encrypted filename to text string (default "base32")
|
--crypt-filename-encoding string How to encode the encrypted filename to text string (default "base32")
|
||||||
--crypt-filename-encryption string How to encrypt the filenames (default "standard")
|
--crypt-filename-encryption string How to encrypt the filenames (default "standard")
|
||||||
|
|
@ -431,6 +436,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--crypt-remote string Remote to encrypt/decrypt
|
--crypt-remote string Remote to encrypt/decrypt
|
||||||
--crypt-server-side-across-configs Deprecated: use --server-side-across-configs instead
|
--crypt-server-side-across-configs Deprecated: use --server-side-across-configs instead
|
||||||
--crypt-show-mapping For all files listed show how the names encrypt
|
--crypt-show-mapping For all files listed show how the names encrypt
|
||||||
|
--crypt-strict-names If set, this will raise an error when crypt comes across a filename that can't be decrypted
|
||||||
--crypt-suffix string If this is set it will override the default suffix of ".bin" (default ".bin")
|
--crypt-suffix string If this is set it will override the default suffix of ".bin" (default ".bin")
|
||||||
--drive-acknowledge-abuse Set to allow files which return cannotDownloadAbusiveFile to be downloaded
|
--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
|
--drive-allow-import-name-change Allow the filetype to change when uploading Google docs
|
||||||
|
|
@ -440,6 +446,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--drive-client-id string Google Application Client Id
|
--drive-client-id string Google Application Client Id
|
||||||
--drive-client-secret string OAuth Client Secret
|
--drive-client-secret string OAuth Client Secret
|
||||||
--drive-copy-shortcut-content Server side copy contents of shortcuts instead of the shortcut
|
--drive-copy-shortcut-content Server side copy contents of shortcuts instead of the shortcut
|
||||||
|
--drive-description string Description of the remote
|
||||||
--drive-disable-http2 Disable drive using http2 (default true)
|
--drive-disable-http2 Disable drive using http2 (default true)
|
||||||
--drive-encoding Encoding The encoding for the backend (default InvalidUtf8)
|
--drive-encoding Encoding The encoding for the backend (default InvalidUtf8)
|
||||||
--drive-env-auth Get IAM credentials from runtime (environment variables or instance meta data if no env vars)
|
--drive-env-auth Get IAM credentials from runtime (environment variables or instance meta data if no env vars)
|
||||||
|
|
@ -488,6 +495,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--dropbox-chunk-size SizeSuffix Upload chunk size (< 150Mi) (default 48Mi)
|
--dropbox-chunk-size SizeSuffix Upload chunk size (< 150Mi) (default 48Mi)
|
||||||
--dropbox-client-id string OAuth Client Id
|
--dropbox-client-id string OAuth Client Id
|
||||||
--dropbox-client-secret string OAuth Client Secret
|
--dropbox-client-secret string OAuth Client Secret
|
||||||
|
--dropbox-description string Description of the remote
|
||||||
--dropbox-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot)
|
--dropbox-encoding Encoding 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
|
||||||
--dropbox-pacer-min-sleep Duration Minimum time to sleep between API calls (default 10ms)
|
--dropbox-pacer-min-sleep Duration Minimum time to sleep between API calls (default 10ms)
|
||||||
|
|
@ -497,10 +505,12 @@ Backend only flags. These can be set in the config file also.
|
||||||
--dropbox-token-url string Token server url
|
--dropbox-token-url string Token server url
|
||||||
--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-cdn Set if you wish to use CDN download links
|
--fichier-cdn Set if you wish to use CDN download links
|
||||||
|
--fichier-description string Description of the remote
|
||||||
--fichier-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot)
|
--fichier-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot)
|
||||||
--fichier-file-password string If you want to download a shared file that is password protected, add this parameter (obscured)
|
--fichier-file-password string If you want to download a shared file that is password protected, add this parameter (obscured)
|
||||||
--fichier-folder-password string If you want to list the files in a shared folder that is password protected, add this parameter (obscured)
|
--fichier-folder-password string If you want to list the files in a shared folder that is password protected, add this parameter (obscured)
|
||||||
--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
|
||||||
|
--filefabric-description string Description of the remote
|
||||||
--filefabric-encoding Encoding The encoding for the backend (default Slash,Del,Ctl,InvalidUtf8,Dot)
|
--filefabric-encoding Encoding The encoding for the backend (default Slash,Del,Ctl,InvalidUtf8,Dot)
|
||||||
--filefabric-permanent-token string Permanent Authentication Token
|
--filefabric-permanent-token string Permanent Authentication Token
|
||||||
--filefabric-root-folder-id string ID of the root folder
|
--filefabric-root-folder-id string ID of the root folder
|
||||||
|
|
@ -511,6 +521,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--ftp-ask-password Allow asking for FTP password when needed
|
--ftp-ask-password Allow asking for FTP password when needed
|
||||||
--ftp-close-timeout Duration Maximum time to wait for a response to close (default 1m0s)
|
--ftp-close-timeout Duration Maximum time to wait for a response to close (default 1m0s)
|
||||||
--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-description string Description of the remote
|
||||||
--ftp-disable-epsv Disable using EPSV even if server advertises support
|
--ftp-disable-epsv Disable using EPSV even if server advertises support
|
||||||
--ftp-disable-mlsd Disable using MLSD even if server advertises support
|
--ftp-disable-mlsd Disable using MLSD even if server advertises support
|
||||||
--ftp-disable-tls13 Disable TLS 1.3 (workaround for FTP servers with buggy TLS)
|
--ftp-disable-tls13 Disable TLS 1.3 (workaround for FTP servers with buggy TLS)
|
||||||
|
|
@ -536,6 +547,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--gcs-client-id string OAuth Client Id
|
--gcs-client-id string OAuth Client Id
|
||||||
--gcs-client-secret string OAuth Client Secret
|
--gcs-client-secret string OAuth Client Secret
|
||||||
--gcs-decompress If set this will decompress gzip encoded objects
|
--gcs-decompress If set this will decompress gzip encoded objects
|
||||||
|
--gcs-description string Description of the remote
|
||||||
--gcs-directory-markers Upload an empty object with a trailing slash when a new directory is created
|
--gcs-directory-markers Upload an empty object with a trailing slash when a new directory is created
|
||||||
--gcs-encoding Encoding The encoding for the backend (default Slash,CrLf,InvalidUtf8,Dot)
|
--gcs-encoding Encoding The encoding for the backend (default Slash,CrLf,InvalidUtf8,Dot)
|
||||||
--gcs-endpoint string Endpoint for the service
|
--gcs-endpoint string Endpoint for the service
|
||||||
|
|
@ -556,6 +568,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--gphotos-batch-timeout Duration Max time to allow an idle upload batch before uploading (default 0s)
|
--gphotos-batch-timeout Duration Max time to allow an idle upload batch before uploading (default 0s)
|
||||||
--gphotos-client-id string OAuth Client Id
|
--gphotos-client-id string OAuth Client Id
|
||||||
--gphotos-client-secret string OAuth Client Secret
|
--gphotos-client-secret string OAuth Client Secret
|
||||||
|
--gphotos-description string Description of the remote
|
||||||
--gphotos-encoding Encoding The encoding for the backend (default Slash,CrLf,InvalidUtf8,Dot)
|
--gphotos-encoding Encoding The encoding for the backend (default Slash,CrLf,InvalidUtf8,Dot)
|
||||||
--gphotos-include-archived Also view and download archived media
|
--gphotos-include-archived Also view and download archived media
|
||||||
--gphotos-read-only Set to make the Google Photos backend read only
|
--gphotos-read-only Set to make the Google Photos backend read only
|
||||||
|
|
@ -564,10 +577,12 @@ Backend only flags. These can be set in the config file also.
|
||||||
--gphotos-token string OAuth Access Token as a JSON blob
|
--gphotos-token string OAuth Access Token as a JSON blob
|
||||||
--gphotos-token-url string Token server url
|
--gphotos-token-url string Token server url
|
||||||
--hasher-auto-size SizeSuffix Auto-update checksum for files smaller than this size (disabled by default)
|
--hasher-auto-size SizeSuffix Auto-update checksum for files smaller than this size (disabled by default)
|
||||||
|
--hasher-description string Description of the remote
|
||||||
--hasher-hashes CommaSepList Comma separated list of supported checksum types (default md5,sha1)
|
--hasher-hashes CommaSepList Comma separated list of supported checksum types (default md5,sha1)
|
||||||
--hasher-max-age Duration Maximum time to keep checksums in cache (0 = no cache, off = cache forever) (default off)
|
--hasher-max-age Duration Maximum time to keep checksums in cache (0 = no cache, off = cache forever) (default off)
|
||||||
--hasher-remote string Remote to cache checksums for (e.g. myRemote:path)
|
--hasher-remote string Remote to cache checksums for (e.g. myRemote:path)
|
||||||
--hdfs-data-transfer-protection string Kerberos data transfer protection: authentication|integrity|privacy
|
--hdfs-data-transfer-protection string Kerberos data transfer protection: authentication|integrity|privacy
|
||||||
|
--hdfs-description string Description of the remote
|
||||||
--hdfs-encoding Encoding The encoding for the backend (default Slash,Colon,Del,Ctl,InvalidUtf8,Dot)
|
--hdfs-encoding Encoding The encoding for the backend (default Slash,Colon,Del,Ctl,InvalidUtf8,Dot)
|
||||||
--hdfs-namenode CommaSepList Hadoop name nodes and ports
|
--hdfs-namenode CommaSepList Hadoop name nodes and ports
|
||||||
--hdfs-service-principal-name string Kerberos service principal name for the namenode
|
--hdfs-service-principal-name string Kerberos service principal name for the namenode
|
||||||
|
|
@ -576,6 +591,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--hidrive-chunk-size SizeSuffix Chunksize for chunked uploads (default 48Mi)
|
--hidrive-chunk-size SizeSuffix Chunksize for chunked uploads (default 48Mi)
|
||||||
--hidrive-client-id string OAuth Client Id
|
--hidrive-client-id string OAuth Client Id
|
||||||
--hidrive-client-secret string OAuth Client Secret
|
--hidrive-client-secret string OAuth Client Secret
|
||||||
|
--hidrive-description string Description of the remote
|
||||||
--hidrive-disable-fetching-member-count Do not fetch number of objects in directories unless it is absolutely necessary
|
--hidrive-disable-fetching-member-count Do not fetch number of objects in directories unless it is absolutely necessary
|
||||||
--hidrive-encoding Encoding The encoding for the backend (default Slash,Dot)
|
--hidrive-encoding Encoding The encoding for the backend (default Slash,Dot)
|
||||||
--hidrive-endpoint string Endpoint for the service (default "https://api.hidrive.strato.com/2.1")
|
--hidrive-endpoint string Endpoint for the service (default "https://api.hidrive.strato.com/2.1")
|
||||||
|
|
@ -586,10 +602,12 @@ Backend only flags. These can be set in the config file also.
|
||||||
--hidrive-token-url string Token server url
|
--hidrive-token-url string Token server url
|
||||||
--hidrive-upload-concurrency int Concurrency for chunked uploads (default 4)
|
--hidrive-upload-concurrency int Concurrency for chunked uploads (default 4)
|
||||||
--hidrive-upload-cutoff SizeSuffix Cutoff/Threshold for chunked uploads (default 96Mi)
|
--hidrive-upload-cutoff SizeSuffix Cutoff/Threshold for chunked uploads (default 96Mi)
|
||||||
|
--http-description string Description of the remote
|
||||||
--http-headers CommaSepList Set HTTP headers for all transactions
|
--http-headers CommaSepList Set HTTP headers for all transactions
|
||||||
--http-no-head Don't use HEAD requests
|
--http-no-head Don't use HEAD requests
|
||||||
--http-no-slash Set this if the site doesn't end directories with /
|
--http-no-slash Set this if the site doesn't end directories with /
|
||||||
--http-url string URL of HTTP host to connect to
|
--http-url string URL of HTTP host to connect to
|
||||||
|
--imagekit-description string Description of the remote
|
||||||
--imagekit-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Dollar,Question,Hash,Percent,BackSlash,Del,Ctl,InvalidUtf8,Dot,SquareBracket)
|
--imagekit-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Dollar,Question,Hash,Percent,BackSlash,Del,Ctl,InvalidUtf8,Dot,SquareBracket)
|
||||||
--imagekit-endpoint string You can find your ImageKit.io URL endpoint in your [dashboard](https://imagekit.io/dashboard/developer/api-keys)
|
--imagekit-endpoint string You can find your ImageKit.io URL endpoint in your [dashboard](https://imagekit.io/dashboard/developer/api-keys)
|
||||||
--imagekit-only-signed Restrict unsigned image URLs If you have configured Restrict unsigned image URLs in your dashboard settings, set this to true
|
--imagekit-only-signed Restrict unsigned image URLs If you have configured Restrict unsigned image URLs in your dashboard settings, set this to true
|
||||||
|
|
@ -598,6 +616,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--imagekit-upload-tags string Tags to add to the uploaded files, e.g. "tag1,tag2"
|
--imagekit-upload-tags string Tags to add to the uploaded files, e.g. "tag1,tag2"
|
||||||
--imagekit-versions Include old versions in directory listings
|
--imagekit-versions Include old versions in directory listings
|
||||||
--internetarchive-access-key-id string IAS3 Access Key
|
--internetarchive-access-key-id string IAS3 Access Key
|
||||||
|
--internetarchive-description string Description of the remote
|
||||||
--internetarchive-disable-checksum Don't ask the server to test against MD5 checksum calculated by rclone (default true)
|
--internetarchive-disable-checksum Don't ask the server to test against MD5 checksum calculated by rclone (default true)
|
||||||
--internetarchive-encoding Encoding The encoding for the backend (default Slash,LtGt,CrLf,Del,Ctl,InvalidUtf8,Dot)
|
--internetarchive-encoding Encoding The encoding for the backend (default Slash,LtGt,CrLf,Del,Ctl,InvalidUtf8,Dot)
|
||||||
--internetarchive-endpoint string IAS3 Endpoint (default "https://s3.us.archive.org")
|
--internetarchive-endpoint string IAS3 Endpoint (default "https://s3.us.archive.org")
|
||||||
|
|
@ -607,6 +626,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--jottacloud-auth-url string Auth server URL
|
--jottacloud-auth-url string Auth server URL
|
||||||
--jottacloud-client-id string OAuth Client Id
|
--jottacloud-client-id string OAuth Client Id
|
||||||
--jottacloud-client-secret string OAuth Client Secret
|
--jottacloud-client-secret string OAuth Client Secret
|
||||||
|
--jottacloud-description string Description of the remote
|
||||||
--jottacloud-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot)
|
--jottacloud-encoding Encoding 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 10Mi)
|
--jottacloud-md5-memory-limit SizeSuffix Files bigger than this will be cached on disk to calculate the MD5 if required (default 10Mi)
|
||||||
|
|
@ -615,6 +635,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--jottacloud-token-url string Token server url
|
--jottacloud-token-url string Token server url
|
||||||
--jottacloud-trashed-only Only show files that are in the trash
|
--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 10Mi)
|
--jottacloud-upload-resume-limit SizeSuffix Files bigger than this can be resumed if the upload fail's (default 10Mi)
|
||||||
|
--koofr-description string Description of the remote
|
||||||
--koofr-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
--koofr-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||||
--koofr-endpoint string The Koofr API endpoint to use
|
--koofr-endpoint string The Koofr API endpoint to use
|
||||||
--koofr-mountid string Mount ID of the mount to use
|
--koofr-mountid string Mount ID of the mount to use
|
||||||
|
|
@ -622,10 +643,12 @@ Backend only flags. These can be set in the config file also.
|
||||||
--koofr-provider string Choose your storage provider
|
--koofr-provider string Choose your storage provider
|
||||||
--koofr-setmtime Does the backend support setting modification time (default true)
|
--koofr-setmtime Does the backend support setting modification time (default true)
|
||||||
--koofr-user string Your user name
|
--koofr-user string Your user name
|
||||||
|
--linkbox-description string Description of the remote
|
||||||
--linkbox-token string Token from https://www.linkbox.to/admin/account
|
--linkbox-token string Token from https://www.linkbox.to/admin/account
|
||||||
-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-description string Description of the remote
|
||||||
--local-encoding Encoding The encoding for the backend (default Slash,Dot)
|
--local-encoding Encoding 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-preallocate Disable preallocation of disk space for transferred files
|
--local-no-preallocate Disable preallocation of disk space for transferred files
|
||||||
|
|
@ -638,6 +661,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--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-client-id string OAuth Client Id
|
--mailru-client-id string OAuth Client Id
|
||||||
--mailru-client-secret string OAuth Client Secret
|
--mailru-client-secret string OAuth Client Secret
|
||||||
|
--mailru-description string Description of the remote
|
||||||
--mailru-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
--mailru-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||||
--mailru-pass string Password (obscured)
|
--mailru-pass string Password (obscured)
|
||||||
--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)
|
||||||
|
|
@ -648,12 +672,15 @@ Backend only flags. These can be set in the config file also.
|
||||||
--mailru-token-url string Token server url
|
--mailru-token-url string Token server url
|
||||||
--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-description string Description of the remote
|
||||||
--mega-encoding Encoding The encoding for the backend (default Slash,InvalidUtf8,Dot)
|
--mega-encoding Encoding 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 (obscured)
|
--mega-pass string Password (obscured)
|
||||||
--mega-use-https Use HTTPS for transfers
|
--mega-use-https Use HTTPS for transfers
|
||||||
--mega-user string User name
|
--mega-user string User name
|
||||||
|
--memory-description string Description of the remote
|
||||||
--netstorage-account string Set the NetStorage account name
|
--netstorage-account string Set the NetStorage account name
|
||||||
|
--netstorage-description string Description of the remote
|
||||||
--netstorage-host string Domain+path of NetStorage host to connect to
|
--netstorage-host string Domain+path of NetStorage host to connect to
|
||||||
--netstorage-protocol string Select between HTTP or HTTPS protocol (default "https")
|
--netstorage-protocol string Select between HTTP or HTTPS protocol (default "https")
|
||||||
--netstorage-secret string Set the NetStorage account secret/G2O key for authentication (obscured)
|
--netstorage-secret string Set the NetStorage account secret/G2O key for authentication (obscured)
|
||||||
|
|
@ -665,6 +692,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--onedrive-client-id string OAuth Client Id
|
--onedrive-client-id string OAuth Client Id
|
||||||
--onedrive-client-secret string OAuth Client Secret
|
--onedrive-client-secret string OAuth Client Secret
|
||||||
--onedrive-delta If set rclone will use delta listing to implement recursive listings
|
--onedrive-delta If set rclone will use delta listing to implement recursive listings
|
||||||
|
--onedrive-description string Description of the remote
|
||||||
--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 Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot)
|
--onedrive-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot)
|
||||||
|
|
@ -674,6 +702,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--onedrive-link-scope string Set the scope of the links created by the link command (default "anonymous")
|
--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")
|
--onedrive-link-type string Set the type of the links created by the link command (default "view")
|
||||||
--onedrive-list-chunk int Size of listing chunk (default 1000)
|
--onedrive-list-chunk int Size of listing chunk (default 1000)
|
||||||
|
--onedrive-metadata-permissions Bits Control whether permissions should be read or written in metadata (default off)
|
||||||
--onedrive-no-versions Remove all versions on modifying operations
|
--onedrive-no-versions Remove all versions on modifying operations
|
||||||
--onedrive-region string Choose national cloud region for OneDrive (default "global")
|
--onedrive-region string Choose national cloud region for OneDrive (default "global")
|
||||||
--onedrive-root-folder-id string ID of the root folder
|
--onedrive-root-folder-id string ID of the root folder
|
||||||
|
|
@ -687,6 +716,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--oos-config-profile string Profile name inside the oci config file (default "Default")
|
--oos-config-profile string Profile name inside the oci config file (default "Default")
|
||||||
--oos-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656Gi)
|
--oos-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656Gi)
|
||||||
--oos-copy-timeout Duration Timeout for copy (default 1m0s)
|
--oos-copy-timeout Duration Timeout for copy (default 1m0s)
|
||||||
|
--oos-description string Description of the remote
|
||||||
--oos-disable-checksum Don't store MD5 checksum with object metadata
|
--oos-disable-checksum Don't store MD5 checksum with object metadata
|
||||||
--oos-encoding Encoding The encoding for the backend (default Slash,InvalidUtf8,Dot)
|
--oos-encoding Encoding The encoding for the backend (default Slash,InvalidUtf8,Dot)
|
||||||
--oos-endpoint string Endpoint for Object storage API
|
--oos-endpoint string Endpoint for Object storage API
|
||||||
|
|
@ -705,12 +735,14 @@ Backend only flags. These can be set in the config file also.
|
||||||
--oos-upload-concurrency int Concurrency for multipart uploads (default 10)
|
--oos-upload-concurrency int Concurrency for multipart uploads (default 10)
|
||||||
--oos-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi)
|
--oos-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi)
|
||||||
--opendrive-chunk-size SizeSuffix Files will be uploaded in chunks this size (default 10Mi)
|
--opendrive-chunk-size SizeSuffix Files will be uploaded in chunks this size (default 10Mi)
|
||||||
|
--opendrive-description string Description of the remote
|
||||||
--opendrive-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot)
|
--opendrive-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot)
|
||||||
--opendrive-password string Password (obscured)
|
--opendrive-password string Password (obscured)
|
||||||
--opendrive-username string Username
|
--opendrive-username string Username
|
||||||
--pcloud-auth-url string Auth server URL
|
--pcloud-auth-url string Auth server URL
|
||||||
--pcloud-client-id string OAuth Client Id
|
--pcloud-client-id string OAuth Client Id
|
||||||
--pcloud-client-secret string OAuth Client Secret
|
--pcloud-client-secret string OAuth Client Secret
|
||||||
|
--pcloud-description string Description of the remote
|
||||||
--pcloud-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
--pcloud-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||||
--pcloud-hostname string Hostname to connect to (default "api.pcloud.com")
|
--pcloud-hostname string Hostname to connect to (default "api.pcloud.com")
|
||||||
--pcloud-password string Your pcloud password (obscured)
|
--pcloud-password string Your pcloud password (obscured)
|
||||||
|
|
@ -721,6 +753,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--pikpak-auth-url string Auth server URL
|
--pikpak-auth-url string Auth server URL
|
||||||
--pikpak-client-id string OAuth Client Id
|
--pikpak-client-id string OAuth Client Id
|
||||||
--pikpak-client-secret string OAuth Client Secret
|
--pikpak-client-secret string OAuth Client Secret
|
||||||
|
--pikpak-description string Description of the remote
|
||||||
--pikpak-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,RightSpace,RightPeriod,InvalidUtf8,Dot)
|
--pikpak-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,RightSpace,RightPeriod,InvalidUtf8,Dot)
|
||||||
--pikpak-hash-memory-limit SizeSuffix Files bigger than this will be cached on disk to calculate hash if required (default 10Mi)
|
--pikpak-hash-memory-limit SizeSuffix Files bigger than this will be cached on disk to calculate hash if required (default 10Mi)
|
||||||
--pikpak-pass string Pikpak password (obscured)
|
--pikpak-pass string Pikpak password (obscured)
|
||||||
|
|
@ -733,11 +766,13 @@ Backend only flags. These can be set in the config file also.
|
||||||
--premiumizeme-auth-url string Auth server URL
|
--premiumizeme-auth-url string Auth server URL
|
||||||
--premiumizeme-client-id string OAuth Client Id
|
--premiumizeme-client-id string OAuth Client Id
|
||||||
--premiumizeme-client-secret string OAuth Client Secret
|
--premiumizeme-client-secret string OAuth Client Secret
|
||||||
|
--premiumizeme-description string Description of the remote
|
||||||
--premiumizeme-encoding Encoding The encoding for the backend (default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
--premiumizeme-encoding Encoding The encoding for the backend (default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||||
--premiumizeme-token string OAuth Access Token as a JSON blob
|
--premiumizeme-token string OAuth Access Token as a JSON blob
|
||||||
--premiumizeme-token-url string Token server url
|
--premiumizeme-token-url string Token server url
|
||||||
--protondrive-2fa string The 2FA code
|
--protondrive-2fa string The 2FA code
|
||||||
--protondrive-app-version string The app version string (default "macos-drive@1.0.0-alpha.1+rclone")
|
--protondrive-app-version string The app version string (default "macos-drive@1.0.0-alpha.1+rclone")
|
||||||
|
--protondrive-description string Description of the remote
|
||||||
--protondrive-enable-caching Caches the files and folders metadata to reduce API calls (default true)
|
--protondrive-enable-caching Caches the files and folders metadata to reduce API calls (default true)
|
||||||
--protondrive-encoding Encoding The encoding for the backend (default Slash,LeftSpace,RightSpace,InvalidUtf8,Dot)
|
--protondrive-encoding Encoding The encoding for the backend (default Slash,LeftSpace,RightSpace,InvalidUtf8,Dot)
|
||||||
--protondrive-mailbox-password string The mailbox password of your two-password proton account (obscured)
|
--protondrive-mailbox-password string The mailbox password of your two-password proton account (obscured)
|
||||||
|
|
@ -748,12 +783,14 @@ Backend only flags. These can be set in the config file also.
|
||||||
--putio-auth-url string Auth server URL
|
--putio-auth-url string Auth server URL
|
||||||
--putio-client-id string OAuth Client Id
|
--putio-client-id string OAuth Client Id
|
||||||
--putio-client-secret string OAuth Client Secret
|
--putio-client-secret string OAuth Client Secret
|
||||||
|
--putio-description string Description of the remote
|
||||||
--putio-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
--putio-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||||
--putio-token string OAuth Access Token as a JSON blob
|
--putio-token string OAuth Access Token as a JSON blob
|
||||||
--putio-token-url string Token server url
|
--putio-token-url string Token server url
|
||||||
--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 4Mi)
|
--qingstor-chunk-size SizeSuffix Chunk size to use for uploading (default 4Mi)
|
||||||
--qingstor-connection-retries int Number of connection retries (default 3)
|
--qingstor-connection-retries int Number of connection retries (default 3)
|
||||||
|
--qingstor-description string Description of the remote
|
||||||
--qingstor-encoding Encoding The encoding for the backend (default Slash,Ctl,InvalidUtf8)
|
--qingstor-encoding Encoding The encoding for the backend (default Slash,Ctl,InvalidUtf8)
|
||||||
--qingstor-endpoint string Enter an endpoint URL to connection QingStor API
|
--qingstor-endpoint string Enter an endpoint URL to connection QingStor API
|
||||||
--qingstor-env-auth Get QingStor credentials from runtime
|
--qingstor-env-auth Get QingStor credentials from runtime
|
||||||
|
|
@ -762,18 +799,21 @@ Backend only flags. These can be set in the config file also.
|
||||||
--qingstor-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi)
|
--qingstor-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi)
|
||||||
--qingstor-zone string Zone to connect to
|
--qingstor-zone string Zone to connect to
|
||||||
--quatrix-api-key string API key for accessing Quatrix account
|
--quatrix-api-key string API key for accessing Quatrix account
|
||||||
|
--quatrix-description string Description of the remote
|
||||||
--quatrix-effective-upload-time string Wanted upload time for one chunk (default "4s")
|
--quatrix-effective-upload-time string Wanted upload time for one chunk (default "4s")
|
||||||
--quatrix-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
--quatrix-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||||
--quatrix-hard-delete Delete files permanently rather than putting them into the trash
|
--quatrix-hard-delete Delete files permanently rather than putting them into the trash
|
||||||
--quatrix-host string Host name of Quatrix account
|
--quatrix-host string Host name of Quatrix account
|
||||||
--quatrix-maximal-summary-chunk-size SizeSuffix The maximal summary for all chunks. It should not be less than 'transfers'*'minimal_chunk_size' (default 95.367Mi)
|
--quatrix-maximal-summary-chunk-size SizeSuffix The maximal summary for all chunks. It should not be less than 'transfers'*'minimal_chunk_size' (default 95.367Mi)
|
||||||
--quatrix-minimal-chunk-size SizeSuffix The minimal size for one chunk (default 9.537Mi)
|
--quatrix-minimal-chunk-size SizeSuffix The minimal size for one chunk (default 9.537Mi)
|
||||||
|
--quatrix-skip-project-folders Skip project folders in operations
|
||||||
--s3-access-key-id string AWS Access Key ID
|
--s3-access-key-id string AWS Access Key ID
|
||||||
--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 5Mi)
|
--s3-chunk-size SizeSuffix Chunk size to use for uploading (default 5Mi)
|
||||||
--s3-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656Gi)
|
--s3-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656Gi)
|
||||||
--s3-decompress If set this will decompress gzip encoded objects
|
--s3-decompress If set this will decompress gzip encoded objects
|
||||||
|
--s3-description string Description of the remote
|
||||||
--s3-directory-markers Upload an empty object with a trailing slash when a new directory is created
|
--s3-directory-markers Upload an empty object with a trailing slash when a new directory is created
|
||||||
--s3-disable-checksum Don't store MD5 checksum with object metadata
|
--s3-disable-checksum Don't store MD5 checksum with object metadata
|
||||||
--s3-disable-http2 Disable usage of http2 for S3 backends
|
--s3-disable-http2 Disable usage of http2 for S3 backends
|
||||||
|
|
@ -808,19 +848,22 @@ Backend only flags. These can be set in the config file also.
|
||||||
--s3-sse-kms-key-id string If using KMS ID you must provide the ARN of Key
|
--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-storage-class string The storage class to use when storing new objects in S3
|
||||||
--s3-sts-endpoint string Endpoint for STS
|
--s3-sts-endpoint string Endpoint for STS
|
||||||
--s3-upload-concurrency int Concurrency for multipart uploads (default 4)
|
--s3-upload-concurrency int Concurrency for multipart uploads and copies (default 4)
|
||||||
--s3-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi)
|
--s3-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi)
|
||||||
--s3-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint
|
--s3-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint
|
||||||
--s3-use-accept-encoding-gzip Accept-Encoding: gzip Whether to send Accept-Encoding: gzip header (default unset)
|
--s3-use-accept-encoding-gzip Accept-Encoding: gzip Whether to send Accept-Encoding: gzip header (default unset)
|
||||||
--s3-use-already-exists Tristate Set if rclone should report BucketAlreadyExists errors on bucket creation (default unset)
|
--s3-use-already-exists Tristate Set if rclone should report BucketAlreadyExists errors on bucket creation (default unset)
|
||||||
|
--s3-use-dual-stack If true use AWS S3 dual-stack endpoint (IPv6 support)
|
||||||
--s3-use-multipart-etag Tristate Whether to use ETag in multipart uploads for verification (default unset)
|
--s3-use-multipart-etag Tristate Whether to use ETag in multipart uploads for verification (default unset)
|
||||||
--s3-use-multipart-uploads Tristate Set if rclone should use multipart uploads (default unset)
|
--s3-use-multipart-uploads Tristate Set if rclone should use multipart uploads (default unset)
|
||||||
--s3-use-presigned-request Whether to use a presigned request or PutObject for single part uploads
|
--s3-use-presigned-request Whether to use a presigned request or PutObject for single part uploads
|
||||||
--s3-v2-auth If true use v2 authentication
|
--s3-v2-auth If true use v2 authentication
|
||||||
--s3-version-at Time Show file versions as they were at the specified time (default off)
|
--s3-version-at Time Show file versions as they were at the specified time (default off)
|
||||||
|
--s3-version-deleted Show deleted file markers when using versions
|
||||||
--s3-versions Include old versions in directory listings
|
--s3-versions Include old versions in directory listings
|
||||||
--seafile-2fa Two-factor authentication ('true' if the account has 2FA enabled)
|
--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
|
--seafile-create-library Should rclone create a library if it doesn't exist
|
||||||
|
--seafile-description string Description of the remote
|
||||||
--seafile-encoding Encoding The encoding for the backend (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8)
|
--seafile-encoding Encoding The encoding for the backend (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8)
|
||||||
--seafile-library string Name of the library
|
--seafile-library string Name of the library
|
||||||
--seafile-library-key string Library password (for encrypted libraries only) (obscured)
|
--seafile-library-key string Library password (for encrypted libraries only) (obscured)
|
||||||
|
|
@ -832,6 +875,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--sftp-ciphers SpaceSepList Space separated list of ciphers to be used for session encryption, ordered by preference
|
--sftp-ciphers SpaceSepList Space separated list of ciphers to be used for session encryption, ordered by preference
|
||||||
--sftp-concurrency int The maximum number of outstanding requests for one file (default 64)
|
--sftp-concurrency int The maximum number of outstanding requests for one file (default 64)
|
||||||
--sftp-copy-is-hardlink Set to enable server side copies using hardlinks
|
--sftp-copy-is-hardlink Set to enable server side copies using hardlinks
|
||||||
|
--sftp-description string Description of the remote
|
||||||
--sftp-disable-concurrent-reads If set don't use concurrent reads
|
--sftp-disable-concurrent-reads If set don't use concurrent reads
|
||||||
--sftp-disable-concurrent-writes If set don't use concurrent writes
|
--sftp-disable-concurrent-writes If set don't use concurrent writes
|
||||||
--sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available
|
--sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available
|
||||||
|
|
@ -866,6 +910,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--sharefile-chunk-size SizeSuffix Upload chunk size (default 64Mi)
|
--sharefile-chunk-size SizeSuffix Upload chunk size (default 64Mi)
|
||||||
--sharefile-client-id string OAuth Client Id
|
--sharefile-client-id string OAuth Client Id
|
||||||
--sharefile-client-secret string OAuth Client Secret
|
--sharefile-client-secret string OAuth Client Secret
|
||||||
|
--sharefile-description string Description of the remote
|
||||||
--sharefile-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot)
|
--sharefile-encoding Encoding 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
|
||||||
|
|
@ -874,10 +919,12 @@ Backend only flags. These can be set in the config file also.
|
||||||
--sharefile-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (default 128Mi)
|
--sharefile-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (default 128Mi)
|
||||||
--sia-api-password string Sia Daemon API Password (obscured)
|
--sia-api-password string Sia Daemon API Password (obscured)
|
||||||
--sia-api-url string Sia daemon API URL, like http://sia.daemon.host:9980 (default "http://127.0.0.1:9980")
|
--sia-api-url string Sia daemon API URL, like http://sia.daemon.host:9980 (default "http://127.0.0.1:9980")
|
||||||
|
--sia-description string Description of the remote
|
||||||
--sia-encoding Encoding The encoding for the backend (default Slash,Question,Hash,Percent,Del,Ctl,InvalidUtf8,Dot)
|
--sia-encoding Encoding The encoding for the backend (default Slash,Question,Hash,Percent,Del,Ctl,InvalidUtf8,Dot)
|
||||||
--sia-user-agent string Siad User Agent (default "Sia-Agent")
|
--sia-user-agent string Siad User Agent (default "Sia-Agent")
|
||||||
--skip-links Don't warn about skipped symlinks
|
--skip-links Don't warn about skipped symlinks
|
||||||
--smb-case-insensitive Whether the server is configured to be case-insensitive (default true)
|
--smb-case-insensitive Whether the server is configured to be case-insensitive (default true)
|
||||||
|
--smb-description string Description of the remote
|
||||||
--smb-domain string Domain name for NTLM authentication (default "WORKGROUP")
|
--smb-domain string Domain name for NTLM authentication (default "WORKGROUP")
|
||||||
--smb-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot)
|
--smb-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot)
|
||||||
--smb-hide-special-share Hide special shares (e.g. print$) which users aren't supposed to access (default true)
|
--smb-hide-special-share Hide special shares (e.g. print$) which users aren't supposed to access (default true)
|
||||||
|
|
@ -889,6 +936,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--smb-user string SMB username (default "$USER")
|
--smb-user string SMB username (default "$USER")
|
||||||
--storj-access-grant string Access grant
|
--storj-access-grant string Access grant
|
||||||
--storj-api-key string API key
|
--storj-api-key string API key
|
||||||
|
--storj-description string Description of the remote
|
||||||
--storj-passphrase string Encryption passphrase
|
--storj-passphrase string Encryption passphrase
|
||||||
--storj-provider string Choose an authentication method (default "existing")
|
--storj-provider string Choose an authentication method (default "existing")
|
||||||
--storj-satellite-address string Satellite address (default "us1.storj.io")
|
--storj-satellite-address string Satellite address (default "us1.storj.io")
|
||||||
|
|
@ -897,6 +945,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--sugarsync-authorization string Sugarsync authorization
|
--sugarsync-authorization string Sugarsync authorization
|
||||||
--sugarsync-authorization-expiry string Sugarsync authorization expiry
|
--sugarsync-authorization-expiry string Sugarsync authorization expiry
|
||||||
--sugarsync-deleted-id string Sugarsync deleted folder id
|
--sugarsync-deleted-id string Sugarsync deleted folder id
|
||||||
|
--sugarsync-description string Description of the remote
|
||||||
--sugarsync-encoding Encoding The encoding for the backend (default Slash,Ctl,InvalidUtf8,Dot)
|
--sugarsync-encoding Encoding The encoding for the backend (default Slash,Ctl,InvalidUtf8,Dot)
|
||||||
--sugarsync-hard-delete Permanently delete files if true
|
--sugarsync-hard-delete Permanently delete files if true
|
||||||
--sugarsync-private-access-key string Sugarsync Private Access Key
|
--sugarsync-private-access-key string Sugarsync Private Access Key
|
||||||
|
|
@ -910,6 +959,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--swift-auth-token string Auth Token from alternate authentication - optional (OS_AUTH_TOKEN)
|
--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-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 5Gi)
|
--swift-chunk-size SizeSuffix Above this size files will be chunked into a _segments container (default 5Gi)
|
||||||
|
--swift-description string Description of the remote
|
||||||
--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 Encoding The encoding for the backend (default Slash,InvalidUtf8)
|
--swift-encoding Encoding 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")
|
||||||
|
|
@ -929,17 +979,21 @@ Backend only flags. These can be set in the config file also.
|
||||||
--union-action-policy string Policy to choose upstream on ACTION category (default "epall")
|
--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) (default 120)
|
--union-cache-time int Cache time of usage and free space (in seconds) (default 120)
|
||||||
--union-create-policy string Policy to choose upstream on CREATE category (default "epmfs")
|
--union-create-policy string Policy to choose upstream on CREATE category (default "epmfs")
|
||||||
|
--union-description string Description of the remote
|
||||||
--union-min-free-space SizeSuffix Minimum viable free space for lfs/eplfs policies (default 1Gi)
|
--union-min-free-space SizeSuffix Minimum viable free space for lfs/eplfs policies (default 1Gi)
|
||||||
--union-search-policy string Policy to choose upstream on SEARCH category (default "ff")
|
--union-search-policy string Policy to choose upstream on SEARCH category (default "ff")
|
||||||
--union-upstreams string List of space separated upstreams
|
--union-upstreams string List of space separated upstreams
|
||||||
--uptobox-access-token string Your access token
|
--uptobox-access-token string Your access token
|
||||||
|
--uptobox-description string Description of the remote
|
||||||
--uptobox-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,BackQuote,Del,Ctl,LeftSpace,InvalidUtf8,Dot)
|
--uptobox-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,BackQuote,Del,Ctl,LeftSpace,InvalidUtf8,Dot)
|
||||||
--uptobox-private Set to make uploaded files private
|
--uptobox-private Set to make uploaded files private
|
||||||
--webdav-bearer-token string Bearer token instead of user/pass (e.g. a Macaroon)
|
--webdav-bearer-token string Bearer token instead of user/pass (e.g. a Macaroon)
|
||||||
--webdav-bearer-token-command string Command to run to get a bearer token
|
--webdav-bearer-token-command string Command to run to get a bearer token
|
||||||
|
--webdav-description string Description of the remote
|
||||||
--webdav-encoding string The encoding for the backend
|
--webdav-encoding string The encoding for the backend
|
||||||
--webdav-headers CommaSepList Set HTTP headers for all transactions
|
--webdav-headers CommaSepList Set HTTP headers for all transactions
|
||||||
--webdav-nextcloud-chunk-size SizeSuffix Nextcloud upload chunk size (default 10Mi)
|
--webdav-nextcloud-chunk-size SizeSuffix Nextcloud upload chunk size (default 10Mi)
|
||||||
|
--webdav-owncloud-exclude-shares Exclude ownCloud shares
|
||||||
--webdav-pacer-min-sleep Duration Minimum time to sleep between API calls (default 10ms)
|
--webdav-pacer-min-sleep Duration Minimum time to sleep between API calls (default 10ms)
|
||||||
--webdav-pass string Password (obscured)
|
--webdav-pass string Password (obscured)
|
||||||
--webdav-url string URL of http host to connect to
|
--webdav-url string URL of http host to connect to
|
||||||
|
|
@ -948,6 +1002,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--yandex-auth-url string Auth server URL
|
--yandex-auth-url string Auth server URL
|
||||||
--yandex-client-id string OAuth Client Id
|
--yandex-client-id string OAuth Client Id
|
||||||
--yandex-client-secret string OAuth Client Secret
|
--yandex-client-secret string OAuth Client Secret
|
||||||
|
--yandex-description string Description of the remote
|
||||||
--yandex-encoding Encoding The encoding for the backend (default Slash,Del,Ctl,InvalidUtf8,Dot)
|
--yandex-encoding Encoding The encoding for the backend (default Slash,Del,Ctl,InvalidUtf8,Dot)
|
||||||
--yandex-hard-delete Delete files permanently rather than putting them into the trash
|
--yandex-hard-delete Delete files permanently rather than putting them into the trash
|
||||||
--yandex-token string OAuth Access Token as a JSON blob
|
--yandex-token string OAuth Access Token as a JSON blob
|
||||||
|
|
@ -955,6 +1010,7 @@ Backend only flags. These can be set in the config file also.
|
||||||
--zoho-auth-url string Auth server URL
|
--zoho-auth-url string Auth server URL
|
||||||
--zoho-client-id string OAuth Client Id
|
--zoho-client-id string OAuth Client Id
|
||||||
--zoho-client-secret string OAuth Client Secret
|
--zoho-client-secret string OAuth Client Secret
|
||||||
|
--zoho-description string Description of the remote
|
||||||
--zoho-encoding Encoding The encoding for the backend (default Del,Ctl,InvalidUtf8)
|
--zoho-encoding Encoding The encoding for the backend (default Del,Ctl,InvalidUtf8)
|
||||||
--zoho-region string Zoho region to connect to
|
--zoho-region string Zoho region to connect to
|
||||||
--zoho-token string OAuth Access Token as a JSON blob
|
--zoho-token string OAuth Access Token as a JSON blob
|
||||||
|
|
|
||||||
|
|
@ -453,6 +453,17 @@ Properties:
|
||||||
- "Ctl,LeftPeriod,Slash"
|
- "Ctl,LeftPeriod,Slash"
|
||||||
- VsFTPd can't handle file names starting with dot
|
- VsFTPd can't handle file names starting with dot
|
||||||
|
|
||||||
|
#### --ftp-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_FTP_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
|
||||||
|
|
@ -699,6 +699,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,CrLf,InvalidUtf8,Dot
|
- Default: Slash,CrLf,InvalidUtf8,Dot
|
||||||
|
|
||||||
|
#### --gcs-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_GCS_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
|
||||||
|
|
@ -461,6 +461,17 @@ Properties:
|
||||||
- Type: Duration
|
- Type: Duration
|
||||||
- Default: 10m0s
|
- Default: 10m0s
|
||||||
|
|
||||||
|
#### --gphotos-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_GPHOTOS_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
|
||||||
|
|
@ -224,6 +224,17 @@ Properties:
|
||||||
- Type: SizeSuffix
|
- Type: SizeSuffix
|
||||||
- Default: 0
|
- Default: 0
|
||||||
|
|
||||||
|
#### --hasher-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_HASHER_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
### Metadata
|
### Metadata
|
||||||
|
|
||||||
Any metadata supported by the underlying remote is read and written.
|
Any metadata supported by the underlying remote is read and written.
|
||||||
|
|
|
||||||
|
|
@ -232,6 +232,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,Colon,Del,Ctl,InvalidUtf8,Dot
|
- Default: Slash,Colon,Del,Ctl,InvalidUtf8,Dot
|
||||||
|
|
||||||
|
#### --hdfs-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_HDFS_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
|
||||||
|
|
@ -418,6 +418,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,Dot
|
- Default: Slash,Dot
|
||||||
|
|
||||||
|
#### --hidrive-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_HIDRIVE_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
|
||||||
|
|
@ -212,6 +212,17 @@ Properties:
|
||||||
- Type: bool
|
- Type: bool
|
||||||
- Default: false
|
- Default: false
|
||||||
|
|
||||||
|
#### --http-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_HTTP_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
## Backend commands
|
## Backend commands
|
||||||
|
|
||||||
Here are the commands specific to the http backend.
|
Here are the commands specific to the http backend.
|
||||||
|
|
|
||||||
|
|
@ -191,6 +191,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,LtGt,DoubleQuote,Dollar,Question,Hash,Percent,BackSlash,Del,Ctl,InvalidUtf8,Dot,SquareBracket
|
- Default: Slash,LtGt,DoubleQuote,Dollar,Question,Hash,Percent,BackSlash,Del,Ctl,InvalidUtf8,Dot,SquareBracket
|
||||||
|
|
||||||
|
#### --imagekit-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_IMAGEKIT_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
### Metadata
|
### Metadata
|
||||||
|
|
||||||
Any metadata supported by the underlying remote is read and written.
|
Any metadata supported by the underlying remote is read and written.
|
||||||
|
|
|
||||||
|
|
@ -263,6 +263,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,LtGt,CrLf,Del,Ctl,InvalidUtf8,Dot
|
- Default: Slash,LtGt,CrLf,Del,Ctl,InvalidUtf8,Dot
|
||||||
|
|
||||||
|
#### --internetarchive-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_INTERNETARCHIVE_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
### Metadata
|
### Metadata
|
||||||
|
|
||||||
Metadata fields provided by Internet Archive.
|
Metadata fields provided by Internet Archive.
|
||||||
|
|
|
||||||
|
|
@ -447,6 +447,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot
|
- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot
|
||||||
|
|
||||||
|
#### --jottacloud-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_JOTTACLOUD_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
### Metadata
|
### Metadata
|
||||||
|
|
||||||
Jottacloud has limited support for metadata, currently an extended set of timestamps.
|
Jottacloud has limited support for metadata, currently an extended set of timestamps.
|
||||||
|
|
|
||||||
|
|
@ -214,6 +214,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
|
- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
|
||||||
|
|
||||||
|
#### --koofr-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_KOOFR_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
|
||||||
|
|
@ -68,6 +68,21 @@ Properties:
|
||||||
- Type: string
|
- Type: string
|
||||||
- Required: true
|
- Required: true
|
||||||
|
|
||||||
|
### Advanced options
|
||||||
|
|
||||||
|
Here are the Advanced options specific to linkbox (Linkbox).
|
||||||
|
|
||||||
|
#### --linkbox-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_LINKBOX_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
|
||||||
|
|
@ -569,6 +569,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,Dot
|
- Default: Slash,Dot
|
||||||
|
|
||||||
|
#### --local-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_LOCAL_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
### Metadata
|
### Metadata
|
||||||
|
|
||||||
Depending on which OS is in use the local backend may return only some
|
Depending on which OS is in use the local backend may return only some
|
||||||
|
|
@ -580,6 +591,8 @@ netbsd, macOS and Solaris. It is **not** supported on Windows yet
|
||||||
User metadata is stored as extended attributes (which may not be
|
User metadata is stored as extended attributes (which may not be
|
||||||
supported by all file systems) under the "user.*" prefix.
|
supported by all file systems) under the "user.*" prefix.
|
||||||
|
|
||||||
|
Metadata is supported on files and directories.
|
||||||
|
|
||||||
Here are the possible system metadata items for the local backend.
|
Here are the possible system metadata items for the local backend.
|
||||||
|
|
||||||
| Name | Help | Type | Example | Read Only |
|
| Name | Help | Type | Example | Read Only |
|
||||||
|
|
|
||||||
|
|
@ -412,6 +412,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot
|
- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot
|
||||||
|
|
||||||
|
#### --mailru-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_MAILRU_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
|
||||||
|
|
@ -282,6 +282,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,InvalidUtf8,Dot
|
- Default: Slash,InvalidUtf8,Dot
|
||||||
|
|
||||||
|
#### --mega-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_MEGA_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
### Process `killed`
|
### Process `killed`
|
||||||
|
|
|
||||||
|
|
@ -64,4 +64,19 @@ The memory backend replaces the [default restricted characters
|
||||||
set](/overview/#restricted-characters).
|
set](/overview/#restricted-characters).
|
||||||
|
|
||||||
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/memory/memory.go then run make backenddocs" >}}
|
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/memory/memory.go then run make backenddocs" >}}
|
||||||
|
### Advanced options
|
||||||
|
|
||||||
|
Here are the Advanced options specific to memory (In memory object storage system.).
|
||||||
|
|
||||||
|
#### --memory-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_MEMORY_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
|
||||||
|
|
@ -242,6 +242,17 @@ Properties:
|
||||||
- "https"
|
- "https"
|
||||||
- HTTPS protocol
|
- HTTPS protocol
|
||||||
|
|
||||||
|
#### --netstorage-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_NETSTORAGE_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
## Backend commands
|
## Backend commands
|
||||||
|
|
||||||
Here are the commands specific to the netstorage backend.
|
Here are the commands specific to the netstorage backend.
|
||||||
|
|
|
||||||
|
|
@ -162,6 +162,17 @@ Properties:
|
||||||
- Type: SizeSuffix
|
- Type: SizeSuffix
|
||||||
- Default: 10Mi
|
- Default: 10Mi
|
||||||
|
|
||||||
|
#### --opendrive-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_OPENDRIVE_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
|
||||||
|
|
@ -319,6 +319,9 @@ Properties:
|
||||||
- use instance principals to authorize an instance to make API calls.
|
- use instance principals to authorize an instance to make API calls.
|
||||||
- each instance has its own identity, and authenticates using the certificates that are read from instance metadata.
|
- each instance has its own identity, and authenticates using the certificates that are read from instance metadata.
|
||||||
- https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm
|
- https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm
|
||||||
|
- "workload_identity_auth"
|
||||||
|
- use workload identity to grant OCI Container Engine for Kubernetes workloads policy-driven access to OCI resources using OCI Identity and Access Management (IAM).
|
||||||
|
- https://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contenggrantingworkloadaccesstoresources.htm
|
||||||
- "resource_principal_auth"
|
- "resource_principal_auth"
|
||||||
- use resource principals to make API calls
|
- use resource principals to make API calls
|
||||||
- "no_auth"
|
- "no_auth"
|
||||||
|
|
@ -704,6 +707,17 @@ Properties:
|
||||||
- "AES256"
|
- "AES256"
|
||||||
- AES256
|
- AES256
|
||||||
|
|
||||||
|
#### --oos-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_OOS_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
## Backend commands
|
## Backend commands
|
||||||
|
|
||||||
Here are the commands specific to the oracleobjectstorage backend.
|
Here are the commands specific to the oracleobjectstorage backend.
|
||||||
|
|
|
||||||
|
|
@ -288,4 +288,15 @@ Properties:
|
||||||
- Type: string
|
- Type: string
|
||||||
- Required: false
|
- Required: false
|
||||||
|
|
||||||
|
#### --pcloud-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_PCLOUD_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
|
||||||
|
|
@ -240,6 +240,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,RightSpace,RightPeriod,InvalidUtf8,Dot
|
- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,RightSpace,RightPeriod,InvalidUtf8,Dot
|
||||||
|
|
||||||
|
#### --pikpak-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_PIKPAK_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
## Backend commands
|
## Backend commands
|
||||||
|
|
||||||
Here are the commands specific to the pikpak backend.
|
Here are the commands specific to the pikpak backend.
|
||||||
|
|
|
||||||
|
|
@ -202,6 +202,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot
|
- Default: Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot
|
||||||
|
|
||||||
|
#### --premiumizeme-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_PREMIUMIZEME_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
|
||||||
|
|
@ -331,6 +331,17 @@ Properties:
|
||||||
- Type: bool
|
- Type: bool
|
||||||
- Default: true
|
- Default: true
|
||||||
|
|
||||||
|
#### --protondrive-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_PROTONDRIVE_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
|
- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
|
||||||
|
|
||||||
|
#### --putio-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_PUTIO_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
|
||||||
|
|
@ -310,6 +310,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,Ctl,InvalidUtf8
|
- Default: Slash,Ctl,InvalidUtf8
|
||||||
|
|
||||||
|
#### --qingstor-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_QINGSTOR_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
|
||||||
|
|
@ -607,6 +607,26 @@ See the [config password](/commands/rclone_config_password/) command for more in
|
||||||
|
|
||||||
**Authentication is required for this call.**
|
**Authentication is required for this call.**
|
||||||
|
|
||||||
|
### config/paths: Reads the config file path and other important paths. {#config-paths}
|
||||||
|
|
||||||
|
Returns a JSON object with the following keys:
|
||||||
|
|
||||||
|
- config: path to config file
|
||||||
|
- cache: path to root of cache directory
|
||||||
|
- temp: path to root of temporary directory
|
||||||
|
|
||||||
|
Eg
|
||||||
|
|
||||||
|
{
|
||||||
|
"cache": "/home/USER/.cache/rclone",
|
||||||
|
"config": "/home/USER/.rclone.conf",
|
||||||
|
"temp": "/tmp"
|
||||||
|
}
|
||||||
|
|
||||||
|
See the [config paths](/commands/rclone_config_paths/) command for more information on the above.
|
||||||
|
|
||||||
|
**Authentication is required for this call.**
|
||||||
|
|
||||||
### config/providers: Shows how providers are configured in the config file. {#config-providers}
|
### config/providers: Shows how providers are configured in the config file. {#config-providers}
|
||||||
|
|
||||||
Returns a JSON object:
|
Returns a JSON object:
|
||||||
|
|
@ -847,15 +867,12 @@ Returns the following values:
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"bytes": total transferred bytes for this file,
|
"bytes": total transferred bytes for this file,
|
||||||
"eta": estimated time in seconds until file transfer completion (may be nil)
|
"eta": estimated time in seconds until file transfer completion
|
||||||
"name": name of the file,
|
"name": name of the file,
|
||||||
"percentage": progress of the file transfer in percent,
|
"percentage": progress of the file transfer in percent,
|
||||||
"speed": average speed over the whole transfer in bytes per second,
|
"speed": average speed over the whole transfer in bytes per second,
|
||||||
"speedAvg": current speed in bytes per second as an exponentially weighted moving average,
|
"speedAvg": current speed in bytes per second as an exponentially weighted moving average,
|
||||||
"size": size of the file in bytes
|
"size": size of the file in bytes
|
||||||
"group": stats group this transfer is part of
|
|
||||||
"srcFs": name of the source remote (not present if not known)
|
|
||||||
"dstFs": name of the destination remote (not present if not known)
|
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"checking": an array of names of currently active file checks
|
"checking": an array of names of currently active file checks
|
||||||
|
|
@ -907,12 +924,9 @@ Returns the following values:
|
||||||
"size": size of the file in bytes,
|
"size": size of the file in bytes,
|
||||||
"bytes": total transferred bytes for this file,
|
"bytes": total transferred bytes for this file,
|
||||||
"checked": if the transfer is only checked (skipped, deleted),
|
"checked": if the transfer is only checked (skipped, deleted),
|
||||||
"started_at": time the transfer was started at (RFC3339 format, eg `"2000-01-01T01:00:00.085742121Z"`),
|
"timestamp": integer representing millisecond unix epoch,
|
||||||
"completed_at": time the transfer was completed at (RFC3339 format, only present if transfer is completed),
|
|
||||||
"error": string description of the error (empty if successful),
|
"error": string description of the error (empty if successful),
|
||||||
"group": string representing which stats group this is part of,
|
"jobid": id of the job that this transfer belongs to
|
||||||
"srcFs": name of the source remote (not present if not known),
|
|
||||||
"dstFs": name of the destination remote (not present if not known),
|
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
@ -1398,6 +1412,50 @@ This command does not have a command line equivalent so use this instead:
|
||||||
|
|
||||||
rclone rc --loopback operations/fsinfo fs=remote:
|
rclone rc --loopback operations/fsinfo fs=remote:
|
||||||
|
|
||||||
|
### operations/hashsum: Produces a hashsum file for all the objects in the path. {#operations-hashsum}
|
||||||
|
|
||||||
|
Produces a hash file for all the objects in the path using the hash
|
||||||
|
named. The output is in the same format as the standard
|
||||||
|
md5sum/sha1sum tool.
|
||||||
|
|
||||||
|
This takes the following parameters:
|
||||||
|
|
||||||
|
- fs - a remote name string e.g. "drive:" for the source, "/" for local filesystem
|
||||||
|
- this can point to a file and just that file will be returned in the listing.
|
||||||
|
- hashType - type of hash to be used
|
||||||
|
- download - check by downloading rather than with hash (boolean)
|
||||||
|
- base64 - output the hashes in base64 rather than hex (boolean)
|
||||||
|
|
||||||
|
If you supply the download flag, it will download the data from the
|
||||||
|
remote and create the hash on the fly. This can be useful for remotes
|
||||||
|
that don't support the given hash or if you really want to check all
|
||||||
|
the data.
|
||||||
|
|
||||||
|
Note that if you wish to supply a checkfile to check hashes against
|
||||||
|
the current files then you should use operations/check instead of
|
||||||
|
operations/hashsum.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
|
||||||
|
- hashsum - array of strings of the hashes
|
||||||
|
- hashType - type of hash used
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
$ rclone rc --loopback operations/hashsum fs=bin hashType=MD5 download=true base64=true
|
||||||
|
{
|
||||||
|
"hashType": "md5",
|
||||||
|
"hashsum": [
|
||||||
|
"WTSVLpuiXyJO_kGzJerRLg== backend-versions.sh",
|
||||||
|
"v1b_OlWCJO9LtNq3EIKkNQ== bisect-go-rclone.sh",
|
||||||
|
"VHbmHzHh4taXzgag8BAIKQ== bisect-rclone.sh",
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
See the [hashsum](/commands/rclone_hashsum/) command for more information on the above.
|
||||||
|
|
||||||
|
**Authentication is required for this call.**
|
||||||
|
|
||||||
### operations/list: List the given remote and path in JSON format {#operations-list}
|
### operations/list: List the given remote and path in JSON format {#operations-list}
|
||||||
|
|
||||||
This takes the following parameters:
|
This takes the following parameters:
|
||||||
|
|
@ -1764,7 +1822,9 @@ This takes the following parameters
|
||||||
- ignoreListingChecksum - Do not use checksums for listings
|
- ignoreListingChecksum - Do not use checksums for listings
|
||||||
- resilient - Allow future runs to retry after certain less-serious errors, instead of requiring resync.
|
- resilient - Allow future runs to retry after certain less-serious errors, instead of requiring resync.
|
||||||
Use at your own risk!
|
Use at your own risk!
|
||||||
- workdir - server directory for history files (default: /home/ncw/.cache/rclone/bisync)
|
- workdir - server directory for history files (default: `~/.cache/rclone/bisync`)
|
||||||
|
- backupdir1 - --backup-dir for Path1. Must be a non-overlapping path on the same remote.
|
||||||
|
- backupdir2 - --backup-dir for Path2. Must be a non-overlapping path on the same remote.
|
||||||
- noCleanup - retain working files
|
- noCleanup - retain working files
|
||||||
|
|
||||||
See [bisync command help](https://rclone.org/commands/rclone_bisync/)
|
See [bisync command help](https://rclone.org/commands/rclone_bisync/)
|
||||||
|
|
|
||||||
|
|
@ -1366,10 +1366,10 @@ Properties:
|
||||||
|
|
||||||
#### --s3-upload-concurrency
|
#### --s3-upload-concurrency
|
||||||
|
|
||||||
Concurrency for multipart uploads.
|
Concurrency for multipart uploads and copies.
|
||||||
|
|
||||||
This is the number of chunks of the same file that are uploaded
|
This is the number of chunks of the same file that are uploaded
|
||||||
concurrently.
|
concurrently for multipart uploads and copies.
|
||||||
|
|
||||||
If you are uploading small numbers of large files over high-speed links
|
If you are uploading small numbers of large files over high-speed links
|
||||||
and these uploads do not fully utilize your bandwidth, then increasing
|
and these uploads do not fully utilize your bandwidth, then increasing
|
||||||
|
|
@ -1418,6 +1418,19 @@ Properties:
|
||||||
- Type: bool
|
- Type: bool
|
||||||
- Default: false
|
- Default: false
|
||||||
|
|
||||||
|
#### --s3-use-dual-stack
|
||||||
|
|
||||||
|
If true use AWS S3 dual-stack endpoint (IPv6 support).
|
||||||
|
|
||||||
|
See [AWS Docs on Dualstack Endpoints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/dual-stack-endpoints.html)
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: use_dual_stack
|
||||||
|
- Env Var: RCLONE_S3_USE_DUAL_STACK
|
||||||
|
- Type: bool
|
||||||
|
- Default: false
|
||||||
|
|
||||||
#### --s3-use-accelerate-endpoint
|
#### --s3-use-accelerate-endpoint
|
||||||
|
|
||||||
If true use the AWS S3 accelerated endpoint.
|
If true use the AWS S3 accelerated endpoint.
|
||||||
|
|
@ -1722,6 +1735,25 @@ Properties:
|
||||||
- Type: Time
|
- Type: Time
|
||||||
- Default: off
|
- Default: off
|
||||||
|
|
||||||
|
#### --s3-version-deleted
|
||||||
|
|
||||||
|
Show deleted file markers when using versions.
|
||||||
|
|
||||||
|
This shows deleted file markers in the listing when using versions. These will appear
|
||||||
|
as 0 size files. The only operation which can be performed on them is deletion.
|
||||||
|
|
||||||
|
Deleting a delete marker will reveal the previous version.
|
||||||
|
|
||||||
|
Deleted files will always show with a timestamp.
|
||||||
|
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: version_deleted
|
||||||
|
- Env Var: RCLONE_S3_VERSION_DELETED
|
||||||
|
- Type: bool
|
||||||
|
- Default: false
|
||||||
|
|
||||||
#### --s3-decompress
|
#### --s3-decompress
|
||||||
|
|
||||||
If set this will decompress gzip encoded objects.
|
If set this will decompress gzip encoded objects.
|
||||||
|
|
@ -1872,6 +1904,17 @@ Properties:
|
||||||
- Type: Tristate
|
- Type: Tristate
|
||||||
- Default: unset
|
- Default: unset
|
||||||
|
|
||||||
|
#### --s3-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_S3_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
### Metadata
|
### Metadata
|
||||||
|
|
||||||
User metadata is stored as x-amz-meta- keys. S3 metadata keys are case insensitive and are always returned in lower case.
|
User metadata is stored as x-amz-meta- keys. S3 metadata keys are case insensitive and are always returned in lower case.
|
||||||
|
|
|
||||||
|
|
@ -389,5 +389,16 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8
|
- Default: Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8
|
||||||
|
|
||||||
|
#### --seafile-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_SEAFILE_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1042,6 +1042,17 @@ Properties:
|
||||||
- Type: bool
|
- Type: bool
|
||||||
- Default: false
|
- Default: false
|
||||||
|
|
||||||
|
#### --sftp-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_SFTP_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
|
||||||
|
|
@ -303,6 +303,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot
|
- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot
|
||||||
|
|
||||||
|
#### --sharefile-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_SHAREFILE_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -194,6 +194,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,Question,Hash,Percent,Del,Ctl,InvalidUtf8,Dot
|
- Default: Slash,Question,Hash,Percent,Del,Ctl,InvalidUtf8,Dot
|
||||||
|
|
||||||
|
#### --sia-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_SIA_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
|
||||||
|
|
@ -248,4 +248,15 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot
|
- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot
|
||||||
|
|
||||||
|
#### --smb-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_SMB_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
|
||||||
|
|
@ -293,6 +293,21 @@ Properties:
|
||||||
- Type: string
|
- Type: string
|
||||||
- Required: false
|
- Required: false
|
||||||
|
|
||||||
|
### Advanced options
|
||||||
|
|
||||||
|
Here are the Advanced options specific to storj (Storj Decentralized Cloud Storage).
|
||||||
|
|
||||||
|
#### --storj-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_STORJ_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
|
||||||
|
|
@ -272,6 +272,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,Ctl,InvalidUtf8,Dot
|
- Default: Slash,Ctl,InvalidUtf8,Dot
|
||||||
|
|
||||||
|
#### --sugarsync-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_SUGARSYNC_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
|
||||||
|
|
@ -587,6 +587,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,InvalidUtf8
|
- Default: Slash,InvalidUtf8
|
||||||
|
|
||||||
|
#### --swift-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_SWIFT_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
|
||||||
|
|
@ -287,6 +287,17 @@ Properties:
|
||||||
- Type: SizeSuffix
|
- Type: SizeSuffix
|
||||||
- Default: 1Gi
|
- Default: 1Gi
|
||||||
|
|
||||||
|
#### --union-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_UNION_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
### Metadata
|
### Metadata
|
||||||
|
|
||||||
Any metadata supported by the underlying remote is read and written.
|
Any metadata supported by the underlying remote is read and written.
|
||||||
|
|
|
||||||
|
|
@ -146,6 +146,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,LtGt,DoubleQuote,BackQuote,Del,Ctl,LeftSpace,InvalidUtf8,Dot
|
- Default: Slash,LtGt,DoubleQuote,BackQuote,Del,Ctl,LeftSpace,InvalidUtf8,Dot
|
||||||
|
|
||||||
|
#### --uptobox-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_UPTOBOX_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
|
||||||
|
|
@ -272,6 +272,28 @@ Properties:
|
||||||
- Type: SizeSuffix
|
- Type: SizeSuffix
|
||||||
- Default: 10Mi
|
- Default: 10Mi
|
||||||
|
|
||||||
|
#### --webdav-owncloud-exclude-shares
|
||||||
|
|
||||||
|
Exclude ownCloud shares
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: owncloud_exclude_shares
|
||||||
|
- Env Var: RCLONE_WEBDAV_OWNCLOUD_EXCLUDE_SHARES
|
||||||
|
- Type: bool
|
||||||
|
- Default: false
|
||||||
|
|
||||||
|
#### --webdav-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_WEBDAV_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Provider notes
|
## Provider notes
|
||||||
|
|
|
||||||
|
|
@ -209,6 +209,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Slash,Del,Ctl,InvalidUtf8,Dot
|
- Default: Slash,Del,Ctl,InvalidUtf8,Dot
|
||||||
|
|
||||||
|
#### --yandex-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_YANDEX_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
|
||||||
|
|
@ -237,6 +237,17 @@ Properties:
|
||||||
- Type: Encoding
|
- Type: Encoding
|
||||||
- Default: Del,Ctl,InvalidUtf8
|
- Default: Del,Ctl,InvalidUtf8
|
||||||
|
|
||||||
|
#### --zoho-description
|
||||||
|
|
||||||
|
Description of the remote
|
||||||
|
|
||||||
|
Properties:
|
||||||
|
|
||||||
|
- Config: description
|
||||||
|
- Env Var: RCLONE_ZOHO_DESCRIPTION
|
||||||
|
- Type: string
|
||||||
|
- Required: false
|
||||||
|
|
||||||
{{< rem autogenerated options stop >}}
|
{{< rem autogenerated options stop >}}
|
||||||
|
|
||||||
## Setting up your own client_id
|
## Setting up your own client_id
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,26 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
set -e
|
||||||
|
|
||||||
|
NAME=vsftpdtls
|
||||||
|
USER=rclone
|
||||||
|
PASS=TiffedRestedSian4
|
||||||
|
|
||||||
|
. $(dirname "$0")/docker.bash
|
||||||
|
|
||||||
|
start() {
|
||||||
|
docker run --rm -d --name $NAME \
|
||||||
|
-e "FTP_USER=rclone" \
|
||||||
|
-e "FTP_PASS=$PASS" \
|
||||||
|
rclone/vsftpd
|
||||||
|
|
||||||
|
echo type=ftp
|
||||||
|
echo host=$(docker_ip)
|
||||||
|
echo user=$USER
|
||||||
|
echo pass=$(rclone obscure $PASS)
|
||||||
|
echo writing_mdtm=true
|
||||||
|
echo encoding=Ctl,LeftPeriod,Slash
|
||||||
|
echo _connect=$(docker_ip):21
|
||||||
|
}
|
||||||
|
|
||||||
|
. $(dirname "$0")/run.bash
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 23 KiB |
Loading…
Reference in New Issue