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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines