imsettings Documentation: XInput configuration file

XInput configuration file

XInput configuration file — How to create the xinput configuration file for Input Method

Valid parameters for XInput configuration file

The following parameters can be described as the shell environment variables like FOO=BAR in the xinput configuration file.

AUXILIARY_PROGRAM

	AUXILIARY_PROGRAM=<string>

An optional program that may want to bring up for Input Method, such as the panel and the toolbar and so on.

AUXILIARY_ARGS

	AUXILIARY_ARGS=<string>

A list of command line options for AUXILIARY_PROGRAM.

GTK_IM_MODULE

	GTK_IM_MODULE=<string>

GTK+ immodule name that want to use.

ICON

	ICON=<string>

An icon filename to use in third-party applications for the Input Method.

IMSETTINGS_IGNORE_ME

	IMSETTINGS_IGNORE_ME=<boolean>

A parameter to hide Input Method from the inventory.

LONG_DESC

	LONG_DESC=<string>

An optional long description to explain what this Input Method is.

NOT_RUN

	NOT_RUN=<string>

A colon-separated list for desktop names where isn't expected to run Input Method on. currently only GNOME3 is supported as a value.

PREFERENCE_PROGRAM

	PREFERENCE_PROGRAM=<string>

An optional program that set up Input Method.

PREFERENCE_ARGS

	PREFERENCE_ARGS=<string>

A list of command line options for PREFERENCE_PROGRAM.

QT_IM_MODULE

	QT_IM_MODULE=<string>

Qt immodule name that want to use.

SHORT_DESC

	SHORT_DESC=<string>[:string]

An optional short description to explain what this Input Method is. This variable is also used for the key to do something on IMSettings. e.g. to switch Input Method and obtain the information and so on. So this parameter has to be unique. For extra option; depending on the backends support though, this parameter is capable to tell the backend a sub input method, which may be useful if Input Method supports multiple engines.

XIM

	XIM=<string>

A XIM server atom for Input Method, which is used as XMODIFIERS=@im=$XIM.

XIM_PROGRAM

	XIM_PROGRAM=<string>

A XIM server name be brought up to communicate through XIM protocol.

XIM_ARGS

	XIM_ARGS=<string>

A list of command line options for XIM_PROGRAM.