| 1 | CONFIGURE OPTIONS |
1 | CONFIGURE 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 default configuration (i.e. "--enable-xxx" or "--disable-xxx"). Of |
4 | the default configuration (i.e. no "--enable-xxx" or "--disable-xxx" |
| 5 | course, you should always report when a combination doesn't work, so it |
5 | switches). Of course, you should always report when a combination |
| 6 | can be fixed. Marc Lehmann <rxvt@schmorp.de>. |
6 | doesn't work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>. |
| 7 | |
7 | |
| 8 | All |
8 | All |
| 9 | |
9 | |
| 10 | --enable-everything |
10 | --enable-everything |
| 11 | Add (or remove) support for all non-multichoice options listed in |
11 | Add (or remove) support for all non-multichoice options listed in |
| 12 | "./configure --help". |
12 | "./configure --help", except for "--enable-assert" and |
|
|
13 | "--enable-256-color". |
| 13 | |
14 | |
| 14 | 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 |
| 15 | *following* this with the appropriate "--disable-..." arguments, or |
16 | *following* this with the appropriate "--disable-..." arguments, or |
| 16 | you can start with a minimal configuration by specifying |
17 | you can start with a minimal configuration by specifying |
| 17 | "--disable-everything" and than adding just the "--enable-..." |
18 | "--disable-everything" and than adding just the "--enable-..." |
| 18 | arguments you want. |
19 | arguments you want. |
| 19 | |
20 | |
| 20 | --enable-xft (default: enabled) |
21 | --enable-xft (default: on) |
| 21 | Add support for Xft (anti-aliases, among others) fonts. Xft fonts |
22 | Add support for Xft (anti-aliased, among others) fonts. Xft fonts |
| 22 | 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 |
| 23 | them, you don't pay for them. |
24 | them, you don't pay for them. |
| 24 | |
25 | |
| 25 | --enable-font-styles (default: on) |
26 | --enable-font-styles (default: on) |
| 26 | Add support for bold, *italic* and *bold italic* font styles. The |
27 | Add support for bold, *italic* and *bold italic* font styles. The |
| 27 | fonts can be set manually or automatically. |
28 | fonts can be set manually or automatically. |
| 28 | |
29 | |
| 29 | --with-codesets=NAME,... (default: all) |
30 | --with-codesets=CS,... (default: all) |
| 30 | Compile in support for additional codeset (encoding) groups ("eu", |
31 | Compile in support for additional codeset (encoding) groups ("eu", |
| 31 | "vn" are always compiled in, which includes most 8-bit character |
32 | "vn" are always compiled in, which includes most 8-bit character |
| 32 | sets). These codeset tables are used for driving X11 core fonts, |
33 | sets). These codeset tables are used for driving X11 core fonts, |
| 33 | they are not required for Xft fonts, although having them compiled |
34 | they are not required for Xft fonts, although having them compiled |
| 34 | in lets rxvt-unicode choose replacement fonts more intelligently. |
35 | in lets rxvt-unicode choose replacement fonts more intelligently. |
| 35 | Compiling them in will make your binary bigger (all of together cost |
36 | 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 | about 700kB), but it doesn't increase memory usage unless you use a |
| 37 | font requiring one of these encodings. |
38 | font requiring one of these encodings. |
| 38 | |
39 | |
| 39 | all all available codeset groups |
40 | all all available codeset groups |
| 40 | zh common chinese encodings |
41 | zh common chinese encodings |
| 41 | zh_ext rarely used but very big chinese encodings |
42 | zh_ext rarely used but very big chinese encodings |
| 42 | jp common japanese encodings |
43 | jp common japanese encodings |
| 43 | jp_ext rarely used but big japanese encodings |
44 | jp_ext rarely used but big japanese encodings |
| 44 | kr korean encodings |
45 | kr korean encodings |
| 45 | |
|
|
| 46 | --enable-xim (default: on) |
46 | --enable-xim (default: on) |
| 47 | Add support for XIM (X Input Method) protocol. This allows using |
47 | Add support for XIM (X Input Method) protocol. This allows using |
| 48 | alternative input methods (e.g. kinput2) and will also correctly set |
48 | alternative input methods (e.g. kinput2) and will also correctly set |
| 49 | up the input for people using dead keys or compose keys. |
49 | up the input for people using dead keys or compose keys. |
| 50 | |
50 | |
| 51 | --enable-unicode3 (default: off) |
51 | --enable-unicode3 (default: off) |
| 52 | Recommended to stay off unless you really need non-BMP characters. |
52 | Recommended to stay off unless you really need a lot of non-BMP |
|
|
53 | characters. |
| 53 | |
54 | |
| 54 | Enable direct support for displaying unicode codepoints above 65535 |
55 | Enable support for direct storage of unicode characters above 65535 |
| 55 | (the basic multilingual page). This increases storage requirements |
56 | (the basic multilingual page). This increases storage requirements |
| 56 | 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 |
| 57 | extra characters, but Xft does. |
58 | extra characters, but Xft does. |
| 58 | |
59 | |
| 59 | Please note that rxvt-unicode can store unicode code points >65535 |
60 | Please note that rxvt-unicode can store and display unicode |
| 60 | even without this flag, but the number of such characters is limited |
61 | characters above 65535 even without this flag, but the number of |
| 61 | to a few thousand (shared with combining characters, see next |
62 | such characters is limited to a few thousand (shared with combining |
| 62 | switch), and right now rxvt-unicode cannot display them |
63 | characters, see next switch). |
| 63 | (input/output and cut&paste still work, though). |
|
|
| 64 | |
64 | |
| 65 | --enable-combining (default: on) |
65 | --enable-combining (default: on) |
| 66 | Enable automatic composition of combining characters into composite |
66 | Enable automatic composition of combining characters into composite |
| 67 | characters. This is required for proper viewing of text where |
67 | characters. This is required for proper viewing of text where |
| 68 | accents are encoded as seperate unicode characters. This is done by |
68 | accents are encoded as separate unicode characters. This is done by |
| 69 | using precomposited characters when available or creating new |
69 | using precomposed characters when available or creating new |
| 70 | pseudo-characters when no precomposed form exists. |
70 | pseudo-characters when no precomposed form exists. |
| 71 | |
71 | |
| 72 | Without --enable-unicode3, the number of additional precomposed |
72 | Without --enable-unicode3, the number of additional precomposed |
| 73 | characters is somewhat limited (the 6400 private use characters will |
73 | characters is somewhat limited (the 6400 private use characters will |
| 74 | be (ab-)used). With --enable-unicode3, no practical limit exists. |
74 | be (ab-)used). With --enable-unicode3, no practical limit exists. |
| … | |
… | |
| 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 | --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: on) |
|
|
| 110 | Add support for XPM background pixmaps. |
|
|
| 111 | |
|
|
| 112 | --enable-afterimage (default: on) |
|
|
| 113 | Add support for libAfterImage to be used for transparency and |
|
|
| 114 | background images. It adds support for many file formats including |
|
|
| 115 | JPG, PNG, SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep |
|
|
| 116 | image XML |
|
|
| 117 | (<http://www.afterstep.org/visualdoc.php?show=asimagexml>). |
|
|
| 118 | |
|
|
| 119 | This option also adds such eye candy as blending an image over the |
|
|
| 120 | root background, as well as dynamic scaling and bluring of |
|
|
| 121 | background images. |
|
|
| 122 | |
|
|
| 123 | Note that with this option enabled, rxvt's memory footprint might |
|
|
| 124 | increase by a few megabytes even if no extra features are used |
|
|
| 125 | (mostly due to third-party libraries used by libAI). Memory |
|
|
| 126 | footprint may somewhat be lowered if libAfterImage is configured |
|
|
| 127 | without support for SVG. |
|
|
| 128 | |
104 | |
| 129 | --enable-transparency (default: on) |
105 | --enable-transparency (default: on) |
| 130 | Add support for inheriting parent backgrounds thus giving a fake |
106 | Add support for using the root pixmap as background to simulate |
| 131 | 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. |
| 132 | |
109 | |
| 133 | --enable-fading (default: on) |
110 | --enable-fading (default: on) |
| 134 | Add support for fading the text when focus is lost. |
111 | Add support for fading the text when focus is lost. |
| 135 | |
112 | |
| 136 | --enable-tinting (default: on) |
|
|
| 137 | Add support for tinting of transparent backgrounds (requires |
|
|
| 138 | "--enable-transparency"). |
|
|
| 139 | |
|
|
| 140 | --enable-rxvt-scroll (default: on) |
113 | --enable-rxvt-scroll (default: on) |
| 141 | Add support for the original rxvt scrollbar. |
114 | Add support for the original rxvt scrollbar. |
| 142 | |
115 | |
| 143 | --enable-next-scroll (default: on) |
116 | --enable-next-scroll (default: on) |
| 144 | Add support for a NeXT-like scrollbar. |
117 | Add support for a NeXT-like scrollbar. |
| 145 | |
118 | |
| 146 | --enable-xterm-scroll (default: on) |
119 | --enable-xterm-scroll (default: on) |
| 147 | Add support for an Xterm-like scrollbar. |
120 | Add support for an Xterm-like scrollbar. |
| 148 | |
|
|
| 149 | --enable-plain-scroll (default: on) |
|
|
| 150 | Add support for a very unobtrusive, plain-looking scrollbar that is |
|
|
| 151 | the favourite of the rxvt-unicode author, having used it for many |
|
|
| 152 | years. |
|
|
| 153 | |
|
|
| 154 | --enable-ttygid (default: off) |
|
|
| 155 | Change tty device setting to group "tty" - only use this if your |
|
|
| 156 | system uses this type of security. |
|
|
| 157 | |
121 | |
| 158 | --disable-backspace-key |
122 | --disable-backspace-key |
| 159 | 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 |
| 160 | do it. |
124 | do it. |
| 161 | |
125 | |
| … | |
… | |
| 178 | (possibly in combination with other switches) is: |
142 | (possibly in combination with other switches) is: |
| 179 | |
143 | |
| 180 | MWM-hints |
144 | MWM-hints |
| 181 | EWMH-hints (pid, utf8 names) and protocols (ping) |
145 | EWMH-hints (pid, utf8 names) and protocols (ping) |
| 182 | urgency hint |
146 | urgency hint |
| 183 | seperate underline colour (-underlineColor) |
147 | separate underline colour (-underlineColor) |
| 184 | settable border widths and borderless switch (-w, -b, -bl) |
148 | settable border widths and borderless switch (-w, -b, -bl) |
| 185 | visual depth selection (-depth) |
149 | visual depth selection (-depth) |
| 186 | settable extra linespacing /-lsp) |
150 | settable extra linespacing (-lsp) |
| 187 | iso-14755 5.1 (basic) support |
151 | iso-14755 5.1 (basic) support |
| 188 | tripleclickwords (-tcw) |
152 | tripleclickwords (-tcw) |
| 189 | settable insecure mode (-insecure) |
153 | settable insecure mode (-insecure) |
| 190 | keysym remapping support |
154 | keysym remapping support |
| 191 | cursor blinking and underline cursor (-cb, -uc) |
155 | cursor blinking and underline cursor (-bc, -uc) |
| 192 | XEmbed support (-embed) |
156 | XEmbed support (-embed) |
| 193 | user-pty (-pty-fd) |
157 | user-pty (-pty-fd) |
| 194 | hold on exit (-hold) |
158 | hold on exit (-hold) |
|
|
159 | compile in built-in block graphics |
| 195 | skip builtin block graphics (-sbg) |
160 | skip builtin block graphics (-sbg) |
| 196 | separate highlightcolor support (-hc) |
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 |
| 197 | |
168 | |
| 198 | It also enables some non-essential features otherwise disabled, such |
169 | It also enables some non-essential features otherwise disabled, such |
| 199 | as: |
170 | as: |
| 200 | |
171 | |
| 201 | some round-trip time optimisations |
172 | some round-trip time optimisations |
| 202 | nearest color allocation on pseudocolor screens |
173 | nearest colour allocation on pseudocolor screens |
| 203 | UTF8_STRING support for selection |
174 | UTF8_STRING support for selection |
| 204 | sgr modes 90..97 and 100..107 |
175 | sgr modes 90..97 and 100..107 |
| 205 | backindex and forwardindex escape sequences |
176 | backindex and forwardindex escape sequences |
| 206 | view change/zero scrollback escape sequences |
177 | view change/zero scrollback escape sequences |
| 207 | locale switching escape sequence |
178 | locale switching escape sequence |
| … | |
… | |
| 209 | rectangular selections |
180 | rectangular selections |
| 210 | trailing space removal for selections |
181 | trailing space removal for selections |
| 211 | verbose X error handling |
182 | verbose X error handling |
| 212 | |
183 | |
| 213 | --enable-iso14755 (default: on) |
184 | --enable-iso14755 (default: on) |
| 214 | Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt). |
185 | Enable extended ISO 14755 support (see rxvt(1)). Basic support |
| 215 | Basic support (section 5.1) is enabled by "--enable-frills", while |
186 | (section 5.1) is enabled by "--enable-frills", while support for |
| 216 | 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. |
| 217 | |
188 | |
| 218 | --enable-keepscrolling (default: on) |
189 | --enable-keepscrolling (default: on) |
| 219 | 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 |
| 220 | mouse button down on a scrollbar arrow. |
191 | mouse button down on a scrollbar arrow. |
| 221 | |
192 | |
| … | |
… | |
| 234 | --enable-smart-resize (default: off) |
205 | --enable-smart-resize (default: off) |
| 235 | Add smart growth/shrink behaviour when resizing. This should keep |
206 | Add smart growth/shrink behaviour when resizing. This should keep |
| 236 | the window corner which is closest to a corner of the screen in a |
207 | the window corner which is closest to a corner of the screen in a |
| 237 | fixed position. |
208 | fixed position. |
| 238 | |
209 | |
|
|
210 | --enable-text-blink (default: on) |
|
|
211 | Add support for blinking text. |
|
|
212 | |
| 239 | --enable-pointer-blank (default: on) |
213 | --enable-pointer-blank (default: on) |
| 240 | Add support to have the pointer disappear when typing or inactive. |
214 | Add support to have the pointer disappear when typing or inactive. |
| 241 | |
215 | |
| 242 | --enable-perl (default: on) |
216 | --enable-perl (default: on) |
| 243 | Enable an embedded perl interpreter. See the rxvtperl(3) manpage |
217 | Enable an embedded perl interpreter. See the rxvtperl(3) manpage for |
| 244 | (doc/rxvtperl.txt) for more info on this feature, or the files in |
218 | more info on this feature, or the files in src/perl/ for the |
| 245 | src/perl-ext/ for the extensions that are installed by default. The |
219 | extensions that are installed by default. The perl interpreter that |
| 246 | perl interpreter that is used can be specified via the "PERL" |
220 | is used can be specified via the "PERL" environment variable when |
| 247 | environment variable when running configure. Even when compiled in, |
221 | running configure. Even when compiled in, perl will *not* be |
| 248 | perl will *not* be initialised when all extensions have been |
222 | initialised when all extensions have been disabled "-pe "" |
| 249 | disabled "-pe "" --perl-ext-common """, so it should be safe to |
223 | --perl-ext-common """, so it should be safe to enable from a |
| 250 | enable from a resource standpoint. |
224 | resource standpoint. |
| 251 | |
225 | |
| 252 | --with-afterimage-config=DIR |
226 | --enable-assert (default: off) |
| 253 | Look for the libAfterImage config script in DIR. |
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 rxvt |
|
|
241 | dramatically when more than six fonts are in use by a terminal |
|
|
242 | instance. |
| 254 | |
243 | |
| 255 | --with-name=NAME (default: urxvt) |
244 | --with-name=NAME (default: urxvt) |
| 256 | Set the basename for the installed binaries, resulting in "urxvt", |
245 | Set the basename for the installed binaries, resulting in "urxvt", |
| 257 | "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt". |
246 | "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt". |
| 258 | |
247 | |
| 259 | --with-term=NAME (default: rxvt-unicode) |
248 | --with-term=NAME (default: rxvt-unicode) |
| 260 | Change the environmental variable for the terminal to NAME. |
249 | Sets the default "TERM" value that rxvt sets. The default is either |
|
|
250 | "rxvt-unicode" or "rxvt-unicode-256color", as appropriate. |
| 261 | |
251 | |
| 262 | --with-terminfo=PATH |
252 | --with-terminfo=PATH |
| 263 | Change the environmental variable for the path to the terminfo tree |
253 | If set, rxvt will set the environment variable "TERMINFO" to the |
| 264 | to PATH. |
254 | given PATH, which can be useful as a last resort if installing the |
|
|
255 | terminfo entries system-wide is not possible. |
| 265 | |
256 | |
| 266 | --with-x |
257 | --with-x |
| 267 | Use the X Window System (pretty much default, eh?). |
258 | Use the X Window System (pretty much default, eh?). |
| 268 | |
259 | |
| 269 | --with-xpm-includes=DIR |
|
|
| 270 | Look for the XPM includes in DIR. |
|
|
| 271 | |
|
|
| 272 | --with-xpm-library=DIR |
|
|
| 273 | Look for the XPM library in DIR. |
|
|
| 274 | |
|
|
| 275 | --with-xpm |
|
|
| 276 | Not needed - define via --enable-xpm-background. |
|
|
| 277 | |
|
|
