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.49 by root, Fri Feb 18 12:15:07 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?
187
188=item How does rxvt-unicode choose fonts?
189
190Most fonts do not contain the full range of Unicode, which is
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
195B<rxvt-unicode> makes a best-effort try at finding a replacement
196font. Often the result is fine, but sometimes the chosen font looks
197bad/ugly/wrong. Some fonts have totally strange characters that don't
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
202In that case, select a font of your taste and add it to the font list,
203e.g.:
204
205 @@RXVT_NAME@@ -fn basefont,font2,font3...
206
207When rxvt-unicode sees a character, it will first look at the base
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).
254
255It's not clear (to me at least), wether this is a bug in Xft, freetype,
256or the respective font. If you encounter this problem you might try using
257the C<-lsp> option to give the font more height. If that doesn't work, you
258might be forced to use a different font.
259
260All of this is not a problem when using X11 core fonts, as their bounding
261box data is correct.
262
263=item My Compose (Multi_key) key is no longer working.
264
265The most common causes for this are that either your locale is not set
266correctly, or you specified a B<preeditStyle> that is not supported by
267your input method. For example, if you specified B<OverTheSpot> and
268your input method (e.g. the default input method handling Compose keys)
269does not support this (for instance because it is not visual), then
270rxvt-unicode will continue without an input method.
271
272In this case either do not specify a B<preeditStyle> or specify more than
273one pre-edit style, such as B<OverTheSpot,Root,None>.
274
275=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
276
277Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
278international keyboards) or simply use ISO 14755 support to your
279advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
280codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
281character and so on.
282
283=item How can I keep rxvt-unicode from using reverse video so much?
284
285First of all, make sure you are running with the right terminal settings
286(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
287make sure you have specified colours for italic and bold, as otherwise
288rxvt-unicode might use reverse video to simulate the effect:
289
290 URxvt.colorBD: white
291 URxvt.colorIT: green
292
293=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
294
295For some unexplainable reason, some rare programs assume a very weird
296colour palette when confronted with a terminal with more than the standard
2978 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
298these programs not to assume non-ISO colours without very good reasons.
299
300In the meantime, you can either edit your C<rxvt-unicode> terminfo
301definition to only claim 8 colour support or use C<TERM=rxvt>, which will
302fix colours but keep you from using other rxvt-unicode features.
303
304=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
305
306Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
307in your compile environment, or an implementation that implements it,
308wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
309B<wchar_t> is represented as unicode.
310
311As you might have guessed, FreeBSD does neither define this symobl nor
312does it support it. Instead, it uses it's own internal representation of
313B<wchar_t>. This is, of course, completely fine with respect to standards.
314
315However, C<__STDC_ISO_10646__> is the only sane way to support
316multi-language apps in an OS, as using a locale-dependent (and
317non-standardized) representation of B<wchar_t> makes it impossible to
318convert between B<wchar_t> (as used by X11 and your applications) and any
319other encoding without implementing OS-specific-wrappers for each and
320every locale. There simply are no APIs to convert B<wchar_t> into anything
321except the current locale encoding.
322
323Some applications (such as the formidable B<mlterm>) work around this
324by carrying their own replacement functions for character set handling
325with them, and either implementing OS-dependent hacks or doing multiple
326conversions (which is slow and unreliable in case the OS implements
327encodings slightly different than the terminal emulator).
328
329The rxvt-unicode author insists that the right way to fix this is in the
330system libraries once and for all, instead of forcing every app to carry
331complete replacements for them :)
332
333=item How does rxvt-unicode determine the encoding to use? 989=head3 How does rxvt-unicode determine the encoding to use?
334 990
991See next entry.
992
335=item Is there an option to switch encodings? 993=head3 Is there an option to switch encodings?
336 994
337Unlike some other terminals, rxvt-unicode has no encoding switch, and no 995Unlike some other terminals, rxvt-unicode has no encoding switch, and no
338specific "utf-8" mode, such as xterm. In fact, it doesn't even know about 996specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
339UTF-8 or any other encodings with respect to terminal I/O. 997UTF-8 or any other encodings with respect to terminal I/O.
340 998
341The reasons is that there exists a perfectly fine mechanism for selecting 999The reasons is that there exists a perfectly fine mechanism for selecting
342the encoding, doing I/O and (most important) communicating this to all 1000the encoding, doing I/O and (most important) communicating this to all
343applications so everybody agrees on character properties such as width 1001applications so everybody agrees on character properties such as width
344and code number. This mechanism is the I<locale>. Applications not using 1002and code number. This mechanism is the I<locale>. Applications not using
345that info will have problems (for example, C<xterm> gets the width of 1003that info will have problems (for example, C<xterm> gets the width of
346characters wrong as it uses it's own, locale-independent table under all 1004characters wrong as it uses its own, locale-independent table under all
347locales). 1005locales).
348 1006
349Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All 1007Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
350programs doing the same (that is, most) will automatically agree in the 1008programs doing the same (that is, most) will automatically agree in the
351interpretation of characters. 1009interpretation of characters.
365rxvt-unicode. 1023rxvt-unicode.
366 1024
367If you want to use a specific encoding you have to make sure you start 1025If you want to use a specific encoding you have to make sure you start
368rxvt-unicode with the correct C<LC_CTYPE> category. 1026rxvt-unicode with the correct C<LC_CTYPE> category.
369 1027
370=item Can I switch locales at runtime? 1028=head3 Can I switch locales at runtime?
371 1029
372Yes, using an escape sequence. Try something like this, which sets 1030Yes, using an escape sequence. Try something like this, which sets
373rxvt-unicode's idea of C<LC_CTYPE>. 1031rxvt-unicode's idea of C<LC_CTYPE>.
374 1032
375 printf '\e]701;%s\007' ja_JP.SJIS 1033 printf '\33]701;%s\007' ja_JP.SJIS
376 1034
377See also the previous answer. 1035See also the previous answer.
378 1036
379Sometimes this capability is rather handy when you want to work in 1037Sometimes this capability is rather handy when you want to work in
380one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it 1038one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
381(e.g. UTF-8). For example, I use this script to start C<xjdic>, which 1039(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
382first switches to a locale supported by xjdic and back later: 1040first switches to a locale supported by xjdic and back later:
383 1041
384 printf '\e]701;%s\007' ja_JP.SJIS 1042 printf '\33]701;%s\007' ja_JP.SJIS
385 xjdic -js 1043 xjdic -js
386 printf '\e]701;%s\007' de_DE.UTF-8 1044 printf '\33]701;%s\007' de_DE.UTF-8
387 1045
388You can also use xterm's C<luit> program, which usually works fine, except 1046You can also use xterm's C<luit> program, which usually works fine, except
389for some locales where character width differs between program- and 1047for some locales where character width differs between program- and
390rxvt-unicode-locales. 1048rxvt-unicode-locales.
391 1049
392=item Can I switch the fonts at runtime? 1050=head3 I have problems getting my input method working.
393 1051
394Yes, using an escape sequence. Try something like this, which has the same 1052Try a search engine, as this is slightly different for every input method server.
395effect as using the C<-fn> switch, and takes effect immediately:
396 1053
397 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" 1054Here is a checklist:
398 1055
399This is useful if you e.g. work primarily with japanese (and prefer a 1056=over 4
400japanese font), but you have to switch to chinese temporarily, where
401japanese fonts would only be in your way.
402 1057
403You can think of this as a kind of manual ISO-2022 switching. 1058=item - Make sure your locale I<and> the imLocale are supported on your OS.
404 1059
405=item Why do italic characters look as if clipped? 1060Try C<locale -a> or check the documentation for your OS.
406 1061
407Many fonts have difficulties with italic characters and hinting. For 1062=item - Make sure your locale or imLocale matches a locale supported by your XIM.
408example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
409Mono> completely fails in it's italic face. A workaround might be to
410enable freetype autohinting, i.e. like this:
411 1063
412 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 1064For example, B<kinput2> does not support UTF-8 locales, you should use
413 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 1065C<ja_JP.EUC-JP> or equivalent.
414 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
415=item My input method wants <some encoding> but I want UTF-8, what can I do? 1081=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
416 1082
417You can specify separate locales for the input method and the rest of the 1083You can specify separate locales for the input method and the rest of the
418terminal, using the resource C<imlocale>: 1084terminal, using the resource C<imlocale>:
419 1085
420 URxvt*imlocale: ja_JP.EUC-JP 1086 URxvt.imlocale: ja_JP.EUC-JP
421 1087
422Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 1088Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
423use your input method. Please note, however, that you will not be able to 1089use your input method. Please note, however, that, depending on your Xlib
424input characters outside C<EUC-JP> in a normal way then, as your input 1090version, you may not be able to input characters outside C<EUC-JP> in a
425method limits you. 1091normal way then, as your input method limits you.
426 1092
427=item Rxvt-unicode crashes when the X Input Method changes or exits. 1093=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
428 1094
429Unfortunately, this is unavoidable, as the XIM protocol is racy by 1095Unfortunately, this is unavoidable, as the XIM protocol is racy by
430design. Applications can avoid some crashes at the expense of memory 1096design. Applications can avoid some crashes at the expense of memory
431leaks, and Input Methods can avoid some crashes by careful ordering at 1097leaks, and Input Methods can avoid some crashes by careful ordering at
432exit time. B<kinput2> (and derived input methods) generally succeeds, 1098exit time. B<kinput2> (and derived input methods) generally succeeds,
433while B<SCIM> (or similar input methods) fails. In the end, however, 1099while B<SCIM> (or similar input methods) fails. In the end, however,
434crashes cannot be completely avoided even if both sides cooperate. 1100crashes cannot be completely avoided even if both sides cooperate.
435 1101
436So the only workaround is not to kill your Input Method Servers. 1102So the only workaround is not to kill your Input Method Servers.
437 1103
438=item Rxvt-unicode uses gobs of memory, how can I reduce that?
439 1104
440Rxvt-unicode tries to obey the rule of not charging you for something you 1105=head2 Operating Systems / Package Maintaining
441don't use. One thing you should try is to configure out all settings that
442you don't need, for example, Xft support is a resource hog by design,
443when used. Compiling it out ensures that no Xft font will be loaded
444accidentally when rxvt-unicode tries to find a font for your characters.
445 1106
446Also, many people (me included) like large windows and even larger 1107=head3 I am using Debian GNU/Linux and have a problem...
447scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
4486 bytes per screen cell. For a 160x?? window this amounts to almost a
449kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
450use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
451rxvt-unicode then uses 8 bytes per screen cell.
452 1108
453=item Can I speed up Xft rendering somehow? 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).
454 1117
455Yes, the most obvious way to speed it up is to avoid Xft entirely, as 1118For other problems that also affect the Debian package, you can and
456it is simply slow. If you still want Xft fonts you might try to disable 1119probably should use the Debian BTS, too, because, after all, it's also a
457antialiasing (by appending C<:antialiasing=false>), which saves lots of 1120bug in the Debian version and it serves as a reminder for other users that
458memory and also speeds up rendering considerably. 1121might encounter the same issue.
459 1122
460=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 1123=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
461 1124
462Rxvt-unicode will use whatever you specify as a font. If it needs to 1125You should build one binary with the default options. F<configure>
463fall back to it's default font search list it will prefer X11 core 1126now enables most useful options, and the trend goes to making them
464fonts, because they are small and fast, and then use Xft fonts. It has 1127runtime-switchable, too, so there is usually no drawback to enabling them,
465antialiasing disabled for most of them, because the author thinks they 1128except higher disk and possibly memory usage. The perl interpreter should
466look best that way. 1129be enabled, as important functionality (menus, selection, likely more in
1130the future) depends on it.
467 1131
468If you want antialiasing, you have to specify the fonts manually. 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.
469 1137
470=item Mouse cut/paste suddenly no longer works. 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).
471 1142
472Make sure that mouse reporting is actually turned off since killing 1143=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
473some editors prematurely may leave the mouse in mouse report mode. I've
474heard that tcsh may use mouse reporting unless it otherwise specified. A
475quick check is to see if cut/paste works when the Alt or Shift keys are
476depressed. See @@RXVT_NAME@@(7)
477 1144
478=item What's with this bold/blink stuff? 1145It should be, starting with release 7.1. You are encouraged to properly
1146install urxvt with privileges necessary for your OS now.
479 1147
480If no bold colour is set via C<colorBD:>, bold will invert text using the 1148When rxvt-unicode detects that it runs setuid or setgid, it will fork
481standard foreground colour. 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).
482 1154
483For the standard background colour, blinking will actually make the 1155This forking is done as the very first within main(), which is very early
484text blink when compiled with C<--enable-blinking>. with standard 1156and reduces possible bugs to initialisation code run before main(), or
485colours. Without C<--enable-blinking>, the blink attribute will be 1157things like the dynamic loader of your system, which should result in very
486ignored. 1158little risk.
487 1159
488On ANSI colours, bold/blink attributes are used to set high-intensity 1160=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
489foreground/background colors.
490 1161
491color0-7 are the low-intensity colors. 1162Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1163in your compile environment, or an implementation that implements it,
1164whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
1165B<wchar_t> is represented as unicode.
492 1166
493color8-15 are the corresponding high-intensity colors. 1167As you might have guessed, FreeBSD does neither define this symbol nor
1168does it support it. Instead, it uses its own internal representation of
1169B<wchar_t>. This is, of course, completely fine with respect to standards.
494 1170
495=item I don't like the screen colors. How do I change them? 1171However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
1172C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
496 1173
497You can change the screen colors at run-time using F<~/.Xdefaults> 1174C<__STDC_ISO_10646__> is the only sane way to support multi-language
498resources (or as long-options). 1175apps in an OS, as using a locale-dependent (and non-standardized)
1176representation of B<wchar_t> makes it impossible to convert between
1177B<wchar_t> (as used by X11 and your applications) and any other encoding
1178without implementing OS-specific-wrappers for each and every locale. There
1179simply are no APIs to convert B<wchar_t> into anything except the current
1180locale encoding.
499 1181
500Here are values that are supposed to resemble a VGA screen, 1182Some applications (such as the formidable B<mlterm>) work around this
501including the murky brown that passes for low-intensity yellow: 1183by carrying their own replacement functions for character set handling
1184with them, and either implementing OS-dependent hacks or doing multiple
1185conversions (which is slow and unreliable in case the OS implements
1186encodings slightly different than the terminal emulator).
502 1187
503 URxvt.color0: #000000 1188The rxvt-unicode author insists that the right way to fix this is in the
504 URxvt.color1: #A80000 1189system libraries once and for all, instead of forcing every app to carry
505 URxvt.color2: #00A800 1190complete replacements for them :)
506 URxvt.color3: #A8A800
507 URxvt.color4: #0000A8
508 URxvt.color5: #A800A8
509 URxvt.color6: #00A8A8
510 URxvt.color7: #A8A8A8
511 1191
512 URxvt.color8: #000054 1192=head3 How can I use rxvt-unicode under cygwin?
513 URxvt.color9: #FF0054
514 URxvt.color10: #00FF54
515 URxvt.color11: #FFFF54
516 URxvt.color12: #0000FF
517 URxvt.color13: #FF00FF
518 URxvt.color14: #00FFFF
519 URxvt.color15: #FFFFFF
520 1193
521And here is a more complete set of non-standard colors described (not by 1194rxvt-unicode should compile and run out of the box on cygwin, using
522me) as "pretty girly". 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.
523 1200
524 URxvt.cursorColor: #dc74d1 1201At the time of this writing, cygwin didn't seem to support any multi-byte
525 URxvt.pointerColor: #dc74d1 1202encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
526 URxvt.background: #0e0e0e 1203to 8-bit encodings.
527 URxvt.foreground: #4ad5e1
528 URxvt.color0: #000000
529 URxvt.color8: #8b8f93
530 URxvt.color1: #dc74d1
531 URxvt.color9: #dc74d1
532 URxvt.color2: #0eb8c7
533 URxvt.color10: #0eb8c7
534 URxvt.color3: #dfe37e
535 URxvt.color11: #dfe37e
536 URxvt.color5: #9e88f0
537 URxvt.color13: #9e88f0
538 URxvt.color6: #73f7ff
539 URxvt.color14: #73f7ff
540 URxvt.color7: #e1dddd
541 URxvt.color15: #e1dddd
542 1204
543=item How can I start @@RXVT_NAME@@d in a race-free way? 1205=head3 Character widths are not correct.
544 1206
545Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a 1207urxvt uses the system wcwidth function to know the information about
546server that answers @@RXVT_NAME@@c's requests, so it doesn't background 1208the width of characters, so on systems with incorrect locale data you
547itself. 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.
548 1212
549To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the 1213The solution is to upgrade your system or switch to a better one. A
550following method to wait for the startup message before continuing: 1214possibly working workaround is to use a wcwidth implementation like
551 1215
552 { @@RXVT_NAME@@d & } | read 1216http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
553 1217
554=item What's with the strange Backspace/Delete key behaviour?
555
556Assuming that the physical Backspace key corresponds to the
557BackSpace keysym (not likely for Linux ... see the following
558question) there are two standard values that can be used for
559Backspace: C<^H> and C<^?>.
560
561Historically, either value is correct, but rxvt-unicode adopts the debian
562policy of using C<^?> when unsure, because it's the one only only correct
563choice :).
564
565Rxvt-unicode tries to inherit the current stty settings and uses the value
566of `erase' to guess the value for backspace. If rxvt-unicode wasn't
567started from a terminal (say, from a menu or by remote shell), then the
568system value of `erase', which corresponds to CERASE in <termios.h>, will
569be used (which may not be the same as your stty setting).
570
571For starting a new rxvt-unicode:
572
573 # use Backspace = ^H
574 $ stty erase ^H
575 $ @@RXVT_NAME@@
576
577 # use Backspace = ^?
578 $ stty erase ^?
579 $ @@RXVT_NAME@@
580
581Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).
582
583For an existing rxvt-unicode:
584
585 # use Backspace = ^H
586 $ stty erase ^H
587 $ echo -n "^[[36h"
588
589 # use Backspace = ^?
590 $ stty erase ^?
591 $ echo -n "^[[36l"
592
593This helps satisfy some of the Backspace discrepancies that occur, but
594if you use Backspace = C<^H>, make sure that the termcap/terminfo value
595properly reflects that.
596
597The Delete key is a another casualty of the ill-defined Backspace problem.
598To avoid confusion between the Backspace and Delete keys, the Delete
599key has been assigned an escape sequence to match the vt100 for Execute
600(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
601
602Some other Backspace problems:
603
604some editors use termcap/terminfo,
605some editors (vim I'm told) expect Backspace = ^H,
606GNU Emacs (and Emacs-like editors) use ^H for help.
607
608Perhaps someday this will all be resolved in a consistent manner.
609
610=item I don't like the key-bindings. How do I change them?
611
612There are some compile-time selections available via configure. Unless
613you have run "configure" with the C<--disable-resources> option you can
614use the `keysym' resource to alter the keystrings associated with keysyms.
615
616Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
617
618 URxvt.keysym.Home: \033[1~
619 URxvt.keysym.End: \033[4~
620 URxvt.keysym.C-apostrophe: \033<C-'>
621 URxvt.keysym.C-slash: \033<C-/>
622 URxvt.keysym.C-semicolon: \033<C-;>
623 URxvt.keysym.C-grave: \033<C-`>
624 URxvt.keysym.C-comma: \033<C-,>
625 URxvt.keysym.C-period: \033<C-.>
626 URxvt.keysym.C-0x60: \033<C-`>
627 URxvt.keysym.C-Tab: \033<C-Tab>
628 URxvt.keysym.C-Return: \033<C-Return>
629 URxvt.keysym.S-Return: \033<S-Return>
630 URxvt.keysym.S-space: \033<S-Space>
631 URxvt.keysym.M-Up: \033<M-Up>
632 URxvt.keysym.M-Down: \033<M-Down>
633 URxvt.keysym.M-Left: \033<M-Left>
634 URxvt.keysym.M-Right: \033<M-Right>
635 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
636 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
637 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
638
639See some more examples in the documentation for the B<keysym> resource.
640
641=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
642How do I make use of them? For example, the Sun Keyboard type 4
643has the following mappings that rxvt-unicode doesn't recognize.
644
645 KP_Insert == Insert
646 F22 == Print
647 F27 == Home
648 F29 == Prior
649 F33 == End
650 F35 == Next
651
652Rather than have rxvt-unicode try to accommodate all the various possible
653keyboard mappings, it is better to use `xmodmap' to remap the keys as
654required for your particular machine.
655
656=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
657I need this to decide about setting colors etc.
658
659rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
660check and see if that is set. Note that several programs, JED, slrn,
661Midnight Commander automatically check this variable to decide whether or
662not to use color.
663
664=item How do I set the correct, full IP address for the DISPLAY variable?
665
666If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
667insecure mode then it is possible to use the following shell script
668snippets to correctly set the display. If your version of rxvt-unicode
669wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
670the COLORTERM variable can be used to distinguish rxvt-unicode from a
671regular xterm.
672
673Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
674snippets:
675
676 # Bourne/Korn/POSIX family of shells:
677 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
678 if [ ${TERM:-foo} = xterm ]; then
679 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
680 echo -n '^[Z'
681 read term_id
682 stty icanon echo
683 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
684 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
685 read DISPLAY # set it in our local shell
686 fi
687 fi
688
689=item How do I compile the manual pages for myself?
690
691You need to have a recent version of perl installed as F</usr/bin/perl>,
692one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
693the doc subdirectory and enter C<make alldoc>.
694
695=item My question isn't answered here, can I ask a human?
696
697Before sending me mail, you could go to IRC: C<irc.freenode.net>,
698channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
699interested in learning about new and exciting problems (but not FAQs :).
700
701=back
702
703=head1 RXVT TECHNICAL REFERENCE 1218=head1 RXVT-UNICODE TECHNICAL REFERENCE
704
705=head1 DESCRIPTION
706 1219
707The rest of this document describes various technical aspects of 1220The rest of this document describes various technical aspects of
708B<rxvt-unicode>. First the description of supported command sequences, 1221B<rxvt-unicode>. First the description of supported command sequences,
709followed by menu and pixmap support and last by a description of all 1222followed by pixmap support and last by a description of all features
710features selectable at C<configure> time. 1223selectable at C<configure> time.
711 1224
712=head1 Definitions 1225=head2 Definitions
713 1226
714=over 4 1227=over 4
715 1228
716=item B<< C<c> >> 1229=item B<< C<c> >>
717 1230
735 1248
736A text parameter composed of printable characters. 1249A text parameter composed of printable characters.
737 1250
738=back 1251=back
739 1252
740=head1 Values 1253=head2 Values
741 1254
742=over 4 1255=over 4
743 1256
744=item B<< C<ENQ> >> 1257=item B<< C<ENQ> >>
745 1258
788 1301
789Space Character 1302Space Character
790 1303
791=back 1304=back
792 1305
793=head1 Escape Sequences 1306=head2 Escape Sequences
794 1307
795=over 4 1308=over 4
796 1309
797=item B<< C<ESC # 8> >> 1310=item B<< C<ESC # 8> >>
798 1311
896 1409
897=back 1410=back
898 1411
899X<CSI> 1412X<CSI>
900 1413
901=head1 CSI (Command Sequence Introducer) Sequences 1414=head2 CSI (Command Sequence Introducer) Sequences
902 1415
903=over 4 1416=over 4
904 1417
905=item B<< C<ESC [ Ps @> >> 1418=item B<< C<ESC [ Ps @> >>
906 1419
1176 1689
1177=back 1690=back
1178 1691
1179X<PrivateModes> 1692X<PrivateModes>
1180 1693
1181=head1 DEC Private Modes 1694=head2 DEC Private Modes
1182 1695
1183=over 4 1696=over 4
1184 1697
1185=item B<< C<ESC [ ? Pm h> >> 1698=item B<< C<ESC [ ? Pm h> >>
1186 1699
1202 1715
1203Toggle DEC Private Mode Values (rxvt extension). I<where> 1716Toggle DEC Private Mode Values (rxvt extension). I<where>
1204 1717
1205=over 4 1718=over 4
1206 1719
1207=item B<< C<Ps = 1> >> (DECCKM) 1720=item B<< C<Pm = 1> >> (DECCKM)
1208 1721
1209=begin table 1722=begin table
1210 1723
1211 B<< C<h> >> Application Cursor Keys 1724 B<< C<h> >> Application Cursor Keys
1212 B<< C<l> >> Normal Cursor Keys 1725 B<< C<l> >> Normal Cursor Keys
1213 1726
1214=end table 1727=end table
1215 1728
1216=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1729=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1217 1730
1218=begin table 1731=begin table
1219 1732
1220 B<< C<h> >> Enter VT52 mode 1733 B<< C<h> >> Enter VT52 mode
1221 B<< C<l> >> Enter VT52 mode 1734 B<< C<l> >> Enter VT52 mode
1222 1735
1223=end table 1736=end table
1224 1737
1225=item B<< C<Ps = 3> >> 1738=item B<< C<Pm = 3> >>
1226 1739
1227=begin table 1740=begin table
1228 1741
1229 B<< C<h> >> 132 Column Mode (DECCOLM) 1742 B<< C<h> >> 132 Column Mode (DECCOLM)
1230 B<< C<l> >> 80 Column Mode (DECCOLM) 1743 B<< C<l> >> 80 Column Mode (DECCOLM)
1231 1744
1232=end table 1745=end table
1233 1746
1234=item B<< C<Ps = 4> >> 1747=item B<< C<Pm = 4> >>
1235 1748
1236=begin table 1749=begin table
1237 1750
1238 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1751 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1239 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1752 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1240 1753
1241=end table 1754=end table
1242 1755
1243=item B<< C<Ps = 5> >> 1756=item B<< C<Pm = 5> >>
1244 1757
1245=begin table 1758=begin table
1246 1759
1247 B<< C<h> >> Reverse Video (DECSCNM) 1760 B<< C<h> >> Reverse Video (DECSCNM)
1248 B<< C<l> >> Normal Video (DECSCNM) 1761 B<< C<l> >> Normal Video (DECSCNM)
1249 1762
1250=end table 1763=end table
1251 1764
1252=item B<< C<Ps = 6> >> 1765=item B<< C<Pm = 6> >>
1253 1766
1254=begin table 1767=begin table
1255 1768
1256 B<< C<h> >> Origin Mode (DECOM) 1769 B<< C<h> >> Origin Mode (DECOM)
1257 B<< C<l> >> Normal Cursor Mode (DECOM) 1770 B<< C<l> >> Normal Cursor Mode (DECOM)
1258 1771
1259=end table 1772=end table
1260 1773
1261=item B<< C<Ps = 7> >> 1774=item B<< C<Pm = 7> >>
1262 1775
1263=begin table 1776=begin table
1264 1777
1265 B<< C<h> >> Wraparound Mode (DECAWM) 1778 B<< C<h> >> Wraparound Mode (DECAWM)
1266 B<< C<l> >> No Wraparound Mode (DECAWM) 1779 B<< C<l> >> No Wraparound Mode (DECAWM)
1267 1780
1268=end table 1781=end table
1269 1782
1270=item B<< C<Ps = 8> >> I<unimplemented> 1783=item B<< C<Pm = 8> >> I<unimplemented>
1271 1784
1272=begin table 1785=begin table
1273 1786
1274 B<< C<h> >> Auto-repeat Keys (DECARM) 1787 B<< C<h> >> Auto-repeat Keys (DECARM)
1275 B<< C<l> >> No Auto-repeat Keys (DECARM) 1788 B<< C<l> >> No Auto-repeat Keys (DECARM)
1276 1789
1277=end table 1790=end table
1278 1791
1279=item B<< C<Ps = 9> >> X10 XTerm 1792=item B<< C<Pm = 9> >> X10 XTerm
1280 1793
1281=begin table 1794=begin table
1282 1795
1283 B<< C<h> >> Send Mouse X & Y on button press. 1796 B<< C<h> >> Send Mouse X & Y on button press.
1284 B<< C<l> >> No mouse reporting. 1797 B<< C<l> >> No mouse reporting.
1285 1798
1286=end table 1799=end table
1287 1800
1288=item B<< C<Ps = 10> >> (B<rxvt>)
1289
1290=begin table
1291
1292 B<< C<h> >> menuBar visible
1293 B<< C<l> >> menuBar invisible
1294
1295=end table
1296
1297=item B<< C<Ps = 25> >> 1801=item B<< C<Pm = 25> >>
1298 1802
1299=begin table 1803=begin table
1300 1804
1301 B<< C<h> >> Visible cursor {cnorm/cvvis} 1805 B<< C<h> >> Visible cursor {cnorm/cvvis}
1302 B<< C<l> >> Invisible cursor {civis} 1806 B<< C<l> >> Invisible cursor {civis}
1303 1807
1304=end table 1808=end table
1305 1809
1306=item B<< C<Ps = 30> >> 1810=item B<< C<Pm = 30> >>
1307 1811
1308=begin table 1812=begin table
1309 1813
1310 B<< C<h> >> scrollBar visisble 1814 B<< C<h> >> scrollBar visisble
1311 B<< C<l> >> scrollBar invisisble 1815 B<< C<l> >> scrollBar invisisble
1312 1816
1313=end table 1817=end table
1314 1818
1315=item B<< C<Ps = 35> >> (B<rxvt>) 1819=item B<< C<Pm = 35> >> (B<rxvt>)
1316 1820
1317=begin table 1821=begin table
1318 1822
1319 B<< C<h> >> Allow XTerm Shift+key sequences 1823 B<< C<h> >> Allow XTerm Shift+key sequences
1320 B<< C<l> >> Disallow XTerm Shift+key sequences 1824 B<< C<l> >> Disallow XTerm Shift+key sequences
1321 1825
1322=end table 1826=end table
1323 1827
1324=item B<< C<Ps = 38> >> I<unimplemented> 1828=item B<< C<Pm = 38> >> I<unimplemented>
1325 1829
1326Enter Tektronix Mode (DECTEK) 1830Enter Tektronix Mode (DECTEK)
1327 1831
1328=item B<< C<Ps = 40> >> 1832=item B<< C<Pm = 40> >>
1329 1833
1330=begin table 1834=begin table
1331 1835
1332 B<< C<h> >> Allow 80/132 Mode 1836 B<< C<h> >> Allow 80/132 Mode
1333 B<< C<l> >> Disallow 80/132 Mode 1837 B<< C<l> >> Disallow 80/132 Mode
1334 1838
1335=end table 1839=end table
1336 1840
1337=item B<< C<Ps = 44> >> I<unimplemented> 1841=item B<< C<Pm = 44> >> I<unimplemented>
1338 1842
1339=begin table 1843=begin table
1340 1844
1341 B<< C<h> >> Turn On Margin Bell 1845 B<< C<h> >> Turn On Margin Bell
1342 B<< C<l> >> Turn Off Margin Bell 1846 B<< C<l> >> Turn Off Margin Bell
1343 1847
1344=end table 1848=end table
1345 1849
1346=item B<< C<Ps = 45> >> I<unimplemented> 1850=item B<< C<Pm = 45> >> I<unimplemented>
1347 1851
1348=begin table 1852=begin table
1349 1853
1350 B<< C<h> >> Reverse-wraparound Mode 1854 B<< C<h> >> Reverse-wraparound Mode
1351 B<< C<l> >> No Reverse-wraparound Mode 1855 B<< C<l> >> No Reverse-wraparound Mode
1352 1856
1353=end table 1857=end table
1354 1858
1355=item B<< C<Ps = 46> >> I<unimplemented> 1859=item B<< C<Pm = 46> >> I<unimplemented>
1356 1860
1357=item B<< C<Ps = 47> >> 1861=item B<< C<Pm = 47> >>
1358 1862
1359=begin table 1863=begin table
1360 1864
1361 B<< C<h> >> Use Alternate Screen Buffer 1865 B<< C<h> >> Use Alternate Screen Buffer
1362 B<< C<l> >> Use Normal Screen Buffer 1866 B<< C<l> >> Use Normal Screen Buffer
1363 1867
1364=end table 1868=end table
1365 1869
1366X<Priv66> 1870X<Priv66>
1367 1871
1368=item B<< C<Ps = 66> >> 1872=item B<< C<Pm = 66> >>
1369 1873
1370=begin table 1874=begin table
1371 1875
1372 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1876 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1373 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1877 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1374 1878
1375=end table 1879=end table
1376 1880
1377=item B<< C<Ps = 67> >> 1881=item B<< C<Pm = 67> >>
1378 1882
1379=begin table 1883=begin table
1380 1884
1381 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1885 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1382 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1886 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1383 1887
1384=end table 1888=end table
1385 1889
1386=item B<< C<Ps = 1000> >> (X11 XTerm) 1890=item B<< C<Pm = 1000> >> (X11 XTerm)
1387 1891
1388=begin table 1892=begin table
1389 1893
1390 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.
1391 B<< C<l> >> No mouse reporting. 1895 B<< C<l> >> No mouse reporting.
1392 1896
1393=end table 1897=end table
1394 1898
1395=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1899=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1396 1900
1397=begin table 1901=begin table
1398 1902
1399 B<< C<h> >> Use Hilite Mouse Tracking. 1903 B<< C<h> >> Use Hilite Mouse Tracking.
1400 B<< C<l> >> No mouse reporting. 1904 B<< C<l> >> No mouse reporting.
1401 1905
1402=end table 1906=end table
1403 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
1404=item B<< C<Ps = 1010> >> (B<rxvt>) 1926=item B<< C<Pm = 1010> >> (B<rxvt>)
1405 1927
1406=begin table 1928=begin table
1407 1929
1408 B<< C<h> >> Don't scroll to bottom on TTY output 1930 B<< C<h> >> Don't scroll to bottom on TTY output
1409 B<< C<l> >> Scroll to bottom on TTY output 1931 B<< C<l> >> Scroll to bottom on TTY output
1410 1932
1411=end table 1933=end table
1412 1934
1413=item B<< C<Ps = 1011> >> (B<rxvt>) 1935=item B<< C<Pm = 1011> >> (B<rxvt>)
1414 1936
1415=begin table 1937=begin table
1416 1938
1417 B<< C<h> >> Scroll to bottom when a key is pressed 1939 B<< C<h> >> Scroll to bottom when a key is pressed
1418 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
1419 1941
1420=end table 1942=end table
1421 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
1422=item B<< C<Ps = 1047> >> 1953=item B<< C<Pm = 1047> >>
1423 1954
1424=begin table 1955=begin table
1425 1956
1426 B<< C<h> >> Use Alternate Screen Buffer 1957 B<< C<h> >> Use Alternate Screen Buffer
1427 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
1428 1959
1429=end table 1960=end table
1430 1961
1431=item B<< C<Ps = 1048> >> 1962=item B<< C<Pm = 1048> >>
1432 1963
1433=begin table 1964=begin table
1434 1965
1435 B<< C<h> >> Save cursor position 1966 B<< C<h> >> Save cursor position
1436 B<< C<l> >> Restore cursor position 1967 B<< C<l> >> Restore cursor position
1437 1968
1438=end table 1969=end table
1439 1970
1440=item B<< C<Ps = 1049> >> 1971=item B<< C<Pm = 1049> >>
1441 1972
1442=begin table 1973=begin table
1443 1974
1444 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
1445 B<< C<l> >> Use Normal Screen Buffer 1976 B<< C<l> >> Use Normal Screen Buffer
1450 1981
1451=back 1982=back
1452 1983
1453X<XTerm> 1984X<XTerm>
1454 1985
1455=head1 XTerm Operating System Commands 1986=head2 XTerm Operating System Commands
1456 1987
1457=over 4 1988=over 4
1458 1989
1459=item B<< C<ESC ] Ps;Pt ST> >> 1990=item B<< C<ESC ] Ps;Pt ST> >>
1460 1991
1472 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)>
1473 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)>
1474 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> >>
1475 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> >>
1476 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> >>
1477 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]
1478 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]
2010 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
1479 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 2011 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1480 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option>
1481 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>
1482 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 2013 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1483 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> >>
1484 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> >>
1485 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVT_NAME@@ extension) 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).
1486 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension) 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>.
1487 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> >>
1488 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> 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> >>
1489 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>.
1490 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 2023 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1491 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 2024 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1492 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 2025 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2026 B<< C<Ps = 720> >> Move viewing window up 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).
1493 2029
1494=end table 2030=end table
1495 2031
1496=back 2032=back
1497 2033
1498X<menuBar> 2034=head1 BACKGROUND IMAGE
1499 2035
1500=head1 menuBar
1501
1502B<< The exact syntax used is I<almost> solidified. >>
1503In the menus, B<DON'T> try to use menuBar commands that add or remove a
1504menuBar.
1505
1506Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1507omitted: use B<./> to specify a menu relative to the current menu.
1508
1509=head2 Overview of menuBar operation
1510
1511For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1512of C<Pt> can be used for a variety of tasks:
1513
1514At the top level is the current menuBar which is a member of a circular
1515linked-list of other such menuBars.
1516
1517The menuBar acts as a parent for the various drop-down menus, which in
1518turn, may have labels, separator lines, menuItems and subMenus.
1519
1520The menuItems are the useful bits: you can use them to mimic keyboard
1521input or even to send text or escape sequences back to rxvt.
1522
1523The menuBar syntax is intended to provide a simple yet robust method of
1524constructing and manipulating menus and navigating through the
1525menuBars.
1526
1527The first step is to use the tag B<< [menu:I<name>] >> which creates
1528the menuBar called I<name> and allows access. You may now or menus,
1529subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1530menuBar access as B<readonly> to prevent accidental corruption of the
1531menus. To re-access the current menuBar for alterations, use the tag
1532B<[menu]>, make the alterations and then use B<[done]>
1533
1534X<menuBarCommands>
1535
1536=head2 Commands
1537
1538=over 4
1539
1540=item B<< [menu:+I<name>] >>
1541
1542access the named menuBar for creation or alteration. If a new menuBar
1543is created, it is called I<name> (max of 15 chars) and the current
1544menuBar is pushed onto the stack
1545
1546=item B<[menu]>
1547
1548access the current menuBar for alteration
1549
1550=item B<< [title:+I<string>] >>
1551
1552set the current menuBar's title to I<string>, which may contain the
1553following format specifiers:
1554
1555 B<%n> rxvt name (as per the B<-name> command-line option)
1556 B<%v> rxvt version
1557 B<%%> literal B<%> character
1558
1559=item B<[done]>
1560
1561set menuBar access as B<readonly>.
1562End-of-file tag for B<< [read:+I<file>] >> operations.
1563
1564=item B<< [read:+I<file>] >>
1565
1566read menu commands directly from I<file> (extension ".menu" will be
1567appended if required.) Start reading at a line with B<[menu]> or B<<
1568[menu:+I<name> >> and continuing until B<[done]> is encountered.
1569
1570Blank and comment lines (starting with B<#>) are ignored. Actually,
1571since any invalid menu commands are also ignored, almost anything could
1572be construed as a comment line, but this may be tightened up in the
1573future ... so don't count on it!.
1574
1575=item B<< [read:+I<file>;+I<name>] >>
1576
1577The same as B<< [read:+I<file>] >>, but start reading at a line with
1578B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1579B<[done]> is encountered.
1580
1581=item B<[dump]>
1582
1583dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1584later rereading.
1585
1586=item B<[rm:name]>
1587
1588remove the named menuBar
1589
1590=item B<[rm] [rm:]>
1591
1592remove the current menuBar
1593
1594=item B<[rm*] [rm:*]>
1595
1596remove all menuBars
1597
1598=item B<[swap]>
1599
1600swap the top two menuBars
1601
1602=item B<[prev]>
1603
1604access the previous menuBar
1605
1606=item B<[next]>
1607
1608access the next menuBar
1609
1610=item B<[show]>
1611
1612Enable display of the menuBar
1613
1614=item B<[hide]>
1615
1616Disable display of the menuBar
1617
1618=item B<< [pixmap:+I<name>] >>
1619
1620=item B<< [pixmap:+I<name>;I<scaling>] >>
1621
1622(set the background pixmap globally
1623
1624B<< A Future implementation I<may> make this local to the menubar >>)
1625
1626=item B<< [:+I<command>:] >>
1627
1628ignore the menu readonly status and issue a I<command> to or a menu or
1629menuitem or change the ; a useful shortcut for setting the quick arrows
1630from a menuBar.
1631
1632=back
1633
1634X<menuBarAdd>
1635
1636=head2 Adding and accessing menus
1637
1638The following commands may also be B<+> prefixed.
1639
1640=over 4
1641
1642=item B</+>
1643
1644access menuBar top level
1645
1646=item B<./+>
1647
1648access current menu level
1649
1650=item B<../+>
1651
1652access parent menu (1 level up)
1653
1654=item B<../../>
1655
1656access parent menu (multiple levels up)
1657
1658=item B<< I</path/>menu >>
1659
1660add/access menu
1661
1662=item B<< I</path/>menu/* >>
1663
1664add/access menu and clear it if it exists
1665
1666=item B<< I</path/>{-} >>
1667
1668add separator
1669
1670=item B<< I</path/>{item} >>
1671
1672add B<item> as a label
1673
1674=item B<< I</path/>{item} action >>
1675
1676add/alter I<menuitem> with an associated I<action>
1677
1678=item B<< I</path/>{item}{right-text} >>
1679
1680add/alter I<menuitem> with B<right-text> as the right-justified text
1681and as the associated I<action>
1682
1683=item B<< I</path/>{item}{rtext} action >>
1684
1685add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1686the right-justified text.
1687
1688=back
1689
1690=over 4
1691
1692=item Special characters in I<action> must be backslash-escaped:
1693
1694B<\a \b \E \e \n \r \t \octal>
1695
1696=item or in control-character notation:
1697
1698B<^@, ^A .. ^Z .. ^_, ^?>
1699
1700=back
1701
1702To send a string starting with a B<NUL> (B<^@>) character to the
1703program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1704the first of which will be stripped off and the balance directed to the
1705program. Otherwise if I<action> begins with B<NUL> followed by
1706non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1707balance is sent back to rxvt.
1708
1709As a convenience for the many Emacs-type editors, I<action> may start
1710with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1711appended if missed from B<M-x> commands.
1712
1713As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1714quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1715
1716=over 4
1717
1718=item For example,
1719
1720B<M-xapropos> is equivalent to B<\Exapropos\r>
1721
1722=item and
1723
1724B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1725
1726=back
1727
1728The option B<< {I<right-rtext>} >> will be right-justified. In the
1729absence of a specified action, this text will be used as the I<action>
1730as well.
1731
1732=over 4
1733
1734=item For example,
1735
1736B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1737
1738=back
1739
1740The left label I<is> necessary, since it's used for matching, but
1741implicitly hiding the left label (by using same name for both left and
1742right labels), or explicitly hiding the left label (by preceeding it
1743with a dot), makes it possible to have right-justified text only.
1744
1745=over 4
1746
1747=item For example,
1748
1749B</File/{Open}{Open} Open-File-Action>
1750
1751=item or hiding it
1752
1753B</File/{.anylabel}{Open} Open-File-Action>
1754
1755=back
1756
1757X<menuBarRemove>
1758
1759=head2 Removing menus
1760
1761=over 4
1762
1763=item B<< -/*+ >>
1764
1765remove all menus from the menuBar, the same as B<[clear]>
1766
1767=item B<< -+I</path>menu+ >>
1768
1769remove menu
1770
1771=item B<< -+I</path>{item}+ >>
1772
1773remove item
1774
1775=item B<< -+I</path>{-} >>
1776
1777remove separator)
1778
1779=item B<-/path/menu/*>
1780
1781remove all items, separators and submenus from menu
1782
1783=back
1784
1785X<menuBarArrows>
1786
1787=head2 Quick Arrows
1788
1789The menus also provide a hook for I<quick arrows> to provide easier
1790user access. If nothing has been explicitly set, the default is to
1791emulate the curror keys. The syntax permits each arrow to be altered
1792individually or all four at once without re-entering their common
1793beginning/end text. For example, to explicitly associate cursor actions
1794with the arrows, any of the following forms could be used:
1795
1796=over 4
1797
1798=item B<< <r>+I<Right> >>
1799
1800=item B<< <l>+I<Left> >>
1801
1802=item B<< <u>+I<Up> >>
1803
1804=item B<< <d>+I<Down> >>
1805
1806Define actions for the respective arrow buttons
1807
1808=item B<< <b>+I<Begin> >>
1809
1810=item B<< <e>+I<End> >>
1811
1812Define common beginning/end parts for I<quick arrows> which used in
1813conjunction with the above <r> <l> <u> <d> constructs
1814
1815=back
1816
1817=over 4
1818
1819=item For example, define arrows individually,
1820
1821 <u>\E[A
1822
1823 <d>\E[B
1824
1825 <r>\E[C
1826
1827 <l>\E[D
1828
1829=item or all at once
1830
1831 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1832
1833=item or more compactly (factoring out common parts)
1834
1835 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1836
1837=back
1838
1839X<menuBarSummary>
1840
1841=head2 Command Summary
1842
1843A short summary of the most I<common> commands:
1844
1845=over 4
1846
1847=item [menu:name]
1848
1849use an existing named menuBar or start a new one
1850
1851=item [menu]
1852
1853use the current menuBar
1854
1855=item [title:string]
1856
1857set menuBar title
1858
1859=item [done]
1860
1861set menu access to readonly and, if reading from a file, signal EOF
1862
1863=item [done:name]
1864
1865if reading from a file using [read:file;name] signal EOF
1866
1867=item [rm:name]
1868
1869remove named menuBar(s)
1870
1871=item [rm] [rm:]
1872
1873remove current menuBar
1874
1875=item [rm*] [rm:*]
1876
1877remove all menuBar(s)
1878
1879=item [swap]
1880
1881swap top two menuBars
1882
1883=item [prev]
1884
1885access the previous menuBar
1886
1887=item [next]
1888
1889access the next menuBar
1890
1891=item [show]
1892
1893map menuBar
1894
1895=item [hide]
1896
1897unmap menuBar
1898
1899=item [pixmap;file]
1900
1901=item [pixmap;file;scaling]
1902
1903set a background pixmap
1904
1905=item [read:file]
1906
1907=item [read:file;name]
1908
1909read in a menu from a file
1910
1911=item [dump]
1912
1913dump out all menuBars to /tmp/rxvt-PID
1914
1915=item /
1916
1917access menuBar top level
1918
1919=item ./
1920
1921=item ../
1922
1923=item ../../
1924
1925access current or parent menu level
1926
1927=item /path/menu
1928
1929add/access menu
1930
1931=item /path/{-}
1932
1933add separator
1934
1935=item /path/{item}{rtext} action
1936
1937add/alter menu item
1938
1939=item -/*
1940
1941remove all menus from the menuBar
1942
1943=item -/path/menu
1944
1945remove menu items, separators and submenus from menu
1946
1947=item -/path/menu
1948
1949remove menu
1950
1951=item -/path/{item}
1952
1953remove item
1954
1955=item -/path/{-}
1956
1957remove separator
1958
1959=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1960
1961menu quick arrows
1962
1963=back
1964X<XPM>
1965
1966=head1 XPM
1967
1968For 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
1969of 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
1970sequence of scaling/positioning commands separated by semi-colons. The 2038sequence of scaling/positioning commands separated by semi-colons. The
1971scaling/positioning commands are as follows: 2039scaling/positioning commands are as follows:
1972 2040
1973=over 4 2041=over 4
1974 2042
2012 2080
2013For example: 2081For example:
2014 2082
2015=over 4 2083=over 4
2016 2084
2017=item B<\E]20;funky\a> 2085=item B<\E]20;funky.jpg\a>
2018 2086
2019load B<funky.xpm> as a tiled image 2087load B<funky.jpg> as a tiled image
2020 2088
2021=item B<\E]20;mona;100\a> 2089=item B<\E]20;mona.jpg;100\a>
2022 2090
2023load B<mona.xpm> with a scaling of 100% 2091load B<mona.jpg> with a scaling of 100%
2024 2092
2025=item B<\E]20;;200;?\a> 2093=item B<\E]20;;200;?\a>
2026 2094
2027rescale the current pixmap to 200% and display the image geometry in 2095rescale the current pixmap to 200% and display the image geometry in
2028the title 2096the title
2067=begin table 2135=begin table
2068 2136
2069 4 Shift 2137 4 Shift
2070 8 Meta 2138 8 Meta
2071 16 Control 2139 16 Control
2072 32 Double Click I<(Rxvt extension)> 2140 32 Double Click I<(rxvt extension)>
2073 2141
2074=end table 2142=end table
2075 2143
2076Col = B<< C<< <x> - SPACE >> >> 2144Col = B<< C<< <x> - SPACE >> >>
2077 2145
2154=end table 2222=end table
2155 2223
2156=head1 CONFIGURE OPTIONS 2224=head1 CONFIGURE OPTIONS
2157 2225
2158General hint: if you get compile errors, then likely your configuration 2226General hint: if you get compile errors, then likely your configuration
2159hasn'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
2160./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>
2161so it should generally be a working config. Of course, you should always 2229switches). Of course, you should always report when a combination doesn't
2162report when a combination doesn't work, so it can be fixed. Marc Lehmann 2230work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2163<rxvt@schmorp.de>. 2231
2232All
2164 2233
2165=over 4 2234=over 4
2166 2235
2167=item --enable-everything 2236=item --enable-everything
2168 2237
2169Add support for all non-multichoice options listed in "./configure 2238Add (or remove) support for all non-multichoice options listed in "./configure
2170--help". Note that unlike other enable options this is order dependant. 2239--help".
2240
2171You can specify this and then disable options which this enables by 2241You can specify this and then disable options you do not like by
2172I<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.
2173 2246
2174=item --enable-xft 2247=item --enable-xft (default: enabled)
2175 2248
2176Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2249Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2177slower 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
2178don't pay for them. 2251don't pay for them.
2179 2252
2180=item --enable-font-styles 2253=item --enable-font-styles (default: on)
2181 2254
2182Add 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
2183styles. The fonts can be set manually or automatically. 2256styles. The fonts can be set manually or automatically.
2184 2257
2185=item --with-codesets=NAME,... 2258=item --with-codesets=NAME,... (default: all)
2186 2259
2187Compile in support for additional codeset (encoding) groups (eu, vn are 2260Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2188always compiled in, which includes most 8-bit character sets). These 2261are always compiled in, which includes most 8-bit character sets). These
2189codeset tables are currently only used for driving X11 core fonts, they 2262codeset tables are used for driving X11 core fonts, they are not required
2190are not required for Xft fonts. Compiling them in will make your binary 2263for Xft fonts, although having them compiled in lets rxvt-unicode choose
2191bigger (together about 700kB), but it doesn't increase memory usage unless 2264replacement fonts more intelligently. Compiling them in will make your
2265binary bigger (all of together cost about 700kB), but it doesn't increase
2192you use an X11 font requiring one of these encodings. 2266memory usage unless you use a font requiring one of these encodings.
2193 2267
2194=begin table 2268=begin table
2195 2269
2196 all all available codeset groups 2270 all all available codeset groups
2197 zh common chinese encodings 2271 zh common chinese encodings
2198 zh_ext rarely used but very big chinese encodigs 2272 zh_ext rarely used but very big chinese encodings
2199 jp common japanese encodings 2273 jp common japanese encodings
2200 jp_ext rarely used but big japanese encodings 2274 jp_ext rarely used but big japanese encodings
2201 kr korean encodings 2275 kr korean encodings
2202 2276
2203=end table 2277=end table
2204 2278
2205=item --enable-xim 2279=item --enable-xim (default: on)
2206 2280
2207Add support for XIM (X Input Method) protocol. This allows using 2281Add support for XIM (X Input Method) protocol. This allows using
2208alternative input methods (e.g. kinput2) and will also correctly 2282alternative input methods (e.g. kinput2) and will also correctly
2209set up the input for people using dead keys or compose keys. 2283set up the input for people using dead keys or compose keys.
2210 2284
2211=item --enable-unicode3 2285=item --enable-unicode3 (default: off)
2286
2287Recommended to stay off unless you really need non-BMP characters.
2212 2288
2213Enable direct support for displaying unicode codepoints above 2289Enable direct support for displaying unicode codepoints above
221465535 (the basic multilingual page). This increases storage 229065535 (the basic multilingual page). This increases storage
2215requirements 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
2216support these extra characters, but Xft does. 2292support these extra characters, but Xft does.
2217 2293
2218Please note that rxvt-unicode can store unicode code points >65535 2294Please note that rxvt-unicode can store unicode code points >65535
2219even without this flag, but the number of such characters is 2295even without this flag, but the number of such characters is
2220limited to a view thousand (shared with combining characters, 2296limited to a few thousand (shared with combining characters,
2221see next switch), and right now rxvt-unicode cannot display them 2297see next switch), and right now rxvt-unicode cannot display them
2222(input/output and cut&paste still work, though). 2298(input/output and cut&paste still work, though).
2223 2299
2224=item --enable-combining 2300=item --enable-combining (default: on)
2225 2301
2226Enable automatic composition of combining characters into 2302Enable automatic composition of combining characters into
2227composite characters. This is required for proper viewing of text 2303composite characters. This is required for proper viewing of text
2228where accents are encoded as seperate unicode characters. This is 2304where accents are encoded as seperate unicode characters. This is
2229done by using precomposited characters when available or creating 2305done by using precomposited characters when available or creating
2230new pseudo-characters when no precomposed form exists. 2306new pseudo-characters when no precomposed form exists.
2231 2307
2232Without --enable-unicode3, the number of additional precomposed characters 2308Without --enable-unicode3, the number of additional precomposed
2233is rather limited (2048, if this is full, rxvt-unicode will use the 2309characters is somewhat limited (the 6400 private use characters will be
2234private use area, extending the number of combinations to 8448). With
2235--enable-unicode3, no practical limit exists. 2310(ab-)used). With --enable-unicode3, no practical limit exists.
2236 2311
2237This option will also enable storage (but not display) of characters 2312This option will also enable storage (but not display) of characters
2238beyond plane 0 (>65535) when --enable-unicode3 was not specified. 2313beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2239 2314
2240The combining table also contains entries for arabic presentation forms, 2315The combining table also contains entries for arabic presentation forms,
2241but 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
2242tell me how these are to be used...). 2317tell me how these are to be used...).
2243 2318
2244=item --enable-fallback(=CLASS) 2319=item --enable-fallback(=CLASS) (default: Rxvt)
2245 2320
2246When reading resource settings, also read settings for class CLASS 2321When reading resource settings, also read settings for class CLASS. To
2247(default: Rxvt). To disable resource fallback use --disable-fallback. 2322disable resource fallback use --disable-fallback.
2248 2323
2249=item --with-res-name=NAME 2324=item --with-res-name=NAME (default: urxvt)
2250 2325
2251Use the given name (default: urxvt) as default application name when 2326Use the given name as default application name when
2252reading resources. Specify --with-res-name=rxvt to replace rxvt. 2327reading resources. Specify --with-res-name=rxvt to replace rxvt.
2253 2328
2254=item --with-res-class=CLASS 2329=item --with-res-class=CLASS (default: URxvt)
2255 2330
2256Use the given class (default: URxvt) as default application class 2331Use the given class as default application class
2257when reading resources. Specify --with-res-class=Rxvt to replace 2332when reading resources. Specify --with-res-class=Rxvt to replace
2258rxvt. 2333rxvt.
2259 2334
2260=item --enable-utmp 2335=item --enable-utmp (default: on)
2261 2336
2262Write 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
2263start of rxvt execution and delete information when rxvt exits. 2338start of rxvt execution and delete information when rxvt exits.
2264 2339
2265=item --enable-wtmp 2340=item --enable-wtmp (default: on)
2266 2341
2267Write 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
2268start of rxvt execution and write logout when rxvt exits. This 2343start of rxvt execution and write logout when rxvt exits. This
2269option requires --enable-utmp to also be specified. 2344option requires --enable-utmp to also be specified.
2270 2345
2271=item --enable-lastlog 2346=item --enable-lastlog (default: on)
2272 2347
2273Write user and tty to lastlog file (used by programs like 2348Write user and tty to lastlog file (used by programs like
2274F<lastlogin>) at start of rxvt execution. This option requires 2349F<lastlogin>) at start of rxvt execution. This option requires
2275--enable-utmp to also be specified. 2350--enable-utmp to also be specified.
2276 2351
2277=item --enable-xpm-background 2352=item --enable-afterimage (default: on)
2278 2353
2279Add 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>).
2280 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
2281=item --enable-transparency 2367=item --enable-transparency (default: on)
2282 2368
2283Add support for inheriting parent backgrounds thus giving a fake 2369Add support for backgrounds, creating illusion of transparency in the term.
2284transparency to the term.
2285 2370
2286=item --enable-fading 2371=item --enable-fading (default: on)
2287 2372
2288Add support for fading the text when focus is lost. 2373Add support for fading the text when focus is lost.
2289 2374
2290=item --enable-tinting
2291
2292Add support for tinting of transparent backgrounds.
2293
2294=item --enable-menubar
2295
2296Add support for our menu bar system (this interacts badly with
2297dynamic locale switching currently).
2298
2299=item --enable-rxvt-scroll 2375=item --enable-rxvt-scroll (default: on)
2300 2376
2301Add support for the original rxvt scrollbar. 2377Add support for the original rxvt scrollbar.
2302 2378
2303=item --enable-next-scroll 2379=item --enable-next-scroll (default: on)
2304 2380
2305Add support for a NeXT-like scrollbar. 2381Add support for a NeXT-like scrollbar.
2306 2382
2307=item --enable-xterm-scroll 2383=item --enable-xterm-scroll (default: on)
2308 2384
2309Add support for an Xterm-like scrollbar. 2385Add support for an Xterm-like scrollbar.
2310 2386
2311=item --enable-plain-scroll 2387=item --enable-plain-scroll (default: on)
2312 2388
2313Add support for a very unobtrusive, plain-looking scrollbar that 2389Add support for a very unobtrusive, plain-looking scrollbar that
2314is the favourite of the rxvt-unicode author, having used it for 2390is the favourite of the rxvt-unicode author, having used it for
2315many years. 2391many years.
2316 2392
2317=item --enable-half-shadow 2393=item --enable-ttygid (default: off)
2318
2319Make shadows on the scrollbar only half the normal width & height.
2320only applicable to rxvt scrollbars.
2321
2322=item --enable-ttygid
2323 2394
2324Change tty device setting to group "tty" - only use this if 2395Change tty device setting to group "tty" - only use this if
2325your system uses this type of security. 2396your system uses this type of security.
2326 2397
2327=item --disable-backspace-key 2398=item --disable-backspace-key
2328 2399
2329Disable 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
2330do it. 2405do it.
2331 2406
2332=item --disable-delete-key
2333
2334Disable any handling of the delete key by us - let the X server
2335do it.
2336
2337=item --disable-resources 2407=item --disable-resources
2338 2408
2339Remove all resources checking. 2409Removes any support for resource checking.
2340
2341=item --enable-xgetdefault
2342
2343Make resources checking via XGetDefault() instead of our small
2344version which only checks ~/.Xdefaults, or if that doesn't exist then
2345~/.Xresources.
2346
2347Please note that nowadays, things like XIM will automatically pull in and
2348use the full X resource manager, so the overhead of using it might be very
2349small, if nonexistant.
2350
2351=item --enable-strings
2352
2353Add support for our possibly faster memset() function and other
2354various routines, overriding your system's versions which may
2355have been hand-crafted in assembly or may require extra libraries
2356to link in. (this breaks ANSI-C rules and has problems on many
2357GNU/Linux systems).
2358 2410
2359=item --disable-swapscreen 2411=item --disable-swapscreen
2360 2412
2361Remove support for swap screen. 2413Remove support for secondary/swap screen.
2362 2414
2363=item --enable-frills 2415=item --enable-frills (default: on)
2364 2416
2365Add 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
2366have. 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
2367disable this. 2419disable this.
2368 2420
2369A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2421A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2370in combination with other switches) is: 2422in combination with other switches) is:
2371 2423
2372 MWM-hints 2424 MWM-hints
2425 EWMH-hints (pid, utf8 names) and protocols (ping)
2426 urgency hint
2373 seperate underline colour 2427 seperate underline colour (-underlineColor)
2374 settable border widths and borderless switch 2428 settable border widths and borderless switch (-w, -b, -bl)
2429 visual depth selection (-depth)
2375 settable extra linespacing 2430 settable extra linespacing /-lsp)
2376 extra window properties (e.g. UTF-8 window names and PID) 2431 iso-14755 5.1 (basic) support
2377 iso-14755-2 and -3, and visual feedback
2378 backindex and forwardindex escape sequence
2379 window op and locale change escape sequences
2380 tripleclickwords 2432 tripleclickwords (-tcw)
2381 settable insecure mode 2433 settable insecure mode (-insecure)
2382 keysym remapping support 2434 keysym remapping support
2383 -embed and -pty-fd options 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)
2384 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
2449 backindex and forwardindex escape sequences
2450 view change/zero scrollback escape sequences
2451 locale switching escape sequence
2452 window op and some xterm/OSC escape sequences
2453 rectangular selections
2454 trailing space removal for selections
2455 verbose X error handling
2456
2385=item --enable-iso14755 2457=item --enable-iso14755 (default: on)
2386 2458
2387Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2459Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2388F<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
2389C<--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
2390this switch. 2462this switch.
2391 2463
2392=item --enable-keepscrolling 2464=item --enable-keepscrolling (default: on)
2393 2465
2394Add support for continual scrolling of the display when you hold 2466Add support for continual scrolling of the display when you hold
2395the mouse button down on a scrollbar arrow. 2467the mouse button down on a scrollbar arrow.
2396 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
2397=item --enable-mousewheel 2474=item --enable-mousewheel (default: on)
2398 2475
2399Add support for scrolling via mouse wheel or buttons 4 & 5. 2476Add support for scrolling via mouse wheel or buttons 4 & 5.
2400 2477
2401=item --enable-slipwheeling 2478=item --enable-slipwheeling (default: on)
2402 2479
2403Add support for continual scrolling (using the mouse wheel as an 2480Add support for continual scrolling (using the mouse wheel as an
2404accelerator) while the control key is held down. This option 2481accelerator) while the control key is held down. This option
2405requires --enable-mousewheel to also be specified. 2482requires --enable-mousewheel to also be specified.
2406 2483
2407=item --disable-new-selection
2408
2409Remove support for mouse selection style like that of xterm.
2410
2411=item --enable-dmalloc
2412
2413Use Gray Watson's malloc - which is good for debugging See
2414http://www.letters.com/dmalloc/ for details If you use either this or the
2415next option, you may need to edit src/Makefile after compiling to point
2416DINCLUDE and DLIB to the right places.
2417
2418You can only use either this option and the following (should
2419you use either) .
2420
2421=item --enable-dlmalloc
2422
2423Use Doug Lea's malloc - which is good for a production version
2424See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2425
2426=item --enable-smart-resize 2484=item --enable-smart-resize (default: off)
2427 2485
2428Add smart growth/shrink behaviour when changing font size via from hot 2486Add smart growth/shrink behaviour when resizing.
2429keys. 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
2430closest to a corner of the screen. 2488the screen in a fixed position.
2431 2489
2432=item --enable-cursor-blink
2433
2434Add support for a blinking cursor.
2435
2436=item --enable-pointer-blank 2490=item --enable-pointer-blank (default: on)
2437 2491
2438Add support to have the pointer disappear when typing or inactive. 2492Add support to have the pointer disappear when typing or inactive.
2439 2493
2440=item --with-name=NAME 2494=item --enable-perl (default: on)
2441 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
2442Set the basename for the installed binaries (default: C<urxvt>, resulting 2511Set the basename for the installed binaries, resulting
2443in 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
2444C<rxvt>. 2513C<rxvt>.
2445 2514
2446=item --with-term=NAME 2515=item --with-term=NAME (default: rxvt-unicode)
2447 2516
2448Change the environmental variable for the terminal to NAME (default 2517Change the environmental variable for the terminal to NAME.
2449C<rxvt-unicode>)
2450 2518
2451=item --with-terminfo=PATH 2519=item --with-terminfo=PATH
2452 2520
2453Change the environmental variable for the path to the terminfo tree to 2521Change the environmental variable for the path to the terminfo tree to
2454PATH. 2522PATH.
2455 2523
2456=item --with-x 2524=item --with-x
2457 2525
2458Use the X Window System (pretty much default, eh?). 2526Use the X Window System (pretty much default, eh?).
2459
2460=item --with-xpm-includes=DIR
2461
2462Look for the XPM includes in DIR.
2463
2464=item --with-xpm-library=DIR
2465
2466Look for the XPM library in DIR.
2467
2468=item --with-xpm
2469
2470Not needed - define via --enable-xpm-background.
2471 2527
2472=back 2528=back
2473 2529
2474=head1 AUTHORS 2530=head1 AUTHORS
2475 2531

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines