ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.pod
(Generate patch)

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines