Files
gtk3/docs/reference/gtk/gtk-update-icon-cache.1
2009-04-11 11:40:30 -04:00

78 lines
2.5 KiB
Groff

'\" t
.\" Title: gtk-update-icon-cache
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
.\" Date: 04/11/2009
.\" Manual: [FIXME: manual]
.\" Source: [FIXME: source]
.\" Language: English
.\"
.TH "GTK\-UPDATE\-ICON\-C" "1" "04/11/2009" "[FIXME: source]" "[FIXME: manual]"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
gtk-update-icon-cache \- Icon theme caching utility
.SH "SYNOPSIS"
.HP \w'\fBgtk\-update\-icon\-cache\fR\ 'u
\fBgtk\-update\-icon\-cache\fR [\-\-force] [\-\-ignore\-theme\-index] [\-\-index\-only] [\-\-source\ [name]] [\-\-quiet] [\-\-validate] {iconpath}
.SH "DESCRIPTION"
.PP
\fBgtk\-update\-icon\-cache\fR
creates mmap()able cache files for icon themes\&.
.PP
It expects to be given the path to a icon theme directory containing an
index\&.theme, 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\&.
.PP
GTK+ can use the cache files created by
\fBgtk\-update\-icon\-cache\fR
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\&.
.SH "OPTIONS"
.PP
\-\-force, \-f
.RS 4
Overwrite an existing cache file even if it appears to be uptodate\&.
.RE
.PP
\-\-ignore\-theme\-index, \-t
.RS 4
Don\'t check for the existence of \'index\&.theme\' in the icon theme directory\&. Without this option,
\fBgtk\-update\-icon\-cache\fR
refuses to create an icon cache in a directory which does not appear to be the toplevel directory of an icon theme\&.
.RE
.PP
\-\-index\-only, \-i
.RS 4
Don\'t include image data in the cache\&.
.RE
.PP
\-\-source, \-c
.RS 4
Output a C header file declaring a constant
\fIname\fR
with the contents of the icon cache\&.
.RE
.PP
\-\-quiet, \-q
.RS 4
Turn off verbose output\&.
.RE
.PP
\-\-validate, \-v
.RS 4
Validate existing icon cache\&.
.RE
.SH "BUGS"
.PP
None known yet\&.