ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.pod
Revision: 1.56
Committed: Wed Jul 13 01:01:41 2005 UTC (19 years ago) by root
Branch: MAIN
Changes since 1.55: +12 -0 lines
Log Message:
*** empty log message ***

File Contents

# Content
1 =head1 NAME
2
3 RXVT REFERENCE - FAQ, command sequences and other background information
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
18 This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19 all escape sequences, and other background information.
20
21 The newest version of this document is
22 also available on the World Wide Web at
23 L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
24
25 =head1 FREQUENTLY ASKED QUESTIONS
26
27 =over 4
28
29 =item How do I know which rxvt-unicode version I'm using?
30
31 The version number is displayed with the usage (-h). Also the escape
32 sequence C<ESC [ 8 n> sets the window title to the version number.
33
34 =item I am using Debian GNU/Linux and have a problem...
35
36 The Debian GNU/Linux package of rxvt-unicode contains large patches that
37 considerably change the behaviour of rxvt-unicode. Before reporting a
38 bug to the original rxvt-unicode author please download and install the
39 genuine version (L<http://software.schmorp.de#rxvt-unicode>) and try to
40 reproduce the problem. If you cannot, chances are that the problems are
41 specific to Debian GNU/Linux, in which case it should be reported via the
42 Debian Bug Tracking System (use C<reportbug> to report the bug).
43
44 For other problems that also affect the Debian package, you can and
45 probably should use the Debian BTS, too, because, after all, it's also a
46 bug in the Debian version and it serves as a reminder for other users that
47 might encounter the same issue.
48
49 =item When I log-in to another system it tells me about missing terminfo data?
50
51 The terminal description used by rxvt-unicode is not as widely available
52 as that for xterm, or even rxvt (for which the same problem often arises).
53
54 The correct solution for this problem is to install the terminfo, this can
55 be done like this (with ncurses' infocmp):
56
57 REMOTE=remotesystem.domain
58 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
59
60 ... or by installing rxvt-unicode normally on the remote system,
61
62 If you cannot or do not want to do this, then you can simply set
63 C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
64 problems arising, which includes wrong keymapping, less and different
65 colours and some refresh errors in fullscreen applications. It's a nice
66 quick-and-dirty workaround for rare cases, though.
67
68 If you always want to do this (and are fine with the consequences) you
69 can either recompile rxvt-unicode with the desired TERM value or use a
70 resource to set it:
71
72 URxvt.termName: rxvt
73
74 If you don't plan to use B<rxvt> (quite common...) you could also replace
75 the rxvt terminfo file with the rxvt-unicode one.
76
77 =item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
78
79 =item I need a termcap file entry.
80
81 One reason you might want this is that some distributions or operating
82 systems still compile some programs using the long-obsoleted termcap
83 library (Fedora Core's bash is one example) and rely on a termcap entry
84 for C<rxvt-unicode>.
85
86 You could use rxvt's termcap entry with resonable results in many cases.
87 You can also create a termcap entry by using terminfo's infocmp program
88 like this:
89
90 infocmp -C rxvt-unicode
91
92 Or you could use this termcap entry, generated by the command above:
93
94 rxvt-unicode|rxvt-unicode terminal (X Window System):\
95 :am:bw:eo:km:mi:ms:xn:xo:\
96 :co#80:it#8:li#24:lm#0:\
97 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
98 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
99 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
100 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
101 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
102 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
103 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
104 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
105 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
106 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
107 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
108 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
109 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
110 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
111 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
112 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
113 :vs=\E[?25h:
114
115 =item Why does C<ls> no longer have coloured output?
116
117 The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
118 decide wether a terminal has colour, but uses it's own configuration
119 file. Needless to say, C<rxvt-unicode> is not in it's default file (among
120 with most other terminals supporting colour). Either add:
121
122 TERM rxvt-unicode
123
124 to C</etc/DIR_COLORS> or simply add:
125
126 alias ls='ls --color=auto'
127
128 to your C<.profile> or C<.bashrc>.
129
130 =item Why doesn't vim/emacs etc. use the 88 colour mode?
131
132 =item Why doesn't vim/emacs etc. make use of italic?
133
134 =item Why are the secondary screen-related options not working properly?
135
136 Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
137 distributions (most notably Debian GNU/Linux) break rxvt-unicode
138 by setting C<TERM> to C<rxvt>, which doesn't have these extra
139 features. Unfortunately, some of these (most notably, again, Debian
140 GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
141 file, so you will need to install it on your own (See the question B<When
142 I log-in to another system it tells me about missing terminfo data?> on
143 how to do this).
144
145 =item My numerical keypad acts weird and generates differing output?
146
147 Some Debian GNUL/Linux users seem to have this problem, although no
148 specific details were reported so far. It is possible that this is caused
149 by the wrong C<TERM> setting, although the details of wether and how
150 this can happen are unknown, as C<TERM=rxvt> should offer a compatible
151 keymap. See the answer to the previous question, and please report if that
152 helped.
153
154 =item Rxvt-unicode does not seem to understand the selected encoding?
155
156 =item Unicode does not seem to work?
157
158 If you encounter strange problems like typing an accented character but
159 getting two unrelated other characters or similar, or if program output is
160 subtly garbled, then you should check your locale settings.
161
162 Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
163 programs. Often rxvt-unicode is started in the C<C> locale, while the
164 login script running within the rxvt-unicode window changes the locale to
165 something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
166
167 The best thing is to fix your startup environment, as you will likely run
168 into other problems. If nothing works you can try this in your .profile.
169
170 printf '\e]701;%s\007' "$LC_CTYPE"
171
172 If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
173 supported on your systems. Some systems have a C<locale> command which
174 displays this (also, C<perl -e0> can be used to check locale settings, as
175 it will complain loudly if it cannot set the locale). If it displays something
176 like:
177
178 locale: Cannot set LC_CTYPE to default locale: ...
179
180 Then the locale you specified is not supported on your system.
181
182 If nothing works and you are sure that everything is set correctly then
183 you will need to remember a little known fact: Some programs just don't
184 support locales :(
185
186 =item Why do some characters look so much different than others?
187
188 =item How does rxvt-unicode choose fonts?
189
190 Most fonts do not contain the full range of Unicode, which is
191 fine. Chances are that the font you (or the admin/package maintainer of
192 your system/os) have specified does not cover all the characters you want
193 to display.
194
195 B<rxvt-unicode> makes a best-effort try at finding a replacement
196 font. Often the result is fine, but sometimes the chosen font looks
197 bad/ugly/wrong. Some fonts have totally strange characters that don't
198 resemble the correct glyph at all, and rxvt-unicode lacks the artificial
199 intelligence to detect that a specific glyph is wrong: it has to believe
200 the font that the characters it claims to contain indeed look correct.
201
202 In that case, select a font of your taste and add it to the font list,
203 e.g.:
204
205 @@RXVT_NAME@@ -fn basefont,font2,font3...
206
207 When rxvt-unicode sees a character, it will first look at the base
208 font. If the base font does not contain the character, it will go to the
209 next font, and so on. Specifying your own fonts will also speed up this
210 search and use less resources within rxvt-unicode and the X-server.
211
212 The only limitation is that none of the fonts may be larger than the base
213 font, as the base font defines the terminal character cell size, which
214 must be the same due to the way terminals work.
215
216 =item Why do some chinese characters look so different than others?
217
218 This is because there is a difference between script and language --
219 rxvt-unicode does not know which language the text that is output is,
220 as it only knows the unicode character codes. If rxvt-unicode first
221 sees a japanese/chinese character, it might choose a japanese font for
222 display. Subsequent japanese characters will use that font. Now, many
223 chinese characters aren't represented in japanese fonts, so when the first
224 non-japanese character comes up, rxvt-unicode will look for a chinese font
225 -- unfortunately at this point, it will still use the japanese font for
226 chinese characters that are also in the japanese font.
227
228 The workaround is easy: just tag a chinese font at the end of your font
229 list (see the previous question). The key is to view the font list as
230 a preference list: If you expect more japanese, list a japanese font
231 first. If you expect more chinese, put a chinese font first.
232
233 In the future it might be possible to switch language preferences at
234 runtime (the internal data structure has no problem with using different
235 fonts for the same character at the same time, but no interface for this
236 has been designed yet).
237
238 Until then, you might get away with switching fonts at runtime (see L<Can
239 I switch the fonts at runtime?> later in this document).
240
241 =item Why does rxvt-unicode sometimes leave pixel droppings?
242
243 Most fonts were not designed for terminal use, which means that character
244 size varies a lot. A font that is otherwise fine for terminal use might
245 contain some characters that are simply too wide. Rxvt-unicode will avoid
246 these characters. For characters that are just "a bit" too wide a special
247 "careful" rendering mode is used that redraws adjacent characters.
248
249 All of this requires that fonts do not lie about character sizes,
250 however: Xft fonts often draw glyphs larger than their acclaimed bounding
251 box, and rxvt-unicode has no way of detecting this (the correct way is to
252 ask for the character bounding box, which unfortunately is wrong in these
253 cases).
254
255 It's not clear (to me at least), wether this is a bug in Xft, freetype,
256 or the respective font. If you encounter this problem you might try using
257 the C<-lsp> option to give the font more height. If that doesn't work, you
258 might be forced to use a different font.
259
260 All of this is not a problem when using X11 core fonts, as their bounding
261 box data is correct.
262
263 =item On Solaris 9, many line-drawing characters are too wide.
264
265 Seems to be a known bug, read
266 L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
267 following ugly workaround to get non-double-wide-characters working:
268
269 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
270
271 =item My Compose (Multi_key) key is no longer working.
272
273 The most common causes for this are that either your locale is not set
274 correctly, or you specified a B<preeditStyle> that is not supported by
275 your input method. For example, if you specified B<OverTheSpot> and
276 your input method (e.g. the default input method handling Compose keys)
277 does not support this (for instance because it is not visual), then
278 rxvt-unicode will continue without an input method.
279
280 In this case either do not specify a B<preeditStyle> or specify more than
281 one pre-edit style, such as B<OverTheSpot,Root,None>.
282
283 =item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
284
285 Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
286 international keyboards) or simply use ISO 14755 support to your
287 advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
288 codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
289 character and so on.
290
291 =item How can I keep rxvt-unicode from using reverse video so much?
292
293 First of all, make sure you are running with the right terminal settings
294 (C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
295 make sure you have specified colours for italic and bold, as otherwise
296 rxvt-unicode might use reverse video to simulate the effect:
297
298 URxvt.colorBD: white
299 URxvt.colorIT: green
300
301 =item Some programs assume totally weird colours (red instead of blue), how can I fix that?
302
303 For some unexplainable reason, some rare programs assume a very weird
304 colour palette when confronted with a terminal with more than the standard
305 8 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
306 these programs not to assume non-ISO colours without very good reasons.
307
308 In the meantime, you can either edit your C<rxvt-unicode> terminfo
309 definition to only claim 8 colour support or use C<TERM=rxvt>, which will
310 fix colours but keep you from using other rxvt-unicode features.
311
312 =item I am on FreeBSD and rxvt-unicode does not seem to work at all.
313
314 Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
315 in your compile environment, or an implementation that implements it,
316 wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
317 B<wchar_t> is represented as unicode.
318
319 As you might have guessed, FreeBSD does neither define this symobl nor
320 does it support it. Instead, it uses it's own internal representation of
321 B<wchar_t>. This is, of course, completely fine with respect to standards.
322
323 However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
324 C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
325
326 C<__STDC_ISO_10646__> is the only sane way to support multi-language
327 apps in an OS, as using a locale-dependent (and non-standardized)
328 representation of B<wchar_t> makes it impossible to convert between
329 B<wchar_t> (as used by X11 and your applications) and any other encoding
330 without implementing OS-specific-wrappers for each and every locale. There
331 simply are no APIs to convert B<wchar_t> into anything except the current
332 locale encoding.
333
334 Some applications (such as the formidable B<mlterm>) work around this
335 by carrying their own replacement functions for character set handling
336 with them, and either implementing OS-dependent hacks or doing multiple
337 conversions (which is slow and unreliable in case the OS implements
338 encodings slightly different than the terminal emulator).
339
340 The rxvt-unicode author insists that the right way to fix this is in the
341 system libraries once and for all, instead of forcing every app to carry
342 complete replacements for them :)
343
344 =item I use Solaris 9 and it doesn't compile/work/etc.
345
346 Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
347 problems with C<wcwidth> and a compile problem.
348
349 =item How can I use rxvt-unicode under cygwin?
350
351 rxvt-unicode should compile and run out of the box on cygwin, using
352 the X11 libraries that come with cygwin. libW11 emulation is no
353 longer supported (and makes no sense, either, as it only supported a
354 single font). I recommend starting the X-server in C<-multiwindow> or
355 C<-rootless> mode instead, which will result in similar look&feel as the
356 old libW11 emulation.
357
358 At the time of this writing, cygwin didn't seem to support any multi-byte
359 encodings, so you are likely limited to 8-bit encodings.
360
361 =item How does rxvt-unicode determine the encoding to use?
362
363 =item Is there an option to switch encodings?
364
365 Unlike some other terminals, rxvt-unicode has no encoding switch, and no
366 specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
367 UTF-8 or any other encodings with respect to terminal I/O.
368
369 The reasons is that there exists a perfectly fine mechanism for selecting
370 the encoding, doing I/O and (most important) communicating this to all
371 applications so everybody agrees on character properties such as width
372 and code number. This mechanism is the I<locale>. Applications not using
373 that info will have problems (for example, C<xterm> gets the width of
374 characters wrong as it uses it's own, locale-independent table under all
375 locales).
376
377 Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
378 programs doing the same (that is, most) will automatically agree in the
379 interpretation of characters.
380
381 Unfortunately, there is no system-independent way to select locales, nor
382 is there a standard on how locale specifiers will look like.
383
384 On most systems, the content of the C<LC_CTYPE> environment variable
385 contains an arbitrary string which corresponds to an already-installed
386 locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
387 C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
388 (i.e. C<de> or C<german>) are also common.
389
390 Rxvt-unicode ignores all other locale categories, and except for
391 the encoding, ignores country or language-specific settings,
392 i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
393 rxvt-unicode.
394
395 If you want to use a specific encoding you have to make sure you start
396 rxvt-unicode with the correct C<LC_CTYPE> category.
397
398 =item Can I switch locales at runtime?
399
400 Yes, using an escape sequence. Try something like this, which sets
401 rxvt-unicode's idea of C<LC_CTYPE>.
402
403 printf '\e]701;%s\007' ja_JP.SJIS
404
405 See also the previous answer.
406
407 Sometimes this capability is rather handy when you want to work in
408 one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
409 (e.g. UTF-8). For example, I use this script to start C<xjdic>, which
410 first switches to a locale supported by xjdic and back later:
411
412 printf '\e]701;%s\007' ja_JP.SJIS
413 xjdic -js
414 printf '\e]701;%s\007' de_DE.UTF-8
415
416 You can also use xterm's C<luit> program, which usually works fine, except
417 for some locales where character width differs between program- and
418 rxvt-unicode-locales.
419
420 =item Can I switch the fonts at runtime?
421
422 Yes, using an escape sequence. Try something like this, which has the same
423 effect as using the C<-fn> switch, and takes effect immediately:
424
425 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
426
427 This is useful if you e.g. work primarily with japanese (and prefer a
428 japanese font), but you have to switch to chinese temporarily, where
429 japanese fonts would only be in your way.
430
431 You can think of this as a kind of manual ISO-2022 switching.
432
433 =item Why do italic characters look as if clipped?
434
435 Many fonts have difficulties with italic characters and hinting. For
436 example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
437 Mono> completely fails in it's italic face. A workaround might be to
438 enable freetype autohinting, i.e. like this:
439
440 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
441 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
442
443 =item My input method wants <some encoding> but I want UTF-8, what can I do?
444
445 You can specify separate locales for the input method and the rest of the
446 terminal, using the resource C<imlocale>:
447
448 URxvt*imlocale: ja_JP.EUC-JP
449
450 Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
451 use your input method. Please note, however, that you will not be able to
452 input characters outside C<EUC-JP> in a normal way then, as your input
453 method limits you.
454
455 =item Rxvt-unicode crashes when the X Input Method changes or exits.
456
457 Unfortunately, this is unavoidable, as the XIM protocol is racy by
458 design. Applications can avoid some crashes at the expense of memory
459 leaks, and Input Methods can avoid some crashes by careful ordering at
460 exit time. B<kinput2> (and derived input methods) generally succeeds,
461 while B<SCIM> (or similar input methods) fails. In the end, however,
462 crashes cannot be completely avoided even if both sides cooperate.
463
464 So the only workaround is not to kill your Input Method Servers.
465
466 =item Rxvt-unicode uses gobs of memory, how can I reduce that?
467
468 Rxvt-unicode tries to obey the rule of not charging you for something you
469 don't use. One thing you should try is to configure out all settings that
470 you don't need, for example, Xft support is a resource hog by design,
471 when used. Compiling it out ensures that no Xft font will be loaded
472 accidentally when rxvt-unicode tries to find a font for your characters.
473
474 Also, many people (me included) like large windows and even larger
475 scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
476 6 bytes per screen cell. For a 160x?? window this amounts to almost a
477 kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
478 use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
479 rxvt-unicode then uses 8 bytes per screen cell.
480
481 =item Can I speed up Xft rendering somehow?
482
483 Yes, the most obvious way to speed it up is to avoid Xft entirely, as
484 it is simply slow. If you still want Xft fonts you might try to disable
485 antialiasing (by appending C<:antialiasing=false>), which saves lots of
486 memory and also speeds up rendering considerably.
487
488 =item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
489
490 Rxvt-unicode will use whatever you specify as a font. If it needs to
491 fall back to it's default font search list it will prefer X11 core
492 fonts, because they are small and fast, and then use Xft fonts. It has
493 antialiasing disabled for most of them, because the author thinks they
494 look best that way.
495
496 If you want antialiasing, you have to specify the fonts manually.
497
498 =item Mouse cut/paste suddenly no longer works.
499
500 Make sure that mouse reporting is actually turned off since killing
501 some editors prematurely may leave the mouse in mouse report mode. I've
502 heard that tcsh may use mouse reporting unless it otherwise specified. A
503 quick check is to see if cut/paste works when the Alt or Shift keys are
504 depressed. See @@RXVT_NAME@@(7)
505
506 =item What's with this bold/blink stuff?
507
508 If no bold colour is set via C<colorBD:>, bold will invert text using the
509 standard foreground colour.
510
511 For the standard background colour, blinking will actually make the
512 text blink when compiled with C<--enable-blinking>. with standard
513 colours. Without C<--enable-blinking>, the blink attribute will be
514 ignored.
515
516 On ANSI colours, bold/blink attributes are used to set high-intensity
517 foreground/background colors.
518
519 color0-7 are the low-intensity colors.
520
521 color8-15 are the corresponding high-intensity colors.
522
523 =item I don't like the screen colors. How do I change them?
524
525 You can change the screen colors at run-time using F<~/.Xdefaults>
526 resources (or as long-options).
527
528 Here are values that are supposed to resemble a VGA screen,
529 including the murky brown that passes for low-intensity yellow:
530
531 URxvt.color0: #000000
532 URxvt.color1: #A80000
533 URxvt.color2: #00A800
534 URxvt.color3: #A8A800
535 URxvt.color4: #0000A8
536 URxvt.color5: #A800A8
537 URxvt.color6: #00A8A8
538 URxvt.color7: #A8A8A8
539
540 URxvt.color8: #000054
541 URxvt.color9: #FF0054
542 URxvt.color10: #00FF54
543 URxvt.color11: #FFFF54
544 URxvt.color12: #0000FF
545 URxvt.color13: #FF00FF
546 URxvt.color14: #00FFFF
547 URxvt.color15: #FFFFFF
548
549 And here is a more complete set of non-standard colors described (not by
550 me) as "pretty girly".
551
552 URxvt.cursorColor: #dc74d1
553 URxvt.pointerColor: #dc74d1
554 URxvt.background: #0e0e0e
555 URxvt.foreground: #4ad5e1
556 URxvt.color0: #000000
557 URxvt.color8: #8b8f93
558 URxvt.color1: #dc74d1
559 URxvt.color9: #dc74d1
560 URxvt.color2: #0eb8c7
561 URxvt.color10: #0eb8c7
562 URxvt.color3: #dfe37e
563 URxvt.color11: #dfe37e
564 URxvt.color5: #9e88f0
565 URxvt.color13: #9e88f0
566 URxvt.color6: #73f7ff
567 URxvt.color14: #73f7ff
568 URxvt.color7: #e1dddd
569 URxvt.color15: #e1dddd
570
571 =item How can I start @@RXVT_NAME@@d in a race-free way?
572
573 Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a
574 server that answers @@RXVT_NAME@@c's requests, so it doesn't background
575 itself.
576
577 To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the
578 following method to wait for the startup message before continuing:
579
580 { @@RXVT_NAME@@d & } | read
581
582 =item What's with the strange Backspace/Delete key behaviour?
583
584 Assuming that the physical Backspace key corresponds to the
585 BackSpace keysym (not likely for Linux ... see the following
586 question) there are two standard values that can be used for
587 Backspace: C<^H> and C<^?>.
588
589 Historically, either value is correct, but rxvt-unicode adopts the debian
590 policy of using C<^?> when unsure, because it's the one only only correct
591 choice :).
592
593 Rxvt-unicode tries to inherit the current stty settings and uses the value
594 of `erase' to guess the value for backspace. If rxvt-unicode wasn't
595 started from a terminal (say, from a menu or by remote shell), then the
596 system value of `erase', which corresponds to CERASE in <termios.h>, will
597 be used (which may not be the same as your stty setting).
598
599 For starting a new rxvt-unicode:
600
601 # use Backspace = ^H
602 $ stty erase ^H
603 $ @@RXVT_NAME@@
604
605 # use Backspace = ^?
606 $ stty erase ^?
607 $ @@RXVT_NAME@@
608
609 Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).
610
611 For an existing rxvt-unicode:
612
613 # use Backspace = ^H
614 $ stty erase ^H
615 $ echo -n "^[[36h"
616
617 # use Backspace = ^?
618 $ stty erase ^?
619 $ echo -n "^[[36l"
620
621 This helps satisfy some of the Backspace discrepancies that occur, but
622 if you use Backspace = C<^H>, make sure that the termcap/terminfo value
623 properly reflects that.
624
625 The Delete key is a another casualty of the ill-defined Backspace problem.
626 To avoid confusion between the Backspace and Delete keys, the Delete
627 key has been assigned an escape sequence to match the vt100 for Execute
628 (C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
629
630 Some other Backspace problems:
631
632 some editors use termcap/terminfo,
633 some editors (vim I'm told) expect Backspace = ^H,
634 GNU Emacs (and Emacs-like editors) use ^H for help.
635
636 Perhaps someday this will all be resolved in a consistent manner.
637
638 =item I don't like the key-bindings. How do I change them?
639
640 There are some compile-time selections available via configure. Unless
641 you have run "configure" with the C<--disable-resources> option you can
642 use the `keysym' resource to alter the keystrings associated with keysyms.
643
644 Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
645
646 URxvt.keysym.Home: \033[1~
647 URxvt.keysym.End: \033[4~
648 URxvt.keysym.C-apostrophe: \033<C-'>
649 URxvt.keysym.C-slash: \033<C-/>
650 URxvt.keysym.C-semicolon: \033<C-;>
651 URxvt.keysym.C-grave: \033<C-`>
652 URxvt.keysym.C-comma: \033<C-,>
653 URxvt.keysym.C-period: \033<C-.>
654 URxvt.keysym.C-0x60: \033<C-`>
655 URxvt.keysym.C-Tab: \033<C-Tab>
656 URxvt.keysym.C-Return: \033<C-Return>
657 URxvt.keysym.S-Return: \033<S-Return>
658 URxvt.keysym.S-space: \033<S-Space>
659 URxvt.keysym.M-Up: \033<M-Up>
660 URxvt.keysym.M-Down: \033<M-Down>
661 URxvt.keysym.M-Left: \033<M-Left>
662 URxvt.keysym.M-Right: \033<M-Right>
663 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
664 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
665 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
666
667 See some more examples in the documentation for the B<keysym> resource.
668
669 =item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
670 How do I make use of them? For example, the Sun Keyboard type 4
671 has the following mappings that rxvt-unicode doesn't recognize.
672
673 KP_Insert == Insert
674 F22 == Print
675 F27 == Home
676 F29 == Prior
677 F33 == End
678 F35 == Next
679
680 Rather than have rxvt-unicode try to accommodate all the various possible
681 keyboard mappings, it is better to use `xmodmap' to remap the keys as
682 required for your particular machine.
683
684 =item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
685 I need this to decide about setting colors etc.
686
687 rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
688 check and see if that is set. Note that several programs, JED, slrn,
689 Midnight Commander automatically check this variable to decide whether or
690 not to use color.
691
692 =item How do I set the correct, full IP address for the DISPLAY variable?
693
694 If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
695 insecure mode then it is possible to use the following shell script
696 snippets to correctly set the display. If your version of rxvt-unicode
697 wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
698 the COLORTERM variable can be used to distinguish rxvt-unicode from a
699 regular xterm.
700
701 Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
702 snippets:
703
704 # Bourne/Korn/POSIX family of shells:
705 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
706 if [ ${TERM:-foo} = xterm ]; then
707 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
708 echo -n '^[Z'
709 read term_id
710 stty icanon echo
711 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
712 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
713 read DISPLAY # set it in our local shell
714 fi
715 fi
716
717 =item How do I compile the manual pages for myself?
718
719 You need to have a recent version of perl installed as F</usr/bin/perl>,
720 one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
721 the doc subdirectory and enter C<make alldoc>.
722
723 =item My question isn't answered here, can I ask a human?
724
725 Before sending me mail, you could go to IRC: C<irc.freenode.net>,
726 channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
727 interested in learning about new and exciting problems (but not FAQs :).
728
729 =back
730
731 =head1 RXVT TECHNICAL REFERENCE
732
733 =head1 DESCRIPTION
734
735 The rest of this document describes various technical aspects of
736 B<rxvt-unicode>. First the description of supported command sequences,
737 followed by menu and pixmap support and last by a description of all
738 features selectable at C<configure> time.
739
740 =head1 Definitions
741
742 =over 4
743
744 =item B<< C<c> >>
745
746 The literal character c.
747
748 =item B<< C<C> >>
749
750 A single (required) character.
751
752 =item B<< C<Ps> >>
753
754 A single (usually optional) numeric parameter, composed of one or more
755 digits.
756
757 =item B<< C<Pm> >>
758
759 A multiple numeric parameter composed of any number of single numeric
760 parameters, separated by C<;> character(s).
761
762 =item B<< C<Pt> >>
763
764 A text parameter composed of printable characters.
765
766 =back
767
768 =head1 Values
769
770 =over 4
771
772 =item B<< C<ENQ> >>
773
774 Enquiry (Ctrl-E) = Send Device Attributes (DA)
775 request attributes from terminal. See B<< C<ESC [ Ps c> >>.
776
777 =item B<< C<BEL> >>
778
779 Bell (Ctrl-G)
780
781 =item B<< C<BS> >>
782
783 Backspace (Ctrl-H)
784
785 =item B<< C<TAB> >>
786
787 Horizontal Tab (HT) (Ctrl-I)
788
789 =item B<< C<LF> >>
790
791 Line Feed or New Line (NL) (Ctrl-J)
792
793 =item B<< C<VT> >>
794
795 Vertical Tab (Ctrl-K) same as B<< C<LF> >>
796
797 =item B<< C<FF> >>
798
799 Form Feed or New Page (NP) (Ctrl-L) same as B<< C<LF> >>
800
801 =item B<< C<CR> >>
802
803 Carriage Return (Ctrl-M)
804
805 =item B<< C<SO> >>
806
807 Shift Out (Ctrl-N), invokes the G1 character set.
808 Switch to Alternate Character Set
809
810 =item B<< C<SI> >>
811
812 Shift In (Ctrl-O), invokes the G0 character set (the default).
813 Switch to Standard Character Set
814
815 =item B<< C<SPC> >>
816
817 Space Character
818
819 =back
820
821 =head1 Escape Sequences
822
823 =over 4
824
825 =item B<< C<ESC # 8> >>
826
827 DEC Screen Alignment Test (DECALN)
828
829 =item B<< C<ESC 7> >>
830
831 Save Cursor (SC)
832
833 =item B<< C<ESC 8> >>
834
835 Restore Cursor
836
837 =item B<< C<ESC => >>
838
839 Application Keypad (SMKX). See also next sequence.
840
841 =item B<<< C<< ESC >> >>>
842
843 Normal Keypad (RMKX)
844
845 B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been
846 pressed, numbers or control functions are generated by the numeric keypad
847 (see Key Codes).
848
849 =item B<< C<ESC D> >>
850
851 Index (IND)
852
853 =item B<< C<ESC E> >>
854
855 Next Line (NEL)
856
857 =item B<< C<ESC H> >>
858
859 Tab Set (HTS)
860
861 =item B<< C<ESC M> >>
862
863 Reverse Index (RI)
864
865 =item B<< C<ESC N> >>
866
867 Single Shift Select of G2 Character Set (SS2): affects next character
868 only I<unimplemented>
869
870 =item B<< C<ESC O> >>
871
872 Single Shift Select of G3 Character Set (SS3): affects next character
873 only I<unimplemented>
874
875 =item B<< C<ESC Z> >>
876
877 Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
878
879 =item B<< C<ESC c> >>
880
881 Full reset (RIS)
882
883 =item B<< C<ESC n> >>
884
885 Invoke the G2 Character Set (LS2)
886
887 =item B<< C<ESC o> >>
888
889 Invoke the G3 Character Set (LS3)
890
891 =item B<< C<ESC ( C> >>
892
893 Designate G0 Character Set (ISO 2022), see below for values of C<C>.
894
895 =item B<< C<ESC ) C> >>
896
897 Designate G1 Character Set (ISO 2022), see below for values of C<C>.
898
899 =item B<< C<ESC * C> >>
900
901 Designate G2 Character Set (ISO 2022), see below for values of C<C>.
902
903 =item B<< C<ESC + C> >>
904
905 Designate G3 Character Set (ISO 2022), see below for values of C<C>.
906
907 =item B<< C<ESC $ C> >>
908
909 Designate Kanji Character Set
910
911 Where B<< C<C> >> is one of:
912
913 =begin table
914
915 C = C<0> DEC Special Character and Line Drawing Set
916 C = C<A> United Kingdom (UK)
917 C = C<B> United States (USASCII)
918 C = C<< < >> Multinational character set I<unimplemented>
919 C = C<5> Finnish character set I<unimplemented>
920 C = C<C> Finnish character set I<unimplemented>
921 C = C<K> German character set I<unimplemented>
922
923 =end table
924
925 =back
926
927 X<CSI>
928
929 =head1 CSI (Command Sequence Introducer) Sequences
930
931 =over 4
932
933 =item B<< C<ESC [ Ps @> >>
934
935 Insert B<< C<Ps> >> (Blank) Character(s) [default: 1] (ICH)X<ESCOBPsA>
936
937 =item B<< C<ESC [ Ps A> >>
938
939 Cursor Up B<< C<Ps> >> Times [default: 1] (CUU)
940
941 =item B<< C<ESC [ Ps B> >>
942
943 Cursor Down B<< C<Ps> >> Times [default: 1] (CUD)X<ESCOBPsC>
944
945 =item B<< C<ESC [ Ps C> >>
946
947 Cursor Forward B<< C<Ps> >> Times [default: 1] (CUF)
948
949 =item B<< C<ESC [ Ps D> >>
950
951 Cursor Backward B<< C<Ps> >> Times [default: 1] (CUB)
952
953 =item B<< C<ESC [ Ps E> >>
954
955 Cursor Down B<< C<Ps> >> Times [default: 1] and to first column
956
957 =item B<< C<ESC [ Ps F> >>
958
959 Cursor Up B<< C<Ps> >> Times [default: 1] and to first columnX<ESCOBPsG>
960
961 =item B<< C<ESC [ Ps G> >>
962
963 Cursor to Column B<< C<Ps> >> (HPA)
964
965 =item B<< C<ESC [ Ps;Ps H> >>
966
967 Cursor Position [row;column] [default: 1;1] (CUP)
968
969 =item B<< C<ESC [ Ps I> >>
970
971 Move forward B<< C<Ps> >> tab stops [default: 1]
972
973 =item B<< C<ESC [ Ps J> >>
974
975 Erase in Display (ED)
976
977 =begin table
978
979 B<< C<Ps = 0> >> Clear Below (default)
980 B<< C<Ps = 1> >> Clear Above
981 B<< C<Ps = 2> >> Clear All
982
983 =end table
984
985 =item B<< C<ESC [ Ps K> >>
986
987 Erase in Line (EL)
988
989 =begin table
990
991 B<< C<Ps = 0> >> Clear to Right (default)
992 B<< C<Ps = 1> >> Clear to Left
993 B<< C<Ps = 2> >> Clear All
994
995 =end table
996
997 =item B<< C<ESC [ Ps L> >>
998
999 Insert B<< C<Ps> >> Line(s) [default: 1] (IL)
1000
1001 =item B<< C<ESC [ Ps M> >>
1002
1003 Delete B<< C<Ps> >> Line(s) [default: 1] (DL)
1004
1005 =item B<< C<ESC [ Ps P> >>
1006
1007 Delete B<< C<Ps> >> Character(s) [default: 1] (DCH)
1008
1009 =item B<< C<ESC [ Ps;Ps;Ps;Ps;Ps T> >>
1010
1011 Initiate . I<unimplemented> Parameters are
1012 [func;startx;starty;firstrow;lastrow].
1013
1014 =item B<< C<ESC [ Ps W> >>
1015
1016 Tabulator functions
1017
1018 =begin table
1019
1020 B<< C<Ps = 0> >> Tab Set (HTS)
1021 B<< C<Ps = 2> >> Tab Clear (TBC), Clear Current Column (default)
1022 B<< C<Ps = 5> >> Tab Clear (TBC), Clear All
1023
1024 =end table
1025
1026 =item B<< C<ESC [ Ps X> >>
1027
1028 Erase B<< C<Ps> >> Character(s) [default: 1] (ECH)
1029
1030 =item B<< C<ESC [ Ps Z> >>
1031
1032 Move backward B<< C<Ps> >> [default: 1] tab stops
1033
1034 =item B<< C<ESC [ Ps '> >>
1035
1036 See B<< C<ESC [ Ps G> >>
1037
1038 =item B<< C<ESC [ Ps a> >>
1039
1040 See B<< C<ESC [ Ps C> >>
1041
1042 =item B<< C<ESC [ Ps c> >>
1043
1044 Send Device Attributes (DA)
1045 B<< C<Ps = 0> >> (or omitted): request attributes from terminal
1046 returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
1047 Option'')
1048
1049 =item B<< C<ESC [ Ps d> >>
1050
1051 Cursor to Line B<< C<Ps> >> (VPA)
1052
1053 =item B<< C<ESC [ Ps e> >>
1054
1055 See B<< C<ESC [ Ps A> >>
1056
1057 =item B<< C<ESC [ Ps;Ps f> >>
1058
1059 Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]
1060
1061 =item B<< C<ESC [ Ps g> >>
1062
1063 Tab Clear (TBC)
1064
1065 =begin table
1066
1067 B<< C<Ps = 0> >> Clear Current Column (default)
1068 B<< C<Ps = 3> >> Clear All (TBC)
1069
1070 =end table
1071
1072 =item B<< C<ESC [ Pm h> >>
1073
1074 Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
1075
1076 =item B<< C<ESC [ Ps i> >>
1077
1078 Printing. See also the C<print-pipe> resource.
1079
1080 =begin table
1081
1082 B<< C<Ps = 0> >> print screen (MC0)
1083 B<< C<Ps = 4> >> disable transparent print mode (MC4)
1084 B<< C<Ps = 5> >> enable transparent print mode (MC5)
1085
1086 =end table
1087
1088 =item B<< C<ESC [ Pm l> >>
1089
1090 Reset Mode (RM)
1091
1092 =over 4
1093
1094 =item B<< C<Ps = 4> >>
1095
1096 =begin table
1097
1098 B<< C<h> >> Insert Mode (SMIR)
1099 B<< C<l> >> Replace Mode (RMIR)
1100
1101 =end table
1102
1103 =item B<< C<Ps = 20> >> (partially implemented)
1104
1105 =begin table
1106
1107 B<< C<h> >> Automatic Newline (LNM)
1108 B<< C<l> >> Normal Linefeed (LNM)
1109
1110 =end table
1111
1112 =back
1113
1114 =item B<< C<ESC [ Pm m> >>
1115
1116 Character Attributes (SGR)
1117
1118 =begin table
1119
1120 B<< C<Ps = 0> >> Normal (default)
1121 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg)
1122 B<< C<Ps = 3 / 23> >> On / Off Italic
1123 B<< C<Ps = 4 / 24> >> On / Off Underline
1124 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg)
1125 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg)
1126 B<< C<Ps = 7 / 27> >> On / Off Inverse
1127 B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI)
1128 B<< C<Ps = 30 / 40> >> fg/bg Black
1129 B<< C<Ps = 31 / 41> >> fg/bg Red
1130 B<< C<Ps = 32 / 42> >> fg/bg Green
1131 B<< C<Ps = 33 / 43> >> fg/bg Yellow
1132 B<< C<Ps = 34 / 44> >> fg/bg Blue
1133 B<< C<Ps = 35 / 45> >> fg/bg Magenta
1134 B<< C<Ps = 36 / 46> >> fg/bg Cyan
1135 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to color #m (ISO 8613-6)
1136 B<< C<Ps = 37 / 47> >> fg/bg White
1137 B<< C<Ps = 39 / 49> >> fg/bg Default
1138 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
1139 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
1140 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
1141 B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow
1142 B<< C<Ps = 94 / 104> >> fg/bg Bright Blue
1143 B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta
1144 B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan
1145 B<< C<Ps = 97 / 107> >> fg/bg Bright White
1146 B<< C<Ps = 99 / 109> >> fg/bg Bright Default
1147
1148 =end table
1149
1150 =item B<< C<ESC [ Ps n> >>
1151
1152 Device Status Report (DSR)
1153
1154 =begin table
1155
1156 B<< C<Ps = 5> >> Status Report B<< C<ESC [ 0 n> >> (``OK'')
1157 B<< C<Ps = 6> >> Report Cursor Position (CPR) [row;column] as B<< C<ESC [ r ; c R> >>
1158 B<< C<Ps = 7> >> Request Display Name
1159 B<< C<Ps = 8> >> Request Version Number (place in window title)
1160
1161 =end table
1162
1163 =item B<< C<ESC [ Ps;Ps r> >>
1164
1165 Set Scrolling Region [top;bottom]
1166 [default: full size of window] (CSR)
1167
1168 =item B<< C<ESC [ s> >>
1169
1170 Save Cursor (SC)
1171
1172 =item B<< C<ESC [ Ps;Pt t> >>
1173
1174 Window Operations
1175
1176 =begin table
1177
1178 B<< C<Ps = 1> >> Deiconify (map) window
1179 B<< C<Ps = 2> >> Iconify window
1180 B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1181 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1182 B<< C<Ps = 5> >> Raise window
1183 B<< C<Ps = 6> >> Lower window
1184 B<< C<Ps = 7> >> Refresh screen once
1185 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1186 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1187 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1188 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1189 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1190 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1191 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1192 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
1193 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1194
1195 =end table
1196
1197 =item B<< C<ESC [ u> >>
1198
1199 Restore Cursor
1200
1201 =item B<< C<ESC [ Ps x> >>
1202
1203 Request Terminal Parameters (DECREQTPARM)
1204
1205 =back
1206
1207 X<PrivateModes>
1208
1209 =head1 DEC Private Modes
1210
1211 =over 4
1212
1213 =item B<< C<ESC [ ? Pm h> >>
1214
1215 DEC Private Mode Set (DECSET)
1216
1217 =item B<< C<ESC [ ? Pm l> >>
1218
1219 DEC Private Mode Reset (DECRST)
1220
1221 =item B<< C<ESC [ ? Pm r> >>
1222
1223 Restore previously saved DEC Private Mode Values.
1224
1225 =item B<< C<ESC [ ? Pm s> >>
1226
1227 Save DEC Private Mode Values.
1228
1229 =item B<< C<ESC [ ? Pm t> >>
1230
1231 Toggle DEC Private Mode Values (rxvt extension). I<where>
1232
1233 =over 4
1234
1235 =item B<< C<Ps = 1> >> (DECCKM)
1236
1237 =begin table
1238
1239 B<< C<h> >> Application Cursor Keys
1240 B<< C<l> >> Normal Cursor Keys
1241
1242 =end table
1243
1244 =item B<< C<Ps = 2> >> (ANSI/VT52 mode)
1245
1246 =begin table
1247
1248 B<< C<h> >> Enter VT52 mode
1249 B<< C<l> >> Enter VT52 mode
1250
1251 =end table
1252
1253 =item B<< C<Ps = 3> >>
1254
1255 =begin table
1256
1257 B<< C<h> >> 132 Column Mode (DECCOLM)
1258 B<< C<l> >> 80 Column Mode (DECCOLM)
1259
1260 =end table
1261
1262 =item B<< C<Ps = 4> >>
1263
1264 =begin table
1265
1266 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1267 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1268
1269 =end table
1270
1271 =item B<< C<Ps = 5> >>
1272
1273 =begin table
1274
1275 B<< C<h> >> Reverse Video (DECSCNM)
1276 B<< C<l> >> Normal Video (DECSCNM)
1277
1278 =end table
1279
1280 =item B<< C<Ps = 6> >>
1281
1282 =begin table
1283
1284 B<< C<h> >> Origin Mode (DECOM)
1285 B<< C<l> >> Normal Cursor Mode (DECOM)
1286
1287 =end table
1288
1289 =item B<< C<Ps = 7> >>
1290
1291 =begin table
1292
1293 B<< C<h> >> Wraparound Mode (DECAWM)
1294 B<< C<l> >> No Wraparound Mode (DECAWM)
1295
1296 =end table
1297
1298 =item B<< C<Ps = 8> >> I<unimplemented>
1299
1300 =begin table
1301
1302 B<< C<h> >> Auto-repeat Keys (DECARM)
1303 B<< C<l> >> No Auto-repeat Keys (DECARM)
1304
1305 =end table
1306
1307 =item B<< C<Ps = 9> >> X10 XTerm
1308
1309 =begin table
1310
1311 B<< C<h> >> Send Mouse X & Y on button press.
1312 B<< C<l> >> No mouse reporting.
1313
1314 =end table
1315
1316 =item B<< C<Ps = 10> >> (B<rxvt>)
1317
1318 =begin table
1319
1320 B<< C<h> >> menuBar visible
1321 B<< C<l> >> menuBar invisible
1322
1323 =end table
1324
1325 =item B<< C<Ps = 25> >>
1326
1327 =begin table
1328
1329 B<< C<h> >> Visible cursor {cnorm/cvvis}
1330 B<< C<l> >> Invisible cursor {civis}
1331
1332 =end table
1333
1334 =item B<< C<Ps = 30> >>
1335
1336 =begin table
1337
1338 B<< C<h> >> scrollBar visisble
1339 B<< C<l> >> scrollBar invisisble
1340
1341 =end table
1342
1343 =item B<< C<Ps = 35> >> (B<rxvt>)
1344
1345 =begin table
1346
1347 B<< C<h> >> Allow XTerm Shift+key sequences
1348 B<< C<l> >> Disallow XTerm Shift+key sequences
1349
1350 =end table
1351
1352 =item B<< C<Ps = 38> >> I<unimplemented>
1353
1354 Enter Tektronix Mode (DECTEK)
1355
1356 =item B<< C<Ps = 40> >>
1357
1358 =begin table
1359
1360 B<< C<h> >> Allow 80/132 Mode
1361 B<< C<l> >> Disallow 80/132 Mode
1362
1363 =end table
1364
1365 =item B<< C<Ps = 44> >> I<unimplemented>
1366
1367 =begin table
1368
1369 B<< C<h> >> Turn On Margin Bell
1370 B<< C<l> >> Turn Off Margin Bell
1371
1372 =end table
1373
1374 =item B<< C<Ps = 45> >> I<unimplemented>
1375
1376 =begin table
1377
1378 B<< C<h> >> Reverse-wraparound Mode
1379 B<< C<l> >> No Reverse-wraparound Mode
1380
1381 =end table
1382
1383 =item B<< C<Ps = 46> >> I<unimplemented>
1384
1385 =item B<< C<Ps = 47> >>
1386
1387 =begin table
1388
1389 B<< C<h> >> Use Alternate Screen Buffer
1390 B<< C<l> >> Use Normal Screen Buffer
1391
1392 =end table
1393
1394 X<Priv66>
1395
1396 =item B<< C<Ps = 66> >>
1397
1398 =begin table
1399
1400 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1401 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1402
1403 =end table
1404
1405 =item B<< C<Ps = 67> >>
1406
1407 =begin table
1408
1409 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1410 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1411
1412 =end table
1413
1414 =item B<< C<Ps = 1000> >> (X11 XTerm)
1415
1416 =begin table
1417
1418 B<< C<h> >> Send Mouse X & Y on button press and release.
1419 B<< C<l> >> No mouse reporting.
1420
1421 =end table
1422
1423 =item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented>
1424
1425 =begin table
1426
1427 B<< C<h> >> Use Hilite Mouse Tracking.
1428 B<< C<l> >> No mouse reporting.
1429
1430 =end table
1431
1432 =item B<< C<Ps = 1010> >> (B<rxvt>)
1433
1434 =begin table
1435
1436 B<< C<h> >> Don't scroll to bottom on TTY output
1437 B<< C<l> >> Scroll to bottom on TTY output
1438
1439 =end table
1440
1441 =item B<< C<Ps = 1011> >> (B<rxvt>)
1442
1443 =begin table
1444
1445 B<< C<h> >> Scroll to bottom when a key is pressed
1446 B<< C<l> >> Don't scroll to bottom when a key is pressed
1447
1448 =end table
1449
1450 =item B<< C<Ps = 1047> >>
1451
1452 =begin table
1453
1454 B<< C<h> >> Use Alternate Screen Buffer
1455 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1456
1457 =end table
1458
1459 =item B<< C<Ps = 1048> >>
1460
1461 =begin table
1462
1463 B<< C<h> >> Save cursor position
1464 B<< C<l> >> Restore cursor position
1465
1466 =end table
1467
1468 =item B<< C<Ps = 1049> >>
1469
1470 =begin table
1471
1472 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1473 B<< C<l> >> Use Normal Screen Buffer
1474
1475 =end table
1476
1477 =back
1478
1479 =back
1480
1481 X<XTerm>
1482
1483 =head1 XTerm Operating System Commands
1484
1485 =over 4
1486
1487 =item B<< C<ESC ] Ps;Pt ST> >>
1488
1489 Set XTerm Parameters. 8-bit ST: 0x9c, 7-bit ST sequence: ESC \ (0x1b,
1490 0x5c), backwards compatible terminator BEL (0x07) is also accepted. any
1491 B<octet> can be escaped by prefixing it with SYN (0x16, ^V).
1492
1493 =begin table
1494
1495 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>
1496 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1497 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
1498 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.
1499 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
1500 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1501 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1502 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1503 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1504 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1505 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >>
1506 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >>
1507 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>
1508 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1509 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1510 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1511 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> >>
1512 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1513 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).
1514 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar).
1515 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1516 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1517 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1518 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1519 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1520 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1521 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1522 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1523
1524 =end table
1525
1526 =back
1527
1528 X<menuBar>
1529
1530 =head1 menuBar
1531
1532 B<< The exact syntax used is I<almost> solidified. >>
1533 In the menus, B<DON'T> try to use menuBar commands that add or remove a
1534 menuBar.
1535
1536 Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1537 omitted: use B<./> to specify a menu relative to the current menu.
1538
1539 =head2 Overview of menuBar operation
1540
1541 For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1542 of C<Pt> can be used for a variety of tasks:
1543
1544 At the top level is the current menuBar which is a member of a circular
1545 linked-list of other such menuBars.
1546
1547 The menuBar acts as a parent for the various drop-down menus, which in
1548 turn, may have labels, separator lines, menuItems and subMenus.
1549
1550 The menuItems are the useful bits: you can use them to mimic keyboard
1551 input or even to send text or escape sequences back to rxvt.
1552
1553 The menuBar syntax is intended to provide a simple yet robust method of
1554 constructing and manipulating menus and navigating through the
1555 menuBars.
1556
1557 The first step is to use the tag B<< [menu:I<name>] >> which creates
1558 the menuBar called I<name> and allows access. You may now or menus,
1559 subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1560 menuBar access as B<readonly> to prevent accidental corruption of the
1561 menus. To re-access the current menuBar for alterations, use the tag
1562 B<[menu]>, make the alterations and then use B<[done]>
1563
1564 X<menuBarCommands>
1565
1566 =head2 Commands
1567
1568 =over 4
1569
1570 =item B<< [menu:+I<name>] >>
1571
1572 access the named menuBar for creation or alteration. If a new menuBar
1573 is created, it is called I<name> (max of 15 chars) and the current
1574 menuBar is pushed onto the stack
1575
1576 =item B<[menu]>
1577
1578 access the current menuBar for alteration
1579
1580 =item B<< [title:+I<string>] >>
1581
1582 set the current menuBar's title to I<string>, which may contain the
1583 following format specifiers:
1584
1585 B<%n> rxvt name (as per the B<-name> command-line option)
1586 B<%v> rxvt version
1587 B<%%> literal B<%> character
1588
1589 =item B<[done]>
1590
1591 set menuBar access as B<readonly>.
1592 End-of-file tag for B<< [read:+I<file>] >> operations.
1593
1594 =item B<< [read:+I<file>] >>
1595
1596 read menu commands directly from I<file> (extension ".menu" will be
1597 appended if required.) Start reading at a line with B<[menu]> or B<<
1598 [menu:+I<name> >> and continuing until B<[done]> is encountered.
1599
1600 Blank and comment lines (starting with B<#>) are ignored. Actually,
1601 since any invalid menu commands are also ignored, almost anything could
1602 be construed as a comment line, but this may be tightened up in the
1603 future ... so don't count on it!.
1604
1605 =item B<< [read:+I<file>;+I<name>] >>
1606
1607 The same as B<< [read:+I<file>] >>, but start reading at a line with
1608 B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1609 B<[done]> is encountered.
1610
1611 =item B<[dump]>
1612
1613 dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1614 later rereading.
1615
1616 =item B<[rm:name]>
1617
1618 remove the named menuBar
1619
1620 =item B<[rm] [rm:]>
1621
1622 remove the current menuBar
1623
1624 =item B<[rm*] [rm:*]>
1625
1626 remove all menuBars
1627
1628 =item B<[swap]>
1629
1630 swap the top two menuBars
1631
1632 =item B<[prev]>
1633
1634 access the previous menuBar
1635
1636 =item B<[next]>
1637
1638 access the next menuBar
1639
1640 =item B<[show]>
1641
1642 Enable display of the menuBar
1643
1644 =item B<[hide]>
1645
1646 Disable display of the menuBar
1647
1648 =item B<< [pixmap:+I<name>] >>
1649
1650 =item B<< [pixmap:+I<name>;I<scaling>] >>
1651
1652 (set the background pixmap globally
1653
1654 B<< A Future implementation I<may> make this local to the menubar >>)
1655
1656 =item B<< [:+I<command>:] >>
1657
1658 ignore the menu readonly status and issue a I<command> to or a menu or
1659 menuitem or change the ; a useful shortcut for setting the quick arrows
1660 from a menuBar.
1661
1662 =back
1663
1664 X<menuBarAdd>
1665
1666 =head2 Adding and accessing menus
1667
1668 The following commands may also be B<+> prefixed.
1669
1670 =over 4
1671
1672 =item B</+>
1673
1674 access menuBar top level
1675
1676 =item B<./+>
1677
1678 access current menu level
1679
1680 =item B<../+>
1681
1682 access parent menu (1 level up)
1683
1684 =item B<../../>
1685
1686 access parent menu (multiple levels up)
1687
1688 =item B<< I</path/>menu >>
1689
1690 add/access menu
1691
1692 =item B<< I</path/>menu/* >>
1693
1694 add/access menu and clear it if it exists
1695
1696 =item B<< I</path/>{-} >>
1697
1698 add separator
1699
1700 =item B<< I</path/>{item} >>
1701
1702 add B<item> as a label
1703
1704 =item B<< I</path/>{item} action >>
1705
1706 add/alter I<menuitem> with an associated I<action>
1707
1708 =item B<< I</path/>{item}{right-text} >>
1709
1710 add/alter I<menuitem> with B<right-text> as the right-justified text
1711 and as the associated I<action>
1712
1713 =item B<< I</path/>{item}{rtext} action >>
1714
1715 add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1716 the right-justified text.
1717
1718 =back
1719
1720 =over 4
1721
1722 =item Special characters in I<action> must be backslash-escaped:
1723
1724 B<\a \b \E \e \n \r \t \octal>
1725
1726 =item or in control-character notation:
1727
1728 B<^@, ^A .. ^Z .. ^_, ^?>
1729
1730 =back
1731
1732 To send a string starting with a B<NUL> (B<^@>) character to the
1733 program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1734 the first of which will be stripped off and the balance directed to the
1735 program. Otherwise if I<action> begins with B<NUL> followed by
1736 non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1737 balance is sent back to rxvt.
1738
1739 As a convenience for the many Emacs-type editors, I<action> may start
1740 with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1741 appended if missed from B<M-x> commands.
1742
1743 As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1744 quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1745
1746 =over 4
1747
1748 =item For example,
1749
1750 B<M-xapropos> is equivalent to B<\Exapropos\r>
1751
1752 =item and
1753
1754 B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1755
1756 =back
1757
1758 The option B<< {I<right-rtext>} >> will be right-justified. In the
1759 absence of a specified action, this text will be used as the I<action>
1760 as well.
1761
1762 =over 4
1763
1764 =item For example,
1765
1766 B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1767
1768 =back
1769
1770 The left label I<is> necessary, since it's used for matching, but
1771 implicitly hiding the left label (by using same name for both left and
1772 right labels), or explicitly hiding the left label (by preceeding it
1773 with a dot), makes it possible to have right-justified text only.
1774
1775 =over 4
1776
1777 =item For example,
1778
1779 B</File/{Open}{Open} Open-File-Action>
1780
1781 =item or hiding it
1782
1783 B</File/{.anylabel}{Open} Open-File-Action>
1784
1785 =back
1786
1787 X<menuBarRemove>
1788
1789 =head2 Removing menus
1790
1791 =over 4
1792
1793 =item B<< -/*+ >>
1794
1795 remove all menus from the menuBar, the same as B<[clear]>
1796
1797 =item B<< -+I</path>menu+ >>
1798
1799 remove menu
1800
1801 =item B<< -+I</path>{item}+ >>
1802
1803 remove item
1804
1805 =item B<< -+I</path>{-} >>
1806
1807 remove separator)
1808
1809 =item B<-/path/menu/*>
1810
1811 remove all items, separators and submenus from menu
1812
1813 =back
1814
1815 X<menuBarArrows>
1816
1817 =head2 Quick Arrows
1818
1819 The menus also provide a hook for I<quick arrows> to provide easier
1820 user access. If nothing has been explicitly set, the default is to
1821 emulate the curror keys. The syntax permits each arrow to be altered
1822 individually or all four at once without re-entering their common
1823 beginning/end text. For example, to explicitly associate cursor actions
1824 with the arrows, any of the following forms could be used:
1825
1826 =over 4
1827
1828 =item B<< <r>+I<Right> >>
1829
1830 =item B<< <l>+I<Left> >>
1831
1832 =item B<< <u>+I<Up> >>
1833
1834 =item B<< <d>+I<Down> >>
1835
1836 Define actions for the respective arrow buttons
1837
1838 =item B<< <b>+I<Begin> >>
1839
1840 =item B<< <e>+I<End> >>
1841
1842 Define common beginning/end parts for I<quick arrows> which used in
1843 conjunction with the above <r> <l> <u> <d> constructs
1844
1845 =back
1846
1847 =over 4
1848
1849 =item For example, define arrows individually,
1850
1851 <u>\E[A
1852
1853 <d>\E[B
1854
1855 <r>\E[C
1856
1857 <l>\E[D
1858
1859 =item or all at once
1860
1861 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1862
1863 =item or more compactly (factoring out common parts)
1864
1865 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1866
1867 =back
1868
1869 X<menuBarSummary>
1870
1871 =head2 Command Summary
1872
1873 A short summary of the most I<common> commands:
1874
1875 =over 4
1876
1877 =item [menu:name]
1878
1879 use an existing named menuBar or start a new one
1880
1881 =item [menu]
1882
1883 use the current menuBar
1884
1885 =item [title:string]
1886
1887 set menuBar title
1888
1889 =item [done]
1890
1891 set menu access to readonly and, if reading from a file, signal EOF
1892
1893 =item [done:name]
1894
1895 if reading from a file using [read:file;name] signal EOF
1896
1897 =item [rm:name]
1898
1899 remove named menuBar(s)
1900
1901 =item [rm] [rm:]
1902
1903 remove current menuBar
1904
1905 =item [rm*] [rm:*]
1906
1907 remove all menuBar(s)
1908
1909 =item [swap]
1910
1911 swap top two menuBars
1912
1913 =item [prev]
1914
1915 access the previous menuBar
1916
1917 =item [next]
1918
1919 access the next menuBar
1920
1921 =item [show]
1922
1923 map menuBar
1924
1925 =item [hide]
1926
1927 unmap menuBar
1928
1929 =item [pixmap;file]
1930
1931 =item [pixmap;file;scaling]
1932
1933 set a background pixmap
1934
1935 =item [read:file]
1936
1937 =item [read:file;name]
1938
1939 read in a menu from a file
1940
1941 =item [dump]
1942
1943 dump out all menuBars to /tmp/rxvt-PID
1944
1945 =item /
1946
1947 access menuBar top level
1948
1949 =item ./
1950
1951 =item ../
1952
1953 =item ../../
1954
1955 access current or parent menu level
1956
1957 =item /path/menu
1958
1959 add/access menu
1960
1961 =item /path/{-}
1962
1963 add separator
1964
1965 =item /path/{item}{rtext} action
1966
1967 add/alter menu item
1968
1969 =item -/*
1970
1971 remove all menus from the menuBar
1972
1973 =item -/path/menu
1974
1975 remove menu items, separators and submenus from menu
1976
1977 =item -/path/menu
1978
1979 remove menu
1980
1981 =item -/path/{item}
1982
1983 remove item
1984
1985 =item -/path/{-}
1986
1987 remove separator
1988
1989 =item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1990
1991 menu quick arrows
1992
1993 =back
1994 X<XPM>
1995
1996 =head1 XPM
1997
1998 For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1999 of B<< C<Pt> >> can be the name of the background pixmap followed by a
2000 sequence of scaling/positioning commands separated by semi-colons. The
2001 scaling/positioning commands are as follows:
2002
2003 =over 4
2004
2005 =item query scale/position
2006
2007 B<?>
2008
2009 =item change scale and position
2010
2011 B<WxH+X+Y>
2012
2013 B<WxH+X> (== B<WxH+X+X>)
2014
2015 B<WxH> (same as B<WxH+50+50>)
2016
2017 B<W+X+Y> (same as B<WxW+X+Y>)
2018
2019 B<W+X> (same as B<WxW+X+X>)
2020
2021 B<W> (same as B<WxW+50+50>)
2022
2023 =item change position (absolute)
2024
2025 B<=+X+Y>
2026
2027 B<=+X> (same as B<=+X+Y>)
2028
2029 =item change position (relative)
2030
2031 B<+X+Y>
2032
2033 B<+X> (same as B<+X+Y>)
2034
2035 =item rescale (relative)
2036
2037 B<Wx0> -> B<W *= (W/100)>
2038
2039 B<0xH> -> B<H *= (H/100)>
2040
2041 =back
2042
2043 For example:
2044
2045 =over 4
2046
2047 =item B<\E]20;funky\a>
2048
2049 load B<funky.xpm> as a tiled image
2050
2051 =item B<\E]20;mona;100\a>
2052
2053 load B<mona.xpm> with a scaling of 100%
2054
2055 =item B<\E]20;;200;?\a>
2056
2057 rescale the current pixmap to 200% and display the image geometry in
2058 the title
2059
2060 =back
2061 X<Mouse>
2062
2063 =head1 Mouse Reporting
2064
2065 =over 4
2066
2067 =item B<< C<< ESC [ M <b> <x> <y> >> >>
2068
2069 report mouse position
2070
2071 =back
2072
2073 The lower 2 bits of B<< C<< <b> >> >> indicate the button:
2074
2075 =over 4
2076
2077 =item Button = B<< C<< (<b> - SPACE) & 3 >> >>
2078
2079 =begin table
2080
2081 0 Button1 pressed
2082 1 Button2 pressed
2083 2 Button3 pressed
2084 3 button released (X11 mouse report)
2085
2086 =end table
2087
2088 =back
2089
2090 The upper bits of B<< C<< <b> >> >> indicate the modifiers when the
2091 button was pressed and are added together (X11 mouse report only):
2092
2093 =over 4
2094
2095 =item State = B<< C<< (<b> - SPACE) & 60 >> >>
2096
2097 =begin table
2098
2099 4 Shift
2100 8 Meta
2101 16 Control
2102 32 Double Click I<(Rxvt extension)>
2103
2104 =end table
2105
2106 Col = B<< C<< <x> - SPACE >> >>
2107
2108 Row = B<< C<< <y> - SPACE >> >>
2109
2110 =back
2111 X<KeyCodes>
2112
2113 =head1 Key Codes
2114
2115 Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
2116
2117 For the keypad, use B<Shift> to temporarily override Application-Keypad
2118 setting use B<Num_Lock> to toggle Application-Keypad setting if
2119 B<Num_Lock> is off, toggle Application-Keypad setting. Also note that
2120 values of B<Home>, B<End>, B<Delete> may have been compiled differently on
2121 your system.
2122
2123 =begin table
2124
2125 B<Normal> B<Shift> B<Control> B<Ctrl+Shift>
2126 Tab ^I ESC [ Z ^I ESC [ Z
2127 BackSpace ^H ^? ^? ^?
2128 Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @
2129 Insert ESC [ 2 ~ I<paste> ESC [ 2 ^ ESC [ 2 @
2130 Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
2131 Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @
2132 Prior ESC [ 5 ~ I<scroll-up> ESC [ 5 ^ ESC [ 5 @
2133 Next ESC [ 6 ~ I<scroll-down> ESC [ 6 ^ ESC [ 6 @
2134 Home ESC [ 7 ~ ESC [ 7 $ ESC [ 7 ^ ESC [ 7 @
2135 End ESC [ 8 ~ ESC [ 8 $ ESC [ 8 ^ ESC [ 8 @
2136 Delete ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
2137 F1 ESC [ 11 ~ ESC [ 23 ~ ESC [ 11 ^ ESC [ 23 ^
2138 F2 ESC [ 12 ~ ESC [ 24 ~ ESC [ 12 ^ ESC [ 24 ^
2139 F3 ESC [ 13 ~ ESC [ 25 ~ ESC [ 13 ^ ESC [ 25 ^
2140 F4 ESC [ 14 ~ ESC [ 26 ~ ESC [ 14 ^ ESC [ 26 ^
2141 F5 ESC [ 15 ~ ESC [ 28 ~ ESC [ 15 ^ ESC [ 28 ^
2142 F6 ESC [ 17 ~ ESC [ 29 ~ ESC [ 17 ^ ESC [ 29 ^
2143 F7 ESC [ 18 ~ ESC [ 31 ~ ESC [ 18 ^ ESC [ 31 ^
2144 F8 ESC [ 19 ~ ESC [ 32 ~ ESC [ 19 ^ ESC [ 32 ^
2145 F9 ESC [ 20 ~ ESC [ 33 ~ ESC [ 20 ^ ESC [ 33 ^
2146 F10 ESC [ 21 ~ ESC [ 34 ~ ESC [ 21 ^ ESC [ 34 ^
2147 F11 ESC [ 23 ~ ESC [ 23 $ ESC [ 23 ^ ESC [ 23 @
2148 F12 ESC [ 24 ~ ESC [ 24 $ ESC [ 24 ^ ESC [ 24 @
2149 F13 ESC [ 25 ~ ESC [ 25 $ ESC [ 25 ^ ESC [ 25 @
2150 F14 ESC [ 26 ~ ESC [ 26 $ ESC [ 26 ^ ESC [ 26 @
2151 F15 (Help) ESC [ 28 ~ ESC [ 28 $ ESC [ 28 ^ ESC [ 28 @
2152 F16 (Menu) ESC [ 29 ~ ESC [ 29 $ ESC [ 29 ^ ESC [ 29 @
2153 F17 ESC [ 31 ~ ESC [ 31 $ ESC [ 31 ^ ESC [ 31 @
2154 F18 ESC [ 32 ~ ESC [ 32 $ ESC [ 32 ^ ESC [ 32 @
2155 F19 ESC [ 33 ~ ESC [ 33 $ ESC [ 33 ^ ESC [ 33 @
2156 F20 ESC [ 34 ~ ESC [ 34 $ ESC [ 34 ^ ESC [ 34 @
2157 B<Application>
2158 Up ESC [ A ESC [ a ESC O a ESC O A
2159 Down ESC [ B ESC [ b ESC O b ESC O B
2160 Right ESC [ C ESC [ c ESC O c ESC O C
2161 Left ESC [ D ESC [ d ESC O d ESC O D
2162 KP_Enter ^M ESC O M
2163 KP_F1 ESC O P ESC O P
2164 KP_F2 ESC O Q ESC O Q
2165 KP_F3 ESC O R ESC O R
2166 KP_F4 ESC O S ESC O S
2167 XK_KP_Multiply * ESC O j
2168 XK_KP_Add + ESC O k
2169 XK_KP_Separator , ESC O l
2170 XK_KP_Subtract - ESC O m
2171 XK_KP_Decimal . ESC O n
2172 XK_KP_Divide / ESC O o
2173 XK_KP_0 0 ESC O p
2174 XK_KP_1 1 ESC O q
2175 XK_KP_2 2 ESC O r
2176 XK_KP_3 3 ESC O s
2177 XK_KP_4 4 ESC O t
2178 XK_KP_5 5 ESC O u
2179 XK_KP_6 6 ESC O v
2180 XK_KP_7 7 ESC O w
2181 XK_KP_8 8 ESC O x
2182 XK_KP_9 9 ESC O y
2183
2184 =end table
2185
2186 =head1 CONFIGURE OPTIONS
2187
2188 General hint: if you get compile errors, then likely your configuration
2189 hasn't been tested well. Either try with --enable-everything or use the
2190 ./reconf script as a base for experiments. ./reconf is used by myself,
2191 so it should generally be a working config. Of course, you should always
2192 report when a combination doesn't work, so it can be fixed. Marc Lehmann
2193 <rxvt@schmorp.de>.
2194
2195 =over 4
2196
2197 =item --enable-everything
2198
2199 Add support for all non-multichoice options listed in "./configure
2200 --help". Note that unlike other enable options this is order dependant.
2201 You can specify this and then disable options which this enables by
2202 I<following> this with the appropriate commands.
2203
2204 =item --enable-xft
2205
2206 Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2207 slower and require lots of memory, but as long as you don't use them, you
2208 don't pay for them.
2209
2210 =item --enable-font-styles
2211
2212 Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2213 styles. The fonts can be set manually or automatically.
2214
2215 =item --with-codesets=NAME,...
2216
2217 Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2218 are always compiled in, which includes most 8-bit character sets). These
2219 codeset tables are used for driving X11 core fonts, they are not required
2220 for Xft fonts, although having them compiled in lets rxvt-unicode choose
2221 replacement fonts more intelligently. Compiling them in will make your
2222 binary bigger (all of together cost about 700kB), but it doesn't increase
2223 memory usage unless you use a font requiring one of these encodings.
2224
2225 =begin table
2226
2227 all all available codeset groups
2228 zh common chinese encodings
2229 zh_ext rarely used but very big chinese encodigs
2230 jp common japanese encodings
2231 jp_ext rarely used but big japanese encodings
2232 kr korean encodings
2233
2234 =end table
2235
2236 =item --enable-xim
2237
2238 Add support for XIM (X Input Method) protocol. This allows using
2239 alternative input methods (e.g. kinput2) and will also correctly
2240 set up the input for people using dead keys or compose keys.
2241
2242 =item --enable-unicode3
2243
2244 Enable direct support for displaying unicode codepoints above
2245 65535 (the basic multilingual page). This increases storage
2246 requirements per character from 2 to 4 bytes. X11 fonts do not yet
2247 support these extra characters, but Xft does.
2248
2249 Please note that rxvt-unicode can store unicode code points >65535
2250 even without this flag, but the number of such characters is
2251 limited to a view thousand (shared with combining characters,
2252 see next switch), and right now rxvt-unicode cannot display them
2253 (input/output and cut&paste still work, though).
2254
2255 =item --enable-combining
2256
2257 Enable automatic composition of combining characters into
2258 composite characters. This is required for proper viewing of text
2259 where accents are encoded as seperate unicode characters. This is
2260 done by using precomposited characters when available or creating
2261 new pseudo-characters when no precomposed form exists.
2262
2263 Without --enable-unicode3, the number of additional precomposed characters
2264 is rather limited (2048, if this is full, rxvt-unicode will use the
2265 private use area, extending the number of combinations to 8448). With
2266 --enable-unicode3, no practical limit exists.
2267
2268 This option will also enable storage (but not display) of characters
2269 beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2270
2271 The combining table also contains entries for arabic presentation forms,
2272 but these are not currently used. Bug me if you want these to be used (and
2273 tell me how these are to be used...).
2274
2275 =item --enable-fallback(=CLASS)
2276
2277 When reading resource settings, also read settings for class CLASS
2278 (default: Rxvt). To disable resource fallback use --disable-fallback.
2279
2280 =item --with-res-name=NAME
2281
2282 Use the given name (default: urxvt) as default application name when
2283 reading resources. Specify --with-res-name=rxvt to replace rxvt.
2284
2285 =item --with-res-class=CLASS
2286
2287 Use the given class (default: URxvt) as default application class
2288 when reading resources. Specify --with-res-class=Rxvt to replace
2289 rxvt.
2290
2291 =item --enable-utmp
2292
2293 Write user and tty to utmp file (used by programs like F<w>) at
2294 start of rxvt execution and delete information when rxvt exits.
2295
2296 =item --enable-wtmp
2297
2298 Write user and tty to wtmp file (used by programs like F<last>) at
2299 start of rxvt execution and write logout when rxvt exits. This
2300 option requires --enable-utmp to also be specified.
2301
2302 =item --enable-lastlog
2303
2304 Write user and tty to lastlog file (used by programs like
2305 F<lastlogin>) at start of rxvt execution. This option requires
2306 --enable-utmp to also be specified.
2307
2308 =item --enable-xpm-background
2309
2310 Add support for XPM background pixmaps.
2311
2312 =item --enable-transparency
2313
2314 Add support for inheriting parent backgrounds thus giving a fake
2315 transparency to the term.
2316
2317 =item --enable-fading
2318
2319 Add support for fading the text when focus is lost.
2320
2321 =item --enable-tinting
2322
2323 Add support for tinting of transparent backgrounds.
2324
2325 =item --enable-menubar
2326
2327 Add support for our menu bar system (this interacts badly with
2328 dynamic locale switching currently).
2329
2330 =item --enable-rxvt-scroll
2331
2332 Add support for the original rxvt scrollbar.
2333
2334 =item --enable-next-scroll
2335
2336 Add support for a NeXT-like scrollbar.
2337
2338 =item --enable-xterm-scroll
2339
2340 Add support for an Xterm-like scrollbar.
2341
2342 =item --enable-plain-scroll
2343
2344 Add support for a very unobtrusive, plain-looking scrollbar that
2345 is the favourite of the rxvt-unicode author, having used it for
2346 many years.
2347
2348 =item --enable-half-shadow
2349
2350 Make shadows on the scrollbar only half the normal width & height.
2351 only applicable to rxvt scrollbars.
2352
2353 =item --enable-ttygid
2354
2355 Change tty device setting to group "tty" - only use this if
2356 your system uses this type of security.
2357
2358 =item --disable-backspace-key
2359
2360 Disable any handling of the backspace key by us - let the X server
2361 do it.
2362
2363 =item --disable-delete-key
2364
2365 Disable any handling of the delete key by us - let the X server
2366 do it.
2367
2368 =item --disable-resources
2369
2370 Remove all resources checking.
2371
2372 =item --enable-xgetdefault
2373
2374 Make resources checking via XGetDefault() instead of our small
2375 version which only checks ~/.Xdefaults, or if that doesn't exist then
2376 ~/.Xresources.
2377
2378 Please note that nowadays, things like XIM will automatically pull in and
2379 use the full X resource manager, so the overhead of using it might be very
2380 small, if nonexistant.
2381
2382 =item --enable-strings
2383
2384 Add support for our possibly faster memset() function and other
2385 various routines, overriding your system's versions which may
2386 have been hand-crafted in assembly or may require extra libraries
2387 to link in. (this breaks ANSI-C rules and has problems on many
2388 GNU/Linux systems).
2389
2390 =item --disable-swapscreen
2391
2392 Remove support for swap screen.
2393
2394 =item --enable-frills
2395
2396 Add support for many small features that are not essential but nice to
2397 have. Normally you want this, but for very small binaries you may want to
2398 disable this.
2399
2400 A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2401 in combination with other switches) is:
2402
2403 MWM-hints
2404 EWMH-hints (pid, utf8 names) and protocols (ping)
2405 seperate underline colour
2406 settable border widths and borderless switch
2407 settable extra linespacing
2408 iso-14755-2 and -3, and visual feedback
2409 backindex and forwardindex escape sequence
2410 window op and some xterm/OSC escape sequences
2411 tripleclickwords
2412 settable insecure mode
2413 keysym remapping support
2414 cursor blinking and underline cursor
2415 -embed and -pty-fd options
2416
2417 =item --enable-iso14755
2418
2419 Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2420 F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2421 C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2422 this switch.
2423
2424 =item --enable-keepscrolling
2425
2426 Add support for continual scrolling of the display when you hold
2427 the mouse button down on a scrollbar arrow.
2428
2429 =item --enable-mousewheel
2430
2431 Add support for scrolling via mouse wheel or buttons 4 & 5.
2432
2433 =item --enable-slipwheeling
2434
2435 Add support for continual scrolling (using the mouse wheel as an
2436 accelerator) while the control key is held down. This option
2437 requires --enable-mousewheel to also be specified.
2438
2439 =item --disable-new-selection
2440
2441 Remove support for mouse selection style like that of xterm.
2442
2443 =item --enable-dmalloc
2444
2445 Use Gray Watson's malloc - which is good for debugging See
2446 http://www.letters.com/dmalloc/ for details If you use either this or the
2447 next option, you may need to edit src/Makefile after compiling to point
2448 DINCLUDE and DLIB to the right places.
2449
2450 You can only use either this option and the following (should
2451 you use either) .
2452
2453 =item --enable-dlmalloc
2454
2455 Use Doug Lea's malloc - which is good for a production version
2456 See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2457
2458 =item --enable-smart-resize
2459
2460 Add smart growth/shrink behaviour when changing font size via from hot
2461 keys. This should keep in a fixed position the rxvt corner which is
2462 closest to a corner of the screen.
2463
2464 =item --enable-pointer-blank
2465
2466 Add support to have the pointer disappear when typing or inactive.
2467
2468 =item --with-name=NAME
2469
2470 Set the basename for the installed binaries (default: C<urxvt>, resulting
2471 in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2472 C<rxvt>.
2473
2474 =item --with-term=NAME
2475
2476 Change the environmental variable for the terminal to NAME (default
2477 C<rxvt-unicode>)
2478
2479 =item --with-terminfo=PATH
2480
2481 Change the environmental variable for the path to the terminfo tree to
2482 PATH.
2483
2484 =item --with-x
2485
2486 Use the X Window System (pretty much default, eh?).
2487
2488 =item --with-xpm-includes=DIR
2489
2490 Look for the XPM includes in DIR.
2491
2492 =item --with-xpm-library=DIR
2493
2494 Look for the XPM library in DIR.
2495
2496 =item --with-xpm
2497
2498 Not needed - define via --enable-xpm-background.
2499
2500 =back
2501
2502 =head1 AUTHORS
2503
2504 Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
2505 reworked it from the original Rxvt documentation, which was done by Geoff
2506 Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other
2507 sources.
2508