source: x/wm/openbox.xml@ 65336f2

systemd-13485
Last change on this file since 65336f2 was cf7ffff, checked in by Krejzi <krejzi@…>, 10 years ago

Check window managers.

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