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.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.208 by sf-exg, Sat Dec 18 12:20:18 2010 UTC

1=head1 Rxvt Technical Reference 1=head1 NAME
2 2
3Marc Lehmann <rxvt@schmorp.de>, converted to pod and reworked from the 3RXVT REFERENCE - FAQ, command sequences and other background information
4original Rxvt documentation by Geoff Wing <gcw@pobox.com>, who in turn used
5the XTerm documentation and other sources.
6 4
7=head1 Definitions 5=head1 SYNOPSIS
6
7 # set a new font set
8 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
9
10 # change the locale and tell rxvt-unicode about it
11 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
12
13 # set window title
14 printf '\33]2;%s\007' "new window title"
15
16=head1 DESCRIPTION
17
18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19all escape sequences, and other background information.
20
21The newest version of this document is also available on the World Wide Web at
22L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23
24The main manual page for @@RXVT_NAME@@ itself is available at
25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
26
27=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
28
29
30=head2 Meta, Features & Commandline Issues
31
32=head3 My question isn't answered here, can I ask a human?
33
34Before sending me mail, you could go to IRC: C<irc.freenode.net>,
35channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
36interested in learning about new and exciting problems (but not FAQs :).
37
38=head3 I use Gentoo, and I have a problem...
39
40There are three big problems with Gentoo Linux: first of all, most if not
41all Gentoo systems are completely broken (missing or mismatched header
42files, broken compiler etc. are just the tip of the iceberg); secondly,
43the Gentoo maintainer thinks it is a good idea to add broken patches to
44the code; and lastly, it should be called Gentoo GNU/Linux.
45
46For these reasons, it is impossible to support rxvt-unicode on
47Gentoo. Problems appearing on Gentoo systems will usually simply be
48ignored unless they can be reproduced on non-Gentoo systems.
49
50=head3 Does it support tabs, can I have a tabbed rxvt-unicode?
51
52Beginning with version 7.3, there is a perl extension that implements a
53simple tabbed terminal. It is installed by default, so any of these should
54give you tabs:
55
56 @@URXVT_NAME@@ -pe tabbed
57
58 URxvt.perl-ext-common: default,tabbed
59
60It will also work fine with tabbing functionality of many window managers
61or similar tabbing programs, and its embedding-features allow it to be
62embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
63the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
64(murxvt) terminal as an example embedding application.
65
66=head3 How do I know which rxvt-unicode version I'm using?
67
68The version number is displayed with the usage (-h). Also the escape
69sequence C<ESC [ 8 n> sets the window title to the version number. When
70using the @@URXVT_NAME@@c client, the version displayed is that of the
71daemon.
72
73=head3 Rxvt-unicode uses gobs of memory, how can I reduce that?
74
75Rxvt-unicode tries to obey the rule of not charging you for something you
76don't use. One thing you should try is to configure out all settings that
77you don't need, for example, Xft support is a resource hog by design,
78when used. Compiling it out ensures that no Xft font will be loaded
79accidentally when rxvt-unicode tries to find a font for your characters.
80
81Also, many people (me included) like large windows and even larger
82scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
836 bytes per screen cell. For a 160x?? window this amounts to almost a
84kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
85use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
86rxvt-unicode then uses 8 bytes per screen cell.
87
88=head3 How can I start @@URXVT_NAME@@d in a race-free way?
89
90Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
91display, create the listening socket and then fork.
92
93=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
94
95If you want to start @@URXVT_NAME@@d automatically whenever you run
96@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
97
98 #!/bin/sh
99 @@URXVT_NAME@@c "$@"
100 if [ $? -eq 2 ]; then
101 @@URXVT_NAME@@d -q -o -f
102 @@URXVT_NAME@@c "$@"
103 fi
104
105This tries to create a new terminal, and if fails with exit status 2,
106meaning it couldn't connect to the daemon, it will start the daemon and
107re-run the command. Subsequent invocations of the script will re-use the
108existing daemon.
109
110=head3 How do I distinguish whether I'm running rxvt-unicode or a regular
111xterm? I need this to decide about setting colours etc.
112
113The original rxvt and rxvt-unicode always export the variable "COLORTERM",
114so you can check and see if that is set. Note that several programs, JED,
115slrn, Midnight Commander automatically check this variable to decide
116whether or not to use colour.
117
118=head3 How do I set the correct, full IP address for the DISPLAY variable?
119
120If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
121insecure mode then it is possible to use the following shell script
122snippets to correctly set the display. If your version of rxvt-unicode
123wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
124the COLORTERM variable can be used to distinguish rxvt-unicode from a
125regular xterm.
126
127Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
128snippets:
129
130 # Bourne/Korn/POSIX family of shells:
131 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
132 if [ ${TERM:-foo} = xterm ]; then
133 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
134 echo -n '^[Z'
135 read term_id
136 stty icanon echo
137 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
138 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
139 read DISPLAY # set it in our local shell
140 fi
141 fi
142
143=head3 How do I compile the manual pages on my own?
144
145You need to have a recent version of perl installed as F</usr/bin/perl>,
146one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from
147F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
148
149=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
150
151I often get asked about this, and I think, no, they didn't cause extra
152bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
153that the urxvt binary is larger (due to some encoding tables always being
154compiled in), but it actually uses less memory (RSS) after startup. Even
155with C<--disable-everything>, this comparison is a bit unfair, as many
156features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
157already in use in this mode.
158
159 text data bss drs rss filename
160 98398 1664 24 15695 1824 rxvt --disable-everything
161 188985 9048 66616 18222 1788 urxvt --disable-everything
162
163When you C<--enable-everything> (which I<is> unfair, as this involves xft
164and full locale/XIM support which are quite bloaty inside libX11 and my
165libc), the two diverge, but not unreasonably so.
166
167 text data bss drs rss filename
168 163431 2152 24 20123 2060 rxvt --enable-everything
169 1035683 49680 66648 29096 3680 urxvt --enable-everything
170
171The very large size of the text section is explained by the east-asian
172encoding tables, which, if unused, take up disk space but nothing else
173and can be compiled out unless you rely on X11 core fonts that use those
174encodings. The BSS size comes from the 64k emergency buffer that my c++
175compiler allocates (but of course doesn't use unless you are out of
176memory). Also, using an xft font instead of a core font immediately adds a
177few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
178not used.
179
180Of course, due to every character using two or four bytes instead of one,
181a large scrollback buffer will ultimately make rxvt-unicode use more
182memory.
183
184Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
185still fares rather well. And compared to some monsters like gnome-terminal
186(21152k + extra 4204k in separate processes) or konsole (22200k + extra
18743180k in daemons that stay around after exit, plus half a minute of
188startup time, including the hundreds of warnings it spits out), it fares
189extremely well *g*.
190
191=head3 Why C++, isn't that unportable/bloated/uncool?
192
193Is this a question? :) It comes up very often. The simple answer is: I had
194to write it, and C++ allowed me to write and maintain it in a fraction
195of the time and effort (which is a scarce resource for me). Put even
196shorter: It simply wouldn't exist without C++.
197
198My personal stance on this is that C++ is less portable than C, but in
199the case of rxvt-unicode this hardly matters, as its portability limits
200are defined by things like X11, pseudo terminals, locale support and unix
201domain sockets, which are all less portable than C++ itself.
202
203Regarding the bloat, see the above question: It's easy to write programs
204in C that use gobs of memory, and certainly possible to write programs in
205C++ that don't. C++ also often comes with large libraries, but this is
206not necessarily the case with GCC. Here is what rxvt links against on my
207system with a minimal config:
208
209 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
210 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
211 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
212 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
213
214And here is rxvt-unicode:
215
216 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
217 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
218 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
219 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
220 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
221
222No large bloated libraries (of course, none were linked in statically),
223except maybe libX11 :)
224
225
226=head2 Rendering, Font & Look and Feel Issues
227
228=head3 I can't get transparency working, what am I doing wrong?
229
230First of all, transparency isn't officially supported in rxvt-unicode, so
231you are mostly on your own. Do not bug the author about it (but you may
232bug everybody else). Also, if you can't get it working consider it a rite
233of passage: ... and you failed.
234
235Here are four ways to get transparency. B<Do> read the manpage and option
236descriptions for the programs mentioned and rxvt-unicode. Really, do it!
237
2381. Use transparent mode:
239
240 Esetroot wallpaper.jpg
241 @@URXVT_NAME@@ -tr -tint red -sh 40
242
243That works. If you think it doesn't, you lack transparency and tinting
244support, or you are unable to read.
245This method requires that the background-setting program sets the
246_XROOTPMAP_ID or ESETROOT_PMAP_ID property. Compatible programs
247are Esetroot, hsetroot and feh.
248
2492. Use a simple pixmap and emulate pseudo-transparency. This enables you
250to use effects other than tinting and shading: Just shade/tint/whatever
251your picture with gimp or any other tool:
252
253 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
254 @@URXVT_NAME@@ -pixmap "background.jpg;:root"
255
256That works. If you think it doesn't, you lack libAfterImage or GDK-PixBuf support, or you
257are unable to read.
258
2593. Use an ARGB visual:
260
261 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
262
263This requires XFT support, and the support of your X-server. If that
264doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
265there yet, no matter what they claim. Rxvt-Unicode contains the necessary
266bugfixes and workarounds for Xft and Xlib to make it work, but that
267doesn't mean that your WM has the required kludges in place.
268
2694. Use xcompmgr and let it do the job:
270
271 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
272 -set _NET_WM_WINDOW_OPACITY 0xc0000000
273
274Then click on a window you want to make transparent. Replace C<0xc0000000>
275by other values to change the degree of opacity. If it doesn't work and
276your server crashes, you got to keep the pieces.
277
278=head3 Why does rxvt-unicode sometimes leave pixel droppings?
279
280Most fonts were not designed for terminal use, which means that character
281size varies a lot. A font that is otherwise fine for terminal use might
282contain some characters that are simply too wide. Rxvt-unicode will avoid
283these characters. For characters that are just "a bit" too wide a special
284"careful" rendering mode is used that redraws adjacent characters.
285
286All of this requires that fonts do not lie about character sizes,
287however: Xft fonts often draw glyphs larger than their acclaimed bounding
288box, and rxvt-unicode has no way of detecting this (the correct way is to
289ask for the character bounding box, which unfortunately is wrong in these
290cases).
291
292It's not clear (to me at least), whether this is a bug in Xft, freetype,
293or the respective font. If you encounter this problem you might try using
294the C<-lsp> option to give the font more height. If that doesn't work, you
295might be forced to use a different font.
296
297All of this is not a problem when using X11 core fonts, as their bounding
298box data is correct.
299
300=head3 How can I keep rxvt-unicode from using reverse video so much?
301
302First of all, make sure you are running with the right terminal settings
303(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
304make sure you have specified colours for italic and bold, as otherwise
305rxvt-unicode might use reverse video to simulate the effect:
306
307 URxvt.colorBD: white
308 URxvt.colorIT: green
309
310=head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
311
312For some unexplainable reason, some rare programs assume a very weird
313colour palette when confronted with a terminal with more than the standard
3148 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
315these programs not to assume non-ISO colours without very good reasons.
316
317In the meantime, you can either edit your C<rxvt-unicode> terminfo
318definition to only claim 8 colour support or use C<TERM=rxvt>, which will
319fix colours but keep you from using other rxvt-unicode features.
320
321=head3 Can I switch the fonts at runtime?
322
323Yes, using an escape sequence. Try something like this, which has the same
324effect as using the C<-fn> switch, and takes effect immediately:
325
326 printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
327
328This is useful if you e.g. work primarily with japanese (and prefer a
329japanese font), but you have to switch to chinese temporarily, where
330japanese fonts would only be in your way.
331
332You can think of this as a kind of manual ISO-2022 switching.
333
334=head3 Why do italic characters look as if clipped?
335
336Many fonts have difficulties with italic characters and hinting. For
337example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
338Mono> completely fails in its italic face. A workaround might be to
339enable freetype autohinting, i.e. like this:
340
341 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
342 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
343
344=head3 Can I speed up Xft rendering somehow?
345
346Yes, the most obvious way to speed it up is to avoid Xft entirely, as
347it is simply slow. If you still want Xft fonts you might try to disable
348antialiasing (by appending C<:antialias=false>), which saves lots of
349memory and also speeds up rendering considerably.
350
351=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
352
353Rxvt-unicode will use whatever you specify as a font. If it needs to
354fall back to its default font search list it will prefer X11 core
355fonts, because they are small and fast, and then use Xft fonts. It has
356antialiasing disabled for most of them, because the author thinks they
357look best that way.
358
359If you want antialiasing, you have to specify the fonts manually.
360
361=head3 What's with this bold/blink stuff?
362
363If no bold colour is set via C<colorBD:>, bold will invert text using the
364standard foreground colour.
365
366For the standard background colour, blinking will actually make
367the text blink when compiled with C<--enable-text-blink>. Without
368C<--enable-text-blink>, the blink attribute will be ignored.
369
370On ANSI colours, bold/blink attributes are used to set high-intensity
371foreground/background colours.
372
373color0-7 are the low-intensity colours.
374
375color8-15 are the corresponding high-intensity colours.
376
377=head3 I don't like the screen colours. How do I change them?
378
379You can change the screen colours at run-time using F<~/.Xdefaults>
380resources (or as long-options).
381
382Here are values that are supposed to resemble a VGA screen,
383including the murky brown that passes for low-intensity yellow:
384
385 URxvt.color0: #000000
386 URxvt.color1: #A80000
387 URxvt.color2: #00A800
388 URxvt.color3: #A8A800
389 URxvt.color4: #0000A8
390 URxvt.color5: #A800A8
391 URxvt.color6: #00A8A8
392 URxvt.color7: #A8A8A8
393
394 URxvt.color8: #000054
395 URxvt.color9: #FF0054
396 URxvt.color10: #00FF54
397 URxvt.color11: #FFFF54
398 URxvt.color12: #0000FF
399 URxvt.color13: #FF00FF
400 URxvt.color14: #00FFFF
401 URxvt.color15: #FFFFFF
402
403And here is a more complete set of non-standard colours.
404
405 URxvt.cursorColor: #dc74d1
406 URxvt.pointerColor: #dc74d1
407 URxvt.background: #0e0e0e
408 URxvt.foreground: #4ad5e1
409 URxvt.color0: #000000
410 URxvt.color8: #8b8f93
411 URxvt.color1: #dc74d1
412 URxvt.color9: #dc74d1
413 URxvt.color2: #0eb8c7
414 URxvt.color10: #0eb8c7
415 URxvt.color3: #dfe37e
416 URxvt.color11: #dfe37e
417 URxvt.color5: #9e88f0
418 URxvt.color13: #9e88f0
419 URxvt.color6: #73f7ff
420 URxvt.color14: #73f7ff
421 URxvt.color7: #e1dddd
422 URxvt.color15: #e1dddd
423
424They have been described (not by me) as "pretty girly".
425
426=head3 Why do some characters look so much different than others?
427
428See next entry.
429
430=head3 How does rxvt-unicode choose fonts?
431
432Most fonts do not contain the full range of Unicode, which is
433fine. Chances are that the font you (or the admin/package maintainer of
434your system/os) have specified does not cover all the characters you want
435to display.
436
437B<rxvt-unicode> makes a best-effort try at finding a replacement
438font. Often the result is fine, but sometimes the chosen font looks
439bad/ugly/wrong. Some fonts have totally strange characters that don't
440resemble the correct glyph at all, and rxvt-unicode lacks the artificial
441intelligence to detect that a specific glyph is wrong: it has to believe
442the font that the characters it claims to contain indeed look correct.
443
444In that case, select a font of your taste and add it to the font list,
445e.g.:
446
447 @@URXVT_NAME@@ -fn basefont,font2,font3...
448
449When rxvt-unicode sees a character, it will first look at the base
450font. If the base font does not contain the character, it will go to the
451next font, and so on. Specifying your own fonts will also speed up this
452search and use less resources within rxvt-unicode and the X-server.
453
454The only limitation is that none of the fonts may be larger than the base
455font, as the base font defines the terminal character cell size, which
456must be the same due to the way terminals work.
457
458=head3 Why do some chinese characters look so different than others?
459
460This is because there is a difference between script and language --
461rxvt-unicode does not know which language the text that is output is,
462as it only knows the unicode character codes. If rxvt-unicode first
463sees a japanese/chinese character, it might choose a japanese font for
464display. Subsequent japanese characters will use that font. Now, many
465chinese characters aren't represented in japanese fonts, so when the first
466non-japanese character comes up, rxvt-unicode will look for a chinese font
467-- unfortunately at this point, it will still use the japanese font for
468chinese characters that are also in the japanese font.
469
470The workaround is easy: just tag a chinese font at the end of your font
471list (see the previous question). The key is to view the font list as
472a preference list: If you expect more japanese, list a japanese font
473first. If you expect more chinese, put a chinese font first.
474
475In the future it might be possible to switch language preferences at
476runtime (the internal data structure has no problem with using different
477fonts for the same character at the same time, but no interface for this
478has been designed yet).
479
480Until then, you might get away with switching fonts at runtime (see L<Can
481I switch the fonts at runtime?> later in this document).
482
483=head3 How can I make mplayer display video correctly?
484
485We are working on it, in the meantime, as a workaround, use something like:
486
487 @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
488
489
490=head2 Keyboard, Mouse & User Interaction
491
492=head3 The new selection selects pieces that are too big, how can I select single words?
493
494If you want to select e.g. alphanumeric words, you can use the following
495setting:
496
497 URxvt.selection.pattern-0: ([[:word:]]+)
498
499If you click more than twice, the selection will be extended
500more and more.
501
502To get a selection that is very similar to the old code, try this pattern:
503
504 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
505
506Please also note that the I<LeftClick Shift-LeftClick> combination also
507selects words like the old code.
508
509=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
510
511You can disable the perl extension completely by setting the
512B<perl-ext-common> resource to the empty string, which also keeps
513rxvt-unicode from initialising perl, saving memory.
514
515If you only want to disable specific features, you first have to
516identify which perl extension is responsible. For this, read the section
517B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
518example, to disable the B<selection-popup> and B<option-popup>, specify
519this B<perl-ext-common> resource:
520
521 URxvt.perl-ext-common: default,-selection-popup,-option-popup
522
523This will keep the default extensions, but disable the two popup
524extensions. Some extensions can also be configured, for example,
525scrollback search mode is triggered by B<M-s>. You can move it to any
526other combination either by setting the B<searchable-scrollback> resource:
527
528 URxvt.searchable-scrollback: CM-s
529
530=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
531
532See next entry.
533
534=head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
535
536These are caused by the C<readline> perl extension. Under normal
537circumstances, it will move your cursor around when you click into the
538line that contains it. It tries hard not to do this at the wrong moment,
539but when running a program that doesn't parse cursor movements or in some
540cases during rlogin sessions, it fails to detect this properly.
541
542You can permanently switch this feature off by disabling the C<readline>
543extension:
544
545 URxvt.perl-ext-common: default,-readline
546
547=head3 My numerical keypad acts weird and generates differing output?
548
549Some Debian GNUL/Linux users seem to have this problem, although no
550specific details were reported so far. It is possible that this is caused
551by the wrong C<TERM> setting, although the details of whether and how
552this can happen are unknown, as C<TERM=rxvt> should offer a compatible
553keymap. See the answer to the previous question, and please report if that
554helped.
555
556=head3 My Compose (Multi_key) key is no longer working.
557
558The most common causes for this are that either your locale is not set
559correctly, or you specified a B<preeditStyle> that is not supported by
560your input method. For example, if you specified B<OverTheSpot> and
561your input method (e.g. the default input method handling Compose keys)
562does not support this (for instance because it is not visual), then
563rxvt-unicode will continue without an input method.
564
565In this case either do not specify a B<preeditStyle> or specify more than
566one pre-edit style, such as B<OverTheSpot,Root,None>.
567
568If it still doesn't work, then maybe your input method doesn't support
569compose sequences - to fall back to the built-in one, make sure you don't
570specify an input method via C<-im> or C<XMODIFIERS>.
571
572=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
573
574Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
575international keyboards) or simply use ISO 14755 support to your
576advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
577codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
578character and so on.
579
580=head3 Mouse cut/paste suddenly no longer works.
581
582Make sure that mouse reporting is actually turned off since killing
583some editors prematurely may leave it active. I've
584heard that tcsh may use mouse reporting unless it is otherwise specified. A
585quick check is to see if cut/paste works when the Alt or Shift keys are
586pressed.
587
588=head3 What's with the strange Backspace/Delete key behaviour?
589
590Assuming that the physical Backspace key corresponds to the
591Backspace keysym (not likely for Linux ... see the following
592question) there are two standard values that can be used for
593Backspace: C<^H> and C<^?>.
594
595Historically, either value is correct, but rxvt-unicode adopts the debian
596policy of using C<^?> when unsure, because it's the one and only correct
597choice :).
598
599It is possible to toggle between C<^H> and C<^?> with the DECBKM
600private mode:
601
602 # use Backspace = ^H
603 $ stty erase ^H
604 $ echo -n "^[[?67h"
605
606 # use Backspace = ^?
607 $ stty erase ^?
608 $ echo -n "^[[?67l"
609
610This helps satisfy some of the Backspace discrepancies that occur, but
611if you use Backspace = C<^H>, make sure that the termcap/terminfo value
612properly reflects that.
613
614The Delete key is a another casualty of the ill-defined Backspace problem.
615To avoid confusion between the Backspace and Delete keys, the Delete
616key has been assigned an escape sequence to match the vt100 for Execute
617(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
618
619Some other Backspace problems:
620
621some editors use termcap/terminfo,
622some editors (vim I'm told) expect Backspace = ^H,
623GNU Emacs (and Emacs-like editors) use ^H for help.
624
625Perhaps someday this will all be resolved in a consistent manner.
626
627=head3 I don't like the key-bindings. How do I change them?
628
629There are some compile-time selections available via configure. Unless
630you have run "configure" with the C<--disable-resources> option you can
631use the `keysym' resource to alter the keystrings associated with keysyms.
632
633Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
634
635 URxvt.keysym.Home: \033[1~
636 URxvt.keysym.End: \033[4~
637 URxvt.keysym.C-apostrophe: \033<C-'>
638 URxvt.keysym.C-slash: \033<C-/>
639 URxvt.keysym.C-semicolon: \033<C-;>
640 URxvt.keysym.C-grave: \033<C-`>
641 URxvt.keysym.C-comma: \033<C-,>
642 URxvt.keysym.C-period: \033<C-.>
643 URxvt.keysym.C-0x60: \033<C-`>
644 URxvt.keysym.C-Tab: \033<C-Tab>
645 URxvt.keysym.C-Return: \033<C-Return>
646 URxvt.keysym.S-Return: \033<S-Return>
647 URxvt.keysym.S-space: \033<S-Space>
648 URxvt.keysym.M-Up: \033<M-Up>
649 URxvt.keysym.M-Down: \033<M-Down>
650 URxvt.keysym.M-Left: \033<M-Left>
651 URxvt.keysym.M-Right: \033<M-Right>
652 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
653 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
654 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
655
656See some more examples in the documentation for the B<keysym> resource.
657
658=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
659
660 KP_Insert == Insert
661 F22 == Print
662 F27 == Home
663 F29 == Prior
664 F33 == End
665 F35 == Next
666
667Rather than have rxvt-unicode try to accommodate all the various possible
668keyboard mappings, it is better to use `xmodmap' to remap the keys as
669required for your particular machine.
670
671
672=head2 Terminal Configuration
673
674=head3 Can I see a typical configuration?
675
676The default configuration tries to be xterm-like, which I don't like that
677much, but it's least surprise to regular users.
678
679As a rxvt or rxvt-unicode user, you are practically supposed to invest
680time into customising your terminal. To get you started, here is the
681author's .Xdefaults entries, with comments on what they do. It's certainly
682not I<typical>, but what's typical...
683
684 URxvt.cutchars: "()*,<>[]{}|'
685 URxvt.print-pipe: cat >/tmp/xxx
686
687These are just for testing stuff.
688
689 URxvt.imLocale: ja_JP.UTF-8
690 URxvt.preeditType: OnTheSpot,None
691
692This tells rxvt-unicode to use a special locale when communicating with
693the X Input Method, and also tells it to only use the OnTheSpot pre-edit
694type, which requires the C<xim-onthespot> perl extension but rewards me
695with correct-looking fonts.
696
697 URxvt.perl-lib: /root/lib/urxvt
698 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
699 URxvt.selection.pattern-0: ( at .*? line \\d+)
700 URxvt.selection.pattern-1: ^(/[^:]+):\
701 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
702 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
703
704This is my perl configuration. The first two set the perl library
705directory and also tells urxvt to use a large number of extensions. I
706develop for myself mostly, so I actually use most of the extensions I
707write.
708
709The selection stuff mainly makes the selection perl-error-message aware
710and tells it to convert perl error messages into vi-commands to load the
711relevant file and go to the error line number.
712
713 URxvt.scrollstyle: plain
714 URxvt.secondaryScroll: true
715
716As the documentation says: plain is the preferred scrollbar for the
717author. The C<secondaryScroll> configures urxvt to scroll in full-screen
718apps, like screen, so lines scrolled out of screen end up in urxvt's
719scrollback buffer.
720
721 URxvt.background: #000000
722 URxvt.foreground: gray90
723 URxvt.color7: gray90
724 URxvt.colorBD: #ffffff
725 URxvt.cursorColor: #e0e080
726 URxvt.throughColor: #8080f0
727 URxvt.highlightColor: #f0f0f0
728
729Some colours. Not sure which ones are being used or even non-defaults, but
730these are in my .Xdefaults. Most notably, they set foreground/background
731to light gray/black, and also make sure that the colour 7 matches the
732default foreground colour.
733
734 URxvt.underlineColor: yellow
735
736Another colour, makes underline lines look different. Sometimes hurts, but
737is mostly a nice effect.
738
739 URxvt.geometry: 154x36
740 URxvt.loginShell: false
741 URxvt.meta: ignore
742 URxvt.utmpInhibit: true
743
744Uh, well, should be mostly self-explanatory. By specifying some defaults
745manually, I can quickly switch them for testing.
746
747 URxvt.saveLines: 8192
748
749A large scrollback buffer is essential. Really.
750
751 URxvt.mapAlert: true
752
753The only case I use it is for my IRC window, which I like to keep
754iconified till people msg me (which beeps).
755
756 URxvt.visualBell: true
757
758The audible bell is often annoying, especially when in a crowd.
759
760 URxvt.insecure: true
761
762Please don't hack my mutt! Ooops...
763
764 URxvt.pastableTabs: false
765
766I once thought this is a great idea.
767
768 urxvt.font: 9x15bold,\
769 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
770 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
771 [codeset=JISX0208]xft:Kochi Gothic, \
772 xft:Bitstream Vera Sans Mono:autohint=true, \
773 xft:Code2000:antialias=false
774 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
775 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
776 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
777
778I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
779overwhelmed. A special note: the C<9x15bold> mentioned above is actually
780the version from XFree-3.3, as XFree-4 replaced it by a totally different
781font (different glyphs for C<;> and many other harmless characters),
782while the second font is actually the C<9x15bold> from XFree4/XOrg. The
783bold version has less chars than the medium version, so I use it for rare
784characters, too. When editing sources with vim, I use italic for comments
785and other stuff, which looks quite good with Bitstream Vera anti-aliased.
786
787Terminus is a quite bad font (many very wrong glyphs), but for most of my
788purposes, it works, and gives a different look, as my normal (Non-bold)
789font is already bold, and I want to see a difference between bold and
790normal fonts.
791
792Please note that I used the C<urxvt> instance name and not the C<URxvt>
793class name. That is because I use different configs for different purposes,
794for example, my IRC window is started with C<-name IRC>, and uses these
795defaults:
796
797 IRC*title: IRC
798 IRC*geometry: 87x12+535+542
799 IRC*saveLines: 0
800 IRC*mapAlert: true
801 IRC*font: suxuseuro
802 IRC*boldFont: suxuseuro
803 IRC*colorBD: white
804 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
805 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
806
807C<Alt-Ctrl-1> and C<Alt-Ctrl-2> switch between two different font
808sizes. C<suxuseuro> allows me to keep an eye (and actually read)
809stuff while keeping a very small window. If somebody pastes something
810complicated (e.g. japanese), I temporarily switch to a larger font.
811
812The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
813C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
814file for different hosts, for example, on my main desktop, I use:
815
816 URxvt.keysym.C-M-q: command:\033[3;5;5t
817 URxvt.keysym.C-M-y: command:\033[3;5;606t
818 URxvt.keysym.C-M-e: command:\033[3;1605;5t
819 URxvt.keysym.C-M-c: command:\033[3;1605;606t
820 URxvt.keysym.C-M-p: perl:test
821
822The first for keysym definitions allow me to quickly bring some windows
823in the layout I like most. Ion users might start laughing but will stop
824immediately when I tell them that I use my own Fvwm2 module for much the
825same effect as Ion provides, and I only very rarely use the above key
826combinations :->
827
828=head3 Why doesn't rxvt-unicode read my resources?
829
830Well, why, indeed? It does, in a way very similar to other X
831applications. Most importantly, this means that if you or your OS loads
832resources into the X display (the right way to do it), rxvt-unicode will
833ignore any resource files in your home directory. It will only read
834F<$HOME/.Xdefaults> when no resources are attached to the display.
835
836If you have or use an F<$HOME/.Xresources> file, chances are that
837resources are loaded into your X-server. In this case, you have to
838re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
839
840Also consider the form resources have to use:
841
842 URxvt.resource: value
843
844If you want to use another form (there are lots of different ways of
845specifying resources), make sure you understand whether and why it
846works. If unsure, use the form above.
847
848=head3 When I log-in to another system it tells me about missing terminfo data?
849
850The terminal description used by rxvt-unicode is not as widely available
851as that for xterm, or even rxvt (for which the same problem often arises).
852
853The correct solution for this problem is to install the terminfo, this can
854be done by simply installing rxvt-unicode on the remote system as well
855(in case you have a nice package manager ready), or you can install the
856terminfo database manually like this (with ncurses infocmp. works as
857user and root):
858
859 REMOTE=remotesystem.domain
860 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
861
862One some systems you might need to set C<$TERMINFO> to the full path of
863F<$HOME/.terminfo> for this to work.
864
865If you cannot or do not want to do this, then you can simply set
866C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
867problems arising, which includes wrong keymapping, less and different
868colours and some refresh errors in fullscreen applications. It's a nice
869quick-and-dirty workaround for rare cases, though.
870
871If you always want to do this (and are fine with the consequences) you
872can either recompile rxvt-unicode with the desired TERM value or use a
873resource to set it:
874
875 URxvt.termName: rxvt
876
877If you don't plan to use B<rxvt> (quite common...) you could also replace
878the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
879
880=head3 nano fails with "Error opening terminal: rxvt-unicode"
881
882This exceptionally confusing and useless error message is printed by nano
883when it can't find the terminfo database. Nothing is wrong with your
884terminal, read the previous answer for a solution.
885
886=head3 C<tic> outputs some error when compiling the terminfo entry.
887
888Most likely it's the empty definition for C<enacs=>. Just replace it by
889C<enacs=\E[0@> and try again.
890
891=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
892
893See next entry.
894
895=head3 I need a termcap file entry.
896
897One reason you might want this is that some distributions or operating
898systems still compile some programs using the long-obsoleted termcap
899library (Fedora Core's bash is one example) and rely on a termcap entry
900for C<rxvt-unicode>.
901
902You could use rxvt's termcap entry with reasonable results in many cases.
903You can also create a termcap entry by using terminfo's infocmp program
904like this:
905
906 infocmp -C rxvt-unicode
907
908Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap,
909generated by the command above.
910
911=head3 Why does C<ls> no longer have coloured output?
912
913The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
914decide whether a terminal has colour, but uses its own configuration
915file. Needless to say, C<rxvt-unicode> is not in its default file (among
916with most other terminals supporting colour). Either add:
917
918 TERM rxvt-unicode
919
920to C</etc/DIR_COLORS> or simply add:
921
922 alias ls='ls --color=auto'
923
924to your C<.profile> or C<.bashrc>.
925
926=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
927
928See next entry.
929
930=head3 Why doesn't vim/emacs etc. make use of italic?
931
932See next entry.
933
934=head3 Why are the secondary screen-related options not working properly?
935
936Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
937distributions (most notably Debian GNU/Linux) break rxvt-unicode
938by setting C<TERM> to C<rxvt>, which doesn't have these extra
939features. Unfortunately, some of these (most notably, again, Debian
940GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
941file, so you will need to install it on your own (See the question B<When
942I log-in to another system it tells me about missing terminfo data?> on
943how to do this).
944
945
946=head2 Encoding / Locale / Input Method Issues
947
948=head3 Rxvt-unicode does not seem to understand the selected encoding?
949
950See next entry.
951
952=head3 Unicode does not seem to work?
953
954If you encounter strange problems like typing an accented character but
955getting two unrelated other characters or similar, or if program output is
956subtly garbled, then you should check your locale settings.
957
958Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
959programs running in it. Often rxvt-unicode is started in the C<C> locale,
960while the login script running within the rxvt-unicode window changes the
961locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
962not going to work, and is the most common cause for problems.
963
964The best thing is to fix your startup environment, as you will likely run
965into other problems. If nothing works you can try this in your .profile.
966
967 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
968
969If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
970supported on your systems. Some systems have a C<locale> command which
971displays this (also, C<perl -e0> can be used to check locale settings, as
972it will complain loudly if it cannot set the locale). If it displays something
973like:
974
975 locale: Cannot set LC_CTYPE to default locale: ...
976
977Then the locale you specified is not supported on your system.
978
979If nothing works and you are sure that everything is set correctly then
980you will need to remember a little known fact: Some programs just don't
981support locales :(
982
983=head3 How does rxvt-unicode determine the encoding to use?
984
985See next entry.
986
987=head3 Is there an option to switch encodings?
988
989Unlike some other terminals, rxvt-unicode has no encoding switch, and no
990specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
991UTF-8 or any other encodings with respect to terminal I/O.
992
993The reasons is that there exists a perfectly fine mechanism for selecting
994the encoding, doing I/O and (most important) communicating this to all
995applications so everybody agrees on character properties such as width
996and code number. This mechanism is the I<locale>. Applications not using
997that info will have problems (for example, C<xterm> gets the width of
998characters wrong as it uses its own, locale-independent table under all
999locales).
1000
1001Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
1002programs doing the same (that is, most) will automatically agree in the
1003interpretation of characters.
1004
1005Unfortunately, there is no system-independent way to select locales, nor
1006is there a standard on how locale specifiers will look like.
1007
1008On most systems, the content of the C<LC_CTYPE> environment variable
1009contains an arbitrary string which corresponds to an already-installed
1010locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1011C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1012(i.e. C<de> or C<german>) are also common.
1013
1014Rxvt-unicode ignores all other locale categories, and except for
1015the encoding, ignores country or language-specific settings,
1016i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
1017rxvt-unicode.
1018
1019If you want to use a specific encoding you have to make sure you start
1020rxvt-unicode with the correct C<LC_CTYPE> category.
1021
1022=head3 Can I switch locales at runtime?
1023
1024Yes, using an escape sequence. Try something like this, which sets
1025rxvt-unicode's idea of C<LC_CTYPE>.
1026
1027 printf '\33]701;%s\007' ja_JP.SJIS
1028
1029See also the previous answer.
1030
1031Sometimes this capability is rather handy when you want to work in
1032one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
1033(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
1034first switches to a locale supported by xjdic and back later:
1035
1036 printf '\33]701;%s\007' ja_JP.SJIS
1037 xjdic -js
1038 printf '\33]701;%s\007' de_DE.UTF-8
1039
1040You can also use xterm's C<luit> program, which usually works fine, except
1041for some locales where character width differs between program- and
1042rxvt-unicode-locales.
1043
1044=head3 I have problems getting my input method working.
1045
1046Try a search engine, as this is slightly different for every input method server.
1047
1048Here is a checklist:
8 1049
9=over 4 1050=over 4
10 1051
1052=item - Make sure your locale I<and> the imLocale are supported on your OS.
1053
1054Try C<locale -a> or check the documentation for your OS.
1055
1056=item - Make sure your locale or imLocale matches a locale supported by your XIM.
1057
1058For example, B<kinput2> does not support UTF-8 locales, you should use
1059C<ja_JP.EUC-JP> or equivalent.
1060
1061=item - Make sure your XIM server is actually running.
1062
1063=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1064
1065When you want to use e.g. B<kinput2>, it must be set to
1066C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1067method servers are running with this command:
1068
1069 xprop -root XIM_SERVERS
1070
1071=item
1072
1073=back
1074
1075=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
1076
1077You can specify separate locales for the input method and the rest of the
1078terminal, using the resource C<imlocale>:
1079
1080 URxvt.imlocale: ja_JP.EUC-JP
1081
1082Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
1083use your input method. Please note, however, that, depending on your Xlib
1084version, you may not be able to input characters outside C<EUC-JP> in a
1085normal way then, as your input method limits you.
1086
1087=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
1088
1089Unfortunately, this is unavoidable, as the XIM protocol is racy by
1090design. Applications can avoid some crashes at the expense of memory
1091leaks, and Input Methods can avoid some crashes by careful ordering at
1092exit time. B<kinput2> (and derived input methods) generally succeeds,
1093while B<SCIM> (or similar input methods) fails. In the end, however,
1094crashes cannot be completely avoided even if both sides cooperate.
1095
1096So the only workaround is not to kill your Input Method Servers.
1097
1098
1099=head2 Operating Systems / Package Maintaining
1100
1101=head3 I am using Debian GNU/Linux and have a problem...
1102
1103The Debian GNU/Linux package of rxvt-unicode in sarge contains large
1104patches that considerably change the behaviour of rxvt-unicode (but
1105unfortunately this notice has been removed). Before reporting a bug to
1106the original rxvt-unicode author please download and install the genuine
1107version (L<http://software.schmorp.de/pkg/rxvt-unicode.html>) and try to
1108reproduce the problem. If you cannot, chances are that the problems are
1109specific to Debian GNU/Linux, in which case it should be reported via the
1110Debian Bug Tracking System (use C<reportbug> to report the bug).
1111
1112For other problems that also affect the Debian package, you can and
1113probably should use the Debian BTS, too, because, after all, it's also a
1114bug in the Debian version and it serves as a reminder for other users that
1115might encounter the same issue.
1116
1117=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
1118
1119You should build one binary with the default options. F<configure>
1120now enables most useful options, and the trend goes to making them
1121runtime-switchable, too, so there is usually no drawback to enabling them,
1122except higher disk and possibly memory usage. The perl interpreter should
1123be enabled, as important functionality (menus, selection, likely more in
1124the future) depends on it.
1125
1126You should not overwrite the C<perl-ext-common> and C<perl-ext> resources
1127system-wide (except maybe with C<defaults>). This will result in useful
1128behaviour. If your distribution aims at low memory, add an empty
1129C<perl-ext-common> resource to the app-defaults file. This will keep the
1130perl interpreter disabled until the user enables it.
1131
1132If you can/want build more binaries, I recommend building a minimal
1133one with C<--disable-everything> (very useful) and a maximal one with
1134C<--enable-everything> (less useful, it will be very big due to a lot of
1135encodings built-in that increase download times and are rarely used).
1136
1137=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
1138
1139It should be, starting with release 7.1. You are encouraged to properly
1140install urxvt with privileges necessary for your OS now.
1141
1142When rxvt-unicode detects that it runs setuid or setgid, it will fork
1143into a helper process for privileged operations (pty handling on some
1144systems, utmp/wtmp/lastlog handling on others) and drop privileges
1145immediately. This is much safer than most other terminals that keep
1146privileges while running (but is more relevant to urxvt, as it contains
1147things as perl interpreters, which might be "helpful" to attackers).
1148
1149This forking is done as the very first within main(), which is very early
1150and reduces possible bugs to initialisation code run before main(), or
1151things like the dynamic loader of your system, which should result in very
1152little risk.
1153
1154=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
1155
1156Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1157in your compile environment, or an implementation that implements it,
1158whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
1159B<wchar_t> is represented as unicode.
1160
1161As you might have guessed, FreeBSD does neither define this symbol nor
1162does it support it. Instead, it uses its own internal representation of
1163B<wchar_t>. This is, of course, completely fine with respect to standards.
1164
1165However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
1166C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>).
1167
1168C<__STDC_ISO_10646__> is the only sane way to support multi-language
1169apps in an OS, as using a locale-dependent (and non-standardized)
1170representation of B<wchar_t> makes it impossible to convert between
1171B<wchar_t> (as used by X11 and your applications) and any other encoding
1172without implementing OS-specific-wrappers for each and every locale. There
1173simply are no APIs to convert B<wchar_t> into anything except the current
1174locale encoding.
1175
1176Some applications (such as the formidable B<mlterm>) work around this
1177by carrying their own replacement functions for character set handling
1178with them, and either implementing OS-dependent hacks or doing multiple
1179conversions (which is slow and unreliable in case the OS implements
1180encodings slightly different than the terminal emulator).
1181
1182The rxvt-unicode author insists that the right way to fix this is in the
1183system libraries once and for all, instead of forcing every app to carry
1184complete replacements for them :)
1185
1186=head3 How can I use rxvt-unicode under cygwin?
1187
1188rxvt-unicode should compile and run out of the box on cygwin, using
1189the X11 libraries that come with cygwin. libW11 emulation is no
1190longer supported (and makes no sense, either, as it only supported a
1191single font). I recommend starting the X-server in C<-multiwindow> or
1192C<-rootless> mode instead, which will result in similar look&feel as the
1193old libW11 emulation.
1194
1195At the time of this writing, cygwin didn't seem to support any multi-byte
1196encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1197to 8-bit encodings.
1198
1199=head3 Character widths are not correct.
1200
1201urxvt uses the system wcwidth function to know the information about
1202the width of characters, so on systems with incorrect locale data you
1203will likely get bad results. Two notorious examples are Solaris 9,
1204where single-width characters like U+2514 are reported as double-width,
1205and Darwin 8, where combining chars are reported having width 1.
1206
1207The solution is to upgrade your system or switch to a better one. A
1208possibly working workaround is to use a wcwidth implementation like
1209
1210http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1211
1212=head1 RXVT-UNICODE TECHNICAL REFERENCE
1213
1214The rest of this document describes various technical aspects of
1215B<rxvt-unicode>. First the description of supported command sequences,
1216followed by pixmap support and last by a description of all features
1217selectable at C<configure> time.
1218
1219=head2 Definitions
1220
1221=over 4
1222
11=item B<< C<c> >> 1223=item B<< C<c> >>
12 1224
13The literal character c. 1225The literal character c (potentially a multi-byte character).
14 1226
15=item B<< C<C> >> 1227=item B<< C<C> >>
16 1228
17A single (required) character. 1229A single (required) character.
18 1230
… …
30 1242
31A text parameter composed of printable characters. 1243A text parameter composed of printable characters.
32 1244
33=back 1245=back
34 1246
35=head1 Values 1247=head2 Values
36 1248
37=over 4 1249=over 4
38 1250
39=item B<< C<ENQ> >> 1251=item B<< C<ENQ> >>
40 1252
41Enquiry (Ctrl-E) = Send Device Attributes (DA) 1253Enquiry (Ctrl-E) = Send Device Attributes (DA)
42request attributes from terminal == 1254request attributes from terminal. See B<< C<ESC [ Ps c> >>.
43 1255
44=item B<< C<BEL> >> 1256=item B<< C<BEL> >>
45 1257
46Bell (Ctrl-G) 1258Bell (Ctrl-G)
47 1259
… …
83 1295
84Space Character 1296Space Character
85 1297
86=back 1298=back
87 1299
88=head1 Escape Sequences 1300=head2 Escape Sequences
89 1301
90=over 4 1302=over 4
91 1303
92=item B<< C<ESC # 8> >> 1304=item B<< C<ESC # 8> >>
93 1305
… …
103 1315
104=item B<< C<ESC => >> 1316=item B<< C<ESC => >>
105 1317
106Application Keypad (SMKX). See also next sequence. 1318Application Keypad (SMKX). See also next sequence.
107 1319
108=item B<<< C<< ESC >> >>> 1320=item B<<< C<< ESC > >> >>>
109 1321
110Normal Keypad (RMKX) 1322Normal Keypad (RMKX)
111 1323
112B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been 1324B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been
113pressed, numbers or control functions are generated by the numeric keypad 1325pressed, numbers or control functions are generated by the numeric keypad
… …
139Single Shift Select of G3 Character Set (SS3): affects next character 1351Single Shift Select of G3 Character Set (SS3): affects next character
140only I<unimplemented> 1352only I<unimplemented>
141 1353
142=item B<< C<ESC Z> >> 1354=item B<< C<ESC Z> >>
143 1355
144Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt compile-time option> 1356Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
145 1357
146=item B<< C<ESC c> >> 1358=item B<< C<ESC c> >>
147 1359
148Full reset (RIS) 1360Full reset (RIS)
149 1361
… …
153 1365
154=item B<< C<ESC o> >> 1366=item B<< C<ESC o> >>
155 1367
156Invoke the G3 Character Set (LS3) 1368Invoke the G3 Character Set (LS3)
157 1369
158=item B<< C<ESC>(C<C> >> 1370=item B<< C<ESC ( C> >>
159 1371
160Designate G0 Character Set (ISO 2022), see below for values of C<C>. 1372Designate G0 Character Set (ISO 2022), see below for values of C<C>.
161 1373
162=item B<< C<ESC>)C<C> >> 1374=item B<< C<ESC ) C> >>
163 1375
164Designate G1 Character Set (ISO 2022), see below for values of C<C>. 1376Designate G1 Character Set (ISO 2022), see below for values of C<C>.
165 1377
166=item B<< C<ESC * C> >> 1378=item B<< C<ESC * C> >>
167 1379
… …
191 1403
192=back 1404=back
193 1405
194X<CSI> 1406X<CSI>
195 1407
196=head1 CSI (Code Sequence Introducer) Sequences 1408=head2 CSI (Command Sequence Introducer) Sequences
197 1409
198=over 4 1410=over 4
199 1411
200=item B<< C<ESC [ Ps @> >> 1412=item B<< C<ESC [ Ps @> >>
201 1413
… …
256=begin table 1468=begin table
257 1469
258 B<< C<Ps = 0> >> Clear to Right (default) 1470 B<< C<Ps = 0> >> Clear to Right (default)
259 B<< C<Ps = 1> >> Clear to Left 1471 B<< C<Ps = 1> >> Clear to Left
260 B<< C<Ps = 2> >> Clear All 1472 B<< C<Ps = 2> >> Clear All
1473 B<< C<Ps = 3> >> Like Ps = 0, but is ignored when wrapped
1474 (@@RXVT_NAME@@ extension)
261 1475
262=end table 1476=end table
263 1477
264=item B<< C<ESC [ Ps L> >> 1478=item B<< C<ESC [ Ps L> >>
265 1479
… …
298 1512
299Move backward B<< C<Ps> >> [default: 1] tab stops 1513Move backward B<< C<Ps> >> [default: 1] tab stops
300 1514
301=item B<< C<ESC [ Ps '> >> 1515=item B<< C<ESC [ Ps '> >>
302 1516
303== 1517See B<< C<ESC [ Ps G> >>
304 1518
305=item B<< C<ESC [ Ps a> >> 1519=item B<< C<ESC [ Ps a> >>
306 1520
307==X<ESCOBPsc> 1521See B<< C<ESC [ Ps C> >>
308 1522
309=item B<< C<ESC [ Ps c> >> 1523=item B<< C<ESC [ Ps c> >>
310 1524
311Send Device Attributes (DA) 1525Send Device Attributes (DA)
312B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1526B<< C<Ps = 0> >> (or omitted): request attributes from terminal
313returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1527returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
314Option'') 1528Option'')
315 1529
316=item B<< C<ESC [ Ps d> >> 1530=item B<< C<ESC [ Ps d> >>
317 1531
318Cursor to Line B<< C<Ps> >> (VPA) 1532Cursor to Line B<< C<Ps> >> (VPA)
319 1533
320=item B<< C<ESC [ Ps e> >> 1534=item B<< C<ESC [ Ps e> >>
321 1535
322== 1536See B<< C<ESC [ Ps A> >>
323 1537
324=item B<< C<ESC [ Ps;Ps f> >> 1538=item B<< C<ESC [ Ps;Ps f> >>
325 1539
326Horizontal and Vertical Position [row;column] (HVP) [default: 1;1] 1540Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]
327 1541
… …
334 B<< C<Ps = 0> >> Clear Current Column (default) 1548 B<< C<Ps = 0> >> Clear Current Column (default)
335 B<< C<Ps = 3> >> Clear All (TBC) 1549 B<< C<Ps = 3> >> Clear All (TBC)
336 1550
337=end table 1551=end table
338 1552
1553=item B<< C<ESC [ Pm h> >>
1554
1555Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
1556
339=item B<< C<ESC [ Ps i> >> 1557=item B<< C<ESC [ Ps i> >>
340 1558
341Printing 1559Printing. See also the C<print-pipe> resource.
342 1560
343=begin table 1561=begin table
344 1562
1563 B<< C<Ps = 0> >> print screen (MC0)
345 B<< C<Ps = 4> >> disable transparent print mode (MC4) 1564 B<< C<Ps = 4> >> disable transparent print mode (MC4)
346 B<< C<Ps = 5> >> enable transparent print mode (MC5) I<unimplemented> 1565 B<< C<Ps = 5> >> enable transparent print mode (MC5)
347 1566
348=end table 1567=end table
349
350=item B<< C<ESC [ Pm h> >>
351
352Set Mode (SM). See next sequence for description of C<Pm>.
353 1568
354=item B<< C<ESC [ Pm l> >> 1569=item B<< C<ESC [ Pm l> >>
355 1570
356Reset Mode (RM) 1571Reset Mode (RM)
357 1572
… …
364 B<< C<h> >> Insert Mode (SMIR) 1579 B<< C<h> >> Insert Mode (SMIR)
365 B<< C<l> >> Replace Mode (RMIR) 1580 B<< C<l> >> Replace Mode (RMIR)
366 1581
367=end table 1582=end table
368 1583
369=item B<< C<Ps = 20> >> I<unimplemented> 1584=item B<< C<Ps = 20> >> (partially implemented)
370 1585
371=begin table 1586=begin table
372 1587
373 B<< C<h> >> Automatic Newline (LNM) 1588 B<< C<h> >> Automatic Newline (LNM)
374 B<< C<h> >> Normal Linefeed (LNM) 1589 B<< C<l> >> Normal Linefeed (LNM)
375 1590
376=end table 1591=end table
377 1592
378=back 1593=back
379 1594
… …
382Character Attributes (SGR) 1597Character Attributes (SGR)
383 1598
384=begin table 1599=begin table
385 1600
386 B<< C<Ps = 0> >> Normal (default) 1601 B<< C<Ps = 0> >> Normal (default)
387 B<< C<Ps = 1 / 22> >> On / Off Bold (bright fg) 1602 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg)
1603 B<< C<Ps = 3 / 23> >> On / Off Italic
388 B<< C<Ps = 4 / 24> >> On / Off Underline 1604 B<< C<Ps = 4 / 24> >> On / Off Underline
389 B<< C<Ps = 5 / 25> >> On / Off Blink (bright bg) 1605 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg)
1606 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg)
390 B<< C<Ps = 7 / 27> >> On / Off Inverse 1607 B<< C<Ps = 7 / 27> >> On / Off Inverse
1608 B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI)
391 B<< C<Ps = 30 / 40> >> fg/bg Black 1609 B<< C<Ps = 30 / 40> >> fg/bg Black
392 B<< C<Ps = 31 / 41> >> fg/bg Red 1610 B<< C<Ps = 31 / 41> >> fg/bg Red
393 B<< C<Ps = 32 / 42> >> fg/bg Green 1611 B<< C<Ps = 32 / 42> >> fg/bg Green
394 B<< C<Ps = 33 / 43> >> fg/bg Yellow 1612 B<< C<Ps = 33 / 43> >> fg/bg Yellow
395 B<< C<Ps = 34 / 44> >> fg/bg Blue 1613 B<< C<Ps = 34 / 44> >> fg/bg Blue
396 B<< C<Ps = 35 / 45> >> fg/bg Magenta 1614 B<< C<Ps = 35 / 45> >> fg/bg Magenta
397 B<< C<Ps = 36 / 46> >> fg/bg Cyan 1615 B<< C<Ps = 36 / 46> >> fg/bg Cyan
1616 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to colour #m (ISO 8613-6)
398 B<< C<Ps = 37 / 47> >> fg/bg White 1617 B<< C<Ps = 37 / 47> >> fg/bg White
399 B<< C<Ps = 39 / 49> >> fg/bg Default 1618 B<< C<Ps = 39 / 49> >> fg/bg Default
1619 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
1620 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
1621 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
1622 B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow
1623 B<< C<Ps = 94 / 104> >> fg/bg Bright Blue
1624 B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta
1625 B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan
1626 B<< C<Ps = 97 / 107> >> fg/bg Bright White
1627 B<< C<Ps = 99 / 109> >> fg/bg Bright Default
400 1628
401=end table 1629=end table
402 1630
403=item B<< C<ESC [ Ps n> >> 1631=item B<< C<ESC [ Ps n> >>
404 1632
… …
420 1648
421=item B<< C<ESC [ s> >> 1649=item B<< C<ESC [ s> >>
422 1650
423Save Cursor (SC) 1651Save Cursor (SC)
424 1652
1653=item B<< C<ESC [ Ps;Pt t> >>
1654
1655Window Operations
1656
1657=begin table
1658
1659 B<< C<Ps = 1> >> Deiconify (map) window
1660 B<< C<Ps = 2> >> Iconify window
1661 B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1662 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1663 B<< C<Ps = 5> >> Raise window
1664 B<< C<Ps = 6> >> Lower window
1665 B<< C<Ps = 7> >> Refresh screen once
1666 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1667 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1668 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1669 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1670 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1671 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1672 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1673 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
1674 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1675
1676=end table
1677
1678=item B<< C<ESC [ u> >>
1679
1680Restore Cursor
1681
425=item B<< C<ESC [ Ps x> >> 1682=item B<< C<ESC [ Ps x> >>
426 1683
427Request Terminal Parameters (DECREQTPARM) 1684Request Terminal Parameters (DECREQTPARM)
428 1685
429=item B<< C<ESC [ u> >>
430
431Restore Cursor
432
433=back 1686=back
434 1687
435X<PrivateModes> 1688X<PrivateModes>
436 1689
437=head1 DEC Private Modes 1690=head2 DEC Private Modes
438 1691
439=over 4 1692=over 4
440 1693
441=item B<< C<ESC [ ? Pm h> >> 1694=item B<< C<ESC [ ? Pm h> >>
442 1695
… …
458 1711
459Toggle DEC Private Mode Values (rxvt extension). I<where> 1712Toggle DEC Private Mode Values (rxvt extension). I<where>
460 1713
461=over 4 1714=over 4
462 1715
463=item B<< C<Ps = 1> >> (DECCKM) 1716=item B<< C<Pm = 1> >> (DECCKM)
464 1717
465=begin table 1718=begin table
466 1719
467 B<< C<h> >> Application Cursor Keys 1720 B<< C<h> >> Application Cursor Keys
468 B<< C<l> >> Normal Cursor Keys 1721 B<< C<l> >> Normal Cursor Keys
469 1722
470=end table 1723=end table
471 1724
472=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1725=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
473 1726
474=begin table 1727=begin table
475 1728
476 B<< C<h> >> Enter VT52 mode 1729 B<< C<h> >> Enter VT52 mode
477 B<< C<l> >> Enter VT52 mode 1730 B<< C<l> >> Enter VT52 mode
478 1731
479=end table 1732=end table
480 1733
481=item B<< C<Ps = 3> >> 1734=item B<< C<Pm = 3> >>
482 1735
483=begin table 1736=begin table
484 1737
485 B<< C<h> >> 132 Column Mode (DECCOLM) 1738 B<< C<h> >> 132 Column Mode (DECCOLM)
486 B<< C<l> >> 80 Column Mode (DECCOLM) 1739 B<< C<l> >> 80 Column Mode (DECCOLM)
487 1740
488=end table 1741=end table
489 1742
490=item B<< C<Ps = 4> >> 1743=item B<< C<Pm = 4> >>
491 1744
492=begin table 1745=begin table
493 1746
494 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1747 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
495 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1748 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
496 1749
497=end table 1750=end table
498 1751
499=item B<< C<Ps = 5> >> 1752=item B<< C<Pm = 5> >>
500 1753
501=begin table 1754=begin table
502 1755
503 B<< C<h> >> Reverse Video (DECSCNM) 1756 B<< C<h> >> Reverse Video (DECSCNM)
504 B<< C<l> >> Normal Video (DECSCNM) 1757 B<< C<l> >> Normal Video (DECSCNM)
505 1758
506=end table 1759=end table
507 1760
508=item B<< C<Ps = 6> >> 1761=item B<< C<Pm = 6> >>
509 1762
510=begin table 1763=begin table
511 1764
512 B<< C<h> >> Origin Mode (DECOM) 1765 B<< C<h> >> Origin Mode (DECOM)
513 B<< C<l> >> Normal Cursor Mode (DECOM) 1766 B<< C<l> >> Normal Cursor Mode (DECOM)
514 1767
515=end table 1768=end table
516 1769
517=item B<< C<Ps = 7> >> 1770=item B<< C<Pm = 7> >>
518 1771
519=begin table 1772=begin table
520 1773
521 B<< C<h> >> Wraparound Mode (DECAWM) 1774 B<< C<h> >> Wraparound Mode (DECAWM)
522 B<< C<l> >> No Wraparound Mode (DECAWM) 1775 B<< C<l> >> No Wraparound Mode (DECAWM)
523 1776
524=end table 1777=end table
525 1778
526=item B<< C<Ps = 8> >> I<unimplemented> 1779=item B<< C<Pm = 8> >> I<unimplemented>
527 1780
528=begin table 1781=begin table
529 1782
530 B<< C<h> >> Auto-repeat Keys (DECARM) 1783 B<< C<h> >> Auto-repeat Keys (DECARM)
531 B<< C<l> >> No Auto-repeat Keys (DECARM) 1784 B<< C<l> >> No Auto-repeat Keys (DECARM)
532 1785
533=end table 1786=end table
534 1787
535=item B<< C<Ps = 9> >> X10 XTerm 1788=item B<< C<Pm = 9> >> X10 XTerm
536 1789
537=begin table 1790=begin table
538 1791
539 B<< C<h> >> Send Mouse X & Y on button press. 1792 B<< C<h> >> Send Mouse X & Y on button press.
540 B<< C<l> >> No mouse reporting. 1793 B<< C<l> >> No mouse reporting.
541 1794
542=end table 1795=end table
543 1796
544)X<Priv10>
545
546=item B<< C<Ps = 10> >> (B<rxvt>)
547
548=begin table
549
550 B<< C<h> >> visible
551 B<< C<l> >> invisible
552
553=end table
554
555=item B<< C<Ps = 25> >> 1797=item B<< C<Pm = 25> >>
556 1798
557=begin table 1799=begin table
558 1800
559 B<< C<h> >> Visible cursor {cnorm/cvvis} 1801 B<< C<h> >> Visible cursor {cnorm/cvvis}
560 B<< C<l> >> Invisible cursor {civis} 1802 B<< C<l> >> Invisible cursor {civis}
561 1803
562=end table 1804=end table
563 1805
564=item B<< C<Ps = 30> >> 1806=item B<< C<Pm = 30> >>
565 1807
566=begin table 1808=begin table
567 1809
568 B<< C<h> >> scrollBar visisble 1810 B<< C<h> >> scrollBar visible
569 B<< C<l> >> scrollBar invisisble 1811 B<< C<l> >> scrollBar invisible
570 1812
571=end table 1813=end table
572 1814
573=item B<< C<Ps = 35> >> (B<rxvt>) 1815=item B<< C<Pm = 35> >> (B<rxvt>)
574 1816
575=begin table 1817=begin table
576 1818
577 B<< C<h> >> Allow XTerm Shift+key sequences 1819 B<< C<h> >> Allow XTerm Shift+key sequences
578 B<< C<l> >> Disallow XTerm Shift+key sequences 1820 B<< C<l> >> Disallow XTerm Shift+key sequences
579 1821
580=end table 1822=end table
581 1823
582=item B<< C<Ps = 38> >> I<unimplemented> 1824=item B<< C<Pm = 38> >> I<unimplemented>
583 1825
584Enter Tektronix Mode (DECTEK) 1826Enter Tektronix Mode (DECTEK)
585 1827
586=item B<< C<Ps = 40> >> 1828=item B<< C<Pm = 40> >>
587 1829
588=begin table 1830=begin table
589 1831
590 B<< C<h> >> Allow 80/132 Mode 1832 B<< C<h> >> Allow 80/132 Mode
591 B<< C<l> >> Disallow 80/132 Mode 1833 B<< C<l> >> Disallow 80/132 Mode
592 1834
593=end table 1835=end table
594 1836
595=item B<< C<Ps = 44> >> I<unimplemented> 1837=item B<< C<Pm = 44> >> I<unimplemented>
596 1838
597=begin table 1839=begin table
598 1840
599 B<< C<h> >> Turn On Margin Bell 1841 B<< C<h> >> Turn On Margin Bell
600 B<< C<l> >> Turn Off Margin Bell 1842 B<< C<l> >> Turn Off Margin Bell
601 1843
602=end table 1844=end table
603 1845
604=item B<< C<Ps = 45> >> I<unimplemented> 1846=item B<< C<Pm = 45> >> I<unimplemented>
605 1847
606=begin table 1848=begin table
607 1849
608 B<< C<h> >> Reverse-wraparound Mode 1850 B<< C<h> >> Reverse-wraparound Mode
609 B<< C<l> >> No Reverse-wraparound Mode 1851 B<< C<l> >> No Reverse-wraparound Mode
610 1852
611=end table 1853=end table
612 1854
613=item B<< C<Ps = 46> >> I<unimplemented> 1855=item B<< C<Pm = 46> >> I<unimplemented>
614 1856
615=item B<< C<Ps = 47> >> 1857=item B<< C<Pm = 47> >>
616 1858
617=begin table 1859=begin table
618 1860
619 B<< C<h> >> Use Alternate Screen Buffer 1861 B<< C<h> >> Use Alternate Screen Buffer
620 B<< C<l> >> Use Normal Screen Buffer 1862 B<< C<l> >> Use Normal Screen Buffer
621 1863
622=end table 1864=end table
623 1865
624X<Priv66> 1866X<Priv66>
625 1867
626=item B<< C<Ps = 66> >> 1868=item B<< C<Pm = 66> >>
627 1869
628=begin table 1870=begin table
629 1871
630 B<< C<h> >> Application Keypad (DECPAM) == 1872 B<< C<h> >> Application Keypad (DECKPAM/DECPAM) == C<ESC =>
631 B<< C<l> >> Normal Keypad (DECPNM) == 1873 B<< C<l> >> Normal Keypad (DECKPNM/DECPNM) == C<< ESC > >>
632 1874
633=end table 1875=end table
634 1876
635=item B<< C<Ps = 67> >> 1877=item B<< C<Pm = 67> >>
636 1878
637=begin table 1879=begin table
638 1880
639 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1881 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
640 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1882 B<< C<l> >> Backspace key sends B<< C<DEL> >>
641 1883
642=end table 1884=end table
643 1885
644=item B<< C<Ps = 1000> >> (X11 XTerm) 1886=item B<< C<Pm = 1000> >> (X11 XTerm)
645 1887
646=begin table 1888=begin table
647 1889
648 B<< C<h> >> Send Mouse X & Y on button press and release. 1890 B<< C<h> >> Send Mouse X & Y on button press and release.
649 B<< C<l> >> No mouse reporting. 1891 B<< C<l> >> No mouse reporting.
650 1892
651=end table 1893=end table
652 1894
653=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1895=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
654 1896
655=begin table 1897=begin table
656 1898
657 B<< C<h> >> Use Hilite Mouse Tracking. 1899 B<< C<h> >> Use Hilite Mouse Tracking.
658 B<< C<l> >> No mouse reporting. 1900 B<< C<l> >> No mouse reporting.
659 1901
660=end table 1902=end table
661 1903
1904=item B<< C<Pm = 1002> >> (X11 XTerm)
1905
1906=begin table
1907
1908 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1909 B<< C<l> >> No mouse reporting.
1910
1911=end table
1912
1913=item B<< C<Pm = 1003> >> (X11 XTerm)
1914
1915=begin table
1916
1917 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1918 B<< C<l> >> No mouse reporting.
1919
1920=end table
1921
1922=item B<< C<Pm = 1005> >> (X11 XTerm) (Compile frills)
1923
1924Try to avoid this mode, it doesn't work sensibly in non-UTF-8 locales. Use
1925mode C<1015> instead.
1926
1927Unlike XTerm, coordinates larger than 2015) will work fine.
1928
1929=begin table
1930
1931 B<< C<h> >> Enable mouse coordinates in locale-specific encoding.
1932 B<< C<l> >> Enable mouse coordinates as binary octets.
1933
1934=end table
1935
662=item B<< C<Ps = 1010> >> 1936=item B<< C<Pm = 1010> >> (B<rxvt>)
663 1937
664=begin table 1938=begin table
665 1939
666 B<< C<h> >> Don't scroll to bottom on TTY output 1940 B<< C<h> >> Don't scroll to bottom on TTY output
667 B<< C<l> >> Scroll to bottom on TTY output 1941 B<< C<l> >> Scroll to bottom on TTY output
668 1942
669=end table 1943=end table
670 1944
671=item B<< C<Ps = 1011> >> 1945=item B<< C<Pm = 1011> >> (B<rxvt>)
672 1946
673=begin table 1947=begin table
674 1948
675 B<< C<h> >> Scroll to bottom when a key is pressed 1949 B<< C<h> >> Scroll to bottom when a key is pressed
676 B<< C<l> >> Don't scroll to bottom when a key is pressed 1950 B<< C<l> >> Don't scroll to bottom when a key is pressed
677 1951
678=end table 1952=end table
679 1953
1954=item B<< C<Pm = 1015> >> (B<rxvt-unicode>) (Compile frills)
1955
1956Changes all mouse reporting codes to use decimal parameters instead of
1957octets or characters.
1958
1959This mode should be enabled I<before> actually enabling mouse reporting,
1960for semi-obvious reasons.
1961
1962The sequences received for various modes are as follows:
1963
1964 ESC [ M o o o !1005, !1015 (three octets)
1965 ESC [ M c c c 1005, !1015 (three characters)
1966 ESC [ Pm M 1015 (three or more numeric paramaters)
1967
1968The three parameters are C<code>, C<x> and C<y>. Code is the numeric code
1969as for the other modes (but encoded as a decimal number), C<x> and C<y>
1970are the coordinates (1|1 is the upper left corner, just as with cursor
1971positioning).
1972
1973Example: Shift-Button-1 press at top row, column 80.
1974
1975 ESC [ 5 ; 80 ; 1 M
1976
1977One can use this feature by simply enabling it and then looking for
1978parameters to the C<ESC [ M> reply - if there are any, this mode is
1979active, otherwise one of the old reporting styles is used.
1980
1981Other (to be implemented) reply sequences will use a similar encoding.
1982
1983In the future, more parameters might get added (pixel coordinates for
1984example - anybody out there who needs this?).
1985
1986=begin table
1987
1988 B<< C<h> >> Enable new mouse coordinate reporting.
1989 B<< C<l> >> Use old-style C<CSI M C C C> encoding.
1990
1991=end table
1992
1993=item B<< C<Pm = 1021> >> (B<rxvt>)
1994
1995=begin table
1996
1997 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1998 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1999
2000=end table
2001
680=item B<< C<Ps = 1047> >> 2002=item B<< C<Pm = 1047> >>
681 2003
682=begin table 2004=begin table
683 2005
684 B<< C<h> >> Use Alternate Screen Buffer 2006 B<< C<h> >> Use Alternate Screen Buffer
685 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 2007 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
686 2008
687=end table 2009=end table
688 2010
689=item B<< C<Ps = 1048> >> 2011=item B<< C<Pm = 1048> >>
690 2012
691=begin table 2013=begin table
692 2014
693 B<< C<h> >> Save cursor position 2015 B<< C<h> >> Save cursor position
694 B<< C<l> >> Restore cursor position 2016 B<< C<l> >> Restore cursor position
695 2017
696=end table 2018=end table
697 2019
2020=item B<< C<Pm = 1049> >>
2021
2022=begin table
2023
2024 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
2025 B<< C<l> >> Use Normal Screen Buffer
2026
2027=end table
2028
2029=item B<< C<Pm = 2004> >>
2030
2031=begin table
2032
2033 B<< C<h> >> Enable bracketed paste mode - prepend / append to the pasted text the control sequences C<ESC [ 200 ~> / C<ESC [ 201 ~>
2034 B<< C<l> >> Disable bracketed paste mode
2035
2036=end table
2037
698=back 2038=back
699 2039
700=back 2040=back
701 2041
702X<XTerm> 2042X<XTerm>
703 2043
704=head1 XTerm Operating System Commands 2044=head2 XTerm Operating System Commands
705 2045
706=over 4 2046=over 4
707 2047
708=item B<< C<ESC ] Ps;Pt ST> >> 2048=item B<< C<ESC ] Ps;Pt ST> >>
709 2049
… …
716 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >> 2056 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>
717 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >> 2057 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
718 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> 2058 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
719 B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property. 2059 B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property.
720 B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white 2060 B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white
721 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 2061 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >>
722 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 2062 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >>
723 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 2063 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
724 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 2064 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
725 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 2065 B<< C<Ps = 17> >> Change background colour of highlight characters to B<< C<Pt> >>
726 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 2066 B<< C<Ps = 19> >> Change foreground colour of highlight characters to B<< C<Pt> >>
727 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 2067 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile afterimage or pixbuf).
728 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>
729 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option> 2068 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. [deprecated, use 10]
730 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 2069 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
731 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 2070 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. [deprecated, use 11]
732 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> >> 2071 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> >>
733 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 2072 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> [disabled]
734 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVTNAME@@ extension) 2073 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).
735 B<< C<Ps = 702> >> find font for character, used for debugging (@@RXVTNAME@@ extension) 2074 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>.
736 B<< C<Ps = 703> >> command B<< C<Pt> >> I<rxvt compile-time option> (@@RXVTNAME@@ extension) 2075 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
2076 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
2077 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
2078 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
2079 B<< C<Ps = 708> >> Change colour of the border to B<< C<Pt> >>
2080 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
2081 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2082 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2083 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2084 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2085 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2086 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
737 2087
738=end table 2088=end table
739 2089
740=back 2090=back
741 2091
742X<menuBar> 2092=head1 BACKGROUND IMAGE
743 2093
744=head1 menuBar 2094For the BACKGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> the value
745 2095of B<< C<Pt> >> can be one of the following commands:
746B<< The exact syntax used is I<almost> solidified. >>
747In the menus, B<DON'T> try to use menuBar commands that add or remove a
748menuBar.
749
750Note that in all of the commands, the B<< I</path/> >> I<cannot> be
751omitted: use B<./> to specify a menu relative to the current menu.
752
753=head2 Overview of menuBar operation
754
755For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
756of C<Pt> can be used for a variety of tasks:
757
758At the top level is the current menuBar which is a member of a circular
759linked-list of other such menuBars.
760
761The menuBar acts as a parent for the various drop-down menus, which in
762turn, may have labels, separator lines, menuItems and subMenus.
763
764The menuItems are the useful bits: you can use them to mimic keyboard
765input or even to send text or escape sequences back to rxvt.
766
767The menuBar syntax is intended to provide a simple yet robust method of
768constructing and manipulating menus and navigating through the
769menuBars.
770
771The first step is to use the tag B<< [menu:I<name>] >> which creates
772the menuBar called I<name> and allows access. You may now or menus,
773subMenus, and menuItems. Finally, use the tag B<[done]> to set the
774menuBar access as B<readonly> to prevent accidental corruption of the
775menus. To re-access the current menuBar for alterations, use the tag
776B<[menu]>, make the alterations and then use B<[done]>
777
778X<menuBarCommands>
779
780=head2 Commands
781 2096
782=over 4 2097=over 4
783 2098
784=item B<< [menu:+I<name>] >> 2099=item B<< C<?> >>
785 2100
786access the named menuBar for creation or alteration. If a new menuBar 2101display scale and position in the title
787is created, it is called I<name> (max of 15 chars) and the current
788menuBar is pushed onto the stack
789 2102
790=item B<[menu]> 2103=item B<< C<;WxH+X+Y> >>
791 2104
792access the current menuBar for alteration 2105change scale and/or position
793 2106
794=item B<< [title:+I<string>] >> 2107=item B<< C<FILE;WxH+X+Y> >>
795 2108
796set the current menuBar's title to I<string>, which may contain the 2109change background image
797following format specifiers:
798B<%%> : literal B<%> character
799B<%n> : rxvt name (as per the B<-name> command-line option)
800B<%v> : rxvt version
801
802=item B<[done]>
803
804set menuBar access as B<readonly>.
805End-of-file tag for B<< [read:+I<file>] >> operations.
806
807=item B<< [read:+I<file>] >>
808
809read menu commands directly from I<file> (extension ".menu" will be
810appended if required.) Start reading at a line with B<[menu]> or B<<
811[menu:+I<name> >> and continuing until B<[done]> is encountered.
812
813Blank and comment lines (starting with B<#>) are ignored. Actually,
814since any invalid menu commands are also ignored, almost anything could
815be construed as a comment line, but this may be tightened up in the
816future ... so don't count on it!.
817
818=item B<< [read:+I<file>;+I<name>] >>
819
820The same as B<< [read:+I<file>] >>, but start reading at a line with
821B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
822B<[done]> is encountered.
823
824=item B<[dump]>
825
826dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
827later rereading.
828
829=item B<[rm:name]>
830
831remove the named menuBar
832
833=item B<[rm] [rm:]>
834
835remove the current menuBar
836
837=item B<[rm*] [rm:*]>
838
839remove all menuBars
840
841=item B<[swap]>
842
843swap the top two menuBars
844
845=item B<[prev]>
846
847access the previous menuBar
848
849=item B<[next]>
850
851access the next menuBar
852
853=item B<[show]>
854
855Enable display of the menuBar
856
857=item B<[hide]>
858
859Disable display of the menuBar
860
861=item B<< [pixmap:+I<name>] >>
862
863=item B<< [pixmap:+I<name>;I<scaling>] >>
864
865(set the background pixmap globally
866
867B<< A Future implementation I<may> make this local to the menubar >>)
868
869=item B<< [:+I<command>:] >>
870
871ignore the menu readonly status and issue a I<command> to or a menu or
872menuitem or change the ; a useful shortcut for setting the quick arrows
873from a menuBar.
874 2110
875=back 2111=back
876 2112
877X<menuBarAdd>
878
879=head2 Adding and accessing menus
880
881The following commands may also be B<+> prefixed.
882
883=over 4
884
885=item B</+>
886
887access menuBar top level
888
889=item B<./+>
890
891access current menu level
892
893=item B<../+>
894
895access parent menu (1 level up)
896
897=item B<../../>
898
899access parent menu (multiple levels up)
900
901=item B<< I</path/>menu >>
902
903add/access menu
904
905=item B<< I</path/>menu/* >>
906
907add/access menu and clear it if it exists
908
909=item B<< I</path/>{-} >>
910
911add separator
912
913=item B<< I</path/>{item} >>
914
915add B<item> as a label
916
917=item B<< I</path/>{item} action >>
918
919add/alter I<menuitem> with an associated I<action>
920
921=item B<< I</path/>{item}{right-text} >>
922
923add/alter I<menuitem> with B<right-text> as the right-justified text
924and as the associated I<action>
925
926=item B<< I</path/>{item}{rtext} action >>
927
928add/alter I<menuitem> with an associated I<action> and with B<rtext> as
929the right-justified text.
930
931=back
932
933=over 4
934
935=item Special characters in I<action> must be backslash-escaped:
936
937B<\a \b \E \e \n \r \t \octal>
938
939=item or in control-character notation:
940
941B<^@, ^A .. ^Z .. ^_, ^?>
942
943=back
944
945To send a string starting with a B<NUL> (B<^@>) character to the
946program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
947the first of which will be stripped off and the balance directed to the
948program. Otherwise if I<action> begins with B<NUL> followed by
949non-+B<NUL> characters, the leading B<NUL> is stripped off and the
950balance is sent back to rxvt.
951
952As a convenience for the many Emacs-type editors, I<action> may start
953with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
954appended if missed from B<M-x> commands.
955
956As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or
957quick arrow), a B<BEL> (B<^G>) will be appended if needed.
958
959=over 4
960
961=item For example,
962
963B<M-xapropos> is equivalent to B<\Exapropos\r>
964
965=item and
966
967B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
968
969=back
970
971The option B<< {I<right-rtext>} >> will be right-justified. In the
972absence of a specified action, this text will be used as the I<action>
973as well.
974
975=over 4
976
977=item For example,
978
979B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
980
981=back
982
983The left label I<is> necessary, since it's used for matching, but
984implicitly hiding the left label (by using same name for both left and
985right labels), or explicitly hiding the left label (by preceeding it
986with a dot), makes it possible to have right-justified text only.
987
988=over 4
989
990=item For example,
991
992B</File/{Open}{Open} Open-File-Action>
993
994=item or hiding it
995
996B</File/{.anylabel}{Open} Open-File-Action>
997
998=back
999
1000X<menuBarRemove>
1001
1002=head2 Removing menus
1003
1004=over 4
1005
1006=item B<< -/*+ >>
1007
1008remove all menus from the menuBar, the same as B<[clear]>
1009
1010=item B<< -+I</path>menu+ >>
1011
1012remove menu
1013
1014=item B<< -+I</path>{item}+ >>
1015
1016remove item
1017
1018=item B<< -+I</path>{-} >>
1019
1020remove separator)
1021
1022=item B<-/path/menu/*>
1023
1024remove all items, separators and submenus from menu
1025
1026=back
1027
1028X<menuBarArrows>
1029
1030=head2 Quick Arrows
1031
1032The menus also provide a hook for I<quick arrows> to provide easier
1033user access. If nothing has been explicitly set, the default is to
1034emulate the curror keys. The syntax permits each arrow to be altered
1035individually or all four at once without re-entering their common
1036beginning/end text. For example, to explicitly associate cursor actions
1037with the arrows, any of the following forms could be used:
1038
1039=over 4
1040
1041=item B<< <r>+I<Right> >>
1042
1043=item B<< <l>+I<Left> >>
1044
1045=item B<< <u>+I<Up> >>
1046
1047=item B<< <d>+I<Down> >>
1048
1049Define actions for the respective arrow buttons
1050
1051=item B<< <b>+I<Begin> >>
1052
1053=item B<< <e>+I<End> >>
1054
1055Define common beginning/end parts for I<quick arrows> which used in
1056conjunction with the above <r> <l> <u> <d> constructs
1057
1058=back
1059
1060=over 4
1061
1062=item For example, define arrows individually,
1063
1064 <u>\E[A
1065
1066 <d>\E[B
1067
1068 <r>\E[C
1069
1070 <l>\E[D
1071
1072=item or all at once
1073
1074 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1075
1076=item or more compactly (factoring out common parts)
1077
1078 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1079
1080=back
1081
1082X<menuBarSummary>
1083
1084=head2 Command Summary
1085
1086A short summary of the most I<common> commands:
1087
1088=over 4
1089
1090=item [menu:name]
1091
1092use an existing named menuBar or start a new one
1093
1094=item [menu]
1095
1096use the current menuBar
1097
1098=item [title:string]
1099
1100set menuBar title
1101
1102=item [done]
1103
1104set menu access to readonly and, if reading from a file, signal EOF
1105
1106=item [done:name]
1107
1108if reading from a file using [read:file;name] signal EOF
1109
1110=item [rm:name]
1111
1112remove named menuBar(s)
1113
1114=item [rm] [rm:]
1115
1116remove current menuBar
1117
1118=item [rm*] [rm:*]
1119
1120remove all menuBar(s)
1121
1122=item [swap]
1123
1124swap top two menuBars
1125
1126=item [prev]
1127
1128access the previous menuBar
1129
1130=item [next]
1131
1132access the next menuBar
1133
1134=item [show]
1135
1136map menuBar
1137
1138=item [hide]
1139
1140unmap menuBar
1141
1142=item [pixmap;file]
1143
1144=item [pixmap;file;scaling]
1145
1146set a background pixmap
1147
1148=item [read:file]
1149
1150=item [read:file;name]
1151
1152read in a menu from a file
1153
1154=item [dump]
1155
1156dump out all menuBars to /tmp/rxvt-PID
1157
1158=item /
1159
1160access menuBar top level
1161
1162=item ./
1163
1164=item ../
1165
1166=item ../../
1167
1168access current or parent menu level
1169
1170=item /path/menu
1171
1172add/access menu
1173
1174=item /path/{-}
1175
1176add separator
1177
1178=item /path/{item}{rtext} action
1179
1180add/alter menu item
1181
1182=item -/*
1183
1184remove all menus from the menuBar
1185
1186=item -/path/menu
1187
1188remove menu items, separators and submenus from menu
1189
1190=item -/path/menu
1191
1192remove menu
1193
1194=item -/path/{item}
1195
1196remove item
1197
1198=item -/path/{-}
1199
1200remove separator
1201
1202=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1203
1204menu quick arrows
1205
1206=back
1207X<XPM>
1208
1209=head1 XPM
1210
1211For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1212of B<< C<Pt> >> can be the name of the background pixmap followed by a
1213sequence of scaling/positioning commands separated by semi-colons. The
1214scaling/positioning commands are as follows:
1215
1216=over 4
1217
1218=item query scale/position
1219
1220B<?>
1221
1222=item change scale and position
1223
1224B<WxH+X+Y>
1225
1226B<WxH+X> (== B<WxH+X+X>)
1227
1228B<WxH> (same as B<WxH+50+50>)
1229
1230B<W+X+Y> (same as B<WxW+X+Y>)
1231
1232B<W+X> (same as B<WxW+X+X>)
1233
1234B<W> (same as B<WxW+50+50>)
1235
1236=item change position (absolute)
1237
1238B<=+X+Y>
1239
1240B<=+X> (same as B<=+X+Y>)
1241
1242=item change position (relative)
1243
1244B<+X+Y>
1245
1246B<+X> (same as B<+X+Y>)
1247
1248=item rescale (relative)
1249
1250B<Wx0> -> B<W *= (W/100)>
1251
1252B<0xH> -> B<H *= (H/100)>
1253
1254=back
1255
1256For example:
1257
1258=over 4
1259
1260=item B<\E]20;funky\a>
1261
1262load B<funky.xpm> as a tiled image
1263
1264=item B<\E]20;mona;100\a>
1265
1266load B<mona.xpm> with a scaling of 100%
1267
1268=item B<\E]20;;200;?\a>
1269
1270rescale the current pixmap to 200% and display the image geometry in
1271the title
1272
1273=back
1274X<Mouse> 2113X<Mouse>
1275 2114
1276=head1 Mouse Reporting 2115=head1 Mouse Reporting
1277 2116
1278=over 4 2117=over 4
… …
1310=begin table 2149=begin table
1311 2150
1312 4 Shift 2151 4 Shift
1313 8 Meta 2152 8 Meta
1314 16 Control 2153 16 Control
1315 32 Double Click I<(Rxvt extension)> 2154 32 Double Click I<(rxvt extension)>
1316 2155
1317=end table 2156=end table
1318 2157
1319Col = B<< C<< <x> - SPACE >> >> 2158Col = B<< C<< <x> - SPACE >> >>
1320 2159
1321Row = B<< C<< <y> - SPACE >> >> 2160Row = B<< C<< <y> - SPACE >> >>
1322 2161
1323=back 2162=back
2163
2164=head1 Key Codes
2165
1324X<KeyCodes> 2166X<KeyCodes>
1325
1326=head1 ISO 14755 support
1327
1328Partial ISO 14755-support is implemented. that means that pressing
1329
1330section 5.1: Control and Shift together enters unicode input
1331mode. Entering hex digits composes a Unicode character, pressing space or
1332releasing the modifiers commits the keycode and every other key cancels
1333the current input character.
1334
1335section 5.2: Pressing and immediately releasing Control and Shift together
1336enters keycap entry mode for the next key: pressing a function key (tab,
1337return etc..) will enter the unicode character corresponding to the given
1338key.
1339
1340=head1 Key Codes
1341 2167
1342Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 2168Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
1343 2169
1344For the keypad, use B<Shift> to temporarily override Application-Keypad 2170For the keypad, use B<Shift> to temporarily override Application-Keypad
1345setting use B<Num_Lock> to toggle Application-Keypad setting if 2171setting use B<Num_Lock> to toggle Application-Keypad setting if
1346B<Num_Lock> is off, toggle Application-Keypad setting. Also note that 2172B<Num_Lock> is off, toggle Application-Keypad setting. Also note that
1347values of B<Home>, B<End>, B<Delete> may have been compiled differently on 2173values of B<BackSpace>, B<Delete> may have been compiled differently on
1348your system. 2174your system.
1349 2175
1350=begin table 2176=begin table
1351 2177
1352 B<Normal> B<Shift> B<Control> B<Ctrl+Shift> 2178 B<Normal> B<Shift> B<Control> B<Ctrl+Shift>
… …
1408 XK_KP_8 8 ESC O x 2234 XK_KP_8 8 ESC O x
1409 XK_KP_9 9 ESC O y 2235 XK_KP_9 9 ESC O y
1410 2236
1411=end table 2237=end table
1412 2238
2239=head1 CONFIGURE OPTIONS
2240
2241General hint: if you get compile errors, then likely your configuration
2242hasn't been tested well. Either try with C<--enable-everything> or use
2243the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2244switches). Of course, you should always report when a combination doesn't
2245work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2246
2247All
2248
2249=over 4
2250
2251=item --enable-everything
2252
2253Add (or remove) support for all non-multichoice options listed
2254in C<./configure --help>, except for C<--enable-assert> and
2255C<--enable-256-color>.
2256
2257You can specify this and then disable options you do not like by
2258I<following> this with the appropriate C<--disable-...> arguments,
2259or you can start with a minimal configuration by specifying
2260C<--disable-everything> and than adding just the C<--enable-...> arguments
2261you want.
2262
2263=item --enable-xft (default: enabled)
2264
2265Add support for Xft (anti-aliased, among others) fonts. Xft fonts are
2266slower and require lots of memory, but as long as you don't use them, you
2267don't pay for them.
2268
2269=item --enable-font-styles (default: on)
2270
2271Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2272styles. The fonts can be set manually or automatically.
2273
2274=item --with-codesets=NAME,... (default: all)
2275
2276Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2277are always compiled in, which includes most 8-bit character sets). These
2278codeset tables are used for driving X11 core fonts, they are not required
2279for Xft fonts, although having them compiled in lets rxvt-unicode choose
2280replacement fonts more intelligently. Compiling them in will make your
2281binary bigger (all of together cost about 700kB), but it doesn't increase
2282memory usage unless you use a font requiring one of these encodings.
2283
2284=begin table
2285
2286 all all available codeset groups
2287 zh common chinese encodings
2288 zh_ext rarely used but very big chinese encodings
2289 jp common japanese encodings
2290 jp_ext rarely used but big japanese encodings
2291 kr korean encodings
2292
2293=end table
2294
2295=item --enable-xim (default: on)
2296
2297Add support for XIM (X Input Method) protocol. This allows using
2298alternative input methods (e.g. kinput2) and will also correctly
2299set up the input for people using dead keys or compose keys.
2300
2301=item --enable-unicode3 (default: off)
2302
2303Recommended to stay off unless you really need non-BMP characters.
2304
2305Enable direct support for displaying unicode codepoints above
230665535 (the basic multilingual page). This increases storage
2307requirements per character from 2 to 4 bytes. X11 fonts do not yet
2308support these extra characters, but Xft does.
2309
2310Please note that rxvt-unicode can store unicode code points >65535
2311even without this flag, but the number of such characters is
2312limited to a few thousand (shared with combining characters,
2313see next switch), and right now rxvt-unicode cannot display them
2314(input/output and cut&paste still work, though).
2315
2316=item --enable-combining (default: on)
2317
2318Enable automatic composition of combining characters into
2319composite characters. This is required for proper viewing of text
2320where accents are encoded as separate unicode characters. This is
2321done by using precomposited characters when available or creating
2322new pseudo-characters when no precomposed form exists.
2323
2324Without --enable-unicode3, the number of additional precomposed
2325characters is somewhat limited (the 6400 private use characters will be
2326(ab-)used). With --enable-unicode3, no practical limit exists.
2327
2328This option will also enable storage (but not display) of characters
2329beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2330
2331The combining table also contains entries for arabic presentation forms,
2332but these are not currently used. Bug me if you want these to be used (and
2333tell me how these are to be used...).
2334
2335=item --enable-fallback(=CLASS) (default: Rxvt)
2336
2337When reading resource settings, also read settings for class CLASS. To
2338disable resource fallback use --disable-fallback.
2339
2340=item --with-res-name=NAME (default: urxvt)
2341
2342Use the given name as default application name when
2343reading resources. Specify --with-res-name=rxvt to replace rxvt.
2344
2345=item --with-res-class=CLASS (default: URxvt)
2346
2347Use the given class as default application class
2348when reading resources. Specify --with-res-class=Rxvt to replace
2349rxvt.
2350
2351=item --enable-utmp (default: on)
2352
2353Write user and tty to utmp file (used by programs like F<w>) at
2354start of rxvt execution and delete information when rxvt exits.
2355
2356=item --enable-wtmp (default: on)
2357
2358Write user and tty to wtmp file (used by programs like F<last>) at
2359start of rxvt execution and write logout when rxvt exits. This
2360option requires --enable-utmp to also be specified.
2361
2362=item --enable-lastlog (default: on)
2363
2364Write user and tty to lastlog file (used by programs like
2365F<lastlogin>) at start of rxvt execution. This option requires
2366--enable-utmp to also be specified.
2367
2368=item --enable-afterimage (default: on)
2369
2370Add support for libAfterImage to be used for background
2371images. It adds support for many file formats including JPG, PNG,
2372SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2373(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2374
2375Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2376increase by a few megabytes even if no extra features are used (mostly due
2377to third-party libraries used by libAI). Memory footprint may somewhat be
2378lowered if libAfterImage is configured without support for SVG.
2379
2380=item --enable-pixbuf (default: off)
2381
2382Add support for GDK-PixBuf to be used for background images.
2383It adds support for many file formats including JPG, PNG,
2384TIFF, GIF, XPM, BMP, ICO and TGA.
2385
2386=item --enable-transparency (default: on)
2387
2388Add support for using the root pixmap as background to simulate transparency.
2389Note that blur and blend effects depend on libAfterImage or on
2390libXrender and on the availability of the RENDER extension in the X
2391server.
2392
2393=item --enable-fading (default: on)
2394
2395Add support for fading the text when focus is lost.
2396
2397=item --enable-rxvt-scroll (default: on)
2398
2399Add support for the original rxvt scrollbar.
2400
2401=item --enable-next-scroll (default: on)
2402
2403Add support for a NeXT-like scrollbar.
2404
2405=item --enable-xterm-scroll (default: on)
2406
2407Add support for an Xterm-like scrollbar.
2408
2409=item --disable-backspace-key
2410
2411Removes any handling of the backspace key by us - let the X server do it.
2412
2413=item --disable-delete-key
2414
2415Removes any handling of the delete key by us - let the X server
2416do it.
2417
2418=item --disable-resources
2419
2420Removes any support for resource checking.
2421
2422=item --disable-swapscreen
2423
2424Remove support for secondary/swap screen.
2425
2426=item --enable-frills (default: on)
2427
2428Add support for many small features that are not essential but nice to
2429have. Normally you want this, but for very small binaries you may want to
2430disable this.
2431
2432A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2433in combination with other switches) is:
2434
2435 MWM-hints
2436 EWMH-hints (pid, utf8 names) and protocols (ping)
2437 urgency hint
2438 separate underline colour (-underlineColor)
2439 settable border widths and borderless switch (-w, -b, -bl)
2440 visual depth selection (-depth)
2441 settable extra linespacing (-lsp)
2442 iso-14755 5.1 (basic) support
2443 tripleclickwords (-tcw)
2444 settable insecure mode (-insecure)
2445 keysym remapping support
2446 cursor blinking and underline cursor (-bc, -uc)
2447 XEmbed support (-embed)
2448 user-pty (-pty-fd)
2449 hold on exit (-hold)
2450 compile in built-in block graphics
2451 skip builtin block graphics (-sbg)
2452 separate highlight colour (-highlightColor, -highlightTextColor)
2453 extended mouse reporting modes (1005 and 1015).
2454
2455It also enables some non-essential features otherwise disabled, such as:
2456
2457 some round-trip time optimisations
2458 nearest colour allocation on pseudocolor screens
2459 UTF8_STRING support for selection
2460 sgr modes 90..97 and 100..107
2461 backindex and forwardindex escape sequences
2462 view change/zero scrollback escape sequences
2463 locale switching escape sequence
2464 window op and some xterm/OSC escape sequences
2465 rectangular selections
2466 trailing space removal for selections
2467 verbose X error handling
2468
2469=item --enable-iso14755 (default: on)
2470
2471Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)).
2472Basic support (section 5.1) is enabled by C<--enable-frills>, while
2473support for 5.2, 5.3 and 5.4 is enabled with this switch.
2474
2475=item --enable-keepscrolling (default: on)
2476
2477Add support for continual scrolling of the display when you hold
2478the mouse button down on a scrollbar arrow.
2479
2480=item --enable-selectionscrolling (default: on)
2481
2482Add support for scrolling when the selection moves to the top or
2483bottom of the screen.
2484
2485=item --enable-mousewheel (default: on)
2486
2487Add support for scrolling via mouse wheel or buttons 4 & 5.
2488
2489=item --enable-slipwheeling (default: on)
2490
2491Add support for continual scrolling (using the mouse wheel as an
2492accelerator) while the control key is held down. This option
2493requires --enable-mousewheel to also be specified.
2494
2495=item --enable-smart-resize (default: off)
2496
2497Add smart growth/shrink behaviour when resizing.
2498This should keep the window corner which is closest to a corner of
2499the screen in a fixed position.
2500
2501=item --enable-text-blink (default: on)
2502
2503Add support for blinking text.
2504
2505=item --enable-pointer-blank (default: on)
2506
2507Add support to have the pointer disappear when typing or inactive.
2508
2509=item --enable-perl (default: on)
2510
2511Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2512manpage for more info on this feature, or the files in F<src/perl/>
2513for the extensions that are installed by default.
2514The perl interpreter that is used can be specified via the C<PERL>
2515environment variable when running configure. Even when compiled in,
2516perl will I<not> be initialised when all extensions have been disabled
2517C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2518resource standpoint.
2519
2520=item --enable-assert (default: off)
2521
2522Enables the assertions in the code, normally disabled. This switch is only
2523useful when developing rxvt-unicode.
2524
2525=item --enable-256-color (default: off)
2526
2527Force use of so-called 256 colour mode, to work around buggy applications
2528that do not support termcap/terminfo, or simply improve support for
2529applications hardcoding the xterm 256 colour table.
2530
2531This switch breaks termcap/terminfo compatibility to C<TERM=rxvt-unicode>,
2532and consequently sets C<TERM> to C<rxvt-unicode-256color> by default
2533(F<doc/etc/> contains termcap/terminfo definitions for both).
2534
2535It also results in higher memory usage and can slow down @@RXVT_NAME@@
2536dramatically when more than six fonts are in use by a terminal instance.
2537
2538=item --with-afterimage-config=DIR
2539
2540Look for the libAfterImage config script in DIR.
2541
2542=item --with-name=NAME (default: urxvt)
2543
2544Set the basename for the installed binaries, resulting
2545in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2546C<rxvt>.
2547
2548=item --with-term=NAME (default: rxvt-unicode)
2549
2550Change the environmental variable for the terminal to NAME.
2551
2552=item --with-terminfo=PATH
2553
2554Change the environmental variable for the path to the terminfo tree to
2555PATH.
2556
2557=item --with-x
2558
2559Use the X Window System (pretty much default, eh?).
2560
2561=back
2562
2563=head1 AUTHORS
2564
2565Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
2566reworked it from the original Rxvt documentation, which was done by Geoff
2567Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other
2568sources.
2569

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines