ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/README.configure
Revision: 1.70
Committed: Mon Dec 13 16:47:27 2010 UTC (13 years, 5 months ago) by root
Branch: MAIN
CVS Tags: rel-9_10
Changes since 1.69: +1 -1 lines
Log Message:
prepare release, fix faq package download url, re-make docs with 5.10 perl

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-aliased, 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 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>).
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
126 --enable-transparency (default: on)
127 Add support for using the root pixmap as background to simulate
128 transparency. Note that blur and blend effects depend on
129 libAfterImage or on libXrender and on the availability of the RENDER
130 extension in the X server.
131
132 --enable-fading (default: on)
133 Add support for fading the text when focus is lost.
134
135 --enable-rxvt-scroll (default: on)
136 Add support for the original rxvt scrollbar.
137
138 --enable-next-scroll (default: on)
139 Add support for a NeXT-like scrollbar.
140
141 --enable-xterm-scroll (default: on)
142 Add support for an Xterm-like scrollbar.
143
144 --disable-backspace-key
145 Removes any handling of the backspace key by us - let the X server
146 do it.
147
148 --disable-delete-key
149 Removes any handling of the delete key by us - let the X server do
150 it.
151
152 --disable-resources
153 Removes any support for resource checking.
154
155 --disable-swapscreen
156 Remove support for secondary/swap screen.
157
158 --enable-frills (default: on)
159 Add support for many small features that are not essential but nice
160 to have. Normally you want this, but for very small binaries you may
161 want to disable this.
162
163 A non-exhaustive list of features enabled by "--enable-frills"
164 (possibly in combination with other switches) is:
165
166 MWM-hints
167 EWMH-hints (pid, utf8 names) and protocols (ping)
168 urgency hint
169 separate underline colour (-underlineColor)
170 settable border widths and borderless switch (-w, -b, -bl)
171 visual depth selection (-depth)
172 settable extra linespacing (-lsp)
173 iso-14755 5.1 (basic) support
174 tripleclickwords (-tcw)
175 settable insecure mode (-insecure)
176 keysym remapping support
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)
184 extended mouse reporting modes (1005 and 1015).
185
186 It also enables some non-essential features otherwise disabled, such
187 as:
188
189 some round-trip time optimisations
190 nearest colour allocation on pseudocolor screens
191 UTF8_STRING support for selection
192 sgr modes 90..97 and 100..107
193 backindex and forwardindex escape sequences
194 view change/zero scrollback escape sequences
195 locale switching escape sequence
196 window op and some xterm/OSC escape sequences
197 rectangular selections
198 trailing space removal for selections
199 verbose X error handling
200
201 --enable-iso14755 (default: on)
202 Enable extended ISO 14755 support (see rxvt(1)). Basic support
203 (section 5.1) is enabled by "--enable-frills", while support for
204 5.2, 5.3 and 5.4 is enabled with this switch.
205
206 --enable-keepscrolling (default: on)
207 Add support for continual scrolling of the display when you hold the
208 mouse button down on a scrollbar arrow.
209
210 --enable-selectionscrolling (default: on)
211 Add support for scrolling when the selection moves to the top or
212 bottom of the screen.
213
214 --enable-mousewheel (default: on)
215 Add support for scrolling via mouse wheel or buttons 4 & 5.
216
217 --enable-slipwheeling (default: on)
218 Add support for continual scrolling (using the mouse wheel as an
219 accelerator) while the control key is held down. This option
220 requires --enable-mousewheel to also be specified.
221
222 --enable-smart-resize (default: off)
223 Add smart growth/shrink behaviour when resizing. This should keep
224 the window corner which is closest to a corner of the screen in a
225 fixed position.
226
227 --enable-text-blink (default: on)
228 Add support for blinking text.
229
230 --enable-pointer-blank (default: on)
231 Add support to have the pointer disappear when typing or inactive.
232
233 --enable-perl (default: on)
234 Enable an embedded perl interpreter. See the rxvtperl(3) manpage for
235 more info on this feature, or the files in src/perl/ for the
236 extensions that are installed by default. The perl interpreter that
237 is used can be specified via the "PERL" environment variable when
238 running configure. Even when compiled in, perl will *not* be
239 initialised when all extensions have been disabled "-pe ""
240 --perl-ext-common """, so it should be safe to enable from a
241 resource standpoint.
242
243 --enable-assert (default: off)
244 Enables the assertions in the code, normally disabled. This switch
245 is only useful when developing rxvt-unicode.
246
247 --enable-256-color (default: off)
248 Force use of so-called 256 colour mode, to work around buggy
249 applications that do not support termcap/terminfo, or simply improve
250 support for applications hardcoding the xterm 256 colour table.
251
252 This switch breaks termcap/terminfo compatibility to
253 "TERM=rxvt-unicode", and consequently sets "TERM" to
254 "rxvt-unicode-256color" by default (doc/etc/ contains
255 termcap/terminfo definitions for both).
256
257 It also results in higher memory usage and can slow down rxvt
258 dramatically when more than six fonts are in use by a terminal
259 instance.
260
261 --with-afterimage-config=DIR
262 Look for the libAfterImage config script in DIR.
263
264 --with-name=NAME (default: urxvt)
265 Set the basename for the installed binaries, resulting in "urxvt",
266 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
267
268 --with-term=NAME (default: rxvt-unicode)
269 Change the environmental variable for the terminal to NAME.
270
271 --with-terminfo=PATH
272 Change the environmental variable for the path to the terminfo tree
273 to PATH.
274
275 --with-x
276 Use the X Window System (pretty much default, eh?).
277