README.configure

   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".
  13
  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)
  21         Add support for Xft (anti-aliases, among others) fonts. Xft fonts
  22         are slower and require lots of memory, but as long as you don't use
  23         them, you don't pay for them.
  24
  25     --enable-font-styles (default: on)
  26         Add support for bold, *italic* and *bold italic* font styles. The
  27         fonts can be set manually or automatically.
  28
  29     --with-codesets=NAME,... (default: all)
  30         Compile in support for additional codeset (encoding) groups ("eu",
  31         "vn" are always compiled in, which includes most 8-bit character
  32         sets). These codeset tables are used for driving X11 core fonts,
  33         they are not required for Xft fonts, although having them compiled
  34         in lets rxvt-unicode choose replacement fonts more intelligently.
  35         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         font requiring one of these encodings.
  38
  39            all             all available codeset groups
  40            zh              common chinese encodings
  41            zh_ext          rarely used but very big chinese encodings
  42            jp              common japanese encodings
  43            jp_ext          rarely used but big japanese encodings
  44            kr              korean encodings
  45
  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 non-BMP characters.
  53
  54         Enable direct support for displaying unicode codepoints above 65535
  55         (the basic multilingual page). This increases storage requirements
  56         per character from 2 to 4 bytes. X11 fonts do not yet support these
  57         extra characters, but Xft does.
  58
  59         Please note that rxvt-unicode can store unicode code points >65535
  60         even without this flag, but the number of such characters is limited
  61         to a few thousand (shared with combining characters, see next
  62         switch), and right now rxvt-unicode cannot display them
  63         (input/output and cut&paste still work, though).
  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 seperate unicode characters. This is done by
  69         using precomposited 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-utmp (default: on)
  96         Write user and tty to utmp file (used by programs like w) at start
  97         of rxvt execution and delete information when rxvt exits.
  98
  99     --enable-wtmp (default: on)
 100         Write user and tty to wtmp file (used by programs like last) at
 101         start of rxvt execution and write logout when rxvt exits. This
 102         option requires --enable-utmp to also be specified.
 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-afterimage (default: on)
 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>).
 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
 126     --enable-transparency (default: on)
 127         Add support for inheriting parent backgrounds thus giving a fake
 128         transparency to the term.
 129
 130     --enable-fading (default: on)
 131         Add support for fading the text when focus is lost.
 132
 133     --enable-rxvt-scroll (default: on)
 134         Add support for the original rxvt scrollbar.
 135
 136     --enable-next-scroll (default: on)
 137         Add support for a NeXT-like scrollbar.
 138
 139     --enable-xterm-scroll (default: on)
 140         Add support for an Xterm-like scrollbar.
 141
 142     --enable-plain-scroll (default: on)
 143         Add support for a very unobtrusive, plain-looking scrollbar that is
 144         the favourite of the rxvt-unicode author, having used it for many
 145         years.
 146
 147     --enable-ttygid (default: off)
 148         Change tty device setting to group "tty" - only use this if your
 149         system uses this type of security.
 150
 151     --disable-backspace-key
 152         Removes any handling of the backspace key by us - let the X server
 153         do it.
 154
 155     --disable-delete-key
 156         Removes any handling of the delete key by us - let the X server do
 157         it.
 158
 159     --disable-resources
 160         Removes any support for resource checking.
 161
 162     --disable-swapscreen
 163         Remove support for secondary/swap screen.
 164
 165     --enable-frills (default: on)
 166         Add support for many small features that are not essential but nice
 167         to have. Normally you want this, but for very small binaries you may
 168         want to disable this.
 169
 170         A non-exhaustive list of features enabled by "--enable-frills"
 171         (possibly in combination with other switches) is:
 172
 173           MWM-hints
 174           EWMH-hints (pid, utf8 names) and protocols (ping)
 175           urgency hint
 176           seperate underline colour (-underlineColor)
 177           settable border widths and borderless switch (-w, -b, -bl)
 178           visual depth selection (-depth)
 179           settable extra linespacing /-lsp)
 180           iso-14755 5.1 (basic) support
 181           tripleclickwords (-tcw)
 182           settable insecure mode (-insecure)
 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
 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
 206     --enable-iso14755 (default: on)
 207         Enable extended ISO 14755 support (see urxvt(1), or doc/rxvt.1.txt).
 208         Basic support (section 5.1) is enabled by "--enable-frills", while
 209         support for 5.2, 5.3 and 5.4 is enabled with this switch.
 210
 211     --enable-keepscrolling (default: on)
 212         Add support for continual scrolling of the display when you hold the
 213         mouse button down on a scrollbar arrow.
 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
 219     --enable-mousewheel (default: on)
 220         Add support for scrolling via mouse wheel or buttons 4 & 5.
 221
 222     --enable-slipwheeling (default: on)
 223         Add support for continual scrolling (using the mouse wheel as an
 224         accelerator) while the control key is held down. This option
 225         requires --enable-mousewheel to also be specified.
 226
 227     --enable-smart-resize (default: off)
 228         Add smart growth/shrink behaviour when resizing. This should keep
 229         the window corner which is closest to a corner of the screen in a
 230         fixed position.
 231
 232     --enable-pointer-blank (default: on)
 233         Add support to have the pointer disappear when typing or inactive.
 234
 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)
 249         Set the basename for the installed binaries, resulting in "urxvt",
 250         "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
 251
 252     --with-term=NAME (default: rxvt-unicode)
 253         Change the environmental variable for the terminal to NAME.
 254
 255     --with-terminfo=PATH
 256         Change the environmental variable for the path to the terminfo tree
 257         to PATH.
 258
 259     --with-x
 260         Use the X Window System (pretty much default, eh?).
 261