diff --git a/README.rst b/README.rst index 7a448d7..dec3170 100644 --- a/README.rst +++ b/README.rst @@ -65,7 +65,8 @@ command invocations: .. code-block:: text $ usbsdmux -h - usage: usbsdmux [-h] [--json] SG {get,dut,client,host,off,gpio,info} ... + usage: usbsdmux [-h] [--config CONFIG] [--json] + SG {get,dut,client,host,off,gpio,info} ... positional arguments: SG /dev/sg* to use @@ -81,6 +82,7 @@ command invocations: options: -h, --help show this help message and exit + --config CONFIG Set config file location --json Format output as json. Useful for scripting. Using as root @@ -161,6 +163,14 @@ Troubleshooting :alt: pypi.org :target: https://pypi.org/project/usbsdmux +MQTT Statistics +--------------- + +This tool can be configured to send certain statistics to a MQTT broker. +To enable this function create a config file at ``/etc/usbsdmux.config`` or use ``--config`` specify a file location. + +See example config file `usbsdmux.config `_. + Contributing ------------