LinuxCommandLibrary

gtk-query-immodules-3.0

List available GTK 3 input method modules

SYNOPSIS

gtk-query-immodules-3.0 [--update-cache] [--language=ll_CC]...

PARAMETERS

--update-cache
    This option forces an update of the immodules.cache file. This happens automatically if no cache exists or it is out of date.

--language=ll_CC
    Specifies the language code for which the cache file should be generated. This can be used to generate separate cache files for different languages. For example: --language=en_US

[immodule-file]...
    Specifies one or more specific input method module files (.so) to scan and include in the output. If specified, only the given modules will be processed; otherwise, the directories in GTK_IMMODULEDIR will be scanned.

DESCRIPTION

The gtk-query-immodules-3.0 command is a utility used to create or update the input method module cache file used by GTK+ 3.0 applications. GTK+ uses this cache to efficiently determine which input method modules are available on the system and their capabilities. Input method modules (IM modules) provide support for entering text in various languages, particularly those with complex character sets, by handling input events and converting them into Unicode characters.

Running gtk-query-immodules-3.0 generates a text file (typically located in /usr/lib/gtk-3.0/3.0.0/immodules.cache) that contains information about each IM module found on the system. This includes the module's name, filename, capabilities, and other relevant properties. The command scans directories specified by the GTK_IMMODULEDIR environment variable for .so files and extracts information from them. By keeping this cache up-to-date, GTK+ can quickly load and use the appropriate IM modules for a given application and user locale. If this cache is missing or out of date, applications might not be able to properly handle text input from certain languages or input methods. It is recommended to run this command after installing new IM modules.

CAVEATS

The command's behavior is highly dependent on the contents of the GTK_IMMODULEDIR environment variable and the available IM modules on the system. Incorrect configuration can lead to issues with input method support in GTK+ applications. Ensure that GTK_IMMODULEDIR is properly set and points to the correct location of input method modules.

ENVIRONMENT VARIABLES

GTK_IMMODULEDIR: Specifies a colon-separated list of directories to search for input method modules. If not set, a default system-dependent path is used.

GTK_PATH: Specifies a colon-separated list of directories to search for GTK+ modules.

GTK_DEBUG: If set, GTK+ will output debug information during input method module loading.

SEE ALSO

gtk-im-context-simple(1), gtk3-demo(1)

Copied to clipboard