Formatting plus whitespace tidy

pull/2768/head
Roger A. Light 3 years ago
parent e85e43c633
commit 7f0cd48921

@ -17,15 +17,15 @@
<refsynopsisdiv>
<cmdsynopsis>
<command>mosquitto</command>
<arg>-c <replaceable>config file</replaceable></arg>
<arg><option>-c</option> <replaceable>config file</replaceable></arg>
<group>
<arg choice='plain'>-d</arg>
<arg choice='plain'>--daemon</arg>
<arg choice='plain'><option>-d</option></arg>
<arg choice='plain'><option>--daemon</option></arg>
</group>
<arg>-p <replaceable>port number</replaceable></arg>
<arg>-q</arg>
<arg>-v</arg>
<arg>--tls-keylog <replaceable>file</replaceable></arg>
<arg><option>-p</option> <replaceable>port number</replaceable></arg>
<arg><option>-q</option></arg>
<arg><option>-v</option></arg>
<arg><option>--tls-keylog</option> <replaceable>file</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>

@ -475,7 +475,7 @@
<term><option>global_max_clients</option> <replaceable>count</replaceable></term>
<listitem>
<para>
The maximum number of client sessions to allow across
The maximum number of client sessions to allow across
the whole broker. In this context a client session means
either a client currently connected via the network, or
a client that has clean_session = False (MQTT v3.x) and
@ -1229,10 +1229,10 @@ log_timestamp_format %Y-%m-%dT%H:%M:%S
<term><option>accept_protocol_versions</option> <replaceable>versions</replaceable></term>
<listitem>
<para>
Accepted protocol versions. This sets what versions
of the MQTT protocol will be accepted on this
listener. Can be any combination of 3, 4, 5 in a
comma separated list, e.g.
Accepted protocol versions. This sets what versions
of the MQTT protocol will be accepted on this
listener. Can be any combination of 3, 4, 5 in a
comma separated list, e.g.
</para>
<programlisting>
# Allow v5.0 only:
@ -1513,13 +1513,13 @@ accept_protocol_versions 3, 4</programlisting>
<varlistentry>
<term><option>websockets_origin</option> <replaceable>level</replaceable></term>
<listitem>
<para>
If set, this will be compared to the http origin
header when a connection attempts to upgrade to
WebSockets. Only matching origins will be allowed.
Use the exact string provided by the browser in the
origin header, e.g.
<replaceable>http://example.com:8080</replaceable>.
<para>
If set, this will be compared to the http origin
header when a connection attempts to upgrade to
WebSockets. Only matching origins will be allowed.
Use the exact string provided by the browser in the
origin header, e.g.
<replaceable>http://example.com:8080</replaceable>.
Can be specified multiple times per listener.
</para>
<para>
@ -1939,11 +1939,11 @@ openssl dhparam -out dhparam.pem 2048</programlisting>
<varlistentry>
<term><option>bridge_tcp_keepalive</option> <replaceable>idle</replaceable> <replaceable>interval</replaceable> <replaceable>counter</replaceable></term>
<listitem>
<para>
Set TCP keepalive parameters for this bridge connection.
Use this option to allow you to set a long MQTT
keepalive value, whilst still being able to detect the
connection dropping in a reasonable time.
<para>
Set TCP keepalive parameters for this bridge connection.
Use this option to allow you to set a long MQTT
keepalive value, whilst still being able to detect the
connection dropping in a reasonable time.
</para>
<para>
This may be useful when bridging to services that bill
@ -2006,7 +2006,7 @@ openssl dhparam -out dhparam.pem 2048</programlisting>
<term><option>local_cleansession</option> [ true | false]</term>
<listitem>
<para>The regular <option>cleansession</option> covers both the local subscriptions
and the remote subscriptions. local_cleansession allows splitting this.
and the remote subscriptions. local_cleansession allows splitting this.
Setting <replaceable>false</replaceable> will mean that the local connection
will preserve subscription, independent of the remote connection.
</para>

@ -557,12 +557,12 @@
<refsect1>
<title>Exit Status</title>
<para>
mosquitto_sub returns zero on success, or non-zero on error. If
the connection is refused by the broker at the MQTT level, then
the exit code is the CONNACK reason code. If another error
occurs, the exit code is a libmosquitto return value.
</para>
<para>
mosquitto_sub returns zero on success, or non-zero on error. If
the connection is refused by the broker at the MQTT level, then
the exit code is the CONNACK reason code. If another error
occurs, the exit code is a libmosquitto return value.
</para>
<para>MQTT v3.1.1 CONNACK codes:</para>
<itemizedlist mark="circle">

@ -32,7 +32,7 @@
man page for details of the options for connecting to remote brokers,
in particular since this module works with authentication and access
control, it is crucial that secure encrypted connections are used.
</para>
</para>
</refsect1>
<refsect1>

@ -129,12 +129,12 @@
<refsect1>
<title>Exit Status</title>
<para>
mosquitto_sub returns zero on success, or non-zero on error. If
the connection is refused by the broker at the MQTT level, then
the exit code is the CONNACK reason code. If another error
occurs, the exit code is a libmosquitto return value.
</para>
<para>
mosquitto_sub returns zero on success, or non-zero on error. If
the connection is refused by the broker at the MQTT level, then
the exit code is the CONNACK reason code. If another error
occurs, the exit code is a libmosquitto return value.
</para>
<para>MQTT v3.1.1 CONNACK codes:</para>
<itemizedlist mark="circle">

@ -376,7 +376,7 @@
or ws(s)://[username[:password]@]host[:port]/path
</para>
<para>
Depending on the scheme, the port will default to
Depending on the scheme, the port will default to
different values. mqtt:// - 1883, mqtts:// - 8883,
ws:// - 80, wss:// - 443.
</para>
@ -416,27 +416,27 @@
<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>
<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>
<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>
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>
<para>
See the <option>--no-tls</option> if you want to use
port 8883 without TLS.
</para>
</para>
</listitem>
</varlistentry>
<varlistentry>
@ -609,14 +609,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
<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.
is used, or if port is 8883 and no other certificate
options are used.
</para>
</listitem>
</varlistentry>
@ -800,12 +800,12 @@
<refsect1>
<title>Exit Status</title>
<para>
mosquitto_pub returns zero on success, or non-zero on error. If
the connection is refused by the broker at the MQTT level, then
the exit code is the CONNACK reason code. If another error
occurs, the exit code is a libmosquitto return value.
</para>
<para>
mosquitto_pub returns zero on success, or non-zero on error. If
the connection is refused by the broker at the MQTT level, then
the exit code is the CONNACK reason code. If another error
occurs, the exit code is a libmosquitto return value.
</para>
<para>MQTT v3.1.1 CONNACK codes:</para>
<itemizedlist mark="circle">

@ -405,7 +405,7 @@
or ws(s)://[username[:password]@]host[:port]/path
</para>
<para>
Depending on the scheme, the port will default to
Depending on the scheme, the port will default to
different values. mqtt:// - 1883, mqtts:// - 8883,
ws:// - 80, wss:// - 443.
</para>
@ -448,27 +448,27 @@
<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>
<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>
<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>
<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>
<para>
See the <option>--no-tls</option> if you want to use
port 8883 without TLS.
</para>
</para>
</listitem>
</varlistentry>
<varlistentry>
@ -484,11 +484,12 @@
<varlistentry>
<term><option>--pretty</option></term>
<listitem>
<para>
<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>
more human readable format.
</para>
</listitem>
</varlistentry>
<varlistentry>
@ -626,14 +627,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
<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.
is used, or if port is 8883 and no other certificate
options are used.
</para>
</listitem>
</varlistentry>

@ -424,7 +424,7 @@
or ws(s)://[username[:password]@]host[:port]/path
</para>
<para>
Depending on the scheme, the port will default to
Depending on the scheme, the port will default to
different values. mqtt:// - 1883, mqtts:// - 8883,
ws:// - 80, wss:// - 443.
</para>
@ -453,27 +453,27 @@
<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>
<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>
<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>
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>
<para>
See the <option>--no-tls</option> if you want to use
port 8883 without TLS.
</para>
</para>
</listitem>
</varlistentry>
<varlistentry>
@ -489,7 +489,7 @@
<varlistentry>
<term><option>--pretty</option></term>
<listitem>
<para>
<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,
@ -710,14 +710,14 @@ mosquitto_sub -t 'bbc/#' -T bbc/bbc1 --remove-retained</programlisting>
<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
<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.
is used, or if port is 8883 and no other certificate
options are used.
</para>
</listitem>
</varlistentry>
@ -827,13 +827,13 @@ mosquitto_sub -t 'bbc/#' -T bbc/bbc1 --remove-retained</programlisting>
<term><option>-w</option></term>
<term><option>--watch</option></term>
<listitem>
<para>
Messages will be printed on a fixed line number based on
the topic and order in which topics are received. Useful
for monitoring multiple topics that have single line
payloads. Unexpected behaviour will occur if there are
more topics than lines in the terminal, or if the
payload occupies more than a single line.
<para>
Messages will be printed on a fixed line number based on
the topic and order in which topics are received. Useful
for monitoring multiple topics that have single line
payloads. Unexpected behaviour will occur if there are
more topics than lines in the terminal, or if the
payload occupies more than a single line.
This can be used in conjuction with other output options
e.g. <option>-F</option>.
</para>
@ -956,13 +956,13 @@ mosquitto_sub -t 'bbc/#' -T bbc/bbc1 --remove-retained</programlisting>
<refsect2>
<title>Field width</title>
<para>
Some of the MQTT related parameters can be formatted with an
option to set their field width in a similar way to regular
printf style formats, i.e. this sets the minimum width when
printing this parameter. This applies to the options %A, %C,
%d, %E, %F, %f, %I, %l, %m, %p, %R, %S, %t, %x, %X.
</para>
<para>
Some of the MQTT related parameters can be formatted with an
option to set their field width in a similar way to regular
printf style formats, i.e. this sets the minimum width when
printing this parameter. This applies to the options %A, %C,
%d, %E, %F, %f, %I, %l, %m, %p, %R, %S, %t, %x, %X.
</para>
<para>
For example <option>%10t</option> would set the minimum topic
field width to 10 characters.
@ -971,16 +971,16 @@ mosquitto_sub -t 'bbc/#' -T bbc/bbc1 --remove-retained</programlisting>
<refsect2>
<title>Maximum width</title>
<para>
Some of the MQTT related parameters can be formatted with an
option to set a maximum field width in a similar way to regular
printf style formats. This applies to the options %C, %I, %R, %t.
</para>
<para>
Some of the MQTT related parameters can be formatted with an
option to set a maximum field width in a similar way to regular
printf style formats. This applies to the options %C, %I, %R, %t.
</para>
<para>
For example <option>%10.10t</option> would set the minimum topic
field width to 10 characters, and the maximum topic width to
10 characters, i.e. the field will always be exactly 10
characters long.
10 characters, i.e. the field will always be exactly 10
characters long.
</para>
</refsect2>
@ -1165,12 +1165,12 @@ mosquitto_sub -t 'bbc/#' -T bbc/bbc1 --remove-retained</programlisting>
<refsect1>
<title>Exit Status</title>
<para>
mosquitto_sub returns zero on success, or non-zero on error. If
the connection is refused by the broker at the MQTT level, then
the exit code is the CONNACK reason code. If another error
occurs, the exit code is a libmosquitto return value.
</para>
<para>
mosquitto_sub returns zero on success, or non-zero on error. If
the connection is refused by the broker at the MQTT level, then
the exit code is the CONNACK reason code. If another error
occurs, the exit code is a libmosquitto return value.
</para>
<para>MQTT v3.1.1 CONNACK codes:</para>
<itemizedlist mark="circle">

Loading…
Cancel
Save