From 326cb9054354b438f9d9e2f8753ef5dd4e1dbaaf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Leonard=20G=C3=B6hrs?= Date: Thu, 21 Dec 2023 09:20:51 +0100 Subject: [PATCH] README: sync the usbsdmux -h output with the actual output MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit A README that does not match the behaviour of the program can be quite confusing. Sync the usbsdmux -h output with the actual output. Signed-off-by: Leonard Göhrs --- README.rst | 33 ++++++++++++++++++--------------- 1 file changed, 18 insertions(+), 15 deletions(-) diff --git a/README.rst b/README.rst index f691f44..e6521d2 100644 --- a/README.rst +++ b/README.rst @@ -65,21 +65,24 @@ command invocations: .. code-block:: text - $ usbsdmux -h - usage: usbsdmux [-h] SG {get,dut,client,host,off} - - positional arguments: - SG /dev/sg* to use - {get,dut,client,host,off} - Action: - get - return selected mode - dut - set to dut mode - client - set to dut mode (alias for dut) - host - set to host mode - off - set to off mode - - optional arguments: - -h, --help show this help message and exit + $ usbsdmux -h + usage: usbsdmux [-h] [--json] SG {get,dut,client,host,off,gpio,info} ... + + positional arguments: + SG /dev/sg* to use + {get,dut,client,host,off,gpio,info} + Supply one of the following commands to interact with the device + get Read the current state of the USB-SD-Mux + dut Switch to the DUT + client Switch to the DUT + host Switch to the host + off Disconnect from host and DUT + gpio Manipulate a GPIO (open drain output only) + info Show information about the SD card + + options: + -h, --help show this help message and exit + --json Format output as json. Useful for scripting. Using as root -------------