ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/README.configure
Revision: 1.66
Committed: Sat Jul 24 14:20:48 2010 UTC (13 years, 9 months ago) by sf-exg
Branch: MAIN
Changes since 1.65: +19 -4 lines
Log Message:
*** empty log message ***

File Contents

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