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

12.0 12.1 kea ken/TL2024 ken/tuningfonts lazarus lxqt plabs/newcss python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since c98ea2d was 91318eb, checked in by Pierre Labastie <pierre.labastie@…>, 14 months ago

Add "setup" to meson commands

I've not been very consistent on typography, but it is a start

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