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

12.0 12.1 kea ken/TL2024 ken/tuningfonts lazarus lxqt plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since 9fd586e9 was 849543ca, checked in by Douglas R. Reno <renodr@…>, 13 months ago

Patch desktop-file-utils to handle the new SingleMainWindow key from
standard version 1.5.

  • Property mode set to 100644
File size: 9.1 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
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 "29739e005f5887cf41639b8450f3c23f">
11 <!ENTITY desktop-file-utils-size "84 KB">
12 <!ENTITY desktop-file-utils-buildsize "1.8 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 &lfs113_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">Additional Downloads</bridgehead>
76 <itemizedlist spacing="compact">
77 <listitem>
78 <para>
79 Required patch:
80 <ulink url="&patch-root;/desktop-file-utils-&desktop-file-utils-version;-update_standard-1.patch"/>
81 </para>
82 </listitem>
83 </itemizedlist>
84
85 <bridgehead renderas="sect3">Desktop File Utils Dependencies</bridgehead>
86
87 <bridgehead renderas="sect4">Required</bridgehead>
88 <para role="required">
89 <xref linkend="glib2"/>
90 </para>
91
92 <bridgehead renderas="sect4">Optional</bridgehead>
93 <para role="optional">
94 <xref linkend="emacs"/>
95 </para>
96
97 <para condition="html" role="usernotes">User Notes:
98 <ulink url="&blfs-wiki;/desktop-file-utils"/>
99 </para>
100 </sect2>
101
102 <sect2 role="installation">
103 <title>Installation of Desktop File Utils</title>
104
105 <warning>
106 <para>
107 If you are upgrading from a previous version of desktop-file-utils that
108 used the Autotools method of installing and configuring the package,
109 you must remove the desktop-file-edit symlink by using the following
110 commands.
111 </para>
112 </warning>
113 <!-- Works around a bug in meson's symlink creation exposed by this package -->
114
115<screen role="root"><userinput>rm -fv /usr/bin/desktop-file-edit</userinput></screen>
116
117 <para>
118 Next, update the version of the desktop file standard to accept the
119 SingleMainWindow key:
120 </para>
121
122<screen><userinput remap="pre">patch -Np1 -i ../desktop-file-utils-&desktop-file-utils-version;-update_standard-1.patch</userinput></screen>
123
124 <para>
125 Install <application>Desktop File Utils</application> by
126 running the following commands:
127 </para>
128
129<screen><userinput>mkdir build &amp;&amp;
130cd build &amp;&amp;
131
132meson setup --prefix=/usr --buildtype=release .. &amp;&amp;
133ninja</userinput></screen>
134
135 <para>
136 This package does not come with a test suite.
137 </para>
138
139 <para>
140 Now, as the <systemitem class="username">root</systemitem> user:
141 </para>
142
143<screen role="root"><userinput>ninja install</userinput></screen>
144
145 </sect2>
146
147 <sect2 role="commands">
148 <title>Command Explanations</title>
149
150 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
151 href="../../xincludes/meson-buildtype-release.xml"/>
152 </sect2>
153
154 <sect2 role="configuration">
155 <title>Configuring Desktop File Utils</title>
156
157 <sect3>
158 <title>Configuration Information</title>
159
160 <para>
161 The <ulink
162 url="https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html">XDG
163 Base Directory</ulink> specification defines the standard locations for
164 applications to place data and configuration files. These files can be
165 used, for instance, to define the menu structure and menu items in a
166 desktop environment.
167 </para>
168
169 <para>
170 The default location for configuration files to be installed
171 is <filename class="directory">/etc/xdg</filename>, and the default
172 locations for data files are <filename
173 class="directory">/usr/local/share</filename> and <filename
174 class="directory">/usr/share</filename>. These locations can be
175 extended with the environment variables <envar>XDG_CONFIG_DIRS</envar>
176 and <envar>XDG_DATA_DIRS</envar>, respectively. The
177 <application>GNOME</application>, <application>KDE</application> and
178 <application>XFCE</application> environments respect these
179 settings.
180 </para>
181
182 <para>
183 When a package installs a <filename>.desktop</filename> file
184 to a location in one of the base data directories, the database
185 that maps MIME-types to available applications can be updated. For
186 instance, the cache file at
187 <filename>/usr/share/applications/mimeinfo.cache</filename> can
188 be rebuilt by executing the following command as the <systemitem
189 class="username">root</systemitem> user:
190 </para>
191
192<screen role="root"><userinput>install -vdm755 /usr/share/applications &amp;&amp;
193update-desktop-database /usr/share/applications</userinput></screen>
194
195 </sect3>
196
197 </sect2>
198
199 <sect2 role="content">
200 <title>Contents</title>
201
202 <segmentedlist>
203 <segtitle>Installed Programs</segtitle>
204 <segtitle>Installed Libraries</segtitle>
205 <segtitle>Installed Directories</segtitle>
206
207 <seglistitem>
208 <seg>
209 desktop-file-edit, desktop-file-install,
210 desktop-file-validate and
211 update-desktop-database
212 </seg>
213 <seg>
214 None
215 </seg>
216 <seg>
217 None
218 </seg>
219 </seglistitem>
220 </segmentedlist>
221
222 <variablelist>
223 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
224 <?dbfo list-presentation="list"?>
225 <?dbhtml list-presentation="table"?>
226
227 <varlistentry id="desktop-file-edit">
228 <term><command>desktop-file-edit</command></term>
229 <listitem>
230 <para>
231 is used to modify an existing desktop file entry
232 </para>
233 <indexterm zone="desktop-file-utils desktop-file-edit">
234 <primary sortas="b-desktop-file-edit">desktop-file-edit</primary>
235 </indexterm>
236 </listitem>
237 </varlistentry>
238
239 <varlistentry id="desktop-file-install">
240 <term><command>desktop-file-install</command></term>
241 <listitem>
242 <para>
243 is used to install a new desktop file entry. It is
244 also used to rebuild or modify the MIME-types application
245 database
246 </para>
247 <indexterm zone="desktop-file-utils desktop-file-install">
248 <primary sortas="b-desktop-file-install">desktop-file-install</primary>
249 </indexterm>
250 </listitem>
251 </varlistentry>
252
253 <varlistentry id="desktop-file-validate">
254 <term><command>desktop-file-validate</command></term>
255 <listitem>
256 <para>
257 is used to verify the integrity of a desktop file
258 </para>
259 <indexterm zone="desktop-file-utils desktop-file-validate">
260 <primary sortas="b-desktop-file-validate">desktop-file-validate</primary>
261 </indexterm>
262 </listitem>
263 </varlistentry>
264
265 <varlistentry id="update-desktop-database">
266 <term><command>update-desktop-database</command></term>
267 <listitem>
268 <para>
269 is used to update the MIME-types application database
270 </para>
271 <indexterm zone="desktop-file-utils update-desktop-database">
272 <primary sortas="b-update-desktop-database">update-desktop-database</primary>
273 </indexterm>
274 </listitem>
275 </varlistentry>
276 </variablelist>
277
278 </sect2>
279
280</sect1>
Note: See TracBrowser for help on using the repository browser.