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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines