ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.143 by ayin, Thu Aug 2 00:09:54 2007 UTC vs.
Revision 1.243 by sf-exg, Tue Jun 21 12:03:55 2016 UTC

17 17
18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting 18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19all escape sequences, and other background information. 19all escape sequences, and other background information.
20 20
21The newest version of this document is also available on the World Wide Web at 21The newest version of this document is also available on the World Wide Web at
22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>. 22L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23
24The main manual page for @@RXVT_NAME@@ itself is available at
25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
23 26
24=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS 27=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
25 28
26 29
27=head2 Meta, Features & Commandline Issues 30=head2 Meta, Features & Commandline Issues
29=head3 My question isn't answered here, can I ask a human? 32=head3 My question isn't answered here, can I ask a human?
30 33
31Before sending me mail, you could go to IRC: C<irc.freenode.net>, 34Before sending me mail, you could go to IRC: C<irc.freenode.net>,
32channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be 35channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
33interested in learning about new and exciting problems (but not FAQs :). 36interested in learning about new and exciting problems (but not FAQs :).
37
38=head3 I use Gentoo, and I have a problem...
39
40There are two big problems with Gentoo Linux: first, most if not all
41Gentoo systems are completely broken (missing or mismatched header
42files, broken compiler etc. are just the tip of the iceberg);
43secondly, it should be called Gentoo GNU/Linux.
44
45For these reasons, it is impossible to support rxvt-unicode on
46Gentoo. Problems appearing on Gentoo systems will usually simply be
47ignored unless they can be reproduced on non-Gentoo systems.
34 48
35=head3 Does it support tabs, can I have a tabbed rxvt-unicode? 49=head3 Does it support tabs, can I have a tabbed rxvt-unicode?
36 50
37Beginning with version 7.3, there is a perl extension that implements a 51Beginning with version 7.3, there is a perl extension that implements a
38simple tabbed terminal. It is installed by default, so any of these should 52simple tabbed terminal. It is installed by default, so any of these should
90This tries to create a new terminal, and if fails with exit status 2, 104This tries to create a new terminal, and if fails with exit status 2,
91meaning it couldn't connect to the daemon, it will start the daemon and 105meaning it couldn't connect to the daemon, it will start the daemon and
92re-run the command. Subsequent invocations of the script will re-use the 106re-run the command. Subsequent invocations of the script will re-use the
93existing daemon. 107existing daemon.
94 108
95=head3 How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc. 109=head3 How do I distinguish whether I'm running rxvt-unicode or a regular
110xterm? I need this to decide about setting colours etc.
96 111
97The original rxvt and rxvt-unicode always export the variable "COLORTERM", 112The original rxvt and rxvt-unicode always export the variable "COLORTERM",
98so you can check and see if that is set. Note that several programs, JED, 113so you can check and see if that is set. Note that several programs, JED,
99slrn, Midnight Commander automatically check this variable to decide 114slrn, Midnight Commander automatically check this variable to decide
100whether or not to use color. 115whether or not to use colour.
101 116
102=head3 How do I set the correct, full IP address for the DISPLAY variable? 117=head3 How do I set the correct, full IP address for the DISPLAY variable?
103 118
104If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled 119If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
105insecure mode then it is possible to use the following shell script 120insecure mode then it is possible to use the following shell script
113 128
114 # Bourne/Korn/POSIX family of shells: 129 # Bourne/Korn/POSIX family of shells:
115 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know 130 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
116 if [ ${TERM:-foo} = xterm ]; then 131 if [ ${TERM:-foo} = xterm ]; then
117 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not 132 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
118 echo -n '^[Z' 133 printf "\eZ"
119 read term_id 134 read term_id
120 stty icanon echo 135 stty icanon echo
121 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then 136 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
122 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string 137 printf '\e[7n' # query the rxvt we are in for the DISPLAY string
123 read DISPLAY # set it in our local shell 138 read DISPLAY # set it in our local shell
124 fi 139 fi
125 fi 140 fi
126 141
127=head3 How do I compile the manual pages on my own? 142=head3 How do I compile the manual pages on my own?
128 143
183the case of rxvt-unicode this hardly matters, as its portability limits 198the case of rxvt-unicode this hardly matters, as its portability limits
184are defined by things like X11, pseudo terminals, locale support and unix 199are defined by things like X11, pseudo terminals, locale support and unix
185domain sockets, which are all less portable than C++ itself. 200domain sockets, which are all less portable than C++ itself.
186 201
187Regarding the bloat, see the above question: It's easy to write programs 202Regarding the bloat, see the above question: It's easy to write programs
188in C that use gobs of memory, an certainly possible to write programs in 203in C that use gobs of memory, and certainly possible to write programs in
189C++ that don't. C++ also often comes with large libraries, but this is 204C++ that don't. C++ also often comes with large libraries, but this is
190not necessarily the case with GCC. Here is what rxvt links against on my 205not necessarily the case with GCC. Here is what rxvt links against on my
191system with a minimal config: 206system with a minimal config:
192 207
193 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) 208 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
197 212
198And here is rxvt-unicode: 213And here is rxvt-unicode:
199 214
200 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) 215 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
201 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) 216 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
202 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) 217 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
203 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) 218 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
204 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) 219 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
205 220
206No large bloated libraries (of course, none were linked in statically), 221No large bloated libraries (of course, none were linked in statically),
207except maybe libX11 :) 222except maybe libX11 :)
208 223
209 224
217of passage: ... and you failed. 232of passage: ... and you failed.
218 233
219Here are four ways to get transparency. B<Do> read the manpage and option 234Here are four ways to get transparency. B<Do> read the manpage and option
220descriptions for the programs mentioned and rxvt-unicode. Really, do it! 235descriptions for the programs mentioned and rxvt-unicode. Really, do it!
221 236
2221. Use inheritPixmap: 2371. Use transparent mode:
223 238
224 Esetroot wallpaper.jpg 239 Esetroot wallpaper.jpg
225 @@URXVT_NAME@@ -ip -tint red -sh 40 240 @@URXVT_NAME@@ -tr -tint red -sh 40
226 241
227That works. If you think it doesn't, you lack transparency and tinting 242That works. If you think it doesn't, you lack transparency and tinting
228support, or you are unable to read. 243support, or you are unable to read.
244This method requires that the background-setting program sets the
245_XROOTPMAP_ID or ESETROOT_PMAP_ID property. Compatible programs
246are Esetroot, hsetroot and feh.
229 247
2302. Use a simple pixmap and emulate pseudo-transparency. This enables you 2482. Use a simple pixmap and emulate pseudo-transparency. This enables you
231to use effects other than tinting and shading: Just shade/tint/whatever 249to use effects other than tinting and shading: Just shade/tint/whatever
232your picture with gimp or any other tool: 250your picture with gimp or any other tool:
233 251
234 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm 252 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
235 @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background 253 @@URXVT_NAME@@ -pixmap "background.jpg;:root"
236 254
237That works. If you think it doesn't, you lack XPM and Perl support, or you 255That works. If you think it doesn't, you lack GDK-PixBuf support, or you
238are unable to read. 256are unable to read.
239 257
2403. Use an ARGB visual: 2583. Use an ARGB visual:
241 259
242 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc 260 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
342=head3 What's with this bold/blink stuff? 360=head3 What's with this bold/blink stuff?
343 361
344If no bold colour is set via C<colorBD:>, bold will invert text using the 362If no bold colour is set via C<colorBD:>, bold will invert text using the
345standard foreground colour. 363standard foreground colour.
346 364
347For the standard background colour, blinking will actually make the 365For the standard background colour, blinking will actually make
348text blink when compiled with C<--enable-blinking>. with standard 366the text blink when compiled with C<--enable-text-blink>. Without
349colours. Without C<--enable-blinking>, the blink attribute will be 367C<--enable-text-blink>, the blink attribute will be ignored.
350ignored.
351 368
352On ANSI colours, bold/blink attributes are used to set high-intensity 369On ANSI colours, bold/blink attributes are used to set high-intensity
353foreground/background colors. 370foreground/background colours.
354 371
355color0-7 are the low-intensity colors. 372color0-7 are the low-intensity colours.
356 373
357color8-15 are the corresponding high-intensity colors. 374color8-15 are the corresponding high-intensity colours.
358 375
359=head3 I don't like the screen colors. How do I change them? 376=head3 I don't like the screen colours. How do I change them?
360 377
361You can change the screen colors at run-time using F<~/.Xdefaults> 378You can change the screen colours at run-time using F<~/.Xdefaults>
362resources (or as long-options). 379resources (or as long-options).
363 380
364Here are values that are supposed to resemble a VGA screen, 381Here are values that are supposed to resemble a VGA screen,
365including the murky brown that passes for low-intensity yellow: 382including the murky brown that passes for low-intensity yellow:
366 383
380 URxvt.color12: #0000FF 397 URxvt.color12: #0000FF
381 URxvt.color13: #FF00FF 398 URxvt.color13: #FF00FF
382 URxvt.color14: #00FFFF 399 URxvt.color14: #00FFFF
383 URxvt.color15: #FFFFFF 400 URxvt.color15: #FFFFFF
384 401
385And here is a more complete set of non-standard colors. 402And here is a more complete set of non-standard colours.
386 403
387 URxvt.cursorColor: #dc74d1 404 URxvt.cursorColor: #dc74d1
388 URxvt.pointerColor: #dc74d1 405 URxvt.pointerColor: #dc74d1
389 URxvt.background: #0e0e0e 406 URxvt.background: #0e0e0e
390 URxvt.foreground: #4ad5e1 407 URxvt.foreground: #4ad5e1
460has been designed yet). 477has been designed yet).
461 478
462Until then, you might get away with switching fonts at runtime (see L<Can 479Until then, you might get away with switching fonts at runtime (see L<Can
463I switch the fonts at runtime?> later in this document). 480I switch the fonts at runtime?> later in this document).
464 481
482=head3 How can I make mplayer display video correctly?
483
484We are working on it, in the meantime, as a workaround, use something like:
485
486 @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
487
488=head3 Why is the cursor now blinking in emacs/vi/...?
489
490This is likely caused by your editor/program's use of the C<cvvis>
491terminfo capability. Emacs uses it by default, as well as some versions of
492vi and possibly other programs.
493
494In emacs, you can switch that off by adding this to your C<.emacs> file:
495
496 (setq visible-cursor nil)
497
498For other programs, if they do not have an option, your have to remove the
499C<cvvis> capability from the terminfo description.
500
501When @@URXVT_NAME@@ first added the blinking cursor option, it didn't
502add a C<cvvis> capability, which served no purpose before. Version 9.21
503introduced C<cvvis> (and the ability to control blinking independent of
504cursor shape) for compatibility with other terminals, which traditionally
505use a blinking cursor for C<cvvis>. This also reflects the intent of
506programs such as emacs, who expect C<cvvis> to enable a blinking cursor.
507
465=head2 Keyboard, Mouse & User Interaction 508=head2 Keyboard, Mouse & User Interaction
466 509
467=head3 The new selection selects pieces that are too big, how can I select single words? 510=head3 The new selection selects pieces that are too big, how can I select single words?
468 511
469If you want to select e.g. alphanumeric words, you can use the following 512If you want to select e.g. alphanumeric words, you can use the following
476 519
477To get a selection that is very similar to the old code, try this pattern: 520To get a selection that is very similar to the old code, try this pattern:
478 521
479 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+) 522 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
480 523
481Please also note that the I<LeftClick Shift-LeftClik> combination also 524Please also note that the I<LeftClick Shift-LeftClick> combination also
482selects words like the old code. 525selects words like the old code.
483 526
484=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it? 527=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
485 528
486You can disable the perl extension completely by setting the 529You can disable the perl extension completely by setting the
496 URxvt.perl-ext-common: default,-selection-popup,-option-popup 539 URxvt.perl-ext-common: default,-selection-popup,-option-popup
497 540
498This will keep the default extensions, but disable the two popup 541This will keep the default extensions, but disable the two popup
499extensions. Some extensions can also be configured, for example, 542extensions. Some extensions can also be configured, for example,
500scrollback search mode is triggered by B<M-s>. You can move it to any 543scrollback search mode is triggered by B<M-s>. You can move it to any
501other combination either by setting the B<searchable-scrollback> resource: 544other combination by adding a B<keysym> resource that binds the desired
545combination to the C<start> action of C<searchable-scrollback> and another
546one that binds B<M-s> to the C<builtin:> action:
502 547
503 URxvt.searchable-scrollback: CM-s 548 URxvt.keysym.CM-s: searchable-scrollback:start
549 URxvt.keysym.M-s: builtin:
504 550
505=head3 The cursor moves when selecting text in the current input line, how do I switch this off? 551=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
506 552
507See next entry. 553See next entry.
508 554
517You can permanently switch this feature off by disabling the C<readline> 563You can permanently switch this feature off by disabling the C<readline>
518extension: 564extension:
519 565
520 URxvt.perl-ext-common: default,-readline 566 URxvt.perl-ext-common: default,-readline
521 567
522=head3 My numerical keypad acts weird and generates differing output? 568=head3 My numeric keypad acts weird and generates differing output?
523 569
524Some Debian GNUL/Linux users seem to have this problem, although no 570Some Debian GNU/Linux users seem to have this problem, although no
525specific details were reported so far. It is possible that this is caused 571specific details were reported so far. It is possible that this is caused
526by the wrong C<TERM> setting, although the details of whether and how 572by the wrong C<TERM> setting, although the details of whether and how
527this can happen are unknown, as C<TERM=rxvt> should offer a compatible 573this can happen are unknown, as C<TERM=rxvt> should offer a compatible
528keymap. See the answer to the previous question, and please report if that 574keymap. See the answer to the previous question, and please report if that
529helped. 575helped.
530 576
531=head3 My Compose (Multi_key) key is no longer working. 577=head3 My Compose (Multi_key) key is no longer working.
532 578
533The most common causes for this are that either your locale is not set 579The most common causes for this are that either your locale is not set
534correctly, or you specified a B<preeditStyle> that is not supported by 580correctly, or you specified a B<preeditType> that is not supported by
535your input method. For example, if you specified B<OverTheSpot> and 581your input method. For example, if you specified B<OverTheSpot> and
536your input method (e.g. the default input method handling Compose keys) 582your input method (e.g. the default input method handling Compose keys)
537does not support this (for instance because it is not visual), then 583does not support this (for instance because it is not visual), then
538rxvt-unicode will continue without an input method. 584rxvt-unicode will continue without an input method.
539 585
540In this case either do not specify a B<preeditStyle> or specify more than 586In this case either do not specify a B<preeditType> or specify more than
541one pre-edit style, such as B<OverTheSpot,Root,None>. 587one pre-edit style, such as B<OverTheSpot,Root,None>.
588
589If it still doesn't work, then maybe your input method doesn't support
590compose sequences - to fall back to the built-in one, make sure you don't
591specify an input method via C<-im> or C<XMODIFIERS>.
542 592
543=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755 593=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
544 594
545Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on 595Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
546international keyboards) or simply use ISO 14755 support to your 596international keyboards) or simply use ISO 14755 support to your
549character and so on. 599character and so on.
550 600
551=head3 Mouse cut/paste suddenly no longer works. 601=head3 Mouse cut/paste suddenly no longer works.
552 602
553Make sure that mouse reporting is actually turned off since killing 603Make sure that mouse reporting is actually turned off since killing
554some editors prematurely may leave the mouse in mouse report mode. I've 604some editors prematurely may leave it active. I've
555heard that tcsh may use mouse reporting unless it otherwise specified. A 605heard that tcsh may use mouse reporting unless it is otherwise specified. A
556quick check is to see if cut/paste works when the Alt or Shift keys are 606quick check is to see if cut/paste works when the Alt or Shift keys are
557depressed. 607pressed.
558 608
559=head3 What's with the strange Backspace/Delete key behaviour? 609=head3 What's with the strange Backspace/Delete key behaviour?
560 610
561Assuming that the physical Backspace key corresponds to the 611Assuming that the physical Backspace key corresponds to the
562Backspace keysym (not likely for Linux ... see the following 612Backspace keysym (not likely for Linux ... see the following
565 615
566Historically, either value is correct, but rxvt-unicode adopts the debian 616Historically, either value is correct, but rxvt-unicode adopts the debian
567policy of using C<^?> when unsure, because it's the one and only correct 617policy of using C<^?> when unsure, because it's the one and only correct
568choice :). 618choice :).
569 619
570Rxvt-unicode tries to inherit the current stty settings and uses the value 620It is possible to toggle between C<^H> and C<^?> with the DECBKM
571of `erase' to guess the value for backspace. If rxvt-unicode wasn't 621private mode:
572started from a terminal (say, from a menu or by remote shell), then the
573system value of `erase', which corresponds to CERASE in <termios.h>, will
574be used (which may not be the same as your stty setting).
575
576For starting a new rxvt-unicode:
577 622
578 # use Backspace = ^H 623 # use Backspace = ^H
579 $ stty erase ^H 624 $ stty erase ^H
580 $ @@URXVT_NAME@@ 625 $ printf "\e[?67h"
581 626
582 # use Backspace = ^? 627 # use Backspace = ^?
583 $ stty erase ^? 628 $ stty erase ^?
584 $ @@URXVT_NAME@@ 629 $ printf "\e[?67l"
585
586Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
587
588For an existing rxvt-unicode:
589
590 # use Backspace = ^H
591 $ stty erase ^H
592 $ echo -n "^[[36h"
593
594 # use Backspace = ^?
595 $ stty erase ^?
596 $ echo -n "^[[36l"
597 630
598This helps satisfy some of the Backspace discrepancies that occur, but 631This helps satisfy some of the Backspace discrepancies that occur, but
599if you use Backspace = C<^H>, make sure that the termcap/terminfo value 632if you use Backspace = C<^H>, make sure that the termcap/terminfo value
600properly reflects that. 633properly reflects that.
601 634
604key has been assigned an escape sequence to match the vt100 for Execute 637key has been assigned an escape sequence to match the vt100 for Execute
605(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo. 638(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
606 639
607Some other Backspace problems: 640Some other Backspace problems:
608 641
609some editors use termcap/terminfo, 642some editors use termcap/terminfo,
610some editors (vim I'm told) expect Backspace = ^H, 643some editors (vim I'm told) expect Backspace = ^H,
611GNU Emacs (and Emacs-like editors) use ^H for help. 644GNU Emacs (and Emacs-like editors) use ^H for help.
612 645
613Perhaps someday this will all be resolved in a consistent manner. 646Perhaps someday this will all be resolved in a consistent manner.
614 647
618you have run "configure" with the C<--disable-resources> option you can 651you have run "configure" with the C<--disable-resources> option you can
619use the `keysym' resource to alter the keystrings associated with keysyms. 652use the `keysym' resource to alter the keystrings associated with keysyms.
620 653
621Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt> 654Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
622 655
656 URxvt.keysym.Prior: \033[5~
657 URxvt.keysym.Next: \033[6~
623 URxvt.keysym.Home: \033[1~ 658 URxvt.keysym.Home: \033[7~
624 URxvt.keysym.End: \033[4~ 659 URxvt.keysym.End: \033[8~
625 URxvt.keysym.C-apostrophe: \033<C-'>
626 URxvt.keysym.C-slash: \033<C-/>
627 URxvt.keysym.C-semicolon: \033<C-;>
628 URxvt.keysym.C-grave: \033<C-`>
629 URxvt.keysym.C-comma: \033<C-,>
630 URxvt.keysym.C-period: \033<C-.>
631 URxvt.keysym.C-0x60: \033<C-`>
632 URxvt.keysym.C-Tab: \033<C-Tab>
633 URxvt.keysym.C-Return: \033<C-Return>
634 URxvt.keysym.S-Return: \033<S-Return>
635 URxvt.keysym.S-space: \033<S-Space>
636 URxvt.keysym.M-Up: \033<M-Up> 660 URxvt.keysym.Up: \033[A
637 URxvt.keysym.M-Down: \033<M-Down> 661 URxvt.keysym.Down: \033[B
662 URxvt.keysym.Right: \033[C
638 URxvt.keysym.M-Left: \033<M-Left> 663 URxvt.keysym.Left: \033[D
639 URxvt.keysym.M-Right: \033<M-Right>
640 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
641 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
642 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
643 664
644See some more examples in the documentation for the B<keysym> resource. 665See some more examples in the documentation for the B<keysym> resource.
645 666
646=head3 I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map 667=head3 I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map
647 668
655Rather than have rxvt-unicode try to accommodate all the various possible 676Rather than have rxvt-unicode try to accommodate all the various possible
656keyboard mappings, it is better to use `xmodmap' to remap the keys as 677keyboard mappings, it is better to use `xmodmap' to remap the keys as
657required for your particular machine. 678required for your particular machine.
658 679
659 680
660
661=head2 Terminal Configuration 681=head2 Terminal Configuration
662 682
663=head3 Can I see a typical configuration? 683=head3 Can I see a typical configuration?
664 684
665The default configuration tries to be xterm-like, which I don't like that 685The default configuration tries to be xterm-like, which I don't like that
695develop for myself mostly, so I actually use most of the extensions I 715develop for myself mostly, so I actually use most of the extensions I
696write. 716write.
697 717
698The selection stuff mainly makes the selection perl-error-message aware 718The selection stuff mainly makes the selection perl-error-message aware
699and tells it to convert perl error messages into vi-commands to load the 719and tells it to convert perl error messages into vi-commands to load the
700relevant file and go tot he error line number. 720relevant file and go to the error line number.
701 721
702 URxvt.scrollstyle: plain 722 URxvt.scrollstyle: plain
703 URxvt.secondaryScroll: true 723 URxvt.secondaryScroll: true
704 724
705As the documentation says: plain is the preferred scrollbar for the 725As the documentation says: plain is the preferred scrollbar for the
777purposes, it works, and gives a different look, as my normal (Non-bold) 797purposes, it works, and gives a different look, as my normal (Non-bold)
778font is already bold, and I want to see a difference between bold and 798font is already bold, and I want to see a difference between bold and
779normal fonts. 799normal fonts.
780 800
781Please note that I used the C<urxvt> instance name and not the C<URxvt> 801Please note that I used the C<urxvt> instance name and not the C<URxvt>
782class name. Thats because I use different configs for different purposes, 802class name. That is because I use different configs for different purposes,
783for example, my IRC window is started with C<-name IRC>, and uses these 803for example, my IRC window is started with C<-name IRC>, and uses these
784defaults: 804defaults:
785 805
786 IRC*title: IRC 806 IRC*title: IRC
787 IRC*geometry: 87x12+535+542 807 IRC*geometry: 87x12+535+542
791 IRC*boldFont: suxuseuro 811 IRC*boldFont: suxuseuro
792 IRC*colorBD: white 812 IRC*colorBD: white
793 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007 813 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
794 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007 814 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
795 815
796C<Alt-Shift-1> and C<Alt-Shift-2> switch between two different font 816C<Alt-Ctrl-1> and C<Alt-Ctrl-2> switch between two different font
797sizes. C<suxuseuro> allows me to keep an eye (and actually read) 817sizes. C<suxuseuro> allows me to keep an eye (and actually read)
798stuff while keeping a very small window. If somebody pastes something 818stuff while keeping a very small window. If somebody pastes something
799complicated (e.g. japanese), I temporarily switch to a larger font. 819complicated (e.g. japanese), I temporarily switch to a larger font.
800 820
801The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor 821The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
802C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname> 822C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
803file for different hosts, for example, on ym main desktop, I use: 823file for different hosts, for example, on my main desktop, I use:
804 824
805 URxvt.keysym.C-M-q: command:\033[3;5;5t 825 URxvt.keysym.C-M-q: command:\033[3;5;5t
806 URxvt.keysym.C-M-y: command:\033[3;5;606t 826 URxvt.keysym.C-M-y: command:\033[3;5;606t
807 URxvt.keysym.C-M-e: command:\033[3;1605;5t 827 URxvt.keysym.C-M-e: command:\033[3;1605;5t
808 URxvt.keysym.C-M-c: command:\033[3;1605;606t 828 URxvt.keysym.C-M-c: command:\033[3;1605;606t
838 858
839The terminal description used by rxvt-unicode is not as widely available 859The terminal description used by rxvt-unicode is not as widely available
840as that for xterm, or even rxvt (for which the same problem often arises). 860as that for xterm, or even rxvt (for which the same problem often arises).
841 861
842The correct solution for this problem is to install the terminfo, this can 862The correct solution for this problem is to install the terminfo, this can
843be done like this (with ncurses' infocmp and works as user and admin): 863be done by simply installing rxvt-unicode on the remote system as well
864(in case you have a nice package manager ready), or you can install the
865terminfo database manually like this (with ncurses infocmp. works as
866user and root):
844 867
845 REMOTE=remotesystem.domain 868 REMOTE=remotesystem.domain
846 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti" 869 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
847
848... or by installing rxvt-unicode normally on the remote system,
849 870
850One some systems you might need to set C<$TERMINFO> to the full path of 871One some systems you might need to set C<$TERMINFO> to the full path of
851F<$HOME/.terminfo> for this to work. 872F<$HOME/.terminfo> for this to work.
852 873
853If you cannot or do not want to do this, then you can simply set 874If you cannot or do not want to do this, then you can simply set
863 URxvt.termName: rxvt 884 URxvt.termName: rxvt
864 885
865If you don't plan to use B<rxvt> (quite common...) you could also replace 886If you don't plan to use B<rxvt> (quite common...) you could also replace
866the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>. 887the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
867 888
889=head3 nano fails with "Error opening terminal: rxvt-unicode"
890
891This exceptionally confusing and useless error message is printed by nano
892when it can't find the terminfo database. Nothing is wrong with your
893terminal, read the previous answer for a solution.
894
868=head3 C<tic> outputs some error when compiling the terminfo entry. 895=head3 C<tic> outputs some error when compiling the terminfo entry.
869 896
870Most likely it's the empty definition for C<enacs=>. Just replace it by 897Most likely it's the empty definition for C<enacs=>. Just replace it by
871C<enacs=\E[0@> and try again. 898C<enacs=\E[0@> and try again.
872 899
876 903
877=head3 I need a termcap file entry. 904=head3 I need a termcap file entry.
878 905
879One reason you might want this is that some distributions or operating 906One reason you might want this is that some distributions or operating
880systems still compile some programs using the long-obsoleted termcap 907systems still compile some programs using the long-obsoleted termcap
881library (Fedora Core's bash is one example) and rely on a termcap entry 908library (Fedora's bash is one example) and rely on a termcap entry
882for C<rxvt-unicode>. 909for C<rxvt-unicode>.
883 910
884You could use rxvt's termcap entry with reasonable results in many cases. 911You could use rxvt's termcap entry with reasonable results in many cases.
885You can also create a termcap entry by using terminfo's infocmp program 912You can also create a termcap entry by using terminfo's infocmp program
886like this: 913like this:
887 914
888 infocmp -C rxvt-unicode 915 infocmp -C rxvt-unicode
889 916
890Or you could use this termcap entry, generated by the command above: 917Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap,
891 918generated by the command above.
892 rxvt-unicode|rxvt-unicode terminal (X Window System):\
893 :am:bw:eo:km:mi:ms:xn:xo:\
894 :co#80:it#8:li#24:lm#0:\
895 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
896 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
897 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
898 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
899 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
900 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
901 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
902 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
903 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
904 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
905 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
906 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
907 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
908 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
909 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
910 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
911 :vs=\E[?25h:
912 919
913=head3 Why does C<ls> no longer have coloured output? 920=head3 Why does C<ls> no longer have coloured output?
914 921
915The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 922The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
916decide whether a terminal has colour, but uses its own configuration 923decide whether a terminal has colour, but uses its own configuration
934See next entry. 941See next entry.
935 942
936=head3 Why are the secondary screen-related options not working properly? 943=head3 Why are the secondary screen-related options not working properly?
937 944
938Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged 945Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
939distributions (most notably Debian GNU/Linux) break rxvt-unicode 946distributions break rxvt-unicode by setting C<TERM> to C<rxvt>, which
940by setting C<TERM> to C<rxvt>, which doesn't have these extra 947doesn't have these extra features. Unfortunately, some of these
941features. Unfortunately, some of these (most notably, again, Debian
942GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo 948furthermore fail to even install the C<rxvt-unicode> terminfo file, so
943file, so you will need to install it on your own (See the question B<When 949you will need to install it on your own (See the question B<When I
944I log-in to another system it tells me about missing terminfo data?> on 950log-in to another system it tells me about missing terminfo data?> on
945how to do this). 951how to do this).
946 952
947 953
948=head2 Encoding / Locale / Input Method Issues 954=head2 Encoding / Locale / Input Method Issues
949 955
1068C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input 1074C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1069method servers are running with this command: 1075method servers are running with this command:
1070 1076
1071 xprop -root XIM_SERVERS 1077 xprop -root XIM_SERVERS
1072 1078
1073=item
1074
1075=back 1079=back
1076 1080
1077=head3 My input method wants <some encoding> but I want UTF-8, what can I do? 1081=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
1078 1082
1079You can specify separate locales for the input method and the rest of the 1083You can specify separate locales for the input method and the rest of the
1098So the only workaround is not to kill your Input Method Servers. 1102So the only workaround is not to kill your Input Method Servers.
1099 1103
1100 1104
1101=head2 Operating Systems / Package Maintaining 1105=head2 Operating Systems / Package Maintaining
1102 1106
1103=head3 I am using Debian GNU/Linux and have a problem...
1104
1105The Debian GNU/Linux package of rxvt-unicode in sarge contains large
1106patches that considerably change the behaviour of rxvt-unicode (but
1107unfortunately this notice has been removed). Before reporting a bug to
1108the original rxvt-unicode author please download and install the genuine
1109version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
1110the problem. If you cannot, chances are that the problems are specific to
1111Debian GNU/Linux, in which case it should be reported via the Debian Bug
1112Tracking System (use C<reportbug> to report the bug).
1113
1114For other problems that also affect the Debian package, you can and
1115probably should use the Debian BTS, too, because, after all, it's also a
1116bug in the Debian version and it serves as a reminder for other users that
1117might encounter the same issue.
1118
1119=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation? 1107=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
1120 1108
1121You should build one binary with the default options. F<configure> 1109You should build one binary with the default options. F<configure>
1122now enables most useful options, and the trend goes to making them 1110now enables most useful options, and the trend goes to making them
1123runtime-switchable, too, so there is usually no drawback to enabling them, 1111runtime-switchable, too, so there is usually no drawback to enabling them,
1124except higher disk and possibly memory usage. The perl interpreter should 1112except higher disk and possibly memory usage. The perl interpreter should
1125be enabled, as important functionality (menus, selection, likely more in 1113be enabled, as important functionality (menus, selection, likely more in
1126the future) depends on it. 1114the future) depends on it.
1127 1115
1128You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 1116You should not overwrite the C<perl-ext-common> and C<perl-ext> resources
1129system-wide (except maybe with C<defaults>). This will result in useful 1117system-wide (except maybe with C<defaults>). This will result in useful
1130behaviour. If your distribution aims at low memory, add an empty 1118behaviour. If your distribution aims at low memory, add an empty
1131C<perl-ext-common> resource to the app-defaults file. This will keep the 1119C<perl-ext-common> resource to the app-defaults file. This will keep the
1132perl interpreter disabled until the user enables it. 1120perl interpreter disabled until the user enables it.
1133 1121
1163As you might have guessed, FreeBSD does neither define this symbol nor 1151As you might have guessed, FreeBSD does neither define this symbol nor
1164does it support it. Instead, it uses its own internal representation of 1152does it support it. Instead, it uses its own internal representation of
1165B<wchar_t>. This is, of course, completely fine with respect to standards. 1153B<wchar_t>. This is, of course, completely fine with respect to standards.
1166 1154
1167However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and 1155However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
1168C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>. 1156C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>).
1169 1157
1170C<__STDC_ISO_10646__> is the only sane way to support multi-language 1158C<__STDC_ISO_10646__> is the only sane way to support multi-language
1171apps in an OS, as using a locale-dependent (and non-standardized) 1159apps in an OS, as using a locale-dependent (and non-standardized)
1172representation of B<wchar_t> makes it impossible to convert between 1160representation of B<wchar_t> makes it impossible to convert between
1173B<wchar_t> (as used by X11 and your applications) and any other encoding 1161B<wchar_t> (as used by X11 and your applications) and any other encoding
1222 1210
1223=over 4 1211=over 4
1224 1212
1225=item B<< C<c> >> 1213=item B<< C<c> >>
1226 1214
1227The literal character c. 1215The literal character c (potentially a multi-byte character).
1228 1216
1229=item B<< C<C> >> 1217=item B<< C<C> >>
1230 1218
1231A single (required) character. 1219A single (required) character.
1232 1220
1291=item B<< C<SI> >> 1279=item B<< C<SI> >>
1292 1280
1293Shift In (Ctrl-O), invokes the G0 character set (the default). 1281Shift In (Ctrl-O), invokes the G0 character set (the default).
1294Switch to Standard Character Set 1282Switch to Standard Character Set
1295 1283
1296=item B<< C<SPC> >> 1284=item B<< C<SP> >>
1297 1285
1298Space Character 1286Space Character
1299 1287
1300=back 1288=back
1301 1289
1317 1305
1318=item B<< C<ESC => >> 1306=item B<< C<ESC => >>
1319 1307
1320Application Keypad (SMKX). See also next sequence. 1308Application Keypad (SMKX). See also next sequence.
1321 1309
1322=item B<<< C<< ESC >> >>> 1310=item B<<< C<< ESC > >> >>>
1323 1311
1324Normal Keypad (RMKX) 1312Normal Keypad (RMKX)
1325 1313
1326B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been
1327pressed, numbers or control functions are generated by the numeric keypad 1314B<Note:> numbers or control functions are generated by the numeric
1328(see Key Codes). 1315keypad in normal or application mode, respectively (see Key Codes).
1316
1329 1317
1330=item B<< C<ESC D> >> 1318=item B<< C<ESC D> >>
1331 1319
1332Index (IND) 1320Index (IND)
1333 1321
1391 1379
1392Where B<< C<C> >> is one of: 1380Where B<< C<C> >> is one of:
1393 1381
1394=begin table 1382=begin table
1395 1383
1396 C = C<0> DEC Special Character and Line Drawing Set 1384 C = C<0> DEC Special Character and Line Drawing Set
1397 C = C<A> United Kingdom (UK) 1385 C = C<A> United Kingdom (UK)
1398 C = C<B> United States (USASCII) 1386 C = C<B> United States (USASCII)
1399 C = C<< < >> Multinational character set I<unimplemented> 1387 C = C<< < >> Multinational character set I<unimplemented>
1400 C = C<5> Finnish character set I<unimplemented> 1388 C = C<5> Finnish character set I<unimplemented>
1401 C = C<C> Finnish character set I<unimplemented> 1389 C = C<C> Finnish character set I<unimplemented>
1402 C = C<K> German character set I<unimplemented> 1390 C = C<K> German character set I<unimplemented>
1403 1391
1404=end table 1392=end table
1405 1393
1406=back 1394=back
1407 1395
1455 1443
1456Erase in Display (ED) 1444Erase in Display (ED)
1457 1445
1458=begin table 1446=begin table
1459 1447
1460 B<< C<Ps = 0> >> Clear Below (default) 1448 B<< C<Ps = 0> >> Clear Right and Below (default)
1461 B<< C<Ps = 1> >> Clear Above 1449 B<< C<Ps = 1> >> Clear Left and Above
1462 B<< C<Ps = 2> >> Clear All 1450 B<< C<Ps = 2> >> Clear All
1463 1451
1464=end table 1452=end table
1465 1453
1466=item B<< C<ESC [ Ps K> >> 1454=item B<< C<ESC [ Ps K> >>
1470=begin table 1458=begin table
1471 1459
1472 B<< C<Ps = 0> >> Clear to Right (default) 1460 B<< C<Ps = 0> >> Clear to Right (default)
1473 B<< C<Ps = 1> >> Clear to Left 1461 B<< C<Ps = 1> >> Clear to Left
1474 B<< C<Ps = 2> >> Clear All 1462 B<< C<Ps = 2> >> Clear All
1463 B<< C<Ps = 3> >> Like Ps = 0, but is ignored when wrapped
1464 (@@RXVT_NAME@@ extension)
1475 1465
1476=end table 1466=end table
1477 1467
1478=item B<< C<ESC [ Ps L> >> 1468=item B<< C<ESC [ Ps L> >>
1479 1469
1596 1586
1597Character Attributes (SGR) 1587Character Attributes (SGR)
1598 1588
1599=begin table 1589=begin table
1600 1590
1601 B<< C<Ps = 0> >> Normal (default) 1591 B<< C<Pm = 0> >> Normal (default)
1602 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg) 1592 B<< C<Pm = 1 / 21> >> On / Off Bold (bright fg)
1603 B<< C<Ps = 3 / 23> >> On / Off Italic 1593 B<< C<Pm = 3 / 23> >> On / Off Italic
1604 B<< C<Ps = 4 / 24> >> On / Off Underline 1594 B<< C<Pm = 4 / 24> >> On / Off Underline
1605 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg) 1595 B<< C<Pm = 5 / 25> >> On / Off Slow Blink (bright bg)
1606 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg) 1596 B<< C<Pm = 6 / 26> >> On / Off Rapid Blink (bright bg)
1607 B<< C<Ps = 7 / 27> >> On / Off Inverse 1597 B<< C<Pm = 7 / 27> >> On / Off Inverse
1608 B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI) 1598 B<< C<Pm = 8 / 27> >> On / Off Invisible (NYI)
1609 B<< C<Ps = 30 / 40> >> fg/bg Black 1599 B<< C<Pm = 30 / 40> >> fg/bg Black
1610 B<< C<Ps = 31 / 41> >> fg/bg Red 1600 B<< C<Pm = 31 / 41> >> fg/bg Red
1611 B<< C<Ps = 32 / 42> >> fg/bg Green 1601 B<< C<Pm = 32 / 42> >> fg/bg Green
1612 B<< C<Ps = 33 / 43> >> fg/bg Yellow 1602 B<< C<Pm = 33 / 43> >> fg/bg Yellow
1613 B<< C<Ps = 34 / 44> >> fg/bg Blue 1603 B<< C<Pm = 34 / 44> >> fg/bg Blue
1614 B<< C<Ps = 35 / 45> >> fg/bg Magenta 1604 B<< C<Pm = 35 / 45> >> fg/bg Magenta
1615 B<< C<Ps = 36 / 46> >> fg/bg Cyan 1605 B<< C<Pm = 36 / 46> >> fg/bg Cyan
1606 B<< C<Pm = 37 / 47> >> fg/bg White
1616 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to color #m (ISO 8613-6) 1607 B<< C<Pm = 38;5 / 48;5> >> set fg/bg to colour #m (ISO 8613-6)
1617 B<< C<Ps = 37 / 47> >> fg/bg White 1608 B<< C<Pm = 38;2;R;G;B> >> set fg to 24-bit colour #RGB (ISO 8613-3)
1609 B<< C<Pm = 48;2;R;G;B> >> set bg to 24-bit colour #RGB (ISO 8613-3)
1618 B<< C<Ps = 39 / 49> >> fg/bg Default 1610 B<< C<Pm = 39 / 49> >> fg/bg Default
1619 B<< C<Ps = 90 / 100> >> fg/bg Bright Black 1611 B<< C<Pm = 90 / 100> >> fg/bg Bright Black
1620 B<< C<Ps = 91 / 101> >> fg/bg Bright Red 1612 B<< C<Pm = 91 / 101> >> fg/bg Bright Red
1621 B<< C<Ps = 92 / 102> >> fg/bg Bright Green 1613 B<< C<Pm = 92 / 102> >> fg/bg Bright Green
1622 B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow 1614 B<< C<Pm = 93 / 103> >> fg/bg Bright Yellow
1623 B<< C<Ps = 94 / 104> >> fg/bg Bright Blue 1615 B<< C<Pm = 94 / 104> >> fg/bg Bright Blue
1624 B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta 1616 B<< C<Pm = 95 / 105> >> fg/bg Bright Magenta
1625 B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan 1617 B<< C<Pm = 96 / 106> >> fg/bg Bright Cyan
1626 B<< C<Ps = 97 / 107> >> fg/bg Bright White 1618 B<< C<Pm = 97 / 107> >> fg/bg Bright White
1627 B<< C<Ps = 99 / 109> >> fg/bg Bright Default 1619 B<< C<Pm = 99 / 109> >> fg/bg Bright Default
1628 1620
1629=end table 1621=end table
1630 1622
1631=item B<< C<ESC [ Ps n> >> 1623=item B<< C<ESC [ Ps n> >>
1632 1624
1636 1628
1637 B<< C<Ps = 5> >> Status Report B<< C<ESC [ 0 n> >> (``OK'') 1629 B<< C<Ps = 5> >> Status Report B<< C<ESC [ 0 n> >> (``OK'')
1638 B<< C<Ps = 6> >> Report Cursor Position (CPR) [row;column] as B<< C<ESC [ r ; c R> >> 1630 B<< C<Ps = 6> >> Report Cursor Position (CPR) [row;column] as B<< C<ESC [ r ; c R> >>
1639 B<< C<Ps = 7> >> Request Display Name 1631 B<< C<Ps = 7> >> Request Display Name
1640 B<< C<Ps = 8> >> Request Version Number (place in window title) 1632 B<< C<Ps = 8> >> Request Version Number (place in window title)
1633
1634=end table
1635
1636=item B<< C<ESC [ Ps SP q> >>
1637
1638Set Cursor Style (DECSCUSR)
1639
1640=begin table
1641
1642 B<< C<Ps = 0> >> Blink Block
1643 B<< C<Ps = 1> >> Blink Block
1644 B<< C<Ps = 2> >> Steady Block
1645 B<< C<Ps = 3> >> Blink Underline
1646 B<< C<Ps = 4> >> Steady Underline
1647 B<< C<Ps = 5> >> Blink Bar (XTerm)
1648 B<< C<Ps = 6> >> Steady Bar (XTerm)
1641 1649
1642=end table 1650=end table
1643 1651
1644=item B<< C<ESC [ Ps;Ps r> >> 1652=item B<< C<ESC [ Ps;Ps r> >>
1645 1653
1720 B<< C<h> >> Application Cursor Keys 1728 B<< C<h> >> Application Cursor Keys
1721 B<< C<l> >> Normal Cursor Keys 1729 B<< C<l> >> Normal Cursor Keys
1722 1730
1723=end table 1731=end table
1724 1732
1725=item B<< C<Pm = 2> >> (ANSI/VT52 mode) 1733=item B<< C<Pm = 2> >> (DECANM)
1726 1734
1727=begin table 1735=begin table
1728 1736
1729 B<< C<h> >> Enter VT52 mode 1737 B<< C<h> >> Enter VT52 mode
1730 B<< C<l> >> Enter VT52 mode 1738 B<< C<l> >> Enter VT52 mode
1731 1739
1732=end table 1740=end table
1733 1741
1734=item B<< C<Pm = 3> >> 1742=item B<< C<Pm = 3> >> (DECCOLM)
1735 1743
1736=begin table 1744=begin table
1737 1745
1738 B<< C<h> >> 132 Column Mode (DECCOLM) 1746 B<< C<h> >> 132 Column Mode
1739 B<< C<l> >> 80 Column Mode (DECCOLM) 1747 B<< C<l> >> 80 Column Mode
1740 1748
1741=end table
1742
1743=item B<< C<Pm = 4> >>
1744
1745=begin table 1749=end table
1746 1750
1751=item B<< C<Pm = 4> >> (DECSCLM)
1752
1753=begin table
1754
1747 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1755 B<< C<h> >> Smooth (Slow) Scroll
1748 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1756 B<< C<l> >> Jump (Fast) Scroll
1749 1757
1750=end table
1751
1752=item B<< C<Pm = 5> >>
1753
1754=begin table 1758=end table
1755 1759
1760=item B<< C<Pm = 5> >> (DECSCNM)
1761
1762=begin table
1763
1756 B<< C<h> >> Reverse Video (DECSCNM) 1764 B<< C<h> >> Reverse Video
1757 B<< C<l> >> Normal Video (DECSCNM) 1765 B<< C<l> >> Normal Video
1758 1766
1759=end table 1767=end table
1760 1768
1761=item B<< C<Pm = 6> >> 1769=item B<< C<Pm = 6> >> (DECOM)
1762 1770
1763=begin table 1771=begin table
1764 1772
1765 B<< C<h> >> Origin Mode (DECOM) 1773 B<< C<h> >> Origin Mode
1766 B<< C<l> >> Normal Cursor Mode (DECOM) 1774 B<< C<l> >> Normal Cursor Mode
1767 1775
1768=end table 1776=end table
1769 1777
1770=item B<< C<Pm = 7> >> 1778=item B<< C<Pm = 7> >> (DECAWM)
1771 1779
1772=begin table 1780=begin table
1773 1781
1774 B<< C<h> >> Wraparound Mode (DECAWM) 1782 B<< C<h> >> Wraparound Mode
1775 B<< C<l> >> No Wraparound Mode (DECAWM) 1783 B<< C<l> >> No Wraparound Mode
1776 1784
1777=end table 1785=end table
1778 1786
1779=item B<< C<Pm = 8> >> I<unimplemented> 1787=item B<< C<Pm = 8> >> (DECARM) I<unimplemented>
1780 1788
1781=begin table 1789=begin table
1782 1790
1783 B<< C<h> >> Auto-repeat Keys (DECARM) 1791 B<< C<h> >> Auto-repeat Keys
1784 B<< C<l> >> No Auto-repeat Keys (DECARM) 1792 B<< C<l> >> No Auto-repeat Keys
1785 1793
1786=end table 1794=end table
1787 1795
1788=item B<< C<Pm = 9> >> X10 XTerm 1796=item B<< C<Pm = 9> >> (X10 XTerm mouse protocol)
1789 1797
1790=begin table 1798=begin table
1791 1799
1792 B<< C<h> >> Send Mouse X & Y on button press. 1800 B<< C<h> >> Send Mouse X & Y on button press.
1793 B<< C<l> >> No mouse reporting. 1801 B<< C<l> >> No mouse reporting.
1794 1802
1795=end table 1803=end table
1796 1804
1805=item B<< C<Pm = 12> >> (AT&T 610, XTerm)
1806
1807=begin table
1808
1809 B<< C<h> >> Blinking cursor (cvvis)
1810 B<< C<l> >> Steady cursor (cnorm)
1811
1812=end table
1813
1797=item B<< C<Pm = 25> >> 1814=item B<< C<Pm = 25> >> (DECTCEM)
1798 1815
1799=begin table 1816=begin table
1800 1817
1801 B<< C<h> >> Visible cursor {cnorm/cvvis} 1818 B<< C<h> >> Visible cursor {cnorm/cvvis}
1802 B<< C<l> >> Invisible cursor {civis} 1819 B<< C<l> >> Invisible cursor {civis}
1803 1820
1804=end table 1821=end table
1805 1822
1806=item B<< C<Pm = 30> >> 1823=item B<< C<Pm = 30> >> (B<rxvt>)
1807 1824
1808=begin table 1825=begin table
1809 1826
1810 B<< C<h> >> scrollBar visisble 1827 B<< C<h> >> scrollBar visible
1811 B<< C<l> >> scrollBar invisisble 1828 B<< C<l> >> scrollBar invisible
1812 1829
1813=end table 1830=end table
1814 1831
1815=item B<< C<Pm = 35> >> (B<rxvt>) 1832=item B<< C<Pm = 35> >> (B<rxvt>)
1816 1833
1863 1880
1864=end table 1881=end table
1865 1882
1866X<Priv66> 1883X<Priv66>
1867 1884
1868=item B<< C<Pm = 66> >> 1885=item B<< C<Pm = 66> >> (DECNKM)
1869 1886
1870=begin table 1887=begin table
1871 1888
1872 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1889 B<< C<h> >> Application Keypad (DECKPAM/DECPAM) == C<ESC =>
1873 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1890 B<< C<l> >> Normal Keypad (DECKPNM/DECPNM) == C<< ESC > >>
1874 1891
1875=end table 1892=end table
1876 1893
1877=item B<< C<Pm = 67> >> 1894=item B<< C<Pm = 67> >> (DECBKM)
1878 1895
1879=begin table 1896=begin table
1880 1897
1881 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1898 B<< C<h> >> Backspace key sends B<< C<BS> >>
1882 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1899 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1883 1900
1884=end table 1901=end table
1885 1902
1886=item B<< C<Pm = 1000> >> (X11 XTerm) 1903=item B<< C<Pm = 1000> >> (X11 XTerm mouse protocol)
1887 1904
1888=begin table 1905=begin table
1889 1906
1890 B<< C<h> >> Send Mouse X & Y on button press and release. 1907 B<< C<h> >> Send Mouse X & Y on button press and release.
1891 B<< C<l> >> No mouse reporting. 1908 B<< C<l> >> No mouse reporting.
1899 B<< C<h> >> Use Hilite Mouse Tracking. 1916 B<< C<h> >> Use Hilite Mouse Tracking.
1900 B<< C<l> >> No mouse reporting. 1917 B<< C<l> >> No mouse reporting.
1901 1918
1902=end table 1919=end table
1903 1920
1921=item B<< C<Pm = 1002> >> (X11 XTerm cell motion mouse tracking)
1922
1923=begin table
1924
1925 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1926 B<< C<l> >> No mouse reporting.
1927
1928=end table
1929
1930=item B<< C<Pm = 1003> >> (X11 XTerm all motion mouse tracking)
1931
1932=begin table
1933
1934 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1935 B<< C<l> >> No mouse reporting.
1936
1937=end table
1938
1939=item B<< C<Pm = 1004> >> (X11 XTerm focus in/focus out events)
1940
1941=begin table
1942
1943 B<< C<h> >> Send Mouse focus in/focus out events.
1944 B<< C<l> >> Don't send focus events.
1945
1946=end table
1947
1948=item B<< C<Pm = 1005> >> (X11 XTerm UTF-8 mouse mode) (Compile frills)
1949
1950Try to avoid this mode, it doesn't work sensibly in non-UTF-8 locales. Use
1951mode C<1015> instead.
1952
1953Unlike XTerm, coordinates larger than 2015) will work fine.
1954
1955=begin table
1956
1957 B<< C<h> >> Enable mouse coordinates in locale-specific encoding.
1958 B<< C<l> >> Enable mouse coordinates as binary octets.
1959
1960=end table
1961
1904=item B<< C<Pm = 1010> >> (B<rxvt>) 1962=item B<< C<Pm = 1010> >> (B<rxvt>)
1905 1963
1906=begin table 1964=begin table
1907 1965
1908 B<< C<h> >> Don't scroll to bottom on TTY output 1966 B<< C<h> >> Don't scroll to bottom on TTY output
1917 B<< C<h> >> Scroll to bottom when a key is pressed 1975 B<< C<h> >> Scroll to bottom when a key is pressed
1918 B<< C<l> >> Don't scroll to bottom when a key is pressed 1976 B<< C<l> >> Don't scroll to bottom when a key is pressed
1919 1977
1920=end table 1978=end table
1921 1979
1980=item B<< C<Pm = 1015> >> (B<rxvt-unicode>) (Compile frills)
1981
1982=begin table
1983
1984 B<< C<h> >> Enable urxvt mouse coordinate reporting.
1985 B<< C<l> >> Use old-style C<CSI M C C C> encoding.
1986
1987=end table
1988
1989Changes all mouse reporting codes to use decimal parameters instead of
1990octets or characters.
1991
1992This mode should be enabled I<before> actually enabling mouse reporting,
1993for semi-obvious reasons.
1994
1995The sequences received for various modes are as follows:
1996
1997 ESC [ M o o o !1005, !1015 (three octets)
1998 ESC [ M c c c 1005, !1015 (three characters)
1999 ESC [ Pm M 1015 (three or more numeric parameters)
2000
2001The first three parameters are C<code>, C<x> and C<y>. Code is the numeric
2002code as for the other modes (but encoded as a decimal number, including
2003the additional offset of 32, so you have to subtract 32 first), C<x> and
2004C<y> are the coordinates (1|1 is the upper left corner, just as with
2005cursor positioning).
2006
2007Example: Shift-Button-1 press at top row, column 80.
2008
2009 ESC [ 37 ; 80 ; 1 M
2010
2011One can use this feature by simply enabling it and then looking for
2012parameters to the C<ESC [ M> reply - if there are any, this mode is
2013active, otherwise one of the old reporting styles is used.
2014
2015Other (to be implemented) reply sequences will use a similar encoding.
2016
2017In the future, more parameters might get added (pixel coordinates for
2018example - anybody out there who needs this?).
2019
1922=item B<< C<Pm = 1021> >> (B<rxvt>) 2020=item B<< C<Pm = 1021> >> (B<rxvt>)
1923 2021
1924=begin table 2022=begin table
1925 2023
1926 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>) 2024 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1927 B<< C<l> >> Font styles have no effect on intensity (Compile styles) 2025 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1928 2026
1929=end table 2027=end table
1930 2028
1931=item B<< C<Pm = 1047> >> 2029=item B<< C<Pm = 1047> >> (X11 XTerm alternate screen buffer)
1932 2030
1933=begin table 2031=begin table
1934 2032
1935 B<< C<h> >> Use Alternate Screen Buffer 2033 B<< C<h> >> Use Alternate Screen Buffer
1936 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 2034 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1937 2035
1938=end table 2036=end table
1939 2037
1940=item B<< C<Pm = 1048> >> 2038=item B<< C<Pm = 1048> >> (X11 XTerm alternate DECSC)
1941 2039
1942=begin table 2040=begin table
1943 2041
1944 B<< C<h> >> Save cursor position 2042 B<< C<h> >> Save cursor position
1945 B<< C<l> >> Restore cursor position 2043 B<< C<l> >> Restore cursor position
1946 2044
1947=end table 2045=end table
1948 2046
1949=item B<< C<Pm = 1049> >> 2047=item B<< C<Pm = 1049> >> (X11 XTerm 1047 + 1048)
1950 2048
1951=begin table 2049=begin table
1952 2050
1953 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it 2051 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1954 B<< C<l> >> Use Normal Screen Buffer 2052 B<< C<l> >> Use Normal Screen Buffer
2053
2054=end table
2055
2056=item B<< C<Pm = 2004> >> (X11 XTerm bracketed paste mode)
2057
2058=begin table
2059
2060 B<< C<h> >> Enable bracketed paste mode - prepend / append to the pasted text the control sequences C<ESC [ 200 ~> / C<ESC [ 201 ~>
2061 B<< C<l> >> Disable bracketed paste mode
1955 2062
1956=end table 2063=end table
1957 2064
1958=back 2065=back
1959 2066
1976 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >> 2083 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>
1977 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >> 2084 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1978 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> 2085 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
1979 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. 2086 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.
1980 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 2087 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
1981 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 2088 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >>
1982 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 2089 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >>
1983 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 2090 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1984 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 2091 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1985 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 2092 B<< C<Ps = 17> >> Change background colour of highlight characters to B<< C<Pt> >>
1986 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706] 2093 B<< C<Ps = 19> >> Change foreground colour of highlight characters to B<< C<Pt> >>
1987 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1988 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM). 2094 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile pixbuf).
1989 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 2095 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. [deprecated, use 10]
1990 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 2096 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1991 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 2097 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. [deprecated, use 11]
1992 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> >> 2098 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> >>
1993 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 2099 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> [disabled]
1994 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). 2100 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).
1995 B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>. 2101 B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>.
1996 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 2102 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1997 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). 2103 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1998 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >> 2104 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1999 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >> 2105 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
2106 B<< C<Ps = 708> >> Change colour of the border to B<< C<Pt> >>
2000 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 2107 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
2001 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2108 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2002 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2109 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2003 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2110 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2004 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 2111 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2007 2114
2008=end table 2115=end table
2009 2116
2010=back 2117=back
2011 2118
2012=head1 XPM 2119=head1 BACKGROUND IMAGE
2013 2120
2014For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2121For the BACKGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> the value
2015of B<< C<Pt> >> can be the name of the background pixmap followed by a 2122of B<< C<Pt> >> can be one of the following commands:
2016sequence of scaling/positioning commands separated by semi-colons. The
2017scaling/positioning commands are as follows:
2018 2123
2019=over 4 2124=over 4
2020 2125
2021=item query scale/position 2126=item B<< C<?> >>
2022 2127
2023B<?> 2128display scale and position in the title
2024 2129
2130=item B<< C<;WxH+X+Y> >>
2131
2025=item change scale and position 2132change scale and/or position
2026 2133
2027B<WxH+X+Y> 2134=item B<< C<FILE;WxH+X+Y> >>
2028 2135
2029B<WxH+X> (== B<WxH+X+X>) 2136change background image
2030
2031B<WxH> (same as B<WxH+50+50>)
2032
2033B<W+X+Y> (same as B<WxW+X+Y>)
2034
2035B<W+X> (same as B<WxW+X+X>)
2036
2037B<W> (same as B<WxW+50+50>)
2038
2039=item change position (absolute)
2040
2041B<=+X+Y>
2042
2043B<=+X> (same as B<=+X+Y>)
2044
2045=item change position (relative)
2046
2047B<+X+Y>
2048
2049B<+X> (same as B<+X+Y>)
2050
2051=item rescale (relative)
2052
2053B<Wx0> -> B<W *= (W/100)>
2054
2055B<0xH> -> B<H *= (H/100)>
2056 2137
2057=back 2138=back
2058 2139
2059For example:
2060
2061=over 4
2062
2063=item B<\E]20;funky\a>
2064
2065load B<funky.xpm> as a tiled image
2066
2067=item B<\E]20;mona;100\a>
2068
2069load B<mona.xpm> with a scaling of 100%
2070
2071=item B<\E]20;;200;?\a>
2072
2073rescale the current pixmap to 200% and display the image geometry in
2074the title
2075
2076=back
2077X<Mouse> 2140X<Mouse>
2078 2141
2079=head1 Mouse Reporting 2142=head1 Mouse Reporting
2080 2143
2081=over 4 2144=over 4
2106The upper bits of B<< C<< <b> >> >> indicate the modifiers when the 2169The upper bits of B<< C<< <b> >> >> indicate the modifiers when the
2107button was pressed and are added together (X11 mouse report only): 2170button was pressed and are added together (X11 mouse report only):
2108 2171
2109=over 4 2172=over 4
2110 2173
2111=item State = B<< C<< (<b> - SPACE) & 60 >> >> 2174=item State = B<< C<< (<b> - SPACE) & ~3 >> >>
2112 2175
2113=begin table 2176=begin table
2114 2177
2115 4 Shift 2178 4 Shift
2116 8 Meta 2179 8 Meta
2117 16 Control 2180 16 Control
2181 32 Motion Notify
2118 32 Double Click I<(rxvt extension)> 2182 32 Double Click I<(rxvt extension)>, disabled by default
2183 64 Button1 is actually Button4, Button2 is actually Button5 etc.
2119 2184
2120=end table 2185=end table
2121 2186
2122Col = B<< C<< <x> - SPACE >> >> 2187Col = B<< C<< <x> - SPACE >> >>
2123 2188
2124Row = B<< C<< <y> - SPACE >> >> 2189Row = B<< C<< <y> - SPACE >> >>
2125 2190
2126=back 2191=back
2192
2193=head1 Key Codes
2194
2127X<KeyCodes> 2195X<KeyCodes>
2128 2196
2129=head1 Key Codes
2130
2131Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 2197Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
2132 2198
2133For the keypad, use B<Shift> to temporarily override Application-Keypad 2199For the keypad, use B<Shift> to temporarily toggle Application Keypad
2134setting use B<Num_Lock> to toggle Application-Keypad setting if 2200mode and use B<Num_Lock> to override Application Keypad mode, i.e. if
2135B<Num_Lock> is off, toggle Application-Keypad setting. Also note that 2201B<Num_Lock> is on the keypad is in normal mode. Also note that the
2136values of B<Home>, B<End>, B<Delete> may have been compiled differently on 2202values of B<BackSpace>, B<Delete> may have been compiled differently
2137your system. 2203on your system.
2138 2204
2139=begin table 2205=begin table
2140 2206
2141 B<Normal> B<Shift> B<Control> B<Ctrl+Shift> 2207 B<Normal> B<Shift> B<Control> B<Ctrl+Shift>
2142 Tab ^I ESC [ Z ^I ESC [ Z 2208 Tab ^I ESC [ Z ^I ESC [ Z
2143 BackSpace ^H ^? ^? ^? 2209 BackSpace ^? ^? ^H ^H
2144 Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @ 2210 Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @
2145 Insert ESC [ 2 ~ I<paste> ESC [ 2 ^ ESC [ 2 @ 2211 Insert ESC [ 2 ~ I<paste> ESC [ 2 ^ ESC [ 2 @
2146 Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @ 2212 Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
2147 Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @ 2213 Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @
2148 Prior ESC [ 5 ~ I<scroll-up> ESC [ 5 ^ ESC [ 5 @ 2214 Prior ESC [ 5 ~ I<scroll-up> ESC [ 5 ^ ESC [ 5 @
2178 KP_Enter ^M ESC O M 2244 KP_Enter ^M ESC O M
2179 KP_F1 ESC O P ESC O P 2245 KP_F1 ESC O P ESC O P
2180 KP_F2 ESC O Q ESC O Q 2246 KP_F2 ESC O Q ESC O Q
2181 KP_F3 ESC O R ESC O R 2247 KP_F3 ESC O R ESC O R
2182 KP_F4 ESC O S ESC O S 2248 KP_F4 ESC O S ESC O S
2183 XK_KP_Multiply * ESC O j 2249 KP_Multiply * ESC O j
2184 XK_KP_Add + ESC O k 2250 KP_Add + ESC O k
2185 XK_KP_Separator , ESC O l 2251 KP_Separator , ESC O l
2186 XK_KP_Subtract - ESC O m 2252 KP_Subtract - ESC O m
2187 XK_KP_Decimal . ESC O n 2253 KP_Decimal . ESC O n
2188 XK_KP_Divide / ESC O o 2254 KP_Divide / ESC O o
2189 XK_KP_0 0 ESC O p 2255 KP_0 0 ESC O p
2190 XK_KP_1 1 ESC O q 2256 KP_1 1 ESC O q
2191 XK_KP_2 2 ESC O r 2257 KP_2 2 ESC O r
2192 XK_KP_3 3 ESC O s 2258 KP_3 3 ESC O s
2193 XK_KP_4 4 ESC O t 2259 KP_4 4 ESC O t
2194 XK_KP_5 5 ESC O u 2260 KP_5 5 ESC O u
2195 XK_KP_6 6 ESC O v 2261 KP_6 6 ESC O v
2196 XK_KP_7 7 ESC O w 2262 KP_7 7 ESC O w
2197 XK_KP_8 8 ESC O x 2263 KP_8 8 ESC O x
2198 XK_KP_9 9 ESC O y 2264 KP_9 9 ESC O y
2199 2265
2200=end table 2266=end table
2201 2267
2202=head1 CONFIGURE OPTIONS 2268=head1 CONFIGURE OPTIONS
2203 2269
2204General hint: if you get compile errors, then likely your configuration 2270General hint: if you get compile errors, then likely your configuration
2205hasn't been tested well. Either try with C<--enable-everything> or use 2271hasn't been tested well. Either try with C<--enable-everything> or use
2206the default configuration (i.e. C<--enable-xxx> or C<--disable-xxx>). Of 2272the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2207course, you should always report when a combination doesn't work, so it 2273switches). Of course, you should always report when a combination doesn't
2208can be fixed. Marc Lehmann <rxvt@schmorp.de>. 2274work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2209 2275
2210All 2276All
2211 2277
2212=over 4 2278=over 4
2213 2279
2214=item --enable-everything 2280=item --enable-everything
2215 2281
2216Add (or remove) support for all non-multichoice options listed in "./configure 2282Add (or remove) support for all non-multichoice options listed
2217--help". 2283in C<./configure --help>, except for C<--enable-assert> and
2284C<--enable-256-color>.
2218 2285
2219You can specify this and then disable options you do not like by 2286You can specify this and then disable options you do not like by
2220I<following> this with the appropriate C<--disable-...> arguments, 2287I<following> this with the appropriate C<--disable-...> arguments,
2221or you can start with a minimal configuration by specifying 2288or you can start with a minimal configuration by specifying
2222C<--disable-everything> and than adding just the C<--enable-...> arguments 2289C<--disable-everything> and than adding just the C<--enable-...> arguments
2223you want. 2290you want.
2224 2291
2225=item --enable-xft (default: enabled) 2292=item --enable-xft (default: on)
2226 2293
2227Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2294Add support for Xft (anti-aliased, among others) fonts. Xft fonts are
2228slower and require lots of memory, but as long as you don't use them, you 2295slower and require lots of memory, but as long as you don't use them, you
2229don't pay for them. 2296don't pay for them.
2230 2297
2231=item --enable-font-styles (default: on) 2298=item --enable-font-styles (default: on)
2232 2299
2233Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2300Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2234styles. The fonts can be set manually or automatically. 2301styles. The fonts can be set manually or automatically.
2235 2302
2236=item --with-codesets=NAME,... (default: all) 2303=item --with-codesets=CS,... (default: all)
2237 2304
2238Compile in support for additional codeset (encoding) groups (C<eu>, C<vn> 2305Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2239are always compiled in, which includes most 8-bit character sets). These 2306are always compiled in, which includes most 8-bit character sets). These
2240codeset tables are used for driving X11 core fonts, they are not required 2307codeset tables are used for driving X11 core fonts, they are not required
2241for Xft fonts, although having them compiled in lets rxvt-unicode choose 2308for Xft fonts, although having them compiled in lets rxvt-unicode choose
2277 2344
2278=item --enable-combining (default: on) 2345=item --enable-combining (default: on)
2279 2346
2280Enable automatic composition of combining characters into 2347Enable automatic composition of combining characters into
2281composite characters. This is required for proper viewing of text 2348composite characters. This is required for proper viewing of text
2282where accents are encoded as seperate unicode characters. This is 2349where accents are encoded as separate unicode characters. This is
2283done by using precomposited characters when available or creating 2350done by using precomposed characters when available or creating
2284new pseudo-characters when no precomposed form exists. 2351new pseudo-characters when no precomposed form exists.
2285 2352
2286Without --enable-unicode3, the number of additional precomposed 2353Without --enable-unicode3, the number of additional precomposed
2287characters is somewhat limited (the 6400 private use characters will be 2354characters is somewhat limited (the 6400 private use characters will be
2288(ab-)used). With --enable-unicode3, no practical limit exists. 2355(ab-)used). With --enable-unicode3, no practical limit exists.
2292 2359
2293The combining table also contains entries for arabic presentation forms, 2360The combining table also contains entries for arabic presentation forms,
2294but these are not currently used. Bug me if you want these to be used (and 2361but these are not currently used. Bug me if you want these to be used (and
2295tell me how these are to be used...). 2362tell me how these are to be used...).
2296 2363
2297=item --enable-fallback(=CLASS) (default: Rxvt) 2364=item --enable-fallback[=CLASS] (default: Rxvt)
2298 2365
2299When reading resource settings, also read settings for class CLASS. To 2366When reading resource settings, also read settings for class CLASS. To
2300disable resource fallback use --disable-fallback. 2367disable resource fallback use --disable-fallback.
2301 2368
2302=item --with-res-name=NAME (default: urxvt) 2369=item --with-res-name=NAME (default: urxvt)
2303 2370
2304Use the given name as default application name when 2371Use the given name as default application name when
2305reading resources. Specify --with-res-name=rxvt to replace rxvt. 2372reading resources. Specify --with-res-name=rxvt to replace rxvt.
2306 2373
2307=item --with-res-class=CLASS /default: URxvt) 2374=item --with-res-class=CLASS (default: URxvt)
2308 2375
2309Use the given class as default application class 2376Use the given class as default application class
2310when reading resources. Specify --with-res-class=Rxvt to replace 2377when reading resources. Specify --with-res-class=Rxvt to replace
2311rxvt. 2378rxvt.
2312 2379
2325 2392
2326Write user and tty to lastlog file (used by programs like 2393Write user and tty to lastlog file (used by programs like
2327F<lastlogin>) at start of rxvt execution. This option requires 2394F<lastlogin>) at start of rxvt execution. This option requires
2328--enable-utmp to also be specified. 2395--enable-utmp to also be specified.
2329 2396
2330=item --enable-afterimage (default: on) 2397=item --enable-pixbuf (default: on)
2331 2398
2332Add support for libAfterImage to be used for transparency and background 2399Add support for GDK-PixBuf to be used for background images.
2333images. It adds support for many file formats including JPG, PNG, 2400It adds support for many file formats including JPG, PNG,
2334SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML 2401TIFF, GIF, XPM, BMP, ICO and TGA.
2335(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2336 2402
2337This option also adds such eye candy as blending an image over the root 2403=item --enable-startup-notification (default: on)
2338background, as well as dynamic scaling and bluring of background images.
2339 2404
2340Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might 2405Add support for freedesktop startup notifications. This allows window managers
2341increase by a few megabytes even if no extra features are used (mostly due 2406to display some kind of progress indicator during startup.
2342to third-party libraries used by libAI). Memory footprint may somewhat be
2343lowered if libAfterImage is configured without support for SVG.
2344 2407
2345=item --enable-transparency (default: on) 2408=item --enable-transparency (default: on)
2346 2409
2347Add support for inheriting parent backgrounds thus giving a fake 2410Add support for using the root pixmap as background to simulate transparency.
2348transparency to the term. 2411Note that this feature depends on libXrender and on the availability
2412of the RENDER extension in the X server.
2349 2413
2350=item --enable-fading (default: on) 2414=item --enable-fading (default: on)
2351 2415
2352Add support for fading the text when focus is lost. 2416Add support for fading the text when focus is lost.
2353 2417
2354=item --enable-tinting (default: on)
2355
2356Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2357
2358=item --enable-rxvt-scroll (default: on) 2418=item --enable-rxvt-scroll (default: on)
2359 2419
2360Add support for the original rxvt scrollbar. 2420Add support for the original rxvt scrollbar.
2361 2421
2362=item --enable-next-scroll (default: on) 2422=item --enable-next-scroll (default: on)
2364Add support for a NeXT-like scrollbar. 2424Add support for a NeXT-like scrollbar.
2365 2425
2366=item --enable-xterm-scroll (default: on) 2426=item --enable-xterm-scroll (default: on)
2367 2427
2368Add support for an Xterm-like scrollbar. 2428Add support for an Xterm-like scrollbar.
2369
2370=item --enable-plain-scroll (default: on)
2371
2372Add support for a very unobtrusive, plain-looking scrollbar that
2373is the favourite of the rxvt-unicode author, having used it for
2374many years.
2375
2376=item --enable-ttygid (default: off)
2377
2378Change tty device setting to group "tty" - only use this if
2379your system uses this type of security.
2380 2429
2381=item --disable-backspace-key 2430=item --disable-backspace-key
2382 2431
2383Removes any handling of the backspace key by us - let the X server do it. 2432Removes any handling of the backspace key by us - let the X server do it.
2384 2433
2405in combination with other switches) is: 2454in combination with other switches) is:
2406 2455
2407 MWM-hints 2456 MWM-hints
2408 EWMH-hints (pid, utf8 names) and protocols (ping) 2457 EWMH-hints (pid, utf8 names) and protocols (ping)
2409 urgency hint 2458 urgency hint
2410 seperate underline colour (-underlineColor) 2459 separate underline colour (-underlineColor)
2411 settable border widths and borderless switch (-w, -b, -bl) 2460 settable border widths and borderless switch (-w, -b, -bl)
2412 visual depth selection (-depth) 2461 visual depth selection (-depth)
2413 settable extra linespacing /-lsp) 2462 settable extra linespacing (-lsp)
2414 iso-14755 5.1 (basic) support 2463 iso-14755 5.1 (basic) support
2415 tripleclickwords (-tcw) 2464 tripleclickwords (-tcw)
2416 settable insecure mode (-insecure) 2465 settable insecure mode (-insecure)
2417 keysym remapping support 2466 keysym remapping support
2418 cursor blinking and underline cursor (-cb, -uc) 2467 cursor blinking and underline cursor (-bc, -uc)
2419 XEmbed support (-embed) 2468 XEmbed support (-embed)
2420 user-pty (-pty-fd) 2469 user-pty (-pty-fd)
2421 hold on exit (-hold) 2470 hold on exit (-hold)
2471 compile in built-in block graphics
2422 skip builtin block graphics (-sbg) 2472 skip builtin block graphics (-sbg)
2423 separate highlightcolor support (-hc) 2473 separate highlight colour (-highlightColor, -highlightTextColor)
2474 focus reporting mode (1004).
2475 extended mouse reporting modes (1005 and 1015).
2476 visual selection via -visual and -depth.
2424 2477
2425It also enables some non-essential features otherwise disabled, such as: 2478It also enables some non-essential features otherwise disabled, such as:
2426 2479
2427 some round-trip time optimisations 2480 some round-trip time optimisations
2428 nearest color allocation on pseudocolor screens 2481 nearest colour allocation on pseudocolor screens
2429 UTF8_STRING support for selection 2482 UTF8_STRING support for selection
2430 sgr modes 90..97 and 100..107 2483 sgr modes 90..97 and 100..107
2431 backindex and forwardindex escape sequences 2484 backindex and forwardindex escape sequences
2432 view change/zero scrollback escape sequences 2485 view change/zero scrollback escape sequences
2433 locale switching escape sequence 2486 locale switching escape sequence
2436 trailing space removal for selections 2489 trailing space removal for selections
2437 verbose X error handling 2490 verbose X error handling
2438 2491
2439=item --enable-iso14755 (default: on) 2492=item --enable-iso14755 (default: on)
2440 2493
2441Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2494Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)).
2442F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2495Basic support (section 5.1) is enabled by C<--enable-frills>, while
2443C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2496support for 5.2, 5.3 and 5.4 is enabled with this switch.
2444this switch.
2445 2497
2446=item --enable-keepscrolling (default: on) 2498=item --enable-keepscrolling (default: on)
2447 2499
2448Add support for continual scrolling of the display when you hold 2500Add support for continual scrolling of the display when you hold
2449the mouse button down on a scrollbar arrow. 2501the mouse button down on a scrollbar arrow.
2467 2519
2468Add smart growth/shrink behaviour when resizing. 2520Add smart growth/shrink behaviour when resizing.
2469This should keep the window corner which is closest to a corner of 2521This should keep the window corner which is closest to a corner of
2470the screen in a fixed position. 2522the screen in a fixed position.
2471 2523
2524=item --enable-text-blink (default: on)
2525
2526Add support for blinking text.
2527
2472=item --enable-pointer-blank (default: on) 2528=item --enable-pointer-blank (default: on)
2473 2529
2474Add support to have the pointer disappear when typing or inactive. 2530Add support to have the pointer disappear when typing or inactive.
2475 2531
2476=item --enable-perl (default: on) 2532=item --enable-perl (default: on)
2477 2533
2478Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2534Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2479manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the 2535manpage for more info on this feature, or the files in F<src/perl/>
2480files in F<src/perl-ext/> for the extensions that are installed by 2536for the extensions that are installed by default.
2481default. The perl interpreter that is used can be specified via the 2537The perl interpreter that is used can be specified via the C<PERL>
2482C<PERL> environment variable when running configure. Even when compiled 2538environment variable when running configure. Even when compiled in,
2483in, perl will I<not> be initialised when all extensions have been disabled 2539perl will I<not> be initialised when all extensions have been disabled
2484C<-pe "" --perl-ext-common "">, so it should be safe to enable from a 2540C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2485resource standpoint. 2541resource standpoint.
2486 2542
2487=item --with-afterimage-config=DIR 2543=item --enable-assert (default: off)
2488 2544
2489Look for the libAfterImage config script in DIR. 2545Enables the assertions in the code, normally disabled. This switch is only
2546useful when developing rxvt-unicode.
2547
2548=item --enable-256-color (default: off)
2549
2550Force use of so-called 256 colour mode, to work around buggy applications
2551that do not support termcap/terminfo, or simply improve support for
2552applications hardcoding the xterm 256 colour table.
2553
2554This switch breaks termcap/terminfo compatibility to C<TERM=rxvt-unicode>,
2555and consequently sets C<TERM> to C<rxvt-unicode-256color> by default
2556(F<doc/etc/> contains termcap/terminfo definitions for both).
2557
2558It also results in higher memory usage and can slow down @@RXVT_NAME@@
2559dramatically when more than six fonts are in use by a terminal instance.
2490 2560
2491=item --with-name=NAME (default: urxvt) 2561=item --with-name=NAME (default: urxvt)
2492 2562
2493Set the basename for the installed binaries, resulting 2563Set the basename for the installed binaries, resulting
2494in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2564in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines