summaryrefslogtreecommitdiff
path: root/doc/special_remotes/rsync.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2014-08-03 15:07:43 -0400
committerGravatar Joey Hess <joey@kitenet.net>2014-08-03 15:07:43 -0400
commit38880b605f2bb22a9e1547e3407676b4bd89935c (patch)
tree4d621bf26aaee95d96b74e39611abfb7a80692d9 /doc/special_remotes/rsync.mdwn
parentac843495d7060267d663eb7bcc063c7a139a6c56 (diff)
rsync: support chunking
Chunking does not speed up rsync at all, so it's only useful for interop with the directory special remote.
Diffstat (limited to 'doc/special_remotes/rsync.mdwn')
-rw-r--r--doc/special_remotes/rsync.mdwn10
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/special_remotes/rsync.mdwn b/doc/special_remotes/rsync.mdwn
index b2a9d23f5..eb218b181 100644
--- a/doc/special_remotes/rsync.mdwn
+++ b/doc/special_remotes/rsync.mdwn
@@ -14,14 +14,14 @@ Or for using rsync over SSH
These parameters can be passed to `git annex initremote` to configure rsync:
+* `rsyncurl` - Required. This is the url or `hostname:/directory` to
+ pass to rsync to tell it where to store content.
+
* `encryption` - One of "none", "hybrid", "shared", or "pubkey".
See [[encryption]].
* `keyid` - Specifies the gpg key to use for [[encryption]].
-* `rsyncurl` - Required. This is the url or `hostname:/directory` to
- pass to rsync to tell it where to store content.
-
* `shellescape` - Optional. Set to "no" to avoid shell escaping normally
done when using rsync over ssh. That escaping is needed with typical
setups, but not with some hosting providers that do not expose rsynced
@@ -30,6 +30,10 @@ These parameters can be passed to `git annex initremote` to configure rsync:
quote (`'`) character. If that happens, you can run enableremote
setting shellescape=no.
+* `chunk` - Enables [[chunking]] when storing large files.
+ This is typically not a win for rsync, so no need to enable it.
+ But, it makes this interoperate with the [[directory]] special remote.
+
The `annex-rsync-options` git configuration setting can be used to pass
parameters to rsync.