source: gnome/platform/gnome-desktop.xml

trunk
Last change on this file was fe33e3f, checked in by Douglas R. Reno <renodr@…>, 4 weeks ago

Tag GNOME Libraries and relevant dependencies

  • Property mode set to 100644
File size: 6.7 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 gnome-desktop-download-http
8 "&gnome-download-http;/gnome-desktop/&gnome-42;/gnome-desktop-&gnome-desktop-version;.tar.xz">
9 <!ENTITY gnome-desktop-download-ftp
10 "&gnome-download-ftp;/gnome-desktop/&gnome-42;/gnome-desktop-&gnome-desktop-version;.tar.xz">
11 <!ENTITY gnome-desktop-md5sum "d1523a08b36cf35d6891d1bf897c07de">
12 <!ENTITY gnome-desktop-size "728 KB">
13 <!ENTITY gnome-desktop-buildsize "26 MB">
14 <!ENTITY gnome-desktop-time "less than 0.1 SBU">
15]>
16
17<sect1 id="gnome-desktop" xreflabel="gnome-desktop-&gnome-desktop-version;">
18 <?dbhtml filename="gnome-desktop.html"?>
19
20 <sect1info>
21 <date>$Date$</date>
22 </sect1info>
23
24 <title>gnome-desktop-&gnome-desktop-version;</title>
25
26 <indexterm zone="gnome-desktop">
27 <primary sortas="a-gnome-desktop">gnome-desktop</primary>
28 </indexterm>
29
30 <sect2 role="package">
31 <title>Introduction to GNOME Desktop</title>
32
33 <para>
34 The <application>GNOME Desktop</application> package contains a library
35 that provides an API shared by several applications on the
36 <application>GNOME</application> Desktop.
37 </para>
38
39 &lfs112_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&gnome-desktop-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&gnome-desktop-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &gnome-desktop-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &gnome-desktop-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &gnome-desktop-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &gnome-desktop-time;
71 </para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect3">GNOME Desktop Dependencies</bridgehead>
76
77 <bridgehead renderas="sect4">Required</bridgehead>
78 <para role="required">
79 <xref linkend="gsettings-desktop-schemas"/>,
80 <xref linkend="gtk3"/>,
81 <xref linkend="gtk4"/>,
82 <xref linkend="iso-codes"/>,
83 <xref linkend="itstool"/>,
84 <xref linkend="libseccomp"/>,
85 <xref linkend="libxml2"/>, and
86 <xref linkend="xkeyboard-config"/>
87 </para>
88
89 <bridgehead renderas="sect4">Recommended</bridgehead>
90 <para role="recommended">
91 <xref linkend="bubblewrap"/> (needed for thumbnailers in Nautilus) and
92 <xref linkend="gobject-introspection"/>
93 </para>
94
95 <bridgehead renderas="sect4">Optional</bridgehead>
96 <para role="optional">
97 <xref linkend="gtk-doc"/>
98 </para>
99
100 <para condition="html" role="usernotes">User Notes:
101 <ulink url="&blfs-wiki;/gnome-desktop"/>
102 </para>
103 </sect2>
104
105 <sect2 role="installation">
106 <title>Installation of GNOME Desktop</title>
107
108 <para>
109 Install <application>GNOME Desktop</application> by
110 running the following commands:
111 </para>
112
113<screen><userinput>mkdir build &amp;&amp;
114cd build &amp;&amp;
115
116meson --prefix=/usr \
117 --buildtype=release \
118 -Dgnome_distributor="BLFS" .. &amp;&amp;
119ninja</userinput></screen>
120
121 <!-- Previously, there was a note here on SysV about the Wall Clock tests
122 failing. Since we symlinked the timezones, it works okay now. -->
123 <!--<para>
124 To test the results, run <command>ninja test</command> from a X Terminal
125 or similar. One test, <filename>wallclock-reftest</filename>, is known to
126 fail due to a difference in expecations in the he_IL.UTF-8 locale.
127 </para>-->
128 <!-- This failure is known upstream and seems to be due to a translation
129 update for the Hebrew translation. See
130 https://gitlab.gnome.org/GNOME/gnome-desktop/-/issues/149 and
131 https://gitlab.gnome.org/GNOME/gnome-desktop/-/merge_requests/70/
132 For some reason, I cannot replicate this on my gcc-10 system.-->
133 <para>
134 This package does not come with a test suite.
135 <!-- "no tests defined." -->
136 </para>
137
138 <para>
139 Now, as the <systemitem class="username">root</systemitem> user:
140 </para>
141
142<screen role="root"><userinput>ninja install</userinput></screen>
143
144 </sect2>
145
146 <sect2 role="commands">
147 <title>Command Explanations</title>
148
149 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
150 href="../../xincludes/meson-buildtype-release.xml"/>
151
152 <para>
153 <option>-Dgnome_distributor="Some Name"</option>: Use this
154 parameter to supply a custom name in the <quote>Distributor:</quote>
155 field of the <quote>GNOME About</quote> display window.
156 </para>
157
158 <para>
159 <option>-Dgtk_doc=true</option>: Use this
160 parameter if you wish to build the API documentation.
161 </para>
162
163 <para>
164 <option>-Dinstalled_tests=true</option>: Use this
165 parameter you wish to enable the installed tests.
166 </para>
167
168 </sect2>
169
170 <sect2 role="content">
171 <title>Contents</title>
172
173 <segmentedlist>
174 <segtitle>Installed Programs</segtitle>
175 <segtitle>Installed Library</segtitle>
176 <segtitle>Installed Directories</segtitle>
177
178 <seglistitem>
179 <seg>
180 None
181 </seg>
182 <seg>
183 libgnome-bg-4.so,
184 libgnome-desktop-3.so,
185 libgnome-desktop-4.so, and
186 libgnome-rr-4.so
187 </seg>
188 <seg>
189 /usr/include/gnome-desktop-3.0,
190 /usr/include/gnome-desktop-4.0,
191 /usr/libexec/gnome-desktop-debug,
192 /usr/share/gnome, and
193 /usr/share/gtk-doc/html/gnome-desktop3 (optional)
194 </seg>
195 </seglistitem>
196 </segmentedlist>
197
198 <variablelist>
199 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
200 <?dbfo list-presentation="list"?>
201 <?dbhtml list-presentation="table"?>
202
203 <varlistentry id="libgnome-desktop-3">
204 <term><filename class="libraryfile">libgnome-desktop-3.so</filename></term>
205 <listitem>
206 <para>
207 contains functions shared by several <application>GNOME</application>
208 applications
209 </para>
210 <indexterm zone="gnome-desktop libgnome-desktop-3">
211 <primary sortas="c-libgnome-desktop-3">libgnome-desktop-3.so</primary>
212 </indexterm>
213 </listitem>
214 </varlistentry>
215
216 </variablelist>
217
218 </sect2>
219
220</sect1>
Note: See TracBrowser for help on using the repository browser.