client: Add bluetoothctl-scan.1 man page

This adds bluetoothctl-scan.rst which is then converted to
bluetoothctl-scan.1 using rst2man.

Makefile.tools

@@ -351,7 +351,9 @@ 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-gatt.1 client/bluetoothctl-player.1
+		client/bluetoothctl-gatt.1 client/bluetoothctl-player.1 \
+		client/bluetoothctl-scan.1
+
 endif
 
 if MESH
@@ -479,7 +481,8 @@ manual_pages += tools/hciattach.1 tools/hciconfig.1 \
 			client/bluetoothctl-advertise.1 \
 			client/bluetoothctl-endpoint.1 \
 			client/bluetoothctl-gatt.1 \
-			client/bluetoothctl-player.1
+			client/bluetoothctl-player.1 \
+			client/bluetoothctl-scan.1
 
 if HID2HCI
 udevdir = $(UDEV_DIR)

client/bluetoothctl-scan.rst

@@ -0,0 +1,140 @@
+=================
+bluetoothctl-scan
+=================
+
+------------
+Scan 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] [scan.commands]
+
+Scan Commands
+=============
+
+uuids
+-----
+
+Set/Get UUIDs filter.
+
+:Usage: **# uuids [all/uuid1 uuid2 ...]**
+
+rssi
+----
+
+Set/Get RSSI filter, and clears pathloss.
+
+This sets the minimum rssi value for reporting device advertisements.
+
+The value is in dBm.
+
+If one or more discovery filters have been set, the RSSI delta-threshold imposed
+by starting discovery by default will not be applied.
+
+:Usage: **# rssi [rssi]**
+:Example: **# rssi -60**
+
+pathloss
+--------
+Set/Get Pathloss filter, and clears RSSI.
+
+This sets the maximum pathloss value for reporting device advertisements.
+
+The value is in dB.
+
+If one or more discovery filters have been set, the RSSI delta-threshold
+imposed by starting discovery by default will not be applied.
+
+:Usage: **# pathloss [pathloss]**
+:Example: **# pathloss 4**
+
+transport
+---------
+
+Set/Get transport filter.
+
+Transport parameter determines the type of scan.
+
+The default is auto.
+
+Possible values:
+
+- "auto": interleaved scan
+- "bredr": BR/EDR inquiry
+- "le": LE scan only
+
+If "le" or "bredr" Transport is requested and the controller doesn't support it,
+an org.bluez.Error.Failed error will be returned.
+
+If "auto" transport is requested, the scan will use LE, BREDR, or both,
+depending on what's currently enabled on the controller.
+
+:Usage: **# transport [auto/bredr/le]**
+
+duplicate-data
+--------------
+
+Set/Get duplicate data filter.
+
+Disables duplicate detection of advertisement data.
+
+When enabled, PropertiesChanged signals will be generated for ManufacturerData
+and ServiceData every time they are discovered.
+
+:Usage: **# duplicate-data [on/off]**
+
+discoverable
+------------
+
+Set/Get discoverable filter.
+
+Makes the adapter discoverable while discovering.
+
+If the adapter is already discoverable, setting this filter won't have any
+effect.
+
+:Usage: **# discoverable [on/off]**
+
+pattern
+-------
+
+Set/Get pattern filter.
+
+Discover devices where the pattern matches either the prefix of the address or
+the device name, which is a convenient way to limit the number of device objects
+created during a discovery.
+
+When set, it disregards device discoverable flags.
+
+:Note: The pattern matching is ignored if there are other clients that don't
+       set any pattern, as it works as a logical OR. Also, setting an empty
+       string "" pattern will match any device found.
+
+:Usage: **# pattern [value]**
+
+
+clear
+-----
+
+Clears discovery filter.
+
+:Usage: **# clear [uuids/rssi/pathloss/transport/duplicate-data/discoverable/pattern]**
+
+RESOURCES
+=========
+
+http://www.bluez.org
+
+REPORTING BUGS
+==============
+
+linux-bluetooth@vger.kernel.org