[ViewVC] Contents of: cvs/rxvt-unicode/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
Revision:	1.2
Committed:	Wed Dec 17 23:21:56 2003 UTC (20 years, 5 months ago) by pcg
Branch:	MAIN
CVS Tags:	rel-2_1_0, rel-4_8, rel-4_9, rel-4_4, rel-4_6, rel-4_7, rel-4_0, rel-4_1, rel-4_2, rel-4_3, rel-2_8, rel-2_7, rel-2_4, rel-2_5, rel-2_2, rel-2_3, rel-2_0, rel-1_9, rel-5_1, rel-5_0, rel-3_7, rel-3_6, rel-3_5, rel-3_4, rel-3_3, rel-3_2, rel-3_0, rel-3_8, rel-1-3, rel-1-2
Changes since 1.1:	+2 -0 lines
Log Message:	* empty log message *
#	Content
1	See README.unicode for rxvt-unicode specific documentation.
2
3	--------------------------------------------------------------------------
4	Using GNU autoconfig
5	--------------------------------------------------------------------------
6	1. If you retrieved a CVS version of this package, you need the GNU
7	autoconf package to generate the configure script. This is done
8	by running ./.prebuild in this directory which will automatically
9	run autoconf with the appropriate options.
10
11	2. Run ./configure to generate config.h and the various Makefiles.
12	./configure --help gives a list of possible options with slightly
13	longer descriptions in README.configure
14
15	Note that configure options have changed since 2.6.x series.
16
17	Some systems require unusual options for compilation or linking that
18	the `configure' script does not know about. You can give `configure'
19	initial values for variables by setting them in the environment. Using
20	a Bourne-compatible shell, you can do that on the command line like
21	this:
22	CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
23	Or on systems that have the `env' program, you can do it like this:
24	env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
25	Or if you're using a non Bourne-compatible shell, you can do:
26	sh -c 'CFLAGS="-O2 -g" ./configure
27
28	If you are making different versions of rxvt you can configure them
29	to be installed with different names using configure arguments, e.g.
30	./configure --enable-languages --program-transform-name='s,rxvt,kxvt,;'
31
32	3. set any other main preferences:
33	Edit "src/feature.h"
34	Edit "config.h" if you didn't use ./configure options
35	If you're cross-compiling, edit the following in "config.h"
36	NO_XLOCALE
37	SIZEOF_* # sizeof some types
38
39	4. Build it (repeat step 2 as desired):
40	make
41
42	5. build rclock (small xclock with biff & appointments) and
43	optionally edit rclock/feature.h to add/remove features:
44	make clock
45
46	6. Install both rxvt and rclock:
47	make install
48
49	or install them separately
50	(cd src; make install)
51	(cd rclock; make install)
52
53	you may also want to install doc/etc/rxvt.terminfo and
54	doc/etc/rxvt.termcap
55
56	7 a. If compiled with UTMP_SUPPORT, you may need to install rxvt setuid
57	root or setuid/setgid to match the file permissions on /etc/utmp
58	7 b. You may need to install setuid root anyway for some systems so that
59	they can give you ownership of the tty devices.
60
61	8. On systems which dislike doc/rxvt.1
62	(cd doc; rm rxvt.1; make rxvt.1)
63
64	===================================
65
66	NB: If you were able to compile OK but running rxvt prints out
67	"rxvt: could not obtain control of tty"
68	running "make tests" from this directory (or from src/test)
69	should give you a breakdown of the failure point which is
70	useful to the developers in fixing the problem
71
72	NB: SunOS (with/without gcc?) gets reported by configure as
73
74	#undef STDC_HEADERS
75	#define HAVE_SYS_IOCTL_H 1
76
77	but the ioctl() defines aren't protected against multiple
78	inclusion, in this case by <termios.h> so use a hack in
79	"feature.h" to avoid the problem.
80
81	Gave up checking for `STDC_HEADERS', since they really should be
82	there and I don't want to deal with the problems when they don't
83	exist.
84
85	SunOS users might complain to the right places and get their
86	system headers fixed so that one day the rest of us won't have
87	to keep compensating :(
88
89	SVR4 users (that aren't using gcc) will have to add -DSVR4 to
90	CPPFLAGS for configure.
91
92	--
93	EOF