gtk-query-immodules-2.0(1)					   User Commands					gtk-query-immodules-2.0(1)

NAME

       gtk-query-immodules-2.0 - create a cache file used by GTK+ to efficiently locate input method modules

SYNOPSIS

       gtk-query-immodules-2.0 [immodule] [immodule...]

DESCRIPTION

       gtk-query-immodules-2.0	searches for input method (IM) modules for GTK+ and and writes information about them to stdout.  If the output is
       redirected to /etc/gtk-2.0/gtk.immodules, then this will cause the GTK+ library to use these modules by default.  This program is typically
       used by developers who are packaging GTK+ software which adds additional modules.

       IM  modules can be selected by right-clicking on input fields when running GTK+ programs. An input method is a software component that con-
       verts key presses into text input that cannot be typed directly. Input methods are normally used to input text for languages that have more
       characters  than  can  fit on a standard keyboard. Input methods are commonly used for Japanese, Chinese, and Korean text but are also used
       for other languages such as Thai and Hindi.

       If any modules are specified on the command line, gtk-query-immodules-2.0 only looks at those particular files. If no modules are specified
       on  the command line, gtk-query-immodules-2.0 scans the user's GTK_PATH environment variable and looks at all IM modules that are specified
       there.

       When run, gtk-query-immodules-2.0 creates context information for each module. Each module has one or more contexts. If no IM  modules  are
       specified on the command line, the scanned paths are included as a comment in the output.

OPTIONS

       None.

OPERANDS

       The following operands are supported:

       immodule        Specify the pathname to an IM module. This can be a full pathname, or relative to the current working directory.

EXAMPLES

       Example 1: Installing a new Input Method module myimmodule.so

       example% gtk_version=`pkg-config --variable=gtk_binary_version gtk-2.0`

       example% cp myimmodule.so /usr/lib/gtk-2.0/$gtk_version/immodules

       example% gtk-query-immodules-2.0 > /etc/gtk-2.0/gtk.immodules

ENVIRONMENT VARIABLES

       See environ(5) for descriptions of the following environment variables that affect the execution of gtk-query-immodules-2.0:

       GTK_PATH 	       Specifies directories to prepend to the input method module path.

       GTK_IM_MODULE	       Specifies what IM modules to use, in preference to the IM module determined from the locale

       GTK_IM_MODULE_FILE      Specifies the file that lists the IM modules to load. This environment variable overrides the im_module_file speci-
			       fied in the RC files, which in turn overrides the default value in the system gtk.immodules file.

EXIT STATUS

       The following exit values are returned:

       0	Application exited successfully

       >0	Application exited with failure

FILES

       The following files are used by this application:

       /usr/bin/gtk-query-immodules-2.0

	   The command-line executable for the application.

       /usr/lib/gtk-2.0/version/immodules

	   Default location of IM modules.

       /etc/gtk-2.0/gtk.immodules

	   The GTK+ input method modules file.

       /usr/share/gtk-doc/html/gtk

	   Location of developer documentation

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Availability		     |SUNWgnome-base-libs-devel    |
       +-----------------------------+-----------------------------+
       |Interface stability	     |Committed 		   |
       +-----------------------------+-----------------------------+

SEE ALSO

       gdk-pixbuf-csource(1), gdk-pixbuf-query-loaders(1), glib-genmarshal(1), glib-gettextize(1), glib-mkenums(1), gobject-query(1),  gtk-update-
       icon-cache(1), libgtk-x11-2.0(3), attributes(5), environ(5), gnome-interfaces(5)

NOTES

       Written by Brian Cameron, Sun Microsystems Inc., 2003, 2006, 2007.

SunOS 5.11							    21 Oct 2007 					gtk-query-immodules-2.0(1)