source: x/wm/openbox.xml@ d8aa38f0

systemd-13485
Last change on this file since d8aa38f0 was d8aa38f0, checked in by DJ Lucas <dj@…>, 8 years ago

Missing tags, fix KDE4 filenames

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@17145 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 14.5 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 "b72794996c6a3ad94b34727b95f9d204">
11 <!ENTITY openbox-size "944 KB">
12 <!ENTITY openbox-buildsize "20 MB">
13 <!ENTITY openbox-time "0.4 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 &lfs79_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="pango"/> (compiled with support for libXft) and
74 <xref linkend="x-window-system"/>
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="librsvg"/>,
82 <xref linkend="pyxdg"/> and
83 <xref linkend="startup-notification"/>
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 <para>If you installed only Python 3 PyXDG module convert one of the
95 scripts to Python 3:</para>
96
97<screen><userinput>2to3 -w data/autostart/openbox-xdg-autostart &amp;&amp;
98sed 's/python/python3/' -i data/autostart/openbox-xdg-autostart</userinput></screen>
99
100 <para>
101 Install <application>Openbox</application> by running the following
102 commands:
103 </para>
104
105<screen><userinput>./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 "exec openbox-session" &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-session</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-session</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-session</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,
295 openbox-gnome-session, openbox-kde-session and openbox-session
296 </seg>
297 <seg>
298 libobrender.so and libobt.so
299 </seg>
300 <seg>
301 /etc/xdg/openbox, /usr/include/openbox,
302 /usr/share/doc/openbox-&openbox-version; and /usr/share/themes.
303 </seg>
304 </seglistitem>
305 </segmentedlist>
306
307 <variablelist>
308 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
309 <?dbfo list-presentation="list"?>
310 <?dbhtml list-presentation="table"?>
311
312 <varlistentry id="gdm-control">
313 <term><command>gdm-control</command></term>
314 <listitem>
315 <para>
316 is a command line tool to send signals to
317 <application>GDM</application>.
318 </para>
319 <indexterm zone="openbox gdm-control">
320 <primary sortas="b-gdm-control">gdm-control</primary>
321 </indexterm>
322 </listitem>
323 </varlistentry>
324
325 <varlistentry id="gnome-panel-control">
326 <term><command>gnome-panel-control</command></term>
327 <listitem>
328 <para>
329 is a command line utility to invoke the <application>Gnome
330 Panel</application> run dialog/menu.
331 </para>
332 <indexterm zone="openbox gnome-panel-control">
333 <primary
334 sortas="b-gnome-panel-control">gnome-panel-control</primary>
335 </indexterm>
336 </listitem>
337 </varlistentry>
338
339 <varlistentry id="obxprop">
340 <term><command>obxprop</command></term>
341 <listitem>
342 <para>
343 is a tool for displaying the properties on an x window. It has a
344 similar functionality to <command>xprop</command>, but allows you to
345 see UTF-8 strings as text.
346 </para>
347 <indexterm zone="openbox obxprop">
348 <primary sortas="b-obxprop">obxprop</primary>
349 </indexterm>
350 </listitem>
351 </varlistentry>
352
353 <varlistentry id="openbox-prog">
354 <term><command>openbox</command></term>
355 <listitem>
356 <para>
357 is a standards compliant, highly configurable, window manager.
358 </para>
359 <indexterm zone="openbox openbox">
360 <primary sortas="b-openbox">openbox</primary>
361 </indexterm>
362 </listitem>
363 </varlistentry>
364
365 <varlistentry id="openbox-gnome-session">
366 <term><command>openbox-gnome-session</command></term>
367 <listitem>
368 <para>
369 is a script to launch an <application>Gnome</application> session
370 with <application>Openbox</application> as your window manager from
371 your <filename>~/.xinitrc</filename>.
372 </para>
373 <indexterm zone="openbox openbox-gnome-session">
374 <primary
375 sortas="b-openbox-gnome-session">openbox-gnome-session</primary>
376 </indexterm>
377 </listitem>
378 </varlistentry>
379
380 <varlistentry id="openbox-kde-session">
381 <term><command>openbox-kde-session</command></term>
382 <listitem>
383 <para>
384 is a script to launch an <application>KDE</application> session with
385 <application>Openbox</application> as your window manager from your
386 <filename>~/.xinitrc</filename>.
387 </para>
388 <indexterm zone="openbox openbox-kde-session">
389 <primary
390 sortas="b-openbox-kde-session">openbox-kde-session</primary>
391 </indexterm>
392 </listitem>
393 </varlistentry>
394
395 <varlistentry id="openbox-session">
396 <term><command>openbox-session</command></term>
397 <listitem>
398 <para>
399 is a script to launch an <application>Openbox</application> session
400 from your <filename>~/.xinitrc</filename>.
401 </para>
402 <indexterm zone="openbox openbox-session">
403 <primary sortas="b-openbox-session">openbox-session</primary>
404 </indexterm>
405 </listitem>
406 </varlistentry>
407
408 <varlistentry id="libobrender">
409 <term><filename class="libraryfile">libobrender.so</filename></term>
410 <listitem>
411 <para>
412 contains the functions used by <application>Openbox</application>
413 for theme rendering.
414 </para>
415 <indexterm zone="openbox libobrender">
416 <primary sortas="c-libobrender">libobrender.so</primary>
417 </indexterm>
418 </listitem>
419 </varlistentry>
420
421 <varlistentry id="libobt">
422 <term><filename class="libraryfile">libobt.so</filename></term>
423 <listitem>
424 <para>
425 is the <application>Openbox</application> toolkit library.
426 </para>
427 <indexterm zone="openbox libobt">
428 <primary sortas="c-libobt">libobt.so</primary>
429 </indexterm>
430 </listitem>
431 </varlistentry>
432 </variablelist>
433 </sect2>
434</sect1>
Note: See TracBrowser for help on using the repository browser.