ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.58 by root, Wed Jul 13 02:24:02 2005 UTC vs.
Revision 1.116 by root, Wed Feb 22 10:42:49 2006 UTC

16=head1 DESCRIPTION 16=head1 DESCRIPTION
17 17
18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting 18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19all escape sequences, and other background information. 19all escape sequences, and other background information.
20 20
21The newest version of this document is 21The newest version of this document is also available on the World Wide Web at
22also available on the World Wide Web at
23L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
24 23
25=head1 FREQUENTLY ASKED QUESTIONS 24=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
26 25
27=over 4
28 26
27=head2 Meta, Features & Commandline Issues
28
29=head3 My question isn't answered here, can I ask a human?
30
31Before sending me mail, you could go to IRC: C<irc.freenode.net>,
32channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
33interested in learning about new and exciting problems (but not FAQs :).
34
35=head3 Does it support tabs, can I have a tabbed rxvt-unicode?
36
37Beginning with version 7.3, there is a perl extension that implements a
38simple tabbed terminal. It is installed by default, so any of these should
39give you tabs:
40
41 @@URXVT_NAME@@ -pe tabbed
42
43 URxvt.perl-ext-common: default,tabbed
44
45It will also work fine with tabbing functionality of many window managers
46or similar tabbing programs, and its embedding-features allow it to be
47embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
48the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
49(murxvt) terminal as an example embedding application.
50
29=item How do I know which rxvt-unicode version I'm using? 51=head3 How do I know which rxvt-unicode version I'm using?
30 52
31The version number is displayed with the usage (-h). Also the escape 53The version number is displayed with the usage (-h). Also the escape
32sequence C<ESC [ 8 n> sets the window title to the version number. 54sequence C<ESC [ 8 n> sets the window title to the version number. When
55using the @@URXVT_NAME@@c client, the version displayed is that of the
56daemon.
33 57
34=item I am using Debian GNU/Linux and have a problem... 58=head3 Rxvt-unicode uses gobs of memory, how can I reduce that?
35 59
36The Debian GNU/Linux package of rxvt-unicode in sarge contains large 60Rxvt-unicode tries to obey the rule of not charging you for something you
37patches that considerably change the behaviour of rxvt-unicode. Before 61don't use. One thing you should try is to configure out all settings that
38reporting a bug to the original rxvt-unicode author please download and 62you don't need, for example, Xft support is a resource hog by design,
39install the genuine version (L<http://software.schmorp.de#rxvt-unicode>) 63when used. Compiling it out ensures that no Xft font will be loaded
40and try to reproduce the problem. If you cannot, chances are that the 64accidentally when rxvt-unicode tries to find a font for your characters.
41problems are specific to Debian GNU/Linux, in which case it should be
42reported via the Debian Bug Tracking System (use C<reportbug> to report
43the bug).
44 65
45For other problems that also affect the Debian package, you can and 66Also, many people (me included) like large windows and even larger
46probably should use the Debian BTS, too, because, after all, it's also a 67scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
47bug in the Debian version and it serves as a reminder for other users that 686 bytes per screen cell. For a 160x?? window this amounts to almost a
48might encounter the same issue. 69kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
70use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
71rxvt-unicode then uses 8 bytes per screen cell.
49 72
73=head3 How can I start @@URXVT_NAME@@d in a race-free way?
74
75Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
76display, create the listening socket and then fork.
77
78=head3 How can I start @@URXVT_NAME@@d automatically when I run URXVT_NAME@@c?
79
80If you want to start @@URXVT_NAME@@d automatically whenever you run
81@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
82
83 #!/bin/sh
84 @@URXVT_NAME@@c "$@"
85 if [ $? -eq 2 ]; then
86 @@URXVT_NAME@@d -q -o -f
87 @@URXVT_NAME@@c "$@"
88 fi
89
90This tries to create a new terminal, and if fails with exit status 2,
91meaning it couldn't connect to the daemon, it will start the daemon and
92re-run the command. Subsequent invocations of the script will re-use the
93existing daemon.
94
95=head3 How do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
96
97The original rxvt and rxvt-unicode always export the variable "COLORTERM",
98so you can check and see if that is set. Note that several programs, JED,
99slrn, Midnight Commander automatically check this variable to decide
100whether or not to use color.
101
102=head3 How do I set the correct, full IP address for the DISPLAY variable?
103
104If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
105insecure mode then it is possible to use the following shell script
106snippets to correctly set the display. If your version of rxvt-unicode
107wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
108the COLORTERM variable can be used to distinguish rxvt-unicode from a
109regular xterm.
110
111Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
112snippets:
113
114 # Bourne/Korn/POSIX family of shells:
115 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
116 if [ ${TERM:-foo} = xterm ]; then
117 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
118 echo -n '^[Z'
119 read term_id
120 stty icanon echo
121 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
122 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
123 read DISPLAY # set it in our local shell
124 fi
125 fi
126
127=head3 How do I compile the manual pages on my own?
128
129You need to have a recent version of perl installed as F</usr/bin/perl>,
130one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
131the doc subdirectory and enter C<make alldoc>.
132
133=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
134
135I often get asked about this, and I think, no, they didn't cause extra
136bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
137that the urxvt binary is larger (due to some encoding tables always being
138compiled in), but it actually uses less memory (RSS) after startup. Even
139with C<--disable-everything>, this comparison is a bit unfair, as many
140features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
141already in use in this mode.
142
143 text data bss drs rss filename
144 98398 1664 24 15695 1824 rxvt --disable-everything
145 188985 9048 66616 18222 1788 urxvt --disable-everything
146
147When you C<--enable-everything> (which I<is> unfair, as this involves xft
148and full locale/XIM support which are quite bloaty inside libX11 and my
149libc), the two diverge, but not unreasnobaly so.
150
151 text data bss drs rss filename
152 163431 2152 24 20123 2060 rxvt --enable-everything
153 1035683 49680 66648 29096 3680 urxvt --enable-everything
154
155The very large size of the text section is explained by the east-asian
156encoding tables, which, if unused, take up disk space but nothing else
157and can be compiled out unless you rely on X11 core fonts that use those
158encodings. The BSS size comes from the 64k emergency buffer that my c++
159compiler allocates (but of course doesn't use unless you are out of
160memory). Also, using an xft font instead of a core font immediately adds a
161few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
162not used.
163
164Of course, due to every character using two or four bytes instead of one,
165a large scrollback buffer will ultimately make rxvt-unicode use more
166memory.
167
168Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
169still fares rather well. And compared to some monsters like gnome-terminal
170(21152k + extra 4204k in separate processes) or konsole (22200k + extra
17143180k in daemons that stay around after exit, plus half a minute of
172startup time, including the hundreds of warnings it spits out), it fares
173extremely well *g*.
174
175=head3 Why C++, isn't that unportable/bloated/uncool?
176
177Is this a question? :) It comes up very often. The simple answer is: I had
178to write it, and C++ allowed me to write and maintain it in a fraction
179of the time and effort (which is a scarce resource for me). Put even
180shorter: It simply wouldn't exist without C++.
181
182My personal stance on this is that C++ is less portable than C, but in
183the case of rxvt-unicode this hardly matters, as its portability limits
184are defined by things like X11, pseudo terminals, locale support and unix
185domain sockets, which are all less portable than C++ itself.
186
187Regarding the bloat, see the above question: It's easy to write programs
188in C that use gobs of memory, an certainly possible to write programs in
189C++ that don't. C++ also often comes with large libraries, but this is
190not necessarily the case with GCC. Here is what rxvt links against on my
191system with a minimal config:
192
193 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
194 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
195 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
196 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
197
198And here is rxvt-unicode:
199
200 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
201 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
202 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
203 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
204 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
205
206No large bloated libraries (of course, none were linked in statically),
207except maybe libX11 :)
208
209
210=head2 Rendering, Font & Look and Feel Issues
211
212=head3 I can't get transparency working, what am I doing wrong?
213
214First of all, transparency isn't officially supported in rxvt-unicode, so
215you are mostly on your own. Do not bug the author about it (but you may
216bug everybody else). Also, if you can't get it working consider it a rite
217of passage: ... and you failed.
218
219Here are four ways to get transparency. B<Do> read the manpage and option
220descriptions for the programs mentioned and rxvt-unicode. Really, do it!
221
2221. Use inheritPixmap:
223
224 Esetroot wallpaper.jpg
225 @@URXVT_NAME@@ -ip -tint red -sh 40
226
227That works. If you think it doesn't, you lack transparency and tinting
228support, or you are unable to read.
229
2302. Use a simple pixmap and emulate pseudo-transparency. This enables you
231to use effects other than tinting and shading: Just shade/tint/whatever
232your picture with gimp or any other tool:
233
234 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
235 @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background
236
237That works. If you think it doesn't, you lack XPM and Perl support, or you
238are unable to read.
239
2403. Use an ARGB visual:
241
242 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
243
244This requires XFT support, and the support of your X-server. If that
245doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
246there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
247bugfixes and workarounds for Xft and Xlib to make it work, but that
248doesn't mean that your WM has the required kludges in place.
249
2504. Use xcompmgr and let it do the job:
251
252 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
253 -set _NET_WM_WINDOW_OPACITY 0xc0000000
254
255Then click on a window you want to make transparent. Replace C<0xc0000000>
256by other values to change the degree of opacity. If it doesn't work and
257your server crashes, you got to keep the pieces.
258
259=head3 Why does rxvt-unicode sometimes leave pixel droppings?
260
261Most fonts were not designed for terminal use, which means that character
262size varies a lot. A font that is otherwise fine for terminal use might
263contain some characters that are simply too wide. Rxvt-unicode will avoid
264these characters. For characters that are just "a bit" too wide a special
265"careful" rendering mode is used that redraws adjacent characters.
266
267All of this requires that fonts do not lie about character sizes,
268however: Xft fonts often draw glyphs larger than their acclaimed bounding
269box, and rxvt-unicode has no way of detecting this (the correct way is to
270ask for the character bounding box, which unfortunately is wrong in these
271cases).
272
273It's not clear (to me at least), wether this is a bug in Xft, freetype,
274or the respective font. If you encounter this problem you might try using
275the C<-lsp> option to give the font more height. If that doesn't work, you
276might be forced to use a different font.
277
278All of this is not a problem when using X11 core fonts, as their bounding
279box data is correct.
280
281=head3 How can I keep rxvt-unicode from using reverse video so much?
282
283First of all, make sure you are running with the right terminal settings
284(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
285make sure you have specified colours for italic and bold, as otherwise
286rxvt-unicode might use reverse video to simulate the effect:
287
288 URxvt.colorBD: white
289 URxvt.colorIT: green
290
291=head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
292
293For some unexplainable reason, some rare programs assume a very weird
294colour palette when confronted with a terminal with more than the standard
2958 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
296these programs not to assume non-ISO colours without very good reasons.
297
298In the meantime, you can either edit your C<rxvt-unicode> terminfo
299definition to only claim 8 colour support or use C<TERM=rxvt>, which will
300fix colours but keep you from using other rxvt-unicode features.
301
302=head3 Can I switch the fonts at runtime?
303
304Yes, using an escape sequence. Try something like this, which has the same
305effect as using the C<-fn> switch, and takes effect immediately:
306
307 printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
308
309This is useful if you e.g. work primarily with japanese (and prefer a
310japanese font), but you have to switch to chinese temporarily, where
311japanese fonts would only be in your way.
312
313You can think of this as a kind of manual ISO-2022 switching.
314
315=head3 Why do italic characters look as if clipped?
316
317Many fonts have difficulties with italic characters and hinting. For
318example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
319Mono> completely fails in it's italic face. A workaround might be to
320enable freetype autohinting, i.e. like this:
321
322 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
323 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
324
325=head3 Can I speed up Xft rendering somehow?
326
327Yes, the most obvious way to speed it up is to avoid Xft entirely, as
328it is simply slow. If you still want Xft fonts you might try to disable
329antialiasing (by appending C<:antialias=false>), which saves lots of
330memory and also speeds up rendering considerably.
331
332=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
333
334Rxvt-unicode will use whatever you specify as a font. If it needs to
335fall back to it's default font search list it will prefer X11 core
336fonts, because they are small and fast, and then use Xft fonts. It has
337antialiasing disabled for most of them, because the author thinks they
338look best that way.
339
340If you want antialiasing, you have to specify the fonts manually.
341
342=head3 What's with this bold/blink stuff?
343
344If no bold colour is set via C<colorBD:>, bold will invert text using the
345standard foreground colour.
346
347For the standard background colour, blinking will actually make the
348text blink when compiled with C<--enable-blinking>. with standard
349colours. Without C<--enable-blinking>, the blink attribute will be
350ignored.
351
352On ANSI colours, bold/blink attributes are used to set high-intensity
353foreground/background colors.
354
355color0-7 are the low-intensity colors.
356
357color8-15 are the corresponding high-intensity colors.
358
359=head3 I don't like the screen colors. How do I change them?
360
361You can change the screen colors at run-time using F<~/.Xdefaults>
362resources (or as long-options).
363
364Here are values that are supposed to resemble a VGA screen,
365including the murky brown that passes for low-intensity yellow:
366
367 URxvt.color0: #000000
368 URxvt.color1: #A80000
369 URxvt.color2: #00A800
370 URxvt.color3: #A8A800
371 URxvt.color4: #0000A8
372 URxvt.color5: #A800A8
373 URxvt.color6: #00A8A8
374 URxvt.color7: #A8A8A8
375
376 URxvt.color8: #000054
377 URxvt.color9: #FF0054
378 URxvt.color10: #00FF54
379 URxvt.color11: #FFFF54
380 URxvt.color12: #0000FF
381 URxvt.color13: #FF00FF
382 URxvt.color14: #00FFFF
383 URxvt.color15: #FFFFFF
384
385And here is a more complete set of non-standard colors.
386
387 URxvt.cursorColor: #dc74d1
388 URxvt.pointerColor: #dc74d1
389 URxvt.background: #0e0e0e
390 URxvt.foreground: #4ad5e1
391 URxvt.color0: #000000
392 URxvt.color8: #8b8f93
393 URxvt.color1: #dc74d1
394 URxvt.color9: #dc74d1
395 URxvt.color2: #0eb8c7
396 URxvt.color10: #0eb8c7
397 URxvt.color3: #dfe37e
398 URxvt.color11: #dfe37e
399 URxvt.color5: #9e88f0
400 URxvt.color13: #9e88f0
401 URxvt.color6: #73f7ff
402 URxvt.color14: #73f7ff
403 URxvt.color7: #e1dddd
404 URxvt.color15: #e1dddd
405
406They have been described (not by me) as "pretty girly".
407
408=head3 Why do some characters look so much different than others?
409
410See next entry.
411
412=head3 How does rxvt-unicode choose fonts?
413
414Most fonts do not contain the full range of Unicode, which is
415fine. Chances are that the font you (or the admin/package maintainer of
416your system/os) have specified does not cover all the characters you want
417to display.
418
419B<rxvt-unicode> makes a best-effort try at finding a replacement
420font. Often the result is fine, but sometimes the chosen font looks
421bad/ugly/wrong. Some fonts have totally strange characters that don't
422resemble the correct glyph at all, and rxvt-unicode lacks the artificial
423intelligence to detect that a specific glyph is wrong: it has to believe
424the font that the characters it claims to contain indeed look correct.
425
426In that case, select a font of your taste and add it to the font list,
427e.g.:
428
429 @@URXVT_NAME@@ -fn basefont,font2,font3...
430
431When rxvt-unicode sees a character, it will first look at the base
432font. If the base font does not contain the character, it will go to the
433next font, and so on. Specifying your own fonts will also speed up this
434search and use less resources within rxvt-unicode and the X-server.
435
436The only limitation is that none of the fonts may be larger than the base
437font, as the base font defines the terminal character cell size, which
438must be the same due to the way terminals work.
439
440=head3 Why do some chinese characters look so different than others?
441
442This is because there is a difference between script and language --
443rxvt-unicode does not know which language the text that is output is,
444as it only knows the unicode character codes. If rxvt-unicode first
445sees a japanese/chinese character, it might choose a japanese font for
446display. Subsequent japanese characters will use that font. Now, many
447chinese characters aren't represented in japanese fonts, so when the first
448non-japanese character comes up, rxvt-unicode will look for a chinese font
449-- unfortunately at this point, it will still use the japanese font for
450chinese characters that are also in the japanese font.
451
452The workaround is easy: just tag a chinese font at the end of your font
453list (see the previous question). The key is to view the font list as
454a preference list: If you expect more japanese, list a japanese font
455first. If you expect more chinese, put a chinese font first.
456
457In the future it might be possible to switch language preferences at
458runtime (the internal data structure has no problem with using different
459fonts for the same character at the same time, but no interface for this
460has been designed yet).
461
462Until then, you might get away with switching fonts at runtime (see L<Can
463I switch the fonts at runtime?> later in this document).
464
465=head2 Keyboard, Mouse & User Interaction
466
467=head3 The new selection selects pieces that are too big, how can I select single words?
468
469If you want to select e.g. alphanumeric words, you can use the following
470setting:
471
472 URxvt.selection.pattern-0: ([[:word:]]+)
473
474If you click more than twice, the selection will be extended
475more and more.
476
477To get a selection that is very similar to the old code, try this pattern:
478
479 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
480
481Please also note that the I<LeftClick Shift-LeftClik> combination also
482selects words like the old code.
483
484=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
485
486You can disable the perl extension completely by setting the
487B<perl-ext-common> resource to the empty string, which also keeps
488rxvt-unicode from initialising perl, saving memory.
489
490If you only want to disable specific features, you first have to
491identify which perl extension is responsible. For this, read the section
492B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
493example, to disable the B<selection-popup> and B<option-popup>, specify
494this B<perl-ext-common> resource:
495
496 URxvt.perl-ext-common: default,-selection-popup,-option-popup
497
498This will keep the default extensions, but disable the two popup
499extensions. Some extensions can also be configured, for example,
500scrollback search mode is triggered by B<M-s>. You can move it to any
501other combination either by setting the B<searchable-scrollback> resource:
502
503 URxvt.searchable-scrollback: CM-s
504
505=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
506
507See next entry.
508
509=head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
510
511These are caused by the C<readline> perl extension. Under normal
512circumstances, it will move your cursor around when you click into the
513line that contains it. It tries hard not to do this at the wrong moment,
514but when running a program that doesn't parse cursor movements or in some
515cases during rlogin sessions, it fails to detect this properly.
516
517You can permamently switch this feature off by disabling the C<readline>
518extension:
519
520 URxvt.perl-ext-common: default,-readline
521
522=head3 My numerical keypad acts weird and generates differing output?
523
524Some Debian GNUL/Linux users seem to have this problem, although no
525specific details were reported so far. It is possible that this is caused
526by the wrong C<TERM> setting, although the details of wether and how
527this can happen are unknown, as C<TERM=rxvt> should offer a compatible
528keymap. See the answer to the previous question, and please report if that
529helped.
530
531=head3 My Compose (Multi_key) key is no longer working.
532
533The most common causes for this are that either your locale is not set
534correctly, or you specified a B<preeditStyle> that is not supported by
535your input method. For example, if you specified B<OverTheSpot> and
536your input method (e.g. the default input method handling Compose keys)
537does not support this (for instance because it is not visual), then
538rxvt-unicode will continue without an input method.
539
540In this case either do not specify a B<preeditStyle> or specify more than
541one pre-edit style, such as B<OverTheSpot,Root,None>.
542
543=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
544
545Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
546international keyboards) or simply use ISO 14755 support to your
547advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
548codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
549character and so on.
550
551=head3 Mouse cut/paste suddenly no longer works.
552
553Make sure that mouse reporting is actually turned off since killing
554some editors prematurely may leave the mouse in mouse report mode. I've
555heard that tcsh may use mouse reporting unless it otherwise specified. A
556quick check is to see if cut/paste works when the Alt or Shift keys are
557depressed.
558
559=head3 What's with the strange Backspace/Delete key behaviour?
560
561Assuming that the physical Backspace key corresponds to the
562BackSpace keysym (not likely for Linux ... see the following
563question) there are two standard values that can be used for
564Backspace: C<^H> and C<^?>.
565
566Historically, either value is correct, but rxvt-unicode adopts the debian
567policy of using C<^?> when unsure, because it's the one only only correct
568choice :).
569
570Rxvt-unicode tries to inherit the current stty settings and uses the value
571of `erase' to guess the value for backspace. If rxvt-unicode wasn't
572started from a terminal (say, from a menu or by remote shell), then the
573system value of `erase', which corresponds to CERASE in <termios.h>, will
574be used (which may not be the same as your stty setting).
575
576For starting a new rxvt-unicode:
577
578 # use Backspace = ^H
579 $ stty erase ^H
580 $ @@URXVT_NAME@@
581
582 # use Backspace = ^?
583 $ stty erase ^?
584 $ @@URXVT_NAME@@
585
586Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
587
588For an existing rxvt-unicode:
589
590 # use Backspace = ^H
591 $ stty erase ^H
592 $ echo -n "^[[36h"
593
594 # use Backspace = ^?
595 $ stty erase ^?
596 $ echo -n "^[[36l"
597
598This helps satisfy some of the Backspace discrepancies that occur, but
599if you use Backspace = C<^H>, make sure that the termcap/terminfo value
600properly reflects that.
601
602The Delete key is a another casualty of the ill-defined Backspace problem.
603To avoid confusion between the Backspace and Delete keys, the Delete
604key has been assigned an escape sequence to match the vt100 for Execute
605(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
606
607Some other Backspace problems:
608
609some editors use termcap/terminfo,
610some editors (vim I'm told) expect Backspace = ^H,
611GNU Emacs (and Emacs-like editors) use ^H for help.
612
613Perhaps someday this will all be resolved in a consistent manner.
614
615=head3 I don't like the key-bindings. How do I change them?
616
617There are some compile-time selections available via configure. Unless
618you have run "configure" with the C<--disable-resources> option you can
619use the `keysym' resource to alter the keystrings associated with keysyms.
620
621Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
622
623 URxvt.keysym.Home: \033[1~
624 URxvt.keysym.End: \033[4~
625 URxvt.keysym.C-apostrophe: \033<C-'>
626 URxvt.keysym.C-slash: \033<C-/>
627 URxvt.keysym.C-semicolon: \033<C-;>
628 URxvt.keysym.C-grave: \033<C-`>
629 URxvt.keysym.C-comma: \033<C-,>
630 URxvt.keysym.C-period: \033<C-.>
631 URxvt.keysym.C-0x60: \033<C-`>
632 URxvt.keysym.C-Tab: \033<C-Tab>
633 URxvt.keysym.C-Return: \033<C-Return>
634 URxvt.keysym.S-Return: \033<S-Return>
635 URxvt.keysym.S-space: \033<S-Space>
636 URxvt.keysym.M-Up: \033<M-Up>
637 URxvt.keysym.M-Down: \033<M-Down>
638 URxvt.keysym.M-Left: \033<M-Left>
639 URxvt.keysym.M-Right: \033<M-Right>
640 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
641 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
642 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
643
644See some more examples in the documentation for the B<keysym> resource.
645
646=head3 I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map
647
648 KP_Insert == Insert
649 F22 == Print
650 F27 == Home
651 F29 == Prior
652 F33 == End
653 F35 == Next
654
655Rather than have rxvt-unicode try to accommodate all the various possible
656keyboard mappings, it is better to use `xmodmap' to remap the keys as
657required for your particular machine.
658
659
660
661=head2 Terminal Configuration
662
663=head3 Can I see a typical configuration?
664
665The default configuration tries to be xterm-like, which I don't like that
666much, but it's least surprise to regular users.
667
668As a rxvt or rxvt-unicode user, you are practically supposed to invest
669time into customising your terminal. To get you started, here is the
670author's .Xdefaults entries, with comments on what they do. It's certainly
671not I<typical>, but what's typical...
672
673 URxvt.cutchars: "()*,<>[]{}|'
674 URxvt.print-pipe: cat >/tmp/xxx
675
676These are just for testing stuff.
677
678 URxvt.imLocale: ja_JP.UTF-8
679 URxvt.preeditType: OnTheSpot,None
680
681This tells rxvt-unicode to use a special locale when communicating with
682the X Input Method, and also tells it to only use the OnTheSpot pre-edit
683type, which requires the C<xim-onthespot> perl extension but rewards me
684with correct-looking fonts.
685
686 URxvt.perl-lib: /root/lib/urxvt
687 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
688 URxvt.selection.pattern-0: ( at .*? line \\d+)
689 URxvt.selection.pattern-1: ^(/[^:]+):\
690 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
691 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
692
693This is my perl configuration. The first two set the perl library
694directory and also tells urxvt to use a large number of extensions. I
695develop for myself mostly, so I actually use most of the extensions I
696write.
697
698The selection stuff mainly makes the selection perl-error-message aware
699and tells it to convert pelr error mssages into vi-commands to load the
700relevant file and go tot he error line number.
701
702 URxvt.scrollstyle: plain
703 URxvt.secondaryScroll: true
704
705As the documentation says: plain is the preferred scrollbar for the
706author. The C<secondaryScroll> confgiures urxvt to scroll in full-screen
707apps, like screen, so lines scorlled out of screen end up in urxvt's
708scrollback buffer.
709
710 URxvt.background: #000000
711 URxvt.foreground: gray90
712 URxvt.color7: gray90
713 URxvt.colorBD: #ffffff
714 URxvt.cursorColor: #e0e080
715 URxvt.throughColor: #8080f0
716 URxvt.highlightColor: #f0f0f0
717
718Some colours. Not sure which ones are being used or even non-defaults, but
719these are in my .Xdefaults. Most notably, they set foreground/background
720to light gray/black, and also make sure that the colour 7 matches the
721default foreground colour.
722
723 URxvt.underlineColor: yellow
724
725Another colour, makes underline lines look different. Sometimes hurts, but
726is mostly a nice effect.
727
728 URxvt.geometry: 154x36
729 URxvt.loginShell: false
730 URxvt.meta: ignore
731 URxvt.utmpInhibit: true
732
733Uh, well, should be mostly self-explanatory. By specifying some defaults
734manually, I can quickly switch them for testing.
735
736 URxvt.saveLines: 8192
737
738A large scrollback buffer is essential. Really.
739
740 URxvt.mapAlert: true
741
742The only case I use it is for my IRC window, which I like to keep
743iconified till people msg me (which beeps).
744
745 URxvt.visualBell: true
746
747The audible bell is often annoying, especially when in a crowd.
748
749 URxvt.insecure: true
750
751Please don't hack my mutt! Ooops...
752
753 URxvt.pastableTabs: false
754
755I once thought this is a great idea.
756
757 urxvt.font: 9x15bold,\
758 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
759 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
760 [codeset=JISX0208]xft:Kochi Gothic, \
761 xft:Bitstream Vera Sans Mono:autohint=true, \
762 xft:Code2000:antialias=false
763 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
764 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
765 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
766
767I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
768overwhelmed. A special note: the C<9x15bold> mentioend above is actually
769the version from XFree-3.3, as XFree-4 replaced it by a totally different
770font (different glyphs for C<;> and many other harmless characters),
771while the second font is actually the C<9x15bold> from XFree4/XOrg. The
772bold version has less chars than the medium version, so I use it for rare
773characters, too. Whene ditign sources with vim, I use italic for comments
774and other stuff, which looks quite good with Bitstream Vera anti-aliased.
775
776Terminus is a quite bad font (many very wrong glyphs), but for most of my
777purposes, it works, and gives a different look, as my normal (Non-bold)
778font is already bold, and I want to see a difference between bold and
779normal fonts.
780
781Please note that I used the C<urxvt> instance name and not the C<URxvt>
782class name. Thats because I use different configs for different purposes,
783for example, my IRC window is started with C<-name IRC>, and uses these
784defaults:
785
786 IRC*title: IRC
787 IRC*geometry: 87x12+535+542
788 IRC*saveLines: 0
789 IRC*mapAlert: true
790 IRC*font: suxuseuro
791 IRC*boldFont: suxuseuro
792 IRC*colorBD: white
793 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
794 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
795
796C<Alt-Shift-1> and C<Alt-Shift-2> switch between two different font
797sizes. C<suxuseuro> allows me to keep an eye (and actually read)
798stuff while keeping a very small window. If somebody pastes something
799complicated (e.g. japanese), I temporarily switch to a larger font.
800
801The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
802C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
803file for different hosts, for example, on ym main desktop, I use:
804
805 URxvt.keysym.C-M-q: command:\033[3;5;5t
806 URxvt.keysym.C-M-y: command:\033[3;5;606t
807 URxvt.keysym.C-M-e: command:\033[3;1605;5t
808 URxvt.keysym.C-M-c: command:\033[3;1605;606t
809 URxvt.keysym.C-M-p: perl:test
810
811The first for keysym definitions allow me to quickly bring some windows
812in the layout I like most. Ion users might start laughing but will stop
813immediately when I tell them that I use my own Fvwm2 module for much the
814same effect as Ion provides, and I only very rarely use the above key
815combinations :->
816
817=head3 Why doesn't rxvt-unicode read my resources?
818
819Well, why, indeed? It does, in a way very similar to other X
820applications. Most importantly, this means that if you or your OS loads
821resources into the X display (the right way to do it), rxvt-unicode will
822ignore any resource files in your home directory. It will only read
823F<$HOME/.Xdefaults> when no resources are attached to the display.
824
825If you have or use an F<$HOME/.Xresources> file, chances are that
826resources are loaded into your X-server. In this case, you have to
827re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
828
829Also consider the form resources have to use:
830
831 URxvt.resource: value
832
833If you want to use another form (there are lots of different ways of
834specifying resources), make sure you understand wether and why it
835works. If unsure, use the form above.
836
50=item When I log-in to another system it tells me about missing terminfo data? 837=head3 When I log-in to another system it tells me about missing terminfo data?
51 838
52The terminal description used by rxvt-unicode is not as widely available 839The terminal description used by rxvt-unicode is not as widely available
53as that for xterm, or even rxvt (for which the same problem often arises). 840as that for xterm, or even rxvt (for which the same problem often arises).
54 841
55The correct solution for this problem is to install the terminfo, this can 842The correct solution for this problem is to install the terminfo, this can
71resource to set it: 858resource to set it:
72 859
73 URxvt.termName: rxvt 860 URxvt.termName: rxvt
74 861
75If you don't plan to use B<rxvt> (quite common...) you could also replace 862If you don't plan to use B<rxvt> (quite common...) you could also replace
76the rxvt terminfo file with the rxvt-unicode one. 863the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
77 864
78=item C<tic> outputs some error when compiling the terminfo entry. 865=head3 C<tic> outputs some error when compiling the terminfo entry.
79 866
80Most likely it's the empty definition for C<enacs=>. Just replace it by 867Most likely it's the empty definition for C<enacs=>. Just replace it by
81C<enacs=\E[0@> and try again. 868C<enacs=\E[0@> and try again.
82 869
83=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@. 870=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
84 871
872See next entry.
873
85=item I need a termcap file entry. 874=head3 I need a termcap file entry.
86 875
87One reason you might want this is that some distributions or operating 876One reason you might want this is that some distributions or operating
88systems still compile some programs using the long-obsoleted termcap 877systems still compile some programs using the long-obsoleted termcap
89library (Fedora Core's bash is one example) and rely on a termcap entry 878library (Fedora Core's bash is one example) and rely on a termcap entry
90for C<rxvt-unicode>. 879for C<rxvt-unicode>.
116 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\ 905 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
117 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\ 906 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
118 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\ 907 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
119 :vs=\E[?25h: 908 :vs=\E[?25h:
120 909
121=item Why does C<ls> no longer have coloured output? 910=head3 Why does C<ls> no longer have coloured output?
122 911
123The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 912The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
124decide wether a terminal has colour, but uses it's own configuration 913decide wether a terminal has colour, but uses it's own configuration
125file. Needless to say, C<rxvt-unicode> is not in it's default file (among 914file. Needless to say, C<rxvt-unicode> is not in it's default file (among
126with most other terminals supporting colour). Either add: 915with most other terminals supporting colour). Either add:
131 920
132 alias ls='ls --color=auto' 921 alias ls='ls --color=auto'
133 922
134to your C<.profile> or C<.bashrc>. 923to your C<.profile> or C<.bashrc>.
135 924
136=item Why doesn't vim/emacs etc. use the 88 colour mode? 925=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
137 926
927See next entry.
928
138=item Why doesn't vim/emacs etc. make use of italic? 929=head3 Why doesn't vim/emacs etc. make use of italic?
139 930
931See next entry.
932
140=item Why are the secondary screen-related options not working properly? 933=head3 Why are the secondary screen-related options not working properly?
141 934
142Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged 935Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
143distributions (most notably Debian GNU/Linux) break rxvt-unicode 936distributions (most notably Debian GNU/Linux) break rxvt-unicode
144by setting C<TERM> to C<rxvt>, which doesn't have these extra 937by setting C<TERM> to C<rxvt>, which doesn't have these extra
145features. Unfortunately, some of these (most notably, again, Debian 938features. Unfortunately, some of these (most notably, again, Debian
146GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo 939GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
147file, so you will need to install it on your own (See the question B<When 940file, so you will need to install it on your own (See the question B<When
148I log-in to another system it tells me about missing terminfo data?> on 941I log-in to another system it tells me about missing terminfo data?> on
149how to do this). 942how to do this).
150 943
151=item My numerical keypad acts weird and generates differing output?
152 944
153Some Debian GNUL/Linux users seem to have this problem, although no 945=head2 Encoding / Locale / Input Method Issues
154specific details were reported so far. It is possible that this is caused
155by the wrong C<TERM> setting, although the details of wether and how
156this can happen are unknown, as C<TERM=rxvt> should offer a compatible
157keymap. See the answer to the previous question, and please report if that
158helped.
159 946
160=item Rxvt-unicode does not seem to understand the selected encoding? 947=head3 Rxvt-unicode does not seem to understand the selected encoding?
161 948
949See next entry.
950
162=item Unicode does not seem to work? 951=head3 Unicode does not seem to work?
163 952
164If you encounter strange problems like typing an accented character but 953If you encounter strange problems like typing an accented character but
165getting two unrelated other characters or similar, or if program output is 954getting two unrelated other characters or similar, or if program output is
166subtly garbled, then you should check your locale settings. 955subtly garbled, then you should check your locale settings.
167 956
171something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work. 960something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
172 961
173The best thing is to fix your startup environment, as you will likely run 962The best thing is to fix your startup environment, as you will likely run
174into other problems. If nothing works you can try this in your .profile. 963into other problems. If nothing works you can try this in your .profile.
175 964
176 printf '\e]701;%s\007' "$LC_CTYPE" 965 printf '\33]701;%s\007' "$LC_CTYPE"
177 966
178If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 967If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
179supported on your systems. Some systems have a C<locale> command which 968supported on your systems. Some systems have a C<locale> command which
180displays this (also, C<perl -e0> can be used to check locale settings, as 969displays this (also, C<perl -e0> can be used to check locale settings, as
181it will complain loudly if it cannot set the locale). If it displays something 970it will complain loudly if it cannot set the locale). If it displays something
187 976
188If nothing works and you are sure that everything is set correctly then 977If nothing works and you are sure that everything is set correctly then
189you will need to remember a little known fact: Some programs just don't 978you will need to remember a little known fact: Some programs just don't
190support locales :( 979support locales :(
191 980
192=item Why do some characters look so much different than others? 981=head3 How does rxvt-unicode determine the encoding to use?
193 982
194=item How does rxvt-unicode choose fonts? 983See next entry.
195 984
196Most fonts do not contain the full range of Unicode, which is 985=head3 Is there an option to switch encodings?
197fine. Chances are that the font you (or the admin/package maintainer of
198your system/os) have specified does not cover all the characters you want
199to display.
200 986
201B<rxvt-unicode> makes a best-effort try at finding a replacement 987Unlike some other terminals, rxvt-unicode has no encoding switch, and no
202font. Often the result is fine, but sometimes the chosen font looks 988specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
203bad/ugly/wrong. Some fonts have totally strange characters that don't 989UTF-8 or any other encodings with respect to terminal I/O.
204resemble the correct glyph at all, and rxvt-unicode lacks the artificial
205intelligence to detect that a specific glyph is wrong: it has to believe
206the font that the characters it claims to contain indeed look correct.
207 990
208In that case, select a font of your taste and add it to the font list, 991The reasons is that there exists a perfectly fine mechanism for selecting
209e.g.: 992the encoding, doing I/O and (most important) communicating this to all
210 993applications so everybody agrees on character properties such as width
211 @@RXVT_NAME@@ -fn basefont,font2,font3... 994and code number. This mechanism is the I<locale>. Applications not using
212 995that info will have problems (for example, C<xterm> gets the width of
213When rxvt-unicode sees a character, it will first look at the base 996characters wrong as it uses it's own, locale-independent table under all
214font. If the base font does not contain the character, it will go to the
215next font, and so on. Specifying your own fonts will also speed up this
216search and use less resources within rxvt-unicode and the X-server.
217
218The only limitation is that none of the fonts may be larger than the base
219font, as the base font defines the terminal character cell size, which
220must be the same due to the way terminals work.
221
222=item Why do some chinese characters look so different than others?
223
224This is because there is a difference between script and language --
225rxvt-unicode does not know which language the text that is output is,
226as it only knows the unicode character codes. If rxvt-unicode first
227sees a japanese/chinese character, it might choose a japanese font for
228display. Subsequent japanese characters will use that font. Now, many
229chinese characters aren't represented in japanese fonts, so when the first
230non-japanese character comes up, rxvt-unicode will look for a chinese font
231-- unfortunately at this point, it will still use the japanese font for
232chinese characters that are also in the japanese font.
233
234The workaround is easy: just tag a chinese font at the end of your font
235list (see the previous question). The key is to view the font list as
236a preference list: If you expect more japanese, list a japanese font
237first. If you expect more chinese, put a chinese font first.
238
239In the future it might be possible to switch language preferences at
240runtime (the internal data structure has no problem with using different
241fonts for the same character at the same time, but no interface for this
242has been designed yet).
243
244Until then, you might get away with switching fonts at runtime (see L<Can
245I switch the fonts at runtime?> later in this document).
246
247=item Why does rxvt-unicode sometimes leave pixel droppings?
248
249Most fonts were not designed for terminal use, which means that character
250size varies a lot. A font that is otherwise fine for terminal use might
251contain some characters that are simply too wide. Rxvt-unicode will avoid
252these characters. For characters that are just "a bit" too wide a special
253"careful" rendering mode is used that redraws adjacent characters.
254
255All of this requires that fonts do not lie about character sizes,
256however: Xft fonts often draw glyphs larger than their acclaimed bounding
257box, and rxvt-unicode has no way of detecting this (the correct way is to
258ask for the character bounding box, which unfortunately is wrong in these
259cases). 997locales).
260 998
261It's not clear (to me at least), wether this is a bug in Xft, freetype, 999Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
262or the respective font. If you encounter this problem you might try using 1000programs doing the same (that is, most) will automatically agree in the
263the C<-lsp> option to give the font more height. If that doesn't work, you 1001interpretation of characters.
264might be forced to use a different font.
265 1002
266All of this is not a problem when using X11 core fonts, as their bounding 1003Unfortunately, there is no system-independent way to select locales, nor
267box data is correct. 1004is there a standard on how locale specifiers will look like.
268 1005
1006On most systems, the content of the C<LC_CTYPE> environment variable
1007contains an arbitrary string which corresponds to an already-installed
1008locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1009C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1010(i.e. C<de> or C<german>) are also common.
1011
1012Rxvt-unicode ignores all other locale categories, and except for
1013the encoding, ignores country or language-specific settings,
1014i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
1015rxvt-unicode.
1016
1017If you want to use a specific encoding you have to make sure you start
1018rxvt-unicode with the correct C<LC_CTYPE> category.
1019
1020=head3 Can I switch locales at runtime?
1021
1022Yes, using an escape sequence. Try something like this, which sets
1023rxvt-unicode's idea of C<LC_CTYPE>.
1024
1025 printf '\33]701;%s\007' ja_JP.SJIS
1026
1027See also the previous answer.
1028
1029Sometimes this capability is rather handy when you want to work in
1030one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
1031(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
1032first switches to a locale supported by xjdic and back later:
1033
1034 printf '\33]701;%s\007' ja_JP.SJIS
1035 xjdic -js
1036 printf '\33]701;%s\007' de_DE.UTF-8
1037
1038You can also use xterm's C<luit> program, which usually works fine, except
1039for some locales where character width differs between program- and
1040rxvt-unicode-locales.
1041
1042=head3 I have problems getting my input method working.
1043
1044Try a search engine, as this is slightly different for every input method server.
1045
1046Here is a checklist:
1047
1048=over 4
1049
1050=item - Make sure your locale I<and> the imLocale are supported on your OS.
1051
1052Try C<locale -a> or check the documentation for your OS.
1053
1054=item - Make sure your locale or imLocale matches a locale supported by your XIM.
1055
1056For example, B<kinput2> does not support UTF-8 locales, you should use
1057C<ja_JP.EUC-JP> or equivalent.
1058
1059=item - Make sure your XIM server is actually running.
1060
1061=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1062
1063When you want to use e.g. B<kinput2>, it must be set to
1064C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. Youc an see what input
1065method servers are running with this command:
1066
1067 xprop -root XIM_SERVERS
1068
1069=item
1070
1071=back
1072
1073=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
1074
1075You can specify separate locales for the input method and the rest of the
1076terminal, using the resource C<imlocale>:
1077
1078 URxvt.imlocale: ja_JP.EUC-JP
1079
1080Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
1081use your input method. Please note, however, that, depending on your Xlib
1082version, you may not be able to input characters outside C<EUC-JP> in a
1083normal way then, as your input method limits you.
1084
1085=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
1086
1087Unfortunately, this is unavoidable, as the XIM protocol is racy by
1088design. Applications can avoid some crashes at the expense of memory
1089leaks, and Input Methods can avoid some crashes by careful ordering at
1090exit time. B<kinput2> (and derived input methods) generally succeeds,
1091while B<SCIM> (or similar input methods) fails. In the end, however,
1092crashes cannot be completely avoided even if both sides cooperate.
1093
1094So the only workaround is not to kill your Input Method Servers.
1095
1096
1097=head2 Operating Systems / Package Maintaining
1098
1099=head3 I am using Debian GNU/Linux and have a problem...
1100
1101The Debian GNU/Linux package of rxvt-unicode in sarge contains large
1102patches that considerably change the behaviour of rxvt-unicode (but
1103unfortunately this notice has been removed). Before reporting a bug to
1104the original rxvt-unicode author please download and install the genuine
1105version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
1106the problem. If you cannot, chances are that the problems are specific to
1107Debian GNU/Linux, in which case it should be reported via the Debian Bug
1108Tracking System (use C<reportbug> to report the bug).
1109
1110For other problems that also affect the Debian package, you can and
1111probably should use the Debian BTS, too, because, after all, it's also a
1112bug in the Debian version and it serves as a reminder for other users that
1113might encounter the same issue.
1114
1115=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
1116
1117You should build one binary with the default options. F<configure>
1118now enables most useful options, and the trend goes to making them
1119runtime-switchable, too, so there is usually no drawback to enbaling them,
1120except higher disk and possibly memory usage. The perl interpreter should
1121be enabled, as important functionality (menus, selection, likely more in
1122the future) depends on it.
1123
1124You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
1125system-wide (except maybe with C<defaults>). This will result in useful
1126behaviour. If your distribution aims at low memory, add an empty
1127C<perl-ext-common> resource to the app-defaults file. This will keep the
1128perl interpreter disabled until the user enables it.
1129
1130If you can/want build more binaries, I recommend building a minimal
1131one with C<--disable-everything> (very useful) and a maximal one with
1132C<--enable-everything> (less useful, it will be very big due to a lot of
1133encodings built-in that increase download times and are rarely used).
1134
1135=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
1136
1137It should be, starting with release 7.1. You are encouraged to properly
1138install urxvt with privileges necessary for your OS now.
1139
1140When rxvt-unicode detects that it runs setuid or setgid, it will fork
1141into a helper process for privileged operations (pty handling on some
1142systems, utmp/wtmp/lastlog handling on others) and drop privileges
1143immediately. This is much safer than most other terminals that keep
1144privileges while running (but is more relevant to urxvt, as it contains
1145things as perl interpreters, which might be "helpful" to attackers).
1146
1147This forking is done as the very first within main(), which is very early
1148and reduces possible bugs to initialisation code run before main(), or
1149things like the dynamic loader of your system, which should result in very
1150little risk.
1151
269=item On Solaris 9, many line-drawing characters are too wide. 1152=head3 On Solaris 9, many line-drawing characters are too wide.
270 1153
271Seems to be a known bug, read 1154Seems to be a known bug, read
272L<http://nixdoc.net/files/forum/about34198.html>. Some people use the 1155L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
273following ugly workaround to get non-double-wide-characters working: 1156following ugly workaround to get non-double-wide-characters working:
274 1157
275 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x) 1158 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
276 1159
277=item My Compose (Multi_key) key is no longer working.
278
279The most common causes for this are that either your locale is not set
280correctly, or you specified a B<preeditStyle> that is not supported by
281your input method. For example, if you specified B<OverTheSpot> and
282your input method (e.g. the default input method handling Compose keys)
283does not support this (for instance because it is not visual), then
284rxvt-unicode will continue without an input method.
285
286In this case either do not specify a B<preeditStyle> or specify more than
287one pre-edit style, such as B<OverTheSpot,Root,None>.
288
289=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
290
291Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
292international keyboards) or simply use ISO 14755 support to your
293advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
294codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
295character and so on.
296
297=item How can I keep rxvt-unicode from using reverse video so much?
298
299First of all, make sure you are running with the right terminal settings
300(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
301make sure you have specified colours for italic and bold, as otherwise
302rxvt-unicode might use reverse video to simulate the effect:
303
304 URxvt.colorBD: white
305 URxvt.colorIT: green
306
307=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
308
309For some unexplainable reason, some rare programs assume a very weird
310colour palette when confronted with a terminal with more than the standard
3118 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
312these programs not to assume non-ISO colours without very good reasons.
313
314In the meantime, you can either edit your C<rxvt-unicode> terminfo
315definition to only claim 8 colour support or use C<TERM=rxvt>, which will
316fix colours but keep you from using other rxvt-unicode features.
317
318=item I am on FreeBSD and rxvt-unicode does not seem to work at all. 1160=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
319 1161
320Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1162Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
321in your compile environment, or an implementation that implements it, 1163in your compile environment, or an implementation that implements it,
322wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1164wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
323B<wchar_t> is represented as unicode. 1165B<wchar_t> is represented as unicode.
345 1187
346The rxvt-unicode author insists that the right way to fix this is in the 1188The rxvt-unicode author insists that the right way to fix this is in the
347system libraries once and for all, instead of forcing every app to carry 1189system libraries once and for all, instead of forcing every app to carry
348complete replacements for them :) 1190complete replacements for them :)
349 1191
350=item I use Solaris 9 and it doesn't compile/work/etc. 1192=head3 I use Solaris 9 and it doesn't compile/work/etc.
351 1193
352Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst 1194Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
353problems with C<wcwidth> and a compile problem. 1195problems with C<wcwidth> and a compile problem.
354 1196
355=item How can I use rxvt-unicode under cygwin? 1197=head3 How can I use rxvt-unicode under cygwin?
356 1198
357rxvt-unicode should compile and run out of the box on cygwin, using 1199rxvt-unicode should compile and run out of the box on cygwin, using
358the X11 libraries that come with cygwin. libW11 emulation is no 1200the X11 libraries that come with cygwin. libW11 emulation is no
359longer supported (and makes no sense, either, as it only supported a 1201longer supported (and makes no sense, either, as it only supported a
360single font). I recommend starting the X-server in C<-multiwindow> or 1202single font). I recommend starting the X-server in C<-multiwindow> or
363 1205
364At the time of this writing, cygwin didn't seem to support any multi-byte 1206At the time of this writing, cygwin didn't seem to support any multi-byte
365encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited 1207encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
366to 8-bit encodings. 1208to 8-bit encodings.
367 1209
368=item How does rxvt-unicode determine the encoding to use?
369
370=item Is there an option to switch encodings?
371
372Unlike some other terminals, rxvt-unicode has no encoding switch, and no
373specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
374UTF-8 or any other encodings with respect to terminal I/O.
375
376The reasons is that there exists a perfectly fine mechanism for selecting
377the encoding, doing I/O and (most important) communicating this to all
378applications so everybody agrees on character properties such as width
379and code number. This mechanism is the I<locale>. Applications not using
380that info will have problems (for example, C<xterm> gets the width of
381characters wrong as it uses it's own, locale-independent table under all
382locales).
383
384Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
385programs doing the same (that is, most) will automatically agree in the
386interpretation of characters.
387
388Unfortunately, there is no system-independent way to select locales, nor
389is there a standard on how locale specifiers will look like.
390
391On most systems, the content of the C<LC_CTYPE> environment variable
392contains an arbitrary string which corresponds to an already-installed
393locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
394C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
395(i.e. C<de> or C<german>) are also common.
396
397Rxvt-unicode ignores all other locale categories, and except for
398the encoding, ignores country or language-specific settings,
399i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
400rxvt-unicode.
401
402If you want to use a specific encoding you have to make sure you start
403rxvt-unicode with the correct C<LC_CTYPE> category.
404
405=item Can I switch locales at runtime?
406
407Yes, using an escape sequence. Try something like this, which sets
408rxvt-unicode's idea of C<LC_CTYPE>.
409
410 printf '\e]701;%s\007' ja_JP.SJIS
411
412See also the previous answer.
413
414Sometimes this capability is rather handy when you want to work in
415one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
416(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
417first switches to a locale supported by xjdic and back later:
418
419 printf '\e]701;%s\007' ja_JP.SJIS
420 xjdic -js
421 printf '\e]701;%s\007' de_DE.UTF-8
422
423You can also use xterm's C<luit> program, which usually works fine, except
424for some locales where character width differs between program- and
425rxvt-unicode-locales.
426
427=item Can I switch the fonts at runtime?
428
429Yes, using an escape sequence. Try something like this, which has the same
430effect as using the C<-fn> switch, and takes effect immediately:
431
432 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
433
434This is useful if you e.g. work primarily with japanese (and prefer a
435japanese font), but you have to switch to chinese temporarily, where
436japanese fonts would only be in your way.
437
438You can think of this as a kind of manual ISO-2022 switching.
439
440=item Why do italic characters look as if clipped?
441
442Many fonts have difficulties with italic characters and hinting. For
443example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
444Mono> completely fails in it's italic face. A workaround might be to
445enable freetype autohinting, i.e. like this:
446
447 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
448 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
449
450=item My input method wants <some encoding> but I want UTF-8, what can I do?
451
452You can specify separate locales for the input method and the rest of the
453terminal, using the resource C<imlocale>:
454
455 URxvt*imlocale: ja_JP.EUC-JP
456
457Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
458use your input method. Please note, however, that you will not be able to
459input characters outside C<EUC-JP> in a normal way then, as your input
460method limits you.
461
462=item Rxvt-unicode crashes when the X Input Method changes or exits.
463
464Unfortunately, this is unavoidable, as the XIM protocol is racy by
465design. Applications can avoid some crashes at the expense of memory
466leaks, and Input Methods can avoid some crashes by careful ordering at
467exit time. B<kinput2> (and derived input methods) generally succeeds,
468while B<SCIM> (or similar input methods) fails. In the end, however,
469crashes cannot be completely avoided even if both sides cooperate.
470
471So the only workaround is not to kill your Input Method Servers.
472
473=item Rxvt-unicode uses gobs of memory, how can I reduce that?
474
475Rxvt-unicode tries to obey the rule of not charging you for something you
476don't use. One thing you should try is to configure out all settings that
477you don't need, for example, Xft support is a resource hog by design,
478when used. Compiling it out ensures that no Xft font will be loaded
479accidentally when rxvt-unicode tries to find a font for your characters.
480
481Also, many people (me included) like large windows and even larger
482scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
4836 bytes per screen cell. For a 160x?? window this amounts to almost a
484kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
485use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
486rxvt-unicode then uses 8 bytes per screen cell.
487
488=item Can I speed up Xft rendering somehow?
489
490Yes, the most obvious way to speed it up is to avoid Xft entirely, as
491it is simply slow. If you still want Xft fonts you might try to disable
492antialiasing (by appending C<:antialiasing=false>), which saves lots of
493memory and also speeds up rendering considerably.
494
495=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
496
497Rxvt-unicode will use whatever you specify as a font. If it needs to
498fall back to it's default font search list it will prefer X11 core
499fonts, because they are small and fast, and then use Xft fonts. It has
500antialiasing disabled for most of them, because the author thinks they
501look best that way.
502
503If you want antialiasing, you have to specify the fonts manually.
504
505=item Mouse cut/paste suddenly no longer works.
506
507Make sure that mouse reporting is actually turned off since killing
508some editors prematurely may leave the mouse in mouse report mode. I've
509heard that tcsh may use mouse reporting unless it otherwise specified. A
510quick check is to see if cut/paste works when the Alt or Shift keys are
511depressed. See @@RXVT_NAME@@(7)
512
513=item What's with this bold/blink stuff?
514
515If no bold colour is set via C<colorBD:>, bold will invert text using the
516standard foreground colour.
517
518For the standard background colour, blinking will actually make the
519text blink when compiled with C<--enable-blinking>. with standard
520colours. Without C<--enable-blinking>, the blink attribute will be
521ignored.
522
523On ANSI colours, bold/blink attributes are used to set high-intensity
524foreground/background colors.
525
526color0-7 are the low-intensity colors.
527
528color8-15 are the corresponding high-intensity colors.
529
530=item I don't like the screen colors. How do I change them?
531
532You can change the screen colors at run-time using F<~/.Xdefaults>
533resources (or as long-options).
534
535Here are values that are supposed to resemble a VGA screen,
536including the murky brown that passes for low-intensity yellow:
537
538 URxvt.color0: #000000
539 URxvt.color1: #A80000
540 URxvt.color2: #00A800
541 URxvt.color3: #A8A800
542 URxvt.color4: #0000A8
543 URxvt.color5: #A800A8
544 URxvt.color6: #00A8A8
545 URxvt.color7: #A8A8A8
546
547 URxvt.color8: #000054
548 URxvt.color9: #FF0054
549 URxvt.color10: #00FF54
550 URxvt.color11: #FFFF54
551 URxvt.color12: #0000FF
552 URxvt.color13: #FF00FF
553 URxvt.color14: #00FFFF
554 URxvt.color15: #FFFFFF
555
556And here is a more complete set of non-standard colors described (not by
557me) as "pretty girly".
558
559 URxvt.cursorColor: #dc74d1
560 URxvt.pointerColor: #dc74d1
561 URxvt.background: #0e0e0e
562 URxvt.foreground: #4ad5e1
563 URxvt.color0: #000000
564 URxvt.color8: #8b8f93
565 URxvt.color1: #dc74d1
566 URxvt.color9: #dc74d1
567 URxvt.color2: #0eb8c7
568 URxvt.color10: #0eb8c7
569 URxvt.color3: #dfe37e
570 URxvt.color11: #dfe37e
571 URxvt.color5: #9e88f0
572 URxvt.color13: #9e88f0
573 URxvt.color6: #73f7ff
574 URxvt.color14: #73f7ff
575 URxvt.color7: #e1dddd
576 URxvt.color15: #e1dddd
577
578=item How can I start @@RXVT_NAME@@d in a race-free way?
579
580Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a
581server that answers @@RXVT_NAME@@c's requests, so it doesn't background
582itself.
583
584To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the
585following method to wait for the startup message before continuing:
586
587 { @@RXVT_NAME@@d & } | read
588
589=item What's with the strange Backspace/Delete key behaviour?
590
591Assuming that the physical Backspace key corresponds to the
592BackSpace keysym (not likely for Linux ... see the following
593question) there are two standard values that can be used for
594Backspace: C<^H> and C<^?>.
595
596Historically, either value is correct, but rxvt-unicode adopts the debian
597policy of using C<^?> when unsure, because it's the one only only correct
598choice :).
599
600Rxvt-unicode tries to inherit the current stty settings and uses the value
601of `erase' to guess the value for backspace. If rxvt-unicode wasn't
602started from a terminal (say, from a menu or by remote shell), then the
603system value of `erase', which corresponds to CERASE in <termios.h>, will
604be used (which may not be the same as your stty setting).
605
606For starting a new rxvt-unicode:
607
608 # use Backspace = ^H
609 $ stty erase ^H
610 $ @@RXVT_NAME@@
611
612 # use Backspace = ^?
613 $ stty erase ^?
614 $ @@RXVT_NAME@@
615
616Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).
617
618For an existing rxvt-unicode:
619
620 # use Backspace = ^H
621 $ stty erase ^H
622 $ echo -n "^[[36h"
623
624 # use Backspace = ^?
625 $ stty erase ^?
626 $ echo -n "^[[36l"
627
628This helps satisfy some of the Backspace discrepancies that occur, but
629if you use Backspace = C<^H>, make sure that the termcap/terminfo value
630properly reflects that.
631
632The Delete key is a another casualty of the ill-defined Backspace problem.
633To avoid confusion between the Backspace and Delete keys, the Delete
634key has been assigned an escape sequence to match the vt100 for Execute
635(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
636
637Some other Backspace problems:
638
639some editors use termcap/terminfo,
640some editors (vim I'm told) expect Backspace = ^H,
641GNU Emacs (and Emacs-like editors) use ^H for help.
642
643Perhaps someday this will all be resolved in a consistent manner.
644
645=item I don't like the key-bindings. How do I change them?
646
647There are some compile-time selections available via configure. Unless
648you have run "configure" with the C<--disable-resources> option you can
649use the `keysym' resource to alter the keystrings associated with keysyms.
650
651Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
652
653 URxvt.keysym.Home: \033[1~
654 URxvt.keysym.End: \033[4~
655 URxvt.keysym.C-apostrophe: \033<C-'>
656 URxvt.keysym.C-slash: \033<C-/>
657 URxvt.keysym.C-semicolon: \033<C-;>
658 URxvt.keysym.C-grave: \033<C-`>
659 URxvt.keysym.C-comma: \033<C-,>
660 URxvt.keysym.C-period: \033<C-.>
661 URxvt.keysym.C-0x60: \033<C-`>
662 URxvt.keysym.C-Tab: \033<C-Tab>
663 URxvt.keysym.C-Return: \033<C-Return>
664 URxvt.keysym.S-Return: \033<S-Return>
665 URxvt.keysym.S-space: \033<S-Space>
666 URxvt.keysym.M-Up: \033<M-Up>
667 URxvt.keysym.M-Down: \033<M-Down>
668 URxvt.keysym.M-Left: \033<M-Left>
669 URxvt.keysym.M-Right: \033<M-Right>
670 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
671 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
672 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
673
674See some more examples in the documentation for the B<keysym> resource.
675
676=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
677How do I make use of them? For example, the Sun Keyboard type 4
678has the following mappings that rxvt-unicode doesn't recognize.
679
680 KP_Insert == Insert
681 F22 == Print
682 F27 == Home
683 F29 == Prior
684 F33 == End
685 F35 == Next
686
687Rather than have rxvt-unicode try to accommodate all the various possible
688keyboard mappings, it is better to use `xmodmap' to remap the keys as
689required for your particular machine.
690
691=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
692I need this to decide about setting colors etc.
693
694rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
695check and see if that is set. Note that several programs, JED, slrn,
696Midnight Commander automatically check this variable to decide whether or
697not to use color.
698
699=item How do I set the correct, full IP address for the DISPLAY variable?
700
701If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
702insecure mode then it is possible to use the following shell script
703snippets to correctly set the display. If your version of rxvt-unicode
704wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
705the COLORTERM variable can be used to distinguish rxvt-unicode from a
706regular xterm.
707
708Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
709snippets:
710
711 # Bourne/Korn/POSIX family of shells:
712 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
713 if [ ${TERM:-foo} = xterm ]; then
714 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
715 echo -n '^[Z'
716 read term_id
717 stty icanon echo
718 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
719 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
720 read DISPLAY # set it in our local shell
721 fi
722 fi
723
724=item How do I compile the manual pages for myself?
725
726You need to have a recent version of perl installed as F</usr/bin/perl>,
727one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
728the doc subdirectory and enter C<make alldoc>.
729
730=item My question isn't answered here, can I ask a human?
731
732Before sending me mail, you could go to IRC: C<irc.freenode.net>,
733channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
734interested in learning about new and exciting problems (but not FAQs :).
735
736=back
737
738=head1 RXVT TECHNICAL REFERENCE 1210=head1 RXVT-UNICODE TECHNICAL REFERENCE
739
740=head1 DESCRIPTION
741 1211
742The rest of this document describes various technical aspects of 1212The rest of this document describes various technical aspects of
743B<rxvt-unicode>. First the description of supported command sequences, 1213B<rxvt-unicode>. First the description of supported command sequences,
744followed by menu and pixmap support and last by a description of all 1214followed by pixmap support and last by a description of all features
745features selectable at C<configure> time. 1215selectable at C<configure> time.
746 1216
747=head1 Definitions 1217=head2 Definitions
748 1218
749=over 4 1219=over 4
750 1220
751=item B<< C<c> >> 1221=item B<< C<c> >>
752 1222
770 1240
771A text parameter composed of printable characters. 1241A text parameter composed of printable characters.
772 1242
773=back 1243=back
774 1244
775=head1 Values 1245=head2 Values
776 1246
777=over 4 1247=over 4
778 1248
779=item B<< C<ENQ> >> 1249=item B<< C<ENQ> >>
780 1250
823 1293
824Space Character 1294Space Character
825 1295
826=back 1296=back
827 1297
828=head1 Escape Sequences 1298=head2 Escape Sequences
829 1299
830=over 4 1300=over 4
831 1301
832=item B<< C<ESC # 8> >> 1302=item B<< C<ESC # 8> >>
833 1303
931 1401
932=back 1402=back
933 1403
934X<CSI> 1404X<CSI>
935 1405
936=head1 CSI (Command Sequence Introducer) Sequences 1406=head2 CSI (Command Sequence Introducer) Sequences
937 1407
938=over 4 1408=over 4
939 1409
940=item B<< C<ESC [ Ps @> >> 1410=item B<< C<ESC [ Ps @> >>
941 1411
1211 1681
1212=back 1682=back
1213 1683
1214X<PrivateModes> 1684X<PrivateModes>
1215 1685
1216=head1 DEC Private Modes 1686=head2 DEC Private Modes
1217 1687
1218=over 4 1688=over 4
1219 1689
1220=item B<< C<ESC [ ? Pm h> >> 1690=item B<< C<ESC [ ? Pm h> >>
1221 1691
1318 B<< C<h> >> Send Mouse X & Y on button press. 1788 B<< C<h> >> Send Mouse X & Y on button press.
1319 B<< C<l> >> No mouse reporting. 1789 B<< C<l> >> No mouse reporting.
1320 1790
1321=end table 1791=end table
1322 1792
1323=item B<< C<Ps = 10> >> (B<rxvt>)
1324
1325=begin table
1326
1327 B<< C<h> >> menuBar visible
1328 B<< C<l> >> menuBar invisible
1329
1330=end table
1331
1332=item B<< C<Ps = 25> >> 1793=item B<< C<Ps = 25> >>
1333 1794
1334=begin table 1795=begin table
1335 1796
1336 B<< C<h> >> Visible cursor {cnorm/cvvis} 1797 B<< C<h> >> Visible cursor {cnorm/cvvis}
1452 B<< C<h> >> Scroll to bottom when a key is pressed 1913 B<< C<h> >> Scroll to bottom when a key is pressed
1453 B<< C<l> >> Don't scroll to bottom when a key is pressed 1914 B<< C<l> >> Don't scroll to bottom when a key is pressed
1454 1915
1455=end table 1916=end table
1456 1917
1918=item B<< C<Ps = 1021> >> (B<rxvt>)
1919
1920=begin table
1921
1922 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1923 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1924
1925=end table
1926
1457=item B<< C<Ps = 1047> >> 1927=item B<< C<Ps = 1047> >>
1458 1928
1459=begin table 1929=begin table
1460 1930
1461 B<< C<h> >> Use Alternate Screen Buffer 1931 B<< C<h> >> Use Alternate Screen Buffer
1485 1955
1486=back 1956=back
1487 1957
1488X<XTerm> 1958X<XTerm>
1489 1959
1490=head1 XTerm Operating System Commands 1960=head2 XTerm Operating System Commands
1491 1961
1492=over 4 1962=over 4
1493 1963
1494=item B<< C<ESC ] Ps;Pt ST> >> 1964=item B<< C<ESC ] Ps;Pt ST> >>
1495 1965
1507 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1977 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1508 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 1978 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1509 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 1979 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1510 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1980 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1511 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1981 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1512 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1982 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1513 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1983 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1514 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1984 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
1515 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 1985 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1516 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1986 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1517 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 1987 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1518 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> 1988 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
1519 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1989 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1520 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills). 1990 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
1521 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar). 1991 B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>.
1522 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 1992 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1523 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). 1993 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1994 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1995 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1524 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 1996 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1525 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1997 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1526 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1998 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1527 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1999 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1528 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 2000 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1529 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 2001 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2002 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1530 2003
1531=end table 2004=end table
1532 2005
1533=back 2006=back
1534
1535X<menuBar>
1536
1537=head1 menuBar
1538
1539B<< The exact syntax used is I<almost> solidified. >>
1540In the menus, B<DON'T> try to use menuBar commands that add or remove a
1541menuBar.
1542
1543Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1544omitted: use B<./> to specify a menu relative to the current menu.
1545
1546=head2 Overview of menuBar operation
1547
1548For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1549of C<Pt> can be used for a variety of tasks:
1550
1551At the top level is the current menuBar which is a member of a circular
1552linked-list of other such menuBars.
1553
1554The menuBar acts as a parent for the various drop-down menus, which in
1555turn, may have labels, separator lines, menuItems and subMenus.
1556
1557The menuItems are the useful bits: you can use them to mimic keyboard
1558input or even to send text or escape sequences back to rxvt.
1559
1560The menuBar syntax is intended to provide a simple yet robust method of
1561constructing and manipulating menus and navigating through the
1562menuBars.
1563
1564The first step is to use the tag B<< [menu:I<name>] >> which creates
1565the menuBar called I<name> and allows access. You may now or menus,
1566subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1567menuBar access as B<readonly> to prevent accidental corruption of the
1568menus. To re-access the current menuBar for alterations, use the tag
1569B<[menu]>, make the alterations and then use B<[done]>
1570
1571X<menuBarCommands>
1572
1573=head2 Commands
1574
1575=over 4
1576
1577=item B<< [menu:+I<name>] >>
1578
1579access the named menuBar for creation or alteration. If a new menuBar
1580is created, it is called I<name> (max of 15 chars) and the current
1581menuBar is pushed onto the stack
1582
1583=item B<[menu]>
1584
1585access the current menuBar for alteration
1586
1587=item B<< [title:+I<string>] >>
1588
1589set the current menuBar's title to I<string>, which may contain the
1590following format specifiers:
1591
1592 B<%n> rxvt name (as per the B<-name> command-line option)
1593 B<%v> rxvt version
1594 B<%%> literal B<%> character
1595
1596=item B<[done]>
1597
1598set menuBar access as B<readonly>.
1599End-of-file tag for B<< [read:+I<file>] >> operations.
1600
1601=item B<< [read:+I<file>] >>
1602
1603read menu commands directly from I<file> (extension ".menu" will be
1604appended if required.) Start reading at a line with B<[menu]> or B<<
1605[menu:+I<name> >> and continuing until B<[done]> is encountered.
1606
1607Blank and comment lines (starting with B<#>) are ignored. Actually,
1608since any invalid menu commands are also ignored, almost anything could
1609be construed as a comment line, but this may be tightened up in the
1610future ... so don't count on it!.
1611
1612=item B<< [read:+I<file>;+I<name>] >>
1613
1614The same as B<< [read:+I<file>] >>, but start reading at a line with
1615B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1616B<[done]> is encountered.
1617
1618=item B<[dump]>
1619
1620dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1621later rereading.
1622
1623=item B<[rm:name]>
1624
1625remove the named menuBar
1626
1627=item B<[rm] [rm:]>
1628
1629remove the current menuBar
1630
1631=item B<[rm*] [rm:*]>
1632
1633remove all menuBars
1634
1635=item B<[swap]>
1636
1637swap the top two menuBars
1638
1639=item B<[prev]>
1640
1641access the previous menuBar
1642
1643=item B<[next]>
1644
1645access the next menuBar
1646
1647=item B<[show]>
1648
1649Enable display of the menuBar
1650
1651=item B<[hide]>
1652
1653Disable display of the menuBar
1654
1655=item B<< [pixmap:+I<name>] >>
1656
1657=item B<< [pixmap:+I<name>;I<scaling>] >>
1658
1659(set the background pixmap globally
1660
1661B<< A Future implementation I<may> make this local to the menubar >>)
1662
1663=item B<< [:+I<command>:] >>
1664
1665ignore the menu readonly status and issue a I<command> to or a menu or
1666menuitem or change the ; a useful shortcut for setting the quick arrows
1667from a menuBar.
1668
1669=back
1670
1671X<menuBarAdd>
1672
1673=head2 Adding and accessing menus
1674
1675The following commands may also be B<+> prefixed.
1676
1677=over 4
1678
1679=item B</+>
1680
1681access menuBar top level
1682
1683=item B<./+>
1684
1685access current menu level
1686
1687=item B<../+>
1688
1689access parent menu (1 level up)
1690
1691=item B<../../>
1692
1693access parent menu (multiple levels up)
1694
1695=item B<< I</path/>menu >>
1696
1697add/access menu
1698
1699=item B<< I</path/>menu/* >>
1700
1701add/access menu and clear it if it exists
1702
1703=item B<< I</path/>{-} >>
1704
1705add separator
1706
1707=item B<< I</path/>{item} >>
1708
1709add B<item> as a label
1710
1711=item B<< I</path/>{item} action >>
1712
1713add/alter I<menuitem> with an associated I<action>
1714
1715=item B<< I</path/>{item}{right-text} >>
1716
1717add/alter I<menuitem> with B<right-text> as the right-justified text
1718and as the associated I<action>
1719
1720=item B<< I</path/>{item}{rtext} action >>
1721
1722add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1723the right-justified text.
1724
1725=back
1726
1727=over 4
1728
1729=item Special characters in I<action> must be backslash-escaped:
1730
1731B<\a \b \E \e \n \r \t \octal>
1732
1733=item or in control-character notation:
1734
1735B<^@, ^A .. ^Z .. ^_, ^?>
1736
1737=back
1738
1739To send a string starting with a B<NUL> (B<^@>) character to the
1740program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1741the first of which will be stripped off and the balance directed to the
1742program. Otherwise if I<action> begins with B<NUL> followed by
1743non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1744balance is sent back to rxvt.
1745
1746As a convenience for the many Emacs-type editors, I<action> may start
1747with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1748appended if missed from B<M-x> commands.
1749
1750As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1751quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1752
1753=over 4
1754
1755=item For example,
1756
1757B<M-xapropos> is equivalent to B<\Exapropos\r>
1758
1759=item and
1760
1761B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1762
1763=back
1764
1765The option B<< {I<right-rtext>} >> will be right-justified. In the
1766absence of a specified action, this text will be used as the I<action>
1767as well.
1768
1769=over 4
1770
1771=item For example,
1772
1773B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1774
1775=back
1776
1777The left label I<is> necessary, since it's used for matching, but
1778implicitly hiding the left label (by using same name for both left and
1779right labels), or explicitly hiding the left label (by preceeding it
1780with a dot), makes it possible to have right-justified text only.
1781
1782=over 4
1783
1784=item For example,
1785
1786B</File/{Open}{Open} Open-File-Action>
1787
1788=item or hiding it
1789
1790B</File/{.anylabel}{Open} Open-File-Action>
1791
1792=back
1793
1794X<menuBarRemove>
1795
1796=head2 Removing menus
1797
1798=over 4
1799
1800=item B<< -/*+ >>
1801
1802remove all menus from the menuBar, the same as B<[clear]>
1803
1804=item B<< -+I</path>menu+ >>
1805
1806remove menu
1807
1808=item B<< -+I</path>{item}+ >>
1809
1810remove item
1811
1812=item B<< -+I</path>{-} >>
1813
1814remove separator)
1815
1816=item B<-/path/menu/*>
1817
1818remove all items, separators and submenus from menu
1819
1820=back
1821
1822X<menuBarArrows>
1823
1824=head2 Quick Arrows
1825
1826The menus also provide a hook for I<quick arrows> to provide easier
1827user access. If nothing has been explicitly set, the default is to
1828emulate the curror keys. The syntax permits each arrow to be altered
1829individually or all four at once without re-entering their common
1830beginning/end text. For example, to explicitly associate cursor actions
1831with the arrows, any of the following forms could be used:
1832
1833=over 4
1834
1835=item B<< <r>+I<Right> >>
1836
1837=item B<< <l>+I<Left> >>
1838
1839=item B<< <u>+I<Up> >>
1840
1841=item B<< <d>+I<Down> >>
1842
1843Define actions for the respective arrow buttons
1844
1845=item B<< <b>+I<Begin> >>
1846
1847=item B<< <e>+I<End> >>
1848
1849Define common beginning/end parts for I<quick arrows> which used in
1850conjunction with the above <r> <l> <u> <d> constructs
1851
1852=back
1853
1854=over 4
1855
1856=item For example, define arrows individually,
1857
1858 <u>\E[A
1859
1860 <d>\E[B
1861
1862 <r>\E[C
1863
1864 <l>\E[D
1865
1866=item or all at once
1867
1868 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1869
1870=item or more compactly (factoring out common parts)
1871
1872 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1873
1874=back
1875
1876X<menuBarSummary>
1877
1878=head2 Command Summary
1879
1880A short summary of the most I<common> commands:
1881
1882=over 4
1883
1884=item [menu:name]
1885
1886use an existing named menuBar or start a new one
1887
1888=item [menu]
1889
1890use the current menuBar
1891
1892=item [title:string]
1893
1894set menuBar title
1895
1896=item [done]
1897
1898set menu access to readonly and, if reading from a file, signal EOF
1899
1900=item [done:name]
1901
1902if reading from a file using [read:file;name] signal EOF
1903
1904=item [rm:name]
1905
1906remove named menuBar(s)
1907
1908=item [rm] [rm:]
1909
1910remove current menuBar
1911
1912=item [rm*] [rm:*]
1913
1914remove all menuBar(s)
1915
1916=item [swap]
1917
1918swap top two menuBars
1919
1920=item [prev]
1921
1922access the previous menuBar
1923
1924=item [next]
1925
1926access the next menuBar
1927
1928=item [show]
1929
1930map menuBar
1931
1932=item [hide]
1933
1934unmap menuBar
1935
1936=item [pixmap;file]
1937
1938=item [pixmap;file;scaling]
1939
1940set a background pixmap
1941
1942=item [read:file]
1943
1944=item [read:file;name]
1945
1946read in a menu from a file
1947
1948=item [dump]
1949
1950dump out all menuBars to /tmp/rxvt-PID
1951
1952=item /
1953
1954access menuBar top level
1955
1956=item ./
1957
1958=item ../
1959
1960=item ../../
1961
1962access current or parent menu level
1963
1964=item /path/menu
1965
1966add/access menu
1967
1968=item /path/{-}
1969
1970add separator
1971
1972=item /path/{item}{rtext} action
1973
1974add/alter menu item
1975
1976=item -/*
1977
1978remove all menus from the menuBar
1979
1980=item -/path/menu
1981
1982remove menu items, separators and submenus from menu
1983
1984=item -/path/menu
1985
1986remove menu
1987
1988=item -/path/{item}
1989
1990remove item
1991
1992=item -/path/{-}
1993
1994remove separator
1995
1996=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1997
1998menu quick arrows
1999
2000=back
2001X<XPM>
2002 2007
2003=head1 XPM 2008=head1 XPM
2004 2009
2005For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2010For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
2006of B<< C<Pt> >> can be the name of the background pixmap followed by a 2011of B<< C<Pt> >> can be the name of the background pixmap followed by a
2104=begin table 2109=begin table
2105 2110
2106 4 Shift 2111 4 Shift
2107 8 Meta 2112 8 Meta
2108 16 Control 2113 16 Control
2109 32 Double Click I<(Rxvt extension)> 2114 32 Double Click I<(rxvt extension)>
2110 2115
2111=end table 2116=end table
2112 2117
2113Col = B<< C<< <x> - SPACE >> >> 2118Col = B<< C<< <x> - SPACE >> >>
2114 2119
2191=end table 2196=end table
2192 2197
2193=head1 CONFIGURE OPTIONS 2198=head1 CONFIGURE OPTIONS
2194 2199
2195General hint: if you get compile errors, then likely your configuration 2200General hint: if you get compile errors, then likely your configuration
2196hasn't been tested well. Either try with --enable-everything or use the 2201hasn't been tested well. Either try with C<--enable-everything> or use
2197./reconf script as a base for experiments. ./reconf is used by myself, 2202the F<./reconf> script as a base for experiments. F<./reconf> is used by
2198so it should generally be a working config. Of course, you should always 2203myself, so it should generally be a working config. Of course, you should
2199report when a combination doesn't work, so it can be fixed. Marc Lehmann 2204always report when a combination doesn't work, so it can be fixed. Marc
2200<rxvt@schmorp.de>. 2205Lehmann <rxvt@schmorp.de>.
2206
2207All
2201 2208
2202=over 4 2209=over 4
2203 2210
2204=item --enable-everything 2211=item --enable-everything
2205 2212
2206Add support for all non-multichoice options listed in "./configure 2213Add (or remove) support for all non-multichoice options listed in "./configure
2207--help". Note that unlike other enable options this is order dependant. 2214--help".
2215
2208You can specify this and then disable options which this enables by 2216You can specify this and then disable options you do not like by
2209I<following> this with the appropriate commands. 2217I<following> this with the appropriate C<--disable-...> arguments,
2218or you can start with a minimal configuration by specifying
2219C<--disable-everything> and than adding just the C<--enable-...> arguments
2220you want.
2210 2221
2211=item --enable-xft 2222=item --enable-xft (default: enabled)
2212 2223
2213Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2224Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2214slower and require lots of memory, but as long as you don't use them, you 2225slower and require lots of memory, but as long as you don't use them, you
2215don't pay for them. 2226don't pay for them.
2216 2227
2217=item --enable-font-styles 2228=item --enable-font-styles (default: on)
2218 2229
2219Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2230Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2220styles. The fonts can be set manually or automatically. 2231styles. The fonts can be set manually or automatically.
2221 2232
2222=item --with-codesets=NAME,... 2233=item --with-codesets=NAME,... (default: all)
2223 2234
2224Compile in support for additional codeset (encoding) groups (C<eu>, C<vn> 2235Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2225are always compiled in, which includes most 8-bit character sets). These 2236are always compiled in, which includes most 8-bit character sets). These
2226codeset tables are used for driving X11 core fonts, they are not required 2237codeset tables are used for driving X11 core fonts, they are not required
2227for Xft fonts, although having them compiled in lets rxvt-unicode choose 2238for Xft fonts, although having them compiled in lets rxvt-unicode choose
2238 jp_ext rarely used but big japanese encodings 2249 jp_ext rarely used but big japanese encodings
2239 kr korean encodings 2250 kr korean encodings
2240 2251
2241=end table 2252=end table
2242 2253
2243=item --enable-xim 2254=item --enable-xim (default: on)
2244 2255
2245Add support for XIM (X Input Method) protocol. This allows using 2256Add support for XIM (X Input Method) protocol. This allows using
2246alternative input methods (e.g. kinput2) and will also correctly 2257alternative input methods (e.g. kinput2) and will also correctly
2247set up the input for people using dead keys or compose keys. 2258set up the input for people using dead keys or compose keys.
2248 2259
2249=item --enable-unicode3 2260=item --enable-unicode3 (default: off)
2261
2262Recommended to stay off unless you really need non-BMP characters.
2250 2263
2251Enable direct support for displaying unicode codepoints above 2264Enable direct support for displaying unicode codepoints above
225265535 (the basic multilingual page). This increases storage 226565535 (the basic multilingual page). This increases storage
2253requirements per character from 2 to 4 bytes. X11 fonts do not yet 2266requirements per character from 2 to 4 bytes. X11 fonts do not yet
2254support these extra characters, but Xft does. 2267support these extra characters, but Xft does.
2257even without this flag, but the number of such characters is 2270even without this flag, but the number of such characters is
2258limited to a view thousand (shared with combining characters, 2271limited to a view thousand (shared with combining characters,
2259see next switch), and right now rxvt-unicode cannot display them 2272see next switch), and right now rxvt-unicode cannot display them
2260(input/output and cut&paste still work, though). 2273(input/output and cut&paste still work, though).
2261 2274
2262=item --enable-combining 2275=item --enable-combining (default: on)
2263 2276
2264Enable automatic composition of combining characters into 2277Enable automatic composition of combining characters into
2265composite characters. This is required for proper viewing of text 2278composite characters. This is required for proper viewing of text
2266where accents are encoded as seperate unicode characters. This is 2279where accents are encoded as seperate unicode characters. This is
2267done by using precomposited characters when available or creating 2280done by using precomposited characters when available or creating
2268new pseudo-characters when no precomposed form exists. 2281new pseudo-characters when no precomposed form exists.
2269 2282
2270Without --enable-unicode3, the number of additional precomposed characters 2283Without --enable-unicode3, the number of additional precomposed
2271is rather limited (2048, if this is full, rxvt-unicode will use the 2284characters is somewhat limited (the 6400 private use characters will be
2272private use area, extending the number of combinations to 8448). With
2273--enable-unicode3, no practical limit exists. 2285(ab-)used). With --enable-unicode3, no practical limit exists.
2274 2286
2275This option will also enable storage (but not display) of characters 2287This option will also enable storage (but not display) of characters
2276beyond plane 0 (>65535) when --enable-unicode3 was not specified. 2288beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2277 2289
2278The combining table also contains entries for arabic presentation forms, 2290The combining table also contains entries for arabic presentation forms,
2279but these are not currently used. Bug me if you want these to be used (and 2291but these are not currently used. Bug me if you want these to be used (and
2280tell me how these are to be used...). 2292tell me how these are to be used...).
2281 2293
2282=item --enable-fallback(=CLASS) 2294=item --enable-fallback(=CLASS) (default: Rxvt)
2283 2295
2284When reading resource settings, also read settings for class CLASS 2296When reading resource settings, also read settings for class CLASS. To
2285(default: Rxvt). To disable resource fallback use --disable-fallback. 2297disable resource fallback use --disable-fallback.
2286 2298
2287=item --with-res-name=NAME 2299=item --with-res-name=NAME (default: urxvt)
2288 2300
2289Use the given name (default: urxvt) as default application name when 2301Use the given name as default application name when
2290reading resources. Specify --with-res-name=rxvt to replace rxvt. 2302reading resources. Specify --with-res-name=rxvt to replace rxvt.
2291 2303
2292=item --with-res-class=CLASS 2304=item --with-res-class=CLASS /default: URxvt)
2293 2305
2294Use the given class (default: URxvt) as default application class 2306Use the given class as default application class
2295when reading resources. Specify --with-res-class=Rxvt to replace 2307when reading resources. Specify --with-res-class=Rxvt to replace
2296rxvt. 2308rxvt.
2297 2309
2298=item --enable-utmp 2310=item --enable-utmp (default: on)
2299 2311
2300Write user and tty to utmp file (used by programs like F<w>) at 2312Write user and tty to utmp file (used by programs like F<w>) at
2301start of rxvt execution and delete information when rxvt exits. 2313start of rxvt execution and delete information when rxvt exits.
2302 2314
2303=item --enable-wtmp 2315=item --enable-wtmp (default: on)
2304 2316
2305Write user and tty to wtmp file (used by programs like F<last>) at 2317Write user and tty to wtmp file (used by programs like F<last>) at
2306start of rxvt execution and write logout when rxvt exits. This 2318start of rxvt execution and write logout when rxvt exits. This
2307option requires --enable-utmp to also be specified. 2319option requires --enable-utmp to also be specified.
2308 2320
2309=item --enable-lastlog 2321=item --enable-lastlog (default: on)
2310 2322
2311Write user and tty to lastlog file (used by programs like 2323Write user and tty to lastlog file (used by programs like
2312F<lastlogin>) at start of rxvt execution. This option requires 2324F<lastlogin>) at start of rxvt execution. This option requires
2313--enable-utmp to also be specified. 2325--enable-utmp to also be specified.
2314 2326
2315=item --enable-xpm-background 2327=item --enable-xpm-background (default: on)
2316 2328
2317Add support for XPM background pixmaps. 2329Add support for XPM background pixmaps.
2318 2330
2319=item --enable-transparency 2331=item --enable-transparency (default: on)
2320 2332
2321Add support for inheriting parent backgrounds thus giving a fake 2333Add support for inheriting parent backgrounds thus giving a fake
2322transparency to the term. 2334transparency to the term.
2323 2335
2324=item --enable-fading 2336=item --enable-fading (default: on)
2325 2337
2326Add support for fading the text when focus is lost. 2338Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2327 2339
2328=item --enable-tinting 2340=item --enable-tinting (default: on)
2329 2341
2330Add support for tinting of transparent backgrounds. 2342Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2331 2343
2332=item --enable-menubar
2333
2334Add support for our menu bar system (this interacts badly with
2335dynamic locale switching currently).
2336
2337=item --enable-rxvt-scroll 2344=item --enable-rxvt-scroll (default: on)
2338 2345
2339Add support for the original rxvt scrollbar. 2346Add support for the original rxvt scrollbar.
2340 2347
2341=item --enable-next-scroll 2348=item --enable-next-scroll (default: on)
2342 2349
2343Add support for a NeXT-like scrollbar. 2350Add support for a NeXT-like scrollbar.
2344 2351
2345=item --enable-xterm-scroll 2352=item --enable-xterm-scroll (default: on)
2346 2353
2347Add support for an Xterm-like scrollbar. 2354Add support for an Xterm-like scrollbar.
2348 2355
2349=item --enable-plain-scroll 2356=item --enable-plain-scroll (default: on)
2350 2357
2351Add support for a very unobtrusive, plain-looking scrollbar that 2358Add support for a very unobtrusive, plain-looking scrollbar that
2352is the favourite of the rxvt-unicode author, having used it for 2359is the favourite of the rxvt-unicode author, having used it for
2353many years. 2360many years.
2354 2361
2355=item --enable-half-shadow 2362=item --enable-ttygid (default: off)
2356
2357Make shadows on the scrollbar only half the normal width & height.
2358only applicable to rxvt scrollbars.
2359
2360=item --enable-ttygid
2361 2363
2362Change tty device setting to group "tty" - only use this if 2364Change tty device setting to group "tty" - only use this if
2363your system uses this type of security. 2365your system uses this type of security.
2364 2366
2365=item --disable-backspace-key 2367=item --disable-backspace-key
2366 2368
2367Disable any handling of the backspace key by us - let the X server 2369Removes any handling of the backspace key by us - let the X server do it.
2370
2371=item --disable-delete-key
2372
2373Removes any handling of the delete key by us - let the X server
2368do it. 2374do it.
2369 2375
2370=item --disable-delete-key
2371
2372Disable any handling of the delete key by us - let the X server
2373do it.
2374
2375=item --disable-resources 2376=item --disable-resources
2376 2377
2377Remove all resources checking. 2378Removes any support for resource checking.
2378
2379=item --enable-xgetdefault
2380
2381Make resources checking via XGetDefault() instead of our small
2382version which only checks ~/.Xdefaults, or if that doesn't exist then
2383~/.Xresources.
2384
2385Please note that nowadays, things like XIM will automatically pull in and
2386use the full X resource manager, so the overhead of using it might be very
2387small, if nonexistant.
2388
2389=item --enable-strings
2390
2391Add support for our possibly faster memset() function and other
2392various routines, overriding your system's versions which may
2393have been hand-crafted in assembly or may require extra libraries
2394to link in. (this breaks ANSI-C rules and has problems on many
2395GNU/Linux systems).
2396 2379
2397=item --disable-swapscreen 2380=item --disable-swapscreen
2398 2381
2399Remove support for swap screen. 2382Remove support for secondary/swap screen.
2400 2383
2401=item --enable-frills 2384=item --enable-frills (default: on)
2402 2385
2403Add support for many small features that are not essential but nice to 2386Add support for many small features that are not essential but nice to
2404have. Normally you want this, but for very small binaries you may want to 2387have. Normally you want this, but for very small binaries you may want to
2405disable this. 2388disable this.
2406 2389
2407A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2390A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2408in combination with other switches) is: 2391in combination with other switches) is:
2409 2392
2410 MWM-hints 2393 MWM-hints
2411 EWMH-hints (pid, utf8 names) and protocols (ping) 2394 EWMH-hints (pid, utf8 names) and protocols (ping)
2412 seperate underline colour 2395 seperate underline colour (-underlineColor)
2413 settable border widths and borderless switch 2396 settable border widths and borderless switch (-w, -b, -bl)
2397 visual depth selection (-depth)
2414 settable extra linespacing 2398 settable extra linespacing /-lsp)
2415 iso-14755-2 and -3, and visual feedback 2399 iso-14755-2 and -3, and visual feedback
2400 tripleclickwords (-tcw)
2401 settable insecure mode (-insecure)
2402 keysym remapping support
2403 cursor blinking and underline cursor (-cb, -uc)
2404 XEmbed support (-embed)
2405 user-pty (-pty-fd)
2406 hold on exit (-hold)
2407 skip builtin block graphics (-sbg)
2408
2409It also enabled some non-essential features otherwise disabled, such as:
2410
2411 some round-trip time optimisations
2412 nearest color allocation on pseudocolor screens
2413 UTF8_STRING supporr for selection
2414 sgr modes 90..97 and 100..107
2416 backindex and forwardindex escape sequence 2415 backindex and forwardindex escape sequences
2416 view change/zero scorllback esacpe sequences
2417 locale switching escape sequence
2417 window op and some xterm/OSC escape sequences 2418 window op and some xterm/OSC escape sequences
2418 tripleclickwords 2419 rectangular selections
2419 settable insecure mode 2420 trailing space removal for selections
2420 keysym remapping support 2421 verbose X error handling
2421 cursor blinking and underline cursor
2422 -embed and -pty-fd options
2423 2422
2424=item --enable-iso14755 2423=item --enable-iso14755 (default: on)
2425 2424
2426Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2425Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2427F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2426F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2428C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2427C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2429this switch. 2428this switch.
2430 2429
2431=item --enable-keepscrolling 2430=item --enable-keepscrolling (default: on)
2432 2431
2433Add support for continual scrolling of the display when you hold 2432Add support for continual scrolling of the display when you hold
2434the mouse button down on a scrollbar arrow. 2433the mouse button down on a scrollbar arrow.
2435 2434
2436=item --enable-mousewheel 2435=item --enable-mousewheel (default: on)
2437 2436
2438Add support for scrolling via mouse wheel or buttons 4 & 5. 2437Add support for scrolling via mouse wheel or buttons 4 & 5.
2439 2438
2440=item --enable-slipwheeling 2439=item --enable-slipwheeling (default: on)
2441 2440
2442Add support for continual scrolling (using the mouse wheel as an 2441Add support for continual scrolling (using the mouse wheel as an
2443accelerator) while the control key is held down. This option 2442accelerator) while the control key is held down. This option
2444requires --enable-mousewheel to also be specified. 2443requires --enable-mousewheel to also be specified.
2445 2444
2446=item --disable-new-selection 2445=item --disable-new-selection
2447 2446
2448Remove support for mouse selection style like that of xterm. 2447Remove support for mouse selection style like that of xterm.
2449 2448
2450=item --enable-dmalloc 2449=item --enable-dmalloc (default: off)
2451 2450
2452Use Gray Watson's malloc - which is good for debugging See 2451Use Gray Watson's malloc - which is good for debugging See
2453http://www.letters.com/dmalloc/ for details If you use either this or the 2452L<http://www.letters.com/dmalloc/> for details If you use either this or the
2454next option, you may need to edit src/Makefile after compiling to point 2453next option, you may need to edit src/Makefile after compiling to point
2455DINCLUDE and DLIB to the right places. 2454DINCLUDE and DLIB to the right places.
2456 2455
2457You can only use either this option and the following (should 2456You can only use either this option and the following (should
2458you use either) . 2457you use either) .
2459 2458
2460=item --enable-dlmalloc 2459=item --enable-dlmalloc (default: off)
2461 2460
2462Use Doug Lea's malloc - which is good for a production version 2461Use Doug Lea's malloc - which is good for a production version
2463See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2462See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2464 2463
2465=item --enable-smart-resize 2464=item --enable-smart-resize (default: on)
2466 2465
2467Add smart growth/shrink behaviour when changing font size via from hot 2466Add smart growth/shrink behaviour when changing font size via hot
2468keys. This should keep in a fixed position the rxvt corner which is 2467keys. This should keep the window corner which is closest to a corner of
2469closest to a corner of the screen. 2468the screen in a fixed position.
2470 2469
2471=item --enable-pointer-blank 2470=item --enable-pointer-blank (default: on)
2472 2471
2473Add support to have the pointer disappear when typing or inactive. 2472Add support to have the pointer disappear when typing or inactive.
2474 2473
2475=item --with-name=NAME 2474=item --enable-perl (default: on)
2476 2475
2476Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2477manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2478in F<src/perl-ext/> for the extensions that are installed by default. The
2479perl interpreter that is used can be specified via the C<PERL> environment
2480variable when running configure.
2481
2482=item --with-name=NAME (default: urxvt)
2483
2477Set the basename for the installed binaries (default: C<urxvt>, resulting 2484Set the basename for the installed binaries, resulting
2478in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2485in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2479C<rxvt>. 2486C<rxvt>.
2480 2487
2481=item --with-term=NAME 2488=item --with-term=NAME (default: rxvt-unicode)
2482 2489
2483Change the environmental variable for the terminal to NAME (default 2490Change the environmental variable for the terminal to NAME.
2484C<rxvt-unicode>)
2485 2491
2486=item --with-terminfo=PATH 2492=item --with-terminfo=PATH
2487 2493
2488Change the environmental variable for the path to the terminfo tree to 2494Change the environmental variable for the path to the terminfo tree to
2489PATH. 2495PATH.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines