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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines