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