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.26 by root, Sun Feb 20 19:45:30 2005 UTC vs.
Revision 1.65 by root, Tue Mar 16 00:54:46 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".
12 dependant. You can specify this and then disable options which this
13 enables by *following* this with the appropriate commands.
14 13
15 --enable-xft 14 You can specify this and then disable options you do not like by
15 *following* this with the appropriate "--disable-..." arguments, or
16 you can start with a minimal configuration by specifying
17 "--disable-everything" and than adding just the "--enable-..."
18 arguments you want.
19
20 --enable-xft (default: enabled)
16 Add support for Xft (anti-aliases, among others) fonts. Xft fonts 21 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 22 are slower and require lots of memory, but as long as you don't use
18 them, you don't pay for them. 23 them, you don't pay for them.
19 24
20 --enable-font-styles 25 --enable-font-styles (default: on)
21 Add support for bold, *italic* and *bold italic* font styles. The 26 Add support for bold, *italic* and *bold italic* font styles. The
22 fonts can be set manually or automatically. 27 fonts can be set manually or automatically.
23 28
24 --with-codesets=NAME,... 29 --with-codesets=NAME,... (default: all)
25 Compile in support for additional codeset (encoding) groups (eu, vn 30 Compile in support for additional codeset (encoding) groups ("eu",
26 are always compiled in, which includes most 8-bit character sets). 31 "vn" are always compiled in, which includes most 8-bit character
27 These codeset tables are currently only used for driving X11 core 32 sets). These codeset tables are used for driving X11 core fonts,
28 fonts, they are not required for Xft fonts. Compiling them in will 33 they are not required for Xft fonts, although having them compiled
29 make your binary bigger (together about 700kB), but it doesn't 34 in lets rxvt-unicode choose replacement fonts more intelligently.
30 increase memory usage unless you use an X11 font requiring one of 35 Compiling them in will make your binary bigger (all of together cost
31 these encodings. 36 about 700kB), but it doesn't increase memory usage unless you use a
37 font requiring one of these encodings.
32 38
33 all all available codeset groups 39 all all available codeset groups
34 zh common chinese encodings 40 zh common chinese encodings
35 zh_ext rarely used but very big chinese encodigs 41 zh_ext rarely used but very big chinese encodings
36 jp common japanese encodings 42 jp common japanese encodings
37 jp_ext rarely used but big japanese encodings 43 jp_ext rarely used but big japanese encodings
38 kr korean encodings 44 kr korean encodings
39 45 --enable-xim (default: on)
40 --enable-xim
41 Add support for XIM (X Input Method) protocol. This allows using 46 Add support for XIM (X Input Method) protocol. This allows using
42 alternative input methods (e.g. kinput2) and will also correctly set 47 alternative input methods (e.g. kinput2) and will also correctly set
43 up the input for people using dead keys or compose keys. 48 up the input for people using dead keys or compose keys.
44 49
45 --enable-unicode3 50 --enable-unicode3 (default: off)
51 Recommended to stay off unless you really need non-BMP characters.
52
46 Enable direct support for displaying unicode codepoints above 65535 53 Enable direct support for displaying unicode codepoints above 65535
47 (the basic multilingual page). This increases storage requirements 54 (the basic multilingual page). This increases storage requirements
48 per character from 2 to 4 bytes. X11 fonts do not yet support these 55 per character from 2 to 4 bytes. X11 fonts do not yet support these
49 extra characters, but Xft does. 56 extra characters, but Xft does.
50 57
51 Please note that rxvt-unicode can store unicode code points >65535 58 Please note that rxvt-unicode can store unicode code points >65535
52 even without this flag, but the number of such characters is limited 59 even without this flag, but the number of such characters is limited
53 to a view thousand (shared with combining characters, see next 60 to a few thousand (shared with combining characters, see next
54 switch), and right now rxvt-unicode cannot display them 61 switch), and right now rxvt-unicode cannot display them
55 (input/output and cut&paste still work, though). 62 (input/output and cut&paste still work, though).
56 63
57 --enable-combining 64 --enable-combining (default: on)
58 Enable automatic composition of combining characters into composite 65 Enable automatic composition of combining characters into composite
59 characters. This is required for proper viewing of text where 66 characters. This is required for proper viewing of text where
60 accents are encoded as seperate unicode characters. This is done by 67 accents are encoded as separate unicode characters. This is done by
61 using precomposited characters when available or creating new 68 using precomposited characters when available or creating new
62 pseudo-characters when no precomposed form exists. 69 pseudo-characters when no precomposed form exists.
63 70
64 Without --enable-unicode3, the number of additional precomposed 71 Without --enable-unicode3, the number of additional precomposed
65 characters is rather limited (2048, if this is full, rxvt-unicode 72 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. 73 be (ab-)used). With --enable-unicode3, no practical limit exists.
68 74
69 This option will also enable storage (but not display) of characters 75 This option will also enable storage (but not display) of characters
70 beyond plane 0 (>65535) when --enable-unicode3 was not specified. 76 beyond plane 0 (>65535) when --enable-unicode3 was not specified.
71 77
72 The combining table also contains entries for arabic presentation 78 The combining table also contains entries for arabic presentation
73 forms, but these are not currently used. Bug me if you want these to 79 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...). 80 be used (and tell me how these are to be used...).
75 81
76 --enable-fallback(=CLASS) 82 --enable-fallback(=CLASS) (default: Rxvt)
77 When reading resource settings, also read settings for class CLASS 83 When reading resource settings, also read settings for class CLASS.
78 (default: Rxvt). To disable resource fallback use 84 To disable resource fallback use --disable-fallback.
79 --disable-fallback.
80 85
81 --with-res-name=NAME 86 --with-res-name=NAME (default: urxvt)
82 Use the given name (default: urxvt) as default application name when 87 Use the given name as default application name when reading
83 reading resources. Specify --with-res-name=rxvt to replace rxvt. 88 resources. Specify --with-res-name=rxvt to replace rxvt.
84 89
85 --with-res-class=CLASS 90 --with-res-class=CLASS (default: URxvt)
86 Use the given class (default: URxvt) as default application class 91 Use the given class as default application class when reading
87 when reading resources. Specify --with-res-class=Rxvt to replace 92 resources. Specify --with-res-class=Rxvt to replace rxvt.
88 rxvt.
89 93
90 --enable-utmp 94 --enable-utmp (default: on)
91 Write user and tty to utmp file (used by programs like w) at start 95 Write user and tty to utmp file (used by programs like w) at start
92 of rxvt execution and delete information when rxvt exits. 96 of rxvt execution and delete information when rxvt exits.
93 97
94 --enable-wtmp 98 --enable-wtmp (default: on)
95 Write user and tty to wtmp file (used by programs like last) at 99 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 100 start of rxvt execution and write logout when rxvt exits. This
97 option requires --enable-utmp to also be specified. 101 option requires --enable-utmp to also be specified.
98 102
99 --enable-lastlog 103 --enable-lastlog (default: on)
100 Write user and tty to lastlog file (used by programs like lastlogin) 104 Write user and tty to lastlog file (used by programs like lastlogin)
101 at start of rxvt execution. This option requires --enable-utmp to 105 at start of rxvt execution. This option requires --enable-utmp to
102 also be specified. 106 also be specified.
103 107
104 --enable-xpm-background 108 --enable-afterimage (default: on)
105 Add support for XPM background pixmaps. 109 Add support for libAfterImage to be used for transparency and
110 background images. It adds support for many file formats including
111 JPG, PNG, SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep
112 image XML
113 (<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
106 114
115 This option also adds such eye candy as blending an image over the
116 root background, as well as dynamic scaling and bluring of
117 background images.
118
119 Note that with this option enabled, rxvt's memory footprint might
120 increase by a few megabytes even if no extra features are used
121 (mostly due to third-party libraries used by libAI). Memory
122 footprint may somewhat be lowered if libAfterImage is configured
123 without support for SVG.
124
107 --enable-transparency 125 --enable-transparency (default: on)
108 Add support for inheriting parent backgrounds thus giving a fake 126 Add support for backgrounds, creating illusion of transparency in
109 transparency to the term. 127 the term.
110 128
111 --enable-fading 129 --enable-fading (default: on)
112 Add support for fading the text when focus is lost. 130 Add support for fading the text when focus is lost.
113 131
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 132 --enable-rxvt-scroll (default: on)
122 Add support for the original rxvt scrollbar. 133 Add support for the original rxvt scrollbar.
123 134
124 --enable-next-scroll 135 --enable-next-scroll (default: on)
125 Add support for a NeXT-like scrollbar. 136 Add support for a NeXT-like scrollbar.
126 137
127 --enable-xterm-scroll 138 --enable-xterm-scroll (default: on)
128 Add support for an Xterm-like scrollbar. 139 Add support for an Xterm-like scrollbar.
129 140
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 141 --disable-backspace-key
144 Disable any handling of the backspace key by us - let the X server 142 Removes any handling of the backspace key by us - let the X server
145 do it. 143 do it.
146 144
147 --disable-delete-key 145 --disable-delete-key
148 Disable any handling of the delete key by us - let the X server do 146 Removes any handling of the delete key by us - let the X server do
149 it. 147 it.
150 148
151 --disable-resources 149 --disable-resources
152 Remove all resources checking. 150 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 151
170 --disable-swapscreen 152 --disable-swapscreen
171 Remove support for swap screen. 153 Remove support for secondary/swap screen.
172 154
173 --enable-frills 155 --enable-frills (default: on)
174 Add support for many small features that are not essential but nice 156 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 157 to have. Normally you want this, but for very small binaries you may
176 want to disable this. 158 want to disable this.
177 159
178 A non-exhaustive list of features enabled by "--enable-frills" 160 A non-exhaustive list of features enabled by "--enable-frills"
179 (possibly in combination with other switches) is: 161 (possibly in combination with other switches) is:
180 162
181 MWM-hints 163 MWM-hints
182 EWMH-hints (pid, utf8 names) and protocols (ping) 164 EWMH-hints (pid, utf8 names) and protocols (ping)
165 urgency hint
183 seperate underline colour 166 separate underline colour (-underlineColor)
184 settable border widths and borderless switch 167 settable border widths and borderless switch (-w, -b, -bl)
168 visual depth selection (-depth)
185 settable extra linespacing 169 settable extra linespacing /-lsp)
186 iso-14755-2 and -3, and visual feedback 170 iso-14755 5.1 (basic) support
187 backindex and forwardindex escape sequence
188 window op and locale change escape sequences
189 tripleclickwords 171 tripleclickwords (-tcw)
190 settable insecure mode 172 settable insecure mode (-insecure)
191 keysym remapping support 173 keysym remapping support
192 -embed and -pty-fd options 174 cursor blinking and underline cursor (-bc, -uc)
175 XEmbed support (-embed)
176 user-pty (-pty-fd)
177 hold on exit (-hold)
178 compile in built-in block graphics
179 skip builtin block graphics (-sbg)
180 separate highlightcolor support (-hc)
193 181
182 It also enables some non-essential features otherwise disabled, such
183 as:
184
185 some round-trip time optimisations
186 nearest color allocation on pseudocolor screens
187 UTF8_STRING support for selection
188 sgr modes 90..97 and 100..107
189 backindex and forwardindex escape sequences
190 view change/zero scrollback escape sequences
191 locale switching escape sequence
192 window op and some xterm/OSC escape sequences
193 rectangular selections
194 trailing space removal for selections
195 verbose X error handling
196
194 --enable-iso14755 197 --enable-iso14755 (default: on)
195 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt). 198 Enable extended ISO 14755 support (see rxvt(1)). Basic support
196 Basic support (section 5.1) is enabled by "--enable-frills", while 199 (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. 200 5.2, 5.3 and 5.4 is enabled with this switch.
198 201
199 --enable-keepscrolling 202 --enable-keepscrolling (default: on)
200 Add support for continual scrolling of the display when you hold the 203 Add support for continual scrolling of the display when you hold the
201 mouse button down on a scrollbar arrow. 204 mouse button down on a scrollbar arrow.
202 205
206 --enable-selectionscrolling (default: on)
207 Add support for scrolling when the selection moves to the top or
208 bottom of the screen.
209
203 --enable-mousewheel 210 --enable-mousewheel (default: on)
204 Add support for scrolling via mouse wheel or buttons 4 & 5. 211 Add support for scrolling via mouse wheel or buttons 4 & 5.
205 212
206 --enable-slipwheeling 213 --enable-slipwheeling (default: on)
207 Add support for continual scrolling (using the mouse wheel as an 214 Add support for continual scrolling (using the mouse wheel as an
208 accelerator) while the control key is held down. This option 215 accelerator) while the control key is held down. This option
209 requires --enable-mousewheel to also be specified. 216 requires --enable-mousewheel to also be specified.
210 217
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 218 --enable-smart-resize (default: off)
228 Add smart growth/shrink behaviour when changing font size via from 219 Add smart growth/shrink behaviour when resizing. This should keep
229 hot keys. This should keep in a fixed position the rxvt corner which 220 the window corner which is closest to a corner of the screen in a
230 is closest to a corner of the screen. 221 fixed position.
231 222
232 --enable-cursor-blink 223 --enable-text-blink (default: on)
233 Add support for a blinking cursor. 224 Add support for blinking text.
234 225
235 --enable-pointer-blank 226 --enable-pointer-blank (default: on)
236 Add support to have the pointer disappear when typing or inactive. 227 Add support to have the pointer disappear when typing or inactive.
237 228
238 --with-name=NAME 229 --enable-perl (default: on)
230 Enable an embedded perl interpreter. See the rxvtperl(3) manpage for
231 more info on this feature, or the files in src/perl/ for the
232 extensions that are installed by default. The perl interpreter that
233 is used can be specified via the "PERL" environment variable when
234 running configure. Even when compiled in, perl will *not* be
235 initialised when all extensions have been disabled "-pe ""
236 --perl-ext-common """, so it should be safe to enable from a
237 resource standpoint.
238
239 --enable-assert (default: off)
240 Enables the assertions in the code, normally disabled. This switch
241 is only useful when developing rxvt-unicode.
242
243 --with-afterimage-config=DIR
244 Look for the libAfterImage config script in DIR.
245
246 --with-name=NAME (default: urxvt)
239 Set the basename for the installed binaries (default: "urxvt", 247 Set the basename for the installed binaries, resulting in "urxvt",
240 resulting in "urxvt", "urxvtd" etc.). Specify "--with-name=rxvt" to 248 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
241 replace with "rxvt".
242 249
243 --with-term=NAME 250 --with-term=NAME (default: rxvt-unicode)
244 Change the environmental variable for the terminal to NAME (default 251 Change the environmental variable for the terminal to NAME.
245 "rxvt-unicode")
246 252
247 --with-terminfo=PATH 253 --with-terminfo=PATH
248 Change the environmental variable for the path to the terminfo tree 254 Change the environmental variable for the path to the terminfo tree
249 to PATH. 255 to PATH.
250 256
251 --with-x 257 --with-x
252 Use the X Window System (pretty much default, eh?). 258 Use the X Window System (pretty much default, eh?).
253 259
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