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.105 by root, Tue Jan 31 21:00:26 2006 UTC vs.
Revision 1.249 by sf-exg, Sun May 9 05:53:10 2021 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 two big problems with Gentoo Linux: first, most if not all
41Gentoo systems are completely broken (missing or mismatched header
42files, broken compiler etc. are just the tip of the iceberg);
43secondly, it should be called Gentoo GNU/Linux.
44
45For these reasons, it is impossible to support rxvt-unicode on
46Gentoo. Problems appearing on Gentoo systems will usually simply be
47ignored unless they can be reproduced on non-Gentoo systems.
34 48
35=head3 Does it support tabs, can I have a tabbed rxvt-unicode? 49=head3 Does it support tabs, can I have a tabbed rxvt-unicode?
36 50
37Beginning with version 7.3, there is a perl extension that implements a 51Beginning 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 52simple 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? 87=head3 How can I start @@URXVT_NAME@@d in a race-free way?
74 88
75Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the 89Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
76display, create the listening socket and then fork. 90display, create the listening socket and then fork.
77 91
78=head3 How do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc. 92=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
93
94If you want to start @@URXVT_NAME@@d automatically whenever you run
95@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
96
97 #!/bin/sh
98 @@URXVT_NAME@@c "$@"
99 if [ $? -eq 2 ]; then
100 @@URXVT_NAME@@d -q -o -f
101 @@URXVT_NAME@@c "$@"
102 fi
103
104This tries to create a new terminal, and if fails with exit status 2,
105meaning it couldn't connect to the daemon, it will start the daemon and
106re-run the command. Subsequent invocations of the script will re-use the
107existing daemon.
108
109Another option is to use systemd socket-based activation (see
110systemd.socket(5)). Here is an example of a service unit file and of a
111socket unit file for the default socket path:
112
113=over 4
114
115=item urxvtd.service
116
117 [Unit]
118 Description=urxvt terminal daemon
119 Requires=urxvtd.socket
120
121 [Service]
122 ExecStart=/usr/bin/urxvtd -o
123
124=item urxvtd.socket
125
126 [Unit]
127 Description=urxvt terminal daemon socket
128
129 [Socket]
130 ListenStream=%h/.urxvt/urxvtd-%H
131
132 [Install]
133 WantedBy=sockets.target
134
135=back
136
137=head3 How do I distinguish whether I'm running rxvt-unicode or a regular
138xterm? I need this to decide about setting colours etc.
79 139
80The original rxvt and rxvt-unicode always export the variable "COLORTERM", 140The original rxvt and rxvt-unicode always export the variable "COLORTERM",
81so you can check and see if that is set. Note that several programs, JED, 141so you can check and see if that is set. Note that several programs, JED,
82slrn, Midnight Commander automatically check this variable to decide 142slrn, Midnight Commander automatically check this variable to decide
83whether or not to use color. 143whether or not to use colour.
84 144
85=head3 How do I set the correct, full IP address for the DISPLAY variable? 145=head3 How do I set the correct, full IP address for the DISPLAY variable?
86 146
87If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled 147If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
88insecure mode then it is possible to use the following shell script 148insecure mode then it is possible to use the following shell script
… …
96 156
97 # Bourne/Korn/POSIX family of shells: 157 # Bourne/Korn/POSIX family of shells:
98 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know 158 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
99 if [ ${TERM:-foo} = xterm ]; then 159 if [ ${TERM:-foo} = xterm ]; then
100 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not 160 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
101 echo -n '^[Z' 161 printf "\eZ"
102 read term_id 162 read term_id
103 stty icanon echo 163 stty icanon echo
104 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then 164 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
105 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string 165 printf '\e[7n' # query the rxvt we are in for the DISPLAY string
106 read DISPLAY # set it in our local shell 166 read DISPLAY # set it in our local shell
107 fi 167 fi
108 fi 168 fi
109 169
110=head3 How do I compile the manual pages on my own? 170=head3 How do I compile the manual pages on my own?
111 171
112You need to have a recent version of perl installed as F</usr/bin/perl>, 172You need to have a recent version of perl installed as F</usr/bin/perl>,
113one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to 173one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from
114the doc subdirectory and enter C<make alldoc>. 174F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
115 175
116=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat? 176=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
117 177
118I often get asked about this, and I think, no, they didn't cause extra 178I often get asked about this, and I think, no, they didn't cause extra
119bloat. If you compare a minimal rxvt and a minimal urxvt, you can see 179bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
… …
125 185
126 text data bss drs rss filename 186 text data bss drs rss filename
127 98398 1664 24 15695 1824 rxvt --disable-everything 187 98398 1664 24 15695 1824 rxvt --disable-everything
128 188985 9048 66616 18222 1788 urxvt --disable-everything 188 188985 9048 66616 18222 1788 urxvt --disable-everything
129 189
130When you C<--enable-everything> (which _is_ unfair, as this involves xft 190When you C<--enable-everything> (which I<is> unfair, as this involves xft
131and full locale/XIM support which are quite bloaty inside libX11 and my 191and full locale/XIM support which are quite bloaty inside libX11 and my
132libc), the two diverge, but not unreasnobaly so. 192libc), the two diverge, but not unreasonably so.
133 193
134 text data bss drs rss filename 194 text data bss drs rss filename
135 163431 2152 24 20123 2060 rxvt --enable-everything 195 163431 2152 24 20123 2060 rxvt --enable-everything
136 1035683 49680 66648 29096 3680 urxvt --enable-everything 196 1035683 49680 66648 29096 3680 urxvt --enable-everything
137 197
… …
166the case of rxvt-unicode this hardly matters, as its portability limits 226the case of rxvt-unicode this hardly matters, as its portability limits
167are defined by things like X11, pseudo terminals, locale support and unix 227are defined by things like X11, pseudo terminals, locale support and unix
168domain sockets, which are all less portable than C++ itself. 228domain sockets, which are all less portable than C++ itself.
169 229
170Regarding the bloat, see the above question: It's easy to write programs 230Regarding the bloat, see the above question: It's easy to write programs
171in C that use gobs of memory, an certainly possible to write programs in 231in C that use gobs of memory, and certainly possible to write programs in
172C++ that don't. C++ also often comes with large libraries, but this is 232C++ that don't. C++ also often comes with large libraries, but this is
173not necessarily the case with GCC. Here is what rxvt links against on my 233not necessarily the case with GCC. Here is what rxvt links against on my
174system with a minimal config: 234system with a minimal config:
175 235
176 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) 236 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
… …
180 240
181And here is rxvt-unicode: 241And here is rxvt-unicode:
182 242
183 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) 243 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
184 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) 244 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
185 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) 245 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
186 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) 246 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
187 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) 247 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
188 248
189No large bloated libraries (of course, none were linked in statically), 249No large bloated libraries (of course, none were linked in statically),
190except maybe libX11 :) 250except maybe libX11 :)
191 251
192 252
… …
200of passage: ... and you failed. 260of passage: ... and you failed.
201 261
202Here are four ways to get transparency. B<Do> read the manpage and option 262Here are four ways to get transparency. B<Do> read the manpage and option
203descriptions for the programs mentioned and rxvt-unicode. Really, do it! 263descriptions for the programs mentioned and rxvt-unicode. Really, do it!
204 264
2051. Use inheritPixmap: 2651. Use transparent mode:
206 266
207 Esetroot wallpaper.jpg 267 Esetroot wallpaper.jpg
208 @@URXVT_NAME@@ -ip -tint red -sh 40 268 @@URXVT_NAME@@ -tr -tint red -sh 40
209 269
210That works. If you think it doesn't, you lack transparency and tinting 270That works. If you think it doesn't, you lack transparency and tinting
211support, or you are unable to read. 271support, or you are unable to read.
272This method requires that the background-setting program sets the
273_XROOTPMAP_ID or ESETROOT_PMAP_ID property. Compatible programs
274are Esetroot, hsetroot and feh.
212 275
2132. Use a simple pixmap and emulate pseudo-transparency. This enables you 2762. Use a simple pixmap and emulate pseudo-transparency. This enables you
214to use effects other than tinting and shading: Just shade/tint/whatever 277to use effects other than tinting and shading: Just shade/tint/whatever
215your picture with gimp or any other tool: 278your picture with gimp or any other tool:
216 279
217 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm 280 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
218 @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background 281 @@URXVT_NAME@@ -pixmap "background.jpg;:root"
219 282
220That works. If you think it doesn't, you lack XPM and Perl support, or you 283That works. If you think it doesn't, you lack GDK-PixBuf support, or you
221are unable to read. 284are unable to read.
222 285
2233. Use an ARGB visual: 2863. Use an ARGB visual:
224 287
225 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc 288 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
226 289
227This requires XFT support, and the support of your X-server. If that 290This requires XFT support, and the support of your X-server. If that
228doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't 291doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
229there yet, no matter what they claim. Rxvt-Unicode contains the neccessary 292there yet, no matter what they claim. Rxvt-Unicode contains the necessary
230bugfixes and workarounds for Xft and Xlib to make it work, but that 293bugfixes and workarounds for Xft and Xlib to make it work, but that
231doesn't mean that your WM has the required kludges in place. 294doesn't mean that your WM has the required kludges in place.
232 295
2334. Use xcompmgr and let it do the job: 2964. Use xcompmgr and let it do the job:
234 297
… …
236 -set _NET_WM_WINDOW_OPACITY 0xc0000000 299 -set _NET_WM_WINDOW_OPACITY 0xc0000000
237 300
238Then click on a window you want to make transparent. Replace C<0xc0000000> 301Then click on a window you want to make transparent. Replace C<0xc0000000>
239by other values to change the degree of opacity. If it doesn't work and 302by other values to change the degree of opacity. If it doesn't work and
240your server crashes, you got to keep the pieces. 303your server crashes, you got to keep the pieces.
241
242=head3 Why do some chinese characters look so different than others?
243
244This is because there is a difference between script and language --
245rxvt-unicode does not know which language the text that is output is,
246as it only knows the unicode character codes. If rxvt-unicode first
247sees a japanese/chinese character, it might choose a japanese font for
248display. Subsequent japanese characters will use that font. Now, many
249chinese characters aren't represented in japanese fonts, so when the first
250non-japanese character comes up, rxvt-unicode will look for a chinese font
251-- unfortunately at this point, it will still use the japanese font for
252chinese characters that are also in the japanese font.
253
254The workaround is easy: just tag a chinese font at the end of your font
255list (see the previous question). The key is to view the font list as
256a preference list: If you expect more japanese, list a japanese font
257first. If you expect more chinese, put a chinese font first.
258
259In the future it might be possible to switch language preferences at
260runtime (the internal data structure has no problem with using different
261fonts for the same character at the same time, but no interface for this
262has been designed yet).
263
264Until then, you might get away with switching fonts at runtime (see L<Can
265I switch the fonts at runtime?> later in this document).
266 304
267=head3 Why does rxvt-unicode sometimes leave pixel droppings? 305=head3 Why does rxvt-unicode sometimes leave pixel droppings?
268 306
269Most fonts were not designed for terminal use, which means that character 307Most fonts were not designed for terminal use, which means that character
270size varies a lot. A font that is otherwise fine for terminal use might 308size varies a lot. A font that is otherwise fine for terminal use might
… …
276however: Xft fonts often draw glyphs larger than their acclaimed bounding 314however: Xft fonts often draw glyphs larger than their acclaimed bounding
277box, and rxvt-unicode has no way of detecting this (the correct way is to 315box, and rxvt-unicode has no way of detecting this (the correct way is to
278ask for the character bounding box, which unfortunately is wrong in these 316ask for the character bounding box, which unfortunately is wrong in these
279cases). 317cases).
280 318
281It's not clear (to me at least), wether this is a bug in Xft, freetype, 319It's not clear (to me at least), whether this is a bug in Xft, freetype,
282or the respective font. If you encounter this problem you might try using 320or the respective font. If you encounter this problem you might try using
283the C<-lsp> option to give the font more height. If that doesn't work, you 321the C<-lsp> option to give the font more height. If that doesn't work, you
284might be forced to use a different font. 322might be forced to use a different font.
285 323
286All of this is not a problem when using X11 core fonts, as their bounding 324All of this is not a problem when using X11 core fonts, as their bounding
… …
310=head3 Can I switch the fonts at runtime? 348=head3 Can I switch the fonts at runtime?
311 349
312Yes, using an escape sequence. Try something like this, which has the same 350Yes, using an escape sequence. Try something like this, which has the same
313effect as using the C<-fn> switch, and takes effect immediately: 351effect as using the C<-fn> switch, and takes effect immediately:
314 352
315 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" 353 printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
316 354
317This is useful if you e.g. work primarily with japanese (and prefer a 355This is useful if you e.g. work primarily with japanese (and prefer a
318japanese font), but you have to switch to chinese temporarily, where 356japanese font), but you have to switch to chinese temporarily, where
319japanese fonts would only be in your way. 357japanese fonts would only be in your way.
320 358
… …
322 360
323=head3 Why do italic characters look as if clipped? 361=head3 Why do italic characters look as if clipped?
324 362
325Many fonts have difficulties with italic characters and hinting. For 363Many fonts have difficulties with italic characters and hinting. For
326example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans 364example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
327Mono> completely fails in it's italic face. A workaround might be to 365Mono> completely fails in its italic face. A workaround might be to
328enable freetype autohinting, i.e. like this: 366enable freetype autohinting, i.e. like this:
329 367
330 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 368 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
331 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 369 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
332 370
… …
338memory and also speeds up rendering considerably. 376memory and also speeds up rendering considerably.
339 377
340=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 378=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
341 379
342Rxvt-unicode will use whatever you specify as a font. If it needs to 380Rxvt-unicode will use whatever you specify as a font. If it needs to
343fall back to it's default font search list it will prefer X11 core 381fall back to its default font search list it will prefer X11 core
344fonts, because they are small and fast, and then use Xft fonts. It has 382fonts, because they are small and fast, and then use Xft fonts. It has
345antialiasing disabled for most of them, because the author thinks they 383antialiasing disabled for most of them, because the author thinks they
346look best that way. 384look best that way.
347 385
348If you want antialiasing, you have to specify the fonts manually. 386If you want antialiasing, you have to specify the fonts manually.
… …
350=head3 What's with this bold/blink stuff? 388=head3 What's with this bold/blink stuff?
351 389
352If no bold colour is set via C<colorBD:>, bold will invert text using the 390If no bold colour is set via C<colorBD:>, bold will invert text using the
353standard foreground colour. 391standard foreground colour.
354 392
355For the standard background colour, blinking will actually make the 393For the standard background colour, blinking will actually make
356text blink when compiled with C<--enable-blinking>. with standard 394the text blink when compiled with C<--enable-text-blink>. Without
357colours. Without C<--enable-blinking>, the blink attribute will be 395C<--enable-text-blink>, the blink attribute will be ignored.
358ignored.
359 396
360On ANSI colours, bold/blink attributes are used to set high-intensity 397On ANSI colours, bold/blink attributes are used to set high-intensity
361foreground/background colors. 398foreground/background colours.
362 399
363color0-7 are the low-intensity colors. 400color0-7 are the low-intensity colours.
364 401
365color8-15 are the corresponding high-intensity colors. 402color8-15 are the corresponding high-intensity colours.
366 403
367=head3 I don't like the screen colors. How do I change them? 404=head3 I don't like the screen colours. How do I change them?
368 405
369You can change the screen colors at run-time using F<~/.Xdefaults> 406You can change the screen colours at run-time using F<~/.Xdefaults>
370resources (or as long-options). 407resources (or as long-options).
371 408
372Here are values that are supposed to resemble a VGA screen, 409Here are values that are supposed to resemble a VGA screen,
373including the murky brown that passes for low-intensity yellow: 410including the murky brown that passes for low-intensity yellow:
374 411
… …
388 URxvt.color12: #0000FF 425 URxvt.color12: #0000FF
389 URxvt.color13: #FF00FF 426 URxvt.color13: #FF00FF
390 URxvt.color14: #00FFFF 427 URxvt.color14: #00FFFF
391 URxvt.color15: #FFFFFF 428 URxvt.color15: #FFFFFF
392 429
393And here is a more complete set of non-standard colors described (not by 430And here is a more complete set of non-standard colours.
394me) as "pretty girly".
395 431
396 URxvt.cursorColor: #dc74d1 432 URxvt.cursorColor: #dc74d1
397 URxvt.pointerColor: #dc74d1 433 URxvt.pointerColor: #dc74d1
398 URxvt.background: #0e0e0e 434 URxvt.background: #0e0e0e
399 URxvt.foreground: #4ad5e1 435 URxvt.foreground: #4ad5e1
… …
410 URxvt.color6: #73f7ff 446 URxvt.color6: #73f7ff
411 URxvt.color14: #73f7ff 447 URxvt.color14: #73f7ff
412 URxvt.color7: #e1dddd 448 URxvt.color7: #e1dddd
413 URxvt.color15: #e1dddd 449 URxvt.color15: #e1dddd
414 450
451They have been described (not by me) as "pretty girly".
452
415=head3 Why do some characters look so much different than others? 453=head3 Why do some characters look so much different than others?
416 454
417See next entry. 455See next entry.
418 456
419=head3 How does rxvt-unicode choose fonts? 457=head3 How does rxvt-unicode choose fonts?
420 458
421Most fonts do not contain the full range of Unicode, which is 459Most fonts do not contain the full range of Unicode, which is
422fine. Chances are that the font you (or the admin/package maintainer of 460fine. Chances are that the font you (or the admin/package maintainer of
423your system/os) have specified does not cover all the characters you want 461your system/os) have specified does not cover all the characters you want
424to display. 462to display.
425 463
426B<rxvt-unicode> makes a best-effort try at finding a replacement 464B<rxvt-unicode> makes a best-effort try at finding a replacement
427font. Often the result is fine, but sometimes the chosen font looks 465font. Often the result is fine, but sometimes the chosen font looks
428bad/ugly/wrong. Some fonts have totally strange characters that don't 466bad/ugly/wrong. Some fonts have totally strange characters that don't
429resemble the correct glyph at all, and rxvt-unicode lacks the artificial 467resemble the correct glyph at all, and rxvt-unicode lacks the artificial
430intelligence to detect that a specific glyph is wrong: it has to believe 468intelligence to detect that a specific glyph is wrong: it has to believe
431the font that the characters it claims to contain indeed look correct. 469the font that the characters it claims to contain indeed look correct.
432 470
433In that case, select a font of your taste and add it to the font list, 471In that case, select a font of your taste and add it to the font list,
434e.g.: 472e.g.:
435 473
436 @@URXVT_NAME@@ -fn basefont,font2,font3... 474 @@URXVT_NAME@@ -fn basefont,font2,font3...
437 475
438When rxvt-unicode sees a character, it will first look at the base 476When rxvt-unicode sees a character, it will first look at the base
439font. If the base font does not contain the character, it will go to the 477font. If the base font does not contain the character, it will go to the
440next font, and so on. Specifying your own fonts will also speed up this 478next font, and so on. Specifying your own fonts will also speed up this
441search and use less resources within rxvt-unicode and the X-server. 479search and use less resources within rxvt-unicode and the X-server.
442 480
443The only limitation is that none of the fonts may be larger than the base 481The only limitation is that none of the fonts may be larger than the base
444font, as the base font defines the terminal character cell size, which 482font, as the base font defines the terminal character cell size, which
445must be the same due to the way terminals work. 483must be the same due to the way terminals work.
446 484
485=head3 Why do some chinese characters look so different than others?
486
487This is because there is a difference between script and language --
488rxvt-unicode does not know which language the text that is output is,
489as it only knows the unicode character codes. If rxvt-unicode first
490sees a japanese/chinese character, it might choose a japanese font for
491display. Subsequent japanese characters will use that font. Now, many
492chinese characters aren't represented in japanese fonts, so when the first
493non-japanese character comes up, rxvt-unicode will look for a chinese font
494-- unfortunately at this point, it will still use the japanese font for
495chinese characters that are also in the japanese font.
496
497The workaround is easy: just tag a chinese font at the end of your font
498list (see the previous question). The key is to view the font list as
499a preference list: If you expect more japanese, list a japanese font
500first. If you expect more chinese, put a chinese font first.
501
502In the future it might be possible to switch language preferences at
503runtime (the internal data structure has no problem with using different
504fonts for the same character at the same time, but no interface for this
505has been designed yet).
506
507Until then, you might get away with switching fonts at runtime (see L<Can
508I switch the fonts at runtime?> later in this document).
509
510=head3 How can I make mplayer display video correctly?
511
512We are working on it, in the meantime, as a workaround, use something like:
513
514 @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
515
516=head3 Why is the cursor now blinking in emacs/vi/...?
517
518This is likely caused by your editor/program's use of the C<cvvis>
519terminfo capability. Emacs uses it by default, as well as some versions of
520vi and possibly other programs.
521
522In emacs, you can switch that off by adding this to your C<.emacs> file:
523
524 (setq visible-cursor nil)
525
526For other programs, if they do not have an option, your have to remove the
527C<cvvis> capability from the terminfo description.
528
529When @@URXVT_NAME@@ first added the blinking cursor option, it didn't
530add a C<cvvis> capability, which served no purpose before. Version 9.21
531introduced C<cvvis> (and the ability to control blinking independent of
532cursor shape) for compatibility with other terminals, which traditionally
533use a blinking cursor for C<cvvis>. This also reflects the intent of
534programs such as emacs, who expect C<cvvis> to enable a blinking cursor.
447 535
448=head2 Keyboard, Mouse & User Interaction 536=head2 Keyboard, Mouse & User Interaction
449 537
450=head3 The new selection selects pieces that are too big, how can I select single words? 538=head3 The new selection selects pieces that are too big, how can I select single words?
451 539
… …
459 547
460To get a selection that is very similar to the old code, try this pattern: 548To get a selection that is very similar to the old code, try this pattern:
461 549
462 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+) 550 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
463 551
464Please also note that the I<LeftClick Shift-LeftClik> combination also 552Please also note that the I<LeftClick Shift-LeftClick> combination also
465selects words like the old code. 553selects words like the old code.
466 554
467=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it? 555=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
468 556
469You can disable the perl extension completely by setting the 557You can disable the perl extension completely by setting the
… …
479 URxvt.perl-ext-common: default,-selection-popup,-option-popup 567 URxvt.perl-ext-common: default,-selection-popup,-option-popup
480 568
481This will keep the default extensions, but disable the two popup 569This will keep the default extensions, but disable the two popup
482extensions. Some extensions can also be configured, for example, 570extensions. Some extensions can also be configured, for example,
483scrollback search mode is triggered by B<M-s>. You can move it to any 571scrollback search mode is triggered by B<M-s>. You can move it to any
484other combination either by setting the B<searchable-scrollback> resource: 572other combination by adding a B<keysym> resource that binds the desired
573combination to the C<start> action of C<searchable-scrollback> and another
574one that binds B<M-s> to the C<builtin:> action:
485 575
486 URxvt.searchable-scrollback: CM-s 576 URxvt.keysym.CM-s: searchable-scrollback:start
577 URxvt.keysym.M-s: builtin:
487 578
488=head3 The cursor moves when selecting text in the current input line, how do I switch this off? 579=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
489 580
490See next entry. 581See next entry.
491 582
… …
495circumstances, it will move your cursor around when you click into the 586circumstances, it will move your cursor around when you click into the
496line that contains it. It tries hard not to do this at the wrong moment, 587line that contains it. It tries hard not to do this at the wrong moment,
497but when running a program that doesn't parse cursor movements or in some 588but when running a program that doesn't parse cursor movements or in some
498cases during rlogin sessions, it fails to detect this properly. 589cases during rlogin sessions, it fails to detect this properly.
499 590
500You can permamently switch this feature off by disabling the C<readline> 591You can permanently switch this feature off by disabling the C<readline>
501extension: 592extension:
502 593
503 URxvt.perl-ext-common: default,-readline 594 URxvt.perl-ext-common: default,-readline
504 595
505=head3 My numerical keypad acts weird and generates differing output? 596=head3 My numeric keypad acts weird and generates differing output?
506 597
507Some Debian GNUL/Linux users seem to have this problem, although no 598Some Debian GNU/Linux users seem to have this problem, although no
508specific details were reported so far. It is possible that this is caused 599specific details were reported so far. It is possible that this is caused
509by the wrong C<TERM> setting, although the details of wether and how 600by the wrong C<TERM> setting, although the details of whether and how
510this can happen are unknown, as C<TERM=rxvt> should offer a compatible 601this can happen are unknown, as C<TERM=rxvt> should offer a compatible
511keymap. See the answer to the previous question, and please report if that 602keymap. See the answer to the previous question, and please report if that
512helped. 603helped.
513 604
514=head3 My Compose (Multi_key) key is no longer working. 605=head3 My Compose (Multi_key) key is no longer working.
515 606
516The most common causes for this are that either your locale is not set 607The most common causes for this are that either your locale is not set
517correctly, or you specified a B<preeditStyle> that is not supported by 608correctly, or you specified a B<preeditType> that is not supported by
518your input method. For example, if you specified B<OverTheSpot> and 609your input method. For example, if you specified B<OverTheSpot> and
519your input method (e.g. the default input method handling Compose keys) 610your input method (e.g. the default input method handling Compose keys)
520does not support this (for instance because it is not visual), then 611does not support this (for instance because it is not visual), then
521rxvt-unicode will continue without an input method. 612rxvt-unicode will continue without an input method.
522 613
523In this case either do not specify a B<preeditStyle> or specify more than 614In this case either do not specify a B<preeditType> or specify more than
524one pre-edit style, such as B<OverTheSpot,Root,None>. 615one pre-edit style, such as B<OverTheSpot,Root,None>.
616
617If it still doesn't work, then maybe your input method doesn't support
618compose sequences - to fall back to the built-in one, make sure you don't
619specify an input method via C<-im> or C<XMODIFIERS>.
525 620
526=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755 621=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
527 622
528Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on 623Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
529international keyboards) or simply use ISO 14755 support to your 624international keyboards) or simply use ISO 14755 support to your
… …
532character and so on. 627character and so on.
533 628
534=head3 Mouse cut/paste suddenly no longer works. 629=head3 Mouse cut/paste suddenly no longer works.
535 630
536Make sure that mouse reporting is actually turned off since killing 631Make sure that mouse reporting is actually turned off since killing
537some editors prematurely may leave the mouse in mouse report mode. I've 632some editors prematurely may leave it active. I've
538heard that tcsh may use mouse reporting unless it otherwise specified. A 633heard that tcsh may use mouse reporting unless it is otherwise specified. A
539quick check is to see if cut/paste works when the Alt or Shift keys are 634quick check is to see if cut/paste works when the Alt or Shift keys are
540depressed. 635pressed.
541 636
542=head3 What's with the strange Backspace/Delete key behaviour? 637=head3 What's with the strange Backspace/Delete key behaviour?
543 638
544Assuming that the physical Backspace key corresponds to the 639Assuming that the physical Backspace key corresponds to the
545BackSpace keysym (not likely for Linux ... see the following 640Backspace keysym (not likely for Linux ... see the following
546question) there are two standard values that can be used for 641question) there are two standard values that can be used for
547Backspace: C<^H> and C<^?>. 642Backspace: C<^H> and C<^?>.
548 643
549Historically, either value is correct, but rxvt-unicode adopts the debian 644Historically, either value is correct, but rxvt-unicode adopts the debian
550policy of using C<^?> when unsure, because it's the one only only correct 645policy of using C<^?> when unsure, because it's the one and only correct
551choice :). 646choice :).
552 647
553Rxvt-unicode tries to inherit the current stty settings and uses the value 648It is possible to toggle between C<^H> and C<^?> with the DECBKM
554of `erase' to guess the value for backspace. If rxvt-unicode wasn't 649private mode:
555started from a terminal (say, from a menu or by remote shell), then the
556system value of `erase', which corresponds to CERASE in <termios.h>, will
557be used (which may not be the same as your stty setting).
558
559For starting a new rxvt-unicode:
560 650
561 # use Backspace = ^H 651 # use Backspace = ^H
562 $ stty erase ^H 652 $ stty erase ^H
563 $ @@URXVT_NAME@@ 653 $ printf "\e[?67h"
564 654
565 # use Backspace = ^? 655 # use Backspace = ^?
566 $ stty erase ^? 656 $ stty erase ^?
567 $ @@URXVT_NAME@@ 657 $ printf "\e[?67l"
568
569Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
570
571For an existing rxvt-unicode:
572
573 # use Backspace = ^H
574 $ stty erase ^H
575 $ echo -n "^[[36h"
576
577 # use Backspace = ^?
578 $ stty erase ^?
579 $ echo -n "^[[36l"
580 658
581This helps satisfy some of the Backspace discrepancies that occur, but 659This helps satisfy some of the Backspace discrepancies that occur, but
582if you use Backspace = C<^H>, make sure that the termcap/terminfo value 660if you use Backspace = C<^H>, make sure that the termcap/terminfo value
583properly reflects that. 661properly reflects that.
584 662
… …
587key has been assigned an escape sequence to match the vt100 for Execute 665key has been assigned an escape sequence to match the vt100 for Execute
588(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo. 666(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
589 667
590Some other Backspace problems: 668Some other Backspace problems:
591 669
592some editors use termcap/terminfo, 670some editors use termcap/terminfo,
593some editors (vim I'm told) expect Backspace = ^H, 671some editors (vim I'm told) expect Backspace = ^H,
594GNU Emacs (and Emacs-like editors) use ^H for help. 672GNU Emacs (and Emacs-like editors) use ^H for help.
595 673
596Perhaps someday this will all be resolved in a consistent manner. 674Perhaps someday this will all be resolved in a consistent manner.
597 675
… …
601you have run "configure" with the C<--disable-resources> option you can 679you have run "configure" with the C<--disable-resources> option you can
602use the `keysym' resource to alter the keystrings associated with keysyms. 680use the `keysym' resource to alter the keystrings associated with keysyms.
603 681
604Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt> 682Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
605 683
684 URxvt.keysym.Prior: \033[5~
685 URxvt.keysym.Next: \033[6~
606 URxvt.keysym.Home: \033[1~ 686 URxvt.keysym.Home: \033[7~
607 URxvt.keysym.End: \033[4~ 687 URxvt.keysym.End: \033[8~
608 URxvt.keysym.C-apostrophe: \033<C-'>
609 URxvt.keysym.C-slash: \033<C-/>
610 URxvt.keysym.C-semicolon: \033<C-;>
611 URxvt.keysym.C-grave: \033<C-`>
612 URxvt.keysym.C-comma: \033<C-,>
613 URxvt.keysym.C-period: \033<C-.>
614 URxvt.keysym.C-0x60: \033<C-`>
615 URxvt.keysym.C-Tab: \033<C-Tab>
616 URxvt.keysym.C-Return: \033<C-Return>
617 URxvt.keysym.S-Return: \033<S-Return>
618 URxvt.keysym.S-space: \033<S-Space>
619 URxvt.keysym.M-Up: \033<M-Up> 688 URxvt.keysym.Up: \033[A
620 URxvt.keysym.M-Down: \033<M-Down> 689 URxvt.keysym.Down: \033[B
690 URxvt.keysym.Right: \033[C
621 URxvt.keysym.M-Left: \033<M-Left> 691 URxvt.keysym.Left: \033[D
622 URxvt.keysym.M-Right: \033<M-Right>
623 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
624 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
625 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
626 692
627See some more examples in the documentation for the B<keysym> resource. 693See some more examples in the documentation for the B<keysym> resource.
628 694
629=head3 I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map 695=head3 I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map
630 696
… …
638Rather than have rxvt-unicode try to accommodate all the various possible 704Rather than have rxvt-unicode try to accommodate all the various possible
639keyboard mappings, it is better to use `xmodmap' to remap the keys as 705keyboard mappings, it is better to use `xmodmap' to remap the keys as
640required for your particular machine. 706required for your particular machine.
641 707
642 708
643
644=head2 Terminal Configuration 709=head2 Terminal Configuration
710
711=head3 Can I see a typical configuration?
712
713The default configuration tries to be xterm-like, which I don't like that
714much, but it's least surprise to regular users.
715
716As a rxvt or rxvt-unicode user, you are practically supposed to invest
717time into customising your terminal. To get you started, here is the
718author's .Xdefaults entries, with comments on what they do. It's certainly
719not I<typical>, but what's typical...
720
721 URxvt.cutchars: "()*,<>[]{}|'
722 URxvt.print-pipe: cat >/some/path
723
724These are just for testing stuff.
725
726 URxvt.imLocale: ja_JP.UTF-8
727 URxvt.preeditType: OnTheSpot,None
728
729This tells rxvt-unicode to use a special locale when communicating with
730the X Input Method, and also tells it to only use the OnTheSpot pre-edit
731type, which requires the C<xim-onthespot> perl extension but rewards me
732with correct-looking fonts.
733
734 URxvt.perl-lib: /root/lib/urxvt
735 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
736 URxvt.selection.pattern-0: ( at .*? line \\d+)
737 URxvt.selection.pattern-1: ^(/[^:]+):\
738 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
739 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
740
741This is my perl configuration. The first two set the perl library
742directory and also tells urxvt to use a large number of extensions. I
743develop for myself mostly, so I actually use most of the extensions I
744write.
745
746The selection stuff mainly makes the selection perl-error-message aware
747and tells it to convert perl error messages into vi-commands to load the
748relevant file and go to the error line number.
749
750 URxvt.scrollstyle: plain
751 URxvt.secondaryScroll: true
752
753As the documentation says: plain is the preferred scrollbar for the
754author. The C<secondaryScroll> configures urxvt to scroll in full-screen
755apps, like screen, so lines scrolled out of screen end up in urxvt's
756scrollback buffer.
757
758 URxvt.background: #000000
759 URxvt.foreground: gray90
760 URxvt.color7: gray90
761 URxvt.colorBD: #ffffff
762 URxvt.cursorColor: #e0e080
763 URxvt.throughColor: #8080f0
764 URxvt.highlightColor: #f0f0f0
765
766Some colours. Not sure which ones are being used or even non-defaults, but
767these are in my .Xdefaults. Most notably, they set foreground/background
768to light gray/black, and also make sure that the colour 7 matches the
769default foreground colour.
770
771 URxvt.underlineColor: yellow
772
773Another colour, makes underline lines look different. Sometimes hurts, but
774is mostly a nice effect.
775
776 URxvt.geometry: 154x36
777 URxvt.loginShell: false
778 URxvt.meta: ignore
779 URxvt.utmpInhibit: true
780
781Uh, well, should be mostly self-explanatory. By specifying some defaults
782manually, I can quickly switch them for testing.
783
784 URxvt.saveLines: 8192
785
786A large scrollback buffer is essential. Really.
787
788 URxvt.mapAlert: true
789
790The only case I use it is for my IRC window, which I like to keep
791iconified till people msg me (which beeps).
792
793 URxvt.visualBell: true
794
795The audible bell is often annoying, especially when in a crowd.
796
797 URxvt.insecure: true
798
799Please don't hack my mutt! Ooops...
800
801 URxvt.pastableTabs: false
802
803I once thought this is a great idea.
804
805 urxvt.font: 9x15bold,\
806 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
807 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
808 [codeset=JISX0208]xft:Kochi Gothic, \
809 xft:Bitstream Vera Sans Mono:autohint=true, \
810 xft:Code2000:antialias=false
811 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
812 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
813 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
814
815I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
816overwhelmed. A special note: the C<9x15bold> mentioned above is actually
817the version from XFree-3.3, as XFree-4 replaced it by a totally different
818font (different glyphs for C<;> and many other harmless characters),
819while the second font is actually the C<9x15bold> from XFree4/XOrg. The
820bold version has less chars than the medium version, so I use it for rare
821characters, too. When editing sources with vim, I use italic for comments
822and other stuff, which looks quite good with Bitstream Vera anti-aliased.
823
824Terminus is a quite bad font (many very wrong glyphs), but for most of my
825purposes, it works, and gives a different look, as my normal (Non-bold)
826font is already bold, and I want to see a difference between bold and
827normal fonts.
828
829Please note that I used the C<urxvt> instance name and not the C<URxvt>
830class name. That is because I use different configs for different purposes,
831for example, my IRC window is started with C<-name IRC>, and uses these
832defaults:
833
834 IRC*title: IRC
835 IRC*geometry: 87x12+535+542
836 IRC*saveLines: 0
837 IRC*mapAlert: true
838 IRC*font: suxuseuro
839 IRC*boldFont: suxuseuro
840 IRC*colorBD: white
841 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
842 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
843
844C<Alt-Ctrl-1> and C<Alt-Ctrl-2> switch between two different font
845sizes. C<suxuseuro> allows me to keep an eye (and actually read)
846stuff while keeping a very small window. If somebody pastes something
847complicated (e.g. japanese), I temporarily switch to a larger font.
848
849The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
850C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
851file for different hosts, for example, on my main desktop, I use:
852
853 URxvt.keysym.C-M-q: command:\033[3;5;5t
854 URxvt.keysym.C-M-y: command:\033[3;5;606t
855 URxvt.keysym.C-M-e: command:\033[3;1605;5t
856 URxvt.keysym.C-M-c: command:\033[3;1605;606t
857 URxvt.keysym.C-M-p: perl:test
858
859The first for keysym definitions allow me to quickly bring some windows
860in the layout I like most. Ion users might start laughing but will stop
861immediately when I tell them that I use my own Fvwm2 module for much the
862same effect as Ion provides, and I only very rarely use the above key
863combinations :->
645 864
646=head3 Why doesn't rxvt-unicode read my resources? 865=head3 Why doesn't rxvt-unicode read my resources?
647 866
648Well, why, indeed? It does, in a way very similar to other X 867Well, why, indeed? It does, in a way very similar to other X
649applications. Most importantly, this means that if you or your OS loads 868applications. Most importantly, this means that if you or your OS loads
… …
658Also consider the form resources have to use: 877Also consider the form resources have to use:
659 878
660 URxvt.resource: value 879 URxvt.resource: value
661 880
662If you want to use another form (there are lots of different ways of 881If you want to use another form (there are lots of different ways of
663specifying resources), make sure you understand wether and why it 882specifying resources), make sure you understand whether and why it
664works. If unsure, use the form above. 883works. If unsure, use the form above.
665 884
666=head3 When I log-in to another system it tells me about missing terminfo data? 885=head3 When I log-in to another system it tells me about missing terminfo data?
667 886
668The terminal description used by rxvt-unicode is not as widely available 887The terminal description used by rxvt-unicode is not as widely available
669as that for xterm, or even rxvt (for which the same problem often arises). 888as that for xterm, or even rxvt (for which the same problem often arises).
670 889
671The correct solution for this problem is to install the terminfo, this can 890The correct solution for this problem is to install the terminfo, this can
672be done like this (with ncurses' infocmp): 891be done by simply installing rxvt-unicode on the remote system as well
892(in case you have a nice package manager ready), or you can install the
893terminfo database manually like this (with ncurses infocmp. works as
894user and root):
673 895
674 REMOTE=remotesystem.domain 896 REMOTE=remotesystem.domain
675 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" 897 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
676 898
677... or by installing rxvt-unicode normally on the remote system, 899One some systems you might need to set C<$TERMINFO> to the full path of
900F<$HOME/.terminfo> for this to work.
678 901
679If you cannot or do not want to do this, then you can simply set 902If you cannot or do not want to do this, then you can simply set
680C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of 903C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
681problems arising, which includes wrong keymapping, less and different 904problems arising, which includes wrong keymapping, less and different
682colours and some refresh errors in fullscreen applications. It's a nice 905colours and some refresh errors in fullscreen applications. It's a nice
… …
689 URxvt.termName: rxvt 912 URxvt.termName: rxvt
690 913
691If you don't plan to use B<rxvt> (quite common...) you could also replace 914If you don't plan to use B<rxvt> (quite common...) you could also replace
692the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>. 915the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
693 916
917=head3 nano fails with "Error opening terminal: rxvt-unicode"
918
919This exceptionally confusing and useless error message is printed by nano
920when it can't find the terminfo database. Nothing is wrong with your
921terminal, read the previous answer for a solution.
922
694=head3 C<tic> outputs some error when compiling the terminfo entry. 923=head3 C<tic> outputs some error when compiling the terminfo entry.
695 924
696Most likely it's the empty definition for C<enacs=>. Just replace it by 925Most likely it's the empty definition for C<enacs=>. Just replace it by
697C<enacs=\E[0@> and try again. 926C<enacs=\E[0@> and try again.
698 927
… …
702 931
703=head3 I need a termcap file entry. 932=head3 I need a termcap file entry.
704 933
705One reason you might want this is that some distributions or operating 934One reason you might want this is that some distributions or operating
706systems still compile some programs using the long-obsoleted termcap 935systems still compile some programs using the long-obsoleted termcap
707library (Fedora Core's bash is one example) and rely on a termcap entry 936library (Fedora's bash is one example) and rely on a termcap entry
708for C<rxvt-unicode>. 937for C<rxvt-unicode>.
709 938
710You could use rxvt's termcap entry with resonable results in many cases. 939You could use rxvt's termcap entry with reasonable results in many cases.
711You can also create a termcap entry by using terminfo's infocmp program 940You can also create a termcap entry by using terminfo's infocmp program
712like this: 941like this:
713 942
714 infocmp -C rxvt-unicode 943 infocmp -C rxvt-unicode
715 944
716Or you could use this termcap entry, generated by the command above: 945Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap,
717 946generated by the command above.
718 rxvt-unicode|rxvt-unicode terminal (X Window System):\
719 :am:bw:eo:km:mi:ms:xn:xo:\
720 :co#80:it#8:li#24:lm#0:\
721 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
722 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
723 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
724 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
725 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
726 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
727 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
728 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
729 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
730 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
731 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
732 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
733 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
734 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
735 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
736 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
737 :vs=\E[?25h:
738 947
739=head3 Why does C<ls> no longer have coloured output? 948=head3 Why does C<ls> no longer have coloured output?
740 949
741The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 950The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
742decide wether a terminal has colour, but uses it's own configuration 951decide whether a terminal has colour, but uses its own configuration
743file. Needless to say, C<rxvt-unicode> is not in it's default file (among 952file. Needless to say, C<rxvt-unicode> is not in its default file (among
744with most other terminals supporting colour). Either add: 953with most other terminals supporting colour). Either add:
745 954
746 TERM rxvt-unicode 955 TERM rxvt-unicode
747 956
748to C</etc/DIR_COLORS> or simply add: 957to C</etc/DIR_COLORS> or simply add:
… …
760See next entry. 969See next entry.
761 970
762=head3 Why are the secondary screen-related options not working properly? 971=head3 Why are the secondary screen-related options not working properly?
763 972
764Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged 973Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
765distributions (most notably Debian GNU/Linux) break rxvt-unicode 974distributions break rxvt-unicode by setting C<TERM> to C<rxvt>, which
766by setting C<TERM> to C<rxvt>, which doesn't have these extra 975doesn't have these extra features. Unfortunately, some of these
767features. Unfortunately, some of these (most notably, again, Debian
768GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo 976furthermore fail to even install the C<rxvt-unicode> terminfo file, so
769file, so you will need to install it on your own (See the question B<When 977you will need to install it on your own (See the question B<When I
770I log-in to another system it tells me about missing terminfo data?> on 978log-in to another system it tells me about missing terminfo data?> on
771how to do this). 979how to do this).
772 980
773 981
774=head2 Encoding / Locale / Input Method Issues 982=head2 Encoding / Locale / Input Method Issues
775 983
… …
782If you encounter strange problems like typing an accented character but 990If you encounter strange problems like typing an accented character but
783getting two unrelated other characters or similar, or if program output is 991getting two unrelated other characters or similar, or if program output is
784subtly garbled, then you should check your locale settings. 992subtly garbled, then you should check your locale settings.
785 993
786Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 994Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
787programs. Often rxvt-unicode is started in the C<C> locale, while the 995programs running in it. Often rxvt-unicode is started in the C<C> locale,
788login script running within the rxvt-unicode window changes the locale to 996while the login script running within the rxvt-unicode window changes the
789something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work. 997locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
998not going to work, and is the most common cause for problems.
790 999
791The best thing is to fix your startup environment, as you will likely run 1000The best thing is to fix your startup environment, as you will likely run
792into other problems. If nothing works you can try this in your .profile. 1001into other problems. If nothing works you can try this in your .profile.
793 1002
794 printf '\e]701;%s\007' "$LC_CTYPE" 1003 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
795 1004
796If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 1005If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
797supported on your systems. Some systems have a C<locale> command which 1006supported on your systems. Some systems have a C<locale> command which
798displays this (also, C<perl -e0> can be used to check locale settings, as 1007displays this (also, C<perl -e0> can be used to check locale settings, as
799it will complain loudly if it cannot set the locale). If it displays something 1008it will complain loudly if it cannot set the locale). If it displays something
… …
820The reasons is that there exists a perfectly fine mechanism for selecting 1029The reasons is that there exists a perfectly fine mechanism for selecting
821the encoding, doing I/O and (most important) communicating this to all 1030the encoding, doing I/O and (most important) communicating this to all
822applications so everybody agrees on character properties such as width 1031applications so everybody agrees on character properties such as width
823and code number. This mechanism is the I<locale>. Applications not using 1032and code number. This mechanism is the I<locale>. Applications not using
824that info will have problems (for example, C<xterm> gets the width of 1033that info will have problems (for example, C<xterm> gets the width of
825characters wrong as it uses it's own, locale-independent table under all 1034characters wrong as it uses its own, locale-independent table under all
826locales). 1035locales).
827 1036
828Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All 1037Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
829programs doing the same (that is, most) will automatically agree in the 1038programs doing the same (that is, most) will automatically agree in the
830interpretation of characters. 1039interpretation of characters.
… …
849=head3 Can I switch locales at runtime? 1058=head3 Can I switch locales at runtime?
850 1059
851Yes, using an escape sequence. Try something like this, which sets 1060Yes, using an escape sequence. Try something like this, which sets
852rxvt-unicode's idea of C<LC_CTYPE>. 1061rxvt-unicode's idea of C<LC_CTYPE>.
853 1062
854 printf '\e]701;%s\007' ja_JP.SJIS 1063 printf '\33]701;%s\007' ja_JP.SJIS
855 1064
856See also the previous answer. 1065See also the previous answer.
857 1066
858Sometimes this capability is rather handy when you want to work in 1067Sometimes this capability is rather handy when you want to work in
859one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it 1068one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
860(e.g. UTF-8). For example, I use this script to start C<xjdic>, which 1069(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
861first switches to a locale supported by xjdic and back later: 1070first switches to a locale supported by xjdic and back later:
862 1071
863 printf '\e]701;%s\007' ja_JP.SJIS 1072 printf '\33]701;%s\007' ja_JP.SJIS
864 xjdic -js 1073 xjdic -js
865 printf '\e]701;%s\007' de_DE.UTF-8 1074 printf '\33]701;%s\007' de_DE.UTF-8
866 1075
867You can also use xterm's C<luit> program, which usually works fine, except 1076You can also use xterm's C<luit> program, which usually works fine, except
868for some locales where character width differs between program- and 1077for some locales where character width differs between program- and
869rxvt-unicode-locales. 1078rxvt-unicode-locales.
870 1079
1080=head3 I have problems getting my input method working.
1081
1082Try a search engine, as this is slightly different for every input method server.
1083
1084Here is a checklist:
1085
1086=over 4
1087
1088=item - Make sure your locale I<and> the imLocale are supported on your OS.
1089
1090Try C<locale -a> or check the documentation for your OS.
1091
1092=item - Make sure your locale or imLocale matches a locale supported by your XIM.
1093
1094For example, B<kinput2> does not support UTF-8 locales, you should use
1095C<ja_JP.EUC-JP> or equivalent.
1096
1097=item - Make sure your XIM server is actually running.
1098
1099=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1100
1101When you want to use e.g. B<kinput2>, it must be set to
1102C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1103method servers are running with this command:
1104
1105 xprop -root XIM_SERVERS
1106
1107=back
1108
871=head3 My input method wants <some encoding> but I want UTF-8, what can I do? 1109=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
872 1110
873You can specify separate locales for the input method and the rest of the 1111You can specify separate locales for the input method and the rest of the
874terminal, using the resource C<imlocale>: 1112terminal, using the resource C<imlocale>:
875 1113
876 URxvt.imlocale: ja_JP.EUC-JP 1114 URxvt.imlocale: ja_JP.EUC-JP
877 1115
878Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 1116Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
879use your input method. Please note, however, that you will not be able to 1117use your input method. Please note, however, that, depending on your Xlib
880input characters outside C<EUC-JP> in a normal way then, as your input 1118version, you may not be able to input characters outside C<EUC-JP> in a
881method limits you. 1119normal way then, as your input method limits you.
882 1120
883=head3 Rxvt-unicode crashes when the X Input Method changes or exits. 1121=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
884 1122
885Unfortunately, this is unavoidable, as the XIM protocol is racy by 1123Unfortunately, this is unavoidable, as the XIM protocol is racy by
886design. Applications can avoid some crashes at the expense of memory 1124design. Applications can avoid some crashes at the expense of memory
… …
892So the only workaround is not to kill your Input Method Servers. 1130So the only workaround is not to kill your Input Method Servers.
893 1131
894 1132
895=head2 Operating Systems / Package Maintaining 1133=head2 Operating Systems / Package Maintaining
896 1134
897=head3 I am using Debian GNU/Linux and have a problem...
898
899The Debian GNU/Linux package of rxvt-unicode in sarge contains large
900patches that considerably change the behaviour of rxvt-unicode (but
901unfortunately this notice has been removed). Before reporting a bug to
902the original rxvt-unicode author please download and install the genuine
903version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
904the problem. If you cannot, chances are that the problems are specific to
905Debian GNU/Linux, in which case it should be reported via the Debian Bug
906Tracking System (use C<reportbug> to report the bug).
907
908For other problems that also affect the Debian package, you can and
909probably should use the Debian BTS, too, because, after all, it's also a
910bug in the Debian version and it serves as a reminder for other users that
911might encounter the same issue.
912
913=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation? 1135=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
914 1136
915You should build one binary with the default options. F<configure> 1137You should build one binary with the default options. F<configure>
916now enables most useful options, and the trend goes to making them 1138now enables most useful options, and the trend goes to making them
917runtime-switchable, too, so there is usually no drawback to enbaling them, 1139runtime-switchable, too, so there is usually no drawback to enabling them,
918except higher disk and possibly memory usage. The perl interpreter should 1140except higher disk and possibly memory usage. The perl interpreter should
919be enabled, as important functionality (menus, selection, likely more in 1141be enabled, as important functionality (menus, selection, likely more in
920the future) depends on it. 1142the future) depends on it.
921 1143
922You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 1144You should not overwrite the C<perl-ext-common> and C<perl-ext> resources
923system-wide (except maybe with C<defaults>). This will result in useful 1145system-wide (except maybe with C<defaults>). This will result in useful
924behaviour. If your distribution aims at low memory, add an empty 1146behaviour. If your distribution aims at low memory, add an empty
925C<perl-ext-common> resource to the app-defaults file. This will keep the 1147C<perl-ext-common> resource to the app-defaults file. This will keep the
926perl interpreter disabled until the user enables it. 1148perl interpreter disabled until the user enables it.
927 1149
… …
945This forking is done as the very first within main(), which is very early 1167This forking is done as the very first within main(), which is very early
946and reduces possible bugs to initialisation code run before main(), or 1168and reduces possible bugs to initialisation code run before main(), or
947things like the dynamic loader of your system, which should result in very 1169things like the dynamic loader of your system, which should result in very
948little risk. 1170little risk.
949 1171
950=head3 On Solaris 9, many line-drawing characters are too wide.
951
952Seems to be a known bug, read
953L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
954following ugly workaround to get non-double-wide-characters working:
955
956 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
957
958=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all. 1172=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
959 1173
960Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1174Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
961in your compile environment, or an implementation that implements it, 1175in your compile environment, or an implementation that implements it,
962wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1176whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
963B<wchar_t> is represented as unicode. 1177B<wchar_t> is represented as unicode.
964 1178
965As you might have guessed, FreeBSD does neither define this symobl nor 1179As you might have guessed, FreeBSD does neither define this symbol nor
966does it support it. Instead, it uses it's own internal representation of 1180does it support it. Instead, it uses its own internal representation of
967B<wchar_t>. This is, of course, completely fine with respect to standards. 1181B<wchar_t>. This is, of course, completely fine with respect to standards.
968 1182
969However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and 1183However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
970C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>. 1184C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>).
971 1185
972C<__STDC_ISO_10646__> is the only sane way to support multi-language 1186C<__STDC_ISO_10646__> is the only sane way to support multi-language
973apps in an OS, as using a locale-dependent (and non-standardized) 1187apps in an OS, as using a locale-dependent (and non-standardized)
974representation of B<wchar_t> makes it impossible to convert between 1188representation of B<wchar_t> makes it impossible to convert between
975B<wchar_t> (as used by X11 and your applications) and any other encoding 1189B<wchar_t> (as used by X11 and your applications) and any other encoding
… …
985 1199
986The rxvt-unicode author insists that the right way to fix this is in the 1200The rxvt-unicode author insists that the right way to fix this is in the
987system libraries once and for all, instead of forcing every app to carry 1201system libraries once and for all, instead of forcing every app to carry
988complete replacements for them :) 1202complete replacements for them :)
989 1203
990=head3 I use Solaris 9 and it doesn't compile/work/etc.
991
992Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
993problems with C<wcwidth> and a compile problem.
994
995=head3 How can I use rxvt-unicode under cygwin? 1204=head3 How can I use rxvt-unicode under cygwin?
996 1205
997rxvt-unicode should compile and run out of the box on cygwin, using 1206rxvt-unicode should compile and run out of the box on cygwin, using
998the X11 libraries that come with cygwin. libW11 emulation is no 1207the X11 libraries that come with cygwin. libW11 emulation is no
999longer supported (and makes no sense, either, as it only supported a 1208longer supported (and makes no sense, either, as it only supported a
… …
1003 1212
1004At the time of this writing, cygwin didn't seem to support any multi-byte 1213At the time of this writing, cygwin didn't seem to support any multi-byte
1005encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited 1214encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1006to 8-bit encodings. 1215to 8-bit encodings.
1007 1216
1217=head3 Character widths are not correct.
1218
1219urxvt uses the system wcwidth function to know the information about
1220the width of characters, so on systems with incorrect locale data you
1221will likely get bad results. Two notorious examples are Solaris 9,
1222where single-width characters like U+2514 are reported as double-width,
1223and Darwin 8, where combining chars are reported having width 1.
1224
1225The solution is to upgrade your system or switch to a better one. A
1226possibly working workaround is to use a wcwidth implementation like
1227
1228http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1229
1008=head1 RXVT-UNICODE TECHNICAL REFERENCE 1230=head1 RXVT-UNICODE TECHNICAL REFERENCE
1009
1010=head1 DESCRIPTION
1011 1231
1012The rest of this document describes various technical aspects of 1232The rest of this document describes various technical aspects of
1013B<rxvt-unicode>. First the description of supported command sequences, 1233B<rxvt-unicode>. First the description of supported command sequences,
1014followed by pixmap support and last by a description of all features 1234followed by pixmap support and last by a description of all features
1015selectable at C<configure> time. 1235selectable at C<configure> time.
1016 1236
1237When some functionality is marked as (insecure mode), then it requires
1238insecure mode to be enabled to work fully, e.g. by using the B<insecure>
1239resource or command line switch. As that name implies, a terminal running
1240in insecure mode might not be secure against attackers that can output
1241arbitrary sequences to the terminal.
1242
1017=head1 Definitions 1243=head2 Definitions
1018 1244
1019=over 4 1245=over 4
1020 1246
1021=item B<< C<c> >> 1247=item B<< C<c> >>
1022 1248
1023The literal character c. 1249The literal character c (potentially a multi-byte character).
1024 1250
1025=item B<< C<C> >> 1251=item B<< C<C> >>
1026 1252
1027A single (required) character. 1253A single (required) character.
1028 1254
… …
1040 1266
1041A text parameter composed of printable characters. 1267A text parameter composed of printable characters.
1042 1268
1043=back 1269=back
1044 1270
1045=head1 Values 1271=head2 Values
1046 1272
1047=over 4 1273=over 4
1048 1274
1049=item B<< C<ENQ> >> 1275=item B<< C<ENQ> >>
1050 1276
… …
1087=item B<< C<SI> >> 1313=item B<< C<SI> >>
1088 1314
1089Shift In (Ctrl-O), invokes the G0 character set (the default). 1315Shift In (Ctrl-O), invokes the G0 character set (the default).
1090Switch to Standard Character Set 1316Switch to Standard Character Set
1091 1317
1092=item B<< C<SPC> >> 1318=item B<< C<SP> >>
1093 1319
1094Space Character 1320Space Character
1095 1321
1096=back 1322=back
1097 1323
1098=head1 Escape Sequences 1324=head2 Escape Sequences
1099 1325
1100=over 4 1326=over 4
1101 1327
1102=item B<< C<ESC # 8> >> 1328=item B<< C<ESC # 8> >>
1103 1329
… …
1113 1339
1114=item B<< C<ESC => >> 1340=item B<< C<ESC => >>
1115 1341
1116Application Keypad (SMKX). See also next sequence. 1342Application Keypad (SMKX). See also next sequence.
1117 1343
1118=item B<<< C<< ESC >> >>> 1344=item B<<< C<< ESC > >> >>>
1119 1345
1120Normal Keypad (RMKX) 1346Normal Keypad (RMKX)
1121 1347
1122B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been
1123pressed, numbers or control functions are generated by the numeric keypad 1348B<Note:> numbers or control functions are generated by the numeric
1124(see Key Codes). 1349keypad in normal or application mode, respectively (see Key Codes).
1350
1125 1351
1126=item B<< C<ESC D> >> 1352=item B<< C<ESC D> >>
1127 1353
1128Index (IND) 1354Index (IND)
1129 1355
… …
1187 1413
1188Where B<< C<C> >> is one of: 1414Where B<< C<C> >> is one of:
1189 1415
1190=begin table 1416=begin table
1191 1417
1192 C = C<0> DEC Special Character and Line Drawing Set 1418 C = C<0> DEC Special Character and Line Drawing Set
1193 C = C<A> United Kingdom (UK) 1419 C = C<A> United Kingdom (UK)
1194 C = C<B> United States (USASCII) 1420 C = C<B> United States (USASCII)
1195 C = C<< < >> Multinational character set I<unimplemented> 1421 C = C<< < >> Multinational character set I<unimplemented>
1196 C = C<5> Finnish character set I<unimplemented> 1422 C = C<5> Finnish character set I<unimplemented>
1197 C = C<C> Finnish character set I<unimplemented> 1423 C = C<C> Finnish character set I<unimplemented>
1198 C = C<K> German character set I<unimplemented> 1424 C = C<K> German character set I<unimplemented>
1199 1425
1200=end table 1426=end table
1201 1427
1202=back 1428=back
1203 1429
1204X<CSI> 1430X<CSI>
1205 1431
1206=head1 CSI (Command Sequence Introducer) Sequences 1432=head2 CSI (Command Sequence Introducer) Sequences
1207 1433
1208=over 4 1434=over 4
1209 1435
1210=item B<< C<ESC [ Ps @> >> 1436=item B<< C<ESC [ Ps @> >>
1211 1437
… …
1251 1477
1252Erase in Display (ED) 1478Erase in Display (ED)
1253 1479
1254=begin table 1480=begin table
1255 1481
1256 B<< C<Ps = 0> >> Clear Below (default) 1482 B<< C<Ps = 0> >> Clear Right and Below (default)
1257 B<< C<Ps = 1> >> Clear Above 1483 B<< C<Ps = 1> >> Clear Left and Above
1258 B<< C<Ps = 2> >> Clear All 1484 B<< C<Ps = 2> >> Clear All
1259 1485
1260=end table 1486=end table
1261 1487
1262=item B<< C<ESC [ Ps K> >> 1488=item B<< C<ESC [ Ps K> >>
… …
1266=begin table 1492=begin table
1267 1493
1268 B<< C<Ps = 0> >> Clear to Right (default) 1494 B<< C<Ps = 0> >> Clear to Right (default)
1269 B<< C<Ps = 1> >> Clear to Left 1495 B<< C<Ps = 1> >> Clear to Left
1270 B<< C<Ps = 2> >> Clear All 1496 B<< C<Ps = 2> >> Clear All
1497 B<< C<Ps = 3> >> Like Ps = 0, but is ignored when wrapped
1498 (@@RXVT_NAME@@ extension)
1271 1499
1272=end table 1500=end table
1273 1501
1274=item B<< C<ESC [ Ps L> >> 1502=item B<< C<ESC [ Ps L> >>
1275 1503
… …
1392 1620
1393Character Attributes (SGR) 1621Character Attributes (SGR)
1394 1622
1395=begin table 1623=begin table
1396 1624
1397 B<< C<Ps = 0> >> Normal (default) 1625 B<< C<Pm = 0> >> Normal (default)
1398 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg) 1626 B<< C<Pm = 1 / 21> >> On / Off Bold (bright fg)
1399 B<< C<Ps = 3 / 23> >> On / Off Italic 1627 B<< C<Pm = 3 / 23> >> On / Off Italic
1400 B<< C<Ps = 4 / 24> >> On / Off Underline 1628 B<< C<Pm = 4 / 24> >> On / Off Underline
1401 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg) 1629 B<< C<Pm = 5 / 25> >> On / Off Slow Blink (bright bg)
1402 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg) 1630 B<< C<Pm = 6 / 26> >> On / Off Rapid Blink (bright bg)
1403 B<< C<Ps = 7 / 27> >> On / Off Inverse 1631 B<< C<Pm = 7 / 27> >> On / Off Inverse
1404 B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI) 1632 B<< C<Pm = 8 / 27> >> On / Off Invisible (NYI)
1405 B<< C<Ps = 30 / 40> >> fg/bg Black 1633 B<< C<Pm = 30 / 40> >> fg/bg Black
1406 B<< C<Ps = 31 / 41> >> fg/bg Red 1634 B<< C<Pm = 31 / 41> >> fg/bg Red
1407 B<< C<Ps = 32 / 42> >> fg/bg Green 1635 B<< C<Pm = 32 / 42> >> fg/bg Green
1408 B<< C<Ps = 33 / 43> >> fg/bg Yellow 1636 B<< C<Pm = 33 / 43> >> fg/bg Yellow
1409 B<< C<Ps = 34 / 44> >> fg/bg Blue 1637 B<< C<Pm = 34 / 44> >> fg/bg Blue
1410 B<< C<Ps = 35 / 45> >> fg/bg Magenta 1638 B<< C<Pm = 35 / 45> >> fg/bg Magenta
1411 B<< C<Ps = 36 / 46> >> fg/bg Cyan 1639 B<< C<Pm = 36 / 46> >> fg/bg Cyan
1640 B<< C<Pm = 37 / 47> >> fg/bg White
1412 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to color #m (ISO 8613-6) 1641 B<< C<Pm = 38;5 / 48;5> >> set fg/bg to colour #m (ISO 8613-6)
1413 B<< C<Ps = 37 / 47> >> fg/bg White 1642 B<< C<Pm = 38;2;R;G;B> >> set fg to 24-bit colour #RGB (ISO 8613-3)
1643 B<< C<Pm = 48;2;R;G;B> >> set bg to 24-bit colour #RGB (ISO 8613-3)
1414 B<< C<Ps = 39 / 49> >> fg/bg Default 1644 B<< C<Pm = 39 / 49> >> fg/bg Default
1415 B<< C<Ps = 90 / 100> >> fg/bg Bright Black 1645 B<< C<Pm = 90 / 100> >> fg/bg Bright Black
1416 B<< C<Ps = 91 / 101> >> fg/bg Bright Red 1646 B<< C<Pm = 91 / 101> >> fg/bg Bright Red
1417 B<< C<Ps = 92 / 102> >> fg/bg Bright Green 1647 B<< C<Pm = 92 / 102> >> fg/bg Bright Green
1418 B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow 1648 B<< C<Pm = 93 / 103> >> fg/bg Bright Yellow
1419 B<< C<Ps = 94 / 104> >> fg/bg Bright Blue 1649 B<< C<Pm = 94 / 104> >> fg/bg Bright Blue
1420 B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta 1650 B<< C<Pm = 95 / 105> >> fg/bg Bright Magenta
1421 B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan 1651 B<< C<Pm = 96 / 106> >> fg/bg Bright Cyan
1422 B<< C<Ps = 97 / 107> >> fg/bg Bright White 1652 B<< C<Pm = 97 / 107> >> fg/bg Bright White
1423 B<< C<Ps = 99 / 109> >> fg/bg Bright Default 1653 B<< C<Pm = 99 / 109> >> fg/bg Bright Default
1424 1654
1425=end table 1655=end table
1426 1656
1427=item B<< C<ESC [ Ps n> >> 1657=item B<< C<ESC [ Ps n> >>
1428 1658
… …
1430 1660
1431=begin table 1661=begin table
1432 1662
1433 B<< C<Ps = 5> >> Status Report B<< C<ESC [ 0 n> >> (``OK'') 1663 B<< C<Ps = 5> >> Status Report B<< C<ESC [ 0 n> >> (``OK'')
1434 B<< C<Ps = 6> >> Report Cursor Position (CPR) [row;column] as B<< C<ESC [ r ; c R> >> 1664 B<< C<Ps = 6> >> Report Cursor Position (CPR) [row;column] as B<< C<ESC [ r ; c R> >>
1435 B<< C<Ps = 7> >> Request Display Name 1665 B<< C<Ps = 7> >> Request Display Name (insecure mode)
1436 B<< C<Ps = 8> >> Request Version Number (place in window title) 1666 B<< C<Ps = 8> >> Request Version Number (place in window title)
1667
1668=end table
1669
1670=item B<< C<ESC [ Ps SP q> >>
1671
1672Set Cursor Style (DECSCUSR)
1673
1674=begin table
1675
1676 B<< C<Ps = 0> >> Blink Block
1677 B<< C<Ps = 1> >> Blink Block
1678 B<< C<Ps = 2> >> Steady Block
1679 B<< C<Ps = 3> >> Blink Underline
1680 B<< C<Ps = 4> >> Steady Underline
1681 B<< C<Ps = 5> >> Blink Bar (XTerm)
1682 B<< C<Ps = 6> >> Steady Bar (XTerm)
1437 1683
1438=end table 1684=end table
1439 1685
1440=item B<< C<ESC [ Ps;Ps r> >> 1686=item B<< C<ESC [ Ps;Ps r> >>
1441 1687
… …
1463 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>) 1709 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1464 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>) 1710 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1465 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>) 1711 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1466 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>) 1712 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1467 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9> 1713 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1468 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>) 1714 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>) (insecure mode)
1469 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>) 1715 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>) (insecure mode)
1470 B<< C<Ps = 24..> >> Set window height to C<Ps> rows 1716 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1471 1717
1472=end table 1718=end table
1473 1719
1474=item B<< C<ESC [ u> >> 1720=item B<< C<ESC [ u> >>
… …
1481 1727
1482=back 1728=back
1483 1729
1484X<PrivateModes> 1730X<PrivateModes>
1485 1731
1486=head1 DEC Private Modes 1732=head2 DEC Private Modes
1487 1733
1488=over 4 1734=over 4
1489 1735
1490=item B<< C<ESC [ ? Pm h> >> 1736=item B<< C<ESC [ ? Pm h> >>
1491 1737
… …
1507 1753
1508Toggle DEC Private Mode Values (rxvt extension). I<where> 1754Toggle DEC Private Mode Values (rxvt extension). I<where>
1509 1755
1510=over 4 1756=over 4
1511 1757
1512=item B<< C<Ps = 1> >> (DECCKM) 1758=item B<< C<Pm = 1> >> (DECCKM)
1513 1759
1514=begin table 1760=begin table
1515 1761
1516 B<< C<h> >> Application Cursor Keys 1762 B<< C<h> >> Application Cursor Keys
1517 B<< C<l> >> Normal Cursor Keys 1763 B<< C<l> >> Normal Cursor Keys
1518 1764
1519=end table 1765=end table
1520 1766
1521=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1767=item B<< C<Pm = 2> >> (DECANM)
1522 1768
1523=begin table 1769=begin table
1524 1770
1525 B<< C<h> >> Enter VT52 mode 1771 B<< C<h> >> Enter VT52 mode
1526 B<< C<l> >> Enter VT52 mode 1772 B<< C<l> >> Enter VT52 mode
1527 1773
1528=end table 1774=end table
1529 1775
1530=item B<< C<Ps = 3> >> 1776=item B<< C<Pm = 3> >> (DECCOLM)
1531 1777
1532=begin table 1778=begin table
1533 1779
1534 B<< C<h> >> 132 Column Mode (DECCOLM) 1780 B<< C<h> >> 132 Column Mode
1535 B<< C<l> >> 80 Column Mode (DECCOLM) 1781 B<< C<l> >> 80 Column Mode
1536 1782
1537=end table
1538
1539=item B<< C<Ps = 4> >>
1540
1541=begin table 1783=end table
1542 1784
1785=item B<< C<Pm = 4> >> (DECSCLM)
1786
1787=begin table
1788
1543 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1789 B<< C<h> >> Smooth (Slow) Scroll
1544 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1790 B<< C<l> >> Jump (Fast) Scroll
1545 1791
1546=end table
1547
1548=item B<< C<Ps = 5> >>
1549
1550=begin table 1792=end table
1551 1793
1794=item B<< C<Pm = 5> >> (DECSCNM)
1795
1796=begin table
1797
1552 B<< C<h> >> Reverse Video (DECSCNM) 1798 B<< C<h> >> Reverse Video
1553 B<< C<l> >> Normal Video (DECSCNM) 1799 B<< C<l> >> Normal Video
1554 1800
1555=end table
1556
1557=item B<< C<Ps = 6> >>
1558
1559=begin table 1801=end table
1560 1802
1803=item B<< C<Pm = 6> >> (DECOM)
1804
1805=begin table
1806
1561 B<< C<h> >> Origin Mode (DECOM) 1807 B<< C<h> >> Origin Mode
1562 B<< C<l> >> Normal Cursor Mode (DECOM) 1808 B<< C<l> >> Normal Cursor Mode
1563 1809
1564=end table
1565
1566=item B<< C<Ps = 7> >>
1567
1568=begin table 1810=end table
1569 1811
1812=item B<< C<Pm = 7> >> (DECAWM)
1813
1814=begin table
1815
1570 B<< C<h> >> Wraparound Mode (DECAWM) 1816 B<< C<h> >> Wraparound Mode
1571 B<< C<l> >> No Wraparound Mode (DECAWM) 1817 B<< C<l> >> No Wraparound Mode
1572 1818
1573=end table 1819=end table
1574 1820
1575=item B<< C<Ps = 8> >> I<unimplemented> 1821=item B<< C<Pm = 8> >> (DECARM) I<unimplemented>
1576 1822
1577=begin table 1823=begin table
1578 1824
1579 B<< C<h> >> Auto-repeat Keys (DECARM) 1825 B<< C<h> >> Auto-repeat Keys
1580 B<< C<l> >> No Auto-repeat Keys (DECARM) 1826 B<< C<l> >> No Auto-repeat Keys
1581 1827
1582=end table 1828=end table
1583 1829
1584=item B<< C<Ps = 9> >> X10 XTerm 1830=item B<< C<Pm = 9> >> (X10 XTerm mouse protocol)
1585 1831
1586=begin table 1832=begin table
1587 1833
1588 B<< C<h> >> Send Mouse X & Y on button press. 1834 B<< C<h> >> Send Mouse X & Y on button press.
1589 B<< C<l> >> No mouse reporting. 1835 B<< C<l> >> No mouse reporting.
1590 1836
1591=end table 1837=end table
1592 1838
1839=item B<< C<Pm = 12> >> (AT&T 610, XTerm)
1840
1841=begin table
1842
1843 B<< C<h> >> Blinking cursor (cvvis)
1844 B<< C<l> >> Steady cursor (cnorm)
1845
1846=end table
1847
1593=item B<< C<Ps = 25> >> 1848=item B<< C<Pm = 25> >> (DECTCEM)
1594 1849
1595=begin table 1850=begin table
1596 1851
1597 B<< C<h> >> Visible cursor {cnorm/cvvis} 1852 B<< C<h> >> Visible cursor {cnorm/cvvis}
1598 B<< C<l> >> Invisible cursor {civis} 1853 B<< C<l> >> Invisible cursor {civis}
1599 1854
1600=end table 1855=end table
1601 1856
1602=item B<< C<Ps = 30> >> 1857=item B<< C<Pm = 30> >> (B<rxvt>)
1603 1858
1604=begin table 1859=begin table
1605 1860
1606 B<< C<h> >> scrollBar visisble 1861 B<< C<h> >> scrollBar visible
1607 B<< C<l> >> scrollBar invisisble 1862 B<< C<l> >> scrollBar invisible
1608 1863
1609=end table 1864=end table
1610 1865
1611=item B<< C<Ps = 35> >> (B<rxvt>) 1866=item B<< C<Pm = 35> >> (B<rxvt>)
1612 1867
1613=begin table 1868=begin table
1614 1869
1615 B<< C<h> >> Allow XTerm Shift+key sequences 1870 B<< C<h> >> Allow XTerm Shift+key sequences
1616 B<< C<l> >> Disallow XTerm Shift+key sequences 1871 B<< C<l> >> Disallow XTerm Shift+key sequences
1617 1872
1618=end table 1873=end table
1619 1874
1620=item B<< C<Ps = 38> >> I<unimplemented> 1875=item B<< C<Pm = 38> >> I<unimplemented>
1621 1876
1622Enter Tektronix Mode (DECTEK) 1877Enter Tektronix Mode (DECTEK)
1623 1878
1624=item B<< C<Ps = 40> >> 1879=item B<< C<Pm = 40> >>
1625 1880
1626=begin table 1881=begin table
1627 1882
1628 B<< C<h> >> Allow 80/132 Mode 1883 B<< C<h> >> Allow 80/132 Mode
1629 B<< C<l> >> Disallow 80/132 Mode 1884 B<< C<l> >> Disallow 80/132 Mode
1630 1885
1631=end table 1886=end table
1632 1887
1633=item B<< C<Ps = 44> >> I<unimplemented> 1888=item B<< C<Pm = 44> >> I<unimplemented>
1634 1889
1635=begin table 1890=begin table
1636 1891
1637 B<< C<h> >> Turn On Margin Bell 1892 B<< C<h> >> Turn On Margin Bell
1638 B<< C<l> >> Turn Off Margin Bell 1893 B<< C<l> >> Turn Off Margin Bell
1639 1894
1640=end table 1895=end table
1641 1896
1642=item B<< C<Ps = 45> >> I<unimplemented> 1897=item B<< C<Pm = 45> >> I<unimplemented>
1643 1898
1644=begin table 1899=begin table
1645 1900
1646 B<< C<h> >> Reverse-wraparound Mode 1901 B<< C<h> >> Reverse-wraparound Mode
1647 B<< C<l> >> No Reverse-wraparound Mode 1902 B<< C<l> >> No Reverse-wraparound Mode
1648 1903
1649=end table 1904=end table
1650 1905
1651=item B<< C<Ps = 46> >> I<unimplemented> 1906=item B<< C<Pm = 46> >> I<unimplemented>
1652 1907
1653=item B<< C<Ps = 47> >> 1908=item B<< C<Pm = 47> >>
1654 1909
1655=begin table 1910=begin table
1656 1911
1657 B<< C<h> >> Use Alternate Screen Buffer 1912 B<< C<h> >> Use Alternate Screen Buffer
1658 B<< C<l> >> Use Normal Screen Buffer 1913 B<< C<l> >> Use Normal Screen Buffer
1659 1914
1660=end table 1915=end table
1661 1916
1662X<Priv66> 1917X<Priv66>
1663 1918
1664=item B<< C<Ps = 66> >> 1919=item B<< C<Pm = 66> >> (DECNKM)
1665 1920
1666=begin table 1921=begin table
1667 1922
1668 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1923 B<< C<h> >> Application Keypad (DECKPAM/DECPAM) == C<ESC =>
1669 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1924 B<< C<l> >> Normal Keypad (DECKPNM/DECPNM) == C<< ESC > >>
1670 1925
1671=end table
1672
1673=item B<< C<Ps = 67> >>
1674
1675=begin table 1926=end table
1676 1927
1928=item B<< C<Pm = 67> >> (DECBKM)
1929
1930=begin table
1931
1677 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1932 B<< C<h> >> Backspace key sends B<< C<BS> >>
1678 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1933 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1679 1934
1680=end table 1935=end table
1681 1936
1682=item B<< C<Ps = 1000> >> (X11 XTerm) 1937=item B<< C<Pm = 1000> >> (X11 XTerm mouse protocol)
1683 1938
1684=begin table 1939=begin table
1685 1940
1686 B<< C<h> >> Send Mouse X & Y on button press and release. 1941 B<< C<h> >> Send Mouse X & Y on button press and release.
1687 B<< C<l> >> No mouse reporting. 1942 B<< C<l> >> No mouse reporting.
1688 1943
1689=end table 1944=end table
1690 1945
1691=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1946=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1692 1947
1693=begin table 1948=begin table
1694 1949
1695 B<< C<h> >> Use Hilite Mouse Tracking. 1950 B<< C<h> >> Use Hilite Mouse Tracking.
1696 B<< C<l> >> No mouse reporting. 1951 B<< C<l> >> No mouse reporting.
1697 1952
1698=end table 1953=end table
1699 1954
1955=item B<< C<Pm = 1002> >> (X11 XTerm cell motion mouse tracking)
1956
1957=begin table
1958
1959 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1960 B<< C<l> >> No mouse reporting.
1961
1962=end table
1963
1964=item B<< C<Pm = 1003> >> (X11 XTerm all motion mouse tracking)
1965
1966=begin table
1967
1968 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1969 B<< C<l> >> No mouse reporting.
1970
1971=end table
1972
1973=item B<< C<Pm = 1004> >> (X11 XTerm focus in/focus out events)
1974
1975=begin table
1976
1977 B<< C<h> >> Send Mouse focus in/focus out events.
1978 B<< C<l> >> Don't send focus events.
1979
1980=end table
1981
1982=item B<< C<Pm = 1005> >> (X11 XTerm UTF-8 mouse mode) (Compile frills)
1983
1984Try to avoid this mode, it doesn't work sensibly in non-UTF-8 locales. Use
1985mode C<1015> instead.
1986
1987Unlike XTerm, coordinates larger than 2015 will work fine.
1988
1989=begin table
1990
1991 B<< C<h> >> Enable mouse coordinates in locale-specific encoding.
1992 B<< C<l> >> Disable mouse coordinates in locale-specific encoding.
1993
1994=end table
1995
1996=item B<< C<Pm = 1006> >> (X11 XTerm SGR mouse mode) (Compile frills)
1997
1998=begin table
1999
2000 B<< C<h> >> Enable xterm SGR mouse coordinate reporting.
2001 B<< C<l> >> Disable xterm SGR mouse coordinate reporting.
2002
2003=end table
2004
1700=item B<< C<Ps = 1010> >> (B<rxvt>) 2005=item B<< C<Pm = 1010> >> (B<rxvt>)
1701 2006
1702=begin table 2007=begin table
1703 2008
1704 B<< C<h> >> Don't scroll to bottom on TTY output 2009 B<< C<h> >> Don't scroll to bottom on TTY output
1705 B<< C<l> >> Scroll to bottom on TTY output 2010 B<< C<l> >> Scroll to bottom on TTY output
1706 2011
1707=end table 2012=end table
1708 2013
1709=item B<< C<Ps = 1011> >> (B<rxvt>) 2014=item B<< C<Pm = 1011> >> (B<rxvt>)
1710 2015
1711=begin table 2016=begin table
1712 2017
1713 B<< C<h> >> Scroll to bottom when a key is pressed 2018 B<< C<h> >> Scroll to bottom when a key is pressed
1714 B<< C<l> >> Don't scroll to bottom when a key is pressed 2019 B<< C<l> >> Don't scroll to bottom when a key is pressed
1715 2020
1716=end table 2021=end table
1717 2022
2023=item B<< C<Pm = 1015> >> (B<rxvt-unicode>) (Compile frills)
2024
2025=begin table
2026
2027 B<< C<h> >> Enable urxvt mouse coordinate reporting.
2028 B<< C<l> >> Disable urxvt mouse coordinate reporting.
2029
2030=end table
2031
1718=item B<< C<Ps = 1021> >> (B<rxvt>) 2032=item B<< C<Pm = 1021> >> (B<rxvt>)
1719 2033
1720=begin table 2034=begin table
1721 2035
1722 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>) 2036 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1723 B<< C<l> >> Font styles have no effect on intensity (Compile styles) 2037 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1724 2038
1725=end table 2039=end table
1726 2040
1727=item B<< C<Ps = 1047> >> 2041=item B<< C<Pm = 1047> >> (X11 XTerm alternate screen buffer)
1728 2042
1729=begin table 2043=begin table
1730 2044
1731 B<< C<h> >> Use Alternate Screen Buffer 2045 B<< C<h> >> Use Alternate Screen Buffer
1732 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 2046 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1733 2047
1734=end table 2048=end table
1735 2049
1736=item B<< C<Ps = 1048> >> 2050=item B<< C<Pm = 1048> >> (X11 XTerm alternate DECSC)
1737 2051
1738=begin table 2052=begin table
1739 2053
1740 B<< C<h> >> Save cursor position 2054 B<< C<h> >> Save cursor position
1741 B<< C<l> >> Restore cursor position 2055 B<< C<l> >> Restore cursor position
1742 2056
1743=end table 2057=end table
1744 2058
1745=item B<< C<Ps = 1049> >> 2059=item B<< C<Pm = 1049> >> (X11 XTerm 1047 + 1048)
1746 2060
1747=begin table 2061=begin table
1748 2062
1749 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it 2063 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1750 B<< C<l> >> Use Normal Screen Buffer 2064 B<< C<l> >> Use Normal Screen Buffer
1751 2065
1752=end table 2066=end table
1753 2067
2068=item B<< C<Pm = 2004> >> (X11 XTerm bracketed paste mode)
2069
2070=begin table
2071
2072 B<< C<h> >> Enable bracketed paste mode - prepend / append to the pasted text the control sequences C<ESC [ 200 ~> / C<ESC [ 201 ~>
2073 B<< C<l> >> Disable bracketed paste mode
2074
2075=end table
2076
1754=back 2077=back
1755 2078
1756=back 2079=back
1757 2080
1758X<XTerm> 2081X<XTerm>
1759 2082
1760=head1 XTerm Operating System Commands 2083=head2 XTerm Operating System Commands
1761 2084
1762=over 4 2085=over 4
1763 2086
1764=item B<< C<ESC ] Ps;Pt ST> >> 2087=item B<< C<ESC ] Ps;Pt ST> >>
1765 2088
1766Set XTerm Parameters. 8-bit ST: 0x9c, 7-bit ST sequence: ESC \ (0x1b, 2089Set XTerm Parameters. 8-bit ST: 0x9c, 7-bit ST sequence: ESC \ (0x1b,
17670x5c), backwards compatible terminator BEL (0x07) is also accepted. any 20900x5c), backwards compatible terminator BEL (0x07) is also accepted. any
1768B<octet> can be escaped by prefixing it with SYN (0x16, ^V). 2091B<octet> can be escaped by prefixing it with SYN (0x16, ^V).
1769 2092
2093Many of these settings can be queried by specifying C<?> as parameter, but
2094this requires insecure mode to be enabled for most of these.
2095
1770=begin table 2096=begin table
1771 2097
1772 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >> 2098 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>
1773 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >> 2099 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1774 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> 2100 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
1775 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. 2101 B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it (insecure mode). If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property.
1776 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 2102 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
1777 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 2103 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >>
1778 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 2104 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >>
1779 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 2105 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1780 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 2106 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1781 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 2107 B<< C<Ps = 17> >> Change background colour of highlight characters to B<< C<Pt> >>
1782 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706] 2108 B<< C<Ps = 19> >> Change foreground colour of highlight characters to B<< C<Pt> >>
1783 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707] 2109 B<< C<Ps = 20> >> Change background image to B<< C<Pt> >> (see the L<urxvt-background>) extension documentation)
1784 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
1785 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 2110 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. [deprecated, use 10]
1786 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 2111 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1787 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 2112 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. [deprecated, use 11]
1788 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> >> 2113 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> >>
1789 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 2114 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> [disabled]
1790 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). 2115 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (insecure mode, Compile frills).
1791 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>. 2116 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>.
1792 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 2117 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1793 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). 2118 B<< C<Ps = 705> >> Change background tint color to B<< C<Pt> >> (see the L<urxvt-background>) extension documentation)
1794 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >> 2119 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1795 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >> 2120 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
2121 B<< C<Ps = 708> >> Change colour of the border to B<< C<Pt> >>
1796 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 2122 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1797 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2123 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1798 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2124 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1799 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2125 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1800 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 2126 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
… …
1803 2129
1804=end table 2130=end table
1805 2131
1806=back 2132=back
1807 2133
1808X<XPM> 2134X<Mouse>
1809 2135
1810=head1 XPM 2136=head1 Mouse Reporting
1811 2137
1812For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2138When mouse reporting is enabled and none of the extended mouse modes
1813of B<< C<Pt> >> can be the name of the background pixmap followed by a 2139(1005, 1006, 1015) is active, urxvt sends the following sequence on a
1814sequence of scaling/positioning commands separated by semi-colons. The 2140mouse event:
1815scaling/positioning commands are as follows:
1816 2141
1817=over 4 2142=over 4
1818 2143
1819=item query scale/position
1820
1821B<?>
1822
1823=item change scale and position
1824
1825B<WxH+X+Y>
1826
1827B<WxH+X> (== B<WxH+X+X>)
1828
1829B<WxH> (same as B<WxH+50+50>)
1830
1831B<W+X+Y> (same as B<WxW+X+Y>)
1832
1833B<W+X> (same as B<WxW+X+X>)
1834
1835B<W> (same as B<WxW+50+50>)
1836
1837=item change position (absolute)
1838
1839B<=+X+Y>
1840
1841B<=+X> (same as B<=+X+Y>)
1842
1843=item change position (relative)
1844
1845B<+X+Y>
1846
1847B<+X> (same as B<+X+Y>)
1848
1849=item rescale (relative)
1850
1851B<Wx0> -> B<W *= (W/100)>
1852
1853B<0xH> -> B<H *= (H/100)>
1854
1855=back
1856
1857For example:
1858
1859=over 4
1860
1861=item B<\E]20;funky\a>
1862
1863load B<funky.xpm> as a tiled image
1864
1865=item B<\E]20;mona;100\a>
1866
1867load B<mona.xpm> with a scaling of 100%
1868
1869=item B<\E]20;;200;?\a>
1870
1871rescale the current pixmap to 200% and display the image geometry in
1872the title
1873
1874=back
1875X<Mouse>
1876
1877=head1 Mouse Reporting
1878
1879=over 4
1880
1881=item B<< C<< ESC [ M <b> <x> <y> >> >> 2144=item B<< C<< ESC [ M <b> <x> <y> >> >>
1882
1883report mouse position
1884 2145
1885=back 2146=back
1886 2147
1887The lower 2 bits of B<< C<< <b> >> >> indicate the button: 2148The lower 2 bits of B<< C<< <b> >> >> indicate the button:
1888 2149
… …
1904The upper bits of B<< C<< <b> >> >> indicate the modifiers when the 2165The upper bits of B<< C<< <b> >> >> indicate the modifiers when the
1905button was pressed and are added together (X11 mouse report only): 2166button was pressed and are added together (X11 mouse report only):
1906 2167
1907=over 4 2168=over 4
1908 2169
1909=item State = B<< C<< (<b> - SPACE) & 60 >> >> 2170=item State = B<< C<< (<b> - SPACE) & ~3 >> >>
1910 2171
1911=begin table 2172=begin table
1912 2173
1913 4 Shift 2174 4 Shift
1914 8 Meta 2175 8 Meta
1915 16 Control 2176 16 Control
2177 32 Motion Notify
1916 32 Double Click I<(rxvt extension)> 2178 32 Double Click I<(rxvt extension)>, disabled by default
2179 64 Button1 is actually Button4, Button2 is actually Button5 etc.
1917 2180
1918=end table 2181=end table
1919
1920Col = B<< C<< <x> - SPACE >> >>
1921
1922Row = B<< C<< <y> - SPACE >> >>
1923 2182
1924=back 2183=back
2184
2185C<x> and C<y> encode the coordinates (1|1 is the upper left corner,
2186just as with cursor positioning):
2187
2188=over 4
2189
2190=item Col = B<< C<< <x> - SPACE >> >>
2191
2192=item Row = B<< C<< <y> - SPACE >> >>
2193
2194=back
2195
2196The parameters include an offset of 32 to ensure that they are
2197printable characters.
2198
2199Example: Shift-Button-1 press at top row, column 80.
2200
2201 ESC [ M $ p !
2202
2203The largest coordinate that can be represented in this encoding is
2204223. The range can be extended by using one of the extended mouse
2205modes, which should be enabled I<before> enabling mouse reporting, for
2206semi-obvious reasons.
2207
2208=head2 Mode 1005
2209
2210If mode 1005 is active, urxvt sends the sequence
2211
2212=over 4
2213
2214=item B<< C<< ESC [ M <b> <x> <y> >> >>
2215
2216=back
2217
2218with the coordinates provided as characters in locale-encoding instead
2219of 1 byte octets. This mode does not work sensibly in non-UTF-8
2220locales and should therefore be avoided.
2221
2222=head2 Mode 1006
2223
2224If mode 1006 is active, urxvt sends the following sequences:
2225
2226=over 4
2227
2228=item B<< C<< ESC [ < <b>;<x>;<y> M >> >>
2229
2230button press and motion
2231
2232=item B<< C<< ESC [ < <b>;<x>;<y> m >> >>
2233
2234button release
2235
2236=back
2237
2238where the parameters are provided as decimal numbers instead of
2239octets and do not include an offset of 32.
2240
2241The lower 2 bits of C<b> encode the button number also on button
2242release (instead of the value C<3>). The final character of the
2243sequence (M or m) specifies the event type (press/motion or release).
2244
2245Example: Shift-Button-1 press at top row, column 80.
2246
2247 ESC [ < 4 ; 80 ; 1 M
2248
2249=head2 Mode 1015
2250
2251If mode 1015 is active, urxvt sends the sequence
2252
2253=over 4
2254
2255=item B<< C<< ESC [ <b>;<x>;<y> M >> >>
2256
2257=back
2258
2259where the parameters are provided as decimal numbers instead of
2260octets and only C<b> includes an offset of 32.
2261
2262Example: Shift-Button-1 press at top row, column 80.
2263
2264 ESC [ 36 ; 80 ; 1 M
2265
2266=head1 Key Codes
2267
1925X<KeyCodes> 2268X<KeyCodes>
1926 2269
1927=head1 Key Codes
1928
1929Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 2270Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
1930 2271
1931For the keypad, use B<Shift> to temporarily override Application-Keypad 2272For the keypad, use B<Shift> to temporarily toggle Application Keypad
1932setting use B<Num_Lock> to toggle Application-Keypad setting if 2273mode and use B<Num_Lock> to override Application Keypad mode, i.e. if
1933B<Num_Lock> is off, toggle Application-Keypad setting. Also note that 2274B<Num_Lock> is on the keypad is in normal mode. Also note that the
1934values of B<Home>, B<End>, B<Delete> may have been compiled differently on 2275values of B<BackSpace>, B<Delete> may have been compiled differently
1935your system. 2276on your system.
1936 2277
1937=begin table 2278=begin table
1938 2279
1939 B<Normal> B<Shift> B<Control> B<Ctrl+Shift> 2280 B<Normal> B<Shift> B<Control> B<Ctrl+Shift>
1940 Tab ^I ESC [ Z ^I ESC [ Z 2281 Tab ^I ESC [ Z ^I ESC [ Z
1941 BackSpace ^H ^? ^? ^? 2282 BackSpace ^? ^? ^H ^H
1942 Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @ 2283 Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @
1943 Insert ESC [ 2 ~ I<paste> ESC [ 2 ^ ESC [ 2 @ 2284 Insert ESC [ 2 ~ I<paste> ESC [ 2 ^ ESC [ 2 @
1944 Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @ 2285 Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
1945 Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @ 2286 Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @
1946 Prior ESC [ 5 ~ I<scroll-up> ESC [ 5 ^ ESC [ 5 @ 2287 Prior ESC [ 5 ~ I<scroll-up> ESC [ 5 ^ ESC [ 5 @
… …
1976 KP_Enter ^M ESC O M 2317 KP_Enter ^M ESC O M
1977 KP_F1 ESC O P ESC O P 2318 KP_F1 ESC O P ESC O P
1978 KP_F2 ESC O Q ESC O Q 2319 KP_F2 ESC O Q ESC O Q
1979 KP_F3 ESC O R ESC O R 2320 KP_F3 ESC O R ESC O R
1980 KP_F4 ESC O S ESC O S 2321 KP_F4 ESC O S ESC O S
1981 XK_KP_Multiply * ESC O j 2322 KP_Multiply * ESC O j
1982 XK_KP_Add + ESC O k 2323 KP_Add + ESC O k
1983 XK_KP_Separator , ESC O l 2324 KP_Separator , ESC O l
1984 XK_KP_Subtract - ESC O m 2325 KP_Subtract - ESC O m
1985 XK_KP_Decimal . ESC O n 2326 KP_Decimal . ESC O n
1986 XK_KP_Divide / ESC O o 2327 KP_Divide / ESC O o
1987 XK_KP_0 0 ESC O p 2328 KP_0 0 ESC O p
1988 XK_KP_1 1 ESC O q 2329 KP_1 1 ESC O q
1989 XK_KP_2 2 ESC O r 2330 KP_2 2 ESC O r
1990 XK_KP_3 3 ESC O s 2331 KP_3 3 ESC O s
1991 XK_KP_4 4 ESC O t 2332 KP_4 4 ESC O t
1992 XK_KP_5 5 ESC O u 2333 KP_5 5 ESC O u
1993 XK_KP_6 6 ESC O v 2334 KP_6 6 ESC O v
1994 XK_KP_7 7 ESC O w 2335 KP_7 7 ESC O w
1995 XK_KP_8 8 ESC O x 2336 KP_8 8 ESC O x
1996 XK_KP_9 9 ESC O y 2337 KP_9 9 ESC O y
1997 2338
1998=end table 2339=end table
1999 2340
2000=head1 CONFIGURE OPTIONS 2341=head1 CONFIGURE OPTIONS
2001 2342
2002General hint: if you get compile errors, then likely your configuration 2343General hint: if you get compile errors, then likely your configuration
2003hasn't been tested well. Either try with C<--enable-everything> or use 2344hasn't been tested well. Either try with C<--enable-everything> or use
2004the F<./reconf> script as a base for experiments. F<./reconf> is used by 2345the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2005myself, so it should generally be a working config. Of course, you should 2346switches). Of course, you should always report when a combination doesn't
2006always report when a combination doesn't work, so it can be fixed. Marc 2347work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2007Lehmann <rxvt@schmorp.de>.
2008 2348
2009All 2349All
2010 2350
2011=over 4 2351=over 4
2012 2352
2013=item --enable-everything 2353=item --enable-everything
2014 2354
2015Add (or remove) support for all non-multichoice options listed in "./configure 2355Add (or remove) support for all non-multichoice options listed
2016--help". 2356in C<./configure --help>, except for C<--enable-assert> and
2357C<--enable-256-color>.
2017 2358
2018You can specify this and then disable options you do not like by 2359You can specify this and then disable options you do not like by
2019I<following> this with the appropriate C<--disable-...> arguments, 2360I<following> this with the appropriate C<--disable-...> arguments,
2020or you can start with a minimal configuration by specifying 2361or you can start with a minimal configuration by specifying
2021C<--disable-everything> and than adding just the C<--enable-...> arguments 2362C<--disable-everything> and than adding just the C<--enable-...> arguments
2022you want. 2363you want.
2023 2364
2024=item --enable-xft (default: enabled) 2365=item --enable-xft (default: on)
2025 2366
2026Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2367Add support for Xft (anti-aliased, among others) fonts. Xft fonts are
2027slower and require lots of memory, but as long as you don't use them, you 2368slower and require lots of memory, but as long as you don't use them, you
2028don't pay for them. 2369don't pay for them.
2029 2370
2030=item --enable-font-styles (default: on) 2371=item --enable-font-styles (default: on)
2031 2372
2032Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2373Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2033styles. The fonts can be set manually or automatically. 2374styles. The fonts can be set manually or automatically.
2034 2375
2035=item --with-codesets=NAME,... (default: all) 2376=item --with-codesets=CS,... (default: all)
2036 2377
2037Compile in support for additional codeset (encoding) groups (C<eu>, C<vn> 2378Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2038are always compiled in, which includes most 8-bit character sets). These 2379are always compiled in, which includes most 8-bit character sets). These
2039codeset tables are used for driving X11 core fonts, they are not required 2380codeset tables are used for driving X11 core fonts, they are not required
2040for Xft fonts, although having them compiled in lets rxvt-unicode choose 2381for Xft fonts, although having them compiled in lets rxvt-unicode choose
… …
2044 2385
2045=begin table 2386=begin table
2046 2387
2047 all all available codeset groups 2388 all all available codeset groups
2048 zh common chinese encodings 2389 zh common chinese encodings
2049 zh_ext rarely used but very big chinese encodigs 2390 zh_ext rarely used but very big chinese encodings
2050 jp common japanese encodings 2391 jp common japanese encodings
2051 jp_ext rarely used but big japanese encodings 2392 jp_ext rarely used but big japanese encodings
2052 kr korean encodings 2393 kr korean encodings
2053 2394
2054=end table 2395=end table
… …
2068requirements per character from 2 to 4 bytes. X11 fonts do not yet 2409requirements per character from 2 to 4 bytes. X11 fonts do not yet
2069support these extra characters, but Xft does. 2410support these extra characters, but Xft does.
2070 2411
2071Please note that rxvt-unicode can store unicode code points >65535 2412Please note that rxvt-unicode can store unicode code points >65535
2072even without this flag, but the number of such characters is 2413even without this flag, but the number of such characters is
2073limited to a view thousand (shared with combining characters, 2414limited to a few thousand (shared with combining characters,
2074see next switch), and right now rxvt-unicode cannot display them 2415see next switch), and right now rxvt-unicode cannot display them
2075(input/output and cut&paste still work, though). 2416(input/output and cut&paste still work, though).
2076 2417
2077=item --enable-combining (default: on) 2418=item --enable-combining (default: on)
2078 2419
2079Enable automatic composition of combining characters into 2420Enable automatic composition of combining characters into
2080composite characters. This is required for proper viewing of text 2421composite characters. This is required for proper viewing of text
2081where accents are encoded as seperate unicode characters. This is 2422where accents are encoded as separate unicode characters. This is
2082done by using precomposited characters when available or creating 2423done by using precomposed characters when available or creating
2083new pseudo-characters when no precomposed form exists. 2424new pseudo-characters when no precomposed form exists.
2084 2425
2085Without --enable-unicode3, the number of additional precomposed 2426Without --enable-unicode3, the number of additional precomposed
2086characters is somewhat limited (the 6400 private use characters will be 2427characters is somewhat limited (the 6400 private use characters will be
2087(ab-)used). With --enable-unicode3, no practical limit exists. 2428(ab-)used). With --enable-unicode3, no practical limit exists.
… …
2091 2432
2092The combining table also contains entries for arabic presentation forms, 2433The combining table also contains entries for arabic presentation forms,
2093but these are not currently used. Bug me if you want these to be used (and 2434but these are not currently used. Bug me if you want these to be used (and
2094tell me how these are to be used...). 2435tell me how these are to be used...).
2095 2436
2096=item --enable-fallback(=CLASS) (default: Rxvt) 2437=item --enable-fallback[=CLASS] (default: Rxvt)
2097 2438
2098When reading resource settings, also read settings for class CLASS. To 2439When reading resource settings, also read settings for class CLASS. To
2099disable resource fallback use --disable-fallback. 2440disable resource fallback use --disable-fallback.
2100 2441
2101=item --with-res-name=NAME (default: urxvt) 2442=item --with-res-name=NAME (default: urxvt)
2102 2443
2103Use the given name as default application name when 2444Use the given name as default application name when
2104reading resources. Specify --with-res-name=rxvt to replace rxvt. 2445reading resources. Specify --with-res-name=rxvt to replace rxvt.
2105 2446
2106=item --with-res-class=CLASS /default: URxvt) 2447=item --with-res-class=CLASS (default: URxvt)
2107 2448
2108Use the given class as default application class 2449Use the given class as default application class
2109when reading resources. Specify --with-res-class=Rxvt to replace 2450when reading resources. Specify --with-res-class=Rxvt to replace
2110rxvt. 2451rxvt.
2111 2452
… …
2124 2465
2125Write user and tty to lastlog file (used by programs like 2466Write user and tty to lastlog file (used by programs like
2126F<lastlogin>) at start of rxvt execution. This option requires 2467F<lastlogin>) at start of rxvt execution. This option requires
2127--enable-utmp to also be specified. 2468--enable-utmp to also be specified.
2128 2469
2129=item --enable-xpm-background (default: on) 2470=item --enable-pixbuf (default: on)
2130 2471
2131Add support for XPM background pixmaps. 2472Add support for GDK-PixBuf to be used for background images.
2473It adds support for many file formats including JPG, PNG,
2474TIFF, GIF, XPM, BMP, ICO and TGA.
2475
2476=item --enable-startup-notification (default: on)
2477
2478Add support for freedesktop startup notifications. This allows window managers
2479to display some kind of progress indicator during startup.
2132 2480
2133=item --enable-transparency (default: on) 2481=item --enable-transparency (default: on)
2134 2482
2135Add support for inheriting parent backgrounds thus giving a fake 2483Add support for using the root pixmap as background to simulate transparency.
2136transparency to the term. 2484Note that this feature depends on libXrender and on the availability
2485of the RENDER extension in the X server.
2137 2486
2138=item --enable-fading (default: on) 2487=item --enable-fading (default: on)
2139 2488
2140Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2489Add support for fading the text when focus is lost.
2141
2142=item --enable-tinting (default: on)
2143
2144Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2145 2490
2146=item --enable-rxvt-scroll (default: on) 2491=item --enable-rxvt-scroll (default: on)
2147 2492
2148Add support for the original rxvt scrollbar. 2493Add support for the original rxvt scrollbar.
2149 2494
… …
2152Add support for a NeXT-like scrollbar. 2497Add support for a NeXT-like scrollbar.
2153 2498
2154=item --enable-xterm-scroll (default: on) 2499=item --enable-xterm-scroll (default: on)
2155 2500
2156Add support for an Xterm-like scrollbar. 2501Add support for an Xterm-like scrollbar.
2157
2158=item --enable-plain-scroll (default: on)
2159
2160Add support for a very unobtrusive, plain-looking scrollbar that
2161is the favourite of the rxvt-unicode author, having used it for
2162many years.
2163
2164=item --enable-ttygid (default: off)
2165
2166Change tty device setting to group "tty" - only use this if
2167your system uses this type of security.
2168 2502
2169=item --disable-backspace-key 2503=item --disable-backspace-key
2170 2504
2171Removes any handling of the backspace key by us - let the X server do it. 2505Removes any handling of the backspace key by us - let the X server do it.
2172 2506
… …
2192A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2526A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2193in combination with other switches) is: 2527in combination with other switches) is:
2194 2528
2195 MWM-hints 2529 MWM-hints
2196 EWMH-hints (pid, utf8 names) and protocols (ping) 2530 EWMH-hints (pid, utf8 names) and protocols (ping)
2531 urgency hint
2197 seperate underline colour (-underlineColor) 2532 separate underline colour (-underlineColor)
2198 settable border widths and borderless switch (-w, -b, -bl) 2533 settable border widths and borderless switch (-w, -b, -bl)
2199 visual depth selection (-depth) 2534 visual depth selection (-depth)
2200 settable extra linespacing /-lsp) 2535 settable extra linespacing (-lsp)
2201 iso-14755-2 and -3, and visual feedback 2536 iso-14755 5.1 (basic) support
2202 tripleclickwords (-tcw) 2537 tripleclickwords (-tcw)
2203 settable insecure mode (-insecure) 2538 settable insecure mode (-insecure)
2204 keysym remapping support 2539 keysym remapping support
2205 cursor blinking and underline cursor (-cb, -uc) 2540 cursor blinking and underline cursor (-bc, -uc)
2206 XEmbed support (-embed) 2541 XEmbed support (-embed)
2207 user-pty (-pty-fd) 2542 user-pty (-pty-fd)
2208 hold on exit (-hold) 2543 hold on exit (-hold)
2544 compile in built-in block graphics
2209 skip builtin block graphics (-sbg) 2545 skip builtin block graphics (-sbg)
2546 separate highlight colour (-highlightColor, -highlightTextColor)
2547 focus reporting mode (1004).
2548 extended mouse reporting modes (1005, 1006 and 1015).
2549 visual selection via -visual and -depth.
2550 systemd socket activation
2210 2551
2211It also enabled some non-essential features otherwise disabled, such as: 2552It also enables some non-essential features otherwise disabled, such as:
2212 2553
2213 some round-trip time optimisations 2554 some round-trip time optimisations
2214 nearest color allocation on pseudocolor screens 2555 nearest colour allocation on pseudocolor screens
2215 UTF8_STRING supporr for selection 2556 UTF8_STRING support for selection
2216 sgr modes 90..97 and 100..107 2557 sgr modes 90..97 and 100..107
2217 backindex and forwardindex escape sequences 2558 backindex and forwardindex escape sequences
2218 view change/zero scorllback esacpe sequences 2559 view change/zero scrollback escape sequences
2219 locale switching escape sequence 2560 locale switching escape sequence
2220 window op and some xterm/OSC escape sequences 2561 window op and some xterm/OSC escape sequences
2221 rectangular selections 2562 rectangular selections
2222 trailing space removal for selections 2563 trailing space removal for selections
2223 verbose X error handling 2564 verbose X error handling
2224 2565
2225=item --enable-iso14755 (default: on) 2566=item --enable-iso14755 (default: on)
2226 2567
2227Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2568Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)).
2228F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2569Basic support (section 5.1) is enabled by C<--enable-frills>, while
2229C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2570support for 5.2, 5.3 and 5.4 is enabled with this switch.
2230this switch.
2231 2571
2232=item --enable-keepscrolling (default: on) 2572=item --enable-keepscrolling (default: on)
2233 2573
2234Add support for continual scrolling of the display when you hold 2574Add support for continual scrolling of the display when you hold
2235the mouse button down on a scrollbar arrow. 2575the mouse button down on a scrollbar arrow.
2576
2577=item --enable-selectionscrolling (default: on)
2578
2579Add support for scrolling when the selection moves to the top or
2580bottom of the screen.
2236 2581
2237=item --enable-mousewheel (default: on) 2582=item --enable-mousewheel (default: on)
2238 2583
2239Add support for scrolling via mouse wheel or buttons 4 & 5. 2584Add support for scrolling via mouse wheel or buttons 4 & 5.
2240 2585
… …
2242 2587
2243Add support for continual scrolling (using the mouse wheel as an 2588Add support for continual scrolling (using the mouse wheel as an
2244accelerator) while the control key is held down. This option 2589accelerator) while the control key is held down. This option
2245requires --enable-mousewheel to also be specified. 2590requires --enable-mousewheel to also be specified.
2246 2591
2247=item --disable-new-selection
2248
2249Remove support for mouse selection style like that of xterm.
2250
2251=item --enable-dmalloc (default: off)
2252
2253Use Gray Watson's malloc - which is good for debugging See
2254http://www.letters.com/dmalloc/ for details If you use either this or the
2255next option, you may need to edit src/Makefile after compiling to point
2256DINCLUDE and DLIB to the right places.
2257
2258You can only use either this option and the following (should
2259you use either) .
2260
2261=item --enable-dlmalloc (default: off)
2262
2263Use Doug Lea's malloc - which is good for a production version
2264See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2265
2266=item --enable-smart-resize (default: on) 2592=item --enable-smart-resize (default: off)
2267 2593
2268Add smart growth/shrink behaviour when changing font size via hot 2594Add smart growth/shrink behaviour when resizing.
2269keys. This should keep the window corner which is closest to a corner of 2595This should keep the window corner which is closest to a corner of
2270the screen in a fixed position. 2596the screen in a fixed position.
2271 2597
2598=item --enable-text-blink (default: on)
2599
2600Add support for blinking text.
2601
2272=item --enable-pointer-blank (default: on) 2602=item --enable-pointer-blank (default: on)
2273 2603
2274Add support to have the pointer disappear when typing or inactive. 2604Add support to have the pointer disappear when typing or inactive.
2275 2605
2276=item --enable-perl (default: on) 2606=item --enable-perl (default: on)
2277 2607
2278Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2608Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2279manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files 2609manpage for more info on this feature, or the files in F<src/perl/>
2280in F<src/perl-ext/> for the extensions that are installed by default. The 2610for the extensions that are installed by default.
2281perl interpreter that is used can be specified via the C<PERL> environment 2611The perl interpreter that is used can be specified via the C<PERL>
2282variable when running configure. 2612environment variable when running configure. Even when compiled in,
2613perl will I<not> be initialised when all extensions have been disabled
2614C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2615resource standpoint.
2616
2617=item --enable-assert (default: off)
2618
2619Enables the assertions in the code, normally disabled. This switch is only
2620useful when developing rxvt-unicode.
2621
2622=item --enable-256-color (default: off)
2623
2624Force use of so-called 256 colour mode, to work around buggy applications
2625that do not support termcap/terminfo, or simply improve support for
2626applications hardcoding the xterm 256 colour table.
2627
2628This switch breaks termcap/terminfo compatibility to C<TERM=rxvt-unicode>,
2629and consequently sets C<TERM> to C<rxvt-unicode-256color> by default
2630(F<doc/etc/> contains termcap/terminfo definitions for both).
2631
2632It also results in higher memory usage and can slow down @@RXVT_NAME@@
2633dramatically when more than six fonts are in use by a terminal instance.
2283 2634
2284=item --with-name=NAME (default: urxvt) 2635=item --with-name=NAME (default: urxvt)
2285 2636
2286Set the basename for the installed binaries, resulting 2637Set the basename for the installed binaries, resulting
2287in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2638in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
… …
2297PATH. 2648PATH.
2298 2649
2299=item --with-x 2650=item --with-x
2300 2651
2301Use the X Window System (pretty much default, eh?). 2652Use the X Window System (pretty much default, eh?).
2302
2303=item --with-xpm-includes=DIR
2304
2305Look for the XPM includes in DIR.
2306
2307=item --with-xpm-library=DIR
2308
2309Look for the XPM library in DIR.
2310
2311=item --with-xpm
2312
2313Not needed - define via --enable-xpm-background.
2314 2653
2315=back 2654=back
2316 2655
2317=head1 AUTHORS 2656=head1 AUTHORS
2318 2657

Diff Legend

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