[gentoo-commits] gentoo commit in xml/htdocs/doc/en: openbox.xml

["Xavier Neys (neysx)" <neysx@gentoo.org>]

neysx       09/04/27 20:18:50

  Modified:             openbox.xml
  Log:
  New draft from #256693

Revision  Changes    Path
1.2                  xml/htdocs/doc/en/openbox.xml

file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/openbox.xml?rev=1.2&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/openbox.xml?rev=1.2&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/openbox.xml?r1=1.1&r2=1.2

Index: openbox.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/openbox.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- openbox.xml	29 Jan 2009 17:50:20 -0000	1.1
+++ openbox.xml	27 Apr 2009 20:18:50 -0000	1.2
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/openbox.xml,v 1.1 2009/01/29 17:50:20 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/openbox.xml,v 1.2 2009/04/27 20:18:50 neysx Exp $ -->
 
 <guide disclaimer="draft">
 <title>The Openbox Configuration HOWTO</title>
@@ -18,8 +18,8 @@
 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
 <license/>
 
-<version>1</version>
-<date>2009-01-29</date>
+<version>1.1</version>
+<date>2009-04-27</date>
 
 <chapter>
 <title>Introduction</title>
@@ -151,29 +151,24 @@
 </pre>
 
 <p>
-Once it is installed, you need to tell it that you want a menu specifically
-using the Openbox XML syntax:
+Once it is installed, make sure to logout of root, and back into your user account.  
+You then instruct MenuMaker to create a menu specifically using the Openbox XML 
+syntax:
 </p>
 
 <pre caption="Using MenuMaker to generate a basic Openbox menu.xml">
-# <i>mmaker -v OpenBox3</i>
+$ <i>mmaker -v OpenBox3</i>
 </pre>
 
 <p>
 The generated menu will be located at
-<path>/root/.config/openbox/menu.xml</path>. You can then copy the file, and
-overwrite either your user-specific <path>menu.xml</path> or the system-wide
-one (both mentioned above):
+<path>~/.config/openbox/menu.xml</path>. You can then choose to leave it as 
+your user-specific <path>menu.xml</path>, or to additionally copy it to the 
+system-wide menu configuration as well:
 </p>
 
-<pre caption="Overwriting the default menu.xml files">
-<comment>(Creating or overwriting your user-specific menu)</comment>
-# <i>mv /root/.config/openbox/menu.xml /home/$USER/.config/openbox/menu.xml</i>
-
-OR
-
-<comment>(Overwriting your system-wide menu)</comment>
-# <i>mv /root/.config/openbox/menu.xml /etc/xdg/openbox/menu.xml</i>
+<pre caption="Overwriting the default system-wide menu.xml files">
+$ <i>mv .config/openbox/menu.xml /etc/xdg/openbox/menu.xml</i>
 </pre>
 
 <impo>
@@ -193,17 +188,24 @@
 <pre caption="Editing the menu.xml file"><![CDATA[
 <?xml version="1.0" encoding="UTF-8"?>
 <openbox_menu>
-<separator label="<i>NAME_OF_SEPARATOR</i>">
-<menu id="<i>IDENTIFIER</i>" label="<i>NAME_OF_MENU</i>">
-  <item label="<i>NAME_OF_PROGRAM</i>">
-    <action name="execute"><execute><i>/LOCATION/OF/BINARY</i></execute></action>
+<separator label="NAME_OF_SEPARATOR" />
+<menu id="IDENTIFIER" label="NAME_OF_MENU">
+  <item label="NAME_OF_PROGRAM">
+    <action name="execute"><execute>/LOCATION/OF/BINARY</execute></action>
   </item>
 </menu>
 </openbox_menu>
 ]]></pre>
 
 <p>
-Simply replace anything in <c>BLUE CAPS</c> with your information.
+Simply replace anything in CAPS with your information.
+</p>
+
+<p>
+Alternatively, you can <c>emerge obmenu</c>, which is a graphical interface 
+allowing you to create your menus without having to manually edit the 
+<path>menu.xml</path> file.  It is a very small application and offers a 
+nice amount of customisation without typing any XML.
 </p>
 
 </body>
@@ -327,8 +329,8 @@
 </p>
 
 <pre caption="Using feh to set the background image">
-<comment>(feh has many other options instead of --bg-scale (which will scale the image
-to the screen dimensions). Consult the feh documentation.)</comment>
+<comment>(feh has many other options instead of --bg-scale [which will scale the image
+to the screen dimensions]. Consult the feh documentation.)</comment>
 $ <i>feh --bg-scale /path/to/image.jpg</i>
 </pre>
 
@@ -345,6 +347,41 @@
 source $HOME/.fehbg &amp;
 </pre>
 
+<p>
+If you don't particularly care for the idea of having to issue a command in the 
+terminal in order to set your background, you can alternatively use nitrogen.  It 
+will allow you to set a folder for your background images, view thumbnails of 
+those images, and fit, stretch, or tile them to your desktop.
+</p>
+
+<p>
+Installing nitrogen and getting it into your Openbox menu requires a few more 
+steps than are readily apparent.  Firstly, and most obviously, you need to emerge 
+nitrogen.  Due to <uri link="http://bugs.gentoo.org/show_bug.cgi?id=267231">this 
+library dependency bug</uri>, you will also need to <c>emerge librsvg</c> to avoid 
+a runtime termination error.  Secondly, you need to run nitrogen with your 
+backgrounds folder appended:
+</p>
+
+<pre caption="Starting nitrogen with your image folder">
+nitrogen /path/to/your/backgrounds/folder
+</pre>
+
+<p>
+Thirdly, you can set your background image, but it will not be there after you 
+logout.  Just as with feh, you need to restore your background by editing your 
+<path>autostart.sh</path> script to have the following line:
+</p>
+
+<pre caption="Restoring your background with nitrogen">
+nitrogen --restore &amp;
+</pre>
+
+<p>
+This will cause nitrogen to load automatically when you start your Openbox session, 
+and that can lead to a slightly slower load time than using feh.
+</p>
+
 </body>
 </section>
 </chapter>
@@ -410,6 +447,52 @@
 </section>
 
 <section>
+<title>File Managers</title>
+<body>
+
+<ul>
+<li>
+<uri link="http://packages.gentoo.org/package/x11-misc/pcmanfm">PCManFM</uri>
+is the lightweight filemanager from LXDE. It supports tabbed browsing, drag and
+drop, thumnails for images, bookmarks, volume management, searching, and more.
+It also provides supports for managing the desktop background and drawing
+desktop icons (both optionally).
+</li>
+<li>
+<uri link="http://packages.gentoo.org/package/xfce-base/thunar">Thunar</uri> is
+the standard file manager from Xfce. It features a bulk renamer,
+user-customisable actions, and an extension framework. Since it depends on many
+Xfce libraries, it isn't as lightweight as PCManFM, but it's still slimmed down
+by comparison to other file managers like Nautilus (from GNOME), and Konqueror
+(from KDE).
+</li>
+<li>
+<uri
+link="http://packages.gentoo.org/package/gnome-base/nautilus">Nautilus</uri> is
+the powerful file manager from the GNOME desktop environment. It features
+volume management, thumbnails for images, searching, and some system
+configuration. As it depends on many of the GNOME libraries for proper
+function, it can seem a heavy compared to some of the other file managers.
+</li>
+<li>
+<uri link="http://packages.gentoo.org/package/app-misc/gentoo">Gentoo</uri> (no
+relation to this glorious Linux distribution) is a two-pane style file manager
+based on GTK+ 1.x. It is incredibly lightweight, but lacks a majority of the
+features now prominent in modern file managers. It should definitely be
+considered for older hardware, or if you are wanting a barebones setup.
+</li>
+<li>
+<uri link="http://packages.gentoo.org/package/app-misc/emelfm2">emelFM2</uri>
+is another file manager in the vein of Midnight Commander. It features a
+three-pane window, and is requires GTK+ 2.6.x or higher. As with the Gentoo
+file manager (listed above), it is barebones and does not include many features
+prevalent in newer file managers.
+</li>
+</ul>
+</body>
+</section>
+
+<section>
 <title>Desktop management</title>
 <body>
 
@@ -432,14 +515,14 @@
 
 </body>
 </section>
+
 <section>
 <title>Panels</title>
 <body>
 
 <ul>
 <li>
-Currently not in the official tree, <uri
-link="http://code.google.com/p/tint2/">Tint2</uri> is a simple panel and
+<uri link="http://code.google.com/p/tint2/">Tint2</uri> is a simple panel and
 taskbar specifically made for Openbox3 (based on the ttm code). It supports
 colour/transparency, a clock, and drag and drop between virtual desktops.
 Currently, it is not available in the official Portage tree, but is available
@@ -469,51 +552,87 @@
 
 </body>
 </section>
+
 <section>
-<title>File Managers</title>
+<title>Pagers / Systrays</title>
 <body>
 
 <ul>
 <li>
-<uri link="http://packages.gentoo.org/package/x11-misc/pcmanfm">PCManFM</uri>
-is the lightweight filemanager from LXDE. It supports tabbed browsing, drag and
-drop, thumnails for images, bookmarks, volume management, searching, and more.
-It also provides supports for managing the desktop background and drawing
-desktop icons (both optionally).
+<uri link="http://packages.gentoo.org/package/x11-misc/netwmpager">NetWMpager</uri> is 
+an EWMH-compliant pager that integrates nicely into any of the *box environments.  It 
+is not as obtrusive, and is much more readily customisable than many of the other 
+available pagers.
 </li>
 <li>
-<uri link="http://packages.gentoo.org/package/xfce-base/thunar">Thunar</uri> is
-the standard file manager from Xfce. It features a bulk renamer,
-user-customisable actions, and an extension framework. Since it depends on many
-Xfce libraries, it isn't as lightweight as PCManFM, but it's still slimmed down
-by comparison to other file managers like Nautilus (from GNOME), and Konqueror
-(from KDE).
+<uri link="http://packages.gentoo.org/package/x11-misc/bbpager">BBpager</uri> is a 
+desktop pager that was originally written for BlackBox, but works nicely with Openbox 
+as well.  It does have some BlackBox dependencies though.
 </li>
 <li>
-<uri
-link="http://packages.gentoo.org/package/gnome-base/nautilus">Nautilus</uri> is
-the powerful file manager from the GNOME desktop environment. It features
-volume management, thumbnails for images, searching, and some system
-configuration. As it depends on many of the GNOME libraries for proper
-function, it can seem a heavy compared to some of the other file managers.
+<uri link="http://packages.gentoo.org/package/x11-plugins/docker">Docker</uri> is the 
+system tray that is made especially for Openbox.  It has no extra dependencies, and 
+gives you the ability to view and use tray icons for supported GTK and QT-based 
+applications.
 </li>
 <li>
-<uri link="http://packages.gentoo.org/package/app-misc/gentoo">Gentoo</uri> (no
-relation to this glorious Linux distribution) is a two-pane style file manager
-based on GTK+ 1.x. It is incredibly lightweight, but lacks a majority of the
-features now prominent in modern file managers. It should definitely be
-considered for older hardware, or if you are wanting a barebones setup.
+<uri link="http://packages.gentoo.org/package/x11-misc/trayer">Trayer</uri> is a system 
+tray that was modified from the FBpanel code, and is often used with FVWM.  One of its 
+perks is that it supports transparency.
 </li>
+</ul>
+
+</body>
+</section>
+
+<section>
+<title>Session Management</title>
+<body>
+
+<ul>
 <li>
-<uri link="http://packages.gentoo.org/package/app-misc/emelfm2">emelFM2</uri>
-is another file manager in the vein of Midnight Commander. It features a
-three-pane window, and is requires GTK+ 2.6.x or higher. As with the Gentoo
-file manager (listed above), it is barebones and does not include many features
-prevalent in newer file managers.
+<uri link="http://packages.gentoo.org/package/lxde-base/lxsession-lite">
+LXsession-Lite</uri> is the stripped down session manager from LXDE.  It is 
+designed to remember applications that the user was running at the last logout, 
+and to automatically restart those programs.  It also supports the HAL daemon.
+</li>
+<li>
+<uri link="http://packages.gentoo.org/package/xfce-base/xfce4-session">
+XFCE4-session</uri> is the session manager from, you guessed it, XFCE.  It is 
+capable of saving several sessions, and provides methods for logging out, rebooting, 
+and suspending your computer.  It does, however, have many XFCE and other library 
+dependencies.
+</li>
+</ul>
+
+</body>
+</section>
+
+<section>
+<title>Configuration tools</title>
+<body>
+
+<ul>
+<li>
+<uri link="http://packages.gentoo.org/package/x11-misc/obconf">ObConf</uri> is a GUI 
+application allowing you to customise the Openbox window manager without manually 
+editing <path>.config/openbox/rc.conf</path>.
+</li>
+<li>
+<uri link="http://packages.gentoo.org/package/lxde-base/lxappearance">LXappearance</uri> is 
+a GTK theme and icon configurator used with LXDE.  It provides a nice graphical interface 
+for setting the theme and icons, while depending on very few extra libraries.
+</li>
+<li>
+<uri link="http://packages.gentoo.org/package/x11-themes/gtk-chtheme">GTK-ChTheme</uri> is 
+a simple application allowing for easier switching of GTK themes.  Currently, it does not 
+allow for the switching of icon themes.
 </li>
 </ul>
+
 </body>
 </section>
+
 <section>
 <title>Miscellaneous</title>
 <body>
@@ -527,12 +646,28 @@
 in appearance and data display.
 </li>
 <li>
+<uri link="http://packages.gentoo.org/package/app-editors/leafpad">Leafpad</uri> is 
+the default text editor from LXDE.  It is very lightweight, but includes features 
+like codeset options, and the ability to undo/redo without limits.
+</li>
+<li>
 <uri link="http://packages.gentoo.org/package/media-gfx/feh">feh</uri> is a
 simple image viewer that runs from the terminal, but it also has many other
 features. It can display a slideshow of images, create an index print,
 dynamically zoom, and set the desktop background (detailed instructions
 above).
 </li>
+<li>
+<uri link="http://packages.gentoo.org/package/media-gfx/gpicview">GPicView</uri> is 
+a GUI-based image viewer.  Though it has more dependencies than feh, it is incredibly 
+quick to load and run.  This is the default image viewer from LXDE.
+</li>
+<li>
+<uri link="http://packages.gentoo.org/package/x11-misc/slim">SLiM</uri> is the Simple 
+Login Manager, which allows you to login to your Openbox session via a graphical 
+interface instead of the terminal.  It has very few dependencies, and supports many 
+external themes, but should not be used on machines that require remote logins.
+</li>
 </ul>
 
 </body>
@@ -709,3 +844,4 @@
 </section>
 </chapter>
 </guide>
+