summaryrefslogtreecommitdiff
path: root/mesh/bluetooth-meshd.rst.in
diff options
context:
space:
mode:
authorInga Stotland <inga.stotland@intel.com>2021-05-16 22:23:57 -0700
committerLuiz Augusto von Dentz <luiz.von.dentz@intel.com>2021-05-19 10:52:53 -0700
commit980bd585c38a0b9578c0f857c20b86c7fc6feffe (patch)
tree1e6a82698fdc8edae06863d418d0e9d6c725ca5c /mesh/bluetooth-meshd.rst.in
parent47f51a98c521f937edb4edacd9d9a52f272520a3 (diff)
downloadbluez-980bd585c38a0b9578c0f857c20b86c7fc6feffe.tar.gz
mesh: Add manpage for bluetooth-meshd daemon
This adds manpage with a brief description of BLuettoth Mesh daemon command line options.
Diffstat (limited to 'mesh/bluetooth-meshd.rst.in')
-rw-r--r--mesh/bluetooth-meshd.rst.in74
1 files changed, 74 insertions, 0 deletions
diff --git a/mesh/bluetooth-meshd.rst.in b/mesh/bluetooth-meshd.rst.in
new file mode 100644
index 000000000..06cdb69da
--- /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 <type>, --io <type>
+ Specifies I/O interface type:
+
+ *hci<index>* - Use generic HCI io on interface hci<index>,
+ or, if no idex is specified, the first available one.
+
+ *unit:<fd_path>*- 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 <file>, --config <file>
+ Specifies an explicit config file path instead of relying on the
+ default path(*@CONFIGDIR@/mesh-main.conf*) for the config file.
+
+-s <dir_path>, --storage <dir path>
+ 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