set _NET_WM_USER_TIME on the window
[dana/urxvt.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index ce30648..5458714 100644 (file)
--- a/INSTALL
+++ b/INSTALL
-See README.unicode for rxvt-unicode specific documentation.
-
---------------------------------------------------------------------------
-Using GNU autoconfig
---------------------------------------------------------------------------
-  1.   If you retrieved a CVS version of this package, you need the GNU
-       autoconf package to generate the configure script.  This is done
-       by running   ./.prebuild   in this directory which will automatically
-       run autoconf with the appropriate options.
-
-  2.   Run   ./configure   to generate config.h and the various Makefiles.
-       ./configure --help   gives a list of possible options with slightly
-       longer descriptions in README.configure
-
-       Note that configure options have changed since 2.6.x series.
-
-       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
-       Or if you're using a non Bourne-compatible shell, you can do:
-               sh -c 'CFLAGS="-O2 -g" ./configure
-
-       If you are making different versions of rxvt you can configure them
-       to be installed with different names using configure arguments, e.g.
-       ./configure --enable-languages --program-transform-name='s,rxvt,kxvt,;'
-
-  3.   set any other main preferences:
-           Edit "src/feature.h"
-           Edit "config.h"   if you didn't use ./configure options
-           If you're cross-compiling, edit the following in "config.h"
-               NO_XLOCALE
-               SIZEOF_*        # sizeof some types
-
-  4.   Build it (repeat step 2 as desired):
-           make
-
-  5.   build rclock (small xclock with biff & appointments) and
-       optionally edit rclock/feature.h to add/remove features:
-           make clock
-
-  6.   Install both rxvt and rclock:
-           make install
-
-       or install them separately
-           (cd src; make install)
-           (cd rclock; make install)
-
-       you may also want to install doc/etc/rxvt.terminfo and 
-       doc/etc/rxvt.termcap
-
-  7 a. If compiled with UTMP_SUPPORT, you may need to install rxvt setuid
-       root or setuid/setgid to match the file permissions on /etc/utmp
-  7 b.  You may need to install setuid root anyway for some systems so that
-       they can give you ownership of the tty devices.
-
-  8.   On systems which dislike doc/rxvt.1
-           (cd doc; rm rxvt.1; make rxvt.1)
-
-                ===================================
-
-NB:    If you were able to compile OK but running rxvt prints out
-               "rxvt: could not obtain control of tty"
-       running "make tests" from this directory (or from src/test)
-       should give you a breakdown of the failure point which is
-       useful to the developers in fixing the problem
-
-NB:    SunOS (with/without gcc?) gets reported by configure as
-
-               #undef STDC_HEADERS
-               #define HAVE_SYS_IOCTL_H 1
-
-       but the ioctl() defines aren't protected against multiple
-       inclusion, in this case by <termios.h> so use a hack in
-       "feature.h" to avoid the problem.
-
-       Gave up checking for `STDC_HEADERS', since they really should be
-       there and I don't want to deal with the problems when they don't
-       exist.
-
-       SunOS users might complain to the right places and get their
-       system headers fixed so that one day the rest of us won't have
-       to keep compensating :(
-
-       SVR4 users (that aren't using gcc) will have to add -DSVR4 to
-       CPPFLAGS for configure.
-
---
-EOF
+Installation Instructions
+*************************
+
+Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
+2006 Free Software Foundation, Inc.
+
+This file is free documentation; the Free Software Foundation gives
+unlimited permission to copy, distribute and modify it.
+
+Basic Installation
+==================
+
+Briefly, the shell commands `./configure; make; make install' should
+configure, build, and install this package.  The following
+more-detailed instructions are generic; see the `README' file for
+instructions specific to this package.
+
+   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 of the package.
+It may also create one or more `.h' files containing system-dependent
+definitions.  Finally, it creates a shell script `config.status' that
+you can run in the future to recreate the current configuration, and a
+file `config.log' containing compiler output (useful mainly for
+debugging `configure').
+
+   It can also use an optional file (typically called `config.cache'
+and enabled with `--cache-file=config.cache' or simply `-C') that saves
+the results of its tests to speed up reconfiguring.  Caching is
+disabled by default to prevent problems with accidental use of stale
+cache files.
+
+   If you need to do unusual things to compile the package, please try
+to figure out how `configure' could check whether to do them, and mail
+diffs or instructions to the address given in the `README' so they can
+be considered for the next release.  If you are using the cache, and at
+some point `config.cache' contains results you don't want to keep, you
+may remove or edit it.
+
+   The file `configure.ac' (or `configure.in') is used to create
+`configure' by a program called `autoconf'.  You need `configure.ac' 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.
+
+     Running `configure' might take a while.  While running, it prints
+     some messages telling which features it is checking for.
+
+  2. Type `make' to compile the package.
+
+  3. Optionally, type `make check' to run any self-tests that come with
+     the package.
+
+  4. Type `make install' to install the programs and any data files and
+     documentation.
+
+  5. 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'.  There is
+     also a `make maintainer-clean' target, but that is intended mainly
+     for the package's developers.  If you use it, you may have to get
+     all sorts of other programs in order to regenerate files that came
+     with the distribution.
+
+Compilers and Options
+=====================
+
+Some systems require unusual options for compilation or linking that the
+`configure' script does not know about.  Run `./configure --help' for
+details on some of the pertinent environment variables.
+
+   You can give `configure' initial values for configuration parameters
+by setting variables in the command line or in the environment.  Here
+is an example:
+
+     ./configure CC=c99 CFLAGS=-g LIBS=-lposix
+
+   *Note Defining Variables::, for more details.
+
+Compiling For Multiple Architectures
+====================================
+
+You can compile the package for more than one kind of computer at the
+same time, by placing the object files for each architecture in their
+own directory.  To do this, you can use GNU `make'.  `cd' to the
+directory where you want the object files and executables to go and run
+the `configure' script.  `configure' automatically checks for the
+source code in the directory that `configure' is in and in `..'.
+
+   With a non-GNU `make', it is safer to compile the package for one
+architecture at a time in the source code directory.  After you have
+installed the package for one architecture, use `make distclean' before
+reconfiguring for another architecture.
+
+Installation Names
+==================
+
+By default, `make install' installs the package's commands under
+`/usr/local/bin', include files under `/usr/local/include', etc.  You
+can specify an installation prefix other than `/usr/local' by giving
+`configure' the option `--prefix=PREFIX'.
+
+   You can specify separate installation prefixes for
+architecture-specific files and architecture-independent files.  If you
+pass the option `--exec-prefix=PREFIX' to `configure', the package uses
+PREFIX as the prefix for installing programs and libraries.
+Documentation and other data files still use the regular prefix.
+
+   In addition, if you use an unusual directory layout you can give
+options like `--bindir=DIR' to specify different values for particular
+kinds of files.  Run `configure --help' for a list of the directories
+you can set and what kinds of files go in them.
+
+   If the package supports it, you can cause programs to be installed
+with an extra prefix or suffix on their names by giving `configure' the
+option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
+
+Optional Features
+=================
+
+Some packages pay attention to `--enable-FEATURE' options to
+`configure', where FEATURE indicates an optional part of the package.
+They may also pay attention to `--with-PACKAGE' options, where PACKAGE
+is something like `gnu-as' or `x' (for the X Window System).  The
+`README' should mention any `--enable-' and `--with-' options that the
+package recognizes.
+
+   For packages that use the X Window System, `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.
+
+Specifying the System Type
+==========================
+
+There may be some features `configure' cannot figure out automatically,
+but needs to determine by the type of machine the package will run on.
+Usually, assuming the package is built to be run on the _same_
+architectures, `configure' can figure that out, but if it prints a
+message saying it cannot guess the machine type, give it the
+`--build=TYPE' option.  TYPE can either be a short name for the system
+type, such as `sun4', or a canonical name which has the form:
+
+     CPU-COMPANY-SYSTEM
+
+where SYSTEM can have one of these forms:
+
+     OS KERNEL-OS
+
+   See the file `config.sub' for the possible values of each field.  If
+`config.sub' isn't included in this package, then this package doesn't
+need to know the machine type.
+
+   If you are _building_ compiler tools for cross-compiling, you should
+use the option `--target=TYPE' to select the type of system they will
+produce code for.
+
+   If you want to _use_ a cross compiler, that generates code for a
+platform different from the build platform, you should specify the
+"host" platform (i.e., that on which the generated programs will
+eventually be run) with `--host=TYPE'.
+
+Sharing Defaults
+================
+
+If you want to set default values for `configure' scripts to share, you
+can create a site shell script called `config.site' that gives default
+values for variables like `CC', `cache_file', and `prefix'.
+`configure' looks for `PREFIX/share/config.site' if it exists, then
+`PREFIX/etc/config.site' if it exists.  Or, you can set the
+`CONFIG_SITE' environment variable to the location of the site script.
+A warning: not all `configure' scripts look for a site script.
+
+Defining Variables
+==================
+
+Variables not defined in a site shell script can be set in the
+environment passed to `configure'.  However, some packages may run
+configure again during the build, and the customized values of these
+variables may be lost.  In order to avoid this problem, you should set
+them in the `configure' command line, using `VAR=value'.  For example:
+
+     ./configure CC=/usr/local2/bin/gcc
+
+causes the specified `gcc' to be used as the C compiler (unless it is
+overridden in the site shell script).
+
+Unfortunately, this technique does not work for `CONFIG_SHELL' due to
+an Autoconf bug.  Until the bug is fixed you can use this workaround:
+
+     CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
+
+`configure' Invocation
+======================
+
+`configure' recognizes the following options to control how it operates.
+
+`--help'
+`-h'
+     Print a summary of the options to `configure', and exit.
+
+`--version'
+`-V'
+     Print the version of Autoconf used to generate the `configure'
+     script, and exit.
+
+`--cache-file=FILE'
+     Enable the cache: use and save the results of the tests in FILE,
+     traditionally `config.cache'.  FILE defaults to `/dev/null' to
+     disable caching.
+
+`--config-cache'
+`-C'
+     Alias for `--cache-file=config.cache'.
+
+`--quiet'
+`--silent'
+`-q'
+     Do not print messages saying which checks are being made.  To
+     suppress all normal output, redirect it to `/dev/null' (any error
+     messages will still be shown).
+
+`--srcdir=DIR'
+     Look for the package's source code in directory DIR.  Usually
+     `configure' can determine that directory automatically.
+
+`configure' also accepts some other, not widely useful, options.  Run
+`configure --help' for more details.
+