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

[Joshua Saddler (nightmorph)]

nightmorph    10/02/14 20:34:48

  Modified:             openbox.xml
  Log:
  Updates from bug 256693

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

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

Index: openbox.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/openbox.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- openbox.xml	29 Dec 2009 19:23:08 -0000	1.6
+++ openbox.xml	14 Feb 2010 20:34:48 -0000	1.7
@@ -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.6 2009/12/29 19:23:08 nightmorph Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/openbox.xml,v 1.7 2010/02/14 20:34:48 nightmorph Exp $ -->
 
 <guide>
 <title>The Openbox Configuration HOWTO</title>
@@ -21,8 +21,8 @@
 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
 <license/>
 
-<version>1.4</version>
-<date>2009-12-29</date>
+<version>1.5</version>
+<date>2010-02-14</date>
 
 <chapter>
 <title>Introduction</title>
@@ -124,6 +124,12 @@
 own menu that contains links to <e>your</e> programs.
 </p>
 
+<impo>
+If you click to view the menu and notice that there is nothing legible, you need
+to install some fonts. Two common choices are <c>media-fonts/corefonts</c> and
+<c>media-fonts/ttf-bitstream-vera</c>.
+</impo>
+
 </body>
 </section>
 <section>
@@ -153,9 +159,9 @@
 </pre>
 
 <p>
-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:
+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">
@@ -200,10 +206,26 @@
 </pre>
 
 <p>
-Simply replace anything in CAPS with your information.
+The above example will work for any applications that launch with standard 
+options in their own windows, but what if you need to append options to 
+the program at launch time?  That is no problem either, but the syntax of 
+the menu item is slightly different.
 </p>
 
+<pre caption="Editing the menu.xml file">
+&lt;?xml version="1.0" encoding="UTF-8"?&gt;
+&lt;openbox_menu&gt;
+&lt;separator label="NAME_OF_SEPARATOR" /&gt;
+&lt;menu id="IDENTIFIER" label="NAME_OF_MENU"&gt;
+  &lt;item label="NAME_OF_PROGRAM"&gt;
+    &lt;action name="execute"&gt;&lt;command&gt;/LOCATION/OF/BINARY --OPTION1 --OPTION2&lt;/command&gt;&lt;/action&gt;
+  &lt;/item&gt;
+&lt;/menu&gt;
+&lt;/openbox_menu&gt;
+</pre>
+
 <p>
+Simply replace anything in CAPS in the above two examples with your information.
 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 
@@ -267,6 +289,22 @@
 &lt;/openbox_menu&gt;
 </pre>
 
+<p>
+While ObConf is a great GUI tool for editing many behaviour-related settings 
+for Openbox, it doesn't allow one to manipulate nearly as many settings as 
+are presented in the <path>rc.xml</path> file itself.  If you are having 
+trouble finding a particular setting which you would like to change, please 
+consult the <uri link="http://openbox.org/wiki/Configuration">Openbox Wiki</uri> 
+for more information.
+</p>
+
+<note>
+In recent versions of Openbox (namely >3.4.7.2), one may experience a delay 
+in the submenu opening.  This setting was introduced into the rc.xml file, and 
+is listed as &lt;submenuShowDelay&gt;100&lt;/submenuShowDelay&gt;.  Simply 
+choose a lower number that suits your needs.
+</note>
+
 </body>
 </section>
 <section>
@@ -861,11 +899,11 @@
 
 <ul>
   <li>
-    On <uri link="http://icculus.org/openbox/index.php/Main_Page">The Official
-    Openbox website</uri> you will find more detailed information regarding
-    theming, creating menus (including pipe menus), autostart scripting, and
-    much more. This site also has information regarding new releases, upgrades,
-    and instructions on how you can contribute to development.
+    On <uri link="http://openbox.org/">The Official Openbox website</uri> 
+    you will find more detailed information regarding theming, creating menus 
+    (including pipe menus), autostart scripting, and much more. This site also 
+    has information regarding new releases, upgrades, and instructions on how 
+    you can contribute to development.
   </li>
   <li>
     The <uri link="http://urukrama.wordpress.com/openbox-guide/">Urukrama's