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