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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines