Skip to content

Commit

Permalink
README: sync the usbsdmux -h output with the actual output
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
hnez committed Dec 21, 2023
1 parent d802776 commit 326cb90
Showing 1 changed file with 18 additions and 15 deletions.
33 changes: 18 additions & 15 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------------
Expand Down

0 comments on commit 326cb90

Please sign in to comment.