README

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