summaryrefslogtreecommitdiff
path: root/doc/design/external_special_remote_protocol.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2013-12-11 13:53:21 -0400
committerGravatar Joey Hess <joey@kitenet.net>2013-12-11 13:53:21 -0400
commit9570c92f41c6a7f079d9459a73aad0ac4c2cfe22 (patch)
tree47a8a8608a3679288840998e86d71cc3c15230ae /doc/design/external_special_remote_protocol.mdwn
parent89c5193a26c148bd8bb7f63ab291ebc812e11b6a (diff)
fixfix
Diffstat (limited to 'doc/design/external_special_remote_protocol.mdwn')
-rw-r--r--doc/design/external_special_remote_protocol.mdwn8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/design/external_special_remote_protocol.mdwn b/doc/design/external_special_remote_protocol.mdwn
index 0787893c0..429a8e7e6 100644
--- a/doc/design/external_special_remote_protocol.mdwn
+++ b/doc/design/external_special_remote_protocol.mdwn
@@ -51,7 +51,7 @@ These are the messages git-annex may send to the special remote program.
* `GETCOST`
Requests the remote return a use cost. Higher costs are more expensive.
(See Config/Cost.hs for some standard costs.)
-* `TRANSFER STORE RETRIEVE Key File`
+* `TRANSFER STORE|RETRIEVE Key File`
Requests the transfer of a key. For Send, the File is the file to upload;
for Receive the File is where to store the download. Note that the File
should not influence the filename used on the remote. The filename used
@@ -69,11 +69,11 @@ These are the messages the special remote program can send.
* `VERSION Int`
Supported protocol version. Current version is 0. Must be sent first
thing at starup.
-* `TRANSFER-SUCCESS STORE\|RETRIEVE Key`
+* `TRANSFER-SUCCESS STORE|RETRIEVE Key`
Indicates the transfer completed successfully.
-* `TRANSFER-FAILURE STORE\|RETRIEVE Key ErrorMsg`
+* `TRANSFER-FAILURE STORE|RETRIEVE Key ErrorMsg`
Indicates the transfer failed.
-* `PROGRESS STORE\|RETRIEVE Key Int`
+* `PROGRESS STORE|RETRIEVE Key Int`
Indicates the current progress of the transfer. May be repeated any
number of times during the transfer process. This is highly recommended
for STORE. (It is not necessary for RETRIEVE.)