johanels/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2025-12-11 22:14:05 +01:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

docs: add option value type to header where missing

Browse Source
This commit is contained in:
albertony
2025-01-17 21:14:17 +01:00
parent 74c0b1ea3b
commit 25f7809822
6 changed files with 48 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

73
docs/content/docs.md
View File

@@ -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`.