580d84d1ad3f0b84ac94944a84b4968a39f7d7d2
[mikachu/openbox.git] / README
1 README for Openbox:
2
3 The source tree for Openbox is comprised of five subdirectories:
4
5         data/           - this holds the default data files that Openbox
6                           requires for proper operation.
7
8         doc/            - this holds the documentation files that explain
9                           the various aspects of Openbox.
10
11         nls/            - this holds the message files used to generate
12                           message catalogs for different languages.
13
14         src/            - this holds the actual C++ source code for the window
15                           manager.
16
17         util/           - this holds source code for small utility programs
18                           that help Openbox do what it does best.
19
20
21 Quick Start:
22 ------------
23 The quickest and easiest way to get Openbox up and running is to run the
24 following commands:
25
26 % cd openbox-x.x.x
27 % ./configure
28 % make
29 % su -c 'make install'
30
31 This will configure, compile and install Openbox the quickest.  For those
32 who like to spend the extra 15 seconds reading ./configure --help, some
33 compile time options can be turned on and off before the build.
34
35 For general information on GNU's ./configure, see the file INSTALL.
36
37
38 Configuring Openbox:
39 ---------------------
40 The next thing most users want to do after installing Openbox is to configure
41 the colors, fonts, menus, etc. to their liking.  This is covered by the files
42 data/README, data/README.menu and data/README.style.  These files give
43 detailed information on how to customize your new window manager.
44
45
46 Included utilities:
47 -------------------
48 Currently, the only included utilities are a program named bsetroot and a
49 script called bsetbg. bsetroot is a replacement for xsetroot, minus a few
50 options.  The difference between xsetroot and bsetroot is that bsetroot has
51 been coded for multiple screens (e.g. multi-headed displays), where as the
52 stock xsetroot is not. The bsetbg script acts as a wrapper for most of the
53 popular programs used to set background pixmaps, making it possible
54 for styles to provide a machine-independent rootCommand.
55
56
57 Third-party utilities:
58 ----------------------
59 Openbox does not handle any keyboard shortcuts; instead it supports a
60 communication protocol which allows other programs to handle these and related
61 tasks. If you'd like to be able to use keyboard shortcuts with Openbox,
62 bbkeys (available at http://bbkeys.sourceforge.net) can provide you with this
63 functionality.
64 If you're looking for a GUI with which to configure your Openbox menu and/or
65 styles, check out http://bbconf.sourceforge.net. bbconf is a QT program that
66 does just that, as well as providing a GUI for editing your keybindings for the
67 above mentioned bbkeys.
68
69 Supported Platforms:
70 --------------------
71 ix86-Linux 2.0.x (libc5 and glibc2)
72 ix86-Linux 2.1.x (libc5 and glibc2)
73 ix86-Linux 2.2.x (libc5 and glibc2)
74 ix86-Linux 2.3.x (glibc2.1)
75 ix86-Linux 2.4.x (glibc2.2)
76 ix86-FreeBSD 4.0-current
77 ix86-FreeBSD 3.3-{stable,release}
78 ix86-FreeBSD 3.2-{stable,release}
79 ix86-FreeBSD 3.1-{stable,release}
80 ix86-FreeBSD 2.2.x-stable
81 ix86-NetBSD 1.3.3
82 ix86-NetBSD 1.4.1
83 ix86-OpenBSD 2.6
84 ix86-BSDi 4.0
85 PPC-mkLinux (version?)
86 ix86-Solaris 2.6
87 Sparc-Solaris 2.6 (2.5 anyone?)
88 Sparc-Solaris 2.7
89 ix86-Solaris 7 (== 2.7?)
90 Alpha-Digital UNIX 4.0D
91 Alpha-Linux 2.2.x
92 rs6k-AIX 4.1.3
93 rs6k-AIX 4.3.2
94 MIPS-IRIX 6.5 (requires gcc, MIPSpro didn't like some of the template-fu)
95 ix86-OS/2 (version? recent successes?)
96 hp9000/715-HP/UX 10.20 (with egcs 1.1.1)
97
98 Please email ben@orodu.net for other success reports.
99