| 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 "00441b53cf14c03566c8e82643544ff9">
|
|---|
| 11 | <!ENTITY openbox-size "9 MB">
|
|---|
| 12 | <!ENTITY openbox-buildsize "18 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 | &lfs71_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="pkgconfig"/>,
|
|---|
| 74 | <xref linkend="x-window-system"/> and
|
|---|
| 75 | <xref linkend="pango"/> (compiled with support for libXft).
|
|---|
| 76 | </para>
|
|---|
| 77 |
|
|---|
| 78 | <bridgehead renderas="sect4">Optional</bridgehead>
|
|---|
| 79 | <para role="optional">
|
|---|
| 80 | <xref linkend="imlib2"/> (to enable icons in the right click menu).
|
|---|
| 81 | </para>
|
|---|
| 82 |
|
|---|
| 83 | <para condition="html" role="usernotes">
|
|---|
| 84 | User Notes: <ulink url="&blfs-wiki;/openbox"/>
|
|---|
| 85 | </para>
|
|---|
| 86 | </sect2>
|
|---|
| 87 |
|
|---|
| 88 | <sect2 role="installation">
|
|---|
| 89 | <title>Installation of Openbox</title>
|
|---|
| 90 |
|
|---|
| 91 | <para>
|
|---|
| 92 | Install <application>Openbox</application> by running the following
|
|---|
| 93 | commands:
|
|---|
| 94 | </para>
|
|---|
| 95 |
|
|---|
| 96 | <screen><userinput>./configure --prefix=/usr --sysconfdir=/etc --disable-static \
|
|---|
| 97 | --docdir=/usr/share/doc/openbox-&openbox-version; &&
|
|---|
| 98 | make</userinput></screen>
|
|---|
| 99 |
|
|---|
| 100 | <para>
|
|---|
| 101 | To test the results, issue: <command>make check</command>.
|
|---|
| 102 | </para>
|
|---|
| 103 |
|
|---|
| 104 | <para>
|
|---|
| 105 | Now, as the <systemitem class="username">root</systemitem> user:
|
|---|
| 106 | </para>
|
|---|
| 107 |
|
|---|
| 108 | <screen role="root"><userinput>make install</userinput></screen>
|
|---|
| 109 | </sect2>
|
|---|
| 110 |
|
|---|
| 111 | <sect2 role="commands">
|
|---|
| 112 | <title>Command Explanations</title>
|
|---|
| 113 |
|
|---|
| 114 | <para>
|
|---|
| 115 | <option>--sysconfdir=/etc</option>: This option puts
|
|---|
| 116 | <application>Openbox</application>'s configuration files in
|
|---|
| 117 | /etc/xdg/openbox instead of /usr/etc/xdg/openbox.
|
|---|
| 118 | </para>
|
|---|
| 119 |
|
|---|
| 120 | <para>
|
|---|
| 121 | <option>--disable-static</option>: This option stops it compiling
|
|---|
| 122 | static versions of the libraries.
|
|---|
| 123 | </para>
|
|---|
| 124 |
|
|---|
| 125 | <para>
|
|---|
| 126 | <option>--docdir=/usr/share/doc/openbox-&openbox-version;</option>:
|
|---|
| 127 | this puts a few files in a versioned directory in
|
|---|
| 128 | <filename class="directory">/usr/share/doc</filename>.
|
|---|
| 129 | </para>
|
|---|
| 130 | </sect2>
|
|---|
| 131 |
|
|---|
| 132 | <sect2 role="configuration">
|
|---|
| 133 | <title>Configuring Openbox</title>
|
|---|
| 134 |
|
|---|
| 135 | <sect3 id="openbox-config">
|
|---|
| 136 | <title>Config Files</title>
|
|---|
| 137 | <para>In ~/.config/openbox and /etc/xdg/openbox,
|
|---|
| 138 | <filename>menu.xml</filename> and <filename>rc.xml</filename></para>
|
|---|
| 139 |
|
|---|
| 140 | <indexterm zone="openbox openbox-config">
|
|---|
| 141 | <primary sortas="e-AA.menu">~/.config/openbox/menu.xml</primary>
|
|---|
| 142 | </indexterm>
|
|---|
| 143 |
|
|---|
| 144 | <indexterm zone="openbox openbox-config">
|
|---|
| 145 | <primary sortas="e-AA.rc">~/.config/openbox/rc.xml</primary>
|
|---|
| 146 | </indexterm>
|
|---|
| 147 |
|
|---|
| 148 | <indexterm zone="openbox openbox-config">
|
|---|
| 149 | <primary sortas="e-etc-path-menu">/etc/xdg/openbox/menu.xml</primary>
|
|---|
| 150 | </indexterm>
|
|---|
| 151 |
|
|---|
| 152 | <indexterm zone="openbox openbox-config">
|
|---|
| 153 | <primary sortas="e-etc-path-rc">/etc/xdg/openbox/rc.xml</primary>
|
|---|
| 154 | </indexterm>
|
|---|
| 155 | </sect3>
|
|---|
| 156 |
|
|---|
| 157 | <sect3><title>Configuration Information</title>
|
|---|
| 158 |
|
|---|
| 159 | <para>
|
|---|
| 160 | <application>Openbox</application>'s right click menu is used to launch
|
|---|
| 161 | programs. The menu itself is configured with 2 files,
|
|---|
| 162 | <filename>/etc/xdg/openbox/menu.xml</filename> and
|
|---|
| 163 | <filename>~/.config/openbox/menu.xml</filename>. If
|
|---|
| 164 | <filename>~/.config/openbox/menu.xml</filename> doesn't exist then
|
|---|
| 165 | <application>Openbox</application> will copy
|
|---|
| 166 | <filename>/etc/xdg/openbox/menu.xml</filename> to
|
|---|
| 167 | <filename>~/.config/openbox/menu.xml</filename> when it is launched.
|
|---|
| 168 | </para>
|
|---|
| 169 |
|
|---|
| 170 | <para>
|
|---|
| 171 | <filename>~/.config/openbox/menu.xml</filename> can be edited with a
|
|---|
| 172 | text editor or you can install
|
|---|
| 173 | <ulink url="http://obmenu.sourceforge.net/">Obmenu</ulink> (requires
|
|---|
| 174 | <xref linkend="pyxml"/> and <xref linkend="pygtk"/>).
|
|---|
| 175 | </para>
|
|---|
| 176 |
|
|---|
| 177 | <para>
|
|---|
| 178 | To have icons in your right click menu requires installing
|
|---|
| 179 | <xref linkend="imlib2"/> before you install
|
|---|
| 180 | <application>Openbox</application>. To set an icon for an entry in the
|
|---|
| 181 | menu edit <filename>~/.config/openbox/menu.xml</filename> and add an
|
|---|
| 182 | icon to the <item> tag like this:
|
|---|
| 183 | </para>
|
|---|
| 184 |
|
|---|
| 185 | <screen role="user"><userinput><item label="Mplayer" icon="/usr/share/pixmaps/mplayer.png"></userinput></screen>
|
|---|
| 186 |
|
|---|
| 187 | <para>
|
|---|
| 188 | Many other aspects of <application>Openbox</application>'s behaviour are
|
|---|
| 189 | configured with <filename>~/.config/openbox/rc.xml</filename> such as
|
|---|
| 190 | what keybindings are used to launch programs or which mouse button
|
|---|
| 191 | launches the main menu.
|
|---|
| 192 | </para>
|
|---|
| 193 |
|
|---|
| 194 | <para>
|
|---|
| 195 | Details of the theme that <application>Openbox</application> applies to
|
|---|
| 196 | window decorations are configured in
|
|---|
| 197 | <filename>~/.config/openbox/rc.xml</filename>. You can get a list of the
|
|---|
| 198 | available themes with the command:
|
|---|
| 199 | </para>
|
|---|
| 200 |
|
|---|
| 201 | <screen role="user"><userinput>ls -d /usr/share/themes/*/openbox-3 | sed 's#.*es/##;s#/o.*##'</userinput></screen>
|
|---|
| 202 | </sect3>
|
|---|
| 203 |
|
|---|
| 204 | <sect3 id="openbox-init">
|
|---|
| 205 | <title>Starting Openbox</title>
|
|---|
| 206 |
|
|---|
| 207 | <para>
|
|---|
| 208 | To automatically start <command>openbox</command> when you start
|
|---|
| 209 | <application>Xorg</application>:
|
|---|
| 210 | </para>
|
|---|
| 211 |
|
|---|
| 212 | <screen role="user"><userinput>echo openbox > ~/.xinitrc</userinput></screen>
|
|---|
| 213 |
|
|---|
| 214 | <para>
|
|---|
| 215 | Alternatively, use the <command>openbox-session</command> script to
|
|---|
| 216 | launch <command>openbox</command>. It runs another script,
|
|---|
| 217 | <filename>~/.config/openbox/autostart</filename> and if that doesn't
|
|---|
| 218 | exist it runs <filename>/etc/xdg/openbox/autostart</filename>. You can
|
|---|
| 219 | create <filename>~/.config/openbox/autostart</filename> and edit it to
|
|---|
| 220 | start any other programs you want running during your
|
|---|
| 221 | <application>Openbox</application> session (eg, a panel or Dbus).
|
|---|
| 222 | </para>
|
|---|
| 223 | </sect3>
|
|---|
| 224 | </sect2>
|
|---|
| 225 |
|
|---|
| 226 | <sect2 role="content">
|
|---|
| 227 | <title>Contents</title>
|
|---|
| 228 |
|
|---|
| 229 | <segmentedlist>
|
|---|
| 230 | <segtitle>Installed Programs</segtitle>
|
|---|
| 231 | <segtitle>Installed Libraries</segtitle>
|
|---|
| 232 | <segtitle>Installed Directories</segtitle>
|
|---|
| 233 |
|
|---|
| 234 | <seglistitem>
|
|---|
| 235 | <seg>
|
|---|
| 236 | gdm-control, gnome-panel-control, obxprop, openbox,
|
|---|
| 237 | openbox-gnome-session, openbox-kde-session and openbox-session
|
|---|
| 238 | </seg>
|
|---|
| 239 | <seg>
|
|---|
| 240 | libobrender.so and libobt.so
|
|---|
| 241 | </seg>
|
|---|
| 242 | <seg>
|
|---|
| 243 | /etc/xdg/openbox, /usr/include/openbox,
|
|---|
| 244 | /usr/share/doc/openbox-&openbox-version; and /usr/share/themes.
|
|---|
| 245 | </seg>
|
|---|
| 246 | </seglistitem>
|
|---|
| 247 | </segmentedlist>
|
|---|
| 248 |
|
|---|
| 249 | <variablelist>
|
|---|
| 250 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|---|
| 251 | <?dbfo list-presentation="list"?>
|
|---|
| 252 | <?dbhtml list-presentation="table"?>
|
|---|
| 253 |
|
|---|
| 254 | <varlistentry id="gdm-control">
|
|---|
| 255 | <term><command>gdm-control</command></term>
|
|---|
| 256 | <listitem>
|
|---|
| 257 | <para>
|
|---|
| 258 | is a command line tool to send signals to
|
|---|
| 259 | <application>GDM</application>.
|
|---|
| 260 | </para>
|
|---|
| 261 | <indexterm zone="openbox gdm-control">
|
|---|
| 262 | <primary sortas="b-gdm-control">gdm-control</primary>
|
|---|
| 263 | </indexterm>
|
|---|
| 264 | </listitem>
|
|---|
| 265 | </varlistentry>
|
|---|
| 266 |
|
|---|
| 267 | <varlistentry id="gnome-panel-control">
|
|---|
| 268 | <term><command>gnome-panel-control</command></term>
|
|---|
| 269 | <listitem>
|
|---|
| 270 | <para>
|
|---|
| 271 | is a command line utility to invoke the <application>Gnome
|
|---|
| 272 | Panel</application> run dialog/menu.
|
|---|
| 273 | </para>
|
|---|
| 274 | <indexterm zone="openbox gnome-panel-control">
|
|---|
| 275 | <primary
|
|---|
| 276 | sortas="b-gnome-panel-control">gnome-panel-control</primary>
|
|---|
| 277 | </indexterm>
|
|---|
| 278 | </listitem>
|
|---|
| 279 | </varlistentry>
|
|---|
| 280 |
|
|---|
| 281 | <varlistentry id="obxprop">
|
|---|
| 282 | <term><command>obxprop</command></term>
|
|---|
| 283 | <listitem>
|
|---|
| 284 | <para>
|
|---|
| 285 | is a tool for displaying the properties on an x window. It has a
|
|---|
| 286 | similar functionality to <command>xprop</command>, but allows you to
|
|---|
| 287 | see UTF-8 strings as text.
|
|---|
| 288 | </para>
|
|---|
| 289 | <indexterm zone="openbox obxprop">
|
|---|
| 290 | <primary sortas="b-obxprop">obxprop</primary>
|
|---|
| 291 | </indexterm>
|
|---|
| 292 | </listitem>
|
|---|
| 293 | </varlistentry>
|
|---|
| 294 |
|
|---|
| 295 | <varlistentry id="openbox-prog">
|
|---|
| 296 | <term><command>openbox</command></term>
|
|---|
| 297 | <listitem>
|
|---|
| 298 | <para>
|
|---|
| 299 | is a standards compliant, highly configurable, window manager.
|
|---|
| 300 | </para>
|
|---|
| 301 | <indexterm zone="openbox openbox">
|
|---|
| 302 | <primary sortas="b-openbox">openbox</primary>
|
|---|
| 303 | </indexterm>
|
|---|
| 304 | </listitem>
|
|---|
| 305 | </varlistentry>
|
|---|
| 306 |
|
|---|
| 307 | <varlistentry id="openbox-gnome-session">
|
|---|
| 308 | <term><command>openbox-gnome-session</command></term>
|
|---|
| 309 | <listitem>
|
|---|
| 310 | <para>
|
|---|
| 311 | is a script to launch an <application>Gnome</application> session
|
|---|
| 312 | with openbox as your window manager from your
|
|---|
| 313 | <filename>~/.xinitrc</filename>.
|
|---|
| 314 | </para>
|
|---|
| 315 | <indexterm zone="openbox openbox-gnome-session">
|
|---|
| 316 | <primary
|
|---|
| 317 | sortas="b-openbox-gnome-session">openbox-gnome-session</primary>
|
|---|
| 318 | </indexterm>
|
|---|
| 319 | </listitem>
|
|---|
| 320 | </varlistentry>
|
|---|
| 321 |
|
|---|
| 322 | <varlistentry id="openbox-kde-session">
|
|---|
| 323 | <term><command>openbox-kde-session</command></term>
|
|---|
| 324 | <listitem>
|
|---|
| 325 | <para>
|
|---|
| 326 | is a script to launch an <application>KDE</application> session with
|
|---|
| 327 | <application>Openbox</application> as your window manager from your
|
|---|
| 328 | <filename>~/.xinitrc</filename>.
|
|---|
| 329 | </para>
|
|---|
| 330 | <indexterm zone="openbox openbox-kde-session">
|
|---|
| 331 | <primary
|
|---|
| 332 | sortas="b-openbox-kde-session">openbox-kde-session</primary>
|
|---|
| 333 | </indexterm>
|
|---|
| 334 | </listitem>
|
|---|
| 335 | </varlistentry>
|
|---|
| 336 |
|
|---|
| 337 | <varlistentry id="openbox-session">
|
|---|
| 338 | <term><command>openbox-session</command></term>
|
|---|
| 339 | <listitem>
|
|---|
| 340 | <para>
|
|---|
| 341 | is a script to launch an <application>Openbox</application> session
|
|---|
| 342 | from your <filename>~/.xinitrc</filename>.
|
|---|
| 343 | </para>
|
|---|
| 344 | <indexterm zone="openbox openbox-session">
|
|---|
| 345 | <primary sortas="b-openbox-session">openbox-session</primary>
|
|---|
| 346 | </indexterm>
|
|---|
| 347 | </listitem>
|
|---|
| 348 | </varlistentry>
|
|---|
| 349 |
|
|---|
| 350 | <varlistentry id="libobrender">
|
|---|
| 351 | <term><filename class="libraryfile">libobrender.so</filename></term>
|
|---|
| 352 | <listitem>
|
|---|
| 353 | <para>
|
|---|
| 354 | contains the functions used by <application>Openbox</application>
|
|---|
| 355 | for theme rendering.
|
|---|
| 356 | </para>
|
|---|
| 357 | <indexterm zone="openbox libobrender">
|
|---|
| 358 | <primary sortas="c-libobrender">libobrender.so</primary>
|
|---|
| 359 | </indexterm>
|
|---|
| 360 | </listitem>
|
|---|
| 361 | </varlistentry>
|
|---|
| 362 |
|
|---|
| 363 | <varlistentry id="libobt">
|
|---|
| 364 | <term><filename class="libraryfile">libobt.so</filename></term>
|
|---|
| 365 | <listitem>
|
|---|
| 366 | <para>
|
|---|
| 367 | is the <application>Openbox</application> toolkit library.
|
|---|
| 368 | </para>
|
|---|
| 369 | <indexterm zone="openbox libobt">
|
|---|
| 370 | <primary sortas="c-libobt">libobt.so</primary>
|
|---|
| 371 | </indexterm>
|
|---|
| 372 | </listitem>
|
|---|
| 373 | </varlistentry>
|
|---|
| 374 | </variablelist>
|
|---|
| 375 | </sect2>
|
|---|
| 376 | </sect1>
|
|---|
