Configuration files

Superkb can be configured by setting directives in the following two files (listed in parsing order):

• /etc/superkbrc
• $HOME/.superkbrc in the user's home directory (notice the dot before the filename)

Parsing the files in that order allows system defaults to be set in /etc/superkbrc and allow users to extend and override settings in the $HOME/.superkbrc file.

Syntax

Both files follow identical syntactic rules:

Tokens

Tokens are separated by spaces. If spaces are needed within the same token, you need to enclose it in double-quotes.

Directives

Directives usually follow the KEYWORD option1 option2 ... syntax. Keywords are case-sensitive and must be in upper case.

Parsing order

The files are parsed as scripts. This means that you may override a previous directive by setting the directive later. If a directive affects other directives (like FEEDBACK_STRINGS_AUTOQUOTE) is must be set before the affected directives, and may be later disabled for another set of directives.

Comments

Comments are indicated by a pound sign (#) and the rest of the line is ignored.

Basic directives

(This list is not complete)

BACKGROUND r g b

Sets the background color for the rendered keyboard.

DELAY seconds

Sets the delay for the keyboard to appear after holding down the Super key.

FOREGROUND r g b

Sets the foreground color for the rendered keyboard.

USE_GRADIENTS 0 or 1

Enable or disable the use of gradients on the keyboard hints window. (Superkb >= 0.22)

KEY COMMAND key mask command icon [feedback]

Binds a key to run an arbitrary command.

KEY DOCUMENT key mask document icon [feedback]

Binds a key to open a document using the document handler.

WELCOME_CMD command

Specifies a program to execute on successful Superkb startup.

Advanced directives

(This list is not complete)

DOCUMENT_HANDLER command

Specifies the program to use to launch a document bound to a key via the KEY DOCUMENT directive.

DRAWKBLIB library

Sets Superkb to use either Xlib or Cairo for rendering the keyboard on screen.

FEEDBACK_HANDLER command

Specifies the program to use to provide launching feedback.

FEEDBACK_STRINGS_AUTOQUOTE 0 or 1

Automatically single-quotes feedback strings on KEY commands. (Superkb >= 0.21)

FONT fontname

The name of the font to use. If using [[DRAWKBLIB]] xlib, fontname should be an XLFD name. If [[DRAWKBLIB]] cairo, it should be a font description understandable by Pango.

IMAGELIB library

Sets Superkb to use either Imlib2 or Gdk-pixbuf to load and render icon files. Only important when using the [[DRAWKBLIB]] xlib directive.

SQUASHED_STATES mask

Specifies the keyboard states to ignore when comparing with the mask parameter in a KEY directive. (Superkb >= 0.21)

SUPERKEY_REPLAY 0 or 1

Sets whether the Super key should be resent to the original input window if not used to launch anything.

SUPERKEY1_STRING keysym

Name of the key to be used as one of the hot keys. Try using xev to find key names. Default: Super_L.

SUPERKEY2_STRING keysym

Name of the key to be used as the other hot key. Try using xev to find key names. Default: Super_R.

SUPERKEY1_CODE keycode

Code of the key to be used as one of the hot keys. Try using xev to find key codes. Set it to 0 to disable the first hot key.

SUPERKEY2_STRING keysym

Code of the key to be used as the other hot key. Try using xev to find key names. Set it to 0 to disable the second hot key.