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