mirror of
https://github.com/eclipse-mosquitto/mosquitto.git
synced 2026-09-24 00:54:01 +08:00
Huge man page refactor and tidy
This commit is contained in:
Roger A. Light
@@ -0,0 +1,10 @@
|
||||
<varlistentry>
|
||||
<term><option>-A</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Bind the outgoing connection to a local ip address/hostname. Use
|
||||
this argument if you need to restrict network communication to a
|
||||
particular interface.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,25 @@
|
||||
<varlistentry>
|
||||
<term><option>-c</option></term>
|
||||
<term><option>--disable-clean-session</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Disable 'clean session' / enable persistent client mode. When this
|
||||
argument is used, the broker will be instructed not to clean
|
||||
existing sessions for the same client id when the client connects,
|
||||
and sessions will never expire when the client disconnects. MQTT v5
|
||||
clients can change their session expiry interval with the
|
||||
<option>-x</option> argument.
|
||||
</para>
|
||||
<para>
|
||||
When a session is persisted on the broker, the subscriptions for the
|
||||
client will be maintained after it disconnects, along with
|
||||
subsequent QoS 1 and QoS 2 messages that arrive. When the client
|
||||
reconnects and does not clean the session, it will receive all of
|
||||
the queued messages.
|
||||
</para>
|
||||
<para>
|
||||
If using this option, the client id must be set manually with
|
||||
<option>--id</option>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,12 @@
|
||||
<varlistentry>
|
||||
<term><option>-I</option></term>
|
||||
<term><option>--id-prefix</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Provide a prefix that the client id will be built from by appending
|
||||
the process id of the client. This is useful where the broker is
|
||||
using the clientid_prefixes option. Cannot be used at the same time
|
||||
as the <option>--id</option> argument.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,15 @@
|
||||
<varlistentry>
|
||||
<term><option>-i</option></term>
|
||||
<term><option>--id</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The id to use for this client. If not given, a client id will be
|
||||
generated depending on the MQTT version being used. For v3.1.1/v3.1,
|
||||
the client generates a client id in the format
|
||||
<option>mosq-XXXXXXXXXXXXXXXXXX</option>, where the <option>X</option>
|
||||
are replaced with random alphanumeric characters. For v5.0, the client
|
||||
sends a zero length client id, and the server will generate a client
|
||||
id for the client.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,9 @@
|
||||
<varlistentry>
|
||||
<term><option>-d</option></term>
|
||||
<term><option>--debug</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Enable debug messages.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,11 @@
|
||||
<varlistentry>
|
||||
<term><option>-N</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Do not append an end of line character to the payload when printing.
|
||||
This allows streaming of payload data from multiple messages
|
||||
directly to another application unmodified. Only really makes sense
|
||||
when not using <option>-v</option>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,10 @@
|
||||
<varlistentry>
|
||||
<term><option>--pretty</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
When using the JSON output format %j or %J, the default is to print
|
||||
in an unformatted fashion. Specifying <option>--pretty</option>
|
||||
prints messages in a prettier, more human readable format.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,14 @@
|
||||
<varlistentry>
|
||||
<term><option>-v</option></term>
|
||||
<term><option>--verbose</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Print received messages verbosely. With this argument, messages will
|
||||
be printed as "topic payload". When this argument is not given, the
|
||||
messages are printed as "payload".
|
||||
</para>
|
||||
<para>
|
||||
See also <option>-F</option>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,15 @@
|
||||
<varlistentry>
|
||||
<term><option>-F</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Specify output printing format. This option allows you to choose
|
||||
what information from each message is printed to the screen. See the
|
||||
<link linkend='outputformat'>Output Format</link> section below for
|
||||
full details.
|
||||
</para>
|
||||
<para>
|
||||
This option overrides the <option>-v</option> option, but does not
|
||||
override the <option>-N</option> option.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,8 @@
|
||||
<varlistentry>
|
||||
<term><option>--help</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Display usage information.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,15 @@
|
||||
<varlistentry>
|
||||
<term><option>-R</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
If this argument is given, messages that are received that have the
|
||||
retain bit set will not be printed. Messages with retain set are
|
||||
"stale", in that it is not known when they were originally
|
||||
published. When subscribing to a wildcard topic there may be a large
|
||||
number of retained messages. This argument suppresses their display.
|
||||
</para>
|
||||
<para>
|
||||
See also <option>--retain-handling</option>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,9 @@
|
||||
<varlistentry>
|
||||
<term><option>-h</option></term>
|
||||
<term><option>--host</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Specify the host to connect to. Defaults to localhost.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,11 @@
|
||||
<varlistentry>
|
||||
<term><option>-k</option></term>
|
||||
<term><option>--keepalive</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The number of seconds between sending PING commands to the broker
|
||||
for the purposes of informing it we are still connected and
|
||||
functioning. Defaults to 60 seconds.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,10 @@
|
||||
<varlistentry>
|
||||
<term><option>--no-tls</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Disable all use of TLS encryption. This is useful if you specify TLS
|
||||
options in a configuration file but want to disable those options.
|
||||
It also stops the automatic use of TLS when connecting to port 8883.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,11 @@
|
||||
<varlistentry>
|
||||
<term><option>--nodelay</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Disable Nagle's algorithm for the socket. This means that latency of
|
||||
sent messages is reduced, which is particularly noticeable for
|
||||
small, reasonably infrequent messages. Using this option may result
|
||||
in more packets being sent than would normally be necessary.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,14 @@
|
||||
<varlistentry>
|
||||
<term><option>-P</option></term>
|
||||
<term><option>--pw</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Provide a password to be used for authenticating with
|
||||
the broker. Using this argument without also specifying
|
||||
a username is invalid when using MQTT v3.1 or v3.1.1.
|
||||
</para>
|
||||
<para>
|
||||
See also the <option>--username</option> option.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,9 @@
|
||||
<varlistentry>
|
||||
<term><option>-f</option></term>
|
||||
<term><option>--file</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Send the contents of a file as the message.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,9 @@
|
||||
<varlistentry>
|
||||
<term><option>-m</option></term>
|
||||
<term><option>--message</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Send a single request message from the command line.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,9 @@
|
||||
<varlistentry>
|
||||
<term><option>-n</option></term>
|
||||
<term><option>--null-message</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Send a null (zero length) message.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,10 @@
|
||||
<varlistentry>
|
||||
<term><option>-s</option></term>
|
||||
<term><option>--stdin-file</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Send a request message read from stdin, sending the entire content
|
||||
as a single message.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,10 @@
|
||||
<varlistentry>
|
||||
<term><option>-p</option></term>
|
||||
<term><option>--port</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Connect to the port specified. If not given, the default of 1883 for
|
||||
plain MQTT or 8883 for MQTT over TLS will be used.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,38 @@
|
||||
<varlistentry>
|
||||
<term><option>-D</option></term>
|
||||
<term><option>--property</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Set MQTT v5 properties for with this client. If you use this option,
|
||||
the client will be set to be an MQTT v5 client. This option has two
|
||||
forms:
|
||||
</para>
|
||||
<para><option>-D command identifier value</option></para>
|
||||
<para><option>-D command identifier name value</option></para>
|
||||
<para>
|
||||
<option>command</option> is the MQTT command/packet identifier and
|
||||
can be one of CONNECT, PUBLISH, PUBACK, PUBREC, PUBCOMP, SUBSCRIBE,
|
||||
UNSUBSCRIBE, DISCONNECT, AUTH, or WILL. The properties available
|
||||
for each command are listed in the Properties section.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<option>identifier</option> is the name of the property to add.
|
||||
This is as described in the specification, but with '-' as a
|
||||
word separator. For example: <option>payload-format-indicator</option>.
|
||||
More details are in the <link linkend='properties'>Properties</link>
|
||||
section.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<option>value</option> is the value of the property to add, with a
|
||||
data type that is property specific.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<option>name</option> is only used for the <option>user-property</option>
|
||||
property as the first of the two strings in the string pair. In that
|
||||
case, <option>value</option> is the second of the strings in the pair.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,15 @@
|
||||
<varlistentry>
|
||||
<term><option>-V</option></term>
|
||||
<term><option>--protocol-version</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Specify which version of the MQTT protocol should be
|
||||
used when connecting to the remote broker. Can be
|
||||
<option>5</option>, <option>311</option>,
|
||||
<option>31</option>, or the more verbose
|
||||
<option>mqttv5</option>, <option>mqttv311</option>, or
|
||||
<option>mqttv31</option>.
|
||||
Defaults to <option>311</option>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,32 @@
|
||||
<varlistentry xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<term><option>--proxy</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Specify a SOCKS5 proxy to connect through. "None" and "username"
|
||||
authentication types are supported. The <option>socks-url</option>
|
||||
must be of the form <option>socks5h://[username[:password]@]host[:port]</option>.
|
||||
The protocol prefix <option>socks5h</option> means that hostnames
|
||||
are resolved by the proxy. The symbols %25, %3A and %40 are URL
|
||||
decoded into %, : and @ respectively, if present in the username or
|
||||
password.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
If username is not given, then no authentication is attempted.
|
||||
If the port is not given, then the default of 1080 is used.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
If the host is given as an IPv6 address, it must be enclosed in
|
||||
square brackets, e.g. <option>socks5h://[::1]:1080</option>.
|
||||
Note that square brackets have special meaning in some shells, so
|
||||
the proxy url may need quoting in double or single quotes.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
More SOCKS versions may be available in the future, depending on
|
||||
demand, and will use different protocol prefixes as described in
|
||||
<citerefentry><refentrytitle><link xlink:href="https://linux.die.net/man/1/curl">curl</link></refentrytitle><manvolnum>1</manvolnum> </citerefentry>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,16 @@
|
||||
<varlistentry xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<term><option>-q</option></term>
|
||||
<term><option>--qos</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Specify the quality of service desired for the incoming messages,
|
||||
from 0, 1 and 2. Defaults to 0. See
|
||||
<citerefentry><refentrytitle><link xlink:href="mqtt-7.html">mqtt</link></refentrytitle><manvolnum>7</manvolnum></citerefentry>
|
||||
for more information on QoS.
|
||||
</para>
|
||||
<para>
|
||||
The QoS applies to all topics subscribed to in a single instance of
|
||||
this client.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,10 @@
|
||||
<varlistentry>
|
||||
<term><option>--quiet</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
If this argument is given, no runtime errors will be printed. This
|
||||
excludes any error messages given in case of invalid user input
|
||||
(e.g. using <option>--port</option> without a port).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,17 @@
|
||||
<varlistentry>
|
||||
<term><option>-x</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Set the session-expiry-interval property on the CONNECT packet. If
|
||||
you use this option, the client will be set to be an MQTT v5 client.
|
||||
Set to 0-4294967294 to specify the session will expire in that many
|
||||
seconds after the client disconnects, or use -1, 4294967295, or ∞
|
||||
for a session that does not expire. Defaults to -1 if -c is also
|
||||
given, or 0 if -c not given.
|
||||
</para>
|
||||
<para>
|
||||
If the session is set to never expire, either with -x or -c, then a
|
||||
client id must be provided.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,11 @@
|
||||
<varlistentry>
|
||||
<term><option>-S</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Use SRV lookups to determine which host to connect to.
|
||||
Performs lookups to <option>_mqtt._tcp.<host></option>
|
||||
when used in conjunction with <option>-h</option>,
|
||||
otherwise uses <option>_mqtt._tcp.<local dns domain></option>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,11 @@
|
||||
<varlistentry>
|
||||
<term><option>-W</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Provide a timeout as an integer number of seconds. The client will
|
||||
stop processing messages and disconnect after this number of seconds
|
||||
has passed. The timeout starts just after the client has connected
|
||||
to the broker.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,10 @@
|
||||
<varlistentry>
|
||||
<term><option>--tls-alpn</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Provide a protocol to use when connecting to a broker that has
|
||||
multiple protocols available on a single port, e.g. MQTT and
|
||||
WebSockets.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,12 @@
|
||||
<varlistentry>
|
||||
<term><option>--cafile</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Define the path to a file containing PEM encoded CA certificates
|
||||
that are trusted. Used to enable SSL communication.
|
||||
</para>
|
||||
<para>
|
||||
See also <option>--capath</option>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,20 @@
|
||||
<varlistentry>
|
||||
<term><option>--capath</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Define the path to a directory containing PEM encoded CA
|
||||
certificates that are trusted. Used to enable SSL communication.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
For <option>--capath</option> to work correctly, the certificate
|
||||
files must have ".crt" as the file ending and you must run
|
||||
"openssl rehash <path to capath>" each time you add/remove
|
||||
a certificate.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
See also <option>--cafile</option>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,14 @@
|
||||
<varlistentry>
|
||||
<term><option>--cert</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Define the path to a file containing a PEM encoded certificate for
|
||||
this client, if required by the server.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
See also <option>--key</option> and the Encrypted Connections
|
||||
section.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,11 @@
|
||||
<varlistentry xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<term><option>--ciphers</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
An openssl compatible list of TLS ciphers to support in the
|
||||
client. See
|
||||
<citerefentry><refentrytitle><link xlink:href="https://linux.die.net/man/1/ciphers">ciphers</link></refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||||
for more information.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,15 @@
|
||||
<varlistentry>
|
||||
<term><option>--tls-engine-kpass-sha1</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
SHA1 of the private key password when using an TLS engine. Some TLS
|
||||
engines such as the TPM engine may require the use of a password in
|
||||
order to be accessed. This option allows a hex encoded SHA1 hash of
|
||||
the password to the engine directly, instead of the user being
|
||||
prompted for the password.
|
||||
</para>
|
||||
<para>
|
||||
See also <option>--tls-engine</option>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,12 @@
|
||||
<varlistentry>
|
||||
<term><option>--tls-engine</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
A valid openssl engine id. These can be listed with the
|
||||
<command>openssl engine</command> command.
|
||||
</para>
|
||||
<para>
|
||||
See also <option>--keyform</option>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,15 @@
|
||||
<varlistentry>
|
||||
<term><option>--insecure</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
When using certificate based encryption, this option disables
|
||||
verification of the server hostname in the server certificate. This
|
||||
can be useful when testing initial server configurations but makes
|
||||
it possible for a malicious third party to impersonate your server
|
||||
through DNS spoofing, for example. Use this option in testing
|
||||
only. If you need to resort to using this option in a production
|
||||
environment, your setup is at fault and there is no point using
|
||||
encryption.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,12 @@
|
||||
<varlistentry>
|
||||
<term><option>--key</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Define the path to a file containing a PEM encoded private key for
|
||||
this client, carrying out mutual TLS with the server.
|
||||
</para>
|
||||
<para>
|
||||
See also <option>--cert</option> and the Encrypted Connections section.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,16 @@
|
||||
<varlistentry>
|
||||
<term><option>--keyform</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Specifies the type of private key in use when making TLS
|
||||
connections.. This can be "pem" or "engine". This parameter is
|
||||
useful when a TPM module is being used and the private key has been
|
||||
created with it. Defaults to "pem", which means normal private key
|
||||
files are used.
|
||||
</para>
|
||||
<para>
|
||||
See also <option>--tls-engine</option>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
<varlistentry>
|
||||
<term><option>--tls-keylog</option> <replaceable>file</replaceable></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Log TLS connection information to <replaceable>file</replaceable>.
|
||||
This option allows tools such as <command>tcpdump</command>,
|
||||
<command>wireshark</command> and <command>mqttshark</command>
|
||||
to decrypt TLS traffic and inspect the MQTT traffic. In Wireshark
|
||||
this can be done by setting the
|
||||
<option>(Pre)-Master-Secret log filename</option> option for the
|
||||
<option>Transport Layer Security</option> protocol.
|
||||
</para>
|
||||
<para>
|
||||
This option should be used for debugging only.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,9 @@
|
||||
<varlistentry>
|
||||
<term><option>--psk-identity</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The client identity to use with TLS-PSK support. This may be used
|
||||
instead of a username if the broker is configured to do so.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,10 @@
|
||||
<varlistentry>
|
||||
<term><option>--psk</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Provide the hexadecimal (no leading 0x) pre-shared-key matching the
|
||||
one used on the broker to use TLS-PSK encryption support.
|
||||
<option>--psk-identity</option> must also be provided to enable TLS-PSK.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,14 @@
|
||||
<varlistentry>
|
||||
<term><option>--tls-use-os-certs</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
If used, this will load and trust the OS provided CA
|
||||
certificates. This can be used in conjunction with
|
||||
<option>--cafile</option> and <option>--capath</option>
|
||||
and can be used on its own to enable TLS mode. This
|
||||
will be set by default if <option>-L mqtts://...</option>
|
||||
is used, or if port is 8883 and no other certificate
|
||||
options are used.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,11 @@
|
||||
<varlistentry>
|
||||
<term><option>--tls-version</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Choose which TLS protocol version to use when communicating with the
|
||||
broker. Valid options are <option>tlsv1.3</option> and
|
||||
<option>tlsv1.2</option>. The default value is <option>tlsv1.2</option>.
|
||||
Must match the protocol version used by the broker.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,16 @@
|
||||
<varlistentry xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<term><option>--unix</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Connect to a broker through a local unix domain socket
|
||||
instead of a TCP socket. This is a replacement for
|
||||
<option>-h</option> and <option>-L</option>. For example:
|
||||
<option>mosquitto_pub --unix /tmp/mosquitto.sock ...</option>
|
||||
</para>
|
||||
<para>
|
||||
See the <option>socket_domain</option> option in
|
||||
<refentrytitle><link xlink:href="mosquitto-conf-5.html">mosquitto.conf</link></refentrytitle><manvolnum>5</manvolnum>
|
||||
to configure Mosquitto to listen on a unix socket.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,16 @@
|
||||
<varlistentry>
|
||||
<term><option>-L</option></term>
|
||||
<term><option>--url</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Specify specify user, password, hostname, port and topic at once as
|
||||
a URL. The URL must be in the form:
|
||||
mqtt(s)://[username[:password]@]host[:port]/topic or
|
||||
ws(s)://[username[:password]@]host[:port]/path
|
||||
</para>
|
||||
<para>
|
||||
Depending on the scheme, the port will default to different values.
|
||||
mqtt:// - 1883, mqtts:// - 8883, ws:// - 80, wss:// - 443.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,14 @@
|
||||
<varlistentry>
|
||||
<term><option>-u</option></term>
|
||||
<term><option>--username</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Provide a username to be used for authenticating with
|
||||
the broker.
|
||||
</para>
|
||||
<para>
|
||||
See also the <option>--pw</option> argument.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
<varlistentry>
|
||||
<term><option>--ws</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Connect using WebSockets instead of plain TCP.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,10 @@
|
||||
<varlistentry>
|
||||
<term><option>--will-payload</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Specify a message that will be stored by the broker and sent out if
|
||||
this client disconnects unexpectedly. This must be used in
|
||||
conjunction with <option>--will-topic</option>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@@ -0,0 +1,9 @@
|
||||
<varlistentry>
|
||||
<term><option>--will-qos</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The QoS to use for the Will. Defaults to 0. This must be used in
|
||||
conjunction with <option>--will-topic</option>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user