diff --git a/docs/content/docs.md b/docs/content/docs.md index dc7039073..9edcea87d 100644 --- a/docs/content/docs.md +++ b/docs/content/docs.md @@ -363,6 +363,7 @@ Will get their own names ### Valid remote names Remote names are case sensitive, and must adhere to the following rules: + - May contain number, letter, `_`, `-`, `.`, `+`, `@` and space. - May not start with `-` or space. - May not end with space. @@ -856,6 +857,7 @@ Specify the directory rclone will use for caching, to override the default. 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. @@ -1204,6 +1206,7 @@ If `--fix-case` is set, then `HELLO.txt` will be renamed to `hello.txt` to match the source. NB: + - directory names with incorrect casing will also be fixed - `--fix-case` will be ignored if `--immutable` is set - using `--local-case-sensitive` instead is not advisable; @@ -2413,6 +2416,7 @@ Specify the directory rclone will use for temporary files, to override the default. Make sure the directory exists and have accessible permissions. By default the operating system's temp directory will be used: + - On Unix systems, `$TMPDIR` if non-empty, else `/tmp`. - On Windows, the first non-empty value from `%TMP%`, `%TEMP%`, `%USERPROFILE%`, or the Windows directory. @@ -3078,6 +3082,7 @@ messages may not be valid after the retry. If rclone has done a retry it will log a high priority message if the retry was successful. ### List of exit codes + - `0` - Success - `1` - Error not otherwise categorised - `2` - Syntax or usage error diff --git a/docs/content/filtering.md b/docs/content/filtering.md index 11fc83012..f38f54909 100644 --- a/docs/content/filtering.md +++ b/docs/content/filtering.md @@ -738,6 +738,7 @@ The flag takes two parameters expressed as a fraction: - `K`: The specific partition to select (an integer from `0` to `N`). For example: + - `--hash-filter 1/3`: Selects the first third of the files. - `--hash-filter 2/3` and `--hash-filter 3/3`: Select the second and third partitions, respectively. diff --git a/docs/content/install.md b/docs/content/install.md index 4725c7c6a..b73d7e638 100644 --- a/docs/content/install.md +++ b/docs/content/install.md @@ -491,6 +491,7 @@ 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-string) - [--cache-dir](https://rclone.org/docs/#cache-dir-string) - [--temp-dir](https://rclone.org/docs/#temp-dir-string) @@ -514,6 +515,7 @@ manually from a Command Prompt first. ### Autostart on Windows The most relevant alternatives for autostart on Windows are: + - Run at user log on using the Startup folder - Run at user log on, at system startup or at schedule using Task Scheduler - Run at system startup using Windows service diff --git a/docs/content/rc.md b/docs/content/rc.md index d65cb8b15..3d1378ef5 100644 --- a/docs/content/rc.md +++ b/docs/content/rc.md @@ -2364,7 +2364,8 @@ e.g. } ``` -The keys in the error response are +The keys in the error response are: + - error - error string - input - the input parameters to the call - status - the HTTP status code