ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/README.configure
Revision: 1.82
Committed: Wed Dec 31 14:20:34 2014 UTC (9 years, 4 months ago) by root
Branch: MAIN
CVS Tags: rxvt-unicode-rel-9_22, rxvt-unicode-rel-9_21
Changes since 1.81: +4 -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: on)
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=CS,... (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 precomposed 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-pixbuf (default: on)
110 Add support for GDK-PixBuf to be used for background images. It adds
111 support for many file formats including JPG, PNG, TIFF, GIF, XPM,
112 BMP, ICO and TGA.
113
114 --enable-startup-notification (default: on)
115 Add support for freedesktop startup notifications. This allows
116 window managers to display some kind of progress indicator during
117 startup.
118
119 --enable-transparency (default: on)
120 Add support for using the root pixmap as background to simulate
121 transparency. Note that this feature depends on libXrender and on
122 the availability of the RENDER extension in the X server.
123
124 --enable-fading (default: on)
125 Add support for fading the text when focus is lost.
126
127 --enable-rxvt-scroll (default: on)
128 Add support for the original rxvt scrollbar.
129
130 --enable-next-scroll (default: on)
131 Add support for a NeXT-like scrollbar.
132
133 --enable-xterm-scroll (default: on)
134 Add support for an Xterm-like scrollbar.
135
136 --disable-backspace-key
137 Removes any handling of the backspace key by us - let the X server
138 do it.
139
140 --disable-delete-key
141 Removes any handling of the delete key by us - let the X server do
142 it.
143
144 --disable-resources
145 Removes any support for resource checking.
146
147 --disable-swapscreen
148 Remove support for secondary/swap screen.
149
150 --enable-frills (default: on)
151 Add support for many small features that are not essential but nice
152 to have. Normally you want this, but for very small binaries you may
153 want to disable this.
154
155 A non-exhaustive list of features enabled by "--enable-frills"
156 (possibly in combination with other switches) is:
157
158 MWM-hints
159 EWMH-hints (pid, utf8 names) and protocols (ping)
160 urgency hint
161 separate underline colour (-underlineColor)
162 settable border widths and borderless switch (-w, -b, -bl)
163 visual depth selection (-depth)
164 settable extra linespacing (-lsp)
165 iso-14755 5.1 (basic) support
166 tripleclickwords (-tcw)
167 settable insecure mode (-insecure)
168 keysym remapping support
169 cursor blinking and underline cursor (-bc, -uc)
170 XEmbed support (-embed)
171 user-pty (-pty-fd)
172 hold on exit (-hold)
173 compile in built-in block graphics
174 skip builtin block graphics (-sbg)
175 separate highlight colour (-highlightColor, -highlightTextColor)
176 extended mouse reporting modes (1005 and 1015).
177 visual selection via -visual and -depth.
178
179 It also enables some non-essential features otherwise disabled, such
180 as:
181
182 some round-trip time optimisations
183 nearest colour allocation on pseudocolor screens
184 UTF8_STRING support for selection
185 sgr modes 90..97 and 100..107
186 backindex and forwardindex escape sequences
187 view change/zero scrollback escape sequences
188 locale switching escape sequence
189 window op and some xterm/OSC escape sequences
190 rectangular selections
191 trailing space removal for selections
192 verbose X error handling
193
194 --enable-iso14755 (default: on)
195 Enable extended ISO 14755 support (see urxvt(1)). Basic support
196 (section 5.1) is enabled by "--enable-frills", while support for
197 5.2, 5.3 and 5.4 is enabled with this switch.
198
199 --enable-keepscrolling (default: on)
200 Add support for continual scrolling of the display when you hold the
201 mouse button down on a scrollbar arrow.
202
203 --enable-selectionscrolling (default: on)
204 Add support for scrolling when the selection moves to the top or
205 bottom of the screen.
206
207 --enable-mousewheel (default: on)
208 Add support for scrolling via mouse wheel or buttons 4 & 5.
209
210 --enable-slipwheeling (default: on)
211 Add support for continual scrolling (using the mouse wheel as an
212 accelerator) while the control key is held down. This option
213 requires --enable-mousewheel to also be specified.
214
215 --enable-smart-resize (default: off)
216 Add smart growth/shrink behaviour when resizing. This should keep
217 the window corner which is closest to a corner of the screen in a
218 fixed position.
219
220 --enable-text-blink (default: on)
221 Add support for blinking text.
222
223 --enable-pointer-blank (default: on)
224 Add support to have the pointer disappear when typing or inactive.
225
226 --enable-perl (default: on)
227 Enable an embedded perl interpreter. See the urxvtperl(3) manpage
228 for more info on this feature, or the files in src/perl/ for the
229 extensions that are installed by default. The perl interpreter that
230 is used can be specified via the "PERL" environment variable when
231 running configure. Even when compiled in, perl will *not* be
232 initialised when all extensions have been disabled "-pe ""
233 --perl-ext-common """, so it should be safe to enable from a
234 resource standpoint.
235
236 --enable-assert (default: off)
237 Enables the assertions in the code, normally disabled. This switch
238 is only useful when developing rxvt-unicode.
239
240 --enable-256-color (default: off)
241 Force use of so-called 256 colour mode, to work around buggy
242 applications that do not support termcap/terminfo, or simply improve
243 support for applications hardcoding the xterm 256 colour table.
244
245 This switch breaks termcap/terminfo compatibility to
246 "TERM=rxvt-unicode", and consequently sets "TERM" to
247 "rxvt-unicode-256color" by default (doc/etc/ contains
248 termcap/terminfo definitions for both).
249
250 It also results in higher memory usage and can slow down urxvt
251 dramatically when more than six fonts are in use by a terminal
252 instance.
253
254 --with-name=NAME (default: urxvt)
255 Set the basename for the installed binaries, resulting in "urxvt",
256 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
257
258 --with-term=NAME (default: rxvt-unicode)
259 Change the environmental variable for the terminal to NAME.
260
261 --with-terminfo=PATH
262 Change the environmental variable for the path to the terminfo tree
263 to PATH.
264
265 --with-x
266 Use the X Window System (pretty much default, eh?).
267