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-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 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-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.75
Committed:	Thu May 10 22:42:03 2012 UTC (12 years ago) by root
Branch:	MAIN
Changes since 1.74:	+2 -18 lines
Log Message:	improve 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	sf-exg	1.71	--enable-pixbuf (default: on)
110	root	1.67	Add support for GDK-PixBuf to be used for background images. It adds
111			support for many file formats including JPG, PNG, TIFF, GIF, XPM,
112			BMP, ICO and TGA.
113
114	sf-exg	1.73	--enable-startup-notification (default: on)
115			Add support for freedesktop startup notifications. This allows
116			window managers to display some kind of progress indicator during
117			startup.
118
119	root	1.38	--enable-transparency (default: on)
120	root	1.68	Add support for using the root pixmap as background to simulate
121	root	1.75	transparency. Note that blur and blend effects depend on libXrender
122			and on the availability of the RENDER extension in the X server.
123	root	1.16
124	root	1.29	--enable-fading (default: on)
125	root	1.56	Add support for fading the text when focus is lost.
126	root	1.29
127			--enable-rxvt-scroll (default: on)
128	root	1.16	Add support for the original rxvt scrollbar.
129
130	root	1.29	--enable-next-scroll (default: on)
131	root	1.16	Add support for a NeXT-like scrollbar.
132
133	root	1.29	--enable-xterm-scroll (default: on)
134	root	1.16	Add support for an Xterm-like scrollbar.
135
136			--disable-backspace-key
137	root	1.29	Removes any handling of the backspace key by us - let the X server
138	root	1.16	do it.
139
140			--disable-delete-key
141	root	1.29	Removes any handling of the delete key by us - let the X server do
142	root	1.16	it.
143
144			--disable-resources
145	root	1.29	Removes any support for resource checking.
146	root	1.16
147			--disable-swapscreen
148	root	1.29	Remove support for secondary/swap screen.
149	root	1.16
150	root	1.29	--enable-frills (default: on)
151	root	1.16	Add support for many small features that are not essential but nice
152			to have. Normally you want this, but for very small binaries you may
153			want to disable this.
154
155	root	1.21	A non-exhaustive list of features enabled by "--enable-frills"
156			(possibly in combination with other switches) is:
157
158			MWM-hints
159	root	1.26	EWMH-hints (pid, utf8 names) and protocols (ping)
160	ayin	1.53	urgency hint
161	root	1.65	separate underline colour (-underlineColor)
162	root	1.36	settable border widths and borderless switch (-w, -b, -bl)
163	root	1.46	visual depth selection (-depth)
164	sf-exg	1.66	settable extra linespacing (-lsp)
165	root	1.54	iso-14755 5.1 (basic) support
166	root	1.36	tripleclickwords (-tcw)
167			settable insecure mode (-insecure)
168	root	1.23	keysym remapping support
169	root	1.64	cursor blinking and underline cursor (-bc, -uc)
170	root	1.36	XEmbed support (-embed)
171			user-pty (-pty-fd)
172			hold on exit (-hold)
173	root	1.59	compile in built-in block graphics
174	root	1.36	skip builtin block graphics (-sbg)
175	sf-exg	1.66	separate highlight colour (-highlightColor, -highlightTextColor)
176	root	1.69	extended mouse reporting modes (1005 and 1015).
177	root	1.46
178	root	1.48	It also enables some non-essential features otherwise disabled, such
179	root	1.46	as:
180
181			some round-trip time optimisations
182	sf-exg	1.66	nearest colour allocation on pseudocolor screens
183	ayin	1.52	UTF8_STRING support for selection
184	root	1.36	sgr modes 90..97 and 100..107
185	root	1.46	backindex and forwardindex escape sequences
186	ayin	1.52	view change/zero scrollback escape sequences
187	root	1.46	locale switching escape sequence
188			window op and some xterm/OSC escape sequences
189			rectangular selections
190			trailing space removal for selections
191			verbose X error handling
192	root	1.21
193	root	1.29	--enable-iso14755 (default: on)
194	root	1.72	Enable extended ISO 14755 support (see rxvt(1)). Basic support
195	root	1.63	(section 5.1) is enabled by "--enable-frills", while support for
196			5.2, 5.3 and 5.4 is enabled with this switch.
197	root	1.17
198	root	1.29	--enable-keepscrolling (default: on)
199	root	1.16	Add support for continual scrolling of the display when you hold the
200			mouse button down on a scrollbar arrow.
201
202	root	1.56	--enable-selectionscrolling (default: on)
203			Add support for scrolling when the selection moves to the top or
204			bottom of the screen.
205
206	root	1.29	--enable-mousewheel (default: on)
207	root	1.16	Add support for scrolling via mouse wheel or buttons 4 & 5.
208
209	root	1.29	--enable-slipwheeling (default: on)
210	root	1.16	Add support for continual scrolling (using the mouse wheel as an
211			accelerator) while the control key is held down. This option
212			requires --enable-mousewheel to also be specified.
213
214	root	1.56	--enable-smart-resize (default: off)
215			Add smart growth/shrink behaviour when resizing. This should keep
216			the window corner which is closest to a corner of the screen in a
217			fixed position.
218	root	1.16
219	root	1.60	--enable-text-blink (default: on)
220			Add support for blinking text.
221
222	root	1.29	--enable-pointer-blank (default: on)
223	root	1.16	Add support to have the pointer disappear when typing or inactive.
224
225	root	1.44	--enable-perl (default: on)
226	root	1.72	Enable an embedded perl interpreter. See the rxvtperl(3) manpage for
227			more info on this feature, or the files in src/perl/ for the
228	root	1.63	extensions that are installed by default. The perl interpreter that
229			is used can be specified via the "PERL" environment variable when
230			running configure. Even when compiled in, perl will not be
231			initialised when all extensions have been disabled "-pe ""
232			--perl-ext-common """, so it should be safe to enable from a
233			resource standpoint.
234	root	1.35
235	root	1.64	--enable-assert (default: off)
236			Enables the assertions in the code, normally disabled. This switch
237			is only useful when developing rxvt-unicode.
238
239	sf-exg	1.66	--enable-256-color (default: off)
240			Force use of so-called 256 colour mode, to work around buggy
241			applications that do not support termcap/terminfo, or simply improve
242			support for applications hardcoding the xterm 256 colour table.
243
244			This switch breaks termcap/terminfo compatibility to
245			"TERM=rxvt-unicode", and consequently sets "TERM" to
246			"rxvt-unicode-256color" by default (doc/etc/ contains
247			termcap/terminfo definitions for both).
248
249	root	1.72	It also results in higher memory usage and can slow down rxvt
250	sf-exg	1.66	dramatically when more than six fonts are in use by a terminal
251			instance.
252
253	root	1.29	--with-name=NAME (default: urxvt)
254			Set the basename for the installed binaries, resulting in "urxvt",
255			"urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
256
257			--with-term=NAME (default: rxvt-unicode)
258			Change the environmental variable for the terminal to NAME.
259	root	1.16
260			--with-terminfo=PATH
261			Change the environmental variable for the path to the terminfo tree
262			to PATH.
263
264			--with-x
265			Use the X Window System (pretty much default, eh?).
266