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.113 by root, Thu Feb 2 18:04:45 2006 UTC vs.
Revision 1.156 by ayin, Mon Dec 10 19:06:55 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
666
667=head3 Can I see a typical configuration?
668
669The default configuration tries to be xterm-like, which I don't like that
670much, but it's least surprise to regular users.
671
672As a rxvt or rxvt-unicode user, you are practically supposed to invest
673time into customising your terminal. To get you started, here is the
674author's .Xdefaults entries, with comments on what they do. It's certainly
675not I<typical>, but what's typical...
676
677 URxvt.cutchars: "()*,<>[]{}|'
678 URxvt.print-pipe: cat >/tmp/xxx
679
680These are just for testing stuff.
681
682 URxvt.imLocale: ja_JP.UTF-8
683 URxvt.preeditType: OnTheSpot,None
684
685This tells rxvt-unicode to use a special locale when communicating with
686the X Input Method, and also tells it to only use the OnTheSpot pre-edit
687type, which requires the C<xim-onthespot> perl extension but rewards me
688with correct-looking fonts.
689
690 URxvt.perl-lib: /root/lib/urxvt
691 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
692 URxvt.selection.pattern-0: ( at .*? line \\d+)
693 URxvt.selection.pattern-1: ^(/[^:]+):\
694 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
695 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
696
697This is my perl configuration. The first two set the perl library
698directory and also tells urxvt to use a large number of extensions. I
699develop for myself mostly, so I actually use most of the extensions I
700write.
701
702The selection stuff mainly makes the selection perl-error-message aware
703and tells it to convert perl error messages into vi-commands to load the
704relevant file and go tot he error line number.
705
706 URxvt.scrollstyle: plain
707 URxvt.secondaryScroll: true
708
709As the documentation says: plain is the preferred scrollbar for the
710author. The C<secondaryScroll> configures urxvt to scroll in full-screen
711apps, like screen, so lines scrolled out of screen end up in urxvt's
712scrollback buffer.
713
714 URxvt.background: #000000
715 URxvt.foreground: gray90
716 URxvt.color7: gray90
717 URxvt.colorBD: #ffffff
718 URxvt.cursorColor: #e0e080
719 URxvt.throughColor: #8080f0
720 URxvt.highlightColor: #f0f0f0
721
722Some colours. Not sure which ones are being used or even non-defaults, but
723these are in my .Xdefaults. Most notably, they set foreground/background
724to light gray/black, and also make sure that the colour 7 matches the
725default foreground colour.
726
727 URxvt.underlineColor: yellow
728
729Another colour, makes underline lines look different. Sometimes hurts, but
730is mostly a nice effect.
731
732 URxvt.geometry: 154x36
733 URxvt.loginShell: false
734 URxvt.meta: ignore
735 URxvt.utmpInhibit: true
736
737Uh, well, should be mostly self-explanatory. By specifying some defaults
738manually, I can quickly switch them for testing.
739
740 URxvt.saveLines: 8192
741
742A large scrollback buffer is essential. Really.
743
744 URxvt.mapAlert: true
745
746The only case I use it is for my IRC window, which I like to keep
747iconified till people msg me (which beeps).
748
749 URxvt.visualBell: true
750
751The audible bell is often annoying, especially when in a crowd.
752
753 URxvt.insecure: true
754
755Please don't hack my mutt! Ooops...
756
757 URxvt.pastableTabs: false
758
759I once thought this is a great idea.
760
761 urxvt.font: 9x15bold,\
762 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
763 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
764 [codeset=JISX0208]xft:Kochi Gothic, \
765 xft:Bitstream Vera Sans Mono:autohint=true, \
766 xft:Code2000:antialias=false
767 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
768 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
769 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
770
771I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
772overwhelmed. A special note: the C<9x15bold> mentioned above is actually
773the version from XFree-3.3, as XFree-4 replaced it by a totally different
774font (different glyphs for C<;> and many other harmless characters),
775while the second font is actually the C<9x15bold> from XFree4/XOrg. The
776bold version has less chars than the medium version, so I use it for rare
777characters, too. When editing sources with vim, I use italic for comments
778and other stuff, which looks quite good with Bitstream Vera anti-aliased.
779
780Terminus is a quite bad font (many very wrong glyphs), but for most of my
781purposes, it works, and gives a different look, as my normal (Non-bold)
782font is already bold, and I want to see a difference between bold and
783normal fonts.
784
785Please note that I used the C<urxvt> instance name and not the C<URxvt>
786class name. Thats because I use different configs for different purposes,
787for example, my IRC window is started with C<-name IRC>, and uses these
788defaults:
789
790 IRC*title: IRC
791 IRC*geometry: 87x12+535+542
792 IRC*saveLines: 0
793 IRC*mapAlert: true
794 IRC*font: suxuseuro
795 IRC*boldFont: suxuseuro
796 IRC*colorBD: white
797 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
798 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
799
800C<Alt-Shift-1> and C<Alt-Shift-2> switch between two different font
801sizes. C<suxuseuro> allows me to keep an eye (and actually read)
802stuff while keeping a very small window. If somebody pastes something
803complicated (e.g. japanese), I temporarily switch to a larger font.
804
805The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
806C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
807file for different hosts, for example, on ym main desktop, I use:
808
809 URxvt.keysym.C-M-q: command:\033[3;5;5t
810 URxvt.keysym.C-M-y: command:\033[3;5;606t
811 URxvt.keysym.C-M-e: command:\033[3;1605;5t
812 URxvt.keysym.C-M-c: command:\033[3;1605;606t
813 URxvt.keysym.C-M-p: perl:test
814
815The first for keysym definitions allow me to quickly bring some windows
816in the layout I like most. Ion users might start laughing but will stop
817immediately when I tell them that I use my own Fvwm2 module for much the
818same effect as Ion provides, and I only very rarely use the above key
819combinations :->
662 820
663=head3 Why doesn't rxvt-unicode read my resources? 821=head3 Why doesn't rxvt-unicode read my resources?
664 822
665Well, why, indeed? It does, in a way very similar to other X 823Well, why, indeed? It does, in a way very similar to other X
666applications. Most importantly, this means that if you or your OS loads 824applications. Most importantly, this means that if you or your OS loads
… …
675Also consider the form resources have to use: 833Also consider the form resources have to use:
676 834
677 URxvt.resource: value 835 URxvt.resource: value
678 836
679If 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
680specifying resources), make sure you understand wether and why it 838specifying resources), make sure you understand whether and why it
681works. If unsure, use the form above. 839works. If unsure, use the form above.
682 840
683=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?
684 842
685The terminal description used by rxvt-unicode is not as widely available 843The 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). 844as that for xterm, or even rxvt (for which the same problem often arises).
687 845
688The 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
689be done like this (with ncurses' infocmp): 847be done like this (with ncurses' infocmp and works as user and admin):
690 848
691 REMOTE=remotesystem.domain 849 REMOTE=remotesystem.domain
692 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"
693 851
694... 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.
695 856
696If 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
697C<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
698problems arising, which includes wrong keymapping, less and different 859problems arising, which includes wrong keymapping, less and different
699colours and some refresh errors in fullscreen applications. It's a nice 860colours and some refresh errors in fullscreen applications. It's a nice
… …
722One reason you might want this is that some distributions or operating 883One reason you might want this is that some distributions or operating
723systems still compile some programs using the long-obsoleted termcap 884systems still compile some programs using the long-obsoleted termcap
724library (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
725for C<rxvt-unicode>. 886for C<rxvt-unicode>.
726 887
727You 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.
728You 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
729like this: 890like this:
730 891
731 infocmp -C rxvt-unicode 892 infocmp -C rxvt-unicode
732 893
… …
754 :vs=\E[?25h: 915 :vs=\E[?25h:
755 916
756=head3 Why does C<ls> no longer have coloured output? 917=head3 Why does C<ls> no longer have coloured output?
757 918
758The 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
759decide wether a terminal has colour, but uses it's own configuration 920decide 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 921file. Needless to say, C<rxvt-unicode> is not in its default file (among
761with most other terminals supporting colour). Either add: 922with most other terminals supporting colour). Either add:
762 923
763 TERM rxvt-unicode 924 TERM rxvt-unicode
764 925
765to C</etc/DIR_COLORS> or simply add: 926to C</etc/DIR_COLORS> or simply add:
… …
799If you encounter strange problems like typing an accented character but 960If you encounter strange problems like typing an accented character but
800getting two unrelated other characters or similar, or if program output is 961getting two unrelated other characters or similar, or if program output is
801subtly garbled, then you should check your locale settings. 962subtly garbled, then you should check your locale settings.
802 963
803Rxvt-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
804programs. 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,
805login script running within the rxvt-unicode window changes the locale to 966while 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. 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.
807 969
808The 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
809into 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.
810 972
811 printf '\e]701;%s\007' "$LC_CTYPE" 973 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
812 974
813If 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
814supported on your systems. Some systems have a C<locale> command which 976supported 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 977displays 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 978it 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 999The reasons is that there exists a perfectly fine mechanism for selecting
838the encoding, doing I/O and (most important) communicating this to all 1000the encoding, doing I/O and (most important) communicating this to all
839applications so everybody agrees on character properties such as width 1001applications so everybody agrees on character properties such as width
840and code number. This mechanism is the I<locale>. Applications not using 1002and code number. This mechanism is the I<locale>. Applications not using
841that 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
842characters wrong as it uses it's own, locale-independent table under all 1004characters wrong as it uses its own, locale-independent table under all
843locales). 1005locales).
844 1006
845Rxvt-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
846programs doing the same (that is, most) will automatically agree in the 1008programs doing the same (that is, most) will automatically agree in the
847interpretation of characters. 1009interpretation of characters.
… …
866=head3 Can I switch locales at runtime? 1028=head3 Can I switch locales at runtime?
867 1029
868Yes, using an escape sequence. Try something like this, which sets 1030Yes, using an escape sequence. Try something like this, which sets
869rxvt-unicode's idea of C<LC_CTYPE>. 1031rxvt-unicode's idea of C<LC_CTYPE>.
870 1032
871 printf '\e]701;%s\007' ja_JP.SJIS 1033 printf '\33]701;%s\007' ja_JP.SJIS
872 1034
873See also the previous answer. 1035See also the previous answer.
874 1036
875Sometimes this capability is rather handy when you want to work in 1037Sometimes 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 1038one 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 1039(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: 1040first switches to a locale supported by xjdic and back later:
879 1041
880 printf '\e]701;%s\007' ja_JP.SJIS 1042 printf '\33]701;%s\007' ja_JP.SJIS
881 xjdic -js 1043 xjdic -js
882 printf '\e]701;%s\007' de_DE.UTF-8 1044 printf '\33]701;%s\007' de_DE.UTF-8
883 1045
884You 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
885for some locales where character width differs between program- and 1047for some locales where character width differs between program- and
886rxvt-unicode-locales. 1048rxvt-unicode-locales.
887 1049
… …
905=item - Make sure your XIM server is actually running. 1067=item - Make sure your XIM server is actually running.
906 1068
907=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.
908 1070
909When 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
910C<@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
911method servers are running with this command: 1073method servers are running with this command:
912 1074
913 xprop -root XIM_SERVERS 1075 xprop -root XIM_SERVERS
914 1076
915=item 1077=item
916 1078
917=back 1079=back
918 1080
919=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?
920 1082
… …
960 1122
961=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?
962 1124
963You should build one binary with the default options. F<configure> 1125You should build one binary with the default options. F<configure>
964now enables most useful options, and the trend goes to making them 1126now enables most useful options, and the trend goes to making them
965runtime-switchable, too, so there is usually no drawback to enbaling them, 1127runtime-switchable, too, so there is usually no drawback to enabling them,
966except higher disk and possibly memory usage. The perl interpreter should 1128except higher disk and possibly memory usage. The perl interpreter should
967be enabled, as important functionality (menus, selection, likely more in 1129be enabled, as important functionality (menus, selection, likely more in
968the future) depends on it. 1130the future) depends on it.
969 1131
970You 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
… …
993This 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
994and reduces possible bugs to initialisation code run before main(), or 1156and reduces possible bugs to initialisation code run before main(), or
995things 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
996little risk. 1158little risk.
997 1159
998=head3 On Solaris 9, many line-drawing characters are too wide.
999
1000Seems to be a known bug, read
1001L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
1002following ugly workaround to get non-double-wide-characters working:
1003
1004 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
1005
1006=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.
1007 1161
1008Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1162Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1009in your compile environment, or an implementation that implements it, 1163in your compile environment, or an implementation that implements it,
1010wether 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
1011B<wchar_t> is represented as unicode. 1165B<wchar_t> is represented as unicode.
1012 1166
1013As you might have guessed, FreeBSD does neither define this symobl nor 1167As you might have guessed, FreeBSD does neither define this symbol nor
1014does it support it. Instead, it uses it's own internal representation of 1168does it support it. Instead, it uses its own internal representation of
1015B<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.
1016 1170
1017However, 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
1018C<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>.
1019 1173
… …
1033 1187
1034The 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
1035system 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
1036complete replacements for them :) 1190complete replacements for them :)
1037 1191
1038=head3 I use Solaris 9 and it doesn't compile/work/etc.
1039
1040Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
1041problems with C<wcwidth> and a compile problem.
1042
1043=head3 How can I use rxvt-unicode under cygwin? 1192=head3 How can I use rxvt-unicode under cygwin?
1044 1193
1045rxvt-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
1046the X11 libraries that come with cygwin. libW11 emulation is no 1195the X11 libraries that come with cygwin. libW11 emulation is no
1047longer supported (and makes no sense, either, as it only supported a 1196longer supported (and makes no sense, either, as it only supported a
… …
1050old libW11 emulation. 1199old libW11 emulation.
1051 1200
1052At 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
1053encodings (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
1054to 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
1055 1217
1056=head1 RXVT-UNICODE TECHNICAL REFERENCE 1218=head1 RXVT-UNICODE TECHNICAL REFERENCE
1057 1219
1058The rest of this document describes various technical aspects of 1220The rest of this document describes various technical aspects of
1059B<rxvt-unicode>. First the description of supported command sequences, 1221B<rxvt-unicode>. First the description of supported command sequences,
… …
1553 1715
1554Toggle DEC Private Mode Values (rxvt extension). I<where> 1716Toggle DEC Private Mode Values (rxvt extension). I<where>
1555 1717
1556=over 4 1718=over 4
1557 1719
1558=item B<< C<Ps = 1> >> (DECCKM) 1720=item B<< C<Pm = 1> >> (DECCKM)
1559 1721
1560=begin table 1722=begin table
1561 1723
1562 B<< C<h> >> Application Cursor Keys 1724 B<< C<h> >> Application Cursor Keys
1563 B<< C<l> >> Normal Cursor Keys 1725 B<< C<l> >> Normal Cursor Keys
1564 1726
1565=end table 1727=end table
1566 1728
1567=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1729=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1568 1730
1569=begin table 1731=begin table
1570 1732
1571 B<< C<h> >> Enter VT52 mode 1733 B<< C<h> >> Enter VT52 mode
1572 B<< C<l> >> Enter VT52 mode 1734 B<< C<l> >> Enter VT52 mode
1573 1735
1574=end table 1736=end table
1575 1737
1576=item B<< C<Ps = 3> >> 1738=item B<< C<Pm = 3> >>
1577 1739
1578=begin table 1740=begin table
1579 1741
1580 B<< C<h> >> 132 Column Mode (DECCOLM) 1742 B<< C<h> >> 132 Column Mode (DECCOLM)
1581 B<< C<l> >> 80 Column Mode (DECCOLM) 1743 B<< C<l> >> 80 Column Mode (DECCOLM)
1582 1744
1583=end table 1745=end table
1584 1746
1585=item B<< C<Ps = 4> >> 1747=item B<< C<Pm = 4> >>
1586 1748
1587=begin table 1749=begin table
1588 1750
1589 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1751 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1590 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1752 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1591 1753
1592=end table 1754=end table
1593 1755
1594=item B<< C<Ps = 5> >> 1756=item B<< C<Pm = 5> >>
1595 1757
1596=begin table 1758=begin table
1597 1759
1598 B<< C<h> >> Reverse Video (DECSCNM) 1760 B<< C<h> >> Reverse Video (DECSCNM)
1599 B<< C<l> >> Normal Video (DECSCNM) 1761 B<< C<l> >> Normal Video (DECSCNM)
1600 1762
1601=end table 1763=end table
1602 1764
1603=item B<< C<Ps = 6> >> 1765=item B<< C<Pm = 6> >>
1604 1766
1605=begin table 1767=begin table
1606 1768
1607 B<< C<h> >> Origin Mode (DECOM) 1769 B<< C<h> >> Origin Mode (DECOM)
1608 B<< C<l> >> Normal Cursor Mode (DECOM) 1770 B<< C<l> >> Normal Cursor Mode (DECOM)
1609 1771
1610=end table 1772=end table
1611 1773
1612=item B<< C<Ps = 7> >> 1774=item B<< C<Pm = 7> >>
1613 1775
1614=begin table 1776=begin table
1615 1777
1616 B<< C<h> >> Wraparound Mode (DECAWM) 1778 B<< C<h> >> Wraparound Mode (DECAWM)
1617 B<< C<l> >> No Wraparound Mode (DECAWM) 1779 B<< C<l> >> No Wraparound Mode (DECAWM)
1618 1780
1619=end table 1781=end table
1620 1782
1621=item B<< C<Ps = 8> >> I<unimplemented> 1783=item B<< C<Pm = 8> >> I<unimplemented>
1622 1784
1623=begin table 1785=begin table
1624 1786
1625 B<< C<h> >> Auto-repeat Keys (DECARM) 1787 B<< C<h> >> Auto-repeat Keys (DECARM)
1626 B<< C<l> >> No Auto-repeat Keys (DECARM) 1788 B<< C<l> >> No Auto-repeat Keys (DECARM)
1627 1789
1628=end table 1790=end table
1629 1791
1630=item B<< C<Ps = 9> >> X10 XTerm 1792=item B<< C<Pm = 9> >> X10 XTerm
1631 1793
1632=begin table 1794=begin table
1633 1795
1634 B<< C<h> >> Send Mouse X & Y on button press. 1796 B<< C<h> >> Send Mouse X & Y on button press.
1635 B<< C<l> >> No mouse reporting. 1797 B<< C<l> >> No mouse reporting.
1636 1798
1637=end table 1799=end table
1638 1800
1639=item B<< C<Ps = 25> >> 1801=item B<< C<Pm = 25> >>
1640 1802
1641=begin table 1803=begin table
1642 1804
1643 B<< C<h> >> Visible cursor {cnorm/cvvis} 1805 B<< C<h> >> Visible cursor {cnorm/cvvis}
1644 B<< C<l> >> Invisible cursor {civis} 1806 B<< C<l> >> Invisible cursor {civis}
1645 1807
1646=end table 1808=end table
1647 1809
1648=item B<< C<Ps = 30> >> 1810=item B<< C<Pm = 30> >>
1649 1811
1650=begin table 1812=begin table
1651 1813
1652 B<< C<h> >> scrollBar visisble 1814 B<< C<h> >> scrollBar visisble
1653 B<< C<l> >> scrollBar invisisble 1815 B<< C<l> >> scrollBar invisisble
1654 1816
1655=end table 1817=end table
1656 1818
1657=item B<< C<Ps = 35> >> (B<rxvt>) 1819=item B<< C<Pm = 35> >> (B<rxvt>)
1658 1820
1659=begin table 1821=begin table
1660 1822
1661 B<< C<h> >> Allow XTerm Shift+key sequences 1823 B<< C<h> >> Allow XTerm Shift+key sequences
1662 B<< C<l> >> Disallow XTerm Shift+key sequences 1824 B<< C<l> >> Disallow XTerm Shift+key sequences
1663 1825
1664=end table 1826=end table
1665 1827
1666=item B<< C<Ps = 38> >> I<unimplemented> 1828=item B<< C<Pm = 38> >> I<unimplemented>
1667 1829
1668Enter Tektronix Mode (DECTEK) 1830Enter Tektronix Mode (DECTEK)
1669 1831
1670=item B<< C<Ps = 40> >> 1832=item B<< C<Pm = 40> >>
1671 1833
1672=begin table 1834=begin table
1673 1835
1674 B<< C<h> >> Allow 80/132 Mode 1836 B<< C<h> >> Allow 80/132 Mode
1675 B<< C<l> >> Disallow 80/132 Mode 1837 B<< C<l> >> Disallow 80/132 Mode
1676 1838
1677=end table 1839=end table
1678 1840
1679=item B<< C<Ps = 44> >> I<unimplemented> 1841=item B<< C<Pm = 44> >> I<unimplemented>
1680 1842
1681=begin table 1843=begin table
1682 1844
1683 B<< C<h> >> Turn On Margin Bell 1845 B<< C<h> >> Turn On Margin Bell
1684 B<< C<l> >> Turn Off Margin Bell 1846 B<< C<l> >> Turn Off Margin Bell
1685 1847
1686=end table 1848=end table
1687 1849
1688=item B<< C<Ps = 45> >> I<unimplemented> 1850=item B<< C<Pm = 45> >> I<unimplemented>
1689 1851
1690=begin table 1852=begin table
1691 1853
1692 B<< C<h> >> Reverse-wraparound Mode 1854 B<< C<h> >> Reverse-wraparound Mode
1693 B<< C<l> >> No Reverse-wraparound Mode 1855 B<< C<l> >> No Reverse-wraparound Mode
1694 1856
1695=end table 1857=end table
1696 1858
1697=item B<< C<Ps = 46> >> I<unimplemented> 1859=item B<< C<Pm = 46> >> I<unimplemented>
1698 1860
1699=item B<< C<Ps = 47> >> 1861=item B<< C<Pm = 47> >>
1700 1862
1701=begin table 1863=begin table
1702 1864
1703 B<< C<h> >> Use Alternate Screen Buffer 1865 B<< C<h> >> Use Alternate Screen Buffer
1704 B<< C<l> >> Use Normal Screen Buffer 1866 B<< C<l> >> Use Normal Screen Buffer
1705 1867
1706=end table 1868=end table
1707 1869
1708X<Priv66> 1870X<Priv66>
1709 1871
1710=item B<< C<Ps = 66> >> 1872=item B<< C<Pm = 66> >>
1711 1873
1712=begin table 1874=begin table
1713 1875
1714 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1876 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1715 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1877 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1716 1878
1717=end table 1879=end table
1718 1880
1719=item B<< C<Ps = 67> >> 1881=item B<< C<Pm = 67> >>
1720 1882
1721=begin table 1883=begin table
1722 1884
1723 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1885 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1724 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1886 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1725 1887
1726=end table 1888=end table
1727 1889
1728=item B<< C<Ps = 1000> >> (X11 XTerm) 1890=item B<< C<Pm = 1000> >> (X11 XTerm)
1729 1891
1730=begin table 1892=begin table
1731 1893
1732 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.
1733 B<< C<l> >> No mouse reporting. 1895 B<< C<l> >> No mouse reporting.
1734 1896
1735=end table 1897=end table
1736 1898
1737=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1899=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1738 1900
1739=begin table 1901=begin table
1740 1902
1741 B<< C<h> >> Use Hilite Mouse Tracking. 1903 B<< C<h> >> Use Hilite Mouse Tracking.
1742 B<< C<l> >> No mouse reporting. 1904 B<< C<l> >> No mouse reporting.
1743 1905
1744=end table 1906=end table
1745 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
1746=item B<< C<Ps = 1010> >> (B<rxvt>) 1926=item B<< C<Pm = 1010> >> (B<rxvt>)
1747 1927
1748=begin table 1928=begin table
1749 1929
1750 B<< C<h> >> Don't scroll to bottom on TTY output 1930 B<< C<h> >> Don't scroll to bottom on TTY output
1751 B<< C<l> >> Scroll to bottom on TTY output 1931 B<< C<l> >> Scroll to bottom on TTY output
1752 1932
1753=end table 1933=end table
1754 1934
1755=item B<< C<Ps = 1011> >> (B<rxvt>) 1935=item B<< C<Pm = 1011> >> (B<rxvt>)
1756 1936
1757=begin table 1937=begin table
1758 1938
1759 B<< C<h> >> Scroll to bottom when a key is pressed 1939 B<< C<h> >> Scroll to bottom when a key is pressed
1760 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
1761 1941
1762=end table 1942=end table
1763 1943
1764=item B<< C<Ps = 1021> >> (B<rxvt>) 1944=item B<< C<Pm = 1021> >> (B<rxvt>)
1765 1945
1766=begin table 1946=begin table
1767 1947
1768 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>)
1769 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)
1770 1950
1771=end table 1951=end table
1772 1952
1773=item B<< C<Ps = 1047> >> 1953=item B<< C<Pm = 1047> >>
1774 1954
1775=begin table 1955=begin table
1776 1956
1777 B<< C<h> >> Use Alternate Screen Buffer 1957 B<< C<h> >> Use Alternate Screen Buffer
1778 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
1779 1959
1780=end table 1960=end table
1781 1961
1782=item B<< C<Ps = 1048> >> 1962=item B<< C<Pm = 1048> >>
1783 1963
1784=begin table 1964=begin table
1785 1965
1786 B<< C<h> >> Save cursor position 1966 B<< C<h> >> Save cursor position
1787 B<< C<l> >> Restore cursor position 1967 B<< C<l> >> Restore cursor position
1788 1968
1789=end table 1969=end table
1790 1970
1791=item B<< C<Ps = 1049> >> 1971=item B<< C<Pm = 1049> >>
1792 1972
1793=begin table 1973=begin table
1794 1974
1795 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
1796 B<< C<l> >> Use Normal Screen Buffer 1976 B<< C<l> >> Use Normal Screen Buffer
… …
1825 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> >>
1826 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> >>
1827 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> >>
1828 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]
1829 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]
1830 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).
1831 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> >>.
1832 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>
1833 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> >>.
1834 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> >>
1835 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> >>
… …
1849 2029
1850=end table 2030=end table
1851 2031
1852=back 2032=back
1853 2033
1854=head1 XPM 2034=head1 BACKGROUND IMAGE
1855 2035
1856For 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
1857of 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
1858sequence of scaling/positioning commands separated by semi-colons. The 2038sequence of scaling/positioning commands separated by semi-colons. The
1859scaling/positioning commands are as follows: 2039scaling/positioning commands are as follows:
1860 2040
1861=over 4 2041=over 4
1862 2042
… …
1900 2080
1901For example: 2081For example:
1902 2082
1903=over 4 2083=over 4
1904 2084
1905=item B<\E]20;funky\a> 2085=item B<\E]20;funky.jpg\a>
1906 2086
1907load B<funky.xpm> as a tiled image 2087load B<funky.jpg> as a tiled image
1908 2088
1909=item B<\E]20;mona;100\a> 2089=item B<\E]20;mona.jpg;100\a>
1910 2090
1911load B<mona.xpm> with a scaling of 100% 2091load B<mona.jpg> with a scaling of 100%
1912 2092
1913=item B<\E]20;;200;?\a> 2093=item B<\E]20;;200;?\a>
1914 2094
1915rescale the current pixmap to 200% and display the image geometry in 2095rescale the current pixmap to 200% and display the image geometry in
1916the title 2096the title
… …
2043 2223
2044=head1 CONFIGURE OPTIONS 2224=head1 CONFIGURE OPTIONS
2045 2225
2046General hint: if you get compile errors, then likely your configuration 2226General hint: if you get compile errors, then likely your configuration
2047hasn'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
2048the 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>
2049myself, so it should generally be a working config. Of course, you should 2229switches). Of course, you should always report when a combination doesn't
2050always report when a combination doesn't work, so it can be fixed. Marc 2230work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2051Lehmann <rxvt@schmorp.de>.
2052 2231
2053All 2232All
2054 2233
2055=over 4 2234=over 4
2056 2235
… …
2088 2267
2089=begin table 2268=begin table
2090 2269
2091 all all available codeset groups 2270 all all available codeset groups
2092 zh common chinese encodings 2271 zh common chinese encodings
2093 zh_ext rarely used but very big chinese encodigs 2272 zh_ext rarely used but very big chinese encodings
2094 jp common japanese encodings 2273 jp common japanese encodings
2095 jp_ext rarely used but big japanese encodings 2274 jp_ext rarely used but big japanese encodings
2096 kr korean encodings 2275 kr korean encodings
2097 2276
2098=end table 2277=end table
… …
2112requirements 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
2113support these extra characters, but Xft does. 2292support these extra characters, but Xft does.
2114 2293
2115Please note that rxvt-unicode can store unicode code points >65535 2294Please note that rxvt-unicode can store unicode code points >65535
2116even without this flag, but the number of such characters is 2295even without this flag, but the number of such characters is
2117limited to a view thousand (shared with combining characters, 2296limited to a few thousand (shared with combining characters,
2118see next switch), and right now rxvt-unicode cannot display them 2297see next switch), and right now rxvt-unicode cannot display them
2119(input/output and cut&paste still work, though). 2298(input/output and cut&paste still work, though).
2120 2299
2121=item --enable-combining (default: on) 2300=item --enable-combining (default: on)
2122 2301
… …
2145=item --with-res-name=NAME (default: urxvt) 2324=item --with-res-name=NAME (default: urxvt)
2146 2325
2147Use the given name as default application name when 2326Use the given name as default application name when
2148reading resources. Specify --with-res-name=rxvt to replace rxvt. 2327reading resources. Specify --with-res-name=rxvt to replace rxvt.
2149 2328
2150=item --with-res-class=CLASS /default: URxvt) 2329=item --with-res-class=CLASS (default: URxvt)
2151 2330
2152Use the given class as default application class 2331Use the given class as default application class
2153when reading resources. Specify --with-res-class=Rxvt to replace 2332when reading resources. Specify --with-res-class=Rxvt to replace
2154rxvt. 2333rxvt.
2155 2334
… …
2168 2347
2169Write user and tty to lastlog file (used by programs like 2348Write user and tty to lastlog file (used by programs like
2170F<lastlogin>) at start of rxvt execution. This option requires 2349F<lastlogin>) at start of rxvt execution. This option requires
2171--enable-utmp to also be specified. 2350--enable-utmp to also be specified.
2172 2351
2173=item --enable-xpm-background (default: on) 2352=item --enable-afterimage (default: on)
2174 2353
2175Add 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.
2176 2366
2177=item --enable-transparency (default: on) 2367=item --enable-transparency (default: on)
2178 2368
2179Add support for inheriting parent backgrounds thus giving a fake 2369Add support for backgrounds, creating illusion of transparency in the term.
2180transparency to the term.
2181 2370
2182=item --enable-fading (default: on) 2371=item --enable-fading (default: on)
2183 2372
2184Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2373Add support for fading the text when focus is lost.
2185
2186=item --enable-tinting (default: on)
2187
2188Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2189 2374
2190=item --enable-rxvt-scroll (default: on) 2375=item --enable-rxvt-scroll (default: on)
2191 2376
2192Add support for the original rxvt scrollbar. 2377Add support for the original rxvt scrollbar.
2193 2378
… …
2236A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2421A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2237in combination with other switches) is: 2422in combination with other switches) is:
2238 2423
2239 MWM-hints 2424 MWM-hints
2240 EWMH-hints (pid, utf8 names) and protocols (ping) 2425 EWMH-hints (pid, utf8 names) and protocols (ping)
2426 urgency hint
2241 seperate underline colour (-underlineColor) 2427 seperate underline colour (-underlineColor)
2242 settable border widths and borderless switch (-w, -b, -bl) 2428 settable border widths and borderless switch (-w, -b, -bl)
2243 visual depth selection (-depth) 2429 visual depth selection (-depth)
2244 settable extra linespacing /-lsp) 2430 settable extra linespacing /-lsp)
2245 iso-14755-2 and -3, and visual feedback 2431 iso-14755 5.1 (basic) support
2246 tripleclickwords (-tcw) 2432 tripleclickwords (-tcw)
2247 settable insecure mode (-insecure) 2433 settable insecure mode (-insecure)
2248 keysym remapping support 2434 keysym remapping support
2249 cursor blinking and underline cursor (-cb, -uc) 2435 cursor blinking and underline cursor (-cb, -uc)
2250 XEmbed support (-embed) 2436 XEmbed support (-embed)
2251 user-pty (-pty-fd) 2437 user-pty (-pty-fd)
2252 hold on exit (-hold) 2438 hold on exit (-hold)
2439 compile in built-in block graphics
2253 skip builtin block graphics (-sbg) 2440 skip builtin block graphics (-sbg)
2441 separate highlightcolor support (-hc)
2254 2442
2255It also enabled some non-essential features otherwise disabled, such as: 2443It also enables some non-essential features otherwise disabled, such as:
2256 2444
2257 some round-trip time optimisations 2445 some round-trip time optimisations
2258 nearest color allocation on pseudocolor screens 2446 nearest color allocation on pseudocolor screens
2259 UTF8_STRING supporr for selection 2447 UTF8_STRING support for selection
2260 sgr modes 90..97 and 100..107 2448 sgr modes 90..97 and 100..107
2261 backindex and forwardindex escape sequences 2449 backindex and forwardindex escape sequences
2262 view change/zero scorllback esacpe sequences 2450 view change/zero scrollback escape sequences
2263 locale switching escape sequence 2451 locale switching escape sequence
2264 window op and some xterm/OSC escape sequences 2452 window op and some xterm/OSC escape sequences
2265 rectangular selections 2453 rectangular selections
2266 trailing space removal for selections 2454 trailing space removal for selections
2267 verbose X error handling 2455 verbose X error handling
… …
2276=item --enable-keepscrolling (default: on) 2464=item --enable-keepscrolling (default: on)
2277 2465
2278Add support for continual scrolling of the display when you hold 2466Add support for continual scrolling of the display when you hold
2279the mouse button down on a scrollbar arrow. 2467the mouse button down on a scrollbar arrow.
2280 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
2281=item --enable-mousewheel (default: on) 2474=item --enable-mousewheel (default: on)
2282 2475
2283Add support for scrolling via mouse wheel or buttons 4 & 5. 2476Add support for scrolling via mouse wheel or buttons 4 & 5.
2284 2477
2285=item --enable-slipwheeling (default: on) 2478=item --enable-slipwheeling (default: on)
2286 2479
2287Add support for continual scrolling (using the mouse wheel as an 2480Add support for continual scrolling (using the mouse wheel as an
2288accelerator) while the control key is held down. This option 2481accelerator) while the control key is held down. This option
2289requires --enable-mousewheel to also be specified. 2482requires --enable-mousewheel to also be specified.
2290 2483
2291=item --disable-new-selection
2292
2293Remove support for mouse selection style like that of xterm.
2294
2295=item --enable-dmalloc (default: off)
2296
2297Use Gray Watson's malloc - which is good for debugging See
2298L<http://www.letters.com/dmalloc/> for details If you use either this or the
2299next option, you may need to edit src/Makefile after compiling to point
2300DINCLUDE and DLIB to the right places.
2301
2302You can only use either this option and the following (should
2303you use either) .
2304
2305=item --enable-dlmalloc (default: off)
2306
2307Use Doug Lea's malloc - which is good for a production version
2308See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2309
2310=item --enable-smart-resize (default: on) 2484=item --enable-smart-resize (default: off)
2311 2485
2312Add smart growth/shrink behaviour when changing font size via hot 2486Add smart growth/shrink behaviour when resizing.
2313keys. 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
2314the screen in a fixed position. 2488the screen in a fixed position.
2315 2489
2490=item --enable-text-blink (default: on)
2491
2492Add support for blinking text.
2493
2316=item --enable-pointer-blank (default: on) 2494=item --enable-pointer-blank (default: on)
2317 2495
2318Add support to have the pointer disappear when typing or inactive. 2496Add support to have the pointer disappear when typing or inactive.
2319 2497
2320=item --enable-perl (default: on) 2498=item --enable-perl (default: on)
2321 2499
2322Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2500Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2323manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files 2501manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the
2324in F<src/perl-ext/> for the extensions that are installed by default. The 2502files in F<src/perl-ext/> for the extensions that are installed by
2325perl interpreter that is used can be specified via the C<PERL> environment 2503default. The perl interpreter that is used can be specified via the
2326variable when running configure. 2504C<PERL> environment variable when running configure. Even when compiled
2505in, perl will I<not> be initialised when all extensions have been disabled
2506C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2507resource standpoint.
2508
2509=item --with-afterimage-config=DIR
2510
2511Look for the libAfterImage config script in DIR.
2327 2512
2328=item --with-name=NAME (default: urxvt) 2513=item --with-name=NAME (default: urxvt)
2329 2514
2330Set the basename for the installed binaries, resulting 2515Set the basename for the installed binaries, resulting
2331in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2516in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
… …
2341PATH. 2526PATH.
2342 2527
2343=item --with-x 2528=item --with-x
2344 2529
2345Use the X Window System (pretty much default, eh?). 2530Use the X Window System (pretty much default, eh?).
2346
2347=item --with-xpm-includes=DIR
2348
2349Look for the XPM includes in DIR.
2350
2351=item --with-xpm-library=DIR
2352
2353Look for the XPM library in DIR.
2354
2355=item --with-xpm
2356
2357Not needed - define via --enable-xpm-background.
2358 2531
2359=back 2532=back
2360 2533
2361=head1 AUTHORS 2534=head1 AUTHORS
2362 2535

Diff Legend

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