aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKlaus Goger <klaus.goger@theobroma-systems.com>2017-12-07 12:27:07 +0100
committerKlaus Goger <klaus.goger@theobroma-systems.com>2017-12-07 12:27:07 +0100
commit4a67b59ffbcf150bc48e93011b512bc736e5ec08 (patch)
treeeb45747286cbb9780dc619e621fb71d52a17a0dc
parentde43b61d63cb74b777eaa44b1e3300885c43bc6f (diff)
usb-control: update README
update the readme to reflect the argument parsing
-rw-r--r--usb-control/README.md22
1 files changed, 10 insertions, 12 deletions
diff --git a/usb-control/README.md b/usb-control/README.md
index 0d62946..deb9a0b 100644
--- a/usb-control/README.md
+++ b/usb-control/README.md
@@ -10,23 +10,21 @@ This tool allows to control the **BIOS Disable** and **Power** Button via USB.
[libusb](http://libusb.info/)
-# Usage
+# Usage
-To manipulate **BIOS Disable** via USB the slider has to be in the **Normal Boot**
-position.
+To manipulate **BIOS Disable** via USB the slider has to be in the **Normal
+Boot** position.
-The script takes following parameters:
+The script takes following commands:
- --list, -l list serial numbers of connected baseboards
+ list list serial numbers of connected baseboards
+
+ power controls the power and BIOS Disable state
--serial SERIALNUMBER, -s SERIALNUMBER
defines the serialnumber to use
- --press-power, -p press power button
--bios-disable, -b activate BIOS Disable
--normal-boot, -n activate Normal Boot
-Each Haikou base board has a unique USB ID so they can be differentiated if more then
-one is connected to the host. Provide the serialnumber on the commandline to select
-a specific board, otherwise the first one found will be used.
-
-If called without `-p`, `-b` or `-n` a GUI with buttons for **Power** and **BIOS Disable**
-starts.
+Each Haikou base board has a unique USB ID so they can be differentiated if more
+then one is connected to the host. Provide the serialnumber on the commandline
+to select a specific board, otherwise the first one found will be used.