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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines