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.114 by root, Tue Feb 21 00:59:59 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 can I start @@URXVT_NAME@@d automatically when I run URXVT_NAME@@c?
79
80If you want to start @@URXVT_NAME@@d automatically whenever you run
81@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
82
83 #!/bin/sh
84 @@URXVT_NAME@@c "$@"
85 if [ $? -eq 2 ]; then
86 @@URXVT_NAME@@d -q -o -f
87 @@URXVT_NAME@@c "$@"
88 fi
89
90This tries to create a new terminal, and if fails with exit status 2,
91meaning it couldn't connect to the daemon, it will start the daemon and
92re-run the command. Subsequent invocations of the script will re-use the
93existing daemon.
94
95=head3 How do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
96
97The original rxvt and rxvt-unicode always export the variable "COLORTERM",
98so you can check and see if that is set. Note that several programs, JED,
99slrn, Midnight Commander automatically check this variable to decide
100whether or not to use color.
101
102=head3 How do I set the correct, full IP address for the DISPLAY variable?
103
104If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
105insecure mode then it is possible to use the following shell script
106snippets to correctly set the display. If your version of rxvt-unicode
107wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
108the COLORTERM variable can be used to distinguish rxvt-unicode from a
109regular xterm.
110
111Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
112snippets:
113
114 # Bourne/Korn/POSIX family of shells:
115 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
116 if [ ${TERM:-foo} = xterm ]; then
117 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
118 echo -n '^[Z'
119 read term_id
120 stty icanon echo
121 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
122 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
123 read DISPLAY # set it in our local shell
124 fi
125 fi
126
127=head3 How do I compile the manual pages on my own?
128
129You need to have a recent version of perl installed as F</usr/bin/perl>,
130one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
131the doc subdirectory and enter C<make alldoc>.
132
133=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
134
135I often get asked about this, and I think, no, they didn't cause extra
136bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
137that the urxvt binary is larger (due to some encoding tables always being
138compiled in), but it actually uses less memory (RSS) after startup. Even
139with C<--disable-everything>, this comparison is a bit unfair, as many
140features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
141already in use in this mode.
142
143 text data bss drs rss filename
144 98398 1664 24 15695 1824 rxvt --disable-everything
145 188985 9048 66616 18222 1788 urxvt --disable-everything
146
147When you C<--enable-everything> (which I<is> unfair, as this involves xft
148and full locale/XIM support which are quite bloaty inside libX11 and my
149libc), the two diverge, but not unreasnobaly so.
150
151 text data bss drs rss filename
152 163431 2152 24 20123 2060 rxvt --enable-everything
153 1035683 49680 66648 29096 3680 urxvt --enable-everything
154
155The very large size of the text section is explained by the east-asian
156encoding tables, which, if unused, take up disk space but nothing else
157and can be compiled out unless you rely on X11 core fonts that use those
158encodings. The BSS size comes from the 64k emergency buffer that my c++
159compiler allocates (but of course doesn't use unless you are out of
160memory). Also, using an xft font instead of a core font immediately adds a
161few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
162not used.
163
164Of course, due to every character using two or four bytes instead of one,
165a large scrollback buffer will ultimately make rxvt-unicode use more
166memory.
167
168Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
169still fares rather well. And compared to some monsters like gnome-terminal
170(21152k + extra 4204k in separate processes) or konsole (22200k + extra
17143180k in daemons that stay around after exit, plus half a minute of
172startup time, including the hundreds of warnings it spits out), it fares
173extremely well *g*.
174
175=head3 Why C++, isn't that unportable/bloated/uncool?
176
177Is this a question? :) It comes up very often. The simple answer is: I had
178to write it, and C++ allowed me to write and maintain it in a fraction
179of the time and effort (which is a scarce resource for me). Put even
180shorter: It simply wouldn't exist without C++.
181
182My personal stance on this is that C++ is less portable than C, but in
183the case of rxvt-unicode this hardly matters, as its portability limits
184are defined by things like X11, pseudo terminals, locale support and unix
185domain sockets, which are all less portable than C++ itself.
186
187Regarding the bloat, see the above question: It's easy to write programs
188in C that use gobs of memory, an certainly possible to write programs in
189C++ that don't. C++ also often comes with large libraries, but this is
190not necessarily the case with GCC. Here is what rxvt links against on my
191system with a minimal config:
192
193 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
194 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
195 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
196 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
197
198And here is rxvt-unicode:
199
200 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
201 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
202 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
203 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
204 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
205
206No large bloated libraries (of course, none were linked in statically),
207except maybe libX11 :)
208
209
210=head2 Rendering, Font & Look and Feel Issues
211
212=head3 I can't get transparency working, what am I doing wrong?
213
214First of all, transparency isn't officially supported in rxvt-unicode, so
215you are mostly on your own. Do not bug the author about it (but you may
216bug everybody else). Also, if you can't get it working consider it a rite
217of passage: ... and you failed.
218
219Here are four ways to get transparency. B<Do> read the manpage and option
220descriptions for the programs mentioned and rxvt-unicode. Really, do it!
221
2221. Use inheritPixmap:
223
224 Esetroot wallpaper.jpg
225 @@URXVT_NAME@@ -ip -tint red -sh 40
226
227That works. If you think it doesn't, you lack transparency and tinting
228support, or you are unable to read.
229
2302. Use a simple pixmap and emulate pseudo-transparency. This enables you
231to use effects other than tinting and shading: Just shade/tint/whatever
232your picture with gimp or any other tool:
233
234 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
235 @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background
236
237That works. If you think it doesn't, you lack XPM and Perl support, or you
238are unable to read.
239
2403. Use an ARGB visual:
241
242 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
243
244This requires XFT support, and the support of your X-server. If that
245doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
246there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
247bugfixes and workarounds for Xft and Xlib to make it work, but that
248doesn't mean that your WM has the required kludges in place.
249
2504. Use xcompmgr and let it do the job:
251
252 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
253 -set _NET_WM_WINDOW_OPACITY 0xc0000000
254
255Then click on a window you want to make transparent. Replace C<0xc0000000>
256by other values to change the degree of opacity. If it doesn't work and
257your server crashes, you got to keep the pieces.
258
259=head3 Why does rxvt-unicode sometimes leave pixel droppings?
260
261Most fonts were not designed for terminal use, which means that character
262size varies a lot. A font that is otherwise fine for terminal use might
263contain some characters that are simply too wide. Rxvt-unicode will avoid
264these characters. For characters that are just "a bit" too wide a special
265"careful" rendering mode is used that redraws adjacent characters.
266
267All of this requires that fonts do not lie about character sizes,
268however: Xft fonts often draw glyphs larger than their acclaimed bounding
269box, and rxvt-unicode has no way of detecting this (the correct way is to
270ask for the character bounding box, which unfortunately is wrong in these
271cases).
272
273It's not clear (to me at least), wether this is a bug in Xft, freetype,
274or the respective font. If you encounter this problem you might try using
275the C<-lsp> option to give the font more height. If that doesn't work, you
276might be forced to use a different font.
277
278All of this is not a problem when using X11 core fonts, as their bounding
279box data is correct.
280
281=head3 How can I keep rxvt-unicode from using reverse video so much?
282
283First of all, make sure you are running with the right terminal settings
284(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
285make sure you have specified colours for italic and bold, as otherwise
286rxvt-unicode might use reverse video to simulate the effect:
287
288 URxvt.colorBD: white
289 URxvt.colorIT: green
290
291=head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
292
293For some unexplainable reason, some rare programs assume a very weird
294colour palette when confronted with a terminal with more than the standard
2958 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
296these programs not to assume non-ISO colours without very good reasons.
297
298In the meantime, you can either edit your C<rxvt-unicode> terminfo
299definition to only claim 8 colour support or use C<TERM=rxvt>, which will
300fix colours but keep you from using other rxvt-unicode features.
301
302=head3 Can I switch the fonts at runtime?
303
304Yes, using an escape sequence. Try something like this, which has the same
305effect as using the C<-fn> switch, and takes effect immediately:
306
307 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
308
309This is useful if you e.g. work primarily with japanese (and prefer a
310japanese font), but you have to switch to chinese temporarily, where
311japanese fonts would only be in your way.
312
313You can think of this as a kind of manual ISO-2022 switching.
314
315=head3 Why do italic characters look as if clipped?
316
317Many fonts have difficulties with italic characters and hinting. For
318example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
319Mono> completely fails in it's italic face. A workaround might be to
320enable freetype autohinting, i.e. like this:
321
322 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
323 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
324
325=head3 Can I speed up Xft rendering somehow?
326
327Yes, the most obvious way to speed it up is to avoid Xft entirely, as
328it is simply slow. If you still want Xft fonts you might try to disable
329antialiasing (by appending C<:antialias=false>), which saves lots of
330memory and also speeds up rendering considerably.
331
332=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
333
334Rxvt-unicode will use whatever you specify as a font. If it needs to
335fall back to it's default font search list it will prefer X11 core
336fonts, because they are small and fast, and then use Xft fonts. It has
337antialiasing disabled for most of them, because the author thinks they
338look best that way.
339
340If you want antialiasing, you have to specify the fonts manually.
341
342=head3 What's with this bold/blink stuff?
343
344If no bold colour is set via C<colorBD:>, bold will invert text using the
345standard foreground colour.
346
347For the standard background colour, blinking will actually make the
348text blink when compiled with C<--enable-blinking>. with standard
349colours. Without C<--enable-blinking>, the blink attribute will be
350ignored.
351
352On ANSI colours, bold/blink attributes are used to set high-intensity
353foreground/background colors.
354
355color0-7 are the low-intensity colors.
356
357color8-15 are the corresponding high-intensity colors.
358
359=head3 I don't like the screen colors. How do I change them?
360
361You can change the screen colors at run-time using F<~/.Xdefaults>
362resources (or as long-options).
363
364Here are values that are supposed to resemble a VGA screen,
365including the murky brown that passes for low-intensity yellow:
366
367 URxvt.color0: #000000
368 URxvt.color1: #A80000
369 URxvt.color2: #00A800
370 URxvt.color3: #A8A800
371 URxvt.color4: #0000A8
372 URxvt.color5: #A800A8
373 URxvt.color6: #00A8A8
374 URxvt.color7: #A8A8A8
375
376 URxvt.color8: #000054
377 URxvt.color9: #FF0054
378 URxvt.color10: #00FF54
379 URxvt.color11: #FFFF54
380 URxvt.color12: #0000FF
381 URxvt.color13: #FF00FF
382 URxvt.color14: #00FFFF
383 URxvt.color15: #FFFFFF
384
385And here is a more complete set of non-standard colors.
386
387 URxvt.cursorColor: #dc74d1
388 URxvt.pointerColor: #dc74d1
389 URxvt.background: #0e0e0e
390 URxvt.foreground: #4ad5e1
391 URxvt.color0: #000000
392 URxvt.color8: #8b8f93
393 URxvt.color1: #dc74d1
394 URxvt.color9: #dc74d1
395 URxvt.color2: #0eb8c7
396 URxvt.color10: #0eb8c7
397 URxvt.color3: #dfe37e
398 URxvt.color11: #dfe37e
399 URxvt.color5: #9e88f0
400 URxvt.color13: #9e88f0
401 URxvt.color6: #73f7ff
402 URxvt.color14: #73f7ff
403 URxvt.color7: #e1dddd
404 URxvt.color15: #e1dddd
405
406They have been described (not by me) as "pretty girly".
407
408=head3 Why do some characters look so much different than others?
409
410See next entry.
411
412=head3 How does rxvt-unicode choose fonts?
413
414Most fonts do not contain the full range of Unicode, which is
415fine. Chances are that the font you (or the admin/package maintainer of
416your system/os) have specified does not cover all the characters you want
417to display.
418
419B<rxvt-unicode> makes a best-effort try at finding a replacement
420font. Often the result is fine, but sometimes the chosen font looks
421bad/ugly/wrong. Some fonts have totally strange characters that don't
422resemble the correct glyph at all, and rxvt-unicode lacks the artificial
423intelligence to detect that a specific glyph is wrong: it has to believe
424the font that the characters it claims to contain indeed look correct.
425
426In that case, select a font of your taste and add it to the font list,
427e.g.:
428
429 @@URXVT_NAME@@ -fn basefont,font2,font3...
430
431When rxvt-unicode sees a character, it will first look at the base
432font. If the base font does not contain the character, it will go to the
433next font, and so on. Specifying your own fonts will also speed up this
434search and use less resources within rxvt-unicode and the X-server.
435
436The only limitation is that none of the fonts may be larger than the base
437font, as the base font defines the terminal character cell size, which
438must be the same due to the way terminals work.
439
440=head3 Why do some chinese characters look so different than others?
441
442This is because there is a difference between script and language --
443rxvt-unicode does not know which language the text that is output is,
444as it only knows the unicode character codes. If rxvt-unicode first
445sees a japanese/chinese character, it might choose a japanese font for
446display. Subsequent japanese characters will use that font. Now, many
447chinese characters aren't represented in japanese fonts, so when the first
448non-japanese character comes up, rxvt-unicode will look for a chinese font
449-- unfortunately at this point, it will still use the japanese font for
450chinese characters that are also in the japanese font.
451
452The workaround is easy: just tag a chinese font at the end of your font
453list (see the previous question). The key is to view the font list as
454a preference list: If you expect more japanese, list a japanese font
455first. If you expect more chinese, put a chinese font first.
456
457In the future it might be possible to switch language preferences at
458runtime (the internal data structure has no problem with using different
459fonts for the same character at the same time, but no interface for this
460has been designed yet).
461
462Until then, you might get away with switching fonts at runtime (see L<Can
463I switch the fonts at runtime?> later in this document).
464
465=head2 Keyboard, Mouse & User Interaction
466
467=head3 The new selection selects pieces that are too big, how can I select single words?
468
469If you want to select e.g. alphanumeric words, you can use the following
470setting:
471
472 URxvt.selection.pattern-0: ([[:word:]]+)
473
474If you click more than twice, the selection will be extended
475more and more.
476
477To get a selection that is very similar to the old code, try this pattern:
478
479 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
480
481Please also note that the I<LeftClick Shift-LeftClik> combination also
482selects words like the old code.
483
484=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
485
486You can disable the perl extension completely by setting the
487B<perl-ext-common> resource to the empty string, which also keeps
488rxvt-unicode from initialising perl, saving memory.
489
490If you only want to disable specific features, you first have to
491identify which perl extension is responsible. For this, read the section
492B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
493example, to disable the B<selection-popup> and B<option-popup>, specify
494this B<perl-ext-common> resource:
495
496 URxvt.perl-ext-common: default,-selection-popup,-option-popup
497
498This will keep the default extensions, but disable the two popup
499extensions. Some extensions can also be configured, for example,
500scrollback search mode is triggered by B<M-s>. You can move it to any
501other combination either by setting the B<searchable-scrollback> resource:
502
503 URxvt.searchable-scrollback: CM-s
504
505=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
506
507See next entry.
508
509=head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
510
511These are caused by the C<readline> perl extension. Under normal
512circumstances, it will move your cursor around when you click into the
513line that contains it. It tries hard not to do this at the wrong moment,
514but when running a program that doesn't parse cursor movements or in some
515cases during rlogin sessions, it fails to detect this properly.
516
517You can permamently switch this feature off by disabling the C<readline>
518extension:
519
520 URxvt.perl-ext-common: default,-readline
521
522=head3 My numerical keypad acts weird and generates differing output?
523
524Some Debian GNUL/Linux users seem to have this problem, although no
525specific details were reported so far. It is possible that this is caused
526by the wrong C<TERM> setting, although the details of wether and how
527this can happen are unknown, as C<TERM=rxvt> should offer a compatible
528keymap. See the answer to the previous question, and please report if that
529helped.
530
531=head3 My Compose (Multi_key) key is no longer working.
532
533The most common causes for this are that either your locale is not set
534correctly, or you specified a B<preeditStyle> that is not supported by
535your input method. For example, if you specified B<OverTheSpot> and
536your input method (e.g. the default input method handling Compose keys)
537does not support this (for instance because it is not visual), then
538rxvt-unicode will continue without an input method.
539
540In this case either do not specify a B<preeditStyle> or specify more than
541one pre-edit style, such as B<OverTheSpot,Root,None>.
542
543=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
544
545Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
546international keyboards) or simply use ISO 14755 support to your
547advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
548codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
549character and so on.
550
551=head3 Mouse cut/paste suddenly no longer works.
552
553Make sure that mouse reporting is actually turned off since killing
554some editors prematurely may leave the mouse in mouse report mode. I've
555heard that tcsh may use mouse reporting unless it otherwise specified. A
556quick check is to see if cut/paste works when the Alt or Shift keys are
557depressed.
558
559=head3 What's with the strange Backspace/Delete key behaviour?
560
561Assuming that the physical Backspace key corresponds to the
562BackSpace keysym (not likely for Linux ... see the following
563question) there are two standard values that can be used for
564Backspace: C<^H> and C<^?>.
565
566Historically, either value is correct, but rxvt-unicode adopts the debian
567policy of using C<^?> when unsure, because it's the one only only correct
568choice :).
569
570Rxvt-unicode tries to inherit the current stty settings and uses the value
571of `erase' to guess the value for backspace. If rxvt-unicode wasn't
572started from a terminal (say, from a menu or by remote shell), then the
573system value of `erase', which corresponds to CERASE in <termios.h>, will
574be used (which may not be the same as your stty setting).
575
576For starting a new rxvt-unicode:
577
578 # use Backspace = ^H
579 $ stty erase ^H
580 $ @@URXVT_NAME@@
581
582 # use Backspace = ^?
583 $ stty erase ^?
584 $ @@URXVT_NAME@@
585
586Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
587
588For an existing rxvt-unicode:
589
590 # use Backspace = ^H
591 $ stty erase ^H
592 $ echo -n "^[[36h"
593
594 # use Backspace = ^?
595 $ stty erase ^?
596 $ echo -n "^[[36l"
597
598This helps satisfy some of the Backspace discrepancies that occur, but
599if you use Backspace = C<^H>, make sure that the termcap/terminfo value
600properly reflects that.
601
602The Delete key is a another casualty of the ill-defined Backspace problem.
603To avoid confusion between the Backspace and Delete keys, the Delete
604key has been assigned an escape sequence to match the vt100 for Execute
605(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
606
607Some other Backspace problems:
608
609some editors use termcap/terminfo,
610some editors (vim I'm told) expect Backspace = ^H,
611GNU Emacs (and Emacs-like editors) use ^H for help.
612
613Perhaps someday this will all be resolved in a consistent manner.
614
615=head3 I don't like the key-bindings. How do I change them?
616
617There are some compile-time selections available via configure. Unless
618you have run "configure" with the C<--disable-resources> option you can
619use the `keysym' resource to alter the keystrings associated with keysyms.
620
621Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
622
623 URxvt.keysym.Home: \033[1~
624 URxvt.keysym.End: \033[4~
625 URxvt.keysym.C-apostrophe: \033<C-'>
626 URxvt.keysym.C-slash: \033<C-/>
627 URxvt.keysym.C-semicolon: \033<C-;>
628 URxvt.keysym.C-grave: \033<C-`>
629 URxvt.keysym.C-comma: \033<C-,>
630 URxvt.keysym.C-period: \033<C-.>
631 URxvt.keysym.C-0x60: \033<C-`>
632 URxvt.keysym.C-Tab: \033<C-Tab>
633 URxvt.keysym.C-Return: \033<C-Return>
634 URxvt.keysym.S-Return: \033<S-Return>
635 URxvt.keysym.S-space: \033<S-Space>
636 URxvt.keysym.M-Up: \033<M-Up>
637 URxvt.keysym.M-Down: \033<M-Down>
638 URxvt.keysym.M-Left: \033<M-Left>
639 URxvt.keysym.M-Right: \033<M-Right>
640 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
641 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
642 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
643
644See some more examples in the documentation for the B<keysym> resource.
645
646=head3 I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map
647
648 KP_Insert == Insert
649 F22 == Print
650 F27 == Home
651 F29 == Prior
652 F33 == End
653 F35 == Next
654
655Rather than have rxvt-unicode try to accommodate all the various possible
656keyboard mappings, it is better to use `xmodmap' to remap the keys as
657required for your particular machine.
658
659
660
661=head2 Terminal Configuration
662
663=head3 Can I see a typical configuration?
664
665The default configuration tries to be xterm-like, which I don't like that
666much, but it's least surprise to regular users.
667
668As a rxvt or rxvt-unicode user, you are practically supposed to invest
669time into customising your terminal. To get you started, here is the
670author's .Xdefaults entries, with comments on what they do:
671
672 URxvt.cutchars: "()*,<>[]{}|'
673 URxvt.print-pipe: cat >/tmp/xxx
674
675These are just for testing stuff.
676
677 URxvt.imLocale: ja_JP.UTF-8
678 URxvt.preeditType: OnTheSpot,None
679
680This tells rxvt-unicode to use a special locale when communicating with
681the X Input Method, and also tells it to only use the OnTheSpot pre-edit
682type, which requires the C<xim-onthespot> perl extension but rewards me
683with correct-looking fonts.
684
685 URxvt.perl-lib: /root/lib/urxvt
686 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
687 URxvt.selection.pattern-0: ( at .*? line \\d+)
688 URxvt.selection.pattern-1: ^(/[^:]+):\
689 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
690 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
691
692This is my perl configuration. The first two set the perl library
693directory and also tells urxvt to use a large number of extensions. I
694develop for myself mostly, so I actually use most of the extensions I
695write.
696
697The selection stuff mainly makes the selection perl-error-message aware
698and tells it to convert pelr error mssages into vi-commands to load the
699relevant file and go tot he error line number.
700
701 URxvt.scrollstyle: plain
702 URxvt.secondaryScroll: true
703
704As the documentation says: plain is the preferred scrollbar for the
705author. The C<secondaryScroll> confgiures urxvt to scroll in full-screen
706apps, like screen, so lines scorlled out of screen end up in urxvt's
707scrollback buffer.
708
709 URxvt.background: #000000
710 URxvt.foreground: gray90
711 URxvt.color7: gray90
712 URxvt.colorBD: #ffffff
713 URxvt.cursorColor: #e0e080
714 URxvt.throughColor: #8080f0
715 URxvt.highlightColor: #f0f0f0
716
717Some colours. Not sure which ones are being used or even non-defaults, but
718these are in my .Xdefaults. Most notably, they set foreground/background
719to light gray/black, and also make sure that the colour 7 matches the
720default foreground colour.
721
722 URxvt.underlineColor: yellow
723
724Another colour, makes underline lines look different. Sometimes hurts, but
725is mostly a nice effect.
726
727 URxvt.geometry: 154x36
728 URxvt.loginShell: false
729 URxvt.meta: ignore
730 URxvt.utmpInhibit: true
731
732Uh, well, should be mostly self-explanatory. By specifying some defaults
733manually, I can quickly switch them for testing.
734
735 URxvt.saveLines: 8192
736
737A large scrollback buffer is essential. Really.
738
739 URxvt.mapAlert: true
740
741The only case I use it is for my IRC window, which I like to keep
742iconified till people msg me (which beeps).
743
744 URxvt.visualBell: true
745
746The audible bell is often annoying, especially when in a crowd.
747
748 URxvt.insecure: true
749
750Please don't hack my mutt! Ooops...
751
752 URxvt.pastableTabs: false
753
754I once thought this is a great idea.
755
756 urxvt.font: 9x15bold,\
757 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
758 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
759 [codeset=JISX0208]xft:Kochi Gothic, \
760 xft:Bitstream Vera Sans Mono:autohint=true, \
761 xft:Code2000:antialias=false
762 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
763 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
764 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
765
766I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
767overwhelmed. A special note: the C<9x15bold> mentioend above is actually
768the version from XFree-3.3, as XFree-4 replaced it by a totally different
769font (different glyphs for C<;> and many other harmless characters),
770while the second font is actually the C<9x15bold> from XFree4/XOrg. The
771bold version has less chars than the medium version, so I use it for rare
772characters, too. Whene ditign sources with vim, I use italic for comments
773and other stuff, which looks quite good with Bitstream Vera anti-aliased.
774
775Terminus is a quite bad font (many very wrong glyphs), but for most of my
776purposes, it works, and gives a different look, as my normal (Non-bold)
777font is already bold, and I want to see a difference between bold and
778normal fonts.
779
780Please note that I used the C<urxvt> instance name and not the C<URxvt>
781class name. Thats because I use different configs for different purposes,
782for example, my IRC window is started with C<-name IRC>, and uses these
783defaults:
784
785 IRC*title: IRC
786 IRC*geometry: 87x12+535+542
787 IRC*saveLines: 0
788 IRC*mapAlert: true
789 IRC*font: suxuseuro
790 IRC*boldFont: suxuseuro
791 IRC*colorBD: white
792 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
793 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
794
795C<Alt-Shift-1> and C<Alt-Shift-2> switch between two different font
796sizes. C<suxuseuro> allows me to keep an eye (and actually read)
797stuff while keeping a very small window. If somebody pastes something
798complicated (e.g. japanese), I temporarily switch to a larger font.
799
800The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
801C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
802file for different hosts, for example, on ym main desktop, I use:
803
804 URxvt.keysym.C-M-q: command:\033[3;5;5t
805 URxvt.keysym.C-M-y: command:\033[3;5;606t
806 URxvt.keysym.C-M-e: command:\033[3;1605;5t
807 URxvt.keysym.C-M-c: command:\033[3;1605;606t
808 URxvt.keysym.C-M-p: perl:test
809
810The first for keysym definitions allow me to quickly bring some windows
811in the layout I like most. Ion users might start laughing but will stop
812immediately when I tell them that I use my own Fvwm2 module for much the
813same effect as Ion provides, and I only very rarely use the above key
814combinations :->
815
816=head3 Why doesn't rxvt-unicode read my resources?
817
818Well, why, indeed? It does, in a way very similar to other X
819applications. Most importantly, this means that if you or your OS loads
820resources into the X display (the right way to do it), rxvt-unicode will
821ignore any resource files in your home directory. It will only read
822F<$HOME/.Xdefaults> when no resources are attached to the display.
823
824If you have or use an F<$HOME/.Xresources> file, chances are that
825resources are loaded into your X-server. In this case, you have to
826re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
827
828Also consider the form resources have to use:
829
830 URxvt.resource: value
831
832If you want to use another form (there are lots of different ways of
833specifying resources), make sure you understand wether and why it
834works. If unsure, use the form above.
835
836=head3 When I log-in to another system it tells me about missing terminfo data?
837
838The terminal description used by rxvt-unicode is not as widely available
839as that for xterm, or even rxvt (for which the same problem often arises).
840
841The correct solution for this problem is to install the terminfo, this can
842be done like this (with ncurses' infocmp):
843
844 REMOTE=remotesystem.domain
845 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
846
847... or by installing rxvt-unicode normally on the remote system,
848
849If you cannot or do not want to do this, then you can simply set
850C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
851problems arising, which includes wrong keymapping, less and different
852colours and some refresh errors in fullscreen applications. It's a nice
853quick-and-dirty workaround for rare cases, though.
854
855If you always want to do this (and are fine with the consequences) you
856can either recompile rxvt-unicode with the desired TERM value or use a
857resource to set it:
858
859 URxvt.termName: rxvt
860
861If you don't plan to use B<rxvt> (quite common...) you could also replace
862the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
863
864=head3 C<tic> outputs some error when compiling the terminfo entry.
865
866Most likely it's the empty definition for C<enacs=>. Just replace it by
867C<enacs=\E[0@> and try again.
868
869=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
870
871See next entry.
872
873=head3 I need a termcap file entry.
874
875One reason you might want this is that some distributions or operating
876systems still compile some programs using the long-obsoleted termcap
877library (Fedora Core's bash is one example) and rely on a termcap entry
878for C<rxvt-unicode>.
879
880You could use rxvt's termcap entry with resonable results in many cases.
881You can also create a termcap entry by using terminfo's infocmp program
882like this:
883
884 infocmp -C rxvt-unicode
885
886Or you could use this termcap entry, generated by the command above:
887
888 rxvt-unicode|rxvt-unicode terminal (X Window System):\
889 :am:bw:eo:km:mi:ms:xn:xo:\
890 :co#80:it#8:li#24:lm#0:\
891 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
892 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
893 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
894 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
895 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
896 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
897 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
898 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
899 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
900 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
901 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
902 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
903 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
904 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
905 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
906 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
907 :vs=\E[?25h:
908
909=head3 Why does C<ls> no longer have coloured output?
910
911The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
912decide wether a terminal has colour, but uses it's own configuration
913file. Needless to say, C<rxvt-unicode> is not in it's default file (among
914with most other terminals supporting colour). Either add:
915
916 TERM rxvt-unicode
917
918to C</etc/DIR_COLORS> or simply add:
919
920 alias ls='ls --color=auto'
921
922to your C<.profile> or C<.bashrc>.
923
924=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
925
926See next entry.
927
928=head3 Why doesn't vim/emacs etc. make use of italic?
929
930See next entry.
931
932=head3 Why are the secondary screen-related options not working properly?
933
934Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
935distributions (most notably Debian GNU/Linux) break rxvt-unicode
936by setting C<TERM> to C<rxvt>, which doesn't have these extra
937features. Unfortunately, some of these (most notably, again, Debian
938GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
939file, so you will need to install it on your own (See the question B<When
940I log-in to another system it tells me about missing terminfo data?> on
941how to do this).
942
943
944=head2 Encoding / Locale / Input Method Issues
945
946=head3 Rxvt-unicode does not seem to understand the selected encoding?
947
948See next entry.
949
950=head3 Unicode does not seem to work?
951
952If you encounter strange problems like typing an accented character but
953getting two unrelated other characters or similar, or if program output is
954subtly garbled, then you should check your locale settings.
955
956Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
957programs. Often rxvt-unicode is started in the C<C> locale, while the
958login script running within the rxvt-unicode window changes the locale to
959something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
960
961The best thing is to fix your startup environment, as you will likely run
962into other problems. If nothing works you can try this in your .profile.
963
964 printf '\e]701;%s\007' "$LC_CTYPE"
965
966If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
967supported on your systems. Some systems have a C<locale> command which
968displays this (also, C<perl -e0> can be used to check locale settings, as
969it will complain loudly if it cannot set the locale). If it displays something
970like:
971
972 locale: Cannot set LC_CTYPE to default locale: ...
973
974Then the locale you specified is not supported on your system.
975
976If nothing works and you are sure that everything is set correctly then
977you will need to remember a little known fact: Some programs just don't
978support locales :(
979
980=head3 How does rxvt-unicode determine the encoding to use?
981
982See next entry.
983
984=head3 Is there an option to switch encodings?
985
986Unlike some other terminals, rxvt-unicode has no encoding switch, and no
987specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
988UTF-8 or any other encodings with respect to terminal I/O.
989
990The reasons is that there exists a perfectly fine mechanism for selecting
991the encoding, doing I/O and (most important) communicating this to all
992applications so everybody agrees on character properties such as width
993and code number. This mechanism is the I<locale>. Applications not using
994that info will have problems (for example, C<xterm> gets the width of
995characters wrong as it uses it's own, locale-independent table under all
996locales).
997
998Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
999programs doing the same (that is, most) will automatically agree in the
1000interpretation of characters.
1001
1002Unfortunately, there is no system-independent way to select locales, nor
1003is there a standard on how locale specifiers will look like.
1004
1005On most systems, the content of the C<LC_CTYPE> environment variable
1006contains an arbitrary string which corresponds to an already-installed
1007locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1008C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1009(i.e. C<de> or C<german>) are also common.
1010
1011Rxvt-unicode ignores all other locale categories, and except for
1012the encoding, ignores country or language-specific settings,
1013i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
1014rxvt-unicode.
1015
1016If you want to use a specific encoding you have to make sure you start
1017rxvt-unicode with the correct C<LC_CTYPE> category.
1018
1019=head3 Can I switch locales at runtime?
1020
1021Yes, using an escape sequence. Try something like this, which sets
1022rxvt-unicode's idea of C<LC_CTYPE>.
1023
1024 printf '\e]701;%s\007' ja_JP.SJIS
1025
1026See also the previous answer.
1027
1028Sometimes this capability is rather handy when you want to work in
1029one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
1030(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
1031first switches to a locale supported by xjdic and back later:
1032
1033 printf '\e]701;%s\007' ja_JP.SJIS
1034 xjdic -js
1035 printf '\e]701;%s\007' de_DE.UTF-8
1036
1037You can also use xterm's C<luit> program, which usually works fine, except
1038for some locales where character width differs between program- and
1039rxvt-unicode-locales.
1040
1041=head3 I have problems getting my input method working.
1042
1043Try a search engine, as this is slightly different for every input method server.
1044
1045Here is a checklist:
1046
1047=over 4
1048
1049=item - Make sure your locale I<and> the imLocale are supported on your OS.
1050
1051Try C<locale -a> or check the documentation for your OS.
1052
1053=item - Make sure your locale or imLocale matches a locale supported by your XIM.
1054
1055For example, B<kinput2> does not support UTF-8 locales, you should use
1056C<ja_JP.EUC-JP> or equivalent.
1057
1058=item - Make sure your XIM server is actually running.
1059
1060=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1061
1062When you want to use e.g. B<kinput2>, it must be set to
1063C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. Youc an see what input
1064method servers are running with this command:
1065
1066 xprop -root XIM_SERVERS
1067
1068=item
1069
1070=back
1071
1072=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
1073
1074You can specify separate locales for the input method and the rest of the
1075terminal, using the resource C<imlocale>:
1076
1077 URxvt.imlocale: ja_JP.EUC-JP
1078
1079Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
1080use your input method. Please note, however, that, depending on your Xlib
1081version, you may not be able to input characters outside C<EUC-JP> in a
1082normal way then, as your input method limits you.
1083
1084=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
1085
1086Unfortunately, this is unavoidable, as the XIM protocol is racy by
1087design. Applications can avoid some crashes at the expense of memory
1088leaks, and Input Methods can avoid some crashes by careful ordering at
1089exit time. B<kinput2> (and derived input methods) generally succeeds,
1090while B<SCIM> (or similar input methods) fails. In the end, however,
1091crashes cannot be completely avoided even if both sides cooperate.
1092
1093So the only workaround is not to kill your Input Method Servers.
1094
1095
1096=head2 Operating Systems / Package Maintaining
1097
1098=head3 I am using Debian GNU/Linux and have a problem...
1099
1100The Debian GNU/Linux package of rxvt-unicode in sarge contains large
1101patches that considerably change the behaviour of rxvt-unicode (but
1102unfortunately this notice has been removed). Before reporting a bug to
1103the original rxvt-unicode author please download and install the genuine
1104version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
1105the problem. If you cannot, chances are that the problems are specific to
1106Debian GNU/Linux, in which case it should be reported via the Debian Bug
1107Tracking System (use C<reportbug> to report the bug).
1108
1109For other problems that also affect the Debian package, you can and
1110probably should use the Debian BTS, too, because, after all, it's also a
1111bug in the Debian version and it serves as a reminder for other users that
1112might encounter the same issue.
1113
1114=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
1115
1116You should build one binary with the default options. F<configure>
1117now enables most useful options, and the trend goes to making them
1118runtime-switchable, too, so there is usually no drawback to enbaling them,
1119except higher disk and possibly memory usage. The perl interpreter should
1120be enabled, as important functionality (menus, selection, likely more in
1121the future) depends on it.
1122
1123You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
1124system-wide (except maybe with C<defaults>). This will result in useful
1125behaviour. If your distribution aims at low memory, add an empty
1126C<perl-ext-common> resource to the app-defaults file. This will keep the
1127perl interpreter disabled until the user enables it.
1128
1129If you can/want build more binaries, I recommend building a minimal
1130one with C<--disable-everything> (very useful) and a maximal one with
1131C<--enable-everything> (less useful, it will be very big due to a lot of
1132encodings built-in that increase download times and are rarely used).
1133
1134=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
1135
1136It should be, starting with release 7.1. You are encouraged to properly
1137install urxvt with privileges necessary for your OS now.
1138
1139When rxvt-unicode detects that it runs setuid or setgid, it will fork
1140into a helper process for privileged operations (pty handling on some
1141systems, utmp/wtmp/lastlog handling on others) and drop privileges
1142immediately. This is much safer than most other terminals that keep
1143privileges while running (but is more relevant to urxvt, as it contains
1144things as perl interpreters, which might be "helpful" to attackers).
1145
1146This forking is done as the very first within main(), which is very early
1147and reduces possible bugs to initialisation code run before main(), or
1148things like the dynamic loader of your system, which should result in very
1149little risk.
1150
1151=head3 On Solaris 9, many line-drawing characters are too wide.
1152
1153Seems to be a known bug, read
1154L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
1155following ugly workaround to get non-double-wide-characters working:
1156
1157 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
1158
1159=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
1160
1161Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1162in your compile environment, or an implementation that implements it,
1163wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
1164B<wchar_t> is represented as unicode.
1165
1166As you might have guessed, FreeBSD does neither define this symobl nor
1167does it support it. Instead, it uses it's own internal representation of
1168B<wchar_t>. This is, of course, completely fine with respect to standards.
1169
1170However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
1171C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
1172
1173C<__STDC_ISO_10646__> is the only sane way to support multi-language
1174apps in an OS, as using a locale-dependent (and non-standardized)
1175representation of B<wchar_t> makes it impossible to convert between
1176B<wchar_t> (as used by X11 and your applications) and any other encoding
1177without implementing OS-specific-wrappers for each and every locale. There
1178simply are no APIs to convert B<wchar_t> into anything except the current
1179locale encoding.
1180
1181Some applications (such as the formidable B<mlterm>) work around this
1182by carrying their own replacement functions for character set handling
1183with them, and either implementing OS-dependent hacks or doing multiple
1184conversions (which is slow and unreliable in case the OS implements
1185encodings slightly different than the terminal emulator).
1186
1187The rxvt-unicode author insists that the right way to fix this is in the
1188system libraries once and for all, instead of forcing every app to carry
1189complete replacements for them :)
1190
1191=head3 I use Solaris 9 and it doesn't compile/work/etc.
1192
1193Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
1194problems with C<wcwidth> and a compile problem.
1195
1196=head3 How can I use rxvt-unicode under cygwin?
1197
1198rxvt-unicode should compile and run out of the box on cygwin, using
1199the X11 libraries that come with cygwin. libW11 emulation is no
1200longer supported (and makes no sense, either, as it only supported a
1201single font). I recommend starting the X-server in C<-multiwindow> or
1202C<-rootless> mode instead, which will result in similar look&feel as the
1203old libW11 emulation.
1204
1205At the time of this writing, cygwin didn't seem to support any multi-byte
1206encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1207to 8-bit encodings.
1208
1=head1 RXVT TECHNICAL REFERENCE 1209=head1 RXVT-UNICODE TECHNICAL REFERENCE
2 1210
1211The rest of this document describes various technical aspects of
1212B<rxvt-unicode>. First the description of supported command sequences,
1213followed by pixmap support and last by a description of all features
1214selectable at C<configure> time.
1215
3=head1 Definitions 1216=head2 Definitions
4 1217
5=over 4 1218=over 4
6 1219
7=item B<< C<c> >> 1220=item B<< C<c> >>
8 1221
… …
26 1239
27A text parameter composed of printable characters. 1240A text parameter composed of printable characters.
28 1241
29=back 1242=back
30 1243
31=head1 Values 1244=head2 Values
32 1245
33=over 4 1246=over 4
34 1247
35=item B<< C<ENQ> >> 1248=item B<< C<ENQ> >>
36 1249
… …
79 1292
80Space Character 1293Space Character
81 1294
82=back 1295=back
83 1296
84=head1 Escape Sequences 1297=head2 Escape Sequences
85 1298
86=over 4 1299=over 4
87 1300
88=item B<< C<ESC # 8> >> 1301=item B<< C<ESC # 8> >>
89 1302
… …
135Single Shift Select of G3 Character Set (SS3): affects next character 1348Single Shift Select of G3 Character Set (SS3): affects next character
136only I<unimplemented> 1349only I<unimplemented>
137 1350
138=item B<< C<ESC Z> >> 1351=item B<< C<ESC Z> >>
139 1352
140Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option> 1353Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
141 1354
142=item B<< C<ESC c> >> 1355=item B<< C<ESC c> >>
143 1356
144Full reset (RIS) 1357Full reset (RIS)
145 1358
… …
149 1362
150=item B<< C<ESC o> >> 1363=item B<< C<ESC o> >>
151 1364
152Invoke the G3 Character Set (LS3) 1365Invoke the G3 Character Set (LS3)
153 1366
154=item B<< C<ESC>(C<C> >> 1367=item B<< C<ESC ( C> >>
155 1368
156Designate G0 Character Set (ISO 2022), see below for values of C<C>. 1369Designate G0 Character Set (ISO 2022), see below for values of C<C>.
157 1370
158=item B<< C<ESC>)C<C> >> 1371=item B<< C<ESC ) C> >>
159 1372
160Designate G1 Character Set (ISO 2022), see below for values of C<C>. 1373Designate G1 Character Set (ISO 2022), see below for values of C<C>.
161 1374
162=item B<< C<ESC * C> >> 1375=item B<< C<ESC * C> >>
163 1376
… …
187 1400
188=back 1401=back
189 1402
190X<CSI> 1403X<CSI>
191 1404
192=head1 CSI (Code Sequence Introducer) Sequences 1405=head2 CSI (Command Sequence Introducer) Sequences
193 1406
194=over 4 1407=over 4
195 1408
196=item B<< C<ESC [ Ps @> >> 1409=item B<< C<ESC [ Ps @> >>
197 1410
… …
304 1517
305=item B<< C<ESC [ Ps c> >> 1518=item B<< C<ESC [ Ps c> >>
306 1519
307Send Device Attributes (DA) 1520Send Device Attributes (DA)
308B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1521B<< C<Ps = 0> >> (or omitted): request attributes from terminal
309returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1522returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
310Option'') 1523Option'')
311 1524
312=item B<< C<ESC [ Ps d> >> 1525=item B<< C<ESC [ Ps d> >>
313 1526
314Cursor to Line B<< C<Ps> >> (VPA) 1527Cursor to Line B<< C<Ps> >> (VPA)
… …
330 B<< C<Ps = 0> >> Clear Current Column (default) 1543 B<< C<Ps = 0> >> Clear Current Column (default)
331 B<< C<Ps = 3> >> Clear All (TBC) 1544 B<< C<Ps = 3> >> Clear All (TBC)
332 1545
333=end table 1546=end table
334 1547
1548=item B<< C<ESC [ Pm h> >>
1549
1550Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
1551
335=item B<< C<ESC [ Ps i> >> 1552=item B<< C<ESC [ Ps i> >>
336 1553
337Printing 1554Printing. See also the C<print-pipe> resource.
338 1555
339=begin table 1556=begin table
340 1557
1558 B<< C<Ps = 0> >> print screen (MC0)
341 B<< C<Ps = 4> >> disable transparent print mode (MC4) 1559 B<< C<Ps = 4> >> disable transparent print mode (MC4)
342 B<< C<Ps = 5> >> enable transparent print mode (MC5) I<unimplemented> 1560 B<< C<Ps = 5> >> enable transparent print mode (MC5)
343 1561
344=end table 1562=end table
345
346=item B<< C<ESC [ Pm h> >>
347
348Set Mode (SM). See next sequence for description of C<Pm>.
349 1563
350=item B<< C<ESC [ Pm l> >> 1564=item B<< C<ESC [ Pm l> >>
351 1565
352Reset Mode (RM) 1566Reset Mode (RM)
353 1567
… …
360 B<< C<h> >> Insert Mode (SMIR) 1574 B<< C<h> >> Insert Mode (SMIR)
361 B<< C<l> >> Replace Mode (RMIR) 1575 B<< C<l> >> Replace Mode (RMIR)
362 1576
363=end table 1577=end table
364 1578
365=item B<< C<Ps = 20> >> I<unimplemented> 1579=item B<< C<Ps = 20> >> (partially implemented)
366 1580
367=begin table 1581=begin table
368 1582
369 B<< C<h> >> Automatic Newline (LNM) 1583 B<< C<h> >> Automatic Newline (LNM)
370 B<< C<h> >> Normal Linefeed (LNM) 1584 B<< C<l> >> Normal Linefeed (LNM)
371 1585
372=end table 1586=end table
373 1587
374=back 1588=back
375 1589
… …
378Character Attributes (SGR) 1592Character Attributes (SGR)
379 1593
380=begin table 1594=begin table
381 1595
382 B<< C<Ps = 0> >> Normal (default) 1596 B<< C<Ps = 0> >> Normal (default)
383 B<< C<Ps = 1 / 22> >> On / Off Bold (bright fg) 1597 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg)
1598 B<< C<Ps = 3 / 23> >> On / Off Italic
384 B<< C<Ps = 4 / 24> >> On / Off Underline 1599 B<< C<Ps = 4 / 24> >> On / Off Underline
385 B<< C<Ps = 5 / 25> >> On / Off Blink (bright bg) 1600 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg)
1601 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg)
386 B<< C<Ps = 7 / 27> >> On / Off Inverse 1602 B<< C<Ps = 7 / 27> >> On / Off Inverse
1603 B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI)
387 B<< C<Ps = 30 / 40> >> fg/bg Black 1604 B<< C<Ps = 30 / 40> >> fg/bg Black
388 B<< C<Ps = 31 / 41> >> fg/bg Red 1605 B<< C<Ps = 31 / 41> >> fg/bg Red
389 B<< C<Ps = 32 / 42> >> fg/bg Green 1606 B<< C<Ps = 32 / 42> >> fg/bg Green
390 B<< C<Ps = 33 / 43> >> fg/bg Yellow 1607 B<< C<Ps = 33 / 43> >> fg/bg Yellow
391 B<< C<Ps = 34 / 44> >> fg/bg Blue 1608 B<< C<Ps = 34 / 44> >> fg/bg Blue
392 B<< C<Ps = 35 / 45> >> fg/bg Magenta 1609 B<< C<Ps = 35 / 45> >> fg/bg Magenta
393 B<< C<Ps = 36 / 46> >> fg/bg Cyan 1610 B<< C<Ps = 36 / 46> >> fg/bg Cyan
1611 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 1612 B<< C<Ps = 37 / 47> >> fg/bg White
395 B<< C<Ps = 39 / 49> >> fg/bg Default 1613 B<< C<Ps = 39 / 49> >> fg/bg Default
1614 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
1615 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
1616 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
1617 B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow
1618 B<< C<Ps = 94 / 104> >> fg/bg Bright Blue
1619 B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta
1620 B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan
1621 B<< C<Ps = 97 / 107> >> fg/bg Bright White
1622 B<< C<Ps = 99 / 109> >> fg/bg Bright Default
396 1623
397=end table 1624=end table
398 1625
399=item B<< C<ESC [ Ps n> >> 1626=item B<< C<ESC [ Ps n> >>
400 1627
… …
416 1643
417=item B<< C<ESC [ s> >> 1644=item B<< C<ESC [ s> >>
418 1645
419Save Cursor (SC) 1646Save Cursor (SC)
420 1647
1648=item B<< C<ESC [ Ps;Pt t> >>
1649
1650Window Operations
1651
1652=begin table
1653
1654 B<< C<Ps = 1> >> Deiconify (map) window
1655 B<< C<Ps = 2> >> Iconify window
1656 B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1657 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1658 B<< C<Ps = 5> >> Raise window
1659 B<< C<Ps = 6> >> Lower window
1660 B<< C<Ps = 7> >> Refresh screen once
1661 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1662 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1663 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1664 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1665 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1666 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1667 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1668 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
1669 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1670
1671=end table
1672
1673=item B<< C<ESC [ u> >>
1674
1675Restore Cursor
1676
421=item B<< C<ESC [ Ps x> >> 1677=item B<< C<ESC [ Ps x> >>
422 1678
423Request Terminal Parameters (DECREQTPARM) 1679Request Terminal Parameters (DECREQTPARM)
424 1680
425=item B<< C<ESC [ u> >>
426
427Restore Cursor
428
429=back 1681=back
430 1682
431X<PrivateModes> 1683X<PrivateModes>
432 1684
433=head1 DEC Private Modes 1685=head2 DEC Private Modes
434 1686
435=over 4 1687=over 4
436 1688
437=item B<< C<ESC [ ? Pm h> >> 1689=item B<< C<ESC [ ? Pm h> >>
438 1690
… …
535 B<< C<h> >> Send Mouse X & Y on button press. 1787 B<< C<h> >> Send Mouse X & Y on button press.
536 B<< C<l> >> No mouse reporting. 1788 B<< C<l> >> No mouse reporting.
537 1789
538=end table 1790=end table
539 1791
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> >> 1792=item B<< C<Ps = 25> >>
552 1793
553=begin table 1794=begin table
554 1795
555 B<< C<h> >> Visible cursor {cnorm/cvvis} 1796 B<< C<h> >> Visible cursor {cnorm/cvvis}
… …
653 B<< C<h> >> Use Hilite Mouse Tracking. 1894 B<< C<h> >> Use Hilite Mouse Tracking.
654 B<< C<l> >> No mouse reporting. 1895 B<< C<l> >> No mouse reporting.
655 1896
656=end table 1897=end table
657 1898
658=item B<< C<Ps = 1010> >> 1899=item B<< C<Ps = 1010> >> (B<rxvt>)
659 1900
660=begin table 1901=begin table
661 1902
662 B<< C<h> >> Don't scroll to bottom on TTY output 1903 B<< C<h> >> Don't scroll to bottom on TTY output
663 B<< C<l> >> Scroll to bottom on TTY output 1904 B<< C<l> >> Scroll to bottom on TTY output
664 1905
665=end table 1906=end table
666 1907
667=item B<< C<Ps = 1011> >> 1908=item B<< C<Ps = 1011> >> (B<rxvt>)
668 1909
669=begin table 1910=begin table
670 1911
671 B<< C<h> >> Scroll to bottom when a key is pressed 1912 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 1913 B<< C<l> >> Don't scroll to bottom when a key is pressed
673 1914
674=end table 1915=end table
675 1916
1917=item B<< C<Ps = 1021> >> (B<rxvt>)
1918
1919=begin table
1920
1921 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1922 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1923
1924=end table
1925
676=item B<< C<Ps = 1047> >> 1926=item B<< C<Ps = 1047> >>
677 1927
678=begin table 1928=begin table
679 1929
680 B<< C<h> >> Use Alternate Screen Buffer 1930 B<< C<h> >> Use Alternate Screen Buffer
… …
689 B<< C<h> >> Save cursor position 1939 B<< C<h> >> Save cursor position
690 B<< C<l> >> Restore cursor position 1940 B<< C<l> >> Restore cursor position
691 1941
692=end table 1942=end table
693 1943
1944=item B<< C<Ps = 1049> >>
1945
1946=begin table
1947
1948 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1949 B<< C<l> >> Use Normal Screen Buffer
1950
1951=end table
1952
694=back 1953=back
695 1954
696=back 1955=back
697 1956
698X<XTerm> 1957X<XTerm>
699 1958
700=head1 XTerm Operating System Commands 1959=head2 XTerm Operating System Commands
701 1960
702=over 4 1961=over 4
703 1962
704=item B<< C<ESC ] Ps;Pt ST> >> 1963=item B<< C<ESC ] Ps;Pt ST> >>
705 1964
… …
717 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1976 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)> 1977 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> >> 1978 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> >> 1979 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> >> 1980 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> >> 1981 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> >> 1982 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1983 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> >> 1984 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> 1985 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> 1986 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> >> 1987 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> >> 1988 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) 1989 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) 1990 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) 1991 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1992 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1993 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1994 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1995 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1996 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1997 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1998 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1999 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2000 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2001 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
733 2002
734=end table 2003=end table
735 2004
736=back 2005=back
737
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>
1204 2006
1205=head1 XPM 2007=head1 XPM
1206 2008
1207For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2009For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1208of B<< C<Pt> >> can be the name of the background pixmap followed by a 2010of B<< C<Pt> >> can be the name of the background pixmap followed by a
… …
1306=begin table 2108=begin table
1307 2109
1308 4 Shift 2110 4 Shift
1309 8 Meta 2111 8 Meta
1310 16 Control 2112 16 Control
1311 32 Double Click I<(Rxvt extension)> 2113 32 Double Click I<(rxvt extension)>
1312 2114
1313=end table 2115=end table
1314 2116
1315Col = B<< C<< <x> - SPACE >> >> 2117Col = B<< C<< <x> - SPACE >> >>
1316 2118
… …
1390 XK_KP_8 8 ESC O x 2192 XK_KP_8 8 ESC O x
1391 XK_KP_9 9 ESC O y 2193 XK_KP_9 9 ESC O y
1392 2194
1393=end table 2195=end table
1394 2196
2197=head1 CONFIGURE OPTIONS
2198
2199General hint: if you get compile errors, then likely your configuration
2200hasn't been tested well. Either try with C<--enable-everything> or use
2201the F<./reconf> script as a base for experiments. F<./reconf> is used by
2202myself, so it should generally be a working config. Of course, you should
2203always report when a combination doesn't work, so it can be fixed. Marc
2204Lehmann <rxvt@schmorp.de>.
2205
2206All
2207
2208=over 4
2209
2210=item --enable-everything
2211
2212Add (or remove) support for all non-multichoice options listed in "./configure
2213--help".
2214
2215You can specify this and then disable options you do not like by
2216I<following> this with the appropriate C<--disable-...> arguments,
2217or you can start with a minimal configuration by specifying
2218C<--disable-everything> and than adding just the C<--enable-...> arguments
2219you want.
2220
2221=item --enable-xft (default: enabled)
2222
2223Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2224slower and require lots of memory, but as long as you don't use them, you
2225don't pay for them.
2226
2227=item --enable-font-styles (default: on)
2228
2229Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2230styles. The fonts can be set manually or automatically.
2231
2232=item --with-codesets=NAME,... (default: all)
2233
2234Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2235are always compiled in, which includes most 8-bit character sets). These
2236codeset tables are used for driving X11 core fonts, they are not required
2237for Xft fonts, although having them compiled in lets rxvt-unicode choose
2238replacement fonts more intelligently. Compiling them in will make your
2239binary bigger (all of together cost about 700kB), but it doesn't increase
2240memory usage unless you use a font requiring one of these encodings.
2241
2242=begin table
2243
2244 all all available codeset groups
2245 zh common chinese encodings
2246 zh_ext rarely used but very big chinese encodigs
2247 jp common japanese encodings
2248 jp_ext rarely used but big japanese encodings
2249 kr korean encodings
2250
2251=end table
2252
2253=item --enable-xim (default: on)
2254
2255Add support for XIM (X Input Method) protocol. This allows using
2256alternative input methods (e.g. kinput2) and will also correctly
2257set up the input for people using dead keys or compose keys.
2258
2259=item --enable-unicode3 (default: off)
2260
2261Recommended to stay off unless you really need non-BMP characters.
2262
2263Enable direct support for displaying unicode codepoints above
226465535 (the basic multilingual page). This increases storage
2265requirements per character from 2 to 4 bytes. X11 fonts do not yet
2266support these extra characters, but Xft does.
2267
2268Please note that rxvt-unicode can store unicode code points >65535
2269even without this flag, but the number of such characters is
2270limited to a view thousand (shared with combining characters,
2271see next switch), and right now rxvt-unicode cannot display them
2272(input/output and cut&paste still work, though).
2273
2274=item --enable-combining (default: on)
2275
2276Enable automatic composition of combining characters into
2277composite characters. This is required for proper viewing of text
2278where accents are encoded as seperate unicode characters. This is
2279done by using precomposited characters when available or creating
2280new pseudo-characters when no precomposed form exists.
2281
2282Without --enable-unicode3, the number of additional precomposed
2283characters is somewhat limited (the 6400 private use characters will be
2284(ab-)used). With --enable-unicode3, no practical limit exists.
2285
2286This option will also enable storage (but not display) of characters
2287beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2288
2289The combining table also contains entries for arabic presentation forms,
2290but these are not currently used. Bug me if you want these to be used (and
2291tell me how these are to be used...).
2292
2293=item --enable-fallback(=CLASS) (default: Rxvt)
2294
2295When reading resource settings, also read settings for class CLASS. To
2296disable resource fallback use --disable-fallback.
2297
2298=item --with-res-name=NAME (default: urxvt)
2299
2300Use the given name as default application name when
2301reading resources. Specify --with-res-name=rxvt to replace rxvt.
2302
2303=item --with-res-class=CLASS /default: URxvt)
2304
2305Use the given class as default application class
2306when reading resources. Specify --with-res-class=Rxvt to replace
2307rxvt.
2308
2309=item --enable-utmp (default: on)
2310
2311Write user and tty to utmp file (used by programs like F<w>) at
2312start of rxvt execution and delete information when rxvt exits.
2313
2314=item --enable-wtmp (default: on)
2315
2316Write user and tty to wtmp file (used by programs like F<last>) at
2317start of rxvt execution and write logout when rxvt exits. This
2318option requires --enable-utmp to also be specified.
2319
2320=item --enable-lastlog (default: on)
2321
2322Write user and tty to lastlog file (used by programs like
2323F<lastlogin>) at start of rxvt execution. This option requires
2324--enable-utmp to also be specified.
2325
2326=item --enable-xpm-background (default: on)
2327
2328Add support for XPM background pixmaps.
2329
2330=item --enable-transparency (default: on)
2331
2332Add support for inheriting parent backgrounds thus giving a fake
2333transparency to the term.
2334
2335=item --enable-fading (default: on)
2336
2337Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2338
2339=item --enable-tinting (default: on)
2340
2341Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2342
2343=item --enable-rxvt-scroll (default: on)
2344
2345Add support for the original rxvt scrollbar.
2346
2347=item --enable-next-scroll (default: on)
2348
2349Add support for a NeXT-like scrollbar.
2350
2351=item --enable-xterm-scroll (default: on)
2352
2353Add support for an Xterm-like scrollbar.
2354
2355=item --enable-plain-scroll (default: on)
2356
2357Add support for a very unobtrusive, plain-looking scrollbar that
2358is the favourite of the rxvt-unicode author, having used it for
2359many years.
2360
2361=item --enable-ttygid (default: off)
2362
2363Change tty device setting to group "tty" - only use this if
2364your system uses this type of security.
2365
2366=item --disable-backspace-key
2367
2368Removes any handling of the backspace key by us - let the X server do it.
2369
2370=item --disable-delete-key
2371
2372Removes any handling of the delete key by us - let the X server
2373do it.
2374
2375=item --disable-resources
2376
2377Removes any support for resource checking.
2378
2379=item --disable-swapscreen
2380
2381Remove support for secondary/swap screen.
2382
2383=item --enable-frills (default: on)
2384
2385Add support for many small features that are not essential but nice to
2386have. Normally you want this, but for very small binaries you may want to
2387disable this.
2388
2389A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2390in combination with other switches) is:
2391
2392 MWM-hints
2393 EWMH-hints (pid, utf8 names) and protocols (ping)
2394 seperate underline colour (-underlineColor)
2395 settable border widths and borderless switch (-w, -b, -bl)
2396 visual depth selection (-depth)
2397 settable extra linespacing /-lsp)
2398 iso-14755-2 and -3, and visual feedback
2399 tripleclickwords (-tcw)
2400 settable insecure mode (-insecure)
2401 keysym remapping support
2402 cursor blinking and underline cursor (-cb, -uc)
2403 XEmbed support (-embed)
2404 user-pty (-pty-fd)
2405 hold on exit (-hold)
2406 skip builtin block graphics (-sbg)
2407
2408It also enabled some non-essential features otherwise disabled, such as:
2409
2410 some round-trip time optimisations
2411 nearest color allocation on pseudocolor screens
2412 UTF8_STRING supporr for selection
2413 sgr modes 90..97 and 100..107
2414 backindex and forwardindex escape sequences
2415 view change/zero scorllback esacpe sequences
2416 locale switching escape sequence
2417 window op and some xterm/OSC escape sequences
2418 rectangular selections
2419 trailing space removal for selections
2420 verbose X error handling
2421
2422=item --enable-iso14755 (default: on)
2423
2424Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2425F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2426C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2427this switch.
2428
2429=item --enable-keepscrolling (default: on)
2430
2431Add support for continual scrolling of the display when you hold
2432the mouse button down on a scrollbar arrow.
2433
2434=item --enable-mousewheel (default: on)
2435
2436Add support for scrolling via mouse wheel or buttons 4 & 5.
2437
2438=item --enable-slipwheeling (default: on)
2439
2440Add support for continual scrolling (using the mouse wheel as an
2441accelerator) while the control key is held down. This option
2442requires --enable-mousewheel to also be specified.
2443
2444=item --disable-new-selection
2445
2446Remove support for mouse selection style like that of xterm.
2447
2448=item --enable-dmalloc (default: off)
2449
2450Use Gray Watson's malloc - which is good for debugging See
2451L<http://www.letters.com/dmalloc/> for details If you use either this or the
2452next option, you may need to edit src/Makefile after compiling to point
2453DINCLUDE and DLIB to the right places.
2454
2455You can only use either this option and the following (should
2456you use either) .
2457
2458=item --enable-dlmalloc (default: off)
2459
2460Use Doug Lea's malloc - which is good for a production version
2461See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2462
2463=item --enable-smart-resize (default: on)
2464
2465Add smart growth/shrink behaviour when changing font size via hot
2466keys. This should keep the window corner which is closest to a corner of
2467the screen in a fixed position.
2468
2469=item --enable-pointer-blank (default: on)
2470
2471Add support to have the pointer disappear when typing or inactive.
2472
2473=item --enable-perl (default: on)
2474
2475Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2476manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2477in F<src/perl-ext/> for the extensions that are installed by default. The
2478perl interpreter that is used can be specified via the C<PERL> environment
2479variable when running configure.
2480
2481=item --with-name=NAME (default: urxvt)
2482
2483Set the basename for the installed binaries, resulting
2484in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2485C<rxvt>.
2486
2487=item --with-term=NAME (default: rxvt-unicode)
2488
2489Change the environmental variable for the terminal to NAME.
2490
2491=item --with-terminfo=PATH
2492
2493Change the environmental variable for the path to the terminfo tree to
2494PATH.
2495
2496=item --with-x
2497
2498Use the X Window System (pretty much default, eh?).
2499
2500=item --with-xpm-includes=DIR
2501
2502Look for the XPM includes in DIR.
2503
2504=item --with-xpm-library=DIR
2505
2506Look for the XPM library in DIR.
2507
2508=item --with-xpm
2509
2510Not needed - define via --enable-xpm-background.
2511
2512=back
2513
1395=head1 AUTHORS 2514=head1 AUTHORS
1396 2515
1397Marc Lehmann <rxvt@schmorp.de> converted this document to pod and 2516Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
1398reworked it from the original Rxvt documentation, which was done by Geoff 2517reworked it from the original Rxvt documentation, which was done by Geoff
1399Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other 2518Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other

Diff Legend

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