From 68a65e878f63a837e86ff9950926a396e9d0a006 Mon Sep 17 00:00:00 2001 From: albertony <12441419+albertony@users.noreply.github.com> Date: Fri, 9 May 2025 08:48:51 +0200 Subject: [PATCH] docs: add hint about config touch and config file not found --- docs/content/docs.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/content/docs.md b/docs/content/docs.md index a8f1f4082..7bbbbd1fe 100644 --- a/docs/content/docs.md +++ b/docs/content/docs.md @@ -968,8 +968,9 @@ on any OS, and the value is defined as following: - On Unix: `$HOME` if defined, else by looking up current user in OS-specific user database (e.g. passwd file), or else use the result from shell command `cd && pwd`. -If you run `rclone config file` you will see where the default -location is for you. +If you run `rclone config file` you will see where the default location is for +you. Running `rclone config touch` will ensure a configuration file exists, +creating an empty one in the default location if there is none. The fact that an existing file `rclone.conf` in the same directory as the rclone executable is always preferred, means that it is easy @@ -980,7 +981,13 @@ same directory. If the location is set to empty string `""` or path to a file with name `notfound`, or the os null device represented by value `NUL` on Windows and `/dev/null` on Unix systems, then rclone will keep the -config file in memory only. +configuration file in memory only. + +You may see a log message "Config file not found - using defaults" if there is +no configuration file. This can be supressed, e.g. if you are using rclone +entirely with [on the fly remotes](/docs/#backend-path-to-dir), by using +memory-only configuration file or by creating an empty configuration file, as +described above. The file format is basic [INI](https://en.wikipedia.org/wiki/INI_file#Format): Sections of text, led by a `[section]` header and followed by