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

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

    --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-2 and -3, and visual feedback
          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)
          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-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: 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.

    --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.53
Committed:	Wed May 2 23:06:32 2007 UTC (17 years ago) by ayin
Branch:	MAIN
Changes since 1.52:	+1 -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			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.51	all all available codeset groups
41			zh common chinese encodings
42	ayin	1.52	zh_ext rarely used but very big chinese encodings
43	root	1.51	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.44	Recommended to stay off unless you really need non-BMP characters.
54
55	root	1.16	Enable direct support for displaying unicode codepoints above 65535
56			(the basic multilingual page). This increases storage requirements
57			per character from 2 to 4 bytes. X11 fonts do not yet support these
58	pcg	1.10	extra characters, but Xft does.
59	root	1.16
60			Please note that rxvt-unicode can store unicode code points >65535
61			even without this flag, but the number of such characters is limited
62			to a view thousand (shared with combining characters, see next
63			switch), and right now rxvt-unicode cannot display them
64			(input/output and cut&paste still work, though).
65
66	root	1.29	--enable-combining (default: on)
67	root	1.16	Enable automatic composition of combining characters into composite
68			characters. This is required for proper viewing of text where
69			accents are encoded as seperate unicode characters. This is done by
70			using precomposited characters when available or creating new
71			pseudo-characters when no precomposed form exists.
72
73			Without --enable-unicode3, the number of additional precomposed
74	root	1.44	characters is somewhat limited (the 6400 private use characters will
75			be (ab-)used). With --enable-unicode3, no practical limit exists.
76	root	1.24
77			This option will also enable storage (but not display) of characters
78			beyond plane 0 (>65535) when --enable-unicode3 was not specified.
79	root	1.16
80	pcg	1.10	The combining table also contains entries for arabic presentation
81	root	1.16	forms, but these are not currently used. Bug me if you want these to
82	root	1.24	be used (and tell me how these are to be used...).
83	root	1.16
84	root	1.29	--enable-fallback(=CLASS) (default: Rxvt)
85			When reading resource settings, also read settings for class CLASS.
86			To disable resource fallback use --disable-fallback.
87
88			--with-res-name=NAME (default: urxvt)
89			Use the given name as default application name when reading
90			resources. Specify --with-res-name=rxvt to replace rxvt.
91
92			--with-res-class=CLASS /default: URxvt)
93			Use the given class as default application class when reading
94			resources. Specify --with-res-class=Rxvt to replace rxvt.
95	root	1.16
96	root	1.29	--enable-utmp (default: on)
97	root	1.16	Write user and tty to utmp file (used by programs like w) at start
98			of rxvt execution and delete information when rxvt exits.
99
100	root	1.29	--enable-wtmp (default: on)
101	root	1.16	Write user and tty to wtmp file (used by programs like last) at
102			start of rxvt execution and write logout when rxvt exits. This
103			option requires --enable-utmp to also be specified.
104
105	root	1.29	--enable-lastlog (default: on)
106	root	1.16	Write user and tty to lastlog file (used by programs like lastlogin)
107			at start of rxvt execution. This option requires --enable-utmp to
108			also be specified.
109
110	root	1.38	--enable-xpm-background (default: on)
111	root	1.16	Add support for XPM background pixmaps.
112
113	root	1.38	--enable-transparency (default: on)
114	root	1.16	Add support for inheriting parent backgrounds thus giving a fake
115			transparency to the term.
116
117	root	1.29	--enable-fading (default: on)
118			Add support for fading the text when focus is lost (requires
119			"--enable-transparency").
120
121			--enable-tinting (default: on)
122			Add support for tinting of transparent backgrounds (requires
123			"--enable-transparency").
124	root	1.16
125	root	1.29	--enable-rxvt-scroll (default: on)
126	root	1.16	Add support for the original rxvt scrollbar.
127
128	root	1.29	--enable-next-scroll (default: on)
129	root	1.16	Add support for a NeXT-like scrollbar.
130
131	root	1.29	--enable-xterm-scroll (default: on)
132	root	1.16	Add support for an Xterm-like scrollbar.
133
134	root	1.29	--enable-plain-scroll (default: on)
135	root	1.16	Add support for a very unobtrusive, plain-looking scrollbar that is
136			the favourite of the rxvt-unicode author, having used it for many
137			years.
138
139	root	1.44	--enable-ttygid (default: off)
140			Change tty device setting to group "tty" - only use this if your
141			system uses this type of security.
142
143	root	1.16	--disable-backspace-key
144	root	1.29	Removes any handling of the backspace key by us - let the X server
145	root	1.16	do it.
146
147			--disable-delete-key
148	root	1.29	Removes any handling of the delete key by us - let the X server do
149	root	1.16	it.
150
151			--disable-resources
152	root	1.29	Removes any support for resource checking.
153	root	1.16
154			--disable-swapscreen
155	root	1.29	Remove support for secondary/swap screen.
156	root	1.16
157	root	1.29	--enable-frills (default: on)
158	root	1.16	Add support for many small features that are not essential but nice
159			to have. Normally you want this, but for very small binaries you may
160			want to disable this.
161
162	root	1.21	A non-exhaustive list of features enabled by "--enable-frills"
163			(possibly in combination with other switches) is:
164
165			MWM-hints
166	root	1.26	EWMH-hints (pid, utf8 names) and protocols (ping)
167	ayin	1.53	urgency hint
168	root	1.36	seperate underline colour (-underlineColor)
169			settable border widths and borderless switch (-w, -b, -bl)
170	root	1.46	visual depth selection (-depth)
171	root	1.36	settable extra linespacing /-lsp)
172	root	1.21	iso-14755-2 and -3, and visual feedback
173	root	1.36	tripleclickwords (-tcw)
174			settable insecure mode (-insecure)
175	root	1.23	keysym remapping support
176	root	1.36	cursor blinking and underline cursor (-cb, -uc)
177			XEmbed support (-embed)
178			user-pty (-pty-fd)
179			hold on exit (-hold)
180			skip builtin block graphics (-sbg)
181	root	1.48	separate highlightcolor support (-hc)
182	root	1.46
183	root	1.48	It also enables some non-essential features otherwise disabled, such
184	root	1.46	as:
185
186			some round-trip time optimisations
187			nearest color allocation on pseudocolor screens
188	ayin	1.52	UTF8_STRING support for selection
189	root	1.36	sgr modes 90..97 and 100..107
190	root	1.46	backindex and forwardindex escape sequences
191	ayin	1.52	view change/zero scrollback escape sequences
192	root	1.46	locale switching escape sequence
193			window op and some xterm/OSC escape sequences
194			rectangular selections
195			trailing space removal for selections
196			verbose X error handling
197	root	1.21
198	root	1.29	--enable-iso14755 (default: on)
199	root	1.50	Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt).
200	root	1.17	Basic support (section 5.1) is enabled by "--enable-frills", while
201			support for 5.2, 5.3 and 5.4 is enabled with this switch.
202
203	root	1.29	--enable-keepscrolling (default: on)
204	root	1.16	Add support for continual scrolling of the display when you hold the
205			mouse button down on a scrollbar arrow.
206
207	root	1.29	--enable-mousewheel (default: on)
208	root	1.16	Add support for scrolling via mouse wheel or buttons 4 & 5.
209
210	root	1.29	--enable-slipwheeling (default: on)
211	root	1.16	Add support for continual scrolling (using the mouse wheel as an
212			accelerator) while the control key is held down. This option
213			requires --enable-mousewheel to also be specified.
214
215			--disable-new-selection
216			Remove support for mouse selection style like that of xterm.
217
218	root	1.29	--enable-dmalloc (default: off)
219	root	1.16	Use Gray Watson's malloc - which is good for debugging See
220	root	1.47	<http://www.letters.com/dmalloc/> for details If you use either this
221	root	1.16	or the next option, you may need to edit src/Makefile after
222			compiling to point DINCLUDE and DLIB to the right places.
223
224			You can only use either this option and the following (should you
225			use either) .
226
227	root	1.29	--enable-dlmalloc (default: off)
228	root	1.16	Use Doug Lea's malloc - which is good for a production version See
229			<http://g.oswego.edu/dl/html/malloc.html> for details.
230
231	root	1.29	--enable-smart-resize (default: on)
232	root	1.30	Add smart growth/shrink behaviour when changing font size via hot
233	root	1.31	keys. This should keep the window corner which is closest to a
234			corner of the screen in a fixed position.
235	root	1.16
236	root	1.29	--enable-pointer-blank (default: on)
237	root	1.16	Add support to have the pointer disappear when typing or inactive.
238
239	root	1.44	--enable-perl (default: on)
240	root	1.50	Enable an embedded perl interpreter. See the rxvtperl(3) manpage
241	root	1.35	(doc/rxvtperl.txt) for more info on this feature, or the files in
242	root	1.37	src/perl-ext/ for the extensions that are installed by default. The
243			perl interpreter that is used can be specified via the "PERL"
244			environment variable when running configure.
245	root	1.35
246	root	1.29	--with-name=NAME (default: urxvt)
247			Set the basename for the installed binaries, resulting in "urxvt",
248			"urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
249
250			--with-term=NAME (default: rxvt-unicode)
251			Change the environmental variable for the terminal to NAME.
252	root	1.16
253			--with-terminfo=PATH
254			Change the environmental variable for the path to the terminfo tree
255			to PATH.
256
257			--with-x
258			Use the X Window System (pretty much default, eh?).
259
260			--with-xpm-includes=DIR
261			Look for the XPM includes in DIR.
262
263			--with-xpm-library=DIR
264			Look for the XPM library in DIR.
265
266			--with-xpm
267			Not needed - define via --enable-xpm-background.
268	pcg	1.7