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.177 by root, Sat May 30 08:53:48 2009 UTC vs.
Revision 1.234 by sf-exg, Mon Nov 24 21:46:04 2014 UTC

… …
105This tries to create a new terminal, and if fails with exit status 2, 105This tries to create a new terminal, and if fails with exit status 2,
106meaning it couldn't connect to the daemon, it will start the daemon and 106meaning it couldn't connect to the daemon, it will start the daemon and
107re-run the command. Subsequent invocations of the script will re-use the 107re-run the command. Subsequent invocations of the script will re-use the
108existing daemon. 108existing daemon.
109 109
110=head3 How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc. 110=head3 How do I distinguish whether I'm running rxvt-unicode or a regular
111xterm? I need this to decide about setting colours etc.
111 112
112The original rxvt and rxvt-unicode always export the variable "COLORTERM", 113The original rxvt and rxvt-unicode always export the variable "COLORTERM",
113so you can check and see if that is set. Note that several programs, JED, 114so you can check and see if that is set. Note that several programs, JED,
114slrn, Midnight Commander automatically check this variable to decide 115slrn, Midnight Commander automatically check this variable to decide
115whether or not to use color. 116whether or not to use colour.
116 117
117=head3 How do I set the correct, full IP address for the DISPLAY variable? 118=head3 How do I set the correct, full IP address for the DISPLAY variable?
118 119
119If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled 120If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
120insecure mode then it is possible to use the following shell script 121insecure mode then it is possible to use the following shell script
… …
128 129
129 # Bourne/Korn/POSIX family of shells: 130 # Bourne/Korn/POSIX family of shells:
130 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know 131 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
131 if [ ${TERM:-foo} = xterm ]; then 132 if [ ${TERM:-foo} = xterm ]; then
132 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not 133 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
133 echo -n '^[Z' 134 printf "\eZ"
134 read term_id 135 read term_id
135 stty icanon echo 136 stty icanon echo
136 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then 137 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
137 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string 138 printf '\e[7n' # query the rxvt we are in for the DISPLAY string
138 read DISPLAY # set it in our local shell 139 read DISPLAY # set it in our local shell
139 fi 140 fi
140 fi 141 fi
141 142
142=head3 How do I compile the manual pages on my own? 143=head3 How do I compile the manual pages on my own?
143 144
… …
198the case of rxvt-unicode this hardly matters, as its portability limits 199the case of rxvt-unicode this hardly matters, as its portability limits
199are defined by things like X11, pseudo terminals, locale support and unix 200are defined by things like X11, pseudo terminals, locale support and unix
200domain sockets, which are all less portable than C++ itself. 201domain sockets, which are all less portable than C++ itself.
201 202
202Regarding the bloat, see the above question: It's easy to write programs 203Regarding the bloat, see the above question: It's easy to write programs
203in C that use gobs of memory, an certainly possible to write programs in 204in C that use gobs of memory, and certainly possible to write programs in
204C++ that don't. C++ also often comes with large libraries, but this is 205C++ that don't. C++ also often comes with large libraries, but this is
205not necessarily the case with GCC. Here is what rxvt links against on my 206not necessarily the case with GCC. Here is what rxvt links against on my
206system with a minimal config: 207system with a minimal config:
207 208
208 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) 209 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
… …
224 225
225=head2 Rendering, Font & Look and Feel Issues 226=head2 Rendering, Font & Look and Feel Issues
226 227
227=head3 I can't get transparency working, what am I doing wrong? 228=head3 I can't get transparency working, what am I doing wrong?
228 229
229First of all, please address all transparency related issues to Sasha Vasko at 230First of all, transparency isn't officially supported in rxvt-unicode, so
230sasha@aftercode.net and do not bug the author about it. Also, if you can't 231you are mostly on your own. Do not bug the author about it (but you may
231get it working consider it a rite of passage: ... and you failed. 232bug everybody else). Also, if you can't get it working consider it a rite
233of passage: ... and you failed.
232 234
233Here are four ways to get transparency. B<Do> read the manpage and option 235Here are four ways to get transparency. B<Do> read the manpage and option
234descriptions for the programs mentioned and rxvt-unicode. Really, do it! 236descriptions for the programs mentioned and rxvt-unicode. Really, do it!
235 237
2361. Use transparent mode: 2381. Use transparent mode:
… …
238 Esetroot wallpaper.jpg 240 Esetroot wallpaper.jpg
239 @@URXVT_NAME@@ -tr -tint red -sh 40 241 @@URXVT_NAME@@ -tr -tint red -sh 40
240 242
241That works. If you think it doesn't, you lack transparency and tinting 243That works. If you think it doesn't, you lack transparency and tinting
242support, or you are unable to read. 244support, or you are unable to read.
245This method requires that the background-setting program sets the
246_XROOTPMAP_ID or ESETROOT_PMAP_ID property. Compatible programs
247are Esetroot, hsetroot and feh.
243 248
2442. Use a simple pixmap and emulate pseudo-transparency. This enables you 2492. Use a simple pixmap and emulate pseudo-transparency. This enables you
245to use effects other than tinting and shading: Just shade/tint/whatever 250to use effects other than tinting and shading: Just shade/tint/whatever
246your picture with gimp or any other tool: 251your picture with gimp or any other tool:
247 252
248 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg 253 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
249 @@URXVT_NAME@@ -pixmap "background.jpg;:root" 254 @@URXVT_NAME@@ -pixmap "background.jpg;:root"
250 255
251That works. If you think it doesn't, you lack AfterImage support, or you 256That works. If you think it doesn't, you lack GDK-PixBuf support, or you
252are unable to read. 257are unable to read.
253 258
2543. Use an ARGB visual: 2593. Use an ARGB visual:
255 260
256 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc 261 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
… …
361For the standard background colour, blinking will actually make 366For the standard background colour, blinking will actually make
362the text blink when compiled with C<--enable-text-blink>. Without 367the text blink when compiled with C<--enable-text-blink>. Without
363C<--enable-text-blink>, the blink attribute will be ignored. 368C<--enable-text-blink>, the blink attribute will be ignored.
364 369
365On ANSI colours, bold/blink attributes are used to set high-intensity 370On ANSI colours, bold/blink attributes are used to set high-intensity
366foreground/background colors. 371foreground/background colours.
367 372
368color0-7 are the low-intensity colors. 373color0-7 are the low-intensity colours.
369 374
370color8-15 are the corresponding high-intensity colors. 375color8-15 are the corresponding high-intensity colours.
371 376
372=head3 I don't like the screen colors. How do I change them? 377=head3 I don't like the screen colours. How do I change them?
373 378
374You can change the screen colors at run-time using F<~/.Xdefaults> 379You can change the screen colours at run-time using F<~/.Xdefaults>
375resources (or as long-options). 380resources (or as long-options).
376 381
377Here are values that are supposed to resemble a VGA screen, 382Here are values that are supposed to resemble a VGA screen,
378including the murky brown that passes for low-intensity yellow: 383including the murky brown that passes for low-intensity yellow:
379 384
… …
393 URxvt.color12: #0000FF 398 URxvt.color12: #0000FF
394 URxvt.color13: #FF00FF 399 URxvt.color13: #FF00FF
395 URxvt.color14: #00FFFF 400 URxvt.color14: #00FFFF
396 URxvt.color15: #FFFFFF 401 URxvt.color15: #FFFFFF
397 402
398And here is a more complete set of non-standard colors. 403And here is a more complete set of non-standard colours.
399 404
400 URxvt.cursorColor: #dc74d1 405 URxvt.cursorColor: #dc74d1
401 URxvt.pointerColor: #dc74d1 406 URxvt.pointerColor: #dc74d1
402 URxvt.background: #0e0e0e 407 URxvt.background: #0e0e0e
403 URxvt.foreground: #4ad5e1 408 URxvt.foreground: #4ad5e1
… …
537You can permanently switch this feature off by disabling the C<readline> 542You can permanently switch this feature off by disabling the C<readline>
538extension: 543extension:
539 544
540 URxvt.perl-ext-common: default,-readline 545 URxvt.perl-ext-common: default,-readline
541 546
542=head3 My numerical keypad acts weird and generates differing output? 547=head3 My numeric keypad acts weird and generates differing output?
543 548
544Some Debian GNUL/Linux users seem to have this problem, although no 549Some Debian GNU/Linux users seem to have this problem, although no
545specific details were reported so far. It is possible that this is caused 550specific details were reported so far. It is possible that this is caused
546by the wrong C<TERM> setting, although the details of whether and how 551by the wrong C<TERM> setting, although the details of whether and how
547this can happen are unknown, as C<TERM=rxvt> should offer a compatible 552this can happen are unknown, as C<TERM=rxvt> should offer a compatible
548keymap. See the answer to the previous question, and please report if that 553keymap. See the answer to the previous question, and please report if that
549helped. 554helped.
550 555
551=head3 My Compose (Multi_key) key is no longer working. 556=head3 My Compose (Multi_key) key is no longer working.
552 557
553The most common causes for this are that either your locale is not set 558The most common causes for this are that either your locale is not set
554correctly, or you specified a B<preeditStyle> that is not supported by 559correctly, or you specified a B<preeditType> that is not supported by
555your input method. For example, if you specified B<OverTheSpot> and 560your input method. For example, if you specified B<OverTheSpot> and
556your input method (e.g. the default input method handling Compose keys) 561your input method (e.g. the default input method handling Compose keys)
557does not support this (for instance because it is not visual), then 562does not support this (for instance because it is not visual), then
558rxvt-unicode will continue without an input method. 563rxvt-unicode will continue without an input method.
559 564
560In this case either do not specify a B<preeditStyle> or specify more than 565In this case either do not specify a B<preeditType> or specify more than
561one pre-edit style, such as B<OverTheSpot,Root,None>. 566one pre-edit style, such as B<OverTheSpot,Root,None>.
567
568If it still doesn't work, then maybe your input method doesn't support
569compose sequences - to fall back to the built-in one, make sure you don't
570specify an input method via C<-im> or C<XMODIFIERS>.
562 571
563=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755 572=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
564 573
565Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on 574Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
566international keyboards) or simply use ISO 14755 support to your 575international keyboards) or simply use ISO 14755 support to your
… …
569character and so on. 578character and so on.
570 579
571=head3 Mouse cut/paste suddenly no longer works. 580=head3 Mouse cut/paste suddenly no longer works.
572 581
573Make sure that mouse reporting is actually turned off since killing 582Make sure that mouse reporting is actually turned off since killing
574some editors prematurely may leave the mouse in mouse report mode. I've 583some editors prematurely may leave it active. I've
575heard that tcsh may use mouse reporting unless it otherwise specified. A 584heard that tcsh may use mouse reporting unless it is otherwise specified. A
576quick check is to see if cut/paste works when the Alt or Shift keys are 585quick check is to see if cut/paste works when the Alt or Shift keys are
577depressed. 586pressed.
578 587
579=head3 What's with the strange Backspace/Delete key behaviour? 588=head3 What's with the strange Backspace/Delete key behaviour?
580 589
581Assuming that the physical Backspace key corresponds to the 590Assuming that the physical Backspace key corresponds to the
582Backspace keysym (not likely for Linux ... see the following 591Backspace keysym (not likely for Linux ... see the following
… …
585 594
586Historically, either value is correct, but rxvt-unicode adopts the debian 595Historically, either value is correct, but rxvt-unicode adopts the debian
587policy of using C<^?> when unsure, because it's the one and only correct 596policy of using C<^?> when unsure, because it's the one and only correct
588choice :). 597choice :).
589 598
590Rxvt-unicode tries to inherit the current stty settings and uses the value 599It is possible to toggle between C<^H> and C<^?> with the DECBKM
591of `erase' to guess the value for backspace. If rxvt-unicode wasn't 600private mode:
592started from a terminal (say, from a menu or by remote shell), then the
593system value of `erase', which corresponds to CERASE in <termios.h>, will
594be used (which may not be the same as your stty setting).
595
596For starting a new rxvt-unicode:
597 601
598 # use Backspace = ^H 602 # use Backspace = ^H
599 $ stty erase ^H 603 $ stty erase ^H
600 $ @@URXVT_NAME@@ 604 $ printf "\e[?67h"
601 605
602 # use Backspace = ^? 606 # use Backspace = ^?
603 $ stty erase ^? 607 $ stty erase ^?
604 $ @@URXVT_NAME@@ 608 $ printf "\e[?67l"
605
606Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
607
608For an existing rxvt-unicode:
609
610 # use Backspace = ^H
611 $ stty erase ^H
612 $ echo -n "^[[36h"
613
614 # use Backspace = ^?
615 $ stty erase ^?
616 $ echo -n "^[[36l"
617 609
618This helps satisfy some of the Backspace discrepancies that occur, but 610This helps satisfy some of the Backspace discrepancies that occur, but
619if you use Backspace = C<^H>, make sure that the termcap/terminfo value 611if you use Backspace = C<^H>, make sure that the termcap/terminfo value
620properly reflects that. 612properly reflects that.
621 613
… …
638you have run "configure" with the C<--disable-resources> option you can 630you have run "configure" with the C<--disable-resources> option you can
639use the `keysym' resource to alter the keystrings associated with keysyms. 631use the `keysym' resource to alter the keystrings associated with keysyms.
640 632
641Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt> 633Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
642 634
635 URxvt.keysym.Prior: \033[5~
636 URxvt.keysym.Next: \033[6~
643 URxvt.keysym.Home: \033[1~ 637 URxvt.keysym.Home: \033[7~
644 URxvt.keysym.End: \033[4~ 638 URxvt.keysym.End: \033[8~
645 URxvt.keysym.C-apostrophe: \033<C-'>
646 URxvt.keysym.C-slash: \033<C-/>
647 URxvt.keysym.C-semicolon: \033<C-;>
648 URxvt.keysym.C-grave: \033<C-`>
649 URxvt.keysym.C-comma: \033<C-,>
650 URxvt.keysym.C-period: \033<C-.>
651 URxvt.keysym.C-0x60: \033<C-`>
652 URxvt.keysym.C-Tab: \033<C-Tab>
653 URxvt.keysym.C-Return: \033<C-Return>
654 URxvt.keysym.S-Return: \033<S-Return>
655 URxvt.keysym.S-space: \033<S-Space>
656 URxvt.keysym.M-Up: \033<M-Up> 639 URxvt.keysym.Up: \033[A
657 URxvt.keysym.M-Down: \033<M-Down> 640 URxvt.keysym.Down: \033[B
641 URxvt.keysym.Right: \033[C
658 URxvt.keysym.M-Left: \033<M-Left> 642 URxvt.keysym.Left: \033[D
659 URxvt.keysym.M-Right: \033<M-Right>
660 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
661 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
662 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
663 643
664See some more examples in the documentation for the B<keysym> resource. 644See some more examples in the documentation for the B<keysym> resource.
665 645
666=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 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 647
… …
714develop for myself mostly, so I actually use most of the extensions I 694develop for myself mostly, so I actually use most of the extensions I
715write. 695write.
716 696
717The selection stuff mainly makes the selection perl-error-message aware 697The selection stuff mainly makes the selection perl-error-message aware
718and tells it to convert perl error messages into vi-commands to load the 698and tells it to convert perl error messages into vi-commands to load the
719relevant file and go tot he error line number. 699relevant file and go to the error line number.
720 700
721 URxvt.scrollstyle: plain 701 URxvt.scrollstyle: plain
722 URxvt.secondaryScroll: true 702 URxvt.secondaryScroll: true
723 703
724As the documentation says: plain is the preferred scrollbar for the 704As the documentation says: plain is the preferred scrollbar for the
… …
796purposes, it works, and gives a different look, as my normal (Non-bold) 776purposes, it works, and gives a different look, as my normal (Non-bold)
797font is already bold, and I want to see a difference between bold and 777font is already bold, and I want to see a difference between bold and
798normal fonts. 778normal fonts.
799 779
800Please note that I used the C<urxvt> instance name and not the C<URxvt> 780Please note that I used the C<urxvt> instance name and not the C<URxvt>
801class name. Thats because I use different configs for different purposes, 781class name. That is because I use different configs for different purposes,
802for example, my IRC window is started with C<-name IRC>, and uses these 782for example, my IRC window is started with C<-name IRC>, and uses these
803defaults: 783defaults:
804 784
805 IRC*title: IRC 785 IRC*title: IRC
806 IRC*geometry: 87x12+535+542 786 IRC*geometry: 87x12+535+542
… …
817stuff while keeping a very small window. If somebody pastes something 797stuff while keeping a very small window. If somebody pastes something
818complicated (e.g. japanese), I temporarily switch to a larger font. 798complicated (e.g. japanese), I temporarily switch to a larger font.
819 799
820The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor 800The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
821C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname> 801C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
822file for different hosts, for example, on ym main desktop, I use: 802file for different hosts, for example, on my main desktop, I use:
823 803
824 URxvt.keysym.C-M-q: command:\033[3;5;5t 804 URxvt.keysym.C-M-q: command:\033[3;5;5t
825 URxvt.keysym.C-M-y: command:\033[3;5;606t 805 URxvt.keysym.C-M-y: command:\033[3;5;606t
826 URxvt.keysym.C-M-e: command:\033[3;1605;5t 806 URxvt.keysym.C-M-e: command:\033[3;1605;5t
827 URxvt.keysym.C-M-c: command:\033[3;1605;606t 807 URxvt.keysym.C-M-c: command:\033[3;1605;606t
… …
866 846
867 REMOTE=remotesystem.domain 847 REMOTE=remotesystem.domain
868 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti" 848 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
869 849
870One some systems you might need to set C<$TERMINFO> to the full path of 850One some systems you might need to set C<$TERMINFO> to the full path of
871F<$HOME/.terminfo> for this to work. 851F<$HOME/.terminfo> for this to work. Debian systems have a broken tic
852which will not be able to overwrite the existing rxvt-unicode terminfo
853entry - you might have to manually delete all traces of F<rxvt-unicode*>
854from F</etc/terminfo>.
872 855
873If you cannot or do not want to do this, then you can simply set 856If you cannot or do not want to do this, then you can simply set
874C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of 857C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
875problems arising, which includes wrong keymapping, less and different 858problems arising, which includes wrong keymapping, less and different
876colours and some refresh errors in fullscreen applications. It's a nice 859colours and some refresh errors in fullscreen applications. It's a nice
… …
1074C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input 1057C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1075method servers are running with this command: 1058method servers are running with this command:
1076 1059
1077 xprop -root XIM_SERVERS 1060 xprop -root XIM_SERVERS
1078 1061
1079=item
1080
1081=back 1062=back
1082 1063
1083=head3 My input method wants <some encoding> but I want UTF-8, what can I do? 1064=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
1084 1065
1085You can specify separate locales for the input method and the rest of the 1066You can specify separate locales for the input method and the rest of the
… …
1110 1091
1111The Debian GNU/Linux package of rxvt-unicode in sarge contains large 1092The Debian GNU/Linux package of rxvt-unicode in sarge contains large
1112patches that considerably change the behaviour of rxvt-unicode (but 1093patches that considerably change the behaviour of rxvt-unicode (but
1113unfortunately this notice has been removed). Before reporting a bug to 1094unfortunately this notice has been removed). Before reporting a bug to
1114the original rxvt-unicode author please download and install the genuine 1095the original rxvt-unicode author please download and install the genuine
1115version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce 1096version (L<http://software.schmorp.de/pkg/rxvt-unicode.html>) and try to
1116the problem. If you cannot, chances are that the problems are specific to 1097reproduce the problem. If you cannot, chances are that the problems are
1117Debian GNU/Linux, in which case it should be reported via the Debian Bug 1098specific to Debian GNU/Linux, in which case it should be reported via the
1118Tracking System (use C<reportbug> to report the bug). 1099Debian Bug Tracking System (use C<reportbug> to report the bug).
1119 1100
1120For other problems that also affect the Debian package, you can and 1101For other problems that also affect the Debian package, you can and
1121probably should use the Debian BTS, too, because, after all, it's also a 1102probably should use the Debian BTS, too, because, after all, it's also a
1122bug in the Debian version and it serves as a reminder for other users that 1103bug in the Debian version and it serves as a reminder for other users that
1123might encounter the same issue. 1104might encounter the same issue.
… …
1129runtime-switchable, too, so there is usually no drawback to enabling them, 1110runtime-switchable, too, so there is usually no drawback to enabling them,
1130except higher disk and possibly memory usage. The perl interpreter should 1111except higher disk and possibly memory usage. The perl interpreter should
1131be enabled, as important functionality (menus, selection, likely more in 1112be enabled, as important functionality (menus, selection, likely more in
1132the future) depends on it. 1113the future) depends on it.
1133 1114
1134You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 1115You should not overwrite the C<perl-ext-common> and C<perl-ext> resources
1135system-wide (except maybe with C<defaults>). This will result in useful 1116system-wide (except maybe with C<defaults>). This will result in useful
1136behaviour. If your distribution aims at low memory, add an empty 1117behaviour. If your distribution aims at low memory, add an empty
1137C<perl-ext-common> resource to the app-defaults file. This will keep the 1118C<perl-ext-common> resource to the app-defaults file. This will keep the
1138perl interpreter disabled until the user enables it. 1119perl interpreter disabled until the user enables it.
1139 1120
… …
1215The solution is to upgrade your system or switch to a better one. A 1196The solution is to upgrade your system or switch to a better one. A
1216possibly working workaround is to use a wcwidth implementation like 1197possibly working workaround is to use a wcwidth implementation like
1217 1198
1218http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c 1199http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1219 1200
1220=head3 I want 256 colors
1221
1222Are you sure you need 256 colors? 88 colors should be enough for most
1223purposes. If you really need more, there is an unsupported patch for
1224it in the doc directory, but please do not ask for it to be applied.
1225
1226=head1 RXVT-UNICODE TECHNICAL REFERENCE 1201=head1 RXVT-UNICODE TECHNICAL REFERENCE
1227 1202
1228The rest of this document describes various technical aspects of 1203The rest of this document describes various technical aspects of
1229B<rxvt-unicode>. First the description of supported command sequences, 1204B<rxvt-unicode>. First the description of supported command sequences,
1230followed by pixmap support and last by a description of all features 1205followed by pixmap support and last by a description of all features
… …
1234 1209
1235=over 4 1210=over 4
1236 1211
1237=item B<< C<c> >> 1212=item B<< C<c> >>
1238 1213
1239The literal character c. 1214The literal character c (potentially a multi-byte character).
1240 1215
1241=item B<< C<C> >> 1216=item B<< C<C> >>
1242 1217
1243A single (required) character. 1218A single (required) character.
1244 1219
… …
1303=item B<< C<SI> >> 1278=item B<< C<SI> >>
1304 1279
1305Shift In (Ctrl-O), invokes the G0 character set (the default). 1280Shift In (Ctrl-O), invokes the G0 character set (the default).
1306Switch to Standard Character Set 1281Switch to Standard Character Set
1307 1282
1308=item B<< C<SPC> >> 1283=item B<< C<SP> >>
1309 1284
1310Space Character 1285Space Character
1311 1286
1312=back 1287=back
1313 1288
… …
1329 1304
1330=item B<< C<ESC => >> 1305=item B<< C<ESC => >>
1331 1306
1332Application Keypad (SMKX). See also next sequence. 1307Application Keypad (SMKX). See also next sequence.
1333 1308
1334=item B<<< C<< ESC >> >>> 1309=item B<<< C<< ESC > >> >>>
1335 1310
1336Normal Keypad (RMKX) 1311Normal Keypad (RMKX)
1337 1312
1338B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been
1339pressed, numbers or control functions are generated by the numeric keypad 1313B<Note:> numbers or control functions are generated by the numeric
1340(see Key Codes). 1314keypad in normal or application mode, respectively (see Key Codes).
1315
1341 1316
1342=item B<< C<ESC D> >> 1317=item B<< C<ESC D> >>
1343 1318
1344Index (IND) 1319Index (IND)
1345 1320
… …
1467 1442
1468Erase in Display (ED) 1443Erase in Display (ED)
1469 1444
1470=begin table 1445=begin table
1471 1446
1472 B<< C<Ps = 0> >> Clear Below (default) 1447 B<< C<Ps = 0> >> Clear Right and Below (default)
1473 B<< C<Ps = 1> >> Clear Above 1448 B<< C<Ps = 1> >> Clear Left and Above
1474 B<< C<Ps = 2> >> Clear All 1449 B<< C<Ps = 2> >> Clear All
1475 1450
1476=end table 1451=end table
1477 1452
1478=item B<< C<ESC [ Ps K> >> 1453=item B<< C<ESC [ Ps K> >>
… …
1610 1585
1611Character Attributes (SGR) 1586Character Attributes (SGR)
1612 1587
1613=begin table 1588=begin table
1614 1589
1615 B<< C<Ps = 0> >> Normal (default) 1590 B<< C<Pm = 0> >> Normal (default)
1616 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg) 1591 B<< C<Pm = 1 / 21> >> On / Off Bold (bright fg)
1617 B<< C<Ps = 3 / 23> >> On / Off Italic 1592 B<< C<Pm = 3 / 23> >> On / Off Italic
1618 B<< C<Ps = 4 / 24> >> On / Off Underline 1593 B<< C<Pm = 4 / 24> >> On / Off Underline
1619 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg) 1594 B<< C<Pm = 5 / 25> >> On / Off Slow Blink (bright bg)
1620 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg) 1595 B<< C<Pm = 6 / 26> >> On / Off Rapid Blink (bright bg)
1621 B<< C<Ps = 7 / 27> >> On / Off Inverse 1596 B<< C<Pm = 7 / 27> >> On / Off Inverse
1622 B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI) 1597 B<< C<Pm = 8 / 27> >> On / Off Invisible (NYI)
1623 B<< C<Ps = 30 / 40> >> fg/bg Black 1598 B<< C<Pm = 30 / 40> >> fg/bg Black
1624 B<< C<Ps = 31 / 41> >> fg/bg Red 1599 B<< C<Pm = 31 / 41> >> fg/bg Red
1625 B<< C<Ps = 32 / 42> >> fg/bg Green 1600 B<< C<Pm = 32 / 42> >> fg/bg Green
1626 B<< C<Ps = 33 / 43> >> fg/bg Yellow 1601 B<< C<Pm = 33 / 43> >> fg/bg Yellow
1627 B<< C<Ps = 34 / 44> >> fg/bg Blue 1602 B<< C<Pm = 34 / 44> >> fg/bg Blue
1628 B<< C<Ps = 35 / 45> >> fg/bg Magenta 1603 B<< C<Pm = 35 / 45> >> fg/bg Magenta
1629 B<< C<Ps = 36 / 46> >> fg/bg Cyan 1604 B<< C<Pm = 36 / 46> >> fg/bg Cyan
1605 B<< C<Pm = 37 / 47> >> fg/bg White
1630 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to color #m (ISO 8613-6) 1606 B<< C<Pm = 38;5 / 48;5> >> set fg/bg to colour #m (ISO 8613-6)
1631 B<< C<Ps = 37 / 47> >> fg/bg White
1632 B<< C<Ps = 39 / 49> >> fg/bg Default 1607 B<< C<Pm = 39 / 49> >> fg/bg Default
1633 B<< C<Ps = 90 / 100> >> fg/bg Bright Black 1608 B<< C<Pm = 90 / 100> >> fg/bg Bright Black
1634 B<< C<Ps = 91 / 101> >> fg/bg Bright Red 1609 B<< C<Pm = 91 / 101> >> fg/bg Bright Red
1635 B<< C<Ps = 92 / 102> >> fg/bg Bright Green 1610 B<< C<Pm = 92 / 102> >> fg/bg Bright Green
1636 B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow 1611 B<< C<Pm = 93 / 103> >> fg/bg Bright Yellow
1637 B<< C<Ps = 94 / 104> >> fg/bg Bright Blue 1612 B<< C<Pm = 94 / 104> >> fg/bg Bright Blue
1638 B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta 1613 B<< C<Pm = 95 / 105> >> fg/bg Bright Magenta
1639 B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan 1614 B<< C<Pm = 96 / 106> >> fg/bg Bright Cyan
1640 B<< C<Ps = 97 / 107> >> fg/bg Bright White 1615 B<< C<Pm = 97 / 107> >> fg/bg Bright White
1641 B<< C<Ps = 99 / 109> >> fg/bg Bright Default 1616 B<< C<Pm = 99 / 109> >> fg/bg Bright Default
1642 1617
1643=end table 1618=end table
1644 1619
1645=item B<< C<ESC [ Ps n> >> 1620=item B<< C<ESC [ Ps n> >>
1646 1621
… …
1650 1625
1651 B<< C<Ps = 5> >> Status Report B<< C<ESC [ 0 n> >> (``OK'') 1626 B<< C<Ps = 5> >> Status Report B<< C<ESC [ 0 n> >> (``OK'')
1652 B<< C<Ps = 6> >> Report Cursor Position (CPR) [row;column] as B<< C<ESC [ r ; c R> >> 1627 B<< C<Ps = 6> >> Report Cursor Position (CPR) [row;column] as B<< C<ESC [ r ; c R> >>
1653 B<< C<Ps = 7> >> Request Display Name 1628 B<< C<Ps = 7> >> Request Display Name
1654 B<< C<Ps = 8> >> Request Version Number (place in window title) 1629 B<< C<Ps = 8> >> Request Version Number (place in window title)
1630
1631=end table
1632
1633=item B<< C<ESC [ Ps SP q> >>
1634
1635Set Cursor Style (DECSCUSR)
1636
1637=begin table
1638
1639 B<< C<Ps = 0> >> Blink Block
1640 B<< C<Ps = 1> >> Blink Block
1641 B<< C<Ps = 2> >> Steady Block
1642 B<< C<Ps = 3> >> Blink Underline
1643 B<< C<Ps = 4> >> Steady Underline
1644 B<< C<Ps = 5> >> Blink Bar (XTerm)
1645 B<< C<Ps = 6> >> Steady Bar (XTerm)
1655 1646
1656=end table 1647=end table
1657 1648
1658=item B<< C<ESC [ Ps;Ps r> >> 1649=item B<< C<ESC [ Ps;Ps r> >>
1659 1650
… …
1734 B<< C<h> >> Application Cursor Keys 1725 B<< C<h> >> Application Cursor Keys
1735 B<< C<l> >> Normal Cursor Keys 1726 B<< C<l> >> Normal Cursor Keys
1736 1727
1737=end table 1728=end table
1738 1729
1739=item B<< C<Pm = 2> >> (ANSI/VT52 mode) 1730=item B<< C<Pm = 2> >> (DECANM)
1740 1731
1741=begin table 1732=begin table
1742 1733
1743 B<< C<h> >> Enter VT52 mode 1734 B<< C<h> >> Enter VT52 mode
1744 B<< C<l> >> Enter VT52 mode 1735 B<< C<l> >> Enter VT52 mode
1745 1736
1746=end table 1737=end table
1747 1738
1748=item B<< C<Pm = 3> >> 1739=item B<< C<Pm = 3> >> (DECCOLM)
1749 1740
1750=begin table 1741=begin table
1751 1742
1752 B<< C<h> >> 132 Column Mode (DECCOLM) 1743 B<< C<h> >> 132 Column Mode
1753 B<< C<l> >> 80 Column Mode (DECCOLM) 1744 B<< C<l> >> 80 Column Mode
1754 1745
1755=end table
1756
1757=item B<< C<Pm = 4> >>
1758
1759=begin table 1746=end table
1760 1747
1748=item B<< C<Pm = 4> >> (DECSCLM)
1749
1750=begin table
1751
1761 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1752 B<< C<h> >> Smooth (Slow) Scroll
1762 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1753 B<< C<l> >> Jump (Fast) Scroll
1763 1754
1764=end table
1765
1766=item B<< C<Pm = 5> >>
1767
1768=begin table 1755=end table
1769 1756
1757=item B<< C<Pm = 5> >> (DECSCNM)
1758
1759=begin table
1760
1770 B<< C<h> >> Reverse Video (DECSCNM) 1761 B<< C<h> >> Reverse Video
1771 B<< C<l> >> Normal Video (DECSCNM) 1762 B<< C<l> >> Normal Video
1772 1763
1773=end table 1764=end table
1774 1765
1775=item B<< C<Pm = 6> >> 1766=item B<< C<Pm = 6> >> (DECOM)
1776 1767
1777=begin table 1768=begin table
1778 1769
1779 B<< C<h> >> Origin Mode (DECOM) 1770 B<< C<h> >> Origin Mode
1780 B<< C<l> >> Normal Cursor Mode (DECOM) 1771 B<< C<l> >> Normal Cursor Mode
1781 1772
1782=end table 1773=end table
1783 1774
1784=item B<< C<Pm = 7> >> 1775=item B<< C<Pm = 7> >> (DECAWM)
1785 1776
1786=begin table 1777=begin table
1787 1778
1788 B<< C<h> >> Wraparound Mode (DECAWM) 1779 B<< C<h> >> Wraparound Mode
1789 B<< C<l> >> No Wraparound Mode (DECAWM) 1780 B<< C<l> >> No Wraparound Mode
1790 1781
1791=end table 1782=end table
1792 1783
1793=item B<< C<Pm = 8> >> I<unimplemented> 1784=item B<< C<Pm = 8> >> (DECARM) I<unimplemented>
1794 1785
1795=begin table 1786=begin table
1796 1787
1797 B<< C<h> >> Auto-repeat Keys (DECARM) 1788 B<< C<h> >> Auto-repeat Keys
1798 B<< C<l> >> No Auto-repeat Keys (DECARM) 1789 B<< C<l> >> No Auto-repeat Keys
1799 1790
1800=end table 1791=end table
1801 1792
1802=item B<< C<Pm = 9> >> X10 XTerm 1793=item B<< C<Pm = 9> >> X10 XTerm
1803 1794
… …
1806 B<< C<h> >> Send Mouse X & Y on button press. 1797 B<< C<h> >> Send Mouse X & Y on button press.
1807 B<< C<l> >> No mouse reporting. 1798 B<< C<l> >> No mouse reporting.
1808 1799
1809=end table 1800=end table
1810 1801
1811=item B<< C<Pm = 25> >> 1802=item B<< C<Pm = 12> >>
1803
1804=begin table
1805
1806 B<< C<h> >> Blinking cursor
1807 B<< C<l> >> Steady cursor
1808
1809=end table
1810
1811=item B<< C<Pm = 25> >> (DECTCEM)
1812 1812
1813=begin table 1813=begin table
1814 1814
1815 B<< C<h> >> Visible cursor {cnorm/cvvis} 1815 B<< C<h> >> Visible cursor {cnorm/cvvis}
1816 B<< C<l> >> Invisible cursor {civis} 1816 B<< C<l> >> Invisible cursor {civis}
… …
1877 1877
1878=end table 1878=end table
1879 1879
1880X<Priv66> 1880X<Priv66>
1881 1881
1882=item B<< C<Pm = 66> >> 1882=item B<< C<Pm = 66> >> (DECNKM)
1883 1883
1884=begin table 1884=begin table
1885 1885
1886 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1886 B<< C<h> >> Application Keypad (DECKPAM/DECPAM) == C<ESC =>
1887 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1887 B<< C<l> >> Normal Keypad (DECKPNM/DECPNM) == C<< ESC > >>
1888 1888
1889=end table 1889=end table
1890 1890
1891=item B<< C<Pm = 67> >> 1891=item B<< C<Pm = 67> >> (DECBKM)
1892 1892
1893=begin table 1893=begin table
1894 1894
1895 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1895 B<< C<h> >> Backspace key sends B<< C<BS> >>
1896 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1896 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1897 1897
1898=end table 1898=end table
1899 1899
1900=item B<< C<Pm = 1000> >> (X11 XTerm) 1900=item B<< C<Pm = 1000> >> (X11 XTerm)
… …
1931 B<< C<h> >> Send Mouse X & Y on button press and release, and motion. 1931 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1932 B<< C<l> >> No mouse reporting. 1932 B<< C<l> >> No mouse reporting.
1933 1933
1934=end table 1934=end table
1935 1935
1936=item B<< C<Pm = 1005> >> (X11 XTerm) (Compile frills)
1937
1938Try to avoid this mode, it doesn't work sensibly in non-UTF-8 locales. Use
1939mode C<1015> instead.
1940
1941Unlike XTerm, coordinates larger than 2015) will work fine.
1942
1943=begin table
1944
1945 B<< C<h> >> Enable mouse coordinates in locale-specific encoding.
1946 B<< C<l> >> Enable mouse coordinates as binary octets.
1947
1948=end table
1949
1936=item B<< C<Pm = 1010> >> (B<rxvt>) 1950=item B<< C<Pm = 1010> >> (B<rxvt>)
1937 1951
1938=begin table 1952=begin table
1939 1953
1940 B<< C<h> >> Don't scroll to bottom on TTY output 1954 B<< C<h> >> Don't scroll to bottom on TTY output
… …
1946 1960
1947=begin table 1961=begin table
1948 1962
1949 B<< C<h> >> Scroll to bottom when a key is pressed 1963 B<< C<h> >> Scroll to bottom when a key is pressed
1950 B<< C<l> >> Don't scroll to bottom when a key is pressed 1964 B<< C<l> >> Don't scroll to bottom when a key is pressed
1965
1966=end table
1967
1968=item B<< C<Pm = 1015> >> (B<rxvt-unicode>) (Compile frills)
1969
1970Changes all mouse reporting codes to use decimal parameters instead of
1971octets or characters.
1972
1973This mode should be enabled I<before> actually enabling mouse reporting,
1974for semi-obvious reasons.
1975
1976The sequences received for various modes are as follows:
1977
1978 ESC [ M o o o !1005, !1015 (three octets)
1979 ESC [ M c c c 1005, !1015 (three characters)
1980 ESC [ Pm M 1015 (three or more numeric parameters)
1981
1982The first three parameters are C<code>, C<x> and C<y>. Code is the numeric
1983code as for the other modes (but encoded as a decimal number, including
1984the additional offset of 32, so you have to subtract 32 first), C<x> and
1985C<y> are the coordinates (1|1 is the upper left corner, just as with
1986cursor positioning).
1987
1988Example: Shift-Button-1 press at top row, column 80.
1989
1990 ESC [ 37 ; 80 ; 1 M
1991
1992One can use this feature by simply enabling it and then looking for
1993parameters to the C<ESC [ M> reply - if there are any, this mode is
1994active, otherwise one of the old reporting styles is used.
1995
1996Other (to be implemented) reply sequences will use a similar encoding.
1997
1998In the future, more parameters might get added (pixel coordinates for
1999example - anybody out there who needs this?).
2000
2001=begin table
2002
2003 B<< C<h> >> Enable new mouse coordinate reporting.
2004 B<< C<l> >> Use old-style C<CSI M C C C> encoding.
1951 2005
1952=end table 2006=end table
1953 2007
1954=item B<< C<Pm = 1021> >> (B<rxvt>) 2008=item B<< C<Pm = 1021> >> (B<rxvt>)
1955 2009
… …
2021 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 2075 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
2022 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> 2076 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >>
2023 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> 2077 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >>
2024 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 2078 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
2025 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 2079 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
2026 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 2080 B<< C<Ps = 17> >> Change background colour of highlight characters to B<< C<Pt> >>
2027 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706] 2081 B<< C<Ps = 19> >> Change foreground colour of highlight characters to B<< C<Pt> >>
2028 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
2029 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage). 2082 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile pixbuf).
2030 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. [deprecated, use 10] 2083 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. [deprecated, use 10]
2031 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 2084 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
2032 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. [deprecated, use 11] 2085 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. [deprecated, use 11]
2033 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> >> 2086 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> >>
2034 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> [disabled] 2087 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> [disabled]
… …
2052=back 2105=back
2053 2106
2054=head1 BACKGROUND IMAGE 2107=head1 BACKGROUND IMAGE
2055 2108
2056For the BACKGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> the value 2109For the BACKGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> the value
2057of B<< C<Pt> >> can be the name of the background image file followed by a 2110of B<< C<Pt> >> can be one of the following commands:
2058sequence of scaling/positioning commands separated by semi-colons. The
2059scaling/positioning commands are as follows:
2060 2111
2061=over 4 2112=over 4
2062 2113
2063=item query scale/position 2114=item B<< C<?> >>
2064 2115
2065B<?> 2116display scale and position in the title
2066 2117
2118=item B<< C<;WxH+X+Y> >>
2119
2067=item change scale and position 2120change scale and/or position
2068 2121
2069B<WxH+X+Y> 2122=item B<< C<FILE;WxH+X+Y> >>
2070 2123
2071B<WxH+X> (== B<WxH+X+X>) 2124change background image
2072
2073B<WxH> (same as B<WxH+50+50>)
2074
2075B<W+X+Y> (same as B<WxW+X+Y>)
2076
2077B<W+X> (same as B<WxW+X+X>)
2078
2079B<W> (same as B<WxW+50+50>)
2080
2081=item change position (absolute)
2082
2083B<=+X+Y>
2084
2085B<=+X> (same as B<=+X+Y>)
2086
2087=item change position (relative)
2088
2089B<+X+Y>
2090
2091B<+X> (same as B<+X+Y>)
2092
2093=item rescale (relative)
2094
2095B<Wx0> -> B<W *= (W/100)>
2096
2097B<0xH> -> B<H *= (H/100)>
2098
2099=back
2100
2101For example:
2102
2103=over 4
2104
2105=item B<\E]20;funky.jpg\a>
2106
2107load B<funky.jpg> as a tiled image
2108
2109=item B<\E]20;mona.jpg;100\a>
2110
2111load B<mona.jpg> with a scaling of 100%
2112
2113=item B<\E]20;;200;?\a>
2114
2115rescale the current pixmap to 200% and display the image geometry in
2116the title
2117 2125
2118=back 2126=back
2119 2127
2120X<Mouse> 2128X<Mouse>
2121 2129
… …
2149The upper bits of B<< C<< <b> >> >> indicate the modifiers when the 2157The upper bits of B<< C<< <b> >> >> indicate the modifiers when the
2150button was pressed and are added together (X11 mouse report only): 2158button was pressed and are added together (X11 mouse report only):
2151 2159
2152=over 4 2160=over 4
2153 2161
2154=item State = B<< C<< (<b> - SPACE) & 60 >> >> 2162=item State = B<< C<< (<b> - SPACE) & ~3 >> >>
2155 2163
2156=begin table 2164=begin table
2157 2165
2158 4 Shift 2166 4 Shift
2159 8 Meta 2167 8 Meta
2160 16 Control 2168 16 Control
2169 32 Motion Notify
2161 32 Double Click I<(rxvt extension)> 2170 32 Double Click I<(rxvt extension)>, disabled by default
2171 64 Button1 is actually Button4, Button2 is actually Button5 etc.
2162 2172
2163=end table 2173=end table
2164 2174
2165Col = B<< C<< <x> - SPACE >> >> 2175Col = B<< C<< <x> - SPACE >> >>
2166 2176
… …
2172 2182
2173X<KeyCodes> 2183X<KeyCodes>
2174 2184
2175Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 2185Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
2176 2186
2177For the keypad, use B<Shift> to temporarily override Application-Keypad 2187For the keypad, use B<Shift> to temporarily toggle Application Keypad
2178setting use B<Num_Lock> to toggle Application-Keypad setting if 2188mode and use B<Num_Lock> to override Application Keypad mode, i.e. if
2179B<Num_Lock> is off, toggle Application-Keypad setting. Also note that 2189B<Num_Lock> is on the keypad is in normal mode. Also note that the
2180values of B<Home>, B<End>, B<Delete> may have been compiled differently on 2190values of B<BackSpace>, B<Delete> may have been compiled differently
2181your system. 2191on your system.
2182 2192
2183=begin table 2193=begin table
2184 2194
2185 B<Normal> B<Shift> B<Control> B<Ctrl+Shift> 2195 B<Normal> B<Shift> B<Control> B<Ctrl+Shift>
2186 Tab ^I ESC [ Z ^I ESC [ Z 2196 Tab ^I ESC [ Z ^I ESC [ Z
2187 BackSpace ^H ^? ^? ^? 2197 BackSpace ^? ^? ^H ^H
2188 Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @ 2198 Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @
2189 Insert ESC [ 2 ~ I<paste> ESC [ 2 ^ ESC [ 2 @ 2199 Insert ESC [ 2 ~ I<paste> ESC [ 2 ^ ESC [ 2 @
2190 Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @ 2200 Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
2191 Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @ 2201 Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @
2192 Prior ESC [ 5 ~ I<scroll-up> ESC [ 5 ^ ESC [ 5 @ 2202 Prior ESC [ 5 ~ I<scroll-up> ESC [ 5 ^ ESC [ 5 @
… …
2222 KP_Enter ^M ESC O M 2232 KP_Enter ^M ESC O M
2223 KP_F1 ESC O P ESC O P 2233 KP_F1 ESC O P ESC O P
2224 KP_F2 ESC O Q ESC O Q 2234 KP_F2 ESC O Q ESC O Q
2225 KP_F3 ESC O R ESC O R 2235 KP_F3 ESC O R ESC O R
2226 KP_F4 ESC O S ESC O S 2236 KP_F4 ESC O S ESC O S
2227 XK_KP_Multiply * ESC O j 2237 KP_Multiply * ESC O j
2228 XK_KP_Add + ESC O k 2238 KP_Add + ESC O k
2229 XK_KP_Separator , ESC O l 2239 KP_Separator , ESC O l
2230 XK_KP_Subtract - ESC O m 2240 KP_Subtract - ESC O m
2231 XK_KP_Decimal . ESC O n 2241 KP_Decimal . ESC O n
2232 XK_KP_Divide / ESC O o 2242 KP_Divide / ESC O o
2233 XK_KP_0 0 ESC O p 2243 KP_0 0 ESC O p
2234 XK_KP_1 1 ESC O q 2244 KP_1 1 ESC O q
2235 XK_KP_2 2 ESC O r 2245 KP_2 2 ESC O r
2236 XK_KP_3 3 ESC O s 2246 KP_3 3 ESC O s
2237 XK_KP_4 4 ESC O t 2247 KP_4 4 ESC O t
2238 XK_KP_5 5 ESC O u 2248 KP_5 5 ESC O u
2239 XK_KP_6 6 ESC O v 2249 KP_6 6 ESC O v
2240 XK_KP_7 7 ESC O w 2250 KP_7 7 ESC O w
2241 XK_KP_8 8 ESC O x 2251 KP_8 8 ESC O x
2242 XK_KP_9 9 ESC O y 2252 KP_9 9 ESC O y
2243 2253
2244=end table 2254=end table
2245 2255
2246=head1 CONFIGURE OPTIONS 2256=head1 CONFIGURE OPTIONS
2247 2257
… …
2255 2265
2256=over 4 2266=over 4
2257 2267
2258=item --enable-everything 2268=item --enable-everything
2259 2269
2260Add (or remove) support for all non-multichoice options listed in "./configure 2270Add (or remove) support for all non-multichoice options listed
2261--help". 2271in C<./configure --help>, except for C<--enable-assert> and
2272C<--enable-256-color>.
2262 2273
2263You can specify this and then disable options you do not like by 2274You can specify this and then disable options you do not like by
2264I<following> this with the appropriate C<--disable-...> arguments, 2275I<following> this with the appropriate C<--disable-...> arguments,
2265or you can start with a minimal configuration by specifying 2276or you can start with a minimal configuration by specifying
2266C<--disable-everything> and than adding just the C<--enable-...> arguments 2277C<--disable-everything> and than adding just the C<--enable-...> arguments
2267you want. 2278you want.
2268 2279
2269=item --enable-xft (default: enabled) 2280=item --enable-xft (default: on)
2270 2281
2271Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2282Add support for Xft (anti-aliased, among others) fonts. Xft fonts are
2272slower and require lots of memory, but as long as you don't use them, you 2283slower and require lots of memory, but as long as you don't use them, you
2273don't pay for them. 2284don't pay for them.
2274 2285
2275=item --enable-font-styles (default: on) 2286=item --enable-font-styles (default: on)
2276 2287
2277Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2288Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2278styles. The fonts can be set manually or automatically. 2289styles. The fonts can be set manually or automatically.
2279 2290
2280=item --with-codesets=NAME,... (default: all) 2291=item --with-codesets=CS,... (default: all)
2281 2292
2282Compile in support for additional codeset (encoding) groups (C<eu>, C<vn> 2293Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2283are always compiled in, which includes most 8-bit character sets). These 2294are always compiled in, which includes most 8-bit character sets). These
2284codeset tables are used for driving X11 core fonts, they are not required 2295codeset tables are used for driving X11 core fonts, they are not required
2285for Xft fonts, although having them compiled in lets rxvt-unicode choose 2296for Xft fonts, although having them compiled in lets rxvt-unicode choose
… …
2321 2332
2322=item --enable-combining (default: on) 2333=item --enable-combining (default: on)
2323 2334
2324Enable automatic composition of combining characters into 2335Enable automatic composition of combining characters into
2325composite characters. This is required for proper viewing of text 2336composite characters. This is required for proper viewing of text
2326where accents are encoded as seperate unicode characters. This is 2337where accents are encoded as separate unicode characters. This is
2327done by using precomposited characters when available or creating 2338done by using precomposed characters when available or creating
2328new pseudo-characters when no precomposed form exists. 2339new pseudo-characters when no precomposed form exists.
2329 2340
2330Without --enable-unicode3, the number of additional precomposed 2341Without --enable-unicode3, the number of additional precomposed
2331characters is somewhat limited (the 6400 private use characters will be 2342characters is somewhat limited (the 6400 private use characters will be
2332(ab-)used). With --enable-unicode3, no practical limit exists. 2343(ab-)used). With --enable-unicode3, no practical limit exists.
… …
2336 2347
2337The combining table also contains entries for arabic presentation forms, 2348The combining table also contains entries for arabic presentation forms,
2338but these are not currently used. Bug me if you want these to be used (and 2349but these are not currently used. Bug me if you want these to be used (and
2339tell me how these are to be used...). 2350tell me how these are to be used...).
2340 2351
2341=item --enable-fallback(=CLASS) (default: Rxvt) 2352=item --enable-fallback[=CLASS] (default: Rxvt)
2342 2353
2343When reading resource settings, also read settings for class CLASS. To 2354When reading resource settings, also read settings for class CLASS. To
2344disable resource fallback use --disable-fallback. 2355disable resource fallback use --disable-fallback.
2345 2356
2346=item --with-res-name=NAME (default: urxvt) 2357=item --with-res-name=NAME (default: urxvt)
… …
2369 2380
2370Write user and tty to lastlog file (used by programs like 2381Write user and tty to lastlog file (used by programs like
2371F<lastlogin>) at start of rxvt execution. This option requires 2382F<lastlogin>) at start of rxvt execution. This option requires
2372--enable-utmp to also be specified. 2383--enable-utmp to also be specified.
2373 2384
2374=item --enable-afterimage (default: on) 2385=item --enable-pixbuf (default: on)
2375 2386
2376Add support for libAfterImage to be used for transparency and background 2387Add support for GDK-PixBuf to be used for background images.
2377images. It adds support for many file formats including JPG, PNG, 2388It adds support for many file formats including JPG, PNG,
2378SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML 2389TIFF, GIF, XPM, BMP, ICO and TGA.
2379(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2380 2390
2381This option also adds such eye candy as blending an image over the root 2391=item --enable-startup-notification (default: on)
2382background, as well as dynamic scaling and bluring of background images.
2383 2392
2384Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might 2393Add support for freedesktop startup notifications. This allows window managers
2385increase by a few megabytes even if no extra features are used (mostly due 2394to display some kind of progress indicator during startup.
2386to third-party libraries used by libAI). Memory footprint may somewhat be
2387lowered if libAfterImage is configured without support for SVG.
2388 2395
2389=item --enable-transparency (default: on) 2396=item --enable-transparency (default: on)
2390 2397
2391Add support for backgrounds, creating illusion of transparency in the term. 2398Add support for using the root pixmap as background to simulate transparency.
2399Note that this feature depends on libXrender and on the availability
2400of the RENDER extension in the X server.
2392 2401
2393=item --enable-fading (default: on) 2402=item --enable-fading (default: on)
2394 2403
2395Add support for fading the text when focus is lost. 2404Add support for fading the text when focus is lost.
2396 2405
… …
2433in combination with other switches) is: 2442in combination with other switches) is:
2434 2443
2435 MWM-hints 2444 MWM-hints
2436 EWMH-hints (pid, utf8 names) and protocols (ping) 2445 EWMH-hints (pid, utf8 names) and protocols (ping)
2437 urgency hint 2446 urgency hint
2438 seperate underline colour (-underlineColor) 2447 separate underline colour (-underlineColor)
2439 settable border widths and borderless switch (-w, -b, -bl) 2448 settable border widths and borderless switch (-w, -b, -bl)
2440 visual depth selection (-depth) 2449 visual depth selection (-depth)
2441 settable extra linespacing /-lsp) 2450 settable extra linespacing (-lsp)
2442 iso-14755 5.1 (basic) support 2451 iso-14755 5.1 (basic) support
2443 tripleclickwords (-tcw) 2452 tripleclickwords (-tcw)
2444 settable insecure mode (-insecure) 2453 settable insecure mode (-insecure)
2445 keysym remapping support 2454 keysym remapping support
2446 cursor blinking and underline cursor (-bc, -uc) 2455 cursor blinking and underline cursor (-bc, -uc)
2447 XEmbed support (-embed) 2456 XEmbed support (-embed)
2448 user-pty (-pty-fd) 2457 user-pty (-pty-fd)
2449 hold on exit (-hold) 2458 hold on exit (-hold)
2450 compile in built-in block graphics 2459 compile in built-in block graphics
2451 skip builtin block graphics (-sbg) 2460 skip builtin block graphics (-sbg)
2452 separate highlightcolor support (-hc) 2461 separate highlight colour (-highlightColor, -highlightTextColor)
2462 extended mouse reporting modes (1005 and 1015).
2463 visual selection via -visual and -depth.
2453 2464
2454It also enables some non-essential features otherwise disabled, such as: 2465It also enables some non-essential features otherwise disabled, such as:
2455 2466
2456 some round-trip time optimisations 2467 some round-trip time optimisations
2457 nearest color allocation on pseudocolor screens 2468 nearest colour allocation on pseudocolor screens
2458 UTF8_STRING support for selection 2469 UTF8_STRING support for selection
2459 sgr modes 90..97 and 100..107 2470 sgr modes 90..97 and 100..107
2460 backindex and forwardindex escape sequences 2471 backindex and forwardindex escape sequences
2461 view change/zero scrollback escape sequences 2472 view change/zero scrollback escape sequences
2462 locale switching escape sequence 2473 locale switching escape sequence
… …
2514environment variable when running configure. Even when compiled in, 2525environment variable when running configure. Even when compiled in,
2515perl will I<not> be initialised when all extensions have been disabled 2526perl will I<not> be initialised when all extensions have been disabled
2516C<-pe "" --perl-ext-common "">, so it should be safe to enable from a 2527C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2517resource standpoint. 2528resource standpoint.
2518 2529
2519=item --with-afterimage-config=DIR 2530=item --enable-assert (default: off)
2520 2531
2521Look for the libAfterImage config script in DIR. 2532Enables the assertions in the code, normally disabled. This switch is only
2533useful when developing rxvt-unicode.
2534
2535=item --enable-256-color (default: off)
2536
2537Force use of so-called 256 colour mode, to work around buggy applications
2538that do not support termcap/terminfo, or simply improve support for
2539applications hardcoding the xterm 256 colour table.
2540
2541This switch breaks termcap/terminfo compatibility to C<TERM=rxvt-unicode>,
2542and consequently sets C<TERM> to C<rxvt-unicode-256color> by default
2543(F<doc/etc/> contains termcap/terminfo definitions for both).
2544
2545It also results in higher memory usage and can slow down @@RXVT_NAME@@
2546dramatically when more than six fonts are in use by a terminal instance.
2522 2547
2523=item --with-name=NAME (default: urxvt) 2548=item --with-name=NAME (default: urxvt)
2524 2549
2525Set the basename for the installed binaries, resulting 2550Set the basename for the installed binaries, resulting
2526in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2551in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines