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.229 by root, Wed Feb 5 01:39:38 2014 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 printf "\eZ"
135 read term_id
136 stty icanon echo
137 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
138 printf '\e[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 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<preeditType> 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<preeditType> 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 $ printf "\e[?67h"
605
606 # use Backspace = ^?
607 $ stty erase ^?
608 $ printf "\e[?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.Prior: \033[5~
636 URxvt.keysym.Next: \033[6~
637 URxvt.keysym.Home: \033[7~
638 URxvt.keysym.End: \033[8~
639 URxvt.keysym.Up: \033[A
640 URxvt.keysym.Down: \033[B
641 URxvt.keysym.Right: \033[C
642 URxvt.keysym.Left: \033[D
643
644See some more examples in the documentation for the B<keysym> resource.
645
646=head3 I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map
647
648 KP_Insert == Insert
649 F22 == Print
650 F27 == Home
651 F29 == Prior
652 F33 == End
653 F35 == Next
654
655Rather than have rxvt-unicode try to accommodate all the various possible
656keyboard mappings, it is better to use `xmodmap' to remap the keys as
657required for your particular machine.
658
659
660=head2 Terminal Configuration
661
662=head3 Can I see a typical configuration?
663
664The default configuration tries to be xterm-like, which I don't like that
665much, but it's least surprise to regular users.
666
667As a rxvt or rxvt-unicode user, you are practically supposed to invest
668time into customising your terminal. To get you started, here is the
669author's .Xdefaults entries, with comments on what they do. It's certainly
670not I<typical>, but what's typical...
671
672 URxvt.cutchars: "()*,<>[]{}|'
673 URxvt.print-pipe: cat >/tmp/xxx
674
675These are just for testing stuff.
676
677 URxvt.imLocale: ja_JP.UTF-8
678 URxvt.preeditType: OnTheSpot,None
679
680This tells rxvt-unicode to use a special locale when communicating with
681the X Input Method, and also tells it to only use the OnTheSpot pre-edit
682type, which requires the C<xim-onthespot> perl extension but rewards me
683with correct-looking fonts.
684
685 URxvt.perl-lib: /root/lib/urxvt
686 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
687 URxvt.selection.pattern-0: ( at .*? line \\d+)
688 URxvt.selection.pattern-1: ^(/[^:]+):\
689 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
690 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
691
692This is my perl configuration. The first two set the perl library
693directory and also tells urxvt to use a large number of extensions. I
694develop for myself mostly, so I actually use most of the extensions I
695write.
696
697The selection stuff mainly makes the selection perl-error-message aware
698and tells it to convert perl error messages into vi-commands to load the
699relevant file and go to the error line number.
700
701 URxvt.scrollstyle: plain
702 URxvt.secondaryScroll: true
703
704As the documentation says: plain is the preferred scrollbar for the
705author. The C<secondaryScroll> configures urxvt to scroll in full-screen
706apps, like screen, so lines scrolled out of screen end up in urxvt's
707scrollback buffer.
708
709 URxvt.background: #000000
710 URxvt.foreground: gray90
711 URxvt.color7: gray90
712 URxvt.colorBD: #ffffff
713 URxvt.cursorColor: #e0e080
714 URxvt.throughColor: #8080f0
715 URxvt.highlightColor: #f0f0f0
716
717Some colours. Not sure which ones are being used or even non-defaults, but
718these are in my .Xdefaults. Most notably, they set foreground/background
719to light gray/black, and also make sure that the colour 7 matches the
720default foreground colour.
721
722 URxvt.underlineColor: yellow
723
724Another colour, makes underline lines look different. Sometimes hurts, but
725is mostly a nice effect.
726
727 URxvt.geometry: 154x36
728 URxvt.loginShell: false
729 URxvt.meta: ignore
730 URxvt.utmpInhibit: true
731
732Uh, well, should be mostly self-explanatory. By specifying some defaults
733manually, I can quickly switch them for testing.
734
735 URxvt.saveLines: 8192
736
737A large scrollback buffer is essential. Really.
738
739 URxvt.mapAlert: true
740
741The only case I use it is for my IRC window, which I like to keep
742iconified till people msg me (which beeps).
743
744 URxvt.visualBell: true
745
746The audible bell is often annoying, especially when in a crowd.
747
748 URxvt.insecure: true
749
750Please don't hack my mutt! Ooops...
751
752 URxvt.pastableTabs: false
753
754I once thought this is a great idea.
755
756 urxvt.font: 9x15bold,\
757 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
758 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
759 [codeset=JISX0208]xft:Kochi Gothic, \
760 xft:Bitstream Vera Sans Mono:autohint=true, \
761 xft:Code2000:antialias=false
762 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
763 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
764 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
765
766I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
767overwhelmed. A special note: the C<9x15bold> mentioned above is actually
768the version from XFree-3.3, as XFree-4 replaced it by a totally different
769font (different glyphs for C<;> and many other harmless characters),
770while the second font is actually the C<9x15bold> from XFree4/XOrg. The
771bold version has less chars than the medium version, so I use it for rare
772characters, too. When editing sources with vim, I use italic for comments
773and other stuff, which looks quite good with Bitstream Vera anti-aliased.
774
775Terminus is a quite bad font (many very wrong glyphs), but for most of my
776purposes, it works, and gives a different look, as my normal (Non-bold)
777font is already bold, and I want to see a difference between bold and
778normal fonts.
779
780Please note that I used the C<urxvt> instance name and not the C<URxvt>
781class name. That is because I use different configs for different purposes,
782for example, my IRC window is started with C<-name IRC>, and uses these
783defaults:
784
785 IRC*title: IRC
786 IRC*geometry: 87x12+535+542
787 IRC*saveLines: 0
788 IRC*mapAlert: true
789 IRC*font: suxuseuro
790 IRC*boldFont: suxuseuro
791 IRC*colorBD: white
792 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
793 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
794
795C<Alt-Ctrl-1> and C<Alt-Ctrl-2> switch between two different font
796sizes. C<suxuseuro> allows me to keep an eye (and actually read)
797stuff while keeping a very small window. If somebody pastes something
798complicated (e.g. japanese), I temporarily switch to a larger font.
799
800The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
801C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
802file for different hosts, for example, on my main desktop, I use:
803
804 URxvt.keysym.C-M-q: command:\033[3;5;5t
805 URxvt.keysym.C-M-y: command:\033[3;5;606t
806 URxvt.keysym.C-M-e: command:\033[3;1605;5t
807 URxvt.keysym.C-M-c: command:\033[3;1605;606t
808 URxvt.keysym.C-M-p: perl:test
809
810The first for keysym definitions allow me to quickly bring some windows
811in the layout I like most. Ion users might start laughing but will stop
812immediately when I tell them that I use my own Fvwm2 module for much the
813same effect as Ion provides, and I only very rarely use the above key
814combinations :->
815
816=head3 Why doesn't rxvt-unicode read my resources?
817
818Well, why, indeed? It does, in a way very similar to other X
819applications. Most importantly, this means that if you or your OS loads
820resources into the X display (the right way to do it), rxvt-unicode will
821ignore any resource files in your home directory. It will only read
822F<$HOME/.Xdefaults> when no resources are attached to the display.
823
824If you have or use an F<$HOME/.Xresources> file, chances are that
825resources are loaded into your X-server. In this case, you have to
826re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
827
828Also consider the form resources have to use:
829
830 URxvt.resource: value
831
832If you want to use another form (there are lots of different ways of
833specifying resources), make sure you understand whether and why it
834works. If unsure, use the form above.
835
836=head3 When I log-in to another system it tells me about missing terminfo data?
837
838The terminal description used by rxvt-unicode is not as widely available
839as that for xterm, or even rxvt (for which the same problem often arises).
840
841The correct solution for this problem is to install the terminfo, this can
842be done by simply installing rxvt-unicode on the remote system as well
843(in case you have a nice package manager ready), or you can install the
844terminfo database manually like this (with ncurses infocmp. works as
845user and root):
846
847 REMOTE=remotesystem.domain
848 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
849
850One some systems you might need to set C<$TERMINFO> to the full path of
851F<$HOME/.terminfo> for this to work. Debian systems have a broken tic
852which will not be able to overwrite the existing rxvt-unicode terminfo
853entry - you might have to manually delete all traces of F<rxvt-unicode*>
854from F</etc/terminfo>.
855
856If you cannot or do not want to do this, then you can simply set
857C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
858problems arising, which includes wrong keymapping, less and different
859colours and some refresh errors in fullscreen applications. It's a nice
860quick-and-dirty workaround for rare cases, though.
861
862If you always want to do this (and are fine with the consequences) you
863can either recompile rxvt-unicode with the desired TERM value or use a
864resource to set it:
865
866 URxvt.termName: rxvt
867
868If you don't plan to use B<rxvt> (quite common...) you could also replace
869the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
870
871=head3 nano fails with "Error opening terminal: rxvt-unicode"
872
873This exceptionally confusing and useless error message is printed by nano
874when it can't find the terminfo database. Nothing is wrong with your
875terminal, read the previous answer for a solution.
876
877=head3 C<tic> outputs some error when compiling the terminfo entry.
878
879Most likely it's the empty definition for C<enacs=>. Just replace it by
880C<enacs=\E[0@> and try again.
881
882=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
883
884See next entry.
885
886=head3 I need a termcap file entry.
887
888One reason you might want this is that some distributions or operating
889systems still compile some programs using the long-obsoleted termcap
890library (Fedora Core's bash is one example) and rely on a termcap entry
891for C<rxvt-unicode>.
892
893You could use rxvt's termcap entry with reasonable results in many cases.
894You can also create a termcap entry by using terminfo's infocmp program
895like this:
896
897 infocmp -C rxvt-unicode
898
899Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap,
900generated by the command above.
901
902=head3 Why does C<ls> no longer have coloured output?
903
904The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
905decide whether a terminal has colour, but uses its own configuration
906file. Needless to say, C<rxvt-unicode> is not in its default file (among
907with most other terminals supporting colour). Either add:
908
909 TERM rxvt-unicode
910
911to C</etc/DIR_COLORS> or simply add:
912
913 alias ls='ls --color=auto'
914
915to your C<.profile> or C<.bashrc>.
916
917=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
918
919See next entry.
920
921=head3 Why doesn't vim/emacs etc. make use of italic?
922
923See next entry.
924
925=head3 Why are the secondary screen-related options not working properly?
926
927Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
928distributions (most notably Debian GNU/Linux) break rxvt-unicode
929by setting C<TERM> to C<rxvt>, which doesn't have these extra
930features. Unfortunately, some of these (most notably, again, Debian
931GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
932file, so you will need to install it on your own (See the question B<When
933I log-in to another system it tells me about missing terminfo data?> on
934how to do this).
935
936
937=head2 Encoding / Locale / Input Method Issues
938
939=head3 Rxvt-unicode does not seem to understand the selected encoding?
940
941See next entry.
942
943=head3 Unicode does not seem to work?
944
945If you encounter strange problems like typing an accented character but
946getting two unrelated other characters or similar, or if program output is
947subtly garbled, then you should check your locale settings.
948
949Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
950programs running in it. Often rxvt-unicode is started in the C<C> locale,
951while the login script running within the rxvt-unicode window changes the
952locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
953not going to work, and is the most common cause for problems.
954
955The best thing is to fix your startup environment, as you will likely run
956into other problems. If nothing works you can try this in your .profile.
957
958 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
959
960If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
961supported on your systems. Some systems have a C<locale> command which
962displays this (also, C<perl -e0> can be used to check locale settings, as
963it will complain loudly if it cannot set the locale). If it displays something
964like:
965
966 locale: Cannot set LC_CTYPE to default locale: ...
967
968Then the locale you specified is not supported on your system.
969
970If nothing works and you are sure that everything is set correctly then
971you will need to remember a little known fact: Some programs just don't
972support locales :(
973
974=head3 How does rxvt-unicode determine the encoding to use?
975
976See next entry.
977
978=head3 Is there an option to switch encodings?
979
980Unlike some other terminals, rxvt-unicode has no encoding switch, and no
981specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
982UTF-8 or any other encodings with respect to terminal I/O.
983
984The reasons is that there exists a perfectly fine mechanism for selecting
985the encoding, doing I/O and (most important) communicating this to all
986applications so everybody agrees on character properties such as width
987and code number. This mechanism is the I<locale>. Applications not using
988that info will have problems (for example, C<xterm> gets the width of
989characters wrong as it uses its own, locale-independent table under all
990locales).
991
992Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
993programs doing the same (that is, most) will automatically agree in the
994interpretation of characters.
995
996Unfortunately, there is no system-independent way to select locales, nor
997is there a standard on how locale specifiers will look like.
998
999On most systems, the content of the C<LC_CTYPE> environment variable
1000contains an arbitrary string which corresponds to an already-installed
1001locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1002C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1003(i.e. C<de> or C<german>) are also common.
1004
1005Rxvt-unicode ignores all other locale categories, and except for
1006the encoding, ignores country or language-specific settings,
1007i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
1008rxvt-unicode.
1009
1010If you want to use a specific encoding you have to make sure you start
1011rxvt-unicode with the correct C<LC_CTYPE> category.
1012
1013=head3 Can I switch locales at runtime?
1014
1015Yes, using an escape sequence. Try something like this, which sets
1016rxvt-unicode's idea of C<LC_CTYPE>.
1017
1018 printf '\33]701;%s\007' ja_JP.SJIS
1019
1020See also the previous answer.
1021
1022Sometimes this capability is rather handy when you want to work in
1023one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
1024(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
1025first switches to a locale supported by xjdic and back later:
1026
1027 printf '\33]701;%s\007' ja_JP.SJIS
1028 xjdic -js
1029 printf '\33]701;%s\007' de_DE.UTF-8
1030
1031You can also use xterm's C<luit> program, which usually works fine, except
1032for some locales where character width differs between program- and
1033rxvt-unicode-locales.
1034
1035=head3 I have problems getting my input method working.
1036
1037Try a search engine, as this is slightly different for every input method server.
1038
1039Here is a checklist:
8 1040
9=over 4 1041=over 4
10 1042
1043=item - Make sure your locale I<and> the imLocale are supported on your OS.
1044
1045Try C<locale -a> or check the documentation for your OS.
1046
1047=item - Make sure your locale or imLocale matches a locale supported by your XIM.
1048
1049For example, B<kinput2> does not support UTF-8 locales, you should use
1050C<ja_JP.EUC-JP> or equivalent.
1051
1052=item - Make sure your XIM server is actually running.
1053
1054=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1055
1056When you want to use e.g. B<kinput2>, it must be set to
1057C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1058method servers are running with this command:
1059
1060 xprop -root XIM_SERVERS
1061
1062=back
1063
1064=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
1065
1066You can specify separate locales for the input method and the rest of the
1067terminal, using the resource C<imlocale>:
1068
1069 URxvt.imlocale: ja_JP.EUC-JP
1070
1071Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
1072use your input method. Please note, however, that, depending on your Xlib
1073version, you may not be able to input characters outside C<EUC-JP> in a
1074normal way then, as your input method limits you.
1075
1076=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
1077
1078Unfortunately, this is unavoidable, as the XIM protocol is racy by
1079design. Applications can avoid some crashes at the expense of memory
1080leaks, and Input Methods can avoid some crashes by careful ordering at
1081exit time. B<kinput2> (and derived input methods) generally succeeds,
1082while B<SCIM> (or similar input methods) fails. In the end, however,
1083crashes cannot be completely avoided even if both sides cooperate.
1084
1085So the only workaround is not to kill your Input Method Servers.
1086
1087
1088=head2 Operating Systems / Package Maintaining
1089
1090=head3 I am using Debian GNU/Linux and have a problem...
1091
1092The Debian GNU/Linux package of rxvt-unicode in sarge contains large
1093patches that considerably change the behaviour of rxvt-unicode (but
1094unfortunately this notice has been removed). Before reporting a bug to
1095the original rxvt-unicode author please download and install the genuine
1096version (L<http://software.schmorp.de/pkg/rxvt-unicode.html>) and try to
1097reproduce the problem. If you cannot, chances are that the problems are
1098specific to Debian GNU/Linux, in which case it should be reported via the
1099Debian Bug Tracking System (use C<reportbug> to report the bug).
1100
1101For other problems that also affect the Debian package, you can and
1102probably should use the Debian BTS, too, because, after all, it's also a
1103bug in the Debian version and it serves as a reminder for other users that
1104might encounter the same issue.
1105
1106=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
1107
1108You should build one binary with the default options. F<configure>
1109now enables most useful options, and the trend goes to making them
1110runtime-switchable, too, so there is usually no drawback to enabling them,
1111except higher disk and possibly memory usage. The perl interpreter should
1112be enabled, as important functionality (menus, selection, likely more in
1113the future) depends on it.
1114
1115You should not overwrite the C<perl-ext-common> and C<perl-ext> resources
1116system-wide (except maybe with C<defaults>). This will result in useful
1117behaviour. If your distribution aims at low memory, add an empty
1118C<perl-ext-common> resource to the app-defaults file. This will keep the
1119perl interpreter disabled until the user enables it.
1120
1121If you can/want build more binaries, I recommend building a minimal
1122one with C<--disable-everything> (very useful) and a maximal one with
1123C<--enable-everything> (less useful, it will be very big due to a lot of
1124encodings built-in that increase download times and are rarely used).
1125
1126=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
1127
1128It should be, starting with release 7.1. You are encouraged to properly
1129install urxvt with privileges necessary for your OS now.
1130
1131When rxvt-unicode detects that it runs setuid or setgid, it will fork
1132into a helper process for privileged operations (pty handling on some
1133systems, utmp/wtmp/lastlog handling on others) and drop privileges
1134immediately. This is much safer than most other terminals that keep
1135privileges while running (but is more relevant to urxvt, as it contains
1136things as perl interpreters, which might be "helpful" to attackers).
1137
1138This forking is done as the very first within main(), which is very early
1139and reduces possible bugs to initialisation code run before main(), or
1140things like the dynamic loader of your system, which should result in very
1141little risk.
1142
1143=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
1144
1145Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1146in your compile environment, or an implementation that implements it,
1147whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
1148B<wchar_t> is represented as unicode.
1149
1150As you might have guessed, FreeBSD does neither define this symbol nor
1151does it support it. Instead, it uses its own internal representation of
1152B<wchar_t>. This is, of course, completely fine with respect to standards.
1153
1154However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
1155C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>).
1156
1157C<__STDC_ISO_10646__> is the only sane way to support multi-language
1158apps in an OS, as using a locale-dependent (and non-standardized)
1159representation of B<wchar_t> makes it impossible to convert between
1160B<wchar_t> (as used by X11 and your applications) and any other encoding
1161without implementing OS-specific-wrappers for each and every locale. There
1162simply are no APIs to convert B<wchar_t> into anything except the current
1163locale encoding.
1164
1165Some applications (such as the formidable B<mlterm>) work around this
1166by carrying their own replacement functions for character set handling
1167with them, and either implementing OS-dependent hacks or doing multiple
1168conversions (which is slow and unreliable in case the OS implements
1169encodings slightly different than the terminal emulator).
1170
1171The rxvt-unicode author insists that the right way to fix this is in the
1172system libraries once and for all, instead of forcing every app to carry
1173complete replacements for them :)
1174
1175=head3 How can I use rxvt-unicode under cygwin?
1176
1177rxvt-unicode should compile and run out of the box on cygwin, using
1178the X11 libraries that come with cygwin. libW11 emulation is no
1179longer supported (and makes no sense, either, as it only supported a
1180single font). I recommend starting the X-server in C<-multiwindow> or
1181C<-rootless> mode instead, which will result in similar look&feel as the
1182old libW11 emulation.
1183
1184At the time of this writing, cygwin didn't seem to support any multi-byte
1185encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1186to 8-bit encodings.
1187
1188=head3 Character widths are not correct.
1189
1190urxvt uses the system wcwidth function to know the information about
1191the width of characters, so on systems with incorrect locale data you
1192will likely get bad results. Two notorious examples are Solaris 9,
1193where single-width characters like U+2514 are reported as double-width,
1194and Darwin 8, where combining chars are reported having width 1.
1195
1196The solution is to upgrade your system or switch to a better one. A
1197possibly working workaround is to use a wcwidth implementation like
1198
1199http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1200
1201=head1 RXVT-UNICODE TECHNICAL REFERENCE
1202
1203The rest of this document describes various technical aspects of
1204B<rxvt-unicode>. First the description of supported command sequences,
1205followed by pixmap support and last by a description of all features
1206selectable at C<configure> time.
1207
1208=head2 Definitions
1209
1210=over 4
1211
11=item B<< C<c> >> 1212=item B<< C<c> >>
12 1213
13The literal character c. 1214The literal character c (potentially a multi-byte character).
14 1215
15=item B<< C<C> >> 1216=item B<< C<C> >>
16 1217
17A single (required) character. 1218A single (required) character.
18 1219
… …
30 1231
31A text parameter composed of printable characters. 1232A text parameter composed of printable characters.
32 1233
33=back 1234=back
34 1235
35=head1 Values 1236=head2 Values
36 1237
37=over 4 1238=over 4
38 1239
39=item B<< C<ENQ> >> 1240=item B<< C<ENQ> >>
40 1241
41Enquiry (Ctrl-E) = Send Device Attributes (DA) 1242Enquiry (Ctrl-E) = Send Device Attributes (DA)
42request attributes from terminal == 1243request attributes from terminal. See B<< C<ESC [ Ps c> >>.
43 1244
44=item B<< C<BEL> >> 1245=item B<< C<BEL> >>
45 1246
46Bell (Ctrl-G) 1247Bell (Ctrl-G)
47 1248
… …
77=item B<< C<SI> >> 1278=item B<< C<SI> >>
78 1279
79Shift In (Ctrl-O), invokes the G0 character set (the default). 1280Shift In (Ctrl-O), invokes the G0 character set (the default).
80Switch to Standard Character Set 1281Switch to Standard Character Set
81 1282
82=item B<< C<SPC> >> 1283=item B<< C<SP> >>
83 1284
84Space Character 1285Space Character
85 1286
86=back 1287=back
87 1288
88=head1 Escape Sequences 1289=head2 Escape Sequences
89 1290
90=over 4 1291=over 4
91 1292
92=item B<< C<ESC # 8> >> 1293=item B<< C<ESC # 8> >>
93 1294
… …
103 1304
104=item B<< C<ESC => >> 1305=item B<< C<ESC => >>
105 1306
106Application Keypad (SMKX). See also next sequence. 1307Application Keypad (SMKX). See also next sequence.
107 1308
108=item B<<< C<< ESC >> >>> 1309=item B<<< C<< ESC > >> >>>
109 1310
110Normal Keypad (RMKX) 1311Normal Keypad (RMKX)
111 1312
112B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been 1313B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been
113pressed, numbers or control functions are generated by the numeric keypad 1314pressed, numbers or control functions are generated by the numeric keypad
… …
139Single Shift Select of G3 Character Set (SS3): affects next character 1340Single Shift Select of G3 Character Set (SS3): affects next character
140only I<unimplemented> 1341only I<unimplemented>
141 1342
142=item B<< C<ESC Z> >> 1343=item B<< C<ESC Z> >>
143 1344
144Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt compile-time option> 1345Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
145 1346
146=item B<< C<ESC c> >> 1347=item B<< C<ESC c> >>
147 1348
148Full reset (RIS) 1349Full reset (RIS)
149 1350
… …
153 1354
154=item B<< C<ESC o> >> 1355=item B<< C<ESC o> >>
155 1356
156Invoke the G3 Character Set (LS3) 1357Invoke the G3 Character Set (LS3)
157 1358
158=item B<< C<ESC>(C<C> >> 1359=item B<< C<ESC ( C> >>
159 1360
160Designate G0 Character Set (ISO 2022), see below for values of C<C>. 1361Designate G0 Character Set (ISO 2022), see below for values of C<C>.
161 1362
162=item B<< C<ESC>)C<C> >> 1363=item B<< C<ESC ) C> >>
163 1364
164Designate G1 Character Set (ISO 2022), see below for values of C<C>. 1365Designate G1 Character Set (ISO 2022), see below for values of C<C>.
165 1366
166=item B<< C<ESC * C> >> 1367=item B<< C<ESC * C> >>
167 1368
… …
191 1392
192=back 1393=back
193 1394
194X<CSI> 1395X<CSI>
195 1396
196=head1 CSI (Code Sequence Introducer) Sequences 1397=head2 CSI (Command Sequence Introducer) Sequences
197 1398
198=over 4 1399=over 4
199 1400
200=item B<< C<ESC [ Ps @> >> 1401=item B<< C<ESC [ Ps @> >>
201 1402
… …
241 1442
242Erase in Display (ED) 1443Erase in Display (ED)
243 1444
244=begin table 1445=begin table
245 1446
246 B<< C<Ps = 0> >> Clear Below (default) 1447 B<< C<Ps = 0> >> Clear Right and Below (default)
247 B<< C<Ps = 1> >> Clear Above 1448 B<< C<Ps = 1> >> Clear Left and Above
248 B<< C<Ps = 2> >> Clear All 1449 B<< C<Ps = 2> >> Clear All
249 1450
250=end table 1451=end table
251 1452
252=item B<< C<ESC [ Ps K> >> 1453=item B<< C<ESC [ Ps K> >>
… …
256=begin table 1457=begin table
257 1458
258 B<< C<Ps = 0> >> Clear to Right (default) 1459 B<< C<Ps = 0> >> Clear to Right (default)
259 B<< C<Ps = 1> >> Clear to Left 1460 B<< C<Ps = 1> >> Clear to Left
260 B<< C<Ps = 2> >> Clear All 1461 B<< C<Ps = 2> >> Clear All
1462 B<< C<Ps = 3> >> Like Ps = 0, but is ignored when wrapped
1463 (@@RXVT_NAME@@ extension)
261 1464
262=end table 1465=end table
263 1466
264=item B<< C<ESC [ Ps L> >> 1467=item B<< C<ESC [ Ps L> >>
265 1468
… …
298 1501
299Move backward B<< C<Ps> >> [default: 1] tab stops 1502Move backward B<< C<Ps> >> [default: 1] tab stops
300 1503
301=item B<< C<ESC [ Ps '> >> 1504=item B<< C<ESC [ Ps '> >>
302 1505
303== 1506See B<< C<ESC [ Ps G> >>
304 1507
305=item B<< C<ESC [ Ps a> >> 1508=item B<< C<ESC [ Ps a> >>
306 1509
307==X<ESCOBPsc> 1510See B<< C<ESC [ Ps C> >>
308 1511
309=item B<< C<ESC [ Ps c> >> 1512=item B<< C<ESC [ Ps c> >>
310 1513
311Send Device Attributes (DA) 1514Send Device Attributes (DA)
312B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1515B<< C<Ps = 0> >> (or omitted): request attributes from terminal
313returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1516returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
314Option'') 1517Option'')
315 1518
316=item B<< C<ESC [ Ps d> >> 1519=item B<< C<ESC [ Ps d> >>
317 1520
318Cursor to Line B<< C<Ps> >> (VPA) 1521Cursor to Line B<< C<Ps> >> (VPA)
319 1522
320=item B<< C<ESC [ Ps e> >> 1523=item B<< C<ESC [ Ps e> >>
321 1524
322== 1525See B<< C<ESC [ Ps A> >>
323 1526
324=item B<< C<ESC [ Ps;Ps f> >> 1527=item B<< C<ESC [ Ps;Ps f> >>
325 1528
326Horizontal and Vertical Position [row;column] (HVP) [default: 1;1] 1529Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]
327 1530
… …
334 B<< C<Ps = 0> >> Clear Current Column (default) 1537 B<< C<Ps = 0> >> Clear Current Column (default)
335 B<< C<Ps = 3> >> Clear All (TBC) 1538 B<< C<Ps = 3> >> Clear All (TBC)
336 1539
337=end table 1540=end table
338 1541
1542=item B<< C<ESC [ Pm h> >>
1543
1544Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
1545
339=item B<< C<ESC [ Ps i> >> 1546=item B<< C<ESC [ Ps i> >>
340 1547
341Printing 1548Printing. See also the C<print-pipe> resource.
342 1549
343=begin table 1550=begin table
344 1551
1552 B<< C<Ps = 0> >> print screen (MC0)
345 B<< C<Ps = 4> >> disable transparent print mode (MC4) 1553 B<< C<Ps = 4> >> disable transparent print mode (MC4)
346 B<< C<Ps = 5> >> enable transparent print mode (MC5) I<unimplemented> 1554 B<< C<Ps = 5> >> enable transparent print mode (MC5)
347 1555
348=end table 1556=end table
349
350=item B<< C<ESC [ Pm h> >>
351
352Set Mode (SM). See next sequence for description of C<Pm>.
353 1557
354=item B<< C<ESC [ Pm l> >> 1558=item B<< C<ESC [ Pm l> >>
355 1559
356Reset Mode (RM) 1560Reset Mode (RM)
357 1561
… …
364 B<< C<h> >> Insert Mode (SMIR) 1568 B<< C<h> >> Insert Mode (SMIR)
365 B<< C<l> >> Replace Mode (RMIR) 1569 B<< C<l> >> Replace Mode (RMIR)
366 1570
367=end table 1571=end table
368 1572
369=item B<< C<Ps = 20> >> I<unimplemented> 1573=item B<< C<Ps = 20> >> (partially implemented)
370 1574
371=begin table 1575=begin table
372 1576
373 B<< C<h> >> Automatic Newline (LNM) 1577 B<< C<h> >> Automatic Newline (LNM)
374 B<< C<h> >> Normal Linefeed (LNM) 1578 B<< C<l> >> Normal Linefeed (LNM)
375 1579
376=end table 1580=end table
377 1581
378=back 1582=back
379 1583
… …
381 1585
382Character Attributes (SGR) 1586Character Attributes (SGR)
383 1587
384=begin table 1588=begin table
385 1589
386 B<< C<Ps = 0> >> Normal (default) 1590 B<< C<Pm = 0> >> Normal (default)
387 B<< C<Ps = 1 / 22> >> On / Off Bold (bright fg) 1591 B<< C<Pm = 1 / 21> >> On / Off Bold (bright fg)
1592 B<< C<Pm = 3 / 23> >> On / Off Italic
388 B<< C<Ps = 4 / 24> >> On / Off Underline 1593 B<< C<Pm = 4 / 24> >> On / Off Underline
389 B<< C<Ps = 5 / 25> >> On / Off Blink (bright bg) 1594 B<< C<Pm = 5 / 25> >> On / Off Slow Blink (bright bg)
1595 B<< C<Pm = 6 / 26> >> On / Off Rapid Blink (bright bg)
390 B<< C<Ps = 7 / 27> >> On / Off Inverse 1596 B<< C<Pm = 7 / 27> >> On / Off Inverse
1597 B<< C<Pm = 8 / 27> >> On / Off Invisible (NYI)
391 B<< C<Ps = 30 / 40> >> fg/bg Black 1598 B<< C<Pm = 30 / 40> >> fg/bg Black
392 B<< C<Ps = 31 / 41> >> fg/bg Red 1599 B<< C<Pm = 31 / 41> >> fg/bg Red
393 B<< C<Ps = 32 / 42> >> fg/bg Green 1600 B<< C<Pm = 32 / 42> >> fg/bg Green
394 B<< C<Ps = 33 / 43> >> fg/bg Yellow 1601 B<< C<Pm = 33 / 43> >> fg/bg Yellow
395 B<< C<Ps = 34 / 44> >> fg/bg Blue 1602 B<< C<Pm = 34 / 44> >> fg/bg Blue
396 B<< C<Ps = 35 / 45> >> fg/bg Magenta 1603 B<< C<Pm = 35 / 45> >> fg/bg Magenta
397 B<< C<Ps = 36 / 46> >> fg/bg Cyan 1604 B<< C<Pm = 36 / 46> >> fg/bg Cyan
398 B<< C<Ps = 37 / 47> >> fg/bg White 1605 B<< C<Pm = 37 / 47> >> fg/bg White
1606 B<< C<Pm = 38;5 / 48;5> >> set fg/bg to colour #m (ISO 8613-6)
399 B<< C<Ps = 39 / 49> >> fg/bg Default 1607 B<< C<Pm = 39 / 49> >> fg/bg Default
1608 B<< C<Pm = 90 / 100> >> fg/bg Bright Black
1609 B<< C<Pm = 91 / 101> >> fg/bg Bright Red
1610 B<< C<Pm = 92 / 102> >> fg/bg Bright Green
1611 B<< C<Pm = 93 / 103> >> fg/bg Bright Yellow
1612 B<< C<Pm = 94 / 104> >> fg/bg Bright Blue
1613 B<< C<Pm = 95 / 105> >> fg/bg Bright Magenta
1614 B<< C<Pm = 96 / 106> >> fg/bg Bright Cyan
1615 B<< C<Pm = 97 / 107> >> fg/bg Bright White
1616 B<< C<Pm = 99 / 109> >> fg/bg Bright Default
400 1617
401=end table 1618=end table
402 1619
403=item B<< C<ESC [ Ps n> >> 1620=item B<< C<ESC [ Ps n> >>
404 1621
… …
411 B<< C<Ps = 7> >> Request Display Name 1628 B<< C<Ps = 7> >> Request Display Name
412 B<< C<Ps = 8> >> Request Version Number (place in window title) 1629 B<< C<Ps = 8> >> Request Version Number (place in window title)
413 1630
414=end table 1631=end table
415 1632
1633=item B<< C<ESC [ Ps SP q> >>
1634
1635Set Cursor Style (DESCUSR)
1636
1637=begin table
1638
1639 B<< C<Ps = 0> >> Blink Block
1640 B<< C<Ps = 1> >> Blink Block
1641 B<< C<Ps = 2> >> Steady Block
1642 B<< C<Ps = 3> >> Blink Underline
1643 B<< C<Ps = 4> >> Steady Underline
1644
1645=end table
1646
416=item B<< C<ESC [ Ps;Ps r> >> 1647=item B<< C<ESC [ Ps;Ps r> >>
417 1648
418Set Scrolling Region [top;bottom] 1649Set Scrolling Region [top;bottom]
419[default: full size of window] (CSR) 1650[default: full size of window] (CSR)
420 1651
421=item B<< C<ESC [ s> >> 1652=item B<< C<ESC [ s> >>
422 1653
423Save Cursor (SC) 1654Save Cursor (SC)
424 1655
1656=item B<< C<ESC [ Ps;Pt t> >>
1657
1658Window Operations
1659
1660=begin table
1661
1662 B<< C<Ps = 1> >> Deiconify (map) window
1663 B<< C<Ps = 2> >> Iconify window
1664 B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1665 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1666 B<< C<Ps = 5> >> Raise window
1667 B<< C<Ps = 6> >> Lower window
1668 B<< C<Ps = 7> >> Refresh screen once
1669 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1670 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1671 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1672 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1673 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1674 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1675 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1676 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
1677 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1678
1679=end table
1680
1681=item B<< C<ESC [ u> >>
1682
1683Restore Cursor
1684
425=item B<< C<ESC [ Ps x> >> 1685=item B<< C<ESC [ Ps x> >>
426 1686
427Request Terminal Parameters (DECREQTPARM) 1687Request Terminal Parameters (DECREQTPARM)
428 1688
429=item B<< C<ESC [ u> >>
430
431Restore Cursor
432
433=back 1689=back
434 1690
435X<PrivateModes> 1691X<PrivateModes>
436 1692
437=head1 DEC Private Modes 1693=head2 DEC Private Modes
438 1694
439=over 4 1695=over 4
440 1696
441=item B<< C<ESC [ ? Pm h> >> 1697=item B<< C<ESC [ ? Pm h> >>
442 1698
… …
458 1714
459Toggle DEC Private Mode Values (rxvt extension). I<where> 1715Toggle DEC Private Mode Values (rxvt extension). I<where>
460 1716
461=over 4 1717=over 4
462 1718
463=item B<< C<Ps = 1> >> (DECCKM) 1719=item B<< C<Pm = 1> >> (DECCKM)
464 1720
465=begin table 1721=begin table
466 1722
467 B<< C<h> >> Application Cursor Keys 1723 B<< C<h> >> Application Cursor Keys
468 B<< C<l> >> Normal Cursor Keys 1724 B<< C<l> >> Normal Cursor Keys
469 1725
470=end table 1726=end table
471 1727
472=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1728=item B<< C<Pm = 2> >> (DECANM)
473 1729
474=begin table 1730=begin table
475 1731
476 B<< C<h> >> Enter VT52 mode 1732 B<< C<h> >> Enter VT52 mode
477 B<< C<l> >> Enter VT52 mode 1733 B<< C<l> >> Enter VT52 mode
478 1734
479=end table 1735=end table
480 1736
481=item B<< C<Ps = 3> >> 1737=item B<< C<Pm = 3> >> (DECCOLM)
482 1738
483=begin table 1739=begin table
484 1740
485 B<< C<h> >> 132 Column Mode (DECCOLM) 1741 B<< C<h> >> 132 Column Mode
486 B<< C<l> >> 80 Column Mode (DECCOLM) 1742 B<< C<l> >> 80 Column Mode
487 1743
488=end table
489
490=item B<< C<Ps = 4> >>
491
492=begin table 1744=end table
493 1745
1746=item B<< C<Pm = 4> >> (DECSCLM)
1747
1748=begin table
1749
494 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1750 B<< C<h> >> Smooth (Slow) Scroll
495 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1751 B<< C<l> >> Jump (Fast) Scroll
496 1752
497=end table
498
499=item B<< C<Ps = 5> >>
500
501=begin table 1753=end table
502 1754
1755=item B<< C<Pm = 5> >> (DECSCNM)
1756
1757=begin table
1758
503 B<< C<h> >> Reverse Video (DECSCNM) 1759 B<< C<h> >> Reverse Video
504 B<< C<l> >> Normal Video (DECSCNM) 1760 B<< C<l> >> Normal Video
505 1761
506=end table
507
508=item B<< C<Ps = 6> >>
509
510=begin table 1762=end table
511 1763
1764=item B<< C<Pm = 6> >> (DECOM)
1765
1766=begin table
1767
512 B<< C<h> >> Origin Mode (DECOM) 1768 B<< C<h> >> Origin Mode
513 B<< C<l> >> Normal Cursor Mode (DECOM) 1769 B<< C<l> >> Normal Cursor Mode
514 1770
515=end table
516
517=item B<< C<Ps = 7> >>
518
519=begin table 1771=end table
520 1772
1773=item B<< C<Pm = 7> >> (DECAWM)
1774
1775=begin table
1776
521 B<< C<h> >> Wraparound Mode (DECAWM) 1777 B<< C<h> >> Wraparound Mode
522 B<< C<l> >> No Wraparound Mode (DECAWM) 1778 B<< C<l> >> No Wraparound Mode
523 1779
524=end table 1780=end table
525 1781
526=item B<< C<Ps = 8> >> I<unimplemented> 1782=item B<< C<Pm = 8> >> (DECARM) I<unimplemented>
527 1783
528=begin table 1784=begin table
529 1785
530 B<< C<h> >> Auto-repeat Keys (DECARM) 1786 B<< C<h> >> Auto-repeat Keys
531 B<< C<l> >> No Auto-repeat Keys (DECARM) 1787 B<< C<l> >> No Auto-repeat Keys
532 1788
533=end table 1789=end table
534 1790
535=item B<< C<Ps = 9> >> X10 XTerm 1791=item B<< C<Pm = 9> >> X10 XTerm
536 1792
537=begin table 1793=begin table
538 1794
539 B<< C<h> >> Send Mouse X & Y on button press. 1795 B<< C<h> >> Send Mouse X & Y on button press.
540 B<< C<l> >> No mouse reporting. 1796 B<< C<l> >> No mouse reporting.
541 1797
542=end table 1798=end table
543 1799
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> >> 1800=item B<< C<Pm = 25> >> (DECTCEM)
556 1801
557=begin table 1802=begin table
558 1803
559 B<< C<h> >> Visible cursor {cnorm/cvvis} 1804 B<< C<h> >> Visible cursor {cnorm/cvvis}
560 B<< C<l> >> Invisible cursor {civis} 1805 B<< C<l> >> Invisible cursor {civis}
561 1806
562=end table 1807=end table
563 1808
564=item B<< C<Ps = 30> >> 1809=item B<< C<Pm = 30> >>
565 1810
566=begin table 1811=begin table
567 1812
568 B<< C<h> >> scrollBar visisble 1813 B<< C<h> >> scrollBar visible
569 B<< C<l> >> scrollBar invisisble 1814 B<< C<l> >> scrollBar invisible
570 1815
571=end table 1816=end table
572 1817
573=item B<< C<Ps = 35> >> (B<rxvt>) 1818=item B<< C<Pm = 35> >> (B<rxvt>)
574 1819
575=begin table 1820=begin table
576 1821
577 B<< C<h> >> Allow XTerm Shift+key sequences 1822 B<< C<h> >> Allow XTerm Shift+key sequences
578 B<< C<l> >> Disallow XTerm Shift+key sequences 1823 B<< C<l> >> Disallow XTerm Shift+key sequences
579 1824
580=end table 1825=end table
581 1826
582=item B<< C<Ps = 38> >> I<unimplemented> 1827=item B<< C<Pm = 38> >> I<unimplemented>
583 1828
584Enter Tektronix Mode (DECTEK) 1829Enter Tektronix Mode (DECTEK)
585 1830
586=item B<< C<Ps = 40> >> 1831=item B<< C<Pm = 40> >>
587 1832
588=begin table 1833=begin table
589 1834
590 B<< C<h> >> Allow 80/132 Mode 1835 B<< C<h> >> Allow 80/132 Mode
591 B<< C<l> >> Disallow 80/132 Mode 1836 B<< C<l> >> Disallow 80/132 Mode
592 1837
593=end table 1838=end table
594 1839
595=item B<< C<Ps = 44> >> I<unimplemented> 1840=item B<< C<Pm = 44> >> I<unimplemented>
596 1841
597=begin table 1842=begin table
598 1843
599 B<< C<h> >> Turn On Margin Bell 1844 B<< C<h> >> Turn On Margin Bell
600 B<< C<l> >> Turn Off Margin Bell 1845 B<< C<l> >> Turn Off Margin Bell
601 1846
602=end table 1847=end table
603 1848
604=item B<< C<Ps = 45> >> I<unimplemented> 1849=item B<< C<Pm = 45> >> I<unimplemented>
605 1850
606=begin table 1851=begin table
607 1852
608 B<< C<h> >> Reverse-wraparound Mode 1853 B<< C<h> >> Reverse-wraparound Mode
609 B<< C<l> >> No Reverse-wraparound Mode 1854 B<< C<l> >> No Reverse-wraparound Mode
610 1855
611=end table 1856=end table
612 1857
613=item B<< C<Ps = 46> >> I<unimplemented> 1858=item B<< C<Pm = 46> >> I<unimplemented>
614 1859
615=item B<< C<Ps = 47> >> 1860=item B<< C<Pm = 47> >>
616 1861
617=begin table 1862=begin table
618 1863
619 B<< C<h> >> Use Alternate Screen Buffer 1864 B<< C<h> >> Use Alternate Screen Buffer
620 B<< C<l> >> Use Normal Screen Buffer 1865 B<< C<l> >> Use Normal Screen Buffer
621 1866
622=end table 1867=end table
623 1868
624X<Priv66> 1869X<Priv66>
625 1870
626=item B<< C<Ps = 66> >> 1871=item B<< C<Pm = 66> >> (DECNKM)
627 1872
628=begin table 1873=begin table
629 1874
630 B<< C<h> >> Application Keypad (DECPAM) == 1875 B<< C<h> >> Application Keypad (DECKPAM/DECPAM) == C<ESC =>
631 B<< C<l> >> Normal Keypad (DECPNM) == 1876 B<< C<l> >> Normal Keypad (DECKPNM/DECPNM) == C<< ESC > >>
632 1877
633=end table
634
635=item B<< C<Ps = 67> >>
636
637=begin table 1878=end table
638 1879
1880=item B<< C<Pm = 67> >> (DECBKM)
1881
1882=begin table
1883
639 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1884 B<< C<h> >> Backspace key sends B<< C<BS> >>
640 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1885 B<< C<l> >> Backspace key sends B<< C<DEL> >>
641 1886
642=end table 1887=end table
643 1888
644=item B<< C<Ps = 1000> >> (X11 XTerm) 1889=item B<< C<Pm = 1000> >> (X11 XTerm)
645 1890
646=begin table 1891=begin table
647 1892
648 B<< C<h> >> Send Mouse X & Y on button press and release. 1893 B<< C<h> >> Send Mouse X & Y on button press and release.
649 B<< C<l> >> No mouse reporting. 1894 B<< C<l> >> No mouse reporting.
650 1895
651=end table 1896=end table
652 1897
653=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1898=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
654 1899
655=begin table 1900=begin table
656 1901
657 B<< C<h> >> Use Hilite Mouse Tracking. 1902 B<< C<h> >> Use Hilite Mouse Tracking.
658 B<< C<l> >> No mouse reporting. 1903 B<< C<l> >> No mouse reporting.
659 1904
660=end table 1905=end table
661 1906
1907=item B<< C<Pm = 1002> >> (X11 XTerm)
1908
1909=begin table
1910
1911 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1912 B<< C<l> >> No mouse reporting.
1913
1914=end table
1915
1916=item B<< C<Pm = 1003> >> (X11 XTerm)
1917
1918=begin table
1919
1920 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1921 B<< C<l> >> No mouse reporting.
1922
1923=end table
1924
1925=item B<< C<Pm = 1005> >> (X11 XTerm) (Compile frills)
1926
1927Try to avoid this mode, it doesn't work sensibly in non-UTF-8 locales. Use
1928mode C<1015> instead.
1929
1930Unlike XTerm, coordinates larger than 2015) will work fine.
1931
1932=begin table
1933
1934 B<< C<h> >> Enable mouse coordinates in locale-specific encoding.
1935 B<< C<l> >> Enable mouse coordinates as binary octets.
1936
1937=end table
1938
662=item B<< C<Ps = 1010> >> 1939=item B<< C<Pm = 1010> >> (B<rxvt>)
663 1940
664=begin table 1941=begin table
665 1942
666 B<< C<h> >> Don't scroll to bottom on TTY output 1943 B<< C<h> >> Don't scroll to bottom on TTY output
667 B<< C<l> >> Scroll to bottom on TTY output 1944 B<< C<l> >> Scroll to bottom on TTY output
668 1945
669=end table 1946=end table
670 1947
671=item B<< C<Ps = 1011> >> 1948=item B<< C<Pm = 1011> >> (B<rxvt>)
672 1949
673=begin table 1950=begin table
674 1951
675 B<< C<h> >> Scroll to bottom when a key is pressed 1952 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 1953 B<< C<l> >> Don't scroll to bottom when a key is pressed
677 1954
678=end table 1955=end table
679 1956
1957=item B<< C<Pm = 1015> >> (B<rxvt-unicode>) (Compile frills)
1958
1959Changes all mouse reporting codes to use decimal parameters instead of
1960octets or characters.
1961
1962This mode should be enabled I<before> actually enabling mouse reporting,
1963for semi-obvious reasons.
1964
1965The sequences received for various modes are as follows:
1966
1967 ESC [ M o o o !1005, !1015 (three octets)
1968 ESC [ M c c c 1005, !1015 (three characters)
1969 ESC [ Pm M 1015 (three or more numeric parameters)
1970
1971The first three parameters are C<code>, C<x> and C<y>. Code is the numeric
1972code as for the other modes (but encoded as a decimal number, including
1973the additional offset of 32, so you have to subtract 32 first), C<x> and
1974C<y> are the coordinates (1|1 is the upper left corner, just as with
1975cursor positioning).
1976
1977Example: Shift-Button-1 press at top row, column 80.
1978
1979 ESC [ 37 ; 80 ; 1 M
1980
1981One can use this feature by simply enabling it and then looking for
1982parameters to the C<ESC [ M> reply - if there are any, this mode is
1983active, otherwise one of the old reporting styles is used.
1984
1985Other (to be implemented) reply sequences will use a similar encoding.
1986
1987In the future, more parameters might get added (pixel coordinates for
1988example - anybody out there who needs this?).
1989
1990=begin table
1991
1992 B<< C<h> >> Enable new mouse coordinate reporting.
1993 B<< C<l> >> Use old-style C<CSI M C C C> encoding.
1994
1995=end table
1996
1997=item B<< C<Pm = 1021> >> (B<rxvt>)
1998
1999=begin table
2000
2001 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
2002 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
2003
2004=end table
2005
680=item B<< C<Ps = 1047> >> 2006=item B<< C<Pm = 1047> >>
681 2007
682=begin table 2008=begin table
683 2009
684 B<< C<h> >> Use Alternate Screen Buffer 2010 B<< C<h> >> Use Alternate Screen Buffer
685 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 2011 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
686 2012
687=end table 2013=end table
688 2014
689=item B<< C<Ps = 1048> >> 2015=item B<< C<Pm = 1048> >>
690 2016
691=begin table 2017=begin table
692 2018
693 B<< C<h> >> Save cursor position 2019 B<< C<h> >> Save cursor position
694 B<< C<l> >> Restore cursor position 2020 B<< C<l> >> Restore cursor position
695 2021
696=end table 2022=end table
697 2023
2024=item B<< C<Pm = 1049> >>
2025
2026=begin table
2027
2028 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
2029 B<< C<l> >> Use Normal Screen Buffer
2030
2031=end table
2032
2033=item B<< C<Pm = 2004> >>
2034
2035=begin table
2036
2037 B<< C<h> >> Enable bracketed paste mode - prepend / append to the pasted text the control sequences C<ESC [ 200 ~> / C<ESC [ 201 ~>
2038 B<< C<l> >> Disable bracketed paste mode
2039
2040=end table
2041
698=back 2042=back
699 2043
700=back 2044=back
701 2045
702X<XTerm> 2046X<XTerm>
703 2047
704=head1 XTerm Operating System Commands 2048=head2 XTerm Operating System Commands
705 2049
706=over 4 2050=over 4
707 2051
708=item B<< C<ESC ] Ps;Pt ST> >> 2052=item B<< C<ESC ] Ps;Pt ST> >>
709 2053
… …
716 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >> 2060 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> >> 2061 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
718 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> 2062 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. 2063 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 2064 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)> 2065 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)> 2066 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> >> 2067 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> >> 2068 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> >> 2069 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> >> 2070 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> >> 2071 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile 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> 2072 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> 2073 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> 2074 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> >> 2075 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> >> 2076 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) 2077 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) 2078 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) 2079 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
2080 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
2081 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
2082 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
2083 B<< C<Ps = 708> >> Change colour of the border to B<< C<Pt> >>
2084 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
2085 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2086 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2087 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2088 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2089 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2090 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
737 2091
738=end table 2092=end table
739 2093
740=back 2094=back
741 2095
742X<menuBar> 2096=head1 BACKGROUND IMAGE
743 2097
744=head1 menuBar 2098For the BACKGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> the value
745 2099of 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 2100
782=over 4 2101=over 4
783 2102
784=item B<< [menu:+I<name>] >> 2103=item B<< C<?> >>
785 2104
786access the named menuBar for creation or alteration. If a new menuBar 2105display 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 2106
790=item B<[menu]> 2107=item B<< C<;WxH+X+Y> >>
791 2108
792access the current menuBar for alteration 2109change scale and/or position
793 2110
794=item B<< [title:+I<string>] >> 2111=item B<< C<FILE;WxH+X+Y> >>
795 2112
796set the current menuBar's title to I<string>, which may contain the 2113change 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 2114
875=back 2115=back
876 2116
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> 2117X<Mouse>
1275 2118
1276=head1 Mouse Reporting 2119=head1 Mouse Reporting
1277 2120
1278=over 4 2121=over 4
… …
1303The upper bits of B<< C<< <b> >> >> indicate the modifiers when the 2146The upper bits of B<< C<< <b> >> >> indicate the modifiers when the
1304button was pressed and are added together (X11 mouse report only): 2147button was pressed and are added together (X11 mouse report only):
1305 2148
1306=over 4 2149=over 4
1307 2150
1308=item State = B<< C<< (<b> - SPACE) & 60 >> >> 2151=item State = B<< C<< (<b> - SPACE) & ~3 >> >>
1309 2152
1310=begin table 2153=begin table
1311 2154
1312 4 Shift 2155 4 Shift
1313 8 Meta 2156 8 Meta
1314 16 Control 2157 16 Control
2158 32 Motion Notify
1315 32 Double Click I<(Rxvt extension)> 2159 32 Double Click I<(rxvt extension)>, disabled by default
2160 64 Button1 is actually Button4, Button2 is actually Button5 etc.
1316 2161
1317=end table 2162=end table
1318 2163
1319Col = B<< C<< <x> - SPACE >> >> 2164Col = B<< C<< <x> - SPACE >> >>
1320 2165
1321Row = B<< C<< <y> - SPACE >> >> 2166Row = B<< C<< <y> - SPACE >> >>
1322 2167
1323=back 2168=back
2169
2170=head1 Key Codes
2171
1324X<KeyCodes> 2172X<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 2173
1342Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 2174Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
1343 2175
1344For the keypad, use B<Shift> to temporarily override Application-Keypad 2176For the keypad, use B<Shift> to temporarily override Application-Keypad
1345setting use B<Num_Lock> to toggle Application-Keypad setting if 2177setting use B<Num_Lock> to toggle Application-Keypad setting if
1346B<Num_Lock> is off, toggle Application-Keypad setting. Also note that 2178B<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 2179values of B<BackSpace>, B<Delete> may have been compiled differently on
1348your system. 2180your system.
1349 2181
1350=begin table 2182=begin table
1351 2183
1352 B<Normal> B<Shift> B<Control> B<Ctrl+Shift> 2184 B<Normal> B<Shift> B<Control> B<Ctrl+Shift>
… …
1408 XK_KP_8 8 ESC O x 2240 XK_KP_8 8 ESC O x
1409 XK_KP_9 9 ESC O y 2241 XK_KP_9 9 ESC O y
1410 2242
1411=end table 2243=end table
1412 2244
2245=head1 CONFIGURE OPTIONS
2246
2247General hint: if you get compile errors, then likely your configuration
2248hasn't been tested well. Either try with C<--enable-everything> or use
2249the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2250switches). Of course, you should always report when a combination doesn't
2251work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2252
2253All
2254
2255=over 4
2256
2257=item --enable-everything
2258
2259Add (or remove) support for all non-multichoice options listed
2260in C<./configure --help>, except for C<--enable-assert> and
2261C<--enable-256-color>.
2262
2263You can specify this and then disable options you do not like by
2264I<following> this with the appropriate C<--disable-...> arguments,
2265or you can start with a minimal configuration by specifying
2266C<--disable-everything> and than adding just the C<--enable-...> arguments
2267you want.
2268
2269=item --enable-xft (default: on)
2270
2271Add support for Xft (anti-aliased, among others) fonts. Xft fonts are
2272slower and require lots of memory, but as long as you don't use them, you
2273don't pay for them.
2274
2275=item --enable-font-styles (default: on)
2276
2277Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2278styles. The fonts can be set manually or automatically.
2279
2280=item --with-codesets=CS,... (default: all)
2281
2282Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2283are always compiled in, which includes most 8-bit character sets). These
2284codeset tables are used for driving X11 core fonts, they are not required
2285for Xft fonts, although having them compiled in lets rxvt-unicode choose
2286replacement fonts more intelligently. Compiling them in will make your
2287binary bigger (all of together cost about 700kB), but it doesn't increase
2288memory usage unless you use a font requiring one of these encodings.
2289
2290=begin table
2291
2292 all all available codeset groups
2293 zh common chinese encodings
2294 zh_ext rarely used but very big chinese encodings
2295 jp common japanese encodings
2296 jp_ext rarely used but big japanese encodings
2297 kr korean encodings
2298
2299=end table
2300
2301=item --enable-xim (default: on)
2302
2303Add support for XIM (X Input Method) protocol. This allows using
2304alternative input methods (e.g. kinput2) and will also correctly
2305set up the input for people using dead keys or compose keys.
2306
2307=item --enable-unicode3 (default: off)
2308
2309Recommended to stay off unless you really need non-BMP characters.
2310
2311Enable direct support for displaying unicode codepoints above
231265535 (the basic multilingual page). This increases storage
2313requirements per character from 2 to 4 bytes. X11 fonts do not yet
2314support these extra characters, but Xft does.
2315
2316Please note that rxvt-unicode can store unicode code points >65535
2317even without this flag, but the number of such characters is
2318limited to a few thousand (shared with combining characters,
2319see next switch), and right now rxvt-unicode cannot display them
2320(input/output and cut&paste still work, though).
2321
2322=item --enable-combining (default: on)
2323
2324Enable automatic composition of combining characters into
2325composite characters. This is required for proper viewing of text
2326where accents are encoded as separate unicode characters. This is
2327done by using precomposed characters when available or creating
2328new pseudo-characters when no precomposed form exists.
2329
2330Without --enable-unicode3, the number of additional precomposed
2331characters is somewhat limited (the 6400 private use characters will be
2332(ab-)used). With --enable-unicode3, no practical limit exists.
2333
2334This option will also enable storage (but not display) of characters
2335beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2336
2337The combining table also contains entries for arabic presentation forms,
2338but these are not currently used. Bug me if you want these to be used (and
2339tell me how these are to be used...).
2340
2341=item --enable-fallback[=CLASS] (default: Rxvt)
2342
2343When reading resource settings, also read settings for class CLASS. To
2344disable resource fallback use --disable-fallback.
2345
2346=item --with-res-name=NAME (default: urxvt)
2347
2348Use the given name as default application name when
2349reading resources. Specify --with-res-name=rxvt to replace rxvt.
2350
2351=item --with-res-class=CLASS (default: URxvt)
2352
2353Use the given class as default application class
2354when reading resources. Specify --with-res-class=Rxvt to replace
2355rxvt.
2356
2357=item --enable-utmp (default: on)
2358
2359Write user and tty to utmp file (used by programs like F<w>) at
2360start of rxvt execution and delete information when rxvt exits.
2361
2362=item --enable-wtmp (default: on)
2363
2364Write user and tty to wtmp file (used by programs like F<last>) at
2365start of rxvt execution and write logout when rxvt exits. This
2366option requires --enable-utmp to also be specified.
2367
2368=item --enable-lastlog (default: on)
2369
2370Write user and tty to lastlog file (used by programs like
2371F<lastlogin>) at start of rxvt execution. This option requires
2372--enable-utmp to also be specified.
2373
2374=item --enable-pixbuf (default: on)
2375
2376Add support for GDK-PixBuf to be used for background images.
2377It adds support for many file formats including JPG, PNG,
2378TIFF, GIF, XPM, BMP, ICO and TGA.
2379
2380=item --enable-startup-notification (default: on)
2381
2382Add support for freedesktop startup notifications. This allows window managers
2383to display some kind of progress indicator during startup.
2384
2385=item --enable-transparency (default: on)
2386
2387Add support for using the root pixmap as background to simulate transparency.
2388Note that this feature depends on libXrender and on the availability
2389of the RENDER extension in the X server.
2390
2391=item --enable-fading (default: on)
2392
2393Add support for fading the text when focus is lost.
2394
2395=item --enable-rxvt-scroll (default: on)
2396
2397Add support for the original rxvt scrollbar.
2398
2399=item --enable-next-scroll (default: on)
2400
2401Add support for a NeXT-like scrollbar.
2402
2403=item --enable-xterm-scroll (default: on)
2404
2405Add support for an Xterm-like scrollbar.
2406
2407=item --disable-backspace-key
2408
2409Removes any handling of the backspace key by us - let the X server do it.
2410
2411=item --disable-delete-key
2412
2413Removes any handling of the delete key by us - let the X server
2414do it.
2415
2416=item --disable-resources
2417
2418Removes any support for resource checking.
2419
2420=item --disable-swapscreen
2421
2422Remove support for secondary/swap screen.
2423
2424=item --enable-frills (default: on)
2425
2426Add support for many small features that are not essential but nice to
2427have. Normally you want this, but for very small binaries you may want to
2428disable this.
2429
2430A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2431in combination with other switches) is:
2432
2433 MWM-hints
2434 EWMH-hints (pid, utf8 names) and protocols (ping)
2435 urgency hint
2436 separate underline colour (-underlineColor)
2437 settable border widths and borderless switch (-w, -b, -bl)
2438 visual depth selection (-depth)
2439 settable extra linespacing (-lsp)
2440 iso-14755 5.1 (basic) support
2441 tripleclickwords (-tcw)
2442 settable insecure mode (-insecure)
2443 keysym remapping support
2444 cursor blinking and underline cursor (-bc, -uc)
2445 XEmbed support (-embed)
2446 user-pty (-pty-fd)
2447 hold on exit (-hold)
2448 compile in built-in block graphics
2449 skip builtin block graphics (-sbg)
2450 separate highlight colour (-highlightColor, -highlightTextColor)
2451 extended mouse reporting modes (1005 and 1015).
2452 visual selection via -visual and -depth.
2453
2454It also enables some non-essential features otherwise disabled, such as:
2455
2456 some round-trip time optimisations
2457 nearest colour allocation on pseudocolor screens
2458 UTF8_STRING support for selection
2459 sgr modes 90..97 and 100..107
2460 backindex and forwardindex escape sequences
2461 view change/zero scrollback escape sequences
2462 locale switching escape sequence
2463 window op and some xterm/OSC escape sequences
2464 rectangular selections
2465 trailing space removal for selections
2466 verbose X error handling
2467
2468=item --enable-iso14755 (default: on)
2469
2470Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)).
2471Basic support (section 5.1) is enabled by C<--enable-frills>, while
2472support for 5.2, 5.3 and 5.4 is enabled with this switch.
2473
2474=item --enable-keepscrolling (default: on)
2475
2476Add support for continual scrolling of the display when you hold
2477the mouse button down on a scrollbar arrow.
2478
2479=item --enable-selectionscrolling (default: on)
2480
2481Add support for scrolling when the selection moves to the top or
2482bottom of the screen.
2483
2484=item --enable-mousewheel (default: on)
2485
2486Add support for scrolling via mouse wheel or buttons 4 & 5.
2487
2488=item --enable-slipwheeling (default: on)
2489
2490Add support for continual scrolling (using the mouse wheel as an
2491accelerator) while the control key is held down. This option
2492requires --enable-mousewheel to also be specified.
2493
2494=item --enable-smart-resize (default: off)
2495
2496Add smart growth/shrink behaviour when resizing.
2497This should keep the window corner which is closest to a corner of
2498the screen in a fixed position.
2499
2500=item --enable-text-blink (default: on)
2501
2502Add support for blinking text.
2503
2504=item --enable-pointer-blank (default: on)
2505
2506Add support to have the pointer disappear when typing or inactive.
2507
2508=item --enable-perl (default: on)
2509
2510Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2511manpage for more info on this feature, or the files in F<src/perl/>
2512for the extensions that are installed by default.
2513The perl interpreter that is used can be specified via the C<PERL>
2514environment variable when running configure. Even when compiled in,
2515perl will I<not> be initialised when all extensions have been disabled
2516C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2517resource standpoint.
2518
2519=item --enable-assert (default: off)
2520
2521Enables the assertions in the code, normally disabled. This switch is only
2522useful when developing rxvt-unicode.
2523
2524=item --enable-256-color (default: off)
2525
2526Force use of so-called 256 colour mode, to work around buggy applications
2527that do not support termcap/terminfo, or simply improve support for
2528applications hardcoding the xterm 256 colour table.
2529
2530This switch breaks termcap/terminfo compatibility to C<TERM=rxvt-unicode>,
2531and consequently sets C<TERM> to C<rxvt-unicode-256color> by default
2532(F<doc/etc/> contains termcap/terminfo definitions for both).
2533
2534It also results in higher memory usage and can slow down @@RXVT_NAME@@
2535dramatically when more than six fonts are in use by a terminal instance.
2536
2537=item --with-name=NAME (default: urxvt)
2538
2539Set the basename for the installed binaries, resulting
2540in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2541C<rxvt>.
2542
2543=item --with-term=NAME (default: rxvt-unicode)
2544
2545Change the environmental variable for the terminal to NAME.
2546
2547=item --with-terminfo=PATH
2548
2549Change the environmental variable for the path to the terminfo tree to
2550PATH.
2551
2552=item --with-x
2553
2554Use the X Window System (pretty much default, eh?).
2555
2556=back
2557
2558=head1 AUTHORS
2559
2560Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
2561reworked it from the original Rxvt documentation, which was done by Geoff
2562Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other
2563sources.
2564

Diff Legend

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