 |
Deskflow 1.26.0.0
Keyboard and mouse sharing utility
|
|
Deskflow 1.26.0.0
Keyboard and mouse sharing utility
|
Deskflow will automatically figure out where to save settings and other files.
Deskflow will look for settings in several places depending on your operating system. The search order for a setting file depends on your operating system
A new settings file will be created in the user path if no settings file is found. The path of the settings file will be used as the base for all other config files.
A new settings file will be created in the user path if no settings file is found. The path of the settings file will be used as the base for all other config files.
Windows will save to the install dir if settings are loaded from there. If not, it saves any other config files in: C:\ProgramData\Deskflow\
When using settings from the install dir, the service mode will not be available.
The GUI config file contains several sections. Each section is formatted the same. Option-value pairs are only written if the value is not the default value.
This section contains options used when in client mode. It will begin with [client]
| Option | Valid Values | Description |
|---|---|---|
| binary | Filename | The filename of the binary to call for client mode. This binary exists in the same path as the GUI |
| invertScrollDirection | true or false | Invert scroll on this client [default: false] |
| languageSync | true or false | Sync to server language [default: true] |
| remoteHost | IP or hostname | The remote host(s) to connect to. Use a comma seperated list when you want to try severial hosts |
| yScrollScale | Double 0.1 - 10.0 | Mouse scrolling will be scaled by this amount on the client [default: 1.0] |
| xdpRestoreToken | UUID | Restore token provided by XDG portals |
This section contains general options it will begin with [core]
| Option | Valid Values | Description |
|---|---|---|
| coreMode | 0 or 1 or 2 | The mode to start in 0: None, 1: Client, 2: Server [default: 0] |
| display | int | The XWindow display to use [default: autodetected] |
| interface | IP Address | Preferred IP to use for network communication. By default the server board casts on any available address |
| lastVersion | M.m.p.t | The version last run used for checking for updates |
| port | port # | Port to use when connecting [default: 24800 |
| preventSleep | true or false | Prevent sleep when Deskflow is active [default: false] |
| processMode | 1 or 0 | The mode we use to start the process Service or Desktop |
| computerName | string | Name used to identify the computer [default: machine's hostname] |
| useHooks | true or false | If Windows uses hooks or not [default: true] |
| language | 639 language | The language to display the GUI in [default: en] |
| wlClipboard | true or false | When true the wl-clipboard backend will be enabled [default: false] |
This section contains options used by the daemon on windows it will begin with [daemon]
| Option | Valid Values | Description |
|---|---|---|
| command | Filename | The filename of the binary the daemon. This binary exists in the same path as the deskflow GUI |
| elevate | true or false | Elevate the daemon app [default: true unless portable mode ] |
| logFile | Filepath | Filepath of the daemon log |
| logLevel | valid log Level, | Log Level |
This section contains options used by the GUI it will begin with [gui]
| Option | Valid Values | Description |
|---|---|---|
| autoHide | true or false | When true the app will hide itself on start up [default: false] |
| enableUpdateCheck | true or false | When true check the update URL to see if a new version was released on start up [default: false] |
| closeReminder | true or false | Used to track if we have shown the reminder that when you close the app it remain running in the background [default: true] |
| closeToTray | true or false | When true the gui will run in the systemTray when its closed [default: true] |
| logExpanded | true or false | Should the log section of the GUI be opened [default: false] |
| symbolicTrayIcon | true or false | When true use the monocolor (symbolic) icon false uses a colorful icon for the tray [default: true] |
| windowGeometry | QRect | Geometry of the window used to restore the window geometry after exiting the app |
| showGenericClientFailureDialog | true or false | When true client connection errors will not show popup error messages [default: true] |
| shownFirstConnectedMessage | true or false | When true GUI has shown the user the message for connecting the first time [default: false] |
| shownServerFirstStartMessage | true or false | When true GUI has shown the user the Deskflow server is now running message [default: false] |
| shownVerionInTitle | true or false | When true GUI will include the version in the window title [default: false] |
| startCoreWithGui | true or false | When true the Core will be started with the GUI. It is set to the Core's state on exit. |
| updateCheckUrl | URL | The URL to use when checking for a new version number, it should return a version [default: https://api.deskflow.org/version] |
This section contains options used by the application logging it will begin with [log]
| Option | Valid Values | Description |
|---|---|---|
| file | Filepath | The file to write the log into |
| level | Valid log level | Log level to use |
| toFile | true or false | When true the log will be written to the value of the file option |
| guiDebug | true or false | When true the log will show the Gui's internal debug messages |
This section contains options used by the application security it will begin with [security]
| Option | Valid Values | Description |
|---|---|---|
| checkPeerFingerprints | true or false | When true peers will have their fingerprints confirmed by the user and stored [default: true] |
| certificate | Filepath | Path to the certificate to use to encrypt messages. |
| keySize | 2048 OR 4096 | Size of the TLS key to use [default: 2048] |
| tlsEnabled | true or false | Are we using TLS encryption when communicating [default: true]. |
This section contains options used when in server mode it will begin with [server]
| Option | Valid Values | Description |
|---|---|---|
| externalConfig | true or false | When true use the external config path |
| externalConfigFile | Filepath | Path the server config file if it does not exist the GUI will it generated based on the internalConfig section. |
This section contains options used when in server mode it will begin with [internalConfig] block of a server config file as seen below. This section is used by the GUI to generate a server configuration
The deskflow-server command accepts the -c or --config option, which takes one argument, the path to a server configuration file. When using the GUI the internalConfig section of the GUI settings will be exported as the server configuration. The configuration file is plain text and case-sensitive. The file is broken into sections, and each section has the form:
Comments are introduced by ''#'' and continue to the end of the line. ''name'' must be one of the following:
The file is parsed top to bottom and names cannot be used before they've been defined in the screens or aliases sections. So the links and aliases must appear after the screens and links cannot refer to aliases unless the aliases appear before the links.
''args'' is a list of computer names, one name per line, each followed by a colon. Names are arbitrary strings but they must be unique. The hostname of each computer is recommended. (This is the computer's network name on win32 and the name reported by the program hostname on Unix and OS X. Note that OS X may append .local to the name you gave your computer; e.g. somehost.local.) There must be a computer name for the server and each client. Each computer can specify a number of options. Options have the form name = value and are listed one per line after the computer name.
This declares three computers named ''moe'', ''larry'', and ''curly''. Computer ''larry'' has half-duplex ''Caps Lock'' and ''Num Lock'' keys (see below) and computer ''curly'' converts the ''Meta'' modifier key to the ''Alt'' modifier key.
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 |
| switchCorners | corners | See switchCorners below. |
| switchCornerSize | integer | see switchCornerSize below. |
| shift | shift ctrl alt meta super none | Map the server's shift modifer to different key on a client computer |
| ctrl | shift ctrl alt meta super none | Map the server's ctrl modifer to different key on a client computer |
| alt | shift ctrl alt meta super none | Map the server's alt modifer to different key on a client computer |
| meta | shift ctrl alt meta super none | Map the server's meta modifer to different key on a client computer |
| super | shift ctrl alt meta super none | Map the server's super modifer to different key on a client computer |
''args'' is a list of computer names just like in the ''screens'' section except each computer is followed by a list of aliases, one per line, not followed by a colon. An ''alias'' is a computer name and must be unique. When searching for computers each alias is equivalent to the computer name it aliases. So a client can connect using its canonical computer name or any of its aliases.
Computer ''larry'' is also known as ''larry.stooges.com'' and can connect as either name. Computer ''curly'' is also known as ''shemp'' (hey, it's just an example).
''args'' is a list of computer names just like in the ''screens'' section except each computer is followed by a list of links, one per line. Each link has the form:
A link indicates which computer is adjacent in the given direction.
Each side of a link can specify a range which defines a portion of an edge. A range on the direction is the portion of edge you can leave from while a range on the computer is the portion of edge you'll enter into. Ranges are optional and default to the entire edge. All ranges on a particular direction of a particular computer must not overlap.
A ''range'' is written as (start,end). Both ''start'' and ''end'' are percentages in the range 0 to 100, inclusive. The start must be less than the end. 0 is the left or top of an edge and 100 is the right or bottom.
This indicates that computer ''larry'' is to the right of computer ''moe'' (so moving the cursor off the right edge of ''moe'' would make it appear at the left edge of ''larry''), the left half of curly is above the right half of ''moe'', ''moe'' is to the left of ''larry'' (edges are not necessarily symmetric so you have to provide both directions), the right half of curly is above the left half of ''larry'', all of ''moe'' is below the left half of ''curly'', and the left half of ''larry'' is below the right half of ''curly''.
Note that links do not have to be symmetrical; for instance, here the edge between ''moe'' and ''curly'' maps to different ranges depending on if you're going up or down. In fact links don't have to be bidirectional. You can configure the right of ''moe'' to go to ''larry'' without a link from the left of ''larry'' to ''moe''. It's possible to configure a computer with no outgoing links; the cursor will get stuck on that computer unless you have a hot key configured to switch off of that computer.
''args'' is a list of lines of the form name = value. These set the global options.
| Options | Value Values | Description |
|---|---|---|
| protocol | barrier or synergy | The protocol to use when saying hello to clients. Can be set to barrier or synergy. If not set barrier is used as the default |
| heartbeat | integer (N) | The server will expect each client to send a message no less than every N milliseconds. If no message arrives from a client within 3N seconds the server forces that client to disconnect. If deskflow fails to detect clients disconnecting while the server is sleeping or vice versa, try using this option. |
| 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. |
| switchDelay | integer | Deskflow won't switch computers when the mouse reaches edge of a computer unless it stays on the edge for N milliseconds. This helps prevent unintentional switching when working near an edge. |
| switchDoubleTap | integer(N) | Deskflow won't switch computers when the mouse reaches the edge of a computer unless it's moved away from the edge and then back to the edge within N milliseconds. With the option you have to quickly tap the edge twice to switch. This helps prevent unintentional switching when working near the edge. |
| screenSaverSync | true or false | ''Note: Removed in v1.14.1'' If set to ''false'' then Deskflow won't synchronize screen savers. Client screen savers will start according to their individual configurations. The server screen saver won't start if there is input, even if that input is directed toward a client computer. |
| relativeMouseMoves | true or false | If set to ''true'' then secondary computers move the mouse using relative rather than absolute mouse moves when and only when the cursor is locked to the computer (by ''Scroll Lock'' or a configured hot key). This is intended to make Deskflow work better with certain games. If set to ''false'' or not set then all mouse moves are absolute. |
| clipboardSharing | true or false | If set to ''true'' then clipboard sharing will be enabled and the ''clipboardSharingSize'' setting will be used. If set to false, then clipboard sharing will be disabled and the the ''clipboardSharingSize'' setting will be ignored. |
| clipboardSharingSize | integer (N) | Deskflow will send a maximum of N kilobytes of clipboard data to another computer when the mouse transitions to that computer. |
| win32KeepForeground | true or false | If set to ''true'' (the default), Deskflow will grab the foreground focus on a Windows server (thereby putting all other windows in the background) upon switching to a client. If set to ''false'', it will leave the currently foreground window in the foreground. Deskflow grabs the focus to avoid issues with other apps interfering with Deskflow's ability to read the hardware inputs. |
| keystroke(key) | actions | Binds the ''key'' combination key to the given ''actions''. ''key'' is an optional list of modifiers (''shift'', ''control'', ''alt'', ''meta'' or ''super'') optionally followed by a character or a key name, all separated by + (plus signs). You must have either modifiers or a character/key name or both. See below for valid key names and actions. Keyboard hot keys are handled while the cursor any computer. Separate actions can be assigned to press and release. |
| mousebutton(button) | actions | Binds the modifier and mouse button combination ''button'' to the given ''actions''. ''button'' is an optional list of modifiers (''shift'', ''control'', ''alt'', ''meta'' or ''super'') followed by a button number. The primary button (the left button for right handed users) is button 1, the middle button is 2, etc. Actions can be found below. Mouse button actions are not handled while the cursor is on the server. You cannot use these to perform an action while on the server. Separate actions can be assigned to press and release. |
You can use both the ''switchDelay'' and ''switchDoubleTap'' options at the same time. Deskflow will switch when either requirement is satisfied.
Actions are two lists of individual actions separated by commas. The two lists are separated by a '';'' (semicolon). Either list can be empty and if the second list is empty then the semicolon is optional. The first list lists actions to take when the condition becomes true (e.g. the hot key or mouse button is pressed) and the second lists actions to take when the condition becomes false (e.g. the hot key or button is released). The condition becoming true is called activation and becoming false is called deactivation. Allowed individual actions are:
: Synthesizes the modifiers and key given in ''key'' which has the same form as described in the ''keystroke'' option. If given, ''computers'' lists the computer or computers to direct the event to, regardless of the active computer. If not given then the event is directed to the active computer only. : ''keyDown'' synthesizes a key press and ''keyUp'' synthesizes a key release. ''keystroke'' synthesizes a key press on activation and a release on deactivation and is equivalent to a ''keyDown'' on activation and ''keyUp'' on deactivation. : ''computers'' is either ''*'' (asterisk) to indicate all computers or a '':'' (colon) separated list of computer names. (Note that the computer name must have already been encountered in the configuration file so you'll probably want to put ''actions'' at the bottom of the file.)
Valid key names are:
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.
This example comes from doc/deskflow-basic.conf
The text config allows computers to be wrapped around. For example, with two machines (a server and a client), the mouse can go off the right of the server onto the left side of the client, then off the right side of the client back onto the left side of server. This config also uses ''Ctrl''+''Super''+(''left arrow''/''right arrow'') to switch between machines on keypress.
The following screen config allows the mapping for ''Alt'' to ''AltGr''. Although this may not work, see [https://github.com/deskflow/deskflow-core/issues/4411 bug #4411].
See also: the man page for ''deskflow-core''.
Stack one computer on top of another's.
Align all computers horizontally.
Span one computer across the two other computers.
1.16.1