summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAntoine Beaupré <anarcat@koumbit.org>2015-10-05 18:54:00 -0400
committerAntoine Beaupré <anarcat@koumbit.org>2015-10-05 18:54:00 -0400
commita0ef4e25ddbc36e2004a8fa6f035890b8cb17e0f (patch)
tree12d27000c82f8592e13705583b87819c3bfdb453 /docs
parent43a65933f7d3e1caa664a84a130c7bd4051bff8f (diff)
add support for arbitrary SSH commands (attic#99)
while SSH options can be specified through `~/.ssh/config`, some users may want to use a completely different SSH command for their backups, without overriding their $PATH variable. it may also be easier to do ad-hoc configuration and tests that way. plus, the POLA tells us that users expects something like this to be supported by commands that talk to ssh. it is supported by rsync, git and so on.
Diffstat (limited to 'docs')
-rw-r--r--docs/usage.rst2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/usage.rst b/docs/usage.rst
index 95b95d90d..6bd292e14 100644
--- a/docs/usage.rst
+++ b/docs/usage.rst
@@ -48,6 +48,8 @@ General:
can either leave it away or abbreviate as `::`, if a positional parameter is required.
BORG_PASSPHRASE
When set, use the value to answer the passphrase question for encrypted repositories.
+ BORG_RSH
+ When set, use this command instead of ``ssh``.
TMPDIR
where temporary files are stored (might need a lot of temporary space for some operations)