From 6905331e2cd8894040b18d1711444fb5e654b958 Mon Sep 17 00:00:00 2001 From: Luiz Augusto von Dentz Date: Wed, 11 Dec 2024 11:28:00 -0500 Subject: [PATCH] client: Add bluetoothctl-hci.1 man page This adds bluetoothctl-hci.rst which is then converted to bluetoothctl-hci.1 using rst2man. --- Makefile.tools | 5 ++- client/bluetoothctl-hci.rst | 86 +++++++++++++++++++++++++++++++++++++ 2 files changed, 89 insertions(+), 2 deletions(-) create mode 100644 client/bluetoothctl-hci.rst diff --git a/Makefile.tools b/Makefile.tools index 51a5af6af..0dca43327 100644 --- a/Makefile.tools +++ b/Makefile.tools @@ -354,7 +354,7 @@ man_MANS += tools/rctest.1 tools/l2ping.1 tools/btattach.1 tools/isotest.1 \ client/bluetoothctl-advertise.1 client/bluetoothctl-endpoint.1 \ client/bluetoothctl-gatt.1 client/bluetoothctl-player.1 \ client/bluetoothctl-scan.1 client/bluetoothctl-transport.1 \ - client/bluetoothctl-assistant.1 + client/bluetoothctl-assistant.1 client/bluetoothctl-hci.1 endif @@ -487,7 +487,8 @@ manual_pages += tools/hciattach.1 tools/hciconfig.1 \ client/bluetoothctl-player.1 \ client/bluetoothctl-scan.1 \ client/bluetoothctl-transport.1 \ - client/bluetoothctl-assistant.1 + client/bluetoothctl-assistant.1 \ + client/bluetoothctl-hci.1 if HID2HCI udevdir = $(UDEV_DIR) diff --git a/client/bluetoothctl-hci.rst b/client/bluetoothctl-hci.rst new file mode 100644 index 000000000..200276317 --- /dev/null +++ b/client/bluetoothctl-hci.rst @@ -0,0 +1,86 @@ +================ +bluetoothctl-hci +================ + +----------- +HCI Submenu +----------- + +:Version: BlueZ +:Copyright: Free use of this software is granted under ther terms of the GNU + Lesser General Public Licenses (LGPL). +:Date: December 2024 +:Manual section: 1 +:Manual group: Linux System Administration + +SYNOPSIS +======== + +**bluetoothctl** [--options] [hci.commands] + +Commands +======== + +open +---- + +Open HCI channel. + +:Usage: **> open ** +:Example open user channel: + | In order to open a user channel the controller needs to be power off + | first: + | > power off + | > hci.open 0 user + | HCI index 0 user channel opened + +cmd +--- + +Send HCI command. + +:Usage: **> cmd [parameters...]** +:Example send HCI Reset command: + | > hci.cmd 0x0c03 + | HCI Command complete: + | 00 + +send +---- + +Send HCI data packet. + +:Usage: **> send [data...]** +:Example send ACL data packet to connection handle 0x0000: + | > hci.send acl 0x0000 + +register +-------- + +Register HCI event handler. + +:Usage: **> register ** + +unregister +---------- + +Unregister HCI event handler. + +:Usage: **> unregister ** + +close +----- + +Close HCI channel. + +:Usage: **> close ** + +RESOURCES +========= + +http://www.bluez.org + +REPORTING BUGS +============== + +linux-bluetooth@vger.kernel.org -- 2.47.3