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.60 by root, Fri Jul 29 03:12:10 2005 UTC vs.
Revision 1.159 by root, Fri Dec 21 13:19:07 2007 UTC

16=head1 DESCRIPTION 16=head1 DESCRIPTION
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 21The newest version of this document is also available on the World Wide Web at
22also available on the World Wide Web at 22L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
24 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>.
26
25=head1 FREQUENTLY ASKED QUESTIONS 27=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
26 28
27=over 4
28 29
30=head2 Meta, Features & Commandline Issues
31
32=head3 My question isn't answered here, can I ask a human?
33
34Before sending me mail, you could go to IRC: C<irc.freenode.net>,
35channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
36interested in learning about new and exciting problems (but not FAQs :).
37
38=head3 Does it support tabs, can I have a tabbed rxvt-unicode?
39
40Beginning with version 7.3, there is a perl extension that implements a
41simple tabbed terminal. It is installed by default, so any of these should
42give you tabs:
43
44 @@URXVT_NAME@@ -pe tabbed
45
46 URxvt.perl-ext-common: default,tabbed
47
48It will also work fine with tabbing functionality of many window managers
49or similar tabbing programs, and its embedding-features allow it to be
50embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
51the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
52(murxvt) terminal as an example embedding application.
53
29=item How do I know which rxvt-unicode version I'm using? 54=head3 How do I know which rxvt-unicode version I'm using?
30 55
31The version number is displayed with the usage (-h). Also the escape 56The version number is displayed with the usage (-h). Also the escape
32sequence C<ESC [ 8 n> sets the window title to the version number. 57sequence C<ESC [ 8 n> sets the window title to the version number. When
58using the @@URXVT_NAME@@c client, the version displayed is that of the
59daemon.
33 60
34=item I am using Debian GNU/Linux and have a problem... 61=head3 Rxvt-unicode uses gobs of memory, how can I reduce that?
35 62
36The Debian GNU/Linux package of rxvt-unicode in sarge contains large 63Rxvt-unicode tries to obey the rule of not charging you for something you
37patches that considerably change the behaviour of rxvt-unicode. Before 64don't use. One thing you should try is to configure out all settings that
38reporting a bug to the original rxvt-unicode author please download and 65you don't need, for example, Xft support is a resource hog by design,
39install the genuine version (L<http://software.schmorp.de#rxvt-unicode>) 66when used. Compiling it out ensures that no Xft font will be loaded
40and try to reproduce the problem. If you cannot, chances are that the 67accidentally when rxvt-unicode tries to find a font for your characters.
41problems are specific to Debian GNU/Linux, in which case it should be
42reported via the Debian Bug Tracking System (use C<reportbug> to report
43the bug).
44 68
45For other problems that also affect the Debian package, you can and 69Also, many people (me included) like large windows and even larger
46probably should use the Debian BTS, too, because, after all, it's also a 70scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
47bug in the Debian version and it serves as a reminder for other users that 716 bytes per screen cell. For a 160x?? window this amounts to almost a
48might encounter the same issue. 72kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
73use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
74rxvt-unicode then uses 8 bytes per screen cell.
49 75
76=head3 How can I start @@URXVT_NAME@@d in a race-free way?
77
78Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
79display, create the listening socket and then fork.
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
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.
99
100The original rxvt and rxvt-unicode always export the variable "COLORTERM",
101so you can check and see if that is set. Note that several programs, JED,
102slrn, Midnight Commander automatically check this variable to decide
103whether or not to use color.
104
105=head3 How do I set the correct, full IP address for the DISPLAY variable?
106
107If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
108insecure mode then it is possible to use the following shell script
109snippets to correctly set the display. If your version of rxvt-unicode
110wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
111the COLORTERM variable can be used to distinguish rxvt-unicode from a
112regular xterm.
113
114Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
115snippets:
116
117 # Bourne/Korn/POSIX family of shells:
118 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
119 if [ ${TERM:-foo} = xterm ]; then
120 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
121 echo -n '^[Z'
122 read term_id
123 stty icanon echo
124 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
125 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
126 read DISPLAY # set it in our local shell
127 fi
128 fi
129
130=head3 How do I compile the manual pages on my own?
131
132You need to have a recent version of perl installed as F</usr/bin/perl>,
133one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from
134F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
135
136=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
137
138I often get asked about this, and I think, no, they didn't cause extra
139bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
140that the urxvt binary is larger (due to some encoding tables always being
141compiled in), but it actually uses less memory (RSS) after startup. Even
142with C<--disable-everything>, this comparison is a bit unfair, as many
143features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
144already in use in this mode.
145
146 text data bss drs rss filename
147 98398 1664 24 15695 1824 rxvt --disable-everything
148 188985 9048 66616 18222 1788 urxvt --disable-everything
149
150When you C<--enable-everything> (which I<is> unfair, as this involves xft
151and full locale/XIM support which are quite bloaty inside libX11 and my
152libc), the two diverge, but not unreasonably so.
153
154 text data bss drs rss filename
155 163431 2152 24 20123 2060 rxvt --enable-everything
156 1035683 49680 66648 29096 3680 urxvt --enable-everything
157
158The very large size of the text section is explained by the east-asian
159encoding tables, which, if unused, take up disk space but nothing else
160and can be compiled out unless you rely on X11 core fonts that use those
161encodings. The BSS size comes from the 64k emergency buffer that my c++
162compiler allocates (but of course doesn't use unless you are out of
163memory). Also, using an xft font instead of a core font immediately adds a
164few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
165not used.
166
167Of course, due to every character using two or four bytes instead of one,
168a large scrollback buffer will ultimately make rxvt-unicode use more
169memory.
170
171Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
172still fares rather well. And compared to some monsters like gnome-terminal
173(21152k + extra 4204k in separate processes) or konsole (22200k + extra
17443180k in daemons that stay around after exit, plus half a minute of
175startup time, including the hundreds of warnings it spits out), it fares
176extremely well *g*.
177
178=head3 Why C++, isn't that unportable/bloated/uncool?
179
180Is this a question? :) It comes up very often. The simple answer is: I had
181to write it, and C++ allowed me to write and maintain it in a fraction
182of the time and effort (which is a scarce resource for me). Put even
183shorter: It simply wouldn't exist without C++.
184
185My personal stance on this is that C++ is less portable than C, but in
186the case of rxvt-unicode this hardly matters, as its portability limits
187are defined by things like X11, pseudo terminals, locale support and unix
188domain sockets, which are all less portable than C++ itself.
189
190Regarding the bloat, see the above question: It's easy to write programs
191in C that use gobs of memory, an certainly possible to write programs in
192C++ that don't. C++ also often comes with large libraries, but this is
193not necessarily the case with GCC. Here is what rxvt links against on my
194system with a minimal config:
195
196 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
197 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
198 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
199 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
200
201And here is rxvt-unicode:
202
203 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
204 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
205 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
206 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
207 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
208
209No large bloated libraries (of course, none were linked in statically),
210except maybe libX11 :)
211
212
213=head2 Rendering, Font & Look and Feel Issues
214
215=head3 I can't get transparency working, what am I doing wrong?
216
217First of all, please address all transparency related issues to Sasha Vasko at
218sasha@aftercode.net and do not bug the author about it. Also, if you can't
219get it working consider it a rite of passage: ... and you failed.
220
221Here are four ways to get transparency. B<Do> read the manpage and option
222descriptions for the programs mentioned and rxvt-unicode. Really, do it!
223
2241. Use transparent mode:
225
226 Esetroot wallpaper.jpg
227 @@URXVT_NAME@@ -tr -tint red -sh 40
228
229That works. If you think it doesn't, you lack transparency and tinting
230support, or you are unable to read.
231
2322. Use a simple pixmap and emulate pseudo-transparency. This enables you
233to use effects other than tinting and shading: Just shade/tint/whatever
234your picture with gimp or any other tool:
235
236 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
237 @@URXVT_NAME@@ -pixmap "background.jpg;:root"
238
239That works. If you think it doesn't, you lack AfterImage support, or you
240are unable to read.
241
2423. Use an ARGB visual:
243
244 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
245
246This requires XFT support, and the support of your X-server. If that
247doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
248there yet, no matter what they claim. Rxvt-Unicode contains the necessary
249bugfixes and workarounds for Xft and Xlib to make it work, but that
250doesn't mean that your WM has the required kludges in place.
251
2524. Use xcompmgr and let it do the job:
253
254 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
255 -set _NET_WM_WINDOW_OPACITY 0xc0000000
256
257Then click on a window you want to make transparent. Replace C<0xc0000000>
258by other values to change the degree of opacity. If it doesn't work and
259your server crashes, you got to keep the pieces.
260
261=head3 Why does rxvt-unicode sometimes leave pixel droppings?
262
263Most fonts were not designed for terminal use, which means that character
264size varies a lot. A font that is otherwise fine for terminal use might
265contain some characters that are simply too wide. Rxvt-unicode will avoid
266these characters. For characters that are just "a bit" too wide a special
267"careful" rendering mode is used that redraws adjacent characters.
268
269All of this requires that fonts do not lie about character sizes,
270however: Xft fonts often draw glyphs larger than their acclaimed bounding
271box, and rxvt-unicode has no way of detecting this (the correct way is to
272ask for the character bounding box, which unfortunately is wrong in these
273cases).
274
275It's not clear (to me at least), whether this is a bug in Xft, freetype,
276or the respective font. If you encounter this problem you might try using
277the C<-lsp> option to give the font more height. If that doesn't work, you
278might be forced to use a different font.
279
280All of this is not a problem when using X11 core fonts, as their bounding
281box data is correct.
282
283=head3 How can I keep rxvt-unicode from using reverse video so much?
284
285First of all, make sure you are running with the right terminal settings
286(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
287make sure you have specified colours for italic and bold, as otherwise
288rxvt-unicode might use reverse video to simulate the effect:
289
290 URxvt.colorBD: white
291 URxvt.colorIT: green
292
293=head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
294
295For some unexplainable reason, some rare programs assume a very weird
296colour palette when confronted with a terminal with more than the standard
2978 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
298these programs not to assume non-ISO colours without very good reasons.
299
300In the meantime, you can either edit your C<rxvt-unicode> terminfo
301definition to only claim 8 colour support or use C<TERM=rxvt>, which will
302fix colours but keep you from using other rxvt-unicode features.
303
304=head3 Can I switch the fonts at runtime?
305
306Yes, using an escape sequence. Try something like this, which has the same
307effect as using the C<-fn> switch, and takes effect immediately:
308
309 printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
310
311This is useful if you e.g. work primarily with japanese (and prefer a
312japanese font), but you have to switch to chinese temporarily, where
313japanese fonts would only be in your way.
314
315You can think of this as a kind of manual ISO-2022 switching.
316
317=head3 Why do italic characters look as if clipped?
318
319Many fonts have difficulties with italic characters and hinting. For
320example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
321Mono> completely fails in its italic face. A workaround might be to
322enable freetype autohinting, i.e. like this:
323
324 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
325 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
326
327=head3 Can I speed up Xft rendering somehow?
328
329Yes, the most obvious way to speed it up is to avoid Xft entirely, as
330it is simply slow. If you still want Xft fonts you might try to disable
331antialiasing (by appending C<:antialias=false>), which saves lots of
332memory and also speeds up rendering considerably.
333
334=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
335
336Rxvt-unicode will use whatever you specify as a font. If it needs to
337fall back to its default font search list it will prefer X11 core
338fonts, because they are small and fast, and then use Xft fonts. It has
339antialiasing disabled for most of them, because the author thinks they
340look best that way.
341
342If you want antialiasing, you have to specify the fonts manually.
343
344=head3 What's with this bold/blink stuff?
345
346If no bold colour is set via C<colorBD:>, bold will invert text using the
347standard foreground colour.
348
349For the standard background colour, blinking will actually make
350the text blink when compiled with C<--enable-text-blink>. Without
351C<--enable-text-blink>, the blink attribute will be ignored.
352
353On ANSI colours, bold/blink attributes are used to set high-intensity
354foreground/background colors.
355
356color0-7 are the low-intensity colors.
357
358color8-15 are the corresponding high-intensity colors.
359
360=head3 I don't like the screen colors. How do I change them?
361
362You can change the screen colors at run-time using F<~/.Xdefaults>
363resources (or as long-options).
364
365Here are values that are supposed to resemble a VGA screen,
366including the murky brown that passes for low-intensity yellow:
367
368 URxvt.color0: #000000
369 URxvt.color1: #A80000
370 URxvt.color2: #00A800
371 URxvt.color3: #A8A800
372 URxvt.color4: #0000A8
373 URxvt.color5: #A800A8
374 URxvt.color6: #00A8A8
375 URxvt.color7: #A8A8A8
376
377 URxvt.color8: #000054
378 URxvt.color9: #FF0054
379 URxvt.color10: #00FF54
380 URxvt.color11: #FFFF54
381 URxvt.color12: #0000FF
382 URxvt.color13: #FF00FF
383 URxvt.color14: #00FFFF
384 URxvt.color15: #FFFFFF
385
386And here is a more complete set of non-standard colors.
387
388 URxvt.cursorColor: #dc74d1
389 URxvt.pointerColor: #dc74d1
390 URxvt.background: #0e0e0e
391 URxvt.foreground: #4ad5e1
392 URxvt.color0: #000000
393 URxvt.color8: #8b8f93
394 URxvt.color1: #dc74d1
395 URxvt.color9: #dc74d1
396 URxvt.color2: #0eb8c7
397 URxvt.color10: #0eb8c7
398 URxvt.color3: #dfe37e
399 URxvt.color11: #dfe37e
400 URxvt.color5: #9e88f0
401 URxvt.color13: #9e88f0
402 URxvt.color6: #73f7ff
403 URxvt.color14: #73f7ff
404 URxvt.color7: #e1dddd
405 URxvt.color15: #e1dddd
406
407They have been described (not by me) as "pretty girly".
408
409=head3 Why do some characters look so much different than others?
410
411See next entry.
412
413=head3 How does rxvt-unicode choose fonts?
414
415Most fonts do not contain the full range of Unicode, which is
416fine. Chances are that the font you (or the admin/package maintainer of
417your system/os) have specified does not cover all the characters you want
418to display.
419
420B<rxvt-unicode> makes a best-effort try at finding a replacement
421font. Often the result is fine, but sometimes the chosen font looks
422bad/ugly/wrong. Some fonts have totally strange characters that don't
423resemble the correct glyph at all, and rxvt-unicode lacks the artificial
424intelligence to detect that a specific glyph is wrong: it has to believe
425the font that the characters it claims to contain indeed look correct.
426
427In that case, select a font of your taste and add it to the font list,
428e.g.:
429
430 @@URXVT_NAME@@ -fn basefont,font2,font3...
431
432When rxvt-unicode sees a character, it will first look at the base
433font. If the base font does not contain the character, it will go to the
434next font, and so on. Specifying your own fonts will also speed up this
435search and use less resources within rxvt-unicode and the X-server.
436
437The only limitation is that none of the fonts may be larger than the base
438font, as the base font defines the terminal character cell size, which
439must be the same due to the way terminals work.
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
472
473=head2 Keyboard, Mouse & User Interaction
474
475=head3 The new selection selects pieces that are too big, how can I select single words?
476
477If you want to select e.g. alphanumeric words, you can use the following
478setting:
479
480 URxvt.selection.pattern-0: ([[:word:]]+)
481
482If you click more than twice, the selection will be extended
483more and more.
484
485To get a selection that is very similar to the old code, try this pattern:
486
487 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
488
489Please also note that the I<LeftClick Shift-LeftClick> combination also
490selects words like the old code.
491
492=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
493
494You can disable the perl extension completely by setting the
495B<perl-ext-common> resource to the empty string, which also keeps
496rxvt-unicode from initialising perl, saving memory.
497
498If you only want to disable specific features, you first have to
499identify which perl extension is responsible. For this, read the section
500B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
501example, to disable the B<selection-popup> and B<option-popup>, specify
502this B<perl-ext-common> resource:
503
504 URxvt.perl-ext-common: default,-selection-popup,-option-popup
505
506This will keep the default extensions, but disable the two popup
507extensions. Some extensions can also be configured, for example,
508scrollback search mode is triggered by B<M-s>. You can move it to any
509other combination either by setting the B<searchable-scrollback> resource:
510
511 URxvt.searchable-scrollback: CM-s
512
513=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
514
515See next entry.
516
517=head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
518
519These are caused by the C<readline> perl extension. Under normal
520circumstances, it will move your cursor around when you click into the
521line that contains it. It tries hard not to do this at the wrong moment,
522but when running a program that doesn't parse cursor movements or in some
523cases during rlogin sessions, it fails to detect this properly.
524
525You can permanently switch this feature off by disabling the C<readline>
526extension:
527
528 URxvt.perl-ext-common: default,-readline
529
530=head3 My numerical keypad acts weird and generates differing output?
531
532Some Debian GNUL/Linux users seem to have this problem, although no
533specific details were reported so far. It is possible that this is caused
534by the wrong C<TERM> setting, although the details of whether and how
535this can happen are unknown, as C<TERM=rxvt> should offer a compatible
536keymap. See the answer to the previous question, and please report if that
537helped.
538
539=head3 My Compose (Multi_key) key is no longer working.
540
541The most common causes for this are that either your locale is not set
542correctly, or you specified a B<preeditStyle> that is not supported by
543your input method. For example, if you specified B<OverTheSpot> and
544your input method (e.g. the default input method handling Compose keys)
545does not support this (for instance because it is not visual), then
546rxvt-unicode will continue without an input method.
547
548In this case either do not specify a B<preeditStyle> or specify more than
549one pre-edit style, such as B<OverTheSpot,Root,None>.
550
551=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
552
553Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
554international keyboards) or simply use ISO 14755 support to your
555advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
556codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
557character and so on.
558
559=head3 Mouse cut/paste suddenly no longer works.
560
561Make sure that mouse reporting is actually turned off since killing
562some editors prematurely may leave the mouse in mouse report mode. I've
563heard that tcsh may use mouse reporting unless it otherwise specified. A
564quick check is to see if cut/paste works when the Alt or Shift keys are
565depressed.
566
567=head3 What's with the strange Backspace/Delete key behaviour?
568
569Assuming that the physical Backspace key corresponds to the
570Backspace keysym (not likely for Linux ... see the following
571question) there are two standard values that can be used for
572Backspace: C<^H> and C<^?>.
573
574Historically, either value is correct, but rxvt-unicode adopts the debian
575policy of using C<^?> when unsure, because it's the one and only correct
576choice :).
577
578Rxvt-unicode tries to inherit the current stty settings and uses the value
579of `erase' to guess the value for backspace. If rxvt-unicode wasn't
580started from a terminal (say, from a menu or by remote shell), then the
581system value of `erase', which corresponds to CERASE in <termios.h>, will
582be used (which may not be the same as your stty setting).
583
584For starting a new rxvt-unicode:
585
586 # use Backspace = ^H
587 $ stty erase ^H
588 $ @@URXVT_NAME@@
589
590 # use Backspace = ^?
591 $ stty erase ^?
592 $ @@URXVT_NAME@@
593
594Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
595
596For an existing rxvt-unicode:
597
598 # use Backspace = ^H
599 $ stty erase ^H
600 $ echo -n "^[[36h"
601
602 # use Backspace = ^?
603 $ stty erase ^?
604 $ echo -n "^[[36l"
605
606This helps satisfy some of the Backspace discrepancies that occur, but
607if you use Backspace = C<^H>, make sure that the termcap/terminfo value
608properly reflects that.
609
610The Delete key is a another casualty of the ill-defined Backspace problem.
611To avoid confusion between the Backspace and Delete keys, the Delete
612key has been assigned an escape sequence to match the vt100 for Execute
613(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
614
615Some other Backspace problems:
616
617some editors use termcap/terminfo,
618some editors (vim I'm told) expect Backspace = ^H,
619GNU Emacs (and Emacs-like editors) use ^H for help.
620
621Perhaps someday this will all be resolved in a consistent manner.
622
623=head3 I don't like the key-bindings. How do I change them?
624
625There are some compile-time selections available via configure. Unless
626you have run "configure" with the C<--disable-resources> option you can
627use the `keysym' resource to alter the keystrings associated with keysyms.
628
629Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
630
631 URxvt.keysym.Home: \033[1~
632 URxvt.keysym.End: \033[4~
633 URxvt.keysym.C-apostrophe: \033<C-'>
634 URxvt.keysym.C-slash: \033<C-/>
635 URxvt.keysym.C-semicolon: \033<C-;>
636 URxvt.keysym.C-grave: \033<C-`>
637 URxvt.keysym.C-comma: \033<C-,>
638 URxvt.keysym.C-period: \033<C-.>
639 URxvt.keysym.C-0x60: \033<C-`>
640 URxvt.keysym.C-Tab: \033<C-Tab>
641 URxvt.keysym.C-Return: \033<C-Return>
642 URxvt.keysym.S-Return: \033<S-Return>
643 URxvt.keysym.S-space: \033<S-Space>
644 URxvt.keysym.M-Up: \033<M-Up>
645 URxvt.keysym.M-Down: \033<M-Down>
646 URxvt.keysym.M-Left: \033<M-Left>
647 URxvt.keysym.M-Right: \033<M-Right>
648 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
649 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
650 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
651
652See some more examples in the documentation for the B<keysym> resource.
653
654=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
655
656 KP_Insert == Insert
657 F22 == Print
658 F27 == Home
659 F29 == Prior
660 F33 == End
661 F35 == Next
662
663Rather than have rxvt-unicode try to accommodate all the various possible
664keyboard mappings, it is better to use `xmodmap' to remap the keys as
665required for your particular machine.
666
667
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 :->
823
824=head3 Why doesn't rxvt-unicode read my resources?
825
826Well, why, indeed? It does, in a way very similar to other X
827applications. Most importantly, this means that if you or your OS loads
828resources into the X display (the right way to do it), rxvt-unicode will
829ignore any resource files in your home directory. It will only read
830F<$HOME/.Xdefaults> when no resources are attached to the display.
831
832If you have or use an F<$HOME/.Xresources> file, chances are that
833resources are loaded into your X-server. In this case, you have to
834re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
835
836Also consider the form resources have to use:
837
838 URxvt.resource: value
839
840If you want to use another form (there are lots of different ways of
841specifying resources), make sure you understand whether and why it
842works. If unsure, use the form above.
843
50=item 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?
51 845
52The terminal description used by rxvt-unicode is not as widely available 846The terminal description used by rxvt-unicode is not as widely available
53as 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).
54 848
55The 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
56be done like this (with ncurses' infocmp): 850be done like this (with ncurses' infocmp and works as user and admin):
57 851
58 REMOTE=remotesystem.domain 852 REMOTE=remotesystem.domain
59 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"
60 854
61... 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.
62 859
63If 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
64C<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
65problems arising, which includes wrong keymapping, less and different 862problems arising, which includes wrong keymapping, less and different
66colours and some refresh errors in fullscreen applications. It's a nice 863colours and some refresh errors in fullscreen applications. It's a nice
71resource to set it: 868resource to set it:
72 869
73 URxvt.termName: rxvt 870 URxvt.termName: rxvt
74 871
75If you don't plan to use B<rxvt> (quite common...) you could also replace 872If you don't plan to use B<rxvt> (quite common...) you could also replace
76the rxvt terminfo file with the rxvt-unicode one. 873the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
77 874
78=item C<tic> outputs some error when compiling the terminfo entry. 875=head3 C<tic> outputs some error when compiling the terminfo entry.
79 876
80Most likely it's the empty definition for C<enacs=>. Just replace it by 877Most likely it's the empty definition for C<enacs=>. Just replace it by
81C<enacs=\E[0@> and try again. 878C<enacs=\E[0@> and try again.
82 879
83=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@. 880=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
84 881
882See next entry.
883
85=item I need a termcap file entry. 884=head3 I need a termcap file entry.
86 885
87One reason you might want this is that some distributions or operating 886One reason you might want this is that some distributions or operating
88systems still compile some programs using the long-obsoleted termcap 887systems still compile some programs using the long-obsoleted termcap
89library (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
90for C<rxvt-unicode>. 889for C<rxvt-unicode>.
91 890
92You 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.
93You 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
94like this: 893like this:
95 894
96 infocmp -C rxvt-unicode 895 infocmp -C rxvt-unicode
97 896
116 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\ 915 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
117 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\ 916 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
118 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\ 917 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
119 :vs=\E[?25h: 918 :vs=\E[?25h:
120 919
121=item Why does C<ls> no longer have coloured output? 920=head3 Why does C<ls> no longer have coloured output?
122 921
123The 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
124decide wether a terminal has colour, but uses it's own configuration 923decide whether a terminal has colour, but uses its own configuration
125file. 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
126with most other terminals supporting colour). Either add: 925with most other terminals supporting colour). Either add:
127 926
128 TERM rxvt-unicode 927 TERM rxvt-unicode
129 928
130to C</etc/DIR_COLORS> or simply add: 929to C</etc/DIR_COLORS> or simply add:
131 930
132 alias ls='ls --color=auto' 931 alias ls='ls --color=auto'
133 932
134to your C<.profile> or C<.bashrc>. 933to your C<.profile> or C<.bashrc>.
135 934
136=item Why doesn't vim/emacs etc. use the 88 colour mode? 935=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
137 936
937See next entry.
938
138=item Why doesn't vim/emacs etc. make use of italic? 939=head3 Why doesn't vim/emacs etc. make use of italic?
139 940
941See next entry.
942
140=item Why are the secondary screen-related options not working properly? 943=head3 Why are the secondary screen-related options not working properly?
141 944
142Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged 945Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
143distributions (most notably Debian GNU/Linux) break rxvt-unicode 946distributions (most notably Debian GNU/Linux) break rxvt-unicode
144by setting C<TERM> to C<rxvt>, which doesn't have these extra 947by setting C<TERM> to C<rxvt>, which doesn't have these extra
145features. Unfortunately, some of these (most notably, again, Debian 948features. Unfortunately, some of these (most notably, again, Debian
146GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo 949GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
147file, so you will need to install it on your own (See the question B<When 950file, so you will need to install it on your own (See the question B<When
148I log-in to another system it tells me about missing terminfo data?> on 951I log-in to another system it tells me about missing terminfo data?> on
149how to do this). 952how to do this).
150 953
151=item My numerical keypad acts weird and generates differing output?
152 954
153Some Debian GNUL/Linux users seem to have this problem, although no 955=head2 Encoding / Locale / Input Method Issues
154specific details were reported so far. It is possible that this is caused
155by the wrong C<TERM> setting, although the details of wether and how
156this can happen are unknown, as C<TERM=rxvt> should offer a compatible
157keymap. See the answer to the previous question, and please report if that
158helped.
159 956
160=item Rxvt-unicode does not seem to understand the selected encoding? 957=head3 Rxvt-unicode does not seem to understand the selected encoding?
161 958
959See next entry.
960
162=item Unicode does not seem to work? 961=head3 Unicode does not seem to work?
163 962
164If you encounter strange problems like typing an accented character but 963If you encounter strange problems like typing an accented character but
165getting two unrelated other characters or similar, or if program output is 964getting two unrelated other characters or similar, or if program output is
166subtly garbled, then you should check your locale settings. 965subtly garbled, then you should check your locale settings.
167 966
168Rxvt-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
169programs. 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,
170login script running within the rxvt-unicode window changes the locale to 969while the login script running within the rxvt-unicode window changes the
171something 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.
172 972
173The 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
174into 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.
175 975
176 printf '\e]701;%s\007' "$LC_CTYPE" 976 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
177 977
178If 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
179supported on your systems. Some systems have a C<locale> command which 979supported on your systems. Some systems have a C<locale> command which
180displays 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
181it 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
187 987
188If nothing works and you are sure that everything is set correctly then 988If nothing works and you are sure that everything is set correctly then
189you will need to remember a little known fact: Some programs just don't 989you will need to remember a little known fact: Some programs just don't
190support locales :( 990support locales :(
191 991
192=item Why do some characters look so much different than others? 992=head3 How does rxvt-unicode determine the encoding to use?
193 993
194=item How does rxvt-unicode choose fonts? 994See next entry.
195 995
196Most fonts do not contain the full range of Unicode, which is 996=head3 Is there an option to switch encodings?
197fine. Chances are that the font you (or the admin/package maintainer of
198your system/os) have specified does not cover all the characters you want
199to display.
200 997
201B<rxvt-unicode> makes a best-effort try at finding a replacement 998Unlike some other terminals, rxvt-unicode has no encoding switch, and no
202font. Often the result is fine, but sometimes the chosen font looks 999specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
203bad/ugly/wrong. Some fonts have totally strange characters that don't 1000UTF-8 or any other encodings with respect to terminal I/O.
204resemble the correct glyph at all, and rxvt-unicode lacks the artificial
205intelligence to detect that a specific glyph is wrong: it has to believe
206the font that the characters it claims to contain indeed look correct.
207 1001
208In that case, select a font of your taste and add it to the font list, 1002The reasons is that there exists a perfectly fine mechanism for selecting
209e.g.: 1003the encoding, doing I/O and (most important) communicating this to all
210 1004applications so everybody agrees on character properties such as width
211 @@RXVT_NAME@@ -fn basefont,font2,font3... 1005and code number. This mechanism is the I<locale>. Applications not using
212 1006that info will have problems (for example, C<xterm> gets the width of
213When rxvt-unicode sees a character, it will first look at the base 1007characters wrong as it uses its own, locale-independent table under all
214font. If the base font does not contain the character, it will go to the
215next font, and so on. Specifying your own fonts will also speed up this
216search and use less resources within rxvt-unicode and the X-server.
217
218The only limitation is that none of the fonts may be larger than the base
219font, as the base font defines the terminal character cell size, which
220must be the same due to the way terminals work.
221
222=item Why do some chinese characters look so different than others?
223
224This is because there is a difference between script and language --
225rxvt-unicode does not know which language the text that is output is,
226as it only knows the unicode character codes. If rxvt-unicode first
227sees a japanese/chinese character, it might choose a japanese font for
228display. Subsequent japanese characters will use that font. Now, many
229chinese characters aren't represented in japanese fonts, so when the first
230non-japanese character comes up, rxvt-unicode will look for a chinese font
231-- unfortunately at this point, it will still use the japanese font for
232chinese characters that are also in the japanese font.
233
234The workaround is easy: just tag a chinese font at the end of your font
235list (see the previous question). The key is to view the font list as
236a preference list: If you expect more japanese, list a japanese font
237first. If you expect more chinese, put a chinese font first.
238
239In the future it might be possible to switch language preferences at
240runtime (the internal data structure has no problem with using different
241fonts for the same character at the same time, but no interface for this
242has been designed yet).
243
244Until then, you might get away with switching fonts at runtime (see L<Can
245I switch the fonts at runtime?> later in this document).
246
247=item Why does rxvt-unicode sometimes leave pixel droppings?
248
249Most fonts were not designed for terminal use, which means that character
250size varies a lot. A font that is otherwise fine for terminal use might
251contain some characters that are simply too wide. Rxvt-unicode will avoid
252these characters. For characters that are just "a bit" too wide a special
253"careful" rendering mode is used that redraws adjacent characters.
254
255All of this requires that fonts do not lie about character sizes,
256however: Xft fonts often draw glyphs larger than their acclaimed bounding
257box, and rxvt-unicode has no way of detecting this (the correct way is to
258ask for the character bounding box, which unfortunately is wrong in these
259cases). 1008locales).
260 1009
261It's not clear (to me at least), wether this is a bug in Xft, freetype, 1010Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
262or the respective font. If you encounter this problem you might try using 1011programs doing the same (that is, most) will automatically agree in the
263the C<-lsp> option to give the font more height. If that doesn't work, you 1012interpretation of characters.
264might be forced to use a different font.
265 1013
266All of this is not a problem when using X11 core fonts, as their bounding 1014Unfortunately, there is no system-independent way to select locales, nor
267box data is correct. 1015is there a standard on how locale specifiers will look like.
268 1016
269=item On Solaris 9, many line-drawing characters are too wide. 1017On most systems, the content of the C<LC_CTYPE> environment variable
1018contains an arbitrary string which corresponds to an already-installed
1019locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1020C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1021(i.e. C<de> or C<german>) are also common.
270 1022
271Seems to be a known bug, read 1023Rxvt-unicode ignores all other locale categories, and except for
272L<http://nixdoc.net/files/forum/about34198.html>. Some people use the 1024the encoding, ignores country or language-specific settings,
273following ugly workaround to get non-double-wide-characters working: 1025i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
1026rxvt-unicode.
274 1027
275 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x) 1028If you want to use a specific encoding you have to make sure you start
1029rxvt-unicode with the correct C<LC_CTYPE> category.
276 1030
277=item My Compose (Multi_key) key is no longer working. 1031=head3 Can I switch locales at runtime?
278 1032
279The most common causes for this are that either your locale is not set 1033Yes, using an escape sequence. Try something like this, which sets
280correctly, or you specified a B<preeditStyle> that is not supported by 1034rxvt-unicode's idea of C<LC_CTYPE>.
281your input method. For example, if you specified B<OverTheSpot> and
282your input method (e.g. the default input method handling Compose keys)
283does not support this (for instance because it is not visual), then
284rxvt-unicode will continue without an input method.
285 1035
286In this case either do not specify a B<preeditStyle> or specify more than 1036 printf '\33]701;%s\007' ja_JP.SJIS
287one pre-edit style, such as B<OverTheSpot,Root,None>.
288 1037
289=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755 1038See also the previous answer.
290 1039
291Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on 1040Sometimes this capability is rather handy when you want to work in
292international keyboards) or simply use ISO 14755 support to your 1041one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
293advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other 1042(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
294codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape 1043first switches to a locale supported by xjdic and back later:
295character and so on.
296 1044
297=item How can I keep rxvt-unicode from using reverse video so much? 1045 printf '\33]701;%s\007' ja_JP.SJIS
1046 xjdic -js
1047 printf '\33]701;%s\007' de_DE.UTF-8
298 1048
299First of all, make sure you are running with the right terminal settings 1049You can also use xterm's C<luit> program, which usually works fine, except
300(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then 1050for some locales where character width differs between program- and
301make sure you have specified colours for italic and bold, as otherwise 1051rxvt-unicode-locales.
302rxvt-unicode might use reverse video to simulate the effect:
303 1052
304 URxvt.colorBD: white 1053=head3 I have problems getting my input method working.
305 URxvt.colorIT: green
306 1054
307=item Some programs assume totally weird colours (red instead of blue), how can I fix that? 1055Try a search engine, as this is slightly different for every input method server.
308 1056
309For some unexplainable reason, some rare programs assume a very weird 1057Here is a checklist:
310colour palette when confronted with a terminal with more than the standard
3118 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
312these programs not to assume non-ISO colours without very good reasons.
313 1058
314In the meantime, you can either edit your C<rxvt-unicode> terminfo 1059=over 4
315definition to only claim 8 colour support or use C<TERM=rxvt>, which will
316fix colours but keep you from using other rxvt-unicode features.
317 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
1084=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
1085
1086You can specify separate locales for the input method and the rest of the
1087terminal, using the resource C<imlocale>:
1088
1089 URxvt.imlocale: ja_JP.EUC-JP
1090
1091Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
1092use your input method. Please note, however, that, depending on your Xlib
1093version, you may not be able to input characters outside C<EUC-JP> in a
1094normal way then, as your input method limits you.
1095
1096=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
1097
1098Unfortunately, this is unavoidable, as the XIM protocol is racy by
1099design. Applications can avoid some crashes at the expense of memory
1100leaks, and Input Methods can avoid some crashes by careful ordering at
1101exit time. B<kinput2> (and derived input methods) generally succeeds,
1102while B<SCIM> (or similar input methods) fails. In the end, however,
1103crashes cannot be completely avoided even if both sides cooperate.
1104
1105So the only workaround is not to kill your Input Method Servers.
1106
1107
1108=head2 Operating Systems / Package Maintaining
1109
1110=head3 I am using Debian GNU/Linux and have a problem...
1111
1112The Debian GNU/Linux package of rxvt-unicode in sarge contains large
1113patches that considerably change the behaviour of rxvt-unicode (but
1114unfortunately this notice has been removed). Before reporting a bug to
1115the original rxvt-unicode author please download and install the genuine
1116version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
1117the problem. If you cannot, chances are that the problems are specific to
1118Debian GNU/Linux, in which case it should be reported via the Debian Bug
1119Tracking System (use C<reportbug> to report the bug).
1120
1121For other problems that also affect the Debian package, you can and
1122probably should use the Debian BTS, too, because, after all, it's also a
1123bug in the Debian version and it serves as a reminder for other users that
1124might encounter the same issue.
1125
1126=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
1127
1128You should build one binary with the default options. F<configure>
1129now enables most useful options, and the trend goes to making them
1130runtime-switchable, too, so there is usually no drawback to enabling them,
1131except higher disk and possibly memory usage. The perl interpreter should
1132be enabled, as important functionality (menus, selection, likely more in
1133the future) depends on it.
1134
1135You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
1136system-wide (except maybe with C<defaults>). This will result in useful
1137behaviour. If your distribution aims at low memory, add an empty
1138C<perl-ext-common> resource to the app-defaults file. This will keep the
1139perl interpreter disabled until the user enables it.
1140
1141If you can/want build more binaries, I recommend building a minimal
1142one with C<--disable-everything> (very useful) and a maximal one with
1143C<--enable-everything> (less useful, it will be very big due to a lot of
1144encodings built-in that increase download times and are rarely used).
1145
1146=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
1147
1148It should be, starting with release 7.1. You are encouraged to properly
1149install urxvt with privileges necessary for your OS now.
1150
1151When rxvt-unicode detects that it runs setuid or setgid, it will fork
1152into a helper process for privileged operations (pty handling on some
1153systems, utmp/wtmp/lastlog handling on others) and drop privileges
1154immediately. This is much safer than most other terminals that keep
1155privileges while running (but is more relevant to urxvt, as it contains
1156things as perl interpreters, which might be "helpful" to attackers).
1157
1158This forking is done as the very first within main(), which is very early
1159and reduces possible bugs to initialisation code run before main(), or
1160things like the dynamic loader of your system, which should result in very
1161little risk.
1162
318=item 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.
319 1164
320Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1165Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
321in your compile environment, or an implementation that implements it, 1166in your compile environment, or an implementation that implements it,
322wether 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
323B<wchar_t> is represented as unicode. 1168B<wchar_t> is represented as unicode.
324 1169
325As you might have guessed, FreeBSD does neither define this symobl nor 1170As you might have guessed, FreeBSD does neither define this symbol nor
326does it support it. Instead, it uses it's own internal representation of 1171does it support it. Instead, it uses its own internal representation of
327B<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.
328 1173
329However, 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
330C<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>.
331 1176
345 1190
346The 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
347system 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
348complete replacements for them :) 1193complete replacements for them :)
349 1194
350=item I use Solaris 9 and it doesn't compile/work/etc.
351
352Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
353problems with C<wcwidth> and a compile problem.
354
355=item How can I use rxvt-unicode under cygwin? 1195=head3 How can I use rxvt-unicode under cygwin?
356 1196
357rxvt-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
358the X11 libraries that come with cygwin. libW11 emulation is no 1198the X11 libraries that come with cygwin. libW11 emulation is no
359longer supported (and makes no sense, either, as it only supported a 1199longer supported (and makes no sense, either, as it only supported a
360single font). I recommend starting the X-server in C<-multiwindow> or 1200single font). I recommend starting the X-server in C<-multiwindow> or
363 1203
364At 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
365encodings (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
366to 8-bit encodings. 1206to 8-bit encodings.
367 1207
368=item How does rxvt-unicode determine the encoding to use? 1208=head3 Character widths are not correct.
369 1209
370=item Is there an option to switch encodings? 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.
371 1215
372Unlike some other terminals, rxvt-unicode has no encoding switch, and no 1216The solution is to upgrade your system or switch to a better one. A
373specific "utf-8" mode, such as xterm. In fact, it doesn't even know about 1217possibly working workaround is to use a wcwidth implementation like
374UTF-8 or any other encodings with respect to terminal I/O.
375 1218
376The reasons is that there exists a perfectly fine mechanism for selecting 1219http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
377the encoding, doing I/O and (most important) communicating this to all
378applications so everybody agrees on character properties such as width
379and code number. This mechanism is the I<locale>. Applications not using
380that info will have problems (for example, C<xterm> gets the width of
381characters wrong as it uses it's own, locale-independent table under all
382locales).
383 1220
384Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
385programs doing the same (that is, most) will automatically agree in the
386interpretation of characters.
387
388Unfortunately, there is no system-independent way to select locales, nor
389is there a standard on how locale specifiers will look like.
390
391On most systems, the content of the C<LC_CTYPE> environment variable
392contains an arbitrary string which corresponds to an already-installed
393locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
394C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
395(i.e. C<de> or C<german>) are also common.
396
397Rxvt-unicode ignores all other locale categories, and except for
398the encoding, ignores country or language-specific settings,
399i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
400rxvt-unicode.
401
402If you want to use a specific encoding you have to make sure you start
403rxvt-unicode with the correct C<LC_CTYPE> category.
404
405=item Can I switch locales at runtime?
406
407Yes, using an escape sequence. Try something like this, which sets
408rxvt-unicode's idea of C<LC_CTYPE>.
409
410 printf '\e]701;%s\007' ja_JP.SJIS
411
412See also the previous answer.
413
414Sometimes this capability is rather handy when you want to work in
415one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
416(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
417first switches to a locale supported by xjdic and back later:
418
419 printf '\e]701;%s\007' ja_JP.SJIS
420 xjdic -js
421 printf '\e]701;%s\007' de_DE.UTF-8
422
423You can also use xterm's C<luit> program, which usually works fine, except
424for some locales where character width differs between program- and
425rxvt-unicode-locales.
426
427=item Can I switch the fonts at runtime?
428
429Yes, using an escape sequence. Try something like this, which has the same
430effect as using the C<-fn> switch, and takes effect immediately:
431
432 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
433
434This is useful if you e.g. work primarily with japanese (and prefer a
435japanese font), but you have to switch to chinese temporarily, where
436japanese fonts would only be in your way.
437
438You can think of this as a kind of manual ISO-2022 switching.
439
440=item Why do italic characters look as if clipped?
441
442Many fonts have difficulties with italic characters and hinting. For
443example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
444Mono> completely fails in it's italic face. A workaround might be to
445enable freetype autohinting, i.e. like this:
446
447 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
448 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
449
450=item My input method wants <some encoding> but I want UTF-8, what can I do?
451
452You can specify separate locales for the input method and the rest of the
453terminal, using the resource C<imlocale>:
454
455 URxvt*imlocale: ja_JP.EUC-JP
456
457Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
458use your input method. Please note, however, that you will not be able to
459input characters outside C<EUC-JP> in a normal way then, as your input
460method limits you.
461
462=item Rxvt-unicode crashes when the X Input Method changes or exits.
463
464Unfortunately, this is unavoidable, as the XIM protocol is racy by
465design. Applications can avoid some crashes at the expense of memory
466leaks, and Input Methods can avoid some crashes by careful ordering at
467exit time. B<kinput2> (and derived input methods) generally succeeds,
468while B<SCIM> (or similar input methods) fails. In the end, however,
469crashes cannot be completely avoided even if both sides cooperate.
470
471So the only workaround is not to kill your Input Method Servers.
472
473=item Rxvt-unicode uses gobs of memory, how can I reduce that?
474
475Rxvt-unicode tries to obey the rule of not charging you for something you
476don't use. One thing you should try is to configure out all settings that
477you don't need, for example, Xft support is a resource hog by design,
478when used. Compiling it out ensures that no Xft font will be loaded
479accidentally when rxvt-unicode tries to find a font for your characters.
480
481Also, many people (me included) like large windows and even larger
482scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
4836 bytes per screen cell. For a 160x?? window this amounts to almost a
484kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
485use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
486rxvt-unicode then uses 8 bytes per screen cell.
487
488=item Can I speed up Xft rendering somehow?
489
490Yes, the most obvious way to speed it up is to avoid Xft entirely, as
491it is simply slow. If you still want Xft fonts you might try to disable
492antialiasing (by appending C<:antialias=false>), which saves lots of
493memory and also speeds up rendering considerably.
494
495=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
496
497Rxvt-unicode will use whatever you specify as a font. If it needs to
498fall back to it's default font search list it will prefer X11 core
499fonts, because they are small and fast, and then use Xft fonts. It has
500antialiasing disabled for most of them, because the author thinks they
501look best that way.
502
503If you want antialiasing, you have to specify the fonts manually.
504
505=item Mouse cut/paste suddenly no longer works.
506
507Make sure that mouse reporting is actually turned off since killing
508some editors prematurely may leave the mouse in mouse report mode. I've
509heard that tcsh may use mouse reporting unless it otherwise specified. A
510quick check is to see if cut/paste works when the Alt or Shift keys are
511depressed. See @@RXVT_NAME@@(7)
512
513=item What's with this bold/blink stuff?
514
515If no bold colour is set via C<colorBD:>, bold will invert text using the
516standard foreground colour.
517
518For the standard background colour, blinking will actually make the
519text blink when compiled with C<--enable-blinking>. with standard
520colours. Without C<--enable-blinking>, the blink attribute will be
521ignored.
522
523On ANSI colours, bold/blink attributes are used to set high-intensity
524foreground/background colors.
525
526color0-7 are the low-intensity colors.
527
528color8-15 are the corresponding high-intensity colors.
529
530=item I don't like the screen colors. How do I change them?
531
532You can change the screen colors at run-time using F<~/.Xdefaults>
533resources (or as long-options).
534
535Here are values that are supposed to resemble a VGA screen,
536including the murky brown that passes for low-intensity yellow:
537
538 URxvt.color0: #000000
539 URxvt.color1: #A80000
540 URxvt.color2: #00A800
541 URxvt.color3: #A8A800
542 URxvt.color4: #0000A8
543 URxvt.color5: #A800A8
544 URxvt.color6: #00A8A8
545 URxvt.color7: #A8A8A8
546
547 URxvt.color8: #000054
548 URxvt.color9: #FF0054
549 URxvt.color10: #00FF54
550 URxvt.color11: #FFFF54
551 URxvt.color12: #0000FF
552 URxvt.color13: #FF00FF
553 URxvt.color14: #00FFFF
554 URxvt.color15: #FFFFFF
555
556And here is a more complete set of non-standard colors described (not by
557me) as "pretty girly".
558
559 URxvt.cursorColor: #dc74d1
560 URxvt.pointerColor: #dc74d1
561 URxvt.background: #0e0e0e
562 URxvt.foreground: #4ad5e1
563 URxvt.color0: #000000
564 URxvt.color8: #8b8f93
565 URxvt.color1: #dc74d1
566 URxvt.color9: #dc74d1
567 URxvt.color2: #0eb8c7
568 URxvt.color10: #0eb8c7
569 URxvt.color3: #dfe37e
570 URxvt.color11: #dfe37e
571 URxvt.color5: #9e88f0
572 URxvt.color13: #9e88f0
573 URxvt.color6: #73f7ff
574 URxvt.color14: #73f7ff
575 URxvt.color7: #e1dddd
576 URxvt.color15: #e1dddd
577
578=item How can I start @@RXVT_NAME@@d in a race-free way?
579
580Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
581display, create the listening socket and then fork.
582
583=item What's with the strange Backspace/Delete key behaviour?
584
585Assuming that the physical Backspace key corresponds to the
586BackSpace keysym (not likely for Linux ... see the following
587question) there are two standard values that can be used for
588Backspace: C<^H> and C<^?>.
589
590Historically, either value is correct, but rxvt-unicode adopts the debian
591policy of using C<^?> when unsure, because it's the one only only correct
592choice :).
593
594Rxvt-unicode tries to inherit the current stty settings and uses the value
595of `erase' to guess the value for backspace. If rxvt-unicode wasn't
596started from a terminal (say, from a menu or by remote shell), then the
597system value of `erase', which corresponds to CERASE in <termios.h>, will
598be used (which may not be the same as your stty setting).
599
600For starting a new rxvt-unicode:
601
602 # use Backspace = ^H
603 $ stty erase ^H
604 $ @@RXVT_NAME@@
605
606 # use Backspace = ^?
607 $ stty erase ^?
608 $ @@RXVT_NAME@@
609
610Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).
611
612For an existing rxvt-unicode:
613
614 # use Backspace = ^H
615 $ stty erase ^H
616 $ echo -n "^[[36h"
617
618 # use Backspace = ^?
619 $ stty erase ^?
620 $ echo -n "^[[36l"
621
622This helps satisfy some of the Backspace discrepancies that occur, but
623if you use Backspace = C<^H>, make sure that the termcap/terminfo value
624properly reflects that.
625
626The Delete key is a another casualty of the ill-defined Backspace problem.
627To avoid confusion between the Backspace and Delete keys, the Delete
628key has been assigned an escape sequence to match the vt100 for Execute
629(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
630
631Some other Backspace problems:
632
633some editors use termcap/terminfo,
634some editors (vim I'm told) expect Backspace = ^H,
635GNU Emacs (and Emacs-like editors) use ^H for help.
636
637Perhaps someday this will all be resolved in a consistent manner.
638
639=item I don't like the key-bindings. How do I change them?
640
641There are some compile-time selections available via configure. Unless
642you have run "configure" with the C<--disable-resources> option you can
643use the `keysym' resource to alter the keystrings associated with keysyms.
644
645Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
646
647 URxvt.keysym.Home: \033[1~
648 URxvt.keysym.End: \033[4~
649 URxvt.keysym.C-apostrophe: \033<C-'>
650 URxvt.keysym.C-slash: \033<C-/>
651 URxvt.keysym.C-semicolon: \033<C-;>
652 URxvt.keysym.C-grave: \033<C-`>
653 URxvt.keysym.C-comma: \033<C-,>
654 URxvt.keysym.C-period: \033<C-.>
655 URxvt.keysym.C-0x60: \033<C-`>
656 URxvt.keysym.C-Tab: \033<C-Tab>
657 URxvt.keysym.C-Return: \033<C-Return>
658 URxvt.keysym.S-Return: \033<S-Return>
659 URxvt.keysym.S-space: \033<S-Space>
660 URxvt.keysym.M-Up: \033<M-Up>
661 URxvt.keysym.M-Down: \033<M-Down>
662 URxvt.keysym.M-Left: \033<M-Left>
663 URxvt.keysym.M-Right: \033<M-Right>
664 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
665 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
666 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
667
668See some more examples in the documentation for the B<keysym> resource.
669
670=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
671How do I make use of them? For example, the Sun Keyboard type 4
672has the following mappings that rxvt-unicode doesn't recognize.
673
674 KP_Insert == Insert
675 F22 == Print
676 F27 == Home
677 F29 == Prior
678 F33 == End
679 F35 == Next
680
681Rather than have rxvt-unicode try to accommodate all the various possible
682keyboard mappings, it is better to use `xmodmap' to remap the keys as
683required for your particular machine.
684
685=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
686I need this to decide about setting colors etc.
687
688rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
689check and see if that is set. Note that several programs, JED, slrn,
690Midnight Commander automatically check this variable to decide whether or
691not to use color.
692
693=item How do I set the correct, full IP address for the DISPLAY variable?
694
695If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
696insecure mode then it is possible to use the following shell script
697snippets to correctly set the display. If your version of rxvt-unicode
698wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
699the COLORTERM variable can be used to distinguish rxvt-unicode from a
700regular xterm.
701
702Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
703snippets:
704
705 # Bourne/Korn/POSIX family of shells:
706 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
707 if [ ${TERM:-foo} = xterm ]; then
708 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
709 echo -n '^[Z'
710 read term_id
711 stty icanon echo
712 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
713 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
714 read DISPLAY # set it in our local shell
715 fi
716 fi
717
718=item How do I compile the manual pages for myself?
719
720You need to have a recent version of perl installed as F</usr/bin/perl>,
721one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
722the doc subdirectory and enter C<make alldoc>.
723
724=item My question isn't answered here, can I ask a human?
725
726Before sending me mail, you could go to IRC: C<irc.freenode.net>,
727channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
728interested in learning about new and exciting problems (but not FAQs :).
729
730=back
731
732=head1 RXVT TECHNICAL REFERENCE 1221=head1 RXVT-UNICODE TECHNICAL REFERENCE
733
734=head1 DESCRIPTION
735 1222
736The rest of this document describes various technical aspects of 1223The rest of this document describes various technical aspects of
737B<rxvt-unicode>. First the description of supported command sequences, 1224B<rxvt-unicode>. First the description of supported command sequences,
738followed by menu and pixmap support and last by a description of all 1225followed by pixmap support and last by a description of all features
739features selectable at C<configure> time. 1226selectable at C<configure> time.
740 1227
741=head1 Definitions 1228=head2 Definitions
742 1229
743=over 4 1230=over 4
744 1231
745=item B<< C<c> >> 1232=item B<< C<c> >>
746 1233
764 1251
765A text parameter composed of printable characters. 1252A text parameter composed of printable characters.
766 1253
767=back 1254=back
768 1255
769=head1 Values 1256=head2 Values
770 1257
771=over 4 1258=over 4
772 1259
773=item B<< C<ENQ> >> 1260=item B<< C<ENQ> >>
774 1261
817 1304
818Space Character 1305Space Character
819 1306
820=back 1307=back
821 1308
822=head1 Escape Sequences 1309=head2 Escape Sequences
823 1310
824=over 4 1311=over 4
825 1312
826=item B<< C<ESC # 8> >> 1313=item B<< C<ESC # 8> >>
827 1314
925 1412
926=back 1413=back
927 1414
928X<CSI> 1415X<CSI>
929 1416
930=head1 CSI (Command Sequence Introducer) Sequences 1417=head2 CSI (Command Sequence Introducer) Sequences
931 1418
932=over 4 1419=over 4
933 1420
934=item B<< C<ESC [ Ps @> >> 1421=item B<< C<ESC [ Ps @> >>
935 1422
1205 1692
1206=back 1693=back
1207 1694
1208X<PrivateModes> 1695X<PrivateModes>
1209 1696
1210=head1 DEC Private Modes 1697=head2 DEC Private Modes
1211 1698
1212=over 4 1699=over 4
1213 1700
1214=item B<< C<ESC [ ? Pm h> >> 1701=item B<< C<ESC [ ? Pm h> >>
1215 1702
1231 1718
1232Toggle DEC Private Mode Values (rxvt extension). I<where> 1719Toggle DEC Private Mode Values (rxvt extension). I<where>
1233 1720
1234=over 4 1721=over 4
1235 1722
1236=item B<< C<Ps = 1> >> (DECCKM) 1723=item B<< C<Pm = 1> >> (DECCKM)
1237 1724
1238=begin table 1725=begin table
1239 1726
1240 B<< C<h> >> Application Cursor Keys 1727 B<< C<h> >> Application Cursor Keys
1241 B<< C<l> >> Normal Cursor Keys 1728 B<< C<l> >> Normal Cursor Keys
1242 1729
1243=end table 1730=end table
1244 1731
1245=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1732=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1246 1733
1247=begin table 1734=begin table
1248 1735
1249 B<< C<h> >> Enter VT52 mode 1736 B<< C<h> >> Enter VT52 mode
1250 B<< C<l> >> Enter VT52 mode 1737 B<< C<l> >> Enter VT52 mode
1251 1738
1252=end table 1739=end table
1253 1740
1254=item B<< C<Ps = 3> >> 1741=item B<< C<Pm = 3> >>
1255 1742
1256=begin table 1743=begin table
1257 1744
1258 B<< C<h> >> 132 Column Mode (DECCOLM) 1745 B<< C<h> >> 132 Column Mode (DECCOLM)
1259 B<< C<l> >> 80 Column Mode (DECCOLM) 1746 B<< C<l> >> 80 Column Mode (DECCOLM)
1260 1747
1261=end table 1748=end table
1262 1749
1263=item B<< C<Ps = 4> >> 1750=item B<< C<Pm = 4> >>
1264 1751
1265=begin table 1752=begin table
1266 1753
1267 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1754 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1268 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1755 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1269 1756
1270=end table 1757=end table
1271 1758
1272=item B<< C<Ps = 5> >> 1759=item B<< C<Pm = 5> >>
1273 1760
1274=begin table 1761=begin table
1275 1762
1276 B<< C<h> >> Reverse Video (DECSCNM) 1763 B<< C<h> >> Reverse Video (DECSCNM)
1277 B<< C<l> >> Normal Video (DECSCNM) 1764 B<< C<l> >> Normal Video (DECSCNM)
1278 1765
1279=end table 1766=end table
1280 1767
1281=item B<< C<Ps = 6> >> 1768=item B<< C<Pm = 6> >>
1282 1769
1283=begin table 1770=begin table
1284 1771
1285 B<< C<h> >> Origin Mode (DECOM) 1772 B<< C<h> >> Origin Mode (DECOM)
1286 B<< C<l> >> Normal Cursor Mode (DECOM) 1773 B<< C<l> >> Normal Cursor Mode (DECOM)
1287 1774
1288=end table 1775=end table
1289 1776
1290=item B<< C<Ps = 7> >> 1777=item B<< C<Pm = 7> >>
1291 1778
1292=begin table 1779=begin table
1293 1780
1294 B<< C<h> >> Wraparound Mode (DECAWM) 1781 B<< C<h> >> Wraparound Mode (DECAWM)
1295 B<< C<l> >> No Wraparound Mode (DECAWM) 1782 B<< C<l> >> No Wraparound Mode (DECAWM)
1296 1783
1297=end table 1784=end table
1298 1785
1299=item B<< C<Ps = 8> >> I<unimplemented> 1786=item B<< C<Pm = 8> >> I<unimplemented>
1300 1787
1301=begin table 1788=begin table
1302 1789
1303 B<< C<h> >> Auto-repeat Keys (DECARM) 1790 B<< C<h> >> Auto-repeat Keys (DECARM)
1304 B<< C<l> >> No Auto-repeat Keys (DECARM) 1791 B<< C<l> >> No Auto-repeat Keys (DECARM)
1305 1792
1306=end table 1793=end table
1307 1794
1308=item B<< C<Ps = 9> >> X10 XTerm 1795=item B<< C<Pm = 9> >> X10 XTerm
1309 1796
1310=begin table 1797=begin table
1311 1798
1312 B<< C<h> >> Send Mouse X & Y on button press. 1799 B<< C<h> >> Send Mouse X & Y on button press.
1313 B<< C<l> >> No mouse reporting. 1800 B<< C<l> >> No mouse reporting.
1314 1801
1315=end table 1802=end table
1316 1803
1317=item B<< C<Ps = 10> >> (B<rxvt>)
1318
1319=begin table
1320
1321 B<< C<h> >> menuBar visible
1322 B<< C<l> >> menuBar invisible
1323
1324=end table
1325
1326=item B<< C<Ps = 25> >> 1804=item B<< C<Pm = 25> >>
1327 1805
1328=begin table 1806=begin table
1329 1807
1330 B<< C<h> >> Visible cursor {cnorm/cvvis} 1808 B<< C<h> >> Visible cursor {cnorm/cvvis}
1331 B<< C<l> >> Invisible cursor {civis} 1809 B<< C<l> >> Invisible cursor {civis}
1332 1810
1333=end table 1811=end table
1334 1812
1335=item B<< C<Ps = 30> >> 1813=item B<< C<Pm = 30> >>
1336 1814
1337=begin table 1815=begin table
1338 1816
1339 B<< C<h> >> scrollBar visisble 1817 B<< C<h> >> scrollBar visisble
1340 B<< C<l> >> scrollBar invisisble 1818 B<< C<l> >> scrollBar invisisble
1341 1819
1342=end table 1820=end table
1343 1821
1344=item B<< C<Ps = 35> >> (B<rxvt>) 1822=item B<< C<Pm = 35> >> (B<rxvt>)
1345 1823
1346=begin table 1824=begin table
1347 1825
1348 B<< C<h> >> Allow XTerm Shift+key sequences 1826 B<< C<h> >> Allow XTerm Shift+key sequences
1349 B<< C<l> >> Disallow XTerm Shift+key sequences 1827 B<< C<l> >> Disallow XTerm Shift+key sequences
1350 1828
1351=end table 1829=end table
1352 1830
1353=item B<< C<Ps = 38> >> I<unimplemented> 1831=item B<< C<Pm = 38> >> I<unimplemented>
1354 1832
1355Enter Tektronix Mode (DECTEK) 1833Enter Tektronix Mode (DECTEK)
1356 1834
1357=item B<< C<Ps = 40> >> 1835=item B<< C<Pm = 40> >>
1358 1836
1359=begin table 1837=begin table
1360 1838
1361 B<< C<h> >> Allow 80/132 Mode 1839 B<< C<h> >> Allow 80/132 Mode
1362 B<< C<l> >> Disallow 80/132 Mode 1840 B<< C<l> >> Disallow 80/132 Mode
1363 1841
1364=end table 1842=end table
1365 1843
1366=item B<< C<Ps = 44> >> I<unimplemented> 1844=item B<< C<Pm = 44> >> I<unimplemented>
1367 1845
1368=begin table 1846=begin table
1369 1847
1370 B<< C<h> >> Turn On Margin Bell 1848 B<< C<h> >> Turn On Margin Bell
1371 B<< C<l> >> Turn Off Margin Bell 1849 B<< C<l> >> Turn Off Margin Bell
1372 1850
1373=end table 1851=end table
1374 1852
1375=item B<< C<Ps = 45> >> I<unimplemented> 1853=item B<< C<Pm = 45> >> I<unimplemented>
1376 1854
1377=begin table 1855=begin table
1378 1856
1379 B<< C<h> >> Reverse-wraparound Mode 1857 B<< C<h> >> Reverse-wraparound Mode
1380 B<< C<l> >> No Reverse-wraparound Mode 1858 B<< C<l> >> No Reverse-wraparound Mode
1381 1859
1382=end table 1860=end table
1383 1861
1384=item B<< C<Ps = 46> >> I<unimplemented> 1862=item B<< C<Pm = 46> >> I<unimplemented>
1385 1863
1386=item B<< C<Ps = 47> >> 1864=item B<< C<Pm = 47> >>
1387 1865
1388=begin table 1866=begin table
1389 1867
1390 B<< C<h> >> Use Alternate Screen Buffer 1868 B<< C<h> >> Use Alternate Screen Buffer
1391 B<< C<l> >> Use Normal Screen Buffer 1869 B<< C<l> >> Use Normal Screen Buffer
1392 1870
1393=end table 1871=end table
1394 1872
1395X<Priv66> 1873X<Priv66>
1396 1874
1397=item B<< C<Ps = 66> >> 1875=item B<< C<Pm = 66> >>
1398 1876
1399=begin table 1877=begin table
1400 1878
1401 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1879 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1402 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1880 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1403 1881
1404=end table 1882=end table
1405 1883
1406=item B<< C<Ps = 67> >> 1884=item B<< C<Pm = 67> >>
1407 1885
1408=begin table 1886=begin table
1409 1887
1410 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1888 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1411 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1889 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1412 1890
1413=end table 1891=end table
1414 1892
1415=item B<< C<Ps = 1000> >> (X11 XTerm) 1893=item B<< C<Pm = 1000> >> (X11 XTerm)
1416 1894
1417=begin table 1895=begin table
1418 1896
1419 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.
1420 B<< C<l> >> No mouse reporting. 1898 B<< C<l> >> No mouse reporting.
1421 1899
1422=end table 1900=end table
1423 1901
1424=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1902=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1425 1903
1426=begin table 1904=begin table
1427 1905
1428 B<< C<h> >> Use Hilite Mouse Tracking. 1906 B<< C<h> >> Use Hilite Mouse Tracking.
1429 B<< C<l> >> No mouse reporting. 1907 B<< C<l> >> No mouse reporting.
1430 1908
1431=end table 1909=end table
1432 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
1433=item B<< C<Ps = 1010> >> (B<rxvt>) 1929=item B<< C<Pm = 1010> >> (B<rxvt>)
1434 1930
1435=begin table 1931=begin table
1436 1932
1437 B<< C<h> >> Don't scroll to bottom on TTY output 1933 B<< C<h> >> Don't scroll to bottom on TTY output
1438 B<< C<l> >> Scroll to bottom on TTY output 1934 B<< C<l> >> Scroll to bottom on TTY output
1439 1935
1440=end table 1936=end table
1441 1937
1442=item B<< C<Ps = 1011> >> (B<rxvt>) 1938=item B<< C<Pm = 1011> >> (B<rxvt>)
1443 1939
1444=begin table 1940=begin table
1445 1941
1446 B<< C<h> >> Scroll to bottom when a key is pressed 1942 B<< C<h> >> Scroll to bottom when a key is pressed
1447 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
1448 1944
1449=end table 1945=end table
1450 1946
1947=item B<< C<Pm = 1021> >> (B<rxvt>)
1948
1949=begin table
1950
1951 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1952 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1953
1954=end table
1955
1451=item B<< C<Ps = 1047> >> 1956=item B<< C<Pm = 1047> >>
1452 1957
1453=begin table 1958=begin table
1454 1959
1455 B<< C<h> >> Use Alternate Screen Buffer 1960 B<< C<h> >> Use Alternate Screen Buffer
1456 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
1457 1962
1458=end table 1963=end table
1459 1964
1460=item B<< C<Ps = 1048> >> 1965=item B<< C<Pm = 1048> >>
1461 1966
1462=begin table 1967=begin table
1463 1968
1464 B<< C<h> >> Save cursor position 1969 B<< C<h> >> Save cursor position
1465 B<< C<l> >> Restore cursor position 1970 B<< C<l> >> Restore cursor position
1466 1971
1467=end table 1972=end table
1468 1973
1469=item B<< C<Ps = 1049> >> 1974=item B<< C<Pm = 1049> >>
1470 1975
1471=begin table 1976=begin table
1472 1977
1473 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
1474 B<< C<l> >> Use Normal Screen Buffer 1979 B<< C<l> >> Use Normal Screen Buffer
1479 1984
1480=back 1985=back
1481 1986
1482X<XTerm> 1987X<XTerm>
1483 1988
1484=head1 XTerm Operating System Commands 1989=head2 XTerm Operating System Commands
1485 1990
1486=over 4 1991=over 4
1487 1992
1488=item B<< C<ESC ] Ps;Pt ST> >> 1993=item B<< C<ESC ] Ps;Pt ST> >>
1489 1994
1501 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> >> B<(NB: may change in future)>
1502 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> >> B<(NB: may change in future)>
1503 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> >>
1504 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> >>
1505 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> >>
1506 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 2011 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1507 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 2012 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1508 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 2013 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
1509 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> >>.
1510 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>
1511 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> >>.
1512 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> >>
1513 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> >>
1514 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).
1515 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar). 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>.
1516 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> >>
1517 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). 2022 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
2023 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
2024 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1518 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 2025 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1519 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2026 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1520 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2027 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1521 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2028 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1522 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 2029 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1523 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 2030 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2031 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1524 2032
1525=end table 2033=end table
1526 2034
1527=back 2035=back
1528 2036
1529X<menuBar> 2037=head1 BACKGROUND IMAGE
1530 2038
1531=head1 menuBar
1532
1533B<< The exact syntax used is I<almost> solidified. >>
1534In the menus, B<DON'T> try to use menuBar commands that add or remove a
1535menuBar.
1536
1537Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1538omitted: use B<./> to specify a menu relative to the current menu.
1539
1540=head2 Overview of menuBar operation
1541
1542For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1543of C<Pt> can be used for a variety of tasks:
1544
1545At the top level is the current menuBar which is a member of a circular
1546linked-list of other such menuBars.
1547
1548The menuBar acts as a parent for the various drop-down menus, which in
1549turn, may have labels, separator lines, menuItems and subMenus.
1550
1551The menuItems are the useful bits: you can use them to mimic keyboard
1552input or even to send text or escape sequences back to rxvt.
1553
1554The menuBar syntax is intended to provide a simple yet robust method of
1555constructing and manipulating menus and navigating through the
1556menuBars.
1557
1558The first step is to use the tag B<< [menu:I<name>] >> which creates
1559the menuBar called I<name> and allows access. You may now or menus,
1560subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1561menuBar access as B<readonly> to prevent accidental corruption of the
1562menus. To re-access the current menuBar for alterations, use the tag
1563B<[menu]>, make the alterations and then use B<[done]>
1564
1565X<menuBarCommands>
1566
1567=head2 Commands
1568
1569=over 4
1570
1571=item B<< [menu:+I<name>] >>
1572
1573access the named menuBar for creation or alteration. If a new menuBar
1574is created, it is called I<name> (max of 15 chars) and the current
1575menuBar is pushed onto the stack
1576
1577=item B<[menu]>
1578
1579access the current menuBar for alteration
1580
1581=item B<< [title:+I<string>] >>
1582
1583set the current menuBar's title to I<string>, which may contain the
1584following format specifiers:
1585
1586 B<%n> rxvt name (as per the B<-name> command-line option)
1587 B<%v> rxvt version
1588 B<%%> literal B<%> character
1589
1590=item B<[done]>
1591
1592set menuBar access as B<readonly>.
1593End-of-file tag for B<< [read:+I<file>] >> operations.
1594
1595=item B<< [read:+I<file>] >>
1596
1597read menu commands directly from I<file> (extension ".menu" will be
1598appended if required.) Start reading at a line with B<[menu]> or B<<
1599[menu:+I<name> >> and continuing until B<[done]> is encountered.
1600
1601Blank and comment lines (starting with B<#>) are ignored. Actually,
1602since any invalid menu commands are also ignored, almost anything could
1603be construed as a comment line, but this may be tightened up in the
1604future ... so don't count on it!.
1605
1606=item B<< [read:+I<file>;+I<name>] >>
1607
1608The same as B<< [read:+I<file>] >>, but start reading at a line with
1609B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1610B<[done]> is encountered.
1611
1612=item B<[dump]>
1613
1614dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1615later rereading.
1616
1617=item B<[rm:name]>
1618
1619remove the named menuBar
1620
1621=item B<[rm] [rm:]>
1622
1623remove the current menuBar
1624
1625=item B<[rm*] [rm:*]>
1626
1627remove all menuBars
1628
1629=item B<[swap]>
1630
1631swap the top two menuBars
1632
1633=item B<[prev]>
1634
1635access the previous menuBar
1636
1637=item B<[next]>
1638
1639access the next menuBar
1640
1641=item B<[show]>
1642
1643Enable display of the menuBar
1644
1645=item B<[hide]>
1646
1647Disable display of the menuBar
1648
1649=item B<< [pixmap:+I<name>] >>
1650
1651=item B<< [pixmap:+I<name>;I<scaling>] >>
1652
1653(set the background pixmap globally
1654
1655B<< A Future implementation I<may> make this local to the menubar >>)
1656
1657=item B<< [:+I<command>:] >>
1658
1659ignore the menu readonly status and issue a I<command> to or a menu or
1660menuitem or change the ; a useful shortcut for setting the quick arrows
1661from a menuBar.
1662
1663=back
1664
1665X<menuBarAdd>
1666
1667=head2 Adding and accessing menus
1668
1669The following commands may also be B<+> prefixed.
1670
1671=over 4
1672
1673=item B</+>
1674
1675access menuBar top level
1676
1677=item B<./+>
1678
1679access current menu level
1680
1681=item B<../+>
1682
1683access parent menu (1 level up)
1684
1685=item B<../../>
1686
1687access parent menu (multiple levels up)
1688
1689=item B<< I</path/>menu >>
1690
1691add/access menu
1692
1693=item B<< I</path/>menu/* >>
1694
1695add/access menu and clear it if it exists
1696
1697=item B<< I</path/>{-} >>
1698
1699add separator
1700
1701=item B<< I</path/>{item} >>
1702
1703add B<item> as a label
1704
1705=item B<< I</path/>{item} action >>
1706
1707add/alter I<menuitem> with an associated I<action>
1708
1709=item B<< I</path/>{item}{right-text} >>
1710
1711add/alter I<menuitem> with B<right-text> as the right-justified text
1712and as the associated I<action>
1713
1714=item B<< I</path/>{item}{rtext} action >>
1715
1716add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1717the right-justified text.
1718
1719=back
1720
1721=over 4
1722
1723=item Special characters in I<action> must be backslash-escaped:
1724
1725B<\a \b \E \e \n \r \t \octal>
1726
1727=item or in control-character notation:
1728
1729B<^@, ^A .. ^Z .. ^_, ^?>
1730
1731=back
1732
1733To send a string starting with a B<NUL> (B<^@>) character to the
1734program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1735the first of which will be stripped off and the balance directed to the
1736program. Otherwise if I<action> begins with B<NUL> followed by
1737non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1738balance is sent back to rxvt.
1739
1740As a convenience for the many Emacs-type editors, I<action> may start
1741with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1742appended if missed from B<M-x> commands.
1743
1744As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1745quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1746
1747=over 4
1748
1749=item For example,
1750
1751B<M-xapropos> is equivalent to B<\Exapropos\r>
1752
1753=item and
1754
1755B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1756
1757=back
1758
1759The option B<< {I<right-rtext>} >> will be right-justified. In the
1760absence of a specified action, this text will be used as the I<action>
1761as well.
1762
1763=over 4
1764
1765=item For example,
1766
1767B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1768
1769=back
1770
1771The left label I<is> necessary, since it's used for matching, but
1772implicitly hiding the left label (by using same name for both left and
1773right labels), or explicitly hiding the left label (by preceeding it
1774with a dot), makes it possible to have right-justified text only.
1775
1776=over 4
1777
1778=item For example,
1779
1780B</File/{Open}{Open} Open-File-Action>
1781
1782=item or hiding it
1783
1784B</File/{.anylabel}{Open} Open-File-Action>
1785
1786=back
1787
1788X<menuBarRemove>
1789
1790=head2 Removing menus
1791
1792=over 4
1793
1794=item B<< -/*+ >>
1795
1796remove all menus from the menuBar, the same as B<[clear]>
1797
1798=item B<< -+I</path>menu+ >>
1799
1800remove menu
1801
1802=item B<< -+I</path>{item}+ >>
1803
1804remove item
1805
1806=item B<< -+I</path>{-} >>
1807
1808remove separator)
1809
1810=item B<-/path/menu/*>
1811
1812remove all items, separators and submenus from menu
1813
1814=back
1815
1816X<menuBarArrows>
1817
1818=head2 Quick Arrows
1819
1820The menus also provide a hook for I<quick arrows> to provide easier
1821user access. If nothing has been explicitly set, the default is to
1822emulate the curror keys. The syntax permits each arrow to be altered
1823individually or all four at once without re-entering their common
1824beginning/end text. For example, to explicitly associate cursor actions
1825with the arrows, any of the following forms could be used:
1826
1827=over 4
1828
1829=item B<< <r>+I<Right> >>
1830
1831=item B<< <l>+I<Left> >>
1832
1833=item B<< <u>+I<Up> >>
1834
1835=item B<< <d>+I<Down> >>
1836
1837Define actions for the respective arrow buttons
1838
1839=item B<< <b>+I<Begin> >>
1840
1841=item B<< <e>+I<End> >>
1842
1843Define common beginning/end parts for I<quick arrows> which used in
1844conjunction with the above <r> <l> <u> <d> constructs
1845
1846=back
1847
1848=over 4
1849
1850=item For example, define arrows individually,
1851
1852 <u>\E[A
1853
1854 <d>\E[B
1855
1856 <r>\E[C
1857
1858 <l>\E[D
1859
1860=item or all at once
1861
1862 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1863
1864=item or more compactly (factoring out common parts)
1865
1866 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1867
1868=back
1869
1870X<menuBarSummary>
1871
1872=head2 Command Summary
1873
1874A short summary of the most I<common> commands:
1875
1876=over 4
1877
1878=item [menu:name]
1879
1880use an existing named menuBar or start a new one
1881
1882=item [menu]
1883
1884use the current menuBar
1885
1886=item [title:string]
1887
1888set menuBar title
1889
1890=item [done]
1891
1892set menu access to readonly and, if reading from a file, signal EOF
1893
1894=item [done:name]
1895
1896if reading from a file using [read:file;name] signal EOF
1897
1898=item [rm:name]
1899
1900remove named menuBar(s)
1901
1902=item [rm] [rm:]
1903
1904remove current menuBar
1905
1906=item [rm*] [rm:*]
1907
1908remove all menuBar(s)
1909
1910=item [swap]
1911
1912swap top two menuBars
1913
1914=item [prev]
1915
1916access the previous menuBar
1917
1918=item [next]
1919
1920access the next menuBar
1921
1922=item [show]
1923
1924map menuBar
1925
1926=item [hide]
1927
1928unmap menuBar
1929
1930=item [pixmap;file]
1931
1932=item [pixmap;file;scaling]
1933
1934set a background pixmap
1935
1936=item [read:file]
1937
1938=item [read:file;name]
1939
1940read in a menu from a file
1941
1942=item [dump]
1943
1944dump out all menuBars to /tmp/rxvt-PID
1945
1946=item /
1947
1948access menuBar top level
1949
1950=item ./
1951
1952=item ../
1953
1954=item ../../
1955
1956access current or parent menu level
1957
1958=item /path/menu
1959
1960add/access menu
1961
1962=item /path/{-}
1963
1964add separator
1965
1966=item /path/{item}{rtext} action
1967
1968add/alter menu item
1969
1970=item -/*
1971
1972remove all menus from the menuBar
1973
1974=item -/path/menu
1975
1976remove menu items, separators and submenus from menu
1977
1978=item -/path/menu
1979
1980remove menu
1981
1982=item -/path/{item}
1983
1984remove item
1985
1986=item -/path/{-}
1987
1988remove separator
1989
1990=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1991
1992menu quick arrows
1993
1994=back
1995X<XPM>
1996
1997=head1 XPM
1998
1999For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2039For the BACGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
2000of 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
2001sequence of scaling/positioning commands separated by semi-colons. The 2041sequence of scaling/positioning commands separated by semi-colons. The
2002scaling/positioning commands are as follows: 2042scaling/positioning commands are as follows:
2003 2043
2004=over 4 2044=over 4
2005 2045
2043 2083
2044For example: 2084For example:
2045 2085
2046=over 4 2086=over 4
2047 2087
2048=item B<\E]20;funky\a> 2088=item B<\E]20;funky.jpg\a>
2049 2089
2050load B<funky.xpm> as a tiled image 2090load B<funky.jpg> as a tiled image
2051 2091
2052=item B<\E]20;mona;100\a> 2092=item B<\E]20;mona.jpg;100\a>
2053 2093
2054load B<mona.xpm> with a scaling of 100% 2094load B<mona.jpg> with a scaling of 100%
2055 2095
2056=item B<\E]20;;200;?\a> 2096=item B<\E]20;;200;?\a>
2057 2097
2058rescale the current pixmap to 200% and display the image geometry in 2098rescale the current pixmap to 200% and display the image geometry in
2059the title 2099the title
2098=begin table 2138=begin table
2099 2139
2100 4 Shift 2140 4 Shift
2101 8 Meta 2141 8 Meta
2102 16 Control 2142 16 Control
2103 32 Double Click I<(Rxvt extension)> 2143 32 Double Click I<(rxvt extension)>
2104 2144
2105=end table 2145=end table
2106 2146
2107Col = B<< C<< <x> - SPACE >> >> 2147Col = B<< C<< <x> - SPACE >> >>
2108 2148
2185=end table 2225=end table
2186 2226
2187=head1 CONFIGURE OPTIONS 2227=head1 CONFIGURE OPTIONS
2188 2228
2189General hint: if you get compile errors, then likely your configuration 2229General hint: if you get compile errors, then likely your configuration
2190hasn't been tested well. Either try with --enable-everything or use the 2230hasn't been tested well. Either try with C<--enable-everything> or use
2191./reconf script as a base for experiments. ./reconf is used by myself, 2231the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2192so it should generally be a working config. Of course, you should always 2232switches). Of course, you should always report when a combination doesn't
2193report when a combination doesn't work, so it can be fixed. Marc Lehmann 2233work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2194<rxvt@schmorp.de>. 2234
2235All
2195 2236
2196=over 4 2237=over 4
2197 2238
2198=item --enable-everything 2239=item --enable-everything
2199 2240
2200Add support for all non-multichoice options listed in "./configure 2241Add (or remove) support for all non-multichoice options listed in "./configure
2201--help". Note that unlike other enable options this is order dependant. 2242--help".
2243
2202You can specify this and then disable options which this enables by 2244You can specify this and then disable options you do not like by
2203I<following> this with the appropriate commands. 2245I<following> this with the appropriate C<--disable-...> arguments,
2246or you can start with a minimal configuration by specifying
2247C<--disable-everything> and than adding just the C<--enable-...> arguments
2248you want.
2204 2249
2205=item --enable-xft 2250=item --enable-xft (default: enabled)
2206 2251
2207Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2252Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2208slower and require lots of memory, but as long as you don't use them, you 2253slower and require lots of memory, but as long as you don't use them, you
2209don't pay for them. 2254don't pay for them.
2210 2255
2211=item --enable-font-styles 2256=item --enable-font-styles (default: on)
2212 2257
2213Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2258Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2214styles. The fonts can be set manually or automatically. 2259styles. The fonts can be set manually or automatically.
2215 2260
2216=item --with-codesets=NAME,... 2261=item --with-codesets=NAME,... (default: all)
2217 2262
2218Compile in support for additional codeset (encoding) groups (C<eu>, C<vn> 2263Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2219are always compiled in, which includes most 8-bit character sets). These 2264are always compiled in, which includes most 8-bit character sets). These
2220codeset tables are used for driving X11 core fonts, they are not required 2265codeset tables are used for driving X11 core fonts, they are not required
2221for Xft fonts, although having them compiled in lets rxvt-unicode choose 2266for Xft fonts, although having them compiled in lets rxvt-unicode choose
2225 2270
2226=begin table 2271=begin table
2227 2272
2228 all all available codeset groups 2273 all all available codeset groups
2229 zh common chinese encodings 2274 zh common chinese encodings
2230 zh_ext rarely used but very big chinese encodigs 2275 zh_ext rarely used but very big chinese encodings
2231 jp common japanese encodings 2276 jp common japanese encodings
2232 jp_ext rarely used but big japanese encodings 2277 jp_ext rarely used but big japanese encodings
2233 kr korean encodings 2278 kr korean encodings
2234 2279
2235=end table 2280=end table
2236 2281
2237=item --enable-xim 2282=item --enable-xim (default: on)
2238 2283
2239Add support for XIM (X Input Method) protocol. This allows using 2284Add support for XIM (X Input Method) protocol. This allows using
2240alternative input methods (e.g. kinput2) and will also correctly 2285alternative input methods (e.g. kinput2) and will also correctly
2241set up the input for people using dead keys or compose keys. 2286set up the input for people using dead keys or compose keys.
2242 2287
2243=item --enable-unicode3 2288=item --enable-unicode3 (default: off)
2289
2290Recommended to stay off unless you really need non-BMP characters.
2244 2291
2245Enable direct support for displaying unicode codepoints above 2292Enable direct support for displaying unicode codepoints above
224665535 (the basic multilingual page). This increases storage 229365535 (the basic multilingual page). This increases storage
2247requirements 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
2248support these extra characters, but Xft does. 2295support these extra characters, but Xft does.
2249 2296
2250Please note that rxvt-unicode can store unicode code points >65535 2297Please note that rxvt-unicode can store unicode code points >65535
2251even without this flag, but the number of such characters is 2298even without this flag, but the number of such characters is
2252limited to a view thousand (shared with combining characters, 2299limited to a few thousand (shared with combining characters,
2253see next switch), and right now rxvt-unicode cannot display them 2300see next switch), and right now rxvt-unicode cannot display them
2254(input/output and cut&paste still work, though). 2301(input/output and cut&paste still work, though).
2255 2302
2256=item --enable-combining 2303=item --enable-combining (default: on)
2257 2304
2258Enable automatic composition of combining characters into 2305Enable automatic composition of combining characters into
2259composite characters. This is required for proper viewing of text 2306composite characters. This is required for proper viewing of text
2260where accents are encoded as seperate unicode characters. This is 2307where accents are encoded as seperate unicode characters. This is
2261done by using precomposited characters when available or creating 2308done by using precomposited characters when available or creating
2262new pseudo-characters when no precomposed form exists. 2309new pseudo-characters when no precomposed form exists.
2263 2310
2264Without --enable-unicode3, the number of additional precomposed characters 2311Without --enable-unicode3, the number of additional precomposed
2265is rather limited (2048, if this is full, rxvt-unicode will use the 2312characters is somewhat limited (the 6400 private use characters will be
2266private use area, extending the number of combinations to 8448). With
2267--enable-unicode3, no practical limit exists. 2313(ab-)used). With --enable-unicode3, no practical limit exists.
2268 2314
2269This option will also enable storage (but not display) of characters 2315This option will also enable storage (but not display) of characters
2270beyond plane 0 (>65535) when --enable-unicode3 was not specified. 2316beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2271 2317
2272The combining table also contains entries for arabic presentation forms, 2318The combining table also contains entries for arabic presentation forms,
2273but these are not currently used. Bug me if you want these to be used (and 2319but these are not currently used. Bug me if you want these to be used (and
2274tell me how these are to be used...). 2320tell me how these are to be used...).
2275 2321
2276=item --enable-fallback(=CLASS) 2322=item --enable-fallback(=CLASS) (default: Rxvt)
2277 2323
2278When reading resource settings, also read settings for class CLASS 2324When reading resource settings, also read settings for class CLASS. To
2279(default: Rxvt). To disable resource fallback use --disable-fallback. 2325disable resource fallback use --disable-fallback.
2280 2326
2281=item --with-res-name=NAME 2327=item --with-res-name=NAME (default: urxvt)
2282 2328
2283Use the given name (default: urxvt) as default application name when 2329Use the given name as default application name when
2284reading resources. Specify --with-res-name=rxvt to replace rxvt. 2330reading resources. Specify --with-res-name=rxvt to replace rxvt.
2285 2331
2286=item --with-res-class=CLASS 2332=item --with-res-class=CLASS (default: URxvt)
2287 2333
2288Use the given class (default: URxvt) as default application class 2334Use the given class as default application class
2289when reading resources. Specify --with-res-class=Rxvt to replace 2335when reading resources. Specify --with-res-class=Rxvt to replace
2290rxvt. 2336rxvt.
2291 2337
2292=item --enable-utmp 2338=item --enable-utmp (default: on)
2293 2339
2294Write user and tty to utmp file (used by programs like F<w>) at 2340Write user and tty to utmp file (used by programs like F<w>) at
2295start of rxvt execution and delete information when rxvt exits. 2341start of rxvt execution and delete information when rxvt exits.
2296 2342
2297=item --enable-wtmp 2343=item --enable-wtmp (default: on)
2298 2344
2299Write user and tty to wtmp file (used by programs like F<last>) at 2345Write user and tty to wtmp file (used by programs like F<last>) at
2300start of rxvt execution and write logout when rxvt exits. This 2346start of rxvt execution and write logout when rxvt exits. This
2301option requires --enable-utmp to also be specified. 2347option requires --enable-utmp to also be specified.
2302 2348
2303=item --enable-lastlog 2349=item --enable-lastlog (default: on)
2304 2350
2305Write user and tty to lastlog file (used by programs like 2351Write user and tty to lastlog file (used by programs like
2306F<lastlogin>) at start of rxvt execution. This option requires 2352F<lastlogin>) at start of rxvt execution. This option requires
2307--enable-utmp to also be specified. 2353--enable-utmp to also be specified.
2308 2354
2309=item --enable-xpm-background 2355=item --enable-afterimage (default: on)
2310 2356
2311Add 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>).
2312 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.
2369
2313=item --enable-transparency 2370=item --enable-transparency (default: on)
2314 2371
2315Add support for inheriting parent backgrounds thus giving a fake 2372Add support for backgrounds, creating illusion of transparency in the term.
2316transparency to the term.
2317 2373
2318=item --enable-fading 2374=item --enable-fading (default: on)
2319 2375
2320Add support for fading the text when focus is lost. 2376Add support for fading the text when focus is lost.
2321 2377
2322=item --enable-tinting
2323
2324Add support for tinting of transparent backgrounds.
2325
2326=item --enable-menubar
2327
2328Add support for our menu bar system (this interacts badly with
2329dynamic locale switching currently).
2330
2331=item --enable-rxvt-scroll 2378=item --enable-rxvt-scroll (default: on)
2332 2379
2333Add support for the original rxvt scrollbar. 2380Add support for the original rxvt scrollbar.
2334 2381
2335=item --enable-next-scroll 2382=item --enable-next-scroll (default: on)
2336 2383
2337Add support for a NeXT-like scrollbar. 2384Add support for a NeXT-like scrollbar.
2338 2385
2339=item --enable-xterm-scroll 2386=item --enable-xterm-scroll (default: on)
2340 2387
2341Add support for an Xterm-like scrollbar. 2388Add support for an Xterm-like scrollbar.
2342 2389
2343=item --enable-plain-scroll 2390=item --enable-plain-scroll (default: on)
2344 2391
2345Add support for a very unobtrusive, plain-looking scrollbar that 2392Add support for a very unobtrusive, plain-looking scrollbar that
2346is the favourite of the rxvt-unicode author, having used it for 2393is the favourite of the rxvt-unicode author, having used it for
2347many years. 2394many years.
2348 2395
2349=item --enable-half-shadow
2350
2351Make shadows on the scrollbar only half the normal width & height.
2352only applicable to rxvt scrollbars.
2353
2354=item --enable-ttygid
2355
2356Change tty device setting to group "tty" - only use this if
2357your system uses this type of security.
2358
2359=item --disable-backspace-key 2396=item --disable-backspace-key
2360 2397
2361Disable any handling of the backspace key by us - let the X server 2398Removes any handling of the backspace key by us - let the X server do it.
2399
2400=item --disable-delete-key
2401
2402Removes any handling of the delete key by us - let the X server
2362do it. 2403do it.
2363 2404
2364=item --disable-delete-key
2365
2366Disable any handling of the delete key by us - let the X server
2367do it.
2368
2369=item --disable-resources 2405=item --disable-resources
2370 2406
2371Remove all resources checking. 2407Removes any support for resource checking.
2372
2373=item --enable-xgetdefault
2374
2375Make resources checking via XGetDefault() instead of our small
2376version which only checks ~/.Xdefaults, or if that doesn't exist then
2377~/.Xresources.
2378
2379Please note that nowadays, things like XIM will automatically pull in and
2380use the full X resource manager, so the overhead of using it might be very
2381small, if nonexistant.
2382
2383=item --enable-strings
2384
2385Add support for our possibly faster memset() function and other
2386various routines, overriding your system's versions which may
2387have been hand-crafted in assembly or may require extra libraries
2388to link in. (this breaks ANSI-C rules and has problems on many
2389GNU/Linux systems).
2390 2408
2391=item --disable-swapscreen 2409=item --disable-swapscreen
2392 2410
2393Remove support for swap screen. 2411Remove support for secondary/swap screen.
2394 2412
2395=item --enable-frills 2413=item --enable-frills (default: on)
2396 2414
2397Add support for many small features that are not essential but nice to 2415Add support for many small features that are not essential but nice to
2398have. Normally you want this, but for very small binaries you may want to 2416have. Normally you want this, but for very small binaries you may want to
2399disable this. 2417disable this.
2400 2418
2401A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2419A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2402in combination with other switches) is: 2420in combination with other switches) is:
2403 2421
2404 MWM-hints 2422 MWM-hints
2405 EWMH-hints (pid, utf8 names) and protocols (ping) 2423 EWMH-hints (pid, utf8 names) and protocols (ping)
2424 urgency hint
2406 seperate underline colour 2425 seperate underline colour (-underlineColor)
2407 settable border widths and borderless switch 2426 settable border widths and borderless switch (-w, -b, -bl)
2427 visual depth selection (-depth)
2408 settable extra linespacing 2428 settable extra linespacing /-lsp)
2409 iso-14755-2 and -3, and visual feedback 2429 iso-14755 5.1 (basic) support
2430 tripleclickwords (-tcw)
2431 settable insecure mode (-insecure)
2432 keysym remapping support
2433 cursor blinking and underline cursor (-cb, -uc)
2434 XEmbed support (-embed)
2435 user-pty (-pty-fd)
2436 hold on exit (-hold)
2437 compile in built-in block graphics
2438 skip builtin block graphics (-sbg)
2439 separate highlightcolor support (-hc)
2440
2441It also enables some non-essential features otherwise disabled, such as:
2442
2443 some round-trip time optimisations
2444 nearest color allocation on pseudocolor screens
2445 UTF8_STRING support for selection
2446 sgr modes 90..97 and 100..107
2410 backindex and forwardindex escape sequence 2447 backindex and forwardindex escape sequences
2448 view change/zero scrollback escape sequences
2449 locale switching escape sequence
2411 window op and some xterm/OSC escape sequences 2450 window op and some xterm/OSC escape sequences
2412 tripleclickwords 2451 rectangular selections
2413 settable insecure mode 2452 trailing space removal for selections
2414 keysym remapping support 2453 verbose X error handling
2415 cursor blinking and underline cursor
2416 -embed and -pty-fd options
2417 2454
2418=item --enable-iso14755 2455=item --enable-iso14755 (default: on)
2419 2456
2420Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2457Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2421F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2458F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2422C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2459C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2423this switch. 2460this switch.
2424 2461
2425=item --enable-keepscrolling 2462=item --enable-keepscrolling (default: on)
2426 2463
2427Add support for continual scrolling of the display when you hold 2464Add support for continual scrolling of the display when you hold
2428the mouse button down on a scrollbar arrow. 2465the mouse button down on a scrollbar arrow.
2429 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
2430=item --enable-mousewheel 2472=item --enable-mousewheel (default: on)
2431 2473
2432Add support for scrolling via mouse wheel or buttons 4 & 5. 2474Add support for scrolling via mouse wheel or buttons 4 & 5.
2433 2475
2434=item --enable-slipwheeling 2476=item --enable-slipwheeling (default: on)
2435 2477
2436Add support for continual scrolling (using the mouse wheel as an 2478Add support for continual scrolling (using the mouse wheel as an
2437accelerator) while the control key is held down. This option 2479accelerator) while the control key is held down. This option
2438requires --enable-mousewheel to also be specified. 2480requires --enable-mousewheel to also be specified.
2439 2481
2440=item --disable-new-selection
2441
2442Remove support for mouse selection style like that of xterm.
2443
2444=item --enable-dmalloc
2445
2446Use Gray Watson's malloc - which is good for debugging See
2447http://www.letters.com/dmalloc/ for details If you use either this or the
2448next option, you may need to edit src/Makefile after compiling to point
2449DINCLUDE and DLIB to the right places.
2450
2451You can only use either this option and the following (should
2452you use either) .
2453
2454=item --enable-dlmalloc
2455
2456Use Doug Lea's malloc - which is good for a production version
2457See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2458
2459=item --enable-smart-resize 2482=item --enable-smart-resize (default: off)
2460 2483
2461Add smart growth/shrink behaviour when changing font size via from hot 2484Add smart growth/shrink behaviour when resizing.
2462keys. This should keep in a fixed position the rxvt corner which is 2485This should keep the window corner which is closest to a corner of
2463closest to a corner of the screen. 2486the screen in a fixed position.
2464 2487
2488=item --enable-text-blink (default: on)
2489
2490Add support for blinking text.
2491
2465=item --enable-pointer-blank 2492=item --enable-pointer-blank (default: on)
2466 2493
2467Add support to have the pointer disappear when typing or inactive. 2494Add support to have the pointer disappear when typing or inactive.
2468 2495
2469=item --with-name=NAME 2496=item --enable-perl (default: on)
2470 2497
2498Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2499manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the
2500files in F<src/perl-ext/> for the extensions that are installed by
2501default. The perl interpreter that is used can be specified via the
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.
2510
2511=item --with-name=NAME (default: urxvt)
2512
2471Set the basename for the installed binaries (default: C<urxvt>, resulting 2513Set the basename for the installed binaries, resulting
2472in 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
2473C<rxvt>. 2515C<rxvt>.
2474 2516
2475=item --with-term=NAME 2517=item --with-term=NAME (default: rxvt-unicode)
2476 2518
2477Change the environmental variable for the terminal to NAME (default 2519Change the environmental variable for the terminal to NAME.
2478C<rxvt-unicode>)
2479 2520
2480=item --with-terminfo=PATH 2521=item --with-terminfo=PATH
2481 2522
2482Change the environmental variable for the path to the terminfo tree to 2523Change the environmental variable for the path to the terminfo tree to
2483PATH. 2524PATH.
2484 2525
2485=item --with-x 2526=item --with-x
2486 2527
2487Use the X Window System (pretty much default, eh?). 2528Use the X Window System (pretty much default, eh?).
2488
2489=item --with-xpm-includes=DIR
2490
2491Look for the XPM includes in DIR.
2492
2493=item --with-xpm-library=DIR
2494
2495Look for the XPM library in DIR.
2496
2497=item --with-xpm
2498
2499Not needed - define via --enable-xpm-background.
2500 2529
2501=back 2530=back
2502 2531
2503=head1 AUTHORS 2532=head1 AUTHORS
2504 2533

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines