Global statements

The following statements configure XcontrolX generally or all servers and screens globally.

Hot keys

The statement

hotKey gui
    {Shift|Lock|Control|Mod1|Mod2|Mod3|Mod4|Mod5|none}... 
    [key|none]

specifies a key combination, which causes the display of the dialog box (Graphical user interface). There is no default hot key.

The statement

hotKey |exit
    {Shift|Lock|Control|Mod1|Mod2|Mod3|Mod4|Mod5|none}... 
    [key|none]

defines a key combination which terminates the xcontrolx process. There is no default hot key.

Telepointer

In addition to remote input XcontrolX allows to simultaneously display a telepointer on a slave. The appearance of the telepointer can be configured for each screen (Telepointer) as well as globally:

telepointer
    height height_in_pixels
    label text|server|user|user@server
    foregroundColor color_specification
    backgroundColor color_specification

The telepointer image is composed of an arrow and a text:

The value height_in_pixels determines the height of the arrow without text, 22 pixels by default. The height of the text is proportional to the size of the arrow.

The text can be arbitrary text, or the name of the user executing the xcontrolx program (user), the name of the master (server), or the concatenation of both names (user@server, default).

The color_specification for determining the foreground color or the background color of the telepointer image stands for the color name or for the color value in the format "#RGB", with R meaning red, G meaning green, and B meaning blue (all values are coded in one to four hexadecimal digits). The default colors are "#ffffcccc0000" as foreground color and "#000033336666" for the background color.

The telepointer configuration has no meaning for the master.

Screen border crossing

Switching between screens usually is done by moving the pointer over the appropriate screen border corresponding to the spatial arrangement of the screens (Screen arrangement). XcontrolX offers two ways to avoid an unintentional move to another screen.

The statement

crossDelay period_of_time

defines a short time interval (Points of time and periods of time) the pointer has to wait at the screen border before it jumps to the other screen. The default value of 0 disables this hysteresis.

The statement

crossKnocking on|off

specifies whether the user has to "knock" at the screen border for a second time within one second to move the pointer to the other screen or not (default).

Integration

The xcontrolx process is able to inform other X Window clients about its internal state regarding input (keyboard and pointer device). Therefore X Window properties are stored on the root window of the first screen of the master and of the current slave.

The property named XCONTROLX_POINTER_SLAVE contains the display name of the server showing the mouse pointer, whereas the property XCONTROLX_KEYBOARD_SLAVE specifies the server, which gets keyboard input. Because of the keyboard focus (Keyboard focus) these servers need not to be equal. The properties names XCONTROLX_KEYBOARD_MASTER and XCONTROLX_POINTER_MASTER both contain the display name of the master. If a server is neither master nor slave, the corresponding properties are empty.

The statement

feedback on|off

enables (or disables default) this communication.

Error messages and warnings

The destination of error messages and warnings may be specified by the statement

logDestination -|stdout|stderr|syslog|file_name

If file_name ends with .html or .htm, the messages are output in HTML format, else in plain text format. The default destination depends on the user executing the xcontrolx program: /var/opt/XSOXcontrolX/logs/xcontrolx-user_name.log.