Pileus Git - ~andy/gtk/blob - docs/reference/gtk/gtk-update-icon-cache.xml

   1 <refentry id="gtk-update-icon-cache">
   2
   3 <refmeta>
   4 <refentrytitle>gtk-update-icon-cache</refentrytitle>
   5 <manvolnum>1</manvolnum>
   6 </refmeta>
   7
   8 <refnamediv>
   9 <refname>gtk-update-icon-cache</refname>
  10 <refpurpose>Icon theme caching utility</refpurpose>
  11 </refnamediv>
  12
  13 <refsynopsisdiv>
  14 <cmdsynopsis>
  15 <command>gtk-update-icon-cache</command>
  16 <arg choice="opt">--force</arg>
  17 <arg choice="req">iconpath</arg>
  18 </cmdsynopsis>
  19 </refsynopsisdiv>
  20
  21 <refsect1><title>Description</title>
  22 <para>
  23 <command>gtk-update-icon-cache</command> creates mmap()able cache files for
  24 icon themes.
  25 </para>
  26 <para>
  27 If expects to be given the path to a icon theme directory, e.g.
  28 <filename>/usr/share/icons/hicolor</filename>, and writes a
  29 <filename>icon-theme.cache</filename> containing cached information
  30 about the icons in the directory tree below the given directory.
  31 </para>
  32 <para>
  33 GTK+ can use the cache files created by <command>gtk-update-icon-cache</command>
  34 to avoid a lot of system call and disk seek overhead when the application starts.
  35 Since the format of the cache files allows them to be mmap()ed shared between
  36 multiple applications, the overall memory consumption is reduced as well.
  37 </para>
  38 <para>
  39 If called with the --force argument,
  40 <command>gtk-update-icon-cache</command> will overwrite an existing cache
  41 file even if it appears to be uptodate.
  42 </para>
  43 </refsect1>
  44
  45 <refsect1><title>Bugs</title>
  46 <para>
  47 None known yet.
  48 </para>
  49 </refsect1>
  50
  51 </refentry>
  52
  53