gtk-query-immodules-2.0

gtk-query-immodules-2.0 [--include-path=] [--exclude-path=] [--update-cache] > gtk.immodules

--include-path=
    Specifies an additional directory to search for input method modules. You can use this option multiple times to include several directories.

--exclude-path=
    Specifies a directory to exclude from the search for input method modules. Useful for ignoring specific directories that might contain problematic or irrelevant modules. Can be used multiple times.

--update-cache
    Updates the existing cache file instead of creating a new one. This option is typically not used directly; it's more common to redirect the output to a file.

The `gtk-query-immodules-2.0` command is a utility provided by the GTK (GIMP Toolkit) library. Its primary function is to generate a cache file containing information about available input method modules (IMMs). IMMs are libraries that provide input methods for entering characters in languages with complex writing systems, such as Chinese, Japanese, and Korean (CJK). This cache file allows GTK applications to quickly identify and load appropriate IMMs, enabling users to input text in these languages.

The command scans the system for shared library files that conform to the GTK IMM interface. It extracts metadata from these libraries, including the module name, description, and supported languages. This data is then formatted into a file (typically `gtk.immodules`) and placed in a location where GTK can find it (usually `/usr/lib/gtk-2.0/2.10.0/immodules/`).

Without a properly generated IMM cache, GTK applications might not be able to correctly display or accept input in non-Latin alphabets. `gtk-query-immodules-2.0` is often run automatically during package installation or system updates to ensure that the IMM cache is up-to-date. Running it manually is required if new IMMs have been installed, or existing ones updated.

The output of `gtk-query-immodules-2.0` *must* be redirected to a file (typically `gtk.immodules`). GTK uses this file to determine available input method modules. Incorrectly generated or missing `gtk.immodules` can lead to input method problems in GTK applications. Ensure write permissions for the destination directory.

The most common usage is: `gtk-query-immodules-2.0 > /usr/lib/gtk-2.0/2.10.0/immodules/gtk.immodules`. This generates a new `gtk.immodules` file in the standard location. The location might be different depending on your distribution.

If you encounter issues with input methods in GTK applications, ensure that `gtk-query-immodules-2.0` has been run recently and that the `gtk.immodules` file is present in the correct location. Check for error messages during the execution of `gtk-query-immodules-2.0` which can give hints of problematic input modules.

The `gtk-query-immodules-2.0` command was introduced with GTK 2.0 as part of the toolkit's input method framework. It replaced earlier methods of identifying and managing input method modules. As GTK evolved, the command's functionality has remained largely consistent, reflecting the stability of the GTK input method architecture. It is a critical component for supporting multilingual input in GTK-based applications. The "2.0" in the command name reflects the GTK version it is associated with; a command `gtk-query-immodules-3.0` was released for GTK 3 and so on.

im-config(1)