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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.54 by root, Tue Jun 21 18:25:09 2005 UTC vs.
Revision 1.123 by root, Sat Dec 16 03:48:49 2006 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines