source: x/wm/openbox.xml@ 4ea982c2

11.3 12.0 12.1 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/xf86-video-removal
Last change on this file since 4ea982c2 was 17aa21c, checked in by Xi Ruoyao <xry111@…>, 15 months ago

Change all ​http://*.sourceforge.net/ URLs to https

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