ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/README.configure
(Generate patch)

Comparing rxvt-unicode/README.configure (file contents):
Revision 1.34 by root, Mon Jan 2 15:11:05 2006 UTC vs.
Revision 1.75 by root, Thu May 10 22:42:03 2012 UTC

1CONFIGURE OPTIONS 1CONFIGURE OPTIONS
2 General hint: if you get compile errors, then likely your configuration 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 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 4 the default configuration (i.e. no "--enable-xxx" or "--disable-xxx"
5 myself, so it should generally be a working config. Of course, you 5 switches). Of course, you should always report when a combination
6 should always report when a combination doesn't work, so it can be
7 fixed. Marc Lehmann <rxvt@schmorp.de>. 6 doesn't work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
8 7
9 All 8 All
10 9
11 --enable-everything 10 --enable-everything
12 Add (or remove) support for all non-multichoice options listed in 11 Add (or remove) support for all non-multichoice options listed in
13 "./configure --help". 12 "./configure --help", except for "--enable-assert" and
13 "--enable-256-color".
14 14
15 You can specify this and then disable options you do not like by 15 You can specify this and then disable options you do not like by
16 *following* this with the appropriate "--disable-..." arguments, or 16 *following* this with the appropriate "--disable-..." arguments, or
17 you can start with a minimal configuration by specifying 17 you can start with a minimal configuration by specifying
18 "--disable-everything" and than adding just the "--enable-..." 18 "--disable-everything" and than adding just the "--enable-..."
19 arguments you want. 19 arguments you want.
20 20
21 --enable-xft (default: enabled) 21 --enable-xft (default: on)
22 Add support for Xft (anti-aliases, among others) fonts. Xft fonts 22 Add support for Xft (anti-aliased, among others) fonts. Xft fonts
23 are slower and require lots of memory, but as long as you don't use 23 are slower and require lots of memory, but as long as you don't use
24 them, you don't pay for them. 24 them, you don't pay for them.
25 25
26 --enable-font-styles (default: on) 26 --enable-font-styles (default: on)
27 Add support for bold, *italic* and *bold italic* font styles. The 27 Add support for bold, *italic* and *bold italic* font styles. The
28 fonts can be set manually or automatically. 28 fonts can be set manually or automatically.
29 29
30 --with-codesets=NAME,... (default: all) 30 --with-codesets=CS,... (default: all)
31 Compile in support for additional codeset (encoding) groups ("eu", 31 Compile in support for additional codeset (encoding) groups ("eu",
32 "vn" are always compiled in, which includes most 8-bit character 32 "vn" are always compiled in, which includes most 8-bit character
33 sets). These codeset tables are used for driving X11 core fonts, 33 sets). These codeset tables are used for driving X11 core fonts,
34 they are not required for Xft fonts, although having them compiled 34 they are not required for Xft fonts, although having them compiled
35 in lets rxvt-unicode choose replacement fonts more intelligently. 35 in lets rxvt-unicode choose replacement fonts more intelligently.
36 Compiling them in will make your binary bigger (all of together cost 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 37 about 700kB), but it doesn't increase memory usage unless you use a
38 font requiring one of these encodings. 38 font requiring one of these encodings.
39 39
40 all all available codeset groups 40 all all available codeset groups
41 zh common chinese encodings 41 zh common chinese encodings
42 zh_ext rarely used but very big chinese encodigs 42 zh_ext rarely used but very big chinese encodings
43 jp common japanese encodings 43 jp common japanese encodings
44 jp_ext rarely used but big japanese encodings 44 jp_ext rarely used but big japanese encodings
45 kr korean encodings 45 kr korean encodings
46
47 --enable-xim (default: on) 46 --enable-xim (default: on)
48 Add support for XIM (X Input Method) protocol. This allows using 47 Add support for XIM (X Input Method) protocol. This allows using
49 alternative input methods (e.g. kinput2) and will also correctly set 48 alternative input methods (e.g. kinput2) and will also correctly set
50 up the input for people using dead keys or compose keys. 49 up the input for people using dead keys or compose keys.
51 50
52 --enable-unicode3 (default: off) 51 --enable-unicode3 (default: off)
52 Recommended to stay off unless you really need non-BMP characters.
53
53 Enable direct support for displaying unicode codepoints above 65535 54 Enable direct support for displaying unicode codepoints above 65535
54 (the basic multilingual page). This increases storage requirements 55 (the basic multilingual page). This increases storage requirements
55 per character from 2 to 4 bytes. X11 fonts do not yet support these 56 per character from 2 to 4 bytes. X11 fonts do not yet support these
56 extra characters, but Xft does. 57 extra characters, but Xft does.
57 58
58 Please note that rxvt-unicode can store unicode code points >65535 59 Please note that rxvt-unicode can store unicode code points >65535
59 even without this flag, but the number of such characters is limited 60 even without this flag, but the number of such characters is limited
60 to a view thousand (shared with combining characters, see next 61 to a few thousand (shared with combining characters, see next
61 switch), and right now rxvt-unicode cannot display them 62 switch), and right now rxvt-unicode cannot display them
62 (input/output and cut&paste still work, though). 63 (input/output and cut&paste still work, though).
63 64
64 --enable-combining (default: on) 65 --enable-combining (default: on)
65 Enable automatic composition of combining characters into composite 66 Enable automatic composition of combining characters into composite
66 characters. This is required for proper viewing of text where 67 characters. This is required for proper viewing of text where
67 accents are encoded as seperate unicode characters. This is done by 68 accents are encoded as separate unicode characters. This is done by
68 using precomposited characters when available or creating new 69 using precomposed characters when available or creating new
69 pseudo-characters when no precomposed form exists. 70 pseudo-characters when no precomposed form exists.
70 71
71 Without --enable-unicode3, the number of additional precomposed 72 Without --enable-unicode3, the number of additional precomposed
72 characters is rather limited (2048, if this is full, rxvt-unicode 73 characters is somewhat limited (the 6400 private use characters will
73 will use the private use area, extending the number of combinations
74 to 8448). With --enable-unicode3, no practical limit exists. 74 be (ab-)used). With --enable-unicode3, no practical limit exists.
75 75
76 This option will also enable storage (but not display) of characters 76 This option will also enable storage (but not display) of characters
77 beyond plane 0 (>65535) when --enable-unicode3 was not specified. 77 beyond plane 0 (>65535) when --enable-unicode3 was not specified.
78 78
79 The combining table also contains entries for arabic presentation 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 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...). 81 be used (and tell me how these are to be used...).
82 82
83 --enable-fallback(=CLASS) (default: Rxvt) 83 --enable-fallback[=CLASS] (default: Rxvt)
84 When reading resource settings, also read settings for class CLASS. 84 When reading resource settings, also read settings for class CLASS.
85 To disable resource fallback use --disable-fallback. 85 To disable resource fallback use --disable-fallback.
86 86
87 --with-res-name=NAME (default: urxvt) 87 --with-res-name=NAME (default: urxvt)
88 Use the given name as default application name when reading 88 Use the given name as default application name when reading
89 resources. Specify --with-res-name=rxvt to replace rxvt. 89 resources. Specify --with-res-name=rxvt to replace rxvt.
90 90
91 --with-res-class=CLASS /default: URxvt) 91 --with-res-class=CLASS (default: URxvt)
92 Use the given class as default application class when reading 92 Use the given class as default application class when reading
93 resources. Specify --with-res-class=Rxvt to replace rxvt. 93 resources. Specify --with-res-class=Rxvt to replace rxvt.
94 94
95 --enable-utmp (default: on) 95 --enable-utmp (default: on)
96 Write user and tty to utmp file (used by programs like w) at start 96 Write user and tty to utmp file (used by programs like w) at start
104 --enable-lastlog (default: on) 104 --enable-lastlog (default: on)
105 Write user and tty to lastlog file (used by programs like lastlogin) 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 106 at start of rxvt execution. This option requires --enable-utmp to
107 also be specified. 107 also be specified.
108 108
109 --enable-xpm-background (default: off) 109 --enable-pixbuf (default: on)
110 Add support for XPM background pixmaps. 110 Add support for GDK-PixBuf to be used for background images. It adds
111 support for many file formats including JPG, PNG, TIFF, GIF, XPM,
112 BMP, ICO and TGA.
111 113
114 --enable-startup-notification (default: on)
115 Add support for freedesktop startup notifications. This allows
116 window managers to display some kind of progress indicator during
117 startup.
118
112 --enable-transparency (default: off) 119 --enable-transparency (default: on)
113 Add support for inheriting parent backgrounds thus giving a fake 120 Add support for using the root pixmap as background to simulate
114 transparency to the term. 121 transparency. Note that blur and blend effects depend on libXrender
122 and on the availability of the RENDER extension in the X server.
115 123
116 --enable-fading (default: on) 124 --enable-fading (default: on)
117 Add support for fading the text when focus is lost (requires 125 Add support for fading the text when focus is lost.
118 "--enable-transparency").
119
120 --enable-tinting (default: on)
121 Add support for tinting of transparent backgrounds (requires
122 "--enable-transparency").
123
124 --enable-menubar (default: off)
125 Add support for our menu bar system (this interacts badly with
126 dynamic locale switching currently).
127 126
128 --enable-rxvt-scroll (default: on) 127 --enable-rxvt-scroll (default: on)
129 Add support for the original rxvt scrollbar. 128 Add support for the original rxvt scrollbar.
130 129
131 --enable-next-scroll (default: on) 130 --enable-next-scroll (default: on)
132 Add support for a NeXT-like scrollbar. 131 Add support for a NeXT-like scrollbar.
133 132
134 --enable-xterm-scroll (default: on) 133 --enable-xterm-scroll (default: on)
135 Add support for an Xterm-like scrollbar. 134 Add support for an Xterm-like scrollbar.
136
137 --enable-plain-scroll (default: on)
138 Add support for a very unobtrusive, plain-looking scrollbar that is
139 the favourite of the rxvt-unicode author, having used it for many
140 years.
141
142 --enable-half-shadow (default: off)
143 Make shadows on the scrollbar only half the normal width & height.
144 only applicable to rxvt scrollbars.
145
146 --enable-ttygid (default: off)
147 Change tty device setting to group "tty" - only use this if your
148 system uses this type of security.
149 135
150 --disable-backspace-key 136 --disable-backspace-key
151 Removes any handling of the backspace key by us - let the X server 137 Removes any handling of the backspace key by us - let the X server
152 do it. 138 do it.
153 139
155 Removes any handling of the delete key by us - let the X server do 141 Removes any handling of the delete key by us - let the X server do
156 it. 142 it.
157 143
158 --disable-resources 144 --disable-resources
159 Removes any support for resource checking. 145 Removes any support for resource checking.
160
161 --enable-xgetdefault
162 Make resources checking via XGetDefault() instead of our small
163 version which only checks ~/.Xdefaults, or if that doesn't exist
164 then ~/.Xresources.
165
166 Please note that nowadays, things like XIM will automatically pull
167 in and use the full X resource manager, so the overhead of using it
168 might be very small, if nonexistant.
169
170 --enable-strings (default: off)
171 Add support for our possibly faster memset() function and other
172 various routines, overriding your system's versions which may have
173 been hand-crafted in assembly or may require extra libraries to link
174 in. (this breaks ANSI-C rules and has problems on many GNU/Linux
175 systems).
176 146
177 --disable-swapscreen 147 --disable-swapscreen
178 Remove support for secondary/swap screen. 148 Remove support for secondary/swap screen.
179 149
180 --enable-frills (default: on) 150 --enable-frills (default: on)
185 A non-exhaustive list of features enabled by "--enable-frills" 155 A non-exhaustive list of features enabled by "--enable-frills"
186 (possibly in combination with other switches) is: 156 (possibly in combination with other switches) is:
187 157
188 MWM-hints 158 MWM-hints
189 EWMH-hints (pid, utf8 names) and protocols (ping) 159 EWMH-hints (pid, utf8 names) and protocols (ping)
160 urgency hint
190 seperate underline colour 161 separate underline colour (-underlineColor)
191 settable border widths and borderless switch 162 settable border widths and borderless switch (-w, -b, -bl)
163 visual depth selection (-depth)
192 settable extra linespacing 164 settable extra linespacing (-lsp)
193 iso-14755-2 and -3, and visual feedback 165 iso-14755 5.1 (basic) support
166 tripleclickwords (-tcw)
167 settable insecure mode (-insecure)
168 keysym remapping support
169 cursor blinking and underline cursor (-bc, -uc)
170 XEmbed support (-embed)
171 user-pty (-pty-fd)
172 hold on exit (-hold)
173 compile in built-in block graphics
174 skip builtin block graphics (-sbg)
175 separate highlight colour (-highlightColor, -highlightTextColor)
176 extended mouse reporting modes (1005 and 1015).
177
178 It also enables some non-essential features otherwise disabled, such
179 as:
180
181 some round-trip time optimisations
182 nearest colour allocation on pseudocolor screens
183 UTF8_STRING support for selection
184 sgr modes 90..97 and 100..107
194 backindex and forwardindex escape sequence 185 backindex and forwardindex escape sequences
186 view change/zero scrollback escape sequences
187 locale switching escape sequence
195 window op and some xterm/OSC escape sequences 188 window op and some xterm/OSC escape sequences
196 tripleclickwords 189 rectangular selections
197 settable insecure mode 190 trailing space removal for selections
198 keysym remapping support 191 verbose X error handling
199 cursor blinking and underline cursor
200 -embed, -pty-fd and -hold options
201 192
202 --enable-iso14755 (default: on) 193 --enable-iso14755 (default: on)
203 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt). 194 Enable extended ISO 14755 support (see rxvt(1)). Basic support
204 Basic support (section 5.1) is enabled by "--enable-frills", while 195 (section 5.1) is enabled by "--enable-frills", while support for
205 support for 5.2, 5.3 and 5.4 is enabled with this switch. 196 5.2, 5.3 and 5.4 is enabled with this switch.
206 197
207 --enable-keepscrolling (default: on) 198 --enable-keepscrolling (default: on)
208 Add support for continual scrolling of the display when you hold the 199 Add support for continual scrolling of the display when you hold the
209 mouse button down on a scrollbar arrow. 200 mouse button down on a scrollbar arrow.
201
202 --enable-selectionscrolling (default: on)
203 Add support for scrolling when the selection moves to the top or
204 bottom of the screen.
210 205
211 --enable-mousewheel (default: on) 206 --enable-mousewheel (default: on)
212 Add support for scrolling via mouse wheel or buttons 4 & 5. 207 Add support for scrolling via mouse wheel or buttons 4 & 5.
213 208
214 --enable-slipwheeling (default: on) 209 --enable-slipwheeling (default: on)
215 Add support for continual scrolling (using the mouse wheel as an 210 Add support for continual scrolling (using the mouse wheel as an
216 accelerator) while the control key is held down. This option 211 accelerator) while the control key is held down. This option
217 requires --enable-mousewheel to also be specified. 212 requires --enable-mousewheel to also be specified.
218 213
219 --disable-new-selection
220 Remove support for mouse selection style like that of xterm.
221
222 --enable-dmalloc (default: off)
223 Use Gray Watson's malloc - which is good for debugging See
224 http://www.letters.com/dmalloc/ for details If you use either this
225 or the next option, you may need to edit src/Makefile after
226 compiling to point DINCLUDE and DLIB to the right places.
227
228 You can only use either this option and the following (should you
229 use either) .
230
231 --enable-dlmalloc (default: off)
232 Use Doug Lea's malloc - which is good for a production version See
233 <http://g.oswego.edu/dl/html/malloc.html> for details.
234
235 --enable-smart-resize (default: on) 214 --enable-smart-resize (default: off)
236 Add smart growth/shrink behaviour when changing font size via hot 215 Add smart growth/shrink behaviour when resizing. This should keep
237 keys. This should keep the window corner which is closest to a 216 the window corner which is closest to a corner of the screen in a
238 corner of the screen in a fixed position. 217 fixed position.
218
219 --enable-text-blink (default: on)
220 Add support for blinking text.
239 221
240 --enable-pointer-blank (default: on) 222 --enable-pointer-blank (default: on)
241 Add support to have the pointer disappear when typing or inactive. 223 Add support to have the pointer disappear when typing or inactive.
224
225 --enable-perl (default: on)
226 Enable an embedded perl interpreter. See the rxvtperl(3) manpage for
227 more info on this feature, or the files in src/perl/ for the
228 extensions that are installed by default. The perl interpreter that
229 is used can be specified via the "PERL" environment variable when
230 running configure. Even when compiled in, perl will *not* be
231 initialised when all extensions have been disabled "-pe ""
232 --perl-ext-common """, so it should be safe to enable from a
233 resource standpoint.
234
235 --enable-assert (default: off)
236 Enables the assertions in the code, normally disabled. This switch
237 is only useful when developing rxvt-unicode.
238
239 --enable-256-color (default: off)
240 Force use of so-called 256 colour mode, to work around buggy
241 applications that do not support termcap/terminfo, or simply improve
242 support for applications hardcoding the xterm 256 colour table.
243
244 This switch breaks termcap/terminfo compatibility to
245 "TERM=rxvt-unicode", and consequently sets "TERM" to
246 "rxvt-unicode-256color" by default (doc/etc/ contains
247 termcap/terminfo definitions for both).
248
249 It also results in higher memory usage and can slow down rxvt
250 dramatically when more than six fonts are in use by a terminal
251 instance.
242 252
243 --with-name=NAME (default: urxvt) 253 --with-name=NAME (default: urxvt)
244 Set the basename for the installed binaries, resulting in "urxvt", 254 Set the basename for the installed binaries, resulting in "urxvt",
245 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt". 255 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
246 256
252 to PATH. 262 to PATH.
253 263
254 --with-x 264 --with-x
255 Use the X Window System (pretty much default, eh?). 265 Use the X Window System (pretty much default, eh?).
256 266
257 --with-xpm-includes=DIR
258 Look for the XPM includes in DIR.
259
260 --with-xpm-library=DIR
261 Look for the XPM library in DIR.
262
263 --with-xpm
264 Not needed - define via --enable-xpm-background.
265

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines