/[gentoo]/xml/htdocs/doc/en/xfce-config.xml
Gentoo

Diff of /xml/htdocs/doc/en/xfce-config.xml

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.19 Revision 1.37
1<?xml version='1.0' encoding='UTF-8'?> 1<?xml version='1.0' encoding='UTF-8'?>
2<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> 2<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
3<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xfce-config.xml,v 1.19 2009/06/10 18:56:18 nightmorph Exp $ --> 3<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xfce-config.xml,v 1.37 2011/02/14 20:43:47 nightmorph Exp $ -->
4 4
5<guide link="/doc/en/xfce-config.xml"> 5<guide>
6<title>The Xfce Configuration Guide</title> 6<title>The Xfce Configuration Guide</title>
7 7
8<author title="Author"> 8<author title="Author">
9 <mail link="nightmorph@gentoo.org">Joshua Saddler</mail> 9 <mail link="nightmorph"/>
10</author> 10</author>
11 11
12<abstract> 12<abstract>
13This guide provides an extensive introduction to Xfce, a fast, lightweight, 13This guide provides an extensive introduction to Xfce, a fast, lightweight,
14full-featured desktop environment. 14full-featured desktop environment.
16 16
17<!-- The content of this document is licensed under the CC-BY-SA license --> 17<!-- The content of this document is licensed under the CC-BY-SA license -->
18<!-- See http://creativecommons.org/licenses/by-sa/2.5 --> 18<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
19<license/> 19<license/>
20 20
21<version>1.15</version> 21<version>5</version>
22<date>2009-06-10</date> 22<date>2011-02-14</date>
23 23
24<chapter> 24<chapter>
25<title>Introduction</title> 25<title>Introduction</title>
26<section> 26<section>
27<title>The Xfce desktop environment</title> 27<title>The Xfce desktop environment</title>
33and is quite configurable while still adhering to the <uri 33and is quite configurable while still adhering to the <uri
34link="http://www.freedesktop.org">Freedesktop</uri> specifications. 34link="http://www.freedesktop.org">Freedesktop</uri> specifications.
35</p> 35</p>
36 36
37<p> 37<p>
38Unlike heavier desktop environments, such as Gnome and KDE, Xfce uses far fewer 38Unlike heavier desktop environments, such as <uri
39system resources. Additionally, it offers greater modularity and fewer 39link="http://www.gnome.org">Gnome</uri> and <uri
40dependencies; it takes up less space on your hard disk and takes less time to 40link="http://www.kde.org">KDE</uri>, Xfce uses far fewer system resources.
41install. 41Additionally, it offers greater modularity and fewer dependencies; it takes up
42less space on your hard disk and takes less time to install.
42</p> 43</p>
43 44
44<p> 45<p>
45This guide will not only show you how to install and configure a minimal Xfce 46This guide will not only show you how to install and configure a minimal Xfce
46environment, but will also explore options to create a full-featured desktop in 47environment, but will also explore options to create a full-featured desktop in
47keeping with the Xfce philosophy: light, fast, and modular. 48keeping with the Xfce philosophy: light, fast, and modular.
48</p> 49</p>
49 50
51<p>
52The last part of this guide lists a few commands to run after upgrading to Xfce
534.8, so be sure to follow them if you are upgrading from an older version.
54</p>
55
50</body> 56</body>
51</section> 57</section>
52</chapter> 58</chapter>
53 59
54<chapter> 60<chapter>
62link="/doc/en/xorg-config.xml">X Server Configuration Howto</uri>. 68link="/doc/en/xorg-config.xml">X Server Configuration Howto</uri>.
63</p> 69</p>
64 70
65<p> 71<p>
66Next, double-check your USE flags in <path>/etc/make.conf</path>; you'll 72Next, double-check your USE flags in <path>/etc/make.conf</path>; you'll
67probably at least want <c>USE="-gnome -kde -qt3 -qt4 X alsa cups dbus hal startup-notification xscreensaver"</c>. 73probably at least want <c>USE="-gnome -kde -minimal -qt4 dbus jpeg lock session
68</p> 74startup-notification thunar udev X"</c>.
69
70<p> 75</p>
71Now, let's install Xfce. 76
77<p>
78Now that you've set your <c>USE</c> variables in
79<path>/etc/make.conf</path>, it's time to install Xfce.
72</p> 80</p>
73 81
74<pre caption="Installing Xfce"> 82<pre caption="Installing Xfce">
75# <i>emerge -avt xfce4</i> 83# <i>emerge -avt xfce4-meta</i>
76</pre> 84</pre>
77 85
78<p> 86<p>
79Next, add your regular user(s) to the <c>plugdev</c>, <c>cdrom</c>, <c>cdrw</c>, 87Next, add your regular user(s) to the <c>plugdev</c>, <c>cdrom</c>, <c>cdrw</c>,
80and <c>usb</c> groups, so that they can take full advantage of <c>hal</c> and be 88and <c>usb</c> groups, so that they can mount and use devices such as cameras,
81able to mount and use devices such as cameras, optical drives, and USB sticks. 89optical drives, and USB sticks.
82</p> 90</p>
83 91
84<pre caption="Adding users to the hardware groups"> 92<pre caption="Adding users to the hardware groups">
85<comment>(Replace username with your actual user)</comment> 93<comment>(Replace username with your actual user)</comment>
86# <i>for x in plugdev cdrom cdrw usb ; do gpasswd -a username $x ; done</i> 94# <i>for x in plugdev cdrom cdrw usb ; do gpasswd -a username $x ; done</i>
93<pre caption="Updating environment variables"> 101<pre caption="Updating environment variables">
94# <i>env-update &amp;&amp; source /etc/profile</i> 102# <i>env-update &amp;&amp; source /etc/profile</i>
95</pre> 103</pre>
96 104
97<p> 105<p>
98Now start up <c>hald</c> and add it to the default runlevel: 106You'll also need a graphical terminal so that you can continue working with your
107new desktop environment. <c>x11-terms/terminal</c> is a good choice, as it's
108made specifically for Xfce. Install Terminal as shown:
99</p> 109</p>
100 110
101<pre caption="Starting hald"> 111<pre caption="Installing Terminal">
102# <i>/etc/init.d/hald start</i> 112# <i>emerge x11-terms/terminal</i>
103# <i>rc-update add hald default</i>
104</pre> 113</pre>
105 114
106</body> 115</body>
107</section> 116</section>
108</chapter> 117</chapter>
120</p> 129</p>
121 130
122<pre caption="Setting Xfce as the default desktop environment"> 131<pre caption="Setting Xfce as the default desktop environment">
123$ <i>echo "exec startxfce4" > ~/.xinitrc</i> 132$ <i>echo "exec startxfce4" > ~/.xinitrc</i>
124</pre> 133</pre>
134
135<note>
136If you have ConsoleKit installed, your <path>~/.xinitrc</path> should instead
137contain <c>exec ck-launch-session startxfce4</c>. Otherwise, some of your
138applications may stop working. You'll also need to add consolekit to the
139default runlevel by running the following command as root: <c>rc-update add
140consolekit default</c>.
141</note>
125 142
126<p> 143<p>
127Now start your graphical environment by typing <c>startx</c>: 144Now start your graphical environment by typing <c>startx</c>:
128</p> 145</p>
129 146
200use within Xfce. 217use within Xfce.
201</p> 218</p>
202 219
203<p> 220<p>
204There are many plugins for the panel available in Portage; see for yourself with 221There are many plugins for the panel available in Portage; see for yourself with
205<c>emerge --search xfce</c>. Though for the most part their names are self 222<c>emerge --search xfce</c>. Though for the most part their names are
206explanatory, a few deserve some attention, as they are quite helpful. To use 223self-explanatory, a few deserve extra attention, as they are quite helpful. To
207them, simply <c>emerge</c> them. They'll be added to the list of available items 224use them, simply <c>emerge</c> them. They'll be added to the list of available
208in the "Add New Item" menu shown when you right-click on the panel. 225items in the "Add New Items" menu shown when you right-click on the panel.
209</p> 226</p>
210 227
211<ul> 228<ul>
212 <li> 229 <li>
213 <c>xfce4-battery</c> is perfect for laptop users. It displays battery 230 <c>xfce4-battery-plugin</c> is perfect for laptop users. It displays battery
214 percentage, time remaining, power source (AC or battery), fan status, 231 percentage, time remaining, power source (AC or battery), fan status,
215 warnings, and can even be configured to execute commands at certain power 232 warnings, and can even be configured to execute commands at certain power
216 levels. This feature can be used to put the laptop into hibernate mode when 233 levels. This feature can be used to put the laptop into hibernate mode when
217 the battery is almost exhausted. 234 the battery is almost exhausted.
218 </li> 235 </li>
219 <li> 236 <li>
220 <c>xfce4-verve</c> is a small command line embedded into the panel. It's 237 <c>xfce4-verve-plugin</c> is a small command line embedded into the panel.
221 quicker than opening up another terminal when you want to run a command. 238 It's quicker than opening up another terminal when you want to run a
222 </li> 239 command.
223 <li> 240 </li>
241 <li>
224 <c>xfce4-mount</c> gives you a handy method of mounting devices listed in 242 <c>xfce4-mount-plugin</c> gives you a handy method of mounting devices
225 <path>/etc/fstab</path> just by clicking your mouse 243 listed in <path>/etc/fstab</path> just by clicking your mouse
244 </li>
245 <li>
246 <c>xfce4-sensors-plugin</c> lets you monitor your hardware sensors, such as
247 CPU temperature, fan RPM, hard drive temp, motherboard voltage, and more
226 </li> 248 </li>
227</ul> 249</ul>
228 250
229<p> 251<p>
230If you can't find what you're looking for in the plugins specifically made for 252If you can't find what you're looking for in the plugins specifically made for
231Xfce, try searching through the list of Gnome panel applets! That's right, by 253Xfce, try searching through the list of Gnome panel applets! That's right, by
232first emerging <c>xfce4-xfapplet</c>, you can install and run any applet made 254first emerging <c>xfce4-xfapplet-plugin</c>, you can install and run any applet
233for Gnome. 255made for Gnome.
234</p> 256</p>
235 257
236</body> 258</body>
237</section> 259</section>
238<section> 260<section>
239<title>Useful programs</title> 261<title>Useful programs</title>
240<body> 262<body>
241 263
242<p> 264<p>
243Xfce bundles a few useful applications, including <c>xfce4-appfinder</c>, the 265We should now <c>emerge</c> some useful applications and utilities:
244Xfce icon theme, xfwm4 window manager themes, <c>terminal</c>, <c>orage</c>, and 266<c>xfce4-mixer</c>, <c>xfce4-taskmanager</c>, <c>xfwm4-themes</c>, <c>orage</c>,
245<c>mousepad</c>. Note that the last three will not be installed if you built 267<c>leafpad</c>, <c>xfce4-power-manager</c>, <c>x11-terms/terminal</c>, and
246<c>xfce4</c> with the <c>minimal</c> USE flag. However, these are all very 268<c>thunar</c>.
247small, yet terrific applications, so they're well worth installing.
248</p>
249
250<p> 269</p>
270
271<p>
272<c>xfce4-mixer</c> is a volume control for your sound card. It can also be run
273as a panel applet, giving you fast access to playback volume.
274<c>xfce4-taskmanager</c> displays a list of all running programs, and the CPU
275and memory consumption each one takes up. By right-clicking an item, you can
276kill a misbehaving application, pause and restart it, or even alter its runtime
277priority, which lets you fine-tune how much of a demand it puts on your system's
278resources.
279</p>
280
281<p>
282<c>xfwm4-themes</c> adds several window manager themes. You may want to add a
283more full-coverage icon theme such as <c>tango-icon-theme</c> just to round out
284your desktop.
285</p>
286
287<p>
251<c>orage</c> is a simple, handy calendar. <c>mousepad</c> is a barebones text 288<c>orage</c> is a simple, handy calendar. <c>leafpad</c> is a barebones text
252editor that starts up extremely quickly. <c>terminal</c> is far more 289editor that starts up extremely quickly.
253configurable and useful than xterm, and supports Unicode text,
254pseudo-transparency and accelerated transparency via Xfce's built-in
255compositor, all out-of-the-box. Just make sure that the default action on the
256terminal launcher of your panel runs <path>/usr/bin/Terminal</path> instead of
257xterm. Right click the launcher and choose "Properties" to change the command.
258</p>
259
260<p> 290</p>
291
292<p>
293<c>xfce4-power-manager</c> is an application to monitor and manage power usage.
294This is especially important for laptops! The power manager allows you to adjust
295screen brightness, choose maximum performance or battery-saving modes, and setup
296hibernate, suspend, and shutdown actions when the lid is shut or buttons are
297pressed. You can set <uri
298link="http://goodies.xfce.org/projects/applications/xfce4-power-manager">xfce4-power-manager</uri>
299to warn you when your battery reaches certain levels, or even turn off your
300machine. The application comes with a couple of helpful panel plugins to display
301battery/charging status, and a brightness control.
302</p>
303
304<p>
305<c>x11-terms/terminal</c> is an X11 terminal emulator, far more configurable and
306useful than the barebones <c>xterm</c>. <c>terminal</c> supports Unicode text,
307color schemes, pseudo-transparency and hardware-accelerated transparency via
308Xfce's built-in compositor, all out-of-the-box. Just make sure that the default
309action on the terminal launcher of your panel runs
310<path>/usr/bin/Terminal</path> instead of <path>xterm</path>. Right-click the
311launcher and choose "Properties" to change the command.
312</p>
313
314<p>
261<c>thunar</c> is Xfce's built-in graphical file manager. It's fast yet quite 315<c>thunar</c> is Xfce's default graphical file manager. It's fast yet quite
262powerful, can support a few plugins for even more functionality; just install 316powerful, can support several plugins for even more functionality; just install
263them with <c>emerge</c>. Let's take a look: 317them with <c>emerge</c>. Let's take a look:
264</p> 318</p>
265 319
266<ul> 320<ul>
267 <li> 321 <li>
268 <c>thunar-archive</c> lets you create and extract archive files using the 322 <c>thunar-archive-plugin</c> lets you create and extract archive files using
269 right-click menu. It works even better when paired with the <uri 323 the right-click menu. It provides a handy <uri
270 link="http://www.foo-projects.org/~benny/projects/thunar-archive-plugin/">graphical 324 link="http://www.foo-projects.org/~benny/projects/thunar-archive-plugin">front-end</uri>
271 archiving application</uri> developed for Xfce, <c>xarchiver</c>. Run 325 for graphical archiving applications such as <c>xarchiver</c>,
272 <c>emerge xarchiver</c> to install it. 326 <c>squeeze</c>, and <c>file-roller</c>.
273 </li>
274 <li> 327 </li>
275 <c>thunar-media-tags</c> lets you intelligently rename multiple media files
276 at once, and lets you <uri
277 link="http://thunar.xfce.org/pwiki/projects/thunar-media-tags-plugin">edit</uri>
278 their information tags, such as id3 tags.
279 </li> 328 <li>
280 <li> 329 <c>tumbler</c> lets you preview certain types of files from within Thunar,
281 <c>thunar-thumbnailers</c> lets you <uri 330 such as images and fonts.
282 link="http://goodies.xfce.org/projects/thunar-plugins/thunar-thumbnailers">preview</uri>
283 certain types of files from within Thunar, such as images and fonts.
284 </li> 331 </li>
285 <li> 332 <li>
286 <c>thunar-volman</c> automatically <uri 333 <c>thunar-volman</c> automatically <uri
287 link="http://foo-projects.org/~benny/projects/thunar-volman/">manages</uri> 334 link="http://foo-projects.org/~benny/projects/thunar-volman/">manages</uri>
288 removable media and drives. 335 removable media and drives.
293Next, let's see about adding some useful but lightweight desktop applications, 340Next, let's see about adding some useful but lightweight desktop applications,
294in keeping with Xfce's philosophy. 341in keeping with Xfce's philosophy.
295</p> 342</p>
296 343
297<p> 344<p>
298Though <c>mousepad</c> is nice enough as a quick text editor, if you need a 345Though <c>leafpad</c> is nice enough as a basic text editor, if you need a
299full-featured word processor but don't want the bloat of OpenOffice, try 346full-featured word processor but don't want the bloat of OpenOffice, try
300emerging <c>abiword</c>. <uri link="http://www.abisource.com">AbiWord</uri> is 347emerging <c>abiword</c>. <uri link="http://www.abisource.com">AbiWord</uri> is
301lighter, faster, and is completely interoperable with industry-standard document 348lighter, faster, and is completely interoperable with industry-standard document
302types. It can also be further extended with <c>abiword-plugins</c>. 349types.
303</p> 350</p>
304 351
305<p> 352<p>
306Need a nice email client/newsreader that isn't as demanding as 353Need a nice email client/newsreader that isn't as demanding as
307<c>mozilla-thunderbird</c> or <c>evolution</c>? Try emerging <c>claws-mail</c>. 354<c>thunderbird</c> or <c>evolution</c>? Try emerging <c>claws-mail</c>.
308</p> 355</p>
309 356
310<p> 357<p>
311For your internet chat needs, <c>irssi</c> is an excellent, tiny, incredibly 358For your internet chat needs, <c>irssi</c> is an excellent, tiny, incredibly
312configurable IRC client that runs in your terminal. If you prefer a compact 359configurable IRC client that runs in your terminal. If you prefer a compact
320can play most every media format available quite nicely. 367can play most every media format available quite nicely.
321</p> 368</p>
322 369
323<p> 370<p>
324Finally, you'll need a webbrowser. Nearly all graphical webbrowsers require more 371Finally, you'll need a webbrowser. Nearly all graphical webbrowsers require more
325resources than most of your other desktop applications. Still, 372resources than most of your other desktop applications. Still, <c>firefox</c>
326<c>mozilla-firefox</c> (or <c>mozilla-firefox-bin</c>) is always a good choice. 373and <c>midori</c> are always good choices. Alternatively, you may find
327Alternatively, you may find <c>opera</c> to be quite fast. However, <c>opera</c> 374<c>opera</c> to be quite fast. However, <c>opera</c> is not available on as many
328is not available on as many processor architectures as <c>mozilla-firefox</c>, 375processor architectures as <c>firefox</c>, and it has more dependencies unless
329and it has more dependencies unless you override them with a USE flag. 376you override them with a few USE flags.
330</p> 377</p>
331 378
332<pre caption="Adding a webbrowser"> 379<pre caption="Adding a webbrowser">
333<comment>(Installing Mozilla Firefox)</comment> 380<comment>(Installing Mozilla Firefox)</comment>
334# <i>emerge mozilla-firefox</i> 381# <i>emerge firefox</i>
382<comment>(Installing Midori)</comment>
383# <i>emerge midori</i>
335<comment>(Installing Opera)</comment> 384<comment>(Installing Opera)</comment>
336# <i>echo "www-client/opera qt-static" >> /etc/portage/package.use</i> 385# <i>echo "www-client/opera gtk -kde" >> /etc/portage/package.use</i>
337# <i>emerge opera</i> 386# <i>emerge opera</i>
338</pre> 387</pre>
339 388
340<p> 389<p>
341Now that we've explored some good suggestions for rounding out your desktop 390Now that we've explored some good suggestions for rounding out your desktop
393DISPLAYMANAGER="slim" 442DISPLAYMANAGER="slim"
394</pre> 443</pre>
395 444
396<p> 445<p>
397SLiM can automatically start your Xfce session if you add 446SLiM can automatically start your Xfce session if you add
398<c>XSESSION="Xfce4"</c> to <path>/etc/rc.conf</path>. 447<c>XSESSION="Xfce4"</c> to <path>/etc/env.d/90xsession</path>:
448</p>
449
450<pre caption="Setting XSESSION">
451# <i>echo XSESSION=\"Xfce4\" > /etc/env.d/90xsession</i>
452# <i>env-update &amp;&amp; source /etc/profile</i>
399</p> 453</pre>
400 454
401</body> 455</body>
402</section> 456</section>
403<section> 457<section>
404<title>Beautifying your desktop</title> 458<title>Beautifying your desktop</title>
456<uri link="/doc/en/index.xml?catid=desktop">Desktop Documentation 510<uri link="/doc/en/index.xml?catid=desktop">Desktop Documentation
457Resources</uri> list to learn about configuring hardware-accelerated rendering 511Resources</uri> list to learn about configuring hardware-accelerated rendering
458for your graphics card. 512for your graphics card.
459</p> 513</p>
460 514
515<p>
516Once you've finished setting up a beautiful Xfce desktop, the next thing to do
517is take a picture of it to share with other folks! Just install
518<c>xfce4-screenshooter</c> and post your pictures somewhere for all to admire.
519</p>
520
461</body> 521</body>
462</section> 522</section>
463</chapter> 523</chapter>
464 524
465<chapter> 525<chapter>
470<p> 530<p>
471Congratulations on making it this far! You've installed and configured a speedy 531Congratulations on making it this far! You've installed and configured a speedy
472desktop environment with a solid suite of applications for your computing 532desktop environment with a solid suite of applications for your computing
473needs. 533needs.
474</p> 534</p>
535
536</body>
537</section>
538<section>
539<title>Upgrading Xfce</title>
540<body>
541
542<p>
543If you're upgrading Xfce from an old version to 4.8 or newer, then you will need
544to remove your old cached sessions. For each of your users, run the following
545commands to remove your old incompatible cached sessions:
546</p>
547
548<pre caption="Deleting old sessions from the cache">
549$ <i>rm -r ~/.cache/sessions</i>
550$ <i>rm -r ~/.config/xfce*</i>
551$ <i>rm -r ~/.config/Thunar</i>
552</pre>
475 553
476</body> 554</body>
477</section> 555</section>
478<section> 556<section>
479<title>Resources</title> 557<title>Resources</title>

Legend:
Removed from v.1.19  
changed lines
  Added in v.1.37

  ViewVC Help
Powered by ViewVC 1.1.20