ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/README.configure
(Generate patch)

Comparing rxvt-unicode/README.configure (file contents):
Revision 1.36 by root, Wed Jan 4 21:37:55 2006 UTC vs.
Revision 1.89 by root, Mon Feb 13 17:29:02 2023 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines