Message ID | 20230720190228.446570-1-luiz.dentz@gmail.com (mailing list archive) |
---|---|
State | Accepted |
Commit | 9ccebfa7f91cb2aeb0c451592a7c4634569578f1 |
Headers | show |
Series | [BlueZ,v5,1/3] btmgmt: Add man page | expand |
Context | Check | Description |
---|---|---|
tedd_an/pre-ci_am | success | Success |
tedd_an/CheckPatch | success | CheckPatch PASS |
tedd_an/GitLint | success | Gitlint PASS |
tedd_an/BuildEll | success | Build ELL PASS |
tedd_an/BluezMake | success | Bluez Make PASS |
tedd_an/MakeCheck | success | Bluez Make Check PASS |
tedd_an/MakeDistcheck | success | Make Distcheck PASS |
tedd_an/CheckValgrind | success | Check Valgrind PASS |
tedd_an/CheckSmatch | success | CheckSparse PASS |
tedd_an/bluezmakeextell | success | Make External ELL PASS |
tedd_an/IncrementalBuild | success | Incremental Build PASS |
tedd_an/ScanBuild | success | Scan Build PASS |
This is automated email and please do not reply to this email! Dear submitter, Thank you for submitting the patches to the linux bluetooth mailing list. This is a CI test results with your patch series: PW Link:https://patchwork.kernel.org/project/bluetooth/list/?series=767959 ---Test result--- Test Summary: CheckPatch PASS 0.85 seconds GitLint PASS 0.63 seconds BuildEll PASS 27.34 seconds BluezMake PASS 869.18 seconds MakeCheck PASS 12.10 seconds MakeDistcheck PASS 155.09 seconds CheckValgrind PASS 255.49 seconds CheckSmatch PASS 341.65 seconds bluezmakeextell PASS 103.62 seconds IncrementalBuild PASS 2135.20 seconds ScanBuild PASS 1040.36 seconds --- Regards, Linux Bluetooth
Hello: This series was applied to bluetooth/bluez.git (master) by Luiz Augusto von Dentz <luiz.von.dentz@intel.com>: On Thu, 20 Jul 2023 12:02:26 -0700 you wrote: > From: Luiz Augusto von Dentz <luiz.von.dentz@intel.com> > > This adds btmgmt.rst which is then converted to btmgmt.1 using rst2man. > --- > Makefile.tools | 5 +-- > tools/btmgmt.rst | 79 ++++++++++++++++++++++++++++++++++++++++++++++++ > 2 files changed, 82 insertions(+), 2 deletions(-) > create mode 100644 tools/btmgmt.rst Here is the summary with links: - [BlueZ,v5,1/3] btmgmt: Add man page https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=9ccebfa7f91c - [BlueZ,v5,2/3] client: Add bluetoothctl-mgmt.1 man page https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=f0bfd7628025 - [BlueZ,v5,3/3] client: Add bluetoothctl-monitor.1 man page https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=82d3d803d4c5 You are awesome, thank you!
diff --git a/Makefile.tools b/Makefile.tools index 7d9697001b75..c1de187bf72b 100644 --- a/Makefile.tools +++ b/Makefile.tools @@ -347,7 +347,8 @@ profiles_iap_iapd_SOURCES = profiles/iap/main.c 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 +man_MANS += tools/rctest.1 tools/l2ping.1 tools/btattach.1 tools/isotest.1 \ + tools/btmgmt.1 endif if MESH @@ -468,7 +469,7 @@ manual_pages += tools/hciattach.1 tools/hciconfig.1 \ tools/hcitool.1 tools/hcidump.1 \ tools/rfcomm.1 tools/sdptool.1 tools/ciptool.1 \ tools/rctest.1 tools/l2ping.1 tools/btattach.1 \ - tools/bdaddr.1 tools/isotest.1 + tools/bdaddr.1 tools/isotest.1 tools/btmgmt.1 if HID2HCI udevdir = $(UDEV_DIR) diff --git a/tools/btmgmt.rst b/tools/btmgmt.rst new file mode 100644 index 000000000000..0159ee128f62 --- /dev/null +++ b/tools/btmgmt.rst @@ -0,0 +1,79 @@ +====== +btmgmt +====== + +------------------------------------- +interactive bluetooth management tool +------------------------------------- + +: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 +======== + +**btmgmt** [--options] [commands] + +DESCRIPTION +=========== + +**btmgmt(1)** interactive bluetooth management tool. The tool issues commands +to the Kernel using the Bluetooth Management socket, some commands may require +net-admin capability in order to work since the Bluetooth Management interface +is considered a low-level interface meant for the likes of **bluetoothd(8)**, +it is not recommended for applications to use it directly as it may result in +unexpected behavior. + +OPTIONS +======= + +:-i/--index: Specify adapter index +:-m-/-monitor: Enable monitor output +:-t/--timeout: Timeout in seconds for non-interactive mode +:-v/--version: Display version +:-i/--init-script: Init script file +:-h/--help: Display help + +COMMANDS +======== + +:main: See **bluetoothctl-mgmt(1)** +:monitor: See **bluetoothctl-monitor(1)** + +AUTOMATION +========== + +Two common ways to automate the tool are to pass the commands directly like in +the follow example: + +.. code-block:: + + btmgmt <<EOF + list + show + EOF + +Or create a script and pass it as init-script: + +.. code-block:: + + $ vi test-script.bt + list + show + quit + :wq + $ btmgmt --init-script=test-script + +RESOURCES +========= + +http://www.bluez.org + +REPORTING BUGS +============== + +linux-bluetooth@vger.kernel.org
From: Luiz Augusto von Dentz <luiz.von.dentz@intel.com> This adds btmgmt.rst which is then converted to btmgmt.1 using rst2man. --- Makefile.tools | 5 +-- tools/btmgmt.rst | 79 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 82 insertions(+), 2 deletions(-) create mode 100644 tools/btmgmt.rst