3957e37ec43c4216f519d1065d0a3b54643a05d3
[dana/urxvt.git] / 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, vn
26         are always compiled in, which includes most 8-bit character sets).
27         These codeset tables are currently only used for driving X11 core
28         fonts, they are not required for Xft fonts. Compiling them in will
29         make your binary bigger (together about 700kB), but it doesn't
30         increase memory usage unless you use an X11 font requiring one of
31         these encodings.
32
33            all             all available codeset groups 
34            zh              common chinese encodings 
35            zh_ext          rarely used but very big chinese encodigs 
36            jp              common japanese encodings 
37            jp_ext          rarely used but big japanese encodings 
38            kr              korean encodings 
39
40     --enable-xim
41         Add support for XIM (X Input Method) protocol. This allows using
42         alternative input methods (e.g. kinput2) and will also correctly set
43         up the input for people using dead keys or compose keys.
44
45     --enable-unicode3
46         Enable direct support for displaying unicode codepoints above 65535
47         (the basic multilingual page). This increases storage requirements
48         per character from 2 to 4 bytes. X11 fonts do not yet support these
49         extra characters, but Xft does.
50
51         Please note that rxvt-unicode can store unicode code points >65535
52         even without this flag, but the number of such characters is limited
53         to a view thousand (shared with combining characters, see next
54         switch), and right now rxvt-unicode cannot display them
55         (input/output and cut&paste still work, though).
56
57     --enable-combining
58         Enable automatic composition of combining characters into composite
59         characters. This is required for proper viewing of text where
60         accents are encoded as seperate unicode characters. This is done by
61         using precomposited characters when available or creating new
62         pseudo-characters when no precomposed form exists.
63
64         Without --enable-unicode3, the number of additional precomposed
65         characters is rather limited (2048, if this is full, rxvt will use
66         the private use area, extending the number of combinations to 8448).
67         With --enable-unicode3, no practical limit exists. This will also
68         enable storage of characters >65535.
69
70         The combining table also contains entries for arabic presentation
71         forms, but these are not currently used. Bug me if you want these to
72         be used.
73
74     --enable-fallback(=CLASS)
75         When reading resource settings, also read settings for class CLASS
76         (default: Rxvt). To disable resource fallback use
77         --disable-fallback.
78
79     --with-res-name=NAME
80         Use the given name (default: urxvt) as default application name when
81         reading resources. Specify --with-res-name=rxvt to replace rxvt.
82
83     --with-res-class=CLASS
84         Use the given class (default: URxvt) as default application class
85         when reading resources. Specify --with-res-class=Rxvt to replace
86         rxvt.
87
88     --enable-utmp
89         Write user and tty to utmp file (used by programs like w) at start
90         of rxvt execution and delete information when rxvt exits.
91
92     --enable-wtmp
93         Write user and tty to wtmp file (used by programs like last) at
94         start of rxvt execution and write logout when rxvt exits. This
95         option requires --enable-utmp to also be specified.
96
97     --enable-lastlog
98         Write user and tty to lastlog file (used by programs like lastlogin)
99         at start of rxvt execution. This option requires --enable-utmp to
100         also be specified.
101
102     --enable-xpm-background
103         Add support for XPM background pixmaps.
104
105     --enable-transparency
106         Add support for inheriting parent backgrounds thus giving a fake
107         transparency to the term.
108
109     --enable-fading
110         Add support for fading the text when focus is lost.
111
112     --enable-tinting
113         Add support for tinting of transparent backgrounds.
114
115     --enable-menubar
116         Add support for our menu bar system (this interacts badly with
117         dynamic locale switching currently).
118
119     --enable-rxvt-scroll
120         Add support for the original rxvt scrollbar.
121
122     --enable-next-scroll
123         Add support for a NeXT-like scrollbar.
124
125     --enable-xterm-scroll
126         Add support for an Xterm-like scrollbar.
127
128     --enable-plain-scroll
129         Add support for a very unobtrusive, plain-looking scrollbar that is
130         the favourite of the rxvt-unicode author, having used it for many
131         years.
132
133     --enable-half-shadow
134         Make shadows on the scrollbar only half the normal width & height.
135         only applicable to rxvt scrollbars.
136
137     --enable-ttygid
138         Change tty device setting to group "tty" - only use this if your
139         system uses this type of security.
140
141     --disable-backspace-key
142         Disable any handling of the backspace key by us - let the X server
143         do it.
144
145     --disable-delete-key
146         Disable any handling of the delete key by us - let the X server do
147         it.
148
149     --disable-resources
150         Remove all resources checking.
151
152     --enable-xgetdefault
153         Make resources checking via XGetDefault() instead of our small
154         version which only checks ~/.Xdefaults, or if that doesn't exist
155         then ~/.Xresources.
156
157     --enable-strings
158         Add support for our possibly faster memset() function and other
159         various routines, overriding your system's versions which may have
160         been hand-crafted in assembly or may require extra libraries to link
161         in. (this breaks ANSI-C rules and has problems on many GNU/Linux
162         systems).
163
164     --disable-swapscreen
165         Remove support for swap screen.
166
167     --enable-frills
168         Add support for many small features that are not essential but nice
169         to have. Normally you want this, but for very small binaries you may
170         want to disable this.
171
172         A non-exhaustive list of features enabled by "--enable-frills"
173         (possibly in combination with other switches) is:
174
175           MWM-hints
176           seperate underline colour
177           settable border widths and borderless switch
178           settable extra linespacing
179           extra window properties (e.g. UTF-8 window names and PID)
180           iso-14755-2 and -3, and visual feedback
181           backindex and forwardindex escape sequence
182           window op and locale change escape sequences
183           tripleclickwords
184           settable insecure mode
185
186     --enable-iso14755
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
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
196         Add support for scrolling via mouse wheel or buttons 4 & 5.
197
198     --enable-slipwheeling
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
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
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
220         Add smart growth/shrink behaviour when changing font size via from
221         hot keys. This should keep in a fixed position the rxvt corner which
222         is closest to a corner of the screen.
223
224     --enable-cursor-blink
225         Add support for a blinking cursor.
226
227     --enable-pointer-blank
228         Add support to have the pointer disappear when typing or inactive.
229
230     --with-name=NAME
231         Set the basename for the installed binaries (default: "urxvt",
232         resulting in "urxvt", "urxvtd" etc.). Specify "--with-name=rxvt" to
233         replace with "rxvt".
234
235     --with-term=NAME
236         Change the environmental variable for the terminal to NAME (default
237         "rxvt-unicode")
238
239     --with-terminfo=PATH
240         Change the environmental variable for the path to the terminfo tree
241         to PATH.
242
243     --with-x
244         Use the X Window System (pretty much default, eh?).
245
246     --with-xpm-includes=DIR
247         Look for the XPM includes in DIR.
248
249     --with-xpm-library=DIR
250         Look for the XPM library in DIR.
251
252     --with-xpm
253         Not needed - define via --enable-xpm-background.
254