| 1 |
-- INSTALL for Blackbox - an X11 Window manager |
| 2 |
|
| 3 |
Compilation and Installation: |
| 4 |
-------------------------------- |
| 5 |
The `configure' shell script attempts to guess correct values for |
| 6 |
various system-dependent variables used during compilation. It uses |
| 7 |
those values to create a `Makefile' in each directory in the |
| 8 |
Blackbox source tree. |
| 9 |
|
| 10 |
Finally, it creates a shell script `config.status' that you can run |
| 11 |
in the future to recreate the current configuration, a file |
| 12 |
`config.cache' that saves the results of its tests to speed up |
| 13 |
reconfiguring, and a file `config.log' containing compiler output |
| 14 |
(useful mainly for debugging `configure'). |
| 15 |
|
| 16 |
If you need to do unusual things to compile Blackbox, please try |
| 17 |
to figure out how `configure' could check whether to do them, and mail |
| 18 |
diffs or instructions to the blackbox mailing list so they can be considered |
| 19 |
for the next release. If at some point `config.cache' contains |
| 20 |
results you don't want to keep, you may remove or edit it. |
| 21 |
|
| 22 |
The file `configure.in' is used to create `configure' by a program |
| 23 |
called `autoconf'. You only need `configure.in' if you want to change |
| 24 |
it or regenerate `configure' using a newer version of `autoconf'. |
| 25 |
|
| 26 |
The simplest way to compile this package is: |
| 27 |
|
| 28 |
1. `cd' to the directory containing the package's source code and type |
| 29 |
`./configure' to configure the package for your system. If you're |
| 30 |
using `csh' on an old version of System V, you might need to type |
| 31 |
`sh ./configure' instead to prevent `csh' from trying to execute |
| 32 |
`configure' itself. |
| 33 |
|
| 34 |
Running `configure' takes awhile. While running, it prints some |
| 35 |
messages telling which features it is checking for. |
| 36 |
|
| 37 |
2. Type `make' to compile the package. |
| 38 |
|
| 39 |
3. Type `make install' to install the programs and any data files and |
| 40 |
documentation. |
| 41 |
|
| 42 |
4. You can remove the program binaries and object files from the |
| 43 |
source code directory by typing `make clean'. To also remove the |
| 44 |
files that `configure' created (so you can compile the package for |
| 45 |
a different kind of computer), type `make distclean'. |
| 46 |
|
| 47 |
|
| 48 |
Compilers and Options: |
| 49 |
---------------------- |
| 50 |
Some systems require unusual options for compilation or linking that |
| 51 |
the `configure' script does not know about. You can give `configure' |
| 52 |
initial values for variables by setting them in the environment. Using |
| 53 |
a Bourne-compatible shell, you can do that on the command line like |
| 54 |
this: |
| 55 |
CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure |
| 56 |
|
| 57 |
Or on systems that have the `env' program, you can do it like this: |
| 58 |
env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure |
| 59 |
|
| 60 |
This method can also be used to add debugging support to the program: |
| 61 |
CXXFLAGS="-g -Wall -Winline -W -pedantic" ./configure |
| 62 |
|
| 63 |
Optional Features: |
| 64 |
------------------ |
| 65 |
Blackbox supports the XShape extension of X11R6. This support is enabled by |
| 66 |
default, but may be overridden by specifying `--disable-shape' on the configure |
| 67 |
script's command line. |
| 68 |
|
| 69 |
Blackbox supports a rendering effect called "faked interlacing" which darkens |
| 70 |
every other line in rendered images. This support works only for gradient |
| 71 |
images. It is compiled in by default, but may be overridden by specifying |
| 72 |
`--disable-interlace' on the configure script's command line. |
| 73 |
|
| 74 |
Blackbox provides an alternative rendering algorithm for dithering on |
| 75 |
pseudocolor (8 bit) displays. A noticeable pattern is visible when using |
| 76 |
this; it's a matter of taste whether this looks better than the default |
| 77 |
algorithm. It is disabled by default, but may be overridden by specifying |
| 78 |
'--enable-ordered-pseudo' on the configure script's command line. |
| 79 |
|
| 80 |
Blackbox uses a timer which allows it to periodically flush its pixmap |
| 81 |
cache. It is enabled by default, but may be overridden by specifying |
| 82 |
'--disable-timed-cache' on the configure script's command line. |
| 83 |
|
| 84 |
Also, `configure' can usually find the X include and library files |
| 85 |
automatically, but if it doesn't, you can use the `configure' |
| 86 |
options `--x-includes=DIR' and `--x-libraries=DIR' to specify |
| 87 |
their locations. |
| 88 |
|
| 89 |
|
| 90 |
Please read the README file also. |
| 91 |
|