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.51 by root, Mon Feb 21 19:26:06 2005 UTC vs.
Revision 1.151 by sasha, Thu Nov 15 18:40:10 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines