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         Recommended to stay off unless you really need non-BMP characters.
  54
  55         Enable direct support for displaying unicode codepoints 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 unicode code points >65535
  61         even without this flag, but the number of such characters is limited
  62         to a view thousand (shared with combining characters, see next
  63         switch), and right now rxvt-unicode cannot display them
  64         (input/output and cut&paste still work, though).
  65
  66     --enable-combining (default: on)
  67         Enable automatic composition of combining characters into composite
  68         characters. This is required for proper viewing of text where
  69         accents are encoded as seperate unicode characters. This is done by
  70         using precomposited characters when available or creating new
  71         pseudo-characters when no precomposed form exists.
  72
  73         Without --enable-unicode3, the number of additional precomposed
  74         characters is somewhat limited (the 6400 private use characters will
  75         be (ab-)used). With --enable-unicode3, no practical limit exists.
  76
  77         This option will also enable storage (but not display) of characters
  78         beyond plane 0 (>65535) when --enable-unicode3 was not specified.
  79
  80         The combining table also contains entries for arabic presentation
  81         forms, but these are not currently used. Bug me if you want these to
  82         be used (and tell me how these are to be used...).
  83
  84     --enable-fallback(=CLASS) (default: Rxvt)
  85         When reading resource settings, also read settings for class CLASS.
  86         To disable resource fallback use --disable-fallback.
  87
  88     --with-res-name=NAME (default: urxvt)
  89         Use the given name as default application name when reading
  90         resources. Specify --with-res-name=rxvt to replace rxvt.
  91
  92     --with-res-class=CLASS /default: URxvt)
  93         Use the given class as default application class when reading
  94         resources. Specify --with-res-class=Rxvt to replace rxvt.
  95
  96     --enable-utmp (default: on)
  97         Write user and tty to utmp file (used by programs like w) at start
  98         of rxvt execution and delete information when rxvt exits.
  99
 100     --enable-wtmp (default: on)
 101         Write user and tty to wtmp file (used by programs like last) at
 102         start of rxvt execution and write logout when rxvt exits. This
 103         option requires --enable-utmp to also be specified.
 104
 105     --enable-lastlog (default: on)
 106         Write user and tty to lastlog file (used by programs like lastlogin)
 107         at start of rxvt execution. This option requires --enable-utmp to
 108         also be specified.
 109
 110     --enable-xpm-background (default: on)
 111         Add support for XPM background pixmaps.
 112
 113     --enable-transparency (default: on)
 114         Add support for inheriting parent backgrounds thus giving a fake
 115         transparency to the term.
 116
 117     --enable-fading (default: on)
 118         Add support for fading the text when focus is lost (requires
 119         "--enable-transparency").
 120
 121     --enable-tinting (default: on)
 122         Add support for tinting of transparent backgrounds (requires
 123         "--enable-transparency").
 124
 125     --enable-rxvt-scroll (default: on)
 126         Add support for the original rxvt scrollbar.
 127
 128     --enable-next-scroll (default: on)
 129         Add support for a NeXT-like scrollbar.
 130
 131     --enable-xterm-scroll (default: on)
 132         Add support for an Xterm-like scrollbar.
 133
 134     --enable-plain-scroll (default: on)
 135         Add support for a very unobtrusive, plain-looking scrollbar that is
 136         the favourite of the rxvt-unicode author, having used it for many
 137         years.
 138
 139     --enable-ttygid (default: off)
 140         Change tty device setting to group "tty" - only use this if your
 141         system uses this type of security.
 142
 143     --disable-backspace-key
 144         Removes any handling of the backspace key by us - let the X server
 145         do it.
 146
 147     --disable-delete-key
 148         Removes any handling of the delete key by us - let the X server do
 149         it.
 150
 151     --disable-resources
 152         Removes any support for resource checking.
 153
 154     --disable-swapscreen
 155         Remove support for secondary/swap screen.
 156
 157     --enable-frills (default: on)
 158         Add support for many small features that are not essential but nice
 159         to have. Normally you want this, but for very small binaries you may
 160         want to disable this.
 161
 162         A non-exhaustive list of features enabled by "--enable-frills"
 163         (possibly in combination with other switches) is:
 164
 165           MWM-hints
 166           EWMH-hints (pid, utf8 names) and protocols (ping)
 167           seperate underline colour (-underlineColor)
 168           settable border widths and borderless switch (-w, -b, -bl)
 169           visual depth selection (-depth)
 170           settable extra linespacing /-lsp)
 171           iso-14755-2 and -3, and visual feedback
 172           tripleclickwords (-tcw)
 173           settable insecure mode (-insecure)
 174           keysym remapping support
 175           cursor blinking and underline cursor (-cb, -uc)
 176           XEmbed support (-embed)
 177           user-pty (-pty-fd)
 178           hold on exit (-hold)
 179           skip builtin block graphics (-sbg)
 180           separate highlightcolor support (-hc)
 181
 182         It also enables some non-essential features otherwise disabled, such
 183         as:
 184
 185           some round-trip time optimisations
 186           nearest color allocation on pseudocolor screens
 187           UTF8_STRING supporr for selection
 188           sgr modes 90..97 and 100..107
 189           backindex and forwardindex escape sequences
 190           view change/zero scorllback esacpe sequences
 191           locale switching escape sequence
 192           window op and some xterm/OSC escape sequences
 193           rectangular selections
 194           trailing space removal for selections
 195           verbose X error handling
 196
 197     --enable-iso14755 (default: on)
 198         Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt).
 199         Basic support (section 5.1) is enabled by "--enable-frills", while
 200         support for 5.2, 5.3 and 5.4 is enabled with this switch.
 201
 202     --enable-keepscrolling (default: on)
 203         Add support for continual scrolling of the display when you hold the
 204         mouse button down on a scrollbar arrow.
 205
 206     --enable-mousewheel (default: on)
 207         Add support for scrolling via mouse wheel or buttons 4 & 5.
 208
 209     --enable-slipwheeling (default: on)
 210         Add support for continual scrolling (using the mouse wheel as an
 211         accelerator) while the control key is held down. This option
 212         requires --enable-mousewheel to also be specified.
 213
 214     --disable-new-selection
 215         Remove support for mouse selection style like that of xterm.
 216
 217     --enable-dmalloc (default: off)
 218         Use Gray Watson's malloc - which is good for debugging See
 219         <http://www.letters.com/dmalloc/> for details If you use either this
 220         or the next option, you may need to edit src/Makefile after
 221         compiling to point DINCLUDE and DLIB to the right places.
 222
 223         You can only use either this option and the following (should you
 224         use either) .
 225
 226     --enable-dlmalloc (default: off)
 227         Use Doug Lea's malloc - which is good for a production version See
 228         <http://g.oswego.edu/dl/html/malloc.html> for details.
 229
 230     --enable-smart-resize (default: on)
 231         Add smart growth/shrink behaviour when changing font size via hot
 232         keys. This should keep the window corner which is closest to a
 233         corner of the screen in a fixed position.
 234
 235     --enable-pointer-blank (default: on)
 236         Add support to have the pointer disappear when typing or inactive.
 237
 238     --enable-perl (default: on)
 239         Enable an embedded perl interpreter. See the rxvtperl(3) manpage
 240         (doc/rxvtperl.txt) for more info on this feature, or the files in
 241         src/perl-ext/ for the extensions that are installed by default. The
 242         perl interpreter that is used can be specified via the "PERL"
 243         environment variable when running configure.
 244
 245     --with-name=NAME (default: urxvt)
 246         Set the basename for the installed binaries, resulting in "urxvt",
 247         "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
 248
 249     --with-term=NAME (default: rxvt-unicode)
 250         Change the environmental variable for the terminal to NAME.
 251
 252     --with-terminfo=PATH
 253         Change the environmental variable for the path to the terminfo tree
 254         to PATH.
 255
 256     --with-x
 257         Use the X Window System (pretty much default, eh?).
 258
 259     --with-xpm-includes=DIR
 260         Look for the XPM includes in DIR.
 261
 262     --with-xpm-library=DIR
 263         Look for the XPM library in DIR.
 264
 265     --with-xpm
 266         Not needed - define via --enable-xpm-background.
 267