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 default configuration (i.e. no "--enable-xxx" or "--disable-xxx"
    switches). 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", except for "--enable-assert" and
        "--enable-256-color".

        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: on)
        Add support for Xft (anti-aliased, 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=CS,... (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 encodings 
   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)
        Recommended to stay off unless you really need non-BMP characters.

        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 few 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 separate unicode characters. This is done by
        using precomposed characters when available or creating new
        pseudo-characters when no precomposed form exists.

        Without --enable-unicode3, the number of additional precomposed
        characters is somewhat limited (the 6400 private use characters will
        be (ab-)used). 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-afterimage (default: on)
        Add support for libAfterImage to be used for background images. It
        adds support for many file formats including JPG, PNG, SVG, TIFF,
        GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
        (<http://www.afterstep.org/visualdoc.php?show=asimagexml>).

        Note that with this option enabled, rxvt's memory footprint might
        increase by a few megabytes even if no extra features are used
        (mostly due to third-party libraries used by libAI). Memory
        footprint may somewhat be lowered if libAfterImage is configured
        without support for SVG.

    --enable-pixbuf (default: on)
        Add support for GDK-PixBuf to be used for background images. It adds
        support for many file formats including JPG, PNG, TIFF, GIF, XPM,
        BMP, ICO and TGA.

    --enable-startup-notification (default: on)
        Add support for freedesktop startup notifications. This allows
        window managers to display some kind of progress indicator during
        startup.

    --enable-transparency (default: on)
        Add support for using the root pixmap as background to simulate
        transparency. Note that blur and blend effects depend on
        libAfterImage or on libXrender and on the availability of the RENDER
        extension in the X server.

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

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

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

    --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)
          urgency hint
          separate underline colour (-underlineColor)
          settable border widths and borderless switch (-w, -b, -bl)
          visual depth selection (-depth)
          settable extra linespacing (-lsp)
          iso-14755 5.1 (basic) support
          tripleclickwords (-tcw)
          settable insecure mode (-insecure)
          keysym remapping support
          cursor blinking and underline cursor (-bc, -uc)
          XEmbed support (-embed)
          user-pty (-pty-fd)
          hold on exit (-hold)
          compile in built-in block graphics
          skip builtin block graphics (-sbg)
          separate highlight colour (-highlightColor, -highlightTextColor)
          extended mouse reporting modes (1005 and 1015).

        It also enables some non-essential features otherwise disabled, such
        as:

          some round-trip time optimisations
          nearest colour allocation on pseudocolor screens
          UTF8_STRING support for selection
          sgr modes 90..97 and 100..107
          backindex and forwardindex escape sequences
          view change/zero scrollback escape sequences
          locale switching escape sequence
          window op and some xterm/OSC escape sequences
          rectangular selections
          trailing space removal for selections
          verbose X error handling

    --enable-iso14755 (default: on)
        Enable extended ISO 14755 support (see rxvt(1)). 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-selectionscrolling (default: on)
        Add support for scrolling when the selection moves to the top or
        bottom of the screen.

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

    --enable-smart-resize (default: off)
        Add smart growth/shrink behaviour when resizing. This should keep
        the window corner which is closest to a corner of the screen in a
        fixed position.

    --enable-text-blink (default: on)
        Add support for blinking text.

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

    --enable-perl (default: on)
        Enable an embedded perl interpreter. See the rxvtperl(3) manpage for
        more info on this feature, or the files in src/perl/ 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. Even when compiled in, perl will *not* be
        initialised when all extensions have been disabled "-pe ""
        --perl-ext-common """, so it should be safe to enable from a
        resource standpoint.

    --enable-assert (default: off)
        Enables the assertions in the code, normally disabled. This switch
        is only useful when developing rxvt-unicode.

    --enable-256-color (default: off)
        Force use of so-called 256 colour mode, to work around buggy
        applications that do not support termcap/terminfo, or simply improve
        support for applications hardcoding the xterm 256 colour table.

        This switch breaks termcap/terminfo compatibility to
        "TERM=rxvt-unicode", and consequently sets "TERM" to
        "rxvt-unicode-256color" by default (doc/etc/ contains
        termcap/terminfo definitions for both).

        It also results in higher memory usage and can slow down rxvt
        dramatically when more than six fonts are in use by a terminal
        instance.

    --with-afterimage-config=DIR
        Look for the libAfterImage config script in DIR.

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

Revision:	1.73
Committed:	Sat Nov 19 11:00:20 2011 UTC (12 years, 6 months ago) by sf-exg
Branch:	MAIN
Changes since 1.72:	+5 -0 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	root	1.57	the default configuration (i.e. no "--enable-xxx" or "--disable-xxx"
5			switches). Of course, you should always report when a combination
6			doesn't work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
7	root	1.29
8			All
9	root	1.16
10			--enable-everything
11	root	1.29	Add (or remove) support for all non-multichoice options listed in
12	sf-exg	1.66	"./configure --help", except for "--enable-assert" and
13			"--enable-256-color".
14	root	1.29
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	sf-exg	1.71	--enable-xft (default: on)
22	root	1.70	Add support for Xft (anti-aliased, among others) fonts. Xft fonts
23	root	1.16	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	sf-exg	1.71	--with-codesets=CS,... (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.61	all all available codeset groups
41			zh common chinese encodings
42			zh_ext rarely used but very big chinese encodings
43			jp common japanese encodings
44			jp_ext rarely used but big japanese encodings
45			kr korean encodings
46	root	1.29	--enable-xim (default: on)
47	root	1.16	Add support for XIM (X Input Method) protocol. This allows using
48			alternative input methods (e.g. kinput2) and will also correctly set
49			up the input for people using dead keys or compose keys.
50
51	root	1.29	--enable-unicode3 (default: off)
52	root	1.44	Recommended to stay off unless you really need non-BMP characters.
53
54	root	1.16	Enable direct support for displaying unicode codepoints above 65535
55			(the basic multilingual page). This increases storage requirements
56			per character from 2 to 4 bytes. X11 fonts do not yet support these
57	pcg	1.10	extra characters, but Xft does.
58	root	1.16
59			Please note that rxvt-unicode can store unicode code points >65535
60			even without this flag, but the number of such characters is limited
61	root	1.55	to a few thousand (shared with combining characters, see next
62	root	1.16	switch), and right now rxvt-unicode cannot display them
63			(input/output and cut&paste still work, though).
64
65	root	1.29	--enable-combining (default: on)
66	root	1.16	Enable automatic composition of combining characters into composite
67			characters. This is required for proper viewing of text where
68	root	1.65	accents are encoded as separate unicode characters. This is done by
69	sf-exg	1.71	using precomposed characters when available or creating new
70	root	1.16	pseudo-characters when no precomposed form exists.
71
72			Without --enable-unicode3, the number of additional precomposed
73	root	1.44	characters is somewhat limited (the 6400 private use characters will
74			be (ab-)used). With --enable-unicode3, no practical limit exists.
75	root	1.24
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	sf-exg	1.71	--enable-fallback[=CLASS] (default: Rxvt)
84	root	1.29	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	root	1.60	--with-res-class=CLASS (default: URxvt)
92	root	1.29	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.56	--enable-afterimage (default: on)
110	root	1.67	Add support for libAfterImage to be used for background images. It
111			adds support for many file formats including JPG, PNG, SVG, TIFF,
112			GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
113	root	1.56	(<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
114
115	root	1.72	Note that with this option enabled, rxvt's memory footprint might
116	root	1.56	increase by a few megabytes even if no extra features are used
117			(mostly due to third-party libraries used by libAI). Memory
118			footprint may somewhat be lowered if libAfterImage is configured
119			without support for SVG.
120
121	sf-exg	1.71	--enable-pixbuf (default: on)
122	root	1.67	Add support for GDK-PixBuf to be used for background images. It adds
123			support for many file formats including JPG, PNG, TIFF, GIF, XPM,
124			BMP, ICO and TGA.
125
126	sf-exg	1.73	--enable-startup-notification (default: on)
127			Add support for freedesktop startup notifications. This allows
128			window managers to display some kind of progress indicator during
129			startup.
130
131	root	1.38	--enable-transparency (default: on)
132	root	1.68	Add support for using the root pixmap as background to simulate
133	root	1.69	transparency. Note that blur and blend effects depend on
134	root	1.68	libAfterImage or on libXrender and on the availability of the RENDER
135			extension in the X server.
136	root	1.16
137	root	1.29	--enable-fading (default: on)
138	root	1.56	Add support for fading the text when focus is lost.
139	root	1.29
140			--enable-rxvt-scroll (default: on)
141	root	1.16	Add support for the original rxvt scrollbar.
142
143	root	1.29	--enable-next-scroll (default: on)
144	root	1.16	Add support for a NeXT-like scrollbar.
145
146	root	1.29	--enable-xterm-scroll (default: on)
147	root	1.16	Add support for an Xterm-like scrollbar.
148
149			--disable-backspace-key
150	root	1.29	Removes any handling of the backspace key by us - let the X server
151	root	1.16	do it.
152
153			--disable-delete-key
154	root	1.29	Removes any handling of the delete key by us - let the X server do
155	root	1.16	it.
156
157			--disable-resources
158	root	1.29	Removes any support for resource checking.
159	root	1.16
160			--disable-swapscreen
161	root	1.29	Remove support for secondary/swap screen.
162	root	1.16
163	root	1.29	--enable-frills (default: on)
164	root	1.16	Add support for many small features that are not essential but nice
165			to have. Normally you want this, but for very small binaries you may
166			want to disable this.
167
168	root	1.21	A non-exhaustive list of features enabled by "--enable-frills"
169			(possibly in combination with other switches) is:
170
171			MWM-hints
172	root	1.26	EWMH-hints (pid, utf8 names) and protocols (ping)
173	ayin	1.53	urgency hint
174	root	1.65	separate underline colour (-underlineColor)
175	root	1.36	settable border widths and borderless switch (-w, -b, -bl)
176	root	1.46	visual depth selection (-depth)
177	sf-exg	1.66	settable extra linespacing (-lsp)
178	root	1.54	iso-14755 5.1 (basic) support
179	root	1.36	tripleclickwords (-tcw)
180			settable insecure mode (-insecure)
181	root	1.23	keysym remapping support
182	root	1.64	cursor blinking and underline cursor (-bc, -uc)
183	root	1.36	XEmbed support (-embed)
184			user-pty (-pty-fd)
185			hold on exit (-hold)
186	root	1.59	compile in built-in block graphics
187	root	1.36	skip builtin block graphics (-sbg)
188	sf-exg	1.66	separate highlight colour (-highlightColor, -highlightTextColor)
189	root	1.69	extended mouse reporting modes (1005 and 1015).
190	root	1.46
191	root	1.48	It also enables some non-essential features otherwise disabled, such
192	root	1.46	as:
193
194			some round-trip time optimisations
195	sf-exg	1.66	nearest colour allocation on pseudocolor screens
196	ayin	1.52	UTF8_STRING support for selection
197	root	1.36	sgr modes 90..97 and 100..107
198	root	1.46	backindex and forwardindex escape sequences
199	ayin	1.52	view change/zero scrollback escape sequences
200	root	1.46	locale switching escape sequence
201			window op and some xterm/OSC escape sequences
202			rectangular selections
203			trailing space removal for selections
204			verbose X error handling
205	root	1.21
206	root	1.29	--enable-iso14755 (default: on)
207	root	1.72	Enable extended ISO 14755 support (see rxvt(1)). Basic support
208	root	1.63	(section 5.1) is enabled by "--enable-frills", while support for
209			5.2, 5.3 and 5.4 is enabled with this switch.
210	root	1.17
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.56	--enable-selectionscrolling (default: on)
216			Add support for scrolling when the selection moves to the top or
217			bottom of the screen.
218
219	root	1.29	--enable-mousewheel (default: on)
220	root	1.16	Add support for scrolling via mouse wheel or buttons 4 & 5.
221
222	root	1.29	--enable-slipwheeling (default: on)
223	root	1.16	Add support for continual scrolling (using the mouse wheel as an
224			accelerator) while the control key is held down. This option
225			requires --enable-mousewheel to also be specified.
226
227	root	1.56	--enable-smart-resize (default: off)
228			Add smart growth/shrink behaviour when resizing. This should keep
229			the window corner which is closest to a corner of the screen in a
230			fixed position.
231	root	1.16
232	root	1.60	--enable-text-blink (default: on)
233			Add support for blinking text.
234
235	root	1.29	--enable-pointer-blank (default: on)
236	root	1.16	Add support to have the pointer disappear when typing or inactive.
237
238	root	1.44	--enable-perl (default: on)
239	root	1.72	Enable an embedded perl interpreter. See the rxvtperl(3) manpage for
240			more info on this feature, or the files in src/perl/ for the
241	root	1.63	extensions that are installed by default. The perl interpreter that
242			is used can be specified via the "PERL" environment variable when
243			running configure. Even when compiled in, perl will not be
244			initialised when all extensions have been disabled "-pe ""
245			--perl-ext-common """, so it should be safe to enable from a
246			resource standpoint.
247	root	1.35
248	root	1.64	--enable-assert (default: off)
249			Enables the assertions in the code, normally disabled. This switch
250			is only useful when developing rxvt-unicode.
251
252	sf-exg	1.66	--enable-256-color (default: off)
253			Force use of so-called 256 colour mode, to work around buggy
254			applications that do not support termcap/terminfo, or simply improve
255			support for applications hardcoding the xterm 256 colour table.
256
257			This switch breaks termcap/terminfo compatibility to
258			"TERM=rxvt-unicode", and consequently sets "TERM" to
259			"rxvt-unicode-256color" by default (doc/etc/ contains
260			termcap/terminfo definitions for both).
261
262	root	1.72	It also results in higher memory usage and can slow down rxvt
263	sf-exg	1.66	dramatically when more than six fonts are in use by a terminal
264			instance.
265
266	root	1.56	--with-afterimage-config=DIR
267			Look for the libAfterImage config script in DIR.
268
269	root	1.29	--with-name=NAME (default: urxvt)
270			Set the basename for the installed binaries, resulting in "urxvt",
271			"urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
272
273			--with-term=NAME (default: rxvt-unicode)
274			Change the environmental variable for the terminal to NAME.
275	root	1.16
276			--with-terminfo=PATH
277			Change the environmental variable for the path to the terminfo tree
278			to PATH.
279
280			--with-x
281			Use the X Window System (pretty much default, eh?).
282