korg/bluez
0
0
Fork 0
mirror of https://git.kernel.org/pub/scm/bluetooth/bluez.git synced 2024-11-15 00:04:29 +08:00
Code Issues Packages Projects Releases Wiki Activity

doc/input-api: Rename to org.bluez.Input.rst

Browse Source 
This renames input-api.txt to org.bluez.Input.rst and generate manpages
org.bluez.Input.5.
This commit is contained in:
Luiz Augusto von Dentz 2023-10-05 17:13:34 -07:00
parent 6481b9095b
commit cfc76016b4
3 changed files with 55 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Makefile.am
View File

@ -361,7 +361,7 @@ man_MANS += doc/org.bluez.Adapter.5 doc/org.bluez.Device.5 \
doc/org.bluez.DeviceSet.5 doc/org.bluez.AgentManager.5 \
doc/org.bluez.Agent.5 doc/org.bluez.ProfileManager.5 \
doc/org.bluez.Profile.5 doc/org.bluez.NetworkServer.5 \
doc/org.bluez.Network.5
doc/org.bluez.Network.5 doc/org.bluez.Input.5
man_MANS += doc/org.bluez.Media.5 doc/org.bluez.MediaControl.5 \
doc/org.bluez.MediaPlayer.5 doc/org.bluez.MediaFolder.5 \
doc/org.bluez.MediaItem.5 doc/org.bluez.MediaEndpoint.5 \
@ -372,7 +372,7 @@ manual_pages += doc/org.bluez.Adapter.5 doc/org.bluez.Device.5 \
doc/org.bluez.DeviceSet.5 doc/org.bluez.AgentManager.5 \
doc/org.bluez.Agent.5 doc/org.bluez.ProfileManager.5 \
doc/org.bluez.Profile.5 doc/org.bluez.NetworkServer.5 \
doc/org.bluez.Network.5
doc/org.bluez.Network.5 doc/org.bluez.Input.5
manual_pages += doc/org.bluez.Media.5 doc/org.bluez.MediaControl.5 \
doc/org.bluez.MediaPlayer.5 doc/org.bluez.MediaFolder.5 \
doc/org.bluez.MediaItem.5 doc/org.bluez.MediaEndpoint.5 \
@ -414,13 +414,13 @@ EXTRA_DIST += doc/assigned-numbers.txt doc/supported-features.txt \
EXTRA_DIST += doc/mgmt-api.txt \
doc/health-api.txt \
doc/sap-api.txt doc/input-api.txt
doc/sap-api.txt
EXTRA_DIST += doc/org.bluez.Adapter.rst doc/org.bluez.Device.rst \
doc/org.bluez.DeviceSet.rst doc/org.bluez.AgentManager.rst \
doc/org.bluez.Agent.rst doc/org.bluez.ProfileManager.rst \
doc/org.bluez.Profile.rst doc/org.bluez.NetworkServer.rst \
doc/org.bluez.Network.rst
doc/org.bluez.Network.rst doc/org.bluez.Input.rst
EXTRA_DIST += doc/org.bluez.Media.rst doc/org.bluez.MediaControl.rst \
doc/org.bluez.MediaPlayer.rst doc/org.bluez.MediaFolder.rst \

32
doc/input-api.txt
View File

@ -1,32 +0,0 @@
BlueZ D-Bus Input API description
*********************************
Input hierarchy
===============
Service org.bluez
Interface org.bluez.Input1
Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
Properties string ReconnectMode [readonly]
Determines the Connectability mode of the HID device as
defined by the HID Profile specification, Section 5.4.2.
This mode is based in the two properties
HIDReconnectInitiate (see Section 5.3.4.6) and
HIDNormallyConnectable (see Section 5.3.4.14) which
define the following four possible values:
"none" Device and host are not required to
automatically restore the connection.
"host" Bluetooth HID host restores connection.
"device" Bluetooth HID device restores
connection.
"any" Bluetooth HID device shall attempt to
restore the lost connection, but
Bluetooth HID Host may also restore the
connection.

51
doc/org.bluez.Input.rst Normal file
View File

@ -0,0 +1,51 @@
===============
org.bluez.Input
===============
-----------------------------------
BlueZ D-Bus Input API documentation
-----------------------------------
:Version: BlueZ
:Date: October 2023
:Manual section: 5
:Manual group: Linux System Administration
Interface
=========
:Service: org.bluez
:Interface: org.bluez.Input1
:Object path: [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
Properties
----------
string ReconnectMode [readonly]
```````````````````````````````
Indicates the Connectability mode of the HID device as defined by the
HID Profile specification, Section 5.4.2.
This mode is based in the two properties HIDReconnectInitiate (see
Section 5.3.4.6) and HIDNormallyConnectable (see Section 5.3.4.14) which
define the following four possible values:
:"none":
Device and host are not required to automatically restore the
connection.
:"host":
Bluetooth HID host restores connection.
:"device":
Bluetooth HID device restores connection.
:"any":
Bluetooth HID device shall attempt to restore the lost
connection, but Bluetooth HID Host may also restore the
connection.