source: archive/core/kdelibs.xml

trunk
Last change on this file was 3f2db3a6, checked in by Pierre Labastie <pierre.labastie@…>, 17 months ago

Remove sect1info tags

They only contain a date tag that is nowhere used.
  • Property mode set to 100644
File size: 11.8 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 kdelibs-download-http "&kde-download-http;applications/&kde-apps2-version;/src/kdelibs-&kde-libs-version;.tar.xz">
8 <!ENTITY kdelibs-download-ftp " ">
9 <!ENTITY kdelibs-md5sum "9a4c194ee49e6e3836515389385d77cc">
10 <!ENTITY kdelibs-size "11.1 MB">
11 <!ENTITY kdelibs-buildsize "381 MB">
12 <!ENTITY kdelibs-time "18 SBU">
13]>
14
15<sect1 id="kdelibs" xreflabel="kdelibs-&kde-libs-version;">
16 <?dbhtml filename="kdelibs.html"?>
17
18
19 <title>Kdelibs-&kde-libs-version;</title>
20
21 <indexterm zone="kdelibs">
22 <primary sortas="a-kdelibs">kdelibs</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to Kdelibs</title>
27
28 <para>This package includes programs and libraries that
29 are central to development and execution of KDE programs.</para>
30
31 &lfs79_checked;
32
33 <bridgehead renderas="sect3">Package Information</bridgehead>
34 <itemizedlist spacing="compact">
35 <listitem>
36 <para>Download (HTTP): <ulink url="&kdelibs-download-http;"/></para>
37 </listitem>
38 <listitem>
39 <para>Download (FTP): <ulink url="&kdelibs-download-ftp;"/></para>
40 </listitem>
41 <listitem>
42 <para>Download MD5 sum: &kdelibs-md5sum;</para>
43 </listitem>
44 <listitem>
45 <para>Download size: &kdelibs-size;</para>
46 </listitem>
47 <listitem>
48 <para>Estimated disk space required: &kdelibs-buildsize;</para>
49 </listitem>
50 <listitem>
51 <para>Estimated build time: &kdelibs-time;</para>
52 </listitem>
53 </itemizedlist>
54
55 <bridgehead renderas="sect3">Kdelibs Dependencies</bridgehead>
56
57 <bridgehead renderas="sect4">Required</bridgehead>
58 <para role="required">
59 <xref linkend="attica"/>,
60 <xref linkend="automoc4"/>,
61 <xref linkend="DocBook"/>,
62 <xref linkend="docbook-xsl"/>,
63 <xref linkend="giflib"/>,
64 <xref linkend="libdbusmenu-qt"/>,
65 <xref linkend="libjpeg"/>,
66 <xref linkend="libpng"/>,
67 <xref linkend="phonon"/>,
68 <xref linkend="strigi"/>, and
69 <xref linkend="shared-mime-info"/>
70 </para>
71
72 <bridgehead renderas="sect4">Recommended</bridgehead>
73 <para role="recommended">
74 <xref linkend="polkit-qt"/>,
75 <xref linkend="openssl"/>,
76 <xref linkend="qca"/>,
77 <xref linkend="upower"/>, and
78 <xref linkend="udisks"/> or <xref linkend="udisks2"/>
79 </para>
80
81 <bridgehead renderas="sect4">Optional</bridgehead>
82 <para role="optional">
83 <xref linkend="jasper"/>,
84 <xref linkend="pcre"/>,
85 <xref linkend="avahi"/>,
86 <xref linkend="aspell"/>,
87 <xref linkend="enchant"/>,
88 <xref linkend="grantlee"/>,
89 <xref linkend="mitkrb"/>,
90 <ulink url="&sourceforge-repo;/soprano">soprano</ulink>,
91 <ulink url="&sourceforge-repo;/oscaf/">shared-desktop-ontologies</ulink>,
92 <ulink url="http://hspell.ivrix.org.il/">Hspell</ulink>,
93 <ulink url="http://oss.sgi.com/projects/fam/">FAM</ulink>,
94 <ulink url="http://www.herqq.org/">HUPnP</ulink>,
95 <ulink url="http://www.openexr.com/">OpenEXR</ulink>, and
96 <ulink url="http://www.freedesktop.org/wiki/Software/media-player-info">media-player-info</ulink>
97 </para>
98
99 <para condition="html" role="usernotes">User Notes:
100 <ulink url="&blfs-wiki;/kdelibs"/>
101 </para>
102
103 </sect2>
104
105 <sect2 role="installation">
106 <title>Installation of Kdelibs</title>
107
108 <para>Fix file conflicts with <application>GNOME Menus</application> by running
109 the following commands:</para>
110
111<screen><userinput>sed -i "s@{SYSCONF_INSTALL_DIR}/xdg/menus@&amp; RENAME kde-applications.menu@" \
112 kded/CMakeLists.txt &amp;&amp;
113
114sed -i "s@applications.menu@kde-&amp;@" \
115 kded/kbuildsycoca.cpp</userinput></screen>
116
117<!--
118 <para>Cmake looks for <application>Xorg</application> libraries in a set of
119 hard coded directories instead of using
120 <application>pkg-config</application>. If <application>Xorg</application>
121 has not been installed in <filename class="directory">/usr</filename>, add
122 the location to the list:</para>
123
124<screen><userinput>sed -e "/SET(X11_LIB_SEARCH_PATH/ a $XORG_PREFIX/lib" \
125 -e "/SET(X11_INC_SEARCH_PATH/ a $XORG_PREFIX/include" \
126 -i cmake/modules/FindX11.cmake</userinput></screen>
127-->
128
129 <para>Install <application>Kdelibs</application> by running the following
130 commands:</para>
131
132<!-- I wouldn't recommend installing D-Bus configuration files outside of
133 /etc if kde-dir is /usr, maybe kde-etc-dir should be introduced? -->
134
135<screen><userinput>mkdir build &amp;&amp;
136cd build &amp;&amp;
137
138cmake -DCMAKE_INSTALL_PREFIX=&kde-dir; \
139 -DSYSCONF_INSTALL_DIR=/etc \
140 -DCMAKE_BUILD_TYPE=Release \
141 -DDOCBOOKXML_CURRENTDTD_DIR=/usr/share/xml/docbook/xml-dtd-&DocBook-version; \
142 -Wno-dev .. &amp;&amp;
143make</userinput></screen>
144
145 <para>The unit regression tests are designed to be run after
146 <application>kdelibs</application> is installed.</para>
147
148 <para> Now as the <systemitem class="username">root</systemitem>
149 user:</para>
150
151<screen role="root"><userinput>make install</userinput></screen>
152
153 <para>To run the unit regression tests, you must have a current KDE session
154 running and issue <command>make test</command>.</para>
155
156 </sect2>
157
158 <sect2 role="commands">
159 <title>Command Explanations</title>
160
161 <para><option>-DSYSCONF_INSTALL_DIR=/etc</option>: This switch is used to install
162 configuration files in /etc.</para>
163
164 <para><option>-DCMAKE_BUILD_TYPE=Release</option>: This switch is used to apply
165 higher level of compiler optimizations.</para>
166
167 <para><option>-DDOCBOOKXML_CURRENTDTD_DIR=...</option>: This switch is used to
168 tell <command>cmake</command> where to find the XML DTDs.</para>
169
170 <para><option>-DWITH_SOLID_UDISKS2=TRUE</option>: Use this switch if you
171 have <application>UDisks2</application>.</para>
172
173 </sect2>
174
175 <sect2 role="content">
176 <title>Contents</title>
177
178 <segmentedlist>
179 <segtitle>Installed Programs</segtitle>
180 <segtitle>Installed Libraries</segtitle>
181 <segtitle>Installed Directories</segtitle>
182
183 <seglistitem>
184 <seg>checkXML, kbuildsycoca4, kconfig_compiler, kcookiejar4,
185 kde4-config, kded4, kdeinit4, kdeinit4_shutdown, kdeinit4_wrapper,
186 kfilemetadatareader, kjs, kjscmd, kmailservice, kross, kshell4,
187 ktelnetservice, kunittestmodrunner, kwrapper4, makekdewidgets,
188 meinproc4, meinproc4_simple, nepomuk-rcgen and preparetips</seg>
189 <seg>several in &kde-dir;/lib</seg>
190 <seg>several in &kde-dir;/include, &kde-dir;/lib and &kde-dir;/share
191 </seg>
192 </seglistitem>
193 </segmentedlist>
194
195 <variablelist>
196 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
197 <?dbfo list-presentation="list"?>
198 <?dbhtml list-presentation="table"?>
199
200 <varlistentry id="checkXML">
201 <term><command>checkXML</command></term>
202 <listitem>
203 <para>
204 is a tool used to check for syntax errors in KDE DocBook
205 XML files.
206 </para>
207 <indexterm zone="kdelibs checkXML">
208 <primary sortas="b-checkXML">checkXML</primary>
209 </indexterm>
210 </listitem>
211 </varlistentry>
212
213 <varlistentry id="kbuildsycoca4">
214 <term><command>kbuildsycoca4</command></term>
215 <listitem>
216 <para>
217 is used to rebuild the system configuration cache.
218 </para>
219 <indexterm zone="kdelibs kbuildsycoca4">
220 <primary sortas="b-kbuildsycoca4">kbuildsycoca4</primary>
221 </indexterm>
222 </listitem>
223 </varlistentry>
224
225 <varlistentry id="kconfig_compiler">
226 <term><command>kconfig_compiler</command></term>
227 <listitem>
228 <para>
229 is the KDE configuration compiler.
230 </para>
231 <indexterm zone="kdelibs kconfig_compiler">
232 <primary sortas="b-kconfig_compiler">kconfig_compiler</primary>
233 </indexterm>
234 </listitem>
235 </varlistentry>
236
237 <varlistentry id="kcookiejar4">
238 <term><command>kcookiejar4</command></term>
239 <listitem>
240 <para>
241 is the KDE HTTP cookie daemon.
242 </para>
243 <indexterm zone="kdelibs kcookiejar4">
244 <primary sortas="b-kcookiejar4">kcookiejar4</primary>
245 </indexterm>
246 </listitem>
247 </varlistentry>
248
249 <varlistentry id="kde4-config">
250 <term><command>kde4-config</command></term>
251 <listitem>
252 <para>
253 is used to print the KDE installation paths.
254 </para>
255 <indexterm zone="kdelibs kde4-config">
256 <primary sortas="b-kde4-config">kde4-config</primary>
257 </indexterm>
258 </listitem>
259 </varlistentry>
260
261 <varlistentry id="kded4">
262 <term><command>kded4</command></term>
263 <listitem>
264 <para>
265 is the KDE daemon.
266 </para>
267 <indexterm zone="kdelibs kded4">
268 <primary sortas="b-kded4">kded4</primary>
269 </indexterm>
270 </listitem>
271 </varlistentry>
272
273 <varlistentry id="kdeinit4">
274 <term><command>kdeinit4</command></term>
275 <listitem>
276 <para>
277 is the KDE process launcher.
278 </para>
279 <indexterm zone="kdelibs kdeinit4">
280 <primary sortas="b-kdeinit4">kdeinit4</primary>
281 </indexterm>
282 </listitem>
283 </varlistentry>
284
285 <varlistentry id="kjs">
286 <term><command>kjs</command></term>
287 <listitem>
288 <para>
289 is the KDE ECMAScript/JavaScript engine.
290 </para>
291 <indexterm zone="kdelibs kjs">
292 <primary sortas="b-kjs">kjs</primary>
293 </indexterm>
294 </listitem>
295 </varlistentry>
296
297 <varlistentry id="kjscmd">
298 <term><command>kjscmd</command></term>
299 <listitem>
300 <para>
301 is a tool used for launching KJSEmbed scripts from
302 the command line.
303 </para>
304 <indexterm zone="kdelibs kjscmd">
305 <primary sortas="b-kjscmd">kjscmd</primary>
306 </indexterm>
307 </listitem>
308 </varlistentry>
309
310 <varlistentry id="kross">
311 <term><command>kross</command></term>
312 <listitem>
313 <para>
314 is the KDE application used to run kross scripts.
315 </para>
316 <indexterm zone="kdelibs kross">
317 <primary sortas="b-kross">kross</primary>
318 </indexterm>
319 </listitem>
320 </varlistentry>
321
322 <varlistentry id="makekdewidgets">
323 <term><command>makekdewidgets</command></term>
324 <listitem>
325 <para>
326 is used to build Qt widget plugins from an ini style
327 description file.
328 </para>
329 <indexterm zone="kdelibs makekdewidgets">
330 <primary sortas="b-makekdewidgets">makekdewidgets</primary>
331 </indexterm>
332 </listitem>
333 </varlistentry>
334
335 <varlistentry id="meinproc4">
336 <term><command>meinproc4</command></term>
337 <listitem>
338 <para>
339 is used to convert DocBook files to HTML.
340 </para>
341 <indexterm zone="kdelibs meinproc4">
342 <primary sortas="b-meinproc4">meinproc4</primary>
343 </indexterm>
344 </listitem>
345 </varlistentry>
346
347 <varlistentry id="preparetips">
348 <term><command>preparetips</command></term>
349 <listitem>
350 <para>
351 is a script used to extract the text from a tips file.
352 </para>
353 <indexterm zone="kdelibs preparetips">
354 <primary sortas="b-preparetips">preparetips</primary>
355 </indexterm>
356 </listitem>
357 </varlistentry>
358
359 </variablelist>
360
361 </sect2>
362
363</sect1>
Note: See TracBrowser for help on using the repository browser.