diff options
Diffstat (limited to 'docs/reference/gtk/gtk-update-icon-cache.xml')
-rw-r--r-- | docs/reference/gtk/gtk-update-icon-cache.xml | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/reference/gtk/gtk-update-icon-cache.xml b/docs/reference/gtk/gtk-update-icon-cache.xml new file mode 100644 index 0000000000..e7baad89d5 --- /dev/null +++ b/docs/reference/gtk/gtk-update-icon-cache.xml @@ -0,0 +1,53 @@ +<refentry id="gtk-update-icon-cache"> + +<refmeta> +<refentrytitle>gtk-update-icon-cache</refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname>gtk-update-icon-cache</refname> +<refpurpose>Icon theme caching utility</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>gtk-update-icon-cache</command> +<arg choice="opt">--force</arg> +<arg choice="req">iconpath</arg> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Description</title> +<para> +<command>gtk-update-icon-cache</command> creates mmap()able cache files for +icon themes. +</para> +<para> +If expects to be given the path to a icon theme directory, 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 <command>gtk-update-icon-cache</command> +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> +<para> +If called with the --force argument, +<command>gtk-update-icon-cache</command> will overwrite an existing cache +file even if it appears to be uptodate. +</para> +</refsect1> + +<refsect1><title>Bugs</title> +<para> +None known yet. +</para> +</refsect1> + +</refentry> + + |