*** empty log message ***
[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-unicode
66         will use the private use area, extending the number of combinations
67         to 8448). With --enable-unicode3, no practical limit exists.
68
69         This option will also enable storage (but not display) of characters
70         beyond plane 0 (>65535) when --enable-unicode3 was not specified.
71
72         The combining table also contains entries for arabic presentation
73         forms, but these are not currently used. Bug me if you want these to
74         be used (and tell me how these are to be used...).
75
76     --enable-fallback(=CLASS)
77         When reading resource settings, also read settings for class CLASS
78         (default: Rxvt). To disable resource fallback use
79         --disable-fallback.
80
81     --with-res-name=NAME
82         Use the given name (default: urxvt) as default application name when
83         reading resources. Specify --with-res-name=rxvt to replace rxvt.
84
85     --with-res-class=CLASS
86         Use the given class (default: URxvt) as default application class
87         when reading resources. Specify --with-res-class=Rxvt to replace
88         rxvt.
89
90     --enable-utmp
91         Write user and tty to utmp file (used by programs like w) at start
92         of rxvt execution and delete information when rxvt exits.
93
94     --enable-wtmp
95         Write user and tty to wtmp file (used by programs like last) at
96         start of rxvt execution and write logout when rxvt exits. This
97         option requires --enable-utmp to also be specified.
98
99     --enable-lastlog
100         Write user and tty to lastlog file (used by programs like lastlogin)
101         at start of rxvt execution. This option requires --enable-utmp to
102         also be specified.
103
104     --enable-xpm-background
105         Add support for XPM background pixmaps.
106
107     --enable-transparency
108         Add support for inheriting parent backgrounds thus giving a fake
109         transparency to the term.
110
111     --enable-fading
112         Add support for fading the text when focus is lost.
113
114     --enable-tinting
115         Add support for tinting of transparent backgrounds.
116
117     --enable-menubar
118         Add support for our menu bar system (this interacts badly with
119         dynamic locale switching currently).
120
121     --enable-rxvt-scroll
122         Add support for the original rxvt scrollbar.
123
124     --enable-next-scroll
125         Add support for a NeXT-like scrollbar.
126
127     --enable-xterm-scroll
128         Add support for an Xterm-like scrollbar.
129
130     --enable-plain-scroll
131         Add support for a very unobtrusive, plain-looking scrollbar that is
132         the favourite of the rxvt-unicode author, having used it for many
133         years.
134
135     --enable-half-shadow
136         Make shadows on the scrollbar only half the normal width & height.
137         only applicable to rxvt scrollbars.
138
139     --enable-ttygid
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         Disable any handling of the backspace key by us - let the X server
145         do it.
146
147     --disable-delete-key
148         Disable any handling of the delete key by us - let the X server do
149         it.
150
151     --disable-resources
152         Remove all resources checking.
153
154     --enable-xgetdefault
155         Make resources checking via XGetDefault() instead of our small
156         version which only checks ~/.Xdefaults, or if that doesn't exist
157         then ~/.Xresources.
158
159         Please note that nowadays, things like XIM will automatically pull
160         in and use the full X resource manager, so the overhead of using it
161         might be very small, if nonexistant.
162
163     --enable-strings
164         Add support for our possibly faster memset() function and other
165         various routines, overriding your system's versions which may have
166         been hand-crafted in assembly or may require extra libraries to link
167         in. (this breaks ANSI-C rules and has problems on many GNU/Linux
168         systems).
169
170     --disable-swapscreen
171         Remove support for swap screen.
172
173     --enable-frills
174         Add support for many small features that are not essential but nice
175         to have. Normally you want this, but for very small binaries you may
176         want to disable this.
177
178         A non-exhaustive list of features enabled by "--enable-frills"
179         (possibly in combination with other switches) is:
180
181           MWM-hints
182           seperate underline colour
183           settable border widths and borderless switch
184           settable extra linespacing
185           extra window properties (e.g. UTF-8 window names and PID)
186           iso-14755-2 and -3, and visual feedback
187           backindex and forwardindex escape sequence
188           window op and locale change escape sequences
189           tripleclickwords
190           settable insecure mode
191           keysym remapping support
192
193     --enable-iso14755
194         Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt).
195         Basic support (section 5.1) is enabled by "--enable-frills", while
196         support for 5.2, 5.3 and 5.4 is enabled with this switch.
197
198     --enable-keepscrolling
199         Add support for continual scrolling of the display when you hold the
200         mouse button down on a scrollbar arrow.
201
202     --enable-mousewheel
203         Add support for scrolling via mouse wheel or buttons 4 & 5.
204
205     --enable-slipwheeling
206         Add support for continual scrolling (using the mouse wheel as an
207         accelerator) while the control key is held down. This option
208         requires --enable-mousewheel to also be specified.
209
210     --disable-new-selection
211         Remove support for mouse selection style like that of xterm.
212
213     --enable-dmalloc
214         Use Gray Watson's malloc - which is good for debugging See
215         http://www.letters.com/dmalloc/ for details If you use either this
216         or the next option, you may need to edit src/Makefile after
217         compiling to point DINCLUDE and DLIB to the right places.
218
219         You can only use either this option and the following (should you
220         use either) .
221
222     --enable-dlmalloc
223         Use Doug Lea's malloc - which is good for a production version See
224         <http://g.oswego.edu/dl/html/malloc.html> for details.
225
226     --enable-smart-resize
227         Add smart growth/shrink behaviour when changing font size via from
228         hot keys. This should keep in a fixed position the rxvt corner which
229         is closest to a corner of the screen.
230
231     --enable-cursor-blink
232         Add support for a blinking cursor.
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