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.114 by root, Tue Feb 21 00:59:59 2006 UTC vs.
Revision 1.155 by ayin, Sun Dec 9 12:15:39 2007 UTC

… …
17 17
18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting 18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19all escape sequences, and other background information. 19all escape sequences, and other background information.
20 20
21The newest version of this document is also available on the World Wide Web at 21The newest version of this document is also available on the World Wide Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
23 23
24=head1 RXVT-UNICODE/URXVT 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
… …
73=head3 How can I start @@URXVT_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<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_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 can I start @@URXVT_NAME@@d automatically when I run URXVT_NAME@@c? 78=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
79 79
80If you want to start @@URXVT_NAME@@d automatically whenever you run 80If you want to start @@URXVT_NAME@@d automatically whenever you run
81@@URXVT_NAME@@c and the daemon isn't running yet, use this script: 81@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
82 82
83 #!/bin/sh 83 #!/bin/sh
… …
90This tries to create a new terminal, and if fails with exit status 2, 90This tries to create a new terminal, and if fails with exit status 2,
91meaning it couldn't connect to the daemon, it will start the daemon and 91meaning it couldn't connect to the daemon, it will start the daemon and
92re-run the command. Subsequent invocations of the script will re-use the 92re-run the command. Subsequent invocations of the script will re-use the
93existing daemon. 93existing daemon.
94 94
95=head3 How do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc. 95=head3 How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
96 96
97The original rxvt and rxvt-unicode always export the variable "COLORTERM", 97The original rxvt and rxvt-unicode always export the variable "COLORTERM",
98so you can check and see if that is set. Note that several programs, JED, 98so you can check and see if that is set. Note that several programs, JED,
99slrn, Midnight Commander automatically check this variable to decide 99slrn, Midnight Commander automatically check this variable to decide
100whether or not to use color. 100whether or not to use color.
… …
125 fi 125 fi
126 126
127=head3 How do I compile the manual pages on my own? 127=head3 How do I compile the manual pages on my own?
128 128
129You need to have a recent version of perl installed as F</usr/bin/perl>, 129You need to have a recent version of perl installed as F</usr/bin/perl>,
130one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to 130one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from
131the doc subdirectory and enter C<make alldoc>. 131F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
132 132
133=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat? 133=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
134 134
135I often get asked about this, and I think, no, they didn't cause extra 135I often get asked about this, and I think, no, they didn't cause extra
136bloat. If you compare a minimal rxvt and a minimal urxvt, you can see 136bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
… …
144 98398 1664 24 15695 1824 rxvt --disable-everything 144 98398 1664 24 15695 1824 rxvt --disable-everything
145 188985 9048 66616 18222 1788 urxvt --disable-everything 145 188985 9048 66616 18222 1788 urxvt --disable-everything
146 146
147When you C<--enable-everything> (which I<is> unfair, as this involves xft 147When you C<--enable-everything> (which I<is> unfair, as this involves xft
148and full locale/XIM support which are quite bloaty inside libX11 and my 148and full locale/XIM support which are quite bloaty inside libX11 and my
149libc), the two diverge, but not unreasnobaly so. 149libc), the two diverge, but not unreasonably so.
150 150
151 text data bss drs rss filename 151 text data bss drs rss filename
152 163431 2152 24 20123 2060 rxvt --enable-everything 152 163431 2152 24 20123 2060 rxvt --enable-everything
153 1035683 49680 66648 29096 3680 urxvt --enable-everything 153 1035683 49680 66648 29096 3680 urxvt --enable-everything
154 154
… …
197 197
198And here is rxvt-unicode: 198And here is rxvt-unicode:
199 199
200 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) 200 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
201 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) 201 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
202 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) 202 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
203 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) 203 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
204 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) 204 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
205 205
206No large bloated libraries (of course, none were linked in statically), 206No large bloated libraries (of course, none were linked in statically),
207except maybe libX11 :) 207except maybe libX11 :)
208 208
209 209
210=head2 Rendering, Font & Look and Feel Issues 210=head2 Rendering, Font & Look and Feel Issues
211 211
212=head3 I can't get transparency working, what am I doing wrong? 212=head3 I can't get transparency working, what am I doing wrong?
213 213
214First of all, transparency isn't officially supported in rxvt-unicode, so 214First of all, please address all transparency related issues to Sasha Vasko at
215you are mostly on your own. Do not bug the author about it (but you may 215sasha@aftercode.net and do not bug the author about it. Also, if you can't
216bug everybody else). Also, if you can't get it working consider it a rite 216get it working consider it a rite of passage: ... and you failed.
217of passage: ... and you failed.
218 217
219Here are four ways to get transparency. B<Do> read the manpage and option 218Here are four ways to get transparency. B<Do> read the manpage and option
220descriptions for the programs mentioned and rxvt-unicode. Really, do it! 219descriptions for the programs mentioned and rxvt-unicode. Really, do it!
221 220
2221. Use inheritPixmap: 2211. Use transparent mode:
223 222
224 Esetroot wallpaper.jpg 223 Esetroot wallpaper.jpg
225 @@URXVT_NAME@@ -ip -tint red -sh 40 224 @@URXVT_NAME@@ -tr -tint red -sh 40
226 225
227That works. If you think it doesn't, you lack transparency and tinting 226That works. If you think it doesn't, you lack transparency and tinting
228support, or you are unable to read. 227support, or you are unable to read.
229 228
2302. Use a simple pixmap and emulate pseudo-transparency. This enables you 2292. Use a simple pixmap and emulate pseudo-transparency. This enables you
231to use effects other than tinting and shading: Just shade/tint/whatever 230to use effects other than tinting and shading: Just shade/tint/whatever
232your picture with gimp or any other tool: 231your picture with gimp or any other tool:
233 232
234 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm 233 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
235 @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background 234 @@URXVT_NAME@@ -pixmap "background.jpg;:root"
236 235
237That works. If you think it doesn't, you lack XPM and Perl support, or you 236That works. If you think it doesn't, you lack AfterImage support, or you
238are unable to read. 237are unable to read.
239 238
2403. Use an ARGB visual: 2393. Use an ARGB visual:
241 240
242 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc 241 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
243 242
244This requires XFT support, and the support of your X-server. If that 243This requires XFT support, and the support of your X-server. If that
245doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't 244doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
246there yet, no matter what they claim. Rxvt-Unicode contains the neccessary 245there yet, no matter what they claim. Rxvt-Unicode contains the necessary
247bugfixes and workarounds for Xft and Xlib to make it work, but that 246bugfixes and workarounds for Xft and Xlib to make it work, but that
248doesn't mean that your WM has the required kludges in place. 247doesn't mean that your WM has the required kludges in place.
249 248
2504. Use xcompmgr and let it do the job: 2494. Use xcompmgr and let it do the job:
251 250
… …
268however: Xft fonts often draw glyphs larger than their acclaimed bounding 267however: Xft fonts often draw glyphs larger than their acclaimed bounding
269box, and rxvt-unicode has no way of detecting this (the correct way is to 268box, and rxvt-unicode has no way of detecting this (the correct way is to
270ask for the character bounding box, which unfortunately is wrong in these 269ask for the character bounding box, which unfortunately is wrong in these
271cases). 270cases).
272 271
273It's not clear (to me at least), wether this is a bug in Xft, freetype, 272It's not clear (to me at least), whether this is a bug in Xft, freetype,
274or the respective font. If you encounter this problem you might try using 273or the respective font. If you encounter this problem you might try using
275the C<-lsp> option to give the font more height. If that doesn't work, you 274the C<-lsp> option to give the font more height. If that doesn't work, you
276might be forced to use a different font. 275might be forced to use a different font.
277 276
278All of this is not a problem when using X11 core fonts, as their bounding 277All of this is not a problem when using X11 core fonts, as their bounding
… …
302=head3 Can I switch the fonts at runtime? 301=head3 Can I switch the fonts at runtime?
303 302
304Yes, using an escape sequence. Try something like this, which has the same 303Yes, using an escape sequence. Try something like this, which has the same
305effect as using the C<-fn> switch, and takes effect immediately: 304effect as using the C<-fn> switch, and takes effect immediately:
306 305
307 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" 306 printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
308 307
309This is useful if you e.g. work primarily with japanese (and prefer a 308This is useful if you e.g. work primarily with japanese (and prefer a
310japanese font), but you have to switch to chinese temporarily, where 309japanese font), but you have to switch to chinese temporarily, where
311japanese fonts would only be in your way. 310japanese fonts would only be in your way.
312 311
… …
314 313
315=head3 Why do italic characters look as if clipped? 314=head3 Why do italic characters look as if clipped?
316 315
317Many fonts have difficulties with italic characters and hinting. For 316Many fonts have difficulties with italic characters and hinting. For
318example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans 317example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
319Mono> completely fails in it's italic face. A workaround might be to 318Mono> completely fails in its italic face. A workaround might be to
320enable freetype autohinting, i.e. like this: 319enable freetype autohinting, i.e. like this:
321 320
322 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 321 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
323 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 322 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
324 323
… …
330memory and also speeds up rendering considerably. 329memory and also speeds up rendering considerably.
331 330
332=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 331=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
333 332
334Rxvt-unicode will use whatever you specify as a font. If it needs to 333Rxvt-unicode will use whatever you specify as a font. If it needs to
335fall back to it's default font search list it will prefer X11 core 334fall back to its default font search list it will prefer X11 core
336fonts, because they are small and fast, and then use Xft fonts. It has 335fonts, because they are small and fast, and then use Xft fonts. It has
337antialiasing disabled for most of them, because the author thinks they 336antialiasing disabled for most of them, because the author thinks they
338look best that way. 337look best that way.
339 338
340If you want antialiasing, you have to specify the fonts manually. 339If you want antialiasing, you have to specify the fonts manually.
… …
342=head3 What's with this bold/blink stuff? 341=head3 What's with this bold/blink stuff?
343 342
344If no bold colour is set via C<colorBD:>, bold will invert text using the 343If no bold colour is set via C<colorBD:>, bold will invert text using the
345standard foreground colour. 344standard foreground colour.
346 345
347For the standard background colour, blinking will actually make the 346For the standard background colour, blinking will actually make
348text blink when compiled with C<--enable-blinking>. with standard 347the text blink when compiled with C<--enable-text-blink>. Without
349colours. Without C<--enable-blinking>, the blink attribute will be 348C<--enable-text-blink>, the blink attribute will be ignored.
350ignored.
351 349
352On ANSI colours, bold/blink attributes are used to set high-intensity 350On ANSI colours, bold/blink attributes are used to set high-intensity
353foreground/background colors. 351foreground/background colors.
354 352
355color0-7 are the low-intensity colors. 353color0-7 are the low-intensity colors.
… …
460has been designed yet). 458has been designed yet).
461 459
462Until then, you might get away with switching fonts at runtime (see L<Can 460Until then, you might get away with switching fonts at runtime (see L<Can
463I switch the fonts at runtime?> later in this document). 461I switch the fonts at runtime?> later in this document).
464 462
463=head3 How can I make mplayer display video correctly?
464
465We are working on it, in the meantime, as a workaround, use something like:
466
467 @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
468
469
465=head2 Keyboard, Mouse & User Interaction 470=head2 Keyboard, Mouse & User Interaction
466 471
467=head3 The new selection selects pieces that are too big, how can I select single words? 472=head3 The new selection selects pieces that are too big, how can I select single words?
468 473
469If you want to select e.g. alphanumeric words, you can use the following 474If you want to select e.g. alphanumeric words, you can use the following
… …
512circumstances, it will move your cursor around when you click into the 517circumstances, it will move your cursor around when you click into the
513line that contains it. It tries hard not to do this at the wrong moment, 518line that contains it. It tries hard not to do this at the wrong moment,
514but when running a program that doesn't parse cursor movements or in some 519but when running a program that doesn't parse cursor movements or in some
515cases during rlogin sessions, it fails to detect this properly. 520cases during rlogin sessions, it fails to detect this properly.
516 521
517You can permamently switch this feature off by disabling the C<readline> 522You can permanently switch this feature off by disabling the C<readline>
518extension: 523extension:
519 524
520 URxvt.perl-ext-common: default,-readline 525 URxvt.perl-ext-common: default,-readline
521 526
522=head3 My numerical keypad acts weird and generates differing output? 527=head3 My numerical keypad acts weird and generates differing output?
523 528
524Some Debian GNUL/Linux users seem to have this problem, although no 529Some Debian GNUL/Linux users seem to have this problem, although no
525specific details were reported so far. It is possible that this is caused 530specific details were reported so far. It is possible that this is caused
526by the wrong C<TERM> setting, although the details of wether and how 531by the wrong C<TERM> setting, although the details of whether and how
527this can happen are unknown, as C<TERM=rxvt> should offer a compatible 532this can happen are unknown, as C<TERM=rxvt> should offer a compatible
528keymap. See the answer to the previous question, and please report if that 533keymap. See the answer to the previous question, and please report if that
529helped. 534helped.
530 535
531=head3 My Compose (Multi_key) key is no longer working. 536=head3 My Compose (Multi_key) key is no longer working.
… …
557depressed. 562depressed.
558 563
559=head3 What's with the strange Backspace/Delete key behaviour? 564=head3 What's with the strange Backspace/Delete key behaviour?
560 565
561Assuming that the physical Backspace key corresponds to the 566Assuming that the physical Backspace key corresponds to the
562BackSpace keysym (not likely for Linux ... see the following 567Backspace keysym (not likely for Linux ... see the following
563question) there are two standard values that can be used for 568question) there are two standard values that can be used for
564Backspace: C<^H> and C<^?>. 569Backspace: C<^H> and C<^?>.
565 570
566Historically, either value is correct, but rxvt-unicode adopts the debian 571Historically, either value is correct, but rxvt-unicode adopts the debian
567policy of using C<^?> when unsure, because it's the one only only correct 572policy of using C<^?> when unsure, because it's the one and only correct
568choice :). 573choice :).
569 574
570Rxvt-unicode tries to inherit the current stty settings and uses the value 575Rxvt-unicode tries to inherit the current stty settings and uses the value
571of `erase' to guess the value for backspace. If rxvt-unicode wasn't 576of `erase' to guess the value for backspace. If rxvt-unicode wasn't
572started from a terminal (say, from a menu or by remote shell), then the 577started from a terminal (say, from a menu or by remote shell), then the
… …
604key has been assigned an escape sequence to match the vt100 for Execute 609key has been assigned an escape sequence to match the vt100 for Execute
605(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo. 610(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
606 611
607Some other Backspace problems: 612Some other Backspace problems:
608 613
609some editors use termcap/terminfo, 614some editors use termcap/terminfo,
610some editors (vim I'm told) expect Backspace = ^H, 615some editors (vim I'm told) expect Backspace = ^H,
611GNU Emacs (and Emacs-like editors) use ^H for help. 616GNU Emacs (and Emacs-like editors) use ^H for help.
612 617
613Perhaps someday this will all be resolved in a consistent manner. 618Perhaps someday this will all be resolved in a consistent manner.
614 619
… …
655Rather than have rxvt-unicode try to accommodate all the various possible 660Rather than have rxvt-unicode try to accommodate all the various possible
656keyboard mappings, it is better to use `xmodmap' to remap the keys as 661keyboard mappings, it is better to use `xmodmap' to remap the keys as
657required for your particular machine. 662required for your particular machine.
658 663
659 664
660
661=head2 Terminal Configuration 665=head2 Terminal Configuration
662 666
663=head3 Can I see a typical configuration? 667=head3 Can I see a typical configuration?
664 668
665The default configuration tries to be xterm-like, which I don't like that 669The default configuration tries to be xterm-like, which I don't like that
666much, but it's least surprise to regular users. 670much, but it's least surprise to regular users.
667 671
668As a rxvt or rxvt-unicode user, you are practically supposed to invest 672As a rxvt or rxvt-unicode user, you are practically supposed to invest
669time into customising your terminal. To get you started, here is the 673time into customising your terminal. To get you started, here is the
670author's .Xdefaults entries, with comments on what they do: 674author's .Xdefaults entries, with comments on what they do. It's certainly
675not I<typical>, but what's typical...
671 676
672 URxvt.cutchars: "()*,<>[]{}|' 677 URxvt.cutchars: "()*,<>[]{}|'
673 URxvt.print-pipe: cat >/tmp/xxx 678 URxvt.print-pipe: cat >/tmp/xxx
674 679
675These are just for testing stuff. 680These are just for testing stuff.
… …
693directory and also tells urxvt to use a large number of extensions. I 698directory and also tells urxvt to use a large number of extensions. I
694develop for myself mostly, so I actually use most of the extensions I 699develop for myself mostly, so I actually use most of the extensions I
695write. 700write.
696 701
697The selection stuff mainly makes the selection perl-error-message aware 702The selection stuff mainly makes the selection perl-error-message aware
698and tells it to convert pelr error mssages into vi-commands to load the 703and tells it to convert perl error messages into vi-commands to load the
699relevant file and go tot he error line number. 704relevant file and go tot he error line number.
700 705
701 URxvt.scrollstyle: plain 706 URxvt.scrollstyle: plain
702 URxvt.secondaryScroll: true 707 URxvt.secondaryScroll: true
703 708
704As the documentation says: plain is the preferred scrollbar for the 709As the documentation says: plain is the preferred scrollbar for the
705author. The C<secondaryScroll> confgiures urxvt to scroll in full-screen 710author. The C<secondaryScroll> configures urxvt to scroll in full-screen
706apps, like screen, so lines scorlled out of screen end up in urxvt's 711apps, like screen, so lines scrolled out of screen end up in urxvt's
707scrollback buffer. 712scrollback buffer.
708 713
709 URxvt.background: #000000 714 URxvt.background: #000000
710 URxvt.foreground: gray90 715 URxvt.foreground: gray90
711 URxvt.color7: gray90 716 URxvt.color7: gray90
… …
762 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15 767 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
763 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 768 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
764 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 769 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
765 770
766I wrote rxvt-unicode to be able to specify fonts exactly. So don't be 771I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
767overwhelmed. A special note: the C<9x15bold> mentioend above is actually 772overwhelmed. A special note: the C<9x15bold> mentioned above is actually
768the version from XFree-3.3, as XFree-4 replaced it by a totally different 773the version from XFree-3.3, as XFree-4 replaced it by a totally different
769font (different glyphs for C<;> and many other harmless characters), 774font (different glyphs for C<;> and many other harmless characters),
770while the second font is actually the C<9x15bold> from XFree4/XOrg. The 775while the second font is actually the C<9x15bold> from XFree4/XOrg. The
771bold version has less chars than the medium version, so I use it for rare 776bold version has less chars than the medium version, so I use it for rare
772characters, too. Whene ditign sources with vim, I use italic for comments 777characters, too. When editing sources with vim, I use italic for comments
773and other stuff, which looks quite good with Bitstream Vera anti-aliased. 778and other stuff, which looks quite good with Bitstream Vera anti-aliased.
774 779
775Terminus is a quite bad font (many very wrong glyphs), but for most of my 780Terminus is a quite bad font (many very wrong glyphs), but for most of my
776purposes, it works, and gives a different look, as my normal (Non-bold) 781purposes, it works, and gives a different look, as my normal (Non-bold)
777font is already bold, and I want to see a difference between bold and 782font is already bold, and I want to see a difference between bold and
… …
828Also consider the form resources have to use: 833Also consider the form resources have to use:
829 834
830 URxvt.resource: value 835 URxvt.resource: value
831 836
832If you want to use another form (there are lots of different ways of 837If you want to use another form (there are lots of different ways of
833specifying resources), make sure you understand wether and why it 838specifying resources), make sure you understand whether and why it
834works. If unsure, use the form above. 839works. If unsure, use the form above.
835 840
836=head3 When I log-in to another system it tells me about missing terminfo data? 841=head3 When I log-in to another system it tells me about missing terminfo data?
837 842
838The terminal description used by rxvt-unicode is not as widely available 843The terminal description used by rxvt-unicode is not as widely available
839as that for xterm, or even rxvt (for which the same problem often arises). 844as that for xterm, or even rxvt (for which the same problem often arises).
840 845
841The correct solution for this problem is to install the terminfo, this can 846The correct solution for this problem is to install the terminfo, this can
842be done like this (with ncurses' infocmp): 847be done like this (with ncurses' infocmp and works as user and admin):
843 848
844 REMOTE=remotesystem.domain 849 REMOTE=remotesystem.domain
845 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" 850 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
846 851
847... or by installing rxvt-unicode normally on the remote system, 852... or by installing rxvt-unicode normally on the remote system,
853
854One some systems you might need to set C<$TERMINFO> to the full path of
855F<$HOME/.terminfo> for this to work.
848 856
849If you cannot or do not want to do this, then you can simply set 857If you cannot or do not want to do this, then you can simply set
850C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of 858C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
851problems arising, which includes wrong keymapping, less and different 859problems arising, which includes wrong keymapping, less and different
852colours and some refresh errors in fullscreen applications. It's a nice 860colours and some refresh errors in fullscreen applications. It's a nice
… …
875One reason you might want this is that some distributions or operating 883One reason you might want this is that some distributions or operating
876systems still compile some programs using the long-obsoleted termcap 884systems still compile some programs using the long-obsoleted termcap
877library (Fedora Core's bash is one example) and rely on a termcap entry 885library (Fedora Core's bash is one example) and rely on a termcap entry
878for C<rxvt-unicode>. 886for C<rxvt-unicode>.
879 887
880You could use rxvt's termcap entry with resonable results in many cases. 888You could use rxvt's termcap entry with reasonable results in many cases.
881You can also create a termcap entry by using terminfo's infocmp program 889You can also create a termcap entry by using terminfo's infocmp program
882like this: 890like this:
883 891
884 infocmp -C rxvt-unicode 892 infocmp -C rxvt-unicode
885 893
… …
907 :vs=\E[?25h: 915 :vs=\E[?25h:
908 916
909=head3 Why does C<ls> no longer have coloured output? 917=head3 Why does C<ls> no longer have coloured output?
910 918
911The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 919The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
912decide wether a terminal has colour, but uses it's own configuration 920decide whether a terminal has colour, but uses its own configuration
913file. Needless to say, C<rxvt-unicode> is not in it's default file (among 921file. Needless to say, C<rxvt-unicode> is not in its default file (among
914with most other terminals supporting colour). Either add: 922with most other terminals supporting colour). Either add:
915 923
916 TERM rxvt-unicode 924 TERM rxvt-unicode
917 925
918to C</etc/DIR_COLORS> or simply add: 926to C</etc/DIR_COLORS> or simply add:
… …
952If you encounter strange problems like typing an accented character but 960If you encounter strange problems like typing an accented character but
953getting two unrelated other characters or similar, or if program output is 961getting two unrelated other characters or similar, or if program output is
954subtly garbled, then you should check your locale settings. 962subtly garbled, then you should check your locale settings.
955 963
956Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 964Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
957programs. Often rxvt-unicode is started in the C<C> locale, while the 965programs running in it. Often rxvt-unicode is started in the C<C> locale,
958login script running within the rxvt-unicode window changes the locale to 966while the login script running within the rxvt-unicode window changes the
959something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work. 967locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
968not going to work, and is the most common cause for problems.
960 969
961The best thing is to fix your startup environment, as you will likely run 970The best thing is to fix your startup environment, as you will likely run
962into other problems. If nothing works you can try this in your .profile. 971into other problems. If nothing works you can try this in your .profile.
963 972
964 printf '\e]701;%s\007' "$LC_CTYPE" 973 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
965 974
966If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 975If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
967supported on your systems. Some systems have a C<locale> command which 976supported on your systems. Some systems have a C<locale> command which
968displays this (also, C<perl -e0> can be used to check locale settings, as 977displays this (also, C<perl -e0> can be used to check locale settings, as
969it will complain loudly if it cannot set the locale). If it displays something 978it will complain loudly if it cannot set the locale). If it displays something
… …
990The reasons is that there exists a perfectly fine mechanism for selecting 999The reasons is that there exists a perfectly fine mechanism for selecting
991the encoding, doing I/O and (most important) communicating this to all 1000the encoding, doing I/O and (most important) communicating this to all
992applications so everybody agrees on character properties such as width 1001applications so everybody agrees on character properties such as width
993and code number. This mechanism is the I<locale>. Applications not using 1002and code number. This mechanism is the I<locale>. Applications not using
994that info will have problems (for example, C<xterm> gets the width of 1003that info will have problems (for example, C<xterm> gets the width of
995characters wrong as it uses it's own, locale-independent table under all 1004characters wrong as it uses its own, locale-independent table under all
996locales). 1005locales).
997 1006
998Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All 1007Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
999programs doing the same (that is, most) will automatically agree in the 1008programs doing the same (that is, most) will automatically agree in the
1000interpretation of characters. 1009interpretation of characters.
… …
1019=head3 Can I switch locales at runtime? 1028=head3 Can I switch locales at runtime?
1020 1029
1021Yes, using an escape sequence. Try something like this, which sets 1030Yes, using an escape sequence. Try something like this, which sets
1022rxvt-unicode's idea of C<LC_CTYPE>. 1031rxvt-unicode's idea of C<LC_CTYPE>.
1023 1032
1024 printf '\e]701;%s\007' ja_JP.SJIS 1033 printf '\33]701;%s\007' ja_JP.SJIS
1025 1034
1026See also the previous answer. 1035See also the previous answer.
1027 1036
1028Sometimes this capability is rather handy when you want to work in 1037Sometimes this capability is rather handy when you want to work in
1029one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it 1038one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
1030(e.g. UTF-8). For example, I use this script to start C<xjdic>, which 1039(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
1031first switches to a locale supported by xjdic and back later: 1040first switches to a locale supported by xjdic and back later:
1032 1041
1033 printf '\e]701;%s\007' ja_JP.SJIS 1042 printf '\33]701;%s\007' ja_JP.SJIS
1034 xjdic -js 1043 xjdic -js
1035 printf '\e]701;%s\007' de_DE.UTF-8 1044 printf '\33]701;%s\007' de_DE.UTF-8
1036 1045
1037You can also use xterm's C<luit> program, which usually works fine, except 1046You can also use xterm's C<luit> program, which usually works fine, except
1038for some locales where character width differs between program- and 1047for some locales where character width differs between program- and
1039rxvt-unicode-locales. 1048rxvt-unicode-locales.
1040 1049
… …
1058=item - Make sure your XIM server is actually running. 1067=item - Make sure your XIM server is actually running.
1059 1068
1060=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode. 1069=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1061 1070
1062When you want to use e.g. B<kinput2>, it must be set to 1071When you want to use e.g. B<kinput2>, it must be set to
1063C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. Youc an see what input 1072C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1064method servers are running with this command: 1073method servers are running with this command:
1065 1074
1066 xprop -root XIM_SERVERS 1075 xprop -root XIM_SERVERS
1067 1076
1068=item 1077=item
1069 1078
1070=back 1079=back
1071 1080
1072=head3 My input method wants <some encoding> but I want UTF-8, what can I do? 1081=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
1073 1082
… …
1113 1122
1114=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation? 1123=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
1115 1124
1116You should build one binary with the default options. F<configure> 1125You should build one binary with the default options. F<configure>
1117now enables most useful options, and the trend goes to making them 1126now enables most useful options, and the trend goes to making them
1118runtime-switchable, too, so there is usually no drawback to enbaling them, 1127runtime-switchable, too, so there is usually no drawback to enabling them,
1119except higher disk and possibly memory usage. The perl interpreter should 1128except higher disk and possibly memory usage. The perl interpreter should
1120be enabled, as important functionality (menus, selection, likely more in 1129be enabled, as important functionality (menus, selection, likely more in
1121the future) depends on it. 1130the future) depends on it.
1122 1131
1123You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 1132You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
… …
1146This forking is done as the very first within main(), which is very early 1155This forking is done as the very first within main(), which is very early
1147and reduces possible bugs to initialisation code run before main(), or 1156and reduces possible bugs to initialisation code run before main(), or
1148things like the dynamic loader of your system, which should result in very 1157things like the dynamic loader of your system, which should result in very
1149little risk. 1158little risk.
1150 1159
1151=head3 On Solaris 9, many line-drawing characters are too wide.
1152
1153Seems to be a known bug, read
1154L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
1155following ugly workaround to get non-double-wide-characters working:
1156
1157 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
1158
1159=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all. 1160=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
1160 1161
1161Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1162Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1162in your compile environment, or an implementation that implements it, 1163in your compile environment, or an implementation that implements it,
1163wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1164whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
1164B<wchar_t> is represented as unicode. 1165B<wchar_t> is represented as unicode.
1165 1166
1166As you might have guessed, FreeBSD does neither define this symobl nor 1167As you might have guessed, FreeBSD does neither define this symbol nor
1167does it support it. Instead, it uses it's own internal representation of 1168does it support it. Instead, it uses its own internal representation of
1168B<wchar_t>. This is, of course, completely fine with respect to standards. 1169B<wchar_t>. This is, of course, completely fine with respect to standards.
1169 1170
1170However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and 1171However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
1171C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>. 1172C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
1172 1173
… …
1186 1187
1187The rxvt-unicode author insists that the right way to fix this is in the 1188The rxvt-unicode author insists that the right way to fix this is in the
1188system libraries once and for all, instead of forcing every app to carry 1189system libraries once and for all, instead of forcing every app to carry
1189complete replacements for them :) 1190complete replacements for them :)
1190 1191
1191=head3 I use Solaris 9 and it doesn't compile/work/etc.
1192
1193Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
1194problems with C<wcwidth> and a compile problem.
1195
1196=head3 How can I use rxvt-unicode under cygwin? 1192=head3 How can I use rxvt-unicode under cygwin?
1197 1193
1198rxvt-unicode should compile and run out of the box on cygwin, using 1194rxvt-unicode should compile and run out of the box on cygwin, using
1199the X11 libraries that come with cygwin. libW11 emulation is no 1195the X11 libraries that come with cygwin. libW11 emulation is no
1200longer supported (and makes no sense, either, as it only supported a 1196longer supported (and makes no sense, either, as it only supported a
… …
1203old libW11 emulation. 1199old libW11 emulation.
1204 1200
1205At the time of this writing, cygwin didn't seem to support any multi-byte 1201At the time of this writing, cygwin didn't seem to support any multi-byte
1206encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited 1202encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1207to 8-bit encodings. 1203to 8-bit encodings.
1204
1205=head3 Character widths are not correct.
1206
1207urxvt uses the system wcwidth function to know the information about
1208the width of characters, so on systems with incorrect locale data you
1209will likely get bad results. Two notorious examples are Solaris 9,
1210where single-width characters like U+2514 are reported as double-width,
1211and Darwin 8, where combining chars are reported having width 1.
1212
1213The solution is to upgrade your system or switch to a better one. A
1214possibly working workaround is to use a wcwidth implementation like
1215
1216http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1208 1217
1209=head1 RXVT-UNICODE TECHNICAL REFERENCE 1218=head1 RXVT-UNICODE TECHNICAL REFERENCE
1210 1219
1211The rest of this document describes various technical aspects of 1220The rest of this document describes various technical aspects of
1212B<rxvt-unicode>. First the description of supported command sequences, 1221B<rxvt-unicode>. First the description of supported command sequences,
… …
1706 1715
1707Toggle DEC Private Mode Values (rxvt extension). I<where> 1716Toggle DEC Private Mode Values (rxvt extension). I<where>
1708 1717
1709=over 4 1718=over 4
1710 1719
1711=item B<< C<Ps = 1> >> (DECCKM) 1720=item B<< C<Pm = 1> >> (DECCKM)
1712 1721
1713=begin table 1722=begin table
1714 1723
1715 B<< C<h> >> Application Cursor Keys 1724 B<< C<h> >> Application Cursor Keys
1716 B<< C<l> >> Normal Cursor Keys 1725 B<< C<l> >> Normal Cursor Keys
1717 1726
1718=end table 1727=end table
1719 1728
1720=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1729=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1721 1730
1722=begin table 1731=begin table
1723 1732
1724 B<< C<h> >> Enter VT52 mode 1733 B<< C<h> >> Enter VT52 mode
1725 B<< C<l> >> Enter VT52 mode 1734 B<< C<l> >> Enter VT52 mode
1726 1735
1727=end table 1736=end table
1728 1737
1729=item B<< C<Ps = 3> >> 1738=item B<< C<Pm = 3> >>
1730 1739
1731=begin table 1740=begin table
1732 1741
1733 B<< C<h> >> 132 Column Mode (DECCOLM) 1742 B<< C<h> >> 132 Column Mode (DECCOLM)
1734 B<< C<l> >> 80 Column Mode (DECCOLM) 1743 B<< C<l> >> 80 Column Mode (DECCOLM)
1735 1744
1736=end table 1745=end table
1737 1746
1738=item B<< C<Ps = 4> >> 1747=item B<< C<Pm = 4> >>
1739 1748
1740=begin table 1749=begin table
1741 1750
1742 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1751 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1743 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1752 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1744 1753
1745=end table 1754=end table
1746 1755
1747=item B<< C<Ps = 5> >> 1756=item B<< C<Pm = 5> >>
1748 1757
1749=begin table 1758=begin table
1750 1759
1751 B<< C<h> >> Reverse Video (DECSCNM) 1760 B<< C<h> >> Reverse Video (DECSCNM)
1752 B<< C<l> >> Normal Video (DECSCNM) 1761 B<< C<l> >> Normal Video (DECSCNM)
1753 1762
1754=end table 1763=end table
1755 1764
1756=item B<< C<Ps = 6> >> 1765=item B<< C<Pm = 6> >>
1757 1766
1758=begin table 1767=begin table
1759 1768
1760 B<< C<h> >> Origin Mode (DECOM) 1769 B<< C<h> >> Origin Mode (DECOM)
1761 B<< C<l> >> Normal Cursor Mode (DECOM) 1770 B<< C<l> >> Normal Cursor Mode (DECOM)
1762 1771
1763=end table 1772=end table
1764 1773
1765=item B<< C<Ps = 7> >> 1774=item B<< C<Pm = 7> >>
1766 1775
1767=begin table 1776=begin table
1768 1777
1769 B<< C<h> >> Wraparound Mode (DECAWM) 1778 B<< C<h> >> Wraparound Mode (DECAWM)
1770 B<< C<l> >> No Wraparound Mode (DECAWM) 1779 B<< C<l> >> No Wraparound Mode (DECAWM)
1771 1780
1772=end table 1781=end table
1773 1782
1774=item B<< C<Ps = 8> >> I<unimplemented> 1783=item B<< C<Pm = 8> >> I<unimplemented>
1775 1784
1776=begin table 1785=begin table
1777 1786
1778 B<< C<h> >> Auto-repeat Keys (DECARM) 1787 B<< C<h> >> Auto-repeat Keys (DECARM)
1779 B<< C<l> >> No Auto-repeat Keys (DECARM) 1788 B<< C<l> >> No Auto-repeat Keys (DECARM)
1780 1789
1781=end table 1790=end table
1782 1791
1783=item B<< C<Ps = 9> >> X10 XTerm 1792=item B<< C<Pm = 9> >> X10 XTerm
1784 1793
1785=begin table 1794=begin table
1786 1795
1787 B<< C<h> >> Send Mouse X & Y on button press. 1796 B<< C<h> >> Send Mouse X & Y on button press.
1788 B<< C<l> >> No mouse reporting. 1797 B<< C<l> >> No mouse reporting.
1789 1798
1790=end table 1799=end table
1791 1800
1792=item B<< C<Ps = 25> >> 1801=item B<< C<Pm = 25> >>
1793 1802
1794=begin table 1803=begin table
1795 1804
1796 B<< C<h> >> Visible cursor {cnorm/cvvis} 1805 B<< C<h> >> Visible cursor {cnorm/cvvis}
1797 B<< C<l> >> Invisible cursor {civis} 1806 B<< C<l> >> Invisible cursor {civis}
1798 1807
1799=end table 1808=end table
1800 1809
1801=item B<< C<Ps = 30> >> 1810=item B<< C<Pm = 30> >>
1802 1811
1803=begin table 1812=begin table
1804 1813
1805 B<< C<h> >> scrollBar visisble 1814 B<< C<h> >> scrollBar visisble
1806 B<< C<l> >> scrollBar invisisble 1815 B<< C<l> >> scrollBar invisisble
1807 1816
1808=end table 1817=end table
1809 1818
1810=item B<< C<Ps = 35> >> (B<rxvt>) 1819=item B<< C<Pm = 35> >> (B<rxvt>)
1811 1820
1812=begin table 1821=begin table
1813 1822
1814 B<< C<h> >> Allow XTerm Shift+key sequences 1823 B<< C<h> >> Allow XTerm Shift+key sequences
1815 B<< C<l> >> Disallow XTerm Shift+key sequences 1824 B<< C<l> >> Disallow XTerm Shift+key sequences
1816 1825
1817=end table 1826=end table
1818 1827
1819=item B<< C<Ps = 38> >> I<unimplemented> 1828=item B<< C<Pm = 38> >> I<unimplemented>
1820 1829
1821Enter Tektronix Mode (DECTEK) 1830Enter Tektronix Mode (DECTEK)
1822 1831
1823=item B<< C<Ps = 40> >> 1832=item B<< C<Pm = 40> >>
1824 1833
1825=begin table 1834=begin table
1826 1835
1827 B<< C<h> >> Allow 80/132 Mode 1836 B<< C<h> >> Allow 80/132 Mode
1828 B<< C<l> >> Disallow 80/132 Mode 1837 B<< C<l> >> Disallow 80/132 Mode
1829 1838
1830=end table 1839=end table
1831 1840
1832=item B<< C<Ps = 44> >> I<unimplemented> 1841=item B<< C<Pm = 44> >> I<unimplemented>
1833 1842
1834=begin table 1843=begin table
1835 1844
1836 B<< C<h> >> Turn On Margin Bell 1845 B<< C<h> >> Turn On Margin Bell
1837 B<< C<l> >> Turn Off Margin Bell 1846 B<< C<l> >> Turn Off Margin Bell
1838 1847
1839=end table 1848=end table
1840 1849
1841=item B<< C<Ps = 45> >> I<unimplemented> 1850=item B<< C<Pm = 45> >> I<unimplemented>
1842 1851
1843=begin table 1852=begin table
1844 1853
1845 B<< C<h> >> Reverse-wraparound Mode 1854 B<< C<h> >> Reverse-wraparound Mode
1846 B<< C<l> >> No Reverse-wraparound Mode 1855 B<< C<l> >> No Reverse-wraparound Mode
1847 1856
1848=end table 1857=end table
1849 1858
1850=item B<< C<Ps = 46> >> I<unimplemented> 1859=item B<< C<Pm = 46> >> I<unimplemented>
1851 1860
1852=item B<< C<Ps = 47> >> 1861=item B<< C<Pm = 47> >>
1853 1862
1854=begin table 1863=begin table
1855 1864
1856 B<< C<h> >> Use Alternate Screen Buffer 1865 B<< C<h> >> Use Alternate Screen Buffer
1857 B<< C<l> >> Use Normal Screen Buffer 1866 B<< C<l> >> Use Normal Screen Buffer
1858 1867
1859=end table 1868=end table
1860 1869
1861X<Priv66> 1870X<Priv66>
1862 1871
1863=item B<< C<Ps = 66> >> 1872=item B<< C<Pm = 66> >>
1864 1873
1865=begin table 1874=begin table
1866 1875
1867 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1876 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1868 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1877 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1869 1878
1870=end table 1879=end table
1871 1880
1872=item B<< C<Ps = 67> >> 1881=item B<< C<Pm = 67> >>
1873 1882
1874=begin table 1883=begin table
1875 1884
1876 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1885 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1877 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1886 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1878 1887
1879=end table 1888=end table
1880 1889
1881=item B<< C<Ps = 1000> >> (X11 XTerm) 1890=item B<< C<Pm = 1000> >> (X11 XTerm)
1882 1891
1883=begin table 1892=begin table
1884 1893
1885 B<< C<h> >> Send Mouse X & Y on button press and release. 1894 B<< C<h> >> Send Mouse X & Y on button press and release.
1886 B<< C<l> >> No mouse reporting. 1895 B<< C<l> >> No mouse reporting.
1887 1896
1888=end table 1897=end table
1889 1898
1890=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1899=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1891 1900
1892=begin table 1901=begin table
1893 1902
1894 B<< C<h> >> Use Hilite Mouse Tracking. 1903 B<< C<h> >> Use Hilite Mouse Tracking.
1895 B<< C<l> >> No mouse reporting. 1904 B<< C<l> >> No mouse reporting.
1896 1905
1897=end table 1906=end table
1898 1907
1908=item B<< C<Pm = 1002> >> (X11 XTerm)
1909
1910=begin table
1911
1912 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1913 B<< C<l> >> No mouse reporting.
1914
1915=end table
1916
1917=item B<< C<Pm = 1003> >> (X11 XTerm)
1918
1919=begin table
1920
1921 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1922 B<< C<l> >> No mouse reporting.
1923
1924=end table
1925
1899=item B<< C<Ps = 1010> >> (B<rxvt>) 1926=item B<< C<Pm = 1010> >> (B<rxvt>)
1900 1927
1901=begin table 1928=begin table
1902 1929
1903 B<< C<h> >> Don't scroll to bottom on TTY output 1930 B<< C<h> >> Don't scroll to bottom on TTY output
1904 B<< C<l> >> Scroll to bottom on TTY output 1931 B<< C<l> >> Scroll to bottom on TTY output
1905 1932
1906=end table 1933=end table
1907 1934
1908=item B<< C<Ps = 1011> >> (B<rxvt>) 1935=item B<< C<Pm = 1011> >> (B<rxvt>)
1909 1936
1910=begin table 1937=begin table
1911 1938
1912 B<< C<h> >> Scroll to bottom when a key is pressed 1939 B<< C<h> >> Scroll to bottom when a key is pressed
1913 B<< C<l> >> Don't scroll to bottom when a key is pressed 1940 B<< C<l> >> Don't scroll to bottom when a key is pressed
1914 1941
1915=end table 1942=end table
1916 1943
1917=item B<< C<Ps = 1021> >> (B<rxvt>) 1944=item B<< C<Pm = 1021> >> (B<rxvt>)
1918 1945
1919=begin table 1946=begin table
1920 1947
1921 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>) 1948 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1922 B<< C<l> >> Font styles have no effect on intensity (Compile styles) 1949 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1923 1950
1924=end table 1951=end table
1925 1952
1926=item B<< C<Ps = 1047> >> 1953=item B<< C<Pm = 1047> >>
1927 1954
1928=begin table 1955=begin table
1929 1956
1930 B<< C<h> >> Use Alternate Screen Buffer 1957 B<< C<h> >> Use Alternate Screen Buffer
1931 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1958 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1932 1959
1933=end table 1960=end table
1934 1961
1935=item B<< C<Ps = 1048> >> 1962=item B<< C<Pm = 1048> >>
1936 1963
1937=begin table 1964=begin table
1938 1965
1939 B<< C<h> >> Save cursor position 1966 B<< C<h> >> Save cursor position
1940 B<< C<l> >> Restore cursor position 1967 B<< C<l> >> Restore cursor position
1941 1968
1942=end table 1969=end table
1943 1970
1944=item B<< C<Ps = 1049> >> 1971=item B<< C<Pm = 1049> >>
1945 1972
1946=begin table 1973=begin table
1947 1974
1948 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it 1975 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1949 B<< C<l> >> Use Normal Screen Buffer 1976 B<< C<l> >> Use Normal Screen Buffer
… …
1978 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 2005 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1979 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 2006 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1980 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 2007 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1981 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706] 2008 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1982 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707] 2009 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1983 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM). 2010 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
1984 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 2011 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1985 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 2012 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1986 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 2013 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1987 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> >> 2014 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> >>
1988 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 2015 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
… …
2002 2029
2003=end table 2030=end table
2004 2031
2005=back 2032=back
2006 2033
2007=head1 XPM 2034=head1 BACKGROUND IMAGE
2008 2035
2009For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2036For the BACGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
2010of B<< C<Pt> >> can be the name of the background pixmap followed by a 2037of B<< C<Pt> >> can be the name of the background image file followed by a
2011sequence of scaling/positioning commands separated by semi-colons. The 2038sequence of scaling/positioning commands separated by semi-colons. The
2012scaling/positioning commands are as follows: 2039scaling/positioning commands are as follows:
2013 2040
2014=over 4 2041=over 4
2015 2042
… …
2053 2080
2054For example: 2081For example:
2055 2082
2056=over 4 2083=over 4
2057 2084
2058=item B<\E]20;funky\a> 2085=item B<\E]20;funky.jpg\a>
2059 2086
2060load B<funky.xpm> as a tiled image 2087load B<funky.jpg> as a tiled image
2061 2088
2062=item B<\E]20;mona;100\a> 2089=item B<\E]20;mona.jpg;100\a>
2063 2090
2064load B<mona.xpm> with a scaling of 100% 2091load B<mona.jpg> with a scaling of 100%
2065 2092
2066=item B<\E]20;;200;?\a> 2093=item B<\E]20;;200;?\a>
2067 2094
2068rescale the current pixmap to 200% and display the image geometry in 2095rescale the current pixmap to 200% and display the image geometry in
2069the title 2096the title
… …
2196 2223
2197=head1 CONFIGURE OPTIONS 2224=head1 CONFIGURE OPTIONS
2198 2225
2199General hint: if you get compile errors, then likely your configuration 2226General hint: if you get compile errors, then likely your configuration
2200hasn't been tested well. Either try with C<--enable-everything> or use 2227hasn't been tested well. Either try with C<--enable-everything> or use
2201the F<./reconf> script as a base for experiments. F<./reconf> is used by 2228the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2202myself, so it should generally be a working config. Of course, you should 2229switches). Of course, you should always report when a combination doesn't
2203always report when a combination doesn't work, so it can be fixed. Marc 2230work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2204Lehmann <rxvt@schmorp.de>.
2205 2231
2206All 2232All
2207 2233
2208=over 4 2234=over 4
2209 2235
… …
2241 2267
2242=begin table 2268=begin table
2243 2269
2244 all all available codeset groups 2270 all all available codeset groups
2245 zh common chinese encodings 2271 zh common chinese encodings
2246 zh_ext rarely used but very big chinese encodigs 2272 zh_ext rarely used but very big chinese encodings
2247 jp common japanese encodings 2273 jp common japanese encodings
2248 jp_ext rarely used but big japanese encodings 2274 jp_ext rarely used but big japanese encodings
2249 kr korean encodings 2275 kr korean encodings
2250 2276
2251=end table 2277=end table
… …
2265requirements per character from 2 to 4 bytes. X11 fonts do not yet 2291requirements per character from 2 to 4 bytes. X11 fonts do not yet
2266support these extra characters, but Xft does. 2292support these extra characters, but Xft does.
2267 2293
2268Please note that rxvt-unicode can store unicode code points >65535 2294Please note that rxvt-unicode can store unicode code points >65535
2269even without this flag, but the number of such characters is 2295even without this flag, but the number of such characters is
2270limited to a view thousand (shared with combining characters, 2296limited to a few thousand (shared with combining characters,
2271see next switch), and right now rxvt-unicode cannot display them 2297see next switch), and right now rxvt-unicode cannot display them
2272(input/output and cut&paste still work, though). 2298(input/output and cut&paste still work, though).
2273 2299
2274=item --enable-combining (default: on) 2300=item --enable-combining (default: on)
2275 2301
… …
2298=item --with-res-name=NAME (default: urxvt) 2324=item --with-res-name=NAME (default: urxvt)
2299 2325
2300Use the given name as default application name when 2326Use the given name as default application name when
2301reading resources. Specify --with-res-name=rxvt to replace rxvt. 2327reading resources. Specify --with-res-name=rxvt to replace rxvt.
2302 2328
2303=item --with-res-class=CLASS /default: URxvt) 2329=item --with-res-class=CLASS (default: URxvt)
2304 2330
2305Use the given class as default application class 2331Use the given class as default application class
2306when reading resources. Specify --with-res-class=Rxvt to replace 2332when reading resources. Specify --with-res-class=Rxvt to replace
2307rxvt. 2333rxvt.
2308 2334
… …
2321 2347
2322Write user and tty to lastlog file (used by programs like 2348Write user and tty to lastlog file (used by programs like
2323F<lastlogin>) at start of rxvt execution. This option requires 2349F<lastlogin>) at start of rxvt execution. This option requires
2324--enable-utmp to also be specified. 2350--enable-utmp to also be specified.
2325 2351
2326=item --enable-xpm-background (default: on) 2352=item --enable-afterimage (default: on)
2327 2353
2328Add support for XPM background pixmaps. 2354Add support for libAfterImage to be used for transparency and background
2355images. It adds support for many file formats including JPG, PNG,
2356SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2357(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2358
2359This option also adds such eye candy as blending an image over the root
2360background, as well as dynamic scaling and bluring of background images.
2361
2362Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2363increase by a few megabytes even if no extra features are used (mostly due
2364to third-party libraries used by libAI). Memory footprint may somewhat be
2365lowered if libAfterImage is configured without support for SVG.
2329 2366
2330=item --enable-transparency (default: on) 2367=item --enable-transparency (default: on)
2331 2368
2332Add support for inheriting parent backgrounds thus giving a fake 2369Add support for backgrounds, creating illusion of transparency in the term.
2333transparency to the term.
2334 2370
2335=item --enable-fading (default: on) 2371=item --enable-fading (default: on)
2336 2372
2337Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2373Add support for fading the text when focus is lost.
2338
2339=item --enable-tinting (default: on)
2340
2341Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2342 2374
2343=item --enable-rxvt-scroll (default: on) 2375=item --enable-rxvt-scroll (default: on)
2344 2376
2345Add support for the original rxvt scrollbar. 2377Add support for the original rxvt scrollbar.
2346 2378
… …
2389A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2421A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2390in combination with other switches) is: 2422in combination with other switches) is:
2391 2423
2392 MWM-hints 2424 MWM-hints
2393 EWMH-hints (pid, utf8 names) and protocols (ping) 2425 EWMH-hints (pid, utf8 names) and protocols (ping)
2426 urgency hint
2394 seperate underline colour (-underlineColor) 2427 seperate underline colour (-underlineColor)
2395 settable border widths and borderless switch (-w, -b, -bl) 2428 settable border widths and borderless switch (-w, -b, -bl)
2396 visual depth selection (-depth) 2429 visual depth selection (-depth)
2397 settable extra linespacing /-lsp) 2430 settable extra linespacing /-lsp)
2398 iso-14755-2 and -3, and visual feedback 2431 iso-14755 5.1 (basic) support
2399 tripleclickwords (-tcw) 2432 tripleclickwords (-tcw)
2400 settable insecure mode (-insecure) 2433 settable insecure mode (-insecure)
2401 keysym remapping support 2434 keysym remapping support
2402 cursor blinking and underline cursor (-cb, -uc) 2435 cursor blinking and underline cursor (-cb, -uc)
2403 XEmbed support (-embed) 2436 XEmbed support (-embed)
2404 user-pty (-pty-fd) 2437 user-pty (-pty-fd)
2405 hold on exit (-hold) 2438 hold on exit (-hold)
2439 compile in built-in block graphics
2406 skip builtin block graphics (-sbg) 2440 skip builtin block graphics (-sbg)
2441 separate highlightcolor support (-hc)
2407 2442
2408It also enabled some non-essential features otherwise disabled, such as: 2443It also enables some non-essential features otherwise disabled, such as:
2409 2444
2410 some round-trip time optimisations 2445 some round-trip time optimisations
2411 nearest color allocation on pseudocolor screens 2446 nearest color allocation on pseudocolor screens
2412 UTF8_STRING supporr for selection 2447 UTF8_STRING support for selection
2413 sgr modes 90..97 and 100..107 2448 sgr modes 90..97 and 100..107
2414 backindex and forwardindex escape sequences 2449 backindex and forwardindex escape sequences
2415 view change/zero scorllback esacpe sequences 2450 view change/zero scrollback escape sequences
2416 locale switching escape sequence 2451 locale switching escape sequence
2417 window op and some xterm/OSC escape sequences 2452 window op and some xterm/OSC escape sequences
2418 rectangular selections 2453 rectangular selections
2419 trailing space removal for selections 2454 trailing space removal for selections
2420 verbose X error handling 2455 verbose X error handling
… …
2429=item --enable-keepscrolling (default: on) 2464=item --enable-keepscrolling (default: on)
2430 2465
2431Add support for continual scrolling of the display when you hold 2466Add support for continual scrolling of the display when you hold
2432the mouse button down on a scrollbar arrow. 2467the mouse button down on a scrollbar arrow.
2433 2468
2469=item --enable-selectionscrolling (default: on)
2470
2471Add support for scrolling when the selection moves to the top or
2472bottom of the screen.
2473
2434=item --enable-mousewheel (default: on) 2474=item --enable-mousewheel (default: on)
2435 2475
2436Add support for scrolling via mouse wheel or buttons 4 & 5. 2476Add support for scrolling via mouse wheel or buttons 4 & 5.
2437 2477
2438=item --enable-slipwheeling (default: on) 2478=item --enable-slipwheeling (default: on)
2439 2479
2440Add support for continual scrolling (using the mouse wheel as an 2480Add support for continual scrolling (using the mouse wheel as an
2441accelerator) while the control key is held down. This option 2481accelerator) while the control key is held down. This option
2442requires --enable-mousewheel to also be specified. 2482requires --enable-mousewheel to also be specified.
2443 2483
2444=item --disable-new-selection
2445
2446Remove support for mouse selection style like that of xterm.
2447
2448=item --enable-dmalloc (default: off)
2449
2450Use Gray Watson's malloc - which is good for debugging See
2451L<http://www.letters.com/dmalloc/> for details If you use either this or the
2452next option, you may need to edit src/Makefile after compiling to point
2453DINCLUDE and DLIB to the right places.
2454
2455You can only use either this option and the following (should
2456you use either) .
2457
2458=item --enable-dlmalloc (default: off)
2459
2460Use Doug Lea's malloc - which is good for a production version
2461See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2462
2463=item --enable-smart-resize (default: on) 2484=item --enable-smart-resize (default: off)
2464 2485
2465Add smart growth/shrink behaviour when changing font size via hot 2486Add smart growth/shrink behaviour when resizing.
2466keys. This should keep the window corner which is closest to a corner of 2487This should keep the window corner which is closest to a corner of
2467the screen in a fixed position. 2488the screen in a fixed position.
2468 2489
2469=item --enable-pointer-blank (default: on) 2490=item --enable-pointer-blank (default: on)
2470 2491
2471Add support to have the pointer disappear when typing or inactive. 2492Add support to have the pointer disappear when typing or inactive.
2472 2493
2473=item --enable-perl (default: on) 2494=item --enable-perl (default: on)
2474 2495
2475Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2496Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2476manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files 2497manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the
2477in F<src/perl-ext/> for the extensions that are installed by default. The 2498files in F<src/perl-ext/> for the extensions that are installed by
2478perl interpreter that is used can be specified via the C<PERL> environment 2499default. The perl interpreter that is used can be specified via the
2479variable when running configure. 2500C<PERL> environment variable when running configure. Even when compiled
2501in, perl will I<not> be initialised when all extensions have been disabled
2502C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2503resource standpoint.
2504
2505=item --with-afterimage-config=DIR
2506
2507Look for the libAfterImage config script in DIR.
2480 2508
2481=item --with-name=NAME (default: urxvt) 2509=item --with-name=NAME (default: urxvt)
2482 2510
2483Set the basename for the installed binaries, resulting 2511Set the basename for the installed binaries, resulting
2484in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2512in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
… …
2494PATH. 2522PATH.
2495 2523
2496=item --with-x 2524=item --with-x
2497 2525
2498Use the X Window System (pretty much default, eh?). 2526Use the X Window System (pretty much default, eh?).
2499
2500=item --with-xpm-includes=DIR
2501
2502Look for the XPM includes in DIR.
2503
2504=item --with-xpm-library=DIR
2505
2506Look for the XPM library in DIR.
2507
2508=item --with-xpm
2509
2510Not needed - define via --enable-xpm-background.
2511 2527
2512=back 2528=back
2513 2529
2514=head1 AUTHORS 2530=head1 AUTHORS
2515 2531

Diff Legend

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