Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
LukasBrand committed Oct 2, 2024
1 parent e4d4260 commit 4f3693b
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/_includes/options/subscribe-options.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
| Option | Long Version | Explanation | Default |
|--------|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
| `-t` | `--topic` | The MQTT topic the client will subscribe to. | |
| `-q` | `--qos` | Define the quality of service level. If only one QoS is specified it will be used for all topics.<br> You can define a specific QoS level for every topic. The corresponding QoS levels will be matched in order to the given topics. | `0` |
| `-of` | `--outputToFile` | Append the received publish messages to a file. Creates the file if it does not exist. | |
| `-b64` | `--base64` | Whether the received publish messages will be base64 encoded. | `false` |
| `-J` | `--jsonOutput` | Print the received publishes in pretty JSON format. | `false` |
| `-T` | `--showTopics` | Prepend the specific topic name to the received publish. | `false` |
| `-up` | `--userProperty` | A user property of the subscribe message. | |
| Option | Long Version | Explanation | Default |
|--------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
| `-t` | `--topic` | The MQTT topic the client will subscribe to. | |
| `-q` | `--qos` | Define the quality of service level. If only one QoS is specified it will be used for all topics.<br> You can define a specific QoS level for every topic. The corresponding QoS levels will be matched in order to the given topics. | `0` |
| | `--output-to-file` | Append the received publish messages to a file. Creates the file if it does not exist. | |
| | `--base64` | Whether the received publish messages will be base64 encoded. | `false` |
| `-J` | `--json-output` | Print the received publishes in pretty JSON format. | `false` |
| `-T` | `--show-topics` | Prepend the specific topic name to the received publish. | `false` |
| | `--user-property` | A user property of the subscribe message. | |

0 comments on commit 4f3693b

Please sign in to comment.