source: x/wm/openbox.xml@ b4cbe50

10.1 11.0 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since b4cbe50 was b4cbe50, checked in by Douglas R. Reno <renodr@…>, 8 months ago

Tags

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@24273 af4574ff-66df-0310-9fd7-8a98e5e911e0

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