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.102 by root, Tue Jan 31 20:50:48 2006 UTC vs.
Revision 1.110 by root, Tue Jan 31 21:10:44 2006 UTC

19all escape sequences, and other background information. 19all escape sequences, and other background information.
20 20
21The newest version of this document is also available on the World Wide Web at 21The newest version of this document is also available on the World Wide Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
23 23
24=head1 FREQUENTLY ASKED QUESTIONS 24=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
25 25
26 26
27=head2 Meta, Features & Commandline Issues 27=head2 Meta, Features & Commandline Issues
28 28
29=head3 My question isn't answered here, can I ask a human? 29=head3 My question isn't answered here, can I ask a human?
36 36
37Beginning with version 7.3, there is a perl extension that implements a 37Beginning with version 7.3, there is a perl extension that implements a
38simple tabbed terminal. It is installed by default, so any of these should 38simple tabbed terminal. It is installed by default, so any of these should
39give you tabs: 39give you tabs:
40 40
41 @@RXVT_NAME@@ -pe tabbed 41 @@URXVT_NAME@@ -pe tabbed
42 42
43 URxvt.perl-ext-common: default,tabbed 43 URxvt.perl-ext-common: default,tabbed
44 44
45It will also work fine with tabbing functionality of many window managers 45It will also work fine with tabbing functionality of many window managers
46or similar tabbing programs, and its embedding-features allow it to be 46or similar tabbing programs, and its embedding-features allow it to be
50 50
51=head3 How do I know which rxvt-unicode version I'm using? 51=head3 How do I know which rxvt-unicode version I'm using?
52 52
53The version number is displayed with the usage (-h). Also the escape 53The version number is displayed with the usage (-h). Also the escape
54sequence C<ESC [ 8 n> sets the window title to the version number. When 54sequence C<ESC [ 8 n> sets the window title to the version number. When
55using the @@RXVT_NAME@@c client, the version displayed is that of the 55using the @@URXVT_NAME@@c client, the version displayed is that of the
56daemon. 56daemon.
57 57
58=head3 Rxvt-unicode uses gobs of memory, how can I reduce that? 58=head3 Rxvt-unicode uses gobs of memory, how can I reduce that?
59 59
60Rxvt-unicode tries to obey the rule of not charging you for something you 60Rxvt-unicode tries to obey the rule of not charging you for something you
686 bytes per screen cell. For a 160x?? window this amounts to almost a 686 bytes per screen cell. For a 160x?? window this amounts to almost a
69kilobyte per line. A scrollback buffer of 10000 lines will then (if full) 69kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
70use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as 70use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
71rxvt-unicode then uses 8 bytes per screen cell. 71rxvt-unicode then uses 8 bytes per screen cell.
72 72
73=head3 How can I start @@RXVT_NAME@@d in a race-free way? 73=head3 How can I start @@URXVT_NAME@@d in a race-free way?
74 74
75Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the 75Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
76display, create the listening socket and then fork. 76display, create the listening socket and then fork.
77 77
78=head3 How do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc. 78=head3 How do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
79 79
80rxvt and rxvt-unicode always export the variable "COLORTERM", so you can 80The original rxvt and rxvt-unicode always export the variable "COLORTERM",
81check and see if that is set. Note that several programs, JED, slrn, 81so you can check and see if that is set. Note that several programs, JED,
82Midnight Commander automatically check this variable to decide whether or 82slrn, Midnight Commander automatically check this variable to decide
83not to use color. 83whether or not to use color.
84 84
85=head3 How do I set the correct, full IP address for the DISPLAY variable? 85=head3 How do I set the correct, full IP address for the DISPLAY variable?
86 86
87If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled 87If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
88insecure mode then it is possible to use the following shell script 88insecure mode then it is possible to use the following shell script
125 125
126 text data bss drs rss filename 126 text data bss drs rss filename
127 98398 1664 24 15695 1824 rxvt --disable-everything 127 98398 1664 24 15695 1824 rxvt --disable-everything
128 188985 9048 66616 18222 1788 urxvt --disable-everything 128 188985 9048 66616 18222 1788 urxvt --disable-everything
129 129
130When you C<--enable-everything> (which _is_ unfair, as this involves xft 130When you C<--enable-everything> (which I<is> unfair, as this involves xft
131and full locale/XIM support which are quite bloaty inside libX11 and my 131and full locale/XIM support which are quite bloaty inside libX11 and my
132libc), the two diverge, but not unreasnobaly so. 132libc), the two diverge, but not unreasnobaly so.
133 133
134 text data bss drs rss filename 134 text data bss drs rss filename
135 163431 2152 24 20123 2060 rxvt --enable-everything 135 163431 2152 24 20123 2060 rxvt --enable-everything
203descriptions for the programs mentioned and rxvt-unicode. Really, do it! 203descriptions for the programs mentioned and rxvt-unicode. Really, do it!
204 204
2051. Use inheritPixmap: 2051. Use inheritPixmap:
206 206
207 Esetroot wallpaper.jpg 207 Esetroot wallpaper.jpg
208 @@RXVT_NAME@@ -ip -tint red -sh 40 208 @@URXVT_NAME@@ -ip -tint red -sh 40
209 209
210That works. If you think it doesn't, you lack transparency and tinting 210That works. If you think it doesn't, you lack transparency and tinting
211support, or you are unable to read. 211support, or you are unable to read.
212 212
2132. Use a simple pixmap and emulate pseudo-transparency. This enables you 2132. Use a simple pixmap and emulate pseudo-transparency. This enables you
214to use effects other than tinting and shading: Just shade/tint/whatever 214to use effects other than tinting and shading: Just shade/tint/whatever
215your picture with gimp or any other tool: 215your picture with gimp or any other tool:
216 216
217 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm 217 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
218 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background 218 @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background
219 219
220That works. If you think it doesn't, you lack XPM and Perl support, or you 220That works. If you think it doesn't, you lack XPM and Perl support, or you
221are unable to read. 221are unable to read.
222 222
2233. Use an ARGB visual: 2233. Use an ARGB visual:
224 224
225 @@RXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc 225 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
226 226
227This requires XFT support, and the support of your X-server. If that 227This requires XFT support, and the support of your X-server. If that
228doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't 228doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
229there yet, no matter what they claim. Rxvt-Unicode contains the neccessary 229there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
230bugfixes and workarounds for Xft and Xlib to make it work, but that 230bugfixes and workarounds for Xft and Xlib to make it work, but that
236 -set _NET_WM_WINDOW_OPACITY 0xc0000000 236 -set _NET_WM_WINDOW_OPACITY 0xc0000000
237 237
238Then click on a window you want to make transparent. Replace C<0xc0000000> 238Then click on a window you want to make transparent. Replace C<0xc0000000>
239by other values to change the degree of opacity. If it doesn't work and 239by other values to change the degree of opacity. If it doesn't work and
240your server crashes, you got to keep the pieces. 240your server crashes, you got to keep the pieces.
241
242=head3 Why do some chinese characters look so different than others?
243
244This is because there is a difference between script and language --
245rxvt-unicode does not know which language the text that is output is,
246as it only knows the unicode character codes. If rxvt-unicode first
247sees a japanese/chinese character, it might choose a japanese font for
248display. Subsequent japanese characters will use that font. Now, many
249chinese characters aren't represented in japanese fonts, so when the first
250non-japanese character comes up, rxvt-unicode will look for a chinese font
251-- unfortunately at this point, it will still use the japanese font for
252chinese characters that are also in the japanese font.
253
254The workaround is easy: just tag a chinese font at the end of your font
255list (see the previous question). The key is to view the font list as
256a preference list: If you expect more japanese, list a japanese font
257first. If you expect more chinese, put a chinese font first.
258
259In the future it might be possible to switch language preferences at
260runtime (the internal data structure has no problem with using different
261fonts for the same character at the same time, but no interface for this
262has been designed yet).
263
264Until then, you might get away with switching fonts at runtime (see L<Can
265I switch the fonts at runtime?> later in this document).
266 241
267=head3 Why does rxvt-unicode sometimes leave pixel droppings? 242=head3 Why does rxvt-unicode sometimes leave pixel droppings?
268 243
269Most fonts were not designed for terminal use, which means that character 244Most fonts were not designed for terminal use, which means that character
270size varies a lot. A font that is otherwise fine for terminal use might 245size varies a lot. A font that is otherwise fine for terminal use might
388 URxvt.color12: #0000FF 363 URxvt.color12: #0000FF
389 URxvt.color13: #FF00FF 364 URxvt.color13: #FF00FF
390 URxvt.color14: #00FFFF 365 URxvt.color14: #00FFFF
391 URxvt.color15: #FFFFFF 366 URxvt.color15: #FFFFFF
392 367
393And here is a more complete set of non-standard colors described (not by 368And here is a more complete set of non-standard colors.
394me) as "pretty girly".
395 369
396 URxvt.cursorColor: #dc74d1 370 URxvt.cursorColor: #dc74d1
397 URxvt.pointerColor: #dc74d1 371 URxvt.pointerColor: #dc74d1
398 URxvt.background: #0e0e0e 372 URxvt.background: #0e0e0e
399 URxvt.foreground: #4ad5e1 373 URxvt.foreground: #4ad5e1
410 URxvt.color6: #73f7ff 384 URxvt.color6: #73f7ff
411 URxvt.color14: #73f7ff 385 URxvt.color14: #73f7ff
412 URxvt.color7: #e1dddd 386 URxvt.color7: #e1dddd
413 URxvt.color15: #e1dddd 387 URxvt.color15: #e1dddd
414 388
389They have been described (not by me) as "pretty girly".
390
415=head3 Why do some characters look so much different than others? 391=head3 Why do some characters look so much different than others?
416 392
417See next entry. 393See next entry.
418 394
419=head3 How does rxvt-unicode choose fonts? 395=head3 How does rxvt-unicode choose fonts?
420 396
421Most fonts do not contain the full range of Unicode, which is 397Most fonts do not contain the full range of Unicode, which is
422fine. Chances are that the font you (or the admin/package maintainer of 398fine. Chances are that the font you (or the admin/package maintainer of
423your system/os) have specified does not cover all the characters you want 399your system/os) have specified does not cover all the characters you want
424to display. 400to display.
425 401
426B<rxvt-unicode> makes a best-effort try at finding a replacement 402B<rxvt-unicode> makes a best-effort try at finding a replacement
427font. Often the result is fine, but sometimes the chosen font looks 403font. Often the result is fine, but sometimes the chosen font looks
428bad/ugly/wrong. Some fonts have totally strange characters that don't 404bad/ugly/wrong. Some fonts have totally strange characters that don't
429resemble the correct glyph at all, and rxvt-unicode lacks the artificial 405resemble the correct glyph at all, and rxvt-unicode lacks the artificial
430intelligence to detect that a specific glyph is wrong: it has to believe 406intelligence to detect that a specific glyph is wrong: it has to believe
431the font that the characters it claims to contain indeed look correct. 407the font that the characters it claims to contain indeed look correct.
432 408
433In that case, select a font of your taste and add it to the font list, 409In that case, select a font of your taste and add it to the font list,
434e.g.: 410e.g.:
435 411
436 @@RXVT_NAME@@ -fn basefont,font2,font3... 412 @@URXVT_NAME@@ -fn basefont,font2,font3...
437 413
438When rxvt-unicode sees a character, it will first look at the base 414When rxvt-unicode sees a character, it will first look at the base
439font. If the base font does not contain the character, it will go to the 415font. If the base font does not contain the character, it will go to the
440next font, and so on. Specifying your own fonts will also speed up this 416next font, and so on. Specifying your own fonts will also speed up this
441search and use less resources within rxvt-unicode and the X-server. 417search and use less resources within rxvt-unicode and the X-server.
442 418
443The only limitation is that none of the fonts may be larger than the base 419The only limitation is that none of the fonts may be larger than the base
444font, as the base font defines the terminal character cell size, which 420font, as the base font defines the terminal character cell size, which
445must be the same due to the way terminals work. 421must be the same due to the way terminals work.
446 422
423=head3 Why do some chinese characters look so different than others?
424
425This is because there is a difference between script and language --
426rxvt-unicode does not know which language the text that is output is,
427as it only knows the unicode character codes. If rxvt-unicode first
428sees a japanese/chinese character, it might choose a japanese font for
429display. Subsequent japanese characters will use that font. Now, many
430chinese characters aren't represented in japanese fonts, so when the first
431non-japanese character comes up, rxvt-unicode will look for a chinese font
432-- unfortunately at this point, it will still use the japanese font for
433chinese characters that are also in the japanese font.
434
435The workaround is easy: just tag a chinese font at the end of your font
436list (see the previous question). The key is to view the font list as
437a preference list: If you expect more japanese, list a japanese font
438first. If you expect more chinese, put a chinese font first.
439
440In the future it might be possible to switch language preferences at
441runtime (the internal data structure has no problem with using different
442fonts for the same character at the same time, but no interface for this
443has been designed yet).
444
445Until then, you might get away with switching fonts at runtime (see L<Can
446I switch the fonts at runtime?> later in this document).
447 447
448=head2 Keyboard, Mouse & User Interaction 448=head2 Keyboard, Mouse & User Interaction
449 449
450=head3 The new selection selects pieces that are too big, how can I select single words? 450=head3 The new selection selects pieces that are too big, how can I select single words?
451 451
470B<perl-ext-common> resource to the empty string, which also keeps 470B<perl-ext-common> resource to the empty string, which also keeps
471rxvt-unicode from initialising perl, saving memory. 471rxvt-unicode from initialising perl, saving memory.
472 472
473If you only want to disable specific features, you first have to 473If you only want to disable specific features, you first have to
474identify which perl extension is responsible. For this, read the section 474identify which perl extension is responsible. For this, read the section
475B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For 475B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
476example, to disable the B<selection-popup> and B<option-popup>, specify 476example, to disable the B<selection-popup> and B<option-popup>, specify
477this B<perl-ext-common> resource: 477this B<perl-ext-common> resource:
478 478
479 URxvt.perl-ext-common: default,-selection-popup,-option-popup 479 URxvt.perl-ext-common: default,-selection-popup,-option-popup
480 480
558 558
559For starting a new rxvt-unicode: 559For starting a new rxvt-unicode:
560 560
561 # use Backspace = ^H 561 # use Backspace = ^H
562 $ stty erase ^H 562 $ stty erase ^H
563 $ @@RXVT_NAME@@ 563 $ @@URXVT_NAME@@
564 564
565 # use Backspace = ^? 565 # use Backspace = ^?
566 $ stty erase ^? 566 $ stty erase ^?
567 $ @@RXVT_NAME@@ 567 $ @@URXVT_NAME@@
568 568
569Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>. 569Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
570 570
571For an existing rxvt-unicode: 571For an existing rxvt-unicode:
572 572
599 599
600There are some compile-time selections available via configure. Unless 600There are some compile-time selections available via configure. Unless
601you have run "configure" with the C<--disable-resources> option you can 601you have run "configure" with the C<--disable-resources> option you can
602use the `keysym' resource to alter the keystrings associated with keysyms. 602use the `keysym' resource to alter the keystrings associated with keysyms.
603 603
604Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt> 604Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
605 605
606 URxvt.keysym.Home: \033[1~ 606 URxvt.keysym.Home: \033[1~
607 URxvt.keysym.End: \033[4~ 607 URxvt.keysym.End: \033[4~
608 URxvt.keysym.C-apostrophe: \033<C-'> 608 URxvt.keysym.C-apostrophe: \033<C-'>
609 URxvt.keysym.C-slash: \033<C-/> 609 URxvt.keysym.C-slash: \033<C-/>
687resource to set it: 687resource to set it:
688 688
689 URxvt.termName: rxvt 689 URxvt.termName: rxvt
690 690
691If you don't plan to use B<rxvt> (quite common...) you could also replace 691If you don't plan to use B<rxvt> (quite common...) you could also replace
692the rxvt terminfo file with the rxvt-unicode one. 692the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
693 693
694=head3 C<tic> outputs some error when compiling the terminfo entry. 694=head3 C<tic> outputs some error when compiling the terminfo entry.
695 695
696Most likely it's the empty definition for C<enacs=>. Just replace it by 696Most likely it's the empty definition for C<enacs=>. Just replace it by
697C<enacs=\E[0@> and try again. 697C<enacs=\E[0@> and try again.
698 698
699=head3 C<bash>'s readline does not work correctly under @@RXVT_NAME@@. 699=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
700 700
701See next entry. 701See next entry.
702 702
703=head3 I need a termcap file entry. 703=head3 I need a termcap file entry.
704 704
1003 1003
1004At the time of this writing, cygwin didn't seem to support any multi-byte 1004At the time of this writing, cygwin didn't seem to support any multi-byte
1005encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited 1005encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1006to 8-bit encodings. 1006to 8-bit encodings.
1007 1007
1008=head1 RXVT TECHNICAL REFERENCE 1008=head1 RXVT-UNICODE TECHNICAL REFERENCE
1009
1010=head1 DESCRIPTION
1011 1009
1012The rest of this document describes various technical aspects of 1010The rest of this document describes various technical aspects of
1013B<rxvt-unicode>. First the description of supported command sequences, 1011B<rxvt-unicode>. First the description of supported command sequences,
1014followed by pixmap support and last by a description of all features 1012followed by pixmap support and last by a description of all features
1015selectable at C<configure> time. 1013selectable at C<configure> time.
1016 1014
1017=head1 Definitions 1015=head2 Definitions
1018 1016
1019=over 4 1017=over 4
1020 1018
1021=item B<< C<c> >> 1019=item B<< C<c> >>
1022 1020
1040 1038
1041A text parameter composed of printable characters. 1039A text parameter composed of printable characters.
1042 1040
1043=back 1041=back
1044 1042
1045=head1 Values 1043=head2 Values
1046 1044
1047=over 4 1045=over 4
1048 1046
1049=item B<< C<ENQ> >> 1047=item B<< C<ENQ> >>
1050 1048
1093 1091
1094Space Character 1092Space Character
1095 1093
1096=back 1094=back
1097 1095
1098=head1 Escape Sequences 1096=head2 Escape Sequences
1099 1097
1100=over 4 1098=over 4
1101 1099
1102=item B<< C<ESC # 8> >> 1100=item B<< C<ESC # 8> >>
1103 1101
1201 1199
1202=back 1200=back
1203 1201
1204X<CSI> 1202X<CSI>
1205 1203
1206=head1 CSI (Command Sequence Introducer) Sequences 1204=head2 CSI (Command Sequence Introducer) Sequences
1207 1205
1208=over 4 1206=over 4
1209 1207
1210=item B<< C<ESC [ Ps @> >> 1208=item B<< C<ESC [ Ps @> >>
1211 1209
1481 1479
1482=back 1480=back
1483 1481
1484X<PrivateModes> 1482X<PrivateModes>
1485 1483
1486=head1 DEC Private Modes 1484=head2 DEC Private Modes
1487 1485
1488=over 4 1486=over 4
1489 1487
1490=item B<< C<ESC [ ? Pm h> >> 1488=item B<< C<ESC [ ? Pm h> >>
1491 1489
1755 1753
1756=back 1754=back
1757 1755
1758X<XTerm> 1756X<XTerm>
1759 1757
1760=head1 XTerm Operating System Commands 1758=head2 XTerm Operating System Commands
1761 1759
1762=over 4 1760=over 4
1763 1761
1764=item B<< C<ESC ] Ps;Pt ST> >> 1762=item B<< C<ESC ] Ps;Pt ST> >>
1765 1763
1803 1801
1804=end table 1802=end table
1805 1803
1806=back 1804=back
1807 1805
1808X<XPM>
1809
1810=head1 XPM 1806=head1 XPM
1811 1807
1812For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 1808For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1813of B<< C<Pt> >> can be the name of the background pixmap followed by a 1809of B<< C<Pt> >> can be the name of the background pixmap followed by a
1814sequence of scaling/positioning commands separated by semi-colons. The 1810sequence of scaling/positioning commands separated by semi-colons. The
1911=begin table 1907=begin table
1912 1908
1913 4 Shift 1909 4 Shift
1914 8 Meta 1910 8 Meta
1915 16 Control 1911 16 Control
1916 32 Double Click I<(Rxvt extension)> 1912 32 Double Click I<(rxvt extension)>
1917 1913
1918=end table 1914=end table
1919 1915
1920Col = B<< C<< <x> - SPACE >> >> 1916Col = B<< C<< <x> - SPACE >> >>
1921 1917

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines