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.54 by root, Tue Jun 21 18:25:09 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 How does rxvt-unicode determine the encoding to use? 1195=head3 How can I use rxvt-unicode under cygwin?
345 1196
346=item Is there an option to switch encodings? 1197rxvt-unicode should compile and run out of the box on cygwin, using
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.
347 1203
348Unlike some other terminals, rxvt-unicode has no encoding switch, and no 1204At the time of this writing, cygwin didn't seem to support any multi-byte
349specific "utf-8" mode, such as xterm. In fact, it doesn't even know about 1205encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
350UTF-8 or any other encodings with respect to terminal I/O. 1206to 8-bit encodings.
351 1207
352The reasons is that there exists a perfectly fine mechanism for selecting 1208=head3 Character widths are not correct.
353the encoding, doing I/O and (most important) communicating this to all
354applications so everybody agrees on character properties such as width
355and code number. This mechanism is the I<locale>. Applications not using
356that info will have problems (for example, C<xterm> gets the width of
357characters wrong as it uses it's own, locale-independent table under all
358locales).
359 1209
360Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All 1210urxvt uses the system wcwidth function to know the information about
361programs doing the same (that is, most) will automatically agree in the 1211the width of characters, so on systems with incorrect locale data you
362interpretation of characters. 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.
363 1215
364Unfortunately, there is no system-independent way to select locales, nor 1216The solution is to upgrade your system or switch to a better one. A
365is there a standard on how locale specifiers will look like. 1217possibly working workaround is to use a wcwidth implementation like
366 1218
367On most systems, the content of the C<LC_CTYPE> environment variable 1219http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
368contains an arbitrary string which corresponds to an already-installed
369locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
370C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
371(i.e. C<de> or C<german>) are also common.
372 1220
373Rxvt-unicode ignores all other locale categories, and except for
374the encoding, ignores country or language-specific settings,
375i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
376rxvt-unicode.
377
378If you want to use a specific encoding you have to make sure you start
379rxvt-unicode with the correct C<LC_CTYPE> category.
380
381=item Can I switch locales at runtime?
382
383Yes, using an escape sequence. Try something like this, which sets
384rxvt-unicode's idea of C<LC_CTYPE>.
385
386 printf '\e]701;%s\007' ja_JP.SJIS
387
388See also the previous answer.
389
390Sometimes this capability is rather handy when you want to work in
391one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
392(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
393first switches to a locale supported by xjdic and back later:
394
395 printf '\e]701;%s\007' ja_JP.SJIS
396 xjdic -js
397 printf '\e]701;%s\007' de_DE.UTF-8
398
399You can also use xterm's C<luit> program, which usually works fine, except
400for some locales where character width differs between program- and
401rxvt-unicode-locales.
402
403=item Can I switch the fonts at runtime?
404
405Yes, using an escape sequence. Try something like this, which has the same
406effect as using the C<-fn> switch, and takes effect immediately:
407
408 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
409
410This is useful if you e.g. work primarily with japanese (and prefer a
411japanese font), but you have to switch to chinese temporarily, where
412japanese fonts would only be in your way.
413
414You can think of this as a kind of manual ISO-2022 switching.
415
416=item Why do italic characters look as if clipped?
417
418Many fonts have difficulties with italic characters and hinting. For
419example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
420Mono> completely fails in it's italic face. A workaround might be to
421enable freetype autohinting, i.e. like this:
422
423 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
424 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
425
426=item My input method wants <some encoding> but I want UTF-8, what can I do?
427
428You can specify separate locales for the input method and the rest of the
429terminal, using the resource C<imlocale>:
430
431 URxvt*imlocale: ja_JP.EUC-JP
432
433Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
434use your input method. Please note, however, that you will not be able to
435input characters outside C<EUC-JP> in a normal way then, as your input
436method limits you.
437
438=item Rxvt-unicode crashes when the X Input Method changes or exits.
439
440Unfortunately, this is unavoidable, as the XIM protocol is racy by
441design. Applications can avoid some crashes at the expense of memory
442leaks, and Input Methods can avoid some crashes by careful ordering at
443exit time. B<kinput2> (and derived input methods) generally succeeds,
444while B<SCIM> (or similar input methods) fails. In the end, however,
445crashes cannot be completely avoided even if both sides cooperate.
446
447So the only workaround is not to kill your Input Method Servers.
448
449=item Rxvt-unicode uses gobs of memory, how can I reduce that?
450
451Rxvt-unicode tries to obey the rule of not charging you for something you
452don't use. One thing you should try is to configure out all settings that
453you don't need, for example, Xft support is a resource hog by design,
454when used. Compiling it out ensures that no Xft font will be loaded
455accidentally when rxvt-unicode tries to find a font for your characters.
456
457Also, many people (me included) like large windows and even larger
458scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
4596 bytes per screen cell. For a 160x?? window this amounts to almost a
460kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
461use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
462rxvt-unicode then uses 8 bytes per screen cell.
463
464=item Can I speed up Xft rendering somehow?
465
466Yes, the most obvious way to speed it up is to avoid Xft entirely, as
467it is simply slow. If you still want Xft fonts you might try to disable
468antialiasing (by appending C<:antialiasing=false>), which saves lots of
469memory and also speeds up rendering considerably.
470
471=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
472
473Rxvt-unicode will use whatever you specify as a font. If it needs to
474fall back to it's default font search list it will prefer X11 core
475fonts, because they are small and fast, and then use Xft fonts. It has
476antialiasing disabled for most of them, because the author thinks they
477look best that way.
478
479If you want antialiasing, you have to specify the fonts manually.
480
481=item Mouse cut/paste suddenly no longer works.
482
483Make sure that mouse reporting is actually turned off since killing
484some editors prematurely may leave the mouse in mouse report mode. I've
485heard that tcsh may use mouse reporting unless it otherwise specified. A
486quick check is to see if cut/paste works when the Alt or Shift keys are
487depressed. See @@RXVT_NAME@@(7)
488
489=item What's with this bold/blink stuff?
490
491If no bold colour is set via C<colorBD:>, bold will invert text using the
492standard foreground colour.
493
494For the standard background colour, blinking will actually make the
495text blink when compiled with C<--enable-blinking>. with standard
496colours. Without C<--enable-blinking>, the blink attribute will be
497ignored.
498
499On ANSI colours, bold/blink attributes are used to set high-intensity
500foreground/background colors.
501
502color0-7 are the low-intensity colors.
503
504color8-15 are the corresponding high-intensity colors.
505
506=item I don't like the screen colors. How do I change them?
507
508You can change the screen colors at run-time using F<~/.Xdefaults>
509resources (or as long-options).
510
511Here are values that are supposed to resemble a VGA screen,
512including the murky brown that passes for low-intensity yellow:
513
514 URxvt.color0: #000000
515 URxvt.color1: #A80000
516 URxvt.color2: #00A800
517 URxvt.color3: #A8A800
518 URxvt.color4: #0000A8
519 URxvt.color5: #A800A8
520 URxvt.color6: #00A8A8
521 URxvt.color7: #A8A8A8
522
523 URxvt.color8: #000054
524 URxvt.color9: #FF0054
525 URxvt.color10: #00FF54
526 URxvt.color11: #FFFF54
527 URxvt.color12: #0000FF
528 URxvt.color13: #FF00FF
529 URxvt.color14: #00FFFF
530 URxvt.color15: #FFFFFF
531
532And here is a more complete set of non-standard colors described (not by
533me) as "pretty girly".
534
535 URxvt.cursorColor: #dc74d1
536 URxvt.pointerColor: #dc74d1
537 URxvt.background: #0e0e0e
538 URxvt.foreground: #4ad5e1
539 URxvt.color0: #000000
540 URxvt.color8: #8b8f93
541 URxvt.color1: #dc74d1
542 URxvt.color9: #dc74d1
543 URxvt.color2: #0eb8c7
544 URxvt.color10: #0eb8c7
545 URxvt.color3: #dfe37e
546 URxvt.color11: #dfe37e
547 URxvt.color5: #9e88f0
548 URxvt.color13: #9e88f0
549 URxvt.color6: #73f7ff
550 URxvt.color14: #73f7ff
551 URxvt.color7: #e1dddd
552 URxvt.color15: #e1dddd
553
554=item How can I start @@RXVT_NAME@@d in a race-free way?
555
556Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a
557server that answers @@RXVT_NAME@@c's requests, so it doesn't background
558itself.
559
560To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the
561following method to wait for the startup message before continuing:
562
563 { @@RXVT_NAME@@d & } | read
564
565=item What's with the strange Backspace/Delete key behaviour?
566
567Assuming that the physical Backspace key corresponds to the
568BackSpace keysym (not likely for Linux ... see the following
569question) there are two standard values that can be used for
570Backspace: C<^H> and C<^?>.
571
572Historically, either value is correct, but rxvt-unicode adopts the debian
573policy of using C<^?> when unsure, because it's the one only only correct
574choice :).
575
576Rxvt-unicode tries to inherit the current stty settings and uses the value
577of `erase' to guess the value for backspace. If rxvt-unicode wasn't
578started from a terminal (say, from a menu or by remote shell), then the
579system value of `erase', which corresponds to CERASE in <termios.h>, will
580be used (which may not be the same as your stty setting).
581
582For starting a new rxvt-unicode:
583
584 # use Backspace = ^H
585 $ stty erase ^H
586 $ @@RXVT_NAME@@
587
588 # use Backspace = ^?
589 $ stty erase ^?
590 $ @@RXVT_NAME@@
591
592Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).
593
594For an existing rxvt-unicode:
595
596 # use Backspace = ^H
597 $ stty erase ^H
598 $ echo -n "^[[36h"
599
600 # use Backspace = ^?
601 $ stty erase ^?
602 $ echo -n "^[[36l"
603
604This helps satisfy some of the Backspace discrepancies that occur, but
605if you use Backspace = C<^H>, make sure that the termcap/terminfo value
606properly reflects that.
607
608The Delete key is a another casualty of the ill-defined Backspace problem.
609To avoid confusion between the Backspace and Delete keys, the Delete
610key has been assigned an escape sequence to match the vt100 for Execute
611(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
612
613Some other Backspace problems:
614
615some editors use termcap/terminfo,
616some editors (vim I'm told) expect Backspace = ^H,
617GNU Emacs (and Emacs-like editors) use ^H for help.
618
619Perhaps someday this will all be resolved in a consistent manner.
620
621=item I don't like the key-bindings. How do I change them?
622
623There are some compile-time selections available via configure. Unless
624you have run "configure" with the C<--disable-resources> option you can
625use the `keysym' resource to alter the keystrings associated with keysyms.
626
627Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
628
629 URxvt.keysym.Home: \033[1~
630 URxvt.keysym.End: \033[4~
631 URxvt.keysym.C-apostrophe: \033<C-'>
632 URxvt.keysym.C-slash: \033<C-/>
633 URxvt.keysym.C-semicolon: \033<C-;>
634 URxvt.keysym.C-grave: \033<C-`>
635 URxvt.keysym.C-comma: \033<C-,>
636 URxvt.keysym.C-period: \033<C-.>
637 URxvt.keysym.C-0x60: \033<C-`>
638 URxvt.keysym.C-Tab: \033<C-Tab>
639 URxvt.keysym.C-Return: \033<C-Return>
640 URxvt.keysym.S-Return: \033<S-Return>
641 URxvt.keysym.S-space: \033<S-Space>
642 URxvt.keysym.M-Up: \033<M-Up>
643 URxvt.keysym.M-Down: \033<M-Down>
644 URxvt.keysym.M-Left: \033<M-Left>
645 URxvt.keysym.M-Right: \033<M-Right>
646 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
647 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
648 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
649
650See some more examples in the documentation for the B<keysym> resource.
651
652=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
653How do I make use of them? For example, the Sun Keyboard type 4
654has the following mappings that rxvt-unicode doesn't recognize.
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=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
668I need this to decide about setting colors etc.
669
670rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
671check and see if that is set. Note that several programs, JED, slrn,
672Midnight Commander automatically check this variable to decide whether or
673not to use color.
674
675=item How do I set the correct, full IP address for the DISPLAY variable?
676
677If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
678insecure mode then it is possible to use the following shell script
679snippets to correctly set the display. If your version of rxvt-unicode
680wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
681the COLORTERM variable can be used to distinguish rxvt-unicode from a
682regular xterm.
683
684Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
685snippets:
686
687 # Bourne/Korn/POSIX family of shells:
688 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
689 if [ ${TERM:-foo} = xterm ]; then
690 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
691 echo -n '^[Z'
692 read term_id
693 stty icanon echo
694 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
695 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
696 read DISPLAY # set it in our local shell
697 fi
698 fi
699
700=item How do I compile the manual pages for myself?
701
702You need to have a recent version of perl installed as F</usr/bin/perl>,
703one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
704the doc subdirectory and enter C<make alldoc>.
705
706=item My question isn't answered here, can I ask a human?
707
708Before sending me mail, you could go to IRC: C<irc.freenode.net>,
709channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
710interested in learning about new and exciting problems (but not FAQs :).
711
712=back
713
714=head1 RXVT TECHNICAL REFERENCE 1221=head1 RXVT-UNICODE TECHNICAL REFERENCE
715
716=head1 DESCRIPTION
717 1222
718The rest of this document describes various technical aspects of 1223The rest of this document describes various technical aspects of
719B<rxvt-unicode>. First the description of supported command sequences, 1224B<rxvt-unicode>. First the description of supported command sequences,
720followed by menu and pixmap support and last by a description of all 1225followed by pixmap support and last by a description of all features
721features selectable at C<configure> time. 1226selectable at C<configure> time.
722 1227
723=head1 Definitions 1228=head2 Definitions
724 1229
725=over 4 1230=over 4
726 1231
727=item B<< C<c> >> 1232=item B<< C<c> >>
728 1233
746 1251
747A text parameter composed of printable characters. 1252A text parameter composed of printable characters.
748 1253
749=back 1254=back
750 1255
751=head1 Values 1256=head2 Values
752 1257
753=over 4 1258=over 4
754 1259
755=item B<< C<ENQ> >> 1260=item B<< C<ENQ> >>
756 1261
799 1304
800Space Character 1305Space Character
801 1306
802=back 1307=back
803 1308
804=head1 Escape Sequences 1309=head2 Escape Sequences
805 1310
806=over 4 1311=over 4
807 1312
808=item B<< C<ESC # 8> >> 1313=item B<< C<ESC # 8> >>
809 1314
907 1412
908=back 1413=back
909 1414
910X<CSI> 1415X<CSI>
911 1416
912=head1 CSI (Command Sequence Introducer) Sequences 1417=head2 CSI (Command Sequence Introducer) Sequences
913 1418
914=over 4 1419=over 4
915 1420
916=item B<< C<ESC [ Ps @> >> 1421=item B<< C<ESC [ Ps @> >>
917 1422
1187 1692
1188=back 1693=back
1189 1694
1190X<PrivateModes> 1695X<PrivateModes>
1191 1696
1192=head1 DEC Private Modes 1697=head2 DEC Private Modes
1193 1698
1194=over 4 1699=over 4
1195 1700
1196=item B<< C<ESC [ ? Pm h> >> 1701=item B<< C<ESC [ ? Pm h> >>
1197 1702
1213 1718
1214Toggle DEC Private Mode Values (rxvt extension). I<where> 1719Toggle DEC Private Mode Values (rxvt extension). I<where>
1215 1720
1216=over 4 1721=over 4
1217 1722
1218=item B<< C<Ps = 1> >> (DECCKM) 1723=item B<< C<Pm = 1> >> (DECCKM)
1219 1724
1220=begin table 1725=begin table
1221 1726
1222 B<< C<h> >> Application Cursor Keys 1727 B<< C<h> >> Application Cursor Keys
1223 B<< C<l> >> Normal Cursor Keys 1728 B<< C<l> >> Normal Cursor Keys
1224 1729
1225=end table 1730=end table
1226 1731
1227=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1732=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1228 1733
1229=begin table 1734=begin table
1230 1735
1231 B<< C<h> >> Enter VT52 mode 1736 B<< C<h> >> Enter VT52 mode
1232 B<< C<l> >> Enter VT52 mode 1737 B<< C<l> >> Enter VT52 mode
1233 1738
1234=end table 1739=end table
1235 1740
1236=item B<< C<Ps = 3> >> 1741=item B<< C<Pm = 3> >>
1237 1742
1238=begin table 1743=begin table
1239 1744
1240 B<< C<h> >> 132 Column Mode (DECCOLM) 1745 B<< C<h> >> 132 Column Mode (DECCOLM)
1241 B<< C<l> >> 80 Column Mode (DECCOLM) 1746 B<< C<l> >> 80 Column Mode (DECCOLM)
1242 1747
1243=end table 1748=end table
1244 1749
1245=item B<< C<Ps = 4> >> 1750=item B<< C<Pm = 4> >>
1246 1751
1247=begin table 1752=begin table
1248 1753
1249 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1754 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1250 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1755 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1251 1756
1252=end table 1757=end table
1253 1758
1254=item B<< C<Ps = 5> >> 1759=item B<< C<Pm = 5> >>
1255 1760
1256=begin table 1761=begin table
1257 1762
1258 B<< C<h> >> Reverse Video (DECSCNM) 1763 B<< C<h> >> Reverse Video (DECSCNM)
1259 B<< C<l> >> Normal Video (DECSCNM) 1764 B<< C<l> >> Normal Video (DECSCNM)
1260 1765
1261=end table 1766=end table
1262 1767
1263=item B<< C<Ps = 6> >> 1768=item B<< C<Pm = 6> >>
1264 1769
1265=begin table 1770=begin table
1266 1771
1267 B<< C<h> >> Origin Mode (DECOM) 1772 B<< C<h> >> Origin Mode (DECOM)
1268 B<< C<l> >> Normal Cursor Mode (DECOM) 1773 B<< C<l> >> Normal Cursor Mode (DECOM)
1269 1774
1270=end table 1775=end table
1271 1776
1272=item B<< C<Ps = 7> >> 1777=item B<< C<Pm = 7> >>
1273 1778
1274=begin table 1779=begin table
1275 1780
1276 B<< C<h> >> Wraparound Mode (DECAWM) 1781 B<< C<h> >> Wraparound Mode (DECAWM)
1277 B<< C<l> >> No Wraparound Mode (DECAWM) 1782 B<< C<l> >> No Wraparound Mode (DECAWM)
1278 1783
1279=end table 1784=end table
1280 1785
1281=item B<< C<Ps = 8> >> I<unimplemented> 1786=item B<< C<Pm = 8> >> I<unimplemented>
1282 1787
1283=begin table 1788=begin table
1284 1789
1285 B<< C<h> >> Auto-repeat Keys (DECARM) 1790 B<< C<h> >> Auto-repeat Keys (DECARM)
1286 B<< C<l> >> No Auto-repeat Keys (DECARM) 1791 B<< C<l> >> No Auto-repeat Keys (DECARM)
1287 1792
1288=end table 1793=end table
1289 1794
1290=item B<< C<Ps = 9> >> X10 XTerm 1795=item B<< C<Pm = 9> >> X10 XTerm
1291 1796
1292=begin table 1797=begin table
1293 1798
1294 B<< C<h> >> Send Mouse X & Y on button press. 1799 B<< C<h> >> Send Mouse X & Y on button press.
1295 B<< C<l> >> No mouse reporting. 1800 B<< C<l> >> No mouse reporting.
1296 1801
1297=end table 1802=end table
1298 1803
1299=item B<< C<Ps = 10> >> (B<rxvt>)
1300
1301=begin table
1302
1303 B<< C<h> >> menuBar visible
1304 B<< C<l> >> menuBar invisible
1305
1306=end table
1307
1308=item B<< C<Ps = 25> >> 1804=item B<< C<Pm = 25> >>
1309 1805
1310=begin table 1806=begin table
1311 1807
1312 B<< C<h> >> Visible cursor {cnorm/cvvis} 1808 B<< C<h> >> Visible cursor {cnorm/cvvis}
1313 B<< C<l> >> Invisible cursor {civis} 1809 B<< C<l> >> Invisible cursor {civis}
1314 1810
1315=end table 1811=end table
1316 1812
1317=item B<< C<Ps = 30> >> 1813=item B<< C<Pm = 30> >>
1318 1814
1319=begin table 1815=begin table
1320 1816
1321 B<< C<h> >> scrollBar visisble 1817 B<< C<h> >> scrollBar visible
1322 B<< C<l> >> scrollBar invisisble 1818 B<< C<l> >> scrollBar invisible
1323 1819
1324=end table 1820=end table
1325 1821
1326=item B<< C<Ps = 35> >> (B<rxvt>) 1822=item B<< C<Pm = 35> >> (B<rxvt>)
1327 1823
1328=begin table 1824=begin table
1329 1825
1330 B<< C<h> >> Allow XTerm Shift+key sequences 1826 B<< C<h> >> Allow XTerm Shift+key sequences
1331 B<< C<l> >> Disallow XTerm Shift+key sequences 1827 B<< C<l> >> Disallow XTerm Shift+key sequences
1332 1828
1333=end table 1829=end table
1334 1830
1335=item B<< C<Ps = 38> >> I<unimplemented> 1831=item B<< C<Pm = 38> >> I<unimplemented>
1336 1832
1337Enter Tektronix Mode (DECTEK) 1833Enter Tektronix Mode (DECTEK)
1338 1834
1339=item B<< C<Ps = 40> >> 1835=item B<< C<Pm = 40> >>
1340 1836
1341=begin table 1837=begin table
1342 1838
1343 B<< C<h> >> Allow 80/132 Mode 1839 B<< C<h> >> Allow 80/132 Mode
1344 B<< C<l> >> Disallow 80/132 Mode 1840 B<< C<l> >> Disallow 80/132 Mode
1345 1841
1346=end table 1842=end table
1347 1843
1348=item B<< C<Ps = 44> >> I<unimplemented> 1844=item B<< C<Pm = 44> >> I<unimplemented>
1349 1845
1350=begin table 1846=begin table
1351 1847
1352 B<< C<h> >> Turn On Margin Bell 1848 B<< C<h> >> Turn On Margin Bell
1353 B<< C<l> >> Turn Off Margin Bell 1849 B<< C<l> >> Turn Off Margin Bell
1354 1850
1355=end table 1851=end table
1356 1852
1357=item B<< C<Ps = 45> >> I<unimplemented> 1853=item B<< C<Pm = 45> >> I<unimplemented>
1358 1854
1359=begin table 1855=begin table
1360 1856
1361 B<< C<h> >> Reverse-wraparound Mode 1857 B<< C<h> >> Reverse-wraparound Mode
1362 B<< C<l> >> No Reverse-wraparound Mode 1858 B<< C<l> >> No Reverse-wraparound Mode
1363 1859
1364=end table 1860=end table
1365 1861
1366=item B<< C<Ps = 46> >> I<unimplemented> 1862=item B<< C<Pm = 46> >> I<unimplemented>
1367 1863
1368=item B<< C<Ps = 47> >> 1864=item B<< C<Pm = 47> >>
1369 1865
1370=begin table 1866=begin table
1371 1867
1372 B<< C<h> >> Use Alternate Screen Buffer 1868 B<< C<h> >> Use Alternate Screen Buffer
1373 B<< C<l> >> Use Normal Screen Buffer 1869 B<< C<l> >> Use Normal Screen Buffer
1374 1870
1375=end table 1871=end table
1376 1872
1377X<Priv66> 1873X<Priv66>
1378 1874
1379=item B<< C<Ps = 66> >> 1875=item B<< C<Pm = 66> >>
1380 1876
1381=begin table 1877=begin table
1382 1878
1383 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1879 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1384 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1880 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1385 1881
1386=end table 1882=end table
1387 1883
1388=item B<< C<Ps = 67> >> 1884=item B<< C<Pm = 67> >>
1389 1885
1390=begin table 1886=begin table
1391 1887
1392 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1888 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1393 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1889 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1394 1890
1395=end table 1891=end table
1396 1892
1397=item B<< C<Ps = 1000> >> (X11 XTerm) 1893=item B<< C<Pm = 1000> >> (X11 XTerm)
1398 1894
1399=begin table 1895=begin table
1400 1896
1401 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.
1402 B<< C<l> >> No mouse reporting. 1898 B<< C<l> >> No mouse reporting.
1403 1899
1404=end table 1900=end table
1405 1901
1406=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1902=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1407 1903
1408=begin table 1904=begin table
1409 1905
1410 B<< C<h> >> Use Hilite Mouse Tracking. 1906 B<< C<h> >> Use Hilite Mouse Tracking.
1411 B<< C<l> >> No mouse reporting. 1907 B<< C<l> >> No mouse reporting.
1412 1908
1413=end table 1909=end table
1414 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
1415=item B<< C<Ps = 1010> >> (B<rxvt>) 1929=item B<< C<Pm = 1010> >> (B<rxvt>)
1416 1930
1417=begin table 1931=begin table
1418 1932
1419 B<< C<h> >> Don't scroll to bottom on TTY output 1933 B<< C<h> >> Don't scroll to bottom on TTY output
1420 B<< C<l> >> Scroll to bottom on TTY output 1934 B<< C<l> >> Scroll to bottom on TTY output
1421 1935
1422=end table 1936=end table
1423 1937
1424=item B<< C<Ps = 1011> >> (B<rxvt>) 1938=item B<< C<Pm = 1011> >> (B<rxvt>)
1425 1939
1426=begin table 1940=begin table
1427 1941
1428 B<< C<h> >> Scroll to bottom when a key is pressed 1942 B<< C<h> >> Scroll to bottom when a key is pressed
1429 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
1430 1944
1431=end table 1945=end table
1432 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
1433=item B<< C<Ps = 1047> >> 1956=item B<< C<Pm = 1047> >>
1434 1957
1435=begin table 1958=begin table
1436 1959
1437 B<< C<h> >> Use Alternate Screen Buffer 1960 B<< C<h> >> Use Alternate Screen Buffer
1438 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
1439 1962
1440=end table 1963=end table
1441 1964
1442=item B<< C<Ps = 1048> >> 1965=item B<< C<Pm = 1048> >>
1443 1966
1444=begin table 1967=begin table
1445 1968
1446 B<< C<h> >> Save cursor position 1969 B<< C<h> >> Save cursor position
1447 B<< C<l> >> Restore cursor position 1970 B<< C<l> >> Restore cursor position
1448 1971
1449=end table 1972=end table
1450 1973
1451=item B<< C<Ps = 1049> >> 1974=item B<< C<Pm = 1049> >>
1452 1975
1453=begin table 1976=begin table
1454 1977
1455 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
1456 B<< C<l> >> Use Normal Screen Buffer 1979 B<< C<l> >> Use Normal Screen Buffer
1461 1984
1462=back 1985=back
1463 1986
1464X<XTerm> 1987X<XTerm>
1465 1988
1466=head1 XTerm Operating System Commands 1989=head2 XTerm Operating System Commands
1467 1990
1468=over 4 1991=over 4
1469 1992
1470=item B<< C<ESC ] Ps;Pt ST> >> 1993=item B<< C<ESC ] Ps;Pt ST> >>
1471 1994
1478 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> >>
1479 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >> 2002 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1480 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> 2003 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
1481 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.
1482 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
1483 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> >>
1484 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> >>
1485 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> >>
1486 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> >>
1487 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> >>
1488 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]
1489 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]
1490 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).
1491 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]
1492 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>
1493 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]
1494 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> >>
1495 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> >>
1496 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).
1497 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>.
1498 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> >>
1499 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> >>
1500 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>.
1501 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).
1502 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).
1503 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).
1504 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).
1505 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).
1506 2032
1507=end table 2033=end table
1508 2034
1509=back 2035=back
1510 2036
1511X<menuBar> 2037=head1 BACKGROUND IMAGE
1512 2038
1513=head1 menuBar
1514
1515B<< The exact syntax used is I<almost> solidified. >>
1516In the menus, B<DON'T> try to use menuBar commands that add or remove a
1517menuBar.
1518
1519Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1520omitted: use B<./> to specify a menu relative to the current menu.
1521
1522=head2 Overview of menuBar operation
1523
1524For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1525of C<Pt> can be used for a variety of tasks:
1526
1527At the top level is the current menuBar which is a member of a circular
1528linked-list of other such menuBars.
1529
1530The menuBar acts as a parent for the various drop-down menus, which in
1531turn, may have labels, separator lines, menuItems and subMenus.
1532
1533The menuItems are the useful bits: you can use them to mimic keyboard
1534input or even to send text or escape sequences back to rxvt.
1535
1536The menuBar syntax is intended to provide a simple yet robust method of
1537constructing and manipulating menus and navigating through the
1538menuBars.
1539
1540The first step is to use the tag B<< [menu:I<name>] >> which creates
1541the menuBar called I<name> and allows access. You may now or menus,
1542subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1543menuBar access as B<readonly> to prevent accidental corruption of the
1544menus. To re-access the current menuBar for alterations, use the tag
1545B<[menu]>, make the alterations and then use B<[done]>
1546
1547X<menuBarCommands>
1548
1549=head2 Commands
1550
1551=over 4
1552
1553=item B<< [menu:+I<name>] >>
1554
1555access the named menuBar for creation or alteration. If a new menuBar
1556is created, it is called I<name> (max of 15 chars) and the current
1557menuBar is pushed onto the stack
1558
1559=item B<[menu]>
1560
1561access the current menuBar for alteration
1562
1563=item B<< [title:+I<string>] >>
1564
1565set the current menuBar's title to I<string>, which may contain the
1566following format specifiers:
1567
1568 B<%n> rxvt name (as per the B<-name> command-line option)
1569 B<%v> rxvt version
1570 B<%%> literal B<%> character
1571
1572=item B<[done]>
1573
1574set menuBar access as B<readonly>.
1575End-of-file tag for B<< [read:+I<file>] >> operations.
1576
1577=item B<< [read:+I<file>] >>
1578
1579read menu commands directly from I<file> (extension ".menu" will be
1580appended if required.) Start reading at a line with B<[menu]> or B<<
1581[menu:+I<name> >> and continuing until B<[done]> is encountered.
1582
1583Blank and comment lines (starting with B<#>) are ignored. Actually,
1584since any invalid menu commands are also ignored, almost anything could
1585be construed as a comment line, but this may be tightened up in the
1586future ... so don't count on it!.
1587
1588=item B<< [read:+I<file>;+I<name>] >>
1589
1590The same as B<< [read:+I<file>] >>, but start reading at a line with
1591B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1592B<[done]> is encountered.
1593
1594=item B<[dump]>
1595
1596dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1597later rereading.
1598
1599=item B<[rm:name]>
1600
1601remove the named menuBar
1602
1603=item B<[rm] [rm:]>
1604
1605remove the current menuBar
1606
1607=item B<[rm*] [rm:*]>
1608
1609remove all menuBars
1610
1611=item B<[swap]>
1612
1613swap the top two menuBars
1614
1615=item B<[prev]>
1616
1617access the previous menuBar
1618
1619=item B<[next]>
1620
1621access the next menuBar
1622
1623=item B<[show]>
1624
1625Enable display of the menuBar
1626
1627=item B<[hide]>
1628
1629Disable display of the menuBar
1630
1631=item B<< [pixmap:+I<name>] >>
1632
1633=item B<< [pixmap:+I<name>;I<scaling>] >>
1634
1635(set the background pixmap globally
1636
1637B<< A Future implementation I<may> make this local to the menubar >>)
1638
1639=item B<< [:+I<command>:] >>
1640
1641ignore the menu readonly status and issue a I<command> to or a menu or
1642menuitem or change the ; a useful shortcut for setting the quick arrows
1643from a menuBar.
1644
1645=back
1646
1647X<menuBarAdd>
1648
1649=head2 Adding and accessing menus
1650
1651The following commands may also be B<+> prefixed.
1652
1653=over 4
1654
1655=item B</+>
1656
1657access menuBar top level
1658
1659=item B<./+>
1660
1661access current menu level
1662
1663=item B<../+>
1664
1665access parent menu (1 level up)
1666
1667=item B<../../>
1668
1669access parent menu (multiple levels up)
1670
1671=item B<< I</path/>menu >>
1672
1673add/access menu
1674
1675=item B<< I</path/>menu/* >>
1676
1677add/access menu and clear it if it exists
1678
1679=item B<< I</path/>{-} >>
1680
1681add separator
1682
1683=item B<< I</path/>{item} >>
1684
1685add B<item> as a label
1686
1687=item B<< I</path/>{item} action >>
1688
1689add/alter I<menuitem> with an associated I<action>
1690
1691=item B<< I</path/>{item}{right-text} >>
1692
1693add/alter I<menuitem> with B<right-text> as the right-justified text
1694and as the associated I<action>
1695
1696=item B<< I</path/>{item}{rtext} action >>
1697
1698add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1699the right-justified text.
1700
1701=back
1702
1703=over 4
1704
1705=item Special characters in I<action> must be backslash-escaped:
1706
1707B<\a \b \E \e \n \r \t \octal>
1708
1709=item or in control-character notation:
1710
1711B<^@, ^A .. ^Z .. ^_, ^?>
1712
1713=back
1714
1715To send a string starting with a B<NUL> (B<^@>) character to the
1716program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1717the first of which will be stripped off and the balance directed to the
1718program. Otherwise if I<action> begins with B<NUL> followed by
1719non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1720balance is sent back to rxvt.
1721
1722As a convenience for the many Emacs-type editors, I<action> may start
1723with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1724appended if missed from B<M-x> commands.
1725
1726As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1727quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1728
1729=over 4
1730
1731=item For example,
1732
1733B<M-xapropos> is equivalent to B<\Exapropos\r>
1734
1735=item and
1736
1737B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1738
1739=back
1740
1741The option B<< {I<right-rtext>} >> will be right-justified. In the
1742absence of a specified action, this text will be used as the I<action>
1743as well.
1744
1745=over 4
1746
1747=item For example,
1748
1749B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1750
1751=back
1752
1753The left label I<is> necessary, since it's used for matching, but
1754implicitly hiding the left label (by using same name for both left and
1755right labels), or explicitly hiding the left label (by preceeding it
1756with a dot), makes it possible to have right-justified text only.
1757
1758=over 4
1759
1760=item For example,
1761
1762B</File/{Open}{Open} Open-File-Action>
1763
1764=item or hiding it
1765
1766B</File/{.anylabel}{Open} Open-File-Action>
1767
1768=back
1769
1770X<menuBarRemove>
1771
1772=head2 Removing menus
1773
1774=over 4
1775
1776=item B<< -/*+ >>
1777
1778remove all menus from the menuBar, the same as B<[clear]>
1779
1780=item B<< -+I</path>menu+ >>
1781
1782remove menu
1783
1784=item B<< -+I</path>{item}+ >>
1785
1786remove item
1787
1788=item B<< -+I</path>{-} >>
1789
1790remove separator)
1791
1792=item B<-/path/menu/*>
1793
1794remove all items, separators and submenus from menu
1795
1796=back
1797
1798X<menuBarArrows>
1799
1800=head2 Quick Arrows
1801
1802The menus also provide a hook for I<quick arrows> to provide easier
1803user access. If nothing has been explicitly set, the default is to
1804emulate the curror keys. The syntax permits each arrow to be altered
1805individually or all four at once without re-entering their common
1806beginning/end text. For example, to explicitly associate cursor actions
1807with the arrows, any of the following forms could be used:
1808
1809=over 4
1810
1811=item B<< <r>+I<Right> >>
1812
1813=item B<< <l>+I<Left> >>
1814
1815=item B<< <u>+I<Up> >>
1816
1817=item B<< <d>+I<Down> >>
1818
1819Define actions for the respective arrow buttons
1820
1821=item B<< <b>+I<Begin> >>
1822
1823=item B<< <e>+I<End> >>
1824
1825Define common beginning/end parts for I<quick arrows> which used in
1826conjunction with the above <r> <l> <u> <d> constructs
1827
1828=back
1829
1830=over 4
1831
1832=item For example, define arrows individually,
1833
1834 <u>\E[A
1835
1836 <d>\E[B
1837
1838 <r>\E[C
1839
1840 <l>\E[D
1841
1842=item or all at once
1843
1844 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1845
1846=item or more compactly (factoring out common parts)
1847
1848 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1849
1850=back
1851
1852X<menuBarSummary>
1853
1854=head2 Command Summary
1855
1856A short summary of the most I<common> commands:
1857
1858=over 4
1859
1860=item [menu:name]
1861
1862use an existing named menuBar or start a new one
1863
1864=item [menu]
1865
1866use the current menuBar
1867
1868=item [title:string]
1869
1870set menuBar title
1871
1872=item [done]
1873
1874set menu access to readonly and, if reading from a file, signal EOF
1875
1876=item [done:name]
1877
1878if reading from a file using [read:file;name] signal EOF
1879
1880=item [rm:name]
1881
1882remove named menuBar(s)
1883
1884=item [rm] [rm:]
1885
1886remove current menuBar
1887
1888=item [rm*] [rm:*]
1889
1890remove all menuBar(s)
1891
1892=item [swap]
1893
1894swap top two menuBars
1895
1896=item [prev]
1897
1898access the previous menuBar
1899
1900=item [next]
1901
1902access the next menuBar
1903
1904=item [show]
1905
1906map menuBar
1907
1908=item [hide]
1909
1910unmap menuBar
1911
1912=item [pixmap;file]
1913
1914=item [pixmap;file;scaling]
1915
1916set a background pixmap
1917
1918=item [read:file]
1919
1920=item [read:file;name]
1921
1922read in a menu from a file
1923
1924=item [dump]
1925
1926dump out all menuBars to /tmp/rxvt-PID
1927
1928=item /
1929
1930access menuBar top level
1931
1932=item ./
1933
1934=item ../
1935
1936=item ../../
1937
1938access current or parent menu level
1939
1940=item /path/menu
1941
1942add/access menu
1943
1944=item /path/{-}
1945
1946add separator
1947
1948=item /path/{item}{rtext} action
1949
1950add/alter menu item
1951
1952=item -/*
1953
1954remove all menus from the menuBar
1955
1956=item -/path/menu
1957
1958remove menu items, separators and submenus from menu
1959
1960=item -/path/menu
1961
1962remove menu
1963
1964=item -/path/{item}
1965
1966remove item
1967
1968=item -/path/{-}
1969
1970remove separator
1971
1972=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1973
1974menu quick arrows
1975
1976=back
1977X<XPM>
1978
1979=head1 XPM
1980
1981For 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
1982of 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
1983sequence of scaling/positioning commands separated by semi-colons. The 2041sequence of scaling/positioning commands separated by semi-colons. The
1984scaling/positioning commands are as follows: 2042scaling/positioning commands are as follows:
1985 2043
1986=over 4 2044=over 4
1987 2045
2025 2083
2026For example: 2084For example:
2027 2085
2028=over 4 2086=over 4
2029 2087
2030=item B<\E]20;funky\a> 2088=item B<\E]20;funky.jpg\a>
2031 2089
2032load B<funky.xpm> as a tiled image 2090load B<funky.jpg> as a tiled image
2033 2091
2034=item B<\E]20;mona;100\a> 2092=item B<\E]20;mona.jpg;100\a>
2035 2093
2036load B<mona.xpm> with a scaling of 100% 2094load B<mona.jpg> with a scaling of 100%
2037 2095
2038=item B<\E]20;;200;?\a> 2096=item B<\E]20;;200;?\a>
2039 2097
2040rescale the current pixmap to 200% and display the image geometry in 2098rescale the current pixmap to 200% and display the image geometry in
2041the title 2099the title
2080=begin table 2138=begin table
2081 2139
2082 4 Shift 2140 4 Shift
2083 8 Meta 2141 8 Meta
2084 16 Control 2142 16 Control
2085 32 Double Click I<(Rxvt extension)> 2143 32 Double Click I<(rxvt extension)>
2086 2144
2087=end table 2145=end table
2088 2146
2089Col = B<< C<< <x> - SPACE >> >> 2147Col = B<< C<< <x> - SPACE >> >>
2090 2148
2167=end table 2225=end table
2168 2226
2169=head1 CONFIGURE OPTIONS 2227=head1 CONFIGURE OPTIONS
2170 2228
2171General hint: if you get compile errors, then likely your configuration 2229General hint: if you get compile errors, then likely your configuration
2172hasn'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
2173./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>
2174so it should generally be a working config. Of course, you should always 2232switches). Of course, you should always report when a combination doesn't
2175report when a combination doesn't work, so it can be fixed. Marc Lehmann 2233work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2176<rxvt@schmorp.de>. 2234
2235All
2177 2236
2178=over 4 2237=over 4
2179 2238
2180=item --enable-everything 2239=item --enable-everything
2181 2240
2182Add support for all non-multichoice options listed in "./configure 2241Add (or remove) support for all non-multichoice options listed in "./configure
2183--help". Note that unlike other enable options this is order dependant. 2242--help".
2243
2184You can specify this and then disable options which this enables by 2244You can specify this and then disable options you do not like by
2185I<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.
2186 2249
2187=item --enable-xft 2250=item --enable-xft (default: enabled)
2188 2251
2189Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2252Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2190slower 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
2191don't pay for them. 2254don't pay for them.
2192 2255
2193=item --enable-font-styles 2256=item --enable-font-styles (default: on)
2194 2257
2195Add 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
2196styles. The fonts can be set manually or automatically. 2259styles. The fonts can be set manually or automatically.
2197 2260
2198=item --with-codesets=NAME,... 2261=item --with-codesets=NAME,... (default: all)
2199 2262
2200Compile in support for additional codeset (encoding) groups (C<eu>, C<vn> 2263Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2201are always compiled in, which includes most 8-bit character sets). These 2264are always compiled in, which includes most 8-bit character sets). These
2202codeset 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
2203for Xft fonts, although having them compiled in lets rxvt-unicode choose 2266for Xft fonts, although having them compiled in lets rxvt-unicode choose
2207 2270
2208=begin table 2271=begin table
2209 2272
2210 all all available codeset groups 2273 all all available codeset groups
2211 zh common chinese encodings 2274 zh common chinese encodings
2212 zh_ext rarely used but very big chinese encodigs 2275 zh_ext rarely used but very big chinese encodings
2213 jp common japanese encodings 2276 jp common japanese encodings
2214 jp_ext rarely used but big japanese encodings 2277 jp_ext rarely used but big japanese encodings
2215 kr korean encodings 2278 kr korean encodings
2216 2279
2217=end table 2280=end table
2218 2281
2219=item --enable-xim 2282=item --enable-xim (default: on)
2220 2283
2221Add support for XIM (X Input Method) protocol. This allows using 2284Add support for XIM (X Input Method) protocol. This allows using
2222alternative input methods (e.g. kinput2) and will also correctly 2285alternative input methods (e.g. kinput2) and will also correctly
2223set up the input for people using dead keys or compose keys. 2286set up the input for people using dead keys or compose keys.
2224 2287
2225=item --enable-unicode3 2288=item --enable-unicode3 (default: off)
2289
2290Recommended to stay off unless you really need non-BMP characters.
2226 2291
2227Enable direct support for displaying unicode codepoints above 2292Enable direct support for displaying unicode codepoints above
222865535 (the basic multilingual page). This increases storage 229365535 (the basic multilingual page). This increases storage
2229requirements 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
2230support these extra characters, but Xft does. 2295support these extra characters, but Xft does.
2231 2296
2232Please note that rxvt-unicode can store unicode code points >65535 2297Please note that rxvt-unicode can store unicode code points >65535
2233even without this flag, but the number of such characters is 2298even without this flag, but the number of such characters is
2234limited to a view thousand (shared with combining characters, 2299limited to a few thousand (shared with combining characters,
2235see next switch), and right now rxvt-unicode cannot display them 2300see next switch), and right now rxvt-unicode cannot display them
2236(input/output and cut&paste still work, though). 2301(input/output and cut&paste still work, though).
2237 2302
2238=item --enable-combining 2303=item --enable-combining (default: on)
2239 2304
2240Enable automatic composition of combining characters into 2305Enable automatic composition of combining characters into
2241composite characters. This is required for proper viewing of text 2306composite characters. This is required for proper viewing of text
2242where accents are encoded as seperate unicode characters. This is 2307where accents are encoded as seperate unicode characters. This is
2243done by using precomposited characters when available or creating 2308done by using precomposited characters when available or creating
2244new pseudo-characters when no precomposed form exists. 2309new pseudo-characters when no precomposed form exists.
2245 2310
2246Without --enable-unicode3, the number of additional precomposed characters 2311Without --enable-unicode3, the number of additional precomposed
2247is rather limited (2048, if this is full, rxvt-unicode will use the 2312characters is somewhat limited (the 6400 private use characters will be
2248private use area, extending the number of combinations to 8448). With
2249--enable-unicode3, no practical limit exists. 2313(ab-)used). With --enable-unicode3, no practical limit exists.
2250 2314
2251This option will also enable storage (but not display) of characters 2315This option will also enable storage (but not display) of characters
2252beyond plane 0 (>65535) when --enable-unicode3 was not specified. 2316beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2253 2317
2254The combining table also contains entries for arabic presentation forms, 2318The combining table also contains entries for arabic presentation forms,
2255but 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
2256tell me how these are to be used...). 2320tell me how these are to be used...).
2257 2321
2258=item --enable-fallback(=CLASS) 2322=item --enable-fallback(=CLASS) (default: Rxvt)
2259 2323
2260When reading resource settings, also read settings for class CLASS 2324When reading resource settings, also read settings for class CLASS. To
2261(default: Rxvt). To disable resource fallback use --disable-fallback. 2325disable resource fallback use --disable-fallback.
2262 2326
2263=item --with-res-name=NAME 2327=item --with-res-name=NAME (default: urxvt)
2264 2328
2265Use the given name (default: urxvt) as default application name when 2329Use the given name as default application name when
2266reading resources. Specify --with-res-name=rxvt to replace rxvt. 2330reading resources. Specify --with-res-name=rxvt to replace rxvt.
2267 2331
2268=item --with-res-class=CLASS 2332=item --with-res-class=CLASS (default: URxvt)
2269 2333
2270Use the given class (default: URxvt) as default application class 2334Use the given class as default application class
2271when reading resources. Specify --with-res-class=Rxvt to replace 2335when reading resources. Specify --with-res-class=Rxvt to replace
2272rxvt. 2336rxvt.
2273 2337
2274=item --enable-utmp 2338=item --enable-utmp (default: on)
2275 2339
2276Write 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
2277start of rxvt execution and delete information when rxvt exits. 2341start of rxvt execution and delete information when rxvt exits.
2278 2342
2279=item --enable-wtmp 2343=item --enable-wtmp (default: on)
2280 2344
2281Write 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
2282start of rxvt execution and write logout when rxvt exits. This 2346start of rxvt execution and write logout when rxvt exits. This
2283option requires --enable-utmp to also be specified. 2347option requires --enable-utmp to also be specified.
2284 2348
2285=item --enable-lastlog 2349=item --enable-lastlog (default: on)
2286 2350
2287Write user and tty to lastlog file (used by programs like 2351Write user and tty to lastlog file (used by programs like
2288F<lastlogin>) at start of rxvt execution. This option requires 2352F<lastlogin>) at start of rxvt execution. This option requires
2289--enable-utmp to also be specified. 2353--enable-utmp to also be specified.
2290 2354
2291=item --enable-xpm-background 2355=item --enable-afterimage (default: on)
2292 2356
2293Add 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>).
2294 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
2295=item --enable-transparency 2370=item --enable-transparency (default: on)
2296 2371
2297Add support for inheriting parent backgrounds thus giving a fake 2372Add support for backgrounds, creating illusion of transparency in the term.
2298transparency to the term.
2299 2373
2300=item --enable-fading 2374=item --enable-fading (default: on)
2301 2375
2302Add support for fading the text when focus is lost. 2376Add support for fading the text when focus is lost.
2303 2377
2304=item --enable-tinting
2305
2306Add support for tinting of transparent backgrounds.
2307
2308=item --enable-menubar
2309
2310Add support for our menu bar system (this interacts badly with
2311dynamic locale switching currently).
2312
2313=item --enable-rxvt-scroll 2378=item --enable-rxvt-scroll (default: on)
2314 2379
2315Add support for the original rxvt scrollbar. 2380Add support for the original rxvt scrollbar.
2316 2381
2317=item --enable-next-scroll 2382=item --enable-next-scroll (default: on)
2318 2383
2319Add support for a NeXT-like scrollbar. 2384Add support for a NeXT-like scrollbar.
2320 2385
2321=item --enable-xterm-scroll 2386=item --enable-xterm-scroll (default: on)
2322 2387
2323Add support for an Xterm-like scrollbar. 2388Add support for an Xterm-like scrollbar.
2324 2389
2325=item --enable-plain-scroll 2390=item --enable-plain-scroll (default: on)
2326 2391
2327Add support for a very unobtrusive, plain-looking scrollbar that 2392Add support for a very unobtrusive, plain-looking scrollbar that
2328is the favourite of the rxvt-unicode author, having used it for 2393is the favourite of the rxvt-unicode author, having used it for
2329many years. 2394many years.
2330 2395
2331=item --enable-half-shadow
2332
2333Make shadows on the scrollbar only half the normal width & height.
2334only applicable to rxvt scrollbars.
2335
2336=item --enable-ttygid
2337
2338Change tty device setting to group "tty" - only use this if
2339your system uses this type of security.
2340
2341=item --disable-backspace-key 2396=item --disable-backspace-key
2342 2397
2343Disable 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
2344do it. 2403do it.
2345 2404
2346=item --disable-delete-key
2347
2348Disable any handling of the delete key by us - let the X server
2349do it.
2350
2351=item --disable-resources 2405=item --disable-resources
2352 2406
2353Remove all resources checking. 2407Removes any support for resource checking.
2354
2355=item --enable-xgetdefault
2356
2357Make resources checking via XGetDefault() instead of our small
2358version which only checks ~/.Xdefaults, or if that doesn't exist then
2359~/.Xresources.
2360
2361Please note that nowadays, things like XIM will automatically pull in and
2362use the full X resource manager, so the overhead of using it might be very
2363small, if nonexistant.
2364
2365=item --enable-strings
2366
2367Add support for our possibly faster memset() function and other
2368various routines, overriding your system's versions which may
2369have been hand-crafted in assembly or may require extra libraries
2370to link in. (this breaks ANSI-C rules and has problems on many
2371GNU/Linux systems).
2372 2408
2373=item --disable-swapscreen 2409=item --disable-swapscreen
2374 2410
2375Remove support for swap screen. 2411Remove support for secondary/swap screen.
2376 2412
2377=item --enable-frills 2413=item --enable-frills (default: on)
2378 2414
2379Add 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
2380have. 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
2381disable this. 2417disable this.
2382 2418
2383A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2419A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2384in combination with other switches) is: 2420in combination with other switches) is:
2385 2421
2386 MWM-hints 2422 MWM-hints
2387 EWMH-hints (pid, utf8 names) and protocols (ping) 2423 EWMH-hints (pid, utf8 names) and protocols (ping)
2424 urgency hint
2388 seperate underline colour 2425 seperate underline colour (-underlineColor)
2389 settable border widths and borderless switch 2426 settable border widths and borderless switch (-w, -b, -bl)
2427 visual depth selection (-depth)
2390 settable extra linespacing 2428 settable extra linespacing /-lsp)
2391 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
2392 backindex and forwardindex escape sequence 2447 backindex and forwardindex escape sequences
2448 view change/zero scrollback escape sequences
2449 locale switching escape sequence
2393 window op and some xterm/OSC escape sequences 2450 window op and some xterm/OSC escape sequences
2394 tripleclickwords 2451 rectangular selections
2395 settable insecure mode 2452 trailing space removal for selections
2396 keysym remapping support 2453 verbose X error handling
2397 cursor blinking and underline cursor
2398 -embed and -pty-fd options
2399 2454
2400=item --enable-iso14755 2455=item --enable-iso14755 (default: on)
2401 2456
2402Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2457Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2403F<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
2404C<--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
2405this switch. 2460this switch.
2406 2461
2407=item --enable-keepscrolling 2462=item --enable-keepscrolling (default: on)
2408 2463
2409Add support for continual scrolling of the display when you hold 2464Add support for continual scrolling of the display when you hold
2410the mouse button down on a scrollbar arrow. 2465the mouse button down on a scrollbar arrow.
2411 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
2412=item --enable-mousewheel 2472=item --enable-mousewheel (default: on)
2413 2473
2414Add support for scrolling via mouse wheel or buttons 4 & 5. 2474Add support for scrolling via mouse wheel or buttons 4 & 5.
2415 2475
2416=item --enable-slipwheeling 2476=item --enable-slipwheeling (default: on)
2417 2477
2418Add support for continual scrolling (using the mouse wheel as an 2478Add support for continual scrolling (using the mouse wheel as an
2419accelerator) while the control key is held down. This option 2479accelerator) while the control key is held down. This option
2420requires --enable-mousewheel to also be specified. 2480requires --enable-mousewheel to also be specified.
2421 2481
2422=item --disable-new-selection
2423
2424Remove support for mouse selection style like that of xterm.
2425
2426=item --enable-dmalloc
2427
2428Use Gray Watson's malloc - which is good for debugging See
2429http://www.letters.com/dmalloc/ for details If you use either this or the
2430next option, you may need to edit src/Makefile after compiling to point
2431DINCLUDE and DLIB to the right places.
2432
2433You can only use either this option and the following (should
2434you use either) .
2435
2436=item --enable-dlmalloc
2437
2438Use Doug Lea's malloc - which is good for a production version
2439See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2440
2441=item --enable-smart-resize 2482=item --enable-smart-resize (default: off)
2442 2483
2443Add smart growth/shrink behaviour when changing font size via from hot 2484Add smart growth/shrink behaviour when resizing.
2444keys. 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
2445closest to a corner of the screen. 2486the screen in a fixed position.
2446 2487
2488=item --enable-text-blink (default: on)
2489
2490Add support for blinking text.
2491
2447=item --enable-pointer-blank 2492=item --enable-pointer-blank (default: on)
2448 2493
2449Add support to have the pointer disappear when typing or inactive. 2494Add support to have the pointer disappear when typing or inactive.
2450 2495
2451=item --with-name=NAME 2496=item --enable-perl (default: on)
2452 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
2453Set the basename for the installed binaries (default: C<urxvt>, resulting 2513Set the basename for the installed binaries, resulting
2454in 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
2455C<rxvt>. 2515C<rxvt>.
2456 2516
2457=item --with-term=NAME 2517=item --with-term=NAME (default: rxvt-unicode)
2458 2518
2459Change the environmental variable for the terminal to NAME (default 2519Change the environmental variable for the terminal to NAME.
2460C<rxvt-unicode>)
2461 2520
2462=item --with-terminfo=PATH 2521=item --with-terminfo=PATH
2463 2522
2464Change the environmental variable for the path to the terminfo tree to 2523Change the environmental variable for the path to the terminfo tree to
2465PATH. 2524PATH.
2466 2525
2467=item --with-x 2526=item --with-x
2468 2527
2469Use the X Window System (pretty much default, eh?). 2528Use the X Window System (pretty much default, eh?).
2470
2471=item --with-xpm-includes=DIR
2472
2473Look for the XPM includes in DIR.
2474
2475=item --with-xpm-library=DIR
2476
2477Look for the XPM library in DIR.
2478
2479=item --with-xpm
2480
2481Not needed - define via --enable-xpm-background.
2482 2529
2483=back 2530=back
2484 2531
2485=head1 AUTHORS 2532=head1 AUTHORS
2486 2533

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines