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>.

    All

    --enable-everything
        Add (or remove) support for all non-multichoice options listed in
        "./configure --help".

        You can specify this and then disable options you do not like by
        *following* this with the appropriate "--disable-..." arguments, or
        you can start with a minimal configuration by specifying
        "--disable-everything" and than adding just the "--enable-..."
        arguments you want.

    --enable-xft (default: enabled)
        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.

    --enable-font-styles (default: on)
        Add support for bold, *italic* and *bold italic* font styles. The
        fonts can be set manually or automatically.

    --with-codesets=NAME,... (default: all)
        Compile in support for additional codeset (encoding) groups ("eu",
        "vn" are always compiled in, which includes most 8-bit character
        sets). These codeset tables are used for driving X11 core fonts,
        they are not required for Xft fonts, although having them compiled
        in lets rxvt-unicode choose replacement fonts more intelligently.
        Compiling them in will make your binary bigger (all of together cost
        about 700kB), but it doesn't increase memory usage unless you use a
        font requiring one of these encodings.

           all             all available codeset groups 
           zh              common chinese encodings 
           zh_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 (default: on)
        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 (default: off)
        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 (default: on)
        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-unicode
        will use the private use area, extending the number of combinations
        to 8448). With --enable-unicode3, no practical limit exists.

        This option will also enable storage (but not display) of characters
        beyond plane 0 (>65535) when --enable-unicode3 was not specified.

        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 (and tell me how these are to be used...).

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

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

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

    --enable-utmp (default: on)
        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 (default: on)
        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 (default: on)
        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 (default: off)
        Add support for XPM background pixmaps.

    --enable-transparency (default: off)
        Add support for inheriting parent backgrounds thus giving a fake
        transparency to the term.

    --enable-fading (default: on)
        Add support for fading the text when focus is lost (requires
        "--enable-transparency").

    --enable-tinting (default: on)
        Add support for tinting of transparent backgrounds (requires
        "--enable-transparency").

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

    --enable-rxvt-scroll (default: on)
        Add support for the original rxvt scrollbar.

    --enable-next-scroll (default: on)
        Add support for a NeXT-like scrollbar.

    --enable-xterm-scroll (default: on)
        Add support for an Xterm-like scrollbar.

    --enable-plain-scroll (default: on)
        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 (default: off)
        Make shadows on the scrollbar only half the normal width & height.
        only applicable to rxvt scrollbars.

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

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

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

    --disable-resources
        Removes any support for resource 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.

        Please note that nowadays, things like XIM will automatically pull
        in and use the full X resource manager, so the overhead of using it
        might be very small, if nonexistant.

    --enable-strings (default: off)
        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 secondary/swap screen.

    --enable-frills (default: on)
        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.

        A non-exhaustive list of features enabled by "--enable-frills"
        (possibly in combination with other switches) is:

          MWM-hints
          EWMH-hints (pid, utf8 names) and protocols (ping)
          seperate underline colour (-underlineColor)
          settable border widths and borderless switch (-w, -b, -bl)
          settable extra linespacing /-lsp)
          iso-14755-2 and -3, and visual feedback
          backindex and forwardindex escape sequence
          window op and some xterm/OSC escape sequences
          tripleclickwords (-tcw)
          settable insecure mode (-insecure)
          keysym remapping support
          cursor blinking and underline cursor (-cb, -uc)
          XEmbed support (-embed)
          user-pty (-pty-fd)
          hold on exit (-hold)
          skip builtin block graphics (-sbg)
          sgr modes 90..97 and 100..107

    --enable-iso14755 (default: on)
        Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt).
        Basic support (section 5.1) is enabled by "--enable-frills", while
        support for 5.2, 5.3 and 5.4 is enabled with this switch.

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

    --enable-mousewheel (default: on)
        Add support for scrolling via mouse wheel or buttons 4 & 5.

    --enable-slipwheeling (default: on)
        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 (default: off)
        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 (default: off)
        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 (default: on)
        Add smart growth/shrink behaviour when changing font size via hot
        keys. This should keep the window corner which is closest to a
        corner of the screen in a fixed position.

    --enable-pointer-blank (default: on)
        Add support to have the pointer disappear when typing or inactive.

    --enable-perl (default: off)
        Enable an embedded perl interpreter. See the rxvtperl(3) manpage
        (doc/rxvtperl.txt) for more info on this feature, or the files in
        src/perl-ext/ for the extensions that are installed by default. The
        perl interpreter that is used can be specified via the "PERL"
        environment variable when running configure.

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

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

    --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.37
Committed:	Wed Jan 4 21:50:12 2006 UTC (18 years, 5 months ago) by root
Branch:	MAIN
CVS Tags:	rel-6_3
Changes since 1.36:	+3 -1 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	root	1.29	hasn't been tested well. Either try with "--enable-everything" or use
4			the ./reconf script as a base for experiments. ./reconf is used by
5			myself, so it should generally be a working config. Of course, you
6			should always report when a combination doesn't work, so it can be
7			fixed. Marc Lehmann <rxvt@schmorp.de>.
8
9			All
10	root	1.16
11			--enable-everything
12	root	1.29	Add (or remove) support for all non-multichoice options listed in
13			"./configure --help".
14
15			You can specify this and then disable options you do not like by
16			following this with the appropriate "--disable-..." arguments, or
17			you can start with a minimal configuration by specifying
18			"--disable-everything" and than adding just the "--enable-..."
19			arguments you want.
20	root	1.16
21	root	1.29	--enable-xft (default: enabled)
22	root	1.16	Add support for Xft (anti-aliases, among others) fonts. Xft fonts
23			are slower and require lots of memory, but as long as you don't use
24			them, you don't pay for them.
25
26	root	1.29	--enable-font-styles (default: on)
27	root	1.20	Add support for bold, italic and bold italic font styles. The
28			fonts can be set manually or automatically.
29
30	root	1.29	--with-codesets=NAME,... (default: all)
31	root	1.28	Compile in support for additional codeset (encoding) groups ("eu",
32			"vn" are always compiled in, which includes most 8-bit character
33			sets). These codeset tables are used for driving X11 core fonts,
34			they are not required for Xft fonts, although having them compiled
35			in lets rxvt-unicode choose replacement fonts more intelligently.
36			Compiling them in will make your binary bigger (all of together cost
37			about 700kB), but it doesn't increase memory usage unless you use a
38			font requiring one of these encodings.
39	root	1.16
40	root	1.18	all all available codeset groups
41	root	1.20	zh common chinese encodings
42			zh_ext rarely used but very big chinese encodigs
43	root	1.16	jp common japanese encodings
44			jp_ext rarely used but big japanese encodings
45			kr korean encodings
46
47	root	1.29	--enable-xim (default: on)
48	root	1.16	Add support for XIM (X Input Method) protocol. This allows using
49			alternative input methods (e.g. kinput2) and will also correctly set
50			up the input for people using dead keys or compose keys.
51
52	root	1.29	--enable-unicode3 (default: off)
53	root	1.16	Enable direct support for displaying unicode codepoints above 65535
54			(the basic multilingual page). This increases storage requirements
55			per character from 2 to 4 bytes. X11 fonts do not yet support these
56	pcg	1.10	extra characters, but Xft does.
57	root	1.16
58			Please note that rxvt-unicode can store unicode code points >65535
59			even without this flag, but the number of such characters is limited
60			to a view thousand (shared with combining characters, see next
61			switch), and right now rxvt-unicode cannot display them
62			(input/output and cut&paste still work, though).
63
64	root	1.29	--enable-combining (default: on)
65	root	1.16	Enable automatic composition of combining characters into composite
66			characters. This is required for proper viewing of text where
67			accents are encoded as seperate unicode characters. This is done by
68			using precomposited characters when available or creating new
69			pseudo-characters when no precomposed form exists.
70
71			Without --enable-unicode3, the number of additional precomposed
72	root	1.24	characters is rather limited (2048, if this is full, rxvt-unicode
73			will use the private use area, extending the number of combinations
74			to 8448). With --enable-unicode3, no practical limit exists.
75
76			This option will also enable storage (but not display) of characters
77			beyond plane 0 (>65535) when --enable-unicode3 was not specified.
78	root	1.16
79	pcg	1.10	The combining table also contains entries for arabic presentation
80	root	1.16	forms, but these are not currently used. Bug me if you want these to
81	root	1.24	be used (and tell me how these are to be used...).
82	root	1.16
83	root	1.29	--enable-fallback(=CLASS) (default: Rxvt)
84			When reading resource settings, also read settings for class CLASS.
85			To disable resource fallback use --disable-fallback.
86
87			--with-res-name=NAME (default: urxvt)
88			Use the given name as default application name when reading
89			resources. Specify --with-res-name=rxvt to replace rxvt.
90
91			--with-res-class=CLASS /default: URxvt)
92			Use the given class as default application class when reading
93			resources. Specify --with-res-class=Rxvt to replace rxvt.
94	root	1.16
95	root	1.29	--enable-utmp (default: on)
96	root	1.16	Write user and tty to utmp file (used by programs like w) at start
97			of rxvt execution and delete information when rxvt exits.
98
99	root	1.29	--enable-wtmp (default: on)
100	root	1.16	Write user and tty to wtmp file (used by programs like last) at
101			start of rxvt execution and write logout when rxvt exits. This
102			option requires --enable-utmp to also be specified.
103
104	root	1.29	--enable-lastlog (default: on)
105	root	1.16	Write user and tty to lastlog file (used by programs like lastlogin)
106			at start of rxvt execution. This option requires --enable-utmp to
107			also be specified.
108
109	root	1.29	--enable-xpm-background (default: off)
110	root	1.16	Add support for XPM background pixmaps.
111
112	root	1.29	--enable-transparency (default: off)
113	root	1.16	Add support for inheriting parent backgrounds thus giving a fake
114			transparency to the term.
115
116	root	1.29	--enable-fading (default: on)
117			Add support for fading the text when focus is lost (requires
118			"--enable-transparency").
119
120			--enable-tinting (default: on)
121			Add support for tinting of transparent backgrounds (requires
122			"--enable-transparency").
123	root	1.16
124	root	1.29	--enable-menubar (default: off)
125	root	1.16	Add support for our menu bar system (this interacts badly with
126			dynamic locale switching currently).
127
128	root	1.29	--enable-rxvt-scroll (default: on)
129	root	1.16	Add support for the original rxvt scrollbar.
130
131	root	1.29	--enable-next-scroll (default: on)
132	root	1.16	Add support for a NeXT-like scrollbar.
133
134	root	1.29	--enable-xterm-scroll (default: on)
135	root	1.16	Add support for an Xterm-like scrollbar.
136
137	root	1.29	--enable-plain-scroll (default: on)
138	root	1.16	Add support for a very unobtrusive, plain-looking scrollbar that is
139			the favourite of the rxvt-unicode author, having used it for many
140			years.
141
142	root	1.29	--enable-half-shadow (default: off)
143	root	1.16	Make shadows on the scrollbar only half the normal width & height.
144			only applicable to rxvt scrollbars.
145
146	root	1.29	--enable-ttygid (default: off)
147	root	1.16	Change tty device setting to group "tty" - only use this if your
148			system uses this type of security.
149
150			--disable-backspace-key
151	root	1.29	Removes any handling of the backspace key by us - let the X server
152	root	1.16	do it.
153
154			--disable-delete-key
155	root	1.29	Removes any handling of the delete key by us - let the X server do
156	root	1.16	it.
157
158			--disable-resources
159	root	1.29	Removes any support for resource checking.
160	root	1.16
161			--enable-xgetdefault
162			Make resources checking via XGetDefault() instead of our small
163			version which only checks ~/.Xdefaults, or if that doesn't exist
164			then ~/.Xresources.
165
166	root	1.23	Please note that nowadays, things like XIM will automatically pull
167			in and use the full X resource manager, so the overhead of using it
168			might be very small, if nonexistant.
169
170	root	1.29	--enable-strings (default: off)
171	root	1.16	Add support for our possibly faster memset() function and other
172			various routines, overriding your system's versions which may have
173			been hand-crafted in assembly or may require extra libraries to link
174			in. (this breaks ANSI-C rules and has problems on many GNU/Linux
175			systems).
176
177			--disable-swapscreen
178	root	1.29	Remove support for secondary/swap screen.
179	root	1.16
180	root	1.29	--enable-frills (default: on)
181	root	1.16	Add support for many small features that are not essential but nice
182			to have. Normally you want this, but for very small binaries you may
183			want to disable this.
184
185	root	1.21	A non-exhaustive list of features enabled by "--enable-frills"
186			(possibly in combination with other switches) is:
187
188			MWM-hints
189	root	1.26	EWMH-hints (pid, utf8 names) and protocols (ping)
190	root	1.36	seperate underline colour (-underlineColor)
191			settable border widths and borderless switch (-w, -b, -bl)
192			settable extra linespacing /-lsp)
193	root	1.21	iso-14755-2 and -3, and visual feedback
194			backindex and forwardindex escape sequence
195	root	1.27	window op and some xterm/OSC escape sequences
196	root	1.36	tripleclickwords (-tcw)
197			settable insecure mode (-insecure)
198	root	1.23	keysym remapping support
199	root	1.36	cursor blinking and underline cursor (-cb, -uc)
200			XEmbed support (-embed)
201			user-pty (-pty-fd)
202			hold on exit (-hold)
203			skip builtin block graphics (-sbg)
204			sgr modes 90..97 and 100..107
205	root	1.21
206	root	1.29	--enable-iso14755 (default: on)
207	root	1.34	Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt).
208	root	1.17	Basic support (section 5.1) is enabled by "--enable-frills", while
209			support for 5.2, 5.3 and 5.4 is enabled with this switch.
210
211	root	1.29	--enable-keepscrolling (default: on)
212	root	1.16	Add support for continual scrolling of the display when you hold the
213			mouse button down on a scrollbar arrow.
214
215	root	1.29	--enable-mousewheel (default: on)
216	root	1.16	Add support for scrolling via mouse wheel or buttons 4 & 5.
217
218	root	1.29	--enable-slipwheeling (default: on)
219	root	1.16	Add support for continual scrolling (using the mouse wheel as an
220			accelerator) while the control key is held down. This option
221			requires --enable-mousewheel to also be specified.
222
223			--disable-new-selection
224			Remove support for mouse selection style like that of xterm.
225
226	root	1.29	--enable-dmalloc (default: off)
227	root	1.16	Use Gray Watson's malloc - which is good for debugging See
228			http://www.letters.com/dmalloc/ for details If you use either this
229			or the next option, you may need to edit src/Makefile after
230			compiling to point DINCLUDE and DLIB to the right places.
231
232			You can only use either this option and the following (should you
233			use either) .
234
235	root	1.29	--enable-dlmalloc (default: off)
236	root	1.16	Use Doug Lea's malloc - which is good for a production version See
237			<http://g.oswego.edu/dl/html/malloc.html> for details.
238
239	root	1.29	--enable-smart-resize (default: on)
240	root	1.30	Add smart growth/shrink behaviour when changing font size via hot
241	root	1.31	keys. This should keep the window corner which is closest to a
242			corner of the screen in a fixed position.
243	root	1.16
244	root	1.29	--enable-pointer-blank (default: on)
245	root	1.16	Add support to have the pointer disappear when typing or inactive.
246
247	root	1.35	--enable-perl (default: off)
248			Enable an embedded perl interpreter. See the rxvtperl(3) manpage
249			(doc/rxvtperl.txt) for more info on this feature, or the files in
250	root	1.37	src/perl-ext/ for the extensions that are installed by default. The
251			perl interpreter that is used can be specified via the "PERL"
252			environment variable when running configure.
253	root	1.35
254	root	1.29	--with-name=NAME (default: urxvt)
255			Set the basename for the installed binaries, resulting in "urxvt",
256			"urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
257
258			--with-term=NAME (default: rxvt-unicode)
259			Change the environmental variable for the terminal to NAME.
260	root	1.16
261			--with-terminfo=PATH
262			Change the environmental variable for the path to the terminfo tree
263			to PATH.
264
265			--with-x
266			Use the X Window System (pretty much default, eh?).
267
268			--with-xpm-includes=DIR
269			Look for the XPM includes in DIR.
270
271			--with-xpm-library=DIR
272			Look for the XPM library in DIR.
273
274			--with-xpm
275			Not needed - define via --enable-xpm-background.
276	pcg	1.7