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 ./reconf script as a base for experiments. ./reconf is used by
   5     myself, so it should generally be a working config. Of course, you
   6     should always report when a combination doesn't work, so it can be
   7     fixed. Marc Lehmann <rxvt@schmorp.de>.
   8
   9     All
  10
  11     --enable-everything
  12         Add (or remove) support for all non-multichoice options listed in
  13         "./configure --help".
  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: enabled)
  22         Add support for Xft (anti-aliases, 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=NAME,... (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 together cost
  37         about 700kB), but it doesn't increase memory usage unless you use a
  38         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 encodigs
  43            jp              common japanese encodings
  44            jp_ext          rarely used but big japanese encodings
  45            kr              korean encodings
  46
  47     --enable-xim (default: on)
  48         Add support for XIM (X Input Method) protocol. This allows using
  49         alternative input methods (e.g. kinput2) and will also correctly set
  50         up the input for people using dead keys or compose keys.
  51
  52     --enable-unicode3 (default: off)
  53         Enable direct support for displaying unicode codepoints above 65535
  54         (the basic multilingual page). This increases storage requirements
  55         per character from 2 to 4 bytes. X11 fonts do not yet support these
  56         extra characters, but Xft does.
  57
  58         Please note that rxvt-unicode can store unicode code points >65535
  59         even without this flag, but the number of such characters is limited
  60         to a view thousand (shared with combining characters, see next
  61         switch), and right now rxvt-unicode cannot display them
  62         (input/output and cut&paste still work, though).
  63
  64     --enable-combining (default: on)
  65         Enable automatic composition of combining characters into composite
  66         characters. This is required for proper viewing of text where
  67         accents are encoded as seperate unicode characters. This is done by
  68         using precomposited characters when available or creating new
  69         pseudo-characters when no precomposed form exists.
  70
  71         Without --enable-unicode3, the number of additional precomposed
  72         characters is rather limited (2048, if this is full, rxvt-unicode
  73         will use the private use area, extending the number of combinations
  74         to 8448). 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-xpm-background (default: on)
 110         Add support for XPM background pixmaps.
 111
 112     --enable-transparency (default: on)
 113         Add support for inheriting parent backgrounds thus giving a fake
 114         transparency to the term.
 115
 116     --enable-fading (default: on)
 117         Add support for fading the text when focus is lost (requires
 118         "--enable-transparency").
 119
 120     --enable-tinting (default: on)
 121         Add support for tinting of transparent backgrounds (requires
 122         "--enable-transparency").
 123
 124     --enable-rxvt-scroll (default: on)
 125         Add support for the original rxvt scrollbar.
 126
 127     --enable-next-scroll (default: on)
 128         Add support for a NeXT-like scrollbar.
 129
 130     --enable-xterm-scroll (default: on)
 131         Add support for an Xterm-like scrollbar.
 132
 133     --enable-plain-scroll (default: on)
 134         Add support for a very unobtrusive, plain-looking scrollbar that is
 135         the favourite of the rxvt-unicode author, having used it for many
 136         years.
 137
 138     --enable-half-shadow (default: off)
 139         Make shadows on the scrollbar only half the normal width & height.
 140         only applicable to rxvt scrollbars.
 141
 142     --enable-ttygid (default: off)
 143         Change tty device setting to group "tty" - only use this if your
 144         system uses this type of security.
 145
 146     --disable-backspace-key
 147         Removes any handling of the backspace key by us - let the X server
 148         do it.
 149
 150     --disable-delete-key
 151         Removes any handling of the delete key by us - let the X server do
 152         it.
 153
 154     --disable-resources
 155         Removes any support for resource checking.
 156
 157     --disable-swapscreen
 158         Remove support for secondary/swap screen.
 159
 160     --enable-frills (default: on)
 161         Add support for many small features that are not essential but nice
 162         to have. Normally you want this, but for very small binaries you may
 163         want to disable this.
 164
 165         A non-exhaustive list of features enabled by "--enable-frills"
 166         (possibly in combination with other switches) is:
 167
 168           MWM-hints
 169           EWMH-hints (pid, utf8 names) and protocols (ping)
 170           seperate underline colour (-underlineColor)
 171           settable border widths and borderless switch (-w, -b, -bl)
 172           settable extra linespacing /-lsp)
 173           iso-14755-2 and -3, and visual feedback
 174           backindex and forwardindex escape sequence
 175           window op and some xterm/OSC escape sequences
 176           tripleclickwords (-tcw)
 177           settable insecure mode (-insecure)
 178           keysym remapping support
 179           cursor blinking and underline cursor (-cb, -uc)
 180           XEmbed support (-embed)
 181           user-pty (-pty-fd)
 182           hold on exit (-hold)
 183           skip builtin block graphics (-sbg)
 184           sgr modes 90..97 and 100..107
 185
 186     --enable-iso14755 (default: on)
 187         Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt).
 188         Basic support (section 5.1) is enabled by "--enable-frills", while
 189         support for 5.2, 5.3 and 5.4 is enabled with this switch.
 190
 191     --enable-keepscrolling (default: on)
 192         Add support for continual scrolling of the display when you hold the
 193         mouse button down on a scrollbar arrow.
 194
 195     --enable-mousewheel (default: on)
 196         Add support for scrolling via mouse wheel or buttons 4 & 5.
 197
 198     --enable-slipwheeling (default: on)
 199         Add support for continual scrolling (using the mouse wheel as an
 200         accelerator) while the control key is held down. This option
 201         requires --enable-mousewheel to also be specified.
 202
 203     --disable-new-selection
 204         Remove support for mouse selection style like that of xterm.
 205
 206     --enable-dmalloc (default: off)
 207         Use Gray Watson's malloc - which is good for debugging See
 208         http://www.letters.com/dmalloc/ for details If you use either this
 209         or the next option, you may need to edit src/Makefile after
 210         compiling to point DINCLUDE and DLIB to the right places.
 211
 212         You can only use either this option and the following (should you
 213         use either) .
 214
 215     --enable-dlmalloc (default: off)
 216         Use Doug Lea's malloc - which is good for a production version See
 217         <http://g.oswego.edu/dl/html/malloc.html> for details.
 218
 219     --enable-smart-resize (default: on)
 220         Add smart growth/shrink behaviour when changing font size via hot
 221         keys. This should keep the window corner which is closest to a
 222         corner of the screen in a fixed position.
 223
 224     --enable-pointer-blank (default: on)
 225         Add support to have the pointer disappear when typing or inactive.
 226
 227     --enable-perl (default: off)
 228         Enable an embedded perl interpreter. See the rxvtperl(3) manpage
 229         (doc/rxvtperl.txt) for more info on this feature, or the files in
 230         src/perl-ext/ for the extensions that are installed by default. The
 231         perl interpreter that is used can be specified via the "PERL"
 232         environment variable when running configure.
 233
 234     --with-name=NAME (default: urxvt)
 235         Set the basename for the installed binaries, resulting in "urxvt",
 236         "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
 237
 238     --with-term=NAME (default: rxvt-unicode)
 239         Change the environmental variable for the terminal to NAME.
 240
 241     --with-terminfo=PATH
 242         Change the environmental variable for the path to the terminfo tree
 243         to PATH.
 244
 245     --with-x
 246         Use the X Window System (pretty much default, eh?).
 247
 248     --with-xpm-includes=DIR
 249         Look for the XPM includes in DIR.
 250
 251     --with-xpm-library=DIR
 252         Look for the XPM library in DIR.
 253
 254     --with-xpm
 255         Not needed - define via --enable-xpm-background.
 256