extern/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2024-11-07 09:04:52 +01:00
Code Issues Packages Projects Releases Wiki Activity

Version v1.68.0

Browse Source
This commit is contained in:
Nick Craig-Wood 2024-09-08 16:21:56 +01:00
parent 3f7651291b
commit 49f69196c2
105 changed files with 13735 additions and 4942 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3964
MANUAL.html generated
View File

File diff suppressed because it is too large Load Diff

3892
MANUAL.md generated
View File

File diff suppressed because it is too large Load Diff

3790
MANUAL.txt generated
View File

File diff suppressed because it is too large Load Diff

3
bin/make_backend_docs.py
View File

@ -32,6 +32,9 @@ def alter_doc(backend):
"""Alter the documentation for backend"""
rclone_bin_dir = Path(sys.path[0]).parent.absolute()
doc_file = "docs/content/"+backend+".md"
doc_file2 = "docs/content/"+backend+"/_index.md"
if not os.path.exists(doc_file) and os.path.exists(doc_file2):
doc_file = doc_file2
if not os.path.exists(doc_file):
raise ValueError("Didn't find doc file %s" % (doc_file,))
new_file = doc_file+"~new~"

4
bin/make_manual.py
View File

@ -64,7 +64,7 @@ docs = [
"azurefiles.md",
"onedrive.md",
"opendrive.md",
"oracleobjectstorage.md",
"oracleobjectstorage/_index.md",
"qingstor.md",
"quatrix.md",
"sia.md",
@ -81,7 +81,6 @@ docs = [
"smb.md",
"storj.md",
"sugarsync.md",
"tardigrade.md", # stub only to redirect to storj.md
"ulozto.md",
"uptobox.md",
"union.md",
@ -159,6 +158,7 @@ def read_doc(doc):
def check_docs(docpath):
"""Check all the docs are in docpath"""
files = set(f for f in os.listdir(docpath) if f.endswith(".md"))
files.update(f for f in docs if os.path.exists(os.path.join(docpath,f)))
files -= set(ignore_docs)
docs_set = set(docs)
if files == docs_set:

121
docs/content/changelog.md
View File

@ -5,6 +5,127 @@ description: "Rclone Changelog"
# Changelog
## v1.68.0 - 2024-09-08
[See commits](https://github.com/rclone/rclone/compare/v1.67.0...v1.68.0)
* New backends
* [Files.com](/filescom) (Sam Harrison)
* [Gofile](/gofile/) (Nick Craig-Wood)
* [Pixeldrain](/pixeldrain/) (Fornax)
* Changed backends
* [S3](/s3/) backend updated to use [AWS SDKv2](https://github.com/aws/aws-sdk-go-v2) as v1 is now unsupported.
* The matrix of providers and auth methods is huge and there could be problems with obscure combinations.
* Please report problems in a [new issue](https://github.com/rclone/rclone/issues/new/choose) on Github.
* New commands
* [config encryption](/commands/rclone_config_encryption/): set, remove and check to manage config file encryption (Nick Craig-Wood)
* New Features
* build
* Update to go1.23 and make go1.21 the minimum required version (Nick Craig-Wood)
* Update all dependencies (Nick Craig-Wood)
* Disable wasm/js build due to [go bug #64856](https://github.com/golang/go/issues/64856) (Nick Craig-Wood)
* Enable custom linting rules with ruleguard via gocritic (albertony)
* Update logging statements to make `--use-json-log` work always (albertony)
* Adding new code quality tests and fixing the fallout (albertony)
* config
* Internal config re-organised to be more consistent and make it available from the rc (Nick Craig-Wood)
* Avoid remotes with empty names from the environment (albertony)
* Make listing of remotes more consistent (albertony)
* Make getting config values more consistent (albertony)
* Use `--password-command` to set config file password if supplied (Nick Craig-Wood)
* doc fixes (albertony, crystalstall, David Seifert, Eng Zer Jun, Ernie Hershey, Florian Klink, John Oxley, kapitainsky, Mathieu Moreau, Nick Craig-Wood, nipil, Pétr Bozsó, Russ Bubley, Sam Harrison, Thearas, URenko, Will Miles, yuval-cloudinary)
* fs: Allow semicolons as well as spaces in `--bwlimit` timetable parsing (Kyle Reynolds)
* help
* Global flags help command now takes glob filter (albertony)
* Make help command output less distracting (albertony)
* lib/encoder: Add Raw encoding for use where no encoding at all is required, eg `--local-encoding Raw` (URenko)
* listremotes: Added options for filtering, ordering and json output (albertony)
* nfsmount
* Make the `--sudo` flag work for umount as well as mount (Nick Craig-Wood)
* Add `-o tcp` option to NFS mount options to fix mounting under Linux (Nick Craig-Wood)
* operations: copy: generate stable partial suffix (Georg Welzel)
* rc
* Add [options/info](/rc/#options-info) call to enumerate options (Nick Craig-Wood)
* Add option blocks parameter to [options/get](/rc/#options-get) and [options/info](/rc/#options-info) (Nick Craig-Wood)
* Add [vfs/queue](/rc/#vfs-queue) to show the status of the upload queue (Nick Craig-Wood)
* Add [vfs/queue-set-expiry](/rc/#vfs-queue-set-expiry) to adjust expiry of items in the VFS queue (Nick Craig-Wood)
* Add `--unix-socket` option to `rc` command (Florian Klink)
* Prevent unmount rc command from sending a `STOPPING=1` sd-notify message (AThePeanut4)
* rcserver: Implement [prometheus metrics](/docs/#metrics) on a dedicated port (Oleg Kunitsyn)
* serve dlna
* Also look at "Subs" subdirectory (Florian Klink)
* Don't swallow `video.{idx,sub}` (Florian Klink)
* Set more correct mime type (Florian Klink)
* serve nfs
* Implement on disk cache for file handles selected with `--nfs-cache-type` (Nick Craig-Wood)
* Add tracing to filesystem calls (Nick Craig-Wood)
* Mask unimplemented error from chmod (Nick Craig-Wood)
* Unify the nfs library logging with rclone's logging better (Nick Craig-Wood)
* Fix incorrect user id and group id exported to NFS (Nick Craig-Wood)
* serve s3
* Implement `--auth-proxy` (Sawjan Gurung)
* Update to AWS SDKv2 by updating `github.com/rclone/gofakes3` (Nick Craig-Wood)
* Bug Fixes
* bisync: Fix sync time problems with backends that round time (eg Dropbox) (nielash)
* serve dlna: Fix panic: invalid argument to Int63n (Nick Craig-Wood)
* VFS
* Add [--vfs-read-chunk-streams](/commands/rclone_mount/#vfs-read-chunk-streams-0-1) to parallel read chunks from files (Nick Craig-Wood)
* This can increase mount performance on high bandwidth or large latency links
* Fix cache encoding with special characters (URenko)
* Local
* Fix encoding of root path fix (URenko)
* Add server-side copy (using clone) with xattrs on macOS (nielash)
* `--local-no-clone` flag to disable cloning for server-side copies (nielash)
* Support setting custom `--metadata` during server-side Copy (nielash)
* Azure Blob
* Allow anonymous access for public resources (Nick Craig-Wood)
* B2
* Include custom upload headers in large file info (Pat Patterson)
* Drive
* Fix copying Google Docs to a backend which only supports SHA1 (Nick Craig-Wood)
* Fichier
* Fix detection of Flood Detected error (Nick Craig-Wood)
* Fix server side move (Nick Craig-Wood)
* HTTP
* Reload client certificates on expiry (Saleh Dindar)
* Support listening on passed FDs (Florian Klink)
* Jottacloud
* Fix setting of metadata on server side move (albertony)
* Onedrive
* Fix nil pointer error when uploading small files (Nick Craig-Wood)
* Pcloud
* Implement `SetModTime` (Georg Welzel)
* Implement `OpenWriterAt` feature to enable multipart uploads (Georg Welzel)
* Pikpak
* Improve data consistency by ensuring async tasks complete (wiserain)
* Implement custom hash to replace wrong sha1 (wiserain)
* Fix error with `copyto` command (wiserain)
* Optimize file move by removing unnecessary `readMetaData()` call (wiserain)
* Non-buffered hash calculation for local source files (wiserain)
* Optimize upload by pre-fetching gcid from API (wiserain)
* Correct file transfer progress for uploads by hash (wiserain)
* Update to using AWS SDK v2 (wiserain)
* S3
* Update to using AWS SDK v2 (Nick Craig-Wood)
* Add `--s3-sdk-log-mode` to control SDKv2 debugging (Nick Craig-Wood)
* Fix incorrect region for Magalu provider (Filipe Herculano)
* Allow restoring from intelligent-tiering storage class (Pawel Palucha)
* SFTP
* Use `uint32` for mtime to save memory (Tomasz Melcer)
* Ignore useless errors when closing the connection pool (Nick Craig-Wood)
* Support listening on passed FDs (Florian Klink)
* Swift
* Add workarounds for bad listings in Ceph RGW (Paul Collins)
* Add total/free space info in `about` command. (fsantagostinobietti)
* Ulozto
* Fix upload of > 2GB files on 32 bit platforms (Tobias Markus)
* WebDAV
* Add `--webdav-unix-socket-path` to connect to a unix socket (Florian Klink)
* Yandex
* Implement custom user agent to help with upload speeds (Sebastian Bünger)
* Zoho
* Fix inefficiencies uploading with new API to avoid throttling (Nick Craig-Wood)
## v1.67.0 - 2024-06-14
[See commits](https://github.com/rclone/rclone/compare/v1.66.0...v1.67.0)

65
docs/content/commands/rclone.md
View File

@ -3,12 +3,11 @@ title: "rclone"
description: "Show help for rclone commands, flags and backends."
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/ and as part of making a release run "make commanddocs"
---
## rclone
# rclone
Show help for rclone commands, flags and backends.
### Synopsis
## Synopsis
Rclone syncs files to and from cloud storage providers as well as
mounting them, listing them in lots of different ways.
@ -22,7 +21,7 @@ documentation, changelog and configuration walkthroughs.
rclone [flags]
```
### Options
## Options
```
--alias-description string Description of the remote
@ -123,7 +122,7 @@ rclone [flags]
--box-token-url string Token server url
--box-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (>= 50 MiB) (default 50Mi)
--buffer-size SizeSuffix In memory buffer size when reading files for each --transfer (default 16Mi)
--bwlimit BwTimetable Bandwidth limit in KiB/s, or use suffix B|K|M|G|T|P or a full timetable.
--bwlimit BwTimetable Bandwidth limit in KiB/s, or use suffix B|K|M|G|T|P or a full timetable
--bwlimit-file BwTimetable Bandwidth limit per file in KiB/s, or use suffix B|K|M|G|T|P or a full timetable
--ca-cert stringArray CA certificate used to verify servers
--cache-chunk-clean-interval Duration How often should the cache perform cleanups of the chunk storage (default 1m0s)
@ -150,7 +149,7 @@ rclone [flags]
--cache-writes Cache file data on writes through the FS
--check-first Do all the checks before starting transfers
--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-description string Description of the remote
--chunker-fail-hard Choose how chunker should handle files with missing or invalid chunks
@ -161,7 +160,7 @@ rclone [flags]
--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
--compare-dest stringArray Include additional comma separated server-side paths during comparison
--compare-dest stringArray Include additional server-side paths during comparison
--compress-description string Description of the remote
--compress-level int GZIP compression level (-2 to 9) (default -1)
--compress-mode string Compression mode (default "gzip")
@ -192,7 +191,7 @@ rclone [flags]
--delete-during When synchronizing, delete files during transfer
--delete-excluded Delete files on dest excluded from sync
--disable string Disable a comma separated list of features (use --disable help to see a list)
--disable-http-keep-alives Disable HTTP keep-alives and use each connection once.
--disable-http-keep-alives Disable HTTP keep-alives and use each connection once
--disable-http2 Disable HTTP/2 in the global transport
--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
@ -288,6 +287,12 @@ rclone [flags]
--filefabric-version string Version read from the file fabric
--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)
--filescom-api-key string The API key used to authenticate with Files.com
--filescom-description string Description of the remote
--filescom-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot)
--filescom-password string The password used to authenticate with Files.com (obscured)
--filescom-site string Your site subdomain (e.g. mysite) or custom domain (e.g. myfiles.customdomain.com)
--filescom-username string The username used to authenticate with Files.com
-f, --filter stringArray Add a file filtering rule
--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
@ -336,6 +341,12 @@ rclone [flags]
--gcs-token string OAuth Access Token as a JSON blob
--gcs-token-url string Token server url
--gcs-user-project string User project
--gofile-access-token string API Access token
--gofile-account-id string Account ID
--gofile-description string Description of the remote
--gofile-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftPeriod,RightPeriod,InvalidUtf8,Dot,Exclamation)
--gofile-list-chunk int Number of items to list in each call (default 1000)
--gofile-root-folder-id string ID of the root folder
--gphotos-auth-url string Auth server URL
--gphotos-batch-commit-timeout Duration Max time to wait for a batch to finish committing (default 10m0s)
--gphotos-batch-mode string Upload file batching sync|async|off (default "sync")
@ -445,6 +456,7 @@ rclone [flags]
--local-description string Description of the remote
--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-clone Disable reflink cloning for server-side copies
--local-no-preallocate Disable preallocation of disk space for transferred files
--local-no-set-modtime Disable setting modtime
--local-no-sparse Disable sparse files for multi-thread downloads
@ -498,6 +510,22 @@ rclone [flags]
--metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin)
--metadata-mapper SpaceSepList Program to run to transforming metadata before upload
--metadata-set stringArray Add metadata key=value when uploading
--metrics-addr stringArray IPaddress:Port or :Port to bind metrics server to (default [""])
--metrics-allow-origin string Origin which cross-domain request (CORS) can be executed from
--metrics-baseurl string Prefix for URLs - leave blank for root
--metrics-cert string TLS PEM key (concatenation of certificate and CA certificate)
--metrics-client-ca string Client certificate authority to verify clients with
--metrics-htpasswd string A htpasswd file - if not provided no authentication is done
--metrics-key string TLS PEM Private key
--metrics-max-header-bytes int Maximum size of request header (default 4096)
--metrics-min-tls-version string Minimum TLS version that is acceptable (default "tls1.0")
--metrics-pass string Password for authentication
--metrics-realm string Realm for authentication
--metrics-salt string Password hashing salt (default "dlPL2MqE")
--metrics-server-read-timeout Duration Timeout for server reading data (default 1h0m0s)
--metrics-server-write-timeout Duration Timeout for server writing data (default 1h0m0s)
--metrics-template string User-specified template
--metrics-user string User name for authentication
--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)
--modify-window Duration Max time diff to be considered the same (default 1ns)
@ -603,6 +631,10 @@ rclone [flags]
--pikpak-upload-concurrency int Concurrency for multipart uploads (default 5)
--pikpak-use-trash Send files to the trash instead of deleting permanently (default true)
--pikpak-user string Pikpak username
--pixeldrain-api-key string API key for your pixeldrain account
--pixeldrain-api-url string The API endpoint to connect to. In the vast majority of cases it's fine to leave (default "https://pixeldrain.com/api")
--pixeldrain-description string Description of the remote
--pixeldrain-root-folder-id string Root of the filesystem to use (default "me")
--premiumizeme-auth-url string Auth server URL
--premiumizeme-client-id string OAuth Client Id
--premiumizeme-client-secret string OAuth Client Secret
@ -651,12 +683,12 @@ rclone [flags]
--quatrix-skip-project-folders Skip project folders in operations
-q, --quiet Print as little stuff as possible
--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"])
--rc-allow-origin string Origin which cross-domain request (CORS) can be executed from
--rc-baseurl string Prefix for URLs - leave blank for root
--rc-cert string TLS PEM key (concatenation of certificate and CA certificate)
--rc-client-ca string Client certificate authority to verify clients with
--rc-enable-metrics Enable prometheus metrics on /metrics
--rc-enable-metrics Enable the Prometheus metrics path at the remote control server
--rc-files string Path to local files to serve on the HTTP server
--rc-htpasswd string A htpasswd file - if not provided no authentication is done
--rc-job-expire-duration Duration Expire finished async jobs older than this value (default 1m0s)
@ -712,6 +744,7 @@ rclone [flags]
--s3-provider string Choose your S3 provider
--s3-region string Region to connect to
--s3-requester-pays Enables requester pays option when interacting with S3 bucket
--s3-sdk-log-mode Bits Set to debug the SDK (default Off)
--s3-secret-access-key string AWS Secret Access Key (password)
--s3-server-side-encryption string The server-side encryption algorithm used when storing this object in S3
--s3-session-token string An AWS session token
@ -722,7 +755,6 @@ rclone [flags]
--s3-sse-customer-key-md5 string If using SSE-C you may provide the secret encryption key MD5 checksum (optional)
--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-sts-endpoint string Endpoint for STS
--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-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint
@ -732,6 +764,7 @@ rclone [flags]
--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-presigned-request Whether to use a presigned request or PutObject for single part uploads
--s3-use-unsigned-payload Tristate Whether to use an unsigned payload in PutObject (default unset)
--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-deleted Show deleted file markers when using versions
@ -852,10 +885,12 @@ rclone [flags]
--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-env-auth Get swift credentials from environment variables in standard OpenStack form
--swift-fetch-until-empty-page When paginating, always fetch unless we received an empty page
--swift-key string API key or password (OS_PASSWORD)
--swift-leave-parts-on-error If true avoid calling abort upload on a failure
--swift-no-chunk Don't chunk files during streaming upload
--swift-no-large-objects Disable support for static and dynamic large objects
--swift-partial-page-fetch-threshold int When paginating, fetch if the current page is within this percentage of the limit
--swift-region string Region name - optional (OS_REGION_NAME)
--swift-storage-policy string The storage policy to use when creating a new container
--swift-storage-url string Storage URL - optional (OS_STORAGE_URL)
@ -866,7 +901,7 @@ rclone [flags]
--swift-user string User name to log in (OS_USERNAME)
--swift-user-id string User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID)
--syslog Use Syslog for logging
--syslog-facility string Facility for syslog, e.g. KERN,USER,... (default "DAEMON")
--syslog-facility string Facility for syslog, e.g. KERN,USER (default "DAEMON")
--temp-dir string Directory rclone will use for temporary files (default "/tmp")
--timeout Duration IO idle timeout (default 5m0s)
--tpslimit float Limit HTTP transactions per second to this
@ -897,7 +932,7 @@ rclone [flags]
--use-json-log Use json log format
--use-mmap Use mmap allocator (see docs)
--use-server-modtime Use server modified time instead of object metadata
--user-agent string Set the user-agent to a specified string (default "rclone/v1.67.0")
--user-agent string Set the user-agent to a specified string (default "rclone/v1.68.0")
-v, --verbose count Print lots more stuff (repeat for more)
-V, --version Print the version number
--webdav-bearer-token string Bearer token instead of user/pass (e.g. a Macaroon)
@ -910,6 +945,7 @@ rclone [flags]
--webdav-owncloud-exclude-shares Exclude ownCloud shares
--webdav-pacer-min-sleep Duration Minimum time to sleep between API calls (default 10ms)
--webdav-pass string Password (obscured)
--webdav-unix-socket string Path to a unix domain socket to dial to, instead of opening a TCP connection directly
--webdav-url string URL of http host to connect to
--webdav-user string User name
--webdav-vendor string Name of the WebDAV site/service/software you are using
@ -919,6 +955,7 @@ rclone [flags]
--yandex-description string Description of the remote
--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-spoof-ua Set the user agent to match an official version of the yandex disk client. May help with upload performance (default true)
--yandex-token string OAuth Access Token as a JSON blob
--yandex-token-url string Token server url
--zoho-auth-url string Auth server URL
@ -931,7 +968,7 @@ rclone [flags]
--zoho-token-url string Token server url
```
### SEE ALSO
## See Also
* [rclone about](/commands/rclone_about/) - Get quota information from the remote.
* [rclone authorize](/commands/rclone_authorize/) - Remote authorization.

6
docs/content/commands/rclone_about.md
View File

@ -10,8 +10,7 @@ Get quota information from the remote.
## Synopsis
`rclone about` prints quota information about a remote to standard
Prints quota information about a remote to standard
output. The output is typically used, free, quota and trash contents.
E.g. Typical output from `rclone about remote:` is:
@ -70,10 +69,9 @@ rclone about remote: [flags]
--json Format output as JSON
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

4
docs/content/commands/rclone_authorize.md
View File

@ -10,7 +10,6 @@ Remote authorization.
## Synopsis
Remote authorization. Used to authorize a remote or headless
rclone from a machine with a browser - use as instructed by
rclone config.
@ -32,10 +31,9 @@ rclone authorize [flags]
--template string The path to a custom Go template for generating HTML responses
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

11
docs/content/commands/rclone_backend.md
View File

@ -10,7 +10,6 @@ Run a backend-specific command.
## Synopsis
This runs a backend-specific command. The commands themselves (except
for "help" and "features") are defined by the backends and you should
see the backend docs for definitions.
@ -50,10 +49,12 @@ rclone backend <command> remote:path [opts] <args> [flags]
-o, --option stringArray Option in the form name=value or name
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Important Options
### Important Options
Important flags useful for most commands.
Important flags useful for most commands
```
-n, --dry-run Do a trial run with no permanent changes
@ -61,9 +62,7 @@ Important flags useful for most commands.
-v, --verbose count Print lots more stuff (repeat for more)
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

22
docs/content/commands/rclone_bisync.md
View File

@ -63,15 +63,17 @@ rclone bisync remote1:path1 remote2:path2 [flags]
--workdir string Use custom working dir - useful for testing. (default: {WORKDIR})
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Copy Options
### Copy Options
Flags for anything which can Copy a file.
Flags for anything which can copy a file
```
--check-first Do all the checks before starting transfers
-c, --checksum Check for changes with size & checksum (if available, or fallback to size only).
--compare-dest stringArray Include additional comma separated server-side paths during comparison
-c, --checksum Check for changes with size & checksum (if available, or fallback to size only)
--compare-dest stringArray Include additional server-side paths during comparison
--copy-dest stringArray Implies --compare-dest but also copies files from paths into destination
--cutoff-mode HARD|SOFT|CAUTIOUS Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD)
--ignore-case-sync Ignore case when synchronizing
@ -103,9 +105,9 @@ Flags for anything which can Copy a file.
-u, --update Skip files that are newer on the destination
```
## Important Options
### Important Options
Important flags useful for most commands.
Important flags useful for most commands
```
-n, --dry-run Do a trial run with no permanent changes
@ -113,9 +115,9 @@ Important flags useful for most commands.
-v, --verbose count Print lots more stuff (repeat for more)
```
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -142,9 +144,7 @@ Flags for filtering directory listings.
--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
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

17
docs/content/commands/rclone_cat.md
View File

@ -10,8 +10,7 @@ Concatenates any files and sends them to stdout.
## Synopsis
rclone cat sends any files to standard output.
Sends any files to standard output.
You can use it like this to output a single file
@ -59,10 +58,12 @@ rclone cat remote:path [flags]
--tail int Only print the last N characters
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -89,18 +90,16 @@ Flags for filtering directory listings.
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
```
## Listing Options
### Listing Options
Flags for listing directories.
Flags for listing directories
```
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

19
docs/content/commands/rclone_check.md
View File

@ -9,7 +9,6 @@ Checks the files in the source and destination match.
## Synopsis
Checks the files in the source and destination match. It compares
sizes and hashes (MD5 or SHA1) and logs a report of files that don't
match. It doesn't alter the source or destination.
@ -73,18 +72,20 @@ rclone check source:path dest:path [flags]
--one-way Check one way only, source files must exist on remote
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Check Options
### Check Options
Flags used for `rclone check`.
Flags used for check commands
```
--max-backlog int Maximum number of objects in sync or check backlog (default 10000)
```
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -111,18 +112,16 @@ Flags for filtering directory listings.
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
```
## Listing Options
### Listing Options
Flags for listing directories.
Flags for listing directories
```
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

15
docs/content/commands/rclone_checksum.md
View File

@ -10,7 +10,6 @@ Checks the files in the destination against a SUM file.
## Synopsis
Checks that hashsums of destination files match the SUM file.
It compares hashes (MD5, SHA1, etc) and logs a report of files which
don't match. It doesn't alter the file system.
@ -67,10 +66,12 @@ rclone checksum <hash> sumfile dst:path [flags]
--one-way Check one way only, source files must exist on remote
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -97,18 +98,16 @@ Flags for filtering directory listings.
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
```
## Listing Options
### Listing Options
Flags for listing directories.
Flags for listing directories
```
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

11
docs/content/commands/rclone_cleanup.md
View File

@ -10,7 +10,6 @@ Clean up the remote if possible.
## Synopsis
Clean up the remote if possible. Empty the trash or delete old file
versions. Not supported by all remotes.
@ -25,10 +24,12 @@ rclone cleanup remote:path [flags]
-h, --help help for cleanup
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Important Options
### Important Options
Important flags useful for most commands.
Important flags useful for most commands
```
-n, --dry-run Do a trial run with no permanent changes
@ -36,9 +37,7 @@ Important flags useful for most commands.
-v, --verbose count Print lots more stuff (repeat for more)
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

4
docs/content/commands/rclone_completion.md
View File

@ -12,7 +12,6 @@ Output completion script for a given shell.
## Synopsis
Generates a shell completion script for rclone.
Run with `--help` to list the supported shells.
@ -23,10 +22,9 @@ Run with `--help` to list the supported shells.
-h, --help help for completion
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.
* [rclone completion bash](/commands/rclone_completion_bash/) - Output bash completion script for rclone.

6
docs/content/commands/rclone_completion_bash.md
View File

@ -11,12 +11,11 @@ Output bash completion script for rclone.
## Synopsis
Generates a bash shell autocompletion script for rclone.
By default, when run without any arguments,
rclone genautocomplete bash
rclone completion bash
the generated script will be written to
@ -51,10 +50,9 @@ rclone completion bash [output_file] [flags]
-h, --help help for bash
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone completion](/commands/rclone_completion/) - Output completion script for a given shell.

6
docs/content/commands/rclone_completion_fish.md
View File

@ -11,13 +11,12 @@ Output fish completion script for rclone.
## Synopsis
Generates a fish autocompletion script for rclone.
This writes to /etc/fish/completions/rclone.fish by default so will
probably need to be run with sudo or as root, e.g.
sudo rclone genautocomplete fish
sudo rclone completion fish
Logout and login again to use the autocompletion scripts, or source
them directly
@ -40,10 +39,9 @@ rclone completion fish [output_file] [flags]
-h, --help help for fish
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone completion](/commands/rclone_completion/) - Output completion script for a given shell.

4
docs/content/commands/rclone_completion_powershell.md
View File

@ -11,7 +11,6 @@ Output powershell completion script for rclone.
## Synopsis
Generate the autocompletion script for powershell.
To load completions in your current shell session:
@ -34,10 +33,9 @@ rclone completion powershell [output_file] [flags]
-h, --help help for powershell
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone completion](/commands/rclone_completion/) - Output completion script for a given shell.

6
docs/content/commands/rclone_completion_zsh.md
View File

@ -11,13 +11,12 @@ Output zsh completion script for rclone.
## Synopsis
Generates a zsh autocompletion script for rclone.
This writes to /usr/share/zsh/vendor-completions/_rclone by default so will
probably need to be run with sudo or as root, e.g.
sudo rclone genautocomplete zsh
sudo rclone completion zsh
Logout and login again to use the autocompletion scripts, or source
them directly
@ -40,10 +39,9 @@ rclone completion zsh [output_file] [flags]
-h, --help help for zsh
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone completion](/commands/rclone_completion/) - Output completion script for a given shell.

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

@ -25,10 +25,9 @@ rclone config [flags]
-h, --help help for config
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.
* [rclone config create](/commands/rclone_config_create/) - Create a new remote with name, type and options.
@ -36,6 +35,7 @@ See the [global flags page](/flags/) for global options not listed here.
* [rclone config disconnect](/commands/rclone_config_disconnect/) - Disconnects user from remote
* [rclone config dump](/commands/rclone_config_dump/) - Dump the config file as JSON.
* [rclone config edit](/commands/rclone_config_edit/) - Enter an interactive configuration session.
* [rclone config encryption](/commands/rclone_config_encryption/) - set, remove and check the encryption for the config file
* [rclone config file](/commands/rclone_config_file/) - Show path of configuration file in use.
* [rclone config password](/commands/rclone_config_password/) - Update password in an existing remote.
* [rclone config paths](/commands/rclone_config_paths/) - Show paths used for configuration, cache, temp etc.

4
docs/content/commands/rclone_config_create.md
View File

@ -10,7 +10,6 @@ Create a new remote with name, type and options.
## Synopsis
Create a new remote of `name` with `type` and options. The options
should be passed in pairs of `key` `value` or as `key=value`.
@ -130,10 +129,9 @@ rclone config create name type [key value]* [flags]
--state string State - use with --continue
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

3
docs/content/commands/rclone_config_delete.md
View File

@ -18,10 +18,9 @@ rclone config delete name [flags]
-h, --help help for delete
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

4
docs/content/commands/rclone_config_disconnect.md
View File

@ -9,7 +9,6 @@ Disconnects user from remote
## Synopsis
This disconnects the remote: passed in to the cloud storage system.
This normally means revoking the oauth token.
@ -27,10 +26,9 @@ rclone config disconnect remote: [flags]
-h, --help help for disconnect
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

3
docs/content/commands/rclone_config_dump.md
View File

@ -18,10 +18,9 @@ rclone config dump [flags]
-h, --help help for dump
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

3
docs/content/commands/rclone_config_edit.md
View File

@ -25,10 +25,9 @@ rclone config edit [flags]
-h, --help help for edit
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

30
docs/content/commands/rclone_config_encryption.md Normal file
View File

@ -0,0 +1,30 @@
---
title: "rclone config encryption"
description: "set, remove and check the encryption for the config file"
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/encryption/ and as part of making a release run "make commanddocs"
---
# rclone config encryption
set, remove and check the encryption for the config file
## Synopsis
This command sets, clears and checks the encryption for the config file using
the subcommands below.
## Options
```
-h, --help help for encryption
```
See the [global flags page](/flags/) for global options not listed here.
## See Also
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.
* [rclone config encryption check](/commands/rclone_config_encryption_check/) - Check that the config file is encrypted
* [rclone config encryption remove](/commands/rclone_config_encryption_remove/) - Remove the config file encryption password
* [rclone config encryption set](/commands/rclone_config_encryption_set/) - Set or change the config file encryption password

37
docs/content/commands/rclone_config_encryption_check.md Normal file
View File

@ -0,0 +1,37 @@
---
title: "rclone config encryption check"
description: "Check that the config file is encrypted"
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/encryption/check/ and as part of making a release run "make commanddocs"
---
# rclone config encryption check
Check that the config file is encrypted
## Synopsis
This checks the config file is encrypted and that you can decrypt it.
It will attempt to decrypt the config using the password you supply.
If decryption fails it will return a non-zero exit code if using
`--password-command`, otherwise it will prompt again for the password.
If the config file is not encrypted it will return a non zero exit code.
```
rclone config encryption check [flags]
```
## Options
```
-h, --help help for check
```
See the [global flags page](/flags/) for global options not listed here.
## See Also
* [rclone config encryption](/commands/rclone_config_encryption/) - set, remove and check the encryption for the config file

38
docs/content/commands/rclone_config_encryption_remove.md Normal file
View File

@ -0,0 +1,38 @@
---
title: "rclone config encryption remove"
description: "Remove the config file encryption password"
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/encryption/remove/ and as part of making a release run "make commanddocs"
---
# rclone config encryption remove
Remove the config file encryption password
## Synopsis
Remove the config file encryption password
This removes the config file encryption, returning it to un-encrypted.
If `--password-command` is in use, this will be called to supply the old config
password.
If the config was not encrypted then no error will be returned and
this command will do nothing.
```
rclone config encryption remove [flags]
```
## Options
```
-h, --help help for remove
```
See the [global flags page](/flags/) for global options not listed here.
## See Also
* [rclone config encryption](/commands/rclone_config_encryption/) - set, remove and check the encryption for the config file

48
docs/content/commands/rclone_config_encryption_set.md Normal file
View File

@ -0,0 +1,48 @@
---
title: "rclone config encryption set"
description: "Set or change the config file encryption password"
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/encryption/set/ and as part of making a release run "make commanddocs"
---
# rclone config encryption set
Set or change the config file encryption password
## Synopsis
This command sets or changes the config file encryption password.
If there was no config password set then it sets a new one, otherwise
it changes the existing config password.
Note that if you are changing an encryption password using
`--password-command` then this will be called once to decrypt the
config using the old password and then again to read the new
password to re-encrypt the config.
When `--password-command` is called to change the password then the
environment variable `RCLONE_PASSWORD_CHANGE=1` will be set. So if
changing passwords programatically you can use the environment
variable to distinguish which password you must supply.
Alternatively you can remove the password first (with `rclone config
encryption remove`), then set it again with this command which may be
easier if you don't mind the unecrypted config file being on the disk
briefly.
```
rclone config encryption set [flags]
```
## Options
```
-h, --help help for set
```
See the [global flags page](/flags/) for global options not listed here.
## See Also
* [rclone config encryption](/commands/rclone_config_encryption/) - set, remove and check the encryption for the config file

3
docs/content/commands/rclone_config_file.md
View File

@ -18,10 +18,9 @@ rclone config file [flags]
-h, --help help for file
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

4
docs/content/commands/rclone_config_password.md
View File

@ -10,7 +10,6 @@ Update password in an existing remote.
## Synopsis
Update an existing remote's password. The password
should be passed in pairs of `key` `password` or as `key=password`.
The `password` should be passed in in clear (unobscured).
@ -34,10 +33,9 @@ rclone config password name [key value]+ [flags]
-h, --help help for password
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

3
docs/content/commands/rclone_config_paths.md
View File

@ -18,10 +18,9 @@ rclone config paths [flags]
-h, --help help for paths
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

3
docs/content/commands/rclone_config_providers.md
View File

@ -18,10 +18,9 @@ rclone config providers [flags]
-h, --help help for providers
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

4
docs/content/commands/rclone_config_reconnect.md
View File

@ -9,7 +9,6 @@ Re-authenticates user with remote.
## Synopsis
This reconnects remote: passed in to the cloud storage system.
To disconnect the remote use "rclone config disconnect".
@ -27,10 +26,9 @@ rclone config reconnect remote: [flags]
-h, --help help for reconnect
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

3
docs/content/commands/rclone_config_redacted.md
View File

@ -32,10 +32,9 @@ rclone config redacted [<remote>] [flags]
-h, --help help for redacted
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

3
docs/content/commands/rclone_config_show.md
View File

@ -18,10 +18,9 @@ rclone config show [<remote>] [flags]
-h, --help help for show
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

3
docs/content/commands/rclone_config_touch.md
View File

@ -18,10 +18,9 @@ rclone config touch [flags]
-h, --help help for touch
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

4
docs/content/commands/rclone_config_update.md
View File

@ -10,7 +10,6 @@ Update options in an existing remote.
## Synopsis
Update an existing remote's options. The options should be passed in
pairs of `key` `value` or as `key=value`.
@ -130,10 +129,9 @@ rclone config update name [key value]+ [flags]
--state string State - use with --continue
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

4
docs/content/commands/rclone_config_userinfo.md
View File

@ -9,7 +9,6 @@ Prints info about logged in user of remote.
## Synopsis
This prints the details of the person logged in to the cloud storage
system.
@ -25,10 +24,9 @@ rclone config userinfo remote: [flags]
--json Format output as JSON
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

27
docs/content/commands/rclone_copy.md
View File

@ -9,7 +9,6 @@ Copy files from source to dest, skipping identical files.
## Synopsis
Copy the source to the destination. Does not transfer files that are
identical on source and destination, testing by size and modification
time or MD5SUM. Doesn't delete files from the destination. If you
@ -87,15 +86,17 @@ rclone copy source:path dest:path [flags]
-h, --help help for copy
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Copy Options
### Copy Options
Flags for anything which can Copy a file.
Flags for anything which can copy a file
```
--check-first Do all the checks before starting transfers
-c, --checksum Check for changes with size & checksum (if available, or fallback to size only).
--compare-dest stringArray Include additional comma separated server-side paths during comparison
-c, --checksum Check for changes with size & checksum (if available, or fallback to size only)
--compare-dest stringArray Include additional server-side paths during comparison
--copy-dest stringArray Implies --compare-dest but also copies files from paths into destination
--cutoff-mode HARD|SOFT|CAUTIOUS Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD)
--ignore-case-sync Ignore case when synchronizing
@ -127,9 +128,9 @@ Flags for anything which can Copy a file.
-u, --update Skip files that are newer on the destination
```
## Important Options
### Important Options
Important flags useful for most commands.
Important flags useful for most commands
```
-n, --dry-run Do a trial run with no permanent changes
@ -137,9 +138,9 @@ Important flags useful for most commands.
-v, --verbose count Print lots more stuff (repeat for more)
```
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -166,18 +167,16 @@ Flags for filtering directory listings.
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
```
## Listing Options
### Listing Options
Flags for listing directories.
Flags for listing directories
```
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

27
docs/content/commands/rclone_copyto.md
View File

@ -10,7 +10,6 @@ Copy files from source to dest, skipping identical files.
## Synopsis
If source:path is a file or directory then it copies it to a file or
directory named dest:path.
@ -50,15 +49,17 @@ rclone copyto source:path dest:path [flags]
-h, --help help for copyto
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Copy Options
### Copy Options
Flags for anything which can Copy a file.
Flags for anything which can copy a file
```
--check-first Do all the checks before starting transfers
-c, --checksum Check for changes with size & checksum (if available, or fallback to size only).
--compare-dest stringArray Include additional comma separated server-side paths during comparison
-c, --checksum Check for changes with size & checksum (if available, or fallback to size only)
--compare-dest stringArray Include additional server-side paths during comparison
--copy-dest stringArray Implies --compare-dest but also copies files from paths into destination
--cutoff-mode HARD|SOFT|CAUTIOUS Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD)
--ignore-case-sync Ignore case when synchronizing
@ -90,9 +91,9 @@ Flags for anything which can Copy a file.
-u, --update Skip files that are newer on the destination
```
## Important Options
### Important Options
Important flags useful for most commands.
Important flags useful for most commands
```
-n, --dry-run Do a trial run with no permanent changes
@ -100,9 +101,9 @@ Important flags useful for most commands.
-v, --verbose count Print lots more stuff (repeat for more)
```
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -129,18 +130,16 @@ Flags for filtering directory listings.
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
```
## Listing Options
### Listing Options
Flags for listing directories.
Flags for listing directories
```
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

11
docs/content/commands/rclone_copyurl.md
View File

@ -10,7 +10,6 @@ Copy the contents of the URL supplied content to dest:path.
## Synopsis
Download a URL's content and copy it to the destination without saving
it in temporary storage.
@ -56,10 +55,12 @@ rclone copyurl https://example.com dest:path [flags]
--stdout Write the output to stdout rather than a file
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Important Options
### Important Options
Important flags useful for most commands.
Important flags useful for most commands
```
-n, --dry-run Do a trial run with no permanent changes
@ -67,9 +68,7 @@ Important flags useful for most commands.
-v, --verbose count Print lots more stuff (repeat for more)
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

25
docs/content/commands/rclone_cryptcheck.md
View File

@ -10,10 +10,9 @@ Cryptcheck checks the integrity of an encrypted remote.
## Synopsis
rclone cryptcheck checks a remote against a [crypted](/crypt/) remote.
This is the equivalent of running rclone [check](/commands/rclone_check/),
but able to check the checksums of the encrypted remote.
Checks a remote against a [crypted](/crypt/) remote. This is the equivalent
of running rclone [check](/commands/rclone_check/), but able to check the
checksums of the encrypted remote.
For it to work the underlying remote of the cryptedremote must support
some kind of checksum.
@ -76,18 +75,20 @@ rclone cryptcheck remote:path cryptedremote:path [flags]
--one-way Check one way only, source files must exist on remote
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Check Options
### Check Options
Flags used for `rclone check`.
Flags used for check commands
```
--max-backlog int Maximum number of objects in sync or check backlog (default 10000)
```
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -114,18 +115,16 @@ Flags for filtering directory listings.
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
```
## Listing Options
### Listing Options
Flags for listing directories.
Flags for listing directories
```
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

8
docs/content/commands/rclone_cryptdecode.md
View File

@ -10,9 +10,8 @@ Cryptdecode returns unencrypted file names.
## Synopsis
rclone cryptdecode returns unencrypted file names when provided with
a list of encrypted file names. List limit is 10 items.
Returns unencrypted file names when provided with a list of encrypted file
names. List limit is 10 items.
If you supply the `--reverse` flag, it will return encrypted file names.
@ -37,10 +36,9 @@ rclone cryptdecode encryptedremote: encryptedfilename [flags]
--reverse Reverse cryptdecode, encrypts filenames
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

12
docs/content/commands/rclone_dedupe.md
View File

@ -10,8 +10,6 @@ Interactively find duplicate filenames and delete/rename them.
## Synopsis
By default `dedupe` interactively finds files with duplicate
names and offers to delete all but one or rename them to be
different. This is known as deduping by name.
@ -130,10 +128,12 @@ rclone dedupe [mode] remote:path [flags]
-h, --help help for dedupe
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Important Options
### Important Options
Important flags useful for most commands.
Important flags useful for most commands
```
-n, --dry-run Do a trial run with no permanent changes
@ -141,9 +141,7 @@ Important flags useful for most commands.
-v, --verbose count Print lots more stuff (repeat for more)
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

19
docs/content/commands/rclone_delete.md
View File

@ -10,7 +10,6 @@ Remove the files in path.
## Synopsis
Remove the files in path. Unlike [purge](/commands/rclone_purge/) it
obeys include/exclude filters so can be used to selectively delete files.
@ -50,10 +49,12 @@ rclone delete remote:path [flags]
--rmdirs rmdirs removes empty directories but leaves root intact
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Important Options
### Important Options
Important flags useful for most commands.
Important flags useful for most commands
```
-n, --dry-run Do a trial run with no permanent changes
@ -61,9 +62,9 @@ Important flags useful for most commands.
-v, --verbose count Print lots more stuff (repeat for more)
```
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -90,18 +91,16 @@ Flags for filtering directory listings.
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
```
## Listing Options
### Listing Options
Flags for listing directories.
Flags for listing directories
```
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

11
docs/content/commands/rclone_deletefile.md
View File

@ -10,7 +10,6 @@ Remove a single file from remote.
## Synopsis
Remove a single file from remote. Unlike `delete` it cannot be used to
remove a directory and it doesn't obey include/exclude filters - if the specified file exists,
it will always be removed.
@ -26,10 +25,12 @@ rclone deletefile remote:path [flags]
-h, --help help for deletefile
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Important Options
### Important Options
Important flags useful for most commands.
Important flags useful for most commands
```
-n, --dry-run Do a trial run with no permanent changes
@ -37,9 +38,7 @@ Important flags useful for most commands.
-v, --verbose count Print lots more stuff (repeat for more)
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

4
docs/content/commands/rclone_gendocs.md
View File

@ -10,7 +10,6 @@ Output markdown docs for rclone to the directory supplied.
## Synopsis
This produces markdown docs for the rclone commands to the directory
supplied. These are in a format suitable for hugo to render into the
rclone.org website.
@ -25,10 +24,9 @@ rclone gendocs output_directory [flags]
-h, --help help for gendocs
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

5
docs/content/commands/rclone_gitannex.md
View File

@ -1,6 +1,8 @@
---
title: "rclone gitannex"
description: "Speaks with git-annex over stdin/stdout."
aliases:
- /commands/rclone_git-annex-remote-rclone-builtin/
versionIntroduced: v1.67.0
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/gitannex/ and as part of making a release run "make commanddocs"
---
@ -91,10 +93,9 @@ rclone gitannex [flags]
-h, --help help for gitannex
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

15
docs/content/commands/rclone_hashsum.md
View File

@ -10,7 +10,6 @@ Produces a hashsum file for all the objects in the path.
## Synopsis
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.
@ -59,10 +58,12 @@ rclone hashsum [<hash> remote:path] [flags]
--output-file string Output hashsums to a file rather than the terminal
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -89,18 +90,16 @@ Flags for filtering directory listings.
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
```
## Listing Options
### Listing Options
Flags for listing directories.
Flags for listing directories
```
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

6
docs/content/commands/rclone_link.md
View File

@ -10,8 +10,7 @@ Generate public link to file/folder.
## Synopsis
rclone link will create, retrieve or remove a public link to the given
file or folder.
Create, retrieve or remove a public link to the given file or folder.
rclone link remote:path/to/file
rclone link remote:path/to/folder/
@ -45,10 +44,9 @@ rclone link remote:path [flags]
--unlink Remove existing public link to file/folder
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

26
docs/content/commands/rclone_listremotes.md
View File

@ -11,26 +11,40 @@ List all the remotes in the config file and defined in environment variables.
## Synopsis
rclone listremotes lists all the available remotes from the config file.
Lists all the available remotes from the config file, or the remotes matching
an optional filter.
When used with the `--long` flag it lists the types and the descriptions too.
Prints the result in human-readable format by default, and as a simple list of
remote names, or if used with flag `--long` a tabular format including
the remote names, types and descriptions. Using flag `--json` produces
machine-readable output instead, which always includes all attributes - including
the source (file or environment).
Result can be filtered by a filter argument which applies to all attributes,
and/or filter flags specific for each attribute. The values must be specified
according to regular rclone filtering pattern syntax.
```
rclone listremotes [flags]
rclone listremotes [<filter>] [flags]
```
## Options
```
--description string Filter remotes by description
-h, --help help for listremotes
--long Show the type and the description as well as names
--json Format output as JSON
--long Show type and description in addition to name
--name string Filter remotes by name
--order-by string Instructions on how to order the result, e.g. 'type,name=descending'
--source string Filter remotes by source, e.g. 'file' or 'environment'
--type string Filter remotes by type
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

15
docs/content/commands/rclone_ls.md
View File

@ -9,7 +9,6 @@ List the objects in the path with size and path.
## Synopsis
Lists the objects in the source path to standard output in a human
readable format with size and path. Recurses by default.
@ -55,10 +54,12 @@ rclone ls remote:path [flags]
-h, --help help for ls
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -85,18 +86,16 @@ Flags for filtering directory listings.
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
```
## Listing Options
### Listing Options
Flags for listing directories.
Flags for listing directories
```
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

15
docs/content/commands/rclone_lsd.md
View File

@ -9,7 +9,6 @@ List all directories/containers/buckets in the path.
## Synopsis
Lists the directories in the source path to standard output. Does not
recurse by default. Use the `-R` flag to recurse.
@ -66,10 +65,12 @@ rclone lsd remote:path [flags]
-R, --recursive Recurse into the listing
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -96,18 +97,16 @@ Flags for filtering directory listings.
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
```
## Listing Options
### Listing Options
Flags for listing directories.
Flags for listing directories
```
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

15
docs/content/commands/rclone_lsf.md
View File

@ -10,7 +10,6 @@ List directories and objects in remote:path formatted for parsing.
## Synopsis
List the contents of the source path (directories and objects) to
standard output in a form which is easy to parse by scripts. By
default this will just be the names of the objects and directories,
@ -163,10 +162,12 @@ rclone lsf remote:path [flags]
-t, --time-format string Specify a custom time format, or 'max' for max precision supported by remote (default: 2006-01-02 15:04:05)
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -193,18 +194,16 @@ Flags for filtering directory listings.
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
```
## Listing Options
### Listing Options
Flags for listing directories.
Flags for listing directories
```
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

77
docs/content/commands/rclone_lsjson.md
View File

@ -12,7 +12,7 @@ List directories and objects in the path in JSON format.
List directories and objects in the path in JSON format.
The output is an array of Items, where each Item looks like this
The output is an array of Items, where each Item looks like this:
{
"Hashes" : {
@ -34,44 +34,50 @@ The output is an array of Items, where each Item looks like this
"Tier" : "hot",
}
If `--hash` is not specified, the Hashes property will be omitted. The
types of hash can be specified with the `--hash-type` parameter (which
may be repeated). If `--hash-type` is set then it implies `--hash`.
The exact set of properties included depends on the backend:
If `--no-modtime` is specified then ModTime will be blank. This can
speed things up on remotes where reading the ModTime takes an extra
request (e.g. s3, swift).
- The property IsBucket will only be included for bucket-based remotes, and only
for directories that are buckets. It will always be omitted when value is not true.
- Properties Encrypted and EncryptedPath will only be included for encrypted
remotes, and (as mentioned below) only if the `--encrypted` option is set.
If `--no-mimetype` is specified then MimeType will be blank. This can
speed things up on remotes where reading the MimeType takes an extra
request (e.g. s3, swift).
Different options may also affect which properties are included:
If `--encrypted` is not specified the Encrypted will be omitted.
- If `--hash` is not specified, the Hashes property will be omitted. The
types of hash can be specified with the `--hash-type` parameter (which
may be repeated). If `--hash-type` is set then it implies `--hash`.
- If `--no-modtime` is specified then ModTime will be blank. This can
speed things up on remotes where reading the ModTime takes an extra
request (e.g. s3, swift).
- If `--no-mimetype` is specified then MimeType will be blank. This can
speed things up on remotes where reading the MimeType takes an extra
request (e.g. s3, swift).
- If `--encrypted` is not specified the Encrypted and EncryptedPath
properties will be omitted - even for encrypted remotes.
- If `--metadata` is set then an additional Metadata property will be
returned. This will have [metadata](/docs/#metadata) in rclone standard format
as a JSON object.
If `--dirs-only` is not specified files in addition to directories are
returned
The default is to list directories and files/objects, but this can be changed
with the following options:
If `--files-only` is not specified directories in addition to the files
will be returned.
- If `--dirs-only` is specified then directories will be returned
only, no files/objects.
- If `--files-only` is specified then files will be returned only,
no directories.
If `--metadata` is set then an additional Metadata key will be returned.
This will have metadata in rclone standard format as a JSON object.
if `--stat` is set then a single JSON blob will be returned about the
item pointed to. This will return an error if the item isn't found.
However on bucket based backends (like s3, gcs, b2, azureblob etc) if
the item isn't found it will return an empty directory as it isn't
possible to tell empty directories from missing directories there.
If `--stat` is set then the the output is not an array of items,
but instead a single JSON blob will be returned about the item pointed to.
This will return an error if the item isn't found, however on bucket based
backends (like s3, gcs, b2, azureblob etc) if the item isn't found it will
return an empty directory, as it isn't possible to tell empty directories
from missing directories there.
The Path field will only show folders below the remote path being listed.
If "remote:path" contains the file "subfolder/file.txt", the Path for "file.txt"
will be "subfolder/file.txt", not "remote:path/subfolder/file.txt".
When used without `--recursive` the Path will always be the same as Name.
If the directory is a bucket in a bucket-based backend, then
"IsBucket" will be set to true. This key won't be present unless it is
"true".
The time is in RFC3339 format with up to nanosecond precision. The
number of decimal digits in the seconds will depend on the precision
that the remote can hold the times, so if times are accurate to the
@ -81,7 +87,8 @@ accurate to the nearest second (Dropbox, Box, WebDav, etc.) no digits
will be shown ("2017-05-31T16:15:57+01:00").
The whole output can be processed as a JSON blob, or alternatively it
can be processed line by line as each item is written one to a line.
can be processed line by line as each item is written on individual lines
(except with `--stat`).
Any of the filtering options can be applied to this command.
@ -127,10 +134,12 @@ rclone lsjson remote:path [flags]
--stat Just return the info for the pointed to file
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -157,18 +166,16 @@ Flags for filtering directory listings.
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
```
## Listing Options
### Listing Options
Flags for listing directories.
Flags for listing directories
```
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

15
docs/content/commands/rclone_lsl.md
View File

@ -10,7 +10,6 @@ List the objects in path with modification time, size and path.
## Synopsis
Lists the objects in the source path to standard output in a human
readable format with modification time, size and path. Recurses by default.
@ -56,10 +55,12 @@ rclone lsl remote:path [flags]
-h, --help help for lsl
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -86,18 +87,16 @@ Flags for filtering directory listings.
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
```
## Listing Options
### Listing Options
Flags for listing directories.
Flags for listing directories
```
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

15
docs/content/commands/rclone_md5sum.md
View File

@ -10,7 +10,6 @@ Produces an md5sum file for all the objects in the path.
## Synopsis
Produces an md5sum file for all the objects in the path. This
is in the same format as the standard md5sum tool produces.
@ -43,10 +42,12 @@ rclone md5sum remote:path [flags]
--output-file string Output hashsums to a file rather than the terminal
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -73,18 +74,16 @@ Flags for filtering directory listings.
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
```
## Listing Options
### Listing Options
Flags for listing directories.
Flags for listing directories
```
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_mkdir.md
View File

@ -17,10 +17,12 @@ rclone mkdir remote:path [flags]
-h, --help help for mkdir
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Important Options
### Important Options
Important flags useful for most commands.
Important flags useful for most commands
```
-n, --dry-run Do a trial run with no permanent changes
@ -28,9 +30,7 @@ Important flags useful for most commands.
-v, --verbose count Print lots more stuff (repeat for more)
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

46
docs/content/commands/rclone_mount.md
View File

@ -704,6 +704,11 @@ 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)
--vfs-read-chunk-streams int The number of parallel streams to read at once
The chunking behaves differently depending on the `--vfs-read-chunk-streams` parameter.
### `--vfs-read-chunk-streams` == 0
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
@ -719,6 +724,30 @@ When `--vfs-read-chunk-size-limit 500M` is specified, the result would be
Setting `--vfs-read-chunk-size` to `0` or "off" disables chunked reading.
The chunks will not be buffered in memory.
### `--vfs-read-chunk-streams` > 0
Rclone reads `--vfs-read-chunk-streams` chunks of size
`--vfs-read-chunk-size` concurrently. The size for each read will stay
constant.
This improves performance performance massively on high latency links
or very high bandwidth links to high performance object stores.
Some experimentation will be needed to find the optimum values of
`--vfs-read-chunk-size` and `--vfs-read-chunk-streams` as these will
depend on the backend in use and the latency to the backend.
For high performance object stores (eg AWS S3) a reasonable place to
start might be `--vfs-read-chunk-streams 16` and
`--vfs-read-chunk-size 4M`. In testing with AWS S3 the performance
scaled roughly as the `--vfs-read-chunk-streams` setting.
Similar settings should work for high latency links, but depending on
the latency they may need more `--vfs-read-chunk-streams` in order to
get the throughput.
## VFS Performance
These flags may be used to enable/disable features of the VFS for
@ -846,9 +875,9 @@ rclone mount remote:path /path/to/mountpoint [flags]
--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)
--dir-perms FileMode Directory permissions (default 777)
--direct-io Use Direct IO, disables caching of data
--file-perms FileMode File permissions (default 0666)
--file-perms FileMode File permissions (default 666)
--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 mount
@ -864,7 +893,7 @@ rclone mount remote:path /path/to/mountpoint [flags]
--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
--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 FileMode Override the permission bits set by the filesystem (not supported on Windows) (default 002)
--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)
@ -877,6 +906,7 @@ rclone mount remote:path /path/to/mountpoint [flags]
--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-chunk-streams int The number of parallel streams to read at once
--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
@ -886,10 +916,12 @@ rclone mount remote:path /path/to/mountpoint [flags]
--write-back-cache Makes kernel buffer writes before sending them to rclone (without this, writethrough caching is used) (not supported on Windows)
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -916,9 +948,7 @@ Flags for filtering directory listings.
--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
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

27
docs/content/commands/rclone_move.md
View File

@ -10,7 +10,6 @@ Move files from source to dest.
## Synopsis
Moves the contents of the source directory to the destination
directory. Rclone will error if the source and destination overlap and
the remote does not support a server-side directory move operation.
@ -62,15 +61,17 @@ rclone move source:path dest:path [flags]
-h, --help help for move
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Copy Options
### Copy Options
Flags for anything which can Copy a file.
Flags for anything which can copy a file
```
--check-first Do all the checks before starting transfers
-c, --checksum Check for changes with size & checksum (if available, or fallback to size only).
--compare-dest stringArray Include additional comma separated server-side paths during comparison
-c, --checksum Check for changes with size & checksum (if available, or fallback to size only)
--compare-dest stringArray Include additional server-side paths during comparison
--copy-dest stringArray Implies --compare-dest but also copies files from paths into destination
--cutoff-mode HARD|SOFT|CAUTIOUS Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD)
--ignore-case-sync Ignore case when synchronizing
@ -102,9 +103,9 @@ Flags for anything which can Copy a file.
-u, --update Skip files that are newer on the destination
```
## Important Options
### Important Options
Important flags useful for most commands.
Important flags useful for most commands
```
-n, --dry-run Do a trial run with no permanent changes
@ -112,9 +113,9 @@ Important flags useful for most commands.
-v, --verbose count Print lots more stuff (repeat for more)
```
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -141,18 +142,16 @@ Flags for filtering directory listings.
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
```
## Listing Options
### Listing Options
Flags for listing directories.
Flags for listing directories
```
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

27
docs/content/commands/rclone_moveto.md
View File

@ -10,7 +10,6 @@ Move file or directory from source to dest.
## Synopsis
If source:path is a file or directory then it moves it to a file or
directory named dest:path.
@ -53,15 +52,17 @@ rclone moveto source:path dest:path [flags]
-h, --help help for moveto
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Copy Options
### Copy Options
Flags for anything which can Copy a file.
Flags for anything which can copy a file
```
--check-first Do all the checks before starting transfers
-c, --checksum Check for changes with size & checksum (if available, or fallback to size only).
--compare-dest stringArray Include additional comma separated server-side paths during comparison
-c, --checksum Check for changes with size & checksum (if available, or fallback to size only)
--compare-dest stringArray Include additional server-side paths during comparison
--copy-dest stringArray Implies --compare-dest but also copies files from paths into destination
--cutoff-mode HARD|SOFT|CAUTIOUS Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD)
--ignore-case-sync Ignore case when synchronizing
@ -93,9 +94,9 @@ Flags for anything which can Copy a file.
-u, --update Skip files that are newer on the destination
```
## Important Options
### Important Options
Important flags useful for most commands.
Important flags useful for most commands
```
-n, --dry-run Do a trial run with no permanent changes
@ -103,9 +104,9 @@ Important flags useful for most commands.
-v, --verbose count Print lots more stuff (repeat for more)
```
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -132,18 +133,16 @@ Flags for filtering directory listings.
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
```
## Listing Options
### Listing Options
Flags for listing directories.
Flags for listing directories
```
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

17
docs/content/commands/rclone_ncdu.md
View File

@ -10,7 +10,6 @@ Explore a remote with a text based user interface.
## Synopsis
This displays a text based user interface allowing the navigation of a
remote. It is most useful for answering the question - "What is using
all my disk space?".
@ -63,7 +62,7 @@ These flags have the following meaning:
This an homage to the [ncdu tool](https://dev.yorhel.nl/ncdu) but for
rclone remotes. It is missing lots of features at the moment
but is useful as it stands.
but is useful as it stands. Unlike ncdu it does not show excluded files.
Note that it might take some time to delete big files/directories. The
UI won't respond in the meantime since the deletion is done synchronously.
@ -83,10 +82,12 @@ rclone ncdu remote:path [flags]
-h, --help help for ncdu
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -113,18 +114,16 @@ Flags for filtering directory listings.
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
```
## Listing Options
### Listing Options
Flags for listing directories.
Flags for listing directories
```
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

50
docs/content/commands/rclone_nfsmount.md
View File

@ -705,6 +705,11 @@ 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)
--vfs-read-chunk-streams int The number of parallel streams to read at once
The chunking behaves differently depending on the `--vfs-read-chunk-streams` parameter.
### `--vfs-read-chunk-streams` == 0
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
@ -720,6 +725,30 @@ When `--vfs-read-chunk-size-limit 500M` is specified, the result would be
Setting `--vfs-read-chunk-size` to `0` or "off" disables chunked reading.
The chunks will not be buffered in memory.
### `--vfs-read-chunk-streams` > 0
Rclone reads `--vfs-read-chunk-streams` chunks of size
`--vfs-read-chunk-size` concurrently. The size for each read will stay
constant.
This improves performance performance massively on high latency links
or very high bandwidth links to high performance object stores.
Some experimentation will be needed to find the optimum values of
`--vfs-read-chunk-size` and `--vfs-read-chunk-streams` as these will
depend on the backend in use and the latency to the backend.
For high performance object stores (eg AWS S3) a reasonable place to
start might be `--vfs-read-chunk-streams 16` and
`--vfs-read-chunk-size 4M`. In testing with AWS S3 the performance
scaled roughly as the `--vfs-read-chunk-streams` setting.
Similar settings should work for high latency links, but depending on
the latency they may need more `--vfs-read-chunk-streams` in order to
get the throughput.
## VFS Performance
These flags may be used to enable/disable features of the VFS for
@ -848,16 +877,18 @@ rclone nfsmount remote:path /path/to/mountpoint [flags]
--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)
--dir-perms FileMode Directory permissions (default 777)
--direct-io Use Direct IO, disables caching of data
--file-perms FileMode File permissions (default 0666)
--file-perms FileMode File permissions (default 666)
--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-dir string The directory the NFS handle cache will use if set
--nfs-cache-handle-limit int max file handles cached simultaneously (min 5) (default 1000000)
--nfs-cache-type memory|disk|symlink Type of NFS handle cache to use (default memory)
--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
@ -866,9 +897,9 @@ rclone nfsmount remote:path /path/to/mountpoint [flags]
-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.
--sudo Use sudo to run the mount/umount commands 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)
--umask FileMode Override the permission bits set by the filesystem (not supported on Windows) (default 002)
--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)
@ -881,6 +912,7 @@ rclone nfsmount remote:path /path/to/mountpoint [flags]
--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-chunk-streams int The number of parallel streams to read at once
--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
@ -890,10 +922,12 @@ rclone nfsmount remote:path /path/to/mountpoint [flags]
--write-back-cache Makes kernel buffer writes before sending them to rclone (without this, writethrough caching is used) (not supported on Windows)
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -920,9 +954,7 @@ Flags for filtering directory listings.
--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
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

3
docs/content/commands/rclone_obscure.md
View File

@ -44,10 +44,9 @@ rclone obscure password [flags]
-h, --help help for obscure
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

11
docs/content/commands/rclone_purge.md
View File

@ -9,7 +9,6 @@ Remove the path and all of its contents.
## Synopsis
Remove the path and all of its contents. Note that this does not obey
include/exclude filters - everything will be removed. Use the
[delete](/commands/rclone_delete/) command if you want to selectively
@ -30,10 +29,12 @@ rclone purge remote:path [flags]
-h, --help help for purge
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Important Options
### Important Options
Important flags useful for most commands.
Important flags useful for most commands
```
-n, --dry-run Do a trial run with no permanent changes
@ -41,9 +42,7 @@ Important flags useful for most commands.
-v, --verbose count Print lots more stuff (repeat for more)
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

13
docs/content/commands/rclone_rc.md
View File

@ -10,8 +10,6 @@ Run a command against a running rclone.
## Synopsis
This runs a command against a running rclone. Use the `--url` flag to
specify an non default URL to connect on. This can be either a
":port" which is taken to mean "http://localhost:port" or a
@ -22,6 +20,13 @@ A username and password can be passed in with `--user` and `--pass`.
Note that `--rc-addr`, `--rc-user`, `--rc-pass` will be read also for
`--url`, `--user`, `--pass`.
The `--unix-socket` flag can be used to connect over a unix socket like this
# start server on /tmp/my.socket
rclone rcd --rc-addr unix:///tmp/my.socket
# Connect to it
rclone rc --unix-socket /tmp/my.socket core/stats
Arguments should be passed in as parameter=value.
The result will be returned as a JSON object by default.
@ -75,14 +80,14 @@ rclone rc commands parameter [flags]
--no-output If set, don't output the JSON result
-o, --opt stringArray Option in the form name=value or name placed in the "opt" array
--pass string Password to use to connect to rclone remote control
--unix-socket string Path to a unix domain socket to dial to, instead of opening a TCP connection directly
--url string URL to connect to rclone remote control (default "http://localhost:5572/")
--user string Username to use to rclone remote control
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

14
docs/content/commands/rclone_rcat.md
View File

@ -10,9 +10,7 @@ Copies standard input to file on remote.
## Synopsis
rclone rcat reads from standard input (stdin) and copies it to a
single remote file.
Reads from standard input (stdin) and copies it to a single remote file.
echo "hello world" | rclone rcat remote:path/to/file
ffmpeg - | rclone rcat remote:path/to/file
@ -53,10 +51,12 @@ rclone rcat remote:path [flags]
--size int File size hint to preallocate (default -1)
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Important Options
### Important Options
Important flags useful for most commands.
Important flags useful for most commands
```
-n, --dry-run Do a trial run with no permanent changes
@ -64,9 +64,7 @@ Important flags useful for most commands.
-v, --verbose count Print lots more stuff (repeat for more)
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

29
docs/content/commands/rclone_rcd.md
View File

@ -35,6 +35,7 @@ or just by using an absolute path name. Note that unix sockets bypass the
authentication - this is expected to be done with file system permissions.
`--rc-addr` may be repeated to listen on multiple IPs/ports/sockets.
Socket activation, described further below, can also be used to accomplish the same.
`--rc-server-read-timeout` and `--rc-server-write-timeout` can be used to
control the timeouts on the server. Note that this is the total time
@ -67,6 +68,20 @@ certificate authority certificate.
values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default
"tls1.0").
## Socket activation
Instead of the listening addresses specified above, rclone will listen to all
FDs passed by the service manager, if any (and ignore any arguments passed by --rc-addr`).
This allows rclone to be a socket-activated service.
It can be configured with .socket and .service unit files as described in
https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html
Socket activation can be tested ad-hoc with the `systemd-socket-activate`command
systemd-socket-activate -l 8000 -- rclone serve
This will socket-activate rclone on the first connection to port 8000 over TCP.
### Template
`--rc-template` allows a user to specify a custom markup template for HTTP
@ -142,19 +157,21 @@ rclone rcd <path to files to serve>* [flags]
-h, --help help for rcd
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## RC Options
### RC Options
Flags to control the Remote Control API.
Flags to control the Remote Control API
```
--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"])
--rc-allow-origin string Origin which cross-domain request (CORS) can be executed from
--rc-baseurl string Prefix for URLs - leave blank for root
--rc-cert string TLS PEM key (concatenation of certificate and CA certificate)
--rc-client-ca string Client certificate authority to verify clients with
--rc-enable-metrics Enable prometheus metrics on /metrics
--rc-enable-metrics Enable the Prometheus metrics path at the remote control server
--rc-files string Path to local files to serve on the HTTP server
--rc-htpasswd string A htpasswd file - if not provided no authentication is done
--rc-job-expire-duration Duration Expire finished async jobs older than this value (default 1m0s)
@ -179,9 +196,7 @@ Flags to control the Remote Control API.
--rc-web-gui-update Check and update to latest version of web gui
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

11
docs/content/commands/rclone_rmdir.md
View File

@ -9,7 +9,6 @@ Remove the empty directory at path.
## Synopsis
This removes empty directory given by path. Will not remove the path if it
has any objects in it, not even empty subdirectories. Use
command [rmdirs](/commands/rclone_rmdirs/) (or [delete](/commands/rclone_delete/)
@ -28,10 +27,12 @@ rclone rmdir remote:path [flags]
-h, --help help for rmdir
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Important Options
### Important Options
Important flags useful for most commands.
Important flags useful for most commands
```
-n, --dry-run Do a trial run with no permanent changes
@ -39,9 +40,7 @@ Important flags useful for most commands.
-v, --verbose count Print lots more stuff (repeat for more)
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

11
docs/content/commands/rclone_rmdirs.md
View File

@ -10,7 +10,6 @@ Remove empty directories under the path.
## Synopsis
This recursively removes any empty directories (including directories
that only contain empty directories), that it finds under the path.
The root path itself will also be removed if it is empty, unless
@ -42,10 +41,12 @@ rclone rmdirs remote:path [flags]
--leave-root Do not remove root directory if empty
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Important Options
### Important Options
Important flags useful for most commands.
Important flags useful for most commands
```
-n, --dry-run Do a trial run with no permanent changes
@ -53,9 +54,7 @@ Important flags useful for most commands.
-v, --verbose count Print lots more stuff (repeat for more)
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

5
docs/content/commands/rclone_selfupdate.md
View File

@ -1,6 +1,8 @@
---
title: "rclone selfupdate"
description: "Update the rclone binary."
aliases:
- /commands/rclone_self-update/
versionIntroduced: v1.55
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/selfupdate/ and as part of making a release run "make commanddocs"
---
@ -75,10 +77,9 @@ rclone selfupdate [flags]
--version string Install the given rclone version (default: latest)
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

3
docs/content/commands/rclone_serve.md
View File

@ -28,10 +28,9 @@ rclone serve <protocol> [opts] <remote> [flags]
-h, --help help for serve
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.
* [rclone serve dlna](/commands/rclone_serve_dlna/) - Serve remote:path over DLNA

50
docs/content/commands/rclone_serve_dlna.md
View File

@ -21,6 +21,10 @@ based on media formats or file extensions. Additionally, there is no
media transcoding support. This means that some players might show
files that they are not able to play back correctly.
Rclone will add external subtitle files (.srt) to videos if they have the same
filename as the video file itself (except the extension), either in the same
directory as the video, or in a "Subs" subdirectory.
## Server options
Use `--addr` to specify which IP address and port the server should
@ -265,6 +269,11 @@ 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)
--vfs-read-chunk-streams int The number of parallel streams to read at once
The chunking behaves differently depending on the `--vfs-read-chunk-streams` parameter.
### `--vfs-read-chunk-streams` == 0
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
@ -280,6 +289,30 @@ When `--vfs-read-chunk-size-limit 500M` is specified, the result would be
Setting `--vfs-read-chunk-size` to `0` or "off" disables chunked reading.
The chunks will not be buffered in memory.
### `--vfs-read-chunk-streams` > 0
Rclone reads `--vfs-read-chunk-streams` chunks of size
`--vfs-read-chunk-size` concurrently. The size for each read will stay
constant.
This improves performance performance massively on high latency links
or very high bandwidth links to high performance object stores.
Some experimentation will be needed to find the optimum values of
`--vfs-read-chunk-size` and `--vfs-read-chunk-streams` as these will
depend on the backend in use and the latency to the backend.
For high performance object stores (eg AWS S3) a reasonable place to
start might be `--vfs-read-chunk-streams 16` and
`--vfs-read-chunk-size 4M`. In testing with AWS S3 the performance
scaled roughly as the `--vfs-read-chunk-streams` setting.
Similar settings should work for high latency links, but depending on
the latency they may need more `--vfs-read-chunk-streams` in order to
get the throughput.
## VFS Performance
These flags may be used to enable/disable features of the VFS for
@ -398,8 +431,8 @@ rclone serve dlna remote:path [flags]
--addr string The ip:port or :port to bind the DLNA http server to (default ":7879")
--announce-interval Duration The interval between SSDP announcements (default 12m0s)
--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)
--dir-perms FileMode Directory permissions (default 777)
--file-perms FileMode File permissions (default 666)
--gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000)
-h, --help help for dlna
--interface stringArray The interface to use for SSDP (repeat as necessary)
@ -411,7 +444,7 @@ rclone serve dlna remote:path [flags]
--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
--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 FileMode Override the permission bits set by the filesystem (not supported on Windows) (default 002)
--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)
@ -424,6 +457,7 @@ rclone serve dlna remote:path [flags]
--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-chunk-streams int The number of parallel streams to read at once
--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
@ -431,10 +465,12 @@ rclone serve dlna remote:path [flags]
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -461,9 +497,7 @@ Flags for filtering directory listings.
--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
## See Also
* [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol.

46
docs/content/commands/rclone_serve_docker.md
View File

@ -281,6 +281,11 @@ 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)
--vfs-read-chunk-streams int The number of parallel streams to read at once
The chunking behaves differently depending on the `--vfs-read-chunk-streams` parameter.
### `--vfs-read-chunk-streams` == 0
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
@ -296,6 +301,30 @@ When `--vfs-read-chunk-size-limit 500M` is specified, the result would be
Setting `--vfs-read-chunk-size` to `0` or "off" disables chunked reading.
The chunks will not be buffered in memory.
### `--vfs-read-chunk-streams` > 0
Rclone reads `--vfs-read-chunk-streams` chunks of size
`--vfs-read-chunk-size` concurrently. The size for each read will stay
constant.
This improves performance performance massively on high latency links
or very high bandwidth links to high performance object stores.
Some experimentation will be needed to find the optimum values of
`--vfs-read-chunk-size` and `--vfs-read-chunk-streams` as these will
depend on the backend in use and the latency to the backend.
For high performance object stores (eg AWS S3) a reasonable place to
start might be `--vfs-read-chunk-streams 16` and
`--vfs-read-chunk-size 4M`. In testing with AWS S3 the performance
scaled roughly as the `--vfs-read-chunk-streams` setting.
Similar settings should work for high latency links, but depending on
the latency they may need more `--vfs-read-chunk-streams` in order to
get the throughput.
## VFS Performance
These flags may be used to enable/disable features of the VFS for
@ -424,9 +453,9 @@ rclone serve docker [flags]
--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)
--dir-perms FileMode Directory permissions (default 777)
--direct-io Use Direct IO, disables caching of data
--file-perms FileMode File permissions (default 0666)
--file-perms FileMode File permissions (default 666)
--forget-state Skip restoring previous state
--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)
@ -446,7 +475,7 @@ rclone serve docker [flags]
--socket-addr string Address <host:port> or absolute path (default: /run/docker/plugins/rclone.sock)
--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)
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
--umask FileMode Override the permission bits set by the filesystem (not supported on Windows) (default 002)
--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)
@ -459,6 +488,7 @@ rclone serve docker [flags]
--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-chunk-streams int The number of parallel streams to read at once
--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
@ -468,10 +498,12 @@ rclone serve docker [flags]
--write-back-cache Makes kernel buffer writes before sending them to rclone (without this, writethrough caching is used) (not supported on Windows)
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -498,9 +530,7 @@ Flags for filtering directory listings.
--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
## See Also
* [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol.

46
docs/content/commands/rclone_serve_ftp.md
View File

@ -262,6 +262,11 @@ 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)
--vfs-read-chunk-streams int The number of parallel streams to read at once
The chunking behaves differently depending on the `--vfs-read-chunk-streams` parameter.
### `--vfs-read-chunk-streams` == 0
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
@ -277,6 +282,30 @@ When `--vfs-read-chunk-size-limit 500M` is specified, the result would be
Setting `--vfs-read-chunk-size` to `0` or "off" disables chunked reading.
The chunks will not be buffered in memory.
### `--vfs-read-chunk-streams` > 0
Rclone reads `--vfs-read-chunk-streams` chunks of size
`--vfs-read-chunk-size` concurrently. The size for each read will stay
constant.
This improves performance performance massively on high latency links
or very high bandwidth links to high performance object stores.
Some experimentation will be needed to find the optimum values of
`--vfs-read-chunk-size` and `--vfs-read-chunk-streams` as these will
depend on the backend in use and the latency to the backend.
For high performance object stores (eg AWS S3) a reasonable place to
start might be `--vfs-read-chunk-streams 16` and
`--vfs-read-chunk-size 4M`. In testing with AWS S3 the performance
scaled roughly as the `--vfs-read-chunk-streams` setting.
Similar settings should work for high latency links, but depending on
the latency they may need more `--vfs-read-chunk-streams` in order to
get the throughput.
## VFS Performance
These flags may be used to enable/disable features of the VFS for
@ -477,8 +506,8 @@ rclone serve ftp remote:path [flags]
--auth-proxy string A program to use to create the backend from the auth
--cert string TLS PEM key (concatenation of certificate and CA certificate)
--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)
--dir-perms FileMode Directory permissions (default 777)
--file-perms FileMode File permissions (default 666)
--gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000)
-h, --help help for ftp
--key string TLS PEM Private key
@ -491,7 +520,7 @@ rclone serve ftp remote:path [flags]
--public-ip string Public IP address to advertise for passive connections
--read-only Only allow read-only access
--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 FileMode Override the permission bits set by the filesystem (not supported on Windows) (default 002)
--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)
@ -505,6 +534,7 @@ rclone serve ftp remote:path [flags]
--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-chunk-streams int The number of parallel streams to read at once
--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
@ -512,10 +542,12 @@ rclone serve ftp remote:path [flags]
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -542,9 +574,7 @@ Flags for filtering directory listings.
--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
## See Also
* [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol.

63
docs/content/commands/rclone_serve_http.md
View File

@ -37,6 +37,7 @@ or just by using an absolute path name. Note that unix sockets bypass the
authentication - this is expected to be done with file system permissions.
`--addr` may be repeated to listen on multiple IPs/ports/sockets.
Socket activation, described further below, can also be used to accomplish the same.
`--server-read-timeout` and `--server-write-timeout` can be used to
control the timeouts on the server. Note that this is the total time
@ -69,6 +70,20 @@ certificate authority certificate.
values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default
"tls1.0").
## Socket activation
Instead of the listening addresses specified above, rclone will listen to all
FDs passed by the service manager, if any (and ignore any arguments passed by --addr`).
This allows rclone to be a socket-activated service.
It can be configured with .socket and .service unit files as described in
https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html
Socket activation can be tested ad-hoc with the `systemd-socket-activate`command
systemd-socket-activate -l 8000 -- rclone serve
This will socket-activate rclone on the first connection to port 8000 over TCP.
### Template
`--template` allows a user to specify a custom markup template for HTTP
@ -364,6 +379,11 @@ 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)
--vfs-read-chunk-streams int The number of parallel streams to read at once
The chunking behaves differently depending on the `--vfs-read-chunk-streams` parameter.
### `--vfs-read-chunk-streams` == 0
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
@ -379,6 +399,30 @@ When `--vfs-read-chunk-size-limit 500M` is specified, the result would be
Setting `--vfs-read-chunk-size` to `0` or "off" disables chunked reading.
The chunks will not be buffered in memory.
### `--vfs-read-chunk-streams` > 0
Rclone reads `--vfs-read-chunk-streams` chunks of size
`--vfs-read-chunk-size` concurrently. The size for each read will stay
constant.
This improves performance performance massively on high latency links
or very high bandwidth links to high performance object stores.
Some experimentation will be needed to find the optimum values of
`--vfs-read-chunk-size` and `--vfs-read-chunk-streams` as these will
depend on the backend in use and the latency to the backend.
For high performance object stores (eg AWS S3) a reasonable place to
start might be `--vfs-read-chunk-streams 16` and
`--vfs-read-chunk-size 4M`. In testing with AWS S3 the performance
scaled roughly as the `--vfs-read-chunk-streams` setting.
Similar settings should work for high latency links, but depending on
the latency they may need more `--vfs-read-chunk-streams` in order to
get the throughput.
## VFS Performance
These flags may be used to enable/disable features of the VFS for
@ -575,15 +619,15 @@ rclone serve http remote:path [flags]
## Options
```
--addr stringArray IPaddress:Port or :Port to bind server to (default [127.0.0.1:8080])
--addr stringArray IPaddress:Port, :Port or [unix://]/path/to/socket to bind server to (default [127.0.0.1:8080])
--allow-origin string Origin which cross-domain request (CORS) can be executed from
--auth-proxy string A program to use to create the backend from the auth
--baseurl string Prefix for URLs - leave blank for root
--cert string TLS PEM key (concatenation of certificate and CA certificate)
--client-ca string Client certificate authority to verify clients with
--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)
--dir-perms FileMode Directory permissions (default 777)
--file-perms FileMode File permissions (default 666)
--gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000)
-h, --help help for http
--htpasswd string A htpasswd file - if not provided no authentication is done
@ -602,7 +646,7 @@ rclone serve http remote:path [flags]
--server-write-timeout Duration Timeout for server writing data (default 1h0m0s)
--template string User-specified template
--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 FileMode Override the permission bits set by the filesystem (not supported on Windows) (default 002)
--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)
@ -616,6 +660,7 @@ rclone serve http remote:path [flags]
--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-chunk-streams int The number of parallel streams to read at once
--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
@ -623,10 +668,12 @@ rclone serve http remote:path [flags]
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -653,9 +700,7 @@ Flags for filtering directory listings.
--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
## See Also
* [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol.

117
docs/content/commands/rclone_serve_nfs.md
View File

@ -13,34 +13,69 @@ Serve the remote as an NFS mount
Create an NFS server that serves the given remote over the network.
The primary purpose for this command is to enable [mount command](/commands/rclone_mount/) on recent macOS versions where
This implements an NFSv3 server to serve any rclone remote via NFS.
The primary purpose for this command is to enable the [mount
command](/commands/rclone_mount/) on recent macOS versions where
installing FUSE is very cumbersome.
Since this is running on NFSv3, no authentication method is available. Any client
will be able to access the data. To limit access, you can use serve NFS on loopback address
and rely on secure tunnels (such as SSH). For this reason, by default, a random TCP port is chosen and loopback interface is used for the listening address;
meaning that it is only available to the local machine. If you want other machines to access the
NFS mount over local network, you need to specify the listening address and port using `--addr` flag.
This server does not implement any authentication so any client will be
able to access the data. To limit access, you can use `serve nfs` on
the loopback address or rely on secure tunnels (such as SSH) or use
firewalling.
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,
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.
For this reason, by default, a random TCP port is chosen and the
loopback interface is used for the listening address by default;
meaning that it is only available to the local machine. If you want
other machines to access the NFS mount over local network, you need to
specify the listening address and port using the `--addr` flag.
Modifying files through the 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, the mount will be read-only.
`--nfs-cache-type` controls the type of the NFS handle cache. By
default this is `memory` where new handles will be randomly allocated
when needed. These are stored in memory. If the server is restarted
the handle cache will be lost and connected NFS clients will get stale
handle errors.
`--nfs-cache-type disk` uses an on disk NFS handle cache. Rclone
hashes the path of the object and stores it in a file named after the
hash. These hashes are stored on disk the directory controlled by
`--cache-dir` or the exact directory may be specified with
`--nfs-cache-dir`. Using this means that the NFS server can be
restarted at will without affecting the connected clients.
`--nfs-cache-type symlink` is similar to `--nfs-cache-type disk` in
that it uses an on disk cache, but the cache entries are held as
symlinks. Rclone will use the handle of the underlying file as the NFS
handle which improves performance. This sort of cache can't be backed
up and restored as the underlying handles will change. This is Linux
only.
`--nfs-cache-handle-limit` controls the maximum number of cached NFS
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. This is only used by the `memory` type
cache.
To serve NFS over the network use following command:
rclone serve nfs remote: --addr 0.0.0.0:$PORT --vfs-cache-mode=full
We specify a specific port that we can use in the mount command:
This specifies a port that can be used in the mount command. To mount
the server under Linux/macOS, use the following command:
To mount the server under Linux/macOS, use the following command:
mount -t nfs -o port=$PORT,mountport=$PORT,tcp $HOSTNAME:/ path/to/mountpoint
mount -oport=$PORT,mountport=$PORT $HOSTNAME: path/to/mountpoint
Where `$PORT` is the same port number used in the `serve nfs` command
and `$HOSTNAME` is the network address of the machine that `serve nfs`
was run on.
Where `$PORT` is the same port number we used in the serve nfs command.
This feature is only available on Unix platforms.
This command is only available on Unix platforms.
## VFS - Virtual File System
@ -274,6 +309,11 @@ 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)
--vfs-read-chunk-streams int The number of parallel streams to read at once
The chunking behaves differently depending on the `--vfs-read-chunk-streams` parameter.
### `--vfs-read-chunk-streams` == 0
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
@ -289,6 +329,30 @@ When `--vfs-read-chunk-size-limit 500M` is specified, the result would be
Setting `--vfs-read-chunk-size` to `0` or "off" disables chunked reading.
The chunks will not be buffered in memory.
### `--vfs-read-chunk-streams` > 0
Rclone reads `--vfs-read-chunk-streams` chunks of size
`--vfs-read-chunk-size` concurrently. The size for each read will stay
constant.
This improves performance performance massively on high latency links
or very high bandwidth links to high performance object stores.
Some experimentation will be needed to find the optimum values of
`--vfs-read-chunk-size` and `--vfs-read-chunk-streams` as these will
depend on the backend in use and the latency to the backend.
For high performance object stores (eg AWS S3) a reasonable place to
start might be `--vfs-read-chunk-streams 16` and
`--vfs-read-chunk-size 4M`. In testing with AWS S3 the performance
scaled roughly as the `--vfs-read-chunk-streams` setting.
Similar settings should work for high latency links, but depending on
the latency they may need more `--vfs-read-chunk-streams` in order to
get the throughput.
## VFS Performance
These flags may be used to enable/disable features of the VFS for
@ -406,18 +470,20 @@ rclone serve nfs remote:path [flags]
```
--addr string IPaddress:Port or :Port to bind server to
--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)
--dir-perms FileMode Directory permissions (default 777)
--file-perms FileMode File permissions (default 666)
--gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000)
-h, --help help for nfs
--nfs-cache-dir string The directory the NFS handle cache will use if set
--nfs-cache-handle-limit int max file handles cached simultaneously (min 5) (default 1000000)
--nfs-cache-type memory|disk|symlink Type of NFS handle cache to use (default memory)
--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
--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
--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 FileMode Override the permission bits set by the filesystem (not supported on Windows) (default 002)
--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)
@ -430,6 +496,7 @@ rclone serve nfs remote:path [flags]
--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-chunk-streams int The number of parallel streams to read at once
--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
@ -437,10 +504,12 @@ rclone serve nfs remote:path [flags]
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -467,9 +536,7 @@ Flags for filtering directory listings.
--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
## See Also
* [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol.

20
docs/content/commands/rclone_serve_restic.md
View File

@ -107,6 +107,7 @@ or just by using an absolute path name. Note that unix sockets bypass the
authentication - this is expected to be done with file system permissions.
`--addr` may be repeated to listen on multiple IPs/ports/sockets.
Socket activation, described further below, can also be used to accomplish the same.
`--server-read-timeout` and `--server-write-timeout` can be used to
control the timeouts on the server. Note that this is the total time
@ -139,6 +140,20 @@ certificate authority certificate.
values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default
"tls1.0").
## Socket activation
Instead of the listening addresses specified above, rclone will listen to all
FDs passed by the service manager, if any (and ignore any arguments passed by --addr`).
This allows rclone to be a socket-activated service.
It can be configured with .socket and .service unit files as described in
https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html
Socket activation can be tested ad-hoc with the `systemd-socket-activate`command
systemd-socket-activate -l 8000 -- rclone serve
This will socket-activate rclone on the first connection to port 8000 over TCP.
### Authentication
By default this will serve files without needing a login.
@ -175,7 +190,7 @@ rclone serve restic remote:path [flags]
## Options
```
--addr stringArray IPaddress:Port or :Port to bind server to (default [127.0.0.1:8080])
--addr stringArray IPaddress:Port, :Port or [unix://]/path/to/socket to bind server to (default [127.0.0.1:8080])
--allow-origin string Origin which cross-domain request (CORS) can be executed from
--append-only Disallow deletion of repository data
--baseurl string Prefix for URLs - leave blank for root
@ -197,10 +212,9 @@ rclone serve restic remote:path [flags]
--user string User name for authentication
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol.

96
docs/content/commands/rclone_serve_s3.md
View File

@ -147,6 +147,33 @@ metadata which will be set as the modification time of the file.
Other operations will return error `Unimplemented`.
### Authentication
By default this will serve files without needing a login.
You can either use an htpasswd file which can take lots of users, or
set a single username and password with the `--user` and `--pass` flags.
If no static users are configured by either of the above methods, and client
certificates are required by the `--client-ca` flag passed to the server, the
client certificate common name will be considered as the username.
Use `--htpasswd /path/to/htpasswd` to provide an htpasswd file. This is
in standard apache format and supports MD5, SHA1 and BCrypt for basic
authentication. Bcrypt is recommended.
To create an htpasswd file:
touch htpasswd
htpasswd -B htpasswd user
htpasswd -B htpasswd anotherUser
The password file can be updated while rclone is running.
Use `--realm` to set the authentication realm.
Use `--salt` to change the password hashing salt from the default.
## Server options
Use `--addr` to specify which IP address and port the server should
@ -162,6 +189,7 @@ or just by using an absolute path name. Note that unix sockets bypass the
authentication - this is expected to be done with file system permissions.
`--addr` may be repeated to listen on multiple IPs/ports/sockets.
Socket activation, described further below, can also be used to accomplish the same.
`--server-read-timeout` and `--server-write-timeout` can be used to
control the timeouts on the server. Note that this is the total time
@ -194,6 +222,20 @@ certificate authority certificate.
values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default
"tls1.0").
## Socket activation
Instead of the listening addresses specified above, rclone will listen to all
FDs passed by the service manager, if any (and ignore any arguments passed by --addr`).
This allows rclone to be a socket-activated service.
It can be configured with .socket and .service unit files as described in
https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html
Socket activation can be tested ad-hoc with the `systemd-socket-activate`command
systemd-socket-activate -l 8000 -- rclone serve
This will socket-activate rclone on the first connection to port 8000 over TCP.
## VFS - Virtual File System
This command uses the VFS layer. This adapts the cloud storage objects
@ -426,6 +468,11 @@ 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)
--vfs-read-chunk-streams int The number of parallel streams to read at once
The chunking behaves differently depending on the `--vfs-read-chunk-streams` parameter.
### `--vfs-read-chunk-streams` == 0
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
@ -441,6 +488,30 @@ When `--vfs-read-chunk-size-limit 500M` is specified, the result would be
Setting `--vfs-read-chunk-size` to `0` or "off" disables chunked reading.
The chunks will not be buffered in memory.
### `--vfs-read-chunk-streams` > 0
Rclone reads `--vfs-read-chunk-streams` chunks of size
`--vfs-read-chunk-size` concurrently. The size for each read will stay
constant.
This improves performance performance massively on high latency links
or very high bandwidth links to high performance object stores.
Some experimentation will be needed to find the optimum values of
`--vfs-read-chunk-size` and `--vfs-read-chunk-streams` as these will
depend on the backend in use and the latency to the backend.
For high performance object stores (eg AWS S3) a reasonable place to
start might be `--vfs-read-chunk-streams 16` and
`--vfs-read-chunk-size 4M`. In testing with AWS S3 the performance
scaled roughly as the `--vfs-read-chunk-streams` setting.
Similar settings should work for high latency links, but depending on
the latency they may need more `--vfs-read-chunk-streams` in order to
get the throughput.
## VFS Performance
These flags may be used to enable/disable features of the VFS for
@ -556,19 +627,21 @@ rclone serve s3 remote:path [flags]
## Options
```
--addr stringArray IPaddress:Port or :Port to bind server to (default [127.0.0.1:8080])
--addr stringArray IPaddress:Port, :Port or [unix://]/path/to/socket to bind server to (default [127.0.0.1:8080])
--allow-origin string Origin which cross-domain request (CORS) can be executed from
--auth-key stringArray Set key pair for v4 authorization: access_key_id,secret_access_key
--auth-proxy string A program to use to create the backend from the auth
--baseurl string Prefix for URLs - leave blank for root
--cert string TLS PEM key (concatenation of certificate and CA certificate)
--client-ca string Client certificate authority to verify clients with
--dir-cache-time Duration Time to cache directory entries for (default 5m0s)
--dir-perms FileMode Directory permissions (default 0777)
--dir-perms FileMode Directory permissions (default 777)
--etag-hash string Which hash to use for the ETag, or auto or blank for off (default "MD5")
--file-perms FileMode File permissions (default 0666)
--file-perms FileMode File permissions (default 666)
--force-path-style If true use path style access if false use virtual hosted style (default true) (default true)
--gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000)
-h, --help help for s3
--htpasswd string A htpasswd file - if not provided no authentication is done
--key string TLS PEM Private key
--max-header-bytes int Maximum size of request header (default 4096)
--min-tls-version string Minimum TLS version that is acceptable (default "tls1.0")
@ -576,12 +649,16 @@ rclone serve s3 remote:path [flags]
--no-cleanup Not to cleanup empty folder after object is deleted
--no-modtime Don't read/write the modification time (can speed things up)
--no-seek Don't allow seeking in files
--pass string Password for authentication
--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
--realm string Realm for authentication
--salt string Password hashing salt (default "dlPL2MqE")
--server-read-timeout Duration Timeout for server reading 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)
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
--umask FileMode Override the permission bits set by the filesystem (not supported on Windows) (default 002)
--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-size SizeSuffix Max total size of objects in the cache (default off)
@ -594,6 +671,7 @@ rclone serve s3 remote:path [flags]
--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-chunk-streams int The number of parallel streams to read at once
--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
@ -601,10 +679,12 @@ rclone serve s3 remote:path [flags]
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -631,9 +711,7 @@ Flags for filtering directory listings.
--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
## See Also
* [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol.

57
docs/content/commands/rclone_serve_sftp.md
View File

@ -43,6 +43,17 @@ directory.
By default the server binds to localhost:2022 - if you want it to be
reachable externally then supply `--addr :2022` for example.
This also supports being run with socket activation, in which case it will
listen on the first passed FD.
It can be configured with .socket and .service unit files as described in
https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html
Socket activation can be tested ad-hoc with the `systemd-socket-activate`command:
systemd-socket-activate -l 2222 -- rclone serve sftp :local:vfs/
This will socket-activate rclone on the first connection to port 2222 over TCP.
Note that the default of `--vfs-cache-mode off` is fine for the rclone
sftp backend, but it may not be with other SFTP clients.
@ -294,6 +305,11 @@ 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)
--vfs-read-chunk-streams int The number of parallel streams to read at once
The chunking behaves differently depending on the `--vfs-read-chunk-streams` parameter.
### `--vfs-read-chunk-streams` == 0
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
@ -309,6 +325,30 @@ When `--vfs-read-chunk-size-limit 500M` is specified, the result would be
Setting `--vfs-read-chunk-size` to `0` or "off" disables chunked reading.
The chunks will not be buffered in memory.
### `--vfs-read-chunk-streams` > 0
Rclone reads `--vfs-read-chunk-streams` chunks of size
`--vfs-read-chunk-size` concurrently. The size for each read will stay
constant.
This improves performance performance massively on high latency links
or very high bandwidth links to high performance object stores.
Some experimentation will be needed to find the optimum values of
`--vfs-read-chunk-size` and `--vfs-read-chunk-streams` as these will
depend on the backend in use and the latency to the backend.
For high performance object stores (eg AWS S3) a reasonable place to
start might be `--vfs-read-chunk-streams 16` and
`--vfs-read-chunk-size 4M`. In testing with AWS S3 the performance
scaled roughly as the `--vfs-read-chunk-streams` setting.
Similar settings should work for high latency links, but depending on
the latency they may need more `--vfs-read-chunk-streams` in order to
get the throughput.
## VFS Performance
These flags may be used to enable/disable features of the VFS for
@ -509,8 +549,8 @@ rclone serve sftp remote:path [flags]
--auth-proxy string A program to use to create the backend from the auth
--authorized-keys string Authorized keys file (default "~/.ssh/authorized_keys")
--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)
--dir-perms FileMode Directory permissions (default 777)
--file-perms FileMode File permissions (default 666)
--gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000)
-h, --help help for sftp
--key stringArray SSH private host key file (Can be multi-valued, leave blank to auto generate)
@ -523,7 +563,7 @@ rclone serve sftp remote:path [flags]
--read-only Only allow read-only access
--stdio Run an sftp server on stdin/stdout
--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 FileMode Override the permission bits set by the filesystem (not supported on Windows) (default 002)
--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)
@ -537,6 +577,7 @@ rclone serve sftp remote:path [flags]
--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-chunk-streams int The number of parallel streams to read at once
--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
@ -544,10 +585,12 @@ rclone serve sftp remote:path [flags]
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -574,9 +617,7 @@ Flags for filtering directory listings.
--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
## See Also
* [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol.

76
docs/content/commands/rclone_serve_webdav.md
View File

@ -52,6 +52,19 @@ Create a new DWORD BasicAuthLevel with value 2.
https://learn.microsoft.com/en-us/office/troubleshoot/powerpoint/office-opens-blank-from-sharepoint
## Serving over a unix socket
You can serve the webdav on a unix socket like this:
rclone serve webdav --addr unix:///tmp/my.socket remote:path
and connect to it like this using rclone and the webdav backend:
rclone --webdav-unix-socket /tmp/my.socket --webdav-url http://localhost lsf :webdav:
Note that there is no authentication on http protocol - this is expected to be
done by the permissions on the socket.
## Server options
Use `--addr` to specify which IP address and port the server should
@ -67,6 +80,7 @@ or just by using an absolute path name. Note that unix sockets bypass the
authentication - this is expected to be done with file system permissions.
`--addr` may be repeated to listen on multiple IPs/ports/sockets.
Socket activation, described further below, can also be used to accomplish the same.
`--server-read-timeout` and `--server-write-timeout` can be used to
control the timeouts on the server. Note that this is the total time
@ -99,6 +113,20 @@ certificate authority certificate.
values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default
"tls1.0").
## Socket activation
Instead of the listening addresses specified above, rclone will listen to all
FDs passed by the service manager, if any (and ignore any arguments passed by --addr`).
This allows rclone to be a socket-activated service.
It can be configured with .socket and .service unit files as described in
https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html
Socket activation can be tested ad-hoc with the `systemd-socket-activate`command
systemd-socket-activate -l 8000 -- rclone serve
This will socket-activate rclone on the first connection to port 8000 over TCP.
### Template
`--template` allows a user to specify a custom markup template for HTTP
@ -394,6 +422,11 @@ 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)
--vfs-read-chunk-streams int The number of parallel streams to read at once
The chunking behaves differently depending on the `--vfs-read-chunk-streams` parameter.
### `--vfs-read-chunk-streams` == 0
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
@ -409,6 +442,30 @@ When `--vfs-read-chunk-size-limit 500M` is specified, the result would be
Setting `--vfs-read-chunk-size` to `0` or "off" disables chunked reading.
The chunks will not be buffered in memory.
### `--vfs-read-chunk-streams` > 0
Rclone reads `--vfs-read-chunk-streams` chunks of size
`--vfs-read-chunk-size` concurrently. The size for each read will stay
constant.
This improves performance performance massively on high latency links
or very high bandwidth links to high performance object stores.
Some experimentation will be needed to find the optimum values of
`--vfs-read-chunk-size` and `--vfs-read-chunk-streams` as these will
depend on the backend in use and the latency to the backend.
For high performance object stores (eg AWS S3) a reasonable place to
start might be `--vfs-read-chunk-streams 16` and
`--vfs-read-chunk-size 4M`. In testing with AWS S3 the performance
scaled roughly as the `--vfs-read-chunk-streams` setting.
Similar settings should work for high latency links, but depending on
the latency they may need more `--vfs-read-chunk-streams` in order to
get the throughput.
## VFS Performance
These flags may be used to enable/disable features of the VFS for
@ -605,17 +662,17 @@ rclone serve webdav remote:path [flags]
## Options
```
--addr stringArray IPaddress:Port or :Port to bind server to (default [127.0.0.1:8080])
--addr stringArray IPaddress:Port, :Port or [unix://]/path/to/socket to bind server to (default [127.0.0.1:8080])
--allow-origin string Origin which cross-domain request (CORS) can be executed from
--auth-proxy string A program to use to create the backend from the auth
--baseurl string Prefix for URLs - leave blank for root
--cert string TLS PEM key (concatenation of certificate and CA certificate)
--client-ca string Client certificate authority to verify clients with
--dir-cache-time Duration Time to cache directory entries for (default 5m0s)
--dir-perms FileMode Directory permissions (default 0777)
--dir-perms FileMode Directory permissions (default 777)
--disable-dir-list Disable HTML directory list on GET request for a directory
--etag-hash string Which hash to use for the ETag, or auto or blank for off
--file-perms FileMode File permissions (default 0666)
--file-perms FileMode File permissions (default 666)
--gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000)
-h, --help help for webdav
--htpasswd string A htpasswd file - if not provided no authentication is done
@ -634,7 +691,7 @@ rclone serve webdav remote:path [flags]
--server-write-timeout Duration Timeout for server writing data (default 1h0m0s)
--template string User-specified template
--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 FileMode Override the permission bits set by the filesystem (not supported on Windows) (default 002)
--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)
@ -648,6 +705,7 @@ rclone serve webdav remote:path [flags]
--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-chunk-streams int The number of parallel streams to read at once
--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
@ -655,10 +713,12 @@ rclone serve webdav remote:path [flags]
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -685,9 +745,7 @@ Flags for filtering directory listings.
--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
## See Also
* [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol.

10
docs/content/commands/rclone_settier.md
View File

@ -10,10 +10,9 @@ Changes storage class/tier of objects in remote.
## Synopsis
rclone settier changes storage tier or class at remote if supported.
Few cloud storage services provides different storage classes on objects,
for example AWS S3 and Glacier, Azure Blob storage - Hot, Cool and Archive,
Changes storage tier or class at remote if supported. Few cloud storage
services provides different storage classes on objects, for example
AWS S3 and Glacier, Azure Blob storage - Hot, Cool and Archive,
Google Cloud Storage, Regional Storage, Nearline, Coldline etc.
Note that, certain tier changes make objects not available to access immediately.
@ -44,10 +43,9 @@ rclone settier tier remote:path [flags]
-h, --help help for settier
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

15
docs/content/commands/rclone_sha1sum.md
View File

@ -10,7 +10,6 @@ Produces an sha1sum file for all the objects in the path.
## Synopsis
Produces an sha1sum file for all the objects in the path. This
is in the same format as the standard sha1sum tool produces.
@ -46,10 +45,12 @@ rclone sha1sum remote:path [flags]
--output-file string Output hashsums to a file rather than the terminal
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -76,18 +77,16 @@ Flags for filtering directory listings.
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
```
## Listing Options
### Listing Options
Flags for listing directories.
Flags for listing directories
```
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

15
docs/content/commands/rclone_size.md
View File

@ -10,7 +10,6 @@ Prints the total size and number of objects in remote:path.
## Synopsis
Counts objects in the path and calculates the total size. Prints the
result to standard output.
@ -41,10 +40,12 @@ rclone size remote:path [flags]
--json Format output as JSON
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -71,18 +72,16 @@ Flags for filtering directory listings.
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
```
## Listing Options
### Listing Options
Flags for listing directories.
Flags for listing directories
```
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

31
docs/content/commands/rclone_sync.md
View File

@ -9,7 +9,6 @@ Make source and dest identical, modifying destination only.
## Synopsis
Sync the source to the destination, changing the destination
only. Doesn't transfer files that are identical on source and
destination, testing by size and modification time or MD5SUM.
@ -118,15 +117,17 @@ rclone sync source:path dest:path [flags]
-t, --timeformat string Specify a custom time format, or 'max' for max precision supported by remote (default: 2006-01-02 15:04:05)
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Copy Options
### Copy Options
Flags for anything which can Copy a file.
Flags for anything which can copy a file
```
--check-first Do all the checks before starting transfers
-c, --checksum Check for changes with size & checksum (if available, or fallback to size only).
--compare-dest stringArray Include additional comma separated server-side paths during comparison
-c, --checksum Check for changes with size & checksum (if available, or fallback to size only)
--compare-dest stringArray Include additional server-side paths during comparison
--copy-dest stringArray Implies --compare-dest but also copies files from paths into destination
--cutoff-mode HARD|SOFT|CAUTIOUS Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD)
--ignore-case-sync Ignore case when synchronizing
@ -158,9 +159,9 @@ Flags for anything which can Copy a file.
-u, --update Skip files that are newer on the destination
```
## Sync Options
### Sync Options
Flags just used for `rclone sync`.
Flags used for sync commands
```
--backup-dir string Make backups into hierarchy based in DIR
@ -177,9 +178,9 @@ Flags just used for `rclone sync`.
--track-renames-strategy string Strategies to use when synchronizing using track-renames hash|modtime|leaf (default "hash")
```
## Important Options
### Important Options
Important flags useful for most commands.
Important flags useful for most commands
```
-n, --dry-run Do a trial run with no permanent changes
@ -187,9 +188,9 @@ Important flags useful for most commands.
-v, --verbose count Print lots more stuff (repeat for more)
```
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -216,18 +217,16 @@ Flags for filtering directory listings.
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
```
## Listing Options
### Listing Options
Flags for listing directories.
Flags for listing directories
```
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

3
docs/content/commands/rclone_test.md
View File

@ -28,10 +28,9 @@ so reading their documentation first is recommended.
-h, --help help for test
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.
* [rclone test changenotify](/commands/rclone_test_changenotify/) - Log any change notify requests for the remote passed in.

3
docs/content/commands/rclone_test_changenotify.md
View File

@ -19,10 +19,9 @@ rclone test changenotify remote: [flags]
--poll-interval Duration Time to wait between polling for changes (default 10s)
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone test](/commands/rclone_test/) - Run a test command

3
docs/content/commands/rclone_test_histogram.md
View File

@ -27,10 +27,9 @@ rclone test histogram [remote:path] [flags]
-h, --help help for histogram
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone test](/commands/rclone_test/) - Run a test command

11
docs/content/commands/rclone_test_info.md
View File

@ -10,10 +10,10 @@ Discovers file name or other limitations for paths.
## Synopsis
rclone info discovers what filenames and upload methods are possible
to write to the paths passed in and how long they can be. It can take some
time. It will write test files into the remote:path passed in. It outputs
a bit of go code for each one.
Discovers what filenames and upload methods are possible to write to the
paths passed in and how long they can be. It can take some time. It will
write test files into the remote:path passed in. It outputs a bit of go
code for each one.
**NB** this can create undeletable files and other hazards - use with care
@ -37,10 +37,9 @@ rclone test info [remote:path]+ [flags]
--write-json string Write results to file
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone test](/commands/rclone_test/) - Run a test command

3
docs/content/commands/rclone_test_makefile.md
View File

@ -24,10 +24,9 @@ rclone test makefile <size> [<file>]+ [flags]
--zero Fill files with ASCII 0x00
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone test](/commands/rclone_test/) - Run a test command

3
docs/content/commands/rclone_test_makefiles.md
View File

@ -31,10 +31,9 @@ rclone test makefiles <dir> [flags]
--zero Fill files with ASCII 0x00
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone test](/commands/rclone_test/) - Run a test command

3
docs/content/commands/rclone_test_memory.md
View File

@ -18,10 +18,9 @@ rclone test memory remote:path [flags]
-h, --help help for memory
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone test](/commands/rclone_test/) - Run a test command

19
docs/content/commands/rclone_touch.md
View File

@ -10,7 +10,6 @@ Create new file or change file modification time.
## Synopsis
Set the modification time on file(s) as specified by remote:path to
have the current time.
@ -46,10 +45,12 @@ rclone touch remote:path [flags]
-t, --timestamp string Use specified time instead of the current time of day
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Important Options
### Important Options
Important flags useful for most commands.
Important flags useful for most commands
```
-n, --dry-run Do a trial run with no permanent changes
@ -57,9 +58,9 @@ Important flags useful for most commands.
-v, --verbose count Print lots more stuff (repeat for more)
```
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -86,18 +87,16 @@ Flags for filtering directory listings.
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
```
## Listing Options
### Listing Options
Flags for listing directories.
Flags for listing directories
```
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

18
docs/content/commands/rclone_tree.md
View File

@ -10,9 +10,7 @@ List the contents of the remote in a tree like fashion.
## Synopsis
rclone tree lists the contents of a remote in a similar way to the
unix tree command.
Lists the contents of a remote in a similar way to the unix tree command.
For example
@ -67,10 +65,12 @@ rclone tree remote:path [flags]
--version Sort files alphanumerically by version
```
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
## Filter Options
### Filter Options
Flags for filtering directory listings.
Flags for filtering directory listings
```
--delete-excluded Delete files on dest excluded from sync
@ -97,18 +97,16 @@ Flags for filtering directory listings.
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
```
## Listing Options
### Listing Options
Flags for listing directories.
Flags for listing directories
```
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

4
docs/content/commands/rclone_version.md
View File

@ -10,7 +10,6 @@ Show the version number.
## Synopsis
Show the rclone version number, the go version, the build target
OS and architecture, the runtime OS and kernel version and bitness,
build tags and the type of executable (static or dynamic).
@ -60,10 +59,9 @@ rclone version [flags]
-h, --help help for version
```
See the [global flags page](/flags/) for global options not listed here.
# SEE ALSO
## See Also
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

78
docs/content/flags.md
View File

@ -1,6 +1,7 @@
---
title: "Global Flags"
description: "Rclone Global Flags"
# autogenerated - DO NOT EDIT
---
# Global Flags
@ -11,12 +12,12 @@ split into groups.
## Copy
Flags for anything which can Copy a file.
Flags for anything which can copy a file.
```
--check-first Do all the checks before starting transfers
-c, --checksum Check for changes with size & checksum (if available, or fallback to size only).
--compare-dest stringArray Include additional comma separated server-side paths during comparison
-c, --checksum Check for changes with size & checksum (if available, or fallback to size only)
--compare-dest stringArray Include additional server-side paths during comparison
--copy-dest stringArray Implies --compare-dest but also copies files from paths into destination
--cutoff-mode HARD|SOFT|CAUTIOUS Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD)
--ignore-case-sync Ignore case when synchronizing
@ -51,7 +52,7 @@ Flags for anything which can Copy a file.
## Sync
Flags just used for `rclone sync`.
Flags used for sync commands.
```
--backup-dir string Make backups into hierarchy based in DIR
@ -82,7 +83,7 @@ Important flags useful for most commands.
## Check
Flags used for `rclone check`.
Flags used for check commands.
```
--max-backlog int Maximum number of objects in sync or check backlog (default 10000)
@ -91,7 +92,7 @@ Flags used for `rclone check`.
## Networking
General networking and HTTP stuff.
Flags for general networking and HTTP stuff.
```
--bind string Local address to bind to for outgoing connections, IPv4, IPv6 or name
@ -101,7 +102,7 @@ General networking and HTTP stuff.
--client-cert string Client SSL certificate (PEM) for mutual TLS auth
--client-key string Client SSL private key (PEM) for mutual TLS auth
--contimeout Duration Connect timeout (default 1m0s)
--disable-http-keep-alives Disable HTTP keep-alives and use each connection once.
--disable-http-keep-alives Disable HTTP keep-alives and use each connection once
--disable-http2 Disable HTTP/2 in the global transport
--dscp string Set DSCP value to connections, value or name, e.g. CS1, LE, DF, AF21
--expect-continue-timeout Duration Timeout when using expect / 100-continue in HTTP (default 1s)
@ -114,7 +115,7 @@ General networking and HTTP stuff.
--tpslimit float Limit HTTP transactions per second to this
--tpslimit-burst int Max burst of transactions for --tpslimit (default 1)
--use-cookies Enable session cookiejar
--user-agent string Set the user-agent to a specified string (default "rclone/v1.67.0")
--user-agent string Set the user-agent to a specified string (default "rclone/v1.68.0")
```
@ -131,7 +132,7 @@ Flags helpful for increasing performance.
## Config
General configuration of rclone.
Flags for general configuration of rclone.
```
--ask-password Allow prompt for password for encrypted configuration (default true)
@ -215,7 +216,7 @@ Flags for listing directories.
## Logging
Logging and statistics.
Flags for logging and statistics.
```
--log-file string Log everything to this file
@ -234,7 +235,7 @@ Logging and statistics.
--stats-one-line-date-format string Enable --stats-one-line-date and use custom formatted date: Enclose date string in double quotes ("), see https://golang.org/pkg/time/#Time.Format
--stats-unit string Show data rate in stats as either 'bits' or 'bytes' per second (default "bytes")
--syslog Use Syslog for logging
--syslog-facility string Facility for syslog, e.g. KERN,USER,... (default "DAEMON")
--syslog-facility string Facility for syslog, e.g. KERN,USER (default "DAEMON")
--use-json-log Use json log format
-v, --verbose count Print lots more stuff (repeat for more)
```
@ -263,12 +264,12 @@ Flags to control the Remote Control API.
```
--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"])
--rc-allow-origin string Origin which cross-domain request (CORS) can be executed from
--rc-baseurl string Prefix for URLs - leave blank for root
--rc-cert string TLS PEM key (concatenation of certificate and CA certificate)
--rc-client-ca string Client certificate authority to verify clients with
--rc-enable-metrics Enable prometheus metrics on /metrics
--rc-enable-metrics Enable the Prometheus metrics path at the remote control server
--rc-files string Path to local files to serve on the HTTP server
--rc-htpasswd string A htpasswd file - if not provided no authentication is done
--rc-job-expire-duration Duration Expire finished async jobs older than this value (default 1m0s)
@ -294,9 +295,34 @@ Flags to control the Remote Control API.
```
## Metrics
Flags to control the Metrics HTTP endpoint..
```
--metrics-addr stringArray IPaddress:Port or :Port to bind metrics server to (default [""])
--metrics-allow-origin string Origin which cross-domain request (CORS) can be executed from
--metrics-baseurl string Prefix for URLs - leave blank for root
--metrics-cert string TLS PEM key (concatenation of certificate and CA certificate)
--metrics-client-ca string Client certificate authority to verify clients with
--metrics-htpasswd string A htpasswd file - if not provided no authentication is done
--metrics-key string TLS PEM Private key
--metrics-max-header-bytes int Maximum size of request header (default 4096)
--metrics-min-tls-version string Minimum TLS version that is acceptable (default "tls1.0")
--metrics-pass string Password for authentication
--metrics-realm string Realm for authentication
--metrics-salt string Password hashing salt (default "dlPL2MqE")
--metrics-server-read-timeout Duration Timeout for server reading data (default 1h0m0s)
--metrics-server-write-timeout Duration Timeout for server writing data (default 1h0m0s)
--metrics-template string User-specified template
--metrics-user string User name for authentication
--rc-enable-metrics Enable the Prometheus metrics path at the remote control server
```
## Backend
Backend only flags. These can be set in the config file also.
Backend-only flags (these can be set in the config file also).
```
--alias-description string Description of the remote
@ -520,6 +546,12 @@ Backend only flags. These can be set in the config file also.
--filefabric-token-expiry string Token expiry time
--filefabric-url string URL of the Enterprise File Fabric to connect to
--filefabric-version string Version read from the file fabric
--filescom-api-key string The API key used to authenticate with Files.com
--filescom-description string Description of the remote
--filescom-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot)
--filescom-password string The password used to authenticate with Files.com (obscured)
--filescom-site string Your site subdomain (e.g. mysite) or custom domain (e.g. myfiles.customdomain.com)
--filescom-username string The username used to authenticate with Files.com
--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-concurrency int Maximum number of FTP simultaneous connections, 0 for unlimited
@ -563,6 +595,12 @@ Backend only flags. These can be set in the config file also.
--gcs-token string OAuth Access Token as a JSON blob
--gcs-token-url string Token server url
--gcs-user-project string User project
--gofile-access-token string API Access token
--gofile-account-id string Account ID
--gofile-description string Description of the remote
--gofile-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftPeriod,RightPeriod,InvalidUtf8,Dot,Exclamation)
--gofile-list-chunk int Number of items to list in each call (default 1000)
--gofile-root-folder-id string ID of the root folder
--gphotos-auth-url string Auth server URL
--gphotos-batch-commit-timeout Duration Max time to wait for a batch to finish committing (default 10m0s)
--gphotos-batch-mode string Upload file batching sync|async|off (default "sync")
@ -654,6 +692,7 @@ Backend only flags. These can be set in the config file also.
--local-description string Description of the remote
--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-clone Disable reflink cloning for server-side copies
--local-no-preallocate Disable preallocation of disk space for transferred files
--local-no-set-modtime Disable setting modtime
--local-no-sparse Disable sparse files for multi-thread downloads
@ -770,6 +809,10 @@ Backend only flags. These can be set in the config file also.
--pikpak-upload-concurrency int Concurrency for multipart uploads (default 5)
--pikpak-use-trash Send files to the trash instead of deleting permanently (default true)
--pikpak-user string Pikpak username
--pixeldrain-api-key string API key for your pixeldrain account
--pixeldrain-api-url string The API endpoint to connect to. In the vast majority of cases it's fine to leave (default "https://pixeldrain.com/api")
--pixeldrain-description string Description of the remote
--pixeldrain-root-folder-id string Root of the filesystem to use (default "me")
--premiumizeme-auth-url string Auth server URL
--premiumizeme-client-id string OAuth Client Id
--premiumizeme-client-secret string OAuth Client Secret
@ -844,6 +887,7 @@ Backend only flags. These can be set in the config file also.
--s3-provider string Choose your S3 provider
--s3-region string Region to connect to
--s3-requester-pays Enables requester pays option when interacting with S3 bucket
--s3-sdk-log-mode Bits Set to debug the SDK (default Off)
--s3-secret-access-key string AWS Secret Access Key (password)
--s3-server-side-encryption string The server-side encryption algorithm used when storing this object in S3
--s3-session-token string An AWS session token
@ -854,7 +898,6 @@ Backend only flags. These can be set in the config file also.
--s3-sse-customer-key-md5 string If using SSE-C you may provide the secret encryption key MD5 checksum (optional)
--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-sts-endpoint string Endpoint for STS
--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-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint
@ -864,6 +907,7 @@ Backend only flags. These can be set in the config file also.
--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-presigned-request Whether to use a presigned request or PutObject for single part uploads
--s3-use-unsigned-payload Tristate Whether to use an unsigned payload in PutObject (default unset)
--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-deleted Show deleted file markers when using versions
@ -972,10 +1016,12 @@ Backend only flags. These can be set in the config file also.
--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-env-auth Get swift credentials from environment variables in standard OpenStack form
--swift-fetch-until-empty-page When paginating, always fetch unless we received an empty page
--swift-key string API key or password (OS_PASSWORD)
--swift-leave-parts-on-error If true avoid calling abort upload on a failure
--swift-no-chunk Don't chunk files during streaming upload
--swift-no-large-objects Disable support for static and dynamic large objects
--swift-partial-page-fetch-threshold int When paginating, fetch if the current page is within this percentage of the limit
--swift-region string Region name - optional (OS_REGION_NAME)
--swift-storage-policy string The storage policy to use when creating a new container
--swift-storage-url string Storage URL - optional (OS_STORAGE_URL)
@ -1013,6 +1059,7 @@ Backend only flags. These can be set in the config file also.
--webdav-owncloud-exclude-shares Exclude ownCloud shares
--webdav-pacer-min-sleep Duration Minimum time to sleep between API calls (default 10ms)
--webdav-pass string Password (obscured)
--webdav-unix-socket string Path to a unix domain socket to dial to, instead of opening a TCP connection directly
--webdav-url string URL of http host to connect to
--webdav-user string User name
--webdav-vendor string Name of the WebDAV site/service/software you are using
@ -1022,6 +1069,7 @@ Backend only flags. These can be set in the config file also.
--yandex-description string Description of the remote
--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-spoof-ua Set the user agent to match an official version of the yandex disk client. May help with upload performance (default true)
--yandex-token string OAuth Access Token as a JSON blob
--yandex-token-url string Token server url
--zoho-auth-url string Auth server URL

11
docs/content/gofile.md
View File

@ -202,6 +202,17 @@ Properties:
- Type: string
- Required: false
#### --gofile-list-chunk
Number of items to list in each call
Properties:
- Config: list_chunk
- Env Var: RCLONE_GOFILE_LIST_CHUNK
- Type: int
- Default: 1000
#### --gofile-encoding
The encoding for the backend.

26
docs/content/local.md
View File

@ -512,6 +512,32 @@ Properties:
- Type: bool
- Default: false
#### --local-no-clone
Disable reflink cloning for server-side copies.
Normally, for local-to-local transfers, rclone will "clone" the file when
possible, and fall back to "copying" only when cloning is not supported.
Cloning creates a shallow copy (or "reflink") which initially shares blocks with
the original file. Unlike a "hardlink", the two files are independent and
neither will affect the other if subsequently modified.
Cloning is usually preferable to copying, as it is much faster and is
deduplicated by default (i.e. having two identical files does not consume more
storage than having just one.) However, for use cases where data redundancy is
preferable, --local-no-clone can be used to disable cloning and force "deep" copies.
Currently, cloning is only supported when using APFS on macOS (support for other
platforms may be added in the future.)
Properties:
- Config: no_clone
- Env Var: RCLONE_LOCAL_NO_CLONE
- Type: bool
- Default: false
#### --local-no-preallocate
Disable preallocation of disk space for transferred files.

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