aboutsummaryrefslogtreecommitdiff
path: root/doc/git-annex-shell.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2012-09-21 16:23:25 -0400
committerGravatar Joey Hess <joey@kitenet.net>2012-09-21 16:23:25 -0400
commit77af38ec6ce38160f88b2bf1aa60d1abb9870769 (patch)
tree6661d5f9a64727778250bb27351c6766857ea78f /doc/git-annex-shell.mdwn
parent34ca1d698cf890016f8674fba7ef83b093103b83 (diff)
git-annex-shell transferinfo command
TODO: Use this when running sendkey, to feed back transfer info from the client side rsync.
Diffstat (limited to 'doc/git-annex-shell.mdwn')
-rw-r--r--doc/git-annex-shell.mdwn9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/git-annex-shell.mdwn b/doc/git-annex-shell.mdwn
index 20a9d3d37..8256da0e3 100644
--- a/doc/git-annex-shell.mdwn
+++ b/doc/git-annex-shell.mdwn
@@ -46,6 +46,15 @@ first "/~/" or "/~user/" is expanded to the specified home directory.
This runs rsync in server mode to transfer out the content of a key.
+* transferinfo directory key uuid [file]
+
+ This is typically run at the same time as sendkey is sending a key
+ to the remote with the specified uuid.
+
+ It reads lines from standard input, each giving the number of bytes
+ that have been received so far. This is optional, but is used to update
+ progress information for the transfer of the key.
+
* commit directory
This commits any staged changes to the git-annex branch.