Current File : //usr/man/man1/gtk-query-immodules-2.0.1

'\" te
.TH gtk-query-immodules-2\&.0 1 "21 Oct 2007" "SunOS 5.11" "User Commands"
.SH "NAME"
gtk-query-immodules-2\&.0 \- create a cache file used by GTK+ to efficiently locate input method
modules
.SH "SYNOPSIS"
.PP
\fBgtk-query-immodules-2\&.0\fR [\fB\fIimmodule\fR\fR] [\fB\fIimmodule\fR\fR\&...]
.SH "DESCRIPTION"
.PP
\fBgtk-query-immodules-2\&.0\fR searches for input method (IM) modules for GTK+ and
and writes information about them to \fBstdout\fR\&.  If the output
is redirected to \fB/etc/gtk-2\&.0/gtk\&.immodules\fR, 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\&.
.PP
IM modules can be selected by right-clicking on input fields when running GTK+
programs\&. An input method is a software component that converts 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\&. 
.PP
If any modules are specified on the command line, \fBgtk-query-immodules-2\&.0\fR only
looks at those particular files\&. If no modules are specified on the command
line, \fBgtk-query-immodules-2\&.0\fR scans the user\&'s GTK_PATH environment variable
and looks at all IM modules that are specified there\&.
.PP
When run, \fBgtk-query-immodules-2\&.0\fR 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\&.
.SH "OPTIONS"
.PP
None\&.
.SH "OPERANDS"
.PP
The following operands are supported:
.sp
.ne 2
.mk
\fB\fB\fIimmodule\fR\fR\fR
.in +16n
.rt
Specify the pathname to an IM module\&. This can be a full pathname, or relative
to the current working directory\&.
.sp
.sp 1
.in -16n
.SH "EXAMPLES"
.PP
\fBExample 1: Installing a new Input Method module \fBmyimmodule\&.so\fR\fR
.PP
.PP
.nf
example% \fBgtk_version=`pkg-config --variable=gtk_binary_version gtk-2\&.0`\fR
.fi
.PP
.nf
example% \fBcp myimmodule\&.so \fB/usr/lib/gtk-2\&.0/$gtk_version/immodules\fR\fR
.fi
.PP
.nf
example% \fBgtk-query-immodules-2\&.0 > \fB/etc/gtk-2\&.0/gtk\&.immodules\fR\fR
.fi
.SH "ENVIRONMENT VARIABLES"
.PP
See
\fBenviron\fR(5)
for descriptions of the following environment variables that affect the
execution of \fBgtk-query-immodules-2\&.0\fR:
.sp
.ne 2
.mk
\fB\fBGTK_PATH\fR\fR
.in +24n
.rt
Specifies directories to prepend to the input method module path\&.
.sp
.sp 1
.in -24n
.sp
.ne 2
.mk
\fB\fBGTK_IM_MODULE\fR\fR
.in +24n
.rt
Specifies what IM modules to use, in preference to the IM module determined
from the locale
.sp
.sp 1
.in -24n
.sp
.ne 2
.mk
\fB\fBGTK_IM_MODULE_FILE\fR\fR
.in +24n
.rt
Specifies the file that lists the IM modules to load\&. This environment variable
overrides the \fBim_module_file\fR specified in the RC files,
which in turn overrides the default value in the system
\fBgtk\&.immodules\fR file\&.
.sp
.sp 1
.in -24n
.SH "EXIT STATUS"
.PP
The following exit values are returned:
.sp
.ne 2
.mk
\fB\fB0\fR\fR
.in +9n
.rt
Application exited successfully
.sp
.sp 1
.in -9n
.sp
.ne 2
.mk
\fB\fB>0\fR\fR
.in +9n
.rt
Application exited with failure
.sp
.sp 1
.in -9n
.SH "FILES"
.PP
The following files are used by this application:
.sp
.ne 2
.mk
\fB\fB/usr/bin/gtk-query-immodules-2\&.0\fR\fR
.sp .6
.in +4
The command-line executable for the application\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB\fB/usr/lib/gtk-2\&.0/\fIversion\fR/immodules\fR\fR
.sp .6
.in +4
Default location of IM modules\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB\fB/etc/gtk-2\&.0/gtk\&.immodules\fR\fR
.sp .6
.in +4
The GTK+ input method modules file\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB\fB/usr/share/gtk-doc/html/gtk\fR\fR
.sp .6
.in +4
Location of developer documentation
.sp
.sp 1
.in -4
.SH "ATTRIBUTES"
.PP
See
\fBattributes\fR(5)
for descriptions of the following attributes:
.sp
.TS
tab() allbox;
cw(2.750000i)| cw(2.750000i)
lw(2.750000i)| lw(2.750000i).
ATTRIBUTE TYPEATTRIBUTE VALUE
Availabilitylibrary/desktop/gtk2
Interface stabilityCommitted
.TE
.sp
.SH "SEE ALSO"
.PP
\fBgdk-pixbuf-csource\fR(1),
\fBgdk-pixbuf-query-loaders\fR(1),
\fBglib-genmarshal\fR(1),
\fBglib-gettextize\fR(1),
\fBglib-mkenums\fR(1),
\fBgobject-query\fR(1),
\fBgtk-update-icon-cache\fR(1),
\fBlibgtk-x11-2\&.0\fR(3),
\fBattributes\fR(5),
\fBenviron\fR(5),
\fBgnome-interfaces\fR(5)
.SH "NOTES"
.PP
Written by Brian Cameron, Sun Microsystems Inc\&., 2003, 2006, 2007\&.
...\" created by instant / solbook-to-man, Thu 20 Mar 2014, 02:30
...\" LSARC 2001/384 Gtk+ 2.0 / glib 2.0
...\" LSARC 2001/781 location of GTK/Glib
...\" PSARC 2001/804 GTK/Glib becomes Contracted External