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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.56 by root, Wed Jul 13 01:01:41 2005 UTC vs.
Revision 1.146 by root, Mon Sep 10 13:05:51 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines