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.102 by root, Tue Jan 31 20:50:48 2006 UTC

1=head1 NAME
2
3RXVT REFERENCE - FAQ, command sequences and other background information
4
5=head1 SYNOPSIS
6
7 # set a new font set
8 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
9
10 # change the locale and tell rxvt-unicode about it
11 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
12
13 # set window title
14 printf '\33]2;%s\007' "new window title"
15
16=head1 DESCRIPTION
17
18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19all escape sequences, and other background information.
20
21The newest version of this document is also available on the World Wide Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
23
24=head1 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 @@RXVT_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 @@RXVT_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 @@RXVT_NAME@@d in a race-free way?
74
75Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
76display, create the listening socket and then fork.
77
78=head3 How do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
79
80rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
81check and see if that is set. Note that several programs, JED, slrn,
82Midnight Commander automatically check this variable to decide whether or
83not to use color.
84
85=head3 How do I set the correct, full IP address for the DISPLAY variable?
86
87If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
88insecure mode then it is possible to use the following shell script
89snippets to correctly set the display. If your version of rxvt-unicode
90wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
91the COLORTERM variable can be used to distinguish rxvt-unicode from a
92regular xterm.
93
94Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
95snippets:
96
97 # Bourne/Korn/POSIX family of shells:
98 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
99 if [ ${TERM:-foo} = xterm ]; then
100 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
101 echo -n '^[Z'
102 read term_id
103 stty icanon echo
104 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
105 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
106 read DISPLAY # set it in our local shell
107 fi
108 fi
109
110=head3 How do I compile the manual pages on my own?
111
112You need to have a recent version of perl installed as F</usr/bin/perl>,
113one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
114the doc subdirectory and enter C<make alldoc>.
115
116=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
117
118I often get asked about this, and I think, no, they didn't cause extra
119bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
120that the urxvt binary is larger (due to some encoding tables always being
121compiled in), but it actually uses less memory (RSS) after startup. Even
122with C<--disable-everything>, this comparison is a bit unfair, as many
123features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
124already in use in this mode.
125
126 text data bss drs rss filename
127 98398 1664 24 15695 1824 rxvt --disable-everything
128 188985 9048 66616 18222 1788 urxvt --disable-everything
129
130When you C<--enable-everything> (which _is_ unfair, as this involves xft
131and full locale/XIM support which are quite bloaty inside libX11 and my
132libc), the two diverge, but not unreasnobaly so.
133
134 text data bss drs rss filename
135 163431 2152 24 20123 2060 rxvt --enable-everything
136 1035683 49680 66648 29096 3680 urxvt --enable-everything
137
138The very large size of the text section is explained by the east-asian
139encoding tables, which, if unused, take up disk space but nothing else
140and can be compiled out unless you rely on X11 core fonts that use those
141encodings. The BSS size comes from the 64k emergency buffer that my c++
142compiler allocates (but of course doesn't use unless you are out of
143memory). Also, using an xft font instead of a core font immediately adds a
144few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
145not used.
146
147Of course, due to every character using two or four bytes instead of one,
148a large scrollback buffer will ultimately make rxvt-unicode use more
149memory.
150
151Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
152still fares rather well. And compared to some monsters like gnome-terminal
153(21152k + extra 4204k in separate processes) or konsole (22200k + extra
15443180k in daemons that stay around after exit, plus half a minute of
155startup time, including the hundreds of warnings it spits out), it fares
156extremely well *g*.
157
158=head3 Why C++, isn't that unportable/bloated/uncool?
159
160Is this a question? :) It comes up very often. The simple answer is: I had
161to write it, and C++ allowed me to write and maintain it in a fraction
162of the time and effort (which is a scarce resource for me). Put even
163shorter: It simply wouldn't exist without C++.
164
165My personal stance on this is that C++ is less portable than C, but in
166the case of rxvt-unicode this hardly matters, as its portability limits
167are defined by things like X11, pseudo terminals, locale support and unix
168domain sockets, which are all less portable than C++ itself.
169
170Regarding the bloat, see the above question: It's easy to write programs
171in C that use gobs of memory, an certainly possible to write programs in
172C++ that don't. C++ also often comes with large libraries, but this is
173not necessarily the case with GCC. Here is what rxvt links against on my
174system with a minimal config:
175
176 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
177 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
178 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
179 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
180
181And here is rxvt-unicode:
182
183 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
184 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
185 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
186 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
187 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
188
189No large bloated libraries (of course, none were linked in statically),
190except maybe libX11 :)
191
192
193=head2 Rendering, Font & Look and Feel Issues
194
195=head3 I can't get transparency working, what am I doing wrong?
196
197First of all, transparency isn't officially supported in rxvt-unicode, so
198you are mostly on your own. Do not bug the author about it (but you may
199bug everybody else). Also, if you can't get it working consider it a rite
200of passage: ... and you failed.
201
202Here are four ways to get transparency. B<Do> read the manpage and option
203descriptions for the programs mentioned and rxvt-unicode. Really, do it!
204
2051. Use inheritPixmap:
206
207 Esetroot wallpaper.jpg
208 @@RXVT_NAME@@ -ip -tint red -sh 40
209
210That works. If you think it doesn't, you lack transparency and tinting
211support, or you are unable to read.
212
2132. Use a simple pixmap and emulate pseudo-transparency. This enables you
214to use effects other than tinting and shading: Just shade/tint/whatever
215your picture with gimp or any other tool:
216
217 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
218 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
219
220That works. If you think it doesn't, you lack XPM and Perl support, or you
221are unable to read.
222
2233. Use an ARGB visual:
224
225 @@RXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
226
227This requires XFT support, and the support of your X-server. If that
228doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
229there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
230bugfixes and workarounds for Xft and Xlib to make it work, but that
231doesn't mean that your WM has the required kludges in place.
232
2334. Use xcompmgr and let it do the job:
234
235 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
236 -set _NET_WM_WINDOW_OPACITY 0xc0000000
237
238Then click on a window you want to make transparent. Replace C<0xc0000000>
239by other values to change the degree of opacity. If it doesn't work and
240your server crashes, you got to keep the pieces.
241
242=head3 Why do some chinese characters look so different than others?
243
244This is because there is a difference between script and language --
245rxvt-unicode does not know which language the text that is output is,
246as it only knows the unicode character codes. If rxvt-unicode first
247sees a japanese/chinese character, it might choose a japanese font for
248display. Subsequent japanese characters will use that font. Now, many
249chinese characters aren't represented in japanese fonts, so when the first
250non-japanese character comes up, rxvt-unicode will look for a chinese font
251-- unfortunately at this point, it will still use the japanese font for
252chinese characters that are also in the japanese font.
253
254The workaround is easy: just tag a chinese font at the end of your font
255list (see the previous question). The key is to view the font list as
256a preference list: If you expect more japanese, list a japanese font
257first. If you expect more chinese, put a chinese font first.
258
259In the future it might be possible to switch language preferences at
260runtime (the internal data structure has no problem with using different
261fonts for the same character at the same time, but no interface for this
262has been designed yet).
263
264Until then, you might get away with switching fonts at runtime (see L<Can
265I switch the fonts at runtime?> later in this document).
266
267=head3 Why does rxvt-unicode sometimes leave pixel droppings?
268
269Most fonts were not designed for terminal use, which means that character
270size varies a lot. A font that is otherwise fine for terminal use might
271contain some characters that are simply too wide. Rxvt-unicode will avoid
272these characters. For characters that are just "a bit" too wide a special
273"careful" rendering mode is used that redraws adjacent characters.
274
275All of this requires that fonts do not lie about character sizes,
276however: Xft fonts often draw glyphs larger than their acclaimed bounding
277box, and rxvt-unicode has no way of detecting this (the correct way is to
278ask for the character bounding box, which unfortunately is wrong in these
279cases).
280
281It's not clear (to me at least), wether this is a bug in Xft, freetype,
282or the respective font. If you encounter this problem you might try using
283the C<-lsp> option to give the font more height. If that doesn't work, you
284might be forced to use a different font.
285
286All of this is not a problem when using X11 core fonts, as their bounding
287box data is correct.
288
289=head3 How can I keep rxvt-unicode from using reverse video so much?
290
291First of all, make sure you are running with the right terminal settings
292(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
293make sure you have specified colours for italic and bold, as otherwise
294rxvt-unicode might use reverse video to simulate the effect:
295
296 URxvt.colorBD: white
297 URxvt.colorIT: green
298
299=head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
300
301For some unexplainable reason, some rare programs assume a very weird
302colour palette when confronted with a terminal with more than the standard
3038 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
304these programs not to assume non-ISO colours without very good reasons.
305
306In the meantime, you can either edit your C<rxvt-unicode> terminfo
307definition to only claim 8 colour support or use C<TERM=rxvt>, which will
308fix colours but keep you from using other rxvt-unicode features.
309
310=head3 Can I switch the fonts at runtime?
311
312Yes, using an escape sequence. Try something like this, which has the same
313effect as using the C<-fn> switch, and takes effect immediately:
314
315 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
316
317This is useful if you e.g. work primarily with japanese (and prefer a
318japanese font), but you have to switch to chinese temporarily, where
319japanese fonts would only be in your way.
320
321You can think of this as a kind of manual ISO-2022 switching.
322
323=head3 Why do italic characters look as if clipped?
324
325Many fonts have difficulties with italic characters and hinting. For
326example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
327Mono> completely fails in it's italic face. A workaround might be to
328enable freetype autohinting, i.e. like this:
329
330 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
331 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
332
333=head3 Can I speed up Xft rendering somehow?
334
335Yes, the most obvious way to speed it up is to avoid Xft entirely, as
336it is simply slow. If you still want Xft fonts you might try to disable
337antialiasing (by appending C<:antialias=false>), which saves lots of
338memory and also speeds up rendering considerably.
339
340=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
341
342Rxvt-unicode will use whatever you specify as a font. If it needs to
343fall back to it's default font search list it will prefer X11 core
344fonts, because they are small and fast, and then use Xft fonts. It has
345antialiasing disabled for most of them, because the author thinks they
346look best that way.
347
348If you want antialiasing, you have to specify the fonts manually.
349
350=head3 What's with this bold/blink stuff?
351
352If no bold colour is set via C<colorBD:>, bold will invert text using the
353standard foreground colour.
354
355For the standard background colour, blinking will actually make the
356text blink when compiled with C<--enable-blinking>. with standard
357colours. Without C<--enable-blinking>, the blink attribute will be
358ignored.
359
360On ANSI colours, bold/blink attributes are used to set high-intensity
361foreground/background colors.
362
363color0-7 are the low-intensity colors.
364
365color8-15 are the corresponding high-intensity colors.
366
367=head3 I don't like the screen colors. How do I change them?
368
369You can change the screen colors at run-time using F<~/.Xdefaults>
370resources (or as long-options).
371
372Here are values that are supposed to resemble a VGA screen,
373including the murky brown that passes for low-intensity yellow:
374
375 URxvt.color0: #000000
376 URxvt.color1: #A80000
377 URxvt.color2: #00A800
378 URxvt.color3: #A8A800
379 URxvt.color4: #0000A8
380 URxvt.color5: #A800A8
381 URxvt.color6: #00A8A8
382 URxvt.color7: #A8A8A8
383
384 URxvt.color8: #000054
385 URxvt.color9: #FF0054
386 URxvt.color10: #00FF54
387 URxvt.color11: #FFFF54
388 URxvt.color12: #0000FF
389 URxvt.color13: #FF00FF
390 URxvt.color14: #00FFFF
391 URxvt.color15: #FFFFFF
392
393And here is a more complete set of non-standard colors described (not by
394me) as "pretty girly".
395
396 URxvt.cursorColor: #dc74d1
397 URxvt.pointerColor: #dc74d1
398 URxvt.background: #0e0e0e
399 URxvt.foreground: #4ad5e1
400 URxvt.color0: #000000
401 URxvt.color8: #8b8f93
402 URxvt.color1: #dc74d1
403 URxvt.color9: #dc74d1
404 URxvt.color2: #0eb8c7
405 URxvt.color10: #0eb8c7
406 URxvt.color3: #dfe37e
407 URxvt.color11: #dfe37e
408 URxvt.color5: #9e88f0
409 URxvt.color13: #9e88f0
410 URxvt.color6: #73f7ff
411 URxvt.color14: #73f7ff
412 URxvt.color7: #e1dddd
413 URxvt.color15: #e1dddd
414
415=head3 Why do some characters look so much different than others?
416
417See next entry.
418
419=head3 How does rxvt-unicode choose fonts?
420
421Most fonts do not contain the full range of Unicode, which is
422fine. Chances are that the font you (or the admin/package maintainer of
423your system/os) have specified does not cover all the characters you want
424to display.
425
426B<rxvt-unicode> makes a best-effort try at finding a replacement
427font. Often the result is fine, but sometimes the chosen font looks
428bad/ugly/wrong. Some fonts have totally strange characters that don't
429resemble the correct glyph at all, and rxvt-unicode lacks the artificial
430intelligence to detect that a specific glyph is wrong: it has to believe
431the font that the characters it claims to contain indeed look correct.
432
433In that case, select a font of your taste and add it to the font list,
434e.g.:
435
436 @@RXVT_NAME@@ -fn basefont,font2,font3...
437
438When rxvt-unicode sees a character, it will first look at the base
439font. If the base font does not contain the character, it will go to the
440next font, and so on. Specifying your own fonts will also speed up this
441search and use less resources within rxvt-unicode and the X-server.
442
443The only limitation is that none of the fonts may be larger than the base
444font, as the base font defines the terminal character cell size, which
445must be the same due to the way terminals work.
446
447
448=head2 Keyboard, Mouse & User Interaction
449
450=head3 The new selection selects pieces that are too big, how can I select single words?
451
452If you want to select e.g. alphanumeric words, you can use the following
453setting:
454
455 URxvt.selection.pattern-0: ([[:word:]]+)
456
457If you click more than twice, the selection will be extended
458more and more.
459
460To get a selection that is very similar to the old code, try this pattern:
461
462 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
463
464Please also note that the I<LeftClick Shift-LeftClik> combination also
465selects words like the old code.
466
467=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
468
469You can disable the perl extension completely by setting the
470B<perl-ext-common> resource to the empty string, which also keeps
471rxvt-unicode from initialising perl, saving memory.
472
473If you only want to disable specific features, you first have to
474identify which perl extension is responsible. For this, read the section
475B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For
476example, to disable the B<selection-popup> and B<option-popup>, specify
477this B<perl-ext-common> resource:
478
479 URxvt.perl-ext-common: default,-selection-popup,-option-popup
480
481This will keep the default extensions, but disable the two popup
482extensions. Some extensions can also be configured, for example,
483scrollback search mode is triggered by B<M-s>. You can move it to any
484other combination either by setting the B<searchable-scrollback> resource:
485
486 URxvt.searchable-scrollback: CM-s
487
488=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
489
490See next entry.
491
492=head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
493
494These are caused by the C<readline> perl extension. Under normal
495circumstances, it will move your cursor around when you click into the
496line that contains it. It tries hard not to do this at the wrong moment,
497but when running a program that doesn't parse cursor movements or in some
498cases during rlogin sessions, it fails to detect this properly.
499
500You can permamently switch this feature off by disabling the C<readline>
501extension:
502
503 URxvt.perl-ext-common: default,-readline
504
505=head3 My numerical keypad acts weird and generates differing output?
506
507Some Debian GNUL/Linux users seem to have this problem, although no
508specific details were reported so far. It is possible that this is caused
509by the wrong C<TERM> setting, although the details of wether and how
510this can happen are unknown, as C<TERM=rxvt> should offer a compatible
511keymap. See the answer to the previous question, and please report if that
512helped.
513
514=head3 My Compose (Multi_key) key is no longer working.
515
516The most common causes for this are that either your locale is not set
517correctly, or you specified a B<preeditStyle> that is not supported by
518your input method. For example, if you specified B<OverTheSpot> and
519your input method (e.g. the default input method handling Compose keys)
520does not support this (for instance because it is not visual), then
521rxvt-unicode will continue without an input method.
522
523In this case either do not specify a B<preeditStyle> or specify more than
524one pre-edit style, such as B<OverTheSpot,Root,None>.
525
526=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
527
528Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
529international keyboards) or simply use ISO 14755 support to your
530advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
531codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
532character and so on.
533
534=head3 Mouse cut/paste suddenly no longer works.
535
536Make sure that mouse reporting is actually turned off since killing
537some editors prematurely may leave the mouse in mouse report mode. I've
538heard that tcsh may use mouse reporting unless it otherwise specified. A
539quick check is to see if cut/paste works when the Alt or Shift keys are
540depressed.
541
542=head3 What's with the strange Backspace/Delete key behaviour?
543
544Assuming that the physical Backspace key corresponds to the
545BackSpace keysym (not likely for Linux ... see the following
546question) there are two standard values that can be used for
547Backspace: C<^H> and C<^?>.
548
549Historically, either value is correct, but rxvt-unicode adopts the debian
550policy of using C<^?> when unsure, because it's the one only only correct
551choice :).
552
553Rxvt-unicode tries to inherit the current stty settings and uses the value
554of `erase' to guess the value for backspace. If rxvt-unicode wasn't
555started from a terminal (say, from a menu or by remote shell), then the
556system value of `erase', which corresponds to CERASE in <termios.h>, will
557be used (which may not be the same as your stty setting).
558
559For starting a new rxvt-unicode:
560
561 # use Backspace = ^H
562 $ stty erase ^H
563 $ @@RXVT_NAME@@
564
565 # use Backspace = ^?
566 $ stty erase ^?
567 $ @@RXVT_NAME@@
568
569Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
570
571For an existing rxvt-unicode:
572
573 # use Backspace = ^H
574 $ stty erase ^H
575 $ echo -n "^[[36h"
576
577 # use Backspace = ^?
578 $ stty erase ^?
579 $ echo -n "^[[36l"
580
581This helps satisfy some of the Backspace discrepancies that occur, but
582if you use Backspace = C<^H>, make sure that the termcap/terminfo value
583properly reflects that.
584
585The Delete key is a another casualty of the ill-defined Backspace problem.
586To avoid confusion between the Backspace and Delete keys, the Delete
587key has been assigned an escape sequence to match the vt100 for Execute
588(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
589
590Some other Backspace problems:
591
592some editors use termcap/terminfo,
593some editors (vim I'm told) expect Backspace = ^H,
594GNU Emacs (and Emacs-like editors) use ^H for help.
595
596Perhaps someday this will all be resolved in a consistent manner.
597
598=head3 I don't like the key-bindings. How do I change them?
599
600There are some compile-time selections available via configure. Unless
601you have run "configure" with the C<--disable-resources> option you can
602use the `keysym' resource to alter the keystrings associated with keysyms.
603
604Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
605
606 URxvt.keysym.Home: \033[1~
607 URxvt.keysym.End: \033[4~
608 URxvt.keysym.C-apostrophe: \033<C-'>
609 URxvt.keysym.C-slash: \033<C-/>
610 URxvt.keysym.C-semicolon: \033<C-;>
611 URxvt.keysym.C-grave: \033<C-`>
612 URxvt.keysym.C-comma: \033<C-,>
613 URxvt.keysym.C-period: \033<C-.>
614 URxvt.keysym.C-0x60: \033<C-`>
615 URxvt.keysym.C-Tab: \033<C-Tab>
616 URxvt.keysym.C-Return: \033<C-Return>
617 URxvt.keysym.S-Return: \033<S-Return>
618 URxvt.keysym.S-space: \033<S-Space>
619 URxvt.keysym.M-Up: \033<M-Up>
620 URxvt.keysym.M-Down: \033<M-Down>
621 URxvt.keysym.M-Left: \033<M-Left>
622 URxvt.keysym.M-Right: \033<M-Right>
623 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
624 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
625 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
626
627See some more examples in the documentation for the B<keysym> resource.
628
629=head3 I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map
630
631 KP_Insert == Insert
632 F22 == Print
633 F27 == Home
634 F29 == Prior
635 F33 == End
636 F35 == Next
637
638Rather than have rxvt-unicode try to accommodate all the various possible
639keyboard mappings, it is better to use `xmodmap' to remap the keys as
640required for your particular machine.
641
642
643
644=head2 Terminal Configuration
645
646=head3 Why doesn't rxvt-unicode read my resources?
647
648Well, why, indeed? It does, in a way very similar to other X
649applications. Most importantly, this means that if you or your OS loads
650resources into the X display (the right way to do it), rxvt-unicode will
651ignore any resource files in your home directory. It will only read
652F<$HOME/.Xdefaults> when no resources are attached to the display.
653
654If you have or use an F<$HOME/.Xresources> file, chances are that
655resources are loaded into your X-server. In this case, you have to
656re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
657
658Also consider the form resources have to use:
659
660 URxvt.resource: value
661
662If you want to use another form (there are lots of different ways of
663specifying resources), make sure you understand wether and why it
664works. If unsure, use the form above.
665
666=head3 When I log-in to another system it tells me about missing terminfo data?
667
668The terminal description used by rxvt-unicode is not as widely available
669as that for xterm, or even rxvt (for which the same problem often arises).
670
671The correct solution for this problem is to install the terminfo, this can
672be done like this (with ncurses' infocmp):
673
674 REMOTE=remotesystem.domain
675 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
676
677... or by installing rxvt-unicode normally on the remote system,
678
679If you cannot or do not want to do this, then you can simply set
680C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
681problems arising, which includes wrong keymapping, less and different
682colours and some refresh errors in fullscreen applications. It's a nice
683quick-and-dirty workaround for rare cases, though.
684
685If you always want to do this (and are fine with the consequences) you
686can either recompile rxvt-unicode with the desired TERM value or use a
687resource to set it:
688
689 URxvt.termName: rxvt
690
691If you don't plan to use B<rxvt> (quite common...) you could also replace
692the rxvt terminfo file with the rxvt-unicode one.
693
694=head3 C<tic> outputs some error when compiling the terminfo entry.
695
696Most likely it's the empty definition for C<enacs=>. Just replace it by
697C<enacs=\E[0@> and try again.
698
699=head3 C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
700
701See next entry.
702
703=head3 I need a termcap file entry.
704
705One reason you might want this is that some distributions or operating
706systems still compile some programs using the long-obsoleted termcap
707library (Fedora Core's bash is one example) and rely on a termcap entry
708for C<rxvt-unicode>.
709
710You could use rxvt's termcap entry with resonable results in many cases.
711You can also create a termcap entry by using terminfo's infocmp program
712like this:
713
714 infocmp -C rxvt-unicode
715
716Or you could use this termcap entry, generated by the command above:
717
718 rxvt-unicode|rxvt-unicode terminal (X Window System):\
719 :am:bw:eo:km:mi:ms:xn:xo:\
720 :co#80:it#8:li#24:lm#0:\
721 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
722 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
723 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
724 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
725 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
726 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
727 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
728 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
729 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
730 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
731 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
732 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
733 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
734 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
735 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
736 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
737 :vs=\E[?25h:
738
739=head3 Why does C<ls> no longer have coloured output?
740
741The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
742decide wether a terminal has colour, but uses it's own configuration
743file. Needless to say, C<rxvt-unicode> is not in it's default file (among
744with most other terminals supporting colour). Either add:
745
746 TERM rxvt-unicode
747
748to C</etc/DIR_COLORS> or simply add:
749
750 alias ls='ls --color=auto'
751
752to your C<.profile> or C<.bashrc>.
753
754=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
755
756See next entry.
757
758=head3 Why doesn't vim/emacs etc. make use of italic?
759
760See next entry.
761
762=head3 Why are the secondary screen-related options not working properly?
763
764Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
765distributions (most notably Debian GNU/Linux) break rxvt-unicode
766by setting C<TERM> to C<rxvt>, which doesn't have these extra
767features. Unfortunately, some of these (most notably, again, Debian
768GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
769file, so you will need to install it on your own (See the question B<When
770I log-in to another system it tells me about missing terminfo data?> on
771how to do this).
772
773
774=head2 Encoding / Locale / Input Method Issues
775
776=head3 Rxvt-unicode does not seem to understand the selected encoding?
777
778See next entry.
779
780=head3 Unicode does not seem to work?
781
782If you encounter strange problems like typing an accented character but
783getting two unrelated other characters or similar, or if program output is
784subtly garbled, then you should check your locale settings.
785
786Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
787programs. Often rxvt-unicode is started in the C<C> locale, while the
788login script running within the rxvt-unicode window changes the locale to
789something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
790
791The best thing is to fix your startup environment, as you will likely run
792into other problems. If nothing works you can try this in your .profile.
793
794 printf '\e]701;%s\007' "$LC_CTYPE"
795
796If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
797supported on your systems. Some systems have a C<locale> command which
798displays this (also, C<perl -e0> can be used to check locale settings, as
799it will complain loudly if it cannot set the locale). If it displays something
800like:
801
802 locale: Cannot set LC_CTYPE to default locale: ...
803
804Then the locale you specified is not supported on your system.
805
806If nothing works and you are sure that everything is set correctly then
807you will need to remember a little known fact: Some programs just don't
808support locales :(
809
810=head3 How does rxvt-unicode determine the encoding to use?
811
812See next entry.
813
814=head3 Is there an option to switch encodings?
815
816Unlike some other terminals, rxvt-unicode has no encoding switch, and no
817specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
818UTF-8 or any other encodings with respect to terminal I/O.
819
820The reasons is that there exists a perfectly fine mechanism for selecting
821the encoding, doing I/O and (most important) communicating this to all
822applications so everybody agrees on character properties such as width
823and code number. This mechanism is the I<locale>. Applications not using
824that info will have problems (for example, C<xterm> gets the width of
825characters wrong as it uses it's own, locale-independent table under all
826locales).
827
828Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
829programs doing the same (that is, most) will automatically agree in the
830interpretation of characters.
831
832Unfortunately, there is no system-independent way to select locales, nor
833is there a standard on how locale specifiers will look like.
834
835On most systems, the content of the C<LC_CTYPE> environment variable
836contains an arbitrary string which corresponds to an already-installed
837locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
838C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
839(i.e. C<de> or C<german>) are also common.
840
841Rxvt-unicode ignores all other locale categories, and except for
842the encoding, ignores country or language-specific settings,
843i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
844rxvt-unicode.
845
846If you want to use a specific encoding you have to make sure you start
847rxvt-unicode with the correct C<LC_CTYPE> category.
848
849=head3 Can I switch locales at runtime?
850
851Yes, using an escape sequence. Try something like this, which sets
852rxvt-unicode's idea of C<LC_CTYPE>.
853
854 printf '\e]701;%s\007' ja_JP.SJIS
855
856See also the previous answer.
857
858Sometimes this capability is rather handy when you want to work in
859one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
860(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
861first switches to a locale supported by xjdic and back later:
862
863 printf '\e]701;%s\007' ja_JP.SJIS
864 xjdic -js
865 printf '\e]701;%s\007' de_DE.UTF-8
866
867You can also use xterm's C<luit> program, which usually works fine, except
868for some locales where character width differs between program- and
869rxvt-unicode-locales.
870
871=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
872
873You can specify separate locales for the input method and the rest of the
874terminal, using the resource C<imlocale>:
875
876 URxvt.imlocale: ja_JP.EUC-JP
877
878Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
879use your input method. Please note, however, that you will not be able to
880input characters outside C<EUC-JP> in a normal way then, as your input
881method limits you.
882
883=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
884
885Unfortunately, this is unavoidable, as the XIM protocol is racy by
886design. Applications can avoid some crashes at the expense of memory
887leaks, and Input Methods can avoid some crashes by careful ordering at
888exit time. B<kinput2> (and derived input methods) generally succeeds,
889while B<SCIM> (or similar input methods) fails. In the end, however,
890crashes cannot be completely avoided even if both sides cooperate.
891
892So the only workaround is not to kill your Input Method Servers.
893
894
895=head2 Operating Systems / Package Maintaining
896
897=head3 I am using Debian GNU/Linux and have a problem...
898
899The Debian GNU/Linux package of rxvt-unicode in sarge contains large
900patches that considerably change the behaviour of rxvt-unicode (but
901unfortunately this notice has been removed). Before reporting a bug to
902the original rxvt-unicode author please download and install the genuine
903version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
904the problem. If you cannot, chances are that the problems are specific to
905Debian GNU/Linux, in which case it should be reported via the Debian Bug
906Tracking System (use C<reportbug> to report the bug).
907
908For other problems that also affect the Debian package, you can and
909probably should use the Debian BTS, too, because, after all, it's also a
910bug in the Debian version and it serves as a reminder for other users that
911might encounter the same issue.
912
913=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
914
915You should build one binary with the default options. F<configure>
916now enables most useful options, and the trend goes to making them
917runtime-switchable, too, so there is usually no drawback to enbaling them,
918except higher disk and possibly memory usage. The perl interpreter should
919be enabled, as important functionality (menus, selection, likely more in
920the future) depends on it.
921
922You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
923system-wide (except maybe with C<defaults>). This will result in useful
924behaviour. If your distribution aims at low memory, add an empty
925C<perl-ext-common> resource to the app-defaults file. This will keep the
926perl interpreter disabled until the user enables it.
927
928If you can/want build more binaries, I recommend building a minimal
929one with C<--disable-everything> (very useful) and a maximal one with
930C<--enable-everything> (less useful, it will be very big due to a lot of
931encodings built-in that increase download times and are rarely used).
932
933=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
934
935It should be, starting with release 7.1. You are encouraged to properly
936install urxvt with privileges necessary for your OS now.
937
938When rxvt-unicode detects that it runs setuid or setgid, it will fork
939into a helper process for privileged operations (pty handling on some
940systems, utmp/wtmp/lastlog handling on others) and drop privileges
941immediately. This is much safer than most other terminals that keep
942privileges while running (but is more relevant to urxvt, as it contains
943things as perl interpreters, which might be "helpful" to attackers).
944
945This forking is done as the very first within main(), which is very early
946and reduces possible bugs to initialisation code run before main(), or
947things like the dynamic loader of your system, which should result in very
948little risk.
949
950=head3 On Solaris 9, many line-drawing characters are too wide.
951
952Seems to be a known bug, read
953L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
954following ugly workaround to get non-double-wide-characters working:
955
956 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
957
958=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
959
960Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
961in your compile environment, or an implementation that implements it,
962wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
963B<wchar_t> is represented as unicode.
964
965As you might have guessed, FreeBSD does neither define this symobl nor
966does it support it. Instead, it uses it's own internal representation of
967B<wchar_t>. This is, of course, completely fine with respect to standards.
968
969However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
970C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
971
972C<__STDC_ISO_10646__> is the only sane way to support multi-language
973apps in an OS, as using a locale-dependent (and non-standardized)
974representation of B<wchar_t> makes it impossible to convert between
975B<wchar_t> (as used by X11 and your applications) and any other encoding
976without implementing OS-specific-wrappers for each and every locale. There
977simply are no APIs to convert B<wchar_t> into anything except the current
978locale encoding.
979
980Some applications (such as the formidable B<mlterm>) work around this
981by carrying their own replacement functions for character set handling
982with them, and either implementing OS-dependent hacks or doing multiple
983conversions (which is slow and unreliable in case the OS implements
984encodings slightly different than the terminal emulator).
985
986The rxvt-unicode author insists that the right way to fix this is in the
987system libraries once and for all, instead of forcing every app to carry
988complete replacements for them :)
989
990=head3 I use Solaris 9 and it doesn't compile/work/etc.
991
992Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
993problems with C<wcwidth> and a compile problem.
994
995=head3 How can I use rxvt-unicode under cygwin?
996
997rxvt-unicode should compile and run out of the box on cygwin, using
998the X11 libraries that come with cygwin. libW11 emulation is no
999longer supported (and makes no sense, either, as it only supported a
1000single font). I recommend starting the X-server in C<-multiwindow> or
1001C<-rootless> mode instead, which will result in similar look&feel as the
1002old libW11 emulation.
1003
1004At the time of this writing, cygwin didn't seem to support any multi-byte
1005encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1006to 8-bit encodings.
1007
1=head1 RXVT TECHNICAL REFERENCE 1008=head1 RXVT TECHNICAL REFERENCE
1009
1010=head1 DESCRIPTION
1011
1012The rest of this document describes various technical aspects of
1013B<rxvt-unicode>. First the description of supported command sequences,
1014followed by pixmap support and last by a description of all features
1015selectable at C<configure> time.
2 1016
3=head1 Definitions 1017=head1 Definitions
4 1018
5=over 4 1019=over 4
6 1020
135Single Shift Select of G3 Character Set (SS3): affects next character 1149Single Shift Select of G3 Character Set (SS3): affects next character
136only I<unimplemented> 1150only I<unimplemented>
137 1151
138=item B<< C<ESC Z> >> 1152=item B<< C<ESC Z> >>
139 1153
140Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option> 1154Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
141 1155
142=item B<< C<ESC c> >> 1156=item B<< C<ESC c> >>
143 1157
144Full reset (RIS) 1158Full reset (RIS)
145 1159
149 1163
150=item B<< C<ESC o> >> 1164=item B<< C<ESC o> >>
151 1165
152Invoke the G3 Character Set (LS3) 1166Invoke the G3 Character Set (LS3)
153 1167
154=item B<< C<ESC>(C<C> >> 1168=item B<< C<ESC ( C> >>
155 1169
156Designate G0 Character Set (ISO 2022), see below for values of C<C>. 1170Designate G0 Character Set (ISO 2022), see below for values of C<C>.
157 1171
158=item B<< C<ESC>)C<C> >> 1172=item B<< C<ESC ) C> >>
159 1173
160Designate G1 Character Set (ISO 2022), see below for values of C<C>. 1174Designate G1 Character Set (ISO 2022), see below for values of C<C>.
161 1175
162=item B<< C<ESC * C> >> 1176=item B<< C<ESC * C> >>
163 1177
304 1318
305=item B<< C<ESC [ Ps c> >> 1319=item B<< C<ESC [ Ps c> >>
306 1320
307Send Device Attributes (DA) 1321Send Device Attributes (DA)
308B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1322B<< C<Ps = 0> >> (or omitted): request attributes from terminal
309returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1323returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
310Option'') 1324Option'')
311 1325
312=item B<< C<ESC [ Ps d> >> 1326=item B<< C<ESC [ Ps d> >>
313 1327
314Cursor to Line B<< C<Ps> >> (VPA) 1328Cursor to Line B<< C<Ps> >> (VPA)
330 B<< C<Ps = 0> >> Clear Current Column (default) 1344 B<< C<Ps = 0> >> Clear Current Column (default)
331 B<< C<Ps = 3> >> Clear All (TBC) 1345 B<< C<Ps = 3> >> Clear All (TBC)
332 1346
333=end table 1347=end table
334 1348
1349=item B<< C<ESC [ Pm h> >>
1350
1351Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
1352
335=item B<< C<ESC [ Ps i> >> 1353=item B<< C<ESC [ Ps i> >>
336 1354
337Printing 1355Printing. See also the C<print-pipe> resource.
338 1356
339=begin table 1357=begin table
340 1358
1359 B<< C<Ps = 0> >> print screen (MC0)
341 B<< C<Ps = 4> >> disable transparent print mode (MC4) 1360 B<< C<Ps = 4> >> disable transparent print mode (MC4)
342 B<< C<Ps = 5> >> enable transparent print mode (MC5) I<unimplemented> 1361 B<< C<Ps = 5> >> enable transparent print mode (MC5)
343 1362
344=end table 1363=end table
345
346=item B<< C<ESC [ Pm h> >>
347
348Set Mode (SM). See next sequence for description of C<Pm>.
349 1364
350=item B<< C<ESC [ Pm l> >> 1365=item B<< C<ESC [ Pm l> >>
351 1366
352Reset Mode (RM) 1367Reset Mode (RM)
353 1368
379 1394
380=begin table 1395=begin table
381 1396
382 B<< C<Ps = 0> >> Normal (default) 1397 B<< C<Ps = 0> >> Normal (default)
383 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg) 1398 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg)
384 B<< C<Ps = 3 / 23> >> On / Off Italic (NYI) 1399 B<< C<Ps = 3 / 23> >> On / Off Italic
385 B<< C<Ps = 4 / 24> >> On / Off Underline 1400 B<< C<Ps = 4 / 24> >> On / Off Underline
386 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg) 1401 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg)
387 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg) 1402 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg)
1403 B<< C<Ps = 7 / 27> >> On / Off Inverse
388 B<< C<Ps = 7 / 27> >> On / Off Invisible (NYI) 1404 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 1405 B<< C<Ps = 30 / 40> >> fg/bg Black
391 B<< C<Ps = 31 / 41> >> fg/bg Red 1406 B<< C<Ps = 31 / 41> >> fg/bg Red
392 B<< C<Ps = 32 / 42> >> fg/bg Green 1407 B<< C<Ps = 32 / 42> >> fg/bg Green
393 B<< C<Ps = 33 / 43> >> fg/bg Yellow 1408 B<< C<Ps = 33 / 43> >> fg/bg Yellow
394 B<< C<Ps = 34 / 44> >> fg/bg Blue 1409 B<< C<Ps = 34 / 44> >> fg/bg Blue
395 B<< C<Ps = 35 / 45> >> fg/bg Magenta 1410 B<< C<Ps = 35 / 45> >> fg/bg Magenta
396 B<< C<Ps = 36 / 46> >> fg/bg Cyan 1411 B<< C<Ps = 36 / 46> >> fg/bg Cyan
1412 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 1413 B<< C<Ps = 37 / 47> >> fg/bg White
398 B<< C<Ps = 39 / 49> >> fg/bg Default 1414 B<< C<Ps = 39 / 49> >> fg/bg Default
399 B<< C<Ps = 90 / 100> >> fg/bg Bright Black 1415 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
400 B<< C<Ps = 91 / 101> >> fg/bg Bright Red 1416 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
401 B<< C<Ps = 92 / 102> >> fg/bg Bright Green 1417 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
428 1444
429=item B<< C<ESC [ s> >> 1445=item B<< C<ESC [ s> >>
430 1446
431Save Cursor (SC) 1447Save Cursor (SC)
432 1448
1449=item B<< C<ESC [ Ps;Pt t> >>
1450
1451Window Operations
1452
1453=begin table
1454
1455 B<< C<Ps = 1> >> Deiconify (map) window
1456 B<< C<Ps = 2> >> Iconify window
1457 B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1458 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1459 B<< C<Ps = 5> >> Raise window
1460 B<< C<Ps = 6> >> Lower window
1461 B<< C<Ps = 7> >> Refresh screen once
1462 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1463 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1464 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1465 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1466 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1467 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1468 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1469 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
1470 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1471
1472=end table
1473
1474=item B<< C<ESC [ u> >>
1475
1476Restore Cursor
1477
433=item B<< C<ESC [ Ps x> >> 1478=item B<< C<ESC [ Ps x> >>
434 1479
435Request Terminal Parameters (DECREQTPARM) 1480Request Terminal Parameters (DECREQTPARM)
436
437=item B<< C<ESC [ u> >>
438
439Restore Cursor
440 1481
441=back 1482=back
442 1483
443X<PrivateModes> 1484X<PrivateModes>
444 1485
547 B<< C<h> >> Send Mouse X & Y on button press. 1588 B<< C<h> >> Send Mouse X & Y on button press.
548 B<< C<l> >> No mouse reporting. 1589 B<< C<l> >> No mouse reporting.
549 1590
550=end table 1591=end table
551 1592
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> >> 1593=item B<< C<Ps = 25> >>
562 1594
563=begin table 1595=begin table
564 1596
565 B<< C<h> >> Visible cursor {cnorm/cvvis} 1597 B<< C<h> >> Visible cursor {cnorm/cvvis}
678 1710
679=begin table 1711=begin table
680 1712
681 B<< C<h> >> Scroll to bottom when a key is pressed 1713 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 1714 B<< C<l> >> Don't scroll to bottom when a key is pressed
1715
1716=end table
1717
1718=item B<< C<Ps = 1021> >> (B<rxvt>)
1719
1720=begin table
1721
1722 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1723 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
683 1724
684=end table 1725=end table
685 1726
686=item B<< C<Ps = 1047> >> 1727=item B<< C<Ps = 1047> >>
687 1728
736 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1777 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
737 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 1778 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
738 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 1779 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
739 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1780 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
740 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1781 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
741 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1782 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
742 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1783 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1784 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
743 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1785 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> 1786 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> 1787 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> >> 1788 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
748 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1789 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
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) 1790 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
750 B<< C<Ps = 702> >> find font for character, used for debugging (@@RXVT_NAME@@ extension) 1791 B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>.
751 B<< C<Ps = 703> >> menubar command B<< C<Pt> >> I<rxvt compile-time option> (@@RXVT_NAME@@ extension) 1792 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1793 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1794 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1795 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1796 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1797 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1798 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1799 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1800 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1801 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1802 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
752 1803
753=end table 1804=end table
754 1805
755=back 1806=back
756 1807
757X<menuBar>
758
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> 1808X<XPM>
1223 1809
1224=head1 XPM 1810=head1 XPM
1225 1811
1226For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 1812For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1412=end table 1998=end table
1413 1999
1414=head1 CONFIGURE OPTIONS 2000=head1 CONFIGURE OPTIONS
1415 2001
1416General hint: if you get compile errors, then likely your configuration 2002General hint: if you get compile errors, then likely your configuration
1417hasn't been tested well. Either try with --enable-everything or use the 2003hasn't been tested well. Either try with C<--enable-everything> or use
1418./reconf script as a base for experiments. ./reconf is used by myself, 2004the F<./reconf> script as a base for experiments. F<./reconf> is used by
1419so it should generally be a working config. Of course, you should always 2005myself, so it should generally be a working config. Of course, you should
1420report when a combination doesn't work, so it can be fixed. Marc Lehmann 2006always report when a combination doesn't work, so it can be fixed. Marc
1421<rxvt@schmorp.de>. 2007Lehmann <rxvt@schmorp.de>.
2008
2009All
1422 2010
1423=over 4 2011=over 4
1424 2012
1425=item --enable-everything 2013=item --enable-everything
1426 2014
1427Add support for all non-multichoice options listed in "./configure 2015Add (or remove) support for all non-multichoice options listed in "./configure
1428--help". Note that unlike other enable options this is order dependant. 2016--help".
2017
1429You can specify this and then disable options which this enables by 2018You can specify this and then disable options you do not like by
1430I<following> this with the appropriate commands. 2019I<following> this with the appropriate C<--disable-...> arguments,
2020or you can start with a minimal configuration by specifying
2021C<--disable-everything> and than adding just the C<--enable-...> arguments
2022you want.
1431 2023
1432=item --enable-xft 2024=item --enable-xft (default: enabled)
1433 2025
1434Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2026Add 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 2027slower and require lots of memory, but as long as you don't use them, you
1436don't pay for them. 2028don't pay for them.
1437 2029
2030=item --enable-font-styles (default: on)
2031
2032Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2033styles. The fonts can be set manually or automatically.
2034
1438=item --with-codesets=NAME,... 2035=item --with-codesets=NAME,... (default: all)
1439 2036
1440Compile in support for additional codeset (encoding) groups. These codeset 2037Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2038are always compiled in, which includes most 8-bit character sets). These
1441tables are currently only used for driving X11 core fonts, they are not 2039codeset tables are used for driving X11 core fonts, they are not required
1442required for Xft fonts. Compiling them in will make your binary bigger 2040for Xft fonts, although having them compiled in lets rxvt-unicode choose
1443(together about 700kB), but it doesn't increase memory usage unless you 2041replacement fonts more intelligently. Compiling them in will make your
2042binary bigger (all of together cost about 700kB), but it doesn't increase
1444use an X11 font requiring one of these encodings. 2043memory usage unless you use a font requiring one of these encodings.
1445 2044
1446=begin table 2045=begin table
1447 2046
1448 all all available codeset groups 2047 all all available codeset groups
1449 cn common chinese encodings 2048 zh common chinese encodings
1450 cn_ext rarely used but very big chinese encodigs 2049 zh_ext rarely used but very big chinese encodigs
1451 jp common japanese encodings 2050 jp common japanese encodings
1452 jp_ext rarely used but big japanese encodings 2051 jp_ext rarely used but big japanese encodings
1453 kr korean encodings 2052 kr korean encodings
1454 2053
1455=end table 2054=end table
1456 2055
1457=item --enable-xim 2056=item --enable-xim (default: on)
1458 2057
1459Add support for XIM (X Input Method) protocol. This allows using 2058Add support for XIM (X Input Method) protocol. This allows using
1460alternative input methods (e.g. kinput2) and will also correctly 2059alternative input methods (e.g. kinput2) and will also correctly
1461set up the input for people using dead keys or compose keys. 2060set up the input for people using dead keys or compose keys.
1462 2061
1463=item --enable-unicode3 2062=item --enable-unicode3 (default: off)
2063
2064Recommended to stay off unless you really need non-BMP characters.
1464 2065
1465Enable direct support for displaying unicode codepoints above 2066Enable direct support for displaying unicode codepoints above
146665535 (the basic multilingual page). This increases storage 206765535 (the basic multilingual page). This increases storage
1467requirements per character from 2 to 4 bytes. X11 fonts do not yet 2068requirements per character from 2 to 4 bytes. X11 fonts do not yet
1468support these extra characters, but Xft does. 2069support these extra characters, but Xft does.
1471even without this flag, but the number of such characters is 2072even without this flag, but the number of such characters is
1472limited to a view thousand (shared with combining characters, 2073limited to a view thousand (shared with combining characters,
1473see next switch), and right now rxvt-unicode cannot display them 2074see next switch), and right now rxvt-unicode cannot display them
1474(input/output and cut&paste still work, though). 2075(input/output and cut&paste still work, though).
1475 2076
1476=item --enable-combining 2077=item --enable-combining (default: on)
1477 2078
1478Enable automatic composition of combining characters into 2079Enable automatic composition of combining characters into
1479composite characters. This is required for proper viewing of text 2080composite characters. This is required for proper viewing of text
1480where accents are encoded as seperate unicode characters. This is 2081where accents are encoded as seperate unicode characters. This is
1481done by using precomposited characters when available or creating 2082done by using precomposited characters when available or creating
1482new pseudo-characters when no precomposed form exists. 2083new pseudo-characters when no precomposed form exists.
1483 2084
1484Without --enable-unicode3, the number of additional precomposed 2085Without --enable-unicode3, the number of additional precomposed
1485characters is rather limited (2048, if this is full, rxvt will use the 2086characters is somewhat limited (the 6400 private use characters will be
1486private use area, extending the number of combinations to 8448). With 2087(ab-)used). With --enable-unicode3, no practical limit exists.
1487--enable-unicode3, no practical limit exists. This will also enable 2088
1488storage of characters >65535. 2089This option will also enable storage (but not display) of characters
2090beyond plane 0 (>65535) when --enable-unicode3 was not specified.
1489 2091
1490The combining table also contains entries for arabic presentation forms, 2092The combining table also contains entries for arabic presentation forms,
1491but these are not currently used. Bug me if you want these to be used. 2093but these are not currently used. Bug me if you want these to be used (and
2094tell me how these are to be used...).
1492 2095
1493=item --enable-fallback(=CLASS) 2096=item --enable-fallback(=CLASS) (default: Rxvt)
1494 2097
1495When reading resource settings, also read settings for class CLASS 2098When reading resource settings, also read settings for class CLASS. To
1496(default: Rxvt). To disable resource fallback use --disable-fallback. 2099disable resource fallback use --disable-fallback.
1497 2100
1498=item --with-res-name=NAME 2101=item --with-res-name=NAME (default: urxvt)
1499 2102
1500Use the given name (default: urxvt) as default application name when 2103Use the given name as default application name when
1501reading resources. Specify --with-res-name=rxvt to replace rxvt. 2104reading resources. Specify --with-res-name=rxvt to replace rxvt.
1502 2105
1503=item --with-res-class=CLASS 2106=item --with-res-class=CLASS /default: URxvt)
1504 2107
1505Use the given class (default: URxvt) as default application class 2108Use the given class as default application class
1506when reading resources. Specify --with-res-class=Rxvt to replace 2109when reading resources. Specify --with-res-class=Rxvt to replace
1507rxvt. 2110rxvt.
1508 2111
1509=item --enable-utmp 2112=item --enable-utmp (default: on)
1510 2113
1511Write user and tty to utmp file (used by programs like F<w>) at 2114Write user and tty to utmp file (used by programs like F<w>) at
1512start of rxvt execution and delete information when rxvt exits. 2115start of rxvt execution and delete information when rxvt exits.
1513 2116
1514=item --enable-wtmp 2117=item --enable-wtmp (default: on)
1515 2118
1516Write user and tty to wtmp file (used by programs like F<last>) at 2119Write user and tty to wtmp file (used by programs like F<last>) at
1517start of rxvt execution and write logout when rxvt exits. This 2120start of rxvt execution and write logout when rxvt exits. This
1518option requires --enable-utmp to also be specified. 2121option requires --enable-utmp to also be specified.
1519 2122
1520=item --enable-lastlog 2123=item --enable-lastlog (default: on)
1521 2124
1522Write user and tty to lastlog file (used by programs like 2125Write user and tty to lastlog file (used by programs like
1523F<lastlogin>) at start of rxvt execution. This option requires 2126F<lastlogin>) at start of rxvt execution. This option requires
1524--enable-utmp to also be specified. 2127--enable-utmp to also be specified.
1525 2128
1526=item --enable-xpm-background 2129=item --enable-xpm-background (default: on)
1527 2130
1528Add support for XPM background pixmaps. 2131Add support for XPM background pixmaps.
1529 2132
1530=item --enable-transparency 2133=item --enable-transparency (default: on)
1531 2134
1532Add support for inheriting parent backgrounds thus giving a fake 2135Add support for inheriting parent backgrounds thus giving a fake
1533transparency to the term. 2136transparency to the term.
1534 2137
1535=item --enable-fading 2138=item --enable-fading (default: on)
1536 2139
1537Add support for fading the text when focus is lost. 2140Add support for fading the text when focus is lost (requires C<--enable-transparency>).
1538 2141
1539=item --enable-tinting 2142=item --enable-tinting (default: on)
1540 2143
1541Add support for tinting of transparent backgrounds. 2144Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
1542 2145
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 2146=item --enable-rxvt-scroll (default: on)
1549 2147
1550Add support for the original rxvt scrollbar. 2148Add support for the original rxvt scrollbar.
1551 2149
1552=item --enable-next-scroll 2150=item --enable-next-scroll (default: on)
1553 2151
1554Add support for a NeXT-like scrollbar. 2152Add support for a NeXT-like scrollbar.
1555 2153
1556=item --enable-xterm-scroll 2154=item --enable-xterm-scroll (default: on)
1557 2155
1558Add support for an Xterm-like scrollbar. 2156Add support for an Xterm-like scrollbar.
1559 2157
1560=item --enable-plain-scroll 2158=item --enable-plain-scroll (default: on)
1561 2159
1562Add support for a very unobtrusive, plain-looking scrollbar that 2160Add support for a very unobtrusive, plain-looking scrollbar that
1563is the favourite of the rxvt-unicode author, having used it for 2161is the favourite of the rxvt-unicode author, having used it for
1564many years. 2162many years.
1565 2163
1566=item --enable-half-shadow 2164=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 2165
1573Change tty device setting to group "tty" - only use this if 2166Change tty device setting to group "tty" - only use this if
1574your system uses this type of security. 2167your system uses this type of security.
1575 2168
1576=item --disable-backspace-key 2169=item --disable-backspace-key
1577 2170
1578Disable any handling of the backspace key by us - let the X server 2171Removes any handling of the backspace key by us - let the X server do it.
2172
2173=item --disable-delete-key
2174
2175Removes any handling of the delete key by us - let the X server
1579do it. 2176do it.
1580 2177
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 2178=item --disable-resources
1587 2179
1588Remove all resources checking. 2180Removes 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 2181
1604=item --disable-swapscreen 2182=item --disable-swapscreen
1605 2183
1606Remove support for swap screen. 2184Remove support for secondary/swap screen.
1607 2185
1608=item --enable-frills 2186=item --enable-frills (default: on)
1609 2187
1610Add support for many small features that are not essential but nice to 2188Add support for many small features that are not essential but nice to
1611have. Normally you want this, but for very small binaries you may want to 2189have. Normally you want this, but for very small binaries you may want to
1612disable this. 2190disable this.
1613 2191
2192A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2193in combination with other switches) is:
2194
2195 MWM-hints
2196 EWMH-hints (pid, utf8 names) and protocols (ping)
2197 seperate underline colour (-underlineColor)
2198 settable border widths and borderless switch (-w, -b, -bl)
2199 visual depth selection (-depth)
2200 settable extra linespacing /-lsp)
2201 iso-14755-2 and -3, and visual feedback
2202 tripleclickwords (-tcw)
2203 settable insecure mode (-insecure)
2204 keysym remapping support
2205 cursor blinking and underline cursor (-cb, -uc)
2206 XEmbed support (-embed)
2207 user-pty (-pty-fd)
2208 hold on exit (-hold)
2209 skip builtin block graphics (-sbg)
2210
2211It also enabled some non-essential features otherwise disabled, such as:
2212
2213 some round-trip time optimisations
2214 nearest color allocation on pseudocolor screens
2215 UTF8_STRING supporr for selection
2216 sgr modes 90..97 and 100..107
2217 backindex and forwardindex escape sequences
2218 view change/zero scorllback esacpe sequences
2219 locale switching escape sequence
2220 window op and some xterm/OSC escape sequences
2221 rectangular selections
2222 trailing space removal for selections
2223 verbose X error handling
2224
1614=item --enable-iso14755 2225=item --enable-iso14755 (default: on)
1615 2226
1616Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2227Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
1617F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2228F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
1618C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2229C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
1619this switch. 2230this switch.
1620 2231
1621=item --enable-linespace
1622
1623Add support to provide user specified line spacing between text rows.
1624
1625=item --enable-keepscrolling 2232=item --enable-keepscrolling (default: on)
1626 2233
1627Add support for continual scrolling of the display when you hold 2234Add support for continual scrolling of the display when you hold
1628the mouse button down on a scrollbar arrow. 2235the mouse button down on a scrollbar arrow.
1629 2236
1630=item --enable-mousewheel 2237=item --enable-mousewheel (default: on)
1631 2238
1632Add support for scrolling via mouse wheel or buttons 4 & 5. 2239Add support for scrolling via mouse wheel or buttons 4 & 5.
1633 2240
1634=item --enable-slipwheeling 2241=item --enable-slipwheeling (default: on)
1635 2242
1636Add support for continual scrolling (using the mouse wheel as an 2243Add support for continual scrolling (using the mouse wheel as an
1637accelerator) while the control key is held down. This option 2244accelerator) while the control key is held down. This option
1638requires --enable-mousewheel to also be specified. 2245requires --enable-mousewheel to also be specified.
1639 2246
1640=item --disable-new-selection 2247=item --disable-new-selection
1641 2248
1642Remove support for mouse selection style like that of xterm. 2249Remove support for mouse selection style like that of xterm.
1643 2250
1644=item --enable-dmalloc 2251=item --enable-dmalloc (default: off)
1645 2252
1646Use Gray Watson's malloc - which is good for debugging See 2253Use Gray Watson's malloc - which is good for debugging See
1647http://www.letters.com/dmalloc/ for details If you use either this or the 2254http://www.letters.com/dmalloc/ for details If you use either this or the
1648next option, you may need to edit src/Makefile after compiling to point 2255next option, you may need to edit src/Makefile after compiling to point
1649DINCLUDE and DLIB to the right places. 2256DINCLUDE and DLIB to the right places.
1650 2257
1651You can only use either this option and the following (should 2258You can only use either this option and the following (should
1652you use either) . 2259you use either) .
1653 2260
1654=item --enable-dlmalloc 2261=item --enable-dlmalloc (default: off)
1655 2262
1656Use Doug Lea's malloc - which is good for a production version 2263Use Doug Lea's malloc - which is good for a production version
1657See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2264See L<http://g.oswego.edu/dl/html/malloc.html> for details.
1658 2265
1659=item --enable-smart-resize 2266=item --enable-smart-resize (default: on)
1660 2267
1661Add smart growth/shrink behaviour when changing font size via from hot 2268Add smart growth/shrink behaviour when changing font size via hot
1662keys. This should keep in a fixed position the rxvt corner which is 2269keys. This should keep the window corner which is closest to a corner of
1663closest to a corner of the screen. 2270the screen in a fixed position.
1664 2271
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 2272=item --enable-pointer-blank (default: on)
1677 2273
1678Add support to have the pointer disappear when typing or inactive. 2274Add support to have the pointer disappear when typing or inactive.
1679 2275
1680=item --with-name=NAME 2276=item --enable-perl (default: on)
1681 2277
2278Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2279manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2280in F<src/perl-ext/> for the extensions that are installed by default. The
2281perl interpreter that is used can be specified via the C<PERL> environment
2282variable when running configure.
2283
2284=item --with-name=NAME (default: urxvt)
2285
1682Set the basename for the installed binaries (default: urxvt, resulting in 2286Set the basename for the installed binaries, resulting
1683urxvt, urxvtd etc.). Specify --with-name=rxvt to replace rxvt. 2287in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2288C<rxvt>.
1684 2289
1685=item --with-term=NAME 2290=item --with-term=NAME (default: rxvt-unicode)
1686 2291
1687Change the environmental variable for the terminal to NAME (default 2292Change the environmental variable for the terminal to NAME.
1688"rxvt")
1689 2293
1690=item --with-terminfo=PATH 2294=item --with-terminfo=PATH
1691 2295
1692Change the environmental variable for the path to the terminfo tree to 2296Change the environmental variable for the path to the terminfo tree to
1693PATH. 2297PATH.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines