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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines