Fix links in man pages.
This commit is contained in:
parent
c418b57d0f
commit
f1f0396d86
@ -41,7 +41,8 @@
|
||||
<listitem>
|
||||
<para>
|
||||
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.
|
||||
</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>
|
||||
@ -83,10 +84,10 @@
|
||||
<title>Configuration</title>
|
||||
<para>The broker can be configured using a configuration file as
|
||||
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.
|
||||
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>
|
||||
</refsect1>
|
||||
|
||||
@ -308,7 +309,7 @@
|
||||
dropped due to inflight/queuing limits. See the
|
||||
max_inflight_messages and max_queued_messages options
|
||||
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>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -415,7 +416,7 @@
|
||||
local to each
|
||||
broker.</para>
|
||||
<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>
|
||||
@ -429,7 +430,7 @@
|
||||
the <option>-c</option> argument was provided when
|
||||
mosquitto was started. Not all configuration parameters can
|
||||
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>
|
||||
<para>If TLS certificates are in use, then mosquitto will
|
||||
also reload certificate on receiving a SIGHUP.</para>
|
||||
@ -461,7 +462,7 @@
|
||||
<varlistentry>
|
||||
<term><filename>/etc/mosquitto/mosquitto.conf</filename></term>
|
||||
<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>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
@ -474,7 +475,7 @@
|
||||
<term><filename>/etc/hosts.allow</filename></term>
|
||||
<term><filename>/etc/hosts.deny</filename></term>
|
||||
<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>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
@ -26,7 +26,7 @@
|
||||
mosquitto. This file can reside anywhere as long as mosquitto can read
|
||||
it. By default, mosquitto does not need a configuration file and will
|
||||
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>
|
||||
</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
|
||||
contents of the file are used to control client access
|
||||
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
|
||||
(it is recommended that TLS support is included), then
|
||||
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
|
||||
affected.</para>
|
||||
<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/"/>
|
||||
</para>
|
||||
</listitem>
|
||||
@ -1107,7 +1107,7 @@ log_timestamp_format %Y-%m-%dT%H:%M:%S
|
||||
to have "unlimited" connections. Note that other
|
||||
limits may be imposed that are outside the control
|
||||
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>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
@ -191,7 +191,7 @@
|
||||
<listitem>
|
||||
<para>An openssl compatible list of TLS ciphers to support
|
||||
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>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -375,7 +375,7 @@
|
||||
<para>More SOCKS versions may be available in the future,
|
||||
depending on demand, and will use different protocol
|
||||
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>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
@ -50,7 +50,7 @@
|
||||
password files for the mosquitto MQTT broker.</para>
|
||||
<para>Usernames must not contain ":". Passwords are stored in a similar
|
||||
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>
|
||||
|
@ -195,7 +195,7 @@
|
||||
<listitem>
|
||||
<para>An openssl compatible list of TLS ciphers to support
|
||||
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>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -413,7 +413,7 @@
|
||||
<para>More SOCKS versions may be available in the future,
|
||||
depending on demand, and will use different protocol
|
||||
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>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -458,7 +458,7 @@
|
||||
<para>
|
||||
If retain is given, the message will be retained as a
|
||||
"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
|
||||
are never retained. If you send a zero length
|
||||
payload retained message it will clear any retained
|
||||
@ -515,7 +515,7 @@
|
||||
<term><option>-t</option></term>
|
||||
<term><option>--topic</option></term>
|
||||
<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>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
@ -662,7 +662,7 @@
|
||||
<title>Wills</title>
|
||||
<para>mosquitto_sub can register a message with the broker that will be
|
||||
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>
|
||||
<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
|
||||
|
@ -206,7 +206,7 @@
|
||||
<listitem>
|
||||
<para>An openssl compatible list of TLS ciphers to support
|
||||
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>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -455,7 +455,7 @@
|
||||
<para>More SOCKS versions may be available in the future,
|
||||
depending on demand, and will use different protocol
|
||||
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>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -483,7 +483,7 @@
|
||||
<listitem>
|
||||
<para>Specify the quality of service desired for the
|
||||
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>
|
||||
<para>The QoS is identical for all topics subscribed to in
|
||||
a single instance of mosquitto_rr.</para>
|
||||
@ -703,7 +703,7 @@
|
||||
related to the MQTT message being printed, or are helper sequences
|
||||
to avoid the need to type long date format strings for example.
|
||||
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
|
||||
character immediately after the @ is passed to strftime). This
|
||||
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
|
||||
to separate different parameters that may contain spaces
|
||||
(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>
|
||||
<listitem><para><option>\a</option> alert/bell.</para></listitem>
|
||||
<listitem><para><option>\e</option> the escape sequence, which can
|
||||
@ -802,7 +802,7 @@
|
||||
<title>Wills</title>
|
||||
<para>mosquitto_rr can register a message with the broker that will be
|
||||
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>
|
||||
<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
|
||||
|
@ -208,7 +208,7 @@
|
||||
<listitem>
|
||||
<para>An openssl compatible list of TLS ciphers to support
|
||||
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>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -455,7 +455,7 @@
|
||||
<para>More SOCKS versions may be available in the future,
|
||||
depending on demand, and will use different protocol
|
||||
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>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -483,7 +483,7 @@
|
||||
<listitem>
|
||||
<para>Specify the quality of service desired for the
|
||||
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>
|
||||
<para>The QoS is identical for all topics subscribed to in
|
||||
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>
|
||||
<listitem>
|
||||
<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>
|
||||
<para>This option may be repeated to subscribe to multiple topics.</para>
|
||||
</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
|
||||
to avoid the need to type long date format strings for example.
|
||||
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
|
||||
character immediately after the @ is passed to strftime). This
|
||||
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
|
||||
to separate different parameters that may contain spaces
|
||||
(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>
|
||||
<listitem><para><option>\a</option> alert/bell.</para></listitem>
|
||||
<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>
|
||||
<para>mosquitto_sub can register a message with the broker that will be
|
||||
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>
|
||||
<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
|
||||
|
Loading…
Reference in New Issue
Block a user