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

        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 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 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 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 transparency and
        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>).

        This option also adds such eye candy as blending an image over the
        root background, as well as dynamic scaling and bluring of
        background images.

        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-transparency (default: on)
        Add support for backgrounds, creating illusion of transparency in
        the term.

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

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

    --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
          seperate 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 (-cb, -uc)
          XEmbed support (-embed)
          user-pty (-pty-fd)
          hold on exit (-hold)
          compile in built-in block graphics
          skip builtin block graphics (-sbg)
          separate highlightcolor support (-hc)

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

          some round-trip time optimisations
          nearest color 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), 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-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
        (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. 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.

    --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.61
Committed:	Fri Jan 25 18:42:23 2008 UTC (16 years, 5 months ago) by root
Branch:	MAIN
CVS Tags:	rel-9_0, rel-9_01
Changes since 1.60:	+6 -7 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			"./configure --help".
13
14			You can specify this and then disable options you do not like by
15			following this with the appropriate "--disable-..." arguments, or
16			you can start with a minimal configuration by specifying
17			"--disable-everything" and than adding just the "--enable-..."
18			arguments you want.
19	root	1.16
20	root	1.29	--enable-xft (default: enabled)
21	root	1.16	Add support for Xft (anti-aliases, among others) fonts. Xft fonts
22			are slower and require lots of memory, but as long as you don't use
23			them, you don't pay for them.
24
25	root	1.29	--enable-font-styles (default: on)
26	root	1.20	Add support for bold, italic and bold italic font styles. The
27			fonts can be set manually or automatically.
28
29	root	1.29	--with-codesets=NAME,... (default: all)
30	root	1.28	Compile in support for additional codeset (encoding) groups ("eu",
31			"vn" are always compiled in, which includes most 8-bit character
32			sets). These codeset tables are used for driving X11 core fonts,
33			they are not required for Xft fonts, although having them compiled
34			in lets rxvt-unicode choose replacement fonts more intelligently.
35			Compiling them in will make your binary bigger (all of together cost
36			about 700kB), but it doesn't increase memory usage unless you use a
37			font requiring one of these encodings.
38	root	1.16
39	root	1.61	all all available codeset groups
40			zh common chinese encodings
41			zh_ext rarely used but very big chinese encodings
42			jp common japanese encodings
43			jp_ext rarely used but big japanese encodings
44			kr korean encodings
45	root	1.29	--enable-xim (default: on)
46	root	1.16	Add support for XIM (X Input Method) protocol. This allows using
47			alternative input methods (e.g. kinput2) and will also correctly set
48			up the input for people using dead keys or compose keys.
49
50	root	1.29	--enable-unicode3 (default: off)
51	root	1.44	Recommended to stay off unless you really need non-BMP characters.
52
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	root	1.55	to a few thousand (shared with combining characters, see next
61	root	1.16	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.44	characters is somewhat limited (the 6400 private use characters will
73			be (ab-)used). With --enable-unicode3, no practical limit exists.
74	root	1.24
75			This option will also enable storage (but not display) of characters
76			beyond plane 0 (>65535) when --enable-unicode3 was not specified.
77	root	1.16
78	pcg	1.10	The combining table also contains entries for arabic presentation
79	root	1.16	forms, but these are not currently used. Bug me if you want these to
80	root	1.24	be used (and tell me how these are to be used...).
81	root	1.16
82	root	1.29	--enable-fallback(=CLASS) (default: Rxvt)
83			When reading resource settings, also read settings for class CLASS.
84			To disable resource fallback use --disable-fallback.
85
86			--with-res-name=NAME (default: urxvt)
87			Use the given name as default application name when reading
88			resources. Specify --with-res-name=rxvt to replace rxvt.
89
90	root	1.60	--with-res-class=CLASS (default: URxvt)
91	root	1.29	Use the given class as default application class when reading
92			resources. Specify --with-res-class=Rxvt to replace rxvt.
93	root	1.16
94	root	1.29	--enable-utmp (default: on)
95	root	1.16	Write user and tty to utmp file (used by programs like w) at start
96			of rxvt execution and delete information when rxvt exits.
97
98	root	1.29	--enable-wtmp (default: on)
99	root	1.16	Write user and tty to wtmp file (used by programs like last) at
100			start of rxvt execution and write logout when rxvt exits. This
101			option requires --enable-utmp to also be specified.
102
103	root	1.29	--enable-lastlog (default: on)
104	root	1.16	Write user and tty to lastlog file (used by programs like lastlogin)
105			at start of rxvt execution. This option requires --enable-utmp to
106			also be specified.
107
108	root	1.56	--enable-afterimage (default: on)
109			Add support for libAfterImage to be used for transparency and
110			background images. It adds support for many file formats including
111			JPG, PNG, SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep
112			image XML
113			(<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
114
115			This option also adds such eye candy as blending an image over the
116			root background, as well as dynamic scaling and bluring of
117			background images.
118
119	root	1.58	Note that with this option enabled, rxvt's memory footprint might
120	root	1.56	increase by a few megabytes even if no extra features are used
121			(mostly due to third-party libraries used by libAI). Memory
122			footprint may somewhat be lowered if libAfterImage is configured
123			without support for SVG.
124
125	root	1.38	--enable-transparency (default: on)
126	root	1.58	Add support for backgrounds, creating illusion of transparency in
127			the term.
128	root	1.16
129	root	1.29	--enable-fading (default: on)
130	root	1.56	Add support for fading the text when focus is lost.
131	root	1.29
132			--enable-rxvt-scroll (default: on)
133	root	1.16	Add support for the original rxvt scrollbar.
134
135	root	1.29	--enable-next-scroll (default: on)
136	root	1.16	Add support for a NeXT-like scrollbar.
137
138	root	1.29	--enable-xterm-scroll (default: on)
139	root	1.16	Add support for an Xterm-like scrollbar.
140
141	root	1.29	--enable-plain-scroll (default: on)
142	root	1.16	Add support for a very unobtrusive, plain-looking scrollbar that is
143			the favourite of the rxvt-unicode author, having used it for many
144			years.
145
146			--disable-backspace-key
147	root	1.29	Removes any handling of the backspace key by us - let the X server
148	root	1.16	do it.
149
150			--disable-delete-key
151	root	1.29	Removes any handling of the delete key by us - let the X server do
152	root	1.16	it.
153
154			--disable-resources
155	root	1.29	Removes any support for resource checking.
156	root	1.16
157			--disable-swapscreen
158	root	1.29	Remove support for secondary/swap screen.
159	root	1.16
160	root	1.29	--enable-frills (default: on)
161	root	1.16	Add support for many small features that are not essential but nice
162			to have. Normally you want this, but for very small binaries you may
163			want to disable this.
164
165	root	1.21	A non-exhaustive list of features enabled by "--enable-frills"
166			(possibly in combination with other switches) is:
167
168			MWM-hints
169	root	1.26	EWMH-hints (pid, utf8 names) and protocols (ping)
170	ayin	1.53	urgency hint
171	root	1.36	seperate underline colour (-underlineColor)
172			settable border widths and borderless switch (-w, -b, -bl)
173	root	1.46	visual depth selection (-depth)
174	root	1.36	settable extra linespacing /-lsp)
175	root	1.54	iso-14755 5.1 (basic) support
176	root	1.36	tripleclickwords (-tcw)
177			settable insecure mode (-insecure)
178	root	1.23	keysym remapping support
179	root	1.36	cursor blinking and underline cursor (-cb, -uc)
180			XEmbed support (-embed)
181			user-pty (-pty-fd)
182			hold on exit (-hold)
183	root	1.59	compile in built-in block graphics
184	root	1.36	skip builtin block graphics (-sbg)
185	root	1.48	separate highlightcolor support (-hc)
186	root	1.46
187	root	1.48	It also enables some non-essential features otherwise disabled, such
188	root	1.46	as:
189
190			some round-trip time optimisations
191			nearest color allocation on pseudocolor screens
192	ayin	1.52	UTF8_STRING support for selection
193	root	1.36	sgr modes 90..97 and 100..107
194	root	1.46	backindex and forwardindex escape sequences
195	ayin	1.52	view change/zero scrollback escape sequences
196	root	1.46	locale switching escape sequence
197			window op and some xterm/OSC escape sequences
198			rectangular selections
199			trailing space removal for selections
200			verbose X error handling
201	root	1.21
202	root	1.29	--enable-iso14755 (default: on)
203	root	1.58	Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt).
204	root	1.17	Basic support (section 5.1) is enabled by "--enable-frills", while
205			support for 5.2, 5.3 and 5.4 is enabled with this switch.
206
207	root	1.29	--enable-keepscrolling (default: on)
208	root	1.16	Add support for continual scrolling of the display when you hold the
209			mouse button down on a scrollbar arrow.
210
211	root	1.56	--enable-selectionscrolling (default: on)
212			Add support for scrolling when the selection moves to the top or
213			bottom of the screen.
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	root	1.56	--enable-smart-resize (default: off)
224			Add smart growth/shrink behaviour when resizing. This should keep
225			the window corner which is closest to a corner of the screen in a
226			fixed position.
227	root	1.16
228	root	1.60	--enable-text-blink (default: on)
229			Add support for blinking text.
230
231	root	1.29	--enable-pointer-blank (default: on)
232	root	1.16	Add support to have the pointer disappear when typing or inactive.
233
234	root	1.44	--enable-perl (default: on)
235	root	1.58	Enable an embedded perl interpreter. See the rxvtperl(3) manpage
236	root	1.35	(doc/rxvtperl.txt) for more info on this feature, or the files in
237	root	1.37	src/perl-ext/ for the extensions that are installed by default. The
238			perl interpreter that is used can be specified via the "PERL"
239	root	1.55	environment variable when running configure. Even when compiled in,
240			perl will not be initialised when all extensions have been
241			disabled "-pe "" --perl-ext-common """, so it should be safe to
242			enable from a resource standpoint.
243	root	1.35
244	root	1.56	--with-afterimage-config=DIR
245			Look for the libAfterImage config script in DIR.
246
247	root	1.29	--with-name=NAME (default: urxvt)
248			Set the basename for the installed binaries, resulting in "urxvt",
249			"urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
250
251			--with-term=NAME (default: rxvt-unicode)
252			Change the environmental variable for the terminal to NAME.
253	root	1.16
254			--with-terminfo=PATH
255			Change the environmental variable for the path to the terminfo tree
256			to PATH.
257
258			--with-x
259			Use the X Window System (pretty much default, eh?).
260