Pileus Git - ~andy/gtk/blob - docs/reference/gtk/gtk-query-immodules-3.0.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
   4 ]>
   5 <refentry id="gtk-query-immodules-3.0">
   6
   7 <refmeta>
   8   <refentrytitle>gtk-query-immodules-3.0</refentrytitle>
   9   <manvolnum>1</manvolnum>
  10   <refmiscinfo class="manual">User Commands</refmiscinfo>
  11 </refmeta>
  12
  13 <refnamediv>
  14   <refname>gtk-query-immodules-3.0</refname>
  15   <refpurpose>Input method module registration utility</refpurpose>
  16 </refnamediv>
  17
  18 <refsynopsisdiv>
  19 <cmdsynopsis>
  20 <command>gtk-query-immodules-3.0</command>
  21 <arg choice="opt">--update-cache</arg>
  22 <arg choice="opt" rep="repeat">module</arg>
  23 </cmdsynopsis>
  24 </refsynopsisdiv>
  25
  26 <refsect1><title>Description</title>
  27 <para>
  28 <command>gtk-query-immodules-3.0</command> collects information about loadable
  29 input method modules for GTK+ and writes it to the default cache file
  30 location, or to <filename>stdout</filename>.
  31 </para>
  32 <para>
  33 If called without arguments, it looks for modules in the GTK+ input method
  34 module path.
  35 </para>
  36 <para>
  37 If called with arguments, it looks for the specified modules. The arguments
  38 may be absolute or relative paths.
  39 </para>
  40 <para>
  41 Normally, the output of <command>gtk-query-immodules-3.0</command> is written
  42 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
  43 location, the environment variable <link linkend="gtk-im-module-file"><envar>GTK_IM_MODULE_FILE</envar></link>
  44 can be set to point GTK+ at the file.
  45 </para>
  46 </refsect1>
  47
  48 <refsect1><title>Options</title>
  49 <variablelist>
  50   <varlistentry>
  51     <term>--update-cache</term>
  52     <listitem><para>Write the output to the default cache location instead of
  53                     <filename>stdout</filename></para></listitem>
  54   </varlistentry>
  55 </variablelist>
  56 </refsect1>
  57
  58 <refsect1><title>Environment</title>
  59 <para>
  60 The environment variable <link linkend="gtk-path"><envar>GTK_PATH</envar></link>
  61 can be used to prepend directories to the input method module path.
  62 </para>
  63 </refsect1>
  64
  65 <refsect1><title>Bugs</title>
  66 <para>
  67 None known yet.
  68 </para>
  69 </refsect1>
  70
  71 </refentry>
  72
  73