From 0b49dda978afa89fd3ea981d721c7842b76c7309 Mon Sep 17 00:00:00 2001 From: Inga Stotland Date: Sun, 16 May 2021 22:23:57 -0700 Subject: [PATCH] mesh: Add manpage for bluetooth-meshd daemon This adds manpage with a brief description of BLuettoth Mesh daemon command line options. Signed-off-by: Ayush Garg --- Makefile.mesh | 5 +++ configure.ac | 3 +- mesh/bluetooth-meshd.rst.in | 74 +++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 81 insertions(+), 1 deletion(-) create mode 100644 mesh/bluetooth-meshd.rst.in diff --git a/Makefile.mesh b/Makefile.mesh index c606af8..0793db3 100644 --- a/Makefile.mesh +++ b/Makefile.mesh @@ -47,6 +47,11 @@ mesh_bluetooth_meshd_LDADD = src/libshared-ell.la $(ell_ldadd) -ljson-c mesh_bluetooth_meshd_DEPENDENCIES = $(ell_dependencies) src/libshared-ell.la \ mesh/bluetooth-mesh.service +if MANPAGES +man_MANS += mesh/bluetooth-meshd.8 +endif +manual_pages += mesh/bluetooth-meshd.8 + EXTRA_DIST += mesh/bluetooth-mesh.conf mesh/bluetooth-mesh.service.in \ mesh/org.bluez.mesh.service mesh/mesh-main.conf diff --git a/configure.ac b/configure.ac index d8b5f02..b530824 100755 --- a/configure.ac +++ b/configure.ac @@ -417,6 +417,7 @@ AC_SUBST(CONFIGDIR, "${configdir}") AC_DEFINE_UNQUOTED(MESH_STORAGEDIR, "${storagedir}/mesh", [Directory for the mesh daemon storage files]) +AC_SUBST(MESH_STORAGEDIR, "${storagedir}/mesh") AC_ARG_ENABLE(android, AC_HELP_STRING([--enable-android], [enable BlueZ for Android]), @@ -440,4 +441,4 @@ fi AC_DEFINE_UNQUOTED(ANDROID_STORAGEDIR, "${storagedir}/android", [Directory for the Android daemon storage files]) -AC_OUTPUT(Makefile src/bluetoothd.rst lib/bluez.pc) +AC_OUTPUT(Makefile src/bluetoothd.rst lib/bluez.pc mesh/bluetooth-meshd.rst) diff --git a/mesh/bluetooth-meshd.rst.in b/mesh/bluetooth-meshd.rst.in new file mode 100644 index 0000000..06cdb69 --- /dev/null +++ b/mesh/bluetooth-meshd.rst.in @@ -0,0 +1,74 @@ +=============== +bluetooth-meshd +=============== + +--------------------- +Bluetooth Mesh daemon +--------------------- + +:Version: BlueZ +:Copyright: Free use of this software is granted under ther terms of the GNU + Lesser General Public Licenses (LGPL). +:Date: March 2021 +:Manual section: 8 +:Manual group: Linux Connectivity + +SYNOPSIS +======== + +**bluetooth-meshd** [*options* ...] + +DESCRIPTION +=========== + +Daemon for managing Bluetooth Mesh connections on Linux. + +OPTIONS +======= + +-h, --help + Print bluetooth-meshd options and exit. + +-n, --nodetach + Enable logging in foreground. Directs log output to the controlling + terminal in addition to syslog. + +-i , --io + Specifies I/O interface type: + + *hci* - Use generic HCI io on interface hci, + or, if no idex is specified, the first available one. + + *unit:*- Specifies open file descriptor for + daemon testing. + + By default, if no type is specified, uses generic I/O + on the first available HCI interface. + +-c , --config + Specifies an explicit config file path instead of relying on the + default path(*@CONFIGDIR@/mesh-main.conf*) for the config file. + +-s , --storage + Specifies an explicit storage directory path instead of the default + path(*@MESH_STORAGEDIR@*) for storing mesh node(s) configuration. + +-d, --debug Enable debug output. + +-b, --dbus-debug Enable D-Bus debug output. + +FILES +===== + +*@CONFIGDIR@/mesh-main.conf* + Location of the global configuration file containing mesh daemon settings. + +RESOURCES +========= + +http://www.bluez.org + +REPORTING BUGS +============== + +linux-bluetooth@vger.kernel.org -- 2.7.4