From 67f2aff4bafa0cdf3264ab77dcca67877f69c046 Mon Sep 17 00:00:00 2001 From: "Roger A. Light" Date: Thu, 3 Apr 2025 11:37:15 +0100 Subject: [PATCH] Improve manpage readability --- man/mosquitto_ctrl.1.xml | 95 ++++++++++++++-------- man/mosquitto_pub.1.xml | 148 ++++++++++++++++++++++------------ man/mosquitto_rr.1.xml | 148 ++++++++++++++++++++++------------ man/mosquitto_sub.1.xml | 166 +++++++++++++++++++++++++-------------- 4 files changed, 365 insertions(+), 192 deletions(-) diff --git a/man/mosquitto_ctrl.1.xml b/man/mosquitto_ctrl.1.xml index 85422741..fa7bb3e5 100644 --- a/man/mosquitto_ctrl.1.xml +++ b/man/mosquitto_ctrl.1.xml @@ -17,58 +17,89 @@ mosquitto_ctrl - connection-options | -o config-file + options | config-file module-name module-command command-options + + options: + auth-options + connection-options + mqtt-options + output-options + + tls-certificate-options + tls-psk-options + + + + auth-options: + + username + password + connection-options: + hostname socket path port-number - username - password URL + bind-address + + socks-url + + + mqtt-options: + - client-id message-QoS - protocol-version - - - - file - dir - - file - file - ciphers - version - protocol - engine - - - pem - engine - - kpass-sha1 - - - - hex-key - identity - ciphers - version - + + + output-options: + + + + + + tls-certificate-options: + + + file + dir - socks-url + + file + file + + ciphers + + version + protocol + + engine + + + pem + engine + + kpass-sha1 + + + tls-psk-options: + + hex-key + identity + ciphers + version mosquitto_ctrl diff --git a/man/mosquitto_pub.1.xml b/man/mosquitto_pub.1.xml index fc27978c..847f0559 100644 --- a/man/mosquitto_pub.1.xml +++ b/man/mosquitto_pub.1.xml @@ -17,78 +17,128 @@ mosquitto_pub + options + topic + payload-options + + + options: + + auth-options + connection-options + mqtt-options + output-options + publish-options + + tls-certificate-options + tls-psk-options + + + + auth-options: + + username + password + + + connection-options + hostname socket path port-number - username - password - message-topic URL + bind-address + + + + + socks-url + + + mqtt-options: + - command identifier value client-id client-id-prefix keepalive-time - - message-QoS - - - count - seconds - - protocol-version - session-expiry-interval - + protocol-version + + + topic + payload + qos + + + + + output-options: + + + + + + payload-options: + + file message - - topic - payload - qos - - + + + publish-options: + + message-QoS + + count + seconds + + + tls-certificate-options: + - - - - file - dir - - file - file - ciphers - version - protocol - engine - - - pem - engine - - kpass-sha1 - file - - - - - hex-key - identity - ciphers - version - + + + file + dir - socks-url + + + + file + file + + ciphers + + protocol + file + version + + engine + + + pem + engine + + kpass-sha1 + + + + tls-psk-options: + + hex-key + identity + ciphers + version mosquitto_pub diff --git a/man/mosquitto_rr.1.xml b/man/mosquitto_rr.1.xml index 3790542c..c94250b8 100644 --- a/man/mosquitto_rr.1.xml +++ b/man/mosquitto_rr.1.xml @@ -17,85 +17,131 @@ mosquitto_rr + options response-topic + message-topic + payload-options + + + options: + + auth-options + connection-options + mqtt-options + misc-options + output-options + + tls-certificate-options + tls-psk-options + + + + auth-options: + + username + password + + + connection-options + hostname socket path port-number - username - password - message-topic URL - message-topic - - file - message - - - bind-address + + + + socks-url + + + misc-options: + + message-processing-timeout + + + mqtt-options: + - command identifier value client-id client-id-prefix keepalive-time - - - message-QoS - - - protocol-version - message-processing-timeout - session-expiry-interval - socks-url - + topic payload qos - - - - - file - dir - - file - file - ciphers - version - protocol - engine - - - pem - engine - - kpass-sha1 - file - - - - - hex-key - identity - ciphers - version - - --tls-keylog file + + + output-options: + + + + + + + + + + payload-options: + + + file + message + + + + tls-certificate-options: + + + + + file + dir + + + + + file + file + + ciphers + + protocol + file + version + + engine + + + pem + engine + + kpass-sha1 + + + + tls-psk-options: + + hex-key + identity + ciphers + version + mosquitto_rr diff --git a/man/mosquitto_sub.1.xml b/man/mosquitto_sub.1.xml index 4a1f9289..679af241 100644 --- a/man/mosquitto_sub.1.xml +++ b/man/mosquitto_sub.1.xml @@ -17,92 +17,138 @@ mosquitto_sub + options + + message-topic + unsubscribe-topic + + + + options: + + auth-options + connection-options + misc-options + mqtt-options + output-options + + tls-certificate-options + tls-psk-options + + + + auth-options: + + username + password + + + connection-options: + hostname socket path port-number - username - password - - message-topic - unsubscribe-topic - URL - message-topic + bind-address - - msg-count - - command identifier value + + + + socks-url + + + misc-options: + + message-processing-timeout + + + mqtt-options: + + + command identifier value client-id client-id-prefix keepalive-time + message-QoS + + protocol-version + session-expiry-interval + + + topic + payload + qos + + + + + output-options: + + + msg-count - - message-QoS chance - - + filter-out - protocol-version - message-processing-timeout - - session-expiry-interval - socks-url - - - topic - payload - qos - - - - - - - file - dir - - file - file - version - protocol - engine - - - pem - engine - - kpass-sha1 - file - - - - - hex-key - identity - version - - + + tls-certificate-options: + + + + + file + dir + + + + + file + file + + ciphers + + protocol + file + version + + engine + + + pem + engine + + kpass-sha1 + + + + tls-psk-options: + + hex-key + identity + ciphers + version + + mosquitto_sub @@ -435,11 +481,11 @@ - - Instead of printing the messages received, print a count - of the messages received at one second intervals. Other - options related to output formatting are not valid when - this option is active. + + Instead of printing the messages received, print a count + of the messages received at one second intervals. Other + options related to output formatting are not valid when + this option is active.