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