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.25 by root, Fri Feb 18 12:15:06 2005 UTC vs.
Revision 1.68 by root, Sat Nov 13 00:48:11 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-aliases, 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, vn 31 Compile in support for additional codeset (encoding) groups ("eu",
26 are always compiled in, which includes most 8-bit character sets). 32 "vn" are always compiled in, which includes most 8-bit character
27 These codeset tables are currently only used for driving X11 core 33 sets). These codeset tables are used for driving X11 core fonts,
28 fonts, they are not required for Xft fonts. Compiling them in will 34 they are not required for Xft fonts, although having them compiled
29 make your binary bigger (together about 700kB), but it doesn't 35 in lets rxvt-unicode choose replacement fonts more intelligently.
30 increase memory usage unless you use an X11 font requiring one of 36 Compiling them in will make your binary bigger (all of together cost
31 these encodings. 37 about 700kB), but it doesn't increase memory usage unless you use a
38 font requiring one of these encodings.
32 39
33 all all available codeset groups 40 all all available codeset groups
34 zh common chinese encodings 41 zh common chinese encodings
35 zh_ext rarely used but very big chinese encodigs 42 zh_ext rarely used but very big chinese encodings
36 jp common japanese encodings 43 jp common japanese encodings
37 jp_ext rarely used but big japanese encodings 44 jp_ext rarely used but big japanese encodings
38 kr korean encodings 45 kr korean encodings
39 46 --enable-xim (default: on)
40 --enable-xim
41 Add support for XIM (X Input Method) protocol. This allows using 47 Add support for XIM (X Input Method) protocol. This allows using
42 alternative input methods (e.g. kinput2) and will also correctly set 48 alternative input methods (e.g. kinput2) and will also correctly set
43 up the input for people using dead keys or compose keys. 49 up the input for people using dead keys or compose keys.
44 50
45 --enable-unicode3 51 --enable-unicode3 (default: off)
52 Recommended to stay off unless you really need non-BMP characters.
53
46 Enable direct support for displaying unicode codepoints above 65535 54 Enable direct support for displaying unicode codepoints above 65535
47 (the basic multilingual page). This increases storage requirements 55 (the basic multilingual page). This increases storage requirements
48 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
49 extra characters, but Xft does. 57 extra characters, but Xft does.
50 58
51 Please note that rxvt-unicode can store unicode code points >65535 59 Please note that rxvt-unicode can store unicode code points >65535
52 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
53 to a view thousand (shared with combining characters, see next 61 to a few thousand (shared with combining characters, see next
54 switch), and right now rxvt-unicode cannot display them 62 switch), and right now rxvt-unicode cannot display them
55 (input/output and cut&paste still work, though). 63 (input/output and cut&paste still work, though).
56 64
57 --enable-combining 65 --enable-combining (default: on)
58 Enable automatic composition of combining characters into composite 66 Enable automatic composition of combining characters into composite
59 characters. This is required for proper viewing of text where 67 characters. This is required for proper viewing of text where
60 accents are encoded as seperate unicode characters. This is done by 68 accents are encoded as separate unicode characters. This is done by
61 using precomposited characters when available or creating new 69 using precomposited characters when available or creating new
62 pseudo-characters when no precomposed form exists. 70 pseudo-characters when no precomposed form exists.
63 71
64 Without --enable-unicode3, the number of additional precomposed 72 Without --enable-unicode3, the number of additional precomposed
65 characters is rather limited (2048, if this is full, rxvt-unicode 73 characters is somewhat limited (the 6400 private use characters will
66 will use the private use area, extending the number of combinations
67 to 8448). With --enable-unicode3, no practical limit exists. 74 be (ab-)used). With --enable-unicode3, no practical limit exists.
68 75
69 This option will also enable storage (but not display) of characters 76 This option will also enable storage (but not display) of characters
70 beyond plane 0 (>65535) when --enable-unicode3 was not specified. 77 beyond plane 0 (>65535) when --enable-unicode3 was not specified.
71 78
72 The combining table also contains entries for arabic presentation 79 The combining table also contains entries for arabic presentation
73 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
74 be used (and tell me how these are to be used...). 81 be used (and tell me how these are to be used...).
75 82
76 --enable-fallback(=CLASS) 83 --enable-fallback(=CLASS) (default: Rxvt)
77 When reading resource settings, also read settings for class CLASS 84 When reading resource settings, also read settings for class CLASS.
78 (default: Rxvt). To disable resource fallback use 85 To disable resource fallback use --disable-fallback.
79 --disable-fallback.
80 86
81 --with-res-name=NAME 87 --with-res-name=NAME (default: urxvt)
82 Use the given name (default: urxvt) as default application name when 88 Use the given name as default application name when reading
83 reading resources. Specify --with-res-name=rxvt to replace rxvt. 89 resources. Specify --with-res-name=rxvt to replace rxvt.
84 90
85 --with-res-class=CLASS 91 --with-res-class=CLASS (default: URxvt)
86 Use the given class (default: URxvt) as default application class 92 Use the given class as default application class when reading
87 when reading resources. Specify --with-res-class=Rxvt to replace 93 resources. Specify --with-res-class=Rxvt to replace rxvt.
88 rxvt.
89 94
90 --enable-utmp 95 --enable-utmp (default: on)
91 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
92 of rxvt execution and delete information when rxvt exits. 97 of rxvt execution and delete information when rxvt exits.
93 98
94 --enable-wtmp 99 --enable-wtmp (default: on)
95 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
96 start of rxvt execution and write logout when rxvt exits. This 101 start of rxvt execution and write logout when rxvt exits. This
97 option requires --enable-utmp to also be specified. 102 option requires --enable-utmp to also be specified.
98 103
99 --enable-lastlog 104 --enable-lastlog (default: on)
100 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)
101 at start of rxvt execution. This option requires --enable-utmp to 106 at start of rxvt execution. This option requires --enable-utmp to
102 also be specified. 107 also be specified.
103 108
104 --enable-xpm-background 109 --enable-afterimage (default: on)
105 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>).
106 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
107 --enable-transparency 126 --enable-transparency (default: on)
108 Add support for inheriting parent backgrounds thus giving a fake 127 Add support for using the root pixmap as background to simulate
109 transparency to the term. 128 transparency. Note that tint, blur and blend effects depend on
129 libAfterImage or on libXrender and on the availability of the RENDER
130 extension in the X server.
110 131
111 --enable-fading 132 --enable-fading (default: on)
112 Add support for fading the text when focus is lost. 133 Add support for fading the text when focus is lost.
113 134
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 135 --enable-rxvt-scroll (default: on)
122 Add support for the original rxvt scrollbar. 136 Add support for the original rxvt scrollbar.
123 137
124 --enable-next-scroll 138 --enable-next-scroll (default: on)
125 Add support for a NeXT-like scrollbar. 139 Add support for a NeXT-like scrollbar.
126 140
127 --enable-xterm-scroll 141 --enable-xterm-scroll (default: on)
128 Add support for an Xterm-like scrollbar. 142 Add support for an Xterm-like scrollbar.
129 143
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-backspace-key
144 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
145 do it. 146 do it.
146 147
147 --disable-delete-key 148 --disable-delete-key
148 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
149 it. 150 it.
150 151
151 --disable-resources 152 --disable-resources
152 Remove all resources checking. 153 Removes any support for resource 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 154
170 --disable-swapscreen 155 --disable-swapscreen
171 Remove support for swap screen. 156 Remove support for secondary/swap screen.
172 157
173 --enable-frills 158 --enable-frills (default: on)
174 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
175 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
176 want to disable this. 161 want to disable this.
177 162
178 A non-exhaustive list of features enabled by "--enable-frills" 163 A non-exhaustive list of features enabled by "--enable-frills"
179 (possibly in combination with other switches) is: 164 (possibly in combination with other switches) is:
180 165
181 MWM-hints 166 MWM-hints
167 EWMH-hints (pid, utf8 names) and protocols (ping)
168 urgency hint
182 seperate underline colour 169 separate underline colour (-underlineColor)
183 settable border widths and borderless switch 170 settable border widths and borderless switch (-w, -b, -bl)
171 visual depth selection (-depth)
184 settable extra linespacing 172 settable extra linespacing (-lsp)
185 extra window properties (e.g. UTF-8 window names and PID) 173 iso-14755 5.1 (basic) support
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 174 tripleclickwords (-tcw)
190 settable insecure mode 175 settable insecure mode (-insecure)
191 keysym remapping support 176 keysym remapping support
192 -embed and -pty-fd options 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)
193 184
185 It also enables some non-essential features otherwise disabled, such
186 as:
187
188 some round-trip time optimisations
189 nearest colour allocation on pseudocolor screens
190 UTF8_STRING support for selection
191 sgr modes 90..97 and 100..107
192 backindex and forwardindex escape sequences
193 view change/zero scrollback escape sequences
194 locale switching escape sequence
195 window op and some xterm/OSC escape sequences
196 rectangular selections
197 trailing space removal for selections
198 verbose X error handling
199
194 --enable-iso14755 200 --enable-iso14755 (default: on)
195 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt). 201 Enable extended ISO 14755 support (see rxvt(1)). Basic support
196 Basic support (section 5.1) is enabled by "--enable-frills", while 202 (section 5.1) is enabled by "--enable-frills", while support for
197 support for 5.2, 5.3 and 5.4 is enabled with this switch. 203 5.2, 5.3 and 5.4 is enabled with this switch.
198 204
199 --enable-keepscrolling 205 --enable-keepscrolling (default: on)
200 Add support for continual scrolling of the display when you hold the 206 Add support for continual scrolling of the display when you hold the
201 mouse button down on a scrollbar arrow. 207 mouse button down on a scrollbar arrow.
202 208
209 --enable-selectionscrolling (default: on)
210 Add support for scrolling when the selection moves to the top or
211 bottom of the screen.
212
203 --enable-mousewheel 213 --enable-mousewheel (default: on)
204 Add support for scrolling via mouse wheel or buttons 4 & 5. 214 Add support for scrolling via mouse wheel or buttons 4 & 5.
205 215
206 --enable-slipwheeling 216 --enable-slipwheeling (default: on)
207 Add support for continual scrolling (using the mouse wheel as an 217 Add support for continual scrolling (using the mouse wheel as an
208 accelerator) while the control key is held down. This option 218 accelerator) while the control key is held down. This option
209 requires --enable-mousewheel to also be specified. 219 requires --enable-mousewheel to also be specified.
210 220
211 --disable-new-selection
212 Remove support for mouse selection style like that of xterm.
213
214 --enable-dmalloc
215 Use Gray Watson's malloc - which is good for debugging See
216 http://www.letters.com/dmalloc/ for details If you use either this
217 or the next option, you may need to edit src/Makefile after
218 compiling to point DINCLUDE and DLIB to the right places.
219
220 You can only use either this option and the following (should you
221 use either) .
222
223 --enable-dlmalloc
224 Use Doug Lea's malloc - which is good for a production version See
225 <http://g.oswego.edu/dl/html/malloc.html> for details.
226
227 --enable-smart-resize 221 --enable-smart-resize (default: off)
228 Add smart growth/shrink behaviour when changing font size via from 222 Add smart growth/shrink behaviour when resizing. This should keep
229 hot keys. This should keep in a fixed position the rxvt corner which 223 the window corner which is closest to a corner of the screen in a
230 is closest to a corner of the screen. 224 fixed position.
231 225
232 --enable-cursor-blink 226 --enable-text-blink (default: on)
233 Add support for a blinking cursor. 227 Add support for blinking text.
234 228
235 --enable-pointer-blank 229 --enable-pointer-blank (default: on)
236 Add support to have the pointer disappear when typing or inactive. 230 Add support to have the pointer disappear when typing or inactive.
237 231
238 --with-name=NAME 232 --enable-perl (default: on)
233 Enable an embedded perl interpreter. See the rxvtperl(3) manpage for
234 more info on this feature, or the files in src/perl/ for the
235 extensions that are installed by default. The perl interpreter that
236 is used can be specified via the "PERL" environment variable when
237 running configure. Even when compiled in, perl will *not* be
238 initialised when all extensions have been disabled "-pe ""
239 --perl-ext-common """, so it should be safe to enable from a
240 resource standpoint.
241
242 --enable-assert (default: off)
243 Enables the assertions in the code, normally disabled. This switch
244 is only useful when developing rxvt-unicode.
245
246 --enable-256-color (default: off)
247 Force use of so-called 256 colour mode, to work around buggy
248 applications that do not support termcap/terminfo, or simply improve
249 support for applications hardcoding the xterm 256 colour table.
250
251 This switch breaks termcap/terminfo compatibility to
252 "TERM=rxvt-unicode", and consequently sets "TERM" to
253 "rxvt-unicode-256color" by default (doc/etc/ contains
254 termcap/terminfo definitions for both).
255
256 It also results in higher memory usage and can slow down rxvt
257 dramatically when more than six fonts are in use by a terminal
258 instance.
259
260 --with-afterimage-config=DIR
261 Look for the libAfterImage config script in DIR.
262
263 --with-name=NAME (default: urxvt)
239 Set the basename for the installed binaries (default: "urxvt", 264 Set the basename for the installed binaries, resulting in "urxvt",
240 resulting in "urxvt", "urxvtd" etc.). Specify "--with-name=rxvt" to 265 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
241 replace with "rxvt".
242 266
243 --with-term=NAME 267 --with-term=NAME (default: rxvt-unicode)
244 Change the environmental variable for the terminal to NAME (default 268 Change the environmental variable for the terminal to NAME.
245 "rxvt-unicode")
246 269
247 --with-terminfo=PATH 270 --with-terminfo=PATH
248 Change the environmental variable for the path to the terminfo tree 271 Change the environmental variable for the path to the terminfo tree
249 to PATH. 272 to PATH.
250 273
251 --with-x 274 --with-x
252 Use the X Window System (pretty much default, eh?). 275 Use the X Window System (pretty much default, eh?).
253 276
254 --with-xpm-includes=DIR
255 Look for the XPM includes in DIR.
256
257 --with-xpm-library=DIR
258 Look for the XPM library in DIR.
259
260 --with-xpm
261 Not needed - define via --enable-xpm-background.
262

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines