From fa5fb919a97ee62d271eeec4fc93ce7a880f9239 Mon Sep 17 00:00:00 2001 From: Paul Otto Date: Fri, 3 Nov 2023 21:38:47 -0400 Subject: [PATCH] client: Add bluetoothctl-gatt.1 man page This adds bluetoothctl-gatt.rst which is then converted to bluetoothctl-gatt.1 using rst2man. --- Makefile.tools | 6 +- client/bluetoothctl-gatt.rst | 180 +++++++++++++++++++++++++++++++++++ 2 files changed, 184 insertions(+), 2 deletions(-) create mode 100644 client/bluetoothctl-gatt.rst diff --git a/Makefile.tools b/Makefile.tools index 8eb62ba6d..a06cbb56a 100644 --- a/Makefile.tools +++ b/Makefile.tools @@ -350,7 +350,8 @@ if MANPAGES man_MANS += tools/rctest.1 tools/l2ping.1 tools/btattach.1 tools/isotest.1 \ tools/btmgmt.1 client/bluetoothctl-mgmt.1 \ client/bluetoothctl-monitor.1 client/bluetoothctl-admin.1 \ - client/bluetoothctl-advertise.1 client/bluetoothctl-endpoint.1 + client/bluetoothctl-advertise.1 client/bluetoothctl-endpoint.1 \ + client/bluetoothctl-gatt.1 endif if MESH @@ -476,7 +477,8 @@ manual_pages += tools/hciattach.1 tools/hciconfig.1 \ client/bluetoothctl-monitor.1 \ client/bluetoothctl-admin.1 \ client/bluetoothctl-advertise.1 \ - client/bluetoothctl-endpoint.1 + client/bluetoothctl-endpoint.1 \ + client/bluetoothctl-gatt.1 if HID2HCI udevdir = $(UDEV_DIR) diff --git a/client/bluetoothctl-gatt.rst b/client/bluetoothctl-gatt.rst new file mode 100644 index 000000000..2a239beca --- /dev/null +++ b/client/bluetoothctl-gatt.rst @@ -0,0 +1,180 @@ +================= +bluetoothctl-gatt +================= + +------------------------- +Generic Attribute Submenu +------------------------- + +:Version: BlueZ +:Copyright: Free use of this software is granted under ther terms of the GNU + Lesser General Public Licenses (LGPL). +:Date: November 2022 +:Manual section: 1 +:Manual group: Linux System Administration + +SYNOPSIS +======== + +**bluetoothctl** [--options] [gatt.commands] + + +Generic Attribute Commands +========================== + +list-attributes +--------------- + +List attributes. + +:Usage: **# list-attributes ** + +select-attribute +---------------- + +Select attribute. + +:Usage: **# select-attribute ** + +attribute-info +-------------- + +Select attribute. + +:Usage: **# attribute-info [attribute/UUID]** + +read +---- + +Read attribute value. + +:Usage: **# read [offset]** + +write +----- + +Write attribute value. + +:Usage: **# write [offset] [type]** + +acquire-write +------------- + +Acquire Write file descriptor. + +:Usage: **# acquire-write** + +release-write +------------- + +Release Write file descriptor. + +:Usage: **# release-write** + +acquire-notify +-------------- + +Acquire Notify file descriptor. + +:Usage: **# acquire-notify** + +release-notify +-------------- + +Release Notify file descriptor. + +:Usage: **# release-notify** + +notify +------ + +Notify attribute value. + +:Usage: **# notify ** + +clone +----- + +Clone a device or attribute. + +:Usage: **# clone [dev/attribute/UUID]** + +register-application +-------------------- + +Register application. + +:Usage: **# register-application [UUID ...]** + +unregister-application +---------------------- + +Unregister application + +:Usage: **# unregister-application** + +register-service +---------------- + +Register application service. + +:Usage: **# register-service [handle]** + +unregister-service +------------------ + +Unregister application service + +:Usage: **# unregister-service ** + +register-includes +----------------- + +Register as Included service. + +:Usage: **#r egister-includes [handle]** + +unregister-includes +------------------- + +Unregister Included service. + +:Usage: **# unregister-includes ** + +register-characteristic +----------------------- + +Register service characteristic. + +:Usage: **# register-characteristic [handle]** + +unregister-characteristic +------------------------- + +Unregister service characteristic. + +:Usage: **# unregister-characteristic ** + +register-descriptor +------------------- + +Register characteristic descriptor. + +:Usage: **# register-descriptor [handle]** + +unregister-descriptor +--------------------- + +Unregister characteristic descriptor. + +:Usage: **# unregister-descriptor ** + +RESOURCES +========= + +http://www.bluez.org + +REPORTING BUGS +============== + +linux-bluetooth@vger.kernel.org -- 2.47.3