Gentoo Archives: gentoo-doc-cvs

From: Josh Saddler <nightmorph@×××××××××××.org>
To: gentoo-doc-cvs@l.g.o
Subject: [gentoo-doc-cvs] cvs commit: xfce-config.xml metadoc.xml
Date: Sat, 13 Jan 2007 05:58:50
Message-Id: E1H5buR-0003IF-MU@lark.gentoo.org
1 nightmorph 07/01/13 05:58:31
2
3 Modified: metadoc.xml
4 Added: xfce-config.xml
5 Log:
6 new guide: xfce-config guide, bug 161107
7
8 Revision Changes Path
9 1.170 xml/htdocs/doc/en/metadoc.xml
10
11 file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/metadoc.xml?rev=1.170&view=markup
12 plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/metadoc.xml?rev=1.170&content-type=text/plain
13 diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/metadoc.xml?r1=1.169&r2=1.170
14
15 Index: metadoc.xml
16 ===================================================================
17 RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v
18 retrieving revision 1.169
19 retrieving revision 1.170
20 diff -u -r1.169 -r1.170
21 --- metadoc.xml 3 Jan 2007 01:21:35 -0000 1.169
22 +++ metadoc.xml 13 Jan 2007 05:58:31 -0000 1.170
23 @@ -1,9 +1,9 @@
24 <?xml version='1.0' encoding="UTF-8"?>
25 -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v 1.169 2007/01/03 01:21:35 nightmorph Exp $ -->
26 +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v 1.170 2007/01/13 05:58:31 nightmorph Exp $ -->
27 <!DOCTYPE metadoc SYSTEM "/dtd/metadoc.dtd">
28
29 <metadoc lang="en">
30 -<version>1.96</version>
31 +<version>1.97</version>
32 <members>
33 <lead>neysx</lead>
34 <member>fox2mike</member>
35 @@ -392,6 +392,7 @@
36 <file id="kernel-config">/doc/en/kernel-config.xml</file>
37 <file id="zsh">/doc/en/zsh.xml</file>
38 <file id="change-chost">/doc/en/change-chost.xml</file>
39 + <file id="xfce-config">/doc/en/xfce-config.xml</file>
40 </files>
41 <docs>
42 <doc id="name-logo">
43 @@ -911,6 +912,10 @@
44 <memberof>desktop_install</memberof>
45 <fileid>fluxbox-config</fileid>
46 </doc>
47 + <doc id="xfce-config">
48 + <memberof>desktop_install</memberof>
49 + <fileid>xfce-config</fileid>
50 + </doc>
51 <doc id="vserver-howto">
52 <memberof>sysadmin_specific</memberof>
53 <fileid>vserver-howto</fileid>
54
55
56
57 1.1 xml/htdocs/doc/en/xfce-config.xml
58
59 file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/xfce-config.xml?rev=1.1&view=markup
60 plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/xfce-config.xml?rev=1.1&content-type=text/plain
61
62 Index: xfce-config.xml
63 ===================================================================
64 <?xml version='1.0' encoding='UTF-8'?>
65
66 <!-- $Header $ -->
67
68 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
69
70 <guide link="/doc/en/xfce-config.xml">
71
72 <title>The Xfce Configuration Guide</title>
73
74 <author title="Author">
75 <mail link="nightmorph@g.o">Joshua Saddler</mail>
76 </author>
77
78 <abstract>
79 This guide provides an extensive introduction to Xfce, a fast, lightweight,
80 full-featured desktop environment.
81 </abstract>
82
83 <!-- The content of this document is licensed under the CC-BY-SA license -->
84 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
85 <license/>
86
87 <version>1.0</version>
88 <date>2007-01-12</date>
89
90 <chapter>
91 <title>Introduction</title>
92 <section>
93 <title>The Xfce desktop environment</title>
94 <body>
95
96 <p>
97 <uri link="http://www.xfce.org">Xfce</uri> is a fast, lightweight desktop
98 environment for Unix-like operating systems. It is designed for productivity,
99 and is quite configurable while still adhering to the <uri
100 link="http://www.freedesktop.org">Freedesktop</uri> specifications.
101 </p>
102
103 <p>
104 Unlike heavier desktop environments, such as Gnome and KDE, Xfce uses far fewer
105 system resources. Additionally, it offers greater modularity and fewer
106 dependencies; it takes up less space on your hard disk and takes less time to
107 install.
108 </p>
109
110 <p>
111 This guide will not only show you how to install and configure a minimal Xfce
112 environment, but will also explore options to create a full-featured desktop in
113 keeping with the Xfce philosophy: light, fast, and modular.
114 </p>
115
116 </body>
117 </section>
118 </chapter>
119
120 <chapter>
121 <title>Installing Xfce</title>
122 <section>
123 <title>The basics</title>
124 <body>
125
126 <p>
127 Before we install our fully-functional yet minimal desktop, let's take a moment
128 to review the basic packages we'll be emerging.
129 </p>
130
131 <table>
132 <tr>
133 <th>Name</th>
134 <th>Description</th>
135 </tr>
136 <tr>
137 <ti>xfce4</ti>
138 <ti>The base Xfce desktop environment</ti>
139 </tr>
140 <tr>
141 <ti>xscreensaver</ti>
142 <ti>
143 A screensaver with powersaving features and the ability to lock the screen
144 for security
145 </ti>
146 </tr>
147 <tr>
148 <ti>hal</ti>
149 <ti>
150 A Hardware Abstraction Layer. HAL enables desktop applications to locate and
151 use hardware devices. This makes it easy for you to work with removable
152 media, such as USB sticks and CD/DVD drives. Installing <c>hal</c> will also
153 install <c>dbus</c>, a simple way for applications to talk to each other.
154 </ti>
155 </tr>
156 <tr>
157 <ti>gamin</ti>
158 <ti>
159 This file alteration monitor keeps track of file changes; it's very handy
160 when used in conjunction with a graphical file browser
161 </ti>
162 </tr>
163 </table>
164
165 <p>
166 You're free to install any other packages you wish, but for now, we'll stick
167 with these suggestions for a fast, minimal working environment. Double check
168 your USE flags in <path>/etc/make.conf</path>; you'll probably at least want
169 <c>USE="-gnome"</c> to avoid pulling in unnecessary dependencies.
170 </p>
171
172 <pre caption="Installing Xfce">
173 # <i>emerge -avt xfce4 xscreensaver hal gamin</i>
174 </pre>
175
176 <p>
177 Next, add your regular user(s) to the following groups, so that they can take
178 full advantage of <c>hal</c> and be able to mount and use devices such as
179 cameras, CD-ROMs, CD-RWs, and USB sticks:
180 </p>
181
182 <pre caption="Adding users to the hardware groups">
183 <comment>(Remember to replace username with your actual user)</comment>
184 # <i>gpasswd -a username plugdev,cdrom,cdrw,usb</i>
185 </pre>
186
187 <p>
188 Next, update your environment variables:
189 </p>
190
191 <pre caption="Updating environment variables">
192 # <i>env-update &amp;&amp; source /etc/profile</i>
193 </pre>
194
195 <p>
196 Now start up <c>hald</c> and add it to the default runlevel:
197 </p>
198
199 <pre caption="Starting hald">
200 # <i>/etc/init.d/hald start</i>
201 # <i>rc-update add hald default</i>
202 </pre>
203
204 </body>
205 </section>
206 </chapter>
207
208 <chapter>
209 <title>Configuring Xfce</title>
210 <section>
211 <title>Starting Xfce</title>
212 <body>
213
214 <p>
215 Now that Xfce is now installed, we'll configure it to be the default desktop
216 environment when we issue the <c>startx</c> command. Exit your root shell and
217 log on as a regular user.
218 </p>
219
220 <pre caption="Setting Xfce as the default desktop environment">
221 $ <i>echo "exec startxfce4" > ~/.xinitrc</i>
222 </pre>
223
224 <p>
225 Now start your graphical environment by typing <c>startx</c>:
226 </p>
227
228 <pre caption="Starting Xfce">
229 $ <i>startx</i>
230 </pre>
231
232 <p>
233 Congratulations, and welcome to your new Xfce desktop environment. Go ahead,
234 explore it a bit. Then continue reading to learn how you can configure Xfce to
235 suit your needs.
236 </p>
237
238 </body>
239 </section>
240 <section>
241 <title>Program access</title>
242 <body>
243
244 <p>
245 You might notice right-clicking on the desktop shows you the menu of all your
246 applications. It's useful, but your desktop can easily be completely obscured by
247 open windows, making it hard to to launch a new program. So, one of the first
248 things you may wish to do is give yourself a handy application menu on your
249 panel. Right click on this panel, and choose "Add New Item". Scroll through the
250 list of choices and select "Xfce Menu". You can choose where you want it to be
251 displayed on your panel. When clicked, it displays the application/preferences
252 menu, providing a nicely categorized list of your installed programs.
253 </p>
254
255 </body>
256 </section>
257 <section>
258 <title>Sessions &amp; startup</title>
259 <body>
260
261 <p>
262 If you've installed (or plan to install) popular Gnome or KDE applications such
263 as <c>k3b</c>, <c>nautilus</c>, <c>kmail</c>, <c>evolution</c>, etc. then you
264 should make sure that Xfce launches the appropriate services for these at
265 startup. Navigate to Menu --> Settings --> Sessions &amp; Startup. On the
266 "Advanced" tab, select the appropriate checkbox. This might slightly increase
267 Xfce startup times, but it decreases load times for KDE and Gnome applications.
268 </p>
269
270 <p>
271 Xfce has the ability to save your session settings and running programs from the
272 "General" tab in the Sessions &amp; Startup menu. They can be automatically
273 saved when you logout, or Xfce can ask you each time. This feature is
274 particularly useful for undoing configuration mistakes. Accidentally killed a
275 panel? Just select "No" when prompted to save your current session, and the next
276 time you start Xfce, your old desktop is restored. Want to automatically launch
277 your open webbrowser, terminal, and email client the next time you login? Just
278 save your session before logging out.
279 </p>
280
281 <p>
282 You've now got a basic working environment installed and configured. But if
283 you're interested in doing more, then continue reading!
284 </p>
285
286 </body>
287 </section>
288 </chapter>
289
290 <chapter>
291 <title>Additional Applications</title>
292 <section>
293 <title>Panel plugins</title>
294 <body>
295
296 <p>
297 In this chapter, we'll discuss some useful plugins and applications for everyday
298 use within Xfce.
299 </p>
300
301 <p>
302 There are many plugins for the panel available in Portage; see for yourself with
303 <c>emerge --search xfce</c>. Though for the most part their names are self
304 explanatory, a few deserve some attention, as they are quite helpful. To use
305 them, simply <c>emerge</c> them. They'll be added to the list of available items
306 in the "Add New Item" menu.
307 </p>
308
309 <ul>
310 <li>
311 <c>xfce4-mount</c> gives you a handy method of mounting devices listed in
312 <path>/etc/fstab</path> just by clicking your mouse
313 </li>
314 <!-- xfce4-taskbar is integrated into the panel in 4.4; remove when stable -->
315 <li>
316 <c>xfce4-taskbar</c> can replace the windowlist panel entirely. It's
317 useful if you want to conserve screen space (for small monitors), or don't
318 want your desktop cluttered with more than one panel. Add the taskbar to
319 your main panel, and then you can remove the separate windowlist panel by
320 running <c>killall -9 xftaskbar4</c> from an xterm, thus displaying your
321 application launchers, Xfce menu, clock, etc. all on just one panel.
322 </li>
323 <li>
324 <c>xfce4-battery</c> is perfect for laptop users. It displays battery
325 percentage, time remaining, power source (AC or battery), fan status,
326 warnings, and can even be configured to execute commands at certain power
327 levels. This feature can be used to put the laptop into hibernate mode when
328 the battery is almost exhausted.
329 </li>
330 <li>
331 <!-- xfce4-minicmd has been superceded by verve in 4.4; remove when stable -->
332 <c>xfce4-minicmd</c> is a small command line embedded into the panel. It's
333 quicker than opening up another terminal when you want to run a command.
334 </li>
335 </ul>
336
337 </body>
338 </section>
339 <section>
340 <title>Useful programs</title>
341 <body>
342
343 <p>
344 Now let's see about adding some useful yet lightweight applications, in keeping
345 with Xfce's philosophy.
346 </p>
347
348 <p>
349 First, let's replace the plain, boring old <c>xterm</c> with
350 <c>xfce-extra/terminal</c>. <c>Terminal</c> is far more configurable and useful
351 than xterm, and supports Unicode text, pseudo-transparency and accelerated
352 transparency via Xfce's built-in compositor, all out-of-the-box.
353 </p>
354 <!-- Remove the warning about ~arch once 4.4 and terminal go stable -->
355 <note>
356 At the time of writing, <c>Terminal</c> may not be marked stable for your
357 architecture, so you will need to add it to
358 <path>/etc/portage/package.keywords</path> before emerging it.
359 </note>
360
361 <pre caption="Installing a better terminal">
362 <comment>(Only run this command if you receive a warning about Terminal being masked)</comment>
363 # <i>echo "xfce-extra/terminal" >> /etc/portage/package.keywords</i>
364
365 <comment>(Otherwise, you can emerge Terminal without any extra steps)</comment>
366 # <i>emerge -av xfce-extra/terminal</i>
367 </pre>
368
369 <p>
370 Once it's installed, you may want to change the default action of the terminal
371 launcher on your panel to run <path>/usr/bin/Terminal</path> instead. Just
372 right-click the launcher and choose "Properties" to change the command.
373 </p>
374
375 <p>
376 You may want to replace the rather confusing default filemanager, <c>xffm</c>,
377 with one that's more intuitive and helpful. The <c>rox</c> file manager is
378 icon-based and behaves much more like a traditional file manager. If you're
379 looking for something even more minimal, yet still extremely flexible, then try
380 out the <c>gentoo</c> file manager. (The <c>gentoo</c> file manager is not
381 related to the Gentoo Linux distribution.) Both file managers are lightweight
382 and fully configurable, and are only a short <c>emerge</c> away.
383 </p>
384
385 <!-- Remove the note about masked thunar once 4.4 is stable -->
386 <p>
387 In the future, <c>thunar</c> will replace <c>xffm</c> as Xfce's default file
388 manager, but it is still masked at the time of this writing. However, the most
389 recent versions have been quite useful for daily work, and show great promise.
390 If you're feeling brave, you can try out the release candidates. Please read
391 <uri link="doc/en/handbook/handbook-x86.xml?part=3&amp;chap=3#doc_chap3">Using
392 Masked Packages</uri> to learn how to unmask it and its dependencies. Note that
393 this software is still unfinished. You have been warned!
394 </p>
395 <!-- remove mousepad once 4.4 is stable; right now it's included by default -->
396 <p>
397 Let's install a simple graphical text editor. It's easier to use than
398 <c>gvim</c> or <c>xemacs</c>, and has fewer dependencies.
399 </p>
400
401 <pre caption="Adding a text editor">
402 # <i>emerge mousepad</i>
403 </pre>
404
405 <p>
406 If you need a full-featured word processor but don't want the bloat of
407 OpenOffice, try emerging <c>abiword</c>. <uri
408 link="http://www.abisource.com">AbiWord</uri> is lighter, faster, and is
409 completely interoperable with industry-standard document types.
410 </p>
411
412 <pre caption="Adding a word processor">
413 # <i>emerge -avt abiword</i>
414 </pre>
415
416 <p>
417 Need a nice email client/newsreader that isn't as demanding as
418 <c>mozilla-thunderbird</c> or <c>evolution</c>? Try <c>sylpheed-claws</c>:
419 </p>
420 <!-- replacement seems to be called claws-mail, but still in ~arch -->
421 <pre caption="Adding an email client">
422 # <i>emerge -avt sylpheed-claws</i>
423 </pre>
424
425 <p>
426 For your internet chat needs, <c>irssi</c> is an excellent, tiny, incredibly
427 configurable IRC client that runs in your terminal. If you prefer a compact
428 all-in-one client that handles nearly all chat protocols, you may want to
429 <c>emerge gaim</c>.
430 </p>
431
432 <p>
433 If you need movie and music players, look no further than <c>mplayer</c> and
434 <c>audacious</c>. They can play most every media format available quite nicely,
435 and have a wealth of additional plugins available for additional functionality.
436 </p>
437
438 <p>
439 Finally, you'll need a webbrowser. Nearly all graphical webbrowsers require more
440 resources than most of your other desktop applications. Still,
441 <c>mozilla-firefox</c> (or <c>mozilla-firefox-bin</c>) is always a good choice.
442 Alternatively, you may find <c>opera</c> to be quite fast. However, <c>opera</c>
443 is not available on as many processor architectures as <c>mozilla-firefox</c>,
444 and it has more dependencies unless you override them with a USE flag.
445 </p>
446
447 <pre caption="Adding a webbrowser">
448 <comment>(Installing Mozilla Firefox)</comment>
449 # <i>emerge mozilla-firefox</i>
450 <comment>(Installing Opera)</comment>
451 # <i>echo "www-client/opera qt-static" >> /etc/portage/package.use</i>
452 # <i>emerge opera</i>
453 </pre>
454
455 <p>
456 Now that we've explored some good suggestions for rounding out your desktop
457 applications, let's see what else we can do to enhance your Xfce experience.
458 </p>
459
460 </body>
461 </section>
462 <section>
463 <title>Graphical login</title>
464 <body>
465
466 <p>
467 Remember when we added <c>startxfce4</c> to our <path>~/.xinitrc</path>? All you
468 have to do to get into your desktop is type <c>startx</c> after logging in. This
469 is fine if you prefer a completely text-based boot and login, but let's use a
470 display manager that will automatically start Xfce after booting (so that you
471 can login graphically).
472 </p>
473
474 <p>
475 First, let's make sure Xfce loads at boot:
476 </p>
477
478 <pre caption="Adding xdm to the default runlevel">
479 # <i>rc-update add xdm default</i>
480 </pre>
481
482 <p>
483 We aren't quite finished yet. We have to pick a display manager and set the
484 appropriate variable. Though there are a few choices available in Portage, for
485 this guide, we'll stick with two display manager options: <c>xdm</c> and
486 <c>gdm</c>.
487 </p>
488
489 <p>
490 <c>xdm</c> is speedy and lightweight, but it isn't pretty, and isn't really
491 customizable. If you'd like to use it, first <c>emerge</c> it:
492 </p>
493
494 <pre caption="Installing XDM">
495 # <i>emerge -avt xdm</i>
496 </pre>
497
498 <p>
499 Then edit the DISPLAYMANAGER variable in <path>/etc/conf.d/xdm</path>:
500 </p>
501
502 <pre caption="Editing /etc/conf.d/xdm">
503 DISPLAYMANAGER="xdm"
504 </pre>
505
506 <p>
507 While you can choose to stick with (the rather ugly) <c>xdm</c>, why not try
508 <c>gdm</c> instead? It's far more configurable, and much, much prettier. First,
509 let's <c>emerge</c> it. Note that though it has a few dependencies, they're
510 small, and they're not as nearly as numerous as other display managers.
511 </p>
512
513 <pre caption="Installing GDM">
514 # <i>emerge -avt gdm</i>
515 </pre>
516
517 <p>
518 Next, change the DISPLAYMANAGER variable to use <c>gdm</c> instead of
519 <c>xdm</c>:
520 </p>
521
522 <pre caption="Editing /etc/conf.d/xdm">
523 DISPLAYMANAGER="gdm"
524 </pre>
525
526 </body>
527 </section>
528 <section>
529 <title>Beautifying your desktop</title>
530 <body>
531
532 <p>
533 A little customization of your desktop's appearance can go a long way. Xfce has
534 all the options you'd expect from a modern desktop environment, font
535 antialiasing settings, color schemes, dozens of window decorations, themes, and
536 more. If these aren't enough, it's easy to install third-party themes, icon
537 sets, mouse cursor themes, and wallpapers.
538 </p>
539
540 <p>
541 A selection of nice Gentoo wallpapers in a variety of resolutions are hosted on
542 the <uri link="http://www.gentoo.org/main/en/graphics.xml">Gentoo website</uri>.
543 If you're looking for icon sets and complete Xfce themes, <uri
544 link="http://www.xfce-look.org/">Xfce-Look</uri> has a huge collection. The
545 important thing to remember about any third-party eyecandy you download is that
546 it will usually first need to be unpacked and then installed to the proper
547 directory. Icon sets go in <path>/usr/share/icons/</path>, and themes go to
548 <path>/usr/share/themes/</path>.
549 </p>
550
551 <p>
552 If you installed GDM as your display manager, take a look at the many GDM themes
553 available on <uri link="http://www.gnome-look.org">Gnome-Look</uri>. To install
554 them, you can either unpack and move them to
555 <path>/usr/share/gdm/themes/</path> on the command line, or you can run
556 <c>gdmsetup</c> as <b>root</b> and drag'n'drop the archive into the GDM window.
557 There are some <uri
558 link="http://gnome-look.org/content/show.php?content=45575">very nice</uri>
559 Gentoo <uri
560 link="http://gnome-look.org/content/show.php?content=20071">themes</uri>
561 available.
562 </p>
563
564 <p>
565 Finally, Xfce has its own built-in compositor to manage window transparency.
566 This option can be found in Menu --> Settings --> Window Manager. For best
567 performance, you will need to be running a graphics card with drivers that
568 support hardware-accelerated rendering, and you will need to enable
569 compositing in <path>/etc/X11/xorg.conf</path> by adding the following section:
570 </p>
571
572 <pre caption="Enabling composite in xorg.conf">
573 Section "Extensions"
574 Option "Composite" "Enable"
575 EndSection
576 </pre>
577
578 <p>
579 This is the bare minimum configuration required for Xfce and Xorg-X11. However,
580 setting up hardware-accelerated rendering depends on your individual graphics
581 card, and is beyond the scope of this guide. Please see the other guides in the
582 <uri link="/doc/en/index.xml?catid=desktop">Desktop Documentation
583 Resources</uri> list to learn about configuring hardware-accelerated rendering
584 for your graphics card.
585 </p>
586
587 </body>
588 </section>
589 </chapter>
590
591 <chapter>
592 <title>Summary</title>
593 <section>
594 <body>
595
596 <p>
597 Congratulations on making it this far! You've installed and configured a speedy
598 desktop environment with a solid suite of applications for your computing
599 needs.
600 </p>
601
602 </body>
603 </section>
604 <section>
605 <title>Resources</title>
606 <body>
607
608 <p>
609 Need additional help on configuring and using Xfce? Need more lightweight
610 application suggestions? Try asking the folks in:
611 </p>
612
613 <ul>
614 <li><uri link="http://forums.gentoo.org">The Gentoo forums</uri></li>
615 <li>#xfce on irc.freenode.net</li>
616 </ul>
617
618 <p>
619 Finally, Gentoo's Xfce team is responsible for making Xfce available in Portage.
620 Send comments, thanks, and suggestions to <mail>xfce@g.o</mail>.
621 </p>
622
623 </body>
624 </section>
625 </chapter>
626 </guide>
627
628
629
630 --
631 gentoo-doc-cvs@g.o mailing list