source: x/wm/openbox.xml@ 34a6571

11.0 11.1 11.2 11.3 12.0 12.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 34a6571 was 34a6571, checked in by Pierre Labastie <pierre.labastie@…>, 3 years ago

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