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.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.143 by ayin, Thu Aug 2 00:09:54 2007 UTC

1=head1 Rxvt Technical Reference 1=head1 NAME
2 2
3Marc Lehmann <rxvt@schmorp.de>, converted to pod and reworked from the 3RXVT REFERENCE - FAQ, command sequences and other background information
4original Rxvt documentation by Geoff Wing <gcw@pobox.com>, who in turn used
5the XTerm documentation and other sources.
6 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/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<pod2xhtml> (from
131F<Pod::Xhtml>). Then go to the 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 and 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 and works as user and admin):
844
845 REMOTE=remotesystem.domain
846 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
847
848... or by installing rxvt-unicode normally on the remote system,
849
850One some systems you might need to set C<$TERMINFO> to the full path of
851F<$HOME/.terminfo> for this to work.
852
853If you cannot or do not want to do this, then you can simply set
854C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
855problems arising, which includes wrong keymapping, less and different
856colours and some refresh errors in fullscreen applications. It's a nice
857quick-and-dirty workaround for rare cases, though.
858
859If you always want to do this (and are fine with the consequences) you
860can either recompile rxvt-unicode with the desired TERM value or use a
861resource to set it:
862
863 URxvt.termName: rxvt
864
865If you don't plan to use B<rxvt> (quite common...) you could also replace
866the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
867
868=head3 C<tic> outputs some error when compiling the terminfo entry.
869
870Most likely it's the empty definition for C<enacs=>. Just replace it by
871C<enacs=\E[0@> and try again.
872
873=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
874
875See next entry.
876
877=head3 I need a termcap file entry.
878
879One reason you might want this is that some distributions or operating
880systems still compile some programs using the long-obsoleted termcap
881library (Fedora Core's bash is one example) and rely on a termcap entry
882for C<rxvt-unicode>.
883
884You could use rxvt's termcap entry with reasonable results in many cases.
885You can also create a termcap entry by using terminfo's infocmp program
886like this:
887
888 infocmp -C rxvt-unicode
889
890Or you could use this termcap entry, generated by the command above:
891
892 rxvt-unicode|rxvt-unicode terminal (X Window System):\
893 :am:bw:eo:km:mi:ms:xn:xo:\
894 :co#80:it#8:li#24:lm#0:\
895 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
896 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
897 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
898 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
899 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
900 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
901 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
902 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
903 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
904 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
905 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
906 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
907 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
908 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
909 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
910 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
911 :vs=\E[?25h:
912
913=head3 Why does C<ls> no longer have coloured output?
914
915The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
916decide whether a terminal has colour, but uses its own configuration
917file. Needless to say, C<rxvt-unicode> is not in its default file (among
918with most other terminals supporting colour). Either add:
919
920 TERM rxvt-unicode
921
922to C</etc/DIR_COLORS> or simply add:
923
924 alias ls='ls --color=auto'
925
926to your C<.profile> or C<.bashrc>.
927
928=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
929
930See next entry.
931
932=head3 Why doesn't vim/emacs etc. make use of italic?
933
934See next entry.
935
936=head3 Why are the secondary screen-related options not working properly?
937
938Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
939distributions (most notably Debian GNU/Linux) break rxvt-unicode
940by setting C<TERM> to C<rxvt>, which doesn't have these extra
941features. Unfortunately, some of these (most notably, again, Debian
942GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
943file, so you will need to install it on your own (See the question B<When
944I log-in to another system it tells me about missing terminfo data?> on
945how to do this).
946
947
948=head2 Encoding / Locale / Input Method Issues
949
950=head3 Rxvt-unicode does not seem to understand the selected encoding?
951
952See next entry.
953
954=head3 Unicode does not seem to work?
955
956If you encounter strange problems like typing an accented character but
957getting two unrelated other characters or similar, or if program output is
958subtly garbled, then you should check your locale settings.
959
960Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
961programs running in it. Often rxvt-unicode is started in the C<C> locale,
962while the login script running within the rxvt-unicode window changes the
963locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
964not going to work, and is the most common cause for problems.
965
966The best thing is to fix your startup environment, as you will likely run
967into other problems. If nothing works you can try this in your .profile.
968
969 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
970
971If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
972supported on your systems. Some systems have a C<locale> command which
973displays this (also, C<perl -e0> can be used to check locale settings, as
974it will complain loudly if it cannot set the locale). If it displays something
975like:
976
977 locale: Cannot set LC_CTYPE to default locale: ...
978
979Then the locale you specified is not supported on your system.
980
981If nothing works and you are sure that everything is set correctly then
982you will need to remember a little known fact: Some programs just don't
983support locales :(
984
985=head3 How does rxvt-unicode determine the encoding to use?
986
987See next entry.
988
989=head3 Is there an option to switch encodings?
990
991Unlike some other terminals, rxvt-unicode has no encoding switch, and no
992specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
993UTF-8 or any other encodings with respect to terminal I/O.
994
995The reasons is that there exists a perfectly fine mechanism for selecting
996the encoding, doing I/O and (most important) communicating this to all
997applications so everybody agrees on character properties such as width
998and code number. This mechanism is the I<locale>. Applications not using
999that info will have problems (for example, C<xterm> gets the width of
1000characters wrong as it uses its own, locale-independent table under all
1001locales).
1002
1003Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
1004programs doing the same (that is, most) will automatically agree in the
1005interpretation of characters.
1006
1007Unfortunately, there is no system-independent way to select locales, nor
1008is there a standard on how locale specifiers will look like.
1009
1010On most systems, the content of the C<LC_CTYPE> environment variable
1011contains an arbitrary string which corresponds to an already-installed
1012locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1013C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1014(i.e. C<de> or C<german>) are also common.
1015
1016Rxvt-unicode ignores all other locale categories, and except for
1017the encoding, ignores country or language-specific settings,
1018i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
1019rxvt-unicode.
1020
1021If you want to use a specific encoding you have to make sure you start
1022rxvt-unicode with the correct C<LC_CTYPE> category.
1023
1024=head3 Can I switch locales at runtime?
1025
1026Yes, using an escape sequence. Try something like this, which sets
1027rxvt-unicode's idea of C<LC_CTYPE>.
1028
1029 printf '\33]701;%s\007' ja_JP.SJIS
1030
1031See also the previous answer.
1032
1033Sometimes this capability is rather handy when you want to work in
1034one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
1035(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
1036first switches to a locale supported by xjdic and back later:
1037
1038 printf '\33]701;%s\007' ja_JP.SJIS
1039 xjdic -js
1040 printf '\33]701;%s\007' de_DE.UTF-8
1041
1042You can also use xterm's C<luit> program, which usually works fine, except
1043for some locales where character width differs between program- and
1044rxvt-unicode-locales.
1045
1046=head3 I have problems getting my input method working.
1047
1048Try a search engine, as this is slightly different for every input method server.
1049
1050Here is a checklist:
1051
1052=over 4
1053
1054=item - Make sure your locale I<and> the imLocale are supported on your OS.
1055
1056Try C<locale -a> or check the documentation for your OS.
1057
1058=item - Make sure your locale or imLocale matches a locale supported by your XIM.
1059
1060For example, B<kinput2> does not support UTF-8 locales, you should use
1061C<ja_JP.EUC-JP> or equivalent.
1062
1063=item - Make sure your XIM server is actually running.
1064
1065=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1066
1067When you want to use e.g. B<kinput2>, it must be set to
1068C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1069method servers are running with this command:
1070
1071 xprop -root XIM_SERVERS
1072
1073=item
1074
1075=back
1076
1077=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
1078
1079You can specify separate locales for the input method and the rest of the
1080terminal, using the resource C<imlocale>:
1081
1082 URxvt.imlocale: ja_JP.EUC-JP
1083
1084Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
1085use your input method. Please note, however, that, depending on your Xlib
1086version, you may not be able to input characters outside C<EUC-JP> in a
1087normal way then, as your input method limits you.
1088
1089=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
1090
1091Unfortunately, this is unavoidable, as the XIM protocol is racy by
1092design. Applications can avoid some crashes at the expense of memory
1093leaks, and Input Methods can avoid some crashes by careful ordering at
1094exit time. B<kinput2> (and derived input methods) generally succeeds,
1095while B<SCIM> (or similar input methods) fails. In the end, however,
1096crashes cannot be completely avoided even if both sides cooperate.
1097
1098So the only workaround is not to kill your Input Method Servers.
1099
1100
1101=head2 Operating Systems / Package Maintaining
1102
1103=head3 I am using Debian GNU/Linux and have a problem...
1104
1105The Debian GNU/Linux package of rxvt-unicode in sarge contains large
1106patches that considerably change the behaviour of rxvt-unicode (but
1107unfortunately this notice has been removed). Before reporting a bug to
1108the original rxvt-unicode author please download and install the genuine
1109version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
1110the problem. If you cannot, chances are that the problems are specific to
1111Debian GNU/Linux, in which case it should be reported via the Debian Bug
1112Tracking System (use C<reportbug> to report the bug).
1113
1114For other problems that also affect the Debian package, you can and
1115probably should use the Debian BTS, too, because, after all, it's also a
1116bug in the Debian version and it serves as a reminder for other users that
1117might encounter the same issue.
1118
1119=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
1120
1121You should build one binary with the default options. F<configure>
1122now enables most useful options, and the trend goes to making them
1123runtime-switchable, too, so there is usually no drawback to enabling them,
1124except higher disk and possibly memory usage. The perl interpreter should
1125be enabled, as important functionality (menus, selection, likely more in
1126the future) depends on it.
1127
1128You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
1129system-wide (except maybe with C<defaults>). This will result in useful
1130behaviour. If your distribution aims at low memory, add an empty
1131C<perl-ext-common> resource to the app-defaults file. This will keep the
1132perl interpreter disabled until the user enables it.
1133
1134If you can/want build more binaries, I recommend building a minimal
1135one with C<--disable-everything> (very useful) and a maximal one with
1136C<--enable-everything> (less useful, it will be very big due to a lot of
1137encodings built-in that increase download times and are rarely used).
1138
1139=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
1140
1141It should be, starting with release 7.1. You are encouraged to properly
1142install urxvt with privileges necessary for your OS now.
1143
1144When rxvt-unicode detects that it runs setuid or setgid, it will fork
1145into a helper process for privileged operations (pty handling on some
1146systems, utmp/wtmp/lastlog handling on others) and drop privileges
1147immediately. This is much safer than most other terminals that keep
1148privileges while running (but is more relevant to urxvt, as it contains
1149things as perl interpreters, which might be "helpful" to attackers).
1150
1151This forking is done as the very first within main(), which is very early
1152and reduces possible bugs to initialisation code run before main(), or
1153things like the dynamic loader of your system, which should result in very
1154little risk.
1155
1156=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
1157
1158Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1159in your compile environment, or an implementation that implements it,
1160whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
1161B<wchar_t> is represented as unicode.
1162
1163As you might have guessed, FreeBSD does neither define this symbol nor
1164does it support it. Instead, it uses its own internal representation of
1165B<wchar_t>. This is, of course, completely fine with respect to standards.
1166
1167However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
1168C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
1169
1170C<__STDC_ISO_10646__> is the only sane way to support multi-language
1171apps in an OS, as using a locale-dependent (and non-standardized)
1172representation of B<wchar_t> makes it impossible to convert between
1173B<wchar_t> (as used by X11 and your applications) and any other encoding
1174without implementing OS-specific-wrappers for each and every locale. There
1175simply are no APIs to convert B<wchar_t> into anything except the current
1176locale encoding.
1177
1178Some applications (such as the formidable B<mlterm>) work around this
1179by carrying their own replacement functions for character set handling
1180with them, and either implementing OS-dependent hacks or doing multiple
1181conversions (which is slow and unreliable in case the OS implements
1182encodings slightly different than the terminal emulator).
1183
1184The rxvt-unicode author insists that the right way to fix this is in the
1185system libraries once and for all, instead of forcing every app to carry
1186complete replacements for them :)
1187
1188=head3 How can I use rxvt-unicode under cygwin?
1189
1190rxvt-unicode should compile and run out of the box on cygwin, using
1191the X11 libraries that come with cygwin. libW11 emulation is no
1192longer supported (and makes no sense, either, as it only supported a
1193single font). I recommend starting the X-server in C<-multiwindow> or
1194C<-rootless> mode instead, which will result in similar look&feel as the
1195old libW11 emulation.
1196
1197At the time of this writing, cygwin didn't seem to support any multi-byte
1198encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1199to 8-bit encodings.
1200
1201=head3 Character widths are not correct.
1202
1203urxvt uses the system wcwidth function to know the information about
1204the width of characters, so on systems with incorrect locale data you
1205will likely get bad results. Two notorious examples are Solaris 9,
1206where single-width characters like U+2514 are reported as double-width,
1207and Darwin 8, where combining chars are reported having width 1.
1208
1209The solution is to upgrade your system or switch to a better one. A
1210possibly working workaround is to use a wcwidth implementation like
1211
1212http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1213
1214=head1 RXVT-UNICODE TECHNICAL REFERENCE
1215
1216The rest of this document describes various technical aspects of
1217B<rxvt-unicode>. First the description of supported command sequences,
1218followed by pixmap support and last by a description of all features
1219selectable at C<configure> time.
1220
7=head1 Definitions 1221=head2 Definitions
8 1222
9=over 4 1223=over 4
10 1224
11=item B<< C<c> >> 1225=item B<< C<c> >>
12 1226
30 1244
31A text parameter composed of printable characters. 1245A text parameter composed of printable characters.
32 1246
33=back 1247=back
34 1248
35=head1 Values 1249=head2 Values
36 1250
37=over 4 1251=over 4
38 1252
39=item B<< C<ENQ> >> 1253=item B<< C<ENQ> >>
40 1254
41Enquiry (Ctrl-E) = Send Device Attributes (DA) 1255Enquiry (Ctrl-E) = Send Device Attributes (DA)
42request attributes from terminal == 1256request attributes from terminal. See B<< C<ESC [ Ps c> >>.
43 1257
44=item B<< C<BEL> >> 1258=item B<< C<BEL> >>
45 1259
46Bell (Ctrl-G) 1260Bell (Ctrl-G)
47 1261
83 1297
84Space Character 1298Space Character
85 1299
86=back 1300=back
87 1301
88=head1 Escape Sequences 1302=head2 Escape Sequences
89 1303
90=over 4 1304=over 4
91 1305
92=item B<< C<ESC # 8> >> 1306=item B<< C<ESC # 8> >>
93 1307
139Single Shift Select of G3 Character Set (SS3): affects next character 1353Single Shift Select of G3 Character Set (SS3): affects next character
140only I<unimplemented> 1354only I<unimplemented>
141 1355
142=item B<< C<ESC Z> >> 1356=item B<< C<ESC Z> >>
143 1357
144Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt compile-time option> 1358Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
145 1359
146=item B<< C<ESC c> >> 1360=item B<< C<ESC c> >>
147 1361
148Full reset (RIS) 1362Full reset (RIS)
149 1363
153 1367
154=item B<< C<ESC o> >> 1368=item B<< C<ESC o> >>
155 1369
156Invoke the G3 Character Set (LS3) 1370Invoke the G3 Character Set (LS3)
157 1371
158=item B<< C<ESC>(C<C> >> 1372=item B<< C<ESC ( C> >>
159 1373
160Designate G0 Character Set (ISO 2022), see below for values of C<C>. 1374Designate G0 Character Set (ISO 2022), see below for values of C<C>.
161 1375
162=item B<< C<ESC>)C<C> >> 1376=item B<< C<ESC ) C> >>
163 1377
164Designate G1 Character Set (ISO 2022), see below for values of C<C>. 1378Designate G1 Character Set (ISO 2022), see below for values of C<C>.
165 1379
166=item B<< C<ESC * C> >> 1380=item B<< C<ESC * C> >>
167 1381
191 1405
192=back 1406=back
193 1407
194X<CSI> 1408X<CSI>
195 1409
196=head1 CSI (Code Sequence Introducer) Sequences 1410=head2 CSI (Command Sequence Introducer) Sequences
197 1411
198=over 4 1412=over 4
199 1413
200=item B<< C<ESC [ Ps @> >> 1414=item B<< C<ESC [ Ps @> >>
201 1415
298 1512
299Move backward B<< C<Ps> >> [default: 1] tab stops 1513Move backward B<< C<Ps> >> [default: 1] tab stops
300 1514
301=item B<< C<ESC [ Ps '> >> 1515=item B<< C<ESC [ Ps '> >>
302 1516
303== 1517See B<< C<ESC [ Ps G> >>
304 1518
305=item B<< C<ESC [ Ps a> >> 1519=item B<< C<ESC [ Ps a> >>
306 1520
307==X<ESCOBPsc> 1521See B<< C<ESC [ Ps C> >>
308 1522
309=item B<< C<ESC [ Ps c> >> 1523=item B<< C<ESC [ Ps c> >>
310 1524
311Send Device Attributes (DA) 1525Send Device Attributes (DA)
312B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1526B<< C<Ps = 0> >> (or omitted): request attributes from terminal
313returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1527returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
314Option'') 1528Option'')
315 1529
316=item B<< C<ESC [ Ps d> >> 1530=item B<< C<ESC [ Ps d> >>
317 1531
318Cursor to Line B<< C<Ps> >> (VPA) 1532Cursor to Line B<< C<Ps> >> (VPA)
319 1533
320=item B<< C<ESC [ Ps e> >> 1534=item B<< C<ESC [ Ps e> >>
321 1535
322== 1536See B<< C<ESC [ Ps A> >>
323 1537
324=item B<< C<ESC [ Ps;Ps f> >> 1538=item B<< C<ESC [ Ps;Ps f> >>
325 1539
326Horizontal and Vertical Position [row;column] (HVP) [default: 1;1] 1540Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]
327 1541
334 B<< C<Ps = 0> >> Clear Current Column (default) 1548 B<< C<Ps = 0> >> Clear Current Column (default)
335 B<< C<Ps = 3> >> Clear All (TBC) 1549 B<< C<Ps = 3> >> Clear All (TBC)
336 1550
337=end table 1551=end table
338 1552
1553=item B<< C<ESC [ Pm h> >>
1554
1555Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
1556
339=item B<< C<ESC [ Ps i> >> 1557=item B<< C<ESC [ Ps i> >>
340 1558
341Printing 1559Printing. See also the C<print-pipe> resource.
342 1560
343=begin table 1561=begin table
344 1562
1563 B<< C<Ps = 0> >> print screen (MC0)
345 B<< C<Ps = 4> >> disable transparent print mode (MC4) 1564 B<< C<Ps = 4> >> disable transparent print mode (MC4)
346 B<< C<Ps = 5> >> enable transparent print mode (MC5) I<unimplemented> 1565 B<< C<Ps = 5> >> enable transparent print mode (MC5)
347 1566
348=end table 1567=end table
349
350=item B<< C<ESC [ Pm h> >>
351
352Set Mode (SM). See next sequence for description of C<Pm>.
353 1568
354=item B<< C<ESC [ Pm l> >> 1569=item B<< C<ESC [ Pm l> >>
355 1570
356Reset Mode (RM) 1571Reset Mode (RM)
357 1572
364 B<< C<h> >> Insert Mode (SMIR) 1579 B<< C<h> >> Insert Mode (SMIR)
365 B<< C<l> >> Replace Mode (RMIR) 1580 B<< C<l> >> Replace Mode (RMIR)
366 1581
367=end table 1582=end table
368 1583
369=item B<< C<Ps = 20> >> I<unimplemented> 1584=item B<< C<Ps = 20> >> (partially implemented)
370 1585
371=begin table 1586=begin table
372 1587
373 B<< C<h> >> Automatic Newline (LNM) 1588 B<< C<h> >> Automatic Newline (LNM)
374 B<< C<h> >> Normal Linefeed (LNM) 1589 B<< C<l> >> Normal Linefeed (LNM)
375 1590
376=end table 1591=end table
377 1592
378=back 1593=back
379 1594
382Character Attributes (SGR) 1597Character Attributes (SGR)
383 1598
384=begin table 1599=begin table
385 1600
386 B<< C<Ps = 0> >> Normal (default) 1601 B<< C<Ps = 0> >> Normal (default)
387 B<< C<Ps = 1 / 22> >> On / Off Bold (bright fg) 1602 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg)
1603 B<< C<Ps = 3 / 23> >> On / Off Italic
388 B<< C<Ps = 4 / 24> >> On / Off Underline 1604 B<< C<Ps = 4 / 24> >> On / Off Underline
389 B<< C<Ps = 5 / 25> >> On / Off Blink (bright bg) 1605 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg)
1606 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg)
390 B<< C<Ps = 7 / 27> >> On / Off Inverse 1607 B<< C<Ps = 7 / 27> >> On / Off Inverse
1608 B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI)
391 B<< C<Ps = 30 / 40> >> fg/bg Black 1609 B<< C<Ps = 30 / 40> >> fg/bg Black
392 B<< C<Ps = 31 / 41> >> fg/bg Red 1610 B<< C<Ps = 31 / 41> >> fg/bg Red
393 B<< C<Ps = 32 / 42> >> fg/bg Green 1611 B<< C<Ps = 32 / 42> >> fg/bg Green
394 B<< C<Ps = 33 / 43> >> fg/bg Yellow 1612 B<< C<Ps = 33 / 43> >> fg/bg Yellow
395 B<< C<Ps = 34 / 44> >> fg/bg Blue 1613 B<< C<Ps = 34 / 44> >> fg/bg Blue
396 B<< C<Ps = 35 / 45> >> fg/bg Magenta 1614 B<< C<Ps = 35 / 45> >> fg/bg Magenta
397 B<< C<Ps = 36 / 46> >> fg/bg Cyan 1615 B<< C<Ps = 36 / 46> >> fg/bg Cyan
1616 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to color #m (ISO 8613-6)
398 B<< C<Ps = 37 / 47> >> fg/bg White 1617 B<< C<Ps = 37 / 47> >> fg/bg White
399 B<< C<Ps = 39 / 49> >> fg/bg Default 1618 B<< C<Ps = 39 / 49> >> fg/bg Default
1619 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
1620 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
1621 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
1622 B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow
1623 B<< C<Ps = 94 / 104> >> fg/bg Bright Blue
1624 B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta
1625 B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan
1626 B<< C<Ps = 97 / 107> >> fg/bg Bright White
1627 B<< C<Ps = 99 / 109> >> fg/bg Bright Default
400 1628
401=end table 1629=end table
402 1630
403=item B<< C<ESC [ Ps n> >> 1631=item B<< C<ESC [ Ps n> >>
404 1632
420 1648
421=item B<< C<ESC [ s> >> 1649=item B<< C<ESC [ s> >>
422 1650
423Save Cursor (SC) 1651Save Cursor (SC)
424 1652
1653=item B<< C<ESC [ Ps;Pt t> >>
1654
1655Window Operations
1656
1657=begin table
1658
1659 B<< C<Ps = 1> >> Deiconify (map) window
1660 B<< C<Ps = 2> >> Iconify window
1661 B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1662 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1663 B<< C<Ps = 5> >> Raise window
1664 B<< C<Ps = 6> >> Lower window
1665 B<< C<Ps = 7> >> Refresh screen once
1666 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1667 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1668 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1669 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1670 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1671 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1672 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1673 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
1674 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1675
1676=end table
1677
1678=item B<< C<ESC [ u> >>
1679
1680Restore Cursor
1681
425=item B<< C<ESC [ Ps x> >> 1682=item B<< C<ESC [ Ps x> >>
426 1683
427Request Terminal Parameters (DECREQTPARM) 1684Request Terminal Parameters (DECREQTPARM)
428 1685
429=item B<< C<ESC [ u> >>
430
431Restore Cursor
432
433=back 1686=back
434 1687
435X<PrivateModes> 1688X<PrivateModes>
436 1689
437=head1 DEC Private Modes 1690=head2 DEC Private Modes
438 1691
439=over 4 1692=over 4
440 1693
441=item B<< C<ESC [ ? Pm h> >> 1694=item B<< C<ESC [ ? Pm h> >>
442 1695
458 1711
459Toggle DEC Private Mode Values (rxvt extension). I<where> 1712Toggle DEC Private Mode Values (rxvt extension). I<where>
460 1713
461=over 4 1714=over 4
462 1715
463=item B<< C<Ps = 1> >> (DECCKM) 1716=item B<< C<Pm = 1> >> (DECCKM)
464 1717
465=begin table 1718=begin table
466 1719
467 B<< C<h> >> Application Cursor Keys 1720 B<< C<h> >> Application Cursor Keys
468 B<< C<l> >> Normal Cursor Keys 1721 B<< C<l> >> Normal Cursor Keys
469 1722
470=end table 1723=end table
471 1724
472=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1725=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
473 1726
474=begin table 1727=begin table
475 1728
476 B<< C<h> >> Enter VT52 mode 1729 B<< C<h> >> Enter VT52 mode
477 B<< C<l> >> Enter VT52 mode 1730 B<< C<l> >> Enter VT52 mode
478 1731
479=end table 1732=end table
480 1733
481=item B<< C<Ps = 3> >> 1734=item B<< C<Pm = 3> >>
482 1735
483=begin table 1736=begin table
484 1737
485 B<< C<h> >> 132 Column Mode (DECCOLM) 1738 B<< C<h> >> 132 Column Mode (DECCOLM)
486 B<< C<l> >> 80 Column Mode (DECCOLM) 1739 B<< C<l> >> 80 Column Mode (DECCOLM)
487 1740
488=end table 1741=end table
489 1742
490=item B<< C<Ps = 4> >> 1743=item B<< C<Pm = 4> >>
491 1744
492=begin table 1745=begin table
493 1746
494 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1747 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
495 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1748 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
496 1749
497=end table 1750=end table
498 1751
499=item B<< C<Ps = 5> >> 1752=item B<< C<Pm = 5> >>
500 1753
501=begin table 1754=begin table
502 1755
503 B<< C<h> >> Reverse Video (DECSCNM) 1756 B<< C<h> >> Reverse Video (DECSCNM)
504 B<< C<l> >> Normal Video (DECSCNM) 1757 B<< C<l> >> Normal Video (DECSCNM)
505 1758
506=end table 1759=end table
507 1760
508=item B<< C<Ps = 6> >> 1761=item B<< C<Pm = 6> >>
509 1762
510=begin table 1763=begin table
511 1764
512 B<< C<h> >> Origin Mode (DECOM) 1765 B<< C<h> >> Origin Mode (DECOM)
513 B<< C<l> >> Normal Cursor Mode (DECOM) 1766 B<< C<l> >> Normal Cursor Mode (DECOM)
514 1767
515=end table 1768=end table
516 1769
517=item B<< C<Ps = 7> >> 1770=item B<< C<Pm = 7> >>
518 1771
519=begin table 1772=begin table
520 1773
521 B<< C<h> >> Wraparound Mode (DECAWM) 1774 B<< C<h> >> Wraparound Mode (DECAWM)
522 B<< C<l> >> No Wraparound Mode (DECAWM) 1775 B<< C<l> >> No Wraparound Mode (DECAWM)
523 1776
524=end table 1777=end table
525 1778
526=item B<< C<Ps = 8> >> I<unimplemented> 1779=item B<< C<Pm = 8> >> I<unimplemented>
527 1780
528=begin table 1781=begin table
529 1782
530 B<< C<h> >> Auto-repeat Keys (DECARM) 1783 B<< C<h> >> Auto-repeat Keys (DECARM)
531 B<< C<l> >> No Auto-repeat Keys (DECARM) 1784 B<< C<l> >> No Auto-repeat Keys (DECARM)
532 1785
533=end table 1786=end table
534 1787
535=item B<< C<Ps = 9> >> X10 XTerm 1788=item B<< C<Pm = 9> >> X10 XTerm
536 1789
537=begin table 1790=begin table
538 1791
539 B<< C<h> >> Send Mouse X & Y on button press. 1792 B<< C<h> >> Send Mouse X & Y on button press.
540 B<< C<l> >> No mouse reporting. 1793 B<< C<l> >> No mouse reporting.
541 1794
542=end table 1795=end table
543 1796
544)X<Priv10>
545
546=item B<< C<Ps = 10> >> (B<rxvt>)
547
548=begin table
549
550 B<< C<h> >> visible
551 B<< C<l> >> invisible
552
553=end table
554
555=item B<< C<Ps = 25> >> 1797=item B<< C<Pm = 25> >>
556 1798
557=begin table 1799=begin table
558 1800
559 B<< C<h> >> Visible cursor {cnorm/cvvis} 1801 B<< C<h> >> Visible cursor {cnorm/cvvis}
560 B<< C<l> >> Invisible cursor {civis} 1802 B<< C<l> >> Invisible cursor {civis}
561 1803
562=end table 1804=end table
563 1805
564=item B<< C<Ps = 30> >> 1806=item B<< C<Pm = 30> >>
565 1807
566=begin table 1808=begin table
567 1809
568 B<< C<h> >> scrollBar visisble 1810 B<< C<h> >> scrollBar visisble
569 B<< C<l> >> scrollBar invisisble 1811 B<< C<l> >> scrollBar invisisble
570 1812
571=end table 1813=end table
572 1814
573=item B<< C<Ps = 35> >> (B<rxvt>) 1815=item B<< C<Pm = 35> >> (B<rxvt>)
574 1816
575=begin table 1817=begin table
576 1818
577 B<< C<h> >> Allow XTerm Shift+key sequences 1819 B<< C<h> >> Allow XTerm Shift+key sequences
578 B<< C<l> >> Disallow XTerm Shift+key sequences 1820 B<< C<l> >> Disallow XTerm Shift+key sequences
579 1821
580=end table 1822=end table
581 1823
582=item B<< C<Ps = 38> >> I<unimplemented> 1824=item B<< C<Pm = 38> >> I<unimplemented>
583 1825
584Enter Tektronix Mode (DECTEK) 1826Enter Tektronix Mode (DECTEK)
585 1827
586=item B<< C<Ps = 40> >> 1828=item B<< C<Pm = 40> >>
587 1829
588=begin table 1830=begin table
589 1831
590 B<< C<h> >> Allow 80/132 Mode 1832 B<< C<h> >> Allow 80/132 Mode
591 B<< C<l> >> Disallow 80/132 Mode 1833 B<< C<l> >> Disallow 80/132 Mode
592 1834
593=end table 1835=end table
594 1836
595=item B<< C<Ps = 44> >> I<unimplemented> 1837=item B<< C<Pm = 44> >> I<unimplemented>
596 1838
597=begin table 1839=begin table
598 1840
599 B<< C<h> >> Turn On Margin Bell 1841 B<< C<h> >> Turn On Margin Bell
600 B<< C<l> >> Turn Off Margin Bell 1842 B<< C<l> >> Turn Off Margin Bell
601 1843
602=end table 1844=end table
603 1845
604=item B<< C<Ps = 45> >> I<unimplemented> 1846=item B<< C<Pm = 45> >> I<unimplemented>
605 1847
606=begin table 1848=begin table
607 1849
608 B<< C<h> >> Reverse-wraparound Mode 1850 B<< C<h> >> Reverse-wraparound Mode
609 B<< C<l> >> No Reverse-wraparound Mode 1851 B<< C<l> >> No Reverse-wraparound Mode
610 1852
611=end table 1853=end table
612 1854
613=item B<< C<Ps = 46> >> I<unimplemented> 1855=item B<< C<Pm = 46> >> I<unimplemented>
614 1856
615=item B<< C<Ps = 47> >> 1857=item B<< C<Pm = 47> >>
616 1858
617=begin table 1859=begin table
618 1860
619 B<< C<h> >> Use Alternate Screen Buffer 1861 B<< C<h> >> Use Alternate Screen Buffer
620 B<< C<l> >> Use Normal Screen Buffer 1862 B<< C<l> >> Use Normal Screen Buffer
621 1863
622=end table 1864=end table
623 1865
624X<Priv66> 1866X<Priv66>
625 1867
626=item B<< C<Ps = 66> >> 1868=item B<< C<Pm = 66> >>
627 1869
628=begin table 1870=begin table
629 1871
630 B<< C<h> >> Application Keypad (DECPAM) == 1872 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
631 B<< C<l> >> Normal Keypad (DECPNM) == 1873 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
632 1874
633=end table 1875=end table
634 1876
635=item B<< C<Ps = 67> >> 1877=item B<< C<Pm = 67> >>
636 1878
637=begin table 1879=begin table
638 1880
639 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1881 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
640 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1882 B<< C<l> >> Backspace key sends B<< C<DEL> >>
641 1883
642=end table 1884=end table
643 1885
644=item B<< C<Ps = 1000> >> (X11 XTerm) 1886=item B<< C<Pm = 1000> >> (X11 XTerm)
645 1887
646=begin table 1888=begin table
647 1889
648 B<< C<h> >> Send Mouse X & Y on button press and release. 1890 B<< C<h> >> Send Mouse X & Y on button press and release.
649 B<< C<l> >> No mouse reporting. 1891 B<< C<l> >> No mouse reporting.
650 1892
651=end table 1893=end table
652 1894
653=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1895=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
654 1896
655=begin table 1897=begin table
656 1898
657 B<< C<h> >> Use Hilite Mouse Tracking. 1899 B<< C<h> >> Use Hilite Mouse Tracking.
658 B<< C<l> >> No mouse reporting. 1900 B<< C<l> >> No mouse reporting.
659 1901
660=end table 1902=end table
661 1903
662=item B<< C<Ps = 1010> >> 1904=item B<< C<Pm = 1010> >> (B<rxvt>)
663 1905
664=begin table 1906=begin table
665 1907
666 B<< C<h> >> Don't scroll to bottom on TTY output 1908 B<< C<h> >> Don't scroll to bottom on TTY output
667 B<< C<l> >> Scroll to bottom on TTY output 1909 B<< C<l> >> Scroll to bottom on TTY output
668 1910
669=end table 1911=end table
670 1912
671=item B<< C<Ps = 1011> >> 1913=item B<< C<Pm = 1011> >> (B<rxvt>)
672 1914
673=begin table 1915=begin table
674 1916
675 B<< C<h> >> Scroll to bottom when a key is pressed 1917 B<< C<h> >> Scroll to bottom when a key is pressed
676 B<< C<l> >> Don't scroll to bottom when a key is pressed 1918 B<< C<l> >> Don't scroll to bottom when a key is pressed
677 1919
678=end table 1920=end table
679 1921
1922=item B<< C<Pm = 1021> >> (B<rxvt>)
1923
1924=begin table
1925
1926 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1927 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1928
1929=end table
1930
680=item B<< C<Ps = 1047> >> 1931=item B<< C<Pm = 1047> >>
681 1932
682=begin table 1933=begin table
683 1934
684 B<< C<h> >> Use Alternate Screen Buffer 1935 B<< C<h> >> Use Alternate Screen Buffer
685 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1936 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
686 1937
687=end table 1938=end table
688 1939
689=item B<< C<Ps = 1048> >> 1940=item B<< C<Pm = 1048> >>
690 1941
691=begin table 1942=begin table
692 1943
693 B<< C<h> >> Save cursor position 1944 B<< C<h> >> Save cursor position
694 B<< C<l> >> Restore cursor position 1945 B<< C<l> >> Restore cursor position
695 1946
696=end table 1947=end table
697 1948
1949=item B<< C<Pm = 1049> >>
1950
1951=begin table
1952
1953 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1954 B<< C<l> >> Use Normal Screen Buffer
1955
1956=end table
1957
698=back 1958=back
699 1959
700=back 1960=back
701 1961
702X<XTerm> 1962X<XTerm>
703 1963
704=head1 XTerm Operating System Commands 1964=head2 XTerm Operating System Commands
705 1965
706=over 4 1966=over 4
707 1967
708=item B<< C<ESC ] Ps;Pt ST> >> 1968=item B<< C<ESC ] Ps;Pt ST> >>
709 1969
721 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1981 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
722 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 1982 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
723 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 1983 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
724 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1984 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
725 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1985 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
726 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1986 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
727 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1987 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1988 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
728 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1989 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
729 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option>
730 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1990 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
731 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 1991 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
732 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> >> 1992 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> >>
733 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1993 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
734 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVTNAME@@ extension) 1994 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).
735 B<< C<Ps = 702> >> find font for character, used for debugging (@@RXVTNAME@@ extension) 1995 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>.
736 B<< C<Ps = 703> >> command B<< C<Pt> >> I<rxvt compile-time option> (@@RXVTNAME@@ extension) 1996 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1997 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1998 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1999 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
2000 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
2001 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2002 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2003 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2004 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2005 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2006 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
737 2007
738=end table 2008=end table
739 2009
740=back 2010=back
741
742X<menuBar>
743
744=head1 menuBar
745
746B<< The exact syntax used is I<almost> solidified. >>
747In the menus, B<DON'T> try to use menuBar commands that add or remove a
748menuBar.
749
750Note that in all of the commands, the B<< I</path/> >> I<cannot> be
751omitted: use B<./> to specify a menu relative to the current menu.
752
753=head2 Overview of menuBar operation
754
755For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
756of C<Pt> can be used for a variety of tasks:
757
758At the top level is the current menuBar which is a member of a circular
759linked-list of other such menuBars.
760
761The menuBar acts as a parent for the various drop-down menus, which in
762turn, may have labels, separator lines, menuItems and subMenus.
763
764The menuItems are the useful bits: you can use them to mimic keyboard
765input or even to send text or escape sequences back to rxvt.
766
767The menuBar syntax is intended to provide a simple yet robust method of
768constructing and manipulating menus and navigating through the
769menuBars.
770
771The first step is to use the tag B<< [menu:I<name>] >> which creates
772the menuBar called I<name> and allows access. You may now or menus,
773subMenus, and menuItems. Finally, use the tag B<[done]> to set the
774menuBar access as B<readonly> to prevent accidental corruption of the
775menus. To re-access the current menuBar for alterations, use the tag
776B<[menu]>, make the alterations and then use B<[done]>
777
778X<menuBarCommands>
779
780=head2 Commands
781
782=over 4
783
784=item B<< [menu:+I<name>] >>
785
786access the named menuBar for creation or alteration. If a new menuBar
787is created, it is called I<name> (max of 15 chars) and the current
788menuBar is pushed onto the stack
789
790=item B<[menu]>
791
792access the current menuBar for alteration
793
794=item B<< [title:+I<string>] >>
795
796set the current menuBar's title to I<string>, which may contain the
797following format specifiers:
798B<%%> : literal B<%> character
799B<%n> : rxvt name (as per the B<-name> command-line option)
800B<%v> : rxvt version
801
802=item B<[done]>
803
804set menuBar access as B<readonly>.
805End-of-file tag for B<< [read:+I<file>] >> operations.
806
807=item B<< [read:+I<file>] >>
808
809read menu commands directly from I<file> (extension ".menu" will be
810appended if required.) Start reading at a line with B<[menu]> or B<<
811[menu:+I<name> >> and continuing until B<[done]> is encountered.
812
813Blank and comment lines (starting with B<#>) are ignored. Actually,
814since any invalid menu commands are also ignored, almost anything could
815be construed as a comment line, but this may be tightened up in the
816future ... so don't count on it!.
817
818=item B<< [read:+I<file>;+I<name>] >>
819
820The same as B<< [read:+I<file>] >>, but start reading at a line with
821B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
822B<[done]> is encountered.
823
824=item B<[dump]>
825
826dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
827later rereading.
828
829=item B<[rm:name]>
830
831remove the named menuBar
832
833=item B<[rm] [rm:]>
834
835remove the current menuBar
836
837=item B<[rm*] [rm:*]>
838
839remove all menuBars
840
841=item B<[swap]>
842
843swap the top two menuBars
844
845=item B<[prev]>
846
847access the previous menuBar
848
849=item B<[next]>
850
851access the next menuBar
852
853=item B<[show]>
854
855Enable display of the menuBar
856
857=item B<[hide]>
858
859Disable display of the menuBar
860
861=item B<< [pixmap:+I<name>] >>
862
863=item B<< [pixmap:+I<name>;I<scaling>] >>
864
865(set the background pixmap globally
866
867B<< A Future implementation I<may> make this local to the menubar >>)
868
869=item B<< [:+I<command>:] >>
870
871ignore the menu readonly status and issue a I<command> to or a menu or
872menuitem or change the ; a useful shortcut for setting the quick arrows
873from a menuBar.
874
875=back
876
877X<menuBarAdd>
878
879=head2 Adding and accessing menus
880
881The following commands may also be B<+> prefixed.
882
883=over 4
884
885=item B</+>
886
887access menuBar top level
888
889=item B<./+>
890
891access current menu level
892
893=item B<../+>
894
895access parent menu (1 level up)
896
897=item B<../../>
898
899access parent menu (multiple levels up)
900
901=item B<< I</path/>menu >>
902
903add/access menu
904
905=item B<< I</path/>menu/* >>
906
907add/access menu and clear it if it exists
908
909=item B<< I</path/>{-} >>
910
911add separator
912
913=item B<< I</path/>{item} >>
914
915add B<item> as a label
916
917=item B<< I</path/>{item} action >>
918
919add/alter I<menuitem> with an associated I<action>
920
921=item B<< I</path/>{item}{right-text} >>
922
923add/alter I<menuitem> with B<right-text> as the right-justified text
924and as the associated I<action>
925
926=item B<< I</path/>{item}{rtext} action >>
927
928add/alter I<menuitem> with an associated I<action> and with B<rtext> as
929the right-justified text.
930
931=back
932
933=over 4
934
935=item Special characters in I<action> must be backslash-escaped:
936
937B<\a \b \E \e \n \r \t \octal>
938
939=item or in control-character notation:
940
941B<^@, ^A .. ^Z .. ^_, ^?>
942
943=back
944
945To send a string starting with a B<NUL> (B<^@>) character to the
946program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
947the first of which will be stripped off and the balance directed to the
948program. Otherwise if I<action> begins with B<NUL> followed by
949non-+B<NUL> characters, the leading B<NUL> is stripped off and the
950balance is sent back to rxvt.
951
952As a convenience for the many Emacs-type editors, I<action> may start
953with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
954appended if missed from B<M-x> commands.
955
956As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or
957quick arrow), a B<BEL> (B<^G>) will be appended if needed.
958
959=over 4
960
961=item For example,
962
963B<M-xapropos> is equivalent to B<\Exapropos\r>
964
965=item and
966
967B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
968
969=back
970
971The option B<< {I<right-rtext>} >> will be right-justified. In the
972absence of a specified action, this text will be used as the I<action>
973as well.
974
975=over 4
976
977=item For example,
978
979B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
980
981=back
982
983The left label I<is> necessary, since it's used for matching, but
984implicitly hiding the left label (by using same name for both left and
985right labels), or explicitly hiding the left label (by preceeding it
986with a dot), makes it possible to have right-justified text only.
987
988=over 4
989
990=item For example,
991
992B</File/{Open}{Open} Open-File-Action>
993
994=item or hiding it
995
996B</File/{.anylabel}{Open} Open-File-Action>
997
998=back
999
1000X<menuBarRemove>
1001
1002=head2 Removing menus
1003
1004=over 4
1005
1006=item B<< -/*+ >>
1007
1008remove all menus from the menuBar, the same as B<[clear]>
1009
1010=item B<< -+I</path>menu+ >>
1011
1012remove menu
1013
1014=item B<< -+I</path>{item}+ >>
1015
1016remove item
1017
1018=item B<< -+I</path>{-} >>
1019
1020remove separator)
1021
1022=item B<-/path/menu/*>
1023
1024remove all items, separators and submenus from menu
1025
1026=back
1027
1028X<menuBarArrows>
1029
1030=head2 Quick Arrows
1031
1032The menus also provide a hook for I<quick arrows> to provide easier
1033user access. If nothing has been explicitly set, the default is to
1034emulate the curror keys. The syntax permits each arrow to be altered
1035individually or all four at once without re-entering their common
1036beginning/end text. For example, to explicitly associate cursor actions
1037with the arrows, any of the following forms could be used:
1038
1039=over 4
1040
1041=item B<< <r>+I<Right> >>
1042
1043=item B<< <l>+I<Left> >>
1044
1045=item B<< <u>+I<Up> >>
1046
1047=item B<< <d>+I<Down> >>
1048
1049Define actions for the respective arrow buttons
1050
1051=item B<< <b>+I<Begin> >>
1052
1053=item B<< <e>+I<End> >>
1054
1055Define common beginning/end parts for I<quick arrows> which used in
1056conjunction with the above <r> <l> <u> <d> constructs
1057
1058=back
1059
1060=over 4
1061
1062=item For example, define arrows individually,
1063
1064 <u>\E[A
1065
1066 <d>\E[B
1067
1068 <r>\E[C
1069
1070 <l>\E[D
1071
1072=item or all at once
1073
1074 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1075
1076=item or more compactly (factoring out common parts)
1077
1078 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1079
1080=back
1081
1082X<menuBarSummary>
1083
1084=head2 Command Summary
1085
1086A short summary of the most I<common> commands:
1087
1088=over 4
1089
1090=item [menu:name]
1091
1092use an existing named menuBar or start a new one
1093
1094=item [menu]
1095
1096use the current menuBar
1097
1098=item [title:string]
1099
1100set menuBar title
1101
1102=item [done]
1103
1104set menu access to readonly and, if reading from a file, signal EOF
1105
1106=item [done:name]
1107
1108if reading from a file using [read:file;name] signal EOF
1109
1110=item [rm:name]
1111
1112remove named menuBar(s)
1113
1114=item [rm] [rm:]
1115
1116remove current menuBar
1117
1118=item [rm*] [rm:*]
1119
1120remove all menuBar(s)
1121
1122=item [swap]
1123
1124swap top two menuBars
1125
1126=item [prev]
1127
1128access the previous menuBar
1129
1130=item [next]
1131
1132access the next menuBar
1133
1134=item [show]
1135
1136map menuBar
1137
1138=item [hide]
1139
1140unmap menuBar
1141
1142=item [pixmap;file]
1143
1144=item [pixmap;file;scaling]
1145
1146set a background pixmap
1147
1148=item [read:file]
1149
1150=item [read:file;name]
1151
1152read in a menu from a file
1153
1154=item [dump]
1155
1156dump out all menuBars to /tmp/rxvt-PID
1157
1158=item /
1159
1160access menuBar top level
1161
1162=item ./
1163
1164=item ../
1165
1166=item ../../
1167
1168access current or parent menu level
1169
1170=item /path/menu
1171
1172add/access menu
1173
1174=item /path/{-}
1175
1176add separator
1177
1178=item /path/{item}{rtext} action
1179
1180add/alter menu item
1181
1182=item -/*
1183
1184remove all menus from the menuBar
1185
1186=item -/path/menu
1187
1188remove menu items, separators and submenus from menu
1189
1190=item -/path/menu
1191
1192remove menu
1193
1194=item -/path/{item}
1195
1196remove item
1197
1198=item -/path/{-}
1199
1200remove separator
1201
1202=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1203
1204menu quick arrows
1205
1206=back
1207X<XPM>
1208 2011
1209=head1 XPM 2012=head1 XPM
1210 2013
1211For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2014For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1212of B<< C<Pt> >> can be the name of the background pixmap followed by a 2015of B<< C<Pt> >> can be the name of the background pixmap followed by a
1310=begin table 2113=begin table
1311 2114
1312 4 Shift 2115 4 Shift
1313 8 Meta 2116 8 Meta
1314 16 Control 2117 16 Control
1315 32 Double Click I<(Rxvt extension)> 2118 32 Double Click I<(rxvt extension)>
1316 2119
1317=end table 2120=end table
1318 2121
1319Col = B<< C<< <x> - SPACE >> >> 2122Col = B<< C<< <x> - SPACE >> >>
1320 2123
1321Row = B<< C<< <y> - SPACE >> >> 2124Row = B<< C<< <y> - SPACE >> >>
1322 2125
1323=back 2126=back
1324X<KeyCodes> 2127X<KeyCodes>
1325
1326=head1 ISO 14755 support
1327
1328Partial ISO 14755-support is implemented. that means that pressing
1329
1330section 5.1: Control and Shift together enters unicode input
1331mode. Entering hex digits composes a Unicode character, pressing space or
1332releasing the modifiers commits the keycode and every other key cancels
1333the current input character.
1334
1335section 5.2: Pressing and immediately releasing Control and Shift together
1336enters keycap entry mode for the next key: pressing a function key (tab,
1337return etc..) will enter the unicode character corresponding to the given
1338key.
1339 2128
1340=head1 Key Codes 2129=head1 Key Codes
1341 2130
1342Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 2131Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
1343 2132
1408 XK_KP_8 8 ESC O x 2197 XK_KP_8 8 ESC O x
1409 XK_KP_9 9 ESC O y 2198 XK_KP_9 9 ESC O y
1410 2199
1411=end table 2200=end table
1412 2201
2202=head1 CONFIGURE OPTIONS
2203
2204General hint: if you get compile errors, then likely your configuration
2205hasn't been tested well. Either try with C<--enable-everything> or use
2206the default configuration (i.e. C<--enable-xxx> or C<--disable-xxx>). Of
2207course, you should always report when a combination doesn't work, so it
2208can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2209
2210All
2211
2212=over 4
2213
2214=item --enable-everything
2215
2216Add (or remove) support for all non-multichoice options listed in "./configure
2217--help".
2218
2219You can specify this and then disable options you do not like by
2220I<following> this with the appropriate C<--disable-...> arguments,
2221or you can start with a minimal configuration by specifying
2222C<--disable-everything> and than adding just the C<--enable-...> arguments
2223you want.
2224
2225=item --enable-xft (default: enabled)
2226
2227Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2228slower and require lots of memory, but as long as you don't use them, you
2229don't pay for them.
2230
2231=item --enable-font-styles (default: on)
2232
2233Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2234styles. The fonts can be set manually or automatically.
2235
2236=item --with-codesets=NAME,... (default: all)
2237
2238Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2239are always compiled in, which includes most 8-bit character sets). These
2240codeset tables are used for driving X11 core fonts, they are not required
2241for Xft fonts, although having them compiled in lets rxvt-unicode choose
2242replacement fonts more intelligently. Compiling them in will make your
2243binary bigger (all of together cost about 700kB), but it doesn't increase
2244memory usage unless you use a font requiring one of these encodings.
2245
2246=begin table
2247
2248 all all available codeset groups
2249 zh common chinese encodings
2250 zh_ext rarely used but very big chinese encodings
2251 jp common japanese encodings
2252 jp_ext rarely used but big japanese encodings
2253 kr korean encodings
2254
2255=end table
2256
2257=item --enable-xim (default: on)
2258
2259Add support for XIM (X Input Method) protocol. This allows using
2260alternative input methods (e.g. kinput2) and will also correctly
2261set up the input for people using dead keys or compose keys.
2262
2263=item --enable-unicode3 (default: off)
2264
2265Recommended to stay off unless you really need non-BMP characters.
2266
2267Enable direct support for displaying unicode codepoints above
226865535 (the basic multilingual page). This increases storage
2269requirements per character from 2 to 4 bytes. X11 fonts do not yet
2270support these extra characters, but Xft does.
2271
2272Please note that rxvt-unicode can store unicode code points >65535
2273even without this flag, but the number of such characters is
2274limited to a few thousand (shared with combining characters,
2275see next switch), and right now rxvt-unicode cannot display them
2276(input/output and cut&paste still work, though).
2277
2278=item --enable-combining (default: on)
2279
2280Enable automatic composition of combining characters into
2281composite characters. This is required for proper viewing of text
2282where accents are encoded as seperate unicode characters. This is
2283done by using precomposited characters when available or creating
2284new pseudo-characters when no precomposed form exists.
2285
2286Without --enable-unicode3, the number of additional precomposed
2287characters is somewhat limited (the 6400 private use characters will be
2288(ab-)used). With --enable-unicode3, no practical limit exists.
2289
2290This option will also enable storage (but not display) of characters
2291beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2292
2293The combining table also contains entries for arabic presentation forms,
2294but these are not currently used. Bug me if you want these to be used (and
2295tell me how these are to be used...).
2296
2297=item --enable-fallback(=CLASS) (default: Rxvt)
2298
2299When reading resource settings, also read settings for class CLASS. To
2300disable resource fallback use --disable-fallback.
2301
2302=item --with-res-name=NAME (default: urxvt)
2303
2304Use the given name as default application name when
2305reading resources. Specify --with-res-name=rxvt to replace rxvt.
2306
2307=item --with-res-class=CLASS /default: URxvt)
2308
2309Use the given class as default application class
2310when reading resources. Specify --with-res-class=Rxvt to replace
2311rxvt.
2312
2313=item --enable-utmp (default: on)
2314
2315Write user and tty to utmp file (used by programs like F<w>) at
2316start of rxvt execution and delete information when rxvt exits.
2317
2318=item --enable-wtmp (default: on)
2319
2320Write user and tty to wtmp file (used by programs like F<last>) at
2321start of rxvt execution and write logout when rxvt exits. This
2322option requires --enable-utmp to also be specified.
2323
2324=item --enable-lastlog (default: on)
2325
2326Write user and tty to lastlog file (used by programs like
2327F<lastlogin>) at start of rxvt execution. This option requires
2328--enable-utmp to also be specified.
2329
2330=item --enable-afterimage (default: on)
2331
2332Add support for libAfterImage to be used for transparency and background
2333images. It adds support for many file formats including JPG, PNG,
2334SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2335(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2336
2337This option also adds such eye candy as blending an image over the root
2338background, as well as dynamic scaling and bluring of background images.
2339
2340Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2341increase by a few megabytes even if no extra features are used (mostly due
2342to third-party libraries used by libAI). Memory footprint may somewhat be
2343lowered if libAfterImage is configured without support for SVG.
2344
2345=item --enable-transparency (default: on)
2346
2347Add support for inheriting parent backgrounds thus giving a fake
2348transparency to the term.
2349
2350=item --enable-fading (default: on)
2351
2352Add support for fading the text when focus is lost.
2353
2354=item --enable-tinting (default: on)
2355
2356Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2357
2358=item --enable-rxvt-scroll (default: on)
2359
2360Add support for the original rxvt scrollbar.
2361
2362=item --enable-next-scroll (default: on)
2363
2364Add support for a NeXT-like scrollbar.
2365
2366=item --enable-xterm-scroll (default: on)
2367
2368Add support for an Xterm-like scrollbar.
2369
2370=item --enable-plain-scroll (default: on)
2371
2372Add support for a very unobtrusive, plain-looking scrollbar that
2373is the favourite of the rxvt-unicode author, having used it for
2374many years.
2375
2376=item --enable-ttygid (default: off)
2377
2378Change tty device setting to group "tty" - only use this if
2379your system uses this type of security.
2380
2381=item --disable-backspace-key
2382
2383Removes any handling of the backspace key by us - let the X server do it.
2384
2385=item --disable-delete-key
2386
2387Removes any handling of the delete key by us - let the X server
2388do it.
2389
2390=item --disable-resources
2391
2392Removes any support for resource checking.
2393
2394=item --disable-swapscreen
2395
2396Remove support for secondary/swap screen.
2397
2398=item --enable-frills (default: on)
2399
2400Add support for many small features that are not essential but nice to
2401have. Normally you want this, but for very small binaries you may want to
2402disable this.
2403
2404A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2405in combination with other switches) is:
2406
2407 MWM-hints
2408 EWMH-hints (pid, utf8 names) and protocols (ping)
2409 urgency hint
2410 seperate underline colour (-underlineColor)
2411 settable border widths and borderless switch (-w, -b, -bl)
2412 visual depth selection (-depth)
2413 settable extra linespacing /-lsp)
2414 iso-14755 5.1 (basic) support
2415 tripleclickwords (-tcw)
2416 settable insecure mode (-insecure)
2417 keysym remapping support
2418 cursor blinking and underline cursor (-cb, -uc)
2419 XEmbed support (-embed)
2420 user-pty (-pty-fd)
2421 hold on exit (-hold)
2422 skip builtin block graphics (-sbg)
2423 separate highlightcolor support (-hc)
2424
2425It also enables some non-essential features otherwise disabled, such as:
2426
2427 some round-trip time optimisations
2428 nearest color allocation on pseudocolor screens
2429 UTF8_STRING support for selection
2430 sgr modes 90..97 and 100..107
2431 backindex and forwardindex escape sequences
2432 view change/zero scrollback escape sequences
2433 locale switching escape sequence
2434 window op and some xterm/OSC escape sequences
2435 rectangular selections
2436 trailing space removal for selections
2437 verbose X error handling
2438
2439=item --enable-iso14755 (default: on)
2440
2441Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2442F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2443C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2444this switch.
2445
2446=item --enable-keepscrolling (default: on)
2447
2448Add support for continual scrolling of the display when you hold
2449the mouse button down on a scrollbar arrow.
2450
2451=item --enable-selectionscrolling (default: on)
2452
2453Add support for scrolling when the selection moves to the top or
2454bottom of the screen.
2455
2456=item --enable-mousewheel (default: on)
2457
2458Add support for scrolling via mouse wheel or buttons 4 & 5.
2459
2460=item --enable-slipwheeling (default: on)
2461
2462Add support for continual scrolling (using the mouse wheel as an
2463accelerator) while the control key is held down. This option
2464requires --enable-mousewheel to also be specified.
2465
2466=item --enable-smart-resize (default: off)
2467
2468Add smart growth/shrink behaviour when resizing.
2469This should keep the window corner which is closest to a corner of
2470the screen in a fixed position.
2471
2472=item --enable-pointer-blank (default: on)
2473
2474Add support to have the pointer disappear when typing or inactive.
2475
2476=item --enable-perl (default: on)
2477
2478Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2479manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the
2480files in F<src/perl-ext/> for the extensions that are installed by
2481default. The perl interpreter that is used can be specified via the
2482C<PERL> environment variable when running configure. Even when compiled
2483in, perl will I<not> be initialised when all extensions have been disabled
2484C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2485resource standpoint.
2486
2487=item --with-afterimage-config=DIR
2488
2489Look for the libAfterImage config script in DIR.
2490
2491=item --with-name=NAME (default: urxvt)
2492
2493Set the basename for the installed binaries, resulting
2494in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2495C<rxvt>.
2496
2497=item --with-term=NAME (default: rxvt-unicode)
2498
2499Change the environmental variable for the terminal to NAME.
2500
2501=item --with-terminfo=PATH
2502
2503Change the environmental variable for the path to the terminfo tree to
2504PATH.
2505
2506=item --with-x
2507
2508Use the X Window System (pretty much default, eh?).
2509
2510=back
2511
2512=head1 AUTHORS
2513
2514Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
2515reworked it from the original Rxvt documentation, which was done by Geoff
2516Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other
2517sources.
2518

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines