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