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 <refentryinfo>
   8   <title>gtk-query-immodules-3.0</title>
   9   <productname>GTK+</productname>
  10   <authorgroup>
  11     <author>
  12       <contrib>Developer</contrib>
  13       <firstname>Matthias</firstname>
  14       <surname>Clasen</surname>
  15     </author>
  16   </authorgroup>
  17 </refentryinfo>
  18
  19 <refmeta>
  20   <refentrytitle>gtk-query-immodules-3.0</refentrytitle>
  21   <manvolnum>1</manvolnum>
  22   <refmiscinfo class="manual">User Commands</refmiscinfo>
  23 </refmeta>
  24
  25 <refnamediv>
  26   <refname>gtk-query-immodules-3.0</refname>
  27   <refpurpose>Input method module registration utility</refpurpose>
  28 </refnamediv>
  29
  30 <refsynopsisdiv>
  31 <cmdsynopsis>
  32 <command>gtk-query-immodules-3.0</command>
  33 <arg choice="opt">--update-cache</arg>
  34 <arg choice="opt" rep="repeat">MODULE</arg>
  35 </cmdsynopsis>
  36 </refsynopsisdiv>
  37
  38 <refsect1><title>Description</title>
  39 <para>
  40 <command>gtk-query-immodules-3.0</command> collects information about loadable
  41 input method modules for GTK+ and writes it to the default cache file
  42 location, or to <filename>stdout</filename>.
  43 </para>
  44 <para>
  45 If called without arguments, it looks for modules in the GTK+ input method
  46 module path.
  47 </para>
  48 <para>
  49 If called with arguments, it looks for the specified modules. The arguments
  50 may be absolute or relative paths.
  51 </para>
  52
  53 <para>
  54 Normally, the output of <command>gtk-query-immodules-3.0</command> is written
  55 to <filename><replaceable>libdir</replaceable>/gtk-3.0/3.0.0/immodules.cache</filename>,
  56 where GTK+ looks for it by default. If it is written to some other location,
  57 the <envar>GTK_IM_MODULE_FILE</envar> environment variable can be set to point
  58 GTK+ at the file.
  59 </para>
  60 </refsect1>
  61
  62 <refsect1><title>Options</title>
  63 <variablelist>
  64   <varlistentry>
  65     <term>--update-cache</term>
  66     <listitem><para>Write the output to the default cache location instead of
  67                     <filename>stdout</filename></para></listitem>
  68   </varlistentry>
  69 </variablelist>
  70 </refsect1>
  71
  72 <refsect1><title>Files</title>
  73 <variablelist>
  74   <varlistentry>
  75     <term><filename><replaceable>libdir</replaceable>/gtk-3.0/3.0.0/immodules.cache</filename></term>
  76     <listitem><para>The default im cache file used by GTK+ applications</para></listitem>
  77   </varlistentry>
  78 </variablelist>
  79
  80 </refsect1>
  81
  82 <refsect1><title>Environment</title>
  83 <variablelist>
  84   <varlistentry>
  85     <term><link linkend="gtk-path"><envar>GTK_PATH</envar></link></term>
  86     <listitem><para>Prepends directories to the input method module path</para></listitem>
  87   </varlistentry>
  88   <varlistentry>
  89     <term><link linkend="gtk-im-module-file"><envar>GTK_IM_MODULE_FILE</envar></link></term>
  90     <listitem><para>Specifies an alternative im module cache for GTK+
  91     applications</para></listitem>
  92   </varlistentry>
  93 </variablelist>
  94 </refsect1>
  95
  96 </refentry>