From patchwork Thu Jul 20 00:29:11 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Luiz Augusto von Dentz X-Patchwork-Id: 13319649 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 7A5C6C001B0 for ; Thu, 20 Jul 2023 00:29:21 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229711AbjGTA3U (ORCPT ); Wed, 19 Jul 2023 20:29:20 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57510 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229705AbjGTA3T (ORCPT ); Wed, 19 Jul 2023 20:29:19 -0400 Received: from mail-qk1-x72d.google.com (mail-qk1-x72d.google.com [IPv6:2607:f8b0:4864:20::72d]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 0097F1A8 for ; Wed, 19 Jul 2023 17:29:17 -0700 (PDT) Received: by mail-qk1-x72d.google.com with SMTP id af79cd13be357-7658430eb5dso27708285a.2 for ; Wed, 19 Jul 2023 17:29:17 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1689812956; x=1692404956; h=content-transfer-encoding:mime-version:message-id:date:subject:to :from:from:to:cc:subject:date:message-id:reply-to; bh=+dA8wc46dxfw24mLtAU0WMcChEuY9TK9kc2Owzhe/cE=; b=n1mK8R9yyHKoIpDTnJEjYMK9l6M0gnfVAB4h0ZNejg8Qu0nVDV52I1BYdaR6Xx90kJ ZR5SFAt6HXdFJdfDf9bILOesD/aaqmQGapUcd1OK58oWzKjn5Z7FzokEIuY3B4ytT5h6 upxD0+xaTGMMyx1yNKddqSo8Q9XFOPzVCiOjvQabQrT+FlAbfo1bh1L85tP3+Fn3b9a8 Xe7mW+0kKK9RWMWdnlZ5gldVXi7nq8imUkWMyeXG8p3LVsIhnf+s543YhCEUJ5vghxc+ +NZbJd01kGrUuedQr81he7EQ+sRI3FwEiGq7PCyW/ZNP4xKuxKJ7qHWjjMHqgD6w0v0i ywUw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1689812956; x=1692404956; h=content-transfer-encoding:mime-version:message-id:date:subject:to :from:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=+dA8wc46dxfw24mLtAU0WMcChEuY9TK9kc2Owzhe/cE=; b=lei9MVcyPES3o038RhZRgEAlt3bhjkJgxGd+c/ltovHZR31v88Qpx/pdzVkAnQTbSQ h1ebdRwBWOYfBszPQzkw/U9EOftzTsAgr5A5bU353gqhQ9KR7kWU/TWoUCSBdUtGRe5l i1wwZ7QRDoK3O9lq1pqoi6bXVD2IXT+jGZqF7TZnVYbY2ppG0XWkiPfPXeRhpCn186e/ eDDkRGGUUQy3FiuoFGFN5/Um5QhtPdA8DK0z6iZ5MvIuRsj+IMJlC48k+Kcr1cKEYx0q Tf6nSjVf0n4KwpiU5l7/U+uIeZOAOLySv3arTPxOmtW3mPn8fFuAK92mJXCvBZElOtNc 0X/Q== X-Gm-Message-State: ABy/qLYIPyMKXrEGIhswiG/zG9OCoFrmrNsPyiyWMbw3oOiP/4cQgFB0 IiobSVZxR/BuEFsO0gLfulFSYLE6Bsk= X-Google-Smtp-Source: APBJJlG1Ib4T6E0nhcxJOV/f3GFfTq/G2bxsyLQnXYPu0mw/OzITnpuQgDEDVkS5x7tXBVlZPr2EzA== X-Received: by 2002:a05:620a:4001:b0:767:f50e:533 with SMTP id h1-20020a05620a400100b00767f50e0533mr26157894qko.77.1689812956277; Wed, 19 Jul 2023 17:29:16 -0700 (PDT) Received: from lvondent-mobl4.. (c-71-236-201-58.hsd1.or.comcast.net. [71.236.201.58]) by smtp.gmail.com with ESMTPSA id r25-20020a05620a03d900b007623c96430csm1619472qkm.111.2023.07.19.17.29.14 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 19 Jul 2023 17:29:15 -0700 (PDT) From: Luiz Augusto von Dentz To: linux-bluetooth@vger.kernel.org Subject: [BlueZ PATCH v4 1/3] btmgmt: Add man page Date: Wed, 19 Jul 2023 17:29:11 -0700 Message-ID: <20230720002913.342733-1-luiz.dentz@gmail.com> X-Mailer: git-send-email 2.41.0 MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-bluetooth@vger.kernel.org From: Luiz Augusto von Dentz 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 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..8e3b5787ae9b --- /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(1)**, +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 < X-Patchwork-Id: 13319650 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 0F892C001DE for ; Thu, 20 Jul 2023 00:29:24 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229812AbjGTA3W (ORCPT ); Wed, 19 Jul 2023 20:29:22 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57528 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229705AbjGTA3V (ORCPT ); Wed, 19 Jul 2023 20:29:21 -0400 Received: from mail-qk1-x72d.google.com (mail-qk1-x72d.google.com [IPv6:2607:f8b0:4864:20::72d]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id B726519A6 for ; Wed, 19 Jul 2023 17:29:19 -0700 (PDT) Received: by mail-qk1-x72d.google.com with SMTP id af79cd13be357-763a2e39b88so25899385a.1 for ; Wed, 19 Jul 2023 17:29:19 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1689812958; x=1692404958; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:from:to:cc:subject:date:message-id :reply-to; bh=MEEQPaHbXzlMLDjOLcsMEWg7RxMf3QZJqNQO0A/xiaE=; b=TVcJommCz5CeU5jaSzJQt6OBrLvUek2RRPEVakKF0Ote38zjgRYJYHmiX+HF2ZJ0EO /l21dCTcYqn8bDZ9TupJVF+u10TYjHK0JlK4hD/v1H/5oZ6OyOW5XLLj8Tfpj+PBprrB 9UUaZuHmt6xop097Mvyk+2gXo++QFROfFX4uPSSP5EUbeNItuZa9C/kls/gs0aOP1kfT y1rRkNg7MKZ3B2z8eciCQ26NpiY5sS5FxOxbb6Ad1R9SgL0ZByv3uItK4oNqGW4dFEYm WOpnUkF8i/CqNftVGZPsc1q3v5LzaGcOPPYIEBQSJ7yjwRD9U1vfIVH1E5Y7M9BkKu1o NgJQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1689812958; x=1692404958; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=MEEQPaHbXzlMLDjOLcsMEWg7RxMf3QZJqNQO0A/xiaE=; b=QnscbarqA2VrRDgP48JNdqEyGjVXmGrunByEHA7FbWK1YEwsDtufREc+QMgECOpwI5 4dnWlNJa49hmeHjLT3klAMgeOe2TRttWGTsWn8En9VnXqD2MOQIjMUWB0R7XwehdlLjJ v0zMayWt1QziTGY5H30Q+tB3SiTl1CJC5QfX5SOJbv7xvvyCR79CaVaXnP7CpwzlvFYR Qm3eLi3iXo4epXaElmnAha6drlW9DjoIvV/X3hvqEby89y3MNVZvOlwvY72mTnQy2uqO q2l81cjAUS3xH8GCRof2anZc9xgrlUDbUQbCFmVR4q0zkX/hs3cTkwv6Z4zP3/wPpdsT Mntg== X-Gm-Message-State: ABy/qLYt/QsIK17FlDZFFKBkYUPmarDX+0fXHIkbuLIPd88/fgDIfsV3 noMLWOc74WaDGsVYkY7flPzBxcQVYJY= X-Google-Smtp-Source: APBJJlE31iGVH3W9qD7avLxbbT84aA2hWYwEg0U3l3R2k8ErCHjHDRq6UZqSFlgVZKDVgfGJ+yn3VA== X-Received: by 2002:a05:620a:371c:b0:763:c8be:819b with SMTP id de28-20020a05620a371c00b00763c8be819bmr5581910qkb.22.1689812958025; Wed, 19 Jul 2023 17:29:18 -0700 (PDT) Received: from lvondent-mobl4.. (c-71-236-201-58.hsd1.or.comcast.net. [71.236.201.58]) by smtp.gmail.com with ESMTPSA id r25-20020a05620a03d900b007623c96430csm1619472qkm.111.2023.07.19.17.29.16 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 19 Jul 2023 17:29:17 -0700 (PDT) From: Luiz Augusto von Dentz To: linux-bluetooth@vger.kernel.org Subject: [BlueZ PATCH v4 2/3] client: Add bluetoothctl-mgmt.1 man page Date: Wed, 19 Jul 2023 17:29:12 -0700 Message-ID: <20230720002913.342733-2-luiz.dentz@gmail.com> X-Mailer: git-send-email 2.41.0 In-Reply-To: <20230720002913.342733-1-luiz.dentz@gmail.com> References: <20230720002913.342733-1-luiz.dentz@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-bluetooth@vger.kernel.org From: Luiz Augusto von Dentz This adds bluetoothctl-mgmt.rst which is then converted to bluetooth-mgmt.1 using rst2man. --- Makefile.tools | 2 +- client/bluetoothctl-mgmt.rst | 559 +++++++++++++++++++++++++++++++++++ 2 files changed, 560 insertions(+), 1 deletion(-) create mode 100644 client/bluetoothctl-mgmt.rst diff --git a/Makefile.tools b/Makefile.tools index c1de187bf72b..6c5835bbd65d 100644 --- a/Makefile.tools +++ b/Makefile.tools @@ -348,7 +348,7 @@ 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 + tools/btmgmt.1 client/bluetoothctl-mgmt.1 endif if MESH diff --git a/client/bluetoothctl-mgmt.rst b/client/bluetoothctl-mgmt.rst new file mode 100644 index 000000000000..4baed6480c14 --- /dev/null +++ b/client/bluetoothctl-mgmt.rst @@ -0,0 +1,559 @@ +================= +bluetoothctl-mgmt +================= + +------------------ +Management 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] [mgmt.commands] + +Mgmt Commands +============= + +select +------ + +Select a different index + +:Usage: **# select ** + +revision +-------- + +Get the MGMT Revision + +:Usage: **# revision** + +commands +-------- + +List supported commands + +:Usage: **# commands** + +config +------ + +Show configuration info + +:Usage: **# config** + +info +---- + +Show controller info + +:Usage: **# info** + +extinfo +------- + +Show extended controller info + +:Usage: **# extinfo** + +auto-power +---------- + +Power all available features + +:Usage: **# auto-power** + +power +----- + +Toggle powered state + +:Usage: **# power ** + +discov +------ + +Toggle discoverable state + +:Usage: **# discov [timeout]** + +connectable +----------- + +Toggle connectable state + +:Usage: **# connectable ** + +fast-conn +--------- + +Toggle fast connectable state + +:Usage: **# fast-conn ** + +bondable +-------- + +Toggle bondable state + +:Usage: **# bondable ** + +pairable +-------- + +Toggle bondable state + +:Usage: **# pairable ** + +linksec +------- + +Toggle link level security + +:Usage: **# linksec ** + +ssp +--- + +Toggle SSP mode + +:Usage: **# spp ** + +sc +-- + +Toggle SC support + +:Usage: **# sc ** + +hs +-- + +Toggle HS support + +:Usage: **# hs ** + +le +-- + +Toggle LE support + +:Usage: **# le ** + +advertising +----------- + +Toggle LE advertising + +:Usage: **# advertise ** + +bredr +----- + +Toggle BR/EDR support + +:Usage: **# bredr ** + +privacy +------- + +Toggle privacy support + +:Usage: **# privacy [irk]** + +class +----- + +Set device major/minor class + +:Usage: **# class ** + +disconnect +---------- + +Disconnect device + +:Usage: **# disconnect [-t type] ** + +con +--- + +List connections + +:Usage: **# con** + +find +---- + +Discover nearby devices + +:Usage: **# find [-l|-b] [-L]** + +find-service +------------ + +Discover nearby service + +:Usage: **# find-service [-u UUID] [-r RSSI_Threshold] [-l|-b]** + +stop-find +--------- + +Stop discovery + +:Usage: **# stop-find [-l|-b]** + +name +---- + +Set local name + +:Usage: **# name [shortname]** + +pair +---- + +Pair with a remote device + +:Usage: **# pair [-c cap] [-t type] ** + +cancelpair +---------- + +Cancel pairing + +:Usage: **# cancelpair [-t type] ** + +unpair +------ + +Unpair device + +:Usage: **# unpair [-t type] ** + +keys +---- + +Load Link Keys + +:Usage: **keys** + +ltks +---- + +Load Long Term Keys + +:Usage: **# ltks** + +irks +---- + +Load Identity Resolving Keys + +:Usage: **# irks [--local index] [--file file path]** + +block +----- + +Block Device + +:Usage: **# block [-t type] ** + +unblock +------- + +Unblock Device + +:Usage: **# unblock [-t type] ** + +add-uuid +-------- + +Add UUID + +:Usage: **# add-uuid ** + +rm-uuid +------- + +Remove UUID + +:Usage: **# rm-uuid ** + +clr-uuids +--------- + +Clear UUIDs + +:Usage: **# clear-uuids** + +local-oob +--------- + +Local OOB data + +:Usage: **# local-oob** + +remote-oob +---------- + +Remote OOB data + +:Usage: **# remote-oob [-t ] [-r ] [-h ] + [-R ] [-H ] ** + +did +--- + +Set Device ID + +:Usage: **# did :::** + +static-addr +----------- + +Set static address + +:Usage: **# static-addr
** + +public-addr +----------- + +Set public address + +:Usage: **# public-addr
** + +ext-config +---------- + +External configuration + +:Usage: **# ext-config ** + +debug-keys +---------- + +Toggle debug keys + +:Usage: **# debug-keys ** + +conn-info +--------- + +Get connection information + +:Usage: **# conn-info [-t type] ** + +io-cap +------ + +Set IO Capability + +:Usage: **# io-cap ** + +scan-params +----------- + +Set Scan Parameters + +:Usage: **# scan-params ** + +get-clock +--------- + +Get Clock Information + +:Usage: **# get-clock [address]** + +add-device +---------- + +Add Device + +:Usage: **# add-device [-a action] [-t type]
** + +del-device +---------- + +Remove Device + +:Usage: **# del-device [-t type]
** + +clr-devices +----------- + +Clear Devices + +:Usage: **# clr-devices** + +bredr-oob +--------- + +Local OOB data (BR/EDR) + +:Usage: **# bredr-oob** + +le-oob +------ + +Local OOB data (LE) + +:Usage: **# le-oob** + +advinfo +------- + +Show advertising features + +:Usage: **# advinfo** + +advsize +------- + +Show advertising size info + +:Usage: **# advsize [options] ** + +add-adv +------- + +Add advertising instance + +:Usage: **# add-adv [options] ** + +rm-adv +------ + +Remove advertising instance + +:Usage: **# rm-adv ** + +clr-adv +------- + +Clear advertising instances + +:Usage: **# clr-adv** + +add-ext-adv-params +------------------ + +Add extended advertising params + +:Usage: **# add-ext-adv-parms [options] ** + +add-ext-adv-data +---------------- + +Add extended advertising data + +:Usage: **# add-ext-adv-data [options] ** + +appearance +---------- + +Set appearance + +:Usage: **# appearance ** + +phy +--- + +Get/Set PHY Configuration + +:Usage: **# phy [LE1MTX] [LE1MRX] [LE2MTX] [LE2MRX] [LECODEDTX] [LECODEDRX] + [BR1M1SLOT] [BR1M3SLOT] [BR1M5SLOT][EDR2M1SLOT] [EDR2M3SLOT] + [EDR2M5SLOT][EDR3M1SLOT] [EDR3M3SLOT] [EDR3M5SLOT]** + +wbs +--- + +Toggle Wideband-Speech support + +:Usage: **# wbs ** + +secinfo +------- + +Show security information + +:Usage: **# secinfo** + +expinfo +------- + +Show experimental features + +:Usage: **# expinfo** + +exp-debug +--------- + +Set debug feature + +:Usage: **# exp-debug ** + +exp-privacy +----------- + +Set LL privacy feature + +:Usage: **# exp-privacy ** + +exp-quality +----------- + +Set bluetooth quality report feature + +:Usage: **# exp-quality ** + +exp-offload +----------- + +Toggle codec support + +:Usage: **# exp-offload ** + +read-sysconfig +-------------- + +Read System Configuration + +:Usage: **# read-sysconfig** + +set-sysconfig +------------- + +Set System Configuration + +:Usage: **# set-sysconfig <-v|-h> [options...]** + +get-flags +--------- + +Get device flags + + +set-flags +--------- + +Set device flags + +:Usage: **# set-flags [-f flags] [-t type]
** + +RESOURCES +========= + +http://www.bluez.org + +REPORTING BUGS +============== + +linux-bluetooth@vger.kernel.org From patchwork Thu Jul 20 00:29:13 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Luiz Augusto von Dentz X-Patchwork-Id: 13319651 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id CD1CDC001B0 for ; Thu, 20 Jul 2023 00:29:24 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229822AbjGTA3Y (ORCPT ); Wed, 19 Jul 2023 20:29:24 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57536 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229781AbjGTA3W (ORCPT ); Wed, 19 Jul 2023 20:29:22 -0400 Received: from mail-qk1-x729.google.com (mail-qk1-x729.google.com [IPv6:2607:f8b0:4864:20::729]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id A1AD91A8 for ; Wed, 19 Jul 2023 17:29:21 -0700 (PDT) Received: by mail-qk1-x729.google.com with SMTP id af79cd13be357-76731802203so24791185a.3 for ; Wed, 19 Jul 2023 17:29:21 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1689812960; x=1692404960; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:from:to:cc:subject:date:message-id :reply-to; bh=yA6UUXyFTO5GmXU2zsZoTlaLvLg/A1iycqt2aCfaztw=; b=HwrJ/CjO5myzwDIpIsle4u+YBT5DbD/42kq8rssi5BncEnp374kaXEt7Mvm74dKYSb VaLGMi14kGyMdlNZwsSalk1iPxZcEHZb1EzvEQairGXuymVaggLe+ujFacG+iOmHsKXF YDrxfSYkB7mIMReyAQpPult9P3HPfcPU0avEos0RJUswByIi51kT38t5MZB5QNFeHgB9 frBqJO+rqb8O5RUZ9Cum5nIDl4LA0GJxaovWOULBnb7Hhs4AvYQQh+C84vzHUFFpS1+4 a0GJNRXl5KalQpmZP47loI+VHfMA1/tQymDSfuOfUO/EJyWa/JfCZfpd+b6N9CEwLdSN n66Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1689812960; x=1692404960; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=yA6UUXyFTO5GmXU2zsZoTlaLvLg/A1iycqt2aCfaztw=; b=aHsBm9jykV17wkZtR7YRYLZOYFKYEPMhZgEUj8yi0Yx3itfc66VaDDvro1wum6PtV9 MQ4AYNf620RAVl1H4rmq0hm21gy9Gj11SmIcuhVUV8XM4eDGVUQFUWNH28aQX8wHgXdK pUmwxeP/JKh34YgQz2oR+AaRPZYrBgKModYUXDfpZkxRC8N/DYBLlFtVNKegFjPgufw2 1nBSJ7QxbFPHU0zReZdfBaFhYz+J9LLFoCVgfAGe2qoE5uPIbGOWQ6K4oJs0XOaYzkvv qgNu66LDkMDi/RAz54VIbHM+0MTH5VSaPR8ieW0XX1PiTLxVgwbYZ5dnTlPViRDtmrqI 807Q== X-Gm-Message-State: ABy/qLYR7FGeeDiwN1M0LgLSsJgamstROMg2mQJy4J2RlY6xJ95U7XAs isaY0ZWfDAx0bCe+YiOuUfeTJnQXeCI= X-Google-Smtp-Source: APBJJlGJqA4jutSGqonEeP8+fPZViMCEPhTua1Km4Z5WbZ8Bt1WpeVQ20a0sbXGiJtXLoqKr677eCw== X-Received: by 2002:a05:620a:4707:b0:767:eb51:ac27 with SMTP id bs7-20020a05620a470700b00767eb51ac27mr24347225qkb.5.1689812959925; Wed, 19 Jul 2023 17:29:19 -0700 (PDT) Received: from lvondent-mobl4.. (c-71-236-201-58.hsd1.or.comcast.net. [71.236.201.58]) by smtp.gmail.com with ESMTPSA id r25-20020a05620a03d900b007623c96430csm1619472qkm.111.2023.07.19.17.29.18 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 19 Jul 2023 17:29:19 -0700 (PDT) From: Luiz Augusto von Dentz 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> X-Mailer: git-send-email 2.41.0 In-Reply-To: <20230720002913.342733-1-luiz.dentz@gmail.com> References: <20230720002913.342733-1-luiz.dentz@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-bluetooth@vger.kernel.org From: Luiz Augusto von Dentz 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 ** + +set-rssi-timeout +---------------- + +Set RSSI timeout parameter + +:Usage: **# set-rssi-timeout ** + +set-rssi-sampling-period +------------------------- + +Set RSSI sampling period parameter + +:Usage: **# set-rssi-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 ** + +remove-pattern +-------------- + +Remove advertisement monitor + +:Usage: **# remove-pattern ** + +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 ** + +RESOURCES +========= + +http://www.bluez.org + +REPORTING BUGS +============== + +linux-bluetooth@vger.kernel.org +