source: x/wm/openbox.xml@ 074c49b

11.3 12.0 12.1 gimp3 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/spidermonkey128 xry111/xf86-video-removal
Last change on this file since 074c49b was 12fe806, checked in by Bruce Dubbs <bdubbs@…>, 18 months ago

Remove unneeded .desktop files.

Several packages add unneeded .desktop files in /usr/share/xsessions/.
These then show up in display managers and can confuse users.
This change moves them out of the way.

Also document that lxdm does not support wayland based desktop sessions.
  • 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>This package creates three .desktop files in the
133 /usr/share/xsessions/ directory. Two of these are not appropriate in a
134 BLFS system, so prevent the extra files showing up as options
135 in a window manager. As the &root; user:</para>
136
137<screen role="root"><userinput>mkdir -p /usr/share/xsessions/deprecated &amp;&amp;
138mv -v /usr/share/xsessions/openbox-{gnome,kde}.desktop /usr/share/xsessions/deprecated</userinput></screen>
139
140</sect2>
141
142 <sect2 role="commands">
143 <title>Command Explanations</title>
144
145 <para>
146 <parameter>--sysconfdir=/etc</parameter>: This option puts
147 <application>Openbox</application>'s configuration files in
148 /etc/xdg/openbox instead of /usr/etc/xdg/openbox.
149 </para>
150
151 <para>
152 <parameter>--docdir=/usr/share/doc/openbox-&openbox-version;</parameter>:
153 this puts a few files in a versioned directory in
154 <filename class="directory">/usr/share/doc</filename>.
155 </para>
156
157 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
158 href="../../xincludes/static-libraries.xml"/>
159
160 </sect2>
161
162 <sect2 role="configuration">
163 <title>Configuring Openbox</title>
164
165 <sect3 id="openbox-config">
166 <title>Config Files</title>
167
168 <para>
169 <filename>/etc/xdg/openbox/autostart</filename>,
170 <filename>/etc/xdg/openbox/menu.xml</filename>,
171 <filename>/etc/xdg/openbox/rc.xml</filename>,
172 <filename>~/.config/openbox/autostart</filename>,
173 <filename>~/.config/openbox/menu.xml</filename> and
174 <filename>~/.config/openbox/rc.xml</filename>
175 </para>
176
177 <indexterm zone="openbox openbox-config">
178 <primary sortas="e-AA.autostart">~/.config/openbox/autostart</primary>
179 </indexterm>
180
181 <indexterm zone="openbox openbox-config">
182 <primary sortas="e-AA.menu">~/.config/openbox/menu.xml</primary>
183 </indexterm>
184
185 <indexterm zone="openbox openbox-config">
186 <primary sortas="e-AA.rc">~/.config/openbox/rc.xml</primary>
187 </indexterm>
188
189 <indexterm zone="openbox openbox-config">
190 <primary sortas="e-etc-path-autostart">/etc/xdg/openbox/autostart</primary>
191 </indexterm>
192
193 <indexterm zone="openbox openbox-config">
194 <primary sortas="e-etc-path-menu">/etc/xdg/openbox/menu.xml</primary>
195 </indexterm>
196
197 <indexterm zone="openbox openbox-config">
198 <primary sortas="e-etc-path-rc">/etc/xdg/openbox/rc.xml</primary>
199 </indexterm>
200 </sect3>
201
202 <sect3><title>Configuration Information</title>
203
204 <para>
205 <application>Openbox</application>'s right click menu can be used to
206 launch programs. The menu itself is configured with 2 files,
207 <filename>/etc/xdg/openbox/menu.xml</filename> and
208 <filename>~/.config/openbox/menu.xml</filename>. To make changes to the
209 menu, copy /etc/xdg/openbox/menu.xml to ~/.config/openbox/menu.xml and
210 edit it:
211 </para>
212
213<screen><userinput>cp -rf /etc/xdg/openbox ~/.config</userinput></screen>
214 <para>
215
216 <filename>~/.config/openbox/menu.xml</filename> can be edited with a
217 text editor or you can install
218 <ulink url="https://obmenu.sourceforge.net/">Obmenu</ulink> (requires
219 <ulink url="https://pyxml.sourceforge.net/topics/">pyxml</ulink>
220 and <xref linkend="pygtk"/>).
221 </para>
222
223 <para>
224 To have icons in your right click menu requires installing
225 <xref linkend="imlib2"/> before you install
226 <application>Openbox</application>. To set an icon for an entry in the
227 menu edit <filename>~/.config/openbox/menu.xml</filename> and add an
228 icon to the &lt;item&gt; tag like this:
229 </para>
230
231<screen>&lt;item label="Mplayer" icon="/usr/share/pixmaps/mplayer.png"&gt;</screen>
232
233 <para>
234 Many other aspects of <application>Openbox</application>'s behavior are
235 configured with <filename>~/.config/openbox/rc.xml</filename> such as
236 what keybindings are used to launch programs or which mouse button
237 launches the main menu.
238 </para>
239
240 <para>
241 Details of the theme that <application>Openbox</application> applies to
242 window decorations are configured in
243 <filename>~/.config/openbox/rc.xml</filename>. You can get a list of the
244 available themes with the command:
245 </para>
246
247<screen role="nodump"><userinput>ls -d /usr/share/themes/*/openbox-3 | sed 's#.*es/##;s#/o.*##'</userinput></screen>
248 </sect3>
249
250 <sect3 id="openbox-init">
251 <title>Starting Openbox</title>
252
253 <para>
254 To automatically start <command>openbox</command> when you start
255 <application>Xorg</application>:
256 </para>
257
258<screen><userinput>echo openbox &gt; ~/.xinitrc</userinput></screen>
259
260 <para>
261 If you want to set a background image to your desktop you can use
262 <xref linkend="display"/> and launch it from ~/.xinitrc just before
263 openbox:
264 </para>
265
266<screen role="nodump"><userinput>cat &gt; ~/.xinitrc &lt;&lt; "EOF"
267<literal>display -backdrop -window root /path/to/beautiful/picture.jpeg
268exec openbox</literal>
269EOF</userinput></screen>
270
271 <para>
272 Or if you like a bit of variety, put a selection of images in a folder
273 (in this example, the directory ~/.config/backgrounds) and choose one at
274 random each time you <command>xinit</command>:
275 </para>
276
277<screen role="nodump"><userinput>cat &gt; ~/.xinitrc &lt;&lt; "EOF"
278<literal># make an array which lists the pictures:
279picture_list=(~/.config/backgrounds/*)
280# create a random integer between 0 and the number of pictures:
281random_number=$(( ${RANDOM} % ${#picture_list[@]} ))
282# display the chosen picture:
283display -backdrop -window root "${picture_list[${random_number}]}"
284exec openbox</literal>
285EOF</userinput></screen>
286
287 <para>
288 If you like to have the numlock key set when you start Xorg, install
289 <!-- 13-12-11 numlockx not found on the KDE website. This URL is OK ? -->
290 <ulink url=
291 "https://ftp.debian.org/debian/pool/main/n/numlockx/numlockx_1.2.orig.tar.gz">
292 Numlockx</ulink> and add that to your xinitrc. Another useful
293 application is <xref linkend="dbus"/>:
294 </para>
295
296<screen role="nodump"><userinput>cat &gt; ~/.xinitrc &lt;&lt; "EOF"
297<literal>. /etc/profile
298picture_list=(~/.config/backgrounds/*)
299random_number=$(( ${RANDOM} % ${#picture_list[*]} ))
300display -backdrop -window root "${picture_list[${random_number}]}"
301numlockx
302eval $(dbus-launch --auto-syntax --exit-with-session)
303lxpanel &amp;
304exec openbox</literal>
305EOF</userinput></screen>
306 </sect3>
307 </sect2>
308
309 <sect2 role="content">
310 <title>Contents</title>
311
312 <segmentedlist>
313 <segtitle>Installed Programs</segtitle>
314 <segtitle>Installed Libraries</segtitle>
315 <segtitle>Installed Directories</segtitle>
316
317 <seglistitem>
318 <seg>
319 gdm-control, gnome-panel-control, obxprop, openbox,
320 openbox-gnome-session, openbox-kde-session and openbox-session
321 </seg>
322 <seg>
323 libobrender.so and libobt.so
324 </seg>
325 <seg>
326 /etc/xdg/openbox, /usr/include/openbox,
327 /usr/share/doc/openbox-&openbox-version; and /usr/share/themes.
328 </seg>
329 </seglistitem>
330 </segmentedlist>
331
332 <variablelist>
333 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
334 <?dbfo list-presentation="list"?>
335 <?dbhtml list-presentation="table"?>
336
337 <varlistentry id="gdm-control">
338 <term><command>gdm-control</command></term>
339 <listitem>
340 <para>
341 is a command line tool to send signals to
342 <application>GDM</application>
343 </para>
344 <indexterm zone="openbox gdm-control">
345 <primary sortas="b-gdm-control">gdm-control</primary>
346 </indexterm>
347 </listitem>
348 </varlistentry>
349
350 <varlistentry id="gnome-panel-control">
351 <term><command>gnome-panel-control</command></term>
352 <listitem>
353 <para>
354 is a command line utility to invoke the <application>Gnome
355 Panel</application> run dialog/menu
356 </para>
357 <indexterm zone="openbox gnome-panel-control">
358 <primary sortas="b-gnome-panel-control">gnome-panel-control</primary>
359 </indexterm>
360 </listitem>
361 </varlistentry>
362
363 <varlistentry id="obxprop">
364 <term><command>obxprop</command></term>
365 <listitem>
366 <para>
367 is a tool for displaying the properties on an x window. It has a
368 similar functionality to <command>xprop</command>, but allows you to
369 see UTF-8 strings as text
370 </para>
371 <indexterm zone="openbox obxprop">
372 <primary sortas="b-obxprop">obxprop</primary>
373 </indexterm>
374 </listitem>
375 </varlistentry>
376
377 <varlistentry id="openbox-prog">
378 <term><command>openbox</command></term>
379 <listitem>
380 <para>
381 is a standards compliant, highly configurable, window manager
382 </para>
383 <indexterm zone="openbox openbox">
384 <primary sortas="b-openbox">openbox</primary>
385 </indexterm>
386 </listitem>
387 </varlistentry>
388
389 <varlistentry id="openbox-gnome-session">
390 <term><command>openbox-gnome-session</command></term>
391 <listitem>
392 <para>
393 is a script to launch an <application>Gnome</application> session
394 with <application>Openbox</application> as your window manager from
395 your <filename>~/.xinitrc</filename>
396 </para>
397 <indexterm zone="openbox openbox-gnome-session">
398 <primary sortas="b-openbox-gnome-session">openbox-gnome-session</primary>
399 </indexterm>
400 </listitem>
401 </varlistentry>
402
403 <varlistentry id="openbox-kde-session">
404 <term><command>openbox-kde-session</command></term>
405 <listitem>
406 <para>
407 is a script to launch an <application>KDE</application> session with
408 <application>Openbox</application> as your window manager from your
409 <filename>~/.xinitrc</filename>
410 </para>
411 <indexterm zone="openbox openbox-kde-session">
412 <primary 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
457</sect1>
Note: See TracBrowser for help on using the repository browser.