mirror of
https://github.com/eclipse-mosquitto/mosquitto.git
synced 2026-02-05 10:40:05 +08:00
168 lines
6.4 KiB
XML
168 lines
6.4 KiB
XML
<?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">
|
|
<refmeta>
|
|
<refentrytitle>mosquitto</refentrytitle>
|
|
<manvolnum>7</manvolnum>
|
|
<refmiscinfo class="source">Mosquitto Project</refmiscinfo>
|
|
<refmiscinfo class="manual">Conventions and miscellaneous</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>mosquitto</refname>
|
|
<refpurpose>Project overview</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>
|
|
The mosquitto project contains MQTT related programs, and comprises
|
|
the mosquitto broker and applications, command line clients, and a
|
|
client library for implementing custom MQTT clients. A brief description
|
|
of some MQTT features is available at
|
|
<citerefentry><refentrytitle><link xlink:href="mqtt-7.html">mqtt</link></refentrytitle><manvolnum>7</manvolnum></citerefentry>.
|
|
</para>
|
|
|
|
<para>
|
|
Mosquitto is an
|
|
<link xlink:href="https://projects.eclipse.org/projects/iot.mosquitto">Eclipse Foundation project</link>,
|
|
part of the <link xlink:href="https://iot.eclipse.org/">IoT top level project</link>.
|
|
</para>
|
|
|
|
<para>
|
|
The project home page is at
|
|
<link xlink:href="https://mosquitto.org/">mosquitto.org</link>,
|
|
the github project is at
|
|
<link xlink:href="https://github.com/eclipse-mosquitto/mosquitto/">github.com/eclipse-mosquitto/mosquitto</link>,
|
|
and the project provides a public MQTT test broker available at
|
|
<link xlink:href="https://test.mosquitto.org/">test.mosquitto.org</link>.
|
|
</para>
|
|
|
|
<para>
|
|
Development is driven by <link xlink:href="https://cedalo.com/">Cedalo</link>,
|
|
who also provide professional support and enterprise features for mosquitto.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Mosquitto Broker</title>
|
|
<para>
|
|
The mosquitto broker is the core of the project. Details on starting the broker, MQTT support, and feature descriptions can be found in
|
|
<citerefentry><refentrytitle><link xlink:href="mosquitto-8.html">mosquitto</link></refentrytitle><manvolnum>8</manvolnum></citerefentry>. A full description of the configuration file format can be found in <citerefentry><refentrytitle><link xlink:href="mosquitto-conf-5.html">mosquitto.conf</link></refentrytitle><manvolnum>5</manvolnum></citerefentry>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Mosquitto Broker Applications</title>
|
|
<para>
|
|
These command line applications directly support the running of the
|
|
mosquitto broker.
|
|
</para>
|
|
|
|
<refsect2>
|
|
<title>mosquitto_ctrl</title>
|
|
|
|
<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 from version 2.1 onwards,
|
|
in an interactive shell mode.
|
|
</para>
|
|
|
|
<para>
|
|
The batch mode is described in
|
|
<citerefentry><refentrytitle><link xlink:href="mosquitto_ctrl-1.html">mosquitto_ctrl</link></refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
|
with the Dynamic Security module described in
|
|
<citerefentry><refentrytitle><link xlink:href="mosquitto_ctrl_dynsec-1.html">mosquitto_ctrl_dynsec</link></refentrytitle><manvolnum>1</manvolnum></citerefentry>.
|
|
</para>
|
|
<para>
|
|
The interactive shell mode is described in
|
|
<citerefentry><refentrytitle><link xlink:href="mosquitto_ctrl_shell-1.html">mosquitto_ctrl_shell</link></refentrytitle><manvolnum>1</manvolnum></citerefentry>.
|
|
</para>
|
|
</refsect2>
|
|
|
|
<refsect2>
|
|
<title>mosquitto_passwd</title>
|
|
|
|
<para>
|
|
This tool is used to generate and modify password files that can
|
|
be used with the <option>mosquitto_password_file</option> plugin
|
|
or <option>password_file</option> configuration option. It is
|
|
described in
|
|
<citerefentry><refentrytitle><link xlink:href="mosquitto_passwd-1.html">mosquitto_passwd</link></refentrytitle><manvolnum>1</manvolnum></citerefentry>.
|
|
</para>
|
|
</refsect2>
|
|
|
|
<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
|
|
with named signals. On Windows it is the only method of sending
|
|
signals to the broker. It is described in
|
|
<citerefentry><refentrytitle><link xlink:href="mosquitto_signal-1.html">mosquitto_signal</link></refentrytitle><manvolnum>1</manvolnum></citerefentry>.
|
|
</para>
|
|
</refsect2>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Mosquitto MQTT Command Line Clients</title>
|
|
<para>
|
|
These command line tools act as MQTT clients and can be useful for
|
|
testing and automation of tasks related to any MQTT broker.
|
|
</para>
|
|
|
|
<refsect2>
|
|
<title>mosquitto_pub</title>
|
|
|
|
<para>
|
|
This client can publish messages to a broker. It supports sending
|
|
simple messages from the command line, reading from stdin, and
|
|
sending files. It is described at
|
|
<citerefentry><refentrytitle><link xlink:href="mosquitto_pub-1.html">mosquitto_pub</link></refentrytitle><manvolnum>1</manvolnum></citerefentry>.
|
|
</para>
|
|
</refsect2>
|
|
|
|
<refsect2>
|
|
<title>mosquitto_rr</title>
|
|
|
|
<para>
|
|
This client operates in a request/response style by sending a
|
|
single message to a broker and waiting for a response on another
|
|
topic. Request/response support is an MQTT v5.0 feature, but it
|
|
is not required most cases for this client. It is described at
|
|
<citerefentry><refentrytitle><link xlink:href="mosquitto_rr-1.html">mosquitto_rr</link></refentrytitle><manvolnum>1</manvolnum></citerefentry>.
|
|
</para>
|
|
</refsect2>
|
|
|
|
<refsect2>
|
|
<title>mosquitto_sub</title>
|
|
|
|
<para>
|
|
This client subscribes to topics on the broker and prints
|
|
messages that it receives. It has a wide variety of output
|
|
options. It is described at
|
|
<citerefentry><refentrytitle><link xlink:href="mosquitto_sub-1.html">mosquitto_sub</link></refentrytitle><manvolnum>1</manvolnum></citerefentry>.
|
|
</para>
|
|
</refsect2>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Mosquitto Client Library</title>
|
|
<para>
|
|
The Mosquitto client library is described at
|
|
<citerefentry><refentrytitle><link xlink:href="libmosquitto-3.html">libmosquitto</link></refentrytitle><manvolnum>3</manvolnum></citerefentry>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Author</title>
|
|
<para>Roger Light <email>roger@atchoo.org</email></para>
|
|
</refsect1>
|
|
</refentry>
|