1ea1d6981SmrgX Window System Unified Protocol 2ea1d6981Smrg-------------------------------- 3ea1d6981Smrg 4ea1d6981SmrgThis package provides the headers and specification documents defining 5ea1d6981Smrgthe core protocol and (many) extensions for the X Window System. The 6d63b911fSmrgextensions are those common among servers descended from X11R7. It 7ea1d6981Smrgalso includes a number of headers that aren't purely protocol related, 8ea1d6981Smrgbut are depended upon by many other X Window System packages to provide 9ea1d6981Smrgcommon definitions and porting layer. 10ea1d6981Smrg 11ea1d6981SmrgThough the protocol specifications herein are authoritative, the 12ea1d6981Smrgcontent of the headers is bound by compatibility constraints with older 13ea1d6981Smrgversions of the X11 suite. If you are looking for a machine-readable 14ea1d6981Smrgprotocol description suitable for code generation or use in new 15ea1d6981Smrgprojects, please refer to the XCB project: 16ea1d6981Smrg 17ea1d6981Smrg https://xcb.freedesktop.org/ 18d63b911fSmrg https://gitlab.freedesktop.org/xorg/proto/xcbproto 19ea1d6981Smrg 20ea1d6981SmrgAll questions regarding this software should be directed at the 21ea1d6981SmrgXorg mailing list: 22ea1d6981Smrg 23ea1d6981Smrg https://lists.x.org/mailman/listinfo/xorg 24ea1d6981Smrg 25d63b911fSmrgThe primary development code repository can be found at: 26ea1d6981Smrg 27ea1d6981Smrg https://gitlab.freedesktop.org/xorg/proto/xorgproto 28ea1d6981Smrg 29ea1d6981SmrgPlease submit bug reports and requests to merge patches there. 30ea1d6981Smrg 31ea1d6981SmrgFor patch submission instructions, see: 32ea1d6981Smrg 33ea1d6981Smrg https://www.x.org/wiki/Development/Documentation/SubmittingPatches 34ea1d6981Smrg 35d63b911fSmrg 36d63b911fSmrgUpdating for new Linux kernel releases 37d63b911fSmrg-------------------------------------- 38d63b911fSmrg 39d63b911fSmrgThe XF86keysym.h header file needs updating whenever the Linux kernel 40d63b911fSmrgadds a new keycode to linux/input-event-codes.h. See the comment in 41d63b911fSmrginclude/X11/XF86keysym.h for details on the format. 42d63b911fSmrg 43d63b911fSmrgThe steps to update the file are: 44d63b911fSmrg 45d63b911fSmrg- if the kernel release did not add new `KEY_FOO` defines, no work is 46d63b911fSmrg required 47d63b911fSmrg- ensure that libevdev has been updated to the new kernel headers. This may 48d63b911fSmrg require installing libevdev from git. 49d63b911fSmrg- run `scripts/keysym-generator.py` to add new keysyms. See the `--help` 50d63b911fSmrg output for the correct invocation. 51d63b911fSmrg- verify that the format for any keys added by this script is correct and 52d63b911fSmrg that the keys need to be mapped. Where a key code should not get a new 53d63b911fSmrg define or is already defined otherwise, comment the line. 54d63b911fSmrg- file a merge request with the new changes 55d63b911fSmrg- notify the xkeyboard-config maintainers that updates are needed 56d63b911fSmrg 57d63b911fSmrgNote that any #define added immediately becomes API. Due diligence is 58d63b911fSmrgrecommended. 59