rxvt-unicode/README.configure

CONFIGURE OPTIONS
    General hint: if you get compile errors, then likely your configuration
    hasn't been tested well. Either try with --enable-everything or use the
    ./reconf script as a base for experiments. ./reconf is used by myself,
    so it should generally be a working config. Of course, you should always
    report when a combination doesn't work, so it can be fixed. Marc Lehmann
    <rxvt@schmorp.de>.

    --enable-everything
        Add support for all non-multichoice options listed in "./configure
        --help". Note that unlike other enable options this is order
        dependant. You can specify this and then disable options which this
        enables by *following* this with the appropriate commands.

    --enable-xft
        Add support for Xft (anti-aliases, among others) fonts. Xft fonts
        are slower and require lots of memory, but as long as you don't use
        them, you don't pay for them.

    --with-codesets=NAME,...
        Compile in support for additional codeset groups:

           all             all of the above 
           cn              common chinese encodings 
           cn_ext          rarely used but very big chinese encodigs 
           jp              common japanese encodings 
           jp_ext          rarely used but big japanese encodings 
           kr              korean encodings 

    --enable-xim
        Add support for XIM (X Input Method) protocol. This allows using
        alternative input methods (e.g. kinput2) and will also correctly set
        up the input for people using dead keys or compose keys.

    --enable-unicode3
        Enable direct support for displaying unicode codepoints above 65535
        (the basic multilingual page). This increases storage requirements
        per character from 2 to 4 bytes. X11 fonts do not yet support these
        extra characters, but Xft does.

        Please note that rxvt-unicode can store unicode code points >65535
        even without this flag, but the number of such characters is limited
        to a view thousand (shared with combining characters, see next
        switch), and right now rxvt-unicode cannot display them
        (input/output and cut&paste still work, though).

    --enable-combining
        Enable automatic composition of combining characters into composite
        characters. This is required for proper viewing of text where
        accents are encoded as seperate unicode characters. This is done by
        using precomposited characters when available or creating new
        pseudo-characters when no precomposed form exists.

        Without --enable-unicode3, the number of additional precomposed
        characters is rather limited (2048, if this is full, rxvt will use
        the private use area, extending the number of combinations to 8448).
        With --enable-unicode3, no practical limit exists. This will also
        enable storage of characters >65535.

        The combining table also contains entries for arabic presentation
        forms, but these are not currently used. Bug me if you want these to
        be used.

    --enable-fallback(=CLASS)
        When reading resource settings, also read settings for class CLASS
        (default: Rxvt). To disable resource fallback use
        --disable-fallback.

    --with-res-name=NAME
        Use the given name (default: urxvt) as default application name when
        reading resources. Specify --with-res-name=rxvt to replace rxvt.

    --with-res-class=CLASS
        Use the given class (default: URxvt) as default application class
        when reading resources. Specify --with-res-class=Rxvt to replace
        rxvt.

    --enable-utmp
        Write user and tty to utmp file (used by programs like w) at start
        of rxvt execution and delete information when rxvt exits.

    --enable-wtmp
        Write user and tty to wtmp file (used by programs like last) at
        start of rxvt execution and write logout when rxvt exits. This
        option requires --enable-utmp to also be specified.

    --enable-lastlog
        Write user and tty to lastlog file (used by programs like lastlogin)
        at start of rxvt execution. This option requires --enable-utmp to
        also be specified.

    --enable-xpm-background
        Add support for XPM background pixmaps.

    --enable-transparency
        Add support for inheriting parent backgrounds thus giving a fake
        transparency to the term.

    --enable-fading
        Add support for fading the text when focus is lost.

    --enable-tinting
        Add support for tinting of transparent backgrounds.

    --enable-menubar
        Add support for our menu bar system (this interacts badly with
        dynamic locale switching currently).

    --enable-rxvt-scroll
        Add support for the original rxvt scrollbar.

    --enable-next-scroll
        Add support for a NeXT-like scrollbar.

    --enable-xterm-scroll
        Add support for an Xterm-like scrollbar.

    --enable-plain-scroll
        Add support for a very unobtrusive, plain-looking scrollbar that is
        the favourite of the rxvt-unicode author, having used it for many
        years.

    --enable-half-shadow
        Make shadows on the scrollbar only half the normal width & height.
        only applicable to rxvt scrollbars.

    --enable-ttygid
        Change tty device setting to group "tty" - only use this if your
        system uses this type of security.

    --disable-backspace-key
        Disable any handling of the backspace key by us - let the X server
        do it.

    --disable-delete-key
        Disable any handling of the delete key by us - let the X server do
        it.

    --disable-resources
        Remove all resources checking.

    --enable-xgetdefault
        Make resources checking via XGetDefault() instead of our small
        version which only checks ~/.Xdefaults, or if that doesn't exist
        then ~/.Xresources.

    --enable-strings
        Add support for our possibly faster memset() function and other
        various routines, overriding your system's versions which may have
        been hand-crafted in assembly or may require extra libraries to link
        in. (this breaks ANSI-C rules and has problems on many GNU/Linux
        systems).

    --disable-swapscreen
        Remove support for swap screen.

    --enable-frills
        Add support for many small features that are not essential but nice
        to have. Normally you want this, but for very small binaries you may
        want to disable this.

    --enable-linespace
        Add support to provide user specified line spacing between text
        rows.

    --enable-keepscrolling
        Add support for continual scrolling of the display when you hold the
        mouse button down on a scrollbar arrow.

    --enable-mousewheel
        Add support for scrolling via mouse wheel or buttons 4 & 5.

    --enable-slipwheeling
        Add support for continual scrolling (using the mouse wheel as an
        accelerator) while the control key is held down. This option
        requires --enable-mousewheel to also be specified.

    --disable-new-selection
        Remove support for mouse selection style like that of xterm.

    --enable-dmalloc
        Use Gray Watson's malloc - which is good for debugging See
        http://www.letters.com/dmalloc/ for details If you use either this
        or the next option, you may need to edit src/Makefile after
        compiling to point DINCLUDE and DLIB to the right places.

        You can only use either this option and the following (should you
        use either) .

    --enable-dlmalloc
        Use Doug Lea's malloc - which is good for a production version See
        <http://g.oswego.edu/dl/html/malloc.html> for details.

    --enable-smart-resize
        Add smart growth/shrink behaviour when changing font size via from
        hot keys. This should keep in a fixed position the rxvt corner which
        is closest to a corner of the screen.

    --enable-256-color
        Add support for 256 colours rather than the base 16 colours.

        This option will likely go away in the future. Speak up if you don't
        want this.

    --enable-cursor-blink
        Add support for a blinking cursor.

    --enable-pointer-blank
        Add support to have the pointer disappear when typing or inactive.

    --with-name=NAME
        Set the basename for the installed binaries (default: urxvt,
        resulting in urxvt, urxvtd etc.). Specify --with-name=rxvt to
        replace rxvt.

    --with-term=NAME
        Change the environmental variable for the terminal to NAME (default
        "rxvt")

    --with-terminfo=PATH
        Change the environmental variable for the path to the terminfo tree
        to PATH.

    --with-x
        Use the X Window System (pretty much default, eh?).

    --with-xpm-includes=DIR
        Look for the XPM includes in DIR.

    --with-xpm-library=DIR
        Look for the XPM library in DIR.

    --with-xpm
        Not needed - define via --enable-xpm-background.

Revision:	1.16
Committed:	Sat Aug 14 03:07:50 2004 UTC (19 years, 9 months ago) by root
Branch:	MAIN
CVS Tags:	rel-3_6
Changes since 1.14:	+231 -171 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	root	1.16	CONFIGURE OPTIONS
2			General hint: if you get compile errors, then likely your configuration
3			hasn't been tested well. Either try with --enable-everything or use the
4			./reconf script as a base for experiments. ./reconf is used by myself,
5			so it should generally be a working config. Of course, you should always
6			report when a combination doesn't work, so it can be fixed. Marc Lehmann
7			<rxvt@schmorp.de>.
8
9			--enable-everything
10			Add support for all non-multichoice options listed in "./configure
11			--help". Note that unlike other enable options this is order
12			dependant. You can specify this and then disable options which this
13			enables by following this with the appropriate commands.
14
15			--enable-xft
16			Add support for Xft (anti-aliases, among others) fonts. Xft fonts
17			are slower and require lots of memory, but as long as you don't use
18			them, you don't pay for them.
19
20			--with-codesets=NAME,...
21			Compile in support for additional codeset groups:
22
23			all all of the above
24			cn common chinese encodings
25			cn_ext rarely used but very big chinese encodigs
26			jp common japanese encodings
27			jp_ext rarely used but big japanese encodings
28			kr korean encodings
29
30			--enable-xim
31			Add support for XIM (X Input Method) protocol. This allows using
32			alternative input methods (e.g. kinput2) and will also correctly set
33			up the input for people using dead keys or compose keys.
34
35			--enable-unicode3
36			Enable direct support for displaying unicode codepoints above 65535
37			(the basic multilingual page). This increases storage requirements
38			per character from 2 to 4 bytes. X11 fonts do not yet support these
39	pcg	1.10	extra characters, but Xft does.
40	root	1.16
41			Please note that rxvt-unicode can store unicode code points >65535
42			even without this flag, but the number of such characters is limited
43			to a view thousand (shared with combining characters, see next
44			switch), and right now rxvt-unicode cannot display them
45			(input/output and cut&paste still work, though).
46
47			--enable-combining
48			Enable automatic composition of combining characters into composite
49			characters. This is required for proper viewing of text where
50			accents are encoded as seperate unicode characters. This is done by
51			using precomposited characters when available or creating new
52			pseudo-characters when no precomposed form exists.
53
54			Without --enable-unicode3, the number of additional precomposed
55			characters is rather limited (2048, if this is full, rxvt will use
56			the private use area, extending the number of combinations to 8448).
57			With --enable-unicode3, no practical limit exists. This will also
58			enable storage of characters >65535.
59
60	pcg	1.10	The combining table also contains entries for arabic presentation
61	root	1.16	forms, but these are not currently used. Bug me if you want these to
62			be used.
63
64			--enable-fallback(=CLASS)
65			When reading resource settings, also read settings for class CLASS
66			(default: Rxvt). To disable resource fallback use
67			--disable-fallback.
68
69			--with-res-name=NAME
70			Use the given name (default: urxvt) as default application name when
71			reading resources. Specify --with-res-name=rxvt to replace rxvt.
72
73			--with-res-class=CLASS
74			Use the given class (default: URxvt) as default application class
75			when reading resources. Specify --with-res-class=Rxvt to replace
76	pcg	1.8	rxvt.
77	root	1.16
78			--enable-utmp
79			Write user and tty to utmp file (used by programs like w) at start
80			of rxvt execution and delete information when rxvt exits.
81
82			--enable-wtmp
83			Write user and tty to wtmp file (used by programs like last) at
84			start of rxvt execution and write logout when rxvt exits. This
85			option requires --enable-utmp to also be specified.
86
87			--enable-lastlog
88			Write user and tty to lastlog file (used by programs like lastlogin)
89			at start of rxvt execution. This option requires --enable-utmp to
90			also be specified.
91
92			--enable-xpm-background
93			Add support for XPM background pixmaps.
94
95			--enable-transparency
96			Add support for inheriting parent backgrounds thus giving a fake
97			transparency to the term.
98
99			--enable-fading
100			Add support for fading the text when focus is lost.
101
102			--enable-tinting
103			Add support for tinting of transparent backgrounds.
104
105			--enable-menubar
106			Add support for our menu bar system (this interacts badly with
107			dynamic locale switching currently).
108
109			--enable-rxvt-scroll
110			Add support for the original rxvt scrollbar.
111
112			--enable-next-scroll
113			Add support for a NeXT-like scrollbar.
114
115			--enable-xterm-scroll
116			Add support for an Xterm-like scrollbar.
117
118			--enable-plain-scroll
119			Add support for a very unobtrusive, plain-looking scrollbar that is
120			the favourite of the rxvt-unicode author, having used it for many
121			years.
122
123			--enable-half-shadow
124			Make shadows on the scrollbar only half the normal width & height.
125			only applicable to rxvt scrollbars.
126
127			--enable-ttygid
128			Change tty device setting to group "tty" - only use this if your
129			system uses this type of security.
130
131			--disable-backspace-key
132			Disable any handling of the backspace key by us - let the X server
133			do it.
134
135			--disable-delete-key
136			Disable any handling of the delete key by us - let the X server do
137			it.
138
139			--disable-resources
140			Remove all resources checking.
141
142			--enable-xgetdefault
143			Make resources checking via XGetDefault() instead of our small
144			version which only checks ~/.Xdefaults, or if that doesn't exist
145			then ~/.Xresources.
146
147			--enable-strings
148			Add support for our possibly faster memset() function and other
149			various routines, overriding your system's versions which may have
150			been hand-crafted in assembly or may require extra libraries to link
151			in. (this breaks ANSI-C rules and has problems on many GNU/Linux
152			systems).
153
154			--disable-swapscreen
155			Remove support for swap screen.
156
157			--enable-frills
158			Add support for many small features that are not essential but nice
159			to have. Normally you want this, but for very small binaries you may
160			want to disable this.
161
162			--enable-linespace
163			Add support to provide user specified line spacing between text
164			rows.
165
166			--enable-keepscrolling
167			Add support for continual scrolling of the display when you hold the
168			mouse button down on a scrollbar arrow.
169
170			--enable-mousewheel
171			Add support for scrolling via mouse wheel or buttons 4 & 5.
172
173			--enable-slipwheeling
174			Add support for continual scrolling (using the mouse wheel as an
175			accelerator) while the control key is held down. This option
176			requires --enable-mousewheel to also be specified.
177
178			--disable-new-selection
179			Remove support for mouse selection style like that of xterm.
180
181			--enable-dmalloc
182			Use Gray Watson's malloc - which is good for debugging See
183			http://www.letters.com/dmalloc/ for details If you use either this
184			or the next option, you may need to edit src/Makefile after
185			compiling to point DINCLUDE and DLIB to the right places.
186
187			You can only use either this option and the following (should you
188			use either) .
189
190			--enable-dlmalloc
191			Use Doug Lea's malloc - which is good for a production version See
192			<http://g.oswego.edu/dl/html/malloc.html> for details.
193
194			--enable-smart-resize
195			Add smart growth/shrink behaviour when changing font size via from
196			hot keys. This should keep in a fixed position the rxvt corner which
197			is closest to a corner of the screen.
198
199			--enable-256-color
200			Add support for 256 colours rather than the base 16 colours.
201
202			This option will likely go away in the future. Speak up if you don't
203			want this.
204
205			--enable-cursor-blink
206			Add support for a blinking cursor.
207
208			--enable-pointer-blank
209			Add support to have the pointer disappear when typing or inactive.
210
211			--with-name=NAME
212			Set the basename for the installed binaries (default: urxvt,
213			resulting in urxvt, urxvtd etc.). Specify --with-name=rxvt to
214			replace rxvt.
215
216			--with-term=NAME
217			Change the environmental variable for the terminal to NAME (default
218			"rxvt")
219
220			--with-terminfo=PATH
221			Change the environmental variable for the path to the terminfo tree
222			to PATH.
223
224			--with-x
225			Use the X Window System (pretty much default, eh?).
226
227			--with-xpm-includes=DIR
228			Look for the XPM includes in DIR.
229
230			--with-xpm-library=DIR
231			Look for the XPM library in DIR.
232
233			--with-xpm
234			Not needed - define via --enable-xpm-background.
235	pcg	1.7