Adding debian version 3.5.0-4.
[debian/openbox.git] / debian / docs / build.html
1 <a href="toc.html">Table of Contents</a>
2
3 <h1>Building Openbox</h1>
4
5 <h2><a name="compile"></a>Compiling</h2>
6
7 <p>
8 The following is what you will need to compile Openbox:
9 </p>
10
11 <p>
12 <ul>
13 <li>C compiler (such as <a href="http://gcc.gnu.org">GCC</a>).</li>
14 <li>Xlib headers and libraries (development package), distributed with
15 <a href="http://xfree86.org">XFree86</a>.</li>
16 <li><a href="http://fontconfig.org">Fontconfig</a> headers and libraries
17 (development package).</li>
18 <li><a href="http://www.gtk.org">Glib 2</a> headers and libraries
19 (development package)</li>
20 <li><em>Optional:</em> The FreeDesktop.org
21 <a href="http://www.freedesktop.org/software/startup-notification/">
22 Startup-Notification</a> library.</li>
23 </ul>
24 </p>
25
26 <p>
27 Once you have the above dependancies installed, you are ready to build
28 Openbox. Untar the Openbox archive and from inside the source tree, run:
29 </p>
30
31 <p>
32 <blockquote>
33 % <b>./configure</b><br>
34 &nbsp;&nbsp;...configure detects the build evironment...<br>
35 % <b>make</b><br>
36 &nbsp;&nbsp;...openbox builds...<br>
37 % <b>make install</b><br>
38 &nbsp;&nbsp;...openbox installs...<br>
39 </blockquote>
40 </p>
41
42 <p>
43 If the configure command fails and the reason is not obvious, you should
44 look in the <b>config.log</b> file to discover the cause of the problem.
45 </p>
46
47 <h2><a name="install"></a>Installing</h2>
48
49 <p>
50 You can install Openbox by <a href="#compile">compiling from source</a> or via
51 binary packages. It is recommended that you get a package from your
52 distribution if possible.
53 </p>
54
55 <p>
56 Once you have Openbox on your system, you will need to set things up to use it.
57 What to set up depends on how you run X.
58 </p>
59
60 <h3><a name="install-gnome"></a>
61 If you run the GNOME desktop environment:</h3>
62
63 <p>
64 The default window manager for the GNOME environment is <b>metacity</b>. To
65 switch from metacity to Openbox, do the following:
66 </p>
67
68 <blockquote>
69 % <b>openbox --replace</b>
70 </blockquote>
71
72 <p>
73 Choose to save your session the next time you log out so that Openbox will be
74 started for you when you log in again.
75 </p>
76
77 <p>
78 <b>Note:</b> As of GNOME 2.4, gnome-panel no longer manages its own key bindings, and requires that the window manager provide its own key bindings for showing the Main Menu and Run dialog. Openbox does this through the bundled <b>gnome-panel-control</b> tool, which can be used in keybindings to access the gnome-panel. Use the <b>--main-menu</b> option to display gnome-panel's menu, and the <b>--run-dialog</b> to display its Run dialog.
79 </p>
80
81 <h3><a name="install-kde"></a>
82 If you run the K desktop environment:</h3>
83
84 <p>
85 The default window manager for the KDE environment is <b>kwin</b>. To switch
86 from kwin to Openbox, set the following environment variable in your startup
87 scripts:
88 </p>
89
90 <blockquote>
91 % <b>export KDEWM=openbox</b>
92 </blockquote>
93
94 <p>
95 When the <b>KDEWM</b> environment variable is set, Openbox will be used in
96 place of kwin.
97 </p>
98
99 <p>
100 <b>Note:</b> The current release of KDE is still using a non-standard,
101 deprecated protocol for its system tray. This protocol requires interaction
102 from the window manager. In place of that, Openbox includes the
103 <b>kdetrayproxy</b> application. Once you run it, KDE system tray apps will
104 work with window managers that don't support the legacy protocol, like Openbox.
105 </p>
106
107 <p>
108 To run <b>kdetrayproxy</b> before running KDE, and if you are using the KDE
109 login manager, it may be easiest to use the
110 <a href="#install-xdm">display manager</a> method, and make a startup script
111 something like:
112 </p>
113
114 <blockquote>
115 # Startup stuff for X<br />
116 <br />
117 # Make openbox the KDE window manager<br />
118 export KDEWM=openbox<br />
119 <br />
120 # Make KDE system tray apps work<br />
121 kdetrayproxy &<br />
122 <br />
123 # Start the KDE environment<br />
124 startkde
125 </blockquote>
126
127 <h3><a name="install-startx"></a>
128 If you run X via the <b>startx</b> command:</h3>
129
130 <p>
131 You need to edit your <b>$HOME/.xinitrc</b> file. This file is simply
132 a shell script, so to lauch Openbox just make a file something like this:
133 </p>
134
135 <blockquote>
136 # Startup stuff for X<br />
137 <br />
138 exec openbox<br />
139 </blockquote>
140
141 <h3><a name="install-xdm"></a>
142 If you run X via a <b>display manager</b> (xdm, gdm, kdm, ...):</h3>
143
144 <p>
145 You may consult the documentation for your specific display manager regarding
146 adding entries to it. Alternately, you can edit a <b>$HOME/.xsession</b> file.
147 The file is a shell script and can be made identical to the <b>.xinitrc</b>
148 example above. With this method, you would choose <b>default</b> as the login
149 target in your display manager.
150 </p>
151
152 <a href="toc.html">Table of Contents</a>