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.24 by root, Mon Feb 14 10:44:50 2005 UTC vs.
Revision 1.54 by root, Sat Jun 2 05:07:11 2007 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. "--enable-xxx" or "--disable-xxx"). Of
5 so it should generally be a working config. Of course, you should always 5 course, you should always report when a combination doesn't work, so it
6 report when a combination doesn't work, so it can be fixed. Marc Lehmann 6 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".
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
40 --enable-xim 46 --enable-xim (default: on)
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
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 view 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 seperate 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-xpm-background (default: on)
105 Add support for XPM background pixmaps. 110 Add support for XPM background pixmaps.
106 111
107 --enable-transparency 112 --enable-transparency (default: on)
108 Add support for inheriting parent backgrounds thus giving a fake 113 Add support for inheriting parent backgrounds thus giving a fake
109 transparency to the term. 114 transparency to the term.
110 115
111 --enable-fading 116 --enable-fading (default: on)
112 Add support for fading the text when focus is lost. 117 Add support for fading the text when focus is lost (requires
118 "--enable-transparency").
113 119
114 --enable-tinting 120 --enable-tinting (default: on)
115 Add support for tinting of transparent backgrounds. 121 Add support for tinting of transparent backgrounds (requires
122 "--enable-transparency").
116 123
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 124 --enable-rxvt-scroll (default: on)
122 Add support for the original rxvt scrollbar. 125 Add support for the original rxvt scrollbar.
123 126
124 --enable-next-scroll 127 --enable-next-scroll (default: on)
125 Add support for a NeXT-like scrollbar. 128 Add support for a NeXT-like scrollbar.
126 129
127 --enable-xterm-scroll 130 --enable-xterm-scroll (default: on)
128 Add support for an Xterm-like scrollbar. 131 Add support for an Xterm-like scrollbar.
129 132
130 --enable-plain-scroll 133 --enable-plain-scroll (default: on)
131 Add support for a very unobtrusive, plain-looking scrollbar that is 134 Add support for a very unobtrusive, plain-looking scrollbar that is
132 the favourite of the rxvt-unicode author, having used it for many 135 the favourite of the rxvt-unicode author, having used it for many
133 years. 136 years.
134 137
135 --enable-half-shadow 138 --enable-ttygid (default: off)
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 139 Change tty device setting to group "tty" - only use this if your
141 system uses this type of security. 140 system uses this type of security.
142 141
143 --disable-backspace-key 142 --disable-backspace-key
144 Disable any handling of the backspace key by us - let the X server 143 Removes any handling of the backspace key by us - let the X server
145 do it. 144 do it.
146 145
147 --disable-delete-key 146 --disable-delete-key
148 Disable any handling of the delete key by us - let the X server do 147 Removes any handling of the delete key by us - let the X server do
149 it. 148 it.
150 149
151 --disable-resources 150 --disable-resources
152 Remove all resources checking. 151 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 152
170 --disable-swapscreen 153 --disable-swapscreen
171 Remove support for swap screen. 154 Remove support for secondary/swap screen.
172 155
173 --enable-frills 156 --enable-frills (default: on)
174 Add support for many small features that are not essential but nice 157 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 158 to have. Normally you want this, but for very small binaries you may
176 want to disable this. 159 want to disable this.
177 160
178 A non-exhaustive list of features enabled by "--enable-frills" 161 A non-exhaustive list of features enabled by "--enable-frills"
179 (possibly in combination with other switches) is: 162 (possibly in combination with other switches) is:
180 163
181 MWM-hints 164 MWM-hints
165 EWMH-hints (pid, utf8 names) and protocols (ping)
166 urgency hint
182 seperate underline colour 167 seperate underline colour (-underlineColor)
183 settable border widths and borderless switch 168 settable border widths and borderless switch (-w, -b, -bl)
169 visual depth selection (-depth)
184 settable extra linespacing 170 settable extra linespacing /-lsp)
185 extra window properties (e.g. UTF-8 window names and PID) 171 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 172 tripleclickwords (-tcw)
190 settable insecure mode 173 settable insecure mode (-insecure)
191 keysym remapping support 174 keysym remapping support
175 cursor blinking and underline cursor (-cb, -uc)
176 XEmbed support (-embed)
177 user-pty (-pty-fd)
178 hold on exit (-hold)
179 skip builtin block graphics (-sbg)
180 separate highlightcolor support (-hc)
192 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
193 --enable-iso14755 197 --enable-iso14755 (default: on)
194 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt). 198 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt).
195 Basic support (section 5.1) is enabled by "--enable-frills", while 199 Basic support (section 5.1) is enabled by "--enable-frills", while
196 support for 5.2, 5.3 and 5.4 is enabled with this switch. 200 support for 5.2, 5.3 and 5.4 is enabled with this switch.
197 201
198 --enable-keepscrolling 202 --enable-keepscrolling (default: on)
199 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
200 mouse button down on a scrollbar arrow. 204 mouse button down on a scrollbar arrow.
201 205
202 --enable-mousewheel 206 --enable-mousewheel (default: on)
203 Add support for scrolling via mouse wheel or buttons 4 & 5. 207 Add support for scrolling via mouse wheel or buttons 4 & 5.
204 208
205 --enable-slipwheeling 209 --enable-slipwheeling (default: on)
206 Add support for continual scrolling (using the mouse wheel as an 210 Add support for continual scrolling (using the mouse wheel as an
207 accelerator) while the control key is held down. This option 211 accelerator) while the control key is held down. This option
208 requires --enable-mousewheel to also be specified. 212 requires --enable-mousewheel to also be specified.
209 213
210 --disable-new-selection 214 --disable-new-selection
211 Remove support for mouse selection style like that of xterm. 215 Remove support for mouse selection style like that of xterm.
212 216
213 --enable-dmalloc 217 --enable-dmalloc (default: off)
214 Use Gray Watson's malloc - which is good for debugging See 218 Use Gray Watson's malloc - which is good for debugging See
215 http://www.letters.com/dmalloc/ for details If you use either this 219 <http://www.letters.com/dmalloc/> for details If you use either this
216 or the next option, you may need to edit src/Makefile after 220 or the next option, you may need to edit src/Makefile after
217 compiling to point DINCLUDE and DLIB to the right places. 221 compiling to point DINCLUDE and DLIB to the right places.
218 222
219 You can only use either this option and the following (should you 223 You can only use either this option and the following (should you
220 use either) . 224 use either) .
221 225
222 --enable-dlmalloc 226 --enable-dlmalloc (default: off)
223 Use Doug Lea's malloc - which is good for a production version See 227 Use Doug Lea's malloc - which is good for a production version See
224 <http://g.oswego.edu/dl/html/malloc.html> for details. 228 <http://g.oswego.edu/dl/html/malloc.html> for details.
225 229
226 --enable-smart-resize 230 --enable-smart-resize (default: on)
227 Add smart growth/shrink behaviour when changing font size via from 231 Add smart growth/shrink behaviour when changing font size via hot
228 hot keys. This should keep in a fixed position the rxvt corner which 232 keys. This should keep the window corner which is closest to a
229 is closest to a corner of the screen. 233 corner of the screen in a fixed position.
230 234
231 --enable-cursor-blink
232 Add support for a blinking cursor.
233
234 --enable-pointer-blank 235 --enable-pointer-blank (default: on)
235 Add support to have the pointer disappear when typing or inactive. 236 Add support to have the pointer disappear when typing or inactive.
236 237
237 --with-name=NAME 238 --enable-perl (default: on)
239 Enable an embedded perl interpreter. See the rxvtperl(3) manpage
240 (doc/rxvtperl.txt) for more info on this feature, or the files in
241 src/perl-ext/ for the extensions that are installed by default. The
242 perl interpreter that is used can be specified via the "PERL"
243 environment variable when running configure.
244
245 --with-name=NAME (default: urxvt)
238 Set the basename for the installed binaries (default: "urxvt", 246 Set the basename for the installed binaries, resulting in "urxvt",
239 resulting in "urxvt", "urxvtd" etc.). Specify "--with-name=rxvt" to 247 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
240 replace with "rxvt".
241 248
242 --with-term=NAME 249 --with-term=NAME (default: rxvt-unicode)
243 Change the environmental variable for the terminal to NAME (default 250 Change the environmental variable for the terminal to NAME.
244 "rxvt-unicode")
245 251
246 --with-terminfo=PATH 252 --with-terminfo=PATH
247 Change the environmental variable for the path to the terminfo tree 253 Change the environmental variable for the path to the terminfo tree
248 to PATH. 254 to PATH.
249 255

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines