ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.107 by root, Tue Jan 31 21:04:14 2006 UTC vs.
Revision 1.162 by ayin, Sat Jan 19 15:00:49 2008 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
… …
73=head3 How can I start @@URXVT_NAME@@d in a race-free way? 76=head3 How can I start @@URXVT_NAME@@d in a race-free way?
74 77
75Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the 78Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
76display, create the listening socket and then fork. 79display, create the listening socket and then fork.
77 80
81=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
82
83If you want to start @@URXVT_NAME@@d automatically whenever you run
84@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
85
86 #!/bin/sh
87 @@URXVT_NAME@@c "$@"
88 if [ $? -eq 2 ]; then
89 @@URXVT_NAME@@d -q -o -f
90 @@URXVT_NAME@@c "$@"
91 fi
92
93This tries to create a new terminal, and if fails with exit status 2,
94meaning it couldn't connect to the daemon, it will start the daemon and
95re-run the command. Subsequent invocations of the script will re-use the
96existing daemon.
97
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. 98=head3 How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
79 99
80The original rxvt and rxvt-unicode always export the variable "COLORTERM", 100The 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, 101so you can check and see if that is set. Note that several programs, JED,
82slrn, Midnight Commander automatically check this variable to decide 102slrn, Midnight Commander automatically check this variable to decide
83whether or not to use color. 103whether or not to use color.
… …
108 fi 128 fi
109 129
110=head3 How do I compile the manual pages on my own? 130=head3 How do I compile the manual pages on my own?
111 131
112You need to have a recent version of perl installed as F</usr/bin/perl>, 132You 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 133one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from
114the doc subdirectory and enter C<make alldoc>. 134F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
115 135
116=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat? 136=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
117 137
118I often get asked about this, and I think, no, they didn't cause extra 138I 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 139bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
… …
127 98398 1664 24 15695 1824 rxvt --disable-everything 147 98398 1664 24 15695 1824 rxvt --disable-everything
128 188985 9048 66616 18222 1788 urxvt --disable-everything 148 188985 9048 66616 18222 1788 urxvt --disable-everything
129 149
130When you C<--enable-everything> (which I<is> unfair, as this involves xft 150When 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 151and full locale/XIM support which are quite bloaty inside libX11 and my
132libc), the two diverge, but not unreasnobaly so. 152libc), the two diverge, but not unreasonably so.
133 153
134 text data bss drs rss filename 154 text data bss drs rss filename
135 163431 2152 24 20123 2060 rxvt --enable-everything 155 163431 2152 24 20123 2060 rxvt --enable-everything
136 1035683 49680 66648 29096 3680 urxvt --enable-everything 156 1035683 49680 66648 29096 3680 urxvt --enable-everything
137 157
… …
180 200
181And here is rxvt-unicode: 201And here is rxvt-unicode:
182 202
183 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) 203 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
184 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) 204 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
185 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) 205 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
186 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) 206 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
187 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) 207 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
188 208
189No large bloated libraries (of course, none were linked in statically), 209No large bloated libraries (of course, none were linked in statically),
190except maybe libX11 :) 210except maybe libX11 :)
191 211
192 212
193=head2 Rendering, Font & Look and Feel Issues 213=head2 Rendering, Font & Look and Feel Issues
194 214
195=head3 I can't get transparency working, what am I doing wrong? 215=head3 I can't get transparency working, what am I doing wrong?
196 216
197First of all, transparency isn't officially supported in rxvt-unicode, so 217First of all, please address all transparency related issues to Sasha Vasko at
198you are mostly on your own. Do not bug the author about it (but you may 218sasha@aftercode.net and do not bug the author about it. Also, if you can't
199bug everybody else). Also, if you can't get it working consider it a rite 219get it working consider it a rite of passage: ... and you failed.
200of passage: ... and you failed.
201 220
202Here are four ways to get transparency. B<Do> read the manpage and option 221Here are four ways to get transparency. B<Do> read the manpage and option
203descriptions for the programs mentioned and rxvt-unicode. Really, do it! 222descriptions for the programs mentioned and rxvt-unicode. Really, do it!
204 223
2051. Use inheritPixmap: 2241. Use transparent mode:
206 225
207 Esetroot wallpaper.jpg 226 Esetroot wallpaper.jpg
208 @@URXVT_NAME@@ -ip -tint red -sh 40 227 @@URXVT_NAME@@ -tr -tint red -sh 40
209 228
210That works. If you think it doesn't, you lack transparency and tinting 229That works. If you think it doesn't, you lack transparency and tinting
211support, or you are unable to read. 230support, or you are unable to read.
212 231
2132. Use a simple pixmap and emulate pseudo-transparency. This enables you 2322. Use a simple pixmap and emulate pseudo-transparency. This enables you
214to use effects other than tinting and shading: Just shade/tint/whatever 233to use effects other than tinting and shading: Just shade/tint/whatever
215your picture with gimp or any other tool: 234your picture with gimp or any other tool:
216 235
217 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm 236 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
218 @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background 237 @@URXVT_NAME@@ -pixmap "background.jpg;:root"
219 238
220That works. If you think it doesn't, you lack XPM and Perl support, or you 239That works. If you think it doesn't, you lack AfterImage support, or you
221are unable to read. 240are unable to read.
222 241
2233. Use an ARGB visual: 2423. Use an ARGB visual:
224 243
225 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc 244 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
226 245
227This requires XFT support, and the support of your X-server. If that 246This 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 247doesn'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 248there yet, no matter what they claim. Rxvt-Unicode contains the necessary
230bugfixes and workarounds for Xft and Xlib to make it work, but that 249bugfixes and workarounds for Xft and Xlib to make it work, but that
231doesn't mean that your WM has the required kludges in place. 250doesn't mean that your WM has the required kludges in place.
232 251
2334. Use xcompmgr and let it do the job: 2524. Use xcompmgr and let it do the job:
234 253
… …
236 -set _NET_WM_WINDOW_OPACITY 0xc0000000 255 -set _NET_WM_WINDOW_OPACITY 0xc0000000
237 256
238Then click on a window you want to make transparent. Replace C<0xc0000000> 257Then 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 258by other values to change the degree of opacity. If it doesn't work and
240your server crashes, you got to keep the pieces. 259your 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 260
267=head3 Why does rxvt-unicode sometimes leave pixel droppings? 261=head3 Why does rxvt-unicode sometimes leave pixel droppings?
268 262
269Most fonts were not designed for terminal use, which means that character 263Most 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 264size varies a lot. A font that is otherwise fine for terminal use might
… …
276however: Xft fonts often draw glyphs larger than their acclaimed bounding 270however: 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 271box, 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 272ask for the character bounding box, which unfortunately is wrong in these
279cases). 273cases).
280 274
281It's not clear (to me at least), wether this is a bug in Xft, freetype, 275It'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 276or 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 277the C<-lsp> option to give the font more height. If that doesn't work, you
284might be forced to use a different font. 278might be forced to use a different font.
285 279
286All of this is not a problem when using X11 core fonts, as their bounding 280All of this is not a problem when using X11 core fonts, as their bounding
… …
310=head3 Can I switch the fonts at runtime? 304=head3 Can I switch the fonts at runtime?
311 305
312Yes, using an escape sequence. Try something like this, which has the same 306Yes, using an escape sequence. Try something like this, which has the same
313effect as using the C<-fn> switch, and takes effect immediately: 307effect as using the C<-fn> switch, and takes effect immediately:
314 308
315 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" 309 printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
316 310
317This is useful if you e.g. work primarily with japanese (and prefer a 311This is useful if you e.g. work primarily with japanese (and prefer a
318japanese font), but you have to switch to chinese temporarily, where 312japanese font), but you have to switch to chinese temporarily, where
319japanese fonts would only be in your way. 313japanese fonts would only be in your way.
320 314
… …
322 316
323=head3 Why do italic characters look as if clipped? 317=head3 Why do italic characters look as if clipped?
324 318
325Many fonts have difficulties with italic characters and hinting. For 319Many fonts have difficulties with italic characters and hinting. For
326example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans 320example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
327Mono> completely fails in it's italic face. A workaround might be to 321Mono> completely fails in its italic face. A workaround might be to
328enable freetype autohinting, i.e. like this: 322enable freetype autohinting, i.e. like this:
329 323
330 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 324 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
331 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 325 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
332 326
… …
338memory and also speeds up rendering considerably. 332memory and also speeds up rendering considerably.
339 333
340=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 334=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
341 335
342Rxvt-unicode will use whatever you specify as a font. If it needs to 336Rxvt-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 337fall 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 338fonts, because they are small and fast, and then use Xft fonts. It has
345antialiasing disabled for most of them, because the author thinks they 339antialiasing disabled for most of them, because the author thinks they
346look best that way. 340look best that way.
347 341
348If you want antialiasing, you have to specify the fonts manually. 342If you want antialiasing, you have to specify the fonts manually.
… …
350=head3 What's with this bold/blink stuff? 344=head3 What's with this bold/blink stuff?
351 345
352If no bold colour is set via C<colorBD:>, bold will invert text using the 346If no bold colour is set via C<colorBD:>, bold will invert text using the
353standard foreground colour. 347standard foreground colour.
354 348
355For the standard background colour, blinking will actually make the 349For the standard background colour, blinking will actually make
356text blink when compiled with C<--enable-blinking>. with standard 350the text blink when compiled with C<--enable-text-blink>. Without
357colours. Without C<--enable-blinking>, the blink attribute will be 351C<--enable-text-blink>, the blink attribute will be ignored.
358ignored.
359 352
360On ANSI colours, bold/blink attributes are used to set high-intensity 353On ANSI colours, bold/blink attributes are used to set high-intensity
361foreground/background colors. 354foreground/background colors.
362 355
363color0-7 are the low-intensity colors. 356color0-7 are the low-intensity colors.
… …
409 URxvt.color6: #73f7ff 402 URxvt.color6: #73f7ff
410 URxvt.color14: #73f7ff 403 URxvt.color14: #73f7ff
411 URxvt.color7: #e1dddd 404 URxvt.color7: #e1dddd
412 URxvt.color15: #e1dddd 405 URxvt.color15: #e1dddd
413 406
414(They were described (not by me) as "pretty girly"). 407They have been described (not by me) as "pretty girly".
415 408
416=head3 Why do some characters look so much different than others? 409=head3 Why do some characters look so much different than others?
417 410
418See next entry. 411See next entry.
419 412
420=head3 How does rxvt-unicode choose fonts? 413=head3 How does rxvt-unicode choose fonts?
421 414
422Most fonts do not contain the full range of Unicode, which is 415Most fonts do not contain the full range of Unicode, which is
423fine. Chances are that the font you (or the admin/package maintainer of 416fine. Chances are that the font you (or the admin/package maintainer of
424your system/os) have specified does not cover all the characters you want 417your system/os) have specified does not cover all the characters you want
425to display. 418to display.
426 419
427B<rxvt-unicode> makes a best-effort try at finding a replacement 420B<rxvt-unicode> makes a best-effort try at finding a replacement
428font. Often the result is fine, but sometimes the chosen font looks 421font. Often the result is fine, but sometimes the chosen font looks
429bad/ugly/wrong. Some fonts have totally strange characters that don't 422bad/ugly/wrong. Some fonts have totally strange characters that don't
430resemble the correct glyph at all, and rxvt-unicode lacks the artificial 423resemble the correct glyph at all, and rxvt-unicode lacks the artificial
431intelligence to detect that a specific glyph is wrong: it has to believe 424intelligence to detect that a specific glyph is wrong: it has to believe
432the font that the characters it claims to contain indeed look correct. 425the font that the characters it claims to contain indeed look correct.
433 426
434In that case, select a font of your taste and add it to the font list, 427In that case, select a font of your taste and add it to the font list,
435e.g.: 428e.g.:
436 429
437 @@URXVT_NAME@@ -fn basefont,font2,font3... 430 @@URXVT_NAME@@ -fn basefont,font2,font3...
438 431
439When rxvt-unicode sees a character, it will first look at the base 432When rxvt-unicode sees a character, it will first look at the base
440font. If the base font does not contain the character, it will go to the 433font. If the base font does not contain the character, it will go to the
441next font, and so on. Specifying your own fonts will also speed up this 434next font, and so on. Specifying your own fonts will also speed up this
442search and use less resources within rxvt-unicode and the X-server. 435search and use less resources within rxvt-unicode and the X-server.
443 436
444The only limitation is that none of the fonts may be larger than the base 437The only limitation is that none of the fonts may be larger than the base
445font, as the base font defines the terminal character cell size, which 438font, as the base font defines the terminal character cell size, which
446must be the same due to the way terminals work. 439must be the same due to the way terminals work.
447 440
441=head3 Why do some chinese characters look so different than others?
442
443This is because there is a difference between script and language --
444rxvt-unicode does not know which language the text that is output is,
445as it only knows the unicode character codes. If rxvt-unicode first
446sees a japanese/chinese character, it might choose a japanese font for
447display. Subsequent japanese characters will use that font. Now, many
448chinese characters aren't represented in japanese fonts, so when the first
449non-japanese character comes up, rxvt-unicode will look for a chinese font
450-- unfortunately at this point, it will still use the japanese font for
451chinese characters that are also in the japanese font.
452
453The workaround is easy: just tag a chinese font at the end of your font
454list (see the previous question). The key is to view the font list as
455a preference list: If you expect more japanese, list a japanese font
456first. If you expect more chinese, put a chinese font first.
457
458In the future it might be possible to switch language preferences at
459runtime (the internal data structure has no problem with using different
460fonts for the same character at the same time, but no interface for this
461has been designed yet).
462
463Until then, you might get away with switching fonts at runtime (see L<Can
464I switch the fonts at runtime?> later in this document).
465
466=head3 How can I make mplayer display video correctly?
467
468We are working on it, in the meantime, as a workaround, use something like:
469
470 @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
471
448 472
449=head2 Keyboard, Mouse & User Interaction 473=head2 Keyboard, Mouse & User Interaction
450 474
451=head3 The new selection selects pieces that are too big, how can I select single words? 475=head3 The new selection selects pieces that are too big, how can I select single words?
452 476
… …
460 484
461To get a selection that is very similar to the old code, try this pattern: 485To get a selection that is very similar to the old code, try this pattern:
462 486
463 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+) 487 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
464 488
465Please also note that the I<LeftClick Shift-LeftClik> combination also 489Please also note that the I<LeftClick Shift-LeftClick> combination also
466selects words like the old code. 490selects words like the old code.
467 491
468=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it? 492=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
469 493
470You can disable the perl extension completely by setting the 494You can disable the perl extension completely by setting the
… …
496circumstances, it will move your cursor around when you click into the 520circumstances, it will move your cursor around when you click into the
497line that contains it. It tries hard not to do this at the wrong moment, 521line that contains it. It tries hard not to do this at the wrong moment,
498but when running a program that doesn't parse cursor movements or in some 522but when running a program that doesn't parse cursor movements or in some
499cases during rlogin sessions, it fails to detect this properly. 523cases during rlogin sessions, it fails to detect this properly.
500 524
501You can permamently switch this feature off by disabling the C<readline> 525You can permanently switch this feature off by disabling the C<readline>
502extension: 526extension:
503 527
504 URxvt.perl-ext-common: default,-readline 528 URxvt.perl-ext-common: default,-readline
505 529
506=head3 My numerical keypad acts weird and generates differing output? 530=head3 My numerical keypad acts weird and generates differing output?
507 531
508Some Debian GNUL/Linux users seem to have this problem, although no 532Some Debian GNUL/Linux users seem to have this problem, although no
509specific details were reported so far. It is possible that this is caused 533specific details were reported so far. It is possible that this is caused
510by the wrong C<TERM> setting, although the details of wether and how 534by the wrong C<TERM> setting, although the details of whether and how
511this can happen are unknown, as C<TERM=rxvt> should offer a compatible 535this can happen are unknown, as C<TERM=rxvt> should offer a compatible
512keymap. See the answer to the previous question, and please report if that 536keymap. See the answer to the previous question, and please report if that
513helped. 537helped.
514 538
515=head3 My Compose (Multi_key) key is no longer working. 539=head3 My Compose (Multi_key) key is no longer working.
… …
541depressed. 565depressed.
542 566
543=head3 What's with the strange Backspace/Delete key behaviour? 567=head3 What's with the strange Backspace/Delete key behaviour?
544 568
545Assuming that the physical Backspace key corresponds to the 569Assuming that the physical Backspace key corresponds to the
546BackSpace keysym (not likely for Linux ... see the following 570Backspace keysym (not likely for Linux ... see the following
547question) there are two standard values that can be used for 571question) there are two standard values that can be used for
548Backspace: C<^H> and C<^?>. 572Backspace: C<^H> and C<^?>.
549 573
550Historically, either value is correct, but rxvt-unicode adopts the debian 574Historically, either value is correct, but rxvt-unicode adopts the debian
551policy of using C<^?> when unsure, because it's the one only only correct 575policy of using C<^?> when unsure, because it's the one and only correct
552choice :). 576choice :).
553 577
554Rxvt-unicode tries to inherit the current stty settings and uses the value 578Rxvt-unicode tries to inherit the current stty settings and uses the value
555of `erase' to guess the value for backspace. If rxvt-unicode wasn't 579of `erase' to guess the value for backspace. If rxvt-unicode wasn't
556started from a terminal (say, from a menu or by remote shell), then the 580started from a terminal (say, from a menu or by remote shell), then the
… …
588key has been assigned an escape sequence to match the vt100 for Execute 612key has been assigned an escape sequence to match the vt100 for Execute
589(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo. 613(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
590 614
591Some other Backspace problems: 615Some other Backspace problems:
592 616
593some editors use termcap/terminfo, 617some editors use termcap/terminfo,
594some editors (vim I'm told) expect Backspace = ^H, 618some editors (vim I'm told) expect Backspace = ^H,
595GNU Emacs (and Emacs-like editors) use ^H for help. 619GNU Emacs (and Emacs-like editors) use ^H for help.
596 620
597Perhaps someday this will all be resolved in a consistent manner. 621Perhaps someday this will all be resolved in a consistent manner.
598 622
… …
639Rather than have rxvt-unicode try to accommodate all the various possible 663Rather than have rxvt-unicode try to accommodate all the various possible
640keyboard mappings, it is better to use `xmodmap' to remap the keys as 664keyboard mappings, it is better to use `xmodmap' to remap the keys as
641required for your particular machine. 665required for your particular machine.
642 666
643 667
644
645=head2 Terminal Configuration 668=head2 Terminal Configuration
669
670=head3 Can I see a typical configuration?
671
672The default configuration tries to be xterm-like, which I don't like that
673much, but it's least surprise to regular users.
674
675As a rxvt or rxvt-unicode user, you are practically supposed to invest
676time into customising your terminal. To get you started, here is the
677author's .Xdefaults entries, with comments on what they do. It's certainly
678not I<typical>, but what's typical...
679
680 URxvt.cutchars: "()*,<>[]{}|'
681 URxvt.print-pipe: cat >/tmp/xxx
682
683These are just for testing stuff.
684
685 URxvt.imLocale: ja_JP.UTF-8
686 URxvt.preeditType: OnTheSpot,None
687
688This tells rxvt-unicode to use a special locale when communicating with
689the X Input Method, and also tells it to only use the OnTheSpot pre-edit
690type, which requires the C<xim-onthespot> perl extension but rewards me
691with correct-looking fonts.
692
693 URxvt.perl-lib: /root/lib/urxvt
694 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
695 URxvt.selection.pattern-0: ( at .*? line \\d+)
696 URxvt.selection.pattern-1: ^(/[^:]+):\
697 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
698 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
699
700This is my perl configuration. The first two set the perl library
701directory and also tells urxvt to use a large number of extensions. I
702develop for myself mostly, so I actually use most of the extensions I
703write.
704
705The selection stuff mainly makes the selection perl-error-message aware
706and tells it to convert perl error messages into vi-commands to load the
707relevant file and go tot he error line number.
708
709 URxvt.scrollstyle: plain
710 URxvt.secondaryScroll: true
711
712As the documentation says: plain is the preferred scrollbar for the
713author. The C<secondaryScroll> configures urxvt to scroll in full-screen
714apps, like screen, so lines scrolled out of screen end up in urxvt's
715scrollback buffer.
716
717 URxvt.background: #000000
718 URxvt.foreground: gray90
719 URxvt.color7: gray90
720 URxvt.colorBD: #ffffff
721 URxvt.cursorColor: #e0e080
722 URxvt.throughColor: #8080f0
723 URxvt.highlightColor: #f0f0f0
724
725Some colours. Not sure which ones are being used or even non-defaults, but
726these are in my .Xdefaults. Most notably, they set foreground/background
727to light gray/black, and also make sure that the colour 7 matches the
728default foreground colour.
729
730 URxvt.underlineColor: yellow
731
732Another colour, makes underline lines look different. Sometimes hurts, but
733is mostly a nice effect.
734
735 URxvt.geometry: 154x36
736 URxvt.loginShell: false
737 URxvt.meta: ignore
738 URxvt.utmpInhibit: true
739
740Uh, well, should be mostly self-explanatory. By specifying some defaults
741manually, I can quickly switch them for testing.
742
743 URxvt.saveLines: 8192
744
745A large scrollback buffer is essential. Really.
746
747 URxvt.mapAlert: true
748
749The only case I use it is for my IRC window, which I like to keep
750iconified till people msg me (which beeps).
751
752 URxvt.visualBell: true
753
754The audible bell is often annoying, especially when in a crowd.
755
756 URxvt.insecure: true
757
758Please don't hack my mutt! Ooops...
759
760 URxvt.pastableTabs: false
761
762I once thought this is a great idea.
763
764 urxvt.font: 9x15bold,\
765 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
766 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
767 [codeset=JISX0208]xft:Kochi Gothic, \
768 xft:Bitstream Vera Sans Mono:autohint=true, \
769 xft:Code2000:antialias=false
770 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
771 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
772 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
773
774I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
775overwhelmed. A special note: the C<9x15bold> mentioned above is actually
776the version from XFree-3.3, as XFree-4 replaced it by a totally different
777font (different glyphs for C<;> and many other harmless characters),
778while the second font is actually the C<9x15bold> from XFree4/XOrg. The
779bold version has less chars than the medium version, so I use it for rare
780characters, too. When editing sources with vim, I use italic for comments
781and other stuff, which looks quite good with Bitstream Vera anti-aliased.
782
783Terminus is a quite bad font (many very wrong glyphs), but for most of my
784purposes, it works, and gives a different look, as my normal (Non-bold)
785font is already bold, and I want to see a difference between bold and
786normal fonts.
787
788Please note that I used the C<urxvt> instance name and not the C<URxvt>
789class name. Thats because I use different configs for different purposes,
790for example, my IRC window is started with C<-name IRC>, and uses these
791defaults:
792
793 IRC*title: IRC
794 IRC*geometry: 87x12+535+542
795 IRC*saveLines: 0
796 IRC*mapAlert: true
797 IRC*font: suxuseuro
798 IRC*boldFont: suxuseuro
799 IRC*colorBD: white
800 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
801 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
802
803C<Alt-Shift-1> and C<Alt-Shift-2> switch between two different font
804sizes. C<suxuseuro> allows me to keep an eye (and actually read)
805stuff while keeping a very small window. If somebody pastes something
806complicated (e.g. japanese), I temporarily switch to a larger font.
807
808The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
809C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
810file for different hosts, for example, on ym main desktop, I use:
811
812 URxvt.keysym.C-M-q: command:\033[3;5;5t
813 URxvt.keysym.C-M-y: command:\033[3;5;606t
814 URxvt.keysym.C-M-e: command:\033[3;1605;5t
815 URxvt.keysym.C-M-c: command:\033[3;1605;606t
816 URxvt.keysym.C-M-p: perl:test
817
818The first for keysym definitions allow me to quickly bring some windows
819in the layout I like most. Ion users might start laughing but will stop
820immediately when I tell them that I use my own Fvwm2 module for much the
821same effect as Ion provides, and I only very rarely use the above key
822combinations :->
646 823
647=head3 Why doesn't rxvt-unicode read my resources? 824=head3 Why doesn't rxvt-unicode read my resources?
648 825
649Well, why, indeed? It does, in a way very similar to other X 826Well, why, indeed? It does, in a way very similar to other X
650applications. Most importantly, this means that if you or your OS loads 827applications. Most importantly, this means that if you or your OS loads
… …
659Also consider the form resources have to use: 836Also consider the form resources have to use:
660 837
661 URxvt.resource: value 838 URxvt.resource: value
662 839
663If you want to use another form (there are lots of different ways of 840If you want to use another form (there are lots of different ways of
664specifying resources), make sure you understand wether and why it 841specifying resources), make sure you understand whether and why it
665works. If unsure, use the form above. 842works. If unsure, use the form above.
666 843
667=head3 When I log-in to another system it tells me about missing terminfo data? 844=head3 When I log-in to another system it tells me about missing terminfo data?
668 845
669The terminal description used by rxvt-unicode is not as widely available 846The terminal description used by rxvt-unicode is not as widely available
670as that for xterm, or even rxvt (for which the same problem often arises). 847as that for xterm, or even rxvt (for which the same problem often arises).
671 848
672The correct solution for this problem is to install the terminfo, this can 849The correct solution for this problem is to install the terminfo, this can
673be done like this (with ncurses' infocmp): 850be done like this (with ncurses' infocmp and works as user and admin):
674 851
675 REMOTE=remotesystem.domain 852 REMOTE=remotesystem.domain
676 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" 853 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
677 854
678... or by installing rxvt-unicode normally on the remote system, 855... or by installing rxvt-unicode normally on the remote system,
856
857One some systems you might need to set C<$TERMINFO> to the full path of
858F<$HOME/.terminfo> for this to work.
679 859
680If you cannot or do not want to do this, then you can simply set 860If you cannot or do not want to do this, then you can simply set
681C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of 861C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
682problems arising, which includes wrong keymapping, less and different 862problems arising, which includes wrong keymapping, less and different
683colours and some refresh errors in fullscreen applications. It's a nice 863colours and some refresh errors in fullscreen applications. It's a nice
… …
706One reason you might want this is that some distributions or operating 886One reason you might want this is that some distributions or operating
707systems still compile some programs using the long-obsoleted termcap 887systems still compile some programs using the long-obsoleted termcap
708library (Fedora Core's bash is one example) and rely on a termcap entry 888library (Fedora Core's bash is one example) and rely on a termcap entry
709for C<rxvt-unicode>. 889for C<rxvt-unicode>.
710 890
711You could use rxvt's termcap entry with resonable results in many cases. 891You could use rxvt's termcap entry with reasonable results in many cases.
712You can also create a termcap entry by using terminfo's infocmp program 892You can also create a termcap entry by using terminfo's infocmp program
713like this: 893like this:
714 894
715 infocmp -C rxvt-unicode 895 infocmp -C rxvt-unicode
716 896
… …
738 :vs=\E[?25h: 918 :vs=\E[?25h:
739 919
740=head3 Why does C<ls> no longer have coloured output? 920=head3 Why does C<ls> no longer have coloured output?
741 921
742The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 922The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
743decide wether a terminal has colour, but uses it's own configuration 923decide whether a terminal has colour, but uses its own configuration
744file. Needless to say, C<rxvt-unicode> is not in it's default file (among 924file. Needless to say, C<rxvt-unicode> is not in its default file (among
745with most other terminals supporting colour). Either add: 925with most other terminals supporting colour). Either add:
746 926
747 TERM rxvt-unicode 927 TERM rxvt-unicode
748 928
749to C</etc/DIR_COLORS> or simply add: 929to C</etc/DIR_COLORS> or simply add:
… …
783If you encounter strange problems like typing an accented character but 963If you encounter strange problems like typing an accented character but
784getting two unrelated other characters or similar, or if program output is 964getting two unrelated other characters or similar, or if program output is
785subtly garbled, then you should check your locale settings. 965subtly garbled, then you should check your locale settings.
786 966
787Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 967Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
788programs. Often rxvt-unicode is started in the C<C> locale, while the 968programs running in it. Often rxvt-unicode is started in the C<C> locale,
789login script running within the rxvt-unicode window changes the locale to 969while the login script running within the rxvt-unicode window changes the
790something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work. 970locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
971not going to work, and is the most common cause for problems.
791 972
792The best thing is to fix your startup environment, as you will likely run 973The best thing is to fix your startup environment, as you will likely run
793into other problems. If nothing works you can try this in your .profile. 974into other problems. If nothing works you can try this in your .profile.
794 975
795 printf '\e]701;%s\007' "$LC_CTYPE" 976 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
796 977
797If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 978If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
798supported on your systems. Some systems have a C<locale> command which 979supported on your systems. Some systems have a C<locale> command which
799displays this (also, C<perl -e0> can be used to check locale settings, as 980displays this (also, C<perl -e0> can be used to check locale settings, as
800it will complain loudly if it cannot set the locale). If it displays something 981it will complain loudly if it cannot set the locale). If it displays something
… …
821The reasons is that there exists a perfectly fine mechanism for selecting 1002The reasons is that there exists a perfectly fine mechanism for selecting
822the encoding, doing I/O and (most important) communicating this to all 1003the encoding, doing I/O and (most important) communicating this to all
823applications so everybody agrees on character properties such as width 1004applications so everybody agrees on character properties such as width
824and code number. This mechanism is the I<locale>. Applications not using 1005and code number. This mechanism is the I<locale>. Applications not using
825that info will have problems (for example, C<xterm> gets the width of 1006that info will have problems (for example, C<xterm> gets the width of
826characters wrong as it uses it's own, locale-independent table under all 1007characters wrong as it uses its own, locale-independent table under all
827locales). 1008locales).
828 1009
829Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All 1010Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
830programs doing the same (that is, most) will automatically agree in the 1011programs doing the same (that is, most) will automatically agree in the
831interpretation of characters. 1012interpretation of characters.
… …
850=head3 Can I switch locales at runtime? 1031=head3 Can I switch locales at runtime?
851 1032
852Yes, using an escape sequence. Try something like this, which sets 1033Yes, using an escape sequence. Try something like this, which sets
853rxvt-unicode's idea of C<LC_CTYPE>. 1034rxvt-unicode's idea of C<LC_CTYPE>.
854 1035
855 printf '\e]701;%s\007' ja_JP.SJIS 1036 printf '\33]701;%s\007' ja_JP.SJIS
856 1037
857See also the previous answer. 1038See also the previous answer.
858 1039
859Sometimes this capability is rather handy when you want to work in 1040Sometimes this capability is rather handy when you want to work in
860one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it 1041one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
861(e.g. UTF-8). For example, I use this script to start C<xjdic>, which 1042(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
862first switches to a locale supported by xjdic and back later: 1043first switches to a locale supported by xjdic and back later:
863 1044
864 printf '\e]701;%s\007' ja_JP.SJIS 1045 printf '\33]701;%s\007' ja_JP.SJIS
865 xjdic -js 1046 xjdic -js
866 printf '\e]701;%s\007' de_DE.UTF-8 1047 printf '\33]701;%s\007' de_DE.UTF-8
867 1048
868You can also use xterm's C<luit> program, which usually works fine, except 1049You can also use xterm's C<luit> program, which usually works fine, except
869for some locales where character width differs between program- and 1050for some locales where character width differs between program- and
870rxvt-unicode-locales. 1051rxvt-unicode-locales.
871 1052
1053=head3 I have problems getting my input method working.
1054
1055Try a search engine, as this is slightly different for every input method server.
1056
1057Here is a checklist:
1058
1059=over 4
1060
1061=item - Make sure your locale I<and> the imLocale are supported on your OS.
1062
1063Try C<locale -a> or check the documentation for your OS.
1064
1065=item - Make sure your locale or imLocale matches a locale supported by your XIM.
1066
1067For example, B<kinput2> does not support UTF-8 locales, you should use
1068C<ja_JP.EUC-JP> or equivalent.
1069
1070=item - Make sure your XIM server is actually running.
1071
1072=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1073
1074When you want to use e.g. B<kinput2>, it must be set to
1075C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1076method servers are running with this command:
1077
1078 xprop -root XIM_SERVERS
1079
1080=item
1081
1082=back
1083
872=head3 My input method wants <some encoding> but I want UTF-8, what can I do? 1084=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
873 1085
874You can specify separate locales for the input method and the rest of the 1086You can specify separate locales for the input method and the rest of the
875terminal, using the resource C<imlocale>: 1087terminal, using the resource C<imlocale>:
876 1088
877 URxvt.imlocale: ja_JP.EUC-JP 1089 URxvt.imlocale: ja_JP.EUC-JP
878 1090
879Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 1091Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
880use your input method. Please note, however, that you will not be able to 1092use your input method. Please note, however, that, depending on your Xlib
881input characters outside C<EUC-JP> in a normal way then, as your input 1093version, you may not be able to input characters outside C<EUC-JP> in a
882method limits you. 1094normal way then, as your input method limits you.
883 1095
884=head3 Rxvt-unicode crashes when the X Input Method changes or exits. 1096=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
885 1097
886Unfortunately, this is unavoidable, as the XIM protocol is racy by 1098Unfortunately, this is unavoidable, as the XIM protocol is racy by
887design. Applications can avoid some crashes at the expense of memory 1099design. Applications can avoid some crashes at the expense of memory
… …
913 1125
914=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation? 1126=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
915 1127
916You should build one binary with the default options. F<configure> 1128You should build one binary with the default options. F<configure>
917now enables most useful options, and the trend goes to making them 1129now enables most useful options, and the trend goes to making them
918runtime-switchable, too, so there is usually no drawback to enbaling them, 1130runtime-switchable, too, so there is usually no drawback to enabling them,
919except higher disk and possibly memory usage. The perl interpreter should 1131except higher disk and possibly memory usage. The perl interpreter should
920be enabled, as important functionality (menus, selection, likely more in 1132be enabled, as important functionality (menus, selection, likely more in
921the future) depends on it. 1133the future) depends on it.
922 1134
923You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 1135You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
… …
946This forking is done as the very first within main(), which is very early 1158This forking is done as the very first within main(), which is very early
947and reduces possible bugs to initialisation code run before main(), or 1159and reduces possible bugs to initialisation code run before main(), or
948things like the dynamic loader of your system, which should result in very 1160things like the dynamic loader of your system, which should result in very
949little risk. 1161little risk.
950 1162
951=head3 On Solaris 9, many line-drawing characters are too wide.
952
953Seems to be a known bug, read
954L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
955following ugly workaround to get non-double-wide-characters working:
956
957 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
958
959=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all. 1163=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
960 1164
961Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1165Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
962in your compile environment, or an implementation that implements it, 1166in your compile environment, or an implementation that implements it,
963wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1167whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
964B<wchar_t> is represented as unicode. 1168B<wchar_t> is represented as unicode.
965 1169
966As you might have guessed, FreeBSD does neither define this symobl nor 1170As you might have guessed, FreeBSD does neither define this symbol nor
967does it support it. Instead, it uses it's own internal representation of 1171does it support it. Instead, it uses its own internal representation of
968B<wchar_t>. This is, of course, completely fine with respect to standards. 1172B<wchar_t>. This is, of course, completely fine with respect to standards.
969 1173
970However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and 1174However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
971C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>. 1175C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
972 1176
… …
986 1190
987The rxvt-unicode author insists that the right way to fix this is in the 1191The rxvt-unicode author insists that the right way to fix this is in the
988system libraries once and for all, instead of forcing every app to carry 1192system libraries once and for all, instead of forcing every app to carry
989complete replacements for them :) 1193complete replacements for them :)
990 1194
991=head3 I use Solaris 9 and it doesn't compile/work/etc.
992
993Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
994problems with C<wcwidth> and a compile problem.
995
996=head3 How can I use rxvt-unicode under cygwin? 1195=head3 How can I use rxvt-unicode under cygwin?
997 1196
998rxvt-unicode should compile and run out of the box on cygwin, using 1197rxvt-unicode should compile and run out of the box on cygwin, using
999the X11 libraries that come with cygwin. libW11 emulation is no 1198the X11 libraries that come with cygwin. libW11 emulation is no
1000longer supported (and makes no sense, either, as it only supported a 1199longer supported (and makes no sense, either, as it only supported a
… …
1004 1203
1005At the time of this writing, cygwin didn't seem to support any multi-byte 1204At the time of this writing, cygwin didn't seem to support any multi-byte
1006encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited 1205encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1007to 8-bit encodings. 1206to 8-bit encodings.
1008 1207
1208=head3 Character widths are not correct.
1209
1210urxvt uses the system wcwidth function to know the information about
1211the width of characters, so on systems with incorrect locale data you
1212will likely get bad results. Two notorious examples are Solaris 9,
1213where single-width characters like U+2514 are reported as double-width,
1214and Darwin 8, where combining chars are reported having width 1.
1215
1216The solution is to upgrade your system or switch to a better one. A
1217possibly working workaround is to use a wcwidth implementation like
1218
1219http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1220
1009=head1 RXVT-UNICODE TECHNICAL REFERENCE 1221=head1 RXVT-UNICODE TECHNICAL REFERENCE
1010
1011=head1 DESCRIPTION
1012 1222
1013The rest of this document describes various technical aspects of 1223The rest of this document describes various technical aspects of
1014B<rxvt-unicode>. First the description of supported command sequences, 1224B<rxvt-unicode>. First the description of supported command sequences,
1015followed by pixmap support and last by a description of all features 1225followed by pixmap support and last by a description of all features
1016selectable at C<configure> time. 1226selectable at C<configure> time.
1017 1227
1018=head1 Definitions 1228=head2 Definitions
1019 1229
1020=over 4 1230=over 4
1021 1231
1022=item B<< C<c> >> 1232=item B<< C<c> >>
1023 1233
… …
1041 1251
1042A text parameter composed of printable characters. 1252A text parameter composed of printable characters.
1043 1253
1044=back 1254=back
1045 1255
1046=head1 Values 1256=head2 Values
1047 1257
1048=over 4 1258=over 4
1049 1259
1050=item B<< C<ENQ> >> 1260=item B<< C<ENQ> >>
1051 1261
… …
1094 1304
1095Space Character 1305Space Character
1096 1306
1097=back 1307=back
1098 1308
1099=head1 Escape Sequences 1309=head2 Escape Sequences
1100 1310
1101=over 4 1311=over 4
1102 1312
1103=item B<< C<ESC # 8> >> 1313=item B<< C<ESC # 8> >>
1104 1314
… …
1202 1412
1203=back 1413=back
1204 1414
1205X<CSI> 1415X<CSI>
1206 1416
1207=head1 CSI (Command Sequence Introducer) Sequences 1417=head2 CSI (Command Sequence Introducer) Sequences
1208 1418
1209=over 4 1419=over 4
1210 1420
1211=item B<< C<ESC [ Ps @> >> 1421=item B<< C<ESC [ Ps @> >>
1212 1422
… …
1482 1692
1483=back 1693=back
1484 1694
1485X<PrivateModes> 1695X<PrivateModes>
1486 1696
1487=head1 DEC Private Modes 1697=head2 DEC Private Modes
1488 1698
1489=over 4 1699=over 4
1490 1700
1491=item B<< C<ESC [ ? Pm h> >> 1701=item B<< C<ESC [ ? Pm h> >>
1492 1702
… …
1508 1718
1509Toggle DEC Private Mode Values (rxvt extension). I<where> 1719Toggle DEC Private Mode Values (rxvt extension). I<where>
1510 1720
1511=over 4 1721=over 4
1512 1722
1513=item B<< C<Ps = 1> >> (DECCKM) 1723=item B<< C<Pm = 1> >> (DECCKM)
1514 1724
1515=begin table 1725=begin table
1516 1726
1517 B<< C<h> >> Application Cursor Keys 1727 B<< C<h> >> Application Cursor Keys
1518 B<< C<l> >> Normal Cursor Keys 1728 B<< C<l> >> Normal Cursor Keys
1519 1729
1520=end table 1730=end table
1521 1731
1522=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1732=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1523 1733
1524=begin table 1734=begin table
1525 1735
1526 B<< C<h> >> Enter VT52 mode 1736 B<< C<h> >> Enter VT52 mode
1527 B<< C<l> >> Enter VT52 mode 1737 B<< C<l> >> Enter VT52 mode
1528 1738
1529=end table 1739=end table
1530 1740
1531=item B<< C<Ps = 3> >> 1741=item B<< C<Pm = 3> >>
1532 1742
1533=begin table 1743=begin table
1534 1744
1535 B<< C<h> >> 132 Column Mode (DECCOLM) 1745 B<< C<h> >> 132 Column Mode (DECCOLM)
1536 B<< C<l> >> 80 Column Mode (DECCOLM) 1746 B<< C<l> >> 80 Column Mode (DECCOLM)
1537 1747
1538=end table 1748=end table
1539 1749
1540=item B<< C<Ps = 4> >> 1750=item B<< C<Pm = 4> >>
1541 1751
1542=begin table 1752=begin table
1543 1753
1544 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1754 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1545 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1755 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1546 1756
1547=end table 1757=end table
1548 1758
1549=item B<< C<Ps = 5> >> 1759=item B<< C<Pm = 5> >>
1550 1760
1551=begin table 1761=begin table
1552 1762
1553 B<< C<h> >> Reverse Video (DECSCNM) 1763 B<< C<h> >> Reverse Video (DECSCNM)
1554 B<< C<l> >> Normal Video (DECSCNM) 1764 B<< C<l> >> Normal Video (DECSCNM)
1555 1765
1556=end table 1766=end table
1557 1767
1558=item B<< C<Ps = 6> >> 1768=item B<< C<Pm = 6> >>
1559 1769
1560=begin table 1770=begin table
1561 1771
1562 B<< C<h> >> Origin Mode (DECOM) 1772 B<< C<h> >> Origin Mode (DECOM)
1563 B<< C<l> >> Normal Cursor Mode (DECOM) 1773 B<< C<l> >> Normal Cursor Mode (DECOM)
1564 1774
1565=end table 1775=end table
1566 1776
1567=item B<< C<Ps = 7> >> 1777=item B<< C<Pm = 7> >>
1568 1778
1569=begin table 1779=begin table
1570 1780
1571 B<< C<h> >> Wraparound Mode (DECAWM) 1781 B<< C<h> >> Wraparound Mode (DECAWM)
1572 B<< C<l> >> No Wraparound Mode (DECAWM) 1782 B<< C<l> >> No Wraparound Mode (DECAWM)
1573 1783
1574=end table 1784=end table
1575 1785
1576=item B<< C<Ps = 8> >> I<unimplemented> 1786=item B<< C<Pm = 8> >> I<unimplemented>
1577 1787
1578=begin table 1788=begin table
1579 1789
1580 B<< C<h> >> Auto-repeat Keys (DECARM) 1790 B<< C<h> >> Auto-repeat Keys (DECARM)
1581 B<< C<l> >> No Auto-repeat Keys (DECARM) 1791 B<< C<l> >> No Auto-repeat Keys (DECARM)
1582 1792
1583=end table 1793=end table
1584 1794
1585=item B<< C<Ps = 9> >> X10 XTerm 1795=item B<< C<Pm = 9> >> X10 XTerm
1586 1796
1587=begin table 1797=begin table
1588 1798
1589 B<< C<h> >> Send Mouse X & Y on button press. 1799 B<< C<h> >> Send Mouse X & Y on button press.
1590 B<< C<l> >> No mouse reporting. 1800 B<< C<l> >> No mouse reporting.
1591 1801
1592=end table 1802=end table
1593 1803
1594=item B<< C<Ps = 25> >> 1804=item B<< C<Pm = 25> >>
1595 1805
1596=begin table 1806=begin table
1597 1807
1598 B<< C<h> >> Visible cursor {cnorm/cvvis} 1808 B<< C<h> >> Visible cursor {cnorm/cvvis}
1599 B<< C<l> >> Invisible cursor {civis} 1809 B<< C<l> >> Invisible cursor {civis}
1600 1810
1601=end table 1811=end table
1602 1812
1603=item B<< C<Ps = 30> >> 1813=item B<< C<Pm = 30> >>
1604 1814
1605=begin table 1815=begin table
1606 1816
1607 B<< C<h> >> scrollBar visisble 1817 B<< C<h> >> scrollBar visible
1608 B<< C<l> >> scrollBar invisisble 1818 B<< C<l> >> scrollBar invisible
1609 1819
1610=end table 1820=end table
1611 1821
1612=item B<< C<Ps = 35> >> (B<rxvt>) 1822=item B<< C<Pm = 35> >> (B<rxvt>)
1613 1823
1614=begin table 1824=begin table
1615 1825
1616 B<< C<h> >> Allow XTerm Shift+key sequences 1826 B<< C<h> >> Allow XTerm Shift+key sequences
1617 B<< C<l> >> Disallow XTerm Shift+key sequences 1827 B<< C<l> >> Disallow XTerm Shift+key sequences
1618 1828
1619=end table 1829=end table
1620 1830
1621=item B<< C<Ps = 38> >> I<unimplemented> 1831=item B<< C<Pm = 38> >> I<unimplemented>
1622 1832
1623Enter Tektronix Mode (DECTEK) 1833Enter Tektronix Mode (DECTEK)
1624 1834
1625=item B<< C<Ps = 40> >> 1835=item B<< C<Pm = 40> >>
1626 1836
1627=begin table 1837=begin table
1628 1838
1629 B<< C<h> >> Allow 80/132 Mode 1839 B<< C<h> >> Allow 80/132 Mode
1630 B<< C<l> >> Disallow 80/132 Mode 1840 B<< C<l> >> Disallow 80/132 Mode
1631 1841
1632=end table 1842=end table
1633 1843
1634=item B<< C<Ps = 44> >> I<unimplemented> 1844=item B<< C<Pm = 44> >> I<unimplemented>
1635 1845
1636=begin table 1846=begin table
1637 1847
1638 B<< C<h> >> Turn On Margin Bell 1848 B<< C<h> >> Turn On Margin Bell
1639 B<< C<l> >> Turn Off Margin Bell 1849 B<< C<l> >> Turn Off Margin Bell
1640 1850
1641=end table 1851=end table
1642 1852
1643=item B<< C<Ps = 45> >> I<unimplemented> 1853=item B<< C<Pm = 45> >> I<unimplemented>
1644 1854
1645=begin table 1855=begin table
1646 1856
1647 B<< C<h> >> Reverse-wraparound Mode 1857 B<< C<h> >> Reverse-wraparound Mode
1648 B<< C<l> >> No Reverse-wraparound Mode 1858 B<< C<l> >> No Reverse-wraparound Mode
1649 1859
1650=end table 1860=end table
1651 1861
1652=item B<< C<Ps = 46> >> I<unimplemented> 1862=item B<< C<Pm = 46> >> I<unimplemented>
1653 1863
1654=item B<< C<Ps = 47> >> 1864=item B<< C<Pm = 47> >>
1655 1865
1656=begin table 1866=begin table
1657 1867
1658 B<< C<h> >> Use Alternate Screen Buffer 1868 B<< C<h> >> Use Alternate Screen Buffer
1659 B<< C<l> >> Use Normal Screen Buffer 1869 B<< C<l> >> Use Normal Screen Buffer
1660 1870
1661=end table 1871=end table
1662 1872
1663X<Priv66> 1873X<Priv66>
1664 1874
1665=item B<< C<Ps = 66> >> 1875=item B<< C<Pm = 66> >>
1666 1876
1667=begin table 1877=begin table
1668 1878
1669 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1879 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1670 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1880 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1671 1881
1672=end table 1882=end table
1673 1883
1674=item B<< C<Ps = 67> >> 1884=item B<< C<Pm = 67> >>
1675 1885
1676=begin table 1886=begin table
1677 1887
1678 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1888 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1679 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1889 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1680 1890
1681=end table 1891=end table
1682 1892
1683=item B<< C<Ps = 1000> >> (X11 XTerm) 1893=item B<< C<Pm = 1000> >> (X11 XTerm)
1684 1894
1685=begin table 1895=begin table
1686 1896
1687 B<< C<h> >> Send Mouse X & Y on button press and release. 1897 B<< C<h> >> Send Mouse X & Y on button press and release.
1688 B<< C<l> >> No mouse reporting. 1898 B<< C<l> >> No mouse reporting.
1689 1899
1690=end table 1900=end table
1691 1901
1692=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1902=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1693 1903
1694=begin table 1904=begin table
1695 1905
1696 B<< C<h> >> Use Hilite Mouse Tracking. 1906 B<< C<h> >> Use Hilite Mouse Tracking.
1697 B<< C<l> >> No mouse reporting. 1907 B<< C<l> >> No mouse reporting.
1698 1908
1699=end table 1909=end table
1700 1910
1911=item B<< C<Pm = 1002> >> (X11 XTerm)
1912
1913=begin table
1914
1915 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1916 B<< C<l> >> No mouse reporting.
1917
1918=end table
1919
1920=item B<< C<Pm = 1003> >> (X11 XTerm)
1921
1922=begin table
1923
1924 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1925 B<< C<l> >> No mouse reporting.
1926
1927=end table
1928
1701=item B<< C<Ps = 1010> >> (B<rxvt>) 1929=item B<< C<Pm = 1010> >> (B<rxvt>)
1702 1930
1703=begin table 1931=begin table
1704 1932
1705 B<< C<h> >> Don't scroll to bottom on TTY output 1933 B<< C<h> >> Don't scroll to bottom on TTY output
1706 B<< C<l> >> Scroll to bottom on TTY output 1934 B<< C<l> >> Scroll to bottom on TTY output
1707 1935
1708=end table 1936=end table
1709 1937
1710=item B<< C<Ps = 1011> >> (B<rxvt>) 1938=item B<< C<Pm = 1011> >> (B<rxvt>)
1711 1939
1712=begin table 1940=begin table
1713 1941
1714 B<< C<h> >> Scroll to bottom when a key is pressed 1942 B<< C<h> >> Scroll to bottom when a key is pressed
1715 B<< C<l> >> Don't scroll to bottom when a key is pressed 1943 B<< C<l> >> Don't scroll to bottom when a key is pressed
1716 1944
1717=end table 1945=end table
1718 1946
1719=item B<< C<Ps = 1021> >> (B<rxvt>) 1947=item B<< C<Pm = 1021> >> (B<rxvt>)
1720 1948
1721=begin table 1949=begin table
1722 1950
1723 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>) 1951 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1724 B<< C<l> >> Font styles have no effect on intensity (Compile styles) 1952 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1725 1953
1726=end table 1954=end table
1727 1955
1728=item B<< C<Ps = 1047> >> 1956=item B<< C<Pm = 1047> >>
1729 1957
1730=begin table 1958=begin table
1731 1959
1732 B<< C<h> >> Use Alternate Screen Buffer 1960 B<< C<h> >> Use Alternate Screen Buffer
1733 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1961 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1734 1962
1735=end table 1963=end table
1736 1964
1737=item B<< C<Ps = 1048> >> 1965=item B<< C<Pm = 1048> >>
1738 1966
1739=begin table 1967=begin table
1740 1968
1741 B<< C<h> >> Save cursor position 1969 B<< C<h> >> Save cursor position
1742 B<< C<l> >> Restore cursor position 1970 B<< C<l> >> Restore cursor position
1743 1971
1744=end table 1972=end table
1745 1973
1746=item B<< C<Ps = 1049> >> 1974=item B<< C<Pm = 1049> >>
1747 1975
1748=begin table 1976=begin table
1749 1977
1750 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it 1978 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1751 B<< C<l> >> Use Normal Screen Buffer 1979 B<< C<l> >> Use Normal Screen Buffer
… …
1756 1984
1757=back 1985=back
1758 1986
1759X<XTerm> 1987X<XTerm>
1760 1988
1761=head1 XTerm Operating System Commands 1989=head2 XTerm Operating System Commands
1762 1990
1763=over 4 1991=over 4
1764 1992
1765=item B<< C<ESC ] Ps;Pt ST> >> 1993=item B<< C<ESC ] Ps;Pt ST> >>
1766 1994
… …
1773 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >> 2001 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>
1774 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >> 2002 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1775 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> 2003 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
1776 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. 2004 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.
1777 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 2005 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
1778 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 2006 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >>
1779 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 2007 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >>
1780 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 2008 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1781 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 2009 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1782 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 2010 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1783 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706] 2011 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1784 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707] 2012 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1785 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM). 2013 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
1786 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 2014 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. [deprecated, use 10]
1787 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 2015 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1788 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 2016 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. [deprecated, use 11]
1789 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> >> 2017 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> >>
1790 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 2018 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1791 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). 2019 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).
1792 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>. 2020 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>.
1793 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 2021 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
… …
1804 2032
1805=end table 2033=end table
1806 2034
1807=back 2035=back
1808 2036
1809X<XPM> 2037=head1 BACKGROUND IMAGE
1810 2038
1811=head1 XPM
1812
1813For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2039For the BACKGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> the value
1814of B<< C<Pt> >> can be the name of the background pixmap followed by a 2040of B<< C<Pt> >> can be the name of the background image file followed by a
1815sequence of scaling/positioning commands separated by semi-colons. The 2041sequence of scaling/positioning commands separated by semi-colons. The
1816scaling/positioning commands are as follows: 2042scaling/positioning commands are as follows:
1817 2043
1818=over 4 2044=over 4
1819 2045
… …
1857 2083
1858For example: 2084For example:
1859 2085
1860=over 4 2086=over 4
1861 2087
1862=item B<\E]20;funky\a> 2088=item B<\E]20;funky.jpg\a>
1863 2089
1864load B<funky.xpm> as a tiled image 2090load B<funky.jpg> as a tiled image
1865 2091
1866=item B<\E]20;mona;100\a> 2092=item B<\E]20;mona.jpg;100\a>
1867 2093
1868load B<mona.xpm> with a scaling of 100% 2094load B<mona.jpg> with a scaling of 100%
1869 2095
1870=item B<\E]20;;200;?\a> 2096=item B<\E]20;;200;?\a>
1871 2097
1872rescale the current pixmap to 200% and display the image geometry in 2098rescale the current pixmap to 200% and display the image geometry in
1873the title 2099the title
… …
2000 2226
2001=head1 CONFIGURE OPTIONS 2227=head1 CONFIGURE OPTIONS
2002 2228
2003General hint: if you get compile errors, then likely your configuration 2229General hint: if you get compile errors, then likely your configuration
2004hasn't been tested well. Either try with C<--enable-everything> or use 2230hasn't been tested well. Either try with C<--enable-everything> or use
2005the F<./reconf> script as a base for experiments. F<./reconf> is used by 2231the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2006myself, so it should generally be a working config. Of course, you should 2232switches). Of course, you should always report when a combination doesn't
2007always report when a combination doesn't work, so it can be fixed. Marc 2233work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2008Lehmann <rxvt@schmorp.de>.
2009 2234
2010All 2235All
2011 2236
2012=over 4 2237=over 4
2013 2238
… …
2045 2270
2046=begin table 2271=begin table
2047 2272
2048 all all available codeset groups 2273 all all available codeset groups
2049 zh common chinese encodings 2274 zh common chinese encodings
2050 zh_ext rarely used but very big chinese encodigs 2275 zh_ext rarely used but very big chinese encodings
2051 jp common japanese encodings 2276 jp common japanese encodings
2052 jp_ext rarely used but big japanese encodings 2277 jp_ext rarely used but big japanese encodings
2053 kr korean encodings 2278 kr korean encodings
2054 2279
2055=end table 2280=end table
… …
2069requirements per character from 2 to 4 bytes. X11 fonts do not yet 2294requirements per character from 2 to 4 bytes. X11 fonts do not yet
2070support these extra characters, but Xft does. 2295support these extra characters, but Xft does.
2071 2296
2072Please note that rxvt-unicode can store unicode code points >65535 2297Please note that rxvt-unicode can store unicode code points >65535
2073even without this flag, but the number of such characters is 2298even without this flag, but the number of such characters is
2074limited to a view thousand (shared with combining characters, 2299limited to a few thousand (shared with combining characters,
2075see next switch), and right now rxvt-unicode cannot display them 2300see next switch), and right now rxvt-unicode cannot display them
2076(input/output and cut&paste still work, though). 2301(input/output and cut&paste still work, though).
2077 2302
2078=item --enable-combining (default: on) 2303=item --enable-combining (default: on)
2079 2304
… …
2102=item --with-res-name=NAME (default: urxvt) 2327=item --with-res-name=NAME (default: urxvt)
2103 2328
2104Use the given name as default application name when 2329Use the given name as default application name when
2105reading resources. Specify --with-res-name=rxvt to replace rxvt. 2330reading resources. Specify --with-res-name=rxvt to replace rxvt.
2106 2331
2107=item --with-res-class=CLASS /default: URxvt) 2332=item --with-res-class=CLASS (default: URxvt)
2108 2333
2109Use the given class as default application class 2334Use the given class as default application class
2110when reading resources. Specify --with-res-class=Rxvt to replace 2335when reading resources. Specify --with-res-class=Rxvt to replace
2111rxvt. 2336rxvt.
2112 2337
… …
2125 2350
2126Write user and tty to lastlog file (used by programs like 2351Write user and tty to lastlog file (used by programs like
2127F<lastlogin>) at start of rxvt execution. This option requires 2352F<lastlogin>) at start of rxvt execution. This option requires
2128--enable-utmp to also be specified. 2353--enable-utmp to also be specified.
2129 2354
2130=item --enable-xpm-background (default: on) 2355=item --enable-afterimage (default: on)
2131 2356
2132Add support for XPM background pixmaps. 2357Add support for libAfterImage to be used for transparency and background
2358images. It adds support for many file formats including JPG, PNG,
2359SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2360(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2361
2362This option also adds such eye candy as blending an image over the root
2363background, as well as dynamic scaling and bluring of background images.
2364
2365Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2366increase by a few megabytes even if no extra features are used (mostly due
2367to third-party libraries used by libAI). Memory footprint may somewhat be
2368lowered if libAfterImage is configured without support for SVG.
2133 2369
2134=item --enable-transparency (default: on) 2370=item --enable-transparency (default: on)
2135 2371
2136Add support for inheriting parent backgrounds thus giving a fake 2372Add support for backgrounds, creating illusion of transparency in the term.
2137transparency to the term.
2138 2373
2139=item --enable-fading (default: on) 2374=item --enable-fading (default: on)
2140 2375
2141Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2376Add support for fading the text when focus is lost.
2142
2143=item --enable-tinting (default: on)
2144
2145Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2146 2377
2147=item --enable-rxvt-scroll (default: on) 2378=item --enable-rxvt-scroll (default: on)
2148 2379
2149Add support for the original rxvt scrollbar. 2380Add support for the original rxvt scrollbar.
2150 2381
… …
2160 2391
2161Add support for a very unobtrusive, plain-looking scrollbar that 2392Add support for a very unobtrusive, plain-looking scrollbar that
2162is the favourite of the rxvt-unicode author, having used it for 2393is the favourite of the rxvt-unicode author, having used it for
2163many years. 2394many years.
2164 2395
2165=item --enable-ttygid (default: off)
2166
2167Change tty device setting to group "tty" - only use this if
2168your system uses this type of security.
2169
2170=item --disable-backspace-key 2396=item --disable-backspace-key
2171 2397
2172Removes any handling of the backspace key by us - let the X server do it. 2398Removes any handling of the backspace key by us - let the X server do it.
2173 2399
2174=item --disable-delete-key 2400=item --disable-delete-key
… …
2193A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2419A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2194in combination with other switches) is: 2420in combination with other switches) is:
2195 2421
2196 MWM-hints 2422 MWM-hints
2197 EWMH-hints (pid, utf8 names) and protocols (ping) 2423 EWMH-hints (pid, utf8 names) and protocols (ping)
2424 urgency hint
2198 seperate underline colour (-underlineColor) 2425 seperate underline colour (-underlineColor)
2199 settable border widths and borderless switch (-w, -b, -bl) 2426 settable border widths and borderless switch (-w, -b, -bl)
2200 visual depth selection (-depth) 2427 visual depth selection (-depth)
2201 settable extra linespacing /-lsp) 2428 settable extra linespacing /-lsp)
2202 iso-14755-2 and -3, and visual feedback 2429 iso-14755 5.1 (basic) support
2203 tripleclickwords (-tcw) 2430 tripleclickwords (-tcw)
2204 settable insecure mode (-insecure) 2431 settable insecure mode (-insecure)
2205 keysym remapping support 2432 keysym remapping support
2206 cursor blinking and underline cursor (-cb, -uc) 2433 cursor blinking and underline cursor (-cb, -uc)
2207 XEmbed support (-embed) 2434 XEmbed support (-embed)
2208 user-pty (-pty-fd) 2435 user-pty (-pty-fd)
2209 hold on exit (-hold) 2436 hold on exit (-hold)
2437 compile in built-in block graphics
2210 skip builtin block graphics (-sbg) 2438 skip builtin block graphics (-sbg)
2439 separate highlightcolor support (-hc)
2211 2440
2212It also enabled some non-essential features otherwise disabled, such as: 2441It also enables some non-essential features otherwise disabled, such as:
2213 2442
2214 some round-trip time optimisations 2443 some round-trip time optimisations
2215 nearest color allocation on pseudocolor screens 2444 nearest color allocation on pseudocolor screens
2216 UTF8_STRING supporr for selection 2445 UTF8_STRING support for selection
2217 sgr modes 90..97 and 100..107 2446 sgr modes 90..97 and 100..107
2218 backindex and forwardindex escape sequences 2447 backindex and forwardindex escape sequences
2219 view change/zero scorllback esacpe sequences 2448 view change/zero scrollback escape sequences
2220 locale switching escape sequence 2449 locale switching escape sequence
2221 window op and some xterm/OSC escape sequences 2450 window op and some xterm/OSC escape sequences
2222 rectangular selections 2451 rectangular selections
2223 trailing space removal for selections 2452 trailing space removal for selections
2224 verbose X error handling 2453 verbose X error handling
… …
2233=item --enable-keepscrolling (default: on) 2462=item --enable-keepscrolling (default: on)
2234 2463
2235Add support for continual scrolling of the display when you hold 2464Add support for continual scrolling of the display when you hold
2236the mouse button down on a scrollbar arrow. 2465the mouse button down on a scrollbar arrow.
2237 2466
2467=item --enable-selectionscrolling (default: on)
2468
2469Add support for scrolling when the selection moves to the top or
2470bottom of the screen.
2471
2238=item --enable-mousewheel (default: on) 2472=item --enable-mousewheel (default: on)
2239 2473
2240Add support for scrolling via mouse wheel or buttons 4 & 5. 2474Add support for scrolling via mouse wheel or buttons 4 & 5.
2241 2475
2242=item --enable-slipwheeling (default: on) 2476=item --enable-slipwheeling (default: on)
2243 2477
2244Add support for continual scrolling (using the mouse wheel as an 2478Add support for continual scrolling (using the mouse wheel as an
2245accelerator) while the control key is held down. This option 2479accelerator) while the control key is held down. This option
2246requires --enable-mousewheel to also be specified. 2480requires --enable-mousewheel to also be specified.
2247 2481
2248=item --disable-new-selection
2249
2250Remove support for mouse selection style like that of xterm.
2251
2252=item --enable-dmalloc (default: off)
2253
2254Use Gray Watson's malloc - which is good for debugging See
2255http://www.letters.com/dmalloc/ for details If you use either this or the
2256next option, you may need to edit src/Makefile after compiling to point
2257DINCLUDE and DLIB to the right places.
2258
2259You can only use either this option and the following (should
2260you use either) .
2261
2262=item --enable-dlmalloc (default: off)
2263
2264Use Doug Lea's malloc - which is good for a production version
2265See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2266
2267=item --enable-smart-resize (default: on) 2482=item --enable-smart-resize (default: off)
2268 2483
2269Add smart growth/shrink behaviour when changing font size via hot 2484Add smart growth/shrink behaviour when resizing.
2270keys. This should keep the window corner which is closest to a corner of 2485This should keep the window corner which is closest to a corner of
2271the screen in a fixed position. 2486the screen in a fixed position.
2272 2487
2488=item --enable-text-blink (default: on)
2489
2490Add support for blinking text.
2491
2273=item --enable-pointer-blank (default: on) 2492=item --enable-pointer-blank (default: on)
2274 2493
2275Add support to have the pointer disappear when typing or inactive. 2494Add support to have the pointer disappear when typing or inactive.
2276 2495
2277=item --enable-perl (default: on) 2496=item --enable-perl (default: on)
2278 2497
2279Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2498Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2280manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files 2499manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the
2281in F<src/perl-ext/> for the extensions that are installed by default. The 2500files in F<src/perl-ext/> for the extensions that are installed by
2282perl interpreter that is used can be specified via the C<PERL> environment 2501default. The perl interpreter that is used can be specified via the
2283variable when running configure. 2502C<PERL> environment variable when running configure. Even when compiled
2503in, perl will I<not> be initialised when all extensions have been disabled
2504C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2505resource standpoint.
2506
2507=item --with-afterimage-config=DIR
2508
2509Look for the libAfterImage config script in DIR.
2284 2510
2285=item --with-name=NAME (default: urxvt) 2511=item --with-name=NAME (default: urxvt)
2286 2512
2287Set the basename for the installed binaries, resulting 2513Set the basename for the installed binaries, resulting
2288in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2514in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
… …
2298PATH. 2524PATH.
2299 2525
2300=item --with-x 2526=item --with-x
2301 2527
2302Use the X Window System (pretty much default, eh?). 2528Use the X Window System (pretty much default, eh?).
2303
2304=item --with-xpm-includes=DIR
2305
2306Look for the XPM includes in DIR.
2307
2308=item --with-xpm-library=DIR
2309
2310Look for the XPM library in DIR.
2311
2312=item --with-xpm
2313
2314Not needed - define via --enable-xpm-background.
2315 2529
2316=back 2530=back
2317 2531
2318=head1 AUTHORS 2532=head1 AUTHORS
2319 2533

Diff Legend

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