Browse Source

Updated 'README.md'

nicolopalazzini 1 year ago
parent
commit
a429dd4a9a
1 changed files with 16 additions and 5 deletions
  1. 16 5
      README.md

+ 16 - 5
README.md

@@ -1,15 +1,26 @@
-usage: xfreerdp {status,start,stop} [options]
-
+# xfreerdpctl
 Simple tool to handle xfreerdp on LCM nodes.
 
+usage: xfreerdpctl [{status,start,stop,doctor}] [options]
+
 positional arguments:
-  {status,start,stop}  Specify command to execute, default is 'status'
+
+*   status             default. Check whether xfreerdp is running on the considered nodes
+    
+*   start              start xfreerdp on the considered nodes
+    
+*   stop               stop xfreerdp on the considered nodes
 
 optional arguments:
+
   -h, --help           show this help message and exit
+  
   -a, --all            All LCM nodes are considered
+  
   -n NODE [NODE ...]   Select one or more nodes (at least one)
+  
   -1, --lcm1           LCM1 nodes are considered
+  
   -2, --lcm2           LCM2 nodes are considered
-  -v, --version        Print program version
-
+  
+  -v, --version        Print program version