… | |
… | |
17 | |
17 | |
18 | This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting |
18 | This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting |
19 | all escape sequences, and other background information. |
19 | all escape sequences, and other background information. |
20 | |
20 | |
21 | The newest version of this document is also available on the World Wide Web at |
21 | The newest version of this document is also available on the World Wide Web at |
22 | L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. |
22 | L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>. |
|
|
23 | |
|
|
24 | The main manual page for @@RXVT_NAME@@ itself is available at |
|
|
25 | L<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 | |
31 | Before sending me mail, you could go to IRC: C<irc.freenode.net>, |
34 | Before sending me mail, you could go to IRC: C<irc.freenode.net>, |
32 | channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be |
35 | channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be |
33 | interested in learning about new and exciting problems (but not FAQs :). |
36 | interested in learning about new and exciting problems (but not FAQs :). |
|
|
37 | |
|
|
38 | =head3 I use Gentoo, and I have a problem... |
|
|
39 | |
|
|
40 | There are three big problems with Gentoo Linux: first of all, most if not |
|
|
41 | all Gentoo systems are completely broken (missing or mismatched header |
|
|
42 | files, broken compiler etc. are just the tip of the iceberg); secondly, |
|
|
43 | the Gentoo maintainer thinks it is a good idea to add broken patches to |
|
|
44 | the code; and lastly, it should be called Gentoo GNU/Linux. |
|
|
45 | |
|
|
46 | For these reasons, it is impossible to support rxvt-unicode on |
|
|
47 | Gentoo. Problems appearing on Gentoo systems will usually simply be |
|
|
48 | ignored 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 | |
37 | Beginning with version 7.3, there is a perl extension that implements a |
52 | Beginning with version 7.3, there is a perl extension that implements a |
38 | simple tabbed terminal. It is installed by default, so any of these should |
53 | simple 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 | |
75 | Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the |
90 | Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the |
76 | display, create the listening socket and then fork. |
91 | display, 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 | |
80 | If you want to start @@URXVT_NAME@@d automatically whenever you run |
95 | If 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 |
… | |
… | |
125 | fi |
140 | fi |
126 | |
141 | |
127 | =head3 How do I compile the manual pages on my own? |
142 | =head3 How do I compile the manual pages on my own? |
128 | |
143 | |
129 | You need to have a recent version of perl installed as F</usr/bin/perl>, |
144 | You need to have a recent version of perl installed as F</usr/bin/perl>, |
130 | one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to |
145 | one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from |
131 | the doc subdirectory and enter C<make alldoc>. |
146 | F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>. |
132 | |
147 | |
133 | =head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat? |
148 | =head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat? |
134 | |
149 | |
135 | I often get asked about this, and I think, no, they didn't cause extra |
150 | I often get asked about this, and I think, no, they didn't cause extra |
136 | bloat. If you compare a minimal rxvt and a minimal urxvt, you can see |
151 | bloat. If you compare a minimal rxvt and a minimal urxvt, you can see |
… | |
… | |
197 | |
212 | |
198 | And here is rxvt-unicode: |
213 | And here is rxvt-unicode: |
199 | |
214 | |
200 | libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) |
215 | libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) |
201 | libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) |
216 | libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) |
202 | libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) |
217 | libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) |
203 | libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) |
218 | libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) |
204 | /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) |
219 | /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) |
205 | |
220 | |
206 | No large bloated libraries (of course, none were linked in statically), |
221 | No large bloated libraries (of course, none were linked in statically), |
207 | except maybe libX11 :) |
222 | except maybe libX11 :) |
208 | |
223 | |
209 | |
224 | |
210 | =head2 Rendering, Font & Look and Feel Issues |
225 | =head2 Rendering, Font & Look and Feel Issues |
211 | |
226 | |
212 | =head3 I can't get transparency working, what am I doing wrong? |
227 | =head3 I can't get transparency working, what am I doing wrong? |
213 | |
228 | |
214 | First of all, transparency isn't officially supported in rxvt-unicode, so |
229 | First of all, please address all transparency related issues to Sasha Vasko at |
215 | you are mostly on your own. Do not bug the author about it (but you may |
230 | sasha@aftercode.net and do not bug the author about it. Also, if you can't |
216 | bug everybody else). Also, if you can't get it working consider it a rite |
231 | get it working consider it a rite of passage: ... and you failed. |
217 | of passage: ... and you failed. |
|
|
218 | |
232 | |
219 | Here are four ways to get transparency. B<Do> read the manpage and option |
233 | Here are four ways to get transparency. B<Do> read the manpage and option |
220 | descriptions for the programs mentioned and rxvt-unicode. Really, do it! |
234 | descriptions for the programs mentioned and rxvt-unicode. Really, do it! |
221 | |
235 | |
222 | 1. Use inheritPixmap: |
236 | 1. Use transparent mode: |
223 | |
237 | |
224 | Esetroot wallpaper.jpg |
238 | Esetroot wallpaper.jpg |
225 | @@URXVT_NAME@@ -ip -tint red -sh 40 |
239 | @@URXVT_NAME@@ -tr -tint red -sh 40 |
226 | |
240 | |
227 | That works. If you think it doesn't, you lack transparency and tinting |
241 | That works. If you think it doesn't, you lack transparency and tinting |
228 | support, or you are unable to read. |
242 | support, or you are unable to read. |
229 | |
243 | |
230 | 2. Use a simple pixmap and emulate pseudo-transparency. This enables you |
244 | 2. Use a simple pixmap and emulate pseudo-transparency. This enables you |
231 | to use effects other than tinting and shading: Just shade/tint/whatever |
245 | to use effects other than tinting and shading: Just shade/tint/whatever |
232 | your picture with gimp or any other tool: |
246 | your picture with gimp or any other tool: |
233 | |
247 | |
234 | convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm |
248 | convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg |
235 | @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background |
249 | @@URXVT_NAME@@ -pixmap "background.jpg;:root" |
236 | |
250 | |
237 | That works. If you think it doesn't, you lack XPM and Perl support, or you |
251 | That works. If you think it doesn't, you lack AfterImage support, or you |
238 | are unable to read. |
252 | are unable to read. |
239 | |
253 | |
240 | 3. Use an ARGB visual: |
254 | 3. Use an ARGB visual: |
241 | |
255 | |
242 | @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc |
256 | @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc |
… | |
… | |
342 | =head3 What's with this bold/blink stuff? |
356 | =head3 What's with this bold/blink stuff? |
343 | |
357 | |
344 | If no bold colour is set via C<colorBD:>, bold will invert text using the |
358 | If no bold colour is set via C<colorBD:>, bold will invert text using the |
345 | standard foreground colour. |
359 | standard foreground colour. |
346 | |
360 | |
347 | For the standard background colour, blinking will actually make the |
361 | For the standard background colour, blinking will actually make |
348 | text blink when compiled with C<--enable-blinking>. with standard |
362 | the text blink when compiled with C<--enable-text-blink>. Without |
349 | colours. Without C<--enable-blinking>, the blink attribute will be |
363 | C<--enable-text-blink>, the blink attribute will be ignored. |
350 | ignored. |
|
|
351 | |
364 | |
352 | On ANSI colours, bold/blink attributes are used to set high-intensity |
365 | On ANSI colours, bold/blink attributes are used to set high-intensity |
353 | foreground/background colors. |
366 | foreground/background colors. |
354 | |
367 | |
355 | color0-7 are the low-intensity colors. |
368 | color0-7 are the low-intensity colors. |
… | |
… | |
460 | has been designed yet). |
473 | has been designed yet). |
461 | |
474 | |
462 | Until then, you might get away with switching fonts at runtime (see L<Can |
475 | Until then, you might get away with switching fonts at runtime (see L<Can |
463 | I switch the fonts at runtime?> later in this document). |
476 | I switch the fonts at runtime?> later in this document). |
464 | |
477 | |
|
|
478 | =head3 How can I make mplayer display video correctly? |
|
|
479 | |
|
|
480 | We are working on it, in the meantime, as a workaround, use something like: |
|
|
481 | |
|
|
482 | @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...' |
|
|
483 | |
|
|
484 | |
465 | =head2 Keyboard, Mouse & User Interaction |
485 | =head2 Keyboard, Mouse & User Interaction |
466 | |
486 | |
467 | =head3 The new selection selects pieces that are too big, how can I select single words? |
487 | =head3 The new selection selects pieces that are too big, how can I select single words? |
468 | |
488 | |
469 | If you want to select e.g. alphanumeric words, you can use the following |
489 | If you want to select e.g. alphanumeric words, you can use the following |
… | |
… | |
476 | |
496 | |
477 | To get a selection that is very similar to the old code, try this pattern: |
497 | To get a selection that is very similar to the old code, try this pattern: |
478 | |
498 | |
479 | URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+) |
499 | URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+) |
480 | |
500 | |
481 | Please also note that the I<LeftClick Shift-LeftClik> combination also |
501 | Please also note that the I<LeftClick Shift-LeftClick> combination also |
482 | selects words like the old code. |
502 | selects words like the old code. |
483 | |
503 | |
484 | =head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it? |
504 | =head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it? |
485 | |
505 | |
486 | You can disable the perl extension completely by setting the |
506 | You can disable the perl extension completely by setting the |
… | |
… | |
562 | Backspace keysym (not likely for Linux ... see the following |
582 | Backspace keysym (not likely for Linux ... see the following |
563 | question) there are two standard values that can be used for |
583 | question) there are two standard values that can be used for |
564 | Backspace: C<^H> and C<^?>. |
584 | Backspace: C<^H> and C<^?>. |
565 | |
585 | |
566 | Historically, either value is correct, but rxvt-unicode adopts the debian |
586 | Historically, either value is correct, but rxvt-unicode adopts the debian |
567 | policy of using C<^?> when unsure, because it's the one only only correct |
587 | policy of using C<^?> when unsure, because it's the one and only correct |
568 | choice :). |
588 | choice :). |
569 | |
589 | |
570 | Rxvt-unicode tries to inherit the current stty settings and uses the value |
590 | Rxvt-unicode tries to inherit the current stty settings and uses the value |
571 | of `erase' to guess the value for backspace. If rxvt-unicode wasn't |
591 | of `erase' to guess the value for backspace. If rxvt-unicode wasn't |
572 | started from a terminal (say, from a menu or by remote shell), then the |
592 | started from a terminal (say, from a menu or by remote shell), then the |
… | |
… | |
604 | key has been assigned an escape sequence to match the vt100 for Execute |
624 | key has been assigned an escape sequence to match the vt100 for Execute |
605 | (C<ESC [ 3 ~>) and is in the supplied termcap/terminfo. |
625 | (C<ESC [ 3 ~>) and is in the supplied termcap/terminfo. |
606 | |
626 | |
607 | Some other Backspace problems: |
627 | Some other Backspace problems: |
608 | |
628 | |
609 | some editors use termcap/terminfo, |
629 | some editors use termcap/terminfo, |
610 | some editors (vim I'm told) expect Backspace = ^H, |
630 | some editors (vim I'm told) expect Backspace = ^H, |
611 | GNU Emacs (and Emacs-like editors) use ^H for help. |
631 | GNU Emacs (and Emacs-like editors) use ^H for help. |
612 | |
632 | |
613 | Perhaps someday this will all be resolved in a consistent manner. |
633 | Perhaps someday this will all be resolved in a consistent manner. |
614 | |
634 | |
… | |
… | |
655 | Rather than have rxvt-unicode try to accommodate all the various possible |
675 | Rather than have rxvt-unicode try to accommodate all the various possible |
656 | keyboard mappings, it is better to use `xmodmap' to remap the keys as |
676 | keyboard mappings, it is better to use `xmodmap' to remap the keys as |
657 | required for your particular machine. |
677 | required for your particular machine. |
658 | |
678 | |
659 | |
679 | |
660 | |
|
|
661 | =head2 Terminal Configuration |
680 | =head2 Terminal Configuration |
662 | |
681 | |
663 | =head3 Can I see a typical configuration? |
682 | =head3 Can I see a typical configuration? |
664 | |
683 | |
665 | The default configuration tries to be xterm-like, which I don't like that |
684 | The default configuration tries to be xterm-like, which I don't like that |
… | |
… | |
791 | IRC*boldFont: suxuseuro |
810 | IRC*boldFont: suxuseuro |
792 | IRC*colorBD: white |
811 | IRC*colorBD: white |
793 | IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007 |
812 | 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 |
813 | IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007 |
795 | |
814 | |
796 | C<Alt-Shift-1> and C<Alt-Shift-2> switch between two different font |
815 | C<Alt-Ctrl-1> and C<Alt-Ctrl-2> switch between two different font |
797 | sizes. C<suxuseuro> allows me to keep an eye (and actually read) |
816 | sizes. C<suxuseuro> allows me to keep an eye (and actually read) |
798 | stuff while keeping a very small window. If somebody pastes something |
817 | stuff while keeping a very small window. If somebody pastes something |
799 | complicated (e.g. japanese), I temporarily switch to a larger font. |
818 | complicated (e.g. japanese), I temporarily switch to a larger font. |
800 | |
819 | |
801 | The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor |
820 | The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor |
… | |
… | |
838 | |
857 | |
839 | The terminal description used by rxvt-unicode is not as widely available |
858 | The terminal description used by rxvt-unicode is not as widely available |
840 | as that for xterm, or even rxvt (for which the same problem often arises). |
859 | as that for xterm, or even rxvt (for which the same problem often arises). |
841 | |
860 | |
842 | The correct solution for this problem is to install the terminfo, this can |
861 | The correct solution for this problem is to install the terminfo, this can |
843 | be done like this (with ncurses' infocmp): |
862 | be done by simply installing rxvt-unicode on the remote system as well |
|
|
863 | (in case you have a nice package manager ready), or you can install the |
|
|
864 | terminfo database manually like this (with ncurses infocmp. works as |
|
|
865 | user and root): |
844 | |
866 | |
845 | REMOTE=remotesystem.domain |
867 | REMOTE=remotesystem.domain |
846 | infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" |
868 | infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti" |
847 | |
869 | |
848 | ... or by installing rxvt-unicode normally on the remote system, |
870 | One some systems you might need to set C<$TERMINFO> to the full path of |
|
|
871 | F<$HOME/.terminfo> for this to work. |
849 | |
872 | |
850 | If you cannot or do not want to do this, then you can simply set |
873 | If you cannot or do not want to do this, then you can simply set |
851 | C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of |
874 | C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of |
852 | problems arising, which includes wrong keymapping, less and different |
875 | problems arising, which includes wrong keymapping, less and different |
853 | colours and some refresh errors in fullscreen applications. It's a nice |
876 | colours and some refresh errors in fullscreen applications. It's a nice |
… | |
… | |
860 | URxvt.termName: rxvt |
883 | URxvt.termName: rxvt |
861 | |
884 | |
862 | If you don't plan to use B<rxvt> (quite common...) you could also replace |
885 | If you don't plan to use B<rxvt> (quite common...) you could also replace |
863 | the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>. |
886 | the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>. |
864 | |
887 | |
|
|
888 | =head3 nano fails with "Error opening terminal: rxvt-unicode" |
|
|
889 | |
|
|
890 | This exceptionally confusing and useless error message is printed by nano |
|
|
891 | when it can't find the terminfo database. Nothing is wrong with your |
|
|
892 | terminal, read the previous answer for a solution. |
|
|
893 | |
865 | =head3 C<tic> outputs some error when compiling the terminfo entry. |
894 | =head3 C<tic> outputs some error when compiling the terminfo entry. |
866 | |
895 | |
867 | Most likely it's the empty definition for C<enacs=>. Just replace it by |
896 | Most likely it's the empty definition for C<enacs=>. Just replace it by |
868 | C<enacs=\E[0@> and try again. |
897 | C<enacs=\E[0@> and try again. |
869 | |
898 | |
… | |
… | |
882 | You can also create a termcap entry by using terminfo's infocmp program |
911 | You can also create a termcap entry by using terminfo's infocmp program |
883 | like this: |
912 | like this: |
884 | |
913 | |
885 | infocmp -C rxvt-unicode |
914 | infocmp -C rxvt-unicode |
886 | |
915 | |
887 | Or you could use this termcap entry, generated by the command above: |
916 | Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap, |
888 | |
917 | generated 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 | |
918 | |
910 | =head3 Why does C<ls> no longer have coloured output? |
919 | =head3 Why does C<ls> no longer have coloured output? |
911 | |
920 | |
912 | The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to |
921 | The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to |
913 | decide whether a terminal has colour, but uses its own configuration |
922 | decide whether a terminal has colour, but uses its own configuration |
… | |
… | |
953 | If you encounter strange problems like typing an accented character but |
962 | If you encounter strange problems like typing an accented character but |
954 | getting two unrelated other characters or similar, or if program output is |
963 | getting two unrelated other characters or similar, or if program output is |
955 | subtly garbled, then you should check your locale settings. |
964 | subtly garbled, then you should check your locale settings. |
956 | |
965 | |
957 | Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the |
966 | Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the |
958 | programs. Often rxvt-unicode is started in the C<C> locale, while the |
967 | programs running in it. Often rxvt-unicode is started in the C<C> locale, |
959 | login script running within the rxvt-unicode window changes the locale to |
968 | while the login script running within the rxvt-unicode window changes the |
960 | something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work. |
969 | locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is |
|
|
970 | not going to work, and is the most common cause for problems. |
961 | |
971 | |
962 | The best thing is to fix your startup environment, as you will likely run |
972 | The best thing is to fix your startup environment, as you will likely run |
963 | into other problems. If nothing works you can try this in your .profile. |
973 | into other problems. If nothing works you can try this in your .profile. |
964 | |
974 | |
965 | printf '\33]701;%s\007' "$LC_CTYPE" |
975 | printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too |
966 | |
976 | |
967 | If this doesn't work, then maybe you use a C<LC_CTYPE> specification not |
977 | If this doesn't work, then maybe you use a C<LC_CTYPE> specification not |
968 | supported on your systems. Some systems have a C<locale> command which |
978 | supported on your systems. Some systems have a C<locale> command which |
969 | displays this (also, C<perl -e0> can be used to check locale settings, as |
979 | displays this (also, C<perl -e0> can be used to check locale settings, as |
970 | it will complain loudly if it cannot set the locale). If it displays something |
980 | it will complain loudly if it cannot set the locale). If it displays something |
… | |
… | |
1064 | C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input |
1074 | C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input |
1065 | method servers are running with this command: |
1075 | method servers are running with this command: |
1066 | |
1076 | |
1067 | xprop -root XIM_SERVERS |
1077 | xprop -root XIM_SERVERS |
1068 | |
1078 | |
1069 | =item |
1079 | =item |
1070 | |
1080 | |
1071 | =back |
1081 | =back |
1072 | |
1082 | |
1073 | =head3 My input method wants <some encoding> but I want UTF-8, what can I do? |
1083 | =head3 My input method wants <some encoding> but I want UTF-8, what can I do? |
1074 | |
1084 | |
… | |
… | |
1147 | This forking is done as the very first within main(), which is very early |
1157 | This forking is done as the very first within main(), which is very early |
1148 | and reduces possible bugs to initialisation code run before main(), or |
1158 | and reduces possible bugs to initialisation code run before main(), or |
1149 | things like the dynamic loader of your system, which should result in very |
1159 | things like the dynamic loader of your system, which should result in very |
1150 | little risk. |
1160 | little risk. |
1151 | |
1161 | |
1152 | =head3 On Solaris 9, many line-drawing characters are too wide. |
|
|
1153 | |
|
|
1154 | Seems to be a known bug, read |
|
|
1155 | L<http://nixdoc.net/files/forum/about34198.html>. Some people use the |
|
|
1156 | following 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. |
1162 | =head3 I am on FreeBSD and rxvt-unicode does not seem to work at all. |
1161 | |
1163 | |
1162 | Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined |
1164 | Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined |
1163 | in your compile environment, or an implementation that implements it, |
1165 | in your compile environment, or an implementation that implements it, |
1164 | whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that |
1166 | whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that |
… | |
… | |
1167 | As you might have guessed, FreeBSD does neither define this symbol nor |
1169 | As you might have guessed, FreeBSD does neither define this symbol nor |
1168 | does it support it. Instead, it uses its own internal representation of |
1170 | does it support it. Instead, it uses its own internal representation of |
1169 | B<wchar_t>. This is, of course, completely fine with respect to standards. |
1171 | B<wchar_t>. This is, of course, completely fine with respect to standards. |
1170 | |
1172 | |
1171 | However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and |
1173 | However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and |
1172 | C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>. |
1174 | C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>). |
1173 | |
1175 | |
1174 | C<__STDC_ISO_10646__> is the only sane way to support multi-language |
1176 | C<__STDC_ISO_10646__> is the only sane way to support multi-language |
1175 | apps in an OS, as using a locale-dependent (and non-standardized) |
1177 | apps in an OS, as using a locale-dependent (and non-standardized) |
1176 | representation of B<wchar_t> makes it impossible to convert between |
1178 | representation of B<wchar_t> makes it impossible to convert between |
1177 | B<wchar_t> (as used by X11 and your applications) and any other encoding |
1179 | B<wchar_t> (as used by X11 and your applications) and any other encoding |
… | |
… | |
1187 | |
1189 | |
1188 | The rxvt-unicode author insists that the right way to fix this is in the |
1190 | The rxvt-unicode author insists that the right way to fix this is in the |
1189 | system libraries once and for all, instead of forcing every app to carry |
1191 | system libraries once and for all, instead of forcing every app to carry |
1190 | complete replacements for them :) |
1192 | complete replacements for them :) |
1191 | |
1193 | |
1192 | =head3 I use Solaris 9 and it doesn't compile/work/etc. |
|
|
1193 | |
|
|
1194 | Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst |
|
|
1195 | problems with C<wcwidth> and a compile problem. |
|
|
1196 | |
|
|
1197 | =head3 How can I use rxvt-unicode under cygwin? |
1194 | =head3 How can I use rxvt-unicode under cygwin? |
1198 | |
1195 | |
1199 | rxvt-unicode should compile and run out of the box on cygwin, using |
1196 | rxvt-unicode should compile and run out of the box on cygwin, using |
1200 | the X11 libraries that come with cygwin. libW11 emulation is no |
1197 | the X11 libraries that come with cygwin. libW11 emulation is no |
1201 | longer supported (and makes no sense, either, as it only supported a |
1198 | longer supported (and makes no sense, either, as it only supported a |
… | |
… | |
1204 | old libW11 emulation. |
1201 | old libW11 emulation. |
1205 | |
1202 | |
1206 | At the time of this writing, cygwin didn't seem to support any multi-byte |
1203 | At the time of this writing, cygwin didn't seem to support any multi-byte |
1207 | encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited |
1204 | encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited |
1208 | to 8-bit encodings. |
1205 | to 8-bit encodings. |
|
|
1206 | |
|
|
1207 | =head3 Character widths are not correct. |
|
|
1208 | |
|
|
1209 | urxvt uses the system wcwidth function to know the information about |
|
|
1210 | the width of characters, so on systems with incorrect locale data you |
|
|
1211 | will likely get bad results. Two notorious examples are Solaris 9, |
|
|
1212 | where single-width characters like U+2514 are reported as double-width, |
|
|
1213 | and Darwin 8, where combining chars are reported having width 1. |
|
|
1214 | |
|
|
1215 | The solution is to upgrade your system or switch to a better one. A |
|
|
1216 | possibly working workaround is to use a wcwidth implementation like |
|
|
1217 | |
|
|
1218 | http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c |
|
|
1219 | |
|
|
1220 | =head3 I want 256 colors |
|
|
1221 | |
|
|
1222 | Are you sure you need 256 colors? 88 colors should be enough for most |
|
|
1223 | purposes. If you really need more, there is an unsupported patch for |
|
|
1224 | it in the doc directory, but please do not ask for it to be applied. |
1209 | |
1225 | |
1210 | =head1 RXVT-UNICODE TECHNICAL REFERENCE |
1226 | =head1 RXVT-UNICODE TECHNICAL REFERENCE |
1211 | |
1227 | |
1212 | The rest of this document describes various technical aspects of |
1228 | The rest of this document describes various technical aspects of |
1213 | B<rxvt-unicode>. First the description of supported command sequences, |
1229 | B<rxvt-unicode>. First the description of supported command sequences, |
… | |
… | |
1466 | =begin table |
1482 | =begin table |
1467 | |
1483 | |
1468 | B<< C<Ps = 0> >> Clear to Right (default) |
1484 | B<< C<Ps = 0> >> Clear to Right (default) |
1469 | B<< C<Ps = 1> >> Clear to Left |
1485 | B<< C<Ps = 1> >> Clear to Left |
1470 | B<< C<Ps = 2> >> Clear All |
1486 | B<< C<Ps = 2> >> Clear All |
|
|
1487 | B<< C<Ps = 3> >> Like Ps = 0, but is ignored when wrapped |
|
|
1488 | (@@RXVT_NAME@@ extension) |
1471 | |
1489 | |
1472 | =end table |
1490 | =end table |
1473 | |
1491 | |
1474 | =item B<< C<ESC [ Ps L> >> |
1492 | =item B<< C<ESC [ Ps L> >> |
1475 | |
1493 | |
… | |
… | |
1801 | |
1819 | |
1802 | =item B<< C<Pm = 30> >> |
1820 | =item B<< C<Pm = 30> >> |
1803 | |
1821 | |
1804 | =begin table |
1822 | =begin table |
1805 | |
1823 | |
1806 | B<< C<h> >> scrollBar visisble |
1824 | B<< C<h> >> scrollBar visible |
1807 | B<< C<l> >> scrollBar invisisble |
1825 | B<< C<l> >> scrollBar invisible |
1808 | |
1826 | |
1809 | =end table |
1827 | =end table |
1810 | |
1828 | |
1811 | =item B<< C<Pm = 35> >> (B<rxvt>) |
1829 | =item B<< C<Pm = 35> >> (B<rxvt>) |
1812 | |
1830 | |
… | |
… | |
1895 | B<< C<h> >> Use Hilite Mouse Tracking. |
1913 | B<< C<h> >> Use Hilite Mouse Tracking. |
1896 | B<< C<l> >> No mouse reporting. |
1914 | B<< C<l> >> No mouse reporting. |
1897 | |
1915 | |
1898 | =end table |
1916 | =end table |
1899 | |
1917 | |
|
|
1918 | =item B<< C<Pm = 1002> >> (X11 XTerm) |
|
|
1919 | |
|
|
1920 | =begin table |
|
|
1921 | |
|
|
1922 | B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed. |
|
|
1923 | B<< C<l> >> No mouse reporting. |
|
|
1924 | |
|
|
1925 | =end table |
|
|
1926 | |
|
|
1927 | =item B<< C<Pm = 1003> >> (X11 XTerm) |
|
|
1928 | |
|
|
1929 | =begin table |
|
|
1930 | |
|
|
1931 | B<< C<h> >> Send Mouse X & Y on button press and release, and motion. |
|
|
1932 | B<< C<l> >> No mouse reporting. |
|
|
1933 | |
|
|
1934 | =end table |
|
|
1935 | |
1900 | =item B<< C<Pm = 1010> >> (B<rxvt>) |
1936 | =item B<< C<Pm = 1010> >> (B<rxvt>) |
1901 | |
1937 | |
1902 | =begin table |
1938 | =begin table |
1903 | |
1939 | |
1904 | B<< C<h> >> Don't scroll to bottom on TTY output |
1940 | B<< C<h> >> Don't scroll to bottom on TTY output |
… | |
… | |
1946 | |
1982 | |
1947 | =begin table |
1983 | =begin table |
1948 | |
1984 | |
1949 | B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it |
1985 | B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it |
1950 | B<< C<l> >> Use Normal Screen Buffer |
1986 | B<< C<l> >> Use Normal Screen Buffer |
|
|
1987 | |
|
|
1988 | =end table |
|
|
1989 | |
|
|
1990 | =item B<< C<Pm = 2004> >> |
|
|
1991 | |
|
|
1992 | =begin table |
|
|
1993 | |
|
|
1994 | B<< C<h> >> Enable bracketed paste mode - prepend / append to the pasted text the control sequences C<ESC [ 200 ~> / C<ESC [ 201 ~> |
|
|
1995 | B<< C<l> >> Disable bracketed paste mode |
1951 | |
1996 | |
1952 | =end table |
1997 | =end table |
1953 | |
1998 | |
1954 | =back |
1999 | =back |
1955 | |
2000 | |
… | |
… | |
1972 | B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >> |
2017 | 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> >> |
2018 | B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >> |
1974 | B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> |
2019 | 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. |
2020 | 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 |
2021 | 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)> |
2022 | 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)> |
2023 | 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> >> |
2024 | 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> >> |
2025 | 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> >> |
2026 | B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> |
1982 | B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706] |
2027 | B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706] |
1983 | B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707] |
2028 | 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). |
2029 | B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage). |
1985 | B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. |
2030 | 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> |
2031 | 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> >>. |
2032 | 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> >> |
2033 | 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> >> |
2034 | 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). |
2035 | 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>. |
2036 | 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> >> |
2037 | 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). |
2038 | 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> >> |
2039 | 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> >> |
2040 | B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >> |
|
|
2041 | 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>. |
2042 | 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). |
2043 | 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). |
2044 | 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). |
2045 | 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). |
2046 | B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). |
… | |
… | |
2003 | |
2049 | |
2004 | =end table |
2050 | =end table |
2005 | |
2051 | |
2006 | =back |
2052 | =back |
2007 | |
2053 | |
2008 | =head1 XPM |
2054 | =head1 BACKGROUND IMAGE |
2009 | |
2055 | |
2010 | For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value |
2056 | For the BACKGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> the value |
2011 | of B<< C<Pt> >> can be the name of the background pixmap followed by a |
2057 | of B<< C<Pt> >> can be the name of the background image file followed by a |
2012 | sequence of scaling/positioning commands separated by semi-colons. The |
2058 | sequence of scaling/positioning commands separated by semi-colons. The |
2013 | scaling/positioning commands are as follows: |
2059 | scaling/positioning commands are as follows: |
2014 | |
2060 | |
2015 | =over 4 |
2061 | =over 4 |
2016 | |
2062 | |
… | |
… | |
2054 | |
2100 | |
2055 | For example: |
2101 | For example: |
2056 | |
2102 | |
2057 | =over 4 |
2103 | =over 4 |
2058 | |
2104 | |
2059 | =item B<\E]20;funky\a> |
2105 | =item B<\E]20;funky.jpg\a> |
2060 | |
2106 | |
2061 | load B<funky.xpm> as a tiled image |
2107 | load B<funky.jpg> as a tiled image |
2062 | |
2108 | |
2063 | =item B<\E]20;mona;100\a> |
2109 | =item B<\E]20;mona.jpg;100\a> |
2064 | |
2110 | |
2065 | load B<mona.xpm> with a scaling of 100% |
2111 | load B<mona.jpg> with a scaling of 100% |
2066 | |
2112 | |
2067 | =item B<\E]20;;200;?\a> |
2113 | =item B<\E]20;;200;?\a> |
2068 | |
2114 | |
2069 | rescale the current pixmap to 200% and display the image geometry in |
2115 | rescale the current pixmap to 200% and display the image geometry in |
2070 | the title |
2116 | the title |
2071 | |
2117 | |
2072 | =back |
2118 | =back |
|
|
2119 | |
2073 | X<Mouse> |
2120 | X<Mouse> |
2074 | |
2121 | |
2075 | =head1 Mouse Reporting |
2122 | =head1 Mouse Reporting |
2076 | |
2123 | |
2077 | =over 4 |
2124 | =over 4 |
… | |
… | |
2118 | Col = B<< C<< <x> - SPACE >> >> |
2165 | Col = B<< C<< <x> - SPACE >> >> |
2119 | |
2166 | |
2120 | Row = B<< C<< <y> - SPACE >> >> |
2167 | Row = B<< C<< <y> - SPACE >> >> |
2121 | |
2168 | |
2122 | =back |
2169 | =back |
|
|
2170 | |
|
|
2171 | =head1 Key Codes |
|
|
2172 | |
2123 | X<KeyCodes> |
2173 | X<KeyCodes> |
2124 | |
|
|
2125 | =head1 Key Codes |
|
|
2126 | |
2174 | |
2127 | Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> |
2175 | Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> |
2128 | |
2176 | |
2129 | For the keypad, use B<Shift> to temporarily override Application-Keypad |
2177 | For the keypad, use B<Shift> to temporarily override Application-Keypad |
2130 | setting use B<Num_Lock> to toggle Application-Keypad setting if |
2178 | setting use B<Num_Lock> to toggle Application-Keypad setting if |
… | |
… | |
2197 | |
2245 | |
2198 | =head1 CONFIGURE OPTIONS |
2246 | =head1 CONFIGURE OPTIONS |
2199 | |
2247 | |
2200 | General hint: if you get compile errors, then likely your configuration |
2248 | General hint: if you get compile errors, then likely your configuration |
2201 | hasn't been tested well. Either try with C<--enable-everything> or use |
2249 | hasn't been tested well. Either try with C<--enable-everything> or use |
2202 | the F<./reconf> script as a base for experiments. F<./reconf> is used by |
2250 | the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx> |
2203 | myself, so it should generally be a working config. Of course, you should |
2251 | switches). Of course, you should always report when a combination doesn't |
2204 | always report when a combination doesn't work, so it can be fixed. Marc |
2252 | work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>. |
2205 | Lehmann <rxvt@schmorp.de>. |
|
|
2206 | |
2253 | |
2207 | All |
2254 | All |
2208 | |
2255 | |
2209 | =over 4 |
2256 | =over 4 |
2210 | |
2257 | |
… | |
… | |
2242 | |
2289 | |
2243 | =begin table |
2290 | =begin table |
2244 | |
2291 | |
2245 | all all available codeset groups |
2292 | all all available codeset groups |
2246 | zh common chinese encodings |
2293 | zh common chinese encodings |
2247 | zh_ext rarely used but very big chinese encodigs |
2294 | zh_ext rarely used but very big chinese encodings |
2248 | jp common japanese encodings |
2295 | jp common japanese encodings |
2249 | jp_ext rarely used but big japanese encodings |
2296 | jp_ext rarely used but big japanese encodings |
2250 | kr korean encodings |
2297 | kr korean encodings |
2251 | |
2298 | |
2252 | =end table |
2299 | =end table |
… | |
… | |
2266 | requirements per character from 2 to 4 bytes. X11 fonts do not yet |
2313 | requirements per character from 2 to 4 bytes. X11 fonts do not yet |
2267 | support these extra characters, but Xft does. |
2314 | support these extra characters, but Xft does. |
2268 | |
2315 | |
2269 | Please note that rxvt-unicode can store unicode code points >65535 |
2316 | Please note that rxvt-unicode can store unicode code points >65535 |
2270 | even without this flag, but the number of such characters is |
2317 | even without this flag, but the number of such characters is |
2271 | limited to a view thousand (shared with combining characters, |
2318 | limited to a few thousand (shared with combining characters, |
2272 | see next switch), and right now rxvt-unicode cannot display them |
2319 | see next switch), and right now rxvt-unicode cannot display them |
2273 | (input/output and cut&paste still work, though). |
2320 | (input/output and cut&paste still work, though). |
2274 | |
2321 | |
2275 | =item --enable-combining (default: on) |
2322 | =item --enable-combining (default: on) |
2276 | |
2323 | |
… | |
… | |
2299 | =item --with-res-name=NAME (default: urxvt) |
2346 | =item --with-res-name=NAME (default: urxvt) |
2300 | |
2347 | |
2301 | Use the given name as default application name when |
2348 | Use the given name as default application name when |
2302 | reading resources. Specify --with-res-name=rxvt to replace rxvt. |
2349 | reading resources. Specify --with-res-name=rxvt to replace rxvt. |
2303 | |
2350 | |
2304 | =item --with-res-class=CLASS /default: URxvt) |
2351 | =item --with-res-class=CLASS (default: URxvt) |
2305 | |
2352 | |
2306 | Use the given class as default application class |
2353 | Use the given class as default application class |
2307 | when reading resources. Specify --with-res-class=Rxvt to replace |
2354 | when reading resources. Specify --with-res-class=Rxvt to replace |
2308 | rxvt. |
2355 | rxvt. |
2309 | |
2356 | |
… | |
… | |
2322 | |
2369 | |
2323 | Write user and tty to lastlog file (used by programs like |
2370 | Write user and tty to lastlog file (used by programs like |
2324 | F<lastlogin>) at start of rxvt execution. This option requires |
2371 | F<lastlogin>) at start of rxvt execution. This option requires |
2325 | --enable-utmp to also be specified. |
2372 | --enable-utmp to also be specified. |
2326 | |
2373 | |
2327 | =item --enable-xpm-background (default: on) |
2374 | =item --enable-afterimage (default: on) |
2328 | |
2375 | |
2329 | Add support for XPM background pixmaps. |
2376 | Add support for libAfterImage to be used for transparency and background |
|
|
2377 | images. It adds support for many file formats including JPG, PNG, |
|
|
2378 | SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML |
|
|
2379 | (L<http://www.afterstep.org/visualdoc.php?show=asimagexml>). |
|
|
2380 | |
|
|
2381 | This option also adds such eye candy as blending an image over the root |
|
|
2382 | background, as well as dynamic scaling and bluring of background images. |
|
|
2383 | |
|
|
2384 | Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might |
|
|
2385 | increase by a few megabytes even if no extra features are used (mostly due |
|
|
2386 | to third-party libraries used by libAI). Memory footprint may somewhat be |
|
|
2387 | lowered if libAfterImage is configured without support for SVG. |
2330 | |
2388 | |
2331 | =item --enable-transparency (default: on) |
2389 | =item --enable-transparency (default: on) |
2332 | |
2390 | |
2333 | Add support for inheriting parent backgrounds thus giving a fake |
2391 | Add support for backgrounds, creating illusion of transparency in the term. |
2334 | transparency to the term. |
|
|
2335 | |
2392 | |
2336 | =item --enable-fading (default: on) |
2393 | =item --enable-fading (default: on) |
2337 | |
2394 | |
2338 | Add support for fading the text when focus is lost (requires C<--enable-transparency>). |
2395 | Add support for fading the text when focus is lost. |
2339 | |
|
|
2340 | =item --enable-tinting (default: on) |
|
|
2341 | |
|
|
2342 | Add support for tinting of transparent backgrounds (requires C<--enable-transparency>). |
|
|
2343 | |
2396 | |
2344 | =item --enable-rxvt-scroll (default: on) |
2397 | =item --enable-rxvt-scroll (default: on) |
2345 | |
2398 | |
2346 | Add support for the original rxvt scrollbar. |
2399 | Add support for the original rxvt scrollbar. |
2347 | |
2400 | |
… | |
… | |
2350 | Add support for a NeXT-like scrollbar. |
2403 | Add support for a NeXT-like scrollbar. |
2351 | |
2404 | |
2352 | =item --enable-xterm-scroll (default: on) |
2405 | =item --enable-xterm-scroll (default: on) |
2353 | |
2406 | |
2354 | Add support for an Xterm-like scrollbar. |
2407 | Add support for an Xterm-like scrollbar. |
2355 | |
|
|
2356 | =item --enable-plain-scroll (default: on) |
|
|
2357 | |
|
|
2358 | Add support for a very unobtrusive, plain-looking scrollbar that |
|
|
2359 | is the favourite of the rxvt-unicode author, having used it for |
|
|
2360 | many years. |
|
|
2361 | |
|
|
2362 | =item --enable-ttygid (default: off) |
|
|
2363 | |
|
|
2364 | Change tty device setting to group "tty" - only use this if |
|
|
2365 | your system uses this type of security. |
|
|
2366 | |
2408 | |
2367 | =item --disable-backspace-key |
2409 | =item --disable-backspace-key |
2368 | |
2410 | |
2369 | Removes any handling of the backspace key by us - let the X server do it. |
2411 | Removes any handling of the backspace key by us - let the X server do it. |
2370 | |
2412 | |
… | |
… | |
2390 | A non-exhaustive list of features enabled by C<--enable-frills> (possibly |
2432 | A non-exhaustive list of features enabled by C<--enable-frills> (possibly |
2391 | in combination with other switches) is: |
2433 | in combination with other switches) is: |
2392 | |
2434 | |
2393 | MWM-hints |
2435 | MWM-hints |
2394 | EWMH-hints (pid, utf8 names) and protocols (ping) |
2436 | EWMH-hints (pid, utf8 names) and protocols (ping) |
|
|
2437 | urgency hint |
2395 | seperate underline colour (-underlineColor) |
2438 | seperate underline colour (-underlineColor) |
2396 | settable border widths and borderless switch (-w, -b, -bl) |
2439 | settable border widths and borderless switch (-w, -b, -bl) |
2397 | visual depth selection (-depth) |
2440 | visual depth selection (-depth) |
2398 | settable extra linespacing /-lsp) |
2441 | settable extra linespacing /-lsp) |
2399 | iso-14755-2 and -3, and visual feedback |
2442 | iso-14755 5.1 (basic) support |
2400 | tripleclickwords (-tcw) |
2443 | tripleclickwords (-tcw) |
2401 | settable insecure mode (-insecure) |
2444 | settable insecure mode (-insecure) |
2402 | keysym remapping support |
2445 | keysym remapping support |
2403 | cursor blinking and underline cursor (-cb, -uc) |
2446 | cursor blinking and underline cursor (-cb, -uc) |
2404 | XEmbed support (-embed) |
2447 | XEmbed support (-embed) |
2405 | user-pty (-pty-fd) |
2448 | user-pty (-pty-fd) |
2406 | hold on exit (-hold) |
2449 | hold on exit (-hold) |
|
|
2450 | compile in built-in block graphics |
2407 | skip builtin block graphics (-sbg) |
2451 | skip builtin block graphics (-sbg) |
2408 | separate highlightcolor support (-hc) |
2452 | separate highlightcolor support (-hc) |
2409 | |
2453 | |
2410 | It also enables some non-essential features otherwise disabled, such as: |
2454 | It also enables some non-essential features otherwise disabled, such as: |
2411 | |
2455 | |
2412 | some round-trip time optimisations |
2456 | some round-trip time optimisations |
2413 | nearest color allocation on pseudocolor screens |
2457 | nearest color allocation on pseudocolor screens |
2414 | UTF8_STRING supporr for selection |
2458 | UTF8_STRING support for selection |
2415 | sgr modes 90..97 and 100..107 |
2459 | sgr modes 90..97 and 100..107 |
2416 | backindex and forwardindex escape sequences |
2460 | backindex and forwardindex escape sequences |
2417 | view change/zero scorllback esacpe sequences |
2461 | view change/zero scrollback escape sequences |
2418 | locale switching escape sequence |
2462 | locale switching escape sequence |
2419 | window op and some xterm/OSC escape sequences |
2463 | window op and some xterm/OSC escape sequences |
2420 | rectangular selections |
2464 | rectangular selections |
2421 | trailing space removal for selections |
2465 | trailing space removal for selections |
2422 | verbose X error handling |
2466 | verbose X error handling |
2423 | |
2467 | |
2424 | =item --enable-iso14755 (default: on) |
2468 | =item --enable-iso14755 (default: on) |
2425 | |
2469 | |
2426 | Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or |
2470 | Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)). |
2427 | F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by |
2471 | Basic support (section 5.1) is enabled by C<--enable-frills>, while |
2428 | C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with |
2472 | support for 5.2, 5.3 and 5.4 is enabled with this switch. |
2429 | this switch. |
|
|
2430 | |
2473 | |
2431 | =item --enable-keepscrolling (default: on) |
2474 | =item --enable-keepscrolling (default: on) |
2432 | |
2475 | |
2433 | Add support for continual scrolling of the display when you hold |
2476 | Add support for continual scrolling of the display when you hold |
2434 | the mouse button down on a scrollbar arrow. |
2477 | the mouse button down on a scrollbar arrow. |
|
|
2478 | |
|
|
2479 | =item --enable-selectionscrolling (default: on) |
|
|
2480 | |
|
|
2481 | Add support for scrolling when the selection moves to the top or |
|
|
2482 | bottom of the screen. |
2435 | |
2483 | |
2436 | =item --enable-mousewheel (default: on) |
2484 | =item --enable-mousewheel (default: on) |
2437 | |
2485 | |
2438 | Add support for scrolling via mouse wheel or buttons 4 & 5. |
2486 | Add support for scrolling via mouse wheel or buttons 4 & 5. |
2439 | |
2487 | |
… | |
… | |
2441 | |
2489 | |
2442 | Add support for continual scrolling (using the mouse wheel as an |
2490 | Add support for continual scrolling (using the mouse wheel as an |
2443 | accelerator) while the control key is held down. This option |
2491 | accelerator) while the control key is held down. This option |
2444 | requires --enable-mousewheel to also be specified. |
2492 | requires --enable-mousewheel to also be specified. |
2445 | |
2493 | |
2446 | =item --disable-new-selection |
|
|
2447 | |
|
|
2448 | Remove support for mouse selection style like that of xterm. |
|
|
2449 | |
|
|
2450 | =item --enable-dmalloc (default: off) |
|
|
2451 | |
|
|
2452 | Use Gray Watson's malloc - which is good for debugging See |
|
|
2453 | L<http://www.letters.com/dmalloc/> for details If you use either this or the |
|
|
2454 | next option, you may need to edit src/Makefile after compiling to point |
|
|
2455 | DINCLUDE and DLIB to the right places. |
|
|
2456 | |
|
|
2457 | You can only use either this option and the following (should |
|
|
2458 | you use either) . |
|
|
2459 | |
|
|
2460 | =item --enable-dlmalloc (default: off) |
|
|
2461 | |
|
|
2462 | Use Doug Lea's malloc - which is good for a production version |
|
|
2463 | See L<http://g.oswego.edu/dl/html/malloc.html> for details. |
|
|
2464 | |
|
|
2465 | =item --enable-smart-resize (default: on) |
2494 | =item --enable-smart-resize (default: off) |
2466 | |
2495 | |
2467 | Add smart growth/shrink behaviour when changing font size via hot |
2496 | Add smart growth/shrink behaviour when resizing. |
2468 | keys. This should keep the window corner which is closest to a corner of |
2497 | This should keep the window corner which is closest to a corner of |
2469 | the screen in a fixed position. |
2498 | the screen in a fixed position. |
2470 | |
2499 | |
|
|
2500 | =item --enable-text-blink (default: on) |
|
|
2501 | |
|
|
2502 | Add support for blinking text. |
|
|
2503 | |
2471 | =item --enable-pointer-blank (default: on) |
2504 | =item --enable-pointer-blank (default: on) |
2472 | |
2505 | |
2473 | Add support to have the pointer disappear when typing or inactive. |
2506 | Add support to have the pointer disappear when typing or inactive. |
2474 | |
2507 | |
2475 | =item --enable-perl (default: on) |
2508 | =item --enable-perl (default: on) |
2476 | |
2509 | |
2477 | Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> |
2510 | Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> |
2478 | manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files |
2511 | manpage for more info on this feature, or the files in F<src/perl/> |
2479 | in F<src/perl-ext/> for the extensions that are installed by default. The |
2512 | for the extensions that are installed by default. |
2480 | perl interpreter that is used can be specified via the C<PERL> environment |
2513 | The perl interpreter that is used can be specified via the C<PERL> |
2481 | variable when running configure. |
2514 | environment variable when running configure. Even when compiled in, |
|
|
2515 | perl will I<not> be initialised when all extensions have been disabled |
|
|
2516 | C<-pe "" --perl-ext-common "">, so it should be safe to enable from a |
|
|
2517 | resource standpoint. |
|
|
2518 | |
|
|
2519 | =item --with-afterimage-config=DIR |
|
|
2520 | |
|
|
2521 | Look for the libAfterImage config script in DIR. |
2482 | |
2522 | |
2483 | =item --with-name=NAME (default: urxvt) |
2523 | =item --with-name=NAME (default: urxvt) |
2484 | |
2524 | |
2485 | Set the basename for the installed binaries, resulting |
2525 | Set the basename for the installed binaries, resulting |
2486 | in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with |
2526 | in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with |
… | |
… | |
2496 | PATH. |
2536 | PATH. |
2497 | |
2537 | |
2498 | =item --with-x |
2538 | =item --with-x |
2499 | |
2539 | |
2500 | Use the X Window System (pretty much default, eh?). |
2540 | Use the X Window System (pretty much default, eh?). |
2501 | |
|
|
2502 | =item --with-xpm-includes=DIR |
|
|
2503 | |
|
|
2504 | Look for the XPM includes in DIR. |
|
|
2505 | |
|
|
2506 | =item --with-xpm-library=DIR |
|
|
2507 | |
|
|
2508 | Look for the XPM library in DIR. |
|
|
2509 | |
|
|
2510 | =item --with-xpm |
|
|
2511 | |
|
|
2512 | Not needed - define via --enable-xpm-background. |
|
|
2513 | |
2541 | |
2514 | =back |
2542 | =back |
2515 | |
2543 | |
2516 | =head1 AUTHORS |
2544 | =head1 AUTHORS |
2517 | |
2545 | |