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.5 by root, Thu Aug 12 22:29:28 2004 UTC vs.
Revision 1.108 by root, Tue Jan 31 21:04:56 2006 UTC

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

Diff Legend

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