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

Version v1.71.0

Browse Source
This commit is contained in:
Nick Craig-Wood
2025-08-22 16:03:16 +01:00
parent cfd0d28742
commit 3f0e9f5fca
45 changed files with 61061 additions and 33341 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46422
MANUAL.html generated
View File

File diff suppressed because it is too large Load Diff

20425
MANUAL.md generated
View File

File diff suppressed because it is too large Load Diff

5935
MANUAL.txt generated
View File

File diff suppressed because it is too large Load Diff

2
docs/content/box.md
View File

@@ -390,6 +390,8 @@ Use client credentials OAuth flow.
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
Note that this option is NOT supported by all backends.
Properties:
- Config: client_credentials

111
docs/content/changelog.md
View File

@@ -6,6 +6,111 @@ description: "Rclone Changelog"
# Changelog
## v1.71.0 - 2025-08-22
[See commits](https://github.com/rclone/rclone/compare/v1.70.0...v1.71.0)
- New S3 providers
- [Exaba](/s3/#exaba) (Nick Craig-Wood)
- We've been working with Exaba and they would love early adopters, self-hosters and testers
- [OVHcloud Object Storage](/s3/#ovhcloud) (Florent Vennetier)
- [Zata](/s3/#Zata) ($@M@RTH_)
- New Features
- Allow [global config to be overriden or set on backend creation](/docs/#globalconfig) (Nick Craig-Wood)
- bisync: Promoted from beta to stable (nielash)
- build
- Update to go1.25 and make go1.24 the minimum required version (Nick Craig-Wood)
- Update all dependencies (Nick Craig-Wood)
- Upgrade golangci-lint to v2 and fix code and config (albertony)
- Add markdown linting to workflow and fix all the docs (albertony)
- Extend check for edits of autogenerated files to all commits in a pull request (albertony)
- Set default shell to bash in build.yml (Ross Smith II)
- config
- Make parsing of `Duration` options consistent (albertony)
- Add error if `RCLONE_CONFIG_PASS` was supplied it but didn't decrypt the config (n4n5)
- copy, copyto: Implement logger flags to store result of sync (Marvin Rösch)
- doc fixes (albertony, Ali Zein Yousuf, Binbin Qian, curlwget, Ed Craig-Wood, jinjingroad, Lucas Bremgartner, n4n5, Nick Craig-Wood)
- hash: Add support for BLAKE3, XXH3, XXH128 (albertony)
- http
- Add `--client-pass` support for encrypted `--client-key` files (Nick Craig-Wood)
- Allow setting of `--http-proxy` from the command line (Nick Craig-Wood)
- lib/mmap: Convert to using unsafe.Slice to avoid deprecated reflect.SliceHeader (cui)
- lib/transform: Avoid empty charmap entry (albertony)
- log: Add log rotation options when using [`--log-file`](/docs/#log-file-string) (Nick Craig-Wood)
- move, moveto: Implement logger flags to store result of sync (Marvin Rösch)
- pool: Unify memory between multipart and asyncreader to use one pool (Nick Craig-Wood)
- purge: Exit with a fatal error if filters are set on `rclone purge` (Nick Craig-Wood)
- rc
- Add `config/unlock` to unlock the config file (n4n5)
- Fix `config/listremotes` to send an empty array instead of nil (n4n5)
- Populate transfer snapshot with "what" value (Timothy Jacobs)
- serve sftp: Add support for more hashes (crc32, sha256, blake3, xxh3, xxh128) (albertony)
- transform: Add `truncate_keep_extension` and `truncate_bytes` (nielash)
- Bug Fixes
- about: Fix potential overflow of about in various backends (Nick Craig-Wood)
- accounting
- Fix incorrect stats with `--transfers=1` (Yu Xin)
- Fix stats (`speed=0` and `eta=nil`) when starting jobs via rc (Nick Craig-Wood)
- bisync
- Fix concurrent runs via rc (nielash)
- Fix `--no-slow-hash` settings on path2 (nielash)
- config: fix problem reading pasted tokens over 4095 bytes (Nick Craig-Wood)
- oauthutil: Fix nil pointer crash when started with expired token (Nick Craig-Wood)
- operations: Fix too many connections open when using `--max-buffer-memory` (Nick Craig-Wood)
- pool: Fix deadlock with `--max-buffer-memory` and multipart transfers (Nick Craig-Wood)
- rc: Fix `operations/check` ignoring `oneWay` parameter (houance)
- Mount
- Fix identification of symlinks in directory listings (huangnauh)
- Local
- Configurable supported hashes (albertony)
- Fix `--copy-links` on Windows when listing Junction points (Anagh Kumar Baranwal)
- Azure Blob
- Add support for client assertion based authentication (Vikas Bhansali)
- Fix deadlock with `--max-connections` with `InvalidBlockOrBlob` errors (Nick Craig-Wood)
- Fix double accounting for multipart uploads (Nick Craig-Wood)
- Azurefiles
- Add support for client assertion based authentication (Vikas Bhansali)
- Fix hash getting erased when modtime is set (nielash)
- Box
- Fix about: cannot unmarshal number 1.0e+18 into Go struct field (Nick Craig-Wood)
- Combine
- Fix directory not found errors with ListP interface (Nick Craig-Wood)
- Filescom
- Document that hashes need to be enabled (Nick Craig-Wood)
- FTP
- Allow insecure TLS ciphers (Anagh Kumar Baranwal)
- Make TLS config default to global TLS config (Nick Craig-Wood)
- This allows `--ca-cert`, `--client-cert` etc to be used.
- This also allows `override.ca_cert = XXX` to be used in the config file.
- Googlephotos
- Added warning for Google Photos compatability-fixes (raider13209)
- Imagekit
- Return correct error when attempting to upload zero length files (Nick Craig-Wood)
- Don't low level retry uploads (Nick Craig-Wood)
- Remove server side Copy method as it was downloading and uploading (Nick Craig-Wood)
- Internetarchive
- Fix server side copy of files with `&` (Nick Craig-Wood)
- Mega
- Fix tls handshake failure (necaran)
- Oracleobjectstorage
- Add read only metadata support (praveen-solanki-oracle)
- Pikpak
- Rewrite upload to bypass AWS S3 manager (wiserain)
- Enhance Move for better handling of error and name collision (wiserain)
- Enhance Copy method to handle name collisions and improve error management (wiserain)
- Add file name integrity check during upload (wiserain)
- S3
- Add `--s3-use-arn-region` flag (Nick Craig-Wood)
- Fix memory leak by cloning strings (liubingrun)
- Fix multipart upload and server side copy when using bucket policy SSE-C (Albin Parou)
- Fix `Content-Type: aws-chunked` causing upload errors with `--metadata` (Nick Craig-Wood)
- SFTP
- Add support for more hashes (crc32, sha256, blake3, xxh3, xxh128) (albertony)
- Smb
- Add `--smb-kerberos-ccache` option to set kerberos ccache per smb backend (Sudipto Baral)
- Refresh Kerberos credentials when ccache file changes (Sudipto Baral)
- Improve multithreaded upload performance using multiple connections (Sudipto Baral)
## v1.70.3 - 2025-07-09
[See commits](https://github.com/rclone/rclone/compare/v1.70.2...v1.70.3)
@@ -39,12 +144,6 @@ description: "Rclone Changelog"
- doc fixes (Ali Zein Yousuf, Nick Craig-Wood)
- Local
- Fix --skip-links on Windows when skipping Junction points (Nick Craig-Wood)
- Combine
- Fix directory not found errors with ListP interface (Nick Craig-Wood)
- Mega
- Fix tls handshake failure (necaran)
- Pikpak
- Fix uploads fail with "aws-chunked encoding is not supported" error (Nick Craig-Wood)
## v1.70.1 - 2025-06-19

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

@@ -165,6 +165,7 @@ rclone [flags]
--chunker-remote string Remote to chunk/unchunk
--client-cert string Client SSL certificate (PEM) for mutual TLS auth
--client-key string Client SSL private key (PEM) for mutual TLS auth
--client-pass string Password for client SSL private key (PEM) for mutual TLS auth (obscured) (obscured)
--cloudinary-adjust-media-files-extensions Cloudinary handles media formats as a file attribute and strips it from the name, which is unlike most other file systems (default true)
--cloudinary-api-key string Cloudinary API Key
--cloudinary-api-secret string Cloudinary API Secret
@@ -327,6 +328,7 @@ rclone [flags]
--fix-case Force rename of case insensitive dest to match source
--fs-cache-expire-duration Duration Cache remotes for this long (0 to disable caching) (default 5m0s)
--fs-cache-expire-interval Duration Interval to check for expired remotes (default 1m0s)
--ftp-allow-insecure-tls-ciphers Allow insecure TLS ciphers
--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
@@ -339,6 +341,7 @@ rclone [flags]
--ftp-explicit-tls Use Explicit FTPS (FTP over TLS)
--ftp-force-list-hidden Use LIST -a to force listing of hidden files and folders. This will disable the use of MLSD
--ftp-host string FTP host to connect to
--ftp-http-proxy string URL for HTTP CONNECT proxy
--ftp-idle-timeout Duration Max time before closing idle connections (default 1m0s)
--ftp-no-check-certificate Do not verify the TLS certificate of the server
--ftp-no-check-upload Don't check the upload is OK
@@ -432,6 +435,7 @@ rclone [flags]
--http-no-escape Do not escape URL metacharacters in path names
--http-no-head Don't use HEAD requests
--http-no-slash Set this if the site doesn't end directories with /
--http-proxy string HTTP proxy URL
--http-url string URL of HTTP host to connect to
--human-readable Print numbers in a human-readable format, sizes with suffix Ki|Mi|Gi|Ti|Pi
--iclouddrive-apple-id string Apple ID
@@ -499,6 +503,7 @@ rclone [flags]
--local-case-sensitive Force the filesystem to report itself as case sensitive
--local-description string Description of the remote
--local-encoding Encoding The encoding for the backend (default Slash,Dot)
--local-hashes CommaSepList Comma separated list of supported checksum types
--local-links Translate symlinks to/from regular files with a '.rclonelink' extension for the local backend
--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
@@ -510,6 +515,10 @@ rclone [flags]
--local-unicode-normalization Apply unicode NFC normalization to paths and filenames
--local-zero-size-links Assume the Stat size of links is zero (and read them instead) (deprecated)
--log-file string Log everything to this file
--log-file-compress If set, compress rotated log files using gzip
--log-file-max-age Duration Maximum duration to retain old log files (eg "7d") (default 0s)
--log-file-max-backups int Maximum number of old log files to retain
--log-file-max-size SizeSuffix Maximum size of the log file before it's rotated (eg "10M") (default off)
--log-format Bits Comma separated list of log format options (default date,time)
--log-level LogLevel Log level DEBUG|INFO|NOTICE|ERROR (default NOTICE)
--log-systemd Activate systemd integration for the logger
@@ -680,7 +689,8 @@ rclone [flags]
--pikpak-pass string Pikpak password (obscured)
--pikpak-root-folder-id string ID of the root folder
--pikpak-trashed-only Only show files that are in the trash
--pikpak-upload-concurrency int Concurrency for multipart uploads (default 5)
--pikpak-upload-concurrency int Concurrency for multipart uploads (default 4)
--pikpak-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi)
--pikpak-use-trash Send files to the trash instead of deleting permanently (default true)
--pikpak-user string Pikpak username
--pikpak-user-agent string HTTP user agent for pikpak (default "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:129.0) Gecko/20100101 Firefox/129.0")
@@ -820,6 +830,7 @@ rclone [flags]
--s3-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint
--s3-use-accept-encoding-gzip Accept-Encoding: gzip Whether to send Accept-Encoding: gzip header (default unset)
--s3-use-already-exists Tristate Set if rclone should report BucketAlreadyExists errors on bucket creation (default unset)
--s3-use-arn-region If true, enables arn region support for the service
--s3-use-dual-stack If true use AWS S3 dual-stack endpoint (IPv6 support)
--s3-use-multipart-etag Tristate Whether to use ETag in multipart uploads for verification (default unset)
--s3-use-multipart-uploads Tristate Set if rclone should use multipart uploads (default unset)
@@ -833,7 +844,7 @@ rclone [flags]
--seafile-2fa Two-factor authentication ('true' if the account has 2FA enabled)
--seafile-create-library Should rclone create a library if it doesn't exist
--seafile-description string Description of the remote
--seafile-encoding Encoding The encoding for the backend (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8)
--seafile-encoding Encoding The encoding for the backend (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8,Dot)
--seafile-library string Name of the library
--seafile-library-key string Library password (for encrypted libraries only) (obscured)
--seafile-pass string Password (obscured)
@@ -841,15 +852,18 @@ rclone [flags]
--seafile-user string User name (usually email address)
--server-side-across-configs Allow server-side operations (e.g. copy) to work across different configs
--sftp-ask-password Allow asking for SFTP password when needed
--sftp-blake3sum-command string The command used to read BLAKE3 hashes
--sftp-chunk-size SizeSuffix Upload and download chunk size (default 32Ki)
--sftp-ciphers SpaceSepList Space separated list of ciphers to be used for session encryption, ordered by preference
--sftp-concurrency int The maximum number of outstanding requests for one file (default 64)
--sftp-connections int Maximum number of SFTP simultaneous connections, 0 for unlimited
--sftp-copy-is-hardlink Set to enable server side copies using hardlinks
--sftp-crc32sum-command string The command used to read CRC-32 hashes
--sftp-description string Description of the remote
--sftp-disable-concurrent-reads If set don't use concurrent reads
--sftp-disable-concurrent-writes If set don't use concurrent writes
--sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available
--sftp-hashes CommaSepList Comma separated list of supported checksum types
--sftp-host string SSH host to connect to
--sftp-host-key-algorithms SpaceSepList Space separated list of host key algorithms, ordered by preference
--sftp-http-proxy string URL for HTTP CONNECT proxy
@@ -861,7 +875,7 @@ rclone [flags]
--sftp-key-use-agent When set forces the usage of the ssh-agent
--sftp-known-hosts-file string Optional path to known_hosts file
--sftp-macs SpaceSepList Space separated list of MACs (message authentication code) algorithms, ordered by preference
--sftp-md5sum-command string The command used to read md5 hashes
--sftp-md5sum-command string The command used to read MD5 hashes
--sftp-pass string SSH password, leave blank to use ssh-agent (obscured)
--sftp-path-override string Override path used by SSH shell commands
--sftp-port int SSH port number (default 22)
@@ -870,7 +884,8 @@ rclone [flags]
--sftp-server-command string Specifies the path or command to run a sftp server on the remote host
--sftp-set-env SpaceSepList Environment variables to pass to sftp and commands
--sftp-set-modtime Set the modified time on the remote if set (default true)
--sftp-sha1sum-command string The command used to read sha1 hashes
--sftp-sha1sum-command string The command used to read SHA-1 hashes
--sftp-sha256sum-command string The command used to read SHA-256 hashes
--sftp-shell-type string The type of SSH shell on remote server, if any
--sftp-skip-links Set to skip any symlinks and any other non regular files
--sftp-socks-proxy string Socks 5 proxy host
@@ -879,6 +894,8 @@ rclone [flags]
--sftp-use-fstat If set use fstat instead of stat
--sftp-use-insecure-cipher Enable the use of insecure ciphers and key exchange methods
--sftp-user string SSH username (default "$USER")
--sftp-xxh128sum-command string The command used to read XXH128 hashes
--sftp-xxh3sum-command string The command used to read XXH3 hashes
--sharefile-auth-url string Auth server URL
--sharefile-chunk-size SizeSuffix Upload chunk size (default 64Mi)
--sharefile-client-credentials Use client credentials OAuth flow
@@ -905,6 +922,7 @@ rclone [flags]
--smb-hide-special-share Hide special shares (e.g. print$) which users aren't supposed to access (default true)
--smb-host string SMB server hostname to connect to
--smb-idle-timeout Duration Max time before closing idle connections (default 1m0s)
--smb-kerberos-ccache string Path to the Kerberos credential cache (krb5cc)
--smb-pass string SMB password (obscured)
--smb-port int SMB port number (default 445)
--smb-spn string Service principal name
@@ -997,7 +1015,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.70.0")
--user-agent string Set the user-agent to a specified string (default "rclone/v1.71.0")
-v, --verbose count Print lots more stuff (repeat for more)
-V, --version Print the version number
--webdav-auth-redirect Preserve authentication on redirect

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

@@ -1,7 +1,6 @@
---
title: "rclone bisync"
description: "Perform bidirectional synchronization between two paths."
status: Beta
versionIntroduced: v1.58
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/bisync/ and as part of making a release run "make commanddocs"
---
@@ -21,7 +20,7 @@ On each successive run it will:
Changes include `New`, `Newer`, `Older`, and `Deleted` files.
- Propagate changes on Path1 to Path2, and vice-versa.
Bisync is **in beta** and is considered an **advanced command**, so use with care.
Bisync is considered an **advanced command**, so use with care.
Make sure you have read and understood the entire [manual](https://rclone.org/bisync)
(especially the [Limitations](https://rclone.org/bisync/#limitations) section) before using,
or data loss can result. Questions can be asked in the [Rclone Forum](https://forum.rclone.org/).
@@ -56,7 +55,7 @@ rclone bisync remote1:path1 remote2:path2 [flags]
--no-slow-hash Ignore listing checksums only on backends where they are slow
--recover Automatically recover from interruptions without requiring --resync.
--remove-empty-dirs Remove ALL empty directories at the final cleanup step.
--resilient Allow future runs to retry after certain less-serious errors, instead of requiring --resync. Use at your own risk!
--resilient Allow future runs to retry after certain less-serious errors, instead of requiring --resync.
-1, --resync Performs the resync run. Equivalent to --resync-mode path1. Consider using --verbose or --dry-run first.
--resync-mode string During resync, prefer the version that is: path1, path2, newer, older, larger, smaller (default: path1 if --resync, otherwise none for no resync.) (default "none")
--slow-hash-sync-only Ignore slow checksums for listings and deltas, but still consider them during sync calls.

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

@@ -49,7 +49,7 @@ you what happened to it. These are reminiscent of diff files.
- `* path` means path was present in source and destination but different.
- `! path` means there was an error reading or hashing the source or dest.
The default number of parallel checks is 8. See the [--checkers=N](/docs/#checkers-n)
The default number of parallel checks is 8. See the [--checkers](/docs/#checkers-int)
option for more information.

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

@@ -44,7 +44,7 @@ you what happened to it. These are reminiscent of diff files.
- `* path` means path was present in source and destination but different.
- `! path` means there was an error reading or hashing the source or dest.
The default number of parallel checks is 8. See the [--checkers=N](/docs/#checkers-n)
The default number of parallel checks is 8. See the [--checkers](/docs/#checkers-int)
option for more information.

28
docs/content/commands/rclone_convmv.md
View File

@@ -221,12 +221,12 @@ rclone convmv "stories/The Quick Brown Fox!.txt" --name-transform "all,command=e
```
rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{YYYYMMDD}"
// Output: stories/The Quick Brown Fox!-20250617
// Output: stories/The Quick Brown Fox!-20250618
```
```
rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{macfriendlytime}"
// Output: stories/The Quick Brown Fox!-2025-06-17 0551PM
// Output: stories/The Quick Brown Fox!-2025-06-18 0148PM
```
```
@@ -234,17 +234,15 @@ rclone convmv "stories/The Quick Brown Fox!.txt" --name-transform "all,regex=[\\
// Output: ababababababab/ababab ababababab ababababab ababab!abababab
```
Multiple transformations can be used in sequence, applied in the order they are specified on the command line.
The `--name-transform` flag is also available in `sync`, `copy`, and `move`.
# Files vs Directories ##
# Files vs Directories
By default `--name-transform` will only apply to file names. The means only the leaf file name will be transformed.
However some of the transforms would be better applied to the whole path or just directories.
To choose which which part of the file path is affected some tags can be added to the `--name-transform`
To choose which which part of the file path is affected some tags can be added to the `--name-transform`.
| Tag | Effect |
|------|------|
@@ -254,11 +252,11 @@ To choose which which part of the file path is affected some tags can be added t
This is used by adding the tag into the transform name like this: `--name-transform file,prefix=ABC` or `--name-transform dir,prefix=DEF`.
For some conversions using all is more likely to be useful, for example `--name-transform all,nfc`
For some conversions using all is more likely to be useful, for example `--name-transform all,nfc`.
Note that `--name-transform` may not add path separators `/` to the name. This will cause an error.
# Ordering and Conflicts ##
# Ordering and Conflicts
* Transformations will be applied in the order specified by the user.
* If the `file` tag is in use (the default) then only the leaf name of files will be transformed.
@@ -273,19 +271,19 @@ user, allowing for intentional use cases (e.g., trimming one prefix before addin
* Users should be aware that certain combinations may lead to unexpected results and should verify
transformations using `--dry-run` before execution.
# Race Conditions and Non-Deterministic Behavior ##
# Race Conditions and Non-Deterministic Behavior
Some transformations, such as `replace=old:new`, may introduce conflicts where multiple source files map to the same destination name.
This can lead to race conditions when performing concurrent transfers. It is up to the user to anticipate these.
* If two files from the source are transformed into the same name at the destination, the final state may be non-deterministic.
* Running rclone check after a sync using such transformations may erroneously report missing or differing files due to overwritten results.
* To minimize risks, users should:
* Carefully review transformations that may introduce conflicts.
* Use `--dry-run` to inspect changes before executing a sync (but keep in mind that it won't show the effect of non-deterministic transformations).
* Avoid transformations that cause multiple distinct source files to map to the same destination name.
* Consider disabling concurrency with `--transfers=1` if necessary.
* Certain transformations (e.g. `prefix`) will have a multiplying effect every time they are used. Avoid these when using `bisync`.
To minimize risks, users should:
* Carefully review transformations that may introduce conflicts.
* Use `--dry-run` to inspect changes before executing a sync (but keep in mind that it won't show the effect of non-deterministic transformations).
* Avoid transformations that cause multiple distinct source files to map to the same destination name.
* Consider disabling concurrency with `--transfers=1` if necessary.
* Certain transformations (e.g. `prefix`) will have a multiplying effect every time they are used. Avoid these when using `bisync`.

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

@@ -74,6 +74,47 @@ for more info.
**Note**: Use the `--dry-run` or the `--interactive`/`-i` flag to test without copying anything.
# Logger Flags
The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match` and `--error` flags write paths,
one per line, to the file name (or stdout if it is `-`) supplied. What they write is described
in the help below. For example `--differ` will write all paths which are present
on both the source and destination but different.
The `--combined` flag will write a file (or stdout) which contains all
file paths with a symbol and then a space and then the path to tell
you what happened to it. These are reminiscent of diff files.
- `= path` means path was found in source and destination and was identical
- `- path` means path was missing on the source, so only in the destination
- `+ path` means path was missing on the destination, so only in the source
- `* path` means path was present in source and destination but different.
- `! path` means there was an error reading or hashing the source or dest.
The `--dest-after` flag writes a list file using the same format flags
as [`lsf`](/commands/rclone_lsf/#synopsis) (including [customizable options
for hash, modtime, etc.](/commands/rclone_lsf/#synopsis))
Conceptually it is similar to rsync's `--itemize-changes`, but not identical
-- it should output an accurate list of what will be on the destination
after the command is finished.
When the `--no-traverse` flag is set, all logs involving files that exist only
on the destination will be incomplete or completely missing.
Note that these logger flags have a few limitations, and certain scenarios
are not currently supported:
- `--max-duration` / `CutoffModeHard`
- `--compare-dest` / `--copy-dest`
- server-side moves of an entire dir at once
- High-level retries, because there would be duplicates (use `--retries 1` to disable)
- Possibly some unusual error scenarios
Note also that each file is logged during execution, as opposed to after, so it
is most useful as a predictor of what SHOULD happen to each file
(which may or may not match what actually DID.)
```
rclone copy source:path dest:path [flags]
@@ -82,8 +123,24 @@ rclone copy source:path dest:path [flags]
## Options
```
--absolute Put a leading / in front of path names
--combined string Make a combined report of changes to this file
--create-empty-src-dirs Create empty source dirs on destination after copy
--csv Output in CSV format
--dest-after string Report all files that exist on the dest post-sync
--differ string Report all non-matching files to this file
-d, --dir-slash Append a slash to directory names (default true)
--dirs-only Only list directories
--error string Report all files with errors (hashing or reading) to this file
--files-only Only list files (default true)
-F, --format string Output format - see lsf help for details (default "p")
--hash h Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default "md5")
-h, --help help for copy
--match string Report all matching files to this file
--missing-on-dst string Report all files missing from the destination to this file
--missing-on-src string Report all files missing from the source to this file
-s, --separator string Separator for the items in the format (default ";")
-t, --timeformat string Specify a custom time format, or 'max' for max precision supported by remote (default: 2006-01-02 15:04:05)
```
Options shared with other commands are described next.

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

@@ -40,6 +40,47 @@ the destination.
**Note**: Use the `-P`/`--progress` flag to view real-time transfer statistics
# Logger Flags
The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match` and `--error` flags write paths,
one per line, to the file name (or stdout if it is `-`) supplied. What they write is described
in the help below. For example `--differ` will write all paths which are present
on both the source and destination but different.
The `--combined` flag will write a file (or stdout) which contains all
file paths with a symbol and then a space and then the path to tell
you what happened to it. These are reminiscent of diff files.
- `= path` means path was found in source and destination and was identical
- `- path` means path was missing on the source, so only in the destination
- `+ path` means path was missing on the destination, so only in the source
- `* path` means path was present in source and destination but different.
- `! path` means there was an error reading or hashing the source or dest.
The `--dest-after` flag writes a list file using the same format flags
as [`lsf`](/commands/rclone_lsf/#synopsis) (including [customizable options
for hash, modtime, etc.](/commands/rclone_lsf/#synopsis))
Conceptually it is similar to rsync's `--itemize-changes`, but not identical
-- it should output an accurate list of what will be on the destination
after the command is finished.
When the `--no-traverse` flag is set, all logs involving files that exist only
on the destination will be incomplete or completely missing.
Note that these logger flags have a few limitations, and certain scenarios
are not currently supported:
- `--max-duration` / `CutoffModeHard`
- `--compare-dest` / `--copy-dest`
- server-side moves of an entire dir at once
- High-level retries, because there would be duplicates (use `--retries 1` to disable)
- Possibly some unusual error scenarios
Note also that each file is logged during execution, as opposed to after, so it
is most useful as a predictor of what SHOULD happen to each file
(which may or may not match what actually DID.)
```
rclone copyto source:path dest:path [flags]
@@ -48,7 +89,23 @@ rclone copyto source:path dest:path [flags]
## Options
```
-h, --help help for copyto
--absolute Put a leading / in front of path names
--combined string Make a combined report of changes to this file
--csv Output in CSV format
--dest-after string Report all files that exist on the dest post-sync
--differ string Report all non-matching files to this file
-d, --dir-slash Append a slash to directory names (default true)
--dirs-only Only list directories
--error string Report all files with errors (hashing or reading) to this file
--files-only Only list files (default true)
-F, --format string Output format - see lsf help for details (default "p")
--hash h Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default "md5")
-h, --help help for copyto
--match string Report all matching files to this file
--missing-on-dst string Report all files missing from the destination to this file
--missing-on-src string Report all files missing from the source to this file
-s, --separator string Separator for the items in the format (default ";")
-t, --timeformat string Specify a custom time format, or 'max' for max precision supported by remote (default: 2006-01-02 15:04:05)
```
Options shared with other commands are described next.

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

@@ -54,7 +54,7 @@ you what happened to it. These are reminiscent of diff files.
- `* path` means path was present in source and destination but different.
- `! path` means there was an error reading or hashing the source or dest.
The default number of parallel checks is 8. See the [--checkers=N](/docs/#checkers-n)
The default number of parallel checks is 8. See the [--checkers](/docs/#checkers-int)
option for more information.

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

@@ -37,6 +37,9 @@ Run without a hash to see the list of all supported hashes, e.g.
* crc32
* sha256
* sha512
* blake3
* xxh3
* xxh128
Then

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

@@ -252,7 +252,7 @@ to run as the SYSTEM account. A third alternative is to use the
Read more in the [install documentation](https://rclone.org/install/).
Note that when running rclone as another user, it will not use
the configuration file from your profile unless you tell it to
with the [`--config`](https://rclone.org/docs/#config-config-file) option.
with the [`--config`](https://rclone.org/docs/#config-string) option.
Note also that it is now the SYSTEM account that will have the owner
permissions, and other accounts will have permissions according to the
group or others scopes. As mentioned above, these will then not get the
@@ -328,10 +328,10 @@ See the [VFS File Caching](#vfs-file-caching) section for more info.
When using NFS mount on macOS, if you don't specify |--vfs-cache-mode|
the mount point will be read-only.
The bucket-based remotes (e.g. Swift, S3, Google Compute Storage, B2)
do not support the concept of empty directories, so empty
directories will have a tendency to disappear once they fall out of
the directory cache.
Bucket-based remotes - Azure Blob, Swift, S3, Google Cloud Storage and B2 -
can't store empty directories. Of these, only Azure Blob, Google Cloud Storage
and S3 can preserve them when you add `--xxx-directory_markers`; otherwise,
empty directories will vanish once they drop out of the directory cache.
When `rclone mount` is invoked on Unix with `--daemon` flag, the main rclone
program will wait for the background mount to become ready or until the timeout

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

@@ -48,6 +48,47 @@ for more info.
**Note**: Use the `-P`/`--progress` flag to view real-time transfer statistics.
# Logger Flags
The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match` and `--error` flags write paths,
one per line, to the file name (or stdout if it is `-`) supplied. What they write is described
in the help below. For example `--differ` will write all paths which are present
on both the source and destination but different.
The `--combined` flag will write a file (or stdout) which contains all
file paths with a symbol and then a space and then the path to tell
you what happened to it. These are reminiscent of diff files.
- `= path` means path was found in source and destination and was identical
- `- path` means path was missing on the source, so only in the destination
- `+ path` means path was missing on the destination, so only in the source
- `* path` means path was present in source and destination but different.
- `! path` means there was an error reading or hashing the source or dest.
The `--dest-after` flag writes a list file using the same format flags
as [`lsf`](/commands/rclone_lsf/#synopsis) (including [customizable options
for hash, modtime, etc.](/commands/rclone_lsf/#synopsis))
Conceptually it is similar to rsync's `--itemize-changes`, but not identical
-- it should output an accurate list of what will be on the destination
after the command is finished.
When the `--no-traverse` flag is set, all logs involving files that exist only
on the destination will be incomplete or completely missing.
Note that these logger flags have a few limitations, and certain scenarios
are not currently supported:
- `--max-duration` / `CutoffModeHard`
- `--compare-dest` / `--copy-dest`
- server-side moves of an entire dir at once
- High-level retries, because there would be duplicates (use `--retries 1` to disable)
- Possibly some unusual error scenarios
Note also that each file is logged during execution, as opposed to after, so it
is most useful as a predictor of what SHOULD happen to each file
(which may or may not match what actually DID.)
```
rclone move source:path dest:path [flags]
@@ -56,9 +97,25 @@ rclone move source:path dest:path [flags]
## Options
```
--absolute Put a leading / in front of path names
--combined string Make a combined report of changes to this file
--create-empty-src-dirs Create empty source dirs on destination after move
--csv Output in CSV format
--delete-empty-src-dirs Delete empty source dirs after move
--dest-after string Report all files that exist on the dest post-sync
--differ string Report all non-matching files to this file
-d, --dir-slash Append a slash to directory names (default true)
--dirs-only Only list directories
--error string Report all files with errors (hashing or reading) to this file
--files-only Only list files (default true)
-F, --format string Output format - see lsf help for details (default "p")
--hash h Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default "md5")
-h, --help help for move
--match string Report all matching files to this file
--missing-on-dst string Report all files missing from the destination to this file
--missing-on-src string Report all files missing from the source to this file
-s, --separator string Separator for the items in the format (default ";")
-t, --timeformat string Specify a custom time format, or 'max' for max precision supported by remote (default: 2006-01-02 15:04:05)
```
Options shared with other commands are described next.

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

@@ -41,6 +41,47 @@ successful transfer.
**Note**: Use the `-P`/`--progress` flag to view real-time transfer statistics.
# Logger Flags
The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match` and `--error` flags write paths,
one per line, to the file name (or stdout if it is `-`) supplied. What they write is described
in the help below. For example `--differ` will write all paths which are present
on both the source and destination but different.
The `--combined` flag will write a file (or stdout) which contains all
file paths with a symbol and then a space and then the path to tell
you what happened to it. These are reminiscent of diff files.
- `= path` means path was found in source and destination and was identical
- `- path` means path was missing on the source, so only in the destination
- `+ path` means path was missing on the destination, so only in the source
- `* path` means path was present in source and destination but different.
- `! path` means there was an error reading or hashing the source or dest.
The `--dest-after` flag writes a list file using the same format flags
as [`lsf`](/commands/rclone_lsf/#synopsis) (including [customizable options
for hash, modtime, etc.](/commands/rclone_lsf/#synopsis))
Conceptually it is similar to rsync's `--itemize-changes`, but not identical
-- it should output an accurate list of what will be on the destination
after the command is finished.
When the `--no-traverse` flag is set, all logs involving files that exist only
on the destination will be incomplete or completely missing.
Note that these logger flags have a few limitations, and certain scenarios
are not currently supported:
- `--max-duration` / `CutoffModeHard`
- `--compare-dest` / `--copy-dest`
- server-side moves of an entire dir at once
- High-level retries, because there would be duplicates (use `--retries 1` to disable)
- Possibly some unusual error scenarios
Note also that each file is logged during execution, as opposed to after, so it
is most useful as a predictor of what SHOULD happen to each file
(which may or may not match what actually DID.)
```
rclone moveto source:path dest:path [flags]
@@ -49,7 +90,23 @@ rclone moveto source:path dest:path [flags]
## Options
```
-h, --help help for moveto
--absolute Put a leading / in front of path names
--combined string Make a combined report of changes to this file
--csv Output in CSV format
--dest-after string Report all files that exist on the dest post-sync
--differ string Report all non-matching files to this file
-d, --dir-slash Append a slash to directory names (default true)
--dirs-only Only list directories
--error string Report all files with errors (hashing or reading) to this file
--files-only Only list files (default true)
-F, --format string Output format - see lsf help for details (default "p")
--hash h Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default "md5")
-h, --help help for moveto
--match string Report all matching files to this file
--missing-on-dst string Report all files missing from the destination to this file
--missing-on-src string Report all files missing from the source to this file
-s, --separator string Separator for the items in the format (default ";")
-t, --timeformat string Specify a custom time format, or 'max' for max precision supported by remote (default: 2006-01-02 15:04:05)
```
Options shared with other commands are described next.

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

@@ -253,7 +253,7 @@ to run as the SYSTEM account. A third alternative is to use the
Read more in the [install documentation](https://rclone.org/install/).
Note that when running rclone as another user, it will not use
the configuration file from your profile unless you tell it to
with the [`--config`](https://rclone.org/docs/#config-config-file) option.
with the [`--config`](https://rclone.org/docs/#config-string) option.
Note also that it is now the SYSTEM account that will have the owner
permissions, and other accounts will have permissions according to the
group or others scopes. As mentioned above, these will then not get the
@@ -329,10 +329,10 @@ See the [VFS File Caching](#vfs-file-caching) section for more info.
When using NFS mount on macOS, if you don't specify |--vfs-cache-mode|
the mount point will be read-only.
The bucket-based remotes (e.g. Swift, S3, Google Compute Storage, B2)
do not support the concept of empty directories, so empty
directories will have a tendency to disappear once they fall out of
the directory cache.
Bucket-based remotes - Azure Blob, Swift, S3, Google Cloud Storage and B2 -
can't store empty directories. Of these, only Azure Blob, Google Cloud Storage
and S3 can preserve them when you add `--xxx-directory_markers`; otherwise,
empty directories will vanish once they drop out of the directory cache.
When `rclone mount` is invoked on Unix with `--daemon` flag, the main rclone
program will wait for the background mount to become ready or until the timeout

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

@@ -18,13 +18,15 @@ want to delete files from destination, use the
[copy](/commands/rclone_copy/) command instead.
**Important**: Since this can cause data loss, test first with the
`--dry-run` or the `--interactive`/`-i` flag.
`--dry-run` or the `--interactive`/`i` flag.
rclone sync --interactive SOURCE remote:DESTINATION
Note that files in the destination won't be deleted if there were any
errors at any point. Duplicate objects (files with the same name, on
those providers that support it) are also not yet handled.
Files in the destination won't be deleted if there were any errors at any
point. Duplicate objects (files with the same name, on those providers that
support it) are not yet handled. Files that are excluded won't be deleted
unless `--delete-excluded` is used. Symlinks won't be transferred or
deleted from local file systems unless `--links` is used.
It is always the contents of the directory that is synced, not the
directory itself. So when source:path is a directory, it's the contents of
@@ -54,10 +56,10 @@ See [this forum post](https://forum.rclone.org/t/sync-not-clearing-duplicates/14
# Logger Flags
The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match` and `--error` flags write paths, one per line, to the file name (or
stdout if it is `-`) supplied. What they write is described in the
help below. For example `--differ` will write all paths which are
present on both the source and destination but different.
The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match` and `--error` flags write paths,
one per line, to the file name (or stdout if it is `-`) supplied. What they write is described
in the help below. For example `--differ` will write all paths which are present
on both the source and destination but different.
The `--combined` flag will write a file (or stdout) which contains all
file paths with a symbol and then a space and then the path to tell
@@ -74,7 +76,10 @@ as [`lsf`](/commands/rclone_lsf/#synopsis) (including [customizable options
for hash, modtime, etc.](/commands/rclone_lsf/#synopsis))
Conceptually it is similar to rsync's `--itemize-changes`, but not identical
-- it should output an accurate list of what will be on the destination
after the sync.
after the command is finished.
When the `--no-traverse` flag is set, all logs involving files that exist only
on the destination will be incomplete or completely missing.
Note that these logger flags have a few limitations, and certain scenarios
are not currently supported:
@@ -85,11 +90,12 @@ are not currently supported:
- High-level retries, because there would be duplicates (use `--retries 1` to disable)
- Possibly some unusual error scenarios
Note also that each file is logged during the sync, as opposed to after, so it
Note also that each file is logged during execution, as opposed to after, so it
is most useful as a predictor of what SHOULD happen to each file
(which may or may not match what actually DID.)
```
rclone sync source:path dest:path [flags]
```

2
docs/content/docs.md
View File

@@ -437,7 +437,7 @@ Do not use single character names on Windows as it creates ambiguity with Window
drives' names, e.g.: remote called `C` is indistinguishable from `C` drive. Rclone
will always assume that single letter name refers to a drive.
## Adding global configuration to a remote
## Adding global configuration to a remote {#globalconfig}
It is possible to add global configuration to the remote configuration which
will be applied just before the remote is created.

2
docs/content/drive.md
View File

@@ -699,6 +699,8 @@ Use client credentials OAuth flow.
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
Note that this option is NOT supported by all backends.
Properties:
- Config: client_credentials

2
docs/content/dropbox.md
View File

@@ -305,6 +305,8 @@ Use client credentials OAuth flow.
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
Note that this option is NOT supported by all backends.
Properties:
- Config: client_credentials

28
docs/content/flags.md
View File

@@ -104,6 +104,7 @@ Flags for general networking and HTTP stuff.
--ca-cert stringArray CA certificate used to verify servers
--client-cert string Client SSL certificate (PEM) for mutual TLS auth
--client-key string Client SSL private key (PEM) for mutual TLS auth
--client-pass string Password for client SSL private key (PEM) for mutual TLS auth (obscured) (obscured)
--contimeout Duration Connect timeout (default 1m0s)
--disable-http-keep-alives Disable HTTP keep-alives and use each connection once
--disable-http2 Disable HTTP/2 in the global transport
@@ -112,6 +113,7 @@ Flags for general networking and HTTP stuff.
--header stringArray Set HTTP header for all transactions
--header-download stringArray Set HTTP header for download transactions
--header-upload stringArray Set HTTP header for upload transactions
--http-proxy string HTTP proxy URL
--max-connections int Maximum number of simultaneous backend API connections, 0 for unlimited
--no-check-certificate Do not verify the server SSL certificate (insecure)
--no-gzip-encoding Don't set Accept-Encoding: gzip
@@ -119,7 +121,7 @@ Flags for 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.70.0")
--user-agent string Set the user-agent to a specified string (default "rclone/v1.71.0")
```
@@ -226,6 +228,10 @@ Flags for logging and statistics.
```
--log-file string Log everything to this file
--log-file-compress If set, compress rotated log files using gzip
--log-file-max-age Duration Maximum duration to retain old log files (eg "7d") (default 0s)
--log-file-max-backups int Maximum number of old log files to retain
--log-file-max-size SizeSuffix Maximum size of the log file before it's rotated (eg "10M") (default off)
--log-format Bits Comma separated list of log format options (default date,time)
--log-level LogLevel Log level DEBUG|INFO|NOTICE|ERROR (default NOTICE)
--log-systemd Activate systemd integration for the logger
@@ -589,6 +595,7 @@ Backend-only flags (these can be set in the config file also).
--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-allow-insecure-tls-ciphers Allow insecure TLS ciphers
--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
@@ -601,6 +608,7 @@ Backend-only flags (these can be set in the config file also).
--ftp-explicit-tls Use Explicit FTPS (FTP over TLS)
--ftp-force-list-hidden Use LIST -a to force listing of hidden files and folders. This will disable the use of MLSD
--ftp-host string FTP host to connect to
--ftp-http-proxy string URL for HTTP CONNECT proxy
--ftp-idle-timeout Duration Max time before closing idle connections (default 1m0s)
--ftp-no-check-certificate Do not verify the TLS certificate of the server
--ftp-no-check-upload Don't check the upload is OK
@@ -740,6 +748,7 @@ Backend-only flags (these can be set in the config file also).
--local-case-sensitive Force the filesystem to report itself as case sensitive
--local-description string Description of the remote
--local-encoding Encoding The encoding for the backend (default Slash,Dot)
--local-hashes CommaSepList Comma separated list of supported checksum types
--local-links Translate symlinks to/from regular files with a '.rclonelink' extension for the local backend
--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
@@ -859,7 +868,8 @@ Backend-only flags (these can be set in the config file also).
--pikpak-pass string Pikpak password (obscured)
--pikpak-root-folder-id string ID of the root folder
--pikpak-trashed-only Only show files that are in the trash
--pikpak-upload-concurrency int Concurrency for multipart uploads (default 5)
--pikpak-upload-concurrency int Concurrency for multipart uploads (default 4)
--pikpak-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi)
--pikpak-use-trash Send files to the trash instead of deleting permanently (default true)
--pikpak-user string Pikpak username
--pikpak-user-agent string HTTP user agent for pikpak (default "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:129.0) Gecko/20100101 Firefox/129.0")
@@ -963,6 +973,7 @@ Backend-only flags (these can be set in the config file also).
--s3-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint
--s3-use-accept-encoding-gzip Accept-Encoding: gzip Whether to send Accept-Encoding: gzip header (default unset)
--s3-use-already-exists Tristate Set if rclone should report BucketAlreadyExists errors on bucket creation (default unset)
--s3-use-arn-region If true, enables arn region support for the service
--s3-use-dual-stack If true use AWS S3 dual-stack endpoint (IPv6 support)
--s3-use-multipart-etag Tristate Whether to use ETag in multipart uploads for verification (default unset)
--s3-use-multipart-uploads Tristate Set if rclone should use multipart uploads (default unset)
@@ -976,22 +987,25 @@ Backend-only flags (these can be set in the config file also).
--seafile-2fa Two-factor authentication ('true' if the account has 2FA enabled)
--seafile-create-library Should rclone create a library if it doesn't exist
--seafile-description string Description of the remote
--seafile-encoding Encoding The encoding for the backend (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8)
--seafile-encoding Encoding The encoding for the backend (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8,Dot)
--seafile-library string Name of the library
--seafile-library-key string Library password (for encrypted libraries only) (obscured)
--seafile-pass string Password (obscured)
--seafile-url string URL of seafile host to connect to
--seafile-user string User name (usually email address)
--sftp-ask-password Allow asking for SFTP password when needed
--sftp-blake3sum-command string The command used to read BLAKE3 hashes
--sftp-chunk-size SizeSuffix Upload and download chunk size (default 32Ki)
--sftp-ciphers SpaceSepList Space separated list of ciphers to be used for session encryption, ordered by preference
--sftp-concurrency int The maximum number of outstanding requests for one file (default 64)
--sftp-connections int Maximum number of SFTP simultaneous connections, 0 for unlimited
--sftp-copy-is-hardlink Set to enable server side copies using hardlinks
--sftp-crc32sum-command string The command used to read CRC-32 hashes
--sftp-description string Description of the remote
--sftp-disable-concurrent-reads If set don't use concurrent reads
--sftp-disable-concurrent-writes If set don't use concurrent writes
--sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available
--sftp-hashes CommaSepList Comma separated list of supported checksum types
--sftp-host string SSH host to connect to
--sftp-host-key-algorithms SpaceSepList Space separated list of host key algorithms, ordered by preference
--sftp-http-proxy string URL for HTTP CONNECT proxy
@@ -1003,7 +1017,7 @@ Backend-only flags (these can be set in the config file also).
--sftp-key-use-agent When set forces the usage of the ssh-agent
--sftp-known-hosts-file string Optional path to known_hosts file
--sftp-macs SpaceSepList Space separated list of MACs (message authentication code) algorithms, ordered by preference
--sftp-md5sum-command string The command used to read md5 hashes
--sftp-md5sum-command string The command used to read MD5 hashes
--sftp-pass string SSH password, leave blank to use ssh-agent (obscured)
--sftp-path-override string Override path used by SSH shell commands
--sftp-port int SSH port number (default 22)
@@ -1012,7 +1026,8 @@ Backend-only flags (these can be set in the config file also).
--sftp-server-command string Specifies the path or command to run a sftp server on the remote host
--sftp-set-env SpaceSepList Environment variables to pass to sftp and commands
--sftp-set-modtime Set the modified time on the remote if set (default true)
--sftp-sha1sum-command string The command used to read sha1 hashes
--sftp-sha1sum-command string The command used to read SHA-1 hashes
--sftp-sha256sum-command string The command used to read SHA-256 hashes
--sftp-shell-type string The type of SSH shell on remote server, if any
--sftp-skip-links Set to skip any symlinks and any other non regular files
--sftp-socks-proxy string Socks 5 proxy host
@@ -1021,6 +1036,8 @@ Backend-only flags (these can be set in the config file also).
--sftp-use-fstat If set use fstat instead of stat
--sftp-use-insecure-cipher Enable the use of insecure ciphers and key exchange methods
--sftp-user string SSH username (default "$USER")
--sftp-xxh128sum-command string The command used to read XXH128 hashes
--sftp-xxh3sum-command string The command used to read XXH3 hashes
--sharefile-auth-url string Auth server URL
--sharefile-chunk-size SizeSuffix Upload chunk size (default 64Mi)
--sharefile-client-credentials Use client credentials OAuth flow
@@ -1046,6 +1063,7 @@ Backend-only flags (these can be set in the config file also).
--smb-hide-special-share Hide special shares (e.g. print$) which users aren't supposed to access (default true)
--smb-host string SMB server hostname to connect to
--smb-idle-timeout Duration Max time before closing idle connections (default 1m0s)
--smb-kerberos-ccache string Path to the Kerberos credential cache (krb5cc)
--smb-pass string SMB password (obscured)
--smb-port int SMB port number (default 445)
--smb-spn string Service principal name

30
docs/content/ftp.md
View File

@@ -419,6 +419,22 @@ Properties:
- Type: bool
- Default: false
#### --ftp-allow-insecure-tls-ciphers
Allow insecure TLS ciphers
Setting this flag will allow the usage of the following TLS ciphers in addition to the secure defaults:
- TLS_RSA_WITH_AES_128_GCM_SHA256
Properties:
- Config: allow_insecure_tls_ciphers
- Env Var: RCLONE_FTP_ALLOW_INSECURE_TLS_CIPHERS
- Type: bool
- Default: false
#### --ftp-shut-timeout
Maximum time to wait for data connection closing status.
@@ -462,6 +478,20 @@ Properties:
- Type: string
- Required: false
#### --ftp-http-proxy
URL for HTTP CONNECT proxy
Set this to a URL for an HTTP proxy which supports the HTTP CONNECT verb.
Properties:
- Config: http_proxy
- Env Var: RCLONE_FTP_HTTP_PROXY
- Type: string
- Required: false
#### --ftp-no-check-upload
Don't check the upload is OK

2
docs/content/googlecloudstorage.md
View File

@@ -679,6 +679,8 @@ Use client credentials OAuth flow.
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
Note that this option is NOT supported by all backends.
Properties:
- Config: client_credentials

2
docs/content/googlephotos.md
View File

@@ -324,6 +324,8 @@ Use client credentials OAuth flow.
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
Note that this option is NOT supported by all backends.
Properties:
- Config: client_credentials

2
docs/content/hidrive.md
View File

@@ -288,6 +288,8 @@ Use client credentials OAuth flow.
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
Note that this option is NOT supported by all backends.
Properties:
- Config: client_credentials

2
docs/content/jottacloud.md
View File

@@ -383,6 +383,8 @@ Use client credentials OAuth flow.
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
Note that this option is NOT supported by all backends.
Properties:
- Config: client_credentials

11
docs/content/local.md
View File

@@ -630,6 +630,17 @@ Properties:
- "ctime"
- The last status change time.
#### --local-hashes
Comma separated list of supported checksum types.
Properties:
- Config: hashes
- Env Var: RCLONE_LOCAL_HASHES
- Type: CommaSepList
- Default:
#### --local-encoding
The encoding for the backend.

2
docs/content/mailru.md
View File

@@ -300,6 +300,8 @@ Use client credentials OAuth flow.
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
Note that this option is NOT supported by all backends.
Properties:
- Config: client_credentials

2
docs/content/onedrive.md
View File

@@ -386,6 +386,8 @@ Use client credentials OAuth flow.
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
Note that this option is NOT supported by all backends.
Properties:
- Config: client_credentials

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

@@ -720,6 +720,23 @@ Properties:
- Type: string
- Required: false
### Metadata
User metadata is stored as opc-meta- keys.
Here are the possible system metadata items for the oracleobjectstorage backend.
| Name | Help | Type | Example | Read Only |
|------|------|------|---------|-----------|
| opc-meta-atime | Time of last access | ISO 8601 | 2025-06-30T22:27:43-04:00 | N |
| opc-meta-btime | Time of file birth (creation) | ISO 8601 | 2025-06-30T22:27:43-04:00 | N |
| opc-meta-gid | Group ID of owner | decimal number | 500 | N |
| opc-meta-mode | File type and mode | octal, unix style | 0100664 | N |
| opc-meta-mtime | Time of last modification | ISO 8601 | 2025-06-30T22:27:43-04:00 | N |
| opc-meta-uid | User ID of owner | decimal number | 500 | N |
See the [metadata](/docs/#metadata) docs for more info.
## Backend commands
Here are the commands specific to the oracleobjectstorage backend.

2
docs/content/pcloud.md
View File

@@ -230,6 +230,8 @@ Use client credentials OAuth flow.
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
Note that this option is NOT supported by all backends.
Properties:
- Config: client_credentials

16
docs/content/pikpak.md
View File

@@ -201,6 +201,20 @@ Properties:
- Type: SizeSuffix
- Default: 10Mi
#### --pikpak-upload-cutoff
Cutoff for switching to chunked upload.
Any files larger than this will be uploaded in chunks of chunk_size.
The minimum is 0 and the maximum is 5 GiB.
Properties:
- Config: upload_cutoff
- Env Var: RCLONE_PIKPAK_UPLOAD_CUTOFF
- Type: SizeSuffix
- Default: 200Mi
#### --pikpak-chunk-size
Chunk size for multipart uploads.
@@ -247,7 +261,7 @@ Properties:
- Config: upload_concurrency
- Env Var: RCLONE_PIKPAK_UPLOAD_CONCURRENCY
- Type: int
- Default: 5
- Default: 4
#### --pikpak-encoding

2
docs/content/premiumizeme.md
View File

@@ -195,6 +195,8 @@ Use client credentials OAuth flow.
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
Note that this option is NOT supported by all backends.
Properties:
- Config: client_credentials

2
docs/content/putio.md
View File

@@ -192,6 +192,8 @@ Use client credentials OAuth flow.
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
Note that this option is NOT supported by all backends.
Properties:
- Config: client_credentials

18
docs/content/rc.md
View File

@@ -783,6 +783,18 @@ Parameters:
**Authentication is required for this call.**
### config/unlock: Unlock the config file. {#config-unlock}
Unlocks the config file if it is locked.
Parameters:
- 'config_password' - password to unlock the config file
A good idea is to disable AskPassword before making this call
**Authentication is required for this call.**
### config/update: update the config for a remote. {#config-update}
This takes the following parameters:
@@ -1066,6 +1078,7 @@ Returns the following values:
"size": size of the file in bytes,
"bytes": total transferred bytes for this file,
"checked": if the transfer is only checked (skipped, deleted),
"what": the purpose of the transfer (transferring, deleting, checking, importing, hashing, merging, listing, moving, renaming),
"timestamp": integer representing millisecond unix epoch,
"error": string description of the error (empty if successful),
"jobid": id of the job that this transfer belongs to
@@ -1783,7 +1796,7 @@ Parameters:
Note that these are the global options which are unaffected by use of
the _config and _filter parameters. If you wish to read the parameters
set in _config then use options/config and for _filter use options/filter.
set in _config or _filter use options/local.
This shows the internal names of the option within rclone which should
map to the external options very easily with a few exceptions.
@@ -2115,8 +2128,7 @@ This takes the following parameters
- removeEmptyDirs - remove empty directories at the final cleanup step
- filtersFile - read filtering patterns from a file
- ignoreListingChecksum - Do not use checksums for listings
- resilient - Allow future runs to retry after certain less-serious errors, instead of requiring resync.
Use at your own risk!
- resilient - Allow future runs to retry after certain less-serious errors, instead of requiring resync.
- workdir - server directory for history files (default: `~/.cache/rclone/bisync`)
- backupdir1 - --backup-dir for Path1. Must be a non-overlapping path on the same remote.
- backupdir2 - --backup-dir for Path2. Must be a non-overlapping path on the same remote.

21
docs/content/s3.md
View File

@@ -795,7 +795,7 @@ A simple solution is to set the `--s3-upload-cutoff 0` and force all the files t
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/s3/s3.go then run make backenddocs" >}}
### Standard options
Here are the Standard options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, Exaba, FlashBlade, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Mega, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others).
Here are the Standard options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, Exaba, FlashBlade, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu, Zata and others).
#### --s3-provider
@@ -856,6 +856,8 @@ Properties:
- Netease Object Storage (NOS)
- "Outscale"
- OUTSCALE Object Storage (OOS)
- "OVHcloud"
- OVHcloud Object Storage
- "Petabox"
- Petabox Object Storage
- "RackCorp"
@@ -880,6 +882,8 @@ Properties:
- Wasabi Object Storage
- "Qiniu"
- Qiniu Object Storage (Kodo)
- "Zata"
- Zata (S3 compatible Gateway)
- "Other"
- Any other S3 compatible provider
@@ -1257,7 +1261,7 @@ Properties:
### Advanced options
Here are the Advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, Exaba, FlashBlade, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Mega, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others).
Here are the Advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, Exaba, FlashBlade, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu, Zata and others).
#### --s3-bucket-acl
@@ -1615,6 +1619,17 @@ Properties:
- Type: bool
- Default: false
#### --s3-use-arn-region
If true, enables arn region support for the service.
Properties:
- Config: use_arn_region
- Env Var: RCLONE_S3_USE_ARN_REGION
- Type: bool
- Default: false
#### --s3-leave-parts-on-error
If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery.
@@ -1913,7 +1928,7 @@ The parameter should be a date, "2006-01-02", datetime "2006-01-02
Note that when using this no file write operations are permitted,
so you can't upload files or delete them.
See [the time option docs](/docs/#time-option) for valid formats.
See [the time option docs](/docs/#time-options) for valid formats.
Properties:

2
docs/content/seafile.md
View File

@@ -387,7 +387,7 @@ Properties:
- Config: encoding
- Env Var: RCLONE_SEAFILE_ENCODING
- Type: Encoding
- Default: Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8
- Default: Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8,Dot
#### --seafile-description

80
docs/content/sftp.md
View File

@@ -725,9 +725,20 @@ Properties:
- "cmd"
- Windows Command Prompt
#### --sftp-hashes
Comma separated list of supported checksum types.
Properties:
- Config: hashes
- Env Var: RCLONE_SFTP_HASHES
- Type: CommaSepList
- Default:
#### --sftp-md5sum-command
The command used to read md5 hashes.
The command used to read MD5 hashes.
Leave blank for autodetect.
@@ -740,7 +751,7 @@ Properties:
#### --sftp-sha1sum-command
The command used to read sha1 hashes.
The command used to read SHA-1 hashes.
Leave blank for autodetect.
@@ -751,6 +762,71 @@ Properties:
- Type: string
- Required: false
#### --sftp-crc32sum-command
The command used to read CRC-32 hashes.
Leave blank for autodetect.
Properties:
- Config: crc32sum_command
- Env Var: RCLONE_SFTP_CRC32SUM_COMMAND
- Type: string
- Required: false
#### --sftp-sha256sum-command
The command used to read SHA-256 hashes.
Leave blank for autodetect.
Properties:
- Config: sha256sum_command
- Env Var: RCLONE_SFTP_SHA256SUM_COMMAND
- Type: string
- Required: false
#### --sftp-blake3sum-command
The command used to read BLAKE3 hashes.
Leave blank for autodetect.
Properties:
- Config: blake3sum_command
- Env Var: RCLONE_SFTP_BLAKE3SUM_COMMAND
- Type: string
- Required: false
#### --sftp-xxh3sum-command
The command used to read XXH3 hashes.
Leave blank for autodetect.
Properties:
- Config: xxh3sum_command
- Env Var: RCLONE_SFTP_XXH3SUM_COMMAND
- Type: string
- Required: false
#### --sftp-xxh128sum-command
The command used to read XXH128 hashes.
Leave blank for autodetect.
Properties:
- Config: xxh128sum_command
- Env Var: RCLONE_SFTP_XXH128SUM_COMMAND
- Type: string
- Required: false
#### --sftp-skip-links
Set to skip any symlinks and any other non regular files.

2
docs/content/sharefile.md
View File

@@ -252,6 +252,8 @@ Use client credentials OAuth flow.
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
Note that this option is NOT supported by all backends.
Properties:
- Config: client_credentials

21
docs/content/smb.md
View File

@@ -252,6 +252,27 @@ Properties:
- Type: bool
- Default: true
#### --smb-kerberos-ccache
Path to the Kerberos credential cache (krb5cc).
Overrides the default KRB5CCNAME environment variable and allows this
instance of the SMB backend to use a different Kerberos cache file.
This is useful when mounting multiple SMB with different credentials
or running in multi-user environments.
Supported formats:
- FILE:/path/to/ccache – Use the specified file.
- DIR:/path/to/ccachedir – Use the primary file inside the specified directory.
- /path/to/ccache – Interpreted as a file path.
Properties:
- Config: kerberos_ccache
- Env Var: RCLONE_SMB_KERBEROS_CCACHE
- Type: string
- Required: false
#### --smb-encoding
The encoding for the backend.

2
docs/content/yandex.md
View File

@@ -192,6 +192,8 @@ Use client credentials OAuth flow.
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
Note that this option is NOT supported by all backends.
Properties:
- Config: client_credentials

2
docs/content/zoho.md
View File

@@ -230,6 +230,8 @@ Use client credentials OAuth flow.
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
Note that this option is NOT supported by all backends.
Properties:
- Config: client_credentials

20885
rclone.1 generated
View File

File diff suppressed because it is too large Load Diff