From 87ac7d8a1f42d265d5f3bf7bf4113821f05063e0 Mon Sep 17 00:00:00 2001 From: sithlord48 Date: Tue, 4 Aug 2026 10:43:53 -0400 Subject: [PATCH] docs: adjust config md to fix up broken screen option table and valid key list --- docs/Configuration.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/Configuration.md b/docs/Configuration.md index 0856178eb..679be968a 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -318,13 +318,14 @@ This declares three computers named ''moe'', ''larry'', and ''curly''. Computer #### screen options A computer can have the following options: + |Option | Valid Values| Description| |:----------|:-----------:|:-----------| |halfDuplexCapsLock| `true` or `false` | This computer has a ''Caps Lock'' key that doesn't report a press and a release event when the user presses it but instead reports a press event when it's turned on and a release event when it's turned off. If ''Caps Lock'' acts strangely on all computers then you may need to set this option to true on the server. If it acts strangely on one computer then that computer may need the option set to true.| |halfDuplexNumLock | `true` or `false` | This computer has a ''Num Lock'' key that doesn't report a press and a release event when the user presses it but instead reports a press event when it's turned on and a release event when it's turned off. If ''Num Lock'' acts strangely on all computers then you may need to set this option to true on the server. If it acts strangely on one computer then that computer may need the option set to true.| |halfDuplexScrollLock| `true` or `false`| This computer has a ''Scroll Lock'' key that doesn't report a press and a release event when the user presses it but instead reports a press event when it's turned on and a release event when it's turned off. If ''Scroll Lock'' acts strangely on all computers then you may need to set this option to true on the server. If it acts strangely on one computer then that computer may need the option set to true.| |xtestIsXineramaUnaware| `true` or `false`| This option works around a bug in the XTest extension when used in combination with Xinerama. It affects X11 clients only. Not all versions of the XTest extension are aware of the Xinerama extension. As a result, they do not move the mouse correctly when using multiple Xinerama screens. This option is currently ''true'' by default. If you know your XTest extension is Xinerama aware then set this option to ''false''.| -|preserveFocus| `true` or `false` | When true don't drop focus when switching computers +|preserveFocus| `true` or `false` | When true don't drop focus when switching computers| |switchCorners | none top-left top-right bottom-left bottom-right left right top bottom all | Deskflow won't switch computers when the mouse reaches the edge of the computer if it's in a listed corner. The size of all corners is given by the `switchCornerSize` option. The first name in the list is one of the above names and defines the initial set of corners. Subsequent names are prefixed with + or - to add the corner to or remove the corner from the set, respectively. For example: `all -left +top-left` starts will all corners, removes the left corners (top and bottom) then adds the top-left back in, resulting in the top-left, bottom-left and bottom-right corners.| |switchCornerSize | integer (N) | Sets the size of all corners in pixels. The cursor must be within `N` pixels of the corner to be considered to be in the corner.| |shift | shift ctrl alt meta super none | Map the server's shift modifer to different key on a client computer| @@ -419,6 +420,7 @@ Actions are two lists of individual actions separated by commas. The two lists a Valid key names are:
Valid Key Names + * AppMail * AppMedia * AppUser1 @@ -576,6 +578,7 @@ Valid key names are: * Bar * BraceR * Tilde +
Additionally, a name of the form `\uXXXX` where ''XXXX'' is a hexadecimal number is interpreted as a unicode character code. Key and modifier names are case-insensitive. Keys that don't exist on the keyboard or in the default keyboard layout will not work.