Kaynağa Gözat

Improved text format in cli/README.md

Serdyukov, Denys 4 yıl önce
ebeveyn
işleme
564c6a4c80
1 değiştirilmiş dosya ile 10 ekleme ve 10 silme
  1. 10 10
      cli/README.md

+ 10 - 10
cli/README.md

@@ -6,14 +6,14 @@ The command line interface can be started with the following arguments:
 
 ### Choosing the CLI mode
 
-<i>no argument</i>:  <br/>
+<b><i>no argument</i></b>:  <br/>
 Regular user mode, designed for user interaction.
 
 `--machine`: <br/>
-Machine mode, not designed for user interaction. Other programs (like the GUI) can use this for communication with the CLI. For usage, please refer to the `GUI-CLI Protocol.md`.
+Machine mode, not designed for user interaction. Other programs (like the GUI) can use this for communication with the CLI. For usage, please refer to [GUI-CLI Protocol.md](../../GUI-CLI Protocol.md).
 
 `--batch <file>`: <br/>
-Batch mode. A batch file for the CLI must contain commands (as used in regular user mode) separated by line breaks. The operations can be run by passing the path to the batch file as argument `<file>`.
+Batch mode. A batch file for the CLI must contain commands (as used in regular user mode) separated by line breaks. The operations can be run by passing the path to the batch file as argument <i>&lt;file&gt;</i>.
 
 ### Additional arguments
 
@@ -26,7 +26,7 @@ Prints additional output for debugging purposes.
 
 ## Connecting to a server and logging in
 
-The user connects to a server using `connect <ip> <port>` where `<ip>` is the IP of the server and `<port>` is the port used by the server. The `<port>` parameter is optional. If no port is specified, 1234 is used.
+The user connects to a server using `connect <ip> <port>` where <i>&lt;ip&gt;</i> is the IP of the server and <i>&lt;port&gt;</i> is the port used by the server. The `<port>` parameter is optional. If no port is specified, 1234 is used.
 
 Then a user has to connect by typing `login <username> <password>`. Alternatively the user can create an account and log in with `signup <username> <password>`. If wrong user data was passed, the user is disconnected from the server and needs to connect again.
 
@@ -35,7 +35,7 @@ Then a user has to connect by typing `login <username> <password>`. Alternativel
 The following commands are used to specify key files used for encryption of all sent files and for decryption. They can be used at any time.
 
 `keyfile <filepath>`: <br/>
-Set a key file.  The path of the file has to be specified by `<filepath>`.
+Set a key file. The path of the file has to be specified by <i>&lt;filepath&gt;</i>.
 
 `closekey`: <br/>
 Stop using the previously selected keyfile.
@@ -63,14 +63,14 @@ Shows a list of notifications since the last time.
 <br/><br/>
 
 `put <filepath>`: <br/>
-Request a file upload to the server. The path of the file has to be specified by `<filepath>`.
+Request a file upload to the server. The path of the file has to be specified by <i>&lt;filepath&gt;</i>.
 
-`get <filename>`: <br/>
-Request a download of the file with name `<filename>` from the server. 
-Alternatively a path can be specified where the file is to save, e.g. `get ./subfolder/foo.txt` downloads the file `foo.txt` from the server to `./subfolder/`.
+`get <filepath>`: <br/>
+Request a download of the file with name <i>&lt;filepath&gt;</i> from the server. <br/>
+Alternatively a path can be specified where the file with corresponding name is to save, e.g. `get ./subfolder/foo.txt` downloads the file <i>foo.txt</i> from the server to the directory <i>./subfolder/</i>.
 
 `deletefile <filename>`: <br/>
-Request a deletion of the file with name `<filename>` from the server. Has to be activated in the server configuration.
+Request a deletion of the file with name <i>&lt;filename&gt;</i> from the server. Has to be activated in the server configuration.
 
 `queue <filename>`: <br/>
 To add a file that is already on the server to the queue for sending with the covert channel.