10139N/A<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [

10139N/A<!--ArborText, Inc., 1988-1999, v.4002-->

10139N/A<!ENTITY cmd "gtk-update-icon-cache">

10139N/A<!ENTITY % commonents SYSTEM "smancommon.ent">

10139N/A%commonents;

10139N/A<!ENTITY % booktitles SYSTEM "booktitles.ent">

10139N/A%booktitles;

11904N/A<!ENTITY suncopy "Copyright (c) 2003,2006,2007 Sun Microsystems, Inc. All Rights Reserved.">

10139N/A]>

10139N/A<refentry id="gtk-update-icon-cache-1">

17616N/A<refmeta>

17616N/A<refentrytitle>gtk-update-icon-cache</refentrytitle><manvolnum>1</manvolnum>

11971N/A<refmiscinfo class="date">21 Nov 2007</refmiscinfo>

10139N/A<refmiscinfo class="sectdesc">&man1;</refmiscinfo>

10139N/A<refmiscinfo class="software">&release;</refmiscinfo>

10139N/A<refmiscinfo class="arch">generic</refmiscinfo>

10139N/A<refmiscinfo class="copyright">&suncopy;</refmiscinfo>

10139N/A</refmeta>

17616N/A<indexterm><primary>gtk-update-icon-cache</primary></indexterm>

17616N/A<indexterm><primary>Icon theme caching utility</primary></indexterm>

17616N/A<refnamediv id="gtk-update-icon-cache-1-name">

17616N/A<refname>gtk-update-icon-cache</refname>

17616N/A<refpurpose>Icon theme caching utility</refpurpose>

10139N/A</refnamediv>

10139N/A<refsynopsisdiv id="gtk-update-icon-cache-1-synp"><title>&synp-tt;</title>

10139N/A<cmdsynopsis><command>&cmd;</command>

10139N/A<arg choice="opt"><option>-force</option></arg>

13701N/A<arg choice="opt"><option>-help</option></arg>

10139N/A<arg choice="opt"><option>-ignore-theme-index</option></arg>

10139N/A<arg choice="opt"><option>-index-only</option></arg>

10139N/A<arg choice="opt"><option>-source=<replaceable>name</replaceable></option></arg>

10139N/A<arg choice="opt"><option>-quiet</option></arg>

11153N/A<arg choice="opt"><option>-validate</option></arg>

10139N/A<arg choice="opt"><option role="nodash"><replaceable>iconpath</replaceable></option></arg>

10139N/A</cmdsynopsis></refsynopsisdiv>

10139N/A

10139N/A<refsect1 id="gtk-update-icon-cache-1-desc"><title>&desc-tt;</title>

10139N/A<para>

17616N/A<command>&cmd;</command> creates cache files for icon themes that can be used

17616N/Awith

17616N/A<citerefentry><refentrytitle>mmap</refentrytitle>

17616N/A<manvolnum>2</manvolnum></citerefentry>.

10139N/A</para>

10139N/A

10139N/A<para>

10139N/AIt expects to be given the path to an icon theme directory containing an

17616N/A<filename>index.theme</filename> file, e.g.

17616N/A<filename>/usr/share/icons/hicolor</filename>, and writes a

17616N/A<filename>icon-theme.cache</filename> containing cached information about the

17616N/Aicons in the directory tree below the given directory.

10139N/A</para>

10139N/A

10139N/A<para>

10139N/AGTK+ can use the cache files created by gtk-update-icon-cache to avoid a lot

10139N/Aof system call and disk seek overhead when the application starts. Since the

10139N/Aformat of the cache files allows them to be mmap()ed shared between multiple

10139N/Aapplications, the overall memory consumption is reduced as well.

10139N/A</para>

10139N/A</refsect1>

10139N/A

10139N/A<refsect1 id="glib-genmarshal-1-opts"><title>&opts-tt;</title>

17616N/A<para>

17616N/AThe following options are supported:

17616N/A</para>

17616N/A

10139N/A<variablelist termlength="wide">

17616N/A<varlistentry>

17616N/A<term><option>f</option>, <option>-force</option></term>

10139N/A<listitem><para>

10139N/AOverwrite an existing cache file even if it appears to be up to date.

17616N/A</para></listitem></varlistentry>

10139N/A

17616N/A<varlistentry>

17616N/A<term><option>?</option>, <option>-help</option></term>

13701N/A<listitem><para>

13701N/AShow help options.

17616N/A</para></listitem></varlistentry>

13701N/A

17616N/A<varlistentry>

17616N/A<term><option>t</option>, <option>-ignore-theme-index</option></term>

10139N/A<listitem><para>

10139N/ADo not check for the existence of 'index.theme' in the icon theme directory.

11971N/AWithout this option, &cmd; refuses to create an icon cache in a directory which

10139N/Adoes not appear to be the toplevel directory of an icon theme.

17616N/A</para></listitem></varlistentry>

10139N/A

17616N/A<varlistentry>

17616N/A<term><option>i</option>, <option>-index-only</option></term>

17616N/A<listitem><para>Do not include image data in the cache

17616N/A</para></listitem></varlistentry>

10139N/A

17616N/A<varlistentry>

17616N/A<term><option>c</option>, <option>-source</option>=<replaceable>name</replaceable></term>

10139N/A<listitem><para>

11153N/AOutput a C header file declaring a constant <replaceable>name</replaceable>

17616N/Awith the contents of the icon cache.

17616N/A</para></listitem></varlistentry>

10139N/A

17616N/A<varlistentry>

17616N/A<term><option>q</option>, <option>-quiet</option></term>

17616N/A<listitem><para>

17616N/ATurn off verbose output.

17616N/A</para></listitem></varlistentry>

11153N/A

17616N/A<varlistentry>

17616N/A<term><option>v</option>, <option>-validate</option></term>

17616N/A<listitem><para>

17616N/AValidate existing icon cache.

17616N/A</para></listitem></varlistentry>

10139N/A</variablelist>

10139N/A</refsect1>

10139N/A

11904N/A<refsect1 id="gtk-update-icon-cache-1-oper"><title>&oper-tt;</title>

17616N/A<para>

17616N/AThe following operands are supported:

17616N/A</para>

17616N/A

10139N/A<variablelist termlength="medium">

17616N/A<varlistentry>

17616N/A<term><option role="nodash"><replaceable>iconpath</replaceable></option></term>

17616N/A<listitem><para>

17616N/AThe path to an icon theme directory containing an

17616N/A<filename>index.theme</filename> file.

17616N/A</para></listitem></varlistentry>

17616N/A</variablelist>

17616N/A</refsect1>

10139N/A

10139N/A<refsect1 id="gtk-update-icon-cache-1-envr"><title>&envr-tt;</title>

17616N/A<para>

17616N/ASee

17616N/A<citerefentry><refentrytitle>environ</refentrytitle>

17616N/A<manvolnum>5</manvolnum></citerefentry>

17616N/Afor descriptions of the following environment variables that affect the

17616N/Aexecution of <command>&cmd;</command>: NLSPATH.

10139N/A</para>

10139N/A</refsect1>

17616N/A

10139N/A<refsect1 id="gtk-update-icon-cache-1-exit"><title>&exit-tt;</title>

17616N/A<para>

17616N/AThe following exit values are returned:

17616N/A</para>

17616N/A

17616N/A<variablelist termlength="xtranarrow"><varlistentry>

17616N/A<term><returnvalue>0</returnvalue></term>

17616N/A<listitem><para>

17616N/AApplication exited successfully

17616N/A</para></listitem></varlistentry>

17616N/A<varlistentry>

17616N/A<term><returnvalue>>0</returnvalue></term>

17616N/A<listitem><para>

17616N/AApplication exited with failure

17616N/A</para>

10139N/A</listitem></varlistentry>

17616N/A</variablelist>

17616N/A</refsect1>

10139N/A

10139N/A<refsect1 id="gtk-update-icon-cache-1-file"><title>&file-tt;</title>

17616N/A<para>

17616N/AThe following files are used by this application:

17616N/A</para>

17616N/A

10139N/A<variablelist termlength="wide">

17616N/A<varlistentry>

17616N/A<term><filename>/usr/bin/&cmd;</filename></term>

17616N/A<listitem><para>

17616N/AThe command-line executable for the application.

17616N/A</para></listitem></varlistentry>

17616N/A<varlistentry>

17616N/A<term><filename>/usr/share/icons</filename></term><listitem>

17616N/A<para>

17616N/ASystem icon directory

17616N/A</para></listitem></varlistentry>

17616N/A<varlistentry>

17616N/A<term><filename>/usr/share/gtk-doc/html/gtk</filename></term>

17616N/A<listitem><para>

17616N/ALocation of developer documentation

17616N/A</para></listitem></varlistentry>

10139N/A</variablelist>

10139N/A</refsect1>

17616N/A

10139N/A<refsect1 id="gtk-update-icon-cache-1-attr"><title>&attr-tt;</title>

17616N/A<para>

17616N/ASee

17616N/A<olink targetdocent="REFMAN5" localinfo="attributes-5">

17616N/A<citerefentry><refentrytitle>attributes</refentrytitle>

17616N/A<manvolnum>5</manvolnum></citerefentry></olink>

17616N/Afor descriptions of the following attributes:

17616N/A</para>

17616N/A

10139N/A<informaltable frame="all">

17616N/A<tgroup cols="2" colsep="1" rowsep="1">

17616N/A<colspec colname="COLSPEC0" colwidth="1*">

10139N/A<colspec colname="COLSPEC1" colwidth="1*">

10139N/A<thead>

17616N/A<row>

17616N/A<entry align="center" valign="middle">ATTRIBUTE TYPE</entry>

17616N/A<entry align="center" valign="middle">ATTRIBUTE VALUE</entry>

17616N/A</row>

10139N/A</thead>

10139N/A<tbody>

17616N/A<row>

17616N/A<entry><para>Availability</para></entry>

18745N/A<entry><para>library/desktop/gtk2</para></entry>

17616N/A</row>

17616N/A<row>

17616N/A<entry colname="COLSPEC0"><para>Interface stability</para></entry>

17616N/A<entry colname="COLSPEC1"><para>Committed</para></entry>

17616N/A</row>

17616N/A</tbody></tgroup></informaltable>

10139N/A</refsect1>

17616N/A

10139N/A<refsect1 id="gtk-update-icon-cache-1-also"><title>&also-tt;</title>

10139N/A<para>

10139N/A<citerefentry><refentrytitle>gdk-pixbuf-csource</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

10139N/A<citerefentry><refentrytitle>gdk-pixbuf-query-loaders</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

10139N/A<citerefentry><refentrytitle>gettext</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

10139N/A<citerefentry><refentrytitle>glib-genmarshal</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

10139N/A<citerefentry><refentrytitle>glib-gettextize</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

10139N/A<citerefentry><refentrytitle>glib-mkenums</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

10139N/A<citerefentry><refentrytitle>gobject-query</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

10139N/A<citerefentry><refentrytitle>gtk-query-immodules-2.0</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

10139N/A<citerefentry><refentrytitle>mmap</refentrytitle><manvolnum>2</manvolnum></citerefentry>.

11904N/A<citerefentry><refentrytitle>libgtk-x11-2.0</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

11904N/A<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,

11904N/A<citerefentry><refentrytitle>environ</refentrytitle><manvolnum>5</manvolnum></citerefentry>

10139N/A</para>

17616N/A

17616N/A<para>

17616N/ALatest version of the <citetitle>GNOME Desktop User Guide</citetitle> for your

17616N/Aplatform.

17616N/A</para>

10139N/A</refsect1>

17616N/A

10139N/A<refsect1 id="gtk-update-icon-cache-1-note"><title>&note-tt;</title>

17616N/A<para>

17616N/AWritten by Brian Cameron, Sun Microsystems Inc., 2003, 2006, 2007.

17616N/A</para>

10139N/A</refsect1>

10139N/A</refentry>