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.18 by root, Sun Aug 15 18:59:05 2004 UTC vs.
Revision 1.74 by root, Sun Dec 18 02:27:24 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 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: on)
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 --with-codesets=NAME,... 26 --enable-font-styles (default: on)
27 Add support for bold, *italic* and *bold italic* font styles. The
28 fonts can be set manually or automatically.
29
30 --with-codesets=CS,... (default: all)
21 Compile in support for additional codeset (encoding) groups. These 31 Compile in support for additional codeset (encoding) groups ("eu",
32 "vn" are always compiled in, which includes most 8-bit character
22 codeset tables are currently only used for driving X11 core fonts, 33 sets). These codeset tables are used for driving X11 core fonts,
23 they are not required for Xft fonts. Compiling them in will make 34 they are not required for Xft fonts, although having them compiled
24 your binary bigger (together about 700kB), but it doesn't increase 35 in lets rxvt-unicode choose replacement fonts more intelligently.
25 memory usage unless you use an X11 font requiring one of these 36 Compiling them in will make your binary bigger (all of together cost
26 encodings. 37 about 700kB), but it doesn't increase memory usage unless you use a
38 font requiring one of these encodings.
27 39
28 all all available codeset groups 40 all all available codeset groups
29 cn common chinese encodings 41 zh common chinese encodings
30 cn_ext rarely used but very big chinese encodigs 42 zh_ext rarely used but very big chinese encodings
31 jp common japanese encodings 43 jp common japanese encodings
32 jp_ext rarely used but big japanese encodings 44 jp_ext rarely used but big japanese encodings
33 kr korean encodings 45 kr korean encodings
34 46 --enable-xim (default: on)
35 --enable-xim
36 Add support for XIM (X Input Method) protocol. This allows using 47 Add support for XIM (X Input Method) protocol. This allows using
37 alternative input methods (e.g. kinput2) and will also correctly set 48 alternative input methods (e.g. kinput2) and will also correctly set
38 up the input for people using dead keys or compose keys. 49 up the input for people using dead keys or compose keys.
39 50
40 --enable-unicode3 51 --enable-unicode3 (default: off)
52 Recommended to stay off unless you really need non-BMP characters.
53
41 Enable direct support for displaying unicode codepoints above 65535 54 Enable direct support for displaying unicode codepoints above 65535
42 (the basic multilingual page). This increases storage requirements 55 (the basic multilingual page). This increases storage requirements
43 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
44 extra characters, but Xft does. 57 extra characters, but Xft does.
45 58
46 Please note that rxvt-unicode can store unicode code points >65535 59 Please note that rxvt-unicode can store unicode code points >65535
47 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
48 to a view thousand (shared with combining characters, see next 61 to a few thousand (shared with combining characters, see next
49 switch), and right now rxvt-unicode cannot display them 62 switch), and right now rxvt-unicode cannot display them
50 (input/output and cut&paste still work, though). 63 (input/output and cut&paste still work, though).
51 64
52 --enable-combining 65 --enable-combining (default: on)
53 Enable automatic composition of combining characters into composite 66 Enable automatic composition of combining characters into composite
54 characters. This is required for proper viewing of text where 67 characters. This is required for proper viewing of text where
55 accents are encoded as seperate unicode characters. This is done by 68 accents are encoded as separate unicode characters. This is done by
56 using precomposited characters when available or creating new 69 using precomposed characters when available or creating new
57 pseudo-characters when no precomposed form exists. 70 pseudo-characters when no precomposed form exists.
58 71
59 Without --enable-unicode3, the number of additional precomposed 72 Without --enable-unicode3, the number of additional precomposed
60 characters is rather limited (2048, if this is full, rxvt will use 73 characters is somewhat limited (the 6400 private use characters will
61 the private use area, extending the number of combinations to 8448).
62 With --enable-unicode3, no practical limit exists. This will also 74 be (ab-)used). With --enable-unicode3, no practical limit exists.
63 enable storage of characters >65535. 75
76 This option will also enable storage (but not display) of characters
77 beyond plane 0 (>65535) when --enable-unicode3 was not specified.
64 78
65 The combining table also contains entries for arabic presentation 79 The combining table also contains entries for arabic presentation
66 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
67 be used. 81 be used (and tell me how these are to be used...).
68 82
69 --enable-fallback(=CLASS) 83 --enable-fallback[=CLASS] (default: Rxvt)
70 When reading resource settings, also read settings for class CLASS 84 When reading resource settings, also read settings for class CLASS.
71 (default: Rxvt). To disable resource fallback use 85 To disable resource fallback use --disable-fallback.
72 --disable-fallback.
73 86
74 --with-res-name=NAME 87 --with-res-name=NAME (default: urxvt)
75 Use the given name (default: urxvt) as default application name when 88 Use the given name as default application name when reading
76 reading resources. Specify --with-res-name=rxvt to replace rxvt. 89 resources. Specify --with-res-name=rxvt to replace rxvt.
77 90
78 --with-res-class=CLASS 91 --with-res-class=CLASS (default: URxvt)
79 Use the given class (default: URxvt) as default application class 92 Use the given class as default application class when reading
80 when reading resources. Specify --with-res-class=Rxvt to replace 93 resources. Specify --with-res-class=Rxvt to replace rxvt.
81 rxvt.
82 94
83 --enable-utmp 95 --enable-utmp (default: on)
84 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
85 of rxvt execution and delete information when rxvt exits. 97 of rxvt execution and delete information when rxvt exits.
86 98
87 --enable-wtmp 99 --enable-wtmp (default: on)
88 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
89 start of rxvt execution and write logout when rxvt exits. This 101 start of rxvt execution and write logout when rxvt exits. This
90 option requires --enable-utmp to also be specified. 102 option requires --enable-utmp to also be specified.
91 103
92 --enable-lastlog 104 --enable-lastlog (default: on)
93 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)
94 at start of rxvt execution. This option requires --enable-utmp to 106 at start of rxvt execution. This option requires --enable-utmp to
95 also be specified. 107 also be specified.
96 108
97 --enable-xpm-background 109 --enable-afterimage (default: off)
98 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>).
99 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: on)
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.
130
100 --enable-transparency 131 --enable-transparency (default: on)
101 Add support for inheriting parent backgrounds thus giving a fake 132 Add support for using the root pixmap as background to simulate
102 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.
103 136
104 --enable-fading 137 --enable-fading (default: on)
105 Add support for fading the text when focus is lost. 138 Add support for fading the text when focus is lost.
106 139
107 --enable-tinting
108 Add support for tinting of transparent backgrounds.
109
110 --enable-menubar
111 Add support for our menu bar system (this interacts badly with
112 dynamic locale switching currently).
113
114 --enable-rxvt-scroll 140 --enable-rxvt-scroll (default: on)
115 Add support for the original rxvt scrollbar. 141 Add support for the original rxvt scrollbar.
116 142
117 --enable-next-scroll 143 --enable-next-scroll (default: on)
118 Add support for a NeXT-like scrollbar. 144 Add support for a NeXT-like scrollbar.
119 145
120 --enable-xterm-scroll 146 --enable-xterm-scroll (default: on)
121 Add support for an Xterm-like scrollbar. 147 Add support for an Xterm-like scrollbar.
122 148
123 --enable-plain-scroll
124 Add support for a very unobtrusive, plain-looking scrollbar that is
125 the favourite of the rxvt-unicode author, having used it for many
126 years.
127
128 --enable-half-shadow
129 Make shadows on the scrollbar only half the normal width & height.
130 only applicable to rxvt scrollbars.
131
132 --enable-ttygid
133 Change tty device setting to group "tty" - only use this if your
134 system uses this type of security.
135
136 --disable-backspace-key 149 --disable-backspace-key
137 Disable 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
138 do it. 151 do it.
139 152
140 --disable-delete-key 153 --disable-delete-key
141 Disable 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
142 it. 155 it.
143 156
144 --disable-resources 157 --disable-resources
145 Remove all resources checking. 158 Removes any support for resource checking.
146
147 --enable-xgetdefault
148 Make resources checking via XGetDefault() instead of our small
149 version which only checks ~/.Xdefaults, or if that doesn't exist
150 then ~/.Xresources.
151
152 --enable-strings
153 Add support for our possibly faster memset() function and other
154 various routines, overriding your system's versions which may have
155 been hand-crafted in assembly or may require extra libraries to link
156 in. (this breaks ANSI-C rules and has problems on many GNU/Linux
157 systems).
158 159
159 --disable-swapscreen 160 --disable-swapscreen
160 Remove support for swap screen. 161 Remove support for secondary/swap screen.
161 162
162 --enable-frills 163 --enable-frills (default: on)
163 Add support for many small features that are not essential but nice 164 Add support for many small features that are not essential but nice
164 to have. Normally you want this, but for very small binaries you may 165 to have. Normally you want this, but for very small binaries you may
165 want to disable this. 166 want to disable this.
166 167
168 A non-exhaustive list of features enabled by "--enable-frills"
169 (possibly in combination with other switches) is:
170
171 MWM-hints
172 EWMH-hints (pid, utf8 names) and protocols (ping)
173 urgency hint
174 separate underline colour (-underlineColor)
175 settable border widths and borderless switch (-w, -b, -bl)
176 visual depth selection (-depth)
177 settable extra linespacing (-lsp)
178 iso-14755 5.1 (basic) support
179 tripleclickwords (-tcw)
180 settable insecure mode (-insecure)
181 keysym remapping support
182 cursor blinking and underline cursor (-bc, -uc)
183 XEmbed support (-embed)
184 user-pty (-pty-fd)
185 hold on exit (-hold)
186 compile in built-in block graphics
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
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
205
167 --enable-iso14755 206 --enable-iso14755 (default: on)
168 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt). 207 Enable extended ISO 14755 support (see rxvt(1)). Basic support
169 Basic support (section 5.1) is enabled by "--enable-frills", while 208 (section 5.1) is enabled by "--enable-frills", while support for
170 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.
171 210
172 --enable-linespace
173 Add support to provide user specified line spacing between text
174 rows.
175
176 --enable-keepscrolling 211 --enable-keepscrolling (default: on)
177 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
178 mouse button down on a scrollbar arrow. 213 mouse button down on a scrollbar arrow.
179 214
215 --enable-selectionscrolling (default: on)
216 Add support for scrolling when the selection moves to the top or
217 bottom of the screen.
218
180 --enable-mousewheel 219 --enable-mousewheel (default: on)
181 Add support for scrolling via mouse wheel or buttons 4 & 5. 220 Add support for scrolling via mouse wheel or buttons 4 & 5.
182 221
183 --enable-slipwheeling 222 --enable-slipwheeling (default: on)
184 Add support for continual scrolling (using the mouse wheel as an 223 Add support for continual scrolling (using the mouse wheel as an
185 accelerator) while the control key is held down. This option 224 accelerator) while the control key is held down. This option
186 requires --enable-mousewheel to also be specified. 225 requires --enable-mousewheel to also be specified.
187 226
188 --disable-new-selection
189 Remove support for mouse selection style like that of xterm.
190
191 --enable-dmalloc
192 Use Gray Watson's malloc - which is good for debugging See
193 http://www.letters.com/dmalloc/ for details If you use either this
194 or the next option, you may need to edit src/Makefile after
195 compiling to point DINCLUDE and DLIB to the right places.
196
197 You can only use either this option and the following (should you
198 use either) .
199
200 --enable-dlmalloc
201 Use Doug Lea's malloc - which is good for a production version See
202 <http://g.oswego.edu/dl/html/malloc.html> for details.
203
204 --enable-smart-resize 227 --enable-smart-resize (default: off)
205 Add smart growth/shrink behaviour when changing font size via from 228 Add smart growth/shrink behaviour when resizing. This should keep
206 hot keys. This should keep in a fixed position the rxvt corner which 229 the window corner which is closest to a corner of the screen in a
207 is closest to a corner of the screen. 230 fixed position.
208 231
209 --enable-256-color 232 --enable-text-blink (default: on)
210 Add support for 256 colours rather than the base 16 colours.
211
212 This option will likely go away in the future. Speak up if you don't
213 want this.
214
215 --enable-cursor-blink
216 Add support for a blinking cursor. 233 Add support for blinking text.
217 234
218 --enable-pointer-blank 235 --enable-pointer-blank (default: on)
219 Add support to have the pointer disappear when typing or inactive. 236 Add support to have the pointer disappear when typing or inactive.
220 237
221 --with-name=NAME 238 --enable-perl (default: on)
239 Enable an embedded perl interpreter. See the rxvtperl(3) manpage for
240 more info on this feature, or the files in src/perl/ for the
241 extensions that are installed by default. The perl interpreter that
242 is used can be specified via the "PERL" environment variable when
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.
268
269 --with-name=NAME (default: urxvt)
222 Set the basename for the installed binaries (default: urxvt, 270 Set the basename for the installed binaries, resulting in "urxvt",
223 resulting in urxvt, urxvtd etc.). Specify --with-name=rxvt to 271 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
224 replace rxvt.
225 272
226 --with-term=NAME 273 --with-term=NAME (default: rxvt-unicode)
227 Change the environmental variable for the terminal to NAME (default 274 Change the environmental variable for the terminal to NAME.
228 "rxvt")
229 275
230 --with-terminfo=PATH 276 --with-terminfo=PATH
231 Change the environmental variable for the path to the terminfo tree 277 Change the environmental variable for the path to the terminfo tree
232 to PATH. 278 to PATH.
233 279
234 --with-x 280 --with-x
235 Use the X Window System (pretty much default, eh?). 281 Use the X Window System (pretty much default, eh?).
236 282
237 --with-xpm-includes=DIR
238 Look for the XPM includes in DIR.
239
240 --with-xpm-library=DIR
241 Look for the XPM library in DIR.
242
243 --with-xpm
244 Not needed - define via --enable-xpm-background.
245

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines