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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.244 by root, Wed Jun 22 07:31:49 2016 UTC

1=head1 Rxvt Technical Reference 1=head1 NAME
2 2
3Marc Lehmann <rxvt@schmorp.de>, converted to pod and reworked from the 3RXVT REFERENCE - FAQ, command sequences and other background information
4original Rxvt documentation by Geoff Wing <gcw@pobox.com>, who in turn used
5the XTerm documentation and other sources.
6 4
7=head1 Definitions 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://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23
24The main manual page for @@RXVT_NAME@@ itself is available at
25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
26
27=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
28
29
30=head2 Meta, Features & Commandline Issues
31
32=head3 My question isn't answered here, can I ask a human?
33
34Before sending me mail, you could go to IRC: C<irc.freenode.net>,
35channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
36interested in learning about new and exciting problems (but not FAQs :).
37
38=head3 I use Gentoo, and I have a problem...
39
40There are two big problems with Gentoo Linux: first, most if not all
41Gentoo systems are completely broken (missing or mismatched header
42files, broken compiler etc. are just the tip of the iceberg);
43secondly, it should be called Gentoo GNU/Linux.
44
45For these reasons, it is impossible to support rxvt-unicode on
46Gentoo. Problems appearing on Gentoo systems will usually simply be
47ignored unless they can be reproduced on non-Gentoo systems.
48
49=head3 Does it support tabs, can I have a tabbed rxvt-unicode?
50
51Beginning with version 7.3, there is a perl extension that implements a
52simple tabbed terminal. It is installed by default, so any of these should
53give you tabs:
54
55 @@URXVT_NAME@@ -pe tabbed
56
57 URxvt.perl-ext-common: default,tabbed
58
59It will also work fine with tabbing functionality of many window managers
60or similar tabbing programs, and its embedding-features allow it to be
61embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
62the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
63(murxvt) terminal as an example embedding application.
64
65=head3 How do I know which rxvt-unicode version I'm using?
66
67The version number is displayed with the usage (-h). Also the escape
68sequence C<ESC [ 8 n> sets the window title to the version number. When
69using the @@URXVT_NAME@@c client, the version displayed is that of the
70daemon.
71
72=head3 Rxvt-unicode uses gobs of memory, how can I reduce that?
73
74Rxvt-unicode tries to obey the rule of not charging you for something you
75don't use. One thing you should try is to configure out all settings that
76you don't need, for example, Xft support is a resource hog by design,
77when used. Compiling it out ensures that no Xft font will be loaded
78accidentally when rxvt-unicode tries to find a font for your characters.
79
80Also, many people (me included) like large windows and even larger
81scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
826 bytes per screen cell. For a 160x?? window this amounts to almost a
83kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
84use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
85rxvt-unicode then uses 8 bytes per screen cell.
86
87=head3 How can I start @@URXVT_NAME@@d in a race-free way?
88
89Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
90display, create the listening socket and then fork.
91
92=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
93
94If you want to start @@URXVT_NAME@@d automatically whenever you run
95@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
96
97 #!/bin/sh
98 @@URXVT_NAME@@c "$@"
99 if [ $? -eq 2 ]; then
100 @@URXVT_NAME@@d -q -o -f
101 @@URXVT_NAME@@c "$@"
102 fi
103
104This tries to create a new terminal, and if fails with exit status 2,
105meaning it couldn't connect to the daemon, it will start the daemon and
106re-run the command. Subsequent invocations of the script will re-use the
107existing daemon.
108
109=head3 How do I distinguish whether I'm running rxvt-unicode or a regular
110xterm? I need this to decide about setting colours etc.
111
112The original rxvt and rxvt-unicode always export the variable "COLORTERM",
113so you can check and see if that is set. Note that several programs, JED,
114slrn, Midnight Commander automatically check this variable to decide
115whether or not to use colour.
116
117=head3 How do I set the correct, full IP address for the DISPLAY variable?
118
119If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
120insecure mode then it is possible to use the following shell script
121snippets to correctly set the display. If your version of rxvt-unicode
122wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
123the COLORTERM variable can be used to distinguish rxvt-unicode from a
124regular xterm.
125
126Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
127snippets:
128
129 # Bourne/Korn/POSIX family of shells:
130 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
131 if [ ${TERM:-foo} = xterm ]; then
132 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
133 printf "\eZ"
134 read term_id
135 stty icanon echo
136 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
137 printf '\e[7n' # query the rxvt we are in for the DISPLAY string
138 read DISPLAY # set it in our local shell
139 fi
140 fi
141
142=head3 How do I compile the manual pages on my own?
143
144You need to have a recent version of perl installed as F</usr/bin/perl>,
145one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from
146F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
147
148=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
149
150I often get asked about this, and I think, no, they didn't cause extra
151bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
152that the urxvt binary is larger (due to some encoding tables always being
153compiled in), but it actually uses less memory (RSS) after startup. Even
154with C<--disable-everything>, this comparison is a bit unfair, as many
155features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
156already in use in this mode.
157
158 text data bss drs rss filename
159 98398 1664 24 15695 1824 rxvt --disable-everything
160 188985 9048 66616 18222 1788 urxvt --disable-everything
161
162When you C<--enable-everything> (which I<is> unfair, as this involves xft
163and full locale/XIM support which are quite bloaty inside libX11 and my
164libc), the two diverge, but not unreasonably so.
165
166 text data bss drs rss filename
167 163431 2152 24 20123 2060 rxvt --enable-everything
168 1035683 49680 66648 29096 3680 urxvt --enable-everything
169
170The very large size of the text section is explained by the east-asian
171encoding tables, which, if unused, take up disk space but nothing else
172and can be compiled out unless you rely on X11 core fonts that use those
173encodings. The BSS size comes from the 64k emergency buffer that my c++
174compiler allocates (but of course doesn't use unless you are out of
175memory). Also, using an xft font instead of a core font immediately adds a
176few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
177not used.
178
179Of course, due to every character using two or four bytes instead of one,
180a large scrollback buffer will ultimately make rxvt-unicode use more
181memory.
182
183Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
184still fares rather well. And compared to some monsters like gnome-terminal
185(21152k + extra 4204k in separate processes) or konsole (22200k + extra
18643180k in daemons that stay around after exit, plus half a minute of
187startup time, including the hundreds of warnings it spits out), it fares
188extremely well *g*.
189
190=head3 Why C++, isn't that unportable/bloated/uncool?
191
192Is this a question? :) It comes up very often. The simple answer is: I had
193to write it, and C++ allowed me to write and maintain it in a fraction
194of the time and effort (which is a scarce resource for me). Put even
195shorter: It simply wouldn't exist without C++.
196
197My personal stance on this is that C++ is less portable than C, but in
198the case of rxvt-unicode this hardly matters, as its portability limits
199are defined by things like X11, pseudo terminals, locale support and unix
200domain sockets, which are all less portable than C++ itself.
201
202Regarding the bloat, see the above question: It's easy to write programs
203in C that use gobs of memory, and certainly possible to write programs in
204C++ that don't. C++ also often comes with large libraries, but this is
205not necessarily the case with GCC. Here is what rxvt links against on my
206system with a minimal config:
207
208 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
209 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
210 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
211 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
212
213And here is rxvt-unicode:
214
215 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
216 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
217 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
218 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
219 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
220
221No large bloated libraries (of course, none were linked in statically),
222except maybe libX11 :)
223
224
225=head2 Rendering, Font & Look and Feel Issues
226
227=head3 I can't get transparency working, what am I doing wrong?
228
229First of all, transparency isn't officially supported in rxvt-unicode, so
230you are mostly on your own. Do not bug the author about it (but you may
231bug everybody else). Also, if you can't get it working consider it a rite
232of passage: ... and you failed.
233
234Here are four ways to get transparency. B<Do> read the manpage and option
235descriptions for the programs mentioned and rxvt-unicode. Really, do it!
236
2371. Use transparent mode:
238
239 Esetroot wallpaper.jpg
240 @@URXVT_NAME@@ -tr -tint red -sh 40
241
242That works. If you think it doesn't, you lack transparency and tinting
243support, or you are unable to read.
244This method requires that the background-setting program sets the
245_XROOTPMAP_ID or ESETROOT_PMAP_ID property. Compatible programs
246are Esetroot, hsetroot and feh.
247
2482. Use a simple pixmap and emulate pseudo-transparency. This enables you
249to use effects other than tinting and shading: Just shade/tint/whatever
250your picture with gimp or any other tool:
251
252 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
253 @@URXVT_NAME@@ -pixmap "background.jpg;:root"
254
255That works. If you think it doesn't, you lack GDK-PixBuf support, or you
256are unable to read.
257
2583. Use an ARGB visual:
259
260 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
261
262This requires XFT support, and the support of your X-server. If that
263doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
264there yet, no matter what they claim. Rxvt-Unicode contains the necessary
265bugfixes and workarounds for Xft and Xlib to make it work, but that
266doesn't mean that your WM has the required kludges in place.
267
2684. Use xcompmgr and let it do the job:
269
270 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
271 -set _NET_WM_WINDOW_OPACITY 0xc0000000
272
273Then click on a window you want to make transparent. Replace C<0xc0000000>
274by other values to change the degree of opacity. If it doesn't work and
275your server crashes, you got to keep the pieces.
276
277=head3 Why does rxvt-unicode sometimes leave pixel droppings?
278
279Most fonts were not designed for terminal use, which means that character
280size varies a lot. A font that is otherwise fine for terminal use might
281contain some characters that are simply too wide. Rxvt-unicode will avoid
282these characters. For characters that are just "a bit" too wide a special
283"careful" rendering mode is used that redraws adjacent characters.
284
285All of this requires that fonts do not lie about character sizes,
286however: Xft fonts often draw glyphs larger than their acclaimed bounding
287box, and rxvt-unicode has no way of detecting this (the correct way is to
288ask for the character bounding box, which unfortunately is wrong in these
289cases).
290
291It's not clear (to me at least), whether this is a bug in Xft, freetype,
292or the respective font. If you encounter this problem you might try using
293the C<-lsp> option to give the font more height. If that doesn't work, you
294might be forced to use a different font.
295
296All of this is not a problem when using X11 core fonts, as their bounding
297box data is correct.
298
299=head3 How can I keep rxvt-unicode from using reverse video so much?
300
301First of all, make sure you are running with the right terminal settings
302(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
303make sure you have specified colours for italic and bold, as otherwise
304rxvt-unicode might use reverse video to simulate the effect:
305
306 URxvt.colorBD: white
307 URxvt.colorIT: green
308
309=head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
310
311For some unexplainable reason, some rare programs assume a very weird
312colour palette when confronted with a terminal with more than the standard
3138 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
314these programs not to assume non-ISO colours without very good reasons.
315
316In the meantime, you can either edit your C<rxvt-unicode> terminfo
317definition to only claim 8 colour support or use C<TERM=rxvt>, which will
318fix colours but keep you from using other rxvt-unicode features.
319
320=head3 Can I switch the fonts at runtime?
321
322Yes, using an escape sequence. Try something like this, which has the same
323effect as using the C<-fn> switch, and takes effect immediately:
324
325 printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
326
327This is useful if you e.g. work primarily with japanese (and prefer a
328japanese font), but you have to switch to chinese temporarily, where
329japanese fonts would only be in your way.
330
331You can think of this as a kind of manual ISO-2022 switching.
332
333=head3 Why do italic characters look as if clipped?
334
335Many fonts have difficulties with italic characters and hinting. For
336example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
337Mono> completely fails in its italic face. A workaround might be to
338enable freetype autohinting, i.e. like this:
339
340 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
341 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
342
343=head3 Can I speed up Xft rendering somehow?
344
345Yes, the most obvious way to speed it up is to avoid Xft entirely, as
346it is simply slow. If you still want Xft fonts you might try to disable
347antialiasing (by appending C<:antialias=false>), which saves lots of
348memory and also speeds up rendering considerably.
349
350=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
351
352Rxvt-unicode will use whatever you specify as a font. If it needs to
353fall back to its default font search list it will prefer X11 core
354fonts, because they are small and fast, and then use Xft fonts. It has
355antialiasing disabled for most of them, because the author thinks they
356look best that way.
357
358If you want antialiasing, you have to specify the fonts manually.
359
360=head3 What's with this bold/blink stuff?
361
362If no bold colour is set via C<colorBD:>, bold will invert text using the
363standard foreground colour.
364
365For the standard background colour, blinking will actually make
366the text blink when compiled with C<--enable-text-blink>. Without
367C<--enable-text-blink>, the blink attribute will be ignored.
368
369On ANSI colours, bold/blink attributes are used to set high-intensity
370foreground/background colours.
371
372color0-7 are the low-intensity colours.
373
374color8-15 are the corresponding high-intensity colours.
375
376=head3 I don't like the screen colours. How do I change them?
377
378You can change the screen colours at run-time using F<~/.Xdefaults>
379resources (or as long-options).
380
381Here are values that are supposed to resemble a VGA screen,
382including the murky brown that passes for low-intensity yellow:
383
384 URxvt.color0: #000000
385 URxvt.color1: #A80000
386 URxvt.color2: #00A800
387 URxvt.color3: #A8A800
388 URxvt.color4: #0000A8
389 URxvt.color5: #A800A8
390 URxvt.color6: #00A8A8
391 URxvt.color7: #A8A8A8
392
393 URxvt.color8: #000054
394 URxvt.color9: #FF0054
395 URxvt.color10: #00FF54
396 URxvt.color11: #FFFF54
397 URxvt.color12: #0000FF
398 URxvt.color13: #FF00FF
399 URxvt.color14: #00FFFF
400 URxvt.color15: #FFFFFF
401
402And here is a more complete set of non-standard colours.
403
404 URxvt.cursorColor: #dc74d1
405 URxvt.pointerColor: #dc74d1
406 URxvt.background: #0e0e0e
407 URxvt.foreground: #4ad5e1
408 URxvt.color0: #000000
409 URxvt.color8: #8b8f93
410 URxvt.color1: #dc74d1
411 URxvt.color9: #dc74d1
412 URxvt.color2: #0eb8c7
413 URxvt.color10: #0eb8c7
414 URxvt.color3: #dfe37e
415 URxvt.color11: #dfe37e
416 URxvt.color5: #9e88f0
417 URxvt.color13: #9e88f0
418 URxvt.color6: #73f7ff
419 URxvt.color14: #73f7ff
420 URxvt.color7: #e1dddd
421 URxvt.color15: #e1dddd
422
423They have been described (not by me) as "pretty girly".
424
425=head3 Why do some characters look so much different than others?
426
427See next entry.
428
429=head3 How does rxvt-unicode choose fonts?
430
431Most fonts do not contain the full range of Unicode, which is
432fine. Chances are that the font you (or the admin/package maintainer of
433your system/os) have specified does not cover all the characters you want
434to display.
435
436B<rxvt-unicode> makes a best-effort try at finding a replacement
437font. Often the result is fine, but sometimes the chosen font looks
438bad/ugly/wrong. Some fonts have totally strange characters that don't
439resemble the correct glyph at all, and rxvt-unicode lacks the artificial
440intelligence to detect that a specific glyph is wrong: it has to believe
441the font that the characters it claims to contain indeed look correct.
442
443In that case, select a font of your taste and add it to the font list,
444e.g.:
445
446 @@URXVT_NAME@@ -fn basefont,font2,font3...
447
448When rxvt-unicode sees a character, it will first look at the base
449font. If the base font does not contain the character, it will go to the
450next font, and so on. Specifying your own fonts will also speed up this
451search and use less resources within rxvt-unicode and the X-server.
452
453The only limitation is that none of the fonts may be larger than the base
454font, as the base font defines the terminal character cell size, which
455must be the same due to the way terminals work.
456
457=head3 Why do some chinese characters look so different than others?
458
459This is because there is a difference between script and language --
460rxvt-unicode does not know which language the text that is output is,
461as it only knows the unicode character codes. If rxvt-unicode first
462sees a japanese/chinese character, it might choose a japanese font for
463display. Subsequent japanese characters will use that font. Now, many
464chinese characters aren't represented in japanese fonts, so when the first
465non-japanese character comes up, rxvt-unicode will look for a chinese font
466-- unfortunately at this point, it will still use the japanese font for
467chinese characters that are also in the japanese font.
468
469The workaround is easy: just tag a chinese font at the end of your font
470list (see the previous question). The key is to view the font list as
471a preference list: If you expect more japanese, list a japanese font
472first. If you expect more chinese, put a chinese font first.
473
474In the future it might be possible to switch language preferences at
475runtime (the internal data structure has no problem with using different
476fonts for the same character at the same time, but no interface for this
477has been designed yet).
478
479Until then, you might get away with switching fonts at runtime (see L<Can
480I switch the fonts at runtime?> later in this document).
481
482=head3 How can I make mplayer display video correctly?
483
484We are working on it, in the meantime, as a workaround, use something like:
485
486 @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
487
488=head3 Why is the cursor now blinking in emacs/vi/...?
489
490This is likely caused by your editor/program's use of the C<cvvis>
491terminfo capability. Emacs uses it by default, as well as some versions of
492vi and possibly other programs.
493
494In emacs, you can switch that off by adding this to your C<.emacs> file:
495
496 (setq visible-cursor nil)
497
498For other programs, if they do not have an option, your have to remove the
499C<cvvis> capability from the terminfo description.
500
501When @@URXVT_NAME@@ first added the blinking cursor option, it didn't
502add a C<cvvis> capability, which served no purpose before. Version 9.21
503introduced C<cvvis> (and the ability to control blinking independent of
504cursor shape) for compatibility with other terminals, which traditionally
505use a blinking cursor for C<cvvis>. This also reflects the intent of
506programs such as emacs, who expect C<cvvis> to enable a blinking cursor.
507
508=head2 Keyboard, Mouse & User Interaction
509
510=head3 The new selection selects pieces that are too big, how can I select single words?
511
512If you want to select e.g. alphanumeric words, you can use the following
513setting:
514
515 URxvt.selection.pattern-0: ([[:word:]]+)
516
517If you click more than twice, the selection will be extended
518more and more.
519
520To get a selection that is very similar to the old code, try this pattern:
521
522 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
523
524Please also note that the I<LeftClick Shift-LeftClick> combination also
525selects words like the old code.
526
527=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
528
529You can disable the perl extension completely by setting the
530B<perl-ext-common> resource to the empty string, which also keeps
531rxvt-unicode from initialising perl, saving memory.
532
533If you only want to disable specific features, you first have to
534identify which perl extension is responsible. For this, read the section
535B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
536example, to disable the B<selection-popup> and B<option-popup>, specify
537this B<perl-ext-common> resource:
538
539 URxvt.perl-ext-common: default,-selection-popup,-option-popup
540
541This will keep the default extensions, but disable the two popup
542extensions. Some extensions can also be configured, for example,
543scrollback search mode is triggered by B<M-s>. You can move it to any
544other combination by adding a B<keysym> resource that binds the desired
545combination to the C<start> action of C<searchable-scrollback> and another
546one that binds B<M-s> to the C<builtin:> action:
547
548 URxvt.keysym.CM-s: searchable-scrollback:start
549 URxvt.keysym.M-s: builtin:
550
551=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
552
553See next entry.
554
555=head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
556
557These are caused by the C<readline> perl extension. Under normal
558circumstances, it will move your cursor around when you click into the
559line that contains it. It tries hard not to do this at the wrong moment,
560but when running a program that doesn't parse cursor movements or in some
561cases during rlogin sessions, it fails to detect this properly.
562
563You can permanently switch this feature off by disabling the C<readline>
564extension:
565
566 URxvt.perl-ext-common: default,-readline
567
568=head3 My numeric keypad acts weird and generates differing output?
569
570Some Debian GNU/Linux users seem to have this problem, although no
571specific details were reported so far. It is possible that this is caused
572by the wrong C<TERM> setting, although the details of whether and how
573this can happen are unknown, as C<TERM=rxvt> should offer a compatible
574keymap. See the answer to the previous question, and please report if that
575helped.
576
577=head3 My Compose (Multi_key) key is no longer working.
578
579The most common causes for this are that either your locale is not set
580correctly, or you specified a B<preeditType> that is not supported by
581your input method. For example, if you specified B<OverTheSpot> and
582your input method (e.g. the default input method handling Compose keys)
583does not support this (for instance because it is not visual), then
584rxvt-unicode will continue without an input method.
585
586In this case either do not specify a B<preeditType> or specify more than
587one pre-edit style, such as B<OverTheSpot,Root,None>.
588
589If it still doesn't work, then maybe your input method doesn't support
590compose sequences - to fall back to the built-in one, make sure you don't
591specify an input method via C<-im> or C<XMODIFIERS>.
592
593=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
594
595Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
596international keyboards) or simply use ISO 14755 support to your
597advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
598codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
599character and so on.
600
601=head3 Mouse cut/paste suddenly no longer works.
602
603Make sure that mouse reporting is actually turned off since killing
604some editors prematurely may leave it active. I've
605heard that tcsh may use mouse reporting unless it is otherwise specified. A
606quick check is to see if cut/paste works when the Alt or Shift keys are
607pressed.
608
609=head3 What's with the strange Backspace/Delete key behaviour?
610
611Assuming that the physical Backspace key corresponds to the
612Backspace keysym (not likely for Linux ... see the following
613question) there are two standard values that can be used for
614Backspace: C<^H> and C<^?>.
615
616Historically, either value is correct, but rxvt-unicode adopts the debian
617policy of using C<^?> when unsure, because it's the one and only correct
618choice :).
619
620It is possible to toggle between C<^H> and C<^?> with the DECBKM
621private mode:
622
623 # use Backspace = ^H
624 $ stty erase ^H
625 $ printf "\e[?67h"
626
627 # use Backspace = ^?
628 $ stty erase ^?
629 $ printf "\e[?67l"
630
631This helps satisfy some of the Backspace discrepancies that occur, but
632if you use Backspace = C<^H>, make sure that the termcap/terminfo value
633properly reflects that.
634
635The Delete key is a another casualty of the ill-defined Backspace problem.
636To avoid confusion between the Backspace and Delete keys, the Delete
637key has been assigned an escape sequence to match the vt100 for Execute
638(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
639
640Some other Backspace problems:
641
642some editors use termcap/terminfo,
643some editors (vim I'm told) expect Backspace = ^H,
644GNU Emacs (and Emacs-like editors) use ^H for help.
645
646Perhaps someday this will all be resolved in a consistent manner.
647
648=head3 I don't like the key-bindings. How do I change them?
649
650There are some compile-time selections available via configure. Unless
651you have run "configure" with the C<--disable-resources> option you can
652use the `keysym' resource to alter the keystrings associated with keysyms.
653
654Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
655
656 URxvt.keysym.Prior: \033[5~
657 URxvt.keysym.Next: \033[6~
658 URxvt.keysym.Home: \033[7~
659 URxvt.keysym.End: \033[8~
660 URxvt.keysym.Up: \033[A
661 URxvt.keysym.Down: \033[B
662 URxvt.keysym.Right: \033[C
663 URxvt.keysym.Left: \033[D
664
665See some more examples in the documentation for the B<keysym> resource.
666
667=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
668
669 KP_Insert == Insert
670 F22 == Print
671 F27 == Home
672 F29 == Prior
673 F33 == End
674 F35 == Next
675
676Rather than have rxvt-unicode try to accommodate all the various possible
677keyboard mappings, it is better to use `xmodmap' to remap the keys as
678required for your particular machine.
679
680
681=head2 Terminal Configuration
682
683=head3 Can I see a typical configuration?
684
685The default configuration tries to be xterm-like, which I don't like that
686much, but it's least surprise to regular users.
687
688As a rxvt or rxvt-unicode user, you are practically supposed to invest
689time into customising your terminal. To get you started, here is the
690author's .Xdefaults entries, with comments on what they do. It's certainly
691not I<typical>, but what's typical...
692
693 URxvt.cutchars: "()*,<>[]{}|'
694 URxvt.print-pipe: cat >/tmp/xxx
695
696These are just for testing stuff.
697
698 URxvt.imLocale: ja_JP.UTF-8
699 URxvt.preeditType: OnTheSpot,None
700
701This tells rxvt-unicode to use a special locale when communicating with
702the X Input Method, and also tells it to only use the OnTheSpot pre-edit
703type, which requires the C<xim-onthespot> perl extension but rewards me
704with correct-looking fonts.
705
706 URxvt.perl-lib: /root/lib/urxvt
707 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
708 URxvt.selection.pattern-0: ( at .*? line \\d+)
709 URxvt.selection.pattern-1: ^(/[^:]+):\
710 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
711 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
712
713This is my perl configuration. The first two set the perl library
714directory and also tells urxvt to use a large number of extensions. I
715develop for myself mostly, so I actually use most of the extensions I
716write.
717
718The selection stuff mainly makes the selection perl-error-message aware
719and tells it to convert perl error messages into vi-commands to load the
720relevant file and go to the error line number.
721
722 URxvt.scrollstyle: plain
723 URxvt.secondaryScroll: true
724
725As the documentation says: plain is the preferred scrollbar for the
726author. The C<secondaryScroll> configures urxvt to scroll in full-screen
727apps, like screen, so lines scrolled out of screen end up in urxvt's
728scrollback buffer.
729
730 URxvt.background: #000000
731 URxvt.foreground: gray90
732 URxvt.color7: gray90
733 URxvt.colorBD: #ffffff
734 URxvt.cursorColor: #e0e080
735 URxvt.throughColor: #8080f0
736 URxvt.highlightColor: #f0f0f0
737
738Some colours. Not sure which ones are being used or even non-defaults, but
739these are in my .Xdefaults. Most notably, they set foreground/background
740to light gray/black, and also make sure that the colour 7 matches the
741default foreground colour.
742
743 URxvt.underlineColor: yellow
744
745Another colour, makes underline lines look different. Sometimes hurts, but
746is mostly a nice effect.
747
748 URxvt.geometry: 154x36
749 URxvt.loginShell: false
750 URxvt.meta: ignore
751 URxvt.utmpInhibit: true
752
753Uh, well, should be mostly self-explanatory. By specifying some defaults
754manually, I can quickly switch them for testing.
755
756 URxvt.saveLines: 8192
757
758A large scrollback buffer is essential. Really.
759
760 URxvt.mapAlert: true
761
762The only case I use it is for my IRC window, which I like to keep
763iconified till people msg me (which beeps).
764
765 URxvt.visualBell: true
766
767The audible bell is often annoying, especially when in a crowd.
768
769 URxvt.insecure: true
770
771Please don't hack my mutt! Ooops...
772
773 URxvt.pastableTabs: false
774
775I once thought this is a great idea.
776
777 urxvt.font: 9x15bold,\
778 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
779 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
780 [codeset=JISX0208]xft:Kochi Gothic, \
781 xft:Bitstream Vera Sans Mono:autohint=true, \
782 xft:Code2000:antialias=false
783 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
784 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
785 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
786
787I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
788overwhelmed. A special note: the C<9x15bold> mentioned above is actually
789the version from XFree-3.3, as XFree-4 replaced it by a totally different
790font (different glyphs for C<;> and many other harmless characters),
791while the second font is actually the C<9x15bold> from XFree4/XOrg. The
792bold version has less chars than the medium version, so I use it for rare
793characters, too. When editing sources with vim, I use italic for comments
794and other stuff, which looks quite good with Bitstream Vera anti-aliased.
795
796Terminus is a quite bad font (many very wrong glyphs), but for most of my
797purposes, it works, and gives a different look, as my normal (Non-bold)
798font is already bold, and I want to see a difference between bold and
799normal fonts.
800
801Please note that I used the C<urxvt> instance name and not the C<URxvt>
802class name. That is because I use different configs for different purposes,
803for example, my IRC window is started with C<-name IRC>, and uses these
804defaults:
805
806 IRC*title: IRC
807 IRC*geometry: 87x12+535+542
808 IRC*saveLines: 0
809 IRC*mapAlert: true
810 IRC*font: suxuseuro
811 IRC*boldFont: suxuseuro
812 IRC*colorBD: white
813 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
814 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
815
816C<Alt-Ctrl-1> and C<Alt-Ctrl-2> switch between two different font
817sizes. C<suxuseuro> allows me to keep an eye (and actually read)
818stuff while keeping a very small window. If somebody pastes something
819complicated (e.g. japanese), I temporarily switch to a larger font.
820
821The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
822C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
823file for different hosts, for example, on my main desktop, I use:
824
825 URxvt.keysym.C-M-q: command:\033[3;5;5t
826 URxvt.keysym.C-M-y: command:\033[3;5;606t
827 URxvt.keysym.C-M-e: command:\033[3;1605;5t
828 URxvt.keysym.C-M-c: command:\033[3;1605;606t
829 URxvt.keysym.C-M-p: perl:test
830
831The first for keysym definitions allow me to quickly bring some windows
832in the layout I like most. Ion users might start laughing but will stop
833immediately when I tell them that I use my own Fvwm2 module for much the
834same effect as Ion provides, and I only very rarely use the above key
835combinations :->
836
837=head3 Why doesn't rxvt-unicode read my resources?
838
839Well, why, indeed? It does, in a way very similar to other X
840applications. Most importantly, this means that if you or your OS loads
841resources into the X display (the right way to do it), rxvt-unicode will
842ignore any resource files in your home directory. It will only read
843F<$HOME/.Xdefaults> when no resources are attached to the display.
844
845If you have or use an F<$HOME/.Xresources> file, chances are that
846resources are loaded into your X-server. In this case, you have to
847re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
848
849Also consider the form resources have to use:
850
851 URxvt.resource: value
852
853If you want to use another form (there are lots of different ways of
854specifying resources), make sure you understand whether and why it
855works. If unsure, use the form above.
856
857=head3 When I log-in to another system it tells me about missing terminfo data?
858
859The terminal description used by rxvt-unicode is not as widely available
860as that for xterm, or even rxvt (for which the same problem often arises).
861
862The correct solution for this problem is to install the terminfo, this can
863be done by simply installing rxvt-unicode on the remote system as well
864(in case you have a nice package manager ready), or you can install the
865terminfo database manually like this (with ncurses infocmp. works as
866user and root):
867
868 REMOTE=remotesystem.domain
869 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
870
871One some systems you might need to set C<$TERMINFO> to the full path of
872F<$HOME/.terminfo> for this to work.
873
874If you cannot or do not want to do this, then you can simply set
875C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
876problems arising, which includes wrong keymapping, less and different
877colours and some refresh errors in fullscreen applications. It's a nice
878quick-and-dirty workaround for rare cases, though.
879
880If you always want to do this (and are fine with the consequences) you
881can either recompile rxvt-unicode with the desired TERM value or use a
882resource to set it:
883
884 URxvt.termName: rxvt
885
886If you don't plan to use B<rxvt> (quite common...) you could also replace
887the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
888
889=head3 nano fails with "Error opening terminal: rxvt-unicode"
890
891This exceptionally confusing and useless error message is printed by nano
892when it can't find the terminfo database. Nothing is wrong with your
893terminal, read the previous answer for a solution.
894
895=head3 C<tic> outputs some error when compiling the terminfo entry.
896
897Most likely it's the empty definition for C<enacs=>. Just replace it by
898C<enacs=\E[0@> and try again.
899
900=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
901
902See next entry.
903
904=head3 I need a termcap file entry.
905
906One reason you might want this is that some distributions or operating
907systems still compile some programs using the long-obsoleted termcap
908library (Fedora's bash is one example) and rely on a termcap entry
909for C<rxvt-unicode>.
910
911You could use rxvt's termcap entry with reasonable results in many cases.
912You can also create a termcap entry by using terminfo's infocmp program
913like this:
914
915 infocmp -C rxvt-unicode
916
917Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap,
918generated by the command above.
919
920=head3 Why does C<ls> no longer have coloured output?
921
922The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
923decide whether a terminal has colour, but uses its own configuration
924file. Needless to say, C<rxvt-unicode> is not in its default file (among
925with most other terminals supporting colour). Either add:
926
927 TERM rxvt-unicode
928
929to C</etc/DIR_COLORS> or simply add:
930
931 alias ls='ls --color=auto'
932
933to your C<.profile> or C<.bashrc>.
934
935=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
936
937See next entry.
938
939=head3 Why doesn't vim/emacs etc. make use of italic?
940
941See next entry.
942
943=head3 Why are the secondary screen-related options not working properly?
944
945Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
946distributions break rxvt-unicode by setting C<TERM> to C<rxvt>, which
947doesn't have these extra features. Unfortunately, some of these
948furthermore fail to even install the C<rxvt-unicode> terminfo file, so
949you will need to install it on your own (See the question B<When I
950log-in to another system it tells me about missing terminfo data?> on
951how to do this).
952
953
954=head2 Encoding / Locale / Input Method Issues
955
956=head3 Rxvt-unicode does not seem to understand the selected encoding?
957
958See next entry.
959
960=head3 Unicode does not seem to work?
961
962If you encounter strange problems like typing an accented character but
963getting two unrelated other characters or similar, or if program output is
964subtly garbled, then you should check your locale settings.
965
966Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
967programs running in it. Often rxvt-unicode is started in the C<C> locale,
968while the login script running within the rxvt-unicode window changes the
969locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
970not going to work, and is the most common cause for problems.
971
972The best thing is to fix your startup environment, as you will likely run
973into other problems. If nothing works you can try this in your .profile.
974
975 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
976
977If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
978supported on your systems. Some systems have a C<locale> command which
979displays this (also, C<perl -e0> can be used to check locale settings, as
980it will complain loudly if it cannot set the locale). If it displays something
981like:
982
983 locale: Cannot set LC_CTYPE to default locale: ...
984
985Then the locale you specified is not supported on your system.
986
987If nothing works and you are sure that everything is set correctly then
988you will need to remember a little known fact: Some programs just don't
989support locales :(
990
991=head3 How does rxvt-unicode determine the encoding to use?
992
993See next entry.
994
995=head3 Is there an option to switch encodings?
996
997Unlike some other terminals, rxvt-unicode has no encoding switch, and no
998specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
999UTF-8 or any other encodings with respect to terminal I/O.
1000
1001The reasons is that there exists a perfectly fine mechanism for selecting
1002the encoding, doing I/O and (most important) communicating this to all
1003applications so everybody agrees on character properties such as width
1004and code number. This mechanism is the I<locale>. Applications not using
1005that info will have problems (for example, C<xterm> gets the width of
1006characters wrong as it uses its own, locale-independent table under all
1007locales).
1008
1009Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
1010programs doing the same (that is, most) will automatically agree in the
1011interpretation of characters.
1012
1013Unfortunately, there is no system-independent way to select locales, nor
1014is there a standard on how locale specifiers will look like.
1015
1016On most systems, the content of the C<LC_CTYPE> environment variable
1017contains an arbitrary string which corresponds to an already-installed
1018locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1019C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1020(i.e. C<de> or C<german>) are also common.
1021
1022Rxvt-unicode ignores all other locale categories, and except for
1023the encoding, ignores country or language-specific settings,
1024i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
1025rxvt-unicode.
1026
1027If you want to use a specific encoding you have to make sure you start
1028rxvt-unicode with the correct C<LC_CTYPE> category.
1029
1030=head3 Can I switch locales at runtime?
1031
1032Yes, using an escape sequence. Try something like this, which sets
1033rxvt-unicode's idea of C<LC_CTYPE>.
1034
1035 printf '\33]701;%s\007' ja_JP.SJIS
1036
1037See also the previous answer.
1038
1039Sometimes this capability is rather handy when you want to work in
1040one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
1041(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
1042first switches to a locale supported by xjdic and back later:
1043
1044 printf '\33]701;%s\007' ja_JP.SJIS
1045 xjdic -js
1046 printf '\33]701;%s\007' de_DE.UTF-8
1047
1048You can also use xterm's C<luit> program, which usually works fine, except
1049for some locales where character width differs between program- and
1050rxvt-unicode-locales.
1051
1052=head3 I have problems getting my input method working.
1053
1054Try a search engine, as this is slightly different for every input method server.
1055
1056Here is a checklist:
8 1057
9=over 4 1058=over 4
10 1059
1060=item - Make sure your locale I<and> the imLocale are supported on your OS.
1061
1062Try C<locale -a> or check the documentation for your OS.
1063
1064=item - Make sure your locale or imLocale matches a locale supported by your XIM.
1065
1066For example, B<kinput2> does not support UTF-8 locales, you should use
1067C<ja_JP.EUC-JP> or equivalent.
1068
1069=item - Make sure your XIM server is actually running.
1070
1071=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1072
1073When you want to use e.g. B<kinput2>, it must be set to
1074C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1075method servers are running with this command:
1076
1077 xprop -root XIM_SERVERS
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 maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
1108
1109You should build one binary with the default options. F<configure>
1110now enables most useful options, and the trend goes to making them
1111runtime-switchable, too, so there is usually no drawback to enabling them,
1112except higher disk and possibly memory usage. The perl interpreter should
1113be enabled, as important functionality (menus, selection, likely more in
1114the future) depends on it.
1115
1116You should not overwrite the C<perl-ext-common> and C<perl-ext> resources
1117system-wide (except maybe with C<defaults>). This will result in useful
1118behaviour. If your distribution aims at low memory, add an empty
1119C<perl-ext-common> resource to the app-defaults file. This will keep the
1120perl interpreter disabled until the user enables it.
1121
1122If you can/want build more binaries, I recommend building a minimal
1123one with C<--disable-everything> (very useful) and a maximal one with
1124C<--enable-everything> (less useful, it will be very big due to a lot of
1125encodings built-in that increase download times and are rarely used).
1126
1127=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
1128
1129It should be, starting with release 7.1. You are encouraged to properly
1130install urxvt with privileges necessary for your OS now.
1131
1132When rxvt-unicode detects that it runs setuid or setgid, it will fork
1133into a helper process for privileged operations (pty handling on some
1134systems, utmp/wtmp/lastlog handling on others) and drop privileges
1135immediately. This is much safer than most other terminals that keep
1136privileges while running (but is more relevant to urxvt, as it contains
1137things as perl interpreters, which might be "helpful" to attackers).
1138
1139This forking is done as the very first within main(), which is very early
1140and reduces possible bugs to initialisation code run before main(), or
1141things like the dynamic loader of your system, which should result in very
1142little risk.
1143
1144=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
1145
1146Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1147in your compile environment, or an implementation that implements it,
1148whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
1149B<wchar_t> is represented as unicode.
1150
1151As you might have guessed, FreeBSD does neither define this symbol nor
1152does it support it. Instead, it uses its own internal representation of
1153B<wchar_t>. This is, of course, completely fine with respect to standards.
1154
1155However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
1156C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>).
1157
1158C<__STDC_ISO_10646__> is the only sane way to support multi-language
1159apps in an OS, as using a locale-dependent (and non-standardized)
1160representation of B<wchar_t> makes it impossible to convert between
1161B<wchar_t> (as used by X11 and your applications) and any other encoding
1162without implementing OS-specific-wrappers for each and every locale. There
1163simply are no APIs to convert B<wchar_t> into anything except the current
1164locale encoding.
1165
1166Some applications (such as the formidable B<mlterm>) work around this
1167by carrying their own replacement functions for character set handling
1168with them, and either implementing OS-dependent hacks or doing multiple
1169conversions (which is slow and unreliable in case the OS implements
1170encodings slightly different than the terminal emulator).
1171
1172The rxvt-unicode author insists that the right way to fix this is in the
1173system libraries once and for all, instead of forcing every app to carry
1174complete replacements for them :)
1175
1176=head3 How can I use rxvt-unicode under cygwin?
1177
1178rxvt-unicode should compile and run out of the box on cygwin, using
1179the X11 libraries that come with cygwin. libW11 emulation is no
1180longer supported (and makes no sense, either, as it only supported a
1181single font). I recommend starting the X-server in C<-multiwindow> or
1182C<-rootless> mode instead, which will result in similar look&feel as the
1183old libW11 emulation.
1184
1185At the time of this writing, cygwin didn't seem to support any multi-byte
1186encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1187to 8-bit encodings.
1188
1189=head3 Character widths are not correct.
1190
1191urxvt uses the system wcwidth function to know the information about
1192the width of characters, so on systems with incorrect locale data you
1193will likely get bad results. Two notorious examples are Solaris 9,
1194where single-width characters like U+2514 are reported as double-width,
1195and Darwin 8, where combining chars are reported having width 1.
1196
1197The solution is to upgrade your system or switch to a better one. A
1198possibly working workaround is to use a wcwidth implementation like
1199
1200http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1201
1202=head1 RXVT-UNICODE TECHNICAL REFERENCE
1203
1204The rest of this document describes various technical aspects of
1205B<rxvt-unicode>. First the description of supported command sequences,
1206followed by pixmap support and last by a description of all features
1207selectable at C<configure> time.
1208
1209=head2 Definitions
1210
1211=over 4
1212
11=item B<< C<c> >> 1213=item B<< C<c> >>
12 1214
13The literal character c. 1215The literal character c (potentially a multi-byte character).
14 1216
15=item B<< C<C> >> 1217=item B<< C<C> >>
16 1218
17A single (required) character. 1219A single (required) character.
18 1220
… …
30 1232
31A text parameter composed of printable characters. 1233A text parameter composed of printable characters.
32 1234
33=back 1235=back
34 1236
35=head1 Values 1237=head2 Values
36 1238
37=over 4 1239=over 4
38 1240
39=item B<< C<ENQ> >> 1241=item B<< C<ENQ> >>
40 1242
41Enquiry (Ctrl-E) = Send Device Attributes (DA) 1243Enquiry (Ctrl-E) = Send Device Attributes (DA)
42request attributes from terminal == 1244request attributes from terminal. See B<< C<ESC [ Ps c> >>.
43 1245
44=item B<< C<BEL> >> 1246=item B<< C<BEL> >>
45 1247
46Bell (Ctrl-G) 1248Bell (Ctrl-G)
47 1249
… …
77=item B<< C<SI> >> 1279=item B<< C<SI> >>
78 1280
79Shift In (Ctrl-O), invokes the G0 character set (the default). 1281Shift In (Ctrl-O), invokes the G0 character set (the default).
80Switch to Standard Character Set 1282Switch to Standard Character Set
81 1283
82=item B<< C<SPC> >> 1284=item B<< C<SP> >>
83 1285
84Space Character 1286Space Character
85 1287
86=back 1288=back
87 1289
88=head1 Escape Sequences 1290=head2 Escape Sequences
89 1291
90=over 4 1292=over 4
91 1293
92=item B<< C<ESC # 8> >> 1294=item B<< C<ESC # 8> >>
93 1295
… …
103 1305
104=item B<< C<ESC => >> 1306=item B<< C<ESC => >>
105 1307
106Application Keypad (SMKX). See also next sequence. 1308Application Keypad (SMKX). See also next sequence.
107 1309
108=item B<<< C<< ESC >> >>> 1310=item B<<< C<< ESC > >> >>>
109 1311
110Normal Keypad (RMKX) 1312Normal Keypad (RMKX)
111 1313
112B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been
113pressed, numbers or control functions are generated by the numeric keypad 1314B<Note:> numbers or control functions are generated by the numeric
114(see Key Codes). 1315keypad in normal or application mode, respectively (see Key Codes).
1316
115 1317
116=item B<< C<ESC D> >> 1318=item B<< C<ESC D> >>
117 1319
118Index (IND) 1320Index (IND)
119 1321
… …
139Single Shift Select of G3 Character Set (SS3): affects next character 1341Single Shift Select of G3 Character Set (SS3): affects next character
140only I<unimplemented> 1342only I<unimplemented>
141 1343
142=item B<< C<ESC Z> >> 1344=item B<< C<ESC Z> >>
143 1345
144Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt compile-time option> 1346Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
145 1347
146=item B<< C<ESC c> >> 1348=item B<< C<ESC c> >>
147 1349
148Full reset (RIS) 1350Full reset (RIS)
149 1351
… …
153 1355
154=item B<< C<ESC o> >> 1356=item B<< C<ESC o> >>
155 1357
156Invoke the G3 Character Set (LS3) 1358Invoke the G3 Character Set (LS3)
157 1359
158=item B<< C<ESC>(C<C> >> 1360=item B<< C<ESC ( C> >>
159 1361
160Designate G0 Character Set (ISO 2022), see below for values of C<C>. 1362Designate G0 Character Set (ISO 2022), see below for values of C<C>.
161 1363
162=item B<< C<ESC>)C<C> >> 1364=item B<< C<ESC ) C> >>
163 1365
164Designate G1 Character Set (ISO 2022), see below for values of C<C>. 1366Designate G1 Character Set (ISO 2022), see below for values of C<C>.
165 1367
166=item B<< C<ESC * C> >> 1368=item B<< C<ESC * C> >>
167 1369
… …
177 1379
178Where B<< C<C> >> is one of: 1380Where B<< C<C> >> is one of:
179 1381
180=begin table 1382=begin table
181 1383
182 C = C<0> DEC Special Character and Line Drawing Set 1384 C = C<0> DEC Special Character and Line Drawing Set
183 C = C<A> United Kingdom (UK) 1385 C = C<A> United Kingdom (UK)
184 C = C<B> United States (USASCII) 1386 C = C<B> United States (USASCII)
185 C = C<< < >> Multinational character set I<unimplemented> 1387 C = C<< < >> Multinational character set I<unimplemented>
186 C = C<5> Finnish character set I<unimplemented> 1388 C = C<5> Finnish character set I<unimplemented>
187 C = C<C> Finnish character set I<unimplemented> 1389 C = C<C> Finnish character set I<unimplemented>
188 C = C<K> German character set I<unimplemented> 1390 C = C<K> German character set I<unimplemented>
189 1391
190=end table 1392=end table
191 1393
192=back 1394=back
193 1395
194X<CSI> 1396X<CSI>
195 1397
196=head1 CSI (Code Sequence Introducer) Sequences 1398=head2 CSI (Command Sequence Introducer) Sequences
197 1399
198=over 4 1400=over 4
199 1401
200=item B<< C<ESC [ Ps @> >> 1402=item B<< C<ESC [ Ps @> >>
201 1403
… …
241 1443
242Erase in Display (ED) 1444Erase in Display (ED)
243 1445
244=begin table 1446=begin table
245 1447
246 B<< C<Ps = 0> >> Clear Below (default) 1448 B<< C<Ps = 0> >> Clear Right and Below (default)
247 B<< C<Ps = 1> >> Clear Above 1449 B<< C<Ps = 1> >> Clear Left and Above
248 B<< C<Ps = 2> >> Clear All 1450 B<< C<Ps = 2> >> Clear All
249 1451
250=end table 1452=end table
251 1453
252=item B<< C<ESC [ Ps K> >> 1454=item B<< C<ESC [ Ps K> >>
… …
256=begin table 1458=begin table
257 1459
258 B<< C<Ps = 0> >> Clear to Right (default) 1460 B<< C<Ps = 0> >> Clear to Right (default)
259 B<< C<Ps = 1> >> Clear to Left 1461 B<< C<Ps = 1> >> Clear to Left
260 B<< C<Ps = 2> >> Clear All 1462 B<< C<Ps = 2> >> Clear All
1463 B<< C<Ps = 3> >> Like Ps = 0, but is ignored when wrapped
1464 (@@RXVT_NAME@@ extension)
261 1465
262=end table 1466=end table
263 1467
264=item B<< C<ESC [ Ps L> >> 1468=item B<< C<ESC [ Ps L> >>
265 1469
… …
298 1502
299Move backward B<< C<Ps> >> [default: 1] tab stops 1503Move backward B<< C<Ps> >> [default: 1] tab stops
300 1504
301=item B<< C<ESC [ Ps '> >> 1505=item B<< C<ESC [ Ps '> >>
302 1506
303== 1507See B<< C<ESC [ Ps G> >>
304 1508
305=item B<< C<ESC [ Ps a> >> 1509=item B<< C<ESC [ Ps a> >>
306 1510
307==X<ESCOBPsc> 1511See B<< C<ESC [ Ps C> >>
308 1512
309=item B<< C<ESC [ Ps c> >> 1513=item B<< C<ESC [ Ps c> >>
310 1514
311Send Device Attributes (DA) 1515Send Device Attributes (DA)
312B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1516B<< C<Ps = 0> >> (or omitted): request attributes from terminal
313returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1517returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
314Option'') 1518Option'')
315 1519
316=item B<< C<ESC [ Ps d> >> 1520=item B<< C<ESC [ Ps d> >>
317 1521
318Cursor to Line B<< C<Ps> >> (VPA) 1522Cursor to Line B<< C<Ps> >> (VPA)
319 1523
320=item B<< C<ESC [ Ps e> >> 1524=item B<< C<ESC [ Ps e> >>
321 1525
322== 1526See B<< C<ESC [ Ps A> >>
323 1527
324=item B<< C<ESC [ Ps;Ps f> >> 1528=item B<< C<ESC [ Ps;Ps f> >>
325 1529
326Horizontal and Vertical Position [row;column] (HVP) [default: 1;1] 1530Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]
327 1531
… …
334 B<< C<Ps = 0> >> Clear Current Column (default) 1538 B<< C<Ps = 0> >> Clear Current Column (default)
335 B<< C<Ps = 3> >> Clear All (TBC) 1539 B<< C<Ps = 3> >> Clear All (TBC)
336 1540
337=end table 1541=end table
338 1542
1543=item B<< C<ESC [ Pm h> >>
1544
1545Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
1546
339=item B<< C<ESC [ Ps i> >> 1547=item B<< C<ESC [ Ps i> >>
340 1548
341Printing 1549Printing. See also the C<print-pipe> resource.
342 1550
343=begin table 1551=begin table
344 1552
1553 B<< C<Ps = 0> >> print screen (MC0)
345 B<< C<Ps = 4> >> disable transparent print mode (MC4) 1554 B<< C<Ps = 4> >> disable transparent print mode (MC4)
346 B<< C<Ps = 5> >> enable transparent print mode (MC5) I<unimplemented> 1555 B<< C<Ps = 5> >> enable transparent print mode (MC5)
347 1556
348=end table 1557=end table
349
350=item B<< C<ESC [ Pm h> >>
351
352Set Mode (SM). See next sequence for description of C<Pm>.
353 1558
354=item B<< C<ESC [ Pm l> >> 1559=item B<< C<ESC [ Pm l> >>
355 1560
356Reset Mode (RM) 1561Reset Mode (RM)
357 1562
… …
364 B<< C<h> >> Insert Mode (SMIR) 1569 B<< C<h> >> Insert Mode (SMIR)
365 B<< C<l> >> Replace Mode (RMIR) 1570 B<< C<l> >> Replace Mode (RMIR)
366 1571
367=end table 1572=end table
368 1573
369=item B<< C<Ps = 20> >> I<unimplemented> 1574=item B<< C<Ps = 20> >> (partially implemented)
370 1575
371=begin table 1576=begin table
372 1577
373 B<< C<h> >> Automatic Newline (LNM) 1578 B<< C<h> >> Automatic Newline (LNM)
374 B<< C<h> >> Normal Linefeed (LNM) 1579 B<< C<l> >> Normal Linefeed (LNM)
375 1580
376=end table 1581=end table
377 1582
378=back 1583=back
379 1584
… …
381 1586
382Character Attributes (SGR) 1587Character Attributes (SGR)
383 1588
384=begin table 1589=begin table
385 1590
386 B<< C<Ps = 0> >> Normal (default) 1591 B<< C<Pm = 0> >> Normal (default)
387 B<< C<Ps = 1 / 22> >> On / Off Bold (bright fg) 1592 B<< C<Pm = 1 / 21> >> On / Off Bold (bright fg)
1593 B<< C<Pm = 3 / 23> >> On / Off Italic
388 B<< C<Ps = 4 / 24> >> On / Off Underline 1594 B<< C<Pm = 4 / 24> >> On / Off Underline
389 B<< C<Ps = 5 / 25> >> On / Off Blink (bright bg) 1595 B<< C<Pm = 5 / 25> >> On / Off Slow Blink (bright bg)
1596 B<< C<Pm = 6 / 26> >> On / Off Rapid Blink (bright bg)
390 B<< C<Ps = 7 / 27> >> On / Off Inverse 1597 B<< C<Pm = 7 / 27> >> On / Off Inverse
1598 B<< C<Pm = 8 / 27> >> On / Off Invisible (NYI)
391 B<< C<Ps = 30 / 40> >> fg/bg Black 1599 B<< C<Pm = 30 / 40> >> fg/bg Black
392 B<< C<Ps = 31 / 41> >> fg/bg Red 1600 B<< C<Pm = 31 / 41> >> fg/bg Red
393 B<< C<Ps = 32 / 42> >> fg/bg Green 1601 B<< C<Pm = 32 / 42> >> fg/bg Green
394 B<< C<Ps = 33 / 43> >> fg/bg Yellow 1602 B<< C<Pm = 33 / 43> >> fg/bg Yellow
395 B<< C<Ps = 34 / 44> >> fg/bg Blue 1603 B<< C<Pm = 34 / 44> >> fg/bg Blue
396 B<< C<Ps = 35 / 45> >> fg/bg Magenta 1604 B<< C<Pm = 35 / 45> >> fg/bg Magenta
397 B<< C<Ps = 36 / 46> >> fg/bg Cyan 1605 B<< C<Pm = 36 / 46> >> fg/bg Cyan
398 B<< C<Ps = 37 / 47> >> fg/bg White 1606 B<< C<Pm = 37 / 47> >> fg/bg White
1607 B<< C<Pm = 38;5 / 48;5> >> set fg/bg to colour #m (ISO 8613-6)
1608 B<< C<Pm = 38;2;R;G;B> >> set fg to 24-bit colour #RGB (ISO 8613-3)
1609 B<< C<Pm = 48;2;R;G;B> >> set bg to 24-bit colour #RGB (ISO 8613-3)
399 B<< C<Ps = 39 / 49> >> fg/bg Default 1610 B<< C<Pm = 39 / 49> >> fg/bg Default
1611 B<< C<Pm = 90 / 100> >> fg/bg Bright Black
1612 B<< C<Pm = 91 / 101> >> fg/bg Bright Red
1613 B<< C<Pm = 92 / 102> >> fg/bg Bright Green
1614 B<< C<Pm = 93 / 103> >> fg/bg Bright Yellow
1615 B<< C<Pm = 94 / 104> >> fg/bg Bright Blue
1616 B<< C<Pm = 95 / 105> >> fg/bg Bright Magenta
1617 B<< C<Pm = 96 / 106> >> fg/bg Bright Cyan
1618 B<< C<Pm = 97 / 107> >> fg/bg Bright White
1619 B<< C<Pm = 99 / 109> >> fg/bg Bright Default
400 1620
401=end table 1621=end table
402 1622
403=item B<< C<ESC [ Ps n> >> 1623=item B<< C<ESC [ Ps n> >>
404 1624
… …
411 B<< C<Ps = 7> >> Request Display Name 1631 B<< C<Ps = 7> >> Request Display Name
412 B<< C<Ps = 8> >> Request Version Number (place in window title) 1632 B<< C<Ps = 8> >> Request Version Number (place in window title)
413 1633
414=end table 1634=end table
415 1635
1636=item B<< C<ESC [ Ps SP q> >>
1637
1638Set Cursor Style (DECSCUSR)
1639
1640=begin table
1641
1642 B<< C<Ps = 0> >> Blink Block
1643 B<< C<Ps = 1> >> Blink Block
1644 B<< C<Ps = 2> >> Steady Block
1645 B<< C<Ps = 3> >> Blink Underline
1646 B<< C<Ps = 4> >> Steady Underline
1647 B<< C<Ps = 5> >> Blink Bar (XTerm)
1648 B<< C<Ps = 6> >> Steady Bar (XTerm)
1649
1650=end table
1651
416=item B<< C<ESC [ Ps;Ps r> >> 1652=item B<< C<ESC [ Ps;Ps r> >>
417 1653
418Set Scrolling Region [top;bottom] 1654Set Scrolling Region [top;bottom]
419[default: full size of window] (CSR) 1655[default: full size of window] (CSR)
420 1656
421=item B<< C<ESC [ s> >> 1657=item B<< C<ESC [ s> >>
422 1658
423Save Cursor (SC) 1659Save Cursor (SC)
424 1660
1661=item B<< C<ESC [ Ps;Pt t> >>
1662
1663Window Operations
1664
1665=begin table
1666
1667 B<< C<Ps = 1> >> Deiconify (map) window
1668 B<< C<Ps = 2> >> Iconify window
1669 B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1670 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1671 B<< C<Ps = 5> >> Raise window
1672 B<< C<Ps = 6> >> Lower window
1673 B<< C<Ps = 7> >> Refresh screen once
1674 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1675 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1676 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1677 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1678 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1679 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1680 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1681 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
1682 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1683
1684=end table
1685
1686=item B<< C<ESC [ u> >>
1687
1688Restore Cursor
1689
425=item B<< C<ESC [ Ps x> >> 1690=item B<< C<ESC [ Ps x> >>
426 1691
427Request Terminal Parameters (DECREQTPARM) 1692Request Terminal Parameters (DECREQTPARM)
428 1693
429=item B<< C<ESC [ u> >>
430
431Restore Cursor
432
433=back 1694=back
434 1695
435X<PrivateModes> 1696X<PrivateModes>
436 1697
437=head1 DEC Private Modes 1698=head2 DEC Private Modes
438 1699
439=over 4 1700=over 4
440 1701
441=item B<< C<ESC [ ? Pm h> >> 1702=item B<< C<ESC [ ? Pm h> >>
442 1703
… …
458 1719
459Toggle DEC Private Mode Values (rxvt extension). I<where> 1720Toggle DEC Private Mode Values (rxvt extension). I<where>
460 1721
461=over 4 1722=over 4
462 1723
463=item B<< C<Ps = 1> >> (DECCKM) 1724=item B<< C<Pm = 1> >> (DECCKM)
464 1725
465=begin table 1726=begin table
466 1727
467 B<< C<h> >> Application Cursor Keys 1728 B<< C<h> >> Application Cursor Keys
468 B<< C<l> >> Normal Cursor Keys 1729 B<< C<l> >> Normal Cursor Keys
469 1730
470=end table 1731=end table
471 1732
472=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1733=item B<< C<Pm = 2> >> (DECANM)
473 1734
474=begin table 1735=begin table
475 1736
476 B<< C<h> >> Enter VT52 mode 1737 B<< C<h> >> Enter VT52 mode
477 B<< C<l> >> Enter VT52 mode 1738 B<< C<l> >> Enter VT52 mode
478 1739
479=end table 1740=end table
480 1741
481=item B<< C<Ps = 3> >> 1742=item B<< C<Pm = 3> >> (DECCOLM)
482 1743
483=begin table 1744=begin table
484 1745
485 B<< C<h> >> 132 Column Mode (DECCOLM) 1746 B<< C<h> >> 132 Column Mode
486 B<< C<l> >> 80 Column Mode (DECCOLM) 1747 B<< C<l> >> 80 Column Mode
487 1748
488=end table
489
490=item B<< C<Ps = 4> >>
491
492=begin table 1749=end table
493 1750
1751=item B<< C<Pm = 4> >> (DECSCLM)
1752
1753=begin table
1754
494 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1755 B<< C<h> >> Smooth (Slow) Scroll
495 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1756 B<< C<l> >> Jump (Fast) Scroll
496 1757
497=end table
498
499=item B<< C<Ps = 5> >>
500
501=begin table 1758=end table
502 1759
1760=item B<< C<Pm = 5> >> (DECSCNM)
1761
1762=begin table
1763
503 B<< C<h> >> Reverse Video (DECSCNM) 1764 B<< C<h> >> Reverse Video
504 B<< C<l> >> Normal Video (DECSCNM) 1765 B<< C<l> >> Normal Video
505 1766
506=end table
507
508=item B<< C<Ps = 6> >>
509
510=begin table 1767=end table
511 1768
1769=item B<< C<Pm = 6> >> (DECOM)
1770
1771=begin table
1772
512 B<< C<h> >> Origin Mode (DECOM) 1773 B<< C<h> >> Origin Mode
513 B<< C<l> >> Normal Cursor Mode (DECOM) 1774 B<< C<l> >> Normal Cursor Mode
514 1775
515=end table
516
517=item B<< C<Ps = 7> >>
518
519=begin table 1776=end table
520 1777
1778=item B<< C<Pm = 7> >> (DECAWM)
1779
1780=begin table
1781
521 B<< C<h> >> Wraparound Mode (DECAWM) 1782 B<< C<h> >> Wraparound Mode
522 B<< C<l> >> No Wraparound Mode (DECAWM) 1783 B<< C<l> >> No Wraparound Mode
523 1784
524=end table 1785=end table
525 1786
526=item B<< C<Ps = 8> >> I<unimplemented> 1787=item B<< C<Pm = 8> >> (DECARM) I<unimplemented>
527 1788
528=begin table 1789=begin table
529 1790
530 B<< C<h> >> Auto-repeat Keys (DECARM) 1791 B<< C<h> >> Auto-repeat Keys
531 B<< C<l> >> No Auto-repeat Keys (DECARM) 1792 B<< C<l> >> No Auto-repeat Keys
532 1793
533=end table 1794=end table
534 1795
535=item B<< C<Ps = 9> >> X10 XTerm 1796=item B<< C<Pm = 9> >> (X10 XTerm mouse protocol)
536 1797
537=begin table 1798=begin table
538 1799
539 B<< C<h> >> Send Mouse X & Y on button press. 1800 B<< C<h> >> Send Mouse X & Y on button press.
540 B<< C<l> >> No mouse reporting. 1801 B<< C<l> >> No mouse reporting.
541 1802
542=end table 1803=end table
543 1804
544)X<Priv10> 1805=item B<< C<Pm = 12> >> (AT&T 610, XTerm)
545 1806
546=item B<< C<Ps = 10> >> (B<rxvt>)
547
548=begin table
549
550 B<< C<h> >> visible
551 B<< C<l> >> invisible
552
553=end table 1807=begin table
554 1808
1809 B<< C<h> >> Blinking cursor (cvvis)
1810 B<< C<l> >> Steady cursor (cnorm)
1811
1812=end table
1813
555=item B<< C<Ps = 25> >> 1814=item B<< C<Pm = 25> >> (DECTCEM)
556 1815
557=begin table 1816=begin table
558 1817
559 B<< C<h> >> Visible cursor {cnorm/cvvis} 1818 B<< C<h> >> Visible cursor {cnorm/cvvis}
560 B<< C<l> >> Invisible cursor {civis} 1819 B<< C<l> >> Invisible cursor {civis}
561 1820
562=end table 1821=end table
563 1822
564=item B<< C<Ps = 30> >> 1823=item B<< C<Pm = 30> >> (B<rxvt>)
565 1824
566=begin table 1825=begin table
567 1826
568 B<< C<h> >> scrollBar visisble 1827 B<< C<h> >> scrollBar visible
569 B<< C<l> >> scrollBar invisisble 1828 B<< C<l> >> scrollBar invisible
570 1829
571=end table 1830=end table
572 1831
573=item B<< C<Ps = 35> >> (B<rxvt>) 1832=item B<< C<Pm = 35> >> (B<rxvt>)
574 1833
575=begin table 1834=begin table
576 1835
577 B<< C<h> >> Allow XTerm Shift+key sequences 1836 B<< C<h> >> Allow XTerm Shift+key sequences
578 B<< C<l> >> Disallow XTerm Shift+key sequences 1837 B<< C<l> >> Disallow XTerm Shift+key sequences
579 1838
580=end table 1839=end table
581 1840
582=item B<< C<Ps = 38> >> I<unimplemented> 1841=item B<< C<Pm = 38> >> I<unimplemented>
583 1842
584Enter Tektronix Mode (DECTEK) 1843Enter Tektronix Mode (DECTEK)
585 1844
586=item B<< C<Ps = 40> >> 1845=item B<< C<Pm = 40> >>
587 1846
588=begin table 1847=begin table
589 1848
590 B<< C<h> >> Allow 80/132 Mode 1849 B<< C<h> >> Allow 80/132 Mode
591 B<< C<l> >> Disallow 80/132 Mode 1850 B<< C<l> >> Disallow 80/132 Mode
592 1851
593=end table 1852=end table
594 1853
595=item B<< C<Ps = 44> >> I<unimplemented> 1854=item B<< C<Pm = 44> >> I<unimplemented>
596 1855
597=begin table 1856=begin table
598 1857
599 B<< C<h> >> Turn On Margin Bell 1858 B<< C<h> >> Turn On Margin Bell
600 B<< C<l> >> Turn Off Margin Bell 1859 B<< C<l> >> Turn Off Margin Bell
601 1860
602=end table 1861=end table
603 1862
604=item B<< C<Ps = 45> >> I<unimplemented> 1863=item B<< C<Pm = 45> >> I<unimplemented>
605 1864
606=begin table 1865=begin table
607 1866
608 B<< C<h> >> Reverse-wraparound Mode 1867 B<< C<h> >> Reverse-wraparound Mode
609 B<< C<l> >> No Reverse-wraparound Mode 1868 B<< C<l> >> No Reverse-wraparound Mode
610 1869
611=end table 1870=end table
612 1871
613=item B<< C<Ps = 46> >> I<unimplemented> 1872=item B<< C<Pm = 46> >> I<unimplemented>
614 1873
615=item B<< C<Ps = 47> >> 1874=item B<< C<Pm = 47> >>
616 1875
617=begin table 1876=begin table
618 1877
619 B<< C<h> >> Use Alternate Screen Buffer 1878 B<< C<h> >> Use Alternate Screen Buffer
620 B<< C<l> >> Use Normal Screen Buffer 1879 B<< C<l> >> Use Normal Screen Buffer
621 1880
622=end table 1881=end table
623 1882
624X<Priv66> 1883X<Priv66>
625 1884
626=item B<< C<Ps = 66> >> 1885=item B<< C<Pm = 66> >> (DECNKM)
627 1886
628=begin table 1887=begin table
629 1888
630 B<< C<h> >> Application Keypad (DECPAM) == 1889 B<< C<h> >> Application Keypad (DECKPAM/DECPAM) == C<ESC =>
631 B<< C<l> >> Normal Keypad (DECPNM) == 1890 B<< C<l> >> Normal Keypad (DECKPNM/DECPNM) == C<< ESC > >>
632 1891
633=end table
634
635=item B<< C<Ps = 67> >>
636
637=begin table 1892=end table
638 1893
1894=item B<< C<Pm = 67> >> (DECBKM)
1895
1896=begin table
1897
639 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1898 B<< C<h> >> Backspace key sends B<< C<BS> >>
640 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1899 B<< C<l> >> Backspace key sends B<< C<DEL> >>
641 1900
642=end table 1901=end table
643 1902
644=item B<< C<Ps = 1000> >> (X11 XTerm) 1903=item B<< C<Pm = 1000> >> (X11 XTerm mouse protocol)
645 1904
646=begin table 1905=begin table
647 1906
648 B<< C<h> >> Send Mouse X & Y on button press and release. 1907 B<< C<h> >> Send Mouse X & Y on button press and release.
649 B<< C<l> >> No mouse reporting. 1908 B<< C<l> >> No mouse reporting.
650 1909
651=end table 1910=end table
652 1911
653=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1912=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
654 1913
655=begin table 1914=begin table
656 1915
657 B<< C<h> >> Use Hilite Mouse Tracking. 1916 B<< C<h> >> Use Hilite Mouse Tracking.
658 B<< C<l> >> No mouse reporting. 1917 B<< C<l> >> No mouse reporting.
659 1918
660=end table 1919=end table
661 1920
1921=item B<< C<Pm = 1002> >> (X11 XTerm cell motion mouse tracking)
1922
1923=begin table
1924
1925 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1926 B<< C<l> >> No mouse reporting.
1927
1928=end table
1929
1930=item B<< C<Pm = 1003> >> (X11 XTerm all motion mouse tracking)
1931
1932=begin table
1933
1934 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1935 B<< C<l> >> No mouse reporting.
1936
1937=end table
1938
1939=item B<< C<Pm = 1004> >> (X11 XTerm focus in/focus out events)
1940
1941=begin table
1942
1943 B<< C<h> >> Send Mouse focus in/focus out events.
1944 B<< C<l> >> Don't send focus events.
1945
1946=end table
1947
1948=item B<< C<Pm = 1005> >> (X11 XTerm UTF-8 mouse mode) (Compile frills)
1949
1950Try to avoid this mode, it doesn't work sensibly in non-UTF-8 locales. Use
1951mode C<1015> instead.
1952
1953Unlike XTerm, coordinates larger than 2015 will work fine.
1954
1955=begin table
1956
1957 B<< C<h> >> Enable mouse coordinates in locale-specific encoding.
1958 B<< C<l> >> Enable mouse coordinates as binary octets.
1959
1960=end table
1961
662=item B<< C<Ps = 1010> >> 1962=item B<< C<Pm = 1010> >> (B<rxvt>)
663 1963
664=begin table 1964=begin table
665 1965
666 B<< C<h> >> Don't scroll to bottom on TTY output 1966 B<< C<h> >> Don't scroll to bottom on TTY output
667 B<< C<l> >> Scroll to bottom on TTY output 1967 B<< C<l> >> Scroll to bottom on TTY output
668 1968
669=end table 1969=end table
670 1970
671=item B<< C<Ps = 1011> >> 1971=item B<< C<Pm = 1011> >> (B<rxvt>)
672 1972
673=begin table 1973=begin table
674 1974
675 B<< C<h> >> Scroll to bottom when a key is pressed 1975 B<< C<h> >> Scroll to bottom when a key is pressed
676 B<< C<l> >> Don't scroll to bottom when a key is pressed 1976 B<< C<l> >> Don't scroll to bottom when a key is pressed
677 1977
678=end table 1978=end table
679 1979
680=item B<< C<Ps = 1047> >> 1980=item B<< C<Pm = 1015> >> (B<rxvt-unicode>) (Compile frills)
1981
1982=begin table
1983
1984 B<< C<h> >> Enable urxvt mouse coordinate reporting.
1985 B<< C<l> >> Use old-style C<CSI M C C C> encoding.
1986
1987=end table
1988
1989Changes all mouse reporting codes to use decimal parameters instead of
1990octets or characters.
1991
1992This mode should be enabled I<before> actually enabling mouse reporting,
1993for semi-obvious reasons.
1994
1995The sequences received for various modes are as follows:
1996
1997 ESC [ M o o o !1005, !1015 (three octets)
1998 ESC [ M c c c 1005, !1015 (three characters)
1999 ESC [ Pm M 1015 (three or more numeric parameters)
2000
2001The first three parameters are C<code>, C<x> and C<y>. Code is the numeric
2002code as for the other modes (but encoded as a decimal number, including
2003the additional offset of 32, so you have to subtract 32 first), C<x> and
2004C<y> are the coordinates (1|1 is the upper left corner, just as with
2005cursor positioning).
2006
2007Example: Shift-Button-1 press at top row, column 80.
2008
2009 ESC [ 37 ; 80 ; 1 M
2010
2011One can use this feature by simply enabling it and then looking for
2012parameters to the C<ESC [ M> reply - if there are any, this mode is
2013active, otherwise one of the old reporting styles is used.
2014
2015Other (to be implemented) reply sequences will use a similar encoding.
2016
2017In the future, more parameters might get added (pixel coordinates for
2018example - anybody out there who needs this?).
2019
2020=item B<< C<Pm = 1021> >> (B<rxvt>)
2021
2022=begin table
2023
2024 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
2025 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
2026
2027=end table
2028
2029=item B<< C<Pm = 1047> >> (X11 XTerm alternate screen buffer)
681 2030
682=begin table 2031=begin table
683 2032
684 B<< C<h> >> Use Alternate Screen Buffer 2033 B<< C<h> >> Use Alternate Screen Buffer
685 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 2034 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
686 2035
687=end table 2036=end table
688 2037
689=item B<< C<Ps = 1048> >> 2038=item B<< C<Pm = 1048> >> (X11 XTerm alternate DECSC)
690 2039
691=begin table 2040=begin table
692 2041
693 B<< C<h> >> Save cursor position 2042 B<< C<h> >> Save cursor position
694 B<< C<l> >> Restore cursor position 2043 B<< C<l> >> Restore cursor position
695 2044
696=end table 2045=end table
697 2046
2047=item B<< C<Pm = 1049> >> (X11 XTerm 1047 + 1048)
2048
2049=begin table
2050
2051 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
2052 B<< C<l> >> Use Normal Screen Buffer
2053
2054=end table
2055
2056=item B<< C<Pm = 2004> >> (X11 XTerm bracketed paste mode)
2057
2058=begin table
2059
2060 B<< C<h> >> Enable bracketed paste mode - prepend / append to the pasted text the control sequences C<ESC [ 200 ~> / C<ESC [ 201 ~>
2061 B<< C<l> >> Disable bracketed paste mode
2062
2063=end table
2064
698=back 2065=back
699 2066
700=back 2067=back
701 2068
702X<XTerm> 2069X<XTerm>
703 2070
704=head1 XTerm Operating System Commands 2071=head2 XTerm Operating System Commands
705 2072
706=over 4 2073=over 4
707 2074
708=item B<< C<ESC ] Ps;Pt ST> >> 2075=item B<< C<ESC ] Ps;Pt ST> >>
709 2076
… …
716 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >> 2083 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>
717 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >> 2084 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
718 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> 2085 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
719 B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property. 2086 B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property.
720 B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white 2087 B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white
721 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 2088 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >>
722 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 2089 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >>
723 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 2090 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
724 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 2091 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
725 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 2092 B<< C<Ps = 17> >> Change background colour of highlight characters to B<< C<Pt> >>
726 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 2093 B<< C<Ps = 19> >> Change foreground colour of highlight characters to B<< C<Pt> >>
727 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 2094 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile pixbuf).
728 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>
729 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option> 2095 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. [deprecated, use 10]
730 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 2096 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
731 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 2097 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. [deprecated, use 11]
732 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> 2098 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
733 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 2099 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> [disabled]
734 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVTNAME@@ extension) 2100 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
735 B<< C<Ps = 702> >> find font for character, used for debugging (@@RXVTNAME@@ extension) 2101 B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>.
736 B<< C<Ps = 703> >> command B<< C<Pt> >> I<rxvt compile-time option> (@@RXVTNAME@@ extension) 2102 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
2103 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
2104 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
2105 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
2106 B<< C<Ps = 708> >> Change colour of the border to B<< C<Pt> >>
2107 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
2108 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2109 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2110 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2111 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2112 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2113 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
737 2114
738=end table 2115=end table
739 2116
740=back 2117=back
741 2118
742X<menuBar> 2119=head1 BACKGROUND IMAGE
743 2120
744=head1 menuBar 2121For the BACKGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> the value
745 2122of B<< C<Pt> >> can be one of the following commands:
746B<< The exact syntax used is I<almost> solidified. >>
747In the menus, B<DON'T> try to use menuBar commands that add or remove a
748menuBar.
749
750Note that in all of the commands, the B<< I</path/> >> I<cannot> be
751omitted: use B<./> to specify a menu relative to the current menu.
752
753=head2 Overview of menuBar operation
754
755For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
756of C<Pt> can be used for a variety of tasks:
757
758At the top level is the current menuBar which is a member of a circular
759linked-list of other such menuBars.
760
761The menuBar acts as a parent for the various drop-down menus, which in
762turn, may have labels, separator lines, menuItems and subMenus.
763
764The menuItems are the useful bits: you can use them to mimic keyboard
765input or even to send text or escape sequences back to rxvt.
766
767The menuBar syntax is intended to provide a simple yet robust method of
768constructing and manipulating menus and navigating through the
769menuBars.
770
771The first step is to use the tag B<< [menu:I<name>] >> which creates
772the menuBar called I<name> and allows access. You may now or menus,
773subMenus, and menuItems. Finally, use the tag B<[done]> to set the
774menuBar access as B<readonly> to prevent accidental corruption of the
775menus. To re-access the current menuBar for alterations, use the tag
776B<[menu]>, make the alterations and then use B<[done]>
777
778X<menuBarCommands>
779
780=head2 Commands
781 2123
782=over 4 2124=over 4
783 2125
784=item B<< [menu:+I<name>] >> 2126=item B<< C<?> >>
785 2127
786access the named menuBar for creation or alteration. If a new menuBar 2128display scale and position in the title
787is created, it is called I<name> (max of 15 chars) and the current
788menuBar is pushed onto the stack
789 2129
790=item B<[menu]> 2130=item B<< C<;WxH+X+Y> >>
791 2131
792access the current menuBar for alteration 2132change scale and/or position
793 2133
794=item B<< [title:+I<string>] >> 2134=item B<< C<FILE;WxH+X+Y> >>
795 2135
796set the current menuBar's title to I<string>, which may contain the 2136change background image
797following format specifiers:
798B<%%> : literal B<%> character
799B<%n> : rxvt name (as per the B<-name> command-line option)
800B<%v> : rxvt version
801
802=item B<[done]>
803
804set menuBar access as B<readonly>.
805End-of-file tag for B<< [read:+I<file>] >> operations.
806
807=item B<< [read:+I<file>] >>
808
809read menu commands directly from I<file> (extension ".menu" will be
810appended if required.) Start reading at a line with B<[menu]> or B<<
811[menu:+I<name> >> and continuing until B<[done]> is encountered.
812
813Blank and comment lines (starting with B<#>) are ignored. Actually,
814since any invalid menu commands are also ignored, almost anything could
815be construed as a comment line, but this may be tightened up in the
816future ... so don't count on it!.
817
818=item B<< [read:+I<file>;+I<name>] >>
819
820The same as B<< [read:+I<file>] >>, but start reading at a line with
821B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
822B<[done]> is encountered.
823
824=item B<[dump]>
825
826dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
827later rereading.
828
829=item B<[rm:name]>
830
831remove the named menuBar
832
833=item B<[rm] [rm:]>
834
835remove the current menuBar
836
837=item B<[rm*] [rm:*]>
838
839remove all menuBars
840
841=item B<[swap]>
842
843swap the top two menuBars
844
845=item B<[prev]>
846
847access the previous menuBar
848
849=item B<[next]>
850
851access the next menuBar
852
853=item B<[show]>
854
855Enable display of the menuBar
856
857=item B<[hide]>
858
859Disable display of the menuBar
860
861=item B<< [pixmap:+I<name>] >>
862
863=item B<< [pixmap:+I<name>;I<scaling>] >>
864
865(set the background pixmap globally
866
867B<< A Future implementation I<may> make this local to the menubar >>)
868
869=item B<< [:+I<command>:] >>
870
871ignore the menu readonly status and issue a I<command> to or a menu or
872menuitem or change the ; a useful shortcut for setting the quick arrows
873from a menuBar.
874 2137
875=back 2138=back
876 2139
877X<menuBarAdd>
878
879=head2 Adding and accessing menus
880
881The following commands may also be B<+> prefixed.
882
883=over 4
884
885=item B</+>
886
887access menuBar top level
888
889=item B<./+>
890
891access current menu level
892
893=item B<../+>
894
895access parent menu (1 level up)
896
897=item B<../../>
898
899access parent menu (multiple levels up)
900
901=item B<< I</path/>menu >>
902
903add/access menu
904
905=item B<< I</path/>menu/* >>
906
907add/access menu and clear it if it exists
908
909=item B<< I</path/>{-} >>
910
911add separator
912
913=item B<< I</path/>{item} >>
914
915add B<item> as a label
916
917=item B<< I</path/>{item} action >>
918
919add/alter I<menuitem> with an associated I<action>
920
921=item B<< I</path/>{item}{right-text} >>
922
923add/alter I<menuitem> with B<right-text> as the right-justified text
924and as the associated I<action>
925
926=item B<< I</path/>{item}{rtext} action >>
927
928add/alter I<menuitem> with an associated I<action> and with B<rtext> as
929the right-justified text.
930
931=back
932
933=over 4
934
935=item Special characters in I<action> must be backslash-escaped:
936
937B<\a \b \E \e \n \r \t \octal>
938
939=item or in control-character notation:
940
941B<^@, ^A .. ^Z .. ^_, ^?>
942
943=back
944
945To send a string starting with a B<NUL> (B<^@>) character to the
946program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
947the first of which will be stripped off and the balance directed to the
948program. Otherwise if I<action> begins with B<NUL> followed by
949non-+B<NUL> characters, the leading B<NUL> is stripped off and the
950balance is sent back to rxvt.
951
952As a convenience for the many Emacs-type editors, I<action> may start
953with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
954appended if missed from B<M-x> commands.
955
956As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or
957quick arrow), a B<BEL> (B<^G>) will be appended if needed.
958
959=over 4
960
961=item For example,
962
963B<M-xapropos> is equivalent to B<\Exapropos\r>
964
965=item and
966
967B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
968
969=back
970
971The option B<< {I<right-rtext>} >> will be right-justified. In the
972absence of a specified action, this text will be used as the I<action>
973as well.
974
975=over 4
976
977=item For example,
978
979B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
980
981=back
982
983The left label I<is> necessary, since it's used for matching, but
984implicitly hiding the left label (by using same name for both left and
985right labels), or explicitly hiding the left label (by preceeding it
986with a dot), makes it possible to have right-justified text only.
987
988=over 4
989
990=item For example,
991
992B</File/{Open}{Open} Open-File-Action>
993
994=item or hiding it
995
996B</File/{.anylabel}{Open} Open-File-Action>
997
998=back
999
1000X<menuBarRemove>
1001
1002=head2 Removing menus
1003
1004=over 4
1005
1006=item B<< -/*+ >>
1007
1008remove all menus from the menuBar, the same as B<[clear]>
1009
1010=item B<< -+I</path>menu+ >>
1011
1012remove menu
1013
1014=item B<< -+I</path>{item}+ >>
1015
1016remove item
1017
1018=item B<< -+I</path>{-} >>
1019
1020remove separator)
1021
1022=item B<-/path/menu/*>
1023
1024remove all items, separators and submenus from menu
1025
1026=back
1027
1028X<menuBarArrows>
1029
1030=head2 Quick Arrows
1031
1032The menus also provide a hook for I<quick arrows> to provide easier
1033user access. If nothing has been explicitly set, the default is to
1034emulate the curror keys. The syntax permits each arrow to be altered
1035individually or all four at once without re-entering their common
1036beginning/end text. For example, to explicitly associate cursor actions
1037with the arrows, any of the following forms could be used:
1038
1039=over 4
1040
1041=item B<< <r>+I<Right> >>
1042
1043=item B<< <l>+I<Left> >>
1044
1045=item B<< <u>+I<Up> >>
1046
1047=item B<< <d>+I<Down> >>
1048
1049Define actions for the respective arrow buttons
1050
1051=item B<< <b>+I<Begin> >>
1052
1053=item B<< <e>+I<End> >>
1054
1055Define common beginning/end parts for I<quick arrows> which used in
1056conjunction with the above <r> <l> <u> <d> constructs
1057
1058=back
1059
1060=over 4
1061
1062=item For example, define arrows individually,
1063
1064 <u>\E[A
1065
1066 <d>\E[B
1067
1068 <r>\E[C
1069
1070 <l>\E[D
1071
1072=item or all at once
1073
1074 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1075
1076=item or more compactly (factoring out common parts)
1077
1078 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1079
1080=back
1081
1082X<menuBarSummary>
1083
1084=head2 Command Summary
1085
1086A short summary of the most I<common> commands:
1087
1088=over 4
1089
1090=item [menu:name]
1091
1092use an existing named menuBar or start a new one
1093
1094=item [menu]
1095
1096use the current menuBar
1097
1098=item [title:string]
1099
1100set menuBar title
1101
1102=item [done]
1103
1104set menu access to readonly and, if reading from a file, signal EOF
1105
1106=item [done:name]
1107
1108if reading from a file using [read:file;name] signal EOF
1109
1110=item [rm:name]
1111
1112remove named menuBar(s)
1113
1114=item [rm] [rm:]
1115
1116remove current menuBar
1117
1118=item [rm*] [rm:*]
1119
1120remove all menuBar(s)
1121
1122=item [swap]
1123
1124swap top two menuBars
1125
1126=item [prev]
1127
1128access the previous menuBar
1129
1130=item [next]
1131
1132access the next menuBar
1133
1134=item [show]
1135
1136map menuBar
1137
1138=item [hide]
1139
1140unmap menuBar
1141
1142=item [pixmap;file]
1143
1144=item [pixmap;file;scaling]
1145
1146set a background pixmap
1147
1148=item [read:file]
1149
1150=item [read:file;name]
1151
1152read in a menu from a file
1153
1154=item [dump]
1155
1156dump out all menuBars to /tmp/rxvt-PID
1157
1158=item /
1159
1160access menuBar top level
1161
1162=item ./
1163
1164=item ../
1165
1166=item ../../
1167
1168access current or parent menu level
1169
1170=item /path/menu
1171
1172add/access menu
1173
1174=item /path/{-}
1175
1176add separator
1177
1178=item /path/{item}{rtext} action
1179
1180add/alter menu item
1181
1182=item -/*
1183
1184remove all menus from the menuBar
1185
1186=item -/path/menu
1187
1188remove menu items, separators and submenus from menu
1189
1190=item -/path/menu
1191
1192remove menu
1193
1194=item -/path/{item}
1195
1196remove item
1197
1198=item -/path/{-}
1199
1200remove separator
1201
1202=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1203
1204menu quick arrows
1205
1206=back
1207X<XPM>
1208
1209=head1 XPM
1210
1211For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1212of B<< C<Pt> >> can be the name of the background pixmap followed by a
1213sequence of scaling/positioning commands separated by semi-colons. The
1214scaling/positioning commands are as follows:
1215
1216=over 4
1217
1218=item query scale/position
1219
1220B<?>
1221
1222=item change scale and position
1223
1224B<WxH+X+Y>
1225
1226B<WxH+X> (== B<WxH+X+X>)
1227
1228B<WxH> (same as B<WxH+50+50>)
1229
1230B<W+X+Y> (same as B<WxW+X+Y>)
1231
1232B<W+X> (same as B<WxW+X+X>)
1233
1234B<W> (same as B<WxW+50+50>)
1235
1236=item change position (absolute)
1237
1238B<=+X+Y>
1239
1240B<=+X> (same as B<=+X+Y>)
1241
1242=item change position (relative)
1243
1244B<+X+Y>
1245
1246B<+X> (same as B<+X+Y>)
1247
1248=item rescale (relative)
1249
1250B<Wx0> -> B<W *= (W/100)>
1251
1252B<0xH> -> B<H *= (H/100)>
1253
1254=back
1255
1256For example:
1257
1258=over 4
1259
1260=item B<\E]20;funky\a>
1261
1262load B<funky.xpm> as a tiled image
1263
1264=item B<\E]20;mona;100\a>
1265
1266load B<mona.xpm> with a scaling of 100%
1267
1268=item B<\E]20;;200;?\a>
1269
1270rescale the current pixmap to 200% and display the image geometry in
1271the title
1272
1273=back
1274X<Mouse> 2140X<Mouse>
1275 2141
1276=head1 Mouse Reporting 2142=head1 Mouse Reporting
1277 2143
1278=over 4 2144=over 4
… …
1303The upper bits of B<< C<< <b> >> >> indicate the modifiers when the 2169The upper bits of B<< C<< <b> >> >> indicate the modifiers when the
1304button was pressed and are added together (X11 mouse report only): 2170button was pressed and are added together (X11 mouse report only):
1305 2171
1306=over 4 2172=over 4
1307 2173
1308=item State = B<< C<< (<b> - SPACE) & 60 >> >> 2174=item State = B<< C<< (<b> - SPACE) & ~3 >> >>
1309 2175
1310=begin table 2176=begin table
1311 2177
1312 4 Shift 2178 4 Shift
1313 8 Meta 2179 8 Meta
1314 16 Control 2180 16 Control
2181 32 Motion Notify
1315 32 Double Click I<(Rxvt extension)> 2182 32 Double Click I<(rxvt extension)>, disabled by default
2183 64 Button1 is actually Button4, Button2 is actually Button5 etc.
1316 2184
1317=end table 2185=end table
1318 2186
1319Col = B<< C<< <x> - SPACE >> >> 2187Col = B<< C<< <x> - SPACE >> >>
1320 2188
1321Row = B<< C<< <y> - SPACE >> >> 2189Row = B<< C<< <y> - SPACE >> >>
1322 2190
1323=back 2191=back
2192
2193=head1 Key Codes
2194
1324X<KeyCodes> 2195X<KeyCodes>
1325 2196
1326=head1 ISO 14755 support
1327
1328Partial ISO 14755-support is implemented. that means that pressing
1329
1330section 5.1: Control and Shift together enters unicode input
1331mode. Entering hex digits composes a Unicode character, pressing space or
1332releasing the modifiers commits the keycode and every other key cancels
1333the current input character.
1334
1335section 5.2: Pressing and immediately releasing Control and Shift together
1336enters keycap entry mode for the next key: pressing a function key (tab,
1337return etc..) will enter the unicode character corresponding to the given
1338key.
1339
1340=head1 Key Codes
1341
1342Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 2197Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
1343 2198
1344For the keypad, use B<Shift> to temporarily override Application-Keypad 2199For the keypad, use B<Shift> to temporarily toggle Application Keypad
1345setting use B<Num_Lock> to toggle Application-Keypad setting if 2200mode and use B<Num_Lock> to override Application Keypad mode, i.e. if
1346B<Num_Lock> is off, toggle Application-Keypad setting. Also note that 2201B<Num_Lock> is on the keypad is in normal mode. Also note that the
1347values of B<Home>, B<End>, B<Delete> may have been compiled differently on 2202values of B<BackSpace>, B<Delete> may have been compiled differently
1348your system. 2203on your system.
1349 2204
1350=begin table 2205=begin table
1351 2206
1352 B<Normal> B<Shift> B<Control> B<Ctrl+Shift> 2207 B<Normal> B<Shift> B<Control> B<Ctrl+Shift>
1353 Tab ^I ESC [ Z ^I ESC [ Z 2208 Tab ^I ESC [ Z ^I ESC [ Z
1354 BackSpace ^H ^? ^? ^? 2209 BackSpace ^? ^? ^H ^H
1355 Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @ 2210 Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @
1356 Insert ESC [ 2 ~ I<paste> ESC [ 2 ^ ESC [ 2 @ 2211 Insert ESC [ 2 ~ I<paste> ESC [ 2 ^ ESC [ 2 @
1357 Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @ 2212 Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
1358 Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @ 2213 Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @
1359 Prior ESC [ 5 ~ I<scroll-up> ESC [ 5 ^ ESC [ 5 @ 2214 Prior ESC [ 5 ~ I<scroll-up> ESC [ 5 ^ ESC [ 5 @
… …
1389 KP_Enter ^M ESC O M 2244 KP_Enter ^M ESC O M
1390 KP_F1 ESC O P ESC O P 2245 KP_F1 ESC O P ESC O P
1391 KP_F2 ESC O Q ESC O Q 2246 KP_F2 ESC O Q ESC O Q
1392 KP_F3 ESC O R ESC O R 2247 KP_F3 ESC O R ESC O R
1393 KP_F4 ESC O S ESC O S 2248 KP_F4 ESC O S ESC O S
1394 XK_KP_Multiply * ESC O j 2249 KP_Multiply * ESC O j
1395 XK_KP_Add + ESC O k 2250 KP_Add + ESC O k
1396 XK_KP_Separator , ESC O l 2251 KP_Separator , ESC O l
1397 XK_KP_Subtract - ESC O m 2252 KP_Subtract - ESC O m
1398 XK_KP_Decimal . ESC O n 2253 KP_Decimal . ESC O n
1399 XK_KP_Divide / ESC O o 2254 KP_Divide / ESC O o
1400 XK_KP_0 0 ESC O p 2255 KP_0 0 ESC O p
1401 XK_KP_1 1 ESC O q 2256 KP_1 1 ESC O q
1402 XK_KP_2 2 ESC O r 2257 KP_2 2 ESC O r
1403 XK_KP_3 3 ESC O s 2258 KP_3 3 ESC O s
1404 XK_KP_4 4 ESC O t 2259 KP_4 4 ESC O t
1405 XK_KP_5 5 ESC O u 2260 KP_5 5 ESC O u
1406 XK_KP_6 6 ESC O v 2261 KP_6 6 ESC O v
1407 XK_KP_7 7 ESC O w 2262 KP_7 7 ESC O w
1408 XK_KP_8 8 ESC O x 2263 KP_8 8 ESC O x
1409 XK_KP_9 9 ESC O y 2264 KP_9 9 ESC O y
1410 2265
2266=end table
2267
2268=head1 CONFIGURE OPTIONS
2269
2270General hint: if you get compile errors, then likely your configuration
2271hasn't been tested well. Either try with C<--enable-everything> or use
2272the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2273switches). Of course, you should always report when a combination doesn't
2274work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2275
2276All
2277
2278=over 4
2279
2280=item --enable-everything
2281
2282Add (or remove) support for all non-multichoice options listed
2283in C<./configure --help>, except for C<--enable-assert> and
2284C<--enable-256-color>.
2285
2286You can specify this and then disable options you do not like by
2287I<following> this with the appropriate C<--disable-...> arguments,
2288or you can start with a minimal configuration by specifying
2289C<--disable-everything> and than adding just the C<--enable-...> arguments
2290you want.
2291
2292=item --enable-xft (default: on)
2293
2294Add support for Xft (anti-aliased, among others) fonts. Xft fonts are
2295slower and require lots of memory, but as long as you don't use them, you
2296don't pay for them.
2297
2298=item --enable-font-styles (default: on)
2299
2300Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2301styles. The fonts can be set manually or automatically.
2302
2303=item --with-codesets=CS,... (default: all)
2304
2305Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2306are always compiled in, which includes most 8-bit character sets). These
2307codeset tables are used for driving X11 core fonts, they are not required
2308for Xft fonts, although having them compiled in lets rxvt-unicode choose
2309replacement fonts more intelligently. Compiling them in will make your
2310binary bigger (all of together cost about 700kB), but it doesn't increase
2311memory usage unless you use a font requiring one of these encodings.
2312
1411=end table 2313=begin table
1412 2314
2315 all all available codeset groups
2316 zh common chinese encodings
2317 zh_ext rarely used but very big chinese encodings
2318 jp common japanese encodings
2319 jp_ext rarely used but big japanese encodings
2320 kr korean encodings
2321
2322=end table
2323
2324=item --enable-xim (default: on)
2325
2326Add support for XIM (X Input Method) protocol. This allows using
2327alternative input methods (e.g. kinput2) and will also correctly
2328set up the input for people using dead keys or compose keys.
2329
2330=item --enable-unicode3 (default: off)
2331
2332Recommended to stay off unless you really need non-BMP characters.
2333
2334Enable direct support for displaying unicode codepoints above
233565535 (the basic multilingual page). This increases storage
2336requirements per character from 2 to 4 bytes. X11 fonts do not yet
2337support these extra characters, but Xft does.
2338
2339Please note that rxvt-unicode can store unicode code points >65535
2340even without this flag, but the number of such characters is
2341limited to a few thousand (shared with combining characters,
2342see next switch), and right now rxvt-unicode cannot display them
2343(input/output and cut&paste still work, though).
2344
2345=item --enable-combining (default: on)
2346
2347Enable automatic composition of combining characters into
2348composite characters. This is required for proper viewing of text
2349where accents are encoded as separate unicode characters. This is
2350done by using precomposed characters when available or creating
2351new pseudo-characters when no precomposed form exists.
2352
2353Without --enable-unicode3, the number of additional precomposed
2354characters is somewhat limited (the 6400 private use characters will be
2355(ab-)used). With --enable-unicode3, no practical limit exists.
2356
2357This option will also enable storage (but not display) of characters
2358beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2359
2360The combining table also contains entries for arabic presentation forms,
2361but these are not currently used. Bug me if you want these to be used (and
2362tell me how these are to be used...).
2363
2364=item --enable-fallback[=CLASS] (default: Rxvt)
2365
2366When reading resource settings, also read settings for class CLASS. To
2367disable resource fallback use --disable-fallback.
2368
2369=item --with-res-name=NAME (default: urxvt)
2370
2371Use the given name as default application name when
2372reading resources. Specify --with-res-name=rxvt to replace rxvt.
2373
2374=item --with-res-class=CLASS (default: URxvt)
2375
2376Use the given class as default application class
2377when reading resources. Specify --with-res-class=Rxvt to replace
2378rxvt.
2379
2380=item --enable-utmp (default: on)
2381
2382Write user and tty to utmp file (used by programs like F<w>) at
2383start of rxvt execution and delete information when rxvt exits.
2384
2385=item --enable-wtmp (default: on)
2386
2387Write user and tty to wtmp file (used by programs like F<last>) at
2388start of rxvt execution and write logout when rxvt exits. This
2389option requires --enable-utmp to also be specified.
2390
2391=item --enable-lastlog (default: on)
2392
2393Write user and tty to lastlog file (used by programs like
2394F<lastlogin>) at start of rxvt execution. This option requires
2395--enable-utmp to also be specified.
2396
2397=item --enable-pixbuf (default: on)
2398
2399Add support for GDK-PixBuf to be used for background images.
2400It adds support for many file formats including JPG, PNG,
2401TIFF, GIF, XPM, BMP, ICO and TGA.
2402
2403=item --enable-startup-notification (default: on)
2404
2405Add support for freedesktop startup notifications. This allows window managers
2406to display some kind of progress indicator during startup.
2407
2408=item --enable-transparency (default: on)
2409
2410Add support for using the root pixmap as background to simulate transparency.
2411Note that this feature depends on libXrender and on the availability
2412of the RENDER extension in the X server.
2413
2414=item --enable-fading (default: on)
2415
2416Add support for fading the text when focus is lost.
2417
2418=item --enable-rxvt-scroll (default: on)
2419
2420Add support for the original rxvt scrollbar.
2421
2422=item --enable-next-scroll (default: on)
2423
2424Add support for a NeXT-like scrollbar.
2425
2426=item --enable-xterm-scroll (default: on)
2427
2428Add support for an Xterm-like scrollbar.
2429
2430=item --disable-backspace-key
2431
2432Removes any handling of the backspace key by us - let the X server do it.
2433
2434=item --disable-delete-key
2435
2436Removes any handling of the delete key by us - let the X server
2437do it.
2438
2439=item --disable-resources
2440
2441Removes any support for resource checking.
2442
2443=item --disable-swapscreen
2444
2445Remove support for secondary/swap screen.
2446
2447=item --enable-frills (default: on)
2448
2449Add support for many small features that are not essential but nice to
2450have. Normally you want this, but for very small binaries you may want to
2451disable this.
2452
2453A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2454in combination with other switches) is:
2455
2456 MWM-hints
2457 EWMH-hints (pid, utf8 names) and protocols (ping)
2458 urgency hint
2459 separate underline colour (-underlineColor)
2460 settable border widths and borderless switch (-w, -b, -bl)
2461 visual depth selection (-depth)
2462 settable extra linespacing (-lsp)
2463 iso-14755 5.1 (basic) support
2464 tripleclickwords (-tcw)
2465 settable insecure mode (-insecure)
2466 keysym remapping support
2467 cursor blinking and underline cursor (-bc, -uc)
2468 XEmbed support (-embed)
2469 user-pty (-pty-fd)
2470 hold on exit (-hold)
2471 compile in built-in block graphics
2472 skip builtin block graphics (-sbg)
2473 separate highlight colour (-highlightColor, -highlightTextColor)
2474 focus reporting mode (1004).
2475 extended mouse reporting modes (1005 and 1015).
2476 visual selection via -visual and -depth.
2477
2478It also enables some non-essential features otherwise disabled, such as:
2479
2480 some round-trip time optimisations
2481 nearest colour allocation on pseudocolor screens
2482 UTF8_STRING support for selection
2483 sgr modes 90..97 and 100..107
2484 backindex and forwardindex escape sequences
2485 view change/zero scrollback escape sequences
2486 locale switching escape sequence
2487 window op and some xterm/OSC escape sequences
2488 rectangular selections
2489 trailing space removal for selections
2490 verbose X error handling
2491
2492=item --enable-iso14755 (default: on)
2493
2494Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)).
2495Basic support (section 5.1) is enabled by C<--enable-frills>, while
2496support for 5.2, 5.3 and 5.4 is enabled with this switch.
2497
2498=item --enable-keepscrolling (default: on)
2499
2500Add support for continual scrolling of the display when you hold
2501the mouse button down on a scrollbar arrow.
2502
2503=item --enable-selectionscrolling (default: on)
2504
2505Add support for scrolling when the selection moves to the top or
2506bottom of the screen.
2507
2508=item --enable-mousewheel (default: on)
2509
2510Add support for scrolling via mouse wheel or buttons 4 & 5.
2511
2512=item --enable-slipwheeling (default: on)
2513
2514Add support for continual scrolling (using the mouse wheel as an
2515accelerator) while the control key is held down. This option
2516requires --enable-mousewheel to also be specified.
2517
2518=item --enable-smart-resize (default: off)
2519
2520Add smart growth/shrink behaviour when resizing.
2521This should keep the window corner which is closest to a corner of
2522the screen in a fixed position.
2523
2524=item --enable-text-blink (default: on)
2525
2526Add support for blinking text.
2527
2528=item --enable-pointer-blank (default: on)
2529
2530Add support to have the pointer disappear when typing or inactive.
2531
2532=item --enable-perl (default: on)
2533
2534Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2535manpage for more info on this feature, or the files in F<src/perl/>
2536for the extensions that are installed by default.
2537The perl interpreter that is used can be specified via the C<PERL>
2538environment variable when running configure. Even when compiled in,
2539perl will I<not> be initialised when all extensions have been disabled
2540C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2541resource standpoint.
2542
2543=item --enable-assert (default: off)
2544
2545Enables the assertions in the code, normally disabled. This switch is only
2546useful when developing rxvt-unicode.
2547
2548=item --enable-256-color (default: off)
2549
2550Force use of so-called 256 colour mode, to work around buggy applications
2551that do not support termcap/terminfo, or simply improve support for
2552applications hardcoding the xterm 256 colour table.
2553
2554This switch breaks termcap/terminfo compatibility to C<TERM=rxvt-unicode>,
2555and consequently sets C<TERM> to C<rxvt-unicode-256color> by default
2556(F<doc/etc/> contains termcap/terminfo definitions for both).
2557
2558It also results in higher memory usage and can slow down @@RXVT_NAME@@
2559dramatically when more than six fonts are in use by a terminal instance.
2560
2561=item --with-name=NAME (default: urxvt)
2562
2563Set the basename for the installed binaries, resulting
2564in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2565C<rxvt>.
2566
2567=item --with-term=NAME (default: rxvt-unicode)
2568
2569Change the environmental variable for the terminal to NAME.
2570
2571=item --with-terminfo=PATH
2572
2573Change the environmental variable for the path to the terminfo tree to
2574PATH.
2575
2576=item --with-x
2577
2578Use the X Window System (pretty much default, eh?).
2579
2580=back
2581
2582=head1 AUTHORS
2583
2584Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
2585reworked it from the original Rxvt documentation, which was done by Geoff
2586Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other
2587sources.
2588

Diff Legend

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