Fix typo in main help and update README

wilriker · Jun 13, 2019 · d51a9d5 · d51a9d5
1 parent 267d054
commit d51a9d5
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -14,18 +14,24 @@ Each command will at least expect the argument -domain which
 specifies where on the network the device is located. This can
 either be a resolvable hostname or an IPv4 address.
 
+Common options to all commands:
+        -domain <domain|IP>     Network address of device. Mandatory parameter.
+        -port <port>            Port the device is reachable on (default 80)
+        -password <password>    Connection password (default "reprap")
+        -verbose                Output more details
+        -debug                  Output details on underlying HTTP requests
+
 The commands are:
-        backup     Backup a given directory on the device
-        upload     Upload local files/directories to the device
-        mkdir      Create a new directory on the device
-        mv         Rename/move a file/directory on the device
-        rm         Remove a file/directory on the device
-        download   Download a single file from the device
-        fileinfo   Get information on a file
-        ls         Show the file tree of a given path
+        backup       Backup a given directory on the device
+        upload       Upload local files/directories to the device
+        mkdir        Create a new directory on the device
+        mv           Rename/move a file/directory on the device
+        rm           Remove a file/directory on the device
+        download     Download a single file from the device
+        fileinfo     Get information on a file
+        ls           Show the file tree of a given path
 
-Use "rfm <command> -help" for more information about a command's
-arguments.
+Use "rfm help <command>" for more information about a command.
 ```
 ## Feedback
 Please provide any feedback either here in the Issues or send a pull request or go to [the Duet3D forum](https://forum.duet3d.com/topic/10880/rfm-reprapfirmware-filemanager-duetbackup-successor).
diff --git a/commands/help.go b/commands/help.go
@@ -21,8 +21,7 @@ Common options to all commands:
         -port <port>            Port the device is reachable on (default 80)
         -password <password>    Connection password (default "reprap")
         -verbose                Output more details
-		-debug                :w
-		Output details on underlying HTTP requests
+        -debug                  Output details on underlying HTTP requests
 
 The commands are:
         backup       Backup a given directory on the device