summaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
authorfluxgen <fluxgen>2001-12-11 20:47:02 (GMT)
committerfluxgen <fluxgen>2001-12-11 20:47:02 (GMT)
commit18830ac9add80cbd3bf7369307d7e35a519dca9b (patch)
tree4759a5434a34ba317fe77bbf8b0ed9bb57bb6018 /INSTALL
parent1523b48bff07dead084af3064ad11c79a9b25df0 (diff)
downloadfluxbox_lack-18830ac9add80cbd3bf7369307d7e35a519dca9b.zip
fluxbox_lack-18830ac9add80cbd3bf7369307d7e35a519dca9b.tar.bz2
Initial revision
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL94
1 files changed, 94 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..471447b
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,94 @@
1-- INSTALL for Fluxbox
2
3Compilation and Installation:
4--------------------------------
5 The `configure' shell script attempts to guess correct values for
6various system-dependent variables used during compilation. It uses
7those values to create a `Makefile' in each directory in the
8Blackbox source tree.
9
10Finally, it creates a shell script `config.status' that you can run
11in the future to recreate the current configuration, a file
12`config.cache' that saves the results of its tests to speed up
13reconfiguring, 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
17to figure out how `configure' could check whether to do them, and mail
18diffs or instructions to bhughes@tcac.net so they can be considered
19for the next release. If at some point `config.cache' contains
20results 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
23called `autoconf'. You only need `configure.in' if you want to change
24it or regenerate `configure' using a newer version of `autoconf'.
25
26The 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
48Compilers and Options:
49----------------------
50 Some systems require unusual options for compilation or linking that
51the `configure' script does not know about. You can give `configure'
52initial values for variables by setting them in the environment. Using
53a Bourne-compatible shell, you can do that on the command line like
54this:
55 CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
56
57Or 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
61Optional Features:
62------------------
63Fluxbox supports the XShape extension of X11R6. This support is enabled by
64default, but may be overridden by specifying `--disable-shape' on the configure
65script's command line.
66
67Fluxbox supports Window Maker dockapps (warning: restarts from wmaker to
68fluxbox don't always handle dockapps correctly) with a gadget called the Slit.
69The Slit is compiled into Blackbox by default, but may be overridden by
70specifying `--disable-slit' on the configure script's command line.
71
72Fluxbox supports a rendering effect called "faked interlacing" which darkens
73every other line in rendered images. This support works only for gradient
74images. It is compiled in by default, but may be overridden by specifying
75`--disable-interlace' on the configure script's command line.
76
77Fluxbox provides an alternative rendering algorithm for dithering on
78pseudocolor (8 bit) displays. A noticeable pattern is visible when using
79this; it's a matter of taste whether this looks better than the default
80algorithm. It is disabled by default, but may be overridden by specifying
81'--enable-ordered-pseudo' on the configure script's command line.
82
83Fluxbox uses a timer which allows it to periodically flush its pixmap
84cache. It is enabled by default, but may be overridden by specifying
85'--disable-timed-cache' on the configure script's command line.
86
87Also, `configure' can usually find the X include and library files
88automatically, but if it doesn't, you can use the `configure'
89options `--x-includes=DIR' and `--x-libraries=DIR' to specify
90their locations.
91
92
93Please read the README file also.
94