source: x/wm/openbox.xml@ 88647e80

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts krejzi/svn lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 88647e80 was 88647e80, checked in by Igor Živković <igor@…>, 11 years ago

Openbox: formatting, mention autostart used by openbox-session

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