| 1 |
CONFIGURE OPTIONS |
| 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 |
| 4 |
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 |
|
| 8 |
All |
| 9 |
|
| 10 |
--enable-everything |
| 11 |
Add (or remove) support for all non-multichoice options listed in |
| 12 |
"./configure --help", except for "--enable-assert" and |
| 13 |
"--enable-256-color". |
| 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 |
|
| 21 |
--enable-xft (default: on) |
| 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 |
| 24 |
them, you don't pay for them. |
| 25 |
|
| 26 |
--enable-font-styles (default: on) |
| 27 |
Add support for bold, *italic* and *bold italic* font styles. The |
| 28 |
fonts can be set manually or automatically. |
| 29 |
|
| 30 |
--with-codesets=CS,... (default: all) |
| 31 |
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 them together |
| 37 |
cost about 700kB), but it doesn't increase memory usage unless you |
| 38 |
use a font requiring one of these encodings. |
| 39 |
|
| 40 |
all all available codeset groups |
| 41 |
zh common chinese encodings |
| 42 |
zh_ext rarely used but very big chinese encodings |
| 43 |
jp common japanese encodings |
| 44 |
jp_ext rarely used but big japanese encodings |
| 45 |
kr korean encodings |
| 46 |
--enable-xim (default: on) |
| 47 |
Add support for XIM (X Input Method) protocol. This allows using |
| 48 |
alternative input methods (e.g. kinput2) and will also correctly set |
| 49 |
up the input for people using dead keys or compose keys. |
| 50 |
|
| 51 |
--enable-unicode3 (default: off) |
| 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 |
| 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 |
extra characters, but Xft does. |
| 59 |
|
| 60 |
Please note that rxvt-unicode can store and display unicode |
| 61 |
characters above 65535 even without this flag, but the number of |
| 62 |
such characters is limited to a few thousand (shared with combining |
| 63 |
characters, see next switch). |
| 64 |
|
| 65 |
--enable-combining (default: on) |
| 66 |
Enable automatic composition of combining characters into composite |
| 67 |
characters. This is required for proper viewing of text where |
| 68 |
accents are encoded as separate unicode characters. This is done by |
| 69 |
using precomposed characters when available or creating new |
| 70 |
pseudo-characters when no precomposed form exists. |
| 71 |
|
| 72 |
Without --enable-unicode3, the number of additional precomposed |
| 73 |
characters is somewhat limited (the 6400 private use characters will |
| 74 |
be (ab-)used). With --enable-unicode3, no practical limit exists. |
| 75 |
|
| 76 |
This option will also enable storage (but not display) of characters |
| 77 |
beyond plane 0 (>65535) when --enable-unicode3 was not specified. |
| 78 |
|
| 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 |
| 81 |
be used (and tell me how these are to be used...). |
| 82 |
|
| 83 |
--enable-fallback[=CLASS] (default: Rxvt) |
| 84 |
When reading resource settings, also read settings for class CLASS. |
| 85 |
To disable resource fallback use --disable-fallback. |
| 86 |
|
| 87 |
--with-res-name=NAME (default: urxvt) |
| 88 |
Use the given name as default application name when reading |
| 89 |
resources. Specify --with-res-name=rxvt to replace rxvt. |
| 90 |
|
| 91 |
--with-res-class=CLASS (default: URxvt) |
| 92 |
Use the given class as default application class when reading |
| 93 |
resources. Specify --with-res-class=Rxvt to replace rxvt. |
| 94 |
|
| 95 |
--enable-pixbuf (default: on) |
| 96 |
Add support for GDK-PixBuf to be used for background images. It adds |
| 97 |
support for many file formats including JPG, PNG, TIFF, GIF, XPM, |
| 98 |
BMP, ICO and TGA. |
| 99 |
|
| 100 |
--enable-startup-notification (default: on) |
| 101 |
Add support for freedesktop startup notifications. This allows |
| 102 |
window managers to display some kind of progress indicator during |
| 103 |
startup. |
| 104 |
|
| 105 |
--enable-transparency (default: on) |
| 106 |
Add support for using the root pixmap as background to simulate |
| 107 |
transparency. Note that this feature depends on libXrender and on |
| 108 |
the availability of the RENDER extension in the X server. |
| 109 |
|
| 110 |
--enable-fading (default: on) |
| 111 |
Add support for fading the text when focus is lost. |
| 112 |
|
| 113 |
--enable-rxvt-scroll (default: on) |
| 114 |
Add support for the original rxvt scrollbar. |
| 115 |
|
| 116 |
--enable-next-scroll (default: on) |
| 117 |
Add support for a NeXT-like scrollbar. |
| 118 |
|
| 119 |
--enable-xterm-scroll (default: on) |
| 120 |
Add support for an Xterm-like scrollbar. |
| 121 |
|
| 122 |
--disable-backspace-key |
| 123 |
Removes any handling of the backspace key by us - let the X server |
| 124 |
do it. |
| 125 |
|
| 126 |
--disable-delete-key |
| 127 |
Removes any handling of the delete key by us - let the X server do |
| 128 |
it. |
| 129 |
|
| 130 |
--disable-resources |
| 131 |
Removes any support for resource checking. |
| 132 |
|
| 133 |
--disable-swapscreen |
| 134 |
Remove support for secondary/swap screen. |
| 135 |
|
| 136 |
--enable-frills (default: on) |
| 137 |
Add support for many small features that are not essential but nice |
| 138 |
to have. Normally you want this, but for very small binaries you may |
| 139 |
want to disable this. |
| 140 |
|
| 141 |
A non-exhaustive list of features enabled by "--enable-frills" |
| 142 |
(possibly in combination with other switches) is: |
| 143 |
|
| 144 |
MWM-hints |
| 145 |
EWMH-hints (pid, utf8 names) and protocols (ping) |
| 146 |
urgency hint |
| 147 |
separate underline colour (-underlineColor) |
| 148 |
settable border widths and borderless switch (-w, -b, -bl) |
| 149 |
visual depth selection (-depth) |
| 150 |
settable extra linespacing (-lsp) |
| 151 |
iso-14755 5.1 (basic) support |
| 152 |
tripleclickwords (-tcw) |
| 153 |
settable insecure mode (-insecure) |
| 154 |
keysym remapping support |
| 155 |
cursor blinking and underline cursor (-bc, -uc) |
| 156 |
XEmbed support (-embed) |
| 157 |
user-pty (-pty-fd) |
| 158 |
hold on exit (-hold) |
| 159 |
compile in built-in block graphics |
| 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 |
| 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 |
| 183 |
|
| 184 |
--enable-iso14755 (default: on) |
| 185 |
Enable extended ISO 14755 support (see urxvt(1)). Basic support |
| 186 |
(section 5.1) is enabled by "--enable-frills", while support for |
| 187 |
5.2, 5.3 and 5.4 is enabled with this switch. |
| 188 |
|
| 189 |
--enable-keepscrolling (default: on) |
| 190 |
Add support for continual scrolling of the display when you hold the |
| 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. |
| 196 |
|
| 197 |
--enable-mousewheel (default: on) |
| 198 |
Add support for scrolling via mouse wheel or buttons 4 & 5. |
| 199 |
|
| 200 |
--enable-slipwheeling (default: on) |
| 201 |
Add support for continual scrolling (using the mouse wheel as an |
| 202 |
accelerator) while the control key is held down. This option |
| 203 |
requires --enable-mousewheel to also be specified. |
| 204 |
|
| 205 |
--enable-smart-resize (default: off) |
| 206 |
Add smart growth/shrink behaviour when resizing. This should keep |
| 207 |
the window corner which is closest to a corner of the screen in a |
| 208 |
fixed position. |
| 209 |
|
| 210 |
--enable-text-blink (default: on) |
| 211 |
Add support for blinking text. |
| 212 |
|
| 213 |
--enable-pointer-blank (default: on) |
| 214 |
Add support to have the pointer disappear when typing or inactive. |
| 215 |
|
| 216 |
--enable-perl (default: on) |
| 217 |
Enable an embedded perl interpreter. See the urxvtperl(3) manpage |
| 218 |
for more info on this feature, or the files in src/perl/ for the |
| 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. |
| 243 |
|
| 244 |
--with-name=NAME (default: urxvt) |
| 245 |
Set the basename for the installed binaries, resulting in "urxvt", |
| 246 |
"urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt". |
| 247 |
|
| 248 |
--with-term=NAME (default: rxvt-unicode) |
| 249 |
Sets the default "TERM" value that urxvt sets. The default is either |
| 250 |
"rxvt-unicode" or "rxvt-unicode-256color", as appropriate. |
| 251 |
|
| 252 |
--with-terminfo=PATH |
| 253 |
If set, urxvt will set the environment variable "TERMINFO" to the |
| 254 |
given PATH, which can be useful as a last resort if installing the |
| 255 |
terminfo entries system-wide is not possible. |
| 256 |
|
| 257 |
--with-x |
| 258 |
Use the X Window System (pretty much default, eh?). |
| 259 |
|
