PAHO_CS_SUB_STATIC(1L)

πŸ“¦
version 1.3.16 Β· 2 versions
, in debian trixie, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ PAHO_CS_SUB_STATIC(1L) ✨

okay bestie, sit down, hydrate, because we're talking about paho_cs_sub_static β€” that's section 1L of the manual, local commands, iykyk πŸ’…. This is the little program that receives (subscribes to) data from an MQTT server, and honestly? iconic. Let's get into it 🫢


🌸 NAME 🌸

paho_cs_sub_static β€” receive (subscribe to) data from an MQTT server πŸ’–


πŸŽ€ SYNOPSIS πŸŽ€

paho_cs_sub_static [topic] [-t|--topic topic] [-c|--connection
connection] [-h|--host hostname] [-p|--port portnumber] [-i|--clientid
clientid] [-u|--username username] [-P|--password password]
[-k|--keepalive keepalive-timeout] [-V|--MQTT-version 31|311|5]
[-q|--qos 0|1|2] [-R|--no-retained] [--delimiter delimiter] [--no-
delimiter]
[--quiet] [--verbose] [--trace min|max|error|protocol]
[--will-topic will-topic] [--will-payload will-payload] [--will-retain]
[--will-qos 0|1|2]
[--cafile cafile] [--capath capath] [--cert certfile] [--key keyfile]
[--keypass password] [--ciphers cipher-string] [--insecure]

πŸ¦‹ DESCRIPTION πŸ¦‹

paho_cs_sub_static receives data from an MQTT server using the Eclipse Paho C client synchronous library (MQTTClient). no cap, that's the whole thing.

MQTT is a protocol β€” running over TCP/IP β€” that lets programs talk to each other so easily through a server. Messages get published to topics, and then delivered to literally anyone subscribed to those topics. The matching publisher program, paho_cs_pub, is the one that sends the MQTT messages. So they're a duo. main character + their bestie energy πŸ’…

The default mode of operation is to output each message to stdout, terminated by the delimiter. simple. clean. slay ✨


πŸ’– OPTIONS πŸ’–

  • -t, --topic β€” The MQTT topic to publish the data to.
  • -c, --connection β€” The MQTT URI to connect to, a combination of transport prefix, host, port and, for websockets, topic. To connect using TCP, use the tcp prefix, for example: tcp://localhost:1883. An example using SSL/TLS: ssl://localhost:1883. An example for websockets, insecure: ws://localhost:1883/topic, and secure: wss://localhost:80/topic.
  • -h, --host β€” The TCP/IP host name of the MQTT server to connect to. Along with the --port option, an older alternative to using --connection.
  • -p, --port β€” The TCP/IP port number of the MQTT server to connect to. Along with the --host option, an older alternative to using --connection.
  • -q, --qos β€” The MQTT QoS on which to publish the message. The alternatives are 0, 1 or 2.
  • -V, --MQTTversion β€” The version of the MQTT protocol to use. Valid options are 31 (or mqttv31), 311 (mqttv311) and 5 (or mqttv5).
  • --quiet β€” Do not print error messages. (shhh 🀫)
  • --trace β€” Print library internal trace. Valid levels are min, max, error and protocol.
  • -R, --no-retained β€” Do not print messages which have the MQTT retained flag set.
  • --delimiter β€” The delimiter string to append to each message when printing. Defaults to newline.
  • --no-delimiter β€” Do not add a delimiter to each message when printing.
  • --will-topic β€” Sets the MQTT will message topic to publish to. If the application ends without sending an MQTT disconnect, the will message will be published to this topic.
  • --will-payload β€” Only used if will-topic is set. Sets the MQTT will message to be published.
  • --will-qos β€” Only used if will-topic is set. Sets the MQTT QoS at which the will message is published. The alternatives are 0, 1 or 2.
  • --will-retain β€” Only used if will-topic is set. Sets the MQTT retained flag on the will message.
  • --cafile β€” Only used with a TLS connection. The name of a file for the OpenSSL trust store.
  • --capath β€” Only used with a TLS connection. The name of a directory holding OpenSSL trusted certificates.
  • --cert β€” Only used with a TLS connection. The name of a file for the TLS keystore containing a client certificate to be presented.
  • --key β€” Only used with a TLS connection. The name of a file containing the client private key.
  • --keypass β€” Only used with a TLS connection. The password for the client private key file, if needed.
  • --ciphers β€” Only used with a TLS connection. A list of cipher suites that the client will present to the server during the TLS handshake.
  • --insecure β€” Only used with a TLS connection. Don't check that the server certificate common name matches the hostname.
bestie, just a heads up: --insecure means it does not check that the server certificate common name matches the hostname. that's the whole point of the flag, and that's the whole risk of the flag. know what you're doing πŸ’€

🌈 SEE ALSO 🌈

paho_c_pub(1) paho_c_pub_static(1) paho_c_sub(1) paho_c_sub_static(1) paho_cs_pub(1) paho_cs_pub_static(1) paho_cs_sub(1)


and that's the page, periodt πŸ’… go read the sibling pages, they're all in the same friend group fr fr.

http://eclipse.org/paho β€” 31 December 2020 β€” (v1.3.8) β€” PAHO_CS_SUB_STATIC(1L) πŸŽ€ bye bestie, happy subscribing πŸ¦‹πŸ’–