opensolaris man page for gtk-update-icon-cache

gtk-update-icon-cache(1)					   User Commands					  gtk-update-icon-cache(1)

NAME
       gtk-update-icon-cache - Icon theme caching utility

SYNOPSIS
       gtk-update-icon-cache [--force] [--help] [--ignore-theme-index] [--index-only] [--source=name] [--quiet] [--validate] [iconpath]

DESCRIPTION
       gtk-update-icon-cache creates cache files for icon themes that can be used with mmap(2).

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

       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.

OPTIONS
       The following options are supported:

       -f, --force		       Overwrite an existing cache file even if it appears to be up to date.

       -?, --help		       Show help options.

       -t, --ignore-theme-index        Do not check for the existence of 'index.theme' in the icon theme directory.   Without  this  option,  gtk-
				       update-icon-cache  refuses  to create an icon cache in a directory which does not appear to be the toplevel
				       directory of an icon theme.

       -i, --index-only 	       Do not include image data in the cache

       -c, --source=name	       Output a C header file declaring a constant name with the contents of the icon cache.

       -q, --quiet		       Turn off verbose output.

       -v, --validate		       Validate existing icon cache.

OPERANDS
       The following operands are supported:

       iconpath 	       The path to an icon theme directory containing an index.theme file.

ENVIRONMENT VARIABLES
       See environ(5) for descriptions of the following environment variables that affect the execution of gtk-update-icon-cache: NLSPATH.

EXIT STATUS
       The following exit values are returned:

       0	Application exited successfully

       >0	Application exited with failure

FILES
       The following files are used by this application:

       /usr/bin/gtk-update-icon-cache  The command-line executable for the application.

       /usr/share/icons 	       System icon directory

       /usr/share/gtk-doc/html/gtk     Location of developer documentation

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Availability		     |SUNWgnome-base-libs	   |
       +-----------------------------+-----------------------------+
       |Interface stability	     |Committed 		   |
       +-----------------------------+-----------------------------+

SEE ALSO
       gdk-pixbuf-csource(1), gdk-pixbuf-query-loaders(1), gettext(1), glib-genmarshal(1), glib-gettextize(1), glib-mkenums(1),  gobject-query(1),
       gtk-query-immodules-2.0(1), mmap(2).  libgtk-x11-2.0(3), attributes(5), environ(5)

       Latest version of the GNOME Desktop User Guide for your platform.

NOTES
       Written by Brian Cameron, Sun Microsystems Inc., 2003, 2006, 2007.

SunOS 5.11							    21 Nov 2007 					  gtk-update-icon-cache(1)