community
/
rclone
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: document how the configuration file is written, and that an .old file will be deleted

This commit is contained in:
albertony 2022-08-28 17:55:55 +02:00 committed by Nick Craig-Wood
parent 7dbf1ab66f
commit 19f9fca2f6
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/content/docs.md
View File

@ -947,6 +947,20 @@ You may also choose to [encrypt](#configuration-encryption) the file.
When token-based authentication are used, the configuration file
must be writable, because rclone needs to update the tokens inside it.
To reduce risk of corrupting an existing configuration file, rclone
will not write directly to it when saving changes. Instead it will
first write to a new, temporary, file. If a configuration file already
existed, it will (on Unix systems) try to mirror its permissions to
the new file. Then it will rename the existing file by adding suffix
".old" to its name (e.g. `rclone.conf.old`), if a file with the same
name already exists it will simply be replaced. Next, rclone will rename
the new file to the correct name, before finally cleaning up by deleting
the original file now which has now ".old" suffix to its name. Note that
one side-effect of this is that if you happen to have a file in the same
directory and with the same name as your configuration file, but with
suffix ".old", then rclone will end up deleting this file next time it
updates its configuration file!
### --contimeout=TIME ###
Set the connection timeout. This should be in go time format which