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.6 by root, Sat Aug 14 03:00:32 2004 UTC vs.
Revision 1.120 by root, Mon Aug 7 15:59:44 2006 UTC

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

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines