Attachment #202210 for bug #256693

View | Details | Raw Unified | Return to bug 256693
Collapse All | Expand All




<?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.4 2009/08/13 19:54:27 robbat2 Exp $ -->

<guide>
<title>The Openbox Configuration HOWTO</title>

<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>

<version>1.4</version>
<date>2009-08-13</date>

<chapter>
<title>Introduction</title>

very quickly, even on older hardware. Whether your hardware is old or new,
Openbox also provides a highly customisable and unobtrusive working
environment. That means that if you don't want or need a panel, taskbar, clock,
or any other program, those choices are yours to make!
</p>

</body>

The generated menu will be located at
<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 (you must again become root to do so):
</p>

<pre caption="Overwriting the default system-wide menu.xml files">
# <i>cp .config/openbox/menu.xml /etc/xdg/openbox/menu.xml</i>
</pre>

<impo>

</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;execute&gt;/LOCATION/OF/BINARY&lt;/execute&gt;&lt;/action&gt;
    name="execute"&gt;&lt;execute&gt;/LOCATION/OF/BINARY&lt;/execute&gt;&lt;/action&gt;
  &lt;/item&gt;
&lt;/menu&gt;
&lt;/openbox_menu&gt;

&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;openbox_menu&gt;
&lt;menu id="1" label="Configuration"&gt;
  &lt;item label="OpenBox Config"&gt;
    &lt;action name="execute"&gt;&lt;execute&gt;/usr/bin/obconf&lt;/execute&gt;&lt;/action&gt;
  &lt;/item&gt;
&lt;/menu&gt;
&lt;/openbox_menu&gt;
</pre>

</body>

<p>
Adding your own programs to the <path>autostart.sh</path> script is as easy as
writing in the program name for many applications. For instance, if you have
<uri link="http://packages.gentoo.org/package/app-admin/conky">Conky</uri> 
(a lightweight system monitor) installed, and want it to start
automatically with your Openbox session, you simply add the following line to
your <path>autostart.sh</path>:
</p>

Some things that you might take for granted in bigger desktop environments are
not included by default in Openbox. One such thing is setting your desktop
background. In order to place an image as your wallpaper, you will need to
emerge a program like 
<uri link="http://packages.gentoo.org/package/media-gfx/feh">feh</uri> or 
<uri link="http://packages.gentoo.org/package/x11-misc/nitrogen">nitrogen</uri>. 
Feh is a simple image viewer that can also set the background, <e>and</e> it 
can easily be put into the autostart script. Once you have emerged feh, you 
can issue the following command to set the background:
</p>

<pre caption="Using feh to set the background image">

<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
<c>emerge nitrogen</c>. Secondly, you need to run nitrogen with your
link="http://bugs.gentoo.org/show_bug.cgi?id=267231">this library dependency
bug</uri>, you may also need to <c>emerge --oneshot librsvg</c> to avoid a
runtime termination error. Secondly, you need to run nitrogen with your
backgrounds folder appended:
</p>


    link="http://packages.gentoo.org/package/x11-terms/terminal">Terminal</uri>
    is the VTE-based default for the Xfce desktop environment, so it does
    require some Xfce libraries to run. However, it is still fairly speedy, and
    supports transparency and is easily customised.
  </li>
</ul>


    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 bit heavy compared to some of the other file managers.
  </li>
  <li>
    <uri link="http://packages.gentoo.org/package/app-misc/gentoo">Gentoo</uri>

Return to bug 256693

Lines 1-6 Link Here

(-)openbox_1.2.xml (-22 / +20 lines)
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/openbox.xml,v 1.4 2009/08/13 19:54:27 robbat2 Exp $ -->
4		3
5	<guide>	4	<guide>
6	<title>The Openbox Configuration HOWTO</title>	5	<title>The Openbox Configuration HOWTO</title>
Lines 21-28 Link Here
21	<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->	20	<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
22	<license/>	21	<license/>
23		22
24	<version>1.2</version>	23	<version>1.4</version>
25	<date>2009-06-27</date>	24	<date>2009-08-13</date>
26		25
27	<chapter>	26	<chapter>
28	<title>Introduction</title>	27	<title>Introduction</title>
Lines 56-62 Link Here
56	very quickly, even on older hardware. Whether your hardware is old or new,	55	very quickly, even on older hardware. Whether your hardware is old or new,
57	Openbox also provides a highly customisable and unobtrusive working	56	Openbox also provides a highly customisable and unobtrusive working
58	environment. That means that if you don't want or need a panel, taskbar, clock,	57	environment. That means that if you don't want or need a panel, taskbar, clock,
59	or any other program, those choices are yours!	58	or any other program, those choices are yours to make!
60	</p>	59	</p>
61		60
62	</body>	61	</body>
Lines 166-176 Link Here
166	The generated menu will be located at	165	The generated menu will be located at
167	<path>~/.config/openbox/menu.xml</path>. You can then choose to leave it as	166	<path>~/.config/openbox/menu.xml</path>. You can then choose to leave it as
168	your user-specific <path>menu.xml</path>, or to additionally copy it to the	167	your user-specific <path>menu.xml</path>, or to additionally copy it to the
169	system-wide menu configuration as well:	168	system-wide menu configuration as well (you must again become root to do so):
170	</p>	169	</p>
171		170
172	<pre caption="Overwriting the default system-wide menu.xml files">	171	<pre caption="Overwriting the default system-wide menu.xml files">
173	$ <i>cp .config/openbox/menu.xml /etc/xdg/openbox/menu.xml</i>	172	# <i>cp .config/openbox/menu.xml /etc/xdg/openbox/menu.xml</i>
174	</pre>	173	</pre>
175		174
176	<impo>	175	<impo>
Lines 188-200 Link Here
188	</p>	187	</p>
189		188
190	<pre caption="Editing the menu.xml file">	189	<pre caption="Editing the menu.xml file">
191	<?xml version="1.0" encoding="UTF-8"?7gt;	190	<?xml version="1.0" encoding="UTF-8"?gt;
192	<openbox_menu>	191	<openbox_menu>
193	<separator label="NAME_OF_SEPARATOR" />	192	<separator label="NAME_OF_SEPARATOR" />
194	<menu id="IDENTIFIER" label="NAME_OF_MENU">	193	<menu id="IDENTIFIER" label="NAME_OF_MENU">
195	<item label="NAME_OF_PROGRAM">	194	<item label="NAME_OF_PROGRAM">
196	<action	195	<action name="execute"><execute>/LOCATION/OF/BINARY</execute></action>
197	name="execute"><execute>/LOCATION/OF/BINARY</execute></action>
198	</item>	196	</item>
199	</menu>	197	</menu>
200	</openbox_menu>	198	</openbox_menu>
Lines 261-271 Link Here
261	<?xml version="1.0" encoding="UTF-8"?>	259	<?xml version="1.0" encoding="UTF-8"?>
262	<openbox_menu>	260	<openbox_menu>
263	<menu id="1" label="Configuration">	261	<menu id="1" label="Configuration">
264	<item label="OpenBox Config>	262	<item label="OpenBox Config">
265	<action name="execute"><execute>/usr/bin/obconf</execute></action>	263	<action name="execute"><execute>/usr/bin/obconf</execute></action>
266	</item>	264	</item>
267	</menu>	265	</menu>
268	</openbox_menu>>	266	</openbox_menu>
269	</pre>	267	</pre>
270		268
271	</body>	269	</body>
Lines 311-317 Link Here
311	<p>	309	<p>
312	Adding your own programs to the <path>autostart.sh</path> script is as easy as	310	Adding your own programs to the <path>autostart.sh</path> script is as easy as
313	writing in the program name for many applications. For instance, if you have	311	writing in the program name for many applications. For instance, if you have
314	Conky (a lightweight system monitor) installed, and want it to start	312	<uri link="http://packages.gentoo.org/package/app-admin/conky">Conky</uri>
		313	(a lightweight system monitor) installed, and want it to start
315	automatically with your Openbox session, you simply add the following line to	314	automatically with your Openbox session, you simply add the following line to
316	your <path>autostart.sh</path>:	315	your <path>autostart.sh</path>:
317	</p>	316	</p>
Lines 338-347 Link Here
338	Some things that you might take for granted in bigger desktop environments are	337	Some things that you might take for granted in bigger desktop environments are
339	not included by default in Openbox. One such thing is setting your desktop	338	not included by default in Openbox. One such thing is setting your desktop
340	background. In order to place an image as your wallpaper, you will need to	339	background. In order to place an image as your wallpaper, you will need to
341	emerge a program like feh or nitrogen. Feh is a simple image viewer that can	340	emerge a program like
342	also set the background, <e>and</e> it can easily be put into the autostart	341	<uri link="http://packages.gentoo.org/package/media-gfx/feh">feh</uri> or
343	script. Once you have emerged feh, you can issue the following command to set	342	<uri link="http://packages.gentoo.org/package/x11-misc/nitrogen">nitrogen</uri>.
344	the background:	343	Feh is a simple image viewer that can also set the background, <e>and</e> it
		344	can easily be put into the autostart script. Once you have emerged feh, you
		345	can issue the following command to set the background:
345	</p>	346	</p>
346		347
347	<pre caption="Using feh to set the background image">	348	<pre caption="Using feh to set the background image">
Lines 374-383 Link Here
374	<p>	375	<p>
375	Installing nitrogen and getting it into your Openbox menu requires a few more	376	Installing nitrogen and getting it into your Openbox menu requires a few more
376	steps than are readily apparent. Firstly, and most obviously, you need to	377	steps than are readily apparent. Firstly, and most obviously, you need to
377	<c>emerge nitrogen</c>. Due to <uri	378	<c>emerge nitrogen</c>. Secondly, you need to run nitrogen with your
378	link="http://bugs.gentoo.org/show_bug.cgi?id=267231">this library dependency
379	bug</uri>, you may also need to <c>emerge --oneshot librsvg</c> to avoid a
380	runtime termination error. Secondly, you need to run nitrogen with your
381	backgrounds folder appended:	379	backgrounds folder appended:
382	</p>	380	</p>
383		381
Lines 468-474 Link Here
468	link="http://packages.gentoo.org/package/x11-terms/terminal">Terminal</uri>	466	link="http://packages.gentoo.org/package/x11-terms/terminal">Terminal</uri>
469	is the VTE-based default for the Xfce desktop environment, so it does	467	is the VTE-based default for the Xfce desktop environment, so it does
470	require some Xfce libraries to run. However, it is still fairly speedy, and	468	require some Xfce libraries to run. However, it is still fairly speedy, and
471	supports transparency and is easily customized.	469	supports transparency and is easily customised.
472	</li>	470	</li>
473	</ul>	471	</ul>
474		472
Lines 504-510 Link Here
504	is the powerful file manager from the GNOME desktop environment. It features	502	is the powerful file manager from the GNOME desktop environment. It features
505	volume management, thumbnails for images, searching, and some system	503	volume management, thumbnails for images, searching, and some system
506	configuration. As it depends on many of the GNOME libraries for proper	504	configuration. As it depends on many of the GNOME libraries for proper
507	function, it can seem a heavy compared to some of the other file managers.	505	function, it can seem a bit heavy compared to some of the other file managers.
508	</li>	506	</li>
509	<li>	507	<li>
510	<uri link="http://packages.gentoo.org/package/app-misc/gentoo">Gentoo</uri>	508	<uri link="http://packages.gentoo.org/package/app-misc/gentoo">Gentoo</uri>