*** empty log message ***
[dana/urxvt.git] / INSTALL
1 --------------------------------------------------------------------------
2 Using GNU autoconfig
3 --------------------------------------------------------------------------
4   1.    If you retrieved a CVS version of this package, you need the GNU
5         autoconf package to generate the configure script.  This is done
6         by running   ./genac   in this directory which will automatically
7         run autoconf with the appropriate options.
8
9   2.    Run   ./configure   to generate config.h and the various Makefiles.
10         ./configure --help   gives a list of possible options with slightly
11         longer descriptions in README.configure
12
13         Some systems require unusual options for compilation or linking that
14         the `configure' script does not know about.  You can give `configure'
15         initial values for variables by setting them in the environment.  Using
16         a Bourne-compatible shell, you can do that on the command line like
17         this:
18                 CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
19         Or on systems that have the `env' program, you can do it like this:
20                 env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
21         Or if you're using a non Bourne-compatible shell, you can do:
22                 sh -c 'CFLAGS="-O2 -g" ./configure
23
24         If you are making different versions of rxvt you can configure them
25         to be installed with different names using configure arguments, e.g.
26         ./configure --enable-languages --program-transform-name='s,rxvt,kxvt,;'
27
28   3.    set any other main preferences:
29             Edit "src/feature.h"
30             Edit "config.h"   if you didn't use ./configure options
31             If you're cross-compiling, edit the following in "config.h"
32                 NO_XLOCALE
33                 SIZEOF_*        # sizeof some types
34
35   4.    Build it (repeat step 2 as desired):
36             make
37
38   5.    build rclock (small xclock with biff & appointments) and
39         optionally edit rclock/feature.h to add/remove features:
40             make clock
41
42   6.    Install both rxvt and rclock:
43             make install
44
45         or install them separately
46             (cd src; make install)
47             (cd rclock; make install)
48
49         you may also want to install doc/etc/rxvt-unicode.terminfo and 
50         doc/etc/rxvt-unicode.termcap
51
52   7 a.  If compiled with UTMP_SUPPORT, you may need to install rxvt setuid
53         root or setuid/setgid to match the file permissions on /etc/utmp
54   7 b.  You may need to install setuid root anyway for some systems so that
55         they can give you ownership of the tty devices.
56
57                  ===================================
58
59 NB:     SunOS (with/without gcc?) gets reported by configure as
60
61                 #undef STDC_HEADERS
62                 #define HAVE_SYS_IOCTL_H 1
63
64         but the ioctl() defines aren't protected against multiple
65         inclusion, in this case by <termios.h> so use a hack in
66         "feature.h" to avoid the problem.
67
68         Gave up checking for `STDC_HEADERS', since they really should be
69         there and I don't want to deal with the problems when they don't
70         exist.
71
72         SunOS users might complain to the right places and get their
73         system headers fixed so that one day the rest of us won't have
74         to keep compensating :(
75
76         SVR4 users (that aren't using gcc) will have to add -DSVR4 to
77         CPPFLAGS for configure.
78
79 --
80 EOF
81