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

<?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          "424 KB">
  <!ENTITY desktop-file-utils-buildsize     "6.6 MB">
  <!ENTITY desktop-file-utils-time          "0.15 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 are used by 
<application><acronym>GNOME</acronym></application>-2 and other applications 
to 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>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="gnome-vfs"/> and 
<xref linkend="postlfs-editors-emacs"/></para>
</sect4>
</sect3>

</sect2>

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

<para>Though the <application>desktop-file-utils</application> package is 
listed here in Chapter 10, the main use of the package will be for the 
<application><acronym>GNOME</acronym></application>-2 desktop. Therefore, the 
instructions are geared towards a 
<application><acronym>GNOME</acronym></application> installation. See the
<quote>Command explanations</quote> section for information about installing 
the package for other uses.</para>

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

<screen><userinput><command>./configure --prefix=$GNOME_PREFIX \
            --sysconfdir=/etc/gnome &amp;&amp;
make &amp;&amp;
make install</command></userinput></screen>

</sect2>

<sect2>
<title>Command explanations</title>

<para><parameter>--prefix=$GNOME_PREFIX</parameter>: This forces the programs 
and libraries to be installed in directories which coincide with a 
<application><acronym>GNOME</acronym></application>-2 installation. Change
the directory path to <filename class='directory'>/usr</filename> if the
package is being installed for a different use.</para>

<para><parameter>--sysconfdir=/etc/gnome</parameter>: This forces the 
configuration directory to coincide with a 
<application><acronym>GNOME</acronym></application>-2 installation. Change 
the directory path to <filename class='directory'>/etc</filename> if the 
package is being installed for a different use.</para>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application>desktop-file-utils</application> package contains 
<command>desktop-file-install</command>, 
<command>desktop-file-validate</command>, 
<command>desktop-menu-tool</command>, 
<command>update-desktop-database</command> and optionally, 
the <application><acronym>GNOME</acronym>-<acronym>VFS</acronym></application> 
<filename class='libraryfile'>libmenu</filename> library module.</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>desktop-menu-tool</title>
<para><command>desktop-menu-tool</command> is used to display a human-readable 
representation of, or display the set of desktop files used for a given menu
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>