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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines