diff mbox series

[BlueZ,1/7] update doc for bluetoothctl-admin.rst

Message ID 20231104013850.24182-2-potto@vt.edu
State New
Headers show
Series Update bluetoothctl documentation | expand

Commit Message

Paul Otto Nov. 4, 2023, 1:38 a.m. UTC 
From: Paul Otto <potto@ieee.org>

---
 client/bluetoothctl-admin.rst | 98 +++++++++++++++++++++++++++++++++++
 1 file changed, 98 insertions(+)
 create mode 100644 client/bluetoothctl-admin.rst
diff mbox series

Patch

diff --git a/client/bluetoothctl-admin.rst b/client/bluetoothctl-admin.rst
new file mode 100644
index 000000000..7084bdad0
--- /dev/null
+++ b/client/bluetoothctl-admin.rst
@@ -0,0 +1,98 @@ 
+==================
+bluetoothctl-admin
+==================
+
+--------------------
+Admin Policy 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** [**-a** *capability*] [**-e**] [**-m**] [**-t** *seconds*] [**-v**] [**-h**]
+
+DESCRIPTION
+===========
+
+**bluetoothctl(1)** interactive bluetooth control tool. The tool works with Bluetooth Classic (BR/EDR) and Bluetooth Low Energy (LE) controllers.
+
+OPTIONS
+=======
+
+-a capability, --agent capability        Register agent handler: <capability>
+-e, --endpoints                  Register Media endpoints
+-m, --monitor                    Enable monitor output
+-t seconds, --timeout seconds    Timeout in seconds for non-interactive mode
+-v, --version       Display version
+-h, --help          Display help
+
+Admin Policy Commands
+=====================
+   We divide bluetoothctl into main menu commands and submenu commands. The submenu commands control options 
+   numbers for the commands can be hex (0x0F) or decimal (10)
+   
+allow
+-----
+   Allow service UUIDs and block rest of them
+   Syntax: allow [clear/uuid1 uuid2 ...]
+   Example: allow 0x1101 0x1102 0x1103
+   Example: allow clear
+
+:Usage: **#allow [clear/uuid1 uuid2 ...]**
+
+back
+----
+   Return to main menu 
+
+:Usage: **#back**
+
+version
+-------
+   Display version
+
+:Usage: **#version**
+
+quit
+----
+   Quit program
+
+:Usage: **#quit**
+
+exit
+----
+   Quit program
+
+:Usage: **#exit**
+
+help
+----
+   Display help about this program
+
+:Usage: **#help**
+
+export
+------
+   Print environment variables
+
+:Usage: **#export**
+
+EXAMPLES
+========
+
+
+RESOURCES
+=========
+
+http://www.bluez.org
+
+REPORTING BUGS
+==============
+
+linux-bluetooth@vger.kernel.org