Mirrors_Framework/mosquitto
1
0
Fork 0
mirror of https://github.com/eclipse-mosquitto/mosquitto.git synced 2026-02-05 18:50:06 +08:00
Code Issues Packages Projects Releases Wiki Activity

Man page fixes and add version info to command args

Browse Source 
Closes #3468. Thanks to Tom Earp.
This commit is contained in:
Roger A. Light
2026-02-02 16:07:08 +00:00
parent 9b6265cdbc
commit 68f3b8428c
11 changed files with 620 additions and 610 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
man/common/option-config-file.xml Normal file
View File

@@ -0,0 +1,13 @@
<!DOCTYPE varlistentry [
<!ENTITY from-version21 SYSTEM "version-2.1.xml">
]>
<varlistentry>
<term><option>-o</option> <replaceable>config-file</replaceable></term>
<listitem>
&from-version21;
<para>
Load options from a config file. See the Default Config File and
Config File sections at the start of the Options section.
</para>
</listitem>
</varlistentry>

4
man/common/option-no-tls.xml
View File

@@ -1,6 +1,10 @@
<!DOCTYPE varlistentry [
<!ENTITY from-version21 SYSTEM "version-2.1.xml">
]>
<varlistentry>
<term><option>--no-tls</option></term>
<listitem>
&from-version21;
<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.

4
man/common/option-retain-handling.xml
View File

@@ -1,6 +1,10 @@
<!DOCTYPE varlistentry [
<!ENTITY from-version21 SYSTEM "version-2.1.xml">
]>
<varlistentry>
<term><option>--retain-handling</option> always | new | never</term>
<listitem>
&from-version21;
<para>
Use this option to control the retain handling option when making a
subscription. This controls under what circumstances an existing

7
man/common/option-tls-keylog.xml
View File

@@ -1,6 +1,10 @@
<!DOCTYPE varlistentry [
<!ENTITY from-version21 SYSTEM "version-2.1.xml">
]>
<varlistentry>
<term><option>--tls-keylog</option> <replaceable>file</replaceable></term>
<listitem>
&from-version21;
<para>
Log TLS connection information to <replaceable>file</replaceable>.
This option allows tools such as <command>tcpdump</command>,
@@ -11,7 +15,8 @@
<option>Transport Layer Security</option> protocol.
</para>
<para>
This option should be used for debugging only.
This option should be used for debugging only, it must not be used
in production.
</para>
</listitem>
</varlistentry>

51
man/common/options-intro.xml Normal file
View File

@@ -0,0 +1,51 @@
<para>
There are three ways to provide options to &commandname;: the
default config file, a specified config file, or options on
the command line.
</para>
<refsect2>
<title>Default Config File</title>
<para>
The default config file is located at
<option>$XDG_CONFIG_HOME/&commandname;</option> or
<option>$HOME/.config/&commandname;</option> on POSIX systems, or
<option>%USERPROFILE%\&commandname;</option> on Windows.
</para>
<para>
The contents of the config file should consist of
options, one per line in the format:
<option>-option <replaceable>value</replaceable></option>. If
options are also specified on the command line, those
options will override the same options set in the config
file. The exceptions to this are the message type options, of which
only one can be specified. Note also that currently some options
cannot be negated, e.g. <option>-S</option>. TLS encryption options
can be negated with the <option>--no-tls</option> option.
</para>
<para>
Config file lines that have a <option>#</option> as the first
character are treated as comments and not processed any further.
</para>
<para>
It is suggested that config files are primarily used for
authentication purposes. Use of a config file allows you to
authenticate without the need to show the username and password
on the command line.
</para>
</refsect2>
<refsect2>
<title>Config File</title>
&from-version21;
<para>
A config file can be specified on the command line using
<option>-o <replaceable>config-file</replaceable></option>.
If the <option>-o</option> option is used, the default config
file will not be loaded.
</para>
<para>
The format is the same as for the default config file.
</para>
</refsect2>

1
man/common/version-2.1.xml Normal file
View File

@@ -0,0 +1 @@
<para>Available from version 2.1.</para>

10
man/mosquitto.7.xml
View File

@@ -1,4 +1,7 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE refentry [
<!ENTITY from-version21 SYSTEM "common/version-2.1.xml">
]>
<?xml-stylesheet type="text/xsl" href="manpage.xsl"?>
<refentry xml:id="mosquitto" xmlns:xlink="http://www.w3.org/1999/xlink">
@@ -45,7 +48,6 @@
</para>
</refsect1>
<!--<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="common/all-man-pages.xml" />-->
<refsect1>
<title>Mosquitto Broker</title>
<para>
@@ -67,8 +69,8 @@
<para>
This can be used to interact with the broker MQTT APIs when the
broker is running. It can run in batch mode, where all arguments
are provided on the command line, or in an interactive shell
mode.
are provided on the command line, or from version 2.1 onwards,
in an interactive shell mode.
</para>
<para>
@@ -97,7 +99,7 @@
<refsect2>
<title>mosquitto_signal</title>
&from-version21;
<para>
This tool is used to send signals to the broker. On POSIX systems it
performs the same task as the <command>kill</command> command, but

25
man/mosquitto.8.xml
View File

@@ -1,4 +1,7 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE refentry [
<!ENTITY from-version21 SYSTEM "common/version-2.1.xml">
]>
<?xml-stylesheet type="text/xsl" href="manpage.xsl"?>
<refentry xml:id="mosquitto"
@@ -84,6 +87,7 @@
<term><option>-q</option></term>
<term><option>--quiet</option></term>
<listitem>
&from-version21;
<para>Disable all logging. This is equivalent to setting
<option>log_type</option> to <option>none</option> in
the configuration file. This overrides any logging
@@ -93,22 +97,21 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--tls-keylog</option> <replaceable>file</replaceable></term>
<term><option>--test-config</option></term>
<listitem>
&from-version21;
<para>
Log TLS connection information to <replaceable>file</replaceable>.
This option allows tools such as <command>tcpdump</command> and
<command>wireshark</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, it must
not be used on production servers.
Load the config file specified with <option>-c</option>,
and verify that it is valid but do not start the broker.
The broker exit code will be 0 if the config was valid,
or non-zero if no config file was specified or the
config file was invalid.
</para>
</listitem>
</varlistentry>
<xi:include href="common/option-tls-keylog.xml" />
<varlistentry>
<term><option>-v</option></term>
<term><option>--verbose</option></term>

306
man/mosquitto_pub.1.xml
View File

@@ -1,6 +1,8 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE refentry [
<!ENTITY commandname "mosquitto_pub">
<!ENTITY from-version21 SYSTEM "common/version-2.1.xml">
<!ENTITY options-intro SYSTEM "common/options-intro.xml">
]>
<?xml-stylesheet type="text/xsl" href="manpage.xsl"?>
@@ -32,6 +34,7 @@
<sbr/>
<arg>auth-options</arg>
<arg>connection-options</arg>
<arg>misc-options</arg>
<arg>mqtt-options</arg>
<arg>output-options</arg>
<arg>publish-options</arg>
@@ -65,6 +68,11 @@
<sbr/>
<arg><option>--proxy</option> <replaceable>socks-url</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>misc-options:</command>
<sbr/>
<arg><option>-o</option> <replaceable>config-file</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>mqtt-options:</command>
<sbr/>
@@ -126,171 +134,139 @@
<refsect1>
<title>Options</title>
<para>
There are three ways to provide options to mosquitto_pub: the
default config file, a specified config file, or options on
the command line.
</para>
<para>
The default config file is located at
<option>$XDG_CONFIG_HOME/mosquitto_pub</option> or
<option>$HOME/.config/mosquitto_pub</option> on POSIX systems, or
<option>%USERPROFILE%\mosquitto_pub</option> on Windows.
</para>
<para>
A config file can be specified on the command line using
<option>-o <replaceable>config-file</replaceable></option>.
If the <option>-o</option> option is used, the default config
file will not be loaded.
</para>
<para>
In both cases, the contents of the config file should consist of
options, one per line in the format:
<option>-option <replaceable>value</replaceable></option>. If
options are also specified on the command line, those
options will override the same options set in the config
file. The exceptions to this are the message type options, of which
only one can be specified. Note also that currently some options
cannot be negated, e.g. <option>-S</option>. TLS encryption options
can be negated with the <option>--no-tls</option> option.
</para>
<para>
Config file lines that have a <option>#</option> as the first
character are treated as comments and not processed any further.
</para>
<para>
It is suggested that config files are primarily used for
authentication purposes. Use of a config file allows you to
authenticate without the need to show the username and password
on the command line.
</para>
<variablelist>
<xi:include href="common/option-bind.xml" />
<xi:include href="common/option-clean-session.xml" />
<xi:include href="common/option-tls-cafile.xml" />
<xi:include href="common/option-tls-capath.xml" />
<xi:include href="common/option-tls-cert.xml" />
<xi:include href="common/option-tls-ciphers.xml" />
<xi:include href="common/option-debug.xml" />
<xi:include href="common/option-property.xml" />
<xi:include href="common/option-payload-file.xml" />
<xi:include href="common/option-help.xml" />
<xi:include href="common/option-host.xml" />
<xi:include href="common/option-clientid.xml" />
<xi:include href="common/option-clientid-prefix.xml" />
<xi:include href="common/option-tls-insecure.xml" />
<xi:include href="common/option-keepalive.xml" />
<xi:include href="common/option-tls-key.xml" />
<xi:include href="common/option-tls-keyform.xml" />
<xi:include href="common/option-url.xml" />
<varlistentry>
<term><option>-l</option></term>
<term><option>--stdin-line</option></term>
<listitem>
<para>
Send messages read from stdin, splitting separate lines into separate messages.
</para>
</listitem>
</varlistentry>
<xi:include href="common/option-payload-message.xml" />
<xi:include href="common/option-payload-null.xml" />
<xi:include href="common/option-nodelay.xml" />
<xi:include href="common/option-no-tls.xml" />
<xi:include href="common/option-port.xml" />
<xi:include href="common/option-password.xml" />
<xi:include href="common/option-proxy.xml" />
<xi:include href="common/option-tls-psk.xml" />
<xi:include href="common/option-tls-psk-identity.xml" />
<varlistentry>
<term><option>-q</option></term>
<term><option>--qos</option></term>
<listitem>
<para>
Specify the quality of service to use for the message,
from 0, 1 and 2. Defaults to 0.
</para>
</listitem>
</varlistentry>
<xi:include href="common/option-quiet.xml" />
<varlistentry>
<term><option>-r</option></term>
<term><option>--retain</option></term>
<listitem>
<para>
If retain is given, the message will be retained as a
"last known good" value on the broker. See
<citerefentry><refentrytitle><link xlink:href="mqtt-7.html">mqtt</link></refentrytitle><manvolnum>7</manvolnum></citerefentry>
for more information. Note that zero length payloads
are never retained. If you send a zero length
payload retained message it will clear any retained
message on the topic.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--repeat</option></term>
<listitem>
<para>
If the publish mode is<option>-m</option>,
<option>-f</option>, or <option>-s</option> (i.e. the modes
where only a single message is sent), then
<option>--repeat</option> can be used to specify that the
message will be published multiple times.
</para>
<para>
See also <option>--repeat-delay</option>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--repeat-delay</option></term>
<listitem>
<para>
If using <option>--repeat</option>, then the default
behaviour is to publish repeated messages as soon as the
previous message is delivered. Use
<option>--repeat-delay</option> to specify the number of
seconds to wait after the previous message was delivered
before publishing the next. Does not need to be an integer
number of seconds.
</para>
<para>
Note that there is no guarantee as to the actual interval
between messages, this option simply defines the minimum
time from delivery of one message to the start of the
publish of the next.
</para>
</listitem>
</varlistentry>
<xi:include href="common/option-payload-stdin-file.xml" />
<xi:include href="common/option-srv.xml" />
<varlistentry>
<term><option>-t</option></term>
<term><option>--topic</option></term>
<listitem>
<para>
The MQTT topic on which to publish the message. See
<citerefentry><refentrytitle><link xlink:href="mqtt-7.html">mqtt</link></refentrytitle><manvolnum>7</manvolnum></citerefentry>
for more information on MQTT topics.
</para>
</listitem>
</varlistentry>
<xi:include href="common/option-tls-alpn.xml" />
<xi:include href="common/option-tls-engine.xml" />
<xi:include href="common/option-tls-engine-kpass-sha1.xml" />
<xi:include href="common/option-tls-keylog.xml" />
<xi:include href="common/option-tls-use-os-certs.xml" />
<xi:include href="common/option-tls-version.xml" />
<xi:include href="common/option-username.xml" />
<xi:include href="common/option-unix-socket.xml" />
<xi:include href="common/option-protocol-version.xml" />
<xi:include href="common/option-will-payload.xml" />
<xi:include href="common/option-will-qos.xml" />
<xi:include href="common/option-will-retain.xml" />
<xi:include href="common/option-will-topic.xml" />
<xi:include href="common/option-websockets.xml" />
<xi:include href="common/option-session-expiry-interval.xml" />
</variablelist>
&options-intro;
<refsect2>
<title>The options</title>
<variablelist>
<xi:include href="common/option-bind.xml" />
<xi:include href="common/option-clean-session.xml" />
<xi:include href="common/option-tls-cafile.xml" />
<xi:include href="common/option-tls-capath.xml" />
<xi:include href="common/option-tls-cert.xml" />
<xi:include href="common/option-tls-ciphers.xml" />
<xi:include href="common/option-debug.xml" />
<xi:include href="common/option-property.xml" />
<xi:include href="common/option-payload-file.xml" />
<xi:include href="common/option-help.xml" />
<xi:include href="common/option-host.xml" />
<xi:include href="common/option-clientid.xml" />
<xi:include href="common/option-clientid-prefix.xml" />
<xi:include href="common/option-tls-insecure.xml" />
<xi:include href="common/option-keepalive.xml" />
<xi:include href="common/option-tls-key.xml" />
<xi:include href="common/option-tls-keyform.xml" />
<xi:include href="common/option-url.xml" />
<varlistentry>
<term><option>-l</option></term>
<term><option>--stdin-line</option></term>
<listitem>
<para>
Send messages read from stdin, splitting separate lines into separate messages.
</para>
</listitem>
</varlistentry>
<xi:include href="common/option-payload-message.xml" />
<xi:include href="common/option-payload-null.xml" />
<xi:include href="common/option-nodelay.xml" />
<xi:include href="common/option-no-tls.xml" />
<xi:include href="common/option-config-file.xml" />
<xi:include href="common/option-port.xml" />
<xi:include href="common/option-password.xml" />
<xi:include href="common/option-proxy.xml" />
<xi:include href="common/option-tls-psk.xml" />
<xi:include href="common/option-tls-psk-identity.xml" />
<varlistentry>
<term><option>-q</option></term>
<term><option>--qos</option></term>
<listitem>
<para>
Specify the quality of service to use for the message,
from 0, 1 and 2. Defaults to 0.
</para>
</listitem>
</varlistentry>
<xi:include href="common/option-quiet.xml" />
<varlistentry>
<term><option>-r</option></term>
<term><option>--retain</option></term>
<listitem>
<para>
If retain is given, the message will be retained as a
"last known good" value on the broker. See
<citerefentry><refentrytitle><link xlink:href="mqtt-7.html">mqtt</link></refentrytitle><manvolnum>7</manvolnum></citerefentry>
for more information. Note that zero length payloads
are never retained. If you send a zero length
payload retained message it will clear any retained
message on the topic.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--repeat</option></term>
<listitem>
<para>
If the publish mode is<option>-m</option>,
<option>-f</option>, or <option>-s</option> (i.e. the modes
where only a single message is sent), then
<option>--repeat</option> can be used to specify that the
message will be published multiple times.
</para>
<para>
See also <option>--repeat-delay</option>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--repeat-delay</option></term>
<listitem>
<para>
If using <option>--repeat</option>, then the default
behaviour is to publish repeated messages as soon as the
previous message is delivered. Use
<option>--repeat-delay</option> to specify the number of
seconds to wait after the previous message was delivered
before publishing the next. Does not need to be an integer
number of seconds.
</para>
<para>
Note that there is no guarantee as to the actual interval
between messages, this option simply defines the minimum
time from delivery of one message to the start of the
publish of the next.
</para>
</listitem>
</varlistentry>
<xi:include href="common/option-payload-stdin-file.xml" />
<xi:include href="common/option-srv.xml" />
<varlistentry>
<term><option>-t</option></term>
<term><option>--topic</option></term>
<listitem>
<para>
The MQTT topic on which to publish the message. See
<citerefentry><refentrytitle><link xlink:href="mqtt-7.html">mqtt</link></refentrytitle><manvolnum>7</manvolnum></citerefentry>
for more information on MQTT topics.
</para>
</listitem>
</varlistentry>
<xi:include href="common/option-tls-alpn.xml" />
<xi:include href="common/option-tls-engine.xml" />
<xi:include href="common/option-tls-engine-kpass-sha1.xml" />
<xi:include href="common/option-tls-keylog.xml" />
<xi:include href="common/option-tls-use-os-certs.xml" />
<xi:include href="common/option-tls-version.xml" />
<xi:include href="common/option-username.xml" />
<xi:include href="common/option-unix-socket.xml" />
<xi:include href="common/option-protocol-version.xml" />
<xi:include href="common/option-will-payload.xml" />
<xi:include href="common/option-will-qos.xml" />
<xi:include href="common/option-will-retain.xml" />
<xi:include href="common/option-will-topic.xml" />
<xi:include href="common/option-websockets.xml" />
<xi:include href="common/option-session-expiry-interval.xml" />
</variablelist>
</refsect2>
</refsect1>
<xi:include href="common/section-wills.xml" />

237
man/mosquitto_rr.1.xml
View File

@@ -1,4 +1,9 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE refentry [
<!ENTITY commandname "mosquitto_rr">
<!ENTITY from-version21 SYSTEM "common/version-2.1.xml">
<!ENTITY options-intro SYSTEM "common/options-intro.xml">
]>
<?xml-stylesheet type="text/xsl" href="manpage.xsl"?>
<refentry xml:id="mosquitto_rr"
@@ -68,6 +73,7 @@
<command>misc-options:</command>
<sbr/>
<arg><option>--latency</option></arg>
<arg><option>-o</option> <replaceable>config-file</replaceable></arg>
<arg><option>-W</option> <replaceable>message-processing-timeout</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
@@ -138,138 +144,107 @@
<refsect1>
<title>Options</title>
<para>
There are three ways to provide options to mosquitto_rr: the
default config file, a specified config file, or options on
the command line.
</para>
<para>
The default config file is located at
<option>$XDG_CONFIG_HOME/mosquitto_rr</option> or
<option>$HOME/.config/mosquitto_rr</option> on POSIX systems, or
<option>%USERPROFILE%\mosquitto_rr</option> on Windows.
</para>
<para>
A config file can be specified on the command line using
<option>-o <replaceable>config-file</replaceable></option>.
If the <option>-o</option> option is used, the default config
file will not be loaded.
</para>
<para>
In both cases, the contents of the config file should consist of
options, one per line in the format:
<option>-option <replaceable>value</replaceable></option>. If
options are also specified on the command line, those
options will override the same options set in the config
file. The exceptions to this are the message type options, of which
only one can be specified. Note also that currently some options
cannot be negated, e.g. <option>-S</option>. TLS encryption options
can be negated with the <option>--no-tls</option> option.
</para>
<para>
Config file lines that have a <option>#</option> as the first
character are treated as comments and not processed any further.
</para>
<para>
It is suggested that config files are primarily used for
authentication purposes. Use of a config file allows you to
authenticate without the need to show the username and password
on the command line.
</para>
<variablelist>
<xi:include href="common/option-bind.xml" />
<xi:include href="common/option-clean-session.xml" />
<xi:include href="common/option-tls-cafile.xml" />
<xi:include href="common/option-tls-capath.xml" />
<xi:include href="common/option-tls-cert.xml" />
<xi:include href="common/option-tls-ciphers.xml" />
<xi:include href="common/option-debug.xml" />
<xi:include href="common/option-property.xml" />
<varlistentry>
<term><option>-e</option></term>
<listitem>
<para>
Response topic. The client will subscribe to this topic to wait for a response.
</para>
</listitem>
</varlistentry>
<xi:include href="common/option-payload-file.xml" />
<xi:include href="common/option-format.xml" />
<xi:include href="common/option-help.xml" />
<xi:include href="common/option-host.xml" />
<xi:include href="common/option-clientid.xml" />
<xi:include href="common/option-clientid-prefix.xml" />
<xi:include href="common/option-tls-insecure.xml" />
<xi:include href="common/option-keepalive.xml" />
<xi:include href="common/option-tls-key.xml" />
<xi:include href="common/option-tls-keyform.xml" />
<xi:include href="common/option-url.xml" />
<varlistentry>
<term><option>--latency</option></term>
<listitem>
<para>
If this option is specified, mosquitto_rr will print out
the latency between it starting to publish a request and
the response arriving. This number includes both the
broker and client processing times, as well as any
inherent network latency.
</para>
&options-intro;
<para>
This can be used to measure message delivery latency
very simply by specifying an identical request and
response topic.
</para>
<para>
The <option>--nodelay</option> option will be automatically
used when <option>--latency</option> is in use.
</para>
</listitem>
</varlistentry>
<xi:include href="common/option-payload-message.xml" />
<xi:include href="common/option-format-no-eol.xml" />
<xi:include href="common/option-payload-null.xml" />
<xi:include href="common/option-nodelay.xml" />
<xi:include href="common/option-no-tls.xml" />
<xi:include href="common/option-port.xml" />
<xi:include href="common/option-password.xml" />
<xi:include href="common/option-format-pretty.xml" />
<xi:include href="common/option-proxy.xml" />
<xi:include href="common/option-tls-psk.xml" />
<xi:include href="common/option-tls-psk-identity.xml" />
<xi:include href="common/option-qos-incoming.xml" />
<xi:include href="common/option-quiet.xml" />
<xi:include href="common/option-hide-retain.xml" />
<xi:include href="common/option-retain-handling.xml" />
<xi:include href="common/option-srv.xml" />
<xi:include href="common/option-payload-stdin-file.xml" />
<varlistentry>
<term><option>-t</option></term>
<term><option>--topic</option></term>
<listitem>
<para>
The MQTT topic where the request message will be sent.
</para>
</listitem>
</varlistentry>
<xi:include href="common/option-tls-alpn.xml" />
<xi:include href="common/option-tls-engine.xml" />
<xi:include href="common/option-tls-engine-kpass-sha1.xml" />
<xi:include href="common/option-tls-keylog.xml" />
<xi:include href="common/option-tls-use-os-certs.xml" />
<xi:include href="common/option-tls-version.xml" />
<xi:include href="common/option-username.xml" />
<xi:include href="common/option-unix-socket.xml" />
<xi:include href="common/option-format-verbose.xml" />
<xi:include href="common/option-protocol-version.xml" />
<xi:include href="common/option-timeout.xml" />
<xi:include href="common/option-will-payload.xml" />
<xi:include href="common/option-will-qos.xml" />
<xi:include href="common/option-will-retain.xml" />
<xi:include href="common/option-will-topic.xml" />
<xi:include href="common/option-websockets.xml" />
<xi:include href="common/option-session-expiry-interval.xml" />
</variablelist>
<refsect2>
<title>The options</title>
<variablelist>
<xi:include href="common/option-bind.xml" />
<xi:include href="common/option-clean-session.xml" />
<xi:include href="common/option-tls-cafile.xml" />
<xi:include href="common/option-tls-capath.xml" />
<xi:include href="common/option-tls-cert.xml" />
<xi:include href="common/option-tls-ciphers.xml" />
<xi:include href="common/option-debug.xml" />
<xi:include href="common/option-property.xml" />
<varlistentry>
<term><option>-e</option></term>
<listitem>
<para>
Response topic. The client will subscribe to this topic to wait for a response.
</para>
</listitem>
</varlistentry>
<xi:include href="common/option-payload-file.xml" />
<xi:include href="common/option-format.xml" />
<xi:include href="common/option-help.xml" />
<xi:include href="common/option-host.xml" />
<xi:include href="common/option-clientid.xml" />
<xi:include href="common/option-clientid-prefix.xml" />
<xi:include href="common/option-tls-insecure.xml" />
<xi:include href="common/option-keepalive.xml" />
<xi:include href="common/option-tls-key.xml" />
<xi:include href="common/option-tls-keyform.xml" />
<xi:include href="common/option-url.xml" />
<varlistentry>
<term><option>--latency</option></term>
<listitem>
&from-version21;
<para>
If this option is specified, mosquitto_rr will print out
the latency between it starting to publish a request and
the response arriving. This number includes both the
broker and client processing times, as well as any
inherent network latency.
</para>
<para>
This can be used to measure message delivery latency
very simply by specifying an identical request and
response topic.
</para>
<para>
The <option>--nodelay</option> option will be automatically
used when <option>--latency</option> is in use.
</para>
</listitem>
</varlistentry>
<xi:include href="common/option-payload-message.xml" />
<xi:include href="common/option-format-no-eol.xml" />
<xi:include href="common/option-payload-null.xml" />
<xi:include href="common/option-nodelay.xml" />
<xi:include href="common/option-no-tls.xml" />
<xi:include href="common/option-config-file.xml" />
<xi:include href="common/option-port.xml" />
<xi:include href="common/option-password.xml" />
<xi:include href="common/option-format-pretty.xml" />
<xi:include href="common/option-proxy.xml" />
<xi:include href="common/option-tls-psk.xml" />
<xi:include href="common/option-tls-psk-identity.xml" />
<xi:include href="common/option-qos-incoming.xml" />
<xi:include href="common/option-quiet.xml" />
<xi:include href="common/option-hide-retain.xml" />
<xi:include href="common/option-retain-handling.xml" />
<xi:include href="common/option-srv.xml" />
<xi:include href="common/option-payload-stdin-file.xml" />
<varlistentry>
<term><option>-t</option></term>
<term><option>--topic</option></term>
<listitem>
<para>
The MQTT topic where the request message will be sent.
</para>
</listitem>
</varlistentry>
<xi:include href="common/option-tls-alpn.xml" />
<xi:include href="common/option-tls-engine.xml" />
<xi:include href="common/option-tls-engine-kpass-sha1.xml" />
<xi:include href="common/option-tls-keylog.xml" />
<xi:include href="common/option-tls-use-os-certs.xml" />
<xi:include href="common/option-tls-version.xml" />
<xi:include href="common/option-username.xml" />
<xi:include href="common/option-unix-socket.xml" />
<xi:include href="common/option-format-verbose.xml" />
<xi:include href="common/option-protocol-version.xml" />
<xi:include href="common/option-timeout.xml" />
<xi:include href="common/option-will-payload.xml" />
<xi:include href="common/option-will-qos.xml" />
<xi:include href="common/option-will-retain.xml" />
<xi:include href="common/option-will-topic.xml" />
<xi:include href="common/option-websockets.xml" />
<xi:include href="common/option-session-expiry-interval.xml" />
</variablelist>
</refsect2>
</refsect1>
<xi:include href="common/section-output-format.xml" />

572
man/mosquitto_sub.1.xml
View File

File diff suppressed because it is too large Load Diff