<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
<!--ArborText, Inc., 1988-1999, v.4002-->
<!ENTITY cmd "gtk-update-icon-cache">
<!ENTITY % commonents SYSTEM "smancommon.ent">
%commonents;
<!ENTITY % booktitles SYSTEM "booktitles.ent">
%booktitles;
<!ENTITY suncopy "Copyright (c) 2003,2006,2007 Sun Microsystems, Inc. All Rights Reserved.">
]>
<refentry id="gtk-update-icon-cache-1">
<!-- %Z%%M% %I% %E% SMI; -->
<refmeta>
<refentrytitle>gtk-update-icon-cache</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="date">21 Nov 2007</refmiscinfo>
<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
<refmiscinfo class="software">&release;</refmiscinfo>
<refmiscinfo class="arch">generic</refmiscinfo>
<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
</refmeta>
<indexterm><primary>gtk-update-icon-cache</primary></indexterm>
<indexterm><primary>Icon theme caching utility</primary></indexterm>
<refnamediv id="gtk-update-icon-cache-1-name">
<refname>gtk-update-icon-cache</refname>
<refpurpose>Icon theme caching utility</refpurpose>
</refnamediv>
<refsynopsisdiv id="gtk-update-icon-cache-1-synp"><title>&synp-tt;</title>
<cmdsynopsis><command>&cmd;</command>
<arg choice="opt"><option>-force</option></arg>
<arg choice="opt"><option>-help</option></arg>
<arg choice="opt"><option>-ignore-theme-index</option></arg>
<arg choice="opt"><option>-index-only</option></arg>
<arg choice="opt"><option>-source=<replaceable>name</replaceable></option></arg>
<arg choice="opt"><option>-quiet</option></arg>
<arg choice="opt"><option>-validate</option></arg>
<arg choice="opt"><option role="nodash"><replaceable>iconpath</replaceable></option></arg>
</cmdsynopsis></refsynopsisdiv>

<refsect1 id="gtk-update-icon-cache-1-desc"><title>&desc-tt;</title>
<para>
<command>&cmd;</command> creates cache files for icon themes that can be used
with
<citerefentry><refentrytitle>mmap</refentrytitle>
<manvolnum>2</manvolnum></citerefentry>.
</para>

<para>
It expects to be given the path to an icon theme directory containing an
<filename>index.theme</filename> file, e.g.
<filename>/usr/share/icons/hicolor</filename>, and writes a
<filename>icon-theme.cache</filename> containing cached information about the
icons in the directory tree below the given directory.
</para>

<para>
GTK+ can use the cache files created by gtk-update-icon-cache to avoid a lot
of system call and disk seek overhead when the application starts. Since the
format of the cache files allows them to be mmap()ed shared between multiple
applications, the overall memory consumption is reduced as well.
</para>
</refsect1>

<refsect1 id="glib-genmarshal-1-opts"><title>&opts-tt;</title>
<para>
The following options are supported:
</para>

<variablelist termlength="wide">
<varlistentry>
<term><option>f</option>, <option>-force</option></term>
<listitem><para>
Overwrite an existing cache file even if it appears to be up to date.
</para></listitem></varlistentry>

<varlistentry>
<term><option>?</option>, <option>-help</option></term>
<listitem><para>
Show help options.
</para></listitem></varlistentry>

<varlistentry>
<term><option>t</option>, <option>-ignore-theme-index</option></term>
<listitem><para>
Do not check for the existence of 'index.theme' in the icon theme directory.
Without this option, &cmd; refuses to create an icon cache in a directory which
does not appear to be the toplevel directory of an icon theme.
</para></listitem></varlistentry>

<varlistentry>
<term><option>i</option>, <option>-index-only</option></term>
<listitem><para>Do not include image data in the cache
</para></listitem></varlistentry>

<varlistentry>
<term><option>c</option>, <option>-source</option>=<replaceable>name</replaceable></term>
<listitem><para>
Output a C header file declaring a constant <replaceable>name</replaceable>
with the contents of the icon cache.
</para></listitem></varlistentry>

<varlistentry>
<term><option>q</option>, <option>-quiet</option></term>
<listitem><para>
Turn off verbose output.
</para></listitem></varlistentry>

<varlistentry>
<term><option>v</option>, <option>-validate</option></term>
<listitem><para>
Validate existing icon cache.
</para></listitem></varlistentry>
</variablelist>
</refsect1>

<refsect1 id="gtk-update-icon-cache-1-oper"><title>&oper-tt;</title>
<para>
The following operands are supported:
</para>

<variablelist termlength="medium">
<varlistentry>
<term><option role="nodash"><replaceable>iconpath</replaceable></option></term>
<listitem><para>
The path to an icon theme directory containing an
<filename>index.theme</filename> file.
</para></listitem></varlistentry>
</variablelist>
</refsect1>

<refsect1 id="gtk-update-icon-cache-1-envr"><title>&envr-tt;</title>
<para>
See
<citerefentry><refentrytitle>environ</refentrytitle>
<manvolnum>5</manvolnum></citerefentry>
for descriptions of the following environment variables that affect the
execution of <command>&cmd;</command>: NLSPATH.
</para>
</refsect1>

<refsect1 id="gtk-update-icon-cache-1-exit"><title>&exit-tt;</title>
<para>
The following exit values are returned:
</para>

<variablelist termlength="xtranarrow"><varlistentry>
<term><returnvalue>0</returnvalue></term>
<listitem><para>
Application exited successfully
</para></listitem></varlistentry>
<varlistentry>
<term><returnvalue>>0</returnvalue></term>
<listitem><para>
Application exited with failure
</para>
</listitem></varlistentry>
</variablelist>
</refsect1>

<refsect1 id="gtk-update-icon-cache-1-file"><title>&file-tt;</title>
<para>
The following files are used by this application:
</para>

<variablelist termlength="wide">
<varlistentry>
<term><filename>/usr/bin/&cmd;</filename></term>
<listitem><para>
The command-line executable for the application.
</para></listitem></varlistentry>
<varlistentry>
<term><filename>/usr/share/icons</filename></term><listitem>
<para>
System icon directory
</para></listitem></varlistentry>
<varlistentry>
<term><filename>/usr/share/gtk-doc/html/gtk</filename></term>
<listitem><para>
Location of developer documentation
</para></listitem></varlistentry>
</variablelist>
</refsect1>

<refsect1 id="gtk-update-icon-cache-1-attr"><title>&attr-tt;</title>
<para>
See
<olink targetdocent="REFMAN5" localinfo="attributes-5">
<citerefentry><refentrytitle>attributes</refentrytitle>
<manvolnum>5</manvolnum></citerefentry></olink>
for descriptions of the following attributes:
</para>

<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1">
<colspec colname="COLSPEC0" colwidth="1*">
<colspec colname="COLSPEC1" colwidth="1*">
<thead>
<row>
<entry align="center" valign="middle">ATTRIBUTE TYPE</entry>
<entry align="center" valign="middle">ATTRIBUTE VALUE</entry>
</row>
</thead>
<tbody>
<row>
<entry><para>Availability</para></entry>
<entry><para>library/desktop/gtk2</para></entry>
</row>
<row>
<entry colname="COLSPEC0"><para>Interface stability</para></entry>
<entry colname="COLSPEC1"><para>Committed</para></entry>
</row>
</tbody></tgroup></informaltable>
</refsect1>

<refsect1 id="gtk-update-icon-cache-1-also"><title>&also-tt;</title>
<!--Reference to another man page-->
<!--Reference to a Help manual-->
<!--Reference to a book.-->
<para>
<citerefentry><refentrytitle>gdk-pixbuf-csource</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gdk-pixbuf-query-loaders</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gettext</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>glib-genmarshal</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>glib-gettextize</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>glib-mkenums</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gobject-query</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gtk-query-immodules-2.0</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>mmap</refentrytitle><manvolnum>2</manvolnum></citerefentry>.
<citerefentry><refentrytitle>libgtk-x11-2.0</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>environ</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>

<para>
Latest version of the <citetitle>GNOME Desktop User Guide</citetitle> for your
platform.
</para>
</refsect1>

<refsect1 id="gtk-update-icon-cache-1-note"><title>&note-tt;</title>
<para>
Written by Brian Cameron, Sun Microsystems Inc., 2003, 2006, 2007.
</para>
</refsect1>
</refentry>
