Received-SPF: pass (google.com: domain of linux-bluetooth-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Luiz Augusto von Dentz <luiz.dentz@gmail.com>
To:     linux-bluetooth@vger.kernel.org
Subject: [BlueZ PATCH v4 3/3] client: Add bluetoothctl-monitor.1 man page
Date:   Wed, 19 Jul 2023 17:29:13 -0700
Message-ID: <20230720002913.342733-3-luiz.dentz@gmail.com>
In-Reply-To: <20230720002913.342733-1-luiz.dentz@gmail.com>
References: <20230720002913.342733-1-luiz.dentz@gmail.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

From: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>

This adds bluetoothctl-monitor.rst which is then converted to
bluetoothctl-mgmt.1 using rst2man.
---
 Makefile.tools                  |  3 +-
 client/bluetoothctl-monitor.rst | 89 +++++++++++++++++++++++++++++++++
 2 files changed, 91 insertions(+), 1 deletion(-)
 create mode 100644 client/bluetoothctl-monitor.rst

diff --git a/Makefile.tools b/Makefile.tools
index 6c5835bbd65d..09e41dd07469 100644
--- a/Makefile.tools
+++ b/Makefile.tools
@@ -348,7 +348,8 @@ profiles_iap_iapd_LDADD = gdbus/libgdbus-internal.la $(GLIB_LIBS) $(DBUS_LIBS)
 
 if MANPAGES
 man_MANS += tools/rctest.1 tools/l2ping.1 tools/btattach.1 tools/isotest.1 \
-		tools/btmgmt.1 client/bluetoothctl-mgmt.1
+		tools/btmgmt.1 client/bluetoothctl-mgmt.1 \
+		client/bluetoothctl-monitor.1
 endif
 
 if MESH
diff --git a/client/bluetoothctl-monitor.rst b/client/bluetoothctl-monitor.rst
new file mode 100644
index 000000000000..2357a56ace36
--- /dev/null
+++ b/client/bluetoothctl-monitor.rst
@@ -0,0 +1,89 @@
+====================
+bluetoothctl-monitor
+====================
+
+---------------
+Monitor Submenu
+---------------
+
+:Version: BlueZ
+:Copyright: Free use of this software is granted under ther terms of the GNU
+            Lesser General Public Licenses (LGPL).
+:Date: July 2023
+:Manual section: 1
+:Manual group: Linux System Administration
+
+SYNOPSIS
+========
+
+**bluetoothctl** [--options] [monitor.commands]
+
+Monitor Commands
+================
+
+set-rssi-threshold
+------------------
+
+Set RSSI threshold parameter
+
+:Usage: **# set-rssi-threshold <low_threshold> <high_threshold>**
+
+set-rssi-timeout
+----------------
+
+Set RSSI timeout parameter
+
+:Usage: **# set-rssi-timeout <low_timeout> <high_timeout>**
+
+set-rssi-sampling-period
+-------------------------
+
+Set RSSI sampling period parameter
+
+:Usage: **# set-rssi-timeout <low_timeout> <high_timeout>**
+
+add-or-pattern
+--------------
+
+Register 'or pattern' type monitor with the specified RSSI parameters
+
+:Usage: **# add-or-pattern [patterns=pattern1 pattern2 ...]**
+
+get-pattern
+-----------
+
+Get advertisement monitor
+
+:Usage: **# get-pattern <monitor-id/all>**
+
+remove-pattern
+--------------
+
+Remove advertisement monitor
+
+:Usage: **# remove-pattern <monitor-id/all>**
+
+get-supported-info
+------------------
+
+Get advertisement manager supported features and supported monitor types
+
+:Usage: **# get-supported-info**
+
+print-usage
+-----------
+
+Print the command usage
+
+:Usage: **# print-usage <add-or-pattern>**
+
+RESOURCES
+=========
+
+http://www.bluez.org
+
+REPORTING BUGS
+==============
+
+linux-bluetooth@vger.kernel.org
+
-- 
2.41.0