aboutsummaryrefslogtreecommitdiff
path: root/doc/special_remotes
diff options
context:
space:
mode:
authorGravatar https://www.google.com/accounts/o8/id?id=AItOawmUJBh1lYmvfCCiGr3yrdx-QhuLCSRnU5c <Justin@web>2013-05-04 18:57:13 +0000
committerGravatar admin <admin@branchable.com>2013-05-04 18:57:13 +0000
commitc38c4df47a282e192c481b049230bd5c7a511ad1 (patch)
treeb09db1a6b17e98b647b9926395928eeecd2bcd37 /doc/special_remotes
parent732873810033fdfa922d27318ed0def83b9cf14a (diff)
Adding section explaining annex-rsync-transport
Diffstat (limited to 'doc/special_remotes')
-rw-r--r--doc/special_remotes/rsync.mdwn22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/special_remotes/rsync.mdwn b/doc/special_remotes/rsync.mdwn
index 641faf474..581ac6b96 100644
--- a/doc/special_remotes/rsync.mdwn
+++ b/doc/special_remotes/rsync.mdwn
@@ -36,3 +36,25 @@ These parameters can be passed to `git annex initremote` to configure rsync:
The `annex-rsync-options` git configuration setting can be used to pass
parameters to rsync.
+
+## annex-rsync-transport
+
+You can use the `annex-rsync-transport` git configuration setting to choose
+whether we run rsync over ssh or rsh. This setting is also used to specify
+parameters that git annex will pass to ssh/rsh.
+
+ssh is the default transport; if you'd like to run rsync over rsh, modify your
+.git/config to include
+
+ annex-rsync-transport = rsh
+
+under the appropriate remote.
+
+To pass parameters to ssh/rsh, include the parameters after "rsh" or
+"ssh". For example, to configure ssh to use the private key at
+`/path/to/private/key`, specify
+
+ annex-rsync-transport = ssh -i /path/to/private/key
+
+Note that environment variables aren't expanded here, so for example, you
+cannot specify `-i $HOME/.ssh/private_key`.