aboutsummaryrefslogtreecommitdiffstats
path: root/doc/protocols
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2014-08-13 17:10:26 +0200
committerMattias Andrée <maandree@operamail.com>2014-08-13 17:10:26 +0200
commitc45638631d4ad36fb94fc51f368adea2c927d195 (patch)
tree157d5bc7d432d6c38476263d4be3a82cafc9ac91 /doc/protocols
parentmisc (diff)
downloadmds-c45638631d4ad36fb94fc51f368adea2c927d195.tar.gz
mds-c45638631d4ad36fb94fc51f368adea2c927d195.tar.bz2
mds-c45638631d4ad36fb94fc51f368adea2c927d195.tar.xz
mds-kkbd: misc
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to 'doc/protocols')
-rw-r--r--doc/protocols35
1 files changed, 34 insertions, 1 deletions
diff --git a/doc/protocols b/doc/protocols
index 09bea45..ac3dfa1 100644
--- a/doc/protocols
+++ b/doc/protocols
@@ -575,7 +575,7 @@ Required header: Client ID
Required header: Keyboard
A string that identifies the keyboard that should be
- affected.
+ affected
Response: The server implementing support for
`Command: get-keyboard-leds` for the keyboard indicated
@@ -603,3 +603,36 @@ Reference implementation: kbdtrans
---------------------------------------------------------------------
+Command: error
+ Notify a client about a request failure
+
+Required header: To
+ The ID of the client that send a request that failed
+
+Required header: Message ID
+ The ID of the message whose request failed
+
+Required header: Error
+ The errno number of the error, 0 on success if the
+ message was not an information query. The string
+ "custom" can be used if there is not errno number,
+ optionally followed by a blank space and a number
+ that identifies the error, this number must be
+ positive (not zero).
+
+Conditionally optional header: Length
+ Available and optional if: "custom" as used in `Error`
+ The length of the message
+
+Message: Description of the error, single line, mid-
+ sentence case, no punctuation in the end, must
+ not be question but rather it must be a statement
+
+Purpose: Enable keyboard layout servers to automatically
+ set active locks when the server starts based on
+ currently active LED:s
+
+Compulsivity: highly recommended
+
+---------------------------------------------------------------------
+