aboutsummaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
authorJim Ramsay <i.am@jimramsay.com>2010-08-10 16:00:36 (GMT)
committerJim Ramsay <i.am@jimramsay.com>2010-08-10 16:00:36 (GMT)
commit75851acebd35352c5b967ccdc510e0f74158de96 (patch)
tree63b06bd64265ba15031e740f610ca00915ad4ec4 /INSTALL
parentbf0d2565860990f5f177d48919fc5990e1602094 (diff)
downloadfluxbox_pavel-75851acebd35352c5b967ccdc510e0f74158de96.zip
fluxbox_pavel-75851acebd35352c5b967ccdc510e0f74158de96.tar.bz2
Restoring our own custom INSTALL file
While automake *can* generate a generic version of this file for us, we don't want it!
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL90
1 files changed, 90 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..ee8983e
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,90 @@
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
8Fluxbox 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 Fluxbox, please try
17to figure out how `configure' could check whether to do them, and mail
18diffs or instructions to fluxbox-developers list (see www.fluxbox.org)
19so they can be considered for the next release. If at some point
20`config.cache' contains results you don't want to keep, you may remove
21or edit it.
22
23 The file `configure.in' is used to create `configure' by a program
24called `autoconf'. You only need `configure.in' if you want to change
25it or regenerate `configure' using a newer version of `autoconf'.
26
27The simplest way to compile this package is:
28
29 1. `cd' to the directory containing the package's source code and type
30 `./configure' to configure the package for your system. If you're
31 using `csh' on an old version of System V, you might need to type
32 `sh ./configure' instead to prevent `csh' from trying to execute
33 `configure' itself.
34
35 Running `configure' takes awhile. While running, it prints some
36 messages telling which features it is checking for.
37
38 2. Type `make' to compile the package.
39
40 3. Type `make install' to install the programs and any data files and
41 documentation.
42
43 4. You can remove the program binaries and object files from the
44 source code directory by typing `make clean'. To also remove the
45 files that `configure' created (so you can compile the package for
46 a different kind of computer), type `make distclean'.
47
48
49Compilers and Options:
50----------------------
51 Some systems require unusual options for compilation or linking that
52the `configure' script does not know about. You can give `configure'
53initial values for variables by setting them in the environment. Using
54a Bourne-compatible shell, you can do that on the command line like
55this:
56 CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
57
58Or on systems that have the `env' program, you can do it like this:
59 env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
60
61
62Optional Features:
63------------------
64Fluxbox supports the XShape extension of X11R6. This support is enabled by
65default, but may be overridden by specifying `--disable-shape' on the configure
66script's command line.
67
68Fluxbox supports Window Maker dockapps (warning: restarts from wmaker to
69fluxbox don't always handle dockapps correctly) with a gadget called the Slit.
70The Slit is compiled into Fluxbox by default, but may be overridden by
71specifying `--disable-slit' on the configure script's command line.
72
73Fluxbox supports a rendering effect called "faked interlacing" which darkens
74every other line in rendered images. This support works only for gradient
75images. It is compiled in by default, but may be overridden by specifying
76`--disable-interlace' on the configure script's command line.
77
78Fluxbox uses a timer which allows it to periodically flush its pixmap
79cache. It is enabled by default, but may be overridden by specifying
80'--disable-timed-cache' on the configure script's command line.
81
82Also, `configure' can usually find the X include and library files
83automatically, but if it doesn't, you can use the `configure'
84options `--x-includes=DIR' and `--x-libraries=DIR' to specify
85their locations.
86
87
88Please read the README file also.
89
90