source: x/wm/openbox.xml@ bf48ccc

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts krejzi/svn lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since bf48ccc was bf48ccc, checked in by Bruce Dubbs <bdubbs@…>, 10 years ago

Minor formatting

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@12855 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 15.3 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY openbox-download-http
8 "http://openbox.org/dist/openbox/openbox-&openbox-version;.tar.gz">
9 <!ENTITY openbox-download-ftp " ">
10 <!ENTITY openbox-md5sum "93df606606053b7e8578a5c116afb8ec">
11 <!ENTITY openbox-size "956 KB">
12 <!ENTITY openbox-buildsize "19 MB">
13 <!ENTITY openbox-time "0.3 SBU">
14]>
15
16<sect1 id="openbox" xreflabel="openbox-&openbox-version;">
17 <?dbhtml filename="openbox.html"?>
18
19 <sect1info>
20 <othername>$LastChangedBy$</othername>
21 <date>$Date$</date>
22 </sect1info>
23
24 <title>openbox-&openbox-version;</title>
25
26 <indexterm zone="openbox">
27 <primary sortas="a-openbox">Openbox</primary>
28 </indexterm>
29
30 <sect2 role="package">
31 <title>Introduction to openbox</title>
32
33 <para>
34 <application>Openbox</application> is a highly configurable desktop
35 window manager with extensive standards support. It allows you to control
36 almost every aspect of how you interact with your desktop.
37 </para>
38
39 &lfs75_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&openbox-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>Download MD5 sum: &openbox-md5sum;
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download size: &openbox-size;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Estimated disk space required: &openbox-buildsize;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated build time: &openbox-time;
65 </para>
66 </listitem>
67 </itemizedlist>
68
69 <bridgehead renderas="sect3">Openbox Dependencies</bridgehead>
70
71 <bridgehead renderas="sect4">Required</bridgehead>
72 <para role="required">
73 <xref linkend="x-window-system"/> and
74 <xref linkend="pango"/> (compiled with support for libXft)
75 </para>
76
77 <bridgehead renderas="sect4">Optional</bridgehead>
78 <para role="optional">
79 <xref linkend="imlib2"/> (to enable icons in the right click menu),
80 <xref linkend="pyxdg"/>,
81 <xref linkend="startup-notification"/>, and
82 <xref linkend="librsvg"/>
83 </para>
84
85 <para condition="html" role="usernotes">
86 User Notes: <ulink url="&blfs-wiki;/openbox"/>
87 </para>
88 </sect2>
89
90 <sect2 role="installation">
91 <title>Installation of Openbox</title>
92
93 <note><para>If XORG_PREFIX is not <filename class='directory'>/usr</filename>,
94 tell <command>gcc</command> about it:</para>
95
96 <screen><userinput>export LIBRARY_PATH=$XORG_PREFIX/lib</userinput></screen>
97 </note>
98
99 <para>
100 Install <application>Openbox</application> by running the following
101 commands:
102 </para>
103
104<screen><userinput>
105./configure --prefix=/usr \
106 --sysconfdir=/etc \
107 --disable-static \
108 --docdir=/usr/share/doc/openbox-&openbox-version; &amp;&amp;
109make</userinput></screen>
110
111 <para>
112 This package does not come with a test suite.
113 </para>
114
115 <para>
116 Now, as the <systemitem class="username">root</systemitem> user:
117 </para>
118
119<screen role="root"><userinput>make install</userinput></screen>
120 </sect2>
121
122 <sect2 role="commands">
123 <title>Command Explanations</title>
124
125 <para>
126 <option>--sysconfdir=/etc</option>: This option puts
127 <application>Openbox</application>'s configuration files in
128 /etc/xdg/openbox instead of /usr/etc/xdg/openbox.
129 </para>
130
131 <para>
132 <option>--docdir=/usr/share/doc/openbox-&openbox-version;</option>:
133 this puts a few files in a versioned directory in
134 <filename class="directory">/usr/share/doc</filename>.
135 </para>
136
137 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
138 href="../../xincludes/static-libraries.xml"/>
139
140 </sect2>
141
142 <sect2 role="configuration">
143 <title>Configuring Openbox</title>
144
145 <sect3 id="openbox-config">
146 <title>Config Files</title>
147
148 <para>
149 /etc/xdg/openbox/autostart, /etc/xdg/openbox/menu.xml, /etc/xdg/openbox/rc.xml,
150 ~/.config/openbox/autostart, ~/.config/openbox/menu.xml and ~/.config/openbox/rc.xml
151 </para>
152
153 <indexterm zone="openbox openbox-config">
154 <primary sortas="e-AA.autostart">~/.config/openbox/autostart</primary>
155 </indexterm>
156
157 <indexterm zone="openbox openbox-config">
158 <primary sortas="e-AA.menu">~/.config/openbox/menu.xml</primary>
159 </indexterm>
160
161 <indexterm zone="openbox openbox-config">
162 <primary sortas="e-AA.rc">~/.config/openbox/rc.xml</primary>
163 </indexterm>
164
165 <indexterm zone="openbox openbox-config">
166 <primary sortas="e-etc-path-autostart">/etc/xdg/openbox/autostart</primary>
167 </indexterm>
168
169 <indexterm zone="openbox openbox-config">
170 <primary sortas="e-etc-path-menu">/etc/xdg/openbox/menu.xml</primary>
171 </indexterm>
172
173 <indexterm zone="openbox openbox-config">
174 <primary sortas="e-etc-path-rc">/etc/xdg/openbox/rc.xml</primary>
175 </indexterm>
176 </sect3>
177
178 <sect3><title>Configuration Information</title>
179
180 <para>
181 <application>Openbox</application>'s right click menu can be used to
182 launch programs. The menu itself is configured with 2 files,
183 <filename>/etc/xdg/openbox/menu.xml</filename> and
184 <filename>~/.config/openbox/menu.xml</filename>. To make changes to the
185 menu, copy /etc/xdg/openbox/menu.xml to ~/.config/openbox/menu.xml and
186 edit it:
187 </para>
188
189<screen role="user"><userinput>cp -rf /etc/xdg/openbox ~/.config</userinput></screen>
190 <para>
191
192 <filename>~/.config/openbox/menu.xml</filename> can be edited with a
193 text editor or you can install
194 <ulink url="http://obmenu.sourceforge.net/">Obmenu</ulink> (requires
195 <ulink url="http://pyxml.sourceforge.net/topics/">pyxml</ulink>
196 and <xref linkend="pygtk"/>).
197 </para>
198
199 <para>
200 To have icons in your right click menu requires installing
201 <xref linkend="imlib2"/> before you install
202 <application>Openbox</application>. To set an icon for an entry in the
203 menu edit <filename>~/.config/openbox/menu.xml</filename> and add an
204 icon to the &lt;item&gt; tag like this:
205 </para>
206
207<screen>&lt;item label="Mplayer" icon="/usr/share/pixmaps/mplayer.png"&gt;</screen>
208
209 <para>
210 Many other aspects of <application>Openbox</application>'s behaviour are
211 configured with <filename>~/.config/openbox/rc.xml</filename> such as
212 what keybindings are used to launch programs or which mouse button
213 launches the main menu.
214 </para>
215
216 <para>
217 Details of the theme that <application>Openbox</application> applies to
218 window decorations are configured in
219 <filename>~/.config/openbox/rc.xml</filename>. You can get a list of the
220 available themes with the command:
221 </para>
222
223<screen role="user"><userinput>ls -d /usr/share/themes/*/openbox-3 | sed 's#.*es/##;s#/o.*##'</userinput></screen>
224 </sect3>
225
226 <sect3 id="openbox-init">
227 <title>Starting Openbox</title>
228
229 <para>
230 To automatically start <command>openbox</command> when you start
231 <application>Xorg</application>:
232 </para>
233
234<screen role="user"><userinput>echo openbox &gt; ~/.xinitrc</userinput></screen>
235
236 <para>
237 If you want to set a background image to your desktop you can use
238 <xref linkend="display"/> and launch it from ~/.xinitrc just before
239 openbox:
240 </para>
241
242<screen role="user"><userinput>cat &gt; ~/.xinitrc &lt;&lt; "EOF"
243<literal>display -backdrop -window root /path/to/beautiful/picture.jpeg
244exec openbox</literal>
245EOF</userinput></screen>
246
247 <para>
248 Or if you like a bit of variety, put a selection of images in a folder
249 (in this example, the directory ~/.config/backgrounds) and choose one at
250 random each time you <command>xinit</command>:
251 </para>
252
253<screen role="user"><userinput>cat &gt; ~/.xinitrc &lt;&lt; "EOF"
254<literal># make an array which lists the pictures:
255picture_list=(~/.config/backgrounds/*)
256# create a random integer between 0 and the number of pictures:
257random_number=$(( ${RANDOM} % ${#picture_list[@]} ))
258# display the chosen picture:
259display -backdrop -window root "${picture_list[${random_number}]}"
260exec openbox</literal>
261EOF</userinput></screen>
262
263 <para>
264 If you like to have the numlock key set whan you start Xorg, install
265 <!-- 13-12-11 numlockx not found on the KDE website. This URL is OK ? -->
266 <ulink url="http://ftp.de.debian.org/debian/pool/main/n/numlockx/numlockx_1.2.orig.tar.gz">Numlockx</ulink> and
267 add that to your xinitrc. Another useful application is
268 <xref linkend="dbus"/>
269 </para>
270
271<screen role="user"><userinput>cat &gt; ~/.xinitrc &lt;&lt; "EOF"
272<literal>. /etc/profile
273picture_list=(~/.config/backgrounds/*)
274random_number=$(( ${RANDOM} % ${#picture_list[*]} ))
275display -backdrop -window root "${picture_list[${random_number}]}"
276numlockx
277eval $(dbus-launch --auto-syntax --exit-with-session)
278lxpanel &amp;
279exec openbox</literal>
280EOF</userinput></screen>
281 </sect3>
282 </sect2>
283
284 <sect2 role="content">
285 <title>Contents</title>
286
287 <segmentedlist>
288 <segtitle>Installed Programs</segtitle>
289 <segtitle>Installed Libraries</segtitle>
290 <segtitle>Installed Directories</segtitle>
291
292 <seglistitem>
293 <seg>
294 gdm-control, gnome-panel-control, obxprop, openbox, openbox-autostart,
295 openbox-gnome-session, openbox-kde-session, openbox-session and
296 openbox-xdg-autostart
297 </seg>
298 <seg>
299 libobrender.so and libobt.so
300 </seg>
301 <seg>
302 /etc/xdg/openbox, /usr/include/openbox,
303 /usr/share/doc/openbox-&openbox-version; and /usr/share/themes.
304 </seg>
305 </seglistitem>
306 </segmentedlist>
307
308 <variablelist>
309 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
310 <?dbfo list-presentation="list"?>
311 <?dbhtml list-presentation="table"?>
312
313 <varlistentry id="gdm-control">
314 <term><command>gdm-control</command></term>
315 <listitem>
316 <para>
317 is a command line tool to send signals to
318 <application>GDM</application>.
319 </para>
320 <indexterm zone="openbox gdm-control">
321 <primary sortas="b-gdm-control">gdm-control</primary>
322 </indexterm>
323 </listitem>
324 </varlistentry>
325
326 <varlistentry id="gnome-panel-control">
327 <term><command>gnome-panel-control</command></term>
328 <listitem>
329 <para>
330 is a command line utility to invoke the <application>Gnome
331 Panel</application> run dialog/menu.
332 </para>
333 <indexterm zone="openbox gnome-panel-control">
334 <primary
335 sortas="b-gnome-panel-control">gnome-panel-control</primary>
336 </indexterm>
337 </listitem>
338 </varlistentry>
339
340 <varlistentry id="obxprop">
341 <term><command>obxprop</command></term>
342 <listitem>
343 <para>
344 is a tool for displaying the properties on an x window. It has a
345 similar functionality to <command>xprop</command>, but allows you to
346 see UTF-8 strings as text.
347 </para>
348 <indexterm zone="openbox obxprop">
349 <primary sortas="b-obxprop">obxprop</primary>
350 </indexterm>
351 </listitem>
352 </varlistentry>
353
354 <varlistentry id="openbox-prog">
355 <term><command>openbox</command></term>
356 <listitem>
357 <para>
358 is a standards compliant, highly configurable, window manager.
359 </para>
360 <indexterm zone="openbox openbox">
361 <primary sortas="b-openbox">openbox</primary>
362 </indexterm>
363 </listitem>
364 </varlistentry>
365
366 <varlistentry id="openbox-autostart">
367 <term><command>openbox-autostart</command></term>
368 <listitem>
369 <para>
370 is a script that runs commands and applications at Openbox startup.
371 </para>
372 <indexterm zone="openbox openbox-autostart">
373 <primary sortas="b-openbox-autostart">openbox-autostart</primary>
374 </indexterm>
375 </listitem>
376 </varlistentry>
377
378 <varlistentry id="openbox-xdg-autostart">
379 <term><command>openbox-xdg-autostart</command></term>
380 <listitem>
381 <para>
382 is a script that runs xdg autostart .desktop files.
383 </para>
384 <indexterm zone="openbox openbox-xdg-autostart">
385 <primary sortas="b-openbox-xdg-autostart">openbox-xdg-autostart</primary>
386 </indexterm>
387 </listitem>
388 </varlistentry>
389
390 <varlistentry id="openbox-gnome-session">
391 <term><command>openbox-gnome-session</command></term>
392 <listitem>
393 <para>
394 is a script to launch an <application>Gnome</application> session
395 with <application>Openbox</application> as your window manager from
396 your <filename>~/.xinitrc</filename>.
397 </para>
398 <indexterm zone="openbox openbox-gnome-session">
399 <primary
400 sortas="b-openbox-gnome-session">openbox-gnome-session</primary>
401 </indexterm>
402 </listitem>
403 </varlistentry>
404
405 <varlistentry id="openbox-kde-session">
406 <term><command>openbox-kde-session</command></term>
407 <listitem>
408 <para>
409 is a script to launch an <application>KDE</application> session with
410 <application>Openbox</application> as your window manager from your
411 <filename>~/.xinitrc</filename>.
412 </para>
413 <indexterm zone="openbox openbox-kde-session">
414 <primary
415 sortas="b-openbox-kde-session">openbox-kde-session</primary>
416 </indexterm>
417 </listitem>
418 </varlistentry>
419
420 <varlistentry id="openbox-session">
421 <term><command>openbox-session</command></term>
422 <listitem>
423 <para>
424 is a script to launch an <application>Openbox</application> session
425 from your <filename>~/.xinitrc</filename>.
426 </para>
427 <indexterm zone="openbox openbox-session">
428 <primary sortas="b-openbox-session">openbox-session</primary>
429 </indexterm>
430 </listitem>
431 </varlistentry>
432
433 <varlistentry id="libobrender">
434 <term><filename class="libraryfile">libobrender.so</filename></term>
435 <listitem>
436 <para>
437 contains the functions used by <application>Openbox</application>
438 for theme rendering.
439 </para>
440 <indexterm zone="openbox libobrender">
441 <primary sortas="c-libobrender">libobrender.so</primary>
442 </indexterm>
443 </listitem>
444 </varlistentry>
445
446 <varlistentry id="libobt">
447 <term><filename class="libraryfile">libobt.so</filename></term>
448 <listitem>
449 <para>
450 is the <application>Openbox</application> toolkit library.
451 </para>
452 <indexterm zone="openbox libobt">
453 <primary sortas="c-libobt">libobt.so</primary>
454 </indexterm>
455 </listitem>
456 </varlistentry>
457 </variablelist>
458 </sect2>
459</sect1>
Note: See TracBrowser for help on using the repository browser.