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.38 by root, Sat Jan 7 04:19:43 2006 UTC vs.
Revision 1.73 by sf-exg, Sat Nov 19 11:00:20 2011 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-afterimage (default: on)
110 Add support for libAfterImage to be used for background images. It
111 adds support for many file formats including JPG, PNG, SVG, TIFF,
112 GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
113 (<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
114
115 Note that with this option enabled, rxvt's memory footprint might
116 increase by a few megabytes even if no extra features are used
117 (mostly due to third-party libraries used by libAI). Memory
118 footprint may somewhat be lowered if libAfterImage is configured
119 without support for SVG.
120
109 --enable-xpm-background (default: on) 121 --enable-pixbuf (default: on)
110 Add support for XPM background pixmaps. 122 Add support for GDK-PixBuf to be used for background images. It adds
123 support for many file formats including JPG, PNG, TIFF, GIF, XPM,
124 BMP, ICO and TGA.
125
126 --enable-startup-notification (default: on)
127 Add support for freedesktop startup notifications. This allows
128 window managers to display some kind of progress indicator during
129 startup.
111 130
112 --enable-transparency (default: on) 131 --enable-transparency (default: on)
113 Add support for inheriting parent backgrounds thus giving a fake 132 Add support for using the root pixmap as background to simulate
114 transparency to the term. 133 transparency. Note that blur and blend effects depend on
134 libAfterImage or on libXrender and on the availability of the RENDER
135 extension in the X server.
115 136
116 --enable-fading (default: on) 137 --enable-fading (default: on)
117 Add support for fading the text when focus is lost (requires 138 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) [DEPRECATED]
125 Add support for our menu bar system (this interacts badly with
126 dynamic locale switching currently). This option is DEPRECATED and
127 will be removed in the future.
128 139
129 --enable-rxvt-scroll (default: on) 140 --enable-rxvt-scroll (default: on)
130 Add support for the original rxvt scrollbar. 141 Add support for the original rxvt scrollbar.
131 142
132 --enable-next-scroll (default: on) 143 --enable-next-scroll (default: on)
133 Add support for a NeXT-like scrollbar. 144 Add support for a NeXT-like scrollbar.
134 145
135 --enable-xterm-scroll (default: on) 146 --enable-xterm-scroll (default: on)
136 Add support for an Xterm-like scrollbar. 147 Add support for an Xterm-like scrollbar.
137
138 --enable-plain-scroll (default: on)
139 Add support for a very unobtrusive, plain-looking scrollbar that is
140 the favourite of the rxvt-unicode author, having used it for many
141 years.
142
143 --enable-half-shadow (default: off)
144 Make shadows on the scrollbar only half the normal width & height.
145 only applicable to rxvt scrollbars.
146
147 --enable-ttygid (default: off)
148 Change tty device setting to group "tty" - only use this if your
149 system uses this type of security.
150 148
151 --disable-backspace-key 149 --disable-backspace-key
152 Removes any handling of the backspace key by us - let the X server 150 Removes any handling of the backspace key by us - let the X server
153 do it. 151 do it.
154 152
156 Removes any handling of the delete key by us - let the X server do 154 Removes any handling of the delete key by us - let the X server do
157 it. 155 it.
158 156
159 --disable-resources 157 --disable-resources
160 Removes any support for resource checking. 158 Removes any support for resource checking.
161
162 --enable-xgetdefault
163 Make resources checking via XGetDefault() instead of our small
164 version which only checks ~/.Xdefaults, or if that doesn't exist
165 then ~/.Xresources.
166
167 Please note that nowadays, things like XIM will automatically pull
168 in and use the full X resource manager, so the overhead of using it
169 might be very small, if nonexistant.
170
171 --enable-strings (default: off)
172 Add support for our possibly faster memset() function and other
173 various routines, overriding your system's versions which may have
174 been hand-crafted in assembly or may require extra libraries to link
175 in. (this breaks ANSI-C rules and has problems on many GNU/Linux
176 systems).
177 159
178 --disable-swapscreen 160 --disable-swapscreen
179 Remove support for secondary/swap screen. 161 Remove support for secondary/swap screen.
180 162
181 --enable-frills (default: on) 163 --enable-frills (default: on)
186 A non-exhaustive list of features enabled by "--enable-frills" 168 A non-exhaustive list of features enabled by "--enable-frills"
187 (possibly in combination with other switches) is: 169 (possibly in combination with other switches) is:
188 170
189 MWM-hints 171 MWM-hints
190 EWMH-hints (pid, utf8 names) and protocols (ping) 172 EWMH-hints (pid, utf8 names) and protocols (ping)
173 urgency hint
191 seperate underline colour (-underlineColor) 174 separate underline colour (-underlineColor)
192 settable border widths and borderless switch (-w, -b, -bl) 175 settable border widths and borderless switch (-w, -b, -bl)
176 visual depth selection (-depth)
193 settable extra linespacing /-lsp) 177 settable extra linespacing (-lsp)
194 iso-14755-2 and -3, and visual feedback 178 iso-14755 5.1 (basic) support
195 backindex and forwardindex escape sequence
196 window op and some xterm/OSC escape sequences
197 tripleclickwords (-tcw) 179 tripleclickwords (-tcw)
198 settable insecure mode (-insecure) 180 settable insecure mode (-insecure)
199 keysym remapping support 181 keysym remapping support
200 cursor blinking and underline cursor (-cb, -uc) 182 cursor blinking and underline cursor (-bc, -uc)
201 XEmbed support (-embed) 183 XEmbed support (-embed)
202 user-pty (-pty-fd) 184 user-pty (-pty-fd)
203 hold on exit (-hold) 185 hold on exit (-hold)
186 compile in built-in block graphics
204 skip builtin block graphics (-sbg) 187 skip builtin block graphics (-sbg)
188 separate highlight colour (-highlightColor, -highlightTextColor)
189 extended mouse reporting modes (1005 and 1015).
190
191 It also enables some non-essential features otherwise disabled, such
192 as:
193
194 some round-trip time optimisations
195 nearest colour allocation on pseudocolor screens
196 UTF8_STRING support for selection
205 sgr modes 90..97 and 100..107 197 sgr modes 90..97 and 100..107
198 backindex and forwardindex escape sequences
199 view change/zero scrollback escape sequences
200 locale switching escape sequence
201 window op and some xterm/OSC escape sequences
202 rectangular selections
203 trailing space removal for selections
204 verbose X error handling
206 205
207 --enable-iso14755 (default: on) 206 --enable-iso14755 (default: on)
208 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt). 207 Enable extended ISO 14755 support (see rxvt(1)). Basic support
209 Basic support (section 5.1) is enabled by "--enable-frills", while 208 (section 5.1) is enabled by "--enable-frills", while support for
210 support for 5.2, 5.3 and 5.4 is enabled with this switch. 209 5.2, 5.3 and 5.4 is enabled with this switch.
211 210
212 --enable-keepscrolling (default: on) 211 --enable-keepscrolling (default: on)
213 Add support for continual scrolling of the display when you hold the 212 Add support for continual scrolling of the display when you hold the
214 mouse button down on a scrollbar arrow. 213 mouse button down on a scrollbar arrow.
214
215 --enable-selectionscrolling (default: on)
216 Add support for scrolling when the selection moves to the top or
217 bottom of the screen.
215 218
216 --enable-mousewheel (default: on) 219 --enable-mousewheel (default: on)
217 Add support for scrolling via mouse wheel or buttons 4 & 5. 220 Add support for scrolling via mouse wheel or buttons 4 & 5.
218 221
219 --enable-slipwheeling (default: on) 222 --enable-slipwheeling (default: on)
220 Add support for continual scrolling (using the mouse wheel as an 223 Add support for continual scrolling (using the mouse wheel as an
221 accelerator) while the control key is held down. This option 224 accelerator) while the control key is held down. This option
222 requires --enable-mousewheel to also be specified. 225 requires --enable-mousewheel to also be specified.
223 226
224 --disable-new-selection
225 Remove support for mouse selection style like that of xterm.
226
227 --enable-dmalloc (default: off)
228 Use Gray Watson's malloc - which is good for debugging See
229 http://www.letters.com/dmalloc/ for details If you use either this
230 or the next option, you may need to edit src/Makefile after
231 compiling to point DINCLUDE and DLIB to the right places.
232
233 You can only use either this option and the following (should you
234 use either) .
235
236 --enable-dlmalloc (default: off)
237 Use Doug Lea's malloc - which is good for a production version See
238 <http://g.oswego.edu/dl/html/malloc.html> for details.
239
240 --enable-smart-resize (default: on) 227 --enable-smart-resize (default: off)
241 Add smart growth/shrink behaviour when changing font size via hot 228 Add smart growth/shrink behaviour when resizing. This should keep
242 keys. This should keep the window corner which is closest to a 229 the window corner which is closest to a corner of the screen in a
243 corner of the screen in a fixed position. 230 fixed position.
231
232 --enable-text-blink (default: on)
233 Add support for blinking text.
244 234
245 --enable-pointer-blank (default: on) 235 --enable-pointer-blank (default: on)
246 Add support to have the pointer disappear when typing or inactive. 236 Add support to have the pointer disappear when typing or inactive.
247 237
248 --enable-perl (default: off) 238 --enable-perl (default: on)
249 Enable an embedded perl interpreter. See the rxvtperl(3) manpage 239 Enable an embedded perl interpreter. See the rxvtperl(3) manpage for
250 (doc/rxvtperl.txt) for more info on this feature, or the files in 240 more info on this feature, or the files in src/perl/ for the
251 src/perl-ext/ for the extensions that are installed by default. The 241 extensions that are installed by default. The perl interpreter that
252 perl interpreter that is used can be specified via the "PERL" 242 is used can be specified via the "PERL" environment variable when
253 environment variable when running configure. 243 running configure. Even when compiled in, perl will *not* be
244 initialised when all extensions have been disabled "-pe ""
245 --perl-ext-common """, so it should be safe to enable from a
246 resource standpoint.
247
248 --enable-assert (default: off)
249 Enables the assertions in the code, normally disabled. This switch
250 is only useful when developing rxvt-unicode.
251
252 --enable-256-color (default: off)
253 Force use of so-called 256 colour mode, to work around buggy
254 applications that do not support termcap/terminfo, or simply improve
255 support for applications hardcoding the xterm 256 colour table.
256
257 This switch breaks termcap/terminfo compatibility to
258 "TERM=rxvt-unicode", and consequently sets "TERM" to
259 "rxvt-unicode-256color" by default (doc/etc/ contains
260 termcap/terminfo definitions for both).
261
262 It also results in higher memory usage and can slow down rxvt
263 dramatically when more than six fonts are in use by a terminal
264 instance.
265
266 --with-afterimage-config=DIR
267 Look for the libAfterImage config script in DIR.
254 268
255 --with-name=NAME (default: urxvt) 269 --with-name=NAME (default: urxvt)
256 Set the basename for the installed binaries, resulting in "urxvt", 270 Set the basename for the installed binaries, resulting in "urxvt",
257 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt". 271 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
258 272
264 to PATH. 278 to PATH.
265 279
266 --with-x 280 --with-x
267 Use the X Window System (pretty much default, eh?). 281 Use the X Window System (pretty much default, eh?).
268 282
269 --with-xpm-includes=DIR
270 Look for the XPM includes in DIR.
271
272 --with-xpm-library=DIR
273 Look for the XPM library in DIR.
274
275 --with-xpm
276 Not needed - define via --enable-xpm-background.
277

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines