Gentoo Archives: gentoo-commits

From: "Theo Chatzimichos (tampakrap)" <tampakrap@g.o>
To: gentoo-commits@l.g.o
Subject: [gentoo-commits] gentoo commit in xml/htdocs/proj/en/desktop/kde: kde4-guide.xml
Date: Fri, 26 Jun 2009 20:40:51
Message-Id: E1MKIE4-0000JW-BA@stork.gentoo.org
1 tampakrap 09/06/26 20:40:48
2
3 Modified: kde4-guide.xml
4 Log:
5 Major rewrite of kde 4 guide: added kde3 references as well, added note about monolithic ebuilds, cleaned up kde4, added note about kdeprefix, added snapshots and live ebuilds installation guide
6
7 Revision Changes Path
8 1.25 xml/htdocs/proj/en/desktop/kde/kde4-guide.xml
9
10 file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/desktop/kde/kde4-guide.xml?rev=1.25&view=markup
11 plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/desktop/kde/kde4-guide.xml?rev=1.25&content-type=text/plain
12 diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/desktop/kde/kde4-guide.xml?r1=1.24&r2=1.25
13
14 Index: kde4-guide.xml
15 ===================================================================
16 RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/desktop/kde/kde4-guide.xml,v
17 retrieving revision 1.24
18 retrieving revision 1.25
19 diff -u -r1.24 -r1.25
20 --- kde4-guide.xml 22 Jun 2009 17:22:43 -0000 1.24
21 +++ kde4-guide.xml 26 Jun 2009 20:40:48 -0000 1.25
22 @@ -1,11 +1,14 @@
23 <?xml version="1.0" encoding="UTF-8"?>
24 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
25 -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/desktop/kde/kde4-guide.xml,v 1.24 2009/06/22 17:22:43 tampakrap Exp $ -->
26 +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/desktop/kde/kde4-guide.xml,v 1.25 2009/06/26 20:40:48 tampakrap Exp $ -->
27
28 <guide link="/proj/en/desktop/kde/kde4-guide.xml" lang="en">
29 -<title>Gentoo KDE 4.X Guide</title>
30 +<title>Gentoo KDE Guide</title>
31
32 <author title="Author">
33 + <mail link="tampakrap" />
34 +</author>
35 +<author title="Author">
36 <mail link="scarabeus" />
37 </author>
38 <author title="Author">
39 @@ -19,7 +22,7 @@
40 </author>
41
42 <abstract>
43 -This guide demonstrates how to setup KDE 4.X using the ebuilds in the tree. Some
44 +This guide demonstrates how to setup KDE using the ebuilds in the tree. Some
45 tools from the KDE team's git overlay (kde-testing) will be used.
46 </abstract>
47
48 @@ -27,135 +30,499 @@
49 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
50 <license/>
51
52 -<version>0.5</version>
53 -<date>2009-02-14</date>
54 +<version>0.6</version>
55 +<date>2009-06-26</date>
56
57 <chapter>
58 -<title>Cleaning up</title>
59 +<title>KDE 3</title>
60 <section>
61 -<title>Removing old KDE versions</title>
62 +<title>Introduction</title>
63 <body>
64
65 <p>
66 -In order to minimize issues, it is best to begin with a clean enviroment. You
67 -will need to uninstall any beta or 4.0.X releases (this is needed if you are
68 -moving from any overlay and in particular if you plan to use the -kdeprefix USE
69 -flag - FHS install). Two possible ways of removing old KDE 4 installations are:
70 +KDE 3 is no longer maintained by upstream, with 3.5.10 being their last release.
71 +Also, most KDE 3 applications aren't maintained any more, as they already have been
72 +or are currently being ported to KDE 4. The Gentoo KDE Team, provides both KDE 3
73 +and KDE 4 ebuilds for the base KDE and for various applications, and supports a side
74 +by side full desktop installation of KDE 3 and 4, including misc KDE applications.
75 +Our advice is for you to install and use by default a full KDE 4 desktop, and use
76 +only the KDE 3 applications that you feel have yet to be propperly ported to KDE 4
77 +(due to missing features, random crashes etc).
78 </p>
79
80 -<pre caption="Unmerging commands">
81 -# <i>emerge -C @kde-4.1 @kdebase-4.1</i> <comment>(only if you are coming from the kdesvn-portage or kde-testing overlay)</comment>
82 -# <i>emerge -C $(qfile -C -q -e /usr/kde/%PREFIX%)</i> <comment>(replace %PREFIX% with your KDE version, eg. 4)</comment>
83 -</pre>
84 +<warn>
85 +Keep in mind that since KDE 3 isn't maintained by upstream any more, it is possible
86 +and likely that bug reports concerning KDE 3 applications may not be fixed, but
87 +rather closed as WONTFIX / CANTFIX / UPSTREAM, or instead kept open for a long time
88 +until a fix (patch) is provided.
89 +</warn>
90
91 -<pre caption="Unmerging commands (only applicable if you are moving from an overlay)">
92 -# <i>cd /path/to/old/overlay/</i>
93 -# <i>emerge -C $(find ./ -name \*.ebuild |sed -e "s:.ebuild::" -e "s:./::" |awk -F'/' '{print "="$1"/"$3}')</i>
94 -</pre>
95 +</body>
96 +</section>
97 +<section>
98 +<title>KDE 3 Stabilization</title>
99 +<body>
100
101 <p>
102 -As a final step you should remove the old overlay so that there are no conflicts
103 -with the KDE ebuilds. You should remove the old unmask and/or keyword data, too.
104 +Currently 3.5.9 is marked stable on all architectures (with stable keywords), while
105 +3.5.10 is in the process of stabilization (see <uri link="https://bugs.gentoo.org/271889">
106 +bug 271889</uri>) - it is already stable on the amd64 and x86 arches.<br />
107 +KDE 3.5.10 uses only split ebuilds, meaning that users of monolithic ebuilds (like
108 +kdebase, kdepim, kdegames etc) must unemerge them manually and then proceed with
109 +the installation of KDE 3.5.10 as described below.
110 </p>
111
112 -<note>
113 -Don't forget to run depclean in order to uninstall any dependant packages.
114 -</note>
115 +<p>
116 +The team is also cleaning up the various KDE 3 applications, either by removing them
117 +from the tree, if they are too old, broken and unmaintained, or by stabilizing the
118 +latest version after moving the SLOT to :3.5. (<uri
119 +link="https://bugs.gentoo.org/270945">bug 270945</uri>), and dropping arts support
120 +(with major help from Media/Video teams). When this task is finished, we are going to
121 +drop arts from base KDE 3 as well.
122 +</p>
123
124 </body>
125 </section>
126 -</chapter>
127 -<chapter>
128 -<title>Unmasking/Keywording</title>
129 <section>
130 -<title>Using the package.keywords/kde file from the kde-testing overlay</title>
131 +<title>KDE 3.5.10 Installation</title>
132 <body>
133
134 <p>
135 -The KDE 4.2 ebuilds are now unmasked. If you're running the stable tree, you'll need
136 -to keyword the packages. You can get the package.keywords file from <uri
137 -link="http://git.overlays.gentoo.org/gitweb/?p=proj/kde.git;a=blob_plain;f=Documentation/package.keywords/kde-4.2.keywords;hb=master">
138 -Documentation/package.keywords/kde-4.2.keywords</uri>.
139 -The KDE 4.1 ebuilds are also not masked.
140 -If you are running the stable tree you will need to keyword the ebuilds,
141 -otherwise skip this step. For those running the stable tree in Gentoo:
142 +The installation of KDE 3 can be done either by using the meta packages (kdebase-meta,
143 +kdepim-meta, kde-meta) or by using the sets. As stated before, users of monolithic 3.5.9
144 +ebuilds that want to update to 3.5.10 and get strange blocks, should manually unemerge
145 +monolithic 3.5.9 ebuilds (kdebase, kdepim, kdegames etc) and emerge 3.5.10 as explained
146 +below. For installation using meta packages:
147 +</p>
148 +
149 +<pre caption="Installation of KDE 3 using meta packages">
150 +# <i>emerge -av kde-meta:3.5</i> <comment>(contains all of KDE modules)</comment>
151 +# <i>emerge -av kdebase-meta:3.5 kdegames-meta:3.5</i> <comment>(installation of chosen modules only)</comment>
152 +</pre>
153 +
154 +<note>
155 +Installation of KDE 3 can be done in parallel with KDE 4, because both use different eclasses,
156 +thus different slotting and prefix, so they don't affect each other. <c>kdeprefix</c> USE Flag
157 +for KDE 4 (explained later) has nothing to do with KDE 3/4 mixed installations.
158 +</note>
159 +
160 +<p>
161 +For installation using sets check the <uri link="#sets">Using Sets</uri> section.
162 </p>
163
164 <p>
165 -Get the appropriate package.keywords file from the <c>kde-testing</c>
166 -overlay that can be used in your package.keywords file/directory. You
167 -can find this file under <uri
168 -link="http://git.overlays.gentoo.org/gitweb/?p=proj/kde.git;a=tree;f=Documentation/package.keywords;hb=master">
169 -Documentation/package.keywords</uri>
170 +In case KDE 3.5.10 isn't marked stable in your architecture yet (or you are using ~mips or
171 +~x86-fbsd, that don't provide stable keywords any more), we provide a package.keywords file
172 +in <c>kde-testing</c> overlay under <uri
173 +link="http://git.overlays.gentoo.org/gitweb/?p=proj/kde.git;a=blob_plain;f=Documentation/package.keywords/kde-3.5.keywords;hb=HEAD">
174 +Documentation/package.keywords</uri> directory.
175 </p>
176
177 +<pre caption="Adding the file to the package.keywords file">
178 +# <i>cd /etc/portage/</i>
179 +# <i>cat /path/to/kde-3.5.keywords/file >> package.keywords</i>
180 +</pre>
181 +
182 <pre caption="Adding the file to the package.keywords directory">
183 # <i>cd /etc/portage/package.keywords</i>
184 -# <i>cp /path/to/keywords/file .</i>
185 +# <i>cp /path/to/kde-3.5-keywords/file .</i>
186 </pre>
187
188 -<pre caption="Adding the file to the package.keywords file">
189 -# <i>cd /etc/portage/</i>
190 -# <i>cat /path/to/keywords/file >> package.keywords</i>
191 +</body>
192 +</section>
193 +<section>
194 +<title>Installation of KDE 3 Applications</title>
195 +<body>
196 +
197 +<p>
198 +As stated before, KDE 3 Applications are slotted as :3.5, which allows users to have them
199 +installed along with the KDE 4 equivalents, just like in the base applications. For better
200 +administration of your system, you could take full advantage of slots and use slotted
201 +package selections in your package.keywords and world file. For example:
202 +</p>
203 +
204 +<pre caption="Installation of KDE 3 application">
205 +# <i>echo "app-cat/application:3.5" &gt;&gt; /etc/portage/package.keywords[/&lt;file&gt;]</i>
206 +<comment>(in case the KDE 3 application is still keyworded as testing)</comment>
207 +# <i>emerge -av application:3.5</i>
208 </pre>
209
210 +<p>
211 +The same rules apply for KDE 4 applications, which are slotted as :4. This way, the emerge
212 +and removal of an application can be easily done without conflicts, blocks, or unwanted
213 +removals.
214 +</p>
215 +
216 </body>
217 </section>
218 </chapter>
219 <chapter>
220 -<title>Installation</title>
221 +<title>KDE 4</title>
222 <section>
223 -<title>The new kdeprefix USE flag</title>
224 +<title>Introduction</title>
225 +<body>
226 +
227 +<p>
228 +KDE 4 is the current KDE version supported by upstream. The current KDE 4 version
229 +available through portage is 4.2.4 (this version is considered stable by upstream).
230 +In addition, KDE upstream provides weekly <uri link="ftp://ftp.kde.org/pub/kde/unstable">
231 +snapshots</uri>, and a <uri link="http://websvn.kde.org">live SVN tree</uri>.
232 +The Gentoo KDE team provides the snapshots, trunk and latest branch live ebuilds,
233 +through the <c>kde-testing</c> overlay. To enable this, the user can have multiple
234 +parallel KDE 4 installations, with the use of the <c>kdeprefix</c> USE flag.
235 +</p>
236 +
237 +<p>
238 +Choose what KDE version is most appropriate for you:
239 +</p>
240 +<table>
241 +<tr>
242 + <ti><uri link="#kde_portage">KDE from Portage (currently 4.2.4)</uri></ti>
243 +</tr>
244 +<tr>
245 + <ti><uri link="#snapshots">KDE snapshots (currently 4.2.X)</uri></ti>
246 +</tr>
247 +<tr>
248 + <ti><uri link="#live">KDE live ebuilds</uri></ti>
249 +</tr>
250 +</table>
251 +
252 +</body>
253 +</section>
254 +<section>
255 +<title>The kdeprefix USE flag</title>
256 <body>
257
258 <warn>
259 -Big Fat Warning! The kdeprefix USE flag is masked. It's <b>unsupported</b>
260 -and shouldn't be used by users in any way. Use on your own risk.
261 +The <c>kdeprefix</c> USE flag is currently masked. It's <b>unsupported</b>
262 +and shouldn't be used by users in any way. Use at your own risk. Read bellow
263 +for the reasons that led to the masking of the USE flag.
264 </warn>
265
266 <p>
267 -The new kdeprefix USE flag allows users to choose between an FHS compliant
268 -install (-kdeprefix) or a slotted install in the KDE prefix (+kdeprefix).
269 +The <c>kdeprefix</c> USE flag allows users to choose between an FHS compliant
270 +install (<c>-kdeprefix</c>) or a slotted install in the KDE prefix (<c>+kdeprefix</c>).
271 </p>
272
273 <p>
274 -If kdeprefix is disabled (default) KDE is installed into the FHS compliant
275 -location, i.e. /usr. That means that all of the files are put under /usr. This
276 -is the desired behaviour for most users. The drawback of the FHS compliant
277 -install is that it will not be possible to have more than one minor version of
278 -KDE side by side (previous behaviour), e.g. KDE 4.1 and 4.2.
279 +If <c>kdeprefix</c> is disabled (default) KDE is installed into the FHS compliant
280 +location, i.e. <path>/usr</path>. That means that all of the files are put under
281 +<path>/usr</path>. This is the desired behaviour for most users. The drawback of
282 +the FHS compliant install is that it will not be possible to have more than one
283 +minor version of KDE side by side (previous behaviour), e.g. KDE 4.2 and 4.3.
284 </p>
285
286 <note>
287 -This restriction does not apply to KDE 3.5 (which uses different eclasses) or
288 -live versions (as they will continue to be installed under
289 -/usr/kde/${live-slot}. You can have a non-kdeprefix version of KDE
290 -4.1, KDE 3.5 and a live version of KDE installed on the same system.
291 +This restriction does not apply to KDE 3 (which uses different prefix (<path>/usr/kde/3.5</path>)).
292 +You can have KDE 3.5 with either <c>-kdeprefix</c> or <c>kdeprefix</c> KDE 4.X in the same system.
293 </note>
294
295 +<warn>
296 +Mixing a <c>+kdeprefix</c> and a <c>-kdeprefix</c> KDE installation is not supported, nor
297 +recommended. If you really want kdeprefix in your system, you'll have to unmask
298 +it and put it globally in <path>/etc/make.conf</path>
299 +</warn>
300 +
301 <p>
302 -If kdeprefix is enabled then KDE is installed into /usr/kde/${SLOT},
303 -which allows you to install KDE 4.1, 4.2, 4.3, etc. in /usr/kde/4.1,
304 -/usr/kde/4.2, and /usr/kde/4.3 for example.
305 +If <c>kdeprefix</c> is enabled then KDE is installed into <path>/usr/kde/${SLOT}</path>,
306 +which allows you to install KDE 4.2, 4.3, live etc. in <path>/usr/kde/4.2</path>,
307 +<path>/usr/kde/4.3</path>, and <path>/usr/kde/live</path> for example.
308 </p>
309
310 <warn>
311 -If you want to move between kdeprefix and -kdeprefix (or vice-versa), it is
312 +If you want to move between <c>kdeprefix</c> and <c>-kdeprefix</c> (or vice-versa), it is
313 recommended that you unmerge all KDE packages and then emerge it with the
314 modified flag. If this is not done, KDE installations can have trouble finding
315 -certain libraries/plugins.
316 +certain libraries/plugins. Check <uri link="#cleanup">Cleaning Up KDE</uri>
317 +for more details.
318 +</warn>
319 +
320 +<p>
321 +Recently <c>kdeprefix</c> got masked by default, as it caused many problems, like
322 +collisions between the same packages when having two or more KDE installations,
323 +or strange behaviour even when only one <c>+kdeprefix</c> KDE installation was present
324 +in the system. Great examples of packages with such problems are pykde4 and
325 +amarok. Since the Gentoo KDE Team decided to proceed with the stabilization of KDE 4
326 +(KDE 4.2.4 being the best candidate at this moment), those issues needed to be resolved
327 +first. As it was difficult to fix them, we decided to mask the use flag instead.
328 +<b>If you really know what you are doing</b> and you are sure that you want
329 +<c>kdeprefix</c> unmasked and enabled in your system, please read the portage manpage
330 +to unmask it, and add it globally to <path>/etc/make.conf</path>.
331 +</p>
332 +
333 +</body>
334 +</section>
335 +<section id="kde_portage">
336 +<title>Installing KDE 4.2.4 (from Portage)</title>
337 +<body>
338 +
339 +<p>
340 +<uri link="http://kde.org/announcements/announce-4.2.4.php">KDE 4.2.4</uri> is the
341 +KDE 4 version that Gentoo has in Portage - it's considered by upstream as the latest
342 +stable. Currently it's in the testing branch in Portage, but in June's meeting the
343 +Gentoo KDE Team decided to move forward with KDE 4 stabilization - 4.2.4 being the
344 +best candidate.
345 +</p>
346 +
347 +<note>
348 +In order to minimize issues it is recommended to start with a clean environment. Read
349 +more in <uri link="#cleanup">Cleaning Up KDE</uri> section.
350 +</note>
351 +
352 +<p>
353 +Users with stable systems have to keyword the packages to proceed.
354 +We provide a package.keyword file in <c>kde-testing</c> overlay under <uri
355 +link="http://git.overlays.gentoo.org/gitweb/?p=proj/kde.git;a=blob_plain;f=Documentation/package.keywords/kde-4.2.keywords;hb=master">
356 +Documentation/package.keywords/</uri> directory.
357 +</p>
358 +
359 +<pre caption="Adding the file to the package.keywords file">
360 +# <i>cd /etc/portage/</i>
361 +# <i>cat /path/to/kde-4.2.keywords/file >> package.keywords</i>
362 +</pre>
363 +
364 +<pre caption="Adding the file to the package.keywords directory">
365 +# <i>cd /etc/portage/package.keywords</i>
366 +# <i>cp /path/to/kde-4.2.keywords/file .</i>
367 +</pre>
368 +
369 +<p>
370 +The installation can be done either by using the meta packages or by using sets.
371 +</p>
372 +
373 +<pre caption="Installation of KDE 4.2.4 using meta packages">
374 +# <i>emerge -av kde-meta:4.2</i> <comment>(contains all of KDE modules)</comment>
375 +# <i>emerge -av kdebase-meta:4.2 kdegames-meta:4.2</i> <comment>(installation of chosen modules only)</comment>
376 +</pre>
377 +
378 +<p>
379 +For installation using sets check the <uri link="#sets">Using Sets</uri> section.
380 +</p>
381 +
382 +</body>
383 +</section>
384 +<section id="snapshots">
385 +<title>Installing KDE 4.2.X snapshots (from kde-testing overlay)</title>
386 +<body>
387 +
388 +<warn>
389 +KDE snapshots are <b>bleeding edge</b>. Use at your own risk.
390 +</warn>
391 +
392 +<p>
393 +KDE upstream provides <uri link="ftp://ftp.kde.org/pub/kde/unstable">weekly snapshots</uri>
394 +taken from the <uri link="http://websvn.kde.org/trunk/">SVN trunk tree</uri>. KDE now provides
395 +4.2.X snapshot series, and after 4.3 release they are going to start with 4.3.60. Beta and
396 +Release Candidate KDE releases are following the snapshot model bellow:
397 +</p>
398 +
399 +<table>
400 +<tr>
401 + <th>Snaphot version</th>
402 + <th>KDE Version</th>
403 +</tr>
404 +<tr>
405 + <ti>4.X.85</ti>
406 + <ti>KDE 4.X Beta 1</ti>
407 +</tr>
408 +<tr>
409 + <ti>4.X.90</ti>
410 + <ti>KDE 4.X Beta 2</ti>
411 +</tr>
412 +<tr>
413 + <ti>4.X.95</ti>
414 + <ti>KDE 4.X Release Candidate</ti>
415 +</tr>
416 +</table>
417 +
418 +<note>
419 +In order to minimize issues it is recommended to start with a clean environment. Read
420 +more in <uri link="#cleanup">Cleaning Up KDE</uri> section.
421 +</note>
422 +
423 +<note>
424 +You'll need portage-2.2_rc*, so please add <c>~sys-apps/portage-2.2</c> entry to your
425 +<path>/etc/portage/package.unmask[/*]</path> file.
426 +</note>
427 +
428 +<p>
429 +Snapshots are only available through <c>kde-testing</c> overlay, so you first need to
430 +add it:
431 +</p>
432 +
433 +<pre caption="Installing kde-testing overlay from layman">
434 +# <i>layman -f -a kde-testing</i>
435 +<comment>For more information regarding overlays, please read the <uri
436 +link="http://www.gentoo.org/proj/en/overlays/userguide.xml">Overlay Guide</uri></comment>
437 +</pre>
438 +
439 +<p>
440 +If you're used to git repos, don't want to use layman and rather do all
441 +the sync work yourself, you can install the repo directly:
442 +</p>
443 +
444 +<pre caption="Installing kde-testing overlay directly">
445 +# <i>mkdir /&lt;repo-base-dir&gt;</i>
446 +# <i>cd /&lt;repo-base-dir&gt;</i>
447 +# git clone git://git.overlays.gentoo.org/proj/kde.git
448 +</pre>
449 +
450 +<p>
451 +Users with stable systems have to keyword the packages to proceed.
452 +We provide a package.keyword file in <c>kde-testing</c> overlay, which we'll
453 +have to symlink to our package.keywords directory:
454 +</p>
455 +
456 +<pre caption="Creating symlink of the kde-4.3.keywords file">
457 +# <i>cd /etc/portage/package.keywords</i>
458 +# <i>ln -s /path/to/overlay/kde-testing/Documentation/package.keywords/kde-4.3.keywords .</i>
459 +</pre>
460 +
461 +<p>
462 +Finally, to install them you'll have to use sets, as we don't provide meta packages
463 +for snapshots.
464 +</p>
465 +
466 +<pre caption="Installation of KDE snapshots using sets">
467 +# <i>emerge -av @kde-4.3</i> <comment>(contains all of KDE modules)</comment>
468 +# <i>emerge -av @kdebase-4.3 @kdegames-4.3</i> <comment>(installation of chosen modules only)</comment>
469 +<comment>See the <uri link="#sets">Using Sets</uri> section for more information.</comment>
470 +</pre>
471 +
472 +</body>
473 +</section>
474 +<section id="live">
475 +<title>Installing KDE live ebuilds (from kde-testing overlay)</title>
476 +<body>
477 +
478 +<warn>
479 +KDE live ebuilds are <b>bleeding edge</b>. Use at your own risk.
480 </warn>
481
482 +<p>
483 +KDE is Open Source, with its code being available for browsing through<uri
484 +link="http://websvn.kde.org">KDE Websvn</uri>, and for public checkout
485 +through an anonymous (anonsvn) account. Gentoo, as a source based distro,
486 +has the ability to provide live ebuilds that checkout the code either from
487 +the latest branch or from trunk. Currently, we provide 4.2.9999 ebuilds
488 +from 4.2 branch and 4.3.9999 ebuilds from 4.3 branch, as both are alive.
489 +We are going to drop 4.2.9999 ebuilds when 4.3 gets released officially.
490 +</p>
491 +
492 +<table>
493 +<tr>
494 + <th>Ebuilds version</th>
495 + <th>KDE Version</th>
496 +</tr>
497 +<tr>
498 + <ti>4.2.9999</ti>
499 + <ti>KDE 4.2 Branch</ti>
500 +</tr>
501 +<tr>
502 + <ti>4.3.9999</ti>
503 + <ti>KDE 4.3.Branch</ti>
504 +</tr>
505 +<tr>
506 + <ti>9999</ti>
507 + <ti>KDE 4 Trunk (currently 4.4)</ti>
508 +</tr>
509 +</table>
510 +
511 <note>
512 -kdeprefix is now masked by default though, as it caused many issues that blocked
513 -the stabilization of KDE 4 that aren't easy to fix. If you really want kdeprefix
514 -USE flag you'll have to read portage manpages to find out how to unmask it.
515 +In order to minimize issues it is recommended to start with a clean environment. Read
516 +more in <uri link="#cleanup">Cleaning Up KDE</uri> section.
517 +</note>
518 +
519 +<note>
520 +You'll need portage-2.2_rc*, so please add <c>~sys-apps/portage-2.2</c> entry in your
521 +<path>/etc/portage/package.unmask</path> file.
522 +</note>
523 +
524 +<p>
525 +Live ebuilds are only available through <c>kde-testing</c> overlay, so first thing is to install
526 +it:
527 +</p>
528 +
529 +<pre caption="Installing kde-testing overlay">
530 +# <i>layman -f -a kde-testing</i>
531 +<comment>For more information regarding overlays, please read the <uri
532 +link="http://www.gentoo.org/proj/en/overlays/userguide.xml">Overlay Guide</uri></comment>
533 +</pre>
534 +
535 +<p>
536 +Users with stable systems have to keyword the packages to proceed.
537 +We provide a package.keyword file in <c>kde-testing</c> overlay, which we'll
538 +have to symlink to our package.keywords directory:
539 +</p>
540 +
541 +<pre caption="Creating symlink of the kde-4.X.9999.keywords or kde-live file">
542 +# <i>cd /etc/portage/package.keywords</i>
543 +# <i>ln -s /path/to/overlay/kde-testing/Documentation/package.keywords/kde-4.2.9999.keywords .</i><comment>(for 4.2 Branch)</comment>
544 +# <i>ln -s /path/to/overlay/kde-testing/Documentation/package.keywords/kde-4.3.9999.keywords .</i><comment>(for 4.3 Branch)</comment>
545 +# <i>ln -s /path/to/overlay/kde-testing/Documentation/package.keywords/kde-live.keywords .</i><comment>(for KDE 4.4 Trunk)</comment>
546 +</pre>
547 +
548 +<p>
549 +Finally, to install them you'll have to use sets, as we don't provide meta packages
550 +for live ebuilds.
551 +</p>
552 +
553 +<pre caption="Installation of KDE live ebuilds using sets">
554 +<comment>(For KDE 4.2 Branch:)</comment>
555 +# <i>emerge -av @kde-4.2</i> <comment>(contains all of KDE modules)</comment>
556 +# <i>emerge -av @kdebase-4.2 @kdegames-4.2</i> <comment>(installation of chosen modules only)</comment>
557 +<comment>(For KDE 4.3 Branch)</comment>
558 +# <i>emerge -av @kde-4.3</i> <comment>(contains all of KDE modules)</comment>
559 +# <i>emerge -av @kdebase-4.3 @kdegames-4.3</i> <comment>(installation of chosen modules only)</comment>
560 +<comment>(For KDE 4.4 Trunk)</comment>
561 +# <i>emerge -av @kde-live</i> <comment>(contains all of KDE modules)</comment>
562 +# <i>emerge -av @kdebase-live @kdegames-live</i> <comment>(installation of chosen modules only)</comment>
563 +<comment>See the <uri link="#sets">Using Sets</uri> section for more information.</comment>
564 +</pre>
565 +
566 +<note>
567 +You may be interested for Qt live ebuilds as well. Check the Qt Guide (TODO) for
568 +installation instructions.
569 </note>
570
571 </body>
572 </section>
573 <section>
574 -<title>Using sets</title>
575 +<title>Installation of KDE 4 Applications</title>
576 +<body>
577 +
578 +<p>
579 +KDE 4 Applications are slotted in :4, which allows the users to have them
580 +installed along with the KDE 3 equivalents, just like in the base applications. For better
581 +administration of your system, you could take full advantage of slots and use slotted
582 +package selections in your package.keywords and world file. For example:
583 +</p>
584 +
585 +<pre caption="Installation of KDE 4 application">
586 +# <i>echo "app-cat/application:4" >> /etc/portage/package.keywords</i>
587 +# <i>emerge -av application:4</i>
588 +</pre>
589 +
590 +<p>
591 +The same rules apply for KDE 3 applications, which are slotted in :3.5. This way, the emerge
592 +and removal of an application can be easily done without conflicts, blocks, or unwanted
593 +removals.
594 +</p>
595 +
596 +<p>
597 +In kde-testing you may find live ebuilds of KDE 4 applications. These are slotted in :4
598 +as well, but they <b>can not</b> be installed in parallel with normal ones. You are
599 +free though to use live KDE 4 applications with KDE 4 from portage, or to use
600 +portage KDE 4 applications with your live KDE.
601 +</p>
602 +
603 +</body>
604 +</section>
605 +</chapter>
606 +<chapter>
607 +<title>Additional Installation/Removal Information</title>
608 +<section id="sets">
609 +<title>Using Sets</title>
610 <body>
611
612 <warn>
613 @@ -176,10 +543,16 @@
614 link="http://git.overlays.gentoo.org/gitweb/?p=proj/kde.git;a=tree;f=sets">sets
615 directory</uri> or grab them as a <uri
616 link="http://git.overlays.gentoo.org/gitweb/?p=proj/kde.git;a=snapshot;h=5b2fc54fa5d1c8aeddaeb05f044bf28754bb18be;sf=tbz2">
617 -tar.bz2 archive</uri> and put the ones you like in <e>/etc/portage/sets</e> --
618 +tar.bz2 archive</uri> and put the ones you like in <path>/etc/portage/sets</path> --
619 you can browse the list of sets provided by the KDE team in the overlay
620 by using the first link.
621 </p>
622 +
623 +<note>
624 +In case you are using <c>kde-testing</c> overlay you can use sets directly instead
625 +of copying them to <path>/etc/portage/sets</path>.
626 +</note>
627 +
628 <p>
629 Amongst others, there are sets for each KDE tarball - @kdeaccessibility,
630 @kdeadmin, @kdeartwork, @kdebase, @kdeedu, @kdegames, @kdegraphics,
631 @@ -192,16 +565,16 @@
632
633 <p>
634 One can install the complete KDE by running <e>emerge -av @kde</e>. The specific
635 -version equivalents are very useful to uninstall an old version, e.g. <e>emerge
636 --C @kde-3.5</e>, or to reinstall all packages from a specific version, e.g.
637 -<e>emerge -av1 @kde-4x</e>. Advanced features, like removing any unwanted
638 +version equivalents are very useful to uninstall an old version, e.g. <c>emerge
639 +-C @kde-3.5</c>, or to reinstall all packages from a specific version, e.g.
640 +<c>emerge -av1 @kde-4x</c>. Advanced features, like removing any unwanted
641 packages from a set, will be supported in a future release of Portage -- you can
642 read more about it in <uri
643 link="http://planet.gentoo.org/developers/genone/2008/09/29/more_extensions_to_package_set_support">Marius
644 Mauch's (genone) blog</uri>. Part of this code has now been released in
645 portage-2.2_rc12 and so you can reinstall all installed packages of a set
646 with <c>emerge -av @&lt;set&gt;/@installled</c> or to have a
647 -/etc/portage/sets/kdebase-unwanted set and then run <e>emerge -av
648 +<path>/etc/portage/sets/kdebase-unwanted</path> set and then run <e>emerge -av
649 @kdebase-@kdebase-unwanted</e>.
650 </p>
651
652 @@ -228,19 +601,52 @@
653
654 </body>
655 </section>
656 -<section>
657 -<title>KDE meta packages</title>
658 +<section id="cleanup">
659 +<title>Cleaning Up KDE</title>
660 <body>
661
662 +<p>
663 +In order to minimize issues, it is best to begin with a clean enviroment. This is
664 +recommended for the following cases:
665 + * Moving from <c>+kdeprefix</c> to <c>-kdeprefix</c> (and vice versa)
666 + * Downgrading KDE (eg. from snapshots/live ebuilds to portage version)
667 + * Fully upgrading from KDE 3 to KDE 4 (and vice versa)
668 + * Moving from an old overlay
669 +Two possible ways of removing old KDE installations are:
670 +</p>
671 +
672 +<pre caption="Unmerging commands">
673 +# <i>emerge -C @kde-4.X @kdebase-4.X @kde-3.5</i>(using the typical sets)
674 +# <i>emerge -C $(qfile -C -q -e /usr/kde/%PREFIX%)</i> <comment>(replace %PREFIX% with your KDE version, eg. 3.5, 4)</comment>
675 +</pre>
676 +
677 +<pre caption="Unmerging commands (only applicable if you are moving from an overlay)">
678 +# <i>cd /path/to/overlay/</i>
679 +# <i>emerge -C $(find ./ -name \*.ebuild |sed -e "s:.ebuild::" -e "s:./::" |awk -F'/' '{print "="$1"/"$3}')</i>
680 +</pre>
681 +
682 +<p>
683 +As a final step you should remove the old overlay so that there are no conflicts
684 +with the KDE ebuilds. You should remove the old unmask and/or keyword data, too.
685 +</p>
686 +
687 <note>
688 -This method is provided to ease the transition to the new sets. We had planned
689 -not to have meta ebuilds for KDE 4.2, but as sets support isn't finalized yet,
690 -that portage-2.2 is still hard masked and that we can't have sets in the tree,
691 -we opted to offer metas for 4.2.
692 +Don't forget to run depclean in order to uninstall any dependant packages.
693 </note>
694
695 -<pre caption="emerge meta packages">
696 -# <i>emerge kde-meta:4.X</i> (Note: X is value of minor kde version 1, 2, etc.)
697 +</body>
698 +</section>
699 +<section>
700 +<title>Rebuilding the application database</title>
701 +<body>
702 +
703 +<p>
704 +To rebuild the KDE application database run:
705 +</p>
706 +
707 +<pre caption="kbuildsycoca command">
708 +# kbuildsycoca --noincremental (for KDE 3)
709 +# kbuildsycoca4 --noincremental (for KDE 4)
710 </pre>
711
712 </body>
713 @@ -255,24 +661,24 @@
714 is shiped to you, just name has been changed so now for getting translations use
715 theese comands.
716 </p>
717 +
718 <pre caption="emerge translations for kde4 packages">
719 # <i>emerge kde-l10n</i>
720 </pre>
721 +
722 <pre caption="emerge translations for kde3 packages">
723 # <i>emerge kde-i18n</i>
724 </pre>
725
726 </body>
727 </section>
728 -</chapter>
729 -<chapter>
730 -<title>Configuration</title>
731 <section>
732 +<title>Configuration of ~/.kde Directory</title>
733 <body>
734
735 <p>
736 -KDE stores its configuration files in the <e>~/.kde</e> directory by default. In
737 -the Gentoo ebuilds this has been changed in KDE 4.1 and later to allow for better
738 +KDE stores its configuration files in the <path>~/.kde</path> directory by default.
739 +In the Gentoo ebuilds this has been changed in KDE 4.1 and later to allow for better
740 integration of KDE 3.5 and 4.X when using the same user account. If you export
741 $KDEHOME this behaviour will be overridden. It is strongly recommended that you
742 do not do this. $KDEHOME will make KDE 3.5 and 4.X use the same configuration
743 @@ -280,10 +686,10 @@
744 </p>
745
746 <p>
747 -KDE 3.5 uses <e>~/.kde</e> and the default FHS (-kdeprefix) KDE 4.X uses
748 -<e>~/.kde4</e>. If you install KDE 4.1 using the kdeprefix USE flag then the
749 -configuration directory will default to <e>~/.kde4.1</e>, for KDE 4.2 it will
750 -be <e>~/.kde4.2</e> and so on.
751 +KDE 3.5 uses <path>~/.kde</path> and the default FHS (<c>-kdeprefix</c>) KDE 4.X uses
752 +<e>~/.kde4</e>. If you install KDE 4.1 using the <c>kdeprefix</c> USE flag then the
753 +configuration directory will default to <path>~/.kde4.1</path>, for KDE 4.2 it will
754 +be <path>~/.kde4.2</path> and so on.
755 The advantage of this is that KDE 3.5 and 4.X can be run from the same user
756 account without clobbering settings. Moving backwards in version, i.e. 4.X to
757 3.5, is not supported.
758 @@ -292,7 +698,7 @@
759 <p>
760 Settings are not migrated by default. If you want to attempt to migrate your
761 settings you should copy your old configuration directory to the new location
762 -before logging in. For example,
763 +before logging in. For example:
764 </p>
765
766 <pre caption="Copying the configuration directory">
767 @@ -309,138 +715,14 @@
768 </section>
769 </chapter>
770 <chapter>
771 -<title>Migration from earlier releases</title>
772 -<section>
773 -<title>Getting blocks while trying to update to 4.2.0</title>
774 -<body>
775 -
776 -<p>
777 -If you have KDE-4.0 or KDE-4.1 installed and get some blocks while trying to
778 -update to 4.2.0, make sure you don't have kde versioned deps in the world* files.
779 -</p>
780 -
781 -<pre caption="Looking for kde deps">
782 -# <i>grep kde /var/lib/portage/world*</i>
783 -</pre>
784 -
785 -<p>
786 -If you have in your world file a versioned dep as konqueror-4.1.2 or kwrite:4.1,
787 -you must replace it with konqueror and kwrite. If you're using sets and have
788 -@kdebase-4.1 in your world_sets file, you need to replace it for @kdebase.
789 -At the moment all plasmoids packages have a hard dep on libplasma that was removed
790 -for 4.2.0 and so it's blocked from kdelibs-4.2.0. You'll need to remove them from
791 -your system or at least remove them from your world file.
792 -</p>
793 -
794 -</body>
795 -</section>
796 -<section>
797 -<title>Upgrading from the kde-testing overlay</title>
798 -<body>
799 -
800 -<p>
801 -If you used the <c>kde-testing</c> overlay before the testing branch was merged
802 -back into the master overlay, you're going to get collision-protection errors
803 -when you try to update; the new ebuilds will show up as belonging to a new slot
804 -[NS]. This is caused by a move from the <e>4</e> to <e>4.1</e> SLOT. You have 2
805 -choices in this case:
806 -</p>
807 -
808 -</body>
809 -</section>
810 -<section>
811 -<title>Unmerging all of KDE and installing it again</title>
812 -<body>
813 -
814 -<pre caption="Unmerging kde-4.1">
815 -# <i>emerge -C @kde-4.1</i>
816 -</pre>
817 -
818 -</body>
819 -</section>
820 -<section>
821 -<title>Changing the SLOT of the installed ebuilds in the VDB</title>
822 -<body>
823 -
824 -<p>
825 -Changing the SLOT in the VDB may cause issues and is not recommended -- do it at
826 -your own risk. You should instead do the above. If you really want to do that,
827 -please grab <uri
828 -link="http://git.overlays.gentoo.org/gitweb/?p=proj/kde.git;a=blob_plain;f=Documentation/change_slot;hb=master">the
829 -script</uri> from the <c>kde-testing</c> overlay. You should only run it if you
830 -understand what it does and after you double checked it.
831 -</p>
832 -
833 -<note>
834 -Be warned that this script is known to eat your kittens or steal all your
835 -cookies.
836 -</note>
837 -
838 -<pre caption="Running change_slot to update the slot from 4 to 4.2">
839 -# <i>change_slot kde 4 4.2</i>
840 -# <comment>(After you confirm that it works as expected (you should see SLOTS as 4.2 and not 4))</comment>
841 -# <i>change_slot kde 4 4.2 Y</i>
842 -</pre>
843 -
844 -</body>
845 -</section>
846 -<section>
847 -<title>Removing KDE 3.5</title>
848 -<body>
849 -
850 -<pre caption="Unmerging KDE 3.5">
851 -# <i>emerge -C @kde-3.5</i>
852 -</pre>
853 -
854 -<note>
855 -Run depclean in order to remove all dependent packages.
856 -</note>
857 -
858 -</body>
859 -</section>
860 -<section>
861 -<title>No Desktop icon</title>
862 -<body>
863 -
864 -<p>
865 -KDE 4, as it moves towards a semantic desktop, did not bundle an icon for the
866 -desktop.
867 -</p>
868 -
869 -<p>
870 -The desktop icon can be replaced with the standard folder icon using the
871 -following command.
872 -</p>
873 -
874 -<pre caption="sed command">
875 -$ <i>sed -i -e "s:Icon=desktop:Icon=folder:g" ~/Desktop/.directory</i>
876 -</pre>
877 -
878 -</body>
879 -</section>
880 -<section>
881 -<title>Missing icons in KDE4</title>
882 -<body>
883 -
884 -<p>
885 -When you occur with this bug try first this command before opening bug.
886 -</p>
887 -<pre caption="emerge command">
888 -# <i>emerge -1 kdebase-data &amp;&amp; emerge -1 hicolor-icon-theme kdebase-data</i>
889 -</pre>
890 -
891 -</body>
892 -</section>
893 -</chapter>
894 -<chapter>
895 -<title>Hints</title>
896 +<title>Hints and Troubleshooting</title>
897 <section>
898 <title>Plasmoids</title>
899 <body>
900
901 <p>
902 Plasmoids are new plasma tools which can enhance your desktop experience
903 -to brand new level. We created kde-plasma/ section where we place every plasmoid
904 +to brand new level. Many plasmoids are available in kde-mis/ category,
905 on which we get our nasty hands and find it workable enought. If you find out
906 that your favorite one is missing create bug and somebody might create it for
907 you.
908 @@ -474,7 +756,6 @@
909
910 </body>
911 </section>
912 -
913 <section>
914 <title>x11-themes/gtk-engines-qtcurve</title>
915 <body>
916 @@ -487,7 +768,6 @@
917
918 </body>
919 </section>
920 -
921 <section>
922 <title>Unable to find libopensync-0.30</title>
923 <body>
924 @@ -504,20 +784,22 @@
925 </section>
926
927 <section>
928 -<title>Flash in konqueror</title>
929 +<title>Flash in Konqueror</title>
930 <body>
931
932 <p>
933 If you are interested in getting flash working in konqueror point your mind
934 to <uri link="kde-flash.xml" >guide</uri> which describes necessary steps for
935 -getting it done.
936 +getting it done. Latest www-plugins/adobe-flash (both 32 and 64-bit) should
937 +work flawlessly though, maybe you'll need to Scan for Plugins under
938 +Konqueror->Settings->Plugins.
939 </p>
940
941 </body>
942 </section>
943
944 <section>
945 -<title>Akonadi complains about the mysql config</title>
946 +<title>Akonadi Complains about the MySQL Config</title>
947 <body>
948
949 <p>
950 @@ -539,7 +821,6 @@
951
952 </body>
953 </section>
954 -
955 <section>
956 <title>KDM fails to start</title>
957 <body>
958 @@ -550,6 +831,7 @@
959 Check previous section.
960 If that doesn't solve the error, check the following notice in the kdm ebuild:
961 </p>
962 +
963 <pre caption="kdm notice">
964 If when you restart xdm, kdm fails to start with a message like "gentoo kdm[2116]: X
965 server startup timeout, terminating" in /var/log/messages, uncomment the ServerTimeout
966 @@ -557,56 +839,44 @@
967 and be sure to increase the timeout - 60 should work
968 </pre>
969
970 -</body>
971 -</section>
972 -
973 -<section>
974 -<title>The battery applet or solid notifications don't show the relevant info</title>
975 -<body>
976 -
977 <p>
978 -So that the battery applet or other solid notifications can show the relevant info,
979 -you need dbus and hald running.
980 +Also be sure that the following services are started:
981 </p>
982 -<pre caption="checking and starting dbus and hald">
983 +
984 +<pre caption="checking and starting services">
985 # <i>/etc/init.d/dbus status</i>
986 # <i>/etc/init.d/hald status</i>
987 -# <i>/etc/init.d/dbus start</i>
988 -# <i>/etc/init.d/hald start</i>
989 +# <i>/etc/init.d/consolekit status</i>
990 </pre>
991
992 -</body>
993 -</section>
994 -
995 -</chapter>
996 -<chapter>
997 -<title>Uninstalling KDE 4.X</title>
998 -<section>
999 -<title>Removing all KDE packages</title>
1000 -<body>
1001 -
1002 <p>
1003 -In order to remove all KDE 4 packages and dependant packages:
1004 +If not, enable them by replacing status with start, and use
1005 +the command <c>rc-update add dbus default</c> for every one
1006 +of them to add them to default runlevel.
1007 </p>
1008
1009 -<pre caption="Unmerging commands">
1010 -# <i>emerge -C @kde-4x</i>
1011 -# <i>cd /path/to/our/overlay/</i>
1012 -# <i>emerge -C $(find ./ -name \*.ebuild |sed -e "s:.ebuild::" -e "s:./::" |awk -F'/' '{print "="$1"/"$3}')</i>
1013 -</pre>
1014 +<p>
1015 +Finally, KDM could fail due to errors in xorg.conf. Take a
1016 +look in logs: <path>/var/log/Xorg.0.log</path> and
1017 +<path>/var/log/kdm.log</path> and fix xorg.conf accordingly.
1018 +For additional help you can find us in IRC (#gentoo-kde at Freenode).
1019 +</p>
1020
1021 </body>
1022 </section>
1023 <section>
1024 -<title>Rebuilding the application database</title>
1025 +<title>The battery applet or solid notifications don't show the relevant info</title>
1026 <body>
1027
1028 <p>
1029 -To rebuild the KDE 3 application database run:
1030 +So that the battery applet or other solid notifications can show the relevant info,
1031 +you need dbus and hald running.
1032 </p>
1033 -
1034 -<pre caption="kbuildsycoca command">
1035 -# kbuildsycoca --noincremental
1036 +<pre caption="checking and starting dbus and hald">
1037 +# <i>/etc/init.d/dbus status</i>
1038 +# <i>/etc/init.d/hald status</i>
1039 +# <i>/etc/init.d/dbus start</i>
1040 +# <i>/etc/init.d/hald start</i>
1041 </pre>
1042
1043 </body>