diff --git a/.gitignore b/.gitignore index 575aafe7..dbdfa661 100644 --- a/.gitignore +++ b/.gitignore @@ -46,6 +46,7 @@ man/mosquitto-tls.7 man/mosquitto.conf.5 man/libmosquitto.3 man/mosquitto_ctrl.1 +man/mosquitto_ctrl_dynsec.1 man/mosquitto_passwd.1 man/mosquitto_pub.1 man/mosquitto_rr.1 diff --git a/man/CMakeLists.txt b/man/CMakeLists.txt index 73e12a64..d68753d3 100644 --- a/man/CMakeLists.txt +++ b/man/CMakeLists.txt @@ -1,4 +1,4 @@ -install(FILES mosquitto_passwd.1 mosquitto_pub.1 mosquitto_sub.1 mosquitto_rr.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1) +install(FILES mosquitto_ctrl.1 mosquitto_ctrl_dynsec.1 mosquitto_passwd.1 mosquitto_pub.1 mosquitto_sub.1 mosquitto_rr.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1) install(FILES libmosquitto.3 DESTINATION ${CMAKE_INSTALL_MANDIR}/man3) install(FILES mosquitto.conf.5 DESTINATION ${CMAKE_INSTALL_MANDIR}/man5) install(FILES mosquitto-tls.7 mqtt.7 DESTINATION ${CMAKE_INSTALL_MANDIR}/man7) diff --git a/man/Makefile b/man/Makefile index c02736f1..65e212c0 100644 --- a/man/Makefile +++ b/man/Makefile @@ -8,6 +8,7 @@ MANPAGES = \ mosquitto.8 \ mosquitto.conf.5 \ mosquitto_ctrl.1 \ + mosquitto_ctrl_dynsec.1 \ mosquitto_passwd.1 \ mosquitto_pub.1 \ mosquitto_rr.1 \ @@ -31,6 +32,7 @@ install : $(INSTALL) -m 644 mosquitto.conf.5 "${DESTDIR}${mandir}/man5/mosquitto.conf.5" $(INSTALL) -d "${DESTDIR}$(mandir)/man1" $(INSTALL) -m 644 mosquitto_ctrl.1 "${DESTDIR}${mandir}/man1/mosquitto_ctrl.1" + $(INSTALL) -m 644 mosquitto_ctrl_dynsec.1 "${DESTDIR}${mandir}/man1/mosquitto_ctrl_dynsec.1" $(INSTALL) -m 644 mosquitto_passwd.1 "${DESTDIR}${mandir}/man1/mosquitto_passwd.1" $(INSTALL) -m 644 mosquitto_pub.1 "${DESTDIR}${mandir}/man1/mosquitto_pub.1" $(INSTALL) -m 644 mosquitto_sub.1 "${DESTDIR}${mandir}/man1/mosquitto_sub.1" @@ -45,6 +47,7 @@ uninstall : -rm -f "${DESTDIR}${mandir}/man8/mosquitto.8" -rm -f "${DESTDIR}${mandir}/man5/mosquitto.conf.5" -rm -f "${DESTDIR}${mandir}/man1/mosquitto_ctrl.1" + -rm -f "${DESTDIR}${mandir}/man1/mosquitto_ctrl_dynsec.1" -rm -f "${DESTDIR}${mandir}/man1/mosquitto_passwd.1" -rm -f "${DESTDIR}${mandir}/man1/mosquitto_pub.1" -rm -f "${DESTDIR}${mandir}/man1/mosquitto_sub.1" @@ -62,6 +65,9 @@ mosquitto.conf.5 : mosquitto.conf.5.xml manpage.xsl mosquitto_ctrl.1 : mosquitto_ctrl.1.xml manpage.xsl $(XSLTPROC) $< +mosquitto_ctrl_dynsec.1 : mosquitto_ctrl_dynsec.1.xml manpage.xsl + $(XSLTPROC) $< + mosquitto_passwd.1 : mosquitto_passwd.1.xml manpage.xsl $(XSLTPROC) $< @@ -94,6 +100,7 @@ potgen : xml2po -o po/mosquitto/mosquitto.8.pot mosquitto.8.xml xml2po -o po/mosquitto.conf/mosquitto.conf.5.pot mosquitto.conf.5.xml xml2po -o po/mosquitto_ctrl/mosquitto_ctrl.1.pot mosquitto_ctrl.1.xml + xml2po -o po/mosquitto_ctrl/mosquitto_ctrl_dynsec.1.pot mosquitto_ctrl_dynsec.1.xml xml2po -o po/mosquitto_passwd/mosquitto_passwd.1.pot mosquitto_passwd.1.xml xml2po -o po/mosquitto_pub/mosquitto_pub.1.pot mosquitto_pub.1.xml xml2po -o po/mosquitto_sub/mosquitto_sub.1.pot mosquitto_sub.1.xml diff --git a/man/mosquitto_ctrl.1.xml b/man/mosquitto_ctrl.1.xml index 9f519ba0..104498e3 100644 --- a/man/mosquitto_ctrl.1.xml +++ b/man/mosquitto_ctrl.1.xml @@ -18,12 +18,12 @@ mosquitto_ctrl connection-options - module + module-name module-command command-options - mosquitto_ctrl + connection-options: hostname @@ -72,9 +72,7 @@ mosquitto_ctrl - - @@ -99,20 +97,36 @@ - Dynamic Security Module - The dynamic security plugin is an optional authentication and - access control plugin for Mosquitto that allows on the fly - control of users, groups, and roles. The mosquitto_ctrl - dynsec module allows you to interact with - a broker using the dynamic security plugin. - - - Configuration file initialisation - - - mosquitto_ctrl dynsec init filename admin-user admin-password [admin-role] - - + Modules + + + + + + Authentication, and role based access control with users + and groups. Uses the dynsec module name. See: + + mosquitto_ctrl_dynsec + 1 + + + + + + + + mosquitto_ctrl has the ability to load + external modules in the form of shared libraries. For example + using the module name will try to load + the external module + or , depending on platform. + This allows new functionality to be added to Mosquitto by combining + a plugin and mosquitto_ctrl module, without having to recompile any + Mosquitto source code. + + + + diff --git a/man/mosquitto_ctrl_dynsec.1.meta b/man/mosquitto_ctrl_dynsec.1.meta new file mode 100644 index 00000000..0d173e91 --- /dev/null +++ b/man/mosquitto_ctrl_dynsec.1.meta @@ -0,0 +1,5 @@ +.. title: mosquitto_ctrl man page +.. slug: mosquitto_ctrl-1 +.. category: man +.. type: man +.. pretty_url: False diff --git a/man/mosquitto_ctrl_dynsec.1.xml b/man/mosquitto_ctrl_dynsec.1.xml new file mode 100644 index 00000000..30a7ebaa --- /dev/null +++ b/man/mosquitto_ctrl_dynsec.1.xml @@ -0,0 +1,108 @@ + + + + + + mosquitto_ctrl_dynsec + 1 + Mosquitto Project + Commands + + + + mosquitto_ctrl_dynsec + mosquitto_ctrl module for controlling the Mosquitto Dynamic Security plugin. + + + + + mosquitto_ctrl + connection-options + dynsec + dynsec-command + command-options + + + + + Description + This page describes the dynsec module for + mosquitto_ctrl + 1. See the mosquitto_ctrl + 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. + + + + + Commands + + + Configuration file initialisation + + + mosquitto_ctrl dynsec init config-filename admin-user [admin-password] + + + + + + Bugs + mosquitto bug information can be found at + + + + + See Also + + + + mqtt + 7 + + + + + mosquitto_rr + 1 + + + + + mosquitto_pub + 1 + + + + + mosquitto_sub + 1 + + + + + mosquitto + 8 + + + + + libmosquitto + 3 + + + + + mosquitto-tls + 7 + + + + + + + Author + Roger Light roger@atchoo.org + + diff --git a/www/conf.py b/www/conf.py index 6018b89a..cc2d1023 100644 --- a/www/conf.py +++ b/www/conf.py @@ -93,6 +93,8 @@ NAVIGATION_LINKS = { ("/man/libmosquitto-3.html", "libmosquitto"), ("/man/mosquitto-8.html", "mosquitto"), ("/man/mosquitto-conf-5.html", "mosquitto.conf"), + ("/man/mosquitto_ctrl-1.html", "mosquitto_ctrl"), + ("/man/mosquitto_ctrl_dynsec-1.html", "mosquitto_ctrl_dynsec"), ("/man/mosquitto_passwd-1.html", "mosquitto_passwd"), ("/man/mosquitto_pub-1.html", "mosquitto_pub"), ("/man/mosquitto_rr-1.html", "mosquitto_rr"),