55cee87191a27a7deb43675a4ef04b8afc194693
[dana/urxvt.git] / README.configure
1 --enable-everything
2         add support for all non-multichoice options listed in "./configure
3         --help".  Note that unlike other enable options this is order
4         dependant.  You can specify this and then disable options which
5         this enables by _following_ this with the appropriate commands.
6 --enable-xft
7         add support for xft (anti-aliases, among others) fonts. xft fonts are
8         slower and require lots of memory, but as long as you don't use them,
9         you don't pay for them.
10 --with-codesets=NAME,...
11         compile in support for additional codeset groups:
12         jp      common japanese encodings
13         jp_ext  rarely used but big japanese encodings
14         kr      korean encodings
15         cn      common chinese encodings
16         cn_ext  rarely used but very big chinese encodigs
17         all     all of the above
18 --enable-unicode3
19         enable support for unicode codepoints above 65535 (the basic
20         multilingual page). This increases storage requirements per character
21         from 2 to 4 bytes and is not too useful as font support in X11 and Xft
22         is largely missing, although cut & paste will work correctly, as will
23         displaying, if you have the right font(s).
24 --enable-utmp
25         write user and tty to utmp file (used by programs like ``w'') at
26         start of rxvt execution and delete information when rxvt exits.
27 --enable-wtmp
28         write user and tty to wtmp file (used by programs like ``last'') at
29         start of rxvt execution and write logout when rxvt exits.  This
30         option requires --enable-utmp to also be specified.
31 --enable-lastlog
32         write user and tty to lastlog file (used by programs like
33         ``lastlogin'') at start of rxvt execution.  This option requires
34         --enable-utmp to also be specified.
35 --enable-xpm-background
36         add support for XPM background pixmaps
37 --enable-transparency
38         add support for inheriting parent backgrounds thus giving a fake
39         transparency to the term
40 --enable-menubar
41         add support for our menu bar system (this interacts badly with
42         dynamic locale switching currently)
43 --enable-rxvt-scroll
44         add support for the original rxvt scrollbar
45 --enable-next-scroll
46         add support for a NeXT-like scrollbar
47 --enable-xterm-scroll
48         add support for an Xterm-like scrollbar
49 --enable-plain-scroll
50         add support for a very unobtrusive, plain-looking scrollbar that
51         is the favourite of the rxvt-unicode author, having used it for
52         many years.
53 --enable-half-shadow
54         make shadows on the scrollbar only half the normal width & height.
55         only applicable to rxvt scrollbars
56 --enable-xim
57         add support for XIM (X Input Method) protocol. This allows using
58         alternative input methods (e.g. kinput2) and will also correctly
59         set up the input for people using dead keys or compose keys.
60 --enable-ttygid
61         change tty device setting to group "tty" - only use this if
62         your system uses this type of security
63 --disable-backspace-key
64         disable any handling of the backspace key by us - let the X server
65         do it
66 --disable-delete-key
67         disable any handling of the delete key by us - let the X server
68         do it
69 --disable-resources
70         remove all resources checking
71 --enable-xgetdefault
72         make resources checking via XGetDefault() instead of our small
73         version which only checks ~/.Xdefaults, or if that doesn't exist
74         then ~/.Xresources
75 --enable-strings
76         add support for our possibly faster memset() function and other
77         various routines, overriding your system's versions which may
78         have been hand-crafted in assembly or may require extra libraries
79         to link in. (this breaks ANSI-C rules and has problems on many
80         GNU/Linux systems).
81 --disable-swapscreen
82         remove support for swap screen
83 --enable-frills
84         add support for some lesser used features
85 --enable-linespace
86         add support to provide user specified line spacing between text rows
87 --enable-keepscrolling
88         add support for continual scrolling of the display when you hold
89         the mouse button down on a scrollbar arrow
90 --enable-mousewheel
91         add support for scrolling via mouse wheel or buttons 4 & 5
92 --enable-slipwheeling
93         add support for continual scrolling (using the mouse wheel as an
94         accelerator) while the control key is held down.  This option
95         requires --enable-mousewheel to also be specified.
96 --enable-old-selection
97         remove support for reverting the mouse selection style to that
98         of v2.20 (and prior)
99 --disable-new-selection
100         remove support for mouse selection style like that of xterm
101 --enable-dmalloc
102         use Gray Watson's malloc - which is good for debugging
103         See  http://www.letters.com/dmalloc/  for details
104         If you use either this or the next option, you may need to
105         edit src/Makefile after compiling to point DINCLUDE and DLIB to
106         the right places.
107         You can only use either this option and the following (should
108         you use either) 
109 --enable-dlmalloc
110         use Doug Lea's malloc - which is good for a production version
111         See  http://g.oswego.edu/dl/html/malloc.html  for details
112 --enable-smart-resize
113         add smart growth/shrink behaviour when changing font size
114         via from hot keys.  This should keep in a fixed position the
115         rxvt corner which is closest to a corner of the screen
116 --enable-256-color
117         add support for 256 colours rather than the base 16 colours
118 --enable-cursor-blink
119         add support for a blinking cursor
120 --enable-pointer-blank
121         add support to have the pointer disappear when typing or inactive
122 --with-term=NAME
123         change the environmental variable for the terminal to NAME
124         (default "rxvt")
125 --with-terminfo=PATH
126         change the environmental variable for the path to the terminfo
127         tree to PATH
128 --with-x
129         use the X Window System (pretty much default, eh?)
130 --with-xpm-includes=DIR
131         look for the XPM includes in DIR
132 --with-xpm-library=DIR
133         look for the XPM library in DIR
134 --with-xpm
135         not needed - define via --enable-xpm-background
136