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.75 by root, Wed Jan 11 05:29:40 2006 UTC vs.
Revision 1.123 by root, Sat Dec 16 03:48: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/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
51=head3 How do I know which rxvt-unicode version I'm using?
52
53The version number is displayed with the usage (-h). Also the escape
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.
57
58=head3 Rxvt-unicode uses gobs of memory, how can I reduce that?
59
60Rxvt-unicode tries to obey the rule of not charging you for something you
61don't use. One thing you should try is to configure out all settings that
62you don't need, for example, Xft support is a resource hog by design,
63when used. Compiling it out ensures that no Xft font will be loaded
64accidentally when rxvt-unicode tries to find a font for your characters.
65
66Also, many people (me included) like large windows and even larger
67scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
686 bytes per screen cell. For a 160x?? window this amounts to almost a
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.
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 whether 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
29=item Isn't rxvt supposed to be small? Don't all those features bloat? 133=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
30 134
31I often get asked about this, and I think, no, they didn't cause extra 135I often get asked about this, and I think, no, they didn't cause extra
32bloat. If you compare a minimal rxvt and a minimal urxvt, you can see 136bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
33that the urxvt binary is larger (due to some encoding tables always being 137that the urxvt binary is larger (due to some encoding tables always being
34compiled in), but it actually uses less memory (RSS) after startup. Even 138compiled in), but it actually uses less memory (RSS) after startup. Even
38 142
39 text data bss drs rss filename 143 text data bss drs rss filename
40 98398 1664 24 15695 1824 rxvt --disable-everything 144 98398 1664 24 15695 1824 rxvt --disable-everything
41 188985 9048 66616 18222 1788 urxvt --disable-everything 145 188985 9048 66616 18222 1788 urxvt --disable-everything
42 146
43When you C<--enable-everything> (which _is_ unfair, as this involves xft 147When you C<--enable-everything> (which I<is> unfair, as this involves xft
44and full locale/XIM support which are quite bloaty inside libX11 and my 148and full locale/XIM support which are quite bloaty inside libX11 and my
45libc), the two diverge, but not unreasnobaly so. 149libc), the two diverge, but not unreasonably so.
46 150
47 text data bss drs rss filename 151 text data bss drs rss filename
48 163431 2152 24 20123 2060 rxvt --enable-everything 152 163431 2152 24 20123 2060 rxvt --enable-everything
49 1035683 49680 66648 29096 3680 urxvt --enable-everything 153 1035683 49680 66648 29096 3680 urxvt --enable-everything
50 154
66(21152k + extra 4204k in separate processes) or konsole (22200k + extra 170(21152k + extra 4204k in separate processes) or konsole (22200k + extra
6743180k in daemons that stay around after exit, plus half a minute of 17143180k in daemons that stay around after exit, plus half a minute of
68startup time, including the hundreds of warnings it spits out), it fares 172startup time, including the hundreds of warnings it spits out), it fares
69extremely well *g*. 173extremely well *g*.
70 174
71=item Why C++, isn't that unportable/bloated/uncool? 175=head3 Why C++, isn't that unportable/bloated/uncool?
72 176
73Is this a question? :) It comes up very often. The simple answer is: I had 177Is this a question? :) It comes up very often. The simple answer is: I had
74to write it, and C++ allowed me to write and maintain it in a fraction 178to write it, and C++ allowed me to write and maintain it in a fraction
75of the time and effort (which is a scarce resource for me). Put even 179of the time and effort (which is a scarce resource for me). Put even
76shorter: It simply wouldn't exist without C++. 180shorter: It simply wouldn't exist without C++.
100 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) 204 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
101 205
102No large bloated libraries (of course, none were linked in statically), 206No large bloated libraries (of course, none were linked in statically),
103except maybe libX11 :) 207except maybe libX11 :)
104 208
105=item Does it support tabs, can I have a tabbed rxvt-unicode?
106 209
107rxvt-unicode does not directly support tabs. It will work fine with 210=head2 Rendering, Font & Look and Feel Issues
108tabbing functionality of many window managers or similar tabbing programs,
109and its embedding-features allow it to be embedded into other programs,
110as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl
111module, which features a tabbed urxvt (murxvt) terminal as an example
112embedding application.
113 211
114=item How do I know which rxvt-unicode version I'm using? 212=head3 I can't get transparency working, what am I doing wrong?
115 213
116The version number is displayed with the usage (-h). Also the escape 214First of all, transparency isn't officially supported in rxvt-unicode, so
117sequence C<ESC [ 8 n> sets the window title to the version number. When 215you are mostly on your own. Do not bug the author about it (but you may
118using the @@RXVT_NAME@@c client, the version displayed is that of the 216bug everybody else). Also, if you can't get it working consider it a rite
119daemon. 217of passage: ... and you failed.
120 218
121=item I am using Debian GNU/Linux and have a problem... 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!
122 221
123The Debian GNU/Linux package of rxvt-unicode in sarge contains large 2221. Use inheritPixmap:
124patches that considerably change the behaviour of rxvt-unicode. Before
125reporting a bug to the original rxvt-unicode author please download and
126install the genuine version (L<http://software.schmorp.de#rxvt-unicode>)
127and try to reproduce the problem. If you cannot, chances are that the
128problems are specific to Debian GNU/Linux, in which case it should be
129reported via the Debian Bug Tracking System (use C<reportbug> to report
130the bug).
131 223
132For other problems that also affect the Debian package, you can and 224 Esetroot wallpaper.jpg
133probably should use the Debian BTS, too, because, after all, it's also a 225 @@URXVT_NAME@@ -ip -tint red -sh 40
134bug in the Debian version and it serves as a reminder for other users that
135might encounter the same issue.
136 226
137=item I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation? 227That works. If you think it doesn't, you lack transparency and tinting
228support, or you are unable to read.
138 229
139You should build one binary with the default options. F<configure> 2302. Use a simple pixmap and emulate pseudo-transparency. This enables you
140now enables most useful options, and the trend goes to making them 231to use effects other than tinting and shading: Just shade/tint/whatever
141runtime-switchable, too, so there is usually no drawback to enbaling them, 232your picture with gimp or any other tool:
142except higher disk and possibly memory usage. The perl interpreter should
143be enabled, as important functionality (menus, selection, likely more in
144the future) depends on it.
145 233
146You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 234 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
147system-wide (except maybe with C<defaults>). This will result in useful 235 @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background
148behaviour. If your distribution aims at low memory, add an empty
149C<perl-ext-common> resource to the app-defaults file. This will keep the
150perl interpreter disabled until the user enables it.
151 236
152If you can/want build more binaries, I recommend building a minimal 237That works. If you think it doesn't, you lack XPM and Perl support, or you
153one with C<--disable-everything> (very useful) and a maximal one with 238are unable to read.
154C<--enable-everything> (less useful, it will be very big due to a lot of
155encodings built-in that increase download times and are rarely used).
156 239
157=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe? 2403. Use an ARGB visual:
158 241
159Likely not. While I honestly try to make it secure, and am probably 242 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
160not bad at it, I think it is simply unreasonable to expect all of
161freetype + fontconfig + xft + xlib + ... + rxvt-unicode itself to all be
162secure. Also, rxvt-unicode disables some options when it detects that it
163runs setuid or setgid, which is not nice.
164 243
165Elevated privileges are only required for utmp and pty operations on some 244This requires XFT support, and the support of your X-server. If that
166systems (for example, GNU/Linux doesn't need any extra privileges for 245doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
167ptys, but some need it for utmp support). If rxvt-unicode doesn't support 246there yet, no matter what they claim. Rxvt-Unicode contains the necessary
168the library/setuid helper that your OS needs I'll be happy to assist you 247bugfixes and workarounds for Xft and Xlib to make it work, but that
169in implementing support for it. 248doesn't mean that your WM has the required kludges in place.
170 249
171So, while setuid/setgid operation is supported and not a problem on your 2504. Use xcompmgr and let it do the job:
172typical single-user-no-other-logins unix desktop, always remember that
173its an awful lot of code, most of which isn't checked for security issues
174regularly.
175 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), whether 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 its 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 its 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 permanently 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 whether 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 perl error messages 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> configures urxvt to scroll in full-screen
707apps, like screen, so lines scrolled 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> mentioned 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. When editing 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 whether and why it
835works. If unsure, use the form above.
836
176=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?
177 838
178The terminal description used by rxvt-unicode is not as widely available 839The terminal description used by rxvt-unicode is not as widely available
179as 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).
180 841
181The 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
182be done like this (with ncurses' infocmp): 843be done like this (with ncurses' infocmp and works as user and admin):
183 844
184 REMOTE=remotesystem.domain 845 REMOTE=remotesystem.domain
185 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" 846 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
186 847
187... or by installing rxvt-unicode normally on the remote system, 848... or by installing rxvt-unicode normally on the remote system,
849
850One some systems you might need to set C<$TERMINFO> to the full path of
851F<$HOME/.terminfo> for this to work.
188 852
189If you cannot or do not want to do this, then you can simply set 853If you cannot or do not want to do this, then you can simply set
190C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of 854C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
191problems arising, which includes wrong keymapping, less and different 855problems arising, which includes wrong keymapping, less and different
192colours and some refresh errors in fullscreen applications. It's a nice 856colours and some refresh errors in fullscreen applications. It's a nice
197resource to set it: 861resource to set it:
198 862
199 URxvt.termName: rxvt 863 URxvt.termName: rxvt
200 864
201If you don't plan to use B<rxvt> (quite common...) you could also replace 865If you don't plan to use B<rxvt> (quite common...) you could also replace
202the rxvt terminfo file with the rxvt-unicode one. 866the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
203 867
204=item C<tic> outputs some error when compiling the terminfo entry. 868=head3 C<tic> outputs some error when compiling the terminfo entry.
205 869
206Most likely it's the empty definition for C<enacs=>. Just replace it by 870Most likely it's the empty definition for C<enacs=>. Just replace it by
207C<enacs=\E[0@> and try again. 871C<enacs=\E[0@> and try again.
208 872
209=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@. 873=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
210 874
875See next entry.
876
211=item I need a termcap file entry. 877=head3 I need a termcap file entry.
212 878
213One reason you might want this is that some distributions or operating 879One reason you might want this is that some distributions or operating
214systems still compile some programs using the long-obsoleted termcap 880systems still compile some programs using the long-obsoleted termcap
215library (Fedora Core's bash is one example) and rely on a termcap entry 881library (Fedora Core's bash is one example) and rely on a termcap entry
216for C<rxvt-unicode>. 882for C<rxvt-unicode>.
217 883
218You could use rxvt's termcap entry with resonable results in many cases. 884You could use rxvt's termcap entry with reasonable results in many cases.
219You can also create a termcap entry by using terminfo's infocmp program 885You can also create a termcap entry by using terminfo's infocmp program
220like this: 886like this:
221 887
222 infocmp -C rxvt-unicode 888 infocmp -C rxvt-unicode
223 889
242 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\ 908 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
243 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\ 909 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
244 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\ 910 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
245 :vs=\E[?25h: 911 :vs=\E[?25h:
246 912
247=item Why does C<ls> no longer have coloured output? 913=head3 Why does C<ls> no longer have coloured output?
248 914
249The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 915The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
250decide wether a terminal has colour, but uses it's own configuration 916decide whether a terminal has colour, but uses its own configuration
251file. Needless to say, C<rxvt-unicode> is not in it's default file (among 917file. Needless to say, C<rxvt-unicode> is not in its default file (among
252with most other terminals supporting colour). Either add: 918with most other terminals supporting colour). Either add:
253 919
254 TERM rxvt-unicode 920 TERM rxvt-unicode
255 921
256to C</etc/DIR_COLORS> or simply add: 922to C</etc/DIR_COLORS> or simply add:
257 923
258 alias ls='ls --color=auto' 924 alias ls='ls --color=auto'
259 925
260to your C<.profile> or C<.bashrc>. 926to your C<.profile> or C<.bashrc>.
261 927
262=item Why doesn't vim/emacs etc. use the 88 colour mode? 928=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
263 929
930See next entry.
931
264=item Why doesn't vim/emacs etc. make use of italic? 932=head3 Why doesn't vim/emacs etc. make use of italic?
265 933
934See next entry.
935
266=item Why are the secondary screen-related options not working properly? 936=head3 Why are the secondary screen-related options not working properly?
267 937
268Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged 938Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
269distributions (most notably Debian GNU/Linux) break rxvt-unicode 939distributions (most notably Debian GNU/Linux) break rxvt-unicode
270by setting C<TERM> to C<rxvt>, which doesn't have these extra 940by setting C<TERM> to C<rxvt>, which doesn't have these extra
271features. Unfortunately, some of these (most notably, again, Debian 941features. Unfortunately, some of these (most notably, again, Debian
272GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo 942GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
273file, so you will need to install it on your own (See the question B<When 943file, so you will need to install it on your own (See the question B<When
274I log-in to another system it tells me about missing terminfo data?> on 944I log-in to another system it tells me about missing terminfo data?> on
275how to do this). 945how to do this).
276 946
277=item My numerical keypad acts weird and generates differing output?
278 947
279Some Debian GNUL/Linux users seem to have this problem, although no 948=head2 Encoding / Locale / Input Method Issues
280specific details were reported so far. It is possible that this is caused
281by the wrong C<TERM> setting, although the details of wether and how
282this can happen are unknown, as C<TERM=rxvt> should offer a compatible
283keymap. See the answer to the previous question, and please report if that
284helped.
285 949
286=item Rxvt-unicode does not seem to understand the selected encoding? 950=head3 Rxvt-unicode does not seem to understand the selected encoding?
287 951
952See next entry.
953
288=item Unicode does not seem to work? 954=head3 Unicode does not seem to work?
289 955
290If you encounter strange problems like typing an accented character but 956If you encounter strange problems like typing an accented character but
291getting two unrelated other characters or similar, or if program output is 957getting two unrelated other characters or similar, or if program output is
292subtly garbled, then you should check your locale settings. 958subtly garbled, then you should check your locale settings.
293 959
297something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work. 963something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
298 964
299The best thing is to fix your startup environment, as you will likely run 965The best thing is to fix your startup environment, as you will likely run
300into other problems. If nothing works you can try this in your .profile. 966into other problems. If nothing works you can try this in your .profile.
301 967
302 printf '\e]701;%s\007' "$LC_CTYPE" 968 printf '\33]701;%s\007' "$LC_CTYPE"
303 969
304If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 970If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
305supported on your systems. Some systems have a C<locale> command which 971supported on your systems. Some systems have a C<locale> command which
306displays this (also, C<perl -e0> can be used to check locale settings, as 972displays this (also, C<perl -e0> can be used to check locale settings, as
307it will complain loudly if it cannot set the locale). If it displays something 973it will complain loudly if it cannot set the locale). If it displays something
313 979
314If nothing works and you are sure that everything is set correctly then 980If nothing works and you are sure that everything is set correctly then
315you will need to remember a little known fact: Some programs just don't 981you will need to remember a little known fact: Some programs just don't
316support locales :( 982support locales :(
317 983
318=item Why do some characters look so much different than others? 984=head3 How does rxvt-unicode determine the encoding to use?
319 985
320=item How does rxvt-unicode choose fonts? 986See next entry.
321 987
322Most fonts do not contain the full range of Unicode, which is 988=head3 Is there an option to switch encodings?
323fine. Chances are that the font you (or the admin/package maintainer of
324your system/os) have specified does not cover all the characters you want
325to display.
326 989
327B<rxvt-unicode> makes a best-effort try at finding a replacement 990Unlike some other terminals, rxvt-unicode has no encoding switch, and no
328font. Often the result is fine, but sometimes the chosen font looks 991specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
329bad/ugly/wrong. Some fonts have totally strange characters that don't 992UTF-8 or any other encodings with respect to terminal I/O.
330resemble the correct glyph at all, and rxvt-unicode lacks the artificial
331intelligence to detect that a specific glyph is wrong: it has to believe
332the font that the characters it claims to contain indeed look correct.
333 993
334In that case, select a font of your taste and add it to the font list, 994The reasons is that there exists a perfectly fine mechanism for selecting
335e.g.: 995the encoding, doing I/O and (most important) communicating this to all
336 996applications so everybody agrees on character properties such as width
337 @@RXVT_NAME@@ -fn basefont,font2,font3... 997and code number. This mechanism is the I<locale>. Applications not using
338 998that info will have problems (for example, C<xterm> gets the width of
339When rxvt-unicode sees a character, it will first look at the base 999characters wrong as it uses its own, locale-independent table under all
340font. If the base font does not contain the character, it will go to the
341next font, and so on. Specifying your own fonts will also speed up this
342search and use less resources within rxvt-unicode and the X-server.
343
344The only limitation is that none of the fonts may be larger than the base
345font, as the base font defines the terminal character cell size, which
346must be the same due to the way terminals work.
347
348=item Why do some chinese characters look so different than others?
349
350This is because there is a difference between script and language --
351rxvt-unicode does not know which language the text that is output is,
352as it only knows the unicode character codes. If rxvt-unicode first
353sees a japanese/chinese character, it might choose a japanese font for
354display. Subsequent japanese characters will use that font. Now, many
355chinese characters aren't represented in japanese fonts, so when the first
356non-japanese character comes up, rxvt-unicode will look for a chinese font
357-- unfortunately at this point, it will still use the japanese font for
358chinese characters that are also in the japanese font.
359
360The workaround is easy: just tag a chinese font at the end of your font
361list (see the previous question). The key is to view the font list as
362a preference list: If you expect more japanese, list a japanese font
363first. If you expect more chinese, put a chinese font first.
364
365In the future it might be possible to switch language preferences at
366runtime (the internal data structure has no problem with using different
367fonts for the same character at the same time, but no interface for this
368has been designed yet).
369
370Until then, you might get away with switching fonts at runtime (see L<Can
371I switch the fonts at runtime?> later in this document).
372
373=item Why does rxvt-unicode sometimes leave pixel droppings?
374
375Most fonts were not designed for terminal use, which means that character
376size varies a lot. A font that is otherwise fine for terminal use might
377contain some characters that are simply too wide. Rxvt-unicode will avoid
378these characters. For characters that are just "a bit" too wide a special
379"careful" rendering mode is used that redraws adjacent characters.
380
381All of this requires that fonts do not lie about character sizes,
382however: Xft fonts often draw glyphs larger than their acclaimed bounding
383box, and rxvt-unicode has no way of detecting this (the correct way is to
384ask for the character bounding box, which unfortunately is wrong in these
385cases). 1000locales).
386 1001
387It's not clear (to me at least), wether this is a bug in Xft, freetype, 1002Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
388or the respective font. If you encounter this problem you might try using 1003programs doing the same (that is, most) will automatically agree in the
389the C<-lsp> option to give the font more height. If that doesn't work, you 1004interpretation of characters.
390might be forced to use a different font.
391 1005
392All of this is not a problem when using X11 core fonts, as their bounding 1006Unfortunately, there is no system-independent way to select locales, nor
393box data is correct. 1007is there a standard on how locale specifiers will look like.
394 1008
1009On most systems, the content of the C<LC_CTYPE> environment variable
1010contains an arbitrary string which corresponds to an already-installed
1011locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1012C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1013(i.e. C<de> or C<german>) are also common.
1014
1015Rxvt-unicode ignores all other locale categories, and except for
1016the encoding, ignores country or language-specific settings,
1017i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
1018rxvt-unicode.
1019
1020If you want to use a specific encoding you have to make sure you start
1021rxvt-unicode with the correct C<LC_CTYPE> category.
1022
1023=head3 Can I switch locales at runtime?
1024
1025Yes, using an escape sequence. Try something like this, which sets
1026rxvt-unicode's idea of C<LC_CTYPE>.
1027
1028 printf '\33]701;%s\007' ja_JP.SJIS
1029
1030See also the previous answer.
1031
1032Sometimes this capability is rather handy when you want to work in
1033one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
1034(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
1035first switches to a locale supported by xjdic and back later:
1036
1037 printf '\33]701;%s\007' ja_JP.SJIS
1038 xjdic -js
1039 printf '\33]701;%s\007' de_DE.UTF-8
1040
1041You can also use xterm's C<luit> program, which usually works fine, except
1042for some locales where character width differs between program- and
1043rxvt-unicode-locales.
1044
1045=head3 I have problems getting my input method working.
1046
1047Try a search engine, as this is slightly different for every input method server.
1048
1049Here is a checklist:
1050
1051=over 4
1052
1053=item - Make sure your locale I<and> the imLocale are supported on your OS.
1054
1055Try C<locale -a> or check the documentation for your OS.
1056
1057=item - Make sure your locale or imLocale matches a locale supported by your XIM.
1058
1059For example, B<kinput2> does not support UTF-8 locales, you should use
1060C<ja_JP.EUC-JP> or equivalent.
1061
1062=item - Make sure your XIM server is actually running.
1063
1064=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1065
1066When you want to use e.g. B<kinput2>, it must be set to
1067C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1068method servers are running with this command:
1069
1070 xprop -root XIM_SERVERS
1071
1072=item
1073
1074=back
1075
1076=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
1077
1078You can specify separate locales for the input method and the rest of the
1079terminal, using the resource C<imlocale>:
1080
1081 URxvt.imlocale: ja_JP.EUC-JP
1082
1083Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
1084use your input method. Please note, however, that, depending on your Xlib
1085version, you may not be able to input characters outside C<EUC-JP> in a
1086normal way then, as your input method limits you.
1087
1088=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
1089
1090Unfortunately, this is unavoidable, as the XIM protocol is racy by
1091design. Applications can avoid some crashes at the expense of memory
1092leaks, and Input Methods can avoid some crashes by careful ordering at
1093exit time. B<kinput2> (and derived input methods) generally succeeds,
1094while B<SCIM> (or similar input methods) fails. In the end, however,
1095crashes cannot be completely avoided even if both sides cooperate.
1096
1097So the only workaround is not to kill your Input Method Servers.
1098
1099
1100=head2 Operating Systems / Package Maintaining
1101
1102=head3 I am using Debian GNU/Linux and have a problem...
1103
1104The Debian GNU/Linux package of rxvt-unicode in sarge contains large
1105patches that considerably change the behaviour of rxvt-unicode (but
1106unfortunately this notice has been removed). Before reporting a bug to
1107the original rxvt-unicode author please download and install the genuine
1108version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
1109the problem. If you cannot, chances are that the problems are specific to
1110Debian GNU/Linux, in which case it should be reported via the Debian Bug
1111Tracking System (use C<reportbug> to report the bug).
1112
1113For other problems that also affect the Debian package, you can and
1114probably should use the Debian BTS, too, because, after all, it's also a
1115bug in the Debian version and it serves as a reminder for other users that
1116might encounter the same issue.
1117
1118=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
1119
1120You should build one binary with the default options. F<configure>
1121now enables most useful options, and the trend goes to making them
1122runtime-switchable, too, so there is usually no drawback to enabling them,
1123except higher disk and possibly memory usage. The perl interpreter should
1124be enabled, as important functionality (menus, selection, likely more in
1125the future) depends on it.
1126
1127You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
1128system-wide (except maybe with C<defaults>). This will result in useful
1129behaviour. If your distribution aims at low memory, add an empty
1130C<perl-ext-common> resource to the app-defaults file. This will keep the
1131perl interpreter disabled until the user enables it.
1132
1133If you can/want build more binaries, I recommend building a minimal
1134one with C<--disable-everything> (very useful) and a maximal one with
1135C<--enable-everything> (less useful, it will be very big due to a lot of
1136encodings built-in that increase download times and are rarely used).
1137
1138=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
1139
1140It should be, starting with release 7.1. You are encouraged to properly
1141install urxvt with privileges necessary for your OS now.
1142
1143When rxvt-unicode detects that it runs setuid or setgid, it will fork
1144into a helper process for privileged operations (pty handling on some
1145systems, utmp/wtmp/lastlog handling on others) and drop privileges
1146immediately. This is much safer than most other terminals that keep
1147privileges while running (but is more relevant to urxvt, as it contains
1148things as perl interpreters, which might be "helpful" to attackers).
1149
1150This forking is done as the very first within main(), which is very early
1151and reduces possible bugs to initialisation code run before main(), or
1152things like the dynamic loader of your system, which should result in very
1153little risk.
1154
395=item On Solaris 9, many line-drawing characters are too wide. 1155=head3 On Solaris 9, many line-drawing characters are too wide.
396 1156
397Seems to be a known bug, read 1157Seems to be a known bug, read
398L<http://nixdoc.net/files/forum/about34198.html>. Some people use the 1158L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
399following ugly workaround to get non-double-wide-characters working: 1159following ugly workaround to get non-double-wide-characters working:
400 1160
401 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x) 1161 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
402 1162
403=item My Compose (Multi_key) key is no longer working.
404
405The most common causes for this are that either your locale is not set
406correctly, or you specified a B<preeditStyle> that is not supported by
407your input method. For example, if you specified B<OverTheSpot> and
408your input method (e.g. the default input method handling Compose keys)
409does not support this (for instance because it is not visual), then
410rxvt-unicode will continue without an input method.
411
412In this case either do not specify a B<preeditStyle> or specify more than
413one pre-edit style, such as B<OverTheSpot,Root,None>.
414
415=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
416
417Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
418international keyboards) or simply use ISO 14755 support to your
419advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
420codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
421character and so on.
422
423=item How can I keep rxvt-unicode from using reverse video so much?
424
425First of all, make sure you are running with the right terminal settings
426(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
427make sure you have specified colours for italic and bold, as otherwise
428rxvt-unicode might use reverse video to simulate the effect:
429
430 URxvt.colorBD: white
431 URxvt.colorIT: green
432
433=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
434
435For some unexplainable reason, some rare programs assume a very weird
436colour palette when confronted with a terminal with more than the standard
4378 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
438these programs not to assume non-ISO colours without very good reasons.
439
440In the meantime, you can either edit your C<rxvt-unicode> terminfo
441definition to only claim 8 colour support or use C<TERM=rxvt>, which will
442fix colours but keep you from using other rxvt-unicode features.
443
444=item I am on FreeBSD and rxvt-unicode does not seem to work at all. 1163=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
445 1164
446Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1165Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
447in your compile environment, or an implementation that implements it, 1166in your compile environment, or an implementation that implements it,
448wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1167whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
449B<wchar_t> is represented as unicode. 1168B<wchar_t> is represented as unicode.
450 1169
451As you might have guessed, FreeBSD does neither define this symobl nor 1170As you might have guessed, FreeBSD does neither define this symbol nor
452does it support it. Instead, it uses it's own internal representation of 1171does it support it. Instead, it uses its own internal representation of
453B<wchar_t>. This is, of course, completely fine with respect to standards. 1172B<wchar_t>. This is, of course, completely fine with respect to standards.
454 1173
455However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and 1174However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
456C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>. 1175C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
457 1176
471 1190
472The rxvt-unicode author insists that the right way to fix this is in the 1191The rxvt-unicode author insists that the right way to fix this is in the
473system libraries once and for all, instead of forcing every app to carry 1192system libraries once and for all, instead of forcing every app to carry
474complete replacements for them :) 1193complete replacements for them :)
475 1194
476=item I use Solaris 9 and it doesn't compile/work/etc. 1195=head3 I use Solaris 9 and it doesn't compile/work/etc.
477 1196
478Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst 1197Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
479problems with C<wcwidth> and a compile problem. 1198problems with C<wcwidth> and a compile problem.
480 1199
481=item How can I use rxvt-unicode under cygwin? 1200=head3 How can I use rxvt-unicode under cygwin?
482 1201
483rxvt-unicode should compile and run out of the box on cygwin, using 1202rxvt-unicode should compile and run out of the box on cygwin, using
484the X11 libraries that come with cygwin. libW11 emulation is no 1203the X11 libraries that come with cygwin. libW11 emulation is no
485longer supported (and makes no sense, either, as it only supported a 1204longer supported (and makes no sense, either, as it only supported a
486single font). I recommend starting the X-server in C<-multiwindow> or 1205single font). I recommend starting the X-server in C<-multiwindow> or
489 1208
490At the time of this writing, cygwin didn't seem to support any multi-byte 1209At the time of this writing, cygwin didn't seem to support any multi-byte
491encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited 1210encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
492to 8-bit encodings. 1211to 8-bit encodings.
493 1212
494=item How does rxvt-unicode determine the encoding to use?
495
496=item Is there an option to switch encodings?
497
498Unlike some other terminals, rxvt-unicode has no encoding switch, and no
499specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
500UTF-8 or any other encodings with respect to terminal I/O.
501
502The reasons is that there exists a perfectly fine mechanism for selecting
503the encoding, doing I/O and (most important) communicating this to all
504applications so everybody agrees on character properties such as width
505and code number. This mechanism is the I<locale>. Applications not using
506that info will have problems (for example, C<xterm> gets the width of
507characters wrong as it uses it's own, locale-independent table under all
508locales).
509
510Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
511programs doing the same (that is, most) will automatically agree in the
512interpretation of characters.
513
514Unfortunately, there is no system-independent way to select locales, nor
515is there a standard on how locale specifiers will look like.
516
517On most systems, the content of the C<LC_CTYPE> environment variable
518contains an arbitrary string which corresponds to an already-installed
519locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
520C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
521(i.e. C<de> or C<german>) are also common.
522
523Rxvt-unicode ignores all other locale categories, and except for
524the encoding, ignores country or language-specific settings,
525i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
526rxvt-unicode.
527
528If you want to use a specific encoding you have to make sure you start
529rxvt-unicode with the correct C<LC_CTYPE> category.
530
531=item Can I switch locales at runtime?
532
533Yes, using an escape sequence. Try something like this, which sets
534rxvt-unicode's idea of C<LC_CTYPE>.
535
536 printf '\e]701;%s\007' ja_JP.SJIS
537
538See also the previous answer.
539
540Sometimes this capability is rather handy when you want to work in
541one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
542(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
543first switches to a locale supported by xjdic and back later:
544
545 printf '\e]701;%s\007' ja_JP.SJIS
546 xjdic -js
547 printf '\e]701;%s\007' de_DE.UTF-8
548
549You can also use xterm's C<luit> program, which usually works fine, except
550for some locales where character width differs between program- and
551rxvt-unicode-locales.
552
553=item Can I switch the fonts at runtime?
554
555Yes, using an escape sequence. Try something like this, which has the same
556effect as using the C<-fn> switch, and takes effect immediately:
557
558 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
559
560This is useful if you e.g. work primarily with japanese (and prefer a
561japanese font), but you have to switch to chinese temporarily, where
562japanese fonts would only be in your way.
563
564You can think of this as a kind of manual ISO-2022 switching.
565
566=item Why do italic characters look as if clipped?
567
568Many fonts have difficulties with italic characters and hinting. For
569example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
570Mono> completely fails in it's italic face. A workaround might be to
571enable freetype autohinting, i.e. like this:
572
573 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
574 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
575
576=item My input method wants <some encoding> but I want UTF-8, what can I do?
577
578You can specify separate locales for the input method and the rest of the
579terminal, using the resource C<imlocale>:
580
581 URxvt*imlocale: ja_JP.EUC-JP
582
583Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
584use your input method. Please note, however, that you will not be able to
585input characters outside C<EUC-JP> in a normal way then, as your input
586method limits you.
587
588=item Rxvt-unicode crashes when the X Input Method changes or exits.
589
590Unfortunately, this is unavoidable, as the XIM protocol is racy by
591design. Applications can avoid some crashes at the expense of memory
592leaks, and Input Methods can avoid some crashes by careful ordering at
593exit time. B<kinput2> (and derived input methods) generally succeeds,
594while B<SCIM> (or similar input methods) fails. In the end, however,
595crashes cannot be completely avoided even if both sides cooperate.
596
597So the only workaround is not to kill your Input Method Servers.
598
599=item Rxvt-unicode uses gobs of memory, how can I reduce that?
600
601Rxvt-unicode tries to obey the rule of not charging you for something you
602don't use. One thing you should try is to configure out all settings that
603you don't need, for example, Xft support is a resource hog by design,
604when used. Compiling it out ensures that no Xft font will be loaded
605accidentally when rxvt-unicode tries to find a font for your characters.
606
607Also, many people (me included) like large windows and even larger
608scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
6096 bytes per screen cell. For a 160x?? window this amounts to almost a
610kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
611use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
612rxvt-unicode then uses 8 bytes per screen cell.
613
614=item Can I speed up Xft rendering somehow?
615
616Yes, the most obvious way to speed it up is to avoid Xft entirely, as
617it is simply slow. If you still want Xft fonts you might try to disable
618antialiasing (by appending C<:antialias=false>), which saves lots of
619memory and also speeds up rendering considerably.
620
621=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
622
623Rxvt-unicode will use whatever you specify as a font. If it needs to
624fall back to it's default font search list it will prefer X11 core
625fonts, because they are small and fast, and then use Xft fonts. It has
626antialiasing disabled for most of them, because the author thinks they
627look best that way.
628
629If you want antialiasing, you have to specify the fonts manually.
630
631=item Mouse cut/paste suddenly no longer works.
632
633Make sure that mouse reporting is actually turned off since killing
634some editors prematurely may leave the mouse in mouse report mode. I've
635heard that tcsh may use mouse reporting unless it otherwise specified. A
636quick check is to see if cut/paste works when the Alt or Shift keys are
637depressed. See @@RXVT_NAME@@(7)
638
639=item What's with this bold/blink stuff?
640
641If no bold colour is set via C<colorBD:>, bold will invert text using the
642standard foreground colour.
643
644For the standard background colour, blinking will actually make the
645text blink when compiled with C<--enable-blinking>. with standard
646colours. Without C<--enable-blinking>, the blink attribute will be
647ignored.
648
649On ANSI colours, bold/blink attributes are used to set high-intensity
650foreground/background colors.
651
652color0-7 are the low-intensity colors.
653
654color8-15 are the corresponding high-intensity colors.
655
656=item I don't like the screen colors. How do I change them?
657
658You can change the screen colors at run-time using F<~/.Xdefaults>
659resources (or as long-options).
660
661Here are values that are supposed to resemble a VGA screen,
662including the murky brown that passes for low-intensity yellow:
663
664 URxvt.color0: #000000
665 URxvt.color1: #A80000
666 URxvt.color2: #00A800
667 URxvt.color3: #A8A800
668 URxvt.color4: #0000A8
669 URxvt.color5: #A800A8
670 URxvt.color6: #00A8A8
671 URxvt.color7: #A8A8A8
672
673 URxvt.color8: #000054
674 URxvt.color9: #FF0054
675 URxvt.color10: #00FF54
676 URxvt.color11: #FFFF54
677 URxvt.color12: #0000FF
678 URxvt.color13: #FF00FF
679 URxvt.color14: #00FFFF
680 URxvt.color15: #FFFFFF
681
682And here is a more complete set of non-standard colors described (not by
683me) as "pretty girly".
684
685 URxvt.cursorColor: #dc74d1
686 URxvt.pointerColor: #dc74d1
687 URxvt.background: #0e0e0e
688 URxvt.foreground: #4ad5e1
689 URxvt.color0: #000000
690 URxvt.color8: #8b8f93
691 URxvt.color1: #dc74d1
692 URxvt.color9: #dc74d1
693 URxvt.color2: #0eb8c7
694 URxvt.color10: #0eb8c7
695 URxvt.color3: #dfe37e
696 URxvt.color11: #dfe37e
697 URxvt.color5: #9e88f0
698 URxvt.color13: #9e88f0
699 URxvt.color6: #73f7ff
700 URxvt.color14: #73f7ff
701 URxvt.color7: #e1dddd
702 URxvt.color15: #e1dddd
703
704=item How can I start @@RXVT_NAME@@d in a race-free way?
705
706Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
707display, create the listening socket and then fork.
708
709=item What's with the strange Backspace/Delete key behaviour?
710
711Assuming that the physical Backspace key corresponds to the
712BackSpace keysym (not likely for Linux ... see the following
713question) there are two standard values that can be used for
714Backspace: C<^H> and C<^?>.
715
716Historically, either value is correct, but rxvt-unicode adopts the debian
717policy of using C<^?> when unsure, because it's the one only only correct
718choice :).
719
720Rxvt-unicode tries to inherit the current stty settings and uses the value
721of `erase' to guess the value for backspace. If rxvt-unicode wasn't
722started from a terminal (say, from a menu or by remote shell), then the
723system value of `erase', which corresponds to CERASE in <termios.h>, will
724be used (which may not be the same as your stty setting).
725
726For starting a new rxvt-unicode:
727
728 # use Backspace = ^H
729 $ stty erase ^H
730 $ @@RXVT_NAME@@
731
732 # use Backspace = ^?
733 $ stty erase ^?
734 $ @@RXVT_NAME@@
735
736Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).
737
738For an existing rxvt-unicode:
739
740 # use Backspace = ^H
741 $ stty erase ^H
742 $ echo -n "^[[36h"
743
744 # use Backspace = ^?
745 $ stty erase ^?
746 $ echo -n "^[[36l"
747
748This helps satisfy some of the Backspace discrepancies that occur, but
749if you use Backspace = C<^H>, make sure that the termcap/terminfo value
750properly reflects that.
751
752The Delete key is a another casualty of the ill-defined Backspace problem.
753To avoid confusion between the Backspace and Delete keys, the Delete
754key has been assigned an escape sequence to match the vt100 for Execute
755(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
756
757Some other Backspace problems:
758
759some editors use termcap/terminfo,
760some editors (vim I'm told) expect Backspace = ^H,
761GNU Emacs (and Emacs-like editors) use ^H for help.
762
763Perhaps someday this will all be resolved in a consistent manner.
764
765=item I don't like the key-bindings. How do I change them?
766
767There are some compile-time selections available via configure. Unless
768you have run "configure" with the C<--disable-resources> option you can
769use the `keysym' resource to alter the keystrings associated with keysyms.
770
771Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
772
773 URxvt.keysym.Home: \033[1~
774 URxvt.keysym.End: \033[4~
775 URxvt.keysym.C-apostrophe: \033<C-'>
776 URxvt.keysym.C-slash: \033<C-/>
777 URxvt.keysym.C-semicolon: \033<C-;>
778 URxvt.keysym.C-grave: \033<C-`>
779 URxvt.keysym.C-comma: \033<C-,>
780 URxvt.keysym.C-period: \033<C-.>
781 URxvt.keysym.C-0x60: \033<C-`>
782 URxvt.keysym.C-Tab: \033<C-Tab>
783 URxvt.keysym.C-Return: \033<C-Return>
784 URxvt.keysym.S-Return: \033<S-Return>
785 URxvt.keysym.S-space: \033<S-Space>
786 URxvt.keysym.M-Up: \033<M-Up>
787 URxvt.keysym.M-Down: \033<M-Down>
788 URxvt.keysym.M-Left: \033<M-Left>
789 URxvt.keysym.M-Right: \033<M-Right>
790 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
791 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
792 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
793
794See some more examples in the documentation for the B<keysym> resource.
795
796=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
797How do I make use of them? For example, the Sun Keyboard type 4
798has the following mappings that rxvt-unicode doesn't recognize.
799
800 KP_Insert == Insert
801 F22 == Print
802 F27 == Home
803 F29 == Prior
804 F33 == End
805 F35 == Next
806
807Rather than have rxvt-unicode try to accommodate all the various possible
808keyboard mappings, it is better to use `xmodmap' to remap the keys as
809required for your particular machine.
810
811=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
812I need this to decide about setting colors etc.
813
814rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
815check and see if that is set. Note that several programs, JED, slrn,
816Midnight Commander automatically check this variable to decide whether or
817not to use color.
818
819=item How do I set the correct, full IP address for the DISPLAY variable?
820
821If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
822insecure mode then it is possible to use the following shell script
823snippets to correctly set the display. If your version of rxvt-unicode
824wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
825the COLORTERM variable can be used to distinguish rxvt-unicode from a
826regular xterm.
827
828Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
829snippets:
830
831 # Bourne/Korn/POSIX family of shells:
832 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
833 if [ ${TERM:-foo} = xterm ]; then
834 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
835 echo -n '^[Z'
836 read term_id
837 stty icanon echo
838 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
839 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
840 read DISPLAY # set it in our local shell
841 fi
842 fi
843
844=item How do I compile the manual pages for myself?
845
846You need to have a recent version of perl installed as F</usr/bin/perl>,
847one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
848the doc subdirectory and enter C<make alldoc>.
849
850=item My question isn't answered here, can I ask a human?
851
852Before sending me mail, you could go to IRC: C<irc.freenode.net>,
853channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
854interested in learning about new and exciting problems (but not FAQs :).
855
856=back
857
858=head1 RXVT TECHNICAL REFERENCE 1213=head1 RXVT-UNICODE TECHNICAL REFERENCE
859
860=head1 DESCRIPTION
861 1214
862The rest of this document describes various technical aspects of 1215The rest of this document describes various technical aspects of
863B<rxvt-unicode>. First the description of supported command sequences, 1216B<rxvt-unicode>. First the description of supported command sequences,
864followed by menu and pixmap support and last by a description of all 1217followed by pixmap support and last by a description of all features
865features selectable at C<configure> time. 1218selectable at C<configure> time.
866 1219
867=head1 Definitions 1220=head2 Definitions
868 1221
869=over 4 1222=over 4
870 1223
871=item B<< C<c> >> 1224=item B<< C<c> >>
872 1225
890 1243
891A text parameter composed of printable characters. 1244A text parameter composed of printable characters.
892 1245
893=back 1246=back
894 1247
895=head1 Values 1248=head2 Values
896 1249
897=over 4 1250=over 4
898 1251
899=item B<< C<ENQ> >> 1252=item B<< C<ENQ> >>
900 1253
943 1296
944Space Character 1297Space Character
945 1298
946=back 1299=back
947 1300
948=head1 Escape Sequences 1301=head2 Escape Sequences
949 1302
950=over 4 1303=over 4
951 1304
952=item B<< C<ESC # 8> >> 1305=item B<< C<ESC # 8> >>
953 1306
1051 1404
1052=back 1405=back
1053 1406
1054X<CSI> 1407X<CSI>
1055 1408
1056=head1 CSI (Command Sequence Introducer) Sequences 1409=head2 CSI (Command Sequence Introducer) Sequences
1057 1410
1058=over 4 1411=over 4
1059 1412
1060=item B<< C<ESC [ Ps @> >> 1413=item B<< C<ESC [ Ps @> >>
1061 1414
1331 1684
1332=back 1685=back
1333 1686
1334X<PrivateModes> 1687X<PrivateModes>
1335 1688
1336=head1 DEC Private Modes 1689=head2 DEC Private Modes
1337 1690
1338=over 4 1691=over 4
1339 1692
1340=item B<< C<ESC [ ? Pm h> >> 1693=item B<< C<ESC [ ? Pm h> >>
1341 1694
1357 1710
1358Toggle DEC Private Mode Values (rxvt extension). I<where> 1711Toggle DEC Private Mode Values (rxvt extension). I<where>
1359 1712
1360=over 4 1713=over 4
1361 1714
1362=item B<< C<Ps = 1> >> (DECCKM) 1715=item B<< C<Pm = 1> >> (DECCKM)
1363 1716
1364=begin table 1717=begin table
1365 1718
1366 B<< C<h> >> Application Cursor Keys 1719 B<< C<h> >> Application Cursor Keys
1367 B<< C<l> >> Normal Cursor Keys 1720 B<< C<l> >> Normal Cursor Keys
1368 1721
1369=end table 1722=end table
1370 1723
1371=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1724=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1372 1725
1373=begin table 1726=begin table
1374 1727
1375 B<< C<h> >> Enter VT52 mode 1728 B<< C<h> >> Enter VT52 mode
1376 B<< C<l> >> Enter VT52 mode 1729 B<< C<l> >> Enter VT52 mode
1377 1730
1378=end table 1731=end table
1379 1732
1380=item B<< C<Ps = 3> >> 1733=item B<< C<Pm = 3> >>
1381 1734
1382=begin table 1735=begin table
1383 1736
1384 B<< C<h> >> 132 Column Mode (DECCOLM) 1737 B<< C<h> >> 132 Column Mode (DECCOLM)
1385 B<< C<l> >> 80 Column Mode (DECCOLM) 1738 B<< C<l> >> 80 Column Mode (DECCOLM)
1386 1739
1387=end table 1740=end table
1388 1741
1389=item B<< C<Ps = 4> >> 1742=item B<< C<Pm = 4> >>
1390 1743
1391=begin table 1744=begin table
1392 1745
1393 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1746 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1394 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1747 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1395 1748
1396=end table 1749=end table
1397 1750
1398=item B<< C<Ps = 5> >> 1751=item B<< C<Pm = 5> >>
1399 1752
1400=begin table 1753=begin table
1401 1754
1402 B<< C<h> >> Reverse Video (DECSCNM) 1755 B<< C<h> >> Reverse Video (DECSCNM)
1403 B<< C<l> >> Normal Video (DECSCNM) 1756 B<< C<l> >> Normal Video (DECSCNM)
1404 1757
1405=end table 1758=end table
1406 1759
1407=item B<< C<Ps = 6> >> 1760=item B<< C<Pm = 6> >>
1408 1761
1409=begin table 1762=begin table
1410 1763
1411 B<< C<h> >> Origin Mode (DECOM) 1764 B<< C<h> >> Origin Mode (DECOM)
1412 B<< C<l> >> Normal Cursor Mode (DECOM) 1765 B<< C<l> >> Normal Cursor Mode (DECOM)
1413 1766
1414=end table 1767=end table
1415 1768
1416=item B<< C<Ps = 7> >> 1769=item B<< C<Pm = 7> >>
1417 1770
1418=begin table 1771=begin table
1419 1772
1420 B<< C<h> >> Wraparound Mode (DECAWM) 1773 B<< C<h> >> Wraparound Mode (DECAWM)
1421 B<< C<l> >> No Wraparound Mode (DECAWM) 1774 B<< C<l> >> No Wraparound Mode (DECAWM)
1422 1775
1423=end table 1776=end table
1424 1777
1425=item B<< C<Ps = 8> >> I<unimplemented> 1778=item B<< C<Pm = 8> >> I<unimplemented>
1426 1779
1427=begin table 1780=begin table
1428 1781
1429 B<< C<h> >> Auto-repeat Keys (DECARM) 1782 B<< C<h> >> Auto-repeat Keys (DECARM)
1430 B<< C<l> >> No Auto-repeat Keys (DECARM) 1783 B<< C<l> >> No Auto-repeat Keys (DECARM)
1431 1784
1432=end table 1785=end table
1433 1786
1434=item B<< C<Ps = 9> >> X10 XTerm 1787=item B<< C<Pm = 9> >> X10 XTerm
1435 1788
1436=begin table 1789=begin table
1437 1790
1438 B<< C<h> >> Send Mouse X & Y on button press. 1791 B<< C<h> >> Send Mouse X & Y on button press.
1439 B<< C<l> >> No mouse reporting. 1792 B<< C<l> >> No mouse reporting.
1440 1793
1441=end table 1794=end table
1442 1795
1443=item B<< C<Ps = 10> >> (B<rxvt>)
1444
1445=begin table
1446
1447 B<< C<h> >> menuBar visible
1448 B<< C<l> >> menuBar invisible
1449
1450=end table
1451
1452=item B<< C<Ps = 25> >> 1796=item B<< C<Pm = 25> >>
1453 1797
1454=begin table 1798=begin table
1455 1799
1456 B<< C<h> >> Visible cursor {cnorm/cvvis} 1800 B<< C<h> >> Visible cursor {cnorm/cvvis}
1457 B<< C<l> >> Invisible cursor {civis} 1801 B<< C<l> >> Invisible cursor {civis}
1458 1802
1459=end table 1803=end table
1460 1804
1461=item B<< C<Ps = 30> >> 1805=item B<< C<Pm = 30> >>
1462 1806
1463=begin table 1807=begin table
1464 1808
1465 B<< C<h> >> scrollBar visisble 1809 B<< C<h> >> scrollBar visisble
1466 B<< C<l> >> scrollBar invisisble 1810 B<< C<l> >> scrollBar invisisble
1467 1811
1468=end table 1812=end table
1469 1813
1470=item B<< C<Ps = 35> >> (B<rxvt>) 1814=item B<< C<Pm = 35> >> (B<rxvt>)
1471 1815
1472=begin table 1816=begin table
1473 1817
1474 B<< C<h> >> Allow XTerm Shift+key sequences 1818 B<< C<h> >> Allow XTerm Shift+key sequences
1475 B<< C<l> >> Disallow XTerm Shift+key sequences 1819 B<< C<l> >> Disallow XTerm Shift+key sequences
1476 1820
1477=end table 1821=end table
1478 1822
1479=item B<< C<Ps = 38> >> I<unimplemented> 1823=item B<< C<Pm = 38> >> I<unimplemented>
1480 1824
1481Enter Tektronix Mode (DECTEK) 1825Enter Tektronix Mode (DECTEK)
1482 1826
1483=item B<< C<Ps = 40> >> 1827=item B<< C<Pm = 40> >>
1484 1828
1485=begin table 1829=begin table
1486 1830
1487 B<< C<h> >> Allow 80/132 Mode 1831 B<< C<h> >> Allow 80/132 Mode
1488 B<< C<l> >> Disallow 80/132 Mode 1832 B<< C<l> >> Disallow 80/132 Mode
1489 1833
1490=end table 1834=end table
1491 1835
1492=item B<< C<Ps = 44> >> I<unimplemented> 1836=item B<< C<Pm = 44> >> I<unimplemented>
1493 1837
1494=begin table 1838=begin table
1495 1839
1496 B<< C<h> >> Turn On Margin Bell 1840 B<< C<h> >> Turn On Margin Bell
1497 B<< C<l> >> Turn Off Margin Bell 1841 B<< C<l> >> Turn Off Margin Bell
1498 1842
1499=end table 1843=end table
1500 1844
1501=item B<< C<Ps = 45> >> I<unimplemented> 1845=item B<< C<Pm = 45> >> I<unimplemented>
1502 1846
1503=begin table 1847=begin table
1504 1848
1505 B<< C<h> >> Reverse-wraparound Mode 1849 B<< C<h> >> Reverse-wraparound Mode
1506 B<< C<l> >> No Reverse-wraparound Mode 1850 B<< C<l> >> No Reverse-wraparound Mode
1507 1851
1508=end table 1852=end table
1509 1853
1510=item B<< C<Ps = 46> >> I<unimplemented> 1854=item B<< C<Pm = 46> >> I<unimplemented>
1511 1855
1512=item B<< C<Ps = 47> >> 1856=item B<< C<Pm = 47> >>
1513 1857
1514=begin table 1858=begin table
1515 1859
1516 B<< C<h> >> Use Alternate Screen Buffer 1860 B<< C<h> >> Use Alternate Screen Buffer
1517 B<< C<l> >> Use Normal Screen Buffer 1861 B<< C<l> >> Use Normal Screen Buffer
1518 1862
1519=end table 1863=end table
1520 1864
1521X<Priv66> 1865X<Priv66>
1522 1866
1523=item B<< C<Ps = 66> >> 1867=item B<< C<Pm = 66> >>
1524 1868
1525=begin table 1869=begin table
1526 1870
1527 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1871 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1528 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1872 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1529 1873
1530=end table 1874=end table
1531 1875
1532=item B<< C<Ps = 67> >> 1876=item B<< C<Pm = 67> >>
1533 1877
1534=begin table 1878=begin table
1535 1879
1536 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1880 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1537 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1881 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1538 1882
1539=end table 1883=end table
1540 1884
1541=item B<< C<Ps = 1000> >> (X11 XTerm) 1885=item B<< C<Pm = 1000> >> (X11 XTerm)
1542 1886
1543=begin table 1887=begin table
1544 1888
1545 B<< C<h> >> Send Mouse X & Y on button press and release. 1889 B<< C<h> >> Send Mouse X & Y on button press and release.
1546 B<< C<l> >> No mouse reporting. 1890 B<< C<l> >> No mouse reporting.
1547 1891
1548=end table 1892=end table
1549 1893
1550=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1894=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1551 1895
1552=begin table 1896=begin table
1553 1897
1554 B<< C<h> >> Use Hilite Mouse Tracking. 1898 B<< C<h> >> Use Hilite Mouse Tracking.
1555 B<< C<l> >> No mouse reporting. 1899 B<< C<l> >> No mouse reporting.
1556 1900
1557=end table 1901=end table
1558 1902
1559=item B<< C<Ps = 1010> >> (B<rxvt>) 1903=item B<< C<Pm = 1010> >> (B<rxvt>)
1560 1904
1561=begin table 1905=begin table
1562 1906
1563 B<< C<h> >> Don't scroll to bottom on TTY output 1907 B<< C<h> >> Don't scroll to bottom on TTY output
1564 B<< C<l> >> Scroll to bottom on TTY output 1908 B<< C<l> >> Scroll to bottom on TTY output
1565 1909
1566=end table 1910=end table
1567 1911
1568=item B<< C<Ps = 1011> >> (B<rxvt>) 1912=item B<< C<Pm = 1011> >> (B<rxvt>)
1569 1913
1570=begin table 1914=begin table
1571 1915
1572 B<< C<h> >> Scroll to bottom when a key is pressed 1916 B<< C<h> >> Scroll to bottom when a key is pressed
1573 B<< C<l> >> Don't scroll to bottom when a key is pressed 1917 B<< C<l> >> Don't scroll to bottom when a key is pressed
1574 1918
1575=end table 1919=end table
1576 1920
1577=item B<< C<Ps = 1021> >> (B<rxvt>) 1921=item B<< C<Pm = 1021> >> (B<rxvt>)
1578 1922
1579=begin table 1923=begin table
1580 1924
1581 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>) 1925 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1582 B<< C<l> >> Font styles have no effect on intensity (Compile styles) 1926 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1583 1927
1584=end table 1928=end table
1585 1929
1586=item B<< C<Ps = 1047> >> 1930=item B<< C<Pm = 1047> >>
1587 1931
1588=begin table 1932=begin table
1589 1933
1590 B<< C<h> >> Use Alternate Screen Buffer 1934 B<< C<h> >> Use Alternate Screen Buffer
1591 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1935 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1592 1936
1593=end table 1937=end table
1594 1938
1595=item B<< C<Ps = 1048> >> 1939=item B<< C<Pm = 1048> >>
1596 1940
1597=begin table 1941=begin table
1598 1942
1599 B<< C<h> >> Save cursor position 1943 B<< C<h> >> Save cursor position
1600 B<< C<l> >> Restore cursor position 1944 B<< C<l> >> Restore cursor position
1601 1945
1602=end table 1946=end table
1603 1947
1604=item B<< C<Ps = 1049> >> 1948=item B<< C<Pm = 1049> >>
1605 1949
1606=begin table 1950=begin table
1607 1951
1608 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it 1952 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1609 B<< C<l> >> Use Normal Screen Buffer 1953 B<< C<l> >> Use Normal Screen Buffer
1614 1958
1615=back 1959=back
1616 1960
1617X<XTerm> 1961X<XTerm>
1618 1962
1619=head1 XTerm Operating System Commands 1963=head2 XTerm Operating System Commands
1620 1964
1621=over 4 1965=over 4
1622 1966
1623=item B<< C<ESC ] Ps;Pt ST> >> 1967=item B<< C<ESC ] Ps;Pt ST> >>
1624 1968
1638 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 1982 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1639 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1983 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1640 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1984 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1641 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706] 1985 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1642 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707] 1986 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1643 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1987 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
1644 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 1988 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1645 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1989 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1646 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 1990 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1647 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> >> 1991 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> >>
1648 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1992 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1649 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). 1993 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).
1650 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar). 1994 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>.
1651 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 1995 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1652 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). 1996 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1653 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >> 1997 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1654 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >> 1998 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1655 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 1999 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1662 2006
1663=end table 2007=end table
1664 2008
1665=back 2009=back
1666 2010
1667X<menuBar>
1668
1669=head1 menuBar
1670
1671B<< The exact syntax used is I<almost> solidified. >>
1672In the menus, B<DON'T> try to use menuBar commands that add or remove a
1673menuBar.
1674
1675Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1676omitted: use B<./> to specify a menu relative to the current menu.
1677
1678=head2 Overview of menuBar operation
1679
1680For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1681of C<Pt> can be used for a variety of tasks:
1682
1683At the top level is the current menuBar which is a member of a circular
1684linked-list of other such menuBars.
1685
1686The menuBar acts as a parent for the various drop-down menus, which in
1687turn, may have labels, separator lines, menuItems and subMenus.
1688
1689The menuItems are the useful bits: you can use them to mimic keyboard
1690input or even to send text or escape sequences back to rxvt.
1691
1692The menuBar syntax is intended to provide a simple yet robust method of
1693constructing and manipulating menus and navigating through the
1694menuBars.
1695
1696The first step is to use the tag B<< [menu:I<name>] >> which creates
1697the menuBar called I<name> and allows access. You may now or menus,
1698subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1699menuBar access as B<readonly> to prevent accidental corruption of the
1700menus. To re-access the current menuBar for alterations, use the tag
1701B<[menu]>, make the alterations and then use B<[done]>
1702
1703X<menuBarCommands>
1704
1705=head2 Commands
1706
1707=over 4
1708
1709=item B<< [menu:+I<name>] >>
1710
1711access the named menuBar for creation or alteration. If a new menuBar
1712is created, it is called I<name> (max of 15 chars) and the current
1713menuBar is pushed onto the stack
1714
1715=item B<[menu]>
1716
1717access the current menuBar for alteration
1718
1719=item B<< [title:+I<string>] >>
1720
1721set the current menuBar's title to I<string>, which may contain the
1722following format specifiers:
1723
1724 B<%n> rxvt name (as per the B<-name> command-line option)
1725 B<%v> rxvt version
1726 B<%%> literal B<%> character
1727
1728=item B<[done]>
1729
1730set menuBar access as B<readonly>.
1731End-of-file tag for B<< [read:+I<file>] >> operations.
1732
1733=item B<< [read:+I<file>] >>
1734
1735read menu commands directly from I<file> (extension ".menu" will be
1736appended if required.) Start reading at a line with B<[menu]> or B<<
1737[menu:+I<name> >> and continuing until B<[done]> is encountered.
1738
1739Blank and comment lines (starting with B<#>) are ignored. Actually,
1740since any invalid menu commands are also ignored, almost anything could
1741be construed as a comment line, but this may be tightened up in the
1742future ... so don't count on it!.
1743
1744=item B<< [read:+I<file>;+I<name>] >>
1745
1746The same as B<< [read:+I<file>] >>, but start reading at a line with
1747B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1748B<[done]> is encountered.
1749
1750=item B<[dump]>
1751
1752dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1753later rereading.
1754
1755=item B<[rm:name]>
1756
1757remove the named menuBar
1758
1759=item B<[rm] [rm:]>
1760
1761remove the current menuBar
1762
1763=item B<[rm*] [rm:*]>
1764
1765remove all menuBars
1766
1767=item B<[swap]>
1768
1769swap the top two menuBars
1770
1771=item B<[prev]>
1772
1773access the previous menuBar
1774
1775=item B<[next]>
1776
1777access the next menuBar
1778
1779=item B<[show]>
1780
1781Enable display of the menuBar
1782
1783=item B<[hide]>
1784
1785Disable display of the menuBar
1786
1787=item B<< [pixmap:+I<name>] >>
1788
1789=item B<< [pixmap:+I<name>;I<scaling>] >>
1790
1791(set the background pixmap globally
1792
1793B<< A Future implementation I<may> make this local to the menubar >>)
1794
1795=item B<< [:+I<command>:] >>
1796
1797ignore the menu readonly status and issue a I<command> to or a menu or
1798menuitem or change the ; a useful shortcut for setting the quick arrows
1799from a menuBar.
1800
1801=back
1802
1803X<menuBarAdd>
1804
1805=head2 Adding and accessing menus
1806
1807The following commands may also be B<+> prefixed.
1808
1809=over 4
1810
1811=item B</+>
1812
1813access menuBar top level
1814
1815=item B<./+>
1816
1817access current menu level
1818
1819=item B<../+>
1820
1821access parent menu (1 level up)
1822
1823=item B<../../>
1824
1825access parent menu (multiple levels up)
1826
1827=item B<< I</path/>menu >>
1828
1829add/access menu
1830
1831=item B<< I</path/>menu/* >>
1832
1833add/access menu and clear it if it exists
1834
1835=item B<< I</path/>{-} >>
1836
1837add separator
1838
1839=item B<< I</path/>{item} >>
1840
1841add B<item> as a label
1842
1843=item B<< I</path/>{item} action >>
1844
1845add/alter I<menuitem> with an associated I<action>
1846
1847=item B<< I</path/>{item}{right-text} >>
1848
1849add/alter I<menuitem> with B<right-text> as the right-justified text
1850and as the associated I<action>
1851
1852=item B<< I</path/>{item}{rtext} action >>
1853
1854add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1855the right-justified text.
1856
1857=back
1858
1859=over 4
1860
1861=item Special characters in I<action> must be backslash-escaped:
1862
1863B<\a \b \E \e \n \r \t \octal>
1864
1865=item or in control-character notation:
1866
1867B<^@, ^A .. ^Z .. ^_, ^?>
1868
1869=back
1870
1871To send a string starting with a B<NUL> (B<^@>) character to the
1872program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1873the first of which will be stripped off and the balance directed to the
1874program. Otherwise if I<action> begins with B<NUL> followed by
1875non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1876balance is sent back to rxvt.
1877
1878As a convenience for the many Emacs-type editors, I<action> may start
1879with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1880appended if missed from B<M-x> commands.
1881
1882As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1883quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1884
1885=over 4
1886
1887=item For example,
1888
1889B<M-xapropos> is equivalent to B<\Exapropos\r>
1890
1891=item and
1892
1893B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1894
1895=back
1896
1897The option B<< {I<right-rtext>} >> will be right-justified. In the
1898absence of a specified action, this text will be used as the I<action>
1899as well.
1900
1901=over 4
1902
1903=item For example,
1904
1905B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1906
1907=back
1908
1909The left label I<is> necessary, since it's used for matching, but
1910implicitly hiding the left label (by using same name for both left and
1911right labels), or explicitly hiding the left label (by preceeding it
1912with a dot), makes it possible to have right-justified text only.
1913
1914=over 4
1915
1916=item For example,
1917
1918B</File/{Open}{Open} Open-File-Action>
1919
1920=item or hiding it
1921
1922B</File/{.anylabel}{Open} Open-File-Action>
1923
1924=back
1925
1926X<menuBarRemove>
1927
1928=head2 Removing menus
1929
1930=over 4
1931
1932=item B<< -/*+ >>
1933
1934remove all menus from the menuBar, the same as B<[clear]>
1935
1936=item B<< -+I</path>menu+ >>
1937
1938remove menu
1939
1940=item B<< -+I</path>{item}+ >>
1941
1942remove item
1943
1944=item B<< -+I</path>{-} >>
1945
1946remove separator)
1947
1948=item B<-/path/menu/*>
1949
1950remove all items, separators and submenus from menu
1951
1952=back
1953
1954X<menuBarArrows>
1955
1956=head2 Quick Arrows
1957
1958The menus also provide a hook for I<quick arrows> to provide easier
1959user access. If nothing has been explicitly set, the default is to
1960emulate the curror keys. The syntax permits each arrow to be altered
1961individually or all four at once without re-entering their common
1962beginning/end text. For example, to explicitly associate cursor actions
1963with the arrows, any of the following forms could be used:
1964
1965=over 4
1966
1967=item B<< <r>+I<Right> >>
1968
1969=item B<< <l>+I<Left> >>
1970
1971=item B<< <u>+I<Up> >>
1972
1973=item B<< <d>+I<Down> >>
1974
1975Define actions for the respective arrow buttons
1976
1977=item B<< <b>+I<Begin> >>
1978
1979=item B<< <e>+I<End> >>
1980
1981Define common beginning/end parts for I<quick arrows> which used in
1982conjunction with the above <r> <l> <u> <d> constructs
1983
1984=back
1985
1986=over 4
1987
1988=item For example, define arrows individually,
1989
1990 <u>\E[A
1991
1992 <d>\E[B
1993
1994 <r>\E[C
1995
1996 <l>\E[D
1997
1998=item or all at once
1999
2000 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
2001
2002=item or more compactly (factoring out common parts)
2003
2004 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
2005
2006=back
2007
2008X<menuBarSummary>
2009
2010=head2 Command Summary
2011
2012A short summary of the most I<common> commands:
2013
2014=over 4
2015
2016=item [menu:name]
2017
2018use an existing named menuBar or start a new one
2019
2020=item [menu]
2021
2022use the current menuBar
2023
2024=item [title:string]
2025
2026set menuBar title
2027
2028=item [done]
2029
2030set menu access to readonly and, if reading from a file, signal EOF
2031
2032=item [done:name]
2033
2034if reading from a file using [read:file;name] signal EOF
2035
2036=item [rm:name]
2037
2038remove named menuBar(s)
2039
2040=item [rm] [rm:]
2041
2042remove current menuBar
2043
2044=item [rm*] [rm:*]
2045
2046remove all menuBar(s)
2047
2048=item [swap]
2049
2050swap top two menuBars
2051
2052=item [prev]
2053
2054access the previous menuBar
2055
2056=item [next]
2057
2058access the next menuBar
2059
2060=item [show]
2061
2062map menuBar
2063
2064=item [hide]
2065
2066unmap menuBar
2067
2068=item [pixmap;file]
2069
2070=item [pixmap;file;scaling]
2071
2072set a background pixmap
2073
2074=item [read:file]
2075
2076=item [read:file;name]
2077
2078read in a menu from a file
2079
2080=item [dump]
2081
2082dump out all menuBars to /tmp/rxvt-PID
2083
2084=item /
2085
2086access menuBar top level
2087
2088=item ./
2089
2090=item ../
2091
2092=item ../../
2093
2094access current or parent menu level
2095
2096=item /path/menu
2097
2098add/access menu
2099
2100=item /path/{-}
2101
2102add separator
2103
2104=item /path/{item}{rtext} action
2105
2106add/alter menu item
2107
2108=item -/*
2109
2110remove all menus from the menuBar
2111
2112=item -/path/menu
2113
2114remove menu items, separators and submenus from menu
2115
2116=item -/path/menu
2117
2118remove menu
2119
2120=item -/path/{item}
2121
2122remove item
2123
2124=item -/path/{-}
2125
2126remove separator
2127
2128=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
2129
2130menu quick arrows
2131
2132=back
2133X<XPM>
2134
2135=head1 XPM 2011=head1 XPM
2136 2012
2137For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2013For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
2138of B<< C<Pt> >> can be the name of the background pixmap followed by a 2014of B<< C<Pt> >> can be the name of the background pixmap followed by a
2139sequence of scaling/positioning commands separated by semi-colons. The 2015sequence of scaling/positioning commands separated by semi-colons. The
2236=begin table 2112=begin table
2237 2113
2238 4 Shift 2114 4 Shift
2239 8 Meta 2115 8 Meta
2240 16 Control 2116 16 Control
2241 32 Double Click I<(Rxvt extension)> 2117 32 Double Click I<(rxvt extension)>
2242 2118
2243=end table 2119=end table
2244 2120
2245Col = B<< C<< <x> - SPACE >> >> 2121Col = B<< C<< <x> - SPACE >> >>
2246 2122
2384alternative input methods (e.g. kinput2) and will also correctly 2260alternative input methods (e.g. kinput2) and will also correctly
2385set up the input for people using dead keys or compose keys. 2261set up the input for people using dead keys or compose keys.
2386 2262
2387=item --enable-unicode3 (default: off) 2263=item --enable-unicode3 (default: off)
2388 2264
2265Recommended to stay off unless you really need non-BMP characters.
2266
2389Enable direct support for displaying unicode codepoints above 2267Enable direct support for displaying unicode codepoints above
239065535 (the basic multilingual page). This increases storage 226865535 (the basic multilingual page). This increases storage
2391requirements per character from 2 to 4 bytes. X11 fonts do not yet 2269requirements per character from 2 to 4 bytes. X11 fonts do not yet
2392support these extra characters, but Xft does. 2270support these extra characters, but Xft does.
2393 2271
2403composite characters. This is required for proper viewing of text 2281composite characters. This is required for proper viewing of text
2404where accents are encoded as seperate unicode characters. This is 2282where accents are encoded as seperate unicode characters. This is
2405done by using precomposited characters when available or creating 2283done by using precomposited characters when available or creating
2406new pseudo-characters when no precomposed form exists. 2284new pseudo-characters when no precomposed form exists.
2407 2285
2408Without --enable-unicode3, the number of additional precomposed characters 2286Without --enable-unicode3, the number of additional precomposed
2409is rather limited (2048, if this is full, rxvt-unicode will use the 2287characters is somewhat limited (the 6400 private use characters will be
2410private use area, extending the number of combinations to 8448). With
2411--enable-unicode3, no practical limit exists. 2288(ab-)used). With --enable-unicode3, no practical limit exists.
2412 2289
2413This option will also enable storage (but not display) of characters 2290This option will also enable storage (but not display) of characters
2414beyond plane 0 (>65535) when --enable-unicode3 was not specified. 2291beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2415 2292
2416The combining table also contains entries for arabic presentation forms, 2293The combining table also contains entries for arabic presentation forms,
2417but these are not currently used. Bug me if you want these to be used (and 2294but these are not currently used. Bug me if you want these to be used (and
2418tell me how these are to be used...). 2295tell me how these are to be used...).
2419 2296
2420=item --enable-fallback(=CLASS) (default: Rxvt) 2297=item --enable-fallback(=CLASS) (default: Rxvt)
2421 2298
2422When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback. 2299When reading resource settings, also read settings for class CLASS. To
2300disable resource fallback use --disable-fallback.
2423 2301
2424=item --with-res-name=NAME (default: urxvt) 2302=item --with-res-name=NAME (default: urxvt)
2425 2303
2426Use the given name as default application name when 2304Use the given name as default application name when
2427reading resources. Specify --with-res-name=rxvt to replace rxvt. 2305reading resources. Specify --with-res-name=rxvt to replace rxvt.
2464 2342
2465=item --enable-tinting (default: on) 2343=item --enable-tinting (default: on)
2466 2344
2467Add support for tinting of transparent backgrounds (requires C<--enable-transparency>). 2345Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2468 2346
2469=item --enable-menubar (default: off) [DEPRECATED]
2470
2471Add support for our menu bar system (this interacts badly with dynamic
2472locale switching currently). This option is DEPRECATED and will be removed
2473in the future.
2474
2475=item --enable-rxvt-scroll (default: on) 2347=item --enable-rxvt-scroll (default: on)
2476 2348
2477Add support for the original rxvt scrollbar. 2349Add support for the original rxvt scrollbar.
2478 2350
2479=item --enable-next-scroll (default: on) 2351=item --enable-next-scroll (default: on)
2488 2360
2489Add support for a very unobtrusive, plain-looking scrollbar that 2361Add support for a very unobtrusive, plain-looking scrollbar that
2490is the favourite of the rxvt-unicode author, having used it for 2362is the favourite of the rxvt-unicode author, having used it for
2491many years. 2363many years.
2492 2364
2493=item --enable-half-shadow (default: off)
2494
2495Make shadows on the scrollbar only half the normal width & height.
2496only applicable to rxvt scrollbars.
2497
2498=item --enable-ttygid (default: off) 2365=item --enable-ttygid (default: off)
2499 2366
2500Change tty device setting to group "tty" - only use this if 2367Change tty device setting to group "tty" - only use this if
2501your system uses this type of security. 2368your system uses this type of security.
2502 2369
2510do it. 2377do it.
2511 2378
2512=item --disable-resources 2379=item --disable-resources
2513 2380
2514Removes any support for resource checking. 2381Removes any support for resource checking.
2515
2516=item --enable-xgetdefault
2517
2518Make resources checking via XGetDefault() instead of our small
2519version which only checks ~/.Xdefaults, or if that doesn't exist then
2520~/.Xresources.
2521
2522Please note that nowadays, things like XIM will automatically pull in and
2523use the full X resource manager, so the overhead of using it might be very
2524small, if nonexistant.
2525
2526=item --enable-strings (default: off)
2527
2528Add support for our possibly faster memset() function and other
2529various routines, overriding your system's versions which may
2530have been hand-crafted in assembly or may require extra libraries
2531to link in. (this breaks ANSI-C rules and has problems on many
2532GNU/Linux systems).
2533 2382
2534=item --disable-swapscreen 2383=item --disable-swapscreen
2535 2384
2536Remove support for secondary/swap screen. 2385Remove support for secondary/swap screen.
2537 2386
2546 2395
2547 MWM-hints 2396 MWM-hints
2548 EWMH-hints (pid, utf8 names) and protocols (ping) 2397 EWMH-hints (pid, utf8 names) and protocols (ping)
2549 seperate underline colour (-underlineColor) 2398 seperate underline colour (-underlineColor)
2550 settable border widths and borderless switch (-w, -b, -bl) 2399 settable border widths and borderless switch (-w, -b, -bl)
2400 visual depth selection (-depth)
2551 settable extra linespacing /-lsp) 2401 settable extra linespacing /-lsp)
2552 iso-14755-2 and -3, and visual feedback 2402 iso-14755-2 and -3, and visual feedback
2553 backindex and forwardindex escape sequence
2554 window op and some xterm/OSC escape sequences
2555 tripleclickwords (-tcw) 2403 tripleclickwords (-tcw)
2556 settable insecure mode (-insecure) 2404 settable insecure mode (-insecure)
2557 keysym remapping support 2405 keysym remapping support
2558 cursor blinking and underline cursor (-cb, -uc) 2406 cursor blinking and underline cursor (-cb, -uc)
2559 XEmbed support (-embed) 2407 XEmbed support (-embed)
2560 user-pty (-pty-fd) 2408 user-pty (-pty-fd)
2561 hold on exit (-hold) 2409 hold on exit (-hold)
2562 skip builtin block graphics (-sbg) 2410 skip builtin block graphics (-sbg)
2411 separate highlightcolor support (-hc)
2412
2413It also enables some non-essential features otherwise disabled, such as:
2414
2415 some round-trip time optimisations
2416 nearest color allocation on pseudocolor screens
2417 UTF8_STRING supporr for selection
2563 sgr modes 90..97 and 100..107 2418 sgr modes 90..97 and 100..107
2419 backindex and forwardindex escape sequences
2420 view change/zero scorllback esacpe sequences
2421 locale switching escape sequence
2422 window op and some xterm/OSC escape sequences
2423 rectangular selections
2424 trailing space removal for selections
2425 verbose X error handling
2564 2426
2565=item --enable-iso14755 (default: on) 2427=item --enable-iso14755 (default: on)
2566 2428
2567Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2429Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2568F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2430F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2589Remove support for mouse selection style like that of xterm. 2451Remove support for mouse selection style like that of xterm.
2590 2452
2591=item --enable-dmalloc (default: off) 2453=item --enable-dmalloc (default: off)
2592 2454
2593Use Gray Watson's malloc - which is good for debugging See 2455Use Gray Watson's malloc - which is good for debugging See
2594http://www.letters.com/dmalloc/ for details If you use either this or the 2456L<http://www.letters.com/dmalloc/> for details If you use either this or the
2595next option, you may need to edit src/Makefile after compiling to point 2457next option, you may need to edit src/Makefile after compiling to point
2596DINCLUDE and DLIB to the right places. 2458DINCLUDE and DLIB to the right places.
2597 2459
2598You can only use either this option and the following (should 2460You can only use either this option and the following (should
2599you use either) . 2461you use either) .
2611 2473
2612=item --enable-pointer-blank (default: on) 2474=item --enable-pointer-blank (default: on)
2613 2475
2614Add support to have the pointer disappear when typing or inactive. 2476Add support to have the pointer disappear when typing or inactive.
2615 2477
2616=item --enable-perl (default: off) 2478=item --enable-perl (default: on)
2617 2479
2618Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2480Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2619manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files 2481manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2620in F<src/perl-ext/> for the extensions that are installed by default. The 2482in F<src/perl-ext/> for the extensions that are installed by default. The
2621perl interpreter that is used can be specified via the C<PERL> environment 2483perl interpreter that is used can be specified via the C<PERL> environment

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines