Merge pull request #4295 from m3nu/maint/4249/clarify-passphrase-shell-behavior

Update BORG_PASSCOMMAND example and clarify variable expansion.
This commit is contained in:
TW 2019-02-01 01:05:34 +01:00 committed by GitHub
commit 988543df1d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 5 additions and 3 deletions

View File

@ -323,7 +323,7 @@ Using ``BORG_PASSCOMMAND`` with a properly permissioned file
Then in an automated script one can put::
export BORG_PASSCOMMAND="cat ~/.borg-passphrase"
export BORG_PASSCOMMAND="cat $HOME/.borg-passphrase"
and Borg will automatically use that passphrase.

View File

@ -393,7 +393,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

View File

@ -171,7 +171,8 @@ General:
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 ``$HOME`` will work, but ``~`` won't.
If BORG_PASSPHRASE is also set, it takes precedence.
See also BORG_NEW_PASSPHRASE.
BORG_PASSPHRASE_FD