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.12 by root, Mon Aug 16 00:17:27 2004 UTC vs.
Revision 1.155 by ayin, Sun Dec 9 12:15:39 2007 UTC

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

Diff Legend

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