浏览代码

Merge pull request #648 from Silvenga/update-documentation

Added example to BORG_RSH documentation.
TW 9 年之前
父节点
当前提交
648aac5b20
共有 1 个文件被更改,包括 2 次插入1 次删除
  1. 2 1
      docs/usage.rst

+ 2 - 1
docs/usage.rst

@@ -65,7 +65,8 @@ General:
     BORG_LOGGING_CONF
         When set, use the given filename as INI_-style logging configuration.
     BORG_RSH
-        When set, use this command instead of ``ssh``.
+        When set, use this command instead of ``ssh``. This can be used to specify ssh options, such as
+        a custom identity file ``ssh -i /path/to/private/key``. See ``man ssh`` for other options.
     TMPDIR
         where temporary files are stored (might need a lot of temporary space for some operations)