source: gnome/platform/dconf.xml

trunk
Last change on this file was e8b3f50, checked in by Douglas R. Reno <renodr@…>, 2 months ago

Tags
  • Property mode set to 100644
File size: 8.4 KB
Line 
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<!-- DConf -->
8 <!ENTITY dconf-download-http "&gnome-download-http;/dconf/0.40/dconf-&dconf-version;.tar.xz">
9 <!ENTITY dconf-download-ftp " ">
10 <!ENTITY dconf-md5sum "ac8db20b0d6b996d4bbbeb96463d01f0">
11 <!ENTITY dconf-size "115 KB">
12 <!ENTITY dconf-buildsize "7.0 MB (with tests)">
13 <!ENTITY dconf-time "0.1 SBU (with tests)">
14
15<!-- DConf-Editor -->
16 <!ENTITY dconf-editor-download-http "&gnome-download-http;/dconf-editor/&gnome-45;/dconf-editor-&dconf-editor-version;.tar.xz">
17 <!ENTITY dconf-editor-download-ftp " ">
18 <!ENTITY dconf-editor-md5sum "82b2f5d396e95757ad7eaf89c82decd6">
19 <!ENTITY dconf-editor-size "596 KB">
20 <!ENTITY dconf-editor-buildsize "21 MB">
21 <!ENTITY dconf-editor-time "0.3 SBU">
22]>
23
24<sect1 id="dconf" xreflabel="DConf-&dconf-version;">
25 <?dbhtml filename="dconf.html"?>
26
27
28 <title>DConf-&dconf-version; / DConf-Editor-&dconf-editor-version;</title>
29
30 <indexterm zone="dconf">
31 <primary sortas="a-DConf">DConf</primary>
32 </indexterm>
33
34<!-- DConf -->
35
36 <sect2 role="package">
37 <title>Introduction to DConf</title>
38
39 <para>
40 The <application>DConf</application> package contains a low-level
41 configuration system. Its main purpose is to provide a backend to
42 GSettings on platforms that don't already have configuration storage
43 systems.
44 </para>
45
46 <para>
47 The <application>DConf-Editor</application>, as the name suggests, is a
48 graphical editor for the <application>DConf</application> database.
49 Installation is optional, because <command>gsettings</command> from <xref
50 linkend="glib2"/> provides similar functionality on the commandline.
51 </para>
52
53 &lfs121_checked;
54
55 <bridgehead renderas="sect3">Package Information</bridgehead>
56 <itemizedlist spacing="compact">
57 <listitem>
58 <para>
59 Download (HTTP): <ulink url="&dconf-download-http;"/>
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Download (FTP): <ulink url="&dconf-download-ftp;"/>
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Download MD5 sum: &dconf-md5sum;
70 </para>
71 </listitem>
72 <listitem>
73 <para>
74 Download size: &dconf-size;
75 </para>
76 </listitem>
77 <listitem>
78 <para>
79 Estimated disk space required: &dconf-buildsize;
80 </para>
81 </listitem>
82 <listitem>
83 <para>
84 Estimated build time: &dconf-time;
85 </para>
86 </listitem>
87 </itemizedlist>
88
89 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
90 <itemizedlist spacing="compact">
91 <listitem>
92 <para>
93 Download (HTTP): <ulink url="&dconf-editor-download-http;"/>
94 </para>
95 </listitem>
96 <listitem>
97 <para>
98 Download (FTP): <ulink url="&dconf-editor-download-ftp;"/>
99 </para>
100 </listitem>
101 <listitem>
102 <para>
103 Download MD5 sum: &dconf-editor-md5sum;
104 </para>
105 </listitem>
106 <listitem>
107 <para>
108 Download size: &dconf-editor-size;
109 </para>
110 </listitem>
111 <listitem>
112 <para>
113 Estimated disk space required: &dconf-editor-buildsize;
114 </para>
115 </listitem>
116 <listitem>
117 <para>
118 Estimated build time: &dconf-editor-time;
119 </para>
120 </listitem>
121 </itemizedlist>
122
123 <bridgehead renderas="sect3">DConf Dependencies</bridgehead>
124
125 <bridgehead renderas="sect4">Required</bridgehead>
126 <para role="required">
127 <xref linkend="dbus"/>,
128 <xref linkend="glib2"/>,
129 <xref linkend="gtk3"/> (for the editor),
130 <xref linkend="libhandy1"/> (for the editor), and
131 <xref linkend="libxml2"/> (for the editor)
132 </para>
133
134 <bridgehead renderas="sect4">Recommended</bridgehead>
135 <para role="recommended">
136 <xref linkend="libxslt"/> and
137 <xref linkend="vala"/>
138 </para>
139
140 <bridgehead renderas="sect4">Optional</bridgehead>
141 <para role="optional">
142 <xref linkend="gtk-doc"/> and
143 <ulink url="https://github.com/scop/bash-completion">bash-completion</ulink>
144 </para>
145
146 </sect2>
147
148 <sect2 role="installation">
149 <title>Installation of DConf</title>
150
151 <para revision="sysv">
152 First, prevent unnecessary systemd units from being installed:
153 </para>
154
155<screen revision="sysv"><userinput remap="pre">sed -i 's/install_dir: systemd_userunitdir,//' service/meson.build</userinput></screen>
156
157 <para>
158 Install <application>DConf</application> by running the following
159 commands:
160 </para>
161
162<screen><userinput>mkdir build &amp;&amp;
163cd build &amp;&amp;
164
165meson setup --prefix=/usr \
166 --buildtype=release \
167 -Dbash_completion=false \
168 .. &amp;&amp;
169ninja</userinput></screen>
170
171 <para>
172 To test the results, issue: <command>ninja test</command>
173 </para>
174
175 <para>
176 As the <systemitem class="username">root</systemitem> user:
177 </para>
178
179<screen role="root"><userinput>ninja install</userinput></screen>
180
181 <para>
182 Now, optionally install the editor:
183 </para>
184
185<screen><userinput>cd .. &amp;&amp;
186tar -xf ../dconf-editor-&dconf-editor-version;.tar.xz &amp;&amp;
187cd dconf-editor-&dconf-editor-version; &amp;&amp;
188
189mkdir build &amp;&amp;
190cd build &amp;&amp;
191
192meson setup --prefix=/usr --buildtype=release .. &amp;&amp;
193ninja</userinput></screen>
194
195 <para>
196 As the <systemitem class="username">root</systemitem> user:
197 </para>
198
199<screen role="root"><userinput>ninja install</userinput></screen>
200
201 </sect2>
202
203 <sect2 role="commands">
204 <title>Command Explanations</title>
205
206 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
207 href="../../xincludes/meson-buildtype-release.xml"/>
208
209 <para>
210 <option>-Dgtk_doc=true</option>: Use this parameter if
211 <application>GTK-Doc</application> is installed and you wish to rebuild
212 and install the API documentation.
213 </para>
214
215<!--
216 <para><!- - Using nbsp so that spaces are output verbatim - ->
217 <command>sed -e '/&nbsp;&nbsp;desktop,/d' ...</command>: This
218 fixes a failure to build with newer versions of
219 <application>meson</application>.
220 </para>
221-->
222
223 </sect2>
224
225 <sect2 role="content">
226 <title>Contents</title>
227
228 <segmentedlist>
229 <segtitle>Installed Programs</segtitle>
230 <segtitle>Installed Libraries</segtitle>
231 <segtitle>Installed Directories</segtitle>
232
233 <seglistitem>
234 <seg>
235 dconf and dconf-editor
236 </seg>
237 <seg>
238 libdconf.so
239 and libdconfsettings.so (GIO Module installed in
240 <filename class="directory">/usr/lib/gio/modules</filename>)
241 </seg>
242 <seg>
243 /usr/{include,share/gtk-doc/html}/dconf
244 </seg>
245 </seglistitem>
246 </segmentedlist>
247
248 <variablelist>
249 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
250 <?dbfo list-presentation="list"?>
251 <?dbhtml list-presentation="table"?>
252
253 <varlistentry id="dconf-prog">
254 <term><command>dconf</command></term>
255 <listitem>
256 <para>
257 is a simple tool for manipulating the
258 <application>DConf</application> database
259 </para>
260 <indexterm zone="dconf dconf-prog">
261 <primary sortas="b-dconf">dconf</primary>
262 </indexterm>
263 </listitem>
264 </varlistentry>
265
266 <varlistentry id="dconf-editor">
267 <term><command>dconf-editor</command></term>
268 <listitem>
269 <para>
270 is a graphical program for editing the
271 <application>DConf</application> database
272 </para>
273 <indexterm zone="dconf dconf-editor">
274 <primary sortas="b-dconf-editor">dconf-editor</primary>
275 </indexterm>
276 </listitem>
277 </varlistentry>
278
279 <varlistentry id="libdconf">
280 <term><filename class="libraryfile">libdconf.so</filename></term>
281 <listitem>
282 <para>
283 contains the <application>DConf</application> client API functions
284 </para>
285 <indexterm zone="dconf libdconf">
286 <primary sortas="c-libdconf">libdconf.so</primary>
287 </indexterm>
288 </listitem>
289 </varlistentry>
290
291 </variablelist>
292
293 </sect2>
294
295</sect1>
Note: See TracBrowser for help on using the repository browser.