docs/reference/gtk/gtk-query-immodules-3.0.xml

<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
]>
<refentry id="gtk-query-immodules-3.0">

<refentryinfo>
  <title>gtk-query-immodules-3.0</title>
  <productname>GTK+</productname>
  <authorgroup>
    <author>
      <contrib>Developer</contrib>
      <firstname>Matthias</firstname>
      <surname>Clasen</surname>
    </author>
  </authorgroup>
</refentryinfo>

<refmeta>
  <refentrytitle>gtk-query-immodules-3.0</refentrytitle>
  <manvolnum>1</manvolnum>
  <refmiscinfo class="manual">User Commands</refmiscinfo>
</refmeta>

<refnamediv>
  <refname>gtk-query-immodules-3.0</refname>
  <refpurpose>Input method module registration utility</refpurpose>
</refnamediv>

<refsynopsisdiv>
<cmdsynopsis>
<command>gtk-query-immodules-3.0</command>
<arg choice="opt">--update-cache</arg>
<arg choice="opt" rep="repeat">MODULE</arg>
</cmdsynopsis>
</refsynopsisdiv>

<refsect1><title>Description</title>
<para>
<command>gtk-query-immodules-3.0</command> collects information about loadable
input method modules for GTK+ and writes it to the default cache file
location, or to <filename>stdout</filename>.
</para>
<para>
If called without arguments, it looks for modules in the GTK+ input method
module path.
</para>
<para>
If called with arguments, it looks for the specified modules. The arguments
may be absolute or relative paths.
</para>

<para>
Normally, the output of <command>gtk-query-immodules-3.0</command> is written
to <filename><replaceable>libdir</replaceable>/gtk-3.0/3.0.0/immodules.cache</filename>,
where GTK+ looks for it by default. If it is written to some other location,
the <envar>GTK_IM_MODULE_FILE</envar> environment variable can be set to point
GTK+ at the file.
</para>
</refsect1>

<refsect1><title>Options</title>
<variablelist>
  <varlistentry>
    <term>--update-cache</term>
    <listitem><para>Write the output to the default cache location instead of
                    <filename>stdout</filename></para></listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1><title>Files</title>
<variablelist>
  <varlistentry>
    <term><filename><replaceable>libdir</replaceable>/gtk-3.0/3.0.0/immodules.cache</filename></term>
    <listitem><para>The default im cache file used by GTK+ applications</para></listitem>
  </varlistentry>
</variablelist>

</refsect1>

<refsect1><title>Environment</title>
<variablelist>
  <varlistentry>
    <term><link linkend="gtk-path"><envar>GTK_PATH</envar></link></term>
    <listitem><para>Prepends directories to the input method module path</para></listitem>
  </varlistentry>
  <varlistentry>
    <term><link linkend="gtk-im-module-file"><envar>GTK_IM_MODULE_FILE</envar></link></term>
    <listitem><para>Specifies an alternative im module cache for GTK+
    applications</para></listitem>
  </varlistentry>
</variablelist>
</refsect1>

</refentry>