jgaunt/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2026-01-10 12:33:46 +00:00
Code Issues Projects Releases Wiki Activity

docs: remove use of parameter type DIR

Browse Source
This commit is contained in:
albertony
2025-01-17 13:02:20 +01:00
parent 52762dc866
commit d5cc0d83b0
4 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/content/docs.md
View File

@@ -665,18 +665,18 @@ However, a suffix of `B` for Byte, `K` for KiB, `M` for MiB,
`G` for GiB, `T` for TiB and `P` for PiB may be used. These are
the binary units, e.g. 1, 2\*\*10, 2\*\*20, 2\*\*30 respectively.
### --backup-dir=DIR
### --backup-dir
When using `sync`, `copy` or `move` any files which would have been
overwritten or deleted are moved in their original hierarchy into this
directory.
If `--suffix` is set, then the moved files will have the suffix added
to them. If there is a file with the same path (after the suffix has
been added) in DIR, then it will be overwritten.
to them. If there is a file with the same path (after the suffix has
been added) in the directory, then it will be overwritten.
The remote in use must support server-side move or copy and you must
use the same remote as the destination of the sync. The backup
use the same remote as the destination of the sync. The backup
directory must not overlap the destination directory without it being
excluded by a filter rule.
@@ -835,7 +835,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=DIR
### --cache-dir
Specify the directory rclone will use for caching, to override
the default.
@@ -844,7 +844,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-dir).
- Fallback (on all OS) to `$TMPDIR/rclone`, where `TMPDIR` is the value from [--temp-dir](#temp-dir).
You can use the [config paths](/commands/rclone_config_paths/)
command to see the current value.
@@ -924,14 +924,14 @@ Specify when colors (and other ANSI codes) should be added to the output.
`ALWAYS` always add ANSI codes, regardless of the output format (terminal or file)
### --compare-dest=DIR
### --compare-dest
When using `sync`, `copy` or `move` DIR is checked in addition to the
destination for files. If a file identical to the source is found that
file is NOT copied from source. This is useful to copy just files that
have changed since the last backup.
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
that file is NOT copied from source. This is useful to copy just files
that have changed since the last backup.
You must use the same remote as the destination of the sync. The
You must use the same remote as the destination of the sync. The
compare directory must not overlap the destination directory.
See `--copy-dest` and `--backup-dir`.
@@ -1055,12 +1055,12 @@ 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=DIR
### --copy-dest
When using `sync`, `copy` or `move` DIR is checked in addition to the
destination for files. If a file identical to the source is found that
file is server-side copied from DIR to the destination. This is useful
for incremental backup.
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,
that file is server-side copied from the directory to the destination.
This is useful for incremental backup.
The remote in use must support server-side copy and you must
use the same remote as the destination of the sync. The compare
@@ -2381,7 +2381,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=DIR
### --temp-dir
Specify the directory rclone will use for temporary files, to override
the default. Make sure the directory exists and have accessible permissions.