diff --git a/cmd/mountlib/mount.md b/cmd/mountlib/mount.md index 1b73feb9d..2143751a0 100644 --- a/cmd/mountlib/mount.md +++ b/cmd/mountlib/mount.md @@ -240,7 +240,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) 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 diff --git a/docs/content/bisync.md b/docs/content/bisync.md index f295e8bcd..e36988c37 100644 --- a/docs/content/bisync.md +++ b/docs/content/bisync.md @@ -635,7 +635,7 @@ directory separators.) To address this particular issue, an additional `2006-01-02 0304PM`. Note that `--conflict-suffix` is entirely separate from rclone's main -[`--sufix`](/docs/#suffix) flag. This is intentional, as users may wish +[`--sufix`](/docs/#suffix-string) flag. This is intentional, as users may wish to use both flags simultaneously, if also using [`--backup-dir`](#backup-dir1-and-backup-dir2). @@ -810,7 +810,7 @@ without requiring the user to get involved and run a `--resync`. (See also: ### --backup-dir1 and --backup-dir2 -As of `v1.66`, [`--backup-dir`](/docs/#backup-dir) is supported in bisync. +As of `v1.66`, [`--backup-dir`](/docs/#backup-dir-string) is supported in bisync. Because `--backup-dir` must be a non-overlapping path on the same remote, Bisync has introduced new `--backup-dir1` and `--backup-dir2` flags to support separate backup-dirs for `Path1` and `Path2` (bisyncing between different @@ -841,7 +841,7 @@ In the event of a [rename due to a sync conflict](#conflict-loser), the rename is not considered a delete, unless a previous conflict with the same name already exists and would get overwritten. -See also: [`--suffix`](/docs/#suffix), +See also: [`--suffix`](/docs/#suffix-string), [`--suffix-keep-extension`](/docs/#suffix-keep-extension) ## Operation diff --git a/docs/content/changelog.md b/docs/content/changelog.md index 50fb273bc..8cdddbd6a 100644 --- a/docs/content/changelog.md +++ b/docs/content/changelog.md @@ -758,7 +758,7 @@ description: "Rclone Changelog" * Final listings are now generated from sync results, to avoid needing to re-list (nielash) * Bisync is now much more resilient to changes that happen during a bisync run, and far less prone to critical errors / undetected changes (nielash) * Bisync is now capable of rolling a file listing back in cases of uncertainty, essentially marking the file as needing to be rechecked next time. (nielash) - * A few basic terminal colors are now supported, controllable with [`--color`](/docs/#color) (`AUTO`|`NEVER`|`ALWAYS`) (nielash) + * A few basic terminal colors are now supported, controllable with [`--color`](/docs/#color-autoneveralways) (`AUTO`|`NEVER`|`ALWAYS`) (nielash) * Initial listing snapshots of Path1 and Path2 are now generated concurrently, using the same "march" infrastructure as `check` and `sync`, for performance improvements and less risk of error. (nielash) * `--resync` is now much more efficient (especially for users of `--create-empty-src-dirs`) (nielash) * Google Docs (and other files of unknown size) are now supported (with the same options as in `sync`) (nielash) diff --git a/docs/content/docs.md b/docs/content/docs.md index 5f6985dbe..d5c4c2f49 100644 --- a/docs/content/docs.md +++ b/docs/content/docs.md @@ -17,7 +17,7 @@ Configure First, you'll need to configure rclone. As the object storage systems have quite complicated authentication these are kept in a config file. -(See the [`--config`](#config) entry for how to find the config +(See the [`--config`](#config-string) entry for how to find the config file and choose its location.) The easiest way to make the config is to run rclone with the config @@ -690,7 +690,7 @@ See also [--human-readable](#human-readable). Main options ------------ -### --backup-dir +### --backup-dir string When using `sync`, `copy` or `move` any files which would have been overwritten or deleted are moved in their original hierarchy into this @@ -860,7 +860,7 @@ Set to `0` to disable the buffering for the minimum memory usage. Note that the memory allocation of the buffers is influenced by the [--use-mmap](#use-mmap) flag. -### --cache-dir +### --cache-dir string Specify the directory rclone will use for caching, to override the default. @@ -869,7 +869,7 @@ Default value is depending on operating system: - Windows `%LocalAppData%\rclone`, if `LocalAppData` is defined. - macOS `$HOME/Library/Caches/rclone` if `HOME` is defined. - Unix `$XDG_CACHE_HOME/rclone` if `XDG_CACHE_HOME` is defined, else `$HOME/.cache/rclone` if `HOME` is defined. -- Fallback (on all OS) to `$TMPDIR/rclone`, where `TMPDIR` is the value from [--temp-dir](#temp-dir). +- Fallback (on all OS) to `$TMPDIR/rclone`, where `TMPDIR` is the value from [--temp-dir](#temp-dir-string). You can use the [config paths](/commands/rclone_config_paths/) command to see the current value. @@ -939,7 +939,7 @@ quicker than without the `--checksum` flag. When using this flag, rclone won't update mtimes of remote files if they are incorrect as it would normally. -### --color +### --color AUTO|NEVER|ALWAYS Specify when colors (and other ANSI codes) should be added to the output. @@ -961,7 +961,7 @@ compare directory must not overlap the destination directory. See `--copy-dest` and `--backup-dir`. -### --config +### --config string Specify the location of the rclone configuration file, to override the default. E.g. `rclone config --config="rclone.conf"`. @@ -1080,7 +1080,7 @@ The connection timeout is the amount of time rclone will wait for a connection to go through to a remote object storage system. It is `1m` by default. -### --copy-dest +### --copy-dest stringArray When using `sync`, `copy` or `move`, check a given directory in addition to the destination for files. If a file identical to the source is found, @@ -1093,11 +1093,12 @@ directory must not overlap the destination directory. See `--compare-dest` and `--backup-dir`. -### --dedupe-mode +### --dedupe-mode interactive|skip|first|newest|oldest|largest|smallest|rename|list Mode to run dedupe command in. One of `interactive`, `skip`, `first`, -`newest`, `oldest`, `rename`. The default is `interactive`. -See the dedupe command for more information as to what these options mean. +`newest`, `oldest`, `largest`, `smallest`, `rename` `list`. The default +is `interactive`. See the [dedupe](/commands/rclone_dedupe/) command +for more information as to what these options mean. ### --default-time Time @@ -1111,7 +1112,7 @@ For example `--default-time 2020-06-01` to set the default time to the 1st of June 2020 or `--default-time 0s` to set the default time to the time rclone started up. -### --disable +### --disable string This disables a comma separated list of optional features. For example to disable server-side move and server-side copy use: @@ -1152,7 +1153,7 @@ This stops rclone from trying to use HTTP/2 if available. This can sometimes speed up transfers due to a [problem in the Go standard library](https://github.com/golang/go/issues/37373). -### --dscp +### --dscp string Specify a DSCP value or name to use in connections. This could help QoS system to identify traffic class. BE, EF, DF, LE, CSx and AFxx are allowed. @@ -1240,7 +1241,7 @@ This controls how often rclone checks for cached remotes to expire. See the `--fs-cache-expire-duration` documentation above for more info. The default is 60s, set to 0 to disable expiry. -### --header +### --header stringArray Add an HTTP header for all transactions. The flag can be repeated to add multiple headers. @@ -1256,7 +1257,7 @@ as a workaround for those with care. rclone ls remote:test --header "X-Rclone: Foo" --header "X-LetMeIn: Yes" ``` -### --header-download +### --header-download stringArray Add an HTTP header for all download transactions. The flag can be repeated to add multiple headers. @@ -1268,7 +1269,7 @@ rclone sync --interactive s3:test/src ~/dst --header-download "X-Amz-Meta-Test: See the GitHub issue [here](https://github.com/rclone/rclone/issues/59) for currently supported backends. -### --header-upload +### --header-upload stringArray Add an HTTP header for all upload transactions. The flag can be repeated to add multiple headers. @@ -1500,7 +1501,7 @@ will only work well for the bucket based backends (eg s3, b2, azureblob, swift) but these are the only backends likely to have millions of entries in a directory. -### --log-file +### --log-file string Log all of rclone's output to a file. This is not active by default. This can be useful for tracking down problems with syncs in @@ -1513,7 +1514,7 @@ Note that if you are using the `logrotate` program to manage rclone's logs, then you should use the `copytruncate` option as rclone doesn't have a signal to rotate logs. -### --log-format +### --log-format string Comma separated list of log format options. The accepted options are: @@ -1531,7 +1532,7 @@ They are added to the log line in the order above. The default log format is `"date,time"`. -### --log-level +### --log-level LogLevel This sets the log level for rclone. The default log level is `NOTICE`. @@ -1547,7 +1548,9 @@ warnings and significant events. `ERROR` is equivalent to `-q`. It only outputs error messages. -### --windows-event-log LEVEL +See also the [logging](#logging) section. + +### --windows-event-log LogLevel If this is configured (the default is `OFF`) then logs of this level and above will be logged to the Windows event log in **addition** to @@ -1771,7 +1774,7 @@ Use `--cutoff-mode` to modify this behaviour. Rclone will exit with exit code 8 if the transfer limit is reached. -### --cutoff-mode +### --cutoff-mode HARD|SOFT|CAUTIOUS Set to value `hard`, `soft` or `cautious` to configure the behavior of `--max-transfer` and `--max-duration`. @@ -2145,7 +2148,7 @@ If you want perfect ordering then you will need to specify [--check-first](#check-first) which will find all the files which need transferring first before transferring any. -### --partial-suffix {#partial-suffix} +### --partial-suffix string {#partial-suffix} When [--inplace](#inplace) is not used, it causes rclone to use the `--partial-suffix` as suffix for temporary files. @@ -2308,19 +2311,19 @@ info on log levels. Note that on macOS you can send a SIGINFO (which is normally ctrl-T in the terminal) to make the stats print immediately. -### --stats-file-name-length +### --stats-file-name-length int By default, the `--stats` output will truncate file names and paths longer than 40 characters. This is equivalent to providing `--stats-file-name-length 40`. Use `--stats-file-name-length 0` to disable any truncation of file names printed by stats. -### --stats-log-level +### --stats-log-level LogLevel Log level to show `--stats` output at. This can be `DEBUG`, `INFO`, `NOTICE`, or `ERROR`. The default is `INFO`. This means at the -default level of logging which is `NOTICE` the stats won't show - if -you want them to then use `--stats-log-level NOTICE`. See the [Logging -section](#logging) for more info on log levels. +default level of logging, which is `NOTICE`, the stats won't show - if +you want them to then use `--stats-log-level NOTICE`. See the +[logging](#logging) section for more details on log levels. ### --stats-one-line @@ -2332,14 +2335,14 @@ showing the most important stats only. When this is specified, rclone enables the single-line stats and prepends the display with a date string. The default is `2006/01/02 15:04:05 - ` -### --stats-one-line-date-format +### --stats-one-line-date-format string When this is specified, rclone enables the single-line stats and prepends the display with a user-supplied date string. The date string MUST be enclosed in quotes. Follow [golang specs](https://golang.org/pkg/time/#Time.Format) for date formatting syntax. -### --stats-unit +### --stats-unit string By default, data transfer rates will be printed in bytes per second, corresponding to `--stats-unit bytes`. @@ -2351,7 +2354,7 @@ reported in bytes. The rate is reported as a binary unit, not SI unit. So 1 Mbit/s equals 1,048,576 bit/s and not 1,000,000 bit/s. -### --suffix +### --suffix string When using `sync`, `copy` or `move` any files which would have been overwritten or deleted will have the suffix added to them. If there @@ -2405,7 +2408,7 @@ If using `--syslog` this sets the syslog facility (e.g. `KERN`, `USER`). See `man syslog` for a list of possible facilities. The default facility is `DAEMON`. -### --temp-dir +### --temp-dir string Specify the directory rclone will use for temporary files, to override the default. Make sure the directory exists and have accessible permissions. @@ -2500,7 +2503,7 @@ Note also that `--track-renames` is incompatible with `--delete-before` and will select `--delete-after` instead of `--delete-during`. -### --track-renames-strategy +### --track-renames-strategy string This option changes the file matching criteria for `--track-renames`. @@ -2580,7 +2583,7 @@ may be a huge advantage. Rclone is not able to take all relevant parameters into account for deciding the best strategy, and therefore allows you to influence the choice in two ways: You can stop rclone from using `ListR` by disabling the feature, using the -[--disable](#disable) option (`--disable ListR`), or you can +[--disable](#disable-string) option (`--disable ListR`), or you can allow rclone to use `ListR` where it would normally choose not to do so due to higher memory usage, using the `--fast-list` option. Rclone should always produce identical results either way. Using `--disable ListR` or `--fast-list` @@ -2847,7 +2850,7 @@ a valid password, and `--password-command` has not been supplied. Whenever running commands that may be affected by options in a configuration file, rclone will look for an existing file according -to the rules described [above](#config), and load any it +to the rules described [above](#config-string), and load any it finds. If an encrypted file is found, this includes decrypting it, with the possible consequence of a password prompt. When executing a command line that you know are not actually using anything from such @@ -2927,11 +2930,11 @@ are also some more remote specific options which aren't documented here which are used for testing. These start with remote name e.g. `--drive-test-option` - see the docs for the remote in question. -### --cpuprofile +### --cpuprofile string Write CPU profile to a file. This can be analysed with `go tool pprof`. -### --memprofile +### --memprofile string Write memory profile to a file. This can be analysed with `go tool pprof`. diff --git a/docs/content/install.md b/docs/content/install.md index 4555b134f..0c9532638 100644 --- a/docs/content/install.md +++ b/docs/content/install.md @@ -491,9 +491,9 @@ the locations that rclone will use. To override them set the corresponding options (as command-line arguments, or as [environment variables](https://rclone.org/docs/#environment-variables)): - - [--config](https://rclone.org/docs/#config) - - [--cache-dir](https://rclone.org/docs/#cache-dir) - - [--temp-dir](https://rclone.org/docs/#temp-dir) + - [--config](https://rclone.org/docs/#config-string) + - [--cache-dir](https://rclone.org/docs/#cache-dir-string) + - [--temp-dir](https://rclone.org/docs/#temp-dir-string) ## Autostart @@ -546,7 +546,7 @@ NOTE: Remember that when rclone runs as the `SYSTEM` user, the user profile that it sees will not be yours. This means that if you normally run rclone with configuration file in the default location, to be able to use the same configuration when running as the system user you must explicitly tell rclone where to find -it with the [`--config`](https://rclone.org/docs/#config) option, +it with the [`--config`](https://rclone.org/docs/#config-string) option, or else it will look in the system users profile path (`C:\Windows\System32\config\systemprofile`). To test your command manually from a Command Prompt, you can run it with the [PsExec](https://docs.microsoft.com/en-us/sysinternals/downloads/psexec) diff --git a/docs/content/jottacloud.md b/docs/content/jottacloud.md index c23feff48..3d3acac2e 100644 --- a/docs/content/jottacloud.md +++ b/docs/content/jottacloud.md @@ -257,7 +257,7 @@ flag. Note that Jottacloud requires the MD5 hash before upload so if the source does not have an MD5 checksum then the file will be cached temporarily on disk (in location given by -[--temp-dir](/docs/#temp-dir)) before it is uploaded. +[--temp-dir](/docs/#temp-dir-string)) before it is uploaded. Small files will be cached in memory - see the [--jottacloud-md5-memory-limit](#jottacloud-md5-memory-limit) flag. When uploading from local disk the source checksum is always available,