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.107 by root, Tue Jan 31 21:04:14 2006 UTC vs.
Revision 1.135 by ayin, Sun Jun 24 23:30:17 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?
79
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:
82
83 #!/bin/sh
84 @@URXVT_NAME@@c "$@"
85 if [ $? -eq 2 ]; then
86 @@URXVT_NAME@@d -q -o -f
87 @@URXVT_NAME@@c "$@"
88 fi
89
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
92re-run the command. Subsequent invocations of the script will re-use the
93existing daemon.
94
78=head3 How do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc. 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.
79 96
80The original rxvt and rxvt-unicode always export the variable "COLORTERM", 97The original rxvt and rxvt-unicode always export the variable "COLORTERM",
81so 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,
82slrn, Midnight Commander automatically check this variable to decide 99slrn, Midnight Commander automatically check this variable to decide
83whether or not to use color. 100whether or not to use color.
108 fi 125 fi
109 126
110=head3 How do I compile the manual pages on my own? 127=head3 How do I compile the manual pages on my own?
111 128
112You 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>,
113one 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
114the doc subdirectory and enter C<make alldoc>. 131F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
115 132
116=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?
117 134
118I 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
119bloat. 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
127 98398 1664 24 15695 1824 rxvt --disable-everything 144 98398 1664 24 15695 1824 rxvt --disable-everything
128 188985 9048 66616 18222 1788 urxvt --disable-everything 145 188985 9048 66616 18222 1788 urxvt --disable-everything
129 146
130When 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
131and 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
132libc), the two diverge, but not unreasnobaly so. 149libc), the two diverge, but not unreasonably so.
133 150
134 text data bss drs rss filename 151 text data bss drs rss filename
135 163431 2152 24 20123 2060 rxvt --enable-everything 152 163431 2152 24 20123 2060 rxvt --enable-everything
136 1035683 49680 66648 29096 3680 urxvt --enable-everything 153 1035683 49680 66648 29096 3680 urxvt --enable-everything
137 154
224 241
225 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc 242 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
226 243
227This requires XFT support, and the support of your X-server. If that 244This requires XFT support, and the support of your X-server. If that
228doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't 245doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
229there yet, no matter what they claim. Rxvt-Unicode contains the neccessary 246there yet, no matter what they claim. Rxvt-Unicode contains the necessary
230bugfixes and workarounds for Xft and Xlib to make it work, but that 247bugfixes and workarounds for Xft and Xlib to make it work, but that
231doesn't mean that your WM has the required kludges in place. 248doesn't mean that your WM has the required kludges in place.
232 249
2334. Use xcompmgr and let it do the job: 2504. Use xcompmgr and let it do the job:
234 251
236 -set _NET_WM_WINDOW_OPACITY 0xc0000000 253 -set _NET_WM_WINDOW_OPACITY 0xc0000000
237 254
238Then click on a window you want to make transparent. Replace C<0xc0000000> 255Then click on a window you want to make transparent. Replace C<0xc0000000>
239by other values to change the degree of opacity. If it doesn't work and 256by other values to change the degree of opacity. If it doesn't work and
240your server crashes, you got to keep the pieces. 257your server crashes, you got to keep the pieces.
241
242=head3 Why do some chinese characters look so different than others?
243
244This is because there is a difference between script and language --
245rxvt-unicode does not know which language the text that is output is,
246as it only knows the unicode character codes. If rxvt-unicode first
247sees a japanese/chinese character, it might choose a japanese font for
248display. Subsequent japanese characters will use that font. Now, many
249chinese characters aren't represented in japanese fonts, so when the first
250non-japanese character comes up, rxvt-unicode will look for a chinese font
251-- unfortunately at this point, it will still use the japanese font for
252chinese characters that are also in the japanese font.
253
254The workaround is easy: just tag a chinese font at the end of your font
255list (see the previous question). The key is to view the font list as
256a preference list: If you expect more japanese, list a japanese font
257first. If you expect more chinese, put a chinese font first.
258
259In the future it might be possible to switch language preferences at
260runtime (the internal data structure has no problem with using different
261fonts for the same character at the same time, but no interface for this
262has been designed yet).
263
264Until then, you might get away with switching fonts at runtime (see L<Can
265I switch the fonts at runtime?> later in this document).
266 258
267=head3 Why does rxvt-unicode sometimes leave pixel droppings? 259=head3 Why does rxvt-unicode sometimes leave pixel droppings?
268 260
269Most fonts were not designed for terminal use, which means that character 261Most fonts were not designed for terminal use, which means that character
270size varies a lot. A font that is otherwise fine for terminal use might 262size varies a lot. A font that is otherwise fine for terminal use might
276however: Xft fonts often draw glyphs larger than their acclaimed bounding 268however: Xft fonts often draw glyphs larger than their acclaimed bounding
277box, and rxvt-unicode has no way of detecting this (the correct way is to 269box, and rxvt-unicode has no way of detecting this (the correct way is to
278ask for the character bounding box, which unfortunately is wrong in these 270ask for the character bounding box, which unfortunately is wrong in these
279cases). 271cases).
280 272
281It's not clear (to me at least), wether this is a bug in Xft, freetype, 273It's not clear (to me at least), whether this is a bug in Xft, freetype,
282or the respective font. If you encounter this problem you might try using 274or the respective font. If you encounter this problem you might try using
283the C<-lsp> option to give the font more height. If that doesn't work, you 275the C<-lsp> option to give the font more height. If that doesn't work, you
284might be forced to use a different font. 276might be forced to use a different font.
285 277
286All of this is not a problem when using X11 core fonts, as their bounding 278All of this is not a problem when using X11 core fonts, as their bounding
310=head3 Can I switch the fonts at runtime? 302=head3 Can I switch the fonts at runtime?
311 303
312Yes, using an escape sequence. Try something like this, which has the same 304Yes, using an escape sequence. Try something like this, which has the same
313effect as using the C<-fn> switch, and takes effect immediately: 305effect as using the C<-fn> switch, and takes effect immediately:
314 306
315 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" 307 printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
316 308
317This is useful if you e.g. work primarily with japanese (and prefer a 309This is useful if you e.g. work primarily with japanese (and prefer a
318japanese font), but you have to switch to chinese temporarily, where 310japanese font), but you have to switch to chinese temporarily, where
319japanese fonts would only be in your way. 311japanese fonts would only be in your way.
320 312
322 314
323=head3 Why do italic characters look as if clipped? 315=head3 Why do italic characters look as if clipped?
324 316
325Many fonts have difficulties with italic characters and hinting. For 317Many fonts have difficulties with italic characters and hinting. For
326example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans 318example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
327Mono> completely fails in it's italic face. A workaround might be to 319Mono> completely fails in its italic face. A workaround might be to
328enable freetype autohinting, i.e. like this: 320enable freetype autohinting, i.e. like this:
329 321
330 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 322 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
331 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 323 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
332 324
338memory and also speeds up rendering considerably. 330memory and also speeds up rendering considerably.
339 331
340=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 332=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
341 333
342Rxvt-unicode will use whatever you specify as a font. If it needs to 334Rxvt-unicode will use whatever you specify as a font. If it needs to
343fall back to it's default font search list it will prefer X11 core 335fall back to its default font search list it will prefer X11 core
344fonts, because they are small and fast, and then use Xft fonts. It has 336fonts, because they are small and fast, and then use Xft fonts. It has
345antialiasing disabled for most of them, because the author thinks they 337antialiasing disabled for most of them, because the author thinks they
346look best that way. 338look best that way.
347 339
348If you want antialiasing, you have to specify the fonts manually. 340If you want antialiasing, you have to specify the fonts manually.
409 URxvt.color6: #73f7ff 401 URxvt.color6: #73f7ff
410 URxvt.color14: #73f7ff 402 URxvt.color14: #73f7ff
411 URxvt.color7: #e1dddd 403 URxvt.color7: #e1dddd
412 URxvt.color15: #e1dddd 404 URxvt.color15: #e1dddd
413 405
414(They were described (not by me) as "pretty girly"). 406They have been described (not by me) as "pretty girly".
415 407
416=head3 Why do some characters look so much different than others? 408=head3 Why do some characters look so much different than others?
417 409
418See next entry. 410See next entry.
419 411
420=head3 How does rxvt-unicode choose fonts? 412=head3 How does rxvt-unicode choose fonts?
421 413
422Most fonts do not contain the full range of Unicode, which is 414Most fonts do not contain the full range of Unicode, which is
423fine. Chances are that the font you (or the admin/package maintainer of 415fine. Chances are that the font you (or the admin/package maintainer of
424your system/os) have specified does not cover all the characters you want 416your system/os) have specified does not cover all the characters you want
425to display. 417to display.
426 418
427B<rxvt-unicode> makes a best-effort try at finding a replacement 419B<rxvt-unicode> makes a best-effort try at finding a replacement
428font. Often the result is fine, but sometimes the chosen font looks 420font. Often the result is fine, but sometimes the chosen font looks
429bad/ugly/wrong. Some fonts have totally strange characters that don't 421bad/ugly/wrong. Some fonts have totally strange characters that don't
430resemble the correct glyph at all, and rxvt-unicode lacks the artificial 422resemble the correct glyph at all, and rxvt-unicode lacks the artificial
431intelligence to detect that a specific glyph is wrong: it has to believe 423intelligence to detect that a specific glyph is wrong: it has to believe
432the font that the characters it claims to contain indeed look correct. 424the font that the characters it claims to contain indeed look correct.
433 425
434In that case, select a font of your taste and add it to the font list, 426In that case, select a font of your taste and add it to the font list,
435e.g.: 427e.g.:
436 428
437 @@URXVT_NAME@@ -fn basefont,font2,font3... 429 @@URXVT_NAME@@ -fn basefont,font2,font3...
438 430
439When rxvt-unicode sees a character, it will first look at the base 431When rxvt-unicode sees a character, it will first look at the base
440font. If the base font does not contain the character, it will go to the 432font. If the base font does not contain the character, it will go to the
441next font, and so on. Specifying your own fonts will also speed up this 433next font, and so on. Specifying your own fonts will also speed up this
442search and use less resources within rxvt-unicode and the X-server. 434search and use less resources within rxvt-unicode and the X-server.
443 435
444The only limitation is that none of the fonts may be larger than the base 436The only limitation is that none of the fonts may be larger than the base
445font, as the base font defines the terminal character cell size, which 437font, as the base font defines the terminal character cell size, which
446must be the same due to the way terminals work. 438must be the same due to the way terminals work.
447 439
440=head3 Why do some chinese characters look so different than others?
441
442This is because there is a difference between script and language --
443rxvt-unicode does not know which language the text that is output is,
444as it only knows the unicode character codes. If rxvt-unicode first
445sees a japanese/chinese character, it might choose a japanese font for
446display. Subsequent japanese characters will use that font. Now, many
447chinese characters aren't represented in japanese fonts, so when the first
448non-japanese character comes up, rxvt-unicode will look for a chinese font
449-- unfortunately at this point, it will still use the japanese font for
450chinese characters that are also in the japanese font.
451
452The workaround is easy: just tag a chinese font at the end of your font
453list (see the previous question). The key is to view the font list as
454a preference list: If you expect more japanese, list a japanese font
455first. If you expect more chinese, put a chinese font first.
456
457In the future it might be possible to switch language preferences at
458runtime (the internal data structure has no problem with using different
459fonts for the same character at the same time, but no interface for this
460has been designed yet).
461
462Until then, you might get away with switching fonts at runtime (see L<Can
463I switch the fonts at runtime?> later in this document).
448 464
449=head2 Keyboard, Mouse & User Interaction 465=head2 Keyboard, Mouse & User Interaction
450 466
451=head3 The new selection selects pieces that are too big, how can I select single words? 467=head3 The new selection selects pieces that are too big, how can I select single words?
452 468
496circumstances, it will move your cursor around when you click into the 512circumstances, it will move your cursor around when you click into the
497line that contains it. It tries hard not to do this at the wrong moment, 513line that contains it. It tries hard not to do this at the wrong moment,
498but when running a program that doesn't parse cursor movements or in some 514but when running a program that doesn't parse cursor movements or in some
499cases during rlogin sessions, it fails to detect this properly. 515cases during rlogin sessions, it fails to detect this properly.
500 516
501You can permamently switch this feature off by disabling the C<readline> 517You can permanently switch this feature off by disabling the C<readline>
502extension: 518extension:
503 519
504 URxvt.perl-ext-common: default,-readline 520 URxvt.perl-ext-common: default,-readline
505 521
506=head3 My numerical keypad acts weird and generates differing output? 522=head3 My numerical keypad acts weird and generates differing output?
507 523
508Some Debian GNUL/Linux users seem to have this problem, although no 524Some Debian GNUL/Linux users seem to have this problem, although no
509specific details were reported so far. It is possible that this is caused 525specific details were reported so far. It is possible that this is caused
510by the wrong C<TERM> setting, although the details of wether and how 526by the wrong C<TERM> setting, although the details of whether and how
511this can happen are unknown, as C<TERM=rxvt> should offer a compatible 527this can happen are unknown, as C<TERM=rxvt> should offer a compatible
512keymap. See the answer to the previous question, and please report if that 528keymap. See the answer to the previous question, and please report if that
513helped. 529helped.
514 530
515=head3 My Compose (Multi_key) key is no longer working. 531=head3 My Compose (Multi_key) key is no longer working.
541depressed. 557depressed.
542 558
543=head3 What's with the strange Backspace/Delete key behaviour? 559=head3 What's with the strange Backspace/Delete key behaviour?
544 560
545Assuming that the physical Backspace key corresponds to the 561Assuming that the physical Backspace key corresponds to the
546BackSpace keysym (not likely for Linux ... see the following 562Backspace keysym (not likely for Linux ... see the following
547question) there are two standard values that can be used for 563question) there are two standard values that can be used for
548Backspace: C<^H> and C<^?>. 564Backspace: C<^H> and C<^?>.
549 565
550Historically, either value is correct, but rxvt-unicode adopts the debian 566Historically, either value is correct, but rxvt-unicode adopts the debian
551policy of using C<^?> when unsure, because it's the one only only correct 567policy of using C<^?> when unsure, because it's the one and only correct
552choice :). 568choice :).
553 569
554Rxvt-unicode tries to inherit the current stty settings and uses the value 570Rxvt-unicode tries to inherit the current stty settings and uses the value
555of `erase' to guess the value for backspace. If rxvt-unicode wasn't 571of `erase' to guess the value for backspace. If rxvt-unicode wasn't
556started from a terminal (say, from a menu or by remote shell), then the 572started from a terminal (say, from a menu or by remote shell), then the
642 658
643 659
644 660
645=head2 Terminal Configuration 661=head2 Terminal Configuration
646 662
663=head3 Can I see a typical configuration?
664
665The default configuration tries to be xterm-like, which I don't like that
666much, but it's least surprise to regular users.
667
668As a rxvt or rxvt-unicode user, you are practically supposed to invest
669time into customising your terminal. To get you started, here is the
670author's .Xdefaults entries, with comments on what they do. It's certainly
671not I<typical>, but what's typical...
672
673 URxvt.cutchars: "()*,<>[]{}|'
674 URxvt.print-pipe: cat >/tmp/xxx
675
676These are just for testing stuff.
677
678 URxvt.imLocale: ja_JP.UTF-8
679 URxvt.preeditType: OnTheSpot,None
680
681This tells rxvt-unicode to use a special locale when communicating with
682the X Input Method, and also tells it to only use the OnTheSpot pre-edit
683type, which requires the C<xim-onthespot> perl extension but rewards me
684with correct-looking fonts.
685
686 URxvt.perl-lib: /root/lib/urxvt
687 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
688 URxvt.selection.pattern-0: ( at .*? line \\d+)
689 URxvt.selection.pattern-1: ^(/[^:]+):\
690 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
691 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
692
693This is my perl configuration. The first two set the perl library
694directory and also tells urxvt to use a large number of extensions. I
695develop for myself mostly, so I actually use most of the extensions I
696write.
697
698The selection stuff mainly makes the selection perl-error-message aware
699and tells it to convert perl error messages into vi-commands to load the
700relevant file and go tot he error line number.
701
702 URxvt.scrollstyle: plain
703 URxvt.secondaryScroll: true
704
705As the documentation says: plain is the preferred scrollbar for the
706author. The C<secondaryScroll> configures urxvt to scroll in full-screen
707apps, like screen, so lines scrolled out of screen end up in urxvt's
708scrollback buffer.
709
710 URxvt.background: #000000
711 URxvt.foreground: gray90
712 URxvt.color7: gray90
713 URxvt.colorBD: #ffffff
714 URxvt.cursorColor: #e0e080
715 URxvt.throughColor: #8080f0
716 URxvt.highlightColor: #f0f0f0
717
718Some colours. Not sure which ones are being used or even non-defaults, but
719these are in my .Xdefaults. Most notably, they set foreground/background
720to light gray/black, and also make sure that the colour 7 matches the
721default foreground colour.
722
723 URxvt.underlineColor: yellow
724
725Another colour, makes underline lines look different. Sometimes hurts, but
726is mostly a nice effect.
727
728 URxvt.geometry: 154x36
729 URxvt.loginShell: false
730 URxvt.meta: ignore
731 URxvt.utmpInhibit: true
732
733Uh, well, should be mostly self-explanatory. By specifying some defaults
734manually, I can quickly switch them for testing.
735
736 URxvt.saveLines: 8192
737
738A large scrollback buffer is essential. Really.
739
740 URxvt.mapAlert: true
741
742The only case I use it is for my IRC window, which I like to keep
743iconified till people msg me (which beeps).
744
745 URxvt.visualBell: true
746
747The audible bell is often annoying, especially when in a crowd.
748
749 URxvt.insecure: true
750
751Please don't hack my mutt! Ooops...
752
753 URxvt.pastableTabs: false
754
755I once thought this is a great idea.
756
757 urxvt.font: 9x15bold,\
758 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
759 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
760 [codeset=JISX0208]xft:Kochi Gothic, \
761 xft:Bitstream Vera Sans Mono:autohint=true, \
762 xft:Code2000:antialias=false
763 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
764 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
765 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
766
767I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
768overwhelmed. A special note: the C<9x15bold> mentioned above is actually
769the version from XFree-3.3, as XFree-4 replaced it by a totally different
770font (different glyphs for C<;> and many other harmless characters),
771while the second font is actually the C<9x15bold> from XFree4/XOrg. The
772bold version has less chars than the medium version, so I use it for rare
773characters, too. When editing sources with vim, I use italic for comments
774and other stuff, which looks quite good with Bitstream Vera anti-aliased.
775
776Terminus is a quite bad font (many very wrong glyphs), but for most of my
777purposes, it works, and gives a different look, as my normal (Non-bold)
778font is already bold, and I want to see a difference between bold and
779normal fonts.
780
781Please note that I used the C<urxvt> instance name and not the C<URxvt>
782class name. Thats because I use different configs for different purposes,
783for example, my IRC window is started with C<-name IRC>, and uses these
784defaults:
785
786 IRC*title: IRC
787 IRC*geometry: 87x12+535+542
788 IRC*saveLines: 0
789 IRC*mapAlert: true
790 IRC*font: suxuseuro
791 IRC*boldFont: suxuseuro
792 IRC*colorBD: white
793 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
794 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
795
796C<Alt-Shift-1> and C<Alt-Shift-2> switch between two different font
797sizes. C<suxuseuro> allows me to keep an eye (and actually read)
798stuff while keeping a very small window. If somebody pastes something
799complicated (e.g. japanese), I temporarily switch to a larger font.
800
801The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
802C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
803file for different hosts, for example, on ym main desktop, I use:
804
805 URxvt.keysym.C-M-q: command:\033[3;5;5t
806 URxvt.keysym.C-M-y: command:\033[3;5;606t
807 URxvt.keysym.C-M-e: command:\033[3;1605;5t
808 URxvt.keysym.C-M-c: command:\033[3;1605;606t
809 URxvt.keysym.C-M-p: perl:test
810
811The first for keysym definitions allow me to quickly bring some windows
812in the layout I like most. Ion users might start laughing but will stop
813immediately when I tell them that I use my own Fvwm2 module for much the
814same effect as Ion provides, and I only very rarely use the above key
815combinations :->
816
647=head3 Why doesn't rxvt-unicode read my resources? 817=head3 Why doesn't rxvt-unicode read my resources?
648 818
649Well, why, indeed? It does, in a way very similar to other X 819Well, why, indeed? It does, in a way very similar to other X
650applications. Most importantly, this means that if you or your OS loads 820applications. Most importantly, this means that if you or your OS loads
651resources into the X display (the right way to do it), rxvt-unicode will 821resources into the X display (the right way to do it), rxvt-unicode will
659Also consider the form resources have to use: 829Also consider the form resources have to use:
660 830
661 URxvt.resource: value 831 URxvt.resource: value
662 832
663If you want to use another form (there are lots of different ways of 833If you want to use another form (there are lots of different ways of
664specifying resources), make sure you understand wether and why it 834specifying resources), make sure you understand whether and why it
665works. If unsure, use the form above. 835works. If unsure, use the form above.
666 836
667=head3 When I log-in to another system it tells me about missing terminfo data? 837=head3 When I log-in to another system it tells me about missing terminfo data?
668 838
669The terminal description used by rxvt-unicode is not as widely available 839The terminal description used by rxvt-unicode is not as widely available
670as that for xterm, or even rxvt (for which the same problem often arises). 840as that for xterm, or even rxvt (for which the same problem often arises).
671 841
672The correct solution for this problem is to install the terminfo, this can 842The correct solution for this problem is to install the terminfo, this can
673be done like this (with ncurses' infocmp): 843be done like this (with ncurses' infocmp and works as user and admin):
674 844
675 REMOTE=remotesystem.domain 845 REMOTE=remotesystem.domain
676 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" 846 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
677 847
678... or by installing rxvt-unicode normally on the remote system, 848... or by installing rxvt-unicode normally on the remote system,
849
850One some systems you might need to set C<$TERMINFO> to the full path of
851F<$HOME/.terminfo> for this to work.
679 852
680If you cannot or do not want to do this, then you can simply set 853If you cannot or do not want to do this, then you can simply set
681C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of 854C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
682problems arising, which includes wrong keymapping, less and different 855problems arising, which includes wrong keymapping, less and different
683colours and some refresh errors in fullscreen applications. It's a nice 856colours and some refresh errors in fullscreen applications. It's a nice
706One reason you might want this is that some distributions or operating 879One reason you might want this is that some distributions or operating
707systems still compile some programs using the long-obsoleted termcap 880systems still compile some programs using the long-obsoleted termcap
708library (Fedora Core's bash is one example) and rely on a termcap entry 881library (Fedora Core's bash is one example) and rely on a termcap entry
709for C<rxvt-unicode>. 882for C<rxvt-unicode>.
710 883
711You could use rxvt's termcap entry with resonable results in many cases. 884You could use rxvt's termcap entry with reasonable results in many cases.
712You can also create a termcap entry by using terminfo's infocmp program 885You can also create a termcap entry by using terminfo's infocmp program
713like this: 886like this:
714 887
715 infocmp -C rxvt-unicode 888 infocmp -C rxvt-unicode
716 889
738 :vs=\E[?25h: 911 :vs=\E[?25h:
739 912
740=head3 Why does C<ls> no longer have coloured output? 913=head3 Why does C<ls> no longer have coloured output?
741 914
742The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 915The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
743decide wether a terminal has colour, but uses it's own configuration 916decide whether a terminal has colour, but uses its own configuration
744file. Needless to say, C<rxvt-unicode> is not in it's default file (among 917file. Needless to say, C<rxvt-unicode> is not in its default file (among
745with most other terminals supporting colour). Either add: 918with most other terminals supporting colour). Either add:
746 919
747 TERM rxvt-unicode 920 TERM rxvt-unicode
748 921
749to C</etc/DIR_COLORS> or simply add: 922to C</etc/DIR_COLORS> or simply add:
783If you encounter strange problems like typing an accented character but 956If you encounter strange problems like typing an accented character but
784getting two unrelated other characters or similar, or if program output is 957getting two unrelated other characters or similar, or if program output is
785subtly garbled, then you should check your locale settings. 958subtly garbled, then you should check your locale settings.
786 959
787Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 960Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
788programs. Often rxvt-unicode is started in the C<C> locale, while the 961programs running in it. Often rxvt-unicode is started in the C<C> locale,
789login script running within the rxvt-unicode window changes the locale to 962while the login script running within the rxvt-unicode window changes the
790something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work. 963locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
964not going to work, and is the most common cause for problems.
791 965
792The best thing is to fix your startup environment, as you will likely run 966The best thing is to fix your startup environment, as you will likely run
793into other problems. If nothing works you can try this in your .profile. 967into other problems. If nothing works you can try this in your .profile.
794 968
795 printf '\e]701;%s\007' "$LC_CTYPE" 969 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
796 970
797If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 971If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
798supported on your systems. Some systems have a C<locale> command which 972supported on your systems. Some systems have a C<locale> command which
799displays this (also, C<perl -e0> can be used to check locale settings, as 973displays this (also, C<perl -e0> can be used to check locale settings, as
800it will complain loudly if it cannot set the locale). If it displays something 974it will complain loudly if it cannot set the locale). If it displays something
821The reasons is that there exists a perfectly fine mechanism for selecting 995The reasons is that there exists a perfectly fine mechanism for selecting
822the encoding, doing I/O and (most important) communicating this to all 996the encoding, doing I/O and (most important) communicating this to all
823applications so everybody agrees on character properties such as width 997applications so everybody agrees on character properties such as width
824and code number. This mechanism is the I<locale>. Applications not using 998and code number. This mechanism is the I<locale>. Applications not using
825that info will have problems (for example, C<xterm> gets the width of 999that info will have problems (for example, C<xterm> gets the width of
826characters wrong as it uses it's own, locale-independent table under all 1000characters wrong as it uses its own, locale-independent table under all
827locales). 1001locales).
828 1002
829Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All 1003Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
830programs doing the same (that is, most) will automatically agree in the 1004programs doing the same (that is, most) will automatically agree in the
831interpretation of characters. 1005interpretation of characters.
850=head3 Can I switch locales at runtime? 1024=head3 Can I switch locales at runtime?
851 1025
852Yes, using an escape sequence. Try something like this, which sets 1026Yes, using an escape sequence. Try something like this, which sets
853rxvt-unicode's idea of C<LC_CTYPE>. 1027rxvt-unicode's idea of C<LC_CTYPE>.
854 1028
855 printf '\e]701;%s\007' ja_JP.SJIS 1029 printf '\33]701;%s\007' ja_JP.SJIS
856 1030
857See also the previous answer. 1031See also the previous answer.
858 1032
859Sometimes this capability is rather handy when you want to work in 1033Sometimes this capability is rather handy when you want to work in
860one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it 1034one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
861(e.g. UTF-8). For example, I use this script to start C<xjdic>, which 1035(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
862first switches to a locale supported by xjdic and back later: 1036first switches to a locale supported by xjdic and back later:
863 1037
864 printf '\e]701;%s\007' ja_JP.SJIS 1038 printf '\33]701;%s\007' ja_JP.SJIS
865 xjdic -js 1039 xjdic -js
866 printf '\e]701;%s\007' de_DE.UTF-8 1040 printf '\33]701;%s\007' de_DE.UTF-8
867 1041
868You can also use xterm's C<luit> program, which usually works fine, except 1042You can also use xterm's C<luit> program, which usually works fine, except
869for some locales where character width differs between program- and 1043for some locales where character width differs between program- and
870rxvt-unicode-locales. 1044rxvt-unicode-locales.
871 1045
1046=head3 I have problems getting my input method working.
1047
1048Try a search engine, as this is slightly different for every input method server.
1049
1050Here is a checklist:
1051
1052=over 4
1053
1054=item - Make sure your locale I<and> the imLocale are supported on your OS.
1055
1056Try C<locale -a> or check the documentation for your OS.
1057
1058=item - Make sure your locale or imLocale matches a locale supported by your XIM.
1059
1060For example, B<kinput2> does not support UTF-8 locales, you should use
1061C<ja_JP.EUC-JP> or equivalent.
1062
1063=item - Make sure your XIM server is actually running.
1064
1065=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1066
1067When you want to use e.g. B<kinput2>, it must be set to
1068C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1069method servers are running with this command:
1070
1071 xprop -root XIM_SERVERS
1072
1073=item
1074
1075=back
1076
872=head3 My input method wants <some encoding> but I want UTF-8, what can I do? 1077=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
873 1078
874You can specify separate locales for the input method and the rest of the 1079You can specify separate locales for the input method and the rest of the
875terminal, using the resource C<imlocale>: 1080terminal, using the resource C<imlocale>:
876 1081
877 URxvt.imlocale: ja_JP.EUC-JP 1082 URxvt.imlocale: ja_JP.EUC-JP
878 1083
879Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 1084Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
880use your input method. Please note, however, that you will not be able to 1085use your input method. Please note, however, that, depending on your Xlib
881input characters outside C<EUC-JP> in a normal way then, as your input 1086version, you may not be able to input characters outside C<EUC-JP> in a
882method limits you. 1087normal way then, as your input method limits you.
883 1088
884=head3 Rxvt-unicode crashes when the X Input Method changes or exits. 1089=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
885 1090
886Unfortunately, this is unavoidable, as the XIM protocol is racy by 1091Unfortunately, this is unavoidable, as the XIM protocol is racy by
887design. Applications can avoid some crashes at the expense of memory 1092design. Applications can avoid some crashes at the expense of memory
913 1118
914=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation? 1119=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
915 1120
916You should build one binary with the default options. F<configure> 1121You should build one binary with the default options. F<configure>
917now enables most useful options, and the trend goes to making them 1122now enables most useful options, and the trend goes to making them
918runtime-switchable, too, so there is usually no drawback to enbaling them, 1123runtime-switchable, too, so there is usually no drawback to enabling them,
919except higher disk and possibly memory usage. The perl interpreter should 1124except higher disk and possibly memory usage. The perl interpreter should
920be enabled, as important functionality (menus, selection, likely more in 1125be enabled, as important functionality (menus, selection, likely more in
921the future) depends on it. 1126the future) depends on it.
922 1127
923You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 1128You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
958 1163
959=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all. 1164=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
960 1165
961Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1166Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
962in your compile environment, or an implementation that implements it, 1167in your compile environment, or an implementation that implements it,
963wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1168whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
964B<wchar_t> is represented as unicode. 1169B<wchar_t> is represented as unicode.
965 1170
966As you might have guessed, FreeBSD does neither define this symobl nor 1171As you might have guessed, FreeBSD does neither define this symbol nor
967does it support it. Instead, it uses it's own internal representation of 1172does it support it. Instead, it uses its own internal representation of
968B<wchar_t>. This is, of course, completely fine with respect to standards. 1173B<wchar_t>. This is, of course, completely fine with respect to standards.
969 1174
970However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and 1175However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
971C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>. 1176C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
972 1177
1006encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited 1211encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1007to 8-bit encodings. 1212to 8-bit encodings.
1008 1213
1009=head1 RXVT-UNICODE TECHNICAL REFERENCE 1214=head1 RXVT-UNICODE TECHNICAL REFERENCE
1010 1215
1011=head1 DESCRIPTION
1012
1013The rest of this document describes various technical aspects of 1216The rest of this document describes various technical aspects of
1014B<rxvt-unicode>. First the description of supported command sequences, 1217B<rxvt-unicode>. First the description of supported command sequences,
1015followed by pixmap support and last by a description of all features 1218followed by pixmap support and last by a description of all features
1016selectable at C<configure> time. 1219selectable at C<configure> time.
1017 1220
1018=head1 Definitions 1221=head2 Definitions
1019 1222
1020=over 4 1223=over 4
1021 1224
1022=item B<< C<c> >> 1225=item B<< C<c> >>
1023 1226
1041 1244
1042A text parameter composed of printable characters. 1245A text parameter composed of printable characters.
1043 1246
1044=back 1247=back
1045 1248
1046=head1 Values 1249=head2 Values
1047 1250
1048=over 4 1251=over 4
1049 1252
1050=item B<< C<ENQ> >> 1253=item B<< C<ENQ> >>
1051 1254
1094 1297
1095Space Character 1298Space Character
1096 1299
1097=back 1300=back
1098 1301
1099=head1 Escape Sequences 1302=head2 Escape Sequences
1100 1303
1101=over 4 1304=over 4
1102 1305
1103=item B<< C<ESC # 8> >> 1306=item B<< C<ESC # 8> >>
1104 1307
1202 1405
1203=back 1406=back
1204 1407
1205X<CSI> 1408X<CSI>
1206 1409
1207=head1 CSI (Command Sequence Introducer) Sequences 1410=head2 CSI (Command Sequence Introducer) Sequences
1208 1411
1209=over 4 1412=over 4
1210 1413
1211=item B<< C<ESC [ Ps @> >> 1414=item B<< C<ESC [ Ps @> >>
1212 1415
1482 1685
1483=back 1686=back
1484 1687
1485X<PrivateModes> 1688X<PrivateModes>
1486 1689
1487=head1 DEC Private Modes 1690=head2 DEC Private Modes
1488 1691
1489=over 4 1692=over 4
1490 1693
1491=item B<< C<ESC [ ? Pm h> >> 1694=item B<< C<ESC [ ? Pm h> >>
1492 1695
1508 1711
1509Toggle DEC Private Mode Values (rxvt extension). I<where> 1712Toggle DEC Private Mode Values (rxvt extension). I<where>
1510 1713
1511=over 4 1714=over 4
1512 1715
1513=item B<< C<Ps = 1> >> (DECCKM) 1716=item B<< C<Pm = 1> >> (DECCKM)
1514 1717
1515=begin table 1718=begin table
1516 1719
1517 B<< C<h> >> Application Cursor Keys 1720 B<< C<h> >> Application Cursor Keys
1518 B<< C<l> >> Normal Cursor Keys 1721 B<< C<l> >> Normal Cursor Keys
1519 1722
1520=end table 1723=end table
1521 1724
1522=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1725=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1523 1726
1524=begin table 1727=begin table
1525 1728
1526 B<< C<h> >> Enter VT52 mode 1729 B<< C<h> >> Enter VT52 mode
1527 B<< C<l> >> Enter VT52 mode 1730 B<< C<l> >> Enter VT52 mode
1528 1731
1529=end table 1732=end table
1530 1733
1531=item B<< C<Ps = 3> >> 1734=item B<< C<Pm = 3> >>
1532 1735
1533=begin table 1736=begin table
1534 1737
1535 B<< C<h> >> 132 Column Mode (DECCOLM) 1738 B<< C<h> >> 132 Column Mode (DECCOLM)
1536 B<< C<l> >> 80 Column Mode (DECCOLM) 1739 B<< C<l> >> 80 Column Mode (DECCOLM)
1537 1740
1538=end table 1741=end table
1539 1742
1540=item B<< C<Ps = 4> >> 1743=item B<< C<Pm = 4> >>
1541 1744
1542=begin table 1745=begin table
1543 1746
1544 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1747 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1545 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1748 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1546 1749
1547=end table 1750=end table
1548 1751
1549=item B<< C<Ps = 5> >> 1752=item B<< C<Pm = 5> >>
1550 1753
1551=begin table 1754=begin table
1552 1755
1553 B<< C<h> >> Reverse Video (DECSCNM) 1756 B<< C<h> >> Reverse Video (DECSCNM)
1554 B<< C<l> >> Normal Video (DECSCNM) 1757 B<< C<l> >> Normal Video (DECSCNM)
1555 1758
1556=end table 1759=end table
1557 1760
1558=item B<< C<Ps = 6> >> 1761=item B<< C<Pm = 6> >>
1559 1762
1560=begin table 1763=begin table
1561 1764
1562 B<< C<h> >> Origin Mode (DECOM) 1765 B<< C<h> >> Origin Mode (DECOM)
1563 B<< C<l> >> Normal Cursor Mode (DECOM) 1766 B<< C<l> >> Normal Cursor Mode (DECOM)
1564 1767
1565=end table 1768=end table
1566 1769
1567=item B<< C<Ps = 7> >> 1770=item B<< C<Pm = 7> >>
1568 1771
1569=begin table 1772=begin table
1570 1773
1571 B<< C<h> >> Wraparound Mode (DECAWM) 1774 B<< C<h> >> Wraparound Mode (DECAWM)
1572 B<< C<l> >> No Wraparound Mode (DECAWM) 1775 B<< C<l> >> No Wraparound Mode (DECAWM)
1573 1776
1574=end table 1777=end table
1575 1778
1576=item B<< C<Ps = 8> >> I<unimplemented> 1779=item B<< C<Pm = 8> >> I<unimplemented>
1577 1780
1578=begin table 1781=begin table
1579 1782
1580 B<< C<h> >> Auto-repeat Keys (DECARM) 1783 B<< C<h> >> Auto-repeat Keys (DECARM)
1581 B<< C<l> >> No Auto-repeat Keys (DECARM) 1784 B<< C<l> >> No Auto-repeat Keys (DECARM)
1582 1785
1583=end table 1786=end table
1584 1787
1585=item B<< C<Ps = 9> >> X10 XTerm 1788=item B<< C<Pm = 9> >> X10 XTerm
1586 1789
1587=begin table 1790=begin table
1588 1791
1589 B<< C<h> >> Send Mouse X & Y on button press. 1792 B<< C<h> >> Send Mouse X & Y on button press.
1590 B<< C<l> >> No mouse reporting. 1793 B<< C<l> >> No mouse reporting.
1591 1794
1592=end table 1795=end table
1593 1796
1594=item B<< C<Ps = 25> >> 1797=item B<< C<Pm = 25> >>
1595 1798
1596=begin table 1799=begin table
1597 1800
1598 B<< C<h> >> Visible cursor {cnorm/cvvis} 1801 B<< C<h> >> Visible cursor {cnorm/cvvis}
1599 B<< C<l> >> Invisible cursor {civis} 1802 B<< C<l> >> Invisible cursor {civis}
1600 1803
1601=end table 1804=end table
1602 1805
1603=item B<< C<Ps = 30> >> 1806=item B<< C<Pm = 30> >>
1604 1807
1605=begin table 1808=begin table
1606 1809
1607 B<< C<h> >> scrollBar visisble 1810 B<< C<h> >> scrollBar visisble
1608 B<< C<l> >> scrollBar invisisble 1811 B<< C<l> >> scrollBar invisisble
1609 1812
1610=end table 1813=end table
1611 1814
1612=item B<< C<Ps = 35> >> (B<rxvt>) 1815=item B<< C<Pm = 35> >> (B<rxvt>)
1613 1816
1614=begin table 1817=begin table
1615 1818
1616 B<< C<h> >> Allow XTerm Shift+key sequences 1819 B<< C<h> >> Allow XTerm Shift+key sequences
1617 B<< C<l> >> Disallow XTerm Shift+key sequences 1820 B<< C<l> >> Disallow XTerm Shift+key sequences
1618 1821
1619=end table 1822=end table
1620 1823
1621=item B<< C<Ps = 38> >> I<unimplemented> 1824=item B<< C<Pm = 38> >> I<unimplemented>
1622 1825
1623Enter Tektronix Mode (DECTEK) 1826Enter Tektronix Mode (DECTEK)
1624 1827
1625=item B<< C<Ps = 40> >> 1828=item B<< C<Pm = 40> >>
1626 1829
1627=begin table 1830=begin table
1628 1831
1629 B<< C<h> >> Allow 80/132 Mode 1832 B<< C<h> >> Allow 80/132 Mode
1630 B<< C<l> >> Disallow 80/132 Mode 1833 B<< C<l> >> Disallow 80/132 Mode
1631 1834
1632=end table 1835=end table
1633 1836
1634=item B<< C<Ps = 44> >> I<unimplemented> 1837=item B<< C<Pm = 44> >> I<unimplemented>
1635 1838
1636=begin table 1839=begin table
1637 1840
1638 B<< C<h> >> Turn On Margin Bell 1841 B<< C<h> >> Turn On Margin Bell
1639 B<< C<l> >> Turn Off Margin Bell 1842 B<< C<l> >> Turn Off Margin Bell
1640 1843
1641=end table 1844=end table
1642 1845
1643=item B<< C<Ps = 45> >> I<unimplemented> 1846=item B<< C<Pm = 45> >> I<unimplemented>
1644 1847
1645=begin table 1848=begin table
1646 1849
1647 B<< C<h> >> Reverse-wraparound Mode 1850 B<< C<h> >> Reverse-wraparound Mode
1648 B<< C<l> >> No Reverse-wraparound Mode 1851 B<< C<l> >> No Reverse-wraparound Mode
1649 1852
1650=end table 1853=end table
1651 1854
1652=item B<< C<Ps = 46> >> I<unimplemented> 1855=item B<< C<Pm = 46> >> I<unimplemented>
1653 1856
1654=item B<< C<Ps = 47> >> 1857=item B<< C<Pm = 47> >>
1655 1858
1656=begin table 1859=begin table
1657 1860
1658 B<< C<h> >> Use Alternate Screen Buffer 1861 B<< C<h> >> Use Alternate Screen Buffer
1659 B<< C<l> >> Use Normal Screen Buffer 1862 B<< C<l> >> Use Normal Screen Buffer
1660 1863
1661=end table 1864=end table
1662 1865
1663X<Priv66> 1866X<Priv66>
1664 1867
1665=item B<< C<Ps = 66> >> 1868=item B<< C<Pm = 66> >>
1666 1869
1667=begin table 1870=begin table
1668 1871
1669 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1872 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1670 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1873 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1671 1874
1672=end table 1875=end table
1673 1876
1674=item B<< C<Ps = 67> >> 1877=item B<< C<Pm = 67> >>
1675 1878
1676=begin table 1879=begin table
1677 1880
1678 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1881 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1679 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1882 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1680 1883
1681=end table 1884=end table
1682 1885
1683=item B<< C<Ps = 1000> >> (X11 XTerm) 1886=item B<< C<Pm = 1000> >> (X11 XTerm)
1684 1887
1685=begin table 1888=begin table
1686 1889
1687 B<< C<h> >> Send Mouse X & Y on button press and release. 1890 B<< C<h> >> Send Mouse X & Y on button press and release.
1688 B<< C<l> >> No mouse reporting. 1891 B<< C<l> >> No mouse reporting.
1689 1892
1690=end table 1893=end table
1691 1894
1692=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1895=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1693 1896
1694=begin table 1897=begin table
1695 1898
1696 B<< C<h> >> Use Hilite Mouse Tracking. 1899 B<< C<h> >> Use Hilite Mouse Tracking.
1697 B<< C<l> >> No mouse reporting. 1900 B<< C<l> >> No mouse reporting.
1698 1901
1699=end table 1902=end table
1700 1903
1701=item B<< C<Ps = 1010> >> (B<rxvt>) 1904=item B<< C<Pm = 1010> >> (B<rxvt>)
1702 1905
1703=begin table 1906=begin table
1704 1907
1705 B<< C<h> >> Don't scroll to bottom on TTY output 1908 B<< C<h> >> Don't scroll to bottom on TTY output
1706 B<< C<l> >> Scroll to bottom on TTY output 1909 B<< C<l> >> Scroll to bottom on TTY output
1707 1910
1708=end table 1911=end table
1709 1912
1710=item B<< C<Ps = 1011> >> (B<rxvt>) 1913=item B<< C<Pm = 1011> >> (B<rxvt>)
1711 1914
1712=begin table 1915=begin table
1713 1916
1714 B<< C<h> >> Scroll to bottom when a key is pressed 1917 B<< C<h> >> Scroll to bottom when a key is pressed
1715 B<< C<l> >> Don't scroll to bottom when a key is pressed 1918 B<< C<l> >> Don't scroll to bottom when a key is pressed
1716 1919
1717=end table 1920=end table
1718 1921
1719=item B<< C<Ps = 1021> >> (B<rxvt>) 1922=item B<< C<Pm = 1021> >> (B<rxvt>)
1720 1923
1721=begin table 1924=begin table
1722 1925
1723 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>) 1926 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1724 B<< C<l> >> Font styles have no effect on intensity (Compile styles) 1927 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1725 1928
1726=end table 1929=end table
1727 1930
1728=item B<< C<Ps = 1047> >> 1931=item B<< C<Pm = 1047> >>
1729 1932
1730=begin table 1933=begin table
1731 1934
1732 B<< C<h> >> Use Alternate Screen Buffer 1935 B<< C<h> >> Use Alternate Screen Buffer
1733 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1936 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1734 1937
1735=end table 1938=end table
1736 1939
1737=item B<< C<Ps = 1048> >> 1940=item B<< C<Pm = 1048> >>
1738 1941
1739=begin table 1942=begin table
1740 1943
1741 B<< C<h> >> Save cursor position 1944 B<< C<h> >> Save cursor position
1742 B<< C<l> >> Restore cursor position 1945 B<< C<l> >> Restore cursor position
1743 1946
1744=end table 1947=end table
1745 1948
1746=item B<< C<Ps = 1049> >> 1949=item B<< C<Pm = 1049> >>
1747 1950
1748=begin table 1951=begin table
1749 1952
1750 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it 1953 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1751 B<< C<l> >> Use Normal Screen Buffer 1954 B<< C<l> >> Use Normal Screen Buffer
1756 1959
1757=back 1960=back
1758 1961
1759X<XTerm> 1962X<XTerm>
1760 1963
1761=head1 XTerm Operating System Commands 1964=head2 XTerm Operating System Commands
1762 1965
1763=over 4 1966=over 4
1764 1967
1765=item B<< C<ESC ] Ps;Pt ST> >> 1968=item B<< C<ESC ] Ps;Pt ST> >>
1766 1969
1803 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl). 2006 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1804 2007
1805=end table 2008=end table
1806 2009
1807=back 2010=back
1808
1809X<XPM>
1810 2011
1811=head1 XPM 2012=head1 XPM
1812 2013
1813For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2014For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1814of B<< C<Pt> >> can be the name of the background pixmap followed by a 2015of B<< C<Pt> >> can be the name of the background pixmap followed by a
2000 2201
2001=head1 CONFIGURE OPTIONS 2202=head1 CONFIGURE OPTIONS
2002 2203
2003General hint: if you get compile errors, then likely your configuration 2204General hint: if you get compile errors, then likely your configuration
2004hasn't been tested well. Either try with C<--enable-everything> or use 2205hasn't been tested well. Either try with C<--enable-everything> or use
2005the F<./reconf> script as a base for experiments. F<./reconf> is used by 2206the default configuration (i.e. C<--enable-xxx> or C<--disable-xxx>). Of
2006myself, so it should generally be a working config. Of course, you should 2207course, you should always report when a combination doesn't work, so it
2007always report when a combination doesn't work, so it can be fixed. Marc 2208can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2008Lehmann <rxvt@schmorp.de>.
2009 2209
2010All 2210All
2011 2211
2012=over 4 2212=over 4
2013 2213
2045 2245
2046=begin table 2246=begin table
2047 2247
2048 all all available codeset groups 2248 all all available codeset groups
2049 zh common chinese encodings 2249 zh common chinese encodings
2050 zh_ext rarely used but very big chinese encodigs 2250 zh_ext rarely used but very big chinese encodings
2051 jp common japanese encodings 2251 jp common japanese encodings
2052 jp_ext rarely used but big japanese encodings 2252 jp_ext rarely used but big japanese encodings
2053 kr korean encodings 2253 kr korean encodings
2054 2254
2055=end table 2255=end table
2069requirements per character from 2 to 4 bytes. X11 fonts do not yet 2269requirements per character from 2 to 4 bytes. X11 fonts do not yet
2070support these extra characters, but Xft does. 2270support these extra characters, but Xft does.
2071 2271
2072Please note that rxvt-unicode can store unicode code points >65535 2272Please note that rxvt-unicode can store unicode code points >65535
2073even without this flag, but the number of such characters is 2273even without this flag, but the number of such characters is
2074limited to a view thousand (shared with combining characters, 2274limited to a few thousand (shared with combining characters,
2075see next switch), and right now rxvt-unicode cannot display them 2275see next switch), and right now rxvt-unicode cannot display them
2076(input/output and cut&paste still work, though). 2276(input/output and cut&paste still work, though).
2077 2277
2078=item --enable-combining (default: on) 2278=item --enable-combining (default: on)
2079 2279
2193A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2393A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2194in combination with other switches) is: 2394in combination with other switches) is:
2195 2395
2196 MWM-hints 2396 MWM-hints
2197 EWMH-hints (pid, utf8 names) and protocols (ping) 2397 EWMH-hints (pid, utf8 names) and protocols (ping)
2398 urgency hint
2198 seperate underline colour (-underlineColor) 2399 seperate underline colour (-underlineColor)
2199 settable border widths and borderless switch (-w, -b, -bl) 2400 settable border widths and borderless switch (-w, -b, -bl)
2200 visual depth selection (-depth) 2401 visual depth selection (-depth)
2201 settable extra linespacing /-lsp) 2402 settable extra linespacing /-lsp)
2202 iso-14755-2 and -3, and visual feedback 2403 iso-14755 5.1 (basic) support
2203 tripleclickwords (-tcw) 2404 tripleclickwords (-tcw)
2204 settable insecure mode (-insecure) 2405 settable insecure mode (-insecure)
2205 keysym remapping support 2406 keysym remapping support
2206 cursor blinking and underline cursor (-cb, -uc) 2407 cursor blinking and underline cursor (-cb, -uc)
2207 XEmbed support (-embed) 2408 XEmbed support (-embed)
2208 user-pty (-pty-fd) 2409 user-pty (-pty-fd)
2209 hold on exit (-hold) 2410 hold on exit (-hold)
2210 skip builtin block graphics (-sbg) 2411 skip builtin block graphics (-sbg)
2412 separate highlightcolor support (-hc)
2211 2413
2212It also enabled some non-essential features otherwise disabled, such as: 2414It also enables some non-essential features otherwise disabled, such as:
2213 2415
2214 some round-trip time optimisations 2416 some round-trip time optimisations
2215 nearest color allocation on pseudocolor screens 2417 nearest color allocation on pseudocolor screens
2216 UTF8_STRING supporr for selection 2418 UTF8_STRING support for selection
2217 sgr modes 90..97 and 100..107 2419 sgr modes 90..97 and 100..107
2218 backindex and forwardindex escape sequences 2420 backindex and forwardindex escape sequences
2219 view change/zero scorllback esacpe sequences 2421 view change/zero scrollback escape sequences
2220 locale switching escape sequence 2422 locale switching escape sequence
2221 window op and some xterm/OSC escape sequences 2423 window op and some xterm/OSC escape sequences
2222 rectangular selections 2424 rectangular selections
2223 trailing space removal for selections 2425 trailing space removal for selections
2224 verbose X error handling 2426 verbose X error handling
2243 2445
2244Add support for continual scrolling (using the mouse wheel as an 2446Add support for continual scrolling (using the mouse wheel as an
2245accelerator) while the control key is held down. This option 2447accelerator) while the control key is held down. This option
2246requires --enable-mousewheel to also be specified. 2448requires --enable-mousewheel to also be specified.
2247 2449
2248=item --disable-new-selection
2249
2250Remove support for mouse selection style like that of xterm.
2251
2252=item --enable-dmalloc (default: off)
2253
2254Use Gray Watson's malloc - which is good for debugging See
2255http://www.letters.com/dmalloc/ for details If you use either this or the
2256next option, you may need to edit src/Makefile after compiling to point
2257DINCLUDE and DLIB to the right places.
2258
2259You can only use either this option and the following (should
2260you use either) .
2261
2262=item --enable-dlmalloc (default: off)
2263
2264Use Doug Lea's malloc - which is good for a production version
2265See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2266
2267=item --enable-smart-resize (default: on) 2450=item --enable-smart-resize (default: on)
2268 2451
2269Add smart growth/shrink behaviour when changing font size via hot 2452Add smart growth/shrink behaviour when changing font size via hot
2270keys. This should keep the window corner which is closest to a corner of 2453keys. This should keep the window corner which is closest to a corner of
2271the screen in a fixed position. 2454the screen in a fixed position.
2275Add support to have the pointer disappear when typing or inactive. 2458Add support to have the pointer disappear when typing or inactive.
2276 2459
2277=item --enable-perl (default: on) 2460=item --enable-perl (default: on)
2278 2461
2279Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2462Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2280manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files 2463manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the
2281in F<src/perl-ext/> for the extensions that are installed by default. The 2464files in F<src/perl-ext/> for the extensions that are installed by
2282perl interpreter that is used can be specified via the C<PERL> environment 2465default. The perl interpreter that is used can be specified via the
2283variable when running configure. 2466C<PERL> environment variable when running configure. Even when compiled
2467in, perl will I<not> be initialised when all extensions have been disabled
2468C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2469resource standpoint.
2284 2470
2285=item --with-name=NAME (default: urxvt) 2471=item --with-name=NAME (default: urxvt)
2286 2472
2287Set the basename for the installed binaries, resulting 2473Set the basename for the installed binaries, resulting
2288in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2474in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines