docs: Document BORG_FILES_CACHE_SUFFIX environment variable

This commit is contained in:
Luke Dashjr 2020-10-23 00:07:37 +00:00
parent dbbd3f1b63
commit 561fbb748c
1 changed files with 4 additions and 0 deletions

View File

@ -56,6 +56,10 @@ General:
BORG_REMOTE_PATH BORG_REMOTE_PATH
When set, use the given path as borg executable on the remote (defaults to "borg" if unset). When set, use the given path as borg executable on the remote (defaults to "borg" if unset).
Using ``--remote-path PATH`` commandline option overrides the environment variable. Using ``--remote-path PATH`` commandline option overrides the environment variable.
BORG_FILES_CACHE_SUFFIX
When set to a value at least one character long, instructs borg to use a specifically named
(based on the suffix) alternative files cache. This can be used to avoid loading and saving
cache entries for backup sources other than the current sources.
BORG_FILES_CACHE_TTL BORG_FILES_CACHE_TTL
When set to a numeric value, this determines the maximum "time to live" for the files cache When set to a numeric value, this determines the maximum "time to live" for the files cache
entries (default: 20). The files cache is used to quickly determine whether a file is unchanged. entries (default: 20). The files cache is used to quickly determine whether a file is unchanged.