From 75851acebd35352c5b967ccdc510e0f74158de96 Mon Sep 17 00:00:00 2001 From: Jim Ramsay Date: Tue, 10 Aug 2010 12:00:36 -0400 Subject: Restoring our own custom INSTALL file While automake *can* generate a generic version of this file for us, we don't want it! --- .gitignore | 1 - INSTALL | 90 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 90 insertions(+), 1 deletion(-) create mode 100644 INSTALL diff --git a/.gitignore b/.gitignore index 97868b9..3913606 100644 --- a/.gitignore +++ b/.gitignore @@ -48,6 +48,5 @@ util/fluxbox-remote util/fluxbox-update_configs util/startfluxbox version.h -INSTALL install-sh missing diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..ee8983e --- /dev/null +++ b/INSTALL @@ -0,0 +1,90 @@ +-- INSTALL for Fluxbox + +Compilation and Installation: +-------------------------------- + The `configure' shell script attempts to guess correct values for +various system-dependent variables used during compilation. It uses +those values to create a `Makefile' in each directory in the +Fluxbox source tree. + +Finally, it creates a shell script `config.status' that you can run +in the future to recreate the current configuration, a file +`config.cache' that saves the results of its tests to speed up +reconfiguring, and a file `config.log' containing compiler output +(useful mainly for debugging `configure'). + + If you need to do unusual things to compile Fluxbox, please try +to figure out how `configure' could check whether to do them, and mail +diffs or instructions to fluxbox-developers list (see www.fluxbox.org) +so they can be considered for the next release. If at some point +`config.cache' contains results you don't want to keep, you may remove +or edit it. + + The file `configure.in' is used to create `configure' by a program +called `autoconf'. You only need `configure.in' if you want to change +it or regenerate `configure' using a newer version of `autoconf'. + +The simplest way to compile this package is: + + 1. `cd' to the directory containing the package's source code and type + `./configure' to configure the package for your system. If you're + using `csh' on an old version of System V, you might need to type + `sh ./configure' instead to prevent `csh' from trying to execute + `configure' itself. + + Running `configure' takes awhile. While running, it prints some + messages telling which features it is checking for. + + 2. Type `make' to compile the package. + + 3. Type `make install' to install the programs and any data files and + documentation. + + 4. You can remove the program binaries and object files from the + source code directory by typing `make clean'. To also remove the + files that `configure' created (so you can compile the package for + a different kind of computer), type `make distclean'. + + +Compilers and Options: +---------------------- + Some systems require unusual options for compilation or linking that +the `configure' script does not know about. You can give `configure' +initial values for variables by setting them in the environment. Using +a Bourne-compatible shell, you can do that on the command line like +this: + CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure + +Or on systems that have the `env' program, you can do it like this: + env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure + + +Optional Features: +------------------ +Fluxbox supports the XShape extension of X11R6. This support is enabled by +default, but may be overridden by specifying `--disable-shape' on the configure +script's command line. + +Fluxbox supports Window Maker dockapps (warning: restarts from wmaker to +fluxbox don't always handle dockapps correctly) with a gadget called the Slit. +The Slit is compiled into Fluxbox by default, but may be overridden by +specifying `--disable-slit' on the configure script's command line. + +Fluxbox supports a rendering effect called "faked interlacing" which darkens +every other line in rendered images. This support works only for gradient +images. It is compiled in by default, but may be overridden by specifying +`--disable-interlace' on the configure script's command line. + +Fluxbox uses a timer which allows it to periodically flush its pixmap +cache. It is enabled by default, but may be overridden by specifying +'--disable-timed-cache' on the configure script's command line. + +Also, `configure' can usually find the X include and library files +automatically, but if it doesn't, you can use the `configure' +options `--x-includes=DIR' and `--x-libraries=DIR' to specify +their locations. + + +Please read the README file also. + + -- cgit v0.11.2