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.120 by root, Mon Aug 7 15:59:44 2006 UTC vs.
Revision 1.196 by sf-exg, Fri Sep 3 10:16:12 2010 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://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23
24The main manual page for @@RXVT_NAME@@ itself is available at
25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
23 26
24=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS 27=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
25 28
26 29
27=head2 Meta, Features & Commandline Issues 30=head2 Meta, Features & Commandline Issues
… …
29=head3 My question isn't answered here, can I ask a human? 32=head3 My question isn't answered here, can I ask a human?
30 33
31Before sending me mail, you could go to IRC: C<irc.freenode.net>, 34Before sending me mail, you could go to IRC: C<irc.freenode.net>,
32channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be 35channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
33interested in learning about new and exciting problems (but not FAQs :). 36interested in learning about new and exciting problems (but not FAQs :).
37
38=head3 I use Gentoo, and I have a problem...
39
40There are three big problems with Gentoo Linux: first of all, most if not
41all Gentoo systems are completely broken (missing or mismatched header
42files, broken compiler etc. are just the tip of the iceberg); secondly,
43the Gentoo maintainer thinks it is a good idea to add broken patches to
44the code; and lastly, it should be called Gentoo GNU/Linux.
45
46For these reasons, it is impossible to support rxvt-unicode on
47Gentoo. Problems appearing on Gentoo systems will usually simply be
48ignored unless they can be reproduced on non-Gentoo systems.
34 49
35=head3 Does it support tabs, can I have a tabbed rxvt-unicode? 50=head3 Does it support tabs, can I have a tabbed rxvt-unicode?
36 51
37Beginning with version 7.3, there is a perl extension that implements a 52Beginning with version 7.3, there is a perl extension that implements a
38simple tabbed terminal. It is installed by default, so any of these should 53simple tabbed terminal. It is installed by default, so any of these should
… …
73=head3 How can I start @@URXVT_NAME@@d in a race-free way? 88=head3 How can I start @@URXVT_NAME@@d in a race-free way?
74 89
75Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the 90Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
76display, create the listening socket and then fork. 91display, create the listening socket and then fork.
77 92
78=head3 How can I start @@URXVT_NAME@@d automatically when I run URXVT_NAME@@c? 93=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
79 94
80If you want to start @@URXVT_NAME@@d automatically whenever you run 95If 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: 96@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
82 97
83 #!/bin/sh 98 #!/bin/sh
… …
90This tries to create a new terminal, and if fails with exit status 2, 105This 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 106meaning 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 107re-run the command. Subsequent invocations of the script will re-use the
93existing daemon. 108existing daemon.
94 109
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. 110=head3 How do I distinguish whether I'm running rxvt-unicode or a regular
111xterm? I need this to decide about setting colours etc.
96 112
97The original rxvt and rxvt-unicode always export the variable "COLORTERM", 113The 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, 114so you can check and see if that is set. Note that several programs, JED,
99slrn, Midnight Commander automatically check this variable to decide 115slrn, Midnight Commander automatically check this variable to decide
100whether or not to use color. 116whether or not to use colour.
101 117
102=head3 How do I set the correct, full IP address for the DISPLAY variable? 118=head3 How do I set the correct, full IP address for the DISPLAY variable?
103 119
104If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled 120If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
105insecure mode then it is possible to use the following shell script 121insecure mode then it is possible to use the following shell script
… …
125 fi 141 fi
126 142
127=head3 How do I compile the manual pages on my own? 143=head3 How do I compile the manual pages on my own?
128 144
129You need to have a recent version of perl installed as F</usr/bin/perl>, 145You 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 146one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from
131the doc subdirectory and enter C<make alldoc>. 147F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
132 148
133=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat? 149=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
134 150
135I often get asked about this, and I think, no, they didn't cause extra 151I 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 152bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
… …
197 213
198And here is rxvt-unicode: 214And here is rxvt-unicode:
199 215
200 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) 216 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
201 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) 217 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
202 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) 218 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
203 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) 219 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
204 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) 220 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
205 221
206No large bloated libraries (of course, none were linked in statically), 222No large bloated libraries (of course, none were linked in statically),
207except maybe libX11 :) 223except maybe libX11 :)
208 224
209 225
210=head2 Rendering, Font & Look and Feel Issues 226=head2 Rendering, Font & Look and Feel Issues
211 227
212=head3 I can't get transparency working, what am I doing wrong? 228=head3 I can't get transparency working, what am I doing wrong?
213 229
214First of all, transparency isn't officially supported in rxvt-unicode, so 230First 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 231sasha@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 232get it working consider it a rite of passage: ... and you failed.
217of passage: ... and you failed.
218 233
219Here are four ways to get transparency. B<Do> read the manpage and option 234Here are four ways to get transparency. B<Do> read the manpage and option
220descriptions for the programs mentioned and rxvt-unicode. Really, do it! 235descriptions for the programs mentioned and rxvt-unicode. Really, do it!
221 236
2221. Use inheritPixmap: 2371. Use transparent mode:
223 238
224 Esetroot wallpaper.jpg 239 Esetroot wallpaper.jpg
225 @@URXVT_NAME@@ -ip -tint red -sh 40 240 @@URXVT_NAME@@ -tr -tint red -sh 40
226 241
227That works. If you think it doesn't, you lack transparency and tinting 242That works. If you think it doesn't, you lack transparency and tinting
228support, or you are unable to read. 243support, or you are unable to read.
229 244
2302. Use a simple pixmap and emulate pseudo-transparency. This enables you 2452. Use a simple pixmap and emulate pseudo-transparency. This enables you
231to use effects other than tinting and shading: Just shade/tint/whatever 246to use effects other than tinting and shading: Just shade/tint/whatever
232your picture with gimp or any other tool: 247your picture with gimp or any other tool:
233 248
234 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm 249 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
235 @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background 250 @@URXVT_NAME@@ -pixmap "background.jpg;:root"
236 251
237That works. If you think it doesn't, you lack XPM and Perl support, or you 252That works. If you think it doesn't, you lack libAfterImage or GDK-PixBuf support, or you
238are unable to read. 253are unable to read.
239 254
2403. Use an ARGB visual: 2553. Use an ARGB visual:
241 256
242 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc 257 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
… …
342=head3 What's with this bold/blink stuff? 357=head3 What's with this bold/blink stuff?
343 358
344If no bold colour is set via C<colorBD:>, bold will invert text using the 359If no bold colour is set via C<colorBD:>, bold will invert text using the
345standard foreground colour. 360standard foreground colour.
346 361
347For the standard background colour, blinking will actually make the 362For the standard background colour, blinking will actually make
348text blink when compiled with C<--enable-blinking>. with standard 363the text blink when compiled with C<--enable-text-blink>. Without
349colours. Without C<--enable-blinking>, the blink attribute will be 364C<--enable-text-blink>, the blink attribute will be ignored.
350ignored.
351 365
352On ANSI colours, bold/blink attributes are used to set high-intensity 366On ANSI colours, bold/blink attributes are used to set high-intensity
353foreground/background colors. 367foreground/background colours.
354 368
355color0-7 are the low-intensity colors. 369color0-7 are the low-intensity colours.
356 370
357color8-15 are the corresponding high-intensity colors. 371color8-15 are the corresponding high-intensity colours.
358 372
359=head3 I don't like the screen colors. How do I change them? 373=head3 I don't like the screen colours. How do I change them?
360 374
361You can change the screen colors at run-time using F<~/.Xdefaults> 375You can change the screen colours at run-time using F<~/.Xdefaults>
362resources (or as long-options). 376resources (or as long-options).
363 377
364Here are values that are supposed to resemble a VGA screen, 378Here are values that are supposed to resemble a VGA screen,
365including the murky brown that passes for low-intensity yellow: 379including the murky brown that passes for low-intensity yellow:
366 380
… …
380 URxvt.color12: #0000FF 394 URxvt.color12: #0000FF
381 URxvt.color13: #FF00FF 395 URxvt.color13: #FF00FF
382 URxvt.color14: #00FFFF 396 URxvt.color14: #00FFFF
383 URxvt.color15: #FFFFFF 397 URxvt.color15: #FFFFFF
384 398
385And here is a more complete set of non-standard colors. 399And here is a more complete set of non-standard colours.
386 400
387 URxvt.cursorColor: #dc74d1 401 URxvt.cursorColor: #dc74d1
388 URxvt.pointerColor: #dc74d1 402 URxvt.pointerColor: #dc74d1
389 URxvt.background: #0e0e0e 403 URxvt.background: #0e0e0e
390 URxvt.foreground: #4ad5e1 404 URxvt.foreground: #4ad5e1
… …
460has been designed yet). 474has been designed yet).
461 475
462Until then, you might get away with switching fonts at runtime (see L<Can 476Until then, you might get away with switching fonts at runtime (see L<Can
463I switch the fonts at runtime?> later in this document). 477I switch the fonts at runtime?> later in this document).
464 478
479=head3 How can I make mplayer display video correctly?
480
481We are working on it, in the meantime, as a workaround, use something like:
482
483 @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
484
485
465=head2 Keyboard, Mouse & User Interaction 486=head2 Keyboard, Mouse & User Interaction
466 487
467=head3 The new selection selects pieces that are too big, how can I select single words? 488=head3 The new selection selects pieces that are too big, how can I select single words?
468 489
469If you want to select e.g. alphanumeric words, you can use the following 490If you want to select e.g. alphanumeric words, you can use the following
… …
476 497
477To get a selection that is very similar to the old code, try this pattern: 498To get a selection that is very similar to the old code, try this pattern:
478 499
479 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+) 500 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
480 501
481Please also note that the I<LeftClick Shift-LeftClik> combination also 502Please also note that the I<LeftClick Shift-LeftClick> combination also
482selects words like the old code. 503selects words like the old code.
483 504
484=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it? 505=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
485 506
486You can disable the perl extension completely by setting the 507You can disable the perl extension completely by setting the
… …
538rxvt-unicode will continue without an input method. 559rxvt-unicode will continue without an input method.
539 560
540In this case either do not specify a B<preeditStyle> or specify more than 561In this case either do not specify a B<preeditStyle> or specify more than
541one pre-edit style, such as B<OverTheSpot,Root,None>. 562one pre-edit style, such as B<OverTheSpot,Root,None>.
542 563
564If it still doesn't work, then maybe your input method doesn't support
565compose sequences - to fall back to the built-in one, make sure you don't
566specify an input method via C<-im> or C<XMODIFIERS>.
567
543=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755 568=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
544 569
545Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on 570Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
546international keyboards) or simply use ISO 14755 support to your 571international keyboards) or simply use ISO 14755 support to your
547advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other 572advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
… …
562Backspace keysym (not likely for Linux ... see the following 587Backspace keysym (not likely for Linux ... see the following
563question) there are two standard values that can be used for 588question) there are two standard values that can be used for
564Backspace: C<^H> and C<^?>. 589Backspace: C<^H> and C<^?>.
565 590
566Historically, either value is correct, but rxvt-unicode adopts the debian 591Historically, either value is correct, but rxvt-unicode adopts the debian
567policy of using C<^?> when unsure, because it's the one only only correct 592policy of using C<^?> when unsure, because it's the one and only correct
568choice :). 593choice :).
569 594
570Rxvt-unicode tries to inherit the current stty settings and uses the value 595It is possible to toggle between C<^H> and C<^?> with the DECBKM
571of `erase' to guess the value for backspace. If rxvt-unicode wasn't 596private mode:
572started from a terminal (say, from a menu or by remote shell), then the
573system value of `erase', which corresponds to CERASE in <termios.h>, will
574be used (which may not be the same as your stty setting).
575
576For starting a new rxvt-unicode:
577 597
578 # use Backspace = ^H 598 # use Backspace = ^H
579 $ stty erase ^H 599 $ stty erase ^H
580 $ @@URXVT_NAME@@ 600 $ echo -n "^[[?67h"
581 601
582 # use Backspace = ^? 602 # use Backspace = ^?
583 $ stty erase ^? 603 $ stty erase ^?
584 $ @@URXVT_NAME@@
585
586Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
587
588For an existing rxvt-unicode:
589
590 # use Backspace = ^H
591 $ stty erase ^H
592 $ echo -n "^[[36h"
593
594 # use Backspace = ^?
595 $ stty erase ^?
596 $ echo -n "^[[36l" 604 $ echo -n "^[[?67l"
597 605
598This helps satisfy some of the Backspace discrepancies that occur, but 606This helps satisfy some of the Backspace discrepancies that occur, but
599if you use Backspace = C<^H>, make sure that the termcap/terminfo value 607if you use Backspace = C<^H>, make sure that the termcap/terminfo value
600properly reflects that. 608properly reflects that.
601 609
… …
604key has been assigned an escape sequence to match the vt100 for Execute 612key has been assigned an escape sequence to match the vt100 for Execute
605(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo. 613(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
606 614
607Some other Backspace problems: 615Some other Backspace problems:
608 616
609some editors use termcap/terminfo, 617some editors use termcap/terminfo,
610some editors (vim I'm told) expect Backspace = ^H, 618some editors (vim I'm told) expect Backspace = ^H,
611GNU Emacs (and Emacs-like editors) use ^H for help. 619GNU Emacs (and Emacs-like editors) use ^H for help.
612 620
613Perhaps someday this will all be resolved in a consistent manner. 621Perhaps someday this will all be resolved in a consistent manner.
614 622
… …
655Rather than have rxvt-unicode try to accommodate all the various possible 663Rather than have rxvt-unicode try to accommodate all the various possible
656keyboard mappings, it is better to use `xmodmap' to remap the keys as 664keyboard mappings, it is better to use `xmodmap' to remap the keys as
657required for your particular machine. 665required for your particular machine.
658 666
659 667
660
661=head2 Terminal Configuration 668=head2 Terminal Configuration
662 669
663=head3 Can I see a typical configuration? 670=head3 Can I see a typical configuration?
664 671
665The default configuration tries to be xterm-like, which I don't like that 672The default configuration tries to be xterm-like, which I don't like that
… …
695develop for myself mostly, so I actually use most of the extensions I 702develop for myself mostly, so I actually use most of the extensions I
696write. 703write.
697 704
698The selection stuff mainly makes the selection perl-error-message aware 705The selection stuff mainly makes the selection perl-error-message aware
699and tells it to convert perl error messages into vi-commands to load the 706and tells it to convert perl error messages into vi-commands to load the
700relevant file and go tot he error line number. 707relevant file and go to the error line number.
701 708
702 URxvt.scrollstyle: plain 709 URxvt.scrollstyle: plain
703 URxvt.secondaryScroll: true 710 URxvt.secondaryScroll: true
704 711
705As the documentation says: plain is the preferred scrollbar for the 712As the documentation says: plain is the preferred scrollbar for the
… …
777purposes, it works, and gives a different look, as my normal (Non-bold) 784purposes, 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 785font is already bold, and I want to see a difference between bold and
779normal fonts. 786normal fonts.
780 787
781Please note that I used the C<urxvt> instance name and not the C<URxvt> 788Please 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, 789class name. That is because I use different configs for different purposes,
783for example, my IRC window is started with C<-name IRC>, and uses these 790for example, my IRC window is started with C<-name IRC>, and uses these
784defaults: 791defaults:
785 792
786 IRC*title: IRC 793 IRC*title: IRC
787 IRC*geometry: 87x12+535+542 794 IRC*geometry: 87x12+535+542
… …
791 IRC*boldFont: suxuseuro 798 IRC*boldFont: suxuseuro
792 IRC*colorBD: white 799 IRC*colorBD: white
793 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007 800 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 801 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
795 802
796C<Alt-Shift-1> and C<Alt-Shift-2> switch between two different font 803C<Alt-Ctrl-1> and C<Alt-Ctrl-2> switch between two different font
797sizes. C<suxuseuro> allows me to keep an eye (and actually read) 804sizes. C<suxuseuro> allows me to keep an eye (and actually read)
798stuff while keeping a very small window. If somebody pastes something 805stuff while keeping a very small window. If somebody pastes something
799complicated (e.g. japanese), I temporarily switch to a larger font. 806complicated (e.g. japanese), I temporarily switch to a larger font.
800 807
801The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor 808The 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> 809C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
803file for different hosts, for example, on ym main desktop, I use: 810file for different hosts, for example, on my main desktop, I use:
804 811
805 URxvt.keysym.C-M-q: command:\033[3;5;5t 812 URxvt.keysym.C-M-q: command:\033[3;5;5t
806 URxvt.keysym.C-M-y: command:\033[3;5;606t 813 URxvt.keysym.C-M-y: command:\033[3;5;606t
807 URxvt.keysym.C-M-e: command:\033[3;1605;5t 814 URxvt.keysym.C-M-e: command:\033[3;1605;5t
808 URxvt.keysym.C-M-c: command:\033[3;1605;606t 815 URxvt.keysym.C-M-c: command:\033[3;1605;606t
… …
838 845
839The terminal description used by rxvt-unicode is not as widely available 846The terminal description used by rxvt-unicode is not as widely available
840as that for xterm, or even rxvt (for which the same problem often arises). 847as that for xterm, or even rxvt (for which the same problem often arises).
841 848
842The correct solution for this problem is to install the terminfo, this can 849The correct solution for this problem is to install the terminfo, this can
843be done like this (with ncurses' infocmp): 850be done by simply installing rxvt-unicode on the remote system as well
851(in case you have a nice package manager ready), or you can install the
852terminfo database manually like this (with ncurses infocmp. works as
853user and root):
844 854
845 REMOTE=remotesystem.domain 855 REMOTE=remotesystem.domain
846 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" 856 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
847 857
848... or by installing rxvt-unicode normally on the remote system, 858One some systems you might need to set C<$TERMINFO> to the full path of
859F<$HOME/.terminfo> for this to work.
849 860
850If you cannot or do not want to do this, then you can simply set 861If you cannot or do not want to do this, then you can simply set
851C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of 862C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
852problems arising, which includes wrong keymapping, less and different 863problems arising, which includes wrong keymapping, less and different
853colours and some refresh errors in fullscreen applications. It's a nice 864colours and some refresh errors in fullscreen applications. It's a nice
… …
860 URxvt.termName: rxvt 871 URxvt.termName: rxvt
861 872
862If you don't plan to use B<rxvt> (quite common...) you could also replace 873If you don't plan to use B<rxvt> (quite common...) you could also replace
863the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>. 874the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
864 875
876=head3 nano fails with "Error opening terminal: rxvt-unicode"
877
878This exceptionally confusing and useless error message is printed by nano
879when it can't find the terminfo database. Nothing is wrong with your
880terminal, read the previous answer for a solution.
881
865=head3 C<tic> outputs some error when compiling the terminfo entry. 882=head3 C<tic> outputs some error when compiling the terminfo entry.
866 883
867Most likely it's the empty definition for C<enacs=>. Just replace it by 884Most likely it's the empty definition for C<enacs=>. Just replace it by
868C<enacs=\E[0@> and try again. 885C<enacs=\E[0@> and try again.
869 886
… …
882You can also create a termcap entry by using terminfo's infocmp program 899You can also create a termcap entry by using terminfo's infocmp program
883like this: 900like this:
884 901
885 infocmp -C rxvt-unicode 902 infocmp -C rxvt-unicode
886 903
887Or you could use this termcap entry, generated by the command above: 904Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap,
888 905generated by the command above.
889 rxvt-unicode|rxvt-unicode terminal (X Window System):\
890 :am:bw:eo:km:mi:ms:xn:xo:\
891 :co#80:it#8:li#24:lm#0:\
892 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
893 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
894 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
895 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
896 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
897 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
898 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
899 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
900 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
901 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
902 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
903 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
904 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
905 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
906 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
907 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
908 :vs=\E[?25h:
909 906
910=head3 Why does C<ls> no longer have coloured output? 907=head3 Why does C<ls> no longer have coloured output?
911 908
912The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 909The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
913decide whether a terminal has colour, but uses its own configuration 910decide whether a terminal has colour, but uses its own configuration
… …
953If you encounter strange problems like typing an accented character but 950If you encounter strange problems like typing an accented character but
954getting two unrelated other characters or similar, or if program output is 951getting two unrelated other characters or similar, or if program output is
955subtly garbled, then you should check your locale settings. 952subtly garbled, then you should check your locale settings.
956 953
957Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 954Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
958programs. Often rxvt-unicode is started in the C<C> locale, while the 955programs running in it. Often rxvt-unicode is started in the C<C> locale,
959login script running within the rxvt-unicode window changes the locale to 956while the login script running within the rxvt-unicode window changes the
960something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work. 957locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
958not going to work, and is the most common cause for problems.
961 959
962The best thing is to fix your startup environment, as you will likely run 960The best thing is to fix your startup environment, as you will likely run
963into other problems. If nothing works you can try this in your .profile. 961into other problems. If nothing works you can try this in your .profile.
964 962
965 printf '\33]701;%s\007' "$LC_CTYPE" 963 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
966 964
967If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 965If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
968supported on your systems. Some systems have a C<locale> command which 966supported on your systems. Some systems have a C<locale> command which
969displays this (also, C<perl -e0> can be used to check locale settings, as 967displays this (also, C<perl -e0> can be used to check locale settings, as
970it will complain loudly if it cannot set the locale). If it displays something 968it will complain loudly if it cannot set the locale). If it displays something
… …
1064C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input 1062C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1065method servers are running with this command: 1063method servers are running with this command:
1066 1064
1067 xprop -root XIM_SERVERS 1065 xprop -root XIM_SERVERS
1068 1066
1069=item 1067=item
1070 1068
1071=back 1069=back
1072 1070
1073=head3 My input method wants <some encoding> but I want UTF-8, what can I do? 1071=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
1074 1072
… …
1119runtime-switchable, too, so there is usually no drawback to enabling them, 1117runtime-switchable, too, so there is usually no drawback to enabling them,
1120except higher disk and possibly memory usage. The perl interpreter should 1118except higher disk and possibly memory usage. The perl interpreter should
1121be enabled, as important functionality (menus, selection, likely more in 1119be enabled, as important functionality (menus, selection, likely more in
1122the future) depends on it. 1120the future) depends on it.
1123 1121
1124You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 1122You should not overwrite the C<perl-ext-common> and C<perl-ext> resources
1125system-wide (except maybe with C<defaults>). This will result in useful 1123system-wide (except maybe with C<defaults>). This will result in useful
1126behaviour. If your distribution aims at low memory, add an empty 1124behaviour. If your distribution aims at low memory, add an empty
1127C<perl-ext-common> resource to the app-defaults file. This will keep the 1125C<perl-ext-common> resource to the app-defaults file. This will keep the
1128perl interpreter disabled until the user enables it. 1126perl interpreter disabled until the user enables it.
1129 1127
… …
1147This forking is done as the very first within main(), which is very early 1145This forking is done as the very first within main(), which is very early
1148and reduces possible bugs to initialisation code run before main(), or 1146and reduces possible bugs to initialisation code run before main(), or
1149things like the dynamic loader of your system, which should result in very 1147things like the dynamic loader of your system, which should result in very
1150little risk. 1148little risk.
1151 1149
1152=head3 On Solaris 9, many line-drawing characters are too wide.
1153
1154Seems to be a known bug, read
1155L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
1156following ugly workaround to get non-double-wide-characters working:
1157
1158 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
1159
1160=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all. 1150=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
1161 1151
1162Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1152Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1163in your compile environment, or an implementation that implements it, 1153in your compile environment, or an implementation that implements it,
1164whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1154whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
… …
1167As you might have guessed, FreeBSD does neither define this symbol nor 1157As you might have guessed, FreeBSD does neither define this symbol nor
1168does it support it. Instead, it uses its own internal representation of 1158does it support it. Instead, it uses its own internal representation of
1169B<wchar_t>. This is, of course, completely fine with respect to standards. 1159B<wchar_t>. This is, of course, completely fine with respect to standards.
1170 1160
1171However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and 1161However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
1172C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>. 1162C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>).
1173 1163
1174C<__STDC_ISO_10646__> is the only sane way to support multi-language 1164C<__STDC_ISO_10646__> is the only sane way to support multi-language
1175apps in an OS, as using a locale-dependent (and non-standardized) 1165apps in an OS, as using a locale-dependent (and non-standardized)
1176representation of B<wchar_t> makes it impossible to convert between 1166representation of B<wchar_t> makes it impossible to convert between
1177B<wchar_t> (as used by X11 and your applications) and any other encoding 1167B<wchar_t> (as used by X11 and your applications) and any other encoding
… …
1187 1177
1188The rxvt-unicode author insists that the right way to fix this is in the 1178The rxvt-unicode author insists that the right way to fix this is in the
1189system libraries once and for all, instead of forcing every app to carry 1179system libraries once and for all, instead of forcing every app to carry
1190complete replacements for them :) 1180complete replacements for them :)
1191 1181
1192=head3 I use Solaris 9 and it doesn't compile/work/etc.
1193
1194Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
1195problems with C<wcwidth> and a compile problem.
1196
1197=head3 How can I use rxvt-unicode under cygwin? 1182=head3 How can I use rxvt-unicode under cygwin?
1198 1183
1199rxvt-unicode should compile and run out of the box on cygwin, using 1184rxvt-unicode should compile and run out of the box on cygwin, using
1200the X11 libraries that come with cygwin. libW11 emulation is no 1185the X11 libraries that come with cygwin. libW11 emulation is no
1201longer supported (and makes no sense, either, as it only supported a 1186longer supported (and makes no sense, either, as it only supported a
… …
1205 1190
1206At the time of this writing, cygwin didn't seem to support any multi-byte 1191At the time of this writing, cygwin didn't seem to support any multi-byte
1207encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited 1192encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1208to 8-bit encodings. 1193to 8-bit encodings.
1209 1194
1195=head3 Character widths are not correct.
1196
1197urxvt uses the system wcwidth function to know the information about
1198the width of characters, so on systems with incorrect locale data you
1199will likely get bad results. Two notorious examples are Solaris 9,
1200where single-width characters like U+2514 are reported as double-width,
1201and Darwin 8, where combining chars are reported having width 1.
1202
1203The solution is to upgrade your system or switch to a better one. A
1204possibly working workaround is to use a wcwidth implementation like
1205
1206http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1207
1210=head1 RXVT-UNICODE TECHNICAL REFERENCE 1208=head1 RXVT-UNICODE TECHNICAL REFERENCE
1211 1209
1212The rest of this document describes various technical aspects of 1210The rest of this document describes various technical aspects of
1213B<rxvt-unicode>. First the description of supported command sequences, 1211B<rxvt-unicode>. First the description of supported command sequences,
1214followed by pixmap support and last by a description of all features 1212followed by pixmap support and last by a description of all features
… …
1313 1311
1314=item B<< C<ESC => >> 1312=item B<< C<ESC => >>
1315 1313
1316Application Keypad (SMKX). See also next sequence. 1314Application Keypad (SMKX). See also next sequence.
1317 1315
1318=item B<<< C<< ESC >> >>> 1316=item B<<< C<< ESC > >> >>>
1319 1317
1320Normal Keypad (RMKX) 1318Normal Keypad (RMKX)
1321 1319
1322B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been 1320B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been
1323pressed, numbers or control functions are generated by the numeric keypad 1321pressed, numbers or control functions are generated by the numeric keypad
… …
1466=begin table 1464=begin table
1467 1465
1468 B<< C<Ps = 0> >> Clear to Right (default) 1466 B<< C<Ps = 0> >> Clear to Right (default)
1469 B<< C<Ps = 1> >> Clear to Left 1467 B<< C<Ps = 1> >> Clear to Left
1470 B<< C<Ps = 2> >> Clear All 1468 B<< C<Ps = 2> >> Clear All
1469 B<< C<Ps = 3> >> Like Ps = 0, but is ignored when wrapped
1470 (@@RXVT_NAME@@ extension)
1471 1471
1472=end table 1472=end table
1473 1473
1474=item B<< C<ESC [ Ps L> >> 1474=item B<< C<ESC [ Ps L> >>
1475 1475
… …
1607 B<< C<Ps = 32 / 42> >> fg/bg Green 1607 B<< C<Ps = 32 / 42> >> fg/bg Green
1608 B<< C<Ps = 33 / 43> >> fg/bg Yellow 1608 B<< C<Ps = 33 / 43> >> fg/bg Yellow
1609 B<< C<Ps = 34 / 44> >> fg/bg Blue 1609 B<< C<Ps = 34 / 44> >> fg/bg Blue
1610 B<< C<Ps = 35 / 45> >> fg/bg Magenta 1610 B<< C<Ps = 35 / 45> >> fg/bg Magenta
1611 B<< C<Ps = 36 / 46> >> fg/bg Cyan 1611 B<< C<Ps = 36 / 46> >> fg/bg Cyan
1612 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to color #m (ISO 8613-6) 1612 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to colour #m (ISO 8613-6)
1613 B<< C<Ps = 37 / 47> >> fg/bg White 1613 B<< C<Ps = 37 / 47> >> fg/bg White
1614 B<< C<Ps = 39 / 49> >> fg/bg Default 1614 B<< C<Ps = 39 / 49> >> fg/bg Default
1615 B<< C<Ps = 90 / 100> >> fg/bg Bright Black 1615 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
1616 B<< C<Ps = 91 / 101> >> fg/bg Bright Red 1616 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
1617 B<< C<Ps = 92 / 102> >> fg/bg Bright Green 1617 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
… …
1801 1801
1802=item B<< C<Pm = 30> >> 1802=item B<< C<Pm = 30> >>
1803 1803
1804=begin table 1804=begin table
1805 1805
1806 B<< C<h> >> scrollBar visisble 1806 B<< C<h> >> scrollBar visible
1807 B<< C<l> >> scrollBar invisisble 1807 B<< C<l> >> scrollBar invisible
1808 1808
1809=end table 1809=end table
1810 1810
1811=item B<< C<Pm = 35> >> (B<rxvt>) 1811=item B<< C<Pm = 35> >> (B<rxvt>)
1812 1812
… …
1863 1863
1864=item B<< C<Pm = 66> >> 1864=item B<< C<Pm = 66> >>
1865 1865
1866=begin table 1866=begin table
1867 1867
1868 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1868 B<< C<h> >> Application Keypad (DECKPAM/DECPAM) == C<ESC =>
1869 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1869 B<< C<l> >> Normal Keypad (DECKPNM/DECPNM) == C<< ESC > >>
1870 1870
1871=end table 1871=end table
1872 1872
1873=item B<< C<Pm = 67> >> 1873=item B<< C<Pm = 67> >>
1874 1874
… …
1895 B<< C<h> >> Use Hilite Mouse Tracking. 1895 B<< C<h> >> Use Hilite Mouse Tracking.
1896 B<< C<l> >> No mouse reporting. 1896 B<< C<l> >> No mouse reporting.
1897 1897
1898=end table 1898=end table
1899 1899
1900=item B<< C<Pm = 1002> >> (X11 XTerm)
1901
1902=begin table
1903
1904 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1905 B<< C<l> >> No mouse reporting.
1906
1907=end table
1908
1909=item B<< C<Pm = 1003> >> (X11 XTerm)
1910
1911=begin table
1912
1913 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1914 B<< C<l> >> No mouse reporting.
1915
1916=end table
1917
1900=item B<< C<Pm = 1010> >> (B<rxvt>) 1918=item B<< C<Pm = 1010> >> (B<rxvt>)
1901 1919
1902=begin table 1920=begin table
1903 1921
1904 B<< C<h> >> Don't scroll to bottom on TTY output 1922 B<< C<h> >> Don't scroll to bottom on TTY output
… …
1946 1964
1947=begin table 1965=begin table
1948 1966
1949 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it 1967 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1950 B<< C<l> >> Use Normal Screen Buffer 1968 B<< C<l> >> Use Normal Screen Buffer
1969
1970=end table
1971
1972=item B<< C<Pm = 2004> >>
1973
1974=begin table
1975
1976 B<< C<h> >> Enable bracketed paste mode - prepend / append to the pasted text the control sequences C<ESC [ 200 ~> / C<ESC [ 201 ~>
1977 B<< C<l> >> Disable bracketed paste mode
1951 1978
1952=end table 1979=end table
1953 1980
1954=back 1981=back
1955 1982
… …
1972 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >> 1999 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>
1973 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >> 2000 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1974 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> 2001 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
1975 B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property. 2002 B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property.
1976 B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white 2003 B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white
1977 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 2004 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >>
1978 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 2005 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >>
1979 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 2006 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1980 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 2007 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1981 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 2008 B<< C<Ps = 17> >> Change background colour of highlight characters to B<< C<Pt> >>
1982 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706] 2009 B<< C<Ps = 19> >> Change foreground colour of highlight characters to B<< C<Pt> >>
1983 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1984 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM). 2010 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile afterimage or pixbuf).
1985 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 2011 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. [deprecated, use 10]
1986 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 2012 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1987 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 2013 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. [deprecated, use 11]
1988 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> 2014 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
1989 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 2015 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> [disabled]
1990 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills). 2016 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
1991 B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>. 2017 B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>.
1992 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 2018 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1993 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). 2019 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1994 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >> 2020 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1995 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >> 2021 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
2022 B<< C<Ps = 708> >> Change colour of the border to B<< C<Pt> >>
1996 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 2023 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1997 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2024 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1998 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2025 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1999 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2026 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2000 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 2027 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
… …
2003 2030
2004=end table 2031=end table
2005 2032
2006=back 2033=back
2007 2034
2008=head1 XPM 2035=head1 BACKGROUND IMAGE
2009 2036
2010For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2037For the BACKGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> the value
2011of B<< C<Pt> >> can be the name of the background pixmap followed by a 2038of B<< C<Pt> >> can be the name of the background image file followed by a
2012sequence of scaling/positioning commands separated by semi-colons. The 2039sequence of scaling/positioning commands separated by semi-colons. The
2013scaling/positioning commands are as follows: 2040scaling/positioning commands are as follows:
2014 2041
2015=over 4 2042=over 4
2016 2043
… …
2054 2081
2055For example: 2082For example:
2056 2083
2057=over 4 2084=over 4
2058 2085
2059=item B<\E]20;funky\a> 2086=item B<\E]20;funky.jpg\a>
2060 2087
2061load B<funky.xpm> as a tiled image 2088load B<funky.jpg> as a tiled image
2062 2089
2063=item B<\E]20;mona;100\a> 2090=item B<\E]20;mona.jpg;100\a>
2064 2091
2065load B<mona.xpm> with a scaling of 100% 2092load B<mona.jpg> with a scaling of 100%
2066 2093
2067=item B<\E]20;;200;?\a> 2094=item B<\E]20;;200;?\a>
2068 2095
2069rescale the current pixmap to 200% and display the image geometry in 2096rescale the current pixmap to 200% and display the image geometry in
2070the title 2097the title
2071 2098
2072=back 2099=back
2100
2073X<Mouse> 2101X<Mouse>
2074 2102
2075=head1 Mouse Reporting 2103=head1 Mouse Reporting
2076 2104
2077=over 4 2105=over 4
… …
2118Col = B<< C<< <x> - SPACE >> >> 2146Col = B<< C<< <x> - SPACE >> >>
2119 2147
2120Row = B<< C<< <y> - SPACE >> >> 2148Row = B<< C<< <y> - SPACE >> >>
2121 2149
2122=back 2150=back
2151
2152=head1 Key Codes
2153
2123X<KeyCodes> 2154X<KeyCodes>
2124
2125=head1 Key Codes
2126 2155
2127Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 2156Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
2128 2157
2129For the keypad, use B<Shift> to temporarily override Application-Keypad 2158For the keypad, use B<Shift> to temporarily override Application-Keypad
2130setting use B<Num_Lock> to toggle Application-Keypad setting if 2159setting use B<Num_Lock> to toggle Application-Keypad setting if
2131B<Num_Lock> is off, toggle Application-Keypad setting. Also note that 2160B<Num_Lock> is off, toggle Application-Keypad setting. Also note that
2132values of B<Home>, B<End>, B<Delete> may have been compiled differently on 2161values of B<BackSpace>, B<Delete> may have been compiled differently on
2133your system. 2162your system.
2134 2163
2135=begin table 2164=begin table
2136 2165
2137 B<Normal> B<Shift> B<Control> B<Ctrl+Shift> 2166 B<Normal> B<Shift> B<Control> B<Ctrl+Shift>
… …
2197 2226
2198=head1 CONFIGURE OPTIONS 2227=head1 CONFIGURE OPTIONS
2199 2228
2200General hint: if you get compile errors, then likely your configuration 2229General hint: if you get compile errors, then likely your configuration
2201hasn't been tested well. Either try with C<--enable-everything> or use 2230hasn't been tested well. Either try with C<--enable-everything> or use
2202the F<./reconf> script as a base for experiments. F<./reconf> is used by 2231the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2203myself, so it should generally be a working config. Of course, you should 2232switches). Of course, you should always report when a combination doesn't
2204always report when a combination doesn't work, so it can be fixed. Marc 2233work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2205Lehmann <rxvt@schmorp.de>.
2206 2234
2207All 2235All
2208 2236
2209=over 4 2237=over 4
2210 2238
2211=item --enable-everything 2239=item --enable-everything
2212 2240
2213Add (or remove) support for all non-multichoice options listed in "./configure 2241Add (or remove) support for all non-multichoice options listed
2214--help". 2242in C<./configure --help>, except for C<--enable-assert> and
2243C<--enable-256-color>.
2215 2244
2216You can specify this and then disable options you do not like by 2245You can specify this and then disable options you do not like by
2217I<following> this with the appropriate C<--disable-...> arguments, 2246I<following> this with the appropriate C<--disable-...> arguments,
2218or you can start with a minimal configuration by specifying 2247or you can start with a minimal configuration by specifying
2219C<--disable-everything> and than adding just the C<--enable-...> arguments 2248C<--disable-everything> and than adding just the C<--enable-...> arguments
… …
2242 2271
2243=begin table 2272=begin table
2244 2273
2245 all all available codeset groups 2274 all all available codeset groups
2246 zh common chinese encodings 2275 zh common chinese encodings
2247 zh_ext rarely used but very big chinese encodigs 2276 zh_ext rarely used but very big chinese encodings
2248 jp common japanese encodings 2277 jp common japanese encodings
2249 jp_ext rarely used but big japanese encodings 2278 jp_ext rarely used but big japanese encodings
2250 kr korean encodings 2279 kr korean encodings
2251 2280
2252=end table 2281=end table
… …
2266requirements per character from 2 to 4 bytes. X11 fonts do not yet 2295requirements per character from 2 to 4 bytes. X11 fonts do not yet
2267support these extra characters, but Xft does. 2296support these extra characters, but Xft does.
2268 2297
2269Please note that rxvt-unicode can store unicode code points >65535 2298Please note that rxvt-unicode can store unicode code points >65535
2270even without this flag, but the number of such characters is 2299even without this flag, but the number of such characters is
2271limited to a view thousand (shared with combining characters, 2300limited to a few thousand (shared with combining characters,
2272see next switch), and right now rxvt-unicode cannot display them 2301see next switch), and right now rxvt-unicode cannot display them
2273(input/output and cut&paste still work, though). 2302(input/output and cut&paste still work, though).
2274 2303
2275=item --enable-combining (default: on) 2304=item --enable-combining (default: on)
2276 2305
2277Enable automatic composition of combining characters into 2306Enable automatic composition of combining characters into
2278composite characters. This is required for proper viewing of text 2307composite characters. This is required for proper viewing of text
2279where accents are encoded as seperate unicode characters. This is 2308where accents are encoded as separate unicode characters. This is
2280done by using precomposited characters when available or creating 2309done by using precomposited characters when available or creating
2281new pseudo-characters when no precomposed form exists. 2310new pseudo-characters when no precomposed form exists.
2282 2311
2283Without --enable-unicode3, the number of additional precomposed 2312Without --enable-unicode3, the number of additional precomposed
2284characters is somewhat limited (the 6400 private use characters will be 2313characters is somewhat limited (the 6400 private use characters will be
… …
2299=item --with-res-name=NAME (default: urxvt) 2328=item --with-res-name=NAME (default: urxvt)
2300 2329
2301Use the given name as default application name when 2330Use the given name as default application name when
2302reading resources. Specify --with-res-name=rxvt to replace rxvt. 2331reading resources. Specify --with-res-name=rxvt to replace rxvt.
2303 2332
2304=item --with-res-class=CLASS /default: URxvt) 2333=item --with-res-class=CLASS (default: URxvt)
2305 2334
2306Use the given class as default application class 2335Use the given class as default application class
2307when reading resources. Specify --with-res-class=Rxvt to replace 2336when reading resources. Specify --with-res-class=Rxvt to replace
2308rxvt. 2337rxvt.
2309 2338
… …
2322 2351
2323Write user and tty to lastlog file (used by programs like 2352Write user and tty to lastlog file (used by programs like
2324F<lastlogin>) at start of rxvt execution. This option requires 2353F<lastlogin>) at start of rxvt execution. This option requires
2325--enable-utmp to also be specified. 2354--enable-utmp to also be specified.
2326 2355
2356=item --enable-afterimage (default: on)
2357
2358Add support for libAfterImage to be used for background
2359images. It adds support for many file formats including JPG, PNG,
2360SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2361(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2362
2363This option also adds the possibility, when transparency is enabled,
2364of blending an image over the root background and blurring the root
2365background.
2366
2367Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2368increase by a few megabytes even if no extra features are used (mostly due
2369to third-party libraries used by libAI). Memory footprint may somewhat be
2370lowered if libAfterImage is configured without support for SVG.
2371
2327=item --enable-xpm-background (default: on) 2372=item --enable-pixbuf (default: off)
2328 2373
2329Add support for XPM background pixmaps. 2374Add support for GDK-PixBuf to be used for background images.
2375It adds support for many file formats including JPG, PNG,
2376TIFF, GIF, XPM, BMP, ICO and TGA.
2330 2377
2331=item --enable-transparency (default: on) 2378=item --enable-transparency (default: on)
2332 2379
2333Add support for inheriting parent backgrounds thus giving a fake 2380Add support for backgrounds, creating illusion of transparency in the term.
2334transparency to the term.
2335 2381
2336=item --enable-fading (default: on) 2382=item --enable-fading (default: on)
2337 2383
2338Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2384Add support for fading the text when focus is lost.
2339
2340=item --enable-tinting (default: on)
2341
2342Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2343 2385
2344=item --enable-rxvt-scroll (default: on) 2386=item --enable-rxvt-scroll (default: on)
2345 2387
2346Add support for the original rxvt scrollbar. 2388Add support for the original rxvt scrollbar.
2347 2389
… …
2350Add support for a NeXT-like scrollbar. 2392Add support for a NeXT-like scrollbar.
2351 2393
2352=item --enable-xterm-scroll (default: on) 2394=item --enable-xterm-scroll (default: on)
2353 2395
2354Add support for an Xterm-like scrollbar. 2396Add support for an Xterm-like scrollbar.
2355
2356=item --enable-plain-scroll (default: on)
2357
2358Add support for a very unobtrusive, plain-looking scrollbar that
2359is the favourite of the rxvt-unicode author, having used it for
2360many years.
2361
2362=item --enable-ttygid (default: off)
2363
2364Change tty device setting to group "tty" - only use this if
2365your system uses this type of security.
2366 2397
2367=item --disable-backspace-key 2398=item --disable-backspace-key
2368 2399
2369Removes any handling of the backspace key by us - let the X server do it. 2400Removes any handling of the backspace key by us - let the X server do it.
2370 2401
… …
2390A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2421A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2391in combination with other switches) is: 2422in combination with other switches) is:
2392 2423
2393 MWM-hints 2424 MWM-hints
2394 EWMH-hints (pid, utf8 names) and protocols (ping) 2425 EWMH-hints (pid, utf8 names) and protocols (ping)
2426 urgency hint
2395 seperate underline colour (-underlineColor) 2427 separate underline colour (-underlineColor)
2396 settable border widths and borderless switch (-w, -b, -bl) 2428 settable border widths and borderless switch (-w, -b, -bl)
2397 visual depth selection (-depth) 2429 visual depth selection (-depth)
2398 settable extra linespacing /-lsp) 2430 settable extra linespacing (-lsp)
2399 iso-14755-2 and -3, and visual feedback 2431 iso-14755 5.1 (basic) support
2400 tripleclickwords (-tcw) 2432 tripleclickwords (-tcw)
2401 settable insecure mode (-insecure) 2433 settable insecure mode (-insecure)
2402 keysym remapping support 2434 keysym remapping support
2403 cursor blinking and underline cursor (-cb, -uc) 2435 cursor blinking and underline cursor (-bc, -uc)
2404 XEmbed support (-embed) 2436 XEmbed support (-embed)
2405 user-pty (-pty-fd) 2437 user-pty (-pty-fd)
2406 hold on exit (-hold) 2438 hold on exit (-hold)
2439 compile in built-in block graphics
2407 skip builtin block graphics (-sbg) 2440 skip builtin block graphics (-sbg)
2408 separate highlightcolor support (-hc) 2441 separate highlight colour (-highlightColor, -highlightTextColor)
2409 2442
2410It also enables some non-essential features otherwise disabled, such as: 2443It also enables some non-essential features otherwise disabled, such as:
2411 2444
2412 some round-trip time optimisations 2445 some round-trip time optimisations
2413 nearest color allocation on pseudocolor screens 2446 nearest colour allocation on pseudocolor screens
2414 UTF8_STRING supporr for selection 2447 UTF8_STRING support for selection
2415 sgr modes 90..97 and 100..107 2448 sgr modes 90..97 and 100..107
2416 backindex and forwardindex escape sequences 2449 backindex and forwardindex escape sequences
2417 view change/zero scorllback esacpe sequences 2450 view change/zero scrollback escape sequences
2418 locale switching escape sequence 2451 locale switching escape sequence
2419 window op and some xterm/OSC escape sequences 2452 window op and some xterm/OSC escape sequences
2420 rectangular selections 2453 rectangular selections
2421 trailing space removal for selections 2454 trailing space removal for selections
2422 verbose X error handling 2455 verbose X error handling
2423 2456
2424=item --enable-iso14755 (default: on) 2457=item --enable-iso14755 (default: on)
2425 2458
2426Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2459Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)).
2427F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2460Basic support (section 5.1) is enabled by C<--enable-frills>, while
2428C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2461support for 5.2, 5.3 and 5.4 is enabled with this switch.
2429this switch.
2430 2462
2431=item --enable-keepscrolling (default: on) 2463=item --enable-keepscrolling (default: on)
2432 2464
2433Add support for continual scrolling of the display when you hold 2465Add support for continual scrolling of the display when you hold
2434the mouse button down on a scrollbar arrow. 2466the mouse button down on a scrollbar arrow.
2467
2468=item --enable-selectionscrolling (default: on)
2469
2470Add support for scrolling when the selection moves to the top or
2471bottom of the screen.
2435 2472
2436=item --enable-mousewheel (default: on) 2473=item --enable-mousewheel (default: on)
2437 2474
2438Add support for scrolling via mouse wheel or buttons 4 & 5. 2475Add support for scrolling via mouse wheel or buttons 4 & 5.
2439 2476
… …
2441 2478
2442Add support for continual scrolling (using the mouse wheel as an 2479Add support for continual scrolling (using the mouse wheel as an
2443accelerator) while the control key is held down. This option 2480accelerator) while the control key is held down. This option
2444requires --enable-mousewheel to also be specified. 2481requires --enable-mousewheel to also be specified.
2445 2482
2446=item --disable-new-selection
2447
2448Remove support for mouse selection style like that of xterm.
2449
2450=item --enable-dmalloc (default: off)
2451
2452Use Gray Watson's malloc - which is good for debugging See
2453L<http://www.letters.com/dmalloc/> for details If you use either this or the
2454next option, you may need to edit src/Makefile after compiling to point
2455DINCLUDE and DLIB to the right places.
2456
2457You can only use either this option and the following (should
2458you use either) .
2459
2460=item --enable-dlmalloc (default: off)
2461
2462Use Doug Lea's malloc - which is good for a production version
2463See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2464
2465=item --enable-smart-resize (default: on) 2483=item --enable-smart-resize (default: off)
2466 2484
2467Add smart growth/shrink behaviour when changing font size via hot 2485Add smart growth/shrink behaviour when resizing.
2468keys. This should keep the window corner which is closest to a corner of 2486This should keep the window corner which is closest to a corner of
2469the screen in a fixed position. 2487the screen in a fixed position.
2470 2488
2489=item --enable-text-blink (default: on)
2490
2491Add support for blinking text.
2492
2471=item --enable-pointer-blank (default: on) 2493=item --enable-pointer-blank (default: on)
2472 2494
2473Add support to have the pointer disappear when typing or inactive. 2495Add support to have the pointer disappear when typing or inactive.
2474 2496
2475=item --enable-perl (default: on) 2497=item --enable-perl (default: on)
2476 2498
2477Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2499Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2478manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files 2500manpage for more info on this feature, or the files in F<src/perl/>
2479in F<src/perl-ext/> for the extensions that are installed by default. The 2501for the extensions that are installed by default.
2480perl interpreter that is used can be specified via the C<PERL> environment 2502The perl interpreter that is used can be specified via the C<PERL>
2481variable when running configure. 2503environment variable when running configure. Even when compiled in,
2504perl will I<not> be initialised when all extensions have been disabled
2505C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2506resource standpoint.
2507
2508=item --enable-assert (default: off)
2509
2510Enables the assertions in the code, normally disabled. This switch is only
2511useful when developing rxvt-unicode.
2512
2513=item --enable-256-color (default: off)
2514
2515Force use of so-called 256 colour mode, to work around buggy applications
2516that do not support termcap/terminfo, or simply improve support for
2517applications hardcoding the xterm 256 colour table.
2518
2519This switch breaks termcap/terminfo compatibility to C<TERM=rxvt-unicode>,
2520and consequently sets C<TERM> to C<rxvt-unicode-256color> by default
2521(F<doc/etc/> contains termcap/terminfo definitions for both).
2522
2523It also results in higher memory usage and can slow down @@RXVT_NAME@@
2524dramatically when more than six fonts are in use by a terminal instance.
2525
2526=item --with-afterimage-config=DIR
2527
2528Look for the libAfterImage config script in DIR.
2482 2529
2483=item --with-name=NAME (default: urxvt) 2530=item --with-name=NAME (default: urxvt)
2484 2531
2485Set the basename for the installed binaries, resulting 2532Set the basename for the installed binaries, resulting
2486in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2533in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
… …
2496PATH. 2543PATH.
2497 2544
2498=item --with-x 2545=item --with-x
2499 2546
2500Use the X Window System (pretty much default, eh?). 2547Use the X Window System (pretty much default, eh?).
2501
2502=item --with-xpm-includes=DIR
2503
2504Look for the XPM includes in DIR.
2505
2506=item --with-xpm-library=DIR
2507
2508Look for the XPM library in DIR.
2509
2510=item --with-xpm
2511
2512Not needed - define via --enable-xpm-background.
2513 2548
2514=back 2549=back
2515 2550
2516=head1 AUTHORS 2551=head1 AUTHORS
2517 2552

Diff Legend

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