source: x/wm/openbox.xml@ 83fbca4

12.0 12.1 kea ken/TL2024 ken/tuningfonts lazarus lxqt plabs/newcss python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since 83fbca4 was 86324838, checked in by Pierre Labastie <pierre.labastie@…>, 16 months ago

Tweak /usr/share/{x,wayland-}sessions files

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