summaryrefslogtreecommitdiffstats
path: root/docs/man
diff options
context:
space:
mode:
authorManu <manu@snapdragon.cc>2019-01-30 10:01:01 +0800
committerManu <manu@snapdragon.cc>2019-01-30 10:12:47 +0800
commitd13ddb224ac2c38c0abce0401e85d0daf1f57ffe (patch)
treeb8ea20a3c6c3163f5aaf50cb6cebf8a5fb1b3c6d /docs/man
parent2bcff382cbe8d390cf526003697dfa2cf6b4cf47 (diff)
Update BORG_PASSCOMMAND example and clarify variable expansion. Fixes #4249
Diffstat (limited to 'docs/man')
-rw-r--r--docs/man/borg.13
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/man/borg.1 b/docs/man/borg.1
index 703bdc4b5..2d650b2bd 100644
--- a/docs/man/borg.1
+++ b/docs/man/borg.1
@@ -354,7 +354,8 @@ See also BORG_NEW_PASSPHRASE.
When set, use the standard output of the command (trailing newlines are stripped) to answer the
passphrase question for encrypted repositories.
It is used when a passphrase is needed to access an encrypted repo as well as when a new
-passphrase should be initially set when initializing an encrypted repo.
+passphrase should be initially set when initializing an encrypted repo. Note that the command
+is executed without a shell. So variables, like \fB$HOME\fP\ will work, but \fB~\fP\ won't.
If BORG_PASSPHRASE is also set, it takes precedence.
See also BORG_NEW_PASSPHRASE.
.TP