From d13ddb224ac2c38c0abce0401e85d0daf1f57ffe Mon Sep 17 00:00:00 2001 From: Manu Date: Wed, 30 Jan 2019 10:01:01 +0800 Subject: [PATCH] Update BORG_PASSCOMMAND example and clarify variable expansion. Fixes #4249 --- docs/faq.rst | 2 +- docs/man/borg.1 | 3 ++- docs/usage_general.rst.inc | 3 ++- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/faq.rst b/docs/faq.rst index bd2662dbb..553e1b18f 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -329,7 +329,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. 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 diff --git a/docs/usage_general.rst.inc b/docs/usage_general.rst.inc index eff2dedda..c41fa8783 100644 --- a/docs/usage_general.rst.inc +++ b/docs/usage_general.rst.inc @@ -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