source: x/wm/openbox.xml@ c60a17aa

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since c60a17aa was c60a17aa, checked in by Pierre Labastie <pieere@…>, 9 years ago

Tag LXDE and deps

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