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.217 by sf-exg, Wed Dec 14 12:28:26 2011 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
… …
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 libAfterImage or 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
… …
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<preeditStyle> or specify more than
561one pre-edit style, such as B<OverTheSpot,Root,None>. 566one pre-edit style, such as B<OverTheSpot,Root,None>.
562 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>.
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
567advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other 576advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
… …
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 $ echo -n "^[[?67h"
601 605
602 # use Backspace = ^? 606 # use Backspace = ^?
603 $ stty erase ^? 607 $ stty erase ^?
604 $ @@URXVT_NAME@@
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" 608 $ echo -n "^[[?67l"
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
… …
1110 1090
1111The Debian GNU/Linux package of rxvt-unicode in sarge contains large 1091The Debian GNU/Linux package of rxvt-unicode in sarge contains large
1112patches that considerably change the behaviour of rxvt-unicode (but 1092patches that considerably change the behaviour of rxvt-unicode (but
1113unfortunately this notice has been removed). Before reporting a bug to 1093unfortunately this notice has been removed). Before reporting a bug to
1114the original rxvt-unicode author please download and install the genuine 1094the original rxvt-unicode author please download and install the genuine
1115version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce 1095version (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 1096reproduce 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 1097specific to Debian GNU/Linux, in which case it should be reported via the
1118Tracking System (use C<reportbug> to report the bug). 1098Debian Bug Tracking System (use C<reportbug> to report the bug).
1119 1099
1120For other problems that also affect the Debian package, you can and 1100For 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 1101probably 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 1102bug in the Debian version and it serves as a reminder for other users that
1123might encounter the same issue. 1103might encounter the same issue.
… …
1129runtime-switchable, too, so there is usually no drawback to enabling them, 1109runtime-switchable, too, so there is usually no drawback to enabling them,
1130except higher disk and possibly memory usage. The perl interpreter should 1110except higher disk and possibly memory usage. The perl interpreter should
1131be enabled, as important functionality (menus, selection, likely more in 1111be enabled, as important functionality (menus, selection, likely more in
1132the future) depends on it. 1112the future) depends on it.
1133 1113
1134You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 1114You 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 1115system-wide (except maybe with C<defaults>). This will result in useful
1136behaviour. If your distribution aims at low memory, add an empty 1116behaviour. If your distribution aims at low memory, add an empty
1137C<perl-ext-common> resource to the app-defaults file. This will keep the 1117C<perl-ext-common> resource to the app-defaults file. This will keep the
1138perl interpreter disabled until the user enables it. 1118perl interpreter disabled until the user enables it.
1139 1119
… …
1215The solution is to upgrade your system or switch to a better one. A 1195The solution is to upgrade your system or switch to a better one. A
1216possibly working workaround is to use a wcwidth implementation like 1196possibly working workaround is to use a wcwidth implementation like
1217 1197
1218http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c 1198http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1219 1199
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 1200=head1 RXVT-UNICODE TECHNICAL REFERENCE
1227 1201
1228The rest of this document describes various technical aspects of 1202The rest of this document describes various technical aspects of
1229B<rxvt-unicode>. First the description of supported command sequences, 1203B<rxvt-unicode>. First the description of supported command sequences,
1230followed by pixmap support and last by a description of all features 1204followed by pixmap support and last by a description of all features
… …
1234 1208
1235=over 4 1209=over 4
1236 1210
1237=item B<< C<c> >> 1211=item B<< C<c> >>
1238 1212
1239The literal character c. 1213The literal character c (potentially a multi-byte character).
1240 1214
1241=item B<< C<C> >> 1215=item B<< C<C> >>
1242 1216
1243A single (required) character. 1217A single (required) character.
1244 1218
… …
1329 1303
1330=item B<< C<ESC => >> 1304=item B<< C<ESC => >>
1331 1305
1332Application Keypad (SMKX). See also next sequence. 1306Application Keypad (SMKX). See also next sequence.
1333 1307
1334=item B<<< C<< ESC >> >>> 1308=item B<<< C<< ESC > >> >>>
1335 1309
1336Normal Keypad (RMKX) 1310Normal Keypad (RMKX)
1337 1311
1338B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been 1312B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been
1339pressed, numbers or control functions are generated by the numeric keypad 1313pressed, numbers or control functions are generated by the numeric keypad
… …
1467 1441
1468Erase in Display (ED) 1442Erase in Display (ED)
1469 1443
1470=begin table 1444=begin table
1471 1445
1472 B<< C<Ps = 0> >> Clear Below (default) 1446 B<< C<Ps = 0> >> Clear Right and Below (default)
1473 B<< C<Ps = 1> >> Clear Above 1447 B<< C<Ps = 1> >> Clear Left and Above
1474 B<< C<Ps = 2> >> Clear All 1448 B<< C<Ps = 2> >> Clear All
1475 1449
1476=end table 1450=end table
1477 1451
1478=item B<< C<ESC [ Ps K> >> 1452=item B<< C<ESC [ Ps K> >>
… …
1625 B<< C<Ps = 32 / 42> >> fg/bg Green 1599 B<< C<Ps = 32 / 42> >> fg/bg Green
1626 B<< C<Ps = 33 / 43> >> fg/bg Yellow 1600 B<< C<Ps = 33 / 43> >> fg/bg Yellow
1627 B<< C<Ps = 34 / 44> >> fg/bg Blue 1601 B<< C<Ps = 34 / 44> >> fg/bg Blue
1628 B<< C<Ps = 35 / 45> >> fg/bg Magenta 1602 B<< C<Ps = 35 / 45> >> fg/bg Magenta
1629 B<< C<Ps = 36 / 46> >> fg/bg Cyan 1603 B<< C<Ps = 36 / 46> >> fg/bg Cyan
1630 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to color #m (ISO 8613-6) 1604 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to colour #m (ISO 8613-6)
1631 B<< C<Ps = 37 / 47> >> fg/bg White 1605 B<< C<Ps = 37 / 47> >> fg/bg White
1632 B<< C<Ps = 39 / 49> >> fg/bg Default 1606 B<< C<Ps = 39 / 49> >> fg/bg Default
1633 B<< C<Ps = 90 / 100> >> fg/bg Bright Black 1607 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
1634 B<< C<Ps = 91 / 101> >> fg/bg Bright Red 1608 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
1635 B<< C<Ps = 92 / 102> >> fg/bg Bright Green 1609 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
… …
1881 1855
1882=item B<< C<Pm = 66> >> 1856=item B<< C<Pm = 66> >>
1883 1857
1884=begin table 1858=begin table
1885 1859
1886 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1860 B<< C<h> >> Application Keypad (DECKPAM/DECPAM) == C<ESC =>
1887 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1861 B<< C<l> >> Normal Keypad (DECKPNM/DECPNM) == C<< ESC > >>
1888 1862
1889=end table 1863=end table
1890 1864
1891=item B<< C<Pm = 67> >> 1865=item B<< C<Pm = 67> >>
1892 1866
… …
1931 B<< C<h> >> Send Mouse X & Y on button press and release, and motion. 1905 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1932 B<< C<l> >> No mouse reporting. 1906 B<< C<l> >> No mouse reporting.
1933 1907
1934=end table 1908=end table
1935 1909
1910=item B<< C<Pm = 1005> >> (X11 XTerm) (Compile frills)
1911
1912Try to avoid this mode, it doesn't work sensibly in non-UTF-8 locales. Use
1913mode C<1015> instead.
1914
1915Unlike XTerm, coordinates larger than 2015) will work fine.
1916
1917=begin table
1918
1919 B<< C<h> >> Enable mouse coordinates in locale-specific encoding.
1920 B<< C<l> >> Enable mouse coordinates as binary octets.
1921
1922=end table
1923
1936=item B<< C<Pm = 1010> >> (B<rxvt>) 1924=item B<< C<Pm = 1010> >> (B<rxvt>)
1937 1925
1938=begin table 1926=begin table
1939 1927
1940 B<< C<h> >> Don't scroll to bottom on TTY output 1928 B<< C<h> >> Don't scroll to bottom on TTY output
… …
1946 1934
1947=begin table 1935=begin table
1948 1936
1949 B<< C<h> >> Scroll to bottom when a key is pressed 1937 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 1938 B<< C<l> >> Don't scroll to bottom when a key is pressed
1939
1940=end table
1941
1942=item B<< C<Pm = 1015> >> (B<rxvt-unicode>) (Compile frills)
1943
1944Changes all mouse reporting codes to use decimal parameters instead of
1945octets or characters.
1946
1947This mode should be enabled I<before> actually enabling mouse reporting,
1948for semi-obvious reasons.
1949
1950The sequences received for various modes are as follows:
1951
1952 ESC [ M o o o !1005, !1015 (three octets)
1953 ESC [ M c c c 1005, !1015 (three characters)
1954 ESC [ Pm M 1015 (three or more numeric parameters)
1955
1956The first three parameters are C<code>, C<x> and C<y>. Code is the numeric
1957code as for the other modes (but encoded as a decimal number, including
1958the additional offset of 32, so you have to subtract 32 first), C<x> and
1959C<y> are the coordinates (1|1 is the upper left corner, just as with
1960cursor positioning).
1961
1962Example: Shift-Button-1 press at top row, column 80.
1963
1964 ESC [ 37 ; 80 ; 1 M
1965
1966One can use this feature by simply enabling it and then looking for
1967parameters to the C<ESC [ M> reply - if there are any, this mode is
1968active, otherwise one of the old reporting styles is used.
1969
1970Other (to be implemented) reply sequences will use a similar encoding.
1971
1972In the future, more parameters might get added (pixel coordinates for
1973example - anybody out there who needs this?).
1974
1975=begin table
1976
1977 B<< C<h> >> Enable new mouse coordinate reporting.
1978 B<< C<l> >> Use old-style C<CSI M C C C> encoding.
1951 1979
1952=end table 1980=end table
1953 1981
1954=item B<< C<Pm = 1021> >> (B<rxvt>) 1982=item B<< C<Pm = 1021> >> (B<rxvt>)
1955 1983
… …
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 2049 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> >> 2050 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> >> 2051 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> >> 2052 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> >> 2053 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> >> 2054 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] 2055 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). 2056 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile afterimage or pixbuf).
2030 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. [deprecated, use 10] 2057 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> 2058 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] 2059 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> >> 2060 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] 2061 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> [disabled]
… …
2052=back 2079=back
2053 2080
2054=head1 BACKGROUND IMAGE 2081=head1 BACKGROUND IMAGE
2055 2082
2056For the BACKGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> the value 2083For 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 2084of 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 2085
2061=over 4 2086=over 4
2062 2087
2063=item query scale/position 2088=item B<< C<?> >>
2064 2089
2065B<?> 2090display scale and position in the title
2066 2091
2092=item B<< C<;WxH+X+Y> >>
2093
2067=item change scale and position 2094change scale and/or position
2068 2095
2069B<WxH+X+Y> 2096=item B<< C<FILE;WxH+X+Y> >>
2070 2097
2071B<WxH+X> (== B<WxH+X+X>) 2098change 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 2099
2118=back 2100=back
2119 2101
2120X<Mouse> 2102X<Mouse>
2121 2103
… …
2149The upper bits of B<< C<< <b> >> >> indicate the modifiers when the 2131The upper bits of B<< C<< <b> >> >> indicate the modifiers when the
2150button was pressed and are added together (X11 mouse report only): 2132button was pressed and are added together (X11 mouse report only):
2151 2133
2152=over 4 2134=over 4
2153 2135
2154=item State = B<< C<< (<b> - SPACE) & 60 >> >> 2136=item State = B<< C<< (<b> - SPACE) & ~3 >> >>
2155 2137
2156=begin table 2138=begin table
2157 2139
2158 4 Shift 2140 4 Shift
2159 8 Meta 2141 8 Meta
2160 16 Control 2142 16 Control
2143 32 Motion Notify
2161 32 Double Click I<(rxvt extension)> 2144 32 Double Click I<(rxvt extension)>, disabled by default
2145 64 Button1 is actually Button4, Button2 is actually Button5 etc.
2162 2146
2163=end table 2147=end table
2164 2148
2165Col = B<< C<< <x> - SPACE >> >> 2149Col = B<< C<< <x> - SPACE >> >>
2166 2150
… …
2175Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 2159Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
2176 2160
2177For the keypad, use B<Shift> to temporarily override Application-Keypad 2161For the keypad, use B<Shift> to temporarily override Application-Keypad
2178setting use B<Num_Lock> to toggle Application-Keypad setting if 2162setting use B<Num_Lock> to toggle Application-Keypad setting if
2179B<Num_Lock> is off, toggle Application-Keypad setting. Also note that 2163B<Num_Lock> is off, toggle Application-Keypad setting. Also note that
2180values of B<Home>, B<End>, B<Delete> may have been compiled differently on 2164values of B<BackSpace>, B<Delete> may have been compiled differently on
2181your system. 2165your system.
2182 2166
2183=begin table 2167=begin table
2184 2168
2185 B<Normal> B<Shift> B<Control> B<Ctrl+Shift> 2169 B<Normal> B<Shift> B<Control> B<Ctrl+Shift>
… …
2255 2239
2256=over 4 2240=over 4
2257 2241
2258=item --enable-everything 2242=item --enable-everything
2259 2243
2260Add (or remove) support for all non-multichoice options listed in "./configure 2244Add (or remove) support for all non-multichoice options listed
2261--help". 2245in C<./configure --help>, except for C<--enable-assert> and
2246C<--enable-256-color>.
2262 2247
2263You can specify this and then disable options you do not like by 2248You can specify this and then disable options you do not like by
2264I<following> this with the appropriate C<--disable-...> arguments, 2249I<following> this with the appropriate C<--disable-...> arguments,
2265or you can start with a minimal configuration by specifying 2250or you can start with a minimal configuration by specifying
2266C<--disable-everything> and than adding just the C<--enable-...> arguments 2251C<--disable-everything> and than adding just the C<--enable-...> arguments
2267you want. 2252you want.
2268 2253
2269=item --enable-xft (default: enabled) 2254=item --enable-xft (default: on)
2270 2255
2271Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2256Add 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 2257slower and require lots of memory, but as long as you don't use them, you
2273don't pay for them. 2258don't pay for them.
2274 2259
2275=item --enable-font-styles (default: on) 2260=item --enable-font-styles (default: on)
2276 2261
2277Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2262Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2278styles. The fonts can be set manually or automatically. 2263styles. The fonts can be set manually or automatically.
2279 2264
2280=item --with-codesets=NAME,... (default: all) 2265=item --with-codesets=CS,... (default: all)
2281 2266
2282Compile in support for additional codeset (encoding) groups (C<eu>, C<vn> 2267Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2283are always compiled in, which includes most 8-bit character sets). These 2268are always compiled in, which includes most 8-bit character sets). These
2284codeset tables are used for driving X11 core fonts, they are not required 2269codeset tables are used for driving X11 core fonts, they are not required
2285for Xft fonts, although having them compiled in lets rxvt-unicode choose 2270for Xft fonts, although having them compiled in lets rxvt-unicode choose
… …
2321 2306
2322=item --enable-combining (default: on) 2307=item --enable-combining (default: on)
2323 2308
2324Enable automatic composition of combining characters into 2309Enable automatic composition of combining characters into
2325composite characters. This is required for proper viewing of text 2310composite characters. This is required for proper viewing of text
2326where accents are encoded as seperate unicode characters. This is 2311where accents are encoded as separate unicode characters. This is
2327done by using precomposited characters when available or creating 2312done by using precomposed characters when available or creating
2328new pseudo-characters when no precomposed form exists. 2313new pseudo-characters when no precomposed form exists.
2329 2314
2330Without --enable-unicode3, the number of additional precomposed 2315Without --enable-unicode3, the number of additional precomposed
2331characters is somewhat limited (the 6400 private use characters will be 2316characters is somewhat limited (the 6400 private use characters will be
2332(ab-)used). With --enable-unicode3, no practical limit exists. 2317(ab-)used). With --enable-unicode3, no practical limit exists.
… …
2336 2321
2337The combining table also contains entries for arabic presentation forms, 2322The 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 2323but these are not currently used. Bug me if you want these to be used (and
2339tell me how these are to be used...). 2324tell me how these are to be used...).
2340 2325
2341=item --enable-fallback(=CLASS) (default: Rxvt) 2326=item --enable-fallback[=CLASS] (default: Rxvt)
2342 2327
2343When reading resource settings, also read settings for class CLASS. To 2328When reading resource settings, also read settings for class CLASS. To
2344disable resource fallback use --disable-fallback. 2329disable resource fallback use --disable-fallback.
2345 2330
2346=item --with-res-name=NAME (default: urxvt) 2331=item --with-res-name=NAME (default: urxvt)
… …
2369 2354
2370Write user and tty to lastlog file (used by programs like 2355Write user and tty to lastlog file (used by programs like
2371F<lastlogin>) at start of rxvt execution. This option requires 2356F<lastlogin>) at start of rxvt execution. This option requires
2372--enable-utmp to also be specified. 2357--enable-utmp to also be specified.
2373 2358
2374=item --enable-afterimage (default: on) 2359=item --enable-afterimage (default: off)
2375 2360
2376Add support for libAfterImage to be used for transparency and background 2361Add support for libAfterImage to be used for background
2377images. It adds support for many file formats including JPG, PNG, 2362images. It adds support for many file formats including JPG, PNG,
2378SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML 2363SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2379(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>). 2364(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2380
2381This option also adds such eye candy as blending an image over the root
2382background, as well as dynamic scaling and bluring of background images.
2383 2365
2384Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might 2366Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2385increase by a few megabytes even if no extra features are used (mostly due 2367increase by a few megabytes even if no extra features are used (mostly due
2386to third-party libraries used by libAI). Memory footprint may somewhat be 2368to third-party libraries used by libAI). Memory footprint may somewhat be
2387lowered if libAfterImage is configured without support for SVG. 2369lowered if libAfterImage is configured without support for SVG.
2388 2370
2371=item --enable-pixbuf (default: on)
2372
2373Add support for GDK-PixBuf to be used for background images.
2374It adds support for many file formats including JPG, PNG,
2375TIFF, GIF, XPM, BMP, ICO and TGA.
2376
2377=item --enable-startup-notification (default: on)
2378
2379Add support for freedesktop startup notifications. This allows window managers
2380to display some kind of progress indicator during startup.
2381
2389=item --enable-transparency (default: on) 2382=item --enable-transparency (default: on)
2390 2383
2391Add support for backgrounds, creating illusion of transparency in the term. 2384Add support for using the root pixmap as background to simulate transparency.
2385Note that blur and blend effects depend on libAfterImage or on
2386libXrender and on the availability of the RENDER extension in the X
2387server.
2392 2388
2393=item --enable-fading (default: on) 2389=item --enable-fading (default: on)
2394 2390
2395Add support for fading the text when focus is lost. 2391Add support for fading the text when focus is lost.
2396 2392
… …
2433in combination with other switches) is: 2429in combination with other switches) is:
2434 2430
2435 MWM-hints 2431 MWM-hints
2436 EWMH-hints (pid, utf8 names) and protocols (ping) 2432 EWMH-hints (pid, utf8 names) and protocols (ping)
2437 urgency hint 2433 urgency hint
2438 seperate underline colour (-underlineColor) 2434 separate underline colour (-underlineColor)
2439 settable border widths and borderless switch (-w, -b, -bl) 2435 settable border widths and borderless switch (-w, -b, -bl)
2440 visual depth selection (-depth) 2436 visual depth selection (-depth)
2441 settable extra linespacing /-lsp) 2437 settable extra linespacing (-lsp)
2442 iso-14755 5.1 (basic) support 2438 iso-14755 5.1 (basic) support
2443 tripleclickwords (-tcw) 2439 tripleclickwords (-tcw)
2444 settable insecure mode (-insecure) 2440 settable insecure mode (-insecure)
2445 keysym remapping support 2441 keysym remapping support
2446 cursor blinking and underline cursor (-bc, -uc) 2442 cursor blinking and underline cursor (-bc, -uc)
2447 XEmbed support (-embed) 2443 XEmbed support (-embed)
2448 user-pty (-pty-fd) 2444 user-pty (-pty-fd)
2449 hold on exit (-hold) 2445 hold on exit (-hold)
2450 compile in built-in block graphics 2446 compile in built-in block graphics
2451 skip builtin block graphics (-sbg) 2447 skip builtin block graphics (-sbg)
2452 separate highlightcolor support (-hc) 2448 separate highlight colour (-highlightColor, -highlightTextColor)
2449 extended mouse reporting modes (1005 and 1015).
2453 2450
2454It also enables some non-essential features otherwise disabled, such as: 2451It also enables some non-essential features otherwise disabled, such as:
2455 2452
2456 some round-trip time optimisations 2453 some round-trip time optimisations
2457 nearest color allocation on pseudocolor screens 2454 nearest colour allocation on pseudocolor screens
2458 UTF8_STRING support for selection 2455 UTF8_STRING support for selection
2459 sgr modes 90..97 and 100..107 2456 sgr modes 90..97 and 100..107
2460 backindex and forwardindex escape sequences 2457 backindex and forwardindex escape sequences
2461 view change/zero scrollback escape sequences 2458 view change/zero scrollback escape sequences
2462 locale switching escape sequence 2459 locale switching escape sequence
… …
2514environment variable when running configure. Even when compiled in, 2511environment variable when running configure. Even when compiled in,
2515perl will I<not> be initialised when all extensions have been disabled 2512perl 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 2513C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2517resource standpoint. 2514resource standpoint.
2518 2515
2516=item --enable-assert (default: off)
2517
2518Enables the assertions in the code, normally disabled. This switch is only
2519useful when developing rxvt-unicode.
2520
2521=item --enable-256-color (default: off)
2522
2523Force use of so-called 256 colour mode, to work around buggy applications
2524that do not support termcap/terminfo, or simply improve support for
2525applications hardcoding the xterm 256 colour table.
2526
2527This switch breaks termcap/terminfo compatibility to C<TERM=rxvt-unicode>,
2528and consequently sets C<TERM> to C<rxvt-unicode-256color> by default
2529(F<doc/etc/> contains termcap/terminfo definitions for both).
2530
2531It also results in higher memory usage and can slow down @@RXVT_NAME@@
2532dramatically when more than six fonts are in use by a terminal instance.
2533
2519=item --with-afterimage-config=DIR 2534=item --with-afterimage-config=DIR
2520 2535
2521Look for the libAfterImage config script in DIR. 2536Look for the libAfterImage config script in DIR.
2522 2537
2523=item --with-name=NAME (default: urxvt) 2538=item --with-name=NAME (default: urxvt)

Diff Legend

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