From d51a9d51d1957e941272afeceeea2514e9b21144 Mon Sep 17 00:00:00 2001 From: Manuel Coenen Date: Thu, 13 Jun 2019 13:34:26 +0200 Subject: [PATCH] Fix typo in main help and update README --- README.md | 26 ++++++++++++++++---------- commands/help.go | 3 +-- 2 files changed, 17 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index b9436cd..28e4dff 100644 --- 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 Network address of device. Mandatory parameter. + -port Port the device is reachable on (default 80) + -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 -help" for more information about a command's -arguments. +Use "rfm help " 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 index 83f460a..caa32ff 100644 --- a/commands/help.go +++ b/commands/help.go @@ -21,8 +21,7 @@ Common options to all commands: -port Port the device is reachable on (default 80) -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