Skip to content

Commit

Permalink
Signal+reload documentation improvement.
Browse files Browse the repository at this point in the history
  • Loading branch information
ralight committed Aug 20, 2021
1 parent 342aa0a commit 035291c
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 6 deletions.
17 changes: 11 additions & 6 deletions man/mosquitto.8.xml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
<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><link xlink:href="mosquitto_conf-5.html">mosquitto.conf</link></refentrytitle><manvolnum>5</manvolnum></citerefentry>
<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>
Expand Down Expand Up @@ -84,7 +84,7 @@
<title>Configuration</title>
<para>The broker can be configured using a configuration file as
described in
<citerefentry><refentrytitle><link xlink:href="mosquitto_conf-5.html">mosquitto.conf</link></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><link xlink:href="mosquitto-tls-7.html">mosquitto-tls</link></refentrytitle><manvolnum>7</manvolnum></citerefentry>.
Expand Down Expand Up @@ -545,7 +545,7 @@
dropped due to inflight/queuing limits. See the
max_inflight_messages and max_queued_messages options
in
<citerefentry><refentrytitle><link xlink:href="mosquitto_conf-5.html">mosquitto.conf</link></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>
Expand Down Expand Up @@ -652,11 +652,16 @@
local to each
broker.</para>
<para>For information on configuring bridges, see
<citerefentry><refentrytitle><link xlink:href="mosquitto_conf-5.html">mosquitto.conf</link></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>
<title>Signals</title>
<para>
On POSIX systems Mosquitto can receive signals and act on them as
described below. To send signals, use e.g.
<command>kill -HUP &lt;process id of mosquitto&gt;</command>
</para>
<variablelist>
<varlistentry>
<term>SIGHUP</term>
Expand All @@ -666,7 +671,7 @@
the <option>-c</option> argument was provided when
mosquitto was started. Not all configuration parameters can
be reloaded without restarting. See
<citerefentry><refentrytitle><link xlink:href="mosquitto_conf-5.html">mosquitto.conf</link></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>
Expand Down Expand Up @@ -698,7 +703,7 @@
<varlistentry>
<term><filename>/etc/mosquitto/mosquitto.conf</filename></term>
<listitem>
<para>Configuration file. See <citerefentry><refentrytitle><link xlink:href="mosquitto_conf-5.html">mosquitto.conf</link></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>
Expand Down
6 changes: 6 additions & 0 deletions man/mosquitto.conf.5.xml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@
use the default values listed below. See
<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>
<para>
Mosquitto can be instructed to reload the configuration file by sending
a SIGHUP signal as described in the Signals section of
<citerefentry><refentrytitle><link xlink:href="mosquitto-8.html">mosquitto</link></refentrytitle><manvolnum>8</manvolnum></citerefentry>.
Not all configuration options can be reloaded, as detailed in the options below.
</para>
</refsect1>

<refsect1>
Expand Down

0 comments on commit 035291c

Please sign in to comment.