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.60 by root, Fri Jul 29 03:12:10 2005 UTC vs.
Revision 1.113 by root, Thu Feb 2 18:04:45 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/*checkout*/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 in sarge contains large 60Rxvt-unicode tries to obey the rule of not charging you for something you
37patches that considerably change the behaviour of rxvt-unicode. Before 61don't use. One thing you should try is to configure out all settings that
38reporting a bug to the original rxvt-unicode author please download and 62you don't need, for example, Xft support is a resource hog by design,
39install the genuine version (L<http://software.schmorp.de#rxvt-unicode>) 63when used. Compiling it out ensures that no Xft font will be loaded
40and try to reproduce the problem. If you cannot, chances are that the 64accidentally when rxvt-unicode tries to find a font for your characters.
41problems are specific to Debian GNU/Linux, in which case it should be
42reported via the Debian Bug Tracking System (use C<reportbug> to report
43the bug).
44 65
45For other problems that also affect the Debian package, you can and 66Also, many people (me included) like large windows and even larger
46probably should use the Debian BTS, too, because, after all, it's also a 67scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
47bug 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
48might 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.
49 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 wether 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 unreasnobaly 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 neccessary
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), wether 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 '\e]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 it's 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 it's 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 permamently 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 wether 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 Why doesn't rxvt-unicode read my resources?
664
665Well, why, indeed? It does, in a way very similar to other X
666applications. Most importantly, this means that if you or your OS loads
667resources into the X display (the right way to do it), rxvt-unicode will
668ignore any resource files in your home directory. It will only read
669F<$HOME/.Xdefaults> when no resources are attached to the display.
670
671If you have or use an F<$HOME/.Xresources> file, chances are that
672resources are loaded into your X-server. In this case, you have to
673re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
674
675Also consider the form resources have to use:
676
677 URxvt.resource: value
678
679If you want to use another form (there are lots of different ways of
680specifying resources), make sure you understand wether and why it
681works. If unsure, use the form above.
682
50=item When I log-in to another system it tells me about missing terminfo data? 683=head3 When I log-in to another system it tells me about missing terminfo data?
51 684
52The terminal description used by rxvt-unicode is not as widely available 685The terminal description used by rxvt-unicode is not as widely available
53as that for xterm, or even rxvt (for which the same problem often arises). 686as that for xterm, or even rxvt (for which the same problem often arises).
54 687
55The correct solution for this problem is to install the terminfo, this can 688The correct solution for this problem is to install the terminfo, this can
71resource to set it: 704resource to set it:
72 705
73 URxvt.termName: rxvt 706 URxvt.termName: rxvt
74 707
75If you don't plan to use B<rxvt> (quite common...) you could also replace 708If you don't plan to use B<rxvt> (quite common...) you could also replace
76the rxvt terminfo file with the rxvt-unicode one. 709the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
77 710
78=item C<tic> outputs some error when compiling the terminfo entry. 711=head3 C<tic> outputs some error when compiling the terminfo entry.
79 712
80Most likely it's the empty definition for C<enacs=>. Just replace it by 713Most likely it's the empty definition for C<enacs=>. Just replace it by
81C<enacs=\E[0@> and try again. 714C<enacs=\E[0@> and try again.
82 715
83=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@. 716=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
84 717
718See next entry.
719
85=item I need a termcap file entry. 720=head3 I need a termcap file entry.
86 721
87One reason you might want this is that some distributions or operating 722One reason you might want this is that some distributions or operating
88systems still compile some programs using the long-obsoleted termcap 723systems still compile some programs using the long-obsoleted termcap
89library (Fedora Core's bash is one example) and rely on a termcap entry 724library (Fedora Core's bash is one example) and rely on a termcap entry
90for C<rxvt-unicode>. 725for C<rxvt-unicode>.
116 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\ 751 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
117 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\ 752 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
118 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\ 753 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
119 :vs=\E[?25h: 754 :vs=\E[?25h:
120 755
121=item Why does C<ls> no longer have coloured output? 756=head3 Why does C<ls> no longer have coloured output?
122 757
123The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 758The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
124decide wether a terminal has colour, but uses it's own configuration 759decide wether a terminal has colour, but uses it's own configuration
125file. Needless to say, C<rxvt-unicode> is not in it's default file (among 760file. Needless to say, C<rxvt-unicode> is not in it's default file (among
126with most other terminals supporting colour). Either add: 761with most other terminals supporting colour). Either add:
131 766
132 alias ls='ls --color=auto' 767 alias ls='ls --color=auto'
133 768
134to your C<.profile> or C<.bashrc>. 769to your C<.profile> or C<.bashrc>.
135 770
136=item Why doesn't vim/emacs etc. use the 88 colour mode? 771=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
137 772
773See next entry.
774
138=item Why doesn't vim/emacs etc. make use of italic? 775=head3 Why doesn't vim/emacs etc. make use of italic?
139 776
777See next entry.
778
140=item Why are the secondary screen-related options not working properly? 779=head3 Why are the secondary screen-related options not working properly?
141 780
142Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged 781Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
143distributions (most notably Debian GNU/Linux) break rxvt-unicode 782distributions (most notably Debian GNU/Linux) break rxvt-unicode
144by setting C<TERM> to C<rxvt>, which doesn't have these extra 783by setting C<TERM> to C<rxvt>, which doesn't have these extra
145features. Unfortunately, some of these (most notably, again, Debian 784features. Unfortunately, some of these (most notably, again, Debian
146GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo 785GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
147file, so you will need to install it on your own (See the question B<When 786file, so you will need to install it on your own (See the question B<When
148I log-in to another system it tells me about missing terminfo data?> on 787I log-in to another system it tells me about missing terminfo data?> on
149how to do this). 788how to do this).
150 789
151=item My numerical keypad acts weird and generates differing output?
152 790
153Some Debian GNUL/Linux users seem to have this problem, although no 791=head2 Encoding / Locale / Input Method Issues
154specific details were reported so far. It is possible that this is caused
155by the wrong C<TERM> setting, although the details of wether and how
156this can happen are unknown, as C<TERM=rxvt> should offer a compatible
157keymap. See the answer to the previous question, and please report if that
158helped.
159 792
160=item Rxvt-unicode does not seem to understand the selected encoding? 793=head3 Rxvt-unicode does not seem to understand the selected encoding?
161 794
795See next entry.
796
162=item Unicode does not seem to work? 797=head3 Unicode does not seem to work?
163 798
164If you encounter strange problems like typing an accented character but 799If you encounter strange problems like typing an accented character but
165getting two unrelated other characters or similar, or if program output is 800getting two unrelated other characters or similar, or if program output is
166subtly garbled, then you should check your locale settings. 801subtly garbled, then you should check your locale settings.
167 802
187 822
188If nothing works and you are sure that everything is set correctly then 823If nothing works and you are sure that everything is set correctly then
189you will need to remember a little known fact: Some programs just don't 824you will need to remember a little known fact: Some programs just don't
190support locales :( 825support locales :(
191 826
192=item Why do some characters look so much different than others? 827=head3 How does rxvt-unicode determine the encoding to use?
193 828
194=item How does rxvt-unicode choose fonts? 829See next entry.
195 830
196Most fonts do not contain the full range of Unicode, which is 831=head3 Is there an option to switch encodings?
197fine. Chances are that the font you (or the admin/package maintainer of
198your system/os) have specified does not cover all the characters you want
199to display.
200 832
201B<rxvt-unicode> makes a best-effort try at finding a replacement 833Unlike some other terminals, rxvt-unicode has no encoding switch, and no
202font. Often the result is fine, but sometimes the chosen font looks 834specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
203bad/ugly/wrong. Some fonts have totally strange characters that don't 835UTF-8 or any other encodings with respect to terminal I/O.
204resemble the correct glyph at all, and rxvt-unicode lacks the artificial
205intelligence to detect that a specific glyph is wrong: it has to believe
206the font that the characters it claims to contain indeed look correct.
207 836
208In that case, select a font of your taste and add it to the font list, 837The reasons is that there exists a perfectly fine mechanism for selecting
209e.g.: 838the encoding, doing I/O and (most important) communicating this to all
210 839applications so everybody agrees on character properties such as width
211 @@RXVT_NAME@@ -fn basefont,font2,font3... 840and code number. This mechanism is the I<locale>. Applications not using
212 841that info will have problems (for example, C<xterm> gets the width of
213When rxvt-unicode sees a character, it will first look at the base 842characters wrong as it uses it's own, locale-independent table under all
214font. If the base font does not contain the character, it will go to the
215next font, and so on. Specifying your own fonts will also speed up this
216search and use less resources within rxvt-unicode and the X-server.
217
218The only limitation is that none of the fonts may be larger than the base
219font, as the base font defines the terminal character cell size, which
220must be the same due to the way terminals work.
221
222=item Why do some chinese characters look so different than others?
223
224This is because there is a difference between script and language --
225rxvt-unicode does not know which language the text that is output is,
226as it only knows the unicode character codes. If rxvt-unicode first
227sees a japanese/chinese character, it might choose a japanese font for
228display. Subsequent japanese characters will use that font. Now, many
229chinese characters aren't represented in japanese fonts, so when the first
230non-japanese character comes up, rxvt-unicode will look for a chinese font
231-- unfortunately at this point, it will still use the japanese font for
232chinese characters that are also in the japanese font.
233
234The workaround is easy: just tag a chinese font at the end of your font
235list (see the previous question). The key is to view the font list as
236a preference list: If you expect more japanese, list a japanese font
237first. If you expect more chinese, put a chinese font first.
238
239In the future it might be possible to switch language preferences at
240runtime (the internal data structure has no problem with using different
241fonts for the same character at the same time, but no interface for this
242has been designed yet).
243
244Until then, you might get away with switching fonts at runtime (see L<Can
245I switch the fonts at runtime?> later in this document).
246
247=item Why does rxvt-unicode sometimes leave pixel droppings?
248
249Most fonts were not designed for terminal use, which means that character
250size varies a lot. A font that is otherwise fine for terminal use might
251contain some characters that are simply too wide. Rxvt-unicode will avoid
252these characters. For characters that are just "a bit" too wide a special
253"careful" rendering mode is used that redraws adjacent characters.
254
255All of this requires that fonts do not lie about character sizes,
256however: Xft fonts often draw glyphs larger than their acclaimed bounding
257box, and rxvt-unicode has no way of detecting this (the correct way is to
258ask for the character bounding box, which unfortunately is wrong in these
259cases). 843locales).
260 844
261It's not clear (to me at least), wether this is a bug in Xft, freetype, 845Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
262or the respective font. If you encounter this problem you might try using 846programs doing the same (that is, most) will automatically agree in the
263the C<-lsp> option to give the font more height. If that doesn't work, you 847interpretation of characters.
264might be forced to use a different font.
265 848
266All of this is not a problem when using X11 core fonts, as their bounding 849Unfortunately, there is no system-independent way to select locales, nor
267box data is correct. 850is there a standard on how locale specifiers will look like.
268 851
852On most systems, the content of the C<LC_CTYPE> environment variable
853contains an arbitrary string which corresponds to an already-installed
854locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
855C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
856(i.e. C<de> or C<german>) are also common.
857
858Rxvt-unicode ignores all other locale categories, and except for
859the encoding, ignores country or language-specific settings,
860i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
861rxvt-unicode.
862
863If you want to use a specific encoding you have to make sure you start
864rxvt-unicode with the correct C<LC_CTYPE> category.
865
866=head3 Can I switch locales at runtime?
867
868Yes, using an escape sequence. Try something like this, which sets
869rxvt-unicode's idea of C<LC_CTYPE>.
870
871 printf '\e]701;%s\007' ja_JP.SJIS
872
873See also the previous answer.
874
875Sometimes this capability is rather handy when you want to work in
876one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
877(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
878first switches to a locale supported by xjdic and back later:
879
880 printf '\e]701;%s\007' ja_JP.SJIS
881 xjdic -js
882 printf '\e]701;%s\007' de_DE.UTF-8
883
884You can also use xterm's C<luit> program, which usually works fine, except
885for some locales where character width differs between program- and
886rxvt-unicode-locales.
887
888=head3 I have problems getting my input method working.
889
890Try a search engine, as this is slightly different for every input method server.
891
892Here is a checklist:
893
894=over 4
895
896=item - Make sure your locale I<and> the imLocale are supported on your OS.
897
898Try C<locale -a> or check the documentation for your OS.
899
900=item - Make sure your locale or imLocale matches a locale supported by your XIM.
901
902For example, B<kinput2> does not support UTF-8 locales, you should use
903C<ja_JP.EUC-JP> or equivalent.
904
905=item - Make sure your XIM server is actually running.
906
907=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
908
909When you want to use e.g. B<kinput2>, it must be set to
910C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. Youc an see what input
911method servers are running with this command:
912
913 xprop -root XIM_SERVERS
914
915=item
916
917=back
918
919=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
920
921You can specify separate locales for the input method and the rest of the
922terminal, using the resource C<imlocale>:
923
924 URxvt.imlocale: ja_JP.EUC-JP
925
926Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
927use your input method. Please note, however, that, depending on your Xlib
928version, you may not be able to input characters outside C<EUC-JP> in a
929normal way then, as your input method limits you.
930
931=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
932
933Unfortunately, this is unavoidable, as the XIM protocol is racy by
934design. Applications can avoid some crashes at the expense of memory
935leaks, and Input Methods can avoid some crashes by careful ordering at
936exit time. B<kinput2> (and derived input methods) generally succeeds,
937while B<SCIM> (or similar input methods) fails. In the end, however,
938crashes cannot be completely avoided even if both sides cooperate.
939
940So the only workaround is not to kill your Input Method Servers.
941
942
943=head2 Operating Systems / Package Maintaining
944
945=head3 I am using Debian GNU/Linux and have a problem...
946
947The Debian GNU/Linux package of rxvt-unicode in sarge contains large
948patches that considerably change the behaviour of rxvt-unicode (but
949unfortunately this notice has been removed). Before reporting a bug to
950the original rxvt-unicode author please download and install the genuine
951version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
952the problem. If you cannot, chances are that the problems are specific to
953Debian GNU/Linux, in which case it should be reported via the Debian Bug
954Tracking System (use C<reportbug> to report the bug).
955
956For other problems that also affect the Debian package, you can and
957probably should use the Debian BTS, too, because, after all, it's also a
958bug in the Debian version and it serves as a reminder for other users that
959might encounter the same issue.
960
961=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
962
963You should build one binary with the default options. F<configure>
964now enables most useful options, and the trend goes to making them
965runtime-switchable, too, so there is usually no drawback to enbaling them,
966except higher disk and possibly memory usage. The perl interpreter should
967be enabled, as important functionality (menus, selection, likely more in
968the future) depends on it.
969
970You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
971system-wide (except maybe with C<defaults>). This will result in useful
972behaviour. If your distribution aims at low memory, add an empty
973C<perl-ext-common> resource to the app-defaults file. This will keep the
974perl interpreter disabled until the user enables it.
975
976If you can/want build more binaries, I recommend building a minimal
977one with C<--disable-everything> (very useful) and a maximal one with
978C<--enable-everything> (less useful, it will be very big due to a lot of
979encodings built-in that increase download times and are rarely used).
980
981=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
982
983It should be, starting with release 7.1. You are encouraged to properly
984install urxvt with privileges necessary for your OS now.
985
986When rxvt-unicode detects that it runs setuid or setgid, it will fork
987into a helper process for privileged operations (pty handling on some
988systems, utmp/wtmp/lastlog handling on others) and drop privileges
989immediately. This is much safer than most other terminals that keep
990privileges while running (but is more relevant to urxvt, as it contains
991things as perl interpreters, which might be "helpful" to attackers).
992
993This forking is done as the very first within main(), which is very early
994and reduces possible bugs to initialisation code run before main(), or
995things like the dynamic loader of your system, which should result in very
996little risk.
997
269=item On Solaris 9, many line-drawing characters are too wide. 998=head3 On Solaris 9, many line-drawing characters are too wide.
270 999
271Seems to be a known bug, read 1000Seems to be a known bug, read
272L<http://nixdoc.net/files/forum/about34198.html>. Some people use the 1001L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
273following ugly workaround to get non-double-wide-characters working: 1002following ugly workaround to get non-double-wide-characters working:
274 1003
275 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x) 1004 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
276 1005
277=item My Compose (Multi_key) key is no longer working.
278
279The most common causes for this are that either your locale is not set
280correctly, or you specified a B<preeditStyle> that is not supported by
281your input method. For example, if you specified B<OverTheSpot> and
282your input method (e.g. the default input method handling Compose keys)
283does not support this (for instance because it is not visual), then
284rxvt-unicode will continue without an input method.
285
286In this case either do not specify a B<preeditStyle> or specify more than
287one pre-edit style, such as B<OverTheSpot,Root,None>.
288
289=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
290
291Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
292international keyboards) or simply use ISO 14755 support to your
293advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
294codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
295character and so on.
296
297=item How can I keep rxvt-unicode from using reverse video so much?
298
299First of all, make sure you are running with the right terminal settings
300(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
301make sure you have specified colours for italic and bold, as otherwise
302rxvt-unicode might use reverse video to simulate the effect:
303
304 URxvt.colorBD: white
305 URxvt.colorIT: green
306
307=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
308
309For some unexplainable reason, some rare programs assume a very weird
310colour palette when confronted with a terminal with more than the standard
3118 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
312these programs not to assume non-ISO colours without very good reasons.
313
314In the meantime, you can either edit your C<rxvt-unicode> terminfo
315definition to only claim 8 colour support or use C<TERM=rxvt>, which will
316fix colours but keep you from using other rxvt-unicode features.
317
318=item I am on FreeBSD and rxvt-unicode does not seem to work at all. 1006=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
319 1007
320Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1008Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
321in your compile environment, or an implementation that implements it, 1009in your compile environment, or an implementation that implements it,
322wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1010wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
323B<wchar_t> is represented as unicode. 1011B<wchar_t> is represented as unicode.
345 1033
346The rxvt-unicode author insists that the right way to fix this is in the 1034The rxvt-unicode author insists that the right way to fix this is in the
347system libraries once and for all, instead of forcing every app to carry 1035system libraries once and for all, instead of forcing every app to carry
348complete replacements for them :) 1036complete replacements for them :)
349 1037
350=item I use Solaris 9 and it doesn't compile/work/etc. 1038=head3 I use Solaris 9 and it doesn't compile/work/etc.
351 1039
352Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst 1040Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
353problems with C<wcwidth> and a compile problem. 1041problems with C<wcwidth> and a compile problem.
354 1042
355=item How can I use rxvt-unicode under cygwin? 1043=head3 How can I use rxvt-unicode under cygwin?
356 1044
357rxvt-unicode should compile and run out of the box on cygwin, using 1045rxvt-unicode should compile and run out of the box on cygwin, using
358the X11 libraries that come with cygwin. libW11 emulation is no 1046the X11 libraries that come with cygwin. libW11 emulation is no
359longer supported (and makes no sense, either, as it only supported a 1047longer supported (and makes no sense, either, as it only supported a
360single font). I recommend starting the X-server in C<-multiwindow> or 1048single font). I recommend starting the X-server in C<-multiwindow> or
363 1051
364At the time of this writing, cygwin didn't seem to support any multi-byte 1052At the time of this writing, cygwin didn't seem to support any multi-byte
365encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited 1053encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
366to 8-bit encodings. 1054to 8-bit encodings.
367 1055
368=item How does rxvt-unicode determine the encoding to use?
369
370=item Is there an option to switch encodings?
371
372Unlike some other terminals, rxvt-unicode has no encoding switch, and no
373specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
374UTF-8 or any other encodings with respect to terminal I/O.
375
376The reasons is that there exists a perfectly fine mechanism for selecting
377the encoding, doing I/O and (most important) communicating this to all
378applications so everybody agrees on character properties such as width
379and code number. This mechanism is the I<locale>. Applications not using
380that info will have problems (for example, C<xterm> gets the width of
381characters wrong as it uses it's own, locale-independent table under all
382locales).
383
384Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
385programs doing the same (that is, most) will automatically agree in the
386interpretation of characters.
387
388Unfortunately, there is no system-independent way to select locales, nor
389is there a standard on how locale specifiers will look like.
390
391On most systems, the content of the C<LC_CTYPE> environment variable
392contains an arbitrary string which corresponds to an already-installed
393locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
394C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
395(i.e. C<de> or C<german>) are also common.
396
397Rxvt-unicode ignores all other locale categories, and except for
398the encoding, ignores country or language-specific settings,
399i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
400rxvt-unicode.
401
402If you want to use a specific encoding you have to make sure you start
403rxvt-unicode with the correct C<LC_CTYPE> category.
404
405=item Can I switch locales at runtime?
406
407Yes, using an escape sequence. Try something like this, which sets
408rxvt-unicode's idea of C<LC_CTYPE>.
409
410 printf '\e]701;%s\007' ja_JP.SJIS
411
412See also the previous answer.
413
414Sometimes this capability is rather handy when you want to work in
415one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
416(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
417first switches to a locale supported by xjdic and back later:
418
419 printf '\e]701;%s\007' ja_JP.SJIS
420 xjdic -js
421 printf '\e]701;%s\007' de_DE.UTF-8
422
423You can also use xterm's C<luit> program, which usually works fine, except
424for some locales where character width differs between program- and
425rxvt-unicode-locales.
426
427=item Can I switch the fonts at runtime?
428
429Yes, using an escape sequence. Try something like this, which has the same
430effect as using the C<-fn> switch, and takes effect immediately:
431
432 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
433
434This is useful if you e.g. work primarily with japanese (and prefer a
435japanese font), but you have to switch to chinese temporarily, where
436japanese fonts would only be in your way.
437
438You can think of this as a kind of manual ISO-2022 switching.
439
440=item Why do italic characters look as if clipped?
441
442Many fonts have difficulties with italic characters and hinting. For
443example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
444Mono> completely fails in it's italic face. A workaround might be to
445enable freetype autohinting, i.e. like this:
446
447 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
448 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
449
450=item My input method wants <some encoding> but I want UTF-8, what can I do?
451
452You can specify separate locales for the input method and the rest of the
453terminal, using the resource C<imlocale>:
454
455 URxvt*imlocale: ja_JP.EUC-JP
456
457Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
458use your input method. Please note, however, that you will not be able to
459input characters outside C<EUC-JP> in a normal way then, as your input
460method limits you.
461
462=item Rxvt-unicode crashes when the X Input Method changes or exits.
463
464Unfortunately, this is unavoidable, as the XIM protocol is racy by
465design. Applications can avoid some crashes at the expense of memory
466leaks, and Input Methods can avoid some crashes by careful ordering at
467exit time. B<kinput2> (and derived input methods) generally succeeds,
468while B<SCIM> (or similar input methods) fails. In the end, however,
469crashes cannot be completely avoided even if both sides cooperate.
470
471So the only workaround is not to kill your Input Method Servers.
472
473=item Rxvt-unicode uses gobs of memory, how can I reduce that?
474
475Rxvt-unicode tries to obey the rule of not charging you for something you
476don't use. One thing you should try is to configure out all settings that
477you don't need, for example, Xft support is a resource hog by design,
478when used. Compiling it out ensures that no Xft font will be loaded
479accidentally when rxvt-unicode tries to find a font for your characters.
480
481Also, many people (me included) like large windows and even larger
482scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
4836 bytes per screen cell. For a 160x?? window this amounts to almost a
484kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
485use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
486rxvt-unicode then uses 8 bytes per screen cell.
487
488=item Can I speed up Xft rendering somehow?
489
490Yes, the most obvious way to speed it up is to avoid Xft entirely, as
491it is simply slow. If you still want Xft fonts you might try to disable
492antialiasing (by appending C<:antialias=false>), which saves lots of
493memory and also speeds up rendering considerably.
494
495=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
496
497Rxvt-unicode will use whatever you specify as a font. If it needs to
498fall back to it's default font search list it will prefer X11 core
499fonts, because they are small and fast, and then use Xft fonts. It has
500antialiasing disabled for most of them, because the author thinks they
501look best that way.
502
503If you want antialiasing, you have to specify the fonts manually.
504
505=item Mouse cut/paste suddenly no longer works.
506
507Make sure that mouse reporting is actually turned off since killing
508some editors prematurely may leave the mouse in mouse report mode. I've
509heard that tcsh may use mouse reporting unless it otherwise specified. A
510quick check is to see if cut/paste works when the Alt or Shift keys are
511depressed. See @@RXVT_NAME@@(7)
512
513=item What's with this bold/blink stuff?
514
515If no bold colour is set via C<colorBD:>, bold will invert text using the
516standard foreground colour.
517
518For the standard background colour, blinking will actually make the
519text blink when compiled with C<--enable-blinking>. with standard
520colours. Without C<--enable-blinking>, the blink attribute will be
521ignored.
522
523On ANSI colours, bold/blink attributes are used to set high-intensity
524foreground/background colors.
525
526color0-7 are the low-intensity colors.
527
528color8-15 are the corresponding high-intensity colors.
529
530=item I don't like the screen colors. How do I change them?
531
532You can change the screen colors at run-time using F<~/.Xdefaults>
533resources (or as long-options).
534
535Here are values that are supposed to resemble a VGA screen,
536including the murky brown that passes for low-intensity yellow:
537
538 URxvt.color0: #000000
539 URxvt.color1: #A80000
540 URxvt.color2: #00A800
541 URxvt.color3: #A8A800
542 URxvt.color4: #0000A8
543 URxvt.color5: #A800A8
544 URxvt.color6: #00A8A8
545 URxvt.color7: #A8A8A8
546
547 URxvt.color8: #000054
548 URxvt.color9: #FF0054
549 URxvt.color10: #00FF54
550 URxvt.color11: #FFFF54
551 URxvt.color12: #0000FF
552 URxvt.color13: #FF00FF
553 URxvt.color14: #00FFFF
554 URxvt.color15: #FFFFFF
555
556And here is a more complete set of non-standard colors described (not by
557me) as "pretty girly".
558
559 URxvt.cursorColor: #dc74d1
560 URxvt.pointerColor: #dc74d1
561 URxvt.background: #0e0e0e
562 URxvt.foreground: #4ad5e1
563 URxvt.color0: #000000
564 URxvt.color8: #8b8f93
565 URxvt.color1: #dc74d1
566 URxvt.color9: #dc74d1
567 URxvt.color2: #0eb8c7
568 URxvt.color10: #0eb8c7
569 URxvt.color3: #dfe37e
570 URxvt.color11: #dfe37e
571 URxvt.color5: #9e88f0
572 URxvt.color13: #9e88f0
573 URxvt.color6: #73f7ff
574 URxvt.color14: #73f7ff
575 URxvt.color7: #e1dddd
576 URxvt.color15: #e1dddd
577
578=item How can I start @@RXVT_NAME@@d in a race-free way?
579
580Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
581display, create the listening socket and then fork.
582
583=item What's with the strange Backspace/Delete key behaviour?
584
585Assuming that the physical Backspace key corresponds to the
586BackSpace keysym (not likely for Linux ... see the following
587question) there are two standard values that can be used for
588Backspace: C<^H> and C<^?>.
589
590Historically, either value is correct, but rxvt-unicode adopts the debian
591policy of using C<^?> when unsure, because it's the one only only correct
592choice :).
593
594Rxvt-unicode tries to inherit the current stty settings and uses the value
595of `erase' to guess the value for backspace. If rxvt-unicode wasn't
596started from a terminal (say, from a menu or by remote shell), then the
597system value of `erase', which corresponds to CERASE in <termios.h>, will
598be used (which may not be the same as your stty setting).
599
600For starting a new rxvt-unicode:
601
602 # use Backspace = ^H
603 $ stty erase ^H
604 $ @@RXVT_NAME@@
605
606 # use Backspace = ^?
607 $ stty erase ^?
608 $ @@RXVT_NAME@@
609
610Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).
611
612For an existing rxvt-unicode:
613
614 # use Backspace = ^H
615 $ stty erase ^H
616 $ echo -n "^[[36h"
617
618 # use Backspace = ^?
619 $ stty erase ^?
620 $ echo -n "^[[36l"
621
622This helps satisfy some of the Backspace discrepancies that occur, but
623if you use Backspace = C<^H>, make sure that the termcap/terminfo value
624properly reflects that.
625
626The Delete key is a another casualty of the ill-defined Backspace problem.
627To avoid confusion between the Backspace and Delete keys, the Delete
628key has been assigned an escape sequence to match the vt100 for Execute
629(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
630
631Some other Backspace problems:
632
633some editors use termcap/terminfo,
634some editors (vim I'm told) expect Backspace = ^H,
635GNU Emacs (and Emacs-like editors) use ^H for help.
636
637Perhaps someday this will all be resolved in a consistent manner.
638
639=item I don't like the key-bindings. How do I change them?
640
641There are some compile-time selections available via configure. Unless
642you have run "configure" with the C<--disable-resources> option you can
643use the `keysym' resource to alter the keystrings associated with keysyms.
644
645Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
646
647 URxvt.keysym.Home: \033[1~
648 URxvt.keysym.End: \033[4~
649 URxvt.keysym.C-apostrophe: \033<C-'>
650 URxvt.keysym.C-slash: \033<C-/>
651 URxvt.keysym.C-semicolon: \033<C-;>
652 URxvt.keysym.C-grave: \033<C-`>
653 URxvt.keysym.C-comma: \033<C-,>
654 URxvt.keysym.C-period: \033<C-.>
655 URxvt.keysym.C-0x60: \033<C-`>
656 URxvt.keysym.C-Tab: \033<C-Tab>
657 URxvt.keysym.C-Return: \033<C-Return>
658 URxvt.keysym.S-Return: \033<S-Return>
659 URxvt.keysym.S-space: \033<S-Space>
660 URxvt.keysym.M-Up: \033<M-Up>
661 URxvt.keysym.M-Down: \033<M-Down>
662 URxvt.keysym.M-Left: \033<M-Left>
663 URxvt.keysym.M-Right: \033<M-Right>
664 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
665 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
666 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
667
668See some more examples in the documentation for the B<keysym> resource.
669
670=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
671How do I make use of them? For example, the Sun Keyboard type 4
672has the following mappings that rxvt-unicode doesn't recognize.
673
674 KP_Insert == Insert
675 F22 == Print
676 F27 == Home
677 F29 == Prior
678 F33 == End
679 F35 == Next
680
681Rather than have rxvt-unicode try to accommodate all the various possible
682keyboard mappings, it is better to use `xmodmap' to remap the keys as
683required for your particular machine.
684
685=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
686I need this to decide about setting colors etc.
687
688rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
689check and see if that is set. Note that several programs, JED, slrn,
690Midnight Commander automatically check this variable to decide whether or
691not to use color.
692
693=item How do I set the correct, full IP address for the DISPLAY variable?
694
695If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
696insecure mode then it is possible to use the following shell script
697snippets to correctly set the display. If your version of rxvt-unicode
698wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
699the COLORTERM variable can be used to distinguish rxvt-unicode from a
700regular xterm.
701
702Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
703snippets:
704
705 # Bourne/Korn/POSIX family of shells:
706 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
707 if [ ${TERM:-foo} = xterm ]; then
708 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
709 echo -n '^[Z'
710 read term_id
711 stty icanon echo
712 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
713 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
714 read DISPLAY # set it in our local shell
715 fi
716 fi
717
718=item How do I compile the manual pages for myself?
719
720You need to have a recent version of perl installed as F</usr/bin/perl>,
721one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
722the doc subdirectory and enter C<make alldoc>.
723
724=item My question isn't answered here, can I ask a human?
725
726Before sending me mail, you could go to IRC: C<irc.freenode.net>,
727channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
728interested in learning about new and exciting problems (but not FAQs :).
729
730=back
731
732=head1 RXVT TECHNICAL REFERENCE 1056=head1 RXVT-UNICODE TECHNICAL REFERENCE
733
734=head1 DESCRIPTION
735 1057
736The rest of this document describes various technical aspects of 1058The rest of this document describes various technical aspects of
737B<rxvt-unicode>. First the description of supported command sequences, 1059B<rxvt-unicode>. First the description of supported command sequences,
738followed by menu and pixmap support and last by a description of all 1060followed by pixmap support and last by a description of all features
739features selectable at C<configure> time. 1061selectable at C<configure> time.
740 1062
741=head1 Definitions 1063=head2 Definitions
742 1064
743=over 4 1065=over 4
744 1066
745=item B<< C<c> >> 1067=item B<< C<c> >>
746 1068
764 1086
765A text parameter composed of printable characters. 1087A text parameter composed of printable characters.
766 1088
767=back 1089=back
768 1090
769=head1 Values 1091=head2 Values
770 1092
771=over 4 1093=over 4
772 1094
773=item B<< C<ENQ> >> 1095=item B<< C<ENQ> >>
774 1096
817 1139
818Space Character 1140Space Character
819 1141
820=back 1142=back
821 1143
822=head1 Escape Sequences 1144=head2 Escape Sequences
823 1145
824=over 4 1146=over 4
825 1147
826=item B<< C<ESC # 8> >> 1148=item B<< C<ESC # 8> >>
827 1149
925 1247
926=back 1248=back
927 1249
928X<CSI> 1250X<CSI>
929 1251
930=head1 CSI (Command Sequence Introducer) Sequences 1252=head2 CSI (Command Sequence Introducer) Sequences
931 1253
932=over 4 1254=over 4
933 1255
934=item B<< C<ESC [ Ps @> >> 1256=item B<< C<ESC [ Ps @> >>
935 1257
1205 1527
1206=back 1528=back
1207 1529
1208X<PrivateModes> 1530X<PrivateModes>
1209 1531
1210=head1 DEC Private Modes 1532=head2 DEC Private Modes
1211 1533
1212=over 4 1534=over 4
1213 1535
1214=item B<< C<ESC [ ? Pm h> >> 1536=item B<< C<ESC [ ? Pm h> >>
1215 1537
1312 B<< C<h> >> Send Mouse X & Y on button press. 1634 B<< C<h> >> Send Mouse X & Y on button press.
1313 B<< C<l> >> No mouse reporting. 1635 B<< C<l> >> No mouse reporting.
1314 1636
1315=end table 1637=end table
1316 1638
1317=item B<< C<Ps = 10> >> (B<rxvt>)
1318
1319=begin table
1320
1321 B<< C<h> >> menuBar visible
1322 B<< C<l> >> menuBar invisible
1323
1324=end table
1325
1326=item B<< C<Ps = 25> >> 1639=item B<< C<Ps = 25> >>
1327 1640
1328=begin table 1641=begin table
1329 1642
1330 B<< C<h> >> Visible cursor {cnorm/cvvis} 1643 B<< C<h> >> Visible cursor {cnorm/cvvis}
1446 B<< C<h> >> Scroll to bottom when a key is pressed 1759 B<< C<h> >> Scroll to bottom when a key is pressed
1447 B<< C<l> >> Don't scroll to bottom when a key is pressed 1760 B<< C<l> >> Don't scroll to bottom when a key is pressed
1448 1761
1449=end table 1762=end table
1450 1763
1764=item B<< C<Ps = 1021> >> (B<rxvt>)
1765
1766=begin table
1767
1768 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1769 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1770
1771=end table
1772
1451=item B<< C<Ps = 1047> >> 1773=item B<< C<Ps = 1047> >>
1452 1774
1453=begin table 1775=begin table
1454 1776
1455 B<< C<h> >> Use Alternate Screen Buffer 1777 B<< C<h> >> Use Alternate Screen Buffer
1479 1801
1480=back 1802=back
1481 1803
1482X<XTerm> 1804X<XTerm>
1483 1805
1484=head1 XTerm Operating System Commands 1806=head2 XTerm Operating System Commands
1485 1807
1486=over 4 1808=over 4
1487 1809
1488=item B<< C<ESC ] Ps;Pt ST> >> 1810=item B<< C<ESC ] Ps;Pt ST> >>
1489 1811
1501 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1823 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1502 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 1824 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1503 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 1825 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1504 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1826 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1505 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1827 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1506 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1828 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1507 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1829 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1508 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1830 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
1509 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 1831 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1510 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1832 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1511 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 1833 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1512 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> >> 1834 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> >>
1513 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1835 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1514 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). 1836 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).
1515 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar). 1837 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>.
1516 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 1838 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1517 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). 1839 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1840 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1841 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1518 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 1842 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1519 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1843 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1520 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1844 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1521 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1845 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1522 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 1846 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1523 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 1847 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1848 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1524 1849
1525=end table 1850=end table
1526 1851
1527=back 1852=back
1528
1529X<menuBar>
1530
1531=head1 menuBar
1532
1533B<< The exact syntax used is I<almost> solidified. >>
1534In the menus, B<DON'T> try to use menuBar commands that add or remove a
1535menuBar.
1536
1537Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1538omitted: use B<./> to specify a menu relative to the current menu.
1539
1540=head2 Overview of menuBar operation
1541
1542For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1543of C<Pt> can be used for a variety of tasks:
1544
1545At the top level is the current menuBar which is a member of a circular
1546linked-list of other such menuBars.
1547
1548The menuBar acts as a parent for the various drop-down menus, which in
1549turn, may have labels, separator lines, menuItems and subMenus.
1550
1551The menuItems are the useful bits: you can use them to mimic keyboard
1552input or even to send text or escape sequences back to rxvt.
1553
1554The menuBar syntax is intended to provide a simple yet robust method of
1555constructing and manipulating menus and navigating through the
1556menuBars.
1557
1558The first step is to use the tag B<< [menu:I<name>] >> which creates
1559the menuBar called I<name> and allows access. You may now or menus,
1560subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1561menuBar access as B<readonly> to prevent accidental corruption of the
1562menus. To re-access the current menuBar for alterations, use the tag
1563B<[menu]>, make the alterations and then use B<[done]>
1564
1565X<menuBarCommands>
1566
1567=head2 Commands
1568
1569=over 4
1570
1571=item B<< [menu:+I<name>] >>
1572
1573access the named menuBar for creation or alteration. If a new menuBar
1574is created, it is called I<name> (max of 15 chars) and the current
1575menuBar is pushed onto the stack
1576
1577=item B<[menu]>
1578
1579access the current menuBar for alteration
1580
1581=item B<< [title:+I<string>] >>
1582
1583set the current menuBar's title to I<string>, which may contain the
1584following format specifiers:
1585
1586 B<%n> rxvt name (as per the B<-name> command-line option)
1587 B<%v> rxvt version
1588 B<%%> literal B<%> character
1589
1590=item B<[done]>
1591
1592set menuBar access as B<readonly>.
1593End-of-file tag for B<< [read:+I<file>] >> operations.
1594
1595=item B<< [read:+I<file>] >>
1596
1597read menu commands directly from I<file> (extension ".menu" will be
1598appended if required.) Start reading at a line with B<[menu]> or B<<
1599[menu:+I<name> >> and continuing until B<[done]> is encountered.
1600
1601Blank and comment lines (starting with B<#>) are ignored. Actually,
1602since any invalid menu commands are also ignored, almost anything could
1603be construed as a comment line, but this may be tightened up in the
1604future ... so don't count on it!.
1605
1606=item B<< [read:+I<file>;+I<name>] >>
1607
1608The same as B<< [read:+I<file>] >>, but start reading at a line with
1609B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1610B<[done]> is encountered.
1611
1612=item B<[dump]>
1613
1614dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1615later rereading.
1616
1617=item B<[rm:name]>
1618
1619remove the named menuBar
1620
1621=item B<[rm] [rm:]>
1622
1623remove the current menuBar
1624
1625=item B<[rm*] [rm:*]>
1626
1627remove all menuBars
1628
1629=item B<[swap]>
1630
1631swap the top two menuBars
1632
1633=item B<[prev]>
1634
1635access the previous menuBar
1636
1637=item B<[next]>
1638
1639access the next menuBar
1640
1641=item B<[show]>
1642
1643Enable display of the menuBar
1644
1645=item B<[hide]>
1646
1647Disable display of the menuBar
1648
1649=item B<< [pixmap:+I<name>] >>
1650
1651=item B<< [pixmap:+I<name>;I<scaling>] >>
1652
1653(set the background pixmap globally
1654
1655B<< A Future implementation I<may> make this local to the menubar >>)
1656
1657=item B<< [:+I<command>:] >>
1658
1659ignore the menu readonly status and issue a I<command> to or a menu or
1660menuitem or change the ; a useful shortcut for setting the quick arrows
1661from a menuBar.
1662
1663=back
1664
1665X<menuBarAdd>
1666
1667=head2 Adding and accessing menus
1668
1669The following commands may also be B<+> prefixed.
1670
1671=over 4
1672
1673=item B</+>
1674
1675access menuBar top level
1676
1677=item B<./+>
1678
1679access current menu level
1680
1681=item B<../+>
1682
1683access parent menu (1 level up)
1684
1685=item B<../../>
1686
1687access parent menu (multiple levels up)
1688
1689=item B<< I</path/>menu >>
1690
1691add/access menu
1692
1693=item B<< I</path/>menu/* >>
1694
1695add/access menu and clear it if it exists
1696
1697=item B<< I</path/>{-} >>
1698
1699add separator
1700
1701=item B<< I</path/>{item} >>
1702
1703add B<item> as a label
1704
1705=item B<< I</path/>{item} action >>
1706
1707add/alter I<menuitem> with an associated I<action>
1708
1709=item B<< I</path/>{item}{right-text} >>
1710
1711add/alter I<menuitem> with B<right-text> as the right-justified text
1712and as the associated I<action>
1713
1714=item B<< I</path/>{item}{rtext} action >>
1715
1716add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1717the right-justified text.
1718
1719=back
1720
1721=over 4
1722
1723=item Special characters in I<action> must be backslash-escaped:
1724
1725B<\a \b \E \e \n \r \t \octal>
1726
1727=item or in control-character notation:
1728
1729B<^@, ^A .. ^Z .. ^_, ^?>
1730
1731=back
1732
1733To send a string starting with a B<NUL> (B<^@>) character to the
1734program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1735the first of which will be stripped off and the balance directed to the
1736program. Otherwise if I<action> begins with B<NUL> followed by
1737non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1738balance is sent back to rxvt.
1739
1740As a convenience for the many Emacs-type editors, I<action> may start
1741with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1742appended if missed from B<M-x> commands.
1743
1744As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1745quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1746
1747=over 4
1748
1749=item For example,
1750
1751B<M-xapropos> is equivalent to B<\Exapropos\r>
1752
1753=item and
1754
1755B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1756
1757=back
1758
1759The option B<< {I<right-rtext>} >> will be right-justified. In the
1760absence of a specified action, this text will be used as the I<action>
1761as well.
1762
1763=over 4
1764
1765=item For example,
1766
1767B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1768
1769=back
1770
1771The left label I<is> necessary, since it's used for matching, but
1772implicitly hiding the left label (by using same name for both left and
1773right labels), or explicitly hiding the left label (by preceeding it
1774with a dot), makes it possible to have right-justified text only.
1775
1776=over 4
1777
1778=item For example,
1779
1780B</File/{Open}{Open} Open-File-Action>
1781
1782=item or hiding it
1783
1784B</File/{.anylabel}{Open} Open-File-Action>
1785
1786=back
1787
1788X<menuBarRemove>
1789
1790=head2 Removing menus
1791
1792=over 4
1793
1794=item B<< -/*+ >>
1795
1796remove all menus from the menuBar, the same as B<[clear]>
1797
1798=item B<< -+I</path>menu+ >>
1799
1800remove menu
1801
1802=item B<< -+I</path>{item}+ >>
1803
1804remove item
1805
1806=item B<< -+I</path>{-} >>
1807
1808remove separator)
1809
1810=item B<-/path/menu/*>
1811
1812remove all items, separators and submenus from menu
1813
1814=back
1815
1816X<menuBarArrows>
1817
1818=head2 Quick Arrows
1819
1820The menus also provide a hook for I<quick arrows> to provide easier
1821user access. If nothing has been explicitly set, the default is to
1822emulate the curror keys. The syntax permits each arrow to be altered
1823individually or all four at once without re-entering their common
1824beginning/end text. For example, to explicitly associate cursor actions
1825with the arrows, any of the following forms could be used:
1826
1827=over 4
1828
1829=item B<< <r>+I<Right> >>
1830
1831=item B<< <l>+I<Left> >>
1832
1833=item B<< <u>+I<Up> >>
1834
1835=item B<< <d>+I<Down> >>
1836
1837Define actions for the respective arrow buttons
1838
1839=item B<< <b>+I<Begin> >>
1840
1841=item B<< <e>+I<End> >>
1842
1843Define common beginning/end parts for I<quick arrows> which used in
1844conjunction with the above <r> <l> <u> <d> constructs
1845
1846=back
1847
1848=over 4
1849
1850=item For example, define arrows individually,
1851
1852 <u>\E[A
1853
1854 <d>\E[B
1855
1856 <r>\E[C
1857
1858 <l>\E[D
1859
1860=item or all at once
1861
1862 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1863
1864=item or more compactly (factoring out common parts)
1865
1866 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1867
1868=back
1869
1870X<menuBarSummary>
1871
1872=head2 Command Summary
1873
1874A short summary of the most I<common> commands:
1875
1876=over 4
1877
1878=item [menu:name]
1879
1880use an existing named menuBar or start a new one
1881
1882=item [menu]
1883
1884use the current menuBar
1885
1886=item [title:string]
1887
1888set menuBar title
1889
1890=item [done]
1891
1892set menu access to readonly and, if reading from a file, signal EOF
1893
1894=item [done:name]
1895
1896if reading from a file using [read:file;name] signal EOF
1897
1898=item [rm:name]
1899
1900remove named menuBar(s)
1901
1902=item [rm] [rm:]
1903
1904remove current menuBar
1905
1906=item [rm*] [rm:*]
1907
1908remove all menuBar(s)
1909
1910=item [swap]
1911
1912swap top two menuBars
1913
1914=item [prev]
1915
1916access the previous menuBar
1917
1918=item [next]
1919
1920access the next menuBar
1921
1922=item [show]
1923
1924map menuBar
1925
1926=item [hide]
1927
1928unmap menuBar
1929
1930=item [pixmap;file]
1931
1932=item [pixmap;file;scaling]
1933
1934set a background pixmap
1935
1936=item [read:file]
1937
1938=item [read:file;name]
1939
1940read in a menu from a file
1941
1942=item [dump]
1943
1944dump out all menuBars to /tmp/rxvt-PID
1945
1946=item /
1947
1948access menuBar top level
1949
1950=item ./
1951
1952=item ../
1953
1954=item ../../
1955
1956access current or parent menu level
1957
1958=item /path/menu
1959
1960add/access menu
1961
1962=item /path/{-}
1963
1964add separator
1965
1966=item /path/{item}{rtext} action
1967
1968add/alter menu item
1969
1970=item -/*
1971
1972remove all menus from the menuBar
1973
1974=item -/path/menu
1975
1976remove menu items, separators and submenus from menu
1977
1978=item -/path/menu
1979
1980remove menu
1981
1982=item -/path/{item}
1983
1984remove item
1985
1986=item -/path/{-}
1987
1988remove separator
1989
1990=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1991
1992menu quick arrows
1993
1994=back
1995X<XPM>
1996 1853
1997=head1 XPM 1854=head1 XPM
1998 1855
1999For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 1856For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
2000of B<< C<Pt> >> can be the name of the background pixmap followed by a 1857of B<< C<Pt> >> can be the name of the background pixmap followed by a
2098=begin table 1955=begin table
2099 1956
2100 4 Shift 1957 4 Shift
2101 8 Meta 1958 8 Meta
2102 16 Control 1959 16 Control
2103 32 Double Click I<(Rxvt extension)> 1960 32 Double Click I<(rxvt extension)>
2104 1961
2105=end table 1962=end table
2106 1963
2107Col = B<< C<< <x> - SPACE >> >> 1964Col = B<< C<< <x> - SPACE >> >>
2108 1965
2185=end table 2042=end table
2186 2043
2187=head1 CONFIGURE OPTIONS 2044=head1 CONFIGURE OPTIONS
2188 2045
2189General hint: if you get compile errors, then likely your configuration 2046General hint: if you get compile errors, then likely your configuration
2190hasn't been tested well. Either try with --enable-everything or use the 2047hasn't been tested well. Either try with C<--enable-everything> or use
2191./reconf script as a base for experiments. ./reconf is used by myself, 2048the F<./reconf> script as a base for experiments. F<./reconf> is used by
2192so it should generally be a working config. Of course, you should always 2049myself, so it should generally be a working config. Of course, you should
2193report when a combination doesn't work, so it can be fixed. Marc Lehmann 2050always report when a combination doesn't work, so it can be fixed. Marc
2194<rxvt@schmorp.de>. 2051Lehmann <rxvt@schmorp.de>.
2052
2053All
2195 2054
2196=over 4 2055=over 4
2197 2056
2198=item --enable-everything 2057=item --enable-everything
2199 2058
2200Add support for all non-multichoice options listed in "./configure 2059Add (or remove) support for all non-multichoice options listed in "./configure
2201--help". Note that unlike other enable options this is order dependant. 2060--help".
2061
2202You can specify this and then disable options which this enables by 2062You can specify this and then disable options you do not like by
2203I<following> this with the appropriate commands. 2063I<following> this with the appropriate C<--disable-...> arguments,
2064or you can start with a minimal configuration by specifying
2065C<--disable-everything> and than adding just the C<--enable-...> arguments
2066you want.
2204 2067
2205=item --enable-xft 2068=item --enable-xft (default: enabled)
2206 2069
2207Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2070Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2208slower and require lots of memory, but as long as you don't use them, you 2071slower and require lots of memory, but as long as you don't use them, you
2209don't pay for them. 2072don't pay for them.
2210 2073
2211=item --enable-font-styles 2074=item --enable-font-styles (default: on)
2212 2075
2213Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2076Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2214styles. The fonts can be set manually or automatically. 2077styles. The fonts can be set manually or automatically.
2215 2078
2216=item --with-codesets=NAME,... 2079=item --with-codesets=NAME,... (default: all)
2217 2080
2218Compile in support for additional codeset (encoding) groups (C<eu>, C<vn> 2081Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2219are always compiled in, which includes most 8-bit character sets). These 2082are always compiled in, which includes most 8-bit character sets). These
2220codeset tables are used for driving X11 core fonts, they are not required 2083codeset tables are used for driving X11 core fonts, they are not required
2221for Xft fonts, although having them compiled in lets rxvt-unicode choose 2084for Xft fonts, although having them compiled in lets rxvt-unicode choose
2232 jp_ext rarely used but big japanese encodings 2095 jp_ext rarely used but big japanese encodings
2233 kr korean encodings 2096 kr korean encodings
2234 2097
2235=end table 2098=end table
2236 2099
2237=item --enable-xim 2100=item --enable-xim (default: on)
2238 2101
2239Add support for XIM (X Input Method) protocol. This allows using 2102Add support for XIM (X Input Method) protocol. This allows using
2240alternative input methods (e.g. kinput2) and will also correctly 2103alternative input methods (e.g. kinput2) and will also correctly
2241set up the input for people using dead keys or compose keys. 2104set up the input for people using dead keys or compose keys.
2242 2105
2243=item --enable-unicode3 2106=item --enable-unicode3 (default: off)
2107
2108Recommended to stay off unless you really need non-BMP characters.
2244 2109
2245Enable direct support for displaying unicode codepoints above 2110Enable direct support for displaying unicode codepoints above
224665535 (the basic multilingual page). This increases storage 211165535 (the basic multilingual page). This increases storage
2247requirements per character from 2 to 4 bytes. X11 fonts do not yet 2112requirements per character from 2 to 4 bytes. X11 fonts do not yet
2248support these extra characters, but Xft does. 2113support these extra characters, but Xft does.
2251even without this flag, but the number of such characters is 2116even without this flag, but the number of such characters is
2252limited to a view thousand (shared with combining characters, 2117limited to a view thousand (shared with combining characters,
2253see next switch), and right now rxvt-unicode cannot display them 2118see next switch), and right now rxvt-unicode cannot display them
2254(input/output and cut&paste still work, though). 2119(input/output and cut&paste still work, though).
2255 2120
2256=item --enable-combining 2121=item --enable-combining (default: on)
2257 2122
2258Enable automatic composition of combining characters into 2123Enable automatic composition of combining characters into
2259composite characters. This is required for proper viewing of text 2124composite characters. This is required for proper viewing of text
2260where accents are encoded as seperate unicode characters. This is 2125where accents are encoded as seperate unicode characters. This is
2261done by using precomposited characters when available or creating 2126done by using precomposited characters when available or creating
2262new pseudo-characters when no precomposed form exists. 2127new pseudo-characters when no precomposed form exists.
2263 2128
2264Without --enable-unicode3, the number of additional precomposed characters 2129Without --enable-unicode3, the number of additional precomposed
2265is rather limited (2048, if this is full, rxvt-unicode will use the 2130characters is somewhat limited (the 6400 private use characters will be
2266private use area, extending the number of combinations to 8448). With
2267--enable-unicode3, no practical limit exists. 2131(ab-)used). With --enable-unicode3, no practical limit exists.
2268 2132
2269This option will also enable storage (but not display) of characters 2133This option will also enable storage (but not display) of characters
2270beyond plane 0 (>65535) when --enable-unicode3 was not specified. 2134beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2271 2135
2272The combining table also contains entries for arabic presentation forms, 2136The combining table also contains entries for arabic presentation forms,
2273but these are not currently used. Bug me if you want these to be used (and 2137but these are not currently used. Bug me if you want these to be used (and
2274tell me how these are to be used...). 2138tell me how these are to be used...).
2275 2139
2276=item --enable-fallback(=CLASS) 2140=item --enable-fallback(=CLASS) (default: Rxvt)
2277 2141
2278When reading resource settings, also read settings for class CLASS 2142When reading resource settings, also read settings for class CLASS. To
2279(default: Rxvt). To disable resource fallback use --disable-fallback. 2143disable resource fallback use --disable-fallback.
2280 2144
2281=item --with-res-name=NAME 2145=item --with-res-name=NAME (default: urxvt)
2282 2146
2283Use the given name (default: urxvt) as default application name when 2147Use the given name as default application name when
2284reading resources. Specify --with-res-name=rxvt to replace rxvt. 2148reading resources. Specify --with-res-name=rxvt to replace rxvt.
2285 2149
2286=item --with-res-class=CLASS 2150=item --with-res-class=CLASS /default: URxvt)
2287 2151
2288Use the given class (default: URxvt) as default application class 2152Use the given class as default application class
2289when reading resources. Specify --with-res-class=Rxvt to replace 2153when reading resources. Specify --with-res-class=Rxvt to replace
2290rxvt. 2154rxvt.
2291 2155
2292=item --enable-utmp 2156=item --enable-utmp (default: on)
2293 2157
2294Write user and tty to utmp file (used by programs like F<w>) at 2158Write user and tty to utmp file (used by programs like F<w>) at
2295start of rxvt execution and delete information when rxvt exits. 2159start of rxvt execution and delete information when rxvt exits.
2296 2160
2297=item --enable-wtmp 2161=item --enable-wtmp (default: on)
2298 2162
2299Write user and tty to wtmp file (used by programs like F<last>) at 2163Write user and tty to wtmp file (used by programs like F<last>) at
2300start of rxvt execution and write logout when rxvt exits. This 2164start of rxvt execution and write logout when rxvt exits. This
2301option requires --enable-utmp to also be specified. 2165option requires --enable-utmp to also be specified.
2302 2166
2303=item --enable-lastlog 2167=item --enable-lastlog (default: on)
2304 2168
2305Write user and tty to lastlog file (used by programs like 2169Write user and tty to lastlog file (used by programs like
2306F<lastlogin>) at start of rxvt execution. This option requires 2170F<lastlogin>) at start of rxvt execution. This option requires
2307--enable-utmp to also be specified. 2171--enable-utmp to also be specified.
2308 2172
2309=item --enable-xpm-background 2173=item --enable-xpm-background (default: on)
2310 2174
2311Add support for XPM background pixmaps. 2175Add support for XPM background pixmaps.
2312 2176
2313=item --enable-transparency 2177=item --enable-transparency (default: on)
2314 2178
2315Add support for inheriting parent backgrounds thus giving a fake 2179Add support for inheriting parent backgrounds thus giving a fake
2316transparency to the term. 2180transparency to the term.
2317 2181
2318=item --enable-fading 2182=item --enable-fading (default: on)
2319 2183
2320Add support for fading the text when focus is lost. 2184Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2321 2185
2322=item --enable-tinting 2186=item --enable-tinting (default: on)
2323 2187
2324Add support for tinting of transparent backgrounds. 2188Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2325 2189
2326=item --enable-menubar
2327
2328Add support for our menu bar system (this interacts badly with
2329dynamic locale switching currently).
2330
2331=item --enable-rxvt-scroll 2190=item --enable-rxvt-scroll (default: on)
2332 2191
2333Add support for the original rxvt scrollbar. 2192Add support for the original rxvt scrollbar.
2334 2193
2335=item --enable-next-scroll 2194=item --enable-next-scroll (default: on)
2336 2195
2337Add support for a NeXT-like scrollbar. 2196Add support for a NeXT-like scrollbar.
2338 2197
2339=item --enable-xterm-scroll 2198=item --enable-xterm-scroll (default: on)
2340 2199
2341Add support for an Xterm-like scrollbar. 2200Add support for an Xterm-like scrollbar.
2342 2201
2343=item --enable-plain-scroll 2202=item --enable-plain-scroll (default: on)
2344 2203
2345Add support for a very unobtrusive, plain-looking scrollbar that 2204Add support for a very unobtrusive, plain-looking scrollbar that
2346is the favourite of the rxvt-unicode author, having used it for 2205is the favourite of the rxvt-unicode author, having used it for
2347many years. 2206many years.
2348 2207
2349=item --enable-half-shadow 2208=item --enable-ttygid (default: off)
2350
2351Make shadows on the scrollbar only half the normal width & height.
2352only applicable to rxvt scrollbars.
2353
2354=item --enable-ttygid
2355 2209
2356Change tty device setting to group "tty" - only use this if 2210Change tty device setting to group "tty" - only use this if
2357your system uses this type of security. 2211your system uses this type of security.
2358 2212
2359=item --disable-backspace-key 2213=item --disable-backspace-key
2360 2214
2361Disable any handling of the backspace key by us - let the X server 2215Removes any handling of the backspace key by us - let the X server do it.
2216
2217=item --disable-delete-key
2218
2219Removes any handling of the delete key by us - let the X server
2362do it. 2220do it.
2363 2221
2364=item --disable-delete-key
2365
2366Disable any handling of the delete key by us - let the X server
2367do it.
2368
2369=item --disable-resources 2222=item --disable-resources
2370 2223
2371Remove all resources checking. 2224Removes any support for resource checking.
2372
2373=item --enable-xgetdefault
2374
2375Make resources checking via XGetDefault() instead of our small
2376version which only checks ~/.Xdefaults, or if that doesn't exist then
2377~/.Xresources.
2378
2379Please note that nowadays, things like XIM will automatically pull in and
2380use the full X resource manager, so the overhead of using it might be very
2381small, if nonexistant.
2382
2383=item --enable-strings
2384
2385Add support for our possibly faster memset() function and other
2386various routines, overriding your system's versions which may
2387have been hand-crafted in assembly or may require extra libraries
2388to link in. (this breaks ANSI-C rules and has problems on many
2389GNU/Linux systems).
2390 2225
2391=item --disable-swapscreen 2226=item --disable-swapscreen
2392 2227
2393Remove support for swap screen. 2228Remove support for secondary/swap screen.
2394 2229
2395=item --enable-frills 2230=item --enable-frills (default: on)
2396 2231
2397Add support for many small features that are not essential but nice to 2232Add support for many small features that are not essential but nice to
2398have. Normally you want this, but for very small binaries you may want to 2233have. Normally you want this, but for very small binaries you may want to
2399disable this. 2234disable this.
2400 2235
2401A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2236A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2402in combination with other switches) is: 2237in combination with other switches) is:
2403 2238
2404 MWM-hints 2239 MWM-hints
2405 EWMH-hints (pid, utf8 names) and protocols (ping) 2240 EWMH-hints (pid, utf8 names) and protocols (ping)
2406 seperate underline colour 2241 seperate underline colour (-underlineColor)
2407 settable border widths and borderless switch 2242 settable border widths and borderless switch (-w, -b, -bl)
2243 visual depth selection (-depth)
2408 settable extra linespacing 2244 settable extra linespacing /-lsp)
2409 iso-14755-2 and -3, and visual feedback 2245 iso-14755-2 and -3, and visual feedback
2246 tripleclickwords (-tcw)
2247 settable insecure mode (-insecure)
2248 keysym remapping support
2249 cursor blinking and underline cursor (-cb, -uc)
2250 XEmbed support (-embed)
2251 user-pty (-pty-fd)
2252 hold on exit (-hold)
2253 skip builtin block graphics (-sbg)
2254
2255It also enabled some non-essential features otherwise disabled, such as:
2256
2257 some round-trip time optimisations
2258 nearest color allocation on pseudocolor screens
2259 UTF8_STRING supporr for selection
2260 sgr modes 90..97 and 100..107
2410 backindex and forwardindex escape sequence 2261 backindex and forwardindex escape sequences
2262 view change/zero scorllback esacpe sequences
2263 locale switching escape sequence
2411 window op and some xterm/OSC escape sequences 2264 window op and some xterm/OSC escape sequences
2412 tripleclickwords 2265 rectangular selections
2413 settable insecure mode 2266 trailing space removal for selections
2414 keysym remapping support 2267 verbose X error handling
2415 cursor blinking and underline cursor
2416 -embed and -pty-fd options
2417 2268
2418=item --enable-iso14755 2269=item --enable-iso14755 (default: on)
2419 2270
2420Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2271Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2421F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2272F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2422C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2273C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2423this switch. 2274this switch.
2424 2275
2425=item --enable-keepscrolling 2276=item --enable-keepscrolling (default: on)
2426 2277
2427Add support for continual scrolling of the display when you hold 2278Add support for continual scrolling of the display when you hold
2428the mouse button down on a scrollbar arrow. 2279the mouse button down on a scrollbar arrow.
2429 2280
2430=item --enable-mousewheel 2281=item --enable-mousewheel (default: on)
2431 2282
2432Add support for scrolling via mouse wheel or buttons 4 & 5. 2283Add support for scrolling via mouse wheel or buttons 4 & 5.
2433 2284
2434=item --enable-slipwheeling 2285=item --enable-slipwheeling (default: on)
2435 2286
2436Add support for continual scrolling (using the mouse wheel as an 2287Add support for continual scrolling (using the mouse wheel as an
2437accelerator) while the control key is held down. This option 2288accelerator) while the control key is held down. This option
2438requires --enable-mousewheel to also be specified. 2289requires --enable-mousewheel to also be specified.
2439 2290
2440=item --disable-new-selection 2291=item --disable-new-selection
2441 2292
2442Remove support for mouse selection style like that of xterm. 2293Remove support for mouse selection style like that of xterm.
2443 2294
2444=item --enable-dmalloc 2295=item --enable-dmalloc (default: off)
2445 2296
2446Use Gray Watson's malloc - which is good for debugging See 2297Use Gray Watson's malloc - which is good for debugging See
2447http://www.letters.com/dmalloc/ for details If you use either this or the 2298L<http://www.letters.com/dmalloc/> for details If you use either this or the
2448next option, you may need to edit src/Makefile after compiling to point 2299next option, you may need to edit src/Makefile after compiling to point
2449DINCLUDE and DLIB to the right places. 2300DINCLUDE and DLIB to the right places.
2450 2301
2451You can only use either this option and the following (should 2302You can only use either this option and the following (should
2452you use either) . 2303you use either) .
2453 2304
2454=item --enable-dlmalloc 2305=item --enable-dlmalloc (default: off)
2455 2306
2456Use Doug Lea's malloc - which is good for a production version 2307Use Doug Lea's malloc - which is good for a production version
2457See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2308See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2458 2309
2459=item --enable-smart-resize 2310=item --enable-smart-resize (default: on)
2460 2311
2461Add smart growth/shrink behaviour when changing font size via from hot 2312Add smart growth/shrink behaviour when changing font size via hot
2462keys. This should keep in a fixed position the rxvt corner which is 2313keys. This should keep the window corner which is closest to a corner of
2463closest to a corner of the screen. 2314the screen in a fixed position.
2464 2315
2465=item --enable-pointer-blank 2316=item --enable-pointer-blank (default: on)
2466 2317
2467Add support to have the pointer disappear when typing or inactive. 2318Add support to have the pointer disappear when typing or inactive.
2468 2319
2469=item --with-name=NAME 2320=item --enable-perl (default: on)
2470 2321
2322Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2323manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2324in F<src/perl-ext/> for the extensions that are installed by default. The
2325perl interpreter that is used can be specified via the C<PERL> environment
2326variable when running configure.
2327
2328=item --with-name=NAME (default: urxvt)
2329
2471Set the basename for the installed binaries (default: C<urxvt>, resulting 2330Set the basename for the installed binaries, resulting
2472in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2331in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2473C<rxvt>. 2332C<rxvt>.
2474 2333
2475=item --with-term=NAME 2334=item --with-term=NAME (default: rxvt-unicode)
2476 2335
2477Change the environmental variable for the terminal to NAME (default 2336Change the environmental variable for the terminal to NAME.
2478C<rxvt-unicode>)
2479 2337
2480=item --with-terminfo=PATH 2338=item --with-terminfo=PATH
2481 2339
2482Change the environmental variable for the path to the terminfo tree to 2340Change the environmental variable for the path to the terminfo tree to
2483PATH. 2341PATH.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines