d0kuhn/mosquitto
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix links in man pages.

Browse Source
This commit is contained in:
Roger Light 2021-04-09 22:54:36 +01:00
parent c418b57d0f
commit f1f0396d86
7 changed files with 34 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
man/mosquitto.8.xml
View File

@ -41,7 +41,8 @@
<listitem> <listitem>
<para> <para>
Load configuration from a file. If not given, then the broker will listen on port 1883 bound to the loopback interface, Load configuration from a file. If not given, then the broker will listen on port 1883 bound to the loopback interface,
and the default values as described in <citerefentry><refentrytitle>mosquitto.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> and the default values as described in
<citerefentry><refentrytitle><link xlink:href="mosquitto_conf-5.html">mosquitto.conf</link></refentrytitle><manvolnum>5</manvolnum></citerefentry>
are used. are used.
</para> </para>
<important><para>See the <option>-p</option> option for a description of changes in behaviour from 1.6.x to 2.0.</para></important> <important><para>See the <option>-p</option> option for a description of changes in behaviour from 1.6.x to 2.0.</para></important>
@ -83,10 +84,10 @@
<title>Configuration</title> <title>Configuration</title>
<para>The broker can be configured using a configuration file as <para>The broker can be configured using a configuration file as
described in described in
<citerefentry><refentrytitle>mosquitto.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> <citerefentry><refentrytitle><link xlink:href="mosquitto_conf-5.html">mosquitto.conf</link></refentrytitle><manvolnum>5</manvolnum></citerefentry>
and this is the main point of information for mosquitto. and this is the main point of information for mosquitto.
The files required for SSL/TLS support are described in The files required for SSL/TLS support are described in
<citerefentry><refentrytitle>mosquitto-tls</refentrytitle><manvolnum>7</manvolnum></citerefentry>. <citerefentry><refentrytitle><link xlink:href="mosquitto-tls-7.html">mosquitto-tls</link></refentrytitle><manvolnum>7</manvolnum></citerefentry>.
</para> </para>
</refsect1> </refsect1>
@ -308,7 +309,7 @@
dropped due to inflight/queuing limits. See the dropped due to inflight/queuing limits. See the
max_inflight_messages and max_queued_messages options max_inflight_messages and max_queued_messages options
in in
<citerefentry><refentrytitle>mosquitto.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> <citerefentry><refentrytitle><link xlink:href="mosquitto_conf-5.html">mosquitto.conf</link></refentrytitle><manvolnum>5</manvolnum></citerefentry>
for more information.</para> for more information.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -415,7 +416,7 @@
local to each local to each
broker.</para> broker.</para>
<para>For information on configuring bridges, see <para>For information on configuring bridges, see
<citerefentry><refentrytitle>mosquitto.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> <citerefentry><refentrytitle><link xlink:href="mosquitto_conf-5.html">mosquitto.conf</link></refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
</refsect1> </refsect1>
<refsect1> <refsect1>
@ -429,7 +430,7 @@
the <option>-c</option> argument was provided when the <option>-c</option> argument was provided when
mosquitto was started. Not all configuration parameters can mosquitto was started. Not all configuration parameters can
be reloaded without restarting. See be reloaded without restarting. See
<citerefentry><refentrytitle>mosquitto.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> <citerefentry><refentrytitle><link xlink:href="mosquitto_conf-5.html">mosquitto.conf</link></refentrytitle><manvolnum>5</manvolnum></citerefentry>
for details.</para> for details.</para>
<para>If TLS certificates are in use, then mosquitto will <para>If TLS certificates are in use, then mosquitto will
also reload certificate on receiving a SIGHUP.</para> also reload certificate on receiving a SIGHUP.</para>
@ -461,7 +462,7 @@
<varlistentry> <varlistentry>
<term><filename>/etc/mosquitto/mosquitto.conf</filename></term> <term><filename>/etc/mosquitto/mosquitto.conf</filename></term>
<listitem> <listitem>
<para>Configuration file. See <citerefentry><refentrytitle>mosquitto.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> <para>Configuration file. See <citerefentry><refentrytitle><link xlink:href="mosquitto_conf-5.html">mosquitto.conf</link></refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -474,7 +475,7 @@
<term><filename>/etc/hosts.allow</filename></term> <term><filename>/etc/hosts.allow</filename></term>
<term><filename>/etc/hosts.deny</filename></term> <term><filename>/etc/hosts.deny</filename></term>
<listitem> <listitem>
<para>Host access control via tcp-wrappers as described in <citerefentry><refentrytitle>hosts_access</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> <para>Host access control via tcp-wrappers as described in <citerefentry><refentrytitle><link xlink:href="https://linux.die.net/man/5/hosts_access">hosts_access</link></refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>

8
man/mosquitto.conf.5.xml
View File

@ -26,7 +26,7 @@
mosquitto. This file can reside anywhere as long as mosquitto can read mosquitto. This file can reside anywhere as long as mosquitto can read
it. By default, mosquitto does not need a configuration file and will it. By default, mosquitto does not need a configuration file and will
use the default values listed below. See use the default values listed below. See
<citerefentry><refentrytitle>mosquitto</refentrytitle><manvolnum>8</manvolnum></citerefentry> <citerefentry><refentrytitle><link xlink:href="mosquitto-8.html">mosquitto</link></refentrytitle><manvolnum>8</manvolnum></citerefentry>
for information on how to load a configuration file.</para> for information on how to load a configuration file.</para>
</refsect1> </refsect1>
@ -737,7 +737,7 @@ log_timestamp_format %Y-%m-%dT%H:%M:%S
<para>Set the path to a password file. If defined, the <para>Set the path to a password file. If defined, the
contents of the file are used to control client access contents of the file are used to control client access
to the broker. The file can be created using the to the broker. The file can be created using the
<citerefentry><refentrytitle>mosquitto_passwd</refentrytitle><manvolnum>1</manvolnum></citerefentry> <citerefentry><refentrytitle><link xlink:href="mosquitto_passwd-1.html">mosquitto_passwd</link></refentrytitle><manvolnum>1</manvolnum></citerefentry>
utility. If mosquitto is compiled without TLS support utility. If mosquitto is compiled without TLS support
(it is recommended that TLS support is included), then (it is recommended that TLS support is included), then
the password file should be a text file with each line the password file should be a text file with each line
@ -765,7 +765,7 @@ log_timestamp_format %Y-%m-%dT%H:%M:%S
Clients that are already connected will not be Clients that are already connected will not be
affected.</para> affected.</para>
<para>See also <para>See also
<citerefentry><refentrytitle>mosquitto_passwd</refentrytitle><manvolnum>1</manvolnum></citerefentry> and <citerefentry><refentrytitle><link xlink:href="mosquitto_passwd-1.html">mosquitto_passwd</link></refentrytitle><manvolnum>1</manvolnum></citerefentry> and
<ulink url="https://mosquitto.org/documentation/dynamic-security/"/> <ulink url="https://mosquitto.org/documentation/dynamic-security/"/>
</para> </para>
</listitem> </listitem>
@ -1107,7 +1107,7 @@ log_timestamp_format %Y-%m-%dT%H:%M:%S
to have "unlimited" connections. Note that other to have "unlimited" connections. Note that other
limits may be imposed that are outside the control limits may be imposed that are outside the control
of mosquitto. See e.g. of mosquitto. See e.g.
<citerefentry><refentrytitle>limits.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> <citerefentry><refentrytitle><link xlink:href="http://linux.die.net/man/5/limits.conf">limits.conf</link></refentrytitle></citerefentry>.</para>
<para>Not reloaded on reload signal.</para> <para>Not reloaded on reload signal.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>

4
man/mosquitto_ctrl.1.xml
View File

@ -191,7 +191,7 @@
<listitem> <listitem>
<para>An openssl compatible list of TLS ciphers to support <para>An openssl compatible list of TLS ciphers to support
in the client. See in the client. See
<citerefentry><refentrytitle>ciphers</refentrytitle><manvolnum>1</manvolnum></citerefentry> <citerefentry><refentrytitle><link xlink:href="https://linux.die.net/man/1/ciphers">ciphers</link></refentrytitle><manvolnum>1</manvolnum></citerefentry>
for more information.</para> for more information.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -375,7 +375,7 @@
<para>More SOCKS versions may be available in the future, <para>More SOCKS versions may be available in the future,
depending on demand, and will use different protocol depending on demand, and will use different protocol
prefixes as described in <citerefentry> prefixes as described in <citerefentry>
<refentrytitle>curl</refentrytitle> <refentrytitle><link xlink:href="https://linux.die.net/man/1/curl">curl</link></refentrytitle>
<manvolnum>1</manvolnum> </citerefentry>.</para> <manvolnum>1</manvolnum> </citerefentry>.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>

2
man/mosquitto_passwd.1.xml
View File

@ -50,7 +50,7 @@
password files for the mosquitto MQTT broker.</para> password files for the mosquitto MQTT broker.</para>
<para>Usernames must not contain ":". Passwords are stored in a similar <para>Usernames must not contain ":". Passwords are stored in a similar
format to format to
<citerefentry><refentrytitle>crypt</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para> <citerefentry><refentrytitle><link xlink:href="https://linux.die.net/man/3/crypt">crypt</link></refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
</refsect1> </refsect1>
<refsect1> <refsect1>

10
man/mosquitto_pub.1.xml
View File

@ -195,7 +195,7 @@
<listitem> <listitem>
<para>An openssl compatible list of TLS ciphers to support <para>An openssl compatible list of TLS ciphers to support
in the client. See in the client. See
<citerefentry><refentrytitle>ciphers</refentrytitle><manvolnum>1</manvolnum></citerefentry> <citerefentry><refentrytitle><link xlink:href="https://linux.die.net/man/1/ciphers">ciphers</link></refentrytitle><manvolnum>1</manvolnum></citerefentry>
for more information.</para> for more information.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -413,7 +413,7 @@
<para>More SOCKS versions may be available in the future, <para>More SOCKS versions may be available in the future,
depending on demand, and will use different protocol depending on demand, and will use different protocol
prefixes as described in <citerefentry> prefixes as described in <citerefentry>
<refentrytitle>curl</refentrytitle> <refentrytitle><link xlink:href="https://linux.die.net/man/1/curl">curl</link></refentrytitle>
<manvolnum>1</manvolnum> </citerefentry>.</para> <manvolnum>1</manvolnum> </citerefentry>.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -458,7 +458,7 @@
<para> <para>
If retain is given, the message will be retained as a If retain is given, the message will be retained as a
"last known good" value on the broker. See "last known good" value on the broker. See
<citerefentry><refentrytitle>mqtt</refentrytitle><manvolnum>7</manvolnum></citerefentry> <citerefentry><refentrytitle><link xlink:href="mqtt-7.html">mqtt</link></refentrytitle><manvolnum>7</manvolnum></citerefentry>
for more information. Note that zero length payloads for more information. Note that zero length payloads
are never retained. If you send a zero length are never retained. If you send a zero length
payload retained message it will clear any retained payload retained message it will clear any retained
@ -515,7 +515,7 @@
<term><option>-t</option></term> <term><option>-t</option></term>
<term><option>--topic</option></term> <term><option>--topic</option></term>
<listitem> <listitem>
<para>The MQTT topic on which to publish the message. See <citerefentry><refentrytitle>mqtt</refentrytitle><manvolnum>7</manvolnum></citerefentry> for more information on MQTT topics.</para> <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> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -662,7 +662,7 @@
<title>Wills</title> <title>Wills</title>
<para>mosquitto_sub can register a message with the broker that will be <para>mosquitto_sub can register a message with the broker that will be
sent out if it disconnects unexpectedly. See sent out if it disconnects unexpectedly. See
<citerefentry><refentrytitle>mqtt</refentrytitle><manvolnum>7</manvolnum></citerefentry> <citerefentry><refentrytitle><link xlink:href="mqtt-7.html">mqtt</link></refentrytitle><manvolnum>7</manvolnum></citerefentry>
for more information.</para> for more information.</para>
<para>The minimum requirement for this is to use <option>--will-topic</option> to <para>The minimum requirement for this is to use <option>--will-topic</option> to
specify which topic the will should be sent out on. This will result in specify which topic the will should be sent out on. This will result in

12
man/mosquitto_rr.1.xml
View File

@ -206,7 +206,7 @@
<listitem> <listitem>
<para>An openssl compatible list of TLS ciphers to support <para>An openssl compatible list of TLS ciphers to support
in the client. See in the client. See
<citerefentry><refentrytitle>ciphers</refentrytitle><manvolnum>1</manvolnum></citerefentry> <citerefentry><refentrytitle><link xlink:href="https://linux.die.net/man/1/ciphers">ciphers</link></refentrytitle><manvolnum>1</manvolnum></citerefentry>
for more information.</para> for more information.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -455,7 +455,7 @@
<para>More SOCKS versions may be available in the future, <para>More SOCKS versions may be available in the future,
depending on demand, and will use different protocol depending on demand, and will use different protocol
prefixes as described in <citerefentry> prefixes as described in <citerefentry>
<refentrytitle>curl</refentrytitle> <refentrytitle><link xlink:href="https://linux.die.net/man/1/curl">curl</link></refentrytitle>
<manvolnum>1</manvolnum> </citerefentry>.</para> <manvolnum>1</manvolnum> </citerefentry>.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -483,7 +483,7 @@
<listitem> <listitem>
<para>Specify the quality of service desired for the <para>Specify the quality of service desired for the
incoming messages, from 0, 1 and 2. Defaults to 0. See incoming messages, from 0, 1 and 2. Defaults to 0. See
<citerefentry><refentrytitle>mqtt</refentrytitle><manvolnum>7</manvolnum></citerefentry> <citerefentry><refentrytitle><link xlink:href="mqtt-7.html">mqtt</link></refentrytitle><manvolnum>7</manvolnum></citerefentry>
for more information on QoS.</para> for more information on QoS.</para>
<para>The QoS is identical for all topics subscribed to in <para>The QoS is identical for all topics subscribed to in
a single instance of mosquitto_rr.</para> a single instance of mosquitto_rr.</para>
@ -703,7 +703,7 @@
related to the MQTT message being printed, or are helper sequences related to the MQTT message being printed, or are helper sequences
to avoid the need to type long date format strings for example. to avoid the need to type long date format strings for example.
Sequences starting with <option>@</option> are passed to the Sequences starting with <option>@</option> are passed to the
<citerefentry><refentrytitle>strftime</refentrytitle><manvolnum>3</manvolnum></citerefentry> <citerefentry><refentrytitle><link xlink:href="https://linux.die.net/man/3/strftime">strftime</link></refentrytitle><manvolnum>3</manvolnum></citerefentry>
function (with the @ replaced with a % - note that only the function (with the @ replaced with a % - note that only the
character immediately after the @ is passed to strftime). This character immediately after the @ is passed to strftime). This
allows the construction of a wide variety of time based outputs. allows the construction of a wide variety of time based outputs.
@ -784,7 +784,7 @@
<listitem><para><option>\0</option> a null character. Can be used <listitem><para><option>\0</option> a null character. Can be used
to separate different parameters that may contain spaces to separate different parameters that may contain spaces
(e.g. topic, payload) so that processing with tools such as (e.g. topic, payload) so that processing with tools such as
<citerefentry><refentrytitle>xargs</refentrytitle><manvolnum>1</manvolnum></citerefentry> <citerefentry><refentrytitle><link xlink:href="https://linux.die.net/man/1/xargs">xargs</link></refentrytitle><manvolnum>1</manvolnum></citerefentry>
is easier.</para></listitem> is easier.</para></listitem>
<listitem><para><option>\a</option> alert/bell.</para></listitem> <listitem><para><option>\a</option> alert/bell.</para></listitem>
<listitem><para><option>\e</option> the escape sequence, which can <listitem><para><option>\e</option> the escape sequence, which can
@ -802,7 +802,7 @@
<title>Wills</title> <title>Wills</title>
<para>mosquitto_rr can register a message with the broker that will be <para>mosquitto_rr can register a message with the broker that will be
sent out if it disconnects unexpectedly. See sent out if it disconnects unexpectedly. See
<citerefentry><refentrytitle>mqtt</refentrytitle><manvolnum>7</manvolnum></citerefentry> <citerefentry><refentrytitle><link xlink:href="mqtt-7.html">mqtt</link></refentrytitle><manvolnum>7</manvolnum></citerefentry>
for more information.</para> for more information.</para>
<para>The minimum requirement for this is to use <option>--will-topic</option> to <para>The minimum requirement for this is to use <option>--will-topic</option> to
specify which topic the will should be sent out on. This will result in specify which topic the will should be sent out on. This will result in

14
man/mosquitto_sub.1.xml
View File

@ -208,7 +208,7 @@
<listitem> <listitem>
<para>An openssl compatible list of TLS ciphers to support <para>An openssl compatible list of TLS ciphers to support
in the client. See in the client. See
<citerefentry><refentrytitle>ciphers</refentrytitle><manvolnum>1</manvolnum></citerefentry> <citerefentry><refentrytitle><link xlink:href="https://linux.die.net/man/1/ciphers">ciphers</link></refentrytitle><manvolnum>1</manvolnum></citerefentry>
for more information.</para> for more information.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -455,7 +455,7 @@
<para>More SOCKS versions may be available in the future, <para>More SOCKS versions may be available in the future,
depending on demand, and will use different protocol depending on demand, and will use different protocol
prefixes as described in <citerefentry> prefixes as described in <citerefentry>
<refentrytitle>curl</refentrytitle> <refentrytitle><link xlink:href="https://linux.die.net/man/1/curl">curl</link></refentrytitle>
<manvolnum>1</manvolnum> </citerefentry>.</para> <manvolnum>1</manvolnum> </citerefentry>.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -483,7 +483,7 @@
<listitem> <listitem>
<para>Specify the quality of service desired for the <para>Specify the quality of service desired for the
incoming messages, from 0, 1 and 2. Defaults to 0. See incoming messages, from 0, 1 and 2. Defaults to 0. See
<citerefentry><refentrytitle>mqtt</refentrytitle><manvolnum>7</manvolnum></citerefentry> <citerefentry><refentrytitle><link xlink:href="mqtt-7.html">mqtt</link></refentrytitle><manvolnum>7</manvolnum></citerefentry>
for more information on QoS.</para> for more information on QoS.</para>
<para>The QoS is identical for all topics subscribed to in <para>The QoS is identical for all topics subscribed to in
a single instance of mosquitto_sub.</para> a single instance of mosquitto_sub.</para>
@ -591,7 +591,7 @@ mosquitto_sub -t 'bbc/#' -T bbc/bbc1 --remove-retained</programlisting>
<term><option>--topic</option></term> <term><option>--topic</option></term>
<listitem> <listitem>
<para>The MQTT topic to subscribe to. See <para>The MQTT topic to subscribe to. See
<citerefentry><refentrytitle>mqtt</refentrytitle><manvolnum>7</manvolnum></citerefentry> <citerefentry><refentrytitle><link xlink:href="mqtt-7.html">mqtt</link></refentrytitle><manvolnum>7</manvolnum></citerefentry>
for more information on MQTT topics.</para> for more information on MQTT topics.</para>
<para>This option may be repeated to subscribe to multiple topics.</para> <para>This option may be repeated to subscribe to multiple topics.</para>
</listitem> </listitem>
@ -826,7 +826,7 @@ mosquitto_sub -t 'bbc/#' -T bbc/bbc1 --remove-retained</programlisting>
related to the MQTT message being printed, or are helper sequences related to the MQTT message being printed, or are helper sequences
to avoid the need to type long date format strings for example. to avoid the need to type long date format strings for example.
Sequences starting with <option>@</option> are passed to the Sequences starting with <option>@</option> are passed to the
<citerefentry><refentrytitle>strftime</refentrytitle><manvolnum>3</manvolnum></citerefentry> <citerefentry><refentrytitle><link xlink:href="https://linux.die.net/man/3/strftime">strftime</link></refentrytitle><manvolnum>3</manvolnum></citerefentry>
function (with the @ replaced with a % - note that only the function (with the @ replaced with a % - note that only the
character immediately after the @ is passed to strftime). This character immediately after the @ is passed to strftime). This
allows the construction of a wide variety of time based outputs. allows the construction of a wide variety of time based outputs.
@ -960,7 +960,7 @@ mosquitto_sub -t 'bbc/#' -T bbc/bbc1 --remove-retained</programlisting>
<listitem><para><option>\0</option> a null character. Can be used <listitem><para><option>\0</option> a null character. Can be used
to separate different parameters that may contain spaces to separate different parameters that may contain spaces
(e.g. topic, payload) so that processing with tools such as (e.g. topic, payload) so that processing with tools such as
<citerefentry><refentrytitle>xargs</refentrytitle><manvolnum>1</manvolnum></citerefentry> <citerefentry><refentrytitle><link xlink:href="https://linux.die.net/man/1/xargs">xargs</link></refentrytitle><manvolnum>1</manvolnum></citerefentry>
is easier.</para></listitem> is easier.</para></listitem>
<listitem><para><option>\a</option> alert/bell.</para></listitem> <listitem><para><option>\a</option> alert/bell.</para></listitem>
<listitem><para><option>\e</option> the escape sequence, which can <listitem><para><option>\e</option> the escape sequence, which can
@ -978,7 +978,7 @@ mosquitto_sub -t 'bbc/#' -T bbc/bbc1 --remove-retained</programlisting>
<title>Wills</title> <title>Wills</title>
<para>mosquitto_sub can register a message with the broker that will be <para>mosquitto_sub can register a message with the broker that will be
sent out if it disconnects unexpectedly. See sent out if it disconnects unexpectedly. See
<citerefentry><refentrytitle>mqtt</refentrytitle><manvolnum>7</manvolnum></citerefentry> <citerefentry><refentrytitle><link xlink:href="mqtt-7.html">mqtt</link></refentrytitle><manvolnum>7</manvolnum></citerefentry>
for more information.</para> for more information.</para>
<para>The minimum requirement for this is to use <option>--will-topic</option> to <para>The minimum requirement for this is to use <option>--will-topic</option> to
specify which topic the will should be sent out on. This will result in specify which topic the will should be sent out on. This will result in