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. "--enable-xxx" or "--disable-xxx"). Of
   5     course, you should always report when a combination doesn't work, so it
   6     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-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-ttygid (default: off)
 139         Change tty device setting to group "tty" - only use this if your
 140         system uses this type of security.
 141
 142     --disable-backspace-key
 143         Removes any handling of the backspace key by us - let the X server
 144         do it.
 145
 146     --disable-delete-key
 147         Removes any handling of the delete key by us - let the X server do
 148         it.
 149
 150     --disable-resources
 151         Removes any support for resource checking.
 152
 153     --disable-swapscreen
 154         Remove support for secondary/swap screen.
 155
 156     --enable-frills (default: on)
 157         Add support for many small features that are not essential but nice
 158         to have. Normally you want this, but for very small binaries you may
 159         want to disable this.
 160
 161         A non-exhaustive list of features enabled by "--enable-frills"
 162         (possibly in combination with other switches) is:
 163
 164           MWM-hints
 165           EWMH-hints (pid, utf8 names) and protocols (ping)
 166           urgency hint
 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 5.1 (basic) support
 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 support for selection
 188           sgr modes 90..97 and 100..107
 189           backindex and forwardindex escape sequences
 190           view change/zero scrollback escape 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. Even when compiled in,
 244         perl will *not* be initialised when all extensions have been
 245         disabled "-pe "" --perl-ext-common """, so it should be safe to
 246         enable from a resource standpoint.
 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
 262     --with-xpm-includes=DIR
 263         Look for the XPM includes in DIR.
 264
 265     --with-xpm-library=DIR
 266         Look for the XPM library in DIR.
 267
 268     --with-xpm
 269         Not needed - define via --enable-xpm-background.
 270