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.198 by sf-exg, Fri Oct 15 10:46:57 2010 UTC

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

Diff Legend

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