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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.51 by root, Mon Feb 21 19:26:06 2005 UTC vs.
Revision 1.105 by root, Tue Jan 31 21:00:26 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 do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
79
80The original rxvt and rxvt-unicode always export the variable "COLORTERM",
81so you can check and see if that is set. Note that several programs, JED,
82slrn, Midnight Commander automatically check this variable to decide
83whether or not to use color.
84
85=head3 How do I set the correct, full IP address for the DISPLAY variable?
86
87If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
88insecure mode then it is possible to use the following shell script
89snippets to correctly set the display. If your version of rxvt-unicode
90wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
91the COLORTERM variable can be used to distinguish rxvt-unicode from a
92regular xterm.
93
94Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
95snippets:
96
97 # Bourne/Korn/POSIX family of shells:
98 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
99 if [ ${TERM:-foo} = xterm ]; then
100 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
101 echo -n '^[Z'
102 read term_id
103 stty icanon echo
104 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
105 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
106 read DISPLAY # set it in our local shell
107 fi
108 fi
109
110=head3 How do I compile the manual pages on my own?
111
112You need to have a recent version of perl installed as F</usr/bin/perl>,
113one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
114the doc subdirectory and enter C<make alldoc>.
115
116=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
117
118I often get asked about this, and I think, no, they didn't cause extra
119bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
120that the urxvt binary is larger (due to some encoding tables always being
121compiled in), but it actually uses less memory (RSS) after startup. Even
122with C<--disable-everything>, this comparison is a bit unfair, as many
123features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
124already in use in this mode.
125
126 text data bss drs rss filename
127 98398 1664 24 15695 1824 rxvt --disable-everything
128 188985 9048 66616 18222 1788 urxvt --disable-everything
129
130When you C<--enable-everything> (which _is_ unfair, as this involves xft
131and full locale/XIM support which are quite bloaty inside libX11 and my
132libc), the two diverge, but not unreasnobaly so.
133
134 text data bss drs rss filename
135 163431 2152 24 20123 2060 rxvt --enable-everything
136 1035683 49680 66648 29096 3680 urxvt --enable-everything
137
138The very large size of the text section is explained by the east-asian
139encoding tables, which, if unused, take up disk space but nothing else
140and can be compiled out unless you rely on X11 core fonts that use those
141encodings. The BSS size comes from the 64k emergency buffer that my c++
142compiler allocates (but of course doesn't use unless you are out of
143memory). Also, using an xft font instead of a core font immediately adds a
144few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
145not used.
146
147Of course, due to every character using two or four bytes instead of one,
148a large scrollback buffer will ultimately make rxvt-unicode use more
149memory.
150
151Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
152still fares rather well. And compared to some monsters like gnome-terminal
153(21152k + extra 4204k in separate processes) or konsole (22200k + extra
15443180k in daemons that stay around after exit, plus half a minute of
155startup time, including the hundreds of warnings it spits out), it fares
156extremely well *g*.
157
158=head3 Why C++, isn't that unportable/bloated/uncool?
159
160Is this a question? :) It comes up very often. The simple answer is: I had
161to write it, and C++ allowed me to write and maintain it in a fraction
162of the time and effort (which is a scarce resource for me). Put even
163shorter: It simply wouldn't exist without C++.
164
165My personal stance on this is that C++ is less portable than C, but in
166the case of rxvt-unicode this hardly matters, as its portability limits
167are defined by things like X11, pseudo terminals, locale support and unix
168domain sockets, which are all less portable than C++ itself.
169
170Regarding the bloat, see the above question: It's easy to write programs
171in C that use gobs of memory, an certainly possible to write programs in
172C++ that don't. C++ also often comes with large libraries, but this is
173not necessarily the case with GCC. Here is what rxvt links against on my
174system with a minimal config:
175
176 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
177 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
178 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
179 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
180
181And here is rxvt-unicode:
182
183 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
184 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
185 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
186 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
187 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
188
189No large bloated libraries (of course, none were linked in statically),
190except maybe libX11 :)
191
192
193=head2 Rendering, Font & Look and Feel Issues
194
195=head3 I can't get transparency working, what am I doing wrong?
196
197First of all, transparency isn't officially supported in rxvt-unicode, so
198you are mostly on your own. Do not bug the author about it (but you may
199bug everybody else). Also, if you can't get it working consider it a rite
200of passage: ... and you failed.
201
202Here are four ways to get transparency. B<Do> read the manpage and option
203descriptions for the programs mentioned and rxvt-unicode. Really, do it!
204
2051. Use inheritPixmap:
206
207 Esetroot wallpaper.jpg
208 @@URXVT_NAME@@ -ip -tint red -sh 40
209
210That works. If you think it doesn't, you lack transparency and tinting
211support, or you are unable to read.
212
2132. Use a simple pixmap and emulate pseudo-transparency. This enables you
214to use effects other than tinting and shading: Just shade/tint/whatever
215your picture with gimp or any other tool:
216
217 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
218 @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background
219
220That works. If you think it doesn't, you lack XPM and Perl support, or you
221are unable to read.
222
2233. Use an ARGB visual:
224
225 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
226
227This requires XFT support, and the support of your X-server. If that
228doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
229there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
230bugfixes and workarounds for Xft and Xlib to make it work, but that
231doesn't mean that your WM has the required kludges in place.
232
2334. Use xcompmgr and let it do the job:
234
235 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
236 -set _NET_WM_WINDOW_OPACITY 0xc0000000
237
238Then click on a window you want to make transparent. Replace C<0xc0000000>
239by other values to change the degree of opacity. If it doesn't work and
240your server crashes, you got to keep the pieces.
241
242=head3 Why do some chinese characters look so different than others?
243
244This is because there is a difference between script and language --
245rxvt-unicode does not know which language the text that is output is,
246as it only knows the unicode character codes. If rxvt-unicode first
247sees a japanese/chinese character, it might choose a japanese font for
248display. Subsequent japanese characters will use that font. Now, many
249chinese characters aren't represented in japanese fonts, so when the first
250non-japanese character comes up, rxvt-unicode will look for a chinese font
251-- unfortunately at this point, it will still use the japanese font for
252chinese characters that are also in the japanese font.
253
254The workaround is easy: just tag a chinese font at the end of your font
255list (see the previous question). The key is to view the font list as
256a preference list: If you expect more japanese, list a japanese font
257first. If you expect more chinese, put a chinese font first.
258
259In the future it might be possible to switch language preferences at
260runtime (the internal data structure has no problem with using different
261fonts for the same character at the same time, but no interface for this
262has been designed yet).
263
264Until then, you might get away with switching fonts at runtime (see L<Can
265I switch the fonts at runtime?> later in this document).
266
267=head3 Why does rxvt-unicode sometimes leave pixel droppings?
268
269Most fonts were not designed for terminal use, which means that character
270size varies a lot. A font that is otherwise fine for terminal use might
271contain some characters that are simply too wide. Rxvt-unicode will avoid
272these characters. For characters that are just "a bit" too wide a special
273"careful" rendering mode is used that redraws adjacent characters.
274
275All of this requires that fonts do not lie about character sizes,
276however: Xft fonts often draw glyphs larger than their acclaimed bounding
277box, and rxvt-unicode has no way of detecting this (the correct way is to
278ask for the character bounding box, which unfortunately is wrong in these
279cases).
280
281It's not clear (to me at least), wether this is a bug in Xft, freetype,
282or the respective font. If you encounter this problem you might try using
283the C<-lsp> option to give the font more height. If that doesn't work, you
284might be forced to use a different font.
285
286All of this is not a problem when using X11 core fonts, as their bounding
287box data is correct.
288
289=head3 How can I keep rxvt-unicode from using reverse video so much?
290
291First of all, make sure you are running with the right terminal settings
292(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
293make sure you have specified colours for italic and bold, as otherwise
294rxvt-unicode might use reverse video to simulate the effect:
295
296 URxvt.colorBD: white
297 URxvt.colorIT: green
298
299=head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
300
301For some unexplainable reason, some rare programs assume a very weird
302colour palette when confronted with a terminal with more than the standard
3038 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
304these programs not to assume non-ISO colours without very good reasons.
305
306In the meantime, you can either edit your C<rxvt-unicode> terminfo
307definition to only claim 8 colour support or use C<TERM=rxvt>, which will
308fix colours but keep you from using other rxvt-unicode features.
309
310=head3 Can I switch the fonts at runtime?
311
312Yes, using an escape sequence. Try something like this, which has the same
313effect as using the C<-fn> switch, and takes effect immediately:
314
315 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
316
317This is useful if you e.g. work primarily with japanese (and prefer a
318japanese font), but you have to switch to chinese temporarily, where
319japanese fonts would only be in your way.
320
321You can think of this as a kind of manual ISO-2022 switching.
322
323=head3 Why do italic characters look as if clipped?
324
325Many fonts have difficulties with italic characters and hinting. For
326example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
327Mono> completely fails in it's italic face. A workaround might be to
328enable freetype autohinting, i.e. like this:
329
330 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
331 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
332
333=head3 Can I speed up Xft rendering somehow?
334
335Yes, the most obvious way to speed it up is to avoid Xft entirely, as
336it is simply slow. If you still want Xft fonts you might try to disable
337antialiasing (by appending C<:antialias=false>), which saves lots of
338memory and also speeds up rendering considerably.
339
340=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
341
342Rxvt-unicode will use whatever you specify as a font. If it needs to
343fall back to it's default font search list it will prefer X11 core
344fonts, because they are small and fast, and then use Xft fonts. It has
345antialiasing disabled for most of them, because the author thinks they
346look best that way.
347
348If you want antialiasing, you have to specify the fonts manually.
349
350=head3 What's with this bold/blink stuff?
351
352If no bold colour is set via C<colorBD:>, bold will invert text using the
353standard foreground colour.
354
355For the standard background colour, blinking will actually make the
356text blink when compiled with C<--enable-blinking>. with standard
357colours. Without C<--enable-blinking>, the blink attribute will be
358ignored.
359
360On ANSI colours, bold/blink attributes are used to set high-intensity
361foreground/background colors.
362
363color0-7 are the low-intensity colors.
364
365color8-15 are the corresponding high-intensity colors.
366
367=head3 I don't like the screen colors. How do I change them?
368
369You can change the screen colors at run-time using F<~/.Xdefaults>
370resources (or as long-options).
371
372Here are values that are supposed to resemble a VGA screen,
373including the murky brown that passes for low-intensity yellow:
374
375 URxvt.color0: #000000
376 URxvt.color1: #A80000
377 URxvt.color2: #00A800
378 URxvt.color3: #A8A800
379 URxvt.color4: #0000A8
380 URxvt.color5: #A800A8
381 URxvt.color6: #00A8A8
382 URxvt.color7: #A8A8A8
383
384 URxvt.color8: #000054
385 URxvt.color9: #FF0054
386 URxvt.color10: #00FF54
387 URxvt.color11: #FFFF54
388 URxvt.color12: #0000FF
389 URxvt.color13: #FF00FF
390 URxvt.color14: #00FFFF
391 URxvt.color15: #FFFFFF
392
393And here is a more complete set of non-standard colors described (not by
394me) as "pretty girly".
395
396 URxvt.cursorColor: #dc74d1
397 URxvt.pointerColor: #dc74d1
398 URxvt.background: #0e0e0e
399 URxvt.foreground: #4ad5e1
400 URxvt.color0: #000000
401 URxvt.color8: #8b8f93
402 URxvt.color1: #dc74d1
403 URxvt.color9: #dc74d1
404 URxvt.color2: #0eb8c7
405 URxvt.color10: #0eb8c7
406 URxvt.color3: #dfe37e
407 URxvt.color11: #dfe37e
408 URxvt.color5: #9e88f0
409 URxvt.color13: #9e88f0
410 URxvt.color6: #73f7ff
411 URxvt.color14: #73f7ff
412 URxvt.color7: #e1dddd
413 URxvt.color15: #e1dddd
414
415=head3 Why do some characters look so much different than others?
416
417See next entry.
418
419=head3 How does rxvt-unicode choose fonts?
420
421Most fonts do not contain the full range of Unicode, which is
422fine. Chances are that the font you (or the admin/package maintainer of
423your system/os) have specified does not cover all the characters you want
424to display.
425
426B<rxvt-unicode> makes a best-effort try at finding a replacement
427font. Often the result is fine, but sometimes the chosen font looks
428bad/ugly/wrong. Some fonts have totally strange characters that don't
429resemble the correct glyph at all, and rxvt-unicode lacks the artificial
430intelligence to detect that a specific glyph is wrong: it has to believe
431the font that the characters it claims to contain indeed look correct.
432
433In that case, select a font of your taste and add it to the font list,
434e.g.:
435
436 @@URXVT_NAME@@ -fn basefont,font2,font3...
437
438When rxvt-unicode sees a character, it will first look at the base
439font. If the base font does not contain the character, it will go to the
440next font, and so on. Specifying your own fonts will also speed up this
441search and use less resources within rxvt-unicode and the X-server.
442
443The only limitation is that none of the fonts may be larger than the base
444font, as the base font defines the terminal character cell size, which
445must be the same due to the way terminals work.
446
447
448=head2 Keyboard, Mouse & User Interaction
449
450=head3 The new selection selects pieces that are too big, how can I select single words?
451
452If you want to select e.g. alphanumeric words, you can use the following
453setting:
454
455 URxvt.selection.pattern-0: ([[:word:]]+)
456
457If you click more than twice, the selection will be extended
458more and more.
459
460To get a selection that is very similar to the old code, try this pattern:
461
462 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
463
464Please also note that the I<LeftClick Shift-LeftClik> combination also
465selects words like the old code.
466
467=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
468
469You can disable the perl extension completely by setting the
470B<perl-ext-common> resource to the empty string, which also keeps
471rxvt-unicode from initialising perl, saving memory.
472
473If you only want to disable specific features, you first have to
474identify which perl extension is responsible. For this, read the section
475B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
476example, to disable the B<selection-popup> and B<option-popup>, specify
477this B<perl-ext-common> resource:
478
479 URxvt.perl-ext-common: default,-selection-popup,-option-popup
480
481This will keep the default extensions, but disable the two popup
482extensions. Some extensions can also be configured, for example,
483scrollback search mode is triggered by B<M-s>. You can move it to any
484other combination either by setting the B<searchable-scrollback> resource:
485
486 URxvt.searchable-scrollback: CM-s
487
488=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
489
490See next entry.
491
492=head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
493
494These are caused by the C<readline> perl extension. Under normal
495circumstances, it will move your cursor around when you click into the
496line that contains it. It tries hard not to do this at the wrong moment,
497but when running a program that doesn't parse cursor movements or in some
498cases during rlogin sessions, it fails to detect this properly.
499
500You can permamently switch this feature off by disabling the C<readline>
501extension:
502
503 URxvt.perl-ext-common: default,-readline
504
505=head3 My numerical keypad acts weird and generates differing output?
506
507Some Debian GNUL/Linux users seem to have this problem, although no
508specific details were reported so far. It is possible that this is caused
509by the wrong C<TERM> setting, although the details of wether and how
510this can happen are unknown, as C<TERM=rxvt> should offer a compatible
511keymap. See the answer to the previous question, and please report if that
512helped.
513
514=head3 My Compose (Multi_key) key is no longer working.
515
516The most common causes for this are that either your locale is not set
517correctly, or you specified a B<preeditStyle> that is not supported by
518your input method. For example, if you specified B<OverTheSpot> and
519your input method (e.g. the default input method handling Compose keys)
520does not support this (for instance because it is not visual), then
521rxvt-unicode will continue without an input method.
522
523In this case either do not specify a B<preeditStyle> or specify more than
524one pre-edit style, such as B<OverTheSpot,Root,None>.
525
526=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
527
528Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
529international keyboards) or simply use ISO 14755 support to your
530advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
531codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
532character and so on.
533
534=head3 Mouse cut/paste suddenly no longer works.
535
536Make sure that mouse reporting is actually turned off since killing
537some editors prematurely may leave the mouse in mouse report mode. I've
538heard that tcsh may use mouse reporting unless it otherwise specified. A
539quick check is to see if cut/paste works when the Alt or Shift keys are
540depressed.
541
542=head3 What's with the strange Backspace/Delete key behaviour?
543
544Assuming that the physical Backspace key corresponds to the
545BackSpace keysym (not likely for Linux ... see the following
546question) there are two standard values that can be used for
547Backspace: C<^H> and C<^?>.
548
549Historically, either value is correct, but rxvt-unicode adopts the debian
550policy of using C<^?> when unsure, because it's the one only only correct
551choice :).
552
553Rxvt-unicode tries to inherit the current stty settings and uses the value
554of `erase' to guess the value for backspace. If rxvt-unicode wasn't
555started from a terminal (say, from a menu or by remote shell), then the
556system value of `erase', which corresponds to CERASE in <termios.h>, will
557be used (which may not be the same as your stty setting).
558
559For starting a new rxvt-unicode:
560
561 # use Backspace = ^H
562 $ stty erase ^H
563 $ @@URXVT_NAME@@
564
565 # use Backspace = ^?
566 $ stty erase ^?
567 $ @@URXVT_NAME@@
568
569Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
570
571For an existing rxvt-unicode:
572
573 # use Backspace = ^H
574 $ stty erase ^H
575 $ echo -n "^[[36h"
576
577 # use Backspace = ^?
578 $ stty erase ^?
579 $ echo -n "^[[36l"
580
581This helps satisfy some of the Backspace discrepancies that occur, but
582if you use Backspace = C<^H>, make sure that the termcap/terminfo value
583properly reflects that.
584
585The Delete key is a another casualty of the ill-defined Backspace problem.
586To avoid confusion between the Backspace and Delete keys, the Delete
587key has been assigned an escape sequence to match the vt100 for Execute
588(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
589
590Some other Backspace problems:
591
592some editors use termcap/terminfo,
593some editors (vim I'm told) expect Backspace = ^H,
594GNU Emacs (and Emacs-like editors) use ^H for help.
595
596Perhaps someday this will all be resolved in a consistent manner.
597
598=head3 I don't like the key-bindings. How do I change them?
599
600There are some compile-time selections available via configure. Unless
601you have run "configure" with the C<--disable-resources> option you can
602use the `keysym' resource to alter the keystrings associated with keysyms.
603
604Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
605
606 URxvt.keysym.Home: \033[1~
607 URxvt.keysym.End: \033[4~
608 URxvt.keysym.C-apostrophe: \033<C-'>
609 URxvt.keysym.C-slash: \033<C-/>
610 URxvt.keysym.C-semicolon: \033<C-;>
611 URxvt.keysym.C-grave: \033<C-`>
612 URxvt.keysym.C-comma: \033<C-,>
613 URxvt.keysym.C-period: \033<C-.>
614 URxvt.keysym.C-0x60: \033<C-`>
615 URxvt.keysym.C-Tab: \033<C-Tab>
616 URxvt.keysym.C-Return: \033<C-Return>
617 URxvt.keysym.S-Return: \033<S-Return>
618 URxvt.keysym.S-space: \033<S-Space>
619 URxvt.keysym.M-Up: \033<M-Up>
620 URxvt.keysym.M-Down: \033<M-Down>
621 URxvt.keysym.M-Left: \033<M-Left>
622 URxvt.keysym.M-Right: \033<M-Right>
623 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
624 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
625 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
626
627See some more examples in the documentation for the B<keysym> resource.
628
629=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
630
631 KP_Insert == Insert
632 F22 == Print
633 F27 == Home
634 F29 == Prior
635 F33 == End
636 F35 == Next
637
638Rather than have rxvt-unicode try to accommodate all the various possible
639keyboard mappings, it is better to use `xmodmap' to remap the keys as
640required for your particular machine.
641
642
643
644=head2 Terminal Configuration
645
646=head3 Why doesn't rxvt-unicode read my resources?
647
648Well, why, indeed? It does, in a way very similar to other X
649applications. Most importantly, this means that if you or your OS loads
650resources into the X display (the right way to do it), rxvt-unicode will
651ignore any resource files in your home directory. It will only read
652F<$HOME/.Xdefaults> when no resources are attached to the display.
653
654If you have or use an F<$HOME/.Xresources> file, chances are that
655resources are loaded into your X-server. In this case, you have to
656re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
657
658Also consider the form resources have to use:
659
660 URxvt.resource: value
661
662If you want to use another form (there are lots of different ways of
663specifying resources), make sure you understand wether and why it
664works. If unsure, use the form above.
665
49=item When I log-in to another system it tells me about missing terminfo data? 666=head3 When I log-in to another system it tells me about missing terminfo data?
50 667
51The terminal description used by rxvt-unicode is not as widely available 668The 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). 669as that for xterm, or even rxvt (for which the same problem often arises).
53 670
54The correct solution for this problem is to install the terminfo, this can 671The correct solution for this problem is to install the terminfo, this can
70resource to set it: 687resource to set it:
71 688
72 URxvt.termName: rxvt 689 URxvt.termName: rxvt
73 690
74If you don't plan to use B<rxvt> (quite common...) you could also replace 691If you don't plan to use B<rxvt> (quite common...) you could also replace
75the rxvt terminfo file with the rxvt-unicode one. 692the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
76 693
694=head3 C<tic> outputs some error when compiling the terminfo entry.
695
696Most likely it's the empty definition for C<enacs=>. Just replace it by
697C<enacs=\E[0@> and try again.
698
77=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@. 699=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
78 700
701See next entry.
702
79=item I need a termcap file entry. 703=head3 I need a termcap file entry.
80 704
81One reason you might want this is that some distributions or operating 705One reason you might want this is that some distributions or operating
82systems still compile some programs using the long-obsoleted termcap 706systems still compile some programs using the long-obsoleted termcap
83library (Fedora Core's bash is one example) and rely on a termcap entry 707library (Fedora Core's bash is one example) and rely on a termcap entry
84for C<rxvt-unicode>. 708for C<rxvt-unicode>.
110 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\ 734 :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:\ 735 :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:\ 736 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
113 :vs=\E[?25h: 737 :vs=\E[?25h:
114 738
115=item Why does C<ls> no longer have coloured output? 739=head3 Why does C<ls> no longer have coloured output?
116 740
117The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 741The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
118decide wether a terminal has colour, but uses it's own configuration 742decide 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 743file. Needless to say, C<rxvt-unicode> is not in it's default file (among
120with most other terminals supporting colour). Either add: 744with most other terminals supporting colour). Either add:
125 749
126 alias ls='ls --color=auto' 750 alias ls='ls --color=auto'
127 751
128to your C<.profile> or C<.bashrc>. 752to your C<.profile> or C<.bashrc>.
129 753
130=item Why doesn't vim/emacs etc. use the 88 colour mode? 754=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
131 755
756See next entry.
757
132=item Why doesn't vim/emacs etc. make use of italic? 758=head3 Why doesn't vim/emacs etc. make use of italic?
133 759
760See next entry.
761
134=item Why are the secondary screen-related options not working properly? 762=head3 Why are the secondary screen-related options not working properly?
135 763
136Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged 764Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
137distributions (most notably Debian GNU/Linux) break rxvt-unicode 765distributions (most notably Debian GNU/Linux) break rxvt-unicode
138by setting C<TERM> to C<rxvt>, which doesn't have these extra 766by setting C<TERM> to C<rxvt>, which doesn't have these extra
139features. Unfortunately, some of these (most notably, again, Debian 767features. Unfortunately, some of these (most notably, again, Debian
140GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo 768GNU/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 769file, 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 770I log-in to another system it tells me about missing terminfo data?> on
143how to do this). 771how to do this).
144 772
145=item My numerical keypad acts weird and generates differing output?
146 773
147Some Debian GNUL/Linux users seem to have this problem, although no 774=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 775
154=item Rxvt-unicode does not seem to understand the selected encoding? 776=head3 Rxvt-unicode does not seem to understand the selected encoding?
155 777
778See next entry.
779
156=item Unicode does not seem to work? 780=head3 Unicode does not seem to work?
157 781
158If you encounter strange problems like typing an accented character but 782If you encounter strange problems like typing an accented character but
159getting two unrelated other characters or similar, or if program output is 783getting two unrelated other characters or similar, or if program output is
160subtly garbled, then you should check your locale settings. 784subtly garbled, then you should check your locale settings.
161 785
181 805
182If nothing works and you are sure that everything is set correctly then 806If 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 807you will need to remember a little known fact: Some programs just don't
184support locales :( 808support locales :(
185 809
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? 810=head3 How does rxvt-unicode determine the encoding to use?
334 811
812See next entry.
813
335=item Is there an option to switch encodings? 814=head3 Is there an option to switch encodings?
336 815
337Unlike some other terminals, rxvt-unicode has no encoding switch, and no 816Unlike 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 817specific "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. 818UTF-8 or any other encodings with respect to terminal I/O.
340 819
365rxvt-unicode. 844rxvt-unicode.
366 845
367If you want to use a specific encoding you have to make sure you start 846If you want to use a specific encoding you have to make sure you start
368rxvt-unicode with the correct C<LC_CTYPE> category. 847rxvt-unicode with the correct C<LC_CTYPE> category.
369 848
370=item Can I switch locales at runtime? 849=head3 Can I switch locales at runtime?
371 850
372Yes, using an escape sequence. Try something like this, which sets 851Yes, using an escape sequence. Try something like this, which sets
373rxvt-unicode's idea of C<LC_CTYPE>. 852rxvt-unicode's idea of C<LC_CTYPE>.
374 853
375 printf '\e]701;%s\007' ja_JP.SJIS 854 printf '\e]701;%s\007' ja_JP.SJIS
387 866
388You can also use xterm's C<luit> program, which usually works fine, except 867You can also use xterm's C<luit> program, which usually works fine, except
389for some locales where character width differs between program- and 868for some locales where character width differs between program- and
390rxvt-unicode-locales. 869rxvt-unicode-locales.
391 870
392=item Can I switch the fonts at runtime?
393
394Yes, using an escape sequence. Try something like this, which has the same
395effect as using the C<-fn> switch, and takes effect immediately:
396
397 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
398
399This is useful if you e.g. work primarily with japanese (and prefer a
400japanese font), but you have to switch to chinese temporarily, where
401japanese fonts would only be in your way.
402
403You can think of this as a kind of manual ISO-2022 switching.
404
405=item Why do italic characters look as if clipped?
406
407Many fonts have difficulties with italic characters and hinting. For
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
412 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
413 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
414
415=item My input method wants <some encoding> but I want UTF-8, what can I do? 871=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
416 872
417You can specify separate locales for the input method and the rest of the 873You can specify separate locales for the input method and the rest of the
418terminal, using the resource C<imlocale>: 874terminal, using the resource C<imlocale>:
419 875
420 URxvt*imlocale: ja_JP.EUC-JP 876 URxvt.imlocale: ja_JP.EUC-JP
421 877
422Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 878Now 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 879use your input method. Please note, however, that you will not be able to
424input characters outside C<EUC-JP> in a normal way then, as your input 880input characters outside C<EUC-JP> in a normal way then, as your input
425method limits you. 881method limits you.
426 882
427=item Rxvt-unicode crashes when the X Input Method changes or exits. 883=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
428 884
429Unfortunately, this is unavoidable, as the XIM protocol is racy by 885Unfortunately, this is unavoidable, as the XIM protocol is racy by
430design. Applications can avoid some crashes at the expense of memory 886design. Applications can avoid some crashes at the expense of memory
431leaks, and Input Methods can avoid some crashes by careful ordering at 887leaks, and Input Methods can avoid some crashes by careful ordering at
432exit time. B<kinput2> (and derived input methods) generally succeeds, 888exit time. B<kinput2> (and derived input methods) generally succeeds,
433while B<SCIM> (or similar input methods) fails. In the end, however, 889while B<SCIM> (or similar input methods) fails. In the end, however,
434crashes cannot be completely avoided even if both sides cooperate. 890crashes cannot be completely avoided even if both sides cooperate.
435 891
436So the only workaround is not to kill your Input Method Servers. 892So the only workaround is not to kill your Input Method Servers.
437 893
438=item Rxvt-unicode uses gobs of memory, how can I reduce that?
439 894
440Rxvt-unicode tries to obey the rule of not charging you for something you 895=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 896
446Also, many people (me included) like large windows and even larger 897=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 898
453=item Can I speed up Xft rendering somehow? 899The Debian GNU/Linux package of rxvt-unicode in sarge contains large
900patches that considerably change the behaviour of rxvt-unicode (but
901unfortunately this notice has been removed). Before reporting a bug to
902the original rxvt-unicode author please download and install the genuine
903version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
904the problem. If you cannot, chances are that the problems are specific to
905Debian GNU/Linux, in which case it should be reported via the Debian Bug
906Tracking System (use C<reportbug> to report the bug).
454 907
455Yes, the most obvious way to speed it up is to avoid Xft entirely, as 908For 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 909probably should use the Debian BTS, too, because, after all, it's also a
457antialiasing (by appending C<:antialiasing=false>), which saves lots of 910bug in the Debian version and it serves as a reminder for other users that
458memory and also speeds up rendering considerably. 911might encounter the same issue.
459 912
460=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 913=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
461 914
462Rxvt-unicode will use whatever you specify as a font. If it needs to 915You should build one binary with the default options. F<configure>
463fall back to it's default font search list it will prefer X11 core 916now 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 917runtime-switchable, too, so there is usually no drawback to enbaling them,
465antialiasing disabled for most of them, because the author thinks they 918except higher disk and possibly memory usage. The perl interpreter should
466look best that way. 919be enabled, as important functionality (menus, selection, likely more in
920the future) depends on it.
467 921
468If you want antialiasing, you have to specify the fonts manually. 922You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
923system-wide (except maybe with C<defaults>). This will result in useful
924behaviour. If your distribution aims at low memory, add an empty
925C<perl-ext-common> resource to the app-defaults file. This will keep the
926perl interpreter disabled until the user enables it.
469 927
470=item Mouse cut/paste suddenly no longer works. 928If you can/want build more binaries, I recommend building a minimal
929one with C<--disable-everything> (very useful) and a maximal one with
930C<--enable-everything> (less useful, it will be very big due to a lot of
931encodings built-in that increase download times and are rarely used).
471 932
472Make sure that mouse reporting is actually turned off since killing 933=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 934
478=item What's with this bold/blink stuff? 935It should be, starting with release 7.1. You are encouraged to properly
936install urxvt with privileges necessary for your OS now.
479 937
480If no bold colour is set via C<colorBD:>, bold will invert text using the 938When rxvt-unicode detects that it runs setuid or setgid, it will fork
481standard foreground colour. 939into a helper process for privileged operations (pty handling on some
940systems, utmp/wtmp/lastlog handling on others) and drop privileges
941immediately. This is much safer than most other terminals that keep
942privileges while running (but is more relevant to urxvt, as it contains
943things as perl interpreters, which might be "helpful" to attackers).
482 944
483For the standard background colour, blinking will actually make the 945This forking is done as the very first within main(), which is very early
484text blink when compiled with C<--enable-blinking>. with standard 946and reduces possible bugs to initialisation code run before main(), or
485colours. Without C<--enable-blinking>, the blink attribute will be 947things like the dynamic loader of your system, which should result in very
486ignored. 948little risk.
487 949
488On ANSI colours, bold/blink attributes are used to set high-intensity 950=head3 On Solaris 9, many line-drawing characters are too wide.
489foreground/background colors.
490 951
491color0-7 are the low-intensity colors. 952Seems to be a known bug, read
953L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
954following ugly workaround to get non-double-wide-characters working:
492 955
493color8-15 are the corresponding high-intensity colors. 956 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
494 957
495=item I don't like the screen colors. How do I change them? 958=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
496 959
497You can change the screen colors at run-time using F<~/.Xdefaults> 960Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
498resources (or as long-options). 961in your compile environment, or an implementation that implements it,
962wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
963B<wchar_t> is represented as unicode.
499 964
500Here are values that are supposed to resemble a VGA screen, 965As you might have guessed, FreeBSD does neither define this symobl nor
501including the murky brown that passes for low-intensity yellow: 966does it support it. Instead, it uses it's own internal representation of
967B<wchar_t>. This is, of course, completely fine with respect to standards.
502 968
503 URxvt.color0: #000000 969However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
504 URxvt.color1: #A80000 970C<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 971
512 URxvt.color8: #000054 972C<__STDC_ISO_10646__> is the only sane way to support multi-language
513 URxvt.color9: #FF0054 973apps in an OS, as using a locale-dependent (and non-standardized)
514 URxvt.color10: #00FF54 974representation of B<wchar_t> makes it impossible to convert between
515 URxvt.color11: #FFFF54 975B<wchar_t> (as used by X11 and your applications) and any other encoding
516 URxvt.color12: #0000FF 976without implementing OS-specific-wrappers for each and every locale. There
517 URxvt.color13: #FF00FF 977simply are no APIs to convert B<wchar_t> into anything except the current
518 URxvt.color14: #00FFFF 978locale encoding.
519 URxvt.color15: #FFFFFF
520 979
521And here is a more complete set of non-standard colors described (not by 980Some applications (such as the formidable B<mlterm>) work around this
522me) as "pretty girly". 981by carrying their own replacement functions for character set handling
982with them, and either implementing OS-dependent hacks or doing multiple
983conversions (which is slow and unreliable in case the OS implements
984encodings slightly different than the terminal emulator).
523 985
524 URxvt.cursorColor: #dc74d1 986The rxvt-unicode author insists that the right way to fix this is in the
525 URxvt.pointerColor: #dc74d1 987system libraries once and for all, instead of forcing every app to carry
526 URxvt.background: #0e0e0e 988complete 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 989
543=item How can I start @@RXVT_NAME@@d in a race-free way? 990=head3 I use Solaris 9 and it doesn't compile/work/etc.
544 991
545Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a 992Try 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 993problems with C<wcwidth> and a compile problem.
547itself.
548 994
549To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the 995=head3 How can I use rxvt-unicode under cygwin?
550following method to wait for the startup message before continuing:
551 996
552 { @@RXVT_NAME@@d & } | read 997rxvt-unicode should compile and run out of the box on cygwin, using
998the X11 libraries that come with cygwin. libW11 emulation is no
999longer supported (and makes no sense, either, as it only supported a
1000single font). I recommend starting the X-server in C<-multiwindow> or
1001C<-rootless> mode instead, which will result in similar look&feel as the
1002old libW11 emulation.
553 1003
554=item What's with the strange Backspace/Delete key behaviour? 1004At the time of this writing, cygwin didn't seem to support any multi-byte
1005encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1006to 8-bit encodings.
555 1007
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 1008=head1 RXVT-UNICODE TECHNICAL REFERENCE
704 1009
705=head1 DESCRIPTION 1010=head1 DESCRIPTION
706 1011
707The rest of this document describes various technical aspects of 1012The rest of this document describes various technical aspects of
708B<rxvt-unicode>. First the description of supported command sequences, 1013B<rxvt-unicode>. First the description of supported command sequences,
709followed by menu and pixmap support and last by a description of all 1014followed by pixmap support and last by a description of all features
710features selectable at C<configure> time. 1015selectable at C<configure> time.
711 1016
712=head1 Definitions 1017=head1 Definitions
713 1018
714=over 4 1019=over 4
715 1020
1283 B<< C<h> >> Send Mouse X & Y on button press. 1588 B<< C<h> >> Send Mouse X & Y on button press.
1284 B<< C<l> >> No mouse reporting. 1589 B<< C<l> >> No mouse reporting.
1285 1590
1286=end table 1591=end table
1287 1592
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> >> 1593=item B<< C<Ps = 25> >>
1298 1594
1299=begin table 1595=begin table
1300 1596
1301 B<< C<h> >> Visible cursor {cnorm/cvvis} 1597 B<< C<h> >> Visible cursor {cnorm/cvvis}
1414 1710
1415=begin table 1711=begin table
1416 1712
1417 B<< C<h> >> Scroll to bottom when a key is pressed 1713 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 1714 B<< C<l> >> Don't scroll to bottom when a key is pressed
1715
1716=end table
1717
1718=item B<< C<Ps = 1021> >> (B<rxvt>)
1719
1720=begin table
1721
1722 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1723 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1419 1724
1420=end table 1725=end table
1421 1726
1422=item B<< C<Ps = 1047> >> 1727=item B<< C<Ps = 1047> >>
1423 1728
1472 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1777 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)> 1778 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> >> 1779 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> >> 1780 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> >> 1781 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> >> 1782 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> >> 1783 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1479 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1784 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
1480 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 1785 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1481 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1786 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> >>. 1787 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> >> 1788 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> >> 1789 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1485 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills). 1790 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
1486 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar). 1791 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> >> 1792 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1488 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). 1793 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1794 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1795 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>. 1796 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1490 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1797 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1491 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1798 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1492 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1799 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1493 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 1800 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1494 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 1801 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1802 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1495 1803
1496=end table 1804=end table
1497 1805
1498=back 1806=back
1499 1807
1500X<menuBar>
1501
1502=head1 menuBar
1503
1504B<< The exact syntax used is I<almost> solidified. >>
1505In the menus, B<DON'T> try to use menuBar commands that add or remove a
1506menuBar.
1507
1508Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1509omitted: use B<./> to specify a menu relative to the current menu.
1510
1511=head2 Overview of menuBar operation
1512
1513For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1514of C<Pt> can be used for a variety of tasks:
1515
1516At the top level is the current menuBar which is a member of a circular
1517linked-list of other such menuBars.
1518
1519The menuBar acts as a parent for the various drop-down menus, which in
1520turn, may have labels, separator lines, menuItems and subMenus.
1521
1522The menuItems are the useful bits: you can use them to mimic keyboard
1523input or even to send text or escape sequences back to rxvt.
1524
1525The menuBar syntax is intended to provide a simple yet robust method of
1526constructing and manipulating menus and navigating through the
1527menuBars.
1528
1529The first step is to use the tag B<< [menu:I<name>] >> which creates
1530the menuBar called I<name> and allows access. You may now or menus,
1531subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1532menuBar access as B<readonly> to prevent accidental corruption of the
1533menus. To re-access the current menuBar for alterations, use the tag
1534B<[menu]>, make the alterations and then use B<[done]>
1535
1536X<menuBarCommands>
1537
1538=head2 Commands
1539
1540=over 4
1541
1542=item B<< [menu:+I<name>] >>
1543
1544access the named menuBar for creation or alteration. If a new menuBar
1545is created, it is called I<name> (max of 15 chars) and the current
1546menuBar is pushed onto the stack
1547
1548=item B<[menu]>
1549
1550access the current menuBar for alteration
1551
1552=item B<< [title:+I<string>] >>
1553
1554set the current menuBar's title to I<string>, which may contain the
1555following format specifiers:
1556
1557 B<%n> rxvt name (as per the B<-name> command-line option)
1558 B<%v> rxvt version
1559 B<%%> literal B<%> character
1560
1561=item B<[done]>
1562
1563set menuBar access as B<readonly>.
1564End-of-file tag for B<< [read:+I<file>] >> operations.
1565
1566=item B<< [read:+I<file>] >>
1567
1568read menu commands directly from I<file> (extension ".menu" will be
1569appended if required.) Start reading at a line with B<[menu]> or B<<
1570[menu:+I<name> >> and continuing until B<[done]> is encountered.
1571
1572Blank and comment lines (starting with B<#>) are ignored. Actually,
1573since any invalid menu commands are also ignored, almost anything could
1574be construed as a comment line, but this may be tightened up in the
1575future ... so don't count on it!.
1576
1577=item B<< [read:+I<file>;+I<name>] >>
1578
1579The same as B<< [read:+I<file>] >>, but start reading at a line with
1580B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1581B<[done]> is encountered.
1582
1583=item B<[dump]>
1584
1585dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1586later rereading.
1587
1588=item B<[rm:name]>
1589
1590remove the named menuBar
1591
1592=item B<[rm] [rm:]>
1593
1594remove the current menuBar
1595
1596=item B<[rm*] [rm:*]>
1597
1598remove all menuBars
1599
1600=item B<[swap]>
1601
1602swap the top two menuBars
1603
1604=item B<[prev]>
1605
1606access the previous menuBar
1607
1608=item B<[next]>
1609
1610access the next menuBar
1611
1612=item B<[show]>
1613
1614Enable display of the menuBar
1615
1616=item B<[hide]>
1617
1618Disable display of the menuBar
1619
1620=item B<< [pixmap:+I<name>] >>
1621
1622=item B<< [pixmap:+I<name>;I<scaling>] >>
1623
1624(set the background pixmap globally
1625
1626B<< A Future implementation I<may> make this local to the menubar >>)
1627
1628=item B<< [:+I<command>:] >>
1629
1630ignore the menu readonly status and issue a I<command> to or a menu or
1631menuitem or change the ; a useful shortcut for setting the quick arrows
1632from a menuBar.
1633
1634=back
1635
1636X<menuBarAdd>
1637
1638=head2 Adding and accessing menus
1639
1640The following commands may also be B<+> prefixed.
1641
1642=over 4
1643
1644=item B</+>
1645
1646access menuBar top level
1647
1648=item B<./+>
1649
1650access current menu level
1651
1652=item B<../+>
1653
1654access parent menu (1 level up)
1655
1656=item B<../../>
1657
1658access parent menu (multiple levels up)
1659
1660=item B<< I</path/>menu >>
1661
1662add/access menu
1663
1664=item B<< I</path/>menu/* >>
1665
1666add/access menu and clear it if it exists
1667
1668=item B<< I</path/>{-} >>
1669
1670add separator
1671
1672=item B<< I</path/>{item} >>
1673
1674add B<item> as a label
1675
1676=item B<< I</path/>{item} action >>
1677
1678add/alter I<menuitem> with an associated I<action>
1679
1680=item B<< I</path/>{item}{right-text} >>
1681
1682add/alter I<menuitem> with B<right-text> as the right-justified text
1683and as the associated I<action>
1684
1685=item B<< I</path/>{item}{rtext} action >>
1686
1687add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1688the right-justified text.
1689
1690=back
1691
1692=over 4
1693
1694=item Special characters in I<action> must be backslash-escaped:
1695
1696B<\a \b \E \e \n \r \t \octal>
1697
1698=item or in control-character notation:
1699
1700B<^@, ^A .. ^Z .. ^_, ^?>
1701
1702=back
1703
1704To send a string starting with a B<NUL> (B<^@>) character to the
1705program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1706the first of which will be stripped off and the balance directed to the
1707program. Otherwise if I<action> begins with B<NUL> followed by
1708non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1709balance is sent back to rxvt.
1710
1711As a convenience for the many Emacs-type editors, I<action> may start
1712with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1713appended if missed from B<M-x> commands.
1714
1715As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1716quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1717
1718=over 4
1719
1720=item For example,
1721
1722B<M-xapropos> is equivalent to B<\Exapropos\r>
1723
1724=item and
1725
1726B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1727
1728=back
1729
1730The option B<< {I<right-rtext>} >> will be right-justified. In the
1731absence of a specified action, this text will be used as the I<action>
1732as well.
1733
1734=over 4
1735
1736=item For example,
1737
1738B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1739
1740=back
1741
1742The left label I<is> necessary, since it's used for matching, but
1743implicitly hiding the left label (by using same name for both left and
1744right labels), or explicitly hiding the left label (by preceeding it
1745with a dot), makes it possible to have right-justified text only.
1746
1747=over 4
1748
1749=item For example,
1750
1751B</File/{Open}{Open} Open-File-Action>
1752
1753=item or hiding it
1754
1755B</File/{.anylabel}{Open} Open-File-Action>
1756
1757=back
1758
1759X<menuBarRemove>
1760
1761=head2 Removing menus
1762
1763=over 4
1764
1765=item B<< -/*+ >>
1766
1767remove all menus from the menuBar, the same as B<[clear]>
1768
1769=item B<< -+I</path>menu+ >>
1770
1771remove menu
1772
1773=item B<< -+I</path>{item}+ >>
1774
1775remove item
1776
1777=item B<< -+I</path>{-} >>
1778
1779remove separator)
1780
1781=item B<-/path/menu/*>
1782
1783remove all items, separators and submenus from menu
1784
1785=back
1786
1787X<menuBarArrows>
1788
1789=head2 Quick Arrows
1790
1791The menus also provide a hook for I<quick arrows> to provide easier
1792user access. If nothing has been explicitly set, the default is to
1793emulate the curror keys. The syntax permits each arrow to be altered
1794individually or all four at once without re-entering their common
1795beginning/end text. For example, to explicitly associate cursor actions
1796with the arrows, any of the following forms could be used:
1797
1798=over 4
1799
1800=item B<< <r>+I<Right> >>
1801
1802=item B<< <l>+I<Left> >>
1803
1804=item B<< <u>+I<Up> >>
1805
1806=item B<< <d>+I<Down> >>
1807
1808Define actions for the respective arrow buttons
1809
1810=item B<< <b>+I<Begin> >>
1811
1812=item B<< <e>+I<End> >>
1813
1814Define common beginning/end parts for I<quick arrows> which used in
1815conjunction with the above <r> <l> <u> <d> constructs
1816
1817=back
1818
1819=over 4
1820
1821=item For example, define arrows individually,
1822
1823 <u>\E[A
1824
1825 <d>\E[B
1826
1827 <r>\E[C
1828
1829 <l>\E[D
1830
1831=item or all at once
1832
1833 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1834
1835=item or more compactly (factoring out common parts)
1836
1837 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1838
1839=back
1840
1841X<menuBarSummary>
1842
1843=head2 Command Summary
1844
1845A short summary of the most I<common> commands:
1846
1847=over 4
1848
1849=item [menu:name]
1850
1851use an existing named menuBar or start a new one
1852
1853=item [menu]
1854
1855use the current menuBar
1856
1857=item [title:string]
1858
1859set menuBar title
1860
1861=item [done]
1862
1863set menu access to readonly and, if reading from a file, signal EOF
1864
1865=item [done:name]
1866
1867if reading from a file using [read:file;name] signal EOF
1868
1869=item [rm:name]
1870
1871remove named menuBar(s)
1872
1873=item [rm] [rm:]
1874
1875remove current menuBar
1876
1877=item [rm*] [rm:*]
1878
1879remove all menuBar(s)
1880
1881=item [swap]
1882
1883swap top two menuBars
1884
1885=item [prev]
1886
1887access the previous menuBar
1888
1889=item [next]
1890
1891access the next menuBar
1892
1893=item [show]
1894
1895map menuBar
1896
1897=item [hide]
1898
1899unmap menuBar
1900
1901=item [pixmap;file]
1902
1903=item [pixmap;file;scaling]
1904
1905set a background pixmap
1906
1907=item [read:file]
1908
1909=item [read:file;name]
1910
1911read in a menu from a file
1912
1913=item [dump]
1914
1915dump out all menuBars to /tmp/rxvt-PID
1916
1917=item /
1918
1919access menuBar top level
1920
1921=item ./
1922
1923=item ../
1924
1925=item ../../
1926
1927access current or parent menu level
1928
1929=item /path/menu
1930
1931add/access menu
1932
1933=item /path/{-}
1934
1935add separator
1936
1937=item /path/{item}{rtext} action
1938
1939add/alter menu item
1940
1941=item -/*
1942
1943remove all menus from the menuBar
1944
1945=item -/path/menu
1946
1947remove menu items, separators and submenus from menu
1948
1949=item -/path/menu
1950
1951remove menu
1952
1953=item -/path/{item}
1954
1955remove item
1956
1957=item -/path/{-}
1958
1959remove separator
1960
1961=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1962
1963menu quick arrows
1964
1965=back
1966X<XPM> 1808X<XPM>
1967 1809
1968=head1 XPM 1810=head1 XPM
1969 1811
1970For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 1812For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
2069=begin table 1911=begin table
2070 1912
2071 4 Shift 1913 4 Shift
2072 8 Meta 1914 8 Meta
2073 16 Control 1915 16 Control
2074 32 Double Click I<(Rxvt extension)> 1916 32 Double Click I<(rxvt extension)>
2075 1917
2076=end table 1918=end table
2077 1919
2078Col = B<< C<< <x> - SPACE >> >> 1920Col = B<< C<< <x> - SPACE >> >>
2079 1921
2156=end table 1998=end table
2157 1999
2158=head1 CONFIGURE OPTIONS 2000=head1 CONFIGURE OPTIONS
2159 2001
2160General hint: if you get compile errors, then likely your configuration 2002General hint: if you get compile errors, then likely your configuration
2161hasn't been tested well. Either try with --enable-everything or use the 2003hasn't been tested well. Either try with C<--enable-everything> or use
2162./reconf script as a base for experiments. ./reconf is used by myself, 2004the F<./reconf> script as a base for experiments. F<./reconf> is used by
2163so it should generally be a working config. Of course, you should always 2005myself, so it should generally be a working config. Of course, you should
2164report when a combination doesn't work, so it can be fixed. Marc Lehmann 2006always report when a combination doesn't work, so it can be fixed. Marc
2165<rxvt@schmorp.de>. 2007Lehmann <rxvt@schmorp.de>.
2008
2009All
2166 2010
2167=over 4 2011=over 4
2168 2012
2169=item --enable-everything 2013=item --enable-everything
2170 2014
2171Add support for all non-multichoice options listed in "./configure 2015Add (or remove) support for all non-multichoice options listed in "./configure
2172--help". Note that unlike other enable options this is order dependant. 2016--help".
2017
2173You can specify this and then disable options which this enables by 2018You can specify this and then disable options you do not like by
2174I<following> this with the appropriate commands. 2019I<following> this with the appropriate C<--disable-...> arguments,
2020or you can start with a minimal configuration by specifying
2021C<--disable-everything> and than adding just the C<--enable-...> arguments
2022you want.
2175 2023
2176=item --enable-xft 2024=item --enable-xft (default: enabled)
2177 2025
2178Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2026Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2179slower and require lots of memory, but as long as you don't use them, you 2027slower and require lots of memory, but as long as you don't use them, you
2180don't pay for them. 2028don't pay for them.
2181 2029
2182=item --enable-font-styles 2030=item --enable-font-styles (default: on)
2183 2031
2184Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2032Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2185styles. The fonts can be set manually or automatically. 2033styles. The fonts can be set manually or automatically.
2186 2034
2187=item --with-codesets=NAME,... 2035=item --with-codesets=NAME,... (default: all)
2188 2036
2189Compile in support for additional codeset (encoding) groups (eu, vn are 2037Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2190always compiled in, which includes most 8-bit character sets). These 2038are always compiled in, which includes most 8-bit character sets). These
2191codeset tables are currently only used for driving X11 core fonts, they 2039codeset tables are used for driving X11 core fonts, they are not required
2192are not required for Xft fonts. Compiling them in will make your binary 2040for Xft fonts, although having them compiled in lets rxvt-unicode choose
2193bigger (together about 700kB), but it doesn't increase memory usage unless 2041replacement fonts more intelligently. Compiling them in will make your
2042binary bigger (all of together cost about 700kB), but it doesn't increase
2194you use an X11 font requiring one of these encodings. 2043memory usage unless you use a font requiring one of these encodings.
2195 2044
2196=begin table 2045=begin table
2197 2046
2198 all all available codeset groups 2047 all all available codeset groups
2199 zh common chinese encodings 2048 zh common chinese encodings
2202 jp_ext rarely used but big japanese encodings 2051 jp_ext rarely used but big japanese encodings
2203 kr korean encodings 2052 kr korean encodings
2204 2053
2205=end table 2054=end table
2206 2055
2207=item --enable-xim 2056=item --enable-xim (default: on)
2208 2057
2209Add support for XIM (X Input Method) protocol. This allows using 2058Add support for XIM (X Input Method) protocol. This allows using
2210alternative input methods (e.g. kinput2) and will also correctly 2059alternative input methods (e.g. kinput2) and will also correctly
2211set up the input for people using dead keys or compose keys. 2060set up the input for people using dead keys or compose keys.
2212 2061
2213=item --enable-unicode3 2062=item --enable-unicode3 (default: off)
2063
2064Recommended to stay off unless you really need non-BMP characters.
2214 2065
2215Enable direct support for displaying unicode codepoints above 2066Enable direct support for displaying unicode codepoints above
221665535 (the basic multilingual page). This increases storage 206765535 (the basic multilingual page). This increases storage
2217requirements per character from 2 to 4 bytes. X11 fonts do not yet 2068requirements per character from 2 to 4 bytes. X11 fonts do not yet
2218support these extra characters, but Xft does. 2069support these extra characters, but Xft does.
2221even without this flag, but the number of such characters is 2072even without this flag, but the number of such characters is
2222limited to a view thousand (shared with combining characters, 2073limited to a view thousand (shared with combining characters,
2223see next switch), and right now rxvt-unicode cannot display them 2074see next switch), and right now rxvt-unicode cannot display them
2224(input/output and cut&paste still work, though). 2075(input/output and cut&paste still work, though).
2225 2076
2226=item --enable-combining 2077=item --enable-combining (default: on)
2227 2078
2228Enable automatic composition of combining characters into 2079Enable automatic composition of combining characters into
2229composite characters. This is required for proper viewing of text 2080composite characters. This is required for proper viewing of text
2230where accents are encoded as seperate unicode characters. This is 2081where accents are encoded as seperate unicode characters. This is
2231done by using precomposited characters when available or creating 2082done by using precomposited characters when available or creating
2232new pseudo-characters when no precomposed form exists. 2083new pseudo-characters when no precomposed form exists.
2233 2084
2234Without --enable-unicode3, the number of additional precomposed characters 2085Without --enable-unicode3, the number of additional precomposed
2235is rather limited (2048, if this is full, rxvt-unicode will use the 2086characters is somewhat limited (the 6400 private use characters will be
2236private use area, extending the number of combinations to 8448). With
2237--enable-unicode3, no practical limit exists. 2087(ab-)used). With --enable-unicode3, no practical limit exists.
2238 2088
2239This option will also enable storage (but not display) of characters 2089This option will also enable storage (but not display) of characters
2240beyond plane 0 (>65535) when --enable-unicode3 was not specified. 2090beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2241 2091
2242The combining table also contains entries for arabic presentation forms, 2092The combining table also contains entries for arabic presentation forms,
2243but these are not currently used. Bug me if you want these to be used (and 2093but these are not currently used. Bug me if you want these to be used (and
2244tell me how these are to be used...). 2094tell me how these are to be used...).
2245 2095
2246=item --enable-fallback(=CLASS) 2096=item --enable-fallback(=CLASS) (default: Rxvt)
2247 2097
2248When reading resource settings, also read settings for class CLASS 2098When reading resource settings, also read settings for class CLASS. To
2249(default: Rxvt). To disable resource fallback use --disable-fallback. 2099disable resource fallback use --disable-fallback.
2250 2100
2251=item --with-res-name=NAME 2101=item --with-res-name=NAME (default: urxvt)
2252 2102
2253Use the given name (default: urxvt) as default application name when 2103Use the given name as default application name when
2254reading resources. Specify --with-res-name=rxvt to replace rxvt. 2104reading resources. Specify --with-res-name=rxvt to replace rxvt.
2255 2105
2256=item --with-res-class=CLASS 2106=item --with-res-class=CLASS /default: URxvt)
2257 2107
2258Use the given class (default: URxvt) as default application class 2108Use the given class as default application class
2259when reading resources. Specify --with-res-class=Rxvt to replace 2109when reading resources. Specify --with-res-class=Rxvt to replace
2260rxvt. 2110rxvt.
2261 2111
2262=item --enable-utmp 2112=item --enable-utmp (default: on)
2263 2113
2264Write user and tty to utmp file (used by programs like F<w>) at 2114Write user and tty to utmp file (used by programs like F<w>) at
2265start of rxvt execution and delete information when rxvt exits. 2115start of rxvt execution and delete information when rxvt exits.
2266 2116
2267=item --enable-wtmp 2117=item --enable-wtmp (default: on)
2268 2118
2269Write user and tty to wtmp file (used by programs like F<last>) at 2119Write user and tty to wtmp file (used by programs like F<last>) at
2270start of rxvt execution and write logout when rxvt exits. This 2120start of rxvt execution and write logout when rxvt exits. This
2271option requires --enable-utmp to also be specified. 2121option requires --enable-utmp to also be specified.
2272 2122
2273=item --enable-lastlog 2123=item --enable-lastlog (default: on)
2274 2124
2275Write user and tty to lastlog file (used by programs like 2125Write user and tty to lastlog file (used by programs like
2276F<lastlogin>) at start of rxvt execution. This option requires 2126F<lastlogin>) at start of rxvt execution. This option requires
2277--enable-utmp to also be specified. 2127--enable-utmp to also be specified.
2278 2128
2279=item --enable-xpm-background 2129=item --enable-xpm-background (default: on)
2280 2130
2281Add support for XPM background pixmaps. 2131Add support for XPM background pixmaps.
2282 2132
2283=item --enable-transparency 2133=item --enable-transparency (default: on)
2284 2134
2285Add support for inheriting parent backgrounds thus giving a fake 2135Add support for inheriting parent backgrounds thus giving a fake
2286transparency to the term. 2136transparency to the term.
2287 2137
2288=item --enable-fading 2138=item --enable-fading (default: on)
2289 2139
2290Add support for fading the text when focus is lost. 2140Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2291 2141
2292=item --enable-tinting 2142=item --enable-tinting (default: on)
2293 2143
2294Add support for tinting of transparent backgrounds. 2144Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2295 2145
2296=item --enable-menubar
2297
2298Add support for our menu bar system (this interacts badly with
2299dynamic locale switching currently).
2300
2301=item --enable-rxvt-scroll 2146=item --enable-rxvt-scroll (default: on)
2302 2147
2303Add support for the original rxvt scrollbar. 2148Add support for the original rxvt scrollbar.
2304 2149
2305=item --enable-next-scroll 2150=item --enable-next-scroll (default: on)
2306 2151
2307Add support for a NeXT-like scrollbar. 2152Add support for a NeXT-like scrollbar.
2308 2153
2309=item --enable-xterm-scroll 2154=item --enable-xterm-scroll (default: on)
2310 2155
2311Add support for an Xterm-like scrollbar. 2156Add support for an Xterm-like scrollbar.
2312 2157
2313=item --enable-plain-scroll 2158=item --enable-plain-scroll (default: on)
2314 2159
2315Add support for a very unobtrusive, plain-looking scrollbar that 2160Add support for a very unobtrusive, plain-looking scrollbar that
2316is the favourite of the rxvt-unicode author, having used it for 2161is the favourite of the rxvt-unicode author, having used it for
2317many years. 2162many years.
2318 2163
2319=item --enable-half-shadow 2164=item --enable-ttygid (default: off)
2320
2321Make shadows on the scrollbar only half the normal width & height.
2322only applicable to rxvt scrollbars.
2323
2324=item --enable-ttygid
2325 2165
2326Change tty device setting to group "tty" - only use this if 2166Change tty device setting to group "tty" - only use this if
2327your system uses this type of security. 2167your system uses this type of security.
2328 2168
2329=item --disable-backspace-key 2169=item --disable-backspace-key
2330 2170
2331Disable any handling of the backspace key by us - let the X server 2171Removes any handling of the backspace key by us - let the X server do it.
2172
2173=item --disable-delete-key
2174
2175Removes any handling of the delete key by us - let the X server
2332do it. 2176do it.
2333 2177
2334=item --disable-delete-key
2335
2336Disable any handling of the delete key by us - let the X server
2337do it.
2338
2339=item --disable-resources 2178=item --disable-resources
2340 2179
2341Remove all resources checking. 2180Removes any support for resource checking.
2342
2343=item --enable-xgetdefault
2344
2345Make resources checking via XGetDefault() instead of our small
2346version which only checks ~/.Xdefaults, or if that doesn't exist then
2347~/.Xresources.
2348
2349Please note that nowadays, things like XIM will automatically pull in and
2350use the full X resource manager, so the overhead of using it might be very
2351small, if nonexistant.
2352
2353=item --enable-strings
2354
2355Add support for our possibly faster memset() function and other
2356various routines, overriding your system's versions which may
2357have been hand-crafted in assembly or may require extra libraries
2358to link in. (this breaks ANSI-C rules and has problems on many
2359GNU/Linux systems).
2360 2181
2361=item --disable-swapscreen 2182=item --disable-swapscreen
2362 2183
2363Remove support for swap screen. 2184Remove support for secondary/swap screen.
2364 2185
2365=item --enable-frills 2186=item --enable-frills (default: on)
2366 2187
2367Add support for many small features that are not essential but nice to 2188Add support for many small features that are not essential but nice to
2368have. Normally you want this, but for very small binaries you may want to 2189have. Normally you want this, but for very small binaries you may want to
2369disable this. 2190disable this.
2370 2191
2371A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2192A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2372in combination with other switches) is: 2193in combination with other switches) is:
2373 2194
2374 MWM-hints 2195 MWM-hints
2375 EWMH-hints (pid, utf8 names) and protocols (ping) 2196 EWMH-hints (pid, utf8 names) and protocols (ping)
2376 seperate underline colour 2197 seperate underline colour (-underlineColor)
2377 settable border widths and borderless switch 2198 settable border widths and borderless switch (-w, -b, -bl)
2199 visual depth selection (-depth)
2378 settable extra linespacing 2200 settable extra linespacing /-lsp)
2379 iso-14755-2 and -3, and visual feedback 2201 iso-14755-2 and -3, and visual feedback
2202 tripleclickwords (-tcw)
2203 settable insecure mode (-insecure)
2204 keysym remapping support
2205 cursor blinking and underline cursor (-cb, -uc)
2206 XEmbed support (-embed)
2207 user-pty (-pty-fd)
2208 hold on exit (-hold)
2209 skip builtin block graphics (-sbg)
2210
2211It also enabled some non-essential features otherwise disabled, such as:
2212
2213 some round-trip time optimisations
2214 nearest color allocation on pseudocolor screens
2215 UTF8_STRING supporr for selection
2216 sgr modes 90..97 and 100..107
2380 backindex and forwardindex escape sequence 2217 backindex and forwardindex escape sequences
2218 view change/zero scorllback esacpe sequences
2219 locale switching escape sequence
2381 window op and some xterm/OSC escape sequences 2220 window op and some xterm/OSC escape sequences
2382 tripleclickwords 2221 rectangular selections
2383 settable insecure mode 2222 trailing space removal for selections
2384 keysym remapping support 2223 verbose X error handling
2385 -embed and -pty-fd options
2386 2224
2387=item --enable-iso14755 2225=item --enable-iso14755 (default: on)
2388 2226
2389Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2227Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2390F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2228F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2391C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2229C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2392this switch. 2230this switch.
2393 2231
2394=item --enable-keepscrolling 2232=item --enable-keepscrolling (default: on)
2395 2233
2396Add support for continual scrolling of the display when you hold 2234Add support for continual scrolling of the display when you hold
2397the mouse button down on a scrollbar arrow. 2235the mouse button down on a scrollbar arrow.
2398 2236
2399=item --enable-mousewheel 2237=item --enable-mousewheel (default: on)
2400 2238
2401Add support for scrolling via mouse wheel or buttons 4 & 5. 2239Add support for scrolling via mouse wheel or buttons 4 & 5.
2402 2240
2403=item --enable-slipwheeling 2241=item --enable-slipwheeling (default: on)
2404 2242
2405Add support for continual scrolling (using the mouse wheel as an 2243Add support for continual scrolling (using the mouse wheel as an
2406accelerator) while the control key is held down. This option 2244accelerator) while the control key is held down. This option
2407requires --enable-mousewheel to also be specified. 2245requires --enable-mousewheel to also be specified.
2408 2246
2409=item --disable-new-selection 2247=item --disable-new-selection
2410 2248
2411Remove support for mouse selection style like that of xterm. 2249Remove support for mouse selection style like that of xterm.
2412 2250
2413=item --enable-dmalloc 2251=item --enable-dmalloc (default: off)
2414 2252
2415Use Gray Watson's malloc - which is good for debugging See 2253Use Gray Watson's malloc - which is good for debugging See
2416http://www.letters.com/dmalloc/ for details If you use either this or the 2254http://www.letters.com/dmalloc/ for details If you use either this or the
2417next option, you may need to edit src/Makefile after compiling to point 2255next option, you may need to edit src/Makefile after compiling to point
2418DINCLUDE and DLIB to the right places. 2256DINCLUDE and DLIB to the right places.
2419 2257
2420You can only use either this option and the following (should 2258You can only use either this option and the following (should
2421you use either) . 2259you use either) .
2422 2260
2423=item --enable-dlmalloc 2261=item --enable-dlmalloc (default: off)
2424 2262
2425Use Doug Lea's malloc - which is good for a production version 2263Use Doug Lea's malloc - which is good for a production version
2426See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2264See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2427 2265
2428=item --enable-smart-resize 2266=item --enable-smart-resize (default: on)
2429 2267
2430Add smart growth/shrink behaviour when changing font size via from hot 2268Add smart growth/shrink behaviour when changing font size via hot
2431keys. This should keep in a fixed position the rxvt corner which is 2269keys. This should keep the window corner which is closest to a corner of
2432closest to a corner of the screen. 2270the screen in a fixed position.
2433 2271
2434=item --enable-cursor-blink
2435
2436Add support for a blinking cursor.
2437
2438=item --enable-pointer-blank 2272=item --enable-pointer-blank (default: on)
2439 2273
2440Add support to have the pointer disappear when typing or inactive. 2274Add support to have the pointer disappear when typing or inactive.
2441 2275
2442=item --with-name=NAME 2276=item --enable-perl (default: on)
2443 2277
2278Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2279manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2280in F<src/perl-ext/> for the extensions that are installed by default. The
2281perl interpreter that is used can be specified via the C<PERL> environment
2282variable when running configure.
2283
2284=item --with-name=NAME (default: urxvt)
2285
2444Set the basename for the installed binaries (default: C<urxvt>, resulting 2286Set the basename for the installed binaries, resulting
2445in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2287in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2446C<rxvt>. 2288C<rxvt>.
2447 2289
2448=item --with-term=NAME 2290=item --with-term=NAME (default: rxvt-unicode)
2449 2291
2450Change the environmental variable for the terminal to NAME (default 2292Change the environmental variable for the terminal to NAME.
2451C<rxvt-unicode>)
2452 2293
2453=item --with-terminfo=PATH 2294=item --with-terminfo=PATH
2454 2295
2455Change the environmental variable for the path to the terminfo tree to 2296Change the environmental variable for the path to the terminfo tree to
2456PATH. 2297PATH.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines