Pileus Git - ~andy/gtk/blob - docs/reference/gtk/gtk-update-icon-cache-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-update-icon-cache">
   6
   7 <refmeta>
   8 <refentrytitle>gtk-update-icon-cache-3.0</refentrytitle>
   9 <manvolnum>1</manvolnum>
  10 </refmeta>
  11
  12 <refnamediv>
  13 <refname>gtk-update-icon-cache-3.0</refname>
  14 <refpurpose>Icon theme caching utility</refpurpose>
  15 </refnamediv>
  16
  17 <refsynopsisdiv>
  18 <cmdsynopsis>
  19 <command>gtk-update-icon-cache-3.0</command>
  20 <arg choice="opt">--force</arg>
  21 <arg choice="opt">--ignore-theme-index</arg>
  22 <arg choice="opt">--index-only</arg>
  23 <arg choice="opt">--source<arg>name</arg></arg>
  24 <arg choice="opt">--quiet</arg>
  25 <arg choice="opt">--validate</arg>
  26 <arg choice="req">iconpath</arg>
  27 </cmdsynopsis>
  28 </refsynopsisdiv>
  29
  30 <refsect1><title>Description</title>
  31 <para>
  32   <command>gtk-update-icon-cache-3.0</command> creates mmap()able cache
  33   files for icon themes.
  34 </para>
  35 <para>
  36   It expects to be given the path to a icon theme directory containing an
  37   <filename>index.theme</filename>, e.g. <filename>/usr/share/icons/hicolor</filename>,
  38   and writes a <filename>icon-theme.cache</filename> containing cached
  39   information about the icons in the directory tree below the given directory.
  40 </para>
  41 <para>
  42   GTK+ can use the cache files created by <command>gtk-update-icon-cache-3.0</command>
  43   to avoid a lot of system call and disk seek overhead when the application
  44   starts. Since the format of the cache files allows them to be mmap()ed
  45   shared between multiple applications, the overall memory consumption is
  46   reduced as well.
  47 </para>
  48 </refsect1>
  49
  50 <refsect1><title>Options</title>
  51 <variablelist>
  52   <varlistentry>
  53     <term>--force</term>
  54     <term>-f</term>
  55     <listitem><para>Overwrite an existing cache file even if it appears to be
  56          uptodate.</para></listitem>
  57   </varlistentry>
  58
  59   <varlistentry>
  60     <term>--ignore-theme-index</term>
  61     <term>-t</term>
  62     <listitem><para>Don't check for the existence of 'index.theme' in the icon
  63      theme directory. Without this option, <command>gtk-update-icon-cache-3.0</command>
  64      refuses to create an icon cache in a directory which does not appear to
  65      be the toplevel directory of an icon theme.
  66     </para></listitem>
  67   </varlistentry>
  68
  69   <varlistentry>
  70     <term>--index-only</term>
  71     <term>-i</term>
  72     <listitem><para>Don't include image data in the cache.
  73     </para></listitem>
  74   </varlistentry>
  75
  76   <varlistentry>
  77     <term>--source</term>
  78     <term>-c</term>
  79     <listitem><para>Output a C header file declaring a constant
  80      <replaceable>name</replaceable> with the contents of the icon
  81      cache.</para></listitem>
  82   </varlistentry>
  83
  84   <varlistentry>
  85     <term>--quiet</term>
  86     <term>-q</term>
  87     <listitem><para>Turn off verbose output.
  88     </para></listitem>
  89   </varlistentry>
  90
  91   <varlistentry>
  92     <term>--validate</term>
  93     <term>-v</term>
  94     <listitem><para>Validate existing icon cache.
  95     </para></listitem>
  96   </varlistentry>
  97 </variablelist>
  98 </refsect1>
  99
 100 <refsect1><title>Bugs</title>
 101 <para>
 102 None known yet.
 103 </para>
 104 </refsect1>
 105
 106 </refentry>
 107
 108