| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
|---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
|---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
|---|
| 5 | %general-entities;
|
|---|
| 6 |
|
|---|
| 7 | <!ENTITY desktop-file-utils-download-http
|
|---|
| 8 | "https://www.freedesktop.org/software/desktop-file-utils/releases/desktop-file-utils-&desktop-file-utils-version;.tar.xz">
|
|---|
| 9 | <!ENTITY desktop-file-utils-download-ftp " ">
|
|---|
| 10 | <!ENTITY desktop-file-utils-md5sum "fdf9215aea91acb6aebc43f770537f2c">
|
|---|
| 11 | <!ENTITY desktop-file-utils-size "80 KB">
|
|---|
| 12 | <!ENTITY desktop-file-utils-buildsize "1.2 MB">
|
|---|
| 13 | <!ENTITY desktop-file-utils-time "less than 0.1 SBU">
|
|---|
| 14 | ]>
|
|---|
| 15 |
|
|---|
| 16 | <sect1 id="desktop-file-utils" xreflabel="desktop-file-utils-&desktop-file-utils-version;">
|
|---|
| 17 | <?dbhtml filename="desktop-file-utils.html"?>
|
|---|
| 18 |
|
|---|
| 19 |
|
|---|
| 20 | <title>desktop-file-utils-&desktop-file-utils-version;</title>
|
|---|
| 21 |
|
|---|
| 22 | <indexterm zone="desktop-file-utils">
|
|---|
| 23 | <primary sortas="a-desktop-file-utils">desktop-file-utils</primary>
|
|---|
| 24 | </indexterm>
|
|---|
| 25 |
|
|---|
| 26 | <sect2 role="package">
|
|---|
| 27 | <title>Introduction to Desktop File Utils</title>
|
|---|
| 28 |
|
|---|
| 29 | <para>
|
|---|
| 30 | The <application>Desktop File Utils</application> package contains
|
|---|
| 31 | command line utilities for working with <ulink
|
|---|
| 32 | url="https://standards.freedesktop.org/desktop-entry-spec/latest/">
|
|---|
| 33 | Desktop entries</ulink>. These utilities are used by Desktop
|
|---|
| 34 | Environments and other applications to manipulate the MIME-types
|
|---|
| 35 | application databases and help adhere to the Desktop Entry
|
|---|
| 36 | Specification.
|
|---|
| 37 | </para>
|
|---|
| 38 |
|
|---|
| 39 | &lfs121_checked;
|
|---|
| 40 |
|
|---|
| 41 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
|---|
| 42 | <itemizedlist spacing="compact">
|
|---|
| 43 | <listitem>
|
|---|
| 44 | <para>
|
|---|
| 45 | Download (HTTP): <ulink url="&desktop-file-utils-download-http;"/>
|
|---|
| 46 | </para>
|
|---|
| 47 | </listitem>
|
|---|
| 48 | <listitem>
|
|---|
| 49 | <para>
|
|---|
| 50 | Download (FTP): <ulink url="&desktop-file-utils-download-ftp;"/>
|
|---|
| 51 | </para>
|
|---|
| 52 | </listitem>
|
|---|
| 53 | <listitem>
|
|---|
| 54 | <para>
|
|---|
| 55 | Download MD5 sum: &desktop-file-utils-md5sum;
|
|---|
| 56 | </para>
|
|---|
| 57 | </listitem>
|
|---|
| 58 | <listitem>
|
|---|
| 59 | <para>
|
|---|
| 60 | Download size: &desktop-file-utils-size;
|
|---|
| 61 | </para>
|
|---|
| 62 | </listitem>
|
|---|
| 63 | <listitem>
|
|---|
| 64 | <para>
|
|---|
| 65 | Estimated disk space required: &desktop-file-utils-buildsize;
|
|---|
| 66 | </para>
|
|---|
| 67 | </listitem>
|
|---|
| 68 | <listitem>
|
|---|
| 69 | <para>
|
|---|
| 70 | Estimated build time: &desktop-file-utils-time;
|
|---|
| 71 | </para>
|
|---|
| 72 | </listitem>
|
|---|
| 73 | </itemizedlist>
|
|---|
| 74 |
|
|---|
| 75 | <bridgehead renderas="sect3">Desktop File Utils Dependencies</bridgehead>
|
|---|
| 76 |
|
|---|
| 77 | <bridgehead renderas="sect4">Required</bridgehead>
|
|---|
| 78 | <para role="required">
|
|---|
| 79 | <xref linkend="glib2"/>
|
|---|
| 80 | </para>
|
|---|
| 81 |
|
|---|
| 82 | <bridgehead renderas="sect4">Optional</bridgehead>
|
|---|
| 83 | <para role="optional">
|
|---|
| 84 | <xref linkend="emacs"/>
|
|---|
| 85 | </para>
|
|---|
| 86 |
|
|---|
| 87 | </sect2>
|
|---|
| 88 |
|
|---|
| 89 | <sect2 role="installation">
|
|---|
| 90 | <title>Installation of Desktop File Utils</title>
|
|---|
| 91 |
|
|---|
| 92 | <warning>
|
|---|
| 93 | <para>
|
|---|
| 94 | If you are upgrading from a previous version of desktop-file-utils that
|
|---|
| 95 | used the Autotools method of installing and configuring the package,
|
|---|
| 96 | you must remove the desktop-file-edit symlink by using the following
|
|---|
| 97 | commands.
|
|---|
| 98 | </para>
|
|---|
| 99 | </warning>
|
|---|
| 100 | <!-- Works around a bug in meson's symlink creation exposed by this package -->
|
|---|
| 101 |
|
|---|
| 102 | <screen role="root"><userinput>rm -fv /usr/bin/desktop-file-edit</userinput></screen>
|
|---|
| 103 |
|
|---|
| 104 | <para>
|
|---|
| 105 | Install <application>Desktop File Utils</application> by
|
|---|
| 106 | running the following commands:
|
|---|
| 107 | </para>
|
|---|
| 108 |
|
|---|
| 109 | <screen><userinput>mkdir build &&
|
|---|
| 110 | cd build &&
|
|---|
| 111 |
|
|---|
| 112 | meson setup --prefix=/usr --buildtype=release .. &&
|
|---|
| 113 | ninja</userinput></screen>
|
|---|
| 114 |
|
|---|
| 115 | <para>
|
|---|
| 116 | This package does not come with a test suite.
|
|---|
| 117 | </para>
|
|---|
| 118 |
|
|---|
| 119 | <para>
|
|---|
| 120 | Now, as the <systemitem class="username">root</systemitem> user:
|
|---|
| 121 | </para>
|
|---|
| 122 |
|
|---|
| 123 | <screen role="root"><userinput>ninja install</userinput></screen>
|
|---|
| 124 |
|
|---|
| 125 | </sect2>
|
|---|
| 126 |
|
|---|
| 127 | <sect2 role="commands">
|
|---|
| 128 | <title>Command Explanations</title>
|
|---|
| 129 |
|
|---|
| 130 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
|---|
| 131 | href="../../xincludes/meson-buildtype-release.xml"/>
|
|---|
| 132 | </sect2>
|
|---|
| 133 |
|
|---|
| 134 | <sect2 role="configuration">
|
|---|
| 135 | <title>Configuring Desktop File Utils</title>
|
|---|
| 136 |
|
|---|
| 137 | <sect3>
|
|---|
| 138 | <title>Configuration Information</title>
|
|---|
| 139 |
|
|---|
| 140 | <para>
|
|---|
| 141 | The <ulink
|
|---|
| 142 | url="https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html">XDG
|
|---|
| 143 | Base Directory</ulink> specification defines the standard locations for
|
|---|
| 144 | applications to place data and configuration files. These files can be
|
|---|
| 145 | used, for instance, to define the menu structure and menu items in a
|
|---|
| 146 | desktop environment.
|
|---|
| 147 | </para>
|
|---|
| 148 |
|
|---|
| 149 | <para>
|
|---|
| 150 | The default location for configuration files to be installed
|
|---|
| 151 | is <filename class="directory">/etc/xdg</filename>, and the default
|
|---|
| 152 | locations for data files are <filename
|
|---|
| 153 | class="directory">/usr/local/share</filename> and <filename
|
|---|
| 154 | class="directory">/usr/share</filename>. These locations can be
|
|---|
| 155 | extended with the environment variables <envar>XDG_CONFIG_DIRS</envar>
|
|---|
| 156 | and <envar>XDG_DATA_DIRS</envar>, respectively. The
|
|---|
| 157 | <application>GNOME</application>, <application>KDE</application> and
|
|---|
| 158 | <application>XFCE</application> environments respect these
|
|---|
| 159 | settings.
|
|---|
| 160 | </para>
|
|---|
| 161 |
|
|---|
| 162 | <para>
|
|---|
| 163 | When a package installs a <filename>.desktop</filename> file
|
|---|
| 164 | to a location in one of the base data directories, the database
|
|---|
| 165 | that maps MIME-types to available applications can be updated. For
|
|---|
| 166 | instance, the cache file at
|
|---|
| 167 | <filename>/usr/share/applications/mimeinfo.cache</filename> can
|
|---|
| 168 | be rebuilt by executing the following command as the <systemitem
|
|---|
| 169 | class="username">root</systemitem> user:
|
|---|
| 170 | </para>
|
|---|
| 171 |
|
|---|
| 172 | <screen role="root"><userinput>install -vdm755 /usr/share/applications &&
|
|---|
| 173 | update-desktop-database /usr/share/applications</userinput></screen>
|
|---|
| 174 |
|
|---|
| 175 | </sect3>
|
|---|
| 176 |
|
|---|
| 177 | </sect2>
|
|---|
| 178 |
|
|---|
| 179 | <sect2 role="content">
|
|---|
| 180 | <title>Contents</title>
|
|---|
| 181 |
|
|---|
| 182 | <segmentedlist>
|
|---|
| 183 | <segtitle>Installed Programs</segtitle>
|
|---|
| 184 | <segtitle>Installed Libraries</segtitle>
|
|---|
| 185 | <segtitle>Installed Directories</segtitle>
|
|---|
| 186 |
|
|---|
| 187 | <seglistitem>
|
|---|
| 188 | <seg>
|
|---|
| 189 | desktop-file-edit, desktop-file-install,
|
|---|
| 190 | desktop-file-validate and
|
|---|
| 191 | update-desktop-database
|
|---|
| 192 | </seg>
|
|---|
| 193 | <seg>
|
|---|
| 194 | None
|
|---|
| 195 | </seg>
|
|---|
| 196 | <seg>
|
|---|
| 197 | None
|
|---|
| 198 | </seg>
|
|---|
| 199 | </seglistitem>
|
|---|
| 200 | </segmentedlist>
|
|---|
| 201 |
|
|---|
| 202 | <variablelist>
|
|---|
| 203 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|---|
| 204 | <?dbfo list-presentation="list"?>
|
|---|
| 205 | <?dbhtml list-presentation="table"?>
|
|---|
| 206 |
|
|---|
| 207 | <varlistentry id="desktop-file-edit">
|
|---|
| 208 | <term><command>desktop-file-edit</command></term>
|
|---|
| 209 | <listitem>
|
|---|
| 210 | <para>
|
|---|
| 211 | is used to modify an existing desktop file entry
|
|---|
| 212 | </para>
|
|---|
| 213 | <indexterm zone="desktop-file-utils desktop-file-edit">
|
|---|
| 214 | <primary sortas="b-desktop-file-edit">desktop-file-edit</primary>
|
|---|
| 215 | </indexterm>
|
|---|
| 216 | </listitem>
|
|---|
| 217 | </varlistentry>
|
|---|
| 218 |
|
|---|
| 219 | <varlistentry id="desktop-file-install">
|
|---|
| 220 | <term><command>desktop-file-install</command></term>
|
|---|
| 221 | <listitem>
|
|---|
| 222 | <para>
|
|---|
| 223 | is used to install a new desktop file entry. It is
|
|---|
| 224 | also used to rebuild or modify the MIME-types application
|
|---|
| 225 | database
|
|---|
| 226 | </para>
|
|---|
| 227 | <indexterm zone="desktop-file-utils desktop-file-install">
|
|---|
| 228 | <primary sortas="b-desktop-file-install">desktop-file-install</primary>
|
|---|
| 229 | </indexterm>
|
|---|
| 230 | </listitem>
|
|---|
| 231 | </varlistentry>
|
|---|
| 232 |
|
|---|
| 233 | <varlistentry id="desktop-file-validate">
|
|---|
| 234 | <term><command>desktop-file-validate</command></term>
|
|---|
| 235 | <listitem>
|
|---|
| 236 | <para>
|
|---|
| 237 | is used to verify the integrity of a desktop file
|
|---|
| 238 | </para>
|
|---|
| 239 | <indexterm zone="desktop-file-utils desktop-file-validate">
|
|---|
| 240 | <primary sortas="b-desktop-file-validate">desktop-file-validate</primary>
|
|---|
| 241 | </indexterm>
|
|---|
| 242 | </listitem>
|
|---|
| 243 | </varlistentry>
|
|---|
| 244 |
|
|---|
| 245 | <varlistentry id="update-desktop-database">
|
|---|
| 246 | <term><command>update-desktop-database</command></term>
|
|---|
| 247 | <listitem>
|
|---|
| 248 | <para>
|
|---|
| 249 | is used to update the MIME-types application database
|
|---|
| 250 | </para>
|
|---|
| 251 | <indexterm zone="desktop-file-utils update-desktop-database">
|
|---|
| 252 | <primary sortas="b-update-desktop-database">update-desktop-database</primary>
|
|---|
| 253 | </indexterm>
|
|---|
| 254 | </listitem>
|
|---|
| 255 | </varlistentry>
|
|---|
| 256 | </variablelist>
|
|---|
| 257 |
|
|---|
| 258 | </sect2>
|
|---|
| 259 |
|
|---|
| 260 | </sect1>
|
|---|
