source: x/wm/openbox.xml@ cfcb253

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 9.0 9.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt 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 cfcb253 was c68f5d2, checked in by Douglas R. Reno <renodr@…>, 5 years ago

Couple of tags

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