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

<!--ArborText, Inc., 1988-1999, v.4002-->

<!ENTITY cmd "update-desktop-database">

<!ENTITY % commonents SYSTEM "smancommon.ent">

%commonents;

<!ENTITY % booktitles SYSTEM "booktitles.ent">

%booktitles;

<!ENTITY suncopy "Copyright (c) 2006 Sun Microsystems, Inc. All Rights Reserved.">

]>

<?Pub UDT _bookmark _target>

<?Pub Inc>

<refentry id="update-desktop-database-1">

<refmeta><refentrytitle>update-desktop-database</refentrytitle><manvolnum>1</manvolnum>

<refmiscinfo class="date">31 Jan 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>update-desktop-database</primary></indexterm><indexterm><primary>

Desktop file caching utility</primary></indexterm><refnamediv id="update-desktop-database-1-name">

<refname>update-desktop-database</refname><refpurpose>Desktop file caching utility</refpurpose>

</refnamediv>

<refsynopsisdiv id="update-desktop-database-1-synp"><title>&synp-tt;</title>

<cmdsynopsis><command>&cmd;</command>

<arg choice="opt"><option>-help</option></arg>

<arg choice="opt"><option>-verbose</option></arg>

<arg choice="opt"><option>-quiet</option></arg>

<arg choice="opt"><option role="nodash"><replaceable>filepath</replaceable></option></arg>

</cmdsynopsis></refsynopsisdiv>

<refsect1 id="update-desktop-database-1-desc"><title>&desc-tt;</title>

<para>

<command>&cmd;</command> creates cache files for desktop file MIME type mapping

for improved MIME lookup performance.

</para>

<para>

It expects to be given the path to a directory or directories containing a number

of application installed .desktop files,

e.g. <filename>/usr/share/applications</filename>, and writes a

<filename>mime-info.cache</filename> containing cached information

about the MIME types that each application can handle. If no directory is

provided, this utility will use a default directory list as specified in the

FreeDesktop MIME specification. This cache file is used to avoid a lot of

system call and disk seek overhead in a number of applications.

</para>

</refsect1>

<refsect1 id="update-desktop-database-1-opts"><title>&opts-tt;</title>

<para>The following options are supported:</para>

<variablelist termlength="wide">

<varlistentry><term><option>?</option>, <option>-help</option></term>

<listitem><para>

Show help options.

</para>

</listitem></varlistentry>

<varlistentry><term><option>v</option>, <option>-verbose</option></term>

<listitem><para>

Turn on verbose output.

</para>

</listitem></varlistentry>

<varlistentry><term><option>q</option>, <option>-quiet</option></term>

<listitem><para>

Do not provide any output.

</para>

</listitem></varlistentry>

</variablelist>

</refsect1>

<refsect1 id="update-desktop-database-1-oper"><title>&oper-tt;</title>

<para>The following operands are supported:</para>

<variablelist termlength="medium">

<varlistentry><term><option role="nodash"><replaceable>filepath</replaceable></option></term>

<listitem><para>The path to a directory or directories containing a number of application

installed .desktop files.</listitem>

</varlistentry>

</variablelist></refsect1>

<refsect1 id="update-desktop-database-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>1</returnvalue></term><listitem><para>Application

exited with failure</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="update-desktop-database-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/applications</filename>

</term><listitem><para>System desktop file directory</para>

</listitem></varlistentry>

</variablelist>

</refsect1>

<refsect1 id="update-desktop-database-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>gnome/preferences/control-center

</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="update-desktop-database-1-also"><title>&also-tt;</title>

<para>

<citerefentry><refentrytitle>update-mime-database</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>gnome-desktop-item-edit</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,

<citerefentry><refentrytitle>gnome-interfaces</refentrytitle><manvolnum>5</manvolnum></citerefentry>

</para>

<para>Latest version of the <citetitle>GNOME Desktop User Guide</citetitle> and

<citetitle>GNOME System Administration Guide</citetitle> for your platform.</para>

</refsect1>

<refsect1 id="update-desktop-database-1-note"><title>&note-tt;</title>

<para>Written by Glynn Foster, Sun Microsystems Inc., 2007.</para>

</refsect1>

</refentry>