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.111 by root, Thu Feb 2 00:31:47 2006 UTC vs.
Revision 1.151 by sasha, Thu Nov 15 18:40:10 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.
… …
460has been designed yet). 459has been designed yet).
461 460
462Until then, you might get away with switching fonts at runtime (see L<Can 461Until then, you might get away with switching fonts at runtime (see L<Can
463I switch the fonts at runtime?> later in this document). 462I switch the fonts at runtime?> later in this document).
464 463
464=head3 How can I make mplayer display video correctly?
465
466We are working on it, in the meantime, as a workaround, use something like:
467
468 @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
469
470
465=head2 Keyboard, Mouse & User Interaction 471=head2 Keyboard, Mouse & User Interaction
466 472
467=head3 The new selection selects pieces that are too big, how can I select single words? 473=head3 The new selection selects pieces that are too big, how can I select single words?
468 474
469If you want to select e.g. alphanumeric words, you can use the following 475If 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 518circumstances, 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, 519line 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 520but when running a program that doesn't parse cursor movements or in some
515cases during rlogin sessions, it fails to detect this properly. 521cases during rlogin sessions, it fails to detect this properly.
516 522
517You can permamently switch this feature off by disabling the C<readline> 523You can permanently switch this feature off by disabling the C<readline>
518extension: 524extension:
519 525
520 URxvt.perl-ext-common: default,-readline 526 URxvt.perl-ext-common: default,-readline
521 527
522=head3 My numerical keypad acts weird and generates differing output? 528=head3 My numerical keypad acts weird and generates differing output?
523 529
524Some Debian GNUL/Linux users seem to have this problem, although no 530Some Debian GNUL/Linux users seem to have this problem, although no
525specific details were reported so far. It is possible that this is caused 531specific 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 532by 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 533this 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 534keymap. See the answer to the previous question, and please report if that
529helped. 535helped.
530 536
531=head3 My Compose (Multi_key) key is no longer working. 537=head3 My Compose (Multi_key) key is no longer working.
… …
557depressed. 563depressed.
558 564
559=head3 What's with the strange Backspace/Delete key behaviour? 565=head3 What's with the strange Backspace/Delete key behaviour?
560 566
561Assuming that the physical Backspace key corresponds to the 567Assuming that the physical Backspace key corresponds to the
562BackSpace keysym (not likely for Linux ... see the following 568Backspace keysym (not likely for Linux ... see the following
563question) there are two standard values that can be used for 569question) there are two standard values that can be used for
564Backspace: C<^H> and C<^?>. 570Backspace: C<^H> and C<^?>.
565 571
566Historically, either value is correct, but rxvt-unicode adopts the debian 572Historically, either value is correct, but rxvt-unicode adopts the debian
567policy of using C<^?> when unsure, because it's the one only only correct 573policy of using C<^?> when unsure, because it's the one and only correct
568choice :). 574choice :).
569 575
570Rxvt-unicode tries to inherit the current stty settings and uses the value 576Rxvt-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 577of `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 578started 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 610key has been assigned an escape sequence to match the vt100 for Execute
605(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo. 611(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
606 612
607Some other Backspace problems: 613Some other Backspace problems:
608 614
609some editors use termcap/terminfo, 615some editors use termcap/terminfo,
610some editors (vim I'm told) expect Backspace = ^H, 616some editors (vim I'm told) expect Backspace = ^H,
611GNU Emacs (and Emacs-like editors) use ^H for help. 617GNU Emacs (and Emacs-like editors) use ^H for help.
612 618
613Perhaps someday this will all be resolved in a consistent manner. 619Perhaps someday this will all be resolved in a consistent manner.
614 620
… …
655Rather than have rxvt-unicode try to accommodate all the various possible 661Rather than have rxvt-unicode try to accommodate all the various possible
656keyboard mappings, it is better to use `xmodmap' to remap the keys as 662keyboard mappings, it is better to use `xmodmap' to remap the keys as
657required for your particular machine. 663required for your particular machine.
658 664
659 665
660
661=head2 Terminal Configuration 666=head2 Terminal Configuration
667
668=head3 Can I see a typical configuration?
669
670The default configuration tries to be xterm-like, which I don't like that
671much, but it's least surprise to regular users.
672
673As a rxvt or rxvt-unicode user, you are practically supposed to invest
674time into customising your terminal. To get you started, here is the
675author's .Xdefaults entries, with comments on what they do. It's certainly
676not I<typical>, but what's typical...
677
678 URxvt.cutchars: "()*,<>[]{}|'
679 URxvt.print-pipe: cat >/tmp/xxx
680
681These are just for testing stuff.
682
683 URxvt.imLocale: ja_JP.UTF-8
684 URxvt.preeditType: OnTheSpot,None
685
686This tells rxvt-unicode to use a special locale when communicating with
687the X Input Method, and also tells it to only use the OnTheSpot pre-edit
688type, which requires the C<xim-onthespot> perl extension but rewards me
689with correct-looking fonts.
690
691 URxvt.perl-lib: /root/lib/urxvt
692 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
693 URxvt.selection.pattern-0: ( at .*? line \\d+)
694 URxvt.selection.pattern-1: ^(/[^:]+):\
695 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
696 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
697
698This is my perl configuration. The first two set the perl library
699directory and also tells urxvt to use a large number of extensions. I
700develop for myself mostly, so I actually use most of the extensions I
701write.
702
703The selection stuff mainly makes the selection perl-error-message aware
704and tells it to convert perl error messages into vi-commands to load the
705relevant file and go tot he error line number.
706
707 URxvt.scrollstyle: plain
708 URxvt.secondaryScroll: true
709
710As the documentation says: plain is the preferred scrollbar for the
711author. The C<secondaryScroll> configures urxvt to scroll in full-screen
712apps, like screen, so lines scrolled out of screen end up in urxvt's
713scrollback buffer.
714
715 URxvt.background: #000000
716 URxvt.foreground: gray90
717 URxvt.color7: gray90
718 URxvt.colorBD: #ffffff
719 URxvt.cursorColor: #e0e080
720 URxvt.throughColor: #8080f0
721 URxvt.highlightColor: #f0f0f0
722
723Some colours. Not sure which ones are being used or even non-defaults, but
724these are in my .Xdefaults. Most notably, they set foreground/background
725to light gray/black, and also make sure that the colour 7 matches the
726default foreground colour.
727
728 URxvt.underlineColor: yellow
729
730Another colour, makes underline lines look different. Sometimes hurts, but
731is mostly a nice effect.
732
733 URxvt.geometry: 154x36
734 URxvt.loginShell: false
735 URxvt.meta: ignore
736 URxvt.utmpInhibit: true
737
738Uh, well, should be mostly self-explanatory. By specifying some defaults
739manually, I can quickly switch them for testing.
740
741 URxvt.saveLines: 8192
742
743A large scrollback buffer is essential. Really.
744
745 URxvt.mapAlert: true
746
747The only case I use it is for my IRC window, which I like to keep
748iconified till people msg me (which beeps).
749
750 URxvt.visualBell: true
751
752The audible bell is often annoying, especially when in a crowd.
753
754 URxvt.insecure: true
755
756Please don't hack my mutt! Ooops...
757
758 URxvt.pastableTabs: false
759
760I once thought this is a great idea.
761
762 urxvt.font: 9x15bold,\
763 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
764 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
765 [codeset=JISX0208]xft:Kochi Gothic, \
766 xft:Bitstream Vera Sans Mono:autohint=true, \
767 xft:Code2000:antialias=false
768 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
769 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
770 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
771
772I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
773overwhelmed. A special note: the C<9x15bold> mentioned above is actually
774the version from XFree-3.3, as XFree-4 replaced it by a totally different
775font (different glyphs for C<;> and many other harmless characters),
776while the second font is actually the C<9x15bold> from XFree4/XOrg. The
777bold version has less chars than the medium version, so I use it for rare
778characters, too. When editing sources with vim, I use italic for comments
779and other stuff, which looks quite good with Bitstream Vera anti-aliased.
780
781Terminus is a quite bad font (many very wrong glyphs), but for most of my
782purposes, it works, and gives a different look, as my normal (Non-bold)
783font is already bold, and I want to see a difference between bold and
784normal fonts.
785
786Please note that I used the C<urxvt> instance name and not the C<URxvt>
787class name. Thats because I use different configs for different purposes,
788for example, my IRC window is started with C<-name IRC>, and uses these
789defaults:
790
791 IRC*title: IRC
792 IRC*geometry: 87x12+535+542
793 IRC*saveLines: 0
794 IRC*mapAlert: true
795 IRC*font: suxuseuro
796 IRC*boldFont: suxuseuro
797 IRC*colorBD: white
798 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
799 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
800
801C<Alt-Shift-1> and C<Alt-Shift-2> switch between two different font
802sizes. C<suxuseuro> allows me to keep an eye (and actually read)
803stuff while keeping a very small window. If somebody pastes something
804complicated (e.g. japanese), I temporarily switch to a larger font.
805
806The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
807C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
808file for different hosts, for example, on ym main desktop, I use:
809
810 URxvt.keysym.C-M-q: command:\033[3;5;5t
811 URxvt.keysym.C-M-y: command:\033[3;5;606t
812 URxvt.keysym.C-M-e: command:\033[3;1605;5t
813 URxvt.keysym.C-M-c: command:\033[3;1605;606t
814 URxvt.keysym.C-M-p: perl:test
815
816The first for keysym definitions allow me to quickly bring some windows
817in the layout I like most. Ion users might start laughing but will stop
818immediately when I tell them that I use my own Fvwm2 module for much the
819same effect as Ion provides, and I only very rarely use the above key
820combinations :->
662 821
663=head3 Why doesn't rxvt-unicode read my resources? 822=head3 Why doesn't rxvt-unicode read my resources?
664 823
665Well, why, indeed? It does, in a way very similar to other X 824Well, why, indeed? It does, in a way very similar to other X
666applications. Most importantly, this means that if you or your OS loads 825applications. Most importantly, this means that if you or your OS loads
… …
675Also consider the form resources have to use: 834Also consider the form resources have to use:
676 835
677 URxvt.resource: value 836 URxvt.resource: value
678 837
679If you want to use another form (there are lots of different ways of 838If you want to use another form (there are lots of different ways of
680specifying resources), make sure you understand wether and why it 839specifying resources), make sure you understand whether and why it
681works. If unsure, use the form above. 840works. If unsure, use the form above.
682 841
683=head3 When I log-in to another system it tells me about missing terminfo data? 842=head3 When I log-in to another system it tells me about missing terminfo data?
684 843
685The terminal description used by rxvt-unicode is not as widely available 844The terminal description used by rxvt-unicode is not as widely available
686as that for xterm, or even rxvt (for which the same problem often arises). 845as that for xterm, or even rxvt (for which the same problem often arises).
687 846
688The correct solution for this problem is to install the terminfo, this can 847The correct solution for this problem is to install the terminfo, this can
689be done like this (with ncurses' infocmp): 848be done like this (with ncurses' infocmp and works as user and admin):
690 849
691 REMOTE=remotesystem.domain 850 REMOTE=remotesystem.domain
692 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" 851 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
693 852
694... or by installing rxvt-unicode normally on the remote system, 853... or by installing rxvt-unicode normally on the remote system,
854
855One some systems you might need to set C<$TERMINFO> to the full path of
856F<$HOME/.terminfo> for this to work.
695 857
696If you cannot or do not want to do this, then you can simply set 858If you cannot or do not want to do this, then you can simply set
697C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of 859C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
698problems arising, which includes wrong keymapping, less and different 860problems arising, which includes wrong keymapping, less and different
699colours and some refresh errors in fullscreen applications. It's a nice 861colours and some refresh errors in fullscreen applications. It's a nice
… …
722One reason you might want this is that some distributions or operating 884One reason you might want this is that some distributions or operating
723systems still compile some programs using the long-obsoleted termcap 885systems still compile some programs using the long-obsoleted termcap
724library (Fedora Core's bash is one example) and rely on a termcap entry 886library (Fedora Core's bash is one example) and rely on a termcap entry
725for C<rxvt-unicode>. 887for C<rxvt-unicode>.
726 888
727You could use rxvt's termcap entry with resonable results in many cases. 889You could use rxvt's termcap entry with reasonable results in many cases.
728You can also create a termcap entry by using terminfo's infocmp program 890You can also create a termcap entry by using terminfo's infocmp program
729like this: 891like this:
730 892
731 infocmp -C rxvt-unicode 893 infocmp -C rxvt-unicode
732 894
… …
754 :vs=\E[?25h: 916 :vs=\E[?25h:
755 917
756=head3 Why does C<ls> no longer have coloured output? 918=head3 Why does C<ls> no longer have coloured output?
757 919
758The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 920The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
759decide wether a terminal has colour, but uses it's own configuration 921decide whether a terminal has colour, but uses its own configuration
760file. Needless to say, C<rxvt-unicode> is not in it's default file (among 922file. Needless to say, C<rxvt-unicode> is not in its default file (among
761with most other terminals supporting colour). Either add: 923with most other terminals supporting colour). Either add:
762 924
763 TERM rxvt-unicode 925 TERM rxvt-unicode
764 926
765to C</etc/DIR_COLORS> or simply add: 927to C</etc/DIR_COLORS> or simply add:
… …
799If you encounter strange problems like typing an accented character but 961If you encounter strange problems like typing an accented character but
800getting two unrelated other characters or similar, or if program output is 962getting two unrelated other characters or similar, or if program output is
801subtly garbled, then you should check your locale settings. 963subtly garbled, then you should check your locale settings.
802 964
803Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 965Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
804programs. Often rxvt-unicode is started in the C<C> locale, while the 966programs running in it. Often rxvt-unicode is started in the C<C> locale,
805login script running within the rxvt-unicode window changes the locale to 967while the login script running within the rxvt-unicode window changes the
806something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work. 968locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
969not going to work, and is the most common cause for problems.
807 970
808The best thing is to fix your startup environment, as you will likely run 971The best thing is to fix your startup environment, as you will likely run
809into other problems. If nothing works you can try this in your .profile. 972into other problems. If nothing works you can try this in your .profile.
810 973
811 printf '\e]701;%s\007' "$LC_CTYPE" 974 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
812 975
813If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 976If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
814supported on your systems. Some systems have a C<locale> command which 977supported on your systems. Some systems have a C<locale> command which
815displays this (also, C<perl -e0> can be used to check locale settings, as 978displays this (also, C<perl -e0> can be used to check locale settings, as
816it will complain loudly if it cannot set the locale). If it displays something 979it will complain loudly if it cannot set the locale). If it displays something
… …
837The reasons is that there exists a perfectly fine mechanism for selecting 1000The reasons is that there exists a perfectly fine mechanism for selecting
838the encoding, doing I/O and (most important) communicating this to all 1001the encoding, doing I/O and (most important) communicating this to all
839applications so everybody agrees on character properties such as width 1002applications so everybody agrees on character properties such as width
840and code number. This mechanism is the I<locale>. Applications not using 1003and code number. This mechanism is the I<locale>. Applications not using
841that info will have problems (for example, C<xterm> gets the width of 1004that info will have problems (for example, C<xterm> gets the width of
842characters wrong as it uses it's own, locale-independent table under all 1005characters wrong as it uses its own, locale-independent table under all
843locales). 1006locales).
844 1007
845Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All 1008Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
846programs doing the same (that is, most) will automatically agree in the 1009programs doing the same (that is, most) will automatically agree in the
847interpretation of characters. 1010interpretation of characters.
… …
866=head3 Can I switch locales at runtime? 1029=head3 Can I switch locales at runtime?
867 1030
868Yes, using an escape sequence. Try something like this, which sets 1031Yes, using an escape sequence. Try something like this, which sets
869rxvt-unicode's idea of C<LC_CTYPE>. 1032rxvt-unicode's idea of C<LC_CTYPE>.
870 1033
871 printf '\e]701;%s\007' ja_JP.SJIS 1034 printf '\33]701;%s\007' ja_JP.SJIS
872 1035
873See also the previous answer. 1036See also the previous answer.
874 1037
875Sometimes this capability is rather handy when you want to work in 1038Sometimes this capability is rather handy when you want to work in
876one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it 1039one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
877(e.g. UTF-8). For example, I use this script to start C<xjdic>, which 1040(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
878first switches to a locale supported by xjdic and back later: 1041first switches to a locale supported by xjdic and back later:
879 1042
880 printf '\e]701;%s\007' ja_JP.SJIS 1043 printf '\33]701;%s\007' ja_JP.SJIS
881 xjdic -js 1044 xjdic -js
882 printf '\e]701;%s\007' de_DE.UTF-8 1045 printf '\33]701;%s\007' de_DE.UTF-8
883 1046
884You can also use xterm's C<luit> program, which usually works fine, except 1047You can also use xterm's C<luit> program, which usually works fine, except
885for some locales where character width differs between program- and 1048for some locales where character width differs between program- and
886rxvt-unicode-locales. 1049rxvt-unicode-locales.
887 1050
1051=head3 I have problems getting my input method working.
1052
1053Try a search engine, as this is slightly different for every input method server.
1054
1055Here is a checklist:
1056
1057=over 4
1058
1059=item - Make sure your locale I<and> the imLocale are supported on your OS.
1060
1061Try C<locale -a> or check the documentation for your OS.
1062
1063=item - Make sure your locale or imLocale matches a locale supported by your XIM.
1064
1065For example, B<kinput2> does not support UTF-8 locales, you should use
1066C<ja_JP.EUC-JP> or equivalent.
1067
1068=item - Make sure your XIM server is actually running.
1069
1070=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1071
1072When you want to use e.g. B<kinput2>, it must be set to
1073C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1074method servers are running with this command:
1075
1076 xprop -root XIM_SERVERS
1077
1078=item
1079
1080=back
1081
888=head3 My input method wants <some encoding> but I want UTF-8, what can I do? 1082=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
889 1083
890You can specify separate locales for the input method and the rest of the 1084You can specify separate locales for the input method and the rest of the
891terminal, using the resource C<imlocale>: 1085terminal, using the resource C<imlocale>:
892 1086
893 URxvt.imlocale: ja_JP.EUC-JP 1087 URxvt.imlocale: ja_JP.EUC-JP
894 1088
895Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 1089Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
896use your input method. Please note, however, that you will not be able to 1090use your input method. Please note, however, that, depending on your Xlib
897input characters outside C<EUC-JP> in a normal way then, as your input 1091version, you may not be able to input characters outside C<EUC-JP> in a
898method limits you. 1092normal way then, as your input method limits you.
899 1093
900=head3 Rxvt-unicode crashes when the X Input Method changes or exits. 1094=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
901 1095
902Unfortunately, this is unavoidable, as the XIM protocol is racy by 1096Unfortunately, this is unavoidable, as the XIM protocol is racy by
903design. Applications can avoid some crashes at the expense of memory 1097design. Applications can avoid some crashes at the expense of memory
… …
929 1123
930=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation? 1124=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
931 1125
932You should build one binary with the default options. F<configure> 1126You should build one binary with the default options. F<configure>
933now enables most useful options, and the trend goes to making them 1127now enables most useful options, and the trend goes to making them
934runtime-switchable, too, so there is usually no drawback to enbaling them, 1128runtime-switchable, too, so there is usually no drawback to enabling them,
935except higher disk and possibly memory usage. The perl interpreter should 1129except higher disk and possibly memory usage. The perl interpreter should
936be enabled, as important functionality (menus, selection, likely more in 1130be enabled, as important functionality (menus, selection, likely more in
937the future) depends on it. 1131the future) depends on it.
938 1132
939You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 1133You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
… …
962This forking is done as the very first within main(), which is very early 1156This forking is done as the very first within main(), which is very early
963and reduces possible bugs to initialisation code run before main(), or 1157and reduces possible bugs to initialisation code run before main(), or
964things like the dynamic loader of your system, which should result in very 1158things like the dynamic loader of your system, which should result in very
965little risk. 1159little risk.
966 1160
967=head3 On Solaris 9, many line-drawing characters are too wide.
968
969Seems to be a known bug, read
970L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
971following ugly workaround to get non-double-wide-characters working:
972
973 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
974
975=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all. 1161=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
976 1162
977Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1163Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
978in your compile environment, or an implementation that implements it, 1164in your compile environment, or an implementation that implements it,
979wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1165whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
980B<wchar_t> is represented as unicode. 1166B<wchar_t> is represented as unicode.
981 1167
982As you might have guessed, FreeBSD does neither define this symobl nor 1168As you might have guessed, FreeBSD does neither define this symbol nor
983does it support it. Instead, it uses it's own internal representation of 1169does it support it. Instead, it uses its own internal representation of
984B<wchar_t>. This is, of course, completely fine with respect to standards. 1170B<wchar_t>. This is, of course, completely fine with respect to standards.
985 1171
986However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and 1172However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
987C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>. 1173C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
988 1174
… …
1002 1188
1003The rxvt-unicode author insists that the right way to fix this is in the 1189The rxvt-unicode author insists that the right way to fix this is in the
1004system libraries once and for all, instead of forcing every app to carry 1190system libraries once and for all, instead of forcing every app to carry
1005complete replacements for them :) 1191complete replacements for them :)
1006 1192
1007=head3 I use Solaris 9 and it doesn't compile/work/etc.
1008
1009Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
1010problems with C<wcwidth> and a compile problem.
1011
1012=head3 How can I use rxvt-unicode under cygwin? 1193=head3 How can I use rxvt-unicode under cygwin?
1013 1194
1014rxvt-unicode should compile and run out of the box on cygwin, using 1195rxvt-unicode should compile and run out of the box on cygwin, using
1015the X11 libraries that come with cygwin. libW11 emulation is no 1196the X11 libraries that come with cygwin. libW11 emulation is no
1016longer supported (and makes no sense, either, as it only supported a 1197longer supported (and makes no sense, either, as it only supported a
… …
1019old libW11 emulation. 1200old libW11 emulation.
1020 1201
1021At the time of this writing, cygwin didn't seem to support any multi-byte 1202At the time of this writing, cygwin didn't seem to support any multi-byte
1022encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited 1203encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1023to 8-bit encodings. 1204to 8-bit encodings.
1205
1206=head3 Character widths are not correct.
1207
1208urxvt uses the system wcwidth function to know the information about
1209the width of characters, so on systems with incorrect locale data you
1210will likely get bad results. Two notorious examples are Solaris 9,
1211where single-width characters like U+2514 are reported as double-width,
1212and Darwin 8, where combining chars are reported having width 1.
1213
1214The solution is to upgrade your system or switch to a better one. A
1215possibly working workaround is to use a wcwidth implementation like
1216
1217http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1024 1218
1025=head1 RXVT-UNICODE TECHNICAL REFERENCE 1219=head1 RXVT-UNICODE TECHNICAL REFERENCE
1026 1220
1027The rest of this document describes various technical aspects of 1221The rest of this document describes various technical aspects of
1028B<rxvt-unicode>. First the description of supported command sequences, 1222B<rxvt-unicode>. First the description of supported command sequences,
… …
1522 1716
1523Toggle DEC Private Mode Values (rxvt extension). I<where> 1717Toggle DEC Private Mode Values (rxvt extension). I<where>
1524 1718
1525=over 4 1719=over 4
1526 1720
1527=item B<< C<Ps = 1> >> (DECCKM) 1721=item B<< C<Pm = 1> >> (DECCKM)
1528 1722
1529=begin table 1723=begin table
1530 1724
1531 B<< C<h> >> Application Cursor Keys 1725 B<< C<h> >> Application Cursor Keys
1532 B<< C<l> >> Normal Cursor Keys 1726 B<< C<l> >> Normal Cursor Keys
1533 1727
1534=end table 1728=end table
1535 1729
1536=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1730=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1537 1731
1538=begin table 1732=begin table
1539 1733
1540 B<< C<h> >> Enter VT52 mode 1734 B<< C<h> >> Enter VT52 mode
1541 B<< C<l> >> Enter VT52 mode 1735 B<< C<l> >> Enter VT52 mode
1542 1736
1543=end table 1737=end table
1544 1738
1545=item B<< C<Ps = 3> >> 1739=item B<< C<Pm = 3> >>
1546 1740
1547=begin table 1741=begin table
1548 1742
1549 B<< C<h> >> 132 Column Mode (DECCOLM) 1743 B<< C<h> >> 132 Column Mode (DECCOLM)
1550 B<< C<l> >> 80 Column Mode (DECCOLM) 1744 B<< C<l> >> 80 Column Mode (DECCOLM)
1551 1745
1552=end table 1746=end table
1553 1747
1554=item B<< C<Ps = 4> >> 1748=item B<< C<Pm = 4> >>
1555 1749
1556=begin table 1750=begin table
1557 1751
1558 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1752 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1559 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1753 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1560 1754
1561=end table 1755=end table
1562 1756
1563=item B<< C<Ps = 5> >> 1757=item B<< C<Pm = 5> >>
1564 1758
1565=begin table 1759=begin table
1566 1760
1567 B<< C<h> >> Reverse Video (DECSCNM) 1761 B<< C<h> >> Reverse Video (DECSCNM)
1568 B<< C<l> >> Normal Video (DECSCNM) 1762 B<< C<l> >> Normal Video (DECSCNM)
1569 1763
1570=end table 1764=end table
1571 1765
1572=item B<< C<Ps = 6> >> 1766=item B<< C<Pm = 6> >>
1573 1767
1574=begin table 1768=begin table
1575 1769
1576 B<< C<h> >> Origin Mode (DECOM) 1770 B<< C<h> >> Origin Mode (DECOM)
1577 B<< C<l> >> Normal Cursor Mode (DECOM) 1771 B<< C<l> >> Normal Cursor Mode (DECOM)
1578 1772
1579=end table 1773=end table
1580 1774
1581=item B<< C<Ps = 7> >> 1775=item B<< C<Pm = 7> >>
1582 1776
1583=begin table 1777=begin table
1584 1778
1585 B<< C<h> >> Wraparound Mode (DECAWM) 1779 B<< C<h> >> Wraparound Mode (DECAWM)
1586 B<< C<l> >> No Wraparound Mode (DECAWM) 1780 B<< C<l> >> No Wraparound Mode (DECAWM)
1587 1781
1588=end table 1782=end table
1589 1783
1590=item B<< C<Ps = 8> >> I<unimplemented> 1784=item B<< C<Pm = 8> >> I<unimplemented>
1591 1785
1592=begin table 1786=begin table
1593 1787
1594 B<< C<h> >> Auto-repeat Keys (DECARM) 1788 B<< C<h> >> Auto-repeat Keys (DECARM)
1595 B<< C<l> >> No Auto-repeat Keys (DECARM) 1789 B<< C<l> >> No Auto-repeat Keys (DECARM)
1596 1790
1597=end table 1791=end table
1598 1792
1599=item B<< C<Ps = 9> >> X10 XTerm 1793=item B<< C<Pm = 9> >> X10 XTerm
1600 1794
1601=begin table 1795=begin table
1602 1796
1603 B<< C<h> >> Send Mouse X & Y on button press. 1797 B<< C<h> >> Send Mouse X & Y on button press.
1604 B<< C<l> >> No mouse reporting. 1798 B<< C<l> >> No mouse reporting.
1605 1799
1606=end table 1800=end table
1607 1801
1608=item B<< C<Ps = 25> >> 1802=item B<< C<Pm = 25> >>
1609 1803
1610=begin table 1804=begin table
1611 1805
1612 B<< C<h> >> Visible cursor {cnorm/cvvis} 1806 B<< C<h> >> Visible cursor {cnorm/cvvis}
1613 B<< C<l> >> Invisible cursor {civis} 1807 B<< C<l> >> Invisible cursor {civis}
1614 1808
1615=end table 1809=end table
1616 1810
1617=item B<< C<Ps = 30> >> 1811=item B<< C<Pm = 30> >>
1618 1812
1619=begin table 1813=begin table
1620 1814
1621 B<< C<h> >> scrollBar visisble 1815 B<< C<h> >> scrollBar visisble
1622 B<< C<l> >> scrollBar invisisble 1816 B<< C<l> >> scrollBar invisisble
1623 1817
1624=end table 1818=end table
1625 1819
1626=item B<< C<Ps = 35> >> (B<rxvt>) 1820=item B<< C<Pm = 35> >> (B<rxvt>)
1627 1821
1628=begin table 1822=begin table
1629 1823
1630 B<< C<h> >> Allow XTerm Shift+key sequences 1824 B<< C<h> >> Allow XTerm Shift+key sequences
1631 B<< C<l> >> Disallow XTerm Shift+key sequences 1825 B<< C<l> >> Disallow XTerm Shift+key sequences
1632 1826
1633=end table 1827=end table
1634 1828
1635=item B<< C<Ps = 38> >> I<unimplemented> 1829=item B<< C<Pm = 38> >> I<unimplemented>
1636 1830
1637Enter Tektronix Mode (DECTEK) 1831Enter Tektronix Mode (DECTEK)
1638 1832
1639=item B<< C<Ps = 40> >> 1833=item B<< C<Pm = 40> >>
1640 1834
1641=begin table 1835=begin table
1642 1836
1643 B<< C<h> >> Allow 80/132 Mode 1837 B<< C<h> >> Allow 80/132 Mode
1644 B<< C<l> >> Disallow 80/132 Mode 1838 B<< C<l> >> Disallow 80/132 Mode
1645 1839
1646=end table 1840=end table
1647 1841
1648=item B<< C<Ps = 44> >> I<unimplemented> 1842=item B<< C<Pm = 44> >> I<unimplemented>
1649 1843
1650=begin table 1844=begin table
1651 1845
1652 B<< C<h> >> Turn On Margin Bell 1846 B<< C<h> >> Turn On Margin Bell
1653 B<< C<l> >> Turn Off Margin Bell 1847 B<< C<l> >> Turn Off Margin Bell
1654 1848
1655=end table 1849=end table
1656 1850
1657=item B<< C<Ps = 45> >> I<unimplemented> 1851=item B<< C<Pm = 45> >> I<unimplemented>
1658 1852
1659=begin table 1853=begin table
1660 1854
1661 B<< C<h> >> Reverse-wraparound Mode 1855 B<< C<h> >> Reverse-wraparound Mode
1662 B<< C<l> >> No Reverse-wraparound Mode 1856 B<< C<l> >> No Reverse-wraparound Mode
1663 1857
1664=end table 1858=end table
1665 1859
1666=item B<< C<Ps = 46> >> I<unimplemented> 1860=item B<< C<Pm = 46> >> I<unimplemented>
1667 1861
1668=item B<< C<Ps = 47> >> 1862=item B<< C<Pm = 47> >>
1669 1863
1670=begin table 1864=begin table
1671 1865
1672 B<< C<h> >> Use Alternate Screen Buffer 1866 B<< C<h> >> Use Alternate Screen Buffer
1673 B<< C<l> >> Use Normal Screen Buffer 1867 B<< C<l> >> Use Normal Screen Buffer
1674 1868
1675=end table 1869=end table
1676 1870
1677X<Priv66> 1871X<Priv66>
1678 1872
1679=item B<< C<Ps = 66> >> 1873=item B<< C<Pm = 66> >>
1680 1874
1681=begin table 1875=begin table
1682 1876
1683 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1877 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1684 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1878 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1685 1879
1686=end table 1880=end table
1687 1881
1688=item B<< C<Ps = 67> >> 1882=item B<< C<Pm = 67> >>
1689 1883
1690=begin table 1884=begin table
1691 1885
1692 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1886 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1693 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1887 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1694 1888
1695=end table 1889=end table
1696 1890
1697=item B<< C<Ps = 1000> >> (X11 XTerm) 1891=item B<< C<Pm = 1000> >> (X11 XTerm)
1698 1892
1699=begin table 1893=begin table
1700 1894
1701 B<< C<h> >> Send Mouse X & Y on button press and release. 1895 B<< C<h> >> Send Mouse X & Y on button press and release.
1702 B<< C<l> >> No mouse reporting. 1896 B<< C<l> >> No mouse reporting.
1703 1897
1704=end table 1898=end table
1705 1899
1706=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1900=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1707 1901
1708=begin table 1902=begin table
1709 1903
1710 B<< C<h> >> Use Hilite Mouse Tracking. 1904 B<< C<h> >> Use Hilite Mouse Tracking.
1711 B<< C<l> >> No mouse reporting. 1905 B<< C<l> >> No mouse reporting.
1712 1906
1713=end table 1907=end table
1714 1908
1909=item B<< C<Pm = 1002> >> (X11 XTerm)
1910
1911=begin table
1912
1913 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1914 B<< C<l> >> No mouse reporting.
1915
1916=end table
1917
1918=item B<< C<Pm = 1003> >> (X11 XTerm)
1919
1920=begin table
1921
1922 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1923 B<< C<l> >> No mouse reporting.
1924
1925=end table
1926
1715=item B<< C<Ps = 1010> >> (B<rxvt>) 1927=item B<< C<Pm = 1010> >> (B<rxvt>)
1716 1928
1717=begin table 1929=begin table
1718 1930
1719 B<< C<h> >> Don't scroll to bottom on TTY output 1931 B<< C<h> >> Don't scroll to bottom on TTY output
1720 B<< C<l> >> Scroll to bottom on TTY output 1932 B<< C<l> >> Scroll to bottom on TTY output
1721 1933
1722=end table 1934=end table
1723 1935
1724=item B<< C<Ps = 1011> >> (B<rxvt>) 1936=item B<< C<Pm = 1011> >> (B<rxvt>)
1725 1937
1726=begin table 1938=begin table
1727 1939
1728 B<< C<h> >> Scroll to bottom when a key is pressed 1940 B<< C<h> >> Scroll to bottom when a key is pressed
1729 B<< C<l> >> Don't scroll to bottom when a key is pressed 1941 B<< C<l> >> Don't scroll to bottom when a key is pressed
1730 1942
1731=end table 1943=end table
1732 1944
1733=item B<< C<Ps = 1021> >> (B<rxvt>) 1945=item B<< C<Pm = 1021> >> (B<rxvt>)
1734 1946
1735=begin table 1947=begin table
1736 1948
1737 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>) 1949 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1738 B<< C<l> >> Font styles have no effect on intensity (Compile styles) 1950 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1739 1951
1740=end table 1952=end table
1741 1953
1742=item B<< C<Ps = 1047> >> 1954=item B<< C<Pm = 1047> >>
1743 1955
1744=begin table 1956=begin table
1745 1957
1746 B<< C<h> >> Use Alternate Screen Buffer 1958 B<< C<h> >> Use Alternate Screen Buffer
1747 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1959 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1748 1960
1749=end table 1961=end table
1750 1962
1751=item B<< C<Ps = 1048> >> 1963=item B<< C<Pm = 1048> >>
1752 1964
1753=begin table 1965=begin table
1754 1966
1755 B<< C<h> >> Save cursor position 1967 B<< C<h> >> Save cursor position
1756 B<< C<l> >> Restore cursor position 1968 B<< C<l> >> Restore cursor position
1757 1969
1758=end table 1970=end table
1759 1971
1760=item B<< C<Ps = 1049> >> 1972=item B<< C<Pm = 1049> >>
1761 1973
1762=begin table 1974=begin table
1763 1975
1764 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it 1976 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1765 B<< C<l> >> Use Normal Screen Buffer 1977 B<< C<l> >> Use Normal Screen Buffer
… …
1794 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 2006 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1795 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 2007 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1796 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 2008 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1797 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706] 2009 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1798 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707] 2010 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1799 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM). 2011 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
1800 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 2012 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1801 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 2013 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1802 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 2014 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1803 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> >> 2015 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> >>
1804 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 2016 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
… …
1818 2030
1819=end table 2031=end table
1820 2032
1821=back 2033=back
1822 2034
1823=head1 XPM 2035=head1 BACKGROUND IMAGE
1824 2036
1825For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2037For the BACGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1826of B<< C<Pt> >> can be the name of the background pixmap followed by a 2038of B<< C<Pt> >> can be the name of the background image file followed by a
1827sequence of scaling/positioning commands separated by semi-colons. The 2039sequence of scaling/positioning commands separated by semi-colons. The
1828scaling/positioning commands are as follows: 2040scaling/positioning commands are as follows:
1829 2041
1830=over 4 2042=over 4
1831 2043
… …
1869 2081
1870For example: 2082For example:
1871 2083
1872=over 4 2084=over 4
1873 2085
1874=item B<\E]20;funky\a> 2086=item B<\E]20;funky.jpg\a>
1875 2087
1876load B<funky.xpm> as a tiled image 2088load B<funky.jpg> as a tiled image
1877 2089
1878=item B<\E]20;mona;100\a> 2090=item B<\E]20;mona.jpg;100\a>
1879 2091
1880load B<mona.xpm> with a scaling of 100% 2092load B<mona.jpg> with a scaling of 100%
1881 2093
1882=item B<\E]20;;200;?\a> 2094=item B<\E]20;;200;?\a>
1883 2095
1884rescale the current pixmap to 200% and display the image geometry in 2096rescale the current pixmap to 200% and display the image geometry in
1885the title 2097the title
… …
2012 2224
2013=head1 CONFIGURE OPTIONS 2225=head1 CONFIGURE OPTIONS
2014 2226
2015General hint: if you get compile errors, then likely your configuration 2227General hint: if you get compile errors, then likely your configuration
2016hasn't been tested well. Either try with C<--enable-everything> or use 2228hasn't been tested well. Either try with C<--enable-everything> or use
2017the F<./reconf> script as a base for experiments. F<./reconf> is used by 2229the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2018myself, so it should generally be a working config. Of course, you should 2230switches). Of course, you should always report when a combination doesn't
2019always report when a combination doesn't work, so it can be fixed. Marc 2231work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2020Lehmann <rxvt@schmorp.de>.
2021 2232
2022All 2233All
2023 2234
2024=over 4 2235=over 4
2025 2236
… …
2057 2268
2058=begin table 2269=begin table
2059 2270
2060 all all available codeset groups 2271 all all available codeset groups
2061 zh common chinese encodings 2272 zh common chinese encodings
2062 zh_ext rarely used but very big chinese encodigs 2273 zh_ext rarely used but very big chinese encodings
2063 jp common japanese encodings 2274 jp common japanese encodings
2064 jp_ext rarely used but big japanese encodings 2275 jp_ext rarely used but big japanese encodings
2065 kr korean encodings 2276 kr korean encodings
2066 2277
2067=end table 2278=end table
… …
2081requirements per character from 2 to 4 bytes. X11 fonts do not yet 2292requirements per character from 2 to 4 bytes. X11 fonts do not yet
2082support these extra characters, but Xft does. 2293support these extra characters, but Xft does.
2083 2294
2084Please note that rxvt-unicode can store unicode code points >65535 2295Please note that rxvt-unicode can store unicode code points >65535
2085even without this flag, but the number of such characters is 2296even without this flag, but the number of such characters is
2086limited to a view thousand (shared with combining characters, 2297limited to a few thousand (shared with combining characters,
2087see next switch), and right now rxvt-unicode cannot display them 2298see next switch), and right now rxvt-unicode cannot display them
2088(input/output and cut&paste still work, though). 2299(input/output and cut&paste still work, though).
2089 2300
2090=item --enable-combining (default: on) 2301=item --enable-combining (default: on)
2091 2302
… …
2137 2348
2138Write user and tty to lastlog file (used by programs like 2349Write user and tty to lastlog file (used by programs like
2139F<lastlogin>) at start of rxvt execution. This option requires 2350F<lastlogin>) at start of rxvt execution. This option requires
2140--enable-utmp to also be specified. 2351--enable-utmp to also be specified.
2141 2352
2142=item --enable-xpm-background (default: on) 2353=item --enable-afterimage (default: on)
2143 2354
2144Add support for XPM background pixmaps. 2355Add support for libAfterImage to be used for transparency and background
2356images. It adds support for many file formats including JPG, PNG,
2357SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2358(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2359
2360This option also adds such eye candy as blending an image over the root
2361background, as well as dynamic scaling and bluring of background images.
2362
2363Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2364increase by a few megabytes even if no extra features are used (mostly due
2365to third-party libraries used by libAI). Memory footprint may somewhat be
2366lowered if libAfterImage is configured without support for SVG.
2145 2367
2146=item --enable-transparency (default: on) 2368=item --enable-transparency (default: on)
2147 2369
2148Add support for inheriting parent backgrounds thus giving a fake 2370Add support for backgrounds, creating illusion of transparency in the term.
2149transparency to the term.
2150 2371
2151=item --enable-fading (default: on) 2372=item --enable-fading (default: on)
2152 2373
2153Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2374Add support for fading the text when focus is lost.
2154
2155=item --enable-tinting (default: on)
2156
2157Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2158 2375
2159=item --enable-rxvt-scroll (default: on) 2376=item --enable-rxvt-scroll (default: on)
2160 2377
2161Add support for the original rxvt scrollbar. 2378Add support for the original rxvt scrollbar.
2162 2379
… …
2205A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2422A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2206in combination with other switches) is: 2423in combination with other switches) is:
2207 2424
2208 MWM-hints 2425 MWM-hints
2209 EWMH-hints (pid, utf8 names) and protocols (ping) 2426 EWMH-hints (pid, utf8 names) and protocols (ping)
2427 urgency hint
2210 seperate underline colour (-underlineColor) 2428 seperate underline colour (-underlineColor)
2211 settable border widths and borderless switch (-w, -b, -bl) 2429 settable border widths and borderless switch (-w, -b, -bl)
2212 visual depth selection (-depth) 2430 visual depth selection (-depth)
2213 settable extra linespacing /-lsp) 2431 settable extra linespacing /-lsp)
2214 iso-14755-2 and -3, and visual feedback 2432 iso-14755 5.1 (basic) support
2215 tripleclickwords (-tcw) 2433 tripleclickwords (-tcw)
2216 settable insecure mode (-insecure) 2434 settable insecure mode (-insecure)
2217 keysym remapping support 2435 keysym remapping support
2218 cursor blinking and underline cursor (-cb, -uc) 2436 cursor blinking and underline cursor (-cb, -uc)
2219 XEmbed support (-embed) 2437 XEmbed support (-embed)
2220 user-pty (-pty-fd) 2438 user-pty (-pty-fd)
2221 hold on exit (-hold) 2439 hold on exit (-hold)
2222 skip builtin block graphics (-sbg) 2440 skip builtin block graphics (-sbg)
2441 separate highlightcolor support (-hc)
2223 2442
2224It also enabled some non-essential features otherwise disabled, such as: 2443It also enables some non-essential features otherwise disabled, such as:
2225 2444
2226 some round-trip time optimisations 2445 some round-trip time optimisations
2227 nearest color allocation on pseudocolor screens 2446 nearest color allocation on pseudocolor screens
2228 UTF8_STRING supporr for selection 2447 UTF8_STRING support for selection
2229 sgr modes 90..97 and 100..107 2448 sgr modes 90..97 and 100..107
2230 backindex and forwardindex escape sequences 2449 backindex and forwardindex escape sequences
2231 view change/zero scorllback esacpe sequences 2450 view change/zero scrollback escape sequences
2232 locale switching escape sequence 2451 locale switching escape sequence
2233 window op and some xterm/OSC escape sequences 2452 window op and some xterm/OSC escape sequences
2234 rectangular selections 2453 rectangular selections
2235 trailing space removal for selections 2454 trailing space removal for selections
2236 verbose X error handling 2455 verbose X error handling
… …
2245=item --enable-keepscrolling (default: on) 2464=item --enable-keepscrolling (default: on)
2246 2465
2247Add support for continual scrolling of the display when you hold 2466Add support for continual scrolling of the display when you hold
2248the mouse button down on a scrollbar arrow. 2467the mouse button down on a scrollbar arrow.
2249 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
2250=item --enable-mousewheel (default: on) 2474=item --enable-mousewheel (default: on)
2251 2475
2252Add support for scrolling via mouse wheel or buttons 4 & 5. 2476Add support for scrolling via mouse wheel or buttons 4 & 5.
2253 2477
2254=item --enable-slipwheeling (default: on) 2478=item --enable-slipwheeling (default: on)
2255 2479
2256Add support for continual scrolling (using the mouse wheel as an 2480Add support for continual scrolling (using the mouse wheel as an
2257accelerator) while the control key is held down. This option 2481accelerator) while the control key is held down. This option
2258requires --enable-mousewheel to also be specified. 2482requires --enable-mousewheel to also be specified.
2259 2483
2260=item --disable-new-selection
2261
2262Remove support for mouse selection style like that of xterm.
2263
2264=item --enable-dmalloc (default: off)
2265
2266Use Gray Watson's malloc - which is good for debugging See
2267http://www.letters.com/dmalloc/ for details If you use either this or the
2268next option, you may need to edit src/Makefile after compiling to point
2269DINCLUDE and DLIB to the right places.
2270
2271You can only use either this option and the following (should
2272you use either) .
2273
2274=item --enable-dlmalloc (default: off)
2275
2276Use Doug Lea's malloc - which is good for a production version
2277See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2278
2279=item --enable-smart-resize (default: on) 2484=item --enable-smart-resize (default: off)
2280 2485
2281Add smart growth/shrink behaviour when changing font size via hot 2486Add smart growth/shrink behaviour when resizing.
2282keys. 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
2283the screen in a fixed position. 2488the screen in a fixed position.
2284 2489
2285=item --enable-pointer-blank (default: on) 2490=item --enable-pointer-blank (default: on)
2286 2491
2287Add support to have the pointer disappear when typing or inactive. 2492Add support to have the pointer disappear when typing or inactive.
2288 2493
2289=item --enable-perl (default: on) 2494=item --enable-perl (default: on)
2290 2495
2291Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2496Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2292manpage (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
2293in 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
2294perl interpreter that is used can be specified via the C<PERL> environment 2499default. The perl interpreter that is used can be specified via the
2295variable 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.
2296 2508
2297=item --with-name=NAME (default: urxvt) 2509=item --with-name=NAME (default: urxvt)
2298 2510
2299Set the basename for the installed binaries, resulting 2511Set the basename for the installed binaries, resulting
2300in 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
… …
2310PATH. 2522PATH.
2311 2523
2312=item --with-x 2524=item --with-x
2313 2525
2314Use the X Window System (pretty much default, eh?). 2526Use the X Window System (pretty much default, eh?).
2315
2316=item --with-xpm-includes=DIR
2317
2318Look for the XPM includes in DIR.
2319
2320=item --with-xpm-library=DIR
2321
2322Look for the XPM library in DIR.
2323
2324=item --with-xpm
2325
2326Not needed - define via --enable-xpm-background.
2327 2527
2328=back 2528=back
2329 2529
2330=head1 AUTHORS 2530=head1 AUTHORS
2331 2531

Diff Legend

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