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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines