source: general/genutils/desktop-file-utils.xml@ 37c5347

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY desktop-file-utils-download-http "http://freedesktop.org/software/desktop-file-utils/releases/desktop-file-utils-&desktop-file-utils-version;.tar.gz">
  <!ENTITY desktop-file-utils-download-ftp  " ">
  <!ENTITY desktop-file-utils-md5sum        "N/A">
  <!ENTITY desktop-file-utils-size          "341 KB">
  <!ENTITY desktop-file-utils-buildsize     "2.7 MB">
  <!ENTITY desktop-file-utils-time          "0.07 SBU">
]>

<sect1 id="desktop-file-utils" xreflabel="desktop-file-utils-&desktop-file-utils-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="desktop-file-utils.html"?>
<title>desktop-file-utils-&desktop-file-utils-version;</title>

<sect2>
<title>Introduction to <application>desktop-file-utils</application></title>

<para>The <application>desktop-file-utils</application> package contains 
command line utilities for working with <ulink 
url="http://www.freedesktop.org/Standards/desktop-entry-spec">desktop 
entries</ulink>. These utilities are used by 
<application><acronym>GNOME</acronym></application>-2 and other applications 
to manipulate the <acronym>MIME</acronym>-types application databases and help 
adhere to the desktop entries standards specification.</para>

<sect3><title>Package information</title>
<itemizedlist spacing="compact">
<listitem><para>Download (HTTP): 
<ulink url="&desktop-file-utils-download-http;"/></para></listitem>
<listitem><para>Download (FTP): 
<ulink url="&desktop-file-utils-download-ftp;"/></para></listitem>
<listitem><para>Download MD5 sum: &desktop-file-utils-md5sum;</para></listitem>
<listitem><para>Download size: &desktop-file-utils-size;</para></listitem>
<listitem><para>Estimated disk space required: 
&desktop-file-utils-buildsize;</para></listitem>
<listitem><para>Estimated build time: 
&desktop-file-utils-time;</para></listitem></itemizedlist>
</sect3>

<sect3><title><application>desktop-file-utils</application> dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="GLib2"/> and <xref linkend="popt"/></para>
</sect4>

<sect4><title>Optional</title>
<para><xref linkend="postlfs-editors-emacs"/></para>
</sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application>desktop-file-utils</application></title>

<para>Install <application>desktop-file-utils</application> by running the 
following commands:</para>

<screen><userinput><command>./configure --prefix=/usr &amp;&amp;
make &amp;&amp;
make install</command></userinput></screen>

</sect2>

<sect2>
<title>Configuring <application>desktop-file-utils</application></title>

<sect3><title>Configuration information</title>
<para>The default location for the <acronym>MIME</acronym>-types application 
database is <filename>/usr/share/applications/mimeinfo.cache</filename>. If 
you are going to install, or have already installed, a desktop environment 
such as <application><acronym>GNOME</acronym></application> or 
<acronym>KDE</acronym> in a prefix other than 
<filename class='directory'>/usr</filename>, you'll need to update the 
<envar>XDG_DATA_DIRS</envar> environment variable so that additional 
<acronym>MIME</acronym>-types application databases are properly maintained. 
Add the following to the system-wide or personal profile:</para>

<para>For <application><acronym>GNOME</acronym></application>:</para>

<screen><userinput>XDG_DATA_DIRS=$XDG_DATA_DIRS:$GNOME_PREFIX/share
export XDG_DATA_DIRS</userinput></screen>

<para>For <application><acronym>KDE</acronym></application>:</para>

<screen><userinput>XDG_DATA_DIRS=$XDG_DATA_DIRS:$KDE_PREFIX/share
export XDG_DATA_DIRS</userinput></screen>

<para>If you're installing both 
<application><acronym>GNOME</acronym></application> and 
<application><acronym>KDE</acronym></application>:</para>

<screen><userinput>XDG_DATA_DIRS=$XDG_DATA_DIRS:$GNOME_PREFIX/share:$KDE_PREFIX/share
export XDG_DATA_DIRS</userinput></screen>

</sect3>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application>desktop-file-utils</application> package contains 
<command>desktop-file-install</command>, 
<command>desktop-file-validate</command> and 
<command>update-desktop-database</command>.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>desktop-file-install</title>
<para><command>desktop-file-install</command> is used to install a new, or 
modify an existing desktop file entry. It is also used to rebuild or modify 
the <acronym>MIME</acronym>-types application database.</para></sect3>

<sect3><title>desktop-file-validate</title>
<para><command>desktop-file-validate</command> is used to verify the integrity 
of a desktop file.</para></sect3>

<sect3><title>update-desktop-database</title>
<para><command>update-desktop-database</command> is used to update the 
<acronym>MIME</acronym>-types application database.</para></sect3>

</sect2>

</sect1>