Gentoo Archives: gentoo-doc-cvs

From: "Joshua Saddler (nightmorph)" <nightmorph@g.o>
To: gentoo-doc-cvs@l.g.o
Subject: [gentoo-doc-cvs] gentoo commit in xml/htdocs/doc/en: openbox.xml metadoc.xml
Date: Sun, 28 Jun 2009 03:42:08
Message-Id: E1MKlHG-0002wT-TH@stork.gentoo.org
1 nightmorph 09/06/28 03:42:02
2
3 Modified: openbox.xml metadoc.xml
4 Log:
5 thorough overhaul of the openbox guide. i started with Nate's latest draft in bug #256693. more or less completely rewrote it, editing as i went. also added sections on other applications. left the ~arch stuff commented out for now, as we aren't supposed to document anything but the stable tree. this may change upon review, arch team stabilization, rainy weather, etc. also added the doc to our index and took it out of draft status. it's official!
6
7 Revision Changes Path
8 1.3 xml/htdocs/doc/en/openbox.xml
9
10 file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/openbox.xml?rev=1.3&view=markup
11 plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/openbox.xml?rev=1.3&content-type=text/plain
12 diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/openbox.xml?r1=1.2&r2=1.3
13
14 Index: openbox.xml
15 ===================================================================
16 RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/openbox.xml,v
17 retrieving revision 1.2
18 retrieving revision 1.3
19 diff -u -r1.2 -r1.3
20 --- openbox.xml 27 Apr 2009 20:18:50 -0000 1.2
21 +++ openbox.xml 28 Jun 2009 03:42:02 -0000 1.3
22 @@ -1,13 +1,16 @@
23 <?xml version="1.0" encoding="UTF-8"?>
24 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
25 -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/openbox.xml,v 1.2 2009/04/27 20:18:50 neysx Exp $ -->
26 +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/openbox.xml,v 1.3 2009/06/28 03:42:02 nightmorph Exp $ -->
27
28 -<guide disclaimer="draft">
29 +<guide>
30 <title>The Openbox Configuration HOWTO</title>
31
32 <author title="Author">
33 <mail link="kalos"/>
34 </author>
35 +<author title="Author">
36 + <mail link="nightmorph"/>
37 +</author>
38
39 <abstract>
40 This guide shows you how to install the Openbox window manager, and references
41 @@ -18,8 +21,8 @@
42 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
43 <license/>
44
45 -<version>1.1</version>
46 -<date>2009-04-27</date>
47 +<version>1.2</version>
48 +<date>2009-06-27</date>
49
50 <chapter>
51 <title>Introduction</title>
52 @@ -34,11 +37,11 @@
53 had some experience with big desktop environments like <uri
54 link="/proj/en/desktop/kde/kde-config.xml">KDE</uri>, <uri
55 link="/doc/en/gnome-config.xml">GNOME</uri>, and <uri
56 -link="/doc/en/xfce-config.xml">Xfce</uri>. One component of those larger
57 -desktop suites is called the window manager (or WM for short). A window manager
58 -is responsible for the appearance and placement of the containers (or
59 -"windows") inside which programs run. Openbox is a minimalistic,
60 -no-frills-attached window manager.
61 +link="/doc/en/xfce-config.xml">Xfce</uri>. One component of those larger desktop
62 +suites is called the window manager (or WM for short). A window manager is
63 +responsible for the appearance and placement of the containers (or "windows")
64 +inside which programs run. Openbox is a minimalistic, no-frills-attached window
65 +manager.
66 </p>
67
68 </body>
69 @@ -53,7 +56,7 @@
70 very quickly, even on older hardware. Whether your hardware is old or new,
71 Openbox also provides a highly customisable and unobtrusive working
72 environment. That means that if you don't want or need a panel, taskbar, clock,
73 -or any other program, that choice is yours!
74 +or any other program, those choices are yours!
75 </p>
76
77 </body>
78 @@ -68,9 +71,8 @@
79 <body>
80
81 <p>
82 -After you have emerged xorg-x11 and configured all of your
83 -<path>xorg.conf</path> settings, installing Openbox can be done in one simple
84 -command:
85 +After you have emerged and configured <c>xorg-server</c>, installing Openbox can
86 +be done in one simple command:
87 </p>
88
89 <pre caption="Installing Openbox">
90 @@ -81,11 +83,11 @@
91 <p>
92 Just like with other window managers and desktop environments, you will need to
93 tell the X Server to load Openbox automatically, by adding it to your
94 -<path>.xinitrc</path>.
95 +<path>~/.xinitrc</path>.
96 </p>
97
98 <pre caption="Adding Openbox to your .xinitrc">
99 -# <i>echo "exec openbox-session" >> ~/.xinitrc</i>
100 +$ <i>echo "exec openbox-session" >> ~/.xinitrc</i>
101 </pre>
102
103 <p>
104 @@ -168,7 +170,7 @@
105 </p>
106
107 <pre caption="Overwriting the default system-wide menu.xml files">
108 -$ <i>mv .config/openbox/menu.xml /etc/xdg/openbox/menu.xml</i>
109 +$ <i>cp .config/openbox/menu.xml /etc/xdg/openbox/menu.xml</i>
110 </pre>
111
112 <impo>
113 @@ -185,17 +187,18 @@
114 not that difficult). The basic syntax for the menu XML is as follows:
115 </p>
116
117 -<pre caption="Editing the menu.xml file"><![CDATA[
118 -<?xml version="1.0" encoding="UTF-8"?>
119 -<openbox_menu>
120 -<separator label="NAME_OF_SEPARATOR" />
121 -<menu id="IDENTIFIER" label="NAME_OF_MENU">
122 - <item label="NAME_OF_PROGRAM">
123 - <action name="execute"><execute>/LOCATION/OF/BINARY</execute></action>
124 - </item>
125 -</menu>
126 -</openbox_menu>
127 -]]></pre>
128 +<pre caption="Editing the menu.xml file">
129 +&lt;?xml version="1.0" encoding="UTF-8"?7gt;
130 +&lt;openbox_menu&gt;
131 +&lt;separator label="NAME_OF_SEPARATOR" /&gt;
132 +&lt;menu id="IDENTIFIER" label="NAME_OF_MENU"&gt;
133 + &lt;item label="NAME_OF_PROGRAM"&gt;
134 + &lt;action
135 + name="execute"&gt;&lt;execute&gt;/LOCATION/OF/BINARY&lt;/execute&gt;&lt;/action&gt;
136 + &lt;/item&gt;
137 +&lt;/menu&gt;
138 +&lt;/openbox_menu&gt;
139 +</pre>
140
141 <p>
142 Simply replace anything in CAPS with your information.
143 @@ -204,7 +207,7 @@
144 <p>
145 Alternatively, you can <c>emerge obmenu</c>, which is a graphical interface
146 allowing you to create your menus without having to manually edit the
147 -<path>menu.xml</path> file. It is a very small application and offers a
148 +<path>menu.xml</path> file. It is a very small application and offers a
149 nice amount of customisation without typing any XML.
150 </p>
151
152 @@ -218,28 +221,28 @@
153 <p>
154 Aside from being minimalistic and lightweight, Openbox is also surprisingly
155 customisable and flexible. As a user, you can easily change various settings
156 -related to theme, appearance, window placement, docking, and more. There are
157 -two options for configuring these settings within Openbox. You may either
158 -manually edit the <path>~/.config/openbox/rc.xml</path> file, or you may want a
159 -GUI to help you quickly change settings.
160 +related to theme, appearance, window placement, docking, and more. There are two
161 +options for configuring these settings within Openbox. You may either manually
162 +edit <path>~/.config/openbox/rc.xml</path>, or you may want a GUI to help you
163 +quickly change settings.
164 </p>
165
166 <p>
167 -If you want to manually edit the <path>rc.xml</path> file, you simply open up
168 -your favourite text editor and start making changes. You might want to make a
169 -backup of the original file just in case, and store it in a location like
170 +If you want to manually edit <path>rc.xml</path>, you simply open up your
171 +favourite text editor and start making changes. You might want to make a backup
172 +of the original file just in case, and store it in a location like
173 <path>~/.config/openbox/rc.xml.default</path>. There are plenty of comments
174 -within the document itself that should help you with editing. Alternatively,
175 -you may want to look at the <uri
176 +within the document itself that should help you with editing. Alternatively, you
177 +may want to look at the <uri
178 link="http://icculus.org/openbox/index.php/Help:Contents#Configuration">Openbox
179 configuration guides</uri>.
180 </p>
181
182 <p>
183 -If manually editing the <path>rc.xml</path> file doesn't sound like your cup of
184 -tea, you may want to use the GTK+ application to manage your themes and
185 -behaviours in Openbox. The application that you will use is called ObConf, and
186 -can be installed on your system just as easily as was Openbox itself.
187 +If manually editing <path>rc.xml</path> doesn't sound like your cup of tea, you
188 +may want to use the GTK+ application to manage your themes and behaviours in
189 +Openbox. The application that you will use is called ObConf, and can be
190 +installed on your system just as easily as was Openbox itself.
191 </p>
192
193 <pre caption="Installing ObConf">
194 @@ -249,9 +252,22 @@
195 <p>
196 You can then open the configurator by typing <c>obconf</c> in your terminal.
197 Next, you can go and add an entry for ObConf into your <path>menu.xml</path> so
198 -it will show up in your Openbox menu.
199 +it will show up in your Openbox menu. If the "editing the menu.xml file" code
200 +listing above seemed too vague to be helpful, we'll use ObConf as an example of
201 +a menu entry:
202 </p>
203
204 +<pre caption="Editing the menu.xml file">
205 +&lt;?xml version="1.0" encoding="UTF-8"?&gt;
206 +&lt;openbox_menu&gt;
207 +&lt;menu id="1" label="Configuration"&gt;
208 + &lt;item label="OpenBox Config&gt;
209 + &lt;action name="execute"&gt;&lt;execute&gt;/usr/bin/obconf&lt;/execute&gt;&lt;/action&gt;
210 + &lt;/item&gt;
211 +&lt;/menu&gt;
212 +&lt;/openbox_menu>&gt;
213 +</pre>
214 +
215 </body>
216 </section>
217 <section>
218 @@ -329,8 +345,9 @@
219 </p>
220
221 <pre caption="Using feh to set the background image">
222 -<comment>(feh has many other options instead of --bg-scale [which will scale the image
223 -to the screen dimensions]. Consult the feh documentation.)</comment>
224 +<comment>(feh has many other options instead of --bg-scale,
225 +which will scale the image to the screen dimensions.
226 +Consult the feh documentation.)</comment>
227 $ <i>feh --bg-scale /path/to/image.jpg</i>
228 </pre>
229
230 @@ -355,11 +372,12 @@
231 </p>
232
233 <p>
234 -Installing nitrogen and getting it into your Openbox menu requires a few more
235 -steps than are readily apparent. Firstly, and most obviously, you need to emerge
236 -nitrogen. Due to <uri link="http://bugs.gentoo.org/show_bug.cgi?id=267231">this
237 -library dependency bug</uri>, you will also need to <c>emerge librsvg</c> to avoid
238 -a runtime termination error. Secondly, you need to run nitrogen with your
239 +Installing nitrogen and getting it into your Openbox menu requires a few more
240 +steps than are readily apparent. Firstly, and most obviously, you need to
241 +<c>emerge nitrogen</c>. Due to <uri
242 +link="http://bugs.gentoo.org/show_bug.cgi?id=267231">this library dependency
243 +bug</uri>, you may also need to <c>emerge --oneshot librsvg</c> to avoid a
244 +runtime termination error. Secondly, you need to run nitrogen with your
245 backgrounds folder appended:
246 </p>
247
248 @@ -369,7 +387,7 @@
249
250 <p>
251 Thirdly, you can set your background image, but it will not be there after you
252 -logout. Just as with feh, you need to restore your background by editing your
253 +logout. Just as with feh, you need to restore your background by editing your
254 <path>autostart.sh</path> script to have the following line:
255 </p>
256
257 @@ -389,285 +407,332 @@
258 <chapter>
259 <title>Programs to use with Openbox</title>
260 <section>
261 -<title>This list</title>
262 <body>
263
264 <p>
265 -The following is a list of some programs which you might want to use within
266 -your Openbox environment. While the list contains numerous terminal emulators,
267 -file managers, panels, and more, it should by no means be considered
268 -exhaustive. If none of the programs listed fit your needs, please check the
269 -appropriate categories in Portage for more options.
270 +The following is a list of some programs which you might want to use within your
271 +Openbox environment. While the list contains numerous terminal emulators, file
272 +managers, panels, and more, it should by no means be considered exhaustive. If
273 +none of the programs listed fit your needs, please check the appropriate
274 +categories in Portage for more options.
275 </p>
276
277 </body>
278 </section>
279 <section>
280 -
281 <title>Terminal emulators</title>
282 <body>
283
284 <ul>
285 -<li>
286 -<uri link="http://packages.gentoo.org/package/x11-terms/evilvte"> EvilVTE</uri>
287 -is an extremely lightweight terminal emulator based on (you guessed it) VTE. It
288 -supports tabs, multiple encodings, as well as an easy and extensible
289 -configuration file.
290 -</li>
291 -<li>
292 -<uri link="http://packages.gentoo.org/package/x11-terms/mrxvt">Mrxvt</uri> is a
293 -multi-tabbed rxvt clone with XFT, transparent background and CJK support. It
294 -also features session support for each tab.
295 -</li>
296 -<li>
297 -<uri link="http://packages.gentoo.org/package/x11-terms/aterm">Aterm</uri>
298 -supports transparency and backwards compatibility with rxvt. It was originally
299 -designed for the AfterStep window manager, but easily integrates with other
300 -environments.
301 -</li>
302 -<li>
303 -<uri link="http://packages.gentoo.org/package/x11-terms/eterm">Eterm</uri> is a
304 -terminal based on vt102 and designed to be a more feature-rich replacement for
305 -xterm.
306 -</li>
307 -<li>
308 -<uri
309 -link="http://packages.gentoo.org/package/x11-terms/rxvt-unicode">Rxvt-unicode</uri>
310 -is a clone of rxvt that supports Unicode, daemons, embedded perl, and multiple
311 -fonts simultaneously.
312 -</li>
313 -<li>
314 -<uri
315 -link="http://packages.gentoo.org/package/x11-terms/terminal">Terminal</uri> is
316 -the VTE-based default for the Xfce desktop environment. It is a little on the
317 -bloated side for use with Openbox, as it pulls in many libraries for Xfce.
318 -</li>
319 +<!-- still ~arch
320 + <li>
321 + <uri
322 + link="http://packages.gentoo.org/package/lxde-base/lxterminal">LXterminal</uri>
323 + is the default terminal emulator for LXDE. It is very lightweight, and
324 + based on VTE. While EvilVTE offers many more customisation options
325 + (including transparency), LXterminal has a graphical interface for some of the
326 + more common options (font, colors, et cetera).
327 + </li>
328 +-->
329 + <li>
330 + <uri
331 + link="http://packages.gentoo.org/package/x11-terms/evilvte">EvilVTE</uri> is
332 + an extremely lightweight terminal emulator based on (you guessed it) VTE. It
333 + supports tabs, multiple encodings, as well as an easy and extensible
334 + configuration file.
335 + </li>
336 + <li>
337 + <uri link="http://packages.gentoo.org/package/x11-terms/mrxvt">Mrxvt</uri>
338 + is a multi-tabbed rxvt clone with XFT, transparent background and CJK
339 + support. It also features session support for each tab.
340 + </li>
341 + <li>
342 + <uri link="http://packages.gentoo.org/package/x11-terms/aterm">Aterm</uri>
343 + supports transparency and backwards compatibility with rxvt. It was
344 + originally designed for the AfterStep window manager, but easily integrates
345 + with other environments.
346 + </li>
347 + <li>
348 + <uri link="http://packages.gentoo.org/package/x11-terms/eterm">Eterm</uri>
349 + is a terminal based on vt102 and designed to be a more feature-rich
350 + replacement for xterm.
351 + </li>
352 + <li>
353 + <uri
354 + link="http://packages.gentoo.org/package/x11-terms/rxvt-unicode">Rxvt-unicode</uri>
355 + is a clone of rxvt that supports Unicode, daemons, embedded perl, and
356 + multiple fonts simultaneously.
357 + </li>
358 + <li>
359 + <uri
360 + link="http://packages.gentoo.org/package/x11-terms/terminal">Terminal</uri>
361 + is the VTE-based default for the Xfce desktop environment, so it does
362 + require some Xfce libraries to run. However, it is still fairly speedy, and
363 + supports transparency and is easily customized.
364 + </li>
365 </ul>
366 +
367 </body>
368 </section>
369
370 <section>
371 -<title>File Managers</title>
372 +<title>File managers</title>
373 <body>
374
375 <ul>
376 -<li>
377 -<uri link="http://packages.gentoo.org/package/x11-misc/pcmanfm">PCManFM</uri>
378 -is the lightweight filemanager from LXDE. It supports tabbed browsing, drag and
379 -drop, thumnails for images, bookmarks, volume management, searching, and more.
380 -It also provides supports for managing the desktop background and drawing
381 -desktop icons (both optionally).
382 -</li>
383 -<li>
384 -<uri link="http://packages.gentoo.org/package/xfce-base/thunar">Thunar</uri> is
385 -the standard file manager from Xfce. It features a bulk renamer,
386 -user-customisable actions, and an extension framework. Since it depends on many
387 -Xfce libraries, it isn't as lightweight as PCManFM, but it's still slimmed down
388 -by comparison to other file managers like Nautilus (from GNOME), and Konqueror
389 -(from KDE).
390 -</li>
391 -<li>
392 -<uri
393 -link="http://packages.gentoo.org/package/gnome-base/nautilus">Nautilus</uri> is
394 -the powerful file manager from the GNOME desktop environment. It features
395 -volume management, thumbnails for images, searching, and some system
396 -configuration. As it depends on many of the GNOME libraries for proper
397 -function, it can seem a heavy compared to some of the other file managers.
398 -</li>
399 -<li>
400 -<uri link="http://packages.gentoo.org/package/app-misc/gentoo">Gentoo</uri> (no
401 -relation to this glorious Linux distribution) is a two-pane style file manager
402 -based on GTK+ 1.x. It is incredibly lightweight, but lacks a majority of the
403 -features now prominent in modern file managers. It should definitely be
404 -considered for older hardware, or if you are wanting a barebones setup.
405 -</li>
406 -<li>
407 -<uri link="http://packages.gentoo.org/package/app-misc/emelfm2">emelFM2</uri>
408 -is another file manager in the vein of Midnight Commander. It features a
409 -three-pane window, and is requires GTK+ 2.6.x or higher. As with the Gentoo
410 -file manager (listed above), it is barebones and does not include many features
411 -prevalent in newer file managers.
412 -</li>
413 +<!-- still ~arch
414 + <li>
415 + <uri
416 + link="http://packages.gentoo.org/package/x11-misc/pcmanfm">PCManFM</uri> is
417 + the lightweight filemanager from LXDE. It supports tabbed browsing, drag and
418 + drop, thumnails for images, bookmarks, volume management, searching, and
419 + more. It also provides supports for managing the desktop background and
420 + drawing desktop icons (both optionally).
421 + </li>
422 +-->
423 + <li>
424 + <uri link="http://packages.gentoo.org/package/xfce-base/thunar">Thunar</uri>
425 + is the standard file manager from Xfce. It features a bulk renamer,
426 + user-customisable actions, and an extension framework, along with many
427 + optional plugins, such as media tag editing. It depends on several Xfce
428 + libraries, but it's still slimmed down compared to other file managers like
429 + Nautilus (from GNOME), and Konqueror (from KDE).
430 + </li>
431 + <li>
432 + <uri
433 + link="http://packages.gentoo.org/package/gnome-base/nautilus">Nautilus</uri>
434 + is the powerful file manager from the GNOME desktop environment. It features
435 + volume management, thumbnails for images, searching, and some system
436 + configuration. As it depends on many of the GNOME libraries for proper
437 + function, it can seem a heavy compared to some of the other file managers.
438 + </li>
439 + <li>
440 + <uri link="http://packages.gentoo.org/package/app-misc/gentoo">Gentoo</uri>
441 + (no relation to this glorious Linux distribution) is a two-pane style file
442 + manager. It is incredibly lightweight, but lacks a some features now
443 + prominent in modern file managers. It should definitely be considered for
444 + older hardware, or if you are wanting a barebones setup.
445 + </li>
446 + <li>
447 + <uri
448 + link="http://packages.gentoo.org/package/app-misc/emelfm2">emelFM2</uri> is
449 + another file manager in the vein of Midnight Commander. It features a
450 + two-pane window. As with the Gentoo file manager (listed above), it is
451 + barebones and does not include many features prevalent in newer file
452 + managers. However, it also offers a few features not found in other file
453 + managers, such as a built-in commandline in a separate pane.
454 + </li>
455 </ul>
456 +
457 </body>
458 </section>
459 -
460 <section>
461 <title>Desktop management</title>
462 <body>
463
464 <ul>
465 -<li>
466 -Though <uri
467 -link="http://packages.gentoo.org/package/x11-misc/pcmanfm">PCManFM</uri> is
468 -mainly a file manager, it also gives you the option to manage the desktop
469 -background (instead of using feh or nitrogen) and draw desktop icons. It should
470 -be noted that with the current release (0.5), it is not readily possible to get
471 -rid of the default "My Documents" icon on the desktop.
472 -</li>
473 -<li>
474 -<uri link="http://packages.gentoo.org/package/x11-misc/idesk">iDesk</uri> is a
475 -simple program used to draw desktop icons. It supports shadowed and
476 -anti-aliased fonts, PNG images, "snap-to-grid" placement, and changing the
477 -desktop background.
478 -</li>
479 +<!-- still ~arch
480 + <li>
481 + Though <uri
482 + link="http://packages.gentoo.org/package/x11-misc/pcmanfm">PCManFM</uri> is
483 + mainly a file manager, it also gives you the option to manage the desktop
484 + background (instead of using feh or nitrogen) and draw desktop icons. It
485 + should be noted that with the current release (0.5), it is not readily
486 + possible to get rid of the default "My Documents" icon on the desktop.
487 + </li>
488 +-->
489 + <li>
490 + <uri link="http://packages.gentoo.org/package/x11-misc/idesk">iDesk</uri> is
491 + a simple program used to draw desktop icons. It supports shadowed and
492 + anti-aliased fonts, PNG images, "snap-to-grid" placement, and changing the
493 + desktop background.
494 + </li>
495 </ul>
496
497 </body>
498 </section>
499 -
500 <section>
501 <title>Panels</title>
502 <body>
503
504 <ul>
505 -<li>
506 -<uri link="http://code.google.com/p/tint2/">Tint2</uri> is a simple panel and
507 -taskbar specifically made for Openbox3 (based on the ttm code). It supports
508 -colour/transparency, a clock, and drag and drop between virtual desktops.
509 -Currently, it is not available in the official Portage tree, but is available
510 -in overlays.
511 -</li>
512 -<li>
513 -<uri link="http://packages.gentoo.org/package/x11-misc/pypanel">PyPanel</uri>
514 -is an easily customised panel written in Python and C. It features
515 -transparency, shading, tinting, location and layout configuration, font type,
516 -autohiding, application launcher, clock, and more.
517 -</li>
518 -<li>
519 -<uri link="http://packages.gentoo.org/package/lxde-base/lxpanel">LXPanel</uri>
520 -is the default panel and taskbar from LXDE. It features a launcher, menu,
521 -clock, and a GUI-based configurator. It is feature-rich while depending on very
522 -few packages, making it a good choice for a lean system.
523 -</li>
524 -<li>
525 -<uri
526 -link="http://packages.gentoo.org/package/xfce-base/xfce4-panel">Xfce4-panel</uri>
527 -is the default panel from the Xfce desktop environment. It supports application
528 -launchers, detachable menus, a pager, tasklist, clock, and more. It does,
529 -however, require a few of the Xfce libraries which are not dependencies of some
530 -other panels.
531 -</li>
532 +<!-- still ~arch
533 + <li>
534 + <uri link="http://code.google.com/p/tint2/">Tint2</uri> is a simple panel
535 + and taskbar specifically made for Openbox3 (based on the ttm code). It
536 + supports color/transparency, a clock, and drag and drop between virtual
537 + desktops.
538 + </li>
539 +-->
540 + <li>
541 + <uri
542 + link="http://packages.gentoo.org/package/x11-misc/pypanel">PyPanel</uri> is
543 + an easily customised panel written in Python and C. It features
544 + transparency, shading, tinting, location and layout configuration, font
545 + type, autohiding, application launcher, clock, and more.
546 + </li>
547 +<!-- still ~arch
548 + <li>
549 + <uri
550 + link="http://packages.gentoo.org/package/lxde-base/lxpanel">LXPanel</uri> is
551 + the default panel and taskbar from LXDE. It features a launcher, menu,
552 + clock, and a GUI-based configurator. It is feature-rich while depending on
553 + very few packages, making it a good choice for a lean system.
554 + </li>
555 +-->
556 + <li>
557 + <uri
558 + link="http://packages.gentoo.org/package/xfce-base/xfce4-panel">Xfce4-panel</uri>
559 + is the default panel from the Xfce desktop environment. It supports
560 + application launchers, detachable menus, a pager, tasklist, clock, applets,
561 + and more. It does, however, require a few of the Xfce libraries which are
562 + not dependencies of some other panels.
563 + </li>
564 + <li>
565 + <uri
566 + link="http://packages.gentoo.org/package/x11-misc/fbpanel">FBpanel</uri> is
567 + a simple, extremely lightweight panel that supports window lists, launchers,
568 + a clock, and a few other goodies. It's not the most featureful panel, and it
569 + can be cumbersome to configure, but it needs only GTK+ to run.
570 + </li>
571 </ul>
572
573 </body>
574 </section>
575 -
576 <section>
577 -<title>Pagers / Systrays</title>
578 +<title>Pagers and systrays</title>
579 <body>
580
581 <ul>
582 -<li>
583 -<uri link="http://packages.gentoo.org/package/x11-misc/netwmpager">NetWMpager</uri> is
584 -an EWMH-compliant pager that integrates nicely into any of the *box environments. It
585 -is not as obtrusive, and is much more readily customisable than many of the other
586 -available pagers.
587 -</li>
588 -<li>
589 -<uri link="http://packages.gentoo.org/package/x11-misc/bbpager">BBpager</uri> is a
590 -desktop pager that was originally written for BlackBox, but works nicely with Openbox
591 -as well. It does have some BlackBox dependencies though.
592 -</li>
593 -<li>
594 -<uri link="http://packages.gentoo.org/package/x11-plugins/docker">Docker</uri> is the
595 -system tray that is made especially for Openbox. It has no extra dependencies, and
596 -gives you the ability to view and use tray icons for supported GTK and QT-based
597 -applications.
598 -</li>
599 -<li>
600 -<uri link="http://packages.gentoo.org/package/x11-misc/trayer">Trayer</uri> is a system
601 -tray that was modified from the FBpanel code, and is often used with FVWM. One of its
602 -perks is that it supports transparency.
603 -</li>
604 + <li>
605 + <uri
606 + link="http://packages.gentoo.org/package/x11-misc/netwmpager">NetWMpager</uri>
607 + is an EWMH-compliant pager that integrates nicely into any of the *box
608 + environments. It is not as obtrusive, and is much more readily customisable
609 + than many of the other available pagers.
610 + </li>
611 + <li>
612 + <uri
613 + link="http://packages.gentoo.org/package/x11-misc/bbpager">BBpager</uri> is
614 + a desktop pager that was originally written for BlackBox, but works nicely
615 + with Openbox as well. It does have some BlackBox dependencies though.
616 + </li>
617 + <li>
618 + <uri
619 + link="http://packages.gentoo.org/package/x11-plugins/docker">Docker</uri> is
620 + the system tray that is made especially for Openbox. It has no extra
621 + dependencies, and gives you the ability to view and use tray icons for
622 + supported GTK and QT-based applications.
623 + </li>
624 + <li>
625 + <uri link="http://packages.gentoo.org/package/x11-misc/trayer">Trayer</uri>
626 + is a system tray that was modified from the FBpanel code, and is often used
627 + with FVWM. One of its perks is that it supports transparency.
628 + </li>
629 </ul>
630
631 </body>
632 </section>
633 -
634 <section>
635 -<title>Session Management</title>
636 +<title>Session management</title>
637 <body>
638
639 <ul>
640 -<li>
641 -<uri link="http://packages.gentoo.org/package/lxde-base/lxsession-lite">
642 -LXsession-Lite</uri> is the stripped down session manager from LXDE. It is
643 -designed to remember applications that the user was running at the last logout,
644 -and to automatically restart those programs. It also supports the HAL daemon.
645 -</li>
646 -<li>
647 -<uri link="http://packages.gentoo.org/package/xfce-base/xfce4-session">
648 -XFCE4-session</uri> is the session manager from, you guessed it, XFCE. It is
649 -capable of saving several sessions, and provides methods for logging out, rebooting,
650 -and suspending your computer. It does, however, have many XFCE and other library
651 -dependencies.
652 -</li>
653 +<!-- still ~arch
654 + <li>
655 + <uri link="http://packages.gentoo.org/package/lxde-base/lxsession">
656 + LXsession</uri> is the stripped down session manager from LXDE. It is
657 + designed to remember applications that the user was running at the last
658 + logout, and to automatically restart those programs. It also supports the
659 + HAL daemon.
660 + </li>
661 +-->
662 + <li>
663 + <uri link="http://packages.gentoo.org/package/xfce-base/xfce4-session">
664 + Xfce4-session</uri> is the session manager from, you guessed it, Xfce. It
665 + is capable of saving several sessions, and provides methods for logging out,
666 + rebooting, and suspending your computer. It does, however, have many Xfce
667 + dependencies.
668 + </li>
669 </ul>
670
671 </body>
672 </section>
673 -
674 <section>
675 <title>Configuration tools</title>
676 <body>
677
678 <ul>
679 -<li>
680 -<uri link="http://packages.gentoo.org/package/x11-misc/obconf">ObConf</uri> is a GUI
681 -application allowing you to customise the Openbox window manager without manually
682 -editing <path>.config/openbox/rc.conf</path>.
683 -</li>
684 -<li>
685 -<uri link="http://packages.gentoo.org/package/lxde-base/lxappearance">LXappearance</uri> is
686 -a GTK theme and icon configurator used with LXDE. It provides a nice graphical interface
687 -for setting the theme and icons, while depending on very few extra libraries.
688 -</li>
689 -<li>
690 -<uri link="http://packages.gentoo.org/package/x11-themes/gtk-chtheme">GTK-ChTheme</uri> is
691 -a simple application allowing for easier switching of GTK themes. Currently, it does not
692 -allow for the switching of icon themes.
693 -</li>
694 + <li>
695 + <uri link="http://packages.gentoo.org/package/x11-misc/obconf">ObConf</uri>
696 + is a GUI application allowing you to customise the Openbox window manager
697 + without manually editing <path>~/.config/openbox/rc.conf</path>.
698 + </li>
699 +<!-- still ~arch
700 + <li>
701 + <uri
702 + link="http://packages.gentoo.org/package/lxde-base/lxappearance">LXappearance</uri>
703 + is a GTK theme and icon configurator used with LXDE. It provides a nice
704 + graphical interface for setting the theme and icons, while depending on very
705 + few extra libraries.
706 + </li>
707 +-->
708 + <li>
709 + <uri
710 + link="http://packages.gentoo.org/package/x11-themes/gtk-chtheme">GTK-ChTheme</uri>
711 + is a simple application allowing for easier switching of GTK themes and your
712 + font. Currently, it does not allow for the switching of icon themes.
713 + </li>
714 + <li>
715 + <uri
716 + link="http://packages.gentoo.org/package/x11-themes/gtk-theme-switch">GTK-theme-switch</uri>
717 + is another simple application that lets you change your GTK theme.
718 + </li>
719 </ul>
720
721 </body>
722 </section>
723 -
724 <section>
725 <title>Miscellaneous</title>
726 <body>
727
728 <ul>
729 -<li>
730 -<uri link="http://packages.gentoo.org/package/app-admin/conky">Conky</uri> is a
731 -lightweight system monitor that can natively display over 250 objects,
732 -including date and time, CPU usage, memory usage, IMAP/POP3 email, top
733 -processes, and even info from your music player. It is highly customisable both
734 -in appearance and data display.
735 -</li>
736 -<li>
737 -<uri link="http://packages.gentoo.org/package/app-editors/leafpad">Leafpad</uri> is
738 -the default text editor from LXDE. It is very lightweight, but includes features
739 -like codeset options, and the ability to undo/redo without limits.
740 -</li>
741 -<li>
742 -<uri link="http://packages.gentoo.org/package/media-gfx/feh">feh</uri> is a
743 -simple image viewer that runs from the terminal, but it also has many other
744 -features. It can display a slideshow of images, create an index print,
745 -dynamically zoom, and set the desktop background (detailed instructions
746 -above).
747 -</li>
748 -<li>
749 -<uri link="http://packages.gentoo.org/package/media-gfx/gpicview">GPicView</uri> is
750 -a GUI-based image viewer. Though it has more dependencies than feh, it is incredibly
751 -quick to load and run. This is the default image viewer from LXDE.
752 -</li>
753 -<li>
754 -<uri link="http://packages.gentoo.org/package/x11-misc/slim">SLiM</uri> is the Simple
755 -Login Manager, which allows you to login to your Openbox session via a graphical
756 -interface instead of the terminal. It has very few dependencies, and supports many
757 -external themes, but should not be used on machines that require remote logins.
758 -</li>
759 + <li>
760 + <uri link="http://packages.gentoo.org/package/app-admin/conky">Conky</uri>
761 + is a lightweight system monitor that can display over 250 objects, including
762 + date and time, CPU usage, memory usage, IMAP/POP3 email, top processes,
763 + hardware sensor data, and even info from your music player. It is highly
764 + customisable both in appearance and data display. We also have a <uri
765 + link="/doc/en/conky-howto.xml">Conky configuration guide</uri> available.
766 + </li>
767 + <li>
768 + <uri
769 + link="http://packages.gentoo.org/package/app-editors/leafpad">Leafpad</uri>
770 + is a simple text editor. It is very lightweight, but includes features like
771 + codeset options, and the ability to undo/redo without limits.
772 + </li>
773 + <li>
774 + <uri link="http://packages.gentoo.org/package/media-gfx/feh">feh</uri> is a
775 + simple image viewer that runs from the terminal, but it also has many other
776 + features. It can display a slideshow of images, create an index print,
777 + dynamically zoom, and set the desktop background (detailed instructions
778 + above).
779 + </li>
780 +<!-- still ~arch
781 + <li>
782 + <uri
783 + link="http://packages.gentoo.org/package/media-gfx/gpicview">GPicView</uri>
784 + is a GUI-based image viewer. Though it has more dependencies than feh, it
785 + is incredibly quick to load and run.
786 + </li>
787 +-->
788 + <li>
789 + <uri link="http://packages.gentoo.org/package/x11-misc/slim">SLiM</uri> is
790 + the Simple Login Manager, which allows you to login to your Openbox session
791 + via a graphical interface instead of the terminal. It has very few
792 + dependencies, and supports many themes, but should not be used on machines
793 + that require remote logins.
794 + </li>
795 </ul>
796
797 </body>
798 @@ -677,17 +742,16 @@
799 <chapter id="inside-desktop-env">
800 <title>Openbox inside desktop environments</title>
801 <section>
802 -<title>LXDE (default)</title>
803 +<title>LXDE</title>
804 <body>
805
806 <p>
807 If installing each component of a working environment sounds like a little
808 <e>too</e> much customisation, but you still want the flexibility of Openbox,
809 -you may want to look into a desktop environment that uses Openbox as its
810 -default window manager. That environment is <uri
811 -link="http://www.lxde.org/">LXDE</uri>, the Lightweight X Desktop Environment.
812 -Designed to require even less system resources than Xfce, it is built around
813 -Openbox and some of the packages mentioned above (like PCManFM and LXpanel).
814 +you may want to look into a desktop environment that uses Openbox as its default
815 +window manager. That environment is <uri link="http://www.lxde.org/">LXDE</uri>,
816 +the Lightweight X Desktop Environment. Designed to require even fewer system
817 +resources than Xfce, it is built around Openbox.
818 </p>
819
820 </body>
821 @@ -699,7 +763,7 @@
822 <p>
823 If you already have a GNOME environment installed, you may just want to replace
824 the Metacity window manager with Openbox. Fortunately, this is quite a simple
825 -task! You will need to fire up your favourite editor, open your
826 +task! You will need to fire up your favourite editor, open your
827 <path>~/.xinitrc</path> file, and put the following command inside it:
828 </p>
829
830 @@ -708,7 +772,7 @@
831 </pre>
832
833 <p>
834 -If you use GDM or another graphic login manager, you will see a new
835 +If you use GDM or another graphical login manager, you will see a new
836 "GNOME/Openbox" option in your session menu. You can simply select that option
837 instead of manually editing your <path>~/.xinitrc</path>.
838 </p>
839 @@ -778,21 +842,23 @@
840 <path>menu.xml</path>, and locate this line:
841 </p>
842
843 -<pre caption="Finding the exit action in menu.xml"><![CDATA[
844 -<item label="Exit">
845 - <action name="Exit"/>
846 -</item>
847 -</pre>
848 -<br />
849 -and change it to this:
850 -<br />
851 +<pre caption="Finding the exit action in menu.xml">
852 +&lt;item label="Exit"&gt;
853 + &lt;action name="Exit"/&gt;
854 +&lt;/item&gt;
855 +</pre>
856 +
857 +<p>
858 +Change it to this:
859 +</p>
860 +
861 <pre caption="Replacing the exit action in menu.xml">
862 -<item label="Exit">
863 - <action name="Execute">
864 - <command>xfce4-session-logout</command>
865 - </action>
866 -</item>
867 -]]></pre>
868 +&lt;item label="Exit"&gt;
869 + &lt;action name="Execute"&gt;
870 + &lt;command&gt;xfce4-session-logout&lt;/command&gt;
871 + &lt;/action&gt;
872 +&lt;/item&gt;
873 +</pre>
874
875 <note>
876 With Xfce4, the root-menu provided by Xfdesktop will be used instead of the
877 @@ -805,7 +871,6 @@
878
879 <chapter>
880 <title>Further documentation</title>
881 -
882 <section>
883 <title>External resources</title>
884 <body>
885 @@ -818,30 +883,29 @@
886 </p>
887
888 <ul>
889 -<li>
890 -On <uri link="http://icculus.org/openbox/index.php/Main_Page">The Official
891 -Openbox website</uri> you will find more detailed information regarding
892 -theming, creating menus (including pipe menus), autostart scripting, and much
893 -more. This site also has information regarding new releases, upgrades, and
894 -instructions on how you can contribute to development.
895 -</li>
896 -<li>
897 -The <uri link="http://urukrama.wordpress.com/openbox-guide/">Urukrama's Guide
898 -to Openbox</uri> blog contains a plethora of information about switching GTK+
899 -themes, setting up keybindings, desktop effects, and other programs to use in
900 -conjunction with Openbox. Though the tutorial was originally written for use
901 -with Ubuntu, everything should be applicable to Gentoo (and other Linux
902 -distributions for that matter).
903 -</li>
904 -<li>
905 -<uri link="http://www.box-look.org/">Box-Look</uri> provides numerous themes,
906 -icons, wallpapers, fonts, and tools to be used with Openbox (as well as the
907 -other *box window managers like Fluxbox, Blackbox, PekWM, etc.)
908 -</li>
909 + <li>
910 + On <uri link="http://icculus.org/openbox/index.php/Main_Page">The Official
911 + Openbox website</uri> you will find more detailed information regarding
912 + theming, creating menus (including pipe menus), autostart scripting, and
913 + much more. This site also has information regarding new releases, upgrades,
914 + and instructions on how you can contribute to development.
915 + </li>
916 + <li>
917 + The <uri link="http://urukrama.wordpress.com/openbox-guide/">Urukrama's
918 + Guide to Openbox</uri> blog contains a plethora of information about
919 + switching GTK+ themes, setting up keybindings, desktop effects, and other
920 + programs to use in conjunction with Openbox. Though the tutorial was
921 + originally written for use with Ubuntu, everything is applicable to Gentoo
922 + (and other Linux distributions for that matter).
923 + </li>
924 + <li>
925 + <uri link="http://www.box-look.org/">Box-Look</uri> provides numerous
926 + themes, icons, wallpapers, fonts, and tools to be used with Openbox (as well
927 + as the other *box window managers like Fluxbox, Blackbox, PekWM, etc.)
928 + </li>
929 </ul>
930
931 </body>
932 </section>
933 </chapter>
934 </guide>
935 -
936
937
938
939 1.221 xml/htdocs/doc/en/metadoc.xml
940
941 file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/metadoc.xml?rev=1.221&view=markup
942 plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/metadoc.xml?rev=1.221&content-type=text/plain
943 diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/metadoc.xml?r1=1.220&r2=1.221
944
945 Index: metadoc.xml
946 ===================================================================
947 RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v
948 retrieving revision 1.220
949 retrieving revision 1.221
950 diff -u -r1.220 -r1.221
951 --- metadoc.xml 14 Jun 2009 15:05:14 -0000 1.220
952 +++ metadoc.xml 28 Jun 2009 03:42:02 -0000 1.221
953 @@ -1,8 +1,8 @@
954 <?xml version="1.0" encoding="UTF-8"?>
955 <!DOCTYPE metadoc SYSTEM "/dtd/metadoc.dtd">
956 -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v 1.220 2009/06/14 15:05:14 neysx Exp $ -->
957 +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v 1.221 2009/06/28 03:42:02 nightmorph Exp $ -->
958 <metadoc lang="en">
959 - <version>1.142</version>
960 + <version>1.143</version>
961 <members>
962 <lead>neysx</lead>
963 <member>cam</member>
964 @@ -362,6 +362,7 @@
965 <file id="zsh">/doc/en/zsh.xml</file>
966 <file id="change-chost">/doc/en/change-chost.xml</file>
967 <file id="xfce-config">/doc/en/xfce-config.xml</file>
968 + <file id="openbox">/doc/en/openbox.xml</file>
969 <file id="gcc-optimization">/doc/en/gcc-optimization.xml</file>
970 <file id="vpnc-howto">/doc/en/vpnc-howto.xml</file>
971 <file id="qa-autofailure">/proj/en/qa/autofailure.xml</file>
972 @@ -788,6 +789,9 @@
973 <doc fileid="xfce-config">
974 <memberof>desktop_install</memberof>
975 </doc>
976 + <doc fileid="openbox">
977 + <memberof>desktop_install</memberof>
978 + </doc>
979 <doc fileid="vserver-howto">
980 <memberof>sysadmin_specific</memberof>
981 </doc>