diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/protocols | 35 |
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 + +--------------------------------------------------------------------- + |