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.115 by root, Tue Feb 21 01:01:33 2006 UTC vs.
Revision 1.157 by ayin, Mon Dec 10 19:08:01 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
694directory 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
695develop 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
696write. 700write.
697 701
698The selection stuff mainly makes the selection perl-error-message aware 702The selection stuff mainly makes the selection perl-error-message aware
699and 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
700relevant file and go tot he error line number. 704relevant file and go tot he error line number.
701 705
702 URxvt.scrollstyle: plain 706 URxvt.scrollstyle: plain
703 URxvt.secondaryScroll: true 707 URxvt.secondaryScroll: true
704 708
705As the documentation says: plain is the preferred scrollbar for the 709As the documentation says: plain is the preferred scrollbar for the
706author. The C<secondaryScroll> confgiures urxvt to scroll in full-screen 710author. The C<secondaryScroll> configures urxvt to scroll in full-screen
707apps, 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
708scrollback buffer. 712scrollback buffer.
709 713
710 URxvt.background: #000000 714 URxvt.background: #000000
711 URxvt.foreground: gray90 715 URxvt.foreground: gray90
712 URxvt.color7: gray90 716 URxvt.color7: gray90
763 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
764 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 768 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
765 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 769 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
766 770
767I 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
768overwhelmed. A special note: the C<9x15bold> mentioend above is actually 772overwhelmed. A special note: the C<9x15bold> mentioned above is actually
769the 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
770font (different glyphs for C<;> and many other harmless characters), 774font (different glyphs for C<;> and many other harmless characters),
771while 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
772bold 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
773characters, too. Whene ditign sources with vim, I use italic for comments 777characters, too. When editing sources with vim, I use italic for comments
774and other stuff, which looks quite good with Bitstream Vera anti-aliased. 778and other stuff, which looks quite good with Bitstream Vera anti-aliased.
775 779
776Terminus 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
777purposes, 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)
778font 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
829Also consider the form resources have to use: 833Also consider the form resources have to use:
830 834
831 URxvt.resource: value 835 URxvt.resource: value
832 836
833If 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
834specifying resources), make sure you understand wether and why it 838specifying resources), make sure you understand whether and why it
835works. If unsure, use the form above. 839works. If unsure, use the form above.
836 840
837=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?
838 842
839The terminal description used by rxvt-unicode is not as widely available 843The terminal description used by rxvt-unicode is not as widely available
840as that for xterm, or even rxvt (for which the same problem often arises). 844as that for xterm, or even rxvt (for which the same problem often arises).
841 845
842The 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
843be done like this (with ncurses' infocmp): 847be done like this (with ncurses' infocmp and works as user and admin):
844 848
845 REMOTE=remotesystem.domain 849 REMOTE=remotesystem.domain
846 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"
847 851
848... 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.
849 856
850If 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
851C<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
852problems arising, which includes wrong keymapping, less and different 859problems arising, which includes wrong keymapping, less and different
853colours and some refresh errors in fullscreen applications. It's a nice 860colours and some refresh errors in fullscreen applications. It's a nice
876One reason you might want this is that some distributions or operating 883One reason you might want this is that some distributions or operating
877systems still compile some programs using the long-obsoleted termcap 884systems still compile some programs using the long-obsoleted termcap
878library (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
879for C<rxvt-unicode>. 886for C<rxvt-unicode>.
880 887
881You 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.
882You 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
883like this: 890like this:
884 891
885 infocmp -C rxvt-unicode 892 infocmp -C rxvt-unicode
886 893
908 :vs=\E[?25h: 915 :vs=\E[?25h:
909 916
910=head3 Why does C<ls> no longer have coloured output? 917=head3 Why does C<ls> no longer have coloured output?
911 918
912The 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
913decide wether a terminal has colour, but uses it's own configuration 920decide whether a terminal has colour, but uses its own configuration
914file. 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
915with most other terminals supporting colour). Either add: 922with most other terminals supporting colour). Either add:
916 923
917 TERM rxvt-unicode 924 TERM rxvt-unicode
918 925
919to C</etc/DIR_COLORS> or simply add: 926to C</etc/DIR_COLORS> or simply add:
953If you encounter strange problems like typing an accented character but 960If you encounter strange problems like typing an accented character but
954getting two unrelated other characters or similar, or if program output is 961getting two unrelated other characters or similar, or if program output is
955subtly garbled, then you should check your locale settings. 962subtly garbled, then you should check your locale settings.
956 963
957Rxvt-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
958programs. 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,
959login script running within the rxvt-unicode window changes the locale to 966while the login script running within the rxvt-unicode window changes the
960something 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.
961 969
962The 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
963into 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.
964 972
965 printf '\e]701;%s\007' "$LC_CTYPE" 973 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
966 974
967If 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
968supported on your systems. Some systems have a C<locale> command which 976supported on your systems. Some systems have a C<locale> command which
969displays 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
970it 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
991The reasons is that there exists a perfectly fine mechanism for selecting 999The reasons is that there exists a perfectly fine mechanism for selecting
992the encoding, doing I/O and (most important) communicating this to all 1000the encoding, doing I/O and (most important) communicating this to all
993applications so everybody agrees on character properties such as width 1001applications so everybody agrees on character properties such as width
994and code number. This mechanism is the I<locale>. Applications not using 1002and code number. This mechanism is the I<locale>. Applications not using
995that 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
996characters wrong as it uses it's own, locale-independent table under all 1004characters wrong as it uses its own, locale-independent table under all
997locales). 1005locales).
998 1006
999Rxvt-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
1000programs doing the same (that is, most) will automatically agree in the 1008programs doing the same (that is, most) will automatically agree in the
1001interpretation of characters. 1009interpretation of characters.
1020=head3 Can I switch locales at runtime? 1028=head3 Can I switch locales at runtime?
1021 1029
1022Yes, using an escape sequence. Try something like this, which sets 1030Yes, using an escape sequence. Try something like this, which sets
1023rxvt-unicode's idea of C<LC_CTYPE>. 1031rxvt-unicode's idea of C<LC_CTYPE>.
1024 1032
1025 printf '\e]701;%s\007' ja_JP.SJIS 1033 printf '\33]701;%s\007' ja_JP.SJIS
1026 1034
1027See also the previous answer. 1035See also the previous answer.
1028 1036
1029Sometimes this capability is rather handy when you want to work in 1037Sometimes this capability is rather handy when you want to work in
1030one 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
1031(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
1032first switches to a locale supported by xjdic and back later: 1040first switches to a locale supported by xjdic and back later:
1033 1041
1034 printf '\e]701;%s\007' ja_JP.SJIS 1042 printf '\33]701;%s\007' ja_JP.SJIS
1035 xjdic -js 1043 xjdic -js
1036 printf '\e]701;%s\007' de_DE.UTF-8 1044 printf '\33]701;%s\007' de_DE.UTF-8
1037 1045
1038You 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
1039for some locales where character width differs between program- and 1047for some locales where character width differs between program- and
1040rxvt-unicode-locales. 1048rxvt-unicode-locales.
1041 1049
1059=item - Make sure your XIM server is actually running. 1067=item - Make sure your XIM server is actually running.
1060 1068
1061=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.
1062 1070
1063When 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
1064C<@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
1065method servers are running with this command: 1073method servers are running with this command:
1066 1074
1067 xprop -root XIM_SERVERS 1075 xprop -root XIM_SERVERS
1068 1076
1069=item 1077=item
1070 1078
1071=back 1079=back
1072 1080
1073=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?
1074 1082
1114 1122
1115=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?
1116 1124
1117You should build one binary with the default options. F<configure> 1125You should build one binary with the default options. F<configure>
1118now enables most useful options, and the trend goes to making them 1126now enables most useful options, and the trend goes to making them
1119runtime-switchable, too, so there is usually no drawback to enbaling them, 1127runtime-switchable, too, so there is usually no drawback to enabling them,
1120except higher disk and possibly memory usage. The perl interpreter should 1128except higher disk and possibly memory usage. The perl interpreter should
1121be enabled, as important functionality (menus, selection, likely more in 1129be enabled, as important functionality (menus, selection, likely more in
1122the future) depends on it. 1130the future) depends on it.
1123 1131
1124You 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
1147This 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
1148and reduces possible bugs to initialisation code run before main(), or 1156and reduces possible bugs to initialisation code run before main(), or
1149things 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
1150little risk. 1158little risk.
1151 1159
1152=head3 On Solaris 9, many line-drawing characters are too wide.
1153
1154Seems to be a known bug, read
1155L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
1156following ugly workaround to get non-double-wide-characters working:
1157
1158 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
1159
1160=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.
1161 1161
1162Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1162Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1163in your compile environment, or an implementation that implements it, 1163in your compile environment, or an implementation that implements it,
1164wether 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
1165B<wchar_t> is represented as unicode. 1165B<wchar_t> is represented as unicode.
1166 1166
1167As you might have guessed, FreeBSD does neither define this symobl nor 1167As you might have guessed, FreeBSD does neither define this symbol nor
1168does it support it. Instead, it uses it's own internal representation of 1168does it support it. Instead, it uses its own internal representation of
1169B<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.
1170 1170
1171However, 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
1172C<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>.
1173 1173
1187 1187
1188The 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
1189system 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
1190complete replacements for them :) 1190complete replacements for them :)
1191 1191
1192=head3 I use Solaris 9 and it doesn't compile/work/etc.
1193
1194Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
1195problems with C<wcwidth> and a compile problem.
1196
1197=head3 How can I use rxvt-unicode under cygwin? 1192=head3 How can I use rxvt-unicode under cygwin?
1198 1193
1199rxvt-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
1200the X11 libraries that come with cygwin. libW11 emulation is no 1195the X11 libraries that come with cygwin. libW11 emulation is no
1201longer supported (and makes no sense, either, as it only supported a 1196longer supported (and makes no sense, either, as it only supported a
1204old libW11 emulation. 1199old libW11 emulation.
1205 1200
1206At 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
1207encodings (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
1208to 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
1209 1217
1210=head1 RXVT-UNICODE TECHNICAL REFERENCE 1218=head1 RXVT-UNICODE TECHNICAL REFERENCE
1211 1219
1212The rest of this document describes various technical aspects of 1220The rest of this document describes various technical aspects of
1213B<rxvt-unicode>. First the description of supported command sequences, 1221B<rxvt-unicode>. First the description of supported command sequences,
1707 1715
1708Toggle DEC Private Mode Values (rxvt extension). I<where> 1716Toggle DEC Private Mode Values (rxvt extension). I<where>
1709 1717
1710=over 4 1718=over 4
1711 1719
1712=item B<< C<Ps = 1> >> (DECCKM) 1720=item B<< C<Pm = 1> >> (DECCKM)
1713 1721
1714=begin table 1722=begin table
1715 1723
1716 B<< C<h> >> Application Cursor Keys 1724 B<< C<h> >> Application Cursor Keys
1717 B<< C<l> >> Normal Cursor Keys 1725 B<< C<l> >> Normal Cursor Keys
1718 1726
1719=end table 1727=end table
1720 1728
1721=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1729=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1722 1730
1723=begin table 1731=begin table
1724 1732
1725 B<< C<h> >> Enter VT52 mode 1733 B<< C<h> >> Enter VT52 mode
1726 B<< C<l> >> Enter VT52 mode 1734 B<< C<l> >> Enter VT52 mode
1727 1735
1728=end table 1736=end table
1729 1737
1730=item B<< C<Ps = 3> >> 1738=item B<< C<Pm = 3> >>
1731 1739
1732=begin table 1740=begin table
1733 1741
1734 B<< C<h> >> 132 Column Mode (DECCOLM) 1742 B<< C<h> >> 132 Column Mode (DECCOLM)
1735 B<< C<l> >> 80 Column Mode (DECCOLM) 1743 B<< C<l> >> 80 Column Mode (DECCOLM)
1736 1744
1737=end table 1745=end table
1738 1746
1739=item B<< C<Ps = 4> >> 1747=item B<< C<Pm = 4> >>
1740 1748
1741=begin table 1749=begin table
1742 1750
1743 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1751 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1744 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1752 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1745 1753
1746=end table 1754=end table
1747 1755
1748=item B<< C<Ps = 5> >> 1756=item B<< C<Pm = 5> >>
1749 1757
1750=begin table 1758=begin table
1751 1759
1752 B<< C<h> >> Reverse Video (DECSCNM) 1760 B<< C<h> >> Reverse Video (DECSCNM)
1753 B<< C<l> >> Normal Video (DECSCNM) 1761 B<< C<l> >> Normal Video (DECSCNM)
1754 1762
1755=end table 1763=end table
1756 1764
1757=item B<< C<Ps = 6> >> 1765=item B<< C<Pm = 6> >>
1758 1766
1759=begin table 1767=begin table
1760 1768
1761 B<< C<h> >> Origin Mode (DECOM) 1769 B<< C<h> >> Origin Mode (DECOM)
1762 B<< C<l> >> Normal Cursor Mode (DECOM) 1770 B<< C<l> >> Normal Cursor Mode (DECOM)
1763 1771
1764=end table 1772=end table
1765 1773
1766=item B<< C<Ps = 7> >> 1774=item B<< C<Pm = 7> >>
1767 1775
1768=begin table 1776=begin table
1769 1777
1770 B<< C<h> >> Wraparound Mode (DECAWM) 1778 B<< C<h> >> Wraparound Mode (DECAWM)
1771 B<< C<l> >> No Wraparound Mode (DECAWM) 1779 B<< C<l> >> No Wraparound Mode (DECAWM)
1772 1780
1773=end table 1781=end table
1774 1782
1775=item B<< C<Ps = 8> >> I<unimplemented> 1783=item B<< C<Pm = 8> >> I<unimplemented>
1776 1784
1777=begin table 1785=begin table
1778 1786
1779 B<< C<h> >> Auto-repeat Keys (DECARM) 1787 B<< C<h> >> Auto-repeat Keys (DECARM)
1780 B<< C<l> >> No Auto-repeat Keys (DECARM) 1788 B<< C<l> >> No Auto-repeat Keys (DECARM)
1781 1789
1782=end table 1790=end table
1783 1791
1784=item B<< C<Ps = 9> >> X10 XTerm 1792=item B<< C<Pm = 9> >> X10 XTerm
1785 1793
1786=begin table 1794=begin table
1787 1795
1788 B<< C<h> >> Send Mouse X & Y on button press. 1796 B<< C<h> >> Send Mouse X & Y on button press.
1789 B<< C<l> >> No mouse reporting. 1797 B<< C<l> >> No mouse reporting.
1790 1798
1791=end table 1799=end table
1792 1800
1793=item B<< C<Ps = 25> >> 1801=item B<< C<Pm = 25> >>
1794 1802
1795=begin table 1803=begin table
1796 1804
1797 B<< C<h> >> Visible cursor {cnorm/cvvis} 1805 B<< C<h> >> Visible cursor {cnorm/cvvis}
1798 B<< C<l> >> Invisible cursor {civis} 1806 B<< C<l> >> Invisible cursor {civis}
1799 1807
1800=end table 1808=end table
1801 1809
1802=item B<< C<Ps = 30> >> 1810=item B<< C<Pm = 30> >>
1803 1811
1804=begin table 1812=begin table
1805 1813
1806 B<< C<h> >> scrollBar visisble 1814 B<< C<h> >> scrollBar visisble
1807 B<< C<l> >> scrollBar invisisble 1815 B<< C<l> >> scrollBar invisisble
1808 1816
1809=end table 1817=end table
1810 1818
1811=item B<< C<Ps = 35> >> (B<rxvt>) 1819=item B<< C<Pm = 35> >> (B<rxvt>)
1812 1820
1813=begin table 1821=begin table
1814 1822
1815 B<< C<h> >> Allow XTerm Shift+key sequences 1823 B<< C<h> >> Allow XTerm Shift+key sequences
1816 B<< C<l> >> Disallow XTerm Shift+key sequences 1824 B<< C<l> >> Disallow XTerm Shift+key sequences
1817 1825
1818=end table 1826=end table
1819 1827
1820=item B<< C<Ps = 38> >> I<unimplemented> 1828=item B<< C<Pm = 38> >> I<unimplemented>
1821 1829
1822Enter Tektronix Mode (DECTEK) 1830Enter Tektronix Mode (DECTEK)
1823 1831
1824=item B<< C<Ps = 40> >> 1832=item B<< C<Pm = 40> >>
1825 1833
1826=begin table 1834=begin table
1827 1835
1828 B<< C<h> >> Allow 80/132 Mode 1836 B<< C<h> >> Allow 80/132 Mode
1829 B<< C<l> >> Disallow 80/132 Mode 1837 B<< C<l> >> Disallow 80/132 Mode
1830 1838
1831=end table 1839=end table
1832 1840
1833=item B<< C<Ps = 44> >> I<unimplemented> 1841=item B<< C<Pm = 44> >> I<unimplemented>
1834 1842
1835=begin table 1843=begin table
1836 1844
1837 B<< C<h> >> Turn On Margin Bell 1845 B<< C<h> >> Turn On Margin Bell
1838 B<< C<l> >> Turn Off Margin Bell 1846 B<< C<l> >> Turn Off Margin Bell
1839 1847
1840=end table 1848=end table
1841 1849
1842=item B<< C<Ps = 45> >> I<unimplemented> 1850=item B<< C<Pm = 45> >> I<unimplemented>
1843 1851
1844=begin table 1852=begin table
1845 1853
1846 B<< C<h> >> Reverse-wraparound Mode 1854 B<< C<h> >> Reverse-wraparound Mode
1847 B<< C<l> >> No Reverse-wraparound Mode 1855 B<< C<l> >> No Reverse-wraparound Mode
1848 1856
1849=end table 1857=end table
1850 1858
1851=item B<< C<Ps = 46> >> I<unimplemented> 1859=item B<< C<Pm = 46> >> I<unimplemented>
1852 1860
1853=item B<< C<Ps = 47> >> 1861=item B<< C<Pm = 47> >>
1854 1862
1855=begin table 1863=begin table
1856 1864
1857 B<< C<h> >> Use Alternate Screen Buffer 1865 B<< C<h> >> Use Alternate Screen Buffer
1858 B<< C<l> >> Use Normal Screen Buffer 1866 B<< C<l> >> Use Normal Screen Buffer
1859 1867
1860=end table 1868=end table
1861 1869
1862X<Priv66> 1870X<Priv66>
1863 1871
1864=item B<< C<Ps = 66> >> 1872=item B<< C<Pm = 66> >>
1865 1873
1866=begin table 1874=begin table
1867 1875
1868 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1876 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1869 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1877 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1870 1878
1871=end table 1879=end table
1872 1880
1873=item B<< C<Ps = 67> >> 1881=item B<< C<Pm = 67> >>
1874 1882
1875=begin table 1883=begin table
1876 1884
1877 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1885 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1878 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1886 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1879 1887
1880=end table 1888=end table
1881 1889
1882=item B<< C<Ps = 1000> >> (X11 XTerm) 1890=item B<< C<Pm = 1000> >> (X11 XTerm)
1883 1891
1884=begin table 1892=begin table
1885 1893
1886 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.
1887 B<< C<l> >> No mouse reporting. 1895 B<< C<l> >> No mouse reporting.
1888 1896
1889=end table 1897=end table
1890 1898
1891=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1899=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1892 1900
1893=begin table 1901=begin table
1894 1902
1895 B<< C<h> >> Use Hilite Mouse Tracking. 1903 B<< C<h> >> Use Hilite Mouse Tracking.
1896 B<< C<l> >> No mouse reporting. 1904 B<< C<l> >> No mouse reporting.
1897 1905
1898=end table 1906=end table
1899 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
1900=item B<< C<Ps = 1010> >> (B<rxvt>) 1926=item B<< C<Pm = 1010> >> (B<rxvt>)
1901 1927
1902=begin table 1928=begin table
1903 1929
1904 B<< C<h> >> Don't scroll to bottom on TTY output 1930 B<< C<h> >> Don't scroll to bottom on TTY output
1905 B<< C<l> >> Scroll to bottom on TTY output 1931 B<< C<l> >> Scroll to bottom on TTY output
1906 1932
1907=end table 1933=end table
1908 1934
1909=item B<< C<Ps = 1011> >> (B<rxvt>) 1935=item B<< C<Pm = 1011> >> (B<rxvt>)
1910 1936
1911=begin table 1937=begin table
1912 1938
1913 B<< C<h> >> Scroll to bottom when a key is pressed 1939 B<< C<h> >> Scroll to bottom when a key is pressed
1914 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
1915 1941
1916=end table 1942=end table
1917 1943
1918=item B<< C<Ps = 1021> >> (B<rxvt>) 1944=item B<< C<Pm = 1021> >> (B<rxvt>)
1919 1945
1920=begin table 1946=begin table
1921 1947
1922 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>)
1923 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)
1924 1950
1925=end table 1951=end table
1926 1952
1927=item B<< C<Ps = 1047> >> 1953=item B<< C<Pm = 1047> >>
1928 1954
1929=begin table 1955=begin table
1930 1956
1931 B<< C<h> >> Use Alternate Screen Buffer 1957 B<< C<h> >> Use Alternate Screen Buffer
1932 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
1933 1959
1934=end table 1960=end table
1935 1961
1936=item B<< C<Ps = 1048> >> 1962=item B<< C<Pm = 1048> >>
1937 1963
1938=begin table 1964=begin table
1939 1965
1940 B<< C<h> >> Save cursor position 1966 B<< C<h> >> Save cursor position
1941 B<< C<l> >> Restore cursor position 1967 B<< C<l> >> Restore cursor position
1942 1968
1943=end table 1969=end table
1944 1970
1945=item B<< C<Ps = 1049> >> 1971=item B<< C<Pm = 1049> >>
1946 1972
1947=begin table 1973=begin table
1948 1974
1949 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
1950 B<< C<l> >> Use Normal Screen Buffer 1976 B<< C<l> >> Use Normal Screen Buffer
1979 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> >>
1980 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> >>
1981 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> >>
1982 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]
1983 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]
1984 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).
1985 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> >>.
1986 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>
1987 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> >>.
1988 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> >>
1989 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> >>
2003 2029
2004=end table 2030=end table
2005 2031
2006=back 2032=back
2007 2033
2008=head1 XPM 2034=head1 BACKGROUND IMAGE
2009 2035
2010For 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
2011of 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
2012sequence of scaling/positioning commands separated by semi-colons. The 2038sequence of scaling/positioning commands separated by semi-colons. The
2013scaling/positioning commands are as follows: 2039scaling/positioning commands are as follows:
2014 2040
2015=over 4 2041=over 4
2016 2042
2054 2080
2055For example: 2081For example:
2056 2082
2057=over 4 2083=over 4
2058 2084
2059=item B<\E]20;funky\a> 2085=item B<\E]20;funky.jpg\a>
2060 2086
2061load B<funky.xpm> as a tiled image 2087load B<funky.jpg> as a tiled image
2062 2088
2063=item B<\E]20;mona;100\a> 2089=item B<\E]20;mona.jpg;100\a>
2064 2090
2065load B<mona.xpm> with a scaling of 100% 2091load B<mona.jpg> with a scaling of 100%
2066 2092
2067=item B<\E]20;;200;?\a> 2093=item B<\E]20;;200;?\a>
2068 2094
2069rescale the current pixmap to 200% and display the image geometry in 2095rescale the current pixmap to 200% and display the image geometry in
2070the title 2096the title
2197 2223
2198=head1 CONFIGURE OPTIONS 2224=head1 CONFIGURE OPTIONS
2199 2225
2200General hint: if you get compile errors, then likely your configuration 2226General hint: if you get compile errors, then likely your configuration
2201hasn'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
2202the 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>
2203myself, so it should generally be a working config. Of course, you should 2229switches). Of course, you should always report when a combination doesn't
2204always report when a combination doesn't work, so it can be fixed. Marc 2230work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2205Lehmann <rxvt@schmorp.de>.
2206 2231
2207All 2232All
2208 2233
2209=over 4 2234=over 4
2210 2235
2242 2267
2243=begin table 2268=begin table
2244 2269
2245 all all available codeset groups 2270 all all available codeset groups
2246 zh common chinese encodings 2271 zh common chinese encodings
2247 zh_ext rarely used but very big chinese encodigs 2272 zh_ext rarely used but very big chinese encodings
2248 jp common japanese encodings 2273 jp common japanese encodings
2249 jp_ext rarely used but big japanese encodings 2274 jp_ext rarely used but big japanese encodings
2250 kr korean encodings 2275 kr korean encodings
2251 2276
2252=end table 2277=end table
2266requirements 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
2267support these extra characters, but Xft does. 2292support these extra characters, but Xft does.
2268 2293
2269Please note that rxvt-unicode can store unicode code points >65535 2294Please note that rxvt-unicode can store unicode code points >65535
2270even without this flag, but the number of such characters is 2295even without this flag, but the number of such characters is
2271limited to a view thousand (shared with combining characters, 2296limited to a few thousand (shared with combining characters,
2272see next switch), and right now rxvt-unicode cannot display them 2297see next switch), and right now rxvt-unicode cannot display them
2273(input/output and cut&paste still work, though). 2298(input/output and cut&paste still work, though).
2274 2299
2275=item --enable-combining (default: on) 2300=item --enable-combining (default: on)
2276 2301
2299=item --with-res-name=NAME (default: urxvt) 2324=item --with-res-name=NAME (default: urxvt)
2300 2325
2301Use the given name as default application name when 2326Use the given name as default application name when
2302reading resources. Specify --with-res-name=rxvt to replace rxvt. 2327reading resources. Specify --with-res-name=rxvt to replace rxvt.
2303 2328
2304=item --with-res-class=CLASS /default: URxvt) 2329=item --with-res-class=CLASS (default: URxvt)
2305 2330
2306Use the given class as default application class 2331Use the given class as default application class
2307when reading resources. Specify --with-res-class=Rxvt to replace 2332when reading resources. Specify --with-res-class=Rxvt to replace
2308rxvt. 2333rxvt.
2309 2334
2322 2347
2323Write user and tty to lastlog file (used by programs like 2348Write user and tty to lastlog file (used by programs like
2324F<lastlogin>) at start of rxvt execution. This option requires 2349F<lastlogin>) at start of rxvt execution. This option requires
2325--enable-utmp to also be specified. 2350--enable-utmp to also be specified.
2326 2351
2327=item --enable-xpm-background (default: on) 2352=item --enable-afterimage (default: on)
2328 2353
2329Add 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.
2330 2366
2331=item --enable-transparency (default: on) 2367=item --enable-transparency (default: on)
2332 2368
2333Add support for inheriting parent backgrounds thus giving a fake 2369Add support for backgrounds, creating illusion of transparency in the term.
2334transparency to the term.
2335 2370
2336=item --enable-fading (default: on) 2371=item --enable-fading (default: on)
2337 2372
2338Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2373Add support for fading the text when focus is lost.
2339
2340=item --enable-tinting (default: on)
2341
2342Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2343 2374
2344=item --enable-rxvt-scroll (default: on) 2375=item --enable-rxvt-scroll (default: on)
2345 2376
2346Add support for the original rxvt scrollbar. 2377Add support for the original rxvt scrollbar.
2347 2378
2357 2388
2358Add support for a very unobtrusive, plain-looking scrollbar that 2389Add support for a very unobtrusive, plain-looking scrollbar that
2359is the favourite of the rxvt-unicode author, having used it for 2390is the favourite of the rxvt-unicode author, having used it for
2360many years. 2391many years.
2361 2392
2362=item --enable-ttygid (default: off)
2363
2364Change tty device setting to group "tty" - only use this if
2365your system uses this type of security.
2366
2367=item --disable-backspace-key 2393=item --disable-backspace-key
2368 2394
2369Removes any handling of the backspace key by us - let the X server do it. 2395Removes any handling of the backspace key by us - let the X server do it.
2370 2396
2371=item --disable-delete-key 2397=item --disable-delete-key
2390A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2416A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2391in combination with other switches) is: 2417in combination with other switches) is:
2392 2418
2393 MWM-hints 2419 MWM-hints
2394 EWMH-hints (pid, utf8 names) and protocols (ping) 2420 EWMH-hints (pid, utf8 names) and protocols (ping)
2421 urgency hint
2395 seperate underline colour (-underlineColor) 2422 seperate underline colour (-underlineColor)
2396 settable border widths and borderless switch (-w, -b, -bl) 2423 settable border widths and borderless switch (-w, -b, -bl)
2397 visual depth selection (-depth) 2424 visual depth selection (-depth)
2398 settable extra linespacing /-lsp) 2425 settable extra linespacing /-lsp)
2399 iso-14755-2 and -3, and visual feedback 2426 iso-14755 5.1 (basic) support
2400 tripleclickwords (-tcw) 2427 tripleclickwords (-tcw)
2401 settable insecure mode (-insecure) 2428 settable insecure mode (-insecure)
2402 keysym remapping support 2429 keysym remapping support
2403 cursor blinking and underline cursor (-cb, -uc) 2430 cursor blinking and underline cursor (-cb, -uc)
2404 XEmbed support (-embed) 2431 XEmbed support (-embed)
2405 user-pty (-pty-fd) 2432 user-pty (-pty-fd)
2406 hold on exit (-hold) 2433 hold on exit (-hold)
2434 compile in built-in block graphics
2407 skip builtin block graphics (-sbg) 2435 skip builtin block graphics (-sbg)
2436 separate highlightcolor support (-hc)
2408 2437
2409It also enabled some non-essential features otherwise disabled, such as: 2438It also enables some non-essential features otherwise disabled, such as:
2410 2439
2411 some round-trip time optimisations 2440 some round-trip time optimisations
2412 nearest color allocation on pseudocolor screens 2441 nearest color allocation on pseudocolor screens
2413 UTF8_STRING supporr for selection 2442 UTF8_STRING support for selection
2414 sgr modes 90..97 and 100..107 2443 sgr modes 90..97 and 100..107
2415 backindex and forwardindex escape sequences 2444 backindex and forwardindex escape sequences
2416 view change/zero scorllback esacpe sequences 2445 view change/zero scrollback escape sequences
2417 locale switching escape sequence 2446 locale switching escape sequence
2418 window op and some xterm/OSC escape sequences 2447 window op and some xterm/OSC escape sequences
2419 rectangular selections 2448 rectangular selections
2420 trailing space removal for selections 2449 trailing space removal for selections
2421 verbose X error handling 2450 verbose X error handling
2430=item --enable-keepscrolling (default: on) 2459=item --enable-keepscrolling (default: on)
2431 2460
2432Add support for continual scrolling of the display when you hold 2461Add support for continual scrolling of the display when you hold
2433the mouse button down on a scrollbar arrow. 2462the mouse button down on a scrollbar arrow.
2434 2463
2464=item --enable-selectionscrolling (default: on)
2465
2466Add support for scrolling when the selection moves to the top or
2467bottom of the screen.
2468
2435=item --enable-mousewheel (default: on) 2469=item --enable-mousewheel (default: on)
2436 2470
2437Add support for scrolling via mouse wheel or buttons 4 & 5. 2471Add support for scrolling via mouse wheel or buttons 4 & 5.
2438 2472
2439=item --enable-slipwheeling (default: on) 2473=item --enable-slipwheeling (default: on)
2440 2474
2441Add support for continual scrolling (using the mouse wheel as an 2475Add support for continual scrolling (using the mouse wheel as an
2442accelerator) while the control key is held down. This option 2476accelerator) while the control key is held down. This option
2443requires --enable-mousewheel to also be specified. 2477requires --enable-mousewheel to also be specified.
2444 2478
2445=item --disable-new-selection
2446
2447Remove support for mouse selection style like that of xterm.
2448
2449=item --enable-dmalloc (default: off)
2450
2451Use Gray Watson's malloc - which is good for debugging See
2452L<http://www.letters.com/dmalloc/> for details If you use either this or the
2453next option, you may need to edit src/Makefile after compiling to point
2454DINCLUDE and DLIB to the right places.
2455
2456You can only use either this option and the following (should
2457you use either) .
2458
2459=item --enable-dlmalloc (default: off)
2460
2461Use Doug Lea's malloc - which is good for a production version
2462See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2463
2464=item --enable-smart-resize (default: on) 2479=item --enable-smart-resize (default: off)
2465 2480
2466Add smart growth/shrink behaviour when changing font size via hot 2481Add smart growth/shrink behaviour when resizing.
2467keys. This should keep the window corner which is closest to a corner of 2482This should keep the window corner which is closest to a corner of
2468the screen in a fixed position. 2483the screen in a fixed position.
2469 2484
2485=item --enable-text-blink (default: on)
2486
2487Add support for blinking text.
2488
2470=item --enable-pointer-blank (default: on) 2489=item --enable-pointer-blank (default: on)
2471 2490
2472Add support to have the pointer disappear when typing or inactive. 2491Add support to have the pointer disappear when typing or inactive.
2473 2492
2474=item --enable-perl (default: on) 2493=item --enable-perl (default: on)
2475 2494
2476Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2495Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2477manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files 2496manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the
2478in F<src/perl-ext/> for the extensions that are installed by default. The 2497files in F<src/perl-ext/> for the extensions that are installed by
2479perl interpreter that is used can be specified via the C<PERL> environment 2498default. The perl interpreter that is used can be specified via the
2480variable when running configure. 2499C<PERL> environment variable when running configure. Even when compiled
2500in, perl will I<not> be initialised when all extensions have been disabled
2501C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2502resource standpoint.
2503
2504=item --with-afterimage-config=DIR
2505
2506Look for the libAfterImage config script in DIR.
2481 2507
2482=item --with-name=NAME (default: urxvt) 2508=item --with-name=NAME (default: urxvt)
2483 2509
2484Set the basename for the installed binaries, resulting 2510Set the basename for the installed binaries, resulting
2485in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2511in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2495PATH. 2521PATH.
2496 2522
2497=item --with-x 2523=item --with-x
2498 2524
2499Use the X Window System (pretty much default, eh?). 2525Use the X Window System (pretty much default, eh?).
2500
2501=item --with-xpm-includes=DIR
2502
2503Look for the XPM includes in DIR.
2504
2505=item --with-xpm-library=DIR
2506
2507Look for the XPM library in DIR.
2508
2509=item --with-xpm
2510
2511Not needed - define via --enable-xpm-background.
2512 2526
2513=back 2527=back
2514 2528
2515=head1 AUTHORS 2529=head1 AUTHORS
2516 2530

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines