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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines