Browse Source

Add information about the status command to cli/README.md, correct GUI-CLI Protocol.

Serdyukov, Denys 4 years ago
parent
commit
9dca83fd68
2 changed files with 5 additions and 8 deletions
  1. 0 4
      GUI-CLI Protocol.md
  2. 5 4
      cli/README.md

+ 0 - 4
GUI-CLI Protocol.md

@@ -150,13 +150,11 @@ CLI:
 {
 	"command": "putdata",
 	"file": string,
-	"speed": float,
 	"cancel": bool,
 	"error": string
 }
 ```
 If `cancel` is `true` then the upload of the file is canceled and an error message should be in `error`.
-`speed` shall contain a float describing the upload speed in kB/s.
 
 
 ### 2.4 Get command
@@ -188,14 +186,12 @@ CLI:
 {
 	"command": "getdata",
 	"file": string,
-	"speed": float,
 	"cancel": bool,
 	"error": string
 }
 ```
 
 If `cancel` is `true` then the download of the file is canceled and an error message should be in `error`.
-`speed` shall contain a float describing the download speed in kB/s.
 
 ### 2.5 Deletefile command
 

+ 5 - 4
cli/README.md

@@ -40,14 +40,15 @@ Set a key file. The path of the file has to be specified by <i>&lt;filepath&gt;<
 `closekey`: <br/>
 Stop using the previously selected keyfile.
 
+## Viewing information about the connection
 
-## Interacting with the server
+`status`: <br/>
+This command shows wether the user is connected to a server, and displays the IP and port of the server in this case. If the user is logged in, also the username and information wether a file transfer between server and client is running are shown.
 
-The following commands can be sent when the user is connected to a server.
+## Interacting with the server
 
+The following commands can be sent when the user is connected to a server and logged in.
 
-`status`: <br/>
-Shows username, ip and port and wether a file transfer between server and client is running.
 
 `extendedstatus`: <br/>
 Shows detailed information about ongoing transfers at the server.