summaryrefslogtreecommitdiff
path: root/doc/special_remotes/rsync.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2012-05-02 13:08:31 -0400
committerGravatar Joey Hess <joey@kitenet.net>2012-05-02 13:08:33 -0400
commit6d61067599142af3eb520527589b0adfbf45867d (patch)
tree5c0ec323e6598e8a11e33ba0591dc1b9f0eb38eb /doc/special_remotes/rsync.mdwn
parent17fd57bd818931532eda1892f23e0998ad0110d5 (diff)
rsync shellescape disable option
Rsync special remotes can be configured with shellescape=no to avoid shell quoting that is normally done when using rsync over ssh. This is known to be needed for certian rsync hosting providers (specificially hidrive.strato.com) that use rsync over ssh but do not pass it through the shell.
Diffstat (limited to 'doc/special_remotes/rsync.mdwn')
-rw-r--r--doc/special_remotes/rsync.mdwn8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/special_remotes/rsync.mdwn b/doc/special_remotes/rsync.mdwn
index 90d544a1e..286615460 100644
--- a/doc/special_remotes/rsync.mdwn
+++ b/doc/special_remotes/rsync.mdwn
@@ -24,5 +24,13 @@ 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.
+* `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
+ filenames to the shell. You'll know you need this option if `git annex get`
+ from the special remote fails with an error message containing a single
+ quote (`'`) character. If that happens, you can re-run initremote
+ setting shellescape=no.
+
The `annex-rsync-options` git configuration setting can be used to pass
parameters to rsync.